BindKey——实现可自定义的快捷键

用过Emacs的人都知道，其快捷键有多么强大，利用组合键C-x C-w，你可以将buffer内容另存为一个新的文件。那么程序是如何响应用户输入的快捷键呢？又如在Linux的Shell环境中，CTRL+R可以查找以前使用过的历史命令，这是由readline库来实现的。下面实现的这个代码，允许将一个函数绑定到一串字符串，如果命中了该字符串，则调用绑定的接口函数。

 

目前的实现，是使用树来管理所有的快捷键路径，每个节点都可以绑定一个函数，但我们应该遵循最长命令的原则，即如果A-B是一个快捷键，A-B-C也是一个快捷键，那么当输入A-B时需要等待用户下一个输入，如果没有输入，或者输入非C，则调用A-B快捷方式；否则调用A-B-C快捷方式。还有以下两个问题没有很好地解决，一个是，在用户输入A-B后，如何判断用户没有后续的输入了？一个是，如果A和A-B都是快捷键，如果用户连续输入两个A，应该怎么调用快捷键A?

例如对于下面五个快捷键， 

AXH, AXE, AXEH, ABXH, ACXH

我们将会生成一棵如下的多分枝树：

/->C->X->H*

|

A->X->H*

|   |

|   /->E*->H*

/->B->X->H*

我们知道，ESC键的ASCII值为0x1b, 而方向键和F1-F12功能键的序列值也是以0x1b开始的，那么如何区别用户键入的是ESC键还是方向键呢？

下面开始粘贴分析代码。

首先是数据结构，如果有不清楚的，请看详细注释。

#include <stdio.h> #include <stdlib.h> #include <ctype.h> #include <string.h> #include <stdint.h> typedef void *bind_func_t(void *data); typedef struct wdm_bind_st { char *shortcuts; bind_func_t *bind_func; char *description; } wdm_bind_t; typedef struct wdm_knode_st { char key; uint32_t children_num; /* at most up to 256 children */ struct wdm_knode_st **children; bind_func_t *bind_func; /* if not NULL, we get a shortcuts. */ } wdm_knode_t; typedef struct wdm_keymap_st { uint32_t node_cnt; /* at most up to 256 nodes */ wdm_knode_t **nodes; } wdm_keymap_t; static wdm_keymap_t *keymaps = NULL; 

然后是初始化和销毁接口，提供了节点内存的申请和释放接口和整个keymap的初始化和销毁接口。

int wdm_knode_new(wdm_knode_t **knode, char key) { wdm_knode_t *new_knode; new_knode = malloc(sizeof(wdm_knode_t)); new_knode->key = key; new_knode->children_num = 0; new_knode->children = NULL; new_knode->bind_func = NULL; *knode = new_knode; return 0; } void wdm_knode_destroy(wdm_knode_t *knode) { int i; wdm_knode_t *child_knode; if (knode) { for (i=0; i<knode->children_num; i++) { child_knode = knode->children[i]; wdm_knode_destroy(child_knode); } free(knode->children); free(knode); } } int wdm_keymap_init(void) { keymaps = malloc(sizeof(wdm_keymap_t)); keymaps->node_cnt = 256; keymaps->nodes = malloc(256 * sizeof(wdm_knode_t *)); memset(keymaps->nodes, 0, 256 * sizeof(wdm_knode_t *)); return 0; } void wdm_keymap_fini(void) { int i; wdm_knode_t *knode; if (keymaps == NULL) return; for (i = 0; i < keymaps->node_cnt; i++) { knode = keymaps->nodes[i]; wdm_knode_destroy(knode); } free(keymaps->nodes); free(keymaps); } 

下面的接口函数可用来打印所有的快捷键路径。

void wdm_shortcuts_show(char *shortcuts) { char *pkey; for (pkey = shortcuts; *pkey; pkey++) { if (isprint(*pkey)) { printf("%c", *pkey); } else { printf("//%03o", *pkey); } } } void wdm_knode_trace(wdm_knode_t **path, uint32_t length) { int i; wdm_knode_t *knode; for (i=0; i<length; i++) { knode = path[i]; if (isprint(knode->key)) { printf("%c->", knode->key); } else { printf("//%03o->", knode->key); } if (knode->bind_func) { printf("%p/n", knode->bind_func); } } } void wdm_knode_dump(wdm_knode_t *knode, wdm_knode_t **path, uint32_t length) { int i; if (knode == NULL) return; path[length] = knode; length++; if (knode->children == NULL) { wdm_knode_trace(path, length); } else { for (i=0; i<knode->children_num; i++) { wdm_knode_dump(knode->children[i], path, length); } } } void wdm_keymap_dump(void) { int i; wdm_knode_t *knode; wdm_knode_t *path[1024]; if (keymaps == NULL) return; for (i=0; i<256; i++) { knode = keymaps->nodes[i]; if (knode) { wdm_knode_dump (knode, path, 0); } } } 

这个接口用来查找某个字符串是否绑定了快捷键，如果没有绑定， 则返回空指针。

bind_func_t *wdm_keymap_search(char * shortcuts) { int i; int found;; char *pkey; wdm_knode_t *knode, *child; if (shortcuts == NULL || keymaps == NULL) return NULL; pkey = shortcuts; knode = keymaps->nodes[(uint8_t)(*pkey)]; while (knode) { pkey++; if (*pkey == '/0') { return knode->bind_func; /* may be null */ } found = 0; for (i=0; i<knode->children_num; i++) { child = knode->children[i]; if (child->key == (*pkey)){ knode = child; found = 1; break; } } if (found == 0) return NULL; } return NULL; } 

