use dynwind_begin and dynwind_end
[bpt/emacs.git] / src / w32menu.c
CommitLineData
b46a6a83 1/* Menu support for GNU Emacs on the Microsoft Windows API.
ba318903 2 Copyright (C) 1986, 1988, 1993-1994, 1996, 1998-1999, 2001-2014 Free
ab422c4d 3 Software Foundation, Inc.
ee78dc32
GV
4
5This file is part of GNU Emacs.
6
9ec0b715 7GNU Emacs is free software: you can redistribute it and/or modify
ee78dc32 8it under the terms of the GNU General Public License as published by
9ec0b715
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
ee78dc32
GV
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9ec0b715 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
ee78dc32 19
ee78dc32 20#include <config.h>
162d2499 21
7ab7006c 22#include <signal.h>
ee78dc32 23#include <stdio.h>
d7306fe6 24#include <setjmp.h>
7ab7006c 25
ee78dc32 26#include "lisp.h"
15d36dee 27#include "keyboard.h"
5ee707b8 28#include "keymap.h"
ee78dc32 29#include "frame.h"
7ab7006c 30#include "termhooks.h"
ee78dc32 31#include "window.h"
ee78dc32 32#include "blockinput.h"
e5560ff7 33#include "character.h"
fdc12c4d 34#include "buffer.h"
6915ded0
JR
35#include "charset.h"
36#include "coding.h"
ef7417fd 37#include "menu.h"
ee78dc32
GV
38
39/* This may include sys/types.h, and that somehow loses
40 if this is not done before the other system files. */
41#include "w32term.h"
42
0fda9b75
DC
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. */
46
47#ifndef NTGUI_UNICODE
48#include <mbstring.h>
49#endif /* !NTGUI_UNICODE */
50
ee78dc32
GV
51/* Load sys/types.h if not already loaded.
52 In some systems loading it twice is suicidal. */
53#ifndef makedev
54#include <sys/types.h>
55#endif
56
57#include "dispextern.h"
58
501199a3 59#include "w32common.h" /* for osinfo_cache */
1c6900d9 60
222456a1 61#undef HAVE_DIALOGS /* TODO: Implement native dialogs. */
162d2499 62
485015ca
GV
63#ifndef TRUE
64#define TRUE 1
65#define FALSE 0
66#endif /* no TRUE */
67
b2a916a0 68HMENU current_popup_menu;
ace9b298 69
b56ceb92
JB
70void syms_of_w32menu (void);
71void globals_of_w32menu (void);
f60ae425
BK
72
73typedef BOOL (WINAPI * GetMenuItemInfoA_Proc) (
74 IN HMENU,
75 IN UINT,
76 IN BOOL,
1f06d367 77 IN OUT LPMENUITEMINFOA);
f60ae425
BK
78typedef BOOL (WINAPI * SetMenuItemInfoA_Proc) (
79 IN HMENU,
80 IN UINT,
81 IN BOOL,
1f06d367 82 IN LPCMENUITEMINFOA);
1c9b4129
JR
83typedef int (WINAPI * MessageBoxW_Proc) (
84 IN HWND window,
af025ae8
EZ
85 IN const WCHAR *text,
86 IN const WCHAR *caption,
1c9b4129 87 IN UINT type);
f60ae425 88
0fda9b75
DC
89#ifdef NTGUI_UNICODE
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 */
1f06d367
JR
95GetMenuItemInfoA_Proc get_menu_item_info = NULL;
96SetMenuItemInfoA_Proc set_menu_item_info = NULL;
97AppendMenuW_Proc unicode_append_menu = NULL;
1c9b4129 98MessageBoxW_Proc unicode_message_box = NULL;
0fda9b75 99#endif /* NTGUI_UNICODE */
ace9b298 100
e139a33c 101Lisp_Object Qdebug_on_next_call, Qunsupported__w32_dialog;
fdc12c4d 102
a10c8269 103void set_frame_menubar (struct frame *, bool, bool);
014510b0 104
1c5acb8c 105#ifdef HAVE_DIALOGS
f1b44793 106static Lisp_Object w32_dialog_show (struct frame *, Lisp_Object, Lisp_Object, char **);
31403b24 107#else
f57e2426 108static int is_simple_dialog (Lisp_Object);
a10c8269 109static Lisp_Object simple_dialog_show (struct frame *, Lisp_Object, Lisp_Object);
1c5acb8c 110#endif
31403b24 111
1c9b4129 112static void utf8to16 (unsigned char *, int, WCHAR *);
24f981c9 113static int fill_in_menu (HMENU, widget_value *);
1c9b4129 114
f57e2426 115void w32_free_menu_strings (HWND);
0fda9b75 116
0afa0aab
EZ
117Lisp_Object
118w32_popup_dialog (struct frame *f, Lisp_Object header, Lisp_Object contents)
ee78dc32 119{
485015ca 120
7452b7bd
DA
121 check_window_system (f);
122
e139a33c 123#ifndef HAVE_DIALOGS
ee78dc32 124
e139a33c
EZ
125 /* Handle simple Yes/No choices as MessageBox popups. */
126 if (is_simple_dialog (contents))
127 return simple_dialog_show (f, contents, header);
128 else
129 return Qunsupported__w32_dialog;
130#else /* HAVE_DIALOGS */
131 {
132 Lisp_Object title;
133 char *error_name;
134 Lisp_Object selection;
ee78dc32 135
e139a33c
EZ
136 /* Decode the dialog items from what was specified. */
137 title = Fcar (contents);
138 CHECK_STRING (title);
ee78dc32 139
e139a33c 140 list_of_panes (Fcons (contents, Qnil));
ee78dc32 141
e139a33c
EZ
142 /* Display them in a dialog box. */
143 block_input ();
f1b44793 144 selection = w32_dialog_show (f, title, header, &error_name);
e139a33c
EZ
145 unblock_input ();
146
147 discard_menu_items ();
148 FRAME_DISPLAY_INFO (f)->grabbed = 0;
149
150 if (error_name) error (error_name);
151 return selection;
152 }
0afa0aab 153#endif /* HAVE_DIALOGS */
e139a33c 154}
ee78dc32 155
014510b0
GV
156/* Activate the menu bar of frame F.
157 This is called from keyboard.c when it gets the
3b8f9651 158 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
014510b0
GV
159
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.
163
164 But first we recompute the menu bar contents (the whole tree).
165
166 This way we can safely execute Lisp code. */
177c0ea7 167
162d2499 168void
a10c8269 169x_activate_menubar (struct frame *f)
014510b0
GV
170{
171 set_frame_menubar (f, 0, 1);
172
173 /* Lock out further menubar changes while active. */
174 f->output_data.w32->menubar_active = 1;
175
176 /* Signal input thread to return from WM_INITMENU. */
177 complete_deferred_msg (FRAME_W32_WINDOW (f), WM_INITMENU, 0);
178}
179
485015ca
GV
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. */
184
185void
a10c8269 186menubar_selection_callback (struct frame *f, void * client_data)
ee78dc32 187{
485015ca
GV
188 Lisp_Object prefix, entry;
189 Lisp_Object vector;
190 Lisp_Object *subprefix_stack;
191 int submenu_depth = 0;
ee78dc32 192 int i;
fdc12c4d 193
485015ca 194 if (!f)
014510b0 195 return;
fe5a0162 196 entry = Qnil;
663e2b3f 197 subprefix_stack = (Lisp_Object *) alloca (f->menu_bar_items_used * word_size);
e69b0960 198 vector = f->menu_bar_vector;
485015ca
GV
199 prefix = Qnil;
200 i = 0;
201 while (i < f->menu_bar_items_used)
202 {
6ed09cf0 203 if (EQ (AREF (vector, i), Qnil))
485015ca
GV
204 {
205 subprefix_stack[submenu_depth++] = prefix;
206 prefix = entry;
207 i++;
208 }
6ed09cf0 209 else if (EQ (AREF (vector, i), Qlambda))
485015ca
GV
210 {
211 prefix = subprefix_stack[--submenu_depth];
212 i++;
213 }
6ed09cf0 214 else if (EQ (AREF (vector, i), Qt))
485015ca 215 {
6ed09cf0 216 prefix = AREF (vector, i + MENU_ITEMS_PANE_PREFIX);
485015ca
GV
217 i += MENU_ITEMS_PANE_LENGTH;
218 }
219 else
220 {
6ed09cf0 221 entry = AREF (vector, i + MENU_ITEMS_ITEM_VALUE);
485015ca
GV
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)
225 {
226 int j;
227 struct input_event buf;
228 Lisp_Object frame;
f456401b 229 EVENT_INIT (buf);
014510b0 230
485015ca 231 XSETFRAME (frame, f);
20501278
GM
232 buf.kind = MENU_BAR_EVENT;
233 buf.frame_or_window = frame;
234 buf.arg = frame;
485015ca 235 kbd_buffer_store_event (&buf);
014510b0 236
485015ca
GV
237 for (j = 0; j < submenu_depth; j++)
238 if (!NILP (subprefix_stack[j]))
239 {
20501278
GM
240 buf.kind = MENU_BAR_EVENT;
241 buf.frame_or_window = frame;
242 buf.arg = subprefix_stack[j];
485015ca
GV
243 kbd_buffer_store_event (&buf);
244 }
fdc12c4d 245
485015ca
GV
246 if (!NILP (prefix))
247 {
20501278
GM
248 buf.kind = MENU_BAR_EVENT;
249 buf.frame_or_window = frame;
250 buf.arg = prefix;
485015ca
GV
251 kbd_buffer_store_event (&buf);
252 }
fdc12c4d 253
20501278
GM
254 buf.kind = MENU_BAR_EVENT;
255 buf.frame_or_window = frame;
256 buf.arg = entry;
71f6b295
JR
257 /* Free memory used by owner-drawn and help-echo strings. */
258 w32_free_menu_strings (FRAME_W32_WINDOW (f));
b2a916a0
JR
259 kbd_buffer_store_event (&buf);
260
71f6b295 261 f->output_data.w32->menubar_active = 0;
485015ca
GV
262 return;
263 }
264 i += MENU_ITEMS_ITEM_LENGTH;
265 }
014510b0 266 }
71f6b295
JR
267 /* Free memory used by owner-drawn and help-echo strings. */
268 w32_free_menu_strings (FRAME_W32_WINDOW (f));
71f6b295 269 f->output_data.w32->menubar_active = 0;
485015ca 270}
014510b0 271
ee78dc32 272\f
485015ca
GV
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. */
276
277void
a10c8269 278set_frame_menubar (struct frame *f, bool first_time, bool deep_p)
485015ca
GV
279{
280 HMENU menubar_widget = f->output_data.w32->menubar_widget;
162d2499 281 Lisp_Object items;
485015ca 282 widget_value *wv, *first_wv, *prev_wv = 0;
6ed09cf0
RS
283 int i, last_i;
284 int *submenu_start, *submenu_end;
fe04b8c8 285 int *submenu_top_level_items, *submenu_n_panes;
485015ca
GV
286
287 /* We must not change the menubar when actually in use. */
288 if (f->output_data.w32->menubar_active)
289 return;
290
291 XSETFRAME (Vmenu_updating_frame, f);
292
293 if (! menubar_widget)
294 deep_p = 1;
485015ca 295
485015ca
GV
296 if (deep_p)
297 {
298 /* Make a widget-value tree representing the entire menu trees. */
299
300 struct buffer *prev = current_buffer;
301 Lisp_Object buffer;
2bfa3d3e 302 dynwind_begin ();
485015ca
GV
303 int previous_menu_items_used = f->menu_bar_items_used;
304 Lisp_Object *previous_items
305 = (Lisp_Object *) alloca (previous_menu_items_used
663e2b3f 306 * word_size);
485015ca
GV
307
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;
312
e74aeda8 313 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->contents;
485015ca
GV
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);
318
89f2614d
KS
319 record_unwind_save_match_data ();
320
485015ca
GV
321 if (NILP (Voverriding_local_map_menu_flag))
322 {
323 specbind (Qoverriding_terminal_local_map, Qnil);
324 specbind (Qoverriding_local_map, Qnil);
325 }
326
327 set_buffer_internal_1 (XBUFFER (buffer));
328
cc477da7 329 /* Run the hooks. */
c53b6500 330 safe_run_hooks (Qactivate_menubar_hook);
485015ca 331 safe_run_hooks (Qmenu_bar_update_hook);
f00af5b1 332 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
485015ca
GV
333
334 items = FRAME_MENU_BAR_ITEMS (f);
335
485015ca 336 /* Save the frame's previous menu bar contents data. */
c30dce3d 337 if (previous_menu_items_used)
91f2d272 338 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
663e2b3f 339 previous_menu_items_used * word_size);
485015ca 340
6ed09cf0
RS
341 /* Fill in menu_items with the current menu bar contents.
342 This can evaluate Lisp code. */
df80fd9d
JR
343 save_menu_items ();
344
e69b0960 345 menu_items = f->menu_bar_vector;
c30dce3d 346 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
57679c86
AS
347 submenu_start = (int *) alloca (ASIZE (items) * sizeof (int));
348 submenu_end = (int *) alloca (ASIZE (items) * sizeof (int));
77b37c05 349 submenu_n_panes = (int *) alloca (ASIZE (items) * sizeof (int));
57679c86 350 submenu_top_level_items = (int *) alloca (ASIZE (items) * sizeof (int));
485015ca 351 init_menu_items ();
6ed09cf0 352 for (i = 0; i < ASIZE (items); i += 4)
485015ca
GV
353 {
354 Lisp_Object key, string, maps;
355
6ed09cf0
RS
356 last_i = i;
357
358 key = AREF (items, i);
359 string = AREF (items, i + 1);
360 maps = AREF (items, i + 2);
485015ca
GV
361 if (NILP (string))
362 break;
363
6ed09cf0
RS
364 submenu_start[i] = menu_items_used;
365
366 menu_items_n_panes = 0;
367 submenu_top_level_items[i]
368 = parse_single_submenu (key, string, maps);
fe04b8c8 369 submenu_n_panes[i] = menu_items_n_panes;
6ed09cf0
RS
370
371 submenu_end[i] = menu_items_used;
372 }
373
374 finish_menu_items ();
375
376 /* Convert menu_items into widget_value trees
377 to display the menu. This cannot evaluate Lisp code. */
378
5668fb88 379 wv = make_widget_value ("menubar", NULL, true, Qnil);
6ed09cf0 380 wv->button_type = BUTTON_TYPE_NONE;
6ed09cf0
RS
381 first_wv = wv;
382
383 for (i = 0; i < last_i; i += 4)
384 {
fe04b8c8 385 menu_items_n_panes = submenu_n_panes[i];
6ed09cf0
RS
386 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
387 submenu_top_level_items[i]);
177c0ea7 388 if (prev_wv)
485015ca
GV
389 prev_wv->next = wv;
390 else
391 first_wv->contents = wv;
392 /* Don't set wv->name here; GC during the loop might relocate it. */
393 wv->enabled = 1;
162d2499 394 wv->button_type = BUTTON_TYPE_NONE;
485015ca
GV
395 prev_wv = wv;
396 }
397
485015ca 398 set_buffer_internal_1 (prev);
485015ca
GV
399
400 /* If there has been no change in the Lisp-level contents
401 of the menu bar, skip redisplaying it. Just exit. */
402
403 for (i = 0; i < previous_menu_items_used; i++)
404 if (menu_items_used == i
6ed09cf0 405 || (!EQ (previous_items[i], AREF (menu_items, i))))
485015ca
GV
406 break;
407 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
408 {
409 free_menubar_widget_value_tree (first_wv);
df80fd9d 410 discard_menu_items ();
2bfa3d3e 411 dynwind_end ();
485015ca
GV
412 return;
413 }
414
f00af5b1 415 fset_menu_bar_vector (f, menu_items);
df80fd9d
JR
416 f->menu_bar_items_used = menu_items_used;
417
418 /* This undoes save_menu_items. */
2bfa3d3e 419 dynwind_end ();
df80fd9d 420
485015ca 421 /* Now GC cannot happen during the lifetime of the widget_value,
ace9b298
JR
422 so it's safe to store data from a Lisp_String, as long as
423 local copies are made when the actual menu is created.
424 Windows takes care of this for normal string items, but
425 not for owner-drawn items or additional item-info. */
485015ca 426 wv = first_wv->contents;
6ed09cf0 427 for (i = 0; i < ASIZE (items); i += 4)
485015ca
GV
428 {
429 Lisp_Object string;
6ed09cf0 430 string = AREF (items, i + 1);
485015ca
GV
431 if (NILP (string))
432 break;
51b59d79 433 wv->name = SSDATA (string);
1f06d367 434 update_submenu_strings (wv->contents);
485015ca
GV
435 wv = wv->next;
436 }
485015ca
GV
437 }
438 else
439 {
440 /* Make a widget-value tree containing
162d2499 441 just the top level menu bar strings. */
485015ca 442
5668fb88 443 wv = make_widget_value ("menubar", NULL, true, Qnil);
6ed09cf0 444 wv->button_type = BUTTON_TYPE_NONE;
6ed09cf0
RS
445 first_wv = wv;
446
485015ca 447 items = FRAME_MENU_BAR_ITEMS (f);
6ed09cf0 448 for (i = 0; i < ASIZE (items); i += 4)
485015ca
GV
449 {
450 Lisp_Object string;
451
6ed09cf0 452 string = AREF (items, i + 1);
485015ca
GV
453 if (NILP (string))
454 break;
455
5668fb88 456 wv = make_widget_value (SSDATA (string), NULL, true, Qnil);
162d2499 457 wv->button_type = BUTTON_TYPE_NONE;
485015ca
GV
458 /* This prevents lwlib from assuming this
459 menu item is really supposed to be empty. */
460 /* The EMACS_INT cast avoids a warning.
461 This value just has to be different from small integers. */
462 wv->call_data = (void *) (EMACS_INT) (-1);
463
177c0ea7 464 if (prev_wv)
485015ca
GV
465 prev_wv->next = wv;
466 else
467 first_wv->contents = wv;
468 prev_wv = wv;
469 }
470
162d2499
JR
471 /* Forget what we thought we knew about what is in the
472 detailed contents of the menu bar menus.
473 Changing the top level always destroys the contents. */
474 f->menu_bar_items_used = 0;
485015ca
GV
475 }
476
477 /* Create or update the menu bar widget. */
ee78dc32 478
4d7e6e51 479 block_input ();
ee78dc32 480
485015ca
GV
481 if (menubar_widget)
482 {
483 /* Empty current menubar, rather than creating a fresh one. */
484 while (DeleteMenu (menubar_widget, 0, MF_BYPOSITION))
485 ;
486 }
487 else
488 {
489 menubar_widget = CreateMenu ();
490 }
491 fill_in_menu (menubar_widget, first_wv->contents);
ee78dc32 492
485015ca 493 free_menubar_widget_value_tree (first_wv);
ee78dc32 494
485015ca
GV
495 {
496 HMENU old_widget = f->output_data.w32->menubar_widget;
ee78dc32 497
485015ca
GV
498 f->output_data.w32->menubar_widget = menubar_widget;
499 SetMenu (FRAME_W32_WINDOW (f), f->output_data.w32->menubar_widget);
177c0ea7 500 /* Causes flicker when menu bar is updated
485015ca 501 DrawMenuBar (FRAME_W32_WINDOW (f)); */
ee78dc32 502
485015ca
GV
503 /* Force the window size to be recomputed so that the frame's text
504 area remains the same, if menubar has just been created. */
505 if (old_widget == NULL)
880e6158 506 x_set_window_size (f, 0, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f), 1);
ee78dc32 507 }
485015ca 508
4d7e6e51 509 unblock_input ();
ee78dc32
GV
510}
511
485015ca
GV
512/* Called from Fx_create_frame to create the initial menubar of a frame
513 before it is mapped, so that the window is mapped with the menubar already
514 there instead of us tacking it on later and thrashing the window after it
515 is visible. */
516
517void
a10c8269 518initialize_frame_menubar (struct frame *f)
485015ca
GV
519{
520 /* This function is called before the first chance to redisplay
521 the frame. It has to be, so the frame will have the right size. */
f00af5b1 522 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
485015ca 523 set_frame_menubar (f, 1, 1);
ee78dc32
GV
524}
525
485015ca
GV
526/* Get rid of the menu bar of frame F, and free its storage.
527 This is used when deleting a frame, and when turning off the menu bar. */
528
529void
a10c8269 530free_frame_menubar (struct frame *f)
485015ca 531{
4d7e6e51 532 block_input ();
485015ca
GV
533
534 {
535 HMENU old = GetMenu (FRAME_W32_WINDOW (f));
536 SetMenu (FRAME_W32_WINDOW (f), NULL);
537 f->output_data.w32->menubar_widget = NULL;
538 DestroyMenu (old);
539 }
29250851 540
4d7e6e51 541 unblock_input ();
485015ca 542}
ee78dc32 543
485015ca
GV
544\f
545/* w32_menu_show actually displays a menu using the panes and items in
546 menu_items and returns the value selected from it; we assume input
547 is blocked by the caller. */
ee78dc32
GV
548
549/* F is the frame the menu is for.
550 X and Y are the frame-relative specified position,
551 relative to the inside upper left corner of the frame F.
cfd794af
DA
552 Bitfield MENUFLAGS bits are:
553 MENU_FOR_CLICK is set if this menu was invoked for a mouse click.
554 MENU_KEYMAPS is set if this menu was specified with keymaps;
485015ca
GV
555 in that case, we return a list containing the chosen item's value
556 and perhaps also the pane's prefix.
ee78dc32
GV
557 TITLE is the specified menu title.
558 ERROR is a place to store an error message string in case of failure.
559 (We return nil on failure, but the value doesn't actually matter.) */
560
ef7417fd 561Lisp_Object
cfd794af 562w32_menu_show (struct frame *f, int x, int y, int menuflags,
42ca4633 563 Lisp_Object title, const char **error)
ee78dc32 564{
485015ca
GV
565 int i;
566 int menu_item_selection;
567 HMENU menu;
ee78dc32 568 POINT pos;
485015ca
GV
569 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
570 widget_value **submenu_stack
571 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
572 Lisp_Object *subprefix_stack
663e2b3f 573 = (Lisp_Object *) alloca (menu_items_used * word_size);
485015ca 574 int submenu_depth = 0;
485015ca 575 int first_pane;
485015ca 576
ee78dc32 577 *error = NULL;
485015ca 578
df80fd9d
JR
579 if (menu_items_n_panes == 0)
580 return Qnil;
581
485015ca 582 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
ee78dc32
GV
583 {
584 *error = "Empty menu";
585 return Qnil;
586 }
485015ca 587
f0177f86
EZ
588 block_input ();
589
485015ca
GV
590 /* Create a tree of widget_value objects
591 representing the panes and their items. */
5668fb88 592 wv = make_widget_value ("menu", NULL, true, Qnil);
162d2499 593 wv->button_type = BUTTON_TYPE_NONE;
485015ca
GV
594 first_wv = wv;
595 first_pane = 1;
177c0ea7 596
485015ca
GV
597 /* Loop over all panes and items, filling in the tree. */
598 i = 0;
599 while (i < menu_items_used)
600 {
6ed09cf0 601 if (EQ (AREF (menu_items, i), Qnil))
485015ca
GV
602 {
603 submenu_stack[submenu_depth++] = save_wv;
604 save_wv = prev_wv;
605 prev_wv = 0;
606 first_pane = 1;
607 i++;
608 }
6ed09cf0 609 else if (EQ (AREF (menu_items, i), Qlambda))
485015ca
GV
610 {
611 prev_wv = save_wv;
612 save_wv = submenu_stack[--submenu_depth];
613 first_pane = 0;
614 i++;
615 }
6ed09cf0 616 else if (EQ (AREF (menu_items, i), Qt)
485015ca
GV
617 && submenu_depth != 0)
618 i += MENU_ITEMS_PANE_LENGTH;
619 /* Ignore a nil in the item list.
620 It's meaningful only for dialog boxes. */
6ed09cf0 621 else if (EQ (AREF (menu_items, i), Qquote))
485015ca 622 i += 1;
6ed09cf0 623 else if (EQ (AREF (menu_items, i), Qt))
485015ca
GV
624 {
625 /* Create a new pane. */
626 Lisp_Object pane_name, prefix;
af025ae8 627 const char *pane_string;
29250851
JR
628 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
629 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1f06d367
JR
630
631 if (STRINGP (pane_name))
29250851 632 {
1f06d367
JR
633 if (unicode_append_menu)
634 pane_name = ENCODE_UTF_8 (pane_name);
635 else if (STRING_MULTIBYTE (pane_name))
636 pane_name = ENCODE_SYSTEM (pane_name);
637
6ed09cf0 638 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
29250851 639 }
1f06d367 640
485015ca 641 pane_string = (NILP (pane_name)
51b59d79 642 ? "" : SSDATA (pane_name));
485015ca
GV
643 /* If there is just one top-level pane, put all its items directly
644 under the top-level menu. */
645 if (menu_items_n_panes == 1)
646 pane_string = "";
647
648 /* If the pane has a meaningful name,
649 make the pane a top-level menu item
650 with its items as a submenu beneath it. */
cfd794af 651 if (!(menuflags & MENU_KEYMAPS) && strcmp (pane_string, ""))
485015ca 652 {
5668fb88 653 wv = make_widget_value (pane_string, NULL, true, Qnil);
485015ca
GV
654 if (save_wv)
655 save_wv->next = wv;
656 else
657 first_wv->contents = wv;
cfd794af 658 if ((menuflags & MENU_KEYMAPS) && !NILP (prefix))
485015ca 659 wv->name++;
162d2499 660 wv->button_type = BUTTON_TYPE_NONE;
485015ca
GV
661 save_wv = wv;
662 prev_wv = 0;
663 }
664 else if (first_pane)
665 {
666 save_wv = wv;
667 prev_wv = 0;
668 }
669 first_pane = 0;
670 i += MENU_ITEMS_PANE_LENGTH;
671 }
672 else
673 {
674 /* Create a new item within current pane. */
b65a2f83 675 Lisp_Object item_name, enable, descrip, def, type, selected, help;
b65a2f83 676
29250851
JR
677 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
678 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
679 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
680 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
681 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
682 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
683 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
162d2499 684
1f06d367 685 if (STRINGP (item_name))
29250851 686 {
1f06d367
JR
687 if (unicode_append_menu)
688 item_name = ENCODE_UTF_8 (item_name);
689 else if (STRING_MULTIBYTE (item_name))
690 item_name = ENCODE_SYSTEM (item_name);
691
6ed09cf0 692 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
29250851 693 }
1f06d367
JR
694
695 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
29250851
JR
696 {
697 descrip = ENCODE_SYSTEM (descrip);
6ed09cf0 698 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
29250851 699 }
485015ca 700
0031c953 701 wv = make_widget_value (SSDATA (item_name), NULL, !NILP (enable),
5668fb88 702 STRINGP (help) ? help : Qnil);
177c0ea7 703 if (prev_wv)
485015ca 704 prev_wv->next = wv;
177c0ea7 705 else
485015ca 706 save_wv->contents = wv;
485015ca 707 if (!NILP (descrip))
51b59d79 708 wv->key = SSDATA (descrip);
485015ca 709 /* Use the contents index as call_data, since we are
2cd23960 710 restricted to 16-bits. */
e59fe83b 711 wv->call_data = !NILP (def) ? (void *) (EMACS_INT) i : 0;
162d2499
JR
712
713 if (NILP (type))
714 wv->button_type = BUTTON_TYPE_NONE;
715 else if (EQ (type, QCtoggle))
716 wv->button_type = BUTTON_TYPE_TOGGLE;
717 else if (EQ (type, QCradio))
718 wv->button_type = BUTTON_TYPE_RADIO;
719 else
1088b922 720 emacs_abort ();
162d2499
JR
721
722 wv->selected = !NILP (selected);
df80fd9d 723
485015ca
GV
724 prev_wv = wv;
725
726 i += MENU_ITEMS_ITEM_LENGTH;
727 }
728 }
729
730 /* Deal with the title, if it is non-nil. */
731 if (!NILP (title))
732 {
5668fb88
DA
733 widget_value *wv_title;
734 widget_value *wv_sep = make_widget_value ("--", NULL, false, Qnil);
485015ca
GV
735
736 /* Maybe replace this separator with a bitmap or owner-draw item
737 so that it looks better. Having two separators looks odd. */
485015ca
GV
738 wv_sep->next = first_wv->contents;
739
1f06d367
JR
740 if (unicode_append_menu)
741 title = ENCODE_UTF_8 (title);
742 else if (STRING_MULTIBYTE (title))
6915ded0 743 title = ENCODE_SYSTEM (title);
1f06d367 744
5668fb88 745 wv_title = make_widget_value (SSDATA (title), NULL, true, Qnil);
5b20b3cc 746 wv_title->title = TRUE;
162d2499 747 wv_title->button_type = BUTTON_TYPE_NONE;
485015ca
GV
748 wv_title->next = wv_sep;
749 first_wv->contents = wv_title;
750 }
751
df80fd9d
JR
752 /* No selection has been chosen yet. */
753 menu_item_selection = 0;
754
485015ca 755 /* Actually create the menu. */
ace9b298 756 current_popup_menu = menu = CreatePopupMenu ();
485015ca 757 fill_in_menu (menu, first_wv->contents);
162d2499 758
485015ca 759 /* Adjust coordinates to be root-window-relative. */
ee78dc32
GV
760 pos.x = x;
761 pos.y = y;
fbd6baed 762 ClientToScreen (FRAME_W32_WINDOW (f), &pos);
485015ca 763
ee78dc32 764 /* Display the menu. */
177c0ea7 765 menu_item_selection = SendMessage (FRAME_W32_WINDOW (f),
485015ca
GV
766 WM_EMACS_TRACKPOPUPMENU,
767 (WPARAM)menu, (LPARAM)&pos);
014510b0
GV
768
769 /* Clean up extraneous mouse events which might have been generated
770 during the call. */
771 discard_mouse_events ();
aad3612f 772 FRAME_DISPLAY_INFO (f)->grabbed = 0;
014510b0 773
86fb1a79
JR
774 /* Free the widget_value objects we used to specify the contents. */
775 free_menubar_widget_value_tree (first_wv);
776
485015ca
GV
777 DestroyMenu (menu);
778
563cd4c0
JR
779 /* Free the owner-drawn and help-echo menu strings. */
780 w32_free_menu_strings (FRAME_W32_WINDOW (f));
5339f50c 781 f->output_data.w32->menubar_active = 0;
563cd4c0 782
ee78dc32
GV
783 /* Find the selected item, and its pane, to return
784 the proper value. */
485015ca 785 if (menu_item_selection != 0)
ee78dc32 786 {
485015ca
GV
787 Lisp_Object prefix, entry;
788
fe5a0162 789 prefix = entry = Qnil;
485015ca
GV
790 i = 0;
791 while (i < menu_items_used)
792 {
6ed09cf0 793 if (EQ (AREF (menu_items, i), Qnil))
485015ca
GV
794 {
795 subprefix_stack[submenu_depth++] = prefix;
796 prefix = entry;
797 i++;
798 }
6ed09cf0 799 else if (EQ (AREF (menu_items, i), Qlambda))
485015ca
GV
800 {
801 prefix = subprefix_stack[--submenu_depth];
802 i++;
803 }
6ed09cf0 804 else if (EQ (AREF (menu_items, i), Qt))
485015ca 805 {
6ed09cf0 806 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
485015ca
GV
807 i += MENU_ITEMS_PANE_LENGTH;
808 }
809 /* Ignore a nil in the item list.
810 It's meaningful only for dialog boxes. */
6ed09cf0 811 else if (EQ (AREF (menu_items, i), Qquote))
485015ca
GV
812 i += 1;
813 else
814 {
cfd794af 815 entry = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
485015ca
GV
816 if (menu_item_selection == i)
817 {
cfd794af 818 if (menuflags & MENU_KEYMAPS)
485015ca
GV
819 {
820 int j;
821
822 entry = Fcons (entry, Qnil);
823 if (!NILP (prefix))
824 entry = Fcons (prefix, entry);
825 for (j = submenu_depth - 1; j >= 0; j--)
826 if (!NILP (subprefix_stack[j]))
827 entry = Fcons (subprefix_stack[j], entry);
828 }
f0177f86 829 unblock_input ();
485015ca
GV
830 return entry;
831 }
832 i += MENU_ITEMS_ITEM_LENGTH;
833 }
834 }
ee78dc32 835 }
cfd794af 836 else if (!(menuflags & MENU_FOR_CLICK))
f0177f86
EZ
837 {
838 unblock_input ();
839 /* Make "Cancel" equivalent to C-g. */
840 Fsignal (Qquit, Qnil);
841 }
014510b0 842
f0177f86 843 unblock_input ();
ee78dc32
GV
844 return Qnil;
845}
485015ca 846\f
ee78dc32 847
ace9b298 848#ifdef HAVE_DIALOGS
31403b24
JR
849/* TODO: On Windows, there are two ways of defining a dialog.
850
851 1. Create a predefined dialog resource and include it in nt/emacs.rc.
852 Using this method, we could then set the titles and make unneeded
853 buttons invisible before displaying the dialog. Everything would
854 be a fixed size though, so there is a risk that text does not
855 fit on a button.
856 2. Create the dialog template in memory on the fly. This allows us
857 to size the dialog and buttons dynamically, probably giving more
858 natural looking results for dialogs with few buttons, and eliminating
859 the problem of text overflowing the buttons. But the API for this is
860 quite complex - structures have to be allocated in particular ways,
861 text content is tacked onto the end of structures in variable length
862 arrays with further structures tacked on after these, there are
863 certain alignment requirements for all this, and we have to
864 measure all the text and convert to "dialog coordinates" to figure
865 out how big to make everything.
866
867 For now, we'll just stick with menus for dialogs that are more
868 complicated than simple yes/no type questions for which we can use
869 the MessageBox function.
870*/
38fecd52 871
485015ca 872static char * button_names [] = {
ee78dc32 873 "button1", "button2", "button3", "button4", "button5",
485015ca 874 "button6", "button7", "button8", "button9", "button10" };
ee78dc32
GV
875
876static Lisp_Object
f1b44793
DA
877w32_dialog_show (struct frame *f, Lisp_Object title,
878 Lisp_Object header, char **error)
ee78dc32 879{
9d4f32e8 880 int i, nb_buttons = 0;
ee78dc32 881 char dialog_name[6];
485015ca
GV
882 int menu_item_selection;
883
fe5a0162 884 widget_value *wv, *first_wv = 0, *prev_wv = 0;
485015ca 885
ee78dc32
GV
886 /* Number of elements seen so far, before boundary. */
887 int left_count = 0;
888 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
889 int boundary_seen = 0;
485015ca 890
ee78dc32 891 *error = NULL;
485015ca 892
ee78dc32
GV
893 if (menu_items_n_panes > 1)
894 {
895 *error = "Multiple panes in dialog box";
896 return Qnil;
897 }
485015ca 898
ee78dc32
GV
899 /* Create a tree of widget_value objects
900 representing the text label and buttons. */
901 {
f1b44793 902 Lisp_Object pane_name;
ee78dc32 903 char *pane_string;
6ed09cf0 904 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
ee78dc32 905 pane_string = (NILP (pane_name)
51b59d79 906 ? "" : SSDATA (pane_name));
5668fb88 907 prev_wv = make_widget_value ("message", pane_string, true, Qnil);
ee78dc32 908 first_wv = prev_wv;
177c0ea7 909
ee78dc32
GV
910 /* Loop over all panes and items, filling in the tree. */
911 i = MENU_ITEMS_PANE_LENGTH;
912 while (i < menu_items_used)
913 {
177c0ea7 914
ee78dc32 915 /* Create a new item within current pane. */
b65a2f83 916 Lisp_Object item_name, enable, descrip, help;
b65a2f83 917
6ed09cf0
RS
918 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
919 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
920 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
921 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
177c0ea7 922
ee78dc32
GV
923 if (NILP (item_name))
924 {
925 free_menubar_widget_value_tree (first_wv);
926 *error = "Submenu in dialog items";
927 return Qnil;
928 }
929 if (EQ (item_name, Qquote))
930 {
931 /* This is the boundary between left-side elts
932 and right-side elts. Stop incrementing right_count. */
933 boundary_seen = 1;
934 i++;
935 continue;
936 }
485015ca 937 if (nb_buttons >= 9)
ee78dc32
GV
938 {
939 free_menubar_widget_value_tree (first_wv);
940 *error = "Too many dialog items";
941 return Qnil;
942 }
485015ca 943
5668fb88
DA
944 wv = make_widget_value (button_names[nb_buttons],
945 SSDATA (item_name),
946 !NILP (enable), Qnil);
ee78dc32 947 prev_wv->next = wv;
ee78dc32 948 if (!NILP (descrip))
51b59d79 949 wv->key = SSDATA (descrip);
4939150c 950 wv->call_data = aref_addr (menu_items, i);
ee78dc32 951 prev_wv = wv;
485015ca 952
ee78dc32
GV
953 if (! boundary_seen)
954 left_count++;
485015ca 955
ee78dc32
GV
956 nb_buttons++;
957 i += MENU_ITEMS_ITEM_LENGTH;
958 }
485015ca 959
ee78dc32
GV
960 /* If the boundary was not specified,
961 by default put half on the left and half on the right. */
962 if (! boundary_seen)
963 left_count = nb_buttons - nb_buttons / 2;
485015ca 964
5668fb88 965 wv = make_widget_value (dialog_name, NULL, false, Qnil);
485015ca 966
d23928c7
NR
967 /* Frame title: 'Q' = Question, 'I' = Information.
968 Can also have 'E' = Error if, one day, we want
969 a popup for errors. */
ed3751c8 970 if (NILP (header))
d23928c7
NR
971 dialog_name[0] = 'Q';
972 else
973 dialog_name[0] = 'I';
974
ee78dc32
GV
975 /* Dialog boxes use a really stupid name encoding
976 which specifies how many buttons to use
d23928c7 977 and how many buttons are on the right. */
ee78dc32
GV
978 dialog_name[1] = '0' + nb_buttons;
979 dialog_name[2] = 'B';
980 dialog_name[3] = 'R';
981 /* Number of buttons to put on the right. */
982 dialog_name[4] = '0' + nb_buttons - left_count;
983 dialog_name[5] = 0;
984 wv->contents = first_wv;
985 first_wv = wv;
986 }
485015ca 987
ee78dc32 988 /* Actually create the dialog. */
485015ca 989 dialog_id = widget_id_tick++;
ee78dc32 990 menu = lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
fbd6baed 991 f->output_data.w32->widget, 1, 0,
ee78dc32 992 dialog_selection_callback, 0);
02067692 993 lw_modify_all_widgets (dialog_id, first_wv->contents, TRUE);
485015ca 994
ee78dc32
GV
995 /* Free the widget_value objects we used to specify the contents. */
996 free_menubar_widget_value_tree (first_wv);
485015ca 997
ee78dc32
GV
998 /* No selection has been chosen yet. */
999 menu_item_selection = 0;
485015ca 1000
ee78dc32
GV
1001 /* Display the menu. */
1002 lw_pop_up_all_widgets (dialog_id);
485015ca 1003
ee78dc32 1004 /* Process events that apply to the menu. */
aad3612f 1005 popup_get_selection ((XEvent *) 0, FRAME_DISPLAY_INFO (f), dialog_id);
ee78dc32 1006
177c0ea7 1007 lw_destroy_all_widgets (dialog_id);
ee78dc32 1008
ee78dc32
GV
1009 /* Find the selected item, and its pane, to return
1010 the proper value. */
1011 if (menu_item_selection != 0)
1012 {
ee78dc32
GV
1013 i = 0;
1014 while (i < menu_items_used)
1015 {
1016 Lisp_Object entry;
1017
6ed09cf0 1018 if (EQ (AREF (menu_items, i), Qt))
f1b44793 1019 i += MENU_ITEMS_PANE_LENGTH;
ee78dc32
GV
1020 else
1021 {
f1b44793 1022 entry = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
485015ca 1023 if (menu_item_selection == i)
f1b44793 1024 return entry;
ee78dc32
GV
1025 i += MENU_ITEMS_ITEM_LENGTH;
1026 }
1027 }
1028 }
f3e0a6de
JR
1029 else
1030 /* Make "Cancel" equivalent to C-g. */
1031 Fsignal (Qquit, Qnil);
485015ca 1032
ee78dc32
GV
1033 return Qnil;
1034}
31403b24
JR
1035#else /* !HAVE_DIALOGS */
1036
1037/* Currently we only handle Yes No dialogs (y-or-n-p and yes-or-no-p) as
1038 simple dialogs. We could handle a few more, but I'm not aware of
1039 anywhere in Emacs that uses the other specific dialog choices that
1040 MessageBox provides. */
1041
b56ceb92
JB
1042static int
1043is_simple_dialog (Lisp_Object contents)
31403b24 1044{
3b0512a3 1045 Lisp_Object options;
31403b24
JR
1046 Lisp_Object name, yes, no, other;
1047
3b0512a3
AS
1048 if (!CONSP (contents))
1049 return 0;
1050 options = XCDR (contents);
1051
31403b24
JR
1052 yes = build_string ("Yes");
1053 no = build_string ("No");
1054
1055 if (!CONSP (options))
1056 return 0;
1057
3b0512a3
AS
1058 name = XCAR (options);
1059 if (!CONSP (name))
31403b24 1060 return 0;
3b0512a3 1061 name = XCAR (name);
31403b24
JR
1062
1063 if (!NILP (Fstring_equal (name, yes)))
1064 other = no;
1065 else if (!NILP (Fstring_equal (name, no)))
1066 other = yes;
1067 else
1068 return 0;
1069
1070 options = XCDR (options);
1071 if (!CONSP (options))
1072 return 0;
1073
3b0512a3
AS
1074 name = XCAR (options);
1075 if (!CONSP (name))
1076 return 0;
1077 name = XCAR (name);
31403b24
JR
1078 if (NILP (Fstring_equal (name, other)))
1079 return 0;
1080
1081 /* Check there are no more options. */
1082 options = XCDR (options);
1083 return !(CONSP (options));
1084}
1085
b56ceb92 1086static Lisp_Object
a10c8269 1087simple_dialog_show (struct frame *f, Lisp_Object contents, Lisp_Object header)
31403b24
JR
1088{
1089 int answer;
1090 UINT type;
31403b24
JR
1091 Lisp_Object lispy_answer = Qnil, temp = XCAR (contents);
1092
1c9b4129
JR
1093 type = MB_YESNO;
1094
1095 /* Since we only handle Yes/No dialogs, and we already checked
1096 is_simple_dialog, we don't need to worry about checking contents
1097 to see what type of dialog to use. */
31403b24 1098
fe7a3057 1099 /* Use Unicode if possible, so any language can be displayed. */
1c9b4129 1100 if (unicode_message_box)
31403b24 1101 {
af025ae8
EZ
1102 WCHAR *text;
1103 const WCHAR *title;
8bc53d00 1104 USE_SAFE_ALLOCA;
1c9b4129
JR
1105
1106 if (STRINGP (temp))
1107 {
1108 char *utf8_text = SDATA (ENCODE_UTF_8 (temp));
1109 /* Be pessimistic about the number of characters needed.
1110 Remember characters outside the BMP will take more than
1111 one utf16 word, so we cannot simply use the character
1112 length of temp. */
1113 int utf8_len = strlen (utf8_text);
98c6f1e3 1114 text = SAFE_ALLOCA ((utf8_len + 1) * sizeof (WCHAR));
1c9b4129
JR
1115 utf8to16 (utf8_text, utf8_len, text);
1116 }
1117 else
1118 {
1119 text = L"";
1120 }
1121
1122 if (NILP (header))
1123 {
1124 title = L"Question";
1125 type |= MB_ICONQUESTION;
1126 }
1127 else
1128 {
1129 title = L"Information";
1130 type |= MB_ICONINFORMATION;
1131 }
1132
1133 answer = unicode_message_box (FRAME_W32_WINDOW (f), text, title, type);
8bc53d00 1134 SAFE_FREE ();
31403b24
JR
1135 }
1136 else
1137 {
af025ae8 1138 const char *text, *title;
31403b24 1139
1c9b4129
JR
1140 /* Fall back on ANSI message box, but at least use system
1141 encoding so questions representable by the system codepage
1142 are encoded properly. */
1143 if (STRINGP (temp))
1144 text = SDATA (ENCODE_SYSTEM (temp));
1145 else
1146 text = "";
1147
1148 if (NILP (header))
1149 {
1150 title = "Question";
1151 type |= MB_ICONQUESTION;
1152 }
1153 else
1154 {
1155 title = "Information";
1156 type |= MB_ICONINFORMATION;
1157 }
1158
1159 answer = MessageBox (FRAME_W32_WINDOW (f), text, title, type);
1160 }
31403b24
JR
1161
1162 if (answer == IDYES)
1163 lispy_answer = build_string ("Yes");
1164 else if (answer == IDNO)
1165 lispy_answer = build_string ("No");
1166 else
1167 Fsignal (Qquit, Qnil);
1168
1169 for (temp = XCDR (contents); CONSP (temp); temp = XCDR (temp))
1170 {
1171 Lisp_Object item, name, value;
1172 item = XCAR (temp);
1173 if (CONSP (item))
1174 {
1175 name = XCAR (item);
1176 value = XCDR (item);
1177 }
1178 else
1179 {
1180 name = item;
1181 value = Qnil;
1182 }
1183
1184 if (!NILP (Fstring_equal (name, lispy_answer)))
1185 {
1186 return value;
1187 }
1188 }
1189 Fsignal (Qquit, Qnil);
1190 return Qnil;
1191}
1192#endif /* !HAVE_DIALOGS */
485015ca
GV
1193\f
1194
1f06d367
JR
1195/* UTF8: 0xxxxxxx, 110xxxxx 10xxxxxx, 1110xxxx, 10xxxxxx, 10xxxxxx */
1196static void
1197utf8to16 (unsigned char * src, int len, WCHAR * dest)
1198{
1199 while (len > 0)
1200 {
1f06d367
JR
1201 if (*src < 0x80)
1202 {
1203 *dest = (WCHAR) *src;
1204 dest++; src++; len--;
1205 }
1206 /* Since we might get >3 byte sequences which we don't handle, ignore the extra parts. */
1207 else if (*src < 0xC0)
1208 {
1209 src++; len--;
1210 }
1211 /* 2 char UTF-8 sequence. */
1212 else if (*src < 0xE0)
1213 {
1214 *dest = (WCHAR) (((*src & 0x1f) << 6)
1215 | (*(src + 1) & 0x3f));
1216 src += 2; len -= 2; dest++;
1217 }
1218 else if (*src < 0xF0)
1219 {
1220 *dest = (WCHAR) (((*src & 0x0f) << 12)
1221 | ((*(src + 1) & 0x3f) << 6)
1222 | (*(src + 2) & 0x3f));
1223 src += 3; len -= 3; dest++;
1224 }
1225 else /* Not encodable. Insert Unicode Substitution char. */
1226 {
1227 *dest = (WCHAR) 0xfffd;
1228 src++; len--; dest++;
1229 }
1230 }
1231 *dest = 0;
1232}
1233
485015ca
GV
1234static int
1235add_menu_item (HMENU menu, widget_value *wv, HMENU item)
1236{
1237 UINT fuFlags;
af41f8a8 1238 char *out_string, *p, *q;
37ad8b63 1239 int return_value;
af41f8a8 1240 size_t nlen, orig_len;
8bc53d00 1241 USE_SAFE_ALLOCA;
485015ca 1242
4039c786 1243 if (menu_separator_name_p (wv->name))
222456a1
JR
1244 {
1245 fuFlags = MF_SEPARATOR;
1246 out_string = NULL;
1247 }
177c0ea7 1248 else
485015ca 1249 {
070d1949 1250 if (wv->enabled)
485015ca
GV
1251 fuFlags = MF_STRING;
1252 else
1253 fuFlags = MF_STRING | MF_GRAYED;
1254
1255 if (wv->key != NULL)
1256 {
98c6f1e3 1257 out_string = SAFE_ALLOCA (strlen (wv->name) + strlen (wv->key) + 2);
485015ca
GV
1258 strcpy (out_string, wv->name);
1259 strcat (out_string, "\t");
1260 strcat (out_string, wv->key);
1261 }
1262 else
94c97d85 1263 out_string = (char *)wv->name;
485015ca 1264
af41f8a8
EZ
1265 /* Quote any special characters within the menu item's text and
1266 key binding. */
1267 nlen = orig_len = strlen (out_string);
ff25d115
JR
1268 if (unicode_append_menu)
1269 {
1270 /* With UTF-8, & cannot be part of a multibyte character. */
1271 for (p = out_string; *p; p++)
1272 {
1273 if (*p == '&')
1274 nlen++;
1275 }
1276 }
0fda9b75 1277#ifndef NTGUI_UNICODE
ff25d115
JR
1278 else
1279 {
1280 /* If encoded with the system codepage, use multibyte string
1281 functions in case of multibyte characters that contain '&'. */
1282 for (p = out_string; *p; p = _mbsinc (p))
1283 {
1284 if (_mbsnextc (p) == '&')
1285 nlen++;
1286 }
1287 }
0fda9b75 1288#endif /* !NTGUI_UNICODE */
ff25d115 1289
af41f8a8 1290 if (nlen > orig_len)
ff25d115
JR
1291 {
1292 p = out_string;
98c6f1e3 1293 out_string = SAFE_ALLOCA (nlen + 1);
ff25d115
JR
1294 q = out_string;
1295 while (*p)
1296 {
1297 if (unicode_append_menu)
1298 {
1299 if (*p == '&')
1300 *q++ = *p;
1301 *q++ = *p++;
1302 }
0fda9b75 1303#ifndef NTGUI_UNICODE
ff25d115
JR
1304 else
1305 {
1306 if (_mbsnextc (p) == '&')
1307 {
1308 _mbsncpy (q, p, 1);
1309 q = _mbsinc (q);
1310 }
1311 _mbsncpy (q, p, 1);
1312 p = _mbsinc (p);
1313 q = _mbsinc (q);
1314 }
0fda9b75 1315#endif /* !NTGUI_UNICODE */
ff25d115
JR
1316 }
1317 *q = '\0';
1318 }
af41f8a8 1319
d1fffd1d
JR
1320 if (item != NULL)
1321 fuFlags = MF_POPUP;
1322 else if (wv->title || wv->call_data == 0)
485015ca 1323 {
ace9b298
JR
1324 /* Only use MF_OWNERDRAW if GetMenuItemInfo is usable, since
1325 we can't deallocate the memory otherwise. */
1326 if (get_menu_item_info)
1327 {
6ed09cf0
RS
1328 out_string = (char *) local_alloc (strlen (wv->name) + 1);
1329 strcpy (out_string, wv->name);
d1fffd1d 1330#ifdef MENU_DEBUG
91af3942 1331 DebPrint ("Menu: allocating %ld for owner-draw", out_string);
d1fffd1d 1332#endif
ace9b298
JR
1333 fuFlags = MF_OWNERDRAW | MF_DISABLED;
1334 }
1335 else
1336 fuFlags = MF_DISABLED;
485015ca 1337 }
1c5acb8c 1338
162d2499 1339 /* Draw radio buttons and tickboxes. */
4cdf6a6c 1340 else if (wv->selected && (wv->button_type == BUTTON_TYPE_TOGGLE ||
6f665da9 1341 wv->button_type == BUTTON_TYPE_RADIO))
4cdf6a6c 1342 fuFlags |= MF_CHECKED;
37ad8b63 1343 else
4cdf6a6c 1344 fuFlags |= MF_UNCHECKED;
485015ca 1345 }
4cdf6a6c 1346
1f06d367
JR
1347 if (unicode_append_menu && out_string)
1348 {
1349 /* Convert out_string from UTF-8 to UTF-16-LE. */
1350 int utf8_len = strlen (out_string);
1351 WCHAR * utf16_string;
1352 if (fuFlags & MF_OWNERDRAW)
1353 utf16_string = local_alloc ((utf8_len + 1) * sizeof (WCHAR));
1354 else
98c6f1e3 1355 utf16_string = SAFE_ALLOCA ((utf8_len + 1) * sizeof (WCHAR));
1f06d367
JR
1356
1357 utf8to16 (out_string, utf8_len, utf16_string);
1358 return_value = unicode_append_menu (menu, fuFlags,
62aba0d4
FP
1359 item != NULL ? (UINT_PTR) item
1360 : (UINT_PTR) wv->call_data,
1f06d367 1361 utf16_string);
0fda9b75
DC
1362
1363#ifndef NTGUI_UNICODE /* Fallback does not apply when always UNICODE */
d749b6fa
JR
1364 if (!return_value)
1365 {
fe7a3057 1366 /* On W9x/ME, Unicode menus are not supported, though AppendMenuW
d749b6fa
JR
1367 apparently does exist at least in some cases and appears to be
1368 stubbed out to do nothing. out_string is UTF-8, but since
1369 our standard menus are in English and this is only going to
1370 happen the first time a menu is used, the encoding is
1371 of minor importance compared with menus not working at all. */
1372 return_value =
1373 AppendMenu (menu, fuFlags,
62aba0d4 1374 item != NULL ? (UINT_PTR) item: (UINT_PTR) wv->call_data,
d749b6fa 1375 out_string);
1c6900d9
EZ
1376 /* Don't use Unicode menus in future, unless this is Windows
1377 NT or later, where a failure of AppendMenuW does NOT mean
1378 Unicode menus are unsupported. */
1379 if (osinfo_cache.dwPlatformId != VER_PLATFORM_WIN32_NT)
1380 unicode_append_menu = NULL;
d749b6fa 1381 }
0fda9b75 1382#endif /* NTGUI_UNICODE */
d749b6fa
JR
1383
1384 if (unicode_append_menu && (fuFlags & MF_OWNERDRAW))
1f06d367
JR
1385 local_free (out_string);
1386 }
1387 else
1388 {
1389 return_value =
1390 AppendMenu (menu,
1391 fuFlags,
62aba0d4 1392 item != NULL ? (UINT_PTR) item : (UINT_PTR) wv->call_data,
1f06d367
JR
1393 out_string );
1394 }
37ad8b63
JR
1395
1396 /* This must be done after the menu item is created. */
6f665da9 1397 if (!wv->title && wv->call_data != 0)
4cdf6a6c 1398 {
4cdf6a6c
AI
1399 if (set_menu_item_info)
1400 {
1401 MENUITEMINFO info;
72af86bd 1402 memset (&info, 0, sizeof (info));
4cdf6a6c
AI
1403 info.cbSize = sizeof (info);
1404 info.fMask = MIIM_DATA;
1405
d1fffd1d
JR
1406 /* Set help string for menu item. Leave it as a Lisp_Object
1407 until it is ready to be displayed, since GC can happen while
1408 menus are active. */
24ee9763 1409 if (!NILP (wv->help))
2d5c5f7d
EZ
1410 {
1411 /* As of Jul-2012, w32api headers say that dwItemData
1412 has DWORD type, but that's a bug: it should actually
37a9eac8 1413 be ULONG_PTR, which is correct for 32-bit and 64-bit
2d5c5f7d
EZ
1414 Windows alike. MSVC headers get it right; hopefully,
1415 MinGW headers will, too. */
37a9eac8 1416 info.dwItemData = (ULONG_PTR) XLI (wv->help);
2d5c5f7d 1417 }
4cdf6a6c
AI
1418 if (wv->button_type == BUTTON_TYPE_RADIO)
1419 {
1420 /* CheckMenuRadioItem allows us to differentiate TOGGLE and
1421 RADIO items, but is not available on NT 3.51 and earlier. */
1422 info.fMask |= MIIM_TYPE | MIIM_STATE;
1423 info.fType = MFT_RADIOCHECK | MFT_STRING;
1424 info.dwTypeData = out_string;
1425 info.fState = wv->selected ? MFS_CHECKED : MFS_UNCHECKED;
1426 }
1427
1428 set_menu_item_info (menu,
62aba0d4 1429 item != NULL ? (UINT_PTR) item : (UINT_PTR) wv->call_data,
4cdf6a6c
AI
1430 FALSE, &info);
1431 }
1432 }
8bc53d00 1433 SAFE_FREE ();
37ad8b63 1434 return return_value;
485015ca
GV
1435}
1436
1437/* Construct native Windows menu(bar) based on widget_value tree. */
24f981c9 1438static int
485015ca
GV
1439fill_in_menu (HMENU menu, widget_value *wv)
1440{
485015ca
GV
1441 for ( ; wv != NULL; wv = wv->next)
1442 {
1443 if (wv->contents)
1444 {
1445 HMENU sub_menu = CreatePopupMenu ();
1446
1447 if (sub_menu == NULL)
1448 return 0;
1449
1450 if (!fill_in_menu (sub_menu, wv->contents) ||
1451 !add_menu_item (menu, wv, sub_menu))
1452 {
1453 DestroyMenu (sub_menu);
1454 return 0;
1455 }
1456 }
1457 else
1458 {
1459 if (!add_menu_item (menu, wv, NULL))
1460 return 0;
1461 }
1462 }
1463 return 1;
1464}
1465
7d8e57da
JR
1466/* Display help string for currently pointed to menu item. Not
1467 supported on NT 3.51 and earlier, as GetMenuItemInfo is not
1468 available. */
1469void
59a86c99 1470w32_menu_display_help (HWND owner, HMENU menu, UINT item, UINT flags)
7d8e57da 1471{
7d8e57da
JR
1472 if (get_menu_item_info)
1473 {
1c5acb8c
JR
1474 struct frame *f = x_window_to_frame (&one_w32_display_info, owner);
1475 Lisp_Object frame, help;
7d8e57da 1476
94c7f257
JR
1477 /* No help echo on owner-draw menu items, or when the keyboard is used
1478 to navigate the menus, since tooltips are distracting if they pop
1479 up elsewhere. */
1480 if (flags & MF_OWNERDRAW || flags & MF_POPUP
1481 || !(flags & MF_MOUSESELECT))
ace9b298
JR
1482 help = Qnil;
1483 else
1484 {
1485 MENUITEMINFO info;
7d8e57da 1486
72af86bd 1487 memset (&info, 0, sizeof (info));
ace9b298
JR
1488 info.cbSize = sizeof (info);
1489 info.fMask = MIIM_DATA;
1490 get_menu_item_info (menu, item, FALSE, &info);
1491
646b5f55 1492 help = info.dwItemData ? XIL (info.dwItemData) : Qnil;
ace9b298 1493 }
e5cd3d11 1494
1c5acb8c
JR
1495 /* Store the help echo in the keyboard buffer as the X toolkit
1496 version does, rather than directly showing it. This seems to
1497 solve the GC problems that were present when we based the
1498 Windows code on the non-toolkit version. */
1499 if (f)
1500 {
1501 XSETFRAME (frame, f);
1502 kbd_buffer_store_help_event (frame, help);
1503 }
1504 else
1505 /* X version has a loop through frames here, which doesn't
1506 appear to do anything, unless it has some side effect. */
f868cd8a 1507 show_help_echo (help, Qnil, Qnil, Qnil);
7d8e57da
JR
1508 }
1509}
1510
d1fffd1d 1511/* Free memory used by owner-drawn strings. */
ace9b298 1512static void
b56ceb92 1513w32_free_submenu_strings (HMENU menu)
ace9b298
JR
1514{
1515 int i, num = GetMenuItemCount (menu);
1516 for (i = 0; i < num; i++)
1517 {
1518 MENUITEMINFO info;
72af86bd 1519 memset (&info, 0, sizeof (info));
ace9b298 1520 info.cbSize = sizeof (info);
d1fffd1d 1521 info.fMask = MIIM_DATA | MIIM_TYPE | MIIM_SUBMENU;
7d8e57da 1522
ace9b298
JR
1523 get_menu_item_info (menu, i, TRUE, &info);
1524
d1fffd1d
JR
1525 /* Owner-drawn names are held in dwItemData. */
1526 if ((info.fType & MF_OWNERDRAW) && info.dwItemData)
1527 {
1528#ifdef MENU_DEBUG
1529 DebPrint ("Menu: freeing %ld for owner-draw", info.dwItemData);
1530#endif
6ed09cf0 1531 local_free (info.dwItemData);
d1fffd1d 1532 }
ace9b298
JR
1533
1534 /* Recurse down submenus. */
1535 if (info.hSubMenu)
1536 w32_free_submenu_strings (info.hSubMenu);
1537 }
1538}
1539
1540void
b56ceb92 1541w32_free_menu_strings (HWND hwnd)
ace9b298
JR
1542{
1543 HMENU menu = current_popup_menu;
1544
1545 if (get_menu_item_info)
1546 {
1547 /* If there is no popup menu active, free the strings from the frame's
1548 menubar. */
1549 if (!menu)
1550 menu = GetMenu (hwnd);
1551
1552 if (menu)
1553 w32_free_submenu_strings (menu);
1554 }
1555
1556 current_popup_menu = NULL;
1557}
7d8e57da 1558
e3135734
CY
1559/* The following is used by delayed window autoselection. */
1560
1561DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
1562 doc: /* Return t if a menu or popup dialog is active on selected frame. */)
5842a27b 1563 (void)
e3135734 1564{
a10c8269 1565 struct frame *f;
e3135734
CY
1566 f = SELECTED_FRAME ();
1567 return (f->output_data.w32->menubar_active > 0) ? Qt : Qnil;
e3135734
CY
1568}
1569
b56ceb92
JB
1570void
1571syms_of_w32menu (void)
ee78dc32 1572{
fe6aa7a1
BT
1573#include "w32menu.x"
1574
019e3c1a 1575 globals_of_w32menu ();
485015ca 1576
ace9b298
JR
1577 current_popup_menu = NULL;
1578
019e3c1a 1579 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
e139a33c 1580 DEFSYM (Qunsupported__w32_dialog, "unsupported--w32-dialog");
ee78dc32 1581}
9785d95b
BK
1582
1583/*
1584 globals_of_w32menu is used to initialize those global variables that
1585 must always be initialized on startup even when the global variable
1586 initialized is non zero (see the function main in emacs.c).
1587 globals_of_w32menu is called from syms_of_w32menu when the global
1588 variable initialized is 0 and directly from main when initialized
1589 is non zero.
1590 */
b56ceb92
JB
1591void
1592globals_of_w32menu (void)
9785d95b 1593{
0fda9b75 1594#ifndef NTGUI_UNICODE
9d4f32e8 1595 /* See if Get/SetMenuItemInfo functions are available. */
9785d95b
BK
1596 HMODULE user32 = GetModuleHandle ("user32.dll");
1597 get_menu_item_info = (GetMenuItemInfoA_Proc) GetProcAddress (user32, "GetMenuItemInfoA");
1598 set_menu_item_info = (SetMenuItemInfoA_Proc) GetProcAddress (user32, "SetMenuItemInfoA");
1f06d367 1599 unicode_append_menu = (AppendMenuW_Proc) GetProcAddress (user32, "AppendMenuW");
1c9b4129 1600 unicode_message_box = (MessageBoxW_Proc) GetProcAddress (user32, "MessageBoxW");
0fda9b75 1601#endif /* !NTGUI_UNICODE */
9785d95b 1602}