1 /* $OpenBSD: cmd-display-message.c,v 1.61 2021/10/07 07:52:13 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 = { "ac:d:INpt:F:v", 0, 1, NULL }, 43 .usage = "[-aINpv] [-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 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 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; 72 struct format_tree *ft; 73 u_int count = args_count(args); 74 75 if (args_has(args, 'I')) { 76 if (wp == NULL) 77 return (CMD_RETURN_NORMAL); 78 switch (window_pane_start_input(wp, item, &cause)) { 79 case -1: 80 cmdq_error(item, "%s", cause); 81 free(cause); 82 return (CMD_RETURN_ERROR); 83 case 1: 84 return (CMD_RETURN_NORMAL); 85 case 0: 86 return (CMD_RETURN_WAIT); 87 } 88 } 89 90 if (args_has(args, 'F') && count != 0) { 91 cmdq_error(item, "only one of -F or argument must be given"); 92 return (CMD_RETURN_ERROR); 93 } 94 95 if (args_has(args, 'd')) { 96 delay = args_strtonum(args, 'd', 0, UINT_MAX, &cause); 97 if (cause != NULL) { 98 cmdq_error(item, "delay %s", cause); 99 free(cause); 100 return (CMD_RETURN_ERROR); 101 } 102 } 103 104 if (count != 0) 105 template = args_string(args, 0); 106 else 107 template = args_get(args, 'F'); 108 if (template == NULL) 109 template = DISPLAY_MESSAGE_TEMPLATE; 110 111 /* 112 * -c is intended to be the client where the message should be 113 * displayed if -p is not given. But it makes sense to use it for the 114 * formats too, assuming it matches the session. If it doesn't, use the 115 * best client for the session. 116 */ 117 if (tc != NULL && tc->session == s) 118 c = tc; 119 else if (s != NULL) 120 c = cmd_find_best_client(s); 121 else 122 c = NULL; 123 if (args_has(args, 'v')) 124 flags = FORMAT_VERBOSE; 125 else 126 flags = 0; 127 ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, flags); 128 format_defaults(ft, c, s, wl, wp); 129 130 if (args_has(args, 'a')) { 131 format_each(ft, cmd_display_message_each, item); 132 return (CMD_RETURN_NORMAL); 133 } 134 135 msg = format_expand_time(ft, template); 136 if (cmdq_get_client(item) == NULL) 137 cmdq_error(item, "%s", msg); 138 else if (args_has(args, 'p')) 139 cmdq_print(item, "%s", msg); 140 else if (tc != NULL) { 141 status_message_set(tc, delay, 0, args_has(args, 'N'), "%s", 142 msg); 143 } 144 free(msg); 145 146 format_free(ft); 147 148 return (CMD_RETURN_NORMAL); 149 } 150