Contents in 1999-06-04-13 of release-21-2.
[chise/xemacs-chise.git.1] / src / keymap.h
1 /* prototypes for keymap-hacking
2    Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
3
4 This file is part of XEmacs.
5
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING.  If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
20
21 /* Synched up with: Not in FSF. */
22
23
24 #ifndef _XEMACS_KEYMAP_H_
25 #define _XEMACS_KEYMAP_H_
26
27 DECLARE_LRECORD (keymap, struct Lisp_Keymap);
28 #define XKEYMAP(x) XRECORD (x, keymap, struct Lisp_Keymap)
29 #define XSETKEYMAP(x, p) XSETRECORD (x, p, keymap)
30 #define KEYMAPP(x) RECORDP (x, keymap)
31 #define GC_KEYMAPP(x) GC_RECORDP (x, keymap)
32 #define CHECK_KEYMAP(x) CHECK_RECORD (x, keymap)
33 #define CONCHECK_KEYMAP(x) CONCHECK_RECORD (x, keymap)
34
35 EXFUN (Fkeymap_prompt, 2);
36 EXFUN (Fkeymapp, 1);
37 EXFUN (Fmake_keymap, 1);
38 EXFUN (Fwhere_is_internal, 5);
39
40 extern Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qshift, Qsuper;
41 extern Lisp_Object Vmeta_prefix_char;
42
43 Lisp_Object get_keymap (Lisp_Object object, int errorp, int autoload);
44 Lisp_Object event_binding (Lisp_Object event0, int accept_default);
45 Lisp_Object event_binding_in (Lisp_Object event0, Lisp_Object keymap,
46                               int accept_default);
47
48 Lisp_Object munging_key_map_event_binding (Lisp_Object event0,
49                                            enum munge_me_out_the_door munge);
50 int relevant_keymaps_to_search (Lisp_Object keys,
51                                 int max_maps, Lisp_Object maps[]);
52 void describe_map_tree (Lisp_Object startmap, int partial,
53                         Lisp_Object shadow, Lisp_Object prefix,
54                         int mice_only_p, Lisp_Object buffer);
55
56 void key_desc_list_to_event (Lisp_Object list, Lisp_Object event,
57                              int allow_menu_events);
58
59 int event_matches_key_specifier_p (struct Lisp_Event *event,
60                                    Lisp_Object key_specifier);
61
62 #endif /* _XEMACS_KEYMAP_H_ */