* lisp/progmodes/flymake.el (flymake-xml-program): New option.
[emacs.git] / src / xmenu.c
blob9993bd87d5b26c16f234e79865178f5e50cc73e4
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2013 Free Software
4 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, bool, 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_EACH_FRAME (tail, frame)
137 f = XFRAME (frame);
138 if (!FRAME_WINDOW_P (f))
139 continue;
140 if (f->output_data.x->id == id)
141 return f;
143 return 0;
146 #endif
148 #ifdef HAVE_X_WINDOWS
149 /* Return the mouse position in *X and *Y. The coordinates are window
150 relative for the edit window in frame F.
151 This is for Fx_popup_menu. The mouse_position_hook can not
152 be used for X, as it returns window relative coordinates
153 for the window where the mouse is in. This could be the menu bar,
154 the scroll bar or the edit window. Fx_popup_menu needs to be
155 sure it is the edit window. */
156 void
157 mouse_position_for_popup (FRAME_PTR f, int *x, int *y)
159 Window root, dummy_window;
160 int dummy;
162 if (! FRAME_X_P (f))
163 emacs_abort ();
165 block_input ();
167 XQueryPointer (FRAME_X_DISPLAY (f),
168 DefaultRootWindow (FRAME_X_DISPLAY (f)),
170 /* The root window which contains the pointer. */
171 &root,
173 /* Window pointer is on, not used */
174 &dummy_window,
176 /* The position on that root window. */
177 x, y,
179 /* x/y in dummy_window coordinates, not used. */
180 &dummy, &dummy,
182 /* Modifier keys and pointer buttons, about which
183 we don't care. */
184 (unsigned int *) &dummy);
186 unblock_input ();
188 /* xmenu_show expects window coordinates, not root window
189 coordinates. Translate. */
190 *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
191 *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
194 #endif /* HAVE_X_WINDOWS */
196 #ifdef HAVE_MENUS
198 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
199 doc: /* Pop up a dialog box and return user's selection.
200 POSITION specifies which frame to use.
201 This is normally a mouse button event or a window or frame.
202 If POSITION is t, it means to use the frame the mouse is on.
203 The dialog box appears in the middle of the specified frame.
205 CONTENTS specifies the alternatives to display in the dialog box.
206 It is a list of the form (DIALOG ITEM1 ITEM2...).
207 Each ITEM is a cons cell (STRING . VALUE).
208 The return value is VALUE from the chosen item.
210 An ITEM may also be just a string--that makes a nonselectable item.
211 An ITEM may also be nil--that means to put all preceding items
212 on the left of the dialog box and all following items on the right.
213 \(By default, approximately half appear on each side.)
215 If HEADER is non-nil, the frame title for the box is "Information",
216 otherwise it is "Question".
218 If the user gets rid of the dialog box without making a valid choice,
219 for instance using the window manager, then this produces a quit and
220 `x-popup-dialog' does not return. */)
221 (Lisp_Object position, Lisp_Object contents, Lisp_Object header)
223 FRAME_PTR f = NULL;
224 Lisp_Object window;
226 /* Decode the first argument: find the window or frame to use. */
227 if (EQ (position, Qt)
228 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
229 || EQ (XCAR (position), Qtool_bar))))
231 #if 0 /* Using the frame the mouse is on may not be right. */
232 /* Use the mouse's current position. */
233 FRAME_PTR new_f = SELECTED_FRAME ();
234 Lisp_Object bar_window;
235 enum scroll_bar_part part;
236 Time time;
237 Lisp_Object x, y;
239 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
241 if (new_f != 0)
242 XSETFRAME (window, new_f);
243 else
244 window = selected_window;
245 #endif
246 window = selected_window;
248 else if (CONSP (position))
250 Lisp_Object tem = XCAR (position);
251 if (CONSP (tem))
252 window = Fcar (XCDR (position));
253 else
255 tem = Fcar (XCDR (position)); /* EVENT_START (position) */
256 window = Fcar (tem); /* POSN_WINDOW (tem) */
259 else if (WINDOWP (position) || FRAMEP (position))
260 window = position;
261 else
262 window = Qnil;
264 /* Decode where to put the menu. */
266 if (FRAMEP (window))
267 f = XFRAME (window);
268 else if (WINDOWP (window))
270 CHECK_LIVE_WINDOW (window);
271 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
273 else
274 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
275 but I don't want to make one now. */
276 CHECK_WINDOW (window);
278 check_window_system (f);
280 /* Force a redisplay before showing the dialog. If a frame is created
281 just before showing the dialog, its contents may not have been fully
282 drawn, as this depends on timing of events from the X server. Redisplay
283 is not done when a dialog is shown. If redisplay could be done in the
284 X event loop (i.e. the X event loop does not run in a signal handler)
285 this would not be needed.
287 Do this before creating the widget value that points to Lisp
288 string contents, because Fredisplay may GC and relocate them. */
289 Fredisplay (Qt);
291 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
292 /* Display a menu with these alternatives
293 in the middle of frame F. */
295 Lisp_Object x, y, frame, newpos;
296 XSETFRAME (frame, f);
297 XSETINT (x, x_pixel_width (f) / 2);
298 XSETINT (y, x_pixel_height (f) / 2);
299 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
301 return Fx_popup_menu (newpos,
302 Fcons (Fcar (contents), Fcons (contents, Qnil)));
304 #else
306 Lisp_Object title;
307 const char *error_name;
308 Lisp_Object selection;
309 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
311 /* Decode the dialog items from what was specified. */
312 title = Fcar (contents);
313 CHECK_STRING (title);
314 record_unwind_protect (unuse_menu_items, Qnil);
316 if (NILP (Fcar (Fcdr (contents))))
317 /* No buttons specified, add an "Ok" button so users can pop down
318 the dialog. Also, the lesstif/motif version crashes if there are
319 no buttons. */
320 contents = Fcons (title, Fcons (Fcons (build_string ("Ok"), Qt), Qnil));
322 list_of_panes (Fcons (contents, Qnil));
324 /* Display them in a dialog box. */
325 block_input ();
326 selection = xdialog_show (f, 0, title, header, &error_name);
327 unblock_input ();
329 unbind_to (specpdl_count, Qnil);
330 discard_menu_items ();
332 if (error_name) error ("%s", error_name);
333 return selection;
335 #endif
339 #ifndef MSDOS
341 #if defined USE_GTK || defined USE_MOTIF
343 /* Set menu_items_inuse so no other popup menu or dialog is created. */
345 void
346 x_menu_set_in_use (int in_use)
348 menu_items_inuse = in_use ? Qt : Qnil;
349 popup_activated_flag = in_use;
350 #ifdef USE_X_TOOLKIT
351 if (popup_activated_flag)
352 x_activate_timeout_atimer ();
353 #endif
356 #endif
358 /* Wait for an X event to arrive or for a timer to expire. */
360 #ifndef USE_MOTIF
361 static
362 #endif
363 void
364 x_menu_wait_for_event (void *data)
366 /* Another way to do this is to register a timer callback, that can be
367 done in GTK and Xt. But we have to do it like this when using only X
368 anyway, and with callbacks we would have three variants for timer handling
369 instead of the small ifdefs below. */
371 while (
372 #ifdef USE_X_TOOLKIT
373 ! XtAppPending (Xt_app_con)
374 #elif defined USE_GTK
375 ! gtk_events_pending ()
376 #else
377 ! XPending ((Display*) data)
378 #endif
381 EMACS_TIME next_time = timer_check (), *ntp;
382 SELECT_TYPE read_fds;
383 struct x_display_info *dpyinfo;
384 int n = 0;
386 FD_ZERO (&read_fds);
387 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
389 int fd = ConnectionNumber (dpyinfo->display);
390 FD_SET (fd, &read_fds);
391 if (fd > n) n = fd;
392 XFlush (dpyinfo->display);
395 if (! EMACS_TIME_VALID_P (next_time))
396 ntp = 0;
397 else
398 ntp = &next_time;
400 #ifdef HAVE_GTK3
401 /* Gtk3 have arrows on menus when they don't fit. When the
402 pointer is over an arrow, a timeout scrolls it a bit. Use
403 xg_select so that timeout gets triggered. */
404 xg_select (n + 1, &read_fds, NULL, NULL, ntp, NULL);
405 #else
406 pselect (n + 1, &read_fds, NULL, NULL, ntp, NULL);
407 #endif
410 #endif /* ! MSDOS */
413 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
415 #ifdef USE_X_TOOLKIT
417 /* Loop in Xt until the menu pulldown or dialog popup has been
418 popped down (deactivated). This is used for x-popup-menu
419 and x-popup-dialog; it is not used for the menu bar.
421 NOTE: All calls to popup_get_selection should be protected
422 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
424 static void
425 popup_get_selection (XEvent *initial_event, struct x_display_info *dpyinfo, LWLIB_ID id, int do_timers)
427 XEvent event;
429 while (popup_activated_flag)
431 if (initial_event)
433 event = *initial_event;
434 initial_event = 0;
436 else
438 if (do_timers) x_menu_wait_for_event (0);
439 XtAppNextEvent (Xt_app_con, &event);
442 /* Make sure we don't consider buttons grabbed after menu goes.
443 And make sure to deactivate for any ButtonRelease,
444 even if XtDispatchEvent doesn't do that. */
445 if (event.type == ButtonRelease
446 && dpyinfo->display == event.xbutton.display)
448 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
449 #ifdef USE_MOTIF /* Pretending that the event came from a
450 Btn1Down seems the only way to convince Motif to
451 activate its callbacks; setting the XmNmenuPost
452 isn't working. --marcus@sysc.pdx.edu. */
453 event.xbutton.button = 1;
454 /* Motif only pops down menus when no Ctrl, Alt or Mod
455 key is pressed and the button is released. So reset key state
456 so Motif thinks this is the case. */
457 event.xbutton.state = 0;
458 #endif
460 /* Pop down on C-g and Escape. */
461 else if (event.type == KeyPress
462 && dpyinfo->display == event.xbutton.display)
464 KeySym keysym = XLookupKeysym (&event.xkey, 0);
466 if ((keysym == XK_g && (event.xkey.state & ControlMask) != 0)
467 || keysym == XK_Escape) /* Any escape, ignore modifiers. */
468 popup_activated_flag = 0;
471 x_dispatch_event (&event, event.xany.display);
475 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
476 doc: /* Start key navigation of the menu bar in FRAME.
477 This initially opens the first menu bar item and you can then navigate with the
478 arrow keys, select a menu entry with the return key or cancel with the
479 escape key. If FRAME has no menu bar this function does nothing.
481 If FRAME is nil or not given, use the selected frame. */)
482 (Lisp_Object frame)
484 XEvent ev;
485 FRAME_PTR f = decode_window_system_frame (frame);
486 Widget menubar;
487 block_input ();
489 if (FRAME_EXTERNAL_MENU_BAR (f))
490 set_frame_menubar (f, 0, 1);
492 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
493 if (menubar)
495 Window child;
496 int error_p = 0;
498 x_catch_errors (FRAME_X_DISPLAY (f));
499 memset (&ev, 0, sizeof ev);
500 ev.xbutton.display = FRAME_X_DISPLAY (f);
501 ev.xbutton.window = XtWindow (menubar);
502 ev.xbutton.root = FRAME_X_DISPLAY_INFO (f)->root_window;
503 ev.xbutton.time = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
504 ev.xbutton.button = Button1;
505 ev.xbutton.x = ev.xbutton.y = FRAME_MENUBAR_HEIGHT (f) / 2;
506 ev.xbutton.same_screen = True;
508 #ifdef USE_MOTIF
510 Arg al[2];
511 WidgetList list;
512 Cardinal nr;
513 XtSetArg (al[0], XtNchildren, &list);
514 XtSetArg (al[1], XtNnumChildren, &nr);
515 XtGetValues (menubar, al, 2);
516 ev.xbutton.window = XtWindow (list[0]);
518 #endif
520 XTranslateCoordinates (FRAME_X_DISPLAY (f),
521 /* From-window, to-window. */
522 ev.xbutton.window, ev.xbutton.root,
524 /* From-position, to-position. */
525 ev.xbutton.x, ev.xbutton.y,
526 &ev.xbutton.x_root, &ev.xbutton.y_root,
528 /* Child of win. */
529 &child);
530 error_p = x_had_errors_p (FRAME_X_DISPLAY (f));
531 x_uncatch_errors ();
533 if (! error_p)
535 ev.type = ButtonPress;
536 ev.xbutton.state = 0;
538 XtDispatchEvent (&ev);
539 ev.xbutton.type = ButtonRelease;
540 ev.xbutton.state = Button1Mask;
541 XtDispatchEvent (&ev);
545 unblock_input ();
547 return Qnil;
549 #endif /* USE_X_TOOLKIT */
552 #ifdef USE_GTK
553 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
554 doc: /* Start key navigation of the menu bar in FRAME.
555 This initially opens the first menu bar item and you can then navigate with the
556 arrow keys, select a menu entry with the return key or cancel with the
557 escape key. If FRAME has no menu bar this function does nothing.
559 If FRAME is nil or not given, use the selected frame. */)
560 (Lisp_Object frame)
562 GtkWidget *menubar;
563 FRAME_PTR f;
565 /* gcc 2.95 doesn't accept the FRAME_PTR declaration after
566 block_input (). */
568 block_input ();
569 f = decode_window_system_frame (frame);
571 if (FRAME_EXTERNAL_MENU_BAR (f))
572 set_frame_menubar (f, 0, 1);
574 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
575 if (menubar)
577 /* Activate the first menu. */
578 GList *children = gtk_container_get_children (GTK_CONTAINER (menubar));
580 if (children)
582 g_signal_emit_by_name (children->data, "activate_item");
583 popup_activated_flag = 1;
584 g_list_free (children);
587 unblock_input ();
589 return Qnil;
592 /* Loop util popup_activated_flag is set to zero in a callback.
593 Used for popup menus and dialogs. */
595 static void
596 popup_widget_loop (int do_timers, GtkWidget *widget)
598 ++popup_activated_flag;
600 /* Process events in the Gtk event loop until done. */
601 while (popup_activated_flag)
603 if (do_timers) x_menu_wait_for_event (0);
604 gtk_main_iteration ();
607 #endif
609 /* Activate the menu bar of frame F.
610 This is called from keyboard.c when it gets the
611 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
613 To activate the menu bar, we use the X button-press event
614 that was saved in saved_menu_event.
615 That makes the toolkit do its thing.
617 But first we recompute the menu bar contents (the whole tree).
619 The reason for saving the button event until here, instead of
620 passing it to the toolkit right away, is that we can safely
621 execute Lisp code. */
623 void
624 x_activate_menubar (FRAME_PTR f)
626 if (! FRAME_X_P (f))
627 emacs_abort ();
629 if (!f->output_data.x->saved_menu_event->type)
630 return;
632 #ifdef USE_GTK
633 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
634 f->output_data.x->saved_menu_event->xany.window))
635 return;
636 #endif
638 set_frame_menubar (f, 0, 1);
639 block_input ();
640 popup_activated_flag = 1;
641 #ifdef USE_GTK
642 XPutBackEvent (f->output_data.x->display_info->display,
643 f->output_data.x->saved_menu_event);
644 #else
645 XtDispatchEvent (f->output_data.x->saved_menu_event);
646 #endif
647 unblock_input ();
649 /* Ignore this if we get it a second time. */
650 f->output_data.x->saved_menu_event->type = 0;
653 /* This callback is invoked when the user selects a menubar cascade
654 pushbutton, but before the pulldown menu is posted. */
656 #ifndef USE_GTK
657 static void
658 popup_activate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
660 popup_activated_flag = 1;
661 #ifdef USE_X_TOOLKIT
662 x_activate_timeout_atimer ();
663 #endif
665 #endif
667 /* This callback is invoked when a dialog or menu is finished being
668 used and has been unposted. */
670 static void
671 popup_deactivate_callback (
672 #ifdef USE_GTK
673 GtkWidget *widget, gpointer client_data
674 #else
675 Widget widget, LWLIB_ID id, XtPointer client_data
676 #endif
679 popup_activated_flag = 0;
683 /* Function that finds the frame for WIDGET and shows the HELP text
684 for that widget.
685 F is the frame if known, or NULL if not known. */
686 static void
687 show_help_event (FRAME_PTR f, xt_or_gtk_widget widget, Lisp_Object help)
689 Lisp_Object frame;
691 if (f)
693 XSETFRAME (frame, f);
694 kbd_buffer_store_help_event (frame, help);
696 else
698 #if 0 /* This code doesn't do anything useful. ++kfs */
699 /* WIDGET is the popup menu. It's parent is the frame's
700 widget. See which frame that is. */
701 xt_or_gtk_widget frame_widget = XtParent (widget);
702 Lisp_Object tail;
704 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
706 frame = XCAR (tail);
707 if (FRAMEP (frame)
708 && (f = XFRAME (frame),
709 FRAME_X_P (f) && f->output_data.x->widget == frame_widget))
710 break;
712 #endif
713 show_help_echo (help, Qnil, Qnil, Qnil);
717 /* Callback called when menu items are highlighted/unhighlighted
718 while moving the mouse over them. WIDGET is the menu bar or menu
719 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
720 the data structure for the menu item, or null in case of
721 unhighlighting. */
723 #ifdef USE_GTK
724 static void
725 menu_highlight_callback (GtkWidget *widget, gpointer call_data)
727 xg_menu_item_cb_data *cb_data;
728 Lisp_Object help;
730 cb_data = (xg_menu_item_cb_data*) g_object_get_data (G_OBJECT (widget),
731 XG_ITEM_DATA);
732 if (! cb_data) return;
734 help = call_data ? cb_data->help : Qnil;
736 /* If popup_activated_flag is greater than 1 we are in a popup menu.
737 Don't pass the frame to show_help_event for those.
738 Passing frame creates an Emacs event. As we are looping in
739 popup_widget_loop, it won't be handled. Passing NULL shows the tip
740 directly without using an Emacs event. This is what the Lucid code
741 does below. */
742 show_help_event (popup_activated_flag <= 1 ? cb_data->cl_data->f : NULL,
743 widget, help);
745 #else
746 static void
747 menu_highlight_callback (Widget widget, LWLIB_ID id, void *call_data)
749 struct frame *f;
750 Lisp_Object help;
752 widget_value *wv = (widget_value *) call_data;
754 help = wv ? wv->help : Qnil;
756 /* Determine the frame for the help event. */
757 f = menubar_id_to_frame (id);
759 show_help_event (f, widget, help);
761 #endif
763 #ifdef USE_GTK
764 /* Gtk calls callbacks just because we tell it what item should be
765 selected in a radio group. If this variable is set to a non-zero
766 value, we are creating menus and don't want callbacks right now.
768 static int xg_crazy_callback_abort;
770 /* This callback is called from the menu bar pulldown menu
771 when the user makes a selection.
772 Figure out what the user chose
773 and put the appropriate events into the keyboard buffer. */
774 static void
775 menubar_selection_callback (GtkWidget *widget, gpointer client_data)
777 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
779 if (xg_crazy_callback_abort)
780 return;
782 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
783 return;
785 /* For a group of radio buttons, GTK calls the selection callback first
786 for the item that was active before the selection and then for the one that
787 is active after the selection. For C-h k this means we get the help on
788 the deselected item and then the selected item is executed. Prevent that
789 by ignoring the non-active item. */
790 if (GTK_IS_RADIO_MENU_ITEM (widget)
791 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)))
792 return;
794 /* When a menu is popped down, X generates a focus event (i.e. focus
795 goes back to the frame below the menu). Since GTK buffers events,
796 we force it out here before the menu selection event. Otherwise
797 sit-for will exit at once if the focus event follows the menu selection
798 event. */
800 block_input ();
801 while (gtk_events_pending ())
802 gtk_main_iteration ();
803 unblock_input ();
805 find_and_call_menu_selection (cb_data->cl_data->f,
806 cb_data->cl_data->menu_bar_items_used,
807 cb_data->cl_data->menu_bar_vector,
808 cb_data->call_data);
811 #else /* not USE_GTK */
813 /* This callback is called from the menu bar pulldown menu
814 when the user makes a selection.
815 Figure out what the user chose
816 and put the appropriate events into the keyboard buffer. */
817 static void
818 menubar_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
820 FRAME_PTR f;
822 f = menubar_id_to_frame (id);
823 if (!f)
824 return;
825 find_and_call_menu_selection (f, f->menu_bar_items_used,
826 f->menu_bar_vector, client_data);
828 #endif /* not USE_GTK */
830 /* Recompute all the widgets of frame F, when the menu bar has been
831 changed. */
833 static void
834 update_frame_menubar (FRAME_PTR f)
836 #ifdef USE_GTK
837 xg_update_frame_menubar (f);
838 #else
839 struct x_output *x;
840 int columns, rows;
842 if (! FRAME_X_P (f))
843 emacs_abort ();
845 x = f->output_data.x;
847 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
848 return;
850 block_input ();
851 /* Save the size of the frame because the pane widget doesn't accept
852 to resize itself. So force it. */
853 columns = FRAME_COLS (f);
854 rows = FRAME_LINES (f);
856 /* Do the voodoo which means "I'm changing lots of things, don't try
857 to refigure sizes until I'm done." */
858 lw_refigure_widget (x->column_widget, False);
860 /* The order in which children are managed is the top to bottom
861 order in which they are displayed in the paned window. First,
862 remove the text-area widget. */
863 XtUnmanageChild (x->edit_widget);
865 /* Remove the menubar that is there now, and put up the menubar that
866 should be there. */
867 XtManageChild (x->menubar_widget);
868 XtMapWidget (x->menubar_widget);
869 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
871 /* Re-manage the text-area widget, and then thrash the sizes. */
872 XtManageChild (x->edit_widget);
873 lw_refigure_widget (x->column_widget, True);
875 /* Force the pane widget to resize itself with the right values. */
876 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
877 unblock_input ();
878 #endif
881 #ifdef USE_LUCID
882 static void
883 apply_systemfont_to_dialog (Widget w)
885 const char *fn = xsettings_get_system_normal_font ();
886 if (fn)
888 XrmDatabase db = XtDatabase (XtDisplay (w));
889 if (db)
890 XrmPutStringResource (&db, "*dialog.font", fn);
894 static void
895 apply_systemfont_to_menu (struct frame *f, Widget w)
897 const char *fn = xsettings_get_system_normal_font ();
899 if (fn)
901 XrmDatabase db = XtDatabase (XtDisplay (w));
902 if (db)
904 XrmPutStringResource (&db, "*menubar*font", fn);
905 XrmPutStringResource (&db, "*popup*font", fn);
910 #endif
912 /* Set the contents of the menubar widgets of frame F.
913 The argument FIRST_TIME is currently ignored;
914 it is set the first time this is called, from initialize_frame_menubar. */
916 void
917 set_frame_menubar (FRAME_PTR f, bool first_time, bool deep_p)
919 xt_or_gtk_widget menubar_widget;
920 #ifdef USE_X_TOOLKIT
921 LWLIB_ID id;
922 #endif
923 Lisp_Object items;
924 widget_value *wv, *first_wv, *prev_wv = 0;
925 int i;
926 int *submenu_start, *submenu_end;
927 bool *submenu_top_level_items;
928 int *submenu_n_panes;
930 if (! FRAME_X_P (f))
931 emacs_abort ();
933 menubar_widget = f->output_data.x->menubar_widget;
935 XSETFRAME (Vmenu_updating_frame, f);
937 #ifdef USE_X_TOOLKIT
938 if (f->output_data.x->id == 0)
939 f->output_data.x->id = next_menubar_widget_id++;
940 id = f->output_data.x->id;
941 #endif
943 if (! menubar_widget)
944 deep_p = 1;
945 /* Make the first call for any given frame always go deep. */
946 else if (!f->output_data.x->saved_menu_event && !deep_p)
948 deep_p = 1;
949 f->output_data.x->saved_menu_event = xmalloc (sizeof (XEvent));
950 f->output_data.x->saved_menu_event->type = 0;
953 #ifdef USE_GTK
954 /* If we have detached menus, we must update deep so detached menus
955 also gets updated. */
956 deep_p = deep_p || xg_have_tear_offs ();
957 #endif
959 if (deep_p)
961 /* Make a widget-value tree representing the entire menu trees. */
963 struct buffer *prev = current_buffer;
964 Lisp_Object buffer;
965 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
966 int previous_menu_items_used = f->menu_bar_items_used;
967 Lisp_Object *previous_items
968 = alloca (previous_menu_items_used * sizeof *previous_items);
969 int subitems;
971 /* If we are making a new widget, its contents are empty,
972 do always reinitialize them. */
973 if (! menubar_widget)
974 previous_menu_items_used = 0;
976 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->contents;
977 specbind (Qinhibit_quit, Qt);
978 /* Don't let the debugger step into this code
979 because it is not reentrant. */
980 specbind (Qdebug_on_next_call, Qnil);
982 record_unwind_save_match_data ();
983 if (NILP (Voverriding_local_map_menu_flag))
985 specbind (Qoverriding_terminal_local_map, Qnil);
986 specbind (Qoverriding_local_map, Qnil);
989 set_buffer_internal_1 (XBUFFER (buffer));
991 /* Run the Lucid hook. */
992 safe_run_hooks (Qactivate_menubar_hook);
994 /* If it has changed current-menubar from previous value,
995 really recompute the menubar from the value. */
996 if (! NILP (Vlucid_menu_bar_dirty_flag))
997 call0 (Qrecompute_lucid_menubar);
998 safe_run_hooks (Qmenu_bar_update_hook);
999 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
1001 items = FRAME_MENU_BAR_ITEMS (f);
1003 /* Save the frame's previous menu bar contents data. */
1004 if (previous_menu_items_used)
1005 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
1006 previous_menu_items_used * word_size);
1008 /* Fill in menu_items with the current menu bar contents.
1009 This can evaluate Lisp code. */
1010 save_menu_items ();
1012 menu_items = f->menu_bar_vector;
1013 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
1014 subitems = ASIZE (items) / 4;
1015 submenu_start = alloca ((subitems + 1) * sizeof *submenu_start);
1016 submenu_end = alloca (subitems * sizeof *submenu_end);
1017 submenu_n_panes = alloca (subitems * sizeof *submenu_n_panes);
1018 submenu_top_level_items = alloca (subitems
1019 * sizeof *submenu_top_level_items);
1020 init_menu_items ();
1021 for (i = 0; i < subitems; i++)
1023 Lisp_Object key, string, maps;
1025 key = AREF (items, 4 * i);
1026 string = AREF (items, 4 * i + 1);
1027 maps = AREF (items, 4 * i + 2);
1028 if (NILP (string))
1029 break;
1031 submenu_start[i] = menu_items_used;
1033 menu_items_n_panes = 0;
1034 submenu_top_level_items[i]
1035 = parse_single_submenu (key, string, maps);
1036 submenu_n_panes[i] = menu_items_n_panes;
1038 submenu_end[i] = menu_items_used;
1041 submenu_start[i] = -1;
1042 finish_menu_items ();
1044 /* Convert menu_items into widget_value trees
1045 to display the menu. This cannot evaluate Lisp code. */
1047 wv = xmalloc_widget_value ();
1048 wv->name = "menubar";
1049 wv->value = 0;
1050 wv->enabled = 1;
1051 wv->button_type = BUTTON_TYPE_NONE;
1052 wv->help = Qnil;
1053 first_wv = wv;
1055 for (i = 0; submenu_start[i] >= 0; i++)
1057 menu_items_n_panes = submenu_n_panes[i];
1058 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
1059 submenu_top_level_items[i]);
1060 if (prev_wv)
1061 prev_wv->next = wv;
1062 else
1063 first_wv->contents = wv;
1064 /* Don't set wv->name here; GC during the loop might relocate it. */
1065 wv->enabled = 1;
1066 wv->button_type = BUTTON_TYPE_NONE;
1067 prev_wv = wv;
1070 set_buffer_internal_1 (prev);
1072 /* If there has been no change in the Lisp-level contents
1073 of the menu bar, skip redisplaying it. Just exit. */
1075 /* Compare the new menu items with the ones computed last time. */
1076 for (i = 0; i < previous_menu_items_used; i++)
1077 if (menu_items_used == i
1078 || (!EQ (previous_items[i], AREF (menu_items, i))))
1079 break;
1080 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1082 /* The menu items have not changed. Don't bother updating
1083 the menus in any form, since it would be a no-op. */
1084 free_menubar_widget_value_tree (first_wv);
1085 discard_menu_items ();
1086 unbind_to (specpdl_count, Qnil);
1087 return;
1090 /* The menu items are different, so store them in the frame. */
1091 fset_menu_bar_vector (f, menu_items);
1092 f->menu_bar_items_used = menu_items_used;
1094 /* This undoes save_menu_items. */
1095 unbind_to (specpdl_count, Qnil);
1097 /* Now GC cannot happen during the lifetime of the widget_value,
1098 so it's safe to store data from a Lisp_String. */
1099 wv = first_wv->contents;
1100 for (i = 0; i < ASIZE (items); i += 4)
1102 Lisp_Object string;
1103 string = AREF (items, i + 1);
1104 if (NILP (string))
1105 break;
1106 wv->name = SSDATA (string);
1107 update_submenu_strings (wv->contents);
1108 wv = wv->next;
1112 else
1114 /* Make a widget-value tree containing
1115 just the top level menu bar strings. */
1117 wv = xmalloc_widget_value ();
1118 wv->name = "menubar";
1119 wv->value = 0;
1120 wv->enabled = 1;
1121 wv->button_type = BUTTON_TYPE_NONE;
1122 wv->help = Qnil;
1123 first_wv = wv;
1125 items = FRAME_MENU_BAR_ITEMS (f);
1126 for (i = 0; i < ASIZE (items); i += 4)
1128 Lisp_Object string;
1130 string = AREF (items, i + 1);
1131 if (NILP (string))
1132 break;
1134 wv = xmalloc_widget_value ();
1135 wv->name = SSDATA (string);
1136 wv->value = 0;
1137 wv->enabled = 1;
1138 wv->button_type = BUTTON_TYPE_NONE;
1139 wv->help = Qnil;
1140 /* This prevents lwlib from assuming this
1141 menu item is really supposed to be empty. */
1142 /* The intptr_t cast avoids a warning.
1143 This value just has to be different from small integers. */
1144 wv->call_data = (void *) (intptr_t) (-1);
1146 if (prev_wv)
1147 prev_wv->next = wv;
1148 else
1149 first_wv->contents = wv;
1150 prev_wv = wv;
1153 /* Forget what we thought we knew about what is in the
1154 detailed contents of the menu bar menus.
1155 Changing the top level always destroys the contents. */
1156 f->menu_bar_items_used = 0;
1159 /* Create or update the menu bar widget. */
1161 block_input ();
1163 #ifdef USE_GTK
1164 xg_crazy_callback_abort = 1;
1165 if (menubar_widget)
1167 /* The fourth arg is DEEP_P, which says to consider the entire
1168 menu trees we supply, rather than just the menu bar item names. */
1169 xg_modify_menubar_widgets (menubar_widget,
1171 first_wv,
1172 deep_p,
1173 G_CALLBACK (menubar_selection_callback),
1174 G_CALLBACK (popup_deactivate_callback),
1175 G_CALLBACK (menu_highlight_callback));
1177 else
1179 menubar_widget
1180 = xg_create_widget ("menubar", "menubar", f, first_wv,
1181 G_CALLBACK (menubar_selection_callback),
1182 G_CALLBACK (popup_deactivate_callback),
1183 G_CALLBACK (menu_highlight_callback));
1185 f->output_data.x->menubar_widget = menubar_widget;
1189 #else /* not USE_GTK */
1190 if (menubar_widget)
1192 /* Disable resizing (done for Motif!) */
1193 lw_allow_resizing (f->output_data.x->widget, False);
1195 /* The third arg is DEEP_P, which says to consider the entire
1196 menu trees we supply, rather than just the menu bar item names. */
1197 lw_modify_all_widgets (id, first_wv, deep_p);
1199 /* Re-enable the edit widget to resize. */
1200 lw_allow_resizing (f->output_data.x->widget, True);
1202 else
1204 char menuOverride[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
1205 XtTranslations override = XtParseTranslationTable (menuOverride);
1207 #ifdef USE_LUCID
1208 apply_systemfont_to_menu (f, f->output_data.x->column_widget);
1209 #endif
1210 menubar_widget = lw_create_widget ("menubar", "menubar", id,
1211 first_wv,
1212 f->output_data.x->column_widget,
1214 popup_activate_callback,
1215 menubar_selection_callback,
1216 popup_deactivate_callback,
1217 menu_highlight_callback);
1218 f->output_data.x->menubar_widget = menubar_widget;
1220 /* Make menu pop down on C-g. */
1221 XtOverrideTranslations (menubar_widget, override);
1225 int menubar_size;
1226 if (f->output_data.x->menubar_widget)
1227 XtRealizeWidget (f->output_data.x->menubar_widget);
1229 menubar_size
1230 = (f->output_data.x->menubar_widget
1231 ? (f->output_data.x->menubar_widget->core.height
1232 + f->output_data.x->menubar_widget->core.border_width)
1233 : 0);
1235 #if 1 /* Experimentally, we now get the right results
1236 for -geometry -0-0 without this. 24 Aug 96, rms.
1237 Maybe so, but the menu bar size is missing the pixels so the
1238 WM size hints are off by these pixels. Jan D, oct 2009. */
1239 #ifdef USE_LUCID
1240 if (FRAME_EXTERNAL_MENU_BAR (f))
1242 Dimension ibw = 0;
1243 XtVaGetValues (f->output_data.x->column_widget,
1244 XtNinternalBorderWidth, &ibw, NULL);
1245 menubar_size += ibw;
1247 #endif /* USE_LUCID */
1248 #endif /* 1 */
1250 f->output_data.x->menubar_height = menubar_size;
1252 #endif /* not USE_GTK */
1254 free_menubar_widget_value_tree (first_wv);
1255 update_frame_menubar (f);
1257 #ifdef USE_GTK
1258 xg_crazy_callback_abort = 0;
1259 #endif
1261 unblock_input ();
1264 /* Called from Fx_create_frame to create the initial menubar of a frame
1265 before it is mapped, so that the window is mapped with the menubar already
1266 there instead of us tacking it on later and thrashing the window after it
1267 is visible. */
1269 void
1270 initialize_frame_menubar (FRAME_PTR f)
1272 /* This function is called before the first chance to redisplay
1273 the frame. It has to be, so the frame will have the right size. */
1274 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
1275 set_frame_menubar (f, 1, 1);
1279 /* Get rid of the menu bar of frame F, and free its storage.
1280 This is used when deleting a frame, and when turning off the menu bar.
1281 For GTK this function is in gtkutil.c. */
1283 #ifndef USE_GTK
1284 void
1285 free_frame_menubar (FRAME_PTR f)
1287 Widget menubar_widget;
1289 if (! FRAME_X_P (f))
1290 emacs_abort ();
1292 menubar_widget = f->output_data.x->menubar_widget;
1294 f->output_data.x->menubar_height = 0;
1296 if (menubar_widget)
1298 #ifdef USE_MOTIF
1299 /* Removing the menu bar magically changes the shell widget's x
1300 and y position of (0, 0) which, when the menu bar is turned
1301 on again, leads to pull-down menus appearing in strange
1302 positions near the upper-left corner of the display. This
1303 happens only with some window managers like twm and ctwm,
1304 but not with other like Motif's mwm or kwm, because the
1305 latter generate ConfigureNotify events when the menu bar
1306 is switched off, which fixes the shell position. */
1307 Position x0, y0, x1, y1;
1308 #endif
1310 block_input ();
1312 #ifdef USE_MOTIF
1313 if (f->output_data.x->widget)
1314 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
1315 #endif
1317 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1318 f->output_data.x->menubar_widget = NULL;
1320 if (f->output_data.x->widget)
1322 #ifdef USE_MOTIF
1323 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
1324 if (x1 == 0 && y1 == 0)
1325 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
1326 #endif
1327 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1329 unblock_input ();
1332 #endif /* not USE_GTK */
1334 #endif /* USE_X_TOOLKIT || USE_GTK */
1336 /* xmenu_show actually displays a menu using the panes and items in menu_items
1337 and returns the value selected from it.
1338 There are two versions of xmenu_show, one for Xt and one for Xlib.
1339 Both assume input is blocked by the caller. */
1341 /* F is the frame the menu is for.
1342 X and Y are the frame-relative specified position,
1343 relative to the inside upper left corner of the frame F.
1344 FOR_CLICK is true if this menu was invoked for a mouse click.
1345 KEYMAPS is true if this menu was specified with keymaps;
1346 in that case, we return a list containing the chosen item's value
1347 and perhaps also the pane's prefix.
1348 TITLE is the specified menu title.
1349 ERROR is a place to store an error message string in case of failure.
1350 (We return nil on failure, but the value doesn't actually matter.) */
1352 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1354 /* The item selected in the popup menu. */
1355 static Lisp_Object *volatile menu_item_selection;
1357 #ifdef USE_GTK
1359 /* Used when position a popup menu. See menu_position_func and
1360 create_and_show_popup_menu below. */
1361 struct next_popup_x_y
1363 FRAME_PTR f;
1364 int x;
1365 int y;
1368 /* The menu position function to use if we are not putting a popup
1369 menu where the pointer is.
1370 MENU is the menu to pop up.
1371 X and Y shall on exit contain x/y where the menu shall pop up.
1372 PUSH_IN is not documented in the GTK manual.
1373 USER_DATA is any data passed in when calling gtk_menu_popup.
1374 Here it points to a struct next_popup_x_y where the coordinates
1375 to store in *X and *Y are as well as the frame for the popup.
1377 Here only X and Y are used. */
1378 static void
1379 menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
1381 struct next_popup_x_y* data = (struct next_popup_x_y*)user_data;
1382 GtkRequisition req;
1383 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (data->f);
1384 int disp_width = x_display_pixel_width (dpyinfo);
1385 int disp_height = x_display_pixel_height (dpyinfo);
1387 *x = data->x;
1388 *y = data->y;
1390 /* Check if there is room for the menu. If not, adjust x/y so that
1391 the menu is fully visible. */
1392 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1393 if (data->x + req.width > disp_width)
1394 *x -= data->x + req.width - disp_width;
1395 if (data->y + req.height > disp_height)
1396 *y -= data->y + req.height - disp_height;
1399 static void
1400 popup_selection_callback (GtkWidget *widget, gpointer client_data)
1402 xg_menu_item_cb_data *cb_data = (xg_menu_item_cb_data*) client_data;
1404 if (xg_crazy_callback_abort) return;
1405 if (cb_data) menu_item_selection = (Lisp_Object *) cb_data->call_data;
1408 static Lisp_Object
1409 pop_down_menu (Lisp_Object arg)
1411 popup_activated_flag = 0;
1412 block_input ();
1413 gtk_widget_destroy (GTK_WIDGET (XSAVE_POINTER (arg, 0)));
1414 unblock_input ();
1415 return Qnil;
1418 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1419 menu pops down.
1420 menu_item_selection will be set to the selection. */
1421 static void
1422 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv, int x, int y,
1423 bool for_click, Time timestamp)
1425 int i;
1426 GtkWidget *menu;
1427 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
1428 struct next_popup_x_y popup_x_y;
1429 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1430 bool use_pos_func = ! for_click;
1432 #ifdef HAVE_GTK3
1433 /* Always use position function for Gtk3. Otherwise menus may become
1434 too small to show anything. */
1435 use_pos_func = 1;
1436 #endif
1438 if (! FRAME_X_P (f))
1439 emacs_abort ();
1441 xg_crazy_callback_abort = 1;
1442 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
1443 G_CALLBACK (popup_selection_callback),
1444 G_CALLBACK (popup_deactivate_callback),
1445 G_CALLBACK (menu_highlight_callback));
1446 xg_crazy_callback_abort = 0;
1448 if (use_pos_func)
1450 /* Not invoked by a click. pop up at x/y. */
1451 pos_func = menu_position_func;
1453 /* Adjust coordinates to be root-window-relative. */
1454 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1455 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1457 popup_x_y.x = x;
1458 popup_x_y.y = y;
1459 popup_x_y.f = f;
1461 i = 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
1464 if (for_click)
1466 for (i = 0; i < 5; i++)
1467 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1468 break;
1471 /* Display the menu. */
1472 gtk_widget_show_all (menu);
1474 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i,
1475 timestamp ? timestamp : gtk_get_current_event_time ());
1477 record_unwind_protect (pop_down_menu, make_save_pointer (menu));
1479 if (gtk_widget_get_mapped (menu))
1481 /* Set this to one. popup_widget_loop increases it by one, so it becomes
1482 two. show_help_echo uses this to detect popup menus. */
1483 popup_activated_flag = 1;
1484 /* Process events that apply to the menu. */
1485 popup_widget_loop (1, menu);
1488 unbind_to (specpdl_count, Qnil);
1490 /* Must reset this manually because the button release event is not passed
1491 to Emacs event loop. */
1492 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
1495 #else /* not USE_GTK */
1497 /* We need a unique id for each widget handled by the Lucid Widget
1498 library.
1500 For the main windows, and popup menus, we use this counter,
1501 which we increment each time after use. This starts from 1<<16.
1503 For menu bars, we use numbers starting at 0, counted in
1504 next_menubar_widget_id. */
1505 LWLIB_ID widget_id_tick;
1507 static void
1508 popup_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1510 menu_item_selection = (Lisp_Object *) client_data;
1513 /* ARG is the LWLIB ID of the dialog box, represented
1514 as a Lisp object as (HIGHPART . LOWPART). */
1516 static Lisp_Object
1517 pop_down_menu (Lisp_Object arg)
1519 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
1520 | XINT (XCDR (arg)));
1522 block_input ();
1523 lw_destroy_all_widgets (id);
1524 unblock_input ();
1525 popup_activated_flag = 0;
1527 return Qnil;
1530 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1531 menu pops down.
1532 menu_item_selection will be set to the selection. */
1533 static void
1534 create_and_show_popup_menu (FRAME_PTR f, widget_value *first_wv,
1535 int x, int y, bool for_click, Time timestamp)
1537 int i;
1538 Arg av[2];
1539 int ac = 0;
1540 XEvent dummy;
1541 XButtonPressedEvent *event = &(dummy.xbutton);
1542 LWLIB_ID menu_id;
1543 Widget menu;
1545 if (! FRAME_X_P (f))
1546 emacs_abort ();
1548 #ifdef USE_LUCID
1549 apply_systemfont_to_menu (f, f->output_data.x->widget);
1550 #endif
1552 menu_id = widget_id_tick++;
1553 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
1554 f->output_data.x->widget, 1, 0,
1555 popup_selection_callback,
1556 popup_deactivate_callback,
1557 menu_highlight_callback);
1559 event->type = ButtonPress;
1560 event->serial = 0;
1561 event->send_event = 0;
1562 event->display = FRAME_X_DISPLAY (f);
1563 event->time = CurrentTime;
1564 event->root = FRAME_X_DISPLAY_INFO (f)->root_window;
1565 event->window = event->subwindow = event->root;
1566 event->x = x;
1567 event->y = y;
1569 /* Adjust coordinates to be root-window-relative. */
1570 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1571 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1573 event->x_root = x;
1574 event->y_root = y;
1576 event->state = 0;
1577 event->button = 0;
1578 for (i = 0; i < 5; i++)
1579 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1580 event->button = i;
1582 /* Don't allow any geometry request from the user. */
1583 XtSetArg (av[ac], XtNgeometry, 0); ac++;
1584 XtSetValues (menu, av, ac);
1586 /* Display the menu. */
1587 lw_popup_menu (menu, &dummy);
1588 popup_activated_flag = 1;
1589 x_activate_timeout_atimer ();
1592 int fact = 4 * sizeof (LWLIB_ID);
1593 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1594 record_unwind_protect (pop_down_menu,
1595 Fcons (make_number (menu_id >> (fact)),
1596 make_number (menu_id & ~(-1 << (fact)))));
1598 /* Process events that apply to the menu. */
1599 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), menu_id, 1);
1601 unbind_to (specpdl_count, Qnil);
1605 #endif /* not USE_GTK */
1607 static Lisp_Object
1608 cleanup_widget_value_tree (Lisp_Object arg)
1610 free_menubar_widget_value_tree (XSAVE_POINTER (arg, 0));
1611 return Qnil;
1614 Lisp_Object
1615 xmenu_show (FRAME_PTR f, int x, int y, bool for_click, bool keymaps,
1616 Lisp_Object title, const char **error_name, Time timestamp)
1618 int i;
1619 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1620 widget_value **submenu_stack
1621 = alloca (menu_items_used * sizeof *submenu_stack);
1622 Lisp_Object *subprefix_stack
1623 = alloca (menu_items_used * sizeof *subprefix_stack);
1624 int submenu_depth = 0;
1626 int first_pane;
1628 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1630 if (! FRAME_X_P (f))
1631 emacs_abort ();
1633 *error_name = NULL;
1635 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1637 *error_name = "Empty menu";
1638 return Qnil;
1641 /* Create a tree of widget_value objects
1642 representing the panes and their items. */
1643 wv = xmalloc_widget_value ();
1644 wv->name = "menu";
1645 wv->value = 0;
1646 wv->enabled = 1;
1647 wv->button_type = BUTTON_TYPE_NONE;
1648 wv->help =Qnil;
1649 first_wv = wv;
1650 first_pane = 1;
1652 /* Loop over all panes and items, filling in the tree. */
1653 i = 0;
1654 while (i < menu_items_used)
1656 if (EQ (AREF (menu_items, i), Qnil))
1658 submenu_stack[submenu_depth++] = save_wv;
1659 save_wv = prev_wv;
1660 prev_wv = 0;
1661 first_pane = 1;
1662 i++;
1664 else if (EQ (AREF (menu_items, i), Qlambda))
1666 prev_wv = save_wv;
1667 save_wv = submenu_stack[--submenu_depth];
1668 first_pane = 0;
1669 i++;
1671 else if (EQ (AREF (menu_items, i), Qt)
1672 && submenu_depth != 0)
1673 i += MENU_ITEMS_PANE_LENGTH;
1674 /* Ignore a nil in the item list.
1675 It's meaningful only for dialog boxes. */
1676 else if (EQ (AREF (menu_items, i), Qquote))
1677 i += 1;
1678 else if (EQ (AREF (menu_items, i), Qt))
1680 /* Create a new pane. */
1681 Lisp_Object pane_name, prefix;
1682 const char *pane_string;
1684 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1685 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1687 #ifndef HAVE_MULTILINGUAL_MENU
1688 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1690 pane_name = ENCODE_MENU_STRING (pane_name);
1691 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1693 #endif
1694 pane_string = (NILP (pane_name)
1695 ? "" : SSDATA (pane_name));
1696 /* If there is just one top-level pane, put all its items directly
1697 under the top-level menu. */
1698 if (menu_items_n_panes == 1)
1699 pane_string = "";
1701 /* If the pane has a meaningful name,
1702 make the pane a top-level menu item
1703 with its items as a submenu beneath it. */
1704 if (!keymaps && strcmp (pane_string, ""))
1706 wv = xmalloc_widget_value ();
1707 if (save_wv)
1708 save_wv->next = wv;
1709 else
1710 first_wv->contents = wv;
1711 wv->name = (char *) pane_string;
1712 if (keymaps && !NILP (prefix))
1713 wv->name++;
1714 wv->value = 0;
1715 wv->enabled = 1;
1716 wv->button_type = BUTTON_TYPE_NONE;
1717 wv->help = Qnil;
1718 save_wv = wv;
1719 prev_wv = 0;
1721 else if (first_pane)
1723 save_wv = wv;
1724 prev_wv = 0;
1726 first_pane = 0;
1727 i += MENU_ITEMS_PANE_LENGTH;
1729 else
1731 /* Create a new item within current pane. */
1732 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1733 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1734 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1735 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1736 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1737 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1738 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1739 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1741 #ifndef HAVE_MULTILINGUAL_MENU
1742 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
1744 item_name = ENCODE_MENU_STRING (item_name);
1745 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1748 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1750 descrip = ENCODE_MENU_STRING (descrip);
1751 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1753 #endif /* not HAVE_MULTILINGUAL_MENU */
1755 wv = xmalloc_widget_value ();
1756 if (prev_wv)
1757 prev_wv->next = wv;
1758 else
1759 save_wv->contents = wv;
1760 wv->name = SSDATA (item_name);
1761 if (!NILP (descrip))
1762 wv->key = SSDATA (descrip);
1763 wv->value = 0;
1764 /* If this item has a null value,
1765 make the call_data null so that it won't display a box
1766 when the mouse is on it. */
1767 wv->call_data = !NILP (def) ? aref_addr (menu_items, i) : 0;
1768 wv->enabled = !NILP (enable);
1770 if (NILP (type))
1771 wv->button_type = BUTTON_TYPE_NONE;
1772 else if (EQ (type, QCtoggle))
1773 wv->button_type = BUTTON_TYPE_TOGGLE;
1774 else if (EQ (type, QCradio))
1775 wv->button_type = BUTTON_TYPE_RADIO;
1776 else
1777 emacs_abort ();
1779 wv->selected = !NILP (selected);
1781 if (! STRINGP (help))
1782 help = Qnil;
1784 wv->help = help;
1786 prev_wv = wv;
1788 i += MENU_ITEMS_ITEM_LENGTH;
1792 /* Deal with the title, if it is non-nil. */
1793 if (!NILP (title))
1795 widget_value *wv_title = xmalloc_widget_value ();
1796 widget_value *wv_sep1 = xmalloc_widget_value ();
1797 widget_value *wv_sep2 = xmalloc_widget_value ();
1799 wv_sep2->name = "--";
1800 wv_sep2->next = first_wv->contents;
1801 wv_sep2->help = Qnil;
1803 wv_sep1->name = "--";
1804 wv_sep1->next = wv_sep2;
1805 wv_sep1->help = Qnil;
1807 #ifndef HAVE_MULTILINGUAL_MENU
1808 if (STRING_MULTIBYTE (title))
1809 title = ENCODE_MENU_STRING (title);
1810 #endif
1812 wv_title->name = SSDATA (title);
1813 wv_title->enabled = TRUE;
1814 wv_title->button_type = BUTTON_TYPE_NONE;
1815 wv_title->help = Qnil;
1816 wv_title->next = wv_sep1;
1817 first_wv->contents = wv_title;
1820 /* No selection has been chosen yet. */
1821 menu_item_selection = 0;
1823 /* Make sure to free the widget_value objects we used to specify the
1824 contents even with longjmp. */
1825 record_unwind_protect (cleanup_widget_value_tree,
1826 make_save_pointer (first_wv));
1828 /* Actually create and show the menu until popped down. */
1829 create_and_show_popup_menu (f, first_wv, x, y, for_click, timestamp);
1831 unbind_to (specpdl_count, Qnil);
1833 /* Find the selected item, and its pane, to return
1834 the proper value. */
1835 if (menu_item_selection != 0)
1837 Lisp_Object prefix, entry;
1839 prefix = entry = Qnil;
1840 i = 0;
1841 while (i < menu_items_used)
1843 if (EQ (AREF (menu_items, i), Qnil))
1845 subprefix_stack[submenu_depth++] = prefix;
1846 prefix = entry;
1847 i++;
1849 else if (EQ (AREF (menu_items, i), Qlambda))
1851 prefix = subprefix_stack[--submenu_depth];
1852 i++;
1854 else if (EQ (AREF (menu_items, i), Qt))
1856 prefix
1857 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1858 i += MENU_ITEMS_PANE_LENGTH;
1860 /* Ignore a nil in the item list.
1861 It's meaningful only for dialog boxes. */
1862 else if (EQ (AREF (menu_items, i), Qquote))
1863 i += 1;
1864 else
1866 entry
1867 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1868 if (menu_item_selection == aref_addr (menu_items, i))
1870 if (keymaps)
1872 int j;
1874 entry = Fcons (entry, Qnil);
1875 if (!NILP (prefix))
1876 entry = Fcons (prefix, entry);
1877 for (j = submenu_depth - 1; j >= 0; j--)
1878 if (!NILP (subprefix_stack[j]))
1879 entry = Fcons (subprefix_stack[j], entry);
1881 return entry;
1883 i += MENU_ITEMS_ITEM_LENGTH;
1887 else if (!for_click)
1888 /* Make "Cancel" equivalent to C-g. */
1889 Fsignal (Qquit, Qnil);
1891 return Qnil;
1894 #ifdef USE_GTK
1895 static void
1896 dialog_selection_callback (GtkWidget *widget, gpointer client_data)
1898 /* Treat the pointer as an integer. There's no problem
1899 as long as pointers have enough bits to hold small integers. */
1900 if ((intptr_t) client_data != -1)
1901 menu_item_selection = (Lisp_Object *) client_data;
1903 popup_activated_flag = 0;
1906 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1907 dialog pops down.
1908 menu_item_selection will be set to the selection. */
1909 static void
1910 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1912 GtkWidget *menu;
1914 if (! FRAME_X_P (f))
1915 emacs_abort ();
1917 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
1918 G_CALLBACK (dialog_selection_callback),
1919 G_CALLBACK (popup_deactivate_callback),
1922 if (menu)
1924 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1925 record_unwind_protect (pop_down_menu, make_save_pointer (menu));
1927 /* Display the menu. */
1928 gtk_widget_show_all (menu);
1930 /* Process events that apply to the menu. */
1931 popup_widget_loop (1, menu);
1933 unbind_to (specpdl_count, Qnil);
1937 #else /* not USE_GTK */
1938 static void
1939 dialog_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1941 /* Treat the pointer as an integer. There's no problem
1942 as long as pointers have enough bits to hold small integers. */
1943 if ((intptr_t) client_data != -1)
1944 menu_item_selection = (Lisp_Object *) client_data;
1946 block_input ();
1947 lw_destroy_all_widgets (id);
1948 unblock_input ();
1949 popup_activated_flag = 0;
1953 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1954 dialog pops down.
1955 menu_item_selection will be set to the selection. */
1956 static void
1957 create_and_show_dialog (FRAME_PTR f, widget_value *first_wv)
1959 LWLIB_ID dialog_id;
1961 if (!FRAME_X_P (f))
1962 emacs_abort ();
1964 dialog_id = widget_id_tick++;
1965 #ifdef USE_LUCID
1966 apply_systemfont_to_dialog (f->output_data.x->widget);
1967 #endif
1968 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
1969 f->output_data.x->widget, 1, 0,
1970 dialog_selection_callback, 0, 0);
1971 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
1972 /* Display the dialog box. */
1973 lw_pop_up_all_widgets (dialog_id);
1974 popup_activated_flag = 1;
1975 x_activate_timeout_atimer ();
1977 /* Process events that apply to the dialog box.
1978 Also handle timers. */
1980 ptrdiff_t count = SPECPDL_INDEX ();
1981 int fact = 4 * sizeof (LWLIB_ID);
1983 /* xdialog_show_unwind is responsible for popping the dialog box down. */
1984 record_unwind_protect (pop_down_menu,
1985 Fcons (make_number (dialog_id >> (fact)),
1986 make_number (dialog_id & ~(-1 << (fact)))));
1988 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f),
1989 dialog_id, 1);
1991 unbind_to (count, Qnil);
1995 #endif /* not USE_GTK */
1997 static const char * button_names [] = {
1998 "button1", "button2", "button3", "button4", "button5",
1999 "button6", "button7", "button8", "button9", "button10" };
2001 static Lisp_Object
2002 xdialog_show (FRAME_PTR f,
2003 bool keymaps,
2004 Lisp_Object title,
2005 Lisp_Object header,
2006 const char **error_name)
2008 int i, nb_buttons=0;
2009 char dialog_name[6];
2011 widget_value *wv, *first_wv = 0, *prev_wv = 0;
2013 /* Number of elements seen so far, before boundary. */
2014 int left_count = 0;
2015 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
2016 int boundary_seen = 0;
2018 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2020 if (! FRAME_X_P (f))
2021 emacs_abort ();
2023 *error_name = NULL;
2025 if (menu_items_n_panes > 1)
2027 *error_name = "Multiple panes in dialog box";
2028 return Qnil;
2031 /* Create a tree of widget_value objects
2032 representing the text label and buttons. */
2034 Lisp_Object pane_name, prefix;
2035 const char *pane_string;
2036 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
2037 prefix = AREF (menu_items, MENU_ITEMS_PANE_PREFIX);
2038 pane_string = (NILP (pane_name)
2039 ? "" : SSDATA (pane_name));
2040 prev_wv = xmalloc_widget_value ();
2041 prev_wv->value = (char *) pane_string;
2042 if (keymaps && !NILP (prefix))
2043 prev_wv->name++;
2044 prev_wv->enabled = 1;
2045 prev_wv->name = "message";
2046 prev_wv->help = Qnil;
2047 first_wv = prev_wv;
2049 /* Loop over all panes and items, filling in the tree. */
2050 i = MENU_ITEMS_PANE_LENGTH;
2051 while (i < menu_items_used)
2054 /* Create a new item within current pane. */
2055 Lisp_Object item_name, enable, descrip;
2056 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2057 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2058 descrip
2059 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2061 if (NILP (item_name))
2063 free_menubar_widget_value_tree (first_wv);
2064 *error_name = "Submenu in dialog items";
2065 return Qnil;
2067 if (EQ (item_name, Qquote))
2069 /* This is the boundary between left-side elts
2070 and right-side elts. Stop incrementing right_count. */
2071 boundary_seen = 1;
2072 i++;
2073 continue;
2075 if (nb_buttons >= 9)
2077 free_menubar_widget_value_tree (first_wv);
2078 *error_name = "Too many dialog items";
2079 return Qnil;
2082 wv = xmalloc_widget_value ();
2083 prev_wv->next = wv;
2084 wv->name = (char *) button_names[nb_buttons];
2085 if (!NILP (descrip))
2086 wv->key = SSDATA (descrip);
2087 wv->value = SSDATA (item_name);
2088 wv->call_data = aref_addr (menu_items, i);
2089 wv->enabled = !NILP (enable);
2090 wv->help = Qnil;
2091 prev_wv = wv;
2093 if (! boundary_seen)
2094 left_count++;
2096 nb_buttons++;
2097 i += MENU_ITEMS_ITEM_LENGTH;
2100 /* If the boundary was not specified,
2101 by default put half on the left and half on the right. */
2102 if (! boundary_seen)
2103 left_count = nb_buttons - nb_buttons / 2;
2105 wv = xmalloc_widget_value ();
2106 wv->name = dialog_name;
2107 wv->help = Qnil;
2109 /* Frame title: 'Q' = Question, 'I' = Information.
2110 Can also have 'E' = Error if, one day, we want
2111 a popup for errors. */
2112 if (NILP (header))
2113 dialog_name[0] = 'Q';
2114 else
2115 dialog_name[0] = 'I';
2117 /* Dialog boxes use a really stupid name encoding
2118 which specifies how many buttons to use
2119 and how many buttons are on the right. */
2120 dialog_name[1] = '0' + nb_buttons;
2121 dialog_name[2] = 'B';
2122 dialog_name[3] = 'R';
2123 /* Number of buttons to put on the right. */
2124 dialog_name[4] = '0' + nb_buttons - left_count;
2125 dialog_name[5] = 0;
2126 wv->contents = first_wv;
2127 first_wv = wv;
2130 /* No selection has been chosen yet. */
2131 menu_item_selection = 0;
2133 /* Make sure to free the widget_value objects we used to specify the
2134 contents even with longjmp. */
2135 record_unwind_protect (cleanup_widget_value_tree,
2136 make_save_pointer (first_wv));
2138 /* Actually create and show the dialog. */
2139 create_and_show_dialog (f, first_wv);
2141 unbind_to (specpdl_count, Qnil);
2143 /* Find the selected item, and its pane, to return
2144 the proper value. */
2145 if (menu_item_selection != 0)
2147 Lisp_Object prefix;
2149 prefix = Qnil;
2150 i = 0;
2151 while (i < menu_items_used)
2153 Lisp_Object entry;
2155 if (EQ (AREF (menu_items, i), Qt))
2157 prefix
2158 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2159 i += MENU_ITEMS_PANE_LENGTH;
2161 else if (EQ (AREF (menu_items, i), Qquote))
2163 /* This is the boundary between left-side elts and
2164 right-side elts. */
2165 ++i;
2167 else
2169 entry
2170 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2171 if (menu_item_selection == aref_addr (menu_items, i))
2173 if (keymaps != 0)
2175 entry = Fcons (entry, Qnil);
2176 if (!NILP (prefix))
2177 entry = Fcons (prefix, entry);
2179 return entry;
2181 i += MENU_ITEMS_ITEM_LENGTH;
2185 else
2186 /* Make "Cancel" equivalent to C-g. */
2187 Fsignal (Qquit, Qnil);
2189 return Qnil;
2192 #else /* not USE_X_TOOLKIT && not USE_GTK */
2194 /* The frame of the last activated non-toolkit menu bar.
2195 Used to generate menu help events. */
2197 static struct frame *menu_help_frame;
2200 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
2202 PANE is the pane number, and ITEM is the menu item number in
2203 the menu (currently not used).
2205 This cannot be done with generating a HELP_EVENT because
2206 XMenuActivate contains a loop that doesn't let Emacs process
2207 keyboard events. */
2209 static void
2210 menu_help_callback (char const *help_string, int pane, int item)
2212 Lisp_Object *first_item;
2213 Lisp_Object pane_name;
2214 Lisp_Object menu_object;
2216 first_item = XVECTOR (menu_items)->contents;
2217 if (EQ (first_item[0], Qt))
2218 pane_name = first_item[MENU_ITEMS_PANE_NAME];
2219 else if (EQ (first_item[0], Qquote))
2220 /* This shouldn't happen, see xmenu_show. */
2221 pane_name = empty_unibyte_string;
2222 else
2223 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
2225 /* (menu-item MENU-NAME PANE-NUMBER) */
2226 menu_object = Fcons (Qmenu_item,
2227 Fcons (pane_name,
2228 Fcons (make_number (pane), Qnil)));
2229 show_help_echo (help_string ? build_string (help_string) : Qnil,
2230 Qnil, menu_object, make_number (item));
2233 static Lisp_Object
2234 pop_down_menu (Lisp_Object arg)
2236 FRAME_PTR f = XSAVE_POINTER (arg, 0);
2237 XMenu *menu = XSAVE_POINTER (arg, 1);
2239 block_input ();
2240 #ifndef MSDOS
2241 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
2242 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
2243 #endif
2244 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2246 #ifdef HAVE_X_WINDOWS
2247 /* Assume the mouse has moved out of the X window.
2248 If it has actually moved in, we will get an EnterNotify. */
2249 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
2251 /* State that no mouse buttons are now held.
2252 (The oldXMenu code doesn't track this info for us.)
2253 That is not necessarily true, but the fiction leads to reasonable
2254 results, and it is a pain to ask which are actually held now. */
2255 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2257 #endif /* HAVE_X_WINDOWS */
2259 unblock_input ();
2261 return Qnil;
2265 Lisp_Object
2266 xmenu_show (FRAME_PTR f, int x, int y, bool for_click, bool keymaps,
2267 Lisp_Object title, const char **error_name, Time timestamp)
2269 Window root;
2270 XMenu *menu;
2271 int pane, selidx, lpane, status;
2272 Lisp_Object entry, pane_prefix;
2273 char *datap;
2274 int ulx, uly, width, height;
2275 int dispwidth, dispheight;
2276 int i, j, lines, maxlines;
2277 int maxwidth;
2278 int dummy_int;
2279 unsigned int dummy_uint;
2280 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2282 if (! FRAME_X_P (f) && ! FRAME_MSDOS_P (f))
2283 emacs_abort ();
2285 *error_name = 0;
2286 if (menu_items_n_panes == 0)
2287 return Qnil;
2289 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2291 *error_name = "Empty menu";
2292 return Qnil;
2295 /* Figure out which root window F is on. */
2296 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2297 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2298 &dummy_uint, &dummy_uint);
2300 /* Make the menu on that window. */
2301 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2302 if (menu == NULL)
2304 *error_name = "Can't create menu";
2305 return Qnil;
2308 /* Don't GC while we prepare and show the menu,
2309 because we give the oldxmenu library pointers to the
2310 contents of strings. */
2311 inhibit_garbage_collection ();
2313 #ifdef HAVE_X_WINDOWS
2314 /* Adjust coordinates to relative to the outer (window manager) window. */
2315 x += FRAME_OUTER_TO_INNER_DIFF_X (f);
2316 y += FRAME_OUTER_TO_INNER_DIFF_Y (f);
2317 #endif /* HAVE_X_WINDOWS */
2319 /* Adjust coordinates to be root-window-relative. */
2320 x += f->left_pos;
2321 y += f->top_pos;
2323 /* Create all the necessary panes and their items. */
2324 maxwidth = maxlines = lines = i = 0;
2325 lpane = XM_FAILURE;
2326 while (i < menu_items_used)
2328 if (EQ (AREF (menu_items, i), Qt))
2330 /* Create a new pane. */
2331 Lisp_Object pane_name, prefix;
2332 const char *pane_string;
2334 maxlines = max (maxlines, lines);
2335 lines = 0;
2336 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
2337 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2338 pane_string = (NILP (pane_name)
2339 ? "" : SSDATA (pane_name));
2340 if (keymaps && !NILP (prefix))
2341 pane_string++;
2343 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2344 if (lpane == XM_FAILURE)
2346 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2347 *error_name = "Can't create pane";
2348 return Qnil;
2350 i += MENU_ITEMS_PANE_LENGTH;
2352 /* Find the width of the widest item in this pane. */
2353 j = i;
2354 while (j < menu_items_used)
2356 Lisp_Object item;
2357 item = AREF (menu_items, j);
2358 if (EQ (item, Qt))
2359 break;
2360 if (NILP (item))
2362 j++;
2363 continue;
2365 width = SBYTES (item);
2366 if (width > maxwidth)
2367 maxwidth = width;
2369 j += MENU_ITEMS_ITEM_LENGTH;
2372 /* Ignore a nil in the item list.
2373 It's meaningful only for dialog boxes. */
2374 else if (EQ (AREF (menu_items, i), Qquote))
2375 i += 1;
2376 else
2378 /* Create a new item within current pane. */
2379 Lisp_Object item_name, enable, descrip, help;
2380 char *item_data;
2381 char const *help_string;
2383 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2384 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2385 descrip
2386 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2387 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
2388 help_string = STRINGP (help) ? SSDATA (help) : NULL;
2390 if (!NILP (descrip))
2392 /* if alloca is fast, use that to make the space,
2393 to reduce gc needs. */
2394 item_data = alloca (maxwidth + SBYTES (descrip) + 1);
2395 memcpy (item_data, SSDATA (item_name), SBYTES (item_name));
2396 for (j = SCHARS (item_name); j < maxwidth; j++)
2397 item_data[j] = ' ';
2398 memcpy (item_data + j, SSDATA (descrip), SBYTES (descrip));
2399 item_data[j + SBYTES (descrip)] = 0;
2401 else
2402 item_data = SSDATA (item_name);
2404 if (lpane == XM_FAILURE
2405 || (XMenuAddSelection (FRAME_X_DISPLAY (f),
2406 menu, lpane, 0, item_data,
2407 !NILP (enable), help_string)
2408 == XM_FAILURE))
2410 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2411 *error_name = "Can't add selection to menu";
2412 return Qnil;
2414 i += MENU_ITEMS_ITEM_LENGTH;
2415 lines++;
2419 maxlines = max (maxlines, lines);
2421 /* All set and ready to fly. */
2422 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2423 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2424 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2425 x = min (x, dispwidth);
2426 y = min (y, dispheight);
2427 x = max (x, 1);
2428 y = max (y, 1);
2429 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2430 &ulx, &uly, &width, &height);
2431 if (ulx+width > dispwidth)
2433 x -= (ulx + width) - dispwidth;
2434 ulx = dispwidth - width;
2436 if (uly+height > dispheight)
2438 y -= (uly + height) - dispheight;
2439 uly = dispheight - height;
2441 #ifndef HAVE_X_WINDOWS
2442 if (FRAME_HAS_MINIBUF_P (f) && uly+height > dispheight - 1)
2444 /* Move the menu away of the echo area, to avoid overwriting the
2445 menu with help echo messages or vice versa. */
2446 if (BUFFERP (echo_area_buffer[0]) && WINDOWP (echo_area_window))
2448 y -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2449 uly -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2451 else
2453 y--;
2454 uly--;
2457 #endif
2458 if (ulx < 0) x -= ulx;
2459 if (uly < 0) y -= uly;
2461 if (! for_click)
2463 /* If position was not given by a mouse click, adjust so upper left
2464 corner of the menu as a whole ends up at given coordinates. This
2465 is what x-popup-menu says in its documentation. */
2466 x += width/2;
2467 y += 1.5*height/(maxlines+2);
2470 XMenuSetAEQ (menu, TRUE);
2471 XMenuSetFreeze (menu, TRUE);
2472 pane = selidx = 0;
2474 #ifndef MSDOS
2475 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
2476 #endif
2478 record_unwind_protect (pop_down_menu,
2479 make_save_value (SAVE_TYPE_PTR_PTR, f, menu));
2481 /* Help display under X won't work because XMenuActivate contains
2482 a loop that doesn't give Emacs a chance to process it. */
2483 menu_help_frame = f;
2484 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2485 x, y, ButtonReleaseMask, &datap,
2486 menu_help_callback);
2487 entry = pane_prefix = Qnil;
2489 switch (status)
2491 case XM_SUCCESS:
2492 #ifdef XDEBUG
2493 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2494 #endif
2496 /* Find the item number SELIDX in pane number PANE. */
2497 i = 0;
2498 while (i < menu_items_used)
2500 if (EQ (AREF (menu_items, i), Qt))
2502 if (pane == 0)
2503 pane_prefix
2504 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2505 pane--;
2506 i += MENU_ITEMS_PANE_LENGTH;
2508 else
2510 if (pane == -1)
2512 if (selidx == 0)
2514 entry
2515 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2516 if (keymaps)
2518 entry = Fcons (entry, Qnil);
2519 if (!NILP (pane_prefix))
2520 entry = Fcons (pane_prefix, entry);
2522 break;
2524 selidx--;
2526 i += MENU_ITEMS_ITEM_LENGTH;
2529 break;
2531 case XM_FAILURE:
2532 *error_name = "Can't activate menu";
2533 case XM_IA_SELECT:
2534 break;
2535 case XM_NO_SELECT:
2536 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
2537 the menu was invoked with a mouse event as POSITION). */
2538 if (! for_click)
2539 Fsignal (Qquit, Qnil);
2540 break;
2543 unbind_to (specpdl_count, Qnil);
2545 return entry;
2548 #endif /* not USE_X_TOOLKIT */
2550 #endif /* HAVE_MENUS */
2552 #ifndef MSDOS
2553 /* Detect if a dialog or menu has been posted. MSDOS has its own
2554 implementation on msdos.c. */
2556 int ATTRIBUTE_CONST
2557 popup_activated (void)
2559 return popup_activated_flag;
2561 #endif /* not MSDOS */
2563 /* The following is used by delayed window autoselection. */
2565 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
2566 doc: /* Return t if a menu or popup dialog is active. */)
2567 (void)
2569 #ifdef HAVE_MENUS
2570 return (popup_activated ()) ? Qt : Qnil;
2571 #else
2572 return Qnil;
2573 #endif /* HAVE_MENUS */
2576 void
2577 syms_of_xmenu (void)
2579 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
2581 #ifdef USE_X_TOOLKIT
2582 widget_id_tick = (1<<16);
2583 next_menubar_widget_id = 1;
2584 #endif
2586 defsubr (&Smenu_or_popup_active_p);
2588 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
2589 defsubr (&Sx_menu_bar_open_internal);
2590 Ffset (intern_c_string ("accelerate-menu"),
2591 intern_c_string (Sx_menu_bar_open_internal.symbol_name));
2592 #endif
2594 #ifdef HAVE_MENUS
2595 defsubr (&Sx_popup_dialog);
2596 #endif