cmd-display-message.c

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