(Minibuffer Completion): When ignoring case,
[emacs.git] / src / xmenu.c
blob23904576edfa4979177fc979926899c0c3361b36
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1986, 1988, 1993, 1994, 1996, 1999, 2000, 2001, 2003, 2004
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* X pop-up deck-of-cards menu facility for GNU Emacs.
24 * Written by Jon Arnold and Roman Budzianowski
25 * Mods and rewrite by Robert Krawitz
29 /* Modified by Fred Pierresteguy on December 93
30 to make the popup menus and menubar use the Xt. */
32 /* Rewritten for clarity and GC protection by rms in Feb 94. */
34 #include <config.h>
36 /* On 4.3 this loses if it comes after xterm.h. */
37 #include <signal.h>
39 #include <stdio.h>
41 #include "lisp.h"
42 #include "termhooks.h"
43 #include "keyboard.h"
44 #include "keymap.h"
45 #include "frame.h"
46 #include "window.h"
47 #include "blockinput.h"
48 #include "buffer.h"
49 #include "charset.h"
50 #include "coding.h"
51 #include "sysselect.h"
53 #ifdef MSDOS
54 #include "msdos.h"
55 #endif
57 #ifdef HAVE_X_WINDOWS
58 /* This may include sys/types.h, and that somehow loses
59 if this is not done before the other system files. */
60 #include "xterm.h"
61 #endif
63 /* Load sys/types.h if not already loaded.
64 In some systems loading it twice is suicidal. */
65 #ifndef makedev
66 #include <sys/types.h>
67 #endif
69 #include "dispextern.h"
71 #ifdef HAVE_X_WINDOWS
72 /* Defining HAVE_MULTILINGUAL_MENU would mean that the toolkit menu
73 code accepts the Emacs internal encoding. */
74 #undef HAVE_MULTILINGUAL_MENU
75 #ifdef USE_X_TOOLKIT
76 #include "widget.h"
77 #include <X11/Xlib.h>
78 #include <X11/IntrinsicP.h>
79 #include <X11/CoreP.h>
80 #include <X11/StringDefs.h>
81 #include <X11/Shell.h>
82 #ifdef USE_LUCID
83 #include <X11/Xaw/Paned.h>
84 #endif /* USE_LUCID */
85 #include "../lwlib/lwlib.h"
86 #else /* not USE_X_TOOLKIT */
87 #ifndef USE_GTK
88 #include "../oldXMenu/XMenu.h"
89 #endif
90 #endif /* not USE_X_TOOLKIT */
91 #endif /* HAVE_X_WINDOWS */
93 #ifndef TRUE
94 #define TRUE 1
95 #define FALSE 0
96 #endif /* no TRUE */
98 Lisp_Object Vmenu_updating_frame;
100 Lisp_Object Qdebug_on_next_call;
102 extern Lisp_Object Qmenu_bar;
104 extern Lisp_Object QCtoggle, QCradio;
106 extern Lisp_Object Voverriding_local_map;
107 extern Lisp_Object Voverriding_local_map_menu_flag;
109 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
111 extern Lisp_Object Qmenu_bar_update_hook;
113 #ifdef USE_X_TOOLKIT
114 extern void set_frame_menubar P_ ((FRAME_PTR, int, int));
115 extern XtAppContext Xt_app_con;
117 static Lisp_Object xdialog_show P_ ((FRAME_PTR, int, Lisp_Object, char **));
118 static void popup_get_selection P_ ((XEvent *, struct x_display_info *,
119 LWLIB_ID, int, int));
121 /* Define HAVE_BOXES if menus can handle radio and toggle buttons. */
123 #define HAVE_BOXES 1
124 #endif /* USE_X_TOOLKIT */
126 #ifdef USE_GTK
127 #include "gtkutil.h"
128 #define HAVE_BOXES 1
129 extern void set_frame_menubar P_ ((FRAME_PTR, int, int));
130 static Lisp_Object xdialog_show P_ ((FRAME_PTR, int, Lisp_Object, char **));
131 #endif
133 /* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU
134 isn't defined. The use of HAVE_MULTILINGUAL_MENU could probably be
135 confined to an extended version of this with sections of code below
136 using it unconditionally. */
137 #ifdef USE_GTK
138 /* gtk just uses utf-8. */
139 # define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
140 #else
141 /* I'm not convinced ENCODE_SYSTEM is defined correctly, or maybe
142 something else should be used here. Except under MS-Windows it
143 just converts to unibyte, but encoding with `locale-coding-system'
144 seems better -- X may actually display the result correctly, and
145 it's not necessarily equivalent to the unibyte text. -- fx */
146 # define ENCODE_MENU_STRING(str) ENCODE_SYSTEM (str)
147 #endif
149 static void push_menu_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
150 Lisp_Object, Lisp_Object, Lisp_Object,
151 Lisp_Object, Lisp_Object));
152 static int update_frame_menubar P_ ((struct frame *));
153 static Lisp_Object xmenu_show P_ ((struct frame *, int, int, int, int,
154 Lisp_Object, char **));
155 static void keymap_panes P_ ((Lisp_Object *, int, int));
156 static void single_keymap_panes P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
157 int, int));
158 static void list_of_panes P_ ((Lisp_Object));
159 static void list_of_items P_ ((Lisp_Object));
162 /* This holds a Lisp vector that holds the results of decoding
163 the keymaps or alist-of-alists that specify a menu.
165 It describes the panes and items within the panes.
167 Each pane is described by 3 elements in the vector:
168 t, the pane name, the pane's prefix key.
169 Then follow the pane's items, with 5 elements per item:
170 the item string, the enable flag, the item's value,
171 the definition, and the equivalent keyboard key's description string.
173 In some cases, multiple levels of menus may be described.
174 A single vector slot containing nil indicates the start of a submenu.
175 A single vector slot containing lambda indicates the end of a submenu.
176 The submenu follows a menu item which is the way to reach the submenu.
178 A single vector slot containing quote indicates that the
179 following items should appear on the right of a dialog box.
181 Using a Lisp vector to hold this information while we decode it
182 takes care of protecting all the data from GC. */
184 #define MENU_ITEMS_PANE_NAME 1
185 #define MENU_ITEMS_PANE_PREFIX 2
186 #define MENU_ITEMS_PANE_LENGTH 3
188 enum menu_item_idx
190 MENU_ITEMS_ITEM_NAME = 0,
191 MENU_ITEMS_ITEM_ENABLE,
192 MENU_ITEMS_ITEM_VALUE,
193 MENU_ITEMS_ITEM_EQUIV_KEY,
194 MENU_ITEMS_ITEM_DEFINITION,
195 MENU_ITEMS_ITEM_TYPE,
196 MENU_ITEMS_ITEM_SELECTED,
197 MENU_ITEMS_ITEM_HELP,
198 MENU_ITEMS_ITEM_LENGTH
201 static Lisp_Object menu_items;
203 /* If non-nil, means that the global vars defined here are already in use.
204 Used to detect cases where we try to re-enter this non-reentrant code. */
205 static Lisp_Object menu_items_inuse;
207 /* Number of slots currently allocated in menu_items. */
208 static int menu_items_allocated;
210 /* This is the index in menu_items of the first empty slot. */
211 static int menu_items_used;
213 /* The number of panes currently recorded in menu_items,
214 excluding those within submenus. */
215 static int menu_items_n_panes;
217 /* Current depth within submenus. */
218 static int menu_items_submenu_depth;
220 /* Flag which when set indicates a dialog or menu has been posted by
221 Xt on behalf of one of the widget sets. */
222 static int popup_activated_flag;
224 static int next_menubar_widget_id;
226 /* This is set nonzero after the user activates the menu bar, and set
227 to zero again after the menu bars are redisplayed by prepare_menu_bar.
228 While it is nonzero, all calls to set_frame_menubar go deep.
230 I don't understand why this is needed, but it does seem to be
231 needed on Motif, according to Marcus Daniels <marcus@sysc.pdx.edu>. */
233 int pending_menu_activation;
235 #ifdef USE_X_TOOLKIT
237 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
239 static struct frame *
240 menubar_id_to_frame (id)
241 LWLIB_ID id;
243 Lisp_Object tail, frame;
244 FRAME_PTR f;
246 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
248 frame = XCAR (tail);
249 if (!GC_FRAMEP (frame))
250 continue;
251 f = XFRAME (frame);
252 if (!FRAME_WINDOW_P (f))
253 continue;
254 if (f->output_data.x->id == id)
255 return f;
257 return 0;
260 #endif
262 /* Initialize the menu_items structure if we haven't already done so.
263 Also mark it as currently empty. */
265 static void
266 init_menu_items ()
268 if (NILP (menu_items))
270 menu_items_allocated = 60;
271 menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
274 if (!NILP (menu_items_inuse))
275 error ("Trying to use a menu from within a menu-entry");
276 menu_items_inuse = Qt;
277 menu_items_used = 0;
278 menu_items_n_panes = 0;
279 menu_items_submenu_depth = 0;
282 /* Call at the end of generating the data in menu_items. */
284 static void
285 finish_menu_items ()
289 static Lisp_Object
290 unuse_menu_items (dummy)
291 Lisp_Object dummy;
293 return menu_items_inuse = Qnil;
296 /* Call when finished using the data for the current menu
297 in menu_items. */
299 static void
300 discard_menu_items ()
302 /* Free the structure if it is especially large.
303 Otherwise, hold on to it, to save time. */
304 if (menu_items_allocated > 200)
306 menu_items = Qnil;
307 menu_items_allocated = 0;
309 xassert (NILP (menu_items_inuse));
312 /* Make the menu_items vector twice as large. */
314 static void
315 grow_menu_items ()
317 Lisp_Object old;
318 int old_size = menu_items_allocated;
319 old = menu_items;
321 menu_items_allocated *= 2;
322 menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
323 bcopy (XVECTOR (old)->contents, XVECTOR (menu_items)->contents,
324 old_size * sizeof (Lisp_Object));
327 /* Begin a submenu. */
329 static void
330 push_submenu_start ()
332 if (menu_items_used + 1 > menu_items_allocated)
333 grow_menu_items ();
335 XVECTOR (menu_items)->contents[menu_items_used++] = Qnil;
336 menu_items_submenu_depth++;
339 /* End a submenu. */
341 static void
342 push_submenu_end ()
344 if (menu_items_used + 1 > menu_items_allocated)
345 grow_menu_items ();
347 XVECTOR (menu_items)->contents[menu_items_used++] = Qlambda;
348 menu_items_submenu_depth--;
351 /* Indicate boundary between left and right. */
353 static void
354 push_left_right_boundary ()
356 if (menu_items_used + 1 > menu_items_allocated)
357 grow_menu_items ();
359 XVECTOR (menu_items)->contents[menu_items_used++] = Qquote;
362 /* Start a new menu pane in menu_items.
363 NAME is the pane name. PREFIX_VEC is a prefix key for this pane. */
365 static void
366 push_menu_pane (name, prefix_vec)
367 Lisp_Object name, prefix_vec;
369 if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
370 grow_menu_items ();
372 if (menu_items_submenu_depth == 0)
373 menu_items_n_panes++;
374 XVECTOR (menu_items)->contents[menu_items_used++] = Qt;
375 XVECTOR (menu_items)->contents[menu_items_used++] = name;
376 XVECTOR (menu_items)->contents[menu_items_used++] = prefix_vec;
379 /* Push one menu item into the current pane. NAME is the string to
380 display. ENABLE if non-nil means this item can be selected. KEY
381 is the key generated by choosing this item, or nil if this item
382 doesn't really have a definition. DEF is the definition of this
383 item. EQUIV is the textual description of the keyboard equivalent
384 for this item (or nil if none). TYPE is the type of this menu
385 item, one of nil, `toggle' or `radio'. */
387 static void
388 push_menu_item (name, enable, key, def, equiv, type, selected, help)
389 Lisp_Object name, enable, key, def, equiv, type, selected, help;
391 if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
392 grow_menu_items ();
394 XVECTOR (menu_items)->contents[menu_items_used++] = name;
395 XVECTOR (menu_items)->contents[menu_items_used++] = enable;
396 XVECTOR (menu_items)->contents[menu_items_used++] = key;
397 XVECTOR (menu_items)->contents[menu_items_used++] = equiv;
398 XVECTOR (menu_items)->contents[menu_items_used++] = def;
399 XVECTOR (menu_items)->contents[menu_items_used++] = type;
400 XVECTOR (menu_items)->contents[menu_items_used++] = selected;
401 XVECTOR (menu_items)->contents[menu_items_used++] = help;
404 /* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
405 and generate menu panes for them in menu_items.
406 If NOTREAL is nonzero,
407 don't bother really computing whether an item is enabled. */
409 static void
410 keymap_panes (keymaps, nmaps, notreal)
411 Lisp_Object *keymaps;
412 int nmaps;
413 int notreal;
415 int mapno;
417 init_menu_items ();
419 /* Loop over the given keymaps, making a pane for each map.
420 But don't make a pane that is empty--ignore that map instead.
421 P is the number of panes we have made so far. */
422 for (mapno = 0; mapno < nmaps; mapno++)
423 single_keymap_panes (keymaps[mapno],
424 Fkeymap_prompt (keymaps[mapno]), Qnil, notreal, 10);
426 finish_menu_items ();
429 /* Args passed between single_keymap_panes and single_menu_item. */
430 struct skp
432 Lisp_Object pending_maps;
433 int maxdepth, notreal;
434 int notbuttons;
437 static void single_menu_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
438 void *));
440 /* This is a recursive subroutine of keymap_panes.
441 It handles one keymap, KEYMAP.
442 The other arguments are passed along
443 or point to local variables of the previous function.
444 If NOTREAL is nonzero, only check for equivalent key bindings, don't
445 evaluate expressions in menu items and don't make any menu.
447 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
449 static void
450 single_keymap_panes (keymap, pane_name, prefix, notreal, maxdepth)
451 Lisp_Object keymap;
452 Lisp_Object pane_name;
453 Lisp_Object prefix;
454 int notreal;
455 int maxdepth;
457 struct skp skp;
458 struct gcpro gcpro1;
460 skp.pending_maps = Qnil;
461 skp.maxdepth = maxdepth;
462 skp.notreal = notreal;
463 skp.notbuttons = 0;
465 if (maxdepth <= 0)
466 return;
468 push_menu_pane (pane_name, prefix);
470 #ifndef HAVE_BOXES
471 /* Remember index for first item in this pane so we can go back and
472 add a prefix when (if) we see the first button. After that, notbuttons
473 is set to 0, to mark that we have seen a button and all non button
474 items need a prefix. */
475 skp.notbuttons = menu_items_used;
476 #endif
478 GCPRO1 (skp.pending_maps);
479 map_keymap (keymap, single_menu_item, Qnil, &skp, 1);
480 UNGCPRO;
482 /* Process now any submenus which want to be panes at this level. */
483 while (CONSP (skp.pending_maps))
485 Lisp_Object elt, eltcdr, string;
486 elt = XCAR (skp.pending_maps);
487 eltcdr = XCDR (elt);
488 string = XCAR (eltcdr);
489 /* We no longer discard the @ from the beginning of the string here.
490 Instead, we do this in xmenu_show. */
491 single_keymap_panes (Fcar (elt), string,
492 XCDR (eltcdr), notreal, maxdepth - 1);
493 skp.pending_maps = XCDR (skp.pending_maps);
497 /* This is a subroutine of single_keymap_panes that handles one
498 keymap entry.
499 KEY is a key in a keymap and ITEM is its binding.
500 SKP->PENDING_MAPS_PTR is a list of keymaps waiting to be made into
501 separate panes.
502 If SKP->NOTREAL is nonzero, only check for equivalent key bindings, don't
503 evaluate expressions in menu items and don't make any menu.
504 If we encounter submenus deeper than SKP->MAXDEPTH levels, ignore them.
505 SKP->NOTBUTTONS is only used when simulating toggle boxes and radio
506 buttons. It keeps track of if we have seen a button in this menu or
507 not. */
509 static void
510 single_menu_item (key, item, dummy, skp_v)
511 Lisp_Object key, item, dummy;
512 void *skp_v;
514 Lisp_Object map, item_string, enabled;
515 struct gcpro gcpro1, gcpro2;
516 int res;
517 struct skp *skp = skp_v;
519 /* Parse the menu item and leave the result in item_properties. */
520 GCPRO2 (key, item);
521 res = parse_menu_item (item, skp->notreal, 0);
522 UNGCPRO;
523 if (!res)
524 return; /* Not a menu item. */
526 map = XVECTOR (item_properties)->contents[ITEM_PROPERTY_MAP];
528 if (skp->notreal)
530 /* We don't want to make a menu, just traverse the keymaps to
531 precompute equivalent key bindings. */
532 if (!NILP (map))
533 single_keymap_panes (map, Qnil, key, 1, skp->maxdepth - 1);
534 return;
537 enabled = XVECTOR (item_properties)->contents[ITEM_PROPERTY_ENABLE];
538 item_string = XVECTOR (item_properties)->contents[ITEM_PROPERTY_NAME];
540 if (!NILP (map) && SREF (item_string, 0) == '@')
542 if (!NILP (enabled))
543 /* An enabled separate pane. Remember this to handle it later. */
544 skp->pending_maps = Fcons (Fcons (map, Fcons (item_string, key)),
545 skp->pending_maps);
546 return;
549 #ifndef HAVE_BOXES
550 /* Simulate radio buttons and toggle boxes by putting a prefix in
551 front of them. */
553 Lisp_Object prefix = Qnil;
554 Lisp_Object type = XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE];
555 if (!NILP (type))
557 Lisp_Object selected
558 = XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED];
560 if (skp->notbuttons)
561 /* The first button. Line up previous items in this menu. */
563 int index = skp->notbuttons; /* Index for first item this menu. */
564 int submenu = 0;
565 Lisp_Object tem;
566 while (index < menu_items_used)
569 = XVECTOR (menu_items)->contents[index + MENU_ITEMS_ITEM_NAME];
570 if (NILP (tem))
572 index++;
573 submenu++; /* Skip sub menu. */
575 else if (EQ (tem, Qlambda))
577 index++;
578 submenu--; /* End sub menu. */
580 else if (EQ (tem, Qt))
581 index += 3; /* Skip new pane marker. */
582 else if (EQ (tem, Qquote))
583 index++; /* Skip a left, right divider. */
584 else
586 if (!submenu && SREF (tem, 0) != '\0'
587 && SREF (tem, 0) != '-')
588 XVECTOR (menu_items)->contents[index + MENU_ITEMS_ITEM_NAME]
589 = concat2 (build_string (" "), tem);
590 index += MENU_ITEMS_ITEM_LENGTH;
593 skp->notbuttons = 0;
596 /* Calculate prefix, if any, for this item. */
597 if (EQ (type, QCtoggle))
598 prefix = build_string (NILP (selected) ? "[ ] " : "[X] ");
599 else if (EQ (type, QCradio))
600 prefix = build_string (NILP (selected) ? "( ) " : "(*) ");
602 /* Not a button. If we have earlier buttons, then we need a prefix. */
603 else if (!skp->notbuttons && SREF (item_string, 0) != '\0'
604 && SREF (item_string, 0) != '-')
605 prefix = build_string (" ");
607 if (!NILP (prefix))
608 item_string = concat2 (prefix, item_string);
610 #endif /* not HAVE_BOXES */
612 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
613 if (!NILP (map))
614 /* Indicate visually that this is a submenu. */
615 item_string = concat2 (item_string, build_string (" >"));
616 #endif
618 push_menu_item (item_string, enabled, key,
619 XVECTOR (item_properties)->contents[ITEM_PROPERTY_DEF],
620 XVECTOR (item_properties)->contents[ITEM_PROPERTY_KEYEQ],
621 XVECTOR (item_properties)->contents[ITEM_PROPERTY_TYPE],
622 XVECTOR (item_properties)->contents[ITEM_PROPERTY_SELECTED],
623 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP]);
625 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
626 /* Display a submenu using the toolkit. */
627 if (! (NILP (map) || NILP (enabled)))
629 push_submenu_start ();
630 single_keymap_panes (map, Qnil, key, 0, skp->maxdepth - 1);
631 push_submenu_end ();
633 #endif
636 /* Push all the panes and items of a menu described by the
637 alist-of-alists MENU.
638 This handles old-fashioned calls to x-popup-menu. */
640 static void
641 list_of_panes (menu)
642 Lisp_Object menu;
644 Lisp_Object tail;
646 init_menu_items ();
648 for (tail = menu; !NILP (tail); tail = Fcdr (tail))
650 Lisp_Object elt, pane_name, pane_data;
651 elt = Fcar (tail);
652 pane_name = Fcar (elt);
653 CHECK_STRING (pane_name);
654 push_menu_pane (ENCODE_MENU_STRING (pane_name), Qnil);
655 pane_data = Fcdr (elt);
656 CHECK_CONS (pane_data);
657 list_of_items (pane_data);
660 finish_menu_items ();
663 /* Push the items in a single pane defined by the alist PANE. */
665 static void
666 list_of_items (pane)
667 Lisp_Object pane;
669 Lisp_Object tail, item, item1;
671 for (tail = pane; !NILP (tail); tail = Fcdr (tail))
673 item = Fcar (tail);
674 if (STRINGP (item))
675 push_menu_item (ENCODE_MENU_STRING (item), Qnil, Qnil, Qt,
676 Qnil, Qnil, Qnil, Qnil);
677 else if (NILP (item))
678 push_left_right_boundary ();
679 else
681 CHECK_CONS (item);
682 item1 = Fcar (item);
683 CHECK_STRING (item1);
684 push_menu_item (ENCODE_MENU_STRING (item1), Qt, Fcdr (item),
685 Qt, Qnil, Qnil, Qnil, Qnil);
690 #ifdef HAVE_X_WINDOWS
691 /* Return the mouse position in *X and *Y. The coordinates are window
692 relative for the edit window in frame F.
693 This is for Fx_popup_menu. The mouse_position_hook can not
694 be used for X, as it returns window relative coordinates
695 for the window where the mouse is in. This could be the menu bar,
696 the scroll bar or the edit window. Fx_popup_menu needs to be
697 sure it is the edit window. */
698 static void
699 mouse_position_for_popup (f, x, y)
700 FRAME_PTR f;
701 int *x;
702 int *y;
704 Window root, dummy_window;
705 int dummy;
707 BLOCK_INPUT;
709 XQueryPointer (FRAME_X_DISPLAY (f),
710 DefaultRootWindow (FRAME_X_DISPLAY (f)),
712 /* The root window which contains the pointer. */
713 &root,
715 /* Window pointer is on, not used */
716 &dummy_window,
718 /* The position on that root window. */
719 x, y,
721 /* x/y in dummy_window coordinates, not used. */
722 &dummy, &dummy,
724 /* Modifier keys and pointer buttons, about which
725 we don't care. */
726 (unsigned int *) &dummy);
728 UNBLOCK_INPUT;
730 /* xmenu_show expects window coordinates, not root window
731 coordinates. Translate. */
732 *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
733 *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
736 #endif /* HAVE_X_WINDOWS */
738 DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
739 doc: /* Pop up a deck-of-cards menu and return user's selection.
740 POSITION is a position specification. This is either a mouse button event
741 or a list ((XOFFSET YOFFSET) WINDOW)
742 where XOFFSET and YOFFSET are positions in pixels from the top left
743 corner of WINDOW's frame. (WINDOW may be a frame object instead of a window.)
744 This controls the position of the center of the first line
745 in the first pane of the menu, not the top left of the menu as a whole.
746 If POSITION is t, it means to use the current mouse position.
748 MENU is a specifier for a menu. For the simplest case, MENU is a keymap.
749 The menu items come from key bindings that have a menu string as well as
750 a definition; actually, the "definition" in such a key binding looks like
751 \(STRING . REAL-DEFINITION). To give the menu a title, put a string into
752 the keymap as a top-level element.
754 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
755 Otherwise, REAL-DEFINITION should be a valid key binding definition.
757 You can also use a list of keymaps as MENU.
758 Then each keymap makes a separate pane.
759 When MENU is a keymap or a list of keymaps, the return value
760 is a list of events.
762 Alternatively, you can specify a menu of multiple panes
763 with a list of the form (TITLE PANE1 PANE2...),
764 where each pane is a list of form (TITLE ITEM1 ITEM2...).
765 Each ITEM is normally a cons cell (STRING . VALUE);
766 but a string can appear as an item--that makes a nonselectable line
767 in the menu.
768 With this form of menu, the return value is VALUE from the chosen item.
770 If POSITION is nil, don't display the menu at all, just precalculate the
771 cached information about equivalent key sequences. */)
772 (position, menu)
773 Lisp_Object position, menu;
775 Lisp_Object keymap, tem;
776 int xpos = 0, ypos = 0;
777 Lisp_Object title;
778 char *error_name;
779 Lisp_Object selection;
780 FRAME_PTR f = NULL;
781 Lisp_Object x, y, window;
782 int keymaps = 0;
783 int for_click = 0;
784 int specpdl_count = SPECPDL_INDEX ();
785 struct gcpro gcpro1;
787 #ifdef HAVE_MENUS
788 if (! NILP (position))
790 int get_current_pos_p = 0;
791 check_x ();
793 /* Decode the first argument: find the window and the coordinates. */
794 if (EQ (position, Qt)
795 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
796 || EQ (XCAR (position), Qtool_bar))))
798 get_current_pos_p = 1;
800 else
802 tem = Fcar (position);
803 if (CONSP (tem))
805 window = Fcar (Fcdr (position));
806 x = Fcar (tem);
807 y = Fcar (Fcdr (tem));
809 else
811 for_click = 1;
812 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
813 window = Fcar (tem); /* POSN_WINDOW (tem) */
814 tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */
815 x = Fcar (tem);
816 y = Fcdr (tem);
819 /* If a click happens in an external tool bar or a detached
820 tool bar, x and y is NIL. In that case, use the current
821 mouse position. This happens for the help button in the
822 tool bar. Ideally popup-menu should pass NIL to
823 this function, but it doesn't. */
824 if (NILP (x) && NILP (y))
825 get_current_pos_p = 1;
828 if (get_current_pos_p)
830 /* Use the mouse's current position. */
831 FRAME_PTR new_f = SELECTED_FRAME ();
832 #ifdef HAVE_X_WINDOWS
833 /* Can't use mouse_position_hook for X since it returns
834 coordinates relative to the window the mouse is in,
835 we need coordinates relative to the edit widget always. */
836 if (new_f != 0)
838 int cur_x, cur_y;
840 mouse_position_for_popup (new_f, &cur_x, &cur_y);
841 /* cur_x/y may be negative, so use make_number. */
842 x = make_number (cur_x);
843 y = make_number (cur_y);
846 #else /* not HAVE_X_WINDOWS */
847 Lisp_Object bar_window;
848 enum scroll_bar_part part;
849 unsigned long time;
851 if (mouse_position_hook)
852 (*mouse_position_hook) (&new_f, 1, &bar_window,
853 &part, &x, &y, &time);
854 #endif /* not HAVE_X_WINDOWS */
856 if (new_f != 0)
857 XSETFRAME (window, new_f);
858 else
860 window = selected_window;
861 XSETFASTINT (x, 0);
862 XSETFASTINT (y, 0);
866 CHECK_NUMBER (x);
867 CHECK_NUMBER (y);
869 /* Decode where to put the menu. */
871 if (FRAMEP (window))
873 f = XFRAME (window);
874 xpos = 0;
875 ypos = 0;
877 else if (WINDOWP (window))
879 CHECK_LIVE_WINDOW (window);
880 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
882 xpos = WINDOW_LEFT_EDGE_X (XWINDOW (window));
883 ypos = WINDOW_TOP_EDGE_Y (XWINDOW (window));
885 else
886 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
887 but I don't want to make one now. */
888 CHECK_WINDOW (window);
890 xpos += XINT (x);
891 ypos += XINT (y);
893 Vmenu_updating_frame = Qnil;
894 #endif /* HAVE_MENUS */
896 record_unwind_protect (unuse_menu_items, Qnil);
897 title = Qnil;
898 GCPRO1 (title);
900 /* Decode the menu items from what was specified. */
902 keymap = get_keymap (menu, 0, 0);
903 if (CONSP (keymap))
905 /* We were given a keymap. Extract menu info from the keymap. */
906 Lisp_Object prompt;
908 /* Extract the detailed info to make one pane. */
909 keymap_panes (&menu, 1, NILP (position));
911 /* Search for a string appearing directly as an element of the keymap.
912 That string is the title of the menu. */
913 prompt = Fkeymap_prompt (keymap);
914 if (NILP (title) && !NILP (prompt))
915 title = prompt;
917 /* Make that be the pane title of the first pane. */
918 if (!NILP (prompt) && menu_items_n_panes >= 0)
919 XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME] = prompt;
921 keymaps = 1;
923 else if (CONSP (menu) && KEYMAPP (XCAR (menu)))
925 /* We were given a list of keymaps. */
926 int nmaps = XFASTINT (Flength (menu));
927 Lisp_Object *maps
928 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
929 int i;
931 title = Qnil;
933 /* The first keymap that has a prompt string
934 supplies the menu title. */
935 for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
937 Lisp_Object prompt;
939 maps[i++] = keymap = get_keymap (Fcar (tem), 1, 0);
941 prompt = Fkeymap_prompt (keymap);
942 if (NILP (title) && !NILP (prompt))
943 title = prompt;
946 /* Extract the detailed info to make one pane. */
947 keymap_panes (maps, nmaps, NILP (position));
949 /* Make the title be the pane title of the first pane. */
950 if (!NILP (title) && menu_items_n_panes >= 0)
951 XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME] = title;
953 keymaps = 1;
955 else
957 /* We were given an old-fashioned menu. */
958 title = Fcar (menu);
959 CHECK_STRING (title);
961 list_of_panes (Fcdr (menu));
963 keymaps = 0;
966 unbind_to (specpdl_count, Qnil);
968 if (NILP (position))
970 discard_menu_items ();
971 UNGCPRO;
972 return Qnil;
975 #ifdef HAVE_MENUS
976 /* Display them in a menu. */
977 BLOCK_INPUT;
979 selection = xmenu_show (f, xpos, ypos, for_click,
980 keymaps, title, &error_name);
981 UNBLOCK_INPUT;
983 discard_menu_items ();
985 UNGCPRO;
986 #endif /* HAVE_MENUS */
988 if (error_name) error (error_name);
989 return selection;
992 #ifdef HAVE_MENUS
994 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
995 doc: /* Pop up a dialog box and return user's selection.
996 POSITION specifies which frame to use.
997 This is normally a mouse button event or a window or frame.
998 If POSITION is t, it means to use the frame the mouse is on.
999 The dialog box appears in the middle of the specified frame.
1001 CONTENTS specifies the alternatives to display in the dialog box.
1002 It is a list of the form (TITLE ITEM1 ITEM2...).
1003 Each ITEM is a cons cell (STRING . VALUE).
1004 The return value is VALUE from the chosen item.
1006 An ITEM may also be just a string--that makes a nonselectable item.
1007 An ITEM may also be nil--that means to put all preceding items
1008 on the left of the dialog box and all following items on the right.
1009 \(By default, approximately half appear on each side.) */)
1010 (position, contents)
1011 Lisp_Object position, contents;
1013 FRAME_PTR f = NULL;
1014 Lisp_Object window;
1016 check_x ();
1018 /* Decode the first argument: find the window or frame to use. */
1019 if (EQ (position, Qt)
1020 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
1021 || EQ (XCAR (position), Qtool_bar))))
1023 #if 0 /* Using the frame the mouse is on may not be right. */
1024 /* Use the mouse's current position. */
1025 FRAME_PTR new_f = SELECTED_FRAME ();
1026 Lisp_Object bar_window;
1027 enum scroll_bar_part part;
1028 unsigned long time;
1029 Lisp_Object x, y;
1031 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
1033 if (new_f != 0)
1034 XSETFRAME (window, new_f);
1035 else
1036 window = selected_window;
1037 #endif
1038 window = selected_window;
1040 else if (CONSP (position))
1042 Lisp_Object tem;
1043 tem = Fcar (position);
1044 if (CONSP (tem))
1045 window = Fcar (Fcdr (position));
1046 else
1048 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
1049 window = Fcar (tem); /* POSN_WINDOW (tem) */
1052 else if (WINDOWP (position) || FRAMEP (position))
1053 window = position;
1054 else
1055 window = Qnil;
1057 /* Decode where to put the menu. */
1059 if (FRAMEP (window))
1060 f = XFRAME (window);
1061 else if (WINDOWP (window))
1063 CHECK_LIVE_WINDOW (window);
1064 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1066 else
1067 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
1068 but I don't want to make one now. */
1069 CHECK_WINDOW (window);
1071 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1072 /* Display a menu with these alternatives
1073 in the middle of frame F. */
1075 Lisp_Object x, y, frame, newpos;
1076 XSETFRAME (frame, f);
1077 XSETINT (x, x_pixel_width (f) / 2);
1078 XSETINT (y, x_pixel_height (f) / 2);
1079 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
1081 return Fx_popup_menu (newpos,
1082 Fcons (Fcar (contents), Fcons (contents, Qnil)));
1084 #else
1086 Lisp_Object title;
1087 char *error_name;
1088 Lisp_Object selection;
1089 int specpdl_count = SPECPDL_INDEX ();
1091 /* Decode the dialog items from what was specified. */
1092 title = Fcar (contents);
1093 CHECK_STRING (title);
1094 record_unwind_protect (unuse_menu_items, Qnil);
1096 if (NILP (Fcar (Fcdr (contents))))
1097 /* No buttons specified, add an "Ok" button so users can pop down
1098 the dialog. Also, the lesstif/motif version crashes if there are
1099 no buttons. */
1100 contents = Fcons (title, Fcons (Fcons (build_string ("Ok"), Qt), Qnil));
1102 list_of_panes (Fcons (contents, Qnil));
1104 /* Display them in a dialog box. */
1105 BLOCK_INPUT;
1106 selection = xdialog_show (f, 0, title, &error_name);
1107 UNBLOCK_INPUT;
1109 unbind_to (specpdl_count, Qnil);
1110 discard_menu_items ();
1112 if (error_name) error (error_name);
1113 return selection;
1115 #endif
1119 #ifndef MSDOS
1121 /* Return non-zero if a dialog or popup menu is already popped up. */
1124 x_menu_in_use ()
1126 return ! NILP (menu_items_inuse);
1129 /* Set menu_items_inuse so no other popup menu or dialog is created. */
1131 void
1132 x_menu_set_in_use (in_use)
1133 int in_use;
1135 menu_items_inuse = in_use ? Qt : Qnil;
1138 /* Wait for an X event to arrive or for a timer to expire. */
1140 void
1141 x_menu_wait_for_event (void *data)
1143 extern EMACS_TIME timer_check P_ ((int));
1145 /* Another way to do this is to register a timer callback, that can be
1146 done in GTK and Xt. But we have to do it like this when using only X
1147 anyway, and with callbacks we would have three variants for timer handling
1148 instead of the small ifdefs below. */
1150 while (
1151 #ifdef USE_X_TOOLKIT
1152 ! XtAppPending (Xt_app_con)
1153 #elif defined USE_GTK
1154 ! gtk_events_pending ()
1155 #else
1156 ! XPending ((Display*) data)
1157 #endif
1160 EMACS_TIME next_time = timer_check (1);
1161 long secs = EMACS_SECS (next_time);
1162 long usecs = EMACS_USECS (next_time);
1163 SELECT_TYPE read_fds;
1164 struct x_display_info *dpyinfo;
1165 int n = 0;
1167 FD_ZERO (&read_fds);
1168 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
1170 int fd = ConnectionNumber (dpyinfo->display);
1171 FD_SET (fd, &read_fds);
1172 if (fd > n) n = fd;
1175 if (secs < 0 || (secs == 0 && usecs == 0))
1177 /* Sometimes timer_check returns -1 (no timers) even if there are
1178 timers. So do a timeout anyway. */
1179 EMACS_SET_SECS (next_time, 1);
1180 EMACS_SET_USECS (next_time, 0);
1183 select (n + 1, &read_fds, (SELECT_TYPE *)0, (SELECT_TYPE *)0, &next_time);
1186 #endif /* ! MSDOS */
1189 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1191 #ifdef USE_X_TOOLKIT
1193 /* Loop in Xt until the menu pulldown or dialog popup has been
1194 popped down (deactivated). This is used for x-popup-menu
1195 and x-popup-dialog; it is not used for the menu bar.
1197 If DOWN_ON_KEYPRESS is nonzero, pop down if a key is pressed.
1199 NOTE: All calls to popup_get_selection should be protected
1200 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
1202 static void
1203 popup_get_selection (initial_event, dpyinfo, id, do_timers, down_on_keypress)
1204 XEvent *initial_event;
1205 struct x_display_info *dpyinfo;
1206 LWLIB_ID id;
1207 int do_timers;
1208 int down_on_keypress;
1210 XEvent event;
1212 while (popup_activated_flag)
1214 if (initial_event)
1216 event = *initial_event;
1217 initial_event = 0;
1219 else
1221 if (do_timers) x_menu_wait_for_event (0);
1222 XtAppNextEvent (Xt_app_con, &event);
1225 /* Make sure we don't consider buttons grabbed after menu goes.
1226 And make sure to deactivate for any ButtonRelease,
1227 even if XtDispatchEvent doesn't do that. */
1228 if (event.type == ButtonRelease
1229 && dpyinfo->display == event.xbutton.display)
1231 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
1232 #ifdef USE_MOTIF /* Pretending that the event came from a
1233 Btn1Down seems the only way to convince Motif to
1234 activate its callbacks; setting the XmNmenuPost
1235 isn't working. --marcus@sysc.pdx.edu. */
1236 event.xbutton.button = 1;
1237 /* Motif only pops down menus when no Ctrl, Alt or Mod
1238 key is pressed and the button is released. So reset key state
1239 so Motif thinks this is the case. */
1240 event.xbutton.state = 0;
1241 #endif
1243 /* If the user presses a key that doesn't go to the menu,
1244 deactivate the menu.
1245 The user is likely to do that if we get wedged.
1246 All toolkits now pop down menus on ESC.
1247 For dialogs however, the focus may not be on the dialog, so
1248 in that case, we pop down. */
1249 else if (event.type == KeyPress
1250 && down_on_keypress
1251 && dpyinfo->display == event.xbutton.display)
1253 KeySym keysym = XLookupKeysym (&event.xkey, 0);
1254 if (!IsModifierKey (keysym)
1255 && x_any_window_to_frame (dpyinfo, event.xany.window) != NULL)
1256 popup_activated_flag = 0;
1259 x_dispatch_event (&event, event.xany.display);
1263 #endif /* USE_X_TOOLKIT */
1265 #ifdef USE_GTK
1266 /* Loop util popup_activated_flag is set to zero in a callback.
1267 Used for popup menus and dialogs. */
1269 static void
1270 popup_widget_loop (do_timers, widget)
1271 int do_timers;
1272 GtkWidget *widget;
1274 ++popup_activated_flag;
1276 /* Process events in the Gtk event loop until done. */
1277 while (popup_activated_flag)
1279 if (do_timers) x_menu_wait_for_event (0);
1280 gtk_main_iteration ();
1283 #endif
1285 /* Activate the menu bar of frame F.
1286 This is called from keyboard.c when it gets the
1287 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
1289 To activate the menu bar, we use the X button-press event
1290 that was saved in saved_menu_event.
1291 That makes the toolkit do its thing.
1293 But first we recompute the menu bar contents (the whole tree).
1295 The reason for saving the button event until here, instead of
1296 passing it to the toolkit right away, is that we can safely
1297 execute Lisp code. */
1299 void
1300 x_activate_menubar (f)
1301 FRAME_PTR f;
1303 if (!f->output_data.x->saved_menu_event->type)
1304 return;
1306 #ifdef USE_GTK
1307 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
1308 f->output_data.x->saved_menu_event->xany.window))
1309 return;
1310 #endif
1312 set_frame_menubar (f, 0, 1);
1313 BLOCK_INPUT;
1314 #ifdef USE_GTK
1315 XPutBackEvent (f->output_data.x->display_info->display,
1316 f->output_data.x->saved_menu_event);
1317 popup_activated_flag = 1;
1318 #else
1319 XtDispatchEvent (f->output_data.x->saved_menu_event);
1320 #endif
1321 UNBLOCK_INPUT;
1322 #ifdef USE_MOTIF
1323 if (f->output_data.x->saved_menu_event->type == ButtonRelease)
1324 pending_menu_activation = 1;
1325 #endif
1327 /* Ignore this if we get it a second time. */
1328 f->output_data.x->saved_menu_event->type = 0;
1331 /* Detect if a dialog or menu has been posted. */
1334 popup_activated ()
1336 return popup_activated_flag;
1339 /* This callback is invoked when the user selects a menubar cascade
1340 pushbutton, but before the pulldown menu is posted. */
1342 #ifndef USE_GTK
1343 static void
1344 popup_activate_callback (widget, id, client_data)
1345 Widget widget;
1346 LWLIB_ID id;
1347 XtPointer client_data;
1349 popup_activated_flag = 1;
1351 #endif
1353 /* This callback is invoked when a dialog or menu is finished being
1354 used and has been unposted. */
1356 #ifdef USE_GTK
1357 static void
1358 popup_deactivate_callback (widget, client_data)
1359 GtkWidget *widget;
1360 gpointer client_data;
1362 popup_activated_flag = 0;
1364 #else
1365 static void
1366 popup_deactivate_callback (widget, id, client_data)
1367 Widget widget;
1368 LWLIB_ID id;
1369 XtPointer client_data;
1371 popup_activated_flag = 0;
1373 #endif
1376 /* Function that finds the frame for WIDGET and shows the HELP text
1377 for that widget.
1378 F is the frame if known, or NULL if not known. */
1379 static void
1380 show_help_event (f, widget, help)
1381 FRAME_PTR f;
1382 xt_or_gtk_widget widget;
1383 Lisp_Object help;
1385 Lisp_Object frame;
1387 if (f)
1389 XSETFRAME (frame, f);
1390 kbd_buffer_store_help_event (frame, help);
1392 else
1394 #if 0 /* This code doesn't do anything useful. ++kfs */
1395 /* WIDGET is the popup menu. It's parent is the frame's
1396 widget. See which frame that is. */
1397 xt_or_gtk_widget frame_widget = XtParent (widget);
1398 Lisp_Object tail;
1400 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
1402 frame = XCAR (tail);
1403 if (GC_FRAMEP (frame)
1404 && (f = XFRAME (frame),
1405 FRAME_X_P (f) && f->output_data.x->widget == frame_widget))
1406 break;
1408 #endif
1409 show_help_echo (help, Qnil, Qnil, Qnil, 1);
1413 /* Callback called when menu items are highlighted/unhighlighted
1414 while moving the mouse over them. WIDGET is the menu bar or menu
1415 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
1416 the data structure for the menu item, or null in case of
1417 unhighlighting. */
1419 #ifdef USE_GTK
1420 void
1421 menu_highlight_callback (widget, call_data)
1422 GtkWidget *widget;
1423 gpointer call_data;
1425 xg_menu_item_cb_data *cb_data;
1426 Lisp_Object help;
1428 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (widget),
1429 XG_ITEM_DATA);
1430 if (! cb_data) return;
1432 help = call_data ? cb_data->help : Qnil;
1434 /* If popup_activated_flag is greater than 1 we are in a popup menu.
1435 Don't show help for them, they won't appear before the
1436 popup is popped down. */
1437 if (popup_activated_flag <= 1)
1438 show_help_event (cb_data->cl_data->f, widget, help);
1440 #else
1441 void
1442 menu_highlight_callback (widget, id, call_data)
1443 Widget widget;
1444 LWLIB_ID id;
1445 void *call_data;
1447 struct frame *f;
1448 Lisp_Object help;
1450 widget_value *wv = (widget_value *) call_data;
1452 help = wv ? wv->help : Qnil;
1454 /* Determine the frame for the help event. */
1455 f = menubar_id_to_frame (id);
1457 show_help_event (f, widget, help);
1459 #endif
1461 /* Find the menu selection and store it in the keyboard buffer.
1462 F is the frame the menu is on.
1463 MENU_BAR_ITEMS_USED is the length of VECTOR.
1464 VECTOR is an array of menu events for the whole menu.
1466 void
1467 find_and_call_menu_selection (f, menu_bar_items_used, vector, client_data)
1468 FRAME_PTR f;
1469 int menu_bar_items_used;
1470 Lisp_Object vector;
1471 void *client_data;
1473 Lisp_Object prefix, entry;
1474 Lisp_Object *subprefix_stack;
1475 int submenu_depth = 0;
1476 int i;
1478 entry = Qnil;
1479 subprefix_stack = (Lisp_Object *) alloca (menu_bar_items_used * sizeof (Lisp_Object));
1480 prefix = Qnil;
1481 i = 0;
1483 while (i < menu_bar_items_used)
1485 if (EQ (XVECTOR (vector)->contents[i], Qnil))
1487 subprefix_stack[submenu_depth++] = prefix;
1488 prefix = entry;
1489 i++;
1491 else if (EQ (XVECTOR (vector)->contents[i], Qlambda))
1493 prefix = subprefix_stack[--submenu_depth];
1494 i++;
1496 else if (EQ (XVECTOR (vector)->contents[i], Qt))
1498 prefix = XVECTOR (vector)->contents[i + MENU_ITEMS_PANE_PREFIX];
1499 i += MENU_ITEMS_PANE_LENGTH;
1501 else
1503 entry = XVECTOR (vector)->contents[i + MENU_ITEMS_ITEM_VALUE];
1504 /* The EMACS_INT cast avoids a warning. There's no problem
1505 as long as pointers have enough bits to hold small integers. */
1506 if ((int) (EMACS_INT) client_data == i)
1508 int j;
1509 struct input_event buf;
1510 Lisp_Object frame;
1511 EVENT_INIT (buf);
1513 XSETFRAME (frame, f);
1514 buf.kind = MENU_BAR_EVENT;
1515 buf.frame_or_window = frame;
1516 buf.arg = frame;
1517 kbd_buffer_store_event (&buf);
1519 for (j = 0; j < submenu_depth; j++)
1520 if (!NILP (subprefix_stack[j]))
1522 buf.kind = MENU_BAR_EVENT;
1523 buf.frame_or_window = frame;
1524 buf.arg = subprefix_stack[j];
1525 kbd_buffer_store_event (&buf);
1528 if (!NILP (prefix))
1530 buf.kind = MENU_BAR_EVENT;
1531 buf.frame_or_window = frame;
1532 buf.arg = prefix;
1533 kbd_buffer_store_event (&buf);
1536 buf.kind = MENU_BAR_EVENT;
1537 buf.frame_or_window = frame;
1538 buf.arg = entry;
1539 kbd_buffer_store_event (&buf);
1541 return;
1543 i += MENU_ITEMS_ITEM_LENGTH;
1549 #ifdef USE_GTK
1550 /* Gtk calls callbacks just because we tell it what item should be
1551 selected in a radio group. If this variable is set to a non-zero
1552 value, we are creating menus and don't want callbacks right now.
1554 static int xg_crazy_callback_abort;
1556 /* This callback is called from the menu bar pulldown menu
1557 when the user makes a selection.
1558 Figure out what the user chose
1559 and put the appropriate events into the keyboard buffer. */
1560 static void
1561 menubar_selection_callback (widget, client_data)
1562 GtkWidget *widget;
1563 gpointer client_data;
1565 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
1567 if (xg_crazy_callback_abort)
1568 return;
1570 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
1571 return;
1573 find_and_call_menu_selection (cb_data->cl_data->f,
1574 cb_data->cl_data->menu_bar_items_used,
1575 cb_data->cl_data->menu_bar_vector,
1576 cb_data->call_data);
1579 #else /* not USE_GTK */
1581 /* This callback is called from the menu bar pulldown menu
1582 when the user makes a selection.
1583 Figure out what the user chose
1584 and put the appropriate events into the keyboard buffer. */
1585 static void
1586 menubar_selection_callback (widget, id, client_data)
1587 Widget widget;
1588 LWLIB_ID id;
1589 XtPointer client_data;
1591 FRAME_PTR f;
1593 f = menubar_id_to_frame (id);
1594 if (!f)
1595 return;
1596 find_and_call_menu_selection (f, f->menu_bar_items_used,
1597 f->menu_bar_vector, client_data);
1599 #endif /* not USE_GTK */
1601 /* Allocate a widget_value, blocking input. */
1603 widget_value *
1604 xmalloc_widget_value ()
1606 widget_value *value;
1608 BLOCK_INPUT;
1609 value = malloc_widget_value ();
1610 UNBLOCK_INPUT;
1612 return value;
1615 /* This recursively calls free_widget_value on the tree of widgets.
1616 It must free all data that was malloc'ed for these widget_values.
1617 In Emacs, many slots are pointers into the data of Lisp_Strings, and
1618 must be left alone. */
1620 void
1621 free_menubar_widget_value_tree (wv)
1622 widget_value *wv;
1624 if (! wv) return;
1626 wv->name = wv->value = wv->key = (char *) 0xDEADBEEF;
1628 if (wv->contents && (wv->contents != (widget_value*)1))
1630 free_menubar_widget_value_tree (wv->contents);
1631 wv->contents = (widget_value *) 0xDEADBEEF;
1633 if (wv->next)
1635 free_menubar_widget_value_tree (wv->next);
1636 wv->next = (widget_value *) 0xDEADBEEF;
1638 BLOCK_INPUT;
1639 free_widget_value (wv);
1640 UNBLOCK_INPUT;
1643 /* Set up data in menu_items for a menu bar item
1644 whose event type is ITEM_KEY (with string ITEM_NAME)
1645 and whose contents come from the list of keymaps MAPS. */
1647 static int
1648 parse_single_submenu (item_key, item_name, maps)
1649 Lisp_Object item_key, item_name, maps;
1651 Lisp_Object length;
1652 int len;
1653 Lisp_Object *mapvec;
1654 int i;
1655 int top_level_items = 0;
1657 length = Flength (maps);
1658 len = XINT (length);
1660 /* Convert the list MAPS into a vector MAPVEC. */
1661 mapvec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));
1662 for (i = 0; i < len; i++)
1664 mapvec[i] = Fcar (maps);
1665 maps = Fcdr (maps);
1668 /* Loop over the given keymaps, making a pane for each map.
1669 But don't make a pane that is empty--ignore that map instead. */
1670 for (i = 0; i < len; i++)
1672 if (!KEYMAPP (mapvec[i]))
1674 /* Here we have a command at top level in the menu bar
1675 as opposed to a submenu. */
1676 top_level_items = 1;
1677 push_menu_pane (Qnil, Qnil);
1678 push_menu_item (item_name, Qt, item_key, mapvec[i],
1679 Qnil, Qnil, Qnil, Qnil);
1681 else
1683 Lisp_Object prompt;
1684 prompt = Fkeymap_prompt (mapvec[i]);
1685 single_keymap_panes (mapvec[i],
1686 !NILP (prompt) ? prompt : item_name,
1687 item_key, 0, 10);
1691 return top_level_items;
1694 /* Create a tree of widget_value objects
1695 representing the panes and items
1696 in menu_items starting at index START, up to index END. */
1698 static widget_value *
1699 digest_single_submenu (start, end, top_level_items)
1700 int start, end, top_level_items;
1702 widget_value *wv, *prev_wv, *save_wv, *first_wv;
1703 int i;
1704 int submenu_depth = 0;
1705 widget_value **submenu_stack;
1707 submenu_stack
1708 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1709 wv = xmalloc_widget_value ();
1710 wv->name = "menu";
1711 wv->value = 0;
1712 wv->enabled = 1;
1713 wv->button_type = BUTTON_TYPE_NONE;
1714 wv->help = Qnil;
1715 first_wv = wv;
1716 save_wv = 0;
1717 prev_wv = 0;
1719 /* Loop over all panes and items made by the preceding call
1720 to parse_single_submenu and construct a tree of widget_value objects.
1721 Ignore the panes and items used by previous calls to
1722 digest_single_submenu, even though those are also in menu_items. */
1723 i = start;
1724 while (i < end)
1726 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1728 submenu_stack[submenu_depth++] = save_wv;
1729 save_wv = prev_wv;
1730 prev_wv = 0;
1731 i++;
1733 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
1735 prev_wv = save_wv;
1736 save_wv = submenu_stack[--submenu_depth];
1737 i++;
1739 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
1740 && submenu_depth != 0)
1741 i += MENU_ITEMS_PANE_LENGTH;
1742 /* Ignore a nil in the item list.
1743 It's meaningful only for dialog boxes. */
1744 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
1745 i += 1;
1746 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
1748 /* Create a new pane. */
1749 Lisp_Object pane_name, prefix;
1750 char *pane_string;
1752 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
1753 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
1755 #ifndef HAVE_MULTILINGUAL_MENU
1756 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1758 pane_name = ENCODE_SYSTEM (pane_name);
1759 AREF (menu_items, i + MENU_ITEMS_PANE_NAME) = pane_name;
1761 #endif
1762 pane_string = (NILP (pane_name)
1763 ? "" : (char *) SDATA (pane_name));
1764 /* If there is just one top-level pane, put all its items directly
1765 under the top-level menu. */
1766 if (menu_items_n_panes == 1)
1767 pane_string = "";
1769 /* If the pane has a meaningful name,
1770 make the pane a top-level menu item
1771 with its items as a submenu beneath it. */
1772 if (strcmp (pane_string, ""))
1774 wv = xmalloc_widget_value ();
1775 if (save_wv)
1776 save_wv->next = wv;
1777 else
1778 first_wv->contents = wv;
1779 wv->lname = pane_name;
1780 /* Set value to 1 so update_submenu_strings can handle '@' */
1781 wv->value = (char *)1;
1782 wv->enabled = 1;
1783 wv->button_type = BUTTON_TYPE_NONE;
1784 wv->help = Qnil;
1786 save_wv = wv;
1787 prev_wv = 0;
1788 i += MENU_ITEMS_PANE_LENGTH;
1790 else
1792 /* Create a new item within current pane. */
1793 Lisp_Object item_name, enable, descrip, def, type, selected;
1794 Lisp_Object help;
1796 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1797 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1798 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1799 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1800 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1801 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1802 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1804 #ifndef HAVE_MULTILINGUAL_MENU
1805 if (STRING_MULTIBYTE (item_name))
1807 item_name = ENCODE_MENU_STRING (item_name);
1808 AREF (menu_items, i + MENU_ITEMS_ITEM_NAME) = item_name;
1811 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1813 descrip = ENCODE_MENU_STRING (descrip);
1814 AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY) = descrip;
1816 #endif /* not HAVE_MULTILINGUAL_MENU */
1818 wv = xmalloc_widget_value ();
1819 if (prev_wv)
1820 prev_wv->next = wv;
1821 else
1822 save_wv->contents = wv;
1824 wv->lname = item_name;
1825 if (!NILP (descrip))
1826 wv->lkey = descrip;
1827 wv->value = 0;
1828 /* The EMACS_INT cast avoids a warning. There's no problem
1829 as long as pointers have enough bits to hold small integers. */
1830 wv->call_data = (!NILP (def) ? (void *) (EMACS_INT) i : 0);
1831 wv->enabled = !NILP (enable);
1833 if (NILP (type))
1834 wv->button_type = BUTTON_TYPE_NONE;
1835 else if (EQ (type, QCradio))
1836 wv->button_type = BUTTON_TYPE_RADIO;
1837 else if (EQ (type, QCtoggle))
1838 wv->button_type = BUTTON_TYPE_TOGGLE;
1839 else
1840 abort ();
1842 wv->selected = !NILP (selected);
1843 if (! STRINGP (help))
1844 help = Qnil;
1846 wv->help = help;
1848 prev_wv = wv;
1850 i += MENU_ITEMS_ITEM_LENGTH;
1854 /* If we have just one "menu item"
1855 that was originally a button, return it by itself. */
1856 if (top_level_items && first_wv->contents && first_wv->contents->next == 0)
1858 wv = first_wv->contents;
1859 free_widget_value (first_wv);
1860 return wv;
1863 return first_wv;
1866 /* Walk through the widget_value tree starting at FIRST_WV and update
1867 the char * pointers from the corresponding lisp values.
1868 We do this after building the whole tree, since GC may happen while the
1869 tree is constructed, and small strings are relocated. So we must wait
1870 until no GC can happen before storing pointers into lisp values. */
1871 static void
1872 update_submenu_strings (first_wv)
1873 widget_value *first_wv;
1875 widget_value *wv;
1877 for (wv = first_wv; wv; wv = wv->next)
1879 if (STRINGP (wv->lname))
1881 wv->name = SDATA (wv->lname);
1883 /* Ignore the @ that means "separate pane".
1884 This is a kludge, but this isn't worth more time. */
1885 if (wv->value == (char *)1)
1887 if (wv->name[0] == '@')
1888 wv->name++;
1889 wv->value = 0;
1893 if (STRINGP (wv->lkey))
1894 wv->key = SDATA (wv->lkey);
1896 if (wv->contents)
1897 update_submenu_strings (wv->contents);
1902 /* Recompute all the widgets of frame F, when the menu bar has been
1903 changed. Value is non-zero if widgets were updated. */
1905 static int
1906 update_frame_menubar (f)
1907 FRAME_PTR f;
1909 #ifdef USE_GTK
1910 return xg_update_frame_menubar (f);
1911 #else
1912 struct x_output *x = f->output_data.x;
1913 int columns, rows;
1915 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
1916 return 0;
1918 BLOCK_INPUT;
1919 /* Save the size of the frame because the pane widget doesn't accept
1920 to resize itself. So force it. */
1921 columns = FRAME_COLS (f);
1922 rows = FRAME_LINES (f);
1924 /* Do the voodoo which means "I'm changing lots of things, don't try
1925 to refigure sizes until I'm done." */
1926 lw_refigure_widget (x->column_widget, False);
1928 /* The order in which children are managed is the top to bottom
1929 order in which they are displayed in the paned window. First,
1930 remove the text-area widget. */
1931 XtUnmanageChild (x->edit_widget);
1933 /* Remove the menubar that is there now, and put up the menubar that
1934 should be there. */
1935 XtManageChild (x->menubar_widget);
1936 XtMapWidget (x->menubar_widget);
1937 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
1939 /* Re-manage the text-area widget, and then thrash the sizes. */
1940 XtManageChild (x->edit_widget);
1941 lw_refigure_widget (x->column_widget, True);
1943 /* Force the pane widget to resize itself with the right values. */
1944 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
1945 UNBLOCK_INPUT;
1946 #endif
1947 return 1;
1950 /* Set the contents of the menubar widgets of frame F.
1951 The argument FIRST_TIME is currently ignored;
1952 it is set the first time this is called, from initialize_frame_menubar. */
1954 void
1955 set_frame_menubar (f, first_time, deep_p)
1956 FRAME_PTR f;
1957 int first_time;
1958 int deep_p;
1960 xt_or_gtk_widget menubar_widget = f->output_data.x->menubar_widget;
1961 #ifdef USE_X_TOOLKIT
1962 LWLIB_ID id;
1963 #endif
1964 Lisp_Object items;
1965 widget_value *wv, *first_wv, *prev_wv = 0;
1966 int i, last_i = 0;
1967 int *submenu_start, *submenu_end;
1968 int *submenu_top_level_items, *submenu_n_panes;
1971 XSETFRAME (Vmenu_updating_frame, f);
1973 #ifdef USE_X_TOOLKIT
1974 if (f->output_data.x->id == 0)
1975 f->output_data.x->id = next_menubar_widget_id++;
1976 id = f->output_data.x->id;
1977 #endif
1979 if (! menubar_widget)
1980 deep_p = 1;
1981 else if (pending_menu_activation && !deep_p)
1982 deep_p = 1;
1983 /* Make the first call for any given frame always go deep. */
1984 else if (!f->output_data.x->saved_menu_event && !deep_p)
1986 deep_p = 1;
1987 f->output_data.x->saved_menu_event = (XEvent*)xmalloc (sizeof (XEvent));
1988 f->output_data.x->saved_menu_event->type = 0;
1991 #ifdef USE_GTK
1992 /* If we have detached menus, we must update deep so detached menus
1993 also gets updated. */
1994 deep_p = deep_p || xg_have_tear_offs ();
1995 #endif
1997 if (deep_p)
1999 /* Make a widget-value tree representing the entire menu trees. */
2001 struct buffer *prev = current_buffer;
2002 Lisp_Object buffer;
2003 int specpdl_count = SPECPDL_INDEX ();
2004 int previous_menu_items_used = f->menu_bar_items_used;
2005 Lisp_Object *previous_items
2006 = (Lisp_Object *) alloca (previous_menu_items_used
2007 * sizeof (Lisp_Object));
2009 /* If we are making a new widget, its contents are empty,
2010 do always reinitialize them. */
2011 if (! menubar_widget)
2012 previous_menu_items_used = 0;
2014 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
2015 specbind (Qinhibit_quit, Qt);
2016 /* Don't let the debugger step into this code
2017 because it is not reentrant. */
2018 specbind (Qdebug_on_next_call, Qnil);
2020 record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil));
2021 record_unwind_protect (unuse_menu_items, Qnil);
2022 if (NILP (Voverriding_local_map_menu_flag))
2024 specbind (Qoverriding_terminal_local_map, Qnil);
2025 specbind (Qoverriding_local_map, Qnil);
2028 set_buffer_internal_1 (XBUFFER (buffer));
2030 /* Run the Lucid hook. */
2031 safe_run_hooks (Qactivate_menubar_hook);
2033 /* If it has changed current-menubar from previous value,
2034 really recompute the menubar from the value. */
2035 if (! NILP (Vlucid_menu_bar_dirty_flag))
2036 call0 (Qrecompute_lucid_menubar);
2037 safe_run_hooks (Qmenu_bar_update_hook);
2038 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
2040 items = FRAME_MENU_BAR_ITEMS (f);
2042 /* Save the frame's previous menu bar contents data. */
2043 if (previous_menu_items_used)
2044 bcopy (XVECTOR (f->menu_bar_vector)->contents, previous_items,
2045 previous_menu_items_used * sizeof (Lisp_Object));
2047 /* Fill in menu_items with the current menu bar contents.
2048 This can evaluate Lisp code. */
2049 menu_items = f->menu_bar_vector;
2050 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
2051 submenu_start = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
2052 submenu_end = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
2053 submenu_n_panes = (int *) alloca (XVECTOR (items)->size * sizeof (int));
2054 submenu_top_level_items
2055 = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
2056 init_menu_items ();
2057 for (i = 0; i < XVECTOR (items)->size; i += 4)
2059 Lisp_Object key, string, maps;
2061 last_i = i;
2063 key = XVECTOR (items)->contents[i];
2064 string = XVECTOR (items)->contents[i + 1];
2065 maps = XVECTOR (items)->contents[i + 2];
2066 if (NILP (string))
2067 break;
2069 submenu_start[i] = menu_items_used;
2071 menu_items_n_panes = 0;
2072 submenu_top_level_items[i]
2073 = parse_single_submenu (key, string, maps);
2074 submenu_n_panes[i] = menu_items_n_panes;
2076 submenu_end[i] = menu_items_used;
2079 finish_menu_items ();
2081 /* Convert menu_items into widget_value trees
2082 to display the menu. This cannot evaluate Lisp code. */
2084 wv = xmalloc_widget_value ();
2085 wv->name = "menubar";
2086 wv->value = 0;
2087 wv->enabled = 1;
2088 wv->button_type = BUTTON_TYPE_NONE;
2089 wv->help = Qnil;
2090 first_wv = wv;
2092 for (i = 0; i < last_i; i += 4)
2094 menu_items_n_panes = submenu_n_panes[i];
2095 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
2096 submenu_top_level_items[i]);
2097 if (prev_wv)
2098 prev_wv->next = wv;
2099 else
2100 first_wv->contents = wv;
2101 /* Don't set wv->name here; GC during the loop might relocate it. */
2102 wv->enabled = 1;
2103 wv->button_type = BUTTON_TYPE_NONE;
2104 prev_wv = wv;
2107 set_buffer_internal_1 (prev);
2108 unbind_to (specpdl_count, Qnil);
2110 /* If there has been no change in the Lisp-level contents
2111 of the menu bar, skip redisplaying it. Just exit. */
2113 for (i = 0; i < previous_menu_items_used; i++)
2114 if (menu_items_used == i
2115 || (!EQ (previous_items[i], XVECTOR (menu_items)->contents[i])))
2116 break;
2117 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
2119 free_menubar_widget_value_tree (first_wv);
2120 discard_menu_items ();
2122 return;
2125 /* Now GC cannot happen during the lifetime of the widget_value,
2126 so it's safe to store data from a Lisp_String. */
2127 wv = first_wv->contents;
2128 for (i = 0; i < XVECTOR (items)->size; i += 4)
2130 Lisp_Object string;
2131 string = XVECTOR (items)->contents[i + 1];
2132 if (NILP (string))
2133 break;
2134 wv->name = (char *) SDATA (string);
2135 update_submenu_strings (wv->contents);
2136 wv = wv->next;
2139 f->menu_bar_vector = menu_items;
2140 f->menu_bar_items_used = menu_items_used;
2141 discard_menu_items ();
2143 else
2145 /* Make a widget-value tree containing
2146 just the top level menu bar strings. */
2148 wv = xmalloc_widget_value ();
2149 wv->name = "menubar";
2150 wv->value = 0;
2151 wv->enabled = 1;
2152 wv->button_type = BUTTON_TYPE_NONE;
2153 wv->help = Qnil;
2154 first_wv = wv;
2156 items = FRAME_MENU_BAR_ITEMS (f);
2157 for (i = 0; i < XVECTOR (items)->size; i += 4)
2159 Lisp_Object string;
2161 string = XVECTOR (items)->contents[i + 1];
2162 if (NILP (string))
2163 break;
2165 wv = xmalloc_widget_value ();
2166 wv->name = (char *) SDATA (string);
2167 wv->value = 0;
2168 wv->enabled = 1;
2169 wv->button_type = BUTTON_TYPE_NONE;
2170 wv->help = Qnil;
2171 /* This prevents lwlib from assuming this
2172 menu item is really supposed to be empty. */
2173 /* The EMACS_INT cast avoids a warning.
2174 This value just has to be different from small integers. */
2175 wv->call_data = (void *) (EMACS_INT) (-1);
2177 if (prev_wv)
2178 prev_wv->next = wv;
2179 else
2180 first_wv->contents = wv;
2181 prev_wv = wv;
2184 /* Forget what we thought we knew about what is in the
2185 detailed contents of the menu bar menus.
2186 Changing the top level always destroys the contents. */
2187 f->menu_bar_items_used = 0;
2190 /* Create or update the menu bar widget. */
2192 BLOCK_INPUT;
2194 #ifdef USE_GTK
2195 xg_crazy_callback_abort = 1;
2196 if (menubar_widget)
2198 /* The fourth arg is DEEP_P, which says to consider the entire
2199 menu trees we supply, rather than just the menu bar item names. */
2200 xg_modify_menubar_widgets (menubar_widget,
2202 first_wv,
2203 deep_p,
2204 G_CALLBACK (menubar_selection_callback),
2205 G_CALLBACK (popup_deactivate_callback),
2206 G_CALLBACK (menu_highlight_callback));
2208 else
2210 GtkWidget *wvbox = f->output_data.x->vbox_widget;
2212 menubar_widget
2213 = xg_create_widget ("menubar", "menubar", f, first_wv,
2214 G_CALLBACK (menubar_selection_callback),
2215 G_CALLBACK (popup_deactivate_callback),
2216 G_CALLBACK (menu_highlight_callback));
2218 f->output_data.x->menubar_widget = menubar_widget;
2222 #else /* not USE_GTK */
2223 if (menubar_widget)
2225 /* Disable resizing (done for Motif!) */
2226 lw_allow_resizing (f->output_data.x->widget, False);
2228 /* The third arg is DEEP_P, which says to consider the entire
2229 menu trees we supply, rather than just the menu bar item names. */
2230 lw_modify_all_widgets (id, first_wv, deep_p);
2232 /* Re-enable the edit widget to resize. */
2233 lw_allow_resizing (f->output_data.x->widget, True);
2235 else
2237 menubar_widget = lw_create_widget ("menubar", "menubar", id, first_wv,
2238 f->output_data.x->column_widget,
2240 popup_activate_callback,
2241 menubar_selection_callback,
2242 popup_deactivate_callback,
2243 menu_highlight_callback);
2244 f->output_data.x->menubar_widget = menubar_widget;
2248 int menubar_size
2249 = (f->output_data.x->menubar_widget
2250 ? (f->output_data.x->menubar_widget->core.height
2251 + f->output_data.x->menubar_widget->core.border_width)
2252 : 0);
2254 #if 0 /* Experimentally, we now get the right results
2255 for -geometry -0-0 without this. 24 Aug 96, rms. */
2256 #ifdef USE_LUCID
2257 if (FRAME_EXTERNAL_MENU_BAR (f))
2259 Dimension ibw = 0;
2260 XtVaGetValues (f->output_data.x->column_widget,
2261 XtNinternalBorderWidth, &ibw, NULL);
2262 menubar_size += ibw;
2264 #endif /* USE_LUCID */
2265 #endif /* 0 */
2267 f->output_data.x->menubar_height = menubar_size;
2269 #endif /* not USE_GTK */
2271 free_menubar_widget_value_tree (first_wv);
2272 update_frame_menubar (f);
2274 #ifdef USE_GTK
2275 xg_crazy_callback_abort = 0;
2276 #endif
2278 UNBLOCK_INPUT;
2281 /* Called from Fx_create_frame to create the initial menubar of a frame
2282 before it is mapped, so that the window is mapped with the menubar already
2283 there instead of us tacking it on later and thrashing the window after it
2284 is visible. */
2286 void
2287 initialize_frame_menubar (f)
2288 FRAME_PTR f;
2290 /* This function is called before the first chance to redisplay
2291 the frame. It has to be, so the frame will have the right size. */
2292 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
2293 set_frame_menubar (f, 1, 1);
2297 /* Get rid of the menu bar of frame F, and free its storage.
2298 This is used when deleting a frame, and when turning off the menu bar.
2299 For GTK this function is in gtkutil.c. */
2301 #ifndef USE_GTK
2302 void
2303 free_frame_menubar (f)
2304 FRAME_PTR f;
2306 Widget menubar_widget;
2308 menubar_widget = f->output_data.x->menubar_widget;
2310 f->output_data.x->menubar_height = 0;
2312 if (menubar_widget)
2314 #ifdef USE_MOTIF
2315 /* Removing the menu bar magically changes the shell widget's x
2316 and y position of (0, 0) which, when the menu bar is turned
2317 on again, leads to pull-down menuss appearing in strange
2318 positions near the upper-left corner of the display. This
2319 happens only with some window managers like twm and ctwm,
2320 but not with other like Motif's mwm or kwm, because the
2321 latter generate ConfigureNotify events when the menu bar
2322 is switched off, which fixes the shell position. */
2323 Position x0, y0, x1, y1;
2324 #endif
2326 BLOCK_INPUT;
2328 #ifdef USE_MOTIF
2329 if (f->output_data.x->widget)
2330 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
2331 #endif
2333 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
2334 f->output_data.x->menubar_widget = NULL;
2336 #ifdef USE_MOTIF
2337 if (f->output_data.x->widget)
2339 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
2340 if (x1 == 0 && y1 == 0)
2341 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
2343 #endif
2345 UNBLOCK_INPUT;
2348 #endif /* not USE_GTK */
2350 #endif /* USE_X_TOOLKIT || USE_GTK */
2352 /* xmenu_show actually displays a menu using the panes and items in menu_items
2353 and returns the value selected from it.
2354 There are two versions of xmenu_show, one for Xt and one for Xlib.
2355 Both assume input is blocked by the caller. */
2357 /* F is the frame the menu is for.
2358 X and Y are the frame-relative specified position,
2359 relative to the inside upper left corner of the frame F.
2360 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
2361 KEYMAPS is 1 if this menu was specified with keymaps;
2362 in that case, we return a list containing the chosen item's value
2363 and perhaps also the pane's prefix.
2364 TITLE is the specified menu title.
2365 ERROR is a place to store an error message string in case of failure.
2366 (We return nil on failure, but the value doesn't actually matter.) */
2368 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
2370 /* The item selected in the popup menu. */
2371 static Lisp_Object *volatile menu_item_selection;
2373 #ifdef USE_GTK
2375 /* Used when position a popup menu. See menu_position_func and
2376 create_and_show_popup_menu below. */
2377 struct next_popup_x_y
2379 FRAME_PTR f;
2380 int x;
2381 int y;
2384 /* The menu position function to use if we are not putting a popup
2385 menu where the pointer is.
2386 MENU is the menu to pop up.
2387 X and Y shall on exit contain x/y where the menu shall pop up.
2388 PUSH_IN is not documented in the GTK manual.
2389 USER_DATA is any data passed in when calling gtk_menu_popup.
2390 Here it points to a struct next_popup_x_y where the coordinates
2391 to store in *X and *Y are as well as the frame for the popup.
2393 Here only X and Y are used. */
2394 static void
2395 menu_position_func (menu, x, y, push_in, user_data)
2396 GtkMenu *menu;
2397 gint *x;
2398 gint *y;
2399 gboolean *push_in;
2400 gpointer user_data;
2402 struct next_popup_x_y* data = (struct next_popup_x_y*)user_data;
2403 GtkRequisition req;
2404 int disp_width = FRAME_X_DISPLAY_INFO (data->f)->width;
2405 int disp_height = FRAME_X_DISPLAY_INFO (data->f)->height;
2407 *x = data->x;
2408 *y = data->y;
2410 /* Check if there is room for the menu. If not, adjust x/y so that
2411 the menu is fully visible. */
2412 gtk_widget_size_request (GTK_WIDGET (menu), &req);
2413 if (data->x + req.width > disp_width)
2414 *x -= data->x + req.width - disp_width;
2415 if (data->y + req.height > disp_height)
2416 *y -= data->y + req.height - disp_height;
2419 static void
2420 popup_selection_callback (widget, client_data)
2421 GtkWidget *widget;
2422 gpointer client_data;
2424 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
2426 if (xg_crazy_callback_abort) return;
2427 if (cb_data) menu_item_selection = (Lisp_Object *) cb_data->call_data;
2430 static Lisp_Object
2431 pop_down_menu (arg)
2432 Lisp_Object arg;
2434 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
2436 popup_activated_flag = 0;
2437 BLOCK_INPUT;
2438 gtk_widget_destroy (GTK_WIDGET (p->pointer));
2439 UNBLOCK_INPUT;
2440 return Qnil;
2443 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
2444 menu pops down.
2445 menu_item_selection will be set to the selection. */
2446 static void
2447 create_and_show_popup_menu (f, first_wv, x, y, for_click)
2448 FRAME_PTR f;
2449 widget_value *first_wv;
2450 int x;
2451 int y;
2452 int for_click;
2454 int i;
2455 GtkWidget *menu;
2456 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
2457 struct next_popup_x_y popup_x_y;
2458 int specpdl_count = SPECPDL_INDEX ();
2460 xg_crazy_callback_abort = 1;
2461 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
2462 G_CALLBACK (popup_selection_callback),
2463 G_CALLBACK (popup_deactivate_callback),
2464 G_CALLBACK (menu_highlight_callback));
2465 xg_crazy_callback_abort = 0;
2467 for (i = 0; i < 5; i++)
2468 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
2469 break;
2471 if (! for_click)
2473 /* Not invoked by a click. pop up at x/y. */
2474 pos_func = menu_position_func;
2476 /* Adjust coordinates to be root-window-relative. */
2477 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
2478 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
2480 popup_x_y.x = x;
2481 popup_x_y.y = y;
2482 popup_x_y.f = f;
2485 /* Display the menu. */
2486 gtk_widget_show_all (menu);
2487 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i, 0);
2489 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
2491 /* Set this to one. popup_widget_loop increases it by one, so it becomes
2492 two. show_help_echo uses this to detect popup menus. */
2493 popup_activated_flag = 1;
2494 /* Process events that apply to the menu. */
2495 popup_widget_loop (1, menu);
2497 unbind_to (specpdl_count, Qnil);
2499 /* Must reset this manually because the button release event is not passed
2500 to Emacs event loop. */
2501 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2504 #else /* not USE_GTK */
2506 /* We need a unique id for each widget handled by the Lucid Widget
2507 library.
2509 For the main windows, and popup menus, we use this counter,
2510 which we increment each time after use. This starts from 1<<16.
2512 For menu bars, we use numbers starting at 0, counted in
2513 next_menubar_widget_id. */
2514 LWLIB_ID widget_id_tick;
2516 static void
2517 popup_selection_callback (widget, id, client_data)
2518 Widget widget;
2519 LWLIB_ID id;
2520 XtPointer client_data;
2522 menu_item_selection = (Lisp_Object *) client_data;
2525 /* ARG is the LWLIB ID of the dialog box, represented
2526 as a Lisp object as (HIGHPART . LOWPART). */
2528 static Lisp_Object
2529 pop_down_menu (arg)
2530 Lisp_Object arg;
2532 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
2533 | XINT (XCDR (arg)));
2535 BLOCK_INPUT;
2536 lw_destroy_all_widgets (id);
2537 UNBLOCK_INPUT;
2538 popup_activated_flag = 0;
2540 return Qnil;
2543 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
2544 menu pops down.
2545 menu_item_selection will be set to the selection. */
2546 static void
2547 create_and_show_popup_menu (f, first_wv, x, y, for_click)
2548 FRAME_PTR f;
2549 widget_value *first_wv;
2550 int x;
2551 int y;
2552 int for_click;
2554 int i;
2555 Arg av[2];
2556 int ac = 0;
2557 XButtonPressedEvent dummy;
2558 LWLIB_ID menu_id;
2559 Widget menu;
2561 menu_id = widget_id_tick++;
2562 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
2563 f->output_data.x->widget, 1, 0,
2564 popup_selection_callback,
2565 popup_deactivate_callback,
2566 menu_highlight_callback);
2568 dummy.type = ButtonPress;
2569 dummy.serial = 0;
2570 dummy.send_event = 0;
2571 dummy.display = FRAME_X_DISPLAY (f);
2572 dummy.time = CurrentTime;
2573 dummy.root = FRAME_X_DISPLAY_INFO (f)->root_window;
2574 dummy.window = dummy.root;
2575 dummy.subwindow = dummy.root;
2576 dummy.x = x;
2577 dummy.y = y;
2579 /* Adjust coordinates to be root-window-relative. */
2580 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
2581 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
2583 dummy.x_root = x;
2584 dummy.y_root = y;
2586 dummy.state = 0;
2587 dummy.button = 0;
2588 for (i = 0; i < 5; i++)
2589 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
2590 dummy.button = i;
2592 /* Don't allow any geometry request from the user. */
2593 XtSetArg (av[ac], XtNgeometry, 0); ac++;
2594 XtSetValues (menu, av, ac);
2596 /* Display the menu. */
2597 lw_popup_menu (menu, (XEvent *) &dummy);
2598 popup_activated_flag = 1;
2601 int fact = 4 * sizeof (LWLIB_ID);
2602 int specpdl_count = SPECPDL_INDEX ();
2603 record_unwind_protect (pop_down_menu,
2604 Fcons (make_number (menu_id >> (fact)),
2605 make_number (menu_id & ~(-1 << (fact)))));
2607 /* Process events that apply to the menu. */
2608 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), menu_id, 1, 0);
2610 unbind_to (specpdl_count, Qnil);
2614 #endif /* not USE_GTK */
2616 static Lisp_Object
2617 xmenu_show (f, x, y, for_click, keymaps, title, error)
2618 FRAME_PTR f;
2619 int x;
2620 int y;
2621 int for_click;
2622 int keymaps;
2623 Lisp_Object title;
2624 char **error;
2626 int i;
2627 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
2628 widget_value **submenu_stack
2629 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
2630 Lisp_Object *subprefix_stack
2631 = (Lisp_Object *) alloca (menu_items_used * sizeof (Lisp_Object));
2632 int submenu_depth = 0;
2634 int first_pane;
2636 *error = NULL;
2638 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2640 *error = "Empty menu";
2641 return Qnil;
2644 /* Create a tree of widget_value objects
2645 representing the panes and their items. */
2646 wv = xmalloc_widget_value ();
2647 wv->name = "menu";
2648 wv->value = 0;
2649 wv->enabled = 1;
2650 wv->button_type = BUTTON_TYPE_NONE;
2651 wv->help =Qnil;
2652 first_wv = wv;
2653 first_pane = 1;
2655 /* Loop over all panes and items, filling in the tree. */
2656 i = 0;
2657 while (i < menu_items_used)
2659 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
2661 submenu_stack[submenu_depth++] = save_wv;
2662 save_wv = prev_wv;
2663 prev_wv = 0;
2664 first_pane = 1;
2665 i++;
2667 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
2669 prev_wv = save_wv;
2670 save_wv = submenu_stack[--submenu_depth];
2671 first_pane = 0;
2672 i++;
2674 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
2675 && submenu_depth != 0)
2676 i += MENU_ITEMS_PANE_LENGTH;
2677 /* Ignore a nil in the item list.
2678 It's meaningful only for dialog boxes. */
2679 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2680 i += 1;
2681 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2683 /* Create a new pane. */
2684 Lisp_Object pane_name, prefix;
2685 char *pane_string;
2687 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
2688 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2690 #ifndef HAVE_MULTILINGUAL_MENU
2691 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
2693 pane_name = ENCODE_SYSTEM (pane_name);
2694 AREF (menu_items, i + MENU_ITEMS_PANE_NAME) = pane_name;
2696 #endif
2697 pane_string = (NILP (pane_name)
2698 ? "" : (char *) SDATA (pane_name));
2699 /* If there is just one top-level pane, put all its items directly
2700 under the top-level menu. */
2701 if (menu_items_n_panes == 1)
2702 pane_string = "";
2704 /* If the pane has a meaningful name,
2705 make the pane a top-level menu item
2706 with its items as a submenu beneath it. */
2707 if (!keymaps && strcmp (pane_string, ""))
2709 wv = xmalloc_widget_value ();
2710 if (save_wv)
2711 save_wv->next = wv;
2712 else
2713 first_wv->contents = wv;
2714 wv->name = pane_string;
2715 if (keymaps && !NILP (prefix))
2716 wv->name++;
2717 wv->value = 0;
2718 wv->enabled = 1;
2719 wv->button_type = BUTTON_TYPE_NONE;
2720 wv->help = Qnil;
2721 save_wv = wv;
2722 prev_wv = 0;
2724 else if (first_pane)
2726 save_wv = wv;
2727 prev_wv = 0;
2729 first_pane = 0;
2730 i += MENU_ITEMS_PANE_LENGTH;
2732 else
2734 /* Create a new item within current pane. */
2735 Lisp_Object item_name, enable, descrip, def, type, selected, help;
2736 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2737 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2738 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2739 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
2740 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
2741 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
2742 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
2744 #ifndef HAVE_MULTILINGUAL_MENU
2745 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
2747 item_name = ENCODE_MENU_STRING (item_name);
2748 AREF (menu_items, i + MENU_ITEMS_ITEM_NAME) = item_name;
2751 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
2753 descrip = ENCODE_MENU_STRING (descrip);
2754 AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY) = descrip;
2756 #endif /* not HAVE_MULTILINGUAL_MENU */
2758 wv = xmalloc_widget_value ();
2759 if (prev_wv)
2760 prev_wv->next = wv;
2761 else
2762 save_wv->contents = wv;
2763 wv->name = (char *) SDATA (item_name);
2764 if (!NILP (descrip))
2765 wv->key = (char *) SDATA (descrip);
2766 wv->value = 0;
2767 /* If this item has a null value,
2768 make the call_data null so that it won't display a box
2769 when the mouse is on it. */
2770 wv->call_data
2771 = (!NILP (def) ? (void *) &XVECTOR (menu_items)->contents[i] : 0);
2772 wv->enabled = !NILP (enable);
2774 if (NILP (type))
2775 wv->button_type = BUTTON_TYPE_NONE;
2776 else if (EQ (type, QCtoggle))
2777 wv->button_type = BUTTON_TYPE_TOGGLE;
2778 else if (EQ (type, QCradio))
2779 wv->button_type = BUTTON_TYPE_RADIO;
2780 else
2781 abort ();
2783 wv->selected = !NILP (selected);
2785 if (! STRINGP (help))
2786 help = Qnil;
2788 wv->help = help;
2790 prev_wv = wv;
2792 i += MENU_ITEMS_ITEM_LENGTH;
2796 /* Deal with the title, if it is non-nil. */
2797 if (!NILP (title))
2799 widget_value *wv_title = xmalloc_widget_value ();
2800 widget_value *wv_sep1 = xmalloc_widget_value ();
2801 widget_value *wv_sep2 = xmalloc_widget_value ();
2803 wv_sep2->name = "--";
2804 wv_sep2->next = first_wv->contents;
2805 wv_sep2->help = Qnil;
2807 wv_sep1->name = "--";
2808 wv_sep1->next = wv_sep2;
2809 wv_sep1->help = Qnil;
2811 #ifndef HAVE_MULTILINGUAL_MENU
2812 if (STRING_MULTIBYTE (title))
2813 title = ENCODE_MENU_STRING (title);
2814 #endif
2816 wv_title->name = (char *) SDATA (title);
2817 wv_title->enabled = TRUE;
2818 wv_title->button_type = BUTTON_TYPE_NONE;
2819 wv_title->next = wv_sep1;
2820 wv_title->help = Qnil;
2821 first_wv->contents = wv_title;
2824 /* No selection has been chosen yet. */
2825 menu_item_selection = 0;
2827 /* Actually create and show the menu until popped down. */
2828 create_and_show_popup_menu (f, first_wv, x, y, for_click);
2830 /* Free the widget_value objects we used to specify the contents. */
2831 free_menubar_widget_value_tree (first_wv);
2833 /* Find the selected item, and its pane, to return
2834 the proper value. */
2835 if (menu_item_selection != 0)
2837 Lisp_Object prefix, entry;
2839 prefix = entry = Qnil;
2840 i = 0;
2841 while (i < menu_items_used)
2843 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
2845 subprefix_stack[submenu_depth++] = prefix;
2846 prefix = entry;
2847 i++;
2849 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
2851 prefix = subprefix_stack[--submenu_depth];
2852 i++;
2854 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2856 prefix
2857 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2858 i += MENU_ITEMS_PANE_LENGTH;
2860 /* Ignore a nil in the item list.
2861 It's meaningful only for dialog boxes. */
2862 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2863 i += 1;
2864 else
2866 entry
2867 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2868 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
2870 if (keymaps != 0)
2872 int j;
2874 entry = Fcons (entry, Qnil);
2875 if (!NILP (prefix))
2876 entry = Fcons (prefix, entry);
2877 for (j = submenu_depth - 1; j >= 0; j--)
2878 if (!NILP (subprefix_stack[j]))
2879 entry = Fcons (subprefix_stack[j], entry);
2881 return entry;
2883 i += MENU_ITEMS_ITEM_LENGTH;
2888 return Qnil;
2891 #ifdef USE_GTK
2892 static void
2893 dialog_selection_callback (widget, client_data)
2894 GtkWidget *widget;
2895 gpointer client_data;
2897 /* The EMACS_INT cast avoids a warning. There's no problem
2898 as long as pointers have enough bits to hold small integers. */
2899 if ((int) (EMACS_INT) client_data != -1)
2900 menu_item_selection = (Lisp_Object *) client_data;
2902 popup_activated_flag = 0;
2905 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
2906 dialog pops down.
2907 menu_item_selection will be set to the selection. */
2908 static void
2909 create_and_show_dialog (f, first_wv)
2910 FRAME_PTR f;
2911 widget_value *first_wv;
2913 GtkWidget *menu;
2915 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
2916 G_CALLBACK (dialog_selection_callback),
2917 G_CALLBACK (popup_deactivate_callback),
2920 if (menu)
2922 int specpdl_count = SPECPDL_INDEX ();
2923 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
2925 /* Display the menu. */
2926 gtk_widget_show_all (menu);
2928 /* Process events that apply to the menu. */
2929 popup_widget_loop (1, menu);
2931 unbind_to (specpdl_count, Qnil);
2935 #else /* not USE_GTK */
2936 static void
2937 dialog_selection_callback (widget, id, client_data)
2938 Widget widget;
2939 LWLIB_ID id;
2940 XtPointer client_data;
2942 /* The EMACS_INT cast avoids a warning. There's no problem
2943 as long as pointers have enough bits to hold small integers. */
2944 if ((int) (EMACS_INT) client_data != -1)
2945 menu_item_selection = (Lisp_Object *) client_data;
2947 BLOCK_INPUT;
2948 lw_destroy_all_widgets (id);
2949 UNBLOCK_INPUT;
2950 popup_activated_flag = 0;
2954 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
2955 dialog pops down.
2956 menu_item_selection will be set to the selection. */
2957 static void
2958 create_and_show_dialog (f, first_wv)
2959 FRAME_PTR f;
2960 widget_value *first_wv;
2962 LWLIB_ID dialog_id;
2964 dialog_id = widget_id_tick++;
2965 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
2966 f->output_data.x->widget, 1, 0,
2967 dialog_selection_callback, 0, 0);
2968 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
2970 /* Display the dialog box. */
2971 lw_pop_up_all_widgets (dialog_id);
2972 popup_activated_flag = 1;
2974 /* Process events that apply to the dialog box.
2975 Also handle timers. */
2977 int count = SPECPDL_INDEX ();
2978 int fact = 4 * sizeof (LWLIB_ID);
2980 /* xdialog_show_unwind is responsible for popping the dialog box down. */
2981 record_unwind_protect (pop_down_menu,
2982 Fcons (make_number (dialog_id >> (fact)),
2983 make_number (dialog_id & ~(-1 << (fact)))));
2985 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f),
2986 dialog_id, 1, 1);
2988 unbind_to (count, Qnil);
2992 #endif /* not USE_GTK */
2994 static char * button_names [] = {
2995 "button1", "button2", "button3", "button4", "button5",
2996 "button6", "button7", "button8", "button9", "button10" };
2998 static Lisp_Object
2999 xdialog_show (f, keymaps, title, error)
3000 FRAME_PTR f;
3001 int keymaps;
3002 Lisp_Object title;
3003 char **error;
3005 int i, nb_buttons=0;
3006 char dialog_name[6];
3008 widget_value *wv, *first_wv = 0, *prev_wv = 0;
3010 /* Number of elements seen so far, before boundary. */
3011 int left_count = 0;
3012 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
3013 int boundary_seen = 0;
3015 *error = NULL;
3017 if (menu_items_n_panes > 1)
3019 *error = "Multiple panes in dialog box";
3020 return Qnil;
3023 /* Create a tree of widget_value objects
3024 representing the text label and buttons. */
3026 Lisp_Object pane_name, prefix;
3027 char *pane_string;
3028 pane_name = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME];
3029 prefix = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_PREFIX];
3030 pane_string = (NILP (pane_name)
3031 ? "" : (char *) SDATA (pane_name));
3032 prev_wv = xmalloc_widget_value ();
3033 prev_wv->value = pane_string;
3034 if (keymaps && !NILP (prefix))
3035 prev_wv->name++;
3036 prev_wv->enabled = 1;
3037 prev_wv->name = "message";
3038 prev_wv->help = Qnil;
3039 first_wv = prev_wv;
3041 /* Loop over all panes and items, filling in the tree. */
3042 i = MENU_ITEMS_PANE_LENGTH;
3043 while (i < menu_items_used)
3046 /* Create a new item within current pane. */
3047 Lisp_Object item_name, enable, descrip;
3048 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
3049 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
3050 descrip
3051 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
3053 if (NILP (item_name))
3055 free_menubar_widget_value_tree (first_wv);
3056 *error = "Submenu in dialog items";
3057 return Qnil;
3059 if (EQ (item_name, Qquote))
3061 /* This is the boundary between left-side elts
3062 and right-side elts. Stop incrementing right_count. */
3063 boundary_seen = 1;
3064 i++;
3065 continue;
3067 if (nb_buttons >= 9)
3069 free_menubar_widget_value_tree (first_wv);
3070 *error = "Too many dialog items";
3071 return Qnil;
3074 wv = xmalloc_widget_value ();
3075 prev_wv->next = wv;
3076 wv->name = (char *) button_names[nb_buttons];
3077 if (!NILP (descrip))
3078 wv->key = (char *) SDATA (descrip);
3079 wv->value = (char *) SDATA (item_name);
3080 wv->call_data = (void *) &XVECTOR (menu_items)->contents[i];
3081 wv->enabled = !NILP (enable);
3082 wv->help = Qnil;
3083 prev_wv = wv;
3085 if (! boundary_seen)
3086 left_count++;
3088 nb_buttons++;
3089 i += MENU_ITEMS_ITEM_LENGTH;
3092 /* If the boundary was not specified,
3093 by default put half on the left and half on the right. */
3094 if (! boundary_seen)
3095 left_count = nb_buttons - nb_buttons / 2;
3097 wv = xmalloc_widget_value ();
3098 wv->name = dialog_name;
3099 wv->help = Qnil;
3100 /* Dialog boxes use a really stupid name encoding
3101 which specifies how many buttons to use
3102 and how many buttons are on the right.
3103 The Q means something also. */
3104 dialog_name[0] = 'Q';
3105 dialog_name[1] = '0' + nb_buttons;
3106 dialog_name[2] = 'B';
3107 dialog_name[3] = 'R';
3108 /* Number of buttons to put on the right. */
3109 dialog_name[4] = '0' + nb_buttons - left_count;
3110 dialog_name[5] = 0;
3111 wv->contents = first_wv;
3112 first_wv = wv;
3115 /* No selection has been chosen yet. */
3116 menu_item_selection = 0;
3118 /* Actually create and show the dialog. */
3119 create_and_show_dialog (f, first_wv);
3121 /* Free the widget_value objects we used to specify the contents. */
3122 free_menubar_widget_value_tree (first_wv);
3124 /* Find the selected item, and its pane, to return
3125 the proper value. */
3126 if (menu_item_selection != 0)
3128 Lisp_Object prefix;
3130 prefix = Qnil;
3131 i = 0;
3132 while (i < menu_items_used)
3134 Lisp_Object entry;
3136 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
3138 prefix
3139 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
3140 i += MENU_ITEMS_PANE_LENGTH;
3142 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
3144 /* This is the boundary between left-side elts and
3145 right-side elts. */
3146 ++i;
3148 else
3150 entry
3151 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
3152 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
3154 if (keymaps != 0)
3156 entry = Fcons (entry, Qnil);
3157 if (!NILP (prefix))
3158 entry = Fcons (prefix, entry);
3160 return entry;
3162 i += MENU_ITEMS_ITEM_LENGTH;
3167 return Qnil;
3170 #else /* not USE_X_TOOLKIT && not USE_GTK */
3172 /* The frame of the last activated non-toolkit menu bar.
3173 Used to generate menu help events. */
3175 static struct frame *menu_help_frame;
3178 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
3180 PANE is the pane number, and ITEM is the menu item number in
3181 the menu (currently not used).
3183 This cannot be done with generating a HELP_EVENT because
3184 XMenuActivate contains a loop that doesn't let Emacs process
3185 keyboard events. */
3187 static void
3188 menu_help_callback (help_string, pane, item)
3189 char *help_string;
3190 int pane, item;
3192 extern Lisp_Object Qmenu_item;
3193 Lisp_Object *first_item;
3194 Lisp_Object pane_name;
3195 Lisp_Object menu_object;
3197 first_item = XVECTOR (menu_items)->contents;
3198 if (EQ (first_item[0], Qt))
3199 pane_name = first_item[MENU_ITEMS_PANE_NAME];
3200 else if (EQ (first_item[0], Qquote))
3201 /* This shouldn't happen, see xmenu_show. */
3202 pane_name = empty_string;
3203 else
3204 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
3206 /* (menu-item MENU-NAME PANE-NUMBER) */
3207 menu_object = Fcons (Qmenu_item,
3208 Fcons (pane_name,
3209 Fcons (make_number (pane), Qnil)));
3210 show_help_echo (help_string ? build_string (help_string) : Qnil,
3211 Qnil, menu_object, make_number (item), 1);
3214 static Lisp_Object
3215 pop_down_menu (arg)
3216 Lisp_Object arg;
3218 struct Lisp_Save_Value *p1 = XSAVE_VALUE (Fcar (arg));
3219 struct Lisp_Save_Value *p2 = XSAVE_VALUE (Fcdr (arg));
3221 FRAME_PTR f = p1->pointer;
3222 XMenu *menu = p2->pointer;
3224 BLOCK_INPUT;
3225 #ifndef MSDOS
3226 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
3227 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
3228 #endif
3229 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
3231 #ifdef HAVE_X_WINDOWS
3232 /* Assume the mouse has moved out of the X window.
3233 If it has actually moved in, we will get an EnterNotify. */
3234 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
3236 /* State that no mouse buttons are now held.
3237 (The oldXMenu code doesn't track this info for us.)
3238 That is not necessarily true, but the fiction leads to reasonable
3239 results, and it is a pain to ask which are actually held now. */
3240 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
3242 #endif /* HAVE_X_WINDOWS */
3244 UNBLOCK_INPUT;
3246 return Qnil;
3250 static Lisp_Object
3251 xmenu_show (f, x, y, for_click, keymaps, title, error)
3252 FRAME_PTR f;
3253 int x, y;
3254 int for_click;
3255 int keymaps;
3256 Lisp_Object title;
3257 char **error;
3259 Window root;
3260 XMenu *menu;
3261 int pane, selidx, lpane, status;
3262 Lisp_Object entry, pane_prefix;
3263 char *datap;
3264 int ulx, uly, width, height;
3265 int dispwidth, dispheight;
3266 int i, j;
3267 int maxwidth;
3268 int dummy_int;
3269 unsigned int dummy_uint;
3270 int specpdl_count = SPECPDL_INDEX ();
3272 *error = 0;
3273 if (menu_items_n_panes == 0)
3274 return Qnil;
3276 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
3278 *error = "Empty menu";
3279 return Qnil;
3282 /* Figure out which root window F is on. */
3283 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
3284 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
3285 &dummy_uint, &dummy_uint);
3287 /* Make the menu on that window. */
3288 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
3289 if (menu == NULL)
3291 *error = "Can't create menu";
3292 return Qnil;
3295 #ifdef HAVE_X_WINDOWS
3296 /* Adjust coordinates to relative to the outer (window manager) window. */
3298 Window child;
3299 int win_x = 0, win_y = 0;
3301 /* Find the position of the outside upper-left corner of
3302 the inner window, with respect to the outer window. */
3303 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
3305 BLOCK_INPUT;
3306 XTranslateCoordinates (FRAME_X_DISPLAY (f),
3308 /* From-window, to-window. */
3309 f->output_data.x->window_desc,
3310 f->output_data.x->parent_desc,
3312 /* From-position, to-position. */
3313 0, 0, &win_x, &win_y,
3315 /* Child of window. */
3316 &child);
3317 UNBLOCK_INPUT;
3318 x += win_x;
3319 y += win_y;
3322 #endif /* HAVE_X_WINDOWS */
3324 /* Adjust coordinates to be root-window-relative. */
3325 x += f->left_pos;
3326 y += f->top_pos;
3328 /* Create all the necessary panes and their items. */
3329 i = 0;
3330 while (i < menu_items_used)
3332 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
3334 /* Create a new pane. */
3335 Lisp_Object pane_name, prefix;
3336 char *pane_string;
3338 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
3339 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
3340 pane_string = (NILP (pane_name)
3341 ? "" : (char *) SDATA (pane_name));
3342 if (keymaps && !NILP (prefix))
3343 pane_string++;
3345 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
3346 if (lpane == XM_FAILURE)
3348 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
3349 *error = "Can't create pane";
3350 return Qnil;
3352 i += MENU_ITEMS_PANE_LENGTH;
3354 /* Find the width of the widest item in this pane. */
3355 maxwidth = 0;
3356 j = i;
3357 while (j < menu_items_used)
3359 Lisp_Object item;
3360 item = XVECTOR (menu_items)->contents[j];
3361 if (EQ (item, Qt))
3362 break;
3363 if (NILP (item))
3365 j++;
3366 continue;
3368 width = SBYTES (item);
3369 if (width > maxwidth)
3370 maxwidth = width;
3372 j += MENU_ITEMS_ITEM_LENGTH;
3375 /* Ignore a nil in the item list.
3376 It's meaningful only for dialog boxes. */
3377 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
3378 i += 1;
3379 else
3381 /* Create a new item within current pane. */
3382 Lisp_Object item_name, enable, descrip, help;
3383 unsigned char *item_data;
3384 char *help_string;
3386 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
3387 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
3388 descrip
3389 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
3390 help = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_HELP];
3391 help_string = STRINGP (help) ? SDATA (help) : NULL;
3393 if (!NILP (descrip))
3395 int gap = maxwidth - SBYTES (item_name);
3396 #ifdef C_ALLOCA
3397 Lisp_Object spacer;
3398 spacer = Fmake_string (make_number (gap), make_number (' '));
3399 item_name = concat2 (item_name, spacer);
3400 item_name = concat2 (item_name, descrip);
3401 item_data = SDATA (item_name);
3402 #else
3403 /* if alloca is fast, use that to make the space,
3404 to reduce gc needs. */
3405 item_data
3406 = (unsigned char *) alloca (maxwidth
3407 + SBYTES (descrip) + 1);
3408 bcopy (SDATA (item_name), item_data,
3409 SBYTES (item_name));
3410 for (j = SCHARS (item_name); j < maxwidth; j++)
3411 item_data[j] = ' ';
3412 bcopy (SDATA (descrip), item_data + j,
3413 SBYTES (descrip));
3414 item_data[j + SBYTES (descrip)] = 0;
3415 #endif
3417 else
3418 item_data = SDATA (item_name);
3420 if (XMenuAddSelection (FRAME_X_DISPLAY (f),
3421 menu, lpane, 0, item_data,
3422 !NILP (enable), help_string)
3423 == XM_FAILURE)
3425 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
3426 *error = "Can't add selection to menu";
3427 return Qnil;
3429 i += MENU_ITEMS_ITEM_LENGTH;
3433 /* All set and ready to fly. */
3434 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
3435 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
3436 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
3437 x = min (x, dispwidth);
3438 y = min (y, dispheight);
3439 x = max (x, 1);
3440 y = max (y, 1);
3441 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
3442 &ulx, &uly, &width, &height);
3443 if (ulx+width > dispwidth)
3445 x -= (ulx + width) - dispwidth;
3446 ulx = dispwidth - width;
3448 if (uly+height > dispheight)
3450 y -= (uly + height) - dispheight;
3451 uly = dispheight - height;
3453 if (ulx < 0) x -= ulx;
3454 if (uly < 0) y -= uly;
3456 XMenuSetAEQ (menu, TRUE);
3457 XMenuSetFreeze (menu, TRUE);
3458 pane = selidx = 0;
3460 #ifndef MSDOS
3461 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
3462 #endif
3464 record_unwind_protect (pop_down_menu,
3465 Fcons (make_save_value (f, 0),
3466 make_save_value (menu, 0)));
3468 /* Help display under X won't work because XMenuActivate contains
3469 a loop that doesn't give Emacs a chance to process it. */
3470 menu_help_frame = f;
3471 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
3472 x, y, ButtonReleaseMask, &datap,
3473 menu_help_callback);
3475 switch (status)
3477 case XM_SUCCESS:
3478 #ifdef XDEBUG
3479 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
3480 #endif
3482 /* Find the item number SELIDX in pane number PANE. */
3483 i = 0;
3484 while (i < menu_items_used)
3486 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
3488 if (pane == 0)
3489 pane_prefix
3490 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
3491 pane--;
3492 i += MENU_ITEMS_PANE_LENGTH;
3494 else
3496 if (pane == -1)
3498 if (selidx == 0)
3500 entry
3501 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
3502 if (keymaps != 0)
3504 entry = Fcons (entry, Qnil);
3505 if (!NILP (pane_prefix))
3506 entry = Fcons (pane_prefix, entry);
3508 break;
3510 selidx--;
3512 i += MENU_ITEMS_ITEM_LENGTH;
3515 break;
3517 case XM_FAILURE:
3518 *error = "Can't activate menu";
3519 case XM_IA_SELECT:
3520 case XM_NO_SELECT:
3521 entry = Qnil;
3522 break;
3525 unbind_to (specpdl_count, Qnil);
3527 return entry;
3530 #endif /* not USE_X_TOOLKIT */
3532 #endif /* HAVE_MENUS */
3534 void
3535 syms_of_xmenu ()
3537 staticpro (&menu_items);
3538 menu_items = Qnil;
3539 menu_items_inuse = Qnil;
3541 Qdebug_on_next_call = intern ("debug-on-next-call");
3542 staticpro (&Qdebug_on_next_call);
3544 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame,
3545 doc: /* Frame for which we are updating a menu.
3546 The enable predicate for a menu command should check this variable. */);
3547 Vmenu_updating_frame = Qnil;
3549 #ifdef USE_X_TOOLKIT
3550 widget_id_tick = (1<<16);
3551 next_menubar_widget_id = 1;
3552 #endif
3554 defsubr (&Sx_popup_menu);
3555 #ifdef HAVE_MENUS
3556 defsubr (&Sx_popup_dialog);
3557 #endif
3560 /* arch-tag: 92ea573c-398e-496e-ac73-2436f7d63242
3561 (do not change this comment) */