Coverage Report

Created: 2026-01-10 06:21

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/tmux/window-buffer.c
Line
Count
Source
1
/* $OpenBSD$ */
2
3
/*
4
 * Copyright (c) 2017 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 <stdio.h>
22
#include <ctype.h>
23
#include <stdlib.h>
24
#include <string.h>
25
#include <time.h>
26
#include <unistd.h>
27
28
#include "tmux.h"
29
30
static struct screen  *window_buffer_init(struct window_mode_entry *,
31
           struct cmd_find_state *, struct args *);
32
static void    window_buffer_free(struct window_mode_entry *);
33
static void    window_buffer_resize(struct window_mode_entry *, u_int,
34
           u_int);
35
static void    window_buffer_update(struct window_mode_entry *);
36
static void    window_buffer_key(struct window_mode_entry *,
37
           struct client *, struct session *,
38
           struct winlink *, key_code, struct mouse_event *);
39
40
0
#define WINDOW_BUFFER_DEFAULT_COMMAND "paste-buffer -p -b '%%'"
41
42
#define WINDOW_BUFFER_DEFAULT_FORMAT \
43
0
  "#{t/p:buffer_created}: #{buffer_sample}"
44
45
#define WINDOW_BUFFER_DEFAULT_KEY_FORMAT \
46
0
  "#{?#{e|<:#{line},10}," \
47
0
    "#{line}" \
48
0
  ",#{e|<:#{line},36}," \
49
0
    "M-#{a:#{e|+:97,#{e|-:#{line},10}}}" \
50
0
  "}"
51
52
static const struct menu_item window_buffer_menu_items[] = {
53
  { "Paste", 'p', NULL },
54
  { "Paste Tagged", 'P', NULL },
55
  { "", KEYC_NONE, NULL },
56
  { "Tag", 't', NULL },
57
  { "Tag All", '\024', NULL },
58
  { "Tag None", 'T', NULL },
59
  { "", KEYC_NONE, NULL },
60
  { "Delete", 'd', NULL },
61
  { "Delete Tagged", 'D', NULL },
62
  { "", KEYC_NONE, NULL },
63
  { "Cancel", 'q', NULL },
64
65
  { NULL, KEYC_NONE, NULL }
66
};
67
68
const struct window_mode window_buffer_mode = {
69
  .name = "buffer-mode",
70
  .default_format = WINDOW_BUFFER_DEFAULT_FORMAT,
71
72
  .init = window_buffer_init,
73
  .free = window_buffer_free,
74
  .resize = window_buffer_resize,
75
  .update = window_buffer_update,
76
  .key = window_buffer_key,
77
};
78
79
enum window_buffer_sort_type {
80
  WINDOW_BUFFER_BY_TIME,
81
  WINDOW_BUFFER_BY_NAME,
82
  WINDOW_BUFFER_BY_SIZE,
83
};
84
static const char *window_buffer_sort_list[] = {
85
  "time",
86
  "name",
87
  "size"
88
};
89
static struct mode_tree_sort_criteria *window_buffer_sort;
90
91
struct window_buffer_itemdata {
92
  const char  *name;
93
  u_int    order;
94
  size_t     size;
95
};
96
97
struct window_buffer_modedata {
98
  struct window_pane     *wp;
99
  struct cmd_find_state     fs;
100
101
  struct mode_tree_data    *data;
102
  char         *command;
103
  char         *format;
104
  char         *key_format;
105
106
  struct window_buffer_itemdata **item_list;
107
  u_int         item_size;
108
};
109
110
struct window_buffer_editdata {
111
  u_int      wp_id;
112
  char      *name;
113
  struct paste_buffer *pb;
114
};
115
116
static struct window_buffer_itemdata *
117
window_buffer_add_item(struct window_buffer_modedata *data)
118
0
{
119
0
  struct window_buffer_itemdata *item;
120
121
0
  data->item_list = xreallocarray(data->item_list, data->item_size + 1,
122
0
      sizeof *data->item_list);
123
0
  item = data->item_list[data->item_size++] = xcalloc(1, sizeof *item);
124
0
  return (item);
125
0
}
126
127
static void
128
window_buffer_free_item(struct window_buffer_itemdata *item)
129
0
{
130
0
  free((void *)item->name);
131
0
  free(item);
132
0
}
133
134
static int
135
window_buffer_cmp(const void *a0, const void *b0)
136
0
{
137
0
  const struct window_buffer_itemdata *const  *a = a0;
138
0
  const struct window_buffer_itemdata *const  *b = b0;
139
0
  int            result = 0;
140
141
0
  if (window_buffer_sort->field == WINDOW_BUFFER_BY_TIME)
142
0
    result = (*b)->order - (*a)->order;
143
0
  else if (window_buffer_sort->field == WINDOW_BUFFER_BY_SIZE)
144
0
    result = (*b)->size - (*a)->size;
145
146
  /* Use WINDOW_BUFFER_BY_NAME as default order and tie breaker. */
