1 /* $OpenBSD: cmd-list-keys.c,v 1.39 2016/10/14 22:14:22 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2007 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 /* 27 * List key bindings. 28 */ 29 30 static enum cmd_retval cmd_list_keys_exec(struct cmd *, struct cmd_q *); 31 32 static enum cmd_retval cmd_list_keys_table(struct cmd *, struct cmd_q *); 33 static enum cmd_retval cmd_list_keys_commands(struct cmd *, struct cmd_q *); 34 35 const struct cmd_entry cmd_list_keys_entry = { 36 .name = "list-keys", 37 .alias = "lsk", 38 39 .args = { "t:T:", 0, 0 }, 40 .usage = "[-t mode-table] [-T key-table]", 41 42 .flags = CMD_STARTSERVER|CMD_AFTERHOOK, 43 .exec = cmd_list_keys_exec 44 }; 45 46 const struct cmd_entry cmd_list_commands_entry = { 47 .name = "list-commands", 48 .alias = "lscm", 49 50 .args = { "F:", 0, 0 }, 51 .usage = "[-F format]", 52 53 .flags = CMD_STARTSERVER|CMD_AFTERHOOK, 54 .exec = cmd_list_keys_exec 55 }; 56 57 static enum cmd_retval 58 cmd_list_keys_exec(struct cmd *self, struct cmd_q *cmdq) 59 { 60 struct args *args = self->args; 61 struct key_table *table; 62 struct key_binding *bd; 63 const char *key, *tablename, *r; 64 char *cp, tmp[BUFSIZ]; 65 int repeat, width, tablewidth, keywidth; 66 67 if (self->entry == &cmd_list_commands_entry) 68 return (cmd_list_keys_commands(self, cmdq)); 69 70 if (args_has(args, 't')) 71 return (cmd_list_keys_table(self, cmdq)); 72 73 tablename = args_get(args, 'T'); 74 if (tablename != NULL && key_bindings_get_table(tablename, 0) == NULL) { 75 cmdq_error(cmdq, "table %s doesn't exist", tablename); 76 return (CMD_RETURN_ERROR); 77 } 78 79 repeat = 0; 80 tablewidth = keywidth = 0; 81 RB_FOREACH(table, key_tables, &key_tables) { 82 if (tablename != NULL && strcmp(table->name, tablename) != 0) 83 continue; 84 RB_FOREACH(bd, key_bindings, &table->key_bindings) { 85 key = key_string_lookup_key(bd->key); 86 87 if (bd->can_repeat) 88 repeat = 1; 89 90 width = utf8_cstrwidth(table->name); 91 if (width > tablewidth) 92 tablewidth = width; 93 width = utf8_cstrwidth(key); 94 if (width > keywidth) 95 keywidth = width; 96 } 97 } 98 99 RB_FOREACH(table, key_tables, &key_tables) { 100 if (tablename != NULL && strcmp(table->name, tablename) != 0) 101 continue; 102 RB_FOREACH(bd, key_bindings, &table->key_bindings) { 103 key = key_string_lookup_key(bd->key); 104 105 if (!repeat) 106 r = ""; 107 else if (bd->can_repeat) 108 r = "-r "; 109 else 110 r = " "; 111 xsnprintf(tmp, sizeof tmp, "%s-T ", r); 112 113 cp = utf8_padcstr(table->name, tablewidth); 114 strlcat(tmp, cp, sizeof tmp); 115 strlcat(tmp, " ", sizeof tmp); 116 free(cp); 117 118 cp = utf8_padcstr(key, keywidth); 119 strlcat(tmp, cp, sizeof tmp); 120 strlcat(tmp, " ", sizeof tmp); 121 free(cp); 122 123 cp = cmd_list_print(bd->cmdlist); 124 strlcat(tmp, cp, sizeof tmp); 125 free(cp); 126 127 cmdq_print(cmdq, "bind-key %s", tmp); 128 } 129 } 130 131 return (CMD_RETURN_NORMAL); 132 } 133 134 static enum cmd_retval 135 cmd_list_keys_table(struct cmd *self, struct cmd_q *cmdq) 136 { 137 struct args *args = self->args; 138 const char *tablename, *cmdstr; 139 const struct mode_key_table *mtab; 140 struct mode_key_binding *mbind; 141 int width, keywidth; 142 143 tablename = args_get(args, 't'); 144 if ((mtab = mode_key_findtable(tablename)) == NULL) { 145 cmdq_error(cmdq, "unknown key table: %s", tablename); 146 return (CMD_RETURN_ERROR); 147 } 148 149 keywidth = 0; 150 RB_FOREACH(mbind, mode_key_tree, mtab->tree) { 151 width = strlen(key_string_lookup_key(mbind->key)); 152 if (width > keywidth) 153 keywidth = width; 154 } 155 156 RB_FOREACH(mbind, mode_key_tree, mtab->tree) { 157 cmdstr = mode_key_tostring(mtab->cmdstr, mbind->cmd); 158 if (cmdstr != NULL) { 159 cmdq_print(cmdq, "bind-key -t %s %*s %s", 160 mtab->name, (int)keywidth, 161 key_string_lookup_key(mbind->key), cmdstr); 162 } 163 } 164 165 return (CMD_RETURN_NORMAL); 166 } 167 168 static enum cmd_retval 169 cmd_list_keys_commands(struct cmd *self, struct cmd_q *cmdq) 170 { 171 struct args *args = self->args; 172 const struct cmd_entry **entryp; 173 const struct cmd_entry *entry; 174 struct format_tree *ft; 175 const char *template; 176 char *line; 177 178 if ((template = args_get(args, 'F')) == NULL) { 179 template = "#{command_list_name}" 180 "#{?command_list_alias, (#{command_list_alias}),} " 181 "#{command_list_usage}"; 182 } 183 184 ft = format_create(cmdq, 0); 185 format_defaults(ft, NULL, NULL, NULL, NULL); 186 187 for (entryp = cmd_table; *entryp != NULL; entryp++) { 188 entry = *entryp; 189 190 format_add(ft, "command_list_name", "%s", entry->name); 191 if (entry->alias != NULL) { 192 format_add(ft, "command_list_alias", "%s", 193 entry->alias); 194 } 195 if (entry->alias != NULL) { 196 format_add(ft, "command_list_usage", "%s", 197 entry->usage); 198 } 199 200 line = format_expand(ft, template); 201 if (*line != '\0') 202 cmdq_print(cmdq, "%s", line); 203 free(line); 204 } 205 206 format_free(ft); 207 return (CMD_RETURN_NORMAL); 208 } 209