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