1 /* $OpenBSD: menu.c,v 1.31 2020/09/16 18:37:55 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_from_state(qitem, item->name, c, fs); 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, 0); 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_from_state(qitem, cmd, c, fs); 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 menu->width = format_width(title); 115 116 return (menu); 117 } 118 119 void 120 menu_free(struct menu *menu) 121 { 122 u_int i; 123 124 for (i = 0; i < menu->count; i++) { 125 free((void *)menu->items[i].name); 126 free((void *)menu->items[i].command); 127 } 128 free(menu->items); 129 130 free((void *)menu->title); 131 free(menu); 132 } 133 134 static struct screen * 135 menu_mode_cb(struct client *c, __unused u_int *cx, __unused u_int *cy) 136 { 137 struct menu_data *md = c->overlay_data; 138 139 return (&md->s); 140 } 141 142 static void 143 menu_draw_cb(struct client *c, __unused struct screen_redraw_ctx *ctx0) 144 { 145 struct menu_data *md = c->overlay_data; 146 struct tty *tty = &c->tty; 147 struct screen *s = &md->s; 148 struct menu *menu = md->menu; 149 struct screen_write_ctx ctx; 150 u_int i, px = md->px, py = md->py; 151 struct grid_cell gc; 152 153 style_apply(&gc, c->session->curw->window->options, "mode-style", NULL); 154 155 screen_write_start(&ctx, s); 156 screen_write_clearscreen(&ctx, 8); 157 screen_write_menu(&ctx, menu, md->choice, &gc); 158 screen_write_stop(&ctx); 159 160 for (i = 0; i < screen_size_y(&md->s); i++) { 161 tty_draw_line(tty, s, 0, i, menu->width + 4, px, py + i, 162 &grid_default_cell, NULL); 163 } 164 } 165 166 static void 167 menu_free_cb(struct client *c) 168 { 169 struct menu_data *md = c->overlay_data; 170 171 if (md->item != NULL) 172 cmdq_continue(md->item); 173 174 if (md->cb != NULL) 175 md->cb(md->menu, UINT_MAX, KEYC_NONE, md->data); 176 177 screen_free(&md->s); 178 menu_free(md->menu); 179 free(md); 180 } 181 182 static int 183 menu_key_cb(struct client *c, struct key_event *event) 184 { 185 struct menu_data *md = c->overlay_data; 186 struct menu *menu = md->menu; 187 struct mouse_event *m = &event->m; 188 u_int i; 189 int count = menu->count, old = md->choice; 190 const char *name = NULL; 191 const struct menu_item *item; 192 struct cmdq_state *state; 193 enum cmd_parse_status status; 194 char *error; 195 196 if (KEYC_IS_MOUSE(event->key)) { 197 if (md->flags & MENU_NOMOUSE) { 198 if (MOUSE_BUTTONS(m->b) != 0) 199 return (1); 200 return (0); 201 } 202 if (m->x < md->px || 203 m->x > md->px + 4 + menu->width || 204 m->y < md->py + 1 || 205 m->y > md->py + 1 + count - 1) { 206 if (MOUSE_RELEASE(m->b)) 207 return (1); 208 if (md->choice != -1) { 209 md->choice = -1; 210 c->flags |= CLIENT_REDRAWOVERLAY; 211 } 212 return (0); 213 } 214 if (MOUSE_RELEASE(m->b)) 215 goto chosen; 216 md->choice = m->y - (md->py + 1); 217 if (md->choice != old) 218 c->flags |= CLIENT_REDRAWOVERLAY; 219 return (0); 220 } 221 for (i = 0; i < (u_int)count; i++) { 222 name = menu->items[i].name; 223 if (name == NULL || *name == '-') 224 continue; 225 if (event->key == menu->items[i].key) { 226 md->choice = i; 227 goto chosen; 228 } 229 } 230 switch (event->key & ~KEYC_MASK_FLAGS) { 231 case KEYC_UP: 232 case 'k': 233 if (old == -1) 234 old = 0; 235 do { 236 if (md->choice == -1 || md->choice == 0) 237 md->choice = count - 1; 238 else 239 md->choice--; 240 name = menu->items[md->choice].name; 241 } while ((name == NULL || *name == '-') && md->choice != old); 242 c->flags |= CLIENT_REDRAWOVERLAY; 243 return (0); 244 case KEYC_BSPACE: 245 if (~md->flags & MENU_TAB) 246 break; 247 return (1); 248 case '\011': /* Tab */ 249 if (~md->flags & MENU_TAB) 250 break; 251 if (md->choice == count - 1) 252 return (1); 253 /* FALLTHROUGH */ 254 case KEYC_DOWN: 255 case 'j': 256 if (old == -1) 257 old = 0; 258 do { 259 if (md->choice == -1 || md->choice == count - 1) 260 md->choice = 0; 261 else 262 md->choice++; 263 name = menu->items[md->choice].name; 264 } while ((name == NULL || *name == '-') && md->choice != old); 265 c->flags |= CLIENT_REDRAWOVERLAY; 266 return (0); 267 case 'g': 268 case KEYC_PPAGE: 269 case '\002': /* C-b */ 270 if (md->choice > 5) 271 md->choice -= 5; 272 else 273 md->choice = 0; 274 while (md->choice != count && (name == NULL || *name == '-')) 275 md->choice++; 276 if (md->choice == count) 277 md->choice = -1; 278 c->flags |= CLIENT_REDRAWOVERLAY; 279 break; 280 case 'G': 281 case KEYC_NPAGE: 282 if (md->choice > count - 6) 283 md->choice = count - 1; 284 else 285 md->choice += 5; 286 while (md->choice != -1 && (name == NULL || *name == '-')) 287 md->choice--; 288 c->flags |= CLIENT_REDRAWOVERLAY; 289 break; 290 case '\006': /* C-f */ 291 break; 292 case '\r': 293 goto chosen; 294 case '\033': /* Escape */ 295 case '\003': /* C-c */ 296 case '\007': /* C-g */ 297 case 'q': 298 return (1); 299 } 300 return (0); 301 302 chosen: 303 if (md->choice == -1) 304 return (1); 305 item = &menu->items[md->choice]; 306 if (item->name == NULL || *item->name == '-') 307 return (1); 308 if (md->cb != NULL) { 309 md->cb(md->menu, md->choice, item->key, md->data); 310 md->cb = NULL; 311 return (1); 312 } 313 314 if (md->item != NULL) 315 event = cmdq_get_event(md->item); 316 else 317 event = NULL; 318 state = cmdq_new_state(&md->fs, event, 0); 319 320 status = cmd_parse_and_append(item->command, NULL, c, state, &error); 321 if (status == CMD_PARSE_ERROR) { 322 cmdq_append(c, cmdq_get_error(error)); 323 free(error); 324 } 325 cmdq_free_state(state); 326 327 return (1); 328 } 329 330 int 331 menu_display(struct menu *menu, int flags, struct cmdq_item *item, u_int px, 332 u_int py, struct client *c, struct cmd_find_state *fs, menu_choice_cb cb, 333 void *data) 334 { 335 struct menu_data *md; 336 u_int i; 337 const char *name; 338 339 if (c->tty.sx < menu->width + 4 || c->tty.sy < menu->count + 2) 340 return (-1); 341 if (px + menu->width + 4 > c->tty.sx) 342 px = c->tty.sx - menu->width - 4; 343 if (py + menu->count + 2 > c->tty.sy) 344 py = c->tty.sy - menu->count - 2; 345 346 md = xcalloc(1, sizeof *md); 347 md->item = item; 348 md->flags = flags; 349 350 if (fs != NULL) 351 cmd_find_copy_state(&md->fs, fs); 352 screen_init(&md->s, menu->width + 4, menu->count + 2, 0); 353 if (~md->flags & MENU_NOMOUSE) 354 md->s.mode |= MODE_MOUSE_ALL; 355 md->s.mode &= ~MODE_CURSOR; 356 357 md->px = px; 358 md->py = py; 359 360 md->menu = menu; 361 if (md->flags & MENU_NOMOUSE) { 362 for (i = 0; i < menu->count; i++) { 363 name = menu->items[i].name; 364 if (name != NULL && *name != '-') 365 break; 366 } 367 if (i != menu->count) 368 md->choice = i; 369 else 370 md->choice = -1; 371 } else 372 md->choice = -1; 373 374 md->cb = cb; 375 md->data = data; 376 377 server_client_set_overlay(c, 0, NULL, menu_mode_cb, menu_draw_cb, 378 menu_key_cb, menu_free_cb, md); 379 return (0); 380 } 381