icomplete-prospects-height fix (tiny change)
[emacs.git] / src / nsfns.m
blob1750eb62cdf611626cc073096873685153d43697
1 /* Functions for the NeXT/Open/GNUstep and MacOSX window system.
3 Copyright (C) 1989, 1992-1994, 2005-2006, 2008-2013 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
22 Originally by Carl Edman
23 Updated by Christian Limpach (chris@nice.ch)
24 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
25 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
26 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
29 /* This should be the first include, as it may set up #defines affecting
30    interpretation of even the system includes. */
31 #include <config.h>
33 #include <math.h>
34 #include <c-strcase.h>
36 #include "lisp.h"
37 #include "blockinput.h"
38 #include "nsterm.h"
39 #include "window.h"
40 #include "character.h"
41 #include "buffer.h"
42 #include "keyboard.h"
43 #include "termhooks.h"
44 #include "fontset.h"
45 #include "font.h"
47 #if 0
48 int fns_trace_num = 1;
49 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",        \
50                                   __FILE__, __LINE__, ++fns_trace_num)
51 #else
52 #define NSTRACE(x)
53 #endif
55 #ifdef HAVE_NS
57 extern NSArray *ns_send_types, *ns_return_types, *ns_drag_types;
59 extern Lisp_Object Qforeground_color;
60 extern Lisp_Object Qbackground_color;
61 extern Lisp_Object Qcursor_color;
62 extern Lisp_Object Qinternal_border_width;
63 extern Lisp_Object Qvisibility;
64 extern Lisp_Object Qcursor_type;
65 extern Lisp_Object Qicon_type;
66 extern Lisp_Object Qicon_name;
67 extern Lisp_Object Qicon_left;
68 extern Lisp_Object Qicon_top;
69 extern Lisp_Object Qleft;
70 extern Lisp_Object Qright;
71 extern Lisp_Object Qtop;
72 extern Lisp_Object Qdisplay;
73 extern Lisp_Object Qvertical_scroll_bars;
74 extern Lisp_Object Qauto_raise;
75 extern Lisp_Object Qauto_lower;
76 extern Lisp_Object Qbox;
77 extern Lisp_Object Qscroll_bar_width;
78 extern Lisp_Object Qx_resource_name;
79 extern Lisp_Object Qface_set_after_frame_default;
80 extern Lisp_Object Qunderline, Qundefined;
81 extern Lisp_Object Qheight, Qminibuffer, Qname, Qonly, Qwidth;
82 extern Lisp_Object Qunsplittable, Qmenu_bar_lines, Qbuffer_predicate, Qtitle;
85 Lisp_Object Qbuffered;
86 Lisp_Object Qfontsize;
88 /* hack for OS X file panels */
89 char panelOK = 0;
91 EmacsTooltip *ns_tooltip;
93 /* Need forward declaration here to preserve organizational integrity of file */
94 Lisp_Object Fx_open_connection (Lisp_Object, Lisp_Object, Lisp_Object);
96 /* Static variables to handle applescript execution.  */
97 static Lisp_Object as_script, *as_result;
98 static int as_status;
100 #ifdef GLYPH_DEBUG
101 static ptrdiff_t image_cache_refcount;
102 #endif
104 /* ==========================================================================
106     Internal utility functions
108    ========================================================================== */
111 void
112 check_ns (void)
114  if (NSApp == nil)
115    error ("OpenStep is not in use or not initialized");
119 /* Nonzero if we can use mouse menus. */
121 have_menus_p (void)
123   return NSApp != nil;
127 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
128    and checking validity for NS.  */
129 static FRAME_PTR
130 check_ns_frame (Lisp_Object frame)
132   FRAME_PTR f;
134   if (NILP (frame))
135       f = SELECTED_FRAME ();
136   else
137     {
138       CHECK_LIVE_FRAME (frame);
139       f = XFRAME (frame);
140     }
141   if (! FRAME_NS_P (f))
142     error ("non-Nextstep frame used");
143   return f;
147 /* Let the user specify an Nextstep display with a frame.
148    nil stands for the selected frame--or, if that is not an Nextstep frame,
149    the first Nextstep display on the list.  */
150 static struct ns_display_info *
151 check_ns_display_info (Lisp_Object frame)
153   if (NILP (frame))
154     {
155       struct frame *f = SELECTED_FRAME ();
156       if (FRAME_NS_P (f) && FRAME_LIVE_P (f) )
157         return FRAME_NS_DISPLAY_INFO (f);
158       else if (x_display_list != 0)
159         return x_display_list;
160       else
161         error ("Nextstep windows are not in use or not initialized");
162     }
163   else if (INTEGERP (frame))
164     {
165       struct terminal *t = get_terminal (frame, 1);
167       if (t->type != output_ns)
168         error ("Terminal %"pI"d is not a Nextstep display", XINT (frame));
170       return t->display_info.ns;
171     }
172   else if (STRINGP (frame))
173     return ns_display_info_for_name (frame);
174   else
175     {
176       FRAME_PTR f;
178       CHECK_LIVE_FRAME (frame);
179       f = XFRAME (frame);
180       if (! FRAME_NS_P (f))
181         error ("non-Nextstep frame used");
182       return FRAME_NS_DISPLAY_INFO (f);
183     }
184   return NULL;  /* shut compiler up */
188 static id
189 ns_get_window (Lisp_Object maybeFrame)
191   id view =nil, window =nil;
193   if (!FRAMEP (maybeFrame) || !FRAME_NS_P (XFRAME (maybeFrame)))
194     maybeFrame = selected_frame;/*wrong_type_argument (Qframep, maybeFrame); */
196   if (!NILP (maybeFrame))
197     view = FRAME_NS_VIEW (XFRAME (maybeFrame));
198   if (view) window =[view window];
200   return window;
204 static NSScreen *
205 ns_get_screen (Lisp_Object screen)
207   struct frame *f;
208   struct terminal *terminal;
210   if (EQ (Qt, screen)) /* not documented */
211     return [NSScreen mainScreen];
213   terminal = get_terminal (screen, 1);
214   if (terminal->type != output_ns)
215     return NULL;
217   if (NILP (screen))
218     f = SELECTED_FRAME ();
219   else if (FRAMEP (screen))
220     f = XFRAME (screen);
221   else
222     {
223       struct ns_display_info *dpyinfo = terminal->display_info.ns;
224       f = dpyinfo->x_focus_frame
225         ? dpyinfo->x_focus_frame : dpyinfo->x_highlight_frame;
226     }
228   return ((f && FRAME_NS_P (f)) ? [[FRAME_NS_VIEW (f) window] screen]
229           : NULL);
233 /* Return the X display structure for the display named NAME.
234    Open a new connection if necessary.  */
235 struct ns_display_info *
236 ns_display_info_for_name (Lisp_Object name)
238   Lisp_Object names;
239   struct ns_display_info *dpyinfo;
241   CHECK_STRING (name);
243   for (dpyinfo = x_display_list, names = ns_display_name_list;
244        dpyinfo;
245        dpyinfo = dpyinfo->next, names = XCDR (names))
246     {
247       Lisp_Object tem;
248       tem = Fstring_equal (XCAR (XCAR (names)), name);
249       if (!NILP (tem))
250         return dpyinfo;
251     }
253   error ("Emacs for OpenStep does not yet support multi-display.");
255   Fx_open_connection (name, Qnil, Qnil);
256   dpyinfo = x_display_list;
258   if (dpyinfo == 0)
259     error ("OpenStep on %s not responding.\n", SDATA (name));
261   return dpyinfo;
265 static Lisp_Object
266 interpret_services_menu (NSMenu *menu, Lisp_Object prefix, Lisp_Object old)
267 /* --------------------------------------------------------------------------
268    Turn the input menu (an NSMenu) into a lisp list for tracking on lisp side
269    -------------------------------------------------------------------------- */
271   int i, count;
272   NSMenuItem *item;
273   const char *name;
274   Lisp_Object nameStr;
275   unsigned short key;
276   NSString *keys;
277   Lisp_Object res;
279   count = [menu numberOfItems];
280   for (i = 0; i<count; i++)
281     {
282       item = [menu itemAtIndex: i];
283       name = [[item title] UTF8String];
284       if (!name) continue;
286       nameStr = build_string (name);
288       if ([item hasSubmenu])
289         {
290           old = interpret_services_menu ([item submenu],
291                                         Fcons (nameStr, prefix), old);
292         }
293       else
294         {
295           keys = [item keyEquivalent];
296           if (keys && [keys length] )
297             {
298               key = [keys characterAtIndex: 0];
299               res = make_number (key|super_modifier);
300             }
301           else
302             {
303               res = Qundefined;
304             }
305           old = Fcons (Fcons (res,
306                             Freverse (Fcons (nameStr,
307                                            prefix))),
308                     old);
309         }
310     }
311   return old;
316 /* ==========================================================================
318     Frame parameter setters
320    ========================================================================== */
323 static void
324 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
326   NSColor *col;
327   CGFloat r, g, b, alpha;
329   if (ns_lisp_to_color (arg, &col))
330     {
331       store_frame_param (f, Qforeground_color, oldval);
332       error ("Unknown color");
333     }
335   [col retain];
336   [f->output_data.ns->foreground_color release];
337   f->output_data.ns->foreground_color = col;
339   [col getRed: &r green: &g blue: &b alpha: &alpha];
340   FRAME_FOREGROUND_PIXEL (f) =
341     ARGB_TO_ULONG ((int)(alpha*0xff), (int)(r*0xff), (int)(g*0xff), (int)(b*0xff));
343   if (FRAME_NS_VIEW (f))
344     {
345       update_face_from_frame_parameter (f, Qforeground_color, arg);
346       /*recompute_basic_faces (f); */
347       if (FRAME_VISIBLE_P (f))
348         redraw_frame (f);
349     }
353 static void
354 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
356   struct face *face;
357   NSColor *col;
358   NSView *view = FRAME_NS_VIEW (f);
359   CGFloat r, g, b, alpha;
361   if (ns_lisp_to_color (arg, &col))
362     {
363       store_frame_param (f, Qbackground_color, oldval);
364       error ("Unknown color");
365     }
367   /* clear the frame; in some instances the NS-internal GC appears not to
368      update, or it does update and cannot clear old text properly */
369   if (FRAME_VISIBLE_P (f))
370     ns_clear_frame (f);
372   [col retain];
373   [f->output_data.ns->background_color release];
374   f->output_data.ns->background_color = col;
376   [col getRed: &r green: &g blue: &b alpha: &alpha];
377   FRAME_BACKGROUND_PIXEL (f) =
378     ARGB_TO_ULONG ((int)(alpha*0xff), (int)(r*0xff), (int)(g*0xff), (int)(b*0xff));
380   if (view != nil)
381     {
382       [[view window] setBackgroundColor: col];
384       if (alpha != 1.0)
385           [[view window] setOpaque: NO];
386       else
387           [[view window] setOpaque: YES];
389       face = FRAME_DEFAULT_FACE (f);
390       if (face)
391         {
392           col = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f);
393           face->background = ns_index_color
394             ([col colorWithAlphaComponent: alpha], f);
396           update_face_from_frame_parameter (f, Qbackground_color, arg);
397         }
399       if (FRAME_VISIBLE_P (f))
400         redraw_frame (f);
401     }
405 static void
406 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
408   NSColor *col;
410   if (ns_lisp_to_color (arg, &col))
411     {
412       store_frame_param (f, Qcursor_color, oldval);
413       error ("Unknown color");
414     }
416   [FRAME_CURSOR_COLOR (f) release];
417   FRAME_CURSOR_COLOR (f) = [col retain];
419   if (FRAME_VISIBLE_P (f))
420     {
421       x_update_cursor (f, 0);
422       x_update_cursor (f, 1);
423     }
424   update_face_from_frame_parameter (f, Qcursor_color, arg);
428 static void
429 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
431   NSView *view = FRAME_NS_VIEW (f);
432   NSTRACE (x_set_icon_name);
434   /* see if it's changed */
435   if (STRINGP (arg))
436     {
437       if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
438         return;
439     }
440   else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
441     return;
443   fset_icon_name (f, arg);
445   if (NILP (arg))
446     {
447       if (!NILP (f->title))
448         arg = f->title;
449       else
450         /* explicit name and no icon-name -> explicit_name */
451         if (f->explicit_name)
452           arg = f->name;
453         else
454           {
455             /* no explicit name and no icon-name ->
456                name has to be rebuild from icon_title_format */
457             windows_or_buffers_changed++;
458             return;
459           }
460     }
462   /* Don't change the name if it's already NAME.  */
463   if ([[view window] miniwindowTitle] &&
464       ([[[view window] miniwindowTitle]
465              isEqualToString: [NSString stringWithUTF8String:
466                                            SSDATA (arg)]]))
467     return;
469   [[view window] setMiniwindowTitle:
470         [NSString stringWithUTF8String: SSDATA (arg)]];
473 static void
474 ns_set_name_internal (FRAME_PTR f, Lisp_Object name)
476   struct gcpro gcpro1;
477   Lisp_Object encoded_name, encoded_icon_name;
478   NSString *str;
479   NSView *view = FRAME_NS_VIEW (f);
481   GCPRO1 (name);
482   encoded_name = ENCODE_UTF_8 (name);
483   UNGCPRO;
485   str = [NSString stringWithUTF8String: SSDATA (encoded_name)];
487   /* Don't change the name if it's already NAME.  */
488   if (! [[[view window] title] isEqualToString: str])
489     [[view window] setTitle: str];
491   if (!STRINGP (f->icon_name))
492     encoded_icon_name = encoded_name;
493   else
494     encoded_icon_name = ENCODE_UTF_8 (f->icon_name);
496   str = [NSString stringWithUTF8String: SSDATA (encoded_icon_name)];
498   if ([[view window] miniwindowTitle] &&
499       ! [[[view window] miniwindowTitle] isEqualToString: str])
500     [[view window] setMiniwindowTitle: str];
504 static void
505 ns_set_name (struct frame *f, Lisp_Object name, int explicit)
507   NSTRACE (ns_set_name);
509   /* Make sure that requests from lisp code override requests from
510      Emacs redisplay code.  */
511   if (explicit)
512     {
513       /* If we're switching from explicit to implicit, we had better
514          update the mode lines and thereby update the title.  */
515       if (f->explicit_name && NILP (name))
516         update_mode_lines = 1;
518       f->explicit_name = ! NILP (name);
519     }
520   else if (f->explicit_name)
521     return;
523   if (NILP (name))
524     name = build_string([ns_app_name UTF8String]);
525   else
526     CHECK_STRING (name);
528   /* Don't change the name if it's already NAME.  */
529   if (! NILP (Fstring_equal (name, f->name)))
530     return;
532   fset_name (f, name);
534   /* title overrides explicit name */
535   if (! NILP (f->title))
536     name = f->title;
538   ns_set_name_internal (f, name);
542 /* This function should be called when the user's lisp code has
543    specified a name for the frame; the name will override any set by the
544    redisplay code.  */
545 static void
546 x_explicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
548   NSTRACE (x_explicitly_set_name);
549   ns_set_name (f, arg, 1);
553 /* This function should be called by Emacs redisplay code to set the
554    name; names set this way will never override names set by the user's
555    lisp code.  */
556 void
557 x_implicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
559   NSTRACE (x_implicitly_set_name);
561   /* Deal with NS specific format t.  */
562   if (FRAME_NS_P (f) && ((FRAME_ICONIFIED_P (f) && EQ (Vicon_title_format, Qt))
563                          || EQ (Vframe_title_format, Qt)))
564     ns_set_name_as_filename (f);
565   else
566     ns_set_name (f, arg, 0);
570 /* Change the title of frame F to NAME.
571    If NAME is nil, use the frame name as the title.  */
573 static void
574 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
576   NSTRACE (x_set_title);
577   /* Don't change the title if it's already NAME.  */
578   if (EQ (name, f->title))
579     return;
581   update_mode_lines = 1;
583   fset_title (f, name);
585   if (NILP (name))
586     name = f->name;
587   else
588     CHECK_STRING (name);
590   ns_set_name_internal (f, name);
594 void
595 ns_set_name_as_filename (struct frame *f)
597   NSView *view;
598   Lisp_Object name, filename;
599   Lisp_Object buf = XWINDOW (f->selected_window)->buffer;
600   const char *title;
601   NSAutoreleasePool *pool;
602   struct gcpro gcpro1;
603   Lisp_Object encoded_name, encoded_filename;
604   NSString *str;
605   NSTRACE (ns_set_name_as_filename);
607   if (f->explicit_name || ! NILP (f->title))
608     return;
610   block_input ();
611   pool = [[NSAutoreleasePool alloc] init];
612   filename = BVAR (XBUFFER (buf), filename);
613   name = BVAR (XBUFFER (buf), name);
615   if (NILP (name))
616     {
617       if (! NILP (filename))
618         name = Ffile_name_nondirectory (filename);
619       else
620         name = build_string ([ns_app_name UTF8String]);
621     }
623   GCPRO1 (name);
624   encoded_name = ENCODE_UTF_8 (name);
625   UNGCPRO;
627   view = FRAME_NS_VIEW (f);
629   title = FRAME_ICONIFIED_P (f) ? [[[view window] miniwindowTitle] UTF8String]
630                                 : [[[view window] title] UTF8String];
632   if (title && (! strcmp (title, SSDATA (encoded_name))))
633     {
634       [pool release];
635       unblock_input ();
636       return;
637     }
639   str = [NSString stringWithUTF8String: SSDATA (encoded_name)];
640   if (str == nil) str = @"Bad coding";
642   if (FRAME_ICONIFIED_P (f))
643     [[view window] setMiniwindowTitle: str];
644   else
645     {
646       NSString *fstr;
648       if (! NILP (filename))
649         {
650           GCPRO1 (filename);
651           encoded_filename = ENCODE_UTF_8 (filename);
652           UNGCPRO;
654           fstr = [NSString stringWithUTF8String: SSDATA (encoded_filename)];
655           if (fstr == nil) fstr = @"";
656 #ifdef NS_IMPL_COCOA
657           /* work around a bug observed on 10.3 and later where
658              setTitleWithRepresentedFilename does not clear out previous state
659              if given filename does not exist */
660           if (! [[NSFileManager defaultManager] fileExistsAtPath: fstr])
661             [[view window] setRepresentedFilename: @""];
662 #endif
663         }
664       else
665         fstr = @"";
667       [[view window] setRepresentedFilename: fstr];
668       [[view window] setTitle: str];
669       fset_name (f, name);
670     }
672   [pool release];
673   unblock_input ();
677 void
678 ns_set_doc_edited (struct frame *f, Lisp_Object arg)
680   NSView *view = FRAME_NS_VIEW (f);
681   NSAutoreleasePool *pool;
682   if (!MINI_WINDOW_P (XWINDOW (f->selected_window)))
683     {
684       block_input ();
685       pool = [[NSAutoreleasePool alloc] init];
686       [[view window] setDocumentEdited: !NILP (arg)];
687       [pool release];
688       unblock_input ();
689     }
693 void
694 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
696   int nlines;
697   if (FRAME_MINIBUF_ONLY_P (f))
698     return;
700   if (TYPE_RANGED_INTEGERP (int, value))
701     nlines = XINT (value);
702   else
703     nlines = 0;
705   FRAME_MENU_BAR_LINES (f) = 0;
706   if (nlines)
707     {
708       FRAME_EXTERNAL_MENU_BAR (f) = 1;
709       /* does for all frames, whereas we just want for one frame
710          [NSMenu setMenuBarVisible: YES]; */
711     }
712   else
713     {
714       if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
715         free_frame_menubar (f);
716       /*      [NSMenu setMenuBarVisible: NO]; */
717       FRAME_EXTERNAL_MENU_BAR (f) = 0;
718     }
722 /* toolbar support */
723 void
724 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
726   int nlines;
728   if (FRAME_MINIBUF_ONLY_P (f))
729     return;
731   if (RANGED_INTEGERP (0, value, INT_MAX))
732     nlines = XFASTINT (value);
733   else
734     nlines = 0;
736   if (nlines)
737     {
738       FRAME_EXTERNAL_TOOL_BAR (f) = 1;
739       update_frame_tool_bar (f);
740     }
741   else
742     {
743       if (FRAME_EXTERNAL_TOOL_BAR (f))
744         {
745           free_frame_tool_bar (f);
746           FRAME_EXTERNAL_TOOL_BAR (f) = 0;
747         }
748     }
750   x_set_window_size (f, 0, f->text_cols, f->text_lines);
754 void
755 ns_implicitly_set_icon_type (struct frame *f)
757   Lisp_Object tem;
758   EmacsView *view = FRAME_NS_VIEW (f);
759   id image = nil;
760   Lisp_Object chain, elt;
761   NSAutoreleasePool *pool;
762   BOOL setMini = YES;
764   NSTRACE (ns_implicitly_set_icon_type);
766   block_input ();
767   pool = [[NSAutoreleasePool alloc] init];
768   if (f->output_data.ns->miniimage
769       && [[NSString stringWithUTF8String: SSDATA (f->name)]
770                isEqualToString: [(NSImage *)f->output_data.ns->miniimage name]])
771     {
772       [pool release];
773       unblock_input ();
774       return;
775     }
777   tem = assq_no_quit (Qicon_type, f->param_alist);
778   if (CONSP (tem) && ! NILP (XCDR (tem)))
779     {
780       [pool release];
781       unblock_input ();
782       return;
783     }
785   for (chain = Vns_icon_type_alist;
786        image == nil && CONSP (chain);
787        chain = XCDR (chain))
788     {
789       elt = XCAR (chain);
790       /* special case: 't' means go by file type */
791       if (SYMBOLP (elt) && EQ (elt, Qt) && SSDATA (f->name)[0] == '/')
792         {
793           NSString *str
794              = [NSString stringWithUTF8String: SSDATA (f->name)];
795           if ([[NSFileManager defaultManager] fileExistsAtPath: str])
796             image = [[[NSWorkspace sharedWorkspace] iconForFile: str] retain];
797         }
798       else if (CONSP (elt) &&
799                STRINGP (XCAR (elt)) &&
800                STRINGP (XCDR (elt)) &&
801                fast_string_match (XCAR (elt), f->name) >= 0)
802         {
803           image = [EmacsImage allocInitFromFile: XCDR (elt)];
804           if (image == nil)
805             image = [[NSImage imageNamed:
806                                [NSString stringWithUTF8String:
807                                             SSDATA (XCDR (elt))]] retain];
808         }
809     }
811   if (image == nil)
812     {
813       image = [[[NSWorkspace sharedWorkspace] iconForFileType: @"text"] retain];
814       setMini = NO;
815     }
817   [f->output_data.ns->miniimage release];
818   f->output_data.ns->miniimage = image;
819   [view setMiniwindowImage: setMini];
820   [pool release];
821   unblock_input ();
825 static void
826 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
828   EmacsView *view = FRAME_NS_VIEW (f);
829   id image = nil;
830   BOOL setMini = YES;
832   NSTRACE (x_set_icon_type);
834   if (!NILP (arg) && SYMBOLP (arg))
835     {
836       arg =build_string (SSDATA (SYMBOL_NAME (arg)));
837       store_frame_param (f, Qicon_type, arg);
838     }
840   /* do it the implicit way */
841   if (NILP (arg))
842     {
843       ns_implicitly_set_icon_type (f);
844       return;
845     }
847   CHECK_STRING (arg);
849   image = [EmacsImage allocInitFromFile: arg];
850   if (image == nil)
851     image =[NSImage imageNamed: [NSString stringWithUTF8String:
852                                             SSDATA (arg)]];
854   if (image == nil)
855     {
856       image = [NSImage imageNamed: @"text"];
857       setMini = NO;
858     }
860   f->output_data.ns->miniimage = image;
861   [view setMiniwindowImage: setMini];
865 /* TODO: move to nsterm? */
867 ns_lisp_to_cursor_type (Lisp_Object arg)
869   char *str;
870   if (XTYPE (arg) == Lisp_String)
871     str = SSDATA (arg);
872   else if (XTYPE (arg) == Lisp_Symbol)
873     str = SSDATA (SYMBOL_NAME (arg));
874   else return -1;
875   if (!strcmp (str, "box"))     return FILLED_BOX_CURSOR;
876   if (!strcmp (str, "hollow"))  return HOLLOW_BOX_CURSOR;
877   if (!strcmp (str, "hbar"))    return HBAR_CURSOR;
878   if (!strcmp (str, "bar"))     return BAR_CURSOR;
879   if (!strcmp (str, "no"))      return NO_CURSOR;
880   return -1;
884 Lisp_Object
885 ns_cursor_type_to_lisp (int arg)
887   switch (arg)
888     {
889     case FILLED_BOX_CURSOR: return Qbox;
890     case HOLLOW_BOX_CURSOR: return intern ("hollow");
891     case HBAR_CURSOR:       return intern ("hbar");
892     case BAR_CURSOR:        return intern ("bar");
893     case NO_CURSOR:
894     default:                return intern ("no");
895     }
898 /* This is the same as the xfns.c definition.  */
899 void
900 x_set_cursor_type (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
902   set_frame_cursor_types (f, arg);
904   /* Make sure the cursor gets redrawn.  */
905   cursor_type_changed = 1;
909 /* called to set mouse pointer color, but all other terms use it to
910    initialize pointer types (and don't set the color ;) */
911 static void
912 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
914   /* don't think we can do this on Nextstep */
918 #define Str(x) #x
919 #define Xstr(x) Str(x)
921 static Lisp_Object
922 ns_appkit_version_str (void)
924   char tmp[80];
926 #ifdef NS_IMPL_GNUSTEP
927   sprintf(tmp, "gnustep-gui-%s", Xstr(GNUSTEP_GUI_VERSION));
928 #elif defined(NS_IMPL_COCOA)
929   sprintf(tmp, "apple-appkit-%.2f", NSAppKitVersionNumber);
930 #else
931   tmp = "ns-unknown";
932 #endif
933   return build_string (tmp);
937 /* This is for use by x-server-version and collapses all version info we
938    have into a single int.  For a better picture of the implementation
939    running, use ns_appkit_version_str.*/
940 static int
941 ns_appkit_version_int (void)
943 #ifdef NS_IMPL_GNUSTEP
944   return GNUSTEP_GUI_MAJOR_VERSION * 100 + GNUSTEP_GUI_MINOR_VERSION;
945 #elif defined(NS_IMPL_COCOA)
946   return (int)NSAppKitVersionNumber;
947 #endif
948   return 0;
952 static void
953 x_icon (struct frame *f, Lisp_Object parms)
954 /* --------------------------------------------------------------------------
955    Strangely-named function to set icon position parameters in frame.
956    This is irrelevant under OS X, but might be needed under GNUstep,
957    depending on the window manager used.  Note, this is not a standard
958    frame parameter-setter; it is called directly from x-create-frame.
959    -------------------------------------------------------------------------- */
961   Lisp_Object icon_x, icon_y;
962   struct ns_display_info *dpyinfo = check_ns_display_info (Qnil);
964   f->output_data.ns->icon_top = Qnil;
965   f->output_data.ns->icon_left = Qnil;
967   /* Set the position of the icon.  */
968   icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
969   icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0,  RES_TYPE_NUMBER);
970   if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
971     {
972       CHECK_NUMBER (icon_x);
973       CHECK_NUMBER (icon_y);
974       f->output_data.ns->icon_top = icon_y;
975       f->output_data.ns->icon_left = icon_x;
976     }
977   else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
978     error ("Both left and top icon corners of icon must be specified");
982 /* Note: see frame.c for template, also where generic functions are impl */
983 frame_parm_handler ns_frame_parm_handlers[] =
985   x_set_autoraise, /* generic OK */
986   x_set_autolower, /* generic OK */
987   x_set_background_color,
988   0, /* x_set_border_color,  may be impossible under Nextstep */
989   0, /* x_set_border_width,  may be impossible under Nextstep */
990   x_set_cursor_color,
991   x_set_cursor_type,
992   x_set_font, /* generic OK */
993   x_set_foreground_color,
994   x_set_icon_name,
995   x_set_icon_type,
996   x_set_internal_border_width, /* generic OK */
997   x_set_menu_bar_lines,
998   x_set_mouse_color,
999   x_explicitly_set_name,
1000   x_set_scroll_bar_width, /* generic OK */
1001   x_set_title,
1002   x_set_unsplittable, /* generic OK */
1003   x_set_vertical_scroll_bars, /* generic OK */
1004   x_set_visibility, /* generic OK */
1005   x_set_tool_bar_lines,
1006   0, /* x_set_scroll_bar_foreground, will ignore (not possible on NS) */
1007   0, /* x_set_scroll_bar_background,  will ignore (not possible on NS) */
1008   x_set_screen_gamma, /* generic OK */
1009   x_set_line_spacing, /* generic OK, sets f->extra_line_spacing to int */
1010   x_set_fringe_width, /* generic OK */
1011   x_set_fringe_width, /* generic OK */
1012   0, /* x_set_wait_for_wm, will ignore */
1013   x_set_fullscreen, /* generic OK */
1014   x_set_font_backend, /* generic OK */
1015   x_set_alpha,
1016   0, /* x_set_sticky */
1017   0, /* x_set_tool_bar_position */
1021 /* Handler for signals raised during x_create_frame.
1022    FRAME is the frame which is partially constructed.  */
1024 static Lisp_Object
1025 unwind_create_frame (Lisp_Object frame)
1027   struct frame *f = XFRAME (frame);
1029   /* If frame is already dead, nothing to do.  This can happen if the
1030      display is disconnected after the frame has become official, but
1031      before x_create_frame removes the unwind protect.  */
1032   if (!FRAME_LIVE_P (f))
1033     return Qnil;
1035   /* If frame is ``official'', nothing to do.  */
1036   if (NILP (Fmemq (frame, Vframe_list)))
1037     {
1038 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1039       struct ns_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1040 #endif
1042       x_free_frame_resources (f);
1043       free_glyphs (f);
1045 #ifdef GLYPH_DEBUG
1046       /* Check that reference counts are indeed correct.  */
1047       eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
1048 #endif
1049       return Qt;
1050     }
1052   return Qnil;
1056  * Read geometry related parameters from preferences if not in PARMS.
1057  * Returns the union of parms and any preferences read.
1058  */
1060 static Lisp_Object
1061 get_geometry_from_preferences (struct ns_display_info *dpyinfo,
1062                                Lisp_Object parms)
1064   struct {
1065     const char *val;
1066     const char *cls;
1067     Lisp_Object tem;
1068   } r[] = {
1069     { "width",  "Width", Qwidth },
1070     { "height", "Height", Qheight },
1071     { "left", "Left", Qleft },
1072     { "top", "Top", Qtop },
1073   };
1075   int i;
1076   for (i = 0; i < sizeof (r)/sizeof (r[0]); ++i)
1077     {
1078       if (NILP (Fassq (r[i].tem, parms)))
1079         {
1080           Lisp_Object value
1081             = x_get_arg (dpyinfo, parms, r[i].tem, r[i].val, r[i].cls,
1082                          RES_TYPE_NUMBER);
1083           if (! EQ (value, Qunbound))
1084             parms = Fcons (Fcons (r[i].tem, value), parms);
1085         }
1086     }
1088   return parms;
1091 /* ==========================================================================
1093     Lisp definitions
1095    ========================================================================== */
1097 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
1098        1, 1, 0,
1099        doc: /* Make a new Nextstep window, called a "frame" in Emacs terms.
1100 Return an Emacs frame object.
1101 PARMS is an alist of frame parameters.
1102 If the parameters specify that the frame should not have a minibuffer,
1103 and do not specify a specific minibuffer window to use,
1104 then `default-minibuffer-frame' must be a frame whose minibuffer can
1105 be shared by the new frame.
1107 This function is an internal primitive--use `make-frame' instead.  */)
1108      (Lisp_Object parms)
1110   struct frame *f;
1111   Lisp_Object frame, tem;
1112   Lisp_Object name;
1113   int minibuffer_only = 0;
1114   int window_prompting = 0;
1115   int width, height;
1116   ptrdiff_t count = specpdl_ptr - specpdl;
1117   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1118   Lisp_Object display;
1119   struct ns_display_info *dpyinfo = NULL;
1120   Lisp_Object parent;
1121   struct kboard *kb;
1122   Lisp_Object tfont, tfontsize;
1123   static int desc_ctr = 1;
1125   check_ns ();
1127   /* x_get_arg modifies parms.  */
1128   parms = Fcopy_alist (parms);
1130   /* Use this general default value to start with
1131      until we know if this frame has a specified name.  */
1132   Vx_resource_name = Vinvocation_name;
1134   display = x_get_arg (dpyinfo, parms, Qterminal, 0, 0, RES_TYPE_STRING);
1135   if (EQ (display, Qunbound))
1136     display = Qnil;
1137   dpyinfo = check_ns_display_info (display);
1138   kb = dpyinfo->terminal->kboard;
1140   if (!dpyinfo->terminal->name)
1141     error ("Terminal is not live, can't create new frames on it");
1143   name = x_get_arg (dpyinfo, parms, Qname, 0, 0, RES_TYPE_STRING);
1144   if (!STRINGP (name)
1145       && ! EQ (name, Qunbound)
1146       && ! NILP (name))
1147     error ("Invalid frame name--not a string or nil");
1149   if (STRINGP (name))
1150     Vx_resource_name = name;
1152   parent = x_get_arg (dpyinfo, parms, Qparent_id, 0, 0, RES_TYPE_NUMBER);
1153   if (EQ (parent, Qunbound))
1154     parent = Qnil;
1155   if (! NILP (parent))
1156     CHECK_NUMBER (parent);
1158   /* make_frame_without_minibuffer can run Lisp code and garbage collect.  */
1159   /* No need to protect DISPLAY because that's not used after passing
1160      it to make_frame_without_minibuffer.  */
1161   frame = Qnil;
1162   GCPRO4 (parms, parent, name, frame);
1163   tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
1164                   RES_TYPE_SYMBOL);
1165   if (EQ (tem, Qnone) || NILP (tem))
1166       f = make_frame_without_minibuffer (Qnil, kb, display);
1167   else if (EQ (tem, Qonly))
1168     {
1169       f = make_minibuffer_frame ();
1170       minibuffer_only = 1;
1171     }
1172   else if (WINDOWP (tem))
1173       f = make_frame_without_minibuffer (tem, kb, display);
1174   else
1175       f = make_frame (1);
1177   XSETFRAME (frame, f);
1179   f->terminal = dpyinfo->terminal;
1181   f->output_method = output_ns;
1182   f->output_data.ns = xzalloc (sizeof *f->output_data.ns);
1184   FRAME_FONTSET (f) = -1;
1186   fset_icon_name (f, x_get_arg (dpyinfo, parms, Qicon_name,
1187                                 "iconName", "Title",
1188                                 RES_TYPE_STRING));
1189   if (! STRINGP (f->icon_name))
1190     fset_icon_name (f, Qnil);
1192   FRAME_NS_DISPLAY_INFO (f) = dpyinfo;
1194   /* With FRAME_NS_DISPLAY_INFO set up, this unwind-protect is safe.  */
1195   record_unwind_protect (unwind_create_frame, frame);
1197   f->output_data.ns->window_desc = desc_ctr++;
1198   if (TYPE_RANGED_INTEGERP (Window, parent))
1199     {
1200       f->output_data.ns->parent_desc = XFASTINT (parent);
1201       f->output_data.ns->explicit_parent = 1;
1202     }
1203   else
1204     {
1205       f->output_data.ns->parent_desc = FRAME_NS_DISPLAY_INFO (f)->root_window;
1206       f->output_data.ns->explicit_parent = 0;
1207     }
1209   /* Set the name; the functions to which we pass f expect the name to
1210      be set.  */
1211   if (EQ (name, Qunbound) || NILP (name) || ! STRINGP (name))
1212     {
1213       fset_name (f, build_string ([ns_app_name UTF8String]));
1214       f->explicit_name = 0;
1215     }
1216   else
1217     {
1218       fset_name (f, name);
1219       f->explicit_name = 1;
1220       specbind (Qx_resource_name, name);
1221     }
1223   f->resx = dpyinfo->resx;
1224   f->resy = dpyinfo->resy;
1226   block_input ();
1227   register_font_driver (&nsfont_driver, f);
1228   x_default_parameter (f, parms, Qfont_backend, Qnil,
1229                         "fontBackend", "FontBackend", RES_TYPE_STRING);
1231   {
1232     /* use for default font name */
1233     id font = [NSFont userFixedPitchFontOfSize: -1.0]; /* default */
1234     tfontsize = x_default_parameter (f, parms, Qfontsize,
1235                                     make_number (0 /*(int)[font pointSize]*/),
1236                                     "fontSize", "FontSize", RES_TYPE_NUMBER);
1237     tfont = x_default_parameter (f, parms, Qfont,
1238                                  build_string ([[font fontName] UTF8String]),
1239                                  "font", "Font", RES_TYPE_STRING);
1240   }
1241   unblock_input ();
1243   x_default_parameter (f, parms, Qborder_width, make_number (0),
1244                        "borderwidth", "BorderWidth", RES_TYPE_NUMBER);
1245   x_default_parameter (f, parms, Qinternal_border_width, make_number (2),
1246                       "internalBorderWidth", "InternalBorderWidth",
1247                       RES_TYPE_NUMBER);
1249   /* default scrollbars on right on Mac */
1250   {
1251       Lisp_Object spos
1252 #ifdef NS_IMPL_GNUSTEP
1253           = Qt;
1254 #else
1255           = Qright;
1256 #endif
1257       x_default_parameter (f, parms, Qvertical_scroll_bars, spos,
1258                            "verticalScrollBars", "VerticalScrollBars",
1259                            RES_TYPE_SYMBOL);
1260   }
1261   x_default_parameter (f, parms, Qforeground_color, build_string ("Black"),
1262                       "foreground", "Foreground", RES_TYPE_STRING);
1263   x_default_parameter (f, parms, Qbackground_color, build_string ("White"),
1264                       "background", "Background", RES_TYPE_STRING);
1265   /* FIXME: not supported yet in Nextstep */
1266   x_default_parameter (f, parms, Qline_spacing, Qnil,
1267                        "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
1268   x_default_parameter (f, parms, Qleft_fringe, Qnil,
1269                        "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
1270   x_default_parameter (f, parms, Qright_fringe, Qnil,
1271                        "rightFringe", "RightFringe", RES_TYPE_NUMBER);
1273 #ifdef GLYPH_DEBUG
1274   image_cache_refcount =
1275     FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
1276 #endif
1278   init_frame_faces (f);
1280   /* The resources controlling the menu-bar and tool-bar are
1281      processed specially at startup, and reflected in the mode
1282      variables; ignore them here.  */
1283   x_default_parameter (f, parms, Qmenu_bar_lines,
1284                        NILP (Vmenu_bar_mode)
1285                        ? make_number (0) : make_number (1),
1286                        NULL, NULL, RES_TYPE_NUMBER);
1287   x_default_parameter (f, parms, Qtool_bar_lines,
1288                        NILP (Vtool_bar_mode)
1289                        ? make_number (0) : make_number (1),
1290                        NULL, NULL, RES_TYPE_NUMBER);
1292   x_default_parameter (f, parms, Qbuffer_predicate, Qnil, "bufferPredicate",
1293                        "BufferPredicate", RES_TYPE_SYMBOL);
1294   x_default_parameter (f, parms, Qtitle, Qnil, "title", "Title",
1295                        RES_TYPE_STRING);
1297   parms = get_geometry_from_preferences (dpyinfo, parms);
1298   window_prompting = x_figure_window_size (f, parms, 1);
1300   tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
1301   f->no_split = minibuffer_only || (!EQ (tem, Qunbound) && !EQ (tem, Qnil));
1303   /* NOTE: on other terms, this is done in set_mouse_color, however this
1304      was not getting called under Nextstep */
1305   f->output_data.ns->text_cursor = [NSCursor IBeamCursor];
1306   f->output_data.ns->nontext_cursor = [NSCursor arrowCursor];
1307   f->output_data.ns->modeline_cursor = [NSCursor pointingHandCursor];
1308   f->output_data.ns->hand_cursor = [NSCursor pointingHandCursor];
1309   f->output_data.ns->hourglass_cursor = [NSCursor disappearingItemCursor];
1310   f->output_data.ns->horizontal_drag_cursor = [NSCursor resizeLeftRightCursor];
1311   FRAME_NS_DISPLAY_INFO (f)->vertical_scroll_bar_cursor
1312      = [NSCursor arrowCursor];
1313   f->output_data.ns->current_pointer = f->output_data.ns->text_cursor;
1315   [[EmacsView alloc] initFrameFromEmacs: f];
1317   x_icon (f, parms);
1319   /* ns_display_info does not have a reference_count.  */
1320   f->terminal->reference_count++;
1322   /* It is now ok to make the frame official even if we get an error below.
1323      The frame needs to be on Vframe_list or making it visible won't work. */
1324   Vframe_list = Fcons (frame, Vframe_list);
1326   x_default_parameter (f, parms, Qicon_type, Qnil,
1327                        "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
1329   x_default_parameter (f, parms, Qauto_raise, Qnil,
1330                        "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
1331   x_default_parameter (f, parms, Qauto_lower, Qnil,
1332                        "autoLower", "AutoLower", RES_TYPE_BOOLEAN);
1333   x_default_parameter (f, parms, Qcursor_type, Qbox,
1334                        "cursorType", "CursorType", RES_TYPE_SYMBOL);
1335   x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
1336                        "scrollBarWidth", "ScrollBarWidth",
1337                        RES_TYPE_NUMBER);
1338   x_default_parameter (f, parms, Qalpha, Qnil,
1339                        "alpha", "Alpha", RES_TYPE_NUMBER);
1340   x_default_parameter (f, parms, Qfullscreen, Qnil,
1341                        "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
1343   width = FRAME_COLS (f);
1344   height = FRAME_LINES (f);
1346   SET_FRAME_COLS (f, 0);
1347   FRAME_LINES (f) = 0;
1348   change_frame_size (f, height, width, 1, 0, 0);
1350   if (! f->output_data.ns->explicit_parent)
1351     {
1352       Lisp_Object visibility;
1354       visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
1355                               RES_TYPE_SYMBOL);
1356       if (EQ (visibility, Qunbound))
1357         visibility = Qt;
1359       if (EQ (visibility, Qicon))
1360         x_iconify_frame (f);
1361       else if (! NILP (visibility))
1362         {
1363           x_make_frame_visible (f);
1364           [[FRAME_NS_VIEW (f) window] makeKeyWindow];
1365         }
1366       else
1367         {
1368           /* Must have been Qnil.  */
1369         }
1370     }
1372   if (FRAME_HAS_MINIBUF_P (f)
1373       && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
1374           || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
1375     kset_default_minibuffer_frame (kb, frame);
1377   /* All remaining specified parameters, which have not been "used"
1378      by x_get_arg and friends, now go in the misc. alist of the frame.  */
1379   for (tem = parms; CONSP (tem); tem = XCDR (tem))
1380     if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
1381       fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
1383   UNGCPRO;
1385   if (window_prompting & USPosition)
1386     x_set_offset (f, f->left_pos, f->top_pos, 1);
1388   /* Make sure windows on this frame appear in calls to next-window
1389      and similar functions.  */
1390   Vwindow_list = Qnil;
1392   return unbind_to (count, frame);
1396 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
1397        doc: /* Set the input focus to FRAME.
1398 FRAME nil means use the selected frame.  */)
1399      (Lisp_Object frame)
1401   struct frame *f = check_ns_frame (frame);
1402   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1404   if (dpyinfo->x_focus_frame != f)
1405     {
1406       EmacsView *view = FRAME_NS_VIEW (f);
1407       block_input ();
1408       [NSApp activateIgnoringOtherApps: YES];
1409       [[view window] makeKeyAndOrderFront: view];
1410       unblock_input ();
1411     }
1413   return Qnil;
1417 DEFUN ("ns-popup-font-panel", Fns_popup_font_panel, Sns_popup_font_panel,
1418        0, 1, "",
1419        doc: /* Pop up the font panel. */)
1420      (Lisp_Object frame)
1422   id fm;
1423   struct frame *f;
1425   check_ns ();
1426   fm = [NSFontManager sharedFontManager];
1427   if (NILP (frame))
1428     f = SELECTED_FRAME ();
1429   else
1430     {
1431       CHECK_FRAME (frame);
1432       f = XFRAME (frame);
1433     }
1435   [fm setSelectedFont: ((struct nsfont_info *)f->output_data.ns->font)->nsfont
1436            isMultiple: NO];
1437   [fm orderFrontFontPanel: NSApp];
1438   return Qnil;
1442 DEFUN ("ns-popup-color-panel", Fns_popup_color_panel, Sns_popup_color_panel,
1443        0, 1, "",
1444        doc: /* Pop up the color panel.  */)
1445      (Lisp_Object frame)
1447   struct frame *f;
1449   check_ns ();
1450   if (NILP (frame))
1451     f = SELECTED_FRAME ();
1452   else
1453     {
1454       CHECK_FRAME (frame);
1455       f = XFRAME (frame);
1456     }
1458   [NSApp orderFrontColorPanel: NSApp];
1459   return Qnil;
1463 DEFUN ("ns-read-file-name", Fns_read_file_name, Sns_read_file_name, 1, 5, 0,
1464        doc: /* Use a graphical panel to read a file name, using prompt PROMPT.
1465 Optional arg DIR, if non-nil, supplies a default directory.
1466 Optional arg MUSTMATCH, if non-nil, means the returned file or
1467 directory must exist.
1468 Optional arg INIT, if non-nil, provides a default file name to use.
1469 Optional arg DIR_ONLY_P, if non-nil, means choose only directories.  */)
1470   (Lisp_Object prompt, Lisp_Object dir, Lisp_Object mustmatch,
1471    Lisp_Object init, Lisp_Object dir_only_p)
1473   static id fileDelegate = nil;
1474   int ret;
1475   id panel;
1476   Lisp_Object fname;
1478   NSString *promptS = NILP (prompt) || !STRINGP (prompt) ? nil :
1479     [NSString stringWithUTF8String: SSDATA (prompt)];
1480   NSString *dirS = NILP (dir) || !STRINGP (dir) ?
1481     [NSString stringWithUTF8String: SSDATA (BVAR (current_buffer, directory))] :
1482     [NSString stringWithUTF8String: SSDATA (dir)];
1483   NSString *initS = NILP (init) || !STRINGP (init) ? nil :
1484     [NSString stringWithUTF8String: SSDATA (init)];
1486   check_ns ();
1488   if (fileDelegate == nil)
1489     fileDelegate = [EmacsFileDelegate new];
1491   [NSCursor setHiddenUntilMouseMoves: NO];
1493   if ([dirS characterAtIndex: 0] == '~')
1494     dirS = [dirS stringByExpandingTildeInPath];
1496   panel = NILP (mustmatch) && NILP (dir_only_p) ?
1497     (id)[EmacsSavePanel savePanel] : (id)[EmacsOpenPanel openPanel];
1499   [panel setTitle: promptS];
1501   [panel setAllowsOtherFileTypes: YES];
1502   [panel setTreatsFilePackagesAsDirectories: YES];
1503   [panel setDelegate: fileDelegate];
1505   panelOK = 0;
1506   if (! NILP (dir_only_p)) 
1507     {
1508       [panel setCanChooseDirectories: YES];
1509       [panel setCanChooseFiles: NO];
1510     }
1511   
1512   block_input ();
1513 #if defined (NS_IMPL_COCOA) && \
1514   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
1515   if (! NILP (mustmatch) || ! NILP (dir_only_p))
1516     [panel setAllowedFileTypes: nil];
1517   if (dirS) [panel setDirectoryURL: [NSURL fileURLWithPath: dirS]];
1518   if (initS && NILP (Ffile_directory_p (init)))
1519     [panel setNameFieldStringValue: [initS lastPathComponent]];
1520   else
1521     [panel setNameFieldStringValue: @""];
1522     
1523   ret = [panel runModal];
1524 #else
1525   if (NILP (mustmatch) && NILP (dir_only_p))
1526     {
1527       ret = [panel runModalForDirectory: dirS file: initS];
1528     }
1529   else
1530     {
1531       [panel setCanChooseDirectories: YES];
1532       ret = [panel runModalForDirectory: dirS file: initS types: nil];
1533     }
1534 #endif
1536   ret = (ret == NSOKButton) || panelOK;
1538   if (ret)
1539     fname = build_string ([[panel filename] UTF8String]);
1541   [[FRAME_NS_VIEW (SELECTED_FRAME ()) window] makeKeyWindow];
1542   unblock_input ();
1544   return ret ? fname : Qnil;
1547 const char *
1548 ns_get_defaults_value (const char *key)
1550   NSObject *obj = [[NSUserDefaults standardUserDefaults]
1551                     objectForKey: [NSString stringWithUTF8String: key]];
1553   if (!obj) return NULL;
1555   return [[NSString stringWithFormat: @"%@", obj] UTF8String];
1559 DEFUN ("ns-get-resource", Fns_get_resource, Sns_get_resource, 2, 2, 0,
1560        doc: /* Return the value of the property NAME of OWNER from the defaults database.
1561 If OWNER is nil, Emacs is assumed.  */)
1562      (Lisp_Object owner, Lisp_Object name)
1564   const char *value;
1566   check_ns ();
1567   if (NILP (owner))
1568     owner = build_string([ns_app_name UTF8String]);
1569   CHECK_STRING (name);
1570 /*fprintf (stderr, "ns-get-resource checking resource '%s'\n", SSDATA (name)); */
1572   value = ns_get_defaults_value (SSDATA (name));
1574   if (value)
1575     return build_string (value);
1576   return Qnil;
1580 DEFUN ("ns-set-resource", Fns_set_resource, Sns_set_resource, 3, 3, 0,
1581        doc: /* Set property NAME of OWNER to VALUE, from the defaults database.
1582 If OWNER is nil, Emacs is assumed.
1583 If VALUE is nil, the default is removed.  */)
1584      (Lisp_Object owner, Lisp_Object name, Lisp_Object value)
1586   check_ns ();
1587   if (NILP (owner))
1588     owner = build_string ([ns_app_name UTF8String]);
1589   CHECK_STRING (name);
1590   if (NILP (value))
1591     {
1592       [[NSUserDefaults standardUserDefaults] removeObjectForKey:
1593                          [NSString stringWithUTF8String: SSDATA (name)]];
1594     }
1595   else
1596     {
1597       CHECK_STRING (value);
1598       [[NSUserDefaults standardUserDefaults] setObject:
1599                 [NSString stringWithUTF8String: SSDATA (value)]
1600                                         forKey: [NSString stringWithUTF8String:
1601                                                          SSDATA (name)]];
1602     }
1604   return Qnil;
1608 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
1609        Sx_server_max_request_size,
1610        0, 1, 0,
1611        doc: /* This function is a no-op.  It is only present for completeness.  */)
1612      (Lisp_Object display)
1614   check_ns ();
1615   /* This function has no real equivalent under NeXTstep.  Return nil to
1616      indicate this. */
1617   return Qnil;
1621 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
1622        doc: /* Return the vendor ID string of Nextstep display server DISPLAY.
1623 DISPLAY should be either a frame or a display name (a string).
1624 If omitted or nil, the selected frame's display is used.  */)
1625      (Lisp_Object display)
1627 #ifdef NS_IMPL_GNUSTEP
1628   return build_string ("GNU");
1629 #else
1630   return build_string ("Apple");
1631 #endif
1635 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
1636        doc: /* Return the version numbers of the server of DISPLAY.
1637 The value is a list of three integers: the major and minor
1638 version numbers of the X Protocol in use, and the distributor-specific
1639 release number.  See also the function `x-server-vendor'.
1641 The optional argument DISPLAY specifies which display to ask about.
1642 DISPLAY should be either a frame or a display name (a string).
1643 If omitted or nil, that stands for the selected frame's display.  */)
1644      (Lisp_Object display)
1646   /*NOTE: it is unclear what would best correspond with "protocol";
1647           we return 10.3, meaning Panther, since this is roughly the
1648           level that GNUstep's APIs correspond to.
1649           The last number is where we distinguish between the Apple
1650           and GNUstep implementations ("distributor-specific release
1651           number") and give int'ized versions of major.minor. */
1652   return Fcons (make_number (10),
1653                 Fcons (make_number (3),
1654                        Fcons (make_number (ns_appkit_version_int()), Qnil)));
1658 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
1659        doc: /* Return the number of screens on Nextstep display server DISPLAY.
1660 DISPLAY should be a frame, the display name as a string, or a terminal ID.
1661 If omitted or nil, the selected frame's display is used.  */)
1662      (Lisp_Object display)
1664   int num;
1666   check_ns ();
1667   num = [[NSScreen screens] count];
1669   return (num != 0) ? make_number (num) : Qnil;
1673 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height,
1674        0, 1, 0,
1675        doc: /* Return the height of Nextstep display server DISPLAY, in millimeters.
1676 DISPLAY should be a frame, the display name as a string, or a terminal ID.
1677 If omitted or nil, the selected frame's display is used.  */)
1678      (Lisp_Object display)
1680   check_ns ();
1681   return make_number ((int)
1682                      ([ns_get_screen (display) frame].size.height/(92.0/25.4)));
1686 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width,
1687        0, 1, 0,
1688        doc: /* Return the width of Nextstep display server DISPLAY, in millimeters.
1689 DISPLAY should be a frame, the display name as a string, or a terminal ID.
1690 If omitted or nil, the selected frame's display is used.  */)
1691      (Lisp_Object display)
1693   check_ns ();
1694   return make_number ((int)
1695                      ([ns_get_screen (display) frame].size.width/(92.0/25.4)));
1699 DEFUN ("x-display-backing-store", Fx_display_backing_store,
1700        Sx_display_backing_store, 0, 1, 0,
1701        doc: /* Return whether the Nextstep display DISPLAY supports backing store.
1702 The value may be `buffered', `retained', or `non-retained'.
1703 DISPLAY should be a frame, the display name as a string, or a terminal ID.
1704 If omitted or nil, the selected frame's display is used.  */)
1705      (Lisp_Object display)
1707   check_ns ();
1708   switch ([ns_get_window (display) backingType])
1709     {
1710     case NSBackingStoreBuffered:
1711       return intern ("buffered");
1712     case NSBackingStoreRetained:
1713       return intern ("retained");
1714     case NSBackingStoreNonretained:
1715       return intern ("non-retained");
1716     default:
1717       error ("Strange value for backingType parameter of frame");
1718     }
1719   return Qnil;  /* not reached, shut compiler up */
1723 DEFUN ("x-display-visual-class", Fx_display_visual_class,
1724        Sx_display_visual_class, 0, 1, 0,
1725        doc: /* Return the visual class of the Nextstep display server DISPLAY.
1726 The value is one of the symbols `static-gray', `gray-scale',
1727 `static-color', `pseudo-color', `true-color', or `direct-color'.
1728 DISPLAY should be a frame, the display name as a string, or a terminal ID.
1729 If omitted or nil, the selected frame's display is used.  */)
1730      (Lisp_Object display)
1732   NSWindowDepth depth;
1733   check_ns ();
1734   depth = [ns_get_screen (display) depth];
1736   if ( depth == NSBestDepth (NSCalibratedWhiteColorSpace, 2, 2, YES, NULL))
1737     return intern ("static-gray");
1738   else if (depth == NSBestDepth (NSCalibratedWhiteColorSpace, 8, 8, YES, NULL))
1739     return intern ("gray-scale");
1740   else if ( depth == NSBestDepth (NSCalibratedRGBColorSpace, 8, 8, YES, NULL))
1741     return intern ("pseudo-color");
1742   else if ( depth == NSBestDepth (NSCalibratedRGBColorSpace, 4, 12, NO, NULL))
1743     return intern ("true-color");
1744   else if ( depth == NSBestDepth (NSCalibratedRGBColorSpace, 8, 24, NO, NULL))
1745     return intern ("direct-color");
1746   else
1747     /* color mgmt as far as we do it is really handled by Nextstep itself anyway */
1748     return intern ("direct-color");
1752 DEFUN ("x-display-save-under", Fx_display_save_under,
1753        Sx_display_save_under, 0, 1, 0,
1754        doc: /* Return t if DISPLAY supports the save-under feature.
1755 The optional argument DISPLAY specifies which display to ask about.
1756 DISPLAY should be a frame, the display name as a string, or a terminal ID.
1757 If omitted or nil, the selected frame's display is used.  */)
1758      (Lisp_Object display)
1760   check_ns ();
1761   switch ([ns_get_window (display) backingType])
1762     {
1763     case NSBackingStoreBuffered:
1764       return Qt;
1766     case NSBackingStoreRetained:
1767     case NSBackingStoreNonretained:
1768       return Qnil;
1770     default:
1771       error ("Strange value for backingType parameter of frame");
1772     }
1773   return Qnil;  /* not reached, shut compiler up */
1777 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1778        1, 3, 0,
1779        doc: /* Open a connection to a display server.
1780 DISPLAY is the name of the display to connect to.
1781 Optional second arg XRM-STRING is a string of resources in xrdb format.
1782 If the optional third arg MUST-SUCCEED is non-nil,
1783 terminate Emacs if we can't open the connection.
1784 \(In the Nextstep version, the last two arguments are currently ignored.)  */)
1785      (Lisp_Object display, Lisp_Object resource_string, Lisp_Object must_succeed)
1787   struct ns_display_info *dpyinfo;
1789   CHECK_STRING (display);
1791   nxatoms_of_nsselect ();
1792   dpyinfo = ns_term_init (display);
1793   if (dpyinfo == 0)
1794     {
1795       if (!NILP (must_succeed))
1796         fatal ("OpenStep on %s not responding.\n",
1797                SSDATA (display));
1798       else
1799         error ("OpenStep on %s not responding.\n",
1800                SSDATA (display));
1801     }
1803   return Qnil;
1807 DEFUN ("x-close-connection", Fx_close_connection, Sx_close_connection,
1808        1, 1, 0,
1809        doc: /* Close the connection to the current Nextstep display server.
1810 The argument DISPLAY is currently ignored.  */)
1811      (Lisp_Object display)
1813   check_ns ();
1814   /*ns_delete_terminal (dpyinfo->terminal); */
1815   [NSApp terminate: NSApp];
1816   return Qnil;
1820 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
1821        doc: /* Return the list of display names that Emacs has connections to.  */)
1822      (void)
1824   Lisp_Object tail, result;
1826   result = Qnil;
1827   for (tail = ns_display_name_list; CONSP (tail); tail = XCDR (tail))
1828     result = Fcons (XCAR (XCAR (tail)), result);
1830   return result;
1834 DEFUN ("ns-hide-others", Fns_hide_others, Sns_hide_others,
1835        0, 0, 0,
1836        doc: /* Hides all applications other than Emacs.  */)
1837      (void)
1839   check_ns ();
1840   [NSApp hideOtherApplications: NSApp];
1841   return Qnil;
1844 DEFUN ("ns-hide-emacs", Fns_hide_emacs, Sns_hide_emacs,
1845        1, 1, 0,
1846        doc: /* If ON is non-nil, the entire Emacs application is hidden.
1847 Otherwise if Emacs is hidden, it is unhidden.
1848 If ON is equal to `activate', Emacs is unhidden and becomes
1849 the active application.  */)
1850      (Lisp_Object on)
1852   check_ns ();
1853   if (EQ (on, intern ("activate")))
1854     {
1855       [NSApp unhide: NSApp];
1856       [NSApp activateIgnoringOtherApps: YES];
1857     }
1858   else if (NILP (on))
1859     [NSApp unhide: NSApp];
1860   else
1861     [NSApp hide: NSApp];
1862   return Qnil;
1866 DEFUN ("ns-emacs-info-panel", Fns_emacs_info_panel, Sns_emacs_info_panel,
1867        0, 0, 0,
1868        doc: /* Shows the 'Info' or 'About' panel for Emacs.  */)
1869      (void)
1871   check_ns ();
1872   [NSApp orderFrontStandardAboutPanel: nil];
1873   return Qnil;
1877 DEFUN ("ns-font-name", Fns_font_name, Sns_font_name, 1, 1, 0,
1878        doc: /* Determine font PostScript or family name for font NAME.
1879 NAME should be a string containing either the font name or an XLFD
1880 font descriptor.  If string contains `fontset' and not
1881 `fontset-startup', it is left alone. */)
1882      (Lisp_Object name)
1884   char *nm;
1885   CHECK_STRING (name);
1886   nm = SSDATA (name);
1888   if (nm[0] != '-')
1889     return name;
1890   if (strstr (nm, "fontset") && !strstr (nm, "fontset-startup"))
1891     return name;
1893   return build_string (ns_xlfd_to_fontname (SSDATA (name)));
1897 DEFUN ("ns-list-colors", Fns_list_colors, Sns_list_colors, 0, 1, 0,
1898        doc: /* Return a list of all available colors.
1899 The optional argument FRAME is currently ignored.  */)
1900      (Lisp_Object frame)
1902   Lisp_Object list = Qnil;
1903   NSEnumerator *colorlists;
1904   NSColorList *clist;
1906   if (!NILP (frame))
1907     {
1908       CHECK_FRAME (frame);
1909       if (! FRAME_NS_P (XFRAME (frame)))
1910         error ("non-Nextstep frame used in `ns-list-colors'");
1911     }
1913   block_input ();
1915   colorlists = [[NSColorList availableColorLists] objectEnumerator];
1916   while ((clist = [colorlists nextObject]))
1917     {
1918       if ([[clist name] length] < 7 ||
1919           [[clist name] rangeOfString: @"PANTONE"].location == 0)
1920         {
1921           NSEnumerator *cnames = [[clist allKeys] reverseObjectEnumerator];
1922           NSString *cname;
1923           while ((cname = [cnames nextObject]))
1924             list = Fcons (build_string ([cname UTF8String]), list);
1925 /*           for (i = [[clist allKeys] count] - 1; i >= 0; i--)
1926                list = Fcons (build_string ([[[clist allKeys] objectAtIndex: i]
1927                                              UTF8String]), list); */
1928         }
1929     }
1931   unblock_input ();
1933   return list;
1937 DEFUN ("ns-list-services", Fns_list_services, Sns_list_services, 0, 0, 0,
1938        doc: /* List available Nextstep services by querying NSApp.  */)
1939      (void)
1941 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
1942   /* You can't get services like this in 10.6+.  */
1943   return Qnil;
1944 #else
1945   Lisp_Object ret = Qnil;
1946   NSMenu *svcs;
1947   id delegate;
1949   check_ns ();
1950   svcs = [[NSMenu alloc] initWithTitle: @"Services"];
1951   [NSApp setServicesMenu: svcs];
1952   [NSApp registerServicesMenuSendTypes: ns_send_types
1953                            returnTypes: ns_return_types];
1955 /* On Tiger, services menu updating was made lazier (waits for user to
1956    actually click on the menu), so we have to force things along: */
1957 #ifdef NS_IMPL_COCOA
1958   delegate = [svcs delegate];
1959   if (delegate != nil)
1960     {
1961       if ([delegate respondsToSelector: @selector (menuNeedsUpdate:)])
1962         [delegate menuNeedsUpdate: svcs];
1963       if ([delegate respondsToSelector:
1964                        @selector (menu:updateItem:atIndex:shouldCancel:)])
1965         {
1966           int i, len = [delegate numberOfItemsInMenu: svcs];
1967           for (i =0; i<len; i++)
1968             [svcs addItemWithTitle: @"" action: NULL keyEquivalent: @""];
1969           for (i =0; i<len; i++)
1970             if (![delegate menu: svcs
1971                      updateItem: (NSMenuItem *)[svcs itemAtIndex: i]
1972                         atIndex: i shouldCancel: NO])
1973               break;
1974         }
1975     }
1976 #endif
1978   [svcs setAutoenablesItems: NO];
1979 #ifdef NS_IMPL_COCOA
1980   [svcs update]; /* on OS X, converts from '/' structure */
1981 #endif
1983   ret = interpret_services_menu (svcs, Qnil, ret);
1984   return ret;
1985 #endif
1989 DEFUN ("ns-perform-service", Fns_perform_service, Sns_perform_service,
1990        2, 2, 0,
1991        doc: /* Perform Nextstep SERVICE on SEND.
1992 SEND should be either a string or nil.
1993 The return value is the result of the service, as string, or nil if
1994 there was no result.  */)
1995      (Lisp_Object service, Lisp_Object send)
1997   id pb;
1998   NSString *svcName;
1999   char *utfStr;
2001   CHECK_STRING (service);
2002   check_ns ();
2004   utfStr = SSDATA (service);
2005   svcName = [NSString stringWithUTF8String: utfStr];
2007   pb =[NSPasteboard pasteboardWithUniqueName];
2008   ns_string_to_pasteboard (pb, send);
2010   if (NSPerformService (svcName, pb) == NO)
2011     Fsignal (Qquit, Fcons (build_string ("service not available"), Qnil));
2013   if ([[pb types] count] == 0)
2014     return build_string ("");
2015   return ns_string_from_pasteboard (pb);
2019 DEFUN ("ns-convert-utf8-nfd-to-nfc", Fns_convert_utf8_nfd_to_nfc,
2020        Sns_convert_utf8_nfd_to_nfc, 1, 1, 0,
2021        doc: /* Return an NFC string that matches the UTF-8 NFD string STR.  */)
2022      (Lisp_Object str)
2024 /* TODO: If GNUstep ever implements precomposedStringWithCanonicalMapping,
2025          remove this. */
2026   NSString *utfStr;
2028   CHECK_STRING (str);
2029   utfStr = [NSString stringWithUTF8String: SSDATA (str)];
2030   if (![utfStr respondsToSelector:
2031                  @selector (precomposedStringWithCanonicalMapping)])
2032     {
2033       message1
2034         ("Warning: ns-convert-utf8-nfd-to-nfc unsupported under GNUstep.\n");
2035       return Qnil;
2036     }
2037   else
2038     utfStr = [utfStr precomposedStringWithCanonicalMapping];
2039   return build_string ([utfStr UTF8String]);
2043 #ifdef NS_IMPL_COCOA
2045 /* Compile and execute the AppleScript SCRIPT and return the error
2046    status as function value.  A zero is returned if compilation and
2047    execution is successful, in which case *RESULT is set to a Lisp
2048    string or a number containing the resulting script value.  Otherwise,
2049    1 is returned. */
2050 static int
2051 ns_do_applescript (Lisp_Object script, Lisp_Object *result)
2053   NSAppleEventDescriptor *desc;
2054   NSDictionary* errorDict;
2055   NSAppleEventDescriptor* returnDescriptor = NULL;
2057   NSAppleScript* scriptObject =
2058     [[NSAppleScript alloc] initWithSource:
2059                              [NSString stringWithUTF8String: SSDATA (script)]];
2061   returnDescriptor = [scriptObject executeAndReturnError: &errorDict];
2062   [scriptObject release];
2064   *result = Qnil;
2066   if (returnDescriptor != NULL)
2067     {
2068       // successful execution
2069       if (kAENullEvent != [returnDescriptor descriptorType])
2070         {
2071           *result = Qt;
2072           // script returned an AppleScript result
2073           if ((typeUnicodeText == [returnDescriptor descriptorType]) ||
2074 #if defined (NS_IMPL_COCOA)
2075               (typeUTF16ExternalRepresentation
2076                == [returnDescriptor descriptorType]) ||
2077 #endif
2078               (typeUTF8Text == [returnDescriptor descriptorType]) ||
2079               (typeCString == [returnDescriptor descriptorType]))
2080             {
2081               desc = [returnDescriptor coerceToDescriptorType: typeUTF8Text];
2082               if (desc)
2083                 *result = build_string([[desc stringValue] UTF8String]);
2084             }
2085           else
2086             {
2087               /* use typeUTF16ExternalRepresentation? */
2088               // coerce the result to the appropriate ObjC type
2089               desc = [returnDescriptor coerceToDescriptorType: typeUTF8Text];
2090               if (desc)
2091                 *result = make_number([desc int32Value]);
2092             }
2093         }
2094     }
2095   else
2096     {
2097       // no script result, return error
2098       return 1;
2099     }
2100   return 0;
2103 /* Helper function called from sendEvent to run applescript
2104    from within the main event loop.  */
2106 void
2107 ns_run_ascript (void)
2109   if (! NILP (as_script))
2110     as_status = ns_do_applescript (as_script, as_result);
2111   as_script = Qnil;
2114 DEFUN ("ns-do-applescript", Fns_do_applescript, Sns_do_applescript, 1, 1, 0,
2115        doc: /* Execute AppleScript SCRIPT and return the result.
2116 If compilation and execution are successful, the resulting script value
2117 is returned as a string, a number or, in the case of other constructs, t.
2118 In case the execution fails, an error is signaled. */)
2119      (Lisp_Object script)
2121   Lisp_Object result;
2122   int status;
2123   NSEvent *nxev;
2125   CHECK_STRING (script);
2126   check_ns ();
2128   block_input ();
2130   as_script = script;
2131   as_result = &result;
2133   /* executing apple script requires the event loop to run, otherwise
2134      errors aren't returned and executeAndReturnError hangs forever.
2135      Post an event that runs applescript and then start the event loop.
2136      The event loop is exited when the script is done.  */
2137   nxev = [NSEvent otherEventWithType: NSApplicationDefined
2138                             location: NSMakePoint (0, 0)
2139                        modifierFlags: 0
2140                            timestamp: 0
2141                         windowNumber: [[NSApp mainWindow] windowNumber]
2142                              context: [NSApp context]
2143                              subtype: 0
2144                                data1: 0
2145                                data2: NSAPP_DATA2_RUNASSCRIPT];
2147   [NSApp postEvent: nxev atStart: NO];
2149   // If there are other events, the event loop may exit.  Keep running
2150   // until the script has been handeled.  */
2151   while (! NILP (as_script))
2152     [NSApp run];
2154   status = as_status;
2155   as_status = 0;
2156   as_result = 0;
2157   unblock_input ();
2158   if (status == 0)
2159     return result;
2160   else if (!STRINGP (result))
2161     error ("AppleScript error %d", status);
2162   else
2163     error ("%s", SSDATA (result));
2165 #endif
2169 /* ==========================================================================
2171     Miscellaneous functions not called through hooks
2173    ========================================================================== */
2176 /* called from image.c */
2177 FRAME_PTR
2178 check_x_frame (Lisp_Object frame)
2180   return check_ns_frame (frame);
2184 /* called from frame.c */
2185 struct ns_display_info *
2186 check_x_display_info (Lisp_Object frame)
2188   return check_ns_display_info (frame);
2192 void
2193 x_set_scroll_bar_default_width (struct frame *f)
2195   int wid = FRAME_COLUMN_WIDTH (f);
2196   FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = NS_SCROLL_BAR_WIDTH_DEFAULT;
2197   FRAME_CONFIG_SCROLL_BAR_COLS (f) = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) +
2198                                       wid - 1) / wid;
2202 /* terms impl this instead of x-get-resource directly */
2203 const char *
2204 x_get_string_resource (XrmDatabase rdb, char *name, char *class)
2206   /* remove appname prefix; TODO: allow for !="Emacs" */
2207   char *toCheck = class + (!strncmp (class, "Emacs.", 6) ? 6 : 0);
2208   const char *res;
2209   check_ns ();
2211   if (inhibit_x_resources)
2212     /* --quick was passed, so this is a no-op.  */
2213     return NULL;
2215   res = ns_get_defaults_value (toCheck);
2216   return !res ? NULL :
2217       (!c_strncasecmp (res, "YES", 3) ? "true" :
2218           (!c_strncasecmp (res, "NO", 2) ? "false" : res));
2222 Lisp_Object
2223 x_get_focus_frame (struct frame *frame)
2225   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
2226   Lisp_Object nsfocus;
2228   if (!dpyinfo->x_focus_frame)
2229     return Qnil;
2231   XSETFRAME (nsfocus, dpyinfo->x_focus_frame);
2232   return nsfocus;
2237 x_pixel_width (struct frame *f)
2239   return FRAME_PIXEL_WIDTH (f);
2244 x_pixel_height (struct frame *f)
2246   return FRAME_PIXEL_HEIGHT (f);
2251 x_screen_planes (struct frame *f)
2253   return FRAME_NS_DISPLAY_INFO (f)->n_planes;
2257 void
2258 x_sync (struct frame *f)
2260   /* XXX Not implemented XXX */
2261   return;
2266 /* ==========================================================================
2268     Lisp definitions that, for whatever reason, we can't alias as 'ns-XXX'.
2270    ========================================================================== */
2273 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
2274        doc: /* Internal function called by `color-defined-p', which see.
2275 \(Note that the Nextstep version of this function ignores FRAME.)  */)
2276      (Lisp_Object color, Lisp_Object frame)
2278   NSColor * col;
2279   check_ns ();
2280   return ns_lisp_to_color (color, &col) ? Qnil : Qt;
2284 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
2285        doc: /* Internal function called by `color-values', which see.  */)
2286      (Lisp_Object color, Lisp_Object frame)
2288   NSColor * col;
2289   CGFloat red, green, blue, alpha;
2291   check_ns ();
2292   CHECK_STRING (color);
2294   if (ns_lisp_to_color (color, &col))
2295     return Qnil;
2297   [[col colorUsingColorSpaceName: NSCalibratedRGBColorSpace]
2298         getRed: &red green: &green blue: &blue alpha: &alpha];
2299   return list3 (make_number (lrint (red*65280)),
2300                 make_number (lrint (green*65280)),
2301                 make_number (lrint (blue*65280)));
2305 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
2306        doc: /* Internal function called by `display-color-p', which see.  */)
2307      (Lisp_Object display)
2309   NSWindowDepth depth;
2310   NSString *colorSpace;
2311   check_ns ();
2312   depth = [ns_get_screen (display) depth];
2313   colorSpace = NSColorSpaceFromDepth (depth);
2315   return    [colorSpace isEqualToString: NSDeviceWhiteColorSpace]
2316          || [colorSpace isEqualToString: NSCalibratedWhiteColorSpace]
2317       ? Qnil : Qt;
2321 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
2322        Sx_display_grayscale_p, 0, 1, 0,
2323        doc: /* Return t if the Nextstep display supports shades of gray.
2324 Note that color displays do support shades of gray.
2325 The optional argument DISPLAY specifies which display to ask about.
2326 DISPLAY should be either a frame, a display name (a string), or terminal ID.
2327 If omitted or nil, that stands for the selected frame's display. */)
2328      (Lisp_Object display)
2330   NSWindowDepth depth;
2331   check_ns ();
2332   depth = [ns_get_screen (display) depth];
2334   return NSBitsPerPixelFromDepth (depth) > 1 ? Qt : Qnil;
2338 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
2339        0, 1, 0,
2340        doc: /* Return the width in pixels of the Nextstep display DISPLAY.
2341 The optional argument DISPLAY specifies which display to ask about.
2342 DISPLAY should be either a frame, a display name (a string), or terminal ID.
2343 If omitted or nil, that stands for the selected frame's display.  */)
2344      (Lisp_Object display)
2346   check_ns ();
2347   return make_number ((int) [ns_get_screen (display) frame].size.width);
2351 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
2352        Sx_display_pixel_height, 0, 1, 0,
2353        doc: /* Return the height in pixels of the Nextstep display DISPLAY.
2354 The optional argument DISPLAY specifies which display to ask about.
2355 DISPLAY should be either a frame, a display name (a string), or terminal ID.
2356 If omitted or nil, that stands for the selected frame's display.  */)
2357      (Lisp_Object display)
2359   check_ns ();
2360   return make_number ((int) [ns_get_screen (display) frame].size.height);
2364 DEFUN ("display-usable-bounds", Fns_display_usable_bounds,
2365        Sns_display_usable_bounds, 0, 1, 0,
2366        doc: /* Return the bounds of the usable part of the screen.
2367 The return value is a list of integers (LEFT TOP WIDTH HEIGHT), which
2368 are the boundaries of the usable part of the screen, excluding areas
2369 reserved for the Mac menu, dock, and so forth.
2371 The screen queried corresponds to DISPLAY, which should be either a
2372 frame, a display name (a string), or terminal ID.  If omitted or nil,
2373 that stands for the selected frame's display. */)
2374      (Lisp_Object display)
2376   NSScreen *screen;
2377   NSRect vScreen;
2379   check_ns ();
2380   screen = ns_get_screen (display);
2381   if (!screen)
2382     return Qnil;
2384   vScreen = [screen visibleFrame];
2386   /* NS coordinate system is upside-down.
2387      Transform to screen-specific coordinates. */
2388   return list4 (make_number ((int) vScreen.origin.x),
2389                 make_number ((int) [screen frame].size.height
2390                              - vScreen.size.height - vScreen.origin.y),
2391                 make_number ((int) vScreen.size.width),
2392                 make_number ((int) vScreen.size.height));
2396 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
2397        0, 1, 0,
2398        doc: /* Return the number of bitplanes of the Nextstep display DISPLAY.
2399 The optional argument DISPLAY specifies which display to ask about.
2400 DISPLAY should be either a frame, a display name (a string), or terminal ID.
2401 If omitted or nil, that stands for the selected frame's display.  */)
2402      (Lisp_Object display)
2404   check_ns ();
2405   return make_number
2406     (NSBitsPerPixelFromDepth ([ns_get_screen (display) depth]));
2410 DEFUN ("x-display-color-cells", Fx_display_color_cells,
2411        Sx_display_color_cells, 0, 1, 0,
2412        doc: /* Returns the number of color cells of the Nextstep display DISPLAY.
2413 The optional argument DISPLAY specifies which display to ask about.
2414 DISPLAY should be either a frame, a display name (a string), or terminal ID.
2415 If omitted or nil, that stands for the selected frame's display.  */)
2416      (Lisp_Object display)
2418   struct ns_display_info *dpyinfo;
2419   check_ns ();
2421   dpyinfo = check_ns_display_info (display);
2422   /* We force 24+ bit depths to 24-bit to prevent an overflow.  */
2423   return make_number (1 << min (dpyinfo->n_planes, 24));
2427 /* Unused dummy def needed for compatibility. */
2428 Lisp_Object tip_frame;
2430 /* TODO: move to xdisp or similar */
2431 static void
2432 compute_tip_xy (struct frame *f,
2433                 Lisp_Object parms,
2434                 Lisp_Object dx,
2435                 Lisp_Object dy,
2436                 int width,
2437                 int height,
2438                 int *root_x,
2439                 int *root_y)
2441   Lisp_Object left, top;
2442   EmacsView *view = FRAME_NS_VIEW (f);
2443   NSPoint pt;
2445   /* Start with user-specified or mouse position.  */
2446   left = Fcdr (Fassq (Qleft, parms));
2447   top = Fcdr (Fassq (Qtop, parms));
2449   if (!INTEGERP (left) || !INTEGERP (top))
2450     {
2451       pt = last_mouse_motion_position;
2452       /* Convert to screen coordinates */
2453       pt = [view convertPoint: pt toView: nil];
2454       pt = [[view window] convertBaseToScreen: pt];
2455     }
2456   else
2457     {
2458       /* Absolute coordinates.  */
2459       pt.x = XINT (left);
2460       pt.y = x_display_pixel_height (FRAME_NS_DISPLAY_INFO (f)) - XINT (top)
2461         - height;
2462     }
2464   /* Ensure in bounds.  (Note, screen origin = lower left.) */
2465   if (INTEGERP (left))
2466     *root_x = pt.x;
2467   else if (pt.x + XINT (dx) <= 0)
2468     *root_x = 0; /* Can happen for negative dx */
2469   else if (pt.x + XINT (dx) + width
2470            <= x_display_pixel_width (FRAME_NS_DISPLAY_INFO (f)))
2471     /* It fits to the right of the pointer.  */
2472     *root_x = pt.x + XINT (dx);
2473   else if (width + XINT (dx) <= pt.x)
2474     /* It fits to the left of the pointer.  */
2475     *root_x = pt.x - width - XINT (dx);
2476   else
2477     /* Put it left justified on the screen -- it ought to fit that way.  */
2478     *root_x = 0;
2480   if (INTEGERP (top))
2481     *root_y = pt.y;
2482   else if (pt.y - XINT (dy) - height >= 0)
2483     /* It fits below the pointer.  */
2484     *root_y = pt.y - height - XINT (dy);
2485   else if (pt.y + XINT (dy) + height
2486            <= x_display_pixel_height (FRAME_NS_DISPLAY_INFO (f)))
2487     /* It fits above the pointer */
2488       *root_y = pt.y + XINT (dy);
2489   else
2490     /* Put it on the top.  */
2491     *root_y = x_display_pixel_height (FRAME_NS_DISPLAY_INFO (f)) - height;
2495 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
2496        doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
2497 A tooltip window is a small window displaying a string.
2499 This is an internal function; Lisp code should call `tooltip-show'.
2501 FRAME nil or omitted means use the selected frame.
2503 PARMS is an optional list of frame parameters which can be used to
2504 change the tooltip's appearance.
2506 Automatically hide the tooltip after TIMEOUT seconds.  TIMEOUT nil
2507 means use the default timeout of 5 seconds.
2509 If the list of frame parameters PARMS contains a `left' parameter,
2510 the tooltip is displayed at that x-position.  Otherwise it is
2511 displayed at the mouse position, with offset DX added (default is 5 if
2512 DX isn't specified).  Likewise for the y-position; if a `top' frame
2513 parameter is specified, it determines the y-position of the tooltip
2514 window, otherwise it is displayed at the mouse position, with offset
2515 DY added (default is -10).
2517 A tooltip's maximum size is specified by `x-max-tooltip-size'.
2518 Text larger than the specified size is clipped.  */)
2519      (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
2521   int root_x, root_y;
2522   struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2523   ptrdiff_t count = SPECPDL_INDEX ();
2524   struct frame *f;
2525   char *str;
2526   NSSize size;
2528   specbind (Qinhibit_redisplay, Qt);
2530   GCPRO4 (string, parms, frame, timeout);
2532   CHECK_STRING (string);
2533   str = SSDATA (string);
2534   f = check_x_frame (frame);
2535   if (NILP (timeout))
2536     timeout = make_number (5);
2537   else
2538     CHECK_NATNUM (timeout);
2540   if (NILP (dx))
2541     dx = make_number (5);
2542   else
2543     CHECK_NUMBER (dx);
2545   if (NILP (dy))
2546     dy = make_number (-10);
2547   else
2548     CHECK_NUMBER (dy);
2550   block_input ();
2551   if (ns_tooltip == nil)
2552     ns_tooltip = [[EmacsTooltip alloc] init];
2553   else
2554     Fx_hide_tip ();
2556   [ns_tooltip setText: str];
2557   size = [ns_tooltip frame].size;
2559   /* Move the tooltip window where the mouse pointer is.  Resize and
2560      show it.  */
2561   compute_tip_xy (f, parms, dx, dy, (int)size.width, (int)size.height,
2562                   &root_x, &root_y);
2564   [ns_tooltip showAtX: root_x Y: root_y for: XINT (timeout)];
2565   unblock_input ();
2567   UNGCPRO;
2568   return unbind_to (count, Qnil);
2572 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
2573        doc: /* Hide the current tooltip window, if there is any.
2574 Value is t if tooltip was open, nil otherwise.  */)
2575      (void)
2577   if (ns_tooltip == nil || ![ns_tooltip isActive])
2578     return Qnil;
2579   [ns_tooltip hide];
2580   return Qt;
2584 /* ==========================================================================
2586     Class implementations
2588    ========================================================================== */
2591 @implementation EmacsSavePanel
2592 #ifdef NS_IMPL_COCOA
2593 /* --------------------------------------------------------------------------
2594    These are overridden to intercept on OS X: ending panel restarts NSApp
2595    event loop if it is stopped.  Not sure if this is correct behavior,
2596    perhaps should check if running and if so send an appdefined.
2597    -------------------------------------------------------------------------- */
2598 - (void) ok: (id)sender
2600   [super ok: sender];
2601   panelOK = 1;
2602   [NSApp stop: self];
2604 - (void) cancel: (id)sender
2606   [super cancel: sender];
2607   [NSApp stop: self];
2609 #endif
2610 @end
2613 @implementation EmacsOpenPanel
2614 #ifdef NS_IMPL_COCOA
2615 /* --------------------------------------------------------------------------
2616    These are overridden to intercept on OS X: ending panel restarts NSApp
2617    event loop if it is stopped.  Not sure if this is correct behavior,
2618    perhaps should check if running and if so send an appdefined.
2619    -------------------------------------------------------------------------- */
2620 - (void) ok: (id)sender
2622   [super ok: sender];
2623   panelOK = 1;
2624   [NSApp stop: self];
2626 - (void) cancel: (id)sender
2628   [super cancel: sender];
2629   [NSApp stop: self];
2631 #endif
2632 @end
2635 @implementation EmacsFileDelegate
2636 /* --------------------------------------------------------------------------
2637    Delegate methods for Open/Save panels
2638    -------------------------------------------------------------------------- */
2639 - (BOOL)panel: (id)sender isValidFilename: (NSString *)filename
2641   return YES;
2643 - (BOOL)panel: (id)sender shouldShowFilename: (NSString *)filename
2645   return YES;
2647 - (NSString *)panel: (id)sender userEnteredFilename: (NSString *)filename
2648           confirmed: (BOOL)okFlag
2650   return filename;
2652 @end
2654 #endif
2657 /* ==========================================================================
2659     Lisp interface declaration
2661    ========================================================================== */
2664 void
2665 syms_of_nsfns (void)
2667   Qfontsize = intern_c_string ("fontsize");
2668   staticpro (&Qfontsize);
2670   DEFVAR_LISP ("ns-icon-type-alist", Vns_icon_type_alist,
2671                doc: /* Alist of elements (REGEXP . IMAGE) for images of icons associated to frames.
2672 If the title of a frame matches REGEXP, then IMAGE.tiff is
2673 selected as the image of the icon representing the frame when it's
2674 miniaturized.  If an element is t, then Emacs tries to select an icon
2675 based on the filetype of the visited file.
2677 The images have to be installed in a folder called English.lproj in the
2678 Emacs folder.  You have to restart Emacs after installing new icons.
2680 Example: Install an icon Gnus.tiff and execute the following code
2682   (setq ns-icon-type-alist
2683         (append ns-icon-type-alist
2684                 '((\"^\\\\*\\\\(Group\\\\*$\\\\|Summary \\\\|Article\\\\*$\\\\)\"
2685                    . \"Gnus\"))))
2687 When you miniaturize a Group, Summary or Article frame, Gnus.tiff will
2688 be used as the image of the icon representing the frame.  */);
2689   Vns_icon_type_alist = Fcons (Qt, Qnil);
2691   DEFVAR_LISP ("ns-version-string", Vns_version_string,
2692                doc: /* Toolkit version for NS Windowing.  */);
2693   Vns_version_string = ns_appkit_version_str ();
2695   defsubr (&Sns_read_file_name);
2696   defsubr (&Sns_get_resource);
2697   defsubr (&Sns_set_resource);
2698   defsubr (&Sxw_display_color_p); /* this and next called directly by C code */
2699   defsubr (&Sx_display_grayscale_p);
2700   defsubr (&Sns_font_name);
2701   defsubr (&Sns_list_colors);
2702 #ifdef NS_IMPL_COCOA
2703   defsubr (&Sns_do_applescript);
2704 #endif
2705   defsubr (&Sxw_color_defined_p);
2706   defsubr (&Sxw_color_values);
2707   defsubr (&Sx_server_max_request_size);
2708   defsubr (&Sx_server_vendor);
2709   defsubr (&Sx_server_version);
2710   defsubr (&Sx_display_pixel_width);
2711   defsubr (&Sx_display_pixel_height);
2712   defsubr (&Sns_display_usable_bounds);
2713   defsubr (&Sx_display_mm_width);
2714   defsubr (&Sx_display_mm_height);
2715   defsubr (&Sx_display_screens);
2716   defsubr (&Sx_display_planes);
2717   defsubr (&Sx_display_color_cells);
2718   defsubr (&Sx_display_visual_class);
2719   defsubr (&Sx_display_backing_store);
2720   defsubr (&Sx_display_save_under);
2721   defsubr (&Sx_create_frame);
2722   defsubr (&Sx_open_connection);
2723   defsubr (&Sx_close_connection);
2724   defsubr (&Sx_display_list);
2726   defsubr (&Sns_hide_others);
2727   defsubr (&Sns_hide_emacs);
2728   defsubr (&Sns_emacs_info_panel);
2729   defsubr (&Sns_list_services);
2730   defsubr (&Sns_perform_service);
2731   defsubr (&Sns_convert_utf8_nfd_to_nfc);
2732   defsubr (&Sx_focus_frame);
2733   defsubr (&Sns_popup_font_panel);
2734   defsubr (&Sns_popup_color_panel);
2736   defsubr (&Sx_show_tip);
2737   defsubr (&Sx_hide_tip);
2739   /* used only in fontset.c */
2740   check_window_system_func = check_ns;
2742   as_status = 0;
2743   as_script = Qnil;
2744   as_result = 0;