Annotation of src/usr.bin/tmux/cmd-display-message.c, Revision 1.54
1.54 ! nicm 1: /* $OpenBSD: cmd-display-message.c,v 1.53 2020/04/13 20:51:57 nicm Exp $ */
1.1 nicm 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:
1.14 nicm 21: #include <stdlib.h>
1.1 nicm 22: #include <time.h>
23:
24: #include "tmux.h"
25:
26: /*
27: * Displays a message in the status line.
28: */
1.26 nicm 29:
30: #define DISPLAY_MESSAGE_TEMPLATE \
31: "[#{session_name}] #{window_index}:" \
32: "#{window_name}, current pane #{pane_index} " \
33: "- (%H:%M %d-%b-%y)"
1.1 nicm 34:
1.39 nicm 35: static enum cmd_retval cmd_display_message_exec(struct cmd *,
36: struct cmdq_item *);
1.1 nicm 37:
38: const struct cmd_entry cmd_display_message_entry = {
1.34 nicm 39: .name = "display-message",
40: .alias = "display",
41:
1.49 nicm 42: .args = { "ac:Ipt:F:v", 0, 1 },
43: .usage = "[-aIpv] [-c target-client] [-F format] "
1.34 nicm 44: CMD_TARGET_PANE_USAGE " [message]",
45:
1.41 nicm 46: .target = { 't', CMD_FIND_PANE, 0 },
1.35 nicm 47:
1.53 nicm 48: .flags = CMD_AFTERHOOK|CMD_CLIENT_CFLAG|CMD_CLIENT_CANFAIL,
1.34 nicm 49: .exec = cmd_display_message_exec
1.1 nicm 50: };
51:
1.48 nicm 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:
1.37 nicm 60: static enum cmd_retval
1.39 nicm 61: cmd_display_message_exec(struct cmd *self, struct cmdq_item *item)
1.1 nicm 62: {
1.51 nicm 63: struct args *args = cmd_get_args(self);
1.52 nicm 64: struct cmd_find_state *target = cmdq_get_target(item);
1.53 nicm 65: struct client *tc = cmdq_get_target_client(item), *c;
1.52 nicm 66: struct session *s = target->s;
67: struct winlink *wl = target->wl;
68: struct window_pane *wp = target->wp;
1.1 nicm 69: const char *template;
1.49 nicm 70: char *msg, *cause;
1.11 nicm 71: struct format_tree *ft;
1.47 nicm 72: int flags;
1.49 nicm 73:
74: if (args_has(args, 'I')) {
75: if (window_pane_start_input(wp, item, &cause) != 0) {
76: cmdq_error(item, "%s", cause);
77: free(cause);
78: return (CMD_RETURN_ERROR);
79: }
80: return (CMD_RETURN_WAIT);
81: }
1.1 nicm 82:
1.11 nicm 83: if (args_has(args, 'F') && args->argc != 0) {
1.39 nicm 84: cmdq_error(item, "only one of -F or argument must be given");
1.15 nicm 85: return (CMD_RETURN_ERROR);
1.22 nicm 86: }
87:
1.11 nicm 88: template = args_get(args, 'F');
89: if (args->argc != 0)
90: template = args->argv[0];
91: if (template == NULL)
1.16 nicm 92: template = DISPLAY_MESSAGE_TEMPLATE;
1.1 nicm 93:
1.43 nicm 94: /*
95: * -c is intended to be the client where the message should be
96: * displayed if -p is not given. But it makes sense to use it for the
97: * formats too, assuming it matches the session. If it doesn't, use the
98: * best client for the session.
99: */
1.53 nicm 100: if (tc != NULL && tc->session == s)
101: c = tc;
1.43 nicm 102: else
1.53 nicm 103: c = cmd_find_best_client(s);
1.51 nicm 104: if (args_has(args, 'v'))
1.47 nicm 105: flags = FORMAT_VERBOSE;
106: else
107: flags = 0;
1.52 nicm 108: ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, flags);
1.53 nicm 109: format_defaults(ft, c, s, wl, wp);
1.48 nicm 110:
111: if (args_has(args, 'a')) {
1.50 nicm 112: format_each(ft, cmd_display_message_each, item);
1.48 nicm 113: return (CMD_RETURN_NORMAL);
114: }
1.11 nicm 115:
1.46 nicm 116: msg = format_expand_time(ft, template);
1.51 nicm 117: if (args_has(args, 'p'))
1.39 nicm 118: cmdq_print(item, "%s", msg);
1.53 nicm 119: else if (tc != NULL)
1.54 ! nicm 120: status_message_set(tc, 0, "%s", msg);
1.14 nicm 121: free(msg);
1.36 nicm 122:
1.12 nicm 123: format_free(ft);
1.20 nicm 124:
1.15 nicm 125: return (CMD_RETURN_NORMAL);
1.1 nicm 126: }