1 /* Menu support for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1986, 88, 93, 94, 96, 98, 1999 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)
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. */
26 #include "termhooks.h"
31 #include "blockinput.h"
36 /* This may include sys/types.h, and that somehow loses
37 if this is not done before the other system files. */
40 /* Load sys/types.h if not already loaded.
41 In some systems loading it twice is suicidal. */
43 #include <sys/types.h>
46 #include "dispextern.h"
48 #undef HAVE_MULTILINGUAL_MENU
49 #undef HAVE_DIALOGS /* TODO: Implement native dialogs. */
51 /******************************************************************/
52 /* Definitions copied from lwlib.h */
54 typedef void * XtPointer
;
64 /* This structure is based on the one in ../lwlib/lwlib.h, modified
66 typedef struct _widget_value
70 /* value (meaning depend on widget type) */
72 /* keyboard equivalent. no implications for XtTranslations */
74 /* Help string or nil if none.
75 GC finds this string through the frame's menu_bar_vector
76 or through menu_items. */
80 /* true if selected */
82 /* The type of a button. */
83 enum button_type button_type
;
84 /* true if menu title */
87 /* true if was edited (maintained by get_value) */
89 /* true if has changed (maintained by lw library) */
91 /* true if this widget itself has changed,
92 but not counting the other widgets found in the `next' field. */
93 change_type this_one_change
;
95 /* Contents of the sub-widgets, also selected slot for checkbox */
96 struct _widget_value
* contents
;
97 /* data passed to callback */
99 /* next one in the list */
100 struct _widget_value
* next
;
102 /* slot for the toolkit dependent part. Always initialize to NULL. */
104 /* tell us if we should free the toolkit data slot when freeing the
105 widget_value itself. */
106 Boolean free_toolkit_data
;
108 /* we resource the widget_value structures; this points to the next
109 one on the free list if this one has been deallocated.
111 struct _widget_value
*free_list
;
115 /* Local memory management */
116 #define local_heap (GetProcessHeap ())
117 #define local_alloc(n) (HeapAlloc (local_heap, HEAP_ZERO_MEMORY, (n)))
118 #define local_free(p) (HeapFree (local_heap, 0, ((LPVOID) (p))))
120 #define malloc_widget_value() ((widget_value *) local_alloc (sizeof (widget_value)))
121 #define free_widget_value(wv) (local_free ((wv)))
123 /******************************************************************/
130 static HMENU current_popup_menu
;
132 void syms_of_w32menu ();
133 void globals_of_w32menu ();
135 typedef BOOL (WINAPI
* GetMenuItemInfoA_Proc
) (
139 IN OUT LPMENUITEMINFOA
141 typedef BOOL (WINAPI
* SetMenuItemInfoA_Proc
) (
148 GetMenuItemInfoA_Proc get_menu_item_info
=NULL
;
149 SetMenuItemInfoA_Proc set_menu_item_info
=NULL
;
151 Lisp_Object Vmenu_updating_frame
;
153 Lisp_Object Qdebug_on_next_call
;
155 extern Lisp_Object Qmenu_bar
;
156 extern Lisp_Object Qmouse_click
, Qevent_kind
;
158 extern Lisp_Object QCtoggle
, QCradio
;
160 extern Lisp_Object Voverriding_local_map
;
161 extern Lisp_Object Voverriding_local_map_menu_flag
;
163 extern Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
165 extern Lisp_Object Qmenu_bar_update_hook
;
167 void set_frame_menubar ();
169 static void push_menu_item
P_ ((Lisp_Object
, Lisp_Object
, Lisp_Object
,
170 Lisp_Object
, Lisp_Object
, Lisp_Object
,
171 Lisp_Object
, Lisp_Object
));
173 static Lisp_Object
w32_dialog_show ();
175 static Lisp_Object
w32_menu_show ();
177 static void keymap_panes ();
178 static void single_keymap_panes ();
179 static void single_menu_item ();
180 static void list_of_panes ();
181 static void list_of_items ();
182 void w32_free_menu_strings (HWND
);
184 /* This holds a Lisp vector that holds the results of decoding
185 the keymaps or alist-of-alists that specify a menu.
187 It describes the panes and items within the panes.
189 Each pane is described by 3 elements in the vector:
190 t, the pane name, the pane's prefix key.
191 Then follow the pane's items, with 5 elements per item:
192 the item string, the enable flag, the item's value,
193 the definition, and the equivalent keyboard key's description string.
195 In some cases, multiple levels of menus may be described.
196 A single vector slot containing nil indicates the start of a submenu.
197 A single vector slot containing lambda indicates the end of a submenu.
198 The submenu follows a menu item which is the way to reach the submenu.
200 A single vector slot containing quote indicates that the
201 following items should appear on the right of a dialog box.
203 Using a Lisp vector to hold this information while we decode it
204 takes care of protecting all the data from GC. */
206 #define MENU_ITEMS_PANE_NAME 1
207 #define MENU_ITEMS_PANE_PREFIX 2
208 #define MENU_ITEMS_PANE_LENGTH 3
212 MENU_ITEMS_ITEM_NAME
= 0,
213 MENU_ITEMS_ITEM_ENABLE
,
214 MENU_ITEMS_ITEM_VALUE
,
215 MENU_ITEMS_ITEM_EQUIV_KEY
,
216 MENU_ITEMS_ITEM_DEFINITION
,
217 MENU_ITEMS_ITEM_TYPE
,
218 MENU_ITEMS_ITEM_SELECTED
,
219 MENU_ITEMS_ITEM_HELP
,
220 MENU_ITEMS_ITEM_LENGTH
223 static Lisp_Object menu_items
;
225 /* Number of slots currently allocated in menu_items. */
226 static int menu_items_allocated
;
228 /* This is the index in menu_items of the first empty slot. */
229 static int menu_items_used
;
231 /* The number of panes currently recorded in menu_items,
232 excluding those within submenus. */
233 static int menu_items_n_panes
;
235 /* Current depth within submenus. */
236 static int menu_items_submenu_depth
;
238 /* Flag which when set indicates a dialog or menu has been posted by
239 Xt on behalf of one of the widget sets. */
240 static int popup_activated_flag
;
242 static int next_menubar_widget_id
;
244 /* This is set nonzero after the user activates the menu bar, and set
245 to zero again after the menu bars are redisplayed by prepare_menu_bar.
246 While it is nonzero, all calls to set_frame_menubar go deep.
248 I don't understand why this is needed, but it does seem to be
249 needed on Motif, according to Marcus Daniels <marcus@sysc.pdx.edu>. */
251 int pending_menu_activation
;
254 /* Return the frame whose ->output_data.w32->menubar_widget equals
257 static struct frame
*
258 menubar_id_to_frame (id
)
261 Lisp_Object tail
, frame
;
264 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
267 if (!GC_FRAMEP (frame
))
270 if (!FRAME_WINDOW_P (f
))
272 if (f
->output_data
.w32
->menubar_widget
== id
)
278 /* Initialize the menu_items structure if we haven't already done so.
279 Also mark it as currently empty. */
284 if (NILP (menu_items
))
286 menu_items_allocated
= 60;
287 menu_items
= Fmake_vector (make_number (menu_items_allocated
), Qnil
);
291 menu_items_n_panes
= 0;
292 menu_items_submenu_depth
= 0;
295 /* Call at the end of generating the data in menu_items.
296 This fills in the number of items in the last pane. */
303 /* Call when finished using the data for the current menu
307 discard_menu_items ()
309 /* Free the structure if it is especially large.
310 Otherwise, hold on to it, to save time. */
311 if (menu_items_allocated
> 200)
314 menu_items_allocated
= 0;
318 /* Make the menu_items vector twice as large. */
324 int old_size
= menu_items_allocated
;
327 menu_items_allocated
*= 2;
328 menu_items
= Fmake_vector (make_number (menu_items_allocated
), Qnil
);
329 bcopy (XVECTOR (old
)->contents
, XVECTOR (menu_items
)->contents
,
330 old_size
* sizeof (Lisp_Object
));
333 /* Begin a submenu. */
336 push_submenu_start ()
338 if (menu_items_used
+ 1 > menu_items_allocated
)
341 ASET (menu_items
, menu_items_used
++, Qnil
);
342 menu_items_submenu_depth
++;
350 if (menu_items_used
+ 1 > menu_items_allocated
)
353 ASET (menu_items
, menu_items_used
++, Qlambda
);
354 menu_items_submenu_depth
--;
357 /* Indicate boundary between left and right. */
360 push_left_right_boundary ()
362 if (menu_items_used
+ 1 > menu_items_allocated
)
365 ASET (menu_items
, menu_items_used
++, Qquote
);
368 /* Start a new menu pane in menu_items.
369 NAME is the pane name. PREFIX_VEC is a prefix key for this pane. */
372 push_menu_pane (name
, prefix_vec
)
373 Lisp_Object name
, prefix_vec
;
375 if (menu_items_used
+ MENU_ITEMS_PANE_LENGTH
> menu_items_allocated
)
378 if (menu_items_submenu_depth
== 0)
379 menu_items_n_panes
++;
380 ASET (menu_items
, menu_items_used
++, Qt
);
381 ASET (menu_items
, menu_items_used
++, name
);
382 ASET (menu_items
, menu_items_used
++, prefix_vec
);
385 /* Push one menu item into the current pane. NAME is the string to
386 display. ENABLE if non-nil means this item can be selected. KEY
387 is the key generated by choosing this item, or nil if this item
388 doesn't really have a definition. DEF is the definition of this
389 item. EQUIV is the textual description of the keyboard equivalent
390 for this item (or nil if none). TYPE is the type of this menu
391 item, one of nil, `toggle' or `radio'. */
394 push_menu_item (name
, enable
, key
, def
, equiv
, type
, selected
, help
)
395 Lisp_Object name
, enable
, key
, def
, equiv
, type
, selected
, help
;
397 if (menu_items_used
+ MENU_ITEMS_ITEM_LENGTH
> menu_items_allocated
)
400 ASET (menu_items
, menu_items_used
++, name
);
401 ASET (menu_items
, menu_items_used
++, enable
);
402 ASET (menu_items
, menu_items_used
++, key
);
403 ASET (menu_items
, menu_items_used
++, equiv
);
404 ASET (menu_items
, menu_items_used
++, def
);
405 ASET (menu_items
, menu_items_used
++, type
);
406 ASET (menu_items
, menu_items_used
++, selected
);
407 ASET (menu_items
, menu_items_used
++, help
);
410 /* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
411 and generate menu panes for them in menu_items.
412 If NOTREAL is nonzero,
413 don't bother really computing whether an item is enabled. */
416 keymap_panes (keymaps
, nmaps
, notreal
)
417 Lisp_Object
*keymaps
;
425 /* Loop over the given keymaps, making a pane for each map.
426 But don't make a pane that is empty--ignore that map instead.
427 P is the number of panes we have made so far. */
428 for (mapno
= 0; mapno
< nmaps
; mapno
++)
429 single_keymap_panes (keymaps
[mapno
],
430 Fkeymap_prompt (keymaps
[mapno
]), Qnil
, notreal
, 10);
432 finish_menu_items ();
435 /* This is a recursive subroutine of keymap_panes.
436 It handles one keymap, KEYMAP.
437 The other arguments are passed along
438 or point to local variables of the previous function.
439 If NOTREAL is nonzero, only check for equivalent key bindings, don't
440 evaluate expressions in menu items and don't make any menu.
442 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
445 single_keymap_panes (keymap
, pane_name
, prefix
, notreal
, maxdepth
)
447 Lisp_Object pane_name
;
452 Lisp_Object pending_maps
= Qnil
;
453 Lisp_Object tail
, item
;
454 struct gcpro gcpro1
, gcpro2
;
459 push_menu_pane (pane_name
, prefix
);
461 for (tail
= keymap
; CONSP (tail
); tail
= XCDR (tail
))
463 GCPRO2 (keymap
, pending_maps
);
464 /* Look at each key binding, and if it is a menu item add it
468 single_menu_item (XCAR (item
), XCDR (item
),
469 &pending_maps
, notreal
, maxdepth
);
470 else if (VECTORP (item
))
472 /* Loop over the char values represented in the vector. */
473 int len
= ASIZE (item
);
475 for (c
= 0; c
< len
; c
++)
477 Lisp_Object character
;
478 XSETFASTINT (character
, c
);
479 single_menu_item (character
, AREF (item
, c
),
480 &pending_maps
, notreal
, maxdepth
);
486 /* Process now any submenus which want to be panes at this level. */
487 while (!NILP (pending_maps
))
489 Lisp_Object elt
, eltcdr
, string
;
490 elt
= Fcar (pending_maps
);
492 string
= XCAR (eltcdr
);
493 /* We no longer discard the @ from the beginning of the string here.
494 Instead, we do this in w32_menu_show. */
495 single_keymap_panes (Fcar (elt
), string
,
496 XCDR (eltcdr
), notreal
, maxdepth
- 1);
497 pending_maps
= Fcdr (pending_maps
);
501 /* This is a subroutine of single_keymap_panes that handles one
503 KEY is a key in a keymap and ITEM is its binding.
504 PENDING_MAPS_PTR points to a list of keymaps waiting to be made into
506 If NOTREAL is nonzero, only check for equivalent key bindings, don't
507 evaluate expressions in menu items and don't make any menu.
508 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
511 single_menu_item (key
, item
, pending_maps_ptr
, notreal
, maxdepth
)
512 Lisp_Object key
, item
;
513 Lisp_Object
*pending_maps_ptr
;
514 int maxdepth
, notreal
;
516 Lisp_Object map
, item_string
, enabled
;
517 struct gcpro gcpro1
, gcpro2
;
520 /* Parse the menu item and leave the result in item_properties. */
522 res
= parse_menu_item (item
, notreal
, 0);
525 return; /* Not a menu item. */
527 map
= AREF (item_properties
, ITEM_PROPERTY_MAP
);
531 /* We don't want to make a menu, just traverse the keymaps to
532 precompute equivalent key bindings. */
534 single_keymap_panes (map
, Qnil
, key
, 1, maxdepth
- 1);
538 enabled
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
539 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
541 if (!NILP (map
) && SREF (item_string
, 0) == '@')
544 /* An enabled separate pane. Remember this to handle it later. */
545 *pending_maps_ptr
= Fcons (Fcons (map
, Fcons (item_string
, key
)),
550 push_menu_item (item_string
, enabled
, key
,
551 AREF (item_properties
, ITEM_PROPERTY_DEF
),
552 AREF (item_properties
, ITEM_PROPERTY_KEYEQ
),
553 AREF (item_properties
, ITEM_PROPERTY_TYPE
),
554 AREF (item_properties
, ITEM_PROPERTY_SELECTED
),
555 AREF (item_properties
, ITEM_PROPERTY_HELP
));
557 /* Display a submenu using the toolkit. */
558 if (! (NILP (map
) || NILP (enabled
)))
560 push_submenu_start ();
561 single_keymap_panes (map
, Qnil
, key
, 0, maxdepth
- 1);
566 /* Push all the panes and items of a menu described by the
567 alist-of-alists MENU.
568 This handles old-fashioned calls to x-popup-menu. */
578 for (tail
= menu
; !NILP (tail
); tail
= Fcdr (tail
))
580 Lisp_Object elt
, pane_name
, pane_data
;
582 pane_name
= Fcar (elt
);
583 CHECK_STRING (pane_name
);
584 push_menu_pane (pane_name
, Qnil
);
585 pane_data
= Fcdr (elt
);
586 CHECK_CONS (pane_data
);
587 list_of_items (pane_data
);
590 finish_menu_items ();
593 /* Push the items in a single pane defined by the alist PANE. */
599 Lisp_Object tail
, item
, item1
;
601 for (tail
= pane
; !NILP (tail
); tail
= Fcdr (tail
))
605 push_menu_item (item
, Qnil
, Qnil
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
);
606 else if (NILP (item
))
607 push_left_right_boundary ();
612 CHECK_STRING (item1
);
613 push_menu_item (item1
, Qt
, Fcdr (item
), Qt
, Qnil
, Qnil
, Qnil
, Qnil
);
618 DEFUN ("x-popup-menu", Fx_popup_menu
, Sx_popup_menu
, 2, 2, 0,
619 doc
: /* Pop up a deck-of-cards menu and return user's selection.
620 POSITION is a position specification. This is either a mouse button
621 event or a list ((XOFFSET YOFFSET) WINDOW) where XOFFSET and YOFFSET
622 are positions in pixels from the top left corner of WINDOW's frame
623 \(WINDOW may be a frame object instead of a window). This controls the
624 position of the center of the first line in the first pane of the
625 menu, not the top left of the menu as a whole. If POSITION is t, it
626 means to use the current mouse position.
628 MENU is a specifier for a menu. For the simplest case, MENU is a keymap.
629 The menu items come from key bindings that have a menu string as well as
630 a definition; actually, the \"definition\" in such a key binding looks like
631 \(STRING . REAL-DEFINITION). To give the menu a title, put a string into
632 the keymap as a top-level element.
634 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
635 Otherwise, REAL-DEFINITION should be a valid key binding definition.
637 You can also use a list of keymaps as MENU. Then each keymap makes a
638 separate pane. When MENU is a keymap or a list of keymaps, the return
639 value is a list of events.
641 Alternatively, you can specify a menu of multiple panes with a list of
642 the form (TITLE PANE1 PANE2...), where each pane is a list of
643 form (TITLE ITEM1 ITEM2...).
644 Each ITEM is normally a cons cell (STRING . VALUE); but a string can
645 appear as an item--that makes a nonselectable line in the menu.
646 With this form of menu, the return value is VALUE from the chosen item.
648 If POSITION is nil, don't display the menu at all, just precalculate the
649 cached information about equivalent key sequences. */)
651 Lisp_Object position
, menu
;
653 Lisp_Object keymap
, tem
;
654 int xpos
= 0, ypos
= 0;
657 Lisp_Object selection
;
659 Lisp_Object x
, y
, window
;
665 if (! NILP (position
))
669 /* Decode the first argument: find the window and the coordinates. */
670 if (EQ (position
, Qt
)
671 || (CONSP (position
) && (EQ (XCAR (position
), Qmenu_bar
)
672 || EQ (XCAR (position
), Qtool_bar
))))
674 /* Use the mouse's current position. */
675 FRAME_PTR new_f
= SELECTED_FRAME ();
676 Lisp_Object bar_window
;
677 enum scroll_bar_part part
;
680 if (mouse_position_hook
)
681 (*mouse_position_hook
) (&new_f
, 1, &bar_window
,
682 &part
, &x
, &y
, &time
);
684 XSETFRAME (window
, new_f
);
687 window
= selected_window
;
694 tem
= Fcar (position
);
697 window
= Fcar (Fcdr (position
));
699 y
= Fcar (Fcdr (tem
));
704 tem
= Fcar (Fcdr (position
)); /* EVENT_START (position) */
705 window
= Fcar (tem
); /* POSN_WINDOW (tem) */
706 tem
= Fcar (Fcdr (Fcdr (tem
))); /* POSN_WINDOW_POSN (tem) */
715 /* Decode where to put the menu. */
723 else if (WINDOWP (window
))
725 CHECK_LIVE_WINDOW (window
);
726 f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
728 xpos
= (FONT_WIDTH (FRAME_FONT (f
))
729 * XFASTINT (XWINDOW (window
)->left
));
730 ypos
= (FRAME_LINE_HEIGHT (f
)
731 * XFASTINT (XWINDOW (window
)->top
));
734 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
735 but I don't want to make one now. */
736 CHECK_WINDOW (window
);
741 XSETFRAME (Vmenu_updating_frame
, f
);
743 Vmenu_updating_frame
= Qnil
;
744 #endif /* HAVE_MENUS */
749 /* Decode the menu items from what was specified. */
751 keymap
= get_keymap (menu
, 0, 0);
754 /* We were given a keymap. Extract menu info from the keymap. */
757 /* Extract the detailed info to make one pane. */
758 keymap_panes (&menu
, 1, NILP (position
));
760 /* Search for a string appearing directly as an element of the keymap.
761 That string is the title of the menu. */
762 prompt
= Fkeymap_prompt (keymap
);
763 if (NILP (title
) && !NILP (prompt
))
766 /* Make that be the pane title of the first pane. */
767 if (!NILP (prompt
) && menu_items_n_panes
>= 0)
768 ASET (menu_items
, MENU_ITEMS_PANE_NAME
, prompt
);
772 else if (CONSP (menu
) && KEYMAPP (XCAR (menu
)))
774 /* We were given a list of keymaps. */
775 int nmaps
= XFASTINT (Flength (menu
));
777 = (Lisp_Object
*) alloca (nmaps
* sizeof (Lisp_Object
));
782 /* The first keymap that has a prompt string
783 supplies the menu title. */
784 for (tem
= menu
, i
= 0; CONSP (tem
); tem
= Fcdr (tem
))
788 maps
[i
++] = keymap
= get_keymap (Fcar (tem
), 1, 0);
790 prompt
= Fkeymap_prompt (keymap
);
791 if (NILP (title
) && !NILP (prompt
))
795 /* Extract the detailed info to make one pane. */
796 keymap_panes (maps
, nmaps
, NILP (position
));
798 /* Make the title be the pane title of the first pane. */
799 if (!NILP (title
) && menu_items_n_panes
>= 0)
800 ASET (menu_items
, MENU_ITEMS_PANE_NAME
, title
);
806 /* We were given an old-fashioned menu. */
808 CHECK_STRING (title
);
810 list_of_panes (Fcdr (menu
));
817 discard_menu_items ();
823 /* If resources from a previous popup menu exist yet, does nothing
824 until the `menu_free_timer' has freed them (see w32fns.c).
826 if (current_popup_menu
)
828 discard_menu_items ();
833 /* Display them in a menu. */
836 selection
= w32_menu_show (f
, xpos
, ypos
, for_click
,
837 keymaps
, title
, &error_name
);
840 discard_menu_items ();
841 #endif /* HAVE_MENUS */
845 if (error_name
) error (error_name
);
851 DEFUN ("x-popup-dialog", Fx_popup_dialog
, Sx_popup_dialog
, 2, 2, 0,
852 doc
: /* Pop up a dialog box and return user's selection.
853 POSITION specifies which frame to use.
854 This is normally a mouse button event or a window or frame.
855 If POSITION is t, it means to use the frame the mouse is on.
856 The dialog box appears in the middle of the specified frame.
858 CONTENTS specifies the alternatives to display in the dialog box.
859 It is a list of the form (TITLE ITEM1 ITEM2...).
860 Each ITEM is a cons cell (STRING . VALUE).
861 The return value is VALUE from the chosen item.
863 An ITEM may also be just a string--that makes a nonselectable item.
864 An ITEM may also be nil--that means to put all preceding items
865 on the left of the dialog box and all following items on the right.
866 \(By default, approximately half appear on each side.) */)
868 Lisp_Object position
, contents
;
875 /* Decode the first argument: find the window or frame to use. */
876 if (EQ (position
, Qt
)
877 || (CONSP (position
) && (EQ (XCAR (position
), Qmenu_bar
)
878 || EQ (XCAR (position
), Qtool_bar
))))
880 #if 0 /* Using the frame the mouse is on may not be right. */
881 /* Use the mouse's current position. */
882 FRAME_PTR new_f
= SELECTED_FRAME ();
883 Lisp_Object bar_window
;
884 enum scroll_bar_part part
;
888 (*mouse_position_hook
) (&new_f
, 1, &bar_window
, &part
, &x
, &y
, &time
);
891 XSETFRAME (window
, new_f
);
893 window
= selected_window
;
895 window
= selected_window
;
897 else if (CONSP (position
))
900 tem
= Fcar (position
);
902 window
= Fcar (Fcdr (position
));
905 tem
= Fcar (Fcdr (position
)); /* EVENT_START (position) */
906 window
= Fcar (tem
); /* POSN_WINDOW (tem) */
909 else if (WINDOWP (position
) || FRAMEP (position
))
914 /* Decode where to put the menu. */
918 else if (WINDOWP (window
))
920 CHECK_LIVE_WINDOW (window
);
921 f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
924 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
925 but I don't want to make one now. */
926 CHECK_WINDOW (window
);
929 /* Display a menu with these alternatives
930 in the middle of frame F. */
932 Lisp_Object x
, y
, frame
, newpos
;
933 XSETFRAME (frame
, f
);
934 XSETINT (x
, x_pixel_width (f
) / 2);
935 XSETINT (y
, x_pixel_height (f
) / 2);
936 newpos
= Fcons (Fcons (x
, Fcons (y
, Qnil
)), Fcons (frame
, Qnil
));
938 return Fx_popup_menu (newpos
,
939 Fcons (Fcar (contents
), Fcons (contents
, Qnil
)));
941 #else /* HAVE_DIALOGS */
945 Lisp_Object selection
;
947 /* Decode the dialog items from what was specified. */
948 title
= Fcar (contents
);
949 CHECK_STRING (title
);
951 list_of_panes (Fcons (contents
, Qnil
));
953 /* Display them in a dialog box. */
955 selection
= w32_dialog_show (f
, 0, title
, &error_name
);
958 discard_menu_items ();
960 if (error_name
) error (error_name
);
963 #endif /* HAVE_DIALOGS */
966 /* Activate the menu bar of frame F.
967 This is called from keyboard.c when it gets the
968 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
970 To activate the menu bar, we signal to the input thread that it can
971 return from the WM_INITMENU message, allowing the normal Windows
972 processing of the menus.
974 But first we recompute the menu bar contents (the whole tree).
976 This way we can safely execute Lisp code. */
979 x_activate_menubar (f
)
982 set_frame_menubar (f
, 0, 1);
984 /* Lock out further menubar changes while active. */
985 f
->output_data
.w32
->menubar_active
= 1;
987 /* Signal input thread to return from WM_INITMENU. */
988 complete_deferred_msg (FRAME_W32_WINDOW (f
), WM_INITMENU
, 0);
991 /* This callback is called from the menu bar pulldown menu
992 when the user makes a selection.
993 Figure out what the user chose
994 and put the appropriate events into the keyboard buffer. */
997 menubar_selection_callback (FRAME_PTR f
, void * client_data
)
999 Lisp_Object prefix
, entry
;
1001 Lisp_Object
*subprefix_stack
;
1002 int submenu_depth
= 0;
1008 subprefix_stack
= (Lisp_Object
*) alloca (f
->menu_bar_items_used
* sizeof (Lisp_Object
));
1009 vector
= f
->menu_bar_vector
;
1012 while (i
< f
->menu_bar_items_used
)
1014 if (EQ (AREF (vector
, i
), Qnil
))
1016 subprefix_stack
[submenu_depth
++] = prefix
;
1020 else if (EQ (AREF (vector
, i
), Qlambda
))
1022 prefix
= subprefix_stack
[--submenu_depth
];
1025 else if (EQ (AREF (vector
, i
), Qt
))
1027 prefix
= AREF (vector
, i
+ MENU_ITEMS_PANE_PREFIX
);
1028 i
+= MENU_ITEMS_PANE_LENGTH
;
1032 entry
= AREF (vector
, i
+ MENU_ITEMS_ITEM_VALUE
);
1033 /* The EMACS_INT cast avoids a warning. There's no problem
1034 as long as pointers have enough bits to hold small integers. */
1035 if ((int) (EMACS_INT
) client_data
== i
)
1038 struct input_event buf
;
1041 XSETFRAME (frame
, f
);
1042 buf
.kind
= MENU_BAR_EVENT
;
1043 buf
.frame_or_window
= frame
;
1045 kbd_buffer_store_event (&buf
);
1047 for (j
= 0; j
< submenu_depth
; j
++)
1048 if (!NILP (subprefix_stack
[j
]))
1050 buf
.kind
= MENU_BAR_EVENT
;
1051 buf
.frame_or_window
= frame
;
1052 buf
.arg
= subprefix_stack
[j
];
1053 kbd_buffer_store_event (&buf
);
1058 buf
.kind
= MENU_BAR_EVENT
;
1059 buf
.frame_or_window
= frame
;
1061 kbd_buffer_store_event (&buf
);
1064 buf
.kind
= MENU_BAR_EVENT
;
1065 buf
.frame_or_window
= frame
;
1067 kbd_buffer_store_event (&buf
);
1069 /* Free memory used by owner-drawn and help-echo strings. */
1070 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
1071 f
->output_data
.w32
->menu_command_in_progress
= 0;
1072 f
->output_data
.w32
->menubar_active
= 0;
1075 i
+= MENU_ITEMS_ITEM_LENGTH
;
1078 /* Free memory used by owner-drawn and help-echo strings. */
1079 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
1080 f
->output_data
.w32
->menu_command_in_progress
= 0;
1081 f
->output_data
.w32
->menubar_active
= 0;
1084 /* Allocate a widget_value, blocking input. */
1087 xmalloc_widget_value ()
1089 widget_value
*value
;
1092 value
= malloc_widget_value ();
1098 /* This recursively calls free_widget_value on the tree of widgets.
1099 It must free all data that was malloc'ed for these widget_values.
1100 In Emacs, many slots are pointers into the data of Lisp_Strings, and
1101 must be left alone. */
1104 free_menubar_widget_value_tree (wv
)
1109 wv
->name
= wv
->value
= wv
->key
= (char *) 0xDEADBEEF;
1111 if (wv
->contents
&& (wv
->contents
!= (widget_value
*)1))
1113 free_menubar_widget_value_tree (wv
->contents
);
1114 wv
->contents
= (widget_value
*) 0xDEADBEEF;
1118 free_menubar_widget_value_tree (wv
->next
);
1119 wv
->next
= (widget_value
*) 0xDEADBEEF;
1122 free_widget_value (wv
);
1126 /* Set up data i menu_items for a menu bar item
1127 whose event type is ITEM_KEY (with string ITEM_NAME)
1128 and whose contents come from the list of keymaps MAPS. */
1131 parse_single_submenu (item_key
, item_name
, maps
)
1132 Lisp_Object item_key
, item_name
, maps
;
1136 Lisp_Object
*mapvec
;
1138 int top_level_items
= 0;
1140 length
= Flength (maps
);
1141 len
= XINT (length
);
1143 /* Convert the list MAPS into a vector MAPVEC. */
1144 mapvec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
1145 for (i
= 0; i
< len
; i
++)
1147 mapvec
[i
] = Fcar (maps
);
1151 /* Loop over the given keymaps, making a pane for each map.
1152 But don't make a pane that is empty--ignore that map instead. */
1153 for (i
= 0; i
< len
; i
++)
1155 if (SYMBOLP (mapvec
[i
])
1156 || (CONSP (mapvec
[i
]) && !KEYMAPP (mapvec
[i
])))
1158 /* Here we have a command at top level in the menu bar
1159 as opposed to a submenu. */
1160 top_level_items
= 1;
1161 push_menu_pane (Qnil
, Qnil
);
1162 push_menu_item (item_name
, Qt
, item_key
, mapvec
[i
],
1163 Qnil
, Qnil
, Qnil
, Qnil
);
1168 prompt
= Fkeymap_prompt (mapvec
[i
]);
1169 single_keymap_panes (mapvec
[i
],
1170 !NILP (prompt
) ? prompt
: item_name
,
1175 return top_level_items
;
1179 /* Create a tree of widget_value objects
1180 representing the panes and items
1181 in menu_items starting at index START, up to index END. */
1183 static widget_value
*
1184 digest_single_submenu (start
, end
, top_level_items
)
1185 int start
, end
, top_level_items
;
1187 widget_value
*wv
, *prev_wv
, *save_wv
, *first_wv
;
1189 int submenu_depth
= 0;
1190 widget_value
**submenu_stack
;
1193 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
1194 wv
= xmalloc_widget_value ();
1198 wv
->button_type
= BUTTON_TYPE_NONE
;
1204 /* Loop over all panes and items made by the preceding call
1205 to parse_single_submenu and construct a tree of widget_value objects.
1206 Ignore the panes and items used by previous calls to
1207 digest_single_submenu, even though those are also in menu_items. */
1211 if (EQ (AREF (menu_items
, i
), Qnil
))
1213 submenu_stack
[submenu_depth
++] = save_wv
;
1218 else if (EQ (AREF (menu_items
, i
), Qlambda
))
1221 save_wv
= submenu_stack
[--submenu_depth
];
1224 else if (EQ (AREF (menu_items
, i
), Qt
)
1225 && submenu_depth
!= 0)
1226 i
+= MENU_ITEMS_PANE_LENGTH
;
1227 /* Ignore a nil in the item list.
1228 It's meaningful only for dialog boxes. */
1229 else if (EQ (AREF (menu_items
, i
), Qquote
))
1231 else if (EQ (AREF (menu_items
, i
), Qt
))
1233 /* Create a new pane. */
1234 Lisp_Object pane_name
, prefix
;
1237 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
1238 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
1240 #ifndef HAVE_MULTILINGUAL_MENU
1241 if (STRINGP (pane_name
) && STRING_MULTIBYTE (pane_name
))
1243 pane_name
= ENCODE_SYSTEM (pane_name
);
1244 ASET (menu_items
, i
+ MENU_ITEMS_PANE_NAME
, pane_name
);
1247 pane_string
= (NILP (pane_name
)
1248 ? "" : (char *) SDATA (pane_name
));
1249 /* If there is just one top-level pane, put all its items directly
1250 under the top-level menu. */
1251 if (menu_items_n_panes
== 1)
1254 /* If the pane has a meaningful name,
1255 make the pane a top-level menu item
1256 with its items as a submenu beneath it. */
1257 if (strcmp (pane_string
, ""))
1259 wv
= xmalloc_widget_value ();
1263 first_wv
->contents
= wv
;
1264 wv
->name
= pane_string
;
1265 /* Ignore the @ that means "separate pane".
1266 This is a kludge, but this isn't worth more time. */
1267 if (!NILP (prefix
) && wv
->name
[0] == '@')
1271 wv
->button_type
= BUTTON_TYPE_NONE
;
1276 i
+= MENU_ITEMS_PANE_LENGTH
;
1280 /* Create a new item within current pane. */
1281 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
;
1284 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
1285 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
1286 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
1287 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
1288 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
1289 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
1290 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
1292 #ifndef HAVE_MULTILINGUAL_MENU
1293 if (STRING_MULTIBYTE (item_name
))
1295 item_name
= ENCODE_SYSTEM (item_name
);
1296 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
, item_name
);
1299 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
1301 descrip
= ENCODE_SYSTEM (descrip
);
1302 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
, descrip
);
1304 #endif /* not HAVE_MULTILINGUAL_MENU */
1306 wv
= xmalloc_widget_value ();
1310 save_wv
->contents
= wv
;
1312 wv
->name
= (char *) SDATA (item_name
);
1313 if (!NILP (descrip
))
1314 wv
->key
= (char *) SDATA (descrip
);
1316 /* The EMACS_INT cast avoids a warning. There's no problem
1317 as long as pointers have enough bits to hold small integers. */
1318 wv
->call_data
= (!NILP (def
) ? (void *) (EMACS_INT
) i
: 0);
1319 wv
->enabled
= !NILP (enable
);
1322 wv
->button_type
= BUTTON_TYPE_NONE
;
1323 else if (EQ (type
, QCradio
))
1324 wv
->button_type
= BUTTON_TYPE_RADIO
;
1325 else if (EQ (type
, QCtoggle
))
1326 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
1330 wv
->selected
= !NILP (selected
);
1331 if (!STRINGP (help
))
1338 i
+= MENU_ITEMS_ITEM_LENGTH
;
1342 /* If we have just one "menu item"
1343 that was originally a button, return it by itself. */
1344 if (top_level_items
&& first_wv
->contents
&& first_wv
->contents
->next
== 0)
1346 wv
= first_wv
->contents
;
1347 free_widget_value (first_wv
);
1354 /* Set the contents of the menubar widgets of frame F.
1355 The argument FIRST_TIME is currently ignored;
1356 it is set the first time this is called, from initialize_frame_menubar. */
1359 set_frame_menubar (f
, first_time
, deep_p
)
1364 HMENU menubar_widget
= f
->output_data
.w32
->menubar_widget
;
1366 widget_value
*wv
, *first_wv
, *prev_wv
= 0;
1368 int *submenu_start
, *submenu_end
;
1369 int *submenu_top_level_items
, *submenu_n_panes
;
1371 /* We must not change the menubar when actually in use. */
1372 if (f
->output_data
.w32
->menubar_active
)
1375 XSETFRAME (Vmenu_updating_frame
, f
);
1377 if (! menubar_widget
)
1379 else if (pending_menu_activation
&& !deep_p
)
1384 /* Make a widget-value tree representing the entire menu trees. */
1386 struct buffer
*prev
= current_buffer
;
1388 int specpdl_count
= SPECPDL_INDEX ();
1389 int previous_menu_items_used
= f
->menu_bar_items_used
;
1390 Lisp_Object
*previous_items
1391 = (Lisp_Object
*) alloca (previous_menu_items_used
1392 * sizeof (Lisp_Object
));
1394 /* If we are making a new widget, its contents are empty,
1395 do always reinitialize them. */
1396 if (! menubar_widget
)
1397 previous_menu_items_used
= 0;
1399 buffer
= XWINDOW (FRAME_SELECTED_WINDOW (f
))->buffer
;
1400 specbind (Qinhibit_quit
, Qt
);
1401 /* Don't let the debugger step into this code
1402 because it is not reentrant. */
1403 specbind (Qdebug_on_next_call
, Qnil
);
1405 record_unwind_protect (Fset_match_data
, Fmatch_data (Qnil
, Qnil
));
1406 if (NILP (Voverriding_local_map_menu_flag
))
1408 specbind (Qoverriding_terminal_local_map
, Qnil
);
1409 specbind (Qoverriding_local_map
, Qnil
);
1412 set_buffer_internal_1 (XBUFFER (buffer
));
1414 /* Run the Lucid hook. */
1415 safe_run_hooks (Qactivate_menubar_hook
);
1416 /* If it has changed current-menubar from previous value,
1417 really recompute the menubar from the value. */
1418 if (! NILP (Vlucid_menu_bar_dirty_flag
))
1419 call0 (Qrecompute_lucid_menubar
);
1420 safe_run_hooks (Qmenu_bar_update_hook
);
1421 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
1423 items
= FRAME_MENU_BAR_ITEMS (f
);
1425 /* Save the frame's previous menu bar contents data. */
1426 if (previous_menu_items_used
)
1427 bcopy (XVECTOR (f
->menu_bar_vector
)->contents
, previous_items
,
1428 previous_menu_items_used
* sizeof (Lisp_Object
));
1430 /* Fill in menu_items with the current menu bar contents.
1431 This can evaluate Lisp code. */
1432 menu_items
= f
->menu_bar_vector
;
1433 menu_items_allocated
= VECTORP (menu_items
) ? ASIZE (menu_items
) : 0;
1434 submenu_start
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
1435 submenu_end
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
1436 submenu_n_panes
= (int *) alloca (XVECTOR (items
)->size
* sizeof (int));
1437 submenu_top_level_items
1438 = (int *) alloca (XVECTOR (items
)->size
* sizeof (int *));
1440 for (i
= 0; i
< ASIZE (items
); i
+= 4)
1442 Lisp_Object key
, string
, maps
;
1446 key
= AREF (items
, i
);
1447 string
= AREF (items
, i
+ 1);
1448 maps
= AREF (items
, i
+ 2);
1452 submenu_start
[i
] = menu_items_used
;
1454 menu_items_n_panes
= 0;
1455 submenu_top_level_items
[i
]
1456 = parse_single_submenu (key
, string
, maps
);
1457 submenu_n_panes
[i
] = menu_items_n_panes
;
1459 submenu_end
[i
] = menu_items_used
;
1462 finish_menu_items ();
1464 /* Convert menu_items into widget_value trees
1465 to display the menu. This cannot evaluate Lisp code. */
1467 wv
= xmalloc_widget_value ();
1468 wv
->name
= "menubar";
1471 wv
->button_type
= BUTTON_TYPE_NONE
;
1475 for (i
= 0; i
< last_i
; i
+= 4)
1477 menu_items_n_panes
= submenu_n_panes
[i
];
1478 wv
= digest_single_submenu (submenu_start
[i
], submenu_end
[i
],
1479 submenu_top_level_items
[i
]);
1483 first_wv
->contents
= wv
;
1484 /* Don't set wv->name here; GC during the loop might relocate it. */
1486 wv
->button_type
= BUTTON_TYPE_NONE
;
1490 set_buffer_internal_1 (prev
);
1491 unbind_to (specpdl_count
, Qnil
);
1493 /* If there has been no change in the Lisp-level contents
1494 of the menu bar, skip redisplaying it. Just exit. */
1496 for (i
= 0; i
< previous_menu_items_used
; i
++)
1497 if (menu_items_used
== i
1498 || (!EQ (previous_items
[i
], AREF (menu_items
, i
))))
1500 if (i
== menu_items_used
&& i
== previous_menu_items_used
&& i
!= 0)
1502 free_menubar_widget_value_tree (first_wv
);
1508 /* Now GC cannot happen during the lifetime of the widget_value,
1509 so it's safe to store data from a Lisp_String, as long as
1510 local copies are made when the actual menu is created.
1511 Windows takes care of this for normal string items, but
1512 not for owner-drawn items or additional item-info. */
1513 wv
= first_wv
->contents
;
1514 for (i
= 0; i
< ASIZE (items
); i
+= 4)
1517 string
= AREF (items
, i
+ 1);
1520 wv
->name
= (char *) SDATA (string
);
1524 f
->menu_bar_vector
= menu_items
;
1525 f
->menu_bar_items_used
= menu_items_used
;
1530 /* Make a widget-value tree containing
1531 just the top level menu bar strings. */
1533 wv
= xmalloc_widget_value ();
1534 wv
->name
= "menubar";
1537 wv
->button_type
= BUTTON_TYPE_NONE
;
1541 items
= FRAME_MENU_BAR_ITEMS (f
);
1542 for (i
= 0; i
< ASIZE (items
); i
+= 4)
1546 string
= AREF (items
, i
+ 1);
1550 wv
= xmalloc_widget_value ();
1551 wv
->name
= (char *) SDATA (string
);
1554 wv
->button_type
= BUTTON_TYPE_NONE
;
1556 /* This prevents lwlib from assuming this
1557 menu item is really supposed to be empty. */
1558 /* The EMACS_INT cast avoids a warning.
1559 This value just has to be different from small integers. */
1560 wv
->call_data
= (void *) (EMACS_INT
) (-1);
1565 first_wv
->contents
= wv
;
1569 /* Forget what we thought we knew about what is in the
1570 detailed contents of the menu bar menus.
1571 Changing the top level always destroys the contents. */
1572 f
->menu_bar_items_used
= 0;
1575 /* Create or update the menu bar widget. */
1581 /* Empty current menubar, rather than creating a fresh one. */
1582 while (DeleteMenu (menubar_widget
, 0, MF_BYPOSITION
))
1587 menubar_widget
= CreateMenu ();
1589 fill_in_menu (menubar_widget
, first_wv
->contents
);
1591 free_menubar_widget_value_tree (first_wv
);
1594 HMENU old_widget
= f
->output_data
.w32
->menubar_widget
;
1596 f
->output_data
.w32
->menubar_widget
= menubar_widget
;
1597 SetMenu (FRAME_W32_WINDOW (f
), f
->output_data
.w32
->menubar_widget
);
1598 /* Causes flicker when menu bar is updated
1599 DrawMenuBar (FRAME_W32_WINDOW (f)); */
1601 /* Force the window size to be recomputed so that the frame's text
1602 area remains the same, if menubar has just been created. */
1603 if (old_widget
== NULL
)
1604 x_set_window_size (f
, 0, FRAME_WIDTH (f
), FRAME_HEIGHT (f
));
1610 /* Called from Fx_create_frame to create the initial menubar of a frame
1611 before it is mapped, so that the window is mapped with the menubar already
1612 there instead of us tacking it on later and thrashing the window after it
1616 initialize_frame_menubar (f
)
1619 /* This function is called before the first chance to redisplay
1620 the frame. It has to be, so the frame will have the right size. */
1621 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
1622 set_frame_menubar (f
, 1, 1);
1625 /* Get rid of the menu bar of frame F, and free its storage.
1626 This is used when deleting a frame, and when turning off the menu bar. */
1629 free_frame_menubar (f
)
1635 HMENU old
= GetMenu (FRAME_W32_WINDOW (f
));
1636 SetMenu (FRAME_W32_WINDOW (f
), NULL
);
1637 f
->output_data
.w32
->menubar_widget
= NULL
;
1645 /* w32_menu_show actually displays a menu using the panes and items in
1646 menu_items and returns the value selected from it; we assume input
1647 is blocked by the caller. */
1649 /* F is the frame the menu is for.
1650 X and Y are the frame-relative specified position,
1651 relative to the inside upper left corner of the frame F.
1652 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
1653 KEYMAPS is 1 if this menu was specified with keymaps;
1654 in that case, we return a list containing the chosen item's value
1655 and perhaps also the pane's prefix.
1656 TITLE is the specified menu title.
1657 ERROR is a place to store an error message string in case of failure.
1658 (We return nil on failure, but the value doesn't actually matter.) */
1661 w32_menu_show (f
, x
, y
, for_click
, keymaps
, title
, error
)
1671 int menu_item_selection
;
1674 widget_value
*wv
, *save_wv
= 0, *first_wv
= 0, *prev_wv
= 0;
1675 widget_value
**submenu_stack
1676 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
1677 Lisp_Object
*subprefix_stack
1678 = (Lisp_Object
*) alloca (menu_items_used
* sizeof (Lisp_Object
));
1679 int submenu_depth
= 0;
1684 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
1686 *error
= "Empty menu";
1690 /* Create a tree of widget_value objects
1691 representing the panes and their items. */
1692 wv
= xmalloc_widget_value ();
1696 wv
->button_type
= BUTTON_TYPE_NONE
;
1701 /* Loop over all panes and items, filling in the tree. */
1703 while (i
< menu_items_used
)
1705 if (EQ (AREF (menu_items
, i
), Qnil
))
1707 submenu_stack
[submenu_depth
++] = save_wv
;
1713 else if (EQ (AREF (menu_items
, i
), Qlambda
))
1716 save_wv
= submenu_stack
[--submenu_depth
];
1720 else if (EQ (AREF (menu_items
, i
), Qt
)
1721 && submenu_depth
!= 0)
1722 i
+= MENU_ITEMS_PANE_LENGTH
;
1723 /* Ignore a nil in the item list.
1724 It's meaningful only for dialog boxes. */
1725 else if (EQ (AREF (menu_items
, i
), Qquote
))
1727 else if (EQ (AREF (menu_items
, i
), Qt
))
1729 /* Create a new pane. */
1730 Lisp_Object pane_name
, prefix
;
1732 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
1733 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
1734 #ifndef HAVE_MULTILINGUAL_MENU
1735 if (STRINGP (pane_name
) && STRING_MULTIBYTE (pane_name
))
1737 pane_name
= ENCODE_SYSTEM (pane_name
);
1738 ASET (menu_items
, i
+ MENU_ITEMS_PANE_NAME
, pane_name
);
1741 pane_string
= (NILP (pane_name
)
1742 ? "" : (char *) SDATA (pane_name
));
1743 /* If there is just one top-level pane, put all its items directly
1744 under the top-level menu. */
1745 if (menu_items_n_panes
== 1)
1748 /* If the pane has a meaningful name,
1749 make the pane a top-level menu item
1750 with its items as a submenu beneath it. */
1751 if (!keymaps
&& strcmp (pane_string
, ""))
1753 wv
= xmalloc_widget_value ();
1757 first_wv
->contents
= wv
;
1758 wv
->name
= pane_string
;
1759 if (keymaps
&& !NILP (prefix
))
1763 wv
->button_type
= BUTTON_TYPE_NONE
;
1768 else if (first_pane
)
1774 i
+= MENU_ITEMS_PANE_LENGTH
;
1778 /* Create a new item within current pane. */
1779 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
, help
;
1781 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
1782 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
1783 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
1784 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
1785 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
1786 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
1787 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
1789 #ifndef HAVE_MULTILINGUAL_MENU
1790 if (STRINGP (item_name
) && STRING_MULTIBYTE (item_name
))
1792 item_name
= ENCODE_SYSTEM (item_name
);
1793 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
, item_name
);
1795 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
1797 descrip
= ENCODE_SYSTEM (descrip
);
1798 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
, descrip
);
1800 #endif /* not HAVE_MULTILINGUAL_MENU */
1802 wv
= xmalloc_widget_value ();
1806 save_wv
->contents
= wv
;
1807 wv
->name
= (char *) SDATA (item_name
);
1808 if (!NILP (descrip
))
1809 wv
->key
= (char *) SDATA (descrip
);
1811 /* Use the contents index as call_data, since we are
1812 restricted to 16-bits. */
1813 wv
->call_data
= !NILP (def
) ? (void *) (EMACS_INT
) i
: 0;
1814 wv
->enabled
= !NILP (enable
);
1817 wv
->button_type
= BUTTON_TYPE_NONE
;
1818 else if (EQ (type
, QCtoggle
))
1819 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
1820 else if (EQ (type
, QCradio
))
1821 wv
->button_type
= BUTTON_TYPE_RADIO
;
1825 wv
->selected
= !NILP (selected
);
1826 if (!STRINGP (help
))
1833 i
+= MENU_ITEMS_ITEM_LENGTH
;
1837 /* Deal with the title, if it is non-nil. */
1840 widget_value
*wv_title
= xmalloc_widget_value ();
1841 widget_value
*wv_sep
= xmalloc_widget_value ();
1843 /* Maybe replace this separator with a bitmap or owner-draw item
1844 so that it looks better. Having two separators looks odd. */
1845 wv_sep
->name
= "--";
1846 wv_sep
->next
= first_wv
->contents
;
1847 wv_sep
->help
= Qnil
;
1849 #ifndef HAVE_MULTILINGUAL_MENU
1850 if (STRING_MULTIBYTE (title
))
1851 title
= ENCODE_SYSTEM (title
);
1853 wv_title
->name
= (char *) SDATA (title
);
1854 wv_title
->enabled
= TRUE
;
1855 wv_title
->title
= TRUE
;
1856 wv_title
->button_type
= BUTTON_TYPE_NONE
;
1857 wv_title
->help
= Qnil
;
1858 wv_title
->next
= wv_sep
;
1859 first_wv
->contents
= wv_title
;
1862 /* Actually create the menu. */
1863 current_popup_menu
= menu
= CreatePopupMenu ();
1864 fill_in_menu (menu
, first_wv
->contents
);
1866 /* Adjust coordinates to be root-window-relative. */
1869 ClientToScreen (FRAME_W32_WINDOW (f
), &pos
);
1871 /* No selection has been chosen yet. */
1872 menu_item_selection
= 0;
1874 /* Display the menu. */
1875 menu_item_selection
= SendMessage (FRAME_W32_WINDOW (f
),
1876 WM_EMACS_TRACKPOPUPMENU
,
1877 (WPARAM
)menu
, (LPARAM
)&pos
);
1879 /* Clean up extraneous mouse events which might have been generated
1881 discard_mouse_events ();
1883 /* Free the widget_value objects we used to specify the contents. */
1884 free_menubar_widget_value_tree (first_wv
);
1888 /* Find the selected item, and its pane, to return
1889 the proper value. */
1890 if (menu_item_selection
!= 0)
1892 Lisp_Object prefix
, entry
;
1894 prefix
= entry
= Qnil
;
1896 while (i
< menu_items_used
)
1898 if (EQ (AREF (menu_items
, i
), Qnil
))
1900 subprefix_stack
[submenu_depth
++] = prefix
;
1904 else if (EQ (AREF (menu_items
, i
), Qlambda
))
1906 prefix
= subprefix_stack
[--submenu_depth
];
1909 else if (EQ (AREF (menu_items
, i
), Qt
))
1911 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
1912 i
+= MENU_ITEMS_PANE_LENGTH
;
1914 /* Ignore a nil in the item list.
1915 It's meaningful only for dialog boxes. */
1916 else if (EQ (AREF (menu_items
, i
), Qquote
))
1920 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
1921 if (menu_item_selection
== i
)
1927 entry
= Fcons (entry
, Qnil
);
1929 entry
= Fcons (prefix
, entry
);
1930 for (j
= submenu_depth
- 1; j
>= 0; j
--)
1931 if (!NILP (subprefix_stack
[j
]))
1932 entry
= Fcons (subprefix_stack
[j
], entry
);
1936 i
+= MENU_ITEMS_ITEM_LENGTH
;
1946 static char * button_names
[] = {
1947 "button1", "button2", "button3", "button4", "button5",
1948 "button6", "button7", "button8", "button9", "button10" };
1951 w32_dialog_show (f
, keymaps
, title
, error
)
1957 int i
, nb_buttons
=0;
1958 char dialog_name
[6];
1959 int menu_item_selection
;
1961 widget_value
*wv
, *first_wv
= 0, *prev_wv
= 0;
1963 /* Number of elements seen so far, before boundary. */
1965 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
1966 int boundary_seen
= 0;
1970 if (menu_items_n_panes
> 1)
1972 *error
= "Multiple panes in dialog box";
1976 /* Create a tree of widget_value objects
1977 representing the text label and buttons. */
1979 Lisp_Object pane_name
, prefix
;
1981 pane_name
= AREF (menu_items
, MENU_ITEMS_PANE_NAME
);
1982 prefix
= AREF (menu_items
, MENU_ITEMS_PANE_PREFIX
);
1983 pane_string
= (NILP (pane_name
)
1984 ? "" : (char *) SDATA (pane_name
));
1985 prev_wv
= xmalloc_widget_value ();
1986 prev_wv
->value
= pane_string
;
1987 if (keymaps
&& !NILP (prefix
))
1989 prev_wv
->enabled
= 1;
1990 prev_wv
->name
= "message";
1991 prev_wv
->help
= Qnil
;
1994 /* Loop over all panes and items, filling in the tree. */
1995 i
= MENU_ITEMS_PANE_LENGTH
;
1996 while (i
< menu_items_used
)
1999 /* Create a new item within current pane. */
2000 Lisp_Object item_name
, enable
, descrip
, help
;
2002 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
2003 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
2004 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
2005 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
2007 if (NILP (item_name
))
2009 free_menubar_widget_value_tree (first_wv
);
2010 *error
= "Submenu in dialog items";
2013 if (EQ (item_name
, Qquote
))
2015 /* This is the boundary between left-side elts
2016 and right-side elts. Stop incrementing right_count. */
2021 if (nb_buttons
>= 9)
2023 free_menubar_widget_value_tree (first_wv
);
2024 *error
= "Too many dialog items";
2028 wv
= xmalloc_widget_value ();
2030 wv
->name
= (char *) button_names
[nb_buttons
];
2031 if (!NILP (descrip
))
2032 wv
->key
= (char *) SDATA (descrip
);
2033 wv
->value
= (char *) SDATA (item_name
);
2034 wv
->call_data
= (void *) &AREF (menu_items
, i
);
2035 wv
->enabled
= !NILP (enable
);
2039 if (! boundary_seen
)
2043 i
+= MENU_ITEMS_ITEM_LENGTH
;
2046 /* If the boundary was not specified,
2047 by default put half on the left and half on the right. */
2048 if (! boundary_seen
)
2049 left_count
= nb_buttons
- nb_buttons
/ 2;
2051 wv
= xmalloc_widget_value ();
2052 wv
->name
= dialog_name
;
2055 /* Dialog boxes use a really stupid name encoding
2056 which specifies how many buttons to use
2057 and how many buttons are on the right.
2058 The Q means something also. */
2059 dialog_name
[0] = 'Q';
2060 dialog_name
[1] = '0' + nb_buttons
;
2061 dialog_name
[2] = 'B';
2062 dialog_name
[3] = 'R';
2063 /* Number of buttons to put on the right. */
2064 dialog_name
[4] = '0' + nb_buttons
- left_count
;
2066 wv
->contents
= first_wv
;
2070 /* Actually create the dialog. */
2071 dialog_id
= widget_id_tick
++;
2072 menu
= lw_create_widget (first_wv
->name
, "dialog", dialog_id
, first_wv
,
2073 f
->output_data
.w32
->widget
, 1, 0,
2074 dialog_selection_callback
, 0);
2075 lw_modify_all_widgets (dialog_id
, first_wv
->contents
, TRUE
);
2077 /* Free the widget_value objects we used to specify the contents. */
2078 free_menubar_widget_value_tree (first_wv
);
2080 /* No selection has been chosen yet. */
2081 menu_item_selection
= 0;
2083 /* Display the menu. */
2084 lw_pop_up_all_widgets (dialog_id
);
2085 popup_activated_flag
= 1;
2087 /* Process events that apply to the menu. */
2088 popup_get_selection ((XEvent
*) 0, FRAME_X_DISPLAY_INFO (f
), dialog_id
);
2090 lw_destroy_all_widgets (dialog_id
);
2092 /* Find the selected item, and its pane, to return
2093 the proper value. */
2094 if (menu_item_selection
!= 0)
2100 while (i
< menu_items_used
)
2104 if (EQ (AREF (menu_items
, i
), Qt
))
2106 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
2107 i
+= MENU_ITEMS_PANE_LENGTH
;
2111 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
2112 if (menu_item_selection
== i
)
2116 entry
= Fcons (entry
, Qnil
);
2118 entry
= Fcons (prefix
, entry
);
2122 i
+= MENU_ITEMS_ITEM_LENGTH
;
2129 #endif /* HAVE_DIALOGS */
2132 /* Is this item a separator? */
2134 name_is_separator (name
)
2139 /* Check if name string consists of only dashes ('-'). */
2140 while (*name
== '-') name
++;
2141 /* Separators can also be of the form "--:TripleSuperMegaEtched"
2142 or "--deep-shadow". We don't implement them yet, se we just treat
2143 them like normal separators. */
2144 return (*name
== '\0' || start
+ 2 == name
);
2148 /* Indicate boundary between left and right. */
2150 add_left_right_boundary (HMENU menu
)
2152 return AppendMenu (menu
, MF_MENUBARBREAK
, 0, NULL
);
2156 add_menu_item (HMENU menu
, widget_value
*wv
, HMENU item
)
2162 if (name_is_separator (wv
->name
))
2164 fuFlags
= MF_SEPARATOR
;
2170 fuFlags
= MF_STRING
;
2172 fuFlags
= MF_STRING
| MF_GRAYED
;
2174 if (wv
->key
!= NULL
)
2176 out_string
= alloca (strlen (wv
->name
) + strlen (wv
->key
) + 2);
2177 strcpy (out_string
, wv
->name
);
2178 strcat (out_string
, "\t");
2179 strcat (out_string
, wv
->key
);
2182 out_string
= wv
->name
;
2186 else if (wv
->title
|| wv
->call_data
== 0)
2188 /* Only use MF_OWNERDRAW if GetMenuItemInfo is usable, since
2189 we can't deallocate the memory otherwise. */
2190 if (get_menu_item_info
)
2192 out_string
= (char *) local_alloc (strlen (wv
->name
) + 1);
2193 strcpy (out_string
, wv
->name
);
2195 DebPrint ("Menu: allocing %ld for owner-draw", out_string
);
2197 fuFlags
= MF_OWNERDRAW
| MF_DISABLED
;
2200 fuFlags
= MF_DISABLED
;
2203 /* Draw radio buttons and tickboxes. */
2204 else if (wv
->selected
&& (wv
->button_type
== BUTTON_TYPE_TOGGLE
||
2205 wv
->button_type
== BUTTON_TYPE_RADIO
))
2206 fuFlags
|= MF_CHECKED
;
2208 fuFlags
|= MF_UNCHECKED
;
2214 item
!= NULL
? (UINT
) item
: (UINT
) wv
->call_data
,
2217 /* This must be done after the menu item is created. */
2218 if (!wv
->title
&& wv
->call_data
!= 0)
2220 if (set_menu_item_info
)
2223 bzero (&info
, sizeof (info
));
2224 info
.cbSize
= sizeof (info
);
2225 info
.fMask
= MIIM_DATA
;
2227 /* Set help string for menu item. Leave it as a Lisp_Object
2228 until it is ready to be displayed, since GC can happen while
2229 menus are active. */
2231 info
.dwItemData
= (DWORD
) wv
->help
;
2233 if (wv
->button_type
== BUTTON_TYPE_RADIO
)
2235 /* CheckMenuRadioItem allows us to differentiate TOGGLE and
2236 RADIO items, but is not available on NT 3.51 and earlier. */
2237 info
.fMask
|= MIIM_TYPE
| MIIM_STATE
;
2238 info
.fType
= MFT_RADIOCHECK
| MFT_STRING
;
2239 info
.dwTypeData
= out_string
;
2240 info
.fState
= wv
->selected
? MFS_CHECKED
: MFS_UNCHECKED
;
2243 set_menu_item_info (menu
,
2244 item
!= NULL
? (UINT
) item
: (UINT
) wv
->call_data
,
2248 return return_value
;
2251 /* Construct native Windows menu(bar) based on widget_value tree. */
2253 fill_in_menu (HMENU menu
, widget_value
*wv
)
2255 int items_added
= 0;
2257 for ( ; wv
!= NULL
; wv
= wv
->next
)
2261 HMENU sub_menu
= CreatePopupMenu ();
2263 if (sub_menu
== NULL
)
2266 if (!fill_in_menu (sub_menu
, wv
->contents
) ||
2267 !add_menu_item (menu
, wv
, sub_menu
))
2269 DestroyMenu (sub_menu
);
2275 if (!add_menu_item (menu
, wv
, NULL
))
2285 /* popup_activated_flag not actually used on W32 */
2289 /* Display help string for currently pointed to menu item. Not
2290 supported on NT 3.51 and earlier, as GetMenuItemInfo is not
2293 w32_menu_display_help (HWND owner
, HMENU menu
, UINT item
, UINT flags
)
2295 if (get_menu_item_info
)
2297 struct frame
*f
= x_window_to_frame (&one_w32_display_info
, owner
);
2298 Lisp_Object frame
, help
;
2300 // No help echo on owner-draw menu items.
2301 if (flags
& MF_OWNERDRAW
|| flags
& MF_POPUP
)
2307 bzero (&info
, sizeof (info
));
2308 info
.cbSize
= sizeof (info
);
2309 info
.fMask
= MIIM_DATA
;
2310 get_menu_item_info (menu
, item
, FALSE
, &info
);
2312 help
= info
.dwItemData
? (Lisp_Object
) info
.dwItemData
: Qnil
;
2315 /* Store the help echo in the keyboard buffer as the X toolkit
2316 version does, rather than directly showing it. This seems to
2317 solve the GC problems that were present when we based the
2318 Windows code on the non-toolkit version. */
2321 XSETFRAME (frame
, f
);
2322 kbd_buffer_store_help_event (frame
, help
);
2325 /* X version has a loop through frames here, which doesn't
2326 appear to do anything, unless it has some side effect. */
2327 show_help_echo (help
, Qnil
, Qnil
, Qnil
, 1);
2331 /* Free memory used by owner-drawn strings. */
2333 w32_free_submenu_strings (menu
)
2336 int i
, num
= GetMenuItemCount (menu
);
2337 for (i
= 0; i
< num
; i
++)
2340 bzero (&info
, sizeof (info
));
2341 info
.cbSize
= sizeof (info
);
2342 info
.fMask
= MIIM_DATA
| MIIM_TYPE
| MIIM_SUBMENU
;
2344 get_menu_item_info (menu
, i
, TRUE
, &info
);
2346 /* Owner-drawn names are held in dwItemData. */
2347 if ((info
.fType
& MF_OWNERDRAW
) && info
.dwItemData
)
2350 DebPrint ("Menu: freeing %ld for owner-draw", info
.dwItemData
);
2352 local_free (info
.dwItemData
);
2355 /* Recurse down submenus. */
2357 w32_free_submenu_strings (info
.hSubMenu
);
2362 w32_free_menu_strings (hwnd
)
2365 HMENU menu
= current_popup_menu
;
2367 if (get_menu_item_info
)
2369 /* If there is no popup menu active, free the strings from the frame's
2372 menu
= GetMenu (hwnd
);
2375 w32_free_submenu_strings (menu
);
2378 current_popup_menu
= NULL
;
2381 #endif /* HAVE_MENUS */
2383 void syms_of_w32menu ()
2385 globals_of_w32menu ();
2386 staticpro (&menu_items
);
2389 current_popup_menu
= NULL
;
2391 Qdebug_on_next_call
= intern ("debug-on-next-call");
2392 staticpro (&Qdebug_on_next_call
);
2394 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame
,
2395 doc
: /* Frame for which we are updating a menu.
2396 The enable predicate for a menu command should check this variable. */);
2397 Vmenu_updating_frame
= Qnil
;
2399 defsubr (&Sx_popup_menu
);
2401 defsubr (&Sx_popup_dialog
);
2406 globals_of_w32menu is used to initialize those global variables that
2407 must always be initialized on startup even when the global variable
2408 initialized is non zero (see the function main in emacs.c).
2409 globals_of_w32menu is called from syms_of_w32menu when the global
2410 variable initialized is 0 and directly from main when initialized
2413 void globals_of_w32menu ()
2415 /* See if Get/SetMenuItemInfo functions are available. */
2416 HMODULE user32
= GetModuleHandle ("user32.dll");
2417 get_menu_item_info
= (GetMenuItemInfoA_Proc
) GetProcAddress (user32
, "GetMenuItemInfoA");
2418 set_menu_item_info
= (SetMenuItemInfoA_Proc
) GetProcAddress (user32
, "SetMenuItemInfoA");