(display_text_line): Handle the case of point being in
[emacs.git] / src / xmenu.c
blobbdfe046f838eb73000b682bf6749597e53056e79
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1986, 1988, 1993, 1994, 1996 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* X pop-up deck-of-cards menu facility for gnuemacs.
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 /* On 4.3 this loses if it comes after xterm.h. */
34 #include <signal.h>
35 #include <config.h>
37 #include <stdio.h>
38 #include "lisp.h"
39 #include "termhooks.h"
40 #include "frame.h"
41 #include "window.h"
42 #include "keyboard.h"
43 #include "blockinput.h"
44 #include "puresize.h"
45 #include "buffer.h"
47 #ifdef MSDOS
48 #include "msdos.h"
49 #endif
51 #ifdef HAVE_X_WINDOWS
52 /* This may include sys/types.h, and that somehow loses
53 if this is not done before the other system files. */
54 #include "xterm.h"
55 #endif
57 /* Load sys/types.h if not already loaded.
58 In some systems loading it twice is suicidal. */
59 #ifndef makedev
60 #include <sys/types.h>
61 #endif
63 #include "dispextern.h"
65 #ifdef HAVE_X_WINDOWS
66 #ifdef USE_X_TOOLKIT
67 #include <X11/Xlib.h>
68 #include <X11/IntrinsicP.h>
69 #include <X11/CoreP.h>
70 #include <X11/StringDefs.h>
71 #include <X11/Shell.h>
72 #ifdef USE_LUCID
73 #include <X11/Xaw/Paned.h>
74 #endif /* USE_LUCID */
75 #include "../lwlib/lwlib.h"
76 #else /* not USE_X_TOOLKIT */
77 #include "../oldXMenu/XMenu.h"
78 #endif /* not USE_X_TOOLKIT */
79 #endif /* HAVE_X_WINDOWS */
81 #define min(x,y) (((x) < (y)) ? (x) : (y))
82 #define max(x,y) (((x) > (y)) ? (x) : (y))
84 #ifndef TRUE
85 #define TRUE 1
86 #define FALSE 0
87 #endif /* no TRUE */
89 Lisp_Object Vmenu_updating_frame;
91 Lisp_Object Qdebug_on_next_call;
93 Lisp_Object Qmenu_alias;
95 extern Lisp_Object Qmenu_enable;
96 extern Lisp_Object Qmenu_bar;
97 extern Lisp_Object Qmouse_click, Qevent_kind;
99 extern Lisp_Object Vdefine_key_rebound_commands;
101 extern Lisp_Object Voverriding_local_map;
102 extern Lisp_Object Voverriding_local_map_menu_flag;
104 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
106 extern Lisp_Object Qmenu_bar_update_hook;
108 #ifdef USE_X_TOOLKIT
109 extern void set_frame_menubar ();
110 extern void process_expose_from_menu ();
111 extern XtAppContext Xt_app_con;
113 static Lisp_Object xdialog_show ();
114 void popup_get_selection ();
115 #endif
117 static Lisp_Object xmenu_show ();
118 static void keymap_panes ();
119 static void single_keymap_panes ();
120 static void list_of_panes ();
121 static void list_of_items ();
123 /* This holds a Lisp vector that holds the results of decoding
124 the keymaps or alist-of-alists that specify a menu.
126 It describes the panes and items within the panes.
128 Each pane is described by 3 elements in the vector:
129 t, the pane name, the pane's prefix key.
130 Then follow the pane's items, with 5 elements per item:
131 the item string, the enable flag, the item's value,
132 the definition, and the equivalent keyboard key's description string.
134 In some cases, multiple levels of menus may be described.
135 A single vector slot containing nil indicates the start of a submenu.
136 A single vector slot containing lambda indicates the end of a submenu.
137 The submenu follows a menu item which is the way to reach the submenu.
139 A single vector slot containing quote indicates that the
140 following items should appear on the right of a dialog box.
142 Using a Lisp vector to hold this information while we decode it
143 takes care of protecting all the data from GC. */
145 #define MENU_ITEMS_PANE_NAME 1
146 #define MENU_ITEMS_PANE_PREFIX 2
147 #define MENU_ITEMS_PANE_LENGTH 3
149 #define MENU_ITEMS_ITEM_NAME 0
150 #define MENU_ITEMS_ITEM_ENABLE 1
151 #define MENU_ITEMS_ITEM_VALUE 2
152 #define MENU_ITEMS_ITEM_EQUIV_KEY 3
153 #define MENU_ITEMS_ITEM_DEFINITION 4
154 #define MENU_ITEMS_ITEM_LENGTH 5
156 static Lisp_Object menu_items;
158 /* Number of slots currently allocated in menu_items. */
159 static int menu_items_allocated;
161 /* This is the index in menu_items of the first empty slot. */
162 static int menu_items_used;
164 /* The number of panes currently recorded in menu_items,
165 excluding those within submenus. */
166 static int menu_items_n_panes;
168 /* Current depth within submenus. */
169 static int menu_items_submenu_depth;
171 /* Flag which when set indicates a dialog or menu has been posted by
172 Xt on behalf of one of the widget sets. */
173 static int popup_activated_flag;
175 static int next_menubar_widget_id;
177 /* This is set nonzero after the user activates the menu bar, and set
178 to zero again after the menu bars are redisplayed by prepare_menu_bar.
179 While it is nonzero, all calls to set_frame_menubar go deep.
181 I don't understand why this is needed, but it does seem to be
182 needed on Motif, according to Marcus Daniels <marcus@sysc.pdx.edu>. */
184 int pending_menu_activation;
186 #ifdef USE_X_TOOLKIT
188 /* Return the frame whose ->output_data.x->id equals ID, or 0 if none. */
190 static struct frame *
191 menubar_id_to_frame (id)
192 LWLIB_ID id;
194 Lisp_Object tail, frame;
195 FRAME_PTR f;
197 for (tail = Vframe_list; GC_CONSP (tail); tail = XCONS (tail)->cdr)
199 frame = XCONS (tail)->car;
200 if (!GC_FRAMEP (frame))
201 continue;
202 f = XFRAME (frame);
203 if (f->output_data.nothing == 1)
204 continue;
205 if (f->output_data.x->id == id)
206 return f;
208 return 0;
211 #endif
213 /* Initialize the menu_items structure if we haven't already done so.
214 Also mark it as currently empty. */
216 static void
217 init_menu_items ()
219 if (NILP (menu_items))
221 menu_items_allocated = 60;
222 menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
225 menu_items_used = 0;
226 menu_items_n_panes = 0;
227 menu_items_submenu_depth = 0;
230 /* Call at the end of generating the data in menu_items.
231 This fills in the number of items in the last pane. */
233 static void
234 finish_menu_items ()
238 /* Call when finished using the data for the current menu
239 in menu_items. */
241 static void
242 discard_menu_items ()
244 /* Free the structure if it is especially large.
245 Otherwise, hold on to it, to save time. */
246 if (menu_items_allocated > 200)
248 menu_items = Qnil;
249 menu_items_allocated = 0;
253 /* Make the menu_items vector twice as large. */
255 static void
256 grow_menu_items ()
258 Lisp_Object old;
259 int old_size = menu_items_allocated;
260 old = menu_items;
262 menu_items_allocated *= 2;
263 menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
264 bcopy (XVECTOR (old)->contents, XVECTOR (menu_items)->contents,
265 old_size * sizeof (Lisp_Object));
268 /* Begin a submenu. */
270 static void
271 push_submenu_start ()
273 if (menu_items_used + 1 > menu_items_allocated)
274 grow_menu_items ();
276 XVECTOR (menu_items)->contents[menu_items_used++] = Qnil;
277 menu_items_submenu_depth++;
280 /* End a submenu. */
282 static void
283 push_submenu_end ()
285 if (menu_items_used + 1 > menu_items_allocated)
286 grow_menu_items ();
288 XVECTOR (menu_items)->contents[menu_items_used++] = Qlambda;
289 menu_items_submenu_depth--;
292 /* Indicate boundary between left and right. */
294 static void
295 push_left_right_boundary ()
297 if (menu_items_used + 1 > menu_items_allocated)
298 grow_menu_items ();
300 XVECTOR (menu_items)->contents[menu_items_used++] = Qquote;
303 /* Start a new menu pane in menu_items..
304 NAME is the pane name. PREFIX_VEC is a prefix key for this pane. */
306 static void
307 push_menu_pane (name, prefix_vec)
308 Lisp_Object name, prefix_vec;
310 if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
311 grow_menu_items ();
313 if (menu_items_submenu_depth == 0)
314 menu_items_n_panes++;
315 XVECTOR (menu_items)->contents[menu_items_used++] = Qt;
316 XVECTOR (menu_items)->contents[menu_items_used++] = name;
317 XVECTOR (menu_items)->contents[menu_items_used++] = prefix_vec;
320 /* Push one menu item into the current pane.
321 NAME is the string to display. ENABLE if non-nil means
322 this item can be selected. KEY is the key generated by
323 choosing this item, or nil if this item doesn't really have a definition.
324 DEF is the definition of this item.
325 EQUIV is the textual description of the keyboard equivalent for
326 this item (or nil if none). */
328 static void
329 push_menu_item (name, enable, key, def, equiv)
330 Lisp_Object name, enable, key, def, equiv;
332 if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
333 grow_menu_items ();
335 XVECTOR (menu_items)->contents[menu_items_used++] = name;
336 XVECTOR (menu_items)->contents[menu_items_used++] = enable;
337 XVECTOR (menu_items)->contents[menu_items_used++] = key;
338 XVECTOR (menu_items)->contents[menu_items_used++] = equiv;
339 XVECTOR (menu_items)->contents[menu_items_used++] = def;
342 /* Figure out the current keyboard equivalent of a menu item ITEM1.
343 The item string for menu display should be ITEM_STRING.
344 Store the equivalent keyboard key sequence's
345 textual description into *DESCRIP_PTR.
346 Also cache them in the item itself.
347 Return the real definition to execute. */
349 static Lisp_Object
350 menu_item_equiv_key (item_string, item1, descrip_ptr)
351 Lisp_Object item_string;
352 Lisp_Object item1;
353 Lisp_Object *descrip_ptr;
355 /* This is the real definition--the function to run. */
356 Lisp_Object def;
357 /* This is the sublist that records cached equiv key data
358 so we can save time. */
359 Lisp_Object cachelist;
360 /* These are the saved equivalent keyboard key sequence
361 and its key-description. */
362 Lisp_Object savedkey, descrip;
363 Lisp_Object def1;
364 int changed = 0;
365 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
367 /* If a help string follows the item string, skip it. */
368 if (CONSP (XCONS (item1)->cdr)
369 && STRINGP (XCONS (XCONS (item1)->cdr)->car))
370 item1 = XCONS (item1)->cdr;
372 def = Fcdr (item1);
374 /* Get out the saved equivalent-keyboard-key info. */
375 cachelist = savedkey = descrip = Qnil;
376 if (CONSP (def) && CONSP (XCONS (def)->car)
377 && (NILP (XCONS (XCONS (def)->car)->car)
378 || VECTORP (XCONS (XCONS (def)->car)->car)))
380 cachelist = XCONS (def)->car;
381 def = XCONS (def)->cdr;
382 savedkey = XCONS (cachelist)->car;
383 descrip = XCONS (cachelist)->cdr;
386 GCPRO4 (def, def1, savedkey, descrip);
388 /* Is it still valid? */
389 def1 = Qnil;
390 if (!NILP (savedkey))
391 def1 = Fkey_binding (savedkey, Qnil);
392 /* If not, update it. */
393 if (! EQ (def1, def)
394 /* If the command is an alias for another
395 (such as easymenu.el and lmenu.el set it up),
396 check if the original command matches the cached command. */
397 && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
398 && EQ (def1, XSYMBOL (def)->function))
399 /* If something had no key binding before, don't recheck it
400 because that is too slow--except if we have a list of rebound
401 commands in Vdefine_key_rebound_commands, do recheck any command
402 that appears in that list. */
403 && (NILP (cachelist) || !NILP (savedkey)
404 || (! EQ (Qt, Vdefine_key_rebound_commands)
405 && !NILP (Fmemq (def, Vdefine_key_rebound_commands)))))
407 changed = 1;
408 descrip = Qnil;
409 /* If the command is an alias for another
410 (such as easymenu.el and lmenu.el set it up),
411 see if the original command name has equivalent keys. */
412 if (SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
413 && ! NILP (Fget (def, Qmenu_alias)))
414 savedkey = Fwhere_is_internal (XSYMBOL (def)->function,
415 Qnil, Qt, Qnil);
416 else
417 /* Otherwise look up the specified command itself.
418 We don't try both, because that makes easymenu menus slow. */
419 savedkey = Fwhere_is_internal (def, Qnil, Qt, Qnil);
421 if (!NILP (savedkey))
423 descrip = Fkey_description (savedkey);
424 descrip = concat2 (make_string (" (", 3), descrip);
425 descrip = concat2 (descrip, make_string (")", 1));
429 /* Cache the data we just got in a sublist of the menu binding. */
430 if (NILP (cachelist))
432 CHECK_IMPURE (item1);
433 XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
435 else if (changed)
437 XCONS (cachelist)->car = savedkey;
438 XCONS (cachelist)->cdr = descrip;
441 UNGCPRO;
442 *descrip_ptr = descrip;
443 return def;
446 /* This is used as the handler when calling internal_condition_case_1. */
448 static Lisp_Object
449 menu_item_enabled_p_1 (arg)
450 Lisp_Object arg;
452 /* If we got a quit from within the menu computation,
453 quit all the way out of it. This takes care of C-] in the debugger. */
454 if (CONSP (arg) && EQ (XCONS (arg)->car, Qquit))
455 Fsignal (Qquit, Qnil);
457 return Qnil;
460 /* Return non-nil if the command DEF is enabled when used as a menu item.
461 This is based on looking for a menu-enable property.
462 If NOTREAL is set, don't bother really computing this. */
464 static Lisp_Object
465 menu_item_enabled_p (def, notreal)
466 Lisp_Object def;
467 int notreal;
469 Lisp_Object enabled, tem;
471 enabled = Qt;
472 if (notreal)
473 return enabled;
474 if (SYMBOLP (def))
476 /* No property, or nil, means enable.
477 Otherwise, enable if value is not nil. */
478 tem = Fget (def, Qmenu_enable);
479 if (!NILP (tem))
480 /* (condition-case nil (eval tem)
481 (error nil)) */
482 enabled = internal_condition_case_1 (Feval, tem, Qerror,
483 menu_item_enabled_p_1);
485 return enabled;
488 /* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
489 and generate menu panes for them in menu_items.
490 If NOTREAL is nonzero,
491 don't bother really computing whether an item is enabled. */
493 static void
494 keymap_panes (keymaps, nmaps, notreal)
495 Lisp_Object *keymaps;
496 int nmaps;
497 int notreal;
499 int mapno;
501 init_menu_items ();
503 /* Loop over the given keymaps, making a pane for each map.
504 But don't make a pane that is empty--ignore that map instead.
505 P is the number of panes we have made so far. */
506 for (mapno = 0; mapno < nmaps; mapno++)
507 single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal, 10);
509 finish_menu_items ();
512 /* This is a recursive subroutine of keymap_panes.
513 It handles one keymap, KEYMAP.
514 The other arguments are passed along
515 or point to local variables of the previous function.
516 If NOTREAL is nonzero,
517 don't bother really computing whether an item is enabled.
519 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
521 static void
522 single_keymap_panes (keymap, pane_name, prefix, notreal, maxdepth)
523 Lisp_Object keymap;
524 Lisp_Object pane_name;
525 Lisp_Object prefix;
526 int notreal;
527 int maxdepth;
529 Lisp_Object pending_maps;
530 Lisp_Object tail, item, item1, item_string, table;
531 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
533 if (maxdepth <= 0)
534 return;
536 pending_maps = Qnil;
538 push_menu_pane (pane_name, prefix);
540 for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
542 /* Look at each key binding, and if it has a menu string,
543 make a menu item from it. */
544 item = XCONS (tail)->car;
545 if (CONSP (item))
547 item1 = XCONS (item)->cdr;
548 if (CONSP (item1))
550 item_string = XCONS (item1)->car;
551 if (STRINGP (item_string))
553 /* This is the real definition--the function to run. */
554 Lisp_Object def;
555 /* These are the saved equivalent keyboard key sequence
556 and its key-description. */
557 Lisp_Object descrip;
558 Lisp_Object tem, enabled;
560 /* GCPRO because ...enabled_p will call eval
561 and ..._equiv_key may autoload something.
562 Protecting KEYMAP preserves everything we use;
563 aside from that, must protect whatever might be
564 a string. Since there's no GCPRO5, we refetch
565 item_string instead of protecting it. */
566 descrip = def = Qnil;
567 GCPRO4 (keymap, pending_maps, def, descrip);
569 def = menu_item_equiv_key (item_string, item1, &descrip);
570 enabled = menu_item_enabled_p (def, notreal);
572 UNGCPRO;
574 item_string = XCONS (item1)->car;
576 tem = Fkeymapp (def);
577 if (XSTRING (item_string)->data[0] == '@' && !NILP (tem))
578 pending_maps = Fcons (Fcons (def, Fcons (item_string, XCONS (item)->car)),
579 pending_maps);
580 else
582 Lisp_Object submap;
583 GCPRO4 (keymap, pending_maps, descrip, item_string);
584 submap = get_keymap_1 (def, 0, 1);
585 UNGCPRO;
586 #ifndef USE_X_TOOLKIT
587 /* Indicate visually that this is a submenu. */
588 if (!NILP (submap))
589 item_string = concat2 (item_string,
590 build_string (" >"));
591 #endif
592 /* If definition is nil, pass nil as the key. */
593 push_menu_item (item_string, enabled,
594 XCONS (item)->car, def,
595 descrip);
596 #ifdef USE_X_TOOLKIT
597 /* Display a submenu using the toolkit. */
598 if (! NILP (submap))
600 push_submenu_start ();
601 single_keymap_panes (submap, Qnil,
602 XCONS (item)->car, notreal,
603 maxdepth - 1);
604 push_submenu_end ();
606 #endif
611 else if (VECTORP (item))
613 /* Loop over the char values represented in the vector. */
614 int len = XVECTOR (item)->size;
615 int c;
616 for (c = 0; c < len; c++)
618 Lisp_Object character;
619 XSETFASTINT (character, c);
620 item1 = XVECTOR (item)->contents[c];
621 if (CONSP (item1))
623 item_string = XCONS (item1)->car;
624 if (STRINGP (item_string))
626 Lisp_Object def;
628 /* These are the saved equivalent keyboard key sequence
629 and its key-description. */
630 Lisp_Object descrip;
631 Lisp_Object tem, enabled;
633 /* GCPRO because ...enabled_p will call eval
634 and ..._equiv_key may autoload something.
635 Protecting KEYMAP preserves everything we use;
636 aside from that, must protect whatever might be
637 a string. Since there's no GCPRO5, we refetch
638 item_string instead of protecting it. */
639 GCPRO4 (keymap, pending_maps, def, descrip);
640 descrip = def = Qnil;
642 def = menu_item_equiv_key (item_string, item1, &descrip);
643 enabled = menu_item_enabled_p (def, notreal);
645 UNGCPRO;
647 item_string = XCONS (item1)->car;
649 tem = Fkeymapp (def);
650 if (XSTRING (item_string)->data[0] == '@' && !NILP (tem))
651 pending_maps = Fcons (Fcons (def, Fcons (item_string, character)),
652 pending_maps);
653 else
655 Lisp_Object submap;
656 GCPRO4 (keymap, pending_maps, descrip, item_string);
657 submap = get_keymap_1 (def, 0, 1);
658 UNGCPRO;
659 #ifndef USE_X_TOOLKIT
660 if (!NILP (submap))
661 item_string = concat2 (item_string,
662 build_string (" >"));
663 #endif
664 /* If definition is nil, pass nil as the key. */
665 push_menu_item (item_string, enabled, character,
666 def, descrip);
667 #ifdef USE_X_TOOLKIT
668 if (! NILP (submap))
670 push_submenu_start ();
671 single_keymap_panes (submap, Qnil,
672 character, notreal,
673 maxdepth - 1);
674 push_submenu_end ();
676 #endif
684 /* Process now any submenus which want to be panes at this level. */
685 while (!NILP (pending_maps))
687 Lisp_Object elt, eltcdr, string;
688 elt = Fcar (pending_maps);
689 eltcdr = XCONS (elt)->cdr;
690 string = XCONS (eltcdr)->car;
691 /* We no longer discard the @ from the beginning of the string here.
692 Instead, we do this in xmenu_show. */
693 single_keymap_panes (Fcar (elt), string,
694 XCONS (eltcdr)->cdr, notreal, maxdepth - 1);
695 pending_maps = Fcdr (pending_maps);
699 /* Push all the panes and items of a menu described by the
700 alist-of-alists MENU.
701 This handles old-fashioned calls to x-popup-menu. */
703 static void
704 list_of_panes (menu)
705 Lisp_Object menu;
707 Lisp_Object tail;
709 init_menu_items ();
711 for (tail = menu; !NILP (tail); tail = Fcdr (tail))
713 Lisp_Object elt, pane_name, pane_data;
714 elt = Fcar (tail);
715 pane_name = Fcar (elt);
716 CHECK_STRING (pane_name, 0);
717 push_menu_pane (pane_name, Qnil);
718 pane_data = Fcdr (elt);
719 CHECK_CONS (pane_data, 0);
720 list_of_items (pane_data);
723 finish_menu_items ();
726 /* Push the items in a single pane defined by the alist PANE. */
728 static void
729 list_of_items (pane)
730 Lisp_Object pane;
732 Lisp_Object tail, item, item1;
734 for (tail = pane; !NILP (tail); tail = Fcdr (tail))
736 item = Fcar (tail);
737 if (STRINGP (item))
738 push_menu_item (item, Qnil, Qnil, Qt, Qnil);
739 else if (NILP (item))
740 push_left_right_boundary ();
741 else
743 CHECK_CONS (item, 0);
744 item1 = Fcar (item);
745 CHECK_STRING (item1, 1);
746 push_menu_item (item1, Qt, Fcdr (item), Qt, Qnil);
751 DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
752 "Pop up a deck-of-cards menu and return user's selection.\n\
753 POSITION is a position specification. This is either a mouse button event\n\
754 or a list ((XOFFSET YOFFSET) WINDOW)\n\
755 where XOFFSET and YOFFSET are positions in pixels from the top left\n\
756 corner of WINDOW's frame. (WINDOW may be a frame object instead of a window.)\n\
757 This controls the position of the center of the first line\n\
758 in the first pane of the menu, not the top left of the menu as a whole.\n\
759 If POSITION is t, it means to use the current mouse position.\n\
761 MENU is a specifier for a menu. For the simplest case, MENU is a keymap.\n\
762 The menu items come from key bindings that have a menu string as well as\n\
763 a definition; actually, the \"definition\" in such a key binding looks like\n\
764 \(STRING . REAL-DEFINITION). To give the menu a title, put a string into\n\
765 the keymap as a top-level element.\n\n\
766 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.\n\
767 Otherwise, REAL-DEFINITION should be a valid key binding definition.\n\
769 You can also use a list of keymaps as MENU.\n\
770 Then each keymap makes a separate pane.\n\
771 When MENU is a keymap or a list of keymaps, the return value\n\
772 is a list of events.\n\n\
774 Alternatively, you can specify a menu of multiple panes\n\
775 with a list of the form (TITLE PANE1 PANE2...),\n\
776 where each pane is a list of form (TITLE ITEM1 ITEM2...).\n\
777 Each ITEM is normally a cons cell (STRING . VALUE);\n\
778 but a string can appear as an item--that makes a nonselectable line\n\
779 in the menu.\n\
780 With this form of menu, the return value is VALUE from the chosen item.\n\
782 If POSITION is nil, don't display the menu at all, just precalculate the\n\
783 cached information about equivalent key sequences.")
784 (position, menu)
785 Lisp_Object position, menu;
787 int number_of_panes, panes;
788 Lisp_Object keymap, tem;
789 int xpos, ypos;
790 Lisp_Object title;
791 char *error_name;
792 Lisp_Object selection;
793 int i, j;
794 FRAME_PTR f;
795 Lisp_Object x, y, window;
796 int keymaps = 0;
797 int for_click = 0;
798 struct gcpro gcpro1;
800 #ifdef HAVE_MENUS
801 if (! NILP (position))
803 check_x ();
805 /* Decode the first argument: find the window and the coordinates. */
806 if (EQ (position, Qt)
807 || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
809 /* Use the mouse's current position. */
810 FRAME_PTR new_f = selected_frame;
811 Lisp_Object bar_window;
812 int part;
813 unsigned long time;
815 if (mouse_position_hook)
816 (*mouse_position_hook) (&new_f, 1, &bar_window,
817 &part, &x, &y, &time);
818 if (new_f != 0)
819 XSETFRAME (window, new_f);
820 else
822 window = selected_window;
823 XSETFASTINT (x, 0);
824 XSETFASTINT (y, 0);
827 else
829 tem = Fcar (position);
830 if (CONSP (tem))
832 window = Fcar (Fcdr (position));
833 x = Fcar (tem);
834 y = Fcar (Fcdr (tem));
836 else
838 for_click = 1;
839 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
840 window = Fcar (tem); /* POSN_WINDOW (tem) */
841 tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */
842 x = Fcar (tem);
843 y = Fcdr (tem);
847 CHECK_NUMBER (x, 0);
848 CHECK_NUMBER (y, 0);
850 /* Decode where to put the menu. */
852 if (FRAMEP (window))
854 f = XFRAME (window);
855 xpos = 0;
856 ypos = 0;
858 else if (WINDOWP (window))
860 CHECK_LIVE_WINDOW (window, 0);
861 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
863 xpos = (FONT_WIDTH (f->output_data.x->font)
864 * XFASTINT (XWINDOW (window)->left));
865 ypos = (f->output_data.x->line_height
866 * XFASTINT (XWINDOW (window)->top));
868 else
869 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
870 but I don't want to make one now. */
871 CHECK_WINDOW (window, 0);
873 xpos += XINT (x);
874 ypos += XINT (y);
876 XSETFRAME (Vmenu_updating_frame, f);
878 Vmenu_updating_frame = Qnil;
879 #endif /* HAVE_MENUS */
881 title = Qnil;
882 GCPRO1 (title);
884 /* Decode the menu items from what was specified. */
886 keymap = Fkeymapp (menu);
887 tem = Qnil;
888 if (CONSP (menu))
889 tem = Fkeymapp (Fcar (menu));
890 if (!NILP (keymap))
892 /* We were given a keymap. Extract menu info from the keymap. */
893 Lisp_Object prompt;
894 keymap = get_keymap (menu);
896 /* Extract the detailed info to make one pane. */
897 keymap_panes (&menu, 1, NILP (position));
899 /* Search for a string appearing directly as an element of the keymap.
900 That string is the title of the menu. */
901 prompt = map_prompt (keymap);
902 if (NILP (title) && !NILP (prompt))
903 title = prompt;
905 /* Make that be the pane title of the first pane. */
906 if (!NILP (prompt) && menu_items_n_panes >= 0)
907 XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME] = prompt;
909 keymaps = 1;
911 else if (!NILP (tem))
913 /* We were given a list of keymaps. */
914 int nmaps = XFASTINT (Flength (menu));
915 Lisp_Object *maps
916 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
917 int i;
919 title = Qnil;
921 /* The first keymap that has a prompt string
922 supplies the menu title. */
923 for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
925 Lisp_Object prompt;
927 maps[i++] = keymap = get_keymap (Fcar (tem));
929 prompt = map_prompt (keymap);
930 if (NILP (title) && !NILP (prompt))
931 title = prompt;
934 /* Extract the detailed info to make one pane. */
935 keymap_panes (maps, nmaps, NILP (position));
937 /* Make the title be the pane title of the first pane. */
938 if (!NILP (title) && menu_items_n_panes >= 0)
939 XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME] = title;
941 keymaps = 1;
943 else
945 /* We were given an old-fashioned menu. */
946 title = Fcar (menu);
947 CHECK_STRING (title, 1);
949 list_of_panes (Fcdr (menu));
951 keymaps = 0;
954 if (NILP (position))
956 discard_menu_items ();
957 UNGCPRO;
958 return Qnil;
961 #ifdef HAVE_MENUS
962 /* Display them in a menu. */
963 BLOCK_INPUT;
965 selection = xmenu_show (f, xpos, ypos, for_click,
966 keymaps, title, &error_name);
967 UNBLOCK_INPUT;
969 discard_menu_items ();
971 UNGCPRO;
972 #endif /* HAVE_MENUS */
974 if (error_name) error (error_name);
975 return selection;
978 #ifdef HAVE_MENUS
980 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
981 "Pop up a dialog box and return user's selection.\n\
982 POSITION specifies which frame to use.\n\
983 This is normally a mouse button event or a window or frame.\n\
984 If POSITION is t, it means to use the frame the mouse is on.\n\
985 The dialog box appears in the middle of the specified frame.\n\
987 CONTENTS specifies the alternatives to display in the dialog box.\n\
988 It is a list of the form (TITLE ITEM1 ITEM2...).\n\
989 Each ITEM is a cons cell (STRING . VALUE).\n\
990 The return value is VALUE from the chosen item.\n\n\
991 An ITEM may also be just a string--that makes a nonselectable item.\n\
992 An ITEM may also be nil--that means to put all preceding items\n\
993 on the left of the dialog box and all following items on the right.\n\
994 \(By default, approximately half appear on each side.)")
995 (position, contents)
996 Lisp_Object position, contents;
998 FRAME_PTR f;
999 Lisp_Object window;
1001 check_x ();
1003 /* Decode the first argument: find the window or frame to use. */
1004 if (EQ (position, Qt)
1005 || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
1007 #if 0 /* Using the frame the mouse is on may not be right. */
1008 /* Use the mouse's current position. */
1009 FRAME_PTR new_f = selected_frame;
1010 Lisp_Object bar_window;
1011 int part;
1012 unsigned long time;
1013 Lisp_Object x, y;
1015 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
1017 if (new_f != 0)
1018 XSETFRAME (window, new_f);
1019 else
1020 window = selected_window;
1021 #endif
1022 window = selected_window;
1024 else if (CONSP (position))
1026 Lisp_Object tem;
1027 tem = Fcar (position);
1028 if (CONSP (tem))
1029 window = Fcar (Fcdr (position));
1030 else
1032 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
1033 window = Fcar (tem); /* POSN_WINDOW (tem) */
1036 else if (WINDOWP (position) || FRAMEP (position))
1037 window = position;
1038 else
1039 window = Qnil;
1041 /* Decode where to put the menu. */
1043 if (FRAMEP (window))
1044 f = XFRAME (window);
1045 else if (WINDOWP (window))
1047 CHECK_LIVE_WINDOW (window, 0);
1048 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1050 else
1051 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
1052 but I don't want to make one now. */
1053 CHECK_WINDOW (window, 0);
1055 #ifndef USE_X_TOOLKIT
1056 /* Display a menu with these alternatives
1057 in the middle of frame F. */
1059 Lisp_Object x, y, frame, newpos;
1060 XSETFRAME (frame, f);
1061 XSETINT (x, x_pixel_width (f) / 2);
1062 XSETINT (y, x_pixel_height (f) / 2);
1063 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
1065 return Fx_popup_menu (newpos,
1066 Fcons (Fcar (contents), Fcons (contents, Qnil)));
1068 #else
1070 Lisp_Object title;
1071 char *error_name;
1072 Lisp_Object selection;
1074 /* Decode the dialog items from what was specified. */
1075 title = Fcar (contents);
1076 CHECK_STRING (title, 1);
1078 list_of_panes (Fcons (contents, Qnil));
1080 /* Display them in a dialog box. */
1081 BLOCK_INPUT;
1082 selection = xdialog_show (f, 0, title, &error_name);
1083 UNBLOCK_INPUT;
1085 discard_menu_items ();
1087 if (error_name) error (error_name);
1088 return selection;
1090 #endif
1093 #ifdef USE_X_TOOLKIT
1095 /* Loop in Xt until the menu pulldown or dialog popup has been
1096 popped down (deactivated). This is used for x-popup-menu
1097 and x-popup-dialog; it is not used for the menu bar any more.
1099 NOTE: All calls to popup_get_selection should be protected
1100 with BLOCK_INPUT, UNBLOCK_INPUT wrappers. */
1102 void
1103 popup_get_selection (initial_event, dpyinfo, id)
1104 XEvent *initial_event;
1105 struct x_display_info *dpyinfo;
1106 LWLIB_ID id;
1108 XEvent event;
1110 /* Define a queue to save up for later unreading
1111 all X events that don't pertain to the menu. */
1112 struct event_queue
1114 XEvent event;
1115 struct event_queue *next;
1118 struct event_queue *queue = NULL;
1119 struct event_queue *queue_tmp;
1121 if (initial_event)
1122 event = *initial_event;
1123 else
1124 XtAppNextEvent (Xt_app_con, &event);
1126 while (1)
1128 /* Handle expose events for editor frames right away. */
1129 if (event.type == Expose)
1130 process_expose_from_menu (event);
1131 /* Make sure we don't consider buttons grabbed after menu goes.
1132 And make sure to deactivate for any ButtonRelease,
1133 even if XtDispatchEvent doesn't do that. */
1134 else if (event.type == ButtonRelease
1135 && dpyinfo->display == event.xbutton.display)
1137 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
1138 popup_activated_flag = 0;
1139 #ifdef USE_MOTIF /* Pretending that the event came from a
1140 Btn1Down seems the only way to convince Motif to
1141 activate its callbacks; setting the XmNmenuPost
1142 isn't working. --marcus@sysc.pdx.edu. */
1143 event.xbutton.button = 1;
1144 #endif
1146 /* If the user presses a key, deactivate the menu.
1147 The user is likely to do that if we get wedged. */
1148 else if (event.type == KeyPress
1149 && dpyinfo->display == event.xbutton.display)
1151 popup_activated_flag = 0;
1152 break;
1154 /* Button presses outside the menu also pop it down. */
1155 else if (event.type == ButtonPress
1156 && event.xany.display == dpyinfo->display
1157 && x_any_window_to_frame (dpyinfo, event.xany.window))
1159 popup_activated_flag = 0;
1160 break;
1163 /* Queue all events not for this popup,
1164 except for Expose, which we've already handled, and ButtonRelease.
1165 Note that the X window is associated with the frame if this
1166 is a menu bar popup, but not if it's a dialog box. So we use
1167 x_non_menubar_window_to_frame, not x_any_window_to_frame. */
1168 if (event.type != Expose
1169 && !(event.type == ButtonRelease
1170 && dpyinfo->display == event.xbutton.display)
1171 && (event.xany.display != dpyinfo->display
1172 || x_non_menubar_window_to_frame (dpyinfo, event.xany.window)))
1174 queue_tmp = (struct event_queue *) malloc (sizeof (struct event_queue));
1176 if (queue_tmp != NULL)
1178 queue_tmp->event = event;
1179 queue_tmp->next = queue;
1180 queue = queue_tmp;
1183 else
1184 XtDispatchEvent (&event);
1186 if (!popup_activated ())
1187 break;
1188 XtAppNextEvent (Xt_app_con, &event);
1191 /* Unread any events that we got but did not handle. */
1192 while (queue != NULL)
1194 queue_tmp = queue;
1195 XPutBackEvent (queue_tmp->event.xany.display, &queue_tmp->event);
1196 queue = queue_tmp->next;
1197 free ((char *)queue_tmp);
1198 /* Cause these events to get read as soon as we UNBLOCK_INPUT. */
1199 interrupt_input_pending = 1;
1203 /* Activate the menu bar of frame F.
1204 This is called from keyboard.c when it gets the
1205 menu_bar_activate_event out of the Emacs event queue.
1207 To activate the menu bar, we use the X button-press event
1208 that was saved in saved_menu_event.
1209 That makes the toolkit do its thing.
1211 But first we recompute the menu bar contents (the whole tree).
1213 The reason for saving the button event until here, instead of
1214 passing it to the toolkit right away, is that we can safely
1215 execute Lisp code. */
1217 x_activate_menubar (f)
1218 FRAME_PTR f;
1220 if (!f->output_data.x->saved_menu_event->type)
1221 return;
1223 set_frame_menubar (f, 0, 1);
1224 BLOCK_INPUT;
1225 XtDispatchEvent ((XEvent *) f->output_data.x->saved_menu_event);
1226 UNBLOCK_INPUT;
1227 #ifdef USE_MOTIF
1228 if (f->output_data.x->saved_menu_event->type == ButtonRelease)
1229 pending_menu_activation = 1;
1230 #endif
1232 /* Ignore this if we get it a second time. */
1233 f->output_data.x->saved_menu_event->type = 0;
1236 /* Detect if a dialog or menu has been posted. */
1239 popup_activated ()
1241 return popup_activated_flag;
1245 /* This callback is invoked when the user selects a menubar cascade
1246 pushbutton, but before the pulldown menu is posted. */
1248 static void
1249 popup_activate_callback (widget, id, client_data)
1250 Widget widget;
1251 LWLIB_ID id;
1252 XtPointer client_data;
1254 popup_activated_flag = 1;
1257 /* This callback is called from the menu bar pulldown menu
1258 when the user makes a selection.
1259 Figure out what the user chose
1260 and put the appropriate events into the keyboard buffer. */
1262 static void
1263 menubar_selection_callback (widget, id, client_data)
1264 Widget widget;
1265 LWLIB_ID id;
1266 XtPointer client_data;
1268 Lisp_Object prefix, entry;
1269 FRAME_PTR f = menubar_id_to_frame (id);
1270 Lisp_Object vector;
1271 Lisp_Object *subprefix_stack;
1272 int submenu_depth = 0;
1273 int i;
1275 if (!f)
1276 return;
1277 subprefix_stack = (Lisp_Object *) alloca (f->menu_bar_items_used * sizeof (Lisp_Object));
1278 vector = f->menu_bar_vector;
1279 prefix = Qnil;
1280 i = 0;
1281 while (i < f->menu_bar_items_used)
1283 if (EQ (XVECTOR (vector)->contents[i], Qnil))
1285 subprefix_stack[submenu_depth++] = prefix;
1286 prefix = entry;
1287 i++;
1289 else if (EQ (XVECTOR (vector)->contents[i], Qlambda))
1291 prefix = subprefix_stack[--submenu_depth];
1292 i++;
1294 else if (EQ (XVECTOR (vector)->contents[i], Qt))
1296 prefix = XVECTOR (vector)->contents[i + MENU_ITEMS_PANE_PREFIX];
1297 i += MENU_ITEMS_PANE_LENGTH;
1299 else
1301 entry = XVECTOR (vector)->contents[i + MENU_ITEMS_ITEM_VALUE];
1302 /* The EMACS_INT cast avoids a warning. There's no problem
1303 as long as pointers have enough bits to hold small integers. */
1304 if ((int) (EMACS_INT) client_data == i)
1306 int j;
1307 struct input_event buf;
1308 Lisp_Object frame;
1310 XSETFRAME (frame, f);
1311 buf.kind = menu_bar_event;
1312 buf.frame_or_window = Fcons (frame, Fcons (Qmenu_bar, Qnil));
1313 kbd_buffer_store_event (&buf);
1315 for (j = 0; j < submenu_depth; j++)
1316 if (!NILP (subprefix_stack[j]))
1318 buf.kind = menu_bar_event;
1319 buf.frame_or_window = Fcons (frame, subprefix_stack[j]);
1320 kbd_buffer_store_event (&buf);
1323 if (!NILP (prefix))
1325 buf.kind = menu_bar_event;
1326 buf.frame_or_window = Fcons (frame, prefix);
1327 kbd_buffer_store_event (&buf);
1330 buf.kind = menu_bar_event;
1331 buf.frame_or_window = Fcons (frame, entry);
1332 kbd_buffer_store_event (&buf);
1334 return;
1336 i += MENU_ITEMS_ITEM_LENGTH;
1341 /* This callback is invoked when a dialog or menu is finished being
1342 used and has been unposted. */
1344 static void
1345 popup_deactivate_callback (widget, id, client_data)
1346 Widget widget;
1347 LWLIB_ID id;
1348 XtPointer client_data;
1350 popup_activated_flag = 0;
1353 /* Allocate a widget_value, blocking input. */
1355 widget_value *
1356 xmalloc_widget_value ()
1358 widget_value *value;
1360 BLOCK_INPUT;
1361 value = malloc_widget_value ();
1362 UNBLOCK_INPUT;
1364 return value;
1367 /* This recursively calls free_widget_value on the tree of widgets.
1368 It must free all data that was malloc'ed for these widget_values.
1369 In Emacs, many slots are pointers into the data of Lisp_Strings, and
1370 must be left alone. */
1372 void
1373 free_menubar_widget_value_tree (wv)
1374 widget_value *wv;
1376 if (! wv) return;
1378 wv->name = wv->value = wv->key = (char *) 0xDEADBEEF;
1380 if (wv->contents && (wv->contents != (widget_value*)1))
1382 free_menubar_widget_value_tree (wv->contents);
1383 wv->contents = (widget_value *) 0xDEADBEEF;
1385 if (wv->next)
1387 free_menubar_widget_value_tree (wv->next);
1388 wv->next = (widget_value *) 0xDEADBEEF;
1390 BLOCK_INPUT;
1391 free_widget_value (wv);
1392 UNBLOCK_INPUT;
1395 /* Return a tree of widget_value structures for a menu bar item
1396 whose event type is ITEM_KEY (with string ITEM_NAME)
1397 and whose contents come from the list of keymaps MAPS. */
1399 static widget_value *
1400 single_submenu (item_key, item_name, maps)
1401 Lisp_Object item_key, item_name, maps;
1403 widget_value *wv, *prev_wv, *save_wv, *first_wv;
1404 int i;
1405 int submenu_depth = 0;
1406 Lisp_Object length;
1407 int len;
1408 Lisp_Object *mapvec;
1409 widget_value **submenu_stack;
1410 int mapno;
1411 int previous_items = menu_items_used;
1412 int top_level_items = 0;
1414 length = Flength (maps);
1415 len = XINT (length);
1417 /* Convert the list MAPS into a vector MAPVEC. */
1418 mapvec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));
1419 for (i = 0; i < len; i++)
1421 mapvec[i] = Fcar (maps);
1422 maps = Fcdr (maps);
1425 menu_items_n_panes = 0;
1427 /* Loop over the given keymaps, making a pane for each map.
1428 But don't make a pane that is empty--ignore that map instead. */
1429 for (i = 0; i < len; i++)
1431 if (SYMBOLP (mapvec[i])
1432 || (CONSP (mapvec[i])
1433 && NILP (Fkeymapp (mapvec[i]))))
1435 /* Here we have a command at top level in the menu bar
1436 as opposed to a submenu. */
1437 top_level_items = 1;
1438 push_menu_pane (Qnil, Qnil);
1439 push_menu_item (item_name, Qt, item_key, mapvec[i], Qnil);
1441 else
1442 single_keymap_panes (mapvec[i], item_name, item_key, 0, 10);
1445 /* Create a tree of widget_value objects
1446 representing the panes and their items. */
1448 submenu_stack
1449 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1450 wv = xmalloc_widget_value ();
1451 wv->name = "menu";
1452 wv->value = 0;
1453 wv->enabled = 1;
1454 first_wv = wv;
1455 save_wv = 0;
1456 prev_wv = 0;
1458 /* Loop over all panes and items made during this call
1459 and construct a tree of widget_value objects.
1460 Ignore the panes and items made by previous calls to
1461 single_submenu, even though those are also in menu_items. */
1462 i = previous_items;
1463 while (i < menu_items_used)
1465 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1467 submenu_stack[submenu_depth++] = save_wv;
1468 save_wv = prev_wv;
1469 prev_wv = 0;
1470 i++;
1472 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
1474 prev_wv = save_wv;
1475 save_wv = submenu_stack[--submenu_depth];
1476 i++;
1478 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
1479 && submenu_depth != 0)
1480 i += MENU_ITEMS_PANE_LENGTH;
1481 /* Ignore a nil in the item list.
1482 It's meaningful only for dialog boxes. */
1483 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
1484 i += 1;
1485 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
1487 /* Create a new pane. */
1488 Lisp_Object pane_name, prefix;
1489 char *pane_string;
1490 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
1491 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
1492 pane_string = (NILP (pane_name)
1493 ? "" : (char *) XSTRING (pane_name)->data);
1494 /* If there is just one top-level pane, put all its items directly
1495 under the top-level menu. */
1496 if (menu_items_n_panes == 1)
1497 pane_string = "";
1499 /* If the pane has a meaningful name,
1500 make the pane a top-level menu item
1501 with its items as a submenu beneath it. */
1502 if (strcmp (pane_string, ""))
1504 wv = xmalloc_widget_value ();
1505 if (save_wv)
1506 save_wv->next = wv;
1507 else
1508 first_wv->contents = wv;
1509 wv->name = pane_string;
1510 /* Ignore the @ that means "separate pane".
1511 This is a kludge, but this isn't worth more time. */
1512 if (!NILP (prefix) && wv->name[0] == '@')
1513 wv->name++;
1514 wv->value = 0;
1515 wv->enabled = 1;
1517 save_wv = wv;
1518 prev_wv = 0;
1519 i += MENU_ITEMS_PANE_LENGTH;
1521 else
1523 /* Create a new item within current pane. */
1524 Lisp_Object item_name, enable, descrip, def;
1525 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
1526 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
1527 descrip
1528 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
1529 def = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_DEFINITION];
1531 wv = xmalloc_widget_value ();
1532 if (prev_wv)
1533 prev_wv->next = wv;
1534 else
1535 save_wv->contents = wv;
1537 wv->name = (char *) XSTRING (item_name)->data;
1538 if (!NILP (descrip))
1539 wv->key = (char *) XSTRING (descrip)->data;
1540 wv->value = 0;
1541 /* The EMACS_INT cast avoids a warning. There's no problem
1542 as long as pointers have enough bits to hold small integers. */
1543 wv->call_data = (!NILP (def) ? (void *) (EMACS_INT) i : 0);
1544 wv->enabled = !NILP (enable);
1545 prev_wv = wv;
1547 i += MENU_ITEMS_ITEM_LENGTH;
1551 /* If we have just one "menu item"
1552 that was originally a button, return it by itself. */
1553 if (top_level_items && first_wv->contents && first_wv->contents->next == 0)
1555 wv = first_wv->contents;
1556 free_widget_value (first_wv);
1557 return wv;
1560 return first_wv;
1563 extern void EmacsFrameSetCharSize ();
1565 /* Recompute all the widgets of frame F, when the menu bar
1566 has been changed. */
1568 static void
1569 update_frame_menubar (f)
1570 FRAME_PTR f;
1572 struct x_output *x = f->output_data.x;
1573 int columns, rows;
1574 int menubar_changed;
1576 Dimension shell_height;
1578 /* We assume the menubar contents has changed if the global flag is set,
1579 or if the current buffer has changed, or if the menubar has never
1580 been updated before.
1582 menubar_changed = (x->menubar_widget
1583 && !XtIsManaged (x->menubar_widget));
1585 if (! (menubar_changed))
1586 return;
1588 BLOCK_INPUT;
1589 /* Save the size of the frame because the pane widget doesn't accept to
1590 resize itself. So force it. */
1591 columns = f->width;
1592 rows = f->height;
1594 /* Do the voodoo which means "I'm changing lots of things, don't try to
1595 refigure sizes until I'm done." */
1596 lw_refigure_widget (x->column_widget, False);
1598 /* the order in which children are managed is the top to
1599 bottom order in which they are displayed in the paned window.
1600 First, remove the text-area widget.
1602 XtUnmanageChild (x->edit_widget);
1604 /* remove the menubar that is there now, and put up the menubar that
1605 should be there.
1607 if (menubar_changed)
1609 XtManageChild (x->menubar_widget);
1610 XtMapWidget (x->menubar_widget);
1611 XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, 0);
1614 /* Re-manage the text-area widget, and then thrash the sizes. */
1615 XtManageChild (x->edit_widget);
1616 lw_refigure_widget (x->column_widget, True);
1618 /* Force the pane widget to resize itself with the right values. */
1619 EmacsFrameSetCharSize (x->edit_widget, columns, rows);
1621 UNBLOCK_INPUT;
1624 /* Set the contents of the menubar widgets of frame F.
1625 The argument FIRST_TIME is currently ignored;
1626 it is set the first time this is called, from initialize_frame_menubar. */
1628 void
1629 set_frame_menubar (f, first_time, deep_p)
1630 FRAME_PTR f;
1631 int first_time;
1632 int deep_p;
1634 Widget menubar_widget = f->output_data.x->menubar_widget;
1635 Lisp_Object tail, items, frame;
1636 widget_value *wv, *first_wv, *prev_wv = 0;
1637 int i;
1638 LWLIB_ID id;
1640 XSETFRAME (Vmenu_updating_frame, f);
1642 if (f->output_data.x->id == 0)
1643 f->output_data.x->id = next_menubar_widget_id++;
1644 id = f->output_data.x->id;
1646 if (! menubar_widget)
1647 deep_p = 1;
1648 else if (pending_menu_activation && !deep_p)
1649 deep_p = 1;
1650 /* Make the first call for any given frame always go deep. */
1651 else if (!f->output_data.x->saved_menu_event && !deep_p)
1653 deep_p = 1;
1654 f->output_data.x->saved_menu_event = (XEvent*)xmalloc (sizeof (XEvent));
1655 f->output_data.x->saved_menu_event->type = 0;
1658 wv = xmalloc_widget_value ();
1659 wv->name = "menubar";
1660 wv->value = 0;
1661 wv->enabled = 1;
1662 first_wv = wv;
1664 if (deep_p)
1666 /* Make a widget-value tree representing the entire menu trees. */
1668 struct buffer *prev = current_buffer;
1669 Lisp_Object buffer;
1670 int specpdl_count = specpdl_ptr - specpdl;
1671 int previous_menu_items_used = f->menu_bar_items_used;
1672 Lisp_Object *previous_items
1673 = (Lisp_Object *) alloca (previous_menu_items_used
1674 * sizeof (Lisp_Object));
1676 /* If we are making a new widget, its contents are empty,
1677 do always reinitialize them. */
1678 if (! menubar_widget)
1679 previous_menu_items_used = 0;
1681 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
1682 specbind (Qinhibit_quit, Qt);
1683 /* Don't let the debugger step into this code
1684 because it is not reentrant. */
1685 specbind (Qdebug_on_next_call, Qnil);
1687 record_unwind_protect (Fstore_match_data, Fmatch_data (Qnil, Qnil));
1688 if (NILP (Voverriding_local_map_menu_flag))
1690 specbind (Qoverriding_terminal_local_map, Qnil);
1691 specbind (Qoverriding_local_map, Qnil);
1694 set_buffer_internal_1 (XBUFFER (buffer));
1696 /* Run the Lucid hook. */
1697 call1 (Vrun_hooks, Qactivate_menubar_hook);
1698 /* If it has changed current-menubar from previous value,
1699 really recompute the menubar from the value. */
1700 if (! NILP (Vlucid_menu_bar_dirty_flag))
1701 call0 (Qrecompute_lucid_menubar);
1702 safe_run_hooks (Qmenu_bar_update_hook);
1703 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1705 items = FRAME_MENU_BAR_ITEMS (f);
1707 inhibit_garbage_collection ();
1709 /* Save the frame's previous menu bar contents data. */
1710 bcopy (XVECTOR (f->menu_bar_vector)->contents, previous_items,
1711 previous_menu_items_used * sizeof (Lisp_Object));
1713 /* Fill in the current menu bar contents. */
1714 menu_items = f->menu_bar_vector;
1715 menu_items_allocated = XVECTOR (menu_items)->size;
1716 init_menu_items ();
1717 for (i = 0; i < XVECTOR (items)->size; i += 4)
1719 Lisp_Object key, string, maps;
1721 key = XVECTOR (items)->contents[i];
1722 string = XVECTOR (items)->contents[i + 1];
1723 maps = XVECTOR (items)->contents[i + 2];
1724 if (NILP (string))
1725 break;
1727 wv = single_submenu (key, string, maps);
1728 if (prev_wv)
1729 prev_wv->next = wv;
1730 else
1731 first_wv->contents = wv;
1732 /* Don't set wv->name here; GC during the loop might relocate it. */
1733 wv->enabled = 1;
1734 prev_wv = wv;
1737 finish_menu_items ();
1739 set_buffer_internal_1 (prev);
1740 unbind_to (specpdl_count, Qnil);
1742 /* If there has been no change in the Lisp-level contents
1743 of the menu bar, skip redisplaying it. Just exit. */
1745 for (i = 0; i < previous_menu_items_used; i++)
1746 if (menu_items_used == i
1747 || (!EQ (previous_items[i], XVECTOR (menu_items)->contents[i])))
1748 break;
1749 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1751 free_menubar_widget_value_tree (first_wv);
1752 menu_items = Qnil;
1754 return;
1757 /* Now GC cannot happen during the lifetime of the widget_value,
1758 so it's safe to store data from a Lisp_String. */
1759 wv = first_wv->contents;
1760 for (i = 0; i < XVECTOR (items)->size; i += 4)
1762 Lisp_Object string;
1763 string = XVECTOR (items)->contents[i + 1];
1764 if (NILP (string))
1765 break;
1766 wv->name = (char *) XSTRING (string)->data;
1767 wv = wv->next;
1770 f->menu_bar_vector = menu_items;
1771 f->menu_bar_items_used = menu_items_used;
1772 menu_items = Qnil;
1774 else
1776 /* Make a widget-value tree containing
1777 just the top level menu bar strings. */
1779 items = FRAME_MENU_BAR_ITEMS (f);
1780 for (i = 0; i < XVECTOR (items)->size; i += 4)
1782 Lisp_Object string;
1784 string = XVECTOR (items)->contents[i + 1];
1785 if (NILP (string))
1786 break;
1788 wv = xmalloc_widget_value ();
1789 wv->name = (char *) XSTRING (string)->data;
1790 wv->value = 0;
1791 wv->enabled = 1;
1792 /* This prevents lwlib from assuming this
1793 menu item is really supposed to be empty. */
1794 /* The EMACS_INT cast avoids a warning.
1795 This value just has to be different from small integers. */
1796 wv->call_data = (void *) (EMACS_INT) (-1);
1798 if (prev_wv)
1799 prev_wv->next = wv;
1800 else
1801 first_wv->contents = wv;
1802 prev_wv = wv;
1805 /* Forget what we thought we knew about what is in the
1806 detailed contents of the menu bar menus.
1807 Changing the top level always destroys the contents. */
1808 f->menu_bar_items_used = 0;
1811 /* Create or update the menu bar widget. */
1813 BLOCK_INPUT;
1815 if (menubar_widget)
1817 /* Disable resizing (done for Motif!) */
1818 lw_allow_resizing (f->output_data.x->widget, False);
1820 /* The third arg is DEEP_P, which says to consider the entire
1821 menu trees we supply, rather than just the menu bar item names. */
1822 lw_modify_all_widgets (id, first_wv, deep_p);
1824 /* Re-enable the edit widget to resize. */
1825 lw_allow_resizing (f->output_data.x->widget, True);
1827 else
1829 menubar_widget = lw_create_widget ("menubar", "menubar", id, first_wv,
1830 f->output_data.x->column_widget,
1832 popup_activate_callback,
1833 menubar_selection_callback,
1834 popup_deactivate_callback);
1835 f->output_data.x->menubar_widget = menubar_widget;
1839 int menubar_size
1840 = (f->output_data.x->menubar_widget
1841 ? (f->output_data.x->menubar_widget->core.height
1842 + f->output_data.x->menubar_widget->core.border_width)
1843 : 0);
1845 #if 0 /* Experimentally, we now get the right results
1846 for -geometry -0-0 without this. 24 Aug 96, rms. */
1847 #ifdef USE_LUCID
1848 if (FRAME_EXTERNAL_MENU_BAR (f))
1850 Dimension ibw = 0;
1851 XtVaGetValues (f->output_data.x->column_widget,
1852 XtNinternalBorderWidth, &ibw, NULL);
1853 menubar_size += ibw;
1855 #endif /* USE_LUCID */
1856 #endif /* 0 */
1858 f->output_data.x->menubar_height = menubar_size;
1861 free_menubar_widget_value_tree (first_wv);
1863 update_frame_menubar (f);
1865 UNBLOCK_INPUT;
1868 /* Called from Fx_create_frame to create the initial menubar of a frame
1869 before it is mapped, so that the window is mapped with the menubar already
1870 there instead of us tacking it on later and thrashing the window after it
1871 is visible. */
1873 void
1874 initialize_frame_menubar (f)
1875 FRAME_PTR f;
1877 /* This function is called before the first chance to redisplay
1878 the frame. It has to be, so the frame will have the right size. */
1879 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1880 set_frame_menubar (f, 1, 1);
1883 /* Get rid of the menu bar of frame F, and free its storage.
1884 This is used when deleting a frame, and when turning off the menu bar. */
1886 void
1887 free_frame_menubar (f)
1888 FRAME_PTR f;
1890 Widget menubar_widget;
1891 int id;
1893 menubar_widget = f->output_data.x->menubar_widget;
1895 if (menubar_widget)
1897 BLOCK_INPUT;
1898 lw_destroy_all_widgets ((LWLIB_ID) f->output_data.x->id);
1899 UNBLOCK_INPUT;
1903 #endif /* USE_X_TOOLKIT */
1905 /* xmenu_show actually displays a menu using the panes and items in menu_items
1906 and returns the value selected from it.
1907 There are two versions of xmenu_show, one for Xt and one for Xlib.
1908 Both assume input is blocked by the caller. */
1910 /* F is the frame the menu is for.
1911 X and Y are the frame-relative specified position,
1912 relative to the inside upper left corner of the frame F.
1913 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
1914 KEYMAPS is 1 if this menu was specified with keymaps;
1915 in that case, we return a list containing the chosen item's value
1916 and perhaps also the pane's prefix.
1917 TITLE is the specified menu title.
1918 ERROR is a place to store an error message string in case of failure.
1919 (We return nil on failure, but the value doesn't actually matter.) */
1921 #ifdef USE_X_TOOLKIT
1923 /* We need a unique id for each widget handled by the Lucid Widget
1924 library.
1926 For the main windows, and popup menus, we use this counter,
1927 which we increment each time after use. This starts from 1<<16.
1929 For menu bars, we use numbers starting at 0, counted in
1930 next_menubar_widget_id. */
1931 LWLIB_ID widget_id_tick;
1933 #ifdef __STDC__
1934 static Lisp_Object *volatile menu_item_selection;
1935 #else
1936 static Lisp_Object *menu_item_selection;
1937 #endif
1939 static void
1940 popup_selection_callback (widget, id, client_data)
1941 Widget widget;
1942 LWLIB_ID id;
1943 XtPointer client_data;
1945 menu_item_selection = (Lisp_Object *) client_data;
1948 static Lisp_Object
1949 xmenu_show (f, x, y, for_click, keymaps, title, error)
1950 FRAME_PTR f;
1951 int x;
1952 int y;
1953 int for_click;
1954 int keymaps;
1955 Lisp_Object title;
1956 char **error;
1958 int i;
1959 LWLIB_ID menu_id;
1960 Widget menu;
1961 Arg av[2];
1962 int ac = 0;
1963 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1964 widget_value **submenu_stack
1965 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1966 Lisp_Object *subprefix_stack
1967 = (Lisp_Object *) alloca (menu_items_used * sizeof (Lisp_Object));
1968 int submenu_depth = 0;
1969 XButtonPressedEvent dummy;
1971 int first_pane;
1972 int next_release_must_exit = 0;
1974 *error = NULL;
1976 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1978 *error = "Empty menu";
1979 return Qnil;
1982 /* Create a tree of widget_value objects
1983 representing the panes and their items. */
1984 wv = xmalloc_widget_value ();
1985 wv->name = "menu";
1986 wv->value = 0;
1987 wv->enabled = 1;
1988 first_wv = wv;
1989 first_pane = 1;
1991 /* Loop over all panes and items, filling in the tree. */
1992 i = 0;
1993 while (i < menu_items_used)
1995 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
1997 submenu_stack[submenu_depth++] = save_wv;
1998 save_wv = prev_wv;
1999 prev_wv = 0;
2000 first_pane = 1;
2001 i++;
2003 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
2005 prev_wv = save_wv;
2006 save_wv = submenu_stack[--submenu_depth];
2007 first_pane = 0;
2008 i++;
2010 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
2011 && submenu_depth != 0)
2012 i += MENU_ITEMS_PANE_LENGTH;
2013 /* Ignore a nil in the item list.
2014 It's meaningful only for dialog boxes. */
2015 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2016 i += 1;
2017 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2019 /* Create a new pane. */
2020 Lisp_Object pane_name, prefix;
2021 char *pane_string;
2022 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
2023 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2024 pane_string = (NILP (pane_name)
2025 ? "" : (char *) XSTRING (pane_name)->data);
2026 /* If there is just one top-level pane, put all its items directly
2027 under the top-level menu. */
2028 if (menu_items_n_panes == 1)
2029 pane_string = "";
2031 /* If the pane has a meaningful name,
2032 make the pane a top-level menu item
2033 with its items as a submenu beneath it. */
2034 if (!keymaps && strcmp (pane_string, ""))
2036 wv = xmalloc_widget_value ();
2037 if (save_wv)
2038 save_wv->next = wv;
2039 else
2040 first_wv->contents = wv;
2041 wv->name = pane_string;
2042 if (keymaps && !NILP (prefix))
2043 wv->name++;
2044 wv->value = 0;
2045 wv->enabled = 1;
2046 save_wv = wv;
2047 prev_wv = 0;
2049 else if (first_pane)
2051 save_wv = wv;
2052 prev_wv = 0;
2054 first_pane = 0;
2055 i += MENU_ITEMS_PANE_LENGTH;
2057 else
2059 /* Create a new item within current pane. */
2060 Lisp_Object item_name, enable, descrip, def;
2061 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2062 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2063 descrip
2064 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2065 def = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_DEFINITION];
2067 wv = xmalloc_widget_value ();
2068 if (prev_wv)
2069 prev_wv->next = wv;
2070 else
2071 save_wv->contents = wv;
2072 wv->name = (char *) XSTRING (item_name)->data;
2073 if (!NILP (descrip))
2074 wv->key = (char *) XSTRING (descrip)->data;
2075 wv->value = 0;
2076 /* If this item has a null value,
2077 make the call_data null so that it won't display a box
2078 when the mouse is on it. */
2079 wv->call_data
2080 = (!NILP (def) ? (void *) &XVECTOR (menu_items)->contents[i] : 0);
2081 wv->enabled = !NILP (enable);
2082 prev_wv = wv;
2084 i += MENU_ITEMS_ITEM_LENGTH;
2088 /* Deal with the title, if it is non-nil. */
2089 if (!NILP (title))
2091 widget_value *wv_title = xmalloc_widget_value ();
2092 widget_value *wv_sep1 = xmalloc_widget_value ();
2093 widget_value *wv_sep2 = xmalloc_widget_value ();
2095 wv_sep2->name = "--";
2096 wv_sep2->next = first_wv->contents;
2098 wv_sep1->name = "--";
2099 wv_sep1->next = wv_sep2;
2101 wv_title->name = (char *) XSTRING (title)->data;
2102 wv_title->enabled = True;
2103 wv_title->next = wv_sep1;
2104 first_wv->contents = wv_title;
2107 /* Actually create the menu. */
2108 menu_id = widget_id_tick++;
2109 menu = lw_create_widget ("popup", first_wv->name, menu_id, first_wv,
2110 f->output_data.x->widget, 1, 0,
2111 popup_selection_callback,
2112 popup_deactivate_callback);
2114 /* Adjust coordinates to relative to the outer (window manager) window. */
2116 Window child;
2117 int win_x = 0, win_y = 0;
2119 /* Find the position of the outside upper-left corner of
2120 the inner window, with respect to the outer window. */
2121 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
2123 BLOCK_INPUT;
2124 XTranslateCoordinates (FRAME_X_DISPLAY (f),
2126 /* From-window, to-window. */
2127 f->output_data.x->window_desc,
2128 f->output_data.x->parent_desc,
2130 /* From-position, to-position. */
2131 0, 0, &win_x, &win_y,
2133 /* Child of window. */
2134 &child);
2135 UNBLOCK_INPUT;
2136 x += win_x;
2137 y += win_y;
2141 /* Adjust coordinates to be root-window-relative. */
2142 x += f->output_data.x->left_pos;
2143 y += f->output_data.x->top_pos;
2145 dummy.type = ButtonPress;
2146 dummy.serial = 0;
2147 dummy.send_event = 0;
2148 dummy.display = FRAME_X_DISPLAY (f);
2149 dummy.time = CurrentTime;
2150 dummy.root = FRAME_X_DISPLAY_INFO (f)->root_window;
2151 dummy.window = dummy.root;
2152 dummy.subwindow = dummy.root;
2153 dummy.x_root = x;
2154 dummy.y_root = y;
2155 dummy.x = x;
2156 dummy.y = y;
2157 dummy.state = (FRAME_X_DISPLAY_INFO (f)->grabbed >> 1) * Button1Mask;
2158 dummy.button = 0;
2159 for (i = 0; i < 5; i++)
2160 if (FRAME_X_DISPLAY_INFO (f)->grabbed & (1 << i))
2161 dummy.button = i;
2163 /* Don't allow any geometry request from the user. */
2164 XtSetArg (av[ac], XtNgeometry, 0); ac++;
2165 XtSetValues (menu, av, ac);
2167 /* Free the widget_value objects we used to specify the contents. */
2168 free_menubar_widget_value_tree (first_wv);
2170 /* No selection has been chosen yet. */
2171 menu_item_selection = 0;
2173 /* Display the menu. */
2174 lw_popup_menu (menu, &dummy);
2175 popup_activated_flag = 1;
2177 /* Process events that apply to the menu. */
2178 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), menu_id);
2180 /* fp turned off the following statement and wrote a comment
2181 that it is unnecessary--that the menu has already disappeared.
2182 Nowadays the menu disappears ok, all right, but
2183 we need to delete the widgets or multiple ones will pile up. */
2184 lw_destroy_all_widgets (menu_id);
2186 /* Find the selected item, and its pane, to return
2187 the proper value. */
2188 if (menu_item_selection != 0)
2190 Lisp_Object prefix, entry;
2192 prefix = Qnil;
2193 i = 0;
2194 while (i < menu_items_used)
2196 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
2198 subprefix_stack[submenu_depth++] = prefix;
2199 prefix = entry;
2200 i++;
2202 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
2204 prefix = subprefix_stack[--submenu_depth];
2205 i++;
2207 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2209 prefix
2210 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2211 i += MENU_ITEMS_PANE_LENGTH;
2213 /* Ignore a nil in the item list.
2214 It's meaningful only for dialog boxes. */
2215 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2216 i += 1;
2217 else
2219 entry
2220 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2221 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
2223 if (keymaps != 0)
2225 int j;
2227 entry = Fcons (entry, Qnil);
2228 if (!NILP (prefix))
2229 entry = Fcons (prefix, entry);
2230 for (j = submenu_depth - 1; j >= 0; j--)
2231 if (!NILP (subprefix_stack[j]))
2232 entry = Fcons (subprefix_stack[j], entry);
2234 return entry;
2236 i += MENU_ITEMS_ITEM_LENGTH;
2241 return Qnil;
2244 static void
2245 dialog_selection_callback (widget, id, client_data)
2246 Widget widget;
2247 LWLIB_ID id;
2248 XtPointer client_data;
2250 /* The EMACS_INT cast avoids a warning. There's no problem
2251 as long as pointers have enough bits to hold small integers. */
2252 if ((int) (EMACS_INT) client_data != -1)
2253 menu_item_selection = (Lisp_Object *) client_data;
2254 BLOCK_INPUT;
2255 lw_destroy_all_widgets (id);
2256 UNBLOCK_INPUT;
2257 popup_activated_flag = 0;
2260 static char * button_names [] = {
2261 "button1", "button2", "button3", "button4", "button5",
2262 "button6", "button7", "button8", "button9", "button10" };
2264 static Lisp_Object
2265 xdialog_show (f, keymaps, title, error)
2266 FRAME_PTR f;
2267 int keymaps;
2268 Lisp_Object title;
2269 char **error;
2271 int i, nb_buttons=0;
2272 LWLIB_ID dialog_id;
2273 Widget menu;
2274 char dialog_name[6];
2276 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
2278 /* Number of elements seen so far, before boundary. */
2279 int left_count = 0;
2280 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
2281 int boundary_seen = 0;
2283 *error = NULL;
2285 if (menu_items_n_panes > 1)
2287 *error = "Multiple panes in dialog box";
2288 return Qnil;
2291 /* Create a tree of widget_value objects
2292 representing the text label and buttons. */
2294 Lisp_Object pane_name, prefix;
2295 char *pane_string;
2296 pane_name = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME];
2297 prefix = XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_PREFIX];
2298 pane_string = (NILP (pane_name)
2299 ? "" : (char *) XSTRING (pane_name)->data);
2300 prev_wv = xmalloc_widget_value ();
2301 prev_wv->value = pane_string;
2302 if (keymaps && !NILP (prefix))
2303 prev_wv->name++;
2304 prev_wv->enabled = 1;
2305 prev_wv->name = "message";
2306 first_wv = prev_wv;
2308 /* Loop over all panes and items, filling in the tree. */
2309 i = MENU_ITEMS_PANE_LENGTH;
2310 while (i < menu_items_used)
2313 /* Create a new item within current pane. */
2314 Lisp_Object item_name, enable, descrip;
2315 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2316 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2317 descrip
2318 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2320 if (NILP (item_name))
2322 free_menubar_widget_value_tree (first_wv);
2323 *error = "Submenu in dialog items";
2324 return Qnil;
2326 if (EQ (item_name, Qquote))
2328 /* This is the boundary between left-side elts
2329 and right-side elts. Stop incrementing right_count. */
2330 boundary_seen = 1;
2331 i++;
2332 continue;
2334 if (nb_buttons >= 9)
2336 free_menubar_widget_value_tree (first_wv);
2337 *error = "Too many dialog items";
2338 return Qnil;
2341 wv = xmalloc_widget_value ();
2342 prev_wv->next = wv;
2343 wv->name = (char *) button_names[nb_buttons];
2344 if (!NILP (descrip))
2345 wv->key = (char *) XSTRING (descrip)->data;
2346 wv->value = (char *) XSTRING (item_name)->data;
2347 wv->call_data = (void *) &XVECTOR (menu_items)->contents[i];
2348 wv->enabled = !NILP (enable);
2349 prev_wv = wv;
2351 if (! boundary_seen)
2352 left_count++;
2354 nb_buttons++;
2355 i += MENU_ITEMS_ITEM_LENGTH;
2358 /* If the boundary was not specified,
2359 by default put half on the left and half on the right. */
2360 if (! boundary_seen)
2361 left_count = nb_buttons - nb_buttons / 2;
2363 wv = xmalloc_widget_value ();
2364 wv->name = dialog_name;
2366 /* Dialog boxes use a really stupid name encoding
2367 which specifies how many buttons to use
2368 and how many buttons are on the right.
2369 The Q means something also. */
2370 dialog_name[0] = 'Q';
2371 dialog_name[1] = '0' + nb_buttons;
2372 dialog_name[2] = 'B';
2373 dialog_name[3] = 'R';
2374 /* Number of buttons to put on the right. */
2375 dialog_name[4] = '0' + nb_buttons - left_count;
2376 dialog_name[5] = 0;
2377 wv->contents = first_wv;
2378 first_wv = wv;
2381 /* Actually create the dialog. */
2382 dialog_id = widget_id_tick++;
2383 menu = lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
2384 f->output_data.x->widget, 1, 0,
2385 dialog_selection_callback, 0);
2386 lw_modify_all_widgets (dialog_id, first_wv->contents, True);
2387 /* Free the widget_value objects we used to specify the contents. */
2388 free_menubar_widget_value_tree (first_wv);
2390 /* No selection has been chosen yet. */
2391 menu_item_selection = 0;
2393 /* Display the menu. */
2394 lw_pop_up_all_widgets (dialog_id);
2395 popup_activated_flag = 1;
2397 /* Process events that apply to the menu. */
2398 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), dialog_id);
2400 lw_destroy_all_widgets (dialog_id);
2402 /* Find the selected item, and its pane, to return
2403 the proper value. */
2404 if (menu_item_selection != 0)
2406 Lisp_Object prefix;
2408 prefix = Qnil;
2409 i = 0;
2410 while (i < menu_items_used)
2412 Lisp_Object entry;
2414 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2416 prefix
2417 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2418 i += MENU_ITEMS_PANE_LENGTH;
2420 else
2422 entry
2423 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2424 if (menu_item_selection == &XVECTOR (menu_items)->contents[i])
2426 if (keymaps != 0)
2428 entry = Fcons (entry, Qnil);
2429 if (!NILP (prefix))
2430 entry = Fcons (prefix, entry);
2432 return entry;
2434 i += MENU_ITEMS_ITEM_LENGTH;
2439 return Qnil;
2441 #else /* not USE_X_TOOLKIT */
2443 static Lisp_Object
2444 xmenu_show (f, x, y, for_click, keymaps, title, error)
2445 FRAME_PTR f;
2446 int x, y;
2447 int for_click;
2448 int keymaps;
2449 Lisp_Object title;
2450 char **error;
2452 Window root;
2453 XMenu *menu;
2454 int pane, selidx, lpane, status;
2455 Lisp_Object entry, pane_prefix;
2456 char *datap;
2457 int ulx, uly, width, height;
2458 int dispwidth, dispheight;
2459 int i, j;
2460 int maxwidth;
2461 int dummy_int;
2462 unsigned int dummy_uint;
2464 *error = 0;
2465 if (menu_items_n_panes == 0)
2466 return Qnil;
2468 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
2470 *error = "Empty menu";
2471 return Qnil;
2474 /* Figure out which root window F is on. */
2475 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &root,
2476 &dummy_int, &dummy_int, &dummy_uint, &dummy_uint,
2477 &dummy_uint, &dummy_uint);
2479 /* Make the menu on that window. */
2480 menu = XMenuCreate (FRAME_X_DISPLAY (f), root, "emacs");
2481 if (menu == NULL)
2483 *error = "Can't create menu";
2484 return Qnil;
2487 #ifdef HAVE_X_WINDOWS
2488 /* Adjust coordinates to relative to the outer (window manager) window. */
2490 Window child;
2491 int win_x = 0, win_y = 0;
2493 /* Find the position of the outside upper-left corner of
2494 the inner window, with respect to the outer window. */
2495 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
2497 BLOCK_INPUT;
2498 XTranslateCoordinates (FRAME_X_DISPLAY (f),
2500 /* From-window, to-window. */
2501 f->output_data.x->window_desc,
2502 f->output_data.x->parent_desc,
2504 /* From-position, to-position. */
2505 0, 0, &win_x, &win_y,
2507 /* Child of window. */
2508 &child);
2509 UNBLOCK_INPUT;
2510 x += win_x;
2511 y += win_y;
2514 #endif /* HAVE_X_WINDOWS */
2516 /* Adjust coordinates to be root-window-relative. */
2517 x += f->output_data.x->left_pos;
2518 y += f->output_data.x->top_pos;
2520 /* Create all the necessary panes and their items. */
2521 i = 0;
2522 while (i < menu_items_used)
2524 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2526 /* Create a new pane. */
2527 Lisp_Object pane_name, prefix;
2528 char *pane_string;
2530 pane_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_NAME];
2531 prefix = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2532 pane_string = (NILP (pane_name)
2533 ? "" : (char *) XSTRING (pane_name)->data);
2534 if (keymaps && !NILP (prefix))
2535 pane_string++;
2537 lpane = XMenuAddPane (FRAME_X_DISPLAY (f), menu, pane_string, TRUE);
2538 if (lpane == XM_FAILURE)
2540 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2541 *error = "Can't create pane";
2542 return Qnil;
2544 i += MENU_ITEMS_PANE_LENGTH;
2546 /* Find the width of the widest item in this pane. */
2547 maxwidth = 0;
2548 j = i;
2549 while (j < menu_items_used)
2551 Lisp_Object item;
2552 item = XVECTOR (menu_items)->contents[j];
2553 if (EQ (item, Qt))
2554 break;
2555 if (NILP (item))
2557 j++;
2558 continue;
2560 width = XSTRING (item)->size;
2561 if (width > maxwidth)
2562 maxwidth = width;
2564 j += MENU_ITEMS_ITEM_LENGTH;
2567 /* Ignore a nil in the item list.
2568 It's meaningful only for dialog boxes. */
2569 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
2570 i += 1;
2571 else
2573 /* Create a new item within current pane. */
2574 Lisp_Object item_name, enable, descrip;
2575 unsigned char *item_data;
2577 item_name = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_NAME];
2578 enable = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_ENABLE];
2579 descrip
2580 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_EQUIV_KEY];
2581 if (!NILP (descrip))
2583 int gap = maxwidth - XSTRING (item_name)->size;
2584 #ifdef C_ALLOCA
2585 Lisp_Object spacer;
2586 spacer = Fmake_string (make_number (gap), make_number (' '));
2587 item_name = concat2 (item_name, spacer);
2588 item_name = concat2 (item_name, descrip);
2589 item_data = XSTRING (item_name)->data;
2590 #else
2591 /* if alloca is fast, use that to make the space,
2592 to reduce gc needs. */
2593 item_data
2594 = (unsigned char *) alloca (maxwidth
2595 + XSTRING (descrip)->size + 1);
2596 bcopy (XSTRING (item_name)->data, item_data,
2597 XSTRING (item_name)->size);
2598 for (j = XSTRING (item_name)->size; j < maxwidth; j++)
2599 item_data[j] = ' ';
2600 bcopy (XSTRING (descrip)->data, item_data + j,
2601 XSTRING (descrip)->size);
2602 item_data[j + XSTRING (descrip)->size] = 0;
2603 #endif
2605 else
2606 item_data = XSTRING (item_name)->data;
2608 if (XMenuAddSelection (FRAME_X_DISPLAY (f),
2609 menu, lpane, 0, item_data,
2610 !NILP (enable))
2611 == XM_FAILURE)
2613 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2614 *error = "Can't add selection to menu";
2615 return Qnil;
2617 i += MENU_ITEMS_ITEM_LENGTH;
2621 /* All set and ready to fly. */
2622 XMenuRecompute (FRAME_X_DISPLAY (f), menu);
2623 dispwidth = DisplayWidth (FRAME_X_DISPLAY (f),
2624 XScreenNumberOfScreen (FRAME_X_SCREEN (f)));
2625 dispheight = DisplayHeight (FRAME_X_DISPLAY (f),
2626 XScreenNumberOfScreen (FRAME_X_SCREEN (f)));
2627 x = min (x, dispwidth);
2628 y = min (y, dispheight);
2629 x = max (x, 1);
2630 y = max (y, 1);
2631 XMenuLocate (FRAME_X_DISPLAY (f), menu, 0, 0, x, y,
2632 &ulx, &uly, &width, &height);
2633 if (ulx+width > dispwidth)
2635 x -= (ulx + width) - dispwidth;
2636 ulx = dispwidth - width;
2638 if (uly+height > dispheight)
2640 y -= (uly + height) - dispheight;
2641 uly = dispheight - height;
2643 if (ulx < 0) x -= ulx;
2644 if (uly < 0) y -= uly;
2646 XMenuSetAEQ (menu, TRUE);
2647 XMenuSetFreeze (menu, TRUE);
2648 pane = selidx = 0;
2650 status = XMenuActivate (FRAME_X_DISPLAY (f), menu, &pane, &selidx,
2651 x, y, ButtonReleaseMask, &datap);
2654 #ifdef HAVE_X_WINDOWS
2655 /* Assume the mouse has moved out of the X window.
2656 If it has actually moved in, we will get an EnterNotify. */
2657 x_mouse_leave (FRAME_X_DISPLAY_INFO (f));
2658 #endif
2660 switch (status)
2662 case XM_SUCCESS:
2663 #ifdef XDEBUG
2664 fprintf (stderr, "pane= %d line = %d\n", panes, selidx);
2665 #endif
2667 /* Find the item number SELIDX in pane number PANE. */
2668 i = 0;
2669 while (i < menu_items_used)
2671 if (EQ (XVECTOR (menu_items)->contents[i], Qt))
2673 if (pane == 0)
2674 pane_prefix
2675 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_PANE_PREFIX];
2676 pane--;
2677 i += MENU_ITEMS_PANE_LENGTH;
2679 else
2681 if (pane == -1)
2683 if (selidx == 0)
2685 entry
2686 = XVECTOR (menu_items)->contents[i + MENU_ITEMS_ITEM_VALUE];
2687 if (keymaps != 0)
2689 entry = Fcons (entry, Qnil);
2690 if (!NILP (pane_prefix))
2691 entry = Fcons (pane_prefix, entry);
2693 break;
2695 selidx--;
2697 i += MENU_ITEMS_ITEM_LENGTH;
2700 break;
2702 case XM_FAILURE:
2703 *error = "Can't activate menu";
2704 case XM_IA_SELECT:
2705 case XM_NO_SELECT:
2706 entry = Qnil;
2707 break;
2709 XMenuDestroy (FRAME_X_DISPLAY (f), menu);
2711 #ifdef HAVE_X_WINDOWS
2712 /* State that no mouse buttons are now held.
2713 (The oldXMenu code doesn't track this info for us.)
2714 That is not necessarily true, but the fiction leads to reasonable
2715 results, and it is a pain to ask which are actually held now. */
2716 FRAME_X_DISPLAY_INFO (f)->grabbed = 0;
2717 #endif
2719 return entry;
2722 #endif /* not USE_X_TOOLKIT */
2724 #endif /* HAVE_MENUS */
2726 syms_of_xmenu ()
2728 staticpro (&menu_items);
2729 menu_items = Qnil;
2731 Qmenu_alias = intern ("menu-alias");
2732 staticpro (&Qmenu_alias);
2734 Qdebug_on_next_call = intern ("debug-on-next-call");
2735 staticpro (&Qdebug_on_next_call);
2737 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame,
2738 "Frame for which we are updating a menu.\n\
2739 The enable predicate for a menu command should check this variable.");
2740 Vmenu_updating_frame = Qnil;
2742 #ifdef USE_X_TOOLKIT
2743 widget_id_tick = (1<<16);
2744 next_menubar_widget_id = 1;
2745 #endif
2747 defsubr (&Sx_popup_menu);
2748 #ifdef HAVE_MENUS
2749 defsubr (&Sx_popup_dialog);
2750 #endif