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