1 /* NeXT/Open/GNUstep and MacOSX Cocoa menu and toolbar module.
2 Copyright (C) 2007, 2008, 2009, 2010 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 3 of the License, or
9 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
20 By Adrian Robert, based on code from original nsmenu.m (Carl Edman,
21 Christian Limpach, Scott Bender, Christophe de Dinechin) and code in the
22 Carbon version by Yamamoto Mitsuharu. */
24 /* This should be the first include, as it may set up #defines affecting
25 interpretation of even the system includes. */
35 #include "blockinput.h"
37 #include "termhooks.h"
41 #define NSMENUPROFILE 0
44 #include <sys/timeb.h>
45 #include <sys/types.h>
48 #define MenuStagger 10.0
51 int menu_trace_num = 0;
52 #define NSTRACE(x) fprintf (stderr, "%s:%d: [%d] " #x "\n", \
53 __FILE__, __LINE__, ++menu_trace_num)
59 /* Include lisp -> C common menu parsing code */
60 #define ENCODE_MENU_STRING(str) ENCODE_UTF_8 (str)
61 #include "nsmenu_common.c"
64 extern Lisp_Object Qundefined, Qmenu_enable, Qmenu_bar_update_hook;
65 extern Lisp_Object QCtoggle, QCradio;
67 Lisp_Object Qdebug_on_next_call;
68 extern Lisp_Object Voverriding_local_map, Voverriding_local_map_menu_flag,
69 Qoverriding_local_map, Qoverriding_terminal_local_map;
71 extern long context_menu_value;
72 EmacsMenu *mainMenu, *svcsMenu, *dockMenu;
74 /* Nonzero means a menu is currently active. */
75 static int popup_activated_flag;
76 static NSModalSession popupSession;
78 /* NOTE: toolbar implementation is at end,
79 following complete menu implementation. */
82 /* ==========================================================================
84 Menu: Externally-called functions
86 ========================================================================== */
89 /* FIXME: not currently used, but should normalize with other terms. */
91 x_activate_menubar (struct frame *f)
93 fprintf (stderr, "XXX: Received x_activate_menubar event.\n");
97 /* Supposed to discard menubar and free storage. Since we share the
98 menubar among frames and update its context for the focused window,
99 there is nothing to do here. */
101 free_frame_menubar (struct frame *f)
110 return popup_activated_flag;
114 /* --------------------------------------------------------------------------
115 Update menubar. Three cases:
116 1) deep_p = 0, submenu = nil: Fresh switch onto a frame -- either set up
117 just top-level menu strings (OS X), or goto case (2) (GNUstep).
118 2) deep_p = 1, submenu = nil: Recompute all submenus.
119 3) deep_p = 1, submenu = non-nil: Update contents of a single submenu.
120 -------------------------------------------------------------------------- */
122 ns_update_menubar (struct frame *f, int deep_p, EmacsMenu *submenu)
124 NSAutoreleasePool *pool;
125 id menu = [NSApp mainMenu];
126 static EmacsMenu *last_submenu = nil;
128 const char *submenuTitle = [[submenu title] UTF8String];
129 extern int waiting_for_input;
132 widget_value *wv, *first_wv, *prev_wv = 0;
140 NSTRACE (set_frame_menubar);
142 if (f != SELECTED_FRAME ())
144 XSETFRAME (Vmenu_updating_frame, f);
145 /*fprintf (stderr, "ns_update_menubar: frame: %p\tdeep: %d\tsub: %p\n", f, deep_p, submenu); */
148 pool = [[NSAutoreleasePool alloc] init];
150 /* Menu may have been created automatically; if so, discard it. */
151 if ([menu isKindOfClass: [EmacsMenu class]] == NO)
159 menu = [[EmacsMenu alloc] initWithTitle: ns_app_name];
163 { /* close up anything on there */
164 id attMenu = [menu attachedMenu];
171 t = -(1000*tb.time+tb.millitm);
174 #ifdef NS_IMPL_GNUSTEP
175 deep_p = 1; /* until GNUstep NSMenu implements the Panther delegation model */
180 /* Fully parse one or more of the submenus. */
182 int *submenu_start, *submenu_end;
183 int *submenu_top_level_items, *submenu_n_panes;
184 struct buffer *prev = current_buffer;
186 int specpdl_count = SPECPDL_INDEX ();
187 int previous_menu_items_used = f->menu_bar_items_used;
188 Lisp_Object *previous_items
189 = (Lisp_Object *) alloca (previous_menu_items_used
190 * sizeof (Lisp_Object));
192 /* lisp preliminaries */
193 buffer = XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer;
194 specbind (Qinhibit_quit, Qt);
195 specbind (Qdebug_on_next_call, Qnil);
196 record_unwind_save_match_data ();
197 if (NILP (Voverriding_local_map_menu_flag))
199 specbind (Qoverriding_terminal_local_map, Qnil);
200 specbind (Qoverriding_local_map, Qnil);
202 set_buffer_internal_1 (XBUFFER (buffer));
204 /* TODO: for some reason this is not needed in other terms,
205 but some menu updates call Info-extract-pointer which causes
206 abort-on-error if waiting-for-input. Needs further investigation. */
207 owfi = waiting_for_input;
208 waiting_for_input = 0;
210 /* lucid hook and possible reset */
211 safe_run_hooks (Qactivate_menubar_hook);
212 if (! NILP (Vlucid_menu_bar_dirty_flag))
213 call0 (Qrecompute_lucid_menubar);
214 safe_run_hooks (Qmenu_bar_update_hook);
215 FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
217 /* Now ready to go */
218 items = FRAME_MENU_BAR_ITEMS (f);
220 /* Save the frame's previous menu bar contents data */
221 if (previous_menu_items_used)
222 bcopy (XVECTOR (f->menu_bar_vector)->contents, previous_items,
223 previous_menu_items_used * sizeof (Lisp_Object));
225 /* parse stage 1: extract from lisp */
228 menu_items = f->menu_bar_vector;
229 menu_items_allocated = VECTORP (menu_items) ? ASIZE (menu_items) : 0;
230 submenu_start = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
231 submenu_end = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
232 submenu_n_panes = (int *) alloca (XVECTOR (items)->size * sizeof (int));
233 submenu_top_level_items
234 = (int *) alloca (XVECTOR (items)->size * sizeof (int *));
236 for (i = 0; i < XVECTOR (items)->size; i += 4)
238 Lisp_Object key, string, maps;
240 key = XVECTOR (items)->contents[i];
241 string = XVECTOR (items)->contents[i + 1];
242 maps = XVECTOR (items)->contents[i + 2];
246 /* FIXME: we'd like to only parse the needed submenu, but this
247 was causing crashes in the _common parsing code.. need to make
248 sure proper initialization done.. */
249 /* if (submenu && strcmp (submenuTitle, SDATA (string)))
252 submenu_start[i] = menu_items_used;
254 menu_items_n_panes = 0;
255 submenu_top_level_items[i] = parse_single_submenu (key, string, maps);
256 submenu_n_panes[i] = menu_items_n_panes;
257 submenu_end[i] = menu_items_used;
261 finish_menu_items ();
262 waiting_for_input = owfi;
265 if (submenu && n == 0)
267 /* should have found a menu for this one but didn't */
268 fprintf (stderr, "ERROR: did not find lisp menu for submenu '%s'.\n",
270 discard_menu_items ();
271 unbind_to (specpdl_count, Qnil);
277 /* parse stage 2: insert into lucid 'widget_value' structures
278 [comments in other terms say not to evaluate lisp code here] */
279 wv = xmalloc_widget_value ();
280 wv->name = "menubar";
283 wv->button_type = BUTTON_TYPE_NONE;
287 for (i = 0; i < 4*n; i += 4)
289 menu_items_n_panes = submenu_n_panes[i];
290 wv = digest_single_submenu (submenu_start[i], submenu_end[i],
291 submenu_top_level_items[i]);
295 first_wv->contents = wv;
296 /* Don't set wv->name here; GC during the loop might relocate it. */
298 wv->button_type = BUTTON_TYPE_NONE;
302 set_buffer_internal_1 (prev);
304 /* Compare the new menu items with previous, and leave off if no change */
305 /* FIXME: following other terms here, but seems like this should be
306 done before parse stage 2 above, since its results aren't used */
307 if (previous_menu_items_used
308 && (!submenu || (submenu && submenu == last_submenu))
309 && menu_items_used == previous_menu_items_used)
311 for (i = 0; i < previous_menu_items_used; i++)
312 /* FIXME: this ALWAYS fails on Buffers menu items.. something
313 about their strings causes them to change every time, so we
314 double-check failures */
315 if (!EQ (previous_items[i], XVECTOR (menu_items)->contents[i]))
316 if (!(STRINGP (previous_items[i])
317 && STRINGP (XVECTOR (menu_items)->contents[i])
318 && !strcmp (SDATA (previous_items[i]),
319 SDATA (XVECTOR (menu_items)->contents[i]))))
321 if (i == previous_menu_items_used)
327 t += 1000*tb.time+tb.millitm;
328 fprintf (stderr, "NO CHANGE! CUTTING OUT after %ld msec.\n", t);
331 free_menubar_widget_value_tree (first_wv);
332 discard_menu_items ();
333 unbind_to (specpdl_count, Qnil);
339 /* The menu items are different, so store them in the frame */
340 /* FIXME: this is not correct for single-submenu case */
341 f->menu_bar_vector = menu_items;
342 f->menu_bar_items_used = menu_items_used;
344 /* Calls restore_menu_items, etc., as they were outside */
345 unbind_to (specpdl_count, Qnil);
347 /* Parse stage 2a: now GC cannot happen during the lifetime of the
348 widget_value, so it's safe to store data from a Lisp_String */
349 wv = first_wv->contents;
350 for (i = 0; i < XVECTOR (items)->size; i += 4)
353 string = XVECTOR (items)->contents[i + 1];
356 /* if (submenu && strcmp (submenuTitle, SDATA (string)))
359 wv->name = (char *) SDATA (string);
360 update_submenu_strings (wv->contents);
364 /* Now, update the NS menu; if we have a submenu, use that, otherwise
365 create a new menu for each sub and fill it. */
368 for (wv = first_wv->contents; wv; wv = wv->next)
370 if (!strcmp (submenuTitle, wv->name))
372 [submenu fillWithWidgetValue: wv->contents];
373 last_submenu = submenu;
380 [menu fillWithWidgetValue: first_wv->contents];
386 static int n_previous_strings = 0;
387 static char previous_strings[100][10];
388 static struct frame *last_f = NULL;
392 wv = xmalloc_widget_value ();
393 wv->name = "menubar";
396 wv->button_type = BUTTON_TYPE_NONE;
400 /* Make widget-value tree w/ just the top level menu bar strings */
401 items = FRAME_MENU_BAR_ITEMS (f);
410 /* check if no change.. this mechanism is a bit rough, but ready */
411 n = XVECTOR (items)->size / 4;
412 if (f == last_f && n_previous_strings == n)
414 for (i = 0; i<n; i++)
416 string = AREF (items, 4*i+1);
418 if (EQ (string, make_number (0))) // FIXME: Why??? --Stef
421 if (previous_strings[i][0])
425 if (strncmp (previous_strings[i], SDATA (string), 10))
438 for (i = 0; i < XVECTOR (items)->size; i += 4)
440 string = XVECTOR (items)->contents[i + 1];
445 strncpy (previous_strings[i/4], SDATA (string), 10);
447 wv = xmalloc_widget_value ();
448 wv->name = (char *) SDATA (string);
451 wv->button_type = BUTTON_TYPE_NONE;
453 wv->call_data = (void *) (EMACS_INT) (-1);
456 /* we'll update the real copy under app menu when time comes */
457 if (!strcmp ("Services", wv->name))
459 /* but we need to make sure it will update on demand */
460 [svcsMenu setFrame: f];
461 [svcsMenu setDelegate: svcsMenu];
465 [menu addSubmenuWithTitle: wv->name forFrame: f];
470 first_wv->contents = wv;
476 n_previous_strings = n;
478 n_previous_strings = 0;
481 free_menubar_widget_value_tree (first_wv);
486 t += 1000*tb.time+tb.millitm;
487 fprintf (stderr, "Menu update took %ld msec.\n", t);
492 [NSApp setMainMenu: menu];
500 /* Main emacs core entry point for menubar menus: called to indicate that the
501 frame's menus have changed, and the *step representation should be updated
504 set_frame_menubar (struct frame *f, int first_time, int deep_p)
506 ns_update_menubar (f, deep_p, nil);
510 /* Utility (from macmenu.c): is this item a separator? */
512 name_is_separator (name)
515 const char *start = name;
517 /* Check if name string consists of only dashes ('-'). */
518 while (*name == '-') name++;
519 /* Separators can also be of the form "--:TripleSuperMegaEtched"
520 or "--deep-shadow". We don't implement them yet, se we just treat
521 them like normal separators. */
522 return (*name == '\0' || start + 2 == name);
526 /* ==========================================================================
528 Menu: class implementation
530 ========================================================================== */
533 /* Menu that can define itself from Emacs "widget_value"s and will lazily
534 update itself when user clicked. Based on Carbon/AppKit implementation
535 by Yamamoto Mitsuharu. */
536 @implementation EmacsMenu
538 /* override designated initializer */
539 - initWithTitle: (NSString *)title
541 if (self = [super initWithTitle: title])
542 [self setAutoenablesItems: NO];
547 /* used for top-level */
548 - initWithTitle: (NSString *)title frame: (struct frame *)f
550 [self initWithTitle: title];
553 [self setDelegate: self];
559 - (void)setFrame: (struct frame *)f
565 /* delegate method called when a submenu is being opened: run a 'deep' call
566 to set_frame_menubar */
567 - (void)menuNeedsUpdate: (NSMenu *)menu
570 if (!FRAME_LIVE_P (frame))
572 event = [[FRAME_NS_VIEW (frame) window] currentEvent];
573 /* HACK: Cocoa/Carbon will request update on every keystroke
574 via IsMenuKeyEvent -> CheckMenusForKeyEvent. These are not needed
575 since key equivalents are handled through emacs.
576 On Leopard, even keystroke events generate SystemDefined events, but
577 their subtype is 8. */
578 if ([event type] != NSSystemDefined || [event subtype] == 8
579 /* Also, don't try this if from an event picked up asynchronously,
580 as lots of lisp evaluation happens in ns_update_menubar. */
581 || handling_signal != 0)
583 /*fprintf (stderr, "Updating menu '%s'\n", [[self title] UTF8String]); NSLog (@"%@\n", event); */
584 ns_update_menubar (frame, 1, self);
588 - (BOOL)performKeyEquivalent: (NSEvent *)theEvent
590 if (SELECTED_FRAME () && FRAME_NS_P (SELECTED_FRAME ())
591 && FRAME_NS_VIEW (SELECTED_FRAME ()))
592 [FRAME_NS_VIEW (SELECTED_FRAME ()) keyDown: theEvent];
597 /* Parse a widget_value's key rep (examples: 's-p', 's-S', '(C-x C-s)', '<f13>')
598 into an accelerator string. We are only able to display a single character
599 for an accelerator, together with an optional modifier combination. (Under
600 Carbon more control was possible, but in Cocoa multi-char strings passed to
601 NSMenuItem get ignored. For now we try to display a super-single letter
602 combo, and return the others as strings to be appended to the item title.
603 (This is signaled by setting keyEquivModMask to 0 for now.) */
604 -(NSString *)parseKeyEquiv: (char *)key
607 keyEquivModMask = NSCommandKeyMask;
609 if (!key || !strlen (key))
612 while (*tpos == ' ' || *tpos == '(')
614 if ((*tpos == 's') && (*(tpos+1) == '-'))
616 return [NSString stringWithFormat: @"%c", tpos[2]];
618 keyEquivModMask = 0; /* signal */
619 return [NSString stringWithUTF8String: tpos];
623 - (NSMenuItem *)addItemWithWidgetValue: (void *)wvptr
626 widget_value *wv = (widget_value *)wvptr;
628 if (name_is_separator (wv->name))
630 item = [NSMenuItem separatorItem];
631 [self addItem: item];
635 NSString *title, *keyEq;
636 title = [NSString stringWithUTF8String: wv->name];
638 title = @"< ? >"; /* (get out in the open so we know about it) */
640 keyEq = [self parseKeyEquiv: wv->key];
642 /* OS X just ignores modifier strings longer than one character */
643 if (keyEquivModMask == 0)
644 title = [title stringByAppendingFormat: @" (%@)", keyEq];
647 item = [self addItemWithTitle: (NSString *)title
648 action: @selector (menuDown:)
649 keyEquivalent: keyEq];
650 [item setKeyEquivalentModifierMask: keyEquivModMask];
652 [item setEnabled: wv->enabled];
654 /* Draw radio buttons and tickboxes */
655 if (wv->selected && (wv->button_type == BUTTON_TYPE_TOGGLE ||
656 wv->button_type == BUTTON_TYPE_RADIO))
657 [item setState: NSOnState];
659 [item setState: NSOffState];
661 [item setTag: (NSInteger)wv->call_data];
673 for (n = [self numberOfItems]-1; n >= 0; n--)
675 NSMenuItem *item = [self itemAtIndex: n];
676 NSString *title = [item title];
677 if (([title length] == 0 /* OSX 10.5 */
678 || [ns_app_name isEqualToString: title] /* from 10.6 on */
679 || [@"Apple" isEqualToString: title]) /* older */
680 && ![item isSeparatorItem])
682 [self removeItemAtIndex: n];
687 - (void)fillWithWidgetValue: (void *)wvptr
689 widget_value *wv = (widget_value *)wvptr;
691 /* clear existing contents */
692 [self setMenuChangedMessagesEnabled: NO];
695 /* add new contents */
696 for (; wv != NULL; wv = wv->next)
698 NSMenuItem *item = [self addItemWithWidgetValue: wv];
702 EmacsMenu *submenu = [[EmacsMenu alloc] initWithTitle: [item title]];
704 [self setSubmenu: submenu forItem: item];
705 [submenu fillWithWidgetValue: wv->contents];
707 [item setAction: nil];
711 [self setMenuChangedMessagesEnabled: YES];
712 #ifdef NS_IMPL_GNUSTEP
713 if ([[self window] isVisible])
716 if ([self supermenu] == nil)
722 /* adds an empty submenu and returns it */
723 - (EmacsMenu *)addSubmenuWithTitle: (char *)title forFrame: (struct frame *)f
725 NSString *titleStr = [NSString stringWithUTF8String: title];
726 NSMenuItem *item = [self addItemWithTitle: titleStr
727 action: nil /*@selector (menuDown:) */
729 EmacsMenu *submenu = [[EmacsMenu alloc] initWithTitle: titleStr frame: f];
730 [self setSubmenu: submenu forItem: item];
735 /* run a menu in popup mode */
736 - (Lisp_Object)runMenuAt: (NSPoint)p forFrame: (struct frame *)f
737 keymaps: (int)keymaps
739 EmacsView *view = FRAME_NS_VIEW (f);
740 /* p = [view convertPoint:p fromView: nil]; */
741 p.y = NSHeight ([view frame]) - p.y;
742 NSEvent *e = [[view window] currentEvent];
743 NSEvent *event = [NSEvent mouseEventWithType: NSRightMouseDown
746 timestamp: [e timestamp]
747 windowNumber: [[view window] windowNumber]
749 eventNumber: 0/*[e eventNumber] */
754 context_menu_value = -1;
755 [NSMenu popUpContextMenu: self withEvent: event forView: view];
756 retVal = context_menu_value;
757 context_menu_value = 0;
759 ? find_and_return_menu_selection (f, keymaps, (void *)retVal)
767 /* ==========================================================================
769 Context Menu: implementing functions
771 ========================================================================== */
774 ns_menu_show (FRAME_PTR f, int x, int y, int for_click, int keymaps,
775 Lisp_Object title, char **error)
779 Lisp_Object window, tem, keymap;
780 int specpdl_count = SPECPDL_INDEX ();
781 widget_value *wv, *first_wv = 0;
785 /* now parse stage 2 as in ns_update_menubar */
786 wv = xmalloc_widget_value ();
787 wv->name = "contextmenu";
790 wv->button_type = BUTTON_TYPE_NONE;
795 /* FIXME: a couple of one-line differences prevent reuse */
796 wv = digest_single_submenu (0, menu_items_used, Qnil);
799 widget_value *save_wv = 0, *prev_wv = 0;
800 widget_value **submenu_stack
801 = (widget_value **) alloca (menu_items_used * sizeof (widget_value *));
802 /* Lisp_Object *subprefix_stack
803 = (Lisp_Object *) alloca (menu_items_used * sizeof (Lisp_Object)); */
804 int submenu_depth = 0;
808 /* Loop over all panes and items, filling in the tree. */
810 while (i < menu_items_used)
812 if (EQ (XVECTOR (menu_items)->contents[i], Qnil))
814 submenu_stack[submenu_depth++] = save_wv;
820 else if (EQ (XVECTOR (menu_items)->contents[i], Qlambda))
823 save_wv = submenu_stack[--submenu_depth];
827 else if (EQ (XVECTOR (menu_items)->contents[i], Qt)
828 && submenu_depth != 0)
829 i += MENU_ITEMS_PANE_LENGTH;
830 /* Ignore a nil in the item list.
831 It's meaningful only for dialog boxes. */
832 else if (EQ (XVECTOR (menu_items)->contents[i], Qquote))
834 else if (EQ (XVECTOR (menu_items)->contents[i], Qt))
836 /* Create a new pane. */
837 Lisp_Object pane_name, prefix;
840 pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
841 prefix = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
843 #ifndef HAVE_MULTILINGUAL_MENU
844 if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
846 pane_name = ENCODE_MENU_STRING (pane_name);
847 ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
850 pane_string = (NILP (pane_name)
851 ? "" : (char *) SDATA (pane_name));
852 /* If there is just one top-level pane, put all its items directly
853 under the top-level menu. */
854 if (menu_items_n_panes == 1)
857 /* If the pane has a meaningful name,
858 make the pane a top-level menu item
859 with its items as a submenu beneath it. */
860 if (!keymaps && strcmp (pane_string, ""))
862 wv = xmalloc_widget_value ();
866 first_wv->contents = wv;
867 wv->name = pane_string;
868 if (keymaps && !NILP (prefix))
872 wv->button_type = BUTTON_TYPE_NONE;
883 i += MENU_ITEMS_PANE_LENGTH;
887 /* Create a new item within current pane. */
888 Lisp_Object item_name, enable, descrip, def, type, selected, help;
889 item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
890 enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
891 descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
892 def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
893 type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
894 selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
895 help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);
897 #ifndef HAVE_MULTILINGUAL_MENU
898 if (STRINGP (item_name) && STRING_MULTIBYTE (item_name))
900 item_name = ENCODE_MENU_STRING (item_name);
901 ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
904 if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
906 descrip = ENCODE_MENU_STRING (descrip);
907 ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
909 #endif /* not HAVE_MULTILINGUAL_MENU */
911 wv = xmalloc_widget_value ();
915 save_wv->contents = wv;
916 wv->name = (char *) SDATA (item_name);
918 wv->key = (char *) SDATA (descrip);
920 /* If this item has a null value,
921 make the call_data null so that it won't display a box
922 when the mouse is on it. */
924 = !NILP (def) ? (void *) &XVECTOR (menu_items)->contents[i] : 0;
925 wv->enabled = !NILP (enable);
928 wv->button_type = BUTTON_TYPE_NONE;
929 else if (EQ (type, QCtoggle))
930 wv->button_type = BUTTON_TYPE_TOGGLE;
931 else if (EQ (type, QCradio))
932 wv->button_type = BUTTON_TYPE_RADIO;
936 wv->selected = !NILP (selected);
938 if (! STRINGP (help))
945 i += MENU_ITEMS_ITEM_LENGTH;
953 widget_value *wv_title = xmalloc_widget_value ();
954 widget_value *wv_sep = xmalloc_widget_value ();
956 /* Maybe replace this separator with a bitmap or owner-draw item
957 so that it looks better. Having two separators looks odd. */
959 wv_sep->next = first_wv->contents;
962 #ifndef HAVE_MULTILINGUAL_MENU
963 if (STRING_MULTIBYTE (title))
964 title = ENCODE_MENU_STRING (title);
967 wv_title->name = (char *) SDATA (title);
968 wv_title->enabled = NO;
969 wv_title->button_type = BUTTON_TYPE_NONE;
970 wv_title->help = Qnil;
971 wv_title->next = wv_sep;
972 first_wv->contents = wv_title;
975 pmenu = [[EmacsMenu alloc] initWithTitle:
976 [NSString stringWithUTF8String: SDATA (title)]];
977 [pmenu fillWithWidgetValue: first_wv->contents];
978 free_menubar_widget_value_tree (first_wv);
979 unbind_to (specpdl_count, Qnil);
981 popup_activated_flag = 1;
982 tem = [pmenu runMenuAt: p forFrame: f keymaps: keymaps];
983 popup_activated_flag = 0;
984 [[FRAME_NS_VIEW (SELECTED_FRAME ()) window] makeKeyWindow];
990 /* ==========================================================================
992 Toolbar: externally-called functions
994 ========================================================================== */
997 free_frame_tool_bar (FRAME_PTR f)
998 /* --------------------------------------------------------------------------
999 Under NS we just hide the toolbar until it might be needed again.
1000 -------------------------------------------------------------------------- */
1002 [[FRAME_NS_VIEW (f) toolbar] setVisible: NO];
1006 update_frame_tool_bar (FRAME_PTR f)
1007 /* --------------------------------------------------------------------------
1008 Update toolbar contents
1009 -------------------------------------------------------------------------- */
1012 EmacsToolbar *toolbar = [FRAME_NS_VIEW (f) toolbar];
1014 [toolbar clearActive];
1016 /* update EmacsToolbar as in GtkUtils, build items list */
1017 for (i = 0; i < f->n_tool_bar_items; ++i)
1019 #define TOOLPROP(IDX) AREF (f->tool_bar_items, \
1020 i * TOOL_BAR_ITEM_NSLOTS + (IDX))
1022 BOOL enabled_p = !NILP (TOOLPROP (TOOL_BAR_ITEM_ENABLED_P));
1023 BOOL selected_p = !NILP (TOOLPROP (TOOL_BAR_ITEM_SELECTED_P));
1028 Lisp_Object helpObj;
1031 /* If image is a vector, choose the image according to the
1033 image = TOOLPROP (TOOL_BAR_ITEM_IMAGES);
1034 if (VECTORP (image))
1036 /* NS toolbar auto-computes disabled and selected images */
1037 idx = TOOL_BAR_IMAGE_ENABLED_SELECTED;
1038 xassert (ASIZE (image) >= idx);
1039 image = AREF (image, idx);
1045 /* Ignore invalid image specifications. */
1046 if (!valid_image_p (image))
1048 NSLog (@"Invalid image for toolbar item");
1052 img_id = lookup_image (f, image);
1053 img = IMAGE_FROM_ID (f, img_id);
1054 prepare_image_for_display (f, img);
1056 if (img->load_failed_p || img->pixmap == nil)
1058 NSLog (@"Could not prepare toolbar image for display.");
1062 helpObj = TOOLPROP (TOOL_BAR_ITEM_HELP);
1064 helpObj = TOOLPROP (TOOL_BAR_ITEM_CAPTION);
1065 helpText = NILP (helpObj) ? "" : (char *)SDATA (helpObj);
1067 [toolbar addDisplayItemWithImage: img->pixmap idx: i helpText: helpText
1068 enabled: enabled_p];
1072 if (![toolbar isVisible])
1073 [toolbar setVisible: YES];
1075 if ([toolbar changed])
1077 /* inform app that toolbar has changed */
1078 NSDictionary *dict = [toolbar configurationDictionary];
1079 NSMutableDictionary *newDict = [dict mutableCopy];
1080 NSEnumerator *keys = [[dict allKeys] objectEnumerator];
1082 while ((key = [keys nextObject]) != nil)
1084 NSObject *val = [dict objectForKey: key];
1085 if ([val isKindOfClass: [NSArray class]])
1088 [toolbar toolbarDefaultItemIdentifiers: toolbar]
1093 [toolbar setConfigurationFromDictionary: newDict];
1100 /* ==========================================================================
1102 Toolbar: class implementation
1104 ========================================================================== */
1106 @implementation EmacsToolbar
1108 - initForView: (EmacsView *)view withIdentifier: (NSString *)identifier
1110 self = [super initWithIdentifier: identifier];
1112 [self setDisplayMode: NSToolbarDisplayModeIconOnly];
1113 [self setSizeMode: NSToolbarSizeModeSmall];
1114 [self setDelegate: self];
1115 identifierToItem = [[NSMutableDictionary alloc] initWithCapacity: 10];
1116 activeIdentifiers = [[NSMutableArray alloc] initWithCapacity: 8];
1117 prevEnablement = enablement = 0L;
1123 [prevIdentifiers release];
1124 [activeIdentifiers release];
1125 [identifierToItem release];
1129 - (void) clearActive
1131 [prevIdentifiers release];
1132 prevIdentifiers = [activeIdentifiers copy];
1133 [activeIdentifiers removeAllObjects];
1134 prevEnablement = enablement;
1140 return [activeIdentifiers isEqualToArray: prevIdentifiers] &&
1141 enablement == prevEnablement ? NO : YES;
1144 - (void) addDisplayItemWithImage: (EmacsImage *)img idx: (int)idx
1145 helpText: (char *)help enabled: (BOOL)enabled
1147 /* 1) come up w/identifier */
1148 NSString *identifier
1149 = [NSString stringWithFormat: @"%u", [img hash]];
1151 /* 2) create / reuse item */
1152 NSToolbarItem *item = [identifierToItem objectForKey: identifier];
1155 item = [[[NSToolbarItem alloc] initWithItemIdentifier: identifier]
1157 [item setImage: img];
1158 [item setToolTip: [NSString stringWithUTF8String: help]];
1159 [item setTarget: emacsView];
1160 [item setAction: @selector (toolbarClicked:)];
1164 [item setEnabled: enabled];
1166 /* 3) update state */
1167 [identifierToItem setObject: item forKey: identifier];
1168 [activeIdentifiers addObject: identifier];
1169 enablement = (enablement << 1) | (enabled == YES);
1172 /* This overrides super's implementation, which automatically sets
1173 all items to enabled state (for some reason). */
1174 - (void)validateVisibleItems { }
1177 /* delegate methods */
1179 - (NSToolbarItem *)toolbar: (NSToolbar *)toolbar
1180 itemForItemIdentifier: (NSString *)itemIdentifier
1181 willBeInsertedIntoToolbar: (BOOL)flag
1183 /* look up NSToolbarItem by identifier and return... */
1184 return [identifierToItem objectForKey: itemIdentifier];
1187 - (NSArray *)toolbarDefaultItemIdentifiers: (NSToolbar *)toolbar
1189 /* return entire set.. */
1190 return activeIdentifiers;
1193 /* for configuration palette (not yet supported) */
1194 - (NSArray *)toolbarAllowedItemIdentifiers: (NSToolbar *)toolbar
1196 /* return entire set... */
1197 return [identifierToItem allKeys];
1200 /* optional and unneeded */
1201 /* - toolbarWillAddItem: (NSNotification *)notification { } */
1202 /* - toolbarDidRemoveItem: (NSNotification *)notification { } */
1203 /* - (NSArray *)toolbarSelectableItemIdentifiers: (NSToolbar *)toolbar */
1205 @end /* EmacsToolbar */
1209 /* ==========================================================================
1211 Tooltip: class implementation
1213 ========================================================================== */
1215 /* Needed because NeXTstep does not provide enough control over tooltip
1217 @implementation EmacsTooltip
1221 NSColor *col = [NSColor colorWithCalibratedRed: 1.0 green: 1.0
1222 blue: 0.792 alpha: 0.95];
1223 NSFont *font = [NSFont toolTipsFontOfSize: 0];
1224 NSFont *sfont = [font screenFont];
1225 int height = [sfont ascender] - [sfont descender];
1226 /*[font boundingRectForFont].size.height; */
1227 NSRect r = NSMakeRect (0, 0, 100, height+6);
1229 textField = [[NSTextField alloc] initWithFrame: r];
1230 [textField setFont: font];
1231 [textField setBackgroundColor: col];
1233 [textField setEditable: NO];
1234 [textField setSelectable: NO];
1235 [textField setBordered: YES];
1236 [textField setBezeled: YES];
1237 [textField setDrawsBackground: YES];
1239 win = [[NSWindow alloc]
1240 initWithContentRect: [textField frame]
1242 backing: NSBackingStoreBuffered
1244 [win setReleasedWhenClosed: NO];
1245 [win setDelegate: self];
1246 [[win contentView] addSubview: textField];
1247 /* [win setBackgroundColor: col]; */
1248 [win setOpaque: NO];
1257 [textField release];
1261 - (void) setText: (char *)text
1263 NSString *str = [NSString stringWithUTF8String: text];
1264 NSRect r = [textField frame];
1265 NSSize textSize = [str sizeWithAttributes:
1266 [NSDictionary dictionaryWithObject: [[textField font] screenFont]
1267 forKey: NSFontAttributeName]];
1268 NSSize padSize = [[[textField font] screenFont]
1269 boundingRectForFont].size;
1271 r.size.width = textSize.width + padSize.width/2;
1272 r.size.height = textSize.height + padSize.height/2;
1273 [textField setFrame: r];
1274 [textField setStringValue: str];
1277 - (void) showAtX: (int)x Y: (int)y for: (int)seconds
1279 NSRect wr = [win frame];
1281 wr.origin = NSMakePoint (x, y);
1282 wr.size = [textField frame].size;
1284 [win setFrame: wr display: YES];
1285 [win orderFront: self];
1287 timer = [NSTimer scheduledTimerWithTimeInterval: (float)seconds target: self
1288 selector: @selector (hide)
1289 userInfo: nil repeats: NO];
1298 if ([timer isValid])
1307 return timer != nil;
1312 return [textField frame];
1315 @end /* EmacsTooltip */
1319 /* ==========================================================================
1321 Popup Dialog: implementing functions
1323 ========================================================================== */
1327 pop_down_menu (Lisp_Object arg)
1329 struct Lisp_Save_Value *p = XSAVE_VALUE (arg);
1330 if (popup_activated_flag)
1332 popup_activated_flag = 0;
1334 [NSApp endModalSession: popupSession];
1335 [((EmacsDialogPanel *) (p->pointer)) close];
1336 [[FRAME_NS_VIEW (SELECTED_FRAME ()) window] makeKeyWindow];
1344 ns_popup_dialog (Lisp_Object position, Lisp_Object contents, Lisp_Object header)
1347 Lisp_Object window, tem;
1352 NSTRACE (x-popup-dialog);
1356 isQ = NILP (header);
1358 if (EQ (position, Qt)
1359 || (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
1360 || EQ (XCAR (position), Qtool_bar))))
1362 window = selected_window;
1364 else if (CONSP (position))
1367 tem = Fcar (position);
1368 if (XTYPE (tem) == Lisp_Cons)
1369 window = Fcar (Fcdr (position));
1372 tem = Fcar (Fcdr (position)); /* EVENT_START (position) */
1373 window = Fcar (tem); /* POSN_WINDOW (tem) */
1376 else if (WINDOWP (position) || FRAMEP (position))
1383 if (FRAMEP (window))
1384 f = XFRAME (window);
1385 else if (WINDOWP (window))
1387 CHECK_LIVE_WINDOW (window);
1388 f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1391 CHECK_WINDOW (window);
1393 p.x = (int)f->left_pos + ((int)FRAME_COLUMN_WIDTH (f) * f->text_cols)/2;
1394 p.y = (int)f->top_pos + (FRAME_LINE_HEIGHT (f) * f->text_lines)/2;
1397 dialog = [[EmacsDialogPanel alloc] initFromContents: contents
1400 int specpdl_count = SPECPDL_INDEX ();
1401 record_unwind_protect (pop_down_menu, make_save_value (dialog, 0));
1402 popup_activated_flag = 1;
1403 tem = [dialog runDialogAt: p];
1404 unbind_to (specpdl_count, Qnil); /* calls pop_down_menu */
1412 /* ==========================================================================
1414 Popup Dialog: class implementation
1416 ========================================================================== */
1418 @interface FlippedView : NSView
1423 @implementation FlippedView
1430 @implementation EmacsDialogPanel
1433 #define ICONSIZE 64.0
1434 #define TEXTHEIGHT 20.0
1435 #define MINCELLWIDTH 90.0
1437 - initWithContentRect: (NSRect)contentRect styleMask: (NSUInteger)aStyle
1438 backing: (NSBackingStoreType)backingType defer: (BOOL)flag
1440 NSSize spacing = {SPACER, SPACER};
1442 char this_cmd_name[80];
1444 static NSImageView *imgView;
1445 static FlippedView *contentView;
1450 area.origin.x = 3*SPACER;
1451 area.origin.y = 2*SPACER;
1452 area.size.width = ICONSIZE;
1453 area.size.height= ICONSIZE;
1454 img = [[NSImage imageNamed: @"NSApplicationIcon"] copy];
1455 [img setScalesWhenResized: YES];
1456 [img setSize: NSMakeSize (ICONSIZE, ICONSIZE)];
1457 imgView = [[NSImageView alloc] initWithFrame: area];
1458 [imgView setImage: img];
1459 [imgView setEditable: NO];
1463 aStyle = NSTitledWindowMask;
1467 [super initWithContentRect: contentRect styleMask: aStyle
1468 backing: backingType defer: flag];
1469 contentView = [[FlippedView alloc] initWithFrame: [[self contentView] frame]];
1470 [self setContentView: contentView];
1472 [[self contentView] setAutoresizesSubviews: YES];
1474 [[self contentView] addSubview: imgView];
1475 [self setTitle: @""];
1477 area.origin.x += ICONSIZE+2*SPACER;
1478 /* area.origin.y = TEXTHEIGHT; ICONSIZE/2-10+SPACER; */
1479 area.size.width = 400;
1480 area.size.height= TEXTHEIGHT;
1481 command = [[[NSTextField alloc] initWithFrame: area] autorelease];
1482 [[self contentView] addSubview: command];
1483 [command setStringValue: ns_app_name];
1484 [command setDrawsBackground: NO];
1485 [command setBezeled: NO];
1486 [command setSelectable: NO];
1487 [command setFont: [NSFont boldSystemFontOfSize: 13.0]];
1489 /* area.origin.x = ICONSIZE+2*SPACER;
1490 area.origin.y = TEXTHEIGHT + 2*SPACER;
1491 area.size.width = 400;
1492 area.size.height= 2;
1493 tem = [[[NSBox alloc] initWithFrame: area] autorelease];
1494 [[self contentView] addSubview: tem];
1495 [tem setTitlePosition: NSNoTitle];
1496 [tem setAutoresizingMask: NSViewWidthSizable];*/
1498 /* area.origin.x = ICONSIZE+2*SPACER; */
1499 area.origin.y += TEXTHEIGHT+SPACER;
1500 area.size.width = 400;
1501 area.size.height= TEXTHEIGHT;
1502 title = [[[NSTextField alloc] initWithFrame: area] autorelease];
1503 [[self contentView] addSubview: title];
1504 [title setDrawsBackground: NO];
1505 [title setBezeled: NO];
1506 [title setSelectable: NO];
1507 [title setFont: [NSFont systemFontOfSize: 11.0]];
1509 cell = [[[NSButtonCell alloc] initTextCell: @""] autorelease];
1510 [cell setBordered: NO];
1511 [cell setEnabled: NO];
1512 [cell setCellAttribute: NSCellIsInsetButton to: 8];
1513 [cell setBezelStyle: NSRoundedBezelStyle];
1515 matrix = [[NSMatrix alloc] initWithFrame: contentRect
1516 mode: NSHighlightModeMatrix
1519 numberOfColumns: 1];
1520 [[self contentView] addSubview: matrix];
1522 [matrix setFrameOrigin: NSMakePoint (area.origin.x,
1523 area.origin.y + (TEXTHEIGHT+3*SPACER))];
1524 [matrix setIntercellSpacing: spacing];
1526 [self setOneShot: YES];
1527 [self setReleasedWhenClosed: YES];
1528 [self setHidesOnDeactivate: YES];
1533 - (BOOL)windowShouldClose: (id)sender
1535 [NSApp stopModalWithCode: XHASH (Qnil)]; // FIXME: BIG UGLY HACK!!
1540 void process_dialog (id window, Lisp_Object list)
1545 for (; XTYPE (list) == Lisp_Cons; list = XCDR (list))
1548 if (XTYPE (item) == Lisp_String)
1550 [window addString: SDATA (item) row: row++];
1552 else if (XTYPE (item) == Lisp_Cons)
1554 [window addButton: SDATA (XCAR (item))
1555 value: XCDR (item) row: row++];
1557 else if (NILP (item))
1566 - addButton: (char *)str value: (Lisp_Object)val row: (int)row
1575 cell = [matrix cellAtRow: row column: cols-1];
1576 [cell setTarget: self];
1577 [cell setAction: @selector (clicked: )];
1578 [cell setTitle: [NSString stringWithUTF8String: str]];
1579 [cell setTag: XHASH (val)]; // FIXME: BIG UGLY HACK!!
1580 [cell setBordered: YES];
1581 [cell setEnabled: YES];
1587 - addString: (char *)str row: (int)row
1596 cell = [matrix cellAtRow: row column: cols-1];
1597 [cell setTitle: [NSString stringWithUTF8String: str]];
1598 [cell setBordered: YES];
1599 [cell setEnabled: NO];
1615 NSArray *sellist = nil;
1618 sellist = [sender selectedCells];
1619 if ([sellist count]<1)
1622 seltag = [[sellist objectAtIndex: 0] tag];
1623 if (seltag != XHASH (Qundefined)) // FIXME: BIG UGLY HACK!!
1624 [NSApp stopModalWithCode: seltag];
1629 - initFromContents: (Lisp_Object)contents isQuestion: (BOOL)isQ
1634 if (XTYPE (contents) == Lisp_Cons)
1636 head = Fcar (contents);
1637 process_dialog (self, Fcdr (contents));
1642 if (XTYPE (head) == Lisp_String)
1643 [title setStringValue:
1644 [NSString stringWithUTF8String: SDATA (head)]];
1645 else if (isQ == YES)
1646 [title setStringValue: @"Question"];
1648 [title setStringValue: @"Information"];
1654 if (cols == 1 && rows > 1) /* Never told where to split */
1657 for (i = 0; i<rows/2; i++)
1659 [matrix putCell: [matrix cellAtRow: (rows+1)/2 column: 0]
1660 atRow: i column: 1];
1661 [matrix removeRow: (rows+1)/2];
1667 NSSize csize = [matrix cellSize];
1668 if (csize.width < MINCELLWIDTH)
1670 csize.width = MINCELLWIDTH;
1671 [matrix setCellSize: csize];
1672 [matrix sizeToCells];
1677 [command sizeToFit];
1681 if (r.size.width+r.origin.x > t.size.width+t.origin.x)
1683 t.origin.x = r.origin.x;
1684 t.size.width = r.size.width;
1686 r = [command frame];
1687 if (r.size.width+r.origin.x > t.size.width+t.origin.x)
1689 t.origin.x = r.origin.x;
1690 t.size.width = r.size.width;
1694 s = [(NSView *)[self contentView] frame];
1695 r.size.width += t.origin.x+t.size.width +2*SPACER-s.size.width;
1696 r.size.height += t.origin.y+t.size.height+SPACER-s.size.height;
1697 [self setFrame: r display: NO];
1706 { [super dealloc]; return; };
1710 - (Lisp_Object)runDialogAt: (NSPoint)p
1713 extern EMACS_TIME timer_check (int do_it_now); /* TODO: add to a header */
1715 /* initiate a session that will be ended by pop_down_menu */
1716 popupSession = [NSApp beginModalSessionForWindow: self];
1717 while (popup_activated_flag
1718 && (ret = [NSApp runModalSession: popupSession])
1719 == NSRunContinuesResponse)
1721 /* Run this for timers.el, indep of atimers; might not return.
1722 TODO: use return value to avoid calling every iteration. */
1724 [NSThread sleepUntilDate: [NSDate dateWithTimeIntervalSinceNow: 0.1]];
1727 { /* FIXME: BIG UGLY HACK!!! */
1729 *(EMACS_INT*)(&tmp) = ret;
1737 /* ==========================================================================
1741 ========================================================================== */
1743 DEFUN ("ns-reset-menu", Fns_reset_menu, Sns_reset_menu, 0, 0, 0,
1744 doc: /* Cause the NS menu to be re-calculated. */)
1747 set_frame_menubar (SELECTED_FRAME (), 1, 0);
1752 DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 3, 0,
1753 doc: /* Pop up a dialog box and return user's selection.
1754 POSITION specifies which frame to use.
1755 This is normally a mouse button event or a window or frame.
1756 If POSITION is t, it means to use the frame the mouse is on.
1757 The dialog box appears in the middle of the specified frame.
1759 CONTENTS specifies the alternatives to display in the dialog box.
1760 It is a list of the form (DIALOG ITEM1 ITEM2...).
1761 Each ITEM is a cons cell (STRING . VALUE).
1762 The return value is VALUE from the chosen item.
1764 An ITEM may also be just a string--that makes a nonselectable item.
1765 An ITEM may also be nil--that means to put all preceding items
1766 on the left of the dialog box and all following items on the right.
1767 \(By default, approximately half appear on each side.)
1769 If HEADER is non-nil, the frame title for the box is "Information",
1770 otherwise it is "Question".
1772 If the user gets rid of the dialog box without making a valid choice,
1773 for instance using the window manager, then this produces a quit and
1774 `x-popup-dialog' does not return. */)
1775 (position, contents, header)
1776 Lisp_Object position, contents, header;
1778 return ns_popup_dialog (position, contents, header);
1781 DEFUN ("menu-or-popup-active-p", Fmenu_or_popup_active_p, Smenu_or_popup_active_p, 0, 0, 0,
1782 doc: /* Return t if a menu or popup dialog is active. */)
1785 return popup_activated () ? Qt : Qnil;
1788 /* ==========================================================================
1790 Lisp interface declaration
1792 ========================================================================== */
1797 defsubr (&Sx_popup_dialog);
1798 defsubr (&Sns_reset_menu);
1799 defsubr (&Smenu_or_popup_active_p);
1801 Qdebug_on_next_call = intern ("debug-on-next-call");
1802 staticpro (&Qdebug_on_next_call);
1805 // arch-tag: 75773656-52e5-4c44-a398-47bd87b32619