Annotation of src/usr.bin/tmux/paste.c, Revision 1.45
1.45 ! nicm 1: /* $OpenBSD: paste.c,v 1.44 2022/08/15 09:10:34 nicm Exp $ */
1.1 nicm 2:
3: /*
1.34 nicm 4: * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 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:
1.12 nicm 21: #include <stdlib.h>
1.1 nicm 22: #include <string.h>
1.38 nicm 23: #include <time.h>
1.9 nicm 24: #include <vis.h>
1.1 nicm 25:
26: #include "tmux.h"
27:
1.7 nicm 28: /*
1.19 nicm 29: * Set of paste buffers. Note that paste buffer data is not necessarily a C
1.7 nicm 30: * string!
31: */
1.1 nicm 32:
1.28 nicm 33: struct paste_buffer {
34: char *data;
35: size_t size;
36:
37: char *name;
1.35 nicm 38: time_t created;
1.28 nicm 39: int automatic;
40: u_int order;
41:
42: RB_ENTRY(paste_buffer) name_entry;
43: RB_ENTRY(paste_buffer) time_entry;
44: };
45:
1.36 nicm 46: static u_int paste_next_index;
47: static u_int paste_next_order;
48: static u_int paste_num_automatic;
1.37 nicm 49: static RB_HEAD(paste_name_tree, paste_buffer) paste_by_name;
50: static RB_HEAD(paste_time_tree, paste_buffer) paste_by_time;
1.19 nicm 51:
1.36 nicm 52: static int paste_cmp_names(const struct paste_buffer *,
53: const struct paste_buffer *);
54: RB_GENERATE_STATIC(paste_name_tree, paste_buffer, name_entry, paste_cmp_names);
55:
56: static int paste_cmp_times(const struct paste_buffer *,
57: const struct paste_buffer *);
58: RB_GENERATE_STATIC(paste_time_tree, paste_buffer, time_entry, paste_cmp_times);
1.18 nicm 59:
1.36 nicm 60: static int
1.19 nicm 61: paste_cmp_names(const struct paste_buffer *a, const struct paste_buffer *b)
1.1 nicm 62: {
1.19 nicm 63: return (strcmp(a->name, b->name));
64: }
1.1 nicm 65:
1.36 nicm 66: static int
1.19 nicm 67: paste_cmp_times(const struct paste_buffer *a, const struct paste_buffer *b)
68: {
69: if (a->order > b->order)
70: return (-1);
71: if (a->order < b->order)
72: return (1);
73: return (0);
1.1 nicm 74: }
75:
1.28 nicm 76: /* Get paste buffer name. */
77: const char *
78: paste_buffer_name(struct paste_buffer *pb)
79: {
80: return (pb->name);
81: }
82:
1.35 nicm 83: /* Get paste buffer order. */
84: u_int
85: paste_buffer_order(struct paste_buffer *pb)
86: {
87: return (pb->order);
88: }
89:
90: /* Get paste buffer created. */
91: time_t
92: paste_buffer_created(struct paste_buffer *pb)
93: {
94: return (pb->created);
95: }
96:
1.28 nicm 97: /* Get paste buffer data. */
98: const char *
99: paste_buffer_data(struct paste_buffer *pb, size_t *size)
100: {
101: if (size != NULL)
102: *size = pb->size;
103: return (pb->data);
104: }
105:
1.35 nicm 106: /* Walk paste buffers by time. */
1.1 nicm 107: struct paste_buffer *
1.19 nicm 108: paste_walk(struct paste_buffer *pb)
1.1 nicm 109: {
1.19 nicm 110: if (pb == NULL)
111: return (RB_MIN(paste_time_tree, &paste_by_time));
112: return (RB_NEXT(paste_time_tree, &paste_by_time, pb));
1.1 nicm 113: }
114:
1.43 nicm 115: int
116: paste_is_empty(void)
117: {
118: return RB_ROOT(&paste_by_time) == NULL;
119: }
120:
1.21 nicm 121: /* Get the most recent automatic buffer. */
1.1 nicm 122: struct paste_buffer *
1.28 nicm 123: paste_get_top(const char **name)
1.1 nicm 124: {
1.19 nicm 125: struct paste_buffer *pb;
126:
127: pb = RB_MIN(paste_time_tree, &paste_by_time);
1.43 nicm 128: while (pb != NULL && !pb->automatic)
129: pb = RB_NEXT(paste_time_tree, &paste_by_time, pb);
1.19 nicm 130: if (pb == NULL)
1.1 nicm 131: return (NULL);
1.28 nicm 132: if (name != NULL)
133: *name = pb->name;
1.19 nicm 134: return (pb);
1.1 nicm 135: }
136:
1.19 nicm 137: /* Get a paste buffer by name. */
138: struct paste_buffer *
139: paste_get_name(const char *name)
140: {
141: struct paste_buffer pbfind;
1.1 nicm 142:
1.19 nicm 143: if (name == NULL || *name == '\0')
144: return (NULL);
1.1 nicm 145:
1.23 nicm 146: pbfind.name = (char *)name;
1.19 nicm 147: return (RB_FIND(paste_name_tree, &paste_by_name, &pbfind));
1.1 nicm 148: }
149:
1.30 nicm 150: /* Free a paste buffer. */
151: void
152: paste_free(struct paste_buffer *pb)
1.1 nicm 153: {
1.45 ! nicm 154: notify_paste_buffer(pb->name, 1);
1.44 nicm 155:
1.19 nicm 156: RB_REMOVE(paste_name_tree, &paste_by_name, pb);
157: RB_REMOVE(paste_time_tree, &paste_by_time, pb);
158: if (pb->automatic)
159: paste_num_automatic--;
1.1 nicm 160:
1.12 nicm 161: free(pb->data);
1.19 nicm 162: free(pb->name);
1.12 nicm 163: free(pb);
1.1 nicm 164: }
165:
1.8 nicm 166: /*
1.19 nicm 167: * Add an automatic buffer, freeing the oldest automatic item if at limit. Note
1.7 nicm 168: * that the caller is responsible for allocating data.
169: */
1.1 nicm 170: void
1.40 nicm 171: paste_add(const char *prefix, char *data, size_t size)
1.1 nicm 172: {
1.19 nicm 173: struct paste_buffer *pb, *pb1;
174: u_int limit;
1.2 nicm 175:
1.40 nicm 176: if (prefix == NULL)
177: prefix = "buffer";
178:
1.39 nicm 179: if (size == 0) {
180: free(data);
1.2 nicm 181: return;
1.39 nicm 182: }
1.1 nicm 183:
1.32 nicm 184: limit = options_get_number(global_options, "buffer-limit");
1.19 nicm 185: RB_FOREACH_REVERSE_SAFE(pb, paste_time_tree, &paste_by_time, pb1) {
186: if (paste_num_automatic < limit)
187: break;
188: if (pb->automatic)
1.30 nicm 189: paste_free(pb);
1.3 nicm 190: }
1.1 nicm 191:
192: pb = xmalloc(sizeof *pb);
1.19 nicm 193:
194: pb->name = NULL;
195: do {
196: free(pb->name);
1.40 nicm 197: xasprintf(&pb->name, "%s%u", prefix, paste_next_index);
1.19 nicm 198: paste_next_index++;
199: } while (paste_get_name(pb->name) != NULL);
1.1 nicm 200:
201: pb->data = data;
1.4 nicm 202: pb->size = size;
1.19 nicm 203:
204: pb->automatic = 1;
205: paste_num_automatic++;
206:
1.35 nicm 207: pb->created = time(NULL);
208:
1.19 nicm 209: pb->order = paste_next_order++;
210: RB_INSERT(paste_name_tree, &paste_by_name, pb);
211: RB_INSERT(paste_time_tree, &paste_by_time, pb);
1.44 nicm 212:
1.45 ! nicm 213: notify_paste_buffer(pb->name, 0);
1.1 nicm 214: }
215:
1.19 nicm 216: /* Rename a paste buffer. */
217: int
218: paste_rename(const char *oldname, const char *newname, char **cause)
219: {
1.20 nicm 220: struct paste_buffer *pb, *pb_new;
1.19 nicm 221:
222: if (cause != NULL)
223: *cause = NULL;
224:
225: if (oldname == NULL || *oldname == '\0') {
226: if (cause != NULL)
227: *cause = xstrdup("no buffer");
228: return (-1);
229: }
230: if (newname == NULL || *newname == '\0') {
231: if (cause != NULL)
232: *cause = xstrdup("new name is empty");
233: return (-1);
234: }
235:
236: pb = paste_get_name(oldname);
237: if (pb == NULL) {
238: if (cause != NULL)
1.20 nicm 239: xasprintf(cause, "no buffer %s", oldname);
240: return (-1);
241: }
242:
243: pb_new = paste_get_name(newname);
244: if (pb_new != NULL) {
245: if (cause != NULL)
246: xasprintf(cause, "buffer %s already exists", newname);
1.19 nicm 247: return (-1);
248: }
249:
250: RB_REMOVE(paste_name_tree, &paste_by_name, pb);
251:
252: free(pb->name);
253: pb->name = xstrdup(newname);
254:
255: if (pb->automatic)
256: paste_num_automatic--;
257: pb->automatic = 0;
258:
259: RB_INSERT(paste_name_tree, &paste_by_name, pb);
260:
1.45 ! nicm 261: notify_paste_buffer(oldname, 1);
! 262: notify_paste_buffer(newname, 0);
1.44 nicm 263:
1.19 nicm 264: return (0);
265: }
1.7 nicm 266:
1.8 nicm 267: /*
1.19 nicm 268: * Add or replace an item in the store. Note that the caller is responsible for
1.7 nicm 269: * allocating data.
270: */
1.1 nicm 271: int
1.19 nicm 272: paste_set(char *data, size_t size, const char *name, char **cause)
1.1 nicm 273: {
1.30 nicm 274: struct paste_buffer *pb, *old;
1.7 nicm 275:
1.19 nicm 276: if (cause != NULL)
277: *cause = NULL;
278:
1.15 nicm 279: if (size == 0) {
280: free(data);
1.7 nicm 281: return (0);
1.15 nicm 282: }
1.19 nicm 283: if (name == NULL) {
1.40 nicm 284: paste_add(NULL, data, size);
1.19 nicm 285: return (0);
286: }
1.1 nicm 287:
1.19 nicm 288: if (*name == '\0') {
289: if (cause != NULL)
290: *cause = xstrdup("empty buffer name");
1.1 nicm 291: return (-1);
1.19 nicm 292: }
293:
294: pb = xmalloc(sizeof *pb);
1.1 nicm 295:
1.19 nicm 296: pb->name = xstrdup(name);
1.1 nicm 297:
298: pb->data = data;
1.4 nicm 299: pb->size = size;
1.19 nicm 300:
301: pb->automatic = 0;
302: pb->order = paste_next_order++;
1.35 nicm 303:
304: pb->created = time(NULL);
1.27 nicm 305:
1.30 nicm 306: if ((old = paste_get_name(name)) != NULL)
307: paste_free(old);
1.19 nicm 308:
309: RB_INSERT(paste_name_tree, &paste_by_name, pb);
310: RB_INSERT(paste_time_tree, &paste_by_time, pb);
1.1 nicm 311:
1.45 ! nicm 312: notify_paste_buffer(name, 0);
1.44 nicm 313:
1.1 nicm 314: return (0);
1.41 nicm 315: }
316:
317: /* Set paste data without otherwise changing it. */
318: void
319: paste_replace(struct paste_buffer *pb, char *data, size_t size)
320: {
321: free(pb->data);
322: pb->data = data;
323: pb->size = size;
1.44 nicm 324:
1.45 ! nicm 325: notify_paste_buffer(pb->name, 0);
1.9 nicm 326: }
327:
1.17 nicm 328: /* Convert start of buffer into a nice string. */
1.9 nicm 329: char *
1.33 nicm 330: paste_make_sample(struct paste_buffer *pb)
1.9 nicm 331: {
1.17 nicm 332: char *buf;
333: size_t len, used;
1.42 nicm 334: const int flags = VIS_OCTAL|VIS_CSTYLE|VIS_TAB|VIS_NL;
1.17 nicm 335: const size_t width = 200;
1.9 nicm 336:
337: len = pb->size;
338: if (len > width)
339: len = width;
1.25 nicm 340: buf = xreallocarray(NULL, len, 4 + 4);
1.9 nicm 341:
1.33 nicm 342: used = utf8_strvis(buf, pb->data, len, flags);
1.13 nicm 343: if (pb->size > width || used > width)
1.17 nicm 344: strlcpy(buf + width, "...", 4);
1.9 nicm 345: return (buf);
1.1 nicm 346: }