147
0
  if (result == 0)
148
0
    result = strcmp((*a)->name, (*b)->name);
149
150
0
  if (window_buffer_sort->reversed)
151
0
    result = -result;
152
0
  return (result);
153
0
}
154
155
static void
156
window_buffer_build(void *modedata, struct mode_tree_sort_criteria *sort_crit,
157
    __unused uint64_t *tag, const char *filter)
158
0
{
159
0
  struct window_buffer_modedata *data = modedata;
160
0
  struct window_buffer_itemdata *item;
161
0
  u_int        i;
162
0
  struct paste_buffer   *pb = NULL;
163
0
  char        *text, *cp;
164
0
  struct format_tree    *ft;
165
0
  struct session      *s = NULL;
166
0
  struct winlink      *wl = NULL;
167
0
  struct window_pane    *wp = NULL;
168
169
0
  for (i = 0; i < data->item_size; i++)
170
0
    window_buffer_free_item(data->item_list[i]);
171
0
  free(data->item_list);
172
0
  data->item_list = NULL;
173
0
  data->item_size = 0;
174
175
0
  while ((pb = paste_walk(pb)) != NULL) {
176
0
    item = window_buffer_add_item(data);
177
0
    item->name = xstrdup(paste_buffer_name(pb));
178
0
    paste_buffer_data(pb, &item->size);
179
0
    item->order = paste_buffer_order(pb);
180
0
  }
181
182
0
  window_buffer_sort = sort_crit;
183
0
  qsort(data->item_list, data->item_size, sizeof *data->item_list,
184
0
      window_buffer_cmp);
185
186
0
  if (cmd_find_valid_state(&data->fs)) {
187
0
    s = data->fs.s;
188
0
    wl = data->fs.wl;
189
0
    wp = data->fs.wp;
190
0
  }
191
192
0
  for (i = 0; i < data->item_size; i++) {
193
0
    item = data->item_list[i];
194
195
0
    pb = paste_get_name(item->name);
196
0
    if (pb == NULL)
197
0
      continue;
198
0
    ft = format_create(NULL, NULL, FORMAT_NONE, 0);
199
0
    format_defaults(ft, NULL, s, wl, wp);
200
0
    format_defaults_paste_buffer(ft, pb);
201
202
0
    if (filter != NULL) {
203
0
      cp = format_expand(ft, filter);
204
0
      if (!format_true(cp)) {
205
0
        free(cp);
206
0
        format_free(ft);
207
0
        continue;
208
0
      }
209
0
      free(cp);
210
0
    }
211
212
0
    text = format_expand(ft, data->format);
213
0
    mode_tree_add(data->data, NULL, item, item->order, item->name,
214
0
        text, -1);
215
0
    free(text);
216
217
0
    format_free(ft);
218
0
  }
219
220
0
}
221
222
static void
223
window_buffer_draw(__unused void *modedata, void *itemdata,
224
    struct screen_write_ctx *ctx, u_int sx, u_int sy)
225
0
{
226
0
  struct window_buffer_itemdata *item = itemdata;
227
0
  struct paste_buffer   *pb;
228
0
  const char      *pdata, *start, *end;
229
0
  char        *buf = NULL;
230
0
  size_t         psize;
231
0
  u_int        i, cx = ctx->s->cx, cy = ctx->s->cy;
232
233
0
  pb = paste_get_name(item->name);
234
0
  if (pb == NULL)
235
0
    return;
236
237
0
  pdata = end = paste_buffer_data(pb, &psize);
238
0
  for (i = 0; i < sy; i++) {
239
0
    start = end;
240
0
    while (end != pdata + psize && *end != '\n')
241
0
      end++;
242
0
    buf = xreallocarray(buf, 4, end - start + 1);
243
0
    utf8_strvis(buf, start, end - start,
244
0
        VIS_OCTAL|VIS_CSTYLE|VIS_TAB);
245
0
    if (*buf != '\0') {
246
0
      screen_write_cursormove(ctx, cx, cy + i, 0);
247
0
      screen_write_nputs(ctx, sx, &grid_default_cell, "%s",
248
0
          buf);
249
0
    }
250
251
0
    if (end == pdata + psize)
252
0
      break;
253
0
    end++;
254
0
  }
255
0
  free(buf);
256
0
}
257
258
static int
259
window_buffer_find(const void *data, size_t datalen, const void *find,
260
    size_t findlen, int icase)
