xref: /openbsd-src/usr.bin/tmux/window-buffer.c (revision 99fd087599a8791921855f21bd7e36130f39aadc)
1 /* $OpenBSD: window-buffer.c,v 1.25 2020/02/11 07:01:09 nicm Exp $ */
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 <stdlib.h>
22 #include <string.h>
23 #include <time.h>
24 #include <vis.h>
25 
26 #include "tmux.h"
27 
28 static struct screen	*window_buffer_init(struct window_mode_entry *,
29 			     struct cmd_find_state *, struct args *);
30 static void		 window_buffer_free(struct window_mode_entry *);
31 static void		 window_buffer_resize(struct window_mode_entry *, u_int,
32 			     u_int);
33 static void		 window_buffer_key(struct window_mode_entry *,
34 			     struct client *, struct session *,
35 			     struct winlink *, key_code, struct mouse_event *);
36 
37 #define WINDOW_BUFFER_DEFAULT_COMMAND "paste-buffer -b '%%'"
38 
39 #define WINDOW_BUFFER_DEFAULT_FORMAT \
40 	"#{buffer_size} bytes (#{t:buffer_created})"
41 
42 static const struct menu_item window_buffer_menu_items[] = {
43 	{ "Paste", 'p', NULL },
44 	{ "Paste Tagged", 'P', NULL },
45 	{ "", KEYC_NONE, NULL },
46 	{ "Tag", 't', NULL },
47 	{ "Tag All", '\024', NULL },
48 	{ "Tag None", 'T', NULL },
49 	{ "", KEYC_NONE, NULL },
50 	{ "Delete", 'd', NULL },
51 	{ "Delete Tagged", 'D', NULL },
52 	{ "", KEYC_NONE, NULL },
53 	{ "Cancel", 'q', NULL },
54 
55 	{ NULL, KEYC_NONE, NULL }
56 };
57 
58 const struct window_mode window_buffer_mode = {
59 	.name = "buffer-mode",
60 	.default_format = WINDOW_BUFFER_DEFAULT_FORMAT,
61 
62 	.init = window_buffer_init,
63 	.free = window_buffer_free,
64 	.resize = window_buffer_resize,
65 	.key = window_buffer_key,
66 };
67 
68 enum window_buffer_sort_type {
69 	WINDOW_BUFFER_BY_TIME,
70 	WINDOW_BUFFER_BY_NAME,
71 	WINDOW_BUFFER_BY_SIZE,
72 };
73 static const char *window_buffer_sort_list[] = {
74 	"time",
75 	"name",
76 	"size"
77 };
78 static struct mode_tree_sort_criteria *window_buffer_sort;
79 
80 struct window_buffer_itemdata {
81 	const char	*name;
82 	u_int		 order;
83 	size_t		 size;
84 };
85 
86 struct window_buffer_modedata {
87 	struct window_pane		 *wp;
88 	struct cmd_find_state		  fs;
89 
90 	struct mode_tree_data		 *data;
91 	char				 *command;
92 	char				 *format;
93 
94 	struct window_buffer_itemdata	**item_list;
95 	u_int				  item_size;
96 };
97 
98 static struct window_buffer_itemdata *
99 window_buffer_add_item(struct window_buffer_modedata *data)
100 {
101 	struct window_buffer_itemdata	*item;
102 
103 	data->item_list = xreallocarray(data->item_list, data->item_size + 1,
104 	    sizeof *data->item_list);
105 	item = data->item_list[data->item_size++] = xcalloc(1, sizeof *item);
106 	return (item);
107 }
108 
109 static void
110 window_buffer_free_item(struct window_buffer_itemdata *item)
111 {
112 	free((void *)item->name);
113 	free(item);
114 }
115 
116 static int
117 window_buffer_cmp(const void *a0, const void *b0)
118 {
119 	const struct window_buffer_itemdata *const	*a = a0;
120 	const struct window_buffer_itemdata *const	*b = b0;
121 	int						 result = 0;
122 
123 	if (window_buffer_sort->field == WINDOW_BUFFER_BY_TIME)
124 		result = (*b)->order - (*a)->order;
125 	else if (window_buffer_sort->field == WINDOW_BUFFER_BY_SIZE)
126 		result = (*b)->size - (*a)->size;
127 
128 	/* Use WINDOW_BUFFER_BY_NAME as default order and tie breaker. */
129 	if (result == 0)
130 		result = strcmp((*a)->name, (*b)->name);
131 
132 	if (window_buffer_sort->reversed)
133 		result = -result;
134 	return (result);
135 }
136 
137 static void
138 window_buffer_build(void *modedata, struct mode_tree_sort_criteria *sort_crit,
139     __unused uint64_t *tag, const char *filter)
140 {
141 	struct window_buffer_modedata	*data = modedata;
142 	struct window_buffer_itemdata	*item;
143 	u_int				 i;
144 	struct paste_buffer		*pb;
145 	char				*text, *cp;
146 	struct format_tree		*ft;
147 	struct session			*s = NULL;
148 	struct winlink			*wl = NULL;
149 	struct window_pane		*wp = NULL;
150 
151 	for (i = 0; i < data->item_size; i++)
152 		window_buffer_free_item(data->item_list[i]);
153 	free(data->item_list);
154 	data->item_list = NULL;
155 	data->item_size = 0;
156 
157 	pb = NULL;
158 	while ((pb = paste_walk(pb)) != NULL) {
159 		item = window_buffer_add_item(data);
160 		item->name = xstrdup(paste_buffer_name(pb));
161 		paste_buffer_data(pb, &item->size);
162 		item->order = paste_buffer_order(pb);
163 	}
164 
165 	window_buffer_sort = sort_crit;
166 	qsort(data->item_list, data->item_size, sizeof *data->item_list,
167 	    window_buffer_cmp);
168 
169 	if (cmd_find_valid_state(&data->fs)) {
170 		s = data->fs.s;
171 		wl = data->fs.wl;
172 		wp = data->fs.wp;
173 	}
174 
175 	for (i = 0; i < data->item_size; i++) {
176 		item = data->item_list[i];
177 
178 		pb = paste_get_name(item->name);
179 		if (pb == NULL)
180 			continue;
181 		ft = format_create(NULL, NULL, FORMAT_NONE, 0);
182 		format_defaults(ft, NULL, s, wl, wp);
183 		format_defaults_paste_buffer(ft, pb);
184 
185 		if (filter != NULL) {
186 			cp = format_expand(ft, filter);
187 			if (!format_true(cp)) {
188 				free(cp);
189 				format_free(ft);
190 				continue;
191 			}
192 			free(cp);
193 		}
194 
195 		text = format_expand(ft, data->format);
196 		mode_tree_add(data->data, NULL, item, item->order, item->name,
197 		    text, -1);
198 		free(text);
199 
200 		format_free(ft);
201 	}
202 
203 }
204 
205 static void
206 window_buffer_draw(__unused void *modedata, void *itemdata,
207     struct screen_write_ctx *ctx, u_int sx, u_int sy)
208 {
209 	struct window_buffer_itemdata	*item = itemdata;
210 	struct paste_buffer		*pb;
211 	const char			*pdata, *start, *end;
212 	char				*buf = NULL;
213 	size_t				 psize;
214 	u_int				 i, cx = ctx->s->cx, cy = ctx->s->cy;
215 
216 	pb = paste_get_name(item->name);
217 	if (pb == NULL)
218 		return;
219 
220 	pdata = end = paste_buffer_data(pb, &psize);
221 	for (i = 0; i < sy; i++) {
222 		start = end;
223 		while (end != pdata + psize && *end != '\n')
224 			end++;
225 		buf = xreallocarray(buf, 4, end - start + 1);
226 		utf8_strvis(buf, start, end - start, VIS_OCTAL|VIS_TAB);
227 		if (*buf != '\0') {
228 			screen_write_cursormove(ctx, cx, cy + i, 0);
229 			screen_write_nputs(ctx, sx, &grid_default_cell, "%s",
230 			    buf);
231 		}
232 
233 		if (end == pdata + psize)
234 			break;
235 		end++;
236 	}
237 	free(buf);
238 }
239 
240 static int
241 window_buffer_search(__unused void *modedata, void *itemdata, const char *ss)
242 {
243 	struct window_buffer_itemdata	*item = itemdata;
244 	struct paste_buffer		*pb;
245 	const char			*bufdata;
246 	size_t				 bufsize;
247 
248 	if ((pb = paste_get_name(item->name)) == NULL)
249 		return (0);
250 	if (strstr(item->name, ss) != NULL)
251 		return (1);
252 	bufdata = paste_buffer_data(pb, &bufsize);
253 	return (memmem(bufdata, bufsize, ss, strlen(ss)) != NULL);
254 }
255 
256 static void
257 window_buffer_menu(void *modedata, struct client *c, key_code key)
258 {
259 	struct window_buffer_modedata	*data = modedata;
260 	struct window_pane		*wp = data->wp;
261 	struct window_mode_entry	*wme;
262 
263 	wme = TAILQ_FIRST(&wp->modes);
264 	if (wme == NULL || wme->data != modedata)
265 		return;
266 	window_buffer_key(wme, c, NULL, NULL, key, NULL);
267 }
268 
269 static struct screen *
270 window_buffer_init(struct window_mode_entry *wme, struct cmd_find_state *fs,
271     struct args *args)
272 {
273 	struct window_pane		*wp = wme->wp;
274 	struct window_buffer_modedata	*data;
275 	struct screen			*s;
276 
277 	wme->data = data = xcalloc(1, sizeof *data);
278 	data->wp = wp;
279 	cmd_find_copy_state(&data->fs, fs);
280 
281 	if (args == NULL || !args_has(args, 'F'))
282 		data->format = xstrdup(WINDOW_BUFFER_DEFAULT_FORMAT);
283 	else
284 		data->format = xstrdup(args_get(args, 'F'));
285 	if (args == NULL || args->argc == 0)
286 		data->command = xstrdup(WINDOW_BUFFER_DEFAULT_COMMAND);
287 	else
288 		data->command = xstrdup(args->argv[0]);
289 
290 	data->data = mode_tree_start(wp, args, window_buffer_build,
291 	    window_buffer_draw, window_buffer_search, window_buffer_menu, data,
292 	    window_buffer_menu_items, window_buffer_sort_list,
293 	    nitems(window_buffer_sort_list), &s);
294 	mode_tree_zoom(data->data, args);
295 
296 	mode_tree_build(data->data);
297 	mode_tree_draw(data->data);
298 
299 	return (s);
300 }
301 
302 static void
303 window_buffer_free(struct window_mode_entry *wme)
304 {
305 	struct window_buffer_modedata	*data = wme->data;
306 	u_int				 i;
307 
308 	if (data == NULL)
309 		return;
310 
311 	mode_tree_free(data->data);
312 
313 	for (i = 0; i < data->item_size; i++)
314 		window_buffer_free_item(data->item_list[i]);
315 	free(data->item_list);
316 
317 	free(data->format);
318 	free(data->command);
319 
320 	free(data);
321 }
322 
323 static void
324 window_buffer_resize(struct window_mode_entry *wme, u_int sx, u_int sy)
325 {
326 	struct window_buffer_modedata	*data = wme->data;
327 
328 	mode_tree_resize(data->data, sx, sy);
329 }
330 
331 static void
332 window_buffer_do_delete(void *modedata, void *itemdata,
333     __unused struct client *c, __unused key_code key)
334 {
335 	struct window_buffer_modedata	*data = modedata;
336 	struct window_buffer_itemdata	*item = itemdata;
337 	struct paste_buffer		*pb;
338 
339 	if (item == mode_tree_get_current(data->data))
340 		mode_tree_down(data->data, 0);
341 	if ((pb = paste_get_name(item->name)) != NULL)
342 		paste_free(pb);
343 }
344 
345 static void
346 window_buffer_do_paste(void *modedata, void *itemdata, struct client *c,
347     __unused key_code key)
348 {
349 	struct window_buffer_modedata	*data = modedata;
350 	struct window_buffer_itemdata	*item = itemdata;
351 	struct paste_buffer		*pb;
352 
353 	if ((pb = paste_get_name(item->name)) != NULL)
354 		mode_tree_run_command(c, NULL, data->command, item->name);
355 }
356 
357 static void
358 window_buffer_key(struct window_mode_entry *wme, struct client *c,
359     __unused struct session *s, __unused struct winlink *wl, key_code key,
360     struct mouse_event *m)
361 {
362 	struct window_pane		*wp = wme->wp;
363 	struct window_buffer_modedata	*data = wme->data;
364 	struct mode_tree_data		*mtd = data->data;
365 	struct window_buffer_itemdata	*item;
366 	int				 finished;
367 
368 	finished = mode_tree_key(mtd, c, &key, m, NULL, NULL);
369 	switch (key) {
370 	case 'd':
371 		item = mode_tree_get_current(mtd);
372 		window_buffer_do_delete(data, item, c, key);
373 		mode_tree_build(mtd);
374 		break;
375 	case 'D':
376 		mode_tree_each_tagged(mtd, window_buffer_do_delete, c, key, 0);
377 		mode_tree_build(mtd);
378 		break;
379 	case 'P':
380 		mode_tree_each_tagged(mtd, window_buffer_do_paste, c, key, 0);
381 		finished = 1;
382 		break;
383 	case 'p':
384 	case '\r':
385 		item = mode_tree_get_current(mtd);
386 		window_buffer_do_paste(data, item, c, key);
387 		finished = 1;
388 		break;
389 	}
390 	if (finished || paste_get_top(NULL) == NULL)
391 		window_pane_reset_mode(wp);
392 	else {
393 		mode_tree_draw(mtd);
394 		wp->flags |= PANE_REDRAW;
395 	}
396 }
397