xref: /openbsd-src/usr.bin/tmux/cmd-display-message.c (revision 4b70baf6e17fc8b27fc1f7fa7929335753fa94c3)
1 /* $OpenBSD: cmd-display-message.c,v 1.49 2019/05/03 20:44:24 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2009 Tiago Cunha <me@tiagocunha.org>
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 
21 #include <stdlib.h>
22 #include <time.h>
23 
24 #include "tmux.h"
25 
26 /*
27  * Displays a message in the status line.
28  */
29 
30 #define DISPLAY_MESSAGE_TEMPLATE			\
31 	"[#{session_name}] #{window_index}:"		\
32 	"#{window_name}, current pane #{pane_index} "	\
33 	"- (%H:%M %d-%b-%y)"
34 
35 static enum cmd_retval	cmd_display_message_exec(struct cmd *,
36 			    struct cmdq_item *);
37 
38 const struct cmd_entry cmd_display_message_entry = {
39 	.name = "display-message",
40 	.alias = "display",
41 
42 	.args = { "ac:Ipt:F:v", 0, 1 },
43 	.usage = "[-aIpv] [-c target-client] [-F format] "
44 		 CMD_TARGET_PANE_USAGE " [message]",
45 
46 	.target = { 't', CMD_FIND_PANE, 0 },
47 
48 	.flags = CMD_AFTERHOOK,
49 	.exec = cmd_display_message_exec
50 };
51 
52 static void
53 cmd_display_message_each(const char *key, const char *value, void *arg)
54 {
55 	struct cmdq_item	*item = arg;
56 
57 	cmdq_print(item, "%s=%s", key, value);
58 }
59 
60 static enum cmd_retval
61 cmd_display_message_exec(struct cmd *self, struct cmdq_item *item)
62 {
63 	struct args		*args = self->args;
64 	struct client		*c, *target_c;
65 	struct session		*s = item->target.s;
66 	struct winlink		*wl = item->target.wl;
67 	struct window_pane	*wp = item->target.wp;
68 	const char		*template;
69 	char			*msg, *cause;
70 	struct format_tree	*ft;
71 	int			 flags;
72 
73 	if (args_has(args, 'I')) {
74 		if (window_pane_start_input(wp, item, &cause) != 0) {
75 			cmdq_error(item, "%s", cause);
76 			free(cause);
77 			return (CMD_RETURN_ERROR);
78 		}
79 		return (CMD_RETURN_WAIT);
80 	}
81 
82 	if (args_has(args, 'F') && args->argc != 0) {
83 		cmdq_error(item, "only one of -F or argument must be given");
84 		return (CMD_RETURN_ERROR);
85 	}
86 
87 	template = args_get(args, 'F');
88 	if (args->argc != 0)
89 		template = args->argv[0];
90 	if (template == NULL)
91 		template = DISPLAY_MESSAGE_TEMPLATE;
92 
93 	/*
94 	 * -c is intended to be the client where the message should be
95 	 * displayed if -p is not given. But it makes sense to use it for the
96 	 * formats too, assuming it matches the session. If it doesn't, use the
97 	 * best client for the session.
98 	 */
99 	c = cmd_find_client(item, args_get(args, 'c'), 1);
100 	if (c != NULL && c->session == s)
101 		target_c = c;
102 	else
103 		target_c = cmd_find_best_client(s);
104 	if (args_has(self->args, 'v'))
105 		flags = FORMAT_VERBOSE;
106 	else
107 		flags = 0;
108 	ft = format_create(item->client, item, FORMAT_NONE, flags);
109 	format_defaults(ft, target_c, s, wl, wp);
110 
111 	if (args_has(args, 'a')) {
112 		if (item != NULL)
113 			format_each(ft, cmd_display_message_each, item);
114 		return (CMD_RETURN_NORMAL);
115 	}
116 
117 	msg = format_expand_time(ft, template);
118 	if (args_has(self->args, 'p'))
119 		cmdq_print(item, "%s", msg);
120 	else if (c != NULL)
121 		status_message_set(c, "%s", msg);
122 	free(msg);
123 
124 	format_free(ft);
125 
126 	return (CMD_RETURN_NORMAL);
127 }
128