(latexenc-find-file-coding-system): Don't inherit the EOL part of the
[emacs.git] / src / w32menu.c
blob8a90eae7ec77e18b723b25f04a7cc24629bf02fe
1 /* Menu support for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1986,88,93,94,96,98,1999,2003 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #include <config.h>
22 #include <signal.h>
24 #include <stdio.h>
25 #include "lisp.h"
26 #include "termhooks.h"
27 #include "keyboard.h"
28 #include "keymap.h"
29 #include "frame.h"
30 #include "window.h"
31 #include "blockinput.h"
32 #include "buffer.h"
33 #include "charset.h"
34 #include "coding.h"
36 /* This may include sys/types.h, and that somehow loses
37 if this is not done before the other system files. */
38 #include "w32term.h"
40 /* Load sys/types.h if not already loaded.
41 In some systems loading it twice is suicidal. */
42 #ifndef makedev
43 #include <sys/types.h>
44 #endif
46 #include "dispextern.h"
48 #undef HAVE_DIALOGS /* TODO: Implement native dialogs. */
50 /******************************************************************/
51 /* Definitions copied from lwlib.h */
53 typedef void * XtPointer;
54 typedef char Boolean;
56 enum button_type
58 BUTTON_TYPE_NONE,
59 BUTTON_TYPE_TOGGLE,
60 BUTTON_TYPE_RADIO
63 /* This structure is based on the one in ../lwlib/lwlib.h, modified
64 for Windows. */
65 typedef struct _widget_value
67 /* name of widget */
68 Lisp_Object lname;
69 char* name;
70 /* value (meaning depend on widget type) */
71 char* value;
72 /* keyboard equivalent. no implications for XtTranslations */
73 Lisp_Object lkey;
74 char* key;
75 /* Help string or nil if none.
76 GC finds this string through the frame's menu_bar_vector
77 or through menu_items. */
78 Lisp_Object help;
79 /* true if enabled */
80 Boolean enabled;
81 /* true if selected */
82 Boolean selected;
83 /* The type of a button. */
84 enum button_type button_type;
85 /* true if menu title */
86 Boolean title;
87 #if 0
88 /* true if was edited (maintained by get_value) */
89 Boolean edited;
90 /* true if has changed (maintained by lw library) */
91 change_type change;
92 /* true if this widget itself has changed,
93 but not counting the other widgets found in the `next' field. */
94 change_type this_one_change;
95 #endif
96 /* Contents of the sub-widgets, also selected slot for checkbox */
97 struct _widget_value* contents;
98 /* data passed to callback */
99 XtPointer call_data;
100 /* next one in the list */
101 struct _widget_value* next;
102 #if 0
103 /* slot for the toolkit dependent part. Always initialize to NULL. */
104 void* toolkit_data;
105 /* tell us if we should free the toolkit data slot when freeing the
106 widget_value itself. */
107 Boolean free_toolkit_data;
109 /* we resource the widget_value structures; this points to the next
110 one on the free list if this one has been deallocated.
112 struct _widget_value *free_list;
113 #endif
114 } widget_value;
116 /* Local memory management */
117 #define local_heap (GetProcessHeap ())
118 #define local_alloc(n) (HeapAlloc (local_heap, HEAP_ZERO_MEMORY, (n)))
119 #define local_free(p) (HeapFree (local_heap, 0, ((LPVOID) (p))))
121 #define malloc_widget_value() ((widget_value *) local_alloc (sizeof (widget_value)))
122 #define free_widget_value(wv) (local_free ((wv)))
124 /******************************************************************/
126 #ifndef TRUE
127 #define TRUE 1
128 #define FALSE 0
129 #endif /* no TRUE */
131 static HMENU current_popup_menu;
133 void syms_of_w32menu ();
134 void globals_of_w32menu ();
136 typedef BOOL (WINAPI * GetMenuItemInfoA_Proc) (
137 IN HMENU,
138 IN UINT,
139 IN BOOL,
140 IN OUT LPMENUITEMINFOA);
141 typedef BOOL (WINAPI * SetMenuItemInfoA_Proc) (
142 IN HMENU,
143 IN UINT,
144 IN BOOL,
145 IN LPCMENUITEMINFOA);
147 GetMenuItemInfoA_Proc get_menu_item_info = NULL;
148 SetMenuItemInfoA_Proc set_menu_item_info = NULL;
149 AppendMenuW_Proc unicode_append_menu = NULL;
151 Lisp_Object Vmenu_updating_frame;
153 Lisp_Object Qdebug_on_next_call;
155 extern Lisp_Object Qmenu_bar;
157 extern Lisp_Object QCtoggle, QCradio;
159 extern Lisp_Object Voverriding_local_map;
160 extern Lisp_Object Voverriding_local_map_menu_flag;
162 extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
164 extern Lisp_Object Qmenu_bar_update_hook;
166 void set_frame_menubar ();
168 static void push_menu_item P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
169 Lisp_Object, Lisp_Object, Lisp_Object,
170 Lisp_Object, Lisp_Object));
171 #ifdef HAVE_DIALOGS
172 static Lisp_Object w32_dialog_show ();
173 #endif
174 static Lisp_Object w32_menu_show ();
176 static void keymap_panes ();
177 static void single_keymap_panes ();
178 static void single_menu_item ();
179 static void list_of_panes ();
180 static void list_of_items ();
181 void w32_free_menu_strings (HWND);
183 /* This holds a Lisp vector that holds the results of decoding
184 the keymaps or alist-of-alists that specify a menu.
186 It describes the panes and items within the panes.
188 Each pane is described by 3 elements in the vector:
189 t, the pane name, the pane's prefix key.
190 Then follow the pane's items, with 5 elements per item:
191 the item string, the enable flag, the item's value,
192 the definition, and the equivalent keyboard key's description string.
194 In some cases, multiple levels of menus may be described.
195 A single vector slot containing nil indicates the start of a submenu.
196 A single vector slot containing lambda indicates the end of a submenu.
197 The submenu follows a menu item which is the way to reach the submenu.
199 A single vector slot containing quote indicates that the
200 following items should appear on the right of a dialog box.
202 Using a Lisp vector to hold this information while we decode it
203 takes care of protecting all the data from GC. */
205 #define MENU_ITEMS_PANE_NAME 1
206 #define MENU_ITEMS_PANE_PREFIX 2
207 #define MENU_ITEMS_PANE_LENGTH 3
209 enum menu_item_idx
211 MENU_ITEMS_ITEM_NAME = 0,
212 MENU_ITEMS_ITEM_ENABLE,
213 MENU_ITEMS_ITEM_VALUE,
214 MENU_ITEMS_ITEM_EQUIV_KEY,
215 MENU_ITEMS_ITEM_DEFINITION,
216 MENU_ITEMS_ITEM_TYPE,
217 MENU_ITEMS_ITEM_SELECTED,
218 MENU_ITEMS_ITEM_HELP,
219 MENU_ITEMS_ITEM_LENGTH
222 static Lisp_Object menu_items;
224 /* Number of slots currently allocated in menu_items. */
225 static int menu_items_allocated;
227 /* This is the index in menu_items of the first empty slot. */
228 static int menu_items_used;
230 /* The number of panes currently recorded in menu_items,
231 excluding those within submenus. */
232 static int menu_items_n_panes;
234 /* Current depth within submenus. */
235 static int menu_items_submenu_depth;
237 /* Flag which when set indicates a dialog or menu has been posted by
238 Xt on behalf of one of the widget sets. */
239 static int popup_activated_flag;
241 static int next_menubar_widget_id;
243 /* This is set nonzero after the user activates the menu bar, and set
244 to zero again after the menu bars are redisplayed by prepare_menu_bar.
245 While it is nonzero, all calls to set_frame_menubar go deep.
247 I don't understand why this is needed, but it does seem to be
248 needed on Motif, according to Marcus Daniels <marcus@sysc.pdx.edu>. */
250 int pending_menu_activation;
253 /* Return the frame whose ->output_data.w32->menubar_widget equals
254 ID, or 0 if none. */
256 static struct frame *
257 menubar_id_to_frame (id)
258 HMENU id;
260 Lisp_Object tail, frame;
261 FRAME_PTR f;
263 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
265 frame = XCAR (tail);
266 if (!GC_FRAMEP (frame))
267 continue;
268 f = XFRAME (frame);
269 if (!FRAME_WINDOW_P (f))
270 continue;
271 if (f->output_data.w32->menubar_widget == id)
272 return f;
274 return 0;
277 /* Initialize the menu_items structure if we haven't already done so.
278 Also mark it as currently empty. */
280 static void
281 init_menu_items ()
283 if (NILP (menu_items))
285 menu_items_allocated = 60;
286 menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
289 menu_items_used = 0;
290 menu_items_n_panes = 0;
291 menu_items_submenu_depth = 0;
294 /* Call at the end of generating the data in menu_items.
295 This fills in the number of items in the last pane. */
297 static void
298 finish_menu_items ()
302 /* Call when finished using the data for the current menu
303 in menu_items. */
305 static void
306 discard_menu_items ()
308 /* Free the structure if it is especially large.
309 Otherwise, hold on to it, to save time. */
310 if (menu_items_allocated > 200)
312 menu_items = Qnil;
313 menu_items_allocated = 0;
317 /* Make the menu_items vector twice as large. */
319 static void
320 grow_menu_items ()
322 Lisp_Object old;
323 int old_size = menu_items_allocated;
324 old = menu_items;
326 menu_items_allocated *= 2;
327 menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
328 bcopy (XVECTOR (old)->contents, XVECTOR (menu_items)->contents,
329 old_size * sizeof (Lisp_Object));
332 /* Begin a submenu. */
334 static void
335 push_submenu_start ()
337 if (menu_items_used + 1 > menu_items_allocated)
338 grow_menu_items ();
340 ASET (menu_items, menu_items_used++, Qnil);
341 menu_items_submenu_depth++;
344 /* End a submenu. */
346 static void
347 push_submenu_end ()
349 if (menu_items_used + 1 > menu_items_allocated)
350 grow_menu_items ();
352 ASET (menu_items, menu_items_used++, Qlambda);
353 menu_items_submenu_depth--;
356 /* Indicate boundary between left and right. */
358 static void
359 push_left_right_boundary ()
361 if (menu_items_used + 1 > menu_items_allocated)
362 grow_menu_items ();
364 ASET (menu_items, menu_items_used++, Qquote);
367 /* Start a new menu pane in menu_items.
368 NAME is the pane name. PREFIX_VEC is a prefix key for this pane. */
370 static void
371 push_menu_pane (name, prefix_vec)
372 Lisp_Object name, prefix_vec;
374 if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
375 grow_menu_items ();
377 if (menu_items_submenu_depth == 0)
378 menu_items_n_panes++;
379 ASET (menu_items, menu_items_used++, Qt);
380 ASET (menu_items, menu_items_used++, name);
381 ASET (menu_items, menu_items_used++, prefix_vec);
384 /* Push one menu item into the current pane. NAME is the string to
385 display. ENABLE if non-nil means this item can be selected. KEY
386 is the key generated by choosing this item, or nil if this item
387 doesn't really have a definition. DEF is the definition of this
388 item. EQUIV is the textual description of the keyboard equivalent
389 for this item (or nil if none). TYPE is the type of this menu
390 item, one of nil, `toggle' or `radio'. */
392 static void
393 push_menu_item (name, enable, key, def, equiv, type, selected, help)
394 Lisp_Object name, enable, key, def, equiv, type, selected, help;
396 if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
397 grow_menu_items ();
399 ASET (menu_items, menu_items_used++, name);
400 ASET (menu_items, menu_items_used++, enable);
401 ASET (menu_items, menu_items_used++, key);
402 ASET (menu_items, menu_items_used++, equiv);
403 ASET (menu_items, menu_items_used++, def);
404 ASET (menu_items, menu_items_used++, type);
405 ASET (menu_items, menu_items_used++, selected);
406 ASET (menu_items, menu_items_used++, help);
409 /* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
410 and generate menu panes for them in menu_items.
411 If NOTREAL is nonzero,
412 don't bother really computing whether an item is enabled. */
414 static void
415 keymap_panes (keymaps, nmaps, notreal)
416 Lisp_Object *keymaps;
417 int nmaps;
418 int notreal;
420 int mapno;
422 init_menu_items ();
424 /* Loop over the given keymaps, making a pane for each map.
425 But don't make a pane that is empty--ignore that map instead.
426 P is the number of panes we have made so far. */
427 for (mapno = 0; mapno < nmaps; mapno++)
428 single_keymap_panes (keymaps[mapno],
429 Fkeymap_prompt (keymaps[mapno]), Qnil, notreal, 10);
431 finish_menu_items ();
434 /* This is a recursive subroutine of keymap_panes.
435 It handles one keymap, KEYMAP.
436 The other arguments are passed along
437 or point to local variables of the previous function.
438 If NOTREAL is nonzero, only check for equivalent key bindings, don't
439 evaluate expressions in menu items and don't make any menu.
441 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
443 static void
444 single_keymap_panes (keymap, pane_name, prefix, notreal, maxdepth)
445 Lisp_Object keymap;
446 Lisp_Object pane_name;
447 Lisp_Object prefix;
448 int notreal;
449 int maxdepth;
451 Lisp_Object pending_maps = Qnil;
452 Lisp_Object tail, item;
453 struct gcpro gcpro1, gcpro2;
455 if (maxdepth <= 0)
456 return;
458 push_menu_pane (pane_name, prefix);
460 for (tail = keymap; CONSP (tail); tail = XCDR (tail))
462 GCPRO2 (keymap, pending_maps);
463 /* Look at each key binding, and if it is a menu item add it
464 to this menu. */
465 item = XCAR (tail);
466 if (CONSP (item))
467 single_menu_item (XCAR (item), XCDR (item),
468 &pending_maps, notreal, maxdepth);
469 else if (VECTORP (item))
471 /* Loop over the char values represented in the vector. */
472 int len = ASIZE (item);
473 int c;
474 for (c = 0; c < len; c++)
476 Lisp_Object character;
477 XSETFASTINT (character, c);
478 single_menu_item (character, AREF (item, c),
479 &pending_maps, notreal, maxdepth);
482 UNGCPRO;
485 /* Process now any submenus which want to be panes at this level. */
486 while (!NILP (pending_maps))
488 Lisp_Object elt, eltcdr, string;
489 elt = Fcar (pending_maps);
490 eltcdr = XCDR (elt);
491 string = XCAR (eltcdr);
492 /* We no longer discard the @ from the beginning of the string here.
493 Instead, we do this in w32_menu_show. */
494 single_keymap_panes (Fcar (elt), string,
495 XCDR (eltcdr), notreal, maxdepth - 1);
496 pending_maps = Fcdr (pending_maps);
500 /* This is a subroutine of single_keymap_panes that handles one
501 keymap entry.
502 KEY is a key in a keymap and ITEM is its binding.
503 PENDING_MAPS_PTR points to a list of keymaps waiting to be made into
504 separate panes.
505 If NOTREAL is nonzero, only check for equivalent key bindings, don't
506 evaluate expressions in menu items and don't make any menu.
507 If we encounter submenus deeper than MAXDEPTH levels, ignore them. */
509 static void
510 single_menu_item (key, item, pending_maps_ptr, notreal, maxdepth)
511 Lisp_Object key, item;
512 Lisp_Object *pending_maps_ptr;
513 int maxdepth, notreal;
515 Lisp_Object map, item_string, enabled;
516 struct gcpro gcpro1, gcpro2;
517 int res;
519 /* Parse the menu item and leave the result in item_properties. */
520 GCPRO2 (key, item);
521 res = parse_menu_item (item, notreal, 0);
522 UNGCPRO;
523 if (!res)
524 return; /* Not a menu item. */
526 map = AREF (item_properties, ITEM_PROPERTY_MAP);
528 if (notreal)
530 /* We don't want to make a menu, just traverse the keymaps to
531 precompute equivalent key bindings. */
532 if (!NILP (map))
533 single_keymap_panes (map, Qnil, key, 1, maxdepth - 1);
534 return;
537 enabled = AREF (item_properties, ITEM_PROPERTY_ENABLE);
538 item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
540 if (!NILP (map) && SREF (item_string, 0) == '@')
542 if (!NILP (enabled))
543 /* An enabled separate pane. Remember this to handle it later. */
544 *pending_maps_ptr = Fcons (Fcons (map, Fcons (item_string, key)),
545 *pending_maps_ptr);
546 return;
549 push_menu_item (item_string, enabled, key,
550 AREF (item_properties, ITEM_PROPERTY_DEF),
551 AREF (item_properties, ITEM_PROPERTY_KEYEQ),
552 AREF (item_properties, ITEM_PROPERTY_TYPE),
553 AREF (item_properties, ITEM_PROPERTY_SELECTED),
554 AREF (item_properties, ITEM_PROPERTY_HELP));
556 /* Display a submenu using the toolkit. */
557 if (! (NILP (map) || NILP (enabled)))
559 push_submenu_start ();
560 single_keymap_panes (map, Qnil, key, 0, maxdepth - 1);
561 push_submenu_end ();
565 /* Push all the panes and items of a menu described by the
566 alist-of-alists MENU.
567 This handles old-fashioned calls to x-popup-menu. */
569 static void
570 list_of_panes (menu)
571 Lisp_Object menu;
573 Lisp_Object tail;
575 init_menu_items ();
577 for (tail = menu; !NILP (tail); tail = Fcdr (tail))
579 Lisp_Object elt, pane_name, pane_data;
580 elt = Fcar (tail);
581 pane_name = Fcar (elt);
582 CHECK_STRING (pane_name);
583 push_menu_pane (pane_name, Qnil);
584 pane_data = Fcdr (elt);
585 CHECK_CONS (pane_data);
586 list_of_items (pane_data);
589 finish_menu_items ();
592 /* Push the items in a single pane defined by the alist PANE. */
594 static void
595 list_of_items (pane)
596 Lisp_Object pane;
598 Lisp_Object tail, item, item1;
600 for (tail = pane; !NILP (tail); tail = Fcdr (tail))
602 item = Fcar (tail);
603 if (STRINGP (item))
604 push_menu_item (item, Qnil, Qnil, Qt, Qnil, Qnil, Qnil, Qnil);
605 else if (NILP (item))
606 push_left_right_boundary ();
607 else
609 CHECK_CONS (item);
610 item1 = Fcar (item);
611 CHECK_STRING (item1);
612 push_menu_item (item1, Qt, Fcdr (item), Qt, Qnil, Qnil, Qnil, Qnil);
617 DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
618 doc: /* Pop up a deck-of-cards menu and return user's selection.
619 POSITION is a position specification. This is either a mouse button
620 event or a list ((XOFFSET YOFFSET) WINDOW) where XOFFSET and YOFFSET
621 are positions in pixels from the top left corner of WINDOW's frame
622 \(WINDOW may be a frame object instead of a window). This controls the
623 position of the center of the first line in the first pane of the
624 menu, not the top left of the menu as a whole. If POSITION is t, it
625 means to use the current mouse position.
627 MENU is a specifier for a menu. For the simplest case, MENU is a keymap.
628 The menu items come from key bindings that have a menu string as well as
629 a definition; actually, the \"definition\" in such a key binding looks like
630 \(STRING . REAL-DEFINITION). To give the menu a title, put a string into
631 the keymap as a top-level element.
633 If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
634 Otherwise, REAL-DEFINITION should be a valid key binding definition.
636 You can also use a list of keymaps as MENU. Then each keymap makes a
637 separate pane. When MENU is a keymap or a list of keymaps, the return
638 value is a list of events.
640 Alternatively, you can specify a menu of multiple panes with a list of
641 the form (TITLE PANE1 PANE2...), where each pane is a list of
642 form (TITLE ITEM1 ITEM2...).
643 Each ITEM is normally a cons cell (STRING . VALUE); but a string can
644 appear as an item--that makes a nonselectable line in the menu.
645 With this form of menu, the return value is VALUE from the chosen item.
647 If POSITION is nil, don't display the menu at all, just precalculate the
648 cached information about equivalent key sequences. */)
649 (position, menu)
650 Lisp_Object position, menu;
652 Lisp_Object keymap, tem;
653 int xpos = 0, ypos = 0;
654 Lisp_Object title;
655 char *error_name;
656 Lisp_Object selection;
657 FRAME_PTR f = NULL;
658 Lisp_Object x, y, window;
659 int keymaps = 0;
660 int for_click = 0;
661 struct gcpro gcpro1;
663 #ifdef HAVE_MENUS
664 if (! NILP (position))
666 check_w32 ();
668 /* Decode the first argument: find the window and the coordinates. */
669 if (EQ (position, Qt)
670 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
671 || EQ (XCAR (position), Qtool_bar))))
673 /* Use the mouse's current position. */
674 FRAME_PTR new_f = SELECTED_FRAME ();
675 Lisp_Object bar_window;
676 enum scroll_bar_part part;
677 unsigned long time;
679 if (mouse_position_hook)
680 (*mouse_position_hook) (&new_f, 1, &bar_window,
681 &part, &x, &y, &time);
682 if (new_f != 0)
683 XSETFRAME (window, new_f);
684 else
686 window = selected_window;
687 XSETFASTINT (x, 0);
688 XSETFASTINT (y, 0);
691 else
693 tem = Fcar (position);
694 if (CONSP (tem))
696 window = Fcar (Fcdr (position));
697 x = Fcar (tem);
698 y = Fcar (Fcdr (tem));
700 else
702 for_click = 1;
703 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
704 window = Fcar (tem); /* POSN_WINDOW (tem) */
705 tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */
706 x = Fcar (tem);
707 y = Fcdr (tem);
711 CHECK_NUMBER (x);
712 CHECK_NUMBER (y);
714 /* Decode where to put the menu. */
716 if (FRAMEP (window))
718 f = XFRAME (window);
719 xpos = 0;
720 ypos = 0;
722 else if (WINDOWP (window))
724 CHECK_LIVE_WINDOW (window);
725 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
727 xpos = WINDOW_LEFT_EDGE_X (XWINDOW (window));
728 ypos = WINDOW_TOP_EDGE_Y (XWINDOW (window));
730 else
731 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
732 but I don't want to make one now. */
733 CHECK_WINDOW (window);
735 xpos += XINT (x);
736 ypos += XINT (y);
738 XSETFRAME (Vmenu_updating_frame, f);
740 Vmenu_updating_frame = Qnil;
741 #endif /* HAVE_MENUS */
743 title = Qnil;
744 GCPRO1 (title);
746 /* Decode the menu items from what was specified. */
748 keymap = get_keymap (menu, 0, 0);
749 if (CONSP (keymap))
751 /* We were given a keymap. Extract menu info from the keymap. */
752 Lisp_Object prompt;
754 /* Extract the detailed info to make one pane. */
755 keymap_panes (&menu, 1, NILP (position));
757 /* Search for a string appearing directly as an element of the keymap.
758 That string is the title of the menu. */
759 prompt = Fkeymap_prompt (keymap);
760 if (NILP (title) && !NILP (prompt))
761 title = prompt;
763 /* Make that be the pane title of the first pane. */
764 if (!NILP (prompt) && menu_items_n_panes >= 0)
765 ASET (menu_items, MENU_ITEMS_PANE_NAME, prompt);
767 keymaps = 1;
769 else if (CONSP (menu) && KEYMAPP (XCAR (menu)))
771 /* We were given a list of keymaps. */
772 int nmaps = XFASTINT (Flength (menu));
773 Lisp_Object *maps
774 = (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
775 int i;
777 title = Qnil;
779 /* The first keymap that has a prompt string
780 supplies the menu title. */
781 for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
783 Lisp_Object prompt;
785 maps[i++] = keymap = get_keymap (Fcar (tem), 1, 0);
787 prompt = Fkeymap_prompt (keymap);
788 if (NILP (title) && !NILP (prompt))
789 title = prompt;
792 /* Extract the detailed info to make one pane. */
793 keymap_panes (maps, nmaps, NILP (position));
795 /* Make the title be the pane title of the first pane. */
796 if (!NILP (title) && menu_items_n_panes >= 0)
797 ASET (menu_items, MENU_ITEMS_PANE_NAME, title);
799 keymaps = 1;
801 else
803 /* We were given an old-fashioned menu. */
804 title = Fcar (menu);
805 CHECK_STRING (title);
807 list_of_panes (Fcdr (menu));
809 keymaps = 0;
812 if (NILP (position))
814 discard_menu_items ();
815 UNGCPRO;
816 return Qnil;
819 #ifdef HAVE_MENUS
820 /* If resources from a previous popup menu exist yet, does nothing
821 until the `menu_free_timer' has freed them (see w32fns.c).
823 if (current_popup_menu)
825 discard_menu_items ();
826 UNGCPRO;
827 return Qnil;
830 /* Display them in a menu. */
831 BLOCK_INPUT;
833 selection = w32_menu_show (f, xpos, ypos, for_click,
834 keymaps, title, &error_name);
835 UNBLOCK_INPUT;
837 discard_menu_items ();
838 #endif /* HAVE_MENUS */
840 UNGCPRO;
842 if (error_name) error (error_name);
843 return selection;
846 #ifdef HAVE_MENUS
848 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
849 doc: /* Pop up a dialog box and return user's selection.
850 POSITION specifies which frame to use.
851 This is normally a mouse button event or a window or frame.
852 If POSITION is t, it means to use the frame the mouse is on.
853 The dialog box appears in the middle of the specified frame.
855 CONTENTS specifies the alternatives to display in the dialog box.
856 It is a list of the form (TITLE ITEM1 ITEM2...).
857 Each ITEM is a cons cell (STRING . VALUE).
858 The return value is VALUE from the chosen item.
860 An ITEM may also be just a string--that makes a nonselectable item.
861 An ITEM may also be nil--that means to put all preceding items
862 on the left of the dialog box and all following items on the right.
863 \(By default, approximately half appear on each side.)
865 If HEADER is non-nil, the frame title for the box is "Information",
866 otherwise it is "Question". */)
867 (position, contents, header)
868 Lisp_Object position, contents, header;
870 FRAME_PTR f = NULL;
871 Lisp_Object window;
873 check_w32 ();
875 /* Decode the first argument: find the window or frame to use. */
876 if (EQ (position, Qt)
877 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
878 || EQ (XCAR (position), Qtool_bar))))
880 #if 0 /* Using the frame the mouse is on may not be right. */
881 /* Use the mouse's current position. */
882 FRAME_PTR new_f = SELECTED_FRAME ();
883 Lisp_Object bar_window;
884 enum scroll_bar_part part;
885 unsigned long time;
886 Lisp_Object x, y;
888 (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
890 if (new_f != 0)
891 XSETFRAME (window, new_f);
892 else
893 window = selected_window;
894 #endif
895 window = selected_window;
897 else if (CONSP (position))
899 Lisp_Object tem;
900 tem = Fcar (position);
901 if (CONSP (tem))
902 window = Fcar (Fcdr (position));
903 else
905 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
906 window = Fcar (tem); /* POSN_WINDOW (tem) */
909 else if (WINDOWP (position) || FRAMEP (position))
910 window = position;
911 else
912 window = Qnil;
914 /* Decode where to put the menu. */
916 if (FRAMEP (window))
917 f = XFRAME (window);
918 else if (WINDOWP (window))
920 CHECK_LIVE_WINDOW (window);
921 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
923 else
924 /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
925 but I don't want to make one now. */
926 CHECK_WINDOW (window);
928 #ifndef HAVE_DIALOGS
929 /* Display a menu with these alternatives
930 in the middle of frame F. */
932 Lisp_Object x, y, frame, newpos;
933 XSETFRAME (frame, f);
934 XSETINT (x, x_pixel_width (f) / 2);
935 XSETINT (y, x_pixel_height (f) / 2);
936 newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));
938 return Fx_popup_menu (newpos,
939 Fcons (Fcar (contents), Fcons (contents, Qnil)));
941 #else /* HAVE_DIALOGS */
943 Lisp_Object title;
944 char *error_name;
945 Lisp_Object selection;
947 /* Decode the dialog items from what was specified. */
948 title = Fcar (contents);
949 CHECK_STRING (title);
951 list_of_panes (Fcons (contents, Qnil));
953 /* Display them in a dialog box. */
954 BLOCK_INPUT;
955 selection = w32_dialog_show (f, 0, title, header, &error_name);
956 UNBLOCK_INPUT;
958 discard_menu_items ();
960 if (error_name) error (error_name);
961 return selection;
963 #endif /* HAVE_DIALOGS */
966 /* Activate the menu bar of frame F.
967 This is called from keyboard.c when it gets the
968 MENU_BAR_ACTIVATE_EVENT out of the Emacs event queue.
970 To activate the menu bar, we signal to the input thread that it can
971 return from the WM_INITMENU message, allowing the normal Windows
972 processing of the menus.
974 But first we recompute the menu bar contents (the whole tree).
976 This way we can safely execute Lisp code. */
978 void
979 x_activate_menubar (f)
980 FRAME_PTR f;
982 set_frame_menubar (f, 0, 1);
984 /* Lock out further menubar changes while active. */
985 f->output_data.w32->menubar_active = 1;
987 /* Signal input thread to return from WM_INITMENU. */
988 complete_deferred_msg (FRAME_W32_WINDOW (f), WM_INITMENU, 0);
991 /* This callback is called from the menu bar pulldown menu
992 when the user makes a selection.
993 Figure out what the user chose
994 and put the appropriate events into the keyboard buffer. */
996 void
997 menubar_selection_callback (FRAME_PTR f, void * client_data)
999 Lisp_Object prefix, entry;
1000 Lisp_Object vector;
1001 Lisp_Object *subprefix_stack;
1002 int submenu_depth = 0;
1003 int i;
1005 if (!f)
1006 return;
1007 entry = Qnil;
1008 subprefix_stack = (Lisp_Object *) alloca (f->menu_bar_items_used * sizeof (Lisp_Object));
1009 vector = f->menu_bar_vector;
1010 prefix = Qnil;
1011 i = 0;
1012 while (i < f->menu_bar_items_used)
1014 if (EQ (AREF (vector, i), Qnil))
1016 subprefix_stack[submenu_depth++] = prefix;
1017 prefix = entry;
1018 i++;
1020 else if (EQ (AREF (vector, i), Qlambda))
1022 prefix = subprefix_stack[--submenu_depth];
1023 i++;
1025 else if (EQ (AREF (vector, i), Qt))
1027 prefix = AREF (vector, i + MENU_ITEMS_PANE_PREFIX);
1028 i += MENU_ITEMS_PANE_LENGTH;
1030 else
1032 entry = AREF (vector, i + MENU_ITEMS_ITEM_VALUE);
1033 /* The EMACS_INT cast avoids a warning. There's no problem
1034 as long as pointers have enough bits to hold small integers. */
1035 if ((int) (EMACS_INT) client_data == i)
1037 int j;
1038 struct input_event buf;
1039 Lisp_Object frame;
1040 EVENT_INIT (buf);
1042 XSETFRAME (frame, f);
1043 buf.kind = MENU_BAR_EVENT;
1044 buf.frame_or_window = frame;
1045 buf.arg = frame;
1046 kbd_buffer_store_event (&buf);
1048 for (j = 0; j < submenu_depth; j++)
1049 if (!NILP (subprefix_stack[j]))
1051 buf.kind = MENU_BAR_EVENT;
1052 buf.frame_or_window = frame;
1053 buf.arg = subprefix_stack[j];
1054 kbd_buffer_store_event (&buf);
1057 if (!NILP (prefix))
1059 buf.kind = MENU_BAR_EVENT;
1060 buf.frame_or_window = frame;
1061 buf.arg = prefix;
1062 kbd_buffer_store_event (&buf);
1065 buf.kind = MENU_BAR_EVENT;
1066 buf.frame_or_window = frame;
1067 buf.arg = entry;
1068 kbd_buffer_store_event (&buf);
1070 /* Free memory used by owner-drawn and help-echo strings. */
1071 w32_free_menu_strings (FRAME_W32_WINDOW (f));
1072 f->output_data.w32->menu_command_in_progress = 0;
1073 f->output_data.w32->menubar_active = 0;
1074 return;
1076 i += MENU_ITEMS_ITEM_LENGTH;
1079 /* Free memory used by owner-drawn and help-echo strings. */
1080 w32_free_menu_strings (FRAME_W32_WINDOW (f));
1081 f->output_data.w32->menu_command_in_progress = 0;
1082 f->output_data.w32->menubar_active = 0;
1085 /* Allocate a widget_value, blocking input. */
1087 widget_value *
1088 xmalloc_widget_value ()
1090 widget_value *value;
1092 BLOCK_INPUT;
1093 value = malloc_widget_value ();
1094 UNBLOCK_INPUT;
1096 return value;
1099 /* This recursively calls free_widget_value on the tree of widgets.
1100 It must free all data that was malloc'ed for these widget_values.
1101 In Emacs, many slots are pointers into the data of Lisp_Strings, and
1102 must be left alone. */
1104 void
1105 free_menubar_widget_value_tree (wv)
1106 widget_value *wv;
1108 if (! wv) return;
1110 wv->name = wv->value = wv->key = (char *) 0xDEADBEEF;
1112 if (wv->contents && (wv->contents != (widget_value*)1))
1114 free_menubar_widget_value_tree (wv->contents);
1115 wv->contents = (widget_value *) 0xDEADBEEF;
1117 if (wv->next)
1119 free_menubar_widget_value_tree (wv->next);
1120 wv->next = (widget_value *) 0xDEADBEEF;
1122 BLOCK_INPUT;
1123 free_widget_value (wv);
1124 UNBLOCK_INPUT;
1127 /* Set up data i menu_items for a menu bar item
1128 whose event type is ITEM_KEY (with string ITEM_NAME)
1129 and whose contents come from the list of keymaps MAPS. */
1131 static int
1132 parse_single_submenu (item_key, item_name, maps)
1133 Lisp_Object item_key, item_name, maps;
1135 Lisp_Object length;
1136 int len;
1137 Lisp_Object *mapvec;
1138 int i;
1139 int top_level_items = 0;
1141 length = Flength (maps);
1142 len = XINT (length);
1144 /* Convert the list MAPS into a vector MAPVEC. */
1145 mapvec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));
1146 for (i = 0; i < len; i++)
1148 mapvec[i] = Fcar (maps);
1149 maps = Fcdr (maps);
1152 /* Loop over the given keymaps, making a pane for each map.
1153 But don't make a pane that is empty--ignore that map instead. */
1154 for (i = 0; i < len; i++)
1156 if (SYMBOLP (mapvec[i])
1157 || (CONSP (mapvec[i]) && !KEYMAPP (mapvec[i])))
1159 /* Here we have a command at top level in the menu bar
1160 as opposed to a submenu. */
1161 top_level_items = 1;
1162 push_menu_pane (Qnil, Qnil);
1163 push_menu_item (item_name, Qt, item_key, mapvec[i],
1164 Qnil, Qnil, Qnil, Qnil);
1166 else
1168 Lisp_Object prompt;
1169 prompt = Fkeymap_prompt (mapvec[i]);
1170 single_keymap_panes (mapvec[i],
1171 !NILP (prompt) ? prompt : item_name,
1172 item_key, 0, 10);
1176 return top_level_items;
1180 /* Create a tree of widget_value objects
1181 representing the panes and items
1182 in menu_items starting at index START, up to index END. */
1184 static widget_value *
1185 digest_single_submenu (start, end, top_level_items)
1186 int start, end, top_level_items;
1188 widget_value *wv, *prev_wv, *save_wv, *first_wv;
1189 int i;
1190 int submenu_depth = 0;
1191 widget_value **submenu_stack;
1193 submenu_stack
1194 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1195 wv = xmalloc_widget_value ();
1196 wv->name = "menu";
1197 wv->value = 0;
1198 wv->enabled = 1;
1199 wv->button_type = BUTTON_TYPE_NONE;
1200 wv->help = Qnil;
1201 first_wv = wv;
1202 save_wv = 0;
1203 prev_wv = 0;
1205 /* Loop over all panes and items made by the preceding call
1206 to parse_single_submenu and construct a tree of widget_value objects.
1207 Ignore the panes and items used by previous calls to
1208 digest_single_submenu, even though those are also in menu_items. */
1209 i = start;
1210 while (i < end)
1212 if (EQ (AREF (menu_items, i), Qnil))
1214 submenu_stack[submenu_depth++] = save_wv;
1215 save_wv = prev_wv;
1216 prev_wv = 0;
1217 i++;
1219 else if (EQ (AREF (menu_items, i), Qlambda))
1221 prev_wv = save_wv;
1222 save_wv = submenu_stack[--submenu_depth];
1223 i++;
1225 else if (EQ (AREF (menu_items, i), Qt)
1226 && submenu_depth != 0)
1227 i += MENU_ITEMS_PANE_LENGTH;
1228 /* Ignore a nil in the item list.
1229 It's meaningful only for dialog boxes. */
1230 else if (EQ (AREF (menu_items, i), Qquote))
1231 i += 1;
1232 else if (EQ (AREF (menu_items, i), Qt))
1234 /* Create a new pane. */
1235 Lisp_Object pane_name, prefix;
1236 char *pane_string;
1238 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1239 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1241 if (STRINGP (pane_name))
1243 if (unicode_append_menu)
1244 /* Encode as UTF-8 for now. */
1245 pane_name = ENCODE_UTF_8 (pane_name);
1246 else if (STRING_MULTIBYTE (pane_name))
1247 pane_name = ENCODE_SYSTEM (pane_name);
1249 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1252 pane_string = (NILP (pane_name)
1253 ? "" : (char *) SDATA (pane_name));
1254 /* If there is just one top-level pane, put all its items directly
1255 under the top-level menu. */
1256 if (menu_items_n_panes == 1)
1257 pane_string = "";
1259 /* If the pane has a meaningful name,
1260 make the pane a top-level menu item
1261 with its items as a submenu beneath it. */
1262 if (strcmp (pane_string, ""))
1264 wv = xmalloc_widget_value ();
1265 if (save_wv)
1266 save_wv->next = wv;
1267 else
1268 first_wv->contents = wv;
1269 wv->lname = pane_name;
1270 /* Set value to 1 so update_submenu_strings can handle '@' */
1271 wv->value = (char *) 1;
1272 wv->enabled = 1;
1273 wv->button_type = BUTTON_TYPE_NONE;
1274 wv->help = Qnil;
1276 save_wv = wv;
1277 prev_wv = 0;
1278 i += MENU_ITEMS_PANE_LENGTH;
1280 else
1282 /* Create a new item within current pane. */
1283 Lisp_Object item_name, enable, descrip, def, type, selected;
1284 Lisp_Object help;
1286 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1287 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1288 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1289 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1290 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1291 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1292 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1294 if (STRINGP (item_name))
1296 if (unicode_append_menu)
1297 item_name = ENCODE_UTF_8 (item_name);
1298 else if (STRING_MULTIBYTE (item_name))
1299 item_name = ENCODE_SYSTEM (item_name);
1301 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1304 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1306 descrip = ENCODE_SYSTEM (descrip);
1307 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1310 wv = xmalloc_widget_value ();
1311 if (prev_wv)
1312 prev_wv->next = wv;
1313 else
1314 save_wv->contents = wv;
1316 wv->lname = item_name;
1317 if (!NILP (descrip))
1318 wv->lkey = descrip;
1319 wv->value = 0;
1320 /* The EMACS_INT cast avoids a warning. There's no problem
1321 as long as pointers have enough bits to hold small integers. */
1322 wv->call_data = (!NILP (def) ? (void *) (EMACS_INT) i : 0);
1323 wv->enabled = !NILP (enable);
1325 if (NILP (type))
1326 wv->button_type = BUTTON_TYPE_NONE;
1327 else if (EQ (type, QCradio))
1328 wv->button_type = BUTTON_TYPE_RADIO;
1329 else if (EQ (type, QCtoggle))
1330 wv->button_type = BUTTON_TYPE_TOGGLE;
1331 else
1332 abort ();
1334 wv->selected = !NILP (selected);
1335 if (!STRINGP (help))
1336 help = Qnil;
1338 wv->help = help;
1340 prev_wv = wv;
1342 i += MENU_ITEMS_ITEM_LENGTH;
1346 /* If we have just one "menu item"
1347 that was originally a button, return it by itself. */
1348 if (top_level_items && first_wv->contents && first_wv->contents->next == 0)
1350 wv = first_wv->contents;
1351 free_widget_value (first_wv);
1352 return wv;
1355 return first_wv;
1359 /* Walk through the widget_value tree starting at FIRST_WV and update
1360 the char * pointers from the corresponding lisp values.
1361 We do this after building the whole tree, since GC may happen while the
1362 tree is constructed, and small strings are relocated. So we must wait
1363 until no GC can happen before storing pointers into lisp values. */
1364 static void
1365 update_submenu_strings (first_wv)
1366 widget_value *first_wv;
1368 widget_value *wv;
1370 for (wv = first_wv; wv; wv = wv->next)
1372 if (wv->lname && ! NILP (wv->lname))
1374 wv->name = SDATA (wv->lname);
1376 /* Ignore the @ that means "separate pane".
1377 This is a kludge, but this isn't worth more time. */
1378 if (wv->value == (char *)1)
1380 if (wv->name[0] == '@')
1381 wv->name++;
1382 wv->value = 0;
1386 if (wv->lkey && ! NILP (wv->lkey))
1387 wv->key = SDATA (wv->lkey);
1389 if (wv->contents)
1390 update_submenu_strings (wv->contents);
1395 /* Set the contents of the menubar widgets of frame F.
1396 The argument FIRST_TIME is currently ignored;
1397 it is set the first time this is called, from initialize_frame_menubar. */
1399 void
1400 set_frame_menubar (f, first_time, deep_p)
1401 FRAME_PTR f;
1402 int first_time;
1403 int deep_p;
1405 HMENU menubar_widget = f->output_data.w32->menubar_widget;
1406 Lisp_Object items;
1407 widget_value *wv, *first_wv, *prev_wv = 0;
1408 int i, last_i;
1409 int *submenu_start, *submenu_end;
1410 int *submenu_top_level_items, *submenu_n_panes;
1412 /* We must not change the menubar when actually in use. */
1413 if (f->output_data.w32->menubar_active)
1414 return;
1416 XSETFRAME (Vmenu_updating_frame, f);
1418 if (! menubar_widget)
1419 deep_p = 1;
1420 else if (pending_menu_activation && !deep_p)
1421 deep_p = 1;
1423 if (deep_p)
1425 /* Make a widget-value tree representing the entire menu trees. */
1427 struct buffer *prev = current_buffer;
1428 Lisp_Object buffer;
1429 int specpdl_count = SPECPDL_INDEX ();
1430 int previous_menu_items_used = f->menu_bar_items_used;
1431 Lisp_Object *previous_items
1432 = (Lisp_Object *) alloca (previous_menu_items_used
1433 * sizeof (Lisp_Object));
1435 /* If we are making a new widget, its contents are empty,
1436 do always reinitialize them. */
1437 if (! menubar_widget)
1438 previous_menu_items_used = 0;
1440 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
1441 specbind (Qinhibit_quit, Qt);
1442 /* Don't let the debugger step into this code
1443 because it is not reentrant. */
1444 specbind (Qdebug_on_next_call, Qnil);
1446 record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil));
1447 if (NILP (Voverriding_local_map_menu_flag))
1449 specbind (Qoverriding_terminal_local_map, Qnil);
1450 specbind (Qoverriding_local_map, Qnil);
1453 set_buffer_internal_1 (XBUFFER (buffer));
1455 /* Run the Lucid hook. */
1456 safe_run_hooks (Qactivate_menubar_hook);
1457 /* If it has changed current-menubar from previous value,
1458 really recompute the menubar from the value. */
1459 if (! NILP (Vlucid_menu_bar_dirty_flag))
1460 call0 (Qrecompute_lucid_menubar);
1461 safe_run_hooks (Qmenu_bar_update_hook);
1462 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1464 items = FRAME_MENU_BAR_ITEMS (f);
1466 /* Save the frame's previous menu bar contents data. */
1467 if (previous_menu_items_used)
1468 bcopy (XVECTOR (f->menu_bar_vector)->contents, previous_items,
1469 previous_menu_items_used * sizeof (Lisp_Object));
1471 /* Fill in menu_items with the current menu bar contents.
1472 This can evaluate Lisp code. */
1473 menu_items = f->menu_bar_vector;
1474 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
1475 submenu_start = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
1476 submenu_end = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
1477 submenu_n_panes = (int *) alloca (XVECTOR (items)->size * sizeof (int));
1478 submenu_top_level_items
1479 = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
1480 init_menu_items ();
1481 for (i = 0; i < ASIZE (items); i += 4)
1483 Lisp_Object key, string, maps;
1485 last_i = i;
1487 key = AREF (items, i);
1488 string = AREF (items, i + 1);
1489 maps = AREF (items, i + 2);
1490 if (NILP (string))
1491 break;
1493 submenu_start[i] = menu_items_used;
1495 menu_items_n_panes = 0;
1496 submenu_top_level_items[i]
1497 = parse_single_submenu (key, string, maps);
1498 submenu_n_panes[i] = menu_items_n_panes;
1500 submenu_end[i] = menu_items_used;
1503 finish_menu_items ();
1505 /* Convert menu_items into widget_value trees
1506 to display the menu. This cannot evaluate Lisp code. */
1508 wv = xmalloc_widget_value ();
1509 wv->name = "menubar";
1510 wv->value = 0;
1511 wv->enabled = 1;
1512 wv->button_type = BUTTON_TYPE_NONE;
1513 wv->help = Qnil;
1514 first_wv = wv;
1516 for (i = 0; i < last_i; i += 4)
1518 menu_items_n_panes = submenu_n_panes[i];
1519 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
1520 submenu_top_level_items[i]);
1521 if (prev_wv)
1522 prev_wv->next = wv;
1523 else
1524 first_wv->contents = wv;
1525 /* Don't set wv->name here; GC during the loop might relocate it. */
1526 wv->enabled = 1;
1527 wv->button_type = BUTTON_TYPE_NONE;
1528 prev_wv = wv;
1531 set_buffer_internal_1 (prev);
1532 unbind_to (specpdl_count, Qnil);
1534 /* If there has been no change in the Lisp-level contents
1535 of the menu bar, skip redisplaying it. Just exit. */
1537 for (i = 0; i < previous_menu_items_used; i++)
1538 if (menu_items_used == i
1539 || (!EQ (previous_items[i], AREF (menu_items, i))))
1540 break;
1541 if (i == menu_items_used && i == previous_menu_items_used && i != 0)
1543 free_menubar_widget_value_tree (first_wv);
1544 menu_items = Qnil;
1546 return;
1549 /* Now GC cannot happen during the lifetime of the widget_value,
1550 so it's safe to store data from a Lisp_String, as long as
1551 local copies are made when the actual menu is created.
1552 Windows takes care of this for normal string items, but
1553 not for owner-drawn items or additional item-info. */
1554 wv = first_wv->contents;
1555 for (i = 0; i < ASIZE (items); i += 4)
1557 Lisp_Object string;
1558 string = AREF (items, i + 1);
1559 if (NILP (string))
1560 break;
1561 wv->name = (char *) SDATA (string);
1562 update_submenu_strings (wv->contents);
1563 wv = wv->next;
1566 f->menu_bar_vector = menu_items;
1567 f->menu_bar_items_used = menu_items_used;
1568 menu_items = Qnil;
1570 else
1572 /* Make a widget-value tree containing
1573 just the top level menu bar strings. */
1575 wv = xmalloc_widget_value ();
1576 wv->name = "menubar";
1577 wv->value = 0;
1578 wv->enabled = 1;
1579 wv->button_type = BUTTON_TYPE_NONE;
1580 wv->help = Qnil;
1581 first_wv = wv;
1583 items = FRAME_MENU_BAR_ITEMS (f);
1584 for (i = 0; i < ASIZE (items); i += 4)
1586 Lisp_Object string;
1588 string = AREF (items, i + 1);
1589 if (NILP (string))
1590 break;
1592 wv = xmalloc_widget_value ();
1593 wv->name = (char *) SDATA (string);
1594 wv->value = 0;
1595 wv->enabled = 1;
1596 wv->button_type = BUTTON_TYPE_NONE;
1597 wv->help = Qnil;
1598 /* This prevents lwlib from assuming this
1599 menu item is really supposed to be empty. */
1600 /* The EMACS_INT cast avoids a warning.
1601 This value just has to be different from small integers. */
1602 wv->call_data = (void *) (EMACS_INT) (-1);
1604 if (prev_wv)
1605 prev_wv->next = wv;
1606 else
1607 first_wv->contents = wv;
1608 prev_wv = wv;
1611 /* Forget what we thought we knew about what is in the
1612 detailed contents of the menu bar menus.
1613 Changing the top level always destroys the contents. */
1614 f->menu_bar_items_used = 0;
1617 /* Create or update the menu bar widget. */
1619 BLOCK_INPUT;
1621 if (menubar_widget)
1623 /* Empty current menubar, rather than creating a fresh one. */
1624 while (DeleteMenu (menubar_widget, 0, MF_BYPOSITION))
1627 else
1629 menubar_widget = CreateMenu ();
1631 fill_in_menu (menubar_widget, first_wv->contents);
1633 free_menubar_widget_value_tree (first_wv);
1636 HMENU old_widget = f->output_data.w32->menubar_widget;
1638 f->output_data.w32->menubar_widget = menubar_widget;
1639 SetMenu (FRAME_W32_WINDOW (f), f->output_data.w32->menubar_widget);
1640 /* Causes flicker when menu bar is updated
1641 DrawMenuBar (FRAME_W32_WINDOW (f)); */
1643 /* Force the window size to be recomputed so that the frame's text
1644 area remains the same, if menubar has just been created. */
1645 if (old_widget == NULL)
1646 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1649 UNBLOCK_INPUT;
1652 /* Called from Fx_create_frame to create the initial menubar of a frame
1653 before it is mapped, so that the window is mapped with the menubar already
1654 there instead of us tacking it on later and thrashing the window after it
1655 is visible. */
1657 void
1658 initialize_frame_menubar (f)
1659 FRAME_PTR f;
1661 /* This function is called before the first chance to redisplay
1662 the frame. It has to be, so the frame will have the right size. */
1663 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1664 set_frame_menubar (f, 1, 1);
1667 /* Get rid of the menu bar of frame F, and free its storage.
1668 This is used when deleting a frame, and when turning off the menu bar. */
1670 void
1671 free_frame_menubar (f)
1672 FRAME_PTR f;
1674 BLOCK_INPUT;
1677 HMENU old = GetMenu (FRAME_W32_WINDOW (f));
1678 SetMenu (FRAME_W32_WINDOW (f), NULL);
1679 f->output_data.w32->menubar_widget = NULL;
1680 DestroyMenu (old);
1683 UNBLOCK_INPUT;
1687 /* w32_menu_show actually displays a menu using the panes and items in
1688 menu_items and returns the value selected from it; we assume input
1689 is blocked by the caller. */
1691 /* F is the frame the menu is for.
1692 X and Y are the frame-relative specified position,
1693 relative to the inside upper left corner of the frame F.
1694 FOR_CLICK is nonzero if this menu was invoked for a mouse click.
1695 KEYMAPS is 1 if this menu was specified with keymaps;
1696 in that case, we return a list containing the chosen item's value
1697 and perhaps also the pane's prefix.
1698 TITLE is the specified menu title.
1699 ERROR is a place to store an error message string in case of failure.
1700 (We return nil on failure, but the value doesn't actually matter.) */
1702 static Lisp_Object
1703 w32_menu_show (f, x, y, for_click, keymaps, title, error)
1704 FRAME_PTR f;
1705 int x;
1706 int y;
1707 int for_click;
1708 int keymaps;
1709 Lisp_Object title;
1710 char **error;
1712 int i;
1713 int menu_item_selection;
1714 HMENU menu;
1715 POINT pos;
1716 widget_value *wv, *save_wv = 0, *first_wv = 0, *prev_wv = 0;
1717 widget_value **submenu_stack
1718 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
1719 Lisp_Object *subprefix_stack
1720 = (Lisp_Object *) alloca (menu_items_used * sizeof (Lisp_Object));
1721 int submenu_depth = 0;
1722 int first_pane;
1724 *error = NULL;
1726 if (menu_items_used <= MENU_ITEMS_PANE_LENGTH)
1728 *error = "Empty menu";
1729 return Qnil;
1732 /* Create a tree of widget_value objects
1733 representing the panes and their items. */
1734 wv = xmalloc_widget_value ();
1735 wv->name = "menu";
1736 wv->value = 0;
1737 wv->enabled = 1;
1738 wv->button_type = BUTTON_TYPE_NONE;
1739 wv->help = Qnil;
1740 first_wv = wv;
1741 first_pane = 1;
1743 /* Loop over all panes and items, filling in the tree. */
1744 i = 0;
1745 while (i < menu_items_used)
1747 if (EQ (AREF (menu_items, i), Qnil))
1749 submenu_stack[submenu_depth++] = save_wv;
1750 save_wv = prev_wv;
1751 prev_wv = 0;
1752 first_pane = 1;
1753 i++;
1755 else if (EQ (AREF (menu_items, i), Qlambda))
1757 prev_wv = save_wv;
1758 save_wv = submenu_stack[--submenu_depth];
1759 first_pane = 0;
1760 i++;
1762 else if (EQ (AREF (menu_items, i), Qt)
1763 && submenu_depth != 0)
1764 i += MENU_ITEMS_PANE_LENGTH;
1765 /* Ignore a nil in the item list.
1766 It's meaningful only for dialog boxes. */
1767 else if (EQ (AREF (menu_items, i), Qquote))
1768 i += 1;
1769 else if (EQ (AREF (menu_items, i), Qt))
1771 /* Create a new pane. */
1772 Lisp_Object pane_name, prefix;
1773 char *pane_string;
1774 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
1775 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1777 if (STRINGP (pane_name))
1779 if (unicode_append_menu)
1780 pane_name = ENCODE_UTF_8 (pane_name);
1781 else if (STRING_MULTIBYTE (pane_name))
1782 pane_name = ENCODE_SYSTEM (pane_name);
1784 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
1787 pane_string = (NILP (pane_name)
1788 ? "" : (char *) SDATA (pane_name));
1789 /* If there is just one top-level pane, put all its items directly
1790 under the top-level menu. */
1791 if (menu_items_n_panes == 1)
1792 pane_string = "";
1794 /* If the pane has a meaningful name,
1795 make the pane a top-level menu item
1796 with its items as a submenu beneath it. */
1797 if (!keymaps && strcmp (pane_string, ""))
1799 wv = xmalloc_widget_value ();
1800 if (save_wv)
1801 save_wv->next = wv;
1802 else
1803 first_wv->contents = wv;
1804 wv->name = pane_string;
1805 if (keymaps && !NILP (prefix))
1806 wv->name++;
1807 wv->value = 0;
1808 wv->enabled = 1;
1809 wv->button_type = BUTTON_TYPE_NONE;
1810 wv->help = Qnil;
1811 save_wv = wv;
1812 prev_wv = 0;
1814 else if (first_pane)
1816 save_wv = wv;
1817 prev_wv = 0;
1819 first_pane = 0;
1820 i += MENU_ITEMS_PANE_LENGTH;
1822 else
1824 /* Create a new item within current pane. */
1825 Lisp_Object item_name, enable, descrip, def, type, selected, help;
1827 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
1828 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
1829 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
1830 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
1831 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
1832 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
1833 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
1835 if (STRINGP (item_name))
1837 if (unicode_append_menu)
1838 item_name = ENCODE_UTF_8 (item_name);
1839 else if (STRING_MULTIBYTE (item_name))
1840 item_name = ENCODE_SYSTEM (item_name);
1842 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
1845 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
1847 descrip = ENCODE_SYSTEM (descrip);
1848 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
1851 wv = xmalloc_widget_value ();
1852 if (prev_wv)
1853 prev_wv->next = wv;
1854 else
1855 save_wv->contents = wv;
1856 wv->name = (char *) SDATA (item_name);
1857 if (!NILP (descrip))
1858 wv->key = (char *) SDATA (descrip);
1859 wv->value = 0;
1860 /* Use the contents index as call_data, since we are
1861 restricted to 16-bits. */
1862 wv->call_data = !NILP (def) ? (void *) (EMACS_INT) i : 0;
1863 wv->enabled = !NILP (enable);
1865 if (NILP (type))
1866 wv->button_type = BUTTON_TYPE_NONE;
1867 else if (EQ (type, QCtoggle))
1868 wv->button_type = BUTTON_TYPE_TOGGLE;
1869 else if (EQ (type, QCradio))
1870 wv->button_type = BUTTON_TYPE_RADIO;
1871 else
1872 abort ();
1874 wv->selected = !NILP (selected);
1875 if (!STRINGP (help))
1876 help = Qnil;
1878 wv->help = help;
1880 prev_wv = wv;
1882 i += MENU_ITEMS_ITEM_LENGTH;
1886 /* Deal with the title, if it is non-nil. */
1887 if (!NILP (title))
1889 widget_value *wv_title = xmalloc_widget_value ();
1890 widget_value *wv_sep = xmalloc_widget_value ();
1892 /* Maybe replace this separator with a bitmap or owner-draw item
1893 so that it looks better. Having two separators looks odd. */
1894 wv_sep->name = "--";
1895 wv_sep->next = first_wv->contents;
1896 wv_sep->help = Qnil;
1898 if (unicode_append_menu)
1899 title = ENCODE_UTF_8 (title);
1900 else if (STRING_MULTIBYTE (title))
1901 title = ENCODE_SYSTEM (title);
1903 wv_title->name = (char *) SDATA (title);
1904 wv_title->enabled = TRUE;
1905 wv_title->title = TRUE;
1906 wv_title->button_type = BUTTON_TYPE_NONE;
1907 wv_title->help = Qnil;
1908 wv_title->next = wv_sep;
1909 first_wv->contents = wv_title;
1912 /* Actually create the menu. */
1913 current_popup_menu = menu = CreatePopupMenu ();
1914 fill_in_menu (menu, first_wv->contents);
1916 /* Adjust coordinates to be root-window-relative. */
1917 pos.x = x;
1918 pos.y = y;
1919 ClientToScreen (FRAME_W32_WINDOW (f), &pos);
1921 /* No selection has been chosen yet. */
1922 menu_item_selection = 0;
1924 /* Display the menu. */
1925 menu_item_selection = SendMessage (FRAME_W32_WINDOW (f),
1926 WM_EMACS_TRACKPOPUPMENU,
1927 (WPARAM)menu, (LPARAM)&pos);
1929 /* Clean up extraneous mouse events which might have been generated
1930 during the call. */
1931 discard_mouse_events ();
1933 /* Free the widget_value objects we used to specify the contents. */
1934 free_menubar_widget_value_tree (first_wv);
1936 DestroyMenu (menu);
1938 /* Find the selected item, and its pane, to return
1939 the proper value. */
1940 if (menu_item_selection != 0)
1942 Lisp_Object prefix, entry;
1944 prefix = entry = Qnil;
1945 i = 0;
1946 while (i < menu_items_used)
1948 if (EQ (AREF (menu_items, i), Qnil))
1950 subprefix_stack[submenu_depth++] = prefix;
1951 prefix = entry;
1952 i++;
1954 else if (EQ (AREF (menu_items, i), Qlambda))
1956 prefix = subprefix_stack[--submenu_depth];
1957 i++;
1959 else if (EQ (AREF (menu_items, i), Qt))
1961 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1962 i += MENU_ITEMS_PANE_LENGTH;
1964 /* Ignore a nil in the item list.
1965 It's meaningful only for dialog boxes. */
1966 else if (EQ (AREF (menu_items, i), Qquote))
1967 i += 1;
1968 else
1970 entry = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1971 if (menu_item_selection == i)
1973 if (keymaps != 0)
1975 int j;
1977 entry = Fcons (entry, Qnil);
1978 if (!NILP (prefix))
1979 entry = Fcons (prefix, entry);
1980 for (j = submenu_depth - 1; j >= 0; j--)
1981 if (!NILP (subprefix_stack[j]))
1982 entry = Fcons (subprefix_stack[j], entry);
1984 return entry;
1986 i += MENU_ITEMS_ITEM_LENGTH;
1991 return Qnil;
1995 #ifdef HAVE_DIALOGS
1996 static char * button_names [] = {
1997 "button1", "button2", "button3", "button4", "button5",
1998 "button6", "button7", "button8", "button9", "button10" };
2000 static Lisp_Object
2001 w32_dialog_show (f, keymaps, title, header, error)
2002 FRAME_PTR f;
2003 int keymaps;
2004 Lisp_Object title, header;
2005 char **error;
2007 int i, nb_buttons=0;
2008 char dialog_name[6];
2009 int menu_item_selection;
2011 widget_value *wv, *first_wv = 0, *prev_wv = 0;
2013 /* Number of elements seen so far, before boundary. */
2014 int left_count = 0;
2015 /* 1 means we've seen the boundary between left-hand elts and right-hand. */
2016 int boundary_seen = 0;
2018 *error = NULL;
2020 if (menu_items_n_panes > 1)
2022 *error = "Multiple panes in dialog box";
2023 return Qnil;
2026 /* Create a tree of widget_value objects
2027 representing the text label and buttons. */
2029 Lisp_Object pane_name, prefix;
2030 char *pane_string;
2031 pane_name = AREF (menu_items, MENU_ITEMS_PANE_NAME);
2032 prefix = AREF (menu_items, MENU_ITEMS_PANE_PREFIX);
2033 pane_string = (NILP (pane_name)
2034 ? "" : (char *) SDATA (pane_name));
2035 prev_wv = xmalloc_widget_value ();
2036 prev_wv->value = pane_string;
2037 if (keymaps && !NILP (prefix))
2038 prev_wv->name++;
2039 prev_wv->enabled = 1;
2040 prev_wv->name = "message";
2041 prev_wv->help = Qnil;
2042 first_wv = prev_wv;
2044 /* Loop over all panes and items, filling in the tree. */
2045 i = MENU_ITEMS_PANE_LENGTH;
2046 while (i < menu_items_used)
2049 /* Create a new item within current pane. */
2050 Lisp_Object item_name, enable, descrip, help;
2052 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
2053 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
2054 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
2055 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
2057 if (NILP (item_name))
2059 free_menubar_widget_value_tree (first_wv);
2060 *error = "Submenu in dialog items";
2061 return Qnil;
2063 if (EQ (item_name, Qquote))
2065 /* This is the boundary between left-side elts
2066 and right-side elts. Stop incrementing right_count. */
2067 boundary_seen = 1;
2068 i++;
2069 continue;
2071 if (nb_buttons >= 9)
2073 free_menubar_widget_value_tree (first_wv);
2074 *error = "Too many dialog items";
2075 return Qnil;
2078 wv = xmalloc_widget_value ();
2079 prev_wv->next = wv;
2080 wv->name = (char *) button_names[nb_buttons];
2081 if (!NILP (descrip))
2082 wv->key = (char *) SDATA (descrip);
2083 wv->value = (char *) SDATA (item_name);
2084 wv->call_data = (void *) &AREF (menu_items, i);
2085 wv->enabled = !NILP (enable);
2086 wv->help = Qnil;
2087 prev_wv = wv;
2089 if (! boundary_seen)
2090 left_count++;
2092 nb_buttons++;
2093 i += MENU_ITEMS_ITEM_LENGTH;
2096 /* If the boundary was not specified,
2097 by default put half on the left and half on the right. */
2098 if (! boundary_seen)
2099 left_count = nb_buttons - nb_buttons / 2;
2101 wv = xmalloc_widget_value ();
2102 wv->name = dialog_name;
2103 wv->help = Qnil;
2105 /* Frame title: 'Q' = Question, 'I' = Information.
2106 Can also have 'E' = Error if, one day, we want
2107 a popup for errors. */
2108 if (NILP(header))
2109 dialog_name[0] = 'Q';
2110 else
2111 dialog_name[0] = 'I';
2113 /* Dialog boxes use a really stupid name encoding
2114 which specifies how many buttons to use
2115 and how many buttons are on the right. */
2116 dialog_name[1] = '0' + nb_buttons;
2117 dialog_name[2] = 'B';
2118 dialog_name[3] = 'R';
2119 /* Number of buttons to put on the right. */
2120 dialog_name[4] = '0' + nb_buttons - left_count;
2121 dialog_name[5] = 0;
2122 wv->contents = first_wv;
2123 first_wv = wv;
2126 /* Actually create the dialog. */
2127 dialog_id = widget_id_tick++;
2128 menu = lw_create_widget (first_wv->name, "dialog", dialog_id, first_wv,
2129 f->output_data.w32->widget, 1, 0,
2130 dialog_selection_callback, 0);
2131 lw_modify_all_widgets (dialog_id, first_wv->contents, TRUE);
2133 /* Free the widget_value objects we used to specify the contents. */
2134 free_menubar_widget_value_tree (first_wv);
2136 /* No selection has been chosen yet. */
2137 menu_item_selection = 0;
2139 /* Display the menu. */
2140 lw_pop_up_all_widgets (dialog_id);
2141 popup_activated_flag = 1;
2143 /* Process events that apply to the menu. */
2144 popup_get_selection ((XEvent *) 0, FRAME_X_DISPLAY_INFO (f), dialog_id);
2146 lw_destroy_all_widgets (dialog_id);
2148 /* Find the selected item, and its pane, to return
2149 the proper value. */
2150 if (menu_item_selection != 0)
2152 Lisp_Object prefix;
2154 prefix = Qnil;
2155 i = 0;
2156 while (i < menu_items_used)
2158 Lisp_Object entry;
2160 if (EQ (AREF (menu_items, i), Qt))
2162 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
2163 i += MENU_ITEMS_PANE_LENGTH;
2165 else
2167 entry = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
2168 if (menu_item_selection == i)
2170 if (keymaps != 0)
2172 entry = Fcons (entry, Qnil);
2173 if (!NILP (prefix))
2174 entry = Fcons (prefix, entry);
2176 return entry;
2178 i += MENU_ITEMS_ITEM_LENGTH;
2183 return Qnil;
2185 #endif /* HAVE_DIALOGS */
2188 /* Is this item a separator? */
2189 static int
2190 name_is_separator (name)
2191 char *name;
2193 char *start = name;
2195 /* Check if name string consists of only dashes ('-'). */
2196 while (*name == '-') name++;
2197 /* Separators can also be of the form "--:TripleSuperMegaEtched"
2198 or "--deep-shadow". We don't implement them yet, se we just treat
2199 them like normal separators. */
2200 return (*name == '\0' || start + 2 == name);
2204 /* Indicate boundary between left and right. */
2205 static int
2206 add_left_right_boundary (HMENU menu)
2208 return AppendMenu (menu, MF_MENUBARBREAK, 0, NULL);
2211 /* UTF8: 0xxxxxxx, 110xxxxx 10xxxxxx, 1110xxxx, 10xxxxxx, 10xxxxxx */
2212 static void
2213 utf8to16 (unsigned char * src, int len, WCHAR * dest)
2215 while (len > 0)
2217 int utf16;
2218 if (*src < 0x80)
2220 *dest = (WCHAR) *src;
2221 dest++; src++; len--;
2223 /* Since we might get >3 byte sequences which we don't handle, ignore the extra parts. */
2224 else if (*src < 0xC0)
2226 src++; len--;
2228 /* 2 char UTF-8 sequence. */
2229 else if (*src < 0xE0)
2231 *dest = (WCHAR) (((*src & 0x1f) << 6)
2232 | (*(src + 1) & 0x3f));
2233 src += 2; len -= 2; dest++;
2235 else if (*src < 0xF0)
2237 *dest = (WCHAR) (((*src & 0x0f) << 12)
2238 | ((*(src + 1) & 0x3f) << 6)
2239 | (*(src + 2) & 0x3f));
2240 src += 3; len -= 3; dest++;
2242 else /* Not encodable. Insert Unicode Substitution char. */
2244 *dest = (WCHAR) 0xfffd;
2245 src++; len--; dest++;
2248 *dest = 0;
2251 static int
2252 add_menu_item (HMENU menu, widget_value *wv, HMENU item)
2254 UINT fuFlags;
2255 char *out_string;
2256 int return_value;
2258 if (name_is_separator (wv->name))
2260 fuFlags = MF_SEPARATOR;
2261 out_string = NULL;
2263 else
2265 if (wv->enabled)
2266 fuFlags = MF_STRING;
2267 else
2268 fuFlags = MF_STRING | MF_GRAYED;
2270 if (wv->key != NULL)
2272 out_string = alloca (strlen (wv->name) + strlen (wv->key) + 2);
2273 strcpy (out_string, wv->name);
2274 strcat (out_string, "\t");
2275 strcat (out_string, wv->key);
2277 else
2278 out_string = wv->name;
2280 if (item != NULL)
2281 fuFlags = MF_POPUP;
2282 else if (wv->title || wv->call_data == 0)
2284 /* Only use MF_OWNERDRAW if GetMenuItemInfo is usable, since
2285 we can't deallocate the memory otherwise. */
2286 if (get_menu_item_info)
2288 out_string = (char *) local_alloc (strlen (wv->name) + 1);
2289 strcpy (out_string, wv->name);
2290 #ifdef MENU_DEBUG
2291 DebPrint ("Menu: allocing %ld for owner-draw", out_string);
2292 #endif
2293 fuFlags = MF_OWNERDRAW | MF_DISABLED;
2295 else
2296 fuFlags = MF_DISABLED;
2299 /* Draw radio buttons and tickboxes. */
2300 else if (wv->selected && (wv->button_type == BUTTON_TYPE_TOGGLE ||
2301 wv->button_type == BUTTON_TYPE_RADIO))
2302 fuFlags |= MF_CHECKED;
2303 else
2304 fuFlags |= MF_UNCHECKED;
2307 if (unicode_append_menu && out_string)
2309 /* Convert out_string from UTF-8 to UTF-16-LE. */
2310 int utf8_len = strlen (out_string);
2311 WCHAR * utf16_string;
2312 if (fuFlags & MF_OWNERDRAW)
2313 utf16_string = local_alloc ((utf8_len + 1) * sizeof (WCHAR));
2314 else
2315 utf16_string = alloca ((utf8_len + 1) * sizeof (WCHAR));
2317 utf8to16 (out_string, utf8_len, utf16_string);
2318 return_value = unicode_append_menu (menu, fuFlags,
2319 item != NULL ? (UINT) item
2320 : (UINT) wv->call_data,
2321 utf16_string);
2322 if (fuFlags & MF_OWNERDRAW)
2323 local_free (out_string);
2325 else
2327 return_value =
2328 AppendMenu (menu,
2329 fuFlags,
2330 item != NULL ? (UINT) item : (UINT) wv->call_data,
2331 out_string );
2334 /* This must be done after the menu item is created. */
2335 if (!wv->title && wv->call_data != 0)
2337 if (set_menu_item_info)
2339 MENUITEMINFO info;
2340 bzero (&info, sizeof (info));
2341 info.cbSize = sizeof (info);
2342 info.fMask = MIIM_DATA;
2344 /* Set help string for menu item. Leave it as a Lisp_Object
2345 until it is ready to be displayed, since GC can happen while
2346 menus are active. */
2347 if (!NILP (wv->help))
2348 #ifdef USE_LISP_UNION_TYPE
2349 info.dwItemData = (DWORD) (wv->help).i;
2350 #else
2351 info.dwItemData = (DWORD) (wv->help);
2352 #endif
2353 if (wv->button_type == BUTTON_TYPE_RADIO)
2355 /* CheckMenuRadioItem allows us to differentiate TOGGLE and
2356 RADIO items, but is not available on NT 3.51 and earlier. */
2357 info.fMask |= MIIM_TYPE | MIIM_STATE;
2358 info.fType = MFT_RADIOCHECK | MFT_STRING;
2359 info.dwTypeData = out_string;
2360 info.fState = wv->selected ? MFS_CHECKED : MFS_UNCHECKED;
2363 set_menu_item_info (menu,
2364 item != NULL ? (UINT) item : (UINT) wv->call_data,
2365 FALSE, &info);
2368 return return_value;
2371 /* Construct native Windows menu(bar) based on widget_value tree. */
2373 fill_in_menu (HMENU menu, widget_value *wv)
2375 int items_added = 0;
2377 for ( ; wv != NULL; wv = wv->next)
2379 if (wv->contents)
2381 HMENU sub_menu = CreatePopupMenu ();
2383 if (sub_menu == NULL)
2384 return 0;
2386 if (!fill_in_menu (sub_menu, wv->contents) ||
2387 !add_menu_item (menu, wv, sub_menu))
2389 DestroyMenu (sub_menu);
2390 return 0;
2393 else
2395 if (!add_menu_item (menu, wv, NULL))
2396 return 0;
2399 return 1;
2403 popup_activated ()
2405 /* popup_activated_flag not actually used on W32 */
2406 return 0;
2409 /* Display help string for currently pointed to menu item. Not
2410 supported on NT 3.51 and earlier, as GetMenuItemInfo is not
2411 available. */
2412 void
2413 w32_menu_display_help (HWND owner, HMENU menu, UINT item, UINT flags)
2415 if (get_menu_item_info)
2417 struct frame *f = x_window_to_frame (&one_w32_display_info, owner);
2418 Lisp_Object frame, help;
2420 /* No help echo on owner-draw menu items. */
2421 if (flags & MF_OWNERDRAW || flags & MF_POPUP)
2422 help = Qnil;
2423 else
2425 MENUITEMINFO info;
2427 bzero (&info, sizeof (info));
2428 info.cbSize = sizeof (info);
2429 info.fMask = MIIM_DATA;
2430 get_menu_item_info (menu, item, FALSE, &info);
2432 #ifdef USE_LISP_UNION_TYPE
2433 help = info.dwItemData ? (Lisp_Object) ((EMACS_INT) info.dwItemData)
2434 : Qnil;
2435 #else
2436 help = info.dwItemData ? (Lisp_Object) info.dwItemData : Qnil;
2437 #endif
2440 /* Store the help echo in the keyboard buffer as the X toolkit
2441 version does, rather than directly showing it. This seems to
2442 solve the GC problems that were present when we based the
2443 Windows code on the non-toolkit version. */
2444 if (f)
2446 XSETFRAME (frame, f);
2447 kbd_buffer_store_help_event (frame, help);
2449 else
2450 /* X version has a loop through frames here, which doesn't
2451 appear to do anything, unless it has some side effect. */
2452 show_help_echo (help, Qnil, Qnil, Qnil, 1);
2456 /* Free memory used by owner-drawn strings. */
2457 static void
2458 w32_free_submenu_strings (menu)
2459 HMENU menu;
2461 int i, num = GetMenuItemCount (menu);
2462 for (i = 0; i < num; i++)
2464 MENUITEMINFO info;
2465 bzero (&info, sizeof (info));
2466 info.cbSize = sizeof (info);
2467 info.fMask = MIIM_DATA | MIIM_TYPE | MIIM_SUBMENU;
2469 get_menu_item_info (menu, i, TRUE, &info);
2471 /* Owner-drawn names are held in dwItemData. */
2472 if ((info.fType & MF_OWNERDRAW) && info.dwItemData)
2474 #ifdef MENU_DEBUG
2475 DebPrint ("Menu: freeing %ld for owner-draw", info.dwItemData);
2476 #endif
2477 local_free (info.dwItemData);
2480 /* Recurse down submenus. */
2481 if (info.hSubMenu)
2482 w32_free_submenu_strings (info.hSubMenu);
2486 void
2487 w32_free_menu_strings (hwnd)
2488 HWND hwnd;
2490 HMENU menu = current_popup_menu;
2492 if (get_menu_item_info)
2494 /* If there is no popup menu active, free the strings from the frame's
2495 menubar. */
2496 if (!menu)
2497 menu = GetMenu (hwnd);
2499 if (menu)
2500 w32_free_submenu_strings (menu);
2503 current_popup_menu = NULL;
2506 #endif /* HAVE_MENUS */
2508 void syms_of_w32menu ()
2510 globals_of_w32menu ();
2511 staticpro (&menu_items);
2512 menu_items = Qnil;
2514 current_popup_menu = NULL;
2516 Qdebug_on_next_call = intern ("debug-on-next-call");
2517 staticpro (&Qdebug_on_next_call);
2519 DEFVAR_LISP ("menu-updating-frame", &Vmenu_updating_frame,
2520 doc: /* Frame for which we are updating a menu.
2521 The enable predicate for a menu command should check this variable. */);
2522 Vmenu_updating_frame = Qnil;
2524 defsubr (&Sx_popup_menu);
2525 #ifdef HAVE_MENUS
2526 defsubr (&Sx_popup_dialog);
2527 #endif
2531 globals_of_w32menu is used to initialize those global variables that
2532 must always be initialized on startup even when the global variable
2533 initialized is non zero (see the function main in emacs.c).
2534 globals_of_w32menu is called from syms_of_w32menu when the global
2535 variable initialized is 0 and directly from main when initialized
2536 is non zero.
2538 void globals_of_w32menu ()
2540 /* See if Get/SetMenuItemInfo functions are available. */
2541 HMODULE user32 = GetModuleHandle ("user32.dll");
2542 get_menu_item_info = (GetMenuItemInfoA_Proc) GetProcAddress (user32, "GetMenuItemInfoA");
2543 set_menu_item_info = (SetMenuItemInfoA_Proc) GetProcAddress (user32, "SetMenuItemInfoA");
2544 unicode_append_menu = (AppendMenuW_Proc) GetProcAddress (user32, "AppendMenuW");
2547 /* arch-tag: 0eaed431-bb4e-4aac-a527-95a1b4f1fed0
2548 (do not change this comment) */