下面是实现绑定的接口， 将快捷键分散到树的各个节点上：

int wdm_keymap_bind_internal(char * shortcuts, bind_func_t * bind_func, char *desc) { int i; int found;; char *pkey; wdm_knode_t *knode, *child; if (shortcuts == NULL || bind_func == NULL || keymaps == NULL) return -1; pkey = shortcuts; if (*pkey == '/0') return -1; knode = keymaps->nodes[(uint8_t)(*pkey)]; if (knode == NULL) { wdm_knode_new(&knode, *pkey); keymaps->nodes[(uint8_t)(*pkey)] = knode; } while (1) { pkey++; if (*pkey == '/0') { if (knode->bind_func) { printf("shortcuts "); wdm_shortcuts_show(shortcuts); printf(" has been bind to function %p/n", knode->bind_func); return -1; } knode->bind_func = bind_func; return 0; } else { found = 0; for (i=0; i<knode->children_num; i++) { child = knode->children[i]; if (child->key == *pkey) { knode = child; found = 1; break; } } if (!found) { wdm_knode_new(&child, *pkey); knode->children_num++; knode->children = realloc(knode->children, knode->children_num * sizeof(wdm_knode_t *)); knode->children[knode->children_num-1] = child; knode = child; } } } return 0; } int wdm_keymap_bind(wdm_bind_t *shortcuts) { int cnt; int ret; wdm_bind_t *cur; cnt = 0; for (cur=shortcuts; cur && cur->shortcuts; cur++) { ret = wdm_keymap_bind_internal(cur->shortcuts, cur->bind_func, cur->description); if (ret < 0) continue; cnt++; } return cnt; } 

以下为测试函数：

void *DEF_BIND_FUNC(void *data) { printf("you input a unbounded key/n"); fflush(NULL); return NULL; } void *UP_BIND_FUNC(void *data) { printf("you input up key/n"); fflush(NULL); return NULL; } void *RIGHT_BIND_FUNC(void *data) { printf("you input right key/n"); fflush(NULL); return NULL; } void *DOWN_BIND_FUNC(void *data) { printf("you input down key/n"); fflush(NULL); return NULL; } void *LEFT_BIND_FUNC(void *data) { printf("you input left key/n"); fflush(NULL); return NULL; } void *CTRL_C_BIND_FUNC(void *data) { printf("you input CTRL-C key/n"); fflush(NULL); return NULL; } void *CTRL_D_BIND_FUNC(void *data) { printf("you input CTRL-D key/n"); fflush(NULL); return NULL; } void *CTRL_L_BIND_FUNC(void *data) { printf("you input CTRL-L key/n"); fflush(NULL); return NULL; } void *BACKSPACE_BIND_FUNC(void *data) { printf("you input backspace key/n"); fflush(NULL); return NULL; } void *ESC_BIND_FUNC(void *data) { printf("you input ESC key/n"); fflush(NULL); return NULL; } static wdm_bind_t shortcuts[] = { {"/003", CTRL_C_BIND_FUNC, "when you press CTRL-C."}, {"/004", CTRL_D_BIND_FUNC, "when you press CTRL-D."}, {"/014", CTRL_L_BIND_FUNC, "when you press CTRL-L."}, {"/177", BACKSPACE_BIND_FUNC, "when you press BACKSPACE."}, {"/033", ESC_BIND_FUNC, "when you press ESC."}, {"/033[A", UP_BIND_FUNC, "when you press UP."}, {"/033[B", DOWN_BIND_FUNC, "when you press DOWN."}, {"/033[C", RIGHT_BIND_FUNC, "when you press RIGHT."}, {"/033[D", LEFT_BIND_FUNC, "when you press LEFT."}, {NULL, NULL, NULL}, }; int main(int argc, char *argv[]) { wdm_keymap_init(); wdm_keymap_bind(shortcuts); wdm_keymap_search("/003"); wdm_keymap_search("/033["); wdm_keymap_search("/033[C"); wdm_keymap_search("/033[F"); wdm_keymap_dump(); wdm_keymap_fini(); return 0; }  

另外，下面使用一个while循环来响应用户的输入，用来测试如何检查用户输入的每个字符是否被绑定到快捷键。

cur_knode = NULL; prev_valid_knode = NULL; while(1) { c = wdm_get_char(); next_knode = wdm_keymap_get_next(cur_knode, c); if (next_knode == NULL) { if (prev_valid_knode) { (*prev_valid_knode->bind_func)(NULL); ctrlmode = 0; newline = 1; fflush(stdin); break; } else { printf("%c", c); ctrlmode = 0; } } else if (next_knode->bind_func == NULL) { cur_knode = next_knode; } else if (next_knode->children == NULL) { (*next_knode->bind_func)(NULL); ctrlmode = 0; newline = 1; fflush(stdin); break; } else { prev_valid_knode = next_knode; cur_knode = next_knode; } }  

其中函数wdm_keymap_get_next()使用当前节点和当前用户输入的键值来获取下一个节点。

wdm_knode_t *wdm_keymap_get_next(wdm_knode_t *knode, char key) { int i; if (keymaps == NULL) return NULL; if (knode == NULL) return keymaps->nodes[(uint8_t)key]; if (knode->children == NULL) return NULL; for (i=0; i<knode->children_num; i++) { if (knode->children[i]->key == key) return knode->children[i]; } return NULL; }