Add support for simple menus usable with mouse or keyboard. New command

display-menu shows a menu (bound to the mouse on status line by default)
and a couple of extra formats for the default menus.

1 files changed, 163 insertions, 0 deletions

diff --git a/usr.bin/tmux/cmd-display-menu.c b/usr.bin/tmux/cmd-display-menu.c
new file mode 100644
index 00000000000..dfe4f9694d2
--- /dev/null
+++ b/usr.bin/tmux/cmd-display-menu.c
@@ -0,0 +1,163 @@
+/* $OpenBSD: cmd-display-menu.c,v 1.1 2019/05/10 18:04:06 nicm Exp $ */
+
+/*
+ * Copyright (c) 2019 Nicholas Marriott <nicholas.marriott@gmail.com>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
+ * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
+ * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <sys/types.h>
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "tmux.h"
+
+/*
+ * Display a menu on a client.
+ */
+
+static enum cmd_retval	cmd_display_menu_exec(struct cmd *,
+			    struct cmdq_item *);
+
+const struct cmd_entry cmd_display_menu_entry = {
+	.name = "display-menu",
+	.alias = "menu",
+
+	.args = { "c:FM:t:T:x:y:", 0, 0 },
+	.usage = "[-F] [-c target-client] [-M menu] " CMD_TARGET_PANE_USAGE " "
+	         "[-T title] [-x position] [-y position]",
+
+	.target = { 't', CMD_FIND_PANE, 0 },
+
+	.flags = CMD_AFTERHOOK,
+	.exec = cmd_display_menu_exec
+};
+
+static enum cmd_retval
+cmd_display_menu_exec(struct cmd *self, struct cmdq_item *item)
+{
+	struct args		*args = self->args;
+	struct client		*c;
+	struct session		*s = item->target.s;
+	struct winlink		*wl = item->target.wl;
+	struct window_pane	*wp = item->target.wp;
+	struct cmd_find_state	*fs = &item->target;
+	struct menu		*menu = NULL;
+	struct style_range	*sr;
+	const char		*string, *xp, *yp;
+	int			 at, flags;
+	u_int			 px, py, ox, oy, sx, sy;
+	char			*title;
+
+	if ((c = cmd_find_client(item, args_get(args, 'c'), 0)) == NULL)
+		return (CMD_RETURN_ERROR);
+	if (c->overlay_draw != NULL)
+		return (CMD_RETURN_NORMAL);
+	at = status_at_line(c);
+
+	string = args_get(args, 'M');
+	if (string == NULL) {
+		cmdq_error(item, "no menu specified");
+		return (CMD_RETURN_ERROR);
+	}
+	if (args_has(args, 'F'))
+		string = format_single(NULL, string, c, s, wl, wp);
+	else
+		string = xstrdup(string);
+	if (args_has(args, 'T'))
+		title = format_single(NULL, args_get(args, 'T'), c, s, wl, wp);
+	else
+		title = xstrdup("");
+	menu = menu_create_from_string(string, c, fs, title);
+	free(title);
+	if (menu == NULL) {
+		cmdq_error(item, "invalid menu %s", string);
+		return (CMD_RETURN_ERROR);
+	}
+	if (menu->count == 0) {
+		menu_free(menu);
+		return (CMD_RETURN_NORMAL);
+	}
+
+	xp = args_get(args, 'x');
+	if (xp == NULL)
+		px = 0;
+	else if (strcmp(xp, "R") == 0)
+		px = c->tty.sx - 1;
+	else if (strcmp(xp, "P") == 0) {
+		tty_window_offset(&c->tty, &ox, &oy, &sx, &sy);
+		if (wp->xoff >= ox)
+			px = wp->xoff - ox;
+		else
+			px = 0;
+	} else if (strcmp(xp, "M") == 0 && item->shared->mouse.valid) {
+		if (item->shared->mouse.x > (menu->width + 4) / 2)
+			px = item->shared->mouse.x - (menu->width + 4) / 2;
+		else
+			px = 0;
+	}
+	else if (strcmp(xp, "W") == 0) {
+		if (at == -1)
+			px = 0;
+		else {
+			TAILQ_FOREACH(sr, &c->status.entries[0].ranges, entry) {
+				if (sr->type != STYLE_RANGE_WINDOW)
+					continue;
+				if (sr->argument == (u_int)wl->idx)
+					break;
+			}
+			if (sr != NULL)
+				px = sr->start;
+			else
+				px = 0;
+		}
+	} else
+		px = strtoul(xp, NULL, 10);
+	if (px + menu->width + 4 >= c->tty.sx)
+		px = c->tty.sx - menu->width - 4;
+
+	yp = args_get(args, 'y');
+	if (yp == NULL)
+		py = 0;
+	else if (strcmp(yp, "P") == 0) {
+		tty_window_offset(&c->tty, &ox, &oy, &sx, &sy);
+		if (wp->yoff + wp->sy >= oy)
+			py = wp->yoff + wp->sy - oy;
+		else
+			py = 0;
+	} else if (strcmp(yp, "M") == 0 && item->shared->mouse.valid)
+		py = item->shared->mouse.y + menu->count + 2;
+	else if (strcmp(yp, "S") == 0) {
+		if (at == -1)
+			py = c->tty.sy;
+		else if (at == 0)
+			py = status_line_size(c) + menu->count + 2;
+		else
+			py = at;
+	} else
+		py = strtoul(yp, NULL, 10);
+	if (py < menu->count + 2)
+		py = 0;
+	else
+		py -= menu->count + 2;
+	if (py + menu->count + 2 >= c->tty.sy)
+		py = c->tty.sy - menu->count - 2;
+
+	flags = 0;
+	if (!item->shared->mouse.valid)
+		flags |= MENU_NOMOUSE;
+	if (menu_display(menu, flags, item, px, py, c, fs, NULL, NULL) != 0)
+		return (CMD_RETURN_NORMAL);
+	return (CMD_RETURN_WAIT);
+}