xref: /openbsd-src/usr.bin/tmux/window-buffer.c (revision 7350f337b9e3eb4461d99580e625c7ef148d107c)
1 /* $OpenBSD: window-buffer.c,v 1.21 2019/05/29 20:05:15 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 
79 struct window_buffer_itemdata {
80 	const char	*name;
81 	u_int		 order;
82 	size_t		 size;
83 };
84 
85 struct window_buffer_modedata {
86 	struct window_pane		 *wp;
87 	struct cmd_find_state		  fs;
88 
89 	struct mode_tree_data		 *data;
90 	char				 *command;
91 	char				 *format;
92 
93 	struct window_buffer_itemdata	**item_list;
94 	u_int				  item_size;
95 };
96 
97 static struct window_buffer_itemdata *
98 window_buffer_add_item(struct window_buffer_modedata *data)
99 {
100 	struct window_buffer_itemdata	*item;
101 
102 	data->item_list = xreallocarray(data->item_list, data->item_size + 1,
103 	    sizeof *data->item_list);
104 	item = data->item_list[data->item_size++] = xcalloc(1, sizeof *item);
105 	return (item);
106 }
107 
108 static void
109 window_buffer_free_item(struct window_buffer_itemdata *item)
110 {
111 	free((void *)item->name);
112 	free(item);
113 }
114 
115 static int
116 window_buffer_cmp_name(const void *a0, const void *b0)
117 {
118 	const struct window_buffer_itemdata *const *a = a0;
119 	const struct window_buffer_itemdata *const *b = b0;
120 
121 	return (strcmp((*a)->name, (*b)->name));
122 }
123 
124 static int
125 window_buffer_cmp_time(const void *a0, const void *b0)
126 {
127 	const struct window_buffer_itemdata *const *a = a0;
128 	const struct window_buffer_itemdata *const *b = b0;
129 
130 	if ((*a)->order > (*b)->order)
131 		return (-1);
132 	if ((*a)->order < (*b)->order)
133 		return (1);
134 	return (strcmp((*a)->name, (*b)->name));
135 }
136 
137 static int
138 window_buffer_cmp_size(const void *a0, const void *b0)
139 {
140 	const struct window_buffer_itemdata *const *a = a0;
141 	const struct window_buffer_itemdata *const *b = b0;
142 
143 	if ((*a)->size > (*b)->size)
144 		return (-1);
145 	if ((*a)->size < (*b)->size)
146 		return (1);
147 	return (strcmp((*a)->name, (*b)->name));
148 }
149 
150 static void
151 window_buffer_build(void *modedata, u_int sort_type, __unused uint64_t *tag,
152     const char *filter)
153 {
154 	struct window_buffer_modedata	*data = modedata;
155 	struct window_buffer_itemdata	*item;
156 	u_int				 i;
157 	struct paste_buffer		*pb;
158 	char				*text, *cp;
159 	struct format_tree		*ft;
160 	struct session			*s = NULL;
161 	struct winlink			*wl = NULL;
162 	struct window_pane		*wp = NULL;
163 
164 	for (i = 0; i < data->item_size; i++)
165 		window_buffer_free_item(data->item_list[i]);
166 	free(data->item_list);
167 	data->item_list = NULL;
168 	data->item_size = 0;
169 
170 	pb = NULL;
171 	while ((pb = paste_walk(pb)) != NULL) {
172 		item = window_buffer_add_item(data);
173 		item->name = xstrdup(paste_buffer_name(pb));
174 		paste_buffer_data(pb, &item->size);
175 		item->order = paste_buffer_order(pb);
176 	}
177 
178 	switch (sort_type) {
179 	case WINDOW_BUFFER_BY_NAME:
180 		qsort(data->item_list, data->item_size, sizeof *data->item_list,
181 		    window_buffer_cmp_name);
182 		break;
183 	case WINDOW_BUFFER_BY_TIME:
184 		qsort(data->item_list, data->item_size, sizeof *data->item_list,
185 		    window_buffer_cmp_time);
186 		break;
187 	case WINDOW_BUFFER_BY_SIZE:
188 		qsort(data->item_list, data->item_size, sizeof *data->item_list,
189 		    window_buffer_cmp_size);
190 		break;
191 	}
192 
193 	if (cmd_find_valid_state(&data->fs)) {
194 		s = data->fs.s;
195 		wl = data->fs.wl;
196 		wp = data->fs.wp;
197 	}
198 
199 	for (i = 0; i < data->item_size; i++) {
200 		item = data->item_list[i];
201 
202 		pb = paste_get_name(item->name);
203 		if (pb == NULL)
204 			continue;
205 		ft = format_create(NULL, NULL, FORMAT_NONE, 0);
206 		format_defaults(ft, NULL, s, wl, wp);
207 		format_defaults_paste_buffer(ft, pb);
208 
209 		if (filter != NULL) {
210 			cp = format_expand(ft, filter);
211 			if (!format_true(cp)) {
212 				free(cp);
213 				format_free(ft);
214 				continue;
215 			}
216 			free(cp);
217 		}
218 
219 		text = format_expand(ft, data->format);
220 		mode_tree_add(data->data, NULL, item, item->order, item->name,
221 		    text, -1);
222 		free(text);
223 
224 		format_free(ft);
225 	}
226 
227 }
228 
229 static void
230 window_buffer_draw(__unused void *modedata, void *itemdata,
231     struct screen_write_ctx *ctx, u_int sx, u_int sy)
232 {
233 	struct window_buffer_itemdata	*item = itemdata;
234 	struct paste_buffer		*pb;
235 	char				 line[1024];
236 	const char			*pdata, *end, *cp;
237 	size_t				 psize, at;
238 	u_int				 i, cx = ctx->s->cx, cy = ctx->s->cy;
239 
240 	pb = paste_get_name(item->name);
241 	if (pb == NULL)
242 		return;
243 
244 	pdata = end = paste_buffer_data(pb, &psize);
245 	for (i = 0; i < sy; i++) {
246 		at = 0;
247 		while (end != pdata + psize && *end != '\n') {
248 			if ((sizeof line) - at > 5) {
249 				cp = vis(line + at, *end, VIS_OCTAL|VIS_TAB, 0);
250 				at = cp - line;
251 			}
252 			end++;
253 		}
254 		if (at > sx)
255 			at = sx;
256 		line[at] = '\0';
257 
258 		if (*line != '\0') {
259 			screen_write_cursormove(ctx, cx, cy + i, 0);
260 			screen_write_puts(ctx, &grid_default_cell, "%s", line);
261 		}
262 
263 		if (end == pdata + psize)
264 			break;
265 		end++;
266 	}
267 }
268 
269 static int
270 window_buffer_search(__unused void *modedata, void *itemdata, const char *ss)
271 {
272 	struct window_buffer_itemdata	*item = itemdata;
273 	struct paste_buffer		*pb;
274 	const char			*bufdata;
275 	size_t				 bufsize;
276 
277 	if ((pb = paste_get_name(item->name)) == NULL)
278 		return (0);
279 	if (strstr(item->name, ss) != NULL)
280 		return (1);
281 	bufdata = paste_buffer_data(pb, &bufsize);
282 	return (memmem(bufdata, bufsize, ss, strlen(ss)) != NULL);
283 }
284 
285 static void
286 window_buffer_menu(void *modedata, struct client *c, key_code key)
287 {
288 	struct window_buffer_modedata	*data = modedata;
289 	struct window_pane		*wp = data->wp;
290 	struct window_mode_entry	*wme;
291 
292 	wme = TAILQ_FIRST(&wp->modes);
293 	if (wme == NULL || wme->data != modedata)
294 		return;
295 	window_buffer_key(wme, c, NULL, NULL, key, NULL);
296 }
297 
298 static struct screen *
299 window_buffer_init(struct window_mode_entry *wme, struct cmd_find_state *fs,
300     struct args *args)
301 {
302 	struct window_pane		*wp = wme->wp;
303 	struct window_buffer_modedata	*data;
304 	struct screen			*s;
305 
306 	wme->data = data = xcalloc(1, sizeof *data);
307 	data->wp = wp;
308 	cmd_find_copy_state(&data->fs, fs);
309 
310 	if (args == NULL || !args_has(args, 'F'))
311 		data->format = xstrdup(WINDOW_BUFFER_DEFAULT_FORMAT);
312 	else
313 		data->format = xstrdup(args_get(args, 'F'));
314 	if (args == NULL || args->argc == 0)
315 		data->command = xstrdup(WINDOW_BUFFER_DEFAULT_COMMAND);
316 	else
317 		data->command = xstrdup(args->argv[0]);
318 
319 	data->data = mode_tree_start(wp, args, window_buffer_build,
320 	    window_buffer_draw, window_buffer_search, window_buffer_menu, data,
321 	    window_buffer_menu_items, window_buffer_sort_list,
322 	    nitems(window_buffer_sort_list), &s);
323 	mode_tree_zoom(data->data, args);
324 
325 	mode_tree_build(data->data);
326 	mode_tree_draw(data->data);
327 
328 	return (s);
329 }
330 
331 static void
332 window_buffer_free(struct window_mode_entry *wme)
333 {
334 	struct window_buffer_modedata	*data = wme->data;
335 	u_int				 i;
336 
337 	if (data == NULL)
338 		return;
339 
340 	mode_tree_free(data->data);
341 
342 	for (i = 0; i < data->item_size; i++)
343 		window_buffer_free_item(data->item_list[i]);
344 	free(data->item_list);
345 
346 	free(data->format);
347 	free(data->command);
348 
349 	free(data);
350 }
351 
352 static void
353 window_buffer_resize(struct window_mode_entry *wme, u_int sx, u_int sy)
354 {
355 	struct window_buffer_modedata	*data = wme->data;
356 
357 	mode_tree_resize(data->data, sx, sy);
358 }
359 
360 static void
361 window_buffer_do_delete(void* modedata, void *itemdata,
362     __unused struct client *c, __unused key_code key)
363 {
364 	struct window_buffer_modedata	*data = modedata;
365 	struct window_buffer_itemdata	*item = itemdata;
366 	struct paste_buffer		*pb;
367 
368 	if (item == mode_tree_get_current(data->data))
369 		mode_tree_down(data->data, 0);
370 	if ((pb = paste_get_name(item->name)) != NULL)
371 		paste_free(pb);
372 }
373 
374 static void
375 window_buffer_do_paste(void* modedata, void *itemdata, struct client *c,
376     __unused key_code key)
377 {
378 	struct window_buffer_modedata	*data = modedata;
379 	struct window_buffer_itemdata	*item = itemdata;
380 	struct paste_buffer		*pb;
381 
382 	if ((pb = paste_get_name(item->name)) != NULL)
383 		mode_tree_run_command(c, NULL, data->command, item->name);
384 }
385 
386 static void
387 window_buffer_key(struct window_mode_entry *wme, struct client *c,
388     __unused struct session *s, __unused struct winlink *wl, key_code key,
389     struct mouse_event *m)
390 {
391 	struct window_pane		*wp = wme->wp;
392 	struct window_buffer_modedata	*data = wme->data;
393 	struct mode_tree_data		*mtd = data->data;
394 	struct window_buffer_itemdata	*item;
395 	int				 finished;
396 
397 	finished = mode_tree_key(mtd, c, &key, m, NULL, NULL);
398 	switch (key) {
399 	case 'd':
400 		item = mode_tree_get_current(mtd);
401 		window_buffer_do_delete(data, item, c, key);
402 		mode_tree_build(mtd);
403 		break;
404 	case 'D':
405 		mode_tree_each_tagged(mtd, window_buffer_do_delete, c, key, 0);
406 		mode_tree_build(mtd);
407 		break;
408 	case 'P':
409 		mode_tree_each_tagged(mtd, window_buffer_do_paste, c, key, 0);
410 		finished = 1;
411 		break;
412 	case 'p':
413 	case '\r':
414 		item = mode_tree_get_current(mtd);
415 		window_buffer_do_paste(data, item, c, key);
416 		finished = 1;
417 		break;
418 	}
419 	if (finished || paste_get_top(NULL) == NULL)
420 		window_pane_reset_mode(wp);
421 	else {
422 		mode_tree_draw(mtd);
423 		wp->flags |= PANE_REDRAW;
424 	}
425 }
426