* keyboard.c (parse_modifiers_uncached, parse_modifiers):
[emacs.git] / src / xmenu.c
blob8ecef00c88ea55c16ed9e6ff5f0441910ecf409d
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* X pop-up deck-of-cards menu facility for GNU Emacs.
23 * Written by Jon Arnold and Roman Budzianowski
24 * Mods and rewrite by Robert Krawitz
28 /* Modified by Fred Pierresteguy on December 93
29 to make the popup menus and menubar use the Xt. */
31 /* Rewritten for clarity and GC protection by rms in Feb 94. */
33 #include <config.h>
35 #if 0 /* Why was this included? And without syssignal.h? */
36 /* On 4.3 this loses if it comes after xterm.h. */
37 #include <signal.h>
38 #endif
40 #include <stdio.h>
41 #include <setjmp.h>
43 #include "lisp.h"
44 #include "keyboard.h"
45 #include "keymap.h"
46 #include "frame.h"
47 #include "termhooks.h"
48 #include "window.h"
49 #include "blockinput.h"
50 #include "buffer.h"
51 #include "charset.h"
52 #include "coding.h"
53 #include "sysselect.h"
55 #ifdef MSDOS
56 #include "msdos.h"
57 #endif
59 #ifdef HAVE_X_WINDOWS
60 /* This may include sys/types.h, and that somehow loses
61 if this is not done before the other system files. */
62 #include "xterm.h"
63 #endif
65 /* Load sys/types.h if not already loaded.
66 In some systems loading it twice is suicidal. */
67 #ifndef makedev
68 #include <sys/types.h>
69 #endif
71 #include "dispextern.h"
73 #ifdef HAVE_X_WINDOWS
74 /* Defining HAVE_MULTILINGUAL_MENU would mean that the toolkit menu
75 code accepts the Emacs internal encoding. */
76 #undef HAVE_MULTILINGUAL_MENU
77 #ifdef USE_X_TOOLKIT
78 #include "widget.h"
79 #include <X11/Xlib.h>
80 #include <X11/IntrinsicP.h>
81 #include <X11/CoreP.h>
82 #include <X11/StringDefs.h>
83 #include <X11/Shell.h>
84 #ifdef USE_LUCID
85 #include "xsettings.h"
86 #include "../lwlib/xlwmenu.h"
87 #ifdef HAVE_XAW3D
88 #include <X11/Xaw3d/Paned.h>
89 #else /* !HAVE_XAW3D */
90 #include <X11/Xaw/Paned.h>
91 #endif /* HAVE_XAW3D */
92 #endif /* USE_LUCID */
93 #ifdef USE_MOTIF
94 #include "../lwlib/lwlib.h"
95 #endif
96 #else /* not USE_X_TOOLKIT */
97 #ifndef USE_GTK
98 #include "../oldXMenu/XMenu.h"
99 #endif
100 #endif /* not USE_X_TOOLKIT */
101 #endif /* HAVE_X_WINDOWS */
103 #ifdef USE_GTK
104 #include "gtkutil.h"
105 #endif
107 #include "menu.h"
109 #ifndef TRUE
110 #define TRUE 1
111 #define FALSE 0
112 #endif /* no TRUE */
114 Lisp_Object Qdebug_on_next_call;
116 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
117 static Lisp_Object xdialog_show (FRAME_PTR, int, Lisp_Object, Lisp_Object,
118 const char **);
119 #endif
121 static int update_frame_menubar (struct frame *);
123 /* Flag which when set indicates a dialog or menu has been posted by
124 Xt on behalf of one of the widget sets. */
125 static int popup_activated_flag;
128 #ifdef USE_X_TOOLKIT
130 static int next_menubar_widget_id;
132 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
134 static struct frame *
135 menubar_id_to_frame (LWLIB_ID id)
137 Lisp_Object tail, frame;
138 FRAME_PTR f;
140 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
142 frame = XCAR (tail);
143 if (!FRAMEP (frame))
144 continue;
145 f = XFRAME (frame);
146 if (!FRAME_WINDOW_P (f))
147 continue;
148 if (f->output_data.x->id == id)
149 return f;
151 return 0;
154 #endif
156 #ifdef HAVE_X_WINDOWS
157 /* Return the mouse position in *X and *Y. The coordinates are window
158 relative for the edit window in frame F.
159 This is for Fx_popup_menu. The mouse_position_hook can not
160 be used for X, as it returns window relative coordinates
161 for the window where the mouse is in. This could be the menu bar,
162 the scroll bar or the edit window. Fx_popup_menu needs to be
163 sure it is the edit window. */
164 void
165 mouse_position_for_popup (FRAME_PTR f, int *x, int *y)
167 Window root, dummy_window;
168 int dummy;
170 if (! FRAME_X_P (f))
171 abort ();
173 BLOCK_INPUT;
175 XQueryPointer (FRAME_X_DISPLAY (f),
176 DefaultRootWindow (FRAME_X_DISPLAY (f)),
178 /* The root window which contains the pointer. */
179 &root,
181 /* Window pointer is on, not used */
182 &dummy_window,
184 /* The position on that root window. */
185 x, y,
187 /* x/y in dummy_window coordinates, not used. */
188 &dummy, &dummy,
190 /* Modifier keys and pointer buttons, about which
191 we don't care. */
192 (unsigned int *) &dummy);
194 UNBLOCK_INPUT;
196 /* xmenu_show expects window coordinates, not root window
197 coordinates. Translate. */
198 *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
199 *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
202 #endif /* HAVE_X_WINDOWS */
204 #ifdef HAVE_MENUS
206 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
207 doc: /* Pop up a dialog box and return user's selection.
208 POSITION specifies which frame to use.
209 This is normally a mouse button event or a window or frame.
210 If POSITION is t, it means to use the frame the mouse is on.
211 The dialog box appears in the middle of the specified frame.
213 CONTENTS specifies the alternatives to display in the dialog box.
214 It is a list of the form (DIALOG ITEM1 ITEM2...).
215 Each ITEM is a cons cell (STRING . VALUE).
216 The return value is VALUE from the chosen item.
218 An ITEM may also be just a string--that makes a nonselectable item.
219 An ITEM may also be nil--that means to put all preceding items
220 on the left of the dialog box and all following items on the right.
221 \(By default, approximately half appear on each side.)
223 If HEADER is non-nil, the frame title for the box is "Information",
224 otherwise it is "Question".
226 If the user gets rid of the dialog box without making a valid choice,
227 for instance using the window manager, then this produces a quit and
228 `x-popup-dialog' does not return. */)
229 (Lisp_Object position, Lisp_Object contents, Lisp_Object header)
231 FRAME_PTR f = NULL;
232 Lisp_Object window;
234 check_x ();
236 /* Decode the first argument: find the window or frame to use. */
237 if (EQ (position, Qt)
238 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
239 || EQ (XCAR (position), Qtool_bar))))
241 #if 0 /* Using the frame the mouse is on may not be right. */
242 /* Use the mouse's current position. */
243 FRAME_PTR new_f = SELECTED_FRAME ();
244 Lisp_Object bar_window;
245 enum scroll_bar_part part;
246 unsigned long time;
247 Lisp_Object x, y;
249 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
251 if (new_f != 0)
252 XSETFRAME (window, new_f);
253 else
254 window = selected_window;
255 #endif
256 window = selected_window;
258 else if (CONSP (position))
260 Lisp_Object tem;
261 tem = Fcar (position);
262 if (CONSP (tem))
263 window = Fcar (Fcdr (position));
264 else
266 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
267 window = Fcar (tem); /* POSN_WINDOW (tem) */
270 else if (WINDOWP (position) || FRAMEP (position))
271 window = position;
272 else
273 window = Qnil;
275 /* Decode where to put the menu. */
277 if (FRAMEP (window))
278 f = XFRAME (window);
279 else if (WINDOWP (window))
281 CHECK_LIVE_WINDOW (window);
282 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
284 else
285 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
286 but I don't want to make one now. */
287 CHECK_WINDOW (window);
289 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
290 error ("Can not put X dialog on this terminal");
292 /* Force a redisplay before showing the dialog. If a frame is created
293 just before showing the dialog, its contents may not have been fully
294 drawn, as this depends on timing of events from the X server. Redisplay
295 is not done when a dialog is shown. If redisplay could be done in the
296 X event loop (i.e. the X event loop does not run in a signal handler)
297 this would not be needed.
299 Do this before creating the widget value that points to Lisp
300 string contents, because Fredisplay may GC and relocate them. */
301 Fredisplay (Qt);
303 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
304 /* Display a menu with these alternatives
305 in the middle of frame F. */
307 Lisp_Object x, y, frame, newpos;
308 XSETFRAME (frame, f);
309 XSETINT (x, x_pixel_width (f) / 2);
310 XSETINT (y, x_pixel_height (f) / 2);
311 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
313 return Fx_popup_menu (newpos,
314 Fcons (Fcar (contents), Fcons (contents, Qnil)));
316 #else
318 Lisp_Object title;
319 const char *error_name;
320 Lisp_Object selection;
321 int specpdl_count = SPECPDL_INDEX ();
323 /* Decode the dialog items from what was specified. */
324 title = Fcar (contents);
325 CHECK_STRING (title);
326 record_unwind_protect (unuse_menu_items, Qnil);
328 if (NILP (Fcar (Fcdr (contents))))
329 /* No buttons specified, add an "Ok" button so users can pop down
330 the dialog. Also, the lesstif/motif version crashes if there are
331 no buttons. */
332 contents = Fcons (title, Fcons (Fcons (build_string ("Ok"), Qt), Qnil));
334 list_of_panes (Fcons (contents, Qnil));
336 /* Display them in a dialog box. */
337 BLOCK_INPUT;
338 selection = xdialog_show (f, 0, title, header, &error_name);
339 UNBLOCK_INPUT;
341 unbind_to (specpdl_count, Qnil);
342 discard_menu_items ();
344 if (error_name) error (error_name);
345 return selection;
347 #endif
351 #ifndef MSDOS
353 /* Set menu_items_inuse so no other popup menu or dialog is created. */
355 void
356 x_menu_set_in_use (int in_use)
358 menu_items_inuse = in_use ? Qt : Qnil;
359 popup_activated_flag = in_use;
360 #ifdef USE_X_TOOLKIT
361 if (popup_activated_flag)
362 x_activate_timeout_atimer ();
363 #endif
366 /* Wait for an X event to arrive or for a timer to expire. */
368 void
369 x_menu_wait_for_event (void *data)
371 /* Another way to do this is to register a timer callback, that can be
372 done in GTK and Xt. But we have to do it like this when using only X
373 anyway, and with callbacks we would have three variants for timer handling
374 instead of the small ifdefs below. */
376 while (
377 #ifdef USE_X_TOOLKIT
378 ! XtAppPending (Xt_app_con)
379 #elif defined USE_GTK
380 ! gtk_events_pending ()
381 #else
382 ! XPending ((Display*) data)
383 #endif
386 EMACS_TIME next_time = timer_check (), *ntp;
387 long secs = EMACS_SECS (next_time);
388 long usecs = EMACS_USECS (next_time);
389 SELECT_TYPE read_fds;
390 struct x_display_info *dpyinfo;
391 int n = 0;
393 FD_ZERO (&read_fds);
394 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
396 int fd = ConnectionNumber (dpyinfo->display);
397 FD_SET (fd, &read_fds);
398 if (fd > n) n = fd;
399 XFlush (dpyinfo->display);
402 if (secs < 0 && usecs < 0)
403 ntp = 0;
404 else
405 ntp = &next_time;
407 select (n + 1, &read_fds, (SELECT_TYPE *)0, (SELECT_TYPE *)0, ntp);
410 #endif /* ! MSDOS */
413 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
415 #ifdef USE_X_TOOLKIT
417 /* Loop in Xt until the menu pulldown or dialog popup has been
418 popped down (deactivated). This is used for x-popup-menu
419 and x-popup-dialog; it is not used for the menu bar.
421 NOTE: All calls to popup_get_selection should be protected
422 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
424 static void
425 popup_get_selection (XEvent *initial_event, struct x_display_info *dpyinfo, LWLIB_ID id, int do_timers)
427 XEvent event;
429 while (popup_activated_flag)
431 if (initial_event)
433 event = *initial_event;
434 initial_event = 0;
436 else
438 if (do_timers) x_menu_wait_for_event (0);
439 XtAppNextEvent (Xt_app_con, &event);
442 /* Make sure we don't consider buttons grabbed after menu goes.
443 And make sure to deactivate for any ButtonRelease,
444 even if XtDispatchEvent doesn't do that. */
445 if (event.type == ButtonRelease
446 && dpyinfo->display == event.xbutton.display)
448 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
449 #ifdef USE_MOTIF /* Pretending that the event came from a
450 Btn1Down seems the only way to convince Motif to
451 activate its callbacks; setting the XmNmenuPost
452 isn't working. --marcus@sysc.pdx.edu. */
453 event.xbutton.button = 1;
454 /* Motif only pops down menus when no Ctrl, Alt or Mod
455 key is pressed and the button is released. So reset key state
456 so Motif thinks this is the case. */
457 event.xbutton.state = 0;
458 #endif
460 /* Pop down on C-g and Escape. */
461 else if (event.type == KeyPress
462 && dpyinfo->display == event.xbutton.display)
464 KeySym keysym = XLookupKeysym (&event.xkey, 0);
466 if ((keysym == XK_g && (event.xkey.state & ControlMask) != 0)
467 || keysym == XK_Escape) /* Any escape, ignore modifiers. */
468 popup_activated_flag = 0;
471 x_dispatch_event (&event, event.xany.display);
475 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
476 doc: /* Start key navigation of the menu bar in FRAME.
477 This initially opens the first menu bar item and you can then navigate with the
478 arrow keys, select a menu entry with the return key or cancel with the
479 escape key. If FRAME has no menu bar this function does nothing.
481 If FRAME is nil or not given, use the selected frame. */)
482 (Lisp_Object frame)
484 XEvent ev;
485 FRAME_PTR f = check_x_frame (frame);
486 Widget menubar;
487 BLOCK_INPUT;
489 if (FRAME_EXTERNAL_MENU_BAR (f))
490 set_frame_menubar (f, 0, 1);
492 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
493 if (menubar)
495 Window child;
496 int error_p = 0;
498 x_catch_errors (FRAME_X_DISPLAY (f));
499 memset (&ev, 0, sizeof ev);
500 ev.xbutton.display = FRAME_X_DISPLAY (f);
501 ev.xbutton.window = XtWindow (menubar);
502 ev.xbutton.root = FRAME_X_DISPLAY_INFO (f)->root_window;
503 ev.xbutton.time = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
504 ev.xbutton.button = Button1;
505 ev.xbutton.x = ev.xbutton.y = FRAME_MENUBAR_HEIGHT (f) / 2;
506 ev.xbutton.same_screen = True;
508 #ifdef USE_MOTIF
510 Arg al[2];
511 WidgetList list;
512 Cardinal nr;
513 XtSetArg (al[0], XtNchildren, &list);
514 XtSetArg (al[1], XtNnumChildren, &nr);
515 XtGetValues (menubar, al, 2);
516 ev.xbutton.window = XtWindow (list[0]);
518 #endif
520 XTranslateCoordinates (FRAME_X_DISPLAY (f),
521 /* From-window, to-window. */
522 ev.xbutton.window, ev.xbutton.root,
524 /* From-position, to-position. */
525 ev.xbutton.x, ev.xbutton.y,
526 &ev.xbutton.x_root, &ev.xbutton.y_root,
528 /* Child of win. */
529 &child);
530 error_p = x_had_errors_p (FRAME_X_DISPLAY (f));
531 x_uncatch_errors ();
533 if (! error_p)
535 ev.type = ButtonPress;
536 ev.xbutton.state = 0;
538 XtDispatchEvent (&ev);
539 ev.xbutton.type = ButtonRelease;
540 ev.xbutton.state = Button1Mask;
541 XtDispatchEvent (&ev);
545 UNBLOCK_INPUT;
547 return Qnil;
549 #endif /* USE_X_TOOLKIT */
552 #ifdef USE_GTK
553 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
554 doc: /* Start key navigation of the menu bar in FRAME.
555 This initially opens the first menu bar item and you can then navigate with the
556 arrow keys, select a menu entry with the return key or cancel with the
557 escape key. If FRAME has no menu bar this function does nothing.
559 If FRAME is nil or not given, use the selected frame. */)
560 (Lisp_Object frame)
562 GtkWidget *menubar;
563 FRAME_PTR f;
565 /* gcc 2.95 doesn't accept the FRAME_PTR declaration after
566 BLOCK_INPUT. */
568 BLOCK_INPUT;
569 f = check_x_frame (frame);
571 if (FRAME_EXTERNAL_MENU_BAR (f))
572 set_frame_menubar (f, 0, 1);
574 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
575 if (menubar)
577 /* Activate the first menu. */
578 GList *children = gtk_container_get_children (GTK_CONTAINER (menubar));
580 if (children)
582 g_signal_emit_by_name (children->data, "activate_item");
583 popup_activated_flag = 1;
584 g_list_free (children);
587 UNBLOCK_INPUT;
589 return Qnil;
592 /* Loop util popup_activated_flag is set to zero in a callback.
593 Used for popup menus and dialogs. */
595 static void
596 popup_widget_loop (int do_timers, GtkWidget *widget)
598 ++popup_activated_flag;
600 /* Process events in the Gtk event loop until done. */
601 while (popup_activated_flag)
603 if (do_timers) x_menu_wait_for_event (0);
604 gtk_main_iteration ();
607 #endif
609 /* Activate the menu bar of frame F.
610 This is called from keyboard.c when it gets the
611 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
613 To activate the menu bar, we use the X button-press event
614 that was saved in saved_menu_event.
615 That makes the toolkit do its thing.
617 But first we recompute the menu bar contents (the whole tree).
619 The reason for saving the button event until here, instead of
620 passing it to the toolkit right away, is that we can safely
621 execute Lisp code. */
623 void
624 x_activate_menubar (FRAME_PTR f)
626 if (! FRAME_X_P (f))
627 abort ();
629 if (!f->output_data.x->saved_menu_event->type)
630 return;
632 #ifdef USE_GTK
633 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
634 f->output_data.x->saved_menu_event->xany.window))
635 return;
636 #endif
638 set_frame_menubar (f, 0, 1);
639 BLOCK_INPUT;
640 popup_activated_flag = 1;
641 #ifdef USE_GTK
642 XPutBackEvent (f->output_data.x->display_info->display,
643 f->output_data.x->saved_menu_event);
644 #else
645 XtDispatchEvent (f->output_data.x->saved_menu_event);
646 #endif
647 UNBLOCK_INPUT;
649 /* Ignore this if we get it a second time. */
650 f->output_data.x->saved_menu_event->type = 0;
653 /* This callback is invoked when the user selects a menubar cascade
654 pushbutton, but before the pulldown menu is posted. */
656 #ifndef USE_GTK
657 static void
658 popup_activate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
660 popup_activated_flag = 1;
661 #ifdef USE_X_TOOLKIT
662 x_activate_timeout_atimer ();
663 #endif
665 #endif
667 /* This callback is invoked when a dialog or menu is finished being
668 used and has been unposted. */
670 #ifdef USE_GTK
671 static void
672 popup_deactivate_callback (GtkWidget *widget, gpointer client_data)
674 popup_activated_flag = 0;
676 #else
677 static void
678 popup_deactivate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
680 popup_activated_flag = 0;
682 #endif
685 /* Function that finds the frame for WIDGET and shows the HELP text
686 for that widget.
687 F is the frame if known, or NULL if not known. */
688 static void
689 show_help_event (FRAME_PTR f, xt_or_gtk_widget widget, Lisp_Object help)
691 Lisp_Object frame;
693 if (f)
695 XSETFRAME (frame, f);
696 kbd_buffer_store_help_event (frame, help);
698 else
700 #if 0 /* This code doesn't do anything useful. ++kfs */
701 /* WIDGET is the popup menu. It's parent is the frame's
702 widget. See which frame that is. */
703 xt_or_gtk_widget frame_widget = XtParent (widget);
704 Lisp_Object tail;
706 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
708 frame = XCAR (tail);
709 if (FRAMEP (frame)
710 && (f = XFRAME (frame),
711 FRAME_X_P (f) && f->output_data.x->widget == frame_widget))
712 break;
714 #endif
715 show_help_echo (help, Qnil, Qnil, Qnil);
719 /* Callback called when menu items are highlighted/unhighlighted
720 while moving the mouse over them. WIDGET is the menu bar or menu
721 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
722 the data structure for the menu item, or null in case of
723 unhighlighting. */
725 #ifdef USE_GTK
726 static void
727 menu_highlight_callback (GtkWidget *widget, gpointer call_data)
729 xg_menu_item_cb_data *cb_data;
730 Lisp_Object help;
732 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (widget),
733 XG_ITEM_DATA);
734 if (! cb_data) return;
736 help = call_data ? cb_data->help : Qnil;
738 /* If popup_activated_flag is greater than 1 we are in a popup menu.
739 Don't show help for them, they won't appear before the
740 popup is popped down. */
741 if (popup_activated_flag <= 1)
742 show_help_event (cb_data->cl_data->f, widget, help);
744 #else
745 static void
746 menu_highlight_callback (Widget widget, LWLIB_ID id, void *call_data)
748 struct frame *f;
749 Lisp_Object help;
751 widget_value *wv = (widget_value *) call_data;
753 help = wv ? wv->help : Qnil;
755 /* Determine the frame for the help event. */
756 f = menubar_id_to_frame (id);
758 show_help_event (f, widget, help);
760 #endif
762 #ifdef USE_GTK
763 /* Gtk calls callbacks just because we tell it what item should be
764 selected in a radio group. If this variable is set to a non-zero
765 value, we are creating menus and don't want callbacks right now.
767 static int xg_crazy_callback_abort;
769 /* This callback is called from the menu bar pulldown menu
770 when the user makes a selection.
771 Figure out what the user chose
772 and put the appropriate events into the keyboard buffer. */
773 static void
774 menubar_selection_callback (GtkWidget *widget, gpointer client_data)
776 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
778 if (xg_crazy_callback_abort)
779 return;
781 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
782 return;
784 /* For a group of radio buttons, GTK calls the selection callback first
785 for the item that was active before the selection and then for the one that
786 is active after the selection. For C-h k this means we get the help on
787 the deselected item and then the selected item is executed. Prevent that
788 by ignoring the non-active item. */
789 if (GTK_IS_RADIO_MENU_ITEM (widget)
790 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)))
791 return;
793 /* When a menu is popped down, X generates a focus event (i.e. focus
794 goes back to the frame below the menu). Since GTK buffers events,
795 we force it out here before the menu selection event. Otherwise
796 sit-for will exit at once if the focus event follows the menu selection
797 event. */
799 BLOCK_INPUT;
800 while (gtk_events_pending ())
801 gtk_main_iteration ();
802 UNBLOCK_INPUT;
804 find_and_call_menu_selection (cb_data->cl_data->f,
805 cb_data->cl_data->menu_bar_items_used,
806 cb_data->cl_data->menu_bar_vector,
807 cb_data->call_data);
810 #else /* not USE_GTK */
812 /* This callback is called from the menu bar pulldown menu
813 when the user makes a selection.
814 Figure out what the user chose
815 and put the appropriate events into the keyboard buffer. */
816 static void
817 menubar_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
819 FRAME_PTR f;
821 f = menubar_id_to_frame (id);
822 if (!f)
823 return;
824 find_and_call_menu_selection (f, f->menu_bar_items_used,
825 f->menu_bar_vector, client_data);
827 #endif /* not USE_GTK */
829 /* Recompute all the widgets of frame F, when the menu bar has been
830 changed. Value is non-zero if widgets were updated. */
832 static int
833 update_frame_menubar (FRAME_PTR f)
835 #ifdef USE_GTK
836 return xg_update_frame_menubar (f);
837 #else
838 struct x_output *x;
839 int columns, rows;
841 if (! FRAME_X_P (f))
842 abort ();
844 x = f->output_data.x;
846 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
847 return 0;
849 BLOCK_INPUT;
850 /* Save the size of the frame because the pane widget doesn't accept
851 to resize itself. So force it. */
852 columns = FRAME_COLS (f);
853 rows = FRAME_LINES (f);
855 /* Do the voodoo which means "I'm changing lots of things, don't try
856 to refigure sizes until I'm done." */
857 lw_refigure_widget (x->column_widget, False);
859 /* The order in which children are managed is the top to bottom
860 order in which they are displayed in the paned window. First,
861 remove the text-area widget. */
862 XtUnmanageChild (x->edit_widget);
864 /* Remove the menubar that is there now, and put up the menubar that
865 should be there. */
866 XtManageChild (x->menubar_widget);
867 XtMapWidget (x->menubar_widget);
868 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
870 /* Re-manage the text-area widget, and then thrash the sizes. */
871 XtManageChild (x->edit_widget);
872 lw_refigure_widget (x->column_widget, True);
874 /* Force the pane widget to resize itself with the right values. */
875 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
876 UNBLOCK_INPUT;
877 #endif
878 return 1;
881 #ifdef USE_LUCID
882 static void
883 apply_systemfont_to_dialog (Widget w)
885 const char *fn = xsettings_get_system_normal_font ();
886 if (fn)
888 XrmDatabase db = XtDatabase (XtDisplay (w));
889 if (db)
890 XrmPutStringResource (&db, "*dialog.font", fn);
894 static void
895 apply_systemfont_to_menu (struct frame *f, Widget w)
897 const char *fn = xsettings_get_system_normal_font ();
899 if (fn)
901 XrmDatabase db = XtDatabase (XtDisplay (w));
902 if (db)
904 XrmPutStringResource (&db, "*menubar*font", fn);
905 XrmPutStringResource (&db, "*popup*font", fn);
910 #endif
912 /* Set the contents of the menubar widgets of frame F.
913 The argument FIRST_TIME is currently ignored;
914 it is set the first time this is called, from initialize_frame_menubar. */
916 void
917 set_frame_menubar (FRAME_PTR f, int first_time, int deep_p)
919 xt_or_gtk_widget menubar_widget;
920 #ifdef USE_X_TOOLKIT
921 LWLIB_ID id;
922 #endif
923 Lisp_Object items;
924 widget_value *wv, *first_wv, *prev_wv = 0;
925 EMACS_UINT i, last_i = 0;
926 int *submenu_start, *submenu_end;
927 int *submenu_top_level_items, *submenu_n_panes;
929 if (! FRAME_X_P (f))
930 abort ();
932 menubar_widget = f->output_data.x->menubar_widget;
934 XSETFRAME (Vmenu_updating_frame, f);
936 #ifdef USE_X_TOOLKIT
937 if (f->output_data.x->id == 0)
938 f->output_data.x->id = next_menubar_widget_id++;
939 id = f->output_data.x->id;
940 #endif
942 if (! menubar_widget)
943 deep_p = 1;
944 /* Make the first call for any given frame always go deep. */
945 else if (!f->output_data.x->saved_menu_event && !deep_p)
947 deep_p = 1;
948 f->output_data.x->saved_menu_event = (XEvent*)xmalloc (sizeof (XEvent));
949 f->output_data.x->saved_menu_event->type = 0;
952 #ifdef USE_GTK
953 /* If we have detached menus, we must update deep so detached menus
954 also gets updated. */
955 deep_p = deep_p || xg_have_tear_offs ();
956 #endif
958 if (deep_p)
960 /* Make a widget-value tree representing the entire menu trees. */
962 struct buffer *prev = current_buffer;
963 Lisp_Object buffer;
964 int specpdl_count = SPECPDL_INDEX ();
965 int previous_menu_items_used = f->menu_bar_items_used;
966 Lisp_Object *previous_items
967 = (Lisp_Object *) alloca (previous_menu_items_used
968 * sizeof (Lisp_Object));
970 /* If we are making a new widget, its contents are empty,
971 do always reinitialize them. */
972 if (! menubar_widget)
973 previous_menu_items_used = 0;
975 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
976 specbind (Qinhibit_quit, Qt);
977 /* Don't let the debugger step into this code
978 because it is not reentrant. */
979 specbind (Qdebug_on_next_call, Qnil);
981 record_unwind_save_match_data ();
982 if (NILP (Voverriding_local_map_menu_flag))
984 specbind (Qoverriding_terminal_local_map, Qnil);
985 specbind (Qoverriding_local_map, Qnil);
988 set_buffer_internal_1 (XBUFFER (buffer));
990 /* Run the Lucid hook. */
991 safe_run_hooks (Qactivate_menubar_hook);
993 /* If it has changed current-menubar from previous value,
994 really recompute the menubar from the value. */
995 if (! NILP (Vlucid_menu_bar_dirty_flag))
996 call0 (Qrecompute_lucid_menubar);
997 safe_run_hooks (Qmenu_bar_update_hook);
998 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1000 items = FRAME_MENU_BAR_ITEMS (f);
1002 /* Save the frame's previous menu bar contents data. */
1003 if (previous_menu_items_used)
1004 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
1005 previous_menu_items_used * sizeof (Lisp_Object));
1007 /* Fill in menu_items with the current menu bar contents.
1008 This can evaluate Lisp code. */
1009 save_menu_items ();
1011 menu_items = f->menu_bar_vector;
1012 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
1013 submenu_start = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
1014 submenu_end = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
1015 submenu_n_panes = (int *) alloca (XVECTOR (items)->size * sizeof (int));
1016 submenu_top_level_items
1017 = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
1018 init_menu_items ();
1019 for (i = 0; i < XVECTOR (items)->size; i += 4)
1021 Lisp_Object key, string, maps;
1023 last_i = i;
1025 key = XVECTOR (items)->contents[i];
1026 string = XVECTOR (items)->contents[i + 1];
1027 maps = XVECTOR (items)->contents[i + 2];
1028 if (NILP (string))
1029 break;
1031 submenu_start[i] = menu_items_used;
1033 menu_items_n_panes = 0;
1034 submenu_top_level_items[i]
1035 = parse_single_submenu (key, string, maps);
1036 submenu_n_panes[i] = menu_items_n_panes;
1038 submenu_end[i] = menu_items_used;
1041 finish_menu_items ();
1043 /* Convert menu_items into widget_value trees
1044 to display the menu. This cannot evaluate Lisp code. */
1046 wv = xmalloc_widget_value ();
1047 wv->name = "menubar";
1048 wv->value = 0;
1049 wv->enabled = 1;
1050 wv->button_type = BUTTON_TYPE_NONE;
1051 wv->help = Qnil;
1052 first_wv = wv;
1054 for (i = 0; i < last_i; i += 4)
1056 menu_items_n_panes = submenu_n_panes[i];
1057 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
1058 submenu_top_level_items[i]);
1059 if (prev_wv)
1060 prev_wv->next = wv;
1061 else
1062 first_wv->contents = wv;
1063 /* Don't set wv->name here; GC during the loop might relocate it. */
1064 wv->enabled = 1;
1065 wv->button_type = BUTTON_TYPE_NONE;
1066 prev_wv = wv;
1069 set_buffer_internal_1 (prev);
1071 /* If there has been no change in the Lisp-level contents
1072 of the menu bar, skip redisplaying it. Just exit. */
1074 /* Compare the new menu items with the ones computed last time. */
1075 for (i = 0; i < previous_menu_items_used; i++)
1076 if (menu_items_used == i
1077 || (!EQ (previous_items[i], XVECTOR (menu_items)->contents[i])))
1078 break;
1079 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1081 /* The menu items have not changed. Don't bother updating
1082 the menus in any form, since it would be a no-op. */
1083 free_menubar_widget_value_tree (first_wv);
1084 discard_menu_items ();
1085 unbind_to (specpdl_count, Qnil);
1086 return;
1089 /* The menu items are different, so store them in the frame. */
1090 f->menu_bar_vector = menu_items;
1091 f->menu_bar_items_used = menu_items_used;
1093 /* This undoes save_menu_items. */
1094 unbind_to (specpdl_count, Qnil);
1096 /* Now GC cannot happen during the lifetime of the widget_value,
1097 so it's safe to store data from a Lisp_String. */
1098 wv = first_wv->contents;
1099 for (i = 0; i < XVECTOR (items)->size; i += 4)
1101 Lisp_Object string;
1102 string = XVECTOR (items)->contents[i + 1];
1103 if (NILP (string))
1104 break;
1105 wv->name = SSDATA (string);
1106 update_submenu_strings (wv->contents);
1107 wv = wv->next;
1111 else
1113 /* Make a widget-value tree containing
1114 just the top level menu bar strings. */
1116 wv = xmalloc_widget_value ();
1117 wv->name = "menubar";
1118 wv->value = 0;
1119 wv->enabled = 1;
1120 wv->button_type = BUTTON_TYPE_NONE;
1121 wv->help = Qnil;
1122 first_wv = wv;
1124 items = FRAME_MENU_BAR_ITEMS (f);
1125 for (i = 0; i < XVECTOR (items)->size; i += 4)
1127 Lisp_Object string;
1129 string = XVECTOR (items)->contents[i + 1];
1130 if (NILP (string))
1131 break;
1133 wv = xmalloc_widget_value ();
1134 wv->name = SSDATA (string);
1135 wv->value = 0;
1136 wv->enabled = 1;
1137 wv->button_type = BUTTON_TYPE_NONE;
1138 wv->help = Qnil;
1139 /* This prevents lwlib from assuming this
1140 menu item is really supposed to be empty. */
1141 /* The EMACS_INT cast avoids a warning.
1142 This value just has to be different from small integers. */
1143 wv->call_data = (void *) (EMACS_INT) (-1);
1145 if (prev_wv)
1146 prev_wv->next = wv;
1147 else
1148 first_wv->contents = wv;
1149 prev_wv = wv;
1152 /* Forget what we thought we knew about what is in the
1153 detailed contents of the menu bar menus.
1154 Changing the top level always destroys the contents. */
1155 f->menu_bar_items_used = 0;
1158 /* Create or update the menu bar widget. */
1160 BLOCK_INPUT;
1162 #ifdef USE_GTK
1163 xg_crazy_callback_abort = 1;
1164 if (menubar_widget)
1166 /* The fourth arg is DEEP_P, which says to consider the entire
1167 menu trees we supply, rather than just the menu bar item names. */
1168 xg_modify_menubar_widgets (menubar_widget,
1170 first_wv,
1171 deep_p,
1172 G_CALLBACK (menubar_selection_callback),
1173 G_CALLBACK (popup_deactivate_callback),
1174 G_CALLBACK (menu_highlight_callback));
1176 else
1178 menubar_widget
1179 = xg_create_widget ("menubar", "menubar", f, first_wv,
1180 G_CALLBACK (menubar_selection_callback),
1181 G_CALLBACK (popup_deactivate_callback),
1182 G_CALLBACK (menu_highlight_callback));
1184 f->output_data.x->menubar_widget = menubar_widget;
1188 #else /* not USE_GTK */
1189 if (menubar_widget)
1191 /* Disable resizing (done for Motif!) */
1192 lw_allow_resizing (f->output_data.x->widget, False);
1194 /* The third arg is DEEP_P, which says to consider the entire
1195 menu trees we supply, rather than just the menu bar item names. */
1196 lw_modify_all_widgets (id, first_wv, deep_p);
1198 /* Re-enable the edit widget to resize. */
1199 lw_allow_resizing (f->output_data.x->widget, True);
1201 else
1203 char menuOverride[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
1204 XtTranslations override = XtParseTranslationTable (menuOverride);
1206 #ifdef USE_LUCID
1207 apply_systemfont_to_menu (f, f->output_data.x->column_widget);
1208 #endif
1209 menubar_widget = lw_create_widget ("menubar", "menubar", id,
1210 first_wv,
1211 f->output_data.x->column_widget,
1213 popup_activate_callback,
1214 menubar_selection_callback,
1215 popup_deactivate_callback,
1216 menu_highlight_callback);
1217 f->output_data.x->menubar_widget = menubar_widget;
1219 /* Make menu pop down on C-g. */
1220 XtOverrideTranslations (menubar_widget, override);
1224 int menubar_size;
1225 if (f->output_data.x->menubar_widget)
1226 XtRealizeWidget (f->output_data.x->menubar_widget);
1228 menubar_size
1229 = (f->output_data.x->menubar_widget
1230 ? (f->output_data.x->menubar_widget->core.height
1231 + f->output_data.x->menubar_widget->core.border_width)
1232 : 0);
1234 #if 1 /* Experimentally, we now get the right results
1235 for -geometry -0-0 without this. 24 Aug 96, rms.
1236 Maybe so, but the menu bar size is missing the pixels so the
1237 WM size hints are off by these pixels. Jan D, oct 2009. */
1238 #ifdef USE_LUCID
1239 if (FRAME_EXTERNAL_MENU_BAR (f))
1241 Dimension ibw = 0;
1242 XtVaGetValues (f->output_data.x->column_widget,
1243 XtNinternalBorderWidth, &ibw, NULL);
1244 menubar_size += ibw;
1246 #endif /* USE_LUCID */
1247 #endif /* 1 */
1249 f->output_data.x->menubar_height = menubar_size;
1251 #endif /* not USE_GTK */
1253 free_menubar_widget_value_tree (first_wv);
1254 update_frame_menubar (f);
1256 #ifdef USE_GTK
1257 xg_crazy_callback_abort = 0;
1258 #endif
1260 UNBLOCK_INPUT;
1263 /* Called from Fx_create_frame to create the initial menubar of a frame
1264 before it is mapped, so that the window is mapped with the menubar already
1265 there instead of us tacking it on later and thrashing the window after it
1266 is visible. */
1268 void
1269 initialize_frame_menubar (FRAME_PTR f)
1271 /* This function is called before the first chance to redisplay
1272 the frame. It has to be, so the frame will have the right size. */
1273 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1274 set_frame_menubar (f, 1, 1);
1278 /* Get rid of the menu bar of frame F, and free its storage.
1279 This is used when deleting a frame, and when turning off the menu bar.
1280 For GTK this function is in gtkutil.c. */
1282 #ifndef USE_GTK
1283 void
1284 free_frame_menubar (FRAME_PTR f)
1286 Widget menubar_widget;
1288 if (! FRAME_X_P (f))
1289 abort ();
1291 menubar_widget = f->output_data.x->menubar_widget;
1293 f->output_data.x->menubar_height = 0;
1295 if (menubar_widget)
1297 #ifdef USE_MOTIF
1298 /* Removing the menu bar magically changes the shell widget's x
1299 and y position of (0, 0) which, when the menu bar is turned
1300 on again, leads to pull-down menuss appearing in strange
1301 positions near the upper-left corner of the display. This
1302 happens only with some window managers like twm and ctwm,
1303 but not with other like Motif's mwm or kwm, because the
1304 latter generate ConfigureNotify events when the menu bar
1305 is switched off, which fixes the shell position. */
1306 Position x0, y0, x1, y1;
1307 #endif
1309 BLOCK_INPUT;
1311 #ifdef USE_MOTIF
1312 if (f->output_data.x->widget)
1313 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
1314 #endif
1316 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1317 f->output_data.x->menubar_widget = NULL;
1319 if (f->output_data.x->widget)
1321 #ifdef USE_MOTIF
1322 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
1323 if (x1 == 0 && y1 == 0)
1324 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
1325 #endif
1326 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1328 UNBLOCK_INPUT;
1331 #endif /* not USE_GTK */
1333 #endif /* USE_X_TOOLKIT || USE_GTK */
1335 /* xmenu_show actually displays a menu using the panes and items in menu_items
1336 and returns the value selected from it.
1337 There are two versions of xmenu_show, one for Xt and one for Xlib.
1338 Both assume input is blocked by the caller. */
1340 /* F is the frame the menu is for.
1341 X and Y are the frame-relative specified position,
1342 relative to the inside upper left corner of the frame F.
1343 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
1344 KEYMAPS is 1 if this menu was specified with keymaps;
1345 in that case, we return a list containing the chosen item's value
1346 and perhaps also the pane's prefix.
1347 TITLE is the specified menu title.
1348 ERROR is a place to store an error message string in case of failure.
1349 (We return nil on failure, but the value doesn't actually matter.) */
1351 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1353 /* The item selected in the popup menu. */
1354 static Lisp_Object *volatile menu_item_selection;
1356 #ifdef USE_GTK
1358 /* Used when position a popup menu. See menu_position_func and
1359 create_and_show_popup_menu below. */
1360 struct next_popup_x_y
1362 FRAME_PTR f;
1363 int x;
1364 int y;
1367 /* The menu position function to use if we are not putting a popup
1368 menu where the pointer is.
1369 MENU is the menu to pop up.
1370 X and Y shall on exit contain x/y where the menu shall pop up.
1371 PUSH_IN is not documented in the GTK manual.
1372 USER_DATA is any data passed in when calling gtk_menu_popup.
1373 Here it points to a struct next_popup_x_y where the coordinates
1374 to store in *X and *Y are as well as the frame for the popup.
1376 Here only X and Y are used. */
1377 static void
1378 menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
1380 struct next_popup_x_y* data = (struct next_popup_x_y*)user_data;
1381 GtkRequisition req;
1382 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (data->f);
1383 int disp_width = x_display_pixel_width (dpyinfo);
1384 int disp_height = x_display_pixel_height (dpyinfo);
1386 *x = data->x;
1387 *y = data->y;
1389 /* Check if there is room for the menu. If not, adjust x/y so that
1390 the menu is fully visible. */
1391 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1392 if (data->x + req.width > disp_width)
1393 *x -= data->x + req.width - disp_width;
1394 if (data->y + req.height > disp_height)
1395 *y -= data->y + req.height - disp_height;
1398 static void
1399 popup_selection_callback (GtkWidget *widget, gpointer client_data)
1401 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
1403 if (xg_crazy_callback_abort) return;
1404 if (cb_data) menu_item_selection = (Lisp_Object *) cb_data->call_data;
1407 static Lisp_Object
1408 pop_down_menu (Lisp_Object arg)
1410 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1412 popup_activated_flag = 0;
1413 BLOCK_INPUT;
1414 gtk_widget_destroy (GTK_WIDGET (p->pointer));
1415 UNBLOCK_INPUT;
1416 return Qnil;
1419 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1420 menu pops down.
1421 menu_item_selection will be set to the selection. */
1422 static void
1423 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv, int x, int y, int for_click, EMACS_UINT timestamp)
1425 int i;
1426 GtkWidget *menu;
1427 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
1428 struct next_popup_x_y popup_x_y;
1429 int specpdl_count = SPECPDL_INDEX ();
1431 if (! FRAME_X_P (f))
1432 abort ();
1434 xg_crazy_callback_abort = 1;
1435 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
1436 G_CALLBACK (popup_selection_callback),
1437 G_CALLBACK (popup_deactivate_callback),
1438 G_CALLBACK (menu_highlight_callback));
1439 xg_crazy_callback_abort = 0;
1441 if (! for_click)
1443 /* Not invoked by a click. pop up at x/y. */
1444 pos_func = menu_position_func;
1446 /* Adjust coordinates to be root-window-relative. */
1447 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1448 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1450 popup_x_y.x = x;
1451 popup_x_y.y = y;
1452 popup_x_y.f = f;
1454 i = 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
1456 else
1458 for (i = 0; i < 5; i++)
1459 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1460 break;
1463 /* Display the menu. */
1464 gtk_widget_show_all (menu);
1466 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i,
1467 timestamp > 0 ? timestamp : gtk_get_current_event_time());
1469 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
1471 if (gtk_widget_get_mapped (menu))
1473 /* Set this to one. popup_widget_loop increases it by one, so it becomes
1474 two. show_help_echo uses this to detect popup menus. */
1475 popup_activated_flag = 1;
1476 /* Process events that apply to the menu. */
1477 popup_widget_loop (1, menu);
1480 unbind_to (specpdl_count, Qnil);
1482 /* Must reset this manually because the button release event is not passed
1483 to Emacs event loop. */
1484 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
1487 #else /* not USE_GTK */
1489 /* We need a unique id for each widget handled by the Lucid Widget
1490 library.
1492 For the main windows, and popup menus, we use this counter,
1493 which we increment each time after use. This starts from 1<<16.
1495 For menu bars, we use numbers starting at 0, counted in
1496 next_menubar_widget_id. */
1497 LWLIB_ID widget_id_tick;
1499 static void
1500 popup_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1502 menu_item_selection = (Lisp_Object *) client_data;
1505 /* ARG is the LWLIB ID of the dialog box, represented
1506 as a Lisp object as (HIGHPART . LOWPART). */
1508 static Lisp_Object
1509 pop_down_menu (Lisp_Object arg)
1511 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
1512 | XINT (XCDR (arg)));
1514 BLOCK_INPUT;
1515 lw_destroy_all_widgets (id);
1516 UNBLOCK_INPUT;
1517 popup_activated_flag = 0;
1519 return Qnil;
1522 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1523 menu pops down.
1524 menu_item_selection will be set to the selection. */
1525 static void
1526 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv,
1527 int x, int y, int for_click, EMACS_UINT timestamp)
1529 int i;
1530 Arg av[2];
1531 int ac = 0;
1532 XButtonPressedEvent dummy;
1533 LWLIB_ID menu_id;
1534 Widget menu;
1536 if (! FRAME_X_P (f))
1537 abort ();
1539 #ifdef USE_LUCID
1540 apply_systemfont_to_menu (f, f->output_data.x->widget);
1541 #endif
1543 menu_id = widget_id_tick++;
1544 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
1545 f->output_data.x->widget, 1, 0,
1546 popup_selection_callback,
1547 popup_deactivate_callback,
1548 menu_highlight_callback);
1550 dummy.type = ButtonPress;
1551 dummy.serial = 0;
1552 dummy.send_event = 0;
1553 dummy.display = FRAME_X_DISPLAY (f);
1554 dummy.time = CurrentTime;
1555 dummy.root = FRAME_X_DISPLAY_INFO (f)->root_window;
1556 dummy.window = dummy.root;
1557 dummy.subwindow = dummy.root;
1558 dummy.x = x;
1559 dummy.y = y;
1561 /* Adjust coordinates to be root-window-relative. */
1562 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1563 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1565 dummy.x_root = x;
1566 dummy.y_root = y;
1568 dummy.state = 0;
1569 dummy.button = 0;
1570 for (i = 0; i < 5; i++)
1571 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1572 dummy.button = i;
1574 /* Don't allow any geometry request from the user. */
1575 XtSetArg (av[ac], XtNgeometry, 0); ac++;
1576 XtSetValues (menu, av, ac);
1578 /* Display the menu. */
1579 lw_popup_menu (menu, (XEvent *) &dummy);
1580 popup_activated_flag = 1;
1581 x_activate_timeout_atimer ();
1584 int fact = 4 * sizeof (LWLIB_ID);
1585 int specpdl_count = SPECPDL_INDEX ();
1586 record_unwind_protect (pop_down_menu,
1587 Fcons (make_number (menu_id >> (fact)),
1588 make_number (menu_id & ~(-1 << (fact)))));
1590 /* Process events that apply to the menu. */
1591 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), menu_id, 1);
1593 unbind_to (specpdl_count, Qnil);
1597 #endif /* not USE_GTK */
1599 Lisp_Object
1600 xmenu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
1601 Lisp_Object title, const char **error_name, EMACS_UINT timestamp)
1603 int i;
1604 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1605 widget_value **submenu_stack
1606 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1607 Lisp_Object *subprefix_stack
1608 = (Lisp_Object *) alloca (menu_items_used * sizeof (Lisp_Object));
1609 int submenu_depth = 0;
1611 int first_pane;
1613 if (! FRAME_X_P (f))
1614 abort ();
1616 *error_name = NULL;
1618 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1620 *error_name = "Empty menu";
1621 return Qnil;
1624 /* Create a tree of widget_value objects
1625 representing the panes and their items. */
1626 wv = xmalloc_widget_value ();
1627 wv->name = "menu";
1628 wv->value = 0;
1629 wv->enabled = 1;
1630 wv->button_type = BUTTON_TYPE_NONE;
1631 wv->help =Qnil;
1632 first_wv = wv;
1633 first_pane = 1;
1635 /* Loop over all panes and items, filling in the tree. */
1636 i = 0;
1637 while (i < menu_items_used)
1639 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1641 submenu_stack[submenu_depth++] = save_wv;
1642 save_wv = prev_wv;
1643 prev_wv = 0;
1644 first_pane = 1;
1645 i++;
1647 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
1649 prev_wv = save_wv;
1650 save_wv = submenu_stack[--submenu_depth];
1651 first_pane = 0;
1652 i++;
1654 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
1655 && submenu_depth != 0)
1656 i += MENU_ITEMS_PANE_LENGTH;
1657 /* Ignore a nil in the item list.
1658 It's meaningful only for dialog boxes. */
1659 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
1660 i += 1;
1661 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
1663 /* Create a new pane. */
1664 Lisp_Object pane_name, prefix;
1665 const char *pane_string;
1667 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1668 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1670 #ifndef HAVE_MULTILINGUAL_MENU
1671 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1673 pane_name = ENCODE_MENU_STRING (pane_name);
1674 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1676 #endif
1677 pane_string = (NILP (pane_name)
1678 ? "" : SSDATA (pane_name));
1679 /* If there is just one top-level pane, put all its items directly
1680 under the top-level menu. */
1681 if (menu_items_n_panes == 1)
1682 pane_string = "";
1684 /* If the pane has a meaningful name,
1685 make the pane a top-level menu item
1686 with its items as a submenu beneath it. */
1687 if (!keymaps && strcmp (pane_string, ""))
1689 wv = xmalloc_widget_value ();
1690 if (save_wv)
1691 save_wv->next = wv;
1692 else
1693 first_wv->contents = wv;
1694 wv->name = pane_string;
1695 if (keymaps && !NILP (prefix))
1696 wv->name++;
1697 wv->value = 0;
1698 wv->enabled = 1;
1699 wv->button_type = BUTTON_TYPE_NONE;
1700 wv->help = Qnil;
1701 save_wv = wv;
1702 prev_wv = 0;
1704 else if (first_pane)
1706 save_wv = wv;
1707 prev_wv = 0;
1709 first_pane = 0;
1710 i += MENU_ITEMS_PANE_LENGTH;
1712 else
1714 /* Create a new item within current pane. */
1715 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1716 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1717 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1718 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1719 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1720 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1721 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1722 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1724 #ifndef HAVE_MULTILINGUAL_MENU
1725 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
1727 item_name = ENCODE_MENU_STRING (item_name);
1728 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1731 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1733 descrip = ENCODE_MENU_STRING (descrip);
1734 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1736 #endif /* not HAVE_MULTILINGUAL_MENU */
1738 wv = xmalloc_widget_value ();
1739 if (prev_wv)
1740 prev_wv->next = wv;
1741 else
1742 save_wv->contents = wv;
1743 wv->name = SSDATA (item_name);
1744 if (!NILP (descrip))
1745 wv->key = SSDATA (descrip);
1746 wv->value = 0;
1747 /* If this item has a null value,
1748 make the call_data null so that it won't display a box
1749 when the mouse is on it. */
1750 wv->call_data
1751 = (!NILP (def) ? (void *) &XVECTOR (menu_items)->contents[i] : 0);
1752 wv->enabled = !NILP (enable);
1754 if (NILP (type))
1755 wv->button_type = BUTTON_TYPE_NONE;
1756 else if (EQ (type, QCtoggle))
1757 wv->button_type = BUTTON_TYPE_TOGGLE;
1758 else if (EQ (type, QCradio))
1759 wv->button_type = BUTTON_TYPE_RADIO;
1760 else
1761 abort ();
1763 wv->selected = !NILP (selected);
1765 if (! STRINGP (help))
1766 help = Qnil;
1768 wv->help = help;
1770 prev_wv = wv;
1772 i += MENU_ITEMS_ITEM_LENGTH;
1776 /* Deal with the title, if it is non-nil. */
1777 if (!NILP (title))
1779 widget_value *wv_title = xmalloc_widget_value ();
1780 widget_value *wv_sep1 = xmalloc_widget_value ();
1781 widget_value *wv_sep2 = xmalloc_widget_value ();
1783 wv_sep2->name = "--";
1784 wv_sep2->next = first_wv->contents;
1785 wv_sep2->help = Qnil;
1787 wv_sep1->name = "--";
1788 wv_sep1->next = wv_sep2;
1789 wv_sep1->help = Qnil;
1791 #ifndef HAVE_MULTILINGUAL_MENU
1792 if (STRING_MULTIBYTE (title))
1793 title = ENCODE_MENU_STRING (title);
1794 #endif
1796 wv_title->name = SSDATA (title);
1797 wv_title->enabled = TRUE;
1798 wv_title->button_type = BUTTON_TYPE_NONE;
1799 wv_title->help = Qnil;
1800 wv_title->next = wv_sep1;
1801 first_wv->contents = wv_title;
1804 /* No selection has been chosen yet. */
1805 menu_item_selection = 0;
1807 /* Actually create and show the menu until popped down. */
1808 create_and_show_popup_menu (f, first_wv, x, y, for_click, timestamp);
1810 /* Free the widget_value objects we used to specify the contents. */
1811 free_menubar_widget_value_tree (first_wv);
1813 /* Find the selected item, and its pane, to return
1814 the proper value. */
1815 if (menu_item_selection != 0)
1817 Lisp_Object prefix, entry;
1819 prefix = entry = Qnil;
1820 i = 0;
1821 while (i < menu_items_used)
1823 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1825 subprefix_stack[submenu_depth++] = prefix;
1826 prefix = entry;
1827 i++;
1829 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
1831 prefix = subprefix_stack[--submenu_depth];
1832 i++;
1834 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
1836 prefix
1837 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
1838 i += MENU_ITEMS_PANE_LENGTH;
1840 /* Ignore a nil in the item list.
1841 It's meaningful only for dialog boxes. */
1842 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
1843 i += 1;
1844 else
1846 entry
1847 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
1848 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
1850 if (keymaps != 0)
1852 int j;
1854 entry = Fcons (entry, Qnil);
1855 if (!NILP (prefix))
1856 entry = Fcons (prefix, entry);
1857 for (j = submenu_depth - 1; j >= 0; j--)
1858 if (!NILP (subprefix_stack[j]))
1859 entry = Fcons (subprefix_stack[j], entry);
1861 return entry;
1863 i += MENU_ITEMS_ITEM_LENGTH;
1867 else if (!for_click)
1868 /* Make "Cancel" equivalent to C-g. */
1869 Fsignal (Qquit, Qnil);
1871 return Qnil;
1874 #ifdef USE_GTK
1875 static void
1876 dialog_selection_callback (GtkWidget *widget, gpointer client_data)
1878 /* The EMACS_INT cast avoids a warning. There's no problem
1879 as long as pointers have enough bits to hold small integers. */
1880 if ((int) (EMACS_INT) client_data != -1)
1881 menu_item_selection = (Lisp_Object *) client_data;
1883 popup_activated_flag = 0;
1886 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1887 dialog pops down.
1888 menu_item_selection will be set to the selection. */
1889 static void
1890 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1892 GtkWidget *menu;
1894 if (! FRAME_X_P (f))
1895 abort ();
1897 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
1898 G_CALLBACK (dialog_selection_callback),
1899 G_CALLBACK (popup_deactivate_callback),
1902 if (menu)
1904 int specpdl_count = SPECPDL_INDEX ();
1905 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
1907 /* Display the menu. */
1908 gtk_widget_show_all (menu);
1910 /* Process events that apply to the menu. */
1911 popup_widget_loop (1, menu);
1913 unbind_to (specpdl_count, Qnil);
1917 #else /* not USE_GTK */
1918 static void
1919 dialog_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1921 /* The EMACS_INT cast avoids a warning. There's no problem
1922 as long as pointers have enough bits to hold small integers. */
1923 if ((int) (EMACS_INT) client_data != -1)
1924 menu_item_selection = (Lisp_Object *) client_data;
1926 BLOCK_INPUT;
1927 lw_destroy_all_widgets (id);
1928 UNBLOCK_INPUT;
1929 popup_activated_flag = 0;
1933 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1934 dialog pops down.
1935 menu_item_selection will be set to the selection. */
1936 static void
1937 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1939 LWLIB_ID dialog_id;
1941 if (!FRAME_X_P (f))
1942 abort();
1944 dialog_id = widget_id_tick++;
1945 #ifdef USE_LUCID
1946 apply_systemfont_to_dialog (f->output_data.x->widget);
1947 #endif
1948 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
1949 f->output_data.x->widget, 1, 0,
1950 dialog_selection_callback, 0, 0);
1951 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
1952 /* Display the dialog box. */
1953 lw_pop_up_all_widgets (dialog_id);
1954 popup_activated_flag = 1;
1955 x_activate_timeout_atimer ();
1957 /* Process events that apply to the dialog box.
1958 Also handle timers. */
1960 int count = SPECPDL_INDEX ();
1961 int fact = 4 * sizeof (LWLIB_ID);
1963 /* xdialog_show_unwind is responsible for popping the dialog box down. */
1964 record_unwind_protect (pop_down_menu,
1965 Fcons (make_number (dialog_id >> (fact)),
1966 make_number (dialog_id & ~(-1 << (fact)))));
1968 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f),
1969 dialog_id, 1);
1971 unbind_to (count, Qnil);
1975 #endif /* not USE_GTK */
1977 static const char * button_names [] = {
1978 "button1", "button2", "button3", "button4", "button5",
1979 "button6", "button7", "button8", "button9", "button10" };
1981 static Lisp_Object
1982 xdialog_show (FRAME_PTR f,
1983 int keymaps,
1984 Lisp_Object title,
1985 Lisp_Object header,
1986 const char **error_name)
1988 int i, nb_buttons=0;
1989 char dialog_name[6];
1991 widget_value *wv, *first_wv = 0, *prev_wv = 0;
1993 /* Number of elements seen so far, before boundary. */
1994 int left_count = 0;
1995 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
1996 int boundary_seen = 0;
1998 if (! FRAME_X_P (f))
1999 abort ();
2001 *error_name = NULL;
2003 if (menu_items_n_panes > 1)
2005 *error_name = "Multiple panes in dialog box";
2006 return Qnil;
2009 /* Create a tree of widget_value objects
2010 representing the text label and buttons. */
2012 Lisp_Object pane_name, prefix;
2013 const char *pane_string;
2014 pane_name = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME];
2015 prefix = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_PREFIX];
2016 pane_string = (NILP (pane_name)
2017 ? "" : SSDATA (pane_name));
2018 prev_wv = xmalloc_widget_value ();
2019 prev_wv->value = pane_string;
2020 if (keymaps && !NILP (prefix))
2021 prev_wv->name++;
2022 prev_wv->enabled = 1;
2023 prev_wv->name = "message";
2024 prev_wv->help = Qnil;
2025 first_wv = prev_wv;
2027 /* Loop over all panes and items, filling in the tree. */
2028 i = MENU_ITEMS_PANE_LENGTH;
2029 while (i < menu_items_used)
2032 /* Create a new item within current pane. */
2033 Lisp_Object item_name, enable, descrip;
2034 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2035 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2036 descrip
2037 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2039 if (NILP (item_name))
2041 free_menubar_widget_value_tree (first_wv);
2042 *error_name = "Submenu in dialog items";
2043 return Qnil;
2045 if (EQ (item_name, Qquote))
2047 /* This is the boundary between left-side elts
2048 and right-side elts. Stop incrementing right_count. */
2049 boundary_seen = 1;
2050 i++;
2051 continue;
2053 if (nb_buttons >= 9)
2055 free_menubar_widget_value_tree (first_wv);
2056 *error_name = "Too many dialog items";
2057 return Qnil;
2060 wv = xmalloc_widget_value ();
2061 prev_wv->next = wv;
2062 wv->name = (char *) button_names[nb_buttons];
2063 if (!NILP (descrip))
2064 wv->key = SSDATA (descrip);
2065 wv->value = SSDATA (item_name);
2066 wv->call_data = (void *) &XVECTOR (menu_items)->contents[i];
2067 wv->enabled = !NILP (enable);
2068 wv->help = Qnil;
2069 prev_wv = wv;
2071 if (! boundary_seen)
2072 left_count++;
2074 nb_buttons++;
2075 i += MENU_ITEMS_ITEM_LENGTH;
2078 /* If the boundary was not specified,
2079 by default put half on the left and half on the right. */
2080 if (! boundary_seen)
2081 left_count = nb_buttons - nb_buttons / 2;
2083 wv = xmalloc_widget_value ();
2084 wv->name = dialog_name;
2085 wv->help = Qnil;
2087 /* Frame title: 'Q' = Question, 'I' = Information.
2088 Can also have 'E' = Error if, one day, we want
2089 a popup for errors. */
2090 if (NILP(header))
2091 dialog_name[0] = 'Q';
2092 else
2093 dialog_name[0] = 'I';
2095 /* Dialog boxes use a really stupid name encoding
2096 which specifies how many buttons to use
2097 and how many buttons are on the right. */
2098 dialog_name[1] = '0' + nb_buttons;
2099 dialog_name[2] = 'B';
2100 dialog_name[3] = 'R';
2101 /* Number of buttons to put on the right. */
2102 dialog_name[4] = '0' + nb_buttons - left_count;
2103 dialog_name[5] = 0;
2104 wv->contents = first_wv;
2105 first_wv = wv;
2108 /* No selection has been chosen yet. */
2109 menu_item_selection = 0;
2111 /* Actually create and show the dialog. */
2112 create_and_show_dialog (f, first_wv);
2114 /* Free the widget_value objects we used to specify the contents. */
2115 free_menubar_widget_value_tree (first_wv);
2117 /* Find the selected item, and its pane, to return
2118 the proper value. */
2119 if (menu_item_selection != 0)
2121 Lisp_Object prefix;
2123 prefix = Qnil;
2124 i = 0;
2125 while (i < menu_items_used)
2127 Lisp_Object entry;
2129 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2131 prefix
2132 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2133 i += MENU_ITEMS_PANE_LENGTH;
2135 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2137 /* This is the boundary between left-side elts and
2138 right-side elts. */
2139 ++i;
2141 else
2143 entry
2144 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2145 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
2147 if (keymaps != 0)
2149 entry = Fcons (entry, Qnil);
2150 if (!NILP (prefix))
2151 entry = Fcons (prefix, entry);
2153 return entry;
2155 i += MENU_ITEMS_ITEM_LENGTH;
2159 else
2160 /* Make "Cancel" equivalent to C-g. */
2161 Fsignal (Qquit, Qnil);
2163 return Qnil;
2166 #else /* not USE_X_TOOLKIT && not USE_GTK */
2168 /* The frame of the last activated non-toolkit menu bar.
2169 Used to generate menu help events. */
2171 static struct frame *menu_help_frame;
2174 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
2176 PANE is the pane number, and ITEM is the menu item number in
2177 the menu (currently not used).
2179 This cannot be done with generating a HELP_EVENT because
2180 XMenuActivate contains a loop that doesn't let Emacs process
2181 keyboard events. */
2183 static void
2184 menu_help_callback (char *help_string, int pane, int item)
2186 Lisp_Object *first_item;
2187 Lisp_Object pane_name;
2188 Lisp_Object menu_object;
2190 first_item = XVECTOR (menu_items)->contents;
2191 if (EQ (first_item[0], Qt))
2192 pane_name = first_item[MENU_ITEMS_PANE_NAME];
2193 else if (EQ (first_item[0], Qquote))
2194 /* This shouldn't happen, see xmenu_show. */
2195 pane_name = empty_unibyte_string;
2196 else
2197 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
2199 /* (menu-item MENU-NAME PANE-NUMBER) */
2200 menu_object = Fcons (Qmenu_item,
2201 Fcons (pane_name,
2202 Fcons (make_number (pane), Qnil)));
2203 show_help_echo (help_string ? build_string (help_string) : Qnil,
2204 Qnil, menu_object, make_number (item));
2207 static Lisp_Object
2208 pop_down_menu (Lisp_Object arg)
2210 struct Lisp_Save_Value *p1 = XSAVE_VALUE (Fcar (arg));
2211 struct Lisp_Save_Value *p2 = XSAVE_VALUE (Fcdr (arg));
2213 FRAME_PTR f = p1->pointer;
2214 XMenu *menu = p2->pointer;
2216 BLOCK_INPUT;
2217 #ifndef MSDOS
2218 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
2219 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
2220 #endif
2221 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2223 #ifdef HAVE_X_WINDOWS
2224 /* Assume the mouse has moved out of the X window.
2225 If it has actually moved in, we will get an EnterNotify. */
2226 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
2228 /* State that no mouse buttons are now held.
2229 (The oldXMenu code doesn't track this info for us.)
2230 That is not necessarily true, but the fiction leads to reasonable
2231 results, and it is a pain to ask which are actually held now. */
2232 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2234 #endif /* HAVE_X_WINDOWS */
2236 UNBLOCK_INPUT;
2238 return Qnil;
2242 Lisp_Object
2243 xmenu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
2244 Lisp_Object title, const char **error, EMACS_UINT timestamp)
2246 Window root;
2247 XMenu *menu;
2248 int pane, selidx, lpane, status;
2249 Lisp_Object entry, pane_prefix;
2250 char *datap;
2251 int ulx, uly, width, height;
2252 int dispwidth, dispheight;
2253 int i, j, lines, maxlines;
2254 int maxwidth;
2255 int dummy_int;
2256 unsigned int dummy_uint;
2257 int specpdl_count = SPECPDL_INDEX ();
2259 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
2260 abort ();
2262 *error = 0;
2263 if (menu_items_n_panes == 0)
2264 return Qnil;
2266 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2268 *error = "Empty menu";
2269 return Qnil;
2272 /* Figure out which root window F is on. */
2273 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2274 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2275 &dummy_uint, &dummy_uint);
2277 /* Make the menu on that window. */
2278 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2279 if (menu == NULL)
2281 *error = "Can't create menu";
2282 return Qnil;
2285 /* Don't GC while we prepare and show the menu,
2286 because we give the oldxmenu library pointers to the
2287 contents of strings. */
2288 inhibit_garbage_collection ();
2290 #ifdef HAVE_X_WINDOWS
2291 /* Adjust coordinates to relative to the outer (window manager) window. */
2292 x += FRAME_OUTER_TO_INNER_DIFF_X (f);
2293 y += FRAME_OUTER_TO_INNER_DIFF_Y (f);
2294 #endif /* HAVE_X_WINDOWS */
2296 /* Adjust coordinates to be root-window-relative. */
2297 x += f->left_pos;
2298 y += f->top_pos;
2300 /* Create all the necessary panes and their items. */
2301 maxlines = lines = i = 0;
2302 while (i < menu_items_used)
2304 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2306 /* Create a new pane. */
2307 Lisp_Object pane_name, prefix;
2308 const char *pane_string;
2310 maxlines = max (maxlines, lines);
2311 lines = 0;
2312 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
2313 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2314 pane_string = (NILP (pane_name)
2315 ? "" : SSDATA (pane_name));
2316 if (keymaps && !NILP (prefix))
2317 pane_string++;
2319 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2320 if (lpane == XM_FAILURE)
2322 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2323 *error = "Can't create pane";
2324 return Qnil;
2326 i += MENU_ITEMS_PANE_LENGTH;
2328 /* Find the width of the widest item in this pane. */
2329 maxwidth = 0;
2330 j = i;
2331 while (j < menu_items_used)
2333 Lisp_Object item;
2334 item = XVECTOR (menu_items)->contents[j];
2335 if (EQ (item, Qt))
2336 break;
2337 if (NILP (item))
2339 j++;
2340 continue;
2342 width = SBYTES (item);
2343 if (width > maxwidth)
2344 maxwidth = width;
2346 j += MENU_ITEMS_ITEM_LENGTH;
2349 /* Ignore a nil in the item list.
2350 It's meaningful only for dialog boxes. */
2351 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2352 i += 1;
2353 else
2355 /* Create a new item within current pane. */
2356 Lisp_Object item_name, enable, descrip, help;
2357 unsigned char *item_data;
2358 char *help_string;
2360 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2361 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2362 descrip
2363 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2364 help = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_HELP];
2365 help_string = STRINGP (help) ? SDATA (help) : NULL;
2367 if (!NILP (descrip))
2369 int gap = maxwidth - SBYTES (item_name);
2370 /* if alloca is fast, use that to make the space,
2371 to reduce gc needs. */
2372 item_data
2373 = (unsigned char *) alloca (maxwidth
2374 + SBYTES (descrip) + 1);
2375 memcpy (item_data, SDATA (item_name), SBYTES (item_name));
2376 for (j = SCHARS (item_name); j < maxwidth; j++)
2377 item_data[j] = ' ';
2378 memcpy (item_data + j, SDATA (descrip), SBYTES (descrip));
2379 item_data[j + SBYTES (descrip)] = 0;
2381 else
2382 item_data = SDATA (item_name);
2384 if (XMenuAddSelection (FRAME_X_DISPLAY (f),
2385 menu, lpane, 0, item_data,
2386 !NILP (enable), help_string)
2387 == XM_FAILURE)
2389 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2390 *error = "Can't add selection to menu";
2391 return Qnil;
2393 i += MENU_ITEMS_ITEM_LENGTH;
2394 lines++;
2398 maxlines = max (maxlines, lines);
2400 /* All set and ready to fly. */
2401 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2402 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2403 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2404 x = min (x, dispwidth);
2405 y = min (y, dispheight);
2406 x = max (x, 1);
2407 y = max (y, 1);
2408 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2409 &ulx, &uly, &width, &height);
2410 if (ulx+width > dispwidth)
2412 x -= (ulx + width) - dispwidth;
2413 ulx = dispwidth - width;
2415 if (uly+height > dispheight)
2417 y -= (uly + height) - dispheight;
2418 uly = dispheight - height;
2420 #ifndef HAVE_X_WINDOWS
2421 if (FRAME_HAS_MINIBUF_P (f) && uly+height > dispheight - 1)
2423 /* Move the menu away of the echo area, to avoid overwriting the
2424 menu with help echo messages or vice versa. */
2425 if (BUFFERP (echo_area_buffer[0]) && WINDOWP (echo_area_window))
2427 y -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2428 uly -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2430 else
2432 y--;
2433 uly--;
2436 #endif
2437 if (ulx < 0) x -= ulx;
2438 if (uly < 0) y -= uly;
2440 if (! for_click)
2442 /* If position was not given by a mouse click, adjust so upper left
2443 corner of the menu as a whole ends up at given coordinates. This
2444 is what x-popup-menu says in its documentation. */
2445 x += width/2;
2446 y += 1.5*height/(maxlines+2);
2449 XMenuSetAEQ (menu, TRUE);
2450 XMenuSetFreeze (menu, TRUE);
2451 pane = selidx = 0;
2453 #ifndef MSDOS
2454 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
2455 #endif
2457 record_unwind_protect (pop_down_menu,
2458 Fcons (make_save_value (f, 0),
2459 make_save_value (menu, 0)));
2461 /* Help display under X won't work because XMenuActivate contains
2462 a loop that doesn't give Emacs a chance to process it. */
2463 menu_help_frame = f;
2464 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2465 x, y, ButtonReleaseMask, &datap,
2466 menu_help_callback);
2468 switch (status)
2470 case XM_SUCCESS:
2471 #ifdef XDEBUG
2472 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2473 #endif
2475 /* Find the item number SELIDX in pane number PANE. */
2476 i = 0;
2477 while (i < menu_items_used)
2479 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2481 if (pane == 0)
2482 pane_prefix
2483 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2484 pane--;
2485 i += MENU_ITEMS_PANE_LENGTH;
2487 else
2489 if (pane == -1)
2491 if (selidx == 0)
2493 entry
2494 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2495 if (keymaps != 0)
2497 entry = Fcons (entry, Qnil);
2498 if (!NILP (pane_prefix))
2499 entry = Fcons (pane_prefix, entry);
2501 break;
2503 selidx--;
2505 i += MENU_ITEMS_ITEM_LENGTH;
2508 break;
2510 case XM_FAILURE:
2511 *error = "Can't activate menu";
2512 case XM_IA_SELECT:
2513 entry = Qnil;
2514 break;
2515 case XM_NO_SELECT:
2516 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
2517 the menu was invoked with a mouse event as POSITION). */
2518 if (! for_click)
2519 Fsignal (Qquit, Qnil);
2520 entry = Qnil;
2521 break;
2524 unbind_to (specpdl_count, Qnil);
2526 return entry;
2529 #endif /* not USE_X_TOOLKIT */
2531 #endif /* HAVE_MENUS */
2533 #ifndef MSDOS
2534 /* Detect if a dialog or menu has been posted. MSDOS has its own
2535 implementation on msdos.c. */
2538 popup_activated (void)
2540 return popup_activated_flag;
2542 #endif /* not MSDOS */
2544 /* The following is used by delayed window autoselection. */
2546 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
2547 doc: /* Return t if a menu or popup dialog is active. */)
2548 (void)
2550 #ifdef HAVE_MENUS
2551 return (popup_activated ()) ? Qt : Qnil;
2552 #else
2553 return Qnil;
2554 #endif /* HAVE_MENUS */
2557 void
2558 syms_of_xmenu (void)
2560 Qdebug_on_next_call = intern_c_string ("debug-on-next-call");
2561 staticpro (&Qdebug_on_next_call);
2563 #ifdef USE_X_TOOLKIT
2564 widget_id_tick = (1<<16);
2565 next_menubar_widget_id = 1;
2566 #endif
2568 defsubr (&Smenu_or_popup_active_p);
2570 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
2571 defsubr (&Sx_menu_bar_open_internal);
2572 Ffset (intern_c_string ("accelerate-menu"),
2573 intern_c_string (Sx_menu_bar_open_internal.symbol_name));
2574 #endif
2576 #ifdef HAVE_MENUS
2577 defsubr (&Sx_popup_dialog);
2578 #endif