Annotation of src/usr.bin/tmux/cmd-list-keys.c, Revision 1.66
1.66 ! nicm 1: /* $OpenBSD: cmd-list-keys.c,v 1.65 2021/08/20 19:50:16 nicm Exp $ */
1.1 nicm 2:
3: /*
1.34 nicm 4: * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 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:
1.29 nicm 21: #include <stdlib.h>
1.3 nicm 22: #include <string.h>
23:
1.1 nicm 24: #include "tmux.h"
25:
26: /*
27: * List key bindings.
28: */
29:
1.40 nicm 30: static enum cmd_retval cmd_list_keys_exec(struct cmd *, struct cmdq_item *);
1.24 nicm 31:
1.40 nicm 32: static enum cmd_retval cmd_list_keys_commands(struct cmd *,
33: struct cmdq_item *);
1.6 nicm 34:
1.1 nicm 35: const struct cmd_entry cmd_list_keys_entry = {
1.32 nicm 36: .name = "list-keys",
37: .alias = "lsk",
38:
1.66 ! nicm 39: .args = { "1aNP:T:", 0, 1, NULL },
1.51 nicm 40: .usage = "[-1aN] [-P prefix-string] [-T key-table] [key]",
1.32 nicm 41:
1.39 nicm 42: .flags = CMD_STARTSERVER|CMD_AFTERHOOK,
1.32 nicm 43: .exec = cmd_list_keys_exec
1.1 nicm 44: };
45:
1.24 nicm 46: const struct cmd_entry cmd_list_commands_entry = {
1.32 nicm 47: .name = "list-commands",
48: .alias = "lscm",
49:
1.66 ! nicm 50: .args = { "F:", 0, 1, NULL },
1.52 nicm 51: .usage = "[-F format] [command]",
1.32 nicm 52:
1.39 nicm 53: .flags = CMD_STARTSERVER|CMD_AFTERHOOK,
1.32 nicm 54: .exec = cmd_list_keys_exec
1.24 nicm 55: };
56:
1.50 nicm 57: static u_int
58: cmd_list_keys_get_width(const char *tablename, key_code only)
59: {
60: struct key_table *table;
61: struct key_binding *bd;
62: u_int width, keywidth = 0;
63:
64: table = key_bindings_get_table(tablename, 0);
65: if (table == NULL)
66: return (0);
67: bd = key_bindings_first(table);
68: while (bd != NULL) {
69: if ((only != KEYC_UNKNOWN && bd->key != only) ||
70: KEYC_IS_MOUSE(bd->key) ||
1.58 nicm 71: bd->note == NULL ||
72: *bd->note == '\0') {
1.50 nicm 73: bd = key_bindings_next(table, bd);
74: continue;
75: }
1.59 nicm 76: width = utf8_cstrwidth(key_string_lookup_key(bd->key, 0));
1.50 nicm 77: if (width > keywidth)
78: keywidth = width;
79:
80: bd = key_bindings_next(table, bd);
81: }
82: return (keywidth);
83: }
84:
85: static int
86: cmd_list_keys_print_notes(struct cmdq_item *item, struct args *args,
87: const char *tablename, u_int keywidth, key_code only, const char *prefix)
88: {
1.56 nicm 89: struct client *tc = cmdq_get_target_client(item);
1.50 nicm 90: struct key_table *table;
91: struct key_binding *bd;
92: const char *key;
1.51 nicm 93: char *tmp, *note;
1.50 nicm 94: int found = 0;
95:
96: table = key_bindings_get_table(tablename, 0);
97: if (table == NULL)
98: return (0);
99: bd = key_bindings_first(table);
100: while (bd != NULL) {
101: if ((only != KEYC_UNKNOWN && bd->key != only) ||
102: KEYC_IS_MOUSE(bd->key) ||
1.58 nicm 103: ((bd->note == NULL || *bd->note == '\0') &&
104: !args_has(args, 'a'))) {
1.50 nicm 105: bd = key_bindings_next(table, bd);
106: continue;
107: }
108: found = 1;
1.59 nicm 109: key = key_string_lookup_key(bd->key, 0);
1.50 nicm 110:
1.58 nicm 111: if (bd->note == NULL || *bd->note == '\0')
1.51 nicm 112: note = cmd_list_print(bd->cmdlist, 1);
113: else
114: note = xstrdup(bd->note);
1.50 nicm 115: tmp = utf8_padcstr(key, keywidth + 1);
1.62 nicm 116: if (args_has(args, '1') && tc != NULL) {
117: status_message_set(tc, -1, 1, 0, "%s%s%s", prefix, tmp,
118: note);
119: } else
1.51 nicm 120: cmdq_print(item, "%s%s%s", prefix, tmp, note);
1.50 nicm 121: free(tmp);
1.51 nicm 122: free(note);
1.50 nicm 123:
124: if (args_has(args, '1'))
125: break;
126: bd = key_bindings_next(table, bd);
127: }
128: return (found);
129: }
130:
131: static char *
132: cmd_list_keys_get_prefix(struct args *args, key_code *prefix)
133: {
134: char *s;
135:
136: *prefix = options_get_number(global_s_options, "prefix");
137: if (!args_has(args, 'P')) {
138: if (*prefix != KEYC_NONE)
1.59 nicm 139: xasprintf(&s, "%s ", key_string_lookup_key(*prefix, 0));
1.50 nicm 140: else
141: s = xstrdup("");
142: } else
143: s = xstrdup(args_get(args, 'P'));
144: return (s);
145: }
146:
1.35 nicm 147: static enum cmd_retval
1.40 nicm 148: cmd_list_keys_exec(struct cmd *self, struct cmdq_item *item)
1.1 nicm 149: {
1.54 nicm 150: struct args *args = cmd_get_args(self);
1.26 nicm 151: struct key_table *table;
1.1 nicm 152: struct key_binding *bd;
1.65 nicm 153: const char *tablename, *r, *keystr;
1.50 nicm 154: char *key, *cp, *tmp, *start, *empty;
155: key_code prefix, only = KEYC_UNKNOWN;
156: int repeat, width, tablewidth, keywidth, found = 0;
1.48 nicm 157: size_t tmpsize, tmpused, cplen;
1.3 nicm 158:
1.54 nicm 159: if (cmd_get_entry(self) == &cmd_list_commands_entry)
1.40 nicm 160: return (cmd_list_keys_commands(self, item));
1.24 nicm 161:
1.65 nicm 162: if ((keystr = args_string(args, 0)) != NULL) {
163: only = key_string_lookup_string(keystr);
1.50 nicm 164: if (only == KEYC_UNKNOWN) {
1.65 nicm 165: cmdq_error(item, "invalid key: %s", keystr);
1.50 nicm 166: return (CMD_RETURN_ERROR);
167: }
1.63 nicm 168: only &= (KEYC_MASK_KEY|KEYC_MASK_MODIFIERS);
1.50 nicm 169: }
170:
1.26 nicm 171: tablename = args_get(args, 'T');
172: if (tablename != NULL && key_bindings_get_table(tablename, 0) == NULL) {
1.40 nicm 173: cmdq_error(item, "table %s doesn't exist", tablename);
1.26 nicm 174: return (CMD_RETURN_ERROR);
175: }
1.15 nicm 176:
1.50 nicm 177: if (args_has(args, 'N')) {
178: if (tablename == NULL) {
179: start = cmd_list_keys_get_prefix(args, &prefix);
180: keywidth = cmd_list_keys_get_width("root", only);
181: if (prefix != KEYC_NONE) {
182: width = cmd_list_keys_get_width("prefix", only);
183: if (width == 0)
184: prefix = KEYC_NONE;
185: else if (width > keywidth)
186: keywidth = width;
187: }
188: empty = utf8_padcstr("", utf8_cstrwidth(start));
189:
190: found = cmd_list_keys_print_notes(item, args, "root",
191: keywidth, only, empty);
192: if (prefix != KEYC_NONE) {
193: if (cmd_list_keys_print_notes(item, args,
194: "prefix", keywidth, only, start))
195: found = 1;
196: }
197: free(empty);
198: } else {
199: if (args_has(args, 'P'))
200: start = xstrdup(args_get(args, 'P'));
201: else
202: start = xstrdup("");
203: keywidth = cmd_list_keys_get_width(tablename, only);
204: found = cmd_list_keys_print_notes(item, args, tablename,
205: keywidth, only, start);
206:
207: }
208: free(start);
209: goto out;
210: }
211:
1.26 nicm 212: repeat = 0;
213: tablewidth = keywidth = 0;
1.64 nicm 214: table = key_bindings_first_table();
1.45 nicm 215: while (table != NULL) {
216: if (tablename != NULL && strcmp(table->name, tablename) != 0) {
217: table = key_bindings_next_table(table);
1.3 nicm 218: continue;
1.45 nicm 219: }
220: bd = key_bindings_first(table);
221: while (bd != NULL) {
1.50 nicm 222: if (only != KEYC_UNKNOWN && bd->key != only) {
223: bd = key_bindings_next(table, bd);
224: continue;
225: }
1.59 nicm 226: key = args_escape(key_string_lookup_key(bd->key, 0));
1.3 nicm 227:
1.43 nicm 228: if (bd->flags & KEY_BINDING_REPEAT)
1.26 nicm 229: repeat = 1;
230:
1.29 nicm 231: width = utf8_cstrwidth(table->name);
1.26 nicm 232: if (width > tablewidth)
1.28 nicm 233: tablewidth = width;
234: width = utf8_cstrwidth(key);
1.26 nicm 235: if (width > keywidth)
236: keywidth = width;
1.45 nicm 237:
1.46 nicm 238: free(key);
1.45 nicm 239: bd = key_bindings_next(table, bd);
1.26 nicm 240: }
1.45 nicm 241: table = key_bindings_next_table(table);
1.3 nicm 242: }
243:
1.48 nicm 244: tmpsize = 256;
245: tmp = xmalloc(tmpsize);
1.65 nicm 246:
1.64 nicm 247: table = key_bindings_first_table();
1.45 nicm 248: while (table != NULL) {
249: if (tablename != NULL && strcmp(table->name, tablename) != 0) {
250: table = key_bindings_next_table(table);
1.1 nicm 251: continue;
1.45 nicm 252: }
253: bd = key_bindings_first(table);
254: while (bd != NULL) {
1.50 nicm 255: if (only != KEYC_UNKNOWN && bd->key != only) {
256: bd = key_bindings_next(table, bd);
257: continue;
258: }
259: found = 1;
1.59 nicm 260: key = args_escape(key_string_lookup_key(bd->key, 0));
1.26 nicm 261:
262: if (!repeat)
263: r = "";
1.43 nicm 264: else if (bd->flags & KEY_BINDING_REPEAT)
1.26 nicm 265: r = "-r ";
1.14 nicm 266: else
1.26 nicm 267: r = " ";
1.48 nicm 268: tmpused = xsnprintf(tmp, tmpsize, "%s-T ", r);
1.29 nicm 269:
270: cp = utf8_padcstr(table->name, tablewidth);
1.48 nicm 271: cplen = strlen(cp) + 1;
1.49 nicm 272: while (tmpused + cplen + 1 >= tmpsize) {
1.48 nicm 273: tmpsize *= 2;
274: tmp = xrealloc(tmp, tmpsize);
275: }
1.53 nicm 276: strlcat(tmp, cp, tmpsize);
1.48 nicm 277: tmpused = strlcat(tmp, " ", tmpsize);
1.29 nicm 278: free(cp);
279:
280: cp = utf8_padcstr(key, keywidth);
1.48 nicm 281: cplen = strlen(cp) + 1;
282: while (tmpused + cplen + 1 >= tmpsize) {
283: tmpsize *= 2;
284: tmp = xrealloc(tmp, tmpsize);
285: }
1.53 nicm 286: strlcat(tmp, cp, tmpsize);
1.48 nicm 287: tmpused = strlcat(tmp, " ", tmpsize);
1.29 nicm 288: free(cp);
289:
1.46 nicm 290: cp = cmd_list_print(bd->cmdlist, 1);
1.48 nicm 291: cplen = strlen(cp);
292: while (tmpused + cplen + 1 >= tmpsize) {
293: tmpsize *= 2;
294: tmp = xrealloc(tmp, tmpsize);
295: }
296: strlcat(tmp, cp, tmpsize);
1.31 nicm 297: free(cp);
1.1 nicm 298:
1.40 nicm 299: cmdq_print(item, "bind-key %s", tmp);
1.46 nicm 300:
301: free(key);
1.45 nicm 302: bd = key_bindings_next(table, bd);
1.14 nicm 303: }
1.45 nicm 304: table = key_bindings_next_table(table);
1.24 nicm 305: }
1.48 nicm 306:
307: free(tmp);
1.24 nicm 308:
1.50 nicm 309: out:
310: if (only != KEYC_UNKNOWN && !found) {
1.65 nicm 311: cmdq_error(item, "unknown key: %s", args_string(args, 0));
1.50 nicm 312: return (CMD_RETURN_ERROR);
313: }
1.24 nicm 314: return (CMD_RETURN_NORMAL);
315: }
316:
1.35 nicm 317: static enum cmd_retval
1.40 nicm 318: cmd_list_keys_commands(struct cmd *self, struct cmdq_item *item)
1.24 nicm 319: {
1.54 nicm 320: struct args *args = cmd_get_args(self);
1.24 nicm 321: const struct cmd_entry **entryp;
1.25 nicm 322: const struct cmd_entry *entry;
1.35 nicm 323: struct format_tree *ft;
1.65 nicm 324: const char *template, *s, *command;
1.35 nicm 325: char *line;
326:
327: if ((template = args_get(args, 'F')) == NULL) {
328: template = "#{command_list_name}"
329: "#{?command_list_alias, (#{command_list_alias}),} "
330: "#{command_list_usage}";
331: }
332:
1.55 nicm 333: ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);
1.35 nicm 334: format_defaults(ft, NULL, NULL, NULL, NULL);
1.24 nicm 335:
1.65 nicm 336: command = args_string(args, 0);
1.24 nicm 337: for (entryp = cmd_table; *entryp != NULL; entryp++) {
338: entry = *entryp;
1.52 nicm 339: if (command != NULL &&
340: (strcmp(entry->name, command) != 0 &&
341: (entry->alias == NULL ||
342: strcmp(entry->alias, command) != 0)))
343: continue;
1.35 nicm 344:
345: format_add(ft, "command_list_name", "%s", entry->name);
1.40 nicm 346: if (entry->alias != NULL)
347: s = entry->alias;
348: else
349: s = "";
350: format_add(ft, "command_list_alias", "%s", s);
351: if (entry->usage != NULL)
352: s = entry->usage;
353: else
354: s = "";
355: format_add(ft, "command_list_usage", "%s", s);
1.35 nicm 356:
357: line = format_expand(ft, template);
358: if (*line != '\0')
1.40 nicm 359: cmdq_print(item, "%s", line);
1.35 nicm 360: free(line);
1.1 nicm 361: }
362:
1.35 nicm 363: format_free(ft);
1.18 nicm 364: return (CMD_RETURN_NORMAL);
1.1 nicm 365: }