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#else
34# include <readline/rlstdc.h>
35# include <readline/chardefs.h>
36#endif
37
38#if !defined (_FUNCTION_DEF)
39# define _FUNCTION_DEF
40typedef int Function ();
41typedef void VFunction ();
42typedef char *CPFunction ();
43typedef char **CPPFunction ();
44#endif
45
46/* A keymap contains one entry for each key in the ASCII set.
47 Each entry consists of a type and a pointer.
48 FUNCTION is the address of a function to run, or the
49 address of a keymap to indirect through.
50 TYPE says which kind of thing FUNCTION is. */
51typedef struct _keymap_entry {
52 char type;
53 Function *function;
54} KEYMAP_ENTRY;
55
56/* This must be large enough to hold bindings for all of the characters
57 in a desired character set (e.g, 128 for ASCII, 256 for ISO Latin-x,
58 and so on). */
59#define KEYMAP_SIZE 256
60
61/* I wanted to make the above structure contain a union of:
62 union { Function *function; struct _keymap_entry *keymap; } value;
63 but this made it impossible for me to create a static array.
64 Maybe I need C lessons. */
65
66typedef KEYMAP_ENTRY KEYMAP_ENTRY_ARRAY[KEYMAP_SIZE];
67typedef KEYMAP_ENTRY *Keymap;
68
69/* The values that TYPE can have in a keymap entry. */
70#define ISFUNC 0
71#define ISKMAP 1
72#define ISMACR 2
73
74extern KEYMAP_ENTRY_ARRAY emacs_standard_keymap, emacs_meta_keymap, emacs_ctlx_keymap;
75extern KEYMAP_ENTRY_ARRAY vi_insertion_keymap, vi_movement_keymap;
76
77/* Return a new, empty keymap.
78 Free it with free() when you are done. */
79extern Keymap rl_make_bare_keymap __P((void));
80
81/* Return a new keymap which is a copy of MAP. */
82extern Keymap rl_copy_keymap __P((Keymap));
83
84/* Return a new keymap with the printing characters bound to rl_insert,
85 the lowercase Meta characters bound to run their equivalents, and
86 the Meta digits bound to produce numeric arguments. */
87extern Keymap rl_make_keymap __P((void));
88
89/* Free the storage associated with a keymap. */
90extern void rl_discard_keymap __P((Keymap));
91
92/* These functions actually appear in bind.c */
93
94/* Return the keymap corresponding to a given name. Names look like
95 `emacs' or `emacs-meta' or `vi-insert'. */
96extern Keymap rl_get_keymap_by_name __P((char *));
97
98/* Return the current keymap. */
99extern Keymap rl_get_keymap __P((void));
100
101/* Set the current keymap to MAP. */
102extern void rl_set_keymap __P((Keymap));
103
104#ifdef __cplusplus
105}
106#endif
107
108#endif /* _KEYMAPS_H_ */