1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1986, 1988, 1993, 1994, 1996, 1999, 2000, 2001, 2002, 2003,
3 2004, 2005, 2006 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)
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., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, 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. */
36 #if 0 /* Why was this included? And without syssignal.h? */
37 /* On 4.3 this loses if it comes after xterm.h. */
44 #include "termhooks.h"
49 #include "blockinput.h"
53 #include "sysselect.h"
60 /* This may include sys/types.h, and that somehow loses
61 if this is not done before the other system files. */
65 /* Load sys/types.h if not already loaded.
66 In some systems loading it twice is suicidal. */
68 #include <sys/types.h>
71 #include "dispextern.h"
74 /* Defining HAVE_MULTILINGUAL_MENU would mean that the toolkit menu
75 code accepts the Emacs internal encoding. */
76 #undef HAVE_MULTILINGUAL_MENU
80 #include <X11/IntrinsicP.h>
81 #include <X11/CoreP.h>
82 #include <X11/StringDefs.h>
83 #include <X11/Shell.h>
85 #include <X11/Xaw/Paned.h>
86 #endif /* USE_LUCID */
87 #include "../lwlib/lwlib.h"
88 #else /* not USE_X_TOOLKIT */
90 #include "../oldXMenu/XMenu.h"
92 #endif /* not USE_X_TOOLKIT */
93 #endif /* HAVE_X_WINDOWS */
100 Lisp_Object Qdebug_on_next_call
;
102 extern Lisp_Object Vmenu_updating_frame
;
104 extern Lisp_Object Qmenu_bar
;
106 extern Lisp_Object QCtoggle
, QCradio
;
108 extern Lisp_Object Voverriding_local_map
;
109 extern Lisp_Object Voverriding_local_map_menu_flag
;
111 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
113 extern Lisp_Object Qmenu_bar_update_hook
;
116 extern void set_frame_menubar
P_ ((FRAME_PTR
, int, int));
117 extern XtAppContext Xt_app_con
;
119 static Lisp_Object xdialog_show
P_ ((FRAME_PTR
, int, Lisp_Object
, Lisp_Object
,
121 static void popup_get_selection
P_ ((XEvent
*, struct x_display_info
*,
124 /* Define HAVE_BOXES if menus can handle radio and toggle buttons. */
127 #endif /* USE_X_TOOLKIT */
132 extern void set_frame_menubar
P_ ((FRAME_PTR
, int, int));
133 static Lisp_Object xdialog_show
P_ ((FRAME_PTR
, int, Lisp_Object
, Lisp_Object
,
137 /* This is how to deal with multibyte text if HAVE_MULTILINGUAL_MENU
138 isn't defined. The use of HAVE_MULTILINGUAL_MENU could probably be
139 confined to an extended version of this with sections of code below
140 using it unconditionally. */
142 /* gtk just uses utf-8. */
143 # define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
144 #elif defined HAVE_X_I18N
145 # define ENCODE_MENU_STRING(str) ENCODE_SYSTEM (str)
147 # define ENCODE_MENU_STRING(str) string_make_unibyte (str)
150 static void push_menu_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
151 Lisp_Object
, Lisp_Object
, Lisp_Object
,
152 Lisp_Object
, Lisp_Object
));
153 static int update_frame_menubar
P_ ((struct frame
*));
154 static Lisp_Object xmenu_show
P_ ((struct frame
*, int, int, int, int,
155 Lisp_Object
, char **));
156 static void keymap_panes
P_ ((Lisp_Object
*, int, int));
157 static void single_keymap_panes
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
159 static void list_of_panes
P_ ((Lisp_Object
));
160 static void list_of_items
P_ ((Lisp_Object
));
163 /* This holds a Lisp vector that holds the results of decoding
164 the keymaps or alist-of-alists that specify a menu.
166 It describes the panes and items within the panes.
168 Each pane is described by 3 elements in the vector:
169 t, the pane name, the pane's prefix key.
170 Then follow the pane's items, with 5 elements per item:
171 the item string, the enable flag, the item's value,
172 the definition, and the equivalent keyboard key's description string.
174 In some cases, multiple levels of menus may be described.
175 A single vector slot containing nil indicates the start of a submenu.
176 A single vector slot containing lambda indicates the end of a submenu.
177 The submenu follows a menu item which is the way to reach the submenu.
179 A single vector slot containing quote indicates that the
180 following items should appear on the right of a dialog box.
182 Using a Lisp vector to hold this information while we decode it
183 takes care of protecting all the data from GC. */
185 #define MENU_ITEMS_PANE_NAME 1
186 #define MENU_ITEMS_PANE_PREFIX 2
187 #define MENU_ITEMS_PANE_LENGTH 3
191 MENU_ITEMS_ITEM_NAME
= 0,
192 MENU_ITEMS_ITEM_ENABLE
,
193 MENU_ITEMS_ITEM_VALUE
,
194 MENU_ITEMS_ITEM_EQUIV_KEY
,
195 MENU_ITEMS_ITEM_DEFINITION
,
196 MENU_ITEMS_ITEM_TYPE
,
197 MENU_ITEMS_ITEM_SELECTED
,
198 MENU_ITEMS_ITEM_HELP
,
199 MENU_ITEMS_ITEM_LENGTH
202 static Lisp_Object menu_items
;
204 /* If non-nil, means that the global vars defined here are already in use.
205 Used to detect cases where we try to re-enter this non-reentrant code. */
206 static Lisp_Object menu_items_inuse
;
208 /* Number of slots currently allocated in menu_items. */
209 static int menu_items_allocated
;
211 /* This is the index in menu_items of the first empty slot. */
212 static int menu_items_used
;
214 /* The number of panes currently recorded in menu_items,
215 excluding those within submenus. */
216 static int menu_items_n_panes
;
218 /* Current depth within submenus. */
219 static int menu_items_submenu_depth
;
221 /* Flag which when set indicates a dialog or menu has been posted by
222 Xt on behalf of one of the widget sets. */
223 static int popup_activated_flag
;
225 static int next_menubar_widget_id
;
227 /* This is set nonzero after the user activates the menu bar, and set
228 to zero again after the menu bars are redisplayed by prepare_menu_bar.
229 While it is nonzero, all calls to set_frame_menubar go deep.
231 I don't understand why this is needed, but it does seem to be
232 needed on Motif, according to Marcus Daniels <marcus@sysc.pdx.edu>. */
234 int pending_menu_activation
;
238 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
240 static struct frame
*
241 menubar_id_to_frame (id
)
244 Lisp_Object tail
, frame
;
247 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
250 if (!GC_FRAMEP (frame
))
253 if (!FRAME_WINDOW_P (f
))
255 if (f
->output_data
.x
->id
== id
)
263 /* Initialize the menu_items structure if we haven't already done so.
264 Also mark it as currently empty. */
269 if (!NILP (menu_items_inuse
))
270 error ("Trying to use a menu from within a menu-entry");
272 if (NILP (menu_items
))
274 menu_items_allocated
= 60;
275 menu_items
= Fmake_vector (make_number (menu_items_allocated
), Qnil
);
278 menu_items_inuse
= Qt
;
280 menu_items_n_panes
= 0;
281 menu_items_submenu_depth
= 0;
284 /* Call at the end of generating the data in menu_items. */
292 unuse_menu_items (dummy
)
295 return menu_items_inuse
= Qnil
;
298 /* Call when finished using the data for the current menu
302 discard_menu_items ()
304 /* Free the structure if it is especially large.
305 Otherwise, hold on to it, to save time. */
306 if (menu_items_allocated
> 200)
309 menu_items_allocated
= 0;
311 xassert (NILP (menu_items_inuse
));
314 /* This undoes save_menu_items, and it is called by the specpdl unwind
318 restore_menu_items (saved
)
321 menu_items
= XCAR (saved
);
322 menu_items_inuse
= (! NILP (menu_items
) ? Qt
: Qnil
);
323 menu_items_allocated
= (VECTORP (menu_items
) ? ASIZE (menu_items
) : 0);
324 saved
= XCDR (saved
);
325 menu_items_used
= XINT (XCAR (saved
));
326 saved
= XCDR (saved
);
327 menu_items_n_panes
= XINT (XCAR (saved
));
328 saved
= XCDR (saved
);
329 menu_items_submenu_depth
= XINT (XCAR (saved
));
333 /* Push the whole state of menu_items processing onto the specpdl.
334 It will be restored when the specpdl is unwound. */
339 Lisp_Object saved
= list4 (!NILP (menu_items_inuse
) ? menu_items
: Qnil
,
340 make_number (menu_items_used
),
341 make_number (menu_items_n_panes
),
342 make_number (menu_items_submenu_depth
));
343 record_unwind_protect (restore_menu_items
, saved
);
344 menu_items_inuse
= Qnil
;
348 /* Make the menu_items vector twice as large. */
354 int old_size
= menu_items_allocated
;
357 menu_items_allocated
*= 2;
359 menu_items
= Fmake_vector (make_number (menu_items_allocated
), Qnil
);
360 bcopy (XVECTOR (old
)->contents
, XVECTOR (menu_items
)->contents
,
361 old_size
* sizeof (Lisp_Object
));
364 /* Begin a submenu. */
367 push_submenu_start ()
369 if (menu_items_used
+ 1 > menu_items_allocated
)
372 XVECTOR (menu_items
)->contents
[menu_items_used
++] = Qnil
;
373 menu_items_submenu_depth
++;
381 if (menu_items_used
+ 1 > menu_items_allocated
)
384 XVECTOR (menu_items
)->contents
[menu_items_used
++] = Qlambda
;
385 menu_items_submenu_depth
--;
388 /* Indicate boundary between left and right. */
391 push_left_right_boundary ()
393 if (menu_items_used
+ 1 > menu_items_allocated
)
396 XVECTOR (menu_items
)->contents
[menu_items_used
++] = Qquote
;
399 /* Start a new menu pane in menu_items.
400 NAME is the pane name. PREFIX_VEC is a prefix key for this pane. */
403 push_menu_pane (name
, prefix_vec
)
404 Lisp_Object name
, prefix_vec
;
406 if (menu_items_used
+ MENU_ITEMS_PANE_LENGTH
> menu_items_allocated
)
409 if (menu_items_submenu_depth
== 0)
410 menu_items_n_panes
++;
411 XVECTOR (menu_items
)->contents
[menu_items_used
++] = Qt
;
412 XVECTOR (menu_items
)->contents
[menu_items_used
++] = name
;
413 XVECTOR (menu_items
)->contents
[menu_items_used
++] = prefix_vec
;
416 /* Push one menu item into the current pane. NAME is the string to
417 display. ENABLE if non-nil means this item can be selected. KEY
418 is the key generated by choosing this item, or nil if this item
419 doesn't really have a definition. DEF is the definition of this
420 item. EQUIV is the textual description of the keyboard equivalent
421 for this item (or nil if none). TYPE is the type of this menu
422 item, one of nil, `toggle' or `radio'. */
425 push_menu_item (name
, enable
, key
, def
, equiv
, type
, selected
, help
)
426 Lisp_Object name
, enable
, key
, def
, equiv
, type
, selected
, help
;
428 if (menu_items_used
+ MENU_ITEMS_ITEM_LENGTH
> menu_items_allocated
)
431 XVECTOR (menu_items
)->contents
[menu_items_used
++] = name
;
432 XVECTOR (menu_items
)->contents
[menu_items_used
++] = enable
;
433 XVECTOR (menu_items
)->contents
[menu_items_used
++] = key
;
434 XVECTOR (menu_items
)->contents
[menu_items_used
++] = equiv
;
435 XVECTOR (menu_items
)->contents
[menu_items_used
++] = def
;
436 XVECTOR (menu_items
)->contents
[menu_items_used
++] = type
;
437 XVECTOR (menu_items
)->contents
[menu_items_used
++] = selected
;
438 XVECTOR (menu_items
)->contents
[menu_items_used
++] = help
;
441 /* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
442 and generate menu panes for them in menu_items.
443 If NOTREAL is nonzero,
444 don't bother really computing whether an item is enabled. */
447 keymap_panes (keymaps
, nmaps
, notreal
)
448 Lisp_Object
*keymaps
;
456 /* Loop over the given keymaps, making a pane for each map.
457 But don't make a pane that is empty--ignore that map instead.
458 P is the number of panes we have made so far. */
459 for (mapno
= 0; mapno
< nmaps
; mapno
++)
460 single_keymap_panes (keymaps
[mapno
],
461 Fkeymap_prompt (keymaps
[mapno
]), Qnil
, notreal
, 10);
463 finish_menu_items ();
466 /* Args passed between single_keymap_panes and single_menu_item. */
469 Lisp_Object pending_maps
;
470 int maxdepth
, notreal
;
474 static void single_menu_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
477 /* This is a recursive subroutine of keymap_panes.
478 It handles one keymap, KEYMAP.
479 The other arguments are passed along
480 or point to local variables of the previous function.
481 If NOTREAL is nonzero, only check for equivalent key bindings, don't
482 evaluate expressions in menu items and don't make any menu.
484 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
487 single_keymap_panes (keymap
, pane_name
, prefix
, notreal
, maxdepth
)
489 Lisp_Object pane_name
;
497 skp
.pending_maps
= Qnil
;
498 skp
.maxdepth
= maxdepth
;
499 skp
.notreal
= notreal
;
505 push_menu_pane (pane_name
, prefix
);
508 /* Remember index for first item in this pane so we can go back and
509 add a prefix when (if) we see the first button. After that, notbuttons
510 is set to 0, to mark that we have seen a button and all non button
511 items need a prefix. */
512 skp
.notbuttons
= menu_items_used
;
515 GCPRO1 (skp
.pending_maps
);
516 map_keymap (keymap
, single_menu_item
, Qnil
, &skp
, 1);
519 /* Process now any submenus which want to be panes at this level. */
520 while (CONSP (skp
.pending_maps
))
522 Lisp_Object elt
, eltcdr
, string
;
523 elt
= XCAR (skp
.pending_maps
);
525 string
= XCAR (eltcdr
);
526 /* We no longer discard the @ from the beginning of the string here.
527 Instead, we do this in xmenu_show. */
528 single_keymap_panes (Fcar (elt
), string
,
529 XCDR (eltcdr
), notreal
, maxdepth
- 1);
530 skp
.pending_maps
= XCDR (skp
.pending_maps
);
534 /* This is a subroutine of single_keymap_panes that handles one
536 KEY is a key in a keymap and ITEM is its binding.
537 SKP->PENDING_MAPS_PTR is a list of keymaps waiting to be made into
539 If SKP->NOTREAL is nonzero, only check for equivalent key bindings, don't
540 evaluate expressions in menu items and don't make any menu.
541 If we encounter submenus deeper than SKP->MAXDEPTH levels, ignore them.
542 SKP->NOTBUTTONS is only used when simulating toggle boxes and radio
543 buttons. It keeps track of if we have seen a button in this menu or
547 single_menu_item (key
, item
, dummy
, skp_v
)
548 Lisp_Object key
, item
, dummy
;
551 Lisp_Object map
, item_string
, enabled
;
552 struct gcpro gcpro1
, gcpro2
;
554 struct skp
*skp
= skp_v
;
556 /* Parse the menu item and leave the result in item_properties. */
558 res
= parse_menu_item (item
, skp
->notreal
, 0);
561 return; /* Not a menu item. */
563 map
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_MAP
];
567 /* We don't want to make a menu, just traverse the keymaps to
568 precompute equivalent key bindings. */
570 single_keymap_panes (map
, Qnil
, key
, 1, skp
->maxdepth
- 1);
574 enabled
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_ENABLE
];
575 item_string
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_NAME
];
577 if (!NILP (map
) && SREF (item_string
, 0) == '@')
580 /* An enabled separate pane. Remember this to handle it later. */
581 skp
->pending_maps
= Fcons (Fcons (map
, Fcons (item_string
, key
)),
587 /* Simulate radio buttons and toggle boxes by putting a prefix in
590 Lisp_Object prefix
= Qnil
;
591 Lisp_Object type
= XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
];
595 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
];
598 /* The first button. Line up previous items in this menu. */
600 int index
= skp
->notbuttons
; /* Index for first item this menu. */
603 while (index
< menu_items_used
)
606 = XVECTOR (menu_items
)->contents
[index
+ MENU_ITEMS_ITEM_NAME
];
610 submenu
++; /* Skip sub menu. */
612 else if (EQ (tem
, Qlambda
))
615 submenu
--; /* End sub menu. */
617 else if (EQ (tem
, Qt
))
618 index
+= 3; /* Skip new pane marker. */
619 else if (EQ (tem
, Qquote
))
620 index
++; /* Skip a left, right divider. */
623 if (!submenu
&& SREF (tem
, 0) != '\0'
624 && SREF (tem
, 0) != '-')
625 XVECTOR (menu_items
)->contents
[index
+ MENU_ITEMS_ITEM_NAME
]
626 = concat2 (build_string (" "), tem
);
627 index
+= MENU_ITEMS_ITEM_LENGTH
;
633 /* Calculate prefix, if any, for this item. */
634 if (EQ (type
, QCtoggle
))
635 prefix
= build_string (NILP (selected
) ? "[ ] " : "[X] ");
636 else if (EQ (type
, QCradio
))
637 prefix
= build_string (NILP (selected
) ? "( ) " : "(*) ");
639 /* Not a button. If we have earlier buttons, then we need a prefix. */
640 else if (!skp
->notbuttons
&& SREF (item_string
, 0) != '\0'
641 && SREF (item_string
, 0) != '-')
642 prefix
= build_string (" ");
645 item_string
= concat2 (prefix
, item_string
);
647 #endif /* not HAVE_BOXES */
649 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
651 /* Indicate visually that this is a submenu. */
652 item_string
= concat2 (item_string
, build_string (" >"));
655 push_menu_item (item_string
, enabled
, key
,
656 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_DEF
],
657 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
],
658 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_TYPE
],
659 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_SELECTED
],
660 XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_HELP
]);
662 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
663 /* Display a submenu using the toolkit. */
664 if (! (NILP (map
) || NILP (enabled
)))
666 push_submenu_start ();
667 single_keymap_panes (map
, Qnil
, key
, 0, skp
->maxdepth
- 1);
673 /* Push all the panes and items of a menu described by the
674 alist-of-alists MENU.
675 This handles old-fashioned calls to x-popup-menu. */
685 for (tail
= menu
; CONSP (tail
); tail
= XCDR (tail
))
687 Lisp_Object elt
, pane_name
, pane_data
;
689 pane_name
= Fcar (elt
);
690 CHECK_STRING (pane_name
);
691 push_menu_pane (ENCODE_MENU_STRING (pane_name
), Qnil
);
692 pane_data
= Fcdr (elt
);
693 CHECK_CONS (pane_data
);
694 list_of_items (pane_data
);
697 finish_menu_items ();
700 /* Push the items in a single pane defined by the alist PANE. */
706 Lisp_Object tail
, item
, item1
;
708 for (tail
= pane
; CONSP (tail
); tail
= XCDR (tail
))
712 push_menu_item (ENCODE_MENU_STRING (item
), Qnil
, Qnil
, Qt
,
713 Qnil
, Qnil
, Qnil
, Qnil
);
714 else if (CONSP (item
))
717 CHECK_STRING (item1
);
718 push_menu_item (ENCODE_MENU_STRING (item1
), Qt
, XCDR (item
),
719 Qt
, Qnil
, Qnil
, Qnil
, Qnil
);
722 push_left_right_boundary ();
727 #ifdef HAVE_X_WINDOWS
728 /* Return the mouse position in *X and *Y. The coordinates are window
729 relative for the edit window in frame F.
730 This is for Fx_popup_menu. The mouse_position_hook can not
731 be used for X, as it returns window relative coordinates
732 for the window where the mouse is in. This could be the menu bar,
733 the scroll bar or the edit window. Fx_popup_menu needs to be
734 sure it is the edit window. */
736 mouse_position_for_popup (f
, x
, y
)
741 Window root
, dummy_window
;
746 XQueryPointer (FRAME_X_DISPLAY (f
),
747 DefaultRootWindow (FRAME_X_DISPLAY (f
)),
749 /* The root window which contains the pointer. */
752 /* Window pointer is on, not used */
755 /* The position on that root window. */
758 /* x/y in dummy_window coordinates, not used. */
761 /* Modifier keys and pointer buttons, about which
763 (unsigned int *) &dummy
);
767 /* xmenu_show expects window coordinates, not root window
768 coordinates. Translate. */
769 *x
-= f
->left_pos
+ FRAME_OUTER_TO_INNER_DIFF_X (f
);
770 *y
-= f
->top_pos
+ FRAME_OUTER_TO_INNER_DIFF_Y (f
);
773 #endif /* HAVE_X_WINDOWS */
775 DEFUN ("x-popup-menu", Fx_popup_menu
, Sx_popup_menu
, 2, 2, 0,
776 doc
: /* Pop up a deck-of-cards menu and return user's selection.
777 POSITION is a position specification. This is either a mouse button event
778 or a list ((XOFFSET YOFFSET) WINDOW)
779 where XOFFSET and YOFFSET are positions in pixels from the top left
780 corner of WINDOW. (WINDOW may be a window or a frame object.)
781 This controls the position of the top left of the menu as a whole.
782 If POSITION is t, it means to use the current mouse position.
784 MENU is a specifier for a menu. For the simplest case, MENU is a keymap.
785 The menu items come from key bindings that have a menu string as well as
786 a definition; actually, the "definition" in such a key binding looks like
787 \(STRING . REAL-DEFINITION). To give the menu a title, put a string into
788 the keymap as a top-level element.
790 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
791 Otherwise, REAL-DEFINITION should be a valid key binding definition.
793 You can also use a list of keymaps as MENU.
794 Then each keymap makes a separate pane.
796 When MENU is a keymap or a list of keymaps, the return value is the
797 list of events corresponding to the user's choice. Note that
798 `x-popup-menu' does not actually execute the command bound to that
801 Alternatively, you can specify a menu of multiple panes
802 with a list of the form (TITLE PANE1 PANE2...),
803 where each pane is a list of form (TITLE ITEM1 ITEM2...).
804 Each ITEM is normally a cons cell (STRING . VALUE);
805 but a string can appear as an item--that makes a nonselectable line
807 With this form of menu, the return value is VALUE from the chosen item.
809 If POSITION is nil, don't display the menu at all, just precalculate the
810 cached information about equivalent key sequences.
812 If the user gets rid of the menu without making a valid choice, for
813 instance by clicking the mouse away from a valid choice or by typing
814 keyboard input, then this normally results in a quit and
815 `x-popup-menu' does not return. But if POSITION is a mouse button
816 event (indicating that the user invoked the menu with the mouse) then
817 no quit occurs and `x-popup-menu' returns nil. */)
819 Lisp_Object position
, menu
;
821 Lisp_Object keymap
, tem
;
822 int xpos
= 0, ypos
= 0;
824 char *error_name
= NULL
;
825 Lisp_Object selection
;
827 Lisp_Object x
, y
, window
;
830 int specpdl_count
= SPECPDL_INDEX ();
834 if (! NILP (position
))
836 int get_current_pos_p
= 0;
839 /* Decode the first argument: find the window and the coordinates. */
840 if (EQ (position
, Qt
)
841 || (CONSP (position
) && (EQ (XCAR (position
), Qmenu_bar
)
842 || EQ (XCAR (position
), Qtool_bar
))))
844 get_current_pos_p
= 1;
848 tem
= Fcar (position
);
851 window
= Fcar (Fcdr (position
));
853 y
= Fcar (XCDR (tem
));
858 tem
= Fcar (Fcdr (position
)); /* EVENT_START (position) */
859 window
= Fcar (tem
); /* POSN_WINDOW (tem) */
860 tem
= Fcar (Fcdr (Fcdr (tem
))); /* POSN_WINDOW_POSN (tem) */
865 /* If a click happens in an external tool bar or a detached
866 tool bar, x and y is NIL. In that case, use the current
867 mouse position. This happens for the help button in the
868 tool bar. Ideally popup-menu should pass NIL to
869 this function, but it doesn't. */
870 if (NILP (x
) && NILP (y
))
871 get_current_pos_p
= 1;
874 if (get_current_pos_p
)
876 /* Use the mouse's current position. */
877 FRAME_PTR new_f
= SELECTED_FRAME ();
878 #ifdef HAVE_X_WINDOWS
879 /* Can't use mouse_position_hook for X since it returns
880 coordinates relative to the window the mouse is in,
881 we need coordinates relative to the edit widget always. */
886 mouse_position_for_popup (new_f
, &cur_x
, &cur_y
);
887 /* cur_x/y may be negative, so use make_number. */
888 x
= make_number (cur_x
);
889 y
= make_number (cur_y
);
892 #else /* not HAVE_X_WINDOWS */
893 Lisp_Object bar_window
;
894 enum scroll_bar_part part
;
897 if (mouse_position_hook
)
898 (*mouse_position_hook
) (&new_f
, 1, &bar_window
,
899 &part
, &x
, &y
, &time
);
900 #endif /* not HAVE_X_WINDOWS */
903 XSETFRAME (window
, new_f
);
906 window
= selected_window
;
915 /* Decode where to put the menu. */
923 else if (WINDOWP (window
))
925 CHECK_LIVE_WINDOW (window
);
926 f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
928 xpos
= WINDOW_LEFT_EDGE_X (XWINDOW (window
));
929 ypos
= WINDOW_TOP_EDGE_Y (XWINDOW (window
));
932 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
933 but I don't want to make one now. */
934 CHECK_WINDOW (window
);
939 XSETFRAME (Vmenu_updating_frame
, f
);
942 Vmenu_updating_frame
= Qnil
;
943 #endif /* HAVE_MENUS */
945 record_unwind_protect (unuse_menu_items
, Qnil
);
949 /* Decode the menu items from what was specified. */
951 keymap
= get_keymap (menu
, 0, 0);
954 /* We were given a keymap. Extract menu info from the keymap. */
957 /* Extract the detailed info to make one pane. */
958 keymap_panes (&menu
, 1, NILP (position
));
960 /* Search for a string appearing directly as an element of the keymap.
961 That string is the title of the menu. */
962 prompt
= Fkeymap_prompt (keymap
);
963 if (NILP (title
) && !NILP (prompt
))
966 /* Make that be the pane title of the first pane. */
967 if (!NILP (prompt
) && menu_items_n_panes
>= 0)
968 XVECTOR (menu_items
)->contents
[MENU_ITEMS_PANE_NAME
] = prompt
;
972 else if (CONSP (menu
) && KEYMAPP (XCAR (menu
)))
974 /* We were given a list of keymaps. */
975 int nmaps
= XFASTINT (Flength (menu
));
977 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
982 /* The first keymap that has a prompt string
983 supplies the menu title. */
984 for (tem
= menu
, i
= 0; CONSP (tem
); tem
= XCDR (tem
))
988 maps
[i
++] = keymap
= get_keymap (XCAR (tem
), 1, 0);
990 prompt
= Fkeymap_prompt (keymap
);
991 if (NILP (title
) && !NILP (prompt
))
995 /* Extract the detailed info to make one pane. */
996 keymap_panes (maps
, nmaps
, NILP (position
));
998 /* Make the title be the pane title of the first pane. */
999 if (!NILP (title
) && menu_items_n_panes
>= 0)
1000 XVECTOR (menu_items
)->contents
[MENU_ITEMS_PANE_NAME
] = title
;
1006 /* We were given an old-fashioned menu. */
1007 title
= Fcar (menu
);
1008 CHECK_STRING (title
);
1010 list_of_panes (Fcdr (menu
));
1015 unbind_to (specpdl_count
, Qnil
);
1017 if (NILP (position
))
1019 discard_menu_items ();
1025 /* Display them in a menu. */
1028 selection
= xmenu_show (f
, xpos
, ypos
, for_click
,
1029 keymaps
, title
, &error_name
);
1032 discard_menu_items ();
1035 #endif /* HAVE_MENUS */
1037 if (error_name
) error (error_name
);
1043 DEFUN ("x-popup-dialog", Fx_popup_dialog
, Sx_popup_dialog
, 2, 3, 0,
1044 doc
: /* Pop up a dialog box and return user's selection.
1045 POSITION specifies which frame to use.
1046 This is normally a mouse button event or a window or frame.
1047 If POSITION is t, it means to use the frame the mouse is on.
1048 The dialog box appears in the middle of the specified frame.
1050 CONTENTS specifies the alternatives to display in the dialog box.
1051 It is a list of the form (DIALOG ITEM1 ITEM2...).
1052 Each ITEM is a cons cell (STRING . VALUE).
1053 The return value is VALUE from the chosen item.
1055 An ITEM may also be just a string--that makes a nonselectable item.
1056 An ITEM may also be nil--that means to put all preceding items
1057 on the left of the dialog box and all following items on the right.
1058 \(By default, approximately half appear on each side.)
1060 If HEADER is non-nil, the frame title for the box is "Information",
1061 otherwise it is "Question".
1063 If the user gets rid of the dialog box without making a valid choice,
1064 for instance using the window manager, then this produces a quit and
1065 `x-popup-dialog' does not return. */)
1066 (position
, contents
, header
)
1067 Lisp_Object position
, contents
, header
;
1074 /* Decode the first argument: find the window or frame to use. */
1075 if (EQ (position
, Qt
)
1076 || (CONSP (position
) && (EQ (XCAR (position
), Qmenu_bar
)
1077 || EQ (XCAR (position
), Qtool_bar
))))
1079 #if 0 /* Using the frame the mouse is on may not be right. */
1080 /* Use the mouse's current position. */
1081 FRAME_PTR new_f
= SELECTED_FRAME ();
1082 Lisp_Object bar_window
;
1083 enum scroll_bar_part part
;
1087 (*mouse_position_hook
) (&new_f
, 1, &bar_window
, &part
, &x
, &y
, &time
);
1090 XSETFRAME (window
, new_f
);
1092 window
= selected_window
;
1094 window
= selected_window
;
1096 else if (CONSP (position
))
1099 tem
= Fcar (position
);
1101 window
= Fcar (Fcdr (position
));
1104 tem
= Fcar (Fcdr (position
)); /* EVENT_START (position) */
1105 window
= Fcar (tem
); /* POSN_WINDOW (tem) */
1108 else if (WINDOWP (position
) || FRAMEP (position
))
1113 /* Decode where to put the menu. */
1115 if (FRAMEP (window
))
1116 f
= XFRAME (window
);
1117 else if (WINDOWP (window
))
1119 CHECK_LIVE_WINDOW (window
);
1120 f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1123 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
1124 but I don't want to make one now. */
1125 CHECK_WINDOW (window
);
1127 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
1128 /* Display a menu with these alternatives
1129 in the middle of frame F. */
1131 Lisp_Object x
, y
, frame
, newpos
;
1132 XSETFRAME (frame
, f
);
1133 XSETINT (x
, x_pixel_width (f
) / 2);
1134 XSETINT (y
, x_pixel_height (f
) / 2);
1135 newpos
= Fcons (Fcons (x
, Fcons (y
, Qnil
)), Fcons (frame
, Qnil
));
1137 return Fx_popup_menu (newpos
,
1138 Fcons (Fcar (contents
), Fcons (contents
, Qnil
)));
1144 Lisp_Object selection
;
1145 int specpdl_count
= SPECPDL_INDEX ();
1147 /* Decode the dialog items from what was specified. */
1148 title
= Fcar (contents
);
1149 CHECK_STRING (title
);
1150 record_unwind_protect (unuse_menu_items
, Qnil
);
1152 if (NILP (Fcar (Fcdr (contents
))))
1153 /* No buttons specified, add an "Ok" button so users can pop down
1154 the dialog. Also, the lesstif/motif version crashes if there are
1156 contents
= Fcons (title
, Fcons (Fcons (build_string ("Ok"), Qt
), Qnil
));
1158 list_of_panes (Fcons (contents
, Qnil
));
1160 /* Display them in a dialog box. */
1162 selection
= xdialog_show (f
, 0, title
, header
, &error_name
);
1165 unbind_to (specpdl_count
, Qnil
);
1166 discard_menu_items ();
1168 if (error_name
) error (error_name
);
1177 /* Set menu_items_inuse so no other popup menu or dialog is created. */
1180 x_menu_set_in_use (in_use
)
1183 menu_items_inuse
= in_use
? Qt
: Qnil
;
1184 popup_activated_flag
= in_use
;
1185 #ifdef USE_X_TOOLKIT
1186 if (popup_activated_flag
)
1187 x_activate_timeout_atimer ();
1191 /* Wait for an X event to arrive or for a timer to expire. */
1194 x_menu_wait_for_event (void *data
)
1196 extern EMACS_TIME timer_check
P_ ((int));
1198 /* Another way to do this is to register a timer callback, that can be
1199 done in GTK and Xt. But we have to do it like this when using only X
1200 anyway, and with callbacks we would have three variants for timer handling
1201 instead of the small ifdefs below. */
1204 #ifdef USE_X_TOOLKIT
1205 ! XtAppPending (Xt_app_con
)
1206 #elif defined USE_GTK
1207 ! gtk_events_pending ()
1209 ! XPending ((Display
*) data
)
1213 EMACS_TIME next_time
= timer_check (1);
1214 long secs
= EMACS_SECS (next_time
);
1215 long usecs
= EMACS_USECS (next_time
);
1216 SELECT_TYPE read_fds
;
1217 struct x_display_info
*dpyinfo
;
1220 FD_ZERO (&read_fds
);
1221 for (dpyinfo
= x_display_list
; dpyinfo
; dpyinfo
= dpyinfo
->next
)
1223 int fd
= ConnectionNumber (dpyinfo
->display
);
1224 FD_SET (fd
, &read_fds
);
1228 if (secs
< 0 || (secs
== 0 && usecs
== 0))
1230 /* Sometimes timer_check returns -1 (no timers) even if there are
1231 timers. So do a timeout anyway. */
1232 EMACS_SET_SECS (next_time
, 1);
1233 EMACS_SET_USECS (next_time
, 0);
1236 select (n
+ 1, &read_fds
, (SELECT_TYPE
*)0, (SELECT_TYPE
*)0, &next_time
);
1239 #endif /* ! MSDOS */
1242 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1244 #ifdef USE_X_TOOLKIT
1246 /* Loop in Xt until the menu pulldown or dialog popup has been
1247 popped down (deactivated). This is used for x-popup-menu
1248 and x-popup-dialog; it is not used for the menu bar.
1250 NOTE: All calls to popup_get_selection should be protected
1251 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
1254 popup_get_selection (initial_event
, dpyinfo
, id
, do_timers
)
1255 XEvent
*initial_event
;
1256 struct x_display_info
*dpyinfo
;
1262 while (popup_activated_flag
)
1266 event
= *initial_event
;
1271 if (do_timers
) x_menu_wait_for_event (0);
1272 XtAppNextEvent (Xt_app_con
, &event
);
1275 /* Make sure we don't consider buttons grabbed after menu goes.
1276 And make sure to deactivate for any ButtonRelease,
1277 even if XtDispatchEvent doesn't do that. */
1278 if (event
.type
== ButtonRelease
1279 && dpyinfo
->display
== event
.xbutton
.display
)
1281 dpyinfo
->grabbed
&= ~(1 << event
.xbutton
.button
);
1282 #ifdef USE_MOTIF /* Pretending that the event came from a
1283 Btn1Down seems the only way to convince Motif to
1284 activate its callbacks; setting the XmNmenuPost
1285 isn't working. --marcus@sysc.pdx.edu. */
1286 event
.xbutton
.button
= 1;
1287 /* Motif only pops down menus when no Ctrl, Alt or Mod
1288 key is pressed and the button is released. So reset key state
1289 so Motif thinks this is the case. */
1290 event
.xbutton
.state
= 0;
1293 /* Pop down on C-g and Escape. */
1294 else if (event
.type
== KeyPress
1295 && dpyinfo
->display
== event
.xbutton
.display
)
1297 KeySym keysym
= XLookupKeysym (&event
.xkey
, 0);
1299 if ((keysym
== XK_g
&& (event
.xkey
.state
& ControlMask
) != 0)
1300 || keysym
== XK_Escape
) /* Any escape, ignore modifiers. */
1301 popup_activated_flag
= 0;
1304 x_dispatch_event (&event
, event
.xany
.display
);
1308 DEFUN ("menu-bar-open", Fmenu_bar_open
, Smenu_bar_open
, 0, 1, "i",
1309 doc
: /* Start key navigation of the menu bar in FRAME.
1310 This initially opens the first menu bar item and you can then navigate with the
1311 arrow keys, select a menu entry with the return key or cancel with the
1312 escape key. If FRAME has no menu bar this function does nothing.
1314 If FRAME is nil or not given, use the selected frame. */)
1319 FRAME_PTR f
= check_x_frame (frame
);
1323 if (FRAME_EXTERNAL_MENU_BAR (f
))
1324 set_frame_menubar (f
, 0, 1);
1326 menubar
= FRAME_X_OUTPUT (f
)->menubar_widget
;
1332 x_catch_errors (FRAME_X_DISPLAY (f
));
1333 memset (&ev
, 0, sizeof ev
);
1334 ev
.xbutton
.display
= FRAME_X_DISPLAY (f
);
1335 ev
.xbutton
.window
= XtWindow (menubar
);
1336 ev
.xbutton
.root
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
1337 ev
.xbutton
.time
= XtLastTimestampProcessed (FRAME_X_DISPLAY (f
));
1338 ev
.xbutton
.button
= Button1
;
1339 ev
.xbutton
.x
= ev
.xbutton
.y
= FRAME_MENUBAR_HEIGHT (f
) / 2;
1340 ev
.xbutton
.same_screen
= True
;
1347 XtSetArg (al
[0], XtNchildren
, &list
);
1348 XtSetArg (al
[1], XtNnumChildren
, &nr
);
1349 XtGetValues (menubar
, al
, 2);
1350 ev
.xbutton
.window
= XtWindow (list
[0]);
1354 XTranslateCoordinates (FRAME_X_DISPLAY (f
),
1355 /* From-window, to-window. */
1356 ev
.xbutton
.window
, ev
.xbutton
.root
,
1358 /* From-position, to-position. */
1359 ev
.xbutton
.x
, ev
.xbutton
.y
,
1360 &ev
.xbutton
.x_root
, &ev
.xbutton
.y_root
,
1364 error_p
= x_had_errors_p (FRAME_X_DISPLAY (f
));
1365 x_uncatch_errors ();
1369 ev
.type
= ButtonPress
;
1370 ev
.xbutton
.state
= 0;
1372 XtDispatchEvent (&ev
);
1373 ev
.xbutton
.type
= ButtonRelease
;
1374 ev
.xbutton
.state
= Button1Mask
;
1375 XtDispatchEvent (&ev
);
1383 #endif /* USE_X_TOOLKIT */
1387 DEFUN ("menu-bar-open", Fmenu_bar_open
, Smenu_bar_open
, 0, 1, "i",
1388 doc
: /* Start key navigation of the menu bar in FRAME.
1389 This initially opens the first menu bar item and you can then navigate with the
1390 arrow keys, select a menu entry with the return key or cancel with the
1391 escape key. If FRAME has no menu bar this function does nothing.
1393 If FRAME is nil or not given, use the selected frame. */)
1400 /* gcc 2.95 doesn't accept the FRAME_PTR declaration after
1404 f
= check_x_frame (frame
);
1406 if (FRAME_EXTERNAL_MENU_BAR (f
))
1407 set_frame_menubar (f
, 0, 1);
1409 menubar
= FRAME_X_OUTPUT (f
)->menubar_widget
;
1412 /* Activate the first menu. */
1413 GList
*children
= gtk_container_get_children (GTK_CONTAINER (menubar
));
1415 gtk_menu_shell_select_item (GTK_MENU_SHELL (menubar
),
1416 GTK_WIDGET (children
->data
));
1418 popup_activated_flag
= 1;
1419 g_list_free (children
);
1426 /* Loop util popup_activated_flag is set to zero in a callback.
1427 Used for popup menus and dialogs. */
1430 popup_widget_loop (do_timers
, widget
)
1434 ++popup_activated_flag
;
1436 /* Process events in the Gtk event loop until done. */
1437 while (popup_activated_flag
)
1439 if (do_timers
) x_menu_wait_for_event (0);
1440 gtk_main_iteration ();
1445 /* Activate the menu bar of frame F.
1446 This is called from keyboard.c when it gets the
1447 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
1449 To activate the menu bar, we use the X button-press event
1450 that was saved in saved_menu_event.
1451 That makes the toolkit do its thing.
1453 But first we recompute the menu bar contents (the whole tree).
1455 The reason for saving the button event until here, instead of
1456 passing it to the toolkit right away, is that we can safely
1457 execute Lisp code. */
1460 x_activate_menubar (f
)
1463 if (!f
->output_data
.x
->saved_menu_event
->type
)
1467 if (! xg_win_to_widget (FRAME_X_DISPLAY (f
),
1468 f
->output_data
.x
->saved_menu_event
->xany
.window
))
1472 set_frame_menubar (f
, 0, 1);
1475 XPutBackEvent (f
->output_data
.x
->display_info
->display
,
1476 f
->output_data
.x
->saved_menu_event
);
1477 popup_activated_flag
= 1;
1479 XtDispatchEvent (f
->output_data
.x
->saved_menu_event
);
1483 if (f
->output_data
.x
->saved_menu_event
->type
== ButtonRelease
)
1484 pending_menu_activation
= 1;
1487 /* Ignore this if we get it a second time. */
1488 f
->output_data
.x
->saved_menu_event
->type
= 0;
1491 /* Detect if a dialog or menu has been posted. */
1496 return popup_activated_flag
;
1499 /* The following is used by delayed window autoselection. */
1501 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p
, Smenu_or_popup_active_p
, 0, 0, 0,
1502 doc
: /* Return t if a menu or popup dialog is active. */)
1505 return (popup_activated ()) ? Qt
: Qnil
;
1508 /* This callback is invoked when the user selects a menubar cascade
1509 pushbutton, but before the pulldown menu is posted. */
1513 popup_activate_callback (widget
, id
, client_data
)
1516 XtPointer client_data
;
1518 popup_activated_flag
= 1;
1519 #ifdef USE_X_TOOLKIT
1520 x_activate_timeout_atimer ();
1525 /* This callback is invoked when a dialog or menu is finished being
1526 used and has been unposted. */
1530 popup_deactivate_callback (widget
, client_data
)
1532 gpointer client_data
;
1534 popup_activated_flag
= 0;
1538 popup_deactivate_callback (widget
, id
, client_data
)
1541 XtPointer client_data
;
1543 popup_activated_flag
= 0;
1548 /* Function that finds the frame for WIDGET and shows the HELP text
1550 F is the frame if known, or NULL if not known. */
1552 show_help_event (f
, widget
, help
)
1554 xt_or_gtk_widget widget
;
1561 XSETFRAME (frame
, f
);
1562 kbd_buffer_store_help_event (frame
, help
);
1566 #if 0 /* This code doesn't do anything useful. ++kfs */
1567 /* WIDGET is the popup menu. It's parent is the frame's
1568 widget. See which frame that is. */
1569 xt_or_gtk_widget frame_widget
= XtParent (widget
);
1572 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
1574 frame
= XCAR (tail
);
1575 if (GC_FRAMEP (frame
)
1576 && (f
= XFRAME (frame
),
1577 FRAME_X_P (f
) && f
->output_data
.x
->widget
== frame_widget
))
1581 show_help_echo (help
, Qnil
, Qnil
, Qnil
, 1);
1585 /* Callback called when menu items are highlighted/unhighlighted
1586 while moving the mouse over them. WIDGET is the menu bar or menu
1587 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
1588 the data structure for the menu item, or null in case of
1593 menu_highlight_callback (widget
, call_data
)
1597 xg_menu_item_cb_data
*cb_data
;
1600 cb_data
= (xg_menu_item_cb_data
*) g_object_get_data (G_OBJECT (widget
),
1602 if (! cb_data
) return;
1604 help
= call_data
? cb_data
->help
: Qnil
;
1606 /* If popup_activated_flag is greater than 1 we are in a popup menu.
1607 Don't show help for them, they won't appear before the
1608 popup is popped down. */
1609 if (popup_activated_flag
<= 1)
1610 show_help_event (cb_data
->cl_data
->f
, widget
, help
);
1614 menu_highlight_callback (widget
, id
, call_data
)
1622 widget_value
*wv
= (widget_value
*) call_data
;
1624 help
= wv
? wv
->help
: Qnil
;
1626 /* Determine the frame for the help event. */
1627 f
= menubar_id_to_frame (id
);
1629 show_help_event (f
, widget
, help
);
1633 /* Find the menu selection and store it in the keyboard buffer.
1634 F is the frame the menu is on.
1635 MENU_BAR_ITEMS_USED is the length of VECTOR.
1636 VECTOR is an array of menu events for the whole menu. */
1639 find_and_call_menu_selection (f
, menu_bar_items_used
, vector
, client_data
)
1641 int menu_bar_items_used
;
1645 Lisp_Object prefix
, entry
;
1646 Lisp_Object
*subprefix_stack
;
1647 int submenu_depth
= 0;
1651 subprefix_stack
= (Lisp_Object
*) alloca (menu_bar_items_used
* sizeof (Lisp_Object
));
1655 while (i
< menu_bar_items_used
)
1657 if (EQ (XVECTOR (vector
)->contents
[i
], Qnil
))
1659 subprefix_stack
[submenu_depth
++] = prefix
;
1663 else if (EQ (XVECTOR (vector
)->contents
[i
], Qlambda
))
1665 prefix
= subprefix_stack
[--submenu_depth
];
1668 else if (EQ (XVECTOR (vector
)->contents
[i
], Qt
))
1670 prefix
= XVECTOR (vector
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
1671 i
+= MENU_ITEMS_PANE_LENGTH
;
1675 entry
= XVECTOR (vector
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
1676 /* The EMACS_INT cast avoids a warning. There's no problem
1677 as long as pointers have enough bits to hold small integers. */
1678 if ((int) (EMACS_INT
) client_data
== i
)
1681 struct input_event buf
;
1685 XSETFRAME (frame
, f
);
1686 buf
.kind
= MENU_BAR_EVENT
;
1687 buf
.frame_or_window
= frame
;
1689 kbd_buffer_store_event (&buf
);
1691 for (j
= 0; j
< submenu_depth
; j
++)
1692 if (!NILP (subprefix_stack
[j
]))
1694 buf
.kind
= MENU_BAR_EVENT
;
1695 buf
.frame_or_window
= frame
;
1696 buf
.arg
= subprefix_stack
[j
];
1697 kbd_buffer_store_event (&buf
);
1702 buf
.kind
= MENU_BAR_EVENT
;
1703 buf
.frame_or_window
= frame
;
1705 kbd_buffer_store_event (&buf
);
1708 buf
.kind
= MENU_BAR_EVENT
;
1709 buf
.frame_or_window
= frame
;
1711 kbd_buffer_store_event (&buf
);
1715 i
+= MENU_ITEMS_ITEM_LENGTH
;
1722 /* Gtk calls callbacks just because we tell it what item should be
1723 selected in a radio group. If this variable is set to a non-zero
1724 value, we are creating menus and don't want callbacks right now.
1726 static int xg_crazy_callback_abort
;
1728 /* This callback is called from the menu bar pulldown menu
1729 when the user makes a selection.
1730 Figure out what the user chose
1731 and put the appropriate events into the keyboard buffer. */
1733 menubar_selection_callback (widget
, client_data
)
1735 gpointer client_data
;
1737 xg_menu_item_cb_data
*cb_data
= (xg_menu_item_cb_data
*) client_data
;
1739 if (xg_crazy_callback_abort
)
1742 if (! cb_data
|| ! cb_data
->cl_data
|| ! cb_data
->cl_data
->f
)
1745 /* For a group of radio buttons, GTK calls the selection callback first
1746 for the item that was active before the selection and then for the one that
1747 is active after the selection. For C-h k this means we get the help on
1748 the deselected item and then the selected item is executed. Prevent that
1749 by ignoring the non-active item. */
1750 if (GTK_IS_RADIO_MENU_ITEM (widget
)
1751 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget
)))
1754 /* When a menu is popped down, X generates a focus event (i.e. focus
1755 goes back to the frame below the menu). Since GTK buffers events,
1756 we force it out here before the menu selection event. Otherwise
1757 sit-for will exit at once if the focus event follows the menu selection
1761 while (gtk_events_pending ())
1762 gtk_main_iteration ();
1765 find_and_call_menu_selection (cb_data
->cl_data
->f
,
1766 cb_data
->cl_data
->menu_bar_items_used
,
1767 cb_data
->cl_data
->menu_bar_vector
,
1768 cb_data
->call_data
);
1771 #else /* not USE_GTK */
1773 /* This callback is called from the menu bar pulldown menu
1774 when the user makes a selection.
1775 Figure out what the user chose
1776 and put the appropriate events into the keyboard buffer. */
1778 menubar_selection_callback (widget
, id
, client_data
)
1781 XtPointer client_data
;
1785 f
= menubar_id_to_frame (id
);
1788 find_and_call_menu_selection (f
, f
->menu_bar_items_used
,
1789 f
->menu_bar_vector
, client_data
);
1791 #endif /* not USE_GTK */
1793 /* Allocate a widget_value, blocking input. */
1796 xmalloc_widget_value ()
1798 widget_value
*value
;
1801 value
= malloc_widget_value ();
1807 /* This recursively calls free_widget_value on the tree of widgets.
1808 It must free all data that was malloc'ed for these widget_values.
1809 In Emacs, many slots are pointers into the data of Lisp_Strings, and
1810 must be left alone. */
1813 free_menubar_widget_value_tree (wv
)
1818 wv
->name
= wv
->value
= wv
->key
= (char *) 0xDEADBEEF;
1820 if (wv
->contents
&& (wv
->contents
!= (widget_value
*)1))
1822 free_menubar_widget_value_tree (wv
->contents
);
1823 wv
->contents
= (widget_value
*) 0xDEADBEEF;
1827 free_menubar_widget_value_tree (wv
->next
);
1828 wv
->next
= (widget_value
*) 0xDEADBEEF;
1831 free_widget_value (wv
);
1835 /* Set up data in menu_items for a menu bar item
1836 whose event type is ITEM_KEY (with string ITEM_NAME)
1837 and whose contents come from the list of keymaps MAPS. */
1840 parse_single_submenu (item_key
, item_name
, maps
)
1841 Lisp_Object item_key
, item_name
, maps
;
1845 Lisp_Object
*mapvec
;
1847 int top_level_items
= 0;
1849 length
= Flength (maps
);
1850 len
= XINT (length
);
1852 /* Convert the list MAPS into a vector MAPVEC. */
1853 mapvec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
1854 for (i
= 0; i
< len
; i
++)
1856 mapvec
[i
] = Fcar (maps
);
1860 /* Loop over the given keymaps, making a pane for each map.
1861 But don't make a pane that is empty--ignore that map instead. */
1862 for (i
= 0; i
< len
; i
++)
1864 if (!KEYMAPP (mapvec
[i
]))
1866 /* Here we have a command at top level in the menu bar
1867 as opposed to a submenu. */
1868 top_level_items
= 1;
1869 push_menu_pane (Qnil
, Qnil
);
1870 push_menu_item (item_name
, Qt
, item_key
, mapvec
[i
],
1871 Qnil
, Qnil
, Qnil
, Qnil
);
1876 prompt
= Fkeymap_prompt (mapvec
[i
]);
1877 single_keymap_panes (mapvec
[i
],
1878 !NILP (prompt
) ? prompt
: item_name
,
1883 return top_level_items
;
1886 /* Create a tree of widget_value objects
1887 representing the panes and items
1888 in menu_items starting at index START, up to index END. */
1890 static widget_value
*
1891 digest_single_submenu (start
, end
, top_level_items
)
1892 int start
, end
, top_level_items
;
1894 widget_value
*wv
, *prev_wv
, *save_wv
, *first_wv
;
1896 int submenu_depth
= 0;
1897 widget_value
**submenu_stack
;
1901 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
1902 wv
= xmalloc_widget_value ();
1906 wv
->button_type
= BUTTON_TYPE_NONE
;
1912 /* Loop over all panes and items made by the preceding call
1913 to parse_single_submenu and construct a tree of widget_value objects.
1914 Ignore the panes and items used by previous calls to
1915 digest_single_submenu, even though those are also in menu_items. */
1919 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qnil
))
1921 submenu_stack
[submenu_depth
++] = save_wv
;
1926 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qlambda
))
1929 save_wv
= submenu_stack
[--submenu_depth
];
1932 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
)
1933 && submenu_depth
!= 0)
1934 i
+= MENU_ITEMS_PANE_LENGTH
;
1935 /* Ignore a nil in the item list.
1936 It's meaningful only for dialog boxes. */
1937 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
1939 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
1941 /* Create a new pane. */
1942 Lisp_Object pane_name
, prefix
;
1947 pane_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_NAME
];
1948 prefix
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
1950 #ifndef HAVE_MULTILINGUAL_MENU
1951 if (STRINGP (pane_name
) && STRING_MULTIBYTE (pane_name
))
1953 pane_name
= ENCODE_MENU_STRING (pane_name
);
1954 AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
) = pane_name
;
1957 pane_string
= (NILP (pane_name
)
1958 ? "" : (char *) SDATA (pane_name
));
1959 /* If there is just one top-level pane, put all its items directly
1960 under the top-level menu. */
1961 if (menu_items_n_panes
== 1)
1964 /* If the pane has a meaningful name,
1965 make the pane a top-level menu item
1966 with its items as a submenu beneath it. */
1967 if (strcmp (pane_string
, ""))
1969 wv
= xmalloc_widget_value ();
1973 first_wv
->contents
= wv
;
1974 wv
->lname
= pane_name
;
1975 /* Set value to 1 so update_submenu_strings can handle '@' */
1976 wv
->value
= (char *)1;
1978 wv
->button_type
= BUTTON_TYPE_NONE
;
1986 i
+= MENU_ITEMS_PANE_LENGTH
;
1990 /* Create a new item within current pane. */
1991 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
;
1994 /* All items should be contained in panes. */
1995 if (panes_seen
== 0)
1998 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
1999 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
2000 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
2001 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
2002 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
2003 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
2004 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
2006 #ifndef HAVE_MULTILINGUAL_MENU
2007 if (STRING_MULTIBYTE (item_name
))
2009 item_name
= ENCODE_MENU_STRING (item_name
);
2010 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
) = item_name
;
2013 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
2015 descrip
= ENCODE_MENU_STRING (descrip
);
2016 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
) = descrip
;
2018 #endif /* not HAVE_MULTILINGUAL_MENU */
2020 wv
= xmalloc_widget_value ();
2024 save_wv
->contents
= wv
;
2026 wv
->lname
= item_name
;
2027 if (!NILP (descrip
))
2030 /* The EMACS_INT cast avoids a warning. There's no problem
2031 as long as pointers have enough bits to hold small integers. */
2032 wv
->call_data
= (!NILP (def
) ? (void *) (EMACS_INT
) i
: 0);
2033 wv
->enabled
= !NILP (enable
);
2036 wv
->button_type
= BUTTON_TYPE_NONE
;
2037 else if (EQ (type
, QCradio
))
2038 wv
->button_type
= BUTTON_TYPE_RADIO
;
2039 else if (EQ (type
, QCtoggle
))
2040 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
2044 wv
->selected
= !NILP (selected
);
2045 if (! STRINGP (help
))
2052 i
+= MENU_ITEMS_ITEM_LENGTH
;
2056 /* If we have just one "menu item"
2057 that was originally a button, return it by itself. */
2058 if (top_level_items
&& first_wv
->contents
&& first_wv
->contents
->next
== 0)
2060 wv
= first_wv
->contents
;
2061 free_widget_value (first_wv
);
2068 /* Walk through the widget_value tree starting at FIRST_WV and update
2069 the char * pointers from the corresponding lisp values.
2070 We do this after building the whole tree, since GC may happen while the
2071 tree is constructed, and small strings are relocated. So we must wait
2072 until no GC can happen before storing pointers into lisp values. */
2074 update_submenu_strings (first_wv
)
2075 widget_value
*first_wv
;
2079 for (wv
= first_wv
; wv
; wv
= wv
->next
)
2081 if (STRINGP (wv
->lname
))
2083 wv
->name
= (char *) SDATA (wv
->lname
);
2085 /* Ignore the @ that means "separate pane".
2086 This is a kludge, but this isn't worth more time. */
2087 if (wv
->value
== (char *)1)
2089 if (wv
->name
[0] == '@')
2095 if (STRINGP (wv
->lkey
))
2096 wv
->key
= (char *) SDATA (wv
->lkey
);
2099 update_submenu_strings (wv
->contents
);
2104 /* Recompute all the widgets of frame F, when the menu bar has been
2105 changed. Value is non-zero if widgets were updated. */
2108 update_frame_menubar (f
)
2112 return xg_update_frame_menubar (f
);
2114 struct x_output
*x
= f
->output_data
.x
;
2117 if (!x
->menubar_widget
|| XtIsManaged (x
->menubar_widget
))
2121 /* Save the size of the frame because the pane widget doesn't accept
2122 to resize itself. So force it. */
2123 columns
= FRAME_COLS (f
);
2124 rows
= FRAME_LINES (f
);
2126 /* Do the voodoo which means "I'm changing lots of things, don't try
2127 to refigure sizes until I'm done." */
2128 lw_refigure_widget (x
->column_widget
, False
);
2130 /* The order in which children are managed is the top to bottom
2131 order in which they are displayed in the paned window. First,
2132 remove the text-area widget. */
2133 XtUnmanageChild (x
->edit_widget
);
2135 /* Remove the menubar that is there now, and put up the menubar that
2137 XtManageChild (x
->menubar_widget
);
2138 XtMapWidget (x
->menubar_widget
);
2139 XtVaSetValues (x
->menubar_widget
, XtNmappedWhenManaged
, 1, NULL
);
2141 /* Re-manage the text-area widget, and then thrash the sizes. */
2142 XtManageChild (x
->edit_widget
);
2143 lw_refigure_widget (x
->column_widget
, True
);
2145 /* Force the pane widget to resize itself with the right values. */
2146 EmacsFrameSetCharSize (x
->edit_widget
, columns
, rows
);
2152 /* Set the contents of the menubar widgets of frame F.
2153 The argument FIRST_TIME is currently ignored;
2154 it is set the first time this is called, from initialize_frame_menubar. */
2157 set_frame_menubar (f
, first_time
, deep_p
)
2162 xt_or_gtk_widget menubar_widget
= f
->output_data
.x
->menubar_widget
;
2163 #ifdef USE_X_TOOLKIT
2167 widget_value
*wv
, *first_wv
, *prev_wv
= 0;
2169 int *submenu_start
, *submenu_end
;
2170 int *submenu_top_level_items
, *submenu_n_panes
;
2173 XSETFRAME (Vmenu_updating_frame
, f
);
2175 #ifdef USE_X_TOOLKIT
2176 if (f
->output_data
.x
->id
== 0)
2177 f
->output_data
.x
->id
= next_menubar_widget_id
++;
2178 id
= f
->output_data
.x
->id
;
2181 if (! menubar_widget
)
2183 else if (pending_menu_activation
&& !deep_p
)
2185 /* Make the first call for any given frame always go deep. */
2186 else if (!f
->output_data
.x
->saved_menu_event
&& !deep_p
)
2189 f
->output_data
.x
->saved_menu_event
= (XEvent
*)xmalloc (sizeof (XEvent
));
2190 f
->output_data
.x
->saved_menu_event
->type
= 0;
2194 /* If we have detached menus, we must update deep so detached menus
2195 also gets updated. */
2196 deep_p
= deep_p
|| xg_have_tear_offs ();
2201 /* Make a widget-value tree representing the entire menu trees. */
2203 struct buffer
*prev
= current_buffer
;
2205 int specpdl_count
= SPECPDL_INDEX ();
2206 int previous_menu_items_used
= f
->menu_bar_items_used
;
2207 Lisp_Object
*previous_items
2208 = (Lisp_Object
*) alloca (previous_menu_items_used
2209 * sizeof (Lisp_Object
));
2211 /* If we are making a new widget, its contents are empty,
2212 do always reinitialize them. */
2213 if (! menubar_widget
)
2214 previous_menu_items_used
= 0;
2216 buffer
= XWINDOW (FRAME_SELECTED_WINDOW (f
))->buffer
;
2217 specbind (Qinhibit_quit
, Qt
);
2218 /* Don't let the debugger step into this code
2219 because it is not reentrant. */
2220 specbind (Qdebug_on_next_call
, Qnil
);
2222 record_unwind_save_match_data ();
2223 if (NILP (Voverriding_local_map_menu_flag
))
2225 specbind (Qoverriding_terminal_local_map
, Qnil
);
2226 specbind (Qoverriding_local_map
, Qnil
);
2229 set_buffer_internal_1 (XBUFFER (buffer
));
2231 /* Run the Lucid hook. */
2232 safe_run_hooks (Qactivate_menubar_hook
);
2234 /* If it has changed current-menubar from previous value,
2235 really recompute the menubar from the value. */
2236 if (! NILP (Vlucid_menu_bar_dirty_flag
))
2237 call0 (Qrecompute_lucid_menubar
);
2238 safe_run_hooks (Qmenu_bar_update_hook
);
2239 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
2241 items
= FRAME_MENU_BAR_ITEMS (f
);
2243 /* Save the frame's previous menu bar contents data. */
2244 if (previous_menu_items_used
)
2245 bcopy (XVECTOR (f
->menu_bar_vector
)->contents
, previous_items
,
2246 previous_menu_items_used
* sizeof (Lisp_Object
));
2248 /* Fill in menu_items with the current menu bar contents.
2249 This can evaluate Lisp code. */
2252 menu_items
= f
->menu_bar_vector
;
2253 menu_items_allocated
= VECTORP (menu_items
) ? ASIZE (menu_items
) : 0;
2254 submenu_start
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
2255 submenu_end
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
2256 submenu_n_panes
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int));
2257 submenu_top_level_items
2258 = (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
2260 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
2262 Lisp_Object key
, string
, maps
;
2266 key
= XVECTOR (items
)->contents
[i
];
2267 string
= XVECTOR (items
)->contents
[i
+ 1];
2268 maps
= XVECTOR (items
)->contents
[i
+ 2];
2272 submenu_start
[i
] = menu_items_used
;
2274 menu_items_n_panes
= 0;
2275 submenu_top_level_items
[i
]
2276 = parse_single_submenu (key
, string
, maps
);
2277 submenu_n_panes
[i
] = menu_items_n_panes
;
2279 submenu_end
[i
] = menu_items_used
;
2282 finish_menu_items ();
2284 /* Convert menu_items into widget_value trees
2285 to display the menu. This cannot evaluate Lisp code. */
2287 wv
= xmalloc_widget_value ();
2288 wv
->name
= "menubar";
2291 wv
->button_type
= BUTTON_TYPE_NONE
;
2295 for (i
= 0; i
< last_i
; i
+= 4)
2297 menu_items_n_panes
= submenu_n_panes
[i
];
2298 wv
= digest_single_submenu (submenu_start
[i
], submenu_end
[i
],
2299 submenu_top_level_items
[i
]);
2303 first_wv
->contents
= wv
;
2304 /* Don't set wv->name here; GC during the loop might relocate it. */
2306 wv
->button_type
= BUTTON_TYPE_NONE
;
2310 set_buffer_internal_1 (prev
);
2312 /* If there has been no change in the Lisp-level contents
2313 of the menu bar, skip redisplaying it. Just exit. */
2315 /* Compare the new menu items with the ones computed last time. */
2316 for (i
= 0; i
< previous_menu_items_used
; i
++)
2317 if (menu_items_used
== i
2318 || (!EQ (previous_items
[i
], XVECTOR (menu_items
)->contents
[i
])))
2320 if (i
== menu_items_used
&& i
== previous_menu_items_used
&& i
!= 0)
2322 /* The menu items have not changed. Don't bother updating
2323 the menus in any form, since it would be a no-op. */
2324 free_menubar_widget_value_tree (first_wv
);
2325 discard_menu_items ();
2326 unbind_to (specpdl_count
, Qnil
);
2330 /* The menu items are different, so store them in the frame. */
2331 f
->menu_bar_vector
= menu_items
;
2332 f
->menu_bar_items_used
= menu_items_used
;
2334 /* This calls restore_menu_items to restore menu_items, etc.,
2335 as they were outside. */
2336 unbind_to (specpdl_count
, Qnil
);
2338 /* Now GC cannot happen during the lifetime of the widget_value,
2339 so it's safe to store data from a Lisp_String. */
2340 wv
= first_wv
->contents
;
2341 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
2344 string
= XVECTOR (items
)->contents
[i
+ 1];
2347 wv
->name
= (char *) SDATA (string
);
2348 update_submenu_strings (wv
->contents
);
2355 /* Make a widget-value tree containing
2356 just the top level menu bar strings. */
2358 wv
= xmalloc_widget_value ();
2359 wv
->name
= "menubar";
2362 wv
->button_type
= BUTTON_TYPE_NONE
;
2366 items
= FRAME_MENU_BAR_ITEMS (f
);
2367 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
2371 string
= XVECTOR (items
)->contents
[i
+ 1];
2375 wv
= xmalloc_widget_value ();
2376 wv
->name
= (char *) SDATA (string
);
2379 wv
->button_type
= BUTTON_TYPE_NONE
;
2381 /* This prevents lwlib from assuming this
2382 menu item is really supposed to be empty. */
2383 /* The EMACS_INT cast avoids a warning.
2384 This value just has to be different from small integers. */
2385 wv
->call_data
= (void *) (EMACS_INT
) (-1);
2390 first_wv
->contents
= wv
;
2394 /* Forget what we thought we knew about what is in the
2395 detailed contents of the menu bar menus.
2396 Changing the top level always destroys the contents. */
2397 f
->menu_bar_items_used
= 0;
2400 /* Create or update the menu bar widget. */
2405 xg_crazy_callback_abort
= 1;
2408 /* The fourth arg is DEEP_P, which says to consider the entire
2409 menu trees we supply, rather than just the menu bar item names. */
2410 xg_modify_menubar_widgets (menubar_widget
,
2414 G_CALLBACK (menubar_selection_callback
),
2415 G_CALLBACK (popup_deactivate_callback
),
2416 G_CALLBACK (menu_highlight_callback
));
2420 GtkWidget
*wvbox
= f
->output_data
.x
->vbox_widget
;
2423 = xg_create_widget ("menubar", "menubar", f
, first_wv
,
2424 G_CALLBACK (menubar_selection_callback
),
2425 G_CALLBACK (popup_deactivate_callback
),
2426 G_CALLBACK (menu_highlight_callback
));
2428 f
->output_data
.x
->menubar_widget
= menubar_widget
;
2432 #else /* not USE_GTK */
2435 /* Disable resizing (done for Motif!) */
2436 lw_allow_resizing (f
->output_data
.x
->widget
, False
);
2438 /* The third arg is DEEP_P, which says to consider the entire
2439 menu trees we supply, rather than just the menu bar item names. */
2440 lw_modify_all_widgets (id
, first_wv
, deep_p
);
2442 /* Re-enable the edit widget to resize. */
2443 lw_allow_resizing (f
->output_data
.x
->widget
, True
);
2447 char menuOverride
[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
2448 XtTranslations override
= XtParseTranslationTable (menuOverride
);
2450 menubar_widget
= lw_create_widget ("menubar", "menubar", id
, first_wv
,
2451 f
->output_data
.x
->column_widget
,
2453 popup_activate_callback
,
2454 menubar_selection_callback
,
2455 popup_deactivate_callback
,
2456 menu_highlight_callback
);
2457 f
->output_data
.x
->menubar_widget
= menubar_widget
;
2459 /* Make menu pop down on C-g. */
2460 XtOverrideTranslations (menubar_widget
, override
);
2465 = (f
->output_data
.x
->menubar_widget
2466 ? (f
->output_data
.x
->menubar_widget
->core
.height
2467 + f
->output_data
.x
->menubar_widget
->core
.border_width
)
2470 #if 0 /* Experimentally, we now get the right results
2471 for -geometry -0-0 without this. 24 Aug 96, rms. */
2473 if (FRAME_EXTERNAL_MENU_BAR (f
))
2476 XtVaGetValues (f
->output_data
.x
->column_widget
,
2477 XtNinternalBorderWidth
, &ibw
, NULL
);
2478 menubar_size
+= ibw
;
2480 #endif /* USE_LUCID */
2483 f
->output_data
.x
->menubar_height
= menubar_size
;
2485 #endif /* not USE_GTK */
2487 free_menubar_widget_value_tree (first_wv
);
2488 update_frame_menubar (f
);
2491 xg_crazy_callback_abort
= 0;
2497 /* Called from Fx_create_frame to create the initial menubar of a frame
2498 before it is mapped, so that the window is mapped with the menubar already
2499 there instead of us tacking it on later and thrashing the window after it
2503 initialize_frame_menubar (f
)
2506 /* This function is called before the first chance to redisplay
2507 the frame. It has to be, so the frame will have the right size. */
2508 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
2509 set_frame_menubar (f
, 1, 1);
2513 /* Get rid of the menu bar of frame F, and free its storage.
2514 This is used when deleting a frame, and when turning off the menu bar.
2515 For GTK this function is in gtkutil.c. */
2519 free_frame_menubar (f
)
2522 Widget menubar_widget
;
2524 menubar_widget
= f
->output_data
.x
->menubar_widget
;
2526 f
->output_data
.x
->menubar_height
= 0;
2531 /* Removing the menu bar magically changes the shell widget's x
2532 and y position of (0, 0) which, when the menu bar is turned
2533 on again, leads to pull-down menuss appearing in strange
2534 positions near the upper-left corner of the display. This
2535 happens only with some window managers like twm and ctwm,
2536 but not with other like Motif's mwm or kwm, because the
2537 latter generate ConfigureNotify events when the menu bar
2538 is switched off, which fixes the shell position. */
2539 Position x0
, y0
, x1
, y1
;
2545 if (f
->output_data
.x
->widget
)
2546 XtVaGetValues (f
->output_data
.x
->widget
, XtNx
, &x0
, XtNy
, &y0
, NULL
);
2549 lw_destroy_all_widgets ((LWLIB_ID
) f
->output_data
.x
->id
);
2550 f
->output_data
.x
->menubar_widget
= NULL
;
2553 if (f
->output_data
.x
->widget
)
2555 XtVaGetValues (f
->output_data
.x
->widget
, XtNx
, &x1
, XtNy
, &y1
, NULL
);
2556 if (x1
== 0 && y1
== 0)
2557 XtVaSetValues (f
->output_data
.x
->widget
, XtNx
, x0
, XtNy
, y0
, NULL
);
2564 #endif /* not USE_GTK */
2566 #endif /* USE_X_TOOLKIT || USE_GTK */
2568 /* xmenu_show actually displays a menu using the panes and items in menu_items
2569 and returns the value selected from it.
2570 There are two versions of xmenu_show, one for Xt and one for Xlib.
2571 Both assume input is blocked by the caller. */
2573 /* F is the frame the menu is for.
2574 X and Y are the frame-relative specified position,
2575 relative to the inside upper left corner of the frame F.
2576 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
2577 KEYMAPS is 1 if this menu was specified with keymaps;
2578 in that case, we return a list containing the chosen item's value
2579 and perhaps also the pane's prefix.
2580 TITLE is the specified menu title.
2581 ERROR is a place to store an error message string in case of failure.
2582 (We return nil on failure, but the value doesn't actually matter.) */
2584 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
2586 /* The item selected in the popup menu. */
2587 static Lisp_Object
*volatile menu_item_selection
;
2591 /* Used when position a popup menu. See menu_position_func and
2592 create_and_show_popup_menu below. */
2593 struct next_popup_x_y
2600 /* The menu position function to use if we are not putting a popup
2601 menu where the pointer is.
2602 MENU is the menu to pop up.
2603 X and Y shall on exit contain x/y where the menu shall pop up.
2604 PUSH_IN is not documented in the GTK manual.
2605 USER_DATA is any data passed in when calling gtk_menu_popup.
2606 Here it points to a struct next_popup_x_y where the coordinates
2607 to store in *X and *Y are as well as the frame for the popup.
2609 Here only X and Y are used. */
2611 menu_position_func (menu
, x
, y
, push_in
, user_data
)
2618 struct next_popup_x_y
* data
= (struct next_popup_x_y
*)user_data
;
2620 int disp_width
= FRAME_X_DISPLAY_INFO (data
->f
)->width
;
2621 int disp_height
= FRAME_X_DISPLAY_INFO (data
->f
)->height
;
2626 /* Check if there is room for the menu. If not, adjust x/y so that
2627 the menu is fully visible. */
2628 gtk_widget_size_request (GTK_WIDGET (menu
), &req
);
2629 if (data
->x
+ req
.width
> disp_width
)
2630 *x
-= data
->x
+ req
.width
- disp_width
;
2631 if (data
->y
+ req
.height
> disp_height
)
2632 *y
-= data
->y
+ req
.height
- disp_height
;
2636 popup_selection_callback (widget
, client_data
)
2638 gpointer client_data
;
2640 xg_menu_item_cb_data
*cb_data
= (xg_menu_item_cb_data
*) client_data
;
2642 if (xg_crazy_callback_abort
) return;
2643 if (cb_data
) menu_item_selection
= (Lisp_Object
*) cb_data
->call_data
;
2650 struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
2652 popup_activated_flag
= 0;
2654 gtk_widget_destroy (GTK_WIDGET (p
->pointer
));
2659 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
2661 menu_item_selection will be set to the selection. */
2663 create_and_show_popup_menu (f
, first_wv
, x
, y
, for_click
)
2665 widget_value
*first_wv
;
2672 GtkMenuPositionFunc pos_func
= 0; /* Pop up at pointer. */
2673 struct next_popup_x_y popup_x_y
;
2674 int specpdl_count
= SPECPDL_INDEX ();
2676 xg_crazy_callback_abort
= 1;
2677 menu
= xg_create_widget ("popup", first_wv
->name
, f
, first_wv
,
2678 G_CALLBACK (popup_selection_callback
),
2679 G_CALLBACK (popup_deactivate_callback
),
2680 G_CALLBACK (menu_highlight_callback
));
2681 xg_crazy_callback_abort
= 0;
2685 /* Not invoked by a click. pop up at x/y. */
2686 pos_func
= menu_position_func
;
2688 /* Adjust coordinates to be root-window-relative. */
2689 x
+= f
->left_pos
+ FRAME_OUTER_TO_INNER_DIFF_X (f
);
2690 y
+= f
->top_pos
+ FRAME_OUTER_TO_INNER_DIFF_Y (f
);
2696 i
= 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
2700 for (i
= 0; i
< 5; i
++)
2701 if (FRAME_X_DISPLAY_INFO (f
)->grabbed
& (1 << i
))
2705 /* Display the menu. */
2706 gtk_widget_show_all (menu
);
2707 gtk_menu_popup (GTK_MENU (menu
), 0, 0, pos_func
, &popup_x_y
, i
, 0);
2709 record_unwind_protect (pop_down_menu
, make_save_value (menu
, 0));
2711 if (GTK_WIDGET_MAPPED (menu
))
2713 /* Set this to one. popup_widget_loop increases it by one, so it becomes
2714 two. show_help_echo uses this to detect popup menus. */
2715 popup_activated_flag
= 1;
2716 /* Process events that apply to the menu. */
2717 popup_widget_loop (1, menu
);
2720 unbind_to (specpdl_count
, Qnil
);
2722 /* Must reset this manually because the button release event is not passed
2723 to Emacs event loop. */
2724 FRAME_X_DISPLAY_INFO (f
)->grabbed
= 0;
2727 #else /* not USE_GTK */
2729 /* We need a unique id for each widget handled by the Lucid Widget
2732 For the main windows, and popup menus, we use this counter,
2733 which we increment each time after use. This starts from 1<<16.
2735 For menu bars, we use numbers starting at 0, counted in
2736 next_menubar_widget_id. */
2737 LWLIB_ID widget_id_tick
;
2740 popup_selection_callback (widget
, id
, client_data
)
2743 XtPointer client_data
;
2745 menu_item_selection
= (Lisp_Object
*) client_data
;
2748 /* ARG is the LWLIB ID of the dialog box, represented
2749 as a Lisp object as (HIGHPART . LOWPART). */
2755 LWLIB_ID id
= (XINT (XCAR (arg
)) << 4 * sizeof (LWLIB_ID
)
2756 | XINT (XCDR (arg
)));
2759 lw_destroy_all_widgets (id
);
2761 popup_activated_flag
= 0;
2766 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
2768 menu_item_selection will be set to the selection. */
2770 create_and_show_popup_menu (f
, first_wv
, x
, y
, for_click
)
2772 widget_value
*first_wv
;
2780 XButtonPressedEvent dummy
;
2784 menu_id
= widget_id_tick
++;
2785 menu
= lw_create_widget ("popup", first_wv
->name
, menu_id
, first_wv
,
2786 f
->output_data
.x
->widget
, 1, 0,
2787 popup_selection_callback
,
2788 popup_deactivate_callback
,
2789 menu_highlight_callback
);
2791 dummy
.type
= ButtonPress
;
2793 dummy
.send_event
= 0;
2794 dummy
.display
= FRAME_X_DISPLAY (f
);
2795 dummy
.time
= CurrentTime
;
2796 dummy
.root
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
2797 dummy
.window
= dummy
.root
;
2798 dummy
.subwindow
= dummy
.root
;
2802 /* Adjust coordinates to be root-window-relative. */
2803 x
+= f
->left_pos
+ FRAME_OUTER_TO_INNER_DIFF_X (f
);
2804 y
+= f
->top_pos
+ FRAME_OUTER_TO_INNER_DIFF_Y (f
);
2811 for (i
= 0; i
< 5; i
++)
2812 if (FRAME_X_DISPLAY_INFO (f
)->grabbed
& (1 << i
))
2815 /* Don't allow any geometry request from the user. */
2816 XtSetArg (av
[ac
], XtNgeometry
, 0); ac
++;
2817 XtSetValues (menu
, av
, ac
);
2819 /* Display the menu. */
2820 lw_popup_menu (menu
, (XEvent
*) &dummy
);
2821 popup_activated_flag
= 1;
2822 x_activate_timeout_atimer ();
2825 int fact
= 4 * sizeof (LWLIB_ID
);
2826 int specpdl_count
= SPECPDL_INDEX ();
2827 record_unwind_protect (pop_down_menu
,
2828 Fcons (make_number (menu_id
>> (fact
)),
2829 make_number (menu_id
& ~(-1 << (fact
)))));
2831 /* Process events that apply to the menu. */
2832 popup_get_selection ((XEvent
*) 0, FRAME_X_DISPLAY_INFO (f
), menu_id
, 1);
2834 unbind_to (specpdl_count
, Qnil
);
2838 #endif /* not USE_GTK */
2841 xmenu_show (f
, x
, y
, for_click
, keymaps
, title
, error
)
2851 widget_value
*wv
, *save_wv
= 0, *first_wv
= 0, *prev_wv
= 0;
2852 widget_value
**submenu_stack
2853 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
2854 Lisp_Object
*subprefix_stack
2855 = (Lisp_Object
*) alloca (menu_items_used
* sizeof (Lisp_Object
));
2856 int submenu_depth
= 0;
2862 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
2864 *error
= "Empty menu";
2868 /* Create a tree of widget_value objects
2869 representing the panes and their items. */
2870 wv
= xmalloc_widget_value ();
2874 wv
->button_type
= BUTTON_TYPE_NONE
;
2879 /* Loop over all panes and items, filling in the tree. */
2881 while (i
< menu_items_used
)
2883 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qnil
))
2885 submenu_stack
[submenu_depth
++] = save_wv
;
2891 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qlambda
))
2894 save_wv
= submenu_stack
[--submenu_depth
];
2898 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
)
2899 && submenu_depth
!= 0)
2900 i
+= MENU_ITEMS_PANE_LENGTH
;
2901 /* Ignore a nil in the item list.
2902 It's meaningful only for dialog boxes. */
2903 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
2905 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
2907 /* Create a new pane. */
2908 Lisp_Object pane_name
, prefix
;
2911 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
2912 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
2914 #ifndef HAVE_MULTILINGUAL_MENU
2915 if (STRINGP (pane_name
) && STRING_MULTIBYTE (pane_name
))
2917 pane_name
= ENCODE_MENU_STRING (pane_name
);
2918 AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
) = pane_name
;
2921 pane_string
= (NILP (pane_name
)
2922 ? "" : (char *) SDATA (pane_name
));
2923 /* If there is just one top-level pane, put all its items directly
2924 under the top-level menu. */
2925 if (menu_items_n_panes
== 1)
2928 /* If the pane has a meaningful name,
2929 make the pane a top-level menu item
2930 with its items as a submenu beneath it. */
2931 if (!keymaps
&& strcmp (pane_string
, ""))
2933 wv
= xmalloc_widget_value ();
2937 first_wv
->contents
= wv
;
2938 wv
->name
= pane_string
;
2939 if (keymaps
&& !NILP (prefix
))
2943 wv
->button_type
= BUTTON_TYPE_NONE
;
2948 else if (first_pane
)
2954 i
+= MENU_ITEMS_PANE_LENGTH
;
2958 /* Create a new item within current pane. */
2959 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
, help
;
2960 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
2961 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
2962 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
2963 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
2964 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
2965 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
2966 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
2968 #ifndef HAVE_MULTILINGUAL_MENU
2969 if (STRINGP (item_name
) && STRING_MULTIBYTE (item_name
))
2971 item_name
= ENCODE_MENU_STRING (item_name
);
2972 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
) = item_name
;
2975 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
2977 descrip
= ENCODE_MENU_STRING (descrip
);
2978 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
) = descrip
;
2980 #endif /* not HAVE_MULTILINGUAL_MENU */
2982 wv
= xmalloc_widget_value ();
2986 save_wv
->contents
= wv
;
2987 wv
->name
= (char *) SDATA (item_name
);
2988 if (!NILP (descrip
))
2989 wv
->key
= (char *) SDATA (descrip
);
2991 /* If this item has a null value,
2992 make the call_data null so that it won't display a box
2993 when the mouse is on it. */
2995 = (!NILP (def
) ? (void *) &XVECTOR (menu_items
)->contents
[i
] : 0);
2996 wv
->enabled
= !NILP (enable
);
2999 wv
->button_type
= BUTTON_TYPE_NONE
;
3000 else if (EQ (type
, QCtoggle
))
3001 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
3002 else if (EQ (type
, QCradio
))
3003 wv
->button_type
= BUTTON_TYPE_RADIO
;
3007 wv
->selected
= !NILP (selected
);
3009 if (! STRINGP (help
))
3016 i
+= MENU_ITEMS_ITEM_LENGTH
;
3020 /* Deal with the title, if it is non-nil. */
3023 widget_value
*wv_title
= xmalloc_widget_value ();
3024 widget_value
*wv_sep1
= xmalloc_widget_value ();
3025 widget_value
*wv_sep2
= xmalloc_widget_value ();
3027 wv_sep2
->name
= "--";
3028 wv_sep2
->next
= first_wv
->contents
;
3029 wv_sep2
->help
= Qnil
;
3031 wv_sep1
->name
= "--";
3032 wv_sep1
->next
= wv_sep2
;
3033 wv_sep1
->help
= Qnil
;
3035 #ifndef HAVE_MULTILINGUAL_MENU
3036 if (STRING_MULTIBYTE (title
))
3037 title
= ENCODE_MENU_STRING (title
);
3040 wv_title
->name
= (char *) SDATA (title
);
3041 wv_title
->enabled
= TRUE
;
3042 wv_title
->button_type
= BUTTON_TYPE_NONE
;
3043 wv_title
->next
= wv_sep1
;
3044 wv_title
->help
= Qnil
;
3045 first_wv
->contents
= wv_title
;
3048 /* No selection has been chosen yet. */
3049 menu_item_selection
= 0;
3051 /* Actually create and show the menu until popped down. */
3052 create_and_show_popup_menu (f
, first_wv
, x
, y
, for_click
);
3054 /* Free the widget_value objects we used to specify the contents. */
3055 free_menubar_widget_value_tree (first_wv
);
3057 /* Find the selected item, and its pane, to return
3058 the proper value. */
3059 if (menu_item_selection
!= 0)
3061 Lisp_Object prefix
, entry
;
3063 prefix
= entry
= Qnil
;
3065 while (i
< menu_items_used
)
3067 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qnil
))
3069 subprefix_stack
[submenu_depth
++] = prefix
;
3073 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qlambda
))
3075 prefix
= subprefix_stack
[--submenu_depth
];
3078 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3081 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3082 i
+= MENU_ITEMS_PANE_LENGTH
;
3084 /* Ignore a nil in the item list.
3085 It's meaningful only for dialog boxes. */
3086 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
3091 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
3092 if (menu_item_selection
== &XVECTOR (menu_items
)->contents
[i
])
3098 entry
= Fcons (entry
, Qnil
);
3100 entry
= Fcons (prefix
, entry
);
3101 for (j
= submenu_depth
- 1; j
>= 0; j
--)
3102 if (!NILP (subprefix_stack
[j
]))
3103 entry
= Fcons (subprefix_stack
[j
], entry
);
3107 i
+= MENU_ITEMS_ITEM_LENGTH
;
3111 else if (!for_click
)
3112 /* Make "Cancel" equivalent to C-g. */
3113 Fsignal (Qquit
, Qnil
);
3120 dialog_selection_callback (widget
, client_data
)
3122 gpointer client_data
;
3124 /* The EMACS_INT cast avoids a warning. There's no problem
3125 as long as pointers have enough bits to hold small integers. */
3126 if ((int) (EMACS_INT
) client_data
!= -1)
3127 menu_item_selection
= (Lisp_Object
*) client_data
;
3129 popup_activated_flag
= 0;
3132 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
3134 menu_item_selection will be set to the selection. */
3136 create_and_show_dialog (f
, first_wv
)
3138 widget_value
*first_wv
;
3142 menu
= xg_create_widget ("dialog", first_wv
->name
, f
, first_wv
,
3143 G_CALLBACK (dialog_selection_callback
),
3144 G_CALLBACK (popup_deactivate_callback
),
3149 int specpdl_count
= SPECPDL_INDEX ();
3150 record_unwind_protect (pop_down_menu
, make_save_value (menu
, 0));
3152 /* Display the menu. */
3153 gtk_widget_show_all (menu
);
3155 /* Process events that apply to the menu. */
3156 popup_widget_loop (1, menu
);
3158 unbind_to (specpdl_count
, Qnil
);
3162 #else /* not USE_GTK */
3164 dialog_selection_callback (widget
, id
, client_data
)
3167 XtPointer client_data
;
3169 /* The EMACS_INT cast avoids a warning. There's no problem
3170 as long as pointers have enough bits to hold small integers. */
3171 if ((int) (EMACS_INT
) client_data
!= -1)
3172 menu_item_selection
= (Lisp_Object
*) client_data
;
3175 lw_destroy_all_widgets (id
);
3177 popup_activated_flag
= 0;
3181 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
3183 menu_item_selection will be set to the selection. */
3185 create_and_show_dialog (f
, first_wv
)
3187 widget_value
*first_wv
;
3191 dialog_id
= widget_id_tick
++;
3192 lw_create_widget (first_wv
->name
, "dialog", dialog_id
, first_wv
,
3193 f
->output_data
.x
->widget
, 1, 0,
3194 dialog_selection_callback
, 0, 0);
3195 lw_modify_all_widgets (dialog_id
, first_wv
->contents
, True
);
3197 /* Display the dialog box. */
3198 lw_pop_up_all_widgets (dialog_id
);
3199 popup_activated_flag
= 1;
3200 x_activate_timeout_atimer ();
3202 /* Process events that apply to the dialog box.
3203 Also handle timers. */
3205 int count
= SPECPDL_INDEX ();
3206 int fact
= 4 * sizeof (LWLIB_ID
);
3208 /* xdialog_show_unwind is responsible for popping the dialog box down. */
3209 record_unwind_protect (pop_down_menu
,
3210 Fcons (make_number (dialog_id
>> (fact
)),
3211 make_number (dialog_id
& ~(-1 << (fact
)))));
3213 popup_get_selection ((XEvent
*) 0, FRAME_X_DISPLAY_INFO (f
),
3216 unbind_to (count
, Qnil
);
3220 #endif /* not USE_GTK */
3222 static char * button_names
[] = {
3223 "button1", "button2", "button3", "button4", "button5",
3224 "button6", "button7", "button8", "button9", "button10" };
3227 xdialog_show (f
, keymaps
, title
, header
, error_name
)
3230 Lisp_Object title
, header
;
3233 int i
, nb_buttons
=0;
3234 char dialog_name
[6];
3236 widget_value
*wv
, *first_wv
= 0, *prev_wv
= 0;
3238 /* Number of elements seen so far, before boundary. */
3240 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
3241 int boundary_seen
= 0;
3245 if (menu_items_n_panes
> 1)
3247 *error_name
= "Multiple panes in dialog box";
3251 /* Create a tree of widget_value objects
3252 representing the text label and buttons. */
3254 Lisp_Object pane_name
, prefix
;
3256 pane_name
= XVECTOR (menu_items
)->contents
[MENU_ITEMS_PANE_NAME
];
3257 prefix
= XVECTOR (menu_items
)->contents
[MENU_ITEMS_PANE_PREFIX
];
3258 pane_string
= (NILP (pane_name
)
3259 ? "" : (char *) SDATA (pane_name
));
3260 prev_wv
= xmalloc_widget_value ();
3261 prev_wv
->value
= pane_string
;
3262 if (keymaps
&& !NILP (prefix
))
3264 prev_wv
->enabled
= 1;
3265 prev_wv
->name
= "message";
3266 prev_wv
->help
= Qnil
;
3269 /* Loop over all panes and items, filling in the tree. */
3270 i
= MENU_ITEMS_PANE_LENGTH
;
3271 while (i
< menu_items_used
)
3274 /* Create a new item within current pane. */
3275 Lisp_Object item_name
, enable
, descrip
;
3276 item_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_NAME
];
3277 enable
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_ENABLE
];
3279 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_EQUIV_KEY
];
3281 if (NILP (item_name
))
3283 free_menubar_widget_value_tree (first_wv
);
3284 *error_name
= "Submenu in dialog items";
3287 if (EQ (item_name
, Qquote
))
3289 /* This is the boundary between left-side elts
3290 and right-side elts. Stop incrementing right_count. */
3295 if (nb_buttons
>= 9)
3297 free_menubar_widget_value_tree (first_wv
);
3298 *error_name
= "Too many dialog items";
3302 wv
= xmalloc_widget_value ();
3304 wv
->name
= (char *) button_names
[nb_buttons
];
3305 if (!NILP (descrip
))
3306 wv
->key
= (char *) SDATA (descrip
);
3307 wv
->value
= (char *) SDATA (item_name
);
3308 wv
->call_data
= (void *) &XVECTOR (menu_items
)->contents
[i
];
3309 wv
->enabled
= !NILP (enable
);
3313 if (! boundary_seen
)
3317 i
+= MENU_ITEMS_ITEM_LENGTH
;
3320 /* If the boundary was not specified,
3321 by default put half on the left and half on the right. */
3322 if (! boundary_seen
)
3323 left_count
= nb_buttons
- nb_buttons
/ 2;
3325 wv
= xmalloc_widget_value ();
3326 wv
->name
= dialog_name
;
3329 /* Frame title: 'Q' = Question, 'I' = Information.
3330 Can also have 'E' = Error if, one day, we want
3331 a popup for errors. */
3333 dialog_name
[0] = 'Q';
3335 dialog_name
[0] = 'I';
3337 /* Dialog boxes use a really stupid name encoding
3338 which specifies how many buttons to use
3339 and how many buttons are on the right. */
3340 dialog_name
[1] = '0' + nb_buttons
;
3341 dialog_name
[2] = 'B';
3342 dialog_name
[3] = 'R';
3343 /* Number of buttons to put on the right. */
3344 dialog_name
[4] = '0' + nb_buttons
- left_count
;
3346 wv
->contents
= first_wv
;
3350 /* No selection has been chosen yet. */
3351 menu_item_selection
= 0;
3353 /* Actually create and show the dialog. */
3354 create_and_show_dialog (f
, first_wv
);
3356 /* Free the widget_value objects we used to specify the contents. */
3357 free_menubar_widget_value_tree (first_wv
);
3359 /* Find the selected item, and its pane, to return
3360 the proper value. */
3361 if (menu_item_selection
!= 0)
3367 while (i
< menu_items_used
)
3371 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3374 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3375 i
+= MENU_ITEMS_PANE_LENGTH
;
3377 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
3379 /* This is the boundary between left-side elts and
3386 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
3387 if (menu_item_selection
== &XVECTOR (menu_items
)->contents
[i
])
3391 entry
= Fcons (entry
, Qnil
);
3393 entry
= Fcons (prefix
, entry
);
3397 i
+= MENU_ITEMS_ITEM_LENGTH
;
3402 /* Make "Cancel" equivalent to C-g. */
3403 Fsignal (Qquit
, Qnil
);
3408 #else /* not USE_X_TOOLKIT && not USE_GTK */
3410 /* The frame of the last activated non-toolkit menu bar.
3411 Used to generate menu help events. */
3413 static struct frame
*menu_help_frame
;
3416 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
3418 PANE is the pane number, and ITEM is the menu item number in
3419 the menu (currently not used).
3421 This cannot be done with generating a HELP_EVENT because
3422 XMenuActivate contains a loop that doesn't let Emacs process
3426 menu_help_callback (help_string
, pane
, item
)
3430 extern Lisp_Object Qmenu_item
;
3431 Lisp_Object
*first_item
;
3432 Lisp_Object pane_name
;
3433 Lisp_Object menu_object
;
3435 first_item
= XVECTOR (menu_items
)->contents
;
3436 if (EQ (first_item
[0], Qt
))
3437 pane_name
= first_item
[MENU_ITEMS_PANE_NAME
];
3438 else if (EQ (first_item
[0], Qquote
))
3439 /* This shouldn't happen, see xmenu_show. */
3440 pane_name
= empty_string
;
3442 pane_name
= first_item
[MENU_ITEMS_ITEM_NAME
];
3444 /* (menu-item MENU-NAME PANE-NUMBER) */
3445 menu_object
= Fcons (Qmenu_item
,
3447 Fcons (make_number (pane
), Qnil
)));
3448 show_help_echo (help_string
? build_string (help_string
) : Qnil
,
3449 Qnil
, menu_object
, make_number (item
), 1);
3456 struct Lisp_Save_Value
*p1
= XSAVE_VALUE (Fcar (arg
));
3457 struct Lisp_Save_Value
*p2
= XSAVE_VALUE (Fcdr (arg
));
3459 FRAME_PTR f
= p1
->pointer
;
3460 XMenu
*menu
= p2
->pointer
;
3464 XUngrabPointer (FRAME_X_DISPLAY (f
), CurrentTime
);
3465 XUngrabKeyboard (FRAME_X_DISPLAY (f
), CurrentTime
);
3467 XMenuDestroy (FRAME_X_DISPLAY (f
), menu
);
3469 #ifdef HAVE_X_WINDOWS
3470 /* Assume the mouse has moved out of the X window.
3471 If it has actually moved in, we will get an EnterNotify. */
3472 x_mouse_leave (FRAME_X_DISPLAY_INFO (f
));
3474 /* State that no mouse buttons are now held.
3475 (The oldXMenu code doesn't track this info for us.)
3476 That is not necessarily true, but the fiction leads to reasonable
3477 results, and it is a pain to ask which are actually held now. */
3478 FRAME_X_DISPLAY_INFO (f
)->grabbed
= 0;
3480 #endif /* HAVE_X_WINDOWS */
3489 xmenu_show (f
, x
, y
, for_click
, keymaps
, title
, error
)
3499 int pane
, selidx
, lpane
, status
;
3500 Lisp_Object entry
, pane_prefix
;
3502 int ulx
, uly
, width
, height
;
3503 int dispwidth
, dispheight
;
3504 int i
, j
, lines
, maxlines
;
3507 unsigned int dummy_uint
;
3508 int specpdl_count
= SPECPDL_INDEX ();
3511 if (menu_items_n_panes
== 0)
3514 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
3516 *error
= "Empty menu";
3520 /* Figure out which root window F is on. */
3521 XGetGeometry (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
), &root
,
3522 &dummy_int
, &dummy_int
, &dummy_uint
, &dummy_uint
,
3523 &dummy_uint
, &dummy_uint
);
3525 /* Make the menu on that window. */
3526 menu
= XMenuCreate (FRAME_X_DISPLAY (f
), root
, "emacs");
3529 *error
= "Can't create menu";
3533 /* Don't GC while we prepare and show the menu,
3534 because we give the oldxmenu library pointers to the
3535 contents of strings. */
3536 inhibit_garbage_collection ();
3538 #ifdef HAVE_X_WINDOWS
3539 /* Adjust coordinates to relative to the outer (window manager) window. */
3540 x
+= FRAME_OUTER_TO_INNER_DIFF_X (f
);
3541 y
+= FRAME_OUTER_TO_INNER_DIFF_Y (f
);
3542 #endif /* HAVE_X_WINDOWS */
3544 /* Adjust coordinates to be root-window-relative. */
3548 /* Create all the necessary panes and their items. */
3549 maxlines
= lines
= i
= 0;
3550 while (i
< menu_items_used
)
3552 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3554 /* Create a new pane. */
3555 Lisp_Object pane_name
, prefix
;
3558 maxlines
= max (maxlines
, lines
);
3560 pane_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_NAME
];
3561 prefix
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3562 pane_string
= (NILP (pane_name
)
3563 ? "" : (char *) SDATA (pane_name
));
3564 if (keymaps
&& !NILP (prefix
))
3567 lpane
= XMenuAddPane (FRAME_X_DISPLAY (f
), menu
, pane_string
, TRUE
);
3568 if (lpane
== XM_FAILURE
)
3570 XMenuDestroy (FRAME_X_DISPLAY (f
), menu
);
3571 *error
= "Can't create pane";
3574 i
+= MENU_ITEMS_PANE_LENGTH
;
3576 /* Find the width of the widest item in this pane. */
3579 while (j
< menu_items_used
)
3582 item
= XVECTOR (menu_items
)->contents
[j
];
3590 width
= SBYTES (item
);
3591 if (width
> maxwidth
)
3594 j
+= MENU_ITEMS_ITEM_LENGTH
;
3597 /* Ignore a nil in the item list.
3598 It's meaningful only for dialog boxes. */
3599 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
3603 /* Create a new item within current pane. */
3604 Lisp_Object item_name
, enable
, descrip
, help
;
3605 unsigned char *item_data
;
3608 item_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_NAME
];
3609 enable
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_ENABLE
];
3611 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_EQUIV_KEY
];
3612 help
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_HELP
];
3613 help_string
= STRINGP (help
) ? SDATA (help
) : NULL
;
3615 if (!NILP (descrip
))
3617 int gap
= maxwidth
- SBYTES (item_name
);
3620 spacer
= Fmake_string (make_number (gap
), make_number (' '));
3621 item_name
= concat2 (item_name
, spacer
);
3622 item_name
= concat2 (item_name
, descrip
);
3623 item_data
= SDATA (item_name
);
3625 /* if alloca is fast, use that to make the space,
3626 to reduce gc needs. */
3628 = (unsigned char *) alloca (maxwidth
3629 + SBYTES (descrip
) + 1);
3630 bcopy (SDATA (item_name
), item_data
,
3631 SBYTES (item_name
));
3632 for (j
= SCHARS (item_name
); j
< maxwidth
; j
++)
3634 bcopy (SDATA (descrip
), item_data
+ j
,
3636 item_data
[j
+ SBYTES (descrip
)] = 0;
3640 item_data
= SDATA (item_name
);
3642 if (XMenuAddSelection (FRAME_X_DISPLAY (f
),
3643 menu
, lpane
, 0, item_data
,
3644 !NILP (enable
), help_string
)
3647 XMenuDestroy (FRAME_X_DISPLAY (f
), menu
);
3648 *error
= "Can't add selection to menu";
3651 i
+= MENU_ITEMS_ITEM_LENGTH
;
3656 maxlines
= max (maxlines
, lines
);
3658 /* All set and ready to fly. */
3659 XMenuRecompute (FRAME_X_DISPLAY (f
), menu
);
3660 dispwidth
= DisplayWidth (FRAME_X_DISPLAY (f
), FRAME_X_SCREEN_NUMBER (f
));
3661 dispheight
= DisplayHeight (FRAME_X_DISPLAY (f
), FRAME_X_SCREEN_NUMBER (f
));
3662 x
= min (x
, dispwidth
);
3663 y
= min (y
, dispheight
);
3666 XMenuLocate (FRAME_X_DISPLAY (f
), menu
, 0, 0, x
, y
,
3667 &ulx
, &uly
, &width
, &height
);
3668 if (ulx
+width
> dispwidth
)
3670 x
-= (ulx
+ width
) - dispwidth
;
3671 ulx
= dispwidth
- width
;
3673 if (uly
+height
> dispheight
)
3675 y
-= (uly
+ height
) - dispheight
;
3676 uly
= dispheight
- height
;
3678 if (ulx
< 0) x
-= ulx
;
3679 if (uly
< 0) y
-= uly
;
3683 /* If position was not given by a mouse click, adjust so upper left
3684 corner of the menu as a whole ends up at given coordinates. This
3685 is what x-popup-menu says in its documentation. */
3687 y
+= 1.5*height
/(maxlines
+2);
3690 XMenuSetAEQ (menu
, TRUE
);
3691 XMenuSetFreeze (menu
, TRUE
);
3695 XMenuActivateSetWaitFunction (x_menu_wait_for_event
, FRAME_X_DISPLAY (f
));
3698 record_unwind_protect (pop_down_menu
,
3699 Fcons (make_save_value (f
, 0),
3700 make_save_value (menu
, 0)));
3702 /* Help display under X won't work because XMenuActivate contains
3703 a loop that doesn't give Emacs a chance to process it. */
3704 menu_help_frame
= f
;
3705 status
= XMenuActivate (FRAME_X_DISPLAY (f
), menu
, &pane
, &selidx
,
3706 x
, y
, ButtonReleaseMask
, &datap
,
3707 menu_help_callback
);
3713 fprintf (stderr
, "pane= %d line = %d\n", panes
, selidx
);
3716 /* Find the item number SELIDX in pane number PANE. */
3718 while (i
< menu_items_used
)
3720 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3724 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3726 i
+= MENU_ITEMS_PANE_LENGTH
;
3735 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
3738 entry
= Fcons (entry
, Qnil
);
3739 if (!NILP (pane_prefix
))
3740 entry
= Fcons (pane_prefix
, entry
);
3746 i
+= MENU_ITEMS_ITEM_LENGTH
;
3752 *error
= "Can't activate menu";
3757 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
3758 the menu was invoked with a mouse event as POSITION). */
3760 Fsignal (Qquit
, Qnil
);
3765 unbind_to (specpdl_count
, Qnil
);
3770 #endif /* not USE_X_TOOLKIT */
3772 #endif /* HAVE_MENUS */
3777 staticpro (&menu_items
);
3779 menu_items_inuse
= Qnil
;
3781 Qdebug_on_next_call
= intern ("debug-on-next-call");
3782 staticpro (&Qdebug_on_next_call
);
3784 #ifdef USE_X_TOOLKIT
3785 widget_id_tick
= (1<<16);
3786 next_menubar_widget_id
= 1;
3789 defsubr (&Sx_popup_menu
);
3790 defsubr (&Smenu_or_popup_active_p
);
3792 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
3793 defsubr (&Smenu_bar_open
);
3794 Ffset (intern ("accelerate-menu"), intern (Smenu_bar_open
.symbol_name
));
3798 defsubr (&Sx_popup_dialog
);
3802 /* arch-tag: 92ea573c-398e-496e-ac73-2436f7d63242
3803 (do not change this comment) */