xref: /openbsd-src/usr.bin/tmux/cmd-display-message.c (revision 0b7734b3d77bb9b21afec6f4621cae6c805dbd45)
1 /* $OpenBSD: cmd-display-message.c,v 1.35 2015/12/14 00:31:54 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 enum cmd_retval	 cmd_display_message_exec(struct cmd *, struct cmd_q *);
36 
37 const struct cmd_entry cmd_display_message_entry = {
38 	.name = "display-message",
39 	.alias = "display",
40 
41 	.args = { "c:pt:F:", 0, 1 },
42 	.usage = "[-p] [-c target-client] [-F format] "
43 		 CMD_TARGET_PANE_USAGE " [message]",
44 
45 	.cflag = CMD_CLIENT_CANFAIL,
46 	.tflag = CMD_PANE,
47 
48 	.flags = 0,
49 	.exec = cmd_display_message_exec
50 };
51 
52 enum cmd_retval
53 cmd_display_message_exec(struct cmd *self, struct cmd_q *cmdq)
54 {
55 	struct args		*args = self->args;
56 	struct client		*c = cmdq->state.c;
57 	struct session		*s = cmdq->state.tflag.s;
58 	struct winlink		*wl = cmdq->state.tflag.wl;
59 	struct window_pane	*wp = cmdq->state.tflag.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(cmdq, "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 	ft = format_create(cmdq, 0);
76 	format_defaults(ft, c, s, wl, wp);
77 
78 	msg = format_expand_time(ft, template, time(NULL));
79 	if (args_has(self->args, 'p'))
80 		cmdq_print(cmdq, "%s", msg);
81 	else
82 		status_message_set(c, "%s", msg);
83 	free(msg);
84 	format_free(ft);
85 
86 	return (CMD_RETURN_NORMAL);
87 }
88