use dynwind_begin and dynwind_end
[bpt/emacs.git] / src / w32menu.c
1 /* Menu support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1986, 1988, 1993-1994, 1996, 1998-1999, 2001-2014 Free
3 Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
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.
16
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/>. */
19
20 #include <config.h>
21
22 #include <signal.h>
23 #include <stdio.h>
24 #include <setjmp.h>
25
26 #include "lisp.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "termhooks.h"
31 #include "window.h"
32 #include "blockinput.h"
33 #include "character.h"
34 #include "buffer.h"
35 #include "charset.h"
36 #include "coding.h"
37 #include "menu.h"
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
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
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
59 #include "w32common.h" /* for osinfo_cache */
60
61 #undef HAVE_DIALOGS /* TODO: Implement native dialogs. */
62
63 #ifndef TRUE
64 #define TRUE 1
65 #define FALSE 0
66 #endif /* no TRUE */
67
68 HMENU current_popup_menu;
69
70 void syms_of_w32menu (void);
71 void globals_of_w32menu (void);
72
73 typedef BOOL (WINAPI * GetMenuItemInfoA_Proc) (
74 IN HMENU,
75 IN UINT,
76 IN BOOL,
77 IN OUT LPMENUITEMINFOA);
78 typedef BOOL (WINAPI * SetMenuItemInfoA_Proc) (
79 IN HMENU,
80 IN UINT,
81 IN BOOL,
82 IN LPCMENUITEMINFOA);
83 typedef int (WINAPI * MessageBoxW_Proc) (
84 IN HWND window,
85 IN const WCHAR *text,
86 IN const WCHAR *caption,
87 IN UINT type);
88
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 */
95 GetMenuItemInfoA_Proc get_menu_item_info = NULL;
96 SetMenuItemInfoA_Proc set_menu_item_info = NULL;
97 AppendMenuW_Proc unicode_append_menu = NULL;
98 MessageBoxW_Proc unicode_message_box = NULL;
99 #endif /* NTGUI_UNICODE */
100
101 Lisp_Object Qdebug_on_next_call, Qunsupported__w32_dialog;
102
103 void set_frame_menubar (struct frame *, bool, bool);
104
105 #ifdef HAVE_DIALOGS
106 static Lisp_Object w32_dialog_show (struct frame *, Lisp_Object, Lisp_Object, char **);
107 #else
108 static int is_simple_dialog (Lisp_Object);
109 static Lisp_Object simple_dialog_show (struct frame *, Lisp_Object, Lisp_Object);
110 #endif
111
112 static void utf8to16 (unsigned char *, int, WCHAR *);
113 static int fill_in_menu (HMENU, widget_value *);
114
115 void w32_free_menu_strings (HWND);
116
117 Lisp_Object
118 w32_popup_dialog (struct frame *f, Lisp_Object header, Lisp_Object contents)
119 {
120
121 check_window_system (f);
122
123 #ifndef HAVE_DIALOGS
124
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;
135
136 /* Decode the dialog items from what was specified. */
137 title = Fcar (contents);
138 CHECK_STRING (title);
139
140 list_of_panes (Fcons (contents, Qnil));
141
142 /* Display them in a dialog box. */
143 block_input ();
144 selection = w32_dialog_show (f, title, header, &error_name);
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 }
153 #endif /* HAVE_DIALOGS */
154 }
155
156 /* Activate the menu bar of frame F.
157 This is called from keyboard.c when it gets the
158 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
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. */
167
168 void
169 x_activate_menubar (struct frame *f)
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
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
185 void
186 menubar_selection_callback (struct frame *f, void * client_data)
187 {
188 Lisp_Object prefix, entry;
189 Lisp_Object vector;
190 Lisp_Object *subprefix_stack;
191 int submenu_depth = 0;
192 int i;
193
194 if (!f)
195 return;
196 entry = Qnil;
197 subprefix_stack = (Lisp_Object *) alloca (f->menu_bar_items_used * word_size);
198 vector = f->menu_bar_vector;
199 prefix = Qnil;
200 i = 0;
201 while (i < f->menu_bar_items_used)
202 {
203 if (EQ (AREF (vector, i), Qnil))
204 {
205 subprefix_stack[submenu_depth++] = prefix;
206 prefix = entry;
207 i++;
208 }
209 else if (EQ (AREF (vector, i), Qlambda))
210 {
211 prefix = subprefix_stack[--submenu_depth];
212 i++;
213 }
214 else if (EQ (AREF (vector, i), Qt))
215 {
216 prefix = AREF (vector, i + MENU_ITEMS_PANE_PREFIX);
217 i += MENU_ITEMS_PANE_LENGTH;
218 }
219 else
220 {
221 entry = AREF (vector, i + MENU_ITEMS_ITEM_VALUE);
222 /* The EMACS_INT cast avoids a warning. There's no problem
223 as long as pointers have enough bits to hold small integers. */
224 if ((int) (EMACS_INT) client_data == i)
225 {
226 int j;
227 struct input_event buf;
228 Lisp_Object frame;
229 EVENT_INIT (buf);
230
231 XSETFRAME (frame, f);
232 buf.kind = MENU_BAR_EVENT;
233 buf.frame_or_window = frame;
234 buf.arg = frame;
235 kbd_buffer_store_event (&buf);
236
237 for (j = 0; j < submenu_depth; j++)
238 if (!NILP (subprefix_stack[j]))
239 {
240 buf.kind = MENU_BAR_EVENT;
241 buf.frame_or_window = frame;
242 buf.arg = subprefix_stack[j];
243 kbd_buffer_store_event (&buf);
244 }
245
246 if (!NILP (prefix))
247 {
248 buf.kind = MENU_BAR_EVENT;
249 buf.frame_or_window = frame;
250 buf.arg = prefix;
251 kbd_buffer_store_event (&buf);
252 }
253
254 buf.kind = MENU_BAR_EVENT;
255 buf.frame_or_window = frame;
256 buf.arg = entry;
257 /* Free memory used by owner-drawn and help-echo strings. */
258 w32_free_menu_strings (FRAME_W32_WINDOW (f));
259 kbd_buffer_store_event (&buf);
260
261 f->output_data.w32->menubar_active = 0;
262 return;
263 }
264 i += MENU_ITEMS_ITEM_LENGTH;
265 }
266 }
267 /* Free memory used by owner-drawn and help-echo strings. */
268 w32_free_menu_strings (FRAME_W32_WINDOW (f));
269 f->output_data.w32->menubar_active = 0;
270 }
271
272 \f
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
277 void
278 set_frame_menubar (struct frame *f, bool first_time, bool deep_p)
279 {
280 HMENU menubar_widget = f->output_data.w32->menubar_widget;
281 Lisp_Object items;
282 widget_value *wv, *first_wv, *prev_wv = 0;
283 int i, last_i;
284 int *submenu_start, *submenu_end;
285 int *submenu_top_level_items, *submenu_n_panes;
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;
295
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;
302 dynwind_begin ();
303 int previous_menu_items_used = f->menu_bar_items_used;
304 Lisp_Object *previous_items
305 = (Lisp_Object *) alloca (previous_menu_items_used
306 * word_size);
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
313 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->contents;
314 specbind (Qinhibit_quit, Qt);
315 /* Don't let the debugger step into this code
316 because it is not reentrant. */
317 specbind (Qdebug_on_next_call, Qnil);
318
319 record_unwind_save_match_data ();
320
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
329 /* Run the hooks. */
330 safe_run_hooks (Qactivate_menubar_hook);
331 safe_run_hooks (Qmenu_bar_update_hook);
332 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
333
334 items = FRAME_MENU_BAR_ITEMS (f);
335
336 /* Save the frame's previous menu bar contents data. */
337 if (previous_menu_items_used)
338 memcpy (previous_items, XVECTOR (f->menu_bar_vector)->contents,
339 previous_menu_items_used * word_size);
340
341 /* Fill in menu_items with the current menu bar contents.
342 This can evaluate Lisp code. */
343 save_menu_items ();
344
345 menu_items = f->menu_bar_vector;
346 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
347 submenu_start = (int *) alloca (ASIZE (items) * sizeof (int));
348 submenu_end = (int *) alloca (ASIZE (items) * sizeof (int));
349 submenu_n_panes = (int *) alloca (ASIZE (items) * sizeof (int));
350 submenu_top_level_items = (int *) alloca (ASIZE (items) * sizeof (int));
351 init_menu_items ();
352 for (i = 0; i < ASIZE (items); i += 4)
353 {
354 Lisp_Object key, string, maps;
355
356 last_i = i;
357
358 key = AREF (items, i);
359 string = AREF (items, i + 1);
360 maps = AREF (items, i + 2);
361 if (NILP (string))
362 break;
363
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);
369 submenu_n_panes[i] = menu_items_n_panes;
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
379 wv = make_widget_value ("menubar", NULL, true, Qnil);
380 wv->button_type = BUTTON_TYPE_NONE;
381 first_wv = wv;
382
383 for (i = 0; i < last_i; i += 4)
384 {
385 menu_items_n_panes = submenu_n_panes[i];
386 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
387 submenu_top_level_items[i]);
388 if (prev_wv)
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;
394 wv->button_type = BUTTON_TYPE_NONE;
395 prev_wv = wv;
396 }
397
398 set_buffer_internal_1 (prev);
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
405 || (!EQ (previous_items[i], AREF (menu_items, i))))
406 break;
407 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
408 {
409 free_menubar_widget_value_tree (first_wv);
410 discard_menu_items ();
411 dynwind_end ();
412 return;
413 }
414
415 fset_menu_bar_vector (f, menu_items);
416 f->menu_bar_items_used = menu_items_used;
417
418 /* This undoes save_menu_items. */
419 dynwind_end ();
420
421 /* Now GC cannot happen during the lifetime of the widget_value,
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. */
426 wv = first_wv->contents;
427 for (i = 0; i < ASIZE (items); i += 4)
428 {
429 Lisp_Object string;
430 string = AREF (items, i + 1);
431 if (NILP (string))
432 break;
433 wv->name = SSDATA (string);
434 update_submenu_strings (wv->contents);
435 wv = wv->next;
436 }
437 }
438 else
439 {
440 /* Make a widget-value tree containing
441 just the top level menu bar strings. */
442
443 wv = make_widget_value ("menubar", NULL, true, Qnil);
444 wv->button_type = BUTTON_TYPE_NONE;
445 first_wv = wv;
446
447 items = FRAME_MENU_BAR_ITEMS (f);
448 for (i = 0; i < ASIZE (items); i += 4)
449 {
450 Lisp_Object string;
451
452 string = AREF (items, i + 1);
453 if (NILP (string))
454 break;
455
456 wv = make_widget_value (SSDATA (string), NULL, true, Qnil);
457 wv->button_type = BUTTON_TYPE_NONE;
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
464 if (prev_wv)
465 prev_wv->next = wv;
466 else
467 first_wv->contents = wv;
468 prev_wv = wv;
469 }
470
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;
475 }
476
477 /* Create or update the menu bar widget. */
478
479 block_input ();
480
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);
492
493 free_menubar_widget_value_tree (first_wv);
494
495 {
496 HMENU old_widget = f->output_data.w32->menubar_widget;
497
498 f->output_data.w32->menubar_widget = menubar_widget;
499 SetMenu (FRAME_W32_WINDOW (f), f->output_data.w32->menubar_widget);
500 /* Causes flicker when menu bar is updated
501 DrawMenuBar (FRAME_W32_WINDOW (f)); */
502
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)
506 x_set_window_size (f, 0, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f), 1);
507 }
508
509 unblock_input ();
510 }
511
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
517 void
518 initialize_frame_menubar (struct frame *f)
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. */
522 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
523 set_frame_menubar (f, 1, 1);
524 }
525
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
529 void
530 free_frame_menubar (struct frame *f)
531 {
532 block_input ();
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 }
540
541 unblock_input ();
542 }
543
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. */
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.
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;
555 in that case, we return a list containing the chosen item's value
556 and perhaps also the pane's prefix.
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
561 Lisp_Object
562 w32_menu_show (struct frame *f, int x, int y, int menuflags,
563 Lisp_Object title, const char **error)
564 {
565 int i;
566 int menu_item_selection;
567 HMENU menu;
568 POINT pos;
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
573 = (Lisp_Object *) alloca (menu_items_used * word_size);
574 int submenu_depth = 0;
575 int first_pane;
576
577 *error = NULL;
578
579 if (menu_items_n_panes == 0)
580 return Qnil;
581
582 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
583 {
584 *error = "Empty menu";
585 return Qnil;
586 }
587
588 block_input ();
589
590 /* Create a tree of widget_value objects
591 representing the panes and their items. */
592 wv = make_widget_value ("menu", NULL, true, Qnil);
593 wv->button_type = BUTTON_TYPE_NONE;
594 first_wv = wv;
595 first_pane = 1;
596
597 /* Loop over all panes and items, filling in the tree. */
598 i = 0;
599 while (i < menu_items_used)
600 {
601 if (EQ (AREF (menu_items, i), Qnil))
602 {
603 submenu_stack[submenu_depth++] = save_wv;
604 save_wv = prev_wv;
605 prev_wv = 0;
606 first_pane = 1;
607 i++;
608 }
609 else if (EQ (AREF (menu_items, i), Qlambda))
610 {
611 prev_wv = save_wv;
612 save_wv = submenu_stack[--submenu_depth];
613 first_pane = 0;
614 i++;
615 }
616 else if (EQ (AREF (menu_items, i), Qt)
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. */
621 else if (EQ (AREF (menu_items, i), Qquote))
622 i += 1;
623 else if (EQ (AREF (menu_items, i), Qt))
624 {
625 /* Create a new pane. */
626 Lisp_Object pane_name, prefix;
627 const char *pane_string;
628 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
629 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
630
631 if (STRINGP (pane_name))
632 {
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
638 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
639 }
640
641 pane_string = (NILP (pane_name)
642 ? "" : SSDATA (pane_name));
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. */
651 if (!(menuflags & MENU_KEYMAPS) && strcmp (pane_string, ""))
652 {
653 wv = make_widget_value (pane_string, NULL, true, Qnil);
654 if (save_wv)
655 save_wv->next = wv;
656 else
657 first_wv->contents = wv;
658 if ((menuflags & MENU_KEYMAPS) && !NILP (prefix))
659 wv->name++;
660 wv->button_type = BUTTON_TYPE_NONE;
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. */
675 Lisp_Object item_name, enable, descrip, def, type, selected, help;
676
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);
684
685 if (STRINGP (item_name))
686 {
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
692 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
693 }
694
695 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
696 {
697 descrip = ENCODE_SYSTEM (descrip);
698 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
699 }
700
701 wv = make_widget_value (SSDATA (item_name), NULL, !NILP (enable),
702 STRINGP (help) ? help : Qnil);
703 if (prev_wv)
704 prev_wv->next = wv;
705 else
706 save_wv->contents = wv;
707 if (!NILP (descrip))
708 wv->key = SSDATA (descrip);
709 /* Use the contents index as call_data, since we are
710 restricted to 16-bits. */
711 wv->call_data = !NILP (def) ? (void *) (EMACS_INT) i : 0;
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
720 emacs_abort ();
721
722 wv->selected = !NILP (selected);
723
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 {
733 widget_value *wv_title;
734 widget_value *wv_sep = make_widget_value ("--", NULL, false, Qnil);
735
736 /* Maybe replace this separator with a bitmap or owner-draw item
737 so that it looks better. Having two separators looks odd. */
738 wv_sep->next = first_wv->contents;
739
740 if (unicode_append_menu)
741 title = ENCODE_UTF_8 (title);
742 else if (STRING_MULTIBYTE (title))
743 title = ENCODE_SYSTEM (title);
744
745 wv_title = make_widget_value (SSDATA (title), NULL, true, Qnil);
746 wv_title->title = TRUE;
747 wv_title->button_type = BUTTON_TYPE_NONE;
748 wv_title->next = wv_sep;
749 first_wv->contents = wv_title;
750 }
751
752 /* No selection has been chosen yet. */
753 menu_item_selection = 0;
754
755 /* Actually create the menu. */
756 current_popup_menu = menu = CreatePopupMenu ();
757 fill_in_menu (menu, first_wv->contents);
758
759 /* Adjust coordinates to be root-window-relative. */
760 pos.x = x;
761 pos.y = y;
762 ClientToScreen (FRAME_W32_WINDOW (f), &pos);
763
764 /* Display the menu. */
765 menu_item_selection = SendMessage (FRAME_W32_WINDOW (f),
766 WM_EMACS_TRACKPOPUPMENU,
767 (WPARAM)menu, (LPARAM)&pos);
768
769 /* Clean up extraneous mouse events which might have been generated
770 during the call. */
771 discard_mouse_events ();
772 FRAME_DISPLAY_INFO (f)->grabbed = 0;
773
774 /* Free the widget_value objects we used to specify the contents. */
775 free_menubar_widget_value_tree (first_wv);
776
777 DestroyMenu (menu);
778
779 /* Free the owner-drawn and help-echo menu strings. */
780 w32_free_menu_strings (FRAME_W32_WINDOW (f));
781 f->output_data.w32->menubar_active = 0;
782
783 /* Find the selected item, and its pane, to return
784 the proper value. */
785 if (menu_item_selection != 0)
786 {
787 Lisp_Object prefix, entry;
788
789 prefix = entry = Qnil;
790 i = 0;
791 while (i < menu_items_used)
792 {
793 if (EQ (AREF (menu_items, i), Qnil))
794 {
795 subprefix_stack[submenu_depth++] = prefix;
796 prefix = entry;
797 i++;
798 }
799 else if (EQ (AREF (menu_items, i), Qlambda))
800 {
801 prefix = subprefix_stack[--submenu_depth];
802 i++;
803 }
804 else if (EQ (AREF (menu_items, i), Qt))
805 {
806 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
807 i += MENU_ITEMS_PANE_LENGTH;
808 }
809 /* Ignore a nil in the item list.
810 It's meaningful only for dialog boxes. */
811 else if (EQ (AREF (menu_items, i), Qquote))
812 i += 1;
813 else
814 {
815 entry = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
816 if (menu_item_selection == i)
817 {
818 if (menuflags & MENU_KEYMAPS)
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 }
829 unblock_input ();
830 return entry;
831 }
832 i += MENU_ITEMS_ITEM_LENGTH;
833 }
834 }
835 }
836 else if (!(menuflags & MENU_FOR_CLICK))
837 {
838 unblock_input ();
839 /* Make "Cancel" equivalent to C-g. */
840 Fsignal (Qquit, Qnil);
841 }
842
843 unblock_input ();
844 return Qnil;
845 }
846 \f
847
848 #ifdef HAVE_DIALOGS
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 */
871
872 static char * button_names [] = {
873 "button1", "button2", "button3", "button4", "button5",
874 "button6", "button7", "button8", "button9", "button10" };
875
876 static Lisp_Object
877 w32_dialog_show (struct frame *f, Lisp_Object title,
878 Lisp_Object header, char **error)
879 {
880 int i, nb_buttons = 0;
881 char dialog_name[6];
882 int menu_item_selection;
883
884 widget_value *wv, *first_wv = 0, *prev_wv = 0;
885
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;
890
891 *error = NULL;
892
893 if (menu_items_n_panes > 1)
894 {
895 *error = "Multiple panes in dialog box";
896 return Qnil;
897 }
898
899 /* Create a tree of widget_value objects
900 representing the text label and buttons. */
901 {
902 Lisp_Object pane_name;
903 char *pane_string;
904 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
905 pane_string = (NILP (pane_name)
906 ? "" : SSDATA (pane_name));
907 prev_wv = make_widget_value ("message", pane_string, true, Qnil);
908 first_wv = prev_wv;
909
910 /* Loop over all panes and items, filling in the tree. */
911 i = MENU_ITEMS_PANE_LENGTH;
912 while (i < menu_items_used)
913 {
914
915 /* Create a new item within current pane. */
916 Lisp_Object item_name, enable, descrip, help;
917
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);
922
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 }
937 if (nb_buttons >= 9)
938 {
939 free_menubar_widget_value_tree (first_wv);
940 *error = "Too many dialog items";
941 return Qnil;
942 }
943
944 wv = make_widget_value (button_names[nb_buttons],
945 SSDATA (item_name),
946 !NILP (enable), Qnil);
947 prev_wv->next = wv;
948 if (!NILP (descrip))
949 wv->key = SSDATA (descrip);
950 wv->call_data = aref_addr (menu_items, i);
951 prev_wv = wv;
952
953 if (! boundary_seen)
954 left_count++;
955
956 nb_buttons++;
957 i += MENU_ITEMS_ITEM_LENGTH;
958 }
959
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;
964
965 wv = make_widget_value (dialog_name, NULL, false, Qnil);
966
967 /* Frame title: 'Q' = Question, 'I' = Information.
968 Can also have 'E' = Error if, one day, we want
969 a popup for errors. */
970 if (NILP (header))
971 dialog_name[0] = 'Q';
972 else
973 dialog_name[0] = 'I';
974
975 /* Dialog boxes use a really stupid name encoding
976 which specifies how many buttons to use
977 and how many buttons are on the right. */
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 }
987
988 /* Actually create the dialog. */
989 dialog_id = widget_id_tick++;
990 menu = lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
991 f->output_data.w32->widget, 1, 0,
992 dialog_selection_callback, 0);
993 lw_modify_all_widgets (dialog_id, first_wv->contents, TRUE);
994
995 /* Free the widget_value objects we used to specify the contents. */
996 free_menubar_widget_value_tree (first_wv);
997
998 /* No selection has been chosen yet. */
999 menu_item_selection = 0;
1000
1001 /* Display the menu. */
1002 lw_pop_up_all_widgets (dialog_id);
1003
1004 /* Process events that apply to the menu. */
1005 popup_get_selection ((XEvent *) 0, FRAME_DISPLAY_INFO (f), dialog_id);
1006
1007 lw_destroy_all_widgets (dialog_id);
1008
1009 /* Find the selected item, and its pane, to return
1010 the proper value. */
1011 if (menu_item_selection != 0)
1012 {
1013 i = 0;
1014 while (i < menu_items_used)
1015 {
1016 Lisp_Object entry;
1017
1018 if (EQ (AREF (menu_items, i), Qt))
1019 i += MENU_ITEMS_PANE_LENGTH;
1020 else
1021 {
1022 entry = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1023 if (menu_item_selection == i)
1024 return entry;
1025 i += MENU_ITEMS_ITEM_LENGTH;
1026 }
1027 }
1028 }
1029 else
1030 /* Make "Cancel" equivalent to C-g. */
1031 Fsignal (Qquit, Qnil);
1032
1033 return Qnil;
1034 }
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
1042 static int
1043 is_simple_dialog (Lisp_Object contents)
1044 {
1045 Lisp_Object options;
1046 Lisp_Object name, yes, no, other;
1047
1048 if (!CONSP (contents))
1049 return 0;
1050 options = XCDR (contents);
1051
1052 yes = build_string ("Yes");
1053 no = build_string ("No");
1054
1055 if (!CONSP (options))
1056 return 0;
1057
1058 name = XCAR (options);
1059 if (!CONSP (name))
1060 return 0;
1061 name = XCAR (name);
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
1074 name = XCAR (options);
1075 if (!CONSP (name))
1076 return 0;
1077 name = XCAR (name);
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
1086 static Lisp_Object
1087 simple_dialog_show (struct frame *f, Lisp_Object contents, Lisp_Object header)
1088 {
1089 int answer;
1090 UINT type;
1091 Lisp_Object lispy_answer = Qnil, temp = XCAR (contents);
1092
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. */
1098
1099 /* Use Unicode if possible, so any language can be displayed. */
1100 if (unicode_message_box)
1101 {
1102 WCHAR *text;
1103 const WCHAR *title;
1104 USE_SAFE_ALLOCA;
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);
1114 text = SAFE_ALLOCA ((utf8_len + 1) * sizeof (WCHAR));
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);
1134 SAFE_FREE ();
1135 }
1136 else
1137 {
1138 const char *text, *title;
1139
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 }
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 */
1193 \f
1194
1195 /* UTF8: 0xxxxxxx, 110xxxxx 10xxxxxx, 1110xxxx, 10xxxxxx, 10xxxxxx */
1196 static void
1197 utf8to16 (unsigned char * src, int len, WCHAR * dest)
1198 {
1199 while (len > 0)
1200 {
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
1234 static int
1235 add_menu_item (HMENU menu, widget_value *wv, HMENU item)
1236 {
1237 UINT fuFlags;
1238 char *out_string, *p, *q;
1239 int return_value;
1240 size_t nlen, orig_len;
1241 USE_SAFE_ALLOCA;
1242
1243 if (menu_separator_name_p (wv->name))
1244 {
1245 fuFlags = MF_SEPARATOR;
1246 out_string = NULL;
1247 }
1248 else
1249 {
1250 if (wv->enabled)
1251 fuFlags = MF_STRING;
1252 else
1253 fuFlags = MF_STRING | MF_GRAYED;
1254
1255 if (wv->key != NULL)
1256 {
1257 out_string = SAFE_ALLOCA (strlen (wv->name) + strlen (wv->key) + 2);
1258 strcpy (out_string, wv->name);
1259 strcat (out_string, "\t");
1260 strcat (out_string, wv->key);
1261 }
1262 else
1263 out_string = (char *)wv->name;
1264
1265 /* Quote any special characters within the menu item's text and
1266 key binding. */
1267 nlen = orig_len = strlen (out_string);
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 }
1277 #ifndef NTGUI_UNICODE
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 }
1288 #endif /* !NTGUI_UNICODE */
1289
1290 if (nlen > orig_len)
1291 {
1292 p = out_string;
1293 out_string = SAFE_ALLOCA (nlen + 1);
1294 q = out_string;
1295 while (*p)
1296 {
1297 if (unicode_append_menu)
1298 {
1299 if (*p == '&')
1300 *q++ = *p;
1301 *q++ = *p++;
1302 }
1303 #ifndef NTGUI_UNICODE
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 }
1315 #endif /* !NTGUI_UNICODE */
1316 }
1317 *q = '\0';
1318 }
1319
1320 if (item != NULL)
1321 fuFlags = MF_POPUP;
1322 else if (wv->title || wv->call_data == 0)
1323 {
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 {
1328 out_string = (char *) local_alloc (strlen (wv->name) + 1);
1329 strcpy (out_string, wv->name);
1330 #ifdef MENU_DEBUG
1331 DebPrint ("Menu: allocating %ld for owner-draw", out_string);
1332 #endif
1333 fuFlags = MF_OWNERDRAW | MF_DISABLED;
1334 }
1335 else
1336 fuFlags = MF_DISABLED;
1337 }
1338
1339 /* Draw radio buttons and tickboxes. */
1340 else if (wv->selected && (wv->button_type == BUTTON_TYPE_TOGGLE ||
1341 wv->button_type == BUTTON_TYPE_RADIO))
1342 fuFlags |= MF_CHECKED;
1343 else
1344 fuFlags |= MF_UNCHECKED;
1345 }
1346
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
1355 utf16_string = SAFE_ALLOCA ((utf8_len + 1) * sizeof (WCHAR));
1356
1357 utf8to16 (out_string, utf8_len, utf16_string);
1358 return_value = unicode_append_menu (menu, fuFlags,
1359 item != NULL ? (UINT_PTR) item
1360 : (UINT_PTR) wv->call_data,
1361 utf16_string);
1362
1363 #ifndef NTGUI_UNICODE /* Fallback does not apply when always UNICODE */
1364 if (!return_value)
1365 {
1366 /* On W9x/ME, Unicode menus are not supported, though AppendMenuW
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,
1374 item != NULL ? (UINT_PTR) item: (UINT_PTR) wv->call_data,
1375 out_string);
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;
1381 }
1382 #endif /* NTGUI_UNICODE */
1383
1384 if (unicode_append_menu && (fuFlags & MF_OWNERDRAW))
1385 local_free (out_string);
1386 }
1387 else
1388 {
1389 return_value =
1390 AppendMenu (menu,
1391 fuFlags,
1392 item != NULL ? (UINT_PTR) item : (UINT_PTR) wv->call_data,
1393 out_string );
1394 }
1395
1396 /* This must be done after the menu item is created. */
1397 if (!wv->title && wv->call_data != 0)
1398 {
1399 if (set_menu_item_info)
1400 {
1401 MENUITEMINFO info;
1402 memset (&info, 0, sizeof (info));
1403 info.cbSize = sizeof (info);
1404 info.fMask = MIIM_DATA;
1405
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. */
1409 if (!NILP (wv->help))
1410 {
1411 /* As of Jul-2012, w32api headers say that dwItemData
1412 has DWORD type, but that's a bug: it should actually
1413 be ULONG_PTR, which is correct for 32-bit and 64-bit
1414 Windows alike. MSVC headers get it right; hopefully,
1415 MinGW headers will, too. */
1416 info.dwItemData = (ULONG_PTR) XLI (wv->help);
1417 }
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,
1429 item != NULL ? (UINT_PTR) item : (UINT_PTR) wv->call_data,
1430 FALSE, &info);
1431 }
1432 }
1433 SAFE_FREE ();
1434 return return_value;
1435 }
1436
1437 /* Construct native Windows menu(bar) based on widget_value tree. */
1438 static int
1439 fill_in_menu (HMENU menu, widget_value *wv)
1440 {
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
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. */
1469 void
1470 w32_menu_display_help (HWND owner, HMENU menu, UINT item, UINT flags)
1471 {
1472 if (get_menu_item_info)
1473 {
1474 struct frame *f = x_window_to_frame (&one_w32_display_info, owner);
1475 Lisp_Object frame, help;
1476
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))
1482 help = Qnil;
1483 else
1484 {
1485 MENUITEMINFO info;
1486
1487 memset (&info, 0, sizeof (info));
1488 info.cbSize = sizeof (info);
1489 info.fMask = MIIM_DATA;
1490 get_menu_item_info (menu, item, FALSE, &info);
1491
1492 help = info.dwItemData ? XIL (info.dwItemData) : Qnil;
1493 }
1494
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. */
1507 show_help_echo (help, Qnil, Qnil, Qnil);
1508 }
1509 }
1510
1511 /* Free memory used by owner-drawn strings. */
1512 static void
1513 w32_free_submenu_strings (HMENU menu)
1514 {
1515 int i, num = GetMenuItemCount (menu);
1516 for (i = 0; i < num; i++)
1517 {
1518 MENUITEMINFO info;
1519 memset (&info, 0, sizeof (info));
1520 info.cbSize = sizeof (info);
1521 info.fMask = MIIM_DATA | MIIM_TYPE | MIIM_SUBMENU;
1522
1523 get_menu_item_info (menu, i, TRUE, &info);
1524
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
1531 local_free (info.dwItemData);
1532 }
1533
1534 /* Recurse down submenus. */
1535 if (info.hSubMenu)
1536 w32_free_submenu_strings (info.hSubMenu);
1537 }
1538 }
1539
1540 void
1541 w32_free_menu_strings (HWND hwnd)
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 }
1558
1559 /* The following is used by delayed window autoselection. */
1560
1561 DEFUN ("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. */)
1563 (void)
1564 {
1565 struct frame *f;
1566 f = SELECTED_FRAME ();
1567 return (f->output_data.w32->menubar_active > 0) ? Qt : Qnil;
1568 }
1569
1570 void
1571 syms_of_w32menu (void)
1572 {
1573 #include "w32menu.x"
1574
1575 globals_of_w32menu ();
1576
1577 current_popup_menu = NULL;
1578
1579 DEFSYM (Qdebug_on_next_call, "debug-on-next-call");
1580 DEFSYM (Qunsupported__w32_dialog, "unsupported--w32-dialog");
1581 }
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 */
1591 void
1592 globals_of_w32menu (void)
1593 {
1594 #ifndef NTGUI_UNICODE
1595 /* See if Get/SetMenuItemInfo functions are available. */
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");
1599 unicode_append_menu = (AppendMenuW_Proc) GetProcAddress (user32, "AppendMenuW");
1600 unicode_message_box = (MessageBoxW_Proc) GetProcAddress (user32, "MessageBoxW");
1601 #endif /* !NTGUI_UNICODE */
1602 }