xref: /openbsd-src/usr.bin/tmux/cmd.c (revision c020cf82e0cc147236f01a8dca7052034cf9d30d)
1 /* $OpenBSD: cmd.c,v 1.162 2020/06/04 07:12:05 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <sys/types.h>
20 #include <sys/time.h>
21 
22 #include <fnmatch.h>
23 #include <paths.h>
24 #include <pwd.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <unistd.h>
28 
29 #include "tmux.h"
30 
31 extern const struct cmd_entry cmd_attach_session_entry;
32 extern const struct cmd_entry cmd_bind_key_entry;
33 extern const struct cmd_entry cmd_break_pane_entry;
34 extern const struct cmd_entry cmd_capture_pane_entry;
35 extern const struct cmd_entry cmd_choose_buffer_entry;
36 extern const struct cmd_entry cmd_choose_client_entry;
37 extern const struct cmd_entry cmd_choose_tree_entry;
38 extern const struct cmd_entry cmd_clear_history_entry;
39 extern const struct cmd_entry cmd_clock_mode_entry;
40 extern const struct cmd_entry cmd_command_prompt_entry;
41 extern const struct cmd_entry cmd_confirm_before_entry;
42 extern const struct cmd_entry cmd_copy_mode_entry;
43 extern const struct cmd_entry cmd_customize_mode_entry;
44 extern const struct cmd_entry cmd_delete_buffer_entry;
45 extern const struct cmd_entry cmd_detach_client_entry;
46 extern const struct cmd_entry cmd_display_menu_entry;
47 extern const struct cmd_entry cmd_display_message_entry;
48 extern const struct cmd_entry cmd_display_popup_entry;
49 extern const struct cmd_entry cmd_display_panes_entry;
50 extern const struct cmd_entry cmd_down_pane_entry;
51 extern const struct cmd_entry cmd_find_window_entry;
52 extern const struct cmd_entry cmd_has_session_entry;
53 extern const struct cmd_entry cmd_if_shell_entry;
54 extern const struct cmd_entry cmd_join_pane_entry;
55 extern const struct cmd_entry cmd_kill_pane_entry;
56 extern const struct cmd_entry cmd_kill_server_entry;
57 extern const struct cmd_entry cmd_kill_session_entry;
58 extern const struct cmd_entry cmd_kill_window_entry;
59 extern const struct cmd_entry cmd_last_pane_entry;
60 extern const struct cmd_entry cmd_last_window_entry;
61 extern const struct cmd_entry cmd_link_window_entry;
62 extern const struct cmd_entry cmd_list_buffers_entry;
63 extern const struct cmd_entry cmd_list_clients_entry;
64 extern const struct cmd_entry cmd_list_commands_entry;
65 extern const struct cmd_entry cmd_list_keys_entry;
66 extern const struct cmd_entry cmd_list_panes_entry;
67 extern const struct cmd_entry cmd_list_sessions_entry;
68 extern const struct cmd_entry cmd_list_windows_entry;
69 extern const struct cmd_entry cmd_load_buffer_entry;
70 extern const struct cmd_entry cmd_lock_client_entry;
71 extern const struct cmd_entry cmd_lock_server_entry;
72 extern const struct cmd_entry cmd_lock_session_entry;
73 extern const struct cmd_entry cmd_move_pane_entry;
74 extern const struct cmd_entry cmd_move_window_entry;
75 extern const struct cmd_entry cmd_new_session_entry;
76 extern const struct cmd_entry cmd_new_window_entry;
77 extern const struct cmd_entry cmd_next_layout_entry;
78 extern const struct cmd_entry cmd_next_window_entry;
79 extern const struct cmd_entry cmd_paste_buffer_entry;
80 extern const struct cmd_entry cmd_pipe_pane_entry;
81 extern const struct cmd_entry cmd_previous_layout_entry;
82 extern const struct cmd_entry cmd_previous_window_entry;
83 extern const struct cmd_entry cmd_refresh_client_entry;
84 extern const struct cmd_entry cmd_rename_session_entry;
85 extern const struct cmd_entry cmd_rename_window_entry;
86 extern const struct cmd_entry cmd_resize_pane_entry;
87 extern const struct cmd_entry cmd_resize_window_entry;
88 extern const struct cmd_entry cmd_respawn_pane_entry;
89 extern const struct cmd_entry cmd_respawn_window_entry;
90 extern const struct cmd_entry cmd_rotate_window_entry;
91 extern const struct cmd_entry cmd_run_shell_entry;
92 extern const struct cmd_entry cmd_save_buffer_entry;
93 extern const struct cmd_entry cmd_select_layout_entry;
94 extern const struct cmd_entry cmd_select_pane_entry;
95 extern const struct cmd_entry cmd_select_window_entry;
96 extern const struct cmd_entry cmd_send_keys_entry;
97 extern const struct cmd_entry cmd_send_prefix_entry;
98 extern const struct cmd_entry cmd_set_buffer_entry;
99 extern const struct cmd_entry cmd_set_environment_entry;
100 extern const struct cmd_entry cmd_set_hook_entry;
101 extern const struct cmd_entry cmd_set_option_entry;
102 extern const struct cmd_entry cmd_set_window_option_entry;
103 extern const struct cmd_entry cmd_show_buffer_entry;
104 extern const struct cmd_entry cmd_show_environment_entry;
105 extern const struct cmd_entry cmd_show_hooks_entry;
106 extern const struct cmd_entry cmd_show_messages_entry;
107 extern const struct cmd_entry cmd_show_options_entry;
108 extern const struct cmd_entry cmd_show_window_options_entry;
109 extern const struct cmd_entry cmd_source_file_entry;
110 extern const struct cmd_entry cmd_split_window_entry;
111 extern const struct cmd_entry cmd_start_server_entry;
112 extern const struct cmd_entry cmd_suspend_client_entry;
113 extern const struct cmd_entry cmd_swap_pane_entry;
114 extern const struct cmd_entry cmd_swap_window_entry;
115 extern const struct cmd_entry cmd_switch_client_entry;
116 extern const struct cmd_entry cmd_unbind_key_entry;
117 extern const struct cmd_entry cmd_unlink_window_entry;
118 extern const struct cmd_entry cmd_up_pane_entry;
119 extern const struct cmd_entry cmd_wait_for_entry;
120 
121 const struct cmd_entry *cmd_table[] = {
122 	&cmd_attach_session_entry,
123 	&cmd_bind_key_entry,
124 	&cmd_break_pane_entry,
125 	&cmd_capture_pane_entry,
126 	&cmd_choose_buffer_entry,
127 	&cmd_choose_client_entry,
128 	&cmd_choose_tree_entry,
129 	&cmd_clear_history_entry,
130 	&cmd_clock_mode_entry,
131 	&cmd_command_prompt_entry,
132 	&cmd_confirm_before_entry,
133 	&cmd_copy_mode_entry,
134 	&cmd_customize_mode_entry,
135 	&cmd_delete_buffer_entry,
136 	&cmd_detach_client_entry,
137 	&cmd_display_menu_entry,
138 	&cmd_display_message_entry,
139 	&cmd_display_popup_entry,
140 	&cmd_display_panes_entry,
141 	&cmd_find_window_entry,
142 	&cmd_has_session_entry,
143 	&cmd_if_shell_entry,
144 	&cmd_join_pane_entry,
145 	&cmd_kill_pane_entry,
146 	&cmd_kill_server_entry,
147 	&cmd_kill_session_entry,
148 	&cmd_kill_window_entry,
149 	&cmd_last_pane_entry,
150 	&cmd_last_window_entry,
151 	&cmd_link_window_entry,
152 	&cmd_list_buffers_entry,
153 	&cmd_list_clients_entry,
154 	&cmd_list_commands_entry,
155 	&cmd_list_keys_entry,
156 	&cmd_list_panes_entry,
157 	&cmd_list_sessions_entry,
158 	&cmd_list_windows_entry,
159 	&cmd_load_buffer_entry,
160 	&cmd_lock_client_entry,
161 	&cmd_lock_server_entry,
162 	&cmd_lock_session_entry,
163 	&cmd_move_pane_entry,
164 	&cmd_move_window_entry,
165 	&cmd_new_session_entry,
166 	&cmd_new_window_entry,
167 	&cmd_next_layout_entry,
168 	&cmd_next_window_entry,
169 	&cmd_paste_buffer_entry,
170 	&cmd_pipe_pane_entry,
171 	&cmd_previous_layout_entry,
172 	&cmd_previous_window_entry,
173 	&cmd_refresh_client_entry,
174 	&cmd_rename_session_entry,
175 	&cmd_rename_window_entry,
176 	&cmd_resize_pane_entry,
177 	&cmd_resize_window_entry,
178 	&cmd_respawn_pane_entry,
179 	&cmd_respawn_window_entry,
180 	&cmd_rotate_window_entry,
181 	&cmd_run_shell_entry,
182 	&cmd_save_buffer_entry,
183 	&cmd_select_layout_entry,
184 	&cmd_select_pane_entry,
185 	&cmd_select_window_entry,
186 	&cmd_send_keys_entry,
187 	&cmd_send_prefix_entry,
188 	&cmd_set_buffer_entry,
189 	&cmd_set_environment_entry,
190 	&cmd_set_hook_entry,
191 	&cmd_set_option_entry,
192 	&cmd_set_window_option_entry,
193 	&cmd_show_buffer_entry,
194 	&cmd_show_environment_entry,
195 	&cmd_show_hooks_entry,
196 	&cmd_show_messages_entry,
197 	&cmd_show_options_entry,
198 	&cmd_show_window_options_entry,
199 	&cmd_source_file_entry,
200 	&cmd_split_window_entry,
201 	&cmd_start_server_entry,
202 	&cmd_suspend_client_entry,
203 	&cmd_swap_pane_entry,
204 	&cmd_swap_window_entry,
205 	&cmd_switch_client_entry,
206 	&cmd_unbind_key_entry,
207 	&cmd_unlink_window_entry,
208 	&cmd_wait_for_entry,
209 	NULL
210 };
211 
212 /* Instance of a command. */
213 struct cmd {
214 	const struct cmd_entry	 *entry;
215 	struct args		 *args;
216 	u_int			  group;
217 
218 	char			 *file;
219 	u_int			  line;
220 
221 	char			 *alias;
222 	int			  argc;
223 	char			**argv;
224 
225 	TAILQ_ENTRY(cmd)	  qentry;
226 };
227 TAILQ_HEAD(cmds, cmd);
228 
229 /* Next group number for new command list. */
230 static u_int cmd_list_next_group = 1;
231 
232 /* Log an argument vector. */
233 void printflike(3, 4)
234 cmd_log_argv(int argc, char **argv, const char *fmt, ...)
235 {
236 	char	*prefix;
237 	va_list	 ap;
238 	int	 i;
239 
240 	va_start(ap, fmt);
241 	xvasprintf(&prefix, fmt, ap);
242 	va_end(ap);
243 
244 	for (i = 0; i < argc; i++)
245 		log_debug("%s: argv[%d]=%s", prefix, i, argv[i]);
246 	free(prefix);
247 }
248 
249 /* Prepend to an argument vector. */
250 void
251 cmd_prepend_argv(int *argc, char ***argv, char *arg)
252 {
253 	char	**new_argv;
254 	int	  i;
255 
256 	new_argv = xreallocarray(NULL, (*argc) + 1, sizeof *new_argv);
257 	new_argv[0] = xstrdup(arg);
258 	for (i = 0; i < *argc; i++)
259 		new_argv[1 + i] = (*argv)[i];
260 
261 	free(*argv);
262 	*argv = new_argv;
263 	(*argc)++;
264 }
265 
266 /* Append to an argument vector. */
267 void
268 cmd_append_argv(int *argc, char ***argv, char *arg)
269 {
270 	*argv = xreallocarray(*argv, (*argc) + 1, sizeof **argv);
271 	(*argv)[(*argc)++] = xstrdup(arg);
272 }
273 
274 /* Pack an argument vector up into a buffer. */
275 int
276 cmd_pack_argv(int argc, char **argv, char *buf, size_t len)
277 {
278 	size_t	arglen;
279 	int	i;
280 
281 	if (argc == 0)
282 		return (0);
283 	cmd_log_argv(argc, argv, "%s", __func__);
284 
285 	*buf = '\0';
286 	for (i = 0; i < argc; i++) {
287 		if (strlcpy(buf, argv[i], len) >= len)
288 			return (-1);
289 		arglen = strlen(argv[i]) + 1;
290 		buf += arglen;
291 		len -= arglen;
292 	}
293 
294 	return (0);
295 }
296 
297 /* Unpack an argument vector from a packed buffer. */
298 int
299 cmd_unpack_argv(char *buf, size_t len, int argc, char ***argv)
300 {
301 	int	i;
302 	size_t	arglen;
303 
304 	if (argc == 0)
305 		return (0);
306 	*argv = xcalloc(argc, sizeof **argv);
307 
308 	buf[len - 1] = '\0';
309 	for (i = 0; i < argc; i++) {
310 		if (len == 0) {
311 			cmd_free_argv(argc, *argv);
312 			return (-1);
313 		}
314 
315 		arglen = strlen(buf) + 1;
316 		(*argv)[i] = xstrdup(buf);
317 
318 		buf += arglen;
319 		len -= arglen;
320 	}
321 	cmd_log_argv(argc, *argv, "%s", __func__);
322 
323 	return (0);
324 }
325 
326 /* Copy an argument vector, ensuring it is terminated by NULL. */
327 char **
328 cmd_copy_argv(int argc, char **argv)
329 {
330 	char	**new_argv;
331 	int	  i;
332 
333 	if (argc == 0)
334 		return (NULL);
335 	new_argv = xcalloc(argc + 1, sizeof *new_argv);
336 	for (i = 0; i < argc; i++) {
337 		if (argv[i] != NULL)
338 			new_argv[i] = xstrdup(argv[i]);
339 	}
340 	return (new_argv);
341 }
342 
343 /* Free an argument vector. */
344 void
345 cmd_free_argv(int argc, char **argv)
346 {
347 	int	i;
348 
349 	if (argc == 0)
350 		return;
351 	for (i = 0; i < argc; i++)
352 		free(argv[i]);
353 	free(argv);
354 }
355 
356 /* Convert argument vector to a string. */
357 char *
358 cmd_stringify_argv(int argc, char **argv)
359 {
360 	char	*buf = NULL, *s;
361 	size_t	 len = 0;
362 	int	 i;
363 
364 	if (argc == 0)
365 		return (xstrdup(""));
366 
367 	for (i = 0; i < argc; i++) {
368 		s = args_escape(argv[i]);
369 		log_debug("%s: %u %s = %s", __func__, i, argv[i], s);
370 
371 		len += strlen(s) + 1;
372 		buf = xrealloc(buf, len);
373 
374 		if (i == 0)
375 			*buf = '\0';
376 		else
377 			strlcat(buf, " ", len);
378 		strlcat(buf, s, len);
379 
380 		free(s);
381 	}
382 	return (buf);
383 }
384 
385 /* Get entry for command. */
386 const struct cmd_entry *
387 cmd_get_entry(struct cmd *cmd)
388 {
389 	return (cmd->entry);
390 }
391 
392 /* Get arguments for command. */
393 struct args *
394 cmd_get_args(struct cmd *cmd)
395 {
396 	return (cmd->args);
397 }
398 
399 /* Get group for command. */
400 u_int
401 cmd_get_group(struct cmd *cmd)
402 {
403 	return (cmd->group);
404 }
405 
406 /* Get file and line for command. */
407 void
408 cmd_get_source(struct cmd *cmd, const char **file, u_int *line)
409 {
410 	if (file != NULL)
411 		*file = cmd->file;
412 	if (line != NULL)
413 		*line = cmd->line;
414 }
415 
416 /* Look for an alias for a command. */
417 char *
418 cmd_get_alias(const char *name)
419 {
420 	struct options_entry		*o;
421 	struct options_array_item	*a;
422 	union options_value		*ov;
423 	size_t				 wanted, n;
424 	const char			*equals;
425 
426 	o = options_get_only(global_options, "command-alias");
427 	if (o == NULL)
428 		return (NULL);
429 	wanted = strlen(name);
430 
431 	a = options_array_first(o);
432 	while (a != NULL) {
433 		ov = options_array_item_value(a);
434 
435 		equals = strchr(ov->string, '=');
436 		if (equals != NULL) {
437 			n = equals - ov->string;
438 			if (n == wanted && strncmp(name, ov->string, n) == 0)
439 				return (xstrdup(equals + 1));
440 		}
441 
442 		a = options_array_next(a);
443 	}
444 	return (NULL);
445 }
446 
447 /* Look up a command entry by name. */
448 static const struct cmd_entry *
449 cmd_find(const char *name, char **cause)
450 {
451 	const struct cmd_entry	**loop, *entry, *found = NULL;
452 	int			  ambiguous;
453 	char			  s[8192];
454 
455 	ambiguous = 0;
456 	for (loop = cmd_table; *loop != NULL; loop++) {
457 		entry = *loop;
458 		if (entry->alias != NULL && strcmp(entry->alias, name) == 0) {
459 			ambiguous = 0;
460 			found = entry;
461 			break;
462 		}
463 
464 		if (strncmp(entry->name, name, strlen(name)) != 0)
465 			continue;
466 		if (found != NULL)
467 			ambiguous = 1;
468 		found = entry;
469 
470 		if (strcmp(entry->name, name) == 0)
471 			break;
472 	}
473 	if (ambiguous)
474 		goto ambiguous;
475 	if (found == NULL) {
476 		xasprintf(cause, "unknown command: %s", name);
477 		return (NULL);
478 	}
479 	return (found);
480 
481 ambiguous:
482 	*s = '\0';
483 	for (loop = cmd_table; *loop != NULL; loop++) {
484 		entry = *loop;
485 		if (strncmp(entry->name, name, strlen(name)) != 0)
486 			continue;
487 		if (strlcat(s, entry->name, sizeof s) >= sizeof s)
488 			break;
489 		if (strlcat(s, ", ", sizeof s) >= sizeof s)
490 			break;
491 	}
492 	s[strlen(s) - 2] = '\0';
493 	xasprintf(cause, "ambiguous command: %s, could be: %s", name, s);
494 	return (NULL);
495 }
496 
497 /* Parse a single command from an argument vector. */
498 struct cmd *
499 cmd_parse(int argc, char **argv, const char *file, u_int line, char **cause)
500 {
501 	const struct cmd_entry	*entry;
502 	const char		*name;
503 	struct cmd		*cmd;
504 	struct args		*args;
505 
506 	if (argc == 0) {
507 		xasprintf(cause, "no command");
508 		return (NULL);
509 	}
510 	name = argv[0];
511 
512 	entry = cmd_find(name, cause);
513 	if (entry == NULL)
514 		return (NULL);
515 	cmd_log_argv(argc, argv, "%s: %s", __func__, entry->name);
516 
517 	args = args_parse(entry->args.template, argc, argv);
518 	if (args == NULL)
519 		goto usage;
520 	if (entry->args.lower != -1 && args->argc < entry->args.lower)
521 		goto usage;
522 	if (entry->args.upper != -1 && args->argc > entry->args.upper)
523 		goto usage;
524 
525 	cmd = xcalloc(1, sizeof *cmd);
526 	cmd->entry = entry;
527 	cmd->args = args;
528 
529 	if (file != NULL)
530 		cmd->file = xstrdup(file);
531 	cmd->line = line;
532 
533 	cmd->alias = NULL;
534 	cmd->argc = argc;
535 	cmd->argv = cmd_copy_argv(argc, argv);
536 
537 	return (cmd);
538 
539 usage:
540 	if (args != NULL)
541 		args_free(args);
542 	xasprintf(cause, "usage: %s %s", entry->name, entry->usage);
543 	return (NULL);
544 }
545 
546 /* Free a command. */
547 void
548 cmd_free(struct cmd *cmd)
549 {
550 	free(cmd->alias);
551 	cmd_free_argv(cmd->argc, cmd->argv);
552 
553 	free(cmd->file);
554 
555 	args_free(cmd->args);
556 	free(cmd);
557 }
558 
559 /* Get a command as a string. */
560 char *
561 cmd_print(struct cmd *cmd)
562 {
563 	char	*out, *s;
564 
565 	s = args_print(cmd->args);
566 	if (*s != '\0')
567 		xasprintf(&out, "%s %s", cmd->entry->name, s);
568 	else
569 		out = xstrdup(cmd->entry->name);
570 	free(s);
571 
572 	return (out);
573 }
574 
575 /* Create a new command list. */
576 struct cmd_list *
577 cmd_list_new(void)
578 {
579 	struct cmd_list	*cmdlist;
580 
581 	cmdlist = xcalloc(1, sizeof *cmdlist);
582 	cmdlist->references = 1;
583 	cmdlist->group = cmd_list_next_group++;
584 	cmdlist->list = xcalloc(1, sizeof *cmdlist->list);
585 	TAILQ_INIT(cmdlist->list);
586 	return (cmdlist);
587 }
588 
589 /* Append a command to a command list. */
590 void
591 cmd_list_append(struct cmd_list *cmdlist, struct cmd *cmd)
592 {
593 	cmd->group = cmdlist->group;
594 	TAILQ_INSERT_TAIL(cmdlist->list, cmd, qentry);
595 }
596 
597 /* Move all commands from one command list to another */
598 void
599 cmd_list_move(struct cmd_list *cmdlist, struct cmd_list *from)
600 {
601 	struct cmd	*cmd, *cmd1;
602 
603 	TAILQ_FOREACH_SAFE(cmd, from->list, qentry, cmd1) {
604 		TAILQ_REMOVE(from->list, cmd, qentry);
605 		TAILQ_INSERT_TAIL(cmdlist->list, cmd, qentry);
606 	}
607 	cmdlist->group = cmd_list_next_group++;
608 }
609 
610 /* Free a command list. */
611 void
612 cmd_list_free(struct cmd_list *cmdlist)
613 {
614 	struct cmd	*cmd, *cmd1;
615 
616 	if (--cmdlist->references != 0)
617 		return;
618 
619 	TAILQ_FOREACH_SAFE(cmd, cmdlist->list, qentry, cmd1) {
620 		TAILQ_REMOVE(cmdlist->list, cmd, qentry);
621 		cmd_free(cmd);
622 	}
623 	free(cmdlist->list);
624 	free(cmdlist);
625 }
626 
627 /* Get a command list as a string. */
628 char *
629 cmd_list_print(struct cmd_list *cmdlist, int escaped)
630 {
631 	struct cmd	*cmd, *next;
632 	char		*buf, *this;
633 	size_t		 len;
634 
635 	len = 1;
636 	buf = xcalloc(1, len);
637 
638 	TAILQ_FOREACH(cmd, cmdlist->list, qentry) {
639 		this = cmd_print(cmd);
640 
641 		len += strlen(this) + 6;
642 		buf = xrealloc(buf, len);
643 
644 		strlcat(buf, this, len);
645 
646 		next = TAILQ_NEXT(cmd, qentry);
647 		if (next != NULL) {
648 			if (cmd->group != next->group) {
649 				if (escaped)
650 					strlcat(buf, " \\;\\; ", len);
651 				else
652 					strlcat(buf, " ;; ", len);
653 			} else {
654 				if (escaped)
655 					strlcat(buf, " \\; ", len);
656 				else
657 					strlcat(buf, " ; ", len);
658 			}
659 		}
660 
661 		free(this);
662 	}
663 
664 	return (buf);
665 }
666 
667 /* Get first command in list. */
668 struct cmd *
669 cmd_list_first(struct cmd_list *cmdlist)
670 {
671 	return (TAILQ_FIRST(cmdlist->list));
672 }
673 
674 /* Get next command in list. */
675 struct cmd *
676 cmd_list_next(struct cmd *cmd)
677 {
678 	return (TAILQ_NEXT(cmd, qentry));
679 }
680 
681 /* Do all of the commands in this command list have this flag? */
682 int
683 cmd_list_all_have(struct cmd_list *cmdlist, int flag)
684 {
685 	struct cmd	*cmd;
686 
687 	TAILQ_FOREACH(cmd, cmdlist->list, qentry) {
688 		if (~cmd->entry->flags & flag)
689 			return (0);
690 	}
691 	return (1);
692 }
693 
694 /* Do any of the commands in this command list have this flag? */
695 int
696 cmd_list_any_have(struct cmd_list *cmdlist, int flag)
697 {
698 	struct cmd	*cmd;
699 
700 	TAILQ_FOREACH(cmd, cmdlist->list, qentry) {
701 		if (cmd->entry->flags & flag)
702 			return (1);
703 	}
704 	return (0);
705 }
706 
707 /* Adjust current mouse position for a pane. */
708 int
709 cmd_mouse_at(struct window_pane *wp, struct mouse_event *m, u_int *xp,
710     u_int *yp, int last)
711 {
712 	u_int	x, y;
713 
714 	if (last) {
715 		x = m->lx + m->ox;
716 		y = m->ly + m->oy;
717 	} else {
718 		x = m->x + m->ox;
719 		y = m->y + m->oy;
720 	}
721 	log_debug("%s: x=%u, y=%u%s", __func__, x, y, last ? " (last)" : "");
722 
723 	if (m->statusat == 0 && y >= m->statuslines)
724 		y -= m->statuslines;
725 
726 	if (x < wp->xoff || x >= wp->xoff + wp->sx)
727 		return (-1);
728 	if (y < wp->yoff || y >= wp->yoff + wp->sy)
729 		return (-1);
730 
731 	if (xp != NULL)
732 		*xp = x - wp->xoff;
733 	if (yp != NULL)
734 		*yp = y - wp->yoff;
735 	return (0);
736 }
737 
738 /* Get current mouse window if any. */
739 struct winlink *
740 cmd_mouse_window(struct mouse_event *m, struct session **sp)
741 {
742 	struct session	*s;
743 	struct window	*w;
744 	struct winlink	*wl;
745 
746 	if (!m->valid)
747 		return (NULL);
748 	if (m->s == -1 || (s = session_find_by_id(m->s)) == NULL)
749 		return (NULL);
750 	if (m->w == -1)
751 		wl = s->curw;
752 	else {
753 		if ((w = window_find_by_id(m->w)) == NULL)
754 			return (NULL);
755 		wl = winlink_find_by_window(&s->windows, w);
756 	}
757 	if (sp != NULL)
758 		*sp = s;
759 	return (wl);
760 }
761 
762 /* Get current mouse pane if any. */
763 struct window_pane *
764 cmd_mouse_pane(struct mouse_event *m, struct session **sp,
765     struct winlink **wlp)
766 {
767 	struct winlink		*wl;
768 	struct window_pane     	*wp;
769 
770 	if ((wl = cmd_mouse_window(m, sp)) == NULL)
771 		return (NULL);
772 	if ((wp = window_pane_find_by_id(m->wp)) == NULL)
773 		return (NULL);
774 	if (!window_has_pane(wl->window, wp))
775 		return (NULL);
776 
777 	if (wlp != NULL)
778 		*wlp = wl;
779 	return (wp);
780 }
781 
782 /* Replace the first %% or %idx in template by s. */
783 char *
784 cmd_template_replace(const char *template, const char *s, int idx)
785 {
786 	char		 ch, *buf;
787 	const char	*ptr, *cp, quote[] = "\"\\$;~";
788 	int		 replaced, quoted;
789 	size_t		 len;
790 
791 	if (strchr(template, '%') == NULL)
792 		return (xstrdup(template));
793 
794 	buf = xmalloc(1);
795 	*buf = '\0';
796 	len = 0;
797 	replaced = 0;
798 
799 	ptr = template;
800 	while (*ptr != '\0') {
801 		switch (ch = *ptr++) {
802 		case '%':
803 			if (*ptr < '1' || *ptr > '9' || *ptr - '0' != idx) {
804 				if (*ptr != '%' || replaced)
805 					break;
806 				replaced = 1;
807 			}
808 			ptr++;
809 
810 			quoted = (*ptr == '%');
811 			if (quoted)
812 				ptr++;
813 
814 			buf = xrealloc(buf, len + (strlen(s) * 3) + 1);
815 			for (cp = s; *cp != '\0'; cp++) {
816 				if (quoted && strchr(quote, *cp) != NULL)
817 					buf[len++] = '\\';
818 				buf[len++] = *cp;
819 			}
820 			buf[len] = '\0';
821 			continue;
822 		}
823 		buf = xrealloc(buf, len + 2);
824 		buf[len++] = ch;
825 		buf[len] = '\0';
826 	}
827 
828 	return (buf);
829 }
830