1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
|
/* Copyright (c) 2002,2003,2004,2009 James M. Kretchmar
*
* This file is part of Owl.
*
* Owl is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Owl is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Owl. If not, see <http://www.gnu.org/licenses/>.
*
* ---------------------------------------------------------------
*
* As of Owl version 2.1.12 there are patches contributed by
* developers of the branched BarnOwl project, Copyright (c)
* 2006-2009 The BarnOwl Developers. All rights reserved.
*/
#include <string.h>
#include "owl.h"
static const char fileIdent[] = "$Id: keymap.c,v 1.8 2009/03/29 12:38:21 kretch Exp $";
/* returns 0 on success */
int owl_keymap_init(owl_keymap *km, char *name, char *desc, void (*default_fn)(int), void (*prealways_fn)(int), void (*postalways_fn)(int))
{
if (!name || !desc) return(-1);
if ((km->name = owl_strdup(name)) == NULL) return(-1);
if ((km->desc = owl_strdup(desc)) == NULL) return(-1);
if (0 != owl_list_create(&km->bindings)) return(-1);
km->submap = NULL;
km->default_fn = default_fn;
km->prealways_fn = prealways_fn;
km->postalways_fn = postalways_fn;
return(0);
}
/* note that this will free the memory for the bindings! */
void owl_keymap_free(owl_keymap *km)
{
owl_free(km->name);
owl_free(km->desc);
owl_list_free_all(&km->bindings, (void(*)(void*))owl_keybinding_free_all);
}
void owl_keymap_set_submap(owl_keymap *km, owl_keymap *submap)
{
km->submap = submap;
}
/* creates and adds a key binding */
int owl_keymap_create_binding(owl_keymap *km, char *keyseq, char *command, void (*function_fn)(void), char *desc)
{
owl_keybinding *kb, *curkb;
int i;
if ((kb = owl_malloc(sizeof(owl_keybinding))) == NULL) return(-1);
if (0 != owl_keybinding_init(kb, keyseq, command, function_fn, desc)) {
owl_free(kb);
return(-1);
}
/* see if another matching binding, and if so remove it.
* otherwise just add this one.
*/
for (i = owl_list_get_size(&km->bindings)-1; i>=0; i--) {
curkb = (owl_keybinding*)owl_list_get_element(&km->bindings, i);
if (owl_keybinding_equal(curkb, kb)) {
owl_list_remove_element(&km->bindings, i);
owl_keybinding_free_all(curkb);
}
}
return owl_list_append_element(&km->bindings, kb);
}
/* returns a summary line describing this keymap. the caller must free. */
char *owl_keymap_summary(owl_keymap *km)
{
char *s;
int slen;
if (!km || !km->name || !km->desc) return NULL;
slen = strlen(km->name)+strlen(km->desc)+20;
s = owl_malloc(slen);
snprintf(s, slen-1, "%-15s - %s", km->name, km->desc);
return s;
}
/* Appends details about the keymap to fm */
void owl_keymap_get_details(owl_keymap *km, owl_fmtext *fm)
{
int i, nbindings;
owl_keybinding *kb;
owl_fmtext_append_bold(fm, "KEYMAP - ");
owl_fmtext_append_bold(fm, km->name);
owl_fmtext_append_normal(fm, "\n");
if (km->desc) {
owl_fmtext_append_normal(fm, OWL_TABSTR "Purpose: ");
owl_fmtext_append_normal(fm, km->desc);
owl_fmtext_append_normal(fm, "\n");
}
if (km->submap) {
owl_fmtext_append_normal(fm, OWL_TABSTR "Has submap: ");
owl_fmtext_append_normal(fm, km->submap->name);
owl_fmtext_append_normal(fm, "\n");
}
owl_fmtext_append_normal(fm, "\n");
if (km->default_fn) {
owl_fmtext_append_normal(fm, OWL_TABSTR
"Has a default keypress handler (default_fn).\n");
}
if (km->prealways_fn) {
owl_fmtext_append_normal(fm, OWL_TABSTR
"Executes a function (prealways_fn) on every keypress.\n");
}
if (km->postalways_fn) {
owl_fmtext_append_normal(fm, OWL_TABSTR
"Executes a function (postalways_fn) after handling every keypress.\n");
}
owl_fmtext_append_bold(fm, "\nKey bindings:\n\n");
nbindings = owl_list_get_size(&km->bindings);
for (i=0; i<nbindings; i++) {
char buff[100];
owl_cmd *cmd;
char *tmpdesc, *desc = "";
kb = owl_list_get_element(&km->bindings, i);
owl_keybinding_tostring(kb, buff, 100);
owl_fmtext_append_normal(fm, OWL_TABSTR);
owl_fmtext_append_normal(fm, buff);
owl_fmtext_append_spaces(fm, 11-strlen(buff));
owl_fmtext_append_normal(fm, " - ");
if (kb->desc && *kb->desc) {
desc = kb->desc;
} else if ((cmd=owl_function_get_cmd(kb->command))
&& (tmpdesc = owl_cmd_get_summary(cmd))) {
desc = tmpdesc;
}
owl_fmtext_append_normal(fm, desc);
if (kb->command && *(kb->command)) {
owl_fmtext_append_normal(fm, " [");
owl_fmtext_append_normal(fm, kb->command);
owl_fmtext_append_normal(fm, "]");
}
owl_fmtext_append_normal(fm, "\n");
}
}
/***********************************************************************/
/***************************** KEYHANDLER ******************************/
/***********************************************************************/
/* NOTE: keyhandler has private access to the internals of keymap */
int owl_keyhandler_init(owl_keyhandler *kh)
{
if (0 != owl_dict_create(&kh->keymaps)) return(-1);
kh->active = NULL;
owl_keyhandler_reset(kh);
return(0);
}
/* adds a new keymap */
void owl_keyhandler_add_keymap(owl_keyhandler *kh, owl_keymap *km)
{
owl_dict_insert_element(&kh->keymaps, km->name, km, NULL);
}
owl_keymap *owl_keyhandler_create_and_add_keymap(owl_keyhandler *kh, char *name, char *desc, void (*default_fn)(int), void (*prealways_fn)(int), void (*postalways_fn)(int))
{
owl_keymap *km;
km = (owl_keymap*)owl_malloc(sizeof(owl_keymap));
if (!km) return NULL;
owl_keymap_init(km, name, desc, default_fn, prealways_fn, postalways_fn);
owl_keyhandler_add_keymap(kh, km);
return km;
}
/* resets state and clears out key stack */
void owl_keyhandler_reset(owl_keyhandler *kh)
{
kh->in_esc = 0;
memset(kh->kpstack, 0, (OWL_KEYMAP_MAXSTACK+1)*sizeof(int));
kh->kpstackpos = -1;
}
owl_keymap *owl_keyhandler_get_keymap(owl_keyhandler *kh, char *mapname)
{
return (owl_keymap*)owl_dict_find_element(&kh->keymaps, mapname);
}
/* free the list with owl_cmddict_namelist_free */
void owl_keyhandler_get_keymap_names(owl_keyhandler *kh, owl_list *l)
{
owl_dict_get_keys(&kh->keymaps, l);
}
void owl_keyhandler_keymap_namelist_free(owl_list *l)
{
owl_list_free_all(l, owl_free);
}
/* sets the active keymap, which will also reset any key state.
* returns the new keymap, or NULL on failure. */
owl_keymap *owl_keyhandler_activate(owl_keyhandler *kh, char *mapname)
{
owl_keymap *km;
if (kh->active && !strcmp(mapname, kh->active->name)) return(kh->active);
km = (owl_keymap*)owl_dict_find_element(&kh->keymaps, mapname);
if (!km) return(NULL);
owl_keyhandler_reset(kh);
kh->active = km;
return(km);
}
/* processes a keypress. returns 0 if the keypress was handled,
* 1 if not handled, -1 on error, and -2 if j==ERR. */
int owl_keyhandler_process(owl_keyhandler *kh, int j)
{
owl_keymap *km;
owl_keybinding *kb;
int i, match;
if (!kh->active) {
owl_function_makemsg("No active keymap!!!");
return(-1);
}
/* temporarily disallow C-`/C-SPACE until we fix associated bugs */
if (j==ERR || j==0) {
return(-1);
}
/*
owl_function_debugmsg("processkey: got key %d, active keymap %s, stack at %d",
j, kh->active->name, kh->kpstackpos);
*/
/* deal with ESC prefixing */
if (!kh->in_esc && j==27) {
kh->in_esc = 1;
return(0);
}
if (kh->in_esc) {
j = OWL_META(j);
kh->in_esc = 0;
}
kh->kpstack[++(kh->kpstackpos)] = j;
if (kh->kpstackpos >= OWL_KEYMAP_MAXSTACK) {
owl_keyhandler_reset(kh);
owl_function_makemsg("Too many prefix keys pressed...");
return(-1);
}
/* deal with the always_fn for the map and submaps */
for (km=kh->active; km; km=km->submap) {
if (km->prealways_fn) {
km->prealways_fn(j);
}
}
/* search for a match. goes through active keymap and then
* through submaps... TODO: clean this up so we can pull
* keyhandler and keymap apart. */
for (km=kh->active; km; km=km->submap) {
for (i=owl_list_get_size(&km->bindings)-1; i>=0; i--) {
kb = (owl_keybinding*)owl_list_get_element(&km->bindings, i);
match = owl_keybinding_match(kb, kh->kpstack);
if (match == 1) { /* subset match */
/* owl_function_debugmsg("processkey: found subset match in %s", km->name); */
return(0);
} else if (match == 2) { /* exact match */
/* owl_function_debugmsg("processkey: found exact match in %s", km->name); */
owl_keybinding_execute(kb, j);
owl_keyhandler_reset(kh);
if (km->postalways_fn) {
km->postalways_fn(j);
}
return(0);
}
}
}
/* see if a default action exists for the active keymap */
if (kh->active->default_fn && kh->kpstackpos<1) {
/*owl_function_debugmsg("processkey: executing default_fn");*/
kh->active->default_fn(j);
owl_keyhandler_reset(kh);
if (kh->active->postalways_fn) {
kh->active->postalways_fn(j);
}
return(0);
}
owl_keyhandler_invalidkey(kh);
/* unable to handle */
return(1);
}
void owl_keyhandler_invalidkey(owl_keyhandler *kh)
{
char kbbuff[500];
owl_keybinding_stack_tostring(kh->kpstack, kbbuff, 500);
owl_function_makemsg("'%s' is not a valid key in this context.", kbbuff);
owl_keyhandler_reset(kh);
}
|