Merge into trunk
[emacs.git] / src / xmenu.c
blob96a1ae87fdc82870e7db8983105aa2f0e69d64eb
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2012
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 #include <stdio.h>
37 #include "lisp.h"
38 #include "keyboard.h"
39 #include "keymap.h"
40 #include "frame.h"
41 #include "termhooks.h"
42 #include "window.h"
43 #include "blockinput.h"
44 #include "character.h"
45 #include "buffer.h"
46 #include "charset.h"
47 #include "coding.h"
48 #include "sysselect.h"
50 #ifdef MSDOS
51 #include "msdos.h"
52 #endif
54 #ifdef HAVE_X_WINDOWS
55 /* This may include sys/types.h, and that somehow loses
56 if this is not done before the other system files. */
57 #include "xterm.h"
58 #endif
60 /* Load sys/types.h if not already loaded.
61 In some systems loading it twice is suicidal. */
62 #ifndef makedev
63 #include <sys/types.h>
64 #endif
66 #include "dispextern.h"
68 #ifdef HAVE_X_WINDOWS
69 /* Defining HAVE_MULTILINGUAL_MENU would mean that the toolkit menu
70 code accepts the Emacs internal encoding. */
71 #undef HAVE_MULTILINGUAL_MENU
72 #ifdef USE_X_TOOLKIT
73 #include "widget.h"
74 #include <X11/Xlib.h>
75 #include <X11/IntrinsicP.h>
76 #include <X11/CoreP.h>
77 #include <X11/StringDefs.h>
78 #include <X11/Shell.h>
79 #ifdef USE_LUCID
80 #include "xsettings.h"
81 #include "../lwlib/xlwmenu.h"
82 #ifdef HAVE_XAW3D
83 #include <X11/Xaw3d/Paned.h>
84 #else /* !HAVE_XAW3D */
85 #include <X11/Xaw/Paned.h>
86 #endif /* HAVE_XAW3D */
87 #endif /* USE_LUCID */
88 #ifdef USE_MOTIF
89 #include "../lwlib/lwlib.h"
90 #endif
91 #else /* not USE_X_TOOLKIT */
92 #ifndef USE_GTK
93 #include "../oldXMenu/XMenu.h"
94 #endif
95 #endif /* not USE_X_TOOLKIT */
96 #endif /* HAVE_X_WINDOWS */
98 #ifdef USE_GTK
99 #include "gtkutil.h"
100 #ifdef HAVE_GTK3
101 #include "xgselect.h"
102 #endif
103 #endif
105 #include "menu.h"
107 #ifndef TRUE
108 #define TRUE 1
109 #endif /* no TRUE */
111 static Lisp_Object Qdebug_on_next_call;
113 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
114 static Lisp_Object xdialog_show (FRAME_PTR, int, Lisp_Object, Lisp_Object,
115 const char **);
116 #endif
118 /* Flag which when set indicates a dialog or menu has been posted by
119 Xt on behalf of one of the widget sets. */
120 static int popup_activated_flag;
123 #ifdef USE_X_TOOLKIT
125 static int next_menubar_widget_id;
127 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
129 static struct frame *
130 menubar_id_to_frame (LWLIB_ID id)
132 Lisp_Object tail, frame;
133 FRAME_PTR f;
135 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
137 frame = XCAR (tail);
138 if (!FRAMEP (frame))
139 continue;
140 f = XFRAME (frame);
141 if (!FRAME_WINDOW_P (f))
142 continue;
143 if (f->output_data.x->id == id)
144 return f;
146 return 0;
149 #endif
151 #ifdef HAVE_X_WINDOWS
152 /* Return the mouse position in *X and *Y. The coordinates are window
153 relative for the edit window in frame F.
154 This is for Fx_popup_menu. The mouse_position_hook can not
155 be used for X, as it returns window relative coordinates
156 for the window where the mouse is in. This could be the menu bar,
157 the scroll bar or the edit window. Fx_popup_menu needs to be
158 sure it is the edit window. */
159 void
160 mouse_position_for_popup (FRAME_PTR f, int *x, int *y)
162 Window root, dummy_window;
163 int dummy;
165 if (! FRAME_X_P (f))
166 emacs_abort ();
168 block_input ();
170 XQueryPointer (FRAME_X_DISPLAY (f),
171 DefaultRootWindow (FRAME_X_DISPLAY (f)),
173 /* The root window which contains the pointer. */
174 &root,
176 /* Window pointer is on, not used */
177 &dummy_window,
179 /* The position on that root window. */
180 x, y,
182 /* x/y in dummy_window coordinates, not used. */
183 &dummy, &dummy,
185 /* Modifier keys and pointer buttons, about which
186 we don't care. */
187 (unsigned int *) &dummy);
189 unblock_input ();
191 /* xmenu_show expects window coordinates, not root window
192 coordinates. Translate. */
193 *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
194 *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
197 #endif /* HAVE_X_WINDOWS */
199 #ifdef HAVE_MENUS
201 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
202 doc: /* Pop up a dialog box and return user's selection.
203 POSITION specifies which frame to use.
204 This is normally a mouse button event or a window or frame.
205 If POSITION is t, it means to use the frame the mouse is on.
206 The dialog box appears in the middle of the specified frame.
208 CONTENTS specifies the alternatives to display in the dialog box.
209 It is a list of the form (DIALOG ITEM1 ITEM2...).
210 Each ITEM is a cons cell (STRING . VALUE).
211 The return value is VALUE from the chosen item.
213 An ITEM may also be just a string--that makes a nonselectable item.
214 An ITEM may also be nil--that means to put all preceding items
215 on the left of the dialog box and all following items on the right.
216 \(By default, approximately half appear on each side.)
218 If HEADER is non-nil, the frame title for the box is "Information",
219 otherwise it is "Question".
221 If the user gets rid of the dialog box without making a valid choice,
222 for instance using the window manager, then this produces a quit and
223 `x-popup-dialog' does not return. */)
224 (Lisp_Object position, Lisp_Object contents, Lisp_Object header)
226 FRAME_PTR f = NULL;
227 Lisp_Object window;
229 check_x ();
231 /* Decode the first argument: find the window or frame to use. */
232 if (EQ (position, Qt)
233 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
234 || EQ (XCAR (position), Qtool_bar))))
236 #if 0 /* Using the frame the mouse is on may not be right. */
237 /* Use the mouse's current position. */
238 FRAME_PTR new_f = SELECTED_FRAME ();
239 Lisp_Object bar_window;
240 enum scroll_bar_part part;
241 Time time;
242 Lisp_Object x, y;
244 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
246 if (new_f != 0)
247 XSETFRAME (window, new_f);
248 else
249 window = selected_window;
250 #endif
251 window = selected_window;
253 else if (CONSP (position))
255 Lisp_Object tem = XCAR (position);
256 if (CONSP (tem))
257 window = Fcar (XCDR (position));
258 else
260 tem = Fcar (XCDR (position)); /* EVENT_START (position) */
261 window = Fcar (tem); /* POSN_WINDOW (tem) */
264 else if (WINDOWP (position) || FRAMEP (position))
265 window = position;
266 else
267 window = Qnil;
269 /* Decode where to put the menu. */
271 if (FRAMEP (window))
272 f = XFRAME (window);
273 else if (WINDOWP (window))
275 CHECK_LIVE_WINDOW (window);
276 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
278 else
279 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
280 but I don't want to make one now. */
281 CHECK_WINDOW (window);
283 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
284 error ("Can not put X dialog on this terminal");
286 /* Force a redisplay before showing the dialog. If a frame is created
287 just before showing the dialog, its contents may not have been fully
288 drawn, as this depends on timing of events from the X server. Redisplay
289 is not done when a dialog is shown. If redisplay could be done in the
290 X event loop (i.e. the X event loop does not run in a signal handler)
291 this would not be needed.
293 Do this before creating the widget value that points to Lisp
294 string contents, because Fredisplay may GC and relocate them. */
295 Fredisplay (Qt);
297 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
298 /* Display a menu with these alternatives
299 in the middle of frame F. */
301 Lisp_Object x, y, frame, newpos;
302 XSETFRAME (frame, f);
303 XSETINT (x, x_pixel_width (f) / 2);
304 XSETINT (y, x_pixel_height (f) / 2);
305 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
307 return Fx_popup_menu (newpos,
308 Fcons (Fcar (contents), Fcons (contents, Qnil)));
310 #else
312 Lisp_Object title;
313 const char *error_name;
314 Lisp_Object selection;
315 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
317 /* Decode the dialog items from what was specified. */
318 title = Fcar (contents);
319 CHECK_STRING (title);
320 record_unwind_protect (unuse_menu_items, Qnil);
322 if (NILP (Fcar (Fcdr (contents))))
323 /* No buttons specified, add an "Ok" button so users can pop down
324 the dialog. Also, the lesstif/motif version crashes if there are
325 no buttons. */
326 contents = Fcons (title, Fcons (Fcons (build_string ("Ok"), Qt), Qnil));
328 list_of_panes (Fcons (contents, Qnil));
330 /* Display them in a dialog box. */
331 block_input ();
332 selection = xdialog_show (f, 0, title, header, &error_name);
333 unblock_input ();
335 unbind_to (specpdl_count, Qnil);
336 discard_menu_items ();
338 if (error_name) error ("%s", error_name);
339 return selection;
341 #endif
345 #ifndef MSDOS
347 #if defined USE_GTK || defined USE_MOTIF
349 /* Set menu_items_inuse so no other popup menu or dialog is created. */
351 void
352 x_menu_set_in_use (int in_use)
354 menu_items_inuse = in_use ? Qt : Qnil;
355 popup_activated_flag = in_use;
356 #ifdef USE_X_TOOLKIT
357 if (popup_activated_flag)
358 x_activate_timeout_atimer ();
359 #endif
362 #endif
364 /* Wait for an X event to arrive or for a timer to expire. */
366 #ifndef USE_MOTIF
367 static
368 #endif
369 void
370 x_menu_wait_for_event (void *data)
372 /* Another way to do this is to register a timer callback, that can be
373 done in GTK and Xt. But we have to do it like this when using only X
374 anyway, and with callbacks we would have three variants for timer handling
375 instead of the small ifdefs below. */
377 while (
378 #ifdef USE_X_TOOLKIT
379 ! XtAppPending (Xt_app_con)
380 #elif defined USE_GTK
381 ! gtk_events_pending ()
382 #else
383 ! XPending ((Display*) data)
384 #endif
387 EMACS_TIME next_time = timer_check (), *ntp;
388 SELECT_TYPE read_fds;
389 struct x_display_info *dpyinfo;
390 int n = 0;
392 FD_ZERO (&read_fds);
393 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
395 int fd = ConnectionNumber (dpyinfo->display);
396 FD_SET (fd, &read_fds);
397 if (fd > n) n = fd;
398 XFlush (dpyinfo->display);
401 if (! EMACS_TIME_VALID_P (next_time))
402 ntp = 0;
403 else
404 ntp = &next_time;
406 #ifdef HAVE_GTK3
407 /* Gtk3 have arrows on menus when they don't fit. When the
408 pointer is over an arrow, a timeout scrolls it a bit. Use
409 xg_select so that timeout gets triggered. */
410 xg_select (n + 1, &read_fds, NULL, NULL, ntp, NULL);
411 #else
412 pselect (n + 1, &read_fds, NULL, NULL, ntp, NULL);
413 #endif
416 #endif /* ! MSDOS */
419 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
421 #ifdef USE_X_TOOLKIT
423 /* Loop in Xt until the menu pulldown or dialog popup has been
424 popped down (deactivated). This is used for x-popup-menu
425 and x-popup-dialog; it is not used for the menu bar.
427 NOTE: All calls to popup_get_selection should be protected
428 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
430 static void
431 popup_get_selection (XEvent *initial_event, struct x_display_info *dpyinfo, LWLIB_ID id, int do_timers)
433 XEvent event;
435 while (popup_activated_flag)
437 if (initial_event)
439 event = *initial_event;
440 initial_event = 0;
442 else
444 if (do_timers) x_menu_wait_for_event (0);
445 XtAppNextEvent (Xt_app_con, &event);
448 /* Make sure we don't consider buttons grabbed after menu goes.
449 And make sure to deactivate for any ButtonRelease,
450 even if XtDispatchEvent doesn't do that. */
451 if (event.type == ButtonRelease
452 && dpyinfo->display == event.xbutton.display)
454 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
455 #ifdef USE_MOTIF /* Pretending that the event came from a
456 Btn1Down seems the only way to convince Motif to
457 activate its callbacks; setting the XmNmenuPost
458 isn't working. --marcus@sysc.pdx.edu. */
459 event.xbutton.button = 1;
460 /* Motif only pops down menus when no Ctrl, Alt or Mod
461 key is pressed and the button is released. So reset key state
462 so Motif thinks this is the case. */
463 event.xbutton.state = 0;
464 #endif
466 /* Pop down on C-g and Escape. */
467 else if (event.type == KeyPress
468 && dpyinfo->display == event.xbutton.display)
470 KeySym keysym = XLookupKeysym (&event.xkey, 0);
472 if ((keysym == XK_g && (event.xkey.state & ControlMask) != 0)
473 || keysym == XK_Escape) /* Any escape, ignore modifiers. */
474 popup_activated_flag = 0;
477 x_dispatch_event (&event, event.xany.display);
481 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
482 doc: /* Start key navigation of the menu bar in FRAME.
483 This initially opens the first menu bar item and you can then navigate with the
484 arrow keys, select a menu entry with the return key or cancel with the
485 escape key. If FRAME has no menu bar this function does nothing.
487 If FRAME is nil or not given, use the selected frame. */)
488 (Lisp_Object frame)
490 XEvent ev;
491 FRAME_PTR f = check_x_frame (frame);
492 Widget menubar;
493 block_input ();
495 if (FRAME_EXTERNAL_MENU_BAR (f))
496 set_frame_menubar (f, 0, 1);
498 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
499 if (menubar)
501 Window child;
502 int error_p = 0;
504 x_catch_errors (FRAME_X_DISPLAY (f));
505 memset (&ev, 0, sizeof ev);
506 ev.xbutton.display = FRAME_X_DISPLAY (f);
507 ev.xbutton.window = XtWindow (menubar);
508 ev.xbutton.root = FRAME_X_DISPLAY_INFO (f)->root_window;
509 ev.xbutton.time = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
510 ev.xbutton.button = Button1;
511 ev.xbutton.x = ev.xbutton.y = FRAME_MENUBAR_HEIGHT (f) / 2;
512 ev.xbutton.same_screen = True;
514 #ifdef USE_MOTIF
516 Arg al[2];
517 WidgetList list;
518 Cardinal nr;
519 XtSetArg (al[0], XtNchildren, &list);
520 XtSetArg (al[1], XtNnumChildren, &nr);
521 XtGetValues (menubar, al, 2);
522 ev.xbutton.window = XtWindow (list[0]);
524 #endif
526 XTranslateCoordinates (FRAME_X_DISPLAY (f),
527 /* From-window, to-window. */
528 ev.xbutton.window, ev.xbutton.root,
530 /* From-position, to-position. */
531 ev.xbutton.x, ev.xbutton.y,
532 &ev.xbutton.x_root, &ev.xbutton.y_root,
534 /* Child of win. */
535 &child);
536 error_p = x_had_errors_p (FRAME_X_DISPLAY (f));
537 x_uncatch_errors ();
539 if (! error_p)
541 ev.type = ButtonPress;
542 ev.xbutton.state = 0;
544 XtDispatchEvent (&ev);
545 ev.xbutton.type = ButtonRelease;
546 ev.xbutton.state = Button1Mask;
547 XtDispatchEvent (&ev);
551 unblock_input ();
553 return Qnil;
555 #endif /* USE_X_TOOLKIT */
558 #ifdef USE_GTK
559 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
560 doc: /* Start key navigation of the menu bar in FRAME.
561 This initially opens the first menu bar item and you can then navigate with the
562 arrow keys, select a menu entry with the return key or cancel with the
563 escape key. If FRAME has no menu bar this function does nothing.
565 If FRAME is nil or not given, use the selected frame. */)
566 (Lisp_Object frame)
568 GtkWidget *menubar;
569 FRAME_PTR f;
571 /* gcc 2.95 doesn't accept the FRAME_PTR declaration after
572 block_input (). */
574 block_input ();
575 f = check_x_frame (frame);
577 if (FRAME_EXTERNAL_MENU_BAR (f))
578 set_frame_menubar (f, 0, 1);
580 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
581 if (menubar)
583 /* Activate the first menu. */
584 GList *children = gtk_container_get_children (GTK_CONTAINER (menubar));
586 if (children)
588 g_signal_emit_by_name (children->data, "activate_item");
589 popup_activated_flag = 1;
590 g_list_free (children);
593 unblock_input ();
595 return Qnil;
598 /* Loop util popup_activated_flag is set to zero in a callback.
599 Used for popup menus and dialogs. */
601 static void
602 popup_widget_loop (int do_timers, GtkWidget *widget)
604 ++popup_activated_flag;
606 /* Process events in the Gtk event loop until done. */
607 while (popup_activated_flag)
609 if (do_timers) x_menu_wait_for_event (0);
610 gtk_main_iteration ();
613 #endif
615 /* Activate the menu bar of frame F.
616 This is called from keyboard.c when it gets the
617 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
619 To activate the menu bar, we use the X button-press event
620 that was saved in saved_menu_event.
621 That makes the toolkit do its thing.
623 But first we recompute the menu bar contents (the whole tree).
625 The reason for saving the button event until here, instead of
626 passing it to the toolkit right away, is that we can safely
627 execute Lisp code. */
629 void
630 x_activate_menubar (FRAME_PTR f)
632 if (! FRAME_X_P (f))
633 emacs_abort ();
635 if (!f->output_data.x->saved_menu_event->type)
636 return;
638 #ifdef USE_GTK
639 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
640 f->output_data.x->saved_menu_event->xany.window))
641 return;
642 #endif
644 set_frame_menubar (f, 0, 1);
645 block_input ();
646 popup_activated_flag = 1;
647 #ifdef USE_GTK
648 XPutBackEvent (f->output_data.x->display_info->display,
649 f->output_data.x->saved_menu_event);
650 #else
651 XtDispatchEvent (f->output_data.x->saved_menu_event);
652 #endif
653 unblock_input ();
655 /* Ignore this if we get it a second time. */
656 f->output_data.x->saved_menu_event->type = 0;
659 /* This callback is invoked when the user selects a menubar cascade
660 pushbutton, but before the pulldown menu is posted. */
662 #ifndef USE_GTK
663 static void
664 popup_activate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
666 popup_activated_flag = 1;
667 #ifdef USE_X_TOOLKIT
668 x_activate_timeout_atimer ();
669 #endif
671 #endif
673 /* This callback is invoked when a dialog or menu is finished being
674 used and has been unposted. */
676 static void
677 popup_deactivate_callback (
678 #ifdef USE_GTK
679 GtkWidget *widget, gpointer client_data
680 #else
681 Widget widget, LWLIB_ID id, XtPointer client_data
682 #endif
685 popup_activated_flag = 0;
689 /* Function that finds the frame for WIDGET and shows the HELP text
690 for that widget.
691 F is the frame if known, or NULL if not known. */
692 static void
693 show_help_event (FRAME_PTR f, xt_or_gtk_widget widget, Lisp_Object help)
695 Lisp_Object frame;
697 if (f)
699 XSETFRAME (frame, f);
700 kbd_buffer_store_help_event (frame, help);
702 else
704 #if 0 /* This code doesn't do anything useful. ++kfs */
705 /* WIDGET is the popup menu. It's parent is the frame's
706 widget. See which frame that is. */
707 xt_or_gtk_widget frame_widget = XtParent (widget);
708 Lisp_Object tail;
710 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
712 frame = XCAR (tail);
713 if (FRAMEP (frame)
714 && (f = XFRAME (frame),
715 FRAME_X_P (f) && f->output_data.x->widget == frame_widget))
716 break;
718 #endif
719 show_help_echo (help, Qnil, Qnil, Qnil);
723 /* Callback called when menu items are highlighted/unhighlighted
724 while moving the mouse over them. WIDGET is the menu bar or menu
725 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
726 the data structure for the menu item, or null in case of
727 unhighlighting. */
729 #ifdef USE_GTK
730 static void
731 menu_highlight_callback (GtkWidget *widget, gpointer call_data)
733 xg_menu_item_cb_data *cb_data;
734 Lisp_Object help;
736 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (widget),
737 XG_ITEM_DATA);
738 if (! cb_data) return;
740 help = call_data ? cb_data->help : Qnil;
742 /* If popup_activated_flag is greater than 1 we are in a popup menu.
743 Don't pass the frame to show_help_event for those.
744 Passing frame creates an Emacs event. As we are looping in
745 popup_widget_loop, it won't be handled. Passing NULL shows the tip
746 directly without using an Emacs event. This is what the Lucid code
747 does below. */
748 show_help_event (popup_activated_flag <= 1 ? cb_data->cl_data->f : NULL,
749 widget, help);
751 #else
752 static void
753 menu_highlight_callback (Widget widget, LWLIB_ID id, void *call_data)
755 struct frame *f;
756 Lisp_Object help;
758 widget_value *wv = (widget_value *) call_data;
760 help = wv ? wv->help : Qnil;
762 /* Determine the frame for the help event. */
763 f = menubar_id_to_frame (id);
765 show_help_event (f, widget, help);
767 #endif
769 #ifdef USE_GTK
770 /* Gtk calls callbacks just because we tell it what item should be
771 selected in a radio group. If this variable is set to a non-zero
772 value, we are creating menus and don't want callbacks right now.
774 static int xg_crazy_callback_abort;
776 /* This callback is called from the menu bar pulldown menu
777 when the user makes a selection.
778 Figure out what the user chose
779 and put the appropriate events into the keyboard buffer. */
780 static void
781 menubar_selection_callback (GtkWidget *widget, gpointer client_data)
783 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
785 if (xg_crazy_callback_abort)
786 return;
788 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
789 return;
791 /* For a group of radio buttons, GTK calls the selection callback first
792 for the item that was active before the selection and then for the one that
793 is active after the selection. For C-h k this means we get the help on
794 the deselected item and then the selected item is executed. Prevent that
795 by ignoring the non-active item. */
796 if (GTK_IS_RADIO_MENU_ITEM (widget)
797 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)))
798 return;
800 /* When a menu is popped down, X generates a focus event (i.e. focus
801 goes back to the frame below the menu). Since GTK buffers events,
802 we force it out here before the menu selection event. Otherwise
803 sit-for will exit at once if the focus event follows the menu selection
804 event. */
806 block_input ();
807 while (gtk_events_pending ())
808 gtk_main_iteration ();
809 unblock_input ();
811 find_and_call_menu_selection (cb_data->cl_data->f,
812 cb_data->cl_data->menu_bar_items_used,
813 cb_data->cl_data->menu_bar_vector,
814 cb_data->call_data);
817 #else /* not USE_GTK */
819 /* This callback is called from the menu bar pulldown menu
820 when the user makes a selection.
821 Figure out what the user chose
822 and put the appropriate events into the keyboard buffer. */
823 static void
824 menubar_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
826 FRAME_PTR f;
828 f = menubar_id_to_frame (id);
829 if (!f)
830 return;
831 find_and_call_menu_selection (f, f->menu_bar_items_used,
832 f->menu_bar_vector, client_data);
834 #endif /* not USE_GTK */
836 /* Recompute all the widgets of frame F, when the menu bar has been
837 changed. */
839 static void
840 update_frame_menubar (FRAME_PTR f)
842 #ifdef USE_GTK
843 xg_update_frame_menubar (f);
844 #else
845 struct x_output *x;
846 int columns, rows;
848 if (! FRAME_X_P (f))
849 emacs_abort ();
851 x = f->output_data.x;
853 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
854 return;
856 block_input ();
857 /* Save the size of the frame because the pane widget doesn't accept
858 to resize itself. So force it. */
859 columns = FRAME_COLS (f);
860 rows = FRAME_LINES (f);
862 /* Do the voodoo which means "I'm changing lots of things, don't try
863 to refigure sizes until I'm done." */
864 lw_refigure_widget (x->column_widget, False);
866 /* The order in which children are managed is the top to bottom
867 order in which they are displayed in the paned window. First,
868 remove the text-area widget. */
869 XtUnmanageChild (x->edit_widget);
871 /* Remove the menubar that is there now, and put up the menubar that
872 should be there. */
873 XtManageChild (x->menubar_widget);
874 XtMapWidget (x->menubar_widget);
875 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
877 /* Re-manage the text-area widget, and then thrash the sizes. */
878 XtManageChild (x->edit_widget);
879 lw_refigure_widget (x->column_widget, True);
881 /* Force the pane widget to resize itself with the right values. */
882 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
883 unblock_input ();
884 #endif
887 #ifdef USE_LUCID
888 static void
889 apply_systemfont_to_dialog (Widget w)
891 const char *fn = xsettings_get_system_normal_font ();
892 if (fn)
894 XrmDatabase db = XtDatabase (XtDisplay (w));
895 if (db)
896 XrmPutStringResource (&db, "*dialog.font", fn);
900 static void
901 apply_systemfont_to_menu (struct frame *f, Widget w)
903 const char *fn = xsettings_get_system_normal_font ();
905 if (fn)
907 XrmDatabase db = XtDatabase (XtDisplay (w));
908 if (db)
910 XrmPutStringResource (&db, "*menubar*font", fn);
911 XrmPutStringResource (&db, "*popup*font", fn);
916 #endif
918 /* Set the contents of the menubar widgets of frame F.
919 The argument FIRST_TIME is currently ignored;
920 it is set the first time this is called, from initialize_frame_menubar. */
922 void
923 set_frame_menubar (FRAME_PTR f, bool first_time, bool deep_p)
925 xt_or_gtk_widget menubar_widget;
926 #ifdef USE_X_TOOLKIT
927 LWLIB_ID id;
928 #endif
929 Lisp_Object items;
930 widget_value *wv, *first_wv, *prev_wv = 0;
931 int i;
932 int *submenu_start, *submenu_end;
933 int *submenu_top_level_items, *submenu_n_panes;
935 if (! FRAME_X_P (f))
936 emacs_abort ();
938 menubar_widget = f->output_data.x->menubar_widget;
940 XSETFRAME (Vmenu_updating_frame, f);
942 #ifdef USE_X_TOOLKIT
943 if (f->output_data.x->id == 0)
944 f->output_data.x->id = next_menubar_widget_id++;
945 id = f->output_data.x->id;
946 #endif
948 if (! menubar_widget)
949 deep_p = 1;
950 /* Make the first call for any given frame always go deep. */
951 else if (!f->output_data.x->saved_menu_event && !deep_p)
953 deep_p = 1;
954 f->output_data.x->saved_menu_event = xmalloc (sizeof (XEvent));
955 f->output_data.x->saved_menu_event->type = 0;
958 #ifdef USE_GTK
959 /* If we have detached menus, we must update deep so detached menus
960 also gets updated. */
961 deep_p = deep_p || xg_have_tear_offs ();
962 #endif
964 if (deep_p)
966 /* Make a widget-value tree representing the entire menu trees. */
968 struct buffer *prev = current_buffer;
969 Lisp_Object buffer;
970 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
971 int previous_menu_items_used = f->menu_bar_items_used;
972 Lisp_Object *previous_items
973 = alloca (previous_menu_items_used * sizeof *previous_items);
974 int subitems;
976 /* If we are making a new widget, its contents are empty,
977 do always reinitialize them. */
978 if (! menubar_widget)
979 previous_menu_items_used = 0;
981 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
982 specbind (Qinhibit_quit, Qt);
983 /* Don't let the debugger step into this code
984 because it is not reentrant. */
985 specbind (Qdebug_on_next_call, Qnil);
987 record_unwind_save_match_data ();
988 if (NILP (Voverriding_local_map_menu_flag))
990 specbind (Qoverriding_terminal_local_map, Qnil);
991 specbind (Qoverriding_local_map, Qnil);
994 set_buffer_internal_1 (XBUFFER (buffer));
996 /* Run the Lucid hook. */
997 safe_run_hooks (Qactivate_menubar_hook);
999 /* If it has changed current-menubar from previous value,
1000 really recompute the menubar from the value. */
1001 if (! NILP (Vlucid_menu_bar_dirty_flag))
1002 call0 (Qrecompute_lucid_menubar);
1003 safe_run_hooks (Qmenu_bar_update_hook);
1004 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
1006 items = FRAME_MENU_BAR_ITEMS (f);
1008 /* Save the frame's previous menu bar contents data. */
1009 if (previous_menu_items_used)
1010 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
1011 previous_menu_items_used * word_size);
1013 /* Fill in menu_items with the current menu bar contents.
1014 This can evaluate Lisp code. */
1015 save_menu_items ();
1017 menu_items = f->menu_bar_vector;
1018 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
1019 subitems = ASIZE (items) / 4;
1020 submenu_start = alloca ((subitems + 1) * sizeof *submenu_start);
1021 submenu_end = alloca (subitems * sizeof *submenu_end);
1022 submenu_n_panes = alloca (subitems * sizeof *submenu_n_panes);
1023 submenu_top_level_items = alloca (subitems
1024 * sizeof *submenu_top_level_items);
1025 init_menu_items ();
1026 for (i = 0; i < subitems; i++)
1028 Lisp_Object key, string, maps;
1030 key = AREF (items, 4 * i);
1031 string = AREF (items, 4 * i + 1);
1032 maps = AREF (items, 4 * i + 2);
1033 if (NILP (string))
1034 break;
1036 submenu_start[i] = menu_items_used;
1038 menu_items_n_panes = 0;
1039 submenu_top_level_items[i]
1040 = parse_single_submenu (key, string, maps);
1041 submenu_n_panes[i] = menu_items_n_panes;
1043 submenu_end[i] = menu_items_used;
1046 submenu_start[i] = -1;
1047 finish_menu_items ();
1049 /* Convert menu_items into widget_value trees
1050 to display the menu. This cannot evaluate Lisp code. */
1052 wv = xmalloc_widget_value ();
1053 wv->name = "menubar";
1054 wv->value = 0;
1055 wv->enabled = 1;
1056 wv->button_type = BUTTON_TYPE_NONE;
1057 wv->help = Qnil;
1058 first_wv = wv;
1060 for (i = 0; 0 <= submenu_start[i]; i++)
1062 menu_items_n_panes = submenu_n_panes[i];
1063 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
1064 submenu_top_level_items[i]);
1065 if (prev_wv)
1066 prev_wv->next = wv;
1067 else
1068 first_wv->contents = wv;
1069 /* Don't set wv->name here; GC during the loop might relocate it. */
1070 wv->enabled = 1;
1071 wv->button_type = BUTTON_TYPE_NONE;
1072 prev_wv = wv;
1075 set_buffer_internal_1 (prev);
1077 /* If there has been no change in the Lisp-level contents
1078 of the menu bar, skip redisplaying it. Just exit. */
1080 /* Compare the new menu items with the ones computed last time. */
1081 for (i = 0; i < previous_menu_items_used; i++)
1082 if (menu_items_used == i
1083 || (!EQ (previous_items[i], AREF (menu_items, i))))
1084 break;
1085 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1087 /* The menu items have not changed. Don't bother updating
1088 the menus in any form, since it would be a no-op. */
1089 free_menubar_widget_value_tree (first_wv);
1090 discard_menu_items ();
1091 unbind_to (specpdl_count, Qnil);
1092 return;
1095 /* The menu items are different, so store them in the frame. */
1096 fset_menu_bar_vector (f, menu_items);
1097 f->menu_bar_items_used = menu_items_used;
1099 /* This undoes save_menu_items. */
1100 unbind_to (specpdl_count, Qnil);
1102 /* Now GC cannot happen during the lifetime of the widget_value,
1103 so it's safe to store data from a Lisp_String. */
1104 wv = first_wv->contents;
1105 for (i = 0; i < ASIZE (items); i += 4)
1107 Lisp_Object string;
1108 string = AREF (items, i + 1);
1109 if (NILP (string))
1110 break;
1111 wv->name = SSDATA (string);
1112 update_submenu_strings (wv->contents);
1113 wv = wv->next;
1117 else
1119 /* Make a widget-value tree containing
1120 just the top level menu bar strings. */
1122 wv = xmalloc_widget_value ();
1123 wv->name = "menubar";
1124 wv->value = 0;
1125 wv->enabled = 1;
1126 wv->button_type = BUTTON_TYPE_NONE;
1127 wv->help = Qnil;
1128 first_wv = wv;
1130 items = FRAME_MENU_BAR_ITEMS (f);
1131 for (i = 0; i < ASIZE (items); i += 4)
1133 Lisp_Object string;
1135 string = AREF (items, i + 1);
1136 if (NILP (string))
1137 break;
1139 wv = xmalloc_widget_value ();
1140 wv->name = SSDATA (string);
1141 wv->value = 0;
1142 wv->enabled = 1;
1143 wv->button_type = BUTTON_TYPE_NONE;
1144 wv->help = Qnil;
1145 /* This prevents lwlib from assuming this
1146 menu item is really supposed to be empty. */
1147 /* The intptr_t cast avoids a warning.
1148 This value just has to be different from small integers. */
1149 wv->call_data = (void *) (intptr_t) (-1);
1151 if (prev_wv)
1152 prev_wv->next = wv;
1153 else
1154 first_wv->contents = wv;
1155 prev_wv = wv;
1158 /* Forget what we thought we knew about what is in the
1159 detailed contents of the menu bar menus.
1160 Changing the top level always destroys the contents. */
1161 f->menu_bar_items_used = 0;
1164 /* Create or update the menu bar widget. */
1166 block_input ();
1168 #ifdef USE_GTK
1169 xg_crazy_callback_abort = 1;
1170 if (menubar_widget)
1172 /* The fourth arg is DEEP_P, which says to consider the entire
1173 menu trees we supply, rather than just the menu bar item names. */
1174 xg_modify_menubar_widgets (menubar_widget,
1176 first_wv,
1177 deep_p,
1178 G_CALLBACK (menubar_selection_callback),
1179 G_CALLBACK (popup_deactivate_callback),
1180 G_CALLBACK (menu_highlight_callback));
1182 else
1184 menubar_widget
1185 = xg_create_widget ("menubar", "menubar", f, first_wv,
1186 G_CALLBACK (menubar_selection_callback),
1187 G_CALLBACK (popup_deactivate_callback),
1188 G_CALLBACK (menu_highlight_callback));
1190 f->output_data.x->menubar_widget = menubar_widget;
1194 #else /* not USE_GTK */
1195 if (menubar_widget)
1197 /* Disable resizing (done for Motif!) */
1198 lw_allow_resizing (f->output_data.x->widget, False);
1200 /* The third arg is DEEP_P, which says to consider the entire
1201 menu trees we supply, rather than just the menu bar item names. */
1202 lw_modify_all_widgets (id, first_wv, deep_p);
1204 /* Re-enable the edit widget to resize. */
1205 lw_allow_resizing (f->output_data.x->widget, True);
1207 else
1209 char menuOverride[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
1210 XtTranslations override = XtParseTranslationTable (menuOverride);
1212 #ifdef USE_LUCID
1213 apply_systemfont_to_menu (f, f->output_data.x->column_widget);
1214 #endif
1215 menubar_widget = lw_create_widget ("menubar", "menubar", id,
1216 first_wv,
1217 f->output_data.x->column_widget,
1219 popup_activate_callback,
1220 menubar_selection_callback,
1221 popup_deactivate_callback,
1222 menu_highlight_callback);
1223 f->output_data.x->menubar_widget = menubar_widget;
1225 /* Make menu pop down on C-g. */
1226 XtOverrideTranslations (menubar_widget, override);
1230 int menubar_size;
1231 if (f->output_data.x->menubar_widget)
1232 XtRealizeWidget (f->output_data.x->menubar_widget);
1234 menubar_size
1235 = (f->output_data.x->menubar_widget
1236 ? (f->output_data.x->menubar_widget->core.height
1237 + f->output_data.x->menubar_widget->core.border_width)
1238 : 0);
1240 #if 1 /* Experimentally, we now get the right results
1241 for -geometry -0-0 without this. 24 Aug 96, rms.
1242 Maybe so, but the menu bar size is missing the pixels so the
1243 WM size hints are off by these pixels. Jan D, oct 2009. */
1244 #ifdef USE_LUCID
1245 if (FRAME_EXTERNAL_MENU_BAR (f))
1247 Dimension ibw = 0;
1248 XtVaGetValues (f->output_data.x->column_widget,
1249 XtNinternalBorderWidth, &ibw, NULL);
1250 menubar_size += ibw;
1252 #endif /* USE_LUCID */
1253 #endif /* 1 */
1255 f->output_data.x->menubar_height = menubar_size;
1257 #endif /* not USE_GTK */
1259 free_menubar_widget_value_tree (first_wv);
1260 update_frame_menubar (f);
1262 #ifdef USE_GTK
1263 xg_crazy_callback_abort = 0;
1264 #endif
1266 unblock_input ();
1269 /* Called from Fx_create_frame to create the initial menubar of a frame
1270 before it is mapped, so that the window is mapped with the menubar already
1271 there instead of us tacking it on later and thrashing the window after it
1272 is visible. */
1274 void
1275 initialize_frame_menubar (FRAME_PTR f)
1277 /* This function is called before the first chance to redisplay
1278 the frame. It has to be, so the frame will have the right size. */
1279 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
1280 set_frame_menubar (f, 1, 1);
1284 /* Get rid of the menu bar of frame F, and free its storage.
1285 This is used when deleting a frame, and when turning off the menu bar.
1286 For GTK this function is in gtkutil.c. */
1288 #ifndef USE_GTK
1289 void
1290 free_frame_menubar (FRAME_PTR f)
1292 Widget menubar_widget;
1294 if (! FRAME_X_P (f))
1295 emacs_abort ();
1297 menubar_widget = f->output_data.x->menubar_widget;
1299 f->output_data.x->menubar_height = 0;
1301 if (menubar_widget)
1303 #ifdef USE_MOTIF
1304 /* Removing the menu bar magically changes the shell widget's x
1305 and y position of (0, 0) which, when the menu bar is turned
1306 on again, leads to pull-down menus appearing in strange
1307 positions near the upper-left corner of the display. This
1308 happens only with some window managers like twm and ctwm,
1309 but not with other like Motif's mwm or kwm, because the
1310 latter generate ConfigureNotify events when the menu bar
1311 is switched off, which fixes the shell position. */
1312 Position x0, y0, x1, y1;
1313 #endif
1315 block_input ();
1317 #ifdef USE_MOTIF
1318 if (f->output_data.x->widget)
1319 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
1320 #endif
1322 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1323 f->output_data.x->menubar_widget = NULL;
1325 if (f->output_data.x->widget)
1327 #ifdef USE_MOTIF
1328 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
1329 if (x1 == 0 && y1 == 0)
1330 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
1331 #endif
1332 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1334 unblock_input ();
1337 #endif /* not USE_GTK */
1339 #endif /* USE_X_TOOLKIT || USE_GTK */
1341 /* xmenu_show actually displays a menu using the panes and items in menu_items
1342 and returns the value selected from it.
1343 There are two versions of xmenu_show, one for Xt and one for Xlib.
1344 Both assume input is blocked by the caller. */
1346 /* F is the frame the menu is for.
1347 X and Y are the frame-relative specified position,
1348 relative to the inside upper left corner of the frame F.
1349 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
1350 KEYMAPS is 1 if this menu was specified with keymaps;
1351 in that case, we return a list containing the chosen item's value
1352 and perhaps also the pane's prefix.
1353 TITLE is the specified menu title.
1354 ERROR is a place to store an error message string in case of failure.
1355 (We return nil on failure, but the value doesn't actually matter.) */
1357 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1359 /* The item selected in the popup menu. */
1360 static Lisp_Object *volatile menu_item_selection;
1362 #ifdef USE_GTK
1364 /* Used when position a popup menu. See menu_position_func and
1365 create_and_show_popup_menu below. */
1366 struct next_popup_x_y
1368 FRAME_PTR f;
1369 int x;
1370 int y;
1373 /* The menu position function to use if we are not putting a popup
1374 menu where the pointer is.
1375 MENU is the menu to pop up.
1376 X and Y shall on exit contain x/y where the menu shall pop up.
1377 PUSH_IN is not documented in the GTK manual.
1378 USER_DATA is any data passed in when calling gtk_menu_popup.
1379 Here it points to a struct next_popup_x_y where the coordinates
1380 to store in *X and *Y are as well as the frame for the popup.
1382 Here only X and Y are used. */
1383 static void
1384 menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
1386 struct next_popup_x_y* data = (struct next_popup_x_y*)user_data;
1387 GtkRequisition req;
1388 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (data->f);
1389 int disp_width = x_display_pixel_width (dpyinfo);
1390 int disp_height = x_display_pixel_height (dpyinfo);
1392 *x = data->x;
1393 *y = data->y;
1395 /* Check if there is room for the menu. If not, adjust x/y so that
1396 the menu is fully visible. */
1397 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1398 if (data->x + req.width > disp_width)
1399 *x -= data->x + req.width - disp_width;
1400 if (data->y + req.height > disp_height)
1401 *y -= data->y + req.height - disp_height;
1404 static void
1405 popup_selection_callback (GtkWidget *widget, gpointer client_data)
1407 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
1409 if (xg_crazy_callback_abort) return;
1410 if (cb_data) menu_item_selection = (Lisp_Object *) cb_data->call_data;
1413 static Lisp_Object
1414 pop_down_menu (Lisp_Object arg)
1416 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1418 popup_activated_flag = 0;
1419 block_input ();
1420 gtk_widget_destroy (GTK_WIDGET (p->pointer));
1421 unblock_input ();
1422 return Qnil;
1425 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1426 menu pops down.
1427 menu_item_selection will be set to the selection. */
1428 static void
1429 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv, int x, int y,
1430 int for_click, Time timestamp)
1432 int i;
1433 GtkWidget *menu;
1434 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
1435 struct next_popup_x_y popup_x_y;
1436 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1437 int use_pos_func = ! for_click;
1439 #ifdef HAVE_GTK3
1440 /* Always use position function for Gtk3. Otherwise menus may become
1441 too small to show anything. */
1442 use_pos_func = 1;
1443 #endif
1445 if (! FRAME_X_P (f))
1446 emacs_abort ();
1448 xg_crazy_callback_abort = 1;
1449 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
1450 G_CALLBACK (popup_selection_callback),
1451 G_CALLBACK (popup_deactivate_callback),
1452 G_CALLBACK (menu_highlight_callback));
1453 xg_crazy_callback_abort = 0;
1455 if (use_pos_func)
1457 /* Not invoked by a click. pop up at x/y. */
1458 pos_func = menu_position_func;
1460 /* Adjust coordinates to be root-window-relative. */
1461 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1462 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1464 popup_x_y.x = x;
1465 popup_x_y.y = y;
1466 popup_x_y.f = f;
1468 i = 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
1471 if (for_click)
1473 for (i = 0; i < 5; i++)
1474 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1475 break;
1478 /* Display the menu. */
1479 gtk_widget_show_all (menu);
1481 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i,
1482 timestamp ? timestamp : gtk_get_current_event_time ());
1484 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
1486 if (gtk_widget_get_mapped (menu))
1488 /* Set this to one. popup_widget_loop increases it by one, so it becomes
1489 two. show_help_echo uses this to detect popup menus. */
1490 popup_activated_flag = 1;
1491 /* Process events that apply to the menu. */
1492 popup_widget_loop (1, menu);
1495 unbind_to (specpdl_count, Qnil);
1497 /* Must reset this manually because the button release event is not passed
1498 to Emacs event loop. */
1499 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
1502 #else /* not USE_GTK */
1504 /* We need a unique id for each widget handled by the Lucid Widget
1505 library.
1507 For the main windows, and popup menus, we use this counter,
1508 which we increment each time after use. This starts from 1<<16.
1510 For menu bars, we use numbers starting at 0, counted in
1511 next_menubar_widget_id. */
1512 LWLIB_ID widget_id_tick;
1514 static void
1515 popup_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1517 menu_item_selection = (Lisp_Object *) client_data;
1520 /* ARG is the LWLIB ID of the dialog box, represented
1521 as a Lisp object as (HIGHPART . LOWPART). */
1523 static Lisp_Object
1524 pop_down_menu (Lisp_Object arg)
1526 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
1527 | XINT (XCDR (arg)));
1529 block_input ();
1530 lw_destroy_all_widgets (id);
1531 unblock_input ();
1532 popup_activated_flag = 0;
1534 return Qnil;
1537 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1538 menu pops down.
1539 menu_item_selection will be set to the selection. */
1540 static void
1541 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv,
1542 int x, int y, int for_click, Time timestamp)
1544 int i;
1545 Arg av[2];
1546 int ac = 0;
1547 XEvent dummy;
1548 XButtonPressedEvent *event = &(dummy.xbutton);
1549 LWLIB_ID menu_id;
1550 Widget menu;
1552 if (! FRAME_X_P (f))
1553 emacs_abort ();
1555 #ifdef USE_LUCID
1556 apply_systemfont_to_menu (f, f->output_data.x->widget);
1557 #endif
1559 menu_id = widget_id_tick++;
1560 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
1561 f->output_data.x->widget, 1, 0,
1562 popup_selection_callback,
1563 popup_deactivate_callback,
1564 menu_highlight_callback);
1566 event->type = ButtonPress;
1567 event->serial = 0;
1568 event->send_event = 0;
1569 event->display = FRAME_X_DISPLAY (f);
1570 event->time = CurrentTime;
1571 event->root = FRAME_X_DISPLAY_INFO (f)->root_window;
1572 event->window = event->subwindow = event->root;
1573 event->x = x;
1574 event->y = y;
1576 /* Adjust coordinates to be root-window-relative. */
1577 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1578 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1580 event->x_root = x;
1581 event->y_root = y;
1583 event->state = 0;
1584 event->button = 0;
1585 for (i = 0; i < 5; i++)
1586 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1587 event->button = i;
1589 /* Don't allow any geometry request from the user. */
1590 XtSetArg (av[ac], XtNgeometry, 0); ac++;
1591 XtSetValues (menu, av, ac);
1593 /* Display the menu. */
1594 lw_popup_menu (menu, &dummy);
1595 popup_activated_flag = 1;
1596 x_activate_timeout_atimer ();
1599 int fact = 4 * sizeof (LWLIB_ID);
1600 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1601 record_unwind_protect (pop_down_menu,
1602 Fcons (make_number (menu_id >> (fact)),
1603 make_number (menu_id & ~(-1 << (fact)))));
1605 /* Process events that apply to the menu. */
1606 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), menu_id, 1);
1608 unbind_to (specpdl_count, Qnil);
1612 #endif /* not USE_GTK */
1614 static Lisp_Object
1615 cleanup_widget_value_tree (Lisp_Object arg)
1617 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1618 widget_value *wv = p->pointer;
1620 free_menubar_widget_value_tree (wv);
1622 return Qnil;
1625 Lisp_Object
1626 xmenu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
1627 Lisp_Object title, const char **error_name, Time timestamp)
1629 int i;
1630 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1631 widget_value **submenu_stack
1632 = alloca (menu_items_used * sizeof *submenu_stack);
1633 Lisp_Object *subprefix_stack
1634 = alloca (menu_items_used * sizeof *subprefix_stack);
1635 int submenu_depth = 0;
1637 int first_pane;
1639 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1641 if (! FRAME_X_P (f))
1642 emacs_abort ();
1644 *error_name = NULL;
1646 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1648 *error_name = "Empty menu";
1649 return Qnil;
1652 /* Create a tree of widget_value objects
1653 representing the panes and their items. */
1654 wv = xmalloc_widget_value ();
1655 wv->name = "menu";
1656 wv->value = 0;
1657 wv->enabled = 1;
1658 wv->button_type = BUTTON_TYPE_NONE;
1659 wv->help =Qnil;
1660 first_wv = wv;
1661 first_pane = 1;
1663 /* Loop over all panes and items, filling in the tree. */
1664 i = 0;
1665 while (i < menu_items_used)
1667 if (EQ (AREF (menu_items, i), Qnil))
1669 submenu_stack[submenu_depth++] = save_wv;
1670 save_wv = prev_wv;
1671 prev_wv = 0;
1672 first_pane = 1;
1673 i++;
1675 else if (EQ (AREF (menu_items, i), Qlambda))
1677 prev_wv = save_wv;
1678 save_wv = submenu_stack[--submenu_depth];
1679 first_pane = 0;
1680 i++;
1682 else if (EQ (AREF (menu_items, i), Qt)
1683 && submenu_depth != 0)
1684 i += MENU_ITEMS_PANE_LENGTH;
1685 /* Ignore a nil in the item list.
1686 It's meaningful only for dialog boxes. */
1687 else if (EQ (AREF (menu_items, i), Qquote))
1688 i += 1;
1689 else if (EQ (AREF (menu_items, i), Qt))
1691 /* Create a new pane. */
1692 Lisp_Object pane_name, prefix;
1693 const char *pane_string;
1695 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1696 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1698 #ifndef HAVE_MULTILINGUAL_MENU
1699 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1701 pane_name = ENCODE_MENU_STRING (pane_name);
1702 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1704 #endif
1705 pane_string = (NILP (pane_name)
1706 ? "" : SSDATA (pane_name));
1707 /* If there is just one top-level pane, put all its items directly
1708 under the top-level menu. */
1709 if (menu_items_n_panes == 1)
1710 pane_string = "";
1712 /* If the pane has a meaningful name,
1713 make the pane a top-level menu item
1714 with its items as a submenu beneath it. */
1715 if (!keymaps && strcmp (pane_string, ""))
1717 wv = xmalloc_widget_value ();
1718 if (save_wv)
1719 save_wv->next = wv;
1720 else
1721 first_wv->contents = wv;
1722 wv->name = (char *) pane_string;
1723 if (keymaps && !NILP (prefix))
1724 wv->name++;
1725 wv->value = 0;
1726 wv->enabled = 1;
1727 wv->button_type = BUTTON_TYPE_NONE;
1728 wv->help = Qnil;
1729 save_wv = wv;
1730 prev_wv = 0;
1732 else if (first_pane)
1734 save_wv = wv;
1735 prev_wv = 0;
1737 first_pane = 0;
1738 i += MENU_ITEMS_PANE_LENGTH;
1740 else
1742 /* Create a new item within current pane. */
1743 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1744 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1745 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1746 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1747 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1748 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1749 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1750 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1752 #ifndef HAVE_MULTILINGUAL_MENU
1753 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
1755 item_name = ENCODE_MENU_STRING (item_name);
1756 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1759 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1761 descrip = ENCODE_MENU_STRING (descrip);
1762 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1764 #endif /* not HAVE_MULTILINGUAL_MENU */
1766 wv = xmalloc_widget_value ();
1767 if (prev_wv)
1768 prev_wv->next = wv;
1769 else
1770 save_wv->contents = wv;
1771 wv->name = SSDATA (item_name);
1772 if (!NILP (descrip))
1773 wv->key = SSDATA (descrip);
1774 wv->value = 0;
1775 /* If this item has a null value,
1776 make the call_data null so that it won't display a box
1777 when the mouse is on it. */
1778 wv->call_data = !NILP (def) ? aref_addr (menu_items, i) : 0;
1779 wv->enabled = !NILP (enable);
1781 if (NILP (type))
1782 wv->button_type = BUTTON_TYPE_NONE;
1783 else if (EQ (type, QCtoggle))
1784 wv->button_type = BUTTON_TYPE_TOGGLE;
1785 else if (EQ (type, QCradio))
1786 wv->button_type = BUTTON_TYPE_RADIO;
1787 else
1788 emacs_abort ();
1790 wv->selected = !NILP (selected);
1792 if (! STRINGP (help))
1793 help = Qnil;
1795 wv->help = help;
1797 prev_wv = wv;
1799 i += MENU_ITEMS_ITEM_LENGTH;
1803 /* Deal with the title, if it is non-nil. */
1804 if (!NILP (title))
1806 widget_value *wv_title = xmalloc_widget_value ();
1807 widget_value *wv_sep1 = xmalloc_widget_value ();
1808 widget_value *wv_sep2 = xmalloc_widget_value ();
1810 wv_sep2->name = "--";
1811 wv_sep2->next = first_wv->contents;
1812 wv_sep2->help = Qnil;
1814 wv_sep1->name = "--";
1815 wv_sep1->next = wv_sep2;
1816 wv_sep1->help = Qnil;
1818 #ifndef HAVE_MULTILINGUAL_MENU
1819 if (STRING_MULTIBYTE (title))
1820 title = ENCODE_MENU_STRING (title);
1821 #endif
1823 wv_title->name = SSDATA (title);
1824 wv_title->enabled = TRUE;
1825 wv_title->button_type = BUTTON_TYPE_NONE;
1826 wv_title->help = Qnil;
1827 wv_title->next = wv_sep1;
1828 first_wv->contents = wv_title;
1831 /* No selection has been chosen yet. */
1832 menu_item_selection = 0;
1834 /* Make sure to free the widget_value objects we used to specify the
1835 contents even with longjmp. */
1836 record_unwind_protect (cleanup_widget_value_tree,
1837 make_save_value (first_wv, 0));
1839 /* Actually create and show the menu until popped down. */
1840 create_and_show_popup_menu (f, first_wv, x, y, for_click, timestamp);
1842 unbind_to (specpdl_count, Qnil);
1844 /* Find the selected item, and its pane, to return
1845 the proper value. */
1846 if (menu_item_selection != 0)
1848 Lisp_Object prefix, entry;
1850 prefix = entry = Qnil;
1851 i = 0;
1852 while (i < menu_items_used)
1854 if (EQ (AREF (menu_items, i), Qnil))
1856 subprefix_stack[submenu_depth++] = prefix;
1857 prefix = entry;
1858 i++;
1860 else if (EQ (AREF (menu_items, i), Qlambda))
1862 prefix = subprefix_stack[--submenu_depth];
1863 i++;
1865 else if (EQ (AREF (menu_items, i), Qt))
1867 prefix
1868 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1869 i += MENU_ITEMS_PANE_LENGTH;
1871 /* Ignore a nil in the item list.
1872 It's meaningful only for dialog boxes. */
1873 else if (EQ (AREF (menu_items, i), Qquote))
1874 i += 1;
1875 else
1877 entry
1878 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1879 if (menu_item_selection == aref_addr (menu_items, i))
1881 if (keymaps != 0)
1883 int j;
1885 entry = Fcons (entry, Qnil);
1886 if (!NILP (prefix))
1887 entry = Fcons (prefix, entry);
1888 for (j = submenu_depth - 1; j >= 0; j--)
1889 if (!NILP (subprefix_stack[j]))
1890 entry = Fcons (subprefix_stack[j], entry);
1892 return entry;
1894 i += MENU_ITEMS_ITEM_LENGTH;
1898 else if (!for_click)
1899 /* Make "Cancel" equivalent to C-g. */
1900 Fsignal (Qquit, Qnil);
1902 return Qnil;
1905 #ifdef USE_GTK
1906 static void
1907 dialog_selection_callback (GtkWidget *widget, gpointer client_data)
1909 /* Treat the pointer as an integer. There's no problem
1910 as long as pointers have enough bits to hold small integers. */
1911 if ((intptr_t) client_data != -1)
1912 menu_item_selection = (Lisp_Object *) client_data;
1914 popup_activated_flag = 0;
1917 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1918 dialog pops down.
1919 menu_item_selection will be set to the selection. */
1920 static void
1921 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1923 GtkWidget *menu;
1925 if (! FRAME_X_P (f))
1926 emacs_abort ();
1928 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
1929 G_CALLBACK (dialog_selection_callback),
1930 G_CALLBACK (popup_deactivate_callback),
1933 if (menu)
1935 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1936 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
1938 /* Display the menu. */
1939 gtk_widget_show_all (menu);
1941 /* Process events that apply to the menu. */
1942 popup_widget_loop (1, menu);
1944 unbind_to (specpdl_count, Qnil);
1948 #else /* not USE_GTK */
1949 static void
1950 dialog_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1952 /* Treat the pointer as an integer. There's no problem
1953 as long as pointers have enough bits to hold small integers. */
1954 if ((intptr_t) client_data != -1)
1955 menu_item_selection = (Lisp_Object *) client_data;
1957 block_input ();
1958 lw_destroy_all_widgets (id);
1959 unblock_input ();
1960 popup_activated_flag = 0;
1964 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1965 dialog pops down.
1966 menu_item_selection will be set to the selection. */
1967 static void
1968 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1970 LWLIB_ID dialog_id;
1972 if (!FRAME_X_P (f))
1973 emacs_abort ();
1975 dialog_id = widget_id_tick++;
1976 #ifdef USE_LUCID
1977 apply_systemfont_to_dialog (f->output_data.x->widget);
1978 #endif
1979 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
1980 f->output_data.x->widget, 1, 0,
1981 dialog_selection_callback, 0, 0);
1982 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
1983 /* Display the dialog box. */
1984 lw_pop_up_all_widgets (dialog_id);
1985 popup_activated_flag = 1;
1986 x_activate_timeout_atimer ();
1988 /* Process events that apply to the dialog box.
1989 Also handle timers. */
1991 ptrdiff_t count = SPECPDL_INDEX ();
1992 int fact = 4 * sizeof (LWLIB_ID);
1994 /* xdialog_show_unwind is responsible for popping the dialog box down. */
1995 record_unwind_protect (pop_down_menu,
1996 Fcons (make_number (dialog_id >> (fact)),
1997 make_number (dialog_id & ~(-1 << (fact)))));
1999 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f),
2000 dialog_id, 1);
2002 unbind_to (count, Qnil);
2006 #endif /* not USE_GTK */
2008 static const char * button_names [] = {
2009 "button1", "button2", "button3", "button4", "button5",
2010 "button6", "button7", "button8", "button9", "button10" };
2012 static Lisp_Object
2013 xdialog_show (FRAME_PTR f,
2014 int keymaps,
2015 Lisp_Object title,
2016 Lisp_Object header,
2017 const char **error_name)
2019 int i, nb_buttons=0;
2020 char dialog_name[6];
2022 widget_value *wv, *first_wv = 0, *prev_wv = 0;
2024 /* Number of elements seen so far, before boundary. */
2025 int left_count = 0;
2026 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
2027 int boundary_seen = 0;
2029 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2031 if (! FRAME_X_P (f))
2032 emacs_abort ();
2034 *error_name = NULL;
2036 if (menu_items_n_panes > 1)
2038 *error_name = "Multiple panes in dialog box";
2039 return Qnil;
2042 /* Create a tree of widget_value objects
2043 representing the text label and buttons. */
2045 Lisp_Object pane_name, prefix;
2046 const char *pane_string;
2047 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
2048 prefix = AREF (menu_items, MENU_ITEMS_PANE_PREFIX);
2049 pane_string = (NILP (pane_name)
2050 ? "" : SSDATA (pane_name));
2051 prev_wv = xmalloc_widget_value ();
2052 prev_wv->value = (char *) pane_string;
2053 if (keymaps && !NILP (prefix))
2054 prev_wv->name++;
2055 prev_wv->enabled = 1;
2056 prev_wv->name = "message";
2057 prev_wv->help = Qnil;
2058 first_wv = prev_wv;
2060 /* Loop over all panes and items, filling in the tree. */
2061 i = MENU_ITEMS_PANE_LENGTH;
2062 while (i < menu_items_used)
2065 /* Create a new item within current pane. */
2066 Lisp_Object item_name, enable, descrip;
2067 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2068 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2069 descrip
2070 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2072 if (NILP (item_name))
2074 free_menubar_widget_value_tree (first_wv);
2075 *error_name = "Submenu in dialog items";
2076 return Qnil;
2078 if (EQ (item_name, Qquote))
2080 /* This is the boundary between left-side elts
2081 and right-side elts. Stop incrementing right_count. */
2082 boundary_seen = 1;
2083 i++;
2084 continue;
2086 if (nb_buttons >= 9)
2088 free_menubar_widget_value_tree (first_wv);
2089 *error_name = "Too many dialog items";
2090 return Qnil;
2093 wv = xmalloc_widget_value ();
2094 prev_wv->next = wv;
2095 wv->name = (char *) button_names[nb_buttons];
2096 if (!NILP (descrip))
2097 wv->key = SSDATA (descrip);
2098 wv->value = SSDATA (item_name);
2099 wv->call_data = aref_addr (menu_items, i);
2100 wv->enabled = !NILP (enable);
2101 wv->help = Qnil;
2102 prev_wv = wv;
2104 if (! boundary_seen)
2105 left_count++;
2107 nb_buttons++;
2108 i += MENU_ITEMS_ITEM_LENGTH;
2111 /* If the boundary was not specified,
2112 by default put half on the left and half on the right. */
2113 if (! boundary_seen)
2114 left_count = nb_buttons - nb_buttons / 2;
2116 wv = xmalloc_widget_value ();
2117 wv->name = dialog_name;
2118 wv->help = Qnil;
2120 /* Frame title: 'Q' = Question, 'I' = Information.
2121 Can also have 'E' = Error if, one day, we want
2122 a popup for errors. */
2123 if (NILP (header))
2124 dialog_name[0] = 'Q';
2125 else
2126 dialog_name[0] = 'I';
2128 /* Dialog boxes use a really stupid name encoding
2129 which specifies how many buttons to use
2130 and how many buttons are on the right. */
2131 dialog_name[1] = '0' + nb_buttons;
2132 dialog_name[2] = 'B';
2133 dialog_name[3] = 'R';
2134 /* Number of buttons to put on the right. */
2135 dialog_name[4] = '0' + nb_buttons - left_count;
2136 dialog_name[5] = 0;
2137 wv->contents = first_wv;
2138 first_wv = wv;
2141 /* No selection has been chosen yet. */
2142 menu_item_selection = 0;
2144 /* Make sure to free the widget_value objects we used to specify the
2145 contents even with longjmp. */
2146 record_unwind_protect (cleanup_widget_value_tree,
2147 make_save_value (first_wv, 0));
2149 /* Actually create and show the dialog. */
2150 create_and_show_dialog (f, first_wv);
2152 unbind_to (specpdl_count, Qnil);
2154 /* Find the selected item, and its pane, to return
2155 the proper value. */
2156 if (menu_item_selection != 0)
2158 Lisp_Object prefix;
2160 prefix = Qnil;
2161 i = 0;
2162 while (i < menu_items_used)
2164 Lisp_Object entry;
2166 if (EQ (AREF (menu_items, i), Qt))
2168 prefix
2169 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2170 i += MENU_ITEMS_PANE_LENGTH;
2172 else if (EQ (AREF (menu_items, i), Qquote))
2174 /* This is the boundary between left-side elts and
2175 right-side elts. */
2176 ++i;
2178 else
2180 entry
2181 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2182 if (menu_item_selection == aref_addr (menu_items, i))
2184 if (keymaps != 0)
2186 entry = Fcons (entry, Qnil);
2187 if (!NILP (prefix))
2188 entry = Fcons (prefix, entry);
2190 return entry;
2192 i += MENU_ITEMS_ITEM_LENGTH;
2196 else
2197 /* Make "Cancel" equivalent to C-g. */
2198 Fsignal (Qquit, Qnil);
2200 return Qnil;
2203 #else /* not USE_X_TOOLKIT && not USE_GTK */
2205 /* The frame of the last activated non-toolkit menu bar.
2206 Used to generate menu help events. */
2208 static struct frame *menu_help_frame;
2211 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
2213 PANE is the pane number, and ITEM is the menu item number in
2214 the menu (currently not used).
2216 This cannot be done with generating a HELP_EVENT because
2217 XMenuActivate contains a loop that doesn't let Emacs process
2218 keyboard events. */
2220 static void
2221 menu_help_callback (char const *help_string, int pane, int item)
2223 Lisp_Object *first_item;
2224 Lisp_Object pane_name;
2225 Lisp_Object menu_object;
2227 first_item = XVECTOR (menu_items)->contents;
2228 if (EQ (first_item[0], Qt))
2229 pane_name = first_item[MENU_ITEMS_PANE_NAME];
2230 else if (EQ (first_item[0], Qquote))
2231 /* This shouldn't happen, see xmenu_show. */
2232 pane_name = empty_unibyte_string;
2233 else
2234 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
2236 /* (menu-item MENU-NAME PANE-NUMBER) */
2237 menu_object = Fcons (Qmenu_item,
2238 Fcons (pane_name,
2239 Fcons (make_number (pane), Qnil)));
2240 show_help_echo (help_string ? build_string (help_string) : Qnil,
2241 Qnil, menu_object, make_number (item));
2244 static Lisp_Object
2245 pop_down_menu (Lisp_Object arg)
2247 struct Lisp_Save_Value *p1 = XSAVE_VALUE (Fcar (arg));
2248 struct Lisp_Save_Value *p2 = XSAVE_VALUE (Fcdr (arg));
2250 FRAME_PTR f = p1->pointer;
2251 XMenu *menu = p2->pointer;
2253 block_input ();
2254 #ifndef MSDOS
2255 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
2256 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
2257 #endif
2258 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2260 #ifdef HAVE_X_WINDOWS
2261 /* Assume the mouse has moved out of the X window.
2262 If it has actually moved in, we will get an EnterNotify. */
2263 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
2265 /* State that no mouse buttons are now held.
2266 (The oldXMenu code doesn't track this info for us.)
2267 That is not necessarily true, but the fiction leads to reasonable
2268 results, and it is a pain to ask which are actually held now. */
2269 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2271 #endif /* HAVE_X_WINDOWS */
2273 unblock_input ();
2275 return Qnil;
2279 Lisp_Object
2280 xmenu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
2281 Lisp_Object title, const char **error_name, Time timestamp)
2283 Window root;
2284 XMenu *menu;
2285 int pane, selidx, lpane, status;
2286 Lisp_Object entry, pane_prefix;
2287 char *datap;
2288 int ulx, uly, width, height;
2289 int dispwidth, dispheight;
2290 int i, j, lines, maxlines;
2291 int maxwidth;
2292 int dummy_int;
2293 unsigned int dummy_uint;
2294 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2296 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
2297 emacs_abort ();
2299 *error_name = 0;
2300 if (menu_items_n_panes == 0)
2301 return Qnil;
2303 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2305 *error_name = "Empty menu";
2306 return Qnil;
2309 /* Figure out which root window F is on. */
2310 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2311 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2312 &dummy_uint, &dummy_uint);
2314 /* Make the menu on that window. */
2315 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2316 if (menu == NULL)
2318 *error_name = "Can't create menu";
2319 return Qnil;
2322 /* Don't GC while we prepare and show the menu,
2323 because we give the oldxmenu library pointers to the
2324 contents of strings. */
2325 inhibit_garbage_collection ();
2327 #ifdef HAVE_X_WINDOWS
2328 /* Adjust coordinates to relative to the outer (window manager) window. */
2329 x += FRAME_OUTER_TO_INNER_DIFF_X (f);
2330 y += FRAME_OUTER_TO_INNER_DIFF_Y (f);
2331 #endif /* HAVE_X_WINDOWS */
2333 /* Adjust coordinates to be root-window-relative. */
2334 x += f->left_pos;
2335 y += f->top_pos;
2337 /* Create all the necessary panes and their items. */
2338 maxwidth = maxlines = lines = i = 0;
2339 lpane = XM_FAILURE;
2340 while (i < menu_items_used)
2342 if (EQ (AREF (menu_items, i), Qt))
2344 /* Create a new pane. */
2345 Lisp_Object pane_name, prefix;
2346 const char *pane_string;
2348 maxlines = max (maxlines, lines);
2349 lines = 0;
2350 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
2351 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2352 pane_string = (NILP (pane_name)
2353 ? "" : SSDATA (pane_name));
2354 if (keymaps && !NILP (prefix))
2355 pane_string++;
2357 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2358 if (lpane == XM_FAILURE)
2360 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2361 *error_name = "Can't create pane";
2362 return Qnil;
2364 i += MENU_ITEMS_PANE_LENGTH;
2366 /* Find the width of the widest item in this pane. */
2367 j = i;
2368 while (j < menu_items_used)
2370 Lisp_Object item;
2371 item = AREF (menu_items, j);
2372 if (EQ (item, Qt))
2373 break;
2374 if (NILP (item))
2376 j++;
2377 continue;
2379 width = SBYTES (item);
2380 if (width > maxwidth)
2381 maxwidth = width;
2383 j += MENU_ITEMS_ITEM_LENGTH;
2386 /* Ignore a nil in the item list.
2387 It's meaningful only for dialog boxes. */
2388 else if (EQ (AREF (menu_items, i), Qquote))
2389 i += 1;
2390 else
2392 /* Create a new item within current pane. */
2393 Lisp_Object item_name, enable, descrip, help;
2394 char *item_data;
2395 char const *help_string;
2397 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2398 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2399 descrip
2400 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2401 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
2402 help_string = STRINGP (help) ? SSDATA (help) : NULL;
2404 if (!NILP (descrip))
2406 /* if alloca is fast, use that to make the space,
2407 to reduce gc needs. */
2408 item_data = alloca (maxwidth + SBYTES (descrip) + 1);
2409 memcpy (item_data, SSDATA (item_name), SBYTES (item_name));
2410 for (j = SCHARS (item_name); j < maxwidth; j++)
2411 item_data[j] = ' ';
2412 memcpy (item_data + j, SSDATA (descrip), SBYTES (descrip));
2413 item_data[j + SBYTES (descrip)] = 0;
2415 else
2416 item_data = SSDATA (item_name);
2418 if (lpane == XM_FAILURE
2419 || (XMenuAddSelection (FRAME_X_DISPLAY (f),
2420 menu, lpane, 0, item_data,
2421 !NILP (enable), help_string)
2422 == XM_FAILURE))
2424 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2425 *error_name = "Can't add selection to menu";
2426 return Qnil;
2428 i += MENU_ITEMS_ITEM_LENGTH;
2429 lines++;
2433 maxlines = max (maxlines, lines);
2435 /* All set and ready to fly. */
2436 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2437 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2438 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2439 x = min (x, dispwidth);
2440 y = min (y, dispheight);
2441 x = max (x, 1);
2442 y = max (y, 1);
2443 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2444 &ulx, &uly, &width, &height);
2445 if (ulx+width > dispwidth)
2447 x -= (ulx + width) - dispwidth;
2448 ulx = dispwidth - width;
2450 if (uly+height > dispheight)
2452 y -= (uly + height) - dispheight;
2453 uly = dispheight - height;
2455 #ifndef HAVE_X_WINDOWS
2456 if (FRAME_HAS_MINIBUF_P (f) && uly+height > dispheight - 1)
2458 /* Move the menu away of the echo area, to avoid overwriting the
2459 menu with help echo messages or vice versa. */
2460 if (BUFFERP (echo_area_buffer[0]) && WINDOWP (echo_area_window))
2462 y -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2463 uly -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2465 else
2467 y--;
2468 uly--;
2471 #endif
2472 if (ulx < 0) x -= ulx;
2473 if (uly < 0) y -= uly;
2475 if (! for_click)
2477 /* If position was not given by a mouse click, adjust so upper left
2478 corner of the menu as a whole ends up at given coordinates. This
2479 is what x-popup-menu says in its documentation. */
2480 x += width/2;
2481 y += 1.5*height/(maxlines+2);
2484 XMenuSetAEQ (menu, TRUE);
2485 XMenuSetFreeze (menu, TRUE);
2486 pane = selidx = 0;
2488 #ifndef MSDOS
2489 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
2490 #endif
2492 record_unwind_protect (pop_down_menu,
2493 Fcons (make_save_value (f, 0),
2494 make_save_value (menu, 0)));
2496 /* Help display under X won't work because XMenuActivate contains
2497 a loop that doesn't give Emacs a chance to process it. */
2498 menu_help_frame = f;
2499 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2500 x, y, ButtonReleaseMask, &datap,
2501 menu_help_callback);
2502 entry = pane_prefix = Qnil;
2504 switch (status)
2506 case XM_SUCCESS:
2507 #ifdef XDEBUG
2508 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2509 #endif
2511 /* Find the item number SELIDX in pane number PANE. */
2512 i = 0;
2513 while (i < menu_items_used)
2515 if (EQ (AREF (menu_items, i), Qt))
2517 if (pane == 0)
2518 pane_prefix
2519 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2520 pane--;
2521 i += MENU_ITEMS_PANE_LENGTH;
2523 else
2525 if (pane == -1)
2527 if (selidx == 0)
2529 entry
2530 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2531 if (keymaps != 0)
2533 entry = Fcons (entry, Qnil);
2534 if (!NILP (pane_prefix))
2535 entry = Fcons (pane_prefix, entry);
2537 break;
2539 selidx--;
2541 i += MENU_ITEMS_ITEM_LENGTH;
2544 break;
2546 case XM_FAILURE:
2547 *error_name = "Can't activate menu";
2548 case XM_IA_SELECT:
2549 break;
2550 case XM_NO_SELECT:
2551 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
2552 the menu was invoked with a mouse event as POSITION). */
2553 if (! for_click)
2554 Fsignal (Qquit, Qnil);
2555 break;
2558 unbind_to (specpdl_count, Qnil);
2560 return entry;
2563 #endif /* not USE_X_TOOLKIT */
2565 #endif /* HAVE_MENUS */
2567 #ifndef MSDOS
2568 /* Detect if a dialog or menu has been posted. MSDOS has its own
2569 implementation on msdos.c. */
2571 int ATTRIBUTE_CONST
2572 popup_activated (void)
2574 return popup_activated_flag;
2576 #endif /* not MSDOS */
2578 /* The following is used by delayed window autoselection. */
2580 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
2581 doc: /* Return t if a menu or popup dialog is active. */)
2582 (void)
2584 #ifdef HAVE_MENUS
2585 return (popup_activated ()) ? Qt : Qnil;
2586 #else
2587 return Qnil;
2588 #endif /* HAVE_MENUS */
2591 void
2592 syms_of_xmenu (void)
2594 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
2596 #ifdef USE_X_TOOLKIT
2597 widget_id_tick = (1<<16);
2598 next_menubar_widget_id = 1;
2599 #endif
2601 defsubr (&Smenu_or_popup_active_p);
2603 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
2604 defsubr (&Sx_menu_bar_open_internal);
2605 Ffset (intern_c_string ("accelerate-menu"),
2606 intern_c_string (Sx_menu_bar_open_internal.symbol_name));
2607 #endif
2609 #ifdef HAVE_MENUS
2610 defsubr (&Sx_popup_dialog);
2611 #endif