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