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