Update copyright year to 2014 by running admin/update-copyright.
[emacs.git] / src / xmenu.c
blobe7e44d4e47f235c496857fe04efd7d4dfbb95786
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2014 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 (struct frame *, 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 struct frame *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 (struct frame *f, int *x, int *y)
159 Window root, dummy_window;
160 int dummy;
162 eassert (FRAME_X_P (f));
164 block_input ();
166 XQueryPointer (FRAME_X_DISPLAY (f),
167 DefaultRootWindow (FRAME_X_DISPLAY (f)),
169 /* The root window which contains the pointer. */
170 &root,
172 /* Window pointer is on, not used */
173 &dummy_window,
175 /* The position on that root window. */
176 x, y,
178 /* x/y in dummy_window coordinates, not used. */
179 &dummy, &dummy,
181 /* Modifier keys and pointer buttons, about which
182 we don't care. */
183 (unsigned int *) &dummy);
185 unblock_input ();
187 /* xmenu_show expects window coordinates, not root window
188 coordinates. Translate. */
189 *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
190 *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
193 #endif /* HAVE_X_WINDOWS */
195 #ifndef MSDOS
197 #if defined USE_GTK || defined USE_MOTIF
199 /* Set menu_items_inuse so no other popup menu or dialog is created. */
201 void
202 x_menu_set_in_use (int in_use)
204 menu_items_inuse = in_use ? Qt : Qnil;
205 popup_activated_flag = in_use;
206 #ifdef USE_X_TOOLKIT
207 if (popup_activated_flag)
208 x_activate_timeout_atimer ();
209 #endif
212 #endif
214 /* Wait for an X event to arrive or for a timer to expire. */
216 #ifndef USE_MOTIF
217 static
218 #endif
219 void
220 x_menu_wait_for_event (void *data)
222 /* Another way to do this is to register a timer callback, that can be
223 done in GTK and Xt. But we have to do it like this when using only X
224 anyway, and with callbacks we would have three variants for timer handling
225 instead of the small ifdefs below. */
227 while (
228 #ifdef USE_X_TOOLKIT
229 ! XtAppPending (Xt_app_con)
230 #elif defined USE_GTK
231 ! gtk_events_pending ()
232 #else
233 ! XPending (data)
234 #endif
237 struct timespec next_time = timer_check (), *ntp;
238 fd_set read_fds;
239 struct x_display_info *dpyinfo;
240 int n = 0;
242 FD_ZERO (&read_fds);
243 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
245 int fd = ConnectionNumber (dpyinfo->display);
246 FD_SET (fd, &read_fds);
247 if (fd > n) n = fd;
248 XFlush (dpyinfo->display);
251 if (! timespec_valid_p (next_time))
252 ntp = 0;
253 else
254 ntp = &next_time;
256 #if defined USE_GTK && defined HAVE_GTK3
257 /* Gtk3 have arrows on menus when they don't fit. When the
258 pointer is over an arrow, a timeout scrolls it a bit. Use
259 xg_select so that timeout gets triggered. */
260 xg_select (n + 1, &read_fds, NULL, NULL, ntp, NULL);
261 #else
262 pselect (n + 1, &read_fds, NULL, NULL, ntp, NULL);
263 #endif
266 #endif /* ! MSDOS */
269 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
271 #ifdef USE_X_TOOLKIT
273 /* Loop in Xt until the menu pulldown or dialog popup has been
274 popped down (deactivated). This is used for x-popup-menu
275 and x-popup-dialog; it is not used for the menu bar.
277 NOTE: All calls to popup_get_selection should be protected
278 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
280 static void
281 popup_get_selection (XEvent *initial_event, struct x_display_info *dpyinfo, LWLIB_ID id, int do_timers)
283 XEvent event;
285 while (popup_activated_flag)
287 if (initial_event)
289 event = *initial_event;
290 initial_event = 0;
292 else
294 if (do_timers) x_menu_wait_for_event (0);
295 XtAppNextEvent (Xt_app_con, &event);
298 /* Make sure we don't consider buttons grabbed after menu goes.
299 And make sure to deactivate for any ButtonRelease,
300 even if XtDispatchEvent doesn't do that. */
301 if (event.type == ButtonRelease
302 && dpyinfo->display == event.xbutton.display)
304 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
305 #ifdef USE_MOTIF /* Pretending that the event came from a
306 Btn1Down seems the only way to convince Motif to
307 activate its callbacks; setting the XmNmenuPost
308 isn't working. --marcus@sysc.pdx.edu. */
309 event.xbutton.button = 1;
310 /* Motif only pops down menus when no Ctrl, Alt or Mod
311 key is pressed and the button is released. So reset key state
312 so Motif thinks this is the case. */
313 event.xbutton.state = 0;
314 #endif
316 /* Pop down on C-g and Escape. */
317 else if (event.type == KeyPress
318 && dpyinfo->display == event.xbutton.display)
320 KeySym keysym = XLookupKeysym (&event.xkey, 0);
322 if ((keysym == XK_g && (event.xkey.state & ControlMask) != 0)
323 || keysym == XK_Escape) /* Any escape, ignore modifiers. */
324 popup_activated_flag = 0;
327 x_dispatch_event (&event, event.xany.display);
331 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
332 doc: /* Start key navigation of the menu bar in FRAME.
333 This initially opens the first menu bar item and you can then navigate with the
334 arrow keys, select a menu entry with the return key or cancel with the
335 escape key. If FRAME has no menu bar this function does nothing.
337 If FRAME is nil or not given, use the selected frame. */)
338 (Lisp_Object frame)
340 XEvent ev;
341 struct frame *f = decode_window_system_frame (frame);
342 Widget menubar;
343 block_input ();
345 if (FRAME_EXTERNAL_MENU_BAR (f))
346 set_frame_menubar (f, 0, 1);
348 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
349 if (menubar)
351 Window child;
352 bool error_p = 0;
354 x_catch_errors (FRAME_X_DISPLAY (f));
355 memset (&ev, 0, sizeof ev);
356 ev.xbutton.display = FRAME_X_DISPLAY (f);
357 ev.xbutton.window = XtWindow (menubar);
358 ev.xbutton.root = FRAME_DISPLAY_INFO (f)->root_window;
359 ev.xbutton.time = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
360 ev.xbutton.button = Button1;
361 ev.xbutton.x = ev.xbutton.y = FRAME_MENUBAR_HEIGHT (f) / 2;
362 ev.xbutton.same_screen = True;
364 #ifdef USE_MOTIF
366 Arg al[2];
367 WidgetList list;
368 Cardinal nr;
369 XtSetArg (al[0], XtNchildren, &list);
370 XtSetArg (al[1], XtNnumChildren, &nr);
371 XtGetValues (menubar, al, 2);
372 ev.xbutton.window = XtWindow (list[0]);
374 #endif
376 XTranslateCoordinates (FRAME_X_DISPLAY (f),
377 /* From-window, to-window. */
378 ev.xbutton.window, ev.xbutton.root,
380 /* From-position, to-position. */
381 ev.xbutton.x, ev.xbutton.y,
382 &ev.xbutton.x_root, &ev.xbutton.y_root,
384 /* Child of win. */
385 &child);
386 error_p = x_had_errors_p (FRAME_X_DISPLAY (f));
387 x_uncatch_errors ();
389 if (! error_p)
391 ev.type = ButtonPress;
392 ev.xbutton.state = 0;
394 XtDispatchEvent (&ev);
395 ev.xbutton.type = ButtonRelease;
396 ev.xbutton.state = Button1Mask;
397 XtDispatchEvent (&ev);
401 unblock_input ();
403 return Qnil;
405 #endif /* USE_X_TOOLKIT */
408 #ifdef USE_GTK
409 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
410 doc: /* Start key navigation of the menu bar in FRAME.
411 This initially opens the first menu bar item and you can then navigate with the
412 arrow keys, select a menu entry with the return key or cancel with the
413 escape key. If FRAME has no menu bar this function does nothing.
415 If FRAME is nil or not given, use the selected frame. */)
416 (Lisp_Object frame)
418 GtkWidget *menubar;
419 struct frame *f;
421 block_input ();
422 f = decode_window_system_frame (frame);
424 if (FRAME_EXTERNAL_MENU_BAR (f))
425 set_frame_menubar (f, 0, 1);
427 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
428 if (menubar)
430 /* Activate the first menu. */
431 GList *children = gtk_container_get_children (GTK_CONTAINER (menubar));
433 if (children)
435 g_signal_emit_by_name (children->data, "activate_item");
436 popup_activated_flag = 1;
437 g_list_free (children);
440 unblock_input ();
442 return Qnil;
445 /* Loop util popup_activated_flag is set to zero in a callback.
446 Used for popup menus and dialogs. */
448 static void
449 popup_widget_loop (int do_timers, GtkWidget *widget)
451 ++popup_activated_flag;
453 /* Process events in the Gtk event loop until done. */
454 while (popup_activated_flag)
456 if (do_timers) x_menu_wait_for_event (0);
457 gtk_main_iteration ();
460 #endif
462 /* Activate the menu bar of frame F.
463 This is called from keyboard.c when it gets the
464 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
466 To activate the menu bar, we use the X button-press event
467 that was saved in saved_menu_event.
468 That makes the toolkit do its thing.
470 But first we recompute the menu bar contents (the whole tree).
472 The reason for saving the button event until here, instead of
473 passing it to the toolkit right away, is that we can safely
474 execute Lisp code. */
476 void
477 x_activate_menubar (struct frame *f)
479 eassert (FRAME_X_P (f));
481 if (!f->output_data.x->saved_menu_event->type)
482 return;
484 #ifdef USE_GTK
485 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
486 f->output_data.x->saved_menu_event->xany.window))
487 return;
488 #endif
490 set_frame_menubar (f, 0, 1);
491 block_input ();
492 popup_activated_flag = 1;
493 #ifdef USE_GTK
494 XPutBackEvent (f->output_data.x->display_info->display,
495 f->output_data.x->saved_menu_event);
496 #else
497 XtDispatchEvent (f->output_data.x->saved_menu_event);
498 #endif
499 unblock_input ();
501 /* Ignore this if we get it a second time. */
502 f->output_data.x->saved_menu_event->type = 0;
505 /* This callback is invoked when the user selects a menubar cascade
506 pushbutton, but before the pulldown menu is posted. */
508 #ifndef USE_GTK
509 static void
510 popup_activate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
512 popup_activated_flag = 1;
513 x_activate_timeout_atimer ();
515 #endif
517 /* This callback is invoked when a dialog or menu is finished being
518 used and has been unposted. */
520 static void
521 popup_deactivate_callback (
522 #ifdef USE_GTK
523 GtkWidget *widget, gpointer client_data
524 #else
525 Widget widget, LWLIB_ID id, XtPointer client_data
526 #endif
529 popup_activated_flag = 0;
533 /* Function that finds the frame for WIDGET and shows the HELP text
534 for that widget.
535 F is the frame if known, or NULL if not known. */
536 static void
537 show_help_event (struct frame *f, xt_or_gtk_widget widget, Lisp_Object help)
539 Lisp_Object frame;
541 if (f)
543 XSETFRAME (frame, f);
544 kbd_buffer_store_help_event (frame, help);
546 else
548 #if 0 /* This code doesn't do anything useful. ++kfs */
549 /* WIDGET is the popup menu. It's parent is the frame's
550 widget. See which frame that is. */
551 xt_or_gtk_widget frame_widget = XtParent (widget);
552 Lisp_Object tail;
554 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
556 frame = XCAR (tail);
557 if (FRAMEP (frame)
558 && (f = XFRAME (frame),
559 FRAME_X_P (f) && f->output_data.x->widget == frame_widget))
560 break;
562 #endif
563 show_help_echo (help, Qnil, Qnil, Qnil);
567 /* Callback called when menu items are highlighted/unhighlighted
568 while moving the mouse over them. WIDGET is the menu bar or menu
569 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
570 the data structure for the menu item, or null in case of
571 unhighlighting. */
573 #ifdef USE_GTK
574 static void
575 menu_highlight_callback (GtkWidget *widget, gpointer call_data)
577 xg_menu_item_cb_data *cb_data;
578 Lisp_Object help;
580 cb_data = g_object_get_data (G_OBJECT (widget), XG_ITEM_DATA);
581 if (! cb_data) return;
583 help = call_data ? cb_data->help : Qnil;
585 /* If popup_activated_flag is greater than 1 we are in a popup menu.
586 Don't pass the frame to show_help_event for those.
587 Passing frame creates an Emacs event. As we are looping in
588 popup_widget_loop, it won't be handled. Passing NULL shows the tip
589 directly without using an Emacs event. This is what the Lucid code
590 does below. */
591 show_help_event (popup_activated_flag <= 1 ? cb_data->cl_data->f : NULL,
592 widget, help);
594 #else
595 static void
596 menu_highlight_callback (Widget widget, LWLIB_ID id, void *call_data)
598 widget_value *wv = call_data;
599 Lisp_Object help = wv ? wv->help : Qnil;
601 /* Determine the frame for the help event. */
602 struct frame *f = menubar_id_to_frame (id);
604 show_help_event (f, widget, help);
606 #endif
608 #ifdef USE_GTK
609 /* Gtk calls callbacks just because we tell it what item should be
610 selected in a radio group. If this variable is set to a non-zero
611 value, we are creating menus and don't want callbacks right now.
613 static int xg_crazy_callback_abort;
615 /* This callback is called from the menu bar pulldown menu
616 when the user makes a selection.
617 Figure out what the user chose
618 and put the appropriate events into the keyboard buffer. */
619 static void
620 menubar_selection_callback (GtkWidget *widget, gpointer client_data)
622 xg_menu_item_cb_data *cb_data = client_data;
624 if (xg_crazy_callback_abort)
625 return;
627 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
628 return;
630 /* For a group of radio buttons, GTK calls the selection callback first
631 for the item that was active before the selection and then for the one that
632 is active after the selection. For C-h k this means we get the help on
633 the deselected item and then the selected item is executed. Prevent that
634 by ignoring the non-active item. */
635 if (GTK_IS_RADIO_MENU_ITEM (widget)
636 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)))
637 return;
639 /* When a menu is popped down, X generates a focus event (i.e. focus
640 goes back to the frame below the menu). Since GTK buffers events,
641 we force it out here before the menu selection event. Otherwise
642 sit-for will exit at once if the focus event follows the menu selection
643 event. */
645 block_input ();
646 while (gtk_events_pending ())
647 gtk_main_iteration ();
648 unblock_input ();
650 find_and_call_menu_selection (cb_data->cl_data->f,
651 cb_data->cl_data->menu_bar_items_used,
652 cb_data->cl_data->menu_bar_vector,
653 cb_data->call_data);
656 #else /* not USE_GTK */
658 /* This callback is called from the menu bar pulldown menu
659 when the user makes a selection.
660 Figure out what the user chose
661 and put the appropriate events into the keyboard buffer. */
662 static void
663 menubar_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
665 struct frame *f;
667 f = menubar_id_to_frame (id);
668 if (!f)
669 return;
670 find_and_call_menu_selection (f, f->menu_bar_items_used,
671 f->menu_bar_vector, client_data);
673 #endif /* not USE_GTK */
675 /* Recompute all the widgets of frame F, when the menu bar has been
676 changed. */
678 static void
679 update_frame_menubar (struct frame *f)
681 #ifdef USE_GTK
682 xg_update_frame_menubar (f);
683 #else
684 struct x_output *x;
685 int columns, rows;
687 eassert (FRAME_X_P (f));
689 x = f->output_data.x;
691 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
692 return;
694 block_input ();
695 /* Save the size of the frame because the pane widget doesn't accept
696 to resize itself. So force it. */
697 columns = FRAME_COLS (f);
698 rows = FRAME_LINES (f);
700 /* Do the voodoo which means "I'm changing lots of things, don't try
701 to refigure sizes until I'm done." */
702 lw_refigure_widget (x->column_widget, False);
704 /* The order in which children are managed is the top to bottom
705 order in which they are displayed in the paned window. First,
706 remove the text-area widget. */
707 XtUnmanageChild (x->edit_widget);
709 /* Remove the menubar that is there now, and put up the menubar that
710 should be there. */
711 XtManageChild (x->menubar_widget);
712 XtMapWidget (x->menubar_widget);
713 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
715 /* Re-manage the text-area widget, and then thrash the sizes. */
716 XtManageChild (x->edit_widget);
717 lw_refigure_widget (x->column_widget, True);
719 /* Force the pane widget to resize itself with the right values. */
720 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
721 unblock_input ();
722 #endif
725 #ifdef USE_LUCID
726 static void
727 apply_systemfont_to_dialog (Widget w)
729 const char *fn = xsettings_get_system_normal_font ();
730 if (fn)
732 XrmDatabase db = XtDatabase (XtDisplay (w));
733 if (db)
734 XrmPutStringResource (&db, "*dialog.font", fn);
738 static void
739 apply_systemfont_to_menu (struct frame *f, Widget w)
741 const char *fn = xsettings_get_system_normal_font ();
743 if (fn)
745 XrmDatabase db = XtDatabase (XtDisplay (w));
746 if (db)
748 XrmPutStringResource (&db, "*menubar*font", fn);
749 XrmPutStringResource (&db, "*popup*font", fn);
754 #endif
756 /* Set the contents of the menubar widgets of frame F.
757 The argument FIRST_TIME is currently ignored;
758 it is set the first time this is called, from initialize_frame_menubar. */
760 void
761 set_frame_menubar (struct frame *f, bool first_time, bool deep_p)
763 xt_or_gtk_widget menubar_widget;
764 #ifdef USE_X_TOOLKIT
765 LWLIB_ID id;
766 #endif
767 Lisp_Object items;
768 widget_value *wv, *first_wv, *prev_wv = 0;
769 int i;
770 int *submenu_start, *submenu_end;
771 bool *submenu_top_level_items;
772 int *submenu_n_panes;
774 eassert (FRAME_X_P (f));
776 menubar_widget = f->output_data.x->menubar_widget;
778 XSETFRAME (Vmenu_updating_frame, f);
780 #ifdef USE_X_TOOLKIT
781 if (f->output_data.x->id == 0)
782 f->output_data.x->id = next_menubar_widget_id++;
783 id = f->output_data.x->id;
784 #endif
786 if (! menubar_widget)
787 deep_p = 1;
788 /* Make the first call for any given frame always go deep. */
789 else if (!f->output_data.x->saved_menu_event && !deep_p)
791 deep_p = 1;
792 f->output_data.x->saved_menu_event = xmalloc (sizeof (XEvent));
793 f->output_data.x->saved_menu_event->type = 0;
796 #ifdef USE_GTK
797 /* If we have detached menus, we must update deep so detached menus
798 also gets updated. */
799 deep_p = deep_p || xg_have_tear_offs ();
800 #endif
802 if (deep_p)
804 /* Make a widget-value tree representing the entire menu trees. */
806 struct buffer *prev = current_buffer;
807 Lisp_Object buffer;
808 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
809 int previous_menu_items_used = f->menu_bar_items_used;
810 Lisp_Object *previous_items
811 = alloca (previous_menu_items_used * sizeof *previous_items);
812 int subitems;
814 /* If we are making a new widget, its contents are empty,
815 do always reinitialize them. */
816 if (! menubar_widget)
817 previous_menu_items_used = 0;
819 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->contents;
820 specbind (Qinhibit_quit, Qt);
821 /* Don't let the debugger step into this code
822 because it is not reentrant. */
823 specbind (Qdebug_on_next_call, Qnil);
825 record_unwind_save_match_data ();
826 if (NILP (Voverriding_local_map_menu_flag))
828 specbind (Qoverriding_terminal_local_map, Qnil);
829 specbind (Qoverriding_local_map, Qnil);
832 set_buffer_internal_1 (XBUFFER (buffer));
834 /* Run the Lucid hook. */
835 safe_run_hooks (Qactivate_menubar_hook);
837 /* If it has changed current-menubar from previous value,
838 really recompute the menubar from the value. */
839 if (! NILP (Vlucid_menu_bar_dirty_flag))
840 call0 (Qrecompute_lucid_menubar);
841 safe_run_hooks (Qmenu_bar_update_hook);
842 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
844 items = FRAME_MENU_BAR_ITEMS (f);
846 /* Save the frame's previous menu bar contents data. */
847 if (previous_menu_items_used)
848 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
849 previous_menu_items_used * word_size);
851 /* Fill in menu_items with the current menu bar contents.
852 This can evaluate Lisp code. */
853 save_menu_items ();
855 menu_items = f->menu_bar_vector;
856 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
857 subitems = ASIZE (items) / 4;
858 submenu_start = alloca ((subitems + 1) * sizeof *submenu_start);
859 submenu_end = alloca (subitems * sizeof *submenu_end);
860 submenu_n_panes = alloca (subitems * sizeof *submenu_n_panes);
861 submenu_top_level_items = alloca (subitems
862 * sizeof *submenu_top_level_items);
863 init_menu_items ();
864 for (i = 0; i < subitems; i++)
866 Lisp_Object key, string, maps;
868 key = AREF (items, 4 * i);
869 string = AREF (items, 4 * i + 1);
870 maps = AREF (items, 4 * i + 2);
871 if (NILP (string))
872 break;
874 submenu_start[i] = menu_items_used;
876 menu_items_n_panes = 0;
877 submenu_top_level_items[i]
878 = parse_single_submenu (key, string, maps);
879 submenu_n_panes[i] = menu_items_n_panes;
881 submenu_end[i] = menu_items_used;
884 submenu_start[i] = -1;
885 finish_menu_items ();
887 /* Convert menu_items into widget_value trees
888 to display the menu. This cannot evaluate Lisp code. */
890 wv = xmalloc_widget_value ();
891 wv->name = "menubar";
892 wv->value = 0;
893 wv->enabled = 1;
894 wv->button_type = BUTTON_TYPE_NONE;
895 wv->help = Qnil;
896 first_wv = wv;
898 for (i = 0; submenu_start[i] >= 0; i++)
900 menu_items_n_panes = submenu_n_panes[i];
901 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
902 submenu_top_level_items[i]);
903 if (prev_wv)
904 prev_wv->next = wv;
905 else
906 first_wv->contents = wv;
907 /* Don't set wv->name here; GC during the loop might relocate it. */
908 wv->enabled = 1;
909 wv->button_type = BUTTON_TYPE_NONE;
910 prev_wv = wv;
913 set_buffer_internal_1 (prev);
915 /* If there has been no change in the Lisp-level contents
916 of the menu bar, skip redisplaying it. Just exit. */
918 /* Compare the new menu items with the ones computed last time. */
919 for (i = 0; i < previous_menu_items_used; i++)
920 if (menu_items_used == i
921 || (!EQ (previous_items[i], AREF (menu_items, i))))
922 break;
923 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
925 /* The menu items have not changed. Don't bother updating
926 the menus in any form, since it would be a no-op. */
927 free_menubar_widget_value_tree (first_wv);
928 discard_menu_items ();
929 unbind_to (specpdl_count, Qnil);
930 return;
933 /* The menu items are different, so store them in the frame. */
934 fset_menu_bar_vector (f, menu_items);
935 f->menu_bar_items_used = menu_items_used;
937 /* This undoes save_menu_items. */
938 unbind_to (specpdl_count, Qnil);
940 /* Now GC cannot happen during the lifetime of the widget_value,
941 so it's safe to store data from a Lisp_String. */
942 wv = first_wv->contents;
943 for (i = 0; i < ASIZE (items); i += 4)
945 Lisp_Object string;
946 string = AREF (items, i + 1);
947 if (NILP (string))
948 break;
949 wv->name = SSDATA (string);
950 update_submenu_strings (wv->contents);
951 wv = wv->next;
955 else
957 /* Make a widget-value tree containing
958 just the top level menu bar strings. */
960 wv = xmalloc_widget_value ();
961 wv->name = "menubar";
962 wv->value = 0;
963 wv->enabled = 1;
964 wv->button_type = BUTTON_TYPE_NONE;
965 wv->help = Qnil;
966 first_wv = wv;
968 items = FRAME_MENU_BAR_ITEMS (f);
969 for (i = 0; i < ASIZE (items); i += 4)
971 Lisp_Object string;
973 string = AREF (items, i + 1);
974 if (NILP (string))
975 break;
977 wv = xmalloc_widget_value ();
978 wv->name = SSDATA (string);
979 wv->value = 0;
980 wv->enabled = 1;
981 wv->button_type = BUTTON_TYPE_NONE;
982 wv->help = Qnil;
983 /* This prevents lwlib from assuming this
984 menu item is really supposed to be empty. */
985 /* The intptr_t cast avoids a warning.
986 This value just has to be different from small integers. */
987 wv->call_data = (void *) (intptr_t) (-1);
989 if (prev_wv)
990 prev_wv->next = wv;
991 else
992 first_wv->contents = wv;
993 prev_wv = wv;
996 /* Forget what we thought we knew about what is in the
997 detailed contents of the menu bar menus.
998 Changing the top level always destroys the contents. */
999 f->menu_bar_items_used = 0;
1002 /* Create or update the menu bar widget. */
1004 block_input ();
1006 #ifdef USE_GTK
1007 xg_crazy_callback_abort = 1;
1008 if (menubar_widget)
1010 /* The fourth arg is DEEP_P, which says to consider the entire
1011 menu trees we supply, rather than just the menu bar item names. */
1012 xg_modify_menubar_widgets (menubar_widget,
1014 first_wv,
1015 deep_p,
1016 G_CALLBACK (menubar_selection_callback),
1017 G_CALLBACK (popup_deactivate_callback),
1018 G_CALLBACK (menu_highlight_callback));
1020 else
1022 menubar_widget
1023 = xg_create_widget ("menubar", "menubar", f, first_wv,
1024 G_CALLBACK (menubar_selection_callback),
1025 G_CALLBACK (popup_deactivate_callback),
1026 G_CALLBACK (menu_highlight_callback));
1028 f->output_data.x->menubar_widget = menubar_widget;
1032 #else /* not USE_GTK */
1033 if (menubar_widget)
1035 /* Disable resizing (done for Motif!) */
1036 lw_allow_resizing (f->output_data.x->widget, False);
1038 /* The third arg is DEEP_P, which says to consider the entire
1039 menu trees we supply, rather than just the menu bar item names. */
1040 lw_modify_all_widgets (id, first_wv, deep_p);
1042 /* Re-enable the edit widget to resize. */
1043 lw_allow_resizing (f->output_data.x->widget, True);
1045 else
1047 char menuOverride[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
1048 XtTranslations override = XtParseTranslationTable (menuOverride);
1050 #ifdef USE_LUCID
1051 apply_systemfont_to_menu (f, f->output_data.x->column_widget);
1052 #endif
1053 menubar_widget = lw_create_widget ("menubar", "menubar", id,
1054 first_wv,
1055 f->output_data.x->column_widget,
1057 popup_activate_callback,
1058 menubar_selection_callback,
1059 popup_deactivate_callback,
1060 menu_highlight_callback);
1061 f->output_data.x->menubar_widget = menubar_widget;
1063 /* Make menu pop down on C-g. */
1064 XtOverrideTranslations (menubar_widget, override);
1068 int menubar_size;
1069 if (f->output_data.x->menubar_widget)
1070 XtRealizeWidget (f->output_data.x->menubar_widget);
1072 menubar_size
1073 = (f->output_data.x->menubar_widget
1074 ? (f->output_data.x->menubar_widget->core.height
1075 + f->output_data.x->menubar_widget->core.border_width)
1076 : 0);
1078 #if 1 /* Experimentally, we now get the right results
1079 for -geometry -0-0 without this. 24 Aug 96, rms.
1080 Maybe so, but the menu bar size is missing the pixels so the
1081 WM size hints are off by these pixels. Jan D, oct 2009. */
1082 #ifdef USE_LUCID
1083 if (FRAME_EXTERNAL_MENU_BAR (f))
1085 Dimension ibw = 0;
1086 XtVaGetValues (f->output_data.x->column_widget,
1087 XtNinternalBorderWidth, &ibw, NULL);
1088 menubar_size += ibw;
1090 #endif /* USE_LUCID */
1091 #endif /* 1 */
1093 f->output_data.x->menubar_height = menubar_size;
1095 #endif /* not USE_GTK */
1097 free_menubar_widget_value_tree (first_wv);
1098 update_frame_menubar (f);
1100 #ifdef USE_GTK
1101 xg_crazy_callback_abort = 0;
1102 #endif
1104 unblock_input ();
1107 /* Called from Fx_create_frame to create the initial menubar of a frame
1108 before it is mapped, so that the window is mapped with the menubar already
1109 there instead of us tacking it on later and thrashing the window after it
1110 is visible. */
1112 void
1113 initialize_frame_menubar (struct frame *f)
1115 /* This function is called before the first chance to redisplay
1116 the frame. It has to be, so the frame will have the right size. */
1117 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
1118 set_frame_menubar (f, 1, 1);
1122 /* Get rid of the menu bar of frame F, and free its storage.
1123 This is used when deleting a frame, and when turning off the menu bar.
1124 For GTK this function is in gtkutil.c. */
1126 #ifndef USE_GTK
1127 void
1128 free_frame_menubar (struct frame *f)
1130 Widget menubar_widget;
1132 eassert (FRAME_X_P (f));
1134 menubar_widget = f->output_data.x->menubar_widget;
1136 f->output_data.x->menubar_height = 0;
1138 if (menubar_widget)
1140 #ifdef USE_MOTIF
1141 /* Removing the menu bar magically changes the shell widget's x
1142 and y position of (0, 0) which, when the menu bar is turned
1143 on again, leads to pull-down menus appearing in strange
1144 positions near the upper-left corner of the display. This
1145 happens only with some window managers like twm and ctwm,
1146 but not with other like Motif's mwm or kwm, because the
1147 latter generate ConfigureNotify events when the menu bar
1148 is switched off, which fixes the shell position. */
1149 Position x0, y0, x1, y1;
1150 #endif
1152 block_input ();
1154 #ifdef USE_MOTIF
1155 if (f->output_data.x->widget)
1156 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
1157 #endif
1159 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1160 f->output_data.x->menubar_widget = NULL;
1162 if (f->output_data.x->widget)
1164 #ifdef USE_MOTIF
1165 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
1166 if (x1 == 0 && y1 == 0)
1167 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
1168 #endif
1169 x_set_window_size (f, 0, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f), 1);
1171 unblock_input ();
1174 #endif /* not USE_GTK */
1176 #endif /* USE_X_TOOLKIT || USE_GTK */
1178 /* xmenu_show actually displays a menu using the panes and items in menu_items
1179 and returns the value selected from it.
1180 There are two versions of xmenu_show, one for Xt and one for Xlib.
1181 Both assume input is blocked by the caller. */
1183 /* F is the frame the menu is for.
1184 X and Y are the frame-relative specified position,
1185 relative to the inside upper left corner of the frame F.
1186 FOR_CLICK is true if this menu was invoked for a mouse click.
1187 KEYMAPS is true if this menu was specified with keymaps;
1188 in that case, we return a list containing the chosen item's value
1189 and perhaps also the pane's prefix.
1190 TITLE is the specified menu title.
1191 ERROR is a place to store an error message string in case of failure.
1192 (We return nil on failure, but the value doesn't actually matter.) */
1194 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1196 /* The item selected in the popup menu. */
1197 static Lisp_Object *volatile menu_item_selection;
1199 #ifdef USE_GTK
1201 /* Used when position a popup menu. See menu_position_func and
1202 create_and_show_popup_menu below. */
1203 struct next_popup_x_y
1205 struct frame *f;
1206 int x;
1207 int y;
1210 /* The menu position function to use if we are not putting a popup
1211 menu where the pointer is.
1212 MENU is the menu to pop up.
1213 X and Y shall on exit contain x/y where the menu shall pop up.
1214 PUSH_IN is not documented in the GTK manual.
1215 USER_DATA is any data passed in when calling gtk_menu_popup.
1216 Here it points to a struct next_popup_x_y where the coordinates
1217 to store in *X and *Y are as well as the frame for the popup.
1219 Here only X and Y are used. */
1220 static void
1221 menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
1223 struct next_popup_x_y *data = user_data;
1224 GtkRequisition req;
1225 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (data->f);
1226 int disp_width = x_display_pixel_width (dpyinfo);
1227 int disp_height = x_display_pixel_height (dpyinfo);
1229 *x = data->x;
1230 *y = data->y;
1232 /* Check if there is room for the menu. If not, adjust x/y so that
1233 the menu is fully visible. */
1234 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1235 if (data->x + req.width > disp_width)
1236 *x -= data->x + req.width - disp_width;
1237 if (data->y + req.height > disp_height)
1238 *y -= data->y + req.height - disp_height;
1241 static void
1242 popup_selection_callback (GtkWidget *widget, gpointer client_data)
1244 xg_menu_item_cb_data *cb_data = client_data;
1246 if (xg_crazy_callback_abort) return;
1247 if (cb_data) menu_item_selection = cb_data->call_data;
1250 static void
1251 pop_down_menu (void *arg)
1253 popup_activated_flag = 0;
1254 block_input ();
1255 gtk_widget_destroy (GTK_WIDGET (arg));
1256 unblock_input ();
1259 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1260 menu pops down.
1261 menu_item_selection will be set to the selection. */
1262 static void
1263 create_and_show_popup_menu (struct frame *f, widget_value *first_wv,
1264 int x, int y, bool for_click)
1266 int i;
1267 GtkWidget *menu;
1268 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
1269 struct next_popup_x_y popup_x_y;
1270 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1271 bool use_pos_func = ! for_click;
1273 #ifdef HAVE_GTK3
1274 /* Always use position function for Gtk3. Otherwise menus may become
1275 too small to show anything. */
1276 use_pos_func = 1;
1277 #endif
1279 eassert (FRAME_X_P (f));
1281 xg_crazy_callback_abort = 1;
1282 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
1283 G_CALLBACK (popup_selection_callback),
1284 G_CALLBACK (popup_deactivate_callback),
1285 G_CALLBACK (menu_highlight_callback));
1286 xg_crazy_callback_abort = 0;
1288 if (use_pos_func)
1290 /* Not invoked by a click. pop up at x/y. */
1291 pos_func = menu_position_func;
1293 /* Adjust coordinates to be root-window-relative. */
1294 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1295 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1297 popup_x_y.x = x;
1298 popup_x_y.y = y;
1299 popup_x_y.f = f;
1301 i = 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
1304 if (for_click)
1306 for (i = 0; i < 5; i++)
1307 if (FRAME_DISPLAY_INFO (f)->grabbed & (1 << i))
1308 break;
1311 /* Display the menu. */
1312 gtk_widget_show_all (menu);
1314 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i,
1315 FRAME_DISPLAY_INFO (f)->last_user_time);
1317 record_unwind_protect_ptr (pop_down_menu, menu);
1319 if (gtk_widget_get_mapped (menu))
1321 /* Set this to one. popup_widget_loop increases it by one, so it becomes
1322 two. show_help_echo uses this to detect popup menus. */
1323 popup_activated_flag = 1;
1324 /* Process events that apply to the menu. */
1325 popup_widget_loop (1, menu);
1328 unbind_to (specpdl_count, Qnil);
1330 /* Must reset this manually because the button release event is not passed
1331 to Emacs event loop. */
1332 FRAME_DISPLAY_INFO (f)->grabbed = 0;
1335 #else /* not USE_GTK */
1337 /* We need a unique id for each widget handled by the Lucid Widget
1338 library.
1340 For the main windows, and popup menus, we use this counter,
1341 which we increment each time after use. This starts from 1<<16.
1343 For menu bars, we use numbers starting at 0, counted in
1344 next_menubar_widget_id. */
1345 LWLIB_ID widget_id_tick;
1347 static void
1348 popup_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1350 menu_item_selection = client_data;
1353 /* ARG is the LWLIB ID of the dialog box, represented
1354 as a Lisp object as (HIGHPART . LOWPART). */
1356 static void
1357 pop_down_menu (Lisp_Object arg)
1359 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
1360 | XINT (XCDR (arg)));
1362 block_input ();
1363 lw_destroy_all_widgets (id);
1364 unblock_input ();
1365 popup_activated_flag = 0;
1368 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1369 menu pops down.
1370 menu_item_selection will be set to the selection. */
1371 static void
1372 create_and_show_popup_menu (struct frame *f, widget_value *first_wv,
1373 int x, int y, bool for_click)
1375 int i;
1376 Arg av[2];
1377 int ac = 0;
1378 XEvent dummy;
1379 XButtonPressedEvent *event = &(dummy.xbutton);
1380 LWLIB_ID menu_id;
1381 Widget menu;
1383 eassert (FRAME_X_P (f));
1385 #ifdef USE_LUCID
1386 apply_systemfont_to_menu (f, f->output_data.x->widget);
1387 #endif
1389 menu_id = widget_id_tick++;
1390 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
1391 f->output_data.x->widget, 1, 0,
1392 popup_selection_callback,
1393 popup_deactivate_callback,
1394 menu_highlight_callback);
1396 event->type = ButtonPress;
1397 event->serial = 0;
1398 event->send_event = 0;
1399 event->display = FRAME_X_DISPLAY (f);
1400 event->time = CurrentTime;
1401 event->root = FRAME_DISPLAY_INFO (f)->root_window;
1402 event->window = event->subwindow = event->root;
1403 event->x = x;
1404 event->y = y;
1406 /* Adjust coordinates to be root-window-relative. */
1407 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1408 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1410 event->x_root = x;
1411 event->y_root = y;
1413 event->state = 0;
1414 event->button = 0;
1415 for (i = 0; i < 5; i++)
1416 if (FRAME_DISPLAY_INFO (f)->grabbed & (1 << i))
1417 event->button = i;
1419 /* Don't allow any geometry request from the user. */
1420 XtSetArg (av[ac], XtNgeometry, 0); ac++;
1421 XtSetValues (menu, av, ac);
1423 /* Display the menu. */
1424 lw_popup_menu (menu, &dummy);
1425 popup_activated_flag = 1;
1426 x_activate_timeout_atimer ();
1429 int fact = 4 * sizeof (LWLIB_ID);
1430 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1431 record_unwind_protect (pop_down_menu,
1432 Fcons (make_number (menu_id >> (fact)),
1433 make_number (menu_id & ~(-1 << (fact)))));
1435 /* Process events that apply to the menu. */
1436 popup_get_selection (0, FRAME_DISPLAY_INFO (f), menu_id, 1);
1438 unbind_to (specpdl_count, Qnil);
1442 #endif /* not USE_GTK */
1444 static void
1445 cleanup_widget_value_tree (void *arg)
1447 free_menubar_widget_value_tree (arg);
1450 Lisp_Object
1451 xmenu_show (struct frame *f, int x, int y, bool for_click, bool keymaps,
1452 Lisp_Object title, const char **error_name)
1454 int i;
1455 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1456 widget_value **submenu_stack
1457 = alloca (menu_items_used * sizeof *submenu_stack);
1458 Lisp_Object *subprefix_stack
1459 = alloca (menu_items_used * sizeof *subprefix_stack);
1460 int submenu_depth = 0;
1462 int first_pane;
1464 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1466 eassert (FRAME_X_P (f));
1468 *error_name = NULL;
1470 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1472 *error_name = "Empty menu";
1473 return Qnil;
1476 block_input ();
1478 /* Create a tree of widget_value objects
1479 representing the panes and their items. */
1480 wv = xmalloc_widget_value ();
1481 wv->name = "menu";
1482 wv->value = 0;
1483 wv->enabled = 1;
1484 wv->button_type = BUTTON_TYPE_NONE;
1485 wv->help =Qnil;
1486 first_wv = wv;
1487 first_pane = 1;
1489 /* Loop over all panes and items, filling in the tree. */
1490 i = 0;
1491 while (i < menu_items_used)
1493 if (EQ (AREF (menu_items, i), Qnil))
1495 submenu_stack[submenu_depth++] = save_wv;
1496 save_wv = prev_wv;
1497 prev_wv = 0;
1498 first_pane = 1;
1499 i++;
1501 else if (EQ (AREF (menu_items, i), Qlambda))
1503 prev_wv = save_wv;
1504 save_wv = submenu_stack[--submenu_depth];
1505 first_pane = 0;
1506 i++;
1508 else if (EQ (AREF (menu_items, i), Qt)
1509 && submenu_depth != 0)
1510 i += MENU_ITEMS_PANE_LENGTH;
1511 /* Ignore a nil in the item list.
1512 It's meaningful only for dialog boxes. */
1513 else if (EQ (AREF (menu_items, i), Qquote))
1514 i += 1;
1515 else if (EQ (AREF (menu_items, i), Qt))
1517 /* Create a new pane. */
1518 Lisp_Object pane_name, prefix;
1519 const char *pane_string;
1521 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1522 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1524 #ifndef HAVE_MULTILINGUAL_MENU
1525 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1527 pane_name = ENCODE_MENU_STRING (pane_name);
1528 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1530 #endif
1531 pane_string = (NILP (pane_name)
1532 ? "" : SSDATA (pane_name));
1533 /* If there is just one top-level pane, put all its items directly
1534 under the top-level menu. */
1535 if (menu_items_n_panes == 1)
1536 pane_string = "";
1538 /* If the pane has a meaningful name,
1539 make the pane a top-level menu item
1540 with its items as a submenu beneath it. */
1541 if (!keymaps && strcmp (pane_string, ""))
1543 wv = xmalloc_widget_value ();
1544 if (save_wv)
1545 save_wv->next = wv;
1546 else
1547 first_wv->contents = wv;
1548 wv->name = (char *) pane_string;
1549 if (keymaps && !NILP (prefix))
1550 wv->name++;
1551 wv->value = 0;
1552 wv->enabled = 1;
1553 wv->button_type = BUTTON_TYPE_NONE;
1554 wv->help = Qnil;
1555 save_wv = wv;
1556 prev_wv = 0;
1558 else if (first_pane)
1560 save_wv = wv;
1561 prev_wv = 0;
1563 first_pane = 0;
1564 i += MENU_ITEMS_PANE_LENGTH;
1566 else
1568 /* Create a new item within current pane. */
1569 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1570 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1571 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1572 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1573 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1574 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1575 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1576 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1578 #ifndef HAVE_MULTILINGUAL_MENU
1579 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
1581 item_name = ENCODE_MENU_STRING (item_name);
1582 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1585 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1587 descrip = ENCODE_MENU_STRING (descrip);
1588 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1590 #endif /* not HAVE_MULTILINGUAL_MENU */
1592 wv = xmalloc_widget_value ();
1593 if (prev_wv)
1594 prev_wv->next = wv;
1595 else
1596 save_wv->contents = wv;
1597 wv->name = SSDATA (item_name);
1598 if (!NILP (descrip))
1599 wv->key = SSDATA (descrip);
1600 wv->value = 0;
1601 /* If this item has a null value,
1602 make the call_data null so that it won't display a box
1603 when the mouse is on it. */
1604 wv->call_data = !NILP (def) ? aref_addr (menu_items, i) : 0;
1605 wv->enabled = !NILP (enable);
1607 if (NILP (type))
1608 wv->button_type = BUTTON_TYPE_NONE;
1609 else if (EQ (type, QCtoggle))
1610 wv->button_type = BUTTON_TYPE_TOGGLE;
1611 else if (EQ (type, QCradio))
1612 wv->button_type = BUTTON_TYPE_RADIO;
1613 else
1614 emacs_abort ();
1616 wv->selected = !NILP (selected);
1618 if (! STRINGP (help))
1619 help = Qnil;
1621 wv->help = help;
1623 prev_wv = wv;
1625 i += MENU_ITEMS_ITEM_LENGTH;
1629 /* Deal with the title, if it is non-nil. */
1630 if (!NILP (title))
1632 widget_value *wv_title = xmalloc_widget_value ();
1633 widget_value *wv_sep1 = xmalloc_widget_value ();
1634 widget_value *wv_sep2 = xmalloc_widget_value ();
1636 wv_sep2->name = "--";
1637 wv_sep2->next = first_wv->contents;
1638 wv_sep2->help = Qnil;
1640 wv_sep1->name = "--";
1641 wv_sep1->next = wv_sep2;
1642 wv_sep1->help = Qnil;
1644 #ifndef HAVE_MULTILINGUAL_MENU
1645 if (STRING_MULTIBYTE (title))
1646 title = ENCODE_MENU_STRING (title);
1647 #endif
1649 wv_title->name = SSDATA (title);
1650 wv_title->enabled = true;
1651 wv_title->button_type = BUTTON_TYPE_NONE;
1652 wv_title->help = Qnil;
1653 wv_title->next = wv_sep1;
1654 first_wv->contents = wv_title;
1657 /* No selection has been chosen yet. */
1658 menu_item_selection = 0;
1660 /* Make sure to free the widget_value objects we used to specify the
1661 contents even with longjmp. */
1662 record_unwind_protect_ptr (cleanup_widget_value_tree, first_wv);
1664 /* Actually create and show the menu until popped down. */
1665 create_and_show_popup_menu (f, first_wv, x, y, for_click);
1667 unbind_to (specpdl_count, Qnil);
1669 /* Find the selected item, and its pane, to return
1670 the proper value. */
1671 if (menu_item_selection != 0)
1673 Lisp_Object prefix, entry;
1675 prefix = entry = Qnil;
1676 i = 0;
1677 while (i < menu_items_used)
1679 if (EQ (AREF (menu_items, i), Qnil))
1681 subprefix_stack[submenu_depth++] = prefix;
1682 prefix = entry;
1683 i++;
1685 else if (EQ (AREF (menu_items, i), Qlambda))
1687 prefix = subprefix_stack[--submenu_depth];
1688 i++;
1690 else if (EQ (AREF (menu_items, i), Qt))
1692 prefix
1693 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1694 i += MENU_ITEMS_PANE_LENGTH;
1696 /* Ignore a nil in the item list.
1697 It's meaningful only for dialog boxes. */
1698 else if (EQ (AREF (menu_items, i), Qquote))
1699 i += 1;
1700 else
1702 entry
1703 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1704 if (menu_item_selection == aref_addr (menu_items, i))
1706 if (keymaps)
1708 int j;
1710 entry = list1 (entry);
1711 if (!NILP (prefix))
1712 entry = Fcons (prefix, entry);
1713 for (j = submenu_depth - 1; j >= 0; j--)
1714 if (!NILP (subprefix_stack[j]))
1715 entry = Fcons (subprefix_stack[j], entry);
1717 unblock_input ();
1718 return entry;
1720 i += MENU_ITEMS_ITEM_LENGTH;
1724 else if (!for_click)
1726 unblock_input ();
1727 /* Make "Cancel" equivalent to C-g. */
1728 Fsignal (Qquit, Qnil);
1731 unblock_input ();
1732 return Qnil;
1735 #ifdef USE_GTK
1736 static void
1737 dialog_selection_callback (GtkWidget *widget, gpointer client_data)
1739 /* Treat the pointer as an integer. There's no problem
1740 as long as pointers have enough bits to hold small integers. */
1741 if ((intptr_t) client_data != -1)
1742 menu_item_selection = client_data;
1744 popup_activated_flag = 0;
1747 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1748 dialog pops down.
1749 menu_item_selection will be set to the selection. */
1750 static void
1751 create_and_show_dialog (struct frame *f, widget_value *first_wv)
1753 GtkWidget *menu;
1755 eassert (FRAME_X_P (f));
1757 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
1758 G_CALLBACK (dialog_selection_callback),
1759 G_CALLBACK (popup_deactivate_callback),
1762 if (menu)
1764 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1765 record_unwind_protect_ptr (pop_down_menu, menu);
1767 /* Display the menu. */
1768 gtk_widget_show_all (menu);
1770 /* Process events that apply to the menu. */
1771 popup_widget_loop (1, menu);
1773 unbind_to (specpdl_count, Qnil);
1777 #else /* not USE_GTK */
1778 static void
1779 dialog_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1781 /* Treat the pointer as an integer. There's no problem
1782 as long as pointers have enough bits to hold small integers. */
1783 if ((intptr_t) client_data != -1)
1784 menu_item_selection = client_data;
1786 block_input ();
1787 lw_destroy_all_widgets (id);
1788 unblock_input ();
1789 popup_activated_flag = 0;
1793 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1794 dialog pops down.
1795 menu_item_selection will be set to the selection. */
1796 static void
1797 create_and_show_dialog (struct frame *f, widget_value *first_wv)
1799 LWLIB_ID dialog_id;
1801 eassert (FRAME_X_P (f));
1803 dialog_id = widget_id_tick++;
1804 #ifdef USE_LUCID
1805 apply_systemfont_to_dialog (f->output_data.x->widget);
1806 #endif
1807 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
1808 f->output_data.x->widget, 1, 0,
1809 dialog_selection_callback, 0, 0);
1810 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
1811 /* Display the dialog box. */
1812 lw_pop_up_all_widgets (dialog_id);
1813 popup_activated_flag = 1;
1814 x_activate_timeout_atimer ();
1816 /* Process events that apply to the dialog box.
1817 Also handle timers. */
1819 ptrdiff_t count = SPECPDL_INDEX ();
1820 int fact = 4 * sizeof (LWLIB_ID);
1822 /* xdialog_show_unwind is responsible for popping the dialog box down. */
1823 record_unwind_protect (pop_down_menu,
1824 Fcons (make_number (dialog_id >> (fact)),
1825 make_number (dialog_id & ~(-1 << (fact)))));
1827 popup_get_selection (0, FRAME_DISPLAY_INFO (f), dialog_id, 1);
1829 unbind_to (count, Qnil);
1833 #endif /* not USE_GTK */
1835 static const char * button_names [] = {
1836 "button1", "button2", "button3", "button4", "button5",
1837 "button6", "button7", "button8", "button9", "button10" };
1839 static Lisp_Object
1840 xdialog_show (struct frame *f,
1841 bool keymaps,
1842 Lisp_Object title,
1843 Lisp_Object header,
1844 const char **error_name)
1846 int i, nb_buttons=0;
1847 char dialog_name[6];
1849 widget_value *wv, *first_wv = 0, *prev_wv = 0;
1851 /* Number of elements seen so far, before boundary. */
1852 int left_count = 0;
1853 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
1854 int boundary_seen = 0;
1856 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1858 eassert (FRAME_X_P (f));
1860 *error_name = NULL;
1862 if (menu_items_n_panes > 1)
1864 *error_name = "Multiple panes in dialog box";
1865 return Qnil;
1868 /* Create a tree of widget_value objects
1869 representing the text label and buttons. */
1871 Lisp_Object pane_name, prefix;
1872 const char *pane_string;
1873 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
1874 prefix = AREF (menu_items, MENU_ITEMS_PANE_PREFIX);
1875 pane_string = (NILP (pane_name)
1876 ? "" : SSDATA (pane_name));
1877 prev_wv = xmalloc_widget_value ();
1878 prev_wv->value = (char *) pane_string;
1879 if (keymaps && !NILP (prefix))
1880 prev_wv->name++;
1881 prev_wv->enabled = 1;
1882 prev_wv->name = "message";
1883 prev_wv->help = Qnil;
1884 first_wv = prev_wv;
1886 /* Loop over all panes and items, filling in the tree. */
1887 i = MENU_ITEMS_PANE_LENGTH;
1888 while (i < menu_items_used)
1891 /* Create a new item within current pane. */
1892 Lisp_Object item_name, enable, descrip;
1893 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1894 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1895 descrip
1896 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1898 if (NILP (item_name))
1900 free_menubar_widget_value_tree (first_wv);
1901 *error_name = "Submenu in dialog items";
1902 return Qnil;
1904 if (EQ (item_name, Qquote))
1906 /* This is the boundary between left-side elts
1907 and right-side elts. Stop incrementing right_count. */
1908 boundary_seen = 1;
1909 i++;
1910 continue;
1912 if (nb_buttons >= 9)
1914 free_menubar_widget_value_tree (first_wv);
1915 *error_name = "Too many dialog items";
1916 return Qnil;
1919 wv = xmalloc_widget_value ();
1920 prev_wv->next = wv;
1921 wv->name = (char *) button_names[nb_buttons];
1922 if (!NILP (descrip))
1923 wv->key = SSDATA (descrip);
1924 wv->value = SSDATA (item_name);
1925 wv->call_data = aref_addr (menu_items, i);
1926 wv->enabled = !NILP (enable);
1927 wv->help = Qnil;
1928 prev_wv = wv;
1930 if (! boundary_seen)
1931 left_count++;
1933 nb_buttons++;
1934 i += MENU_ITEMS_ITEM_LENGTH;
1937 /* If the boundary was not specified,
1938 by default put half on the left and half on the right. */
1939 if (! boundary_seen)
1940 left_count = nb_buttons - nb_buttons / 2;
1942 wv = xmalloc_widget_value ();
1943 wv->name = dialog_name;
1944 wv->help = Qnil;
1946 /* Frame title: 'Q' = Question, 'I' = Information.
1947 Can also have 'E' = Error if, one day, we want
1948 a popup for errors. */
1949 if (NILP (header))
1950 dialog_name[0] = 'Q';
1951 else
1952 dialog_name[0] = 'I';
1954 /* Dialog boxes use a really stupid name encoding
1955 which specifies how many buttons to use
1956 and how many buttons are on the right. */
1957 dialog_name[1] = '0' + nb_buttons;
1958 dialog_name[2] = 'B';
1959 dialog_name[3] = 'R';
1960 /* Number of buttons to put on the right. */
1961 dialog_name[4] = '0' + nb_buttons - left_count;
1962 dialog_name[5] = 0;
1963 wv->contents = first_wv;
1964 first_wv = wv;
1967 /* No selection has been chosen yet. */
1968 menu_item_selection = 0;
1970 /* Make sure to free the widget_value objects we used to specify the
1971 contents even with longjmp. */
1972 record_unwind_protect_ptr (cleanup_widget_value_tree, first_wv);
1974 /* Actually create and show the dialog. */
1975 create_and_show_dialog (f, first_wv);
1977 unbind_to (specpdl_count, Qnil);
1979 /* Find the selected item, and its pane, to return
1980 the proper value. */
1981 if (menu_item_selection != 0)
1983 Lisp_Object prefix;
1985 prefix = Qnil;
1986 i = 0;
1987 while (i < menu_items_used)
1989 Lisp_Object entry;
1991 if (EQ (AREF (menu_items, i), Qt))
1993 prefix
1994 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1995 i += MENU_ITEMS_PANE_LENGTH;
1997 else if (EQ (AREF (menu_items, i), Qquote))
1999 /* This is the boundary between left-side elts and
2000 right-side elts. */
2001 ++i;
2003 else
2005 entry
2006 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2007 if (menu_item_selection == aref_addr (menu_items, i))
2009 if (keymaps != 0)
2011 entry = list1 (entry);
2012 if (!NILP (prefix))
2013 entry = Fcons (prefix, entry);
2015 return entry;
2017 i += MENU_ITEMS_ITEM_LENGTH;
2021 else
2022 /* Make "Cancel" equivalent to C-g. */
2023 Fsignal (Qquit, Qnil);
2025 return Qnil;
2028 Lisp_Object
2029 xw_popup_dialog (struct frame *f, Lisp_Object header, Lisp_Object contents)
2031 Lisp_Object title;
2032 const char *error_name;
2033 Lisp_Object selection;
2034 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2036 check_window_system (f);
2038 /* Decode the dialog items from what was specified. */
2039 title = Fcar (contents);
2040 CHECK_STRING (title);
2041 record_unwind_protect_void (unuse_menu_items);
2043 if (NILP (Fcar (Fcdr (contents))))
2044 /* No buttons specified, add an "Ok" button so users can pop down
2045 the dialog. Also, the lesstif/motif version crashes if there are
2046 no buttons. */
2047 contents = list2 (title, Fcons (build_string ("Ok"), Qt));
2049 list_of_panes (list1 (contents));
2051 /* Display them in a dialog box. */
2052 block_input ();
2053 selection = xdialog_show (f, 0, title, header, &error_name);
2054 unblock_input ();
2056 unbind_to (specpdl_count, Qnil);
2057 discard_menu_items ();
2059 if (error_name) error ("%s", error_name);
2060 return selection;
2063 #else /* not USE_X_TOOLKIT && not USE_GTK */
2065 /* The frame of the last activated non-toolkit menu bar.
2066 Used to generate menu help events. */
2068 static struct frame *menu_help_frame;
2071 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
2073 PANE is the pane number, and ITEM is the menu item number in
2074 the menu (currently not used).
2076 This cannot be done with generating a HELP_EVENT because
2077 XMenuActivate contains a loop that doesn't let Emacs process
2078 keyboard events. */
2080 static void
2081 menu_help_callback (char const *help_string, int pane, int item)
2083 Lisp_Object *first_item;
2084 Lisp_Object pane_name;
2085 Lisp_Object menu_object;
2087 first_item = XVECTOR (menu_items)->contents;
2088 if (EQ (first_item[0], Qt))
2089 pane_name = first_item[MENU_ITEMS_PANE_NAME];
2090 else if (EQ (first_item[0], Qquote))
2091 /* This shouldn't happen, see xmenu_show. */
2092 pane_name = empty_unibyte_string;
2093 else
2094 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
2096 /* (menu-item MENU-NAME PANE-NUMBER) */
2097 menu_object = list3 (Qmenu_item, pane_name, make_number (pane));
2098 show_help_echo (help_string ? build_string (help_string) : Qnil,
2099 Qnil, menu_object, make_number (item));
2102 static void
2103 pop_down_menu (Lisp_Object arg)
2105 struct frame *f = XSAVE_POINTER (arg, 0);
2106 XMenu *menu = XSAVE_POINTER (arg, 1);
2108 block_input ();
2109 #ifndef MSDOS
2110 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
2111 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
2112 #endif
2113 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2115 #ifdef HAVE_X_WINDOWS
2116 /* Assume the mouse has moved out of the X window.
2117 If it has actually moved in, we will get an EnterNotify. */
2118 x_mouse_leave (FRAME_DISPLAY_INFO (f));
2120 /* State that no mouse buttons are now held.
2121 (The oldXMenu code doesn't track this info for us.)
2122 That is not necessarily true, but the fiction leads to reasonable
2123 results, and it is a pain to ask which are actually held now. */
2124 FRAME_DISPLAY_INFO (f)->grabbed = 0;
2126 #endif /* HAVE_X_WINDOWS */
2128 unblock_input ();
2132 Lisp_Object
2133 xmenu_show (struct frame *f, int x, int y, bool for_click, bool keymaps,
2134 Lisp_Object title, const char **error_name)
2136 Window root;
2137 XMenu *menu;
2138 int pane, selidx, lpane, status;
2139 Lisp_Object entry, pane_prefix;
2140 char *datap;
2141 int ulx, uly, width, height;
2142 int dispwidth, dispheight;
2143 int i, j, lines, maxlines;
2144 int maxwidth;
2145 int dummy_int;
2146 unsigned int dummy_uint;
2147 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2149 eassert (FRAME_X_P (f) || FRAME_MSDOS_P (f));
2151 *error_name = 0;
2152 if (menu_items_n_panes == 0)
2153 return Qnil;
2155 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2157 *error_name = "Empty menu";
2158 return Qnil;
2161 block_input ();
2163 /* Figure out which root window F is on. */
2164 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2165 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2166 &dummy_uint, &dummy_uint);
2168 /* Make the menu on that window. */
2169 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2170 if (menu == NULL)
2172 *error_name = "Can't create menu";
2173 unblock_input ();
2174 return Qnil;
2177 /* Don't GC while we prepare and show the menu,
2178 because we give the oldxmenu library pointers to the
2179 contents of strings. */
2180 inhibit_garbage_collection ();
2182 #ifdef HAVE_X_WINDOWS
2183 /* Adjust coordinates to relative to the outer (window manager) window. */
2184 x += FRAME_OUTER_TO_INNER_DIFF_X (f);
2185 y += FRAME_OUTER_TO_INNER_DIFF_Y (f);
2186 #endif /* HAVE_X_WINDOWS */
2188 /* Adjust coordinates to be root-window-relative. */
2189 x += f->left_pos;
2190 y += f->top_pos;
2192 /* Create all the necessary panes and their items. */
2193 maxwidth = maxlines = lines = i = 0;
2194 lpane = XM_FAILURE;
2195 while (i < menu_items_used)
2197 if (EQ (AREF (menu_items, i), Qt))
2199 /* Create a new pane. */
2200 Lisp_Object pane_name, prefix;
2201 const char *pane_string;
2203 maxlines = max (maxlines, lines);
2204 lines = 0;
2205 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
2206 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2207 pane_string = (NILP (pane_name)
2208 ? "" : SSDATA (pane_name));
2209 if (keymaps && !NILP (prefix))
2210 pane_string++;
2212 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2213 if (lpane == XM_FAILURE)
2215 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2216 *error_name = "Can't create pane";
2217 unblock_input ();
2218 return Qnil;
2220 i += MENU_ITEMS_PANE_LENGTH;
2222 /* Find the width of the widest item in this pane. */
2223 j = i;
2224 while (j < menu_items_used)
2226 Lisp_Object item;
2227 item = AREF (menu_items, j);
2228 if (EQ (item, Qt))
2229 break;
2230 if (NILP (item))
2232 j++;
2233 continue;
2235 width = SBYTES (item);
2236 if (width > maxwidth)
2237 maxwidth = width;
2239 j += MENU_ITEMS_ITEM_LENGTH;
2242 /* Ignore a nil in the item list.
2243 It's meaningful only for dialog boxes. */
2244 else if (EQ (AREF (menu_items, i), Qquote))
2245 i += 1;
2246 else
2248 /* Create a new item within current pane. */
2249 Lisp_Object item_name, enable, descrip, help;
2250 char *item_data;
2251 char const *help_string;
2253 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2254 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2255 descrip
2256 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2257 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
2258 help_string = STRINGP (help) ? SSDATA (help) : NULL;
2260 if (!NILP (descrip))
2262 /* if alloca is fast, use that to make the space,
2263 to reduce gc needs. */
2264 item_data = alloca (maxwidth + SBYTES (descrip) + 1);
2265 memcpy (item_data, SSDATA (item_name), SBYTES (item_name));
2266 for (j = SCHARS (item_name); j < maxwidth; j++)
2267 item_data[j] = ' ';
2268 memcpy (item_data + j, SSDATA (descrip), SBYTES (descrip));
2269 item_data[j + SBYTES (descrip)] = 0;
2271 else
2272 item_data = SSDATA (item_name);
2274 if (lpane == XM_FAILURE
2275 || (XMenuAddSelection (FRAME_X_DISPLAY (f),
2276 menu, lpane, 0, item_data,
2277 !NILP (enable), help_string)
2278 == XM_FAILURE))
2280 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2281 *error_name = "Can't add selection to menu";
2282 unblock_input ();
2283 return Qnil;
2285 i += MENU_ITEMS_ITEM_LENGTH;
2286 lines++;
2290 maxlines = max (maxlines, lines);
2292 /* All set and ready to fly. */
2293 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2294 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2295 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2296 x = min (x, dispwidth);
2297 y = min (y, dispheight);
2298 x = max (x, 1);
2299 y = max (y, 1);
2300 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2301 &ulx, &uly, &width, &height);
2302 if (ulx+width > dispwidth)
2304 x -= (ulx + width) - dispwidth;
2305 ulx = dispwidth - width;
2307 if (uly+height > dispheight)
2309 y -= (uly + height) - dispheight;
2310 uly = dispheight - height;
2312 #ifndef HAVE_X_WINDOWS
2313 if (FRAME_HAS_MINIBUF_P (f) && uly+height > dispheight - 1)
2315 /* Move the menu away of the echo area, to avoid overwriting the
2316 menu with help echo messages or vice versa. */
2317 if (BUFFERP (echo_area_buffer[0]) && WINDOWP (echo_area_window))
2319 y -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2320 uly -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2322 else
2324 y--;
2325 uly--;
2328 #endif
2329 if (ulx < 0) x -= ulx;
2330 if (uly < 0) y -= uly;
2332 if (! for_click)
2334 /* If position was not given by a mouse click, adjust so upper left
2335 corner of the menu as a whole ends up at given coordinates. This
2336 is what x-popup-menu says in its documentation. */
2337 x += width/2;
2338 y += 1.5*height/(maxlines+2);
2341 XMenuSetAEQ (menu, TRUE);
2342 XMenuSetFreeze (menu, TRUE);
2343 pane = selidx = 0;
2345 #ifndef MSDOS
2346 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
2347 #endif
2349 record_unwind_protect (pop_down_menu, make_save_ptr_ptr (f, menu));
2351 /* Help display under X won't work because XMenuActivate contains
2352 a loop that doesn't give Emacs a chance to process it. */
2353 menu_help_frame = f;
2354 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2355 x, y, ButtonReleaseMask, &datap,
2356 menu_help_callback);
2357 entry = pane_prefix = Qnil;
2359 switch (status)
2361 case XM_SUCCESS:
2362 #ifdef XDEBUG
2363 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2364 #endif
2366 /* Find the item number SELIDX in pane number PANE. */
2367 i = 0;
2368 while (i < menu_items_used)
2370 if (EQ (AREF (menu_items, i), Qt))
2372 if (pane == 0)
2373 pane_prefix
2374 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2375 pane--;
2376 i += MENU_ITEMS_PANE_LENGTH;
2378 else
2380 if (pane == -1)
2382 if (selidx == 0)
2384 entry
2385 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2386 if (keymaps)
2388 entry = list1 (entry);
2389 if (!NILP (pane_prefix))
2390 entry = Fcons (pane_prefix, entry);
2392 break;
2394 selidx--;
2396 i += MENU_ITEMS_ITEM_LENGTH;
2399 break;
2401 case XM_FAILURE:
2402 *error_name = "Can't activate menu";
2403 case XM_IA_SELECT:
2404 break;
2405 case XM_NO_SELECT:
2406 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
2407 the menu was invoked with a mouse event as POSITION). */
2408 if (! for_click)
2410 unblock_input ();
2411 Fsignal (Qquit, Qnil);
2413 break;
2416 unblock_input ();
2417 unbind_to (specpdl_count, Qnil);
2419 return entry;
2422 #endif /* not USE_X_TOOLKIT */
2424 #ifndef MSDOS
2425 /* Detect if a dialog or menu has been posted. MSDOS has its own
2426 implementation on msdos.c. */
2428 int ATTRIBUTE_CONST
2429 popup_activated (void)
2431 return popup_activated_flag;
2433 #endif /* not MSDOS */
2435 /* The following is used by delayed window autoselection. */
2437 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
2438 doc: /* Return t if a menu or popup dialog is active. */)
2439 (void)
2441 return (popup_activated ()) ? Qt : Qnil;
2444 void
2445 syms_of_xmenu (void)
2447 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
2449 #ifdef USE_X_TOOLKIT
2450 widget_id_tick = (1<<16);
2451 next_menubar_widget_id = 1;
2452 #endif
2454 defsubr (&Smenu_or_popup_active_p);
2456 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
2457 defsubr (&Sx_menu_bar_open_internal);
2458 Ffset (intern_c_string ("accelerate-menu"),
2459 intern_c_string (Sx_menu_bar_open_internal.symbol_name));
2460 #endif