Coverage Report

Created: 2026-07-09 06:08

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/tmux/cmd-display-menu.c
Line
Count
Source
1
/* $OpenBSD$ */
2
3
/*
4
 * Copyright (c) 2019 Nicholas Marriott <nicholas.marriott@gmail.com>
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 <string.h>
23
24
#include "tmux.h"
25
26
/*
27
 * Display a menu on a client.
28
 */
29
30
static enum args_parse_type cmd_display_menu_args_parse(struct args *,
31
            u_int, char **);
32
static enum cmd_retval    cmd_display_menu_exec(struct cmd *,
33
            struct cmdq_item *);
34
static enum cmd_retval    cmd_display_popup_exec(struct cmd *,
35
            struct cmdq_item *);
36
37
const struct cmd_entry cmd_display_menu_entry = {
38
  .name = "display-menu",
39
  .alias = "menu",
40
41
  .args = { "b:c:C:H:s:S:MOt:T:x:y:", 1, -1, cmd_display_menu_args_parse },
42
  .usage = "[-MO] [-b border-lines] [-c target-client] "
43
     "[-C starting-choice] [-H selected-style] [-s style] "
44
     "[-S border-style] " CMD_TARGET_PANE_USAGE " [-T title] "
45
     "[-x position] [-y position] name [key] [command] ...",
46
47
  .target = { 't', CMD_FIND_PANE, 0 },
48
49
  .flags = CMD_AFTERHOOK|CMD_CLIENT_CFLAG,
50
  .exec = cmd_display_menu_exec
51
};
52
53
const struct cmd_entry cmd_display_popup_entry = {
54
  .name = "display-popup",
55
  .alias = "popup",
56
57
  .args = { "Bb:Cc:d:e:Eh:kNs:S:t:T:w:x:y:", 0, -1, NULL },
58
  .usage = "[-BCEkN] [-b border-lines] [-c target-client] "
59
     "[-d start-directory] [-e environment] [-h height] "
60
     "[-s style] [-S border-style] " CMD_TARGET_PANE_USAGE
61
     " [-T title] [-w width] [-x position] [-y position] "
62
     "[shell-command [argument ...]]",
63
64
  .target = { 't', CMD_FIND_PANE, 0 },
65
66
  .flags = CMD_AFTERHOOK|CMD_CLIENT_CFLAG,
67
  .exec = cmd_display_popup_exec
68
};
69
70
static enum args_parse_type
71
cmd_display_menu_args_parse(struct args *args, u_int idx, __unused char **cause)
72
5.07k
{
73
5.07k
  u_int      i = 0;
74
5.07k
  enum args_parse_type   type = ARGS_PARSE_STRING;
75
76
340k
  for (;;) {
77
340k
    type = ARGS_PARSE_STRING;
78
340k
    if (i == idx)
79
2.09k
      break;
80
338k
    if (*args_string(args, i++) == '\0')
81
47.2k
      continue;
82
83
291k
    type = ARGS_PARSE_STRING;
84
291k
    if (i++ == idx)
85
1.50k
      break;
86
87
290k
    type = ARGS_PARSE_COMMANDS_OR_STRING;
88
290k
    if (i++ == idx)
89
1.47k
      break;
90
290k
  }
91
5.07k
  return (type);
92
5.07k
}
93
94
static int
95
cmd_display_menu_get_pos(struct client *tc, struct cmdq_item *item,
96
    struct args *args, u_int *px, u_int *py, u_int w, u_int h)
