xref: /openbsd-src/usr.bin/tmux/cmd-display-message.c (revision c90a81c56dcebd6a1b73fe4aff9b03385b8e63b3)
1 /* $OpenBSD: cmd-display-message.c,v 1.44 2018/04/23 13:43:08 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 = { "c:pt:F:", 0, 1 },
43 	.usage = "[-p] [-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 enum cmd_retval
53 cmd_display_message_exec(struct cmd *self, struct cmdq_item *item)
54 {
55 	struct args		*args = self->args;
56 	struct client		*c, *target_c;
57 	struct session		*s = item->target.s;
58 	struct winlink		*wl = item->target.wl;
59 	struct window_pane	*wp = item->target.wp;
60 	const char		*template;
61 	char			*msg;
62 	struct format_tree	*ft;
63 
64 	if (args_has(args, 'F') && args->argc != 0) {
65 		cmdq_error(item, "only one of -F or argument must be given");
66 		return (CMD_RETURN_ERROR);
67 	}
68 
69 	template = args_get(args, 'F');
70 	if (args->argc != 0)
71 		template = args->argv[0];
72 	if (template == NULL)
73 		template = DISPLAY_MESSAGE_TEMPLATE;
74 
75 	/*
76 	 * -c is intended to be the client where the message should be
77 	 * displayed if -p is not given. But it makes sense to use it for the
78 	 * formats too, assuming it matches the session. If it doesn't, use the
79 	 * best client for the session.
80 	 */
81 	c = cmd_find_client(item, args_get(args, 'c'), 1);
82 	if (c != NULL && c->session == s)
83 		target_c = c;
84 	else
85 		target_c = cmd_find_best_client(s);
86 	ft = format_create(item->client, item, FORMAT_NONE, 0);
87 	format_defaults(ft, target_c, s, wl, wp);
88 
89 	msg = format_expand_time(ft, template, time(NULL));
90 	if (args_has(self->args, 'p'))
91 		cmdq_print(item, "%s", msg);
92 	else if (c != NULL)
93 		status_message_set(c, "%s", msg);
94 	free(msg);
95 
96 	format_free(ft);
97 
98 	return (CMD_RETURN_NORMAL);
99 }
100