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 Lisp_Object Qdebug_on_next_call
, Qunsupported__w32_dialog
;
103 void set_frame_menubar (struct frame
*, bool, bool);
106 static Lisp_Object
w32_dialog_show (struct frame
*, int, Lisp_Object
, char**);
108 static int is_simple_dialog (Lisp_Object
);
109 static Lisp_Object
simple_dialog_show (struct frame
*, Lisp_Object
, Lisp_Object
);
112 static void utf8to16 (unsigned char *, int, WCHAR
*);
113 static int fill_in_menu (HMENU
, widget_value
*);
115 void w32_free_menu_strings (HWND
);
118 w32_popup_dialog (struct frame
*f
, Lisp_Object header
, Lisp_Object contents
)
121 check_window_system (f
);
125 /* Handle simple Yes/No choices as MessageBox popups. */
126 if (is_simple_dialog (contents
))
127 return simple_dialog_show (f
, contents
, header
);
129 return Qunsupported__w32_dialog
;
130 #else /* HAVE_DIALOGS */
134 Lisp_Object selection
;
136 /* Decode the dialog items from what was specified. */
137 title
= Fcar (contents
);
138 CHECK_STRING (title
);
140 list_of_panes (Fcons (contents
, Qnil
));
142 /* Display them in a dialog box. */
144 selection
= w32_dialog_show (f
, 0, title
, header
, &error_name
);
147 discard_menu_items ();
148 FRAME_DISPLAY_INFO (f
)->grabbed
= 0;
150 if (error_name
) error (error_name
);
153 #endif /* HAVE_DIALOGS */
156 /* Activate the menu bar of frame F.
157 This is called from keyboard.c when it gets the
158 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
160 To activate the menu bar, we signal to the input thread that it can
161 return from the WM_INITMENU message, allowing the normal Windows
162 processing of the menus.
164 But first we recompute the menu bar contents (the whole tree).
166 This way we can safely execute Lisp code. */
169 x_activate_menubar (struct frame
*f
)
171 set_frame_menubar (f
, 0, 1);
173 /* Lock out further menubar changes while active. */
174 f
->output_data
.w32
->menubar_active
= 1;
176 /* Signal input thread to return from WM_INITMENU. */
177 complete_deferred_msg (FRAME_W32_WINDOW (f
), WM_INITMENU
, 0);
180 /* This callback is called from the menu bar pulldown menu
181 when the user makes a selection.
182 Figure out what the user chose
183 and put the appropriate events into the keyboard buffer. */
186 menubar_selection_callback (struct frame
*f
, void * client_data
)
188 Lisp_Object prefix
, entry
;
190 Lisp_Object
*subprefix_stack
;
191 int submenu_depth
= 0;
197 subprefix_stack
= (Lisp_Object
*) alloca (f
->menu_bar_items_used
* word_size
);
198 vector
= f
->menu_bar_vector
;
201 while (i
< f
->menu_bar_items_used
)
203 if (EQ (AREF (vector
, i
), Qnil
))
205 subprefix_stack
[submenu_depth
++] = prefix
;
209 else if (EQ (AREF (vector
, i
), Qlambda
))
211 prefix
= subprefix_stack
[--submenu_depth
];
214 else if (EQ (AREF (vector
, i
), Qt
))
216 prefix
= AREF (vector
, i
+ MENU_ITEMS_PANE_PREFIX
);
217 i
+= MENU_ITEMS_PANE_LENGTH
;
221 entry
= AREF (vector
, i
+ MENU_ITEMS_ITEM_VALUE
);
222 /* The EMACS_INT cast avoids a warning. There's no problem
223 as long as pointers have enough bits to hold small integers. */
224 if ((int) (EMACS_INT
) client_data
== i
)
227 struct input_event buf
;
231 XSETFRAME (frame
, f
);
232 buf
.kind
= MENU_BAR_EVENT
;
233 buf
.frame_or_window
= frame
;
235 kbd_buffer_store_event (&buf
);
237 for (j
= 0; j
< submenu_depth
; j
++)
238 if (!NILP (subprefix_stack
[j
]))
240 buf
.kind
= MENU_BAR_EVENT
;
241 buf
.frame_or_window
= frame
;
242 buf
.arg
= subprefix_stack
[j
];
243 kbd_buffer_store_event (&buf
);
248 buf
.kind
= MENU_BAR_EVENT
;
249 buf
.frame_or_window
= frame
;
251 kbd_buffer_store_event (&buf
);
254 buf
.kind
= MENU_BAR_EVENT
;
255 buf
.frame_or_window
= frame
;
257 /* Free memory used by owner-drawn and help-echo strings. */
258 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
259 kbd_buffer_store_event (&buf
);
261 f
->output_data
.w32
->menubar_active
= 0;
264 i
+= MENU_ITEMS_ITEM_LENGTH
;
267 /* Free memory used by owner-drawn and help-echo strings. */
268 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
269 f
->output_data
.w32
->menubar_active
= 0;
273 /* Set the contents of the menubar widgets of frame F.
274 The argument FIRST_TIME is currently ignored;
275 it is set the first time this is called, from initialize_frame_menubar. */
278 set_frame_menubar (struct frame
*f
, bool first_time
, bool deep_p
)
280 HMENU menubar_widget
= f
->output_data
.w32
->menubar_widget
;
282 widget_value
*wv
, *first_wv
, *prev_wv
= 0;
284 int *submenu_start
, *submenu_end
;
285 int *submenu_top_level_items
, *submenu_n_panes
;
287 /* We must not change the menubar when actually in use. */
288 if (f
->output_data
.w32
->menubar_active
)
291 XSETFRAME (Vmenu_updating_frame
, f
);
293 if (! menubar_widget
)
298 /* Make a widget-value tree representing the entire menu trees. */
300 struct buffer
*prev
= current_buffer
;
302 ptrdiff_t specpdl_count
= SPECPDL_INDEX ();
303 int previous_menu_items_used
= f
->menu_bar_items_used
;
304 Lisp_Object
*previous_items
305 = (Lisp_Object
*) alloca (previous_menu_items_used
308 /* If we are making a new widget, its contents are empty,
309 do always reinitialize them. */
310 if (! menubar_widget
)
311 previous_menu_items_used
= 0;
313 buffer
= XWINDOW (FRAME_SELECTED_WINDOW (f
))->contents
;
314 specbind (Qinhibit_quit
, Qt
);
315 /* Don't let the debugger step into this code
316 because it is not reentrant. */
317 specbind (Qdebug_on_next_call
, Qnil
);
319 record_unwind_save_match_data ();
321 if (NILP (Voverriding_local_map_menu_flag
))
323 specbind (Qoverriding_terminal_local_map
, Qnil
);
324 specbind (Qoverriding_local_map
, Qnil
);
327 set_buffer_internal_1 (XBUFFER (buffer
));
330 safe_run_hooks (Qactivate_menubar_hook
);
331 safe_run_hooks (Qmenu_bar_update_hook
);
332 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
334 items
= FRAME_MENU_BAR_ITEMS (f
);
336 /* Save the frame's previous menu bar contents data. */
337 if (previous_menu_items_used
)
338 memcpy (previous_items
, XVECTOR (f
->menu_bar_vector
)->contents
,
339 previous_menu_items_used
* word_size
);
341 /* Fill in menu_items with the current menu bar contents.
342 This can evaluate Lisp code. */
345 menu_items
= f
->menu_bar_vector
;
346 menu_items_allocated
= VECTORP (menu_items
) ? ASIZE (menu_items
) : 0;
347 submenu_start
= (int *) alloca (ASIZE (items
) * sizeof (int));
348 submenu_end
= (int *) alloca (ASIZE (items
) * sizeof (int));
349 submenu_n_panes
= (int *) alloca (ASIZE (items
) * sizeof (int));
350 submenu_top_level_items
= (int *) alloca (ASIZE (items
) * sizeof (int));
352 for (i
= 0; i
< ASIZE (items
); i
+= 4)
354 Lisp_Object key
, string
, maps
;
358 key
= AREF (items
, i
);
359 string
= AREF (items
, i
+ 1);
360 maps
= AREF (items
, i
+ 2);
364 submenu_start
[i
] = menu_items_used
;
366 menu_items_n_panes
= 0;
367 submenu_top_level_items
[i
]
368 = parse_single_submenu (key
, string
, maps
);
369 submenu_n_panes
[i
] = menu_items_n_panes
;
371 submenu_end
[i
] = menu_items_used
;
374 finish_menu_items ();
376 /* Convert menu_items into widget_value trees
377 to display the menu. This cannot evaluate Lisp code. */
379 wv
= xmalloc_widget_value ();
380 wv
->name
= "menubar";
383 wv
->button_type
= BUTTON_TYPE_NONE
;
387 for (i
= 0; i
< last_i
; i
+= 4)
389 menu_items_n_panes
= submenu_n_panes
[i
];
390 wv
= digest_single_submenu (submenu_start
[i
], submenu_end
[i
],
391 submenu_top_level_items
[i
]);
395 first_wv
->contents
= wv
;
396 /* Don't set wv->name here; GC during the loop might relocate it. */
398 wv
->button_type
= BUTTON_TYPE_NONE
;
402 set_buffer_internal_1 (prev
);
404 /* If there has been no change in the Lisp-level contents
405 of the menu bar, skip redisplaying it. Just exit. */
407 for (i
= 0; i
< previous_menu_items_used
; i
++)
408 if (menu_items_used
== i
409 || (!EQ (previous_items
[i
], AREF (menu_items
, i
))))
411 if (i
== menu_items_used
&& i
== previous_menu_items_used
&& i
!= 0)
413 free_menubar_widget_value_tree (first_wv
);
414 discard_menu_items ();
415 unbind_to (specpdl_count
, Qnil
);
419 fset_menu_bar_vector (f
, menu_items
);
420 f
->menu_bar_items_used
= menu_items_used
;
422 /* This undoes save_menu_items. */
423 unbind_to (specpdl_count
, Qnil
);
425 /* Now GC cannot happen during the lifetime of the widget_value,
426 so it's safe to store data from a Lisp_String, as long as
427 local copies are made when the actual menu is created.
428 Windows takes care of this for normal string items, but
429 not for owner-drawn items or additional item-info. */
430 wv
= first_wv
->contents
;
431 for (i
= 0; i
< ASIZE (items
); i
+= 4)
434 string
= AREF (items
, i
+ 1);
437 wv
->name
= SSDATA (string
);
438 update_submenu_strings (wv
->contents
);
444 /* Make a widget-value tree containing
445 just the top level menu bar strings. */
447 wv
= xmalloc_widget_value ();
448 wv
->name
= "menubar";
451 wv
->button_type
= BUTTON_TYPE_NONE
;
455 items
= FRAME_MENU_BAR_ITEMS (f
);
456 for (i
= 0; i
< ASIZE (items
); i
+= 4)
460 string
= AREF (items
, i
+ 1);
464 wv
= xmalloc_widget_value ();
465 wv
->name
= SSDATA (string
);
468 wv
->button_type
= BUTTON_TYPE_NONE
;
470 /* This prevents lwlib from assuming this
471 menu item is really supposed to be empty. */
472 /* The EMACS_INT cast avoids a warning.
473 This value just has to be different from small integers. */
474 wv
->call_data
= (void *) (EMACS_INT
) (-1);
479 first_wv
->contents
= wv
;
483 /* Forget what we thought we knew about what is in the
484 detailed contents of the menu bar menus.
485 Changing the top level always destroys the contents. */
486 f
->menu_bar_items_used
= 0;
489 /* Create or update the menu bar widget. */
495 /* Empty current menubar, rather than creating a fresh one. */
496 while (DeleteMenu (menubar_widget
, 0, MF_BYPOSITION
))
501 menubar_widget
= CreateMenu ();
503 fill_in_menu (menubar_widget
, first_wv
->contents
);
505 free_menubar_widget_value_tree (first_wv
);
508 HMENU old_widget
= f
->output_data
.w32
->menubar_widget
;
510 f
->output_data
.w32
->menubar_widget
= menubar_widget
;
511 SetMenu (FRAME_W32_WINDOW (f
), f
->output_data
.w32
->menubar_widget
);
512 /* Causes flicker when menu bar is updated
513 DrawMenuBar (FRAME_W32_WINDOW (f)); */
515 /* Force the window size to be recomputed so that the frame's text
516 area remains the same, if menubar has just been created. */
517 if (old_widget
== NULL
)
518 x_set_window_size (f
, 0, FRAME_TEXT_WIDTH (f
), FRAME_TEXT_HEIGHT (f
), 1);
524 /* Called from Fx_create_frame to create the initial menubar of a frame
525 before it is mapped, so that the window is mapped with the menubar already
526 there instead of us tacking it on later and thrashing the window after it
530 initialize_frame_menubar (struct frame
*f
)
532 /* This function is called before the first chance to redisplay
533 the frame. It has to be, so the frame will have the right size. */
534 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
535 set_frame_menubar (f
, 1, 1);
538 /* Get rid of the menu bar of frame F, and free its storage.
539 This is used when deleting a frame, and when turning off the menu bar. */
542 free_frame_menubar (struct frame
*f
)
547 HMENU old
= GetMenu (FRAME_W32_WINDOW (f
));
548 SetMenu (FRAME_W32_WINDOW (f
), NULL
);
549 f
->output_data
.w32
->menubar_widget
= NULL
;
557 /* w32_menu_show actually displays a menu using the panes and items in
558 menu_items and returns the value selected from it; we assume input
559 is blocked by the caller. */
561 /* F is the frame the menu is for.
562 X and Y are the frame-relative specified position,
563 relative to the inside upper left corner of the frame F.
564 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
565 KEYMAPS is 1 if this menu was specified with keymaps;
566 in that case, we return a list containing the chosen item's value
567 and perhaps also the pane's prefix.
568 TITLE is the specified menu title.
569 ERROR is a place to store an error message string in case of failure.
570 (We return nil on failure, but the value doesn't actually matter.) */
573 w32_menu_show (struct frame
*f
, int x
, int y
, int for_click
, int keymaps
,
574 Lisp_Object title
, const char **error
)
577 int menu_item_selection
;
580 widget_value
*wv
, *save_wv
= 0, *first_wv
= 0, *prev_wv
= 0;
581 widget_value
**submenu_stack
582 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
583 Lisp_Object
*subprefix_stack
584 = (Lisp_Object
*) alloca (menu_items_used
* word_size
);
585 int submenu_depth
= 0;
590 if (menu_items_n_panes
== 0)
593 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
595 *error
= "Empty menu";
601 /* Create a tree of widget_value objects
602 representing the panes and their items. */
603 wv
= xmalloc_widget_value ();
607 wv
->button_type
= BUTTON_TYPE_NONE
;
612 /* Loop over all panes and items, filling in the tree. */
614 while (i
< menu_items_used
)
616 if (EQ (AREF (menu_items
, i
), Qnil
))
618 submenu_stack
[submenu_depth
++] = save_wv
;
624 else if (EQ (AREF (menu_items
, i
), Qlambda
))
627 save_wv
= submenu_stack
[--submenu_depth
];
631 else if (EQ (AREF (menu_items
, i
), Qt
)
632 && submenu_depth
!= 0)
633 i
+= MENU_ITEMS_PANE_LENGTH
;
634 /* Ignore a nil in the item list.
635 It's meaningful only for dialog boxes. */
636 else if (EQ (AREF (menu_items
, i
), Qquote
))
638 else if (EQ (AREF (menu_items
, i
), Qt
))
640 /* Create a new pane. */
641 Lisp_Object pane_name
, prefix
;
642 const char *pane_string
;
643 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
644 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
646 if (STRINGP (pane_name
))
648 if (unicode_append_menu
)
649 pane_name
= ENCODE_UTF_8 (pane_name
);
650 else if (STRING_MULTIBYTE (pane_name
))
651 pane_name
= ENCODE_SYSTEM (pane_name
);
653 ASET (menu_items
, i
+ MENU_ITEMS_PANE_NAME
, pane_name
);
656 pane_string
= (NILP (pane_name
)
657 ? "" : SSDATA (pane_name
));
658 /* If there is just one top-level pane, put all its items directly
659 under the top-level menu. */
660 if (menu_items_n_panes
== 1)
663 /* If the pane has a meaningful name,
664 make the pane a top-level menu item
665 with its items as a submenu beneath it. */
666 if (!keymaps
&& strcmp (pane_string
, ""))
668 wv
= xmalloc_widget_value ();
672 first_wv
->contents
= wv
;
673 wv
->name
= pane_string
;
674 if (keymaps
&& !NILP (prefix
))
678 wv
->button_type
= BUTTON_TYPE_NONE
;
689 i
+= MENU_ITEMS_PANE_LENGTH
;
693 /* Create a new item within current pane. */
694 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
, help
;
696 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
697 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
698 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
699 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
700 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
701 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
702 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
704 if (STRINGP (item_name
))
706 if (unicode_append_menu
)
707 item_name
= ENCODE_UTF_8 (item_name
);
708 else if (STRING_MULTIBYTE (item_name
))
709 item_name
= ENCODE_SYSTEM (item_name
);
711 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
, item_name
);
714 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
716 descrip
= ENCODE_SYSTEM (descrip
);
717 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
, descrip
);
720 wv
= xmalloc_widget_value ();
724 save_wv
->contents
= wv
;
725 wv
->name
= SSDATA (item_name
);
727 wv
->key
= SSDATA (descrip
);
729 /* Use the contents index as call_data, since we are
730 restricted to 16-bits. */
731 wv
->call_data
= !NILP (def
) ? (void *) (EMACS_INT
) i
: 0;
732 wv
->enabled
= !NILP (enable
);
735 wv
->button_type
= BUTTON_TYPE_NONE
;
736 else if (EQ (type
, QCtoggle
))
737 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
738 else if (EQ (type
, QCradio
))
739 wv
->button_type
= BUTTON_TYPE_RADIO
;
743 wv
->selected
= !NILP (selected
);
752 i
+= MENU_ITEMS_ITEM_LENGTH
;
756 /* Deal with the title, if it is non-nil. */
759 widget_value
*wv_title
= xmalloc_widget_value ();
760 widget_value
*wv_sep
= xmalloc_widget_value ();
762 /* Maybe replace this separator with a bitmap or owner-draw item
763 so that it looks better. Having two separators looks odd. */
765 wv_sep
->next
= first_wv
->contents
;
768 if (unicode_append_menu
)
769 title
= ENCODE_UTF_8 (title
);
770 else if (STRING_MULTIBYTE (title
))
771 title
= ENCODE_SYSTEM (title
);
773 wv_title
->name
= SSDATA (title
);
774 wv_title
->enabled
= TRUE
;
775 wv_title
->title
= TRUE
;
776 wv_title
->button_type
= BUTTON_TYPE_NONE
;
777 wv_title
->help
= Qnil
;
778 wv_title
->next
= wv_sep
;
779 first_wv
->contents
= wv_title
;
782 /* No selection has been chosen yet. */
783 menu_item_selection
= 0;
785 /* Actually create the menu. */
786 current_popup_menu
= menu
= CreatePopupMenu ();
787 fill_in_menu (menu
, first_wv
->contents
);
789 /* Adjust coordinates to be root-window-relative. */
792 ClientToScreen (FRAME_W32_WINDOW (f
), &pos
);
794 /* Display the menu. */
795 menu_item_selection
= SendMessage (FRAME_W32_WINDOW (f
),
796 WM_EMACS_TRACKPOPUPMENU
,
797 (WPARAM
)menu
, (LPARAM
)&pos
);
799 /* Clean up extraneous mouse events which might have been generated
801 discard_mouse_events ();
802 FRAME_DISPLAY_INFO (f
)->grabbed
= 0;
804 /* Free the widget_value objects we used to specify the contents. */
805 free_menubar_widget_value_tree (first_wv
);
809 /* Free the owner-drawn and help-echo menu strings. */
810 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
811 f
->output_data
.w32
->menubar_active
= 0;
813 /* Find the selected item, and its pane, to return
815 if (menu_item_selection
!= 0)
817 Lisp_Object prefix
, entry
;
819 prefix
= entry
= Qnil
;
821 while (i
< menu_items_used
)
823 if (EQ (AREF (menu_items
, i
), Qnil
))
825 subprefix_stack
[submenu_depth
++] = prefix
;
829 else if (EQ (AREF (menu_items
, i
), Qlambda
))
831 prefix
= subprefix_stack
[--submenu_depth
];
834 else if (EQ (AREF (menu_items
, i
), Qt
))
836 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
837 i
+= MENU_ITEMS_PANE_LENGTH
;
839 /* Ignore a nil in the item list.
840 It's meaningful only for dialog boxes. */
841 else if (EQ (AREF (menu_items
, i
), Qquote
))
845 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
846 if (menu_item_selection
== i
)
852 entry
= Fcons (entry
, Qnil
);
854 entry
= Fcons (prefix
, entry
);
855 for (j
= submenu_depth
- 1; j
>= 0; j
--)
856 if (!NILP (subprefix_stack
[j
]))
857 entry
= Fcons (subprefix_stack
[j
], entry
);
862 i
+= MENU_ITEMS_ITEM_LENGTH
;
869 /* Make "Cancel" equivalent to C-g. */
870 Fsignal (Qquit
, Qnil
);
879 /* TODO: On Windows, there are two ways of defining a dialog.
881 1. Create a predefined dialog resource and include it in nt/emacs.rc.
882 Using this method, we could then set the titles and make unneeded
883 buttons invisible before displaying the dialog. Everything would
884 be a fixed size though, so there is a risk that text does not
886 2. Create the dialog template in memory on the fly. This allows us
887 to size the dialog and buttons dynamically, probably giving more
888 natural looking results for dialogs with few buttons, and eliminating
889 the problem of text overflowing the buttons. But the API for this is
890 quite complex - structures have to be allocated in particular ways,
891 text content is tacked onto the end of structures in variable length
892 arrays with further structures tacked on after these, there are
893 certain alignment requirements for all this, and we have to
894 measure all the text and convert to "dialog coordinates" to figure
895 out how big to make everything.
897 For now, we'll just stick with menus for dialogs that are more
898 complicated than simple yes/no type questions for which we can use
899 the MessageBox function.
902 static char * button_names
[] = {
903 "button1", "button2", "button3", "button4", "button5",
904 "button6", "button7", "button8", "button9", "button10" };
907 w32_dialog_show (struct frame
*f
, int keymaps
,
908 Lisp_Object title
, Lisp_Object header
,
911 int i
, nb_buttons
= 0;
913 int menu_item_selection
;
915 widget_value
*wv
, *first_wv
= 0, *prev_wv
= 0;
917 /* Number of elements seen so far, before boundary. */
919 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
920 int boundary_seen
= 0;
924 if (menu_items_n_panes
> 1)
926 *error
= "Multiple panes in dialog box";
930 /* Create a tree of widget_value objects
931 representing the text label and buttons. */
933 Lisp_Object pane_name
, prefix
;
935 pane_name
= AREF (menu_items
, MENU_ITEMS_PANE_NAME
);
936 prefix
= AREF (menu_items
, MENU_ITEMS_PANE_PREFIX
);
937 pane_string
= (NILP (pane_name
)
938 ? "" : SSDATA (pane_name
));
939 prev_wv
= xmalloc_widget_value ();
940 prev_wv
->value
= pane_string
;
941 if (keymaps
&& !NILP (prefix
))
943 prev_wv
->enabled
= 1;
944 prev_wv
->name
= "message";
945 prev_wv
->help
= Qnil
;
948 /* Loop over all panes and items, filling in the tree. */
949 i
= MENU_ITEMS_PANE_LENGTH
;
950 while (i
< menu_items_used
)
953 /* Create a new item within current pane. */
954 Lisp_Object item_name
, enable
, descrip
, help
;
956 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
957 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
958 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
959 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
961 if (NILP (item_name
))
963 free_menubar_widget_value_tree (first_wv
);
964 *error
= "Submenu in dialog items";
967 if (EQ (item_name
, Qquote
))
969 /* This is the boundary between left-side elts
970 and right-side elts. Stop incrementing right_count. */
977 free_menubar_widget_value_tree (first_wv
);
978 *error
= "Too many dialog items";
982 wv
= xmalloc_widget_value ();
984 wv
->name
= (char *) button_names
[nb_buttons
];
986 wv
->key
= SSDATA (descrip
);
987 wv
->value
= SSDATA (item_name
);
988 wv
->call_data
= aref_addr (menu_items
, i
);
989 wv
->enabled
= !NILP (enable
);
997 i
+= MENU_ITEMS_ITEM_LENGTH
;
1000 /* If the boundary was not specified,
1001 by default put half on the left and half on the right. */
1002 if (! boundary_seen
)
1003 left_count
= nb_buttons
- nb_buttons
/ 2;
1005 wv
= xmalloc_widget_value ();
1006 wv
->name
= dialog_name
;
1009 /* Frame title: 'Q' = Question, 'I' = Information.
1010 Can also have 'E' = Error if, one day, we want
1011 a popup for errors. */
1013 dialog_name
[0] = 'Q';
1015 dialog_name
[0] = 'I';
1017 /* Dialog boxes use a really stupid name encoding
1018 which specifies how many buttons to use
1019 and how many buttons are on the right. */
1020 dialog_name
[1] = '0' + nb_buttons
;
1021 dialog_name
[2] = 'B';
1022 dialog_name
[3] = 'R';
1023 /* Number of buttons to put on the right. */
1024 dialog_name
[4] = '0' + nb_buttons
- left_count
;
1026 wv
->contents
= first_wv
;
1030 /* Actually create the dialog. */
1031 dialog_id
= widget_id_tick
++;
1032 menu
= lw_create_widget (first_wv
->name
, "dialog", dialog_id
, first_wv
,
1033 f
->output_data
.w32
->widget
, 1, 0,
1034 dialog_selection_callback
, 0);
1035 lw_modify_all_widgets (dialog_id
, first_wv
->contents
, TRUE
);
1037 /* Free the widget_value objects we used to specify the contents. */
1038 free_menubar_widget_value_tree (first_wv
);
1040 /* No selection has been chosen yet. */
1041 menu_item_selection
= 0;
1043 /* Display the menu. */
1044 lw_pop_up_all_widgets (dialog_id
);
1046 /* Process events that apply to the menu. */
1047 popup_get_selection ((XEvent
*) 0, FRAME_DISPLAY_INFO (f
), dialog_id
);
1049 lw_destroy_all_widgets (dialog_id
);
1051 /* Find the selected item, and its pane, to return
1052 the proper value. */
1053 if (menu_item_selection
!= 0)
1059 while (i
< menu_items_used
)
1063 if (EQ (AREF (menu_items
, i
), Qt
))
1065 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
1066 i
+= MENU_ITEMS_PANE_LENGTH
;
1070 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
1071 if (menu_item_selection
== i
)
1075 entry
= Fcons (entry
, Qnil
);
1077 entry
= Fcons (prefix
, entry
);
1081 i
+= MENU_ITEMS_ITEM_LENGTH
;
1086 /* Make "Cancel" equivalent to C-g. */
1087 Fsignal (Qquit
, Qnil
);
1091 #else /* !HAVE_DIALOGS */
1093 /* Currently we only handle Yes No dialogs (y-or-n-p and yes-or-no-p) as
1094 simple dialogs. We could handle a few more, but I'm not aware of
1095 anywhere in Emacs that uses the other specific dialog choices that
1096 MessageBox provides. */
1099 is_simple_dialog (Lisp_Object contents
)
1101 Lisp_Object options
;
1102 Lisp_Object name
, yes
, no
, other
;
1104 if (!CONSP (contents
))
1106 options
= XCDR (contents
);
1108 yes
= build_string ("Yes");
1109 no
= build_string ("No");
1111 if (!CONSP (options
))
1114 name
= XCAR (options
);
1119 if (!NILP (Fstring_equal (name
, yes
)))
1121 else if (!NILP (Fstring_equal (name
, no
)))
1126 options
= XCDR (options
);
1127 if (!CONSP (options
))
1130 name
= XCAR (options
);
1134 if (NILP (Fstring_equal (name
, other
)))
1137 /* Check there are no more options. */
1138 options
= XCDR (options
);
1139 return !(CONSP (options
));
1143 simple_dialog_show (struct frame
*f
, Lisp_Object contents
, Lisp_Object header
)
1147 Lisp_Object lispy_answer
= Qnil
, temp
= XCAR (contents
);
1151 /* Since we only handle Yes/No dialogs, and we already checked
1152 is_simple_dialog, we don't need to worry about checking contents
1153 to see what type of dialog to use. */
1155 /* Use Unicode if possible, so any language can be displayed. */
1156 if (unicode_message_box
)
1164 char *utf8_text
= SDATA (ENCODE_UTF_8 (temp
));
1165 /* Be pessimistic about the number of characters needed.
1166 Remember characters outside the BMP will take more than
1167 one utf16 word, so we cannot simply use the character
1169 int utf8_len
= strlen (utf8_text
);
1170 text
= SAFE_ALLOCA ((utf8_len
+ 1) * sizeof (WCHAR
));
1171 utf8to16 (utf8_text
, utf8_len
, text
);
1180 title
= L
"Question";
1181 type
|= MB_ICONQUESTION
;
1185 title
= L
"Information";
1186 type
|= MB_ICONINFORMATION
;
1189 answer
= unicode_message_box (FRAME_W32_WINDOW (f
), text
, title
, type
);
1194 const char *text
, *title
;
1196 /* Fall back on ANSI message box, but at least use system
1197 encoding so questions representable by the system codepage
1198 are encoded properly. */
1200 text
= SDATA (ENCODE_SYSTEM (temp
));
1207 type
|= MB_ICONQUESTION
;
1211 title
= "Information";
1212 type
|= MB_ICONINFORMATION
;
1215 answer
= MessageBox (FRAME_W32_WINDOW (f
), text
, title
, type
);
1218 if (answer
== IDYES
)
1219 lispy_answer
= build_string ("Yes");
1220 else if (answer
== IDNO
)
1221 lispy_answer
= build_string ("No");
1223 Fsignal (Qquit
, Qnil
);
1225 for (temp
= XCDR (contents
); CONSP (temp
); temp
= XCDR (temp
))
1227 Lisp_Object item
, name
, value
;
1232 value
= XCDR (item
);
1240 if (!NILP (Fstring_equal (name
, lispy_answer
)))
1245 Fsignal (Qquit
, Qnil
);
1248 #endif /* !HAVE_DIALOGS */
1251 /* UTF8: 0xxxxxxx, 110xxxxx 10xxxxxx, 1110xxxx, 10xxxxxx, 10xxxxxx */
1253 utf8to16 (unsigned char * src
, int len
, WCHAR
* dest
)
1259 *dest
= (WCHAR
) *src
;
1260 dest
++; src
++; len
--;
1262 /* Since we might get >3 byte sequences which we don't handle, ignore the extra parts. */
1263 else if (*src
< 0xC0)
1267 /* 2 char UTF-8 sequence. */
1268 else if (*src
< 0xE0)
1270 *dest
= (WCHAR
) (((*src
& 0x1f) << 6)
1271 | (*(src
+ 1) & 0x3f));
1272 src
+= 2; len
-= 2; dest
++;
1274 else if (*src
< 0xF0)
1276 *dest
= (WCHAR
) (((*src
& 0x0f) << 12)
1277 | ((*(src
+ 1) & 0x3f) << 6)
1278 | (*(src
+ 2) & 0x3f));
1279 src
+= 3; len
-= 3; dest
++;
1281 else /* Not encodable. Insert Unicode Substitution char. */
1283 *dest
= (WCHAR
) 0xfffd;
1284 src
++; len
--; dest
++;
1291 add_menu_item (HMENU menu
, widget_value
*wv
, HMENU item
)
1294 char *out_string
, *p
, *q
;
1296 size_t nlen
, orig_len
;
1299 if (menu_separator_name_p (wv
->name
))
1301 fuFlags
= MF_SEPARATOR
;
1307 fuFlags
= MF_STRING
;
1309 fuFlags
= MF_STRING
| MF_GRAYED
;
1311 if (wv
->key
!= NULL
)
1313 out_string
= SAFE_ALLOCA (strlen (wv
->name
) + strlen (wv
->key
) + 2);
1314 strcpy (out_string
, wv
->name
);
1315 strcat (out_string
, "\t");
1316 strcat (out_string
, wv
->key
);
1319 out_string
= (char *)wv
->name
;
1321 /* Quote any special characters within the menu item's text and
1323 nlen
= orig_len
= strlen (out_string
);
1324 if (unicode_append_menu
)
1326 /* With UTF-8, & cannot be part of a multibyte character. */
1327 for (p
= out_string
; *p
; p
++)
1333 #ifndef NTGUI_UNICODE
1336 /* If encoded with the system codepage, use multibyte string
1337 functions in case of multibyte characters that contain '&'. */
1338 for (p
= out_string
; *p
; p
= _mbsinc (p
))
1340 if (_mbsnextc (p
) == '&')
1344 #endif /* !NTGUI_UNICODE */
1346 if (nlen
> orig_len
)
1349 out_string
= SAFE_ALLOCA (nlen
+ 1);
1353 if (unicode_append_menu
)
1359 #ifndef NTGUI_UNICODE
1362 if (_mbsnextc (p
) == '&')
1371 #endif /* !NTGUI_UNICODE */
1378 else if (wv
->title
|| wv
->call_data
== 0)
1380 /* Only use MF_OWNERDRAW if GetMenuItemInfo is usable, since
1381 we can't deallocate the memory otherwise. */
1382 if (get_menu_item_info
)
1384 out_string
= (char *) local_alloc (strlen (wv
->name
) + 1);
1385 strcpy (out_string
, wv
->name
);
1387 DebPrint ("Menu: allocating %ld for owner-draw", out_string
);
1389 fuFlags
= MF_OWNERDRAW
| MF_DISABLED
;
1392 fuFlags
= MF_DISABLED
;
1395 /* Draw radio buttons and tickboxes. */
1396 else if (wv
->selected
&& (wv
->button_type
== BUTTON_TYPE_TOGGLE
||
1397 wv
->button_type
== BUTTON_TYPE_RADIO
))
1398 fuFlags
|= MF_CHECKED
;
1400 fuFlags
|= MF_UNCHECKED
;
1403 if (unicode_append_menu
&& out_string
)
1405 /* Convert out_string from UTF-8 to UTF-16-LE. */
1406 int utf8_len
= strlen (out_string
);
1407 WCHAR
* utf16_string
;
1408 if (fuFlags
& MF_OWNERDRAW
)
1409 utf16_string
= local_alloc ((utf8_len
+ 1) * sizeof (WCHAR
));
1411 utf16_string
= SAFE_ALLOCA ((utf8_len
+ 1) * sizeof (WCHAR
));
1413 utf8to16 (out_string
, utf8_len
, utf16_string
);
1414 return_value
= unicode_append_menu (menu
, fuFlags
,
1415 item
!= NULL
? (UINT_PTR
) item
1416 : (UINT_PTR
) wv
->call_data
,
1419 #ifndef NTGUI_UNICODE /* Fallback does not apply when always UNICODE */
1422 /* On W9x/ME, Unicode menus are not supported, though AppendMenuW
1423 apparently does exist at least in some cases and appears to be
1424 stubbed out to do nothing. out_string is UTF-8, but since
1425 our standard menus are in English and this is only going to
1426 happen the first time a menu is used, the encoding is
1427 of minor importance compared with menus not working at all. */
1429 AppendMenu (menu
, fuFlags
,
1430 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1432 /* Don't use Unicode menus in future, unless this is Windows
1433 NT or later, where a failure of AppendMenuW does NOT mean
1434 Unicode menus are unsupported. */
1435 if (osinfo_cache
.dwPlatformId
!= VER_PLATFORM_WIN32_NT
)
1436 unicode_append_menu
= NULL
;
1438 #endif /* NTGUI_UNICODE */
1440 if (unicode_append_menu
&& (fuFlags
& MF_OWNERDRAW
))
1441 local_free (out_string
);
1448 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1452 /* This must be done after the menu item is created. */
1453 if (!wv
->title
&& wv
->call_data
!= 0)
1455 if (set_menu_item_info
)
1458 memset (&info
, 0, sizeof (info
));
1459 info
.cbSize
= sizeof (info
);
1460 info
.fMask
= MIIM_DATA
;
1462 /* Set help string for menu item. Leave it as a Lisp_Object
1463 until it is ready to be displayed, since GC can happen while
1464 menus are active. */
1465 if (!NILP (wv
->help
))
1467 /* As of Jul-2012, w32api headers say that dwItemData
1468 has DWORD type, but that's a bug: it should actually
1469 be ULONG_PTR, which is correct for 32-bit and 64-bit
1470 Windows alike. MSVC headers get it right; hopefully,
1471 MinGW headers will, too. */
1472 info
.dwItemData
= (ULONG_PTR
) XLI (wv
->help
);
1474 if (wv
->button_type
== BUTTON_TYPE_RADIO
)
1476 /* CheckMenuRadioItem allows us to differentiate TOGGLE and
1477 RADIO items, but is not available on NT 3.51 and earlier. */
1478 info
.fMask
|= MIIM_TYPE
| MIIM_STATE
;
1479 info
.fType
= MFT_RADIOCHECK
| MFT_STRING
;
1480 info
.dwTypeData
= out_string
;
1481 info
.fState
= wv
->selected
? MFS_CHECKED
: MFS_UNCHECKED
;
1484 set_menu_item_info (menu
,
1485 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1490 return return_value
;
1493 /* Construct native Windows menu(bar) based on widget_value tree. */
1495 fill_in_menu (HMENU menu
, widget_value
*wv
)
1497 for ( ; wv
!= NULL
; wv
= wv
->next
)
1501 HMENU sub_menu
= CreatePopupMenu ();
1503 if (sub_menu
== NULL
)
1506 if (!fill_in_menu (sub_menu
, wv
->contents
) ||
1507 !add_menu_item (menu
, wv
, sub_menu
))
1509 DestroyMenu (sub_menu
);
1515 if (!add_menu_item (menu
, wv
, NULL
))
1522 /* Display help string for currently pointed to menu item. Not
1523 supported on NT 3.51 and earlier, as GetMenuItemInfo is not
1526 w32_menu_display_help (HWND owner
, HMENU menu
, UINT item
, UINT flags
)
1528 if (get_menu_item_info
)
1530 struct frame
*f
= x_window_to_frame (&one_w32_display_info
, owner
);
1531 Lisp_Object frame
, help
;
1533 /* No help echo on owner-draw menu items, or when the keyboard is used
1534 to navigate the menus, since tooltips are distracting if they pop
1536 if (flags
& MF_OWNERDRAW
|| flags
& MF_POPUP
1537 || !(flags
& MF_MOUSESELECT
))
1543 memset (&info
, 0, sizeof (info
));
1544 info
.cbSize
= sizeof (info
);
1545 info
.fMask
= MIIM_DATA
;
1546 get_menu_item_info (menu
, item
, FALSE
, &info
);
1548 help
= info
.dwItemData
? XIL (info
.dwItemData
) : Qnil
;
1551 /* Store the help echo in the keyboard buffer as the X toolkit
1552 version does, rather than directly showing it. This seems to
1553 solve the GC problems that were present when we based the
1554 Windows code on the non-toolkit version. */
1557 XSETFRAME (frame
, f
);
1558 kbd_buffer_store_help_event (frame
, help
);
1561 /* X version has a loop through frames here, which doesn't
1562 appear to do anything, unless it has some side effect. */
1563 show_help_echo (help
, Qnil
, Qnil
, Qnil
);
1567 /* Free memory used by owner-drawn strings. */
1569 w32_free_submenu_strings (HMENU menu
)
1571 int i
, num
= GetMenuItemCount (menu
);
1572 for (i
= 0; i
< num
; i
++)
1575 memset (&info
, 0, sizeof (info
));
1576 info
.cbSize
= sizeof (info
);
1577 info
.fMask
= MIIM_DATA
| MIIM_TYPE
| MIIM_SUBMENU
;
1579 get_menu_item_info (menu
, i
, TRUE
, &info
);
1581 /* Owner-drawn names are held in dwItemData. */
1582 if ((info
.fType
& MF_OWNERDRAW
) && info
.dwItemData
)
1585 DebPrint ("Menu: freeing %ld for owner-draw", info
.dwItemData
);
1587 local_free (info
.dwItemData
);
1590 /* Recurse down submenus. */
1592 w32_free_submenu_strings (info
.hSubMenu
);
1597 w32_free_menu_strings (HWND hwnd
)
1599 HMENU menu
= current_popup_menu
;
1601 if (get_menu_item_info
)
1603 /* If there is no popup menu active, free the strings from the frame's
1606 menu
= GetMenu (hwnd
);
1609 w32_free_submenu_strings (menu
);
1612 current_popup_menu
= NULL
;
1615 /* The following is used by delayed window autoselection. */
1617 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p
, Smenu_or_popup_active_p
, 0, 0, 0,
1618 doc
: /* Return t if a menu or popup dialog is active on selected frame. */)
1622 f
= SELECTED_FRAME ();
1623 return (f
->output_data
.w32
->menubar_active
> 0) ? Qt
: Qnil
;
1627 syms_of_w32menu (void)
1629 globals_of_w32menu ();
1631 current_popup_menu
= NULL
;
1633 DEFSYM (Qdebug_on_next_call
, "debug-on-next-call");
1634 DEFSYM (Qunsupported__w32_dialog
, "unsupported--w32-dialog");
1636 defsubr (&Smenu_or_popup_active_p
);
1640 globals_of_w32menu is used to initialize those global variables that
1641 must always be initialized on startup even when the global variable
1642 initialized is non zero (see the function main in emacs.c).
1643 globals_of_w32menu is called from syms_of_w32menu when the global
1644 variable initialized is 0 and directly from main when initialized
1648 globals_of_w32menu (void)
1650 #ifndef NTGUI_UNICODE
1651 /* See if Get/SetMenuItemInfo functions are available. */
1652 HMODULE user32
= GetModuleHandle ("user32.dll");
1653 get_menu_item_info
= (GetMenuItemInfoA_Proc
) GetProcAddress (user32
, "GetMenuItemInfoA");
1654 set_menu_item_info
= (SetMenuItemInfoA_Proc
) GetProcAddress (user32
, "SetMenuItemInfoA");
1655 unicode_append_menu
= (AppendMenuW_Proc
) GetProcAddress (user32
, "AppendMenuW");
1656 unicode_message_box
= (MessageBoxW_Proc
) GetProcAddress (user32
, "MessageBoxW");
1657 #endif /* !NTGUI_UNICODE */