Prevent Gnus from loading PGG.
[emacs.git] / src / xmenu.c
blobfc629b35104b2d3790cd28307f647e019c5e45d0
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 #endif /* no TRUE */
113 static Lisp_Object Qdebug_on_next_call;
115 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
116 static Lisp_Object xdialog_show (FRAME_PTR, int, Lisp_Object, Lisp_Object,
117 const char **);
118 #endif
120 /* Flag which when set indicates a dialog or menu has been posted by
121 Xt on behalf of one of the widget sets. */
122 static int popup_activated_flag;
125 #ifdef USE_X_TOOLKIT
127 static int next_menubar_widget_id;
129 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
131 static struct frame *
132 menubar_id_to_frame (LWLIB_ID id)
134 Lisp_Object tail, frame;
135 FRAME_PTR f;
137 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
139 frame = XCAR (tail);
140 if (!FRAMEP (frame))
141 continue;
142 f = XFRAME (frame);
143 if (!FRAME_WINDOW_P (f))
144 continue;
145 if (f->output_data.x->id == id)
146 return f;
148 return 0;
151 #endif
153 #ifdef HAVE_X_WINDOWS
154 /* Return the mouse position in *X and *Y. The coordinates are window
155 relative for the edit window in frame F.
156 This is for Fx_popup_menu. The mouse_position_hook can not
157 be used for X, as it returns window relative coordinates
158 for the window where the mouse is in. This could be the menu bar,
159 the scroll bar or the edit window. Fx_popup_menu needs to be
160 sure it is the edit window. */
161 void
162 mouse_position_for_popup (FRAME_PTR f, int *x, int *y)
164 Window root, dummy_window;
165 int dummy;
167 if (! FRAME_X_P (f))
168 abort ();
170 BLOCK_INPUT;
172 XQueryPointer (FRAME_X_DISPLAY (f),
173 DefaultRootWindow (FRAME_X_DISPLAY (f)),
175 /* The root window which contains the pointer. */
176 &root,
178 /* Window pointer is on, not used */
179 &dummy_window,
181 /* The position on that root window. */
182 x, y,
184 /* x/y in dummy_window coordinates, not used. */
185 &dummy, &dummy,
187 /* Modifier keys and pointer buttons, about which
188 we don't care. */
189 (unsigned int *) &dummy);
191 UNBLOCK_INPUT;
193 /* xmenu_show expects window coordinates, not root window
194 coordinates. Translate. */
195 *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
196 *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
199 #endif /* HAVE_X_WINDOWS */
201 #ifdef HAVE_MENUS
203 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
204 doc: /* Pop up a dialog box and return user's selection.
205 POSITION specifies which frame to use.
206 This is normally a mouse button event or a window or frame.
207 If POSITION is t, it means to use the frame the mouse is on.
208 The dialog box appears in the middle of the specified frame.
210 CONTENTS specifies the alternatives to display in the dialog box.
211 It is a list of the form (DIALOG ITEM1 ITEM2...).
212 Each ITEM is a cons cell (STRING . VALUE).
213 The return value is VALUE from the chosen item.
215 An ITEM may also be just a string--that makes a nonselectable item.
216 An ITEM may also be nil--that means to put all preceding items
217 on the left of the dialog box and all following items on the right.
218 \(By default, approximately half appear on each side.)
220 If HEADER is non-nil, the frame title for the box is "Information",
221 otherwise it is "Question".
223 If the user gets rid of the dialog box without making a valid choice,
224 for instance using the window manager, then this produces a quit and
225 `x-popup-dialog' does not return. */)
226 (Lisp_Object position, Lisp_Object contents, Lisp_Object header)
228 FRAME_PTR f = NULL;
229 Lisp_Object window;
231 check_x ();
233 /* Decode the first argument: find the window or frame to use. */
234 if (EQ (position, Qt)
235 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
236 || EQ (XCAR (position), Qtool_bar))))
238 #if 0 /* Using the frame the mouse is on may not be right. */
239 /* Use the mouse's current position. */
240 FRAME_PTR new_f = SELECTED_FRAME ();
241 Lisp_Object bar_window;
242 enum scroll_bar_part part;
243 Time time;
244 Lisp_Object x, y;
246 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
248 if (new_f != 0)
249 XSETFRAME (window, new_f);
250 else
251 window = selected_window;
252 #endif
253 window = selected_window;
255 else if (CONSP (position))
257 Lisp_Object tem;
258 tem = Fcar (position);
259 if (CONSP (tem))
260 window = Fcar (Fcdr (position));
261 else
263 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
264 window = Fcar (tem); /* POSN_WINDOW (tem) */
267 else if (WINDOWP (position) || FRAMEP (position))
268 window = position;
269 else
270 window = Qnil;
272 /* Decode where to put the menu. */
274 if (FRAMEP (window))
275 f = XFRAME (window);
276 else if (WINDOWP (window))
278 CHECK_LIVE_WINDOW (window);
279 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
281 else
282 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
283 but I don't want to make one now. */
284 CHECK_WINDOW (window);
286 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
287 error ("Can not put X dialog on this terminal");
289 /* Force a redisplay before showing the dialog. If a frame is created
290 just before showing the dialog, its contents may not have been fully
291 drawn, as this depends on timing of events from the X server. Redisplay
292 is not done when a dialog is shown. If redisplay could be done in the
293 X event loop (i.e. the X event loop does not run in a signal handler)
294 this would not be needed.
296 Do this before creating the widget value that points to Lisp
297 string contents, because Fredisplay may GC and relocate them. */
298 Fredisplay (Qt);
300 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
301 /* Display a menu with these alternatives
302 in the middle of frame F. */
304 Lisp_Object x, y, frame, newpos;
305 XSETFRAME (frame, f);
306 XSETINT (x, x_pixel_width (f) / 2);
307 XSETINT (y, x_pixel_height (f) / 2);
308 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
310 return Fx_popup_menu (newpos,
311 Fcons (Fcar (contents), Fcons (contents, Qnil)));
313 #else
315 Lisp_Object title;
316 const char *error_name;
317 Lisp_Object selection;
318 int specpdl_count = SPECPDL_INDEX ();
320 /* Decode the dialog items from what was specified. */
321 title = Fcar (contents);
322 CHECK_STRING (title);
323 record_unwind_protect (unuse_menu_items, Qnil);
325 if (NILP (Fcar (Fcdr (contents))))
326 /* No buttons specified, add an "Ok" button so users can pop down
327 the dialog. Also, the lesstif/motif version crashes if there are
328 no buttons. */
329 contents = Fcons (title, Fcons (Fcons (build_string ("Ok"), Qt), Qnil));
331 list_of_panes (Fcons (contents, Qnil));
333 /* Display them in a dialog box. */
334 BLOCK_INPUT;
335 selection = xdialog_show (f, 0, title, header, &error_name);
336 UNBLOCK_INPUT;
338 unbind_to (specpdl_count, Qnil);
339 discard_menu_items ();
341 if (error_name) error ("%s", error_name);
342 return selection;
344 #endif
348 #ifndef MSDOS
350 #if defined USE_GTK || defined USE_MOTIF
352 /* Set menu_items_inuse so no other popup menu or dialog is created. */
354 void
355 x_menu_set_in_use (int in_use)
357 menu_items_inuse = in_use ? Qt : Qnil;
358 popup_activated_flag = in_use;
359 #ifdef USE_X_TOOLKIT
360 if (popup_activated_flag)
361 x_activate_timeout_atimer ();
362 #endif
365 #endif
367 /* Wait for an X event to arrive or for a timer to expire. */
369 #ifndef USE_MOTIF
370 static
371 #endif
372 void
373 x_menu_wait_for_event (void *data)
375 /* Another way to do this is to register a timer callback, that can be
376 done in GTK and Xt. But we have to do it like this when using only X
377 anyway, and with callbacks we would have three variants for timer handling
378 instead of the small ifdefs below. */
380 while (
381 #ifdef USE_X_TOOLKIT
382 ! XtAppPending (Xt_app_con)
383 #elif defined USE_GTK
384 ! gtk_events_pending ()
385 #else
386 ! XPending ((Display*) data)
387 #endif
390 EMACS_TIME next_time = timer_check (), *ntp;
391 long secs = EMACS_SECS (next_time);
392 long usecs = EMACS_USECS (next_time);
393 SELECT_TYPE read_fds;
394 struct x_display_info *dpyinfo;
395 int n = 0;
397 FD_ZERO (&read_fds);
398 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
400 int fd = ConnectionNumber (dpyinfo->display);
401 FD_SET (fd, &read_fds);
402 if (fd > n) n = fd;
403 XFlush (dpyinfo->display);
406 if (secs < 0 && usecs < 0)
407 ntp = 0;
408 else
409 ntp = &next_time;
411 select (n + 1, &read_fds, (SELECT_TYPE *)0, (SELECT_TYPE *)0, ntp);
414 #endif /* ! MSDOS */
417 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
419 #ifdef USE_X_TOOLKIT
421 /* Loop in Xt until the menu pulldown or dialog popup has been
422 popped down (deactivated). This is used for x-popup-menu
423 and x-popup-dialog; it is not used for the menu bar.
425 NOTE: All calls to popup_get_selection should be protected
426 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
428 static void
429 popup_get_selection (XEvent *initial_event, struct x_display_info *dpyinfo, LWLIB_ID id, int do_timers)
431 XEvent event;
433 while (popup_activated_flag)
435 if (initial_event)
437 event = *initial_event;
438 initial_event = 0;
440 else
442 if (do_timers) x_menu_wait_for_event (0);
443 XtAppNextEvent (Xt_app_con, &event);
446 /* Make sure we don't consider buttons grabbed after menu goes.
447 And make sure to deactivate for any ButtonRelease,
448 even if XtDispatchEvent doesn't do that. */
449 if (event.type == ButtonRelease
450 && dpyinfo->display == event.xbutton.display)
452 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
453 #ifdef USE_MOTIF /* Pretending that the event came from a
454 Btn1Down seems the only way to convince Motif to
455 activate its callbacks; setting the XmNmenuPost
456 isn't working. --marcus@sysc.pdx.edu. */
457 event.xbutton.button = 1;
458 /* Motif only pops down menus when no Ctrl, Alt or Mod
459 key is pressed and the button is released. So reset key state
460 so Motif thinks this is the case. */
461 event.xbutton.state = 0;
462 #endif
464 /* Pop down on C-g and Escape. */
465 else if (event.type == KeyPress
466 && dpyinfo->display == event.xbutton.display)
468 KeySym keysym = XLookupKeysym (&event.xkey, 0);
470 if ((keysym == XK_g && (event.xkey.state & ControlMask) != 0)
471 || keysym == XK_Escape) /* Any escape, ignore modifiers. */
472 popup_activated_flag = 0;
475 x_dispatch_event (&event, event.xany.display);
479 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
480 doc: /* Start key navigation of the menu bar in FRAME.
481 This initially opens the first menu bar item and you can then navigate with the
482 arrow keys, select a menu entry with the return key or cancel with the
483 escape key. If FRAME has no menu bar this function does nothing.
485 If FRAME is nil or not given, use the selected frame. */)
486 (Lisp_Object frame)
488 XEvent ev;
489 FRAME_PTR f = check_x_frame (frame);
490 Widget menubar;
491 BLOCK_INPUT;
493 if (FRAME_EXTERNAL_MENU_BAR (f))
494 set_frame_menubar (f, 0, 1);
496 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
497 if (menubar)
499 Window child;
500 int error_p = 0;
502 x_catch_errors (FRAME_X_DISPLAY (f));
503 memset (&ev, 0, sizeof ev);
504 ev.xbutton.display = FRAME_X_DISPLAY (f);
505 ev.xbutton.window = XtWindow (menubar);
506 ev.xbutton.root = FRAME_X_DISPLAY_INFO (f)->root_window;
507 ev.xbutton.time = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
508 ev.xbutton.button = Button1;
509 ev.xbutton.x = ev.xbutton.y = FRAME_MENUBAR_HEIGHT (f) / 2;
510 ev.xbutton.same_screen = True;
512 #ifdef USE_MOTIF
514 Arg al[2];
515 WidgetList list;
516 Cardinal nr;
517 XtSetArg (al[0], XtNchildren, &list);
518 XtSetArg (al[1], XtNnumChildren, &nr);
519 XtGetValues (menubar, al, 2);
520 ev.xbutton.window = XtWindow (list[0]);
522 #endif
524 XTranslateCoordinates (FRAME_X_DISPLAY (f),
525 /* From-window, to-window. */
526 ev.xbutton.window, ev.xbutton.root,
528 /* From-position, to-position. */
529 ev.xbutton.x, ev.xbutton.y,
530 &ev.xbutton.x_root, &ev.xbutton.y_root,
532 /* Child of win. */
533 &child);
534 error_p = x_had_errors_p (FRAME_X_DISPLAY (f));
535 x_uncatch_errors ();
537 if (! error_p)
539 ev.type = ButtonPress;
540 ev.xbutton.state = 0;
542 XtDispatchEvent (&ev);
543 ev.xbutton.type = ButtonRelease;
544 ev.xbutton.state = Button1Mask;
545 XtDispatchEvent (&ev);
549 UNBLOCK_INPUT;
551 return Qnil;
553 #endif /* USE_X_TOOLKIT */
556 #ifdef USE_GTK
557 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
558 doc: /* Start key navigation of the menu bar in FRAME.
559 This initially opens the first menu bar item and you can then navigate with the
560 arrow keys, select a menu entry with the return key or cancel with the
561 escape key. If FRAME has no menu bar this function does nothing.
563 If FRAME is nil or not given, use the selected frame. */)
564 (Lisp_Object frame)
566 GtkWidget *menubar;
567 FRAME_PTR f;
569 /* gcc 2.95 doesn't accept the FRAME_PTR declaration after
570 BLOCK_INPUT. */
572 BLOCK_INPUT;
573 f = check_x_frame (frame);
575 if (FRAME_EXTERNAL_MENU_BAR (f))
576 set_frame_menubar (f, 0, 1);
578 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
579 if (menubar)
581 /* Activate the first menu. */
582 GList *children = gtk_container_get_children (GTK_CONTAINER (menubar));
584 if (children)
586 g_signal_emit_by_name (children->data, "activate_item");
587 popup_activated_flag = 1;
588 g_list_free (children);
591 UNBLOCK_INPUT;
593 return Qnil;
596 /* Loop util popup_activated_flag is set to zero in a callback.
597 Used for popup menus and dialogs. */
599 static void
600 popup_widget_loop (int do_timers, GtkWidget *widget)
602 ++popup_activated_flag;
604 /* Process events in the Gtk event loop until done. */
605 while (popup_activated_flag)
607 if (do_timers) x_menu_wait_for_event (0);
608 gtk_main_iteration ();
611 #endif
613 /* Activate the menu bar of frame F.
614 This is called from keyboard.c when it gets the
615 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
617 To activate the menu bar, we use the X button-press event
618 that was saved in saved_menu_event.
619 That makes the toolkit do its thing.
621 But first we recompute the menu bar contents (the whole tree).
623 The reason for saving the button event until here, instead of
624 passing it to the toolkit right away, is that we can safely
625 execute Lisp code. */
627 void
628 x_activate_menubar (FRAME_PTR f)
630 if (! FRAME_X_P (f))
631 abort ();
633 if (!f->output_data.x->saved_menu_event->type)
634 return;
636 #ifdef USE_GTK
637 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
638 f->output_data.x->saved_menu_event->xany.window))
639 return;
640 #endif
642 set_frame_menubar (f, 0, 1);
643 BLOCK_INPUT;
644 popup_activated_flag = 1;
645 #ifdef USE_GTK
646 XPutBackEvent (f->output_data.x->display_info->display,
647 f->output_data.x->saved_menu_event);
648 #else
649 XtDispatchEvent (f->output_data.x->saved_menu_event);
650 #endif
651 UNBLOCK_INPUT;
653 /* Ignore this if we get it a second time. */
654 f->output_data.x->saved_menu_event->type = 0;
657 /* This callback is invoked when the user selects a menubar cascade
658 pushbutton, but before the pulldown menu is posted. */
660 #ifndef USE_GTK
661 static void
662 popup_activate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
664 popup_activated_flag = 1;
665 #ifdef USE_X_TOOLKIT
666 x_activate_timeout_atimer ();
667 #endif
669 #endif
671 /* This callback is invoked when a dialog or menu is finished being
672 used and has been unposted. */
674 #ifdef USE_GTK
675 static void
676 popup_deactivate_callback (GtkWidget *widget, gpointer client_data)
678 popup_activated_flag = 0;
680 #else
681 static void
682 popup_deactivate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
684 popup_activated_flag = 0;
686 #endif
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 show help for them, they won't appear before the
744 popup is popped down. */
745 if (popup_activated_flag <= 1)
746 show_help_event (cb_data->cl_data->f, widget, help);
748 #else
749 static void
750 menu_highlight_callback (Widget widget, LWLIB_ID id, void *call_data)
752 struct frame *f;
753 Lisp_Object help;
755 widget_value *wv = (widget_value *) call_data;
757 help = wv ? wv->help : Qnil;
759 /* Determine the frame for the help event. */
760 f = menubar_id_to_frame (id);
762 show_help_event (f, widget, help);
764 #endif
766 #ifdef USE_GTK
767 /* Gtk calls callbacks just because we tell it what item should be
768 selected in a radio group. If this variable is set to a non-zero
769 value, we are creating menus and don't want callbacks right now.
771 static int xg_crazy_callback_abort;
773 /* This callback is called from the menu bar pulldown menu
774 when the user makes a selection.
775 Figure out what the user chose
776 and put the appropriate events into the keyboard buffer. */
777 static void
778 menubar_selection_callback (GtkWidget *widget, gpointer client_data)
780 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
782 if (xg_crazy_callback_abort)
783 return;
785 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
786 return;
788 /* For a group of radio buttons, GTK calls the selection callback first
789 for the item that was active before the selection and then for the one that
790 is active after the selection. For C-h k this means we get the help on
791 the deselected item and then the selected item is executed. Prevent that
792 by ignoring the non-active item. */
793 if (GTK_IS_RADIO_MENU_ITEM (widget)
794 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)))
795 return;
797 /* When a menu is popped down, X generates a focus event (i.e. focus
798 goes back to the frame below the menu). Since GTK buffers events,
799 we force it out here before the menu selection event. Otherwise
800 sit-for will exit at once if the focus event follows the menu selection
801 event. */
803 BLOCK_INPUT;
804 while (gtk_events_pending ())
805 gtk_main_iteration ();
806 UNBLOCK_INPUT;
808 find_and_call_menu_selection (cb_data->cl_data->f,
809 cb_data->cl_data->menu_bar_items_used,
810 cb_data->cl_data->menu_bar_vector,
811 cb_data->call_data);
814 #else /* not USE_GTK */
816 /* This callback is called from the menu bar pulldown menu
817 when the user makes a selection.
818 Figure out what the user chose
819 and put the appropriate events into the keyboard buffer. */
820 static void
821 menubar_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
823 FRAME_PTR f;
825 f = menubar_id_to_frame (id);
826 if (!f)
827 return;
828 find_and_call_menu_selection (f, f->menu_bar_items_used,
829 f->menu_bar_vector, client_data);
831 #endif /* not USE_GTK */
833 /* Recompute all the widgets of frame F, when the menu bar has been
834 changed. Value is non-zero if widgets were updated. */
836 static int
837 update_frame_menubar (FRAME_PTR f)
839 #ifdef USE_GTK
840 return xg_update_frame_menubar (f);
841 #else
842 struct x_output *x;
843 int columns, rows;
845 if (! FRAME_X_P (f))
846 abort ();
848 x = f->output_data.x;
850 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
851 return 0;
853 BLOCK_INPUT;
854 /* Save the size of the frame because the pane widget doesn't accept
855 to resize itself. So force it. */
856 columns = FRAME_COLS (f);
857 rows = FRAME_LINES (f);
859 /* Do the voodoo which means "I'm changing lots of things, don't try
860 to refigure sizes until I'm done." */
861 lw_refigure_widget (x->column_widget, False);
863 /* The order in which children are managed is the top to bottom
864 order in which they are displayed in the paned window. First,
865 remove the text-area widget. */
866 XtUnmanageChild (x->edit_widget);
868 /* Remove the menubar that is there now, and put up the menubar that
869 should be there. */
870 XtManageChild (x->menubar_widget);
871 XtMapWidget (x->menubar_widget);
872 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
874 /* Re-manage the text-area widget, and then thrash the sizes. */
875 XtManageChild (x->edit_widget);
876 lw_refigure_widget (x->column_widget, True);
878 /* Force the pane widget to resize itself with the right values. */
879 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
880 UNBLOCK_INPUT;
881 #endif
882 return 1;
885 #ifdef USE_LUCID
886 static void
887 apply_systemfont_to_dialog (Widget w)
889 const char *fn = xsettings_get_system_normal_font ();
890 if (fn)
892 XrmDatabase db = XtDatabase (XtDisplay (w));
893 if (db)
894 XrmPutStringResource (&db, "*dialog.font", fn);
898 static void
899 apply_systemfont_to_menu (struct frame *f, Widget w)
901 const char *fn = xsettings_get_system_normal_font ();
903 if (fn)
905 XrmDatabase db = XtDatabase (XtDisplay (w));
906 if (db)
908 XrmPutStringResource (&db, "*menubar*font", fn);
909 XrmPutStringResource (&db, "*popup*font", fn);
914 #endif
916 /* Set the contents of the menubar widgets of frame F.
917 The argument FIRST_TIME is currently ignored;
918 it is set the first time this is called, from initialize_frame_menubar. */
920 void
921 set_frame_menubar (FRAME_PTR f, int first_time, int deep_p)
923 xt_or_gtk_widget menubar_widget;
924 #ifdef USE_X_TOOLKIT
925 LWLIB_ID id;
926 #endif
927 Lisp_Object items;
928 widget_value *wv, *first_wv, *prev_wv = 0;
929 int i;
930 int *submenu_start, *submenu_end;
931 int *submenu_top_level_items, *submenu_n_panes;
933 if (! FRAME_X_P (f))
934 abort ();
936 menubar_widget = f->output_data.x->menubar_widget;
938 XSETFRAME (Vmenu_updating_frame, f);
940 #ifdef USE_X_TOOLKIT
941 if (f->output_data.x->id == 0)
942 f->output_data.x->id = next_menubar_widget_id++;
943 id = f->output_data.x->id;
944 #endif
946 if (! menubar_widget)
947 deep_p = 1;
948 /* Make the first call for any given frame always go deep. */
949 else if (!f->output_data.x->saved_menu_event && !deep_p)
951 deep_p = 1;
952 f->output_data.x->saved_menu_event = (XEvent*)xmalloc (sizeof (XEvent));
953 f->output_data.x->saved_menu_event->type = 0;
956 #ifdef USE_GTK
957 /* If we have detached menus, we must update deep so detached menus
958 also gets updated. */
959 deep_p = deep_p || xg_have_tear_offs ();
960 #endif
962 if (deep_p)
964 /* Make a widget-value tree representing the entire menu trees. */
966 struct buffer *prev = current_buffer;
967 Lisp_Object buffer;
968 int specpdl_count = SPECPDL_INDEX ();
969 int previous_menu_items_used = f->menu_bar_items_used;
970 Lisp_Object *previous_items
971 = (Lisp_Object *) alloca (previous_menu_items_used
972 * sizeof (Lisp_Object));
973 int subitems;
975 /* If we are making a new widget, its contents are empty,
976 do always reinitialize them. */
977 if (! menubar_widget)
978 previous_menu_items_used = 0;
980 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
981 specbind (Qinhibit_quit, Qt);
982 /* Don't let the debugger step into this code
983 because it is not reentrant. */
984 specbind (Qdebug_on_next_call, Qnil);
986 record_unwind_save_match_data ();
987 if (NILP (Voverriding_local_map_menu_flag))
989 specbind (Qoverriding_terminal_local_map, Qnil);
990 specbind (Qoverriding_local_map, Qnil);
993 set_buffer_internal_1 (XBUFFER (buffer));
995 /* Run the Lucid hook. */
996 safe_run_hooks (Qactivate_menubar_hook);
998 /* If it has changed current-menubar from previous value,
999 really recompute the menubar from the value. */
1000 if (! NILP (Vlucid_menu_bar_dirty_flag))
1001 call0 (Qrecompute_lucid_menubar);
1002 safe_run_hooks (Qmenu_bar_update_hook);
1003 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1005 items = FRAME_MENU_BAR_ITEMS (f);
1007 /* Save the frame's previous menu bar contents data. */
1008 if (previous_menu_items_used)
1009 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
1010 previous_menu_items_used * sizeof (Lisp_Object));
1012 /* Fill in menu_items with the current menu bar contents.
1013 This can evaluate Lisp code. */
1014 save_menu_items ();
1016 menu_items = f->menu_bar_vector;
1017 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
1018 subitems = ASIZE (items) / 4;
1019 submenu_start = (int *) alloca ((subitems + 1) * sizeof (int));
1020 submenu_end = (int *) alloca (subitems * sizeof (int));
1021 submenu_n_panes = (int *) alloca (subitems * sizeof (int));
1022 submenu_top_level_items = (int *) alloca (subitems * sizeof (int));
1023 init_menu_items ();
1024 for (i = 0; i < subitems; i++)
1026 Lisp_Object key, string, maps;
1028 key = XVECTOR (items)->contents[4 * i];
1029 string = XVECTOR (items)->contents[4 * i + 1];
1030 maps = XVECTOR (items)->contents[4 * i + 2];
1031 if (NILP (string))
1032 break;
1034 submenu_start[i] = menu_items_used;
1036 menu_items_n_panes = 0;
1037 submenu_top_level_items[i]
1038 = parse_single_submenu (key, string, maps);
1039 submenu_n_panes[i] = menu_items_n_panes;
1041 submenu_end[i] = menu_items_used;
1044 submenu_start[i] = -1;
1045 finish_menu_items ();
1047 /* Convert menu_items into widget_value trees
1048 to display the menu. This cannot evaluate Lisp code. */
1050 wv = xmalloc_widget_value ();
1051 wv->name = "menubar";
1052 wv->value = 0;
1053 wv->enabled = 1;
1054 wv->button_type = BUTTON_TYPE_NONE;
1055 wv->help = Qnil;
1056 first_wv = wv;
1058 for (i = 0; 0 <= submenu_start[i]; i++)
1060 menu_items_n_panes = submenu_n_panes[i];
1061 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
1062 submenu_top_level_items[i]);
1063 if (prev_wv)
1064 prev_wv->next = wv;
1065 else
1066 first_wv->contents = wv;
1067 /* Don't set wv->name here; GC during the loop might relocate it. */
1068 wv->enabled = 1;
1069 wv->button_type = BUTTON_TYPE_NONE;
1070 prev_wv = wv;
1073 set_buffer_internal_1 (prev);
1075 /* If there has been no change in the Lisp-level contents
1076 of the menu bar, skip redisplaying it. Just exit. */
1078 /* Compare the new menu items with the ones computed last time. */
1079 for (i = 0; i < previous_menu_items_used; i++)
1080 if (menu_items_used == i
1081 || (!EQ (previous_items[i], XVECTOR (menu_items)->contents[i])))
1082 break;
1083 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1085 /* The menu items have not changed. Don't bother updating
1086 the menus in any form, since it would be a no-op. */
1087 free_menubar_widget_value_tree (first_wv);
1088 discard_menu_items ();
1089 unbind_to (specpdl_count, Qnil);
1090 return;
1093 /* The menu items are different, so store them in the frame. */
1094 f->menu_bar_vector = menu_items;
1095 f->menu_bar_items_used = menu_items_used;
1097 /* This undoes save_menu_items. */
1098 unbind_to (specpdl_count, Qnil);
1100 /* Now GC cannot happen during the lifetime of the widget_value,
1101 so it's safe to store data from a Lisp_String. */
1102 wv = first_wv->contents;
1103 for (i = 0; i < ASIZE (items); i += 4)
1105 Lisp_Object string;
1106 string = XVECTOR (items)->contents[i + 1];
1107 if (NILP (string))
1108 break;
1109 wv->name = SSDATA (string);
1110 update_submenu_strings (wv->contents);
1111 wv = wv->next;
1115 else
1117 /* Make a widget-value tree containing
1118 just the top level menu bar strings. */
1120 wv = xmalloc_widget_value ();
1121 wv->name = "menubar";
1122 wv->value = 0;
1123 wv->enabled = 1;
1124 wv->button_type = BUTTON_TYPE_NONE;
1125 wv->help = Qnil;
1126 first_wv = wv;
1128 items = FRAME_MENU_BAR_ITEMS (f);
1129 for (i = 0; i < ASIZE (items); i += 4)
1131 Lisp_Object string;
1133 string = XVECTOR (items)->contents[i + 1];
1134 if (NILP (string))
1135 break;
1137 wv = xmalloc_widget_value ();
1138 wv->name = SSDATA (string);
1139 wv->value = 0;
1140 wv->enabled = 1;
1141 wv->button_type = BUTTON_TYPE_NONE;
1142 wv->help = Qnil;
1143 /* This prevents lwlib from assuming this
1144 menu item is really supposed to be empty. */
1145 /* The intptr_t cast avoids a warning.
1146 This value just has to be different from small integers. */
1147 wv->call_data = (void *) (intptr_t) (-1);
1149 if (prev_wv)
1150 prev_wv->next = wv;
1151 else
1152 first_wv->contents = wv;
1153 prev_wv = wv;
1156 /* Forget what we thought we knew about what is in the
1157 detailed contents of the menu bar menus.
1158 Changing the top level always destroys the contents. */
1159 f->menu_bar_items_used = 0;
1162 /* Create or update the menu bar widget. */
1164 BLOCK_INPUT;
1166 #ifdef USE_GTK
1167 xg_crazy_callback_abort = 1;
1168 if (menubar_widget)
1170 /* The fourth arg is DEEP_P, which says to consider the entire
1171 menu trees we supply, rather than just the menu bar item names. */
1172 xg_modify_menubar_widgets (menubar_widget,
1174 first_wv,
1175 deep_p,
1176 G_CALLBACK (menubar_selection_callback),
1177 G_CALLBACK (popup_deactivate_callback),
1178 G_CALLBACK (menu_highlight_callback));
1180 else
1182 menubar_widget
1183 = xg_create_widget ("menubar", "menubar", f, first_wv,
1184 G_CALLBACK (menubar_selection_callback),
1185 G_CALLBACK (popup_deactivate_callback),
1186 G_CALLBACK (menu_highlight_callback));
1188 f->output_data.x->menubar_widget = menubar_widget;
1192 #else /* not USE_GTK */
1193 if (menubar_widget)
1195 /* Disable resizing (done for Motif!) */
1196 lw_allow_resizing (f->output_data.x->widget, False);
1198 /* The third arg is DEEP_P, which says to consider the entire
1199 menu trees we supply, rather than just the menu bar item names. */
1200 lw_modify_all_widgets (id, first_wv, deep_p);
1202 /* Re-enable the edit widget to resize. */
1203 lw_allow_resizing (f->output_data.x->widget, True);
1205 else
1207 char menuOverride[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
1208 XtTranslations override = XtParseTranslationTable (menuOverride);
1210 #ifdef USE_LUCID
1211 apply_systemfont_to_menu (f, f->output_data.x->column_widget);
1212 #endif
1213 menubar_widget = lw_create_widget ("menubar", "menubar", id,
1214 first_wv,
1215 f->output_data.x->column_widget,
1217 popup_activate_callback,
1218 menubar_selection_callback,
1219 popup_deactivate_callback,
1220 menu_highlight_callback);
1221 f->output_data.x->menubar_widget = menubar_widget;
1223 /* Make menu pop down on C-g. */
1224 XtOverrideTranslations (menubar_widget, override);
1228 int menubar_size;
1229 if (f->output_data.x->menubar_widget)
1230 XtRealizeWidget (f->output_data.x->menubar_widget);
1232 menubar_size
1233 = (f->output_data.x->menubar_widget
1234 ? (f->output_data.x->menubar_widget->core.height
1235 + f->output_data.x->menubar_widget->core.border_width)
1236 : 0);
1238 #if 1 /* Experimentally, we now get the right results
1239 for -geometry -0-0 without this. 24 Aug 96, rms.
1240 Maybe so, but the menu bar size is missing the pixels so the
1241 WM size hints are off by these pixels. Jan D, oct 2009. */
1242 #ifdef USE_LUCID
1243 if (FRAME_EXTERNAL_MENU_BAR (f))
1245 Dimension ibw = 0;
1246 XtVaGetValues (f->output_data.x->column_widget,
1247 XtNinternalBorderWidth, &ibw, NULL);
1248 menubar_size += ibw;
1250 #endif /* USE_LUCID */
1251 #endif /* 1 */
1253 f->output_data.x->menubar_height = menubar_size;
1255 #endif /* not USE_GTK */
1257 free_menubar_widget_value_tree (first_wv);
1258 update_frame_menubar (f);
1260 #ifdef USE_GTK
1261 xg_crazy_callback_abort = 0;
1262 #endif
1264 UNBLOCK_INPUT;
1267 /* Called from Fx_create_frame to create the initial menubar of a frame
1268 before it is mapped, so that the window is mapped with the menubar already
1269 there instead of us tacking it on later and thrashing the window after it
1270 is visible. */
1272 void
1273 initialize_frame_menubar (FRAME_PTR f)
1275 /* This function is called before the first chance to redisplay
1276 the frame. It has to be, so the frame will have the right size. */
1277 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1278 set_frame_menubar (f, 1, 1);
1282 /* Get rid of the menu bar of frame F, and free its storage.
1283 This is used when deleting a frame, and when turning off the menu bar.
1284 For GTK this function is in gtkutil.c. */
1286 #ifndef USE_GTK
1287 void
1288 free_frame_menubar (FRAME_PTR f)
1290 Widget menubar_widget;
1292 if (! FRAME_X_P (f))
1293 abort ();
1295 menubar_widget = f->output_data.x->menubar_widget;
1297 f->output_data.x->menubar_height = 0;
1299 if (menubar_widget)
1301 #ifdef USE_MOTIF
1302 /* Removing the menu bar magically changes the shell widget's x
1303 and y position of (0, 0) which, when the menu bar is turned
1304 on again, leads to pull-down menuss appearing in strange
1305 positions near the upper-left corner of the display. This
1306 happens only with some window managers like twm and ctwm,
1307 but not with other like Motif's mwm or kwm, because the
1308 latter generate ConfigureNotify events when the menu bar
1309 is switched off, which fixes the shell position. */
1310 Position x0, y0, x1, y1;
1311 #endif
1313 BLOCK_INPUT;
1315 #ifdef USE_MOTIF
1316 if (f->output_data.x->widget)
1317 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
1318 #endif
1320 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1321 f->output_data.x->menubar_widget = NULL;
1323 if (f->output_data.x->widget)
1325 #ifdef USE_MOTIF
1326 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
1327 if (x1 == 0 && y1 == 0)
1328 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
1329 #endif
1330 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1332 UNBLOCK_INPUT;
1335 #endif /* not USE_GTK */
1337 #endif /* USE_X_TOOLKIT || USE_GTK */
1339 /* xmenu_show actually displays a menu using the panes and items in menu_items
1340 and returns the value selected from it.
1341 There are two versions of xmenu_show, one for Xt and one for Xlib.
1342 Both assume input is blocked by the caller. */
1344 /* F is the frame the menu is for.
1345 X and Y are the frame-relative specified position,
1346 relative to the inside upper left corner of the frame F.
1347 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
1348 KEYMAPS is 1 if this menu was specified with keymaps;
1349 in that case, we return a list containing the chosen item's value
1350 and perhaps also the pane's prefix.
1351 TITLE is the specified menu title.
1352 ERROR is a place to store an error message string in case of failure.
1353 (We return nil on failure, but the value doesn't actually matter.) */
1355 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1357 /* The item selected in the popup menu. */
1358 static Lisp_Object *volatile menu_item_selection;
1360 #ifdef USE_GTK
1362 /* Used when position a popup menu. See menu_position_func and
1363 create_and_show_popup_menu below. */
1364 struct next_popup_x_y
1366 FRAME_PTR f;
1367 int x;
1368 int y;
1371 /* The menu position function to use if we are not putting a popup
1372 menu where the pointer is.
1373 MENU is the menu to pop up.
1374 X and Y shall on exit contain x/y where the menu shall pop up.
1375 PUSH_IN is not documented in the GTK manual.
1376 USER_DATA is any data passed in when calling gtk_menu_popup.
1377 Here it points to a struct next_popup_x_y where the coordinates
1378 to store in *X and *Y are as well as the frame for the popup.
1380 Here only X and Y are used. */
1381 static void
1382 menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
1384 struct next_popup_x_y* data = (struct next_popup_x_y*)user_data;
1385 GtkRequisition req;
1386 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (data->f);
1387 int disp_width = x_display_pixel_width (dpyinfo);
1388 int disp_height = x_display_pixel_height (dpyinfo);
1390 *x = data->x;
1391 *y = data->y;
1393 /* Check if there is room for the menu. If not, adjust x/y so that
1394 the menu is fully visible. */
1395 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1396 if (data->x + req.width > disp_width)
1397 *x -= data->x + req.width - disp_width;
1398 if (data->y + req.height > disp_height)
1399 *y -= data->y + req.height - disp_height;
1402 static void
1403 popup_selection_callback (GtkWidget *widget, gpointer client_data)
1405 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
1407 if (xg_crazy_callback_abort) return;
1408 if (cb_data) menu_item_selection = (Lisp_Object *) cb_data->call_data;
1411 static Lisp_Object
1412 pop_down_menu (Lisp_Object arg)
1414 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1416 popup_activated_flag = 0;
1417 BLOCK_INPUT;
1418 gtk_widget_destroy (GTK_WIDGET (p->pointer));
1419 UNBLOCK_INPUT;
1420 return Qnil;
1423 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1424 menu pops down.
1425 menu_item_selection will be set to the selection. */
1426 static void
1427 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv, int x, int y,
1428 int for_click, Time timestamp)
1430 int i;
1431 GtkWidget *menu;
1432 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
1433 struct next_popup_x_y popup_x_y;
1434 int specpdl_count = SPECPDL_INDEX ();
1436 if (! FRAME_X_P (f))
1437 abort ();
1439 xg_crazy_callback_abort = 1;
1440 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
1441 G_CALLBACK (popup_selection_callback),
1442 G_CALLBACK (popup_deactivate_callback),
1443 G_CALLBACK (menu_highlight_callback));
1444 xg_crazy_callback_abort = 0;
1446 if (! for_click)
1448 /* Not invoked by a click. pop up at x/y. */
1449 pos_func = menu_position_func;
1451 /* Adjust coordinates to be root-window-relative. */
1452 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1453 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1455 popup_x_y.x = x;
1456 popup_x_y.y = y;
1457 popup_x_y.f = f;
1459 i = 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
1461 else
1463 for (i = 0; i < 5; i++)
1464 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1465 break;
1468 /* Display the menu. */
1469 gtk_widget_show_all (menu);
1471 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i,
1472 timestamp ? timestamp : gtk_get_current_event_time ());
1474 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
1476 if (gtk_widget_get_mapped (menu))
1478 /* Set this to one. popup_widget_loop increases it by one, so it becomes
1479 two. show_help_echo uses this to detect popup menus. */
1480 popup_activated_flag = 1;
1481 /* Process events that apply to the menu. */
1482 popup_widget_loop (1, menu);
1485 unbind_to (specpdl_count, Qnil);
1487 /* Must reset this manually because the button release event is not passed
1488 to Emacs event loop. */
1489 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
1492 #else /* not USE_GTK */
1494 /* We need a unique id for each widget handled by the Lucid Widget
1495 library.
1497 For the main windows, and popup menus, we use this counter,
1498 which we increment each time after use. This starts from 1<<16.
1500 For menu bars, we use numbers starting at 0, counted in
1501 next_menubar_widget_id. */
1502 LWLIB_ID widget_id_tick;
1504 static void
1505 popup_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1507 menu_item_selection = (Lisp_Object *) client_data;
1510 /* ARG is the LWLIB ID of the dialog box, represented
1511 as a Lisp object as (HIGHPART . LOWPART). */
1513 static Lisp_Object
1514 pop_down_menu (Lisp_Object arg)
1516 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
1517 | XINT (XCDR (arg)));
1519 BLOCK_INPUT;
1520 lw_destroy_all_widgets (id);
1521 UNBLOCK_INPUT;
1522 popup_activated_flag = 0;
1524 return Qnil;
1527 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1528 menu pops down.
1529 menu_item_selection will be set to the selection. */
1530 static void
1531 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv,
1532 int x, int y, int for_click, Time timestamp)
1534 int i;
1535 Arg av[2];
1536 int ac = 0;
1537 XEvent dummy;
1538 XButtonPressedEvent *event = &(dummy.xbutton);
1539 LWLIB_ID menu_id;
1540 Widget menu;
1542 if (! FRAME_X_P (f))
1543 abort ();
1545 #ifdef USE_LUCID
1546 apply_systemfont_to_menu (f, f->output_data.x->widget);
1547 #endif
1549 menu_id = widget_id_tick++;
1550 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
1551 f->output_data.x->widget, 1, 0,
1552 popup_selection_callback,
1553 popup_deactivate_callback,
1554 menu_highlight_callback);
1556 event->type = ButtonPress;
1557 event->serial = 0;
1558 event->send_event = 0;
1559 event->display = FRAME_X_DISPLAY (f);
1560 event->time = CurrentTime;
1561 event->root = FRAME_X_DISPLAY_INFO (f)->root_window;
1562 event->window = event->subwindow = event->root;
1563 event->x = x;
1564 event->y = y;
1566 /* Adjust coordinates to be root-window-relative. */
1567 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1568 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1570 event->x_root = x;
1571 event->y_root = y;
1573 event->state = 0;
1574 event->button = 0;
1575 for (i = 0; i < 5; i++)
1576 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1577 event->button = i;
1579 /* Don't allow any geometry request from the user. */
1580 XtSetArg (av[ac], XtNgeometry, 0); ac++;
1581 XtSetValues (menu, av, ac);
1583 /* Display the menu. */
1584 lw_popup_menu (menu, &dummy);
1585 popup_activated_flag = 1;
1586 x_activate_timeout_atimer ();
1589 int fact = 4 * sizeof (LWLIB_ID);
1590 int specpdl_count = SPECPDL_INDEX ();
1591 record_unwind_protect (pop_down_menu,
1592 Fcons (make_number (menu_id >> (fact)),
1593 make_number (menu_id & ~(-1 << (fact)))));
1595 /* Process events that apply to the menu. */
1596 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), menu_id, 1);
1598 unbind_to (specpdl_count, Qnil);
1602 #endif /* not USE_GTK */
1604 Lisp_Object
1605 xmenu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
1606 Lisp_Object title, const char **error_name, Time timestamp)
1608 int i;
1609 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1610 widget_value **submenu_stack
1611 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1612 Lisp_Object *subprefix_stack
1613 = (Lisp_Object *) alloca (menu_items_used * sizeof (Lisp_Object));
1614 int submenu_depth = 0;
1616 int first_pane;
1618 if (! FRAME_X_P (f))
1619 abort ();
1621 *error_name = NULL;
1623 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1625 *error_name = "Empty menu";
1626 return Qnil;
1629 /* Create a tree of widget_value objects
1630 representing the panes and their items. */
1631 wv = xmalloc_widget_value ();
1632 wv->name = "menu";
1633 wv->value = 0;
1634 wv->enabled = 1;
1635 wv->button_type = BUTTON_TYPE_NONE;
1636 wv->help =Qnil;
1637 first_wv = wv;
1638 first_pane = 1;
1640 /* Loop over all panes and items, filling in the tree. */
1641 i = 0;
1642 while (i < menu_items_used)
1644 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1646 submenu_stack[submenu_depth++] = save_wv;
1647 save_wv = prev_wv;
1648 prev_wv = 0;
1649 first_pane = 1;
1650 i++;
1652 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
1654 prev_wv = save_wv;
1655 save_wv = submenu_stack[--submenu_depth];
1656 first_pane = 0;
1657 i++;
1659 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
1660 && submenu_depth != 0)
1661 i += MENU_ITEMS_PANE_LENGTH;
1662 /* Ignore a nil in the item list.
1663 It's meaningful only for dialog boxes. */
1664 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
1665 i += 1;
1666 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
1668 /* Create a new pane. */
1669 Lisp_Object pane_name, prefix;
1670 const char *pane_string;
1672 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1673 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1675 #ifndef HAVE_MULTILINGUAL_MENU
1676 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1678 pane_name = ENCODE_MENU_STRING (pane_name);
1679 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1681 #endif
1682 pane_string = (NILP (pane_name)
1683 ? "" : SSDATA (pane_name));
1684 /* If there is just one top-level pane, put all its items directly
1685 under the top-level menu. */
1686 if (menu_items_n_panes == 1)
1687 pane_string = "";
1689 /* If the pane has a meaningful name,
1690 make the pane a top-level menu item
1691 with its items as a submenu beneath it. */
1692 if (!keymaps && strcmp (pane_string, ""))
1694 wv = xmalloc_widget_value ();
1695 if (save_wv)
1696 save_wv->next = wv;
1697 else
1698 first_wv->contents = wv;
1699 wv->name = pane_string;
1700 if (keymaps && !NILP (prefix))
1701 wv->name++;
1702 wv->value = 0;
1703 wv->enabled = 1;
1704 wv->button_type = BUTTON_TYPE_NONE;
1705 wv->help = Qnil;
1706 save_wv = wv;
1707 prev_wv = 0;
1709 else if (first_pane)
1711 save_wv = wv;
1712 prev_wv = 0;
1714 first_pane = 0;
1715 i += MENU_ITEMS_PANE_LENGTH;
1717 else
1719 /* Create a new item within current pane. */
1720 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1721 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1722 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1723 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1724 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1725 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1726 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1727 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1729 #ifndef HAVE_MULTILINGUAL_MENU
1730 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
1732 item_name = ENCODE_MENU_STRING (item_name);
1733 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1736 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1738 descrip = ENCODE_MENU_STRING (descrip);
1739 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1741 #endif /* not HAVE_MULTILINGUAL_MENU */
1743 wv = xmalloc_widget_value ();
1744 if (prev_wv)
1745 prev_wv->next = wv;
1746 else
1747 save_wv->contents = wv;
1748 wv->name = SSDATA (item_name);
1749 if (!NILP (descrip))
1750 wv->key = SSDATA (descrip);
1751 wv->value = 0;
1752 /* If this item has a null value,
1753 make the call_data null so that it won't display a box
1754 when the mouse is on it. */
1755 wv->call_data
1756 = (!NILP (def) ? (void *) &XVECTOR (menu_items)->contents[i] : 0);
1757 wv->enabled = !NILP (enable);
1759 if (NILP (type))
1760 wv->button_type = BUTTON_TYPE_NONE;
1761 else if (EQ (type, QCtoggle))
1762 wv->button_type = BUTTON_TYPE_TOGGLE;
1763 else if (EQ (type, QCradio))
1764 wv->button_type = BUTTON_TYPE_RADIO;
1765 else
1766 abort ();
1768 wv->selected = !NILP (selected);
1770 if (! STRINGP (help))
1771 help = Qnil;
1773 wv->help = help;
1775 prev_wv = wv;
1777 i += MENU_ITEMS_ITEM_LENGTH;
1781 /* Deal with the title, if it is non-nil. */
1782 if (!NILP (title))
1784 widget_value *wv_title = xmalloc_widget_value ();
1785 widget_value *wv_sep1 = xmalloc_widget_value ();
1786 widget_value *wv_sep2 = xmalloc_widget_value ();
1788 wv_sep2->name = "--";
1789 wv_sep2->next = first_wv->contents;
1790 wv_sep2->help = Qnil;
1792 wv_sep1->name = "--";
1793 wv_sep1->next = wv_sep2;
1794 wv_sep1->help = Qnil;
1796 #ifndef HAVE_MULTILINGUAL_MENU
1797 if (STRING_MULTIBYTE (title))
1798 title = ENCODE_MENU_STRING (title);
1799 #endif
1801 wv_title->name = SSDATA (title);
1802 wv_title->enabled = TRUE;
1803 wv_title->button_type = BUTTON_TYPE_NONE;
1804 wv_title->help = Qnil;
1805 wv_title->next = wv_sep1;
1806 first_wv->contents = wv_title;
1809 /* No selection has been chosen yet. */
1810 menu_item_selection = 0;
1812 /* Actually create and show the menu until popped down. */
1813 create_and_show_popup_menu (f, first_wv, x, y, for_click, timestamp);
1815 /* Free the widget_value objects we used to specify the contents. */
1816 free_menubar_widget_value_tree (first_wv);
1818 /* Find the selected item, and its pane, to return
1819 the proper value. */
1820 if (menu_item_selection != 0)
1822 Lisp_Object prefix, entry;
1824 prefix = entry = Qnil;
1825 i = 0;
1826 while (i < menu_items_used)
1828 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1830 subprefix_stack[submenu_depth++] = prefix;
1831 prefix = entry;
1832 i++;
1834 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
1836 prefix = subprefix_stack[--submenu_depth];
1837 i++;
1839 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
1841 prefix
1842 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
1843 i += MENU_ITEMS_PANE_LENGTH;
1845 /* Ignore a nil in the item list.
1846 It's meaningful only for dialog boxes. */
1847 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
1848 i += 1;
1849 else
1851 entry
1852 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
1853 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
1855 if (keymaps != 0)
1857 int j;
1859 entry = Fcons (entry, Qnil);
1860 if (!NILP (prefix))
1861 entry = Fcons (prefix, entry);
1862 for (j = submenu_depth - 1; j >= 0; j--)
1863 if (!NILP (subprefix_stack[j]))
1864 entry = Fcons (subprefix_stack[j], entry);
1866 return entry;
1868 i += MENU_ITEMS_ITEM_LENGTH;
1872 else if (!for_click)
1873 /* Make "Cancel" equivalent to C-g. */
1874 Fsignal (Qquit, Qnil);
1876 return Qnil;
1879 #ifdef USE_GTK
1880 static void
1881 dialog_selection_callback (GtkWidget *widget, gpointer client_data)
1883 /* Treat the pointer as an integer. There's no problem
1884 as long as pointers have enough bits to hold small integers. */
1885 if ((intptr_t) client_data != -1)
1886 menu_item_selection = (Lisp_Object *) client_data;
1888 popup_activated_flag = 0;
1891 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1892 dialog pops down.
1893 menu_item_selection will be set to the selection. */
1894 static void
1895 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1897 GtkWidget *menu;
1899 if (! FRAME_X_P (f))
1900 abort ();
1902 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
1903 G_CALLBACK (dialog_selection_callback),
1904 G_CALLBACK (popup_deactivate_callback),
1907 if (menu)
1909 int specpdl_count = SPECPDL_INDEX ();
1910 record_unwind_protect (pop_down_menu, make_save_value (menu, 0));
1912 /* Display the menu. */
1913 gtk_widget_show_all (menu);
1915 /* Process events that apply to the menu. */
1916 popup_widget_loop (1, menu);
1918 unbind_to (specpdl_count, Qnil);
1922 #else /* not USE_GTK */
1923 static void
1924 dialog_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1926 /* Treat the pointer as an integer. There's no problem
1927 as long as pointers have enough bits to hold small integers. */
1928 if ((intptr_t) client_data != -1)
1929 menu_item_selection = (Lisp_Object *) client_data;
1931 BLOCK_INPUT;
1932 lw_destroy_all_widgets (id);
1933 UNBLOCK_INPUT;
1934 popup_activated_flag = 0;
1938 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1939 dialog pops down.
1940 menu_item_selection will be set to the selection. */
1941 static void
1942 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1944 LWLIB_ID dialog_id;
1946 if (!FRAME_X_P (f))
1947 abort();
1949 dialog_id = widget_id_tick++;
1950 #ifdef USE_LUCID
1951 apply_systemfont_to_dialog (f->output_data.x->widget);
1952 #endif
1953 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
1954 f->output_data.x->widget, 1, 0,
1955 dialog_selection_callback, 0, 0);
1956 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
1957 /* Display the dialog box. */
1958 lw_pop_up_all_widgets (dialog_id);
1959 popup_activated_flag = 1;
1960 x_activate_timeout_atimer ();
1962 /* Process events that apply to the dialog box.
1963 Also handle timers. */
1965 int count = SPECPDL_INDEX ();
1966 int fact = 4 * sizeof (LWLIB_ID);
1968 /* xdialog_show_unwind is responsible for popping the dialog box down. */
1969 record_unwind_protect (pop_down_menu,
1970 Fcons (make_number (dialog_id >> (fact)),
1971 make_number (dialog_id & ~(-1 << (fact)))));
1973 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f),
1974 dialog_id, 1);
1976 unbind_to (count, Qnil);
1980 #endif /* not USE_GTK */
1982 static const char * button_names [] = {
1983 "button1", "button2", "button3", "button4", "button5",
1984 "button6", "button7", "button8", "button9", "button10" };
1986 static Lisp_Object
1987 xdialog_show (FRAME_PTR f,
1988 int keymaps,
1989 Lisp_Object title,
1990 Lisp_Object header,
1991 const char **error_name)
1993 int i, nb_buttons=0;
1994 char dialog_name[6];
1996 widget_value *wv, *first_wv = 0, *prev_wv = 0;
1998 /* Number of elements seen so far, before boundary. */
1999 int left_count = 0;
2000 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
2001 int boundary_seen = 0;
2003 if (! FRAME_X_P (f))
2004 abort ();
2006 *error_name = NULL;
2008 if (menu_items_n_panes > 1)
2010 *error_name = "Multiple panes in dialog box";
2011 return Qnil;
2014 /* Create a tree of widget_value objects
2015 representing the text label and buttons. */
2017 Lisp_Object pane_name, prefix;
2018 const char *pane_string;
2019 pane_name = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME];
2020 prefix = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_PREFIX];
2021 pane_string = (NILP (pane_name)
2022 ? "" : SSDATA (pane_name));
2023 prev_wv = xmalloc_widget_value ();
2024 prev_wv->value = pane_string;
2025 if (keymaps && !NILP (prefix))
2026 prev_wv->name++;
2027 prev_wv->enabled = 1;
2028 prev_wv->name = "message";
2029 prev_wv->help = Qnil;
2030 first_wv = prev_wv;
2032 /* Loop over all panes and items, filling in the tree. */
2033 i = MENU_ITEMS_PANE_LENGTH;
2034 while (i < menu_items_used)
2037 /* Create a new item within current pane. */
2038 Lisp_Object item_name, enable, descrip;
2039 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2040 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2041 descrip
2042 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2044 if (NILP (item_name))
2046 free_menubar_widget_value_tree (first_wv);
2047 *error_name = "Submenu in dialog items";
2048 return Qnil;
2050 if (EQ (item_name, Qquote))
2052 /* This is the boundary between left-side elts
2053 and right-side elts. Stop incrementing right_count. */
2054 boundary_seen = 1;
2055 i++;
2056 continue;
2058 if (nb_buttons >= 9)
2060 free_menubar_widget_value_tree (first_wv);
2061 *error_name = "Too many dialog items";
2062 return Qnil;
2065 wv = xmalloc_widget_value ();
2066 prev_wv->next = wv;
2067 wv->name = (char *) button_names[nb_buttons];
2068 if (!NILP (descrip))
2069 wv->key = SSDATA (descrip);
2070 wv->value = SSDATA (item_name);
2071 wv->call_data = (void *) &XVECTOR (menu_items)->contents[i];
2072 wv->enabled = !NILP (enable);
2073 wv->help = Qnil;
2074 prev_wv = wv;
2076 if (! boundary_seen)
2077 left_count++;
2079 nb_buttons++;
2080 i += MENU_ITEMS_ITEM_LENGTH;
2083 /* If the boundary was not specified,
2084 by default put half on the left and half on the right. */
2085 if (! boundary_seen)
2086 left_count = nb_buttons - nb_buttons / 2;
2088 wv = xmalloc_widget_value ();
2089 wv->name = dialog_name;
2090 wv->help = Qnil;
2092 /* Frame title: 'Q' = Question, 'I' = Information.
2093 Can also have 'E' = Error if, one day, we want
2094 a popup for errors. */
2095 if (NILP(header))
2096 dialog_name[0] = 'Q';
2097 else
2098 dialog_name[0] = 'I';
2100 /* Dialog boxes use a really stupid name encoding
2101 which specifies how many buttons to use
2102 and how many buttons are on the right. */
2103 dialog_name[1] = '0' + nb_buttons;
2104 dialog_name[2] = 'B';
2105 dialog_name[3] = 'R';
2106 /* Number of buttons to put on the right. */
2107 dialog_name[4] = '0' + nb_buttons - left_count;
2108 dialog_name[5] = 0;
2109 wv->contents = first_wv;
2110 first_wv = wv;
2113 /* No selection has been chosen yet. */
2114 menu_item_selection = 0;
2116 /* Actually create and show the dialog. */
2117 create_and_show_dialog (f, first_wv);
2119 /* Free the widget_value objects we used to specify the contents. */
2120 free_menubar_widget_value_tree (first_wv);
2122 /* Find the selected item, and its pane, to return
2123 the proper value. */
2124 if (menu_item_selection != 0)
2126 Lisp_Object prefix;
2128 prefix = Qnil;
2129 i = 0;
2130 while (i < menu_items_used)
2132 Lisp_Object entry;
2134 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2136 prefix
2137 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2138 i += MENU_ITEMS_PANE_LENGTH;
2140 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2142 /* This is the boundary between left-side elts and
2143 right-side elts. */
2144 ++i;
2146 else
2148 entry
2149 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2150 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
2152 if (keymaps != 0)
2154 entry = Fcons (entry, Qnil);
2155 if (!NILP (prefix))
2156 entry = Fcons (prefix, entry);
2158 return entry;
2160 i += MENU_ITEMS_ITEM_LENGTH;
2164 else
2165 /* Make "Cancel" equivalent to C-g. */
2166 Fsignal (Qquit, Qnil);
2168 return Qnil;
2171 #else /* not USE_X_TOOLKIT && not USE_GTK */
2173 /* The frame of the last activated non-toolkit menu bar.
2174 Used to generate menu help events. */
2176 static struct frame *menu_help_frame;
2179 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
2181 PANE is the pane number, and ITEM is the menu item number in
2182 the menu (currently not used).
2184 This cannot be done with generating a HELP_EVENT because
2185 XMenuActivate contains a loop that doesn't let Emacs process
2186 keyboard events. */
2188 static void
2189 menu_help_callback (char const *help_string, int pane, int item)
2191 Lisp_Object *first_item;
2192 Lisp_Object pane_name;
2193 Lisp_Object menu_object;
2195 first_item = XVECTOR (menu_items)->contents;
2196 if (EQ (first_item[0], Qt))
2197 pane_name = first_item[MENU_ITEMS_PANE_NAME];
2198 else if (EQ (first_item[0], Qquote))
2199 /* This shouldn't happen, see xmenu_show. */
2200 pane_name = empty_unibyte_string;
2201 else
2202 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
2204 /* (menu-item MENU-NAME PANE-NUMBER) */
2205 menu_object = Fcons (Qmenu_item,
2206 Fcons (pane_name,
2207 Fcons (make_number (pane), Qnil)));
2208 show_help_echo (help_string ? build_string (help_string) : Qnil,
2209 Qnil, menu_object, make_number (item));
2212 static Lisp_Object
2213 pop_down_menu (Lisp_Object arg)
2215 struct Lisp_Save_Value *p1 = XSAVE_VALUE (Fcar (arg));
2216 struct Lisp_Save_Value *p2 = XSAVE_VALUE (Fcdr (arg));
2218 FRAME_PTR f = p1->pointer;
2219 XMenu *menu = p2->pointer;
2221 BLOCK_INPUT;
2222 #ifndef MSDOS
2223 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
2224 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
2225 #endif
2226 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2228 #ifdef HAVE_X_WINDOWS
2229 /* Assume the mouse has moved out of the X window.
2230 If it has actually moved in, we will get an EnterNotify. */
2231 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
2233 /* State that no mouse buttons are now held.
2234 (The oldXMenu code doesn't track this info for us.)
2235 That is not necessarily true, but the fiction leads to reasonable
2236 results, and it is a pain to ask which are actually held now. */
2237 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2239 #endif /* HAVE_X_WINDOWS */
2241 UNBLOCK_INPUT;
2243 return Qnil;
2247 Lisp_Object
2248 xmenu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
2249 Lisp_Object title, const char **error_name, Time timestamp)
2251 Window root;
2252 XMenu *menu;
2253 int pane, selidx, lpane, status;
2254 Lisp_Object entry, pane_prefix;
2255 char *datap;
2256 int ulx, uly, width, height;
2257 int dispwidth, dispheight;
2258 int i, j, lines, maxlines;
2259 int maxwidth;
2260 int dummy_int;
2261 unsigned int dummy_uint;
2262 int specpdl_count = SPECPDL_INDEX ();
2264 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
2265 abort ();
2267 *error_name = 0;
2268 if (menu_items_n_panes == 0)
2269 return Qnil;
2271 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2273 *error_name = "Empty menu";
2274 return Qnil;
2277 /* Figure out which root window F is on. */
2278 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2279 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2280 &dummy_uint, &dummy_uint);
2282 /* Make the menu on that window. */
2283 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2284 if (menu == NULL)
2286 *error_name = "Can't create menu";
2287 return Qnil;
2290 /* Don't GC while we prepare and show the menu,
2291 because we give the oldxmenu library pointers to the
2292 contents of strings. */
2293 inhibit_garbage_collection ();
2295 #ifdef HAVE_X_WINDOWS
2296 /* Adjust coordinates to relative to the outer (window manager) window. */
2297 x += FRAME_OUTER_TO_INNER_DIFF_X (f);
2298 y += FRAME_OUTER_TO_INNER_DIFF_Y (f);
2299 #endif /* HAVE_X_WINDOWS */
2301 /* Adjust coordinates to be root-window-relative. */
2302 x += f->left_pos;
2303 y += f->top_pos;
2305 /* Create all the necessary panes and their items. */
2306 maxwidth = maxlines = lines = i = 0;
2307 lpane = XM_FAILURE;
2308 while (i < menu_items_used)
2310 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2312 /* Create a new pane. */
2313 Lisp_Object pane_name, prefix;
2314 const char *pane_string;
2316 maxlines = max (maxlines, lines);
2317 lines = 0;
2318 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
2319 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2320 pane_string = (NILP (pane_name)
2321 ? "" : SSDATA (pane_name));
2322 if (keymaps && !NILP (prefix))
2323 pane_string++;
2325 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2326 if (lpane == XM_FAILURE)
2328 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2329 *error_name = "Can't create pane";
2330 return Qnil;
2332 i += MENU_ITEMS_PANE_LENGTH;
2334 /* Find the width of the widest item in this pane. */
2335 j = i;
2336 while (j < menu_items_used)
2338 Lisp_Object item;
2339 item = XVECTOR (menu_items)->contents[j];
2340 if (EQ (item, Qt))
2341 break;
2342 if (NILP (item))
2344 j++;
2345 continue;
2347 width = SBYTES (item);
2348 if (width > maxwidth)
2349 maxwidth = width;
2351 j += MENU_ITEMS_ITEM_LENGTH;
2354 /* Ignore a nil in the item list.
2355 It's meaningful only for dialog boxes. */
2356 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2357 i += 1;
2358 else
2360 /* Create a new item within current pane. */
2361 Lisp_Object item_name, enable, descrip, help;
2362 char *item_data;
2363 char const *help_string;
2365 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2366 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2367 descrip
2368 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2369 help = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_HELP];
2370 help_string = STRINGP (help) ? SSDATA (help) : NULL;
2372 if (!NILP (descrip))
2374 /* if alloca is fast, use that to make the space,
2375 to reduce gc needs. */
2376 item_data = (char *) alloca (maxwidth + SBYTES (descrip) + 1);
2377 memcpy (item_data, SSDATA (item_name), SBYTES (item_name));
2378 for (j = SCHARS (item_name); j < maxwidth; j++)
2379 item_data[j] = ' ';
2380 memcpy (item_data + j, SSDATA (descrip), SBYTES (descrip));
2381 item_data[j + SBYTES (descrip)] = 0;
2383 else
2384 item_data = SSDATA (item_name);
2386 if (lpane == XM_FAILURE
2387 || (XMenuAddSelection (FRAME_X_DISPLAY (f),
2388 menu, lpane, 0, item_data,
2389 !NILP (enable), help_string)
2390 == XM_FAILURE))
2392 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2393 *error_name = "Can't add selection to menu";
2394 return Qnil;
2396 i += MENU_ITEMS_ITEM_LENGTH;
2397 lines++;
2401 maxlines = max (maxlines, lines);
2403 /* All set and ready to fly. */
2404 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2405 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2406 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2407 x = min (x, dispwidth);
2408 y = min (y, dispheight);
2409 x = max (x, 1);
2410 y = max (y, 1);
2411 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2412 &ulx, &uly, &width, &height);
2413 if (ulx+width > dispwidth)
2415 x -= (ulx + width) - dispwidth;
2416 ulx = dispwidth - width;
2418 if (uly+height > dispheight)
2420 y -= (uly + height) - dispheight;
2421 uly = dispheight - height;
2423 #ifndef HAVE_X_WINDOWS
2424 if (FRAME_HAS_MINIBUF_P (f) && uly+height > dispheight - 1)
2426 /* Move the menu away of the echo area, to avoid overwriting the
2427 menu with help echo messages or vice versa. */
2428 if (BUFFERP (echo_area_buffer[0]) && WINDOWP (echo_area_window))
2430 y -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2431 uly -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2433 else
2435 y--;
2436 uly--;
2439 #endif
2440 if (ulx < 0) x -= ulx;
2441 if (uly < 0) y -= uly;
2443 if (! for_click)
2445 /* If position was not given by a mouse click, adjust so upper left
2446 corner of the menu as a whole ends up at given coordinates. This
2447 is what x-popup-menu says in its documentation. */
2448 x += width/2;
2449 y += 1.5*height/(maxlines+2);
2452 XMenuSetAEQ (menu, TRUE);
2453 XMenuSetFreeze (menu, TRUE);
2454 pane = selidx = 0;
2456 #ifndef MSDOS
2457 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
2458 #endif
2460 record_unwind_protect (pop_down_menu,
2461 Fcons (make_save_value (f, 0),
2462 make_save_value (menu, 0)));
2464 /* Help display under X won't work because XMenuActivate contains
2465 a loop that doesn't give Emacs a chance to process it. */
2466 menu_help_frame = f;
2467 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2468 x, y, ButtonReleaseMask, &datap,
2469 menu_help_callback);
2470 entry = pane_prefix = Qnil;
2472 switch (status)
2474 case XM_SUCCESS:
2475 #ifdef XDEBUG
2476 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2477 #endif
2479 /* Find the item number SELIDX in pane number PANE. */
2480 i = 0;
2481 while (i < menu_items_used)
2483 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2485 if (pane == 0)
2486 pane_prefix
2487 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2488 pane--;
2489 i += MENU_ITEMS_PANE_LENGTH;
2491 else
2493 if (pane == -1)
2495 if (selidx == 0)
2497 entry
2498 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2499 if (keymaps != 0)
2501 entry = Fcons (entry, Qnil);
2502 if (!NILP (pane_prefix))
2503 entry = Fcons (pane_prefix, entry);
2505 break;
2507 selidx--;
2509 i += MENU_ITEMS_ITEM_LENGTH;
2512 break;
2514 case XM_FAILURE:
2515 *error_name = "Can't activate menu";
2516 case XM_IA_SELECT:
2517 break;
2518 case XM_NO_SELECT:
2519 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
2520 the menu was invoked with a mouse event as POSITION). */
2521 if (! for_click)
2522 Fsignal (Qquit, Qnil);
2523 break;
2526 unbind_to (specpdl_count, Qnil);
2528 return entry;
2531 #endif /* not USE_X_TOOLKIT */
2533 #endif /* HAVE_MENUS */
2535 #ifndef MSDOS
2536 /* Detect if a dialog or menu has been posted. MSDOS has its own
2537 implementation on msdos.c. */
2540 popup_activated (void)
2542 return popup_activated_flag;
2544 #endif /* not MSDOS */
2546 /* The following is used by delayed window autoselection. */
2548 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
2549 doc: /* Return t if a menu or popup dialog is active. */)
2550 (void)
2552 #ifdef HAVE_MENUS
2553 return (popup_activated ()) ? Qt : Qnil;
2554 #else
2555 return Qnil;
2556 #endif /* HAVE_MENUS */
2559 void
2560 syms_of_xmenu (void)
2562 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
2564 #ifdef USE_X_TOOLKIT
2565 widget_id_tick = (1<<16);
2566 next_menubar_widget_id = 1;
2567 #endif
2569 defsubr (&Smenu_or_popup_active_p);
2571 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
2572 defsubr (&Sx_menu_bar_open_internal);
2573 Ffset (intern_c_string ("accelerate-menu"),
2574 intern_c_string (Sx_menu_bar_open_internal.symbol_name));
2575 #endif
2577 #ifdef HAVE_MENUS
2578 defsubr (&Sx_popup_dialog);
2579 #endif