261
0
{
262
0
  const u_char  *udata = data, *ufind = find;
263
0
  size_t     i, j;
264
265
0
  if (findlen == 0 || datalen < findlen)
266
0
    return (0);
267
0
  for (i = 0; i + findlen <= datalen; i++) {
268
0
    for (j = 0; j < findlen; j++) {
269
0
      if (!icase && udata[i + j] != ufind[j])
270
0
        break;
271
0
      if (icase && tolower(udata[i + j]) != tolower(ufind[j]))
272
0
        break;
273
0
    }
274
0
    if (j == findlen)
275
0
      return (1);
276
0
  }
277
0
  return (0);
278
0
}
279
280
static int
281
window_buffer_search(__unused void *modedata, void *itemdata, const char *ss,
282
    int icase)
283
0
{
284
0
  struct window_buffer_itemdata *item = itemdata;
285
0
  struct paste_buffer   *pb;
286
0
  const char      *bufdata;
287
0
  size_t         bufsize;
288
289
0
  if ((pb = paste_get_name(item->name)) == NULL)
290
0
    return (0);
291
0
  if (icase) {
292
0
    if (strcasestr(item->name, ss) != NULL)
293
0
      return (1);
294
0
    bufdata = paste_buffer_data(pb, &bufsize);
295
0
    return (window_buffer_find(bufdata, bufsize, ss, strlen(ss),
296
0
        icase));
297
0
  } else {
298
0
    if (strstr(item->name, ss) != NULL)
299
0
      return (1);
300
0
    bufdata = paste_buffer_data(pb, &bufsize);
301
0
    return (window_buffer_find(bufdata, bufsize, ss, strlen(ss),
302
0
        icase));
303
0
  }
304
0
}
305
306
static void
307
window_buffer_menu(void *modedata, struct client *c, key_code key)
308
0
{
309
0
  struct window_buffer_modedata *data = modedata;
310
0
  struct window_pane    *wp = data->wp;
311
0
  struct window_mode_entry  *wme;
312
313
0
  wme = TAILQ_FIRST(&wp->modes);
314
0
  if (wme == NULL || wme->data != modedata)
315
0
    return;
316
0
  window_buffer_key(wme, c, NULL, NULL, key, NULL);
317
0
}
318
319
static key_code
320
window_buffer_get_key(void *modedata, void *itemdata, u_int line)
321
0
{
322
0
  struct window_buffer_modedata *data = modedata;
323
0
  struct window_buffer_itemdata *item = itemdata;
324
0
  struct format_tree    *ft;
325
0
  struct session      *s = NULL;
326
0
  struct winlink      *wl = NULL;
327
0
  struct window_pane    *wp = NULL;
328
0
  struct paste_buffer   *pb;
329
0
  char        *expanded;
330
0
  key_code       key;
331
332
0
  if (cmd_find_valid_state(&data->fs)) {
333
0
    s = data->fs.s;
334
0
    wl = data->fs.wl;
335
0
    wp = data->fs.wp;
336
0
  }
337
0
  pb = paste_get_name(item->name);
338
0
  if (pb == NULL)
339
0
    return (KEYC_NONE);
340
341
0
  ft = format_create(NULL, NULL, FORMAT_NONE, 0);
342
0
  format_defaults(ft, NULL, NULL, 0, NULL);
343
0
  format_defaults(ft, NULL, s, wl, wp);
344
0
  format_defaults_paste_buffer(ft, pb);
345
0
  format_add(ft, "line", "%u", line);
346
347
0
  expanded = format_expand(ft, data->key_format);
348
0
  key = key_string_lookup_string(expanded);
349
0
  free(expanded);
350
0
  format_free(ft);
351
0
  return (key);
352
0
}
353
354
static struct screen *
355
window_buffer_init(struct window_mode_entry *wme, struct cmd_find_state *fs,
356
    struct args *args)
