1 /* Menu support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1986, 1988, 1993-1994, 1996, 1998-1999, 2001-2015 Free
3 Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
32 #include "blockinput.h"
33 #include "character.h"
39 /* This may include sys/types.h, and that somehow loses
40 if this is not done before the other system files. */
43 /* Cygwin does not support the multibyte string functions declared in
44 * mbstring.h below --- but that's okay: because Cygwin is
45 * UNICODE-only, we don't need to use these functions anyway. */
49 #endif /* !NTGUI_UNICODE */
51 /* Load sys/types.h if not already loaded.
52 In some systems loading it twice is suicidal. */
54 #include <sys/types.h>
57 #include "dispextern.h"
59 #include "w32common.h" /* for osinfo_cache */
61 #undef HAVE_DIALOGS /* TODO: Implement native dialogs. */
68 HMENU current_popup_menu
;
70 void syms_of_w32menu (void);
71 void globals_of_w32menu (void);
73 typedef BOOL (WINAPI
* GetMenuItemInfoA_Proc
) (
77 IN OUT LPMENUITEMINFOA
);
78 typedef BOOL (WINAPI
* SetMenuItemInfoA_Proc
) (
83 typedef int (WINAPI
* MessageBoxW_Proc
) (
86 IN
const WCHAR
*caption
,
90 #define get_menu_item_info GetMenuItemInfoA
91 #define set_menu_item_info SetMenuItemInfoA
92 #define unicode_append_menu AppendMenuW
93 #define unicode_message_box MessageBoxW
94 #else /* !NTGUI_UNICODE */
95 GetMenuItemInfoA_Proc get_menu_item_info
= NULL
;
96 SetMenuItemInfoA_Proc set_menu_item_info
= NULL
;
97 AppendMenuW_Proc unicode_append_menu
= NULL
;
98 MessageBoxW_Proc unicode_message_box
= NULL
;
99 #endif /* NTGUI_UNICODE */
101 void set_frame_menubar (struct frame
*, bool, bool);
104 static Lisp_Object
w32_dialog_show (struct frame
*, Lisp_Object
, Lisp_Object
, char **);
106 static int is_simple_dialog (Lisp_Object
);
107 static Lisp_Object
simple_dialog_show (struct frame
*, Lisp_Object
, Lisp_Object
);
110 static void utf8to16 (unsigned char *, int, WCHAR
*);
111 static int fill_in_menu (HMENU
, widget_value
*);
113 void w32_free_menu_strings (HWND
);
116 w32_popup_dialog (struct frame
*f
, Lisp_Object header
, Lisp_Object contents
)
119 check_window_system (f
);
123 /* Handle simple Yes/No choices as MessageBox popups. */
124 if (is_simple_dialog (contents
))
125 return simple_dialog_show (f
, contents
, header
);
127 return Qunsupported__w32_dialog
;
128 #else /* HAVE_DIALOGS */
132 Lisp_Object selection
;
134 /* Decode the dialog items from what was specified. */
135 title
= Fcar (contents
);
136 CHECK_STRING (title
);
138 list_of_panes (Fcons (contents
, Qnil
));
140 /* Display them in a dialog box. */
142 selection
= w32_dialog_show (f
, title
, header
, &error_name
);
145 discard_menu_items ();
146 FRAME_DISPLAY_INFO (f
)->grabbed
= 0;
148 if (error_name
) error (error_name
);
151 #endif /* HAVE_DIALOGS */
154 /* Activate the menu bar of frame F.
155 This is called from keyboard.c when it gets the
156 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
158 To activate the menu bar, we signal to the input thread that it can
159 return from the WM_INITMENU message, allowing the normal Windows
160 processing of the menus.
162 But first we recompute the menu bar contents (the whole tree).
164 This way we can safely execute Lisp code. */
167 x_activate_menubar (struct frame
*f
)
169 set_frame_menubar (f
, 0, 1);
171 /* Lock out further menubar changes while active. */
172 f
->output_data
.w32
->menubar_active
= 1;
174 /* Signal input thread to return from WM_INITMENU. */
175 complete_deferred_msg (FRAME_W32_WINDOW (f
), WM_INITMENU
, 0);
178 /* This callback is called from the menu bar pulldown menu
179 when the user makes a selection.
180 Figure out what the user chose
181 and put the appropriate events into the keyboard buffer. */
184 menubar_selection_callback (struct frame
*f
, void * client_data
)
186 Lisp_Object prefix
, entry
;
188 Lisp_Object
*subprefix_stack
;
189 int submenu_depth
= 0;
195 subprefix_stack
= (Lisp_Object
*) alloca (f
->menu_bar_items_used
* word_size
);
196 vector
= f
->menu_bar_vector
;
199 while (i
< f
->menu_bar_items_used
)
201 if (EQ (AREF (vector
, i
), Qnil
))
203 subprefix_stack
[submenu_depth
++] = prefix
;
207 else if (EQ (AREF (vector
, i
), Qlambda
))
209 prefix
= subprefix_stack
[--submenu_depth
];
212 else if (EQ (AREF (vector
, i
), Qt
))
214 prefix
= AREF (vector
, i
+ MENU_ITEMS_PANE_PREFIX
);
215 i
+= MENU_ITEMS_PANE_LENGTH
;
219 entry
= AREF (vector
, i
+ MENU_ITEMS_ITEM_VALUE
);
220 /* The UINT_PTR cast avoids a warning. There's no problem
221 as long as pointers have enough bits to hold small integers. */
222 if ((int) (UINT_PTR
) client_data
== i
)
225 struct input_event buf
;
229 XSETFRAME (frame
, f
);
230 buf
.kind
= MENU_BAR_EVENT
;
231 buf
.frame_or_window
= frame
;
233 kbd_buffer_store_event (&buf
);
235 for (j
= 0; j
< submenu_depth
; j
++)
236 if (!NILP (subprefix_stack
[j
]))
238 buf
.kind
= MENU_BAR_EVENT
;
239 buf
.frame_or_window
= frame
;
240 buf
.arg
= subprefix_stack
[j
];
241 kbd_buffer_store_event (&buf
);
246 buf
.kind
= MENU_BAR_EVENT
;
247 buf
.frame_or_window
= frame
;
249 kbd_buffer_store_event (&buf
);
252 buf
.kind
= MENU_BAR_EVENT
;
253 buf
.frame_or_window
= frame
;
255 /* Free memory used by owner-drawn and help-echo strings. */
256 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
257 kbd_buffer_store_event (&buf
);
259 f
->output_data
.w32
->menubar_active
= 0;
262 i
+= MENU_ITEMS_ITEM_LENGTH
;
265 /* Free memory used by owner-drawn and help-echo strings. */
266 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
267 f
->output_data
.w32
->menubar_active
= 0;
271 /* Set the contents of the menubar widgets of frame F.
272 The argument FIRST_TIME is currently ignored;
273 it is set the first time this is called, from initialize_frame_menubar. */
276 set_frame_menubar (struct frame
*f
, bool first_time
, bool deep_p
)
278 HMENU menubar_widget
= f
->output_data
.w32
->menubar_widget
;
280 widget_value
*wv
, *first_wv
, *prev_wv
= 0;
282 int *submenu_start
, *submenu_end
;
283 int *submenu_top_level_items
, *submenu_n_panes
;
285 /* We must not change the menubar when actually in use. */
286 if (f
->output_data
.w32
->menubar_active
)
289 XSETFRAME (Vmenu_updating_frame
, f
);
291 if (! menubar_widget
)
296 /* Make a widget-value tree representing the entire menu trees. */
298 struct buffer
*prev
= current_buffer
;
300 ptrdiff_t specpdl_count
= SPECPDL_INDEX ();
301 int previous_menu_items_used
= f
->menu_bar_items_used
;
302 Lisp_Object
*previous_items
303 = (Lisp_Object
*) alloca (previous_menu_items_used
306 /* If we are making a new widget, its contents are empty,
307 do always reinitialize them. */
308 if (! menubar_widget
)
309 previous_menu_items_used
= 0;
311 buffer
= XWINDOW (FRAME_SELECTED_WINDOW (f
))->contents
;
312 specbind (Qinhibit_quit
, Qt
);
313 /* Don't let the debugger step into this code
314 because it is not reentrant. */
315 specbind (Qdebug_on_next_call
, Qnil
);
317 record_unwind_save_match_data ();
319 if (NILP (Voverriding_local_map_menu_flag
))
321 specbind (Qoverriding_terminal_local_map
, Qnil
);
322 specbind (Qoverriding_local_map
, Qnil
);
325 set_buffer_internal_1 (XBUFFER (buffer
));
328 safe_run_hooks (Qactivate_menubar_hook
);
329 safe_run_hooks (Qmenu_bar_update_hook
);
330 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
332 items
= FRAME_MENU_BAR_ITEMS (f
);
334 /* Save the frame's previous menu bar contents data. */
335 if (previous_menu_items_used
)
336 memcpy (previous_items
, XVECTOR (f
->menu_bar_vector
)->contents
,
337 previous_menu_items_used
* word_size
);
339 /* Fill in menu_items with the current menu bar contents.
340 This can evaluate Lisp code. */
343 menu_items
= f
->menu_bar_vector
;
344 menu_items_allocated
= VECTORP (menu_items
) ? ASIZE (menu_items
) : 0;
345 submenu_start
= (int *) alloca (ASIZE (items
) * sizeof (int));
346 submenu_end
= (int *) alloca (ASIZE (items
) * sizeof (int));
347 submenu_n_panes
= (int *) alloca (ASIZE (items
) * sizeof (int));
348 submenu_top_level_items
= (int *) alloca (ASIZE (items
) * sizeof (int));
350 for (i
= 0; i
< ASIZE (items
); i
+= 4)
352 Lisp_Object key
, string
, maps
;
356 key
= AREF (items
, i
);
357 string
= AREF (items
, i
+ 1);
358 maps
= AREF (items
, i
+ 2);
362 submenu_start
[i
] = menu_items_used
;
364 menu_items_n_panes
= 0;
365 submenu_top_level_items
[i
]
366 = parse_single_submenu (key
, string
, maps
);
367 submenu_n_panes
[i
] = menu_items_n_panes
;
369 submenu_end
[i
] = menu_items_used
;
372 finish_menu_items ();
374 /* Convert menu_items into widget_value trees
375 to display the menu. This cannot evaluate Lisp code. */
377 wv
= make_widget_value ("menubar", NULL
, true, Qnil
);
378 wv
->button_type
= BUTTON_TYPE_NONE
;
381 for (i
= 0; i
< last_i
; i
+= 4)
383 menu_items_n_panes
= submenu_n_panes
[i
];
384 wv
= digest_single_submenu (submenu_start
[i
], submenu_end
[i
],
385 submenu_top_level_items
[i
]);
389 first_wv
->contents
= wv
;
390 /* Don't set wv->name here; GC during the loop might relocate it. */
392 wv
->button_type
= BUTTON_TYPE_NONE
;
396 set_buffer_internal_1 (prev
);
398 /* If there has been no change in the Lisp-level contents
399 of the menu bar, skip redisplaying it. Just exit. */
401 for (i
= 0; i
< previous_menu_items_used
; i
++)
402 if (menu_items_used
== i
403 || (!EQ (previous_items
[i
], AREF (menu_items
, i
))))
405 if (i
== menu_items_used
&& i
== previous_menu_items_used
&& i
!= 0)
407 free_menubar_widget_value_tree (first_wv
);
408 discard_menu_items ();
409 unbind_to (specpdl_count
, Qnil
);
413 fset_menu_bar_vector (f
, menu_items
);
414 f
->menu_bar_items_used
= menu_items_used
;
416 /* This undoes save_menu_items. */
417 unbind_to (specpdl_count
, Qnil
);
419 /* Now GC cannot happen during the lifetime of the widget_value,
420 so it's safe to store data from a Lisp_String, as long as
421 local copies are made when the actual menu is created.
422 Windows takes care of this for normal string items, but
423 not for owner-drawn items or additional item-info. */
424 wv
= first_wv
->contents
;
425 for (i
= 0; i
< ASIZE (items
); i
+= 4)
428 string
= AREF (items
, i
+ 1);
431 wv
->name
= SSDATA (string
);
432 update_submenu_strings (wv
->contents
);
438 /* Make a widget-value tree containing
439 just the top level menu bar strings. */
441 wv
= make_widget_value ("menubar", NULL
, true, Qnil
);
442 wv
->button_type
= BUTTON_TYPE_NONE
;
445 items
= FRAME_MENU_BAR_ITEMS (f
);
446 for (i
= 0; i
< ASIZE (items
); i
+= 4)
450 string
= AREF (items
, i
+ 1);
454 wv
= make_widget_value (SSDATA (string
), NULL
, true, Qnil
);
455 wv
->button_type
= BUTTON_TYPE_NONE
;
456 /* This prevents lwlib from assuming this
457 menu item is really supposed to be empty. */
458 /* The EMACS_INT cast avoids a warning.
459 This value just has to be different from small integers. */
460 wv
->call_data
= (void *) (EMACS_INT
) (-1);
465 first_wv
->contents
= wv
;
469 /* Forget what we thought we knew about what is in the
470 detailed contents of the menu bar menus.
471 Changing the top level always destroys the contents. */
472 f
->menu_bar_items_used
= 0;
475 /* Create or update the menu bar widget. */
481 /* Empty current menubar, rather than creating a fresh one. */
482 while (DeleteMenu (menubar_widget
, 0, MF_BYPOSITION
))
487 menubar_widget
= CreateMenu ();
489 fill_in_menu (menubar_widget
, first_wv
->contents
);
491 free_menubar_widget_value_tree (first_wv
);
494 HMENU old_widget
= f
->output_data
.w32
->menubar_widget
;
496 f
->output_data
.w32
->menubar_widget
= menubar_widget
;
497 SetMenu (FRAME_W32_WINDOW (f
), f
->output_data
.w32
->menubar_widget
);
498 /* Causes flicker when menu bar is updated
499 DrawMenuBar (FRAME_W32_WINDOW (f)); */
501 /* Force the window size to be recomputed so that the frame's text
502 area remains the same, if menubar has just been created. */
503 if (old_widget
== NULL
)
504 adjust_frame_size (f
, -1, -1, 2, 0, Qmenu_bar_lines
);
510 /* Called from Fx_create_frame to create the initial menubar of a frame
511 before it is mapped, so that the window is mapped with the menubar already
512 there instead of us tacking it on later and thrashing the window after it
516 initialize_frame_menubar (struct frame
*f
)
518 /* This function is called before the first chance to redisplay
519 the frame. It has to be, so the frame will have the right size. */
520 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
521 set_frame_menubar (f
, 1, 1);
524 /* Get rid of the menu bar of frame F, and free its storage.
525 This is used when deleting a frame, and when turning off the menu bar. */
528 free_frame_menubar (struct frame
*f
)
533 HMENU old
= GetMenu (FRAME_W32_WINDOW (f
));
534 SetMenu (FRAME_W32_WINDOW (f
), NULL
);
535 f
->output_data
.w32
->menubar_widget
= NULL
;
543 /* w32_menu_show actually displays a menu using the panes and items in
544 menu_items and returns the value selected from it; we assume input
545 is blocked by the caller. */
547 /* F is the frame the menu is for.
548 X and Y are the frame-relative specified position,
549 relative to the inside upper left corner of the frame F.
550 Bitfield MENUFLAGS bits are:
551 MENU_FOR_CLICK is set if this menu was invoked for a mouse click.
552 MENU_KEYMAPS is set if this menu was specified with keymaps;
553 in that case, we return a list containing the chosen item's value
554 and perhaps also the pane's prefix.
555 TITLE is the specified menu title.
556 ERROR is a place to store an error message string in case of failure.
557 (We return nil on failure, but the value doesn't actually matter.) */
560 w32_menu_show (struct frame
*f
, int x
, int y
, int menuflags
,
561 Lisp_Object title
, const char **error
)
564 int menu_item_selection
;
567 widget_value
*wv
, *save_wv
= 0, *first_wv
= 0, *prev_wv
= 0;
568 widget_value
**submenu_stack
569 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
570 Lisp_Object
*subprefix_stack
571 = (Lisp_Object
*) alloca (menu_items_used
* word_size
);
572 int submenu_depth
= 0;
577 if (menu_items_n_panes
== 0)
580 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
582 *error
= "Empty menu";
588 /* Create a tree of widget_value objects
589 representing the panes and their items. */
590 wv
= make_widget_value ("menu", NULL
, true, Qnil
);
591 wv
->button_type
= BUTTON_TYPE_NONE
;
595 /* Loop over all panes and items, filling in the tree. */
597 while (i
< menu_items_used
)
599 if (EQ (AREF (menu_items
, i
), Qnil
))
601 submenu_stack
[submenu_depth
++] = save_wv
;
607 else if (EQ (AREF (menu_items
, i
), Qlambda
))
610 save_wv
= submenu_stack
[--submenu_depth
];
614 else if (EQ (AREF (menu_items
, i
), Qt
)
615 && submenu_depth
!= 0)
616 i
+= MENU_ITEMS_PANE_LENGTH
;
617 /* Ignore a nil in the item list.
618 It's meaningful only for dialog boxes. */
619 else if (EQ (AREF (menu_items
, i
), Qquote
))
621 else if (EQ (AREF (menu_items
, i
), Qt
))
623 /* Create a new pane. */
624 Lisp_Object pane_name
, prefix
;
625 const char *pane_string
;
626 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
627 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
629 if (STRINGP (pane_name
))
631 if (unicode_append_menu
)
632 pane_name
= ENCODE_UTF_8 (pane_name
);
633 else if (STRING_MULTIBYTE (pane_name
))
634 pane_name
= ENCODE_SYSTEM (pane_name
);
636 ASET (menu_items
, i
+ MENU_ITEMS_PANE_NAME
, pane_name
);
639 pane_string
= (NILP (pane_name
)
640 ? "" : SSDATA (pane_name
));
641 /* If there is just one top-level pane, put all its items directly
642 under the top-level menu. */
643 if (menu_items_n_panes
== 1)
646 /* If the pane has a meaningful name,
647 make the pane a top-level menu item
648 with its items as a submenu beneath it. */
649 if (!(menuflags
& MENU_KEYMAPS
) && strcmp (pane_string
, ""))
651 wv
= make_widget_value (pane_string
, NULL
, true, Qnil
);
655 first_wv
->contents
= wv
;
656 if ((menuflags
& MENU_KEYMAPS
) && !NILP (prefix
))
658 wv
->button_type
= BUTTON_TYPE_NONE
;
668 i
+= MENU_ITEMS_PANE_LENGTH
;
672 /* Create a new item within current pane. */
673 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
, help
;
675 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
676 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
677 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
678 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
679 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
680 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
681 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
683 if (STRINGP (item_name
))
685 if (unicode_append_menu
)
686 item_name
= ENCODE_UTF_8 (item_name
);
687 else if (STRING_MULTIBYTE (item_name
))
688 item_name
= ENCODE_SYSTEM (item_name
);
690 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
, item_name
);
693 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
695 descrip
= ENCODE_SYSTEM (descrip
);
696 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
, descrip
);
699 wv
= make_widget_value (SSDATA (item_name
), NULL
, !NILP (enable
),
700 STRINGP (help
) ? help
: Qnil
);
704 save_wv
->contents
= wv
;
706 wv
->key
= SSDATA (descrip
);
707 /* Use the contents index as call_data, since we are
708 restricted to 16-bits. */
709 wv
->call_data
= !NILP (def
) ? (void *) (UINT_PTR
) i
: 0;
712 wv
->button_type
= BUTTON_TYPE_NONE
;
713 else if (EQ (type
, QCtoggle
))
714 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
715 else if (EQ (type
, QCradio
))
716 wv
->button_type
= BUTTON_TYPE_RADIO
;
720 wv
->selected
= !NILP (selected
);
724 i
+= MENU_ITEMS_ITEM_LENGTH
;
728 /* Deal with the title, if it is non-nil. */
731 widget_value
*wv_title
;
732 widget_value
*wv_sep
= make_widget_value ("--", NULL
, false, Qnil
);
734 /* Maybe replace this separator with a bitmap or owner-draw item
735 so that it looks better. Having two separators looks odd. */
736 wv_sep
->next
= first_wv
->contents
;
738 if (unicode_append_menu
)
739 title
= ENCODE_UTF_8 (title
);
740 else if (STRING_MULTIBYTE (title
))
741 title
= ENCODE_SYSTEM (title
);
743 wv_title
= make_widget_value (SSDATA (title
), NULL
, true, Qnil
);
744 wv_title
->title
= TRUE
;
745 wv_title
->button_type
= BUTTON_TYPE_NONE
;
746 wv_title
->next
= wv_sep
;
747 first_wv
->contents
= wv_title
;
750 /* No selection has been chosen yet. */
751 menu_item_selection
= 0;
753 /* Actually create the menu. */
754 current_popup_menu
= menu
= CreatePopupMenu ();
755 fill_in_menu (menu
, first_wv
->contents
);
757 /* Adjust coordinates to be root-window-relative. */
760 ClientToScreen (FRAME_W32_WINDOW (f
), &pos
);
762 /* Display the menu. */
763 menu_item_selection
= SendMessage (FRAME_W32_WINDOW (f
),
764 WM_EMACS_TRACKPOPUPMENU
,
765 (WPARAM
)menu
, (LPARAM
)&pos
);
767 /* Clean up extraneous mouse events which might have been generated
769 discard_mouse_events ();
770 FRAME_DISPLAY_INFO (f
)->grabbed
= 0;
772 /* Free the widget_value objects we used to specify the contents. */
773 free_menubar_widget_value_tree (first_wv
);
777 /* Free the owner-drawn and help-echo menu strings. */
778 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
779 f
->output_data
.w32
->menubar_active
= 0;
781 /* Find the selected item, and its pane, to return
783 if (menu_item_selection
!= 0)
785 Lisp_Object prefix
, entry
;
787 prefix
= entry
= Qnil
;
789 while (i
< menu_items_used
)
791 if (EQ (AREF (menu_items
, i
), Qnil
))
793 subprefix_stack
[submenu_depth
++] = prefix
;
797 else if (EQ (AREF (menu_items
, i
), Qlambda
))
799 prefix
= subprefix_stack
[--submenu_depth
];
802 else if (EQ (AREF (menu_items
, i
), Qt
))
804 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
805 i
+= MENU_ITEMS_PANE_LENGTH
;
807 /* Ignore a nil in the item list.
808 It's meaningful only for dialog boxes. */
809 else if (EQ (AREF (menu_items
, i
), Qquote
))
813 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
814 if (menu_item_selection
== i
)
816 if (menuflags
& MENU_KEYMAPS
)
820 entry
= Fcons (entry
, Qnil
);
822 entry
= Fcons (prefix
, entry
);
823 for (j
= submenu_depth
- 1; j
>= 0; j
--)
824 if (!NILP (subprefix_stack
[j
]))
825 entry
= Fcons (subprefix_stack
[j
], entry
);
830 i
+= MENU_ITEMS_ITEM_LENGTH
;
834 else if (!(menuflags
& MENU_FOR_CLICK
))
837 /* Make "Cancel" equivalent to C-g. */
838 Fsignal (Qquit
, Qnil
);
847 /* TODO: On Windows, there are two ways of defining a dialog.
849 1. Create a predefined dialog resource and include it in nt/emacs.rc.
850 Using this method, we could then set the titles and make unneeded
851 buttons invisible before displaying the dialog. Everything would
852 be a fixed size though, so there is a risk that text does not
854 2. Create the dialog template in memory on the fly. This allows us
855 to size the dialog and buttons dynamically, probably giving more
856 natural looking results for dialogs with few buttons, and eliminating
857 the problem of text overflowing the buttons. But the API for this is
858 quite complex - structures have to be allocated in particular ways,
859 text content is tacked onto the end of structures in variable length
860 arrays with further structures tacked on after these, there are
861 certain alignment requirements for all this, and we have to
862 measure all the text and convert to "dialog coordinates" to figure
863 out how big to make everything.
865 For now, we'll just stick with menus for dialogs that are more
866 complicated than simple yes/no type questions for which we can use
867 the MessageBox function.
870 static char * button_names
[] = {
871 "button1", "button2", "button3", "button4", "button5",
872 "button6", "button7", "button8", "button9", "button10" };
875 w32_dialog_show (struct frame
*f
, Lisp_Object title
,
876 Lisp_Object header
, char **error
)
878 int i
, nb_buttons
= 0;
880 int menu_item_selection
;
882 widget_value
*wv
, *first_wv
= 0, *prev_wv
= 0;
884 /* Number of elements seen so far, before boundary. */
886 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
887 int boundary_seen
= 0;
891 if (menu_items_n_panes
> 1)
893 *error
= "Multiple panes in dialog box";
897 /* Create a tree of widget_value objects
898 representing the text label and buttons. */
900 Lisp_Object pane_name
;
902 pane_name
= AREF (menu_items
, MENU_ITEMS_PANE_NAME
);
903 pane_string
= (NILP (pane_name
)
904 ? "" : SSDATA (pane_name
));
905 prev_wv
= make_widget_value ("message", pane_string
, true, Qnil
);
908 /* Loop over all panes and items, filling in the tree. */
909 i
= MENU_ITEMS_PANE_LENGTH
;
910 while (i
< menu_items_used
)
913 /* Create a new item within current pane. */
914 Lisp_Object item_name
, enable
, descrip
, help
;
916 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
917 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
918 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
919 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
921 if (NILP (item_name
))
923 free_menubar_widget_value_tree (first_wv
);
924 *error
= "Submenu in dialog items";
927 if (EQ (item_name
, Qquote
))
929 /* This is the boundary between left-side elts
930 and right-side elts. Stop incrementing right_count. */
937 free_menubar_widget_value_tree (first_wv
);
938 *error
= "Too many dialog items";
942 wv
= make_widget_value (button_names
[nb_buttons
],
944 !NILP (enable
), Qnil
);
947 wv
->key
= SSDATA (descrip
);
948 wv
->call_data
= aref_addr (menu_items
, i
);
955 i
+= MENU_ITEMS_ITEM_LENGTH
;
958 /* If the boundary was not specified,
959 by default put half on the left and half on the right. */
961 left_count
= nb_buttons
- nb_buttons
/ 2;
963 wv
= make_widget_value (dialog_name
, NULL
, false, Qnil
);
965 /* Frame title: 'Q' = Question, 'I' = Information.
966 Can also have 'E' = Error if, one day, we want
967 a popup for errors. */
969 dialog_name
[0] = 'Q';
971 dialog_name
[0] = 'I';
973 /* Dialog boxes use a really stupid name encoding
974 which specifies how many buttons to use
975 and how many buttons are on the right. */
976 dialog_name
[1] = '0' + nb_buttons
;
977 dialog_name
[2] = 'B';
978 dialog_name
[3] = 'R';
979 /* Number of buttons to put on the right. */
980 dialog_name
[4] = '0' + nb_buttons
- left_count
;
982 wv
->contents
= first_wv
;
986 /* Actually create the dialog. */
987 dialog_id
= widget_id_tick
++;
988 menu
= lw_create_widget (first_wv
->name
, "dialog", dialog_id
, first_wv
,
989 f
->output_data
.w32
->widget
, 1, 0,
990 dialog_selection_callback
, 0);
991 lw_modify_all_widgets (dialog_id
, first_wv
->contents
, TRUE
);
993 /* Free the widget_value objects we used to specify the contents. */
994 free_menubar_widget_value_tree (first_wv
);
996 /* No selection has been chosen yet. */
997 menu_item_selection
= 0;
999 /* Display the menu. */
1000 lw_pop_up_all_widgets (dialog_id
);
1002 /* Process events that apply to the menu. */
1003 popup_get_selection ((XEvent
*) 0, FRAME_DISPLAY_INFO (f
), dialog_id
);
1005 lw_destroy_all_widgets (dialog_id
);
1007 /* Find the selected item, and its pane, to return
1008 the proper value. */
1009 if (menu_item_selection
!= 0)
1012 while (i
< menu_items_used
)
1016 if (EQ (AREF (menu_items
, i
), Qt
))
1017 i
+= MENU_ITEMS_PANE_LENGTH
;
1020 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
1021 if (menu_item_selection
== i
)
1023 i
+= MENU_ITEMS_ITEM_LENGTH
;
1028 /* Make "Cancel" equivalent to C-g. */
1029 Fsignal (Qquit
, Qnil
);
1033 #else /* !HAVE_DIALOGS */
1035 /* Currently we only handle Yes No dialogs (y-or-n-p and yes-or-no-p) as
1036 simple dialogs. We could handle a few more, but I'm not aware of
1037 anywhere in Emacs that uses the other specific dialog choices that
1038 MessageBox provides. */
1041 is_simple_dialog (Lisp_Object contents
)
1043 Lisp_Object options
;
1044 Lisp_Object name
, yes
, no
, other
;
1046 if (!CONSP (contents
))
1048 options
= XCDR (contents
);
1050 yes
= build_string ("Yes");
1051 no
= build_string ("No");
1053 if (!CONSP (options
))
1056 name
= XCAR (options
);
1061 if (!NILP (Fstring_equal (name
, yes
)))
1063 else if (!NILP (Fstring_equal (name
, no
)))
1068 options
= XCDR (options
);
1069 if (!CONSP (options
))
1072 name
= XCAR (options
);
1076 if (NILP (Fstring_equal (name
, other
)))
1079 /* Check there are no more options. */
1080 options
= XCDR (options
);
1081 return !(CONSP (options
));
1085 simple_dialog_show (struct frame
*f
, Lisp_Object contents
, Lisp_Object header
)
1089 Lisp_Object lispy_answer
= Qnil
, temp
= XCAR (contents
);
1093 /* Since we only handle Yes/No dialogs, and we already checked
1094 is_simple_dialog, we don't need to worry about checking contents
1095 to see what type of dialog to use. */
1097 /* Use Unicode if possible, so any language can be displayed. */
1098 if (unicode_message_box
)
1106 char *utf8_text
= SDATA (ENCODE_UTF_8 (temp
));
1107 /* Be pessimistic about the number of characters needed.
1108 Remember characters outside the BMP will take more than
1109 one utf16 word, so we cannot simply use the character
1111 int utf8_len
= strlen (utf8_text
);
1112 text
= SAFE_ALLOCA ((utf8_len
+ 1) * sizeof (WCHAR
));
1113 utf8to16 (utf8_text
, utf8_len
, text
);
1122 title
= L
"Question";
1123 type
|= MB_ICONQUESTION
;
1127 title
= L
"Information";
1128 type
|= MB_ICONINFORMATION
;
1131 answer
= unicode_message_box (FRAME_W32_WINDOW (f
), text
, title
, type
);
1136 const char *text
, *title
;
1138 /* Fall back on ANSI message box, but at least use system
1139 encoding so questions representable by the system codepage
1140 are encoded properly. */
1142 text
= SDATA (ENCODE_SYSTEM (temp
));
1149 type
|= MB_ICONQUESTION
;
1153 title
= "Information";
1154 type
|= MB_ICONINFORMATION
;
1157 answer
= MessageBox (FRAME_W32_WINDOW (f
), text
, title
, type
);
1160 if (answer
== IDYES
)
1161 lispy_answer
= build_string ("Yes");
1162 else if (answer
== IDNO
)
1163 lispy_answer
= build_string ("No");
1165 Fsignal (Qquit
, Qnil
);
1167 for (temp
= XCDR (contents
); CONSP (temp
); temp
= XCDR (temp
))
1169 Lisp_Object item
, name
, value
;
1174 value
= XCDR (item
);
1182 if (!NILP (Fstring_equal (name
, lispy_answer
)))
1187 Fsignal (Qquit
, Qnil
);
1190 #endif /* !HAVE_DIALOGS */
1193 /* UTF8: 0xxxxxxx, 110xxxxx 10xxxxxx, 1110xxxx, 10xxxxxx, 10xxxxxx */
1195 utf8to16 (unsigned char * src
, int len
, WCHAR
* dest
)
1201 *dest
= (WCHAR
) *src
;
1202 dest
++; src
++; len
--;
1204 /* Since we might get >3 byte sequences which we don't handle, ignore the extra parts. */
1205 else if (*src
< 0xC0)
1209 /* 2 char UTF-8 sequence. */
1210 else if (*src
< 0xE0)
1212 *dest
= (WCHAR
) (((*src
& 0x1f) << 6)
1213 | (*(src
+ 1) & 0x3f));
1214 src
+= 2; len
-= 2; dest
++;
1216 else if (*src
< 0xF0)
1218 *dest
= (WCHAR
) (((*src
& 0x0f) << 12)
1219 | ((*(src
+ 1) & 0x3f) << 6)
1220 | (*(src
+ 2) & 0x3f));
1221 src
+= 3; len
-= 3; dest
++;
1223 else /* Not encodable. Insert Unicode Substitution char. */
1225 *dest
= (WCHAR
) 0xfffd;
1226 src
++; len
--; dest
++;
1233 add_menu_item (HMENU menu
, widget_value
*wv
, HMENU item
)
1236 char *out_string
, *p
, *q
;
1238 size_t nlen
, orig_len
;
1241 if (menu_separator_name_p (wv
->name
))
1243 fuFlags
= MF_SEPARATOR
;
1249 fuFlags
= MF_STRING
;
1251 fuFlags
= MF_STRING
| MF_GRAYED
;
1253 if (wv
->key
!= NULL
)
1255 out_string
= SAFE_ALLOCA (strlen (wv
->name
) + strlen (wv
->key
) + 2);
1256 p
= stpcpy (out_string
, wv
->name
);
1257 p
= stpcpy (p
, "\t");
1258 strcpy (p
, wv
->key
);
1261 out_string
= (char *)wv
->name
;
1263 /* Quote any special characters within the menu item's text and
1265 nlen
= orig_len
= strlen (out_string
);
1266 if (unicode_append_menu
)
1268 /* With UTF-8, & cannot be part of a multibyte character. */
1269 for (p
= out_string
; *p
; p
++)
1275 #ifndef NTGUI_UNICODE
1278 /* If encoded with the system codepage, use multibyte string
1279 functions in case of multibyte characters that contain '&'. */
1280 for (p
= out_string
; *p
; p
= _mbsinc (p
))
1282 if (_mbsnextc (p
) == '&')
1286 #endif /* !NTGUI_UNICODE */
1288 if (nlen
> orig_len
)
1291 out_string
= SAFE_ALLOCA (nlen
+ 1);
1295 if (unicode_append_menu
)
1301 #ifndef NTGUI_UNICODE
1304 if (_mbsnextc (p
) == '&')
1313 #endif /* !NTGUI_UNICODE */
1320 else if (wv
->title
|| wv
->call_data
== 0)
1322 /* Only use MF_OWNERDRAW if GetMenuItemInfo is usable, since
1323 we can't deallocate the memory otherwise. */
1324 if (get_menu_item_info
)
1326 out_string
= (char *) local_alloc (strlen (wv
->name
) + 1);
1327 strcpy (out_string
, wv
->name
);
1329 DebPrint ("Menu: allocating %ld for owner-draw", out_string
);
1331 fuFlags
= MF_OWNERDRAW
| MF_DISABLED
;
1334 fuFlags
= MF_DISABLED
;
1337 /* Draw radio buttons and tickboxes. */
1338 else if (wv
->selected
&& (wv
->button_type
== BUTTON_TYPE_TOGGLE
||
1339 wv
->button_type
== BUTTON_TYPE_RADIO
))
1340 fuFlags
|= MF_CHECKED
;
1342 fuFlags
|= MF_UNCHECKED
;
1345 if (unicode_append_menu
&& out_string
)
1347 /* Convert out_string from UTF-8 to UTF-16-LE. */
1348 int utf8_len
= strlen (out_string
);
1349 WCHAR
* utf16_string
;
1350 if (fuFlags
& MF_OWNERDRAW
)
1351 utf16_string
= local_alloc ((utf8_len
+ 1) * sizeof (WCHAR
));
1353 utf16_string
= SAFE_ALLOCA ((utf8_len
+ 1) * sizeof (WCHAR
));
1355 utf8to16 (out_string
, utf8_len
, utf16_string
);
1356 return_value
= unicode_append_menu (menu
, fuFlags
,
1357 item
!= NULL
? (UINT_PTR
) item
1358 : (UINT_PTR
) wv
->call_data
,
1361 #ifndef NTGUI_UNICODE /* Fallback does not apply when always UNICODE */
1364 /* On W9x/ME, Unicode menus are not supported, though AppendMenuW
1365 apparently does exist at least in some cases and appears to be
1366 stubbed out to do nothing. out_string is UTF-8, but since
1367 our standard menus are in English and this is only going to
1368 happen the first time a menu is used, the encoding is
1369 of minor importance compared with menus not working at all. */
1371 AppendMenu (menu
, fuFlags
,
1372 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1374 /* Don't use Unicode menus in future, unless this is Windows
1375 NT or later, where a failure of AppendMenuW does NOT mean
1376 Unicode menus are unsupported. */
1377 if (osinfo_cache
.dwPlatformId
!= VER_PLATFORM_WIN32_NT
)
1378 unicode_append_menu
= NULL
;
1380 #endif /* NTGUI_UNICODE */
1382 if (unicode_append_menu
&& (fuFlags
& MF_OWNERDRAW
))
1383 local_free (out_string
);
1390 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1394 /* This must be done after the menu item is created. */
1395 if (!wv
->title
&& wv
->call_data
!= 0)
1397 if (set_menu_item_info
)
1400 memset (&info
, 0, sizeof (info
));
1401 info
.cbSize
= sizeof (info
);
1402 info
.fMask
= MIIM_DATA
;
1404 /* Set help string for menu item. Leave it as a pointer to
1405 a Lisp_String until it is ready to be displayed, since GC
1406 can happen while menus are active. */
1407 if (!NILP (wv
->help
))
1409 /* We use XUNTAG below because in a 32-bit build
1410 --with-wide-int we cannot pass a Lisp_Object
1411 via a DWORD member of MENUITEMINFO. */
1412 /* As of Jul-2012, w32api headers say that dwItemData
1413 has DWORD type, but that's a bug: it should actually
1414 be ULONG_PTR, which is correct for 32-bit and 64-bit
1415 Windows alike. MSVC headers get it right; hopefully,
1416 MinGW headers will, too. */
1417 eassert (STRINGP (wv
->help
));
1418 info
.dwItemData
= (ULONG_PTR
) XUNTAG (wv
->help
, Lisp_String
);
1420 if (wv
->button_type
== BUTTON_TYPE_RADIO
)
1422 /* CheckMenuRadioItem allows us to differentiate TOGGLE and
1423 RADIO items, but is not available on NT 3.51 and earlier. */
1424 info
.fMask
|= MIIM_TYPE
| MIIM_STATE
;
1425 info
.fType
= MFT_RADIOCHECK
| MFT_STRING
;
1426 info
.dwTypeData
= out_string
;
1427 info
.fState
= wv
->selected
? MFS_CHECKED
: MFS_UNCHECKED
;
1430 set_menu_item_info (menu
,
1431 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1436 return return_value
;
1439 /* Construct native Windows menu(bar) based on widget_value tree. */
1441 fill_in_menu (HMENU menu
, widget_value
*wv
)
1443 for ( ; wv
!= NULL
; wv
= wv
->next
)
1447 HMENU sub_menu
= CreatePopupMenu ();
1449 if (sub_menu
== NULL
)
1452 if (!fill_in_menu (sub_menu
, wv
->contents
) ||
1453 !add_menu_item (menu
, wv
, sub_menu
))
1455 DestroyMenu (sub_menu
);
1461 if (!add_menu_item (menu
, wv
, NULL
))
1468 /* Display help string for currently pointed to menu item. Not
1469 supported on NT 3.51 and earlier, as GetMenuItemInfo is not
1472 w32_menu_display_help (HWND owner
, HMENU menu
, UINT item
, UINT flags
)
1474 if (get_menu_item_info
)
1476 struct frame
*f
= x_window_to_frame (&one_w32_display_info
, owner
);
1477 Lisp_Object frame
, help
;
1479 /* No help echo on owner-draw menu items, or when the keyboard
1480 is used to navigate the menus, since tooltips are distracting
1481 if they pop up elsewhere. */
1482 if ((flags
& MF_OWNERDRAW
) || (flags
& MF_POPUP
)
1483 || !(flags
& MF_MOUSESELECT
)
1484 /* Ignore any dwItemData for menu items whose flags don't
1485 have the MF_HILITE bit set. These are dwItemData that
1486 Windows sends our way, but they aren't pointers to our
1487 Lisp_String objects, so trying to create Lisp_Strings out
1488 of them below and pass that to the keyboard queue will
1489 crash Emacs when we try to display those "strings". It
1490 is unclear why we get these dwItemData, or what they are:
1491 sometimes they point to a wchar_t string that is the menu
1492 title, sometimes to someting that doesn't look like text
1493 at all. (The problematic data also comes with the 0x0800
1494 bit set, but this bit is not documented, so we don't want
1495 to depend on it.) */
1496 || !(flags
& MF_HILITE
))
1502 memset (&info
, 0, sizeof (info
));
1503 info
.cbSize
= sizeof (info
);
1504 info
.fMask
= MIIM_DATA
;
1505 get_menu_item_info (menu
, item
, FALSE
, &info
);
1509 ? make_lisp_ptr ((void *) info
.dwItemData
, Lisp_String
)
1513 /* Store the help echo in the keyboard buffer as the X toolkit
1514 version does, rather than directly showing it. This seems to
1515 solve the GC problems that were present when we based the
1516 Windows code on the non-toolkit version. */
1519 XSETFRAME (frame
, f
);
1520 kbd_buffer_store_help_event (frame
, help
);
1523 /* X version has a loop through frames here, which doesn't
1524 appear to do anything, unless it has some side effect. */
1525 show_help_echo (help
, Qnil
, Qnil
, Qnil
);
1529 /* Free memory used by owner-drawn strings. */
1531 w32_free_submenu_strings (HMENU menu
)
1533 int i
, num
= GetMenuItemCount (menu
);
1534 for (i
= 0; i
< num
; i
++)
1537 memset (&info
, 0, sizeof (info
));
1538 info
.cbSize
= sizeof (info
);
1539 info
.fMask
= MIIM_DATA
| MIIM_TYPE
| MIIM_SUBMENU
;
1541 get_menu_item_info (menu
, i
, TRUE
, &info
);
1543 /* Owner-drawn names are held in dwItemData. */
1544 if ((info
.fType
& MF_OWNERDRAW
) && info
.dwItemData
)
1547 DebPrint ("Menu: freeing %ld for owner-draw", info
.dwItemData
);
1549 local_free (info
.dwItemData
);
1552 /* Recurse down submenus. */
1554 w32_free_submenu_strings (info
.hSubMenu
);
1559 w32_free_menu_strings (HWND hwnd
)
1561 HMENU menu
= current_popup_menu
;
1563 if (get_menu_item_info
)
1565 /* If there is no popup menu active, free the strings from the frame's
1568 menu
= GetMenu (hwnd
);
1571 w32_free_submenu_strings (menu
);
1574 current_popup_menu
= NULL
;
1577 /* The following is used by delayed window autoselection. */
1579 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p
, Smenu_or_popup_active_p
, 0, 0, 0,
1580 doc
: /* Return t if a menu or popup dialog is active on selected frame. */)
1584 f
= SELECTED_FRAME ();
1585 return (f
->output_data
.w32
->menubar_active
> 0) ? Qt
: Qnil
;
1589 syms_of_w32menu (void)
1591 globals_of_w32menu ();
1593 current_popup_menu
= NULL
;
1595 DEFSYM (Qdebug_on_next_call
, "debug-on-next-call");
1596 DEFSYM (Qunsupported__w32_dialog
, "unsupported--w32-dialog");
1598 defsubr (&Smenu_or_popup_active_p
);
1602 globals_of_w32menu is used to initialize those global variables that
1603 must always be initialized on startup even when the global variable
1604 initialized is non zero (see the function main in emacs.c).
1605 globals_of_w32menu is called from syms_of_w32menu when the global
1606 variable initialized is 0 and directly from main when initialized
1610 globals_of_w32menu (void)
1612 #ifndef NTGUI_UNICODE
1613 /* See if Get/SetMenuItemInfo functions are available. */
1614 HMODULE user32
= GetModuleHandle ("user32.dll");
1615 get_menu_item_info
= (GetMenuItemInfoA_Proc
) GetProcAddress (user32
, "GetMenuItemInfoA");
1616 set_menu_item_info
= (SetMenuItemInfoA_Proc
) GetProcAddress (user32
, "SetMenuItemInfoA");
1617 unicode_append_menu
= (AppendMenuW_Proc
) GetProcAddress (user32
, "AppendMenuW");
1618 unicode_message_box
= (MessageBoxW_Proc
) GetProcAddress (user32
, "MessageBoxW");
1619 #endif /* !NTGUI_UNICODE */