xref: /netbsd-src/external/bsd/tmux/dist/cmd-list-keys.c (revision c23f9150cad51fdd442fa1806fac769ae26a1fdd)
15494e770Schristos /* $OpenBSD$ */
2698d5317Sjmmv 
3698d5317Sjmmv /*
4ed4e6cd4Schristos  * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
5698d5317Sjmmv  *
6698d5317Sjmmv  * Permission to use, copy, modify, and distribute this software for any
7698d5317Sjmmv  * purpose with or without fee is hereby granted, provided that the above
8698d5317Sjmmv  * copyright notice and this permission notice appear in all copies.
9698d5317Sjmmv  *
10698d5317Sjmmv  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11698d5317Sjmmv  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12698d5317Sjmmv  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13698d5317Sjmmv  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14698d5317Sjmmv  * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15698d5317Sjmmv  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16698d5317Sjmmv  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17698d5317Sjmmv  */
18698d5317Sjmmv 
19698d5317Sjmmv #include <sys/types.h>
20698d5317Sjmmv 
21ed4e6cd4Schristos #include <stdlib.h>
22698d5317Sjmmv #include <string.h>
23698d5317Sjmmv 
24698d5317Sjmmv #include "tmux.h"
25698d5317Sjmmv 
26698d5317Sjmmv /*
27698d5317Sjmmv  * List key bindings.
28698d5317Sjmmv  */
29698d5317Sjmmv 
304e179ddaSchristos static enum cmd_retval	cmd_list_keys_exec(struct cmd *, struct cmdq_item *);
315494e770Schristos 
324e179ddaSchristos static enum cmd_retval	cmd_list_keys_commands(struct cmd *,
334e179ddaSchristos 			    struct cmdq_item *);
34698d5317Sjmmv 
35698d5317Sjmmv const struct cmd_entry cmd_list_keys_entry = {
36ed4e6cd4Schristos 	.name = "list-keys",
37ed4e6cd4Schristos 	.alias = "lsk",
38ed4e6cd4Schristos 
396db26757Swiz 	.args = { "1aNP:T:", 0, 1, NULL },
40aa83ff61Schristos 	.usage = "[-1aN] [-P prefix-string] [-T key-table] [key]",
41ed4e6cd4Schristos 
424e179ddaSchristos 	.flags = CMD_STARTSERVER|CMD_AFTERHOOK,
43ed4e6cd4Schristos 	.exec = cmd_list_keys_exec
445494e770Schristos };
455494e770Schristos 
465494e770Schristos const struct cmd_entry cmd_list_commands_entry = {
47ed4e6cd4Schristos 	.name = "list-commands",
48ed4e6cd4Schristos 	.alias = "lscm",
49ed4e6cd4Schristos 
506db26757Swiz 	.args = { "F:", 0, 1, NULL },
51aa83ff61Schristos 	.usage = "[-F format] [command]",
52ed4e6cd4Schristos 
534e179ddaSchristos 	.flags = CMD_STARTSERVER|CMD_AFTERHOOK,
54ed4e6cd4Schristos 	.exec = cmd_list_keys_exec
55698d5317Sjmmv };
56698d5317Sjmmv 
57aa83ff61Schristos static u_int
cmd_list_keys_get_width(const char * tablename,key_code only)58aa83ff61Schristos cmd_list_keys_get_width(const char *tablename, key_code only)
59aa83ff61Schristos {
60aa83ff61Schristos 	struct key_table	*table;
61aa83ff61Schristos 	struct key_binding	*bd;
62aa83ff61Schristos 	u_int			 width, keywidth = 0;
63aa83ff61Schristos 
64aa83ff61Schristos 	table = key_bindings_get_table(tablename, 0);
65aa83ff61Schristos 	if (table == NULL)
66aa83ff61Schristos 		return (0);
67aa83ff61Schristos 	bd = key_bindings_first(table);
68aa83ff61Schristos 	while (bd != NULL) {
69aa83ff61Schristos 		if ((only != KEYC_UNKNOWN && bd->key != only) ||
70aa83ff61Schristos 		    KEYC_IS_MOUSE(bd->key) ||
719fb66d81Schristos 		    bd->note == NULL ||
729fb66d81Schristos 		    *bd->note == '\0') {
73aa83ff61Schristos 			bd = key_bindings_next(table, bd);
74aa83ff61Schristos 			continue;
75aa83ff61Schristos 		}
769fb66d81Schristos 		width = utf8_cstrwidth(key_string_lookup_key(bd->key, 0));
77aa83ff61Schristos 		if (width > keywidth)
78aa83ff61Schristos 			keywidth = width;
79aa83ff61Schristos 
80aa83ff61Schristos 		bd = key_bindings_next(table, bd);
81aa83ff61Schristos 	}
82aa83ff61Schristos 	return (keywidth);
83aa83ff61Schristos }
84aa83ff61Schristos 
85aa83ff61Schristos static int
cmd_list_keys_print_notes(struct cmdq_item * item,struct args * args,const char * tablename,u_int keywidth,key_code only,const char * prefix)86aa83ff61Schristos cmd_list_keys_print_notes(struct cmdq_item *item, struct args *args,
87aa83ff61Schristos     const char *tablename, u_int keywidth, key_code only, const char *prefix)
88aa83ff61Schristos {
899fb66d81Schristos 	struct client		*tc = cmdq_get_target_client(item);
90aa83ff61Schristos 	struct key_table	*table;
91aa83ff61Schristos 	struct key_binding	*bd;
92aa83ff61Schristos 	const char		*key;
93aa83ff61Schristos 	char			*tmp, *note;
94aa83ff61Schristos 	int	                 found = 0;
95aa83ff61Schristos 
96aa83ff61Schristos 	table = key_bindings_get_table(tablename, 0);
97aa83ff61Schristos 	if (table == NULL)
98aa83ff61Schristos 		return (0);
99aa83ff61Schristos 	bd = key_bindings_first(table);
100aa83ff61Schristos 	while (bd != NULL) {
101aa83ff61Schristos 		if ((only != KEYC_UNKNOWN && bd->key != only) ||
102aa83ff61Schristos 		    KEYC_IS_MOUSE(bd->key) ||
1039fb66d81Schristos 		    ((bd->note == NULL || *bd->note == '\0') &&
1049fb66d81Schristos 		    !args_has(args, 'a'))) {
105aa83ff61Schristos 			bd = key_bindings_next(table, bd);
106aa83ff61Schristos 			continue;
107aa83ff61Schristos 		}
108aa83ff61Schristos 		found = 1;
1099fb66d81Schristos 		key = key_string_lookup_key(bd->key, 0);
110aa83ff61Schristos 
1119fb66d81Schristos 		if (bd->note == NULL || *bd->note == '\0')
112aa83ff61Schristos 			note = cmd_list_print(bd->cmdlist, 1);
113aa83ff61Schristos 		else
114aa83ff61Schristos 			note = xstrdup(bd->note);
115aa83ff61Schristos 		tmp = utf8_padcstr(key, keywidth + 1);
1169fb66d81Schristos 		if (args_has(args, '1') && tc != NULL) {
1179fb66d81Schristos 			status_message_set(tc, -1, 1, 0, "%s%s%s", prefix, tmp,
1189fb66d81Schristos 			    note);
1199fb66d81Schristos 		} else
120aa83ff61Schristos 			cmdq_print(item, "%s%s%s", prefix, tmp, note);
121aa83ff61Schristos 		free(tmp);
122aa83ff61Schristos 		free(note);
123aa83ff61Schristos 
124aa83ff61Schristos 		if (args_has(args, '1'))
125aa83ff61Schristos 			break;
126aa83ff61Schristos 		bd = key_bindings_next(table, bd);
127aa83ff61Schristos 	}
128aa83ff61Schristos 	return (found);
129aa83ff61Schristos }
130aa83ff61Schristos 
131aa83ff61Schristos static char *
cmd_list_keys_get_prefix(struct args * args,key_code * prefix)132aa83ff61Schristos cmd_list_keys_get_prefix(struct args *args, key_code *prefix)
133aa83ff61Schristos {
134aa83ff61Schristos 	char	*s;
135aa83ff61Schristos 
136aa83ff61Schristos 	*prefix = options_get_number(global_s_options, "prefix");
137aa83ff61Schristos 	if (!args_has(args, 'P')) {
138aa83ff61Schristos 		if (*prefix != KEYC_NONE)
1399fb66d81Schristos 			xasprintf(&s, "%s ", key_string_lookup_key(*prefix, 0));
140aa83ff61Schristos 		else
141aa83ff61Schristos 			s = xstrdup("");
142aa83ff61Schristos 	} else
143aa83ff61Schristos 		s = xstrdup(args_get(args, 'P'));
144aa83ff61Schristos 	return (s);
145aa83ff61Schristos }
146aa83ff61Schristos 
1474e179ddaSchristos static enum cmd_retval
cmd_list_keys_exec(struct cmd * self,struct cmdq_item * item)1484e179ddaSchristos cmd_list_keys_exec(struct cmd *self, struct cmdq_item *item)
149698d5317Sjmmv {
1509fb66d81Schristos 	struct args		*args = cmd_get_args(self);
151*c23f9150Swiz 	struct client		*tc = cmdq_get_target_client(item);
1525494e770Schristos 	struct key_table	*table;
153698d5317Sjmmv 	struct key_binding	*bd;
1546db26757Swiz 	const char		*tablename, *r, *keystr;
155aa83ff61Schristos 	char			*key, *cp, *tmp, *start, *empty;
156aa83ff61Schristos 	key_code		 prefix, only = KEYC_UNKNOWN;
157aa83ff61Schristos 	int			 repeat, width, tablewidth, keywidth, found = 0;
1586483eba0Schristos 	size_t			 tmpsize, tmpused, cplen;
1595494e770Schristos 
1609fb66d81Schristos 	if (cmd_get_entry(self) == &cmd_list_commands_entry)
1614e179ddaSchristos 		return (cmd_list_keys_commands(self, item));
162698d5317Sjmmv 
1636db26757Swiz 	if ((keystr = args_string(args, 0)) != NULL) {
1646db26757Swiz 		only = key_string_lookup_string(keystr);
165aa83ff61Schristos 		if (only == KEYC_UNKNOWN) {
1666db26757Swiz 			cmdq_error(item, "invalid key: %s", keystr);
167aa83ff61Schristos 			return (CMD_RETURN_ERROR);
168aa83ff61Schristos 		}
169de7701e2Schristos 		only &= (KEYC_MASK_KEY|KEYC_MASK_MODIFIERS);
170aa83ff61Schristos 	}
171aa83ff61Schristos 
1725494e770Schristos 	tablename = args_get(args, 'T');
1735494e770Schristos 	if (tablename != NULL && key_bindings_get_table(tablename, 0) == NULL) {
1744e179ddaSchristos 		cmdq_error(item, "table %s doesn't exist", tablename);
1755494e770Schristos 		return (CMD_RETURN_ERROR);
176698d5317Sjmmv 	}
177698d5317Sjmmv 
178aa83ff61Schristos 	if (args_has(args, 'N')) {
179aa83ff61Schristos 		if (tablename == NULL) {
180aa83ff61Schristos 			start = cmd_list_keys_get_prefix(args, &prefix);
181aa83ff61Schristos 			keywidth = cmd_list_keys_get_width("root", only);
182aa83ff61Schristos 			if (prefix != KEYC_NONE) {
183aa83ff61Schristos 				width = cmd_list_keys_get_width("prefix", only);
184aa83ff61Schristos 				if (width == 0)
185aa83ff61Schristos 					prefix = KEYC_NONE;
186aa83ff61Schristos 				else if (width > keywidth)
187aa83ff61Schristos 					keywidth = width;
188aa83ff61Schristos 			}
189aa83ff61Schristos 			empty = utf8_padcstr("", utf8_cstrwidth(start));
190aa83ff61Schristos 
191aa83ff61Schristos 			found = cmd_list_keys_print_notes(item, args, "root",
192aa83ff61Schristos 			    keywidth, only, empty);
193aa83ff61Schristos 			if (prefix != KEYC_NONE) {
194aa83ff61Schristos 				if (cmd_list_keys_print_notes(item, args,
195aa83ff61Schristos 				    "prefix", keywidth, only, start))
196aa83ff61Schristos 					found = 1;
197aa83ff61Schristos 			}
198aa83ff61Schristos 			free(empty);
199aa83ff61Schristos 		} else {
200aa83ff61Schristos 			if (args_has(args, 'P'))
201aa83ff61Schristos 				start = xstrdup(args_get(args, 'P'));
202aa83ff61Schristos 			else
203aa83ff61Schristos 				start = xstrdup("");
204aa83ff61Schristos 			keywidth = cmd_list_keys_get_width(tablename, only);
205aa83ff61Schristos 			found = cmd_list_keys_print_notes(item, args, tablename,
206aa83ff61Schristos 			    keywidth, only, start);
207aa83ff61Schristos 
208aa83ff61Schristos 		}
209aa83ff61Schristos 		free(start);
210aa83ff61Schristos 		goto out;
211aa83ff61Schristos 	}
212aa83ff61Schristos 
2135494e770Schristos 	repeat = 0;
2145494e770Schristos 	tablewidth = keywidth = 0;
2158f3b9483Schristos 	table = key_bindings_first_table();
2168f3b9483Schristos 	while (table != NULL) {
2178f3b9483Schristos 		if (tablename != NULL && strcmp(table->name, tablename) != 0) {
2188f3b9483Schristos 			table = key_bindings_next_table(table);
2195494e770Schristos 			continue;
2208f3b9483Schristos 		}
2218f3b9483Schristos 		bd = key_bindings_first(table);
2228f3b9483Schristos 		while (bd != NULL) {
223aa83ff61Schristos 			if (only != KEYC_UNKNOWN && bd->key != only) {
224aa83ff61Schristos 				bd = key_bindings_next(table, bd);
225aa83ff61Schristos 				continue;
226aa83ff61Schristos 			}
2279fb66d81Schristos 			key = args_escape(key_string_lookup_key(bd->key, 0));
228d530c4d0Sjmmv 
229c9ad075bSchristos 			if (bd->flags & KEY_BINDING_REPEAT)
2305494e770Schristos 				repeat = 1;
231d530c4d0Sjmmv 
232ed4e6cd4Schristos 			width = utf8_cstrwidth(table->name);
2335494e770Schristos 			if (width > tablewidth)
2345494e770Schristos 				tablewidth = width;
235ed4e6cd4Schristos 			width = utf8_cstrwidth(key);
2365494e770Schristos 			if (width > keywidth)
2375494e770Schristos 				keywidth = width;
2388f3b9483Schristos 
2396483eba0Schristos 			free(key);
2408f3b9483Schristos 			bd = key_bindings_next(table, bd);
2415494e770Schristos 		}
2428f3b9483Schristos 		table = key_bindings_next_table(table);
2435494e770Schristos 	}
2445494e770Schristos 
2456483eba0Schristos 	tmpsize = 256;
2466483eba0Schristos 	tmp = xmalloc(tmpsize);
2476483eba0Schristos 
2488f3b9483Schristos 	table = key_bindings_first_table();
2498f3b9483Schristos 	while (table != NULL) {
2508f3b9483Schristos 		if (tablename != NULL && strcmp(table->name, tablename) != 0) {
2518f3b9483Schristos 			table = key_bindings_next_table(table);
2525494e770Schristos 			continue;
2538f3b9483Schristos 		}
2548f3b9483Schristos 		bd = key_bindings_first(table);
2558f3b9483Schristos 		while (bd != NULL) {
256aa83ff61Schristos 			if (only != KEYC_UNKNOWN && bd->key != only) {
257aa83ff61Schristos 				bd = key_bindings_next(table, bd);
258aa83ff61Schristos 				continue;
259aa83ff61Schristos 			}
260aa83ff61Schristos 			found = 1;
2619fb66d81Schristos 			key = args_escape(key_string_lookup_key(bd->key, 0));
262698d5317Sjmmv 
2635494e770Schristos 			if (!repeat)
2645494e770Schristos 				r = "";
265c9ad075bSchristos 			else if (bd->flags & KEY_BINDING_REPEAT)
2665494e770Schristos 				r = "-r ";
2675494e770Schristos 			else
2685494e770Schristos 				r = "   ";
2696483eba0Schristos 			tmpused = xsnprintf(tmp, tmpsize, "%s-T ", r);
270ed4e6cd4Schristos 
271ed4e6cd4Schristos 			cp = utf8_padcstr(table->name, tablewidth);
2726483eba0Schristos 			cplen = strlen(cp) + 1;
2736483eba0Schristos 			while (tmpused + cplen + 1 >= tmpsize) {
2746483eba0Schristos 				tmpsize *= 2;
2756483eba0Schristos 				tmp = xrealloc(tmp, tmpsize);
2766483eba0Schristos 			}
2779fb66d81Schristos 			strlcat(tmp, cp, tmpsize);
2786483eba0Schristos 			tmpused = strlcat(tmp, " ", tmpsize);
279ed4e6cd4Schristos 			free(cp);
280ed4e6cd4Schristos 
281ed4e6cd4Schristos 			cp = utf8_padcstr(key, keywidth);
2826483eba0Schristos 			cplen = strlen(cp) + 1;
2836483eba0Schristos 			while (tmpused + cplen + 1 >= tmpsize) {
2846483eba0Schristos 				tmpsize *= 2;
2856483eba0Schristos 				tmp = xrealloc(tmp, tmpsize);
2866483eba0Schristos 			}
2879fb66d81Schristos 			strlcat(tmp, cp, tmpsize);
2886483eba0Schristos 			tmpused = strlcat(tmp, " ", tmpsize);
289ed4e6cd4Schristos 			free(cp);
290ed4e6cd4Schristos 
2916483eba0Schristos 			cp = cmd_list_print(bd->cmdlist, 1);
2926483eba0Schristos 			cplen = strlen(cp);
2936483eba0Schristos 			while (tmpused + cplen + 1 >= tmpsize) {
2946483eba0Schristos 				tmpsize *= 2;
2956483eba0Schristos 				tmp = xrealloc(tmp, tmpsize);
2966483eba0Schristos 			}
2976483eba0Schristos 			strlcat(tmp, cp, tmpsize);
298ed4e6cd4Schristos 			free(cp);
2995494e770Schristos 
300*c23f9150Swiz 			if (args_has(args, '1') && tc != NULL) {
301*c23f9150Swiz 				status_message_set(tc, -1, 1, 0, "bind-key %s",
302*c23f9150Swiz 				    tmp);
303*c23f9150Swiz 			} else
3044e179ddaSchristos 				cmdq_print(item, "bind-key %s", tmp);
3056483eba0Schristos 			free(key);
306*c23f9150Swiz 
307*c23f9150Swiz 			if (args_has(args, '1'))
308*c23f9150Swiz 				break;
3098f3b9483Schristos 			bd = key_bindings_next(table, bd);
310698d5317Sjmmv 		}
3118f3b9483Schristos 		table = key_bindings_next_table(table);
3125494e770Schristos 	}
313698d5317Sjmmv 
3146483eba0Schristos 	free(tmp);
3156483eba0Schristos 
316aa83ff61Schristos out:
317aa83ff61Schristos 	if (only != KEYC_UNKNOWN && !found) {
3186db26757Swiz 		cmdq_error(item, "unknown key: %s", args_string(args, 0));
319aa83ff61Schristos 		return (CMD_RETURN_ERROR);
320aa83ff61Schristos 	}
321928fc495Schristos 	return (CMD_RETURN_NORMAL);
322698d5317Sjmmv }
323698d5317Sjmmv 
3244e179ddaSchristos static enum cmd_retval
cmd_list_keys_commands(struct cmd * self,struct cmdq_item * item)3254e179ddaSchristos cmd_list_keys_commands(struct cmd *self, struct cmdq_item *item)
326698d5317Sjmmv {
3279fb66d81Schristos 	struct args		 *args = cmd_get_args(self);
3285494e770Schristos 	const struct cmd_entry	**entryp;
3295494e770Schristos 	const struct cmd_entry	 *entry;
3304e179ddaSchristos 	struct format_tree	 *ft;
3316db26757Swiz 	const char		 *template, *s, *command;
3324e179ddaSchristos 	char			 *line;
3334e179ddaSchristos 
3344e179ddaSchristos 	if ((template = args_get(args, 'F')) == NULL) {
3354e179ddaSchristos 		template = "#{command_list_name}"
3364e179ddaSchristos 		    "#{?command_list_alias, (#{command_list_alias}),} "
3374e179ddaSchristos 		    "#{command_list_usage}";
3384e179ddaSchristos 	}
3394e179ddaSchristos 
3409fb66d81Schristos 	ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);
3414e179ddaSchristos 	format_defaults(ft, NULL, NULL, NULL, NULL);
3425494e770Schristos 
3436db26757Swiz 	command = args_string(args, 0);
3445494e770Schristos 	for (entryp = cmd_table; *entryp != NULL; entryp++) {
3455494e770Schristos 		entry = *entryp;
346aa83ff61Schristos 		if (command != NULL &&
347aa83ff61Schristos 		    (strcmp(entry->name, command) != 0 &&
348aa83ff61Schristos 		    (entry->alias == NULL ||
349aa83ff61Schristos 		    strcmp(entry->alias, command) != 0)))
350aa83ff61Schristos 		    continue;
3514e179ddaSchristos 
3524e179ddaSchristos 		format_add(ft, "command_list_name", "%s", entry->name);
3534e179ddaSchristos 		if (entry->alias != NULL)
3544e179ddaSchristos 			s = entry->alias;
3554e179ddaSchristos 		else
3564e179ddaSchristos 			s = "";
3574e179ddaSchristos 		format_add(ft, "command_list_alias", "%s", s);
3584e179ddaSchristos 		if (entry->usage != NULL)
3594e179ddaSchristos 			s = entry->usage;
3604e179ddaSchristos 		else
3614e179ddaSchristos 			s = "";
3624e179ddaSchristos 		format_add(ft, "command_list_usage", "%s", s);
3634e179ddaSchristos 
3644e179ddaSchristos 		line = format_expand(ft, template);
3654e179ddaSchristos 		if (*line != '\0')
3664e179ddaSchristos 			cmdq_print(item, "%s", line);
3674e179ddaSchristos 		free(line);
3685494e770Schristos 	}
3695494e770Schristos 
3704e179ddaSchristos 	format_free(ft);
3715494e770Schristos 	return (CMD_RETURN_NORMAL);
3725494e770Schristos }
373