Reformatted.
[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 INCLUDED_keymap_h_
25 #define INCLUDED_keymap_h_
26
27 typedef struct Lisp_Keymap Lisp_Keymap;
28
29 DECLARE_LRECORD (keymap, Lisp_Keymap);
30 #define XKEYMAP(x) XRECORD (x, keymap, Lisp_Keymap)
31 #define XSETKEYMAP(x, p) XSETRECORD (x, p, keymap)
32 #define KEYMAPP(x) RECORDP (x, keymap)
33 #define CHECK_KEYMAP(x) CHECK_RECORD (x, keymap)
34 #define CONCHECK_KEYMAP(x) CONCHECK_RECORD (x, keymap)
35
36 EXFUN (Fkeymap_prompt, 2);
37 EXFUN (Fkeymapp, 1);
38 EXFUN (Fmake_keymap, 1);
39 EXFUN (Fwhere_is_internal, 5);
40
41 extern Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qshift, Qsuper;
42 extern Lisp_Object Qbutton1, Qbutton2, Qbutton3, Qbutton4, Qbutton5;
43 extern Lisp_Object Vmeta_prefix_char;
44
45 Lisp_Object get_keymap (Lisp_Object object, int errorp, int autoload);
46 Lisp_Object event_binding (Lisp_Object event0, int accept_default);
47 Lisp_Object event_binding_in (Lisp_Object event0, Lisp_Object keymap,
48                               int accept_default);
49
50 Lisp_Object munging_key_map_event_binding (Lisp_Object event0,
51                                            enum munge_me_out_the_door munge);
52 int relevant_keymaps_to_search (Lisp_Object keys,
53                                 int max_maps, Lisp_Object maps[]);
54 void describe_map_tree (Lisp_Object startmap, int partial,
55                         Lisp_Object shadow, Lisp_Object prefix,
56                         int mice_only_p, Lisp_Object buffer);
57
58 void key_desc_list_to_event (Lisp_Object list, Lisp_Object event,
59                              int allow_menu_events);
60
61 int event_matches_key_specifier_p (Lisp_Event *event,
62                                    Lisp_Object key_specifier);
63
64 #endif /* INCLUDED_keymap_h_ */