xref: /openbsd-src/usr.bin/tmux/cmd-display-message.c (revision d4741794dd2f512d997014f8bd85fbb24d935059)
1 /* $OpenBSD: cmd-display-message.c,v 1.39 2016/10/16 19:04:05 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 	.cflag = CMD_CLIENT_CANFAIL,
47 	.tflag = CMD_PANE,
48 
49 	.flags = CMD_AFTERHOOK,
50 	.exec = cmd_display_message_exec
51 };
52 
53 static enum cmd_retval
54 cmd_display_message_exec(struct cmd *self, struct cmdq_item *item)
55 {
56 	struct args		*args = self->args;
57 	struct client		*c = item->state.c;
58 	struct session		*s = item->state.tflag.s;
59 	struct winlink		*wl = item->state.tflag.wl;
60 	struct window_pane	*wp = item->state.tflag.wp;
61 	const char		*template;
62 	char			*msg;
63 	struct format_tree	*ft;
64 
65 	if (args_has(args, 'F') && args->argc != 0) {
66 		cmdq_error(item, "only one of -F or argument must be given");
67 		return (CMD_RETURN_ERROR);
68 	}
69 
70 	template = args_get(args, 'F');
71 	if (args->argc != 0)
72 		template = args->argv[0];
73 	if (template == NULL)
74 		template = DISPLAY_MESSAGE_TEMPLATE;
75 
76 	ft = format_create(item, 0);
77 	format_defaults(ft, c, s, wl, wp);
78 
79 	msg = format_expand_time(ft, template, time(NULL));
80 	if (args_has(self->args, 'p'))
81 		cmdq_print(item, "%s", msg);
82 	else if (c != NULL)
83 		status_message_set(c, "%s", msg);
84 	free(msg);
85 
86 	format_free(ft);
87 
88 	return (CMD_RETURN_NORMAL);
89 }
90