Mercurial > hg > xemacs-beta
annotate src/keymap.c @ 5402:308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
author | Mats Lidell <matsl@xemacs.org> |
---|---|
date | Thu, 14 Oct 2010 17:15:20 +0200 |
parents | 71ee43b8a74d |
children | 0af042a0c116 |
rev | line source |
---|---|
428 | 1 /* Manipulation of keymaps |
2 Copyright (C) 1985, 1991-1995 Free Software Foundation, Inc. | |
3 Copyright (C) 1995 Board of Trustees, University of Illinois. | |
4 Copyright (C) 1995 Sun Microsystems, Inc. | |
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
5 Copyright (C) 2001, 2002, 2010 Ben Wing. |
428 | 6 Totally redesigned by jwz in 1991. |
7 | |
8 This file is part of XEmacs. | |
9 | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
10 XEmacs is free software: you can redistribute it and/or modify it |
428 | 11 under the terms of the GNU General Public License as published by the |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
12 Free Software Foundation, either version 3 of the License, or (at your |
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
13 option) any later version. |
428 | 14 |
15 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
18 for more details. | |
19 | |
20 You should have received a copy of the GNU General Public License | |
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5191
diff
changeset
|
21 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
428 | 22 |
23 /* Synched up with: Mule 2.0. Not synched with FSF. Substantially | |
24 different from FSF. */ | |
25 | |
26 | |
27 #include <config.h> | |
28 #include "lisp.h" | |
29 | |
30 #include "buffer.h" | |
31 #include "bytecode.h" | |
872 | 32 #include "console-impl.h" |
428 | 33 #include "elhash.h" |
34 #include "events.h" | |
872 | 35 #include "extents.h" |
428 | 36 #include "frame.h" |
37 #include "insdel.h" | |
38 #include "keymap.h" | |
39 #include "window.h" | |
40 | |
41 | |
42 /* A keymap contains six slots: | |
43 | |
44 parents Ordered list of keymaps to search after | |
45 this one if no match is found. | |
46 Keymaps can thus be arranged in a hierarchy. | |
47 | |
48 table A hash table, hashing keysyms to their bindings. | |
49 It will be one of the following: | |
50 | |
3025 | 51 -- a symbol, e.g. `home' |
428 | 52 -- a character, representing something printable |
53 (not ?\C-c meaning C-c, for instance) | |
54 -- an integer representing a modifier combination | |
55 | |
56 inverse_table A hash table, hashing bindings to the list of keysyms | |
57 in this keymap which are bound to them. This is to make | |
58 the Fwhere_is_internal() function be fast. It needs to be | |
59 fast because we want to be able to call it in realtime to | |
60 update the keyboard-equivalents on the pulldown menus. | |
61 Values of the table are either atoms (keysyms) | |
62 or a dotted list of keysyms. | |
63 | |
64 sub_maps_cache An alist; for each entry in this keymap whose binding is | |
65 a keymap (that is, Fkeymapp()) this alist associates that | |
66 keysym with that binding. This is used to optimize both | |
67 Fwhere_is_internal() and Faccessible_keymaps(). This slot | |
68 gets set to the symbol `t' every time a change is made to | |
69 this keymap, causing it to be recomputed when next needed. | |
70 | |
71 prompt See `set-keymap-prompt'. | |
72 | |
73 default_binding See `set-keymap-default-binding'. | |
74 | |
75 Sequences of keys are stored in the obvious way: if the sequence of keys | |
76 "abc" was bound to some command `foo', the hierarchy would look like | |
77 | |
78 keymap-1: associates "a" with keymap-2 | |
79 keymap-2: associates "b" with keymap-3 | |
80 keymap-3: associates "c" with foo | |
81 | |
82 However, bucky bits ("modifiers" to the X-minded) are represented in the | |
83 keymap hierarchy as well. (This lets us use EQable objects as hash keys.) | |
84 Each combination of modifiers (e.g. control-hyper) gets its own submap | |
85 off of the main map. The hash key for a modifier combination is | |
86 an integer, computed by MAKE_MODIFIER_HASH_KEY(). | |
87 | |
88 If the key `C-a' was bound to some command, the hierarchy would look like | |
89 | |
442 | 90 keymap-1: associates the integer XEMACS_MOD_CONTROL with keymap-2 |
428 | 91 keymap-2: associates "a" with the command |
92 | |
93 Similarly, if the key `C-H-a' was bound to some command, the hierarchy | |
94 would look like | |
95 | |
442 | 96 keymap-1: associates the integer (XEMACS_MOD_CONTROL | XEMACS_MOD_HYPER) |
428 | 97 with keymap-2 |
98 keymap-2: associates "a" with the command | |
99 | |
100 Note that a special exception is made for the meta modifier, in order | |
101 to deal with ESC/meta lossage. Any key combination containing the | |
102 meta modifier is first indexed off of the main map into the meta | |
442 | 103 submap (with hash key XEMACS_MOD_META) and then indexed off of the |
428 | 104 meta submap with the meta modifier removed from the key combination. |
105 For example, when associating a command with C-M-H-a, we'd have | |
106 | |
442 | 107 keymap-1: associates the integer XEMACS_MOD_META with keymap-2 |
108 keymap-2: associates the integer (XEMACS_MOD_CONTROL | XEMACS_MOD_HYPER) | |
428 | 109 with keymap-3 |
110 keymap-3: associates "a" with the command | |
111 | |
112 Note that keymap-2 might have normal bindings in it; these would be | |
113 for key combinations containing only the meta modifier, such as | |
114 M-y or meta-backspace. | |
115 | |
116 If the command that "a" was bound to in keymap-3 was itself a keymap, | |
117 then that would make the key "C-M-H-a" be a prefix character. | |
118 | |
119 Note that this new model of keymaps takes much of the magic away from | |
120 the Escape key: the value of the variable `esc-map' is no longer indexed | |
121 in the `global-map' under the ESC key. It's indexed under the integer | |
442 | 122 XEMACS_MOD_META. This is not user-visible, however; none of the "bucky" |
428 | 123 maps are. |
124 | |
125 There is a hack in Flookup_key() that makes (lookup-key global-map "\^[") | |
126 and (define-key some-random-map "\^[" my-esc-map) work as before, for | |
127 compatibility. | |
128 | |
129 Since keymaps are opaque, the only way to extract information from them | |
130 is with the functions lookup-key, key-binding, local-key-binding, and | |
131 global-key-binding, which work just as before, and the new function | |
440 | 132 map-keymap, which is roughly analogous to maphash. |
428 | 133 |
134 Note that map-keymap perpetuates the illusion that the "bucky" submaps | |
135 don't exist: if you map over a keymap with bucky submaps, it will also | |
136 map over those submaps. It does not, however, map over other random | |
137 submaps of the keymap, just the bucky ones. | |
138 | |
139 One implication of this is that when you map over `global-map', you will | |
140 also map over `esc-map'. It is merely for compatibility that the esc-map | |
141 is accessible at all; I think that's a bad thing, since it blurs the | |
142 distinction between ESC and "meta" even more. "M-x" is no more a two- | |
143 key sequence than "C-x" is. | |
144 | |
145 */ | |
146 | |
440 | 147 struct Lisp_Keymap |
428 | 148 { |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
149 NORMAL_LISP_OBJECT_HEADER header; |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
150 #define MARKED_SLOT(x) Lisp_Object x; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
151 #include "keymap-slots.h" |
440 | 152 }; |
428 | 153 |
154 #define MAKE_MODIFIER_HASH_KEY(modifier) make_int (modifier) | |
155 #define MODIFIER_HASH_KEY_BITS(x) (INTP (x) ? XINT (x) : 0) | |
156 | |
157 | |
158 | |
159 /* Actually allocate storage for these variables */ | |
160 | |
440 | 161 Lisp_Object Vcurrent_global_map; /* Always a keymap */ |
428 | 162 |
771 | 163 static Lisp_Object Vglobal_tty_map, Vglobal_window_system_map; |
164 | |
428 | 165 static Lisp_Object Vmouse_grabbed_buffer; |
166 | |
167 /* Alist of minor mode variables and keymaps. */ | |
168 static Lisp_Object Qminor_mode_map_alist; | |
169 | |
170 static Lisp_Object Voverriding_local_map; | |
171 | |
172 static Lisp_Object Vkey_translation_map; | |
173 | |
174 static Lisp_Object Vvertical_divider_map; | |
175 | |
176 /* This is incremented whenever a change is made to a keymap. This is | |
177 so that things which care (such as the menubar code) can recompute | |
178 privately-cached data when the user has changed keybindings. | |
179 */ | |
458 | 180 Fixnum keymap_tick; |
428 | 181 |
182 /* Prefixing a key with this character is the same as sending a meta bit. */ | |
183 Lisp_Object Vmeta_prefix_char; | |
184 | |
185 Lisp_Object Qkeymapp; | |
186 Lisp_Object Vsingle_space_string; | |
187 Lisp_Object Qsuppress_keymap; | |
188 Lisp_Object Qmodeline_map; | |
189 Lisp_Object Qtoolbar_map; | |
190 | |
191 EXFUN (Fkeymap_fullness, 1); | |
192 EXFUN (Fset_keymap_name, 2); | |
193 EXFUN (Fsingle_key_description, 1); | |
194 | |
195 static void describe_command (Lisp_Object definition, Lisp_Object buffer); | |
196 static void describe_map (Lisp_Object keymap, Lisp_Object elt_prefix, | |
197 void (*elt_describer) (Lisp_Object, Lisp_Object), | |
198 int partial, | |
199 Lisp_Object shadow, | |
200 int mice_only_p, | |
201 Lisp_Object buffer); | |
440 | 202 static Lisp_Object keymap_submaps (Lisp_Object keymap); |
428 | 203 |
204 Lisp_Object Qcontrol, Qctrl, Qmeta, Qsuper, Qhyper, Qalt, Qshift; | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
205 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
206 #define INCLUDE_BUTTON_ZERO |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
207 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
208 Lisp_Object Qbutton##num; \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
209 Lisp_Object Qbutton##num##up; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
210 #include "keymap-buttons.h" |
428 | 211 |
212 Lisp_Object Qmenu_selection; | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
213 |
428 | 214 /* Emacs compatibility */ |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
215 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
216 Lisp_Object Qmouse_##num; \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
217 Lisp_Object Qdown_mouse_##num; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
218 #include "keymap-buttons.h" |
428 | 219 |
220 /* Kludge kludge kludge */ | |
221 Lisp_Object QLFD, QTAB, QRET, QESC, QDEL, QSPC, QBS; | |
222 | |
223 | |
224 /************************************************************************/ | |
225 /* The keymap Lisp object */ | |
226 /************************************************************************/ | |
227 | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
228 /* Keymaps are equal if Faces are equal if all of their display attributes are equal. We |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
229 don't compare names or doc-strings, because that would make equal |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
230 be eq. |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
231 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
232 This isn't concerned with "unspecified" attributes, that's what |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
233 #'face-differs-from-default-p is for. */ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
234 static int |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
235 keymap_equal (Lisp_Object obj1, Lisp_Object obj2, int depth, |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
236 int UNUSED (foldcase)) |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
237 { |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
238 Lisp_Keymap *k1 = XKEYMAP (obj1); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
239 Lisp_Keymap *k2 = XKEYMAP (obj2); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
240 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
241 depth++; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
242 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
243 return |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
244 ( |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
245 #define MARKED_SLOT(x) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
246 internal_equal (k1->x, k2->x, depth) && |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
247 #define MARKED_SLOT_NOCOMPARE(x) |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
248 #include "keymap-slots.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
249 1 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
250 ); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
251 } |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
252 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
253 static Hashcode |
5191
71ee43b8a74d
Add #'equalp as a hash test by default; add #'define-hash-table-test, GNU API
Aidan Kehoe <kehoea@parhasard.net>
parents:
5183
diff
changeset
|
254 keymap_hash (Lisp_Object obj, int depth, Boolint UNUSED (equalp)) |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
255 { |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
256 Lisp_Keymap *k = XKEYMAP (obj); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
257 Hashcode hash = 0xCAFEBABE; /* why not? */ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
258 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
259 depth++; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
260 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
261 #define MARKED_SLOT(x) \ |
5191
71ee43b8a74d
Add #'equalp as a hash test by default; add #'define-hash-table-test, GNU API
Aidan Kehoe <kehoea@parhasard.net>
parents:
5183
diff
changeset
|
262 hash = HASH2 (hash, internal_hash (k->x, depth, 0)); |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
263 #define MARKED_SLOT_NOCOMPARE(x) |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
264 #include "keymap-slots.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
265 |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
266 return hash; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
267 } |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
268 |
428 | 269 static Lisp_Object |
270 mark_keymap (Lisp_Object obj) | |
271 { | |
272 Lisp_Keymap *keymap = XKEYMAP (obj); | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
273 #define MARKED_SLOT(x) mark_object (keymap->x); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
274 #include "keymap-slots.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
275 return Qnil; |
428 | 276 } |
277 | |
278 static void | |
2286 | 279 print_keymap (Lisp_Object obj, Lisp_Object printcharfun, |
280 int UNUSED (escapeflag)) | |
428 | 281 { |
282 /* This function can GC */ | |
283 Lisp_Keymap *keymap = XKEYMAP (obj); | |
284 if (print_readably) | |
5142
f965e31a35f0
reduce lcrecord headers to 2 words, rename printing_unreadable_object
Ben Wing <ben@xemacs.org>
parents:
5128
diff
changeset
|
285 printing_unreadable_lisp_object (obj, 0); |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
286 write_ascstring (printcharfun, "#<keymap "); |
428 | 287 if (!NILP (keymap->name)) |
440 | 288 { |
800 | 289 write_fmt_string_lisp (printcharfun, "%S ", 1, keymap->name); |
440 | 290 } |
800 | 291 write_fmt_string (printcharfun, "size %ld 0x%x>", |
5146
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5142
diff
changeset
|
292 (long) XINT (Fkeymap_fullness (obj)), |
88bd4f3ef8e4
make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c
Ben Wing <ben@xemacs.org>
parents:
5142
diff
changeset
|
293 LISP_OBJECT_UID (obj)); |
428 | 294 } |
295 | |
1204 | 296 static const struct memory_description keymap_description[] = { |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
297 #define MARKED_SLOT(x) { XD_LISP_OBJECT, offsetof (Lisp_Keymap, x) }, |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
298 #include "keymap-slots.h" |
428 | 299 { XD_END } |
300 }; | |
301 | |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
diff
changeset
|
302 DEFINE_DUMPABLE_LISP_OBJECT ("keymap", keymap, |
5125 | 303 mark_keymap, print_keymap, 0, |
304 keymap_equal, keymap_hash, | |
5124
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
305 keymap_description, |
623d57b7fbe8
separate regular and disksave finalization, print method fixes.
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
306 Lisp_Keymap); |
428 | 307 |
308 /************************************************************************/ | |
309 /* Traversing keymaps and their parents */ | |
310 /************************************************************************/ | |
311 | |
312 static Lisp_Object | |
313 traverse_keymaps (Lisp_Object start_keymap, Lisp_Object start_parents, | |
314 Lisp_Object (*mapper) (Lisp_Object keymap, void *mapper_arg), | |
315 void *mapper_arg) | |
316 { | |
317 /* This function can GC */ | |
318 Lisp_Object keymap; | |
319 Lisp_Object tail = start_parents; | |
320 Lisp_Object malloc_sucks[10]; | |
321 Lisp_Object malloc_bites = Qnil; | |
322 int stack_depth = 0; | |
323 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
324 GCPRO4 (*malloc_sucks, malloc_bites, start_keymap, tail); | |
325 gcpro1.nvars = 0; | |
326 | |
327 start_keymap = get_keymap (start_keymap, 1, 1); | |
328 keymap = start_keymap; | |
329 /* Hack special-case parents at top-level */ | |
440 | 330 tail = !NILP (tail) ? tail : XKEYMAP (keymap)->parents; |
428 | 331 |
332 for (;;) | |
333 { | |
334 Lisp_Object result; | |
335 | |
336 QUIT; | |
440 | 337 result = mapper (keymap, mapper_arg); |
428 | 338 if (!NILP (result)) |
339 { | |
340 while (CONSP (malloc_bites)) | |
341 { | |
853 | 342 Lisp_Object victim = malloc_bites; |
343 malloc_bites = XCDR (victim); | |
428 | 344 free_cons (victim); |
345 } | |
346 UNGCPRO; | |
347 return result; | |
348 } | |
349 if (NILP (tail)) | |
350 { | |
351 if (stack_depth == 0) | |
352 { | |
353 UNGCPRO; | |
354 return Qnil; /* Nothing found */ | |
355 } | |
356 stack_depth--; | |
357 if (CONSP (malloc_bites)) | |
358 { | |
853 | 359 Lisp_Object victim = malloc_bites; |
360 tail = XCAR (victim); | |
361 malloc_bites = XCDR (victim); | |
428 | 362 free_cons (victim); |
363 } | |
364 else | |
365 { | |
366 tail = malloc_sucks[stack_depth]; | |
367 gcpro1.nvars = stack_depth; | |
368 } | |
369 keymap = XCAR (tail); | |
370 tail = XCDR (tail); | |
371 } | |
372 else | |
373 { | |
374 Lisp_Object parents; | |
375 | |
376 keymap = XCAR (tail); | |
377 tail = XCDR (tail); | |
378 parents = XKEYMAP (keymap)->parents; | |
379 if (!CONSP (parents)) | |
380 ; | |
381 else if (NILP (tail)) | |
382 /* Tail-recurse */ | |
383 tail = parents; | |
384 else | |
385 { | |
386 if (CONSP (malloc_bites)) | |
387 malloc_bites = noseeum_cons (tail, malloc_bites); | |
388 else if (stack_depth < countof (malloc_sucks)) | |
389 { | |
390 malloc_sucks[stack_depth++] = tail; | |
391 gcpro1.nvars = stack_depth; | |
392 } | |
393 else | |
394 { | |
395 /* *&@##[*&^$ C. @#[$*&@# Unix. Losers all. */ | |
396 int i; | |
397 for (i = 0, malloc_bites = Qnil; | |
398 i < countof (malloc_sucks); | |
399 i++) | |
400 malloc_bites = noseeum_cons (malloc_sucks[i], | |
401 malloc_bites); | |
402 gcpro1.nvars = 0; | |
403 } | |
404 tail = parents; | |
405 } | |
406 } | |
407 keymap = get_keymap (keymap, 1, 1); | |
408 if (EQ (keymap, start_keymap)) | |
409 { | |
563 | 410 invalid_argument ("Cyclic keymap indirection", start_keymap); |
428 | 411 } |
412 } | |
413 } | |
414 | |
415 | |
416 /************************************************************************/ | |
417 /* Some low-level functions */ | |
418 /************************************************************************/ | |
419 | |
442 | 420 static int |
428 | 421 bucky_sym_to_bucky_bit (Lisp_Object sym) |
422 { | |
442 | 423 if (EQ (sym, Qcontrol)) return XEMACS_MOD_CONTROL; |
424 if (EQ (sym, Qmeta)) return XEMACS_MOD_META; | |
425 if (EQ (sym, Qsuper)) return XEMACS_MOD_SUPER; | |
426 if (EQ (sym, Qhyper)) return XEMACS_MOD_HYPER; | |
427 if (EQ (sym, Qalt)) return XEMACS_MOD_ALT; | |
428 if (EQ (sym, Qsymbol)) return XEMACS_MOD_ALT; /* #### - reverse compat */ | |
429 if (EQ (sym, Qshift)) return XEMACS_MOD_SHIFT; | |
428 | 430 |
431 return 0; | |
432 } | |
433 | |
434 static Lisp_Object | |
442 | 435 control_meta_superify (Lisp_Object frob, int modifiers) |
428 | 436 { |
437 if (modifiers == 0) | |
438 return frob; | |
439 frob = Fcons (frob, Qnil); | |
442 | 440 if (modifiers & XEMACS_MOD_SHIFT) frob = Fcons (Qshift, frob); |
441 if (modifiers & XEMACS_MOD_ALT) frob = Fcons (Qalt, frob); | |
442 if (modifiers & XEMACS_MOD_HYPER) frob = Fcons (Qhyper, frob); | |
443 if (modifiers & XEMACS_MOD_SUPER) frob = Fcons (Qsuper, frob); | |
444 if (modifiers & XEMACS_MOD_CONTROL) frob = Fcons (Qcontrol, frob); | |
445 if (modifiers & XEMACS_MOD_META) frob = Fcons (Qmeta, frob); | |
428 | 446 return frob; |
447 } | |
448 | |
449 static Lisp_Object | |
934 | 450 make_key_description (const Lisp_Key_Data *key, int prettify) |
451 { | |
1204 | 452 Lisp_Object keysym = KEY_DATA_KEYSYM (key); |
934 | 453 int modifiers = KEY_DATA_MODIFIERS (key); |
428 | 454 if (prettify && CHARP (keysym)) |
455 { | |
456 /* This is a little slow, but (control a) is prettier than (control 65). | |
457 It's now ok to do this for digit-chars too, since we've fixed the | |
458 bug where \9 read as the integer 9 instead of as the symbol with | |
459 "9" as its name. | |
460 */ | |
461 /* !!#### I'm not sure how correct this is. */ | |
867 | 462 Ibyte str [1 + MAX_ICHAR_LEN]; |
463 Bytecount count = set_itext_ichar (str, XCHAR (keysym)); | |
428 | 464 str[count] = 0; |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
465 keysym = intern_istring (str); |
428 | 466 } |
467 return control_meta_superify (keysym, modifiers); | |
468 } | |
469 | |
470 | |
471 /************************************************************************/ | |
472 /* Low-level keymap-store functions */ | |
473 /************************************************************************/ | |
474 | |
475 static Lisp_Object | |
476 raw_lookup_key (Lisp_Object keymap, | |
934 | 477 const Lisp_Key_Data *raw_keys, int raw_keys_count, |
428 | 478 int keys_so_far, int accept_default); |
479 | |
480 /* Relies on caller to gc-protect args */ | |
481 static Lisp_Object | |
482 keymap_lookup_directly (Lisp_Object keymap, | |
442 | 483 Lisp_Object keysym, int modifiers) |
428 | 484 { |
485 Lisp_Keymap *k; | |
486 | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
487 modifiers &= ~( |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
488 #define FROB(num) XEMACS_MOD_BUTTON##num | |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
489 #include "keymap-buttons.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
490 0); |
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
491 assert ((modifiers & ~(XEMACS_MOD_CONTROL | XEMACS_MOD_META | |
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
492 XEMACS_MOD_SUPER | XEMACS_MOD_HYPER | |
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
493 XEMACS_MOD_ALT | XEMACS_MOD_SHIFT)) |
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
494 == 0); |
428 | 495 |
496 k = XKEYMAP (keymap); | |
497 | |
498 /* If the keysym is a one-character symbol, use the char code instead. */ | |
826 | 499 if (SYMBOLP (keysym) && string_char_length (XSYMBOL (keysym)->name) == 1) |
428 | 500 { |
501 Lisp_Object i_fart_on_gcc = | |
867 | 502 make_char (string_ichar (XSYMBOL (keysym)->name, 0)); |
428 | 503 keysym = i_fart_on_gcc; |
504 } | |
505 | |
442 | 506 if (modifiers & XEMACS_MOD_META) /* Utterly hateful ESC lossage */ |
428 | 507 { |
442 | 508 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (XEMACS_MOD_META), |
428 | 509 k->table, Qnil); |
510 if (NILP (submap)) | |
511 return Qnil; | |
512 k = XKEYMAP (submap); | |
442 | 513 modifiers &= ~XEMACS_MOD_META; |
428 | 514 } |
515 | |
516 if (modifiers != 0) | |
517 { | |
518 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (modifiers), | |
519 k->table, Qnil); | |
520 if (NILP (submap)) | |
521 return Qnil; | |
522 k = XKEYMAP (submap); | |
523 } | |
524 return Fgethash (keysym, k->table, Qnil); | |
525 } | |
526 | |
527 static void | |
528 keymap_store_inverse_internal (Lisp_Object inverse_table, | |
529 Lisp_Object keysym, | |
530 Lisp_Object value) | |
531 { | |
532 Lisp_Object keys = Fgethash (value, inverse_table, Qunbound); | |
533 | |
534 if (UNBOUNDP (keys)) | |
535 { | |
536 keys = keysym; | |
537 /* Don't cons this unless necessary */ | |
538 /* keys = Fcons (keysym, Qnil); */ | |
539 Fputhash (value, keys, inverse_table); | |
540 } | |
541 else if (!CONSP (keys)) | |
542 { | |
543 /* Now it's necessary to cons */ | |
544 keys = Fcons (keys, keysym); | |
545 Fputhash (value, keys, inverse_table); | |
546 } | |
547 else | |
548 { | |
549 while (CONSP (XCDR (keys))) | |
550 keys = XCDR (keys); | |
551 XCDR (keys) = Fcons (XCDR (keys), keysym); | |
552 /* No need to call puthash because we've destructively | |
553 modified the list tail in place */ | |
554 } | |
555 } | |
556 | |
557 | |
558 static void | |
559 keymap_delete_inverse_internal (Lisp_Object inverse_table, | |
560 Lisp_Object keysym, | |
561 Lisp_Object value) | |
562 { | |
563 Lisp_Object keys = Fgethash (value, inverse_table, Qunbound); | |
564 Lisp_Object new_keys = keys; | |
565 Lisp_Object tail; | |
566 Lisp_Object *prev; | |
567 | |
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
568 assert (!UNBOUNDP (keys)); |
428 | 569 |
570 for (prev = &new_keys, tail = new_keys; | |
571 ; | |
572 prev = &(XCDR (tail)), tail = XCDR (tail)) | |
573 { | |
574 if (EQ (tail, keysym)) | |
575 { | |
576 *prev = Qnil; | |
577 break; | |
578 } | |
579 else if (EQ (keysym, XCAR (tail))) | |
580 { | |
581 *prev = XCDR (tail); | |
582 break; | |
583 } | |
584 } | |
585 | |
586 if (NILP (new_keys)) | |
587 Fremhash (value, inverse_table); | |
588 else if (!EQ (keys, new_keys)) | |
589 /* Removed the first elt */ | |
590 Fputhash (value, new_keys, inverse_table); | |
591 /* else the list's tail has been modified, so we don't need to | |
592 touch the hash table again (the pointer in there is ok). | |
593 */ | |
594 } | |
595 | |
440 | 596 /* Prevent luser from shooting herself in the foot using something like |
597 (define-key ctl-x-4-map "p" global-map) */ | |
598 static void | |
599 check_keymap_definition_loop (Lisp_Object def, Lisp_Keymap *to_keymap) | |
600 { | |
601 def = get_keymap (def, 0, 0); | |
602 | |
603 if (KEYMAPP (def)) | |
604 { | |
605 Lisp_Object maps; | |
606 | |
607 if (XKEYMAP (def) == to_keymap) | |
563 | 608 invalid_argument ("Cyclic keymap definition", def); |
440 | 609 |
610 for (maps = keymap_submaps (def); | |
611 CONSP (maps); | |
612 maps = XCDR (maps)) | |
613 check_keymap_definition_loop (XCDR (XCAR (maps)), to_keymap); | |
614 } | |
615 } | |
428 | 616 |
617 static void | |
618 keymap_store_internal (Lisp_Object keysym, Lisp_Keymap *keymap, | |
440 | 619 Lisp_Object def) |
428 | 620 { |
440 | 621 Lisp_Object prev_def = Fgethash (keysym, keymap->table, Qnil); |
622 | |
623 if (EQ (prev_def, def)) | |
428 | 624 return; |
440 | 625 |
626 check_keymap_definition_loop (def, keymap); | |
627 | |
628 if (!NILP (prev_def)) | |
428 | 629 keymap_delete_inverse_internal (keymap->inverse_table, |
440 | 630 keysym, prev_def); |
631 if (NILP (def)) | |
428 | 632 { |
633 Fremhash (keysym, keymap->table); | |
634 } | |
635 else | |
636 { | |
440 | 637 Fputhash (keysym, def, keymap->table); |
428 | 638 keymap_store_inverse_internal (keymap->inverse_table, |
440 | 639 keysym, def); |
428 | 640 } |
641 keymap_tick++; | |
642 } | |
643 | |
644 | |
645 static Lisp_Object | |
442 | 646 create_bucky_submap (Lisp_Keymap *k, int modifiers, |
428 | 647 Lisp_Object parent_for_debugging_info) |
648 { | |
649 Lisp_Object submap = Fmake_sparse_keymap (Qnil); | |
650 /* User won't see this, but it is nice for debugging Emacs */ | |
651 XKEYMAP (submap)->name | |
652 = control_meta_superify (parent_for_debugging_info, modifiers); | |
653 /* Invalidate cache */ | |
654 k->sub_maps_cache = Qt; | |
655 keymap_store_internal (MAKE_MODIFIER_HASH_KEY (modifiers), k, submap); | |
656 return submap; | |
657 } | |
658 | |
659 | |
660 /* Relies on caller to gc-protect keymap, keysym, value */ | |
661 static void | |
934 | 662 keymap_store (Lisp_Object keymap, const Lisp_Key_Data *key, |
428 | 663 Lisp_Object value) |
664 { | |
934 | 665 Lisp_Object keysym = KEY_DATA_KEYSYM (key); |
666 int modifiers = KEY_DATA_MODIFIERS (key); | |
440 | 667 Lisp_Keymap *k = XKEYMAP (keymap); |
668 | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
669 modifiers &= ~( |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
670 #define FROB(num) XEMACS_MOD_BUTTON##num | |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
671 #include "keymap-buttons.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
672 0); |
442 | 673 assert ((modifiers & ~(XEMACS_MOD_CONTROL | XEMACS_MOD_META |
674 | XEMACS_MOD_SUPER | XEMACS_MOD_HYPER | |
675 | XEMACS_MOD_ALT | XEMACS_MOD_SHIFT)) == 0); | |
428 | 676 |
677 /* If the keysym is a one-character symbol, use the char code instead. */ | |
826 | 678 if (SYMBOLP (keysym) && string_char_length (XSYMBOL (keysym)->name) == 1) |
867 | 679 keysym = make_char (string_ichar (XSYMBOL (keysym)->name, 0)); |
428 | 680 |
442 | 681 if (modifiers & XEMACS_MOD_META) /* Utterly hateful ESC lossage */ |
428 | 682 { |
442 | 683 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (XEMACS_MOD_META), |
428 | 684 k->table, Qnil); |
685 if (NILP (submap)) | |
442 | 686 submap = create_bucky_submap (k, XEMACS_MOD_META, keymap); |
428 | 687 k = XKEYMAP (submap); |
442 | 688 modifiers &= ~XEMACS_MOD_META; |
428 | 689 } |
690 | |
691 if (modifiers != 0) | |
692 { | |
693 Lisp_Object submap = Fgethash (MAKE_MODIFIER_HASH_KEY (modifiers), | |
694 k->table, Qnil); | |
695 if (NILP (submap)) | |
696 submap = create_bucky_submap (k, modifiers, keymap); | |
697 k = XKEYMAP (submap); | |
698 } | |
699 k->sub_maps_cache = Qt; /* Invalidate cache */ | |
700 keymap_store_internal (keysym, k, value); | |
701 } | |
702 | |
703 | |
704 /************************************************************************/ | |
705 /* Listing the submaps of a keymap */ | |
706 /************************************************************************/ | |
707 | |
708 struct keymap_submaps_closure | |
709 { | |
710 Lisp_Object *result_locative; | |
711 }; | |
712 | |
713 static int | |
2286 | 714 keymap_submaps_mapper_0 (Lisp_Object UNUSED (key), Lisp_Object value, |
715 void *UNUSED (keymap_submaps_closure)) | |
428 | 716 { |
717 /* This function can GC */ | |
718 /* Perform any autoloads, etc */ | |
719 Fkeymapp (value); | |
720 return 0; | |
721 } | |
722 | |
723 static int | |
724 keymap_submaps_mapper (Lisp_Object key, Lisp_Object value, | |
725 void *keymap_submaps_closure) | |
726 { | |
727 /* This function can GC */ | |
728 Lisp_Object *result_locative; | |
729 struct keymap_submaps_closure *cl = | |
730 (struct keymap_submaps_closure *) keymap_submaps_closure; | |
731 result_locative = cl->result_locative; | |
732 | |
733 if (!NILP (Fkeymapp (value))) | |
734 *result_locative = Fcons (Fcons (key, value), *result_locative); | |
735 return 0; | |
736 } | |
737 | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
738 static Lisp_Object map_keymap_sort_predicate (Lisp_Object obj1, |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
739 Lisp_Object obj2, |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
740 Lisp_Object pred, |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
741 Lisp_Object key_func); |
428 | 742 |
743 static Lisp_Object | |
744 keymap_submaps (Lisp_Object keymap) | |
745 { | |
746 /* This function can GC */ | |
747 Lisp_Keymap *k = XKEYMAP (keymap); | |
748 | |
749 if (EQ (k->sub_maps_cache, Qt)) /* Unknown */ | |
750 { | |
751 Lisp_Object result = Qnil; | |
752 struct gcpro gcpro1, gcpro2; | |
753 struct keymap_submaps_closure keymap_submaps_closure; | |
754 | |
755 GCPRO2 (keymap, result); | |
756 keymap_submaps_closure.result_locative = &result; | |
757 /* Do this first pass to touch (and load) any autoloaded maps */ | |
758 elisp_maphash (keymap_submaps_mapper_0, k->table, | |
759 &keymap_submaps_closure); | |
760 result = Qnil; | |
761 elisp_maphash (keymap_submaps_mapper, k->table, | |
762 &keymap_submaps_closure); | |
763 /* keep it sorted so that the result of accessible-keymaps is ordered */ | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
764 k->sub_maps_cache = list_sort (result, map_keymap_sort_predicate, |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
765 Qnil, Qidentity); |
428 | 766 UNGCPRO; |
767 } | |
768 return k->sub_maps_cache; | |
769 } | |
770 | |
771 | |
772 /************************************************************************/ | |
773 /* Basic operations on keymaps */ | |
774 /************************************************************************/ | |
775 | |
776 static Lisp_Object | |
665 | 777 make_keymap (Elemcount size) |
428 | 778 { |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5126
diff
changeset
|
779 Lisp_Object obj = ALLOC_NORMAL_LISP_OBJECT (keymap); |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
780 Lisp_Keymap *keymap = XKEYMAP (obj); |
428 | 781 |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
782 #define MARKED_SLOT(x) keymap->x = Qnil; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
783 #include "keymap-slots.h" |
428 | 784 |
785 if (size != 0) /* hack for copy-keymap */ | |
786 { | |
787 keymap->table = | |
5191
71ee43b8a74d
Add #'equalp as a hash test by default; add #'define-hash-table-test, GNU API
Aidan Kehoe <kehoea@parhasard.net>
parents:
5183
diff
changeset
|
788 make_lisp_hash_table (size, HASH_TABLE_NON_WEAK, Qeq); |
428 | 789 /* Inverse table is often less dense because of duplicate key-bindings. |
790 If not, it will grow anyway. */ | |
791 keymap->inverse_table = | |
647 | 792 make_lisp_hash_table (size * 3 / 4, HASH_TABLE_NON_WEAK, |
5191
71ee43b8a74d
Add #'equalp as a hash test by default; add #'define-hash-table-test, GNU API
Aidan Kehoe <kehoea@parhasard.net>
parents:
5183
diff
changeset
|
793 Qeq); |
428 | 794 } |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
795 return obj; |
428 | 796 } |
797 | |
798 DEFUN ("make-keymap", Fmake_keymap, 0, 1, 0, /* | |
799 Construct and return a new keymap object. | |
800 All entries in it are nil, meaning "command undefined". | |
801 | |
802 Optional argument NAME specifies a name to assign to the keymap, | |
803 as in `set-keymap-name'. This name is only a debugging convenience; | |
804 it is not used except when printing the keymap. | |
805 */ | |
806 (name)) | |
807 { | |
808 Lisp_Object keymap = make_keymap (60); | |
809 if (!NILP (name)) | |
810 Fset_keymap_name (keymap, name); | |
811 return keymap; | |
812 } | |
813 | |
814 DEFUN ("make-sparse-keymap", Fmake_sparse_keymap, 0, 1, 0, /* | |
815 Construct and return a new keymap object. | |
816 All entries in it are nil, meaning "command undefined". The only | |
444 | 817 difference between this function and `make-keymap' is that this function |
428 | 818 returns a "smaller" keymap (one that is expected to contain fewer |
444 | 819 entries). As keymaps dynamically resize, this distinction is not great. |
428 | 820 |
821 Optional argument NAME specifies a name to assign to the keymap, | |
822 as in `set-keymap-name'. This name is only a debugging convenience; | |
823 it is not used except when printing the keymap. | |
824 */ | |
825 (name)) | |
826 { | |
827 Lisp_Object keymap = make_keymap (8); | |
828 if (!NILP (name)) | |
829 Fset_keymap_name (keymap, name); | |
830 return keymap; | |
831 } | |
832 | |
833 DEFUN ("keymap-parents", Fkeymap_parents, 1, 1, 0, /* | |
834 Return the `parent' keymaps of KEYMAP, or nil. | |
835 The parents of a keymap are searched for keybindings when a key sequence | |
836 isn't bound in this one. `(current-global-map)' is the default parent | |
837 of all keymaps. | |
838 */ | |
839 (keymap)) | |
840 { | |
841 keymap = get_keymap (keymap, 1, 1); | |
842 return Fcopy_sequence (XKEYMAP (keymap)->parents); | |
843 } | |
844 | |
845 | |
846 | |
847 static Lisp_Object | |
2286 | 848 traverse_keymaps_noop (Lisp_Object UNUSED (keymap), void *UNUSED (arg)) |
428 | 849 { |
850 return Qnil; | |
851 } | |
852 | |
853 DEFUN ("set-keymap-parents", Fset_keymap_parents, 2, 2, 0, /* | |
854 Set the `parent' keymaps of KEYMAP to PARENTS. | |
855 The parents of a keymap are searched for keybindings when a key sequence | |
856 isn't bound in this one. `(current-global-map)' is the default parent | |
857 of all keymaps. | |
858 */ | |
859 (keymap, parents)) | |
860 { | |
861 /* This function can GC */ | |
862 Lisp_Object k; | |
863 struct gcpro gcpro1, gcpro2; | |
864 | |
865 GCPRO2 (keymap, parents); | |
866 keymap = get_keymap (keymap, 1, 1); | |
867 | |
868 if (KEYMAPP (parents)) /* backwards-compatibility */ | |
869 parents = list1 (parents); | |
870 if (!NILP (parents)) | |
871 { | |
872 Lisp_Object tail = parents; | |
873 while (!NILP (tail)) | |
874 { | |
875 QUIT; | |
876 CHECK_CONS (tail); | |
877 k = XCAR (tail); | |
878 /* Require that it be an actual keymap object, rather than a symbol | |
879 with a (crockish) symbol-function which is a keymap */ | |
880 CHECK_KEYMAP (k); /* get_keymap (k, 1, 1); */ | |
881 tail = XCDR (tail); | |
882 } | |
883 } | |
884 | |
885 /* Check for circularities */ | |
886 traverse_keymaps (keymap, parents, traverse_keymaps_noop, 0); | |
887 keymap_tick++; | |
888 XKEYMAP (keymap)->parents = Fcopy_sequence (parents); | |
889 UNGCPRO; | |
890 return parents; | |
891 } | |
892 | |
893 DEFUN ("set-keymap-name", Fset_keymap_name, 2, 2, 0, /* | |
894 Set the `name' of the KEYMAP to NEW-NAME. | |
895 The name is only a debugging convenience; it is not used except | |
896 when printing the keymap. | |
897 */ | |
898 (keymap, new_name)) | |
899 { | |
900 keymap = get_keymap (keymap, 1, 1); | |
901 | |
902 XKEYMAP (keymap)->name = new_name; | |
903 return new_name; | |
904 } | |
905 | |
906 DEFUN ("keymap-name", Fkeymap_name, 1, 1, 0, /* | |
907 Return the `name' of KEYMAP. | |
908 The name is only a debugging convenience; it is not used except | |
909 when printing the keymap. | |
910 */ | |
911 (keymap)) | |
912 { | |
913 keymap = get_keymap (keymap, 1, 1); | |
914 | |
915 return XKEYMAP (keymap)->name; | |
916 } | |
917 | |
918 DEFUN ("set-keymap-prompt", Fset_keymap_prompt, 2, 2, 0, /* | |
919 Set the `prompt' of KEYMAP to string NEW-PROMPT, or `nil' | |
920 if no prompt is desired. The prompt is shown in the echo-area | |
921 when reading a key-sequence to be looked-up in this keymap. | |
922 */ | |
923 (keymap, new_prompt)) | |
924 { | |
925 keymap = get_keymap (keymap, 1, 1); | |
926 | |
927 if (!NILP (new_prompt)) | |
928 CHECK_STRING (new_prompt); | |
929 | |
930 XKEYMAP (keymap)->prompt = new_prompt; | |
931 return new_prompt; | |
932 } | |
933 | |
934 static Lisp_Object | |
2286 | 935 keymap_prompt_mapper (Lisp_Object keymap, void *UNUSED (arg)) |
428 | 936 { |
937 return XKEYMAP (keymap)->prompt; | |
938 } | |
939 | |
940 | |
941 DEFUN ("keymap-prompt", Fkeymap_prompt, 1, 2, 0, /* | |
942 Return the `prompt' of KEYMAP. | |
943 If non-nil, the prompt is shown in the echo-area | |
944 when reading a key-sequence to be looked-up in this keymap. | |
945 */ | |
946 (keymap, use_inherited)) | |
947 { | |
948 /* This function can GC */ | |
949 Lisp_Object prompt; | |
950 | |
951 keymap = get_keymap (keymap, 1, 1); | |
952 prompt = XKEYMAP (keymap)->prompt; | |
953 if (!NILP (prompt) || NILP (use_inherited)) | |
954 return prompt; | |
955 else | |
956 return traverse_keymaps (keymap, Qnil, keymap_prompt_mapper, 0); | |
957 } | |
958 | |
959 DEFUN ("set-keymap-default-binding", Fset_keymap_default_binding, 2, 2, 0, /* | |
960 Sets the default binding of KEYMAP to COMMAND, or `nil' | |
961 if no default is desired. The default-binding is returned when | |
962 no other binding for a key-sequence is found in the keymap. | |
963 If a keymap has a non-nil default-binding, neither the keymap's | |
964 parents nor the current global map are searched for key bindings. | |
965 */ | |
966 (keymap, command)) | |
967 { | |
968 /* This function can GC */ | |
969 keymap = get_keymap (keymap, 1, 1); | |
970 | |
971 XKEYMAP (keymap)->default_binding = command; | |
972 return command; | |
973 } | |
974 | |
975 DEFUN ("keymap-default-binding", Fkeymap_default_binding, 1, 1, 0, /* | |
976 Return the default binding of KEYMAP, or `nil' if it has none. | |
977 The default-binding is returned when no other binding for a key-sequence | |
978 is found in the keymap. | |
979 If a keymap has a non-nil default-binding, neither the keymap's | |
980 parents nor the current global map are searched for key bindings. | |
981 */ | |
982 (keymap)) | |
983 { | |
984 /* This function can GC */ | |
985 keymap = get_keymap (keymap, 1, 1); | |
986 return XKEYMAP (keymap)->default_binding; | |
987 } | |
988 | |
989 DEFUN ("keymapp", Fkeymapp, 1, 1, 0, /* | |
444 | 990 Return t if OBJECT is a keymap object. |
428 | 991 The keymap may be autoloaded first if necessary. |
992 */ | |
993 (object)) | |
994 { | |
995 /* This function can GC */ | |
996 return KEYMAPP (get_keymap (object, 0, 0)) ? Qt : Qnil; | |
997 } | |
998 | |
999 /* Check that OBJECT is a keymap (after dereferencing through any | |
1000 symbols). If it is, return it. | |
1001 | |
1002 If AUTOLOAD is non-zero and OBJECT is a symbol whose function value | |
1003 is an autoload form, do the autoload and try again. | |
1004 If AUTOLOAD is nonzero, callers must assume GC is possible. | |
1005 | |
1006 ERRORP controls how we respond if OBJECT isn't a keymap. | |
1007 If ERRORP is non-zero, signal an error; otherwise, just return Qnil. | |
1008 | |
1009 Note that most of the time, we don't want to pursue autoloads. | |
1010 Functions like Faccessible_keymaps which scan entire keymap trees | |
1011 shouldn't load every autoloaded keymap. I'm not sure about this, | |
1012 but it seems to me that only read_key_sequence, Flookup_key, and | |
1013 Fdefine_key should cause keymaps to be autoloaded. */ | |
1014 | |
1015 Lisp_Object | |
1016 get_keymap (Lisp_Object object, int errorp, int autoload) | |
1017 { | |
1018 /* This function can GC */ | |
1019 while (1) | |
1020 { | |
1021 Lisp_Object tem = indirect_function (object, 0); | |
1022 | |
1023 if (KEYMAPP (tem)) | |
1024 return tem; | |
1025 /* Should we do an autoload? */ | |
1026 else if (autoload | |
1027 /* (autoload "filename" doc nil keymap) */ | |
1028 && SYMBOLP (object) | |
1029 && CONSP (tem) | |
1030 && EQ (XCAR (tem), Qautoload) | |
1031 && EQ (Fcar (Fcdr (Fcdr (Fcdr (Fcdr (tem))))), Qkeymap)) | |
1032 { | |
970 | 1033 /* do_autoload GCPROs both arguments */ |
428 | 1034 do_autoload (tem, object); |
1035 } | |
1036 else if (errorp) | |
1037 object = wrong_type_argument (Qkeymapp, object); | |
1038 else | |
1039 return Qnil; | |
1040 } | |
1041 } | |
1042 | |
1043 /* Given OBJECT which was found in a slot in a keymap, | |
1044 trace indirect definitions to get the actual definition of that slot. | |
1045 An indirect definition is a list of the form | |
1046 (KEYMAP . INDEX), where KEYMAP is a keymap or a symbol defined as one | |
1047 and INDEX is an ASCII code, or a cons of (KEYSYM . MODIFIERS). | |
1048 */ | |
1049 static Lisp_Object | |
1050 get_keyelt (Lisp_Object object, int accept_default) | |
1051 { | |
1052 /* This function can GC */ | |
1053 Lisp_Object map; | |
1054 | |
1055 tail_recurse: | |
1056 if (!CONSP (object)) | |
1057 return object; | |
1058 | |
1059 { | |
1060 struct gcpro gcpro1; | |
1061 GCPRO1 (object); | |
1062 map = XCAR (object); | |
1063 map = get_keymap (map, 0, 1); | |
1064 UNGCPRO; | |
1065 } | |
1066 /* If the contents are (KEYMAP . ELEMENT), go indirect. */ | |
1067 if (!NILP (map)) | |
1068 { | |
1069 Lisp_Object idx = Fcdr (object); | |
934 | 1070 Lisp_Key_Data indirection; |
428 | 1071 if (CHARP (idx)) |
1072 { | |
934 | 1073 Lisp_Object event = Fmake_event (Qnil, Qnil); |
1074 struct gcpro gcpro1; | |
1075 GCPRO1 (event); | |
1076 character_to_event (XCHAR (idx), XEVENT (event), | |
4780
2fd201d73a92
Call character_to_event on characters received from XIM, event-Xt.c
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
1077 XCONSOLE (Vselected_console), |
2fd201d73a92
Call character_to_event on characters received from XIM, event-Xt.c
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
1078 high_bit_is_meta, 0); |
1204 | 1079 indirection.keysym = XEVENT_KEY_KEYSYM (event); |
1080 indirection.modifiers = XEVENT_KEY_MODIFIERS (event); | |
1081 UNGCPRO; | |
428 | 1082 } |
1083 else if (CONSP (idx)) | |
1084 { | |
1085 if (!INTP (XCDR (idx))) | |
1086 return Qnil; | |
1087 indirection.keysym = XCAR (idx); | |
442 | 1088 indirection.modifiers = (unsigned char) XINT (XCDR (idx)); |
428 | 1089 } |
1090 else if (SYMBOLP (idx)) | |
1091 { | |
1092 indirection.keysym = idx; | |
934 | 1093 SET_KEY_DATA_MODIFIERS (&indirection, XINT (XCDR (idx))); |
428 | 1094 } |
1095 else | |
1096 { | |
1097 /* Random junk */ | |
1098 return Qnil; | |
1099 } | |
1100 return raw_lookup_key (map, &indirection, 1, 0, accept_default); | |
1101 } | |
1102 else if (STRINGP (XCAR (object))) | |
1103 { | |
1104 /* If the keymap contents looks like (STRING . DEFN), | |
1105 use DEFN. | |
1106 Keymap alist elements like (CHAR MENUSTRING . DEFN) | |
1107 will be used by HierarKey menus. */ | |
1108 object = XCDR (object); | |
1109 goto tail_recurse; | |
1110 } | |
1111 else | |
1112 { | |
1113 /* Anything else is really the value. */ | |
1114 return object; | |
1115 } | |
1116 } | |
1117 | |
1118 static Lisp_Object | |
934 | 1119 keymap_lookup_1 (Lisp_Object keymap, const Lisp_Key_Data *key, |
428 | 1120 int accept_default) |
1121 { | |
1122 /* This function can GC */ | |
934 | 1123 return get_keyelt (keymap_lookup_directly (keymap, |
1124 KEY_DATA_KEYSYM (key), | |
1125 KEY_DATA_MODIFIERS (key)), | |
1126 accept_default); | |
428 | 1127 } |
1128 | |
1129 | |
1130 /************************************************************************/ | |
1131 /* Copying keymaps */ | |
1132 /************************************************************************/ | |
1133 | |
1134 struct copy_keymap_inverse_closure | |
1135 { | |
1136 Lisp_Object inverse_table; | |
1137 }; | |
1138 | |
1139 static int | |
1140 copy_keymap_inverse_mapper (Lisp_Object key, Lisp_Object value, | |
1141 void *copy_keymap_inverse_closure) | |
1142 { | |
1143 struct copy_keymap_inverse_closure *closure = | |
1144 (struct copy_keymap_inverse_closure *) copy_keymap_inverse_closure; | |
1145 | |
1146 /* copy-sequence deals with dotted lists. */ | |
1147 if (CONSP (value)) | |
1148 value = Fcopy_list (value); | |
1149 Fputhash (key, value, closure->inverse_table); | |
1150 | |
1151 return 0; | |
1152 } | |
1153 | |
1154 | |
1155 static Lisp_Object | |
1156 copy_keymap_internal (Lisp_Keymap *keymap) | |
1157 { | |
1158 Lisp_Object nkm = make_keymap (0); | |
1159 Lisp_Keymap *new_keymap = XKEYMAP (nkm); | |
1160 struct copy_keymap_inverse_closure copy_keymap_inverse_closure; | |
1161 copy_keymap_inverse_closure.inverse_table = keymap->inverse_table; | |
1162 | |
1163 new_keymap->parents = Fcopy_sequence (keymap->parents); | |
1164 new_keymap->sub_maps_cache = Qnil; /* No submaps */ | |
1165 new_keymap->table = Fcopy_hash_table (keymap->table); | |
1166 new_keymap->inverse_table = Fcopy_hash_table (keymap->inverse_table); | |
1167 new_keymap->default_binding = keymap->default_binding; | |
1168 /* After copying the inverse map, we need to copy the conses which | |
1169 are its values, lest they be shared by the copy, and mangled. | |
1170 */ | |
1171 elisp_maphash (copy_keymap_inverse_mapper, keymap->inverse_table, | |
1172 ©_keymap_inverse_closure); | |
1173 return nkm; | |
1174 } | |
1175 | |
1176 | |
1177 static Lisp_Object copy_keymap (Lisp_Object keymap); | |
1178 | |
1179 struct copy_keymap_closure | |
1180 { | |
1181 Lisp_Keymap *self; | |
1182 }; | |
1183 | |
1184 static int | |
1185 copy_keymap_mapper (Lisp_Object key, Lisp_Object value, | |
1186 void *copy_keymap_closure) | |
1187 { | |
1188 /* This function can GC */ | |
1189 struct copy_keymap_closure *closure = | |
1190 (struct copy_keymap_closure *) copy_keymap_closure; | |
1191 | |
1192 /* When we encounter a keymap which is indirected through a | |
1193 symbol, we need to copy the sub-map. In v18, the form | |
1194 (lookup-key (copy-keymap global-map) "\C-x") | |
3025 | 1195 returned a new keymap, not the symbol `Control-X-prefix'. |
428 | 1196 */ |
1197 value = get_keymap (value, 0, 1); /* #### autoload GC-safe here? */ | |
1198 if (KEYMAPP (value)) | |
1199 keymap_store_internal (key, closure->self, | |
1200 copy_keymap (value)); | |
1201 return 0; | |
1202 } | |
1203 | |
1204 static Lisp_Object | |
1205 copy_keymap (Lisp_Object keymap) | |
1206 { | |
1207 /* This function can GC */ | |
1208 struct copy_keymap_closure copy_keymap_closure; | |
1209 | |
1210 keymap = copy_keymap_internal (XKEYMAP (keymap)); | |
1211 copy_keymap_closure.self = XKEYMAP (keymap); | |
1212 elisp_maphash (copy_keymap_mapper, | |
1213 XKEYMAP (keymap)->table, | |
1214 ©_keymap_closure); | |
1215 return keymap; | |
1216 } | |
1217 | |
1218 DEFUN ("copy-keymap", Fcopy_keymap, 1, 1, 0, /* | |
1219 Return a copy of the keymap KEYMAP. | |
1220 The copy starts out with the same definitions of KEYMAP, | |
1221 but changing either the copy or KEYMAP does not affect the other. | |
1222 Any key definitions that are subkeymaps are recursively copied. | |
1223 */ | |
1224 (keymap)) | |
1225 { | |
1226 /* This function can GC */ | |
1227 keymap = get_keymap (keymap, 1, 1); | |
1228 return copy_keymap (keymap); | |
1229 } | |
1230 | |
1231 | |
1232 static int | |
1233 keymap_fullness (Lisp_Object keymap) | |
1234 { | |
1235 /* This function can GC */ | |
1236 int fullness; | |
1237 Lisp_Object sub_maps; | |
1238 struct gcpro gcpro1, gcpro2; | |
1239 | |
1240 keymap = get_keymap (keymap, 1, 1); | |
440 | 1241 fullness = XINT (Fhash_table_count (XKEYMAP (keymap)->table)); |
428 | 1242 GCPRO2 (keymap, sub_maps); |
440 | 1243 for (sub_maps = keymap_submaps (keymap); |
1244 !NILP (sub_maps); | |
1245 sub_maps = XCDR (sub_maps)) | |
428 | 1246 { |
1247 if (MODIFIER_HASH_KEY_BITS (XCAR (XCAR (sub_maps))) != 0) | |
1248 { | |
440 | 1249 Lisp_Object bucky_map = XCDR (XCAR (sub_maps)); |
1250 fullness--; /* don't count bucky maps themselves. */ | |
1251 fullness += keymap_fullness (bucky_map); | |
428 | 1252 } |
1253 } | |
1254 UNGCPRO; | |
1255 return fullness; | |
1256 } | |
1257 | |
1258 DEFUN ("keymap-fullness", Fkeymap_fullness, 1, 1, 0, /* | |
1259 Return the number of bindings in the keymap. | |
1260 */ | |
1261 (keymap)) | |
1262 { | |
1263 /* This function can GC */ | |
1264 return make_int (keymap_fullness (get_keymap (keymap, 1, 1))); | |
1265 } | |
1266 | |
1267 | |
1268 /************************************************************************/ | |
1269 /* Defining keys in keymaps */ | |
1270 /************************************************************************/ | |
1271 | |
1272 /* Given a keysym (should be a symbol, int, char), make sure it's valid | |
1273 and perform any necessary canonicalization. */ | |
1274 | |
1275 static void | |
1276 define_key_check_and_coerce_keysym (Lisp_Object spec, | |
1277 Lisp_Object *keysym, | |
442 | 1278 int modifiers) |
428 | 1279 { |
1280 /* Now, check and massage the trailing keysym specifier. */ | |
1281 if (SYMBOLP (*keysym)) | |
1282 { | |
826 | 1283 if (string_char_length (XSYMBOL (*keysym)->name) == 1) |
428 | 1284 { |
1285 Lisp_Object ream_gcc_up_the_ass = | |
867 | 1286 make_char (string_ichar (XSYMBOL (*keysym)->name, 0)); |
428 | 1287 *keysym = ream_gcc_up_the_ass; |
1288 goto fixnum_keysym; | |
1289 } | |
1290 } | |
1291 else if (CHAR_OR_CHAR_INTP (*keysym)) | |
1292 { | |
1293 CHECK_CHAR_COERCE_INT (*keysym); | |
1294 fixnum_keysym: | |
1295 if (XCHAR (*keysym) < ' ' | |
1296 /* || (XCHAR (*keysym) >= 128 && XCHAR (*keysym) < 160) */) | |
1297 /* yuck! Can't make the above restriction; too many compatibility | |
1298 problems ... */ | |
563 | 1299 invalid_argument ("keysym char must be printable", *keysym); |
428 | 1300 /* #### This bites! I want to be able to write (control shift a) */ |
442 | 1301 if (modifiers & XEMACS_MOD_SHIFT) |
563 | 1302 invalid_argument |
428 | 1303 ("The `shift' modifier may not be applied to ASCII keysyms", |
1304 spec); | |
1305 } | |
1306 else | |
1307 { | |
563 | 1308 invalid_argument ("Unknown keysym specifier", *keysym); |
428 | 1309 } |
1310 | |
1311 if (SYMBOLP (*keysym)) | |
1312 { | |
867 | 1313 Ibyte *name = XSTRING_DATA (XSYMBOL (*keysym)->name); |
428 | 1314 |
3025 | 1315 /* GNU Emacs uses symbols with the printed representation of keysyms in |
1316 their names, like `M-x', and we use the syntax '(meta x). So, to | |
1317 avoid confusion, notice the M-x syntax and signal an error - | |
1318 because otherwise it would be interpreted as a regular keysym, and | |
1319 would even show up in the list-buffers output, causing confusion | |
1320 to the naive. | |
428 | 1321 |
1322 We can get away with this because none of the X keysym names contain | |
1323 a hyphen (some contain underscore, however). | |
1324 | |
1325 It might be useful to reject keysyms which are not x-valid-keysym- | |
1326 name-p, but that would interfere with various tricks we do to | |
1327 sanitize the Sun keyboards, and would make it trickier to | |
1328 conditionalize a .emacs file for multiple X servers. | |
1329 */ | |
793 | 1330 if (((int) qxestrlen (name) >= 2 && name[1] == '-') |
428 | 1331 #if 1 |
1332 || | |
1333 /* Ok, this is a bit more dubious - prevent people from doing things | |
1334 like (global-set-key 'RET 'something) because that will have the | |
1335 same problem as above. (Gag!) Maybe we should just silently | |
1336 accept these as aliases for the "real" names? | |
1337 */ | |
793 | 1338 (XSTRING_LENGTH (XSYMBOL (*keysym)->name) <= 3 && |
2367 | 1339 (!qxestrcmp_ascii (name, "LFD") || |
1340 !qxestrcmp_ascii (name, "TAB") || | |
1341 !qxestrcmp_ascii (name, "RET") || | |
1342 !qxestrcmp_ascii (name, "ESC") || | |
1343 !qxestrcmp_ascii (name, "DEL") || | |
1344 !qxestrcmp_ascii (name, "SPC") || | |
1345 !qxestrcmp_ascii (name, "BS"))) | |
428 | 1346 #endif /* unused */ |
1347 ) | |
563 | 1348 invalid_argument |
3086 | 1349 ("Invalid (GNU Emacs) key format (see doc of define-key)", |
428 | 1350 *keysym); |
1351 | |
1352 /* #### Ok, this is a bit more dubious - make people not lose if they | |
1353 do things like (global-set-key 'RET 'something) because that would | |
1354 otherwise have the same problem as above. (Gag!) We silently | |
1355 accept these as aliases for the "real" names. | |
1356 */ | |
2367 | 1357 else if (!qxestrncmp_ascii (name, "kp_", 3)) |
793 | 1358 { |
1359 /* Likewise, the obsolete keysym binding of kp_.* should not lose. */ | |
1360 DECLARE_EISTRING (temp); | |
1361 eicpy_raw (temp, name, qxestrlen (name)); | |
1362 eisetch_char (temp, 2, '-'); | |
4355
a2af1ff1761f
Provide a DEFAULT argument in #'intern-soft.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4272
diff
changeset
|
1363 *keysym = Fintern_soft (eimake_string (temp), Qnil, Qnil); |
793 | 1364 } |
1365 else if (EQ (*keysym, QLFD)) | |
428 | 1366 *keysym = QKlinefeed; |
1367 else if (EQ (*keysym, QTAB)) | |
1368 *keysym = QKtab; | |
1369 else if (EQ (*keysym, QRET)) | |
1370 *keysym = QKreturn; | |
1371 else if (EQ (*keysym, QESC)) | |
1372 *keysym = QKescape; | |
1373 else if (EQ (*keysym, QDEL)) | |
1374 *keysym = QKdelete; | |
1375 else if (EQ (*keysym, QSPC)) | |
1376 *keysym = QKspace; | |
1377 else if (EQ (*keysym, QBS)) | |
1378 *keysym = QKbackspace; | |
1379 /* Emacs compatibility */ | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1380 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1381 else if (EQ(*keysym, Qdown_mouse_##num)) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1382 *keysym = Qbutton##num; \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1383 else if (EQ(*keysym, Qmouse_##num)) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1384 *keysym = Qbutton##num##up; |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1385 #include "keymap-buttons.h" |
428 | 1386 } |
1387 } | |
1388 | |
1389 | |
1390 /* Given any kind of key-specifier, return a keysym and modifier mask. | |
1391 Proper canonicalization is performed: | |
1392 | |
1393 -- integers are converted into the equivalent characters. | |
1394 -- one-character strings are converted into the equivalent characters. | |
1395 */ | |
1396 | |
1397 static void | |
934 | 1398 define_key_parser (Lisp_Object spec, Lisp_Key_Data *returned_value) |
428 | 1399 { |
1400 if (CHAR_OR_CHAR_INTP (spec)) | |
1401 { | |
934 | 1402 Lisp_Object event = Fmake_event (Qnil, Qnil); |
1403 struct gcpro gcpro1; | |
1404 GCPRO1 (event); | |
1405 character_to_event (XCHAR_OR_CHAR_INT (spec), XEVENT (event), | |
4780
2fd201d73a92
Call character_to_event on characters received from XIM, event-Xt.c
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
1406 XCONSOLE (Vselected_console), high_bit_is_meta, 0); |
1204 | 1407 SET_KEY_DATA_KEYSYM (returned_value, XEVENT_KEY_KEYSYM (event)); |
934 | 1408 SET_KEY_DATA_MODIFIERS (returned_value, |
1204 | 1409 XEVENT_KEY_MODIFIERS (event)); |
1410 UNGCPRO; | |
428 | 1411 } |
1412 else if (EVENTP (spec)) | |
1413 { | |
934 | 1414 switch (XEVENT_TYPE (spec)) |
428 | 1415 { |
1416 case key_press_event: | |
1417 { | |
1204 | 1418 SET_KEY_DATA_KEYSYM (returned_value, XEVENT_KEY_KEYSYM (spec)); |
1419 SET_KEY_DATA_MODIFIERS (returned_value, XEVENT_KEY_MODIFIERS (spec)); | |
428 | 1420 break; |
1421 } | |
1422 case button_press_event: | |
1423 case button_release_event: | |
1424 { | |
934 | 1425 int down = (XEVENT_TYPE (spec) == button_press_event); |
1204 | 1426 switch (XEVENT_BUTTON_BUTTON (spec)) |
934 | 1427 { |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1428 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1429 case num: \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1430 SET_KEY_DATA_KEYSYM (returned_value, \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1431 (down ? Qbutton##num : \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1432 Qbutton##num##up)); \ |
934 | 1433 break; |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1434 #include "keymap-buttons.h" |
934 | 1435 default: |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1436 SET_KEY_DATA_KEYSYM (returned_value, (down ? Qbutton0 : |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1437 Qbutton0up)); |
934 | 1438 break; |
1439 } | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1440 SET_KEY_DATA_MODIFIERS (returned_value, |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1441 XEVENT_BUTTON_MODIFIERS (spec)); |
428 | 1442 break; |
1443 } | |
1444 default: | |
563 | 1445 wtaerror ("unable to bind this type of event", spec); |
428 | 1446 } |
1447 } | |
1448 else if (SYMBOLP (spec)) | |
1449 { | |
1450 /* Be nice, allow = to mean (=) */ | |
1451 if (bucky_sym_to_bucky_bit (spec) != 0) | |
563 | 1452 invalid_argument ("Key is a modifier name", spec); |
428 | 1453 define_key_check_and_coerce_keysym (spec, &spec, 0); |
934 | 1454 SET_KEY_DATA_KEYSYM (returned_value, spec); |
1455 SET_KEY_DATA_MODIFIERS (returned_value, 0); | |
428 | 1456 } |
1457 else if (CONSP (spec)) | |
1458 { | |
442 | 1459 int modifiers = 0; |
428 | 1460 Lisp_Object keysym = Qnil; |
1461 Lisp_Object rest = spec; | |
1462 | |
1463 /* First, parse out the leading modifier symbols. */ | |
1464 while (CONSP (rest)) | |
1465 { | |
442 | 1466 int modifier; |
428 | 1467 |
1468 keysym = XCAR (rest); | |
1469 modifier = bucky_sym_to_bucky_bit (keysym); | |
1470 modifiers |= modifier; | |
1471 if (!NILP (XCDR (rest))) | |
1472 { | |
1473 if (! modifier) | |
563 | 1474 invalid_argument ("Unknown modifier", keysym); |
428 | 1475 } |
1476 else | |
1477 { | |
1478 if (modifier) | |
563 | 1479 sferror ("Nothing but modifiers here", |
428 | 1480 spec); |
1481 } | |
1482 rest = XCDR (rest); | |
1483 QUIT; | |
1484 } | |
1485 if (!NILP (rest)) | |
563 | 1486 signal_error (Qlist_formation_error, |
1487 "List must be nil-terminated", spec); | |
428 | 1488 |
1489 define_key_check_and_coerce_keysym (spec, &keysym, modifiers); | |
934 | 1490 SET_KEY_DATA_KEYSYM(returned_value, keysym); |
1491 SET_KEY_DATA_MODIFIERS (returned_value, modifiers); | |
428 | 1492 } |
1493 else | |
1494 { | |
563 | 1495 invalid_argument ("Unknown key-sequence specifier", |
428 | 1496 spec); |
1497 } | |
1498 } | |
1499 | |
1500 /* Used by character-to-event */ | |
1501 void | |
1502 key_desc_list_to_event (Lisp_Object list, Lisp_Object event, | |
1503 int allow_menu_events) | |
1504 { | |
934 | 1505 Lisp_Key_Data raw_key; |
428 | 1506 |
1507 if (allow_menu_events && | |
1508 CONSP (list) && | |
1509 /* #### where the hell does this come from? */ | |
1510 EQ (XCAR (list), Qmenu_selection)) | |
1511 { | |
1512 Lisp_Object fn, arg; | |
1513 if (! NILP (Fcdr (Fcdr (list)))) | |
563 | 1514 invalid_argument ("Invalid menu event desc", list); |
428 | 1515 arg = Fcar (Fcdr (list)); |
1516 if (SYMBOLP (arg)) | |
1517 fn = Qcall_interactively; | |
1518 else | |
1519 fn = Qeval; | |
934 | 1520 XSET_EVENT_TYPE (event, misc_user_event); |
1204 | 1521 XSET_EVENT_CHANNEL (event, wrap_frame (selected_frame ())); |
1522 XSET_EVENT_MISC_USER_FUNCTION (event, fn); | |
1523 XSET_EVENT_MISC_USER_OBJECT (event, arg); | |
428 | 1524 return; |
1525 } | |
1526 | |
1527 define_key_parser (list, &raw_key); | |
1528 | |
5183
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1529 /* The first zero is needed for Apple's i686-apple-darwin8-g++-4.0.1, |
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1530 otherwise the build fails with: |
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1531 |
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1532 In function ‘void key_desc_list_to_event(Lisp_Object, Lisp_Object, int)’: |
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1533 cc1plus: error: expected primary-expression |
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1534 cc1plus: error: expected `)' */ |
f283b08ff0c9
Avoid build failure, Apple's g++-4.0.1, Mac OS 10.4.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5182
diff
changeset
|
1535 if (0 || |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1536 #define INCLUDE_BUTTON_ZERO |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1537 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1538 EQ (raw_key.keysym, Qbutton##num) || \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1539 EQ (raw_key.keysym, Qbutton##num##up) || |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1540 #include "keymap-buttons.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1541 0) |
563 | 1542 invalid_operation ("Mouse-clicks can't appear in saved keyboard macros", |
1543 Qunbound); | |
428 | 1544 |
934 | 1545 XSET_EVENT_CHANNEL (event, Vselected_console); |
1546 XSET_EVENT_TYPE (event, key_press_event); | |
1204 | 1547 XSET_EVENT_KEY_KEYSYM (event, raw_key.keysym); |
1548 XSET_EVENT_KEY_MODIFIERS (event, KEY_DATA_MODIFIERS (&raw_key)); | |
428 | 1549 } |
1550 | |
1551 | |
1552 int | |
1204 | 1553 event_matches_key_specifier_p (Lisp_Object event, Lisp_Object key_specifier) |
428 | 1554 { |
446 | 1555 Lisp_Object event2 = Qnil; |
428 | 1556 int retval; |
1557 struct gcpro gcpro1; | |
1558 | |
1204 | 1559 if (XEVENT_TYPE (event) != key_press_event || NILP (key_specifier) || |
428 | 1560 (INTP (key_specifier) && !CHAR_INTP (key_specifier))) |
1561 return 0; | |
1562 | |
1563 /* if the specifier is an integer such as 27, then it should match | |
3025 | 1564 both of the events `escape' and `control ['. Calling |
1565 Fcharacter_to_event() will only match `escape'. */ | |
428 | 1566 if (CHAR_OR_CHAR_INTP (key_specifier)) |
1567 return (XCHAR_OR_CHAR_INT (key_specifier) | |
2828 | 1568 == event_to_character (event, 0, 0)); |
428 | 1569 |
1570 /* Otherwise, we cannot call event_to_character() because we may | |
1571 be dealing with non-ASCII keystrokes. In any case, if I ask | |
3025 | 1572 for `control [' then I should get exactly that, and not |
1573 `escape'. | |
1574 | |
1575 However, we have to behave differently on TTY's, where `control [' | |
1576 is silently converted into `escape' by the keyboard driver. | |
428 | 1577 In this case, ASCII is the only thing we know about, so we have |
1578 to compare the ASCII values. */ | |
1579 | |
1580 GCPRO1 (event2); | |
1204 | 1581 if (EVENTP (key_specifier)) |
1582 event2 = Fcopy_event (key_specifier, Qnil); | |
1583 else | |
1584 event2 = Fcharacter_to_event (key_specifier, Qnil, Qnil, Qnil); | |
428 | 1585 if (XEVENT (event2)->event_type != key_press_event) |
1586 retval = 0; | |
1204 | 1587 else if (CONSOLE_TTY_P (XCONSOLE (XEVENT_CHANNEL (event)))) |
428 | 1588 { |
1589 int ch1, ch2; | |
1590 | |
2828 | 1591 ch1 = event_to_character (event, 0, 0); |
1592 ch2 = event_to_character (event2, 0, 0); | |
428 | 1593 retval = (ch1 >= 0 && ch2 >= 0 && ch1 == ch2); |
1594 } | |
1204 | 1595 else if (EQ (XEVENT_KEY_KEYSYM (event), XEVENT_KEY_KEYSYM (event2)) && |
1596 XEVENT_KEY_MODIFIERS (event) == XEVENT_KEY_MODIFIERS (event2)) | |
428 | 1597 retval = 1; |
1598 else | |
1599 retval = 0; | |
1600 Fdeallocate_event (event2); | |
1601 UNGCPRO; | |
1602 return retval; | |
1603 } | |
1604 | |
1605 static int | |
934 | 1606 meta_prefix_char_p (const Lisp_Key_Data *key) |
428 | 1607 { |
934 | 1608 Lisp_Object event = Fmake_event (Qnil, Qnil); |
1609 struct gcpro gcpro1; | |
1204 | 1610 int retval; |
1611 | |
934 | 1612 GCPRO1 (event); |
1613 | |
1614 XSET_EVENT_TYPE (event, key_press_event); | |
1615 XSET_EVENT_CHANNEL (event, Vselected_console); | |
1204 | 1616 XSET_EVENT_KEY_KEYSYM (event, KEY_DATA_KEYSYM (key)); |
1617 XSET_EVENT_KEY_MODIFIERS (event, KEY_DATA_MODIFIERS (key)); | |
1618 retval = event_matches_key_specifier_p (event, Vmeta_prefix_char); | |
1619 UNGCPRO; | |
1620 return retval; | |
428 | 1621 } |
1622 | |
1623 DEFUN ("event-matches-key-specifier-p", Fevent_matches_key_specifier_p, 2, 2, 0, /* | |
1624 Return non-nil if EVENT matches KEY-SPECIFIER. | |
1625 This can be useful, e.g., to determine if the user pressed `help-char' or | |
1626 `quit-char'. | |
1204 | 1627 |
1628 KEY-SPECIFIER can be a character, integer, a symbol, a list of modifiers | |
1629 and symbols, or an event. | |
1630 | |
1631 What this actually happens is this: | |
1632 | |
1633 \(1) Return no, if EVENT is not a key press event or if KEY-SPECIFIER is nil | |
1634 or an integer that cannot be converted to a character. | |
1635 | |
1636 \(2) If KEY-SPECIFIER is a character or integer, | |
1637 (event-to-character EVENT nil nil nil) is called, and the characters are | |
1638 compared to get the result. The reason for special-casing this and doing | |
1639 it this way is to ensure that, e.g., a KEY-SPECIFIER of 27 matches both | |
1640 a key-press `escape' and a key-press `control ['. #### Think about META | |
1641 argument to event-to-character. | |
1642 | |
1643 \(3) If KEY-SPECIFIER is an event, fine; else, convert to an event using | |
1644 \(character-to-event KEY-SPECIFIER nil nil nil). If EVENT is not on a TTY, | |
1645 we just compare keysyms and modifiers and return yes if both are equal. | |
1646 For TTY, we do character-level comparison by converting both to a character | |
1647 with (event-to-character ... nil nil nil) and comparing the characters. | |
1648 | |
428 | 1649 */ |
1650 (event, key_specifier)) | |
1651 { | |
1652 CHECK_LIVE_EVENT (event); | |
1204 | 1653 return (event_matches_key_specifier_p (event, key_specifier) ? Qt : Qnil); |
428 | 1654 } |
1204 | 1655 #define MACROLET(k, m) do { \ |
1656 SET_KEY_DATA_KEYSYM (returned_value, k); \ | |
1657 SET_KEY_DATA_MODIFIERS (returned_value, m); \ | |
1658 RETURN_SANS_WARNINGS; \ | |
934 | 1659 } while (0) |
428 | 1660 /* ASCII grunge. |
1661 Given a keysym, return another keysym/modifier pair which could be | |
1662 considered the same key in an ASCII world. Backspace returns ^H, for | |
1663 example. | |
1664 */ | |
1665 static void | |
934 | 1666 define_key_alternate_name (Lisp_Key_Data *key, |
1667 Lisp_Key_Data *returned_value) | |
428 | 1668 { |
934 | 1669 Lisp_Object keysym = KEY_DATA_KEYSYM (key); |
1670 int modifiers = KEY_DATA_MODIFIERS (key); | |
442 | 1671 int modifiers_sans_control = (modifiers & (~XEMACS_MOD_CONTROL)); |
1672 int modifiers_sans_meta = (modifiers & (~XEMACS_MOD_META)); | |
934 | 1673 SET_KEY_DATA_KEYSYM (returned_value, Qnil); /* By default, no "alternate" key */ |
1674 SET_KEY_DATA_MODIFIERS (returned_value, 0); | |
442 | 1675 if (modifiers_sans_meta == XEMACS_MOD_CONTROL) |
428 | 1676 { |
722 | 1677 if (EQ (keysym, QKspace)) |
428 | 1678 MACROLET (make_char ('@'), modifiers); |
1679 else if (!CHARP (keysym)) | |
1680 return; | |
1681 else switch (XCHAR (keysym)) | |
1682 { | |
1683 case '@': /* c-@ => c-space */ | |
1684 MACROLET (QKspace, modifiers); | |
1685 case 'h': /* c-h => backspace */ | |
1686 MACROLET (QKbackspace, modifiers_sans_control); | |
1687 case 'i': /* c-i => tab */ | |
1688 MACROLET (QKtab, modifiers_sans_control); | |
1689 case 'j': /* c-j => linefeed */ | |
1690 MACROLET (QKlinefeed, modifiers_sans_control); | |
1691 case 'm': /* c-m => return */ | |
1692 MACROLET (QKreturn, modifiers_sans_control); | |
1693 case '[': /* c-[ => escape */ | |
1694 MACROLET (QKescape, modifiers_sans_control); | |
1695 default: | |
1696 return; | |
1697 } | |
1698 } | |
1699 else if (modifiers_sans_meta != 0) | |
1700 return; | |
1701 else if (EQ (keysym, QKbackspace)) /* backspace => c-h */ | |
442 | 1702 MACROLET (make_char ('h'), (modifiers | XEMACS_MOD_CONTROL)); |
428 | 1703 else if (EQ (keysym, QKtab)) /* tab => c-i */ |
442 | 1704 MACROLET (make_char ('i'), (modifiers | XEMACS_MOD_CONTROL)); |
428 | 1705 else if (EQ (keysym, QKlinefeed)) /* linefeed => c-j */ |
442 | 1706 MACROLET (make_char ('j'), (modifiers | XEMACS_MOD_CONTROL)); |
428 | 1707 else if (EQ (keysym, QKreturn)) /* return => c-m */ |
442 | 1708 MACROLET (make_char ('m'), (modifiers | XEMACS_MOD_CONTROL)); |
428 | 1709 else if (EQ (keysym, QKescape)) /* escape => c-[ */ |
442 | 1710 MACROLET (make_char ('['), (modifiers | XEMACS_MOD_CONTROL)); |
428 | 1711 else |
1712 return; | |
1713 #undef MACROLET | |
1714 } | |
1715 | |
1716 static void | |
1717 ensure_meta_prefix_char_keymapp (Lisp_Object keys, int indx, | |
1718 Lisp_Object keymap) | |
1719 { | |
1720 /* This function can GC */ | |
1721 Lisp_Object new_keys; | |
1722 int i; | |
1723 Lisp_Object mpc_binding; | |
934 | 1724 Lisp_Key_Data meta_key; |
428 | 1725 if (NILP (Vmeta_prefix_char) || |
1726 (INTP (Vmeta_prefix_char) && !CHAR_INTP (Vmeta_prefix_char))) | |
1727 return; | |
1728 | |
1729 define_key_parser (Vmeta_prefix_char, &meta_key); | |
1730 mpc_binding = keymap_lookup_1 (keymap, &meta_key, 0); | |
1731 if (NILP (mpc_binding) || !NILP (Fkeymapp (mpc_binding))) | |
1732 return; | |
1733 | |
1734 if (indx == 0) | |
1735 new_keys = keys; | |
1736 else if (STRINGP (keys)) | |
5089
99f8ebc082d9
Make #'substring an alias of #'subseq; give the latter the byte code.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5050
diff
changeset
|
1737 new_keys = Fsubseq (keys, Qzero, make_int (indx)); |
428 | 1738 else if (VECTORP (keys)) |
1739 { | |
1740 new_keys = make_vector (indx, Qnil); | |
1741 for (i = 0; i < indx; i++) | |
1742 XVECTOR_DATA (new_keys) [i] = XVECTOR_DATA (keys) [i]; | |
1743 } | |
1744 else | |
442 | 1745 { |
1746 new_keys = Qnil; | |
2500 | 1747 ABORT (); |
442 | 1748 } |
428 | 1749 |
1750 if (EQ (keys, new_keys)) | |
563 | 1751 signal_ferror_with_frob (Qinvalid_operation, mpc_binding, |
1752 "can't bind %s: %s has a non-keymap binding", | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1753 (CIbyte *) XSTRING_DATA (Fkey_description (keys)), |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1754 (CIbyte *) XSTRING_DATA (Fsingle_key_description |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1755 (Vmeta_prefix_char))); |
428 | 1756 else |
563 | 1757 signal_ferror_with_frob (Qinvalid_operation, mpc_binding, |
1758 "can't bind %s: %s %s has a non-keymap binding", | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1759 (CIbyte *) XSTRING_DATA (Fkey_description (keys)), |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1760 (CIbyte *) XSTRING_DATA (Fkey_description |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1761 (new_keys)), |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1762 (CIbyte *) XSTRING_DATA (Fsingle_key_description |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
1763 (Vmeta_prefix_char))); |
428 | 1764 } |
1765 | |
1766 DEFUN ("define-key", Fdefine_key, 3, 3, 0, /* | |
1767 Define key sequence KEYS, in KEYMAP, as DEF. | |
1768 KEYMAP is a keymap object. | |
3086 | 1769 KEYS is the key sequence to bind, described below. |
428 | 1770 DEF is anything that can be a key's definition: |
1771 nil (means key is undefined in this keymap); | |
1772 a command (a Lisp function suitable for interactive calling); | |
1773 a string or key sequence vector (treated as a keyboard macro); | |
1774 a keymap (to define a prefix key); | |
1775 a symbol; when the key is looked up, the symbol will stand for its | |
1776 function definition, that should at that time be one of the above, | |
1777 or another symbol whose function definition is used, and so on. | |
1778 a cons (STRING . DEFN), meaning that DEFN is the definition | |
1779 (DEFN should be a valid definition in its own right); | |
1780 or a cons (KEYMAP . CHAR), meaning use definition of CHAR in map KEYMAP. | |
1781 | |
3086 | 1782 A `key sequence' is a vector of one or more keystrokes. |
1783 A `keystroke' is a list containing a key and zero or more modifiers. The | |
1784 key must be the last element of the list. | |
1785 A `key' is a symbol corresponding to a key on the keyboard, or to a mouse | |
1786 gesture. Mouse clicks are denoted by symbols prefixed with "button", | |
1787 followed by a digit for which button, and optionally "up". Thus `button1' | |
1788 means the down-stroke and `button1up' means the up-stroke when clicking | |
1789 mouse button 1. | |
1790 A `modifier' is a symbol naming a physical key which is only "noticed" by | |
1791 XEmacs when chorded with another key. The `shift' modifier is a special | |
1792 case. You cannot use `(meta shift a)' to mean `(meta A)', since for | |
1793 characters that have ASCII equivalents, the state of the shift key is | |
1794 implicit in the keysym (a vs. A). You also cannot say `(shift =)' to mean | |
1795 `+', as that correspondence varies from keyboard to keyboard. The shift | |
1796 modifier can only be applied to keys that do not have a second keysym on the | |
1797 same key, such as `backspace' and `tab'. A mouse click may be combined with | |
1798 modifiers to create a compound "keystroke". | |
1799 | |
1800 The keys, mouse gestures, and modifiers that are available depend on your | |
1801 console and its driver. At a minimum the ASCII graphic characters will be | |
1802 available as keys, and shift, control, and meta as modifiers. | |
1803 | |
1804 To find out programmatically what a key is bound to, use `key-binding' to | |
1805 check all applicable keymaps, or `lookup-key' to check a specific keymap. | |
1806 The documentation for `key-binding' also contains a description of which | |
1807 keymaps are applicable in various situations. `where-is-internal' does | |
1808 the opposite of `key-binding', i.e. searches keymaps for the keys that | |
1809 map to a particular binding. | |
1810 | |
1811 If you are confused about why a particular key sequence is generating a | |
1812 particular binding, and looking through the keymaps doesn't help, setting | |
1813 the variable `debug-emacs-events' may help. If not, try checking | |
1814 what's in `function-key-map' and `key-translation-map'. | |
1815 | |
1816 When running under a window system, typically the repertoire of keys is | |
1817 vastly expanded. XEmacs does its best to use the names defined on each | |
1818 platform. Also, when running under a window system, XEmacs can tell the | |
1819 difference between the keystrokes control-h, control-shift-h, and backspace. | |
1820 If the symbols differ, you can bind different actions to each. For mouse | |
1821 clicks, different commands may be bound to the up and down strokes, though | |
1822 that is probably not what you want, so be careful. | |
1823 | |
1824 Variant representations: | |
1825 | |
1826 Besides the canonical representation as a vector of lists of symbols, | |
1827 `define-key' also accepts a number of abbreviations, aliases, and variants | |
1828 for convenience, compatibility, and internal use. | |
1829 | |
1830 A keystroke may be represented by a key; this is treated as though it were a | |
1831 list containing that key as the only element. A keystroke may also be | |
1832 represented by an event object, as returned by the `next-command-event' and | |
1833 `read-key-sequence' functions. A key sequence may be represented by a | |
1834 single keystroke; this is treated as a vector containing that keystroke as | |
1835 its only element. | |
1836 | |
1837 A key may be represented by a character or its equivalent integer code, | |
1838 if and only if it is equivalent to a character with a code in the range | |
1839 32 - 255. | |
1840 | |
1841 For backward compatibility, a key sequence may also be represented by a | |
1842 string. In this case, it represents the key sequence(s) that would | |
1843 produce that sequence of ASCII characters in a purely ASCII world. An | |
1844 alternative string representation is keyboard macro notation, which can | |
1845 be translated to the canonical representation with `kbd'. | |
1846 | |
1847 Examples: | |
1848 | |
1849 The key sequence `A' (which invokes `self-insert-command') is represented | |
1850 by all of these forms: | |
428 | 1851 A ?A 65 (A) (?A) (65) |
1852 [A] [?A] [65] [(A)] [(?A)] [(65)] | |
1853 | |
3086 | 1854 The key sequence `control-a' is represented by these forms: |
428 | 1855 (control A) (control ?A) (control 65) |
1856 [(control A)] [(control ?A)] [(control 65)] | |
3086 | 1857 |
1858 The key sequence `control-c control-a' is represented by these forms: | |
428 | 1859 [(control c) (control a)] [(control ?c) (control ?a)] |
1860 [(control 99) (control 65)] etc. | |
1861 | |
3086 | 1862 The keystroke `control-b' *may not* be represented by the number 2 (the |
1863 ASCII code for ^B) or the character `?\^B'. | |
1864 | |
1865 The `break' key may be represented only by the symbol `break'. | |
1866 | |
428 | 1867 Mouse button clicks work just like keypresses: (control button1) means |
1868 pressing the left mouse button while holding down the control key. | |
3086 | 1869 |
1870 A string containing the ASCII backspace character, "\\^H", would represent | |
1871 two key sequences: `(control h)' and `backspace'. Binding a | |
428 | 1872 command to this will actually bind both of those key sequences. Likewise |
1873 for the following pairs: | |
1874 | |
1875 control h backspace | |
1876 control i tab | |
1877 control m return | |
1878 control j linefeed | |
1879 control [ escape | |
1880 control @ control space | |
1881 | |
1882 After binding a command to two key sequences with a form like | |
1883 | |
1884 (define-key global-map "\\^X\\^I" \'command-1) | |
1885 | |
1886 it is possible to redefine only one of those sequences like so: | |
1887 | |
1888 (define-key global-map [(control x) (control i)] \'command-2) | |
1889 (define-key global-map [(control x) tab] \'command-3) | |
1890 */ | |
1891 (keymap, keys, def)) | |
1892 { | |
1893 /* This function can GC */ | |
1894 int idx; | |
1895 int metized = 0; | |
1896 int len; | |
1897 int ascii_hack; | |
1898 struct gcpro gcpro1, gcpro2, gcpro3; | |
1899 | |
1900 if (VECTORP (keys)) | |
1901 len = XVECTOR_LENGTH (keys); | |
1902 else if (STRINGP (keys)) | |
826 | 1903 len = string_char_length (keys); |
428 | 1904 else if (CHAR_OR_CHAR_INTP (keys) || SYMBOLP (keys) || CONSP (keys)) |
1905 { | |
1906 if (!CONSP (keys)) keys = list1 (keys); | |
1907 len = 1; | |
1908 keys = make_vector (1, keys); /* this is kinda sleazy. */ | |
1909 } | |
1910 else | |
1911 { | |
1912 keys = wrong_type_argument (Qsequencep, keys); | |
1913 len = XINT (Flength (keys)); | |
1914 } | |
1915 if (len == 0) | |
1916 return Qnil; | |
1917 | |
1918 GCPRO3 (keymap, keys, def); | |
1919 | |
1920 /* ASCII grunge. | |
1921 When the user defines a key which, in a strictly ASCII world, would be | |
1922 produced by two different keys (^J and linefeed, or ^H and backspace, | |
1923 for example) then the binding will be made for both keysyms. | |
1924 | |
1925 This is done if the user binds a command to a string, as in | |
3086 | 1926 (define-key map "\^H" 'something), but not when using the canonical |
1927 syntax (define-key map '(control h) 'something). | |
428 | 1928 */ |
1929 ascii_hack = (STRINGP (keys)); | |
1930 | |
1931 keymap = get_keymap (keymap, 1, 1); | |
1932 | |
1933 idx = 0; | |
1934 while (1) | |
1935 { | |
1936 Lisp_Object c; | |
934 | 1937 Lisp_Key_Data raw_key1; |
1938 Lisp_Key_Data raw_key2; | |
428 | 1939 if (STRINGP (keys)) |
867 | 1940 c = make_char (string_ichar (keys, idx)); |
428 | 1941 else |
1942 c = XVECTOR_DATA (keys) [idx]; | |
1943 | |
1944 define_key_parser (c, &raw_key1); | |
1945 | |
1946 if (!metized && ascii_hack && meta_prefix_char_p (&raw_key1)) | |
1947 { | |
1948 if (idx == (len - 1)) | |
1949 { | |
1950 /* This is a hack to prevent a binding for the meta-prefix-char | |
1951 from being made in a map which already has a non-empty "meta" | |
1952 submap. That is, we can't let both "escape" and "meta" have | |
1953 a binding in the same keymap. This implies that the idiom | |
1954 (define-key my-map "\e" my-escape-map) | |
1955 (define-key my-escape-map "a" 'my-command) | |
1956 no longer works. That's ok. Instead the luser should do | |
1957 (define-key my-map "\ea" 'my-command) | |
1958 or, more correctly | |
1959 (define-key my-map "\M-a" 'my-command) | |
1960 and then perhaps | |
1961 (defvar my-escape-map (lookup-key my-map "\e")) | |
1962 if the luser really wants the map in a variable. | |
1963 */ | |
440 | 1964 Lisp_Object meta_map; |
428 | 1965 struct gcpro ngcpro1; |
1966 | |
1967 NGCPRO1 (c); | |
442 | 1968 meta_map = Fgethash (MAKE_MODIFIER_HASH_KEY (XEMACS_MOD_META), |
440 | 1969 XKEYMAP (keymap)->table, Qnil); |
1970 if (!NILP (meta_map) | |
1971 && keymap_fullness (meta_map) != 0) | |
563 | 1972 invalid_operation_2 |
440 | 1973 ("Map contains meta-bindings, can't bind", |
1974 Fsingle_key_description (Vmeta_prefix_char), keymap); | |
428 | 1975 NUNGCPRO; |
1976 } | |
1977 else | |
1978 { | |
1979 metized = 1; | |
1980 idx++; | |
1981 continue; | |
1982 } | |
1983 } | |
1984 | |
1985 if (ascii_hack) | |
1986 define_key_alternate_name (&raw_key1, &raw_key2); | |
1987 else | |
1988 { | |
1989 raw_key2.keysym = Qnil; | |
1990 raw_key2.modifiers = 0; | |
1991 } | |
1992 | |
1993 if (metized) | |
1994 { | |
442 | 1995 raw_key1.modifiers |= XEMACS_MOD_META; |
1996 raw_key2.modifiers |= XEMACS_MOD_META; | |
428 | 1997 metized = 0; |
1998 } | |
1999 | |
2000 /* This crap is to make sure that someone doesn't bind something like | |
2001 "C-x M-a" while "C-x ESC" has a non-keymap binding. */ | |
442 | 2002 if (raw_key1.modifiers & XEMACS_MOD_META) |
428 | 2003 ensure_meta_prefix_char_keymapp (keys, idx, keymap); |
2004 | |
2005 if (++idx == len) | |
2006 { | |
2007 keymap_store (keymap, &raw_key1, def); | |
2008 if (ascii_hack && !NILP (raw_key2.keysym)) | |
2009 keymap_store (keymap, &raw_key2, def); | |
2010 UNGCPRO; | |
2011 return def; | |
2012 } | |
2013 | |
2014 { | |
2015 Lisp_Object cmd; | |
2016 struct gcpro ngcpro1; | |
2017 NGCPRO1 (c); | |
2018 | |
2019 cmd = keymap_lookup_1 (keymap, &raw_key1, 0); | |
2020 if (NILP (cmd)) | |
2021 { | |
2022 cmd = Fmake_sparse_keymap (Qnil); | |
2023 XKEYMAP (cmd)->name /* for debugging */ | |
2024 = list2 (make_key_description (&raw_key1, 1), keymap); | |
2025 keymap_store (keymap, &raw_key1, cmd); | |
2026 } | |
2027 if (NILP (Fkeymapp (cmd))) | |
563 | 2028 sferror_2 ("Invalid prefix keys in sequence", |
428 | 2029 c, keys); |
2030 | |
2031 if (ascii_hack && !NILP (raw_key2.keysym) && | |
2032 NILP (keymap_lookup_1 (keymap, &raw_key2, 0))) | |
2033 keymap_store (keymap, &raw_key2, cmd); | |
2034 | |
2035 keymap = get_keymap (cmd, 1, 1); | |
2036 NUNGCPRO; | |
2037 } | |
2038 } | |
2039 } | |
2040 | |
2041 | |
2042 /************************************************************************/ | |
2043 /* Looking up keys in keymaps */ | |
2044 /************************************************************************/ | |
2045 | |
2046 /* We need a very fast (i.e., non-consing) version of lookup-key in order | |
2047 to make where-is-internal really fly. */ | |
2048 | |
2049 struct raw_lookup_key_mapper_closure | |
2050 { | |
2051 int remaining; | |
934 | 2052 const Lisp_Key_Data *raw_keys; |
428 | 2053 int raw_keys_count; |
2054 int keys_so_far; | |
2055 int accept_default; | |
2056 }; | |
2057 | |
2058 static Lisp_Object raw_lookup_key_mapper (Lisp_Object k, void *); | |
2059 | |
2060 /* Caller should gc-protect args (keymaps may autoload) */ | |
2061 static Lisp_Object | |
2062 raw_lookup_key (Lisp_Object keymap, | |
934 | 2063 const Lisp_Key_Data *raw_keys, int raw_keys_count, |
428 | 2064 int keys_so_far, int accept_default) |
2065 { | |
2066 /* This function can GC */ | |
2067 struct raw_lookup_key_mapper_closure c; | |
2068 c.remaining = raw_keys_count - 1; | |
2069 c.raw_keys = raw_keys; | |
2070 c.raw_keys_count = raw_keys_count; | |
2071 c.keys_so_far = keys_so_far; | |
2072 c.accept_default = accept_default; | |
2073 | |
2074 return traverse_keymaps (keymap, Qnil, raw_lookup_key_mapper, &c); | |
2075 } | |
2076 | |
2077 static Lisp_Object | |
2078 raw_lookup_key_mapper (Lisp_Object k, void *arg) | |
2079 { | |
2080 /* This function can GC */ | |
2081 struct raw_lookup_key_mapper_closure *c = | |
2082 (struct raw_lookup_key_mapper_closure *) arg; | |
2083 int accept_default = c->accept_default; | |
2084 int remaining = c->remaining; | |
2085 int keys_so_far = c->keys_so_far; | |
934 | 2086 const Lisp_Key_Data *raw_keys = c->raw_keys; |
428 | 2087 Lisp_Object cmd; |
2088 | |
2089 if (! meta_prefix_char_p (&(raw_keys[0]))) | |
2090 { | |
2091 /* Normal case: every case except the meta-hack (see below). */ | |
2092 cmd = keymap_lookup_1 (k, &(raw_keys[0]), accept_default); | |
2093 | |
2094 if (remaining == 0) | |
2095 /* Return whatever we found if we're out of keys */ | |
2096 ; | |
2097 else if (NILP (cmd)) | |
2098 /* Found nothing (though perhaps parent map may have binding) */ | |
2099 ; | |
2100 else if (NILP (Fkeymapp (cmd))) | |
2101 /* Didn't find a keymap, and we have more keys. | |
2102 * Return a fixnum to indicate that keys were too long. | |
2103 */ | |
2104 cmd = make_int (keys_so_far + 1); | |
2105 else | |
2106 cmd = raw_lookup_key (cmd, raw_keys + 1, remaining, | |
2107 keys_so_far + 1, accept_default); | |
2108 } | |
2109 else | |
2110 { | |
2111 /* This is a hack so that looking up a key-sequence whose last | |
2112 * element is the meta-prefix-char will return the keymap that | |
2113 * the "meta" keys are stored in, if there is no binding for | |
2114 * the meta-prefix-char (and if this map has a "meta" submap). | |
2115 * If this map doesn't have a "meta" submap, then the | |
2116 * meta-prefix-char is looked up just like any other key. | |
2117 */ | |
2118 if (remaining == 0) | |
2119 { | |
2120 /* First look for the prefix-char directly */ | |
2121 cmd = keymap_lookup_1 (k, &(raw_keys[0]), accept_default); | |
2122 if (NILP (cmd)) | |
2123 { | |
2124 /* Do kludgy return of the meta-map */ | |
442 | 2125 cmd = Fgethash (MAKE_MODIFIER_HASH_KEY (XEMACS_MOD_META), |
428 | 2126 XKEYMAP (k)->table, Qnil); |
2127 } | |
2128 } | |
2129 else | |
2130 { | |
2131 /* Search for the prefix-char-prefixed sequence directly */ | |
2132 cmd = keymap_lookup_1 (k, &(raw_keys[0]), accept_default); | |
2133 cmd = get_keymap (cmd, 0, 1); | |
2134 if (!NILP (cmd)) | |
2135 cmd = raw_lookup_key (cmd, raw_keys + 1, remaining, | |
2136 keys_so_far + 1, accept_default); | |
442 | 2137 else if ((raw_keys[1].modifiers & XEMACS_MOD_META) == 0) |
428 | 2138 { |
934 | 2139 Lisp_Key_Data metified; |
428 | 2140 metified.keysym = raw_keys[1].keysym; |
442 | 2141 metified.modifiers = raw_keys[1].modifiers | |
2142 (unsigned char) XEMACS_MOD_META; | |
428 | 2143 |
2144 /* Search for meta-next-char sequence directly */ | |
2145 cmd = keymap_lookup_1 (k, &metified, accept_default); | |
2146 if (remaining == 1) | |
2147 ; | |
2148 else | |
2149 { | |
2150 cmd = get_keymap (cmd, 0, 1); | |
2151 if (!NILP (cmd)) | |
2152 cmd = raw_lookup_key (cmd, raw_keys + 2, remaining - 1, | |
2153 keys_so_far + 2, | |
2154 accept_default); | |
2155 } | |
2156 } | |
2157 } | |
2158 } | |
2159 if (accept_default && NILP (cmd)) | |
2160 cmd = XKEYMAP (k)->default_binding; | |
2161 return cmd; | |
2162 } | |
2163 | |
2164 /* Value is number if `keys' is too long; NIL if valid but has no definition.*/ | |
2165 /* Caller should gc-protect arguments */ | |
2166 static Lisp_Object | |
2167 lookup_keys (Lisp_Object keymap, int nkeys, Lisp_Object *keys, | |
2168 int accept_default) | |
2169 { | |
2170 /* This function can GC */ | |
934 | 2171 Lisp_Key_Data kkk[20]; |
2172 Lisp_Key_Data *raw_keys; | |
428 | 2173 int i; |
2174 | |
2175 if (nkeys == 0) | |
2176 return Qnil; | |
2177 | |
438 | 2178 if (nkeys < countof (kkk)) |
428 | 2179 raw_keys = kkk; |
2180 else | |
934 | 2181 raw_keys = alloca_array (Lisp_Key_Data, nkeys); |
428 | 2182 |
2183 for (i = 0; i < nkeys; i++) | |
2184 { | |
2185 define_key_parser (keys[i], &(raw_keys[i])); | |
2186 } | |
2187 return raw_lookup_key (keymap, raw_keys, nkeys, 0, accept_default); | |
2188 } | |
2189 | |
2190 static Lisp_Object | |
2191 lookup_events (Lisp_Object event_head, int nmaps, Lisp_Object keymaps[], | |
2192 int accept_default) | |
2193 { | |
2194 /* This function can GC */ | |
934 | 2195 Lisp_Key_Data kkk[20]; |
428 | 2196 Lisp_Object event; |
2197 | |
2198 int nkeys; | |
934 | 2199 Lisp_Key_Data *raw_keys; |
428 | 2200 Lisp_Object tem = Qnil; |
2201 struct gcpro gcpro1, gcpro2; | |
2202 int iii; | |
2203 | |
2204 CHECK_LIVE_EVENT (event_head); | |
2205 | |
2206 nkeys = event_chain_count (event_head); | |
2207 | |
438 | 2208 if (nkeys < countof (kkk)) |
428 | 2209 raw_keys = kkk; |
2210 else | |
934 | 2211 raw_keys = alloca_array (Lisp_Key_Data, nkeys); |
428 | 2212 |
2213 nkeys = 0; | |
2214 EVENT_CHAIN_LOOP (event, event_head) | |
2215 define_key_parser (event, &(raw_keys[nkeys++])); | |
2216 GCPRO2 (keymaps[0], event_head); | |
2217 gcpro1.nvars = nmaps; | |
2218 /* ####raw_keys[].keysym slots aren't gc-protected. We rely (but shouldn't) | |
2219 * on somebody else somewhere (obarray) having a pointer to all keysyms. */ | |
2220 for (iii = 0; iii < nmaps; iii++) | |
2221 { | |
2222 tem = raw_lookup_key (keymaps[iii], raw_keys, nkeys, 0, | |
2223 accept_default); | |
2224 if (INTP (tem)) | |
2225 { | |
2226 /* Too long in some local map means don't look at global map */ | |
2227 tem = Qnil; | |
2228 break; | |
2229 } | |
2230 else if (!NILP (tem)) | |
2231 break; | |
2232 } | |
2233 UNGCPRO; | |
2234 return tem; | |
2235 } | |
2236 | |
2237 DEFUN ("lookup-key", Flookup_key, 2, 3, 0, /* | |
2238 In keymap KEYMAP, look up key-sequence KEYS. Return the definition. | |
2239 Nil is returned if KEYS is unbound. See documentation of `define-key' | |
2240 for valid key definitions and key-sequence specifications. | |
2241 A number is returned if KEYS is "too long"; that is, the leading | |
2242 characters fail to be a valid sequence of prefix characters in KEYMAP. | |
444 | 2243 The number is how many key strokes at the front of KEYS it takes to |
2244 reach a non-prefix command. | |
428 | 2245 */ |
2246 (keymap, keys, accept_default)) | |
2247 { | |
2248 /* This function can GC */ | |
2249 if (VECTORP (keys)) | |
2250 return lookup_keys (keymap, | |
2251 XVECTOR_LENGTH (keys), | |
2252 XVECTOR_DATA (keys), | |
2253 !NILP (accept_default)); | |
2254 else if (SYMBOLP (keys) || CHAR_OR_CHAR_INTP (keys) || CONSP (keys)) | |
2255 return lookup_keys (keymap, 1, &keys, !NILP (accept_default)); | |
2256 else if (STRINGP (keys)) | |
2257 { | |
826 | 2258 int length = string_char_length (keys); |
428 | 2259 int i; |
934 | 2260 Lisp_Key_Data *raw_keys = alloca_array (Lisp_Key_Data, length); |
428 | 2261 if (length == 0) |
2262 return Qnil; | |
2263 | |
2264 for (i = 0; i < length; i++) | |
2265 { | |
867 | 2266 Ichar n = string_ichar (keys, i); |
428 | 2267 define_key_parser (make_char (n), &(raw_keys[i])); |
2268 } | |
2269 return raw_lookup_key (keymap, raw_keys, length, 0, | |
2270 !NILP (accept_default)); | |
2271 } | |
2272 else | |
2273 { | |
2274 keys = wrong_type_argument (Qsequencep, keys); | |
2275 return Flookup_key (keymap, keys, accept_default); | |
2276 } | |
2277 } | |
2278 | |
2279 /* Given a key sequence, returns a list of keymaps to search for bindings. | |
2280 Does all manner of semi-hairy heuristics, like looking in the current | |
2281 buffer's map before looking in the global map and looking in the local | |
2282 map of the buffer in which the mouse was clicked in event0 is a click. | |
2283 | |
2284 It would be kind of nice if this were in Lisp so that this semi-hairy | |
2285 semi-heuristic command-lookup behavior could be readily understood and | |
2286 customised. However, this needs to be pretty fast, or performance of | |
2287 keyboard macros goes to shit; putting this in lisp slows macros down | |
2288 2-3x. And they're already slower than v18 by 5-6x. | |
2289 */ | |
2290 | |
2291 struct relevant_maps | |
2292 { | |
2293 int nmaps; | |
647 | 2294 int max_maps; |
428 | 2295 Lisp_Object *maps; |
2296 struct gcpro *gcpro; | |
2297 }; | |
2298 | |
2299 static void get_relevant_extent_keymaps (Lisp_Object pos, | |
2300 Lisp_Object buffer_or_string, | |
2301 Lisp_Object glyph, | |
2302 struct relevant_maps *closure); | |
2303 static void get_relevant_minor_maps (Lisp_Object buffer, | |
2304 struct relevant_maps *closure); | |
2305 | |
2306 static void | |
2307 relevant_map_push (Lisp_Object map, struct relevant_maps *closure) | |
2308 { | |
647 | 2309 int nmaps = closure->nmaps; |
428 | 2310 |
2311 if (!KEYMAPP (map)) | |
2312 return; | |
2313 closure->nmaps = nmaps + 1; | |
2314 if (nmaps < closure->max_maps) | |
2315 { | |
2316 closure->maps[nmaps] = map; | |
2317 closure->gcpro->nvars = nmaps; | |
2318 } | |
2319 } | |
2320 | |
2321 static int | |
2322 get_relevant_keymaps (Lisp_Object keys, | |
2323 int max_maps, Lisp_Object maps[]) | |
2324 { | |
2325 /* This function can GC */ | |
2326 Lisp_Object terminal = Qnil; | |
2327 struct gcpro gcpro1; | |
2328 struct relevant_maps closure; | |
2329 struct console *con; | |
2330 | |
2331 GCPRO1 (*maps); | |
2332 gcpro1.nvars = 0; | |
2333 closure.nmaps = 0; | |
2334 closure.max_maps = max_maps; | |
2335 closure.maps = maps; | |
2336 closure.gcpro = &gcpro1; | |
2337 | |
2338 if (EVENTP (keys)) | |
2339 terminal = event_chain_tail (keys); | |
2340 else if (VECTORP (keys)) | |
2341 { | |
2342 int len = XVECTOR_LENGTH (keys); | |
2343 if (len > 0) | |
2344 terminal = XVECTOR_DATA (keys)[len - 1]; | |
2345 } | |
2346 | |
2347 if (EVENTP (terminal)) | |
2348 { | |
2349 CHECK_LIVE_EVENT (terminal); | |
2350 con = event_console_or_selected (terminal); | |
2351 } | |
2352 else | |
2353 con = XCONSOLE (Vselected_console); | |
2354 | |
2355 if (KEYMAPP (con->overriding_terminal_local_map) | |
2356 || KEYMAPP (Voverriding_local_map)) | |
2357 { | |
2358 if (KEYMAPP (con->overriding_terminal_local_map)) | |
2359 relevant_map_push (con->overriding_terminal_local_map, &closure); | |
2360 if (KEYMAPP (Voverriding_local_map)) | |
2361 relevant_map_push (Voverriding_local_map, &closure); | |
2362 } | |
2363 else if (!EVENTP (terminal) | |
2364 || (XEVENT (terminal)->event_type != button_press_event | |
2365 && XEVENT (terminal)->event_type != button_release_event)) | |
2366 { | |
793 | 2367 Lisp_Object tem = wrap_buffer (current_buffer); |
2368 | |
428 | 2369 /* It's not a mouse event; order of keymaps searched is: |
2370 o keymap of any/all extents under the mouse | |
2371 o minor-mode maps | |
2372 o local-map of current-buffer | |
771 | 2373 o global-tty-map or global-window-system-map |
428 | 2374 o global-map |
2375 */ | |
2376 /* The terminal element of the lookup may be nil or a keysym. | |
2377 In those cases we don't want to check for an extent | |
2378 keymap. */ | |
2379 if (EVENTP (terminal)) | |
2380 { | |
2381 get_relevant_extent_keymaps (make_int (BUF_PT (current_buffer)), | |
2382 tem, Qnil, &closure); | |
2383 } | |
2384 get_relevant_minor_maps (tem, &closure); | |
2385 | |
2386 tem = current_buffer->keymap; | |
2387 if (!NILP (tem)) | |
2388 relevant_map_push (tem, &closure); | |
2389 } | |
2390 #ifdef HAVE_WINDOW_SYSTEM | |
2391 else | |
2392 { | |
2393 /* It's a mouse event; order of keymaps searched is: | |
2394 o vertical-divider-map, if event is over a divider | |
2395 o local-map of mouse-grabbed-buffer | |
2396 o keymap of any/all extents under the mouse | |
2397 if the mouse is over a modeline: | |
2398 o modeline-map of buffer corresponding to that modeline | |
2399 o else, local-map of buffer under the mouse | |
2400 o minor-mode maps | |
2401 o local-map of current-buffer | |
771 | 2402 o global-tty-map or global-window-system-map |
428 | 2403 o global-map |
2404 */ | |
2405 Lisp_Object window = Fevent_window (terminal); | |
2406 | |
2407 if (!NILP (Fevent_over_vertical_divider_p (terminal))) | |
2408 { | |
2409 if (KEYMAPP (Vvertical_divider_map)) | |
2410 relevant_map_push (Vvertical_divider_map, &closure); | |
2411 } | |
2412 | |
2413 if (BUFFERP (Vmouse_grabbed_buffer)) | |
2414 { | |
2415 Lisp_Object map = XBUFFER (Vmouse_grabbed_buffer)->keymap; | |
2416 | |
2417 get_relevant_minor_maps (Vmouse_grabbed_buffer, &closure); | |
2418 if (!NILP (map)) | |
2419 relevant_map_push (map, &closure); | |
2420 } | |
2421 | |
2422 if (!NILP (window)) | |
2423 { | |
2424 Lisp_Object buffer = Fwindow_buffer (window); | |
2425 | |
2426 if (!NILP (buffer)) | |
2427 { | |
2428 if (!NILP (Fevent_over_modeline_p (terminal))) | |
2429 { | |
2430 Lisp_Object map = symbol_value_in_buffer (Qmodeline_map, | |
2431 buffer); | |
2432 | |
2433 get_relevant_extent_keymaps | |
2434 (Fevent_modeline_position (terminal), | |
2435 XBUFFER (buffer)->generated_modeline_string, | |
438 | 2436 Fevent_glyph_extent (terminal), &closure); |
428 | 2437 |
2438 if (!UNBOUNDP (map) && !NILP (map)) | |
2439 relevant_map_push (get_keymap (map, 1, 1), &closure); | |
2440 } | |
2441 else | |
2442 { | |
2443 get_relevant_extent_keymaps (Fevent_point (terminal), buffer, | |
2444 Fevent_glyph_extent (terminal), | |
2445 &closure); | |
2446 } | |
2447 | |
2448 if (!EQ (buffer, Vmouse_grabbed_buffer)) /* already pushed */ | |
2449 { | |
2450 Lisp_Object map = XBUFFER (buffer)->keymap; | |
2451 | |
2452 get_relevant_minor_maps (buffer, &closure); | |
2453 if (!NILP(map)) | |
2454 relevant_map_push (map, &closure); | |
2455 } | |
2456 } | |
2457 } | |
2458 else if (!NILP (Fevent_over_toolbar_p (terminal))) | |
2459 { | |
2460 Lisp_Object map = Fsymbol_value (Qtoolbar_map); | |
2461 | |
2462 if (!UNBOUNDP (map) && !NILP (map)) | |
2463 relevant_map_push (map, &closure); | |
2464 } | |
2465 } | |
2466 #endif /* HAVE_WINDOW_SYSTEM */ | |
2467 | |
771 | 2468 if (CONSOLE_TTY_P (con)) |
2469 relevant_map_push (Vglobal_tty_map, &closure); | |
2470 else | |
2471 relevant_map_push (Vglobal_window_system_map, &closure); | |
2472 | |
428 | 2473 { |
2474 int nmaps = closure.nmaps; | |
2475 /* Silently truncate at 100 keymaps to prevent infinite lossage */ | |
2476 if (nmaps >= max_maps && max_maps > 0) | |
2477 maps[max_maps - 1] = Vcurrent_global_map; | |
2478 else | |
2479 maps[nmaps] = Vcurrent_global_map; | |
2480 UNGCPRO; | |
2481 return nmaps + 1; | |
2482 } | |
2483 } | |
2484 | |
2485 /* Returns a set of keymaps extracted from the extents at POS in | |
2486 BUFFER_OR_STRING. The GLYPH arg, if specified, is one more extent | |
2487 to look for a keymap in, and if it has one, its keymap will be the | |
2488 first element in the list returned. This is so we can correctly | |
2489 search the keymaps associated with glyphs which may be physically | |
2490 disjoint from their extents: for example, if a glyph is out in the | |
2491 margin, we should still consult the keymap of that glyph's extent, | |
2492 which may not itself be under the mouse. | |
2493 */ | |
2494 | |
2495 static void | |
2496 get_relevant_extent_keymaps (Lisp_Object pos, Lisp_Object buffer_or_string, | |
2497 Lisp_Object glyph, | |
2498 struct relevant_maps *closure) | |
2499 { | |
2500 /* This function can GC */ | |
2501 /* the glyph keymap, if any, comes first. | |
2502 (Processing it twice is no big deal: noop.) */ | |
2503 if (!NILP (glyph)) | |
2504 { | |
2505 Lisp_Object keymap = Fextent_property (glyph, Qkeymap, Qnil); | |
2506 if (!NILP (keymap)) | |
2507 relevant_map_push (get_keymap (keymap, 1, 1), closure); | |
2508 } | |
2509 | |
2510 /* Next check the extents at the text position, if any */ | |
2511 if (!NILP (pos)) | |
2512 { | |
2513 Lisp_Object extent; | |
2514 for (extent = Fextent_at (pos, buffer_or_string, Qkeymap, Qnil, Qnil); | |
2515 !NILP (extent); | |
2516 extent = Fextent_at (pos, buffer_or_string, Qkeymap, extent, Qnil)) | |
2517 { | |
2518 Lisp_Object keymap = Fextent_property (extent, Qkeymap, Qnil); | |
2519 if (!NILP (keymap)) | |
2520 relevant_map_push (get_keymap (keymap, 1, 1), closure); | |
2521 QUIT; | |
2522 } | |
2523 } | |
2524 } | |
2525 | |
2526 static Lisp_Object | |
2527 minor_mode_keymap_predicate (Lisp_Object assoc, Lisp_Object buffer) | |
2528 { | |
2529 /* This function can GC */ | |
2530 if (CONSP (assoc)) | |
2531 { | |
2532 Lisp_Object sym = XCAR (assoc); | |
2533 if (SYMBOLP (sym)) | |
2534 { | |
2535 Lisp_Object val = symbol_value_in_buffer (sym, buffer); | |
2536 if (!NILP (val) && !UNBOUNDP (val)) | |
2537 { | |
793 | 2538 return get_keymap (XCDR (assoc), 0, 1); |
428 | 2539 } |
2540 } | |
2541 } | |
2542 return Qnil; | |
2543 } | |
2544 | |
2545 static void | |
2546 get_relevant_minor_maps (Lisp_Object buffer, struct relevant_maps *closure) | |
2547 { | |
2548 /* This function can GC */ | |
2549 Lisp_Object alist; | |
2550 | |
2551 /* Will you ever lose badly if you make this circular! */ | |
2552 for (alist = symbol_value_in_buffer (Qminor_mode_map_alist, buffer); | |
2553 CONSP (alist); | |
2554 alist = XCDR (alist)) | |
2555 { | |
2556 Lisp_Object m = minor_mode_keymap_predicate (XCAR (alist), | |
2557 buffer); | |
2558 if (!NILP (m)) relevant_map_push (m, closure); | |
2559 QUIT; | |
2560 } | |
2561 } | |
2562 | |
2563 /* #### Would map-current-keymaps be a better thing?? */ | |
2564 DEFUN ("current-keymaps", Fcurrent_keymaps, 0, 1, 0, /* | |
2565 Return a list of the current keymaps that will be searched for bindings. | |
2566 This lists keymaps such as the current local map and the minor-mode maps, | |
2567 but does not list the parents of those keymaps. | |
2568 EVENT-OR-KEYS controls which keymaps will be listed. | |
2569 If EVENT-OR-KEYS is a mouse event (or a vector whose last element is a | |
2570 mouse event), the keymaps for that mouse event will be listed (see | |
2571 `key-binding'). Otherwise, the keymaps for key presses will be listed. | |
771 | 2572 See `key-binding' for a description of which keymaps are searched in |
2573 various situations. | |
428 | 2574 */ |
2575 (event_or_keys)) | |
2576 { | |
2577 /* This function can GC */ | |
2578 struct gcpro gcpro1; | |
2579 Lisp_Object maps[100]; | |
2580 Lisp_Object *gubbish = maps; | |
2581 int nmaps; | |
2582 | |
2583 GCPRO1 (event_or_keys); | |
2584 nmaps = get_relevant_keymaps (event_or_keys, countof (maps), | |
2585 gubbish); | |
2586 if (nmaps > countof (maps)) | |
2587 { | |
2588 gubbish = alloca_array (Lisp_Object, nmaps); | |
2589 nmaps = get_relevant_keymaps (event_or_keys, nmaps, gubbish); | |
2590 } | |
2591 UNGCPRO; | |
2592 return Flist (nmaps, gubbish); | |
2593 } | |
2594 | |
2595 DEFUN ("key-binding", Fkey_binding, 1, 2, 0, /* | |
2596 Return the binding for command KEYS in current keymaps. | |
2597 KEYS is a string, a vector of events, or a vector of key-description lists | |
2598 as described in the documentation for the `define-key' function. | |
2599 The binding is probably a symbol with a function definition; see | |
2600 the documentation for `lookup-key' for more information. | |
2601 | |
2602 For key-presses, the order of keymaps searched is: | |
2603 - the `keymap' property of any extent(s) at point; | |
2604 - any applicable minor-mode maps; | |
444 | 2605 - the current local map of the current-buffer; |
771 | 2606 - either `global-tty-map' or `global-window-system-map', depending on |
2607 whether the current console is a TTY or non-TTY console; | |
428 | 2608 - the current global map. |
2609 | |
2610 For mouse-clicks, the order of keymaps searched is: | |
2611 - the current-local-map of the `mouse-grabbed-buffer' if any; | |
2612 - vertical-divider-map, if the event happened over a vertical divider | |
2613 - the `keymap' property of any extent(s) at the position of the click | |
2614 (this includes modeline extents); | |
2615 - the modeline-map of the buffer corresponding to the modeline under | |
2616 the mouse (if the click happened over a modeline); | |
444 | 2617 - the value of `toolbar-map' in the current-buffer (if the click |
428 | 2618 happened over a toolbar); |
444 | 2619 - the current local map of the buffer under the mouse (does not |
428 | 2620 apply to toolbar clicks); |
2621 - any applicable minor-mode maps; | |
771 | 2622 - either `global-tty-map' or `global-window-system-map', depending on |
2623 whether the current console is a TTY or non-TTY console; | |
428 | 2624 - the current global map. |
2625 | |
2626 Note that if `overriding-local-map' or `overriding-terminal-local-map' | |
2627 is non-nil, *only* those two maps and the current global map are searched. | |
771 | 2628 |
2629 Note also that key sequences actually received from the keyboard driver | |
2630 may be processed in various ways to generate the key sequence that is | |
2631 actually looked up in the keymaps. In particular: | |
2632 | |
2633 -- Keysyms are individually passed through `keyboard-translate-table' before | |
2634 any other processing. | |
2635 -- After this, key sequences as a whole are passed through | |
2636 `key-translation-map'. | |
2637 -- The resulting key sequence is actually looked up in the keymaps. | |
2638 -- If there's no binding found, the key sequence is passed through | |
2639 `function-key-map' and looked up again. | |
2640 -- If no binding is found and `retry-undefined-key-binding-unshifted' is | |
2641 set (it usually is) and the final keysym is an uppercase character, | |
2642 we lowercase it and start over from the `key-translation-map' stage. | |
2643 -- If no binding is found and we're on MS Windows and have international | |
2644 support, we successively remap the key sequence using the keyboard layouts | |
2645 of various default locales (current language environment, user default, | |
2646 system default, US ASCII) and try again. This makes (e.g.) sequences | |
2647 such as `C-x b' work in a Russian locale, where the alphabetic keys are | |
2648 actually generating Russian characters and not the Roman letters written | |
2649 on the keycaps. (Not yet implemented) | |
2650 -- Finally, if the last keystroke matches `help-char', we automatically | |
2651 generate and display a list of possible key sequences and bindings | |
2652 given the prefix so far generated. | |
428 | 2653 */ |
2654 (keys, accept_default)) | |
2655 { | |
2656 /* This function can GC */ | |
2657 int i; | |
2658 Lisp_Object maps[100]; | |
2659 int nmaps; | |
2660 struct gcpro gcpro1, gcpro2; | |
2661 GCPRO2 (keys, accept_default); /* get_relevant_keymaps may autoload */ | |
2662 | |
2663 nmaps = get_relevant_keymaps (keys, countof (maps), maps); | |
2664 | |
2665 UNGCPRO; | |
2666 | |
2667 if (EVENTP (keys)) /* unadvertised "feature" for the future */ | |
2668 return lookup_events (keys, nmaps, maps, !NILP (accept_default)); | |
2669 | |
2670 for (i = 0; i < nmaps; i++) | |
2671 { | |
2672 Lisp_Object tem = Flookup_key (maps[i], keys, | |
2673 accept_default); | |
2674 if (INTP (tem)) | |
2675 { | |
2676 /* Too long in some local map means don't look at global map */ | |
2677 return Qnil; | |
2678 } | |
2679 else if (!NILP (tem)) | |
2680 return tem; | |
2681 } | |
2682 return Qnil; | |
2683 } | |
2684 | |
2685 static Lisp_Object | |
2686 process_event_binding_result (Lisp_Object result) | |
2687 { | |
2688 if (EQ (result, Qundefined)) | |
3025 | 2689 /* The suppress-keymap function binds keys to `undefined' - special-case |
428 | 2690 that here, so that being bound to that has the same error-behavior as |
2691 not being defined at all. | |
2692 */ | |
2693 result = Qnil; | |
2694 if (!NILP (result)) | |
2695 { | |
2696 Lisp_Object map; | |
2697 /* Snap out possible keymap indirections */ | |
2698 map = get_keymap (result, 0, 1); | |
2699 if (!NILP (map)) | |
2700 result = map; | |
2701 } | |
2702 | |
2703 return result; | |
2704 } | |
2705 | |
2706 /* Attempts to find a command corresponding to the event-sequence | |
2707 whose head is event0 (sequence is threaded though event_next). | |
2708 | |
2709 The return value will be | |
2710 | |
2711 -- nil (there is no binding; this will also be returned | |
2712 whenever the event chain is "too long", i.e. there | |
2713 is a non-nil, non-keymap binding for a prefix of | |
2714 the event chain) | |
2715 -- a keymap (part of a command has been specified) | |
2716 -- a command (anything that satisfies `commandp'; this includes | |
2717 some symbols, lists, subrs, strings, vectors, and | |
2718 compiled-function objects) */ | |
2719 Lisp_Object | |
2720 event_binding (Lisp_Object event0, int accept_default) | |
2721 { | |
2722 /* This function can GC */ | |
2723 Lisp_Object maps[100]; | |
2724 int nmaps; | |
2725 | |
2726 assert (EVENTP (event0)); | |
2727 | |
2728 nmaps = get_relevant_keymaps (event0, countof (maps), maps); | |
2729 if (nmaps > countof (maps)) | |
2730 nmaps = countof (maps); | |
2731 return process_event_binding_result (lookup_events (event0, nmaps, maps, | |
2732 accept_default)); | |
2733 } | |
2734 | |
2735 /* like event_binding, but specify a keymap to search */ | |
2736 | |
2737 Lisp_Object | |
2738 event_binding_in (Lisp_Object event0, Lisp_Object keymap, int accept_default) | |
2739 { | |
2740 /* This function can GC */ | |
2741 if (!KEYMAPP (keymap)) | |
2742 return Qnil; | |
2743 | |
2744 return process_event_binding_result (lookup_events (event0, 1, &keymap, | |
2745 accept_default)); | |
2746 } | |
2747 | |
2748 /* Attempts to find a function key mapping corresponding to the | |
2749 event-sequence whose head is event0 (sequence is threaded through | |
2750 event_next). The return value will be the same as for event_binding(). */ | |
2751 Lisp_Object | |
2752 munging_key_map_event_binding (Lisp_Object event0, | |
2753 enum munge_me_out_the_door munge) | |
2754 { | |
2755 Lisp_Object keymap = (munge == MUNGE_ME_FUNCTION_KEY) ? | |
2756 CONSOLE_FUNCTION_KEY_MAP (event_console_or_selected (event0)) : | |
2757 Vkey_translation_map; | |
2758 | |
2759 if (NILP (keymap)) | |
2760 return Qnil; | |
2761 | |
2762 return process_event_binding_result (lookup_events (event0, 1, &keymap, 1)); | |
2763 } | |
2764 | |
2765 | |
2766 /************************************************************************/ | |
2767 /* Setting/querying the global and local maps */ | |
2768 /************************************************************************/ | |
2769 | |
2770 DEFUN ("use-global-map", Fuse_global_map, 1, 1, 0, /* | |
2771 Select KEYMAP as the global keymap. | |
2772 */ | |
2773 (keymap)) | |
2774 { | |
2775 /* This function can GC */ | |
2776 keymap = get_keymap (keymap, 1, 1); | |
2777 Vcurrent_global_map = keymap; | |
2778 return Qnil; | |
2779 } | |
2780 | |
2781 DEFUN ("use-local-map", Fuse_local_map, 1, 2, 0, /* | |
2782 Select KEYMAP as the local keymap in BUFFER. | |
2783 If KEYMAP is nil, that means no local keymap. | |
2784 If BUFFER is nil, the current buffer is assumed. | |
2785 */ | |
2786 (keymap, buffer)) | |
2787 { | |
2788 /* This function can GC */ | |
2789 struct buffer *b = decode_buffer (buffer, 0); | |
2790 if (!NILP (keymap)) | |
2791 keymap = get_keymap (keymap, 1, 1); | |
2792 | |
2793 b->keymap = keymap; | |
2794 | |
2795 return Qnil; | |
2796 } | |
2797 | |
2798 DEFUN ("current-local-map", Fcurrent_local_map, 0, 1, 0, /* | |
2799 Return BUFFER's local keymap, or nil if it has none. | |
2800 If BUFFER is nil, the current buffer is assumed. | |
2801 */ | |
2802 (buffer)) | |
2803 { | |
2804 struct buffer *b = decode_buffer (buffer, 0); | |
2805 return b->keymap; | |
2806 } | |
2807 | |
2808 DEFUN ("current-global-map", Fcurrent_global_map, 0, 0, 0, /* | |
2809 Return the current global keymap. | |
2810 */ | |
2811 ()) | |
2812 { | |
2813 return Vcurrent_global_map; | |
2814 } | |
2815 | |
2816 | |
2817 /************************************************************************/ | |
2818 /* Mapping over keymap elements */ | |
2819 /************************************************************************/ | |
2820 | |
2821 /* Since keymaps are arranged in a hierarchy, one keymap per bucky bit or | |
2822 prefix key, it's not entirely obvious what map-keymap should do, but | |
2823 what it does is: map over all keys in this map; then recursively map | |
2824 over all submaps of this map that are "bucky" submaps. This means that, | |
2825 when mapping over a keymap, it appears that "x" and "C-x" are in the | |
2826 same map, although "C-x" is really in the "control" submap of this one. | |
2827 However, since we don't recursively descend the submaps that are bound | |
2828 to prefix keys (like C-x, C-h, etc) the caller will have to recurse on | |
2829 those explicitly, if that's what they want. | |
2830 | |
2831 So the end result of this is that the bucky keymaps (the ones indexed | |
2832 under the large integers returned from MAKE_MODIFIER_HASH_KEY()) are | |
2833 invisible from elisp. They're just an implementation detail that code | |
2834 outside of this file doesn't need to know about. | |
2835 */ | |
2836 | |
2837 struct map_keymap_unsorted_closure | |
2838 { | |
934 | 2839 void (*fn) (const Lisp_Key_Data *, Lisp_Object binding, void *arg); |
428 | 2840 void *arg; |
442 | 2841 int modifiers; |
428 | 2842 }; |
2843 | |
2844 /* used by map_keymap() */ | |
2845 static int | |
2846 map_keymap_unsorted_mapper (Lisp_Object keysym, Lisp_Object value, | |
2847 void *map_keymap_unsorted_closure) | |
2848 { | |
2849 /* This function can GC */ | |
2850 struct map_keymap_unsorted_closure *closure = | |
2851 (struct map_keymap_unsorted_closure *) map_keymap_unsorted_closure; | |
442 | 2852 int modifiers = closure->modifiers; |
2853 int mod_bit; | |
428 | 2854 mod_bit = MODIFIER_HASH_KEY_BITS (keysym); |
2855 if (mod_bit != 0) | |
2856 { | |
2857 int omod = modifiers; | |
2858 closure->modifiers = (modifiers | mod_bit); | |
2859 value = get_keymap (value, 1, 0); | |
2860 elisp_maphash (map_keymap_unsorted_mapper, | |
2861 XKEYMAP (value)->table, | |
2862 map_keymap_unsorted_closure); | |
2863 closure->modifiers = omod; | |
2864 } | |
2865 else | |
2866 { | |
934 | 2867 Lisp_Key_Data key; |
428 | 2868 key.keysym = keysym; |
2869 key.modifiers = modifiers; | |
2870 ((*closure->fn) (&key, value, closure->arg)); | |
2871 } | |
2872 return 0; | |
2873 } | |
2874 | |
2875 | |
2876 struct map_keymap_sorted_closure | |
2877 { | |
2878 Lisp_Object *result_locative; | |
2879 }; | |
2880 | |
2881 /* used by map_keymap_sorted() */ | |
2882 static int | |
2883 map_keymap_sorted_mapper (Lisp_Object key, Lisp_Object value, | |
2884 void *map_keymap_sorted_closure) | |
2885 { | |
2886 struct map_keymap_sorted_closure *cl = | |
2887 (struct map_keymap_sorted_closure *) map_keymap_sorted_closure; | |
2888 Lisp_Object *list = cl->result_locative; | |
2889 *list = Fcons (Fcons (key, value), *list); | |
2890 return 0; | |
2891 } | |
2892 | |
2893 | |
2894 /* used by map_keymap_sorted(), describe_map_sort_predicate(), | |
2895 and keymap_submaps(). | |
2896 */ | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2897 static Lisp_Object |
428 | 2898 map_keymap_sort_predicate (Lisp_Object obj1, Lisp_Object obj2, |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2899 Lisp_Object UNUSED (pred), |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2900 Lisp_Object UNUSED (key_func)) |
428 | 2901 { |
2902 /* obj1 and obj2 are conses with keysyms in their cars. Cdrs are ignored. | |
2903 */ | |
442 | 2904 int bit1, bit2; |
428 | 2905 int sym1_p = 0; |
2906 int sym2_p = 0; | |
2828 | 2907 extern Lisp_Object Qcharacter_of_keysym; |
2908 | |
428 | 2909 obj1 = XCAR (obj1); |
2910 obj2 = XCAR (obj2); | |
2911 | |
2912 if (EQ (obj1, obj2)) | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2913 return Qnil; |
428 | 2914 bit1 = MODIFIER_HASH_KEY_BITS (obj1); |
2915 bit2 = MODIFIER_HASH_KEY_BITS (obj2); | |
2916 | |
2828 | 2917 /* If either is a symbol with a Qcharacter_of_keysym property, then sort it by |
428 | 2918 that code instead of alphabetically. |
2919 */ | |
2920 if (! bit1 && SYMBOLP (obj1)) | |
2921 { | |
2828 | 2922 Lisp_Object code = Fget (obj1, Qcharacter_of_keysym, Qnil); |
428 | 2923 if (CHAR_OR_CHAR_INTP (code)) |
2924 { | |
2925 obj1 = code; | |
2926 CHECK_CHAR_COERCE_INT (obj1); | |
2927 sym1_p = 1; | |
2928 } | |
2929 } | |
2930 if (! bit2 && SYMBOLP (obj2)) | |
2931 { | |
2828 | 2932 Lisp_Object code = Fget (obj2, Qcharacter_of_keysym, Qnil); |
428 | 2933 if (CHAR_OR_CHAR_INTP (code)) |
2934 { | |
2935 obj2 = code; | |
2936 CHECK_CHAR_COERCE_INT (obj2); | |
2937 sym2_p = 1; | |
2938 } | |
2939 } | |
2940 | |
2941 /* all symbols (non-ASCIIs) come after characters (ASCIIs) */ | |
2942 if (XTYPE (obj1) != XTYPE (obj2)) | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2943 return SYMBOLP (obj2) ? Qt : Qnil; |
428 | 2944 |
2945 if (! bit1 && CHARP (obj1)) /* they're both ASCII */ | |
2946 { | |
2947 int o1 = XCHAR (obj1); | |
2948 int o2 = XCHAR (obj2); | |
2949 if (o1 == o2 && /* If one started out as a symbol and the */ | |
2950 sym1_p != sym2_p) /* other didn't, the symbol comes last. */ | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2951 return sym2_p ? Qt : Qnil; |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2952 |
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2953 return o1 < o2 ? Qt : Qnil; /* else just compare them */ |
428 | 2954 } |
2955 | |
2956 /* else they're both symbols. If they're both buckys, then order them. */ | |
2957 if (bit1 && bit2) | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2958 return bit1 < bit2 ? Qt : Qnil; |
428 | 2959 |
2960 /* if only one is a bucky, then it comes later */ | |
2961 if (bit1 || bit2) | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2962 return bit2 ? Qt : Qnil; |
428 | 2963 |
2964 /* otherwise, string-sort them. */ | |
2965 { | |
867 | 2966 Ibyte *s1 = XSTRING_DATA (XSYMBOL (obj1)->name); |
2967 Ibyte *s2 = XSTRING_DATA (XSYMBOL (obj2)->name); | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2968 return 0 > qxestrcmp (s1, s2) ? Qt : Qnil; |
428 | 2969 } |
2970 } | |
2971 | |
2972 | |
2973 /* used by map_keymap() */ | |
2974 static void | |
2975 map_keymap_sorted (Lisp_Object keymap_table, | |
442 | 2976 int modifiers, |
934 | 2977 void (*function) (const Lisp_Key_Data *key, |
428 | 2978 Lisp_Object binding, |
2979 void *map_keymap_sorted_closure), | |
2980 void *map_keymap_sorted_closure) | |
2981 { | |
2982 /* This function can GC */ | |
2983 struct gcpro gcpro1; | |
2984 Lisp_Object contents = Qnil; | |
2985 | |
2986 if (XINT (Fhash_table_count (keymap_table)) == 0) | |
2987 return; | |
2988 | |
2989 GCPRO1 (contents); | |
2990 | |
2991 { | |
2992 struct map_keymap_sorted_closure c1; | |
2993 c1.result_locative = &contents; | |
2994 elisp_maphash (map_keymap_sorted_mapper, keymap_table, &c1); | |
2995 } | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
2996 contents = list_sort (contents, map_keymap_sort_predicate, Qnil, Qidentity); |
428 | 2997 for (; !NILP (contents); contents = XCDR (contents)) |
2998 { | |
2999 Lisp_Object keysym = XCAR (XCAR (contents)); | |
3000 Lisp_Object binding = XCDR (XCAR (contents)); | |
442 | 3001 int sub_bits = MODIFIER_HASH_KEY_BITS (keysym); |
428 | 3002 if (sub_bits != 0) |
3003 map_keymap_sorted (XKEYMAP (get_keymap (binding, | |
3004 1, 1))->table, | |
3005 (modifiers | sub_bits), | |
3006 function, | |
3007 map_keymap_sorted_closure); | |
3008 else | |
3009 { | |
934 | 3010 Lisp_Key_Data k; |
428 | 3011 k.keysym = keysym; |
3012 k.modifiers = modifiers; | |
3013 ((*function) (&k, binding, map_keymap_sorted_closure)); | |
3014 } | |
3015 } | |
3016 UNGCPRO; | |
3017 } | |
3018 | |
3019 | |
3020 /* used by Fmap_keymap() */ | |
3021 static void | |
934 | 3022 map_keymap_mapper (const Lisp_Key_Data *key, |
428 | 3023 Lisp_Object binding, |
3024 void *function) | |
3025 { | |
3026 /* This function can GC */ | |
3027 Lisp_Object fn; | |
5013 | 3028 fn = GET_LISP_FROM_VOID (function); |
428 | 3029 call2 (fn, make_key_description (key, 1), binding); |
3030 } | |
3031 | |
3032 | |
3033 static void | |
3034 map_keymap (Lisp_Object keymap_table, int sort_first, | |
934 | 3035 void (*function) (const Lisp_Key_Data *key, |
428 | 3036 Lisp_Object binding, |
3037 void *fn_arg), | |
3038 void *fn_arg) | |
3039 { | |
3040 /* This function can GC */ | |
3041 if (sort_first) | |
3042 map_keymap_sorted (keymap_table, 0, function, fn_arg); | |
3043 else | |
3044 { | |
3045 struct map_keymap_unsorted_closure map_keymap_unsorted_closure; | |
3046 map_keymap_unsorted_closure.fn = function; | |
3047 map_keymap_unsorted_closure.arg = fn_arg; | |
3048 map_keymap_unsorted_closure.modifiers = 0; | |
3049 elisp_maphash (map_keymap_unsorted_mapper, keymap_table, | |
3050 &map_keymap_unsorted_closure); | |
3051 } | |
3052 } | |
3053 | |
3054 DEFUN ("map-keymap", Fmap_keymap, 2, 3, 0, /* | |
3055 Apply FUNCTION to each element of KEYMAP. | |
3056 FUNCTION will be called with two arguments: a key-description list, and | |
3057 the binding. The order in which the elements of the keymap are passed to | |
3058 the function is unspecified. If the function inserts new elements into | |
3059 the keymap, it may or may not be called with them later. No element of | |
3060 the keymap will ever be passed to the function more than once. | |
3061 | |
3062 The function will not be called on elements of this keymap's parents | |
3063 \(see the function `keymap-parents') or upon keymaps which are contained | |
3064 within this keymap (multi-character definitions). | |
3065 It will be called on "meta" characters since they are not really | |
3066 two-character sequences. | |
3067 | |
3068 If the optional third argument SORT-FIRST is non-nil, then the elements of | |
3069 the keymap will be passed to the mapper function in a canonical order. | |
3070 Otherwise, they will be passed in hash (that is, random) order, which is | |
3071 faster. | |
3072 */ | |
3073 (function, keymap, sort_first)) | |
3074 { | |
3075 /* This function can GC */ | |
489 | 3076 struct gcpro gcpro1, gcpro2; |
428 | 3077 |
3078 /* tolerate obviously transposed args */ | |
3079 if (!NILP (Fkeymapp (function))) | |
3080 { | |
3081 Lisp_Object tmp = function; | |
3082 function = keymap; | |
3083 keymap = tmp; | |
3084 } | |
489 | 3085 GCPRO2 (function, keymap); |
428 | 3086 keymap = get_keymap (keymap, 1, 1); |
489 | 3087 map_keymap (XKEYMAP (keymap)->table, !NILP (sort_first), |
5013 | 3088 map_keymap_mapper, STORE_LISP_IN_VOID (function)); |
428 | 3089 UNGCPRO; |
3090 return Qnil; | |
3091 } | |
3092 | |
3093 | |
3094 | |
3095 /************************************************************************/ | |
3096 /* Accessible keymaps */ | |
3097 /************************************************************************/ | |
3098 | |
3099 struct accessible_keymaps_closure | |
3100 { | |
3101 Lisp_Object tail; | |
3102 }; | |
3103 | |
3104 | |
3105 static void | |
3106 accessible_keymaps_mapper_1 (Lisp_Object keysym, Lisp_Object contents, | |
442 | 3107 int modifiers, |
428 | 3108 struct accessible_keymaps_closure *closure) |
3109 { | |
3110 /* This function can GC */ | |
442 | 3111 int subbits = MODIFIER_HASH_KEY_BITS (keysym); |
428 | 3112 |
3113 if (subbits != 0) | |
3114 { | |
3115 Lisp_Object submaps; | |
3116 | |
3117 contents = get_keymap (contents, 1, 1); | |
3118 submaps = keymap_submaps (contents); | |
3119 for (; !NILP (submaps); submaps = XCDR (submaps)) | |
3120 { | |
3121 accessible_keymaps_mapper_1 (XCAR (XCAR (submaps)), | |
3122 XCDR (XCAR (submaps)), | |
3123 (subbits | modifiers), | |
3124 closure); | |
3125 } | |
3126 } | |
3127 else | |
3128 { | |
3129 Lisp_Object thisseq = Fcar (Fcar (closure->tail)); | |
3130 Lisp_Object cmd = get_keyelt (contents, 1); | |
3131 Lisp_Object vec; | |
3132 int j; | |
3133 int len; | |
934 | 3134 Lisp_Key_Data key; |
428 | 3135 key.keysym = keysym; |
3136 key.modifiers = modifiers; | |
3137 | |
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
3138 assert (!NILP (cmd)); |
428 | 3139 cmd = get_keymap (cmd, 0, 1); |
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
3140 assert (KEYMAPP (cmd)); |
428 | 3141 |
3142 vec = make_vector (XVECTOR_LENGTH (thisseq) + 1, Qnil); | |
3143 len = XVECTOR_LENGTH (thisseq); | |
3144 for (j = 0; j < len; j++) | |
3145 XVECTOR_DATA (vec) [j] = XVECTOR_DATA (thisseq) [j]; | |
3146 XVECTOR_DATA (vec) [j] = make_key_description (&key, 1); | |
3147 | |
3148 nconc2 (closure->tail, list1 (Fcons (vec, cmd))); | |
3149 } | |
3150 } | |
3151 | |
3152 | |
3153 static Lisp_Object | |
3154 accessible_keymaps_keymap_mapper (Lisp_Object thismap, void *arg) | |
3155 { | |
3156 /* This function can GC */ | |
3157 struct accessible_keymaps_closure *closure = | |
3158 (struct accessible_keymaps_closure *) arg; | |
3159 Lisp_Object submaps = keymap_submaps (thismap); | |
3160 | |
3161 for (; !NILP (submaps); submaps = XCDR (submaps)) | |
3162 { | |
3163 accessible_keymaps_mapper_1 (XCAR (XCAR (submaps)), | |
3164 XCDR (XCAR (submaps)), | |
3165 0, | |
3166 closure); | |
3167 } | |
3168 return Qnil; | |
3169 } | |
3170 | |
3171 | |
3172 DEFUN ("accessible-keymaps", Faccessible_keymaps, 1, 2, 0, /* | |
3173 Find all keymaps accessible via prefix characters from KEYMAP. | |
3174 Returns a list of elements of the form (KEYS . MAP), where the sequence | |
3175 KEYS starting from KEYMAP gets you to MAP. These elements are ordered | |
3176 so that the KEYS increase in length. The first element is ([] . KEYMAP). | |
3177 An optional argument PREFIX, if non-nil, should be a key sequence; | |
3178 then the value includes only maps for prefixes that start with PREFIX. | |
3179 */ | |
3180 (keymap, prefix)) | |
3181 { | |
3182 /* This function can GC */ | |
3183 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
3184 Lisp_Object accessible_keymaps = Qnil; | |
3185 struct accessible_keymaps_closure c; | |
3186 c.tail = Qnil; | |
3187 GCPRO4 (accessible_keymaps, c.tail, prefix, keymap); | |
3188 | |
440 | 3189 keymap = get_keymap (keymap, 1, 1); |
3190 | |
428 | 3191 retry: |
3192 if (NILP (prefix)) | |
3193 { | |
440 | 3194 prefix = make_vector (0, Qnil); |
428 | 3195 } |
440 | 3196 else if (VECTORP (prefix) || STRINGP (prefix)) |
428 | 3197 { |
3198 int len = XINT (Flength (prefix)); | |
440 | 3199 Lisp_Object def; |
428 | 3200 Lisp_Object p; |
3201 int iii; | |
3202 struct gcpro ngcpro1; | |
3203 | |
440 | 3204 if (len == 0) |
3205 { | |
3206 prefix = Qnil; | |
3207 goto retry; | |
3208 } | |
3209 | |
3210 def = Flookup_key (keymap, prefix, Qnil); | |
428 | 3211 def = get_keymap (def, 0, 1); |
3212 if (!KEYMAPP (def)) | |
3213 goto RETURN; | |
3214 | |
3215 keymap = def; | |
3216 p = make_vector (len, Qnil); | |
3217 NGCPRO1 (p); | |
3218 for (iii = 0; iii < len; iii++) | |
3219 { | |
934 | 3220 Lisp_Key_Data key; |
428 | 3221 define_key_parser (Faref (prefix, make_int (iii)), &key); |
3222 XVECTOR_DATA (p)[iii] = make_key_description (&key, 1); | |
3223 } | |
3224 NUNGCPRO; | |
3225 prefix = p; | |
3226 } | |
440 | 3227 else |
3228 { | |
3229 prefix = wrong_type_argument (Qarrayp, prefix); | |
3230 goto retry; | |
3231 } | |
428 | 3232 |
3233 accessible_keymaps = list1 (Fcons (prefix, keymap)); | |
3234 | |
440 | 3235 /* For each map in the list maps, look at any other maps it points |
3236 to and stick them at the end if they are not already in the list */ | |
428 | 3237 |
3238 for (c.tail = accessible_keymaps; | |
3239 !NILP (c.tail); | |
3240 c.tail = XCDR (c.tail)) | |
3241 { | |
3242 Lisp_Object thismap = Fcdr (Fcar (c.tail)); | |
3243 CHECK_KEYMAP (thismap); | |
3244 traverse_keymaps (thismap, Qnil, | |
3245 accessible_keymaps_keymap_mapper, &c); | |
3246 } | |
3247 RETURN: | |
3248 UNGCPRO; | |
3249 return accessible_keymaps; | |
3250 } | |
3251 | |
3252 | |
3253 | |
3254 /************************************************************************/ | |
3255 /* Pretty descriptions of key sequences */ | |
3256 /************************************************************************/ | |
3257 | |
3258 DEFUN ("key-description", Fkey_description, 1, 1, 0, /* | |
3259 Return a pretty description of key-sequence KEYS. | |
3260 Control characters turn into "C-foo" sequences, meta into "M-foo", | |
3261 spaces are put between sequence elements, etc... | |
3262 */ | |
3263 (keys)) | |
3264 { | |
3265 if (CHAR_OR_CHAR_INTP (keys) || CONSP (keys) || SYMBOLP (keys) | |
3266 || EVENTP (keys)) | |
3267 { | |
3268 return Fsingle_key_description (keys); | |
3269 } | |
3270 else if (VECTORP (keys) || | |
3271 STRINGP (keys)) | |
3272 { | |
3273 Lisp_Object string = Qnil; | |
3274 /* Lisp_Object sep = Qnil; */ | |
3275 int size = XINT (Flength (keys)); | |
3276 int i; | |
3277 | |
3278 for (i = 0; i < size; i++) | |
3279 { | |
3280 Lisp_Object s2 = Fsingle_key_description | |
3281 (STRINGP (keys) | |
867 | 3282 ? make_char (string_ichar (keys, i)) |
428 | 3283 : XVECTOR_DATA (keys)[i]); |
3284 | |
3285 if (i == 0) | |
3286 string = s2; | |
3287 else | |
3288 { | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
3289 /* if (NILP (sep)) Lisp_Object sep = build_ascstring (" ") */; |
428 | 3290 string = concat2 (string, concat2 (Vsingle_space_string, s2)); |
3291 } | |
3292 } | |
3293 return string; | |
3294 } | |
3295 return Fkey_description (wrong_type_argument (Qsequencep, keys)); | |
3296 } | |
3297 | |
3298 DEFUN ("single-key-description", Fsingle_key_description, 1, 1, 0, /* | |
3299 Return a pretty description of command character KEY. | |
3300 Control characters turn into C-whatever, etc. | |
3301 This differs from `text-char-description' in that it returns a description | |
3302 of a key read from the user rather than a character from a buffer. | |
3303 */ | |
3304 (key)) | |
3305 { | |
3306 if (SYMBOLP (key)) | |
3307 key = Fcons (key, Qnil); /* sleaze sleaze */ | |
3308 | |
3309 if (EVENTP (key) || CHAR_OR_CHAR_INTP (key)) | |
3310 { | |
793 | 3311 DECLARE_EISTRING_MALLOC (buf); |
3312 Lisp_Object str; | |
3313 | |
428 | 3314 if (!EVENTP (key)) |
3315 { | |
934 | 3316 Lisp_Object event = Fmake_event (Qnil, Qnil); |
3317 CHECK_CHAR_COERCE_INT (key); | |
1204 | 3318 character_to_event (XCHAR (key), XEVENT (event), |
4780
2fd201d73a92
Call character_to_event on characters received from XIM, event-Xt.c
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3319 XCONSOLE (Vselected_console), |
2fd201d73a92
Call character_to_event on characters received from XIM, event-Xt.c
Aidan Kehoe <kehoea@parhasard.net>
parents:
4355
diff
changeset
|
3320 high_bit_is_meta, 1); |
934 | 3321 format_event_object (buf, event, 1); |
1204 | 3322 Fdeallocate_event (event); |
934 | 3323 } |
3324 else | |
3325 format_event_object (buf, key, 1); | |
793 | 3326 str = eimake_string (buf); |
3327 eifree (buf); | |
3328 return str; | |
428 | 3329 } |
3330 | |
3331 if (CONSP (key)) | |
3332 { | |
793 | 3333 DECLARE_EISTRING (bufp); |
3334 | |
428 | 3335 Lisp_Object rest; |
3336 LIST_LOOP (rest, key) | |
3337 { | |
3338 Lisp_Object keysym = XCAR (rest); | |
2421 | 3339 if (EQ (keysym, Qcontrol)) eicat_ascii (bufp, "C-"); |
3340 else if (EQ (keysym, Qctrl)) eicat_ascii (bufp, "C-"); | |
3341 else if (EQ (keysym, Qmeta)) eicat_ascii (bufp, "M-"); | |
3342 else if (EQ (keysym, Qsuper)) eicat_ascii (bufp, "S-"); | |
3343 else if (EQ (keysym, Qhyper)) eicat_ascii (bufp, "H-"); | |
3344 else if (EQ (keysym, Qalt)) eicat_ascii (bufp, "A-"); | |
3345 else if (EQ (keysym, Qshift)) eicat_ascii (bufp, "Sh-"); | |
428 | 3346 else if (CHAR_OR_CHAR_INTP (keysym)) |
793 | 3347 eicat_ch (bufp, XCHAR_OR_CHAR_INT (keysym)); |
428 | 3348 else |
3349 { | |
3350 CHECK_SYMBOL (keysym); | |
3351 #if 0 /* This is bogus */ | |
2421 | 3352 if (EQ (keysym, QKlinefeed)) eicat_ascii (bufp, "LFD"); |
3353 else if (EQ (keysym, QKtab)) eicat_ascii (bufp, "TAB"); | |
3354 else if (EQ (keysym, QKreturn)) eicat_ascii (bufp, "RET"); | |
3355 else if (EQ (keysym, QKescape)) eicat_ascii (bufp, "ESC"); | |
3356 else if (EQ (keysym, QKdelete)) eicat_ascii (bufp, "DEL"); | |
3357 else if (EQ (keysym, QKspace)) eicat_ascii (bufp, "SPC"); | |
3358 else if (EQ (keysym, QKbackspace)) eicat_ascii (bufp, "BS"); | |
428 | 3359 else |
3360 #endif | |
793 | 3361 eicat_lstr (bufp, XSYMBOL (keysym)->name); |
428 | 3362 if (!NILP (XCDR (rest))) |
793 | 3363 invalid_argument ("Invalid key description", key); |
428 | 3364 } |
3365 } | |
793 | 3366 return eimake_string (bufp); |
428 | 3367 } |
3368 return Fsingle_key_description | |
3369 (wrong_type_argument (intern ("char-or-event-p"), key)); | |
3370 } | |
3371 | |
3372 DEFUN ("text-char-description", Ftext_char_description, 1, 1, 0, /* | |
3373 Return a pretty description of file-character CHR. | |
3374 Unprintable characters turn into "^char" or \\NNN, depending on the value | |
3375 of the `ctl-arrow' variable. | |
3376 This differs from `single-key-description' in that it returns a description | |
3377 of a character from a buffer rather than a key read from the user. | |
3378 */ | |
3379 (chr)) | |
3380 { | |
867 | 3381 Ibyte buf[200]; |
3382 Ibyte *p; | |
3383 Ichar c; | |
428 | 3384 Lisp_Object ctl_arrow = current_buffer->ctl_arrow; |
3385 int ctl_p = !NILP (ctl_arrow); | |
867 | 3386 Ichar printable_min = (CHAR_OR_CHAR_INTP (ctl_arrow) |
428 | 3387 ? XCHAR_OR_CHAR_INT (ctl_arrow) |
3388 : ((EQ (ctl_arrow, Qt) || NILP (ctl_arrow)) | |
3389 ? 256 : 160)); | |
3390 | |
3391 if (EVENTP (chr)) | |
3392 { | |
2862 | 3393 Lisp_Object ch = Fevent_to_character (chr, Qnil, Qnil, Qnil); |
428 | 3394 if (NILP (ch)) |
3395 return | |
563 | 3396 signal_continuable_error |
3397 (Qinvalid_argument, | |
2828 | 3398 "key has no character equivalent (that we know of)", |
3399 Fcopy_event (chr, Qnil)); | |
428 | 3400 chr = ch; |
3401 } | |
3402 | |
3403 CHECK_CHAR_COERCE_INT (chr); | |
3404 | |
3405 c = XCHAR (chr); | |
3406 p = buf; | |
3407 | |
3408 if (c >= printable_min) | |
3409 { | |
867 | 3410 p += set_itext_ichar (p, c); |
428 | 3411 } |
3412 else if (c < 040 && ctl_p) | |
3413 { | |
3414 *p++ = '^'; | |
3415 *p++ = c + 64; /* 'A' - 1 */ | |
3416 } | |
3417 else if (c == 0177) | |
3418 { | |
3419 *p++ = '^'; | |
3420 *p++ = '?'; | |
3421 } | |
3422 else if (c >= 0200 || c < 040) | |
3423 { | |
3424 *p++ = '\\'; | |
3425 #ifdef MULE | |
3426 /* !!#### This syntax is not readable. It will | |
3427 be interpreted as a 3-digit octal number rather | |
3428 than a 7-digit octal number. */ | |
3429 if (c >= 0400) | |
3430 { | |
3431 *p++ = '0' + ((c & 07000000) >> 18); | |
3432 *p++ = '0' + ((c & 0700000) >> 15); | |
3433 *p++ = '0' + ((c & 070000) >> 12); | |
3434 *p++ = '0' + ((c & 07000) >> 9); | |
3435 } | |
3436 #endif | |
3437 *p++ = '0' + ((c & 0700) >> 6); | |
3438 *p++ = '0' + ((c & 0070) >> 3); | |
3439 *p++ = '0' + ((c & 0007)); | |
3440 } | |
3441 else | |
3442 { | |
867 | 3443 p += set_itext_ichar (p, c); |
428 | 3444 } |
3445 | |
3446 *p = 0; | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3447 return build_istring (buf); |
428 | 3448 } |
3449 | |
3450 | |
3451 /************************************************************************/ | |
3452 /* where-is (mapping bindings to keys) */ | |
3453 /************************************************************************/ | |
3454 | |
3455 static Lisp_Object | |
3456 where_is_internal (Lisp_Object definition, Lisp_Object *maps, int nmaps, | |
793 | 3457 Lisp_Object firstonly, Eistring *target_buffer); |
428 | 3458 |
3459 DEFUN ("where-is-internal", Fwhere_is_internal, 1, 5, 0, /* | |
3460 Return list of keys that invoke DEFINITION in KEYMAPS. | |
3461 KEYMAPS can be either a keymap (meaning search in that keymap and the | |
3462 current global keymap) or a list of keymaps (meaning search in exactly | |
3096 | 3463 those keymaps and no others). |
428 | 3464 |
3465 If optional 3rd arg FIRSTONLY is non-nil, return a vector representing | |
3466 the first key sequence found, rather than a list of all possible key | |
3467 sequences. | |
3468 | |
3096 | 3469 Optional 4th argument NOINDIRECT is ignored. (GNU Emacs uses it to allow |
3470 searching for an indirect keymap by inhibiting following of indirections to | |
3471 keymaps or slots, but XEmacs doesn't need it because keymaps are a type.) | |
3472 | |
3473 If optional 5th argument EVENT-OR-KEYS is non-nil and KEYMAPS is nil, | |
3474 search in the currently applicable maps for EVENT-OR-KEYS (this is | |
3475 equivalent to specifying `(current-keymaps EVENT-OR-KEYS)' as the | |
3476 argument to KEYMAPS). | |
428 | 3477 */ |
2286 | 3478 (definition, keymaps, firstonly, UNUSED (noindirect), event_or_keys)) |
428 | 3479 { |
3480 /* This function can GC */ | |
3481 Lisp_Object maps[100]; | |
3482 Lisp_Object *gubbish = maps; | |
3483 int nmaps; | |
3484 | |
3485 /* Get keymaps as an array */ | |
3486 if (NILP (keymaps)) | |
3487 { | |
3488 nmaps = get_relevant_keymaps (event_or_keys, countof (maps), | |
3489 gubbish); | |
3490 if (nmaps > countof (maps)) | |
3491 { | |
3492 gubbish = alloca_array (Lisp_Object, nmaps); | |
3493 nmaps = get_relevant_keymaps (event_or_keys, nmaps, gubbish); | |
3494 } | |
3495 } | |
3496 else if (CONSP (keymaps)) | |
3497 { | |
3498 Lisp_Object rest; | |
3499 int i; | |
3500 | |
3501 nmaps = XINT (Flength (keymaps)); | |
3502 if (nmaps > countof (maps)) | |
3503 { | |
3504 gubbish = alloca_array (Lisp_Object, nmaps); | |
3505 } | |
3506 for (rest = keymaps, i = 0; !NILP (rest); | |
3507 rest = XCDR (keymaps), i++) | |
3508 { | |
3509 gubbish[i] = get_keymap (XCAR (keymaps), 1, 1); | |
3510 } | |
3511 } | |
3512 else | |
3513 { | |
3514 nmaps = 1; | |
3515 gubbish[0] = get_keymap (keymaps, 1, 1); | |
3516 if (!EQ (gubbish[0], Vcurrent_global_map)) | |
3517 { | |
3518 gubbish[1] = Vcurrent_global_map; | |
3519 nmaps++; | |
3520 } | |
3521 } | |
3522 | |
3523 return where_is_internal (definition, gubbish, nmaps, firstonly, 0); | |
3524 } | |
3525 | |
3526 /* This function is like | |
3527 (key-description (where-is-internal definition nil t)) | |
3528 except that it writes its output into a (char *) buffer that you | |
3529 provide; it doesn't cons (or allocate memory) at all, so it's | |
3530 very fast. This is used by menubar.c. | |
3531 */ | |
3532 void | |
793 | 3533 where_is_to_char (Lisp_Object definition, Eistring *buffer) |
428 | 3534 { |
3535 /* This function can GC */ | |
3536 Lisp_Object maps[100]; | |
3537 Lisp_Object *gubbish = maps; | |
3538 int nmaps; | |
3539 | |
3540 /* Get keymaps as an array */ | |
3541 nmaps = get_relevant_keymaps (Qnil, countof (maps), gubbish); | |
3542 if (nmaps > countof (maps)) | |
3543 { | |
3544 gubbish = alloca_array (Lisp_Object, nmaps); | |
3545 nmaps = get_relevant_keymaps (Qnil, nmaps, gubbish); | |
3546 } | |
3547 | |
3548 where_is_internal (definition, maps, nmaps, Qt, buffer); | |
3549 } | |
3550 | |
3551 | |
3552 static Lisp_Object | |
934 | 3553 raw_keys_to_keys (Lisp_Key_Data *keys, int count) |
428 | 3554 { |
3555 Lisp_Object result = make_vector (count, Qnil); | |
3556 while (count--) | |
3557 XVECTOR_DATA (result) [count] = make_key_description (&(keys[count]), 1); | |
3558 return result; | |
3559 } | |
3560 | |
3561 | |
3562 static void | |
934 | 3563 format_raw_keys (Lisp_Key_Data *keys, int count, Eistring *buf) |
428 | 3564 { |
3565 int i; | |
934 | 3566 Lisp_Object event = Fmake_event (Qnil, Qnil); |
3567 XSET_EVENT_TYPE (event, key_press_event); | |
3568 XSET_EVENT_CHANNEL (event, Vselected_console); | |
428 | 3569 for (i = 0; i < count; i++) |
3570 { | |
1204 | 3571 XSET_EVENT_KEY_KEYSYM (event, keys[i].keysym); |
3572 XSET_EVENT_KEY_MODIFIERS (event, KEY_DATA_MODIFIERS (&keys[i])); | |
934 | 3573 format_event_object (buf, event, 1); |
793 | 3574 if (i < count - 1) |
2421 | 3575 eicat_ascii (buf, " "); |
428 | 3576 } |
1204 | 3577 Fdeallocate_event (event); |
428 | 3578 } |
3579 | |
3580 | |
3581 /* definition is the thing to look for. | |
3582 map is a keymap. | |
3583 shadow is an array of shadow_count keymaps; if there is a different | |
3584 binding in any of the keymaps of a key that we are considering | |
3585 returning, then we reconsider. | |
3586 firstonly means give up after finding the first match; | |
3587 keys_so_far and modifiers_so_far describe which map we're looking in; | |
3588 If we're in the "meta" submap of the map that "C-x 4" is bound to, | |
3589 then keys_so_far will be {(control x), \4}, and modifiers_so_far | |
442 | 3590 will be XEMACS_MOD_META. That is, keys_so_far is the chain of keys that we |
428 | 3591 have followed, and modifiers_so_far_so_far is the bits (partial keys) |
3592 beyond that. | |
3593 | |
3594 (keys_so_far is a global buffer and the keys_count arg says how much | |
3595 of it we're currently interested in.) | |
3596 | |
3597 If target_buffer is provided, then we write a key-description into it, | |
3598 to avoid consing a string. This only works with firstonly on. | |
3599 */ | |
3600 | |
3601 struct where_is_closure | |
3602 { | |
3603 Lisp_Object definition; | |
3604 Lisp_Object *shadow; | |
3605 int shadow_count; | |
3606 int firstonly; | |
3607 int keys_count; | |
442 | 3608 int modifiers_so_far; |
793 | 3609 Eistring *target_buffer; |
934 | 3610 Lisp_Key_Data *keys_so_far; |
428 | 3611 int keys_so_far_total_size; |
3612 int keys_so_far_malloced; | |
3613 }; | |
3614 | |
3615 static Lisp_Object where_is_recursive_mapper (Lisp_Object map, void *arg); | |
3616 | |
3617 static Lisp_Object | |
3618 where_is_recursive_mapper (Lisp_Object map, void *arg) | |
3619 { | |
3620 /* This function can GC */ | |
3621 struct where_is_closure *c = (struct where_is_closure *) arg; | |
3622 Lisp_Object definition = c->definition; | |
442 | 3623 const int firstonly = c->firstonly; |
3624 const int keys_count = c->keys_count; | |
3625 const int modifiers_so_far = c->modifiers_so_far; | |
793 | 3626 Eistring *target_buffer = c->target_buffer; |
428 | 3627 Lisp_Object keys = Fgethash (definition, |
3628 XKEYMAP (map)->inverse_table, | |
3629 Qnil); | |
3630 Lisp_Object submaps; | |
3631 Lisp_Object result = Qnil; | |
3632 | |
3633 if (!NILP (keys)) | |
3634 { | |
3635 /* One or more keys in this map match the definition we're looking for. | |
3636 Verify that these bindings aren't shadowed by other bindings | |
3637 in the shadow maps. Either nil or number as value from | |
3638 raw_lookup_key() means undefined. */ | |
934 | 3639 Lisp_Key_Data *so_far = c->keys_so_far; |
428 | 3640 |
3641 for (;;) /* loop over all keys that match */ | |
3642 { | |
3643 Lisp_Object k = CONSP (keys) ? XCAR (keys) : keys; | |
3644 int i; | |
3645 | |
3646 so_far [keys_count].keysym = k; | |
934 | 3647 SET_KEY_DATA_MODIFIERS (&so_far [keys_count], modifiers_so_far); |
428 | 3648 |
3649 /* now loop over all shadow maps */ | |
3650 for (i = 0; i < c->shadow_count; i++) | |
3651 { | |
3652 Lisp_Object shadowed = raw_lookup_key (c->shadow[i], | |
3653 so_far, | |
3654 keys_count + 1, | |
3655 0, 1); | |
3656 | |
3657 if (NILP (shadowed) || CHARP (shadowed) || | |
3658 EQ (shadowed, definition)) | |
3659 continue; /* we passed this test; it's not shadowed here. */ | |
3660 else | |
3661 /* ignore this key binding, since it actually has a | |
3662 different binding in a shadowing map */ | |
3663 goto c_doesnt_have_proper_loop_exit_statements; | |
3664 } | |
3665 | |
3666 /* OK, the key is for real */ | |
3667 if (target_buffer) | |
3668 { | |
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
5013
diff
changeset
|
3669 assert (firstonly); |
428 | 3670 format_raw_keys (so_far, keys_count + 1, target_buffer); |
3671 return make_int (1); | |
3672 } | |
3673 else if (firstonly) | |
3674 return raw_keys_to_keys (so_far, keys_count + 1); | |
3675 else | |
3676 result = Fcons (raw_keys_to_keys (so_far, keys_count + 1), | |
3677 result); | |
3678 | |
3679 c_doesnt_have_proper_loop_exit_statements: | |
3680 /* now on to the next matching key ... */ | |
3681 if (!CONSP (keys)) break; | |
3682 keys = XCDR (keys); | |
3683 } | |
3684 } | |
3685 | |
3686 /* Now search the sub-keymaps of this map. | |
3687 If we're in "firstonly" mode and have already found one, this | |
3688 point is not reached. If we get one from lower down, either | |
3689 return it immediately (in firstonly mode) or tack it onto the | |
3690 end of the ones we've gotten so far. | |
3691 */ | |
3692 for (submaps = keymap_submaps (map); | |
3693 !NILP (submaps); | |
3694 submaps = XCDR (submaps)) | |
3695 { | |
3696 Lisp_Object key = XCAR (XCAR (submaps)); | |
3697 Lisp_Object submap = XCDR (XCAR (submaps)); | |
442 | 3698 int lower_modifiers; |
428 | 3699 int lower_keys_count = keys_count; |
442 | 3700 int bucky; |
428 | 3701 |
3702 submap = get_keymap (submap, 0, 0); | |
3703 | |
3704 if (EQ (submap, map)) | |
3705 /* Arrgh! Some loser has introduced a loop... */ | |
3706 continue; | |
3707 | |
3708 /* If this is not a keymap, then that's probably because someone | |
3709 did an `fset' of a symbol that used to point to a map such that | |
3710 it no longer does. Sigh. Ignore this, and invalidate the cache | |
3711 so that it doesn't happen to us next time too. | |
3712 */ | |
3713 if (NILP (submap)) | |
3714 { | |
3715 XKEYMAP (map)->sub_maps_cache = Qt; | |
3716 continue; | |
3717 } | |
3718 | |
3719 /* If the map is a "bucky" map, then add a bit to the | |
3720 modifiers_so_far list. | |
3721 Otherwise, add a new raw_key onto the end of keys_so_far. | |
3722 */ | |
3723 bucky = MODIFIER_HASH_KEY_BITS (key); | |
3724 if (bucky != 0) | |
3725 lower_modifiers = (modifiers_so_far | bucky); | |
3726 else | |
3727 { | |
934 | 3728 Lisp_Key_Data *so_far = c->keys_so_far; |
428 | 3729 lower_modifiers = 0; |
3730 so_far [lower_keys_count].keysym = key; | |
934 | 3731 SET_KEY_DATA_MODIFIERS (&so_far [lower_keys_count], modifiers_so_far); |
428 | 3732 lower_keys_count++; |
3733 } | |
3734 | |
3735 if (lower_keys_count >= c->keys_so_far_total_size) | |
3736 { | |
3737 int size = lower_keys_count + 50; | |
3738 if (! c->keys_so_far_malloced) | |
3739 { | |
3025 | 3740 Lisp_Key_Data *new_ = xnew_array (Lisp_Key_Data, size); |
3741 memcpy ((void *)new_, (const void *)c->keys_so_far, | |
934 | 3742 c->keys_so_far_total_size * sizeof (Lisp_Key_Data)); |
4976
16112448d484
Rename xfree(FOO, TYPE) -> xfree(FOO)
Ben Wing <ben@xemacs.org>
parents:
4962
diff
changeset
|
3743 xfree (c->keys_so_far); |
3550 | 3744 c->keys_so_far = new_; |
428 | 3745 } |
3746 else | |
934 | 3747 XREALLOC_ARRAY (c->keys_so_far, Lisp_Key_Data, size); |
428 | 3748 |
3749 c->keys_so_far_total_size = size; | |
3750 c->keys_so_far_malloced = 1; | |
3751 } | |
3752 | |
3753 { | |
3754 Lisp_Object lower; | |
3755 | |
3756 c->keys_count = lower_keys_count; | |
3757 c->modifiers_so_far = lower_modifiers; | |
3758 | |
3759 lower = traverse_keymaps (submap, Qnil, where_is_recursive_mapper, c); | |
3760 | |
3761 c->keys_count = keys_count; | |
3762 c->modifiers_so_far = modifiers_so_far; | |
3763 | |
3764 if (!firstonly) | |
3765 result = nconc2 (lower, result); | |
3766 else if (!NILP (lower)) | |
3767 return lower; | |
3768 } | |
3769 } | |
3770 return result; | |
3771 } | |
3772 | |
3773 | |
3774 static Lisp_Object | |
3775 where_is_internal (Lisp_Object definition, Lisp_Object *maps, int nmaps, | |
793 | 3776 Lisp_Object firstonly, Eistring *target_buffer) |
428 | 3777 { |
3778 /* This function can GC */ | |
3779 Lisp_Object result = Qnil; | |
3780 int i; | |
934 | 3781 Lisp_Key_Data raw[20]; |
428 | 3782 struct where_is_closure c; |
3783 | |
3784 c.definition = definition; | |
3785 c.shadow = maps; | |
3786 c.firstonly = !NILP (firstonly); | |
3787 c.target_buffer = target_buffer; | |
3788 c.keys_so_far = raw; | |
3789 c.keys_so_far_total_size = countof (raw); | |
3790 c.keys_so_far_malloced = 0; | |
3791 | |
3792 /* Loop over each of the maps, accumulating the keys found. | |
3793 For each map searched, all previous maps shadow this one | |
3794 so that bogus keys aren't listed. */ | |
3795 for (i = 0; i < nmaps; i++) | |
3796 { | |
3797 Lisp_Object this_result; | |
3798 c.shadow_count = i; | |
3799 /* Reset the things set in each iteration */ | |
3800 c.keys_count = 0; | |
3801 c.modifiers_so_far = 0; | |
3802 | |
3803 this_result = traverse_keymaps (maps[i], Qnil, where_is_recursive_mapper, | |
3804 &c); | |
3805 if (!NILP (firstonly)) | |
3806 { | |
3807 result = this_result; | |
3808 if (!NILP (result)) | |
3809 break; | |
3810 } | |
3811 else | |
3812 result = nconc2 (this_result, result); | |
3813 } | |
3814 | |
3815 if (NILP (firstonly)) | |
3816 result = Fnreverse (result); | |
3817 | |
3818 if (c.keys_so_far_malloced) | |
4976
16112448d484
Rename xfree(FOO, TYPE) -> xfree(FOO)
Ben Wing <ben@xemacs.org>
parents:
4962
diff
changeset
|
3819 xfree (c.keys_so_far); |
428 | 3820 return result; |
3821 } | |
3822 | |
3823 | |
3824 /************************************************************************/ | |
3825 /* Describing keymaps */ | |
3826 /************************************************************************/ | |
3827 | |
3828 DEFUN ("describe-bindings-internal", Fdescribe_bindings_internal, 1, 5, 0, /* | |
3829 Insert a list of all defined keys and their definitions in MAP. | |
3830 Optional second argument ALL says whether to include even "uninteresting" | |
3831 definitions (ie symbols with a non-nil `suppress-keymap' property. | |
3832 Third argument SHADOW is a list of keymaps whose bindings shadow those | |
3833 of map; if a binding is present in any shadowing map, it is not printed. | |
3834 Fourth argument PREFIX, if non-nil, should be a key sequence; | |
3835 only bindings which start with that key sequence will be printed. | |
3836 Fifth argument MOUSE-ONLY-P says to only print bindings for mouse clicks. | |
3837 */ | |
3838 (map, all, shadow, prefix, mouse_only_p)) | |
3839 { | |
3840 /* This function can GC */ | |
3841 | |
3842 /* #### At some point, this function should be changed to accept a | |
3843 BUFFER argument. Currently, the BUFFER argument to | |
3844 describe_map_tree is being used only internally. */ | |
3845 describe_map_tree (map, NILP (all), shadow, prefix, | |
3846 !NILP (mouse_only_p), Fcurrent_buffer ()); | |
3847 return Qnil; | |
3848 } | |
3849 | |
3850 | |
3851 /* Insert a description of the key bindings in STARTMAP, | |
3852 followed by those of all maps reachable through STARTMAP. | |
3853 If PARTIAL is nonzero, omit certain "uninteresting" commands | |
3854 (such as `undefined'). | |
3855 If SHADOW is non-nil, it is a list of other maps; | |
3856 don't mention keys which would be shadowed by any of them | |
3857 If PREFIX is non-nil, only list bindings which start with those keys. | |
3858 */ | |
3859 | |
3860 void | |
3861 describe_map_tree (Lisp_Object startmap, int partial, Lisp_Object shadow, | |
3862 Lisp_Object prefix, int mice_only_p, Lisp_Object buffer) | |
3863 { | |
3864 /* This function can GC */ | |
3865 Lisp_Object maps = Qnil; | |
3866 struct gcpro gcpro1, gcpro2; /* get_keymap may autoload */ | |
3867 GCPRO2 (maps, shadow); | |
3868 | |
3869 maps = Faccessible_keymaps (startmap, prefix); | |
3870 | |
3871 for (; !NILP (maps); maps = Fcdr (maps)) | |
3872 { | |
3873 Lisp_Object sub_shadow = Qnil; | |
3874 Lisp_Object elt = Fcar (maps); | |
3875 Lisp_Object tail; | |
3876 int no_prefix = (VECTORP (Fcar (elt)) | |
3877 && XINT (Flength (Fcar (elt))) == 0); | |
3878 struct gcpro ngcpro1, ngcpro2, ngcpro3; | |
3879 NGCPRO3 (sub_shadow, elt, tail); | |
3880 | |
3881 for (tail = shadow; CONSP (tail); tail = XCDR (tail)) | |
3882 { | |
3883 Lisp_Object shmap = XCAR (tail); | |
3884 | |
3885 /* If the sequence by which we reach this keymap is zero-length, | |
3886 then the shadow maps for this keymap are just SHADOW. */ | |
3887 if (no_prefix) | |
3888 ; | |
3889 /* If the sequence by which we reach this keymap actually has | |
3890 some elements, then the sequence's definition in SHADOW is | |
3891 what we should use. */ | |
3892 else | |
3893 { | |
3894 shmap = Flookup_key (shmap, Fcar (elt), Qt); | |
3895 if (CHARP (shmap)) | |
3896 shmap = Qnil; | |
3897 } | |
3898 | |
3899 if (!NILP (shmap)) | |
3900 { | |
3901 Lisp_Object shm = get_keymap (shmap, 0, 1); | |
3902 /* If shmap is not nil and not a keymap, it completely | |
3903 shadows this map, so don't describe this map at all. */ | |
3904 if (!KEYMAPP (shm)) | |
3905 goto SKIP; | |
3906 sub_shadow = Fcons (shm, sub_shadow); | |
3907 } | |
3908 } | |
3909 | |
3910 { | |
3911 /* Describe the contents of map MAP, assuming that this map | |
3912 itself is reached by the sequence of prefix keys KEYS (a vector). | |
3913 PARTIAL and SHADOW are as in `describe_map_tree'. */ | |
3914 Lisp_Object keysdesc | |
3915 = ((!no_prefix) | |
3916 ? concat2 (Fkey_description (Fcar (elt)), Vsingle_space_string) | |
3917 : Qnil); | |
3918 describe_map (Fcdr (elt), keysdesc, | |
3919 describe_command, | |
3920 partial, | |
3921 sub_shadow, | |
3922 mice_only_p, | |
3923 buffer); | |
3924 } | |
3925 SKIP: | |
3926 NUNGCPRO; | |
3927 } | |
3928 UNGCPRO; | |
3929 } | |
3930 | |
3931 | |
3932 static void | |
3933 describe_command (Lisp_Object definition, Lisp_Object buffer) | |
3934 { | |
3935 /* This function can GC */ | |
3936 int keymapp = !NILP (Fkeymapp (definition)); | |
3937 struct gcpro gcpro1; | |
3938 GCPRO1 (definition); | |
3939 | |
3940 Findent_to (make_int (16), make_int (3), buffer); | |
3941 if (keymapp) | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3942 buffer_insert_ascstring (XBUFFER (buffer), "<< "); |
428 | 3943 |
3944 if (SYMBOLP (definition)) | |
3945 { | |
3946 buffer_insert1 (XBUFFER (buffer), Fsymbol_name (definition)); | |
3947 } | |
3948 else if (STRINGP (definition) || VECTORP (definition)) | |
3949 { | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3950 buffer_insert_ascstring (XBUFFER (buffer), "Kbd Macro: "); |
428 | 3951 buffer_insert1 (XBUFFER (buffer), Fkey_description (definition)); |
3952 } | |
3953 else if (COMPILED_FUNCTIONP (definition)) | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3954 buffer_insert_ascstring (XBUFFER (buffer), "Anonymous Compiled Function"); |
428 | 3955 else if (CONSP (definition) && EQ (XCAR (definition), Qlambda)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3956 buffer_insert_ascstring (XBUFFER (buffer), "Anonymous Lambda"); |
428 | 3957 else if (KEYMAPP (definition)) |
3958 { | |
3959 Lisp_Object name = XKEYMAP (definition)->name; | |
3960 if (STRINGP (name) || (SYMBOLP (name) && !NILP (name))) | |
3961 { | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3962 buffer_insert_ascstring (XBUFFER (buffer), "Prefix command "); |
428 | 3963 if (SYMBOLP (name) |
3964 && EQ (find_symbol_value (name), definition)) | |
3965 buffer_insert1 (XBUFFER (buffer), Fsymbol_name (name)); | |
3966 else | |
3967 { | |
3968 buffer_insert1 (XBUFFER (buffer), Fprin1_to_string (name, Qnil)); | |
3969 } | |
3970 } | |
3971 else | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3972 buffer_insert_ascstring (XBUFFER (buffer), "Prefix Command"); |
428 | 3973 } |
3974 else | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3975 buffer_insert_ascstring (XBUFFER (buffer), "??"); |
428 | 3976 |
3977 if (keymapp) | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3978 buffer_insert_ascstring (XBUFFER (buffer), " >>"); |
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3979 buffer_insert_ascstring (XBUFFER (buffer), "\n"); |
428 | 3980 UNGCPRO; |
3981 } | |
3982 | |
3983 struct describe_map_closure | |
3984 { | |
3985 Lisp_Object *list; /* pointer to the list to update */ | |
3986 Lisp_Object partial; /* whether to ignore suppressed commands */ | |
3987 Lisp_Object shadow; /* list of maps shadowing this one */ | |
3988 Lisp_Object self; /* this map */ | |
3989 Lisp_Object self_root; /* this map, or some map that has this map as | |
3990 a parent. this is the base of the tree */ | |
3991 int mice_only_p; /* whether we are to display only button bindings */ | |
3992 }; | |
3993 | |
3994 struct describe_map_shadow_closure | |
3995 { | |
934 | 3996 const Lisp_Key_Data *raw_key; |
428 | 3997 Lisp_Object self; |
3998 }; | |
3999 | |
4000 static Lisp_Object | |
4001 describe_map_mapper_shadow_search (Lisp_Object map, void *arg) | |
4002 { | |
4003 struct describe_map_shadow_closure *c = | |
4004 (struct describe_map_shadow_closure *) arg; | |
4005 | |
4006 if (EQ (map, c->self)) | |
4007 return Qzero; /* Not shadowed; terminate search */ | |
4008 | |
934 | 4009 return !NILP (keymap_lookup_directly (map, |
4010 KEY_DATA_KEYSYM (c->raw_key), | |
4011 KEY_DATA_MODIFIERS (c->raw_key))) | |
428 | 4012 ? Qt : Qnil; |
4013 } | |
4014 | |
4015 | |
4016 static Lisp_Object | |
4017 keymap_lookup_inherited_mapper (Lisp_Object km, void *arg) | |
4018 { | |
934 | 4019 Lisp_Key_Data *k = (Lisp_Key_Data *) arg; |
4020 return keymap_lookup_directly (km, KEY_DATA_KEYSYM (k), KEY_DATA_MODIFIERS (k)); | |
428 | 4021 } |
4022 | |
4023 | |
4024 static void | |
934 | 4025 describe_map_mapper (const Lisp_Key_Data *key, |
428 | 4026 Lisp_Object binding, |
4027 void *describe_map_closure) | |
4028 { | |
4029 /* This function can GC */ | |
4030 struct describe_map_closure *closure = | |
4031 (struct describe_map_closure *) describe_map_closure; | |
934 | 4032 Lisp_Object keysym = KEY_DATA_KEYSYM (key); |
4033 int modifiers = KEY_DATA_MODIFIERS (key); | |
428 | 4034 |
4035 /* Don't mention suppressed commands. */ | |
4036 if (SYMBOLP (binding) | |
4037 && !NILP (closure->partial) | |
4038 && !NILP (Fget (binding, closure->partial, Qnil))) | |
4039 return; | |
4040 | |
4041 /* If we're only supposed to display mouse bindings and this isn't one, | |
4042 then bug out. */ | |
4043 if (closure->mice_only_p && | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4044 (! ( |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4045 #define INCLUDE_BUTTON_ZERO |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4046 #define FROB(num) EQ (keysym, Qbutton##num) || \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4047 EQ (keysym, Qbutton##num##up) || |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4048 #include "keymap-buttons.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4049 0))) |
428 | 4050 return; |
4051 | |
4052 /* If this command in this map is shadowed by some other map, ignore it. */ | |
4053 { | |
4054 Lisp_Object tail; | |
4055 | |
4056 for (tail = closure->shadow; CONSP (tail); tail = XCDR (tail)) | |
4057 { | |
4058 QUIT; | |
4059 if (!NILP (traverse_keymaps (XCAR (tail), Qnil, | |
4060 keymap_lookup_inherited_mapper, | |
4061 /* Cast to discard `const' */ | |
4062 (void *)key))) | |
4063 return; | |
4064 } | |
4065 } | |
4066 | |
4067 /* If this key is in some map of which this map is a parent, then ignore | |
4068 it (in that case, it has been shadowed). | |
4069 */ | |
4070 { | |
4071 Lisp_Object sh; | |
4072 struct describe_map_shadow_closure c; | |
4073 c.raw_key = key; | |
4074 c.self = closure->self; | |
4075 | |
4076 sh = traverse_keymaps (closure->self_root, Qnil, | |
4077 describe_map_mapper_shadow_search, &c); | |
4078 if (!NILP (sh) && !ZEROP (sh)) | |
4079 return; | |
4080 } | |
4081 | |
4082 /* Otherwise add it to the list to be sorted. */ | |
4083 *(closure->list) = Fcons (Fcons (Fcons (keysym, make_int (modifiers)), | |
4084 binding), | |
4085 *(closure->list)); | |
4086 } | |
4087 | |
4088 | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
4089 static Lisp_Object |
428 | 4090 describe_map_sort_predicate (Lisp_Object obj1, Lisp_Object obj2, |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
4091 Lisp_Object pred, Lisp_Object key_func) |
428 | 4092 { |
4093 /* obj1 and obj2 are conses of the form | |
4094 ( ( <keysym> . <modifiers> ) . <binding> ) | |
4095 keysym and modifiers are used, binding is ignored. | |
4096 */ | |
442 | 4097 int bit1, bit2; |
428 | 4098 obj1 = XCAR (obj1); |
4099 obj2 = XCAR (obj2); | |
4100 bit1 = XINT (XCDR (obj1)); | |
4101 bit2 = XINT (XCDR (obj2)); | |
4102 if (bit1 != bit2) | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
4103 return bit1 < bit2 ? Qt : Qnil; |
428 | 4104 else |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
4105 return map_keymap_sort_predicate (obj1, obj2, pred, key_func); |
428 | 4106 } |
4107 | |
4108 /* Elide 2 or more consecutive numeric keysyms bound to the same thing, | |
4109 or 2 or more symbolic keysyms that are bound to the same thing and | |
4110 have consecutive character-set-properties. | |
4111 */ | |
4112 static int | |
4113 elide_next_two_p (Lisp_Object list) | |
4114 { | |
4115 Lisp_Object s1, s2; | |
2828 | 4116 extern Lisp_Object Qcharacter_of_keysym; |
428 | 4117 |
4118 if (NILP (XCDR (list))) | |
4119 return 0; | |
4120 | |
4121 /* next two bindings differ */ | |
4122 if (!EQ (XCDR (XCAR (list)), | |
4123 XCDR (XCAR (XCDR (list))))) | |
4124 return 0; | |
4125 | |
4126 /* next two modifier-sets differ */ | |
4127 if (!EQ (XCDR (XCAR (XCAR (list))), | |
4128 XCDR (XCAR (XCAR (XCDR (list)))))) | |
4129 return 0; | |
4130 | |
4131 s1 = XCAR (XCAR (XCAR (list))); | |
4132 s2 = XCAR (XCAR (XCAR (XCDR (list)))); | |
4133 | |
4134 if (SYMBOLP (s1)) | |
4135 { | |
2828 | 4136 Lisp_Object code = Fget (s1, Qcharacter_of_keysym, Qnil); |
428 | 4137 if (CHAR_OR_CHAR_INTP (code)) |
4138 { | |
4139 s1 = code; | |
4140 CHECK_CHAR_COERCE_INT (s1); | |
4141 } | |
4142 else return 0; | |
4143 } | |
4144 if (SYMBOLP (s2)) | |
4145 { | |
2828 | 4146 Lisp_Object code = Fget (s2, Qcharacter_of_keysym, Qnil); |
428 | 4147 if (CHAR_OR_CHAR_INTP (code)) |
4148 { | |
4149 s2 = code; | |
4150 CHECK_CHAR_COERCE_INT (s2); | |
4151 } | |
4152 else return 0; | |
4153 } | |
4154 | |
4155 return (XCHAR (s1) == XCHAR (s2) || | |
4156 XCHAR (s1) + 1 == XCHAR (s2)); | |
4157 } | |
4158 | |
4159 | |
4160 static Lisp_Object | |
4161 describe_map_parent_mapper (Lisp_Object keymap, void *arg) | |
4162 { | |
4163 /* This function can GC */ | |
4164 struct describe_map_closure *describe_map_closure = | |
4165 (struct describe_map_closure *) arg; | |
4166 describe_map_closure->self = keymap; | |
4167 map_keymap (XKEYMAP (keymap)->table, | |
4168 0, /* don't sort: we'll do it later */ | |
4169 describe_map_mapper, describe_map_closure); | |
4170 return Qnil; | |
4171 } | |
4172 | |
4173 | |
4174 /* Describe the contents of map MAP, assuming that this map itself is | |
4175 reached by the sequence of prefix keys KEYS (a string or vector). | |
4176 PARTIAL, SHADOW, NOMENU are as in `describe_map_tree' above. */ | |
4177 | |
4178 static void | |
4179 describe_map (Lisp_Object keymap, Lisp_Object elt_prefix, | |
4180 void (*elt_describer) (Lisp_Object, Lisp_Object), | |
4181 int partial, | |
4182 Lisp_Object shadow, | |
4183 int mice_only_p, | |
4184 Lisp_Object buffer) | |
4185 { | |
4186 /* This function can GC */ | |
4187 struct describe_map_closure describe_map_closure; | |
4188 Lisp_Object list = Qnil; | |
4189 struct buffer *buf = XBUFFER (buffer); | |
867 | 4190 Ichar printable_min = (CHAR_OR_CHAR_INTP (buf->ctl_arrow) |
428 | 4191 ? XCHAR_OR_CHAR_INT (buf->ctl_arrow) |
4192 : ((EQ (buf->ctl_arrow, Qt) | |
4193 || EQ (buf->ctl_arrow, Qnil)) | |
4194 ? 256 : 160)); | |
4195 int elided = 0; | |
4196 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
2828 | 4197 extern Lisp_Object Qcharacter_of_keysym; |
428 | 4198 |
4199 keymap = get_keymap (keymap, 1, 1); | |
4200 describe_map_closure.partial = (partial ? Qsuppress_keymap : Qnil); | |
4201 describe_map_closure.shadow = shadow; | |
4202 describe_map_closure.list = &list; | |
4203 describe_map_closure.self_root = keymap; | |
4204 describe_map_closure.mice_only_p = mice_only_p; | |
4205 | |
4206 GCPRO4 (keymap, elt_prefix, shadow, list); | |
4207 | |
4208 traverse_keymaps (keymap, Qnil, | |
4209 describe_map_parent_mapper, &describe_map_closure); | |
4210 | |
4211 if (!NILP (list)) | |
4212 { | |
5182
2e528066e2fc
Move #'sort*, #'fill, #'merge to C from cl-seq.el.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5146
diff
changeset
|
4213 list = list_sort (list, describe_map_sort_predicate, Qnil, Qidentity); |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4214 buffer_insert_ascstring (buf, "\n"); |
428 | 4215 while (!NILP (list)) |
4216 { | |
4217 Lisp_Object elt = XCAR (XCAR (list)); | |
4218 Lisp_Object keysym = XCAR (elt); | |
442 | 4219 int modifiers = XINT (XCDR (elt)); |
428 | 4220 |
4221 if (!NILP (elt_prefix)) | |
4222 buffer_insert_lisp_string (buf, elt_prefix); | |
4223 | |
442 | 4224 if (modifiers & XEMACS_MOD_META) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4225 buffer_insert_ascstring (buf, "M-"); |
442 | 4226 if (modifiers & XEMACS_MOD_CONTROL) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4227 buffer_insert_ascstring (buf, "C-"); |
442 | 4228 if (modifiers & XEMACS_MOD_SUPER) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4229 buffer_insert_ascstring (buf, "S-"); |
442 | 4230 if (modifiers & XEMACS_MOD_HYPER) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4231 buffer_insert_ascstring (buf, "H-"); |
442 | 4232 if (modifiers & XEMACS_MOD_ALT) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4233 buffer_insert_ascstring (buf, "Alt-"); |
442 | 4234 if (modifiers & XEMACS_MOD_SHIFT) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4235 buffer_insert_ascstring (buf, "Sh-"); |
428 | 4236 if (SYMBOLP (keysym)) |
4237 { | |
2828 | 4238 Lisp_Object code = Fget (keysym, Qcharacter_of_keysym, Qnil); |
867 | 4239 Ichar c = (CHAR_OR_CHAR_INTP (code) |
4240 ? XCHAR_OR_CHAR_INT (code) : (Ichar) -1); | |
428 | 4241 /* Calling Fsingle_key_description() would cons more */ |
4242 #if 0 /* This is bogus */ | |
4243 if (EQ (keysym, QKlinefeed)) | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4244 buffer_insert_ascstring (buf, "LFD"); |
428 | 4245 else if (EQ (keysym, QKtab)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4246 buffer_insert_ascstring (buf, "TAB"); |
428 | 4247 else if (EQ (keysym, QKreturn)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4248 buffer_insert_ascstring (buf, "RET"); |
428 | 4249 else if (EQ (keysym, QKescape)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4250 buffer_insert_ascstring (buf, "ESC"); |
428 | 4251 else if (EQ (keysym, QKdelete)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4252 buffer_insert_ascstring (buf, "DEL"); |
428 | 4253 else if (EQ (keysym, QKspace)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4254 buffer_insert_ascstring (buf, "SPC"); |
428 | 4255 else if (EQ (keysym, QKbackspace)) |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4256 buffer_insert_ascstring (buf, "BS"); |
428 | 4257 else |
4258 #endif | |
4259 if (c >= printable_min) | |
4260 buffer_insert_emacs_char (buf, c); | |
4261 else buffer_insert1 (buf, Fsymbol_name (keysym)); | |
4262 } | |
4263 else if (CHARP (keysym)) | |
4264 buffer_insert_emacs_char (buf, XCHAR (keysym)); | |
4265 else | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4266 buffer_insert_ascstring (buf, "---bad keysym---"); |
428 | 4267 |
4268 if (elided) | |
4269 elided = 0; | |
4270 else | |
4271 { | |
4272 int k = 0; | |
4273 | |
4274 while (elide_next_two_p (list)) | |
4275 { | |
4276 k++; | |
4277 list = XCDR (list); | |
4278 } | |
4279 if (k != 0) | |
4280 { | |
4281 if (k == 1) | |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4282 buffer_insert_ascstring (buf, ", "); |
428 | 4283 else |
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
4284 buffer_insert_ascstring (buf, " .. "); |
428 | 4285 elided = 1; |
4286 continue; | |
4287 } | |
4288 } | |
4289 | |
4290 /* Print a description of the definition of this character. */ | |
4291 (*elt_describer) (XCDR (XCAR (list)), buffer); | |
4292 list = XCDR (list); | |
4293 } | |
4294 } | |
4295 UNGCPRO; | |
4296 } | |
4297 | |
4298 | |
4299 void | |
4300 syms_of_keymap (void) | |
4301 { | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
4302 INIT_LISP_OBJECT (keymap); |
442 | 4303 |
502 | 4304 DEFSYMBOL (Qminor_mode_map_alist); |
4305 | |
4306 DEFSYMBOL (Qkeymapp); | |
4307 | |
4308 DEFSYMBOL (Qsuppress_keymap); | |
4309 | |
4310 DEFSYMBOL (Qmodeline_map); | |
4311 DEFSYMBOL (Qtoolbar_map); | |
428 | 4312 |
4313 DEFSUBR (Fkeymap_parents); | |
4314 DEFSUBR (Fset_keymap_parents); | |
4315 DEFSUBR (Fkeymap_name); | |
4316 DEFSUBR (Fset_keymap_name); | |
4317 DEFSUBR (Fkeymap_prompt); | |
4318 DEFSUBR (Fset_keymap_prompt); | |
4319 DEFSUBR (Fkeymap_default_binding); | |
4320 DEFSUBR (Fset_keymap_default_binding); | |
4321 | |
4322 DEFSUBR (Fkeymapp); | |
4323 DEFSUBR (Fmake_keymap); | |
4324 DEFSUBR (Fmake_sparse_keymap); | |
4325 | |
4326 DEFSUBR (Fcopy_keymap); | |
4327 DEFSUBR (Fkeymap_fullness); | |
4328 DEFSUBR (Fmap_keymap); | |
4329 DEFSUBR (Fevent_matches_key_specifier_p); | |
4330 DEFSUBR (Fdefine_key); | |
4331 DEFSUBR (Flookup_key); | |
4332 DEFSUBR (Fkey_binding); | |
4333 DEFSUBR (Fuse_global_map); | |
4334 DEFSUBR (Fuse_local_map); | |
4335 DEFSUBR (Fcurrent_local_map); | |
4336 DEFSUBR (Fcurrent_global_map); | |
4337 DEFSUBR (Fcurrent_keymaps); | |
4338 DEFSUBR (Faccessible_keymaps); | |
4339 DEFSUBR (Fkey_description); | |
4340 DEFSUBR (Fsingle_key_description); | |
4341 DEFSUBR (Fwhere_is_internal); | |
4342 DEFSUBR (Fdescribe_bindings_internal); | |
4343 | |
4344 DEFSUBR (Ftext_char_description); | |
4345 | |
502 | 4346 DEFSYMBOL (Qcontrol); |
4347 DEFSYMBOL (Qctrl); | |
4348 DEFSYMBOL (Qmeta); | |
4349 DEFSYMBOL (Qsuper); | |
4350 DEFSYMBOL (Qhyper); | |
4351 DEFSYMBOL (Qalt); | |
4352 DEFSYMBOL (Qshift); | |
4906
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4353 #define INCLUDE_BUTTON_ZERO |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4354 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4355 DEFSYMBOL (Qbutton##num); \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4356 DEFSYMBOL (Qbutton##num##up); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4357 #include "keymap-buttons.h" |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4358 #define FROB(num) \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4359 DEFSYMBOL (Qmouse_##num); \ |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4360 DEFSYMBOL (Qdown_mouse_##num); |
6ef8256a020a
implement equalp in C, fix case-folding, add equal() method for keymaps
Ben Wing <ben@xemacs.org>
parents:
4846
diff
changeset
|
4361 #include "keymap-buttons.h" |
502 | 4362 DEFSYMBOL (Qmenu_selection); |
4363 DEFSYMBOL (QLFD); | |
4364 DEFSYMBOL (QTAB); | |
4365 DEFSYMBOL (QRET); | |
4366 DEFSYMBOL (QESC); | |
4367 DEFSYMBOL (QDEL); | |
4368 DEFSYMBOL (QSPC); | |
4369 DEFSYMBOL (QBS); | |
428 | 4370 } |
4371 | |
4372 void | |
4373 vars_of_keymap (void) | |
4374 { | |
4375 DEFVAR_LISP ("meta-prefix-char", &Vmeta_prefix_char /* | |
4376 Meta-prefix character. | |
4377 This character followed by some character `foo' turns into `Meta-foo'. | |
4378 This can be any form recognized as a single key specifier. | |
4379 To disable the meta-prefix-char, set it to a negative number. | |
4380 */ ); | |
4381 Vmeta_prefix_char = make_char (033); | |
4382 | |
4383 DEFVAR_LISP ("mouse-grabbed-buffer", &Vmouse_grabbed_buffer /* | |
4384 A buffer which should be consulted first for all mouse activity. | |
4385 When a mouse-click is processed, it will first be looked up in the | |
4386 local-map of this buffer, and then through the normal mechanism if there | |
4387 is no binding for that click. This buffer's value of `mode-motion-hook' | |
4388 will be consulted instead of the `mode-motion-hook' of the buffer of the | |
4389 window under the mouse. You should *bind* this, not set it. | |
4390 */ ); | |
4391 Vmouse_grabbed_buffer = Qnil; | |
4392 | |
4393 DEFVAR_LISP ("overriding-local-map", &Voverriding_local_map /* | |
4394 Keymap that overrides all other local keymaps. | |
4395 If this variable is non-nil, it is used as a keymap instead of the | |
4396 buffer's local map, and the minor mode keymaps and extent-local keymaps. | |
4397 You should *bind* this, not set it. | |
4398 */ ); | |
4399 Voverriding_local_map = Qnil; | |
4400 | |
4401 Fset (Qminor_mode_map_alist, Qnil); | |
4402 | |
4403 DEFVAR_LISP ("key-translation-map", &Vkey_translation_map /* | |
4404 Keymap of key translations that can override keymaps. | |
2027 | 4405 |
4406 This keymap works like `function-key-map', but is searched before it, | |
428 | 4407 and applies even for keys that have ordinary bindings. |
2027 | 4408 |
4409 The `read-key-sequence' function replaces any subsequence bound by | |
4410 `key-translation-map' with its binding. More precisely, when the active | |
4411 keymaps have no binding for the current key sequence but | |
4412 `key-translation-map' binds a suffix of the sequence to a vector or string, | |
4413 `read-key-sequence' replaces the matching suffix with its binding, and | |
4414 continues with the new sequence. See `key-binding' for details. | |
4415 | |
4416 The events that come from bindings in `key-translation-map' are not | |
4417 themselves looked up in `key-translation-map'. | |
4418 | |
4419 #### FIXME: stolen from `function-key-map'; need better example. | |
4420 #### I guess you could implement a Dvorak keyboard with this? | |
4421 For example, suppose `key-translation-map' binds `ESC O P' to [f1]. | |
4422 Typing `ESC O P' to `read-key-sequence' would return | |
4423 \[#<keypress-event f1>]. Typing `C-x ESC O P' would return | |
4424 \[#<keypress-event control-X> #<keypress-event f1>]. If [f1] | |
4425 were a prefix key, typing `ESC O P x' would return | |
4426 \[#<keypress-event f1> #<keypress-event x>]. | |
428 | 4427 */ ); |
4428 Vkey_translation_map = Qnil; | |
4429 | |
771 | 4430 DEFVAR_LISP ("global-tty-map", &Vglobal_tty_map /* |
4431 Global keymap that applies only to TTY's. | |
4432 Key bindings are looked up in this map just before looking in the global map, | |
4433 but only when the current console is a TTY console. See also | |
4434 `global-window-system-map'. | |
4435 */ ); | |
4436 Vglobal_tty_map = Qnil; | |
4437 | |
4438 DEFVAR_LISP ("global-window-system-map", &Vglobal_window_system_map /* | |
4439 Global keymap that applies only to window systems. | |
4440 Key bindings are looked up in this map just before looking in the global map, | |
4441 but only when the current console is not a TTY console. See also | |
4442 `global-tty-map'. | |
4443 */ ); | |
4444 Vglobal_window_system_map = Qnil; | |
4445 | |
428 | 4446 DEFVAR_LISP ("vertical-divider-map", &Vvertical_divider_map /* |
4447 Keymap which handles mouse clicks over vertical dividers. | |
4448 */ ); | |
4449 Vvertical_divider_map = Qnil; | |
4450 | |
4451 DEFVAR_INT ("keymap-tick", &keymap_tick /* | |
4452 Incremented for each change to any keymap. | |
4453 */ ); | |
4454 keymap_tick = 0; | |
4455 | |
4456 staticpro (&Vcurrent_global_map); | |
4457 | |
867 | 4458 Vsingle_space_string = make_string ((const Ibyte *) " ", 1); |
428 | 4459 staticpro (&Vsingle_space_string); |
4460 } | |
4461 | |
4462 void | |
4463 complex_vars_of_keymap (void) | |
4464 { | |
4465 /* This function can GC */ | |
4466 Lisp_Object ESC_prefix = intern ("ESC-prefix"); | |
4467 Lisp_Object meta_disgustitute; | |
4468 | |
4469 Vcurrent_global_map = Fmake_keymap (Qnil); | |
771 | 4470 Vglobal_tty_map = Fmake_keymap (intern ("global-tty-map")); |
4471 Vglobal_window_system_map = | |
4472 Fmake_keymap (intern ("global-window-system-map")); | |
428 | 4473 |
4474 meta_disgustitute = Fmake_keymap (Qnil); | |
4475 Ffset (ESC_prefix, meta_disgustitute); | |
4476 /* no need to protect meta_disgustitute, though */ | |
442 | 4477 keymap_store_internal (MAKE_MODIFIER_HASH_KEY (XEMACS_MOD_META), |
428 | 4478 XKEYMAP (Vcurrent_global_map), |
4479 meta_disgustitute); | |
4480 XKEYMAP (Vcurrent_global_map)->sub_maps_cache = Qt; | |
4481 | |
4482 Vkey_translation_map = Fmake_sparse_keymap (intern ("key-translation-map")); | |
4483 } |