Annotation of src/usr.bin/tmux/cmd-list-keys.c, Revision 1.58
1.58 ! nicm 1: /* $OpenBSD: cmd-list-keys.c,v 1.57 2020/05/16 15:54:20 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.51 nicm 39: .args = { "1aNP:T:", 0, 1 },
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.52 nicm 50: .args = { "F:", 0, 1 },
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: }
76: width = utf8_cstrwidth(key_string_lookup_key(bd->key));
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;
109: key = key_string_lookup_key(bd->key);
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.56 nicm 116: if (args_has(args, '1') && tc != NULL)
1.57 nicm 117: status_message_set(tc, 1, "%s%s%s", prefix, tmp, note);
1.50 nicm 118: else
1.51 nicm 119: cmdq_print(item, "%s%s%s", prefix, tmp, note);
1.50 nicm 120: free(tmp);
1.51 nicm 121: free(note);
1.50 nicm 122:
123: if (args_has(args, '1'))
124: break;
125: bd = key_bindings_next(table, bd);
126: }
127: return (found);
128: }
129:
130: static char *
131: cmd_list_keys_get_prefix(struct args *args, key_code *prefix)
132: {
133: char *s;
134:
135: *prefix = options_get_number(global_s_options, "prefix");
136: if (!args_has(args, 'P')) {
137: if (*prefix != KEYC_NONE)
138: xasprintf(&s, "%s ", key_string_lookup_key(*prefix));
139: else
140: s = xstrdup("");
141: } else
142: s = xstrdup(args_get(args, 'P'));
143: return (s);
144: }
145:
1.35 nicm 146: static enum cmd_retval
1.40 nicm 147: cmd_list_keys_exec(struct cmd *self, struct cmdq_item *item)
1.1 nicm 148: {
1.54 nicm 149: struct args *args = cmd_get_args(self);
1.26 nicm 150: struct key_table *table;
1.1 nicm 151: struct key_binding *bd;
1.46 nicm 152: const char *tablename, *r;
1.50 nicm 153: char *key, *cp, *tmp, *start, *empty;
154: key_code prefix, only = KEYC_UNKNOWN;
155: int repeat, width, tablewidth, keywidth, found = 0;
1.48 nicm 156: size_t tmpsize, tmpused, cplen;
1.3 nicm 157:
1.54 nicm 158: if (cmd_get_entry(self) == &cmd_list_commands_entry)
1.40 nicm 159: return (cmd_list_keys_commands(self, item));
1.24 nicm 160:
1.50 nicm 161: if (args->argc != 0) {
162: only = key_string_lookup_string(args->argv[0]);
163: if (only == KEYC_UNKNOWN) {
164: cmdq_error(item, "invalid key: %s", args->argv[0]);
165: return (CMD_RETURN_ERROR);
166: }
167: }
168:
1.26 nicm 169: tablename = args_get(args, 'T');
170: if (tablename != NULL && key_bindings_get_table(tablename, 0) == NULL) {
1.40 nicm 171: cmdq_error(item, "table %s doesn't exist", tablename);
1.26 nicm 172: return (CMD_RETURN_ERROR);
173: }
1.15 nicm 174:
1.50 nicm 175: if (args_has(args, 'N')) {
176: if (tablename == NULL) {
177: start = cmd_list_keys_get_prefix(args, &prefix);
178: keywidth = cmd_list_keys_get_width("root", only);
179: if (prefix != KEYC_NONE) {
180: width = cmd_list_keys_get_width("prefix", only);
181: if (width == 0)
182: prefix = KEYC_NONE;
183: else if (width > keywidth)
184: keywidth = width;
185: }
186: empty = utf8_padcstr("", utf8_cstrwidth(start));
187:
188: found = cmd_list_keys_print_notes(item, args, "root",
189: keywidth, only, empty);
190: if (prefix != KEYC_NONE) {
191: if (cmd_list_keys_print_notes(item, args,
192: "prefix", keywidth, only, start))
193: found = 1;
194: }
195: free(empty);
196: } else {
197: if (args_has(args, 'P'))
198: start = xstrdup(args_get(args, 'P'));
199: else
200: start = xstrdup("");
201: keywidth = cmd_list_keys_get_width(tablename, only);
202: found = cmd_list_keys_print_notes(item, args, tablename,
203: keywidth, only, start);
204:
205: }
206: free(start);
207: goto out;
208: }
209:
1.26 nicm 210: repeat = 0;
211: tablewidth = keywidth = 0;
1.45 nicm 212: table = key_bindings_first_table ();
213: while (table != NULL) {
214: if (tablename != NULL && strcmp(table->name, tablename) != 0) {
215: table = key_bindings_next_table(table);
1.3 nicm 216: continue;
1.45 nicm 217: }
218: bd = key_bindings_first(table);
219: while (bd != NULL) {
1.50 nicm 220: if (only != KEYC_UNKNOWN && bd->key != only) {
221: bd = key_bindings_next(table, bd);
222: continue;
223: }
1.46 nicm 224: key = args_escape(key_string_lookup_key(bd->key));
1.3 nicm 225:
1.43 nicm 226: if (bd->flags & KEY_BINDING_REPEAT)
1.26 nicm 227: repeat = 1;
228:
1.29 nicm 229: width = utf8_cstrwidth(table->name);
1.26 nicm 230: if (width > tablewidth)
1.28 nicm 231: tablewidth = width;
232: width = utf8_cstrwidth(key);
1.26 nicm 233: if (width > keywidth)
234: keywidth = width;
1.45 nicm 235:
1.46 nicm 236: free(key);
1.45 nicm 237: bd = key_bindings_next(table, bd);
1.26 nicm 238: }
1.45 nicm 239: table = key_bindings_next_table(table);
1.3 nicm 240: }
241:
1.48 nicm 242: tmpsize = 256;
243: tmp = xmalloc(tmpsize);
244:
1.45 nicm 245: table = key_bindings_first_table ();
246: while (table != NULL) {
247: if (tablename != NULL && strcmp(table->name, tablename) != 0) {
248: table = key_bindings_next_table(table);
1.1 nicm 249: continue;
1.45 nicm 250: }
251: bd = key_bindings_first(table);
252: while (bd != NULL) {
1.50 nicm 253: if (only != KEYC_UNKNOWN && bd->key != only) {
254: bd = key_bindings_next(table, bd);
255: continue;
256: }
257: found = 1;
1.46 nicm 258: key = args_escape(key_string_lookup_key(bd->key));
1.26 nicm 259:
260: if (!repeat)
261: r = "";
1.43 nicm 262: else if (bd->flags & KEY_BINDING_REPEAT)
1.26 nicm 263: r = "-r ";
1.14 nicm 264: else
1.26 nicm 265: r = " ";
1.48 nicm 266: tmpused = xsnprintf(tmp, tmpsize, "%s-T ", r);
1.29 nicm 267:
268: cp = utf8_padcstr(table->name, tablewidth);
1.48 nicm 269: cplen = strlen(cp) + 1;
1.49 nicm 270: while (tmpused + cplen + 1 >= tmpsize) {
1.48 nicm 271: tmpsize *= 2;
272: tmp = xrealloc(tmp, tmpsize);
273: }
1.53 nicm 274: strlcat(tmp, cp, tmpsize);
1.48 nicm 275: tmpused = strlcat(tmp, " ", tmpsize);
1.29 nicm 276: free(cp);
277:
278: cp = utf8_padcstr(key, keywidth);
1.48 nicm 279: cplen = strlen(cp) + 1;
280: while (tmpused + cplen + 1 >= tmpsize) {
281: tmpsize *= 2;
282: tmp = xrealloc(tmp, tmpsize);
283: }
1.53 nicm 284: strlcat(tmp, cp, tmpsize);
1.48 nicm 285: tmpused = strlcat(tmp, " ", tmpsize);
1.29 nicm 286: free(cp);
287:
1.46 nicm 288: cp = cmd_list_print(bd->cmdlist, 1);
1.48 nicm 289: cplen = strlen(cp);
290: while (tmpused + cplen + 1 >= tmpsize) {
291: tmpsize *= 2;
292: tmp = xrealloc(tmp, tmpsize);
293: }
294: strlcat(tmp, cp, tmpsize);
1.31 nicm 295: free(cp);
1.1 nicm 296:
1.40 nicm 297: cmdq_print(item, "bind-key %s", tmp);
1.46 nicm 298:
299: free(key);
1.45 nicm 300: bd = key_bindings_next(table, bd);
1.14 nicm 301: }
1.45 nicm 302: table = key_bindings_next_table(table);
1.24 nicm 303: }
1.48 nicm 304:
305: free(tmp);
1.24 nicm 306:
1.50 nicm 307: out:
308: if (only != KEYC_UNKNOWN && !found) {
309: cmdq_error(item, "unknown key: %s", args->argv[0]);
310: return (CMD_RETURN_ERROR);
311: }
1.24 nicm 312: return (CMD_RETURN_NORMAL);
313: }
314:
1.35 nicm 315: static enum cmd_retval
1.40 nicm 316: cmd_list_keys_commands(struct cmd *self, struct cmdq_item *item)
1.24 nicm 317: {
1.54 nicm 318: struct args *args = cmd_get_args(self);
1.24 nicm 319: const struct cmd_entry **entryp;
1.25 nicm 320: const struct cmd_entry *entry;
1.35 nicm 321: struct format_tree *ft;
1.52 nicm 322: const char *template, *s, *command = NULL;
1.35 nicm 323: char *line;
324:
1.52 nicm 325: if (args->argc != 0)
326: command = args->argv[0];
327:
1.35 nicm 328: if ((template = args_get(args, 'F')) == NULL) {
329: template = "#{command_list_name}"
330: "#{?command_list_alias, (#{command_list_alias}),} "
331: "#{command_list_usage}";
332: }
333:
1.55 nicm 334: ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);
1.35 nicm 335: format_defaults(ft, NULL, NULL, NULL, NULL);
1.24 nicm 336:
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: }