source: keymap.c @ e4524da

release-1.10release-1.8release-1.9
Last change on this file since e4524da was e4d7cb6, checked in by David Benjamin <davidben@mit.edu>, 13 years ago
Replace owl_keymap's list with a GPtrArray
  • Property mode set to 100644
File size: 8.9 KB
RevLine 
[7d4fbcd]1#include <string.h>
2#include "owl.h"
3
[13ebf92]4static void _owl_keymap_format_bindings(const owl_keymap *km, owl_fmtext *fm);
[44cc9ab]5static void _owl_keymap_format_with_parents(const owl_keymap *km, owl_fmtext *fm);
[13ebf92]6
[7d4fbcd]7/* returns 0 on success */
[e19eb97]8int owl_keymap_init(owl_keymap *km, const char *name, const char *desc, void (*default_fn)(owl_input), void (*prealways_fn)(owl_input), void (*postalways_fn)(owl_input))
[cf83b7a]9{
[7d4fbcd]10  if (!name || !desc) return(-1);
[fda61d3]11  km->name = g_strdup(name);
12  km->desc = g_strdup(desc);
[e4d7cb6]13  km->bindings = g_ptr_array_new();
[44cc9ab]14  km->parent = NULL;
[7d4fbcd]15  km->default_fn = default_fn;
16  km->prealways_fn = prealways_fn;
17  km->postalways_fn = postalways_fn;
18  return(0);
19}
20
21/* note that this will free the memory for the bindings! */
[0bdb3a6]22void owl_keymap_cleanup(owl_keymap *km)
[cf83b7a]23{
[ddbbcffa]24  g_free(km->name);
25  g_free(km->desc);
[e4d7cb6]26  g_ptr_array_foreach(km->bindings, (GFunc)owl_keybinding_delete, NULL);
27  g_ptr_array_free(km->bindings, true);
[7d4fbcd]28}
29
[44cc9ab]30void owl_keymap_set_parent(owl_keymap *km, const owl_keymap *parent)
[cf83b7a]31{
[44cc9ab]32  km->parent = parent;
[7d4fbcd]33}
34
35/* creates and adds a key binding */
[e19eb97]36int owl_keymap_create_binding(owl_keymap *km, const char *keyseq, const char *command, void (*function_fn)(void), const char *desc)
[cf83b7a]37{
[e4d7cb6]38  owl_keybinding *kb;
[7d4fbcd]39  int i;
40
[b13daa0]41  kb = owl_keybinding_new(keyseq, command, function_fn, desc);
42  if (kb == NULL)
43    return -1;
[7d4fbcd]44  /* see if another matching binding, and if so remove it.
45   * otherwise just add this one.
46   */
[e4d7cb6]47  for (i = km->bindings->len-1; i >= 0; i--) {
48    if (owl_keybinding_equal(km->bindings->pdata[i], kb)) {
49      owl_keybinding_delete(g_ptr_array_remove_index(km->bindings, i));
[7d4fbcd]50    }
51  }
[e4d7cb6]52  g_ptr_array_add(km->bindings, kb);
[d427f08]53  return 0;
[7d4fbcd]54}
55
[8a921b5]56/* removes the binding associated with the keymap */
57int owl_keymap_remove_binding(owl_keymap *km, const char *keyseq)
58{
[e4d7cb6]59  owl_keybinding *kb;
[8a921b5]60  int i;
61
[b13daa0]62  kb = owl_keybinding_new(keyseq, NULL, NULL, NULL);
63  if (kb == NULL)
64    return -1;
[8a921b5]65
[e4d7cb6]66  for (i = km->bindings->len-1; i >= 0; i--) {
67    if (owl_keybinding_equal(km->bindings->pdata[i], kb)) {
68      owl_keybinding_delete(g_ptr_array_remove_index(km->bindings, i));
[b13daa0]69      owl_keybinding_delete(kb);
[8a921b5]70      return(0);
71    }
72  }
[b13daa0]73  owl_keybinding_delete(kb);
[8a921b5]74  return(-2);
75}
76
77
[7d4fbcd]78/* returns a summary line describing this keymap.  the caller must free. */
[6829afc]79CALLER_OWN char *owl_keymap_summary(const owl_keymap *km)
[cf83b7a]80{
[7d4fbcd]81  if (!km || !km->name || !km->desc) return NULL;
[3472845]82  return g_strdup_printf("%-15s - %s", km->name, km->desc);
[7d4fbcd]83}
84
85/* Appends details about the keymap to fm */
[13ebf92]86void owl_keymap_get_details(const owl_keymap *km, owl_fmtext *fm, int recurse)
[cf83b7a]87{
[7d4fbcd]88  owl_fmtext_append_bold(fm, "KEYMAP - ");
89  owl_fmtext_append_bold(fm, km->name);
90  owl_fmtext_append_normal(fm, "\n");
91  if (km->desc) {
92    owl_fmtext_append_normal(fm, OWL_TABSTR "Purpose:    ");
93    owl_fmtext_append_normal(fm, km->desc);
94    owl_fmtext_append_normal(fm, "\n");
95  }
[44cc9ab]96  if (km->parent) {
97    owl_fmtext_append_normal(fm, OWL_TABSTR "Has parent: ");
98    owl_fmtext_append_normal(fm, km->parent->name);
[7d4fbcd]99    owl_fmtext_append_normal(fm, "\n");
100  }
101    owl_fmtext_append_normal(fm, "\n");
102  if (km->default_fn) {
103    owl_fmtext_append_normal(fm, OWL_TABSTR
104     "Has a default keypress handler (default_fn).\n");
105  }
106  if (km->prealways_fn) {
107    owl_fmtext_append_normal(fm, OWL_TABSTR
108     "Executes a function (prealways_fn) on every keypress.\n");
109  }
110  if (km->postalways_fn) {
111    owl_fmtext_append_normal(fm, OWL_TABSTR
112     "Executes a function (postalways_fn) after handling every keypress.\n");
113  }
114
115  owl_fmtext_append_bold(fm, "\nKey bindings:\n\n"); 
[13ebf92]116  if (recurse) {
[44cc9ab]117    _owl_keymap_format_with_parents(km, fm);
[13ebf92]118  } else {
119    _owl_keymap_format_bindings(km, fm);
120  }
121}
122
[44cc9ab]123static void _owl_keymap_format_with_parents(const owl_keymap *km, owl_fmtext *fm)
[13ebf92]124{
125  while (km) {
126    _owl_keymap_format_bindings(km, fm);
[44cc9ab]127    km = km->parent;
[13ebf92]128    if (km) {
129      owl_fmtext_append_bold(fm, "\nInherited from ");
130      owl_fmtext_append_bold(fm, km->name);
131      owl_fmtext_append_bold(fm, ":\n\n");
132    }
133  }
134}
135
136static void _owl_keymap_format_bindings(const owl_keymap *km, owl_fmtext *fm)
137{
[e4d7cb6]138  int i;
[13ebf92]139  const owl_keybinding *kb;
140 
[e4d7cb6]141  for (i = 0; i < km->bindings->len; i++) {
[45e2c95]142    char *kbstr;
[0a0fb74]143    const owl_cmd *cmd;
[e19eb97]144    const char *tmpdesc, *desc = "";
[7d4fbcd]145
[e4d7cb6]146    kb = km->bindings->pdata[i];
[45e2c95]147    kbstr = owl_keybinding_tostring(kb);
[7d4fbcd]148    owl_fmtext_append_normal(fm, OWL_TABSTR);
[45e2c95]149    owl_fmtext_append_normal(fm, kbstr);
150    owl_fmtext_append_spaces(fm, 11-strlen(kbstr));
151    g_free(kbstr);
[7d4fbcd]152    owl_fmtext_append_normal(fm, " - ");
153    if (kb->desc && *kb->desc) {
154      desc = kb->desc;
155    } else if ((cmd=owl_function_get_cmd(kb->command))
156               && (tmpdesc = owl_cmd_get_summary(cmd))) {
157      desc = tmpdesc;
158    }
159    owl_fmtext_append_normal(fm, desc);
160    if (kb->command && *(kb->command)) {
161      owl_fmtext_append_normal(fm, "   [");
162      owl_fmtext_append_normal(fm, kb->command);
163      owl_fmtext_append_normal(fm, "]");
164    } 
165    owl_fmtext_append_normal(fm, "\n");
166  }
167}
168
169
170
171/***********************************************************************/
172/***************************** KEYHANDLER ******************************/
173/***********************************************************************/
174
175/* NOTE: keyhandler has private access to the internals of keymap */
176
[4c7c21f]177void owl_keyhandler_init(owl_keyhandler *kh)
[cf83b7a]178{
[4c7c21f]179  owl_dict_create(&kh->keymaps);
[7d4fbcd]180  kh->active = NULL;
181  owl_keyhandler_reset(kh);
182}
183
184/* adds a new keymap */
[cf83b7a]185void owl_keyhandler_add_keymap(owl_keyhandler *kh, owl_keymap *km)
186{
[7d4fbcd]187  owl_dict_insert_element(&kh->keymaps, km->name, km, NULL);
188}
189
[e19eb97]190owl_keymap *owl_keyhandler_create_and_add_keymap(owl_keyhandler *kh, const char *name, const char *desc, void (*default_fn)(owl_input), void (*prealways_fn)(owl_input), void (*postalways_fn)(owl_input))
[cf83b7a]191{
[7d4fbcd]192  owl_keymap *km;
[96828e4]193  km = g_new(owl_keymap, 1);
[7d4fbcd]194  owl_keymap_init(km, name, desc, default_fn, prealways_fn, postalways_fn);
195  owl_keyhandler_add_keymap(kh, km);
196  return km;
197}
198
199/* resets state and clears out key stack */
[cf83b7a]200void owl_keyhandler_reset(owl_keyhandler *kh)
201{
[7d4fbcd]202  kh->in_esc = 0;
203  memset(kh->kpstack, 0, (OWL_KEYMAP_MAXSTACK+1)*sizeof(int));
204  kh->kpstackpos = -1;
205}
206
[12bc46a]207owl_keymap *owl_keyhandler_get_keymap(const owl_keyhandler *kh, const char *mapname)
[cf83b7a]208{
[4d86e06]209  return owl_dict_find_element(&kh->keymaps, mapname);
[7d4fbcd]210}
211
[12bc46a]212void owl_keyhandler_get_keymap_names(const owl_keyhandler *kh, owl_list *l)
[cf83b7a]213{
[7d4fbcd]214  owl_dict_get_keys(&kh->keymaps, l);
215}
216
217
218/* sets the active keymap, which will also reset any key state.
219 * returns the new keymap, or NULL on failure. */
[afa200a]220const owl_keymap *owl_keyhandler_activate(owl_keyhandler *kh, const char *mapname)
[cf83b7a]221{
[afa200a]222  const owl_keymap *km;
[7d4fbcd]223  if (kh->active && !strcmp(mapname, kh->active->name)) return(kh->active);
[4d86e06]224  km = owl_dict_find_element(&kh->keymaps, mapname);
[7d4fbcd]225  if (!km) return(NULL);
226  owl_keyhandler_reset(kh);
227  kh->active = km;
228  return(km);
229}
230
231/* processes a keypress.  returns 0 if the keypress was handled,
232 * 1 if not handled, -1 on error, and -2 if j==ERR. */
[428834d]233int owl_keyhandler_process(owl_keyhandler *kh, owl_input j)
[cf83b7a]234{
[afa200a]235  const owl_keymap     *km;
[f1d7d0f]236  const owl_keybinding *kb;
[7d4fbcd]237  int i, match;
238
239  if (!kh->active) {
240    owl_function_makemsg("No active keymap!!!");
241    return(-1);
242  }
[7131cf2]243
[7d4fbcd]244  /* deal with ESC prefixing */
[428834d]245  if (!kh->in_esc && j.ch == 27) {
[7d4fbcd]246    kh->in_esc = 1;
247    return(0);
248  }
249  if (kh->in_esc) {
[428834d]250    j.ch = OWL_META(j.ch);
[7d4fbcd]251    kh->in_esc = 0;
252  }
253 
[428834d]254  kh->kpstack[++(kh->kpstackpos)] = j.ch;
[7d4fbcd]255  if (kh->kpstackpos >= OWL_KEYMAP_MAXSTACK) {
256    owl_keyhandler_reset(kh);
257    owl_function_makemsg("Too many prefix keys pressed...");
258    return(-1);
259  }
260
[44cc9ab]261  /* deal with the always_fn for the map and parents */
262  for (km=kh->active; km; km=km->parent) {
[7d4fbcd]263    if (km->prealways_fn) {
264      km->prealways_fn(j);
265    }
266  }
267
268  /* search for a match.  goes through active keymap and then
[44cc9ab]269   * through parents... TODO:  clean this up so we can pull
[7d4fbcd]270   * keyhandler and keymap apart.  */
[44cc9ab]271  for (km=kh->active; km; km=km->parent) {
[e4d7cb6]272    for (i = km->bindings->len-1; i >= 0; i--) {
273      kb = km->bindings->pdata[i];
[e1b136bf]274      match = owl_keybinding_match(kb, kh);
[7d4fbcd]275      if (match == 1) {         /* subset match */
[10b866d]276
277        /* owl_function_debugmsg("processkey: found subset match in %s", km->name); */
[7d4fbcd]278        return(0);
279      } else if (match == 2) {  /* exact match */
[10b866d]280        /* owl_function_debugmsg("processkey: found exact match in %s", km->name); */
[428834d]281        owl_keybinding_execute(kb, j.ch);
[7d4fbcd]282        owl_keyhandler_reset(kh);
283        if (km->postalways_fn) {
284          km->postalways_fn(j);
285        }
286        return(0);
287      }
288    }
289  }
290
291  /* see if a default action exists for the active keymap */
292  if (kh->active->default_fn && kh->kpstackpos<1) {
[10b866d]293    /*owl_function_debugmsg("processkey: executing default_fn");*/
294
[7d4fbcd]295    kh->active->default_fn(j);
296    owl_keyhandler_reset(kh);
297    if (kh->active->postalways_fn) {
298      kh->active->postalways_fn(j);
299    }
300    return(0);
301  }
302
303  owl_keyhandler_invalidkey(kh);
304  /* unable to handle */
305  return(1); 
306}
307
[cf83b7a]308void owl_keyhandler_invalidkey(owl_keyhandler *kh)
309{
[45e2c95]310    char *kbbuff = owl_keybinding_stack_tostring(kh->kpstack, kh->kpstackpos+1);
[7d4fbcd]311    owl_function_makemsg("'%s' is not a valid key in this context.", kbbuff);
[45e2c95]312    g_free(kbbuff);
[7d4fbcd]313    owl_keyhandler_reset(kh);
314}
Note: See TracBrowser for help on using the repository browser.