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