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