357
0
{
358
0
  struct window_pane    *wp = wme->wp;
359
0
  struct window_buffer_modedata *data;
360
0
  struct screen     *s;
361
362
0
  wme->data = data = xcalloc(1, sizeof *data);
363
0
  data->wp = wp;
364
0
  cmd_find_copy_state(&data->fs, fs);
365
366
0
  if (args == NULL || !args_has(args, 'F'))
367
0
    data->format = xstrdup(WINDOW_BUFFER_DEFAULT_FORMAT);
368
0
  else
369
0
    data->format = xstrdup(args_get(args, 'F'));
370
0
  if (args == NULL || !args_has(args, 'K'))
371
0
    data->key_format = xstrdup(WINDOW_BUFFER_DEFAULT_KEY_FORMAT);
372
0
  else
373
0
    data->key_format = xstrdup(args_get(args, 'K'));
374
0
  if (args == NULL || args_count(args) == 0)
375
0
    data->command = xstrdup(WINDOW_BUFFER_DEFAULT_COMMAND);
376
0
  else
377
0
    data->command = xstrdup(args_string(args, 0));
378
379
0
  data->data = mode_tree_start(wp, args, window_buffer_build,
380
0
      window_buffer_draw, window_buffer_search, window_buffer_menu, NULL,
381
0
      window_buffer_get_key, NULL, data, window_buffer_menu_items,
382
0
      window_buffer_sort_list, nitems(window_buffer_sort_list), &s);
383
0
  mode_tree_zoom(data->data, args);
384
385
0
  mode_tree_build(data->data);
386
0
  mode_tree_draw(data->data);
387
388
0
  return (s);
389
0
}
390
391
static void
392
window_buffer_free(struct window_mode_entry *wme)
393
0
{
394
0
  struct window_buffer_modedata *data = wme->data;
395
0
  u_int        i;
396
397
0
  if (data == NULL)
398
0
    return;
399
400
0
  mode_tree_free(data->data);
401
402
0
  for (i = 0; i < data->item_size; i++)
403
0
    window_buffer_free_item(data->item_list[i]);
404
0
  free(data->item_list);
405
406
0
  free(data->format);
407
0
  free(data->key_format);
408
0
  free(data->command);
409
410
0
  free(data);
411
0
}
412
413
static void
414
window_buffer_resize(struct window_mode_entry *wme, u_int sx, u_int sy)
415
0
{
416
0
  struct window_buffer_modedata *data = wme->data;
417
418
0
  mode_tree_resize(data->data, sx, sy);
419
0
}
420
421
static void
422
window_buffer_update(struct window_mode_entry *wme)
423
0
{
424
0
  struct window_buffer_modedata *data = wme->data;
425
426
0
  mode_tree_build(data->data);
427
0
  mode_tree_draw(data->data);
428
0
  data->wp->flags |= PANE_REDRAW;
429
0
}
430
431
static void
432
window_buffer_do_delete(void *modedata, void *itemdata,
433
    __unused struct client *c, __unused key_code key)
434
0
{
435
0
  struct window_buffer_modedata *data = modedata;
436
0
  struct window_buffer_itemdata *item = itemdata;
437
0
  struct paste_buffer   *pb;
438
439
0
  if (item == mode_tree_get_current(data->data) &&
440
0
      !mode_tree_down(data->data, 0)) {
441
    /*
442
     *If we were unable to select the item further down we are at
443
     * the end of the list. Move one element up instead, to make
444
     * sure that we preserve a valid selection or we risk having
445
     * the tree build logic reset it to the first item.
446
     */
447
0
    mode_tree_up(data->data, 0);
448
0
  }
449
450
0
  if ((pb = paste_get_name(item->name)) != NULL)
451
0
    paste_free(pb);
452
0
}
453
454
static void
455
window_buffer_do_paste(void *modedata, void *itemdata, struct client *c,
456
    __unused key_code key)
