1 /* Menu support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1986, 1988, 1993-1994, 1996, 1998-1999, 2001-2017 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 (at
10 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/>. */
29 #include "blockinput.h"
31 #include "coding.h" /* for ENCODE_SYSTEM */
34 /* This may include sys/types.h, and that somehow loses
35 if this is not done before the other system files. */
38 /* Cygwin does not support the multibyte string functions declared in
39 * mbstring.h below --- but that's okay: because Cygwin is
40 * UNICODE-only, we don't need to use these functions anyway. */
44 #endif /* !NTGUI_UNICODE */
46 /* Load sys/types.h if not already loaded.
47 In some systems loading it twice is suicidal. */
49 #include <sys/types.h>
52 #include "w32common.h" /* for osinfo_cache */
54 #undef HAVE_DIALOGS /* TODO: Implement native dialogs. */
61 HMENU current_popup_menu
;
63 typedef BOOL (WINAPI
* GetMenuItemInfoA_Proc
) (
67 IN OUT LPMENUITEMINFOA
);
68 typedef BOOL (WINAPI
* SetMenuItemInfoA_Proc
) (
73 typedef int (WINAPI
* MessageBoxW_Proc
) (
76 IN
const WCHAR
*caption
,
80 GetMenuItemInfoA_Proc get_menu_item_info
= GetMenuItemInfoA
;
81 SetMenuItemInfoA_Proc set_menu_item_info
= SetMenuItemInfoA
;
82 AppendMenuW_Proc unicode_append_menu
= AppendMenuW
;
83 MessageBoxW_Proc unicode_message_box
= MessageBoxW
;
84 #else /* !NTGUI_UNICODE */
85 GetMenuItemInfoA_Proc get_menu_item_info
= NULL
;
86 SetMenuItemInfoA_Proc set_menu_item_info
= NULL
;
87 AppendMenuW_Proc unicode_append_menu
= NULL
;
88 MessageBoxW_Proc unicode_message_box
= NULL
;
89 #endif /* NTGUI_UNICODE */
92 static Lisp_Object
w32_dialog_show (struct frame
*, Lisp_Object
, Lisp_Object
, char **);
94 static bool is_simple_dialog (Lisp_Object
);
95 static Lisp_Object
simple_dialog_show (struct frame
*, Lisp_Object
, Lisp_Object
);
98 static void utf8to16 (unsigned char *, int, WCHAR
*);
99 static int fill_in_menu (HMENU
, widget_value
*);
101 void w32_free_menu_strings (HWND
);
104 w32_popup_dialog (struct frame
*f
, Lisp_Object header
, Lisp_Object contents
)
107 check_window_system (f
);
111 /* Handle simple Yes/No choices as MessageBox popups. */
112 if (is_simple_dialog (contents
))
113 return simple_dialog_show (f
, contents
, header
);
115 return Qunsupported__w32_dialog
;
116 #else /* HAVE_DIALOGS */
120 Lisp_Object selection
;
122 /* Decode the dialog items from what was specified. */
123 title
= Fcar (contents
);
124 CHECK_STRING (title
);
126 list_of_panes (Fcons (contents
, Qnil
));
128 /* Display them in a dialog box. */
130 selection
= w32_dialog_show (f
, title
, header
, &error_name
);
133 discard_menu_items ();
134 FRAME_DISPLAY_INFO (f
)->grabbed
= 0;
136 if (error_name
) error (error_name
);
139 #endif /* HAVE_DIALOGS */
142 /* Activate the menu bar of frame F.
143 This is called from keyboard.c when it gets the
144 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
146 To activate the menu bar, we signal to the input thread that it can
147 return from the WM_INITMENU message, allowing the normal Windows
148 processing of the menus.
150 But first we recompute the menu bar contents (the whole tree).
152 This way we can safely execute Lisp code. */
155 x_activate_menubar (struct frame
*f
)
157 set_frame_menubar (f
, false, true);
159 /* Lock out further menubar changes while active. */
160 f
->output_data
.w32
->menubar_active
= 1;
162 /* Signal input thread to return from WM_INITMENU. */
163 complete_deferred_msg (FRAME_W32_WINDOW (f
), WM_INITMENU
, 0);
166 /* This callback is called from the menu bar pulldown menu
167 when the user makes a selection.
168 Figure out what the user chose
169 and put the appropriate events into the keyboard buffer. */
170 void menubar_selection_callback (struct frame
*, void *);
173 menubar_selection_callback (struct frame
*f
, void * client_data
)
175 Lisp_Object prefix
, entry
;
177 Lisp_Object
*subprefix_stack
;
178 int submenu_depth
= 0;
184 subprefix_stack
= (Lisp_Object
*) alloca (f
->menu_bar_items_used
* word_size
);
185 vector
= f
->menu_bar_vector
;
188 while (i
< f
->menu_bar_items_used
)
190 if (EQ (AREF (vector
, i
), Qnil
))
192 subprefix_stack
[submenu_depth
++] = prefix
;
196 else if (EQ (AREF (vector
, i
), Qlambda
))
198 prefix
= subprefix_stack
[--submenu_depth
];
201 else if (EQ (AREF (vector
, i
), Qt
))
203 prefix
= AREF (vector
, i
+ MENU_ITEMS_PANE_PREFIX
);
204 i
+= MENU_ITEMS_PANE_LENGTH
;
208 entry
= AREF (vector
, i
+ MENU_ITEMS_ITEM_VALUE
);
209 /* The UINT_PTR cast avoids a warning. There's no problem
210 as long as pointers have enough bits to hold small integers. */
211 if ((int) (UINT_PTR
) client_data
== i
)
214 struct input_event buf
;
218 XSETFRAME (frame
, f
);
219 buf
.kind
= MENU_BAR_EVENT
;
220 buf
.frame_or_window
= frame
;
222 kbd_buffer_store_event (&buf
);
224 for (j
= 0; j
< submenu_depth
; j
++)
225 if (!NILP (subprefix_stack
[j
]))
227 buf
.kind
= MENU_BAR_EVENT
;
228 buf
.frame_or_window
= frame
;
229 buf
.arg
= subprefix_stack
[j
];
230 kbd_buffer_store_event (&buf
);
235 buf
.kind
= MENU_BAR_EVENT
;
236 buf
.frame_or_window
= frame
;
238 kbd_buffer_store_event (&buf
);
241 buf
.kind
= MENU_BAR_EVENT
;
242 buf
.frame_or_window
= frame
;
244 /* Free memory used by owner-drawn and help-echo strings. */
245 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
246 kbd_buffer_store_event (&buf
);
248 f
->output_data
.w32
->menubar_active
= 0;
251 i
+= MENU_ITEMS_ITEM_LENGTH
;
254 /* Free memory used by owner-drawn and help-echo strings. */
255 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
256 f
->output_data
.w32
->menubar_active
= 0;
260 /* Set the contents of the menubar widgets of frame F.
261 The argument FIRST_TIME is currently ignored;
262 it is set the first time this is called, from initialize_frame_menubar. */
265 set_frame_menubar (struct frame
*f
, bool first_time
, bool deep_p
)
267 HMENU menubar_widget
= f
->output_data
.w32
->menubar_widget
;
269 widget_value
*wv
, *first_wv
, *prev_wv
= 0;
271 int *submenu_start
, *submenu_end
;
272 int *submenu_top_level_items
, *submenu_n_panes
;
274 /* We must not change the menubar when actually in use. */
275 if (f
->output_data
.w32
->menubar_active
)
278 XSETFRAME (Vmenu_updating_frame
, f
);
280 if (! menubar_widget
)
285 /* Make a widget-value tree representing the entire menu trees. */
287 struct buffer
*prev
= current_buffer
;
289 ptrdiff_t specpdl_count
= SPECPDL_INDEX ();
290 int previous_menu_items_used
= f
->menu_bar_items_used
;
291 Lisp_Object
*previous_items
292 = (Lisp_Object
*) alloca (previous_menu_items_used
295 /* If we are making a new widget, its contents are empty,
296 do always reinitialize them. */
297 if (! menubar_widget
)
298 previous_menu_items_used
= 0;
300 buffer
= XWINDOW (FRAME_SELECTED_WINDOW (f
))->contents
;
301 specbind (Qinhibit_quit
, Qt
);
302 /* Don't let the debugger step into this code
303 because it is not reentrant. */
304 specbind (Qdebug_on_next_call
, Qnil
);
306 record_unwind_save_match_data ();
308 if (NILP (Voverriding_local_map_menu_flag
))
310 specbind (Qoverriding_terminal_local_map
, Qnil
);
311 specbind (Qoverriding_local_map
, Qnil
);
314 set_buffer_internal_1 (XBUFFER (buffer
));
317 safe_run_hooks (Qactivate_menubar_hook
);
318 safe_run_hooks (Qmenu_bar_update_hook
);
319 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
321 items
= FRAME_MENU_BAR_ITEMS (f
);
323 /* Save the frame's previous menu bar contents data. */
324 if (previous_menu_items_used
)
325 memcpy (previous_items
, XVECTOR (f
->menu_bar_vector
)->contents
,
326 previous_menu_items_used
* word_size
);
328 /* Fill in menu_items with the current menu bar contents.
329 This can evaluate Lisp code. */
332 menu_items
= f
->menu_bar_vector
;
333 menu_items_allocated
= VECTORP (menu_items
) ? ASIZE (menu_items
) : 0;
334 submenu_start
= (int *) alloca (ASIZE (items
) * sizeof (int));
335 submenu_end
= (int *) alloca (ASIZE (items
) * sizeof (int));
336 submenu_n_panes
= (int *) alloca (ASIZE (items
) * sizeof (int));
337 submenu_top_level_items
= (int *) alloca (ASIZE (items
) * sizeof (int));
339 for (i
= 0; i
< ASIZE (items
); i
+= 4)
341 Lisp_Object key
, string
, maps
;
345 key
= AREF (items
, i
);
346 string
= AREF (items
, i
+ 1);
347 maps
= AREF (items
, i
+ 2);
351 submenu_start
[i
] = menu_items_used
;
353 menu_items_n_panes
= 0;
354 submenu_top_level_items
[i
]
355 = parse_single_submenu (key
, string
, maps
);
356 submenu_n_panes
[i
] = menu_items_n_panes
;
358 submenu_end
[i
] = menu_items_used
;
361 finish_menu_items ();
363 /* Convert menu_items into widget_value trees
364 to display the menu. This cannot evaluate Lisp code. */
366 wv
= make_widget_value ("menubar", NULL
, true, Qnil
);
367 wv
->button_type
= BUTTON_TYPE_NONE
;
370 for (i
= 0; i
< last_i
; i
+= 4)
372 menu_items_n_panes
= submenu_n_panes
[i
];
373 wv
= digest_single_submenu (submenu_start
[i
], submenu_end
[i
],
374 submenu_top_level_items
[i
]);
378 first_wv
->contents
= wv
;
379 /* Don't set wv->name here; GC during the loop might relocate it. */
381 wv
->button_type
= BUTTON_TYPE_NONE
;
385 set_buffer_internal_1 (prev
);
387 /* If there has been no change in the Lisp-level contents
388 of the menu bar, skip redisplaying it. Just exit. */
390 for (i
= 0; i
< previous_menu_items_used
; i
++)
391 if (menu_items_used
== i
392 || (!EQ (previous_items
[i
], AREF (menu_items
, i
))))
394 if (i
== menu_items_used
&& i
== previous_menu_items_used
&& i
!= 0)
396 free_menubar_widget_value_tree (first_wv
);
397 discard_menu_items ();
398 unbind_to (specpdl_count
, Qnil
);
402 fset_menu_bar_vector (f
, menu_items
);
403 f
->menu_bar_items_used
= menu_items_used
;
405 /* This undoes save_menu_items. */
406 unbind_to (specpdl_count
, Qnil
);
408 /* Now GC cannot happen during the lifetime of the widget_value,
409 so it's safe to store data from a Lisp_String, as long as
410 local copies are made when the actual menu is created.
411 Windows takes care of this for normal string items, but
412 not for owner-drawn items or additional item-info. */
413 wv
= first_wv
->contents
;
414 for (i
= 0; i
< ASIZE (items
); i
+= 4)
417 string
= AREF (items
, i
+ 1);
420 wv
->name
= SSDATA (string
);
421 update_submenu_strings (wv
->contents
);
427 /* Make a widget-value tree containing
428 just the top level menu bar strings. */
430 wv
= make_widget_value ("menubar", NULL
, true, Qnil
);
431 wv
->button_type
= BUTTON_TYPE_NONE
;
434 items
= FRAME_MENU_BAR_ITEMS (f
);
435 for (i
= 0; i
< ASIZE (items
); i
+= 4)
439 string
= AREF (items
, i
+ 1);
443 wv
= make_widget_value (SSDATA (string
), NULL
, true, Qnil
);
444 wv
->button_type
= BUTTON_TYPE_NONE
;
445 /* This prevents lwlib from assuming this
446 menu item is really supposed to be empty. */
447 /* The EMACS_INT cast avoids a warning.
448 This value just has to be different from small integers. */
449 wv
->call_data
= (void *) (EMACS_INT
) (-1);
454 first_wv
->contents
= wv
;
458 /* Forget what we thought we knew about what is in the
459 detailed contents of the menu bar menus.
460 Changing the top level always destroys the contents. */
461 f
->menu_bar_items_used
= 0;
464 /* Create or update the menu bar widget. */
470 /* Empty current menubar, rather than creating a fresh one. */
471 while (DeleteMenu (menubar_widget
, 0, MF_BYPOSITION
))
476 menubar_widget
= CreateMenu ();
478 fill_in_menu (menubar_widget
, first_wv
->contents
);
480 free_menubar_widget_value_tree (first_wv
);
483 HMENU old_widget
= f
->output_data
.w32
->menubar_widget
;
485 f
->output_data
.w32
->menubar_widget
= menubar_widget
;
486 SetMenu (FRAME_W32_WINDOW (f
), f
->output_data
.w32
->menubar_widget
);
487 /* Causes flicker when menu bar is updated
488 DrawMenuBar (FRAME_W32_WINDOW (f)); */
490 /* Force the window size to be recomputed so that the frame's text
491 area remains the same, if menubar has just been created. */
492 if (old_widget
== NULL
)
494 windows_or_buffers_changed
= 23;
495 adjust_frame_size (f
, -1, -1, 2, false, Qmenu_bar_lines
);
502 /* Called from Fx_create_frame to create the initial menubar of a frame
503 before it is mapped, so that the window is mapped with the menubar already
504 there instead of us tacking it on later and thrashing the window after it
508 initialize_frame_menubar (struct frame
*f
)
510 /* This function is called before the first chance to redisplay
511 the frame. It has to be, so the frame will have the right size. */
512 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
513 set_frame_menubar (f
, true, true);
516 /* Get rid of the menu bar of frame F, and free its storage.
517 This is used when deleting a frame, and when turning off the menu bar. */
520 free_frame_menubar (struct frame
*f
)
525 HMENU old
= GetMenu (FRAME_W32_WINDOW (f
));
526 SetMenu (FRAME_W32_WINDOW (f
), NULL
);
527 f
->output_data
.w32
->menubar_widget
= NULL
;
535 /* w32_menu_show actually displays a menu using the panes and items in
536 menu_items and returns the value selected from it; we assume input
537 is blocked by the caller. */
539 /* F is the frame the menu is for.
540 X and Y are the frame-relative specified position,
541 relative to the inside upper left corner of the frame F.
542 Bitfield MENUFLAGS bits are:
543 MENU_FOR_CLICK is set if this menu was invoked for a mouse click.
544 MENU_KEYMAPS is set if this menu was specified with keymaps;
545 in that case, we return a list containing the chosen item's value
546 and perhaps also the pane's prefix.
547 TITLE is the specified menu title.
548 ERROR is a place to store an error message string in case of failure.
549 (We return nil on failure, but the value doesn't actually matter.) */
552 w32_menu_show (struct frame
*f
, int x
, int y
, int menuflags
,
553 Lisp_Object title
, const char **error
)
556 int menu_item_selection
;
559 widget_value
*wv
, *save_wv
= 0, *first_wv
= 0, *prev_wv
= 0;
560 widget_value
**submenu_stack
561 = (widget_value
**) alloca (menu_items_used
* sizeof (widget_value
*));
562 Lisp_Object
*subprefix_stack
563 = (Lisp_Object
*) alloca (menu_items_used
* word_size
);
564 int submenu_depth
= 0;
569 if (menu_items_n_panes
== 0)
572 if (menu_items_used
<= MENU_ITEMS_PANE_LENGTH
)
574 *error
= "Empty menu";
580 /* Create a tree of widget_value objects
581 representing the panes and their items. */
582 wv
= make_widget_value ("menu", NULL
, true, Qnil
);
583 wv
->button_type
= BUTTON_TYPE_NONE
;
587 /* Loop over all panes and items, filling in the tree. */
589 while (i
< menu_items_used
)
591 if (EQ (AREF (menu_items
, i
), Qnil
))
593 submenu_stack
[submenu_depth
++] = save_wv
;
599 else if (EQ (AREF (menu_items
, i
), Qlambda
))
602 save_wv
= submenu_stack
[--submenu_depth
];
606 else if (EQ (AREF (menu_items
, i
), Qt
)
607 && submenu_depth
!= 0)
608 i
+= MENU_ITEMS_PANE_LENGTH
;
609 /* Ignore a nil in the item list.
610 It's meaningful only for dialog boxes. */
611 else if (EQ (AREF (menu_items
, i
), Qquote
))
613 else if (EQ (AREF (menu_items
, i
), Qt
))
615 /* Create a new pane. */
616 Lisp_Object pane_name
, prefix
;
617 const char *pane_string
;
618 pane_name
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_NAME
);
619 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
621 if (STRINGP (pane_name
))
623 if (unicode_append_menu
)
624 pane_name
= ENCODE_UTF_8 (pane_name
);
625 else if (STRING_MULTIBYTE (pane_name
))
626 pane_name
= ENCODE_SYSTEM (pane_name
);
628 ASET (menu_items
, i
+ MENU_ITEMS_PANE_NAME
, pane_name
);
631 pane_string
= (NILP (pane_name
)
632 ? "" : SSDATA (pane_name
));
633 /* If there is just one top-level pane, put all its items directly
634 under the top-level menu. */
635 if (menu_items_n_panes
== 1)
638 /* If the pane has a meaningful name,
639 make the pane a top-level menu item
640 with its items as a submenu beneath it. */
641 if (!(menuflags
& MENU_KEYMAPS
) && strcmp (pane_string
, ""))
643 wv
= make_widget_value (pane_string
, NULL
, true, Qnil
);
647 first_wv
->contents
= wv
;
648 if ((menuflags
& MENU_KEYMAPS
) && !NILP (prefix
))
650 wv
->button_type
= BUTTON_TYPE_NONE
;
660 i
+= MENU_ITEMS_PANE_LENGTH
;
664 /* Create a new item within current pane. */
665 Lisp_Object item_name
, enable
, descrip
, def
, type
, selected
, help
;
667 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
668 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
669 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
670 def
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_DEFINITION
);
671 type
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_TYPE
);
672 selected
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_SELECTED
);
673 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
675 if (STRINGP (item_name
))
677 if (unicode_append_menu
)
678 item_name
= ENCODE_UTF_8 (item_name
);
679 else if (STRING_MULTIBYTE (item_name
))
680 item_name
= ENCODE_SYSTEM (item_name
);
682 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
, item_name
);
685 if (STRINGP (descrip
) && STRING_MULTIBYTE (descrip
))
687 descrip
= ENCODE_SYSTEM (descrip
);
688 ASET (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
, descrip
);
691 wv
= make_widget_value (SSDATA (item_name
), NULL
, !NILP (enable
),
692 STRINGP (help
) ? help
: Qnil
);
696 save_wv
->contents
= wv
;
698 wv
->key
= SSDATA (descrip
);
699 /* Use the contents index as call_data, since we are
700 restricted to 16-bits. */
701 wv
->call_data
= !NILP (def
) ? (void *) (UINT_PTR
) i
: 0;
704 wv
->button_type
= BUTTON_TYPE_NONE
;
705 else if (EQ (type
, QCtoggle
))
706 wv
->button_type
= BUTTON_TYPE_TOGGLE
;
707 else if (EQ (type
, QCradio
))
708 wv
->button_type
= BUTTON_TYPE_RADIO
;
712 wv
->selected
= !NILP (selected
);
716 i
+= MENU_ITEMS_ITEM_LENGTH
;
720 /* Deal with the title, if it is non-nil. */
723 widget_value
*wv_title
;
724 widget_value
*wv_sep
= make_widget_value ("--", NULL
, false, Qnil
);
726 /* Maybe replace this separator with a bitmap or owner-draw item
727 so that it looks better. Having two separators looks odd. */
728 wv_sep
->next
= first_wv
->contents
;
730 if (unicode_append_menu
)
731 title
= ENCODE_UTF_8 (title
);
732 else if (STRING_MULTIBYTE (title
))
733 title
= ENCODE_SYSTEM (title
);
735 wv_title
= make_widget_value (SSDATA (title
), NULL
, true, Qnil
);
736 wv_title
->title
= TRUE
;
737 wv_title
->button_type
= BUTTON_TYPE_NONE
;
738 wv_title
->next
= wv_sep
;
739 first_wv
->contents
= wv_title
;
742 /* No selection has been chosen yet. */
743 menu_item_selection
= 0;
745 /* Actually create the menu. */
746 current_popup_menu
= menu
= CreatePopupMenu ();
747 fill_in_menu (menu
, first_wv
->contents
);
749 /* Adjust coordinates to be root-window-relative. */
752 ClientToScreen (FRAME_W32_WINDOW (f
), &pos
);
754 /* Display the menu. */
755 menu_item_selection
= SendMessage (FRAME_W32_WINDOW (f
),
756 WM_EMACS_TRACKPOPUPMENU
,
757 (WPARAM
)menu
, (LPARAM
)&pos
);
759 /* Clean up extraneous mouse events which might have been generated
761 discard_mouse_events ();
762 FRAME_DISPLAY_INFO (f
)->grabbed
= 0;
764 /* Free the widget_value objects we used to specify the contents. */
765 free_menubar_widget_value_tree (first_wv
);
769 /* Free the owner-drawn and help-echo menu strings. */
770 w32_free_menu_strings (FRAME_W32_WINDOW (f
));
771 f
->output_data
.w32
->menubar_active
= 0;
773 /* Find the selected item, and its pane, to return
775 if (menu_item_selection
!= 0)
777 Lisp_Object prefix
, entry
;
779 prefix
= entry
= Qnil
;
781 while (i
< menu_items_used
)
783 if (EQ (AREF (menu_items
, i
), Qnil
))
785 subprefix_stack
[submenu_depth
++] = prefix
;
789 else if (EQ (AREF (menu_items
, i
), Qlambda
))
791 prefix
= subprefix_stack
[--submenu_depth
];
794 else if (EQ (AREF (menu_items
, i
), Qt
))
796 prefix
= AREF (menu_items
, i
+ MENU_ITEMS_PANE_PREFIX
);
797 i
+= MENU_ITEMS_PANE_LENGTH
;
799 /* Ignore a nil in the item list.
800 It's meaningful only for dialog boxes. */
801 else if (EQ (AREF (menu_items
, i
), Qquote
))
805 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
806 if (menu_item_selection
== i
)
808 if (menuflags
& MENU_KEYMAPS
)
812 entry
= Fcons (entry
, Qnil
);
814 entry
= Fcons (prefix
, entry
);
815 for (j
= submenu_depth
- 1; j
>= 0; j
--)
816 if (!NILP (subprefix_stack
[j
]))
817 entry
= Fcons (subprefix_stack
[j
], entry
);
822 i
+= MENU_ITEMS_ITEM_LENGTH
;
826 else if (!(menuflags
& MENU_FOR_CLICK
))
829 /* Make "Cancel" equivalent to C-g. */
839 /* TODO: On Windows, there are two ways of defining a dialog.
841 1. Create a predefined dialog resource and include it in nt/emacs.rc.
842 Using this method, we could then set the titles and make unneeded
843 buttons invisible before displaying the dialog. Everything would
844 be a fixed size though, so there is a risk that text does not
846 2. Create the dialog template in memory on the fly. This allows us
847 to size the dialog and buttons dynamically, probably giving more
848 natural looking results for dialogs with few buttons, and eliminating
849 the problem of text overflowing the buttons. But the API for this is
850 quite complex - structures have to be allocated in particular ways,
851 text content is tacked onto the end of structures in variable length
852 arrays with further structures tacked on after these, there are
853 certain alignment requirements for all this, and we have to
854 measure all the text and convert to "dialog coordinates" to figure
855 out how big to make everything.
857 For now, we'll just stick with menus for dialogs that are more
858 complicated than simple yes/no type questions for which we can use
859 the MessageBox function.
862 static char * button_names
[] = {
863 "button1", "button2", "button3", "button4", "button5",
864 "button6", "button7", "button8", "button9", "button10" };
867 w32_dialog_show (struct frame
*f
, Lisp_Object title
,
868 Lisp_Object header
, char **error
)
870 int i
, nb_buttons
= 0;
872 int menu_item_selection
;
874 widget_value
*wv
, *first_wv
= 0, *prev_wv
= 0;
876 /* Number of elements seen so far, before boundary. */
878 /* true means we've seen the boundary between left-hand elts and
880 bool boundary_seen
= false;
884 if (menu_items_n_panes
> 1)
886 *error
= "Multiple panes in dialog box";
890 /* Create a tree of widget_value objects
891 representing the text label and buttons. */
893 Lisp_Object pane_name
;
895 pane_name
= AREF (menu_items
, MENU_ITEMS_PANE_NAME
);
896 pane_string
= (NILP (pane_name
)
897 ? "" : SSDATA (pane_name
));
898 prev_wv
= make_widget_value ("message", pane_string
, true, Qnil
);
901 /* Loop over all panes and items, filling in the tree. */
902 i
= MENU_ITEMS_PANE_LENGTH
;
903 while (i
< menu_items_used
)
906 /* Create a new item within current pane. */
907 Lisp_Object item_name
, enable
, descrip
, help
;
909 item_name
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_NAME
);
910 enable
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_ENABLE
);
911 descrip
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_EQUIV_KEY
);
912 help
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_HELP
);
914 if (NILP (item_name
))
916 free_menubar_widget_value_tree (first_wv
);
917 *error
= "Submenu in dialog items";
920 if (EQ (item_name
, Qquote
))
922 /* This is the boundary between left-side elts
923 and right-side elts. Stop incrementing right_count. */
924 boundary_seen
= true;
930 free_menubar_widget_value_tree (first_wv
);
931 *error
= "Too many dialog items";
935 wv
= make_widget_value (button_names
[nb_buttons
],
937 !NILP (enable
), Qnil
);
940 wv
->key
= SSDATA (descrip
);
941 wv
->call_data
= aref_addr (menu_items
, i
);
948 i
+= MENU_ITEMS_ITEM_LENGTH
;
951 /* If the boundary was not specified,
952 by default put half on the left and half on the right. */
954 left_count
= nb_buttons
- nb_buttons
/ 2;
956 wv
= make_widget_value (dialog_name
, NULL
, false, Qnil
);
958 /* Frame title: 'Q' = Question, 'I' = Information.
959 Can also have 'E' = Error if, one day, we want
960 a popup for errors. */
962 dialog_name
[0] = 'Q';
964 dialog_name
[0] = 'I';
966 /* Dialog boxes use a really stupid name encoding
967 which specifies how many buttons to use
968 and how many buttons are on the right. */
969 dialog_name
[1] = '0' + nb_buttons
;
970 dialog_name
[2] = 'B';
971 dialog_name
[3] = 'R';
972 /* Number of buttons to put on the right. */
973 dialog_name
[4] = '0' + nb_buttons
- left_count
;
975 wv
->contents
= first_wv
;
979 /* Actually create the dialog. */
980 dialog_id
= widget_id_tick
++;
981 menu
= lw_create_widget (first_wv
->name
, "dialog", dialog_id
, first_wv
,
982 f
->output_data
.w32
->widget
, true, 0,
983 dialog_selection_callback
, 0);
984 lw_modify_all_widgets (dialog_id
, first_wv
->contents
, TRUE
);
986 /* Free the widget_value objects we used to specify the contents. */
987 free_menubar_widget_value_tree (first_wv
);
989 /* No selection has been chosen yet. */
990 menu_item_selection
= 0;
992 /* Display the menu. */
993 lw_pop_up_all_widgets (dialog_id
);
995 /* Process events that apply to the menu. */
996 popup_get_selection ((XEvent
*) 0, FRAME_DISPLAY_INFO (f
), dialog_id
);
998 lw_destroy_all_widgets (dialog_id
);
1000 /* Find the selected item, and its pane, to return
1001 the proper value. */
1002 if (menu_item_selection
!= 0)
1005 while (i
< menu_items_used
)
1009 if (EQ (AREF (menu_items
, i
), Qt
))
1010 i
+= MENU_ITEMS_PANE_LENGTH
;
1013 entry
= AREF (menu_items
, i
+ MENU_ITEMS_ITEM_VALUE
);
1014 if (menu_item_selection
== i
)
1016 i
+= MENU_ITEMS_ITEM_LENGTH
;
1021 /* Make "Cancel" equivalent to C-g. */
1026 #else /* !HAVE_DIALOGS */
1028 /* Currently we only handle Yes No dialogs (y-or-n-p and yes-or-no-p) as
1029 simple dialogs. We could handle a few more, but I'm not aware of
1030 anywhere in Emacs that uses the other specific dialog choices that
1031 MessageBox provides. */
1034 is_simple_dialog (Lisp_Object contents
)
1036 Lisp_Object options
;
1037 Lisp_Object name
, yes
, no
, other
;
1039 if (!CONSP (contents
))
1041 options
= XCDR (contents
);
1043 yes
= build_string ("Yes");
1044 no
= build_string ("No");
1046 if (!CONSP (options
))
1049 name
= XCAR (options
);
1054 if (!NILP (Fstring_equal (name
, yes
)))
1056 else if (!NILP (Fstring_equal (name
, no
)))
1061 options
= XCDR (options
);
1062 if (!CONSP (options
))
1065 name
= XCAR (options
);
1069 if (NILP (Fstring_equal (name
, other
)))
1072 /* Check there are no more options. */
1073 options
= XCDR (options
);
1074 return !(CONSP (options
));
1078 simple_dialog_show (struct frame
*f
, Lisp_Object contents
, Lisp_Object header
)
1082 Lisp_Object lispy_answer
= Qnil
, temp
= XCAR (contents
);
1086 /* Since we only handle Yes/No dialogs, and we already checked
1087 is_simple_dialog, we don't need to worry about checking contents
1088 to see what type of dialog to use. */
1090 /* Use Unicode if possible, so any language can be displayed. */
1091 if (unicode_message_box
)
1099 char *utf8_text
= SSDATA (ENCODE_UTF_8 (temp
));
1100 /* Be pessimistic about the number of characters needed.
1101 Remember characters outside the BMP will take more than
1102 one utf16 word, so we cannot simply use the character
1104 int utf8_len
= strlen (utf8_text
);
1105 text
= SAFE_ALLOCA ((utf8_len
+ 1) * sizeof (WCHAR
));
1106 utf8to16 ((unsigned char *)utf8_text
, utf8_len
, text
);
1110 text
= (WCHAR
*)L
"";
1115 title
= L
"Question";
1116 type
|= MB_ICONQUESTION
;
1120 title
= L
"Information";
1121 type
|= MB_ICONINFORMATION
;
1124 answer
= unicode_message_box (FRAME_W32_WINDOW (f
), text
, title
, type
);
1129 const char *text
, *title
;
1131 /* Fall back on ANSI message box, but at least use system
1132 encoding so questions representable by the system codepage
1133 are encoded properly. */
1135 text
= SSDATA (ENCODE_SYSTEM (temp
));
1142 type
|= MB_ICONQUESTION
;
1146 title
= "Information";
1147 type
|= MB_ICONINFORMATION
;
1150 answer
= MessageBox (FRAME_W32_WINDOW (f
), text
, title
, type
);
1153 if (answer
== IDYES
)
1154 lispy_answer
= build_string ("Yes");
1155 else if (answer
== IDNO
)
1156 lispy_answer
= build_string ("No");
1160 for (temp
= XCDR (contents
); CONSP (temp
); temp
= XCDR (temp
))
1162 Lisp_Object item
, name
, value
;
1167 value
= XCDR (item
);
1175 if (!NILP (Fstring_equal (name
, lispy_answer
)))
1182 #endif /* !HAVE_DIALOGS */
1185 /* UTF8: 0xxxxxxx, 110xxxxx 10xxxxxx, 1110xxxx, 10xxxxxx, 10xxxxxx */
1187 utf8to16 (unsigned char * src
, int len
, WCHAR
* dest
)
1193 *dest
= (WCHAR
) *src
;
1194 dest
++; src
++; len
--;
1196 /* Since we might get >3 byte sequences which we don't handle, ignore the extra parts. */
1197 else if (*src
< 0xC0)
1201 /* 2 char UTF-8 sequence. */
1202 else if (*src
< 0xE0)
1204 *dest
= (WCHAR
) (((*src
& 0x1f) << 6)
1205 | (*(src
+ 1) & 0x3f));
1206 src
+= 2; len
-= 2; dest
++;
1208 else if (*src
< 0xF0)
1210 *dest
= (WCHAR
) (((*src
& 0x0f) << 12)
1211 | ((*(src
+ 1) & 0x3f) << 6)
1212 | (*(src
+ 2) & 0x3f));
1213 src
+= 3; len
-= 3; dest
++;
1215 else /* Not encodable. Insert Unicode Substitution char. */
1217 *dest
= (WCHAR
) 0xfffd;
1218 src
++; len
--; dest
++;
1225 add_menu_item (HMENU menu
, widget_value
*wv
, HMENU item
)
1228 char *out_string
, *p
, *q
;
1230 size_t nlen
, orig_len
;
1233 if (menu_separator_name_p (wv
->name
))
1235 fuFlags
= MF_SEPARATOR
;
1241 fuFlags
= MF_STRING
;
1243 fuFlags
= MF_STRING
| MF_GRAYED
;
1245 if (wv
->key
!= NULL
)
1247 out_string
= SAFE_ALLOCA (strlen (wv
->name
) + strlen (wv
->key
) + 2);
1248 p
= stpcpy (out_string
, wv
->name
);
1249 p
= stpcpy (p
, "\t");
1250 strcpy (p
, wv
->key
);
1253 out_string
= (char *)wv
->name
;
1255 /* Quote any special characters within the menu item's text and
1257 nlen
= orig_len
= strlen (out_string
);
1258 if (unicode_append_menu
)
1260 /* With UTF-8, & cannot be part of a multibyte character. */
1261 for (p
= out_string
; *p
; p
++)
1267 #ifndef NTGUI_UNICODE
1270 /* If encoded with the system codepage, use multibyte string
1271 functions in case of multibyte characters that contain '&'. */
1272 for (p
= out_string
; *p
; p
= _mbsinc (p
))
1274 if (_mbsnextc (p
) == '&')
1278 #endif /* !NTGUI_UNICODE */
1280 if (nlen
> orig_len
)
1283 out_string
= SAFE_ALLOCA (nlen
+ 1);
1287 if (unicode_append_menu
)
1293 #ifndef NTGUI_UNICODE
1296 if (_mbsnextc (p
) == '&')
1305 #endif /* !NTGUI_UNICODE */
1312 else if (wv
->title
|| wv
->call_data
== 0)
1314 /* Only use MF_OWNERDRAW if GetMenuItemInfo is usable, since
1315 we can't deallocate the memory otherwise. */
1316 if (get_menu_item_info
)
1318 out_string
= (char *) local_alloc (strlen (wv
->name
) + 1);
1319 strcpy (out_string
, wv
->name
);
1321 DebPrint ("Menu: allocating %ld for owner-draw", out_string
);
1323 fuFlags
= MF_OWNERDRAW
| MF_DISABLED
;
1326 fuFlags
= MF_DISABLED
;
1329 /* Draw radio buttons and tickboxes. */
1330 else if (wv
->selected
&& (wv
->button_type
== BUTTON_TYPE_TOGGLE
||
1331 wv
->button_type
== BUTTON_TYPE_RADIO
))
1332 fuFlags
|= MF_CHECKED
;
1334 fuFlags
|= MF_UNCHECKED
;
1337 if (unicode_append_menu
&& out_string
)
1339 /* Convert out_string from UTF-8 to UTF-16-LE. */
1340 int utf8_len
= strlen (out_string
);
1341 WCHAR
* utf16_string
;
1342 if (fuFlags
& MF_OWNERDRAW
)
1343 utf16_string
= local_alloc ((utf8_len
+ 1) * sizeof (WCHAR
));
1345 utf16_string
= SAFE_ALLOCA ((utf8_len
+ 1) * sizeof (WCHAR
));
1347 utf8to16 ((unsigned char *)out_string
, utf8_len
, utf16_string
);
1348 return_value
= unicode_append_menu (menu
, fuFlags
,
1349 item
!= NULL
? (UINT_PTR
) item
1350 : (UINT_PTR
) wv
->call_data
,
1353 #ifndef NTGUI_UNICODE /* Fallback does not apply when always UNICODE */
1356 /* On W9x/ME, Unicode menus are not supported, though AppendMenuW
1357 apparently does exist at least in some cases and appears to be
1358 stubbed out to do nothing. out_string is UTF-8, but since
1359 our standard menus are in English and this is only going to
1360 happen the first time a menu is used, the encoding is
1361 of minor importance compared with menus not working at all. */
1363 AppendMenu (menu
, fuFlags
,
1364 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1366 /* Don't use Unicode menus in future, unless this is Windows
1367 NT or later, where a failure of AppendMenuW does NOT mean
1368 Unicode menus are unsupported. */
1369 if (osinfo_cache
.dwPlatformId
!= VER_PLATFORM_WIN32_NT
)
1370 unicode_append_menu
= NULL
;
1372 #endif /* NTGUI_UNICODE */
1374 if (unicode_append_menu
&& (fuFlags
& MF_OWNERDRAW
))
1375 local_free (out_string
);
1382 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1386 /* This must be done after the menu item is created. */
1387 if (!wv
->title
&& wv
->call_data
!= 0)
1389 if (set_menu_item_info
)
1392 memset (&info
, 0, sizeof (info
));
1393 info
.cbSize
= sizeof (info
);
1394 info
.fMask
= MIIM_DATA
;
1396 /* Set help string for menu item. Leave it as a pointer to
1397 a Lisp_String until it is ready to be displayed, since GC
1398 can happen while menus are active. */
1399 if (!NILP (wv
->help
))
1401 /* We use XUNTAG below because in a 32-bit build
1402 --with-wide-int we cannot pass a Lisp_Object
1403 via a DWORD member of MENUITEMINFO. */
1404 /* As of Jul-2012, w32api headers say that dwItemData
1405 has DWORD type, but that's a bug: it should actually
1406 be ULONG_PTR, which is correct for 32-bit and 64-bit
1407 Windows alike. MSVC headers get it right; hopefully,
1408 MinGW headers will, too. */
1409 eassert (STRINGP (wv
->help
));
1410 info
.dwItemData
= (ULONG_PTR
) XUNTAG (wv
->help
, Lisp_String
);
1412 if (wv
->button_type
== BUTTON_TYPE_RADIO
)
1414 /* CheckMenuRadioItem allows us to differentiate TOGGLE and
1415 RADIO items, but is not available on NT 3.51 and earlier. */
1416 info
.fMask
|= MIIM_TYPE
| MIIM_STATE
;
1417 info
.fType
= MFT_RADIOCHECK
| MFT_STRING
;
1418 info
.dwTypeData
= out_string
;
1419 info
.fState
= wv
->selected
? MFS_CHECKED
: MFS_UNCHECKED
;
1422 set_menu_item_info (menu
,
1423 item
!= NULL
? (UINT_PTR
) item
: (UINT_PTR
) wv
->call_data
,
1428 return return_value
;
1431 /* Construct native Windows menu(bar) based on widget_value tree. */
1433 fill_in_menu (HMENU menu
, widget_value
*wv
)
1435 for ( ; wv
!= NULL
; wv
= wv
->next
)
1439 HMENU sub_menu
= CreatePopupMenu ();
1441 if (sub_menu
== NULL
)
1444 if (!fill_in_menu (sub_menu
, wv
->contents
) ||
1445 !add_menu_item (menu
, wv
, sub_menu
))
1447 DestroyMenu (sub_menu
);
1453 if (!add_menu_item (menu
, wv
, NULL
))
1460 /* Display help string for currently pointed to menu item. Not
1461 supported on NT 3.51 and earlier, as GetMenuItemInfo is not
1463 void w32_menu_display_help (HWND
, HMENU
, UINT
, UINT
);
1466 w32_menu_display_help (HWND owner
, HMENU menu
, UINT item
, UINT flags
)
1468 if (get_menu_item_info
)
1470 struct frame
*f
= x_window_to_frame (&one_w32_display_info
, owner
);
1471 Lisp_Object frame
, help
;
1473 /* No help echo on owner-draw menu items, or when the keyboard
1474 is used to navigate the menus, since tooltips are distracting
1475 if they pop up elsewhere. */
1476 if ((flags
& MF_OWNERDRAW
) || (flags
& MF_POPUP
)
1477 || !(flags
& MF_MOUSESELECT
)
1478 /* Ignore any dwItemData for menu items whose flags don't
1479 have the MF_HILITE bit set. These are dwItemData that
1480 Windows sends our way, but they aren't pointers to our
1481 Lisp_String objects, so trying to create Lisp_Strings out
1482 of them below and pass that to the keyboard queue will
1483 crash Emacs when we try to display those "strings". It
1484 is unclear why we get these dwItemData, or what they are:
1485 sometimes they point to a wchar_t string that is the menu
1486 title, sometimes to someting that doesn't look like text
1487 at all. (The problematic data also comes with the 0x0800
1488 bit set, but this bit is not documented, so we don't want
1489 to depend on it.) */
1490 || !(flags
& MF_HILITE
))
1496 memset (&info
, 0, sizeof (info
));
1497 info
.cbSize
= sizeof (info
);
1498 info
.fMask
= MIIM_DATA
;
1499 get_menu_item_info (menu
, item
, FALSE
, &info
);
1503 ? make_lisp_ptr ((void *) info
.dwItemData
, Lisp_String
)
1507 /* Store the help echo in the keyboard buffer as the X toolkit
1508 version does, rather than directly showing it. This seems to
1509 solve the GC problems that were present when we based the
1510 Windows code on the non-toolkit version. */
1513 XSETFRAME (frame
, f
);
1514 kbd_buffer_store_help_event (frame
, help
);
1517 /* X version has a loop through frames here, which doesn't
1518 appear to do anything, unless it has some side effect. */
1519 show_help_echo (help
, Qnil
, Qnil
, Qnil
);
1523 /* Free memory used by owner-drawn strings. */
1525 w32_free_submenu_strings (HMENU menu
)
1527 int i
, num
= GetMenuItemCount (menu
);
1528 for (i
= 0; i
< num
; i
++)
1531 memset (&info
, 0, sizeof (info
));
1532 info
.cbSize
= sizeof (info
);
1533 info
.fMask
= MIIM_DATA
| MIIM_TYPE
| MIIM_SUBMENU
;
1535 get_menu_item_info (menu
, i
, TRUE
, &info
);
1537 /* Owner-drawn names are held in dwItemData. */
1538 if ((info
.fType
& MF_OWNERDRAW
) && info
.dwItemData
)
1541 DebPrint ("Menu: freeing %ld for owner-draw", info
.dwItemData
);
1543 local_free (info
.dwItemData
);
1546 /* Recurse down submenus. */
1548 w32_free_submenu_strings (info
.hSubMenu
);
1553 w32_free_menu_strings (HWND hwnd
)
1555 HMENU menu
= current_popup_menu
;
1557 if (get_menu_item_info
)
1559 /* If there is no popup menu active, free the strings from the frame's
1562 menu
= GetMenu (hwnd
);
1565 w32_free_submenu_strings (menu
);
1568 current_popup_menu
= NULL
;
1571 /* The following is used by delayed window autoselection. */
1573 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p
, Smenu_or_popup_active_p
, 0, 0, 0,
1574 doc
: /* Return t if a menu or popup dialog is active on selected frame. */)
1578 f
= SELECTED_FRAME ();
1579 return (f
->output_data
.w32
->menubar_active
> 0) ? Qt
: Qnil
;
1583 syms_of_w32menu (void)
1585 globals_of_w32menu ();
1587 current_popup_menu
= NULL
;
1589 DEFSYM (Qdebug_on_next_call
, "debug-on-next-call");
1590 DEFSYM (Qunsupported__w32_dialog
, "unsupported--w32-dialog");
1592 defsubr (&Smenu_or_popup_active_p
);
1596 globals_of_w32menu is used to initialize those global variables that
1597 must always be initialized on startup even when the global variable
1598 initialized is non zero (see the function main in emacs.c).
1599 globals_of_w32menu is called from syms_of_w32menu when the global
1600 variable initialized is 0 and directly from main when initialized
1604 globals_of_w32menu (void)
1606 #ifndef NTGUI_UNICODE
1607 /* See if Get/SetMenuItemInfo functions are available. */
1608 HMODULE user32
= GetModuleHandle ("user32.dll");
1609 get_menu_item_info
= (GetMenuItemInfoA_Proc
) GetProcAddress (user32
, "GetMenuItemInfoA");
1610 set_menu_item_info
= (SetMenuItemInfoA_Proc
) GetProcAddress (user32
, "SetMenuItemInfoA");
1611 unicode_append_menu
= (AppendMenuW_Proc
) GetProcAddress (user32
, "AppendMenuW");
1612 unicode_message_box
= (MessageBoxW_Proc
) GetProcAddress (user32
, "MessageBoxW");
1613 #endif /* !NTGUI_UNICODE */