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 Vmenu_updating_frame
;
102 Lisp_Object Qdebug_on_next_call
;
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
;
1187 /* Wait for an X event to arrive or for a timer to expire. */
1190 x_menu_wait_for_event (void *data
)
1192 extern EMACS_TIME timer_check
P_ ((int));
1194 /* Another way to do this is to register a timer callback, that can be
1195 done in GTK and Xt. But we have to do it like this when using only X
1196 anyway, and with callbacks we would have three variants for timer handling
1197 instead of the small ifdefs below. */
1200 #ifdef USE_X_TOOLKIT
1201 ! XtAppPending (Xt_app_con
)
1202 #elif defined USE_GTK
1203 ! gtk_events_pending ()
1205 ! XPending ((Display
*) data
)
1209 EMACS_TIME next_time
= timer_check (1);
1210 long secs
= EMACS_SECS (next_time
);
1211 long usecs
= EMACS_USECS (next_time
);
1212 SELECT_TYPE read_fds
;
1213 struct x_display_info
*dpyinfo
;
1216 FD_ZERO (&read_fds
);
1217 for (dpyinfo
= x_display_list
; dpyinfo
; dpyinfo
= dpyinfo
->next
)
1219 int fd
= ConnectionNumber (dpyinfo
->display
);
1220 FD_SET (fd
, &read_fds
);
1224 if (secs
< 0 || (secs
== 0 && usecs
== 0))
1226 /* Sometimes timer_check returns -1 (no timers) even if there are
1227 timers. So do a timeout anyway. */
1228 EMACS_SET_SECS (next_time
, 1);
1229 EMACS_SET_USECS (next_time
, 0);
1232 select (n
+ 1, &read_fds
, (SELECT_TYPE
*)0, (SELECT_TYPE
*)0, &next_time
);
1235 #endif /* ! MSDOS */
1238 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1240 #ifdef USE_X_TOOLKIT
1242 /* Loop in Xt until the menu pulldown or dialog popup has been
1243 popped down (deactivated). This is used for x-popup-menu
1244 and x-popup-dialog; it is not used for the menu bar.
1246 NOTE: All calls to popup_get_selection should be protected
1247 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
1250 popup_get_selection (initial_event
, dpyinfo
, id
, do_timers
)
1251 XEvent
*initial_event
;
1252 struct x_display_info
*dpyinfo
;
1258 while (popup_activated_flag
)
1262 event
= *initial_event
;
1267 if (do_timers
) x_menu_wait_for_event (0);
1268 XtAppNextEvent (Xt_app_con
, &event
);
1271 /* Make sure we don't consider buttons grabbed after menu goes.
1272 And make sure to deactivate for any ButtonRelease,
1273 even if XtDispatchEvent doesn't do that. */
1274 if (event
.type
== ButtonRelease
1275 && dpyinfo
->display
== event
.xbutton
.display
)
1277 dpyinfo
->grabbed
&= ~(1 << event
.xbutton
.button
);
1278 #ifdef USE_MOTIF /* Pretending that the event came from a
1279 Btn1Down seems the only way to convince Motif to
1280 activate its callbacks; setting the XmNmenuPost
1281 isn't working. --marcus@sysc.pdx.edu. */
1282 event
.xbutton
.button
= 1;
1283 /* Motif only pops down menus when no Ctrl, Alt or Mod
1284 key is pressed and the button is released. So reset key state
1285 so Motif thinks this is the case. */
1286 event
.xbutton
.state
= 0;
1289 /* Pop down on C-g and Escape. */
1290 else if (event
.type
== KeyPress
1291 && dpyinfo
->display
== event
.xbutton
.display
)
1293 KeySym keysym
= XLookupKeysym (&event
.xkey
, 0);
1295 if ((keysym
== XK_g
&& (event
.xkey
.state
& ControlMask
) != 0)
1296 || keysym
== XK_Escape
) /* Any escape, ignore modifiers. */
1297 popup_activated_flag
= 0;
1300 x_dispatch_event (&event
, event
.xany
.display
);
1304 #endif /* USE_X_TOOLKIT */
1307 /* Loop util popup_activated_flag is set to zero in a callback.
1308 Used for popup menus and dialogs. */
1311 popup_widget_loop (do_timers
, widget
)
1315 ++popup_activated_flag
;
1317 /* Process events in the Gtk event loop until done. */
1318 while (popup_activated_flag
)
1320 if (do_timers
) x_menu_wait_for_event (0);
1321 gtk_main_iteration ();
1326 /* Activate the menu bar of frame F.
1327 This is called from keyboard.c when it gets the
1328 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
1330 To activate the menu bar, we use the X button-press event
1331 that was saved in saved_menu_event.
1332 That makes the toolkit do its thing.
1334 But first we recompute the menu bar contents (the whole tree).
1336 The reason for saving the button event until here, instead of
1337 passing it to the toolkit right away, is that we can safely
1338 execute Lisp code. */
1341 x_activate_menubar (f
)
1344 if (!f
->output_data
.x
->saved_menu_event
->type
)
1348 if (! xg_win_to_widget (FRAME_X_DISPLAY (f
),
1349 f
->output_data
.x
->saved_menu_event
->xany
.window
))
1353 set_frame_menubar (f
, 0, 1);
1356 XPutBackEvent (f
->output_data
.x
->display_info
->display
,
1357 f
->output_data
.x
->saved_menu_event
);
1358 popup_activated_flag
= 1;
1360 XtDispatchEvent (f
->output_data
.x
->saved_menu_event
);
1364 if (f
->output_data
.x
->saved_menu_event
->type
== ButtonRelease
)
1365 pending_menu_activation
= 1;
1368 /* Ignore this if we get it a second time. */
1369 f
->output_data
.x
->saved_menu_event
->type
= 0;
1372 /* Detect if a dialog or menu has been posted. */
1377 return popup_activated_flag
;
1380 /* This callback is invoked when the user selects a menubar cascade
1381 pushbutton, but before the pulldown menu is posted. */
1385 popup_activate_callback (widget
, id
, client_data
)
1388 XtPointer client_data
;
1390 popup_activated_flag
= 1;
1394 /* This callback is invoked when a dialog or menu is finished being
1395 used and has been unposted. */
1399 popup_deactivate_callback (widget
, client_data
)
1401 gpointer client_data
;
1403 popup_activated_flag
= 0;
1407 popup_deactivate_callback (widget
, id
, client_data
)
1410 XtPointer client_data
;
1412 popup_activated_flag
= 0;
1417 /* Function that finds the frame for WIDGET and shows the HELP text
1419 F is the frame if known, or NULL if not known. */
1421 show_help_event (f
, widget
, help
)
1423 xt_or_gtk_widget widget
;
1430 XSETFRAME (frame
, f
);
1431 kbd_buffer_store_help_event (frame
, help
);
1435 #if 0 /* This code doesn't do anything useful. ++kfs */
1436 /* WIDGET is the popup menu. It's parent is the frame's
1437 widget. See which frame that is. */
1438 xt_or_gtk_widget frame_widget
= XtParent (widget
);
1441 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
1443 frame
= XCAR (tail
);
1444 if (GC_FRAMEP (frame
)
1445 && (f
= XFRAME (frame
),
1446 FRAME_X_P (f
) && f
->output_data
.x
->widget
== frame_widget
))
1450 show_help_echo (help
, Qnil
, Qnil
, Qnil
, 1);
1454 /* Callback called when menu items are highlighted/unhighlighted
1455 while moving the mouse over them. WIDGET is the menu bar or menu
1456 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
1457 the data structure for the menu item, or null in case of
1462 menu_highlight_callback (widget
, call_data
)
1466 xg_menu_item_cb_data
*cb_data
;
1469 cb_data
= (xg_menu_item_cb_data
*) g_object_get_data (G_OBJECT (widget
),
1471 if (! cb_data
) return;
1473 help
= call_data
? cb_data
->help
: Qnil
;
1475 /* If popup_activated_flag is greater than 1 we are in a popup menu.
1476 Don't show help for them, they won't appear before the
1477 popup is popped down. */
1478 if (popup_activated_flag
<= 1)
1479 show_help_event (cb_data
->cl_data
->f
, widget
, help
);
1483 menu_highlight_callback (widget
, id
, call_data
)
1491 widget_value
*wv
= (widget_value
*) call_data
;
1493 help
= wv
? wv
->help
: Qnil
;
1495 /* Determine the frame for the help event. */
1496 f
= menubar_id_to_frame (id
);
1498 show_help_event (f
, widget
, help
);
1502 /* Find the menu selection and store it in the keyboard buffer.
1503 F is the frame the menu is on.
1504 MENU_BAR_ITEMS_USED is the length of VECTOR.
1505 VECTOR is an array of menu events for the whole menu. */
1508 find_and_call_menu_selection (f
, menu_bar_items_used
, vector
, client_data
)
1510 int menu_bar_items_used
;
1514 Lisp_Object prefix
, entry
;
1515 Lisp_Object
*subprefix_stack
;
1516 int submenu_depth
= 0;
1520 subprefix_stack
= (Lisp_Object
*) alloca (menu_bar_items_used
* sizeof (Lisp_Object
));
1524 while (i
< menu_bar_items_used
)
1526 if (EQ (XVECTOR (vector
)->contents
[i
], Qnil
))
1528 subprefix_stack
[submenu_depth
++] = prefix
;
1532 else if (EQ (XVECTOR (vector
)->contents
[i
], Qlambda
))
1534 prefix
= subprefix_stack
[--submenu_depth
];
1537 else if (EQ (XVECTOR (vector
)->contents
[i
], Qt
))
1539 prefix
= XVECTOR (vector
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
1540 i
+= MENU_ITEMS_PANE_LENGTH
;
1544 entry
= XVECTOR (vector
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
1545 /* The EMACS_INT cast avoids a warning. There's no problem
1546 as long as pointers have enough bits to hold small integers. */
1547 if ((int) (EMACS_INT
) client_data
== i
)
1550 struct input_event buf
;
1554 XSETFRAME (frame
, f
);
1555 buf
.kind
= MENU_BAR_EVENT
;
1556 buf
.frame_or_window
= frame
;
1558 kbd_buffer_store_event (&buf
);
1560 for (j
= 0; j
< submenu_depth
; j
++)
1561 if (!NILP (subprefix_stack
[j
]))
1563 buf
.kind
= MENU_BAR_EVENT
;
1564 buf
.frame_or_window
= frame
;
1565 buf
.arg
= subprefix_stack
[j
];
1566 kbd_buffer_store_event (&buf
);
1571 buf
.kind
= MENU_BAR_EVENT
;
1572 buf
.frame_or_window
= frame
;
1574 kbd_buffer_store_event (&buf
);
1577 buf
.kind
= MENU_BAR_EVENT
;
1578 buf
.frame_or_window
= frame
;
1580 kbd_buffer_store_event (&buf
);
1584 i
+= MENU_ITEMS_ITEM_LENGTH
;
1591 /* Gtk calls callbacks just because we tell it what item should be
1592 selected in a radio group. If this variable is set to a non-zero
1593 value, we are creating menus and don't want callbacks right now.
1595 static int xg_crazy_callback_abort
;
1597 /* This callback is called from the menu bar pulldown menu
1598 when the user makes a selection.
1599 Figure out what the user chose
1600 and put the appropriate events into the keyboard buffer. */
1602 menubar_selection_callback (widget
, client_data
)
1604 gpointer client_data
;
1606 xg_menu_item_cb_data
*cb_data
= (xg_menu_item_cb_data
*) client_data
;
1608 if (xg_crazy_callback_abort
)
1611 if (! cb_data
|| ! cb_data
->cl_data
|| ! cb_data
->cl_data
->f
)
1614 /* For a group of radio buttons, GTK calls the selection callback first
1615 for the item that was active before the selection and then for the one that
1616 is active after the selection. For C-h k this means we get the help on
1617 the deselected item and then the selected item is executed. Prevent that
1618 by ignoring the non-active item. */
1619 if (GTK_IS_RADIO_MENU_ITEM (widget
)
1620 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget
)))
1623 /* When a menu is popped down, X generates a focus event (i.e. focus
1624 goes back to the frame below the menu). Since GTK buffers events,
1625 we force it out here before the menu selection event. Otherwise
1626 sit-for will exit at once if the focus event follows the menu selection
1630 while (gtk_events_pending ())
1631 gtk_main_iteration ();
1634 find_and_call_menu_selection (cb_data
->cl_data
->f
,
1635 cb_data
->cl_data
->menu_bar_items_used
,
1636 cb_data
->cl_data
->menu_bar_vector
,
1637 cb_data
->call_data
);
1640 #else /* not USE_GTK */
1642 /* This callback is called from the menu bar pulldown menu
1643 when the user makes a selection.
1644 Figure out what the user chose
1645 and put the appropriate events into the keyboard buffer. */
1647 menubar_selection_callback (widget
, id
, client_data
)
1650 XtPointer client_data
;
1654 f
= menubar_id_to_frame (id
);
1657 find_and_call_menu_selection (f
, f
->menu_bar_items_used
,
1658 f
->menu_bar_vector
, client_data
);
1660 #endif /* not USE_GTK */
1662 /* Allocate a widget_value, blocking input. */
1665 xmalloc_widget_value ()
1667 widget_value
*value
;
1670 value
= malloc_widget_value ();
1676 /* This recursively calls free_widget_value on the tree of widgets.
1677 It must free all data that was malloc'ed for these widget_values.
1678 In Emacs, many slots are pointers into the data of Lisp_Strings, and
1679 must be left alone. */
1682 free_menubar_widget_value_tree (wv
)
1687 wv
->name
= wv
->value
= wv
->key
= (char *) 0xDEADBEEF;
1689 if (wv
->contents
&& (wv
->contents
!= (widget_value
*)1))
1691 free_menubar_widget_value_tree (wv
->contents
);
1692 wv
->contents
= (widget_value
*) 0xDEADBEEF;
1696 free_menubar_widget_value_tree (wv
->next
);
1697 wv
->next
= (widget_value
*) 0xDEADBEEF;
1700 free_widget_value (wv
);
1704 /* Set up data in menu_items for a menu bar item
1705 whose event type is ITEM_KEY (with string ITEM_NAME)
1706 and whose contents come from the list of keymaps MAPS. */
1709 parse_single_submenu (item_key
, item_name
, maps
)
1710 Lisp_Object item_key
, item_name
, maps
;
1714 Lisp_Object
*mapvec
;
1716 int top_level_items
= 0;
1718 length
= Flength (maps
);
1719 len
= XINT (length
);
1721 /* Convert the list MAPS into a vector MAPVEC. */
1722 mapvec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
1723 for (i
= 0; i
< len
; i
++)
1725 mapvec
[i
] = Fcar (maps
);
1729 /* Loop over the given keymaps, making a pane for each map.
1730 But don't make a pane that is empty--ignore that map instead. */
1731 for (i
= 0; i
< len
; i
++)
1733 if (!KEYMAPP (mapvec
[i
]))
1735 /* Here we have a command at top level in the menu bar
1736 as opposed to a submenu. */
1737 top_level_items
= 1;
1738 push_menu_pane (Qnil
, Qnil
);
1739 push_menu_item (item_name
, Qt
, item_key
, mapvec
[i
],
1740 Qnil
, Qnil
, Qnil
, Qnil
);
1745 prompt
= Fkeymap_prompt (mapvec
[i
]);
1746 single_keymap_panes (mapvec
[i
],
1747 !NILP (prompt
) ? prompt
: item_name
,
1752 return top_level_items
;
1755 /* Create a tree of widget_value objects
1756 representing the panes and items
1757 in menu_items starting at index START, up to index END. */
1759 static widget_value
*
1760 digest_single_submenu (start
, end
, top_level_items
)
1761 int start
, end
, top_level_items
;
1763 widget_value
*wv
, *prev_wv
, *save_wv
, *first_wv
;
1765 int submenu_depth
= 0;
1766 widget_value
**submenu_stack
;
1770 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
1771 wv
= xmalloc_widget_value ();
1775 wv
->button_type
= BUTTON_TYPE_NONE
;
1781 /* Loop over all panes and items made by the preceding call
1782 to parse_single_submenu and construct a tree of widget_value objects.
1783 Ignore the panes and items used by previous calls to
1784 digest_single_submenu, even though those are also in menu_items. */
1788 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qnil
))
1790 submenu_stack
[submenu_depth
++] = save_wv
;
1795 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qlambda
))
1798 save_wv
= submenu_stack
[--submenu_depth
];
1801 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
)
1802 && submenu_depth
!= 0)
1803 i
+= MENU_ITEMS_PANE_LENGTH
;
1804 /* Ignore a nil in the item list.
1805 It's meaningful only for dialog boxes. */
1806 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
1808 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
1810 /* Create a new pane. */
1811 Lisp_Object pane_name
, prefix
;
1816 pane_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_NAME
];
1817 prefix
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
1819 #ifndef HAVE_MULTILINGUAL_MENU
1820 if (STRINGP (pane_name
) && STRING_MULTIBYTE (pane_name
))
1822 pane_name
= ENCODE_MENU_STRING (pane_name
);
1823 AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
) = pane_name
;
1826 pane_string
= (NILP (pane_name
)
1827 ? "" : (char *) SDATA (pane_name
));
1828 /* If there is just one top-level pane, put all its items directly
1829 under the top-level menu. */
1830 if (menu_items_n_panes
== 1)
1833 /* If the pane has a meaningful name,
1834 make the pane a top-level menu item
1835 with its items as a submenu beneath it. */
1836 if (strcmp (pane_string
, ""))
1838 wv
= xmalloc_widget_value ();
1842 first_wv
->contents
= wv
;
1843 wv
->lname
= pane_name
;
1844 /* Set value to 1 so update_submenu_strings can handle '@' */
1845 wv
->value
= (char *)1;
1847 wv
->button_type
= BUTTON_TYPE_NONE
;
1855 i
+= MENU_ITEMS_PANE_LENGTH
;
1859 /* Create a new item within current pane. */
1860 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
;
1863 /* All items should be contained in panes. */
1864 if (panes_seen
== 0)
1867 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
1868 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
1869 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
1870 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
1871 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
1872 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
1873 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
1875 #ifndef HAVE_MULTILINGUAL_MENU
1876 if (STRING_MULTIBYTE (item_name
))
1878 item_name
= ENCODE_MENU_STRING (item_name
);
1879 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
) = item_name
;
1882 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
1884 descrip
= ENCODE_MENU_STRING (descrip
);
1885 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
) = descrip
;
1887 #endif /* not HAVE_MULTILINGUAL_MENU */
1889 wv
= xmalloc_widget_value ();
1893 save_wv
->contents
= wv
;
1895 wv
->lname
= item_name
;
1896 if (!NILP (descrip
))
1899 /* The EMACS_INT cast avoids a warning. There's no problem
1900 as long as pointers have enough bits to hold small integers. */
1901 wv
->call_data
= (!NILP (def
) ? (void *) (EMACS_INT
) i
: 0);
1902 wv
->enabled
= !NILP (enable
);
1905 wv
->button_type
= BUTTON_TYPE_NONE
;
1906 else if (EQ (type
, QCradio
))
1907 wv
->button_type
= BUTTON_TYPE_RADIO
;
1908 else if (EQ (type
, QCtoggle
))
1909 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
1913 wv
->selected
= !NILP (selected
);
1914 if (! STRINGP (help
))
1921 i
+= MENU_ITEMS_ITEM_LENGTH
;
1925 /* If we have just one "menu item"
1926 that was originally a button, return it by itself. */
1927 if (top_level_items
&& first_wv
->contents
&& first_wv
->contents
->next
== 0)
1929 wv
= first_wv
->contents
;
1930 free_widget_value (first_wv
);
1937 /* Walk through the widget_value tree starting at FIRST_WV and update
1938 the char * pointers from the corresponding lisp values.
1939 We do this after building the whole tree, since GC may happen while the
1940 tree is constructed, and small strings are relocated. So we must wait
1941 until no GC can happen before storing pointers into lisp values. */
1943 update_submenu_strings (first_wv
)
1944 widget_value
*first_wv
;
1948 for (wv
= first_wv
; wv
; wv
= wv
->next
)
1950 if (STRINGP (wv
->lname
))
1952 wv
->name
= (char *) SDATA (wv
->lname
);
1954 /* Ignore the @ that means "separate pane".
1955 This is a kludge, but this isn't worth more time. */
1956 if (wv
->value
== (char *)1)
1958 if (wv
->name
[0] == '@')
1964 if (STRINGP (wv
->lkey
))
1965 wv
->key
= (char *) SDATA (wv
->lkey
);
1968 update_submenu_strings (wv
->contents
);
1973 /* Recompute all the widgets of frame F, when the menu bar has been
1974 changed. Value is non-zero if widgets were updated. */
1977 update_frame_menubar (f
)
1981 return xg_update_frame_menubar (f
);
1983 struct x_output
*x
= f
->output_data
.x
;
1986 if (!x
->menubar_widget
|| XtIsManaged (x
->menubar_widget
))
1990 /* Save the size of the frame because the pane widget doesn't accept
1991 to resize itself. So force it. */
1992 columns
= FRAME_COLS (f
);
1993 rows
= FRAME_LINES (f
);
1995 /* Do the voodoo which means "I'm changing lots of things, don't try
1996 to refigure sizes until I'm done." */
1997 lw_refigure_widget (x
->column_widget
, False
);
1999 /* The order in which children are managed is the top to bottom
2000 order in which they are displayed in the paned window. First,
2001 remove the text-area widget. */
2002 XtUnmanageChild (x
->edit_widget
);
2004 /* Remove the menubar that is there now, and put up the menubar that
2006 XtManageChild (x
->menubar_widget
);
2007 XtMapWidget (x
->menubar_widget
);
2008 XtVaSetValues (x
->menubar_widget
, XtNmappedWhenManaged
, 1, NULL
);
2010 /* Re-manage the text-area widget, and then thrash the sizes. */
2011 XtManageChild (x
->edit_widget
);
2012 lw_refigure_widget (x
->column_widget
, True
);
2014 /* Force the pane widget to resize itself with the right values. */
2015 EmacsFrameSetCharSize (x
->edit_widget
, columns
, rows
);
2021 /* Set the contents of the menubar widgets of frame F.
2022 The argument FIRST_TIME is currently ignored;
2023 it is set the first time this is called, from initialize_frame_menubar. */
2026 set_frame_menubar (f
, first_time
, deep_p
)
2031 xt_or_gtk_widget menubar_widget
= f
->output_data
.x
->menubar_widget
;
2032 #ifdef USE_X_TOOLKIT
2036 widget_value
*wv
, *first_wv
, *prev_wv
= 0;
2038 int *submenu_start
, *submenu_end
;
2039 int *submenu_top_level_items
, *submenu_n_panes
;
2042 XSETFRAME (Vmenu_updating_frame
, f
);
2044 #ifdef USE_X_TOOLKIT
2045 if (f
->output_data
.x
->id
== 0)
2046 f
->output_data
.x
->id
= next_menubar_widget_id
++;
2047 id
= f
->output_data
.x
->id
;
2050 if (! menubar_widget
)
2052 else if (pending_menu_activation
&& !deep_p
)
2054 /* Make the first call for any given frame always go deep. */
2055 else if (!f
->output_data
.x
->saved_menu_event
&& !deep_p
)
2058 f
->output_data
.x
->saved_menu_event
= (XEvent
*)xmalloc (sizeof (XEvent
));
2059 f
->output_data
.x
->saved_menu_event
->type
= 0;
2063 /* If we have detached menus, we must update deep so detached menus
2064 also gets updated. */
2065 deep_p
= deep_p
|| xg_have_tear_offs ();
2070 /* Make a widget-value tree representing the entire menu trees. */
2072 struct buffer
*prev
= current_buffer
;
2074 int specpdl_count
= SPECPDL_INDEX ();
2075 int previous_menu_items_used
= f
->menu_bar_items_used
;
2076 Lisp_Object
*previous_items
2077 = (Lisp_Object
*) alloca (previous_menu_items_used
2078 * sizeof (Lisp_Object
));
2080 /* If we are making a new widget, its contents are empty,
2081 do always reinitialize them. */
2082 if (! menubar_widget
)
2083 previous_menu_items_used
= 0;
2085 buffer
= XWINDOW (FRAME_SELECTED_WINDOW (f
))->buffer
;
2086 specbind (Qinhibit_quit
, Qt
);
2087 /* Don't let the debugger step into this code
2088 because it is not reentrant. */
2089 specbind (Qdebug_on_next_call
, Qnil
);
2091 record_unwind_save_match_data ();
2092 if (NILP (Voverriding_local_map_menu_flag
))
2094 specbind (Qoverriding_terminal_local_map
, Qnil
);
2095 specbind (Qoverriding_local_map
, Qnil
);
2098 set_buffer_internal_1 (XBUFFER (buffer
));
2100 /* Run the Lucid hook. */
2101 safe_run_hooks (Qactivate_menubar_hook
);
2103 /* If it has changed current-menubar from previous value,
2104 really recompute the menubar from the value. */
2105 if (! NILP (Vlucid_menu_bar_dirty_flag
))
2106 call0 (Qrecompute_lucid_menubar
);
2107 safe_run_hooks (Qmenu_bar_update_hook
);
2108 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
2110 items
= FRAME_MENU_BAR_ITEMS (f
);
2112 /* Save the frame's previous menu bar contents data. */
2113 if (previous_menu_items_used
)
2114 bcopy (XVECTOR (f
->menu_bar_vector
)->contents
, previous_items
,
2115 previous_menu_items_used
* sizeof (Lisp_Object
));
2117 /* Fill in menu_items with the current menu bar contents.
2118 This can evaluate Lisp code. */
2121 menu_items
= f
->menu_bar_vector
;
2122 menu_items_allocated
= VECTORP (menu_items
) ? ASIZE (menu_items
) : 0;
2123 submenu_start
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
2124 submenu_end
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
2125 submenu_n_panes
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int));
2126 submenu_top_level_items
2127 = (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
2129 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
2131 Lisp_Object key
, string
, maps
;
2135 key
= XVECTOR (items
)->contents
[i
];
2136 string
= XVECTOR (items
)->contents
[i
+ 1];
2137 maps
= XVECTOR (items
)->contents
[i
+ 2];
2141 submenu_start
[i
] = menu_items_used
;
2143 menu_items_n_panes
= 0;
2144 submenu_top_level_items
[i
]
2145 = parse_single_submenu (key
, string
, maps
);
2146 submenu_n_panes
[i
] = menu_items_n_panes
;
2148 submenu_end
[i
] = menu_items_used
;
2151 finish_menu_items ();
2153 /* Convert menu_items into widget_value trees
2154 to display the menu. This cannot evaluate Lisp code. */
2156 wv
= xmalloc_widget_value ();
2157 wv
->name
= "menubar";
2160 wv
->button_type
= BUTTON_TYPE_NONE
;
2164 for (i
= 0; i
< last_i
; i
+= 4)
2166 menu_items_n_panes
= submenu_n_panes
[i
];
2167 wv
= digest_single_submenu (submenu_start
[i
], submenu_end
[i
],
2168 submenu_top_level_items
[i
]);
2172 first_wv
->contents
= wv
;
2173 /* Don't set wv->name here; GC during the loop might relocate it. */
2175 wv
->button_type
= BUTTON_TYPE_NONE
;
2179 set_buffer_internal_1 (prev
);
2181 /* If there has been no change in the Lisp-level contents
2182 of the menu bar, skip redisplaying it. Just exit. */
2184 /* Compare the new menu items with the ones computed last time. */
2185 for (i
= 0; i
< previous_menu_items_used
; i
++)
2186 if (menu_items_used
== i
2187 || (!EQ (previous_items
[i
], XVECTOR (menu_items
)->contents
[i
])))
2189 if (i
== menu_items_used
&& i
== previous_menu_items_used
&& i
!= 0)
2191 /* The menu items have not changed. Don't bother updating
2192 the menus in any form, since it would be a no-op. */
2193 free_menubar_widget_value_tree (first_wv
);
2194 discard_menu_items ();
2195 unbind_to (specpdl_count
, Qnil
);
2199 /* The menu items are different, so store them in the frame. */
2200 f
->menu_bar_vector
= menu_items
;
2201 f
->menu_bar_items_used
= menu_items_used
;
2203 /* This calls restore_menu_items to restore menu_items, etc.,
2204 as they were outside. */
2205 unbind_to (specpdl_count
, Qnil
);
2207 /* Now GC cannot happen during the lifetime of the widget_value,
2208 so it's safe to store data from a Lisp_String. */
2209 wv
= first_wv
->contents
;
2210 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
2213 string
= XVECTOR (items
)->contents
[i
+ 1];
2216 wv
->name
= (char *) SDATA (string
);
2217 update_submenu_strings (wv
->contents
);
2224 /* Make a widget-value tree containing
2225 just the top level menu bar strings. */
2227 wv
= xmalloc_widget_value ();
2228 wv
->name
= "menubar";
2231 wv
->button_type
= BUTTON_TYPE_NONE
;
2235 items
= FRAME_MENU_BAR_ITEMS (f
);
2236 for (i
= 0; i
< XVECTOR (items
)->size
; i
+= 4)
2240 string
= XVECTOR (items
)->contents
[i
+ 1];
2244 wv
= xmalloc_widget_value ();
2245 wv
->name
= (char *) SDATA (string
);
2248 wv
->button_type
= BUTTON_TYPE_NONE
;
2250 /* This prevents lwlib from assuming this
2251 menu item is really supposed to be empty. */
2252 /* The EMACS_INT cast avoids a warning.
2253 This value just has to be different from small integers. */
2254 wv
->call_data
= (void *) (EMACS_INT
) (-1);
2259 first_wv
->contents
= wv
;
2263 /* Forget what we thought we knew about what is in the
2264 detailed contents of the menu bar menus.
2265 Changing the top level always destroys the contents. */
2266 f
->menu_bar_items_used
= 0;
2269 /* Create or update the menu bar widget. */
2274 xg_crazy_callback_abort
= 1;
2277 /* The fourth arg is DEEP_P, which says to consider the entire
2278 menu trees we supply, rather than just the menu bar item names. */
2279 xg_modify_menubar_widgets (menubar_widget
,
2283 G_CALLBACK (menubar_selection_callback
),
2284 G_CALLBACK (popup_deactivate_callback
),
2285 G_CALLBACK (menu_highlight_callback
));
2289 GtkWidget
*wvbox
= f
->output_data
.x
->vbox_widget
;
2292 = xg_create_widget ("menubar", "menubar", f
, first_wv
,
2293 G_CALLBACK (menubar_selection_callback
),
2294 G_CALLBACK (popup_deactivate_callback
),
2295 G_CALLBACK (menu_highlight_callback
));
2297 f
->output_data
.x
->menubar_widget
= menubar_widget
;
2301 #else /* not USE_GTK */
2304 /* Disable resizing (done for Motif!) */
2305 lw_allow_resizing (f
->output_data
.x
->widget
, False
);
2307 /* The third arg is DEEP_P, which says to consider the entire
2308 menu trees we supply, rather than just the menu bar item names. */
2309 lw_modify_all_widgets (id
, first_wv
, deep_p
);
2311 /* Re-enable the edit widget to resize. */
2312 lw_allow_resizing (f
->output_data
.x
->widget
, True
);
2316 char menuOverride
[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
2317 XtTranslations override
= XtParseTranslationTable (menuOverride
);
2319 menubar_widget
= lw_create_widget ("menubar", "menubar", id
, first_wv
,
2320 f
->output_data
.x
->column_widget
,
2322 popup_activate_callback
,
2323 menubar_selection_callback
,
2324 popup_deactivate_callback
,
2325 menu_highlight_callback
);
2326 f
->output_data
.x
->menubar_widget
= menubar_widget
;
2328 /* Make menu pop down on C-g. */
2329 XtOverrideTranslations (menubar_widget
, override
);
2334 = (f
->output_data
.x
->menubar_widget
2335 ? (f
->output_data
.x
->menubar_widget
->core
.height
2336 + f
->output_data
.x
->menubar_widget
->core
.border_width
)
2339 #if 0 /* Experimentally, we now get the right results
2340 for -geometry -0-0 without this. 24 Aug 96, rms. */
2342 if (FRAME_EXTERNAL_MENU_BAR (f
))
2345 XtVaGetValues (f
->output_data
.x
->column_widget
,
2346 XtNinternalBorderWidth
, &ibw
, NULL
);
2347 menubar_size
+= ibw
;
2349 #endif /* USE_LUCID */
2352 f
->output_data
.x
->menubar_height
= menubar_size
;
2354 #endif /* not USE_GTK */
2356 free_menubar_widget_value_tree (first_wv
);
2357 update_frame_menubar (f
);
2360 xg_crazy_callback_abort
= 0;
2366 /* Called from Fx_create_frame to create the initial menubar of a frame
2367 before it is mapped, so that the window is mapped with the menubar already
2368 there instead of us tacking it on later and thrashing the window after it
2372 initialize_frame_menubar (f
)
2375 /* This function is called before the first chance to redisplay
2376 the frame. It has to be, so the frame will have the right size. */
2377 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
2378 set_frame_menubar (f
, 1, 1);
2382 /* Get rid of the menu bar of frame F, and free its storage.
2383 This is used when deleting a frame, and when turning off the menu bar.
2384 For GTK this function is in gtkutil.c. */
2388 free_frame_menubar (f
)
2391 Widget menubar_widget
;
2393 menubar_widget
= f
->output_data
.x
->menubar_widget
;
2395 f
->output_data
.x
->menubar_height
= 0;
2400 /* Removing the menu bar magically changes the shell widget's x
2401 and y position of (0, 0) which, when the menu bar is turned
2402 on again, leads to pull-down menuss appearing in strange
2403 positions near the upper-left corner of the display. This
2404 happens only with some window managers like twm and ctwm,
2405 but not with other like Motif's mwm or kwm, because the
2406 latter generate ConfigureNotify events when the menu bar
2407 is switched off, which fixes the shell position. */
2408 Position x0
, y0
, x1
, y1
;
2414 if (f
->output_data
.x
->widget
)
2415 XtVaGetValues (f
->output_data
.x
->widget
, XtNx
, &x0
, XtNy
, &y0
, NULL
);
2418 lw_destroy_all_widgets ((LWLIB_ID
) f
->output_data
.x
->id
);
2419 f
->output_data
.x
->menubar_widget
= NULL
;
2422 if (f
->output_data
.x
->widget
)
2424 XtVaGetValues (f
->output_data
.x
->widget
, XtNx
, &x1
, XtNy
, &y1
, NULL
);
2425 if (x1
== 0 && y1
== 0)
2426 XtVaSetValues (f
->output_data
.x
->widget
, XtNx
, x0
, XtNy
, y0
, NULL
);
2433 #endif /* not USE_GTK */
2435 #endif /* USE_X_TOOLKIT || USE_GTK */
2437 /* xmenu_show actually displays a menu using the panes and items in menu_items
2438 and returns the value selected from it.
2439 There are two versions of xmenu_show, one for Xt and one for Xlib.
2440 Both assume input is blocked by the caller. */
2442 /* F is the frame the menu is for.
2443 X and Y are the frame-relative specified position,
2444 relative to the inside upper left corner of the frame F.
2445 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
2446 KEYMAPS is 1 if this menu was specified with keymaps;
2447 in that case, we return a list containing the chosen item's value
2448 and perhaps also the pane's prefix.
2449 TITLE is the specified menu title.
2450 ERROR is a place to store an error message string in case of failure.
2451 (We return nil on failure, but the value doesn't actually matter.) */
2453 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
2455 /* The item selected in the popup menu. */
2456 static Lisp_Object
*volatile menu_item_selection
;
2460 /* Used when position a popup menu. See menu_position_func and
2461 create_and_show_popup_menu below. */
2462 struct next_popup_x_y
2469 /* The menu position function to use if we are not putting a popup
2470 menu where the pointer is.
2471 MENU is the menu to pop up.
2472 X and Y shall on exit contain x/y where the menu shall pop up.
2473 PUSH_IN is not documented in the GTK manual.
2474 USER_DATA is any data passed in when calling gtk_menu_popup.
2475 Here it points to a struct next_popup_x_y where the coordinates
2476 to store in *X and *Y are as well as the frame for the popup.
2478 Here only X and Y are used. */
2480 menu_position_func (menu
, x
, y
, push_in
, user_data
)
2487 struct next_popup_x_y
* data
= (struct next_popup_x_y
*)user_data
;
2489 int disp_width
= FRAME_X_DISPLAY_INFO (data
->f
)->width
;
2490 int disp_height
= FRAME_X_DISPLAY_INFO (data
->f
)->height
;
2495 /* Check if there is room for the menu. If not, adjust x/y so that
2496 the menu is fully visible. */
2497 gtk_widget_size_request (GTK_WIDGET (menu
), &req
);
2498 if (data
->x
+ req
.width
> disp_width
)
2499 *x
-= data
->x
+ req
.width
- disp_width
;
2500 if (data
->y
+ req
.height
> disp_height
)
2501 *y
-= data
->y
+ req
.height
- disp_height
;
2505 popup_selection_callback (widget
, client_data
)
2507 gpointer client_data
;
2509 xg_menu_item_cb_data
*cb_data
= (xg_menu_item_cb_data
*) client_data
;
2511 if (xg_crazy_callback_abort
) return;
2512 if (cb_data
) menu_item_selection
= (Lisp_Object
*) cb_data
->call_data
;
2519 struct Lisp_Save_Value
*p
= XSAVE_VALUE (arg
);
2521 popup_activated_flag
= 0;
2523 gtk_widget_destroy (GTK_WIDGET (p
->pointer
));
2528 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
2530 menu_item_selection will be set to the selection. */
2532 create_and_show_popup_menu (f
, first_wv
, x
, y
, for_click
)
2534 widget_value
*first_wv
;
2541 GtkMenuPositionFunc pos_func
= 0; /* Pop up at pointer. */
2542 struct next_popup_x_y popup_x_y
;
2543 int specpdl_count
= SPECPDL_INDEX ();
2545 xg_crazy_callback_abort
= 1;
2546 menu
= xg_create_widget ("popup", first_wv
->name
, f
, first_wv
,
2547 G_CALLBACK (popup_selection_callback
),
2548 G_CALLBACK (popup_deactivate_callback
),
2549 G_CALLBACK (menu_highlight_callback
));
2550 xg_crazy_callback_abort
= 0;
2554 /* Not invoked by a click. pop up at x/y. */
2555 pos_func
= menu_position_func
;
2557 /* Adjust coordinates to be root-window-relative. */
2558 x
+= f
->left_pos
+ FRAME_OUTER_TO_INNER_DIFF_X (f
);
2559 y
+= f
->top_pos
+ FRAME_OUTER_TO_INNER_DIFF_Y (f
);
2565 i
= 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
2569 for (i
= 0; i
< 5; i
++)
2570 if (FRAME_X_DISPLAY_INFO (f
)->grabbed
& (1 << i
))
2574 /* Display the menu. */
2575 gtk_widget_show_all (menu
);
2576 gtk_menu_popup (GTK_MENU (menu
), 0, 0, pos_func
, &popup_x_y
, i
, 0);
2578 record_unwind_protect (pop_down_menu
, make_save_value (menu
, 0));
2580 if (GTK_WIDGET_MAPPED (menu
))
2582 /* Set this to one. popup_widget_loop increases it by one, so it becomes
2583 two. show_help_echo uses this to detect popup menus. */
2584 popup_activated_flag
= 1;
2585 /* Process events that apply to the menu. */
2586 popup_widget_loop (1, menu
);
2589 unbind_to (specpdl_count
, Qnil
);
2591 /* Must reset this manually because the button release event is not passed
2592 to Emacs event loop. */
2593 FRAME_X_DISPLAY_INFO (f
)->grabbed
= 0;
2596 #else /* not USE_GTK */
2598 /* We need a unique id for each widget handled by the Lucid Widget
2601 For the main windows, and popup menus, we use this counter,
2602 which we increment each time after use. This starts from 1<<16.
2604 For menu bars, we use numbers starting at 0, counted in
2605 next_menubar_widget_id. */
2606 LWLIB_ID widget_id_tick
;
2609 popup_selection_callback (widget
, id
, client_data
)
2612 XtPointer client_data
;
2614 menu_item_selection
= (Lisp_Object
*) client_data
;
2617 /* ARG is the LWLIB ID of the dialog box, represented
2618 as a Lisp object as (HIGHPART . LOWPART). */
2624 LWLIB_ID id
= (XINT (XCAR (arg
)) << 4 * sizeof (LWLIB_ID
)
2625 | XINT (XCDR (arg
)));
2628 lw_destroy_all_widgets (id
);
2630 popup_activated_flag
= 0;
2635 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
2637 menu_item_selection will be set to the selection. */
2639 create_and_show_popup_menu (f
, first_wv
, x
, y
, for_click
)
2641 widget_value
*first_wv
;
2649 XButtonPressedEvent dummy
;
2653 menu_id
= widget_id_tick
++;
2654 menu
= lw_create_widget ("popup", first_wv
->name
, menu_id
, first_wv
,
2655 f
->output_data
.x
->widget
, 1, 0,
2656 popup_selection_callback
,
2657 popup_deactivate_callback
,
2658 menu_highlight_callback
);
2660 dummy
.type
= ButtonPress
;
2662 dummy
.send_event
= 0;
2663 dummy
.display
= FRAME_X_DISPLAY (f
);
2664 dummy
.time
= CurrentTime
;
2665 dummy
.root
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
2666 dummy
.window
= dummy
.root
;
2667 dummy
.subwindow
= dummy
.root
;
2671 /* Adjust coordinates to be root-window-relative. */
2672 x
+= f
->left_pos
+ FRAME_OUTER_TO_INNER_DIFF_X (f
);
2673 y
+= f
->top_pos
+ FRAME_OUTER_TO_INNER_DIFF_Y (f
);
2680 for (i
= 0; i
< 5; i
++)
2681 if (FRAME_X_DISPLAY_INFO (f
)->grabbed
& (1 << i
))
2684 /* Don't allow any geometry request from the user. */
2685 XtSetArg (av
[ac
], XtNgeometry
, 0); ac
++;
2686 XtSetValues (menu
, av
, ac
);
2688 /* Display the menu. */
2689 lw_popup_menu (menu
, (XEvent
*) &dummy
);
2690 popup_activated_flag
= 1;
2693 int fact
= 4 * sizeof (LWLIB_ID
);
2694 int specpdl_count
= SPECPDL_INDEX ();
2695 record_unwind_protect (pop_down_menu
,
2696 Fcons (make_number (menu_id
>> (fact
)),
2697 make_number (menu_id
& ~(-1 << (fact
)))));
2699 /* Process events that apply to the menu. */
2700 popup_get_selection ((XEvent
*) 0, FRAME_X_DISPLAY_INFO (f
), menu_id
, 1);
2702 unbind_to (specpdl_count
, Qnil
);
2706 #endif /* not USE_GTK */
2709 xmenu_show (f
, x
, y
, for_click
, keymaps
, title
, error
)
2719 widget_value
*wv
, *save_wv
= 0, *first_wv
= 0, *prev_wv
= 0;
2720 widget_value
**submenu_stack
2721 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
2722 Lisp_Object
*subprefix_stack
2723 = (Lisp_Object
*) alloca (menu_items_used
* sizeof (Lisp_Object
));
2724 int submenu_depth
= 0;
2730 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
2732 *error
= "Empty menu";
2736 /* Create a tree of widget_value objects
2737 representing the panes and their items. */
2738 wv
= xmalloc_widget_value ();
2742 wv
->button_type
= BUTTON_TYPE_NONE
;
2747 /* Loop over all panes and items, filling in the tree. */
2749 while (i
< menu_items_used
)
2751 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qnil
))
2753 submenu_stack
[submenu_depth
++] = save_wv
;
2759 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qlambda
))
2762 save_wv
= submenu_stack
[--submenu_depth
];
2766 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
)
2767 && submenu_depth
!= 0)
2768 i
+= MENU_ITEMS_PANE_LENGTH
;
2769 /* Ignore a nil in the item list.
2770 It's meaningful only for dialog boxes. */
2771 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
2773 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
2775 /* Create a new pane. */
2776 Lisp_Object pane_name
, prefix
;
2779 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
2780 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
2782 #ifndef HAVE_MULTILINGUAL_MENU
2783 if (STRINGP (pane_name
) && STRING_MULTIBYTE (pane_name
))
2785 pane_name
= ENCODE_MENU_STRING (pane_name
);
2786 AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
) = pane_name
;
2789 pane_string
= (NILP (pane_name
)
2790 ? "" : (char *) SDATA (pane_name
));
2791 /* If there is just one top-level pane, put all its items directly
2792 under the top-level menu. */
2793 if (menu_items_n_panes
== 1)
2796 /* If the pane has a meaningful name,
2797 make the pane a top-level menu item
2798 with its items as a submenu beneath it. */
2799 if (!keymaps
&& strcmp (pane_string
, ""))
2801 wv
= xmalloc_widget_value ();
2805 first_wv
->contents
= wv
;
2806 wv
->name
= pane_string
;
2807 if (keymaps
&& !NILP (prefix
))
2811 wv
->button_type
= BUTTON_TYPE_NONE
;
2816 else if (first_pane
)
2822 i
+= MENU_ITEMS_PANE_LENGTH
;
2826 /* Create a new item within current pane. */
2827 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
, help
;
2828 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
2829 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
2830 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
2831 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
2832 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
2833 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
2834 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
2836 #ifndef HAVE_MULTILINGUAL_MENU
2837 if (STRINGP (item_name
) && STRING_MULTIBYTE (item_name
))
2839 item_name
= ENCODE_MENU_STRING (item_name
);
2840 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
) = item_name
;
2843 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
2845 descrip
= ENCODE_MENU_STRING (descrip
);
2846 AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
) = descrip
;
2848 #endif /* not HAVE_MULTILINGUAL_MENU */
2850 wv
= xmalloc_widget_value ();
2854 save_wv
->contents
= wv
;
2855 wv
->name
= (char *) SDATA (item_name
);
2856 if (!NILP (descrip
))
2857 wv
->key
= (char *) SDATA (descrip
);
2859 /* If this item has a null value,
2860 make the call_data null so that it won't display a box
2861 when the mouse is on it. */
2863 = (!NILP (def
) ? (void *) &XVECTOR (menu_items
)->contents
[i
] : 0);
2864 wv
->enabled
= !NILP (enable
);
2867 wv
->button_type
= BUTTON_TYPE_NONE
;
2868 else if (EQ (type
, QCtoggle
))
2869 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
2870 else if (EQ (type
, QCradio
))
2871 wv
->button_type
= BUTTON_TYPE_RADIO
;
2875 wv
->selected
= !NILP (selected
);
2877 if (! STRINGP (help
))
2884 i
+= MENU_ITEMS_ITEM_LENGTH
;
2888 /* Deal with the title, if it is non-nil. */
2891 widget_value
*wv_title
= xmalloc_widget_value ();
2892 widget_value
*wv_sep1
= xmalloc_widget_value ();
2893 widget_value
*wv_sep2
= xmalloc_widget_value ();
2895 wv_sep2
->name
= "--";
2896 wv_sep2
->next
= first_wv
->contents
;
2897 wv_sep2
->help
= Qnil
;
2899 wv_sep1
->name
= "--";
2900 wv_sep1
->next
= wv_sep2
;
2901 wv_sep1
->help
= Qnil
;
2903 #ifndef HAVE_MULTILINGUAL_MENU
2904 if (STRING_MULTIBYTE (title
))
2905 title
= ENCODE_MENU_STRING (title
);
2908 wv_title
->name
= (char *) SDATA (title
);
2909 wv_title
->enabled
= TRUE
;
2910 wv_title
->button_type
= BUTTON_TYPE_NONE
;
2911 wv_title
->next
= wv_sep1
;
2912 wv_title
->help
= Qnil
;
2913 first_wv
->contents
= wv_title
;
2916 /* No selection has been chosen yet. */
2917 menu_item_selection
= 0;
2919 /* Actually create and show the menu until popped down. */
2920 create_and_show_popup_menu (f
, first_wv
, x
, y
, for_click
);
2922 /* Free the widget_value objects we used to specify the contents. */
2923 free_menubar_widget_value_tree (first_wv
);
2925 /* Find the selected item, and its pane, to return
2926 the proper value. */
2927 if (menu_item_selection
!= 0)
2929 Lisp_Object prefix
, entry
;
2931 prefix
= entry
= Qnil
;
2933 while (i
< menu_items_used
)
2935 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qnil
))
2937 subprefix_stack
[submenu_depth
++] = prefix
;
2941 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qlambda
))
2943 prefix
= subprefix_stack
[--submenu_depth
];
2946 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
2949 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
2950 i
+= MENU_ITEMS_PANE_LENGTH
;
2952 /* Ignore a nil in the item list.
2953 It's meaningful only for dialog boxes. */
2954 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
2959 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
2960 if (menu_item_selection
== &XVECTOR (menu_items
)->contents
[i
])
2966 entry
= Fcons (entry
, Qnil
);
2968 entry
= Fcons (prefix
, entry
);
2969 for (j
= submenu_depth
- 1; j
>= 0; j
--)
2970 if (!NILP (subprefix_stack
[j
]))
2971 entry
= Fcons (subprefix_stack
[j
], entry
);
2975 i
+= MENU_ITEMS_ITEM_LENGTH
;
2979 else if (!for_click
)
2980 /* Make "Cancel" equivalent to C-g. */
2981 Fsignal (Qquit
, Qnil
);
2988 dialog_selection_callback (widget
, client_data
)
2990 gpointer client_data
;
2992 /* The EMACS_INT cast avoids a warning. There's no problem
2993 as long as pointers have enough bits to hold small integers. */
2994 if ((int) (EMACS_INT
) client_data
!= -1)
2995 menu_item_selection
= (Lisp_Object
*) client_data
;
2997 popup_activated_flag
= 0;
3000 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
3002 menu_item_selection will be set to the selection. */
3004 create_and_show_dialog (f
, first_wv
)
3006 widget_value
*first_wv
;
3010 menu
= xg_create_widget ("dialog", first_wv
->name
, f
, first_wv
,
3011 G_CALLBACK (dialog_selection_callback
),
3012 G_CALLBACK (popup_deactivate_callback
),
3017 int specpdl_count
= SPECPDL_INDEX ();
3018 record_unwind_protect (pop_down_menu
, make_save_value (menu
, 0));
3020 /* Display the menu. */
3021 gtk_widget_show_all (menu
);
3023 /* Process events that apply to the menu. */
3024 popup_widget_loop (1, menu
);
3026 unbind_to (specpdl_count
, Qnil
);
3030 #else /* not USE_GTK */
3032 dialog_selection_callback (widget
, id
, client_data
)
3035 XtPointer client_data
;
3037 /* The EMACS_INT cast avoids a warning. There's no problem
3038 as long as pointers have enough bits to hold small integers. */
3039 if ((int) (EMACS_INT
) client_data
!= -1)
3040 menu_item_selection
= (Lisp_Object
*) client_data
;
3043 lw_destroy_all_widgets (id
);
3045 popup_activated_flag
= 0;
3049 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
3051 menu_item_selection will be set to the selection. */
3053 create_and_show_dialog (f
, first_wv
)
3055 widget_value
*first_wv
;
3059 dialog_id
= widget_id_tick
++;
3060 lw_create_widget (first_wv
->name
, "dialog", dialog_id
, first_wv
,
3061 f
->output_data
.x
->widget
, 1, 0,
3062 dialog_selection_callback
, 0, 0);
3063 lw_modify_all_widgets (dialog_id
, first_wv
->contents
, True
);
3065 /* Display the dialog box. */
3066 lw_pop_up_all_widgets (dialog_id
);
3067 popup_activated_flag
= 1;
3069 /* Process events that apply to the dialog box.
3070 Also handle timers. */
3072 int count
= SPECPDL_INDEX ();
3073 int fact
= 4 * sizeof (LWLIB_ID
);
3075 /* xdialog_show_unwind is responsible for popping the dialog box down. */
3076 record_unwind_protect (pop_down_menu
,
3077 Fcons (make_number (dialog_id
>> (fact
)),
3078 make_number (dialog_id
& ~(-1 << (fact
)))));
3080 popup_get_selection ((XEvent
*) 0, FRAME_X_DISPLAY_INFO (f
),
3083 unbind_to (count
, Qnil
);
3087 #endif /* not USE_GTK */
3089 static char * button_names
[] = {
3090 "button1", "button2", "button3", "button4", "button5",
3091 "button6", "button7", "button8", "button9", "button10" };
3094 xdialog_show (f
, keymaps
, title
, header
, error_name
)
3097 Lisp_Object title
, header
;
3100 int i
, nb_buttons
=0;
3101 char dialog_name
[6];
3103 widget_value
*wv
, *first_wv
= 0, *prev_wv
= 0;
3105 /* Number of elements seen so far, before boundary. */
3107 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
3108 int boundary_seen
= 0;
3112 if (menu_items_n_panes
> 1)
3114 *error_name
= "Multiple panes in dialog box";
3118 /* Create a tree of widget_value objects
3119 representing the text label and buttons. */
3121 Lisp_Object pane_name
, prefix
;
3123 pane_name
= XVECTOR (menu_items
)->contents
[MENU_ITEMS_PANE_NAME
];
3124 prefix
= XVECTOR (menu_items
)->contents
[MENU_ITEMS_PANE_PREFIX
];
3125 pane_string
= (NILP (pane_name
)
3126 ? "" : (char *) SDATA (pane_name
));
3127 prev_wv
= xmalloc_widget_value ();
3128 prev_wv
->value
= pane_string
;
3129 if (keymaps
&& !NILP (prefix
))
3131 prev_wv
->enabled
= 1;
3132 prev_wv
->name
= "message";
3133 prev_wv
->help
= Qnil
;
3136 /* Loop over all panes and items, filling in the tree. */
3137 i
= MENU_ITEMS_PANE_LENGTH
;
3138 while (i
< menu_items_used
)
3141 /* Create a new item within current pane. */
3142 Lisp_Object item_name
, enable
, descrip
;
3143 item_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_NAME
];
3144 enable
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_ENABLE
];
3146 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_EQUIV_KEY
];
3148 if (NILP (item_name
))
3150 free_menubar_widget_value_tree (first_wv
);
3151 *error_name
= "Submenu in dialog items";
3154 if (EQ (item_name
, Qquote
))
3156 /* This is the boundary between left-side elts
3157 and right-side elts. Stop incrementing right_count. */
3162 if (nb_buttons
>= 9)
3164 free_menubar_widget_value_tree (first_wv
);
3165 *error_name
= "Too many dialog items";
3169 wv
= xmalloc_widget_value ();
3171 wv
->name
= (char *) button_names
[nb_buttons
];
3172 if (!NILP (descrip
))
3173 wv
->key
= (char *) SDATA (descrip
);
3174 wv
->value
= (char *) SDATA (item_name
);
3175 wv
->call_data
= (void *) &XVECTOR (menu_items
)->contents
[i
];
3176 wv
->enabled
= !NILP (enable
);
3180 if (! boundary_seen
)
3184 i
+= MENU_ITEMS_ITEM_LENGTH
;
3187 /* If the boundary was not specified,
3188 by default put half on the left and half on the right. */
3189 if (! boundary_seen
)
3190 left_count
= nb_buttons
- nb_buttons
/ 2;
3192 wv
= xmalloc_widget_value ();
3193 wv
->name
= dialog_name
;
3196 /* Frame title: 'Q' = Question, 'I' = Information.
3197 Can also have 'E' = Error if, one day, we want
3198 a popup for errors. */
3200 dialog_name
[0] = 'Q';
3202 dialog_name
[0] = 'I';
3204 /* Dialog boxes use a really stupid name encoding
3205 which specifies how many buttons to use
3206 and how many buttons are on the right. */
3207 dialog_name
[1] = '0' + nb_buttons
;
3208 dialog_name
[2] = 'B';
3209 dialog_name
[3] = 'R';
3210 /* Number of buttons to put on the right. */
3211 dialog_name
[4] = '0' + nb_buttons
- left_count
;
3213 wv
->contents
= first_wv
;
3217 /* No selection has been chosen yet. */
3218 menu_item_selection
= 0;
3220 /* Actually create and show the dialog. */
3221 create_and_show_dialog (f
, first_wv
);
3223 /* Free the widget_value objects we used to specify the contents. */
3224 free_menubar_widget_value_tree (first_wv
);
3226 /* Find the selected item, and its pane, to return
3227 the proper value. */
3228 if (menu_item_selection
!= 0)
3234 while (i
< menu_items_used
)
3238 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3241 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3242 i
+= MENU_ITEMS_PANE_LENGTH
;
3244 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
3246 /* This is the boundary between left-side elts and
3253 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
3254 if (menu_item_selection
== &XVECTOR (menu_items
)->contents
[i
])
3258 entry
= Fcons (entry
, Qnil
);
3260 entry
= Fcons (prefix
, entry
);
3264 i
+= MENU_ITEMS_ITEM_LENGTH
;
3269 /* Make "Cancel" equivalent to C-g. */
3270 Fsignal (Qquit
, Qnil
);
3275 #else /* not USE_X_TOOLKIT && not USE_GTK */
3277 /* The frame of the last activated non-toolkit menu bar.
3278 Used to generate menu help events. */
3280 static struct frame
*menu_help_frame
;
3283 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
3285 PANE is the pane number, and ITEM is the menu item number in
3286 the menu (currently not used).
3288 This cannot be done with generating a HELP_EVENT because
3289 XMenuActivate contains a loop that doesn't let Emacs process
3293 menu_help_callback (help_string
, pane
, item
)
3297 extern Lisp_Object Qmenu_item
;
3298 Lisp_Object
*first_item
;
3299 Lisp_Object pane_name
;
3300 Lisp_Object menu_object
;
3302 first_item
= XVECTOR (menu_items
)->contents
;
3303 if (EQ (first_item
[0], Qt
))
3304 pane_name
= first_item
[MENU_ITEMS_PANE_NAME
];
3305 else if (EQ (first_item
[0], Qquote
))
3306 /* This shouldn't happen, see xmenu_show. */
3307 pane_name
= empty_string
;
3309 pane_name
= first_item
[MENU_ITEMS_ITEM_NAME
];
3311 /* (menu-item MENU-NAME PANE-NUMBER) */
3312 menu_object
= Fcons (Qmenu_item
,
3314 Fcons (make_number (pane
), Qnil
)));
3315 show_help_echo (help_string
? build_string (help_string
) : Qnil
,
3316 Qnil
, menu_object
, make_number (item
), 1);
3323 struct Lisp_Save_Value
*p1
= XSAVE_VALUE (Fcar (arg
));
3324 struct Lisp_Save_Value
*p2
= XSAVE_VALUE (Fcdr (arg
));
3326 FRAME_PTR f
= p1
->pointer
;
3327 XMenu
*menu
= p2
->pointer
;
3331 XUngrabPointer (FRAME_X_DISPLAY (f
), CurrentTime
);
3332 XUngrabKeyboard (FRAME_X_DISPLAY (f
), CurrentTime
);
3334 XMenuDestroy (FRAME_X_DISPLAY (f
), menu
);
3336 #ifdef HAVE_X_WINDOWS
3337 /* Assume the mouse has moved out of the X window.
3338 If it has actually moved in, we will get an EnterNotify. */
3339 x_mouse_leave (FRAME_X_DISPLAY_INFO (f
));
3341 /* State that no mouse buttons are now held.
3342 (The oldXMenu code doesn't track this info for us.)
3343 That is not necessarily true, but the fiction leads to reasonable
3344 results, and it is a pain to ask which are actually held now. */
3345 FRAME_X_DISPLAY_INFO (f
)->grabbed
= 0;
3347 #endif /* HAVE_X_WINDOWS */
3356 xmenu_show (f
, x
, y
, for_click
, keymaps
, title
, error
)
3366 int pane
, selidx
, lpane
, status
;
3367 Lisp_Object entry
, pane_prefix
;
3369 int ulx
, uly
, width
, height
;
3370 int dispwidth
, dispheight
;
3371 int i
, j
, lines
, maxlines
;
3374 unsigned int dummy_uint
;
3375 int specpdl_count
= SPECPDL_INDEX ();
3378 if (menu_items_n_panes
== 0)
3381 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
3383 *error
= "Empty menu";
3387 /* Figure out which root window F is on. */
3388 XGetGeometry (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
), &root
,
3389 &dummy_int
, &dummy_int
, &dummy_uint
, &dummy_uint
,
3390 &dummy_uint
, &dummy_uint
);
3392 /* Make the menu on that window. */
3393 menu
= XMenuCreate (FRAME_X_DISPLAY (f
), root
, "emacs");
3396 *error
= "Can't create menu";
3400 /* Don't GC while we prepare and show the menu,
3401 because we give the oldxmenu library pointers to the
3402 contents of strings. */
3403 inhibit_garbage_collection ();
3405 #ifdef HAVE_X_WINDOWS
3406 /* Adjust coordinates to relative to the outer (window manager) window. */
3407 x
+= FRAME_OUTER_TO_INNER_DIFF_X (f
);
3408 y
+= FRAME_OUTER_TO_INNER_DIFF_Y (f
);
3409 #endif /* HAVE_X_WINDOWS */
3411 /* Adjust coordinates to be root-window-relative. */
3415 /* Create all the necessary panes and their items. */
3416 maxlines
= lines
= i
= 0;
3417 while (i
< menu_items_used
)
3419 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3421 /* Create a new pane. */
3422 Lisp_Object pane_name
, prefix
;
3425 maxlines
= max (maxlines
, lines
);
3427 pane_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_NAME
];
3428 prefix
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3429 pane_string
= (NILP (pane_name
)
3430 ? "" : (char *) SDATA (pane_name
));
3431 if (keymaps
&& !NILP (prefix
))
3434 lpane
= XMenuAddPane (FRAME_X_DISPLAY (f
), menu
, pane_string
, TRUE
);
3435 if (lpane
== XM_FAILURE
)
3437 XMenuDestroy (FRAME_X_DISPLAY (f
), menu
);
3438 *error
= "Can't create pane";
3441 i
+= MENU_ITEMS_PANE_LENGTH
;
3443 /* Find the width of the widest item in this pane. */
3446 while (j
< menu_items_used
)
3449 item
= XVECTOR (menu_items
)->contents
[j
];
3457 width
= SBYTES (item
);
3458 if (width
> maxwidth
)
3461 j
+= MENU_ITEMS_ITEM_LENGTH
;
3464 /* Ignore a nil in the item list.
3465 It's meaningful only for dialog boxes. */
3466 else if (EQ (XVECTOR (menu_items
)->contents
[i
], Qquote
))
3470 /* Create a new item within current pane. */
3471 Lisp_Object item_name
, enable
, descrip
, help
;
3472 unsigned char *item_data
;
3475 item_name
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_NAME
];
3476 enable
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_ENABLE
];
3478 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_EQUIV_KEY
];
3479 help
= XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_HELP
];
3480 help_string
= STRINGP (help
) ? SDATA (help
) : NULL
;
3482 if (!NILP (descrip
))
3484 int gap
= maxwidth
- SBYTES (item_name
);
3487 spacer
= Fmake_string (make_number (gap
), make_number (' '));
3488 item_name
= concat2 (item_name
, spacer
);
3489 item_name
= concat2 (item_name
, descrip
);
3490 item_data
= SDATA (item_name
);
3492 /* if alloca is fast, use that to make the space,
3493 to reduce gc needs. */
3495 = (unsigned char *) alloca (maxwidth
3496 + SBYTES (descrip
) + 1);
3497 bcopy (SDATA (item_name
), item_data
,
3498 SBYTES (item_name
));
3499 for (j
= SCHARS (item_name
); j
< maxwidth
; j
++)
3501 bcopy (SDATA (descrip
), item_data
+ j
,
3503 item_data
[j
+ SBYTES (descrip
)] = 0;
3507 item_data
= SDATA (item_name
);
3509 if (XMenuAddSelection (FRAME_X_DISPLAY (f
),
3510 menu
, lpane
, 0, item_data
,
3511 !NILP (enable
), help_string
)
3514 XMenuDestroy (FRAME_X_DISPLAY (f
), menu
);
3515 *error
= "Can't add selection to menu";
3518 i
+= MENU_ITEMS_ITEM_LENGTH
;
3523 maxlines
= max (maxlines
, lines
);
3525 /* All set and ready to fly. */
3526 XMenuRecompute (FRAME_X_DISPLAY (f
), menu
);
3527 dispwidth
= DisplayWidth (FRAME_X_DISPLAY (f
), FRAME_X_SCREEN_NUMBER (f
));
3528 dispheight
= DisplayHeight (FRAME_X_DISPLAY (f
), FRAME_X_SCREEN_NUMBER (f
));
3529 x
= min (x
, dispwidth
);
3530 y
= min (y
, dispheight
);
3533 XMenuLocate (FRAME_X_DISPLAY (f
), menu
, 0, 0, x
, y
,
3534 &ulx
, &uly
, &width
, &height
);
3535 if (ulx
+width
> dispwidth
)
3537 x
-= (ulx
+ width
) - dispwidth
;
3538 ulx
= dispwidth
- width
;
3540 if (uly
+height
> dispheight
)
3542 y
-= (uly
+ height
) - dispheight
;
3543 uly
= dispheight
- height
;
3545 if (ulx
< 0) x
-= ulx
;
3546 if (uly
< 0) y
-= uly
;
3550 /* If position was not given by a mouse click, adjust so upper left
3551 corner of the menu as a whole ends up at given coordinates. This
3552 is what x-popup-menu says in its documentation. */
3554 y
+= 1.5*height
/(maxlines
+2);
3557 XMenuSetAEQ (menu
, TRUE
);
3558 XMenuSetFreeze (menu
, TRUE
);
3562 XMenuActivateSetWaitFunction (x_menu_wait_for_event
, FRAME_X_DISPLAY (f
));
3565 record_unwind_protect (pop_down_menu
,
3566 Fcons (make_save_value (f
, 0),
3567 make_save_value (menu
, 0)));
3569 /* Help display under X won't work because XMenuActivate contains
3570 a loop that doesn't give Emacs a chance to process it. */
3571 menu_help_frame
= f
;
3572 status
= XMenuActivate (FRAME_X_DISPLAY (f
), menu
, &pane
, &selidx
,
3573 x
, y
, ButtonReleaseMask
, &datap
,
3574 menu_help_callback
);
3580 fprintf (stderr
, "pane= %d line = %d\n", panes
, selidx
);
3583 /* Find the item number SELIDX in pane number PANE. */
3585 while (i
< menu_items_used
)
3587 if (EQ (XVECTOR (menu_items
)->contents
[i
], Qt
))
3591 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_PANE_PREFIX
];
3593 i
+= MENU_ITEMS_PANE_LENGTH
;
3602 = XVECTOR (menu_items
)->contents
[i
+ MENU_ITEMS_ITEM_VALUE
];
3605 entry
= Fcons (entry
, Qnil
);
3606 if (!NILP (pane_prefix
))
3607 entry
= Fcons (pane_prefix
, entry
);
3613 i
+= MENU_ITEMS_ITEM_LENGTH
;
3619 *error
= "Can't activate menu";
3624 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
3625 the menu was invoked with a mouse event as POSITION). */
3627 Fsignal (Qquit
, Qnil
);
3632 unbind_to (specpdl_count
, Qnil
);
3637 #endif /* not USE_X_TOOLKIT */
3639 #endif /* HAVE_MENUS */
3644 staticpro (&menu_items
);
3646 menu_items_inuse
= Qnil
;
3648 Qdebug_on_next_call
= intern ("debug-on-next-call");
3649 staticpro (&Qdebug_on_next_call
);
3651 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
3652 doc
: /* Frame for which we are updating a menu.
3653 The enable predicate for a menu command should check this variable. */);
3654 Vmenu_updating_frame
= Qnil
;
3656 #ifdef USE_X_TOOLKIT
3657 widget_id_tick
= (1<<16);
3658 next_menubar_widget_id
= 1;
3661 defsubr (&Sx_popup_menu
);
3663 defsubr (&Sx_popup_dialog
);
3667 /* arch-tag: 92ea573c-398e-496e-ac73-2436f7d63242
3668 (do not change this comment) */