457
0
{
458
0
  struct window_buffer_modedata *data = modedata;
459
0
  struct window_buffer_itemdata *item = itemdata;
460
461
0
  if (paste_get_name(item->name) != NULL)
462
0
    mode_tree_run_command(c, NULL, data->command, item->name);
463
0
}
464
465
static void
466
window_buffer_finish_edit(struct window_buffer_editdata *ed)
467
0
{
468
0
  free(ed->name);
469
0
  free(ed);
470
0
}
471
472
static void
473
window_buffer_edit_close_cb(char *buf, size_t len, void *arg)
474
0
{
475
0
  struct window_buffer_editdata *ed = arg;
476
0
  size_t         oldlen;
477
0
  const char      *oldbuf;
478
0
  struct paste_buffer   *pb;
479
0
  struct window_pane    *wp;
480
0
  struct window_buffer_modedata *data;
481
0
  struct window_mode_entry  *wme;
482
483
0
  if (buf == NULL || len == 0) {
484
0
    window_buffer_finish_edit(ed);
485
0
    return;
486
0
  }
487
488
0
  pb = paste_get_name(ed->name);
489
0
  if (pb == NULL || pb != ed->pb) {
490
0
    window_buffer_finish_edit(ed);
491
0
    return;
492
0
  }
493
494
0
  oldbuf = paste_buffer_data(pb, &oldlen);
495
0
  if (oldlen != '\0' &&
496
0
      oldbuf[oldlen - 1] != '\n' &&
497
0
      buf[len - 1] == '\n')
498
0
    len--;
499
0
  if (len != 0)
500
0
    paste_replace(pb, buf, len);
501
502
0
  wp = window_pane_find_by_id(ed->wp_id);
503
0
  if (wp != NULL) {
504
0
    wme = TAILQ_FIRST(&wp->modes);
505
0
    if (wme->mode == &window_buffer_mode) {
506
0
      data = wme->data;
507
0
      mode_tree_build(data->data);
508
0
      mode_tree_draw(data->data);
509
0
    }
510
0
    wp->flags |= PANE_REDRAW;
511
0
  }
512
0
  window_buffer_finish_edit(ed);
513
0
}
514
515
static void
516
window_buffer_start_edit(struct window_buffer_modedata *data,
517
    struct window_buffer_itemdata *item, struct client *c)
518
0
{
519
0
  struct paste_buffer   *pb;
520
0
  const char      *buf;
521
0
  size_t         len;
522
0
  struct window_buffer_editdata *ed;
523
524
0
  if ((pb = paste_get_name(item->name)) == NULL)
525
0
    return;
526
0
  buf = paste_buffer_data(pb, &len);
527
528
0
  ed = xcalloc(1, sizeof *ed);
529
0
  ed->wp_id = data->wp->id;
530
0
  ed->name = xstrdup(paste_buffer_name(pb));
531
0
  ed->pb = pb;
532
533
0
  if (popup_editor(c, buf, len, window_buffer_edit_close_cb, ed) != 0)
534
0
    window_buffer_finish_edit(ed);
535
0
}
536
537
static void
538
window_buffer_key(struct window_mode_entry *wme, struct client *c,
539
    __unused struct session *s, __unused struct winlink *wl, key_code key,
540
    struct mouse_event *m)
541
0
{
542
0
  struct window_pane    *wp = wme->wp;
543
0
  struct window_buffer_modedata *data = wme->data;
544
0
  struct mode_tree_data   *mtd = data->data;
545
0
  struct window_buffer_itemdata *item;
546
0
  int        finished;
547
548
0
  if (paste_is_empty()) {
549
0
    finished = 1;
550
0
    goto out;
551
0
  }
552
553
0
  finished = mode_tree_key(mtd, c, &key, m, NULL, NULL);
554
0
  switch (key) {
555
0
  case 'e':
556
0
    item = mode_tree_get_current(mtd);
557
0
    window_buffer_start_edit(data, item, c);
558
0
    break;
559
0
  case 'd':
560
0
    item = mode_tree_get_current(mtd);
561
0
    window_buffer_do_delete(data, item, c, key);
562
0
    mode_tree_build(mtd);
563
0
    break;
564
0
  case 'D':
565
0
    mode_tree_each_tagged(mtd, window_buffer_do_delete, c, key, 0);
566
0
    mode_tree_build(mtd);
567
0
    break;
568
0
  case 'P':
569
0
    mode_tree_each_tagged(mtd, window_buffer_do_paste, c, key, 0);
570
0
    finished = 1;
571
0
    break;
572
0
  case 'p':
573
0
  case '\r':
574
0
    item = mode_tree_get_current(mtd);
575
0
    window_buffer_do_paste(data, item, c, key);
576
0
    finished = 1;
577
0
    break;
578
0
  }
579
580
0
out:
581
0
  if (finished || paste_is_empty())
582
0
    window_pane_reset_mode(wp);
583
0
  else {
584
0
    mode_tree_draw(mtd);
585
0
    wp->flags |= PANE_REDRAW;
586
0
  }
587
0
}