xref: /openbsd-src/usr.bin/tmux/menu.c (revision 7350f337b9e3eb4461d99580e625c7ef148d107c)
1 /* $OpenBSD: menu.c,v 1.10 2019/06/18 11:08:42 nicm Exp $ */
2 
3 /*
4  * Copyright (c) 2019 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 
24 #include "tmux.h"
25 
26 struct menu_data {
27 	struct cmdq_item	*item;
28 	int			 flags;
29 
30 	struct cmd_find_state	 fs;
31 	struct screen		 s;
32 
33 	u_int			 px;
34 	u_int			 py;
35 
36 	struct menu		*menu;
37 	int			 choice;
38 
39 	menu_choice_cb		 cb;
40 	void			*data;
41 };
42 
43 void
44 menu_add_items(struct menu *menu, const struct menu_item *items,
45     struct cmdq_item *qitem, struct client *c, struct cmd_find_state *fs)
46 {
47 	const struct menu_item	*loop;
48 
49 	for (loop = items; loop->name != NULL; loop++)
50 		menu_add_item(menu, loop, qitem, c, fs);
51 }
52 
53 void
54 menu_add_item(struct menu *menu, const struct menu_item *item,
55     struct cmdq_item *qitem, struct client *c, struct cmd_find_state *fs)
56 {
57 	struct menu_item	*new_item;
58 	const char		*key, *cmd;
59 	char			*s, *name;
60 	u_int			 width;
61 	int			 line;
62 
63 	line = (item == NULL || item->name == NULL || *item->name == '\0');
64 	if (line && menu->count == 0)
65 		return;
66 
67 	menu->items = xreallocarray(menu->items, menu->count + 1,
68 	    sizeof *menu->items);
69 	new_item = &menu->items[menu->count++];
70 	memset(new_item, 0, sizeof *new_item);
71 
72 	if (line)
73 		return;
74 
75 	if (fs != NULL)
76 		s = format_single(qitem, item->name, c, fs->s, fs->wl, fs->wp);
77 	else
78 		s = format_single(qitem, item->name, c, NULL, NULL, NULL);
79 	if (*s == '\0') { /* no item if empty after format expanded */
80 		menu->count--;
81 		return;
82 	}
83 	if (*s != '-' && item->key != KEYC_UNKNOWN && item->key != KEYC_NONE) {
84 		key = key_string_lookup_key(item->key);
85 		xasprintf(&name, "%s#[default] #[align=right](%s)", s, key);
86 	} else
87 		xasprintf(&name, "%s", s);
88 	new_item->name = name;
89 	free(s);
90 
91 	cmd = item->command;
92 	if (cmd != NULL) {
93 		if (fs != NULL)
94 			s = format_single(qitem, cmd, c, fs->s, fs->wl, fs->wp);
95 		else
96 			s = format_single(qitem, cmd, c, NULL, NULL, NULL);
97 	} else
98 		s = NULL;
99 	new_item->command = s;
100 	new_item->key = item->key;
101 
102 	width = format_width(new_item->name);
103 	if (width > menu->width)
104 		menu->width = width;
105 }
106 
107 struct menu *
108 menu_create(const char *title)
109 {
110 	struct menu	*menu;
111 
112 	menu = xcalloc(1, sizeof *menu);
113 	menu->title = xstrdup(title);
114 
115 	return (menu);
116 }
117 
118 void
119 menu_free(struct menu *menu)
120 {
121 	u_int	i;
122 
123 	for (i = 0; i < menu->count; i++) {
124 		free((void *)menu->items[i].name);
125 		free((void *)menu->items[i].command);
126 	}
127 	free(menu->items);
128 
129 	free((void *)menu->title);
130 	free(menu);
131 }
132 
133 static void
134 menu_draw_cb(struct client *c, __unused struct screen_redraw_ctx *ctx0)
135 {
136 	struct menu_data	*md = c->overlay_data;
137 	struct tty		*tty = &c->tty;
138 	struct screen		*s = &md->s;
139 	struct menu		*menu = md->menu;
140 	struct screen_write_ctx	 ctx;
141 	u_int			 i, px, py;
142 
143 	screen_write_start(&ctx, NULL, s);
144 	screen_write_clearscreen(&ctx, 8);
145 	screen_write_menu(&ctx, menu, md->choice);
146 	screen_write_stop(&ctx);
147 
148 	px = md->px;
149 	py = md->py;
150 
151 	for (i = 0; i < screen_size_y(&md->s); i++)
152 		tty_draw_line(tty, NULL, s, 0, i, menu->width + 4, px, py + i);
153 
154 	if (~md->flags & MENU_NOMOUSE)
155 		tty_update_mode(tty, MODE_MOUSE_ALL, NULL);
156 }
157 
158 static void
159 menu_free_cb(struct client *c)
160 {
161 	struct menu_data	*md = c->overlay_data;
162 
163 	if (md->item != NULL)
164 		cmdq_continue(md->item);
165 
166 	if (md->cb != NULL)
167 		md->cb(md->menu, UINT_MAX, KEYC_NONE, md->data);
168 
169 	screen_free(&md->s);
170 	menu_free(md->menu);
171 	free(md);
172 }
173 
174 static int
175 menu_key_cb(struct client *c, struct key_event *event)
176 {
177 	struct menu_data		*md = c->overlay_data;
178 	struct menu			*menu = md->menu;
179 	struct mouse_event		*m = &event->m;
180 	u_int				 i;
181 	int				 count = menu->count, old = md->choice;
182 	const struct menu_item		*item;
183 	struct cmdq_item		*new_item;
184 	struct cmd_parse_result		*pr;
185 	const char			*name;
186 
187 	if (KEYC_IS_MOUSE(event->key)) {
188 		if (md->flags & MENU_NOMOUSE)
189 			return (0);
190 		if (m->x < md->px ||
191 		    m->x > md->px + 4 + menu->width ||
192 		    m->y < md->py + 1 ||
193 		    m->y > md->py + 1 + count - 1) {
194 			if (MOUSE_RELEASE(m->b))
195 				return (1);
196 			if (md->choice != -1) {
197 				md->choice = -1;
198 				c->flags |= CLIENT_REDRAWOVERLAY;
199 			}
200 			return (0);
201 		}
202 		if (MOUSE_RELEASE(m->b))
203 			goto chosen;
204 		md->choice = m->y - (md->py + 1);
205 		if (md->choice != old)
206 			c->flags |= CLIENT_REDRAWOVERLAY;
207 		return (0);
208 	}
209 	switch (event->key) {
210 	case KEYC_UP:
211 		if (old == -1)
212 			old = 0;
213 		do {
214 			if (md->choice == -1 || md->choice == 0)
215 				md->choice = count - 1;
216 			else
217 				md->choice--;
218 			name = menu->items[md->choice].name;
219 		} while ((name == NULL || *name == '-') && md->choice != old);
220 		c->flags |= CLIENT_REDRAWOVERLAY;
221 		return (0);
222 	case KEYC_DOWN:
223 		if (old == -1)
224 			old = 0;
225 		do {
226 			if (md->choice == -1 || md->choice == count - 1)
227 				md->choice = 0;
228 			else
229 				md->choice++;
230 			name = menu->items[md->choice].name;
231 		} while ((name == NULL || *name == '-') && md->choice != old);
232 		c->flags |= CLIENT_REDRAWOVERLAY;
233 		return (0);
234 	case '\r':
235 		goto chosen;
236 	case '\033': /* Escape */
237 	case '\003': /* C-c */
238 	case '\007': /* C-g */
239 	case 'q':
240 		return (1);
241 	}
242 	for (i = 0; i < (u_int)count; i++) {
243 		name = menu->items[i].name;
244 		if (name == NULL || *name == '-')
245 			continue;
246 		if (event->key == menu->items[i].key) {
247 			md->choice = i;
248 			goto chosen;
249 		}
250 	}
251 	return (0);
252 
253 chosen:
254 	if (md->choice == -1)
255 		return (1);
256 	item = &menu->items[md->choice];
257 	if (item->name == NULL || *item->name == '-')
258 		return (1);
259 	if (md->cb != NULL) {
260 	    md->cb(md->menu, md->choice, item->key, md->data);
261 	    md->cb = NULL;
262 	    return (1);
263 	}
264 
265 	pr = cmd_parse_from_string(item->command, NULL);
266 	switch (pr->status) {
267 	case CMD_PARSE_EMPTY:
268 		new_item = NULL;
269 		break;
270 	case CMD_PARSE_ERROR:
271 		new_item = cmdq_get_error(pr->error);
272 		free(pr->error);
273 		cmdq_append(c, new_item);
274 		break;
275 	case CMD_PARSE_SUCCESS:
276 		if (md->item != NULL)
277 			m = &md->item->shared->mouse;
278 		else
279 			m = NULL;
280 		new_item = cmdq_get_command(pr->cmdlist, &md->fs, m, 0);
281 		cmd_list_free(pr->cmdlist);
282 		cmdq_append(c, new_item);
283 		break;
284 	}
285 	return (1);
286 }
287 
288 int
289 menu_display(struct menu *menu, int flags, struct cmdq_item *item, u_int px,
290     u_int py, struct client *c, struct cmd_find_state *fs, menu_choice_cb cb,
291     void *data)
292 {
293 	struct menu_data	*md;
294 
295 	if (c->tty.sx < menu->width + 4 || c->tty.sy < menu->count + 2)
296 		return (-1);
297 
298 	md = xcalloc(1, sizeof *md);
299 	md->item = item;
300 	md->flags = flags;
301 
302 	if (fs != NULL)
303 		cmd_find_copy_state(&md->fs, fs);
304 	screen_init(&md->s, menu->width + 4, menu->count + 2, 0);
305 
306 	md->px = px;
307 	md->py = py;
308 
309 	md->menu = menu;
310 	md->choice = -1;
311 
312 	md->cb = cb;
313 	md->data = data;
314 
315 	server_client_set_overlay(c, 0, menu_draw_cb, menu_key_cb, menu_free_cb,
316 	    md);
317 	return (0);
318 }
319