keymaps.h revision 75406
1/* keymaps.h -- Manipulation of readline keymaps. */ 2 3/* Copyright (C) 1987, 1989, 1992 Free Software Foundation, Inc. 4 5 This file is part of the GNU Readline Library, a library for 6 reading lines of text with interactive input and history editing. 7 8 The GNU Readline Library is free software; you can redistribute it 9 and/or modify it under the terms of the GNU General Public License 10 as published by the Free Software Foundation; either version 2, or 11 (at your option) any later version. 12 13 The GNU Readline Library is distributed in the hope that it will be 14 useful, but WITHOUT ANY WARRANTY; without even the implied warranty 15 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 GNU General Public License for more details. 17 18 The GNU General Public License is often shipped with GNU software, and 19 is generally kept in a file called COPYING or LICENSE. If you do not 20 have a copy of the license, write to the Free Software Foundation, 21 59 Temple Place, Suite 330, Boston, MA 02111 USA. */ 22 23#ifndef _KEYMAPS_H_ 24#define _KEYMAPS_H_ 25 26#ifdef __cplusplus 27extern "C" { 28#endif 29 30#if defined (READLINE_LIBRARY) 31# include "rlstdc.h" 32# include "chardefs.h" 33# include "rltypedefs.h" 34#else 35# include <readline/rlstdc.h> 36# include <readline/chardefs.h> 37# include <readline/rltypedefs.h> 38#endif 39 40/* A keymap contains one entry for each key in the ASCII set. 41 Each entry consists of a type and a pointer. 42 FUNCTION is the address of a function to run, or the 43 address of a keymap to indirect through. 44 TYPE says which kind of thing FUNCTION is. */ 45typedef struct _keymap_entry { 46 char type; 47 rl_command_func_t *function; 48} KEYMAP_ENTRY; 49 50/* This must be large enough to hold bindings for all of the characters 51 in a desired character set (e.g, 128 for ASCII, 256 for ISO Latin-x, 52 and so on). */ 53#define KEYMAP_SIZE 256 54 55/* I wanted to make the above structure contain a union of: 56 union { rl_command_func_t *function; struct _keymap_entry *keymap; } value; 57 but this made it impossible for me to create a static array. 58 Maybe I need C lessons. */ 59 60typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE]; 61typedef KEYMAP_ENTRY *Keymap; 62 63/* The values that TYPE can have in a keymap entry. */ 64#define ISFUNC 0 65#define ISKMAP 1 66#define ISMACR 2 67 68extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, emacs_meta_keymap, emacs_ctlx_keymap; 69extern KEYMAP_ENTRY_ARRAY vi_insertion_keymap, vi_movement_keymap; 70 71/* Return a new, empty keymap. 72 Free it with free() when you are done. */ 73extern Keymap rl_make_bare_keymap __P((void)); 74 75/* Return a new keymap which is a copy of MAP. */ 76extern Keymap rl_copy_keymap __P((Keymap)); 77 78/* Return a new keymap with the printing characters bound to rl_insert, 79 the lowercase Meta characters bound to run their equivalents, and 80 the Meta digits bound to produce numeric arguments. */ 81extern Keymap rl_make_keymap __P((void)); 82 83/* Free the storage associated with a keymap. */ 84extern void rl_discard_keymap __P((Keymap)); 85 86/* These functions actually appear in bind.c */ 87 88/* Return the keymap corresponding to a given name. Names look like 89 `emacs' or `emacs-meta' or `vi-insert'. */ 90extern Keymap rl_get_keymap_by_name __P((const char *)); 91 92/* Return the current keymap. */ 93extern Keymap rl_get_keymap __P((void)); 94 95/* Set the current keymap to MAP. */ 96extern void rl_set_keymap __P((Keymap)); 97 98#ifdef __cplusplus 99} 100#endif 101 102#endif /* _KEYMAPS_H_ */ 103