1 /* $OpenBSD$ */
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:d:lINpt:F:v", 0, 1, NULL },
43 .usage = "[-aIlNpv] [-c target-client] [-d delay] [-F format] "
44 CMD_TARGET_PANE_USAGE " [message]",
45
46 .target = { 't', CMD_FIND_PANE, CMD_FIND_CANFAIL },
47
48 .flags = CMD_AFTERHOOK|CMD_CLIENT_CFLAG|CMD_CLIENT_CANFAIL,
49 .exec = cmd_display_message_exec
50 };
51
52 static void
cmd_display_message_each(const char * key,const char * value,void * arg)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
cmd_display_message_exec(struct cmd * self,struct cmdq_item * item)61 cmd_display_message_exec(struct cmd *self, struct cmdq_item *item)
62 {
63 struct args *args = cmd_get_args(self);
64 struct cmd_find_state *target = cmdq_get_target(item);
65 struct client *tc = cmdq_get_target_client(item), *c;
66 struct session *s = target->s;
67 struct winlink *wl = target->wl;
68 struct window_pane *wp = target->wp;
69 const char *template;
70 char *msg, *cause;
71 int delay = -1, flags, Nflag = args_has(args, 'N');
72 struct format_tree *ft;
73 u_int count = args_count(args);
74 struct evbuffer *evb;
75
76 if (args_has(args, 'I')) {
77 if (wp == NULL)
78 return (CMD_RETURN_NORMAL);
79 switch (window_pane_start_input(wp, item, &cause)) {
80 case -1:
81 cmdq_error(item, "%s", cause);
82 free(cause);
83 return (CMD_RETURN_ERROR);
84 case 1:
85 return (CMD_RETURN_NORMAL);
86 case 0:
87 return (CMD_RETURN_WAIT);
88 }
89 }
90
91 if (args_has(args, 'F') && count != 0) {
92 cmdq_error(item, "only one of -F or argument must be given");
93 return (CMD_RETURN_ERROR);
94 }
95
96 if (args_has(args, 'd')) {
97 delay = args_strtonum(args, 'd', 0, UINT_MAX, &cause);
98 if (cause != NULL) {
99 cmdq_error(item, "delay %s", cause);
100 free(cause);
101 return (CMD_RETURN_ERROR);
102 }
103 }
104
105 if (count != 0)
106 template = args_string(args, 0);
107 else
108 template = args_get(args, 'F');
109 if (template == NULL)
110 template = DISPLAY_MESSAGE_TEMPLATE;
111
112 /*
113 * -c is intended to be the client where the message should be
114 * displayed if -p is not given. But it makes sense to use it for the
115 * formats too, assuming it matches the session. If it doesn't, use the
116 * best client for the session.
117 */
118 if (tc != NULL && tc->session == s)
119 c = tc;
120 else if (s != NULL)
121 c = cmd_find_best_client(s);
122 else
123 c = NULL;
124 if (args_has(args, 'v'))
125 flags = FORMAT_VERBOSE;
126 else
127 flags = 0;
128 ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, flags);
129 format_defaults(ft, c, s, wl, wp);
130
131 if (args_has(args, 'a')) {
132 format_each(ft, cmd_display_message_each, item);
133 return (CMD_RETURN_NORMAL);
134 }
135
136 if (args_has(args, 'l'))
137 msg = xstrdup(template);
138 else
139 msg = format_expand_time(ft, template);
140
141 if (cmdq_get_client(item) == NULL)
142 cmdq_error(item, "%s", msg);
143 else if (args_has(args, 'p'))
144 cmdq_print(item, "%s", msg);
145 else if (tc != NULL && (tc->flags & CLIENT_CONTROL)) {
146 evb = evbuffer_new();
147 if (evb == NULL)
148 fatalx("out of memory");
149 evbuffer_add_printf(evb, "%%message %s", msg);
150 server_client_print(tc, 0, evb);
151 evbuffer_free(evb);
152 } else if (tc != NULL)
153 status_message_set(tc, delay, 0, Nflag, "%s", msg);
154 free(msg);
155
156 format_free(ft);
157
158 return (CMD_RETURN_NORMAL);
159 }
160