Merge from emacs-24; up to 2013-01-02T16:37:04Z!eggert@cs.ucla.edu
[bpt/emacs.git] / src / xmenu.c
1 /* X Communication module for terminals which understand the X protocol.
2
3 Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2013 Free Software
4 Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
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.
12
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.
17
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/>. */
20
21 /* X pop-up deck-of-cards menu facility for GNU Emacs.
22 *
23 * Written by Jon Arnold and Roman Budzianowski
24 * Mods and rewrite by Robert Krawitz
25 *
26 */
27
28 /* Modified by Fred Pierresteguy on December 93
29 to make the popup menus and menubar use the Xt. */
30
31 /* Rewritten for clarity and GC protection by rms in Feb 94. */
32
33 #include <config.h>
34
35 #include <stdio.h>
36
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"
49
50 #ifdef MSDOS
51 #include "msdos.h"
52 #endif
53
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
59
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
65
66 #include "dispextern.h"
67
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 */
97
98 #ifdef USE_GTK
99 #include "gtkutil.h"
100 #ifdef HAVE_GTK3
101 #include "xgselect.h"
102 #endif
103 #endif
104
105 #include "menu.h"
106
107 #ifndef TRUE
108 #define TRUE 1
109 #endif /* no TRUE */
110
111 static Lisp_Object Qdebug_on_next_call;
112
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
117 \f
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;
121
122 \f
123 #ifdef USE_X_TOOLKIT
124
125 static int next_menubar_widget_id;
126
127 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
128
129 static struct frame *
130 menubar_id_to_frame (LWLIB_ID id)
131 {
132 Lisp_Object tail, frame;
133 struct frame *f;
134
135 FOR_EACH_FRAME (tail, frame)
136 {
137 f = XFRAME (frame);
138 if (!FRAME_WINDOW_P (f))
139 continue;
140 if (f->output_data.x->id == id)
141 return f;
142 }
143 return 0;
144 }
145
146 #endif
147 \f
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)
158 {
159 Window root, dummy_window;
160 int dummy;
161
162 eassert (FRAME_X_P (f));
163
164 block_input ();
165
166 XQueryPointer (FRAME_X_DISPLAY (f),
167 DefaultRootWindow (FRAME_X_DISPLAY (f)),
168
169 /* The root window which contains the pointer. */
170 &root,
171
172 /* Window pointer is on, not used */
173 &dummy_window,
174
175 /* The position on that root window. */
176 x, y,
177
178 /* x/y in dummy_window coordinates, not used. */
179 &dummy, &dummy,
180
181 /* Modifier keys and pointer buttons, about which
182 we don't care. */
183 (unsigned int *) &dummy);
184
185 unblock_input ();
186
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);
191 }
192
193 #endif /* HAVE_X_WINDOWS */
194
195 #ifdef HAVE_MENUS
196
197 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
198 doc: /* Pop up a dialog box and return user's selection.
199 POSITION specifies which frame to use.
200 This is normally a mouse button event or a window or frame.
201 If POSITION is t, it means to use the frame the mouse is on.
202 The dialog box appears in the middle of the specified frame.
203
204 CONTENTS specifies the alternatives to display in the dialog box.
205 It is a list of the form (DIALOG ITEM1 ITEM2...).
206 Each ITEM is a cons cell (STRING . VALUE).
207 The return value is VALUE from the chosen item.
208
209 An ITEM may also be just a string--that makes a nonselectable item.
210 An ITEM may also be nil--that means to put all preceding items
211 on the left of the dialog box and all following items on the right.
212 \(By default, approximately half appear on each side.)
213
214 If HEADER is non-nil, the frame title for the box is "Information",
215 otherwise it is "Question".
216
217 If the user gets rid of the dialog box without making a valid choice,
218 for instance using the window manager, then this produces a quit and
219 `x-popup-dialog' does not return. */)
220 (Lisp_Object position, Lisp_Object contents, Lisp_Object header)
221 {
222 struct frame *f = NULL;
223 Lisp_Object window;
224
225 /* Decode the first argument: find the window or frame to use. */
226 if (EQ (position, Qt)
227 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
228 || EQ (XCAR (position), Qtool_bar))))
229 {
230 #if 0 /* Using the frame the mouse is on may not be right. */
231 /* Use the mouse's current position. */
232 struct frame *new_f = SELECTED_FRAME ();
233 Lisp_Object bar_window;
234 enum scroll_bar_part part;
235 Time time;
236 Lisp_Object x, y;
237
238 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
239
240 if (new_f != 0)
241 XSETFRAME (window, new_f);
242 else
243 window = selected_window;
244 #endif
245 window = selected_window;
246 }
247 else if (CONSP (position))
248 {
249 Lisp_Object tem = XCAR (position);
250 if (CONSP (tem))
251 window = Fcar (XCDR (position));
252 else
253 {
254 tem = Fcar (XCDR (position)); /* EVENT_START (position) */
255 window = Fcar (tem); /* POSN_WINDOW (tem) */
256 }
257 }
258 else if (WINDOWP (position) || FRAMEP (position))
259 window = position;
260 else
261 window = Qnil;
262
263 /* Decode where to put the menu. */
264
265 if (FRAMEP (window))
266 f = XFRAME (window);
267 else if (WINDOWP (window))
268 {
269 CHECK_LIVE_WINDOW (window);
270 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
271 }
272 else
273 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
274 but I don't want to make one now. */
275 CHECK_WINDOW (window);
276
277 check_window_system (f);
278
279 /* Force a redisplay before showing the dialog. If a frame is created
280 just before showing the dialog, its contents may not have been fully
281 drawn, as this depends on timing of events from the X server. Redisplay
282 is not done when a dialog is shown. If redisplay could be done in the
283 X event loop (i.e. the X event loop does not run in a signal handler)
284 this would not be needed.
285
286 Do this before creating the widget value that points to Lisp
287 string contents, because Fredisplay may GC and relocate them. */
288 Fredisplay (Qt);
289
290 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
291 /* Display a menu with these alternatives
292 in the middle of frame F. */
293 {
294 Lisp_Object x, y, frame, newpos;
295 XSETFRAME (frame, f);
296 XSETINT (x, FRAME_PIXEL_WIDTH (f) / 2);
297 XSETINT (y, FRAME_PIXEL_HEIGHT (f) / 2);
298 newpos = list2 (list2 (x, y), frame);
299
300 return Fx_popup_menu (newpos,
301 list2 (Fcar (contents), contents));
302 }
303 #else
304 {
305 Lisp_Object title;
306 const char *error_name;
307 Lisp_Object selection;
308 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
309
310 /* Decode the dialog items from what was specified. */
311 title = Fcar (contents);
312 CHECK_STRING (title);
313 record_unwind_protect_void (unuse_menu_items);
314
315 if (NILP (Fcar (Fcdr (contents))))
316 /* No buttons specified, add an "Ok" button so users can pop down
317 the dialog. Also, the lesstif/motif version crashes if there are
318 no buttons. */
319 contents = list2 (title, Fcons (build_string ("Ok"), Qt));
320
321 list_of_panes (list1 (contents));
322
323 /* Display them in a dialog box. */
324 block_input ();
325 selection = xdialog_show (f, 0, title, header, &error_name);
326 unblock_input ();
327
328 unbind_to (specpdl_count, Qnil);
329 discard_menu_items ();
330
331 if (error_name) error ("%s", error_name);
332 return selection;
333 }
334 #endif
335 }
336
337
338 #ifndef MSDOS
339
340 #if defined USE_GTK || defined USE_MOTIF
341
342 /* Set menu_items_inuse so no other popup menu or dialog is created. */
343
344 void
345 x_menu_set_in_use (int in_use)
346 {
347 menu_items_inuse = in_use ? Qt : Qnil;
348 popup_activated_flag = in_use;
349 #ifdef USE_X_TOOLKIT
350 if (popup_activated_flag)
351 x_activate_timeout_atimer ();
352 #endif
353 }
354
355 #endif
356
357 /* Wait for an X event to arrive or for a timer to expire. */
358
359 #ifndef USE_MOTIF
360 static
361 #endif
362 void
363 x_menu_wait_for_event (void *data)
364 {
365 /* Another way to do this is to register a timer callback, that can be
366 done in GTK and Xt. But we have to do it like this when using only X
367 anyway, and with callbacks we would have three variants for timer handling
368 instead of the small ifdefs below. */
369
370 while (
371 #ifdef USE_X_TOOLKIT
372 ! XtAppPending (Xt_app_con)
373 #elif defined USE_GTK
374 ! gtk_events_pending ()
375 #else
376 ! XPending (data)
377 #endif
378 )
379 {
380 EMACS_TIME next_time = timer_check (), *ntp;
381 SELECT_TYPE read_fds;
382 struct x_display_info *dpyinfo;
383 int n = 0;
384
385 FD_ZERO (&read_fds);
386 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
387 {
388 int fd = ConnectionNumber (dpyinfo->display);
389 FD_SET (fd, &read_fds);
390 if (fd > n) n = fd;
391 XFlush (dpyinfo->display);
392 }
393
394 if (! EMACS_TIME_VALID_P (next_time))
395 ntp = 0;
396 else
397 ntp = &next_time;
398
399 #if defined USE_GTK && defined HAVE_GTK3
400 /* Gtk3 have arrows on menus when they don't fit. When the
401 pointer is over an arrow, a timeout scrolls it a bit. Use
402 xg_select so that timeout gets triggered. */
403 xg_select (n + 1, &read_fds, NULL, NULL, ntp, NULL);
404 #else
405 pselect (n + 1, &read_fds, NULL, NULL, ntp, NULL);
406 #endif
407 }
408 }
409 #endif /* ! MSDOS */
410
411 \f
412 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
413
414 #ifdef USE_X_TOOLKIT
415
416 /* Loop in Xt until the menu pulldown or dialog popup has been
417 popped down (deactivated). This is used for x-popup-menu
418 and x-popup-dialog; it is not used for the menu bar.
419
420 NOTE: All calls to popup_get_selection should be protected
421 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
422
423 static void
424 popup_get_selection (XEvent *initial_event, struct x_display_info *dpyinfo, LWLIB_ID id, int do_timers)
425 {
426 XEvent event;
427
428 while (popup_activated_flag)
429 {
430 if (initial_event)
431 {
432 event = *initial_event;
433 initial_event = 0;
434 }
435 else
436 {
437 if (do_timers) x_menu_wait_for_event (0);
438 XtAppNextEvent (Xt_app_con, &event);
439 }
440
441 /* Make sure we don't consider buttons grabbed after menu goes.
442 And make sure to deactivate for any ButtonRelease,
443 even if XtDispatchEvent doesn't do that. */
444 if (event.type == ButtonRelease
445 && dpyinfo->display == event.xbutton.display)
446 {
447 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
448 #ifdef USE_MOTIF /* Pretending that the event came from a
449 Btn1Down seems the only way to convince Motif to
450 activate its callbacks; setting the XmNmenuPost
451 isn't working. --marcus@sysc.pdx.edu. */
452 event.xbutton.button = 1;
453 /* Motif only pops down menus when no Ctrl, Alt or Mod
454 key is pressed and the button is released. So reset key state
455 so Motif thinks this is the case. */
456 event.xbutton.state = 0;
457 #endif
458 }
459 /* Pop down on C-g and Escape. */
460 else if (event.type == KeyPress
461 && dpyinfo->display == event.xbutton.display)
462 {
463 KeySym keysym = XLookupKeysym (&event.xkey, 0);
464
465 if ((keysym == XK_g && (event.xkey.state & ControlMask) != 0)
466 || keysym == XK_Escape) /* Any escape, ignore modifiers. */
467 popup_activated_flag = 0;
468 }
469
470 x_dispatch_event (&event, event.xany.display);
471 }
472 }
473
474 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
475 doc: /* Start key navigation of the menu bar in FRAME.
476 This initially opens the first menu bar item and you can then navigate with the
477 arrow keys, select a menu entry with the return key or cancel with the
478 escape key. If FRAME has no menu bar this function does nothing.
479
480 If FRAME is nil or not given, use the selected frame. */)
481 (Lisp_Object frame)
482 {
483 XEvent ev;
484 struct frame *f = decode_window_system_frame (frame);
485 Widget menubar;
486 block_input ();
487
488 if (FRAME_EXTERNAL_MENU_BAR (f))
489 set_frame_menubar (f, 0, 1);
490
491 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
492 if (menubar)
493 {
494 Window child;
495 bool error_p = 0;
496
497 x_catch_errors (FRAME_X_DISPLAY (f));
498 memset (&ev, 0, sizeof ev);
499 ev.xbutton.display = FRAME_X_DISPLAY (f);
500 ev.xbutton.window = XtWindow (menubar);
501 ev.xbutton.root = FRAME_X_DISPLAY_INFO (f)->root_window;
502 ev.xbutton.time = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
503 ev.xbutton.button = Button1;
504 ev.xbutton.x = ev.xbutton.y = FRAME_MENUBAR_HEIGHT (f) / 2;
505 ev.xbutton.same_screen = True;
506
507 #ifdef USE_MOTIF
508 {
509 Arg al[2];
510 WidgetList list;
511 Cardinal nr;
512 XtSetArg (al[0], XtNchildren, &list);
513 XtSetArg (al[1], XtNnumChildren, &nr);
514 XtGetValues (menubar, al, 2);
515 ev.xbutton.window = XtWindow (list[0]);
516 }
517 #endif
518
519 XTranslateCoordinates (FRAME_X_DISPLAY (f),
520 /* From-window, to-window. */
521 ev.xbutton.window, ev.xbutton.root,
522
523 /* From-position, to-position. */
524 ev.xbutton.x, ev.xbutton.y,
525 &ev.xbutton.x_root, &ev.xbutton.y_root,
526
527 /* Child of win. */
528 &child);
529 error_p = x_had_errors_p (FRAME_X_DISPLAY (f));
530 x_uncatch_errors ();
531
532 if (! error_p)
533 {
534 ev.type = ButtonPress;
535 ev.xbutton.state = 0;
536
537 XtDispatchEvent (&ev);
538 ev.xbutton.type = ButtonRelease;
539 ev.xbutton.state = Button1Mask;
540 XtDispatchEvent (&ev);
541 }
542 }
543
544 unblock_input ();
545
546 return Qnil;
547 }
548 #endif /* USE_X_TOOLKIT */
549
550
551 #ifdef USE_GTK
552 DEFUN ("x-menu-bar-open-internal", Fx_menu_bar_open_internal, Sx_menu_bar_open_internal, 0, 1, "i",
553 doc: /* Start key navigation of the menu bar in FRAME.
554 This initially opens the first menu bar item and you can then navigate with the
555 arrow keys, select a menu entry with the return key or cancel with the
556 escape key. If FRAME has no menu bar this function does nothing.
557
558 If FRAME is nil or not given, use the selected frame. */)
559 (Lisp_Object frame)
560 {
561 GtkWidget *menubar;
562 struct frame *f;
563
564 block_input ();
565 f = decode_window_system_frame (frame);
566
567 if (FRAME_EXTERNAL_MENU_BAR (f))
568 set_frame_menubar (f, 0, 1);
569
570 menubar = FRAME_X_OUTPUT (f)->menubar_widget;
571 if (menubar)
572 {
573 /* Activate the first menu. */
574 GList *children = gtk_container_get_children (GTK_CONTAINER (menubar));
575
576 if (children)
577 {
578 g_signal_emit_by_name (children->data, "activate_item");
579 popup_activated_flag = 1;
580 g_list_free (children);
581 }
582 }
583 unblock_input ();
584
585 return Qnil;
586 }
587
588 /* Loop util popup_activated_flag is set to zero in a callback.
589 Used for popup menus and dialogs. */
590
591 static void
592 popup_widget_loop (int do_timers, GtkWidget *widget)
593 {
594 ++popup_activated_flag;
595
596 /* Process events in the Gtk event loop until done. */
597 while (popup_activated_flag)
598 {
599 if (do_timers) x_menu_wait_for_event (0);
600 gtk_main_iteration ();
601 }
602 }
603 #endif
604
605 /* Activate the menu bar of frame F.
606 This is called from keyboard.c when it gets the
607 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
608
609 To activate the menu bar, we use the X button-press event
610 that was saved in saved_menu_event.
611 That makes the toolkit do its thing.
612
613 But first we recompute the menu bar contents (the whole tree).
614
615 The reason for saving the button event until here, instead of
616 passing it to the toolkit right away, is that we can safely
617 execute Lisp code. */
618
619 void
620 x_activate_menubar (struct frame *f)
621 {
622 eassert (FRAME_X_P (f));
623
624 if (!f->output_data.x->saved_menu_event->type)
625 return;
626
627 #ifdef USE_GTK
628 if (! xg_win_to_widget (FRAME_X_DISPLAY (f),
629 f->output_data.x->saved_menu_event->xany.window))
630 return;
631 #endif
632
633 set_frame_menubar (f, 0, 1);
634 block_input ();
635 popup_activated_flag = 1;
636 #ifdef USE_GTK
637 XPutBackEvent (f->output_data.x->display_info->display,
638 f->output_data.x->saved_menu_event);
639 #else
640 XtDispatchEvent (f->output_data.x->saved_menu_event);
641 #endif
642 unblock_input ();
643
644 /* Ignore this if we get it a second time. */
645 f->output_data.x->saved_menu_event->type = 0;
646 }
647
648 /* This callback is invoked when the user selects a menubar cascade
649 pushbutton, but before the pulldown menu is posted. */
650
651 #ifndef USE_GTK
652 static void
653 popup_activate_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
654 {
655 popup_activated_flag = 1;
656 #ifdef USE_X_TOOLKIT
657 x_activate_timeout_atimer ();
658 #endif
659 }
660 #endif
661
662 /* This callback is invoked when a dialog or menu is finished being
663 used and has been unposted. */
664
665 static void
666 popup_deactivate_callback (
667 #ifdef USE_GTK
668 GtkWidget *widget, gpointer client_data
669 #else
670 Widget widget, LWLIB_ID id, XtPointer client_data
671 #endif
672 )
673 {
674 popup_activated_flag = 0;
675 }
676
677
678 /* Function that finds the frame for WIDGET and shows the HELP text
679 for that widget.
680 F is the frame if known, or NULL if not known. */
681 static void
682 show_help_event (struct frame *f, xt_or_gtk_widget widget, Lisp_Object help)
683 {
684 Lisp_Object frame;
685
686 if (f)
687 {
688 XSETFRAME (frame, f);
689 kbd_buffer_store_help_event (frame, help);
690 }
691 else
692 {
693 #if 0 /* This code doesn't do anything useful. ++kfs */
694 /* WIDGET is the popup menu. It's parent is the frame's
695 widget. See which frame that is. */
696 xt_or_gtk_widget frame_widget = XtParent (widget);
697 Lisp_Object tail;
698
699 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
700 {
701 frame = XCAR (tail);
702 if (FRAMEP (frame)
703 && (f = XFRAME (frame),
704 FRAME_X_P (f) && f->output_data.x->widget == frame_widget))
705 break;
706 }
707 #endif
708 show_help_echo (help, Qnil, Qnil, Qnil);
709 }
710 }
711
712 /* Callback called when menu items are highlighted/unhighlighted
713 while moving the mouse over them. WIDGET is the menu bar or menu
714 popup widget. ID is its LWLIB_ID. CALL_DATA contains a pointer to
715 the data structure for the menu item, or null in case of
716 unhighlighting. */
717
718 #ifdef USE_GTK
719 static void
720 menu_highlight_callback (GtkWidget *widget, gpointer call_data)
721 {
722 xg_menu_item_cb_data *cb_data;
723 Lisp_Object help;
724
725 cb_data = g_object_get_data (G_OBJECT (widget), XG_ITEM_DATA);
726 if (! cb_data) return;
727
728 help = call_data ? cb_data->help : Qnil;
729
730 /* If popup_activated_flag is greater than 1 we are in a popup menu.
731 Don't pass the frame to show_help_event for those.
732 Passing frame creates an Emacs event. As we are looping in
733 popup_widget_loop, it won't be handled. Passing NULL shows the tip
734 directly without using an Emacs event. This is what the Lucid code
735 does below. */
736 show_help_event (popup_activated_flag <= 1 ? cb_data->cl_data->f : NULL,
737 widget, help);
738 }
739 #else
740 static void
741 menu_highlight_callback (Widget widget, LWLIB_ID id, void *call_data)
742 {
743 widget_value *wv = call_data;
744 Lisp_Object help = wv ? wv->help : Qnil;
745
746 /* Determine the frame for the help event. */
747 struct frame *f = menubar_id_to_frame (id);
748
749 show_help_event (f, widget, help);
750 }
751 #endif
752
753 #ifdef USE_GTK
754 /* Gtk calls callbacks just because we tell it what item should be
755 selected in a radio group. If this variable is set to a non-zero
756 value, we are creating menus and don't want callbacks right now.
757 */
758 static int xg_crazy_callback_abort;
759
760 /* This callback is called from the menu bar pulldown menu
761 when the user makes a selection.
762 Figure out what the user chose
763 and put the appropriate events into the keyboard buffer. */
764 static void
765 menubar_selection_callback (GtkWidget *widget, gpointer client_data)
766 {
767 xg_menu_item_cb_data *cb_data = client_data;
768
769 if (xg_crazy_callback_abort)
770 return;
771
772 if (! cb_data || ! cb_data->cl_data || ! cb_data->cl_data->f)
773 return;
774
775 /* For a group of radio buttons, GTK calls the selection callback first
776 for the item that was active before the selection and then for the one that
777 is active after the selection. For C-h k this means we get the help on
778 the deselected item and then the selected item is executed. Prevent that
779 by ignoring the non-active item. */
780 if (GTK_IS_RADIO_MENU_ITEM (widget)
781 && ! gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)))
782 return;
783
784 /* When a menu is popped down, X generates a focus event (i.e. focus
785 goes back to the frame below the menu). Since GTK buffers events,
786 we force it out here before the menu selection event. Otherwise
787 sit-for will exit at once if the focus event follows the menu selection
788 event. */
789
790 block_input ();
791 while (gtk_events_pending ())
792 gtk_main_iteration ();
793 unblock_input ();
794
795 find_and_call_menu_selection (cb_data->cl_data->f,
796 cb_data->cl_data->menu_bar_items_used,
797 cb_data->cl_data->menu_bar_vector,
798 cb_data->call_data);
799 }
800
801 #else /* not USE_GTK */
802
803 /* This callback is called from the menu bar pulldown menu
804 when the user makes a selection.
805 Figure out what the user chose
806 and put the appropriate events into the keyboard buffer. */
807 static void
808 menubar_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
809 {
810 struct frame *f;
811
812 f = menubar_id_to_frame (id);
813 if (!f)
814 return;
815 find_and_call_menu_selection (f, f->menu_bar_items_used,
816 f->menu_bar_vector, client_data);
817 }
818 #endif /* not USE_GTK */
819 \f
820 /* Recompute all the widgets of frame F, when the menu bar has been
821 changed. */
822
823 static void
824 update_frame_menubar (struct frame *f)
825 {
826 #ifdef USE_GTK
827 xg_update_frame_menubar (f);
828 #else
829 struct x_output *x;
830 int columns, rows;
831
832 eassert (FRAME_X_P (f));
833
834 x = f->output_data.x;
835
836 if (!x->menubar_widget || XtIsManaged (x->menubar_widget))
837 return;
838
839 block_input ();
840 /* Save the size of the frame because the pane widget doesn't accept
841 to resize itself. So force it. */
842 columns = FRAME_COLS (f);
843 rows = FRAME_LINES (f);
844
845 /* Do the voodoo which means "I'm changing lots of things, don't try
846 to refigure sizes until I'm done." */
847 lw_refigure_widget (x->column_widget, False);
848
849 /* The order in which children are managed is the top to bottom
850 order in which they are displayed in the paned window. First,
851 remove the text-area widget. */
852 XtUnmanageChild (x->edit_widget);
853
854 /* Remove the menubar that is there now, and put up the menubar that
855 should be there. */
856 XtManageChild (x->menubar_widget);
857 XtMapWidget (x->menubar_widget);
858 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, NULL);
859
860 /* Re-manage the text-area widget, and then thrash the sizes. */
861 XtManageChild (x->edit_widget);
862 lw_refigure_widget (x->column_widget, True);
863
864 /* Force the pane widget to resize itself with the right values. */
865 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
866 unblock_input ();
867 #endif
868 }
869
870 #ifdef USE_LUCID
871 static void
872 apply_systemfont_to_dialog (Widget w)
873 {
874 const char *fn = xsettings_get_system_normal_font ();
875 if (fn)
876 {
877 XrmDatabase db = XtDatabase (XtDisplay (w));
878 if (db)
879 XrmPutStringResource (&db, "*dialog.font", fn);
880 }
881 }
882
883 static void
884 apply_systemfont_to_menu (struct frame *f, Widget w)
885 {
886 const char *fn = xsettings_get_system_normal_font ();
887
888 if (fn)
889 {
890 XrmDatabase db = XtDatabase (XtDisplay (w));
891 if (db)
892 {
893 XrmPutStringResource (&db, "*menubar*font", fn);
894 XrmPutStringResource (&db, "*popup*font", fn);
895 }
896 }
897 }
898
899 #endif
900
901 /* Set the contents of the menubar widgets of frame F.
902 The argument FIRST_TIME is currently ignored;
903 it is set the first time this is called, from initialize_frame_menubar. */
904
905 void
906 set_frame_menubar (struct frame *f, bool first_time, bool deep_p)
907 {
908 xt_or_gtk_widget menubar_widget;
909 #ifdef USE_X_TOOLKIT
910 LWLIB_ID id;
911 #endif
912 Lisp_Object items;
913 widget_value *wv, *first_wv, *prev_wv = 0;
914 int i;
915 int *submenu_start, *submenu_end;
916 bool *submenu_top_level_items;
917 int *submenu_n_panes;
918
919 eassert (FRAME_X_P (f));
920
921 menubar_widget = f->output_data.x->menubar_widget;
922
923 XSETFRAME (Vmenu_updating_frame, f);
924
925 #ifdef USE_X_TOOLKIT
926 if (f->output_data.x->id == 0)
927 f->output_data.x->id = next_menubar_widget_id++;
928 id = f->output_data.x->id;
929 #endif
930
931 if (! menubar_widget)
932 deep_p = 1;
933 /* Make the first call for any given frame always go deep. */
934 else if (!f->output_data.x->saved_menu_event && !deep_p)
935 {
936 deep_p = 1;
937 f->output_data.x->saved_menu_event = xmalloc (sizeof (XEvent));
938 f->output_data.x->saved_menu_event->type = 0;
939 }
940
941 #ifdef USE_GTK
942 /* If we have detached menus, we must update deep so detached menus
943 also gets updated. */
944 deep_p = deep_p || xg_have_tear_offs ();
945 #endif
946
947 if (deep_p)
948 {
949 /* Make a widget-value tree representing the entire menu trees. */
950
951 struct buffer *prev = current_buffer;
952 Lisp_Object buffer;
953 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
954 int previous_menu_items_used = f->menu_bar_items_used;
955 Lisp_Object *previous_items
956 = alloca (previous_menu_items_used * sizeof *previous_items);
957 int subitems;
958
959 /* If we are making a new widget, its contents are empty,
960 do always reinitialize them. */
961 if (! menubar_widget)
962 previous_menu_items_used = 0;
963
964 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->contents;
965 specbind (Qinhibit_quit, Qt);
966 /* Don't let the debugger step into this code
967 because it is not reentrant. */
968 specbind (Qdebug_on_next_call, Qnil);
969
970 record_unwind_save_match_data ();
971 if (NILP (Voverriding_local_map_menu_flag))
972 {
973 specbind (Qoverriding_terminal_local_map, Qnil);
974 specbind (Qoverriding_local_map, Qnil);
975 }
976
977 set_buffer_internal_1 (XBUFFER (buffer));
978
979 /* Run the Lucid hook. */
980 safe_run_hooks (Qactivate_menubar_hook);
981
982 /* If it has changed current-menubar from previous value,
983 really recompute the menubar from the value. */
984 if (! NILP (Vlucid_menu_bar_dirty_flag))
985 call0 (Qrecompute_lucid_menubar);
986 safe_run_hooks (Qmenu_bar_update_hook);
987 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
988
989 items = FRAME_MENU_BAR_ITEMS (f);
990
991 /* Save the frame's previous menu bar contents data. */
992 if (previous_menu_items_used)
993 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
994 previous_menu_items_used * word_size);
995
996 /* Fill in menu_items with the current menu bar contents.
997 This can evaluate Lisp code. */
998 save_menu_items ();
999
1000 menu_items = f->menu_bar_vector;
1001 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
1002 subitems = ASIZE (items) / 4;
1003 submenu_start = alloca ((subitems + 1) * sizeof *submenu_start);
1004 submenu_end = alloca (subitems * sizeof *submenu_end);
1005 submenu_n_panes = alloca (subitems * sizeof *submenu_n_panes);
1006 submenu_top_level_items = alloca (subitems
1007 * sizeof *submenu_top_level_items);
1008 init_menu_items ();
1009 for (i = 0; i < subitems; i++)
1010 {
1011 Lisp_Object key, string, maps;
1012
1013 key = AREF (items, 4 * i);
1014 string = AREF (items, 4 * i + 1);
1015 maps = AREF (items, 4 * i + 2);
1016 if (NILP (string))
1017 break;
1018
1019 submenu_start[i] = menu_items_used;
1020
1021 menu_items_n_panes = 0;
1022 submenu_top_level_items[i]
1023 = parse_single_submenu (key, string, maps);
1024 submenu_n_panes[i] = menu_items_n_panes;
1025
1026 submenu_end[i] = menu_items_used;
1027 }
1028
1029 submenu_start[i] = -1;
1030 finish_menu_items ();
1031
1032 /* Convert menu_items into widget_value trees
1033 to display the menu. This cannot evaluate Lisp code. */
1034
1035 wv = xmalloc_widget_value ();
1036 wv->name = "menubar";
1037 wv->value = 0;
1038 wv->enabled = 1;
1039 wv->button_type = BUTTON_TYPE_NONE;
1040 wv->help = Qnil;
1041 first_wv = wv;
1042
1043 for (i = 0; submenu_start[i] >= 0; i++)
1044 {
1045 menu_items_n_panes = submenu_n_panes[i];
1046 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
1047 submenu_top_level_items[i]);
1048 if (prev_wv)
1049 prev_wv->next = wv;
1050 else
1051 first_wv->contents = wv;
1052 /* Don't set wv->name here; GC during the loop might relocate it. */
1053 wv->enabled = 1;
1054 wv->button_type = BUTTON_TYPE_NONE;
1055 prev_wv = wv;
1056 }
1057
1058 set_buffer_internal_1 (prev);
1059
1060 /* If there has been no change in the Lisp-level contents
1061 of the menu bar, skip redisplaying it. Just exit. */
1062
1063 /* Compare the new menu items with the ones computed last time. */
1064 for (i = 0; i < previous_menu_items_used; i++)
1065 if (menu_items_used == i
1066 || (!EQ (previous_items[i], AREF (menu_items, i))))
1067 break;
1068 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1069 {
1070 /* The menu items have not changed. Don't bother updating
1071 the menus in any form, since it would be a no-op. */
1072 free_menubar_widget_value_tree (first_wv);
1073 discard_menu_items ();
1074 unbind_to (specpdl_count, Qnil);
1075 return;
1076 }
1077
1078 /* The menu items are different, so store them in the frame. */
1079 fset_menu_bar_vector (f, menu_items);
1080 f->menu_bar_items_used = menu_items_used;
1081
1082 /* This undoes save_menu_items. */
1083 unbind_to (specpdl_count, Qnil);
1084
1085 /* Now GC cannot happen during the lifetime of the widget_value,
1086 so it's safe to store data from a Lisp_String. */
1087 wv = first_wv->contents;
1088 for (i = 0; i < ASIZE (items); i += 4)
1089 {
1090 Lisp_Object string;
1091 string = AREF (items, i + 1);
1092 if (NILP (string))
1093 break;
1094 wv->name = SSDATA (string);
1095 update_submenu_strings (wv->contents);
1096 wv = wv->next;
1097 }
1098
1099 }
1100 else
1101 {
1102 /* Make a widget-value tree containing
1103 just the top level menu bar strings. */
1104
1105 wv = xmalloc_widget_value ();
1106 wv->name = "menubar";
1107 wv->value = 0;
1108 wv->enabled = 1;
1109 wv->button_type = BUTTON_TYPE_NONE;
1110 wv->help = Qnil;
1111 first_wv = wv;
1112
1113 items = FRAME_MENU_BAR_ITEMS (f);
1114 for (i = 0; i < ASIZE (items); i += 4)
1115 {
1116 Lisp_Object string;
1117
1118 string = AREF (items, i + 1);
1119 if (NILP (string))
1120 break;
1121
1122 wv = xmalloc_widget_value ();
1123 wv->name = SSDATA (string);
1124 wv->value = 0;
1125 wv->enabled = 1;
1126 wv->button_type = BUTTON_TYPE_NONE;
1127 wv->help = Qnil;
1128 /* This prevents lwlib from assuming this
1129 menu item is really supposed to be empty. */
1130 /* The intptr_t cast avoids a warning.
1131 This value just has to be different from small integers. */
1132 wv->call_data = (void *) (intptr_t) (-1);
1133
1134 if (prev_wv)
1135 prev_wv->next = wv;
1136 else
1137 first_wv->contents = wv;
1138 prev_wv = wv;
1139 }
1140
1141 /* Forget what we thought we knew about what is in the
1142 detailed contents of the menu bar menus.
1143 Changing the top level always destroys the contents. */
1144 f->menu_bar_items_used = 0;
1145 }
1146
1147 /* Create or update the menu bar widget. */
1148
1149 block_input ();
1150
1151 #ifdef USE_GTK
1152 xg_crazy_callback_abort = 1;
1153 if (menubar_widget)
1154 {
1155 /* The fourth arg is DEEP_P, which says to consider the entire
1156 menu trees we supply, rather than just the menu bar item names. */
1157 xg_modify_menubar_widgets (menubar_widget,
1158 f,
1159 first_wv,
1160 deep_p,
1161 G_CALLBACK (menubar_selection_callback),
1162 G_CALLBACK (popup_deactivate_callback),
1163 G_CALLBACK (menu_highlight_callback));
1164 }
1165 else
1166 {
1167 menubar_widget
1168 = xg_create_widget ("menubar", "menubar", f, first_wv,
1169 G_CALLBACK (menubar_selection_callback),
1170 G_CALLBACK (popup_deactivate_callback),
1171 G_CALLBACK (menu_highlight_callback));
1172
1173 f->output_data.x->menubar_widget = menubar_widget;
1174 }
1175
1176
1177 #else /* not USE_GTK */
1178 if (menubar_widget)
1179 {
1180 /* Disable resizing (done for Motif!) */
1181 lw_allow_resizing (f->output_data.x->widget, False);
1182
1183 /* The third arg is DEEP_P, which says to consider the entire
1184 menu trees we supply, rather than just the menu bar item names. */
1185 lw_modify_all_widgets (id, first_wv, deep_p);
1186
1187 /* Re-enable the edit widget to resize. */
1188 lw_allow_resizing (f->output_data.x->widget, True);
1189 }
1190 else
1191 {
1192 char menuOverride[] = "Ctrl<KeyPress>g: MenuGadgetEscape()";
1193 XtTranslations override = XtParseTranslationTable (menuOverride);
1194
1195 #ifdef USE_LUCID
1196 apply_systemfont_to_menu (f, f->output_data.x->column_widget);
1197 #endif
1198 menubar_widget = lw_create_widget ("menubar", "menubar", id,
1199 first_wv,
1200 f->output_data.x->column_widget,
1201 0,
1202 popup_activate_callback,
1203 menubar_selection_callback,
1204 popup_deactivate_callback,
1205 menu_highlight_callback);
1206 f->output_data.x->menubar_widget = menubar_widget;
1207
1208 /* Make menu pop down on C-g. */
1209 XtOverrideTranslations (menubar_widget, override);
1210 }
1211
1212 {
1213 int menubar_size;
1214 if (f->output_data.x->menubar_widget)
1215 XtRealizeWidget (f->output_data.x->menubar_widget);
1216
1217 menubar_size
1218 = (f->output_data.x->menubar_widget
1219 ? (f->output_data.x->menubar_widget->core.height
1220 + f->output_data.x->menubar_widget->core.border_width)
1221 : 0);
1222
1223 #if 1 /* Experimentally, we now get the right results
1224 for -geometry -0-0 without this. 24 Aug 96, rms.
1225 Maybe so, but the menu bar size is missing the pixels so the
1226 WM size hints are off by these pixels. Jan D, oct 2009. */
1227 #ifdef USE_LUCID
1228 if (FRAME_EXTERNAL_MENU_BAR (f))
1229 {
1230 Dimension ibw = 0;
1231 XtVaGetValues (f->output_data.x->column_widget,
1232 XtNinternalBorderWidth, &ibw, NULL);
1233 menubar_size += ibw;
1234 }
1235 #endif /* USE_LUCID */
1236 #endif /* 1 */
1237
1238 f->output_data.x->menubar_height = menubar_size;
1239 }
1240 #endif /* not USE_GTK */
1241
1242 free_menubar_widget_value_tree (first_wv);
1243 update_frame_menubar (f);
1244
1245 #ifdef USE_GTK
1246 xg_crazy_callback_abort = 0;
1247 #endif
1248
1249 unblock_input ();
1250 }
1251
1252 /* Called from Fx_create_frame to create the initial menubar of a frame
1253 before it is mapped, so that the window is mapped with the menubar already
1254 there instead of us tacking it on later and thrashing the window after it
1255 is visible. */
1256
1257 void
1258 initialize_frame_menubar (struct frame *f)
1259 {
1260 /* This function is called before the first chance to redisplay
1261 the frame. It has to be, so the frame will have the right size. */
1262 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
1263 set_frame_menubar (f, 1, 1);
1264 }
1265
1266
1267 /* Get rid of the menu bar of frame F, and free its storage.
1268 This is used when deleting a frame, and when turning off the menu bar.
1269 For GTK this function is in gtkutil.c. */
1270
1271 #ifndef USE_GTK
1272 void
1273 free_frame_menubar (struct frame *f)
1274 {
1275 Widget menubar_widget;
1276
1277 eassert (FRAME_X_P (f));
1278
1279 menubar_widget = f->output_data.x->menubar_widget;
1280
1281 f->output_data.x->menubar_height = 0;
1282
1283 if (menubar_widget)
1284 {
1285 #ifdef USE_MOTIF
1286 /* Removing the menu bar magically changes the shell widget's x
1287 and y position of (0, 0) which, when the menu bar is turned
1288 on again, leads to pull-down menus appearing in strange
1289 positions near the upper-left corner of the display. This
1290 happens only with some window managers like twm and ctwm,
1291 but not with other like Motif's mwm or kwm, because the
1292 latter generate ConfigureNotify events when the menu bar
1293 is switched off, which fixes the shell position. */
1294 Position x0, y0, x1, y1;
1295 #endif
1296
1297 block_input ();
1298
1299 #ifdef USE_MOTIF
1300 if (f->output_data.x->widget)
1301 XtVaGetValues (f->output_data.x->widget, XtNx, &x0, XtNy, &y0, NULL);
1302 #endif
1303
1304 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1305 f->output_data.x->menubar_widget = NULL;
1306
1307 if (f->output_data.x->widget)
1308 {
1309 #ifdef USE_MOTIF
1310 XtVaGetValues (f->output_data.x->widget, XtNx, &x1, XtNy, &y1, NULL);
1311 if (x1 == 0 && y1 == 0)
1312 XtVaSetValues (f->output_data.x->widget, XtNx, x0, XtNy, y0, NULL);
1313 #endif
1314 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1315 }
1316 unblock_input ();
1317 }
1318 }
1319 #endif /* not USE_GTK */
1320
1321 #endif /* USE_X_TOOLKIT || USE_GTK */
1322 \f
1323 /* xmenu_show actually displays a menu using the panes and items in menu_items
1324 and returns the value selected from it.
1325 There are two versions of xmenu_show, one for Xt and one for Xlib.
1326 Both assume input is blocked by the caller. */
1327
1328 /* F is the frame the menu is for.
1329 X and Y are the frame-relative specified position,
1330 relative to the inside upper left corner of the frame F.
1331 FOR_CLICK is true if this menu was invoked for a mouse click.
1332 KEYMAPS is true if this menu was specified with keymaps;
1333 in that case, we return a list containing the chosen item's value
1334 and perhaps also the pane's prefix.
1335 TITLE is the specified menu title.
1336 ERROR is a place to store an error message string in case of failure.
1337 (We return nil on failure, but the value doesn't actually matter.) */
1338
1339 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1340
1341 /* The item selected in the popup menu. */
1342 static Lisp_Object *volatile menu_item_selection;
1343
1344 #ifdef USE_GTK
1345
1346 /* Used when position a popup menu. See menu_position_func and
1347 create_and_show_popup_menu below. */
1348 struct next_popup_x_y
1349 {
1350 struct frame *f;
1351 int x;
1352 int y;
1353 };
1354
1355 /* The menu position function to use if we are not putting a popup
1356 menu where the pointer is.
1357 MENU is the menu to pop up.
1358 X and Y shall on exit contain x/y where the menu shall pop up.
1359 PUSH_IN is not documented in the GTK manual.
1360 USER_DATA is any data passed in when calling gtk_menu_popup.
1361 Here it points to a struct next_popup_x_y where the coordinates
1362 to store in *X and *Y are as well as the frame for the popup.
1363
1364 Here only X and Y are used. */
1365 static void
1366 menu_position_func (GtkMenu *menu, gint *x, gint *y, gboolean *push_in, gpointer user_data)
1367 {
1368 struct next_popup_x_y *data = user_data;
1369 GtkRequisition req;
1370 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (data->f);
1371 int disp_width = x_display_pixel_width (dpyinfo);
1372 int disp_height = x_display_pixel_height (dpyinfo);
1373
1374 *x = data->x;
1375 *y = data->y;
1376
1377 /* Check if there is room for the menu. If not, adjust x/y so that
1378 the menu is fully visible. */
1379 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1380 if (data->x + req.width > disp_width)
1381 *x -= data->x + req.width - disp_width;
1382 if (data->y + req.height > disp_height)
1383 *y -= data->y + req.height - disp_height;
1384 }
1385
1386 static void
1387 popup_selection_callback (GtkWidget *widget, gpointer client_data)
1388 {
1389 xg_menu_item_cb_data *cb_data = client_data;
1390
1391 if (xg_crazy_callback_abort) return;
1392 if (cb_data) menu_item_selection = cb_data->call_data;
1393 }
1394
1395 static void
1396 pop_down_menu (void *arg)
1397 {
1398 popup_activated_flag = 0;
1399 block_input ();
1400 gtk_widget_destroy (GTK_WIDGET (arg));
1401 unblock_input ();
1402 }
1403
1404 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1405 menu pops down.
1406 menu_item_selection will be set to the selection. */
1407 static void
1408 create_and_show_popup_menu (struct frame *f, widget_value *first_wv, int x, int y,
1409 bool for_click, Time timestamp)
1410 {
1411 int i;
1412 GtkWidget *menu;
1413 GtkMenuPositionFunc pos_func = 0; /* Pop up at pointer. */
1414 struct next_popup_x_y popup_x_y;
1415 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1416 bool use_pos_func = ! for_click;
1417
1418 #ifdef HAVE_GTK3
1419 /* Always use position function for Gtk3. Otherwise menus may become
1420 too small to show anything. */
1421 use_pos_func = 1;
1422 #endif
1423
1424 eassert (FRAME_X_P (f));
1425
1426 xg_crazy_callback_abort = 1;
1427 menu = xg_create_widget ("popup", first_wv->name, f, first_wv,
1428 G_CALLBACK (popup_selection_callback),
1429 G_CALLBACK (popup_deactivate_callback),
1430 G_CALLBACK (menu_highlight_callback));
1431 xg_crazy_callback_abort = 0;
1432
1433 if (use_pos_func)
1434 {
1435 /* Not invoked by a click. pop up at x/y. */
1436 pos_func = menu_position_func;
1437
1438 /* Adjust coordinates to be root-window-relative. */
1439 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1440 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1441
1442 popup_x_y.x = x;
1443 popup_x_y.y = y;
1444 popup_x_y.f = f;
1445
1446 i = 0; /* gtk_menu_popup needs this to be 0 for a non-button popup. */
1447 }
1448
1449 if (for_click)
1450 {
1451 for (i = 0; i < 5; i++)
1452 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1453 break;
1454 }
1455
1456 /* Display the menu. */
1457 gtk_widget_show_all (menu);
1458
1459 gtk_menu_popup (GTK_MENU (menu), 0, 0, pos_func, &popup_x_y, i,
1460 timestamp ? timestamp : gtk_get_current_event_time ());
1461
1462 record_unwind_protect_ptr (pop_down_menu, menu);
1463
1464 if (gtk_widget_get_mapped (menu))
1465 {
1466 /* Set this to one. popup_widget_loop increases it by one, so it becomes
1467 two. show_help_echo uses this to detect popup menus. */
1468 popup_activated_flag = 1;
1469 /* Process events that apply to the menu. */
1470 popup_widget_loop (1, menu);
1471 }
1472
1473 unbind_to (specpdl_count, Qnil);
1474
1475 /* Must reset this manually because the button release event is not passed
1476 to Emacs event loop. */
1477 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
1478 }
1479
1480 #else /* not USE_GTK */
1481
1482 /* We need a unique id for each widget handled by the Lucid Widget
1483 library.
1484
1485 For the main windows, and popup menus, we use this counter,
1486 which we increment each time after use. This starts from 1<<16.
1487
1488 For menu bars, we use numbers starting at 0, counted in
1489 next_menubar_widget_id. */
1490 LWLIB_ID widget_id_tick;
1491
1492 static void
1493 popup_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1494 {
1495 menu_item_selection = client_data;
1496 }
1497
1498 /* ARG is the LWLIB ID of the dialog box, represented
1499 as a Lisp object as (HIGHPART . LOWPART). */
1500
1501 static void
1502 pop_down_menu (Lisp_Object arg)
1503 {
1504 LWLIB_ID id = (XINT (XCAR (arg)) << 4 * sizeof (LWLIB_ID)
1505 | XINT (XCDR (arg)));
1506
1507 block_input ();
1508 lw_destroy_all_widgets (id);
1509 unblock_input ();
1510 popup_activated_flag = 0;
1511 }
1512
1513 /* Pop up the menu for frame F defined by FIRST_WV at X/Y and loop until the
1514 menu pops down.
1515 menu_item_selection will be set to the selection. */
1516 static void
1517 create_and_show_popup_menu (struct frame *f, widget_value *first_wv,
1518 int x, int y, bool for_click, Time timestamp)
1519 {
1520 int i;
1521 Arg av[2];
1522 int ac = 0;
1523 XEvent dummy;
1524 XButtonPressedEvent *event = &(dummy.xbutton);
1525 LWLIB_ID menu_id;
1526 Widget menu;
1527
1528 eassert (FRAME_X_P (f));
1529
1530 #ifdef USE_LUCID
1531 apply_systemfont_to_menu (f, f->output_data.x->widget);
1532 #endif
1533
1534 menu_id = widget_id_tick++;
1535 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
1536 f->output_data.x->widget, 1, 0,
1537 popup_selection_callback,
1538 popup_deactivate_callback,
1539 menu_highlight_callback);
1540
1541 event->type = ButtonPress;
1542 event->serial = 0;
1543 event->send_event = 0;
1544 event->display = FRAME_X_DISPLAY (f);
1545 event->time = CurrentTime;
1546 event->root = FRAME_X_DISPLAY_INFO (f)->root_window;
1547 event->window = event->subwindow = event->root;
1548 event->x = x;
1549 event->y = y;
1550
1551 /* Adjust coordinates to be root-window-relative. */
1552 x += f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f);
1553 y += f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f);
1554
1555 event->x_root = x;
1556 event->y_root = y;
1557
1558 event->state = 0;
1559 event->button = 0;
1560 for (i = 0; i < 5; i++)
1561 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
1562 event->button = i;
1563
1564 /* Don't allow any geometry request from the user. */
1565 XtSetArg (av[ac], XtNgeometry, 0); ac++;
1566 XtSetValues (menu, av, ac);
1567
1568 /* Display the menu. */
1569 lw_popup_menu (menu, &dummy);
1570 popup_activated_flag = 1;
1571 x_activate_timeout_atimer ();
1572
1573 {
1574 int fact = 4 * sizeof (LWLIB_ID);
1575 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1576 record_unwind_protect (pop_down_menu,
1577 Fcons (make_number (menu_id >> (fact)),
1578 make_number (menu_id & ~(-1 << (fact)))));
1579
1580 /* Process events that apply to the menu. */
1581 popup_get_selection (0, FRAME_X_DISPLAY_INFO (f), menu_id, 1);
1582
1583 unbind_to (specpdl_count, Qnil);
1584 }
1585 }
1586
1587 #endif /* not USE_GTK */
1588
1589 static void
1590 cleanup_widget_value_tree (void *arg)
1591 {
1592 free_menubar_widget_value_tree (arg);
1593 }
1594
1595 Lisp_Object
1596 xmenu_show (struct frame *f, int x, int y, bool for_click, bool keymaps,
1597 Lisp_Object title, const char **error_name, Time timestamp)
1598 {
1599 int i;
1600 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1601 widget_value **submenu_stack
1602 = alloca (menu_items_used * sizeof *submenu_stack);
1603 Lisp_Object *subprefix_stack
1604 = alloca (menu_items_used * sizeof *subprefix_stack);
1605 int submenu_depth = 0;
1606
1607 int first_pane;
1608
1609 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1610
1611 eassert (FRAME_X_P (f));
1612
1613 *error_name = NULL;
1614
1615 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1616 {
1617 *error_name = "Empty menu";
1618 return Qnil;
1619 }
1620
1621 /* Create a tree of widget_value objects
1622 representing the panes and their items. */
1623 wv = xmalloc_widget_value ();
1624 wv->name = "menu";
1625 wv->value = 0;
1626 wv->enabled = 1;
1627 wv->button_type = BUTTON_TYPE_NONE;
1628 wv->help =Qnil;
1629 first_wv = wv;
1630 first_pane = 1;
1631
1632 /* Loop over all panes and items, filling in the tree. */
1633 i = 0;
1634 while (i < menu_items_used)
1635 {
1636 if (EQ (AREF (menu_items, i), Qnil))
1637 {
1638 submenu_stack[submenu_depth++] = save_wv;
1639 save_wv = prev_wv;
1640 prev_wv = 0;
1641 first_pane = 1;
1642 i++;
1643 }
1644 else if (EQ (AREF (menu_items, i), Qlambda))
1645 {
1646 prev_wv = save_wv;
1647 save_wv = submenu_stack[--submenu_depth];
1648 first_pane = 0;
1649 i++;
1650 }
1651 else if (EQ (AREF (menu_items, i), Qt)
1652 && submenu_depth != 0)
1653 i += MENU_ITEMS_PANE_LENGTH;
1654 /* Ignore a nil in the item list.
1655 It's meaningful only for dialog boxes. */
1656 else if (EQ (AREF (menu_items, i), Qquote))
1657 i += 1;
1658 else if (EQ (AREF (menu_items, i), Qt))
1659 {
1660 /* Create a new pane. */
1661 Lisp_Object pane_name, prefix;
1662 const char *pane_string;
1663
1664 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1665 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1666
1667 #ifndef HAVE_MULTILINGUAL_MENU
1668 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
1669 {
1670 pane_name = ENCODE_MENU_STRING (pane_name);
1671 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1672 }
1673 #endif
1674 pane_string = (NILP (pane_name)
1675 ? "" : SSDATA (pane_name));
1676 /* If there is just one top-level pane, put all its items directly
1677 under the top-level menu. */
1678 if (menu_items_n_panes == 1)
1679 pane_string = "";
1680
1681 /* If the pane has a meaningful name,
1682 make the pane a top-level menu item
1683 with its items as a submenu beneath it. */
1684 if (!keymaps && strcmp (pane_string, ""))
1685 {
1686 wv = xmalloc_widget_value ();
1687 if (save_wv)
1688 save_wv->next = wv;
1689 else
1690 first_wv->contents = wv;
1691 wv->name = (char *) pane_string;
1692 if (keymaps && !NILP (prefix))
1693 wv->name++;
1694 wv->value = 0;
1695 wv->enabled = 1;
1696 wv->button_type = BUTTON_TYPE_NONE;
1697 wv->help = Qnil;
1698 save_wv = wv;
1699 prev_wv = 0;
1700 }
1701 else if (first_pane)
1702 {
1703 save_wv = wv;
1704 prev_wv = 0;
1705 }
1706 first_pane = 0;
1707 i += MENU_ITEMS_PANE_LENGTH;
1708 }
1709 else
1710 {
1711 /* Create a new item within current pane. */
1712 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1713 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1714 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1715 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1716 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1717 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1718 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1719 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1720
1721 #ifndef HAVE_MULTILINGUAL_MENU
1722 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
1723 {
1724 item_name = ENCODE_MENU_STRING (item_name);
1725 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1726 }
1727
1728 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1729 {
1730 descrip = ENCODE_MENU_STRING (descrip);
1731 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1732 }
1733 #endif /* not HAVE_MULTILINGUAL_MENU */
1734
1735 wv = xmalloc_widget_value ();
1736 if (prev_wv)
1737 prev_wv->next = wv;
1738 else
1739 save_wv->contents = wv;
1740 wv->name = SSDATA (item_name);
1741 if (!NILP (descrip))
1742 wv->key = SSDATA (descrip);
1743 wv->value = 0;
1744 /* If this item has a null value,
1745 make the call_data null so that it won't display a box
1746 when the mouse is on it. */
1747 wv->call_data = !NILP (def) ? aref_addr (menu_items, i) : 0;
1748 wv->enabled = !NILP (enable);
1749
1750 if (NILP (type))
1751 wv->button_type = BUTTON_TYPE_NONE;
1752 else if (EQ (type, QCtoggle))
1753 wv->button_type = BUTTON_TYPE_TOGGLE;
1754 else if (EQ (type, QCradio))
1755 wv->button_type = BUTTON_TYPE_RADIO;
1756 else
1757 emacs_abort ();
1758
1759 wv->selected = !NILP (selected);
1760
1761 if (! STRINGP (help))
1762 help = Qnil;
1763
1764 wv->help = help;
1765
1766 prev_wv = wv;
1767
1768 i += MENU_ITEMS_ITEM_LENGTH;
1769 }
1770 }
1771
1772 /* Deal with the title, if it is non-nil. */
1773 if (!NILP (title))
1774 {
1775 widget_value *wv_title = xmalloc_widget_value ();
1776 widget_value *wv_sep1 = xmalloc_widget_value ();
1777 widget_value *wv_sep2 = xmalloc_widget_value ();
1778
1779 wv_sep2->name = "--";
1780 wv_sep2->next = first_wv->contents;
1781 wv_sep2->help = Qnil;
1782
1783 wv_sep1->name = "--";
1784 wv_sep1->next = wv_sep2;
1785 wv_sep1->help = Qnil;
1786
1787 #ifndef HAVE_MULTILINGUAL_MENU
1788 if (STRING_MULTIBYTE (title))
1789 title = ENCODE_MENU_STRING (title);
1790 #endif
1791
1792 wv_title->name = SSDATA (title);
1793 wv_title->enabled = TRUE;
1794 wv_title->button_type = BUTTON_TYPE_NONE;
1795 wv_title->help = Qnil;
1796 wv_title->next = wv_sep1;
1797 first_wv->contents = wv_title;
1798 }
1799
1800 /* No selection has been chosen yet. */
1801 menu_item_selection = 0;
1802
1803 /* Make sure to free the widget_value objects we used to specify the
1804 contents even with longjmp. */
1805 record_unwind_protect_ptr (cleanup_widget_value_tree, first_wv);
1806
1807 /* Actually create and show the menu until popped down. */
1808 create_and_show_popup_menu (f, first_wv, x, y, for_click, timestamp);
1809
1810 unbind_to (specpdl_count, Qnil);
1811
1812 /* Find the selected item, and its pane, to return
1813 the proper value. */
1814 if (menu_item_selection != 0)
1815 {
1816 Lisp_Object prefix, entry;
1817
1818 prefix = entry = Qnil;
1819 i = 0;
1820 while (i < menu_items_used)
1821 {
1822 if (EQ (AREF (menu_items, i), Qnil))
1823 {
1824 subprefix_stack[submenu_depth++] = prefix;
1825 prefix = entry;
1826 i++;
1827 }
1828 else if (EQ (AREF (menu_items, i), Qlambda))
1829 {
1830 prefix = subprefix_stack[--submenu_depth];
1831 i++;
1832 }
1833 else if (EQ (AREF (menu_items, i), Qt))
1834 {
1835 prefix
1836 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1837 i += MENU_ITEMS_PANE_LENGTH;
1838 }
1839 /* Ignore a nil in the item list.
1840 It's meaningful only for dialog boxes. */
1841 else if (EQ (AREF (menu_items, i), Qquote))
1842 i += 1;
1843 else
1844 {
1845 entry
1846 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1847 if (menu_item_selection == aref_addr (menu_items, i))
1848 {
1849 if (keymaps)
1850 {
1851 int j;
1852
1853 entry = list1 (entry);
1854 if (!NILP (prefix))
1855 entry = Fcons (prefix, entry);
1856 for (j = submenu_depth - 1; j >= 0; j--)
1857 if (!NILP (subprefix_stack[j]))
1858 entry = Fcons (subprefix_stack[j], entry);
1859 }
1860 return entry;
1861 }
1862 i += MENU_ITEMS_ITEM_LENGTH;
1863 }
1864 }
1865 }
1866 else if (!for_click)
1867 /* Make "Cancel" equivalent to C-g. */
1868 Fsignal (Qquit, Qnil);
1869
1870 return Qnil;
1871 }
1872 \f
1873 #ifdef USE_GTK
1874 static void
1875 dialog_selection_callback (GtkWidget *widget, gpointer client_data)
1876 {
1877 /* Treat the pointer as an integer. There's no problem
1878 as long as pointers have enough bits to hold small integers. */
1879 if ((intptr_t) client_data != -1)
1880 menu_item_selection = client_data;
1881
1882 popup_activated_flag = 0;
1883 }
1884
1885 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1886 dialog pops down.
1887 menu_item_selection will be set to the selection. */
1888 static void
1889 create_and_show_dialog (struct frame *f, widget_value *first_wv)
1890 {
1891 GtkWidget *menu;
1892
1893 eassert (FRAME_X_P (f));
1894
1895 menu = xg_create_widget ("dialog", first_wv->name, f, first_wv,
1896 G_CALLBACK (dialog_selection_callback),
1897 G_CALLBACK (popup_deactivate_callback),
1898 0);
1899
1900 if (menu)
1901 {
1902 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1903 record_unwind_protect_ptr (pop_down_menu, menu);
1904
1905 /* Display the menu. */
1906 gtk_widget_show_all (menu);
1907
1908 /* Process events that apply to the menu. */
1909 popup_widget_loop (1, menu);
1910
1911 unbind_to (specpdl_count, Qnil);
1912 }
1913 }
1914
1915 #else /* not USE_GTK */
1916 static void
1917 dialog_selection_callback (Widget widget, LWLIB_ID id, XtPointer client_data)
1918 {
1919 /* Treat the pointer as an integer. There's no problem
1920 as long as pointers have enough bits to hold small integers. */
1921 if ((intptr_t) client_data != -1)
1922 menu_item_selection = client_data;
1923
1924 block_input ();
1925 lw_destroy_all_widgets (id);
1926 unblock_input ();
1927 popup_activated_flag = 0;
1928 }
1929
1930
1931 /* Pop up the dialog for frame F defined by FIRST_WV and loop until the
1932 dialog pops down.
1933 menu_item_selection will be set to the selection. */
1934 static void
1935 create_and_show_dialog (struct frame *f, widget_value *first_wv)
1936 {
1937 LWLIB_ID dialog_id;
1938
1939 eassert (FRAME_X_P (f));
1940
1941 dialog_id = widget_id_tick++;
1942 #ifdef USE_LUCID
1943 apply_systemfont_to_dialog (f->output_data.x->widget);
1944 #endif
1945 lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
1946 f->output_data.x->widget, 1, 0,
1947 dialog_selection_callback, 0, 0);
1948 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
1949 /* Display the dialog box. */
1950 lw_pop_up_all_widgets (dialog_id);
1951 popup_activated_flag = 1;
1952 x_activate_timeout_atimer ();
1953
1954 /* Process events that apply to the dialog box.
1955 Also handle timers. */
1956 {
1957 ptrdiff_t count = SPECPDL_INDEX ();
1958 int fact = 4 * sizeof (LWLIB_ID);
1959
1960 /* xdialog_show_unwind is responsible for popping the dialog box down. */
1961 record_unwind_protect (pop_down_menu,
1962 Fcons (make_number (dialog_id >> (fact)),
1963 make_number (dialog_id & ~(-1 << (fact)))));
1964
1965 popup_get_selection (0, FRAME_X_DISPLAY_INFO (f), dialog_id, 1);
1966
1967 unbind_to (count, Qnil);
1968 }
1969 }
1970
1971 #endif /* not USE_GTK */
1972
1973 static const char * button_names [] = {
1974 "button1", "button2", "button3", "button4", "button5",
1975 "button6", "button7", "button8", "button9", "button10" };
1976
1977 static Lisp_Object
1978 xdialog_show (struct frame *f,
1979 bool keymaps,
1980 Lisp_Object title,
1981 Lisp_Object header,
1982 const char **error_name)
1983 {
1984 int i, nb_buttons=0;
1985 char dialog_name[6];
1986
1987 widget_value *wv, *first_wv = 0, *prev_wv = 0;
1988
1989 /* Number of elements seen so far, before boundary. */
1990 int left_count = 0;
1991 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
1992 int boundary_seen = 0;
1993
1994 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1995
1996 eassert (FRAME_X_P (f));
1997
1998 *error_name = NULL;
1999
2000 if (menu_items_n_panes > 1)
2001 {
2002 *error_name = "Multiple panes in dialog box";
2003 return Qnil;
2004 }
2005
2006 /* Create a tree of widget_value objects
2007 representing the text label and buttons. */
2008 {
2009 Lisp_Object pane_name, prefix;
2010 const char *pane_string;
2011 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
2012 prefix = AREF (menu_items, MENU_ITEMS_PANE_PREFIX);
2013 pane_string = (NILP (pane_name)
2014 ? "" : SSDATA (pane_name));
2015 prev_wv = xmalloc_widget_value ();
2016 prev_wv->value = (char *) pane_string;
2017 if (keymaps && !NILP (prefix))
2018 prev_wv->name++;
2019 prev_wv->enabled = 1;
2020 prev_wv->name = "message";
2021 prev_wv->help = Qnil;
2022 first_wv = prev_wv;
2023
2024 /* Loop over all panes and items, filling in the tree. */
2025 i = MENU_ITEMS_PANE_LENGTH;
2026 while (i < menu_items_used)
2027 {
2028
2029 /* Create a new item within current pane. */
2030 Lisp_Object item_name, enable, descrip;
2031 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2032 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2033 descrip
2034 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2035
2036 if (NILP (item_name))
2037 {
2038 free_menubar_widget_value_tree (first_wv);
2039 *error_name = "Submenu in dialog items";
2040 return Qnil;
2041 }
2042 if (EQ (item_name, Qquote))
2043 {
2044 /* This is the boundary between left-side elts
2045 and right-side elts. Stop incrementing right_count. */
2046 boundary_seen = 1;
2047 i++;
2048 continue;
2049 }
2050 if (nb_buttons >= 9)
2051 {
2052 free_menubar_widget_value_tree (first_wv);
2053 *error_name = "Too many dialog items";
2054 return Qnil;
2055 }
2056
2057 wv = xmalloc_widget_value ();
2058 prev_wv->next = wv;
2059 wv->name = (char *) button_names[nb_buttons];
2060 if (!NILP (descrip))
2061 wv->key = SSDATA (descrip);
2062 wv->value = SSDATA (item_name);
2063 wv->call_data = aref_addr (menu_items, i);
2064 wv->enabled = !NILP (enable);
2065 wv->help = Qnil;
2066 prev_wv = wv;
2067
2068 if (! boundary_seen)
2069 left_count++;
2070
2071 nb_buttons++;
2072 i += MENU_ITEMS_ITEM_LENGTH;
2073 }
2074
2075 /* If the boundary was not specified,
2076 by default put half on the left and half on the right. */
2077 if (! boundary_seen)
2078 left_count = nb_buttons - nb_buttons / 2;
2079
2080 wv = xmalloc_widget_value ();
2081 wv->name = dialog_name;
2082 wv->help = Qnil;
2083
2084 /* Frame title: 'Q' = Question, 'I' = Information.
2085 Can also have 'E' = Error if, one day, we want
2086 a popup for errors. */
2087 if (NILP (header))
2088 dialog_name[0] = 'Q';
2089 else
2090 dialog_name[0] = 'I';
2091
2092 /* Dialog boxes use a really stupid name encoding
2093 which specifies how many buttons to use
2094 and how many buttons are on the right. */
2095 dialog_name[1] = '0' + nb_buttons;
2096 dialog_name[2] = 'B';
2097 dialog_name[3] = 'R';
2098 /* Number of buttons to put on the right. */
2099 dialog_name[4] = '0' + nb_buttons - left_count;
2100 dialog_name[5] = 0;
2101 wv->contents = first_wv;
2102 first_wv = wv;
2103 }
2104
2105 /* No selection has been chosen yet. */
2106 menu_item_selection = 0;
2107
2108 /* Make sure to free the widget_value objects we used to specify the
2109 contents even with longjmp. */
2110 record_unwind_protect_ptr (cleanup_widget_value_tree, first_wv);
2111
2112 /* Actually create and show the dialog. */
2113 create_and_show_dialog (f, first_wv);
2114
2115 unbind_to (specpdl_count, Qnil);
2116
2117 /* Find the selected item, and its pane, to return
2118 the proper value. */
2119 if (menu_item_selection != 0)
2120 {
2121 Lisp_Object prefix;
2122
2123 prefix = Qnil;
2124 i = 0;
2125 while (i < menu_items_used)
2126 {
2127 Lisp_Object entry;
2128
2129 if (EQ (AREF (menu_items, i), Qt))
2130 {
2131 prefix
2132 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2133 i += MENU_ITEMS_PANE_LENGTH;
2134 }
2135 else if (EQ (AREF (menu_items, i), Qquote))
2136 {
2137 /* This is the boundary between left-side elts and
2138 right-side elts. */
2139 ++i;
2140 }
2141 else
2142 {
2143 entry
2144 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2145 if (menu_item_selection == aref_addr (menu_items, i))
2146 {
2147 if (keymaps != 0)
2148 {
2149 entry = list1 (entry);
2150 if (!NILP (prefix))
2151 entry = Fcons (prefix, entry);
2152 }
2153 return entry;
2154 }
2155 i += MENU_ITEMS_ITEM_LENGTH;
2156 }
2157 }
2158 }
2159 else
2160 /* Make "Cancel" equivalent to C-g. */
2161 Fsignal (Qquit, Qnil);
2162
2163 return Qnil;
2164 }
2165
2166 #else /* not USE_X_TOOLKIT && not USE_GTK */
2167
2168 /* The frame of the last activated non-toolkit menu bar.
2169 Used to generate menu help events. */
2170
2171 static struct frame *menu_help_frame;
2172
2173
2174 /* Show help HELP_STRING, or clear help if HELP_STRING is null.
2175
2176 PANE is the pane number, and ITEM is the menu item number in
2177 the menu (currently not used).
2178
2179 This cannot be done with generating a HELP_EVENT because
2180 XMenuActivate contains a loop that doesn't let Emacs process
2181 keyboard events. */
2182
2183 static void
2184 menu_help_callback (char const *help_string, int pane, int item)
2185 {
2186 Lisp_Object *first_item;
2187 Lisp_Object pane_name;
2188 Lisp_Object menu_object;
2189
2190 first_item = XVECTOR (menu_items)->contents;
2191 if (EQ (first_item[0], Qt))
2192 pane_name = first_item[MENU_ITEMS_PANE_NAME];
2193 else if (EQ (first_item[0], Qquote))
2194 /* This shouldn't happen, see xmenu_show. */
2195 pane_name = empty_unibyte_string;
2196 else
2197 pane_name = first_item[MENU_ITEMS_ITEM_NAME];
2198
2199 /* (menu-item MENU-NAME PANE-NUMBER) */
2200 menu_object = list3 (Qmenu_item, pane_name, make_number (pane));
2201 show_help_echo (help_string ? build_string (help_string) : Qnil,
2202 Qnil, menu_object, make_number (item));
2203 }
2204
2205 static void
2206 pop_down_menu (Lisp_Object arg)
2207 {
2208 struct frame *f = XSAVE_POINTER (arg, 0);
2209 XMenu *menu = XSAVE_POINTER (arg, 1);
2210
2211 block_input ();
2212 #ifndef MSDOS
2213 XUngrabPointer (FRAME_X_DISPLAY (f), CurrentTime);
2214 XUngrabKeyboard (FRAME_X_DISPLAY (f), CurrentTime);
2215 #endif
2216 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2217
2218 #ifdef HAVE_X_WINDOWS
2219 /* Assume the mouse has moved out of the X window.
2220 If it has actually moved in, we will get an EnterNotify. */
2221 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
2222
2223 /* State that no mouse buttons are now held.
2224 (The oldXMenu code doesn't track this info for us.)
2225 That is not necessarily true, but the fiction leads to reasonable
2226 results, and it is a pain to ask which are actually held now. */
2227 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2228
2229 #endif /* HAVE_X_WINDOWS */
2230
2231 unblock_input ();
2232 }
2233
2234
2235 Lisp_Object
2236 xmenu_show (struct frame *f, int x, int y, bool for_click, bool keymaps,
2237 Lisp_Object title, const char **error_name, Time timestamp)
2238 {
2239 Window root;
2240 XMenu *menu;
2241 int pane, selidx, lpane, status;
2242 Lisp_Object entry, pane_prefix;
2243 char *datap;
2244 int ulx, uly, width, height;
2245 int dispwidth, dispheight;
2246 int i, j, lines, maxlines;
2247 int maxwidth;
2248 int dummy_int;
2249 unsigned int dummy_uint;
2250 ptrdiff_t specpdl_count = SPECPDL_INDEX ();
2251
2252 eassert (FRAME_X_P (f) || FRAME_MSDOS_P (f));
2253
2254 *error_name = 0;
2255 if (menu_items_n_panes == 0)
2256 return Qnil;
2257
2258 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2259 {
2260 *error_name = "Empty menu";
2261 return Qnil;
2262 }
2263
2264 /* Figure out which root window F is on. */
2265 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2266 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2267 &dummy_uint, &dummy_uint);
2268
2269 /* Make the menu on that window. */
2270 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2271 if (menu == NULL)
2272 {
2273 *error_name = "Can't create menu";
2274 return Qnil;
2275 }
2276
2277 /* Don't GC while we prepare and show the menu,
2278 because we give the oldxmenu library pointers to the
2279 contents of strings. */
2280 inhibit_garbage_collection ();
2281
2282 #ifdef HAVE_X_WINDOWS
2283 /* Adjust coordinates to relative to the outer (window manager) window. */
2284 x += FRAME_OUTER_TO_INNER_DIFF_X (f);
2285 y += FRAME_OUTER_TO_INNER_DIFF_Y (f);
2286 #endif /* HAVE_X_WINDOWS */
2287
2288 /* Adjust coordinates to be root-window-relative. */
2289 x += f->left_pos;
2290 y += f->top_pos;
2291
2292 /* Create all the necessary panes and their items. */
2293 maxwidth = maxlines = lines = i = 0;
2294 lpane = XM_FAILURE;
2295 while (i < menu_items_used)
2296 {
2297 if (EQ (AREF (menu_items, i), Qt))
2298 {
2299 /* Create a new pane. */
2300 Lisp_Object pane_name, prefix;
2301 const char *pane_string;
2302
2303 maxlines = max (maxlines, lines);
2304 lines = 0;
2305 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
2306 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2307 pane_string = (NILP (pane_name)
2308 ? "" : SSDATA (pane_name));
2309 if (keymaps && !NILP (prefix))
2310 pane_string++;
2311
2312 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2313 if (lpane == XM_FAILURE)
2314 {
2315 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2316 *error_name = "Can't create pane";
2317 return Qnil;
2318 }
2319 i += MENU_ITEMS_PANE_LENGTH;
2320
2321 /* Find the width of the widest item in this pane. */
2322 j = i;
2323 while (j < menu_items_used)
2324 {
2325 Lisp_Object item;
2326 item = AREF (menu_items, j);
2327 if (EQ (item, Qt))
2328 break;
2329 if (NILP (item))
2330 {
2331 j++;
2332 continue;
2333 }
2334 width = SBYTES (item);
2335 if (width > maxwidth)
2336 maxwidth = width;
2337
2338 j += MENU_ITEMS_ITEM_LENGTH;
2339 }
2340 }
2341 /* Ignore a nil in the item list.
2342 It's meaningful only for dialog boxes. */
2343 else if (EQ (AREF (menu_items, i), Qquote))
2344 i += 1;
2345 else
2346 {
2347 /* Create a new item within current pane. */
2348 Lisp_Object item_name, enable, descrip, help;
2349 char *item_data;
2350 char const *help_string;
2351
2352 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2353 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2354 descrip
2355 = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2356 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
2357 help_string = STRINGP (help) ? SSDATA (help) : NULL;
2358
2359 if (!NILP (descrip))
2360 {
2361 /* if alloca is fast, use that to make the space,
2362 to reduce gc needs. */
2363 item_data = alloca (maxwidth + SBYTES (descrip) + 1);
2364 memcpy (item_data, SSDATA (item_name), SBYTES (item_name));
2365 for (j = SCHARS (item_name); j < maxwidth; j++)
2366 item_data[j] = ' ';
2367 memcpy (item_data + j, SSDATA (descrip), SBYTES (descrip));
2368 item_data[j + SBYTES (descrip)] = 0;
2369 }
2370 else
2371 item_data = SSDATA (item_name);
2372
2373 if (lpane == XM_FAILURE
2374 || (XMenuAddSelection (FRAME_X_DISPLAY (f),
2375 menu, lpane, 0, item_data,
2376 !NILP (enable), help_string)
2377 == XM_FAILURE))
2378 {
2379 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2380 *error_name = "Can't add selection to menu";
2381 return Qnil;
2382 }
2383 i += MENU_ITEMS_ITEM_LENGTH;
2384 lines++;
2385 }
2386 }
2387
2388 maxlines = max (maxlines, lines);
2389
2390 /* All set and ready to fly. */
2391 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2392 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2393 dispheight = DisplayHeight (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f));
2394 x = min (x, dispwidth);
2395 y = min (y, dispheight);
2396 x = max (x, 1);
2397 y = max (y, 1);
2398 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2399 &ulx, &uly, &width, &height);
2400 if (ulx+width > dispwidth)
2401 {
2402 x -= (ulx + width) - dispwidth;
2403 ulx = dispwidth - width;
2404 }
2405 if (uly+height > dispheight)
2406 {
2407 y -= (uly + height) - dispheight;
2408 uly = dispheight - height;
2409 }
2410 #ifndef HAVE_X_WINDOWS
2411 if (FRAME_HAS_MINIBUF_P (f) && uly+height > dispheight - 1)
2412 {
2413 /* Move the menu away of the echo area, to avoid overwriting the
2414 menu with help echo messages or vice versa. */
2415 if (BUFFERP (echo_area_buffer[0]) && WINDOWP (echo_area_window))
2416 {
2417 y -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2418 uly -= WINDOW_TOTAL_LINES (XWINDOW (echo_area_window));
2419 }
2420 else
2421 {
2422 y--;
2423 uly--;
2424 }
2425 }
2426 #endif
2427 if (ulx < 0) x -= ulx;
2428 if (uly < 0) y -= uly;
2429
2430 if (! for_click)
2431 {
2432 /* If position was not given by a mouse click, adjust so upper left
2433 corner of the menu as a whole ends up at given coordinates. This
2434 is what x-popup-menu says in its documentation. */
2435 x += width/2;
2436 y += 1.5*height/(maxlines+2);
2437 }
2438
2439 XMenuSetAEQ (menu, TRUE);
2440 XMenuSetFreeze (menu, TRUE);
2441 pane = selidx = 0;
2442
2443 #ifndef MSDOS
2444 XMenuActivateSetWaitFunction (x_menu_wait_for_event, FRAME_X_DISPLAY (f));
2445 #endif
2446
2447 record_unwind_protect (pop_down_menu, make_save_ptr_ptr (f, menu));
2448
2449 /* Help display under X won't work because XMenuActivate contains
2450 a loop that doesn't give Emacs a chance to process it. */
2451 menu_help_frame = f;
2452 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2453 x, y, ButtonReleaseMask, &datap,
2454 menu_help_callback);
2455 entry = pane_prefix = Qnil;
2456
2457 switch (status)
2458 {
2459 case XM_SUCCESS:
2460 #ifdef XDEBUG
2461 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2462 #endif
2463
2464 /* Find the item number SELIDX in pane number PANE. */
2465 i = 0;
2466 while (i < menu_items_used)
2467 {
2468 if (EQ (AREF (menu_items, i), Qt))
2469 {
2470 if (pane == 0)
2471 pane_prefix
2472 = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2473 pane--;
2474 i += MENU_ITEMS_PANE_LENGTH;
2475 }
2476 else
2477 {
2478 if (pane == -1)
2479 {
2480 if (selidx == 0)
2481 {
2482 entry
2483 = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2484 if (keymaps)
2485 {
2486 entry = list1 (entry);
2487 if (!NILP (pane_prefix))
2488 entry = Fcons (pane_prefix, entry);
2489 }
2490 break;
2491 }
2492 selidx--;
2493 }
2494 i += MENU_ITEMS_ITEM_LENGTH;
2495 }
2496 }
2497 break;
2498
2499 case XM_FAILURE:
2500 *error_name = "Can't activate menu";
2501 case XM_IA_SELECT:
2502 break;
2503 case XM_NO_SELECT:
2504 /* Make "Cancel" equivalent to C-g unless FOR_CLICK (which means
2505 the menu was invoked with a mouse event as POSITION). */
2506 if (! for_click)
2507 Fsignal (Qquit, Qnil);
2508 break;
2509 }
2510
2511 unbind_to (specpdl_count, Qnil);
2512
2513 return entry;
2514 }
2515
2516 #endif /* not USE_X_TOOLKIT */
2517
2518 #endif /* HAVE_MENUS */
2519
2520 #ifndef MSDOS
2521 /* Detect if a dialog or menu has been posted. MSDOS has its own
2522 implementation on msdos.c. */
2523
2524 int ATTRIBUTE_CONST
2525 popup_activated (void)
2526 {
2527 return popup_activated_flag;
2528 }
2529 #endif /* not MSDOS */
2530
2531 /* The following is used by delayed window autoselection. */
2532
2533 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
2534 doc: /* Return t if a menu or popup dialog is active. */)
2535 (void)
2536 {
2537 #ifdef HAVE_MENUS
2538 return (popup_activated ()) ? Qt : Qnil;
2539 #else
2540 return Qnil;
2541 #endif /* HAVE_MENUS */
2542 }
2543 \f
2544 void
2545 syms_of_xmenu (void)
2546 {
2547 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
2548
2549 #ifdef USE_X_TOOLKIT
2550 widget_id_tick = (1<<16);
2551 next_menubar_widget_id = 1;
2552 #endif
2553
2554 defsubr (&Smenu_or_popup_active_p);
2555
2556 #if defined (USE_GTK) || defined (USE_X_TOOLKIT)
2557 defsubr (&Sx_menu_bar_open_internal);
2558 Ffset (intern_c_string ("accelerate-menu"),
2559 intern_c_string (Sx_menu_bar_open_internal.symbol_name));
2560 #endif
2561
2562 #ifdef HAVE_MENUS
2563 defsubr (&Sx_popup_dialog);
2564 #endif
2565 }