Commit | Line | Data |
---|---|---|
279a1d4b | 1 | /* Platform-independent code for terminal communications. |
95df8112 | 2 | |
acaf905b | 3 | Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2012 |
95df8112 | 4 | Free Software Foundation, Inc. |
279a1d4b CY |
5 | |
6 | This file is part of GNU Emacs. | |
7 | ||
8 | GNU Emacs is free software: you can redistribute it and/or modify | |
9 | it under the terms of the GNU General Public License as published by | |
10 | the Free Software Foundation, either version 3 of the License, or | |
11 | (at your option) any later version. | |
12 | ||
13 | GNU Emacs is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | GNU General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU General Public License | |
19 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ | |
20 | ||
21 | #include <config.h> | |
22 | #include <stdio.h> | |
3c24731f | 23 | #include <limits.h> /* for INT_MAX */ |
279a1d4b CY |
24 | |
25 | #include "lisp.h" | |
26 | #include "keyboard.h" | |
27 | #include "keymap.h" | |
28 | #include "frame.h" | |
ef7417fd | 29 | #include "window.h" |
279a1d4b CY |
30 | #include "termhooks.h" |
31 | #include "blockinput.h" | |
32 | #include "dispextern.h" | |
33 | ||
34 | #ifdef USE_X_TOOLKIT | |
35 | #include "../lwlib/lwlib.h" | |
36 | #endif | |
37 | ||
17a2cbbd DC |
38 | #ifdef HAVE_WINDOW_SYSTEM |
39 | #include TERM_HEADER | |
40 | #endif /* HAVE_WINDOW_SYSTEM */ | |
279a1d4b CY |
41 | |
42 | #ifdef HAVE_NTGUI | |
279a1d4b | 43 | extern AppendMenuW_Proc unicode_append_menu; |
04e452cb | 44 | extern HMENU current_popup_menu; |
279a1d4b CY |
45 | #endif /* HAVE_NTGUI */ |
46 | ||
e7c9048f | 47 | #include "menu.h" |
279a1d4b CY |
48 | |
49 | /* Define HAVE_BOXES if menus can handle radio and toggle buttons. */ | |
50 | #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI) | |
51 | #define HAVE_BOXES 1 | |
52 | #endif | |
53 | ||
279a1d4b CY |
54 | Lisp_Object menu_items; |
55 | ||
56 | /* If non-nil, means that the global vars defined here are already in use. | |
57 | Used to detect cases where we try to re-enter this non-reentrant code. */ | |
4475bec4 PE |
58 | #if ! (defined USE_GTK || defined USE_MOTIF) |
59 | static | |
60 | #endif | |
279a1d4b CY |
61 | Lisp_Object menu_items_inuse; |
62 | ||
63 | /* Number of slots currently allocated in menu_items. */ | |
64 | int menu_items_allocated; | |
65 | ||
66 | /* This is the index in menu_items of the first empty slot. */ | |
67 | int menu_items_used; | |
68 | ||
69 | /* The number of panes currently recorded in menu_items, | |
70 | excluding those within submenus. */ | |
71 | int menu_items_n_panes; | |
72 | ||
73 | /* Current depth within submenus. */ | |
74 | static int menu_items_submenu_depth; | |
75 | ||
76 | void | |
971de7fb | 77 | init_menu_items (void) |
279a1d4b CY |
78 | { |
79 | if (!NILP (menu_items_inuse)) | |
80 | error ("Trying to use a menu from within a menu-entry"); | |
81 | ||
82 | if (NILP (menu_items)) | |
83 | { | |
84 | menu_items_allocated = 60; | |
85 | menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil); | |
86 | } | |
87 | ||
88 | menu_items_inuse = Qt; | |
89 | menu_items_used = 0; | |
90 | menu_items_n_panes = 0; | |
91 | menu_items_submenu_depth = 0; | |
92 | } | |
93 | ||
94 | /* Call at the end of generating the data in menu_items. */ | |
95 | ||
96 | void | |
971de7fb | 97 | finish_menu_items (void) |
279a1d4b CY |
98 | { |
99 | } | |
100 | ||
101 | Lisp_Object | |
971de7fb | 102 | unuse_menu_items (Lisp_Object dummy) |
279a1d4b CY |
103 | { |
104 | return menu_items_inuse = Qnil; | |
105 | } | |
106 | ||
107 | /* Call when finished using the data for the current menu | |
108 | in menu_items. */ | |
109 | ||
110 | void | |
971de7fb | 111 | discard_menu_items (void) |
279a1d4b CY |
112 | { |
113 | /* Free the structure if it is especially large. | |
114 | Otherwise, hold on to it, to save time. */ | |
115 | if (menu_items_allocated > 200) | |
116 | { | |
117 | menu_items = Qnil; | |
118 | menu_items_allocated = 0; | |
119 | } | |
a54e2c05 | 120 | eassert (NILP (menu_items_inuse)); |
279a1d4b CY |
121 | } |
122 | ||
94da8397 | 123 | #ifdef HAVE_NS |
ef7417fd SM |
124 | static Lisp_Object |
125 | cleanup_popup_menu (Lisp_Object arg) | |
126 | { | |
127 | discard_menu_items (); | |
128 | return Qnil; | |
129 | } | |
94da8397 | 130 | #endif |
ef7417fd | 131 | |
279a1d4b CY |
132 | /* This undoes save_menu_items, and it is called by the specpdl unwind |
133 | mechanism. */ | |
134 | ||
135 | static Lisp_Object | |
971de7fb | 136 | restore_menu_items (Lisp_Object saved) |
279a1d4b CY |
137 | { |
138 | menu_items = XCAR (saved); | |
139 | menu_items_inuse = (! NILP (menu_items) ? Qt : Qnil); | |
140 | menu_items_allocated = (VECTORP (menu_items) ? ASIZE (menu_items) : 0); | |
141 | saved = XCDR (saved); | |
142 | menu_items_used = XINT (XCAR (saved)); | |
143 | saved = XCDR (saved); | |
144 | menu_items_n_panes = XINT (XCAR (saved)); | |
145 | saved = XCDR (saved); | |
146 | menu_items_submenu_depth = XINT (XCAR (saved)); | |
147 | return Qnil; | |
148 | } | |
149 | ||
150 | /* Push the whole state of menu_items processing onto the specpdl. | |
151 | It will be restored when the specpdl is unwound. */ | |
152 | ||
153 | void | |
971de7fb | 154 | save_menu_items (void) |
279a1d4b CY |
155 | { |
156 | Lisp_Object saved = list4 (!NILP (menu_items_inuse) ? menu_items : Qnil, | |
157 | make_number (menu_items_used), | |
158 | make_number (menu_items_n_panes), | |
159 | make_number (menu_items_submenu_depth)); | |
160 | record_unwind_protect (restore_menu_items, saved); | |
161 | menu_items_inuse = Qnil; | |
162 | menu_items = Qnil; | |
163 | } | |
164 | ||
165 | \f | |
d311d28c | 166 | /* Ensure that there is room for ITEMS items in the menu_items vector. */ |
279a1d4b CY |
167 | |
168 | static void | |
d311d28c | 169 | ensure_menu_items (int items) |
279a1d4b | 170 | { |
d311d28c PE |
171 | int incr = items - (menu_items_allocated - menu_items_used); |
172 | if (0 < incr) | |
173 | { | |
174 | menu_items = larger_vector (menu_items, incr, INT_MAX); | |
175 | menu_items_allocated = ASIZE (menu_items); | |
176 | } | |
279a1d4b CY |
177 | } |
178 | ||
60d9e1db PE |
179 | #if (defined USE_X_TOOLKIT || defined USE_GTK || defined HAVE_NS \ |
180 | || defined HAVE_NTGUI) | |
181 | ||
279a1d4b CY |
182 | /* Begin a submenu. */ |
183 | ||
184 | static void | |
971de7fb | 185 | push_submenu_start (void) |
279a1d4b | 186 | { |
d311d28c | 187 | ensure_menu_items (1); |
fb7da12e AS |
188 | ASET (menu_items, menu_items_used, Qnil); |
189 | menu_items_used++; | |
279a1d4b CY |
190 | menu_items_submenu_depth++; |
191 | } | |
192 | ||
193 | /* End a submenu. */ | |
194 | ||
195 | static void | |
971de7fb | 196 | push_submenu_end (void) |
279a1d4b | 197 | { |
d311d28c | 198 | ensure_menu_items (1); |
fb7da12e AS |
199 | ASET (menu_items, menu_items_used, Qlambda); |
200 | menu_items_used++; | |
279a1d4b CY |
201 | menu_items_submenu_depth--; |
202 | } | |
203 | ||
60d9e1db PE |
204 | #endif /* USE_X_TOOLKIT || USE_GTK || HAVE_NS || defined HAVE_NTGUI */ |
205 | ||
279a1d4b CY |
206 | /* Indicate boundary between left and right. */ |
207 | ||
208 | static void | |
971de7fb | 209 | push_left_right_boundary (void) |
279a1d4b | 210 | { |
d311d28c | 211 | ensure_menu_items (1); |
fb7da12e AS |
212 | ASET (menu_items, menu_items_used, Qquote); |
213 | menu_items_used++; | |
279a1d4b CY |
214 | } |
215 | ||
216 | /* Start a new menu pane in menu_items. | |
217 | NAME is the pane name. PREFIX_VEC is a prefix key for this pane. */ | |
218 | ||
593c843c | 219 | static void |
971de7fb | 220 | push_menu_pane (Lisp_Object name, Lisp_Object prefix_vec) |
279a1d4b | 221 | { |
d311d28c | 222 | ensure_menu_items (MENU_ITEMS_PANE_LENGTH); |
279a1d4b CY |
223 | if (menu_items_submenu_depth == 0) |
224 | menu_items_n_panes++; | |
fb7da12e AS |
225 | ASET (menu_items, menu_items_used, Qt); |
226 | menu_items_used++; | |
227 | ASET (menu_items, menu_items_used, name); | |
228 | menu_items_used++; | |
229 | ASET (menu_items, menu_items_used, prefix_vec); | |
230 | menu_items_used++; | |
279a1d4b CY |
231 | } |
232 | ||
233 | /* Push one menu item into the current pane. NAME is the string to | |
234 | display. ENABLE if non-nil means this item can be selected. KEY | |
235 | is the key generated by choosing this item, or nil if this item | |
236 | doesn't really have a definition. DEF is the definition of this | |
237 | item. EQUIV is the textual description of the keyboard equivalent | |
238 | for this item (or nil if none). TYPE is the type of this menu | |
239 | item, one of nil, `toggle' or `radio'. */ | |
240 | ||
593c843c | 241 | static void |
971de7fb | 242 | push_menu_item (Lisp_Object name, Lisp_Object enable, Lisp_Object key, Lisp_Object def, Lisp_Object equiv, Lisp_Object type, Lisp_Object selected, Lisp_Object help) |
279a1d4b | 243 | { |
d311d28c | 244 | ensure_menu_items (MENU_ITEMS_ITEM_LENGTH); |
279a1d4b | 245 | |
b7c7a4d1 SM |
246 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_NAME, name); |
247 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_ENABLE, enable); | |
248 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_VALUE, key); | |
249 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_EQUIV_KEY, equiv); | |
250 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_DEFINITION, def); | |
251 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_TYPE, type); | |
252 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_SELECTED, selected); | |
253 | ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_HELP, help); | |
254 | ||
255 | menu_items_used += MENU_ITEMS_ITEM_LENGTH; | |
279a1d4b CY |
256 | } |
257 | ||
258 | /* Args passed between single_keymap_panes and single_menu_item. */ | |
259 | struct skp | |
260 | { | |
261 | Lisp_Object pending_maps; | |
ef7417fd | 262 | int maxdepth; |
279a1d4b CY |
263 | int notbuttons; |
264 | }; | |
265 | ||
f57e2426 J |
266 | static void single_menu_item (Lisp_Object, Lisp_Object, Lisp_Object, |
267 | void *); | |
279a1d4b CY |
268 | |
269 | /* This is a recursive subroutine of keymap_panes. | |
270 | It handles one keymap, KEYMAP. | |
271 | The other arguments are passed along | |
272 | or point to local variables of the previous function. | |
279a1d4b CY |
273 | |
274 | If we encounter submenus deeper than MAXDEPTH levels, ignore them. */ | |
275 | ||
593c843c | 276 | static void |
ef7417fd SM |
277 | single_keymap_panes (Lisp_Object keymap, Lisp_Object pane_name, |
278 | Lisp_Object prefix, int maxdepth) | |
279a1d4b CY |
279 | { |
280 | struct skp skp; | |
281 | struct gcpro gcpro1; | |
282 | ||
283 | skp.pending_maps = Qnil; | |
284 | skp.maxdepth = maxdepth; | |
279a1d4b CY |
285 | skp.notbuttons = 0; |
286 | ||
287 | if (maxdepth <= 0) | |
288 | return; | |
289 | ||
290 | push_menu_pane (pane_name, prefix); | |
291 | ||
292 | #ifndef HAVE_BOXES | |
293 | /* Remember index for first item in this pane so we can go back and | |
294 | add a prefix when (if) we see the first button. After that, notbuttons | |
295 | is set to 0, to mark that we have seen a button and all non button | |
296 | items need a prefix. */ | |
297 | skp.notbuttons = menu_items_used; | |
298 | #endif | |
299 | ||
300 | GCPRO1 (skp.pending_maps); | |
301 | map_keymap_canonical (keymap, single_menu_item, Qnil, &skp); | |
302 | UNGCPRO; | |
303 | ||
304 | /* Process now any submenus which want to be panes at this level. */ | |
305 | while (CONSP (skp.pending_maps)) | |
306 | { | |
307 | Lisp_Object elt, eltcdr, string; | |
308 | elt = XCAR (skp.pending_maps); | |
309 | eltcdr = XCDR (elt); | |
310 | string = XCAR (eltcdr); | |
311 | /* We no longer discard the @ from the beginning of the string here. | |
312 | Instead, we do this in *menu_show. */ | |
ef7417fd | 313 | single_keymap_panes (Fcar (elt), string, XCDR (eltcdr), maxdepth - 1); |
279a1d4b CY |
314 | skp.pending_maps = XCDR (skp.pending_maps); |
315 | } | |
316 | } | |
317 | ||
318 | /* This is a subroutine of single_keymap_panes that handles one | |
319 | keymap entry. | |
320 | KEY is a key in a keymap and ITEM is its binding. | |
321 | SKP->PENDING_MAPS_PTR is a list of keymaps waiting to be made into | |
322 | separate panes. | |
279a1d4b CY |
323 | If we encounter submenus deeper than SKP->MAXDEPTH levels, ignore them. */ |
324 | ||
325 | static void | |
971de7fb | 326 | single_menu_item (Lisp_Object key, Lisp_Object item, Lisp_Object dummy, void *skp_v) |
279a1d4b CY |
327 | { |
328 | Lisp_Object map, item_string, enabled; | |
329 | struct gcpro gcpro1, gcpro2; | |
330 | int res; | |
331 | struct skp *skp = skp_v; | |
332 | ||
333 | /* Parse the menu item and leave the result in item_properties. */ | |
334 | GCPRO2 (key, item); | |
ef7417fd | 335 | res = parse_menu_item (item, 0); |
279a1d4b CY |
336 | UNGCPRO; |
337 | if (!res) | |
338 | return; /* Not a menu item. */ | |
339 | ||
28be1ada | 340 | map = AREF (item_properties, ITEM_PROPERTY_MAP); |
279a1d4b | 341 | |
28be1ada DA |
342 | enabled = AREF (item_properties, ITEM_PROPERTY_ENABLE); |
343 | item_string = AREF (item_properties, ITEM_PROPERTY_NAME); | |
279a1d4b CY |
344 | |
345 | if (!NILP (map) && SREF (item_string, 0) == '@') | |
346 | { | |
347 | if (!NILP (enabled)) | |
348 | /* An enabled separate pane. Remember this to handle it later. */ | |
349 | skp->pending_maps = Fcons (Fcons (map, Fcons (item_string, key)), | |
350 | skp->pending_maps); | |
351 | return; | |
352 | } | |
353 | ||
5e617bc2 | 354 | #if defined (HAVE_X_WINDOWS) || defined (MSDOS) |
279a1d4b CY |
355 | #ifndef HAVE_BOXES |
356 | /* Simulate radio buttons and toggle boxes by putting a prefix in | |
357 | front of them. */ | |
358 | { | |
359 | Lisp_Object prefix = Qnil; | |
28be1ada | 360 | Lisp_Object type = AREF (item_properties, ITEM_PROPERTY_TYPE); |
279a1d4b CY |
361 | if (!NILP (type)) |
362 | { | |
363 | Lisp_Object selected | |
28be1ada | 364 | = AREF (item_properties, ITEM_PROPERTY_SELECTED); |
279a1d4b CY |
365 | |
366 | if (skp->notbuttons) | |
367 | /* The first button. Line up previous items in this menu. */ | |
368 | { | |
60d9e1db | 369 | int idx = skp->notbuttons; /* Index for first item this menu. */ |
279a1d4b CY |
370 | int submenu = 0; |
371 | Lisp_Object tem; | |
60d9e1db | 372 | while (idx < menu_items_used) |
279a1d4b CY |
373 | { |
374 | tem | |
28be1ada | 375 | = AREF (menu_items, idx + MENU_ITEMS_ITEM_NAME); |
279a1d4b CY |
376 | if (NILP (tem)) |
377 | { | |
60d9e1db | 378 | idx++; |
279a1d4b CY |
379 | submenu++; /* Skip sub menu. */ |
380 | } | |
381 | else if (EQ (tem, Qlambda)) | |
382 | { | |
60d9e1db | 383 | idx++; |
279a1d4b CY |
384 | submenu--; /* End sub menu. */ |
385 | } | |
386 | else if (EQ (tem, Qt)) | |
60d9e1db | 387 | idx += 3; /* Skip new pane marker. */ |
279a1d4b | 388 | else if (EQ (tem, Qquote)) |
60d9e1db | 389 | idx++; /* Skip a left, right divider. */ |
279a1d4b CY |
390 | else |
391 | { | |
392 | if (!submenu && SREF (tem, 0) != '\0' | |
393 | && SREF (tem, 0) != '-') | |
28be1ada DA |
394 | ASET (menu_items, idx + MENU_ITEMS_ITEM_NAME, |
395 | concat2 (build_string (" "), tem)); | |
60d9e1db | 396 | idx += MENU_ITEMS_ITEM_LENGTH; |
279a1d4b CY |
397 | } |
398 | } | |
399 | skp->notbuttons = 0; | |
400 | } | |
401 | ||
402 | /* Calculate prefix, if any, for this item. */ | |
403 | if (EQ (type, QCtoggle)) | |
404 | prefix = build_string (NILP (selected) ? "[ ] " : "[X] "); | |
405 | else if (EQ (type, QCradio)) | |
406 | prefix = build_string (NILP (selected) ? "( ) " : "(*) "); | |
407 | } | |
408 | /* Not a button. If we have earlier buttons, then we need a prefix. */ | |
409 | else if (!skp->notbuttons && SREF (item_string, 0) != '\0' | |
410 | && SREF (item_string, 0) != '-') | |
411 | prefix = build_string (" "); | |
412 | ||
413 | if (!NILP (prefix)) | |
414 | item_string = concat2 (prefix, item_string); | |
415 | } | |
416 | #endif /* not HAVE_BOXES */ | |
417 | ||
418 | #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) | |
419 | if (!NILP (map)) | |
420 | /* Indicate visually that this is a submenu. */ | |
421 | item_string = concat2 (item_string, build_string (" >")); | |
422 | #endif | |
423 | ||
dda86321 | 424 | #endif /* HAVE_X_WINDOWS || MSDOS */ |
279a1d4b CY |
425 | |
426 | push_menu_item (item_string, enabled, key, | |
28be1ada DA |
427 | AREF (item_properties, ITEM_PROPERTY_DEF), |
428 | AREF (item_properties, ITEM_PROPERTY_KEYEQ), | |
429 | AREF (item_properties, ITEM_PROPERTY_TYPE), | |
430 | AREF (item_properties, ITEM_PROPERTY_SELECTED), | |
431 | AREF (item_properties, ITEM_PROPERTY_HELP)); | |
279a1d4b | 432 | |
edfda783 | 433 | #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI) |
279a1d4b CY |
434 | /* Display a submenu using the toolkit. */ |
435 | if (! (NILP (map) || NILP (enabled))) | |
436 | { | |
437 | push_submenu_start (); | |
ef7417fd | 438 | single_keymap_panes (map, Qnil, key, skp->maxdepth - 1); |
279a1d4b CY |
439 | push_submenu_end (); |
440 | } | |
441 | #endif | |
442 | } | |
443 | ||
444 | /* Look through KEYMAPS, a vector of keymaps that is NMAPS long, | |
ef7417fd | 445 | and generate menu panes for them in menu_items. */ |
279a1d4b | 446 | |
ef7417fd | 447 | static void |
d311d28c | 448 | keymap_panes (Lisp_Object *keymaps, ptrdiff_t nmaps) |
279a1d4b | 449 | { |
d311d28c | 450 | ptrdiff_t mapno; |
279a1d4b CY |
451 | |
452 | init_menu_items (); | |
453 | ||
454 | /* Loop over the given keymaps, making a pane for each map. | |
455 | But don't make a pane that is empty--ignore that map instead. | |
456 | P is the number of panes we have made so far. */ | |
457 | for (mapno = 0; mapno < nmaps; mapno++) | |
458 | single_keymap_panes (keymaps[mapno], | |
ef7417fd | 459 | Fkeymap_prompt (keymaps[mapno]), Qnil, 10); |
279a1d4b CY |
460 | |
461 | finish_menu_items (); | |
462 | } | |
463 | ||
464 | ||
465 | /* Push the items in a single pane defined by the alist PANE. */ | |
466 | static void | |
971de7fb | 467 | list_of_items (Lisp_Object pane) |
279a1d4b CY |
468 | { |
469 | Lisp_Object tail, item, item1; | |
470 | ||
471 | for (tail = pane; CONSP (tail); tail = XCDR (tail)) | |
472 | { | |
473 | item = XCAR (tail); | |
474 | if (STRINGP (item)) | |
475 | push_menu_item (ENCODE_MENU_STRING (item), Qnil, Qnil, Qt, | |
476 | Qnil, Qnil, Qnil, Qnil); | |
477 | else if (CONSP (item)) | |
478 | { | |
479 | item1 = XCAR (item); | |
480 | CHECK_STRING (item1); | |
481 | push_menu_item (ENCODE_MENU_STRING (item1), Qt, XCDR (item), | |
482 | Qt, Qnil, Qnil, Qnil, Qnil); | |
483 | } | |
484 | else | |
485 | push_left_right_boundary (); | |
486 | ||
487 | } | |
488 | } | |
489 | ||
490 | /* Push all the panes and items of a menu described by the | |
491 | alist-of-alists MENU. | |
492 | This handles old-fashioned calls to x-popup-menu. */ | |
493 | void | |
971de7fb | 494 | list_of_panes (Lisp_Object menu) |
279a1d4b CY |
495 | { |
496 | Lisp_Object tail; | |
497 | ||
498 | init_menu_items (); | |
499 | ||
500 | for (tail = menu; CONSP (tail); tail = XCDR (tail)) | |
501 | { | |
502 | Lisp_Object elt, pane_name, pane_data; | |
503 | elt = XCAR (tail); | |
504 | pane_name = Fcar (elt); | |
505 | CHECK_STRING (pane_name); | |
506 | push_menu_pane (ENCODE_MENU_STRING (pane_name), Qnil); | |
507 | pane_data = Fcdr (elt); | |
508 | CHECK_CONS (pane_data); | |
509 | list_of_items (pane_data); | |
510 | } | |
511 | ||
512 | finish_menu_items (); | |
513 | } | |
514 | ||
515 | /* Set up data in menu_items for a menu bar item | |
516 | whose event type is ITEM_KEY (with string ITEM_NAME) | |
517 | and whose contents come from the list of keymaps MAPS. */ | |
518 | int | |
971de7fb | 519 | parse_single_submenu (Lisp_Object item_key, Lisp_Object item_name, Lisp_Object maps) |
279a1d4b CY |
520 | { |
521 | Lisp_Object length; | |
d311d28c | 522 | EMACS_INT len; |
279a1d4b | 523 | Lisp_Object *mapvec; |
d311d28c | 524 | ptrdiff_t i; |
279a1d4b | 525 | int top_level_items = 0; |
d311d28c | 526 | USE_SAFE_ALLOCA; |
279a1d4b CY |
527 | |
528 | length = Flength (maps); | |
529 | len = XINT (length); | |
530 | ||
531 | /* Convert the list MAPS into a vector MAPVEC. */ | |
d311d28c | 532 | SAFE_ALLOCA_LISP (mapvec, len); |
279a1d4b CY |
533 | for (i = 0; i < len; i++) |
534 | { | |
535 | mapvec[i] = Fcar (maps); | |
536 | maps = Fcdr (maps); | |
537 | } | |
538 | ||
539 | /* Loop over the given keymaps, making a pane for each map. | |
540 | But don't make a pane that is empty--ignore that map instead. */ | |
541 | for (i = 0; i < len; i++) | |
542 | { | |
543 | if (!KEYMAPP (mapvec[i])) | |
544 | { | |
545 | /* Here we have a command at top level in the menu bar | |
546 | as opposed to a submenu. */ | |
547 | top_level_items = 1; | |
548 | push_menu_pane (Qnil, Qnil); | |
549 | push_menu_item (item_name, Qt, item_key, mapvec[i], | |
550 | Qnil, Qnil, Qnil, Qnil); | |
551 | } | |
552 | else | |
553 | { | |
554 | Lisp_Object prompt; | |
555 | prompt = Fkeymap_prompt (mapvec[i]); | |
556 | single_keymap_panes (mapvec[i], | |
557 | !NILP (prompt) ? prompt : item_name, | |
ef7417fd | 558 | item_key, 10); |
279a1d4b CY |
559 | } |
560 | } | |
561 | ||
d311d28c | 562 | SAFE_FREE (); |
279a1d4b CY |
563 | return top_level_items; |
564 | } | |
565 | ||
566 | \f | |
edfda783 | 567 | #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI) |
279a1d4b CY |
568 | |
569 | /* Allocate a widget_value, blocking input. */ | |
570 | ||
571 | widget_value * | |
971de7fb | 572 | xmalloc_widget_value (void) |
279a1d4b CY |
573 | { |
574 | widget_value *value; | |
575 | ||
4d7e6e51 | 576 | block_input (); |
279a1d4b | 577 | value = malloc_widget_value (); |
4d7e6e51 | 578 | unblock_input (); |
279a1d4b CY |
579 | |
580 | return value; | |
581 | } | |
582 | ||
583 | /* This recursively calls free_widget_value on the tree of widgets. | |
584 | It must free all data that was malloc'ed for these widget_values. | |
585 | In Emacs, many slots are pointers into the data of Lisp_Strings, and | |
586 | must be left alone. */ | |
587 | ||
588 | void | |
971de7fb | 589 | free_menubar_widget_value_tree (widget_value *wv) |
279a1d4b CY |
590 | { |
591 | if (! wv) return; | |
592 | ||
593 | wv->name = wv->value = wv->key = (char *) 0xDEADBEEF; | |
594 | ||
595 | if (wv->contents && (wv->contents != (widget_value*)1)) | |
596 | { | |
597 | free_menubar_widget_value_tree (wv->contents); | |
598 | wv->contents = (widget_value *) 0xDEADBEEF; | |
599 | } | |
600 | if (wv->next) | |
601 | { | |
602 | free_menubar_widget_value_tree (wv->next); | |
603 | wv->next = (widget_value *) 0xDEADBEEF; | |
604 | } | |
4d7e6e51 | 605 | block_input (); |
279a1d4b | 606 | free_widget_value (wv); |
4d7e6e51 | 607 | unblock_input (); |
279a1d4b CY |
608 | } |
609 | ||
610 | /* Create a tree of widget_value objects | |
611 | representing the panes and items | |
612 | in menu_items starting at index START, up to index END. */ | |
613 | ||
614 | widget_value * | |
971de7fb | 615 | digest_single_submenu (int start, int end, int top_level_items) |
279a1d4b CY |
616 | { |
617 | widget_value *wv, *prev_wv, *save_wv, *first_wv; | |
618 | int i; | |
619 | int submenu_depth = 0; | |
620 | widget_value **submenu_stack; | |
621 | int panes_seen = 0; | |
622 | ||
38182d90 | 623 | submenu_stack = alloca (menu_items_used * sizeof *submenu_stack); |
279a1d4b CY |
624 | wv = xmalloc_widget_value (); |
625 | wv->name = "menu"; | |
626 | wv->value = 0; | |
627 | wv->enabled = 1; | |
628 | wv->button_type = BUTTON_TYPE_NONE; | |
629 | wv->help = Qnil; | |
630 | first_wv = wv; | |
631 | save_wv = 0; | |
632 | prev_wv = 0; | |
633 | ||
634 | /* Loop over all panes and items made by the preceding call | |
635 | to parse_single_submenu and construct a tree of widget_value objects. | |
636 | Ignore the panes and items used by previous calls to | |
637 | digest_single_submenu, even though those are also in menu_items. */ | |
638 | i = start; | |
639 | while (i < end) | |
640 | { | |
28be1ada | 641 | if (EQ (AREF (menu_items, i), Qnil)) |
279a1d4b CY |
642 | { |
643 | submenu_stack[submenu_depth++] = save_wv; | |
644 | save_wv = prev_wv; | |
645 | prev_wv = 0; | |
646 | i++; | |
647 | } | |
28be1ada | 648 | else if (EQ (AREF (menu_items, i), Qlambda)) |
279a1d4b CY |
649 | { |
650 | prev_wv = save_wv; | |
651 | save_wv = submenu_stack[--submenu_depth]; | |
652 | i++; | |
653 | } | |
28be1ada | 654 | else if (EQ (AREF (menu_items, i), Qt) |
279a1d4b CY |
655 | && submenu_depth != 0) |
656 | i += MENU_ITEMS_PANE_LENGTH; | |
657 | /* Ignore a nil in the item list. | |
658 | It's meaningful only for dialog boxes. */ | |
28be1ada | 659 | else if (EQ (AREF (menu_items, i), Qquote)) |
279a1d4b | 660 | i += 1; |
28be1ada | 661 | else if (EQ (AREF (menu_items, i), Qt)) |
279a1d4b CY |
662 | { |
663 | /* Create a new pane. */ | |
b01a1c29 | 664 | Lisp_Object pane_name; |
675e2c69 | 665 | const char *pane_string; |
279a1d4b CY |
666 | |
667 | panes_seen++; | |
668 | ||
28be1ada | 669 | pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME); |
279a1d4b CY |
670 | |
671 | #ifdef HAVE_NTGUI | |
672 | if (STRINGP (pane_name)) | |
673 | { | |
674 | if (unicode_append_menu) | |
675 | /* Encode as UTF-8 for now. */ | |
676 | pane_name = ENCODE_UTF_8 (pane_name); | |
677 | else if (STRING_MULTIBYTE (pane_name)) | |
678 | pane_name = ENCODE_SYSTEM (pane_name); | |
679 | ||
680 | ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name); | |
681 | } | |
99852628 JD |
682 | #elif defined (USE_LUCID) && defined (HAVE_XFT) |
683 | if (STRINGP (pane_name)) | |
684 | { | |
685 | pane_name = ENCODE_UTF_8 (pane_name); | |
686 | ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name); | |
687 | } | |
279a1d4b CY |
688 | #elif !defined (HAVE_MULTILINGUAL_MENU) |
689 | if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name)) | |
690 | { | |
691 | pane_name = ENCODE_MENU_STRING (pane_name); | |
692 | ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name); | |
693 | } | |
694 | #endif | |
695 | ||
696 | pane_string = (NILP (pane_name) | |
51b59d79 | 697 | ? "" : SSDATA (pane_name)); |
279a1d4b CY |
698 | /* If there is just one top-level pane, put all its items directly |
699 | under the top-level menu. */ | |
700 | if (menu_items_n_panes == 1) | |
701 | pane_string = ""; | |
702 | ||
703 | /* If the pane has a meaningful name, | |
704 | make the pane a top-level menu item | |
705 | with its items as a submenu beneath it. */ | |
706 | if (strcmp (pane_string, "")) | |
707 | { | |
708 | wv = xmalloc_widget_value (); | |
709 | if (save_wv) | |
710 | save_wv->next = wv; | |
711 | else | |
712 | first_wv->contents = wv; | |
713 | wv->lname = pane_name; | |
714 | /* Set value to 1 so update_submenu_strings can handle '@' */ | |
715 | wv->value = (char *)1; | |
716 | wv->enabled = 1; | |
717 | wv->button_type = BUTTON_TYPE_NONE; | |
718 | wv->help = Qnil; | |
719 | save_wv = wv; | |
720 | } | |
721 | else | |
722 | save_wv = first_wv; | |
723 | ||
724 | prev_wv = 0; | |
725 | i += MENU_ITEMS_PANE_LENGTH; | |
726 | } | |
727 | else | |
728 | { | |
729 | /* Create a new item within current pane. */ | |
730 | Lisp_Object item_name, enable, descrip, def, type, selected; | |
731 | Lisp_Object help; | |
732 | ||
733 | /* All items should be contained in panes. */ | |
734 | if (panes_seen == 0) | |
1088b922 | 735 | emacs_abort (); |
279a1d4b CY |
736 | |
737 | item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME); | |
738 | enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE); | |
739 | descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY); | |
740 | def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION); | |
741 | type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE); | |
742 | selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED); | |
743 | help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP); | |
744 | ||
745 | #ifdef HAVE_NTGUI | |
746 | if (STRINGP (item_name)) | |
747 | { | |
748 | if (unicode_append_menu) | |
749 | item_name = ENCODE_UTF_8 (item_name); | |
750 | else if (STRING_MULTIBYTE (item_name)) | |
751 | item_name = ENCODE_SYSTEM (item_name); | |
752 | ||
753 | ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name); | |
754 | } | |
755 | ||
756 | if (STRINGP (descrip) && STRING_MULTIBYTE (descrip)) | |
757 | { | |
758 | descrip = ENCODE_SYSTEM (descrip); | |
759 | ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip); | |
760 | } | |
99852628 JD |
761 | #elif USE_LUCID |
762 | if (STRINGP (item_name)) | |
763 | { | |
764 | item_name = ENCODE_UTF_8 (item_name); | |
765 | ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name); | |
766 | } | |
767 | ||
768 | if (STRINGP (descrip)) | |
769 | { | |
770 | descrip = ENCODE_UTF_8 (descrip); | |
771 | ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip); | |
772 | } | |
279a1d4b CY |
773 | #elif !defined (HAVE_MULTILINGUAL_MENU) |
774 | if (STRING_MULTIBYTE (item_name)) | |
775 | { | |
776 | item_name = ENCODE_MENU_STRING (item_name); | |
777 | ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name); | |
778 | } | |
779 | ||
780 | if (STRINGP (descrip) && STRING_MULTIBYTE (descrip)) | |
781 | { | |
782 | descrip = ENCODE_MENU_STRING (descrip); | |
783 | ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip); | |
784 | } | |
785 | #endif | |
786 | ||
787 | wv = xmalloc_widget_value (); | |
788 | if (prev_wv) | |
789 | prev_wv->next = wv; | |
790 | else | |
791 | save_wv->contents = wv; | |
792 | ||
793 | wv->lname = item_name; | |
794 | if (!NILP (descrip)) | |
795 | wv->lkey = descrip; | |
796 | wv->value = 0; | |
d01a7826 | 797 | /* The intptr_t cast avoids a warning. There's no problem |
279a1d4b | 798 | as long as pointers have enough bits to hold small integers. */ |
d01a7826 | 799 | wv->call_data = (!NILP (def) ? (void *) (intptr_t) i : 0); |
279a1d4b CY |
800 | wv->enabled = !NILP (enable); |
801 | ||
802 | if (NILP (type)) | |
803 | wv->button_type = BUTTON_TYPE_NONE; | |
804 | else if (EQ (type, QCradio)) | |
805 | wv->button_type = BUTTON_TYPE_RADIO; | |
806 | else if (EQ (type, QCtoggle)) | |
807 | wv->button_type = BUTTON_TYPE_TOGGLE; | |
808 | else | |
1088b922 | 809 | emacs_abort (); |
279a1d4b CY |
810 | |
811 | wv->selected = !NILP (selected); | |
812 | if (! STRINGP (help)) | |
813 | help = Qnil; | |
814 | ||
815 | wv->help = help; | |
816 | ||
817 | prev_wv = wv; | |
818 | ||
819 | i += MENU_ITEMS_ITEM_LENGTH; | |
820 | } | |
821 | } | |
822 | ||
823 | /* If we have just one "menu item" | |
824 | that was originally a button, return it by itself. */ | |
825 | if (top_level_items && first_wv->contents && first_wv->contents->next == 0) | |
826 | { | |
827 | wv = first_wv->contents; | |
828 | free_widget_value (first_wv); | |
829 | return wv; | |
830 | } | |
831 | ||
832 | return first_wv; | |
833 | } | |
834 | ||
835 | /* Walk through the widget_value tree starting at FIRST_WV and update | |
836 | the char * pointers from the corresponding lisp values. | |
837 | We do this after building the whole tree, since GC may happen while the | |
838 | tree is constructed, and small strings are relocated. So we must wait | |
839 | until no GC can happen before storing pointers into lisp values. */ | |
840 | void | |
971de7fb | 841 | update_submenu_strings (widget_value *first_wv) |
279a1d4b CY |
842 | { |
843 | widget_value *wv; | |
844 | ||
845 | for (wv = first_wv; wv; wv = wv->next) | |
846 | { | |
847 | if (STRINGP (wv->lname)) | |
848 | { | |
51b59d79 | 849 | wv->name = SSDATA (wv->lname); |
279a1d4b CY |
850 | |
851 | /* Ignore the @ that means "separate pane". | |
852 | This is a kludge, but this isn't worth more time. */ | |
853 | if (wv->value == (char *)1) | |
854 | { | |
855 | if (wv->name[0] == '@') | |
856 | wv->name++; | |
857 | wv->value = 0; | |
858 | } | |
859 | } | |
860 | ||
861 | if (STRINGP (wv->lkey)) | |
51b59d79 | 862 | wv->key = SSDATA (wv->lkey); |
279a1d4b CY |
863 | |
864 | if (wv->contents) | |
865 | update_submenu_strings (wv->contents); | |
866 | } | |
867 | } | |
868 | ||
869 | /* Find the menu selection and store it in the keyboard buffer. | |
870 | F is the frame the menu is on. | |
871 | MENU_BAR_ITEMS_USED is the length of VECTOR. | |
872 | VECTOR is an array of menu events for the whole menu. */ | |
873 | ||
874 | void | |
971de7fb | 875 | find_and_call_menu_selection (FRAME_PTR f, int menu_bar_items_used, Lisp_Object vector, void *client_data) |
279a1d4b CY |
876 | { |
877 | Lisp_Object prefix, entry; | |
878 | Lisp_Object *subprefix_stack; | |
879 | int submenu_depth = 0; | |
880 | int i; | |
881 | ||
882 | entry = Qnil; | |
38182d90 | 883 | subprefix_stack = alloca (menu_bar_items_used * sizeof *subprefix_stack); |
279a1d4b CY |
884 | prefix = Qnil; |
885 | i = 0; | |
886 | ||
887 | while (i < menu_bar_items_used) | |
888 | { | |
28be1ada | 889 | if (EQ (AREF (vector, i), Qnil)) |
279a1d4b CY |
890 | { |
891 | subprefix_stack[submenu_depth++] = prefix; | |
892 | prefix = entry; | |
893 | i++; | |
894 | } | |
28be1ada | 895 | else if (EQ (AREF (vector, i), Qlambda)) |
279a1d4b CY |
896 | { |
897 | prefix = subprefix_stack[--submenu_depth]; | |
898 | i++; | |
899 | } | |
28be1ada | 900 | else if (EQ (AREF (vector, i), Qt)) |
279a1d4b | 901 | { |
28be1ada | 902 | prefix = AREF (vector, i + MENU_ITEMS_PANE_PREFIX); |
279a1d4b CY |
903 | i += MENU_ITEMS_PANE_LENGTH; |
904 | } | |
905 | else | |
906 | { | |
28be1ada | 907 | entry = AREF (vector, i + MENU_ITEMS_ITEM_VALUE); |
8ac068ac | 908 | /* Treat the pointer as an integer. There's no problem |
279a1d4b | 909 | as long as pointers have enough bits to hold small integers. */ |
d01a7826 | 910 | if ((intptr_t) client_data == i) |
279a1d4b CY |
911 | { |
912 | int j; | |
913 | struct input_event buf; | |
914 | Lisp_Object frame; | |
915 | EVENT_INIT (buf); | |
916 | ||
917 | XSETFRAME (frame, f); | |
918 | buf.kind = MENU_BAR_EVENT; | |
919 | buf.frame_or_window = frame; | |
920 | buf.arg = frame; | |
921 | kbd_buffer_store_event (&buf); | |
922 | ||
923 | for (j = 0; j < submenu_depth; j++) | |
924 | if (!NILP (subprefix_stack[j])) | |
925 | { | |
926 | buf.kind = MENU_BAR_EVENT; | |
927 | buf.frame_or_window = frame; | |
928 | buf.arg = subprefix_stack[j]; | |
929 | kbd_buffer_store_event (&buf); | |
930 | } | |
931 | ||
932 | if (!NILP (prefix)) | |
933 | { | |
934 | buf.kind = MENU_BAR_EVENT; | |
935 | buf.frame_or_window = frame; | |
936 | buf.arg = prefix; | |
937 | kbd_buffer_store_event (&buf); | |
938 | } | |
939 | ||
940 | buf.kind = MENU_BAR_EVENT; | |
941 | buf.frame_or_window = frame; | |
942 | buf.arg = entry; | |
943 | kbd_buffer_store_event (&buf); | |
944 | ||
945 | return; | |
946 | } | |
947 | i += MENU_ITEMS_ITEM_LENGTH; | |
948 | } | |
949 | } | |
950 | } | |
951 | ||
edfda783 AR |
952 | #endif /* USE_X_TOOLKIT || USE_GTK || HAVE_NS || HAVE_NTGUI */ |
953 | ||
954 | #ifdef HAVE_NS | |
955 | /* As above, but return the menu selection instead of storing in kb buffer. | |
956 | If keymaps==1, return full prefixes to selection. */ | |
957 | Lisp_Object | |
958 | find_and_return_menu_selection (FRAME_PTR f, int keymaps, void *client_data) | |
959 | { | |
960 | Lisp_Object prefix, entry; | |
961 | int i; | |
962 | Lisp_Object *subprefix_stack; | |
963 | int submenu_depth = 0; | |
964 | ||
965 | prefix = entry = Qnil; | |
966 | i = 0; | |
663e2b3f | 967 | subprefix_stack = alloca (menu_items_used * word_size); |
edfda783 AR |
968 | |
969 | while (i < menu_items_used) | |
970 | { | |
28be1ada | 971 | if (EQ (AREF (menu_items, i), Qnil)) |
edfda783 AR |
972 | { |
973 | subprefix_stack[submenu_depth++] = prefix; | |
974 | prefix = entry; | |
975 | i++; | |
976 | } | |
28be1ada | 977 | else if (EQ (AREF (menu_items, i), Qlambda)) |
edfda783 AR |
978 | { |
979 | prefix = subprefix_stack[--submenu_depth]; | |
980 | i++; | |
981 | } | |
28be1ada | 982 | else if (EQ (AREF (menu_items, i), Qt)) |
edfda783 AR |
983 | { |
984 | prefix | |
28be1ada | 985 | = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX); |
edfda783 AR |
986 | i += MENU_ITEMS_PANE_LENGTH; |
987 | } | |
988 | /* Ignore a nil in the item list. | |
989 | It's meaningful only for dialog boxes. */ | |
28be1ada | 990 | else if (EQ (AREF (menu_items, i), Qquote)) |
edfda783 AR |
991 | i += 1; |
992 | else | |
993 | { | |
994 | entry | |
28be1ada | 995 | = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE); |
4939150c | 996 | if (aref_addr (menu_items, i) == client_data) |
edfda783 AR |
997 | { |
998 | if (keymaps != 0) | |
999 | { | |
1000 | int j; | |
1001 | ||
1002 | entry = Fcons (entry, Qnil); | |
1003 | if (!NILP (prefix)) | |
1004 | entry = Fcons (prefix, entry); | |
1005 | for (j = submenu_depth - 1; j >= 0; j--) | |
1006 | if (!NILP (subprefix_stack[j])) | |
1007 | entry = Fcons (subprefix_stack[j], entry); | |
1008 | } | |
1009 | return entry; | |
1010 | } | |
1011 | i += MENU_ITEMS_ITEM_LENGTH; | |
1012 | } | |
1013 | } | |
facfbbbd | 1014 | return Qnil; |
edfda783 | 1015 | } |
31c2d412 | 1016 | #endif /* HAVE_NS */ |
279a1d4b | 1017 | |
a7ca3326 | 1018 | DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0, |
ef7417fd SM |
1019 | doc: /* Pop up a deck-of-cards menu and return user's selection. |
1020 | POSITION is a position specification. This is either a mouse button event | |
1021 | or a list ((XOFFSET YOFFSET) WINDOW) | |
1022 | where XOFFSET and YOFFSET are positions in pixels from the top left | |
1023 | corner of WINDOW. (WINDOW may be a window or a frame object.) | |
1024 | This controls the position of the top left of the menu as a whole. | |
1025 | If POSITION is t, it means to use the current mouse position. | |
1026 | ||
1027 | MENU is a specifier for a menu. For the simplest case, MENU is a keymap. | |
1028 | The menu items come from key bindings that have a menu string as well as | |
1029 | a definition; actually, the "definition" in such a key binding looks like | |
1030 | \(STRING . REAL-DEFINITION). To give the menu a title, put a string into | |
1031 | the keymap as a top-level element. | |
1032 | ||
1033 | If REAL-DEFINITION is nil, that puts a nonselectable string in the menu. | |
1034 | Otherwise, REAL-DEFINITION should be a valid key binding definition. | |
1035 | ||
1036 | You can also use a list of keymaps as MENU. | |
1037 | Then each keymap makes a separate pane. | |
1038 | ||
1039 | When MENU is a keymap or a list of keymaps, the return value is the | |
1040 | list of events corresponding to the user's choice. Note that | |
1041 | `x-popup-menu' does not actually execute the command bound to that | |
1042 | sequence of events. | |
1043 | ||
1044 | Alternatively, you can specify a menu of multiple panes | |
1045 | with a list of the form (TITLE PANE1 PANE2...), | |
1046 | where each pane is a list of form (TITLE ITEM1 ITEM2...). | |
1047 | Each ITEM is normally a cons cell (STRING . VALUE); | |
1048 | but a string can appear as an item--that makes a nonselectable line | |
1049 | in the menu. | |
1050 | With this form of menu, the return value is VALUE from the chosen item. | |
1051 | ||
1052 | If POSITION is nil, don't display the menu at all, just precalculate the | |
1053 | cached information about equivalent key sequences. | |
1054 | ||
1055 | If the user gets rid of the menu without making a valid choice, for | |
1056 | instance by clicking the mouse away from a valid choice or by typing | |
1057 | keyboard input, then this normally results in a quit and | |
1058 | `x-popup-menu' does not return. But if POSITION is a mouse button | |
1059 | event (indicating that the user invoked the menu with the mouse) then | |
1060 | no quit occurs and `x-popup-menu' returns nil. */) | |
5842a27b | 1061 | (Lisp_Object position, Lisp_Object menu) |
ef7417fd SM |
1062 | { |
1063 | Lisp_Object keymap, tem; | |
1064 | int xpos = 0, ypos = 0; | |
1065 | Lisp_Object title; | |
42ca4633 | 1066 | const char *error_name = NULL; |
ef7417fd SM |
1067 | Lisp_Object selection = Qnil; |
1068 | FRAME_PTR f = NULL; | |
1069 | Lisp_Object x, y, window; | |
1070 | int keymaps = 0; | |
1071 | int for_click = 0; | |
d311d28c | 1072 | ptrdiff_t specpdl_count = SPECPDL_INDEX (); |
ef7417fd | 1073 | struct gcpro gcpro1; |
ef7417fd | 1074 | |
ef7417fd SM |
1075 | if (NILP (position)) |
1076 | /* This is an obsolete call, which wants us to precompute the | |
1077 | keybinding equivalents, but we don't do that any more anyway. */ | |
1078 | return Qnil; | |
1079 | ||
1080 | #ifdef HAVE_MENUS | |
1081 | { | |
1082 | int get_current_pos_p = 0; | |
1083 | /* FIXME!! check_w32 (); or check_x (); or check_ns (); */ | |
1084 | ||
1085 | /* Decode the first argument: find the window and the coordinates. */ | |
1086 | if (EQ (position, Qt) | |
1087 | || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar) | |
1088 | || EQ (XCAR (position), Qtool_bar)))) | |
1089 | { | |
1090 | get_current_pos_p = 1; | |
1091 | } | |
1092 | else | |
1093 | { | |
1094 | tem = Fcar (position); | |
1095 | if (CONSP (tem)) | |
1096 | { | |
1097 | window = Fcar (Fcdr (position)); | |
1098 | x = XCAR (tem); | |
1099 | y = Fcar (XCDR (tem)); | |
1100 | } | |
1101 | else | |
1102 | { | |
1103 | for_click = 1; | |
1104 | tem = Fcar (Fcdr (position)); /* EVENT_START (position) */ | |
1105 | window = Fcar (tem); /* POSN_WINDOW (tem) */ | |
a6d676d9 CY |
1106 | tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */ |
1107 | x = Fcar (tem); | |
1108 | y = Fcdr (tem); | |
ef7417fd SM |
1109 | } |
1110 | ||
1111 | /* If a click happens in an external tool bar or a detached | |
1112 | tool bar, x and y is NIL. In that case, use the current | |
1113 | mouse position. This happens for the help button in the | |
1114 | tool bar. Ideally popup-menu should pass NIL to | |
1115 | this function, but it doesn't. */ | |
1116 | if (NILP (x) && NILP (y)) | |
1117 | get_current_pos_p = 1; | |
1118 | } | |
1119 | ||
1120 | if (get_current_pos_p) | |
1121 | { | |
1122 | /* Use the mouse's current position. */ | |
1123 | FRAME_PTR new_f = SELECTED_FRAME (); | |
1124 | #ifdef HAVE_X_WINDOWS | |
1125 | /* Can't use mouse_position_hook for X since it returns | |
1126 | coordinates relative to the window the mouse is in, | |
1127 | we need coordinates relative to the edit widget always. */ | |
1128 | if (new_f != 0) | |
1129 | { | |
1130 | int cur_x, cur_y; | |
1131 | ||
1132 | mouse_position_for_popup (new_f, &cur_x, &cur_y); | |
1133 | /* cur_x/y may be negative, so use make_number. */ | |
1134 | x = make_number (cur_x); | |
1135 | y = make_number (cur_y); | |
1136 | } | |
1137 | ||
1138 | #else /* not HAVE_X_WINDOWS */ | |
1139 | Lisp_Object bar_window; | |
1140 | enum scroll_bar_part part; | |
08dc5ae6 | 1141 | Time time; |
f57e2426 J |
1142 | void (*mouse_position_hook) (struct frame **, int, |
1143 | Lisp_Object *, | |
1144 | enum scroll_bar_part *, | |
1145 | Lisp_Object *, | |
1146 | Lisp_Object *, | |
08dc5ae6 | 1147 | Time *) = |
ef7417fd SM |
1148 | FRAME_TERMINAL (new_f)->mouse_position_hook; |
1149 | ||
1150 | if (mouse_position_hook) | |
1151 | (*mouse_position_hook) (&new_f, 1, &bar_window, | |
1152 | &part, &x, &y, &time); | |
1153 | #endif /* not HAVE_X_WINDOWS */ | |
1154 | ||
1155 | if (new_f != 0) | |
1156 | XSETFRAME (window, new_f); | |
1157 | else | |
1158 | { | |
1159 | window = selected_window; | |
1160 | XSETFASTINT (x, 0); | |
1161 | XSETFASTINT (y, 0); | |
1162 | } | |
1163 | } | |
1164 | ||
ef7417fd SM |
1165 | /* Decode where to put the menu. */ |
1166 | ||
1167 | if (FRAMEP (window)) | |
1168 | { | |
1169 | f = XFRAME (window); | |
1170 | xpos = 0; | |
1171 | ypos = 0; | |
1172 | } | |
1173 | else if (WINDOWP (window)) | |
1174 | { | |
1175 | struct window *win = XWINDOW (window); | |
1176 | CHECK_LIVE_WINDOW (window); | |
1177 | f = XFRAME (WINDOW_FRAME (win)); | |
1178 | ||
ef7417fd SM |
1179 | xpos = WINDOW_LEFT_EDGE_X (win); |
1180 | ypos = WINDOW_TOP_EDGE_Y (win); | |
ef7417fd SM |
1181 | } |
1182 | else | |
1183 | /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME, | |
1184 | but I don't want to make one now. */ | |
1185 | CHECK_WINDOW (window); | |
1186 | ||
af5a5a98 AS |
1187 | CHECK_RANGED_INTEGER (x, |
1188 | (xpos < INT_MIN - MOST_NEGATIVE_FIXNUM | |
d311d28c PE |
1189 | ? (EMACS_INT) INT_MIN - xpos |
1190 | : MOST_NEGATIVE_FIXNUM), | |
af5a5a98 AS |
1191 | INT_MAX - xpos); |
1192 | CHECK_RANGED_INTEGER (y, | |
1193 | (ypos < INT_MIN - MOST_NEGATIVE_FIXNUM | |
d311d28c PE |
1194 | ? (EMACS_INT) INT_MIN - ypos |
1195 | : MOST_NEGATIVE_FIXNUM), | |
af5a5a98 | 1196 | INT_MAX - ypos); |
ef7417fd SM |
1197 | xpos += XINT (x); |
1198 | ypos += XINT (y); | |
1199 | ||
1200 | /* FIXME: Find a more general check! */ | |
1201 | if (!(FRAME_X_P (f) || FRAME_MSDOS_P (f) | |
1202 | || FRAME_W32_P (f) || FRAME_NS_P (f))) | |
1203 | error ("Can not put GUI menu on this terminal"); | |
1204 | ||
1205 | XSETFRAME (Vmenu_updating_frame, f); | |
1206 | } | |
1207 | #endif /* HAVE_MENUS */ | |
1208 | ||
1209 | /* Now parse the lisp menus. */ | |
1210 | record_unwind_protect (unuse_menu_items, Qnil); | |
1211 | ||
1212 | title = Qnil; | |
1213 | GCPRO1 (title); | |
1214 | ||
1215 | /* Decode the menu items from what was specified. */ | |
1216 | ||
1217 | keymap = get_keymap (menu, 0, 0); | |
1218 | if (CONSP (keymap)) | |
1219 | { | |
1220 | /* We were given a keymap. Extract menu info from the keymap. */ | |
1221 | Lisp_Object prompt; | |
1222 | ||
1223 | /* Extract the detailed info to make one pane. */ | |
1224 | keymap_panes (&menu, 1); | |
1225 | ||
1226 | /* Search for a string appearing directly as an element of the keymap. | |
1227 | That string is the title of the menu. */ | |
1228 | prompt = Fkeymap_prompt (keymap); | |
1229 | if (!NILP (prompt)) | |
1230 | title = prompt; | |
1231 | #ifdef HAVE_NS /* Is that needed and NS-specific? --Stef */ | |
1232 | else | |
1233 | title = build_string ("Select"); | |
1234 | #endif | |
1235 | ||
1236 | /* Make that be the pane title of the first pane. */ | |
1237 | if (!NILP (prompt) && menu_items_n_panes >= 0) | |
1238 | ASET (menu_items, MENU_ITEMS_PANE_NAME, prompt); | |
1239 | ||
1240 | keymaps = 1; | |
1241 | } | |
1242 | else if (CONSP (menu) && KEYMAPP (XCAR (menu))) | |
1243 | { | |
1244 | /* We were given a list of keymaps. */ | |
d311d28c PE |
1245 | EMACS_INT nmaps = XFASTINT (Flength (menu)); |
1246 | Lisp_Object *maps; | |
1247 | ptrdiff_t i; | |
1248 | USE_SAFE_ALLOCA; | |
ef7417fd | 1249 | |
d311d28c | 1250 | SAFE_ALLOCA_LISP (maps, nmaps); |
ef7417fd SM |
1251 | title = Qnil; |
1252 | ||
1253 | /* The first keymap that has a prompt string | |
1254 | supplies the menu title. */ | |
1255 | for (tem = menu, i = 0; CONSP (tem); tem = XCDR (tem)) | |
1256 | { | |
1257 | Lisp_Object prompt; | |
1258 | ||
1259 | maps[i++] = keymap = get_keymap (XCAR (tem), 1, 0); | |
1260 | ||
1261 | prompt = Fkeymap_prompt (keymap); | |
1262 | if (NILP (title) && !NILP (prompt)) | |
1263 | title = prompt; | |
1264 | } | |
1265 | ||
1266 | /* Extract the detailed info to make one pane. */ | |
1267 | keymap_panes (maps, nmaps); | |
1268 | ||
1269 | /* Make the title be the pane title of the first pane. */ | |
1270 | if (!NILP (title) && menu_items_n_panes >= 0) | |
1271 | ASET (menu_items, MENU_ITEMS_PANE_NAME, title); | |
1272 | ||
1273 | keymaps = 1; | |
d311d28c PE |
1274 | |
1275 | SAFE_FREE (); | |
ef7417fd SM |
1276 | } |
1277 | else | |
1278 | { | |
1279 | /* We were given an old-fashioned menu. */ | |
1280 | title = Fcar (menu); | |
1281 | CHECK_STRING (title); | |
1282 | ||
1283 | list_of_panes (Fcdr (menu)); | |
1284 | ||
1285 | keymaps = 0; | |
1286 | } | |
1287 | ||
1288 | unbind_to (specpdl_count, Qnil); | |
1289 | ||
1290 | #ifdef HAVE_MENUS | |
dc92c039 | 1291 | #ifdef HAVE_WINDOW_SYSTEM |
ef7417fd SM |
1292 | /* Hide a previous tip, if any. */ |
1293 | Fx_hide_tip (); | |
dc92c039 | 1294 | #endif |
ef7417fd SM |
1295 | |
1296 | #ifdef HAVE_NTGUI /* FIXME: Is it really w32-specific? --Stef */ | |
1297 | /* If resources from a previous popup menu still exist, does nothing | |
1298 | until the `menu_free_timer' has freed them (see w32fns.c). This | |
1299 | can occur if you press ESC or click outside a menu without selecting | |
1300 | a menu item. | |
1301 | */ | |
1302 | if (current_popup_menu) | |
1303 | { | |
1304 | discard_menu_items (); | |
1305 | FRAME_X_DISPLAY_INFO (f)->grabbed = 0; | |
1306 | UNGCPRO; | |
1307 | return Qnil; | |
1308 | } | |
1309 | #endif | |
1310 | ||
1311 | #ifdef HAVE_NS /* FIXME: ns-specific, why? --Stef */ | |
1312 | record_unwind_protect (cleanup_popup_menu, Qnil); | |
1313 | #endif | |
1314 | ||
1315 | /* Display them in a menu. */ | |
4d7e6e51 | 1316 | block_input (); |
ef7417fd SM |
1317 | |
1318 | /* FIXME: Use a terminal hook! */ | |
1319 | #if defined HAVE_NTGUI | |
1320 | selection = w32_menu_show (f, xpos, ypos, for_click, | |
1321 | keymaps, title, &error_name); | |
1322 | #elif defined HAVE_NS | |
1323 | selection = ns_menu_show (f, xpos, ypos, for_click, | |
1324 | keymaps, title, &error_name); | |
1325 | #else /* MSDOS and X11 */ | |
a6d676d9 CY |
1326 | /* Assume last_event_timestamp is the timestamp of the button event. |
1327 | Is this assumption ever violated? We can't use the timestamp | |
1328 | stored within POSITION because there the top bits from the actual | |
1329 | timestamp may be truncated away (Bug#4930). */ | |
ef7417fd SM |
1330 | selection = xmenu_show (f, xpos, ypos, for_click, |
1331 | keymaps, title, &error_name, | |
a6d676d9 | 1332 | last_event_timestamp); |
ef7417fd SM |
1333 | #endif |
1334 | ||
4d7e6e51 | 1335 | unblock_input (); |
ef7417fd SM |
1336 | |
1337 | #ifdef HAVE_NS | |
1338 | unbind_to (specpdl_count, Qnil); | |
1339 | #else | |
1340 | discard_menu_items (); | |
1341 | #endif | |
1342 | ||
1343 | #ifdef HAVE_NTGUI /* FIXME: Is it really w32-specific? --Stef */ | |
1344 | FRAME_X_DISPLAY_INFO (f)->grabbed = 0; | |
1345 | #endif | |
1346 | ||
1347 | #endif /* HAVE_MENUS */ | |
1348 | ||
1349 | UNGCPRO; | |
1350 | ||
42eea0d0 | 1351 | if (error_name) error ("%s", error_name); |
ef7417fd SM |
1352 | return selection; |
1353 | } | |
1354 | ||
279a1d4b | 1355 | void |
971de7fb | 1356 | syms_of_menu (void) |
279a1d4b CY |
1357 | { |
1358 | staticpro (&menu_items); | |
1359 | menu_items = Qnil; | |
1360 | menu_items_inuse = Qnil; | |
ef7417fd SM |
1361 | |
1362 | defsubr (&Sx_popup_menu); | |
279a1d4b | 1363 | } |