Drop support for deprecated (since 23.1) forms of diary-display-function
[emacs.git] / src / nsterm.m
blobb0a2994bcf57a6fb2d87bce0e0a12749daad242c
1 /* NeXT/Open/GNUstep / MacOSX communication module.
3 Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2014 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
22 Originally by Carl Edman
23 Updated by Christian Limpach (chris@nice.ch)
24 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
25 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
26 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
29 /* This should be the first include, as it may set up #defines affecting
30    interpretation of even the system includes. */
31 #include <config.h>
33 #include <fcntl.h>
34 #include <math.h>
35 #include <pthread.h>
36 #include <sys/types.h>
37 #include <time.h>
38 #include <signal.h>
39 #include <unistd.h>
41 #include <c-ctype.h>
42 #include <c-strcase.h>
43 #include <ftoastr.h>
45 #include "lisp.h"
46 #include "blockinput.h"
47 #include "sysselect.h"
48 #include "nsterm.h"
49 #include "systime.h"
50 #include "character.h"
51 #include "fontset.h"
52 #include "composite.h"
53 #include "ccl.h"
55 #include "termhooks.h"
56 #include "termchar.h"
57 #include "menu.h"
58 #include "window.h"
59 #include "keyboard.h"
60 #include "buffer.h"
61 #include "font.h"
63 #ifdef NS_IMPL_GNUSTEP
64 #include "process.h"
65 #endif
67 #ifdef NS_IMPL_COCOA
68 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
69 #include "macfont.h"
70 #endif
71 #endif
73 /* call tracing */
74 #if 0
75 int term_trace_num = 0;
76 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
77                                 __FILE__, __LINE__, ++term_trace_num)
78 #else
79 #define NSTRACE(x)
80 #endif
82 /* Detailed tracing. "S" means "size" and "LL" stands for "lower left". */
83 #if 0
84 int term_trace_num = 0;
85 #define NSTRACE_SIZE(str,size) fprintf (stderr,                         \
86                                    "%s:%d: [%d]   " str                 \
87                                    " (S:%.0f x %.0f)\n", \
88                                    __FILE__, __LINE__, ++term_trace_num,\
89                                    size.height,                       \
90                                    size.width)
91 #define NSTRACE_RECT(s,r) fprintf (stderr,                              \
92                                    "%s:%d: [%d]   " s                   \
93                                    " (LL:%.0f x %.0f -> S:%.0f x %.0f)\n", \
94                                    __FILE__, __LINE__, ++term_trace_num,\
95                                    r.origin.x,                          \
96                                    r.origin.y,                          \
97                                    r.size.height,                       \
98                                    r.size.width)
99 #else
100 #define NSTRACE_SIZE(str,size)
101 #define NSTRACE_RECT(s,r)
102 #endif
104 extern NSString *NSMenuDidBeginTrackingNotification;
106 /* ==========================================================================
108    NSColor, EmacsColor category.
110    ========================================================================== */
111 @implementation NSColor (EmacsColor)
112 + (NSColor *)colorForEmacsRed:(CGFloat)red green:(CGFloat)green
113                          blue:(CGFloat)blue alpha:(CGFloat)alpha
115 #ifdef NS_IMPL_COCOA
116 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
117   if (ns_use_srgb_colorspace)
118       return [NSColor colorWithSRGBRed: red
119                                  green: green
120                                   blue: blue
121                                  alpha: alpha];
122 #endif
123 #endif
124   return [NSColor colorWithCalibratedRed: red
125                                    green: green
126                                     blue: blue
127                                    alpha: alpha];
130 - (NSColor *)colorUsingDefaultColorSpace
132 #ifdef NS_IMPL_COCOA
133 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
134   if (ns_use_srgb_colorspace)
135     return [self colorUsingColorSpace: [NSColorSpace sRGBColorSpace]];
136 #endif
137 #endif
138   return [self colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
141 @end
143 /* ==========================================================================
145     Local declarations
147    ========================================================================== */
149 /* Convert a symbol indexed with an NSxxx value to a value as defined
150    in keyboard.c (lispy_function_key). I hope this is a correct way
151    of doing things... */
152 static unsigned convert_ns_to_X_keysym[] =
154   NSHomeFunctionKey,            0x50,
155   NSLeftArrowFunctionKey,       0x51,
156   NSUpArrowFunctionKey,         0x52,
157   NSRightArrowFunctionKey,      0x53,
158   NSDownArrowFunctionKey,       0x54,
159   NSPageUpFunctionKey,          0x55,
160   NSPageDownFunctionKey,        0x56,
161   NSEndFunctionKey,             0x57,
162   NSBeginFunctionKey,           0x58,
163   NSSelectFunctionKey,          0x60,
164   NSPrintFunctionKey,           0x61,
165   NSClearLineFunctionKey,       0x0B,
166   NSExecuteFunctionKey,         0x62,
167   NSInsertFunctionKey,          0x63,
168   NSUndoFunctionKey,            0x65,
169   NSRedoFunctionKey,            0x66,
170   NSMenuFunctionKey,            0x67,
171   NSFindFunctionKey,            0x68,
172   NSHelpFunctionKey,            0x6A,
173   NSBreakFunctionKey,           0x6B,
175   NSF1FunctionKey,              0xBE,
176   NSF2FunctionKey,              0xBF,
177   NSF3FunctionKey,              0xC0,
178   NSF4FunctionKey,              0xC1,
179   NSF5FunctionKey,              0xC2,
180   NSF6FunctionKey,              0xC3,
181   NSF7FunctionKey,              0xC4,
182   NSF8FunctionKey,              0xC5,
183   NSF9FunctionKey,              0xC6,
184   NSF10FunctionKey,             0xC7,
185   NSF11FunctionKey,             0xC8,
186   NSF12FunctionKey,             0xC9,
187   NSF13FunctionKey,             0xCA,
188   NSF14FunctionKey,             0xCB,
189   NSF15FunctionKey,             0xCC,
190   NSF16FunctionKey,             0xCD,
191   NSF17FunctionKey,             0xCE,
192   NSF18FunctionKey,             0xCF,
193   NSF19FunctionKey,             0xD0,
194   NSF20FunctionKey,             0xD1,
195   NSF21FunctionKey,             0xD2,
196   NSF22FunctionKey,             0xD3,
197   NSF23FunctionKey,             0xD4,
198   NSF24FunctionKey,             0xD5,
200   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
201   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
202   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
204   NSTabCharacter,               0x09,
205   0x19,                         0x09,  /* left tab->regular since pass shift */
206   NSCarriageReturnCharacter,    0x0D,
207   NSNewlineCharacter,           0x0D,
208   NSEnterCharacter,             0x8D,
210   0x41|NSNumericPadKeyMask,     0xAE,  /* KP_Decimal */
211   0x43|NSNumericPadKeyMask,     0xAA,  /* KP_Multiply */
212   0x45|NSNumericPadKeyMask,     0xAB,  /* KP_Add */
213   0x4B|NSNumericPadKeyMask,     0xAF,  /* KP_Divide */
214   0x4E|NSNumericPadKeyMask,     0xAD,  /* KP_Subtract */
215   0x51|NSNumericPadKeyMask,     0xBD,  /* KP_Equal */
216   0x52|NSNumericPadKeyMask,     0xB0,  /* KP_0 */
217   0x53|NSNumericPadKeyMask,     0xB1,  /* KP_1 */
218   0x54|NSNumericPadKeyMask,     0xB2,  /* KP_2 */
219   0x55|NSNumericPadKeyMask,     0xB3,  /* KP_3 */
220   0x56|NSNumericPadKeyMask,     0xB4,  /* KP_4 */
221   0x57|NSNumericPadKeyMask,     0xB5,  /* KP_5 */
222   0x58|NSNumericPadKeyMask,     0xB6,  /* KP_6 */
223   0x59|NSNumericPadKeyMask,     0xB7,  /* KP_7 */
224   0x5B|NSNumericPadKeyMask,     0xB8,  /* KP_8 */
225   0x5C|NSNumericPadKeyMask,     0xB9,  /* KP_9 */
227   0x1B,                         0x1B   /* escape */
230 static Lisp_Object Qmodifier_value;
231 Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper;
232 extern Lisp_Object Qcursor_color, Qcursor_type, Qns;
234 static Lisp_Object QUTF8_STRING;
235 static Lisp_Object Qcocoa, Qgnustep;
236 static Lisp_Object Qfile, Qurl;
238 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
239    the maximum font size to NOT antialias.  On GNUstep there is currently
240    no way to control this behavior. */
241 float ns_antialias_threshold;
243 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
244 NSString *ns_app_name = @"Emacs";  /* default changed later */
246 /* Display variables */
247 struct ns_display_info *x_display_list; /* Chain of existing displays */
248 long context_menu_value = 0;
250 /* display update */
251 static struct frame *ns_updating_frame;
252 static NSView *focus_view = NULL;
253 static int ns_window_num = 0;
254 #ifdef NS_IMPL_GNUSTEP
255 static NSRect uRect;
256 #endif
257 static BOOL gsaved = NO;
258 static BOOL ns_fake_keydown = NO;
259 #ifdef NS_IMPL_COCOA
260 static BOOL ns_menu_bar_is_hidden = NO;
261 #endif
262 /*static int debug_lock = 0; */
264 /* event loop */
265 static BOOL send_appdefined = YES;
266 #define NO_APPDEFINED_DATA (-8)
267 static int last_appdefined_event_data = NO_APPDEFINED_DATA;
268 static NSTimer *timed_entry = 0;
269 static NSTimer *scroll_repeat_entry = nil;
270 static fd_set select_readfds, select_writefds;
271 enum { SELECT_HAVE_READ = 1, SELECT_HAVE_WRITE = 2, SELECT_HAVE_TMO = 4 };
272 static int select_nfds = 0, select_valid = 0;
273 static struct timespec select_timeout = { 0, 0 };
274 static int selfds[2] = { -1, -1 };
275 static pthread_mutex_t select_mutex;
276 static int apploopnr = 0;
277 static NSAutoreleasePool *outerpool;
278 static struct input_event *emacs_event = NULL;
279 static struct input_event *q_event_ptr = NULL;
280 static int n_emacs_events_pending = 0;
281 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
282   *ns_pending_service_args;
283 static BOOL ns_do_open_file = NO;
284 static BOOL ns_last_use_native_fullscreen;
286 /* Non-zero means that a HELP_EVENT has been generated since Emacs
287    start.  */
289 static BOOL any_help_event_p = NO;
291 static struct {
292   struct input_event *q;
293   int nr, cap;
294 } hold_event_q = {
295   NULL, 0, 0
298 #ifdef NS_IMPL_COCOA
300  * State for pending menu activation:
301  * MENU_NONE     Normal state
302  * MENU_PENDING  A menu has been clicked on, but has been canceled so we can
303  *               run lisp to update the menu.
304  * MENU_OPENING  Menu is up to date, and the click event is redone so the menu
305  *               will open.
306  */
307 #define MENU_NONE 0
308 #define MENU_PENDING 1
309 #define MENU_OPENING 2
310 static int menu_will_open_state = MENU_NONE;
312 /* Saved position for menu click.  */
313 static CGPoint menu_mouse_point;
314 #endif
316 /* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
317 #define NS_FUNCTION_KEY_MASK 0x800000
318 #define NSLeftControlKeyMask    (0x000001 | NSControlKeyMask)
319 #define NSRightControlKeyMask   (0x002000 | NSControlKeyMask)
320 #define NSLeftCommandKeyMask    (0x000008 | NSCommandKeyMask)
321 #define NSRightCommandKeyMask   (0x000010 | NSCommandKeyMask)
322 #define NSLeftAlternateKeyMask  (0x000020 | NSAlternateKeyMask)
323 #define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
324 #define EV_MODIFIERS2(flags)                          \
325     (((flags & NSHelpKeyMask) ?           \
326            hyper_modifier : 0)                        \
327      | (!EQ (ns_right_alternate_modifier, Qleft) && \
328         ((flags & NSRightAlternateKeyMask) \
329          == NSRightAlternateKeyMask) ? \
330            parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
331      | ((flags & NSAlternateKeyMask) ?                 \
332            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
333      | ((flags & NSShiftKeyMask) ?     \
334            shift_modifier : 0)                        \
335      | (!EQ (ns_right_control_modifier, Qleft) && \
336         ((flags & NSRightControlKeyMask) \
337          == NSRightControlKeyMask) ? \
338            parse_solitary_modifier (ns_right_control_modifier) : 0) \
339      | ((flags & NSControlKeyMask) ?      \
340            parse_solitary_modifier (ns_control_modifier) : 0)     \
341      | ((flags & NS_FUNCTION_KEY_MASK) ?  \
342            parse_solitary_modifier (ns_function_modifier) : 0)    \
343      | (!EQ (ns_right_command_modifier, Qleft) && \
344         ((flags & NSRightCommandKeyMask) \
345          == NSRightCommandKeyMask) ? \
346            parse_solitary_modifier (ns_right_command_modifier) : 0) \
347      | ((flags & NSCommandKeyMask) ?      \
348            parse_solitary_modifier (ns_command_modifier):0))
349 #define EV_MODIFIERS(e) EV_MODIFIERS2 ([e modifierFlags])
351 #define EV_UDMODIFIERS(e)                                      \
352     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
353      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
354      | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
355      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
356      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
357      | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
358      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
359      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
360      | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
362 #define EV_BUTTON(e)                                                         \
363     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
364       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
365      [e buttonNumber] - 1)
367 /* Convert the time field to a timestamp in milliseconds. */
368 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
370 /* This is a piece of code which is common to all the event handling
371    methods.  Maybe it should even be a function.  */
372 #define EV_TRAILER(e)                                                   \
373   {                                                                     \
374     XSETFRAME (emacs_event->frame_or_window, emacsframe);               \
375     EV_TRAILER2 (e);                                                    \
376   }
378 #define EV_TRAILER2(e)                                                  \
379   {                                                                     \
380       if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
381       if (q_event_ptr)                                                  \
382         {                                                               \
383           n_emacs_events_pending++;                                     \
384           kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
385         }                                                               \
386       else                                                              \
387         hold_event (emacs_event);                                       \
388       EVENT_INIT (*emacs_event);                                        \
389       ns_send_appdefined (-1);                                          \
390     }
392 /* TODO: get rid of need for these forward declarations */
393 static void ns_condemn_scroll_bars (struct frame *f);
394 static void ns_judge_scroll_bars (struct frame *f);
395 void x_set_frame_alpha (struct frame *f);
398 /* ==========================================================================
400     Utilities
402    ========================================================================== */
404 void
405 ns_init_events (struct input_event* ev)
407   EVENT_INIT (*ev);
408   emacs_event = ev;
411 void
412 ns_finish_events ()
414   emacs_event = NULL;
417 static void
418 hold_event (struct input_event *event)
420   if (hold_event_q.nr == hold_event_q.cap)
421     {
422       if (hold_event_q.cap == 0) hold_event_q.cap = 10;
423       else hold_event_q.cap *= 2;
424       hold_event_q.q =
425         xrealloc (hold_event_q.q, hold_event_q.cap * sizeof *hold_event_q.q);
426     }
428   hold_event_q.q[hold_event_q.nr++] = *event;
429   /* Make sure ns_read_socket is called, i.e. we have input.  */
430   raise (SIGIO);
431   send_appdefined = YES;
434 static Lisp_Object
435 append2 (Lisp_Object list, Lisp_Object item)
436 /* --------------------------------------------------------------------------
437    Utility to append to a list
438    -------------------------------------------------------------------------- */
440   Lisp_Object array[2];
441   array[0] = list;
442   array[1] = list1 (item);
443   return Fnconc (2, &array[0]);
447 const char *
448 ns_etc_directory (void)
449 /* If running as a self-contained app bundle, return as a string the
450    filename of the etc directory, if present; else nil.  */
452   NSBundle *bundle = [NSBundle mainBundle];
453   NSString *resourceDir = [bundle resourcePath];
454   NSString *resourcePath;
455   NSFileManager *fileManager = [NSFileManager defaultManager];
456   BOOL isDir;
458   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
459   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
460     {
461       if (isDir) return [resourcePath UTF8String];
462     }
463   return NULL;
467 const char *
468 ns_exec_path (void)
469 /* If running as a self-contained app bundle, return as a path string
470    the filenames of the libexec and bin directories, ie libexec:bin.
471    Otherwise, return nil.
472    Normally, Emacs does not add its own bin/ directory to the PATH.
473    However, a self-contained NS build has a different layout, with
474    bin/ and libexec/ subdirectories in the directory that contains
475    Emacs.app itself.
476    We put libexec first, because init_callproc_1 uses the first
477    element to initialize exec-directory.  An alternative would be
478    for init_callproc to check for invocation-directory/libexec.
481   NSBundle *bundle = [NSBundle mainBundle];
482   NSString *resourceDir = [bundle resourcePath];
483   NSString *binDir = [bundle bundlePath];
484   NSString *resourcePath, *resourcePaths;
485   NSRange range;
486   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
487   NSFileManager *fileManager = [NSFileManager defaultManager];
488   NSArray *paths;
489   NSEnumerator *pathEnum;
490   BOOL isDir;
492   range = [resourceDir rangeOfString: @"Contents"];
493   if (range.location != NSNotFound)
494     {
495       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
496 #ifdef NS_IMPL_COCOA
497       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
498 #endif
499     }
501   paths = [binDir stringsByAppendingPaths:
502                 [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
503   pathEnum = [paths objectEnumerator];
504   resourcePaths = @"";
506   while ((resourcePath = [pathEnum nextObject]))
507     {
508       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
509         if (isDir)
510           {
511             if ([resourcePaths length] > 0)
512               resourcePaths
513                 = [resourcePaths stringByAppendingString: pathSeparator];
514             resourcePaths
515               = [resourcePaths stringByAppendingString: resourcePath];
516           }
517     }
518   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
520   return NULL;
524 const char *
525 ns_load_path (void)
526 /* If running as a self-contained app bundle, return as a path string
527    the filenames of the site-lisp and lisp directories.
528    Ie, site-lisp:lisp.  Otherwise, return nil.  */
530   NSBundle *bundle = [NSBundle mainBundle];
531   NSString *resourceDir = [bundle resourcePath];
532   NSString *resourcePath, *resourcePaths;
533   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
534   NSFileManager *fileManager = [NSFileManager defaultManager];
535   BOOL isDir;
536   NSArray *paths = [resourceDir stringsByAppendingPaths:
537                               [NSArray arrayWithObjects:
538                                          @"site-lisp", @"lisp", nil]];
539   NSEnumerator *pathEnum = [paths objectEnumerator];
540   resourcePaths = @"";
542   /* Hack to skip site-lisp.  */
543   if (no_site_lisp) resourcePath = [pathEnum nextObject];
545   while ((resourcePath = [pathEnum nextObject]))
546     {
547       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
548         if (isDir)
549           {
550             if ([resourcePaths length] > 0)
551               resourcePaths
552                 = [resourcePaths stringByAppendingString: pathSeparator];
553             resourcePaths
554               = [resourcePaths stringByAppendingString: resourcePath];
555           }
556     }
557   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
559   return NULL;
562 static void
563 ns_timeout (int usecs)
564 /* --------------------------------------------------------------------------
565      Blocking timer utility used by ns_ring_bell
566    -------------------------------------------------------------------------- */
568   struct timespec wakeup = timespec_add (current_timespec (),
569                                          make_timespec (0, usecs * 1000));
571   /* Keep waiting until past the time wakeup.  */
572   while (1)
573     {
574       struct timespec timeout, now = current_timespec ();
575       if (timespec_cmp (wakeup, now) <= 0)
576         break;
577       timeout = timespec_sub (wakeup, now);
579       /* Try to wait that long--but we might wake up sooner.  */
580       pselect (0, NULL, NULL, NULL, &timeout, NULL);
581     }
585 void
586 ns_release_object (void *obj)
587 /* --------------------------------------------------------------------------
588     Release an object (callable from C)
589    -------------------------------------------------------------------------- */
591     [(id)obj release];
595 void
596 ns_retain_object (void *obj)
597 /* --------------------------------------------------------------------------
598     Retain an object (callable from C)
599    -------------------------------------------------------------------------- */
601     [(id)obj retain];
605 void *
606 ns_alloc_autorelease_pool (void)
607 /* --------------------------------------------------------------------------
608      Allocate a pool for temporary objects (callable from C)
609    -------------------------------------------------------------------------- */
611   return [[NSAutoreleasePool alloc] init];
615 void
616 ns_release_autorelease_pool (void *pool)
617 /* --------------------------------------------------------------------------
618      Free a pool and temporary objects it refers to (callable from C)
619    -------------------------------------------------------------------------- */
621   ns_release_object (pool);
626 /* ==========================================================================
628     Focus (clipping) and screen update
630    ========================================================================== */
633 // Window constraining
634 // -------------------
636 // To ensure that the windows are not placed under the menu bar, they
637 // are typically moved by the call-back constrainFrameRect. However,
638 // by overriding it, it's possible to inhibit this, leaving the window
639 // in it's original position.
641 // It's possible to hide the menu bar. However, technically, it's only
642 // possible to hide it when the application is active. To ensure that
643 // this work properly, the menu bar and window constraining are
644 // deferred until the application becomes active.
646 // Even though it's not possible to manually move a window above the
647 // top of the screen, it is allowed if it's done programmatically,
648 // when the menu is hidden. This allows the editable area to cover the
649 // full screen height.
651 // Test cases
652 // ----------
654 // Use the following extra files:
656 //    init.el:
657 //       ;; Hide menu and place frame slightly above the top of the screen.
658 //       (setq ns-auto-hide-menu-bar t)
659 //       (set-frame-position (selected-frame) 0 -20)
661 // Test 1:
663 //    emacs -Q -l init.el
665 //    Result: No menu bar, and the title bar should be above the screen.
667 // Test 2:
669 //    emacs -Q
671 //    Result: Menu bar visible, frame placed immediately below the menu.
674 static void
675 ns_constrain_all_frames (void)
677   Lisp_Object tail, frame;
679   FOR_EACH_FRAME (tail, frame)
680     {
681       struct frame *f = XFRAME (frame);
682       if (FRAME_NS_P (f))
683         {
684           NSView *view = FRAME_NS_VIEW (f);
685           /* This no-op will trigger the default window placing
686            * constraint system. */
687           [[view window] setFrameOrigin:[[view window] frame].origin];
688         }
689     }
693 /* True, if the menu bar should be hidden.  */
695 static BOOL
696 ns_menu_bar_should_be_hidden (void)
698   return !NILP (ns_auto_hide_menu_bar)
699     && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
703 /* Show or hide the menu bar, based on user setting.  */
705 static void
706 ns_update_auto_hide_menu_bar (void)
708 #ifdef NS_IMPL_COCOA
709 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
710   block_input ();
712   NSTRACE (ns_update_auto_hide_menu_bar);
714   if (NSApp != nil && [NSApp isActive])
715     {
716       // Note, "setPresentationOptions" triggers an error unless the
717       // application is active.
718       BOOL menu_bar_should_be_hidden = ns_menu_bar_should_be_hidden ();
720       if (menu_bar_should_be_hidden != ns_menu_bar_is_hidden)
721         {
722           NSApplicationPresentationOptions options
723             = NSApplicationPresentationDefault;
725           if (menu_bar_should_be_hidden)
726             options |= NSApplicationPresentationAutoHideMenuBar
727               | NSApplicationPresentationAutoHideDock;
729           [NSApp setPresentationOptions: options];
731           ns_menu_bar_is_hidden = menu_bar_should_be_hidden;
733           if (!ns_menu_bar_is_hidden)
734             {
735               ns_constrain_all_frames ();
736             }
737         }
738     }
740   unblock_input ();
741 #endif
742 #endif
746 static void
747 ns_update_begin (struct frame *f)
748 /* --------------------------------------------------------------------------
749    Prepare for a grouped sequence of drawing calls
750    external (RIF) call; whole frame, called before update_window_begin
751    -------------------------------------------------------------------------- */
753   EmacsView *view = FRAME_NS_VIEW (f);
754   NSTRACE (ns_update_begin);
756   ns_update_auto_hide_menu_bar ();
758 #ifdef NS_IMPL_COCOA
759   if ([view isFullscreen] && [view fsIsNative])
760   {
761     // Fix reappearing tool bar in fullscreen for OSX 10.7
762     BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (f) ? YES : NO;
763     NSToolbar *toolbar = [FRAME_NS_VIEW (f) toolbar];
764     if (! tbar_visible != ! [toolbar isVisible])
765       [toolbar setVisible: tbar_visible];
766   }
767 #endif
769   ns_updating_frame = f;
770   [view lockFocus];
772   /* drawRect may have been called for say the minibuffer, and then clip path
773      is for the minibuffer.  But the display engine may draw more because
774      we have set the frame as garbaged.  So reset clip path to the whole
775      view.  */
776 #ifdef NS_IMPL_COCOA
777   {
778     NSBezierPath *bp;
779     NSRect r = [view frame];
780     NSRect cr = [[view window] frame];
781     /* If a large frame size is set, r may be larger than the window frame
782        before constrained.  In that case don't change the clip path, as we
783        will clear in to the tool bar and title bar.  */
784     if (r.size.height
785         + FRAME_NS_TITLEBAR_HEIGHT (f)
786         + FRAME_TOOLBAR_HEIGHT (f) <= cr.size.height)
787       {
788         bp = [[NSBezierPath bezierPathWithRect: r] retain];
789         [bp setClip];
790         [bp release];
791       }
792   }
793 #endif
795 #ifdef NS_IMPL_GNUSTEP
796   uRect = NSMakeRect (0, 0, 0, 0);
797 #endif
801 static void
802 ns_update_window_begin (struct window *w)
803 /* --------------------------------------------------------------------------
804    Prepare for a grouped sequence of drawing calls
805    external (RIF) call; for one window, called after update_begin
806    -------------------------------------------------------------------------- */
808   struct frame *f = XFRAME (WINDOW_FRAME (w));
809   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
811   NSTRACE (ns_update_window_begin);
812   w->output_cursor = w->cursor;
814   block_input ();
816   if (f == hlinfo->mouse_face_mouse_frame)
817     {
818       /* Don't do highlighting for mouse motion during the update.  */
819       hlinfo->mouse_face_defer = 1;
821         /* If the frame needs to be redrawn,
822            simply forget about any prior mouse highlighting.  */
823       if (FRAME_GARBAGED_P (f))
824         hlinfo->mouse_face_window = Qnil;
826       /* (further code for mouse faces ifdef'd out in other terms elided) */
827     }
829   unblock_input ();
833 static void
834 ns_update_window_end (struct window *w, bool cursor_on_p,
835                       bool mouse_face_overwritten_p)
836 /* --------------------------------------------------------------------------
837    Finished a grouped sequence of drawing calls
838    external (RIF) call; for one window called before update_end
839    -------------------------------------------------------------------------- */
841   /* note: this fn is nearly identical in all terms */
842   if (!w->pseudo_window_p)
843     {
844       block_input ();
846       if (cursor_on_p)
847         display_and_set_cursor (w, 1,
848                                 w->output_cursor.hpos, w->output_cursor.vpos,
849                                 w->output_cursor.x, w->output_cursor.y);
851       if (draw_window_fringes (w, 1))
852         {
853           if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
854             x_draw_right_divider (w);
855           else
856             x_draw_vertical_border (w);
857         }
859       unblock_input ();
860     }
862   /* If a row with mouse-face was overwritten, arrange for
863      frame_up_to_date to redisplay the mouse highlight.  */
864   if (mouse_face_overwritten_p)
865     reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
867   NSTRACE (update_window_end);
871 static void
872 ns_update_end (struct frame *f)
873 /* --------------------------------------------------------------------------
874    Finished a grouped sequence of drawing calls
875    external (RIF) call; for whole frame, called after update_window_end
876    -------------------------------------------------------------------------- */
878   EmacsView *view = FRAME_NS_VIEW (f);
880 /*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
881   MOUSE_HL_INFO (f)->mouse_face_defer = 0;
883   block_input ();
885   [view unlockFocus];
886   [[view window] flushWindow];
888   unblock_input ();
889   ns_updating_frame = NULL;
890   NSTRACE (ns_update_end);
893 static void
894 ns_focus (struct frame *f, NSRect *r, int n)
895 /* --------------------------------------------------------------------------
896    Internal: Focus on given frame.  During small local updates this is used to
897      draw, however during large updates, ns_update_begin and ns_update_end are
898      called to wrap the whole thing, in which case these calls are stubbed out.
899      Except, on GNUstep, we accumulate the rectangle being drawn into, because
900      the back end won't do this automatically, and will just end up flushing
901      the entire window.
902    -------------------------------------------------------------------------- */
904 //  NSTRACE (ns_focus);
905 /* static int c =0;
906    fprintf (stderr, "focus: %d", c++);
907    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
908    fprintf (stderr, "\n"); */
910   if (f != ns_updating_frame)
911     {
912       NSView *view = FRAME_NS_VIEW (f);
913       if (view != focus_view)
914         {
915           if (focus_view != NULL)
916             {
917               [focus_view unlockFocus];
918               [[focus_view window] flushWindow];
919 /*debug_lock--; */
920             }
922           if (view)
923             [view lockFocus];
924           focus_view = view;
925 /*if (view) debug_lock++; */
926         }
927     }
929   /* clipping */
930   if (r)
931     {
932       [[NSGraphicsContext currentContext] saveGraphicsState];
933       if (n == 2)
934         NSRectClipList (r, 2);
935       else
936         NSRectClip (*r);
937       gsaved = YES;
938     }
942 static void
943 ns_unfocus (struct frame *f)
944 /* --------------------------------------------------------------------------
945      Internal: Remove focus on given frame
946    -------------------------------------------------------------------------- */
948 //  NSTRACE (ns_unfocus);
950   if (gsaved)
951     {
952       [[NSGraphicsContext currentContext] restoreGraphicsState];
953       gsaved = NO;
954     }
956   if (f != ns_updating_frame)
957     {
958       if (focus_view != NULL)
959         {
960           [focus_view unlockFocus];
961           [[focus_view window] flushWindow];
962           focus_view = NULL;
963 /*debug_lock--; */
964         }
965     }
969 static void
970 ns_clip_to_row (struct window *w, struct glyph_row *row,
971                 enum glyph_row_area area, BOOL gc)
972 /* --------------------------------------------------------------------------
973      Internal (but parallels other terms): Focus drawing on given row
974    -------------------------------------------------------------------------- */
976   struct frame *f = XFRAME (WINDOW_FRAME (w));
977   NSRect clip_rect;
978   int window_x, window_y, window_width;
980   window_box (w, area, &window_x, &window_y, &window_width, 0);
982   clip_rect.origin.x = window_x;
983   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
984   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
985   clip_rect.size.width = window_width;
986   clip_rect.size.height = row->visible_height;
988   ns_focus (f, &clip_rect, 1);
992 static void
993 ns_ring_bell (struct frame *f)
994 /* --------------------------------------------------------------------------
995      "Beep" routine
996    -------------------------------------------------------------------------- */
998   NSTRACE (ns_ring_bell);
999   if (visible_bell)
1000     {
1001       NSAutoreleasePool *pool;
1002       struct frame *frame = SELECTED_FRAME ();
1003       NSView *view;
1005       block_input ();
1006       pool = [[NSAutoreleasePool alloc] init];
1008       view = FRAME_NS_VIEW (frame);
1009       if (view != nil)
1010         {
1011           NSRect r, surr;
1012           NSPoint dim = NSMakePoint (128, 128);
1014           r = [view bounds];
1015           r.origin.x += (r.size.width - dim.x) / 2;
1016           r.origin.y += (r.size.height - dim.y) / 2;
1017           r.size.width = dim.x;
1018           r.size.height = dim.y;
1019           surr = NSInsetRect (r, -2, -2);
1020           ns_focus (frame, &surr, 1);
1021           [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
1022           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
1023                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
1024           NSRectFill (r);
1025           [[view window] flushWindow];
1026           ns_timeout (150000);
1027           [[view window] restoreCachedImage];
1028           [[view window] flushWindow];
1029           ns_unfocus (frame);
1030         }
1031       [pool release];
1032       unblock_input ();
1033     }
1034   else
1035     {
1036       NSBeep ();
1037     }
1040 /* ==========================================================================
1042     Frame / window manager related functions
1044    ========================================================================== */
1047 static void
1048 ns_raise_frame (struct frame *f)
1049 /* --------------------------------------------------------------------------
1050      Bring window to foreground and make it active
1051    -------------------------------------------------------------------------- */
1053   NSView *view;
1054   check_window_system (f);
1055   view = FRAME_NS_VIEW (f);
1056   block_input ();
1057   if (FRAME_VISIBLE_P (f))
1058     [[view window] makeKeyAndOrderFront: NSApp];
1059   unblock_input ();
1063 static void
1064 ns_lower_frame (struct frame *f)
1065 /* --------------------------------------------------------------------------
1066      Send window to back
1067    -------------------------------------------------------------------------- */
1069   NSView *view;
1070   check_window_system (f);
1071   view = FRAME_NS_VIEW (f);
1072   block_input ();
1073   [[view window] orderBack: NSApp];
1074   unblock_input ();
1078 static void
1079 ns_frame_raise_lower (struct frame *f, int raise)
1080 /* --------------------------------------------------------------------------
1081      External (hook)
1082    -------------------------------------------------------------------------- */
1084   NSTRACE (ns_frame_raise_lower);
1086   if (raise)
1087     ns_raise_frame (f);
1088   else
1089     ns_lower_frame (f);
1093 static void
1094 ns_frame_rehighlight (struct frame *frame)
1095 /* --------------------------------------------------------------------------
1096      External (hook): called on things like window switching within frame
1097    -------------------------------------------------------------------------- */
1099   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1100   struct frame *old_highlight = dpyinfo->x_highlight_frame;
1102   NSTRACE (ns_frame_rehighlight);
1103   if (dpyinfo->x_focus_frame)
1104     {
1105       dpyinfo->x_highlight_frame
1106         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1107            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1108            : dpyinfo->x_focus_frame);
1109       if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
1110         {
1111           fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
1112           dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
1113         }
1114     }
1115   else
1116       dpyinfo->x_highlight_frame = 0;
1118   if (dpyinfo->x_highlight_frame &&
1119          dpyinfo->x_highlight_frame != old_highlight)
1120     {
1121       if (old_highlight)
1122         {
1123           x_update_cursor (old_highlight, 1);
1124           x_set_frame_alpha (old_highlight);
1125         }
1126       if (dpyinfo->x_highlight_frame)
1127         {
1128           x_update_cursor (dpyinfo->x_highlight_frame, 1);
1129           x_set_frame_alpha (dpyinfo->x_highlight_frame);
1130         }
1131     }
1135 void
1136 x_make_frame_visible (struct frame *f)
1137 /* --------------------------------------------------------------------------
1138      External: Show the window (X11 semantics)
1139    -------------------------------------------------------------------------- */
1141   NSTRACE (x_make_frame_visible);
1142   /* XXX: at some points in past this was not needed, as the only place that
1143      called this (frame.c:Fraise_frame ()) also called raise_lower;
1144      if this ends up the case again, comment this out again. */
1145   if (!FRAME_VISIBLE_P (f))
1146     {
1147       EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1149       SET_FRAME_VISIBLE (f, 1);
1150       ns_raise_frame (f);
1152       /* Making a new frame from a fullscreen frame will make the new frame
1153          fullscreen also.  So skip handleFS as this will print an error.  */
1154       if ([view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH
1155           && [view isFullscreen])
1156         return;
1158       if (f->want_fullscreen != FULLSCREEN_NONE)
1159         {
1160           block_input ();
1161           [view handleFS];
1162           unblock_input ();
1163         }
1164     }
1168 void
1169 x_make_frame_invisible (struct frame *f)
1170 /* --------------------------------------------------------------------------
1171      External: Hide the window (X11 semantics)
1172    -------------------------------------------------------------------------- */
1174   NSView *view;
1175   NSTRACE (x_make_frame_invisible);
1176   check_window_system (f);
1177   view = FRAME_NS_VIEW (f);
1178   [[view window] orderOut: NSApp];
1179   SET_FRAME_VISIBLE (f, 0);
1180   SET_FRAME_ICONIFIED (f, 0);
1184 void
1185 x_iconify_frame (struct frame *f)
1186 /* --------------------------------------------------------------------------
1187      External: Iconify window
1188    -------------------------------------------------------------------------- */
1190   NSView *view;
1191   struct ns_display_info *dpyinfo;
1193   NSTRACE (x_iconify_frame);
1194   check_window_system (f);
1195   view = FRAME_NS_VIEW (f);
1196   dpyinfo = FRAME_DISPLAY_INFO (f);
1198   if (dpyinfo->x_highlight_frame == f)
1199     dpyinfo->x_highlight_frame = 0;
1201   if ([[view window] windowNumber] <= 0)
1202     {
1203       /* the window is still deferred.  Make it very small, bring it
1204          on screen and order it out. */
1205       NSRect s = { { 100, 100}, {0, 0} };
1206       NSRect t;
1207       t = [[view window] frame];
1208       [[view window] setFrame: s display: NO];
1209       [[view window] orderBack: NSApp];
1210       [[view window] orderOut: NSApp];
1211       [[view window] setFrame: t display: NO];
1212     }
1213   [[view window] miniaturize: NSApp];
1216 /* Free X resources of frame F.  */
1218 void
1219 x_free_frame_resources (struct frame *f)
1221   NSView *view;
1222   struct ns_display_info *dpyinfo;
1223   Mouse_HLInfo *hlinfo;
1225   NSTRACE (x_free_frame_resources);
1226   check_window_system (f);
1227   view = FRAME_NS_VIEW (f);
1228   dpyinfo = FRAME_DISPLAY_INFO (f);
1229   hlinfo = MOUSE_HL_INFO (f);
1231   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1233   block_input ();
1235   free_frame_menubar (f);
1236   free_frame_faces (f);
1238   if (f == dpyinfo->x_focus_frame)
1239     dpyinfo->x_focus_frame = 0;
1240   if (f == dpyinfo->x_highlight_frame)
1241     dpyinfo->x_highlight_frame = 0;
1242   if (f == hlinfo->mouse_face_mouse_frame)
1243     reset_mouse_highlight (hlinfo);
1245   if (f->output_data.ns->miniimage != nil)
1246     [f->output_data.ns->miniimage release];
1248   [[view window] close];
1249   [view release];
1251   xfree (f->output_data.ns);
1253   unblock_input ();
1256 void
1257 x_destroy_window (struct frame *f)
1258 /* --------------------------------------------------------------------------
1259      External: Delete the window
1260    -------------------------------------------------------------------------- */
1262   NSTRACE (x_destroy_window);
1263   check_window_system (f);
1264   x_free_frame_resources (f);
1265   ns_window_num--;
1269 void
1270 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1271 /* --------------------------------------------------------------------------
1272      External: Position the window
1273    -------------------------------------------------------------------------- */
1275   NSView *view = FRAME_NS_VIEW (f);
1276   NSArray *screens = [NSScreen screens];
1277   NSScreen *fscreen = [screens objectAtIndex: 0];
1278   NSScreen *screen = [[view window] screen];
1280   NSTRACE (x_set_offset);
1282   block_input ();
1284   f->left_pos = xoff;
1285   f->top_pos = yoff;
1287   if (view != nil && screen && fscreen)
1288     {
1289       f->left_pos = f->size_hint_flags & XNegative
1290         ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
1291         : f->left_pos;
1292       /* We use visibleFrame here to take menu bar into account.
1293          Ideally we should also adjust left/top with visibleFrame.origin.  */
1295       f->top_pos = f->size_hint_flags & YNegative
1296         ? ([screen visibleFrame].size.height + f->top_pos
1297            - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
1298            - FRAME_TOOLBAR_HEIGHT (f))
1299         : f->top_pos;
1300 #ifdef NS_IMPL_GNUSTEP
1301       if (f->left_pos < 100)
1302         f->left_pos = 100;  /* don't overlap menu */
1303 #endif
1304       /* Constrain the setFrameTopLeftPoint so we don't move behind the
1305          menu bar.  */
1306       [[view window] setFrameTopLeftPoint:
1307                        NSMakePoint (SCREENMAXBOUND (f->left_pos),
1308                                     SCREENMAXBOUND ([fscreen frame].size.height
1309                                                     - NS_TOP_POS (f)))];
1310       f->size_hint_flags &= ~(XNegative|YNegative);
1311     }
1313   unblock_input ();
1317 void
1318 x_set_window_size (struct frame *f,
1319                    int change_grav,
1320                    int width,
1321                    int height,
1322                    bool pixelwise)
1323 /* --------------------------------------------------------------------------
1324      Adjust window pixel size based on given character grid size
1325      Impl is a bit more complex than other terms, need to do some
1326      internal clipping.
1327    -------------------------------------------------------------------------- */
1329   EmacsView *view = FRAME_NS_VIEW (f);
1330   NSWindow *window = [view window];
1331   NSRect wr = [window frame];
1332   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1333   int pixelwidth, pixelheight;
1334   int rows, cols;
1336   NSTRACE (x_set_window_size);
1338   if (view == nil)
1339     return;
1341 /*fprintf (stderr, "\tsetWindowSize: %d x %d, pixelwise %d, font size %d x %d\n", width, height, pixelwise, FRAME_COLUMN_WIDTH (f), FRAME_LINE_HEIGHT (f));*/
1343   block_input ();
1345   if (pixelwise)
1346     {
1347       pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
1348       pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
1349       cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
1350       rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
1351     }
1352   else
1353     {
1354       pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, width);
1355       pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, height);
1356       cols = width;
1357       rows = height;
1358     }
1360   /* If we have a toolbar, take its height into account. */
1361   if (tb && ! [view isFullscreen])
1362     {
1363     /* NOTE: previously this would generate wrong result if toolbar not
1364              yet displayed and fixing toolbar_height=32 helped, but
1365              now (200903) seems no longer needed */
1366     FRAME_TOOLBAR_HEIGHT (f) =
1367       NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1368         - FRAME_NS_TITLEBAR_HEIGHT (f);
1369 #ifdef NS_IMPL_GNUSTEP
1370       FRAME_TOOLBAR_HEIGHT (f) -= 3;
1371 #endif
1372     }
1373   else
1374     FRAME_TOOLBAR_HEIGHT (f) = 0;
1376   wr.size.width = pixelwidth + f->border_width;
1377   wr.size.height = pixelheight;
1378   if (! [view isFullscreen])
1379     wr.size.height += FRAME_NS_TITLEBAR_HEIGHT (f)
1380       + FRAME_TOOLBAR_HEIGHT (f);
1382   /* Do not try to constrain to this screen.  We may have multiple
1383      screens, and want Emacs to span those.  Constraining to screen
1384      prevents that, and that is not nice to the user.  */
1385  if (f->output_data.ns->zooming)
1386    f->output_data.ns->zooming = 0;
1387  else
1388    wr.origin.y += FRAME_PIXEL_HEIGHT (f) - pixelheight;
1390   [view setRows: rows andColumns: cols];
1391   [window setFrame: wr display: YES];
1393   /* This is a trick to compensate for Emacs' managing the scrollbar area
1394      as a fixed number of standard character columns.  Instead of leaving
1395      blank space for the extra, we chopped it off above.  Now for
1396      left-hand scrollbars, we shift all rendering to the left by the
1397      difference between the real width and Emacs' imagined one.  For
1398      right-hand bars, don't worry about it since the extra is never used.
1399      (Obviously doesn't work for vertically split windows tho..) */
1400   {
1401     NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1402       ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1403                      - NS_SCROLL_BAR_WIDTH (f), 0)
1404       : NSMakePoint (0, 0);
1405     [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1406     [view setBoundsOrigin: origin];
1407   }
1409   change_frame_size (f, width, height, 0, 1, 0, pixelwise);
1410 /*  SET_FRAME_GARBAGED (f); // this short-circuits expose call in drawRect */
1412   mark_window_cursors_off (XWINDOW (f->root_window));
1413   cancel_mouse_face (f);
1415   unblock_input ();
1417   do_pending_window_change (0);
1421 static void
1422 ns_fullscreen_hook (struct frame *f)
1424   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1426   if (!FRAME_VISIBLE_P (f))
1427     return;
1429    if (! [view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH)
1430     {
1431       /* Old style fs don't initiate correctly if created from
1432          init/default-frame alist, so use a timer (not nice...).
1433       */
1434       [NSTimer scheduledTimerWithTimeInterval: 0.5 target: view
1435                                      selector: @selector (handleFS)
1436                                      userInfo: nil repeats: NO];
1437       return;
1438     }
1440   block_input ();
1441   [view handleFS];
1442   unblock_input ();
1445 /* ==========================================================================
1447     Color management
1449    ========================================================================== */
1452 NSColor *
1453 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1455   struct ns_color_table *color_table = FRAME_DISPLAY_INFO (f)->color_table;
1456   if (idx < 1 || idx >= color_table->avail)
1457     return nil;
1458   return color_table->colors[idx];
1462 unsigned long
1463 ns_index_color (NSColor *color, struct frame *f)
1465   struct ns_color_table *color_table = FRAME_DISPLAY_INFO (f)->color_table;
1466   ptrdiff_t idx;
1467   ptrdiff_t i;
1469   if (!color_table->colors)
1470     {
1471       color_table->size = NS_COLOR_CAPACITY;
1472       color_table->avail = 1; /* skip idx=0 as marker */
1473       color_table->colors = xmalloc (color_table->size * sizeof (NSColor *));
1474       color_table->colors[0] = nil;
1475       color_table->empty_indices = [[NSMutableSet alloc] init];
1476     }
1478   /* Do we already have this color?  */
1479   for (i = 1; i < color_table->avail; i++)
1480     if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1481       return i;
1483   if ([color_table->empty_indices count] > 0)
1484     {
1485       NSNumber *index = [color_table->empty_indices anyObject];
1486       [color_table->empty_indices removeObject: index];
1487       idx = [index unsignedLongValue];
1488     }
1489   else
1490     {
1491       if (color_table->avail == color_table->size)
1492         color_table->colors =
1493           xpalloc (color_table->colors, &color_table->size, 1,
1494                    min (ULONG_MAX, PTRDIFF_MAX), sizeof *color_table->colors);
1495       idx = color_table->avail++;
1496     }
1498   color_table->colors[idx] = color;
1499   [color retain];
1500 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1501   return idx;
1505 void
1506 ns_free_indexed_color (unsigned long idx, struct frame *f)
1508   struct ns_color_table *color_table;
1509   NSColor *color;
1510   NSNumber *index;
1512   if (!f)
1513     return;
1515   color_table = FRAME_DISPLAY_INFO (f)->color_table;
1517   if (idx <= 0 || idx >= color_table->size) {
1518     message1 ("ns_free_indexed_color: Color index out of range.\n");
1519     return;
1520   }
1522   index = [NSNumber numberWithUnsignedInt: idx];
1523   if ([color_table->empty_indices containsObject: index]) {
1524     message1 ("ns_free_indexed_color: attempt to free already freed color.\n");
1525     return;
1526   }
1528   color = color_table->colors[idx];
1529   [color release];
1530   color_table->colors[idx] = nil;
1531   [color_table->empty_indices addObject: index];
1532 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1536 static int
1537 ns_get_color (const char *name, NSColor **col)
1538 /* --------------------------------------------------------------------------
1539      Parse a color name
1540    -------------------------------------------------------------------------- */
1541 /* On *Step, we attempt to mimic the X11 platform here, down to installing an
1542    X11 rgb.txt-compatible color list in Emacs.clr (see ns_term_init()).
1543    See: http://thread.gmane.org/gmane.emacs.devel/113050/focus=113272). */
1545   NSColor *new = nil;
1546   static char hex[20];
1547   int scaling;
1548   float r = -1.0, g, b;
1549   NSString *nsname = [NSString stringWithUTF8String: name];
1551 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1552   block_input ();
1554   if ([nsname isEqualToString: @"ns_selection_bg_color"])
1555     {
1556 #ifdef NS_IMPL_COCOA
1557       NSString *defname = [[NSUserDefaults standardUserDefaults]
1558                             stringForKey: @"AppleHighlightColor"];
1559       if (defname != nil)
1560         nsname = defname;
1561       else
1562 #endif
1563       if ((new = [NSColor selectedTextBackgroundColor]) != nil)
1564         {
1565           *col = [new colorUsingDefaultColorSpace];
1566           unblock_input ();
1567           return 0;
1568         }
1569       else
1570         nsname = NS_SELECTION_BG_COLOR_DEFAULT;
1572       name = [nsname UTF8String];
1573     }
1574   else if ([nsname isEqualToString: @"ns_selection_fg_color"])
1575     {
1576       /* NOTE: OSX applications normally don't set foreground selection, but
1577          text may be unreadable if we don't.
1578       */
1579       if ((new = [NSColor selectedTextColor]) != nil)
1580         {
1581           *col = [new colorUsingDefaultColorSpace];
1582           unblock_input ();
1583           return 0;
1584         }
1586       nsname = NS_SELECTION_FG_COLOR_DEFAULT;
1587       name = [nsname UTF8String];
1588     }
1590   /* First, check for some sort of numeric specification. */
1591   hex[0] = '\0';
1593   if (name[0] == '0' || name[0] == '1' || name[0] == '.')  /* RGB decimal */
1594     {
1595       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1596       [scanner scanFloat: &r];
1597       [scanner scanFloat: &g];
1598       [scanner scanFloat: &b];
1599     }
1600   else if (!strncmp(name, "rgb:", 4))  /* A newer X11 format -- rgb:r/g/b */
1601     scaling = (snprintf (hex, sizeof hex, "%s", name + 4) - 2) / 3;
1602   else if (name[0] == '#')        /* An old X11 format; convert to newer */
1603     {
1604       int len = (strlen(name) - 1);
1605       int start = (len % 3 == 0) ? 1 : len / 4 + 1;
1606       int i;
1607       scaling = strlen(name+start) / 3;
1608       for (i = 0; i < 3; i++)
1609         sprintf (hex + i * (scaling + 1), "%.*s/", scaling,
1610                  name + start + i * scaling);
1611       hex[3 * (scaling + 1) - 1] = '\0';
1612     }
1614   if (hex[0])
1615     {
1616       int rr, gg, bb;
1617       float fscale = scaling == 4 ? 65535.0 : (scaling == 2 ? 255.0 : 15.0);
1618       if (sscanf (hex, "%x/%x/%x", &rr, &gg, &bb))
1619         {
1620           r = rr / fscale;
1621           g = gg / fscale;
1622           b = bb / fscale;
1623         }
1624     }
1626   if (r >= 0.0F)
1627     {
1628       *col = [NSColor colorForEmacsRed: r green: g blue: b alpha: 1.0];
1629       unblock_input ();
1630       return 0;
1631     }
1633   /* Otherwise, color is expected to be from a list */
1634   {
1635     NSEnumerator *lenum, *cenum;
1636     NSString *name;
1637     NSColorList *clist;
1639 #ifdef NS_IMPL_GNUSTEP
1640     /* XXX: who is wrong, the requestor or the implementation? */
1641     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1642         == NSOrderedSame)
1643       nsname = @"highlightColor";
1644 #endif
1646     lenum = [[NSColorList availableColorLists] objectEnumerator];
1647     while ( (clist = [lenum nextObject]) && new == nil)
1648       {
1649         cenum = [[clist allKeys] objectEnumerator];
1650         while ( (name = [cenum nextObject]) && new == nil )
1651           {
1652             if ([name compare: nsname
1653                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1654               new = [clist colorWithKey: name];
1655           }
1656       }
1657   }
1659   if (new)
1660     *col = [new colorUsingDefaultColorSpace];
1661   unblock_input ();
1662   return new ? 0 : 1;
1667 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1668 /* --------------------------------------------------------------------------
1669      Convert a Lisp string object to a NS color
1670    -------------------------------------------------------------------------- */
1672   NSTRACE (ns_lisp_to_color);
1673   if (STRINGP (color))
1674     return ns_get_color (SSDATA (color), col);
1675   else if (SYMBOLP (color))
1676     return ns_get_color (SSDATA (SYMBOL_NAME (color)), col);
1677   return 1;
1681 Lisp_Object
1682 ns_color_to_lisp (NSColor *col)
1683 /* --------------------------------------------------------------------------
1684      Convert a color to a lisp string with the RGB equivalent
1685    -------------------------------------------------------------------------- */
1687   EmacsCGFloat red, green, blue, alpha, gray;
1688   char buf[1024];
1689   const char *str;
1690   NSTRACE (ns_color_to_lisp);
1692   block_input ();
1693   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1695       if ((str =[[col colorNameComponent] UTF8String]))
1696         {
1697           unblock_input ();
1698           return build_string ((char *)str);
1699         }
1701     [[col colorUsingDefaultColorSpace]
1702         getRed: &red green: &green blue: &blue alpha: &alpha];
1703   if (red == green && red == blue)
1704     {
1705       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1706             getWhite: &gray alpha: &alpha];
1707       snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1708                 lrint (gray * 0xff), lrint (gray * 0xff), lrint (gray * 0xff));
1709       unblock_input ();
1710       return build_string (buf);
1711     }
1713   snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1714             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1716   unblock_input ();
1717   return build_string (buf);
1721 void
1722 ns_query_color(void *col, XColor *color_def, int setPixel)
1723 /* --------------------------------------------------------------------------
1724          Get ARGB values out of NSColor col and put them into color_def.
1725          If setPixel, set the pixel to a concatenated version.
1726          and set color_def pixel to the resulting index.
1727    -------------------------------------------------------------------------- */
1729   EmacsCGFloat r, g, b, a;
1731   [((NSColor *)col) getRed: &r green: &g blue: &b alpha: &a];
1732   color_def->red   = r * 65535;
1733   color_def->green = g * 65535;
1734   color_def->blue  = b * 65535;
1736   if (setPixel == YES)
1737     color_def->pixel
1738       = ARGB_TO_ULONG((int)(a*255),
1739                       (int)(r*255), (int)(g*255), (int)(b*255));
1743 bool
1744 ns_defined_color (struct frame *f,
1745                   const char *name,
1746                   XColor *color_def,
1747                   bool alloc,
1748                   bool makeIndex)
1749 /* --------------------------------------------------------------------------
1750          Return true if named color found, and set color_def rgb accordingly.
1751          If makeIndex and alloc are nonzero put the color in the color_table,
1752          and set color_def pixel to the resulting index.
1753          If makeIndex is zero, set color_def pixel to ARGB.
1754          Return false if not found
1755    -------------------------------------------------------------------------- */
1757   NSColor *col;
1758   NSTRACE (ns_defined_color);
1760   block_input ();
1761   if (ns_get_color (name, &col) != 0) /* Color not found  */
1762     {
1763       unblock_input ();
1764       return 0;
1765     }
1766   if (makeIndex && alloc)
1767     color_def->pixel = ns_index_color (col, f);
1768   ns_query_color (col, color_def, !makeIndex);
1769   unblock_input ();
1770   return 1;
1774 void
1775 x_set_frame_alpha (struct frame *f)
1776 /* --------------------------------------------------------------------------
1777      change the entire-frame transparency
1778    -------------------------------------------------------------------------- */
1780   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1781   double alpha = 1.0;
1782   double alpha_min = 1.0;
1784   if (dpyinfo->x_highlight_frame == f)
1785     alpha = f->alpha[0];
1786   else
1787     alpha = f->alpha[1];
1789   if (FLOATP (Vframe_alpha_lower_limit))
1790     alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
1791   else if (INTEGERP (Vframe_alpha_lower_limit))
1792     alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
1794   if (alpha < 0.0)
1795     return;
1796   else if (1.0 < alpha)
1797     alpha = 1.0;
1798   else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
1799     alpha = alpha_min;
1801 #ifdef NS_IMPL_COCOA
1802   {
1803     EmacsView *view = FRAME_NS_VIEW (f);
1804   [[view window] setAlphaValue: alpha];
1805   }
1806 #endif
1810 /* ==========================================================================
1812     Mouse handling
1814    ========================================================================== */
1817 void
1818 frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1819 /* --------------------------------------------------------------------------
1820      Programmatically reposition mouse pointer in pixel coordinates
1821    -------------------------------------------------------------------------- */
1823   NSTRACE (frame_set_mouse_pixel_position);
1824   ns_raise_frame (f);
1825 #if 0
1826   /* FIXME: this does not work, and what about GNUstep? */
1827 #ifdef NS_IMPL_COCOA
1828   [FRAME_NS_VIEW (f) lockFocus];
1829   PSsetmouse ((float)pix_x, (float)pix_y);
1830   [FRAME_NS_VIEW (f) unlockFocus];
1831 #endif
1832 #endif
1835 static int
1836 note_mouse_movement (struct frame *frame, CGFloat x, CGFloat y)
1837 /*   ------------------------------------------------------------------------
1838      Called by EmacsView on mouseMovement events.  Passes on
1839      to emacs mainstream code if we moved off of a rect of interest
1840      known as last_mouse_glyph.
1841      ------------------------------------------------------------------------ */
1843   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1844   NSRect *r;
1846 //  NSTRACE (note_mouse_movement);
1848   dpyinfo->last_mouse_motion_frame = frame;
1849   r = &dpyinfo->last_mouse_glyph;
1851   /* Note, this doesn't get called for enter/leave, since we don't have a
1852      position.  Those are taken care of in the corresponding NSView methods. */
1854   /* has movement gone beyond last rect we were tracking? */
1855   if (x < r->origin.x || x >= r->origin.x + r->size.width
1856       || y < r->origin.y || y >= r->origin.y + r->size.height)
1857     {
1858       ns_update_begin (frame);
1859       frame->mouse_moved = 1;
1860       note_mouse_highlight (frame, x, y);
1861       remember_mouse_glyph (frame, x, y, r);
1862       ns_update_end (frame);
1863       return 1;
1864     }
1866   return 0;
1870 static void
1871 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1872                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1873                    Time *time)
1874 /* --------------------------------------------------------------------------
1875     External (hook): inform emacs about mouse position and hit parts.
1876     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1877     x & y should be position in the scrollbar (the whole bar, not the handle)
1878     and length of scrollbar respectively
1879    -------------------------------------------------------------------------- */
1881   id view;
1882   NSPoint position;
1883   Lisp_Object frame, tail;
1884   struct frame *f;
1885   struct ns_display_info *dpyinfo;
1887   NSTRACE (ns_mouse_position);
1889   if (*fp == NULL)
1890     {
1891       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1892       return;
1893     }
1895   dpyinfo = FRAME_DISPLAY_INFO (*fp);
1897   block_input ();
1899   if (dpyinfo->last_mouse_scroll_bar != nil && insist == 0)
1900     {
1901       /* TODO: we do not use this path at the moment because drag events will
1902            go directly to the EmacsScroller.  Leaving code in for now. */
1903       [dpyinfo->last_mouse_scroll_bar
1904           getMouseMotionPart: (int *)part window: bar_window x: x y: y];
1905       if (time)
1906         *time = dpyinfo->last_mouse_movement_time;
1907       dpyinfo->last_mouse_scroll_bar = nil;
1908     }
1909   else
1910     {
1911       /* Clear the mouse-moved flag for every frame on this display.  */
1912       FOR_EACH_FRAME (tail, frame)
1913         if (FRAME_NS_P (XFRAME (frame))
1914             && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1915           XFRAME (frame)->mouse_moved = 0;
1917       dpyinfo->last_mouse_scroll_bar = nil;
1918       if (dpyinfo->last_mouse_frame
1919           && FRAME_LIVE_P (dpyinfo->last_mouse_frame))
1920         f = dpyinfo->last_mouse_frame;
1921       else
1922         f = dpyinfo->x_focus_frame ? dpyinfo->x_focus_frame
1923                                     : SELECTED_FRAME ();
1925       if (f && FRAME_NS_P (f))
1926         {
1927           view = FRAME_NS_VIEW (*fp);
1929           position = [[view window] mouseLocationOutsideOfEventStream];
1930           position = [view convertPoint: position fromView: nil];
1931           remember_mouse_glyph (f, position.x, position.y,
1932                                 &dpyinfo->last_mouse_glyph);
1934           if (bar_window) *bar_window = Qnil;
1935           if (part) *part = scroll_bar_above_handle;
1937           if (x) XSETINT (*x, lrint (position.x));
1938           if (y) XSETINT (*y, lrint (position.y));
1939           if (time)
1940             *time = dpyinfo->last_mouse_movement_time;
1941           *fp = f;
1942         }
1943     }
1945   unblock_input ();
1949 static void
1950 ns_frame_up_to_date (struct frame *f)
1951 /* --------------------------------------------------------------------------
1952     External (hook): Fix up mouse highlighting right after a full update.
1953     Can't use FRAME_MOUSE_UPDATE due to ns_frame_begin and ns_frame_end calls.
1954    -------------------------------------------------------------------------- */
1956   NSTRACE (ns_frame_up_to_date);
1958   if (FRAME_NS_P (f))
1959     {
1960       Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1961       if (f == hlinfo->mouse_face_mouse_frame)
1962         {
1963           block_input ();
1964           ns_update_begin(f);
1965           note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
1966                                 hlinfo->mouse_face_mouse_x,
1967                                 hlinfo->mouse_face_mouse_y);
1968           ns_update_end(f);
1969           unblock_input ();
1970         }
1971     }
1975 static void
1976 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1977 /* --------------------------------------------------------------------------
1978     External (RIF): set frame mouse pointer type.
1979    -------------------------------------------------------------------------- */
1981   NSTRACE (ns_define_frame_cursor);
1982   if (FRAME_POINTER_TYPE (f) != cursor)
1983     {
1984       EmacsView *view = FRAME_NS_VIEW (f);
1985       FRAME_POINTER_TYPE (f) = cursor;
1986       [[view window] invalidateCursorRectsForView: view];
1987       /* Redisplay assumes this function also draws the changed frame
1988          cursor, but this function doesn't, so do it explicitly.  */
1989       x_update_cursor (f, 1);
1990     }
1995 /* ==========================================================================
1997     Keyboard handling
1999    ========================================================================== */
2002 static unsigned
2003 ns_convert_key (unsigned code)
2004 /* --------------------------------------------------------------------------
2005     Internal call used by NSView-keyDown.
2006    -------------------------------------------------------------------------- */
2008   const unsigned last_keysym = ARRAYELTS (convert_ns_to_X_keysym);
2009   unsigned keysym;
2010   /* An array would be faster, but less easy to read. */
2011   for (keysym = 0; keysym < last_keysym; keysym += 2)
2012     if (code == convert_ns_to_X_keysym[keysym])
2013       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
2014   return 0;
2015 /* if decide to use keyCode and Carbon table, use this line:
2016      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
2020 char *
2021 x_get_keysym_name (int keysym)
2022 /* --------------------------------------------------------------------------
2023     Called by keyboard.c.  Not sure if the return val is important, except
2024     that it be unique.
2025    -------------------------------------------------------------------------- */
2027   static char value[16];
2028   NSTRACE (x_get_keysym_name);
2029   sprintf (value, "%d", keysym);
2030   return value;
2035 /* ==========================================================================
2037     Block drawing operations
2039    ========================================================================== */
2042 static void
2043 ns_redraw_scroll_bars (struct frame *f)
2045   int i;
2046   id view;
2047   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
2048   NSTRACE (ns_redraw_scroll_bars);
2049   for (i =[subviews count]-1; i >= 0; i--)
2050     {
2051       view = [subviews objectAtIndex: i];
2052       if (![view isKindOfClass: [EmacsScroller class]]) continue;
2053       [view display];
2054     }
2058 void
2059 ns_clear_frame (struct frame *f)
2060 /* --------------------------------------------------------------------------
2061       External (hook): Erase the entire frame
2062    -------------------------------------------------------------------------- */
2064   NSView *view = FRAME_NS_VIEW (f);
2065   NSRect r;
2067   NSTRACE (ns_clear_frame);
2069  /* comes on initial frame because we have
2070     after-make-frame-functions = select-frame */
2071  if (!FRAME_DEFAULT_FACE (f))
2072    return;
2074   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2076   r = [view bounds];
2078   block_input ();
2079   ns_focus (f, &r, 1);
2080   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
2081   NSRectFill (r);
2082   ns_unfocus (f);
2084   /* as of 2006/11 or so this is now needed */
2085   ns_redraw_scroll_bars (f);
2086   unblock_input ();
2090 static void
2091 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
2092 /* --------------------------------------------------------------------------
2093     External (RIF):  Clear section of frame
2094    -------------------------------------------------------------------------- */
2096   NSRect r = NSMakeRect (x, y, width, height);
2097   NSView *view = FRAME_NS_VIEW (f);
2098   struct face *face = FRAME_DEFAULT_FACE (f);
2100   if (!view || !face)
2101     return;
2103   NSTRACE (ns_clear_frame_area);
2105   r = NSIntersectionRect (r, [view frame]);
2106   ns_focus (f, &r, 1);
2107   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
2109   NSRectFill (r);
2111   ns_unfocus (f);
2112   return;
2116 static void
2117 ns_scroll_run (struct window *w, struct run *run)
2118 /* --------------------------------------------------------------------------
2119     External (RIF):  Insert or delete n lines at line vpos
2120    -------------------------------------------------------------------------- */
2122   struct frame *f = XFRAME (w->frame);
2123   int x, y, width, height, from_y, to_y, bottom_y;
2125   NSTRACE (ns_scroll_run);
2127   /* begin copy from other terms */
2128   /* Get frame-relative bounding box of the text display area of W,
2129      without mode lines.  Include in this box the left and right
2130      fringe of W.  */
2131   window_box (w, ANY_AREA, &x, &y, &width, &height);
2133   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
2134   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
2135   bottom_y = y + height;
2137   if (to_y < from_y)
2138     {
2139       /* Scrolling up.  Make sure we don't copy part of the mode
2140          line at the bottom.  */
2141       if (from_y + run->height > bottom_y)
2142         height = bottom_y - from_y;
2143       else
2144         height = run->height;
2145     }
2146   else
2147     {
2148       /* Scrolling down.  Make sure we don't copy over the mode line.
2149          at the bottom.  */
2150       if (to_y + run->height > bottom_y)
2151         height = bottom_y - to_y;
2152       else
2153         height = run->height;
2154     }
2155   /* end copy from other terms */
2157   if (height == 0)
2158       return;
2160   block_input ();
2162   x_clear_cursor (w);
2164   {
2165     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2166     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2167     NSPoint dstOrigin = NSMakePoint (x, to_y);
2169     ns_focus (f, &dstRect, 1);
2170     NSCopyBits (0, srcRect , dstOrigin);
2171     ns_unfocus (f);
2172   }
2174   unblock_input ();
2178 static void
2179 ns_after_update_window_line (struct window *w, struct glyph_row *desired_row)
2180 /* --------------------------------------------------------------------------
2181     External (RIF): preparatory to fringe update after text was updated
2182    -------------------------------------------------------------------------- */
2184   struct frame *f;
2185   int width, height;
2187   NSTRACE (ns_after_update_window_line);
2189   /* begin copy from other terms */
2190   eassert (w);
2192   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2193     desired_row->redraw_fringe_bitmaps_p = 1;
2195   /* When a window has disappeared, make sure that no rest of
2196      full-width rows stays visible in the internal border.  */
2197   if (windows_or_buffers_changed
2198       && desired_row->full_width_p
2199       && (f = XFRAME (w->frame),
2200           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2201           width != 0)
2202       && (height = desired_row->visible_height,
2203           height > 0))
2204     {
2205       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2207       block_input ();
2208       ns_clear_frame_area (f, 0, y, width, height);
2209       ns_clear_frame_area (f,
2210                            FRAME_PIXEL_WIDTH (f) - width,
2211                            y, width, height);
2212       unblock_input ();
2213     }
2217 static void
2218 ns_shift_glyphs_for_insert (struct frame *f,
2219                            int x, int y, int width, int height,
2220                            int shift_by)
2221 /* --------------------------------------------------------------------------
2222     External (RIF): copy an area horizontally, don't worry about clearing src
2223    -------------------------------------------------------------------------- */
2225   NSRect srcRect = NSMakeRect (x, y, width, height);
2226   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2227   NSPoint dstOrigin = dstRect.origin;
2229   NSTRACE (ns_shift_glyphs_for_insert);
2231   ns_focus (f, &dstRect, 1);
2232   NSCopyBits (0, srcRect, dstOrigin);
2233   ns_unfocus (f);
2238 /* ==========================================================================
2240     Character encoding and metrics
2242    ========================================================================== */
2245 static void
2246 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2247 /* --------------------------------------------------------------------------
2248      External (RIF); compute left/right overhang of whole string and set in s
2249    -------------------------------------------------------------------------- */
2251   struct font *font = s->font;
2253   if (s->char2b)
2254     {
2255       struct font_metrics metrics;
2256       unsigned int codes[2];
2257       codes[0] = *(s->char2b);
2258       codes[1] = *(s->char2b + s->nchars - 1);
2260       font->driver->text_extents (font, codes, 2, &metrics);
2261       s->left_overhang = -metrics.lbearing;
2262       s->right_overhang
2263         = metrics.rbearing > metrics.width
2264         ? metrics.rbearing - metrics.width : 0;
2265     }
2266   else
2267     {
2268       s->left_overhang = 0;
2269       if (EQ (font->driver->type, Qns))
2270         s->right_overhang = ((struct nsfont_info *)font)->ital ?
2271           FONT_HEIGHT (font) * 0.2 : 0;
2272       else
2273         s->right_overhang = 0;
2274     }
2279 /* ==========================================================================
2281     Fringe and cursor drawing
2283    ========================================================================== */
2286 extern int max_used_fringe_bitmap;
2287 static void
2288 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2289                       struct draw_fringe_bitmap_params *p)
2290 /* --------------------------------------------------------------------------
2291     External (RIF); fringe-related
2292    -------------------------------------------------------------------------- */
2294   struct frame *f = XFRAME (WINDOW_FRAME (w));
2295   struct face *face = p->face;
2296   static EmacsImage **bimgs = NULL;
2297   static int nBimgs = 0;
2299   /* grow bimgs if needed */
2300   if (nBimgs < max_used_fringe_bitmap)
2301     {
2302       bimgs = xrealloc (bimgs, max_used_fringe_bitmap * sizeof *bimgs);
2303       memset (bimgs + nBimgs, 0,
2304               (max_used_fringe_bitmap - nBimgs) * sizeof *bimgs);
2305       nBimgs = max_used_fringe_bitmap;
2306     }
2308   /* Must clip because of partially visible lines.  */
2309   ns_clip_to_row (w, row, ANY_AREA, YES);
2311   if (!p->overlay_p)
2312     {
2313       int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
2315       if (bx >= 0 && nx > 0)
2316         {
2317           NSRect r = NSMakeRect (bx, by, nx, ny);
2318           NSRectClip (r);
2319           [ns_lookup_indexed_color (face->background, f) set];
2320           NSRectFill (r);
2321         }
2322     }
2324   if (p->which)
2325     {
2326       NSRect r = NSMakeRect (p->x, p->y, p->wd, p->h);
2327       EmacsImage *img = bimgs[p->which - 1];
2329       if (!img)
2330         {
2331           unsigned short *bits = p->bits + p->dh;
2332           int len = p->h;
2333           int i;
2334           unsigned char *cbits = xmalloc (len);
2336           for (i = 0; i < len; i++)
2337             cbits[i] = ~(bits[i] & 0xff);
2338           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2339                                            flip: NO];
2340           bimgs[p->which - 1] = img;
2341           xfree (cbits);
2342         }
2344       NSRectClip (r);
2345       /* Since we composite the bitmap instead of just blitting it, we need
2346          to erase the whole background. */
2347       [ns_lookup_indexed_color(face->background, f) set];
2348       NSRectFill (r);
2350       {
2351         NSColor *bm_color;
2352         if (!p->cursor_p)
2353           bm_color = ns_lookup_indexed_color(face->foreground, f);
2354         else if (p->overlay_p)
2355           bm_color = ns_lookup_indexed_color(face->background, f);
2356         else
2357           bm_color = f->output_data.ns->cursor_color;
2358         [img setXBMColor: bm_color];
2359       }
2361 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
2362       [img drawInRect: r
2363               fromRect: NSZeroRect
2364              operation: NSCompositeSourceOver
2365               fraction: 1.0
2366            respectFlipped: YES
2367                 hints: nil];
2368 #else
2369       {
2370         NSPoint pt = r.origin;
2371         pt.y += p->h;
2372         [img compositeToPoint: pt operation: NSCompositeSourceOver];
2373       }
2374 #endif
2375     }
2376   ns_unfocus (f);
2380 static void
2381 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2382                        int x, int y, enum text_cursor_kinds cursor_type,
2383                        int cursor_width, bool on_p, bool active_p)
2384 /* --------------------------------------------------------------------------
2385      External call (RIF): draw cursor.
2386      Note that CURSOR_WIDTH is meaningful only for (h)bar cursors.
2387    -------------------------------------------------------------------------- */
2389   NSRect r, s;
2390   int fx, fy, h, cursor_height;
2391   struct frame *f = WINDOW_XFRAME (w);
2392   struct glyph *phys_cursor_glyph;
2393   struct glyph *cursor_glyph;
2394   struct face *face;
2395   NSColor *hollow_color = FRAME_BACKGROUND_COLOR (f);
2397   /* If cursor is out of bounds, don't draw garbage.  This can happen
2398      in mini-buffer windows when switching between echo area glyphs
2399      and mini-buffer.  */
2401   NSTRACE (dumpcursor);
2403   if (!on_p)
2404     return;
2406   w->phys_cursor_type = cursor_type;
2407   w->phys_cursor_on_p = on_p;
2409   if (cursor_type == NO_CURSOR)
2410     {
2411       w->phys_cursor_width = 0;
2412       return;
2413     }
2415   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2416     {
2417       if (glyph_row->exact_window_width_line_p
2418           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2419         {
2420           glyph_row->cursor_in_fringe_p = 1;
2421           draw_fringe_bitmap (w, glyph_row, 0);
2422         }
2423       return;
2424     }
2426   /* We draw the cursor (with NSRectFill), then draw the glyph on top
2427      (other terminals do it the other way round).  We must set
2428      w->phys_cursor_width to the cursor width.  For bar cursors, that
2429      is CURSOR_WIDTH; for box cursors, it is the glyph width.  */
2430   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2432   /* The above get_phys_cursor_geometry call set w->phys_cursor_width
2433      to the glyph width; replace with CURSOR_WIDTH for (V)BAR cursors. */
2434   if (cursor_type == BAR_CURSOR)
2435     {
2436       if (cursor_width < 1)
2437         cursor_width = max (FRAME_CURSOR_WIDTH (f), 1);
2438       w->phys_cursor_width = cursor_width;
2439     }
2440   /* If we have an HBAR, "cursor_width" MAY specify height. */
2441   else if (cursor_type == HBAR_CURSOR)
2442     {
2443       cursor_height = (cursor_width < 1) ? lrint (0.25 * h) : cursor_width;
2444       if (cursor_height > glyph_row->height)
2445         cursor_height = glyph_row->height;
2446       if (h > cursor_height) // Cursor smaller than line height, move down
2447         fy += h - cursor_height;
2448       h = cursor_height;
2449     }
2451   r.origin.x = fx, r.origin.y = fy;
2452   r.size.height = h;
2453   r.size.width = w->phys_cursor_width;
2455   /* TODO: only needed in rare cases with last-resort font in HELLO..
2456      should we do this more efficiently? */
2457   ns_clip_to_row (w, glyph_row, ANY_AREA, NO); /* do ns_focus(f, &r, 1); if remove */
2460   face = FACE_FROM_ID (f, phys_cursor_glyph->face_id);
2461   if (face && NS_FACE_BACKGROUND (face)
2462       == ns_index_color (FRAME_CURSOR_COLOR (f), f))
2463     {
2464       [ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), f) set];
2465       hollow_color = FRAME_CURSOR_COLOR (f);
2466     }
2467   else
2468     [FRAME_CURSOR_COLOR (f) set];
2470 #ifdef NS_IMPL_COCOA
2471   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2472            atomic.  Cleaner ways of doing this should be investigated.
2473            One way would be to set a global variable DRAWING_CURSOR
2474            when making the call to draw_phys..(), don't focus in that
2475            case, then move the ns_unfocus() here after that call. */
2476   NSDisableScreenUpdates ();
2477 #endif
2479   switch (cursor_type)
2480     {
2481     case NO_CURSOR:
2482       break;
2483     case FILLED_BOX_CURSOR:
2484       NSRectFill (r);
2485       break;
2486     case HOLLOW_BOX_CURSOR:
2487       NSRectFill (r);
2488       [hollow_color set];
2489       NSRectFill (NSInsetRect (r, 1, 1));
2490       [FRAME_CURSOR_COLOR (f) set];
2491       break;
2492     case HBAR_CURSOR:
2493       NSRectFill (r);
2494       break;
2495     case BAR_CURSOR:
2496       s = r;
2497       /* If the character under cursor is R2L, draw the bar cursor
2498          on the right of its glyph, rather than on the left.  */
2499       cursor_glyph = get_phys_cursor_glyph (w);
2500       if ((cursor_glyph->resolved_level & 1) != 0)
2501         s.origin.x += cursor_glyph->pixel_width - s.size.width;
2503       NSRectFill (s);
2504       break;
2505     }
2506   ns_unfocus (f);
2508   /* draw the character under the cursor */
2509   if (cursor_type != NO_CURSOR)
2510     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2512 #ifdef NS_IMPL_COCOA
2513   NSEnableScreenUpdates ();
2514 #endif
2519 static void
2520 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2521 /* --------------------------------------------------------------------------
2522      External (RIF): Draw a vertical line.
2523    -------------------------------------------------------------------------- */
2525   struct frame *f = XFRAME (WINDOW_FRAME (w));
2526   struct face *face;
2527   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2529   NSTRACE (ns_draw_vertical_window_border);
2531   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2532   if (face)
2533       [ns_lookup_indexed_color(face->foreground, f) set];
2535   ns_focus (f, &r, 1);
2536   NSRectFill(r);
2537   ns_unfocus (f);
2541 static void
2542 ns_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
2543 /* --------------------------------------------------------------------------
2544      External (RIF): Draw a window divider.
2545    -------------------------------------------------------------------------- */
2547   struct frame *f = XFRAME (WINDOW_FRAME (w));
2548   struct face *face;
2549   NSRect r = NSMakeRect (x0, y0, x1-x0, y1-y0);
2551   NSTRACE (ns_draw_window_divider);
2553   face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
2554   if (face)
2555       [ns_lookup_indexed_color(face->foreground, f) set];
2557   ns_focus (f, &r, 1);
2558   NSRectFill(r);
2559   ns_unfocus (f);
2562 static void
2563 ns_show_hourglass (struct frame *f)
2565   /* TODO: add NSProgressIndicator to all frames.  */
2568 static void
2569 ns_hide_hourglass (struct frame *f)
2571   /* TODO: remove NSProgressIndicator from all frames.  */
2574 /* ==========================================================================
2576     Glyph drawing operations
2578    ========================================================================== */
2580 static int
2581 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2582 /* --------------------------------------------------------------------------
2583     Wrapper utility to account for internal border width on full-width lines,
2584     and allow top full-width rows to hit the frame top.  nr should be pointer
2585     to two successive NSRects.  Number of rects actually used is returned.
2586    -------------------------------------------------------------------------- */
2588   int n = get_glyph_string_clip_rects (s, nr, 2);
2589   return n;
2592 /* --------------------------------------------------------------------
2593    Draw a wavy line under glyph string s. The wave fills wave_height
2594    pixels from y.
2596                     x          wave_length = 2
2597                                  --
2598                 y    *   *   *   *   *
2599                      |* * * * * * * * *
2600     wave_height = 3  | *   *   *   *
2601   --------------------------------------------------------------------- */
2603 static void
2604 ns_draw_underwave (struct glyph_string *s, EmacsCGFloat width, EmacsCGFloat x)
2606   int wave_height = 3, wave_length = 2;
2607   int y, dx, dy, odd, xmax;
2608   NSPoint a, b;
2609   NSRect waveClip;
2611   dx = wave_length;
2612   dy = wave_height - 1;
2613   y =  s->ybase - wave_height + 3;
2614   xmax = x + width;
2616   /* Find and set clipping rectangle */
2617   waveClip = NSMakeRect (x, y, width, wave_height);
2618   [[NSGraphicsContext currentContext] saveGraphicsState];
2619   NSRectClip (waveClip);
2621   /* Draw the waves */
2622   a.x = x - ((int)(x) % dx) + (EmacsCGFloat) 0.5;
2623   b.x = a.x + dx;
2624   odd = (int)(a.x/dx) % 2;
2625   a.y = b.y = y + 0.5;
2627   if (odd)
2628     a.y += dy;
2629   else
2630     b.y += dy;
2632   while (a.x <= xmax)
2633     {
2634       [NSBezierPath strokeLineFromPoint:a toPoint:b];
2635       a.x = b.x, a.y = b.y;
2636       b.x += dx, b.y = y + 0.5 + odd*dy;
2637       odd = !odd;
2638     }
2640   /* Restore previous clipping rectangle(s) */
2641   [[NSGraphicsContext currentContext] restoreGraphicsState];
2646 void
2647 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
2648                          NSColor *defaultCol, CGFloat width, CGFloat x)
2649 /* --------------------------------------------------------------------------
2650    Draw underline, overline, and strike-through on glyph string s.
2651    -------------------------------------------------------------------------- */
2653   if (s->for_overlaps)
2654     return;
2656   /* Do underline. */
2657   if (face->underline_p)
2658     {
2659       if (s->face->underline_type == FACE_UNDER_WAVE)
2660         {
2661           if (face->underline_defaulted_p)
2662             [defaultCol set];
2663           else
2664             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2666           ns_draw_underwave (s, width, x);
2667         }
2668       else if (s->face->underline_type == FACE_UNDER_LINE)
2669         {
2671           NSRect r;
2672           unsigned long thickness, position;
2674           /* If the prev was underlined, match its appearance. */
2675           if (s->prev && s->prev->face->underline_p
2676               && s->prev->face->underline_type == FACE_UNDER_LINE
2677               && s->prev->underline_thickness > 0)
2678             {
2679               thickness = s->prev->underline_thickness;
2680               position = s->prev->underline_position;
2681             }
2682           else
2683             {
2684               struct font *font;
2685               unsigned long descent;
2687               font=s->font;
2688               descent = s->y + s->height - s->ybase;
2690               /* Use underline thickness of font, defaulting to 1. */
2691               thickness = (font && font->underline_thickness > 0)
2692                 ? font->underline_thickness : 1;
2694               /* Determine the offset of underlining from the baseline. */
2695               if (x_underline_at_descent_line)
2696                 position = descent - thickness;
2697               else if (x_use_underline_position_properties
2698                        && font && font->underline_position >= 0)
2699                 position = font->underline_position;
2700               else if (font)
2701                 position = lround (font->descent / 2);
2702               else
2703                 position = underline_minimum_offset;
2705               position = max (position, underline_minimum_offset);
2707               /* Ensure underlining is not cropped. */
2708               if (descent <= position)
2709                 {
2710                   position = descent - 1;
2711                   thickness = 1;
2712                 }
2713               else if (descent < position + thickness)
2714                 thickness = 1;
2715             }
2717           s->underline_thickness = thickness;
2718           s->underline_position = position;
2720           r = NSMakeRect (x, s->ybase + position, width, thickness);
2722           if (face->underline_defaulted_p)
2723             [defaultCol set];
2724           else
2725             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2726           NSRectFill (r);
2727         }
2728     }
2729   /* Do overline. We follow other terms in using a thickness of 1
2730      and ignoring overline_margin. */
2731   if (face->overline_p)
2732     {
2733       NSRect r;
2734       r = NSMakeRect (x, s->y, width, 1);
2736       if (face->overline_color_defaulted_p)
2737         [defaultCol set];
2738       else
2739         [ns_lookup_indexed_color (face->overline_color, s->f) set];
2740       NSRectFill (r);
2741     }
2743   /* Do strike-through.  We follow other terms for thickness and
2744      vertical position.*/
2745   if (face->strike_through_p)
2746     {
2747       NSRect r;
2748       unsigned long dy;
2750       dy = lrint ((s->height - 1) / 2);
2751       r = NSMakeRect (x, s->y + dy, width, 1);
2753       if (face->strike_through_color_defaulted_p)
2754         [defaultCol set];
2755       else
2756         [ns_lookup_indexed_color (face->strike_through_color, s->f) set];
2757       NSRectFill (r);
2758     }
2761 static void
2762 ns_draw_box (NSRect r, CGFloat thickness, NSColor *col,
2763              char left_p, char right_p)
2764 /* --------------------------------------------------------------------------
2765     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2766     Note we can't just use an NSDrawRect command, because of the possibility
2767     of some sides not being drawn, and because the rect will be filled.
2768    -------------------------------------------------------------------------- */
2770   NSRect s = r;
2771   [col set];
2773   /* top, bottom */
2774   s.size.height = thickness;
2775   NSRectFill (s);
2776   s.origin.y += r.size.height - thickness;
2777   NSRectFill (s);
2779   s.size.height = r.size.height;
2780   s.origin.y = r.origin.y;
2782   /* left, right (optional) */
2783   s.size.width = thickness;
2784   if (left_p)
2785     NSRectFill (s);
2786   if (right_p)
2787     {
2788       s.origin.x += r.size.width - thickness;
2789       NSRectFill (s);
2790     }
2794 static void
2795 ns_draw_relief (NSRect r, int thickness, char raised_p,
2796                char top_p, char bottom_p, char left_p, char right_p,
2797                struct glyph_string *s)
2798 /* --------------------------------------------------------------------------
2799     Draw a relief rect inside r, optionally leaving some sides open.
2800     Note we can't just use an NSDrawBezel command, because of the possibility
2801     of some sides not being drawn, and because the rect will be filled.
2802    -------------------------------------------------------------------------- */
2804   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2805   NSColor *newBaseCol = nil;
2806   NSRect sr = r;
2808   NSTRACE (ns_draw_relief);
2810   /* set up colors */
2812   if (s->face->use_box_color_for_shadows_p)
2813     {
2814       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2815     }
2816 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2817            && s->img->pixmap
2818            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2819        {
2820          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2821        } */
2822   else
2823     {
2824       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2825     }
2827   if (newBaseCol == nil)
2828     newBaseCol = [NSColor grayColor];
2830   if (newBaseCol != baseCol)  /* TODO: better check */
2831     {
2832       [baseCol release];
2833       baseCol = [newBaseCol retain];
2834       [lightCol release];
2835       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2836       [darkCol release];
2837       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2838     }
2840   [(raised_p ? lightCol : darkCol) set];
2842   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2844   /* top */
2845   sr.size.height = thickness;
2846   if (top_p) NSRectFill (sr);
2848   /* left */
2849   sr.size.height = r.size.height;
2850   sr.size.width = thickness;
2851   if (left_p) NSRectFill (sr);
2853   [(raised_p ? darkCol : lightCol) set];
2855   /* bottom */
2856   sr.size.width = r.size.width;
2857   sr.size.height = thickness;
2858   sr.origin.y += r.size.height - thickness;
2859   if (bottom_p) NSRectFill (sr);
2861   /* right */
2862   sr.size.height = r.size.height;
2863   sr.origin.y = r.origin.y;
2864   sr.size.width = thickness;
2865   sr.origin.x += r.size.width - thickness;
2866   if (right_p) NSRectFill (sr);
2870 static void
2871 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2872 /* --------------------------------------------------------------------------
2873       Function modeled after x_draw_glyph_string_box ().
2874       Sets up parameters for drawing.
2875    -------------------------------------------------------------------------- */
2877   int right_x, last_x;
2878   char left_p, right_p;
2879   struct glyph *last_glyph;
2880   NSRect r;
2881   int thickness;
2882   struct face *face;
2884   if (s->hl == DRAW_MOUSE_FACE)
2885     {
2886       face = FACE_FROM_ID (s->f, MOUSE_HL_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 = s->face;
2893   thickness = face->box_line_width;
2895   NSTRACE (ns_dumpglyphs_box_or_relief);
2897   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2898             ? WINDOW_RIGHT_EDGE_X (s->w)
2899             : window_box_right (s->w, s->area));
2900   last_glyph = (s->cmp || s->img
2901                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2903   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2904               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2906   left_p = (s->first_glyph->left_box_line_p
2907             || (s->hl == DRAW_MOUSE_FACE
2908                 && (s->prev == NULL || s->prev->hl != s->hl)));
2909   right_p = (last_glyph->right_box_line_p
2910              || (s->hl == DRAW_MOUSE_FACE
2911                  && (s->next == NULL || s->next->hl != s->hl)));
2913   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2915   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2916   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2917     {
2918       ns_draw_box (r, abs (thickness),
2919                    ns_lookup_indexed_color (face->box_color, s->f),
2920                   left_p, right_p);
2921     }
2922   else
2923     {
2924       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2925                      1, 1, left_p, right_p, s);
2926     }
2930 static void
2931 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2932 /* --------------------------------------------------------------------------
2933       Modeled after x_draw_glyph_string_background, which draws BG in
2934       certain cases.  Others are left to the text rendering routine.
2935    -------------------------------------------------------------------------- */
2937   NSTRACE (ns_maybe_dumpglyphs_background);
2939   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2940     {
2941       int box_line_width = max (s->face->box_line_width, 0);
2942       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2943           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2944         {
2945           struct face *face;
2946           if (s->hl == DRAW_MOUSE_FACE)
2947             {
2948               face = FACE_FROM_ID (s->f,
2949                                    MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2950               if (!face)
2951                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2952             }
2953           else
2954             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2955           if (!face->stipple)
2956             [(NS_FACE_BACKGROUND (face) != 0
2957               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2958               : FRAME_BACKGROUND_COLOR (s->f)) set];
2959           else
2960             {
2961               struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (s->f);
2962               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2963             }
2965           if (s->hl != DRAW_CURSOR)
2966             {
2967               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2968                                     s->background_width,
2969                                     s->height-2*box_line_width);
2970               NSRectFill (r);
2971             }
2973           s->background_filled_p = 1;
2974         }
2975     }
2979 static void
2980 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2981 /* --------------------------------------------------------------------------
2982       Renders an image and associated borders.
2983    -------------------------------------------------------------------------- */
2985   EmacsImage *img = s->img->pixmap;
2986   int box_line_vwidth = max (s->face->box_line_width, 0);
2987   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2988   int bg_x, bg_y, bg_height;
2989   int th;
2990   char raised_p;
2991   NSRect br;
2992   struct face *face;
2993   NSColor *tdCol;
2995   NSTRACE (ns_dumpglyphs_image);
2997   if (s->face->box != FACE_NO_BOX
2998       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2999     x += abs (s->face->box_line_width);
3001   bg_x = x;
3002   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
3003   bg_height = s->height;
3004   /* other terms have this, but was causing problems w/tabbar mode */
3005   /* - 2 * box_line_vwidth; */
3007   if (s->slice.x == 0) x += s->img->hmargin;
3008   if (s->slice.y == 0) y += s->img->vmargin;
3010   /* Draw BG: if we need larger area than image itself cleared, do that,
3011      otherwise, since we composite the image under NS (instead of mucking
3012      with its background color), we must clear just the image area. */
3013   if (s->hl == DRAW_MOUSE_FACE)
3014     {
3015       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3016       if (!face)
3017        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3018     }
3019   else
3020     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3022   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
3024   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
3025       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
3026     {
3027       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
3028       s->background_filled_p = 1;
3029     }
3030   else
3031     {
3032       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
3033     }
3035   NSRectFill (br);
3037   /* Draw the image.. do we need to draw placeholder if img ==nil? */
3038   if (img != nil)
3039     {
3040 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
3041       NSRect dr = NSMakeRect (x, y, s->slice.width, s->slice.height);
3042       NSRect ir = NSMakeRect (s->slice.x, s->slice.y,
3043                               s->slice.width, s->slice.height);
3044       [img drawInRect: dr
3045              fromRect: ir
3046              operation: NSCompositeSourceOver
3047               fraction: 1.0
3048            respectFlipped: YES
3049                 hints: nil];
3050 #else
3051       [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
3052                   operation: NSCompositeSourceOver];
3053 #endif
3054     }
3056   if (s->hl == DRAW_CURSOR)
3057     {
3058     [FRAME_CURSOR_COLOR (s->f) set];
3059     if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3060       tdCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3061     else
3062       /* Currently on NS img->mask is always 0. Since
3063          get_window_cursor_type specifies a hollow box cursor when on
3064          a non-masked image we never reach this clause. But we put it
3065          in in anticipation of better support for image masks on
3066          NS. */
3067       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3068     }
3069   else
3070     {
3071       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3072     }
3074   /* Draw underline, overline, strike-through. */
3075   ns_draw_text_decoration (s, face, tdCol, br.size.width, br.origin.x);
3077   /* Draw relief, if requested */
3078   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
3079     {
3080       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
3081         {
3082           th = tool_bar_button_relief >= 0 ?
3083             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
3084           raised_p = (s->hl == DRAW_IMAGE_RAISED);
3085         }
3086       else
3087         {
3088           th = abs (s->img->relief);
3089           raised_p = (s->img->relief > 0);
3090         }
3092       r.origin.x = x - th;
3093       r.origin.y = y - th;
3094       r.size.width = s->slice.width + 2*th-1;
3095       r.size.height = s->slice.height + 2*th-1;
3096       ns_draw_relief (r, th, raised_p,
3097                       s->slice.y == 0,
3098                       s->slice.y + s->slice.height == s->img->height,
3099                       s->slice.x == 0,
3100                       s->slice.x + s->slice.width == s->img->width, s);
3101     }
3103   /* If there is no mask, the background won't be seen,
3104      so draw a rectangle on the image for the cursor.
3105      Do this for all images, getting transparency right is not reliable.  */
3106   if (s->hl == DRAW_CURSOR)
3107     {
3108       int thickness = abs (s->img->relief);
3109       if (thickness == 0) thickness = 1;
3110       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
3111     }
3115 static void
3116 ns_dumpglyphs_stretch (struct glyph_string *s)
3118   NSRect r[2];
3119   int n, i;
3120   struct face *face;
3121   NSColor *fgCol, *bgCol;
3123   if (!s->background_filled_p)
3124     {
3125       n = ns_get_glyph_string_clip_rect (s, r);
3126       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
3128       ns_focus (s->f, r, n);
3130       if (s->hl == DRAW_MOUSE_FACE)
3131        {
3132          face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3133          if (!face)
3134            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3135        }
3136       else
3137        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3139       bgCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3140       fgCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3142       for (i = 0; i < n; ++i)
3143         {
3144           if (!s->row->full_width_p)
3145             {
3146               int overrun, leftoverrun;
3148               /* truncate to avoid overwriting fringe and/or scrollbar */
3149               overrun = max (0, (s->x + s->background_width)
3150                              - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
3151                                 - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
3152               r[i].size.width -= overrun;
3154               /* truncate to avoid overwriting to left of the window box */
3155               leftoverrun = (WINDOW_BOX_LEFT_EDGE_X (s->w)
3156                              + WINDOW_LEFT_FRINGE_WIDTH (s->w)) - s->x;
3158               if (leftoverrun > 0)
3159                 {
3160                   r[i].origin.x += leftoverrun;
3161                   r[i].size.width -= leftoverrun;
3162                 }
3164               /* XXX: Try to work between problem where a stretch glyph on
3165                  a partially-visible bottom row will clear part of the
3166                  modeline, and another where list-buffers headers and similar
3167                  rows erroneously have visible_height set to 0.  Not sure
3168                  where this is coming from as other terms seem not to show. */
3169               r[i].size.height = min (s->height, s->row->visible_height);
3170             }
3172           [bgCol set];
3174           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
3175              overwriting cursor (usually when cursor on a tab) */
3176           if (s->hl == DRAW_CURSOR)
3177             {
3178               CGFloat x, width;
3180               x = r[i].origin.x;
3181               width = s->w->phys_cursor_width;
3182               r[i].size.width -= width;
3183               r[i].origin.x += width;
3185               NSRectFill (r[i]);
3187               /* Draw overlining, etc. on the cursor. */
3188               if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3189                 ns_draw_text_decoration (s, face, bgCol, width, x);
3190               else
3191                 ns_draw_text_decoration (s, face, fgCol, width, x);
3192             }
3193           else
3194             {
3195               NSRectFill (r[i]);
3196             }
3198           /* Draw overlining, etc. on the stretch glyph (or the part
3199              of the stretch glyph after the cursor). */
3200           ns_draw_text_decoration (s, face, fgCol, r[i].size.width,
3201                                    r[i].origin.x);
3202         }
3203       ns_unfocus (s->f);
3204       s->background_filled_p = 1;
3205     }
3209 static void
3210 ns_draw_glyph_string (struct glyph_string *s)
3211 /* --------------------------------------------------------------------------
3212       External (RIF): Main draw-text call.
3213    -------------------------------------------------------------------------- */
3215   /* TODO (optimize): focus for box and contents draw */
3216   NSRect r[2];
3217   int n, flags;
3218   char box_drawn_p = 0;
3219   struct font *font = s->face->font;
3220   if (! font) font = FRAME_FONT (s->f);
3222   NSTRACE (ns_draw_glyph_string);
3224   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
3225     {
3226       int width;
3227       struct glyph_string *next;
3229       for (width = 0, next = s->next;
3230            next && width < s->right_overhang;
3231            width += next->width, next = next->next)
3232         if (next->first_glyph->type != IMAGE_GLYPH)
3233           {
3234             if (next->first_glyph->type != STRETCH_GLYPH)
3235               {
3236                 n = ns_get_glyph_string_clip_rect (s->next, r);
3237                 ns_focus (s->f, r, n);
3238                 ns_maybe_dumpglyphs_background (s->next, 1);
3239                 ns_unfocus (s->f);
3240               }
3241             else
3242               {
3243                 ns_dumpglyphs_stretch (s->next);
3244               }
3245             next->num_clips = 0;
3246           }
3247     }
3249   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
3250         && (s->first_glyph->type == CHAR_GLYPH
3251             || s->first_glyph->type == COMPOSITE_GLYPH))
3252     {
3253       n = ns_get_glyph_string_clip_rect (s, r);
3254       ns_focus (s->f, r, n);
3255       ns_maybe_dumpglyphs_background (s, 1);
3256       ns_dumpglyphs_box_or_relief (s);
3257       ns_unfocus (s->f);
3258       box_drawn_p = 1;
3259     }
3261   switch (s->first_glyph->type)
3262     {
3264     case IMAGE_GLYPH:
3265       n = ns_get_glyph_string_clip_rect (s, r);
3266       ns_focus (s->f, r, n);
3267       ns_dumpglyphs_image (s, r[0]);
3268       ns_unfocus (s->f);
3269       break;
3271     case STRETCH_GLYPH:
3272       ns_dumpglyphs_stretch (s);
3273       break;
3275     case CHAR_GLYPH:
3276     case COMPOSITE_GLYPH:
3277       n = ns_get_glyph_string_clip_rect (s, r);
3278       ns_focus (s->f, r, n);
3280       if (s->for_overlaps || (s->cmp_from > 0
3281                               && ! s->first_glyph->u.cmp.automatic))
3282         s->background_filled_p = 1;
3283       else
3284         ns_maybe_dumpglyphs_background
3285           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3287       flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
3288         (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
3289          (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
3290           NS_DUMPGLYPH_NORMAL));
3292       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3293         {
3294           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3295           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3296           NS_FACE_FOREGROUND (s->face) = tmp;
3297         }
3299       {
3300         BOOL isComposite = s->first_glyph->type == COMPOSITE_GLYPH;
3301         int end = isComposite ? s->cmp_to : s->nchars;
3303         font->driver->draw
3304           (s, s->cmp_from, end, s->x, s->ybase,
3305            (flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
3306            || flags == NS_DUMPGLYPH_MOUSEFACE);
3308       }
3310       {
3311         NSColor *col = (NS_FACE_FOREGROUND (s->face) != 0
3312                         ? ns_lookup_indexed_color (NS_FACE_FOREGROUND (s->face),
3313                                                    s->f)
3314                         : FRAME_FOREGROUND_COLOR (s->f));
3315         [col set];
3317         /* Draw underline, overline, strike-through. */
3318         ns_draw_text_decoration (s, s->face, col, s->width, s->x);
3319       }
3321       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3322         {
3323           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3324           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3325           NS_FACE_FOREGROUND (s->face) = tmp;
3326         }
3328       ns_unfocus (s->f);
3329       break;
3331     case GLYPHLESS_GLYPH:
3332       n = ns_get_glyph_string_clip_rect (s, r);
3333       ns_focus (s->f, r, n);
3335       if (s->for_overlaps || (s->cmp_from > 0
3336                               && ! s->first_glyph->u.cmp.automatic))
3337         s->background_filled_p = 1;
3338       else
3339         ns_maybe_dumpglyphs_background
3340           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3341       /* ... */
3342       /* Not yet implemented.  */
3343       /* ... */
3344       ns_unfocus (s->f);
3345       break;
3347     default:
3348       emacs_abort ();
3349     }
3351   /* Draw box if not done already. */
3352   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3353     {
3354       n = ns_get_glyph_string_clip_rect (s, r);
3355       ns_focus (s->f, r, n);
3356       ns_dumpglyphs_box_or_relief (s);
3357       ns_unfocus (s->f);
3358     }
3360   s->num_clips = 0;
3365 /* ==========================================================================
3367     Event loop
3369    ========================================================================== */
3372 static void
3373 ns_send_appdefined (int value)
3374 /* --------------------------------------------------------------------------
3375     Internal: post an appdefined event which EmacsApp-sendEvent will
3376               recognize and take as a command to halt the event loop.
3377    -------------------------------------------------------------------------- */
3379   /*NSTRACE (ns_send_appdefined); */
3381 #ifdef NS_IMPL_GNUSTEP
3382   // GNUstep needs postEvent to happen on the main thread.
3383   if (! [[NSThread currentThread] isMainThread])
3384     {
3385       EmacsApp *app = (EmacsApp *)NSApp;
3386       app->nextappdefined = value;
3387       [app performSelectorOnMainThread:@selector (sendFromMainThread:)
3388                             withObject:nil
3389                          waitUntilDone:YES];
3390       return;
3391     }
3392 #endif
3394   /* Only post this event if we haven't already posted one.  This will end
3395        the [NXApp run] main loop after having processed all events queued at
3396        this moment.  */
3397   if (send_appdefined)
3398     {
3399       NSEvent *nxev;
3401       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3402       send_appdefined = NO;
3404       /* Don't need wakeup timer any more */
3405       if (timed_entry)
3406         {
3407           [timed_entry invalidate];
3408           [timed_entry release];
3409           timed_entry = nil;
3410         }
3412       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3413                                 location: NSMakePoint (0, 0)
3414                            modifierFlags: 0
3415                                timestamp: 0
3416                             windowNumber: [[NSApp mainWindow] windowNumber]
3417                                  context: [NSApp context]
3418                                  subtype: 0
3419                                    data1: value
3420                                    data2: 0];
3422       /* Post an application defined event on the event queue.  When this is
3423          received the [NXApp run] will return, thus having processed all
3424          events which are currently queued.  */
3425       [NSApp postEvent: nxev atStart: NO];
3426     }
3429 #ifdef HAVE_NATIVE_FS
3430 static void
3431 check_native_fs ()
3433   Lisp_Object frame, tail;
3435   if (ns_last_use_native_fullscreen == ns_use_native_fullscreen)
3436     return;
3438   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
3440   FOR_EACH_FRAME (tail, frame)
3441     {
3442       struct frame *f = XFRAME (frame);
3443       if (FRAME_NS_P (f))
3444         {
3445           EmacsView *view = FRAME_NS_VIEW (f);
3446           [view updateCollectionBehavior];
3447         }
3448     }
3450 #endif
3452 /* GNUstep and OSX <= 10.4 does not have cancelTracking.  */
3453 #if defined (NS_IMPL_COCOA) && \
3454   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
3455 /* Check if menu open should be canceled or continued as normal.  */
3456 void
3457 ns_check_menu_open (NSMenu *menu)
3459   /* Click in menu bar? */
3460   NSArray *a = [[NSApp mainMenu] itemArray];
3461   int i;
3462   BOOL found = NO;
3464   if (menu == nil) // Menu tracking ended.
3465     {
3466       if (menu_will_open_state == MENU_OPENING)
3467         menu_will_open_state = MENU_NONE;
3468       return;
3469     }
3471   for (i = 0; ! found && i < [a count]; i++)
3472     found = menu == [[a objectAtIndex:i] submenu];
3473   if (found)
3474     {
3475       if (menu_will_open_state == MENU_NONE && emacs_event)
3476         {
3477           NSEvent *theEvent = [NSApp currentEvent];
3478           struct frame *emacsframe = SELECTED_FRAME ();
3480           [menu cancelTracking];
3481           menu_will_open_state = MENU_PENDING;
3482           emacs_event->kind = MENU_BAR_ACTIVATE_EVENT;
3483           EV_TRAILER (theEvent);
3485           CGEventRef ourEvent = CGEventCreate (NULL);
3486           menu_mouse_point = CGEventGetLocation (ourEvent);
3487           CFRelease (ourEvent);
3488         }
3489       else if (menu_will_open_state == MENU_OPENING)
3490         {
3491           menu_will_open_state = MENU_NONE;
3492         }
3493     }
3496 /* Redo saved menu click if state is MENU_PENDING.  */
3497 void
3498 ns_check_pending_open_menu ()
3500   if (menu_will_open_state == MENU_PENDING)
3501     {
3502       CGEventSourceRef source
3503         = CGEventSourceCreate (kCGEventSourceStateHIDSystemState);
3505       CGEventRef event = CGEventCreateMouseEvent (source,
3506                                                   kCGEventLeftMouseDown,
3507                                                   menu_mouse_point,
3508                                                   kCGMouseButtonLeft);
3509       CGEventSetType (event, kCGEventLeftMouseDown);
3510       CGEventPost (kCGHIDEventTap, event);
3511       CFRelease (event);
3512       CFRelease (source);
3514       menu_will_open_state = MENU_OPENING;
3515     }
3517 #endif /* NS_IMPL_COCOA) && >= MAC_OS_X_VERSION_10_5 */
3519 static void
3520 unwind_apploopnr (Lisp_Object not_used)
3522   --apploopnr;
3523   n_emacs_events_pending = 0;
3524   ns_finish_events ();
3525   q_event_ptr = NULL;
3528 static int
3529 ns_read_socket (struct terminal *terminal, struct input_event *hold_quit)
3530 /* --------------------------------------------------------------------------
3531      External (hook): Post an event to ourself and keep reading events until
3532      we read it back again.  In effect process all events which were waiting.
3533      From 21+ we have to manage the event buffer ourselves.
3534    -------------------------------------------------------------------------- */
3536   struct input_event ev;
3537   int nevents;
3539 /* NSTRACE (ns_read_socket); */
3541 #ifdef HAVE_NATIVE_FS
3542   check_native_fs ();
3543 #endif
3545   if ([NSApp modalWindow] != nil)
3546     return -1;
3548   if (hold_event_q.nr > 0)
3549     {
3550       int i;
3551       for (i = 0; i < hold_event_q.nr; ++i)
3552         kbd_buffer_store_event_hold (&hold_event_q.q[i], hold_quit);
3553       hold_event_q.nr = 0;
3554       return i;
3555     }
3557   block_input ();
3558   n_emacs_events_pending = 0;
3559   ns_init_events (&ev);
3560   q_event_ptr = hold_quit;
3562   /* we manage autorelease pools by allocate/reallocate each time around
3563      the loop; strict nesting is occasionally violated but seems not to
3564      matter.. earlier methods using full nesting caused major memory leaks */
3565   [outerpool release];
3566   outerpool = [[NSAutoreleasePool alloc] init];
3568   /* If have pending open-file requests, attend to the next one of those. */
3569   if (ns_pending_files && [ns_pending_files count] != 0
3570       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3571     {
3572       [ns_pending_files removeObjectAtIndex: 0];
3573     }
3574   /* Deal with pending service requests. */
3575   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3576     && [(EmacsApp *)
3577          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3578                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3579     {
3580       [ns_pending_service_names removeObjectAtIndex: 0];
3581       [ns_pending_service_args removeObjectAtIndex: 0];
3582     }
3583   else
3584     {
3585       ptrdiff_t specpdl_count = SPECPDL_INDEX ();
3586       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3587          to ourself, otherwise [NXApp run] will never exit.  */
3588       send_appdefined = YES;
3589       ns_send_appdefined (-1);
3591       if (++apploopnr != 1)
3592         {
3593           emacs_abort ();
3594         }
3595       record_unwind_protect (unwind_apploopnr, Qt);
3596       [NSApp run];
3597       unbind_to (specpdl_count, Qnil);  /* calls unwind_apploopnr */
3598     }
3600   nevents = n_emacs_events_pending;
3601   n_emacs_events_pending = 0;
3602   ns_finish_events ();
3603   q_event_ptr = NULL;
3604   unblock_input ();
3606   return nevents;
3611 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3612            fd_set *exceptfds, struct timespec const *timeout,
3613            sigset_t const *sigmask)
3614 /* --------------------------------------------------------------------------
3615      Replacement for select, checking for events
3616    -------------------------------------------------------------------------- */
3618   int result;
3619   int t, k, nr = 0;
3620   struct input_event event;
3621   char c;
3623 /*  NSTRACE (ns_select); */
3625 #ifdef HAVE_NATIVE_FS
3626   check_native_fs ();
3627 #endif
3629   if (hold_event_q.nr > 0)
3630     {
3631       /* We already have events pending. */
3632       raise (SIGIO);
3633       errno = EINTR;
3634       return -1;
3635     }
3637   for (k = 0; k < nfds+1; k++)
3638     {
3639       if (readfds && FD_ISSET(k, readfds)) ++nr;
3640       if (writefds && FD_ISSET(k, writefds)) ++nr;
3641     }
3643   if (NSApp == nil
3644       || (timeout && timeout->tv_sec == 0 && timeout->tv_nsec == 0))
3645     return pselect (nfds, readfds, writefds, exceptfds, timeout, sigmask);
3647   [outerpool release];
3648   outerpool = [[NSAutoreleasePool alloc] init];
3651   send_appdefined = YES;
3652   if (nr > 0)
3653     {
3654       pthread_mutex_lock (&select_mutex);
3655       select_nfds = nfds;
3656       select_valid = 0;
3657       if (readfds)
3658         {
3659           select_readfds = *readfds;
3660           select_valid += SELECT_HAVE_READ;
3661         }
3662       if (writefds)
3663         {
3664           select_writefds = *writefds;
3665           select_valid += SELECT_HAVE_WRITE;
3666         }
3668       if (timeout)
3669         {
3670           select_timeout = *timeout;
3671           select_valid += SELECT_HAVE_TMO;
3672         }
3674       pthread_mutex_unlock (&select_mutex);
3676       /* Inform fd_handler that select should be called */
3677       c = 'g';
3678       emacs_write_sig (selfds[1], &c, 1);
3679     }
3680   else if (nr == 0 && timeout)
3681     {
3682       /* No file descriptor, just a timeout, no need to wake fd_handler  */
3683       double time = timespectod (*timeout);
3684       timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3685                                                       target: NSApp
3686                                                     selector:
3687                                   @selector (timeout_handler:)
3688                                                     userInfo: 0
3689                                                      repeats: NO]
3690                       retain];
3691     }
3692   else /* No timeout and no file descriptors, can this happen?  */
3693     {
3694       /* Send appdefined so we exit from the loop */
3695       ns_send_appdefined (-1);
3696     }
3698   block_input ();
3699   ns_init_events (&event);
3700   if (++apploopnr != 1)
3701     {
3702       emacs_abort ();
3703     }
3705   {
3706     ptrdiff_t specpdl_count = SPECPDL_INDEX ();
3707     record_unwind_protect (unwind_apploopnr, Qt);
3708     [NSApp run];
3709     unbind_to (specpdl_count, Qnil);  /* calls unwind_apploopnr */
3710   }
3712   ns_finish_events ();
3713   if (nr > 0 && readfds)
3714     {
3715       c = 's';
3716       emacs_write_sig (selfds[1], &c, 1);
3717     }
3718   unblock_input ();
3720   t = last_appdefined_event_data;
3722   if (t != NO_APPDEFINED_DATA)
3723     {
3724       last_appdefined_event_data = NO_APPDEFINED_DATA;
3726       if (t == -2)
3727         {
3728           /* The NX_APPDEFINED event we received was a timeout. */
3729           result = 0;
3730         }
3731       else if (t == -1)
3732         {
3733           /* The NX_APPDEFINED event we received was the result of
3734              at least one real input event arriving.  */
3735           errno = EINTR;
3736           result = -1;
3737         }
3738       else
3739         {
3740           /* Received back from select () in fd_handler; copy the results */
3741           pthread_mutex_lock (&select_mutex);
3742           if (readfds) *readfds = select_readfds;
3743           if (writefds) *writefds = select_writefds;
3744           pthread_mutex_unlock (&select_mutex);
3745           result = t;
3746         }
3747     }
3748   else
3749     {
3750       errno = EINTR;
3751       result = -1;
3752     }
3754   return result;
3759 /* ==========================================================================
3761     Scrollbar handling
3763    ========================================================================== */
3766 static void
3767 ns_set_vertical_scroll_bar (struct window *window,
3768                            int portion, int whole, int position)
3769 /* --------------------------------------------------------------------------
3770       External (hook): Update or add scrollbar
3771    -------------------------------------------------------------------------- */
3773   Lisp_Object win;
3774   NSRect r, v;
3775   struct frame *f = XFRAME (WINDOW_FRAME (window));
3776   EmacsView *view = FRAME_NS_VIEW (f);
3777   EmacsScroller *bar;
3778   int window_y, window_height;
3779   int top, left, height, width;
3781   /* optimization; display engine sends WAY too many of these.. */
3782   if (!NILP (window->vertical_scroll_bar))
3783     {
3784       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3785       if ([bar checkSamePosition: position portion: portion whole: whole])
3786         {
3787           if (view->scrollbarsNeedingUpdate == 0)
3788             {
3789               if (!windows_or_buffers_changed)
3790                   return;
3791             }
3792           else
3793             view->scrollbarsNeedingUpdate--;
3794         }
3795     }
3797   NSTRACE (ns_set_vertical_scroll_bar);
3799   /* Get dimensions.  */
3800   window_box (window, ANY_AREA, 0, &window_y, 0, &window_height);
3801   top = window_y;
3802   height = window_height;
3803   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3804   left = WINDOW_SCROLL_BAR_AREA_X (window);
3806   r = NSMakeRect (left, top, width, height);
3807   /* the parent view is flipped, so we need to flip y value */
3808   v = [view frame];
3809   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3811   XSETWINDOW (win, window);
3812   block_input ();
3814   /* we want at least 5 lines to display a scrollbar */
3815   if (WINDOW_TOTAL_LINES (window) < 5)
3816     {
3817       if (!NILP (window->vertical_scroll_bar))
3818         {
3819           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3820           [bar removeFromSuperview];
3821           wset_vertical_scroll_bar (window, Qnil);
3822         }
3823       ns_clear_frame_area (f, left, top, width, height);
3824       unblock_input ();
3825       return;
3826     }
3828   if (NILP (window->vertical_scroll_bar))
3829     {
3830       if (width > 0 && height > 0)
3831         ns_clear_frame_area (f, left, top, width, height);
3833       bar = [[EmacsScroller alloc] initFrame: r window: win];
3834       wset_vertical_scroll_bar (window, make_save_ptr (bar));
3835     }
3836   else
3837     {
3838       NSRect oldRect;
3839       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3840       oldRect = [bar frame];
3841       r.size.width = oldRect.size.width;
3842       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3843         {
3844           if (oldRect.origin.x != r.origin.x)
3845               ns_clear_frame_area (f, left, top, width, height);
3846           [bar setFrame: r];
3847         }
3848     }
3850   [bar setPosition: position portion: portion whole: whole];
3851   unblock_input ();
3855 static void
3856 ns_set_horizontal_scroll_bar (struct window *window,
3857                               int portion, int whole, int position)
3858 /* --------------------------------------------------------------------------
3859       External (hook): Update or add scrollbar
3860    -------------------------------------------------------------------------- */
3862   Lisp_Object win;
3863   NSRect r, v;
3864   struct frame *f = XFRAME (WINDOW_FRAME (window));
3865   EmacsView *view = FRAME_NS_VIEW (f);
3866   EmacsScroller *bar;
3867   int top, height, left, width;
3868   int window_x, window_width;
3869   int pixel_width = WINDOW_PIXEL_WIDTH (window);
3871   /* optimization; display engine sends WAY too many of these.. */
3872   if (!NILP (window->horizontal_scroll_bar))
3873     {
3874       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3875       if ([bar checkSamePosition: position portion: portion whole: whole])
3876         {
3877           if (view->scrollbarsNeedingUpdate == 0)
3878             {
3879               if (!windows_or_buffers_changed)
3880                   return;
3881             }
3882           else
3883             view->scrollbarsNeedingUpdate--;
3884         }
3885     }
3887   NSTRACE (ns_set_horizontal_scroll_bar);
3889   /* Get dimensions.  */
3890   window_box (window, ANY_AREA, 0, &window_x, &window_width, 0);
3891   left = window_x;
3892   width = window_width;
3893   height = WINDOW_CONFIG_SCROLL_BAR_LINES (window) * FRAME_LINE_HEIGHT (f);
3894   top = WINDOW_SCROLL_BAR_AREA_Y (window);
3896   r = NSMakeRect (left, top, width, height);
3897   /* the parent view is flipped, so we need to flip y value */
3898   v = [view frame];
3899   /* ??????? PXW/scrollbars !!!!!!!!!!!!!!!!!!!! */
3900   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3902   XSETWINDOW (win, window);
3903   block_input ();
3905   if (WINDOW_TOTAL_COLS (window) < 5)
3906     {
3907       if (!NILP (window->horizontal_scroll_bar))
3908         {
3909           bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3910           [bar removeFromSuperview];
3911           wset_horizontal_scroll_bar (window, Qnil);
3912         }
3913       ns_clear_frame_area (f, left, top, width, height);
3914       unblock_input ();
3915       return;
3916     }
3918   if (NILP (window->horizontal_scroll_bar))
3919     {
3920       if (width > 0 && height > 0)
3921         ns_clear_frame_area (f, left, top, width, height);
3923       bar = [[EmacsScroller alloc] initFrame: r window: win];
3924       wset_horizontal_scroll_bar (window, make_save_ptr (bar));
3925     }
3926   else
3927     {
3928       NSRect oldRect;
3929       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3930       oldRect = [bar frame];
3931       r.size.width = oldRect.size.width;
3932       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3933         {
3934           if (oldRect.origin.x != r.origin.x)
3935               ns_clear_frame_area (f, left, top, width, height);
3936           [bar setFrame: r];
3937         }
3938     }
3940   [bar setPosition: position portion: portion whole: whole];
3941   unblock_input ();
3945 static void
3946 ns_condemn_scroll_bars (struct frame *f)
3947 /* --------------------------------------------------------------------------
3948      External (hook): arrange for all frame's scrollbars to be removed
3949      at next call to judge_scroll_bars, except for those redeemed.
3950    -------------------------------------------------------------------------- */
3952   int i;
3953   id view;
3954   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3956   NSTRACE (ns_condemn_scroll_bars);
3958   for (i =[subviews count]-1; i >= 0; i--)
3959     {
3960       view = [subviews objectAtIndex: i];
3961       if ([view isKindOfClass: [EmacsScroller class]])
3962         [view condemn];
3963     }
3967 static void
3968 ns_redeem_scroll_bar (struct window *window)
3969 /* --------------------------------------------------------------------------
3970      External (hook): arrange to spare this window's scrollbar
3971      at next call to judge_scroll_bars.
3972    -------------------------------------------------------------------------- */
3974   id bar;
3975   NSTRACE (ns_redeem_scroll_bar);
3976   if (!NILP (window->vertical_scroll_bar))
3977     {
3978       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3979       [bar reprieve];
3980     }
3982   if (!NILP (window->horizontal_scroll_bar))
3983     {
3984       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3985       [bar reprieve];
3986     }
3990 static void
3991 ns_judge_scroll_bars (struct frame *f)
3992 /* --------------------------------------------------------------------------
3993      External (hook): destroy all scrollbars on frame that weren't
3994      redeemed after call to condemn_scroll_bars.
3995    -------------------------------------------------------------------------- */
3997   int i;
3998   id view;
3999   EmacsView *eview = FRAME_NS_VIEW (f);
4000   NSArray *subviews = [[eview superview] subviews];
4001   BOOL removed = NO;
4003   NSTRACE (ns_judge_scroll_bars);
4004   for (i = [subviews count]-1; i >= 0; --i)
4005     {
4006       view = [subviews objectAtIndex: i];
4007       if (![view isKindOfClass: [EmacsScroller class]]) continue;
4008       [view judge];
4009       removed = YES;
4010     }
4012   if (removed)
4013     [eview updateFrameSize: NO];
4016 /* ==========================================================================
4018     Initialization
4020    ========================================================================== */
4023 x_display_pixel_height (struct ns_display_info *dpyinfo)
4025   NSArray *screens = [NSScreen screens];
4026   NSEnumerator *enumerator = [screens objectEnumerator];
4027   NSScreen *screen;
4028   NSRect frame;
4030   frame = NSZeroRect;
4031   while ((screen = [enumerator nextObject]) != nil)
4032     frame = NSUnionRect (frame, [screen frame]);
4034   return NSHeight (frame);
4038 x_display_pixel_width (struct ns_display_info *dpyinfo)
4040   NSArray *screens = [NSScreen screens];
4041   NSEnumerator *enumerator = [screens objectEnumerator];
4042   NSScreen *screen;
4043   NSRect frame;
4045   frame = NSZeroRect;
4046   while ((screen = [enumerator nextObject]) != nil)
4047     frame = NSUnionRect (frame, [screen frame]);
4049   return NSWidth (frame);
4053 static Lisp_Object ns_string_to_lispmod (const char *s)
4054 /* --------------------------------------------------------------------------
4055      Convert modifier name to lisp symbol
4056    -------------------------------------------------------------------------- */
4058   if (!strncmp (SSDATA (SYMBOL_NAME (Qmeta)), s, 10))
4059     return Qmeta;
4060   else if (!strncmp (SSDATA (SYMBOL_NAME (Qsuper)), s, 10))
4061     return Qsuper;
4062   else if (!strncmp (SSDATA (SYMBOL_NAME (Qcontrol)), s, 10))
4063     return Qcontrol;
4064   else if (!strncmp (SSDATA (SYMBOL_NAME (Qalt)), s, 10))
4065     return Qalt;
4066   else if (!strncmp (SSDATA (SYMBOL_NAME (Qhyper)), s, 10))
4067     return Qhyper;
4068   else if (!strncmp (SSDATA (SYMBOL_NAME (Qnone)), s, 10))
4069     return Qnone;
4070   else
4071     return Qnil;
4075 static void
4076 ns_default (const char *parameter, Lisp_Object *result,
4077            Lisp_Object yesval, Lisp_Object noval,
4078            BOOL is_float, BOOL is_modstring)
4079 /* --------------------------------------------------------------------------
4080       Check a parameter value in user's preferences
4081    -------------------------------------------------------------------------- */
4083   const char *value = ns_get_defaults_value (parameter);
4085   if (value)
4086     {
4087       double f;
4088       char *pos;
4089       if (c_strcasecmp (value, "YES") == 0)
4090         *result = yesval;
4091       else if (c_strcasecmp (value, "NO") == 0)
4092         *result = noval;
4093       else if (is_float && (f = strtod (value, &pos), pos != value))
4094         *result = make_float (f);
4095       else if (is_modstring && value)
4096         *result = ns_string_to_lispmod (value);
4097       else fprintf (stderr,
4098                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
4099     }
4103 static void
4104 ns_initialize_display_info (struct ns_display_info *dpyinfo)
4105 /* --------------------------------------------------------------------------
4106       Initialize global info and storage for display.
4107    -------------------------------------------------------------------------- */
4109     NSScreen *screen = [NSScreen mainScreen];
4110     NSWindowDepth depth = [screen depth];
4112     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
4113     dpyinfo->resy = 72.27;
4114     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
4115                                                   NSColorSpaceFromDepth (depth)]
4116                 && ![NSCalibratedWhiteColorSpace isEqualToString:
4117                                                  NSColorSpaceFromDepth (depth)];
4118     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
4119     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
4120     dpyinfo->color_table->colors = NULL;
4121     dpyinfo->root_window = 42; /* a placeholder.. */
4122     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
4123     dpyinfo->n_fonts = 0;
4124     dpyinfo->smallest_font_height = 1;
4125     dpyinfo->smallest_char_width = 1;
4127     reset_mouse_highlight (&dpyinfo->mouse_highlight);
4131 /* This and next define (many of the) public functions in this file. */
4132 /* x_... are generic versions in xdisp.c that we, and other terms, get away
4133          with using despite presence in the "system dependent" redisplay
4134          interface.  In addition, many of the ns_ methods have code that is
4135          shared with all terms, indicating need for further refactoring. */
4136 extern frame_parm_handler ns_frame_parm_handlers[];
4137 static struct redisplay_interface ns_redisplay_interface =
4139   ns_frame_parm_handlers,
4140   x_produce_glyphs,
4141   x_write_glyphs,
4142   x_insert_glyphs,
4143   x_clear_end_of_line,
4144   ns_scroll_run,
4145   ns_after_update_window_line,
4146   ns_update_window_begin,
4147   ns_update_window_end,
4148   0, /* flush_display */
4149   x_clear_window_mouse_face,
4150   x_get_glyph_overhangs,
4151   x_fix_overlapping_area,
4152   ns_draw_fringe_bitmap,
4153   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
4154   0, /* destroy_fringe_bitmap */
4155   ns_compute_glyph_string_overhangs,
4156   ns_draw_glyph_string,
4157   ns_define_frame_cursor,
4158   ns_clear_frame_area,
4159   ns_draw_window_cursor,
4160   ns_draw_vertical_window_border,
4161   ns_draw_window_divider,
4162   ns_shift_glyphs_for_insert,
4163   ns_show_hourglass,
4164   ns_hide_hourglass
4168 static void
4169 ns_delete_display (struct ns_display_info *dpyinfo)
4171   /* TODO... */
4175 /* This function is called when the last frame on a display is deleted. */
4176 static void
4177 ns_delete_terminal (struct terminal *terminal)
4179   struct ns_display_info *dpyinfo = terminal->display_info.ns;
4181   /* Protect against recursive calls.  delete_frame in
4182      delete_terminal calls us back when it deletes our last frame.  */
4183   if (!terminal->name)
4184     return;
4186   block_input ();
4188   x_destroy_all_bitmaps (dpyinfo);
4189   ns_delete_display (dpyinfo);
4190   unblock_input ();
4194 static struct terminal *
4195 ns_create_terminal (struct ns_display_info *dpyinfo)
4196 /* --------------------------------------------------------------------------
4197       Set up use of NS before we make the first connection.
4198    -------------------------------------------------------------------------- */
4200   struct terminal *terminal;
4202   NSTRACE (ns_create_terminal);
4204   terminal = create_terminal (output_ns, &ns_redisplay_interface);
4206   terminal->display_info.ns = dpyinfo;
4207   dpyinfo->terminal = terminal;
4209   terminal->clear_frame_hook = ns_clear_frame;
4210   terminal->ring_bell_hook = ns_ring_bell;
4211   terminal->update_begin_hook = ns_update_begin;
4212   terminal->update_end_hook = ns_update_end;
4213   terminal->read_socket_hook = ns_read_socket;
4214   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
4215   terminal->mouse_position_hook = ns_mouse_position;
4216   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
4217   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
4218   terminal->fullscreen_hook = ns_fullscreen_hook;
4219   terminal->menu_show_hook = ns_menu_show;
4220   terminal->popup_dialog_hook = ns_popup_dialog;
4221   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
4222   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
4223   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
4224   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
4225   terminal->delete_frame_hook = x_destroy_window;
4226   terminal->delete_terminal_hook = ns_delete_terminal;
4227   /* Other hooks are NULL by default.  */
4229   return terminal;
4233 struct ns_display_info *
4234 ns_term_init (Lisp_Object display_name)
4235 /* --------------------------------------------------------------------------
4236      Start the Application and get things rolling.
4237    -------------------------------------------------------------------------- */
4239   struct terminal *terminal;
4240   struct ns_display_info *dpyinfo;
4241   static int ns_initialized = 0;
4242   Lisp_Object tmp;
4244   if (ns_initialized) return x_display_list;
4245   ns_initialized = 1;
4247   NSTRACE (ns_term_init);
4249   [outerpool release];
4250   outerpool = [[NSAutoreleasePool alloc] init];
4252   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
4253   /*GSDebugAllocationActive (YES); */
4254   block_input ();
4256   baud_rate = 38400;
4257   Fset_input_interrupt_mode (Qnil);
4259   if (selfds[0] == -1)
4260     {
4261       if (emacs_pipe (selfds) != 0)
4262         {
4263           fprintf (stderr, "Failed to create pipe: %s\n",
4264                    emacs_strerror (errno));
4265           emacs_abort ();
4266         }
4268       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4269       FD_ZERO (&select_readfds);
4270       FD_ZERO (&select_writefds);
4271       pthread_mutex_init (&select_mutex, NULL);
4272     }
4274   ns_pending_files = [[NSMutableArray alloc] init];
4275   ns_pending_service_names = [[NSMutableArray alloc] init];
4276   ns_pending_service_args = [[NSMutableArray alloc] init];
4278 /* Start app and create the main menu, window, view.
4279      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4280      The view will then ask the NSApp to stop and return to Emacs. */
4281   [EmacsApp sharedApplication];
4282   if (NSApp == nil)
4283     return NULL;
4284   [NSApp setDelegate: NSApp];
4286   /* Start the select thread.  */
4287   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4288                            toTarget:NSApp
4289                          withObject:nil];
4291   /* debugging: log all notifications */
4292   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4293                                          selector: @selector (logNotification:)
4294                                              name: nil object: nil]; */
4296   dpyinfo = xzalloc (sizeof *dpyinfo);
4298   ns_initialize_display_info (dpyinfo);
4299   terminal = ns_create_terminal (dpyinfo);
4301   terminal->kboard = allocate_kboard (Qns);
4302   /* Don't let the initial kboard remain current longer than necessary.
4303      That would cause problems if a file loaded on startup tries to
4304      prompt in the mini-buffer.  */
4305   if (current_kboard == initial_kboard)
4306     current_kboard = terminal->kboard;
4307   terminal->kboard->reference_count++;
4309   dpyinfo->next = x_display_list;
4310   x_display_list = dpyinfo;
4312   dpyinfo->name_list_element = Fcons (display_name, Qnil);
4314   terminal->name = xstrdup (SSDATA (display_name));
4316   unblock_input ();
4318   if (!inhibit_x_resources)
4319     {
4320       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4321                  Qt, Qnil, NO, NO);
4322       tmp = Qnil;
4323       /* this is a standard variable */
4324       ns_default ("AppleAntiAliasingThreshold", &tmp,
4325                  make_float (10.0), make_float (6.0), YES, NO);
4326       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4327     }
4329   {
4330     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4332     if ( cl == nil )
4333       {
4334         Lisp_Object color_file, color_map, color;
4335         unsigned long c;
4336         char *name;
4338         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4339                          Fsymbol_value (intern ("data-directory")));
4341         color_map = Fx_load_color_file (color_file);
4342         if (NILP (color_map))
4343           fatal ("Could not read %s.\n", SDATA (color_file));
4345         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4346         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4347           {
4348             color = XCAR (color_map);
4349             name = SSDATA (XCAR (color));
4350             c = XINT (XCDR (color));
4351             [cl setColor:
4352                   [NSColor colorForEmacsRed: RED_FROM_ULONG (c) / 255.0
4353                                       green: GREEN_FROM_ULONG (c) / 255.0
4354                                        blue: BLUE_FROM_ULONG (c) / 255.0
4355                                       alpha: 1.0]
4356                   forKey: [NSString stringWithUTF8String: name]];
4357           }
4358         [cl writeToFile: nil];
4359       }
4360   }
4362   {
4363 #ifdef NS_IMPL_GNUSTEP
4364     Vwindow_system_version = build_string (gnustep_base_version);
4365 #else
4366     /*PSnextrelease (128, c); */
4367     char c[DBL_BUFSIZE_BOUND];
4368     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4369     Vwindow_system_version = make_unibyte_string (c, len);
4370 #endif
4371   }
4373   delete_keyboard_wait_descriptor (0);
4375   ns_app_name = [[NSProcessInfo processInfo] processName];
4377 /* Set up OS X app menu */
4378 #ifdef NS_IMPL_COCOA
4379   {
4380     NSMenu *appMenu;
4381     NSMenuItem *item;
4382     /* set up the application menu */
4383     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4384     [svcsMenu setAutoenablesItems: NO];
4385     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4386     [appMenu setAutoenablesItems: NO];
4387     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4388     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4390     [appMenu insertItemWithTitle: @"About Emacs"
4391                           action: @selector (orderFrontStandardAboutPanel:)
4392                    keyEquivalent: @""
4393                          atIndex: 0];
4394     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4395     [appMenu insertItemWithTitle: @"Preferences..."
4396                           action: @selector (showPreferencesWindow:)
4397                    keyEquivalent: @","
4398                          atIndex: 2];
4399     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4400     item = [appMenu insertItemWithTitle: @"Services"
4401                                  action: @selector (menuDown:)
4402                           keyEquivalent: @""
4403                                 atIndex: 4];
4404     [appMenu setSubmenu: svcsMenu forItem: item];
4405     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4406     [appMenu insertItemWithTitle: @"Hide Emacs"
4407                           action: @selector (hide:)
4408                    keyEquivalent: @"h"
4409                          atIndex: 6];
4410     item =  [appMenu insertItemWithTitle: @"Hide Others"
4411                           action: @selector (hideOtherApplications:)
4412                    keyEquivalent: @"h"
4413                          atIndex: 7];
4414     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4415     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4416     [appMenu insertItemWithTitle: @"Quit Emacs"
4417                           action: @selector (terminate:)
4418                    keyEquivalent: @"q"
4419                          atIndex: 9];
4421     item = [mainMenu insertItemWithTitle: ns_app_name
4422                                   action: @selector (menuDown:)
4423                            keyEquivalent: @""
4424                                  atIndex: 0];
4425     [mainMenu setSubmenu: appMenu forItem: item];
4426     [dockMenu insertItemWithTitle: @"New Frame"
4427                            action: @selector (newFrame:)
4428                     keyEquivalent: @""
4429                           atIndex: 0];
4431     [NSApp setMainMenu: mainMenu];
4432     [NSApp setAppleMenu: appMenu];
4433     [NSApp setServicesMenu: svcsMenu];
4434     /* Needed at least on Cocoa, to get dock menu to show windows */
4435     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4437     [[NSNotificationCenter defaultCenter]
4438       addObserver: mainMenu
4439          selector: @selector (trackingNotification:)
4440              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4441     [[NSNotificationCenter defaultCenter]
4442       addObserver: mainMenu
4443          selector: @selector (trackingNotification:)
4444              name: NSMenuDidEndTrackingNotification object: mainMenu];
4445   }
4446 #endif /* MAC OS X menu setup */
4448   /* Register our external input/output types, used for determining
4449      applicable services and also drag/drop eligibility. */
4450   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4451   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4452                       retain];
4453   ns_drag_types = [[NSArray arrayWithObjects:
4454                             NSStringPboardType,
4455                             NSTabularTextPboardType,
4456                             NSFilenamesPboardType,
4457                             NSURLPboardType, nil] retain];
4459   /* If fullscreen is in init/default-frame-alist, focus isn't set
4460      right for fullscreen windows, so set this.  */
4461   [NSApp activateIgnoringOtherApps:YES];
4463   [NSApp run];
4464   ns_do_open_file = YES;
4466 #ifdef NS_IMPL_GNUSTEP
4467   /* GNUstep steals SIGCHLD for use in NSTask, but we don't use NSTask.
4468      We must re-catch it so subprocess works.  */
4469   catch_child_signal ();
4470 #endif
4471   return dpyinfo;
4475 void
4476 ns_term_shutdown (int sig)
4478   [[NSUserDefaults standardUserDefaults] synchronize];
4480   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4481   if (STRINGP (Vauto_save_list_file_name))
4482     unlink (SSDATA (Vauto_save_list_file_name));
4484   if (sig == 0 || sig == SIGTERM)
4485     {
4486       [NSApp terminate: NSApp];
4487     }
4488   else // force a stack trace to happen
4489     {
4490       emacs_abort ();
4491     }
4495 /* ==========================================================================
4497     EmacsApp implementation
4499    ========================================================================== */
4502 @implementation EmacsApp
4504 - (id)init
4506   if (self = [super init])
4507     {
4508 #ifdef NS_IMPL_COCOA
4509       self->isFirst = YES;
4510 #endif
4511 #ifdef NS_IMPL_GNUSTEP
4512       self->applicationDidFinishLaunchingCalled = NO;
4513 #endif
4514     }
4516   return self;
4519 #ifdef NS_IMPL_COCOA
4520 - (void)run
4522 #ifndef NSAppKitVersionNumber10_8
4523 #define NSAppKitVersionNumber10_8 1187
4524 #endif
4526   if (NSAppKitVersionNumber <= NSAppKitVersionNumber10_8) 
4527     {
4528       [super run];
4529       return;
4530     }
4532   NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
4534   if (isFirst) [self finishLaunching];
4535   isFirst = NO;
4537   shouldKeepRunning = YES;
4538   do
4539     {
4540       [pool release];
4541       pool = [[NSAutoreleasePool alloc] init];
4543       NSEvent *event =
4544         [self nextEventMatchingMask:NSAnyEventMask
4545                           untilDate:[NSDate distantFuture]
4546                              inMode:NSDefaultRunLoopMode
4547                             dequeue:YES];
4548       [self sendEvent:event];
4549       [self updateWindows];
4550     } while (shouldKeepRunning);
4552   [pool release];
4555 - (void)stop: (id)sender
4557     shouldKeepRunning = NO;
4558     // Stop possible dialog also.  Noop if no dialog present.
4559     // The file dialog still leaks 7k - 10k on 10.9 though.
4560     [super stop:sender];
4562 #endif /* NS_IMPL_COCOA */
4564 - (void)logNotification: (NSNotification *)notification
4566   const char *name = [[notification name] UTF8String];
4567   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4568       && !strstr (name, "WindowNumber"))
4569     NSLog (@"notification: '%@'", [notification name]);
4573 - (void)sendEvent: (NSEvent *)theEvent
4574 /* --------------------------------------------------------------------------
4575      Called when NSApp is running for each event received.  Used to stop
4576      the loop when we choose, since there's no way to just run one iteration.
4577    -------------------------------------------------------------------------- */
4579   int type = [theEvent type];
4580   NSWindow *window = [theEvent window];
4582 /*  NSTRACE (sendEvent); */
4583 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4585 #ifdef NS_IMPL_GNUSTEP
4586   // Keyboard events aren't propagated to file dialogs for some reason.
4587   if ([NSApp modalWindow] != nil &&
4588       (type == NSKeyDown || type == NSKeyUp || type == NSFlagsChanged))
4589     {
4590       [[NSApp modalWindow] sendEvent: theEvent];
4591       return;
4592     }
4593 #endif
4595   if (type == NSApplicationDefined)
4596     {
4597       switch ([theEvent data2])
4598         {
4599 #ifdef NS_IMPL_COCOA
4600         case NSAPP_DATA2_RUNASSCRIPT:
4601           ns_run_ascript ();
4602           [self stop: self];
4603           return;
4604 #endif
4605         case NSAPP_DATA2_RUNFILEDIALOG:
4606           ns_run_file_dialog ();
4607           [self stop: self];
4608           return;
4609         }
4610     }
4612   if (type == NSCursorUpdate && window == nil)
4613     {
4614       fprintf (stderr, "Dropping external cursor update event.\n");
4615       return;
4616     }
4618   if (type == NSApplicationDefined)
4619     {
4620       /* Events posted by ns_send_appdefined interrupt the run loop here.
4621          But, if a modal window is up, an appdefined can still come through,
4622          (e.g., from a makeKeyWindow event) but stopping self also stops the
4623          modal loop. Just defer it until later. */
4624       if ([NSApp modalWindow] == nil)
4625         {
4626           last_appdefined_event_data = [theEvent data1];
4627           [self stop: self];
4628         }
4629       else
4630         {
4631           send_appdefined = YES;
4632         }
4633     }
4636 #ifdef NS_IMPL_COCOA
4637   /* If no dialog and none of our frames have focus and it is a move, skip it.
4638      It is a mouse move in an auxiliary menu, i.e. on the top right on OSX,
4639      such as Wifi, sound, date or similar.
4640      This prevents "spooky" highlighting in the frame under the menu.  */
4641   if (type == NSMouseMoved && [NSApp modalWindow] == nil)
4642     {
4643       struct ns_display_info *di;
4644       BOOL has_focus = NO;
4645       for (di = x_display_list; ! has_focus && di; di = di->next)
4646         has_focus = di->x_focus_frame != 0;
4647       if (! has_focus)
4648         return;
4649     }
4650 #endif
4652   [super sendEvent: theEvent];
4656 - (void)showPreferencesWindow: (id)sender
4658   struct frame *emacsframe = SELECTED_FRAME ();
4659   NSEvent *theEvent = [NSApp currentEvent];
4661   if (!emacs_event)
4662     return;
4663   emacs_event->kind = NS_NONKEY_EVENT;
4664   emacs_event->code = KEY_NS_SHOW_PREFS;
4665   emacs_event->modifiers = 0;
4666   EV_TRAILER (theEvent);
4670 - (void)newFrame: (id)sender
4672   struct frame *emacsframe = SELECTED_FRAME ();
4673   NSEvent *theEvent = [NSApp currentEvent];
4675   if (!emacs_event)
4676     return;
4677   emacs_event->kind = NS_NONKEY_EVENT;
4678   emacs_event->code = KEY_NS_NEW_FRAME;
4679   emacs_event->modifiers = 0;
4680   EV_TRAILER (theEvent);
4684 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4685 - (BOOL) openFile: (NSString *)fileName
4687   struct frame *emacsframe = SELECTED_FRAME ();
4688   NSEvent *theEvent = [NSApp currentEvent];
4690   if (!emacs_event)
4691     return NO;
4693   emacs_event->kind = NS_NONKEY_EVENT;
4694   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4695   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4696   ns_input_line = Qnil; /* can be start or cons start,end */
4697   emacs_event->modifiers =0;
4698   EV_TRAILER (theEvent);
4700   return YES;
4704 /* **************************************************************************
4706       EmacsApp delegate implementation
4708    ************************************************************************** */
4710 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4711 /* --------------------------------------------------------------------------
4712      When application is loaded, terminate event loop in ns_term_init
4713    -------------------------------------------------------------------------- */
4715   NSTRACE (applicationDidFinishLaunching);
4716 #ifdef NS_IMPL_GNUSTEP
4717   ((EmacsApp *)self)->applicationDidFinishLaunchingCalled = YES;
4718 #endif
4719   [NSApp setServicesProvider: NSApp];
4721   [self antialiasThresholdDidChange:nil];
4722 #ifdef NS_IMPL_COCOA
4723 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
4724   [[NSNotificationCenter defaultCenter]
4725     addObserver:self
4726        selector:@selector(antialiasThresholdDidChange:)
4727            name:NSAntialiasThresholdChangedNotification
4728          object:nil];
4729 #endif
4730 #endif
4732   ns_send_appdefined (-2);
4735 - (void)antialiasThresholdDidChange:(NSNotification *)notification
4737 #ifdef NS_IMPL_COCOA
4738 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
4739   macfont_update_antialias_threshold ();
4740 #endif
4741 #endif
4745 /* Termination sequences:
4746     C-x C-c:
4747     Cmd-Q:
4748     MenuBar | File | Exit:
4749     Select Quit from App menubar:
4750         -terminate
4751         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4752         ns_term_shutdown()
4754     Select Quit from Dock menu:
4755     Logout attempt:
4756         -appShouldTerminate
4757           Cancel -> Nothing else
4758           Accept ->
4760           -terminate
4761           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4762           ns_term_shutdown()
4766 - (void) terminate: (id)sender
4768   struct frame *emacsframe = SELECTED_FRAME ();
4770   if (!emacs_event)
4771     return;
4773   emacs_event->kind = NS_NONKEY_EVENT;
4774   emacs_event->code = KEY_NS_POWER_OFF;
4775   emacs_event->arg = Qt; /* mark as non-key event */
4776   EV_TRAILER ((id)nil);
4780 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4782   int ret;
4784   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4785     return NSTerminateNow;
4787     ret = NSRunAlertPanel(ns_app_name,
4788                           @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4789                           @"Save Buffers and Exit", @"Cancel", nil);
4791     if (ret == NSAlertDefaultReturn)
4792         return NSTerminateNow;
4793     else if (ret == NSAlertAlternateReturn)
4794         return NSTerminateCancel;
4795     return NSTerminateNow;  /* just in case */
4798 static int
4799 not_in_argv (NSString *arg)
4801   int k;
4802   const char *a = [arg UTF8String];
4803   for (k = 1; k < initial_argc; ++k)
4804     if (strcmp (a, initial_argv[k]) == 0) return 0;
4805   return 1;
4808 /*   Notification from the Workspace to open a file */
4809 - (BOOL)application: sender openFile: (NSString *)file
4811   if (ns_do_open_file || not_in_argv (file))
4812     [ns_pending_files addObject: file];
4813   return YES;
4817 /*   Open a file as a temporary file */
4818 - (BOOL)application: sender openTempFile: (NSString *)file
4820   if (ns_do_open_file || not_in_argv (file))
4821     [ns_pending_files addObject: file];
4822   return YES;
4826 /*   Notification from the Workspace to open a file noninteractively (?) */
4827 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4829   if (ns_do_open_file || not_in_argv (file))
4830     [ns_pending_files addObject: file];
4831   return YES;
4834 /*   Notification from the Workspace to open multiple files */
4835 - (void)application: sender openFiles: (NSArray *)fileList
4837   NSEnumerator *files = [fileList objectEnumerator];
4838   NSString *file;
4839   /* Don't open files from the command line unconditionally,
4840      Cocoa parses the command line wrong, --option value tries to open value
4841      if --option is the last option.  */
4842   while ((file = [files nextObject]) != nil)
4843     if (ns_do_open_file || not_in_argv (file))
4844       [ns_pending_files addObject: file];
4846   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4851 /* Handle dock menu requests.  */
4852 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4854   return dockMenu;
4858 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4859 - (void)applicationWillBecomeActive: (NSNotification *)notification
4861   //ns_app_active=YES;
4863 - (void)applicationDidBecomeActive: (NSNotification *)notification
4865   NSTRACE (applicationDidBecomeActive);
4867 #ifdef NS_IMPL_GNUSTEP
4868   if (! applicationDidFinishLaunchingCalled)
4869     [self applicationDidFinishLaunching:notification];
4870 #endif
4871   //ns_app_active=YES;
4873   ns_update_auto_hide_menu_bar ();
4874   // No constraining takes place when the application is not active.
4875   ns_constrain_all_frames ();
4877 - (void)applicationDidResignActive: (NSNotification *)notification
4879   //ns_app_active=NO;
4880   ns_send_appdefined (-1);
4885 /* ==========================================================================
4887     EmacsApp aux handlers for managing event loop
4889    ========================================================================== */
4892 - (void)timeout_handler: (NSTimer *)timedEntry
4893 /* --------------------------------------------------------------------------
4894      The timeout specified to ns_select has passed.
4895    -------------------------------------------------------------------------- */
4897   /*NSTRACE (timeout_handler); */
4898   ns_send_appdefined (-2);
4901 #ifdef NS_IMPL_GNUSTEP
4902 - (void)sendFromMainThread:(id)unused
4904   ns_send_appdefined (nextappdefined);
4906 #endif
4908 - (void)fd_handler:(id)unused
4909 /* --------------------------------------------------------------------------
4910      Check data waiting on file descriptors and terminate if so
4911    -------------------------------------------------------------------------- */
4913   int result;
4914   int waiting = 1, nfds;
4915   char c;
4917   fd_set readfds, writefds, *wfds;
4918   struct timespec timeout, *tmo;
4919   NSAutoreleasePool *pool = nil;
4921   /* NSTRACE (fd_handler); */
4923   for (;;)
4924     {
4925       [pool release];
4926       pool = [[NSAutoreleasePool alloc] init];
4928       if (waiting)
4929         {
4930           fd_set fds;
4931           FD_ZERO (&fds);
4932           FD_SET (selfds[0], &fds);
4933           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
4934           if (result > 0 && read (selfds[0], &c, 1) == 1 && c == 'g')
4935             waiting = 0;
4936         }
4937       else
4938         {
4939           pthread_mutex_lock (&select_mutex);
4940           nfds = select_nfds;
4942           if (select_valid & SELECT_HAVE_READ)
4943             readfds = select_readfds;
4944           else
4945             FD_ZERO (&readfds);
4947           if (select_valid & SELECT_HAVE_WRITE)
4948             {
4949               writefds = select_writefds;
4950               wfds = &writefds;
4951             }
4952           else
4953             wfds = NULL;
4954           if (select_valid & SELECT_HAVE_TMO)
4955             {
4956               timeout = select_timeout;
4957               tmo = &timeout;
4958             }
4959           else
4960             tmo = NULL;
4962           pthread_mutex_unlock (&select_mutex);
4964           FD_SET (selfds[0], &readfds);
4965           if (selfds[0] >= nfds) nfds = selfds[0]+1;
4967           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
4969           if (result == 0)
4970             ns_send_appdefined (-2);
4971           else if (result > 0)
4972             {
4973               if (FD_ISSET (selfds[0], &readfds))
4974                 {
4975                   if (read (selfds[0], &c, 1) == 1 && c == 's')
4976                     waiting = 1;
4977                 }
4978               else
4979                 {
4980                   pthread_mutex_lock (&select_mutex);
4981                   if (select_valid & SELECT_HAVE_READ)
4982                     select_readfds = readfds;
4983                   if (select_valid & SELECT_HAVE_WRITE)
4984                     select_writefds = writefds;
4985                   if (select_valid & SELECT_HAVE_TMO)
4986                     select_timeout = timeout;
4987                   pthread_mutex_unlock (&select_mutex);
4989                   ns_send_appdefined (result);
4990                 }
4991             }
4992           waiting = 1;
4993         }
4994     }
4999 /* ==========================================================================
5001     Service provision
5003    ========================================================================== */
5005 /* called from system: queue for next pass through event loop */
5006 - (void)requestService: (NSPasteboard *)pboard
5007               userData: (NSString *)userData
5008                  error: (NSString **)error
5010   [ns_pending_service_names addObject: userData];
5011   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
5012       SSDATA (ns_string_from_pasteboard (pboard))]];
5016 /* called from ns_read_socket to clear queue */
5017 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
5019   struct frame *emacsframe = SELECTED_FRAME ();
5020   NSEvent *theEvent = [NSApp currentEvent];
5022   if (!emacs_event)
5023     return NO;
5025   emacs_event->kind = NS_NONKEY_EVENT;
5026   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
5027   ns_input_spi_name = build_string ([name UTF8String]);
5028   ns_input_spi_arg = build_string ([arg UTF8String]);
5029   emacs_event->modifiers = EV_MODIFIERS (theEvent);
5030   EV_TRAILER (theEvent);
5032   return YES;
5036 @end  /* EmacsApp */
5040 /* ==========================================================================
5042     EmacsView implementation
5044    ========================================================================== */
5047 @implementation EmacsView
5049 /* needed to inform when window closed from LISP */
5050 - (void) setWindowClosing: (BOOL)closing
5052   windowClosing = closing;
5056 - (void)dealloc
5058   NSTRACE (EmacsView_dealloc);
5059   [toolbar release];
5060   if (fs_state == FULLSCREEN_BOTH)
5061     [nonfs_window release];
5062   [super dealloc];
5066 /* called on font panel selection */
5067 - (void)changeFont: (id)sender
5069   NSEvent *e = [[self window] currentEvent];
5070   struct face *face = FRAME_DEFAULT_FACE (emacsframe);
5071   struct font *font = face->font;
5072   id newFont;
5073   CGFloat size;
5074   NSFont *nsfont;
5076   NSTRACE (changeFont);
5078   if (!emacs_event)
5079     return;
5081   if (EQ (font->driver->type, Qns))
5082     nsfont = ((struct nsfont_info *)font)->nsfont;
5083 #ifdef NS_IMPL_COCOA
5084 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
5085   else
5086     nsfont = (NSFont *) macfont_get_nsctfont (font);
5087 #endif
5088 #endif
5090   if ((newFont = [sender convertFont: nsfont]))
5091     {
5092       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
5094       emacs_event->kind = NS_NONKEY_EVENT;
5095       emacs_event->modifiers = 0;
5096       emacs_event->code = KEY_NS_CHANGE_FONT;
5098       size = [newFont pointSize];
5099       ns_input_fontsize = make_number (lrint (size));
5100       ns_input_font = build_string ([[newFont familyName] UTF8String]);
5101       EV_TRAILER (e);
5102     }
5106 - (BOOL)acceptsFirstResponder
5108   NSTRACE (acceptsFirstResponder);
5109   return YES;
5113 - (void)resetCursorRects
5115   NSRect visible = [self visibleRect];
5116   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
5117   NSTRACE (resetCursorRects);
5119   if (currentCursor == nil)
5120     currentCursor = [NSCursor arrowCursor];
5122   if (!NSIsEmptyRect (visible))
5123     [self addCursorRect: visible cursor: currentCursor];
5124   [currentCursor setOnMouseEntered: YES];
5129 /*****************************************************************************/
5130 /* Keyboard handling. */
5131 #define NS_KEYLOG 0
5133 - (void)keyDown: (NSEvent *)theEvent
5135   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5136   int code;
5137   unsigned fnKeysym = 0;
5138   static NSMutableArray *nsEvArray;
5139 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5140   static BOOL firstTime = YES;
5141 #endif
5142   int left_is_none;
5143   unsigned int flags = [theEvent modifierFlags];
5145   NSTRACE (keyDown);
5147   /* Rhapsody and OS X give up and down events for the arrow keys */
5148   if (ns_fake_keydown == YES)
5149     ns_fake_keydown = NO;
5150   else if ([theEvent type] != NSKeyDown)
5151     return;
5153   if (!emacs_event)
5154     return;
5156  if (![[self window] isKeyWindow]
5157      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
5158      /* we must avoid an infinite loop here. */
5159      && (EmacsView *)[[theEvent window] delegate] != self)
5160    {
5161      /* XXX: There is an occasional condition in which, when Emacs display
5162          updates a different frame from the current one, and temporarily
5163          selects it, then processes some interrupt-driven input
5164          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
5165          for some reason that window has its first responder set to the NSView
5166          most recently updated (I guess), which is not the correct one. */
5167      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
5168      return;
5169    }
5171   if (nsEvArray == nil)
5172     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
5174   [NSCursor setHiddenUntilMouseMoves: YES];
5176   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
5177     {
5178       clear_mouse_face (hlinfo);
5179       hlinfo->mouse_face_hidden = 1;
5180     }
5182   if (!processingCompose)
5183     {
5184       /* When using screen sharing, no left or right information is sent,
5185          so use Left key in those cases.  */
5186       int is_left_key, is_right_key;
5188       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
5189         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
5191       /* (Carbon way: [theEvent keyCode]) */
5193       /* is it a "function key"? */
5194       /* Note: Sometimes a plain key will have the NSNumericPadKeyMask
5195          flag set (this is probably a bug in the OS).
5196       */
5197       if (code < 0x00ff && (flags&NSNumericPadKeyMask))
5198         {
5199           fnKeysym = ns_convert_key ([theEvent keyCode] | NSNumericPadKeyMask);
5200         }
5201       if (fnKeysym == 0)
5202         {
5203           fnKeysym = ns_convert_key (code);
5204         }
5206       if (fnKeysym)
5207         {
5208           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
5209              because Emacs treats Delete and KP-Delete same (in simple.el). */
5210           if ((fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
5211 #ifdef NS_IMPL_GNUSTEP
5212               /*  GNUstep uses incompatible keycodes, even for those that are
5213                   supposed to be hardware independent.  Just check for delete.
5214                   Keypad delete does not have keysym 0xFFFF.
5215                   See http://savannah.gnu.org/bugs/?25395
5216               */
5217               || (fnKeysym == 0xFFFF && code == 127)
5218 #endif
5219             )
5220             code = 0xFF08; /* backspace */
5221           else
5222             code = fnKeysym;
5223         }
5225       /* are there modifiers? */
5226       emacs_event->modifiers = 0;
5228       if (flags & NSHelpKeyMask)
5229           emacs_event->modifiers |= hyper_modifier;
5231       if (flags & NSShiftKeyMask)
5232         emacs_event->modifiers |= shift_modifier;
5234       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
5235       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
5236         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
5238       if (is_right_key)
5239         emacs_event->modifiers |= parse_solitary_modifier
5240           (EQ (ns_right_command_modifier, Qleft)
5241            ? ns_command_modifier
5242            : ns_right_command_modifier);
5244       if (is_left_key)
5245         {
5246           emacs_event->modifiers |= parse_solitary_modifier
5247             (ns_command_modifier);
5249           /* if super (default), take input manager's word so things like
5250              dvorak / qwerty layout work */
5251           if (EQ (ns_command_modifier, Qsuper)
5252               && !fnKeysym
5253               && [[theEvent characters] length] != 0)
5254             {
5255               /* XXX: the code we get will be unshifted, so if we have
5256                  a shift modifier, must convert ourselves */
5257               if (!(flags & NSShiftKeyMask))
5258                 code = [[theEvent characters] characterAtIndex: 0];
5259 #if 0
5260               /* this is ugly and also requires linking w/Carbon framework
5261                  (for LMGetKbdType) so for now leave this rare (?) case
5262                  undealt with.. in future look into CGEvent methods */
5263               else
5264                 {
5265                   long smv = GetScriptManagerVariable (smKeyScript);
5266                   Handle uchrHandle = GetResource
5267                     ('uchr', GetScriptVariable (smv, smScriptKeys));
5268                   UInt32 dummy = 0;
5269                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
5270                                  [[theEvent characters] characterAtIndex: 0],
5271                                  kUCKeyActionDisplay,
5272                                  (flags & ~NSCommandKeyMask) >> 8,
5273                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
5274                                  &dummy, 1, &dummy, &code);
5275                   code &= 0xFF;
5276                 }
5277 #endif
5278             }
5279         }
5281       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
5282       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
5283         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
5285       if (is_right_key)
5286           emacs_event->modifiers |= parse_solitary_modifier
5287               (EQ (ns_right_control_modifier, Qleft)
5288                ? ns_control_modifier
5289                : ns_right_control_modifier);
5291       if (is_left_key)
5292         emacs_event->modifiers |= parse_solitary_modifier
5293           (ns_control_modifier);
5295       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
5296           emacs_event->modifiers |=
5297             parse_solitary_modifier (ns_function_modifier);
5299       left_is_none = NILP (ns_alternate_modifier)
5300         || EQ (ns_alternate_modifier, Qnone);
5302       is_right_key = (flags & NSRightAlternateKeyMask)
5303         == NSRightAlternateKeyMask;
5304       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
5305         || (! is_right_key
5306             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
5308       if (is_right_key)
5309         {
5310           if ((NILP (ns_right_alternate_modifier)
5311                || EQ (ns_right_alternate_modifier, Qnone)
5312                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
5313               && !fnKeysym)
5314             {   /* accept pre-interp alt comb */
5315               if ([[theEvent characters] length] > 0)
5316                 code = [[theEvent characters] characterAtIndex: 0];
5317               /*HACK: clear lone shift modifier to stop next if from firing */
5318               if (emacs_event->modifiers == shift_modifier)
5319                 emacs_event->modifiers = 0;
5320             }
5321           else
5322             emacs_event->modifiers |= parse_solitary_modifier
5323               (EQ (ns_right_alternate_modifier, Qleft)
5324                ? ns_alternate_modifier
5325                : ns_right_alternate_modifier);
5326         }
5328       if (is_left_key) /* default = meta */
5329         {
5330           if (left_is_none && !fnKeysym)
5331             {   /* accept pre-interp alt comb */
5332               if ([[theEvent characters] length] > 0)
5333                 code = [[theEvent characters] characterAtIndex: 0];
5334               /*HACK: clear lone shift modifier to stop next if from firing */
5335               if (emacs_event->modifiers == shift_modifier)
5336                 emacs_event->modifiers = 0;
5337             }
5338           else
5339               emacs_event->modifiers |=
5340                 parse_solitary_modifier (ns_alternate_modifier);
5341         }
5343   if (NS_KEYLOG)
5344     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
5345              code, fnKeysym, flags, emacs_event->modifiers);
5347       /* if it was a function key or had modifiers, pass it directly to emacs */
5348       if (fnKeysym || (emacs_event->modifiers
5349                        && (emacs_event->modifiers != shift_modifier)
5350                        && [[theEvent charactersIgnoringModifiers] length] > 0))
5351 /*[[theEvent characters] length] */
5352         {
5353           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5354           if (code < 0x20)
5355             code |= (1<<28)|(3<<16);
5356           else if (code == 0x7f)
5357             code |= (1<<28)|(3<<16);
5358           else if (!fnKeysym)
5359             emacs_event->kind = code > 0xFF
5360               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5362           emacs_event->code = code;
5363           EV_TRAILER (theEvent);
5364           processingCompose = NO;
5365           return;
5366         }
5367     }
5370 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5371   /* if we get here we should send the key for input manager processing */
5372   /* Disable warning, there is nothing a user can do about it anyway, and
5373      it does not seem to matter.  */
5374 #if 0
5375   if (firstTime && [[NSInputManager currentInputManager]
5376                      wantsToDelayTextChangeNotifications] == NO)
5377     fprintf (stderr,
5378           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
5379 #endif
5380   firstTime = NO;
5381 #endif
5382   if (NS_KEYLOG && !processingCompose)
5383     fprintf (stderr, "keyDown: Begin compose sequence.\n");
5385   processingCompose = YES;
5386   [nsEvArray addObject: theEvent];
5387   [self interpretKeyEvents: nsEvArray];
5388   [nsEvArray removeObject: theEvent];
5392 #ifdef NS_IMPL_COCOA
5393 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
5394    decided not to send key-down for.
5395    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
5396    This only applies on Tiger and earlier.
5397    If it matches one of these, send it on to keyDown. */
5398 -(void)keyUp: (NSEvent *)theEvent
5400   int flags = [theEvent modifierFlags];
5401   int code = [theEvent keyCode];
5402   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5403       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5404     {
5405       if (NS_KEYLOG)
5406         fprintf (stderr, "keyUp: passed test");
5407       ns_fake_keydown = YES;
5408       [self keyDown: theEvent];
5409     }
5411 #endif
5414 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5417 /* <NSTextInput>: called when done composing;
5418    NOTE: also called when we delete over working text, followed immed.
5419          by doCommandBySelector: deleteBackward: */
5420 - (void)insertText: (id)aString
5422   int code;
5423   int len = [(NSString *)aString length];
5424   int i;
5426   if (NS_KEYLOG)
5427     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5428   processingCompose = NO;
5430   if (!emacs_event)
5431     return;
5433   /* first, clear any working text */
5434   if (workingText != nil)
5435     [self deleteWorkingText];
5437   /* now insert the string as keystrokes */
5438   for (i =0; i<len; i++)
5439     {
5440       code = [aString characterAtIndex: i];
5441       /* TODO: still need this? */
5442       if (code == 0x2DC)
5443         code = '~'; /* 0x7E */
5444       if (code != 32) /* Space */
5445         emacs_event->modifiers = 0;
5446       emacs_event->kind
5447         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5448       emacs_event->code = code;
5449       EV_TRAILER ((id)nil);
5450     }
5454 /* <NSTextInput>: inserts display of composing characters */
5455 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5457   NSString *str = [aString respondsToSelector: @selector (string)] ?
5458     [aString string] : aString;
5459   if (NS_KEYLOG)
5460     NSLog (@"setMarkedText '%@' len =%lu range %lu from %lu",
5461            str, (unsigned long)[str length],
5462            (unsigned long)selRange.length,
5463            (unsigned long)selRange.location);
5465   if (workingText != nil)
5466     [self deleteWorkingText];
5467   if ([str length] == 0)
5468     return;
5470   if (!emacs_event)
5471     return;
5473   processingCompose = YES;
5474   workingText = [str copy];
5475   ns_working_text = build_string ([workingText UTF8String]);
5477   emacs_event->kind = NS_TEXT_EVENT;
5478   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5479   EV_TRAILER ((id)nil);
5483 /* delete display of composing characters [not in <NSTextInput>] */
5484 - (void)deleteWorkingText
5486   if (workingText == nil)
5487     return;
5488   if (NS_KEYLOG)
5489     NSLog(@"deleteWorkingText len =%lu\n", (unsigned long)[workingText length]);
5490   [workingText release];
5491   workingText = nil;
5492   processingCompose = NO;
5494   if (!emacs_event)
5495     return;
5497   emacs_event->kind = NS_TEXT_EVENT;
5498   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5499   EV_TRAILER ((id)nil);
5503 - (BOOL)hasMarkedText
5505   return workingText != nil;
5509 - (NSRange)markedRange
5511   NSRange rng = workingText != nil
5512     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5513   if (NS_KEYLOG)
5514     NSLog (@"markedRange request");
5515   return rng;
5519 - (void)unmarkText
5521   if (NS_KEYLOG)
5522     NSLog (@"unmark (accept) text");
5523   [self deleteWorkingText];
5524   processingCompose = NO;
5528 /* used to position char selection windows, etc. */
5529 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5531   NSRect rect;
5532   NSPoint pt;
5533   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5534   if (NS_KEYLOG)
5535     NSLog (@"firstRectForCharRange request");
5537   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5538   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5539   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5540   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5541                                        +FRAME_LINE_HEIGHT (emacsframe));
5543   pt = [self convertPoint: pt toView: nil];
5544   pt = [[self window] convertBaseToScreen: pt];
5545   rect.origin = pt;
5546   return rect;
5550 - (NSInteger)conversationIdentifier
5552   return (NSInteger)self;
5556 - (void)doCommandBySelector: (SEL)aSelector
5558   if (NS_KEYLOG)
5559     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5561   processingCompose = NO;
5562   if (aSelector == @selector (deleteBackward:))
5563     {
5564       /* happens when user backspaces over an ongoing composition:
5565          throw a 'delete' into the event queue */
5566       if (!emacs_event)
5567         return;
5568       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5569       emacs_event->code = 0xFF08;
5570       EV_TRAILER ((id)nil);
5571     }
5574 - (NSArray *)validAttributesForMarkedText
5576   static NSArray *arr = nil;
5577   if (arr == nil) arr = [NSArray new];
5578  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5579   return arr;
5582 - (NSRange)selectedRange
5584   if (NS_KEYLOG)
5585     NSLog (@"selectedRange request");
5586   return NSMakeRange (NSNotFound, 0);
5589 #if defined (NS_IMPL_COCOA) || GNUSTEP_GUI_MAJOR_VERSION > 0 || \
5590     GNUSTEP_GUI_MINOR_VERSION > 22
5591 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5592 #else
5593 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
5594 #endif
5596   if (NS_KEYLOG)
5597     NSLog (@"characterIndexForPoint request");
5598   return 0;
5601 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5603   static NSAttributedString *str = nil;
5604   if (str == nil) str = [NSAttributedString new];
5605   if (NS_KEYLOG)
5606     NSLog (@"attributedSubstringFromRange request");
5607   return str;
5610 /* End <NSTextInput> impl. */
5611 /*****************************************************************************/
5614 /* This is what happens when the user presses a mouse button.  */
5615 - (void)mouseDown: (NSEvent *)theEvent
5617   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5618   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5620   NSTRACE (mouseDown);
5622   [self deleteWorkingText];
5624   if (!emacs_event)
5625     return;
5627   dpyinfo->last_mouse_frame = emacsframe;
5628   /* appears to be needed to prevent spurious movement events generated on
5629      button clicks */
5630   emacsframe->mouse_moved = 0;
5632   if ([theEvent type] == NSScrollWheel)
5633     {
5634       CGFloat delta = [theEvent deltaY];
5635       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5636       if (delta == 0)
5637         {
5638           delta = [theEvent deltaX];
5639           if (delta == 0)
5640             {
5641               NSTRACE (deltaIsZero);
5642               return;
5643             }
5644           emacs_event->kind = HORIZ_WHEEL_EVENT;
5645         }
5646       else
5647         emacs_event->kind = WHEEL_EVENT;
5649       emacs_event->code = 0;
5650       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5651         ((delta > 0) ? up_modifier : down_modifier);
5652     }
5653   else
5654     {
5655       emacs_event->kind = MOUSE_CLICK_EVENT;
5656       emacs_event->code = EV_BUTTON (theEvent);
5657       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5658                              | EV_UDMODIFIERS (theEvent);
5659     }
5660   XSETINT (emacs_event->x, lrint (p.x));
5661   XSETINT (emacs_event->y, lrint (p.y));
5662   EV_TRAILER (theEvent);
5666 - (void)rightMouseDown: (NSEvent *)theEvent
5668   NSTRACE (rightMouseDown);
5669   [self mouseDown: theEvent];
5673 - (void)otherMouseDown: (NSEvent *)theEvent
5675   NSTRACE (otherMouseDown);
5676   [self mouseDown: theEvent];
5680 - (void)mouseUp: (NSEvent *)theEvent
5682   NSTRACE (mouseUp);
5683   [self mouseDown: theEvent];
5687 - (void)rightMouseUp: (NSEvent *)theEvent
5689   NSTRACE (rightMouseUp);
5690   [self mouseDown: theEvent];
5694 - (void)otherMouseUp: (NSEvent *)theEvent
5696   NSTRACE (otherMouseUp);
5697   [self mouseDown: theEvent];
5701 - (void) scrollWheel: (NSEvent *)theEvent
5703   NSTRACE (scrollWheel);
5704   [self mouseDown: theEvent];
5708 /* Tell emacs the mouse has moved. */
5709 - (void)mouseMoved: (NSEvent *)e
5711   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5712   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5713   Lisp_Object frame;
5714   NSPoint pt;
5716 //  NSTRACE (mouseMoved);
5718   dpyinfo->last_mouse_movement_time = EV_TIMESTAMP (e);
5719   pt = [self convertPoint: [e locationInWindow] fromView: nil];
5720   dpyinfo->last_mouse_motion_x = pt.x;
5721   dpyinfo->last_mouse_motion_y = pt.y;
5723   /* update any mouse face */
5724   if (hlinfo->mouse_face_hidden)
5725     {
5726       hlinfo->mouse_face_hidden = 0;
5727       clear_mouse_face (hlinfo);
5728     }
5730   /* tooltip handling */
5731   previous_help_echo_string = help_echo_string;
5732   help_echo_string = Qnil;
5734   if (!NILP (Vmouse_autoselect_window))
5735     {
5736       NSTRACE (mouse_autoselect_window);
5737       static Lisp_Object last_mouse_window;
5738       Lisp_Object window
5739         = window_from_coordinates (emacsframe, pt.x, pt.y, 0, 0);
5741       if (WINDOWP (window)
5742           && !EQ (window, last_mouse_window)
5743           && !EQ (window, selected_window)
5744           && (focus_follows_mouse
5745               || (EQ (XWINDOW (window)->frame,
5746                       XWINDOW (selected_window)->frame))))
5747         {
5748           NSTRACE (in_window);
5749           emacs_event->kind = SELECT_WINDOW_EVENT;
5750           emacs_event->frame_or_window = window;
5751           EV_TRAILER2 (e);
5752         }
5753       /* Remember the last window where we saw the mouse.  */
5754       last_mouse_window = window;
5755     }
5757   if (!note_mouse_movement (emacsframe, pt.x, pt.y))
5758     help_echo_string = previous_help_echo_string;
5760   XSETFRAME (frame, emacsframe);
5761   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5762     {
5763       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5764          (note_mouse_highlight), which is called through the
5765          note_mouse_movement () call above */
5766       any_help_event_p = YES;
5767       gen_help_event (help_echo_string, frame, help_echo_window,
5768                       help_echo_object, help_echo_pos);
5769     }
5771   if (emacsframe->mouse_moved && send_appdefined)
5772     ns_send_appdefined (-1);
5776 - (void)mouseDragged: (NSEvent *)e
5778   NSTRACE (mouseDragged);
5779   [self mouseMoved: e];
5783 - (void)rightMouseDragged: (NSEvent *)e
5785   NSTRACE (rightMouseDragged);
5786   [self mouseMoved: e];
5790 - (void)otherMouseDragged: (NSEvent *)e
5792   NSTRACE (otherMouseDragged);
5793   [self mouseMoved: e];
5797 - (BOOL)windowShouldClose: (id)sender
5799   NSEvent *e =[[self window] currentEvent];
5801   NSTRACE (windowShouldClose);
5802   windowClosing = YES;
5803   if (!emacs_event)
5804     return NO;
5805   emacs_event->kind = DELETE_WINDOW_EVENT;
5806   emacs_event->modifiers = 0;
5807   emacs_event->code = 0;
5808   EV_TRAILER (e);
5809   /* Don't close this window, let this be done from lisp code.  */
5810   return NO;
5813 - (void) updateFrameSize: (BOOL) delay;
5815   NSWindow *window = [self window];
5816   NSRect wr = [window frame];
5817   int extra = 0;
5818   int oldc = cols, oldr = rows;
5819   int oldw = FRAME_PIXEL_WIDTH (emacsframe);
5820   int oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5821   int neww, newh;
5823   NSTRACE (updateFrameSize);
5824   NSTRACE_SIZE ("Original size", NSMakeSize (oldw, oldh));
5826   if (! [self isFullscreen])
5827     {
5828 #ifdef NS_IMPL_GNUSTEP
5829       // GNUstep does not always update the tool bar height.  Force it.
5830       if (toolbar && [toolbar isVisible])
5831           update_frame_tool_bar (emacsframe);
5832 #endif
5834       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5835         + FRAME_TOOLBAR_HEIGHT (emacsframe);
5836     }
5838   if (wait_for_tool_bar)
5839     {
5840       if (FRAME_TOOLBAR_HEIGHT (emacsframe) == 0)
5841         return;
5842       wait_for_tool_bar = NO;
5843     }
5845   neww = (int)wr.size.width - emacsframe->border_width;
5846   newh = (int)wr.size.height - extra;
5848   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, neww);
5849   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, newh);
5851   if (cols < MINWIDTH)
5852     cols = MINWIDTH;
5854   if (rows < MINHEIGHT)
5855     rows = MINHEIGHT;
5857   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5858     {
5859       NSView *view = FRAME_NS_VIEW (emacsframe);
5860       NSWindow *win = [view window];
5861       NSSize sz = [win resizeIncrements];
5863       change_frame_size (emacsframe,
5864                          FRAME_PIXEL_TO_TEXT_WIDTH (emacsframe, neww),
5865                          FRAME_PIXEL_TO_TEXT_HEIGHT (emacsframe, newh),
5866                          0, delay, 0, 1);
5867       SET_FRAME_GARBAGED (emacsframe);
5868       cancel_mouse_face (emacsframe);
5870       // Did resize increments change because of a font change?
5871       if (sz.width != FRAME_COLUMN_WIDTH (emacsframe) ||
5872           sz.height != FRAME_LINE_HEIGHT (emacsframe) ||
5873           (frame_resize_pixelwise && sz.width != 1))
5874         {
5875           sz.width = frame_resize_pixelwise
5876             ? 1 : FRAME_COLUMN_WIDTH (emacsframe);
5877           sz.height = frame_resize_pixelwise
5878             ? 1 : FRAME_LINE_HEIGHT (emacsframe);
5879           [win setResizeIncrements: sz];
5881           NSTRACE_SIZE ("New size", NSMakeSize (neww, newh));
5882         }
5884       [view setFrame: NSMakeRect (0, 0, neww, newh)];
5885       [self windowDidMove:nil];   // Update top/left.
5886     }
5889 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
5890 /* normalize frame to gridded text size */
5892   int extra = 0;
5894   NSTRACE (windowWillResize);
5895   NSTRACE_SIZE ("Original size", frameSize);
5896 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5898   if (fs_state == FULLSCREEN_MAXIMIZED
5899       && (maximized_width != (int)frameSize.width
5900           || maximized_height != (int)frameSize.height))
5901     [self setFSValue: FULLSCREEN_NONE];
5902   else if (fs_state == FULLSCREEN_WIDTH
5903            && maximized_width != (int)frameSize.width)
5904     [self setFSValue: FULLSCREEN_NONE];
5905   else if (fs_state == FULLSCREEN_HEIGHT
5906            && maximized_height != (int)frameSize.height)
5907     [self setFSValue: FULLSCREEN_NONE];
5908   if (fs_state == FULLSCREEN_NONE)
5909     maximized_width = maximized_height = -1;
5911   if (! [self isFullscreen])
5912     {
5913       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5914         + FRAME_TOOLBAR_HEIGHT (emacsframe);
5915     }
5917   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, frameSize.width);
5918   if (cols < MINWIDTH)
5919     cols = MINWIDTH;
5921   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe,
5922                                            frameSize.height - extra);
5923   if (rows < MINHEIGHT)
5924     rows = MINHEIGHT;
5925 #ifdef NS_IMPL_COCOA
5926   {
5927     /* this sets window title to have size in it; the wm does this under GS */
5928     NSRect r = [[self window] frame];
5929     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5930       {
5931         if (old_title != 0)
5932           {
5933             xfree (old_title);
5934             old_title = 0;
5935           }
5936       }
5937     else if (fs_state == FULLSCREEN_NONE && ! maximizing_resize)
5938       {
5939         char *size_title;
5940         NSWindow *window = [self window];
5941         if (old_title == 0)
5942           {
5943             char *t = strdup ([[[self window] title] UTF8String]);
5944             char *pos = strstr (t, "  â€”  ");
5945             if (pos)
5946               *pos = '\0';
5947             old_title = t;
5948           }
5949         size_title = xmalloc (strlen (old_title) + 40);
5950         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5951         [window setTitle: [NSString stringWithUTF8String: size_title]];
5952         [window display];
5953         xfree (size_title);
5954       }
5955   }
5956 #endif /* NS_IMPL_COCOA */
5957 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5959   return frameSize;
5963 - (void)windowDidResize: (NSNotification *)notification
5965   if (! [self fsIsNative])
5966     {
5967       NSWindow *theWindow = [notification object];
5968       /* We can get notification on the non-FS window when in
5969          fullscreen mode.  */
5970       if ([self window] != theWindow) return;
5971     }
5973 #ifdef NS_IMPL_GNUSTEP
5974   NSWindow *theWindow = [notification object];
5976    /* In GNUstep, at least currently, it's possible to get a didResize
5977       without getting a willResize.. therefore we need to act as if we got
5978       the willResize now */
5979   NSSize sz = [theWindow frame].size;
5980   sz = [self windowWillResize: theWindow toSize: sz];
5981 #endif /* NS_IMPL_GNUSTEP */
5983   NSTRACE (windowDidResize);
5984 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5986 if (cols > 0 && rows > 0)
5987     {
5988       [self updateFrameSize: YES];
5989     }
5991   ns_send_appdefined (-1);
5994 #ifdef NS_IMPL_COCOA
5995 - (void)viewDidEndLiveResize
5997   [super viewDidEndLiveResize];
5998   if (old_title != 0)
5999     {
6000       [[self window] setTitle: [NSString stringWithUTF8String: old_title]];
6001       xfree (old_title);
6002       old_title = 0;
6003     }
6004   maximizing_resize = NO;
6006 #endif /* NS_IMPL_COCOA */
6009 - (void)windowDidBecomeKey: (NSNotification *)notification
6010 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
6012   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
6013   struct frame *old_focus = dpyinfo->x_focus_frame;
6015   NSTRACE (windowDidBecomeKey);
6017   if (emacsframe != old_focus)
6018     dpyinfo->x_focus_frame = emacsframe;
6020   ns_frame_rehighlight (emacsframe);
6022   if (emacs_event)
6023     {
6024       emacs_event->kind = FOCUS_IN_EVENT;
6025       EV_TRAILER ((id)nil);
6026     }
6030 - (void)windowDidResignKey: (NSNotification *)notification
6031 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
6033   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
6034   BOOL is_focus_frame = dpyinfo->x_focus_frame == emacsframe;
6035   NSTRACE (windowDidResignKey);
6037   if (is_focus_frame)
6038     dpyinfo->x_focus_frame = 0;
6040   emacsframe->mouse_moved = 0;
6041   ns_frame_rehighlight (emacsframe);
6043   /* FIXME: for some reason needed on second and subsequent clicks away
6044             from sole-frame Emacs to get hollow box to show */
6045   if (!windowClosing && [[self window] isVisible] == YES)
6046     {
6047       x_update_cursor (emacsframe, 1);
6048       x_set_frame_alpha (emacsframe);
6049     }
6051   if (any_help_event_p)
6052     {
6053       Lisp_Object frame;
6054       XSETFRAME (frame, emacsframe);
6055       help_echo_string = Qnil;
6056       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6057     }
6059   if (emacs_event && is_focus_frame)
6060     {
6061       [self deleteWorkingText];
6062       emacs_event->kind = FOCUS_OUT_EVENT;
6063       EV_TRAILER ((id)nil);
6064     }
6068 - (void)windowWillMiniaturize: sender
6070   NSTRACE (windowWillMiniaturize);
6074 - (BOOL)isFlipped
6076   return YES;
6080 - (BOOL)isOpaque
6082   return NO;
6086 - initFrameFromEmacs: (struct frame *)f
6088   NSRect r, wr;
6089   Lisp_Object tem;
6090   NSWindow *win;
6091   NSSize sz;
6092   NSColor *col;
6093   NSString *name;
6095   NSTRACE (initFrameFromEmacs);
6097   windowClosing = NO;
6098   processingCompose = NO;
6099   scrollbarsNeedingUpdate = 0;
6100   fs_state = FULLSCREEN_NONE;
6101   fs_before_fs = next_maximized = -1;
6102 #ifdef HAVE_NATIVE_FS
6103   fs_is_native = ns_use_native_fullscreen;
6104 #else
6105   fs_is_native = NO;
6106 #endif
6107   maximized_width = maximized_height = -1;
6108   nonfs_window = nil;
6110 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
6112   ns_userRect = NSMakeRect (0, 0, 0, 0);
6113   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
6114                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
6115   [self initWithFrame: r];
6116   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
6118   FRAME_NS_VIEW (f) = self;
6119   emacsframe = f;
6120 #ifdef NS_IMPL_COCOA
6121   old_title = 0;
6122   maximizing_resize = NO;
6123 #endif
6125   win = [[EmacsWindow alloc]
6126             initWithContentRect: r
6127                       styleMask: (NSResizableWindowMask |
6128 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6129                                   NSTitledWindowMask |
6130 #endif
6131                                   NSMiniaturizableWindowMask |
6132                                   NSClosableWindowMask)
6133                         backing: NSBackingStoreBuffered
6134                           defer: YES];
6136 #ifdef HAVE_NATIVE_FS
6137     [win setCollectionBehavior:NSWindowCollectionBehaviorFullScreenPrimary];
6138 #endif
6140   wr = [win frame];
6141   bwidth = f->border_width = wr.size.width - r.size.width;
6142   tibar_height = FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
6144   [win setAcceptsMouseMovedEvents: YES];
6145   [win setDelegate: self];
6146   [win useOptimizedDrawing: YES];
6148   sz.width = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
6149   sz.height = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
6150   [win setResizeIncrements: sz];
6152   [[win contentView] addSubview: self];
6154   if (ns_drag_types)
6155     [self registerForDraggedTypes: ns_drag_types];
6157   tem = f->name;
6158   name = [NSString stringWithUTF8String:
6159                    NILP (tem) ? "Emacs" : SSDATA (tem)];
6160   [win setTitle: name];
6162   /* toolbar support */
6163   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
6164                          [NSString stringWithFormat: @"Emacs Frame %d",
6165                                    ns_window_num]];
6166   [win setToolbar: toolbar];
6167   [toolbar setVisible: NO];
6169   /* Don't set frame garbaged until tool bar is up to date?
6170      This avoids an extra clear and redraw (flicker) at frame creation.  */
6171   if (FRAME_EXTERNAL_TOOL_BAR (f)) wait_for_tool_bar = YES;
6172   else wait_for_tool_bar = NO;
6175 #ifdef NS_IMPL_COCOA
6176   {
6177     NSButton *toggleButton;
6178   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
6179   [toggleButton setTarget: self];
6180   [toggleButton setAction: @selector (toggleToolbar: )];
6181   }
6182 #endif
6183   FRAME_TOOLBAR_HEIGHT (f) = 0;
6185   tem = f->icon_name;
6186   if (!NILP (tem))
6187     [win setMiniwindowTitle:
6188            [NSString stringWithUTF8String: SSDATA (tem)]];
6190   {
6191     NSScreen *screen = [win screen];
6193     if (screen != 0)
6194       [win setFrameTopLeftPoint: NSMakePoint
6195            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
6196             IN_BOUND (-SCREENMAX,
6197                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
6198   }
6200   [win makeFirstResponder: self];
6202   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6203                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
6204   [win setBackgroundColor: col];
6205   if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6206     [win setOpaque: NO];
6208   [self allocateGState];
6210   [NSApp registerServicesMenuSendTypes: ns_send_types
6211                            returnTypes: nil];
6213   ns_window_num++;
6214   return self;
6218 - (void)windowDidMove: sender
6220   NSWindow *win = [self window];
6221   NSRect r = [win frame];
6222   NSArray *screens = [NSScreen screens];
6223   NSScreen *screen = [screens objectAtIndex: 0];
6225   NSTRACE (windowDidMove);
6227   if (!emacsframe->output_data.ns)
6228     return;
6229   if (screen != nil)
6230     {
6231       emacsframe->left_pos = r.origin.x;
6232       emacsframe->top_pos =
6233         [screen frame].size.height - (r.origin.y + r.size.height);
6234     }
6238 /* Called AFTER method below, but before our windowWillResize call there leads
6239    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
6240    location so set_window_size moves the frame. */
6241 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
6243   emacsframe->output_data.ns->zooming = 1;
6244   return YES;
6248 /* Override to do something slightly nonstandard, but nice.  First click on
6249    zoom button will zoom vertically.  Second will zoom completely.  Third
6250    returns to original. */
6251 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
6252                         defaultFrame:(NSRect)defaultFrame
6254   NSRect result = [sender frame];
6256   NSTRACE (windowWillUseStandardFrame);
6258   if (fs_before_fs != -1) /* Entering fullscreen */
6259       {
6260         result = defaultFrame;
6261       }
6262   else if (next_maximized == FULLSCREEN_HEIGHT
6263       || (next_maximized == -1
6264           && abs (defaultFrame.size.height - result.size.height)
6265           > FRAME_LINE_HEIGHT (emacsframe)))
6266     {
6267       /* first click */
6268       ns_userRect = result;
6269       maximized_height = result.size.height = defaultFrame.size.height;
6270       maximized_width = -1;
6271       result.origin.y = defaultFrame.origin.y;
6272       [self setFSValue: FULLSCREEN_HEIGHT];
6273 #ifdef NS_IMPL_COCOA
6274       maximizing_resize = YES;
6275 #endif
6276     }
6277   else if (next_maximized == FULLSCREEN_WIDTH)
6278     {
6279       ns_userRect = result;
6280       maximized_width = result.size.width = defaultFrame.size.width;
6281       maximized_height = -1;
6282       result.origin.x = defaultFrame.origin.x;
6283       [self setFSValue: FULLSCREEN_WIDTH];
6284     }
6285   else if (next_maximized == FULLSCREEN_MAXIMIZED
6286            || (next_maximized == -1
6287                && abs (defaultFrame.size.width - result.size.width)
6288                > FRAME_COLUMN_WIDTH (emacsframe)))
6289     {
6290       result = defaultFrame;  /* second click */
6291       maximized_width = result.size.width;
6292       maximized_height = result.size.height;
6293       [self setFSValue: FULLSCREEN_MAXIMIZED];
6294 #ifdef NS_IMPL_COCOA
6295       maximizing_resize = YES;
6296 #endif
6297     }
6298   else
6299     {
6300       /* restore */
6301       result = ns_userRect.size.height ? ns_userRect : result;
6302       ns_userRect = NSMakeRect (0, 0, 0, 0);
6303 #ifdef NS_IMPL_COCOA
6304       maximizing_resize = fs_state != FULLSCREEN_NONE;
6305 #endif
6306       [self setFSValue: FULLSCREEN_NONE];
6307       maximized_width = maximized_height = -1;
6308     }
6310   if (fs_before_fs == -1) next_maximized = -1;
6311   [self windowWillResize: sender toSize: result.size];
6312   return result;
6316 - (void)windowDidDeminiaturize: sender
6318   NSTRACE (windowDidDeminiaturize);
6319   if (!emacsframe->output_data.ns)
6320     return;
6322   SET_FRAME_ICONIFIED (emacsframe, 0);
6323   SET_FRAME_VISIBLE (emacsframe, 1);
6324   windows_or_buffers_changed = 63;
6326   if (emacs_event)
6327     {
6328       emacs_event->kind = DEICONIFY_EVENT;
6329       EV_TRAILER ((id)nil);
6330     }
6334 - (void)windowDidExpose: sender
6336   NSTRACE (windowDidExpose);
6337   if (!emacsframe->output_data.ns)
6338     return;
6340   SET_FRAME_VISIBLE (emacsframe, 1);
6341   SET_FRAME_GARBAGED (emacsframe);
6343   if (send_appdefined)
6344     ns_send_appdefined (-1);
6348 - (void)windowDidMiniaturize: sender
6350   NSTRACE (windowDidMiniaturize);
6351   if (!emacsframe->output_data.ns)
6352     return;
6354   SET_FRAME_ICONIFIED (emacsframe, 1);
6355   SET_FRAME_VISIBLE (emacsframe, 0);
6357   if (emacs_event)
6358     {
6359       emacs_event->kind = ICONIFY_EVENT;
6360       EV_TRAILER ((id)nil);
6361     }
6364 #ifdef HAVE_NATIVE_FS
6365 - (NSApplicationPresentationOptions)window:(NSWindow *)window
6366       willUseFullScreenPresentationOptions:
6367   (NSApplicationPresentationOptions)proposedOptions
6369   return proposedOptions|NSApplicationPresentationAutoHideToolbar;
6371 #endif
6373 - (void)windowWillEnterFullScreen:(NSNotification *)notification
6375   fs_before_fs = fs_state;
6378 - (void)windowDidEnterFullScreen:(NSNotification *)notification
6380   [self setFSValue: FULLSCREEN_BOTH];
6381   if (! [self fsIsNative])
6382     {
6383       [self windowDidBecomeKey:notification];
6384       [nonfs_window orderOut:self];
6385     }
6386   else
6387     {
6388       BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (emacsframe) ? YES : NO;
6389 #ifdef NS_IMPL_COCOA
6390 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6391       unsigned val = (unsigned)[NSApp presentationOptions];
6393       // OSX 10.7 bug fix, the menu won't appear without this.
6394       // val is non-zero on other OSX versions.
6395       if (val == 0)
6396         {
6397           NSApplicationPresentationOptions options
6398             = NSApplicationPresentationAutoHideDock
6399             | NSApplicationPresentationAutoHideMenuBar
6400             | NSApplicationPresentationFullScreen
6401             | NSApplicationPresentationAutoHideToolbar;
6403           [NSApp setPresentationOptions: options];
6404         }
6405 #endif
6406 #endif
6407       [toolbar setVisible:tbar_visible];
6408     }
6411 - (void)windowWillExitFullScreen:(NSNotification *)notification
6413   if (next_maximized != -1)
6414     fs_before_fs = next_maximized;
6417 - (void)windowDidExitFullScreen:(NSNotification *)notification
6419   [self setFSValue: fs_before_fs];
6420   fs_before_fs = -1;
6421 #ifdef HAVE_NATIVE_FS
6422   [self updateCollectionBehavior];
6423 #endif
6424   if (FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6425     {
6426       [toolbar setVisible:YES];
6427       update_frame_tool_bar (emacsframe);
6428       [self updateFrameSize:YES];
6429       [[self window] display];
6430     }
6431   else
6432     [toolbar setVisible:NO];
6434   if (next_maximized != -1)
6435     [[self window] performZoom:self];
6438 - (BOOL)fsIsNative
6440   return fs_is_native;
6443 - (BOOL)isFullscreen
6445   if (! fs_is_native) return nonfs_window != nil;
6446 #ifdef HAVE_NATIVE_FS
6447   return ([[self window] styleMask] & NSFullScreenWindowMask) != 0;
6448 #else
6449   return NO;
6450 #endif
6453 #ifdef HAVE_NATIVE_FS
6454 - (void)updateCollectionBehavior
6456   if (! [self isFullscreen])
6457     {
6458       NSWindow *win = [self window];
6459       NSWindowCollectionBehavior b = [win collectionBehavior];
6460       if (ns_use_native_fullscreen)
6461         b |= NSWindowCollectionBehaviorFullScreenPrimary;
6462       else
6463         b &= ~NSWindowCollectionBehaviorFullScreenPrimary;
6465       [win setCollectionBehavior: b];
6466       fs_is_native = ns_use_native_fullscreen;
6467     }
6469 #endif
6471 - (void)toggleFullScreen: (id)sender
6473   NSWindow *w, *fw;
6474   BOOL onFirstScreen;
6475   struct frame *f;
6476   NSSize sz;
6477   NSRect r, wr;
6478   NSColor *col;
6480   if (fs_is_native)
6481     {
6482 #ifdef HAVE_NATIVE_FS
6483       [[self window] toggleFullScreen:sender];
6484 #endif
6485       return;
6486     }
6488   w = [self window];
6489   onFirstScreen = [[w screen] isEqual:[[NSScreen screens] objectAtIndex:0]];
6490   f = emacsframe;
6491   wr = [w frame];
6492   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6493                                  (FRAME_DEFAULT_FACE (f)),
6494                                  f);
6496   sz.width = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
6497   sz.height = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
6499   if (fs_state != FULLSCREEN_BOTH)
6500     {
6501       NSScreen *screen = [w screen];
6503 #if defined (NS_IMPL_COCOA) && \
6504   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
6505       /* Hide ghost menu bar on secondary monitor? */
6506       if (! onFirstScreen)
6507         onFirstScreen = [NSScreen screensHaveSeparateSpaces];
6508 #endif
6509       /* Hide dock and menubar if we are on the primary screen.  */
6510       if (onFirstScreen)
6511         {
6512 #if defined (NS_IMPL_COCOA) && \
6513   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6514           NSApplicationPresentationOptions options
6515             = NSApplicationPresentationAutoHideDock
6516             | NSApplicationPresentationAutoHideMenuBar;
6518           [NSApp setPresentationOptions: options];
6519 #else
6520           [NSMenu setMenuBarVisible:NO];
6521 #endif
6522         }
6524       fw = [[EmacsFSWindow alloc]
6525                        initWithContentRect:[w contentRectForFrameRect:wr]
6526                                  styleMask:NSBorderlessWindowMask
6527                                    backing:NSBackingStoreBuffered
6528                                      defer:YES
6529                                     screen:screen];
6531       [fw setContentView:[w contentView]];
6532       [fw setTitle:[w title]];
6533       [fw setDelegate:self];
6534       [fw setAcceptsMouseMovedEvents: YES];
6535       [fw useOptimizedDrawing: YES];
6536       [fw setResizeIncrements: sz];
6537       [fw setBackgroundColor: col];
6538       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6539         [fw setOpaque: NO];
6541       f->border_width = 0;
6542       FRAME_NS_TITLEBAR_HEIGHT (f) = 0;
6543       tobar_height = FRAME_TOOLBAR_HEIGHT (f);
6544       FRAME_TOOLBAR_HEIGHT (f) = 0;
6546       nonfs_window = w;
6548       [self windowWillEnterFullScreen:nil];
6549       [fw makeKeyAndOrderFront:NSApp];
6550       [fw makeFirstResponder:self];
6551       [w orderOut:self];
6552       r = [fw frameRectForContentRect:[screen frame]];
6553       [fw setFrame: r display:YES animate:ns_use_fullscreen_animation];
6554       [self windowDidEnterFullScreen:nil];
6555       [fw display];
6556     }
6557   else
6558     {
6559       fw = w;
6560       w = nonfs_window;
6561       nonfs_window = nil;
6563       if (onFirstScreen)
6564         {
6565 #if defined (NS_IMPL_COCOA) && \
6566   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6567           [NSApp setPresentationOptions: NSApplicationPresentationDefault];
6568 #else
6569           [NSMenu setMenuBarVisible:YES];
6570 #endif
6571         }
6573       [w setContentView:[fw contentView]];
6574       [w setResizeIncrements: sz];
6575       [w setBackgroundColor: col];
6576       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6577         [w setOpaque: NO];
6579       f->border_width = bwidth;
6580       FRAME_NS_TITLEBAR_HEIGHT (f) = tibar_height;
6581       if (FRAME_EXTERNAL_TOOL_BAR (f))
6582         FRAME_TOOLBAR_HEIGHT (f) = tobar_height;
6584       [self windowWillExitFullScreen:nil];
6585       [fw setFrame: [w frame] display:YES animate:ns_use_fullscreen_animation];
6586       [fw close];
6587       [w makeKeyAndOrderFront:NSApp];
6588       [self windowDidExitFullScreen:nil];
6589       [self updateFrameSize:YES];
6590     }
6593 - (void)handleFS
6595   if (fs_state != emacsframe->want_fullscreen)
6596     {
6597       if (fs_state == FULLSCREEN_BOTH)
6598         {
6599           [self toggleFullScreen:self];
6600         }
6602       switch (emacsframe->want_fullscreen)
6603         {
6604         case FULLSCREEN_BOTH:
6605           [self toggleFullScreen:self];
6606           break;
6607         case FULLSCREEN_WIDTH:
6608           next_maximized = FULLSCREEN_WIDTH;
6609           if (fs_state != FULLSCREEN_BOTH)
6610             [[self window] performZoom:self];
6611           break;
6612         case FULLSCREEN_HEIGHT:
6613           next_maximized = FULLSCREEN_HEIGHT;
6614           if (fs_state != FULLSCREEN_BOTH)
6615             [[self window] performZoom:self];
6616           break;
6617         case FULLSCREEN_MAXIMIZED:
6618           next_maximized = FULLSCREEN_MAXIMIZED;
6619           if (fs_state != FULLSCREEN_BOTH)
6620             [[self window] performZoom:self];
6621           break;
6622         case FULLSCREEN_NONE:
6623           if (fs_state != FULLSCREEN_BOTH)
6624             {
6625               next_maximized = FULLSCREEN_NONE;
6626               [[self window] performZoom:self];
6627             }
6628           break;
6629         }
6631       emacsframe->want_fullscreen = FULLSCREEN_NONE;
6632     }
6636 - (void) setFSValue: (int)value
6638   Lisp_Object lval = Qnil;
6639   switch (value)
6640     {
6641     case FULLSCREEN_BOTH:
6642       lval = Qfullboth;
6643       break;
6644     case FULLSCREEN_WIDTH:
6645       lval = Qfullwidth;
6646       break;
6647     case FULLSCREEN_HEIGHT:
6648       lval = Qfullheight;
6649       break;
6650     case FULLSCREEN_MAXIMIZED:
6651       lval = Qmaximized;
6652       break;
6653     }
6654   store_frame_param (emacsframe, Qfullscreen, lval);
6655   fs_state = value;
6658 - (void)mouseEntered: (NSEvent *)theEvent
6660   NSTRACE (mouseEntered);
6661   if (emacsframe)
6662     FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6663       = EV_TIMESTAMP (theEvent);
6667 - (void)mouseExited: (NSEvent *)theEvent
6669   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
6671   NSTRACE (mouseExited);
6673   if (!hlinfo)
6674     return;
6676   FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6677     = EV_TIMESTAMP (theEvent);
6679   if (emacsframe == hlinfo->mouse_face_mouse_frame)
6680     {
6681       clear_mouse_face (hlinfo);
6682       hlinfo->mouse_face_mouse_frame = 0;
6683     }
6687 - menuDown: sender
6689   NSTRACE (menuDown);
6690   if (context_menu_value == -1)
6691     context_menu_value = [sender tag];
6692   else
6693     {
6694       NSInteger tag = [sender tag];
6695       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
6696                                     emacsframe->menu_bar_vector,
6697                                     (void *)tag);
6698     }
6700   ns_send_appdefined (-1);
6701   return self;
6705 - (EmacsToolbar *)toolbar
6707   return toolbar;
6711 /* this gets called on toolbar button click */
6712 - toolbarClicked: (id)item
6714   NSEvent *theEvent;
6715   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
6717   NSTRACE (toolbarClicked);
6719   if (!emacs_event)
6720     return self;
6722   /* send first event (for some reason two needed) */
6723   theEvent = [[self window] currentEvent];
6724   emacs_event->kind = TOOL_BAR_EVENT;
6725   XSETFRAME (emacs_event->arg, emacsframe);
6726   EV_TRAILER (theEvent);
6728   emacs_event->kind = TOOL_BAR_EVENT;
6729 /*   XSETINT (emacs_event->code, 0); */
6730   emacs_event->arg = AREF (emacsframe->tool_bar_items,
6731                            idx + TOOL_BAR_ITEM_KEY);
6732   emacs_event->modifiers = EV_MODIFIERS (theEvent);
6733   EV_TRAILER (theEvent);
6734   return self;
6738 - toggleToolbar: (id)sender
6740   if (!emacs_event)
6741     return self;
6743   emacs_event->kind = NS_NONKEY_EVENT;
6744   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
6745   EV_TRAILER ((id)nil);
6746   return self;
6750 - (void)drawRect: (NSRect)rect
6752   int x = NSMinX (rect), y = NSMinY (rect);
6753   int width = NSWidth (rect), height = NSHeight (rect);
6755   NSTRACE (drawRect);
6757   if (!emacsframe || !emacsframe->output_data.ns)
6758     return;
6760   ns_clear_frame_area (emacsframe, x, y, width, height);
6761   expose_frame (emacsframe, x, y, width, height);
6763   /*
6764     drawRect: may be called (at least in OS X 10.5) for invisible
6765     views as well for some reason.  Thus, do not infer visibility
6766     here.
6768     emacsframe->async_visible = 1;
6769     emacsframe->async_iconified = 0;
6770   */
6774 /* NSDraggingDestination protocol methods.  Actually this is not really a
6775    protocol, but a category of Object.  O well...  */
6777 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
6779   NSTRACE (draggingEntered);
6780   return NSDragOperationGeneric;
6784 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
6786   return YES;
6790 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
6792   id pb;
6793   int x, y;
6794   NSString *type;
6795   NSEvent *theEvent = [[self window] currentEvent];
6796   NSPoint position;
6797   NSDragOperation op = [sender draggingSourceOperationMask];
6798   int modifiers = 0;
6800   NSTRACE (performDragOperation);
6802   if (!emacs_event)
6803     return NO;
6805   position = [self convertPoint: [sender draggingLocation] fromView: nil];
6806   x = lrint (position.x);  y = lrint (position.y);
6808   pb = [sender draggingPasteboard];
6809   type = [pb availableTypeFromArray: ns_drag_types];
6811   if (! (op & (NSDragOperationMove|NSDragOperationDelete)) &&
6812       // URL drags contain all operations (0xf), don't allow all to be set.
6813       (op & 0xf) != 0xf)
6814     {
6815       if (op & NSDragOperationLink)
6816         modifiers |= NSControlKeyMask;
6817       if (op & NSDragOperationCopy)
6818         modifiers |= NSAlternateKeyMask;
6819       if (op & NSDragOperationGeneric)
6820         modifiers |= NSCommandKeyMask;
6821     }
6823   modifiers = EV_MODIFIERS2 (modifiers);
6824   if (type == 0)
6825     {
6826       return NO;
6827     }
6828   else if ([type isEqualToString: NSFilenamesPboardType])
6829     {
6830       NSArray *files;
6831       NSEnumerator *fenum;
6832       NSString *file;
6834       if (!(files = [pb propertyListForType: type]))
6835         return NO;
6837       fenum = [files objectEnumerator];
6838       while ( (file = [fenum nextObject]) )
6839         {
6840           emacs_event->kind = DRAG_N_DROP_EVENT;
6841           XSETINT (emacs_event->x, x);
6842           XSETINT (emacs_event->y, y);
6843           ns_input_file = append2 (ns_input_file,
6844                                    build_string ([file UTF8String]));
6845           emacs_event->modifiers = modifiers;
6846           emacs_event->arg =  list2 (Qfile, build_string ([file UTF8String]));
6847           EV_TRAILER (theEvent);
6848         }
6849       return YES;
6850     }
6851   else if ([type isEqualToString: NSURLPboardType])
6852     {
6853       NSURL *url = [NSURL URLFromPasteboard: pb];
6854       if (url == nil) return NO;
6856       emacs_event->kind = DRAG_N_DROP_EVENT;
6857       XSETINT (emacs_event->x, x);
6858       XSETINT (emacs_event->y, y);
6859       emacs_event->modifiers = modifiers;
6860       emacs_event->arg =  list2 (Qurl,
6861                                  build_string ([[url absoluteString]
6862                                                  UTF8String]));
6863       EV_TRAILER (theEvent);
6865       if ([url isFileURL] != NO)
6866         {
6867           NSString *file = [url path];
6868           ns_input_file = append2 (ns_input_file,
6869                                    build_string ([file UTF8String]));
6870         }
6871       return YES;
6872     }
6873   else if ([type isEqualToString: NSStringPboardType]
6874            || [type isEqualToString: NSTabularTextPboardType])
6875     {
6876       NSString *data;
6878       if (! (data = [pb stringForType: type]))
6879         return NO;
6881       emacs_event->kind = DRAG_N_DROP_EVENT;
6882       XSETINT (emacs_event->x, x);
6883       XSETINT (emacs_event->y, y);
6884       emacs_event->modifiers = modifiers;
6885       emacs_event->arg =  list2 (Qnil, build_string ([data UTF8String]));
6886       EV_TRAILER (theEvent);
6887       return YES;
6888     }
6889   else
6890     {
6891       fprintf (stderr, "Invalid data type in dragging pasteboard");
6892       return NO;
6893     }
6897 - (id) validRequestorForSendType: (NSString *)typeSent
6898                       returnType: (NSString *)typeReturned
6900   NSTRACE (validRequestorForSendType);
6901   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
6902       && typeReturned == nil)
6903     {
6904       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
6905         return self;
6906     }
6908   return [super validRequestorForSendType: typeSent
6909                                returnType: typeReturned];
6913 /* The next two methods are part of NSServicesRequests informal protocol,
6914    supposedly called when a services menu item is chosen from this app.
6915    But this should not happen because we override the services menu with our
6916    own entries which call ns-perform-service.
6917    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
6918    So let's at least stub them out until further investigation can be done. */
6920 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
6922   /* we could call ns_string_from_pasteboard(pboard) here but then it should
6923      be written into the buffer in place of the existing selection..
6924      ordinary service calls go through functions defined in ns-win.el */
6925   return NO;
6928 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
6930   NSArray *typesDeclared;
6931   Lisp_Object val;
6933   /* We only support NSStringPboardType */
6934   if ([types containsObject:NSStringPboardType] == NO) {
6935     return NO;
6936   }
6938   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6939   if (CONSP (val) && SYMBOLP (XCAR (val)))
6940     {
6941       val = XCDR (val);
6942       if (CONSP (val) && NILP (XCDR (val)))
6943         val = XCAR (val);
6944     }
6945   if (! STRINGP (val))
6946     return NO;
6948   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
6949   [pb declareTypes:typesDeclared owner:nil];
6950   ns_string_to_pasteboard (pb, val);
6951   return YES;
6955 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
6956    (gives a miniaturized version of the window); currently we use the latter for
6957    frames whose active buffer doesn't correspond to any file
6958    (e.g., '*scratch*') */
6959 - setMiniwindowImage: (BOOL) setMini
6961   id image = [[self window] miniwindowImage];
6962   NSTRACE (setMiniwindowImage);
6964   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
6965      about "AppleDockIconEnabled" notwithstanding, however the set message
6966      below has its effect nonetheless. */
6967   if (image != emacsframe->output_data.ns->miniimage)
6968     {
6969       if (image && [image isKindOfClass: [EmacsImage class]])
6970         [image release];
6971       [[self window] setMiniwindowImage:
6972                        setMini ? emacsframe->output_data.ns->miniimage : nil];
6973     }
6975   return self;
6979 - (void) setRows: (int) r andColumns: (int) c
6981   rows = r;
6982   cols = c;
6985 @end  /* EmacsView */
6989 /* ==========================================================================
6991     EmacsWindow implementation
6993    ========================================================================== */
6995 @implementation EmacsWindow
6997 #ifdef NS_IMPL_COCOA
6998 - (id)accessibilityAttributeValue:(NSString *)attribute
7000   Lisp_Object str = Qnil;
7001   struct frame *f = SELECTED_FRAME ();
7002   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->contents);
7004   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
7005     return NSAccessibilityTextFieldRole;
7007   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
7008       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
7009     {
7010       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
7011     }
7012   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
7013     {
7014       if (! NILP (BVAR (curbuf, mark_active)))
7015           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
7017       if (NILP (str))
7018         {
7019           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
7020           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
7021           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
7023           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
7024             str = make_uninit_multibyte_string (range, byte_range);
7025           else
7026             str = make_uninit_string (range);
7027           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
7028              Is this a problem?  */
7029           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
7030         }
7031     }
7034   if (! NILP (str))
7035     {
7036       if (CONSP (str) && SYMBOLP (XCAR (str)))
7037         {
7038           str = XCDR (str);
7039           if (CONSP (str) && NILP (XCDR (str)))
7040             str = XCAR (str);
7041         }
7042       if (STRINGP (str))
7043         {
7044           const char *utfStr = SSDATA (str);
7045           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
7046           return nsStr;
7047         }
7048     }
7050   return [super accessibilityAttributeValue:attribute];
7052 #endif /* NS_IMPL_COCOA */
7054 /* If we have multiple monitors, one above the other, we don't want to
7055    restrict the height to just one monitor.  So we override this.  */
7056 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
7058   /* When making the frame visible for the first time or if there is just
7059      one screen, we want to constrain.  Other times not.  */
7060   NSArray *screens = [NSScreen screens];
7061   NSUInteger nr_screens = [screens count], nr_eff_screens = 0, i;
7062   struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
7063   NSTRACE (constrainFrameRect);
7064   NSTRACE_RECT ("input", frameRect);
7066   if (ns_menu_bar_should_be_hidden ())
7067     return frameRect;
7069   if (nr_screens == 1)
7070     return [super constrainFrameRect:frameRect toScreen:screen];
7072 #ifdef NS_IMPL_COCOA
7073 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
7074   // If separate spaces is on, it is like each screen is independent.  There is
7075   // no spanning of frames across screens.
7076   if ([NSScreen screensHaveSeparateSpaces])
7077     return [super constrainFrameRect:frameRect toScreen:screen];
7078 #endif
7079 #endif
7081   for (i = 0; i < nr_screens; ++i) 
7082     {
7083       NSScreen *s = [screens objectAtIndex: i];
7084       NSRect scrrect = [s frame];
7085       NSRect intersect = NSIntersectionRect (frameRect, scrrect);
7087       if (intersect.size.width > 0 || intersect.size.height > 0)
7088         ++nr_eff_screens;
7089     }
7091   if (nr_eff_screens == 1)
7092     return [super constrainFrameRect:frameRect toScreen:screen];
7094   /* The default implementation does two things 1) ensure that the top
7095      of the rectangle is below the menu bar (or below the top of the
7096      screen) and 2) resizes windows larger than the screen. As we
7097      don't want the latter, a smaller rectangle is used. */
7098 #define FAKE_HEIGHT 64
7099   float old_top = frameRect.origin.y + frameRect.size.height;
7100   NSRect r;
7101   r.size.height = FAKE_HEIGHT;
7102   r.size.width = frameRect.size.width;
7103   r.origin.x = frameRect.origin.x;
7104   r.origin.y = old_top - FAKE_HEIGHT;
7106   NSTRACE_RECT ("input to super", r);
7108   r = [super constrainFrameRect:r toScreen:screen];
7110   NSTRACE_RECT ("output from super", r);
7112   float new_top = r.origin.y + FAKE_HEIGHT;
7113   if (new_top < old_top)
7114   {
7115     frameRect.origin.y = new_top - frameRect.size.height;
7116   }
7118   NSTRACE_RECT ("output", frameRect);
7120   return frameRect;
7121 #undef FAKE_HEIGHT
7124 @end /* EmacsWindow */
7127 @implementation EmacsFSWindow
7129 - (BOOL)canBecomeKeyWindow
7131   return YES;
7134 - (BOOL)canBecomeMainWindow
7136   return YES;
7139 @end
7141 /* ==========================================================================
7143     EmacsScroller implementation
7145    ========================================================================== */
7148 @implementation EmacsScroller
7150 /* for repeat button push */
7151 #define SCROLL_BAR_FIRST_DELAY 0.5
7152 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
7154 + (CGFloat) scrollerWidth
7156   /* TODO: if we want to allow variable widths, this is the place to do it,
7157            however neither GNUstep nor Cocoa support it very well */
7158   return [NSScroller scrollerWidth];
7162 - initFrame: (NSRect )r window: (Lisp_Object)nwin
7164   NSTRACE (EmacsScroller_initFrame);
7166   r.size.width = [EmacsScroller scrollerWidth];
7167   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
7168   [self setContinuous: YES];
7169   [self setEnabled: YES];
7171   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
7172      locked against the top and bottom edges, and right edge on OS X, where
7173      scrollers are on right. */
7174 #ifdef NS_IMPL_GNUSTEP
7175   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
7176 #else
7177   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
7178 #endif
7180   win = nwin;
7181   condemned = NO;
7182   pixel_height = NSHeight (r);
7183   if (pixel_height == 0) pixel_height = 1;
7184   min_portion = 20 / pixel_height;
7186   frame = XFRAME (XWINDOW (win)->frame);
7187   if (FRAME_LIVE_P (frame))
7188     {
7189       int i;
7190       EmacsView *view = FRAME_NS_VIEW (frame);
7191       NSView *sview = [[view window] contentView];
7192       NSArray *subs = [sview subviews];
7194       /* disable optimization stopping redraw of other scrollbars */
7195       view->scrollbarsNeedingUpdate = 0;
7196       for (i =[subs count]-1; i >= 0; i--)
7197         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
7198           view->scrollbarsNeedingUpdate++;
7199       [sview addSubview: self];
7200     }
7202 /*  [self setFrame: r]; */
7204   return self;
7208 - (void)setFrame: (NSRect)newRect
7210   NSTRACE (EmacsScroller_setFrame);
7211 /*  block_input (); */
7212   pixel_height = NSHeight (newRect);
7213   if (pixel_height == 0) pixel_height = 1;
7214   min_portion = 20 / pixel_height;
7215   [super setFrame: newRect];
7216   [self display];
7217 /*  unblock_input (); */
7221 - condemn
7223   NSTRACE (condemn);
7224   condemned =YES;
7225   return self;
7229 - reprieve
7231   NSTRACE (reprieve);
7232   condemned =NO;
7233   return self;
7237 - judge
7239   NSTRACE (judge);
7240   if (condemned)
7241     {
7242       EmacsView *view;
7243       block_input ();
7244       /* ensure other scrollbar updates after deletion */
7245       view = (EmacsView *)FRAME_NS_VIEW (frame);
7246       if (view != nil)
7247         view->scrollbarsNeedingUpdate++;
7248       if (!NILP (win))
7249         wset_vertical_scroll_bar (XWINDOW (win), Qnil);
7250       win = Qnil;
7251       [self removeFromSuperview];
7252       [self release];
7253       unblock_input ();
7254     }
7255   return self;
7259 - (void)resetCursorRects
7261   NSRect visible = [self visibleRect];
7262   NSTRACE (resetCursorRects);
7264   if (!NSIsEmptyRect (visible))
7265     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
7266   [[NSCursor arrowCursor] setOnMouseEntered: YES];
7270 - (int) checkSamePosition: (int) position portion: (int) portion
7271                     whole: (int) whole
7273   return em_position ==position && em_portion ==portion && em_whole ==whole
7274     && portion != whole; /* needed for resize empty buf */
7278 - setPosition: (int)position portion: (int)portion whole: (int)whole
7280   NSTRACE (setPosition);
7282   em_position = position;
7283   em_portion = portion;
7284   em_whole = whole;
7286   if (portion >= whole)
7287     {
7288 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7289       [self setKnobProportion: 1.0];
7290       [self setDoubleValue: 1.0];
7291 #else
7292       [self setFloatValue: 0.0 knobProportion: 1.0];
7293 #endif
7294     }
7295   else
7296     {
7297       float pos;
7298       CGFloat por;
7299       portion = max ((float)whole*min_portion/pixel_height, portion);
7300       pos = (float)position / (whole - portion);
7301       por = (CGFloat)portion/whole;
7302 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7303       [self setKnobProportion: por];
7304       [self setDoubleValue: pos];
7305 #else
7306       [self setFloatValue: pos knobProportion: por];
7307 #endif
7308     }
7310   /* Events may come here even if the event loop is not running.
7311      If we don't enter the event loop, the scroll bar will not update.
7312      So send SIGIO to ourselves.  */
7313   if (apploopnr == 0) raise (SIGIO);
7315   return self;
7318 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
7319      drag events will go directly to the EmacsScroller.  Leaving in for now. */
7320 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
7321                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
7323   *part = last_hit_part;
7324   *window = win;
7325   XSETINT (*y, pixel_height);
7326   if ([self floatValue] > 0.999F)
7327     XSETINT (*x, pixel_height);
7328   else
7329     XSETINT (*x, pixel_height * [self floatValue]);
7333 /* set up emacs_event */
7334 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
7336   if (!emacs_event)
7337     return;
7339   emacs_event->part = last_hit_part;
7340   emacs_event->code = 0;
7341   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
7342   emacs_event->frame_or_window = win;
7343   emacs_event->timestamp = EV_TIMESTAMP (e);
7344   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
7345   emacs_event->arg = Qnil;
7346   XSETINT (emacs_event->x, loc * pixel_height);
7347   XSETINT (emacs_event->y, pixel_height-20);
7349   if (q_event_ptr)
7350     {
7351       n_emacs_events_pending++;
7352       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
7353     }
7354   else
7355     hold_event (emacs_event);
7356   EVENT_INIT (*emacs_event);
7357   ns_send_appdefined (-1);
7361 /* called manually thru timer to implement repeated button action w/hold-down */
7362 - repeatScroll: (NSTimer *)scrollEntry
7364   NSEvent *e = [[self window] currentEvent];
7365   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
7366   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
7368   /* clear timer if need be */
7369   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
7370     {
7371         [scroll_repeat_entry invalidate];
7372         [scroll_repeat_entry release];
7373         scroll_repeat_entry = nil;
7375         if (inKnob)
7376           return self;
7378         scroll_repeat_entry
7379           = [[NSTimer scheduledTimerWithTimeInterval:
7380                         SCROLL_BAR_CONTINUOUS_DELAY
7381                                             target: self
7382                                           selector: @selector (repeatScroll:)
7383                                           userInfo: 0
7384                                            repeats: YES]
7385               retain];
7386     }
7388   [self sendScrollEventAtLoc: 0 fromEvent: e];
7389   return self;
7393 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
7394    mouseDragged events without going into a modal loop. */
7395 - (void)mouseDown: (NSEvent *)e
7397   NSRect sr, kr;
7398   /* hitPart is only updated AFTER event is passed on */
7399   NSScrollerPart part = [self testPart: [e locationInWindow]];
7400   CGFloat inc = 0.0, loc, kloc, pos;
7401   int edge = 0;
7403   NSTRACE (EmacsScroller_mouseDown);
7405   switch (part)
7406     {
7407     case NSScrollerDecrementPage:
7408         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
7409     case NSScrollerIncrementPage:
7410         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
7411     case NSScrollerDecrementLine:
7412       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
7413     case NSScrollerIncrementLine:
7414       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
7415     case NSScrollerKnob:
7416       last_hit_part = scroll_bar_handle; break;
7417     case NSScrollerKnobSlot:  /* GNUstep-only */
7418       last_hit_part = scroll_bar_move_ratio; break;
7419     default:  /* NSScrollerNoPart? */
7420       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
7421                (long) part);
7422       return;
7423     }
7425   if (inc != 0.0)
7426     {
7427       pos = 0;      /* ignored */
7429       /* set a timer to repeat, as we can't let superclass do this modally */
7430       scroll_repeat_entry
7431         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
7432                                             target: self
7433                                           selector: @selector (repeatScroll:)
7434                                           userInfo: 0
7435                                            repeats: YES]
7436             retain];
7437     }
7438   else
7439     {
7440       /* handle, or on GNUstep possibly slot */
7441       NSEvent *fake_event;
7443       /* compute float loc in slot and mouse offset on knob */
7444       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7445                       toView: nil];
7446       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7447       if (loc <= 0.0)
7448         {
7449           loc = 0.0;
7450           edge = -1;
7451         }
7452       else if (loc >= NSHeight (sr))
7453         {
7454           loc = NSHeight (sr);
7455           edge = 1;
7456         }
7458       if (edge)
7459         kloc = 0.5 * edge;
7460       else
7461         {
7462           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
7463                           toView: nil];
7464           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
7465         }
7466       last_mouse_offset = kloc;
7468       /* if knob, tell emacs a location offset by knob pos
7469          (to indicate top of handle) */
7470       if (part == NSScrollerKnob)
7471           pos = (loc - last_mouse_offset) / NSHeight (sr);
7472       else
7473         /* else this is a slot click on GNUstep: go straight there */
7474         pos = loc / NSHeight (sr);
7476       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
7477       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
7478                                       location: [e locationInWindow]
7479                                  modifierFlags: [e modifierFlags]
7480                                      timestamp: [e timestamp]
7481                                   windowNumber: [e windowNumber]
7482                                        context: [e context]
7483                                    eventNumber: [e eventNumber]
7484                                     clickCount: [e clickCount]
7485                                       pressure: [e pressure]];
7486       [super mouseUp: fake_event];
7487     }
7489   if (part != NSScrollerKnob)
7490     [self sendScrollEventAtLoc: pos fromEvent: e];
7494 /* Called as we manually track scroller drags, rather than superclass. */
7495 - (void)mouseDragged: (NSEvent *)e
7497     NSRect sr;
7498     double loc, pos;
7500     NSTRACE (EmacsScroller_mouseDragged);
7502       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7503                       toView: nil];
7504       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7506       if (loc <= 0.0)
7507         {
7508           loc = 0.0;
7509         }
7510       else if (loc >= NSHeight (sr) + last_mouse_offset)
7511         {
7512           loc = NSHeight (sr) + last_mouse_offset;
7513         }
7515       pos = (loc - last_mouse_offset) / NSHeight (sr);
7516       [self sendScrollEventAtLoc: pos fromEvent: e];
7520 - (void)mouseUp: (NSEvent *)e
7522   if (scroll_repeat_entry)
7523     {
7524       [scroll_repeat_entry invalidate];
7525       [scroll_repeat_entry release];
7526       scroll_repeat_entry = nil;
7527     }
7528   last_hit_part = scroll_bar_above_handle;
7532 /* treat scrollwheel events in the bar as though they were in the main window */
7533 - (void) scrollWheel: (NSEvent *)theEvent
7535   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
7536   [view mouseDown: theEvent];
7539 @end  /* EmacsScroller */
7542 #ifdef NS_IMPL_GNUSTEP
7543 /* Dummy class to get rid of startup warnings.  */
7544 @implementation EmacsDocument
7546 @end
7547 #endif
7550 /* ==========================================================================
7552    Font-related functions; these used to be in nsfaces.m
7554    ========================================================================== */
7557 Lisp_Object
7558 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7560   struct font *font = XFONT_OBJECT (font_object);
7561   EmacsView *view = FRAME_NS_VIEW (f);
7563   if (fontset < 0)
7564     fontset = fontset_from_font (font_object);
7565   FRAME_FONTSET (f) = fontset;
7567   if (FRAME_FONT (f) == font)
7568     /* This font is already set in frame F.  There's nothing more to
7569        do.  */
7570     return font_object;
7572   FRAME_FONT (f) = font;
7574   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7575   FRAME_COLUMN_WIDTH (f) = font->average_width;
7576   FRAME_LINE_HEIGHT (f) = font->height;
7578   /* Compute the scroll bar width in character columns.  */
7579   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7580     {
7581       int wid = FRAME_COLUMN_WIDTH (f);
7582       FRAME_CONFIG_SCROLL_BAR_COLS (f)
7583         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
7584     }
7585   else
7586     {
7587       int wid = FRAME_COLUMN_WIDTH (f);
7588       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7589     }
7591   /* Compute the scroll bar height in character lines.  */
7592   if (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0)
7593     {
7594       int height = FRAME_LINE_HEIGHT (f);
7595       FRAME_CONFIG_SCROLL_BAR_LINES (f)
7596         = (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) + height - 1) / height;
7597     }
7598   else
7599     {
7600       int height = FRAME_LINE_HEIGHT (f);
7601       FRAME_CONFIG_SCROLL_BAR_LINES (f) = (14 + height - 1) / height;
7602     }
7604   /* Now make the frame display the given font.  */
7605   if (FRAME_NS_WINDOW (f) != 0 && ! [view isFullscreen])
7606     x_set_window_size (f, 0, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
7607                        FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1);
7609   return font_object;
7613 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
7614 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
7615          in 1.43. */
7617 const char *
7618 ns_xlfd_to_fontname (const char *xlfd)
7619 /* --------------------------------------------------------------------------
7620     Convert an X font name (XLFD) to an NS font name.
7621     Only family is used.
7622     The string returned is temporarily allocated.
7623    -------------------------------------------------------------------------- */
7625   char *name = xmalloc (180);
7626   int i, len;
7627   const char *ret;
7629   if (!strncmp (xlfd, "--", 2))
7630     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
7631   else
7632     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
7634   /* stopgap for malformed XLFD input */
7635   if (strlen (name) == 0)
7636     strcpy (name, "Monaco");
7638   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
7639      also uppercase after '-' or ' ' */
7640   name[0] = c_toupper (name[0]);
7641   for (len =strlen (name), i =0; i<len; i++)
7642     {
7643       if (name[i] == '$')
7644         {
7645           name[i] = '-';
7646           if (i+1<len)
7647             name[i+1] = c_toupper (name[i+1]);
7648         }
7649       else if (name[i] == '_')
7650         {
7651           name[i] = ' ';
7652           if (i+1<len)
7653             name[i+1] = c_toupper (name[i+1]);
7654         }
7655     }
7656 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
7657   ret = [[NSString stringWithUTF8String: name] UTF8String];
7658   xfree (name);
7659   return ret;
7663 void
7664 syms_of_nsterm (void)
7666   NSTRACE (syms_of_nsterm);
7668   ns_antialias_threshold = 10.0;
7670   /* from 23+ we need to tell emacs what modifiers there are.. */
7671   DEFSYM (Qmodifier_value, "modifier-value");
7672   DEFSYM (Qalt, "alt");
7673   DEFSYM (Qhyper, "hyper");
7674   DEFSYM (Qmeta, "meta");
7675   DEFSYM (Qsuper, "super");
7676   DEFSYM (Qcontrol, "control");
7677   DEFSYM (QUTF8_STRING, "UTF8_STRING");
7679   DEFSYM (Qfile, "file");
7680   DEFSYM (Qurl, "url");
7682   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
7683   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
7684   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
7685   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
7686   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
7688   DEFVAR_LISP ("ns-input-file", ns_input_file,
7689               "The file specified in the last NS event.");
7690   ns_input_file =Qnil;
7692   DEFVAR_LISP ("ns-working-text", ns_working_text,
7693               "String for visualizing working composition sequence.");
7694   ns_working_text =Qnil;
7696   DEFVAR_LISP ("ns-input-font", ns_input_font,
7697               "The font specified in the last NS event.");
7698   ns_input_font =Qnil;
7700   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
7701               "The fontsize specified in the last NS event.");
7702   ns_input_fontsize =Qnil;
7704   DEFVAR_LISP ("ns-input-line", ns_input_line,
7705                "The line specified in the last NS event.");
7706   ns_input_line =Qnil;
7708   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
7709                "The service name specified in the last NS event.");
7710   ns_input_spi_name =Qnil;
7712   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
7713                "The service argument specified in the last NS event.");
7714   ns_input_spi_arg =Qnil;
7716   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
7717                "This variable describes the behavior of the alternate or option key.\n\
7718 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7719 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7720 at all, allowing it to be used at a lower level for accented character entry.");
7721   ns_alternate_modifier = Qmeta;
7723   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
7724                "This variable describes the behavior of the right alternate or option key.\n\
7725 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7726 Set to left means be the same key as `ns-alternate-modifier'.\n\
7727 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7728 at all, allowing it to be used at a lower level for accented character entry.");
7729   ns_right_alternate_modifier = Qleft;
7731   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
7732                "This variable describes the behavior of the command key.\n\
7733 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7734   ns_command_modifier = Qsuper;
7736   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
7737                "This variable describes the behavior of the right command key.\n\
7738 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7739 Set to left means be the same key as `ns-command-modifier'.\n\
7740 Set to none means that the command / option key is not interpreted by Emacs\n\
7741 at all, allowing it to be used at a lower level for accented character entry.");
7742   ns_right_command_modifier = Qleft;
7744   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
7745                "This variable describes the behavior of the control key.\n\
7746 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7747   ns_control_modifier = Qcontrol;
7749   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
7750                "This variable describes the behavior of the right control key.\n\
7751 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7752 Set to left means be the same key as `ns-control-modifier'.\n\
7753 Set to none means that the control / option key is not interpreted by Emacs\n\
7754 at all, allowing it to be used at a lower level for accented character entry.");
7755   ns_right_control_modifier = Qleft;
7757   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
7758                "This variable describes the behavior of the function key (on laptops).\n\
7759 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7760 Set to none means that the function key is not interpreted by Emacs at all,\n\
7761 allowing it to be used at a lower level for accented character entry.");
7762   ns_function_modifier = Qnone;
7764   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
7765                "Non-nil (the default) means to render text antialiased.");
7766   ns_antialias_text = Qt;
7768   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
7769                "Whether to confirm application quit using dialog.");
7770   ns_confirm_quit = Qnil;
7772   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
7773                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
7774 Only works on OSX 10.6 or later.  */);
7775   ns_auto_hide_menu_bar = Qnil;
7777   DEFVAR_BOOL ("ns-use-native-fullscreen", ns_use_native_fullscreen,
7778      doc: /*Non-nil means to use native fullscreen on OSX >= 10.7.
7779 Nil means use fullscreen the old (< 10.7) way.  The old way works better with
7780 multiple monitors, but lacks tool bar.  This variable is ignored on OSX < 10.7.
7781 Default is t for OSX >= 10.7, nil otherwise.  */);
7782 #ifdef HAVE_NATIVE_FS
7783   ns_use_native_fullscreen = YES;
7784 #else
7785   ns_use_native_fullscreen = NO;
7786 #endif
7787   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
7789   DEFVAR_BOOL ("ns-use-fullscreen-animation", ns_use_fullscreen_animation,
7790      doc: /*Non-nil means use animation on non-native fullscreen.
7791 For native fullscreen, this does nothing.
7792 Default is nil.  */);
7793   ns_use_fullscreen_animation = NO;
7795   DEFVAR_BOOL ("ns-use-srgb-colorspace", ns_use_srgb_colorspace,
7796      doc: /*Non-nil means to use sRGB colorspace on OSX >= 10.7.
7797 Note that this does not apply to images.
7798 This variable is ignored on OSX < 10.7 and GNUstep.  */);
7799   ns_use_srgb_colorspace = YES;
7801   /* TODO: move to common code */
7802   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
7803                doc: /* Which toolkit scroll bars Emacs uses, if any.
7804 A value of nil means Emacs doesn't use toolkit scroll bars.
7805 With the X Window system, the value is a symbol describing the
7806 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
7807 With MS Windows or Nextstep, the value is t.  */);
7808   Vx_toolkit_scroll_bars = Qt;
7810   DEFVAR_BOOL ("x-use-underline-position-properties",
7811                x_use_underline_position_properties,
7812      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
7813 A value of nil means ignore them.  If you encounter fonts with bogus
7814 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
7815 to 4.1, set this to nil. */);
7816   x_use_underline_position_properties = 0;
7818   DEFVAR_BOOL ("x-underline-at-descent-line",
7819                x_underline_at_descent_line,
7820      doc: /* Non-nil means to draw the underline at the same place as the descent line.
7821 A value of nil means to draw the underline according to the value of the
7822 variable `x-use-underline-position-properties', which is usually at the
7823 baseline level.  The default value is nil.  */);
7824   x_underline_at_descent_line = 0;
7826   /* Tell Emacs about this window system.  */
7827   Fprovide (Qns, Qnil);
7829   DEFSYM (Qcocoa, "cocoa");
7830   DEFSYM (Qgnustep, "gnustep");
7832   syms_of_nsfont ();
7833 #ifdef NS_IMPL_COCOA
7834   Fprovide (Qcocoa, Qnil);
7835 #if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
7836   syms_of_macfont ();
7837 #endif
7838 #else
7839   Fprovide (Qgnustep, Qnil);
7840 #endif