* lispref/modes.texi (Region to Refontify): Rename from "Region to Fontify".
[emacs.git] / src / nsterm.m
blob30b73c2fd13f2fc43a657bb08dca0f5d8a1fe043
1 /* NeXT/Open/GNUstep / MacOSX communication module.
2    Copyright (C) 1989, 1993, 1994, 2005, 2006, 2008, 2009, 2010, 2011
3      Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
21 Originally by Carl Edman
22 Updated by Christian Limpach (chris@nice.ch)
23 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
24 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
25 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
28 /* This should be the first include, as it may set up #defines affecting
29    interpretation of even the system includes. */
30 #include "config.h"
32 #include <math.h>
33 #include <sys/types.h>
34 #include <time.h>
35 #include <signal.h>
36 #include <unistd.h>
37 #include <setjmp.h>
39 #include "lisp.h"
40 #include "blockinput.h"
41 #include "sysselect.h"
42 #include "nsterm.h"
43 #include "systime.h"
44 #include "character.h"
45 #include "fontset.h"
46 #include "composite.h"
47 #include "ccl.h"
49 #include "termhooks.h"
50 #include "termopts.h"
51 #include "termchar.h"
53 #include "window.h"
54 #include "keyboard.h"
56 #include "font.h"
58 /* call tracing */
59 #if 0
60 int term_trace_num = 0;
61 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
62                                 __FILE__, __LINE__, ++term_trace_num)
63 #else
64 #define NSTRACE(x)
65 #endif
68 /* ==========================================================================
70     Local declarations
72    ========================================================================== */
74 /* Convert a symbol indexed with an NSxxx value to a value as defined
75    in keyboard.c (lispy_function_key). I hope this is a correct way
76    of doing things... */
77 static unsigned convert_ns_to_X_keysym[] =
79   NSHomeFunctionKey,            0x50,
80   NSLeftArrowFunctionKey,       0x51,
81   NSUpArrowFunctionKey,         0x52,
82   NSRightArrowFunctionKey,      0x53,
83   NSDownArrowFunctionKey,       0x54,
84   NSPageUpFunctionKey,          0x55,
85   NSPageDownFunctionKey,        0x56,
86   NSEndFunctionKey,             0x57,
87   NSBeginFunctionKey,           0x58,
88   NSSelectFunctionKey,          0x60,
89   NSPrintFunctionKey,           0x61,
90   NSExecuteFunctionKey,         0x62,
91   NSInsertFunctionKey,          0x63,
92   NSUndoFunctionKey,            0x65,
93   NSRedoFunctionKey,            0x66,
94   NSMenuFunctionKey,            0x67,
95   NSFindFunctionKey,            0x68,
96   NSHelpFunctionKey,            0x6A,
97   NSBreakFunctionKey,           0x6B,
99   NSF1FunctionKey,              0xBE,
100   NSF2FunctionKey,              0xBF,
101   NSF3FunctionKey,              0xC0,
102   NSF4FunctionKey,              0xC1,
103   NSF5FunctionKey,              0xC2,
104   NSF6FunctionKey,              0xC3,
105   NSF7FunctionKey,              0xC4,
106   NSF8FunctionKey,              0xC5,
107   NSF9FunctionKey,              0xC6,
108   NSF10FunctionKey,             0xC7,
109   NSF11FunctionKey,             0xC8,
110   NSF12FunctionKey,             0xC9,
111   NSF13FunctionKey,             0xCA,
112   NSF14FunctionKey,             0xCB,
113   NSF15FunctionKey,             0xCC,
114   NSF16FunctionKey,             0xCD,
115   NSF17FunctionKey,             0xCE,
116   NSF18FunctionKey,             0xCF,
117   NSF19FunctionKey,             0xD0,
118   NSF20FunctionKey,             0xD1,
119   NSF21FunctionKey,             0xD2,
120   NSF22FunctionKey,             0xD3,
121   NSF23FunctionKey,             0xD4,
122   NSF24FunctionKey,             0xD5,
124   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
125   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
126   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
128   NSTabCharacter,               0x09,
129   0x19,                         0x09,  /* left tab->regular since pass shift */
130   NSCarriageReturnCharacter,    0x0D,
131   NSNewlineCharacter,           0x0D,
132   NSEnterCharacter,             0x8D,
134   0x1B,                         0x1B   /* escape */
138 /* Lisp communications */
139 Lisp_Object ns_input_file, ns_input_font, ns_input_fontsize, ns_input_line;
140 Lisp_Object ns_input_color, ns_input_text, ns_working_text;
141 Lisp_Object ns_input_spi_name, ns_input_spi_arg;
142 Lisp_Object Vx_toolkit_scroll_bars;
143 static Lisp_Object Qmodifier_value;
144 Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper, Qnone;
145 extern Lisp_Object Qcursor_color, Qcursor_type, Qns, Qleft;
147 /* Specifies which emacs modifier should be generated when NS receives
148    the Alternate modifier.  May be Qnone or any of the modifier lisp symbols. */
149 Lisp_Object ns_alternate_modifier;
151 /* Specifies which emacs modifier should be generated when NS receives
152    the right Alternate modifier.  Has same values as ns_alternate_modifier plus
153    the value Qleft which means whatever value ns_alternate_modifier has.  */
154 Lisp_Object ns_right_alternate_modifier;
156 /* Specifies which emacs modifier should be generated when NS receives
157    the Command modifier.  May be any of the modifier lisp symbols. */
158 Lisp_Object ns_command_modifier;
160 /* Specifies which emacs modifier should be generated when NS receives
161    the Control modifier.  May be any of the modifier lisp symbols. */
162 Lisp_Object ns_control_modifier;
164 /* Specifies which emacs modifier should be generated when NS receives
165    the Function modifier (laptops).  May be any of the modifier lisp symbols. */
166 Lisp_Object ns_function_modifier;
168 /* Control via default 'GSFontAntiAlias' on OS X and GNUstep. */
169 Lisp_Object ns_antialias_text;
171 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
172    the maximum font size to NOT antialias.  On GNUstep there is currently
173    no way to control this behavior. */
174 float ns_antialias_threshold;
176 /* Used to pick up AppleHighlightColor on OS X */
177 NSString *ns_selection_color;
179 /* Confirm on exit. */
180 Lisp_Object ns_confirm_quit;
182 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
183 NSString *ns_app_name = @"Emacs";  /* default changed later */
185 /* Display variables */
186 struct ns_display_info *x_display_list; /* Chain of existing displays */
187 Lisp_Object ns_display_name_list;
188 long context_menu_value = 0;
190 /* display update */
191 NSPoint last_mouse_motion_position;
192 static NSRect last_mouse_glyph;
193 static unsigned long last_mouse_movement_time = 0;
194 static Lisp_Object last_mouse_motion_frame;
195 static EmacsScroller *last_mouse_scroll_bar = nil;
196 static struct frame *ns_updating_frame;
197 static NSView *focus_view = NULL;
198 static int ns_window_num =0;
199 static NSRect uRect;
200 static BOOL gsaved = NO;
201 BOOL ns_in_resize = NO;
202 static BOOL ns_fake_keydown = NO;
203 int ns_tmp_flags; /* FIXME */
204 struct nsfont_info *ns_tmp_font; /* FIXME */
205 /*static int debug_lock = 0; */
207 /* event loop */
208 static BOOL send_appdefined = YES;
209 static NSEvent *last_appdefined_event = 0;
210 static NSTimer *timed_entry = 0;
211 static NSTimer *fd_entry = nil;
212 static NSTimer *scroll_repeat_entry = nil;
213 static fd_set select_readfds, t_readfds;
214 static struct timeval select_timeout;
215 static int select_nfds;
216 static NSAutoreleasePool *outerpool;
217 static struct input_event *emacs_event = NULL;
218 static struct input_event *q_event_ptr = NULL;
219 static int n_emacs_events_pending = 0;
220 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
221   *ns_pending_service_args;
222 static BOOL inNsSelect = 0;
224 /* Convert modifiers in a NeXTSTEP event to emacs style modifiers.  */
225 #define NS_FUNCTION_KEY_MASK 0x800000
226 #define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
227 #define EV_MODIFIERS(e)                               \
228     ((([e modifierFlags] & NSHelpKeyMask) ?           \
229            hyper_modifier : 0)                        \
230      | (!EQ (ns_right_alternate_modifier, Qleft) && \
231         (([e modifierFlags] & NSRightAlternateKeyMask) \
232          == NSRightAlternateKeyMask) ? \
233            parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
234      | (([e modifierFlags] & NSAlternateKeyMask) ?                 \
235            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
236      | (([e modifierFlags] & NSShiftKeyMask) ?     \
237            shift_modifier : 0)                        \
238      | (([e modifierFlags] & NSControlKeyMask) ?      \
239            parse_solitary_modifier (ns_control_modifier) : 0)     \
240      | (([e modifierFlags] & NS_FUNCTION_KEY_MASK) ?  \
241            parse_solitary_modifier (ns_function_modifier) : 0)    \
242      | (([e modifierFlags] & NSCommandKeyMask) ?      \
243            parse_solitary_modifier (ns_command_modifier):0))
245 #define EV_UDMODIFIERS(e)                                      \
246     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
247      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
248      | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
249      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
250      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
251      | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
252      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
253      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
254      | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
256 #define EV_BUTTON(e)                                                         \
257     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
258       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
259      [e buttonNumber] - 1)
261 /* Convert the time field to a timestamp in milliseconds. */
262 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
264 /* This is a piece of code which is common to all the event handling
265    methods.  Maybe it should even be a function.  */
266 #define EV_TRAILER(e)                                         \
267   {                                                           \
268   XSETFRAME (emacs_event->frame_or_window, emacsframe);       \
269   if (e) emacs_event->timestamp = EV_TIMESTAMP (e);           \
270   n_emacs_events_pending++;                                   \
271   kbd_buffer_store_event_hold (emacs_event, q_event_ptr);     \
272   EVENT_INIT (*emacs_event);                                  \
273   ns_send_appdefined (-1);                                    \
274   }
276 void x_set_cursor_type (struct frame *, Lisp_Object, Lisp_Object);
278 /* TODO: get rid of need for these forward declarations */
279 static void ns_condemn_scroll_bars (struct frame *f);
280 static void ns_judge_scroll_bars (struct frame *f);
281 void x_set_frame_alpha (struct frame *f);
283 /* unused variables needed for compatibility reasons */
284 int x_use_underline_position_properties, x_underline_at_descent_line;
285 /* FIXME: figure out what to do with underline_minimum_offset. */
288 /* ==========================================================================
290     Utilities
292    ========================================================================== */
295 static Lisp_Object
296 append2 (Lisp_Object list, Lisp_Object item)
297 /* --------------------------------------------------------------------------
298    Utility to append to a list
299    -------------------------------------------------------------------------- */
301   Lisp_Object array[2];
302   array[0] = list;
303   array[1] = Fcons (item, Qnil);
304   return Fnconc (2, &array[0]);
308 void
309 ns_init_paths ()
310 /* --------------------------------------------------------------------------
311    Used to allow emacs to find its resources under Emacs.app
312    Called from emacs.c at startup.
313    -------------------------------------------------------------------------- */
315   NSBundle *bundle = [NSBundle mainBundle];
316   NSString *binDir = [bundle bundlePath], *resourceDir = [bundle resourcePath];
317   NSString *resourcePath, *resourcePaths;
318   NSRange range;
319   BOOL onWindows = NO; /* how do I determine this? */
320   NSString *pathSeparator = onWindows ? @";" : @":";
321   NSFileManager *fileManager = [NSFileManager defaultManager];
322   BOOL isDir;
323 /*NSLog (@"ns_init_paths: '%@'\n%@\n", [[NSBundle mainBundle] bundlePath], [[NSBundle mainBundle] resourcePath]); */
325   /* get bindir from base */
326   range = [resourceDir rangeOfString: @"Contents"];
327   if (range.location != NSNotFound)
328     {
329       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
330 #ifdef NS_IMPL_COCOA
331       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
332 #endif
333     }
335   /* the following based on Andrew Choi's init_mac_osx_environment () */
336   if (!getenv ("EMACSLOADPATH"))
337     {
338       NSArray *paths = [resourceDir stringsByAppendingPaths:
339                                   [NSArray arrayWithObjects:
340                                          @"site-lisp", @"lisp", @"leim", nil]];
341       NSEnumerator *pathEnum = [paths objectEnumerator];
342       resourcePaths = @"";
343       while (resourcePath = [pathEnum nextObject])
344         {
345           if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
346             if (isDir)
347               {
348                 if ([resourcePaths length] > 0)
349                   resourcePaths
350                     = [resourcePaths stringByAppendingString: pathSeparator];
351                 resourcePaths
352                   = [resourcePaths stringByAppendingString: resourcePath];
353               }
354         }
355       if ([resourcePaths length] > 0)
356         setenv ("EMACSLOADPATH", [resourcePaths UTF8String], 1);
357 /*NSLog (@"loadPath: '%@'\n", resourcePaths); */
358     }
360   if (!getenv ("EMACSPATH"))
361     {
362       NSArray *paths = [binDir stringsByAppendingPaths:
363                                   [NSArray arrayWithObjects: @"bin",
364                                                              @"lib-exec", nil]];
365       NSEnumerator *pathEnum = [paths objectEnumerator];
366       resourcePaths = @"";
367       while (resourcePath = [pathEnum nextObject])
368         {
369           if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
370             if (isDir)
371               {
372                 if ([resourcePaths length] > 0)
373                   resourcePaths
374                     = [resourcePaths stringByAppendingString: pathSeparator];
375                 resourcePaths
376                   = [resourcePaths stringByAppendingString: resourcePath];
377               }
378         }
379       if ([resourcePaths length] > 0)
380         setenv ("EMACSPATH", [resourcePaths UTF8String], 1);
381     }
383   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
384   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
385     {
386       if (isDir)
387         {
388           if (!getenv ("EMACSDATA"))
389             setenv ("EMACSDATA", [resourcePath UTF8String], 1);
390           if (!getenv ("EMACSDOC"))
391             setenv ("EMACSDOC", [resourcePath UTF8String], 1);
392         }
393     }
395   if (!getenv ("INFOPATH"))
396     {
397       resourcePath = [resourceDir stringByAppendingPathComponent: @"info"];
398       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
399         if (isDir)
400           setenv ("INFOPATH", [[resourcePath stringByAppendingString: @":"]
401                                              UTF8String], 1);
402       /* Note, extra colon needed to cause merge w/later user additions. */
403     }
407 static int
408 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
409 /* --------------------------------------------------------------------------
410    Subtract the `struct timeval' values X and Y, storing the result in RESULT.
411    Return 1 if the difference is negative, otherwise 0.
412    -------------------------------------------------------------------------- */
414   /* Perform the carry for the later subtraction by updating y.
415      This is safer because on some systems
416      the tv_sec member is unsigned.  */
417   if (x.tv_usec < y.tv_usec)
418     {
419       int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
420       y.tv_usec -= 1000000 * nsec;
421       y.tv_sec += nsec;
422     }
423   if (x.tv_usec - y.tv_usec > 1000000)
424     {
425       int nsec = (y.tv_usec - x.tv_usec) / 1000000;
426       y.tv_usec += 1000000 * nsec;
427       y.tv_sec -= nsec;
428     }
430   /* Compute the time remaining to wait.  tv_usec is certainly positive.  */
431   result->tv_sec = x.tv_sec - y.tv_sec;
432   result->tv_usec = x.tv_usec - y.tv_usec;
434   /* Return indication of whether the result should be considered negative.  */
435   return x.tv_sec < y.tv_sec;
438 static void
439 ns_timeout (int usecs)
440 /* --------------------------------------------------------------------------
441      Blocking timer utility used by ns_ring_bell
442    -------------------------------------------------------------------------- */
444   struct timeval wakeup;
446   EMACS_GET_TIME (wakeup);
448   /* Compute time to wait until, propagating carry from usecs.  */
449   wakeup.tv_usec += usecs;
450   wakeup.tv_sec += (wakeup.tv_usec / 1000000);
451   wakeup.tv_usec %= 1000000;
453   /* Keep waiting until past the time wakeup.  */
454   while (1)
455     {
456       struct timeval timeout;
458       EMACS_GET_TIME (timeout);
460       /* In effect, timeout = wakeup - timeout.
461          Break if result would be negative.  */
462       if (timeval_subtract (&timeout, wakeup, timeout))
463         break;
465       /* Try to wait that long--but we might wake up sooner.  */
466       select (0, NULL, NULL, NULL, &timeout);
467     }
471 void
472 ns_release_object (void *obj)
473 /* --------------------------------------------------------------------------
474     Release an object (callable from C)
475    -------------------------------------------------------------------------- */
477     [(id)obj release];
481 void
482 ns_retain_object (void *obj)
483 /* --------------------------------------------------------------------------
484     Retain an object (callable from C)
485    -------------------------------------------------------------------------- */
487     [(id)obj retain];
491 void *
492 ns_alloc_autorelease_pool ()
493 /* --------------------------------------------------------------------------
494      Allocate a pool for temporary objects (callable from C)
495    -------------------------------------------------------------------------- */
497   return [[NSAutoreleasePool alloc] init];
501 void
502 ns_release_autorelease_pool (void *pool)
503 /* --------------------------------------------------------------------------
504      Free a pool and temporary objects it refers to (callable from C)
505    -------------------------------------------------------------------------- */
507   ns_release_object (pool);
512 /* ==========================================================================
514     Focus (clipping) and screen update
516    ========================================================================== */
518 static NSRect
519 ns_resize_handle_rect (NSWindow *window)
521   NSRect r = [window frame];
522   r.origin.x = r.size.width - RESIZE_HANDLE_SIZE;
523   r.origin.y = 0;
524   r.size.width = r.size.height = RESIZE_HANDLE_SIZE;
525   return r;
529 static void
530 ns_update_begin (struct frame *f)
531 /* --------------------------------------------------------------------------
532    Prepare for a grouped sequence of drawing calls
533    external (RIF) call; whole frame, called before update_window_begin
534    -------------------------------------------------------------------------- */
536   NSView *view = FRAME_NS_VIEW (f);
537   NSTRACE (ns_update_begin);
539   ns_updating_frame = f;
540   [view lockFocus];
542 #ifdef NS_IMPL_GNUSTEP
543   uRect = NSMakeRect (0, 0, 0, 0);
544 #endif
548 static void
549 ns_update_window_begin (struct window *w)
550 /* --------------------------------------------------------------------------
551    Prepare for a grouped sequence of drawing calls
552    external (RIF) call; for one window, called after update_begin
553    -------------------------------------------------------------------------- */
555   struct frame *f = XFRAME (WINDOW_FRAME (w));
556   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
557   NSTRACE (ns_update_window_begin);
559   updated_window = w;
560   set_output_cursor (&w->cursor);
562   BLOCK_INPUT;
564   if (f == dpyinfo->mouse_face_mouse_frame)
565     {
566       /* Don't do highlighting for mouse motion during the update.  */
567       dpyinfo->mouse_face_defer = 1;
569         /* If the frame needs to be redrawn,
570            simply forget about any prior mouse highlighting.  */
571       if (FRAME_GARBAGED_P (f))
572         dpyinfo->mouse_face_window = Qnil;
574       /* (further code for mouse faces ifdef'd out in other terms elided) */
575     }
577   UNBLOCK_INPUT;
581 static void
582 ns_update_window_end (struct window *w, int cursor_on_p,
583                       int mouse_face_overwritten_p)
584 /* --------------------------------------------------------------------------
585    Finished a grouped sequence of drawing calls
586    external (RIF) call; for one window called before update_end
587    -------------------------------------------------------------------------- */
589   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (XFRAME (w->frame));
591   /* note: this fn is nearly identical in all terms */
592   if (!w->pseudo_window_p)
593     {
594       BLOCK_INPUT;
596       if (cursor_on_p)
597         display_and_set_cursor (w, 1,
598                                 output_cursor.hpos, output_cursor.vpos,
599                                 output_cursor.x, output_cursor.y);
601       if (draw_window_fringes (w, 1))
602         x_draw_vertical_border (w);
604       UNBLOCK_INPUT;
605     }
607   /* If a row with mouse-face was overwritten, arrange for
608      frame_up_to_date to redisplay the mouse highlight.  */
609   if (mouse_face_overwritten_p)
610     {
611       dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
612       dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
613       dpyinfo->mouse_face_window = Qnil;
614     }
616   updated_window = NULL;
617   NSTRACE (update_window_end);
621 static void
622 ns_update_end (struct frame *f)
623 /* --------------------------------------------------------------------------
624    Finished a grouped sequence of drawing calls
625    external (RIF) call; for whole frame, called after update_window_end
626    -------------------------------------------------------------------------- */
628   NSView *view = FRAME_NS_VIEW (f);
630 /*   if (f == FRAME_NS_DISPLAY_INFO (f)->mouse_face_mouse_frame) */
631     FRAME_NS_DISPLAY_INFO (f)->mouse_face_defer = 0;
633   BLOCK_INPUT;
635 #ifdef NS_IMPL_GNUSTEP
636   /* trigger flush only in the rectangle we tracked as being drawn */
637   [view unlockFocusNeedsFlush: NO];
638 /*fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", uRect.origin.x, uRect.origin.y, uRect.size.width, uRect.size.height); */
639   [view lockFocusInRect: uRect];
640 #endif
642   [view unlockFocus];
643   [[view window] flushWindow];
645   UNBLOCK_INPUT;
646   ns_updating_frame = NULL;
647   NSTRACE (ns_update_end);
651 static void
652 ns_flush (struct frame *f)
653 /* --------------------------------------------------------------------------
654    external (RIF) call
655    NS impl is no-op since currently we flush in ns_update_end and elsewhere
656    -------------------------------------------------------------------------- */
658     NSTRACE (ns_flush);
662 static void
663 ns_focus (struct frame *f, NSRect *r, int n)
664 /* --------------------------------------------------------------------------
665    Internal: Focus on given frame.  During small local updates this is used to
666      draw, however during large updates, ns_update_begin and ns_update_end are
667      called to wrap the whole thing, in which case these calls are stubbed out.
668      Except, on GNUstep, we accumulate the rectangle being drawn into, because
669      the back end won't do this automatically, and will just end up flushing
670      the entire window.
671    -------------------------------------------------------------------------- */
673 //  NSTRACE (ns_focus);
674 #ifdef NS_IMPL_GNUSTEP
675   NSRect u;
676     if (n == 2)
677       u = NSUnionRect (r[0], r[1]);
678     else if (r)
679       u = *r;
680 #endif
681 /* static int c =0;
682    fprintf (stderr, "focus: %d", c++);
683    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
684    fprintf (stderr, "\n"); */
686   if (f != ns_updating_frame)
687     {
688       NSView *view = FRAME_NS_VIEW (f);
689       if (view != focus_view)
690         {
691           if (focus_view != NULL)
692             {
693               [focus_view unlockFocus];
694               [[focus_view window] flushWindow];
695 /*debug_lock--; */
696             }
698           if (view)
699 #ifdef NS_IMPL_GNUSTEP
700             r ? [view lockFocusInRect: u] : [view lockFocus];
701 #else
702             [view lockFocus];
703 #endif
704           focus_view = view;
705 /*if (view) debug_lock++; */
706         }
707 #ifdef NS_IMPL_GNUSTEP
708       else
709         {
710           /* more than one rect being drawn into */
711           if (view && r)
712             {
713               [view unlockFocus]; /* add prev rect to redraw list */
714               [view lockFocusInRect: u]; /* focus for draw in new rect */
715             }
716         }
717 #endif
718     }
719 #ifdef NS_IMPL_GNUSTEP
720   else
721     {
722       /* in batch mode, but in GNUstep must still track rectangles explicitly */
723       uRect = (r ? NSUnionRect (uRect, u) : [FRAME_NS_VIEW (f) visibleRect]);
724     }
725 #endif
727   /* clipping */
728   if (r)
729     {
730       [[NSGraphicsContext currentContext] saveGraphicsState];
731       if (n == 2)
732         NSRectClipList (r, 2);
733       else
734         NSRectClip (*r);
735       gsaved = YES;
736     }
740 static void
741 ns_unfocus (struct frame *f)
742 /* --------------------------------------------------------------------------
743      Internal: Remove focus on given frame
744    -------------------------------------------------------------------------- */
746 //  NSTRACE (ns_unfocus);
748   if (gsaved)
749     {
750       [[NSGraphicsContext currentContext] restoreGraphicsState];
751       gsaved = NO;
752     }
754   if (f != ns_updating_frame)
755     {
756       if (focus_view != NULL)
757         {
758           [focus_view unlockFocus];
759           [[focus_view window] flushWindow];
760           focus_view = NULL;
761 /*debug_lock--; */
762         }
763     }
767 static void
768 ns_clip_to_row (struct window *w, struct glyph_row *row, int area, BOOL gc)
769 /* --------------------------------------------------------------------------
770      Internal (but parallels other terms): Focus drawing on given row
771    -------------------------------------------------------------------------- */
773   struct frame *f = XFRAME (WINDOW_FRAME (w));
774   NSRect clip_rect;
775   int window_x, window_y, window_width;
777   window_box (w, area, &window_x, &window_y, &window_width, 0);
779   clip_rect.origin.x = window_x - FRAME_INTERNAL_BORDER_WIDTH (f);
780   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
781   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
782   clip_rect.size.width = window_width + 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
783   clip_rect.size.height = row->visible_height;
785   /* allow a full-height row at the top when requested
786      (used to draw fringe all the way through internal border area) */
787   if (gc && clip_rect.origin.y < 5)
788     {
789       clip_rect.origin.y -= FRAME_INTERNAL_BORDER_WIDTH (f);
790       clip_rect.size.height += FRAME_INTERNAL_BORDER_WIDTH (f);
791     }
793   /* likewise at bottom */
794   if (gc &&
795       FRAME_PIXEL_HEIGHT (f) - (clip_rect.origin.y + clip_rect.size.height) < 5)
796     clip_rect.size.height += FRAME_INTERNAL_BORDER_WIDTH (f);
798   ns_focus (f, &clip_rect, 1);
802 static void
803 ns_ring_bell ()
804 /* --------------------------------------------------------------------------
805      "Beep" routine
806    -------------------------------------------------------------------------- */
808   NSTRACE (ns_ring_bell);
809   if (visible_bell)
810     {
811       NSAutoreleasePool *pool;
812       struct frame *frame = SELECTED_FRAME ();
813       NSView *view;
815       BLOCK_INPUT;
816       pool = [[NSAutoreleasePool alloc] init];
818       view = FRAME_NS_VIEW (frame);
819       if (view != nil)
820         {
821           NSRect r, surr;
822           NSPoint dim = NSMakePoint (128, 128);
824           r = [view bounds];
825           r.origin.x += (r.size.width - dim.x) / 2;
826           r.origin.y += (r.size.height - dim.y) / 2;
827           r.size.width = dim.x;
828           r.size.height = dim.y;
829           surr = NSInsetRect (r, -2, -2);
830           ns_focus (frame, &surr, 1);
831           [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
832           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
833                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
834           NSRectFill (r);
835           [[view window] flushWindow];
836           ns_timeout (150000);
837           [[view window] restoreCachedImage];
838           [[view window] flushWindow];
839           ns_unfocus (frame);
840         }
841       [pool release];
842       UNBLOCK_INPUT;
843     }
844   else
845     {
846       NSBeep ();
847     }
851 static void
852 ns_reset_terminal_modes (struct terminal *terminal)
853 /*  Externally called as hook */
855   NSTRACE (ns_reset_terminal_modes);
859 static void
860 ns_set_terminal_modes (struct terminal *terminal)
861 /*  Externally called as hook */
863   NSTRACE (ns_set_terminal_modes);
868 /* ==========================================================================
870     Frame / window manager related functions
872    ========================================================================== */
875 static void
876 ns_raise_frame (struct frame *f)
877 /* --------------------------------------------------------------------------
878      Bring window to foreground and make it active
879    -------------------------------------------------------------------------- */
881   NSView *view = FRAME_NS_VIEW (f);
882   check_ns ();
883   BLOCK_INPUT;
884   FRAME_SAMPLE_VISIBILITY (f);
885   if (FRAME_VISIBLE_P (f))
886     {
887       [[view window] makeKeyAndOrderFront: NSApp];
888     }
889   UNBLOCK_INPUT;
893 static void
894 ns_lower_frame (struct frame *f)
895 /* --------------------------------------------------------------------------
896      Send window to back
897    -------------------------------------------------------------------------- */
899   NSView *view = FRAME_NS_VIEW (f);
900   check_ns ();
901   BLOCK_INPUT;
902   [[view window] orderBack: NSApp];
903   UNBLOCK_INPUT;
907 static void
908 ns_frame_raise_lower (struct frame *f, int raise)
909 /* --------------------------------------------------------------------------
910      External (hook)
911    -------------------------------------------------------------------------- */
913   NSTRACE (ns_frame_raise_lower);
915   if (raise)
916     ns_raise_frame (f);
917   else
918     ns_lower_frame (f);
922 static void
923 ns_frame_rehighlight (struct frame *frame)
924 /* --------------------------------------------------------------------------
925      External (hook): called on things like window switching within frame
926    -------------------------------------------------------------------------- */
928   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
929   struct frame *old_highlight = dpyinfo->x_highlight_frame;
931   NSTRACE (ns_frame_rehighlight);
932   if (dpyinfo->x_focus_frame)
933     {
934       dpyinfo->x_highlight_frame
935         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
936            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
937            : dpyinfo->x_focus_frame);
938       if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
939         {
940           FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
941           dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
942         }
943     }
944   else
945       dpyinfo->x_highlight_frame = 0;
947   if (dpyinfo->x_highlight_frame &&
948          dpyinfo->x_highlight_frame != old_highlight)
949     {
950       if (old_highlight)
951         {
952           x_update_cursor (old_highlight, 1);
953           x_set_frame_alpha (old_highlight);
954         }
955       if (dpyinfo->x_highlight_frame)
956         {
957           x_update_cursor (dpyinfo->x_highlight_frame, 1);
958           x_set_frame_alpha (dpyinfo->x_highlight_frame);
959         }
960     }
964 void
965 x_make_frame_visible (struct frame *f)
966 /* --------------------------------------------------------------------------
967      External: Show the window (X11 semantics)
968    -------------------------------------------------------------------------- */
970   NSTRACE (x_make_frame_visible);
971   /* XXX: at some points in past this was not needed, as the only place that
972      called this (frame.c:Fraise_frame ()) also called raise_lower;
973      if this ends up the case again, comment this out again. */
974   if (!FRAME_VISIBLE_P (f))
975     {
976       f->async_visible = 1;
977       ns_raise_frame (f);
978     }
982 void
983 x_make_frame_invisible (struct frame *f)
984 /* --------------------------------------------------------------------------
985      External: Hide the window (X11 semantics)
986    -------------------------------------------------------------------------- */
988   NSView * view = FRAME_NS_VIEW (f);
989   NSTRACE (x_make_frame_invisible);
990   check_ns ();
991   [[view window] orderOut: NSApp];
992   f->async_visible = 0;
993   f->async_iconified = 0;
997 void
998 x_iconify_frame (struct frame *f)
999 /* --------------------------------------------------------------------------
1000      External: Iconify window
1001    -------------------------------------------------------------------------- */
1003   NSView * view = FRAME_NS_VIEW (f);
1004   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1005   NSTRACE (x_iconify_frame);
1006   check_ns ();
1008   if (dpyinfo->x_highlight_frame == f)
1009     dpyinfo->x_highlight_frame = 0;
1011   if ([[view window] windowNumber] <= 0)
1012     {
1013       /* the window is still deferred.  Make it very small, bring it
1014          on screen and order it out. */
1015       NSRect s = { { 100, 100}, {0, 0} };
1016       NSRect t;
1017       t = [[view window] frame];
1018       [[view window] setFrame: s display: NO];
1019       [[view window] orderBack: NSApp];
1020       [[view window] orderOut: NSApp];
1021       [[view window] setFrame: t display: NO];
1022     }
1023   [[view window] miniaturize: NSApp];
1027 void
1028 x_destroy_window (struct frame *f)
1029 /* --------------------------------------------------------------------------
1030      External: Delete the window
1031    -------------------------------------------------------------------------- */
1033   NSView *view = FRAME_NS_VIEW (f);
1034   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1035   NSTRACE (x_destroy_window);
1036   check_ns ();
1038   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1040   BLOCK_INPUT;
1042   free_frame_menubar (f);
1044   if (FRAME_FACE_CACHE (f))
1045     free_frame_faces (f);
1047   if (f == dpyinfo->x_focus_frame)
1048     dpyinfo->x_focus_frame = 0;
1049   if (f == dpyinfo->x_highlight_frame)
1050     dpyinfo->x_highlight_frame = 0;
1051   if (f == dpyinfo->mouse_face_mouse_frame)
1052     {
1053       dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
1054       dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
1055       dpyinfo->mouse_face_window = Qnil;
1056       dpyinfo->mouse_face_deferred_gc = 0;
1057       dpyinfo->mouse_face_mouse_frame = 0;
1058     }
1060   xfree (f->output_data.ns);
1062   [[view window] close];
1063   [view release];
1065   ns_window_num--;
1066   UNBLOCK_INPUT;
1070 void
1071 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1072 /* --------------------------------------------------------------------------
1073      External: Position the window
1074    -------------------------------------------------------------------------- */
1076   NSScreen *screen;
1077   NSView *view = FRAME_NS_VIEW (f);
1079   NSTRACE (x_set_offset);
1081   BLOCK_INPUT;
1083   f->left_pos = xoff;
1084   f->top_pos = yoff;
1086   if (view != nil && (screen = [[view window] screen]))
1087     {
1088       f->left_pos = f->size_hint_flags & XNegative
1089         ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
1090         : f->left_pos;
1091       /* We use visibleFrame here to take menu bar into account.
1092          Ideally we should also adjust left/top with visibleFrame.offset.  */
1093          
1094       f->top_pos = f->size_hint_flags & YNegative
1095         ? ([screen visibleFrame].size.height + f->top_pos
1096            - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
1097            - FRAME_TOOLBAR_HEIGHT (f))
1098         : f->top_pos;
1099 #ifdef NS_IMPL_GNUSTEP
1100       if (f->left_pos < 100)
1101         f->left_pos = 100;  /* don't overlap menu */
1102 #endif
1103       [[view window] setFrameTopLeftPoint:
1104                        NSMakePoint (SCREENMAXBOUND (f->left_pos),
1105                                     SCREENMAXBOUND ([screen frame].size.height
1106                                                     - NS_TOP_POS (f)))];
1107       f->size_hint_flags &= ~(XNegative|YNegative);
1108     }
1110   UNBLOCK_INPUT;
1114 void
1115 x_set_window_size (struct frame *f, int change_grav, int cols, int rows)
1116 /* --------------------------------------------------------------------------
1117      Adjust window pixel size based on given character grid size
1118      Impl is a bit more complex than other terms, need to do some
1119      internal clipping and also pay attention to screen constraints.
1120    -------------------------------------------------------------------------- */
1122   EmacsView *view = FRAME_NS_VIEW (f);
1123   EmacsToolbar *toolbar = [view toolbar];
1124   NSWindow *window = [view window];
1125   NSScreen *screen = [window screen];
1126   NSRect wr = [window frame];
1127   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1128   int pixelwidth, pixelheight;
1129   static int oldRows, oldCols, oldFontWidth, oldFontHeight;
1130   static int oldTB;
1131   static struct frame *oldF;
1133   NSTRACE (x_set_window_size);
1135   if (view == nil ||
1136       (f == oldF
1137        && rows == oldRows && cols == oldCols
1138        && oldFontWidth == FRAME_COLUMN_WIDTH (f)
1139        && oldFontHeight == FRAME_LINE_HEIGHT (f)
1140        && oldTB == tb))
1141     return;
1143 /*fprintf (stderr, "\tsetWindowSize: %d x %d, font size %d x %d\n", cols, rows, FRAME_COLUMN_WIDTH (f), FRAME_LINE_HEIGHT (f)); */
1145   BLOCK_INPUT;
1147   check_frame_size (f, &rows, &cols);
1148   oldF = f;
1149   oldRows = rows;
1150   oldCols = cols;
1151   oldFontWidth = FRAME_COLUMN_WIDTH (f);
1152   oldFontHeight = FRAME_LINE_HEIGHT (f);
1153   oldTB = tb;
1155   f->scroll_bar_actual_width = NS_SCROLL_BAR_WIDTH (f);
1156   compute_fringe_widths (f, 0);
1158   pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, cols);
1159   pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
1161   /* If we have a toolbar, take its height into account. */
1162   if (tb)
1163     /* NOTE: previously this would generate wrong result if toolbar not
1164              yet displayed and fixing toolbar_height=32 helped, but
1165              now (200903) seems no longer needed */
1166     FRAME_TOOLBAR_HEIGHT (f) =
1167       NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1168         - FRAME_NS_TITLEBAR_HEIGHT (f);
1169   else
1170     FRAME_TOOLBAR_HEIGHT (f) = 0;
1172   wr.size.width = pixelwidth + f->border_width;
1173   wr.size.height = pixelheight + FRAME_NS_TITLEBAR_HEIGHT (f) 
1174                   + FRAME_TOOLBAR_HEIGHT (f);
1176   /* constrain to screen if we can */
1177   if (screen)
1178     {
1179       NSSize sz = [screen visibleFrame].size;
1180       NSSize ez = { wr.size.width - sz.width, wr.size.height - sz.height };
1181       if (ez.width > 0)
1182         {
1183           int cr = ez.width / FRAME_COLUMN_WIDTH (f) + 1;
1184           cols -= cr;
1185           oldCols = cols;
1186           wr.size.width -= cr * FRAME_COLUMN_WIDTH (f);
1187           pixelwidth -= cr * FRAME_COLUMN_WIDTH (f);
1188         }
1189       if (ez.height > 0)
1190         {
1191           int rr = ez.height / FRAME_LINE_HEIGHT (f) + 1;
1192           rows -= rr;
1193           oldRows = rows;
1194           wr.size.height -= rr * FRAME_LINE_HEIGHT (f);
1195           pixelheight -= rr * FRAME_LINE_HEIGHT (f);
1196         }
1197       wr.origin.x = f->left_pos;
1198       wr.origin.y = [screen frame].size.height - NS_TOP_POS (f)
1199         - wr.size.height;
1200     }
1202   [view setRows: rows andColumns: cols];
1203   [window setFrame: wr display: YES];
1205 /*fprintf (stderr, "\tx_set_window_size %d, %d\t%d, %d\n", cols, rows, pixelwidth, pixelheight); */
1207   /* This is a trick to compensate for Emacs' managing the scrollbar area
1208      as a fixed number of standard character columns.  Instead of leaving
1209      blank space for the extra, we chopped it off above.  Now for
1210      left-hand scrollbars, we shift all rendering to the left by the
1211      difference between the real width and Emacs' imagined one.  For
1212      right-hand bars, don't worry about it since the extra is never used.
1213      (Obviously doesn't work for vertically split windows tho..) */
1214   NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1215     ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1216                   - NS_SCROLL_BAR_WIDTH (f), 0)
1217     : NSMakePoint (0, 0);
1218   [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1219   [view setBoundsOrigin: origin];
1221   change_frame_size (f, rows, cols, 0, 1, 0); /* pretend, delay, safe */
1222   FRAME_PIXEL_WIDTH (f) = pixelwidth;
1223   FRAME_PIXEL_HEIGHT (f) = pixelheight;
1224 /*  SET_FRAME_GARBAGED (f); // this short-circuits expose call in drawRect */
1226   mark_window_cursors_off (XWINDOW (f->root_window));
1227   cancel_mouse_face (f);
1229   UNBLOCK_INPUT;
1234 /* ==========================================================================
1236     Color management
1238    ========================================================================== */
1241 NSColor *
1242 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1244   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1245   if (idx < 1 || idx >= color_table->avail)
1246     return nil;
1247   return color_table->colors[idx];
1251 unsigned long
1252 ns_index_color (NSColor *color, struct frame *f)
1254   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1255   int idx;
1256   NSNumber *index;
1258   if (!color_table->colors)
1259     {
1260       color_table->size = NS_COLOR_CAPACITY;
1261       color_table->avail = 1; /* skip idx=0 as marker */
1262       color_table->colors
1263         = (NSColor **)xmalloc (color_table->size * sizeof (NSColor *));
1264       color_table->colors[0] = nil;
1265       color_table->empty_indices = [[NSMutableSet alloc] init];
1266     }
1268   /* do we already have this color ? */
1269   {
1270     int i;
1271     for (i = 1; i < color_table->avail; i++)
1272       {
1273         if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1274           {
1275             [color_table->colors[i] retain];
1276             return i;
1277           }
1278       }
1279   }
1281   if ([color_table->empty_indices count] > 0)
1282     {
1283       index = [color_table->empty_indices anyObject];
1284       [color_table->empty_indices removeObject: index];
1285       idx = [index unsignedIntValue];
1286     }
1287   else
1288     {
1289       if (color_table->avail == color_table->size)
1290         {
1291           color_table->size += NS_COLOR_CAPACITY;
1292           color_table->colors
1293             = (NSColor **)xrealloc (color_table->colors,
1294                                     color_table->size * sizeof (NSColor *));
1295         }
1296       idx = color_table->avail++;
1297     }
1299   color_table->colors[idx] = color;
1300   [color retain];
1301 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1302   return idx;
1306 void
1307 ns_free_indexed_color (unsigned long idx, struct frame *f)
1309   struct ns_color_table *color_table;
1310   NSColor *color;
1311   NSNumber *index;
1313   if (!f)
1314     return;
1316   color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1318   if (idx <= 0 || idx >= color_table->size) {
1319     message1("ns_free_indexed_color: Color index out of range.\n");
1320     return;
1321   }
1323   index = [NSNumber numberWithUnsignedInt: idx];
1324   if ([color_table->empty_indices containsObject: index]) {
1325     message1("ns_free_indexed_color: attempt to free already freed color.\n");
1326     return;
1327   }
1329   color = color_table->colors[idx];
1330   [color release];
1331   color_table->colors[idx] = nil;
1332   [color_table->empty_indices addObject: [NSNumber numberWithUnsignedInt: idx]];
1333 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1337 static int
1338 ns_get_color (const char *name, NSColor **col)
1339 /* --------------------------------------------------------------------------
1340      Parse a color name
1341    -------------------------------------------------------------------------- */
1342 /* On *Step, we attempt to mimic the X11 platform here, down to installing an
1343    X11 rgb.txt-compatible color list in Emacs.clr (see ns_term_init()).
1344    See: http://thread.gmane.org/gmane.emacs.devel/113050/focus=113272). */
1346   NSColor *new = nil;
1347   static char hex[20];
1348   int scaling;
1349   float r = -1.0, g, b;
1350   NSString *nsname = [NSString stringWithUTF8String: name];
1352 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1353   BLOCK_INPUT;
1355   if ([nsname isEqualToString: @"ns_selection_color"])
1356     {
1357       nsname = ns_selection_color;
1358       name = [ns_selection_color UTF8String];
1359     }
1361   /* First, check for some sort of numeric specification. */
1362   hex[0] = '\0';
1364   if (name[0] == '0' || name[0] == '1' || name[0] == '.')  /* RGB decimal */
1365     {
1366       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1367       [scanner scanFloat: &r];
1368       [scanner scanFloat: &g];
1369       [scanner scanFloat: &b];
1370     }
1371   else if (!strncmp(name, "rgb:", 4))  /* A newer X11 format -- rgb:r/g/b */
1372     {
1373       strncpy (hex, name + 4, 19);
1374       hex[19] = '\0';
1375       scaling = (strlen(hex) - 2) / 3;
1376     }
1377   else if (name[0] == '#')        /* An old X11 format; convert to newer */
1378     {
1379       int len = (strlen(name) - 1);
1380       int start = (len % 3 == 0) ? 1 : len / 4 + 1;
1381       int i;
1382       scaling = strlen(name+start) / 3;
1383       for (i=0; i<3; i++) {
1384         strncpy(hex + i * (scaling + 1), name + start + i * scaling, scaling);
1385         hex[(i+1) * (scaling + 1) - 1] = '/';
1386       }
1387       hex[3 * (scaling + 1) - 1] = '\0';
1388     }
1390   if (hex[0])
1391     {
1392       int rr, gg, bb;
1393       float fscale = scaling == 4 ? 65535.0 : (scaling == 2 ? 255.0 : 15.0);
1394       if (sscanf (hex, "%x/%x/%x", &rr, &gg, &bb))
1395         {
1396           r = rr / fscale;
1397           g = gg / fscale;
1398           b = bb / fscale;
1399         }
1400     }
1402   if (r >= 0.0)
1403     {
1404       *col = [NSColor colorWithCalibratedRed: r green: g blue: b alpha: 1.0];
1405       UNBLOCK_INPUT;
1406       return 0;
1407     }
1409   /* Otherwise, color is expected to be from a list */
1410   {
1411     NSEnumerator *lenum, *cenum;
1412     NSString *name;
1413     NSColorList *clist;
1415 #ifdef NS_IMPL_GNUSTEP
1416     /* XXX: who is wrong, the requestor or the implementation? */
1417     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1418         == NSOrderedSame)
1419       nsname = @"highlightColor";
1420 #endif
1422     lenum = [[NSColorList availableColorLists] objectEnumerator];
1423     while ( (clist = [lenum nextObject]) && new == nil)
1424       {
1425         cenum = [[clist allKeys] objectEnumerator];
1426         while ( (name = [cenum nextObject]) && new == nil )
1427           {
1428             if ([name compare: nsname
1429                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1430               new = [clist colorWithKey: name];
1431           }
1432       }
1433   }
1435   if (new)
1436     *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1437   UNBLOCK_INPUT;
1438   return new ? 0 : 1;
1442 static NSColor *
1443 ns_get_color_default (const char *name, NSColor *dflt)
1444 /* --------------------------------------------------------------------------
1445      Parse a color or use a default value
1446    -------------------------------------------------------------------------- */
1448   NSColor * col;
1450   if (ns_get_color (name, &col))
1451     return dflt;
1452   else
1453     return col;
1458 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1459 /* --------------------------------------------------------------------------
1460      Convert a Lisp string object to a NS color
1461    -------------------------------------------------------------------------- */
1463   NSTRACE (ns_lisp_to_color);
1464   if (STRINGP (color))
1465     return ns_get_color (SDATA (color), col);
1466   else if (SYMBOLP (color))
1467     return ns_get_color (SDATA (SYMBOL_NAME (color)), col);
1468   return 1;
1472 Lisp_Object
1473 ns_color_to_lisp (NSColor *col)
1474 /* --------------------------------------------------------------------------
1475      Convert a color to a lisp string with the RGB equivalent
1476    -------------------------------------------------------------------------- */
1478   CGFloat red, green, blue, alpha, gray;
1479   char buf[1024];
1480   const char *str;
1481   NSTRACE (ns_color_to_lisp);
1483   BLOCK_INPUT;
1484   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1486       if ((str =[[col colorNameComponent] UTF8String]))
1487         {
1488           UNBLOCK_INPUT;
1489           return build_string ((char *)str);
1490         }
1492     [[col colorUsingColorSpaceName: NSCalibratedRGBColorSpace]
1493         getRed: &red green: &green blue: &blue alpha: &alpha];
1494   if (red ==green && red ==blue)
1495     {
1496       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1497             getWhite: &gray alpha: &alpha];
1498       snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1499                 lrint (gray * 0xff), lrint (gray * 0xff), lrint (gray * 0xff));
1500       UNBLOCK_INPUT;
1501       return build_string (buf);
1502     }
1504   snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1505             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1507   UNBLOCK_INPUT;
1508   return build_string (buf);
1512 void
1513 ns_query_color(void *col, XColor *color_def, int setPixel)
1514 /* --------------------------------------------------------------------------
1515          Get ARGB values out of NSColor col and put them into color_def.
1516          If setPixel, set the pixel to a concatenated version.
1517          and set color_def pixel to the resulting index.
1518    -------------------------------------------------------------------------- */
1520   CGFloat r, g, b, a;
1522   [((NSColor *)col) getRed: &r green: &g blue: &b alpha: &a];
1523   color_def->red   = r * 65535;
1524   color_def->green = g * 65535;
1525   color_def->blue  = b * 65535;
1527   if (setPixel == YES)
1528     color_def->pixel
1529       = ARGB_TO_ULONG((int)(a*255),
1530                       (int)(r*255), (int)(g*255), (int)(b*255));
1535 ns_defined_color (struct frame *f, char *name, XColor *color_def, int alloc,
1536                   char makeIndex)
1537 /* --------------------------------------------------------------------------
1538          Return 1 if named color found, and set color_def rgb accordingly.
1539          If makeIndex and alloc are nonzero put the color in the color_table,
1540          and set color_def pixel to the resulting index.
1541          If makeIndex is zero, set color_def pixel to ARGB.
1542          Return 0 if not found
1543    -------------------------------------------------------------------------- */
1545   NSColor *col;
1546   NSTRACE (ns_defined_color);
1548   BLOCK_INPUT;
1549   if (ns_get_color (name, &col) != 0) /* Color not found  */
1550     {
1551       UNBLOCK_INPUT;
1552       return 0;
1553     }
1554   if (makeIndex && alloc)
1555     color_def->pixel = ns_index_color (col, f);
1556   ns_query_color (col, color_def, !makeIndex);
1557   UNBLOCK_INPUT;
1558   return 1;
1562 unsigned long
1563 ns_get_rgb_color (struct frame *f, float r, float g, float b, float a)
1564 /* --------------------------------------------------------------------------
1565     return an autoreleased RGB color
1566    -------------------------------------------------------------------------- */
1568 /*static int c = 1; fprintf (stderr, "color request %d\n", c++); */
1569   if (r < 0.0) r = 0.0;
1570   else if (r > 1.0) r = 1.0;
1571   if (g < 0.0) g = 0.0;
1572   else if (g > 1.0) g = 1.0;
1573   if (b < 0.0) b = 0.0;
1574   else if (b > 1.0) b = 1.0;
1575   if (a < 0.0) a = 0.0;
1576   else if (a > 1.0) a = 1.0;
1577   return (unsigned long) ns_index_color(
1578     [NSColor colorWithCalibratedRed: r green: g blue: b alpha: a], f);
1582 void
1583 x_set_frame_alpha (struct frame *f)
1584 /* --------------------------------------------------------------------------
1585      change the entire-frame transparency
1586    -------------------------------------------------------------------------- */
1588   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1589   EmacsView *view = FRAME_NS_VIEW (f);
1590   double alpha = 1.0;
1591   double alpha_min = 1.0;
1593   if (dpyinfo->x_highlight_frame == f)
1594     alpha = f->alpha[0];
1595   else
1596     alpha = f->alpha[1];
1598   if (FLOATP (Vframe_alpha_lower_limit))
1599     alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
1600   else if (INTEGERP (Vframe_alpha_lower_limit))
1601     alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
1603   if (alpha < 0.0)
1604     return;
1605   else if (1.0 < alpha)
1606     alpha = 1.0;
1607   else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
1608     alpha = alpha_min;
1610 #ifdef NS_IMPL_COCOA
1611   [[view window] setAlphaValue: alpha];
1612 #endif
1616 /* ==========================================================================
1618     Mouse handling
1620    ========================================================================== */
1623 void
1624 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1625 /* --------------------------------------------------------------------------
1626      Programmatically reposition mouse pointer in pixel coordinates
1627    -------------------------------------------------------------------------- */
1629   NSTRACE (x_set_mouse_pixel_position);
1630   ns_raise_frame (f);
1631 #if 0
1632   /* FIXME: this does not work, and what about GNUstep? */
1633 #ifdef NS_IMPL_COCOA
1634   [FRAME_NS_VIEW (f) lockFocus];
1635   PSsetmouse ((float)pix_x, (float)pix_y);
1636   [FRAME_NS_VIEW (f) unlockFocus];
1637 #endif
1638 #endif
1642 void
1643 x_set_mouse_position (struct frame *f, int h, int v)
1644 /* --------------------------------------------------------------------------
1645      Programmatically reposition mouse pointer in character coordinates
1646    -------------------------------------------------------------------------- */
1648   int pix_x, pix_y;
1650   pix_x = FRAME_COL_TO_PIXEL_X (f, h) + FRAME_COLUMN_WIDTH (f) / 2;
1651   pix_y = FRAME_LINE_TO_PIXEL_Y (f, v) + FRAME_LINE_HEIGHT (f) / 2;
1653   if (pix_x < 0) pix_x = 0;
1654   if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
1656   if (pix_y < 0) pix_y = 0;
1657   if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
1659   x_set_mouse_pixel_position (f, pix_x, pix_y);
1663 static int
1664 note_mouse_movement (struct frame *frame, float x, float y)
1665 /*   ------------------------------------------------------------------------
1666      Called by EmacsView on mouseMovement events.  Passes on
1667      to emacs mainstream code if we moved off of a rect of interest
1668      known as last_mouse_glyph.
1669      ------------------------------------------------------------------------ */
1671 //  NSTRACE (note_mouse_movement);
1673   XSETFRAME (last_mouse_motion_frame, frame);
1675   /* Note, this doesn't get called for enter/leave, since we don't have a
1676      position.  Those are taken care of in the corresponding NSView methods. */
1678   /* has movement gone beyond last rect we were tracking? */
1679   if (x < last_mouse_glyph.origin.x ||
1680       x >= (last_mouse_glyph.origin.x + last_mouse_glyph.size.width) ||
1681       y < last_mouse_glyph.origin.y ||
1682       y >= (last_mouse_glyph.origin.y + last_mouse_glyph.size.height))
1683     {
1684       ns_update_begin(frame);
1685       frame->mouse_moved = 1;
1686       note_mouse_highlight (frame, x, y);
1687       remember_mouse_glyph (frame, x, y, &last_mouse_glyph);
1688       ns_update_end(frame);
1689       return 1;
1690     }
1692   return 0;
1696 static void
1697 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1698                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1699                    unsigned long *time)
1700 /* --------------------------------------------------------------------------
1701     External (hook): inform emacs about mouse position and hit parts.
1702     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1703     x & y should be position in the scrollbar (the whole bar, not the handle)
1704     and length of scrollbar respectively
1705    -------------------------------------------------------------------------- */
1707   id view;
1708   NSPoint position;
1709   int xchar, ychar;
1710   Lisp_Object frame, tail;
1711   struct frame *f;
1712   struct ns_display_info *dpyinfo;
1714   NSTRACE (ns_mouse_position);
1716   if (*fp == NULL)
1717     {
1718       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1719       return;
1720     }
1722   dpyinfo = FRAME_NS_DISPLAY_INFO (*fp);
1724   BLOCK_INPUT;
1726   if (last_mouse_scroll_bar != nil && insist == 0)
1727     {
1728       /* TODO: we do not use this path at the moment because drag events will
1729            go directly to the EmacsScroller.  Leaving code in for now. */
1730       [last_mouse_scroll_bar getMouseMotionPart: (int *)part window: bar_window
1731                                               x: x y: y];
1732       if (time) *time = last_mouse_movement_time;
1733       last_mouse_scroll_bar = nil;
1734     }
1735   else
1736     {
1737       /* Clear the mouse-moved flag for every frame on this display.  */
1738       FOR_EACH_FRAME (tail, frame)
1739         if (FRAME_NS_P (XFRAME (frame))
1740             && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1741           XFRAME (frame)->mouse_moved = 0;
1743       last_mouse_scroll_bar = nil;
1744       if (last_mouse_frame && FRAME_LIVE_P (last_mouse_frame))
1745         f = last_mouse_frame;
1746       else
1747         f = dpyinfo->x_focus_frame ? dpyinfo->x_focus_frame
1748                                     : SELECTED_FRAME ();
1750       if (f && f->output_data.ns)  /* TODO: 2nd check no longer needed? */
1751         {
1752           view = FRAME_NS_VIEW (*fp);
1754           position = [[view window] mouseLocationOutsideOfEventStream];
1755           position = [view convertPoint: position fromView: nil];
1756           remember_mouse_glyph (f, position.x, position.y, &last_mouse_glyph);
1757 /*fprintf (stderr, "ns_mouse_position: %.0f, %.0f\n", position.x, position.y); */
1759           if (bar_window) *bar_window = Qnil;
1760           if (part) *part = 0; /*scroll_bar_handle; */
1762           if (x) XSETINT (*x, lrint (position.x));
1763           if (y) XSETINT (*y, lrint (position.y));
1764           if (time) *time = last_mouse_movement_time;
1765           *fp = f;
1766         }
1767     }
1769   UNBLOCK_INPUT;
1773 static void
1774 ns_frame_up_to_date (struct frame *f)
1775 /* --------------------------------------------------------------------------
1776     External (hook): Fix up mouse highlighting right after a full update.
1777     Some highlighting was deferred if GC was happening during
1778     note_mouse_highlight (), while other highlighting was deferred for update.
1779    -------------------------------------------------------------------------- */
1781   NSTRACE (ns_frame_up_to_date);
1783   if (FRAME_NS_P (f))
1784     {
1785       struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1786       if ((dpyinfo->mouse_face_deferred_gc||f ==dpyinfo->mouse_face_mouse_frame)
1787       /*&& dpyinfo->mouse_face_mouse_frame*/)
1788         {
1789           BLOCK_INPUT;
1790          ns_update_begin(f);
1791           if (dpyinfo->mouse_face_mouse_frame)
1792             note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
1793                                   dpyinfo->mouse_face_mouse_x,
1794                                   dpyinfo->mouse_face_mouse_y);
1795           dpyinfo->mouse_face_deferred_gc = 0;
1796          ns_update_end(f);
1797           UNBLOCK_INPUT;
1798         }
1799     }
1803 void
1804 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1805 /* --------------------------------------------------------------------------
1806     External (RIF): set frame mouse pointer type.
1807    -------------------------------------------------------------------------- */
1809   NSTRACE (ns_define_frame_cursor);
1810   if (FRAME_POINTER_TYPE (f) != cursor)
1811     {
1812       EmacsView *view = FRAME_NS_VIEW (f);
1813       FRAME_POINTER_TYPE (f) = cursor;
1814       [[view window] invalidateCursorRectsForView: view];
1815     }
1820 /* ==========================================================================
1822     Keyboard handling
1824    ========================================================================== */
1827 static unsigned
1828 ns_convert_key (unsigned code)
1829 /* --------------------------------------------------------------------------
1830     Internal call used by NSView-keyDown.
1831    -------------------------------------------------------------------------- */
1833   const unsigned last_keysym = (sizeof (convert_ns_to_X_keysym)
1834                                 / sizeof (convert_ns_to_X_keysym[0]));
1835   unsigned keysym;
1836   /* An array would be faster, but less easy to read. */
1837   for (keysym = 0; keysym < last_keysym; keysym += 2)
1838     if (code == convert_ns_to_X_keysym[keysym])
1839       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
1840   return 0;
1841 /* if decide to use keyCode and Carbon table, use this line:
1842      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
1846 char *
1847 x_get_keysym_name (int keysym)
1848 /* --------------------------------------------------------------------------
1849     Called by keyboard.c.  Not sure if the return val is important, except
1850     that it be unique.
1851    -------------------------------------------------------------------------- */
1853   static char value[16];
1854   NSTRACE (x_get_keysym_name);
1855   sprintf (value, "%d", keysym);
1856   return value;
1861 /* ==========================================================================
1863     Block drawing operations
1865    ========================================================================== */
1868 static void
1869 ns_redraw_scroll_bars (struct frame *f)
1871   int i;
1872   id view;
1873   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
1874   NSTRACE (ns_judge_scroll_bars);
1875   for (i =[subviews count]-1; i >= 0; i--)
1876     {
1877       view = [subviews objectAtIndex: i];
1878       if (![view isKindOfClass: [EmacsScroller class]]) continue;
1879       [view display];
1880     }
1884 void
1885 ns_clear_frame (struct frame *f)
1886 /* --------------------------------------------------------------------------
1887       External (hook): Erase the entire frame
1888    -------------------------------------------------------------------------- */
1890   NSView *view = FRAME_NS_VIEW (f);
1891   NSRect r;
1893   NSTRACE (ns_clear_frame);
1894   if (ns_in_resize)
1895     return;
1897  /* comes on initial frame because we have
1898     after-make-frame-functions = select-frame */
1899  if (!FRAME_DEFAULT_FACE (f))
1900    return;
1902   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
1904   output_cursor.hpos = output_cursor.vpos = 0;
1905   output_cursor.x = -1;
1907   r = [view bounds];
1909   BLOCK_INPUT;
1910   ns_focus (f, &r, 1);
1911   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
1912   NSRectFill (r);
1913   ns_unfocus (f);
1915 #ifdef NS_IMPL_COCOA
1916   [[view window] display];  /* redraw resize handle */
1917 #endif
1919   /* as of 2006/11 or so this is now needed */
1920   ns_redraw_scroll_bars (f);
1921   UNBLOCK_INPUT;
1925 void
1926 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
1927 /* --------------------------------------------------------------------------
1928     External (RIF):  Clear section of frame
1929    -------------------------------------------------------------------------- */
1931   NSRect r = NSMakeRect (x, y, width, height);
1932   NSView *view = FRAME_NS_VIEW (f);
1933   struct face *face = FRAME_DEFAULT_FACE (f);
1935   if (!view || !face)
1936     return;
1938   NSTRACE (ns_clear_frame_area);
1940   r = NSIntersectionRect (r, [view frame]);
1941   ns_focus (f, &r, 1);
1942   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
1944 #ifdef NS_IMPL_COCOA
1945   {
1946     /* clip out the resize handle */
1947     NSWindow *window = [FRAME_NS_VIEW (f) window];
1948     NSRect ir
1949       = [view convertRect: ns_resize_handle_rect (window) fromView: nil];
1951     ir = NSIntersectionRect (r, ir);
1952     if (NSIsEmptyRect (ir))
1953       {
1954 #endif
1956   NSRectFill (r);
1958 #ifdef NS_IMPL_COCOA
1959       }
1960     else
1961       {
1962         NSRect r1 = r, r2 = r; /* upper and lower non-intersecting */
1963         r1.size.height -= ir.size.height;
1964         r2.origin.y += r1.size.height;
1965         r2.size.width -= ir.size.width;
1966         r2.size.height = ir.size.height;
1967         NSRectFill (r1);
1968         NSRectFill (r2);
1969       }
1970   }
1971 #endif
1973   ns_unfocus (f);
1974   return;
1978 static void
1979 ns_scroll_run (struct window *w, struct run *run)
1980 /* --------------------------------------------------------------------------
1981     External (RIF):  Insert or delete n lines at line vpos
1982    -------------------------------------------------------------------------- */
1984   struct frame *f = XFRAME (w->frame);
1985   int x, y, width, height, from_y, to_y, bottom_y;
1987   NSTRACE (ns_scroll_run);
1989   /* begin copy from other terms */
1990   /* Get frame-relative bounding box of the text display area of W,
1991      without mode lines.  Include in this box the left and right
1992      fringe of W.  */
1993   window_box (w, -1, &x, &y, &width, &height);
1995   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
1996   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
1997   bottom_y = y + height;
1999   if (to_y < from_y)
2000     {
2001       /* Scrolling up.  Make sure we don't copy part of the mode
2002          line at the bottom.  */
2003       if (from_y + run->height > bottom_y)
2004         height = bottom_y - from_y;
2005       else
2006         height = run->height;
2007     }
2008   else
2009     {
2010       /* Scolling down.  Make sure we don't copy over the mode line.
2011          at the bottom.  */
2012       if (to_y + run->height > bottom_y)
2013         height = bottom_y - to_y;
2014       else
2015         height = run->height;
2016     }
2017   /* end copy from other terms */
2019   if (height == 0)
2020       return;
2022   BLOCK_INPUT;
2024   updated_window = w;
2025   x_clear_cursor (w);
2027   {
2028     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2029     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2030     NSPoint dstOrigin = NSMakePoint (x, to_y);
2032     ns_focus (f, &dstRect, 1);
2033     NSCopyBits (0, srcRect , dstOrigin);
2034     ns_unfocus (f);
2035   }
2037   UNBLOCK_INPUT;
2041 static void
2042 ns_after_update_window_line (struct glyph_row *desired_row)
2043 /* --------------------------------------------------------------------------
2044     External (RIF): preparatory to fringe update after text was updated
2045    -------------------------------------------------------------------------- */
2047   struct window *w = updated_window;
2048   struct frame *f;
2049   int width, height;
2051   NSTRACE (ns_after_update_window_line);
2053   /* begin copy from other terms */
2054   xassert (w);
2056   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2057     desired_row->redraw_fringe_bitmaps_p = 1;
2059   /* When a window has disappeared, make sure that no rest of
2060      full-width rows stays visible in the internal border.
2061      Under NS this is drawn inside the fringes. */
2062   if (windows_or_buffers_changed
2063       && (f = XFRAME (w->frame),
2064           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2065           width != 0)
2066       && (height = desired_row->visible_height,
2067           height > 0))
2068     {
2069       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2071       /* Internal border is drawn below the tool bar.  */
2072       if (WINDOWP (f->tool_bar_window)
2073           && w == XWINDOW (f->tool_bar_window))
2074         y -= width;
2075       /* end copy from other terms */
2077       BLOCK_INPUT;
2078       if (!desired_row->full_width_p)
2079         {
2080           int x1 = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2081             + WINDOW_LEFT_FRINGE_WIDTH (w);
2082           int x2 = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2083             + FRAME_PIXEL_WIDTH (f) - NS_SCROLL_BAR_WIDTH (f)
2084             - WINDOW_RIGHT_FRINGE_WIDTH (w)
2085             - FRAME_INTERNAL_BORDER_WIDTH (f);
2086           ns_clear_frame_area (f, x1, y, width, height);
2087           ns_clear_frame_area (f, x2, y, width, height);
2088         }
2089       UNBLOCK_INPUT;
2090     }
2094 static void
2095 ns_shift_glyphs_for_insert (struct frame *f,
2096                            int x, int y, int width, int height,
2097                            int shift_by)
2098 /* --------------------------------------------------------------------------
2099     External (RIF): copy an area horizontally, don't worry about clearing src
2100    -------------------------------------------------------------------------- */
2102   NSRect srcRect = NSMakeRect (x, y, width, height);
2103   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2104   NSPoint dstOrigin = dstRect.origin;
2106   NSTRACE (ns_shift_glyphs_for_insert);
2108   ns_focus (f, &dstRect, 1);
2109   NSCopyBits (0, srcRect, dstOrigin);
2110   ns_unfocus (f);
2115 /* ==========================================================================
2117     Character encoding and metrics
2119    ========================================================================== */
2122 static inline void
2123 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2124 /* --------------------------------------------------------------------------
2125      External (RIF); compute left/right overhang of whole string and set in s
2126    -------------------------------------------------------------------------- */
2128   struct face *face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2129   struct font *font = s->font; /*face->font; */
2131   if (s->char2b)
2132     {
2133       struct font_metrics metrics;
2134       unsigned int codes[2];
2135       codes[0] = *(s->char2b);
2136       codes[1] = *(s->char2b + s->nchars - 1);
2138       font->driver->text_extents (font, codes, 2, &metrics);
2139       s->left_overhang = -metrics.lbearing;
2140       s->right_overhang
2141         = metrics.rbearing > metrics.width
2142         ? metrics.rbearing - metrics.width : 0;
2143     }
2144   else
2145     {
2146       s->left_overhang = 0;
2147       s->right_overhang = ((struct nsfont_info *)font)->ital ?
2148         FONT_HEIGHT (font) * 0.2 : 0;
2149     }
2154 /* ==========================================================================
2156     Fringe and cursor drawing
2158    ========================================================================== */
2161 extern int max_used_fringe_bitmap;
2162 static void
2163 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2164                       struct draw_fringe_bitmap_params *p)
2165 /* --------------------------------------------------------------------------
2166     External (RIF); fringe-related
2167    -------------------------------------------------------------------------- */
2169   struct frame *f = XFRAME (WINDOW_FRAME (w));
2170   struct face *face = p->face;
2171   int rowY;
2172   static EmacsImage **bimgs = NULL;
2173   static int nBimgs = 0;
2174   /* NS-specific: move internal border inside fringe */
2175   int x = p->bx < 0 ? p->x : p->bx;
2176   int wd = p->bx < 0 ? p->wd : p->nx;
2177   BOOL fringeOnVeryLeft
2178     = x - WINDOW_LEFT_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)
2179       - FRAME_INTERNAL_BORDER_WIDTH (f) < 10;
2180   BOOL fringeOnVeryRight
2181     = FRAME_PIXEL_WIDTH (f) - x - wd - FRAME_INTERNAL_BORDER_WIDTH (f)
2182       - WINDOW_RIGHT_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w) < 10;
2183   int xAdjust = FRAME_INTERNAL_BORDER_WIDTH (f) *
2184     (fringeOnVeryLeft ? -1 : (fringeOnVeryRight ? 1 : 0));
2186   /* grow bimgs if needed */
2187   if (nBimgs < max_used_fringe_bitmap)
2188     {
2189       EmacsImage **newBimgs
2190         = xmalloc (max_used_fringe_bitmap * sizeof (EmacsImage *));
2191       bzero (newBimgs, max_used_fringe_bitmap * sizeof (EmacsImage *));
2193       if (nBimgs)
2194         {
2195           bcopy (bimgs, newBimgs, nBimgs * sizeof (EmacsImage *));
2196           xfree (bimgs);
2197         }
2199       bimgs = newBimgs;
2200       nBimgs = max_used_fringe_bitmap;
2201     }
2203   /* Must clip because of partially visible lines.  */
2204   rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
2205   ns_clip_to_row (w, row, -1, YES);
2207   if (p->bx >= 0 && !p->overlay_p)
2208     {
2209       int yAdjust = rowY - FRAME_INTERNAL_BORDER_WIDTH (f) < 5 ?
2210         -FRAME_INTERNAL_BORDER_WIDTH (f) : 0;
2211       int yIncr = FRAME_PIXEL_HEIGHT (f) - (p->by+yAdjust + p->ny) < 5 ?
2212         FRAME_INTERNAL_BORDER_WIDTH (f) : 0;
2213       if (yAdjust)
2214         yIncr += FRAME_INTERNAL_BORDER_WIDTH (f);
2215       NSRect r = NSMakeRect (p->bx+xAdjust, p->by+yAdjust, p->nx, p->ny+yIncr);
2216       NSRectClip (r);
2217       [ns_lookup_indexed_color(face->background, f) set];
2218       NSRectFill (r);
2219     }
2221   if (p->which)
2222     {
2223       NSRect r = NSMakeRect (p->x+xAdjust, p->y, p->wd, p->h);
2224       NSPoint pt = r.origin;
2225       EmacsImage *img = bimgs[p->which - 1];
2227       if (!img)
2228         {
2229           unsigned short *bits = p->bits + p->dh;
2230           int len = 8 * p->h/8;
2231           int i;
2232           unsigned char *cbits = xmalloc (len);
2234           for (i =0; i<len; i++)
2235             cbits[i] = ~(bits[i] & 0xff);
2236           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2237                                            flip: NO];
2238           bimgs[p->which - 1] = img;
2239           xfree (cbits);
2240         }
2242       NSRectClip (r);
2243       /* Since we composite the bitmap instead of just blitting it, we need
2244          to erase the whole background. */
2245       [ns_lookup_indexed_color(face->background, f) set];
2246       NSRectFill (r);
2247       pt.y += p->h;
2248       [img setXBMColor: ns_lookup_indexed_color(face->foreground, f)];
2249       [img compositeToPoint: pt operation: NSCompositeSourceOver];
2250     }
2251   ns_unfocus (f);
2255 void
2256 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2257                        int x, int y, int cursor_type, int cursor_width,
2258                        int on_p, int active_p)
2259 /* --------------------------------------------------------------------------
2260      External call (RIF): draw cursor
2261      (modeled after x_draw_window_cursor
2262      FIXME: cursor_width is effectively bogus -- it sometimes gets set
2263      in xdisp.c set_frame_cursor_types, sometimes left uninitialized;
2264      DON'T USE IT (no other terms do)
2265    -------------------------------------------------------------------------- */
2267   NSRect r, s;
2268   int fx, fy, h;
2269   struct frame *f = WINDOW_XFRAME (w);
2270   struct glyph *phys_cursor_glyph;
2271   int overspill;
2273   NSTRACE (dumpcursor);
2274 //fprintf(stderr, "drawcursor (%d,%d) activep = %d\tonp = %d\tc_type = %d\twidth = %d\n",x,y, active_p,on_p,cursor_type,cursor_width);
2276   if (!on_p)
2277         return;
2279   w->phys_cursor_type = cursor_type;
2280   w->phys_cursor_on_p = on_p;
2282   if (cursor_type == NO_CURSOR)
2283     {
2284       w->phys_cursor_width = 0;
2285       return;
2286     }
2288   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2289     {
2290       if (glyph_row->exact_window_width_line_p
2291           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2292         {
2293           glyph_row->cursor_in_fringe_p = 1;
2294           draw_fringe_bitmap (w, glyph_row, 0);
2295         }
2296       return;
2297     }
2299   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2301   r.origin.x = fx, r.origin.y = fy;
2302   r.size.height = h;
2303   r.size.width = w->phys_cursor_width;
2305   /* FIXME: if we overwrite the internal border area, it does not get erased;
2306      fix by truncating cursor, but better would be to erase properly */
2307   overspill = r.origin.x + r.size.width -
2308     WINDOW_TEXT_TO_FRAME_PIXEL_X (w, WINDOW_BOX_RIGHT_EDGE_X (w) 
2309       - WINDOW_TOTAL_FRINGE_WIDTH (w) - FRAME_INTERNAL_BORDER_WIDTH (f));
2310   if (overspill > 0)
2311     r.size.width -= overspill;
2313   /* TODO: only needed in rare cases with last-resort font in HELLO..
2314      should we do this more efficiently? */
2315   ns_clip_to_row (w, glyph_row, -1, NO); /* do ns_focus(f, &r, 1); if remove */
2316   [FRAME_CURSOR_COLOR (f) set];
2318 #ifdef NS_IMPL_COCOA
2319   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2320            atomic.  Cleaner ways of doing this should be investigated.
2321            One way would be to set a global variable DRAWING_CURSOR
2322            when making the call to draw_phys..(), don't focus in that
2323            case, then move the ns_unfocus() here after that call. */
2324   NSDisableScreenUpdates ();
2325 #endif
2327   switch (cursor_type)
2328     {
2329     case NO_CURSOR:
2330       break;
2331     case FILLED_BOX_CURSOR:
2332       NSRectFill (r);
2333       break;
2334     case HOLLOW_BOX_CURSOR:
2335       NSRectFill (r);
2336       [FRAME_BACKGROUND_COLOR (f) set];
2337       NSRectFill (NSInsetRect (r, 1, 1));
2338       [FRAME_CURSOR_COLOR (f) set];
2339       break;
2340     case HBAR_CURSOR:
2341       s = r;
2342       s.origin.y += lrint (0.75 * s.size.height);
2343       s.size.height = lrint (s.size.height * 0.25);
2344       NSRectFill (s);
2345       break;
2346     case BAR_CURSOR:
2347       s = r;
2348       s.size.width = min (cursor_width, 2); //FIXME(see above)
2349       NSRectFill (s);
2350       break;
2351     }
2352   ns_unfocus (f);
2354   /* draw the character under the cursor */
2355   if (cursor_type != NO_CURSOR)
2356     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2358 #ifdef NS_IMPL_COCOA
2359   NSEnableScreenUpdates ();
2360 #endif
2365 static void
2366 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2367 /* --------------------------------------------------------------------------
2368      External (RIF): Draw a vertical line.
2369    -------------------------------------------------------------------------- */
2371   struct frame *f = XFRAME (WINDOW_FRAME (w));
2372   struct face *face;
2373   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2375   NSTRACE (ns_draw_vertical_window_border);
2377   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2378   if (face)
2379       [ns_lookup_indexed_color(face->foreground, f) set];
2381   ns_focus (f, &r, 1);
2382   NSRectFill(r);
2383   ns_unfocus (f);
2387 void
2388 show_hourglass (struct atimer *timer)
2390   if (hourglass_shown_p)
2391     return;
2393   BLOCK_INPUT;
2395   /* TODO: add NSProgressIndicator to selected frame (see macfns.c) */
2397   hourglass_shown_p = 1;
2398   UNBLOCK_INPUT;
2402 void
2403 hide_hourglass ()
2405   if (!hourglass_shown_p)
2406     return;
2408   BLOCK_INPUT;
2410   /* TODO: remove NSProgressIndicator from all frames */
2412   hourglass_shown_p = 0;
2413   UNBLOCK_INPUT;
2418 /* ==========================================================================
2420     Glyph drawing operations
2422    ========================================================================== */
2425 static inline NSRect
2426 ns_fix_rect_ibw (NSRect r, int fibw, int frame_pixel_width)
2427 /* --------------------------------------------------------------------------
2428     Under NS we draw internal borders inside fringes, and want full-width
2429     rendering to go all the way to edge.  This function makes that correction.
2430    -------------------------------------------------------------------------- */
2432   if (r.origin.y <= fibw+1)
2433     {
2434       r.size.height += r.origin.y;
2435       r.origin.y = 0;
2436     }
2437   if (r.origin.x <= fibw+1)
2438     {
2439       r.size.width += r.origin.x;
2440       r.origin.x = 0;
2441     }
2442   if (frame_pixel_width - (r.origin.x+r.size.width) <= fibw+1)
2443     r.size.width += fibw;
2445   return r;
2449 static int
2450 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2451 /* --------------------------------------------------------------------------
2452     Wrapper utility to account for internal border width on full-width lines,
2453     and allow top full-width rows to hit the frame top.  nr should be pointer
2454     to two successive NSRects.  Number of rects actually used is returned.
2455    -------------------------------------------------------------------------- */
2457   int n = get_glyph_string_clip_rects (s, nr, 2);
2458   if (s->row->full_width_p)
2459     {
2460       *nr = ns_fix_rect_ibw (*nr, FRAME_INTERNAL_BORDER_WIDTH (s->f),
2461                             FRAME_PIXEL_WIDTH (s->f));
2462       if (n == 2)
2463         *nr = ns_fix_rect_ibw (*(nr+1), FRAME_INTERNAL_BORDER_WIDTH (s->f),
2464                               FRAME_PIXEL_WIDTH (s->f));
2465     }
2466   return n;
2470 static void
2471 ns_draw_box (NSRect r, float thickness, NSColor *col, char left_p, char right_p)
2472 /* --------------------------------------------------------------------------
2473     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2474     Note we can't just use an NSDrawRect command, because of the possibility
2475     of some sides not being drawn, and because the rect will be filled.
2476    -------------------------------------------------------------------------- */
2478   NSRect s = r;
2479   [col set];
2481   /* top, bottom */
2482   s.size.height = thickness;
2483   NSRectFill (s);
2484   s.origin.y += r.size.height - thickness;
2485   NSRectFill (s);
2487   s.size.height = r.size.height;
2488   s.origin.y = r.origin.y;
2490   /* left, right (optional) */
2491   s.size.width = thickness;
2492   if (left_p)
2493     NSRectFill (s);
2494   if (right_p)
2495     {
2496       s.origin.x += r.size.width - thickness;
2497       NSRectFill (s);
2498     }
2502 static void
2503 ns_draw_relief (NSRect r, int thickness, char raised_p,
2504                char top_p, char bottom_p, char left_p, char right_p,
2505                struct glyph_string *s)
2506 /* --------------------------------------------------------------------------
2507     Draw a relief rect inside r, optionally leaving some sides open.
2508     Note we can't just use an NSDrawBezel command, because of the possibility
2509     of some sides not being drawn, and because the rect will be filled.
2510    -------------------------------------------------------------------------- */
2512   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2513   NSColor *newBaseCol = nil;
2514   NSRect sr = r;
2516   NSTRACE (ns_draw_relief);
2518   /* set up colors */
2520   if (s->face->use_box_color_for_shadows_p)
2521     {
2522       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2523     }
2524 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2525            && s->img->pixmap
2526            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2527        {
2528          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2529        } */
2530   else
2531     {
2532       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2533     }
2535   if (newBaseCol == nil)
2536     newBaseCol = [NSColor grayColor];
2538   if (newBaseCol != baseCol)  /* TODO: better check */
2539     {
2540       [baseCol release];
2541       baseCol = [newBaseCol retain];
2542       [lightCol release];
2543       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2544       [darkCol release];
2545       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2546     }
2548   [(raised_p ? lightCol : darkCol) set];
2550   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2552   /* top */
2553   sr.size.height = thickness;
2554   if (top_p) NSRectFill (sr);
2556   /* left */
2557   sr.size.height = r.size.height;
2558   sr.size.width = thickness;
2559   if (left_p) NSRectFill (sr);
2561   [(raised_p ? darkCol : lightCol) set];
2563   /* bottom */
2564   sr.size.width = r.size.width;
2565   sr.size.height = thickness;
2566   sr.origin.y += r.size.height - thickness;
2567   if (bottom_p) NSRectFill (sr);
2569   /* right */
2570   sr.size.height = r.size.height;
2571   sr.origin.y = r.origin.y;
2572   sr.size.width = thickness;
2573   sr.origin.x += r.size.width - thickness;
2574   if (right_p) NSRectFill (sr);
2578 static void
2579 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2580 /* --------------------------------------------------------------------------
2581       Function modeled after x_draw_glyph_string_box ().
2582       Sets up parameters for drawing.
2583    -------------------------------------------------------------------------- */
2585   int right_x, last_x;
2586   char left_p, right_p;
2587   struct glyph *last_glyph;
2588   NSRect r;
2589   int thickness;
2590   struct face *face;
2592   if (s->hl == DRAW_MOUSE_FACE)
2593     {
2594       face = FACE_FROM_ID
2595         (s->f, FRAME_NS_DISPLAY_INFO (s->f)->mouse_face_face_id);
2596       if (!face)
2597         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2598     }
2599   else
2600     face = s->face;
2602   thickness = face->box_line_width;
2604   NSTRACE (ns_dumpglyphs_box_or_relief);
2606   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2607             ? WINDOW_RIGHT_EDGE_X (s->w)
2608             : window_box_right (s->w, s->area));
2609   last_glyph = (s->cmp || s->img
2610                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2612   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2613               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2615   left_p = (s->first_glyph->left_box_line_p
2616             || (s->hl == DRAW_MOUSE_FACE
2617                 && (s->prev == NULL || s->prev->hl != s->hl)));
2618   right_p = (last_glyph->right_box_line_p
2619              || (s->hl == DRAW_MOUSE_FACE
2620                  && (s->next == NULL || s->next->hl != s->hl)));
2622   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2624   /* expand full-width row over internal borders */
2625   if (s->row->full_width_p)
2626     r = ns_fix_rect_ibw (r, FRAME_INTERNAL_BORDER_WIDTH (s->f),
2627                         FRAME_PIXEL_WIDTH (s->f));
2629   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2630   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2631     {
2632       ns_draw_box (r, abs (thickness),
2633                    ns_lookup_indexed_color (face->box_color, s->f),
2634                   left_p, right_p);
2635     }
2636   else
2637     {
2638       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2639                      1, 1, left_p, right_p, s);
2640     }
2644 static void
2645 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2646 /* --------------------------------------------------------------------------
2647       Modeled after x_draw_glyph_string_background, which draws BG in
2648       certain cases.  Others are left to the text rendering routine.
2649    -------------------------------------------------------------------------- */
2651   NSTRACE (ns_maybe_dumpglyphs_background);
2653   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2654     {
2655       int box_line_width = max (s->face->box_line_width, 0);
2656       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2657           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2658         {
2659           struct face *face;
2660           if (s->hl == DRAW_MOUSE_FACE)
2661             {
2662               face = FACE_FROM_ID
2663                 (s->f, FRAME_NS_DISPLAY_INFO (s->f)->mouse_face_face_id);
2664               if (!face)
2665                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2666             }
2667           else
2668             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2669           if (!face->stipple)
2670             [(NS_FACE_BACKGROUND (face) != 0
2671               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2672               : FRAME_BACKGROUND_COLOR (s->f)) set];
2673           else
2674             {
2675               struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (s->f);
2676               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2677             }
2679           if (s->hl != DRAW_CURSOR)
2680             {
2681               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2682                                     s->background_width,
2683                                     s->height-2*box_line_width);
2685               /* expand full-width row over internal borders */
2686               if (s->row->full_width_p)
2687                 {
2688                   int fibw = FRAME_INTERNAL_BORDER_WIDTH (s->f);
2689                   if (r.origin.y <= fibw+1 + box_line_width)
2690                     {
2691                       r.size.height += r.origin.y;
2692                       r.origin.y = 0;
2693                     }
2694                   if (r.origin.x <= fibw+1)
2695                     {
2696                       r.size.width += 2*r.origin.x;
2697                       r.origin.x = 0;
2698                     }
2699                   if (FRAME_PIXEL_WIDTH (s->f) - (r.origin.x + r.size.width)
2700                       <= fibw+1)
2701                     r.size.width += fibw;
2702                 }
2704               NSRectFill (r);
2705             }
2707           s->background_filled_p = 1;
2708         }
2709     }
2713 static void
2714 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2715 /* --------------------------------------------------------------------------
2716       Renders an image and associated borders.
2717    -------------------------------------------------------------------------- */
2719   EmacsImage *img = s->img->pixmap;
2720   int box_line_vwidth = max (s->face->box_line_width, 0);
2721   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2722   int bg_x, bg_y, bg_height;
2723   int th;
2724   char raised_p;
2725   NSRect br;
2726   struct face *face;
2728   NSTRACE (ns_dumpglyphs_image);
2730   if (s->face->box != FACE_NO_BOX
2731       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2732     x += abs (s->face->box_line_width);
2734   bg_x = x;
2735   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
2736   bg_height = s->height;
2737   /* other terms have this, but was causing problems w/tabbar mode */
2738   /* - 2 * box_line_vwidth; */
2740   if (s->slice.x == 0) x += s->img->hmargin;
2741   if (s->slice.y == 0) y += s->img->vmargin;
2743   /* Draw BG: if we need larger area than image itself cleared, do that,
2744      otherwise, since we composite the image under NS (instead of mucking
2745      with its background color), we must clear just the image area. */
2746   if (s->hl == DRAW_MOUSE_FACE)
2747     {
2748       face = FACE_FROM_ID
2749        (s->f, FRAME_NS_DISPLAY_INFO (s->f)->mouse_face_face_id);
2750       if (!face)
2751        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2752     }
2753   else
2754     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2756   if (s->hl == DRAW_CURSOR)
2757       [FRAME_CURSOR_COLOR (s->f) set];
2758   else
2759     [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
2761   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
2762       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
2763     {
2764       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
2765       s->background_filled_p = 1;
2766     }
2767   else
2768     {
2769       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
2770     }
2772   /* expand full-width row over internal borders */
2773   if (s->row->full_width_p)
2774     {
2775       int fibw = FRAME_INTERNAL_BORDER_WIDTH (s->f);
2776       if (br.origin.y <= fibw+1 + box_line_vwidth)
2777         {
2778           br.size.height += br.origin.y;
2779           br.origin.y = 0;
2780         }
2781       if (br.origin.x <= fibw+1 + box_line_vwidth)
2782         {
2783           br.size.width += br.origin.x;
2784           br.origin.x = 0;
2785         }
2786       if (FRAME_PIXEL_WIDTH (s->f) - (br.origin.x + br.size.width) <= fibw+1)
2787         br.size.width += fibw;
2788     }
2790   NSRectFill (br);
2792   /* Draw the image.. do we need to draw placeholder if img ==nil? */
2793   if (img != nil)
2794     [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
2795                 operation: NSCompositeSourceOver];
2797   /* Draw relief, if requested */
2798   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
2799     {
2800       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
2801         {
2802           th = tool_bar_button_relief >= 0 ?
2803             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2804           raised_p = (s->hl == DRAW_IMAGE_RAISED);
2805         }
2806       else
2807         {
2808           th = abs (s->img->relief);
2809           raised_p = (s->img->relief > 0);
2810         }
2812       r.origin.x = x - th;
2813       r.origin.y = y - th;
2814       r.size.width = s->slice.width + 2*th-1;
2815       r.size.height = s->slice.height + 2*th-1;
2816       ns_draw_relief (r, th, raised_p,
2817                       s->slice.y == 0,
2818                       s->slice.y + s->slice.height == s->img->height,
2819                       s->slice.x == 0,
2820                       s->slice.x + s->slice.width == s->img->width, s);
2821     }
2823   /* If there is no mask, the background won't be seen,
2824      so draw a rectangle on the image for the cursor.
2825      Do this for all images, getting trancparency right is not reliable.  */
2826   if (s->hl == DRAW_CURSOR)
2827     {
2828       int thickness = abs (s->img->relief);
2829       if (thickness == 0) thickness = 1;
2830       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
2831     }
2835 static void
2836 ns_dumpglyphs_stretch (struct glyph_string *s)
2838   NSRect r[2];
2839   int n, i;
2840   struct face *face;
2842   if (!s->background_filled_p)
2843     {
2844       n = ns_get_glyph_string_clip_rect (s, r);
2845       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
2847       for (i=0; i<n; i++)
2848         {
2849           if (!s->row->full_width_p)
2850             {
2851               /* truncate to avoid overwriting fringe and/or scrollbar */
2852               int overrun = max (0, (s->x + s->background_width)
2853                                   - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
2854                                     - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
2855               r[i].size.width -= overrun;
2857               /* XXX: Try to work between problem where a stretch glyph on
2858                  a partially-visible bottom row will clear part of the
2859                  modeline, and another where list-buffers headers and similar
2860                  rows erroneously have visible_height set to 0.  Not sure
2861                  where this is coming from as other terms seem not to show. */
2862               r[i].size.height = min (s->height, s->row->visible_height);
2863             }
2865           /* expand full-width rows over internal borders */
2866           else
2867             {
2868               r[i] = ns_fix_rect_ibw (r[i], FRAME_INTERNAL_BORDER_WIDTH (s->f),
2869                                       FRAME_PIXEL_WIDTH (s->f));
2870             }
2872           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
2873              overwriting cursor (usually when cursor on a tab) */
2874           if (s->hl == DRAW_CURSOR)
2875             {
2876               r[i].origin.x += s->width;
2877               r[i].size.width -= s->width;
2878             }
2879         }
2881       ns_focus (s->f, r, n);
2883       if (s->hl == DRAW_MOUSE_FACE)
2884        {
2885          face = FACE_FROM_ID
2886            (s->f, FRAME_NS_DISPLAY_INFO (s->f)->mouse_face_face_id);
2887          if (!face)
2888            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2889        }
2890       else
2891        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2893       [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
2895       NSRectFill (r[0]);
2896       NSRectFill (r[1]);
2897       ns_unfocus (s->f);
2898       s->background_filled_p = 1;
2899     }
2903 static void
2904 ns_draw_glyph_string (struct glyph_string *s)
2905 /* --------------------------------------------------------------------------
2906       External (RIF): Main draw-text call.
2907    -------------------------------------------------------------------------- */
2909   /* TODO (optimize): focus for box and contents draw */
2910   NSRect r[2];
2911   int n;
2912   char box_drawn_p = 0;
2914   NSTRACE (ns_draw_glyph_string);
2916   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
2917     {
2918       int width;
2919       struct glyph_string *next;
2921       for (width = 0, next = s->next;
2922            next && width < s->right_overhang;
2923            width += next->width, next = next->next)
2924         if (next->first_glyph->type != IMAGE_GLYPH)
2925           {
2926             if (next->first_glyph->type != STRETCH_GLYPH)
2927               {
2928                 n = ns_get_glyph_string_clip_rect (s->next, r);
2929                 ns_focus (s->f, r, n);
2930                 ns_maybe_dumpglyphs_background (s->next, 1);
2931                 ns_unfocus (s->f);
2932               }
2933             else
2934               {
2935                 ns_dumpglyphs_stretch (s->next);
2936               }
2937             next->num_clips = 0;
2938           }
2939     }
2941   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
2942         && (s->first_glyph->type == CHAR_GLYPH
2943             || s->first_glyph->type == COMPOSITE_GLYPH))
2944     {
2945       n = ns_get_glyph_string_clip_rect (s, r);
2946       ns_focus (s->f, r, n);
2947       ns_maybe_dumpglyphs_background (s, 1);
2948       ns_dumpglyphs_box_or_relief (s);
2949       ns_unfocus (s->f);
2950       box_drawn_p = 1;
2951     }
2953   switch (s->first_glyph->type)
2954     {
2956     case IMAGE_GLYPH:
2957       n = ns_get_glyph_string_clip_rect (s, r);
2958       ns_focus (s->f, r, n);
2959       ns_dumpglyphs_image (s, r[0]);
2960       ns_unfocus (s->f);
2961       break;
2963     case STRETCH_GLYPH:
2964       ns_dumpglyphs_stretch (s);
2965       break;
2967     case CHAR_GLYPH:
2968     case COMPOSITE_GLYPH:
2969       n = ns_get_glyph_string_clip_rect (s, r);
2970       ns_focus (s->f, r, n);
2972       if (s->for_overlaps || (s->cmp_from > 0
2973                               && ! s->first_glyph->u.cmp.automatic))
2974         s->background_filled_p = 1;
2975       else
2976         ns_maybe_dumpglyphs_background
2977           (s, s->first_glyph->type == COMPOSITE_GLYPH);
2979       ns_tmp_flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
2980                     (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
2981                      (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
2982                       NS_DUMPGLYPH_NORMAL));
2983       ns_tmp_font = (struct nsfont_info *)s->face->font;
2984       if (ns_tmp_font == NULL)
2985           ns_tmp_font = (struct nsfont_info *)FRAME_FONT (s->f);
2987       ns_tmp_font->font.driver->draw
2988         (s, 0, s->nchars, s->x, s->y,
2989          (ns_tmp_flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
2990          || ns_tmp_flags == NS_DUMPGLYPH_MOUSEFACE);
2992       ns_unfocus (s->f);
2993       break;
2995     default:
2996       abort ();
2997     }
2999   /* Draw box if not done already. */
3000   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3001     {
3002       n = ns_get_glyph_string_clip_rect (s, r);
3003       ns_focus (s->f, r, n);
3004       ns_dumpglyphs_box_or_relief (s);
3005       ns_unfocus (s->f);
3006     }
3008   s->num_clips = 0;
3013 /* ==========================================================================
3015     Event loop
3017    ========================================================================== */
3020 static void
3021 ns_send_appdefined (int value)
3022 /* --------------------------------------------------------------------------
3023     Internal: post an appdefined event which EmacsApp-sendEvent will
3024               recognize and take as a command to halt the event loop.
3025    -------------------------------------------------------------------------- */
3027   /*NSTRACE (ns_send_appdefined); */
3029   /* Only post this event if we haven't already posted one.  This will end
3030        the [NXApp run] main loop after having processed all events queued at
3031        this moment.  */
3032   if (send_appdefined)
3033     {
3034       NSEvent *nxev;
3036       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3037       send_appdefined = NO;
3039       /* Don't need wakeup timer any more */
3040       if (timed_entry)
3041         {
3042           [timed_entry invalidate];
3043           [timed_entry release];
3044           timed_entry = nil;
3045         }
3047       /* Ditto for file descriptor poller */
3048       if (fd_entry)
3049         {
3050           [fd_entry invalidate];
3051           [fd_entry release];
3052           fd_entry = nil;
3053         }
3055       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3056                                 location: NSMakePoint (0, 0)
3057                            modifierFlags: 0
3058                                timestamp: 0
3059                             windowNumber: [[NSApp mainWindow] windowNumber]
3060                                  context: [NSApp context]
3061                                  subtype: 0
3062                                    data1: value
3063                                    data2: 0];
3065       /* Post an application defined event on the event queue.  When this is
3066          received the [NXApp run] will return, thus having processed all
3067          events which are currently queued.  */
3068       [NSApp postEvent: nxev atStart: NO];
3069     }
3073 static int
3074 ns_read_socket (struct terminal *terminal, int expected,
3075                 struct input_event *hold_quit)
3076 /* --------------------------------------------------------------------------
3077      External (hook): Post an event to ourself and keep reading events until
3078      we read it back again.  In effect process all events which were waiting.
3079      From 21+ we have to manage the event buffer ourselves.
3080    -------------------------------------------------------------------------- */
3082   struct input_event ev;
3083   int nevents;
3085 /* NSTRACE (ns_read_socket); */
3087   if (interrupt_input_blocked)
3088     {
3089       interrupt_input_pending = 1;
3090 #ifdef SYNC_INPUT
3091       pending_signals = 1;
3092 #endif
3093       return -1;
3094     }
3096   interrupt_input_pending = 0;
3097 #ifdef SYNC_INPUT
3098   pending_signals = pending_atimers;
3099 #endif
3101   BLOCK_INPUT;
3102   n_emacs_events_pending = 0;
3103   EVENT_INIT (ev);
3104   emacs_event = &ev;
3105   q_event_ptr = hold_quit;
3107   /* we manage autorelease pools by allocate/reallocate each time around
3108      the loop; strict nesting is occasionally violated but seems not to
3109      matter.. earlier methods using full nesting caused major memory leaks */
3110   [outerpool release];
3111   outerpool = [[NSAutoreleasePool alloc] init];
3113   /* If have pending open-file requests, attend to the next one of those. */
3114   if (ns_pending_files && [ns_pending_files count] != 0
3115       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3116     {
3117       [ns_pending_files removeObjectAtIndex: 0];
3118     }
3119   /* Deal with pending service requests. */
3120   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3121     && [(EmacsApp *)
3122          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3123                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3124     {
3125       [ns_pending_service_names removeObjectAtIndex: 0];
3126       [ns_pending_service_args removeObjectAtIndex: 0];
3127     }
3128   else
3129     {
3130       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3131          to ourself, otherwise [NXApp run] will never exit.  */
3132       send_appdefined = YES;
3134       /* If called via ns_select, this is called once with expected=1,
3135          because we expect either the timeout or file descriptor activity.
3136          In this case the first event through will either be real input or
3137          one of these.  read_avail_input() then calls once more with expected=0
3138          and in that case we need to return quickly if there is nothing.
3139          If we're being called outside of that, it's also OK to return quickly
3140          after one iteration through the event loop, since other terms do
3141          this and emacs expects it. */
3142       if (!(inNsSelect && expected))
3143         {
3144           /* Post an application defined event on the event queue.  When this is
3145              received the [NXApp run] will return, thus having processed all
3146              events which are currently queued, if any.  */
3147           ns_send_appdefined (-1);
3148         }
3150       [NSApp run];
3151     }
3153   nevents = n_emacs_events_pending;
3154   n_emacs_events_pending = 0;
3155   emacs_event = q_event_ptr = NULL;
3156   UNBLOCK_INPUT;
3158   return nevents;
3163 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3164            fd_set *exceptfds, struct timeval *timeout)
3165 /* --------------------------------------------------------------------------
3166      Replacement for select, checking for events
3167    -------------------------------------------------------------------------- */
3169   int result;
3170   double time;
3171   NSEvent *ev;
3172 /*  NSTRACE (ns_select); */
3174   if (NSApp == nil || inNsSelect == 1 /* || ([NSApp isActive] == NO &&
3175                       [NSApp nextEventMatchingMask:NSAnyEventMask untilDate:nil
3176  inMode:NSDefaultRunLoopMode dequeue:NO] == nil) */)
3177     return select (nfds, readfds, writefds, exceptfds, timeout);
3179   /* Save file descriptor set, which gets overwritten in calls to select ()
3180      Note, this is called from process.c, and only readfds is ever set */
3181   if (readfds)
3182     {
3183       memcpy (&select_readfds, readfds, sizeof (fd_set));
3184       select_nfds = nfds;
3185     }
3186   else
3187     select_nfds = 0;
3189     /* Try an initial select for pending data on input files */
3190   select_timeout.tv_sec = select_timeout.tv_usec = 0;
3191   result = select (nfds, readfds, writefds, exceptfds, &select_timeout);
3192   if (result)
3193     return result;
3195   /* if (!timeout || timed_entry || fd_entry)
3196        fprintf (stderr, "assertion failed: timeout null or timed_entry/fd_entry non-null in ns_select\n"); */
3198     /* set a timeout and run the main AppKit event loop while continuing
3199        to monitor the files */
3200   time = ((double) timeout->tv_sec) + ((double) timeout->tv_usec)/1000000.0;
3201   timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3202                                            target: NSApp
3203                                          selector: @selector (timeout_handler:)
3204                                          userInfo: 0
3205                                           repeats: YES] /* for safe removal */
3206                                                          retain];
3208   /* set a periodic task to try the select () again */
3209   fd_entry = [[NSTimer scheduledTimerWithTimeInterval: 0.1
3210                                                target: NSApp
3211                                              selector: @selector (fd_handler:)
3212                                              userInfo: 0
3213                                               repeats: YES]
3214                retain];
3216   /* Let Application dispatch events until it receives an event of the type
3217      NX_APPDEFINED, which should only be sent by timeout_handler.
3218      We tell read_avail_input() that input is "expected" because we do expect
3219      either the timeout or fd handler to fire, and if they don't, the original
3220      call from process.c that got us here expects us to wait until some input
3221      comes. */
3222   inNsSelect = 1;
3223   gobble_input (1);
3224   ev = last_appdefined_event;
3225   inNsSelect = 0;
3227   if (ev)
3228     {
3229       int t;
3230       if ([ev type] != NSApplicationDefined)
3231         abort ();
3233       t = [ev data1];
3234       last_appdefined_event = 0;
3236       if (t == -2)
3237         {
3238           /* The NX_APPDEFINED event we received was a timeout. */
3239           return 0;
3240         }
3241       else if (t == -1)
3242         {
3243           /* The NX_APPDEFINED event we received was the result of
3244              at least one real input event arriving.  */
3245           errno = EINTR;
3246           return -1;
3247         }
3248       else
3249         {
3250           /* Received back from select () in fd_handler; copy the results */
3251           if (readfds)
3252             memcpy (readfds, &select_readfds, sizeof (fd_set));
3253           return t;
3254         }
3255     }
3256   /* never reached, shut compiler up */
3257   return 0;
3262 /* ==========================================================================
3264     Scrollbar handling
3266    ========================================================================== */
3269 static void
3270 ns_set_vertical_scroll_bar (struct window *window,
3271                            int portion, int whole, int position)
3272 /* --------------------------------------------------------------------------
3273       External (hook): Update or add scrollbar
3274    -------------------------------------------------------------------------- */
3276   Lisp_Object win;
3277   NSRect r, v;
3278   struct frame *f = XFRAME (WINDOW_FRAME (window));
3279   EmacsView *view = FRAME_NS_VIEW (f);
3280   int window_y, window_height;
3281   BOOL barOnVeryLeft, barOnVeryRight;
3282   int top, left, height, width, sb_width, sb_left;
3283   EmacsScroller *bar;
3284 static int count = 0;
3286   /* optimization; display engine sends WAY too many of these.. */
3287   if (!NILP (window->vertical_scroll_bar))
3288     {
3289       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3290       if ([bar checkSamePosition: position portion: portion whole: whole])
3291         {
3292           if (view->scrollbarsNeedingUpdate == 0)
3293             {
3294               if (!windows_or_buffers_changed)
3295                   return;
3296             }
3297           else
3298             view->scrollbarsNeedingUpdate--;
3299         }
3300     }
3302   NSTRACE (ns_set_vertical_scroll_bar);
3304   /* Get dimensions.  */
3305   window_box (window, -1, 0, &window_y, 0, &window_height);
3306   top = window_y;
3307   height = window_height;
3308   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3309   left = WINDOW_SCROLL_BAR_AREA_X (window);
3311   if (top < 5) /* top scrollbar adjustment */
3312     {
3313       top -= FRAME_INTERNAL_BORDER_WIDTH (f);
3314       height += FRAME_INTERNAL_BORDER_WIDTH (f);
3315     }
3317   /* allow for displaying a skinnier scrollbar than char area allotted */
3318   sb_width = (WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) > 0) ?
3319     WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) : width;
3321   barOnVeryLeft = left < 5;
3322   barOnVeryRight = FRAME_PIXEL_WIDTH (f) - left - width < 5;
3323   sb_left = left + FRAME_INTERNAL_BORDER_WIDTH (f)
3324       * (barOnVeryLeft ? -1 : (barOnVeryRight ? 1 : 0));
3326   r = NSMakeRect (sb_left, top, sb_width, height);
3327   /* the parent view is flipped, so we need to flip y value */
3328   v = [view frame];
3329   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3331   XSETWINDOW (win, window);
3332   BLOCK_INPUT;
3334   /* we want at least 5 lines to display a scrollbar */
3335   if (WINDOW_TOTAL_LINES (window) < 5)
3336     {
3337       if (!NILP (window->vertical_scroll_bar))
3338         {
3339           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3340           [bar removeFromSuperview];
3341           window->vertical_scroll_bar = Qnil;
3342         }
3343       ns_clear_frame_area (f, sb_left, top, width, height);
3344       UNBLOCK_INPUT;
3345       return;
3346     }
3348   if (NILP (window->vertical_scroll_bar))
3349     {
3350       ns_clear_frame_area (f, sb_left, top, width, height);
3351       bar = [[EmacsScroller alloc] initFrame: r window: win];
3352       window->vertical_scroll_bar = make_save_value (bar, 0);
3353     }
3354   else
3355     {
3356       NSRect oldRect;
3357       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3358       oldRect = [bar frame];
3359       r.size.width = oldRect.size.width;
3360       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3361         {
3362           if (oldRect.origin.x != r.origin.x)
3363               ns_clear_frame_area (f, sb_left, top, width, height);
3364           [bar setFrame: r];
3365         }
3366     }
3368   [bar setPosition: position portion: portion whole: whole];
3369   UNBLOCK_INPUT;
3373 static void
3374 ns_condemn_scroll_bars (struct frame *f)
3375 /* --------------------------------------------------------------------------
3376      External (hook): arrange for all frame's scrollbars to be removed
3377      at next call to judge_scroll_bars, except for those redeemed.
3378    -------------------------------------------------------------------------- */
3380   int i;
3381   id view;
3382   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3384   NSTRACE (ns_condemn_scroll_bars);
3386   for (i =[subviews count]-1; i >= 0; i--)
3387     {
3388       view = [subviews objectAtIndex: i];
3389       if ([view isKindOfClass: [EmacsScroller class]])
3390         [view condemn];
3391     }
3395 static void
3396 ns_redeem_scroll_bar (struct window *window)
3397 /* --------------------------------------------------------------------------
3398      External (hook): arrange to spare this window's scrollbar
3399      at next call to judge_scroll_bars.
3400    -------------------------------------------------------------------------- */
3402   id bar;
3403   NSTRACE (ns_redeem_scroll_bar);
3404   if (!NILP (window->vertical_scroll_bar))
3405     {
3406       bar =XNS_SCROLL_BAR (window->vertical_scroll_bar);
3407       [bar reprieve];
3408     }
3412 static void
3413 ns_judge_scroll_bars (struct frame *f)
3414 /* --------------------------------------------------------------------------
3415      External (hook): destroy all scrollbars on frame that weren't
3416      redeemed after call to condemn_scroll_bars.
3417    -------------------------------------------------------------------------- */
3419   int i;
3420   id view;
3421   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3422   NSTRACE (ns_judge_scroll_bars);
3423   for (i =[subviews count]-1; i >= 0; i--)
3424     {
3425       view = [subviews objectAtIndex: i];
3426       if (![view isKindOfClass: [EmacsScroller class]]) continue;
3427       [view judge];
3428     }
3432 void
3433 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
3435   /* XXX irrelevant under NS */
3440 /* ==========================================================================
3442     Initialization
3444    ========================================================================== */
3447 x_display_pixel_height (dpyinfo)
3448      struct ns_display_info *dpyinfo;
3450   NSScreen *screen = [NSScreen mainScreen];
3451   return [screen frame].size.height;
3455 x_display_pixel_width (dpyinfo)
3456      struct ns_display_info *dpyinfo;
3458   NSScreen *screen = [NSScreen mainScreen];
3459   return [screen frame].size.width;
3463 static Lisp_Object ns_string_to_lispmod (const char *s)
3464 /* --------------------------------------------------------------------------
3465      Convert modifier name to lisp symbol
3466    -------------------------------------------------------------------------- */
3468   if (!strncmp (SDATA (SYMBOL_NAME (Qmeta)), s, 10))
3469     return Qmeta;
3470   else if (!strncmp (SDATA (SYMBOL_NAME (Qsuper)), s, 10))
3471     return Qsuper;
3472   else if (!strncmp (SDATA (SYMBOL_NAME (Qcontrol)), s, 10))
3473     return Qcontrol;
3474   else if (!strncmp (SDATA (SYMBOL_NAME (Qalt)), s, 10))
3475     return Qalt;
3476   else if (!strncmp (SDATA (SYMBOL_NAME (Qhyper)), s, 10))
3477     return Qhyper;
3478   else if (!strncmp (SDATA (SYMBOL_NAME (Qnone)), s, 10))
3479     return Qnone;
3480   else
3481     return Qnil;
3485 static Lisp_Object ns_mod_to_lisp (int m)
3486 /* --------------------------------------------------------------------------
3487      Convert modifier code (see lisp.h) to lisp symbol
3488    -------------------------------------------------------------------------- */
3490   if (m == CHAR_META)
3491     return Qmeta;
3492   else if (m == CHAR_SUPER)
3493     return Qsuper;
3494   else if (m == CHAR_CTL)
3495     return Qcontrol;
3496   else if (m == CHAR_ALT)
3497     return Qalt;
3498   else if (m == CHAR_HYPER)
3499     return Qhyper;
3500   else /* if (m == 0) */
3501     return Qnone;
3505 static void
3506 ns_default (const char *parameter, Lisp_Object *result,
3507            Lisp_Object yesval, Lisp_Object noval,
3508            BOOL is_float, BOOL is_modstring)
3509 /* --------------------------------------------------------------------------
3510       Check a parameter value in user's preferences
3511    -------------------------------------------------------------------------- */
3513   const char *value;
3515   if ( (value =[[[NSUserDefaults standardUserDefaults]
3516                    stringForKey: [NSString stringWithUTF8String: parameter]]
3517                 UTF8String]) )
3518     {
3519       double f;
3520       char *pos;
3521       if (strcasecmp (value, "YES") == 0)
3522         *result = yesval;
3523       else if (strcasecmp (value, "NO") == 0)
3524         *result = noval;
3525       else if (is_float && (f = strtod (value, &pos), pos != value))
3526         *result = make_float (f);
3527       else if (is_modstring && value)
3528         *result = ns_string_to_lispmod (value);
3529       else fprintf (stderr,
3530                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
3531     }
3535 void
3536 ns_initialize_display_info (struct ns_display_info *dpyinfo)
3537 /* --------------------------------------------------------------------------
3538       Initialize global info and storage for display.
3539    -------------------------------------------------------------------------- */
3541     NSScreen *screen = [NSScreen mainScreen];
3542     NSWindowDepth depth = [screen depth];
3544     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
3545     dpyinfo->resy = 72.27;
3546     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
3547                                                   NSColorSpaceFromDepth (depth)]
3548                 && ![NSCalibratedWhiteColorSpace isEqualToString:
3549                                                  NSColorSpaceFromDepth (depth)];
3550     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
3551     dpyinfo->image_cache = make_image_cache ();
3552     dpyinfo->color_table
3553       = (struct ns_color_table *)xmalloc (sizeof (struct ns_color_table));
3554     dpyinfo->color_table->colors = NULL;
3555     dpyinfo->root_window = 42; /* a placeholder.. */
3557     dpyinfo->mouse_face_mouse_frame = NULL;
3558     dpyinfo->mouse_face_deferred_gc = 0;
3559     dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
3560     dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
3561     dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
3562     dpyinfo->mouse_face_window = dpyinfo->mouse_face_overlay = Qnil;
3563     dpyinfo->mouse_face_hidden = 0;
3565     dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
3566     dpyinfo->mouse_face_defer = 0;
3568     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
3570     dpyinfo->n_fonts = 0;
3571     dpyinfo->smallest_font_height = 1;
3572     dpyinfo->smallest_char_width = 1;
3576 /* This and next define (many of the) public functions in this file. */
3577 /* x_... are generic versions in xdisp.c that we, and other terms, get away
3578          with using despite presence in the "system dependent" redisplay
3579          interface.  In addition, many of the ns_ methods have code that is
3580          shared with all terms, indicating need for further refactoring. */
3581 extern frame_parm_handler ns_frame_parm_handlers[];
3582 static struct redisplay_interface ns_redisplay_interface =
3584   ns_frame_parm_handlers,
3585   x_produce_glyphs,
3586   x_write_glyphs,
3587   x_insert_glyphs,
3588   x_clear_end_of_line,
3589   ns_scroll_run,
3590   ns_after_update_window_line,
3591   ns_update_window_begin,
3592   ns_update_window_end,
3593   x_cursor_to,
3594   ns_flush,
3595   0, /* flush_display_optional */
3596   x_clear_window_mouse_face,
3597   x_get_glyph_overhangs,
3598   x_fix_overlapping_area,
3599   ns_draw_fringe_bitmap,
3600   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
3601   0, /* destroy_fringe_bitmap */
3602   ns_compute_glyph_string_overhangs,
3603   ns_draw_glyph_string, /* interface to nsfont.m */
3604   ns_define_frame_cursor,
3605   ns_clear_frame_area,
3606   ns_draw_window_cursor,
3607   ns_draw_vertical_window_border,
3608   ns_shift_glyphs_for_insert
3612 static void
3613 ns_delete_display (struct ns_display_info *dpyinfo)
3615   /* TODO... */
3619 /* This function is called when the last frame on a display is deleted. */
3620 static void
3621 ns_delete_terminal (struct terminal *terminal)
3623   struct ns_display_info *dpyinfo = terminal->display_info.ns;
3624   int i;
3626   /* Protect against recursive calls.  delete_frame in
3627      delete_terminal calls us back when it deletes our last frame.  */
3628   if (!terminal->name)
3629     return;
3631   BLOCK_INPUT;
3633   x_destroy_all_bitmaps (dpyinfo);
3634   ns_delete_display (dpyinfo);
3635   UNBLOCK_INPUT;
3639 static struct terminal *
3640 ns_create_terminal (struct ns_display_info *dpyinfo)
3641 /* --------------------------------------------------------------------------
3642       Set up use of NS before we make the first connection.
3643    -------------------------------------------------------------------------- */
3645   struct terminal *terminal;
3647   NSTRACE (ns_create_terminal);
3649   terminal = create_terminal ();
3651   terminal->type = output_ns;
3652   terminal->display_info.ns = dpyinfo;
3653   dpyinfo->terminal = terminal;
3655   terminal->rif = &ns_redisplay_interface;
3657   terminal->clear_frame_hook = ns_clear_frame;
3658   terminal->ins_del_lines_hook = 0; /* XXX vestigial? */
3659   terminal->delete_glyphs_hook = 0; /* XXX vestigial? */
3660   terminal->ring_bell_hook = ns_ring_bell;
3661   terminal->reset_terminal_modes_hook = ns_reset_terminal_modes;
3662   terminal->set_terminal_modes_hook = ns_set_terminal_modes;
3663   terminal->update_begin_hook = ns_update_begin;
3664   terminal->update_end_hook = ns_update_end;
3665   terminal->set_terminal_window_hook = NULL; /* XXX vestigial? */
3666   terminal->read_socket_hook = ns_read_socket;
3667   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
3668   terminal->mouse_position_hook = ns_mouse_position;
3669   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
3670   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
3672   terminal->fullscreen_hook = 0; /* see XTfullscreen_hook */
3674   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
3675   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
3676   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
3677   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
3679   terminal->delete_frame_hook = x_destroy_window;
3680   terminal->delete_terminal_hook = ns_delete_terminal;
3682   terminal->scroll_region_ok = 1;
3683   terminal->char_ins_del_ok = 1;
3684   terminal->line_ins_del_ok = 1;
3685   terminal->fast_clear_end_of_line = 1;
3686   terminal->memory_below_frame = 0;
3688   return terminal;
3692 struct ns_display_info *
3693 ns_term_init (Lisp_Object display_name)
3694 /* --------------------------------------------------------------------------
3695      Start the Application and get things rolling.
3696    -------------------------------------------------------------------------- */
3698   struct terminal *terminal;
3699   struct ns_display_info *dpyinfo;
3700   static int ns_initialized = 0;
3701   Lisp_Object tmp;
3703   NSTRACE (ns_term_init);
3705   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
3706   /*GSDebugAllocationActive (YES); */
3707   BLOCK_INPUT;
3708   handling_signal = 0;
3710   if (!ns_initialized)
3711     {
3712       baud_rate = 38400;
3713       Fset_input_interrupt_mode (Qnil);
3714       ns_initialized = 1;
3715     }
3717   ns_pending_files = [[NSMutableArray alloc] init];
3718   ns_pending_service_names = [[NSMutableArray alloc] init];
3719   ns_pending_service_args = [[NSMutableArray alloc] init];
3721   /* Start app and create the main menu, window, view.
3722      Needs to be here because ns_initialize_display_info () uses AppKit classes.
3723      The view will then ask the NSApp to stop and return to Emacs. */
3724   [EmacsApp sharedApplication];
3725   if (NSApp == nil)
3726     return NULL;
3727   [NSApp setDelegate: NSApp];
3729   /* debugging: log all notifications */
3730   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
3731                                          selector: @selector (logNotification:)
3732                                              name: nil object: nil]; */
3734   dpyinfo = (struct ns_display_info *)xmalloc (sizeof (struct ns_display_info));
3735   bzero (dpyinfo, sizeof (struct ns_display_info));
3737   ns_initialize_display_info (dpyinfo);
3738   terminal = ns_create_terminal (dpyinfo);
3740   terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
3741   init_kboard (terminal->kboard);
3742   terminal->kboard->Vwindow_system = Qns;
3743   terminal->kboard->next_kboard = all_kboards;
3744   all_kboards = terminal->kboard;
3745   /* Don't let the initial kboard remain current longer than necessary.
3746      That would cause problems if a file loaded on startup tries to
3747      prompt in the mini-buffer.  */
3748   if (current_kboard == initial_kboard)
3749     current_kboard = terminal->kboard;
3750   terminal->kboard->reference_count++;
3752   dpyinfo->next = x_display_list;
3753   x_display_list = dpyinfo;
3755   /* Put it on ns_display_name_list */
3756   ns_display_name_list = Fcons (Fcons (display_name, Qnil),
3757                                 ns_display_name_list);
3758   dpyinfo->name_list_element = XCAR (ns_display_name_list);
3760   /* Set the name of the terminal. */
3761   terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
3762   strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
3763   terminal->name[SBYTES (display_name)] = 0;
3765   UNBLOCK_INPUT; 
3767   if (!inhibit_x_resources)
3768     {
3769       ns_default ("GSFontAntiAlias", &ns_antialias_text,
3770                  Qt, Qnil, NO, NO);
3771       tmp = Qnil;
3772       /* this is a standard variable */
3773       ns_default ("AppleAntiAliasingThreshold", &tmp,
3774                  make_float (10.0), make_float (6.0), YES, NO);
3775       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
3776     }
3778   ns_selection_color = [[NSUserDefaults standardUserDefaults]
3779                          stringForKey: @"AppleHighlightColor"];
3780   if (ns_selection_color == nil)
3781     ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
3782   
3783   {
3784     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
3786     if ( cl == nil )
3787       {
3788         Lisp_Object color_file, color_map, color;
3789         int r,g,b;
3790         unsigned long c;
3791         char *name;
3793         color_file = Fexpand_file_name (build_string ("rgb.txt"),
3794                          Fsymbol_value (intern ("data-directory")));
3795         if (NILP (Ffile_readable_p (color_file)))
3796           fatal ("Could not find %s.\n", SDATA (color_file));
3798         color_map = Fx_load_color_file (color_file);
3799         if (NILP (color_map))
3800           fatal ("Could not read %s.\n", SDATA (color_file));
3802         cl = [[NSColorList alloc] initWithName: @"Emacs"];
3803         for ( ; CONSP (color_map); color_map = XCDR (color_map))
3804           {
3805             color = XCAR (color_map);
3806             name = SDATA (XCAR (color));
3807             c = XINT (XCDR (color));
3808             [cl setColor:
3809                   [NSColor colorWithCalibratedRed: RED_FROM_ULONG (c) / 255.0
3810                                             green: GREEN_FROM_ULONG (c) / 255.0
3811                                              blue: BLUE_FROM_ULONG (c) / 255.0
3812                                             alpha: 1.0]
3813                   forKey: [NSString stringWithUTF8String: name]];
3814           }
3815         [cl writeToFile: nil];
3816       }
3817   }
3819   {
3820     char c[128];
3821 #ifdef NS_IMPL_GNUSTEP
3822     strncpy (c, gnustep_base_version, sizeof (c));
3823 #else
3824     /*PSnextrelease (128, c); */
3825     snprintf (c, sizeof (c), "%g", NSAppKitVersionNumber);
3826 #endif
3827     Vwindow_system_version = build_string (c);
3828   }
3830   delete_keyboard_wait_descriptor (0);
3832   ns_app_name = [[NSProcessInfo processInfo] processName];
3834 /* Set up OS X app menu */
3835 #ifdef NS_IMPL_COCOA
3836   {
3837     NSMenu *appMenu;
3838     NSMenuItem *item;
3839     /* set up the application menu */
3840     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
3841     [svcsMenu setAutoenablesItems: NO];
3842     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
3843     [appMenu setAutoenablesItems: NO];
3844     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
3845     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
3847     [appMenu insertItemWithTitle: @"About Emacs"
3848                           action: @selector (orderFrontStandardAboutPanel:)
3849                    keyEquivalent: @""
3850                          atIndex: 0];
3851     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
3852     [appMenu insertItemWithTitle: @"Preferences..."
3853                           action: @selector (showPreferencesWindow:)
3854                    keyEquivalent: @","
3855                          atIndex: 2];
3856     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
3857     item = [appMenu insertItemWithTitle: @"Services"
3858                                  action: @selector (menuDown:)
3859                           keyEquivalent: @""
3860                                 atIndex: 4];
3861     [appMenu setSubmenu: svcsMenu forItem: item];
3862     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
3863     [appMenu insertItemWithTitle: @"Hide Emacs"
3864                           action: @selector (hide:)
3865                    keyEquivalent: @"h"
3866                          atIndex: 6];
3867     item =  [appMenu insertItemWithTitle: @"Hide Others"
3868                           action: @selector (hideOtherApplications:)
3869                    keyEquivalent: @"h"
3870                          atIndex: 7];
3871     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
3872     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
3873     [appMenu insertItemWithTitle: @"Quit Emacs"
3874                           action: @selector (terminate:)
3875                    keyEquivalent: @"q"
3876                          atIndex: 9];
3878     item = [mainMenu insertItemWithTitle: ns_app_name                       
3879                                   action: @selector (menuDown:)
3880                            keyEquivalent: @""
3881                                  atIndex: 0];
3882     [mainMenu setSubmenu: appMenu forItem: item];
3883     [dockMenu insertItemWithTitle: @"New Frame"
3884                            action: @selector (newFrame:)
3885                     keyEquivalent: @""
3886                           atIndex: 0];
3888     [NSApp setMainMenu: mainMenu];
3889     [NSApp setAppleMenu: appMenu];
3890     [NSApp setServicesMenu: svcsMenu];
3891     /* Needed at least on Cocoa, to get dock menu to show windows */
3892     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
3893   }
3894 #endif /* MAC OS X menu setup */
3896   [NSApp run];
3898   return dpyinfo;
3902 extern Lisp_Object Vauto_save_list_file_name;
3903 void
3904 ns_term_shutdown (int sig)
3906   /* code not reached in emacs.c after this is called by shut_down_emacs: */
3907   if (STRINGP (Vauto_save_list_file_name))
3908     unlink (SDATA (Vauto_save_list_file_name));
3910   if (sig == 0 || sig == SIGTERM)
3911     {
3912       [NSApp terminate: NSApp];
3913     }
3914   else // force a stack trace to happen
3915     {
3916       abort();
3917     }
3921 /* ==========================================================================
3923     EmacsApp implementation
3925    ========================================================================== */
3928 @implementation EmacsApp
3930 - (void)logNotification: (NSNotification *)notification
3932   const char *name = [[notification name] UTF8String];
3933   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
3934       && !strstr (name, "WindowNumber"))
3935     NSLog (@"notification: '%@'", [notification name]);
3939 - (void)sendEvent: (NSEvent *)theEvent
3940 /* --------------------------------------------------------------------------
3941      Called when NSApp is running for each event received.  Used to stop
3942      the loop when we choose, since there's no way to just run one iteration.
3943    -------------------------------------------------------------------------- */
3945   int type = [theEvent type];
3946   NSWindow *window = [theEvent window];
3947 /*  NSTRACE (sendEvent); */
3948 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
3950   if (type == NSCursorUpdate && window == nil)
3951     {
3952       fprintf (stderr, "Dropping external cursor update event.\n");
3953       return;
3954     }
3956 #ifdef NS_IMPL_COCOA
3957   /* pass mouse down in resize handle and subsequent drags directly to
3958      EmacsWindow so we can generate continuous redisplays */
3959   if (ns_in_resize)
3960     {
3961       if (type == NSLeftMouseDragged)
3962         {
3963           [window mouseDragged: theEvent];
3964           return;
3965         }
3966       else if (type == NSLeftMouseUp)
3967         {
3968           [window mouseUp: theEvent];
3969           return;
3970         }
3971     }
3972   else if (type == NSLeftMouseDown)
3973     {
3974       NSRect r = ns_resize_handle_rect (window);
3975       if (NSPointInRect ([theEvent locationInWindow], r))
3976         {
3977           ns_in_resize = YES;
3978           [window mouseDown: theEvent];
3979           return;
3980         }
3981     }
3982 #endif
3984   if (type == NSApplicationDefined)
3985     {
3986       /* Events posted by ns_send_appdefined interrupt the run loop here.
3987          But, if a modal window is up, an appdefined can still come through,
3988          (e.g., from a makeKeyWindow event) but stopping self also stops the
3989          modal loop. Just defer it until later. */
3990       if ([NSApp modalWindow] == nil)
3991         {
3992           last_appdefined_event = theEvent;
3993           [self stop: self];
3994         }
3995       else
3996         {
3997           send_appdefined = YES;
3998         }
3999     }
4001   [super sendEvent: theEvent];
4005 - (void)showPreferencesWindow: (id)sender
4007   struct frame *emacsframe = SELECTED_FRAME ();
4008   NSEvent *theEvent = [NSApp currentEvent];
4010   if (!emacs_event)
4011     return;
4012   emacs_event->kind = NS_NONKEY_EVENT;
4013   emacs_event->code = KEY_NS_SHOW_PREFS;
4014   emacs_event->modifiers = 0;
4015   EV_TRAILER (theEvent);
4019 - (void)newFrame: (id)sender
4021   struct frame *emacsframe = SELECTED_FRAME ();
4022   NSEvent *theEvent = [NSApp currentEvent];
4024   if (!emacs_event)
4025     return;
4026   emacs_event->kind = NS_NONKEY_EVENT;
4027   emacs_event->code = KEY_NS_NEW_FRAME;
4028   emacs_event->modifiers = 0;
4029   EV_TRAILER (theEvent);
4033 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4034 - (BOOL) openFile: (NSString *)fileName
4036   struct frame *emacsframe = SELECTED_FRAME ();
4037   NSEvent *theEvent = [NSApp currentEvent];
4039   if (!emacs_event)
4040     return NO;
4042   emacs_event->kind = NS_NONKEY_EVENT;
4043   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4044   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4045   ns_input_line = Qnil; /* can be start or cons start,end */
4046   emacs_event->modifiers =0;
4047   EV_TRAILER (theEvent);
4049   return YES;
4053 /* **************************************************************************
4055       EmacsApp delegate implementation
4057    ************************************************************************** */
4059 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4060 /* --------------------------------------------------------------------------
4061      When application is loaded, terminate event loop in ns_term_init
4062    -------------------------------------------------------------------------- */
4064   NSTRACE (applicationDidFinishLaunching);
4065   [NSApp setServicesProvider: NSApp];
4066   ns_send_appdefined (-2);
4070 /* Termination sequences:
4071     C-x C-c:
4072     Cmd-Q:
4073     MenuBar | File | Exit:
4074     Select Quit from App menubar:
4075         -terminate
4076         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4077         ns_term_shutdown()
4079     Select Quit from Dock menu:
4080     Logout attempt:
4081         -appShouldTerminate
4082           Cancel -> Nothing else
4083           Accept ->
4084           
4085           -terminate
4086           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4087           ns_term_shutdown()
4091 - (void) terminate: (id)sender
4093   struct frame *emacsframe = SELECTED_FRAME ();
4094   
4095   if (!emacs_event)
4096     return;
4097   
4098   emacs_event->kind = NS_NONKEY_EVENT;
4099   emacs_event->code = KEY_NS_POWER_OFF;
4100   emacs_event->arg = Qt; /* mark as non-key event */
4101   EV_TRAILER ((id)nil);
4105 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4107   int ret;
4109   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4110     return NSTerminateNow;
4112     ret = NSRunAlertPanel(ns_app_name,
4113                           [NSString stringWithUTF8String:"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?"],
4114                           @"Save Buffers and Exit", @"Cancel", nil);
4116     if (ret == NSAlertDefaultReturn)
4117         return NSTerminateNow;
4118     else if (ret == NSAlertAlternateReturn)
4119         return NSTerminateCancel;
4120     return NSTerminateNow;  /* just in case */
4124 /*   Notification from the Workspace to open a file */
4125 - (BOOL)application: sender openFile: (NSString *)file
4127   [ns_pending_files addObject: file];
4128   return YES;
4132 /*   Open a file as a temporary file */
4133 - (BOOL)application: sender openTempFile: (NSString *)file
4135   [ns_pending_files addObject: file];
4136   return YES;
4140 /*   Notification from the Workspace to open a file noninteractively (?) */
4141 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4143   [ns_pending_files addObject: file];
4144   return YES;
4148 /*   Notification from the Workspace to open multiple files */
4149 - (void)application: sender openFiles: (NSArray *)fileList
4151   NSEnumerator *files = [fileList objectEnumerator];
4152   NSString *file;
4153   while ((file = [files nextObject]) != nil)
4154     [ns_pending_files addObject: file];
4156   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4161 /* Handle dock menu requests.  */
4162 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4164   return dockMenu;
4168 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4169 - (void)applicationWillBecomeActive: (NSNotification *)notification
4171   //ns_app_active=YES;
4173 - (void)applicationDidBecomeActive: (NSNotification *)notification
4175   //ns_app_active=YES;
4177 - (void)applicationDidResignActive: (NSNotification *)notification
4179   //ns_app_active=NO;
4180   ns_send_appdefined (-1);
4185 /* ==========================================================================
4187     EmacsApp aux handlers for managing event loop
4189    ========================================================================== */
4192 - (void)timeout_handler: (NSTimer *)timedEntry
4193 /* --------------------------------------------------------------------------
4194      The timeout specified to ns_select has passed.
4195    -------------------------------------------------------------------------- */
4197   /*NSTRACE (timeout_handler); */
4198   ns_send_appdefined (-2);
4201 - (void)fd_handler: (NSTimer *) fdEntry
4202 /* --------------------------------------------------------------------------
4203      Check data waiting on file descriptors and terminate if so
4204    -------------------------------------------------------------------------- */
4206   int result;
4207   /* NSTRACE (fd_handler); */
4209   if (select_nfds == 0)
4210     return;
4212   memcpy (&t_readfds, &select_readfds, sizeof (fd_set));
4214   select_timeout.tv_sec = select_timeout.tv_usec = 0;
4215   result = select (select_nfds, &t_readfds, (SELECT_TYPE *)0, (SELECT_TYPE *)0,
4216                   &select_timeout);
4217   if (result)
4218     {
4219       memcpy (&select_readfds, &t_readfds, sizeof (fd_set));
4220       ns_send_appdefined (result);
4221     }
4226 /* ==========================================================================
4228     Service provision
4230    ========================================================================== */
4232 /* called from system: queue for next pass through event loop */
4233 - (void)requestService: (NSPasteboard *)pboard
4234               userData: (NSString *)userData
4235                  error: (NSString **)error
4237   [ns_pending_service_names addObject: userData];
4238   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4239       SDATA (ns_string_from_pasteboard (pboard))]];
4243 /* called from ns_read_socket to clear queue */
4244 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4246   struct frame *emacsframe = SELECTED_FRAME ();
4247   NSEvent *theEvent = [NSApp currentEvent];
4249   if (!emacs_event)
4250     return NO;
4252   emacs_event->kind = NS_NONKEY_EVENT;
4253   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
4254   ns_input_spi_name = build_string ([name UTF8String]);
4255   ns_input_spi_arg = build_string ([arg UTF8String]);
4256   emacs_event->modifiers = EV_MODIFIERS (theEvent);
4257   EV_TRAILER (theEvent);
4259   return YES;
4263 @end  /* EmacsApp */
4267 /* ==========================================================================
4269     EmacsView implementation
4271    ========================================================================== */
4274 @implementation EmacsView
4276 /* needed to inform when window closed from LISP */
4277 - (void) setWindowClosing: (BOOL)closing
4279   windowClosing = closing;
4283 - (void)dealloc
4285   NSTRACE (EmacsView_dealloc);
4286   [toolbar release];
4287   [super dealloc];
4291 /* called on font panel selection */
4292 - (void)changeFont: (id)sender
4294   NSEvent *e =[[self window] currentEvent];
4295   struct face *face =FRAME_DEFAULT_FACE (emacsframe);
4296   id newFont;
4297   float size;
4299   NSTRACE (changeFont);
4300   if (!emacs_event)
4301     return;
4303   if (newFont = [sender convertFont:
4304                            ((struct nsfont_info *)face->font)->nsfont])
4305     {
4306       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
4308       emacs_event->kind = NS_NONKEY_EVENT;
4309       emacs_event->modifiers = 0;
4310       emacs_event->code = KEY_NS_CHANGE_FONT;
4312       size = [newFont pointSize];
4313       ns_input_fontsize = make_number (lrint (size));
4314       ns_input_font = build_string ([[newFont familyName] UTF8String]);
4315       EV_TRAILER (e);
4316     }
4320 - (BOOL)acceptsFirstResponder
4322   NSTRACE (acceptsFirstResponder);
4323   return YES;
4327 - (void)resetCursorRects
4329   NSRect visible = [self visibleRect];
4330   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
4331   NSTRACE (resetCursorRects);
4333   if (currentCursor == nil)
4334     currentCursor = [NSCursor arrowCursor];
4336   if (!NSIsEmptyRect (visible))
4337     [self addCursorRect: visible cursor: currentCursor];
4338   [currentCursor setOnMouseEntered: YES];
4343 /*****************************************************************************/
4344 /* Keyboard handling. */
4345 #define NS_KEYLOG 0
4347 - (void)keyDown: (NSEvent *)theEvent
4349   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
4350   int code;
4351   unsigned fnKeysym = 0;
4352   int flags;
4353   static NSMutableArray *nsEvArray;
4354   static BOOL firstTime = YES;
4356   NSTRACE (keyDown);
4358   /* Rhapsody and OS X give up and down events for the arrow keys */
4359   if (ns_fake_keydown == YES)
4360     ns_fake_keydown = NO;
4361   else if ([theEvent type] != NSKeyDown)
4362     return;
4364   if (!emacs_event)
4365     return;
4367  if (![[self window] isKeyWindow]
4368      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
4369      /* we must avoid an infinite loop here. */
4370      && (EmacsView *)[[theEvent window] delegate] != self)
4371    {
4372      /* XXX: There is an occasional condition in which, when Emacs display
4373          updates a different frame from the current one, and temporarily
4374          selects it, then processes some interrupt-driven input
4375          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
4376          for some reason that window has its first responder set to the NSView
4377          most recently updated (I guess), which is not the correct one. */
4378      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
4379      return;
4380    }
4382   if (nsEvArray == nil)
4383     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
4385   [NSCursor setHiddenUntilMouseMoves: YES];
4387   if (dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
4388     {
4389       clear_mouse_face (dpyinfo);
4390       dpyinfo->mouse_face_hidden = 1;
4391     }
4393   if (!processingCompose)
4394     {
4395       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
4396         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
4397       /* (Carbon way: [theEvent keyCode]) */
4399       /* is it a "function key"? */
4400       fnKeysym = ns_convert_key (code);
4401       if (fnKeysym)
4402         {
4403           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
4404              because Emacs treats Delete and KP-Delete same (in simple.el). */
4405           if (fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
4406             code = 0xFF08; /* backspace */
4407           else
4408             code = fnKeysym;
4409         }
4411       /* are there modifiers? */
4412       emacs_event->modifiers = 0;
4413       flags = [theEvent modifierFlags];
4415       if (flags & NSHelpKeyMask)
4416           emacs_event->modifiers |= hyper_modifier;
4418       if (flags & NSShiftKeyMask)
4419         emacs_event->modifiers |= shift_modifier;
4421       if (flags & NSCommandKeyMask)
4422         {
4423           emacs_event->modifiers |= parse_solitary_modifier (ns_command_modifier);
4424           /* if super (default), take input manager's word so things like
4425              dvorak / qwerty layout work */
4426           if (EQ (ns_command_modifier, Qsuper)
4427               && !fnKeysym
4428               && [[theEvent characters] length] != 0)
4429             {
4430               /* XXX: the code we get will be unshifted, so if we have
4431                  a shift modifier, must convert ourselves */
4432               if (!(flags & NSShiftKeyMask))
4433                 code = [[theEvent characters] characterAtIndex: 0];
4434 #if 0
4435               /* this is ugly and also requires linking w/Carbon framework
4436                  (for LMGetKbdType) so for now leave this rare (?) case
4437                  undealt with.. in future look into CGEvent methods */
4438               else
4439                 {
4440                   long smv = GetScriptManagerVariable (smKeyScript);
4441                   Handle uchrHandle = GetResource
4442                     ('uchr', GetScriptVariable (smv, smScriptKeys));
4443                   UInt32 dummy = 0;
4444                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
4445                                  [[theEvent characters] characterAtIndex: 0],
4446                                  kUCKeyActionDisplay,
4447                                  (flags & ~NSCommandKeyMask) >> 8,
4448                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
4449                                  &dummy, 1, &dummy, &code);
4450                   code &= 0xFF;
4451                 }
4452 #endif
4453             }
4454         }
4456       if (flags & NSControlKeyMask)
4457           emacs_event->modifiers |=
4458             parse_solitary_modifier (ns_control_modifier);
4460       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
4461           emacs_event->modifiers |=
4462             parse_solitary_modifier (ns_function_modifier);
4464       if (!EQ (ns_right_alternate_modifier, Qleft)
4465           && ((flags & NSRightAlternateKeyMask) == NSRightAlternateKeyMask)) 
4466         {
4467           emacs_event->modifiers |= parse_solitary_modifier
4468             (ns_right_alternate_modifier);
4469         }
4470       else if (flags & NSAlternateKeyMask) /* default = meta */
4471         {
4472           if ((NILP (ns_alternate_modifier) || EQ (ns_alternate_modifier, Qnone))
4473               && !fnKeysym)
4474             {   /* accept pre-interp alt comb */
4475               if ([[theEvent characters] length] > 0)
4476                 code = [[theEvent characters] characterAtIndex: 0];
4477               /*HACK: clear lone shift modifier to stop next if from firing */
4478               if (emacs_event->modifiers == shift_modifier)
4479                 emacs_event->modifiers = 0;
4480             }
4481           else
4482               emacs_event->modifiers |=
4483                 parse_solitary_modifier (ns_alternate_modifier);
4484         }
4486   if (NS_KEYLOG)
4487     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
4488              code, fnKeysym, flags, emacs_event->modifiers);
4490       /* if it was a function key or had modifiers, pass it directly to emacs */
4491       if (fnKeysym || (emacs_event->modifiers
4492                        && [[theEvent charactersIgnoringModifiers] length] > 0))
4493 /*[[theEvent characters] length] */
4494         {
4495           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4496           if (code < 0x20)
4497             code |= (1<<28)|(3<<16);
4498           else if (code == 0x7f)
4499             code |= (1<<28)|(3<<16);
4500           else if (!fnKeysym)
4501             emacs_event->kind = code > 0xFF
4502               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
4504           emacs_event->code = code;
4505           EV_TRAILER (theEvent);
4506           return;
4507         }
4508     }
4510   /* if we get here we should send the key for input manager processing */
4511   if (firstTime && [[NSInputManager currentInputManager]
4512                      wantsToDelayTextChangeNotifications] == NO)
4513     fprintf (stderr,
4514           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
4515   firstTime = NO;
4517   if (NS_KEYLOG && !processingCompose)
4518     fprintf (stderr, "keyDown: Begin compose sequence.\n");
4520   processingCompose = YES;
4521   [nsEvArray addObject: theEvent];
4522   [self interpretKeyEvents: nsEvArray];
4523   [nsEvArray removeObject: theEvent];
4527 #ifdef NS_IMPL_COCOA
4528 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
4529    decided not to send key-down for.
4530    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
4531    This only applies on Tiger and earlier.
4532    If it matches one of these, send it on to keyDown. */
4533 -(void)keyUp: (NSEvent *)theEvent
4535   int flags = [theEvent modifierFlags];
4536   int code = [theEvent keyCode];
4537   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
4538       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
4539     {
4540       if (NS_KEYLOG)
4541         fprintf (stderr, "keyUp: passed test");
4542       ns_fake_keydown = YES;
4543       [self keyDown: theEvent];
4544     }
4546 #endif
4549 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
4552 /* <NSTextInput>: called when done composing;
4553    NOTE: also called when we delete over working text, followed immed.
4554          by doCommandBySelector: deleteBackward: */
4555 - (void)insertText: (id)aString
4557   int code;
4558   int len = [(NSString *)aString length];
4559   int i;
4561   if (NS_KEYLOG)
4562     NSLog (@"insertText '%@'\tlen = %d", aString, len);
4563   processingCompose = NO;
4565   if (!emacs_event)
4566     return;
4568   /* first, clear any working text */
4569   if (workingText != nil)
4570     [self deleteWorkingText];
4572   /* now insert the string as keystrokes */
4573   for (i =0; i<len; i++)
4574     {
4575       code = [aString characterAtIndex: i];
4576       /* TODO: still need this? */
4577       if (code == 0x2DC)
4578         code = '~'; /* 0x7E */
4579       emacs_event->modifiers = 0;
4580       emacs_event->kind
4581         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
4582       emacs_event->code = code;
4583       EV_TRAILER ((id)nil);
4584     }
4588 /* <NSTextInput>: inserts display of composing characters */
4589 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
4591   NSString *str = [aString respondsToSelector: @selector (string)] ?
4592     [aString string] : aString;
4593   if (NS_KEYLOG)
4594     NSLog (@"setMarkedText '%@' len =%d range %d from %d", str, [str length],
4595            selRange.length, selRange.location);
4597   if (workingText != nil)
4598     [self deleteWorkingText];
4599   if ([str length] == 0)
4600     return;
4602   if (!emacs_event)
4603     return;
4605   processingCompose = YES;
4606   workingText = [str copy];
4607   ns_working_text = build_string ([workingText UTF8String]);
4609   emacs_event->kind = NS_TEXT_EVENT;
4610   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
4611   EV_TRAILER ((id)nil);
4615 /* delete display of composing characters [not in <NSTextInput>] */
4616 - (void)deleteWorkingText
4618   if (workingText == nil)
4619     return;
4620   if (NS_KEYLOG)
4621     NSLog(@"deleteWorkingText len =%d\n", [workingText length]);
4622   [workingText release];
4623   workingText = nil;
4624   processingCompose = NO;
4626   if (!emacs_event)
4627     return;
4629   emacs_event->kind = NS_TEXT_EVENT;
4630   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
4631   EV_TRAILER ((id)nil);
4635 - (BOOL)hasMarkedText
4637   return workingText != nil;
4641 - (NSRange)markedRange
4643   NSRange rng = workingText != nil
4644     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
4645   if (NS_KEYLOG)
4646     NSLog (@"markedRange request");
4647   return rng;
4651 - (void)unmarkText
4653   if (NS_KEYLOG)
4654     NSLog (@"unmark (accept) text");
4655   [self deleteWorkingText];
4656   processingCompose = NO;
4660 /* used to position char selection windows, etc. */
4661 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
4663   NSRect rect;
4664   NSPoint pt;
4665   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
4666   if (NS_KEYLOG)
4667     NSLog (@"firstRectForCharRange request");
4669   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
4670   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
4671   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
4672   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
4673                                        +FRAME_LINE_HEIGHT (emacsframe));
4675   pt = [self convertPoint: pt toView: nil];
4676   pt = [[self window] convertBaseToScreen: pt];
4677   rect.origin = pt;
4678   return rect;
4682 - (long)conversationIdentifier
4684   return (long)self;
4688 - (void)doCommandBySelector: (SEL)aSelector
4690   if (NS_KEYLOG)
4691     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
4693   if (aSelector == @selector (deleteBackward:))
4694     {
4695       /* happens when user backspaces over an ongoing composition:
4696          throw a 'delete' into the event queue */
4697       if (!emacs_event)
4698         return;
4699       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4700       emacs_event->code = 0xFF08;
4701       EV_TRAILER ((id)nil);
4702     }
4705 - (NSArray *)validAttributesForMarkedText
4707   static NSArray *arr = nil;
4708   if (arr == nil) arr = [NSArray new];
4709  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
4710   return arr;
4713 - (NSRange)selectedRange
4715   if (NS_KEYLOG)
4716     NSLog (@"selectedRange request");
4717   return NSMakeRange (NSNotFound, 0);
4720 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
4722   if (NS_KEYLOG)
4723     NSLog (@"characterIndexForPoint request");
4724   return 0;
4727 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
4729   static NSAttributedString *str = nil;
4730   if (str == nil) str = [NSAttributedString new];
4731   if (NS_KEYLOG)
4732     NSLog (@"attributedSubstringFromRange request");
4733   return str;
4736 /* End <NSTextInput> impl. */
4737 /*****************************************************************************/
4740 /* This is what happens when the user presses a mouse button.  */
4741 - (void)mouseDown: (NSEvent *)theEvent
4743   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
4744   Lisp_Object window;
4746   NSTRACE (mouseDown);
4748   [self deleteWorkingText];
4750   if (!emacs_event)
4751     return;
4753   last_mouse_frame = emacsframe;
4754   /* appears to be needed to prevent spurious movement events generated on
4755      button clicks */
4756   last_mouse_frame->mouse_moved = 0;
4758   if ([theEvent type] == NSScrollWheel)
4759     {
4760       float delta = [theEvent deltaY];
4761       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
4762       if (delta == 0)
4763         return;
4764       emacs_event->kind = WHEEL_EVENT;
4765       emacs_event->code = 0;
4766       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
4767         ((delta > 0) ? up_modifier : down_modifier);
4768     }
4769   else
4770     {
4771       emacs_event->kind = MOUSE_CLICK_EVENT;
4772       emacs_event->code = EV_BUTTON (theEvent);
4773       emacs_event->modifiers = EV_MODIFIERS (theEvent)
4774                              | EV_UDMODIFIERS (theEvent);
4775     }
4776   XSETINT (emacs_event->x, lrint (p.x));
4777   XSETINT (emacs_event->y, lrint (p.y));
4778   EV_TRAILER (theEvent);
4782 - (void)rightMouseDown: (NSEvent *)theEvent
4784   NSTRACE (rightMouseDown);
4785   [self mouseDown: theEvent];
4789 - (void)otherMouseDown: (NSEvent *)theEvent
4791   NSTRACE (otherMouseDown);
4792   [self mouseDown: theEvent];
4796 - (void)mouseUp: (NSEvent *)theEvent
4798   NSTRACE (mouseUp);
4799   [self mouseDown: theEvent];
4803 - (void)rightMouseUp: (NSEvent *)theEvent
4805   NSTRACE (rightMouseUp);
4806   [self mouseDown: theEvent];
4810 - (void)otherMouseUp: (NSEvent *)theEvent
4812   NSTRACE (otherMouseUp);
4813   [self mouseDown: theEvent];
4817 - (void) scrollWheel: (NSEvent *)theEvent
4819   NSTRACE (scrollWheel);
4820   [self mouseDown: theEvent];
4824 /* Tell emacs the mouse has moved. */
4825 - (void)mouseMoved: (NSEvent *)e
4827   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
4828   Lisp_Object frame;
4830 //  NSTRACE (mouseMoved);
4832   last_mouse_movement_time = EV_TIMESTAMP (e);
4833   last_mouse_motion_position
4834     = [self convertPoint: [e locationInWindow] fromView: nil];
4836   /* update any mouse face */
4837   if (dpyinfo->mouse_face_hidden)
4838     {
4839       dpyinfo->mouse_face_hidden = 0;
4840       clear_mouse_face (dpyinfo);
4841     }
4843   /* tooltip handling */
4844   previous_help_echo_string = help_echo_string;
4845   help_echo_string = Qnil;
4847   if (!note_mouse_movement (emacsframe, last_mouse_motion_position.x,
4848                             last_mouse_motion_position.y))
4849     help_echo_string = previous_help_echo_string;
4851   XSETFRAME (frame, emacsframe);
4852   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
4853     {
4854       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
4855          (note_mouse_highlight), which is called through the
4856          note_mouse_movement () call above */
4857       gen_help_event (help_echo_string, frame, help_echo_window,
4858                       help_echo_object, help_echo_pos);
4859     }
4860   else
4861     {
4862       help_echo_string = Qnil;
4863       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
4864     }
4866   if (emacsframe->mouse_moved && send_appdefined)
4867     ns_send_appdefined (-1);
4871 - (void)mouseDragged: (NSEvent *)e
4873   NSTRACE (mouseDragged);
4874   [self mouseMoved: e];
4878 - (void)rightMouseDragged: (NSEvent *)e
4880   NSTRACE (rightMouseDragged);
4881   [self mouseMoved: e];
4885 - (void)otherMouseDragged: (NSEvent *)e
4887   NSTRACE (otherMouseDragged);
4888   [self mouseMoved: e];
4892 - (BOOL)windowShouldClose: (id)sender
4894   NSEvent *e =[[self window] currentEvent];
4896   NSTRACE (windowShouldClose);
4897   windowClosing = YES;
4898   if (!emacs_event)
4899     return NO;
4900   emacs_event->kind = DELETE_WINDOW_EVENT;
4901   emacs_event->modifiers = 0;
4902   emacs_event->code = 0;
4903   EV_TRAILER (e);
4904   /* Don't close this window, let this be done from lisp code.  */
4905   return NO;
4909 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
4910 /* normalize frame to gridded text size */
4912   NSTRACE (windowWillResize);
4913 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
4915   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe,
4916 #ifdef NS_IMPL_GNUSTEP
4917                                         frameSize.width + 3);
4918 #else
4919                                         frameSize.width);
4920 #endif
4921   if (cols < MINWIDTH)
4922     cols = MINWIDTH;
4923   frameSize.width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (emacsframe, cols);
4925   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, frameSize.height
4926 #ifdef NS_IMPL_GNUSTEP
4927       - FRAME_NS_TITLEBAR_HEIGHT (emacsframe) + 3
4928         - FRAME_TOOLBAR_HEIGHT (emacsframe));
4929 #else
4930       - FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
4931         - FRAME_TOOLBAR_HEIGHT (emacsframe));
4932 #endif
4933   if (rows < MINHEIGHT)
4934     rows = MINHEIGHT;
4935   frameSize.height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (emacsframe, rows)
4936                        + FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
4937                        + FRAME_TOOLBAR_HEIGHT (emacsframe);
4938 #ifdef NS_IMPL_COCOA
4939   {
4940     /* this sets window title to have size in it; the wm does this under GS */
4941     NSRect r = [[self window] frame];
4942     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
4943       {
4944         if (old_title != 0)
4945           {
4946             xfree (old_title);
4947             old_title = 0;
4948           }
4949       }
4950     else
4951       {
4952         char *size_title;
4953         NSWindow *window = [self window];
4954         if (old_title == 0)
4955           {
4956             const char *t = [[[self window] title] UTF8String];
4957             char *pos = strstr (t, "  â€”  ");
4958             if (pos)
4959               *pos = '\0';
4960             old_title = (char *) xmalloc (strlen (t) + 1);
4961             strcpy (old_title, t);
4962           }
4963         size_title = xmalloc (strlen (old_title) + 40);
4964         sprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
4965         [window setTitle: [NSString stringWithUTF8String: size_title]];
4966         [window display];
4967         xfree (size_title);
4968       }
4969   }
4970 #endif /* NS_IMPL_COCOA */
4971 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
4973   return frameSize;
4977 - (void)windowDidResize: (NSNotification *)notification
4979   NSWindow *theWindow = [notification object];
4981 #ifdef NS_IMPL_GNUSTEP
4982    /* in GNUstep, at least currently, it's possible to get a didResize
4983       without getting a willResize.. therefore we need to act as if we got
4984       the willResize now */
4985   NSSize sz = [theWindow frame].size;
4986   sz = [self windowWillResize: theWindow toSize: sz];
4987 #endif /* NS_IMPL_GNUSTEP */
4989   NSTRACE (windowDidResize);
4990 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
4992 #ifdef NS_IMPL_COCOA
4993   if (old_title != 0)
4994     {
4995       xfree (old_title);
4996       old_title = 0;
4997     }
4998 #endif /* NS_IMPL_COCOA */
5000   /* Avoid loop under GNUstep due to call at beginning of this function.
5001      (x_set_window_size causes a resize which causes
5002      a "windowDidResize" which calls x_set_window_size).  */
5003 #ifndef NS_IMPL_GNUSTEP
5004   if (cols > 0 && rows > 0)
5005      x_set_window_size (emacsframe, 0, cols, rows);
5006 #endif
5008   ns_send_appdefined (-1);
5012 - (void)windowDidBecomeKey: (NSNotification *)notification
5013 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5015   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5016   struct frame *old_focus = dpyinfo->x_focus_frame;
5018   NSTRACE (windowDidBecomeKey);
5020   if (emacsframe != old_focus)
5021     dpyinfo->x_focus_frame = emacsframe;
5023   ns_frame_rehighlight (emacsframe);
5025   if (emacs_event)
5026     {
5027       emacs_event->kind = FOCUS_IN_EVENT;
5028       EV_TRAILER ((id)nil);
5029     }
5033 - (void)windowDidResignKey: (NSNotification *)notification
5034 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5036   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5037   NSTRACE (windowDidResignKey);
5039   if (dpyinfo->x_focus_frame == emacsframe)
5040     dpyinfo->x_focus_frame = 0;
5042   ns_frame_rehighlight (emacsframe);
5044   /* FIXME: for some reason needed on second and subsequent clicks away
5045             from sole-frame Emacs to get hollow box to show */
5046   if (!windowClosing && [[self window] isVisible] == YES)
5047     {
5048       x_update_cursor (emacsframe, 1);
5049       x_set_frame_alpha (emacsframe);
5050     }
5052   if (emacs_event)
5053     {
5054       [self deleteWorkingText];
5055       emacs_event->kind = FOCUS_IN_EVENT;
5056       EV_TRAILER ((id)nil);
5057     }
5061 - (void)windowWillMiniaturize: sender
5063   NSTRACE (windowWillMiniaturize);
5067 - (BOOL)isFlipped
5069   return YES;
5073 - (BOOL)isOpaque
5075   return NO;
5079 - initFrameFromEmacs: (struct frame *)f
5081   NSRect r, wr;
5082   Lisp_Object tem;
5083   NSWindow *win;
5084   NSButton *toggleButton;
5085   int vbextra = NS_SCROLL_BAR_WIDTH (f);
5086   NSSize sz;
5087   NSColor *col;
5088   NSString *name;
5090   NSTRACE (initFrameFromEmacs);
5092   windowClosing = NO;
5093   processingCompose = NO;
5094   scrollbarsNeedingUpdate = 0;
5096 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
5098   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
5099                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
5100   [self initWithFrame: r];
5101   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
5103   FRAME_NS_VIEW (f) = self;
5104   emacsframe = f;
5105   old_title = 0;
5107   win = [[EmacsWindow alloc]
5108             initWithContentRect: r
5109                       styleMask: (NSResizableWindowMask |
5110                                   NSMiniaturizableWindowMask |
5111                                   NSClosableWindowMask)
5112                         backing: NSBackingStoreBuffered
5113                           defer: YES];
5115   wr = [win frame];
5116   f->border_width = wr.size.width - r.size.width;
5117   FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
5119   [win setAcceptsMouseMovedEvents: YES];
5120   [win setDelegate: self];
5121   [win useOptimizedDrawing: YES];
5123   sz.width = FRAME_COLUMN_WIDTH (f);
5124   sz.height = FRAME_LINE_HEIGHT (f);
5125   [win setResizeIncrements: sz];
5127   [[win contentView] addSubview: self];
5129   if (ns_drag_types)
5130     [self registerForDraggedTypes: ns_drag_types];
5132   tem = f->name;
5133   name = [NSString stringWithUTF8String:
5134                    NILP (tem) ? (unsigned char *)"Emacs" : SDATA (tem)];
5135   [win setTitle: name];
5137   /* toolbar support */
5138   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
5139                          [NSString stringWithFormat: @"Emacs Frame %d",
5140                                    ns_window_num]];
5141   [win setToolbar: toolbar];
5142   [toolbar setVisible: NO];
5143 #ifdef NS_IMPL_COCOA
5144   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
5145   [toggleButton setTarget: self];
5146   [toggleButton setAction: @selector (toggleToolbar: )];
5147 #endif
5148   FRAME_TOOLBAR_HEIGHT (f) = 0;
5150   tem = f->icon_name;
5151   if (!NILP (tem))
5152     [win setMiniwindowTitle:
5153            [NSString stringWithUTF8String: SDATA (tem)]];
5155   {
5156     NSScreen *screen = [win screen];
5158     if (screen != 0)
5159       [win setFrameTopLeftPoint: NSMakePoint
5160            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
5161             IN_BOUND (-SCREENMAX,
5162                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
5163   }
5165   [win makeFirstResponder: self];
5167   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
5168                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
5169   [win setBackgroundColor: col];
5170   if ([col alphaComponent] != 1.0)
5171     [win setOpaque: NO];
5173   [self allocateGState];
5175   ns_window_num++;
5176   return self;
5180 - (void)windowDidMove: sender
5182   NSWindow *win = [self window];
5183   NSRect r = [win frame];
5184   NSScreen *screen = [win screen];
5186   NSTRACE (windowDidMove);
5188   if (!emacsframe->output_data.ns)
5189     return;
5190   if (screen != nil)
5191     {
5192       emacsframe->left_pos = r.origin.x;
5193       emacsframe->top_pos =
5194         [screen frame].size.height - (r.origin.y + r.size.height);
5195     }
5199 /* Called AFTER method below, but before our windowWillResize call there leads
5200    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
5201    location so set_window_size moves the frame. */
5202 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
5204   NSTRACE (windowShouldZoom);
5205   emacsframe->left_pos = (int)newFrame.origin.x;
5206   emacsframe->top_pos = [[sender screen] frame].size.height
5207                             - (newFrame.origin.y+newFrame.size.height);
5208   return YES;
5212 /* Override to do something slightly nonstandard, but nice.  First click on
5213    zoom button will zoom vertically.  Second will zoom completely.  Third
5214    returns to original. */
5215 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
5216                         defaultFrame:(NSRect)defaultFrame
5218   NSRect result = [sender frame];
5219   static NSRect ns_userRect = { 0, 0, 0, 0 };
5221   NSTRACE (windowWillUseStandardFrame);
5223   if (abs (defaultFrame.size.height - result.size.height)
5224       > FRAME_LINE_HEIGHT (emacsframe))
5225     {
5226       /* first click */
5227       ns_userRect = result;
5228       result.size.height = defaultFrame.size.height;
5229       result.origin.y = defaultFrame.origin.y;
5230     }
5231   else
5232     {
5233       if (abs (defaultFrame.size.width - result.size.width)
5234           > FRAME_COLUMN_WIDTH (emacsframe))
5235         result = defaultFrame;  /* second click */
5236       else
5237         result = ns_userRect.size.height ? ns_userRect : result;  /* restore */
5238     }
5240   [self windowWillResize: sender toSize: result.size];
5241   return result;
5245 - (void)windowDidDeminiaturize: sender
5247   NSTRACE (windowDidDeminiaturize);
5248   if (!emacsframe->output_data.ns)
5249     return;
5250   emacsframe->async_iconified = 0;
5251   emacsframe->async_visible   = 1;
5252   windows_or_buffers_changed++;
5254   if (emacs_event)
5255     {
5256       emacs_event->kind = ICONIFY_EVENT;
5257       EV_TRAILER ((id)nil);
5258     }
5262 - (void)windowDidExpose: sender
5264   NSTRACE (windowDidExpose);
5265   if (!emacsframe->output_data.ns)
5266     return;
5267   emacsframe->async_visible = 1;
5268   SET_FRAME_GARBAGED (emacsframe);
5270   if (send_appdefined)
5271     ns_send_appdefined (-1);
5275 - (void)windowDidMiniaturize: sender
5277   NSTRACE (windowDidMiniaturize);
5278   if (!emacsframe->output_data.ns)
5279     return;
5281   emacsframe->async_iconified = 1;
5282   emacsframe->async_visible = 0;
5284   if (emacs_event)
5285     {
5286       emacs_event->kind = ICONIFY_EVENT;
5287       EV_TRAILER ((id)nil);
5288     }
5292 - (void)mouseEntered: (NSEvent *)theEvent
5294   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5295   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5296   NSTRACE (mouseEntered);
5298   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
5302 - (void)mouseExited: (NSEvent *)theEvent
5304   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5305   NSRect r;
5306   struct ns_display_info *dpyinfo
5307     = emacsframe ? FRAME_NS_DISPLAY_INFO (emacsframe) : NULL;
5309   NSTRACE (mouseExited);
5311   if (dpyinfo || !emacsframe)
5312     return;
5314   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
5316   if (emacsframe == dpyinfo->mouse_face_mouse_frame)
5317     {
5318       clear_mouse_face (dpyinfo);
5319       dpyinfo->mouse_face_mouse_frame = 0;
5320     }
5324 - menuDown: sender
5326   NSTRACE (menuDown);
5327   if (context_menu_value == -1)
5328     context_menu_value = [sender tag];
5329   else
5330     find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
5331                                   emacsframe->menu_bar_vector,
5332                                   (void *)[sender tag]);
5333   ns_send_appdefined (-1);
5334   return self;
5338 - (EmacsToolbar *)toolbar
5340   return toolbar;
5344 /* this gets called on toolbar button click */
5345 - toolbarClicked: (id)item
5347   NSEvent *theEvent;
5348   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
5350   NSTRACE (toolbarClicked);
5352   if (!emacs_event)
5353     return self;
5355   /* send first event (for some reason two needed) */
5356   theEvent = [[self window] currentEvent];
5357   emacs_event->kind = TOOL_BAR_EVENT;
5358   XSETFRAME (emacs_event->arg, emacsframe);
5359   EV_TRAILER (theEvent);
5361   emacs_event->kind = TOOL_BAR_EVENT;
5362 /*   XSETINT (emacs_event->code, 0); */
5363   emacs_event->arg = AREF (emacsframe->tool_bar_items,
5364                           idx + TOOL_BAR_ITEM_KEY);
5365   emacs_event->modifiers = EV_MODIFIERS (theEvent);
5366   EV_TRAILER (theEvent);
5367   return self;
5371 - toggleToolbar: (id)sender
5373   if (!emacs_event)
5374     return self;
5376   emacs_event->kind = NS_NONKEY_EVENT;
5377   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
5378   EV_TRAILER ((id)nil);
5379   return self;
5383 - (void)drawRect: (NSRect)rect
5385   int x = NSMinX (rect), y = NSMinY (rect);
5386   int width = NSWidth (rect), height = NSHeight (rect);
5388   NSTRACE (drawRect);
5390   if (!emacsframe || !emacsframe->output_data.ns || ns_in_resize)
5391     return;
5393   ns_clear_frame_area (emacsframe, x, y, width, height);
5394   expose_frame (emacsframe, x, y, width, height);
5396   /*
5397     drawRect: may be called (at least in OS X 10.5) for invisible
5398     views as well for some reason.  Thus, do not infer visibility 
5399     here.
5401     emacsframe->async_visible = 1;
5402     emacsframe->async_iconified = 0;
5403   */
5407 /* NSDraggingDestination protocol methods.  Actually this is not really a
5408    protocol, but a category of Object.  O well...  */
5410 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
5412   NSTRACE (draggingEntered);
5413   return NSDragOperationGeneric;
5417 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
5419   return YES;
5423 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
5425   id pb;
5426   int x, y;
5427   NSString *type;
5428   NSEvent *theEvent = [[self window] currentEvent];
5429   NSPoint position;
5431   NSTRACE (performDragOperation);
5433   if (!emacs_event)
5434     return;
5436   position = [self convertPoint: [sender draggingLocation] fromView: nil];
5437   x = lrint (position.x);  y = lrint (position.y);
5439   pb = [sender draggingPasteboard];
5440   type = [pb availableTypeFromArray: ns_drag_types];
5441   if (type == 0)
5442     {
5443       return NO;
5444     }
5445   else if ([type isEqualToString: NSFilenamesPboardType])
5446     {
5447       NSArray *files;
5448       NSEnumerator *fenum;
5449       NSString *file;
5451       if (!(files = [pb propertyListForType: type]))
5452         return NO;
5454       fenum = [files objectEnumerator];
5455       while ( (file = [fenum nextObject]) )
5456         {
5457           emacs_event->kind = NS_NONKEY_EVENT;
5458           emacs_event->code = KEY_NS_DRAG_FILE;
5459           XSETINT (emacs_event->x, x);
5460           XSETINT (emacs_event->y, y);
5461           ns_input_file = append2 (ns_input_file,
5462                                    build_string ([file UTF8String]));
5463           emacs_event->modifiers = EV_MODIFIERS (theEvent);
5464           EV_TRAILER (theEvent);
5465         }
5466       return YES;
5467     }
5468   else if ([type isEqualToString: NSURLPboardType])
5469     {
5470       NSString *file;
5471       NSURL *fileURL;
5473       if (!(fileURL = [NSURL URLFromPasteboard: pb]) ||
5474           [fileURL isFileURL] == NO)
5475         return NO;
5477       file = [fileURL path];
5478       emacs_event->kind = NS_NONKEY_EVENT;
5479       emacs_event->code = KEY_NS_DRAG_FILE;
5480       XSETINT (emacs_event->x, x);
5481       XSETINT (emacs_event->y, y);
5482       ns_input_file = append2 (ns_input_file, build_string ([file UTF8String]));
5483       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5484       EV_TRAILER (theEvent);
5485       return YES;
5486     }
5487   else if ([type isEqualToString: NSStringPboardType]
5488            || [type isEqualToString: NSTabularTextPboardType])
5489     {
5490       NSString *data;
5492       if (! (data = [pb stringForType: type]))
5493         return NO;
5495       emacs_event->kind = NS_NONKEY_EVENT;
5496       emacs_event->code = KEY_NS_DRAG_TEXT;
5497       XSETINT (emacs_event->x, x);
5498       XSETINT (emacs_event->y, y);
5499       ns_input_text = build_string ([data UTF8String]);
5500       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5501       EV_TRAILER (theEvent);
5502       return YES;
5503     }
5504   else if ([type isEqualToString: NSColorPboardType])
5505     {
5506       NSColor *c = [NSColor colorFromPasteboard: pb];
5507       emacs_event->kind = NS_NONKEY_EVENT;
5508       emacs_event->code = KEY_NS_DRAG_COLOR;
5509       XSETINT (emacs_event->x, x);
5510       XSETINT (emacs_event->y, y);
5511       ns_input_color = ns_color_to_lisp (c);
5512       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5513       EV_TRAILER (theEvent);
5514       return YES;
5515     }
5516   else if ([type isEqualToString: NSFontPboardType])
5517     {
5518       /* impl based on GNUstep NSTextView.m */
5519       NSData *data = [pb dataForType: NSFontPboardType];
5520       NSDictionary *dict = [NSUnarchiver unarchiveObjectWithData: data];
5521       NSFont *font = [dict objectForKey: NSFontAttributeName];
5522       char fontSize[10];
5524       if (font == nil)
5525         return NO;
5527       emacs_event->kind = NS_NONKEY_EVENT;
5528       emacs_event->code = KEY_NS_CHANGE_FONT;
5529       XSETINT (emacs_event->x, x);
5530       XSETINT (emacs_event->y, y);
5531       ns_input_font = build_string ([[font fontName] UTF8String]);
5532       snprintf (fontSize, 10, "%f", [font pointSize]);
5533       ns_input_fontsize = build_string (fontSize);
5534       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5535       EV_TRAILER (theEvent);
5536       return YES;
5537     }
5538   else
5539     {
5540       error ("Invalid data type in dragging pasteboard.");
5541       return NO;
5542     }
5546 - validRequestorForSendType: (NSString *)typeSent
5547                  returnType: (NSString *)typeReturned
5549   NSTRACE (validRequestorForSendType);
5550   if ([ns_send_types indexOfObjectIdenticalTo: typeSent] != NSNotFound &&
5551       [ns_return_types indexOfObjectIdenticalTo: typeSent] != NSNotFound)
5552     return self;
5554   return [super validRequestorForSendType: typeSent
5555                                returnType: typeReturned];
5559 /* The next two methods are part of NSServicesRequests informal protocol,
5560    supposedly called when a services menu item is chosen from this app.
5561    But this should not happen because we override the services menu with our
5562    own entries which call ns-perform-service.
5563    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
5564    So let's at least stub them out until further investigation can be done. */
5566 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
5568   /* we could call ns_string_from_pasteboard(pboard) here but then it should
5569      be written into the buffer in place of the existing selection..
5570      ordinary service calls go through functions defined in ns-win.el */
5571   return NO;
5574 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
5576   /* supposed to write for as many of types as we are able */
5577   return NO;
5581 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
5582    (gives a miniaturized version of the window); currently we use the latter for
5583    frames whose active buffer doesn't correspond to any file
5584    (e.g., '*scratch*') */
5585 - setMiniwindowImage: (BOOL) setMini
5587   id image = [[self window] miniwindowImage];
5588   NSTRACE (setMiniwindowImage);
5590   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
5591      about "AppleDockIconEnabled" notwithstanding, however the set message
5592      below has its effect nonetheless. */
5593   if (image != emacsframe->output_data.ns->miniimage)
5594     {
5595       if (image && [image isKindOfClass: [EmacsImage class]])
5596         [image release];
5597       [[self window] setMiniwindowImage:
5598                        setMini ? emacsframe->output_data.ns->miniimage : nil];
5599     }
5601   return self;
5605 - (void) setRows: (int) r andColumns: (int) c
5607   rows = r;
5608   cols = c;
5611 @end  /* EmacsView */
5615 /* ==========================================================================
5617     EmacsWindow implementation
5619    ========================================================================== */
5621 @implementation EmacsWindow
5623 /* called only on resize clicks by special case in EmacsApp-sendEvent */
5624 - (void)mouseDown: (NSEvent *)theEvent
5626   if (ns_in_resize)
5627     {
5628       NSSize size = [[theEvent window] frame].size;
5629       grabOffset = [theEvent locationInWindow];
5630       grabOffset.x = size.width - grabOffset.x;
5631     }
5632   else
5633     [super mouseDown: theEvent];
5637 /* stop resizing */
5638 - (void)mouseUp: (NSEvent *)theEvent
5640   if (ns_in_resize)
5641     {
5642       struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
5643       ns_in_resize = NO;
5644       ns_set_name_as_filename (f);
5645       [self display];
5646       ns_send_appdefined (-1);
5647     }
5648   else
5649     [super mouseUp: theEvent];
5653 /* send resize events */
5654 - (void)mouseDragged: (NSEvent *)theEvent
5656   if (ns_in_resize)
5657     {
5658       NSPoint p = [theEvent locationInWindow];
5659       NSSize size, vettedSize, origSize = [self frame].size;
5661       size.width = p.x + grabOffset.x;
5662       size.height = origSize.height - p.y + grabOffset.y;
5664       if (size.width == origSize.width && size.height == origSize.height)
5665         return;
5667       vettedSize = [[self delegate] windowWillResize: self toSize: size];
5668       if (vettedSize.width != size.width || vettedSize.height != size.height)
5669         {
5670           [[NSNotificationCenter defaultCenter]
5671             postNotificationName: NSWindowDidResizeNotification
5672                           object: self];
5673         }
5674     }
5675   else
5676     [super mouseDragged: theEvent];
5679 @end /* EmacsWindow */
5682 /* ==========================================================================
5684     EmacsScroller implementation
5686    ========================================================================== */
5689 @implementation EmacsScroller
5691 /* for repeat button push */
5692 #define SCROLL_BAR_FIRST_DELAY 0.5
5693 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
5695 + (CGFloat) scrollerWidth
5697   /* TODO: if we want to allow variable widths, this is the place to do it,
5698            however neither GNUstep nor Cocoa support it very well */
5699   return [NSScroller scrollerWidth];
5703 - initFrame: (NSRect )r window: (Lisp_Object)nwin
5705   NSTRACE (EmacsScroller_initFrame);
5707   r.size.width = [EmacsScroller scrollerWidth];
5708   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
5709   [self setContinuous: YES];
5710   [self setEnabled: YES];
5712   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
5713      locked against the top and bottom edges, and right edge on OS X, where
5714      scrollers are on right. */
5715 #ifdef NS_IMPL_GNUSTEP
5716   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
5717 #else
5718   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
5719 #endif
5721   win = nwin;
5722   condemned = NO;
5723   pixel_height = NSHeight (r);
5724   if (pixel_height == 0) pixel_height = 1;
5725   min_portion = 20 / pixel_height;
5727   frame = XFRAME (XWINDOW (win)->frame);
5728   if (FRAME_LIVE_P (frame))
5729     {
5730       int i;
5731       EmacsView *view = FRAME_NS_VIEW (frame);
5732       NSView *sview = [[view window] contentView];
5733       NSArray *subs = [sview subviews];
5735       /* disable optimization stopping redraw of other scrollbars */
5736       view->scrollbarsNeedingUpdate = 0;
5737       for (i =[subs count]-1; i >= 0; i--)
5738         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
5739           view->scrollbarsNeedingUpdate++;
5740       [sview addSubview: self];
5741     }
5743 /*  [self setFrame: r]; */
5745   return self;
5749 - (void)setFrame: (NSRect)newRect
5751   NSTRACE (EmacsScroller_setFrame);
5752 /*  BLOCK_INPUT; */
5753   pixel_height = NSHeight (newRect);
5754   if (pixel_height == 0) pixel_height = 1;
5755   min_portion = 20 / pixel_height;
5756   [super setFrame: newRect];
5757   [self display];
5758 /*  UNBLOCK_INPUT; */
5762 - (void)dealloc
5764   NSTRACE (EmacsScroller_dealloc);
5765   if (!NILP (win))
5766     XWINDOW (win)->vertical_scroll_bar = Qnil;
5767   [super dealloc];
5771 - condemn
5773   NSTRACE (condemn);
5774   condemned =YES;
5775   return self;
5779 - reprieve
5781   NSTRACE (reprieve);
5782   condemned =NO;
5783   return self;
5787 - judge
5789   NSTRACE (judge);
5790   if (condemned)
5791     {
5792       BLOCK_INPUT;
5793       /* ensure other scrollbar updates after deletion */
5794       EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
5795       if (view != nil)
5796         view->scrollbarsNeedingUpdate++;
5797       [self removeFromSuperview];
5798       [self release];
5799       UNBLOCK_INPUT;
5800     }
5801   return self;
5805 - (void)resetCursorRects
5807   NSRect visible = [self visibleRect];
5808   NSTRACE (resetCursorRects);
5810   if (!NSIsEmptyRect (visible))
5811     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
5812   [[NSCursor arrowCursor] setOnMouseEntered: YES];
5816 - (int) checkSamePosition: (int) position portion: (int) portion
5817                     whole: (int) whole
5819   return em_position ==position && em_portion ==portion && em_whole ==whole
5820     && portion != whole; /* needed for resize empty buf */
5824 - setPosition: (int)position portion: (int)portion whole: (int)whole
5826   NSTRACE (setPosition);
5828   em_position = position;
5829   em_portion = portion;
5830   em_whole = whole;
5832   if (portion >= whole)
5833     [self setFloatValue: 0.0 knobProportion: 1.0];
5834   else
5835     {
5836       float pos, por;
5837       portion = max ((float)whole*min_portion/pixel_height, portion);
5838       pos = (float)position / (whole - portion);
5839       por = (float)portion/whole;
5840       [self setFloatValue: pos knobProportion: por];
5841     }
5842   return self;
5845 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
5846      drag events will go directly to the EmacsScroller.  Leaving in for now. */
5847 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
5848                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
5850   *part = last_hit_part;
5851   *window = win;
5852   XSETINT (*y, pixel_height);
5853   if ([self floatValue] > 0.999)
5854     XSETINT (*x, pixel_height);
5855   else
5856     XSETINT (*x, pixel_height * [self floatValue]);
5860 /* set up emacs_event */
5861 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
5863   if (!emacs_event)
5864     return;
5866   emacs_event->part = last_hit_part;
5867   emacs_event->code = 0;
5868   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
5869   emacs_event->frame_or_window = win;
5870   emacs_event->timestamp = EV_TIMESTAMP (e);
5871   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5872   emacs_event->arg = Qnil;
5873   XSETINT (emacs_event->x, loc * pixel_height);
5874   XSETINT (emacs_event->y, pixel_height-20);
5876   n_emacs_events_pending++;
5877   kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
5878   EVENT_INIT (*emacs_event);
5879   ns_send_appdefined (-1);
5883 /* called manually thru timer to implement repeated button action w/hold-down */
5884 - repeatScroll: (NSTimer *)scrollEntry
5886   NSEvent *e = [[self window] currentEvent];
5887   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
5888   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
5890   /* clear timer if need be */
5891   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
5892     {
5893         [scroll_repeat_entry invalidate];
5894         [scroll_repeat_entry release];
5895         scroll_repeat_entry = nil;
5897         if (inKnob)
5898           return self;
5900         scroll_repeat_entry
5901           = [[NSTimer scheduledTimerWithTimeInterval:
5902                         SCROLL_BAR_CONTINUOUS_DELAY
5903                                             target: self
5904                                           selector: @selector (repeatScroll:)
5905                                           userInfo: 0
5906                                            repeats: YES]
5907               retain];
5908     }
5910   [self sendScrollEventAtLoc: 0 fromEvent: e];
5911   return self;
5915 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
5916    mouseDragged events without going into a modal loop. */
5917 - (void)mouseDown: (NSEvent *)e
5919   NSRect sr, kr;
5920   /* hitPart is only updated AFTER event is passed on */
5921   NSScrollerPart part = [self testPart: [e locationInWindow]];
5922   double inc = 0.0, loc, kloc, pos;
5923   int edge = 0;
5925   NSTRACE (EmacsScroller_mouseDown);
5927   switch (part)
5928     {
5929     case NSScrollerDecrementPage:
5930         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
5931     case NSScrollerIncrementPage:
5932         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
5933     case NSScrollerDecrementLine:
5934       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
5935     case NSScrollerIncrementLine:
5936       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
5937     case NSScrollerKnob:
5938       last_hit_part = scroll_bar_handle; break;
5939     case NSScrollerKnobSlot:  /* GNUstep-only */
5940       last_hit_part = scroll_bar_move_ratio; break;
5941     default:  /* NSScrollerNoPart? */
5942       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
5943                (long) part);
5944       return;
5945     }
5947   if (inc != 0.0)
5948     {
5949       pos = 0;      /* ignored */
5951       /* set a timer to repeat, as we can't let superclass do this modally */
5952       scroll_repeat_entry
5953         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
5954                                             target: self
5955                                           selector: @selector (repeatScroll:)
5956                                           userInfo: 0
5957                                            repeats: YES]
5958             retain];
5959     }
5960   else
5961     {
5962       /* handle, or on GNUstep possibly slot */
5963       NSEvent *fake_event;
5965       /* compute float loc in slot and mouse offset on knob */
5966       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
5967                       toView: nil];
5968       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
5969       if (loc <= 0.0)
5970         {
5971           loc = 0.0;
5972           edge = -1;
5973         }
5974       else if (loc >= NSHeight (sr))
5975         {
5976           loc = NSHeight (sr);
5977           edge = 1;
5978         }
5980       if (edge)
5981         kloc = 0.5 * edge;
5982       else
5983         {
5984           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
5985                           toView: nil];
5986           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
5987         }
5988       last_mouse_offset = kloc;
5990       /* if knob, tell emacs a location offset by knob pos
5991          (to indicate top of handle) */
5992       if (part == NSScrollerKnob)
5993           pos = (loc - last_mouse_offset) / NSHeight (sr);
5994       else
5995         /* else this is a slot click on GNUstep: go straight there */
5996         pos = loc / NSHeight (sr);
5998       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
5999       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
6000                                       location: [e locationInWindow]
6001                                  modifierFlags: [e modifierFlags]
6002                                      timestamp: [e timestamp]
6003                                   windowNumber: [e windowNumber]
6004                                        context: [e context]
6005                                    eventNumber: [e eventNumber]
6006                                     clickCount: [e clickCount]
6007                                       pressure: [e pressure]];
6008       [super mouseUp: fake_event];
6009     }
6011   if (part != NSScrollerKnob)
6012     [self sendScrollEventAtLoc: pos fromEvent: e];
6016 /* Called as we manually track scroller drags, rather than superclass. */
6017 - (void)mouseDragged: (NSEvent *)e
6019     NSRect sr;
6020     double loc, pos;
6021     int edge = 0;
6023     NSTRACE (EmacsScroller_mouseDragged);
6025       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
6026                       toView: nil];
6027       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
6029       if (loc <= 0.0)
6030         {
6031           loc = 0.0;
6032           edge = -1;
6033         }
6034       else if (loc >= NSHeight (sr) + last_mouse_offset)
6035         {
6036           loc = NSHeight (sr) + last_mouse_offset;
6037           edge = 1;
6038         }
6040       pos = /*(edge ? loc :*/ (loc - last_mouse_offset) / NSHeight (sr);
6041       [self sendScrollEventAtLoc: pos fromEvent: e];
6045 - (void)mouseUp: (NSEvent *)e
6047   if (scroll_repeat_entry)
6048     {
6049       [scroll_repeat_entry invalidate];
6050       [scroll_repeat_entry release];
6051       scroll_repeat_entry = nil;
6052     }
6053   last_hit_part = 0;
6057 /* treat scrollwheel events in the bar as though they were in the main window */
6058 - (void) scrollWheel: (NSEvent *)theEvent
6060   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
6061   [view mouseDown: theEvent];
6064 @end  /* EmacsScroller */
6069 /* ==========================================================================
6071    Font-related functions; these used to be in nsfaces.m
6073    ========================================================================== */
6076 Lisp_Object
6077 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
6079   struct font *font = XFONT_OBJECT (font_object);
6081   if (fontset < 0)
6082     fontset = fontset_from_font (font_object);
6083   FRAME_FONTSET (f) = fontset;
6085   if (FRAME_FONT (f) == font)
6086     /* This font is already set in frame F.  There's nothing more to
6087        do.  */
6088     return font_object;
6090   FRAME_FONT (f) = font;
6092   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
6093   FRAME_COLUMN_WIDTH (f) = font->average_width;
6094   FRAME_SPACE_WIDTH (f) = font->space_width;
6095   FRAME_LINE_HEIGHT (f) = font->height;
6097   compute_fringe_widths (f, 1);
6099   /* Compute the scroll bar width in character columns.  */
6100   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
6101     {
6102       int wid = FRAME_COLUMN_WIDTH (f);
6103       FRAME_CONFIG_SCROLL_BAR_COLS (f)
6104         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
6105     }
6106   else
6107     {
6108       int wid = FRAME_COLUMN_WIDTH (f);
6109       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
6110     }
6112   /* Now make the frame display the given font.  */
6113   if (FRAME_NS_WINDOW (f) != 0)
6114         x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
6116   return font_object;
6120 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
6121 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
6122          in 1.43. */
6124 const char *
6125 ns_xlfd_to_fontname (const char *xlfd)
6126 /* --------------------------------------------------------------------------
6127     Convert an X font name (XLFD) to an NS font name.
6128     Only family is used.
6129     The string returned is temporarily allocated.
6130    -------------------------------------------------------------------------- */
6132   char *name = xmalloc (180);
6133   int i, len;
6134   const char *ret;
6136   if (!strncmp (xlfd, "--", 2))
6137     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
6138   else
6139     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
6141   /* stopgap for malformed XLFD input */
6142   if (strlen (name) == 0)
6143     strcpy (name, "Monaco");
6145   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
6146      also uppercase after '-' or ' ' */
6147   name[0] = toupper (name[0]);
6148   for (len =strlen (name), i =0; i<len; i++)
6149     {
6150       if (name[i] == '$')
6151         {
6152           name[i] = '-';
6153           if (i+1<len)
6154             name[i+1] = toupper (name[i+1]);
6155         }
6156       else if (name[i] == '_')
6157         {
6158           name[i] = ' ';
6159           if (i+1<len)
6160             name[i+1] = toupper (name[i+1]);
6161         }
6162     }
6163 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
6164   ret = [[NSString stringWithUTF8String: name] UTF8String];
6165   xfree (name);
6166   return ret;
6170 void
6171 syms_of_nsterm ()
6173   NSTRACE (syms_of_nsterm);
6175   ns_antialias_threshold = 10.0;
6177   /* from 23+ we need to tell emacs what modifiers there are.. */
6178   DEFSYM (Qmodifier_value, "modifier-value");
6179   DEFSYM (Qalt, "alt");
6180   DEFSYM (Qhyper, "hyper");
6181   DEFSYM (Qmeta, "meta");
6182   DEFSYM (Qsuper, "super");
6183   DEFSYM (Qcontrol, "control");
6184   DEFSYM (Qnone, "none");
6185   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
6186   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
6187   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
6188   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
6189   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
6191   DEFVAR_LISP ("ns-input-file", &ns_input_file,
6192               "The file specified in the last NS event.");
6193   ns_input_file =Qnil;
6195   DEFVAR_LISP ("ns-input-text", &ns_input_text,
6196               "The data received in the last NS text drag event.");
6197   ns_input_text =Qnil;
6199   DEFVAR_LISP ("ns-working-text", &ns_working_text,
6200               "String for visualizing working composition sequence.");
6201   ns_working_text =Qnil;
6203   DEFVAR_LISP ("ns-input-font", &ns_input_font,
6204               "The font specified in the last NS event.");
6205   ns_input_font =Qnil;
6207   DEFVAR_LISP ("ns-input-fontsize", &ns_input_fontsize,
6208               "The fontsize specified in the last NS event.");
6209   ns_input_fontsize =Qnil;
6211   DEFVAR_LISP ("ns-input-line", &ns_input_line,
6212                "The line specified in the last NS event.");
6213   ns_input_line =Qnil;
6215   DEFVAR_LISP ("ns-input-color", &ns_input_color,
6216                "The color specified in the last NS event.");
6217   ns_input_color =Qnil;
6219   DEFVAR_LISP ("ns-input-spi-name", &ns_input_spi_name,
6220                "The service name specified in the last NS event.");
6221   ns_input_spi_name =Qnil;
6223   DEFVAR_LISP ("ns-input-spi-arg", &ns_input_spi_arg,
6224                "The service argument specified in the last NS event.");
6225   ns_input_spi_arg =Qnil;
6227   DEFVAR_LISP ("ns-alternate-modifier", &ns_alternate_modifier,
6228                "This variable describes the behavior of the alternate or option key.\n\
6229 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6230 Set to none means that the alternate / option key is not interpreted by Emacs\n\
6231 at all, allowing it to be used at a lower level for accented character entry.");
6232   ns_alternate_modifier = Qmeta;
6234   DEFVAR_LISP ("ns-right-alternate-modifier", &ns_right_alternate_modifier,
6235                "This variable describes the behavior of the right alternate or option key.\n\
6236 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6237 Set to left means be the same key as `ns-alternate-modifier'.\n\
6238 Set to none means that the alternate / option key is not interpreted by Emacs\n\
6239 at all, allowing it to be used at a lower level for accented character entry.");
6240   ns_right_alternate_modifier = Qleft;
6242   DEFVAR_LISP ("ns-command-modifier", &ns_command_modifier,
6243                "This variable describes the behavior of the command key.\n\
6244 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
6245   ns_command_modifier = Qsuper;
6247   DEFVAR_LISP ("ns-control-modifier", &ns_control_modifier,
6248                "This variable describes the behavior of the control key.\n\
6249 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
6250   ns_control_modifier = Qcontrol;
6252   DEFVAR_LISP ("ns-function-modifier", &ns_function_modifier,
6253                "This variable describes the behavior of the function key (on laptops).\n\
6254 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6255 Set to none means that the function key is not interpreted by Emacs at all,\n\
6256 allowing it to be used at a lower level for accented character entry.");
6257   ns_function_modifier = Qnone;
6259   DEFVAR_LISP ("ns-antialias-text", &ns_antialias_text,
6260                "Non-nil (the default) means to render text antialiased. Only has an effect on OS X Panther and above.");
6261   ns_antialias_text = Qt;
6263   DEFVAR_LISP ("ns-confirm-quit", &ns_confirm_quit,
6264                "Whether to confirm application quit using dialog.");
6265   ns_confirm_quit = Qnil;
6267   staticpro (&ns_display_name_list);
6268   ns_display_name_list = Qnil;
6270   staticpro (&last_mouse_motion_frame);
6271   last_mouse_motion_frame = Qnil;
6273   /* TODO: move to common code */
6274   DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
6275                doc: /* If not nil, Emacs uses toolkit scroll bars.  */);
6276 #ifdef USE_TOOLKIT_SCROLL_BARS
6277   Vx_toolkit_scroll_bars = Qt;
6278 #else
6279   Vx_toolkit_scroll_bars = Qnil;
6280 #endif
6282   /* these are unsupported but we need the declarations to avoid whining
6283      messages from cus-start.el */
6284   DEFVAR_BOOL ("x-use-underline-position-properties",
6285                &x_use_underline_position_properties,
6286      doc: /* NOT SUPPORTED UNDER NS.
6287 *Non-nil means make use of UNDERLINE_POSITION font properties.
6288 A value of nil means ignore them.  If you encounter fonts with bogus
6289 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
6290 to 4.1, set this to nil.
6292 NOTE: Not supported on Mac yet.  */);
6293   x_use_underline_position_properties = 0;
6295   DEFVAR_BOOL ("x-underline-at-descent-line",
6296                &x_underline_at_descent_line,
6297      doc: /* NOT SUPPORTED UNDER NS.
6298 *Non-nil means to draw the underline at the same place as the descent line.
6299 A value of nil means to draw the underline according to the value of the
6300 variable `x-use-underline-position-properties', which is usually at the
6301 baseline level.  The default value is nil.  */);
6302   x_underline_at_descent_line = 0;
6304   /* Tell emacs about this window system. */
6305   Fprovide (intern ("ns"), Qnil);
6309 // arch-tag: 6eaa8f7d-a69b-4e1c-b43d-ab31defbe0d2