97
0
{
98
0
  struct tty    *tty = &tc->tty;
99
0
  struct cmd_find_state *target = cmdq_get_target(item);
100
0
  struct key_event  *event = cmdq_get_event(item);
101
0
  struct session    *s = tc->session;
102
0
  struct winlink    *wl = target->wl;
103
0
  struct window_pane  *wp = target->wp;
104
0
  struct style_ranges *ranges = NULL;
105
0
  struct style_range  *sr = NULL;
106
0
  const char    *xp, *yp;
107
0
  char      *p;
108
0
  int      top;
109
0
  u_int      line, ox, oy, sx, sy, lines, position;
110
0
  long       n;
111
0
  struct format_tree  *ft;
112
113
  /*
114
   * Work out the position from the -x and -y arguments. This is the
115
   * bottom-left position.
116
   */
117
118
  /* If the popup is too big, stop now. */
119
0
  if (w > tty->sx || h > tty->sy)
120
0
    return (0);
121
122
  /* Create format with mouse position if any. */
123
0
  ft = format_create_from_target(item);
124
0
  if (event->m.valid) {
125
0
    format_add(ft, "popup_mouse_x", "%u", event->m.x);
126
0
    format_add(ft, "popup_mouse_y", "%u", event->m.y);
127
0
  }
128
129
  /* Position of the previous menu, for -x/-y L. */
130
0
  format_add(ft, "popup_last_x", "%u", tc->menu_last_px);
131
0
  format_add(ft, "popup_last_y", "%u", tc->menu_last_py + h);
132
133
  /*
134
   * If there are any status lines, add this window position and the
135
   * status line position.
136
   */
137
0
  top = status_at_line(tc);
138
0
  if (top != -1) {
139
0
    lines = status_line_size(tc);
140
0
    if (top == 0)
141
0
      top = lines;
142
0
    else
143
0
      top = 0;
144
0
    position = options_get_number(s->options, "status-position");
145
146
0
    for (line = 0; line < lines; line++) {
147
0
      ranges = &tc->status.entries[line].ranges;
148
0
      TAILQ_FOREACH(sr, ranges, entry) {
149
0
        if (sr->type != STYLE_RANGE_WINDOW)
150
0
          continue;
151
0
        if (sr->argument == (u_int)wl->idx)
152
0
          break;
153
0
      }
154
0
      if (sr != NULL)
155
0
        break;
156
0
    }
157
158
0
    if (sr != NULL) {
159
0
      format_add(ft, "popup_window_status_line_x", "%u",
160
0
          sr->start);
161
0
      if (position == 0) {
162
0
        format_add(ft, "popup_window_status_line_y",
163
0
            "%u", line + 1 + h);
164
0
      } else {
165
0
        format_add(ft, "popup_window_status_line_y",
166
0
            "%u", tty->sy - lines + line);
167
0
      }
168
0
    }
169
170
0
    if (position == 0)
171
0
      format_add(ft, "popup_status_line_y", "%u", lines + h);
172
0
    else {
173
0
      format_add(ft, "popup_status_line_y", "%u",
174
0
          tty->sy - lines);
175
0
    }
176
0
  } else
177
0
    top = 0;
178
179
  /* Popup width and height. */
180
0
  format_add(ft, "popup_width", "%u", w);
181
0
  format_add(ft, "popup_height", "%u", h);
182
183
  /* Position so popup is in the centre. */
184
0
  n = (long)(tty->sx - 1) / 2 - w / 2;
185
0
  if (n < 0)
186
0
    format_add(ft, "popup_centre_x", "%u", 0);
187
0
  else
188
0
    format_add(ft, "popup_centre_x", "%ld", n);
189
0
  n = (tty->sy - 1) / 2 + h / 2;
190
0
  if (n >= tty->sy)
191
0
    format_add(ft, "popup_centre_y", "%u", tty->sy - h);
192
0
  else
193
0
    format_add(ft, "popup_centre_y", "%ld", n);
194
195
  /* Position of popup relative to mouse. */
196
0
  if (event->m.valid) {
197
0
    n = (long)event->m.x - w / 2;
198
0
    if (n < 0)
199
0
      format_add(ft, "popup_mouse_centre_x", "%u", 0);
200
0
    else
201
0
      format_add(ft, "popup_mouse_centre_x", "%ld", n);
202
0
    n = event->m.y - h / 2;
203
0
    if (n + h >= tty->sy) {
204
0
      format_add(ft, "popup_mouse_centre_y", "%u",
205
0
          tty->sy - h);
206
0
    } else
207
0
      format_add(ft, "popup_mouse_centre_y", "%ld", n);
208
0
    n = (long)event->m.y + h;
209
0
    if (n >= tty->sy)
210
0
      format_add(ft, "popup_mouse_top", "%u", tty->sy - 1);
211
0
    else
212
0
      format_add(ft, "popup_mouse_top", "%ld", n);
213
0
    n = event->m.y - h;
214
0
    if (n < 0)
215
0
      format_add(ft, "popup_mouse_bottom", "%u", 0);
216
0
    else
217
0
      format_add(ft, "popup_mouse_bottom", "%ld", n);
218
0
  }
219
220
  /* Position in pane. */
221
0
  tty_window_offset(&tc->tty, &ox, &oy, &sx, &sy);
222
0
  n = top + wp->yoff - oy + h;
223
0
  if (n >= tty->sy)
224
0
    format_add(ft, "popup_pane_top", "%u", tty->sy - h);
225
0
  else
226
0
    format_add(ft, "popup_pane_top", "%ld", n);
227
0
  format_add(ft, "popup_pane_bottom", "%u", top + wp->yoff + wp->sy - oy);
228
0
  format_add(ft, "popup_pane_left", "%u", wp->xoff - ox);
229
0
  n = (long)wp->xoff + wp->sx - ox - w;
230
0
  if (n < 0)
231
0
    format_add(ft, "popup_pane_right", "%u", 0);
232
0
  else
233
0
    format_add(ft, "popup_pane_right", "%ld", n);
234
235
  /* Expand horizontal position. */
236
0
  xp = args_get(args, 'x');
237
0
  if (xp == NULL || strcmp(xp, "C") == 0)
238
0
    xp = "#{popup_centre_x}";
239
0
  else if (strcmp(xp, "R") == 0)
240
0
    xp = "#{popup_pane_right}";
241
0
  else if (strcmp(xp, "P") == 0)
242
0
    xp = "#{popup_pane_left}";
243
0
  else if (strcmp(xp, "M") == 0)
244
0
    xp = "#{popup_mouse_centre_x}";
245
0
  else if (strcmp(xp, "L") == 0)
246
0
    xp = "#{popup_last_x}";
247
0
  else if (strcmp(xp, "W") == 0)
248
0
    xp = "#{popup_window_status_line_x}";
249
0
  p = format_expand(ft, xp);
250
0
  n = strtol(p, NULL, 10);
251
0
  if (n + w >= tty->sx)
252
0
    n = tty->sx - w;
253
0
  else if (n < 0)
254
0
    n = 0;
255
0
  *px = n;
256
0
  log_debug("%s: -x: %s = %s = %u (-w %u)", __func__, xp, p, *px, w);
257
0
  free(p);
258
259
  /* Expand vertical position  */
260
0
  yp = args_get(args, 'y');
261
0
  if (yp == NULL || strcmp(yp, "C") == 0)
262
0
    yp = "#{popup_centre_y}";
263
0
  else if (strcmp(yp, "P") == 0)
264
0
    yp = "#{popup_pane_bottom}";
265
0
  else if (strcmp(yp, "M") == 0)
266
0
    yp = "#{popup_mouse_top}";
267
0
  else if (strcmp(yp, "L") == 0)
268
0
    yp = "#{popup_last_y}";
269
0
  else if (strcmp(yp, "S") == 0)
270
0
    yp = "#{popup_status_line_y}";
271
0
  else if (strcmp(yp, "W") == 0)
272
0
    yp = "#{popup_window_status_line_y}";
273
0
  p = format_expand(ft, yp);
274
0
  n = strtol(p, NULL, 10);
275
0
  if (n < h)
276
0
    n = 0;
277
0
  else
278
0
    n -= h;
279
0
  if (n + h >= tty->sy)
280
0
    n = tty->sy - h;
281
0
  else if (n < 0)
282
0
    n = 0;
283
0
  *py = n;
284
0
  log_debug("%s: -y: %s = %s = %u (-h %u)", __func__, yp, p, *py, h);
285
0
  free(p);
286
287
0
  format_free(ft);
288
0
  return (1);
289
0
}
290
291
static enum cmd_retval
292
cmd_display_menu_exec(struct cmd *self, struct cmdq_item *item)
293
0
{
294
0
  struct args   *args = cmd_get_args(self);
295
0
  struct cmd_find_state *target = cmdq_get_target(item);
296
0
  struct key_event  *event = cmdq_get_event(item);
297
0
  struct client   *tc = cmdq_get_target_client(item);
298
0
  struct menu   *menu = NULL;
299
0
  struct menu_item   menu_item;
300
0
  const char    *key, *name, *value;
301
0
  const char    *style = args_get(args, 's');
302
0
  const char    *border_style = args_get(args, 'S');
303
0
  const char    *selected_style = args_get(args, 'H');
304
0
  enum box_lines     lines = BOX_LINES_DEFAULT;
305
0
  char      *title, *cause = NULL;
306
0
  int      flags = 0, starting_choice = 0;
307
0
  u_int      px, py, i, count = args_count(args);
308
0
  struct options    *o = target->s->curw->window->options;
309
0
  struct options_entry  *oe;
310
311
312
0
  if (tc->overlay_draw != NULL)
313
0
    return (CMD_RETURN_NORMAL);
314
315
0
  if (args_has(args, 'C')) {
316
0
    if (strcmp(args_get(args, 'C'), "-") == 0)
317
0
      starting_choice = -1;
318
0
    else {
319
0
      starting_choice = args_strtonum(args, 'C', 0, UINT_MAX,
320
0
          &cause);
321
0
      if (cause != NULL) {
322
0
        cmdq_error(item, "starting choice %s", cause);
323
0
        goto fail;
324
0
      }
325
0
    }
326
0
  }
327
328
0
  if (args_has(args, 'T'))
329
0
    title = format_single_from_target(item, args_get(args, 'T'));
330
0
  else
331
0
    title = xstrdup("");
332
0
  menu = menu_create(title);
333
0
  free(title);
334
335
0
  for (i = 0; i != count; /* nothing */) {
336
0
    name = args_string(args, i++);
337
0
    if (*name == '\0') {
338
0
      menu_add_item(menu, NULL, item, tc, target);
339
0
      continue;
340
0
    }
341
342
0
    if (count - i < 2) {
343
0
      cmdq_error(item, "not enough arguments");
344
0
      goto fail;
345
0
    }
346
0
    key = args_string(args, i++);
347
348
0
    menu_item.name = name;
349
0
    menu_item.key = key_string_lookup_string(key);
350
0
    menu_item.command = args_string(args, i++);
351
352
0
    menu_add_item(menu, &menu_item, item, tc, target);
353
0
  }
354
0
  if (menu == NULL) {
355
0
    cmdq_error(item, "invalid menu arguments");
356
0
    goto fail;
357
0
  }
358
0
  if (menu->count == 0)
359
0
    goto out;
360
0
  if (!cmd_display_menu_get_pos(tc, item, args, &px, &py, menu->width + 4,
361
0
      menu->count + 2))
362
0
    goto out;
363
364
0
  value = args_get(args, 'b');
365
0
  if (value != NULL) {
366
0
    oe = options_get(o, "menu-border-lines");
367
0
    lines = options_find_choice(options_table_entry(oe), value,
368
0
        &cause);
369
0
    if (lines == -1) {
370
0
      cmdq_error(item, "menu-border-lines %s", cause);
371
0
      goto fail;
372
0
    }
373
0
  }
374
375
0
  if (args_has(args, 'O'))
376
0
    flags |= MENU_STAYOPEN;
377
0
  if (!event->m.valid && !args_has(args, 'M'))
378
0
    flags |= MENU_NOMOUSE;
379
0
  if (menu_display(menu, flags, starting_choice, item, px, py, tc, lines,
380
0
      style, selected_style, border_style, target, NULL, NULL) != 0)
381
0
    goto out;
382
0
  return (CMD_RETURN_WAIT);
383
384
0
out:
385
0
  menu_free(menu);
386
0
  return (CMD_RETURN_NORMAL);
387
388
0
fail:
389
0
  free(cause);
390
0
  menu_free(menu);
391
0
  return (CMD_RETURN_ERROR);
392
0
}
393
394
static enum cmd_retval
395
cmd_display_popup_exec(struct cmd *self, struct cmdq_item *item)
396
0
{
397
0
  struct args   *args = cmd_get_args(self);
398
0
  struct cmd_find_state *target = cmdq_get_target(item);
399
0
  struct session    *s = target->s;
400
0
  struct client   *tc = cmdq_get_target_client(item);
401
0
  struct tty    *tty = &tc->tty;
402
0
  const char    *value, *shell, *shellcmd = NULL;
403
0
  const char    *style = args_get(args, 's');
404
0
  const char    *border_style = args_get(args, 'S');
405
0
  char      *cwd = NULL, *cause = NULL, **argv = NULL;
406
0
  char      *title = NULL;
407
0
  int      modify = popup_present(tc);
408
0
  int      flags = -1, argc = 0;
409
0
  enum box_lines     lines = BOX_LINES_DEFAULT;
410
0
  u_int      px, py, w, h, count = args_count(args);
411
0
  struct args_value *av;
412
0
  struct environ    *env = NULL;
413
0
  struct options    *o = s->curw->window->options;
414
0
  struct options_entry  *oe;
415
416
0
  if (args_has(args, 'C')) {
417
0
    server_client_clear_overlay(tc);
418
0
    return (CMD_RETURN_NORMAL);
419
0
  }
420
0
  if (!modify && tc->overlay_draw != NULL)
421
0
    return (CMD_RETURN_NORMAL);
422
423
0
  if (!modify) {
424
0
    h = tty->sy / 2;
425
0
    if (args_has(args, 'h')) {
426
0
      h = args_percentage(args, 'h', 1, tty->sy, tty->sy,
427
0
          &cause);
428
0
      if (cause != NULL) {
429
0
        cmdq_error(item, "height %s", cause);
430
0
        goto fail;
431
0
      }
432
0
    }
433
434
0
    w = tty->sx / 2;
435
0
    if (args_has(args, 'w')) {
436
0
      w = args_percentage(args, 'w', 1, tty->sx, tty->sx,
437
0
          &cause);
438
0
      if (cause != NULL) {
439
0
        cmdq_error(item, "width %s", cause);
440
0
        goto fail;
441
0
      }
442
0
    }
443
444
0
    if (w > tty->sx)
445
0
      w = tty->sx;
446
0
    if (h > tty->sy)
447
0
      h = tty->sy;
448
0
    if (!cmd_display_menu_get_pos(tc, item, args, &px, &py, w, h))
449
0
      goto out;
450
451
0
    value = args_get(args, 'd');
452
0
    if (value != NULL)
453
0
      cwd = format_single_from_target(item, value);
454
0
    else
455
0
      cwd = xstrdup(server_client_get_cwd(tc, s));
456
0
    if (count == 0) {
457
0
      shellcmd = options_get_string(s->options,
458
0
          "default-command");
459
0
    } else if (count == 1)
460
0
      shellcmd = args_string(args, 0);
461
0
    if (count <= 1 && (shellcmd == NULL || *shellcmd == '\0')) {
462
0
      shellcmd = NULL;
463
0
      shell = options_get_string(s->options, "default-shell");
464
0
      if (!checkshell(shell))
465
0
        shell = _PATH_BSHELL;
466
0
      cmd_append_argv(&argc, &argv, shell);
467
0
    } else
468
0
      args_to_vector(args, &argc, &argv);
469
470
0
    if (args_has(args, 'e') >= 1) {
471
0
      env = environ_create();
472
0
      av = args_first_value(args, 'e');
473
0
      while (av != NULL) {
474
0
        environ_put(env, av->string, 0);
475
0
        av = args_next_value(av);
476
0
      }
477
0
    }
478
0
  }
479
480
0
  value = args_get(args, 'b');
481
0
  if (args_has(args, 'B'))
482
0
    lines = BOX_LINES_NONE;
483
0
  else if (value != NULL) {
484
0
    oe = options_get(o, "popup-border-lines");
485
0
    lines = options_find_choice(options_table_entry(oe), value,
486
0
        &cause);
487
0
    if (cause != NULL) {
488
0
      cmdq_error(item, "popup-border-lines %s", cause);
489
0
      goto fail;
490
0
    }
491
0
  }
492
493
0
  if (args_has(args, 'T'))
494
0
    title = format_single_from_target(item, args_get(args, 'T'));
495
0
  else
496
0
    title = xstrdup("");
497
498
0
  if (args_has(args, 'N') || !modify)
499
0
    flags = 0;
500
0
  if (args_has(args, 'E') > 1) {
501
0
    if (flags == -1)
502
0
      flags = 0;
503
0
    flags |= POPUP_CLOSEEXITZERO;
504
0
  } else if (args_has(args, 'E')) {
505
0
    if (flags == -1)
506
0
      flags = 0;
507
0
    flags |= POPUP_CLOSEEXIT;
508
0
  }
509
0
  if (args_has(args, 'k')) {
510
0
    if (flags == -1)
511
0
      flags = 0;
512
0
    flags |= POPUP_CLOSEANYKEY;
513
0
  }
514
515
0
  if (modify) {
516
0
    popup_modify(tc, title, style, border_style, lines, flags);
517
0
    goto out;
518
0
  }
519
0
  if (popup_display(flags, lines, item, px, py, w, h, env, shellcmd, argc,
520
0
      argv, cwd, title, tc, s, style, border_style, NULL, NULL) != 0)
521
0
    goto out;
522
0
  environ_free(env);
523
0
  free(cwd);
524
0
  free(title);
525
0
  cmd_free_argv(argc, argv);
526
0
  return (CMD_RETURN_WAIT);
527
528
0
out:
529
0
  cmd_free_argv(argc, argv);
530
0
  environ_free(env);
531
0
  free(cwd);
532
0
  free(title);
533
0
  return (CMD_RETURN_NORMAL);
534
535
0
fail:
536
0
  free(cause);
537
0
  cmd_free_argv(argc, argv);
538
0
  environ_free(env);
539
0
  free(cwd);
540
0
  free(title);
541
0
  return (CMD_RETURN_ERROR);
542
0
}