* admin/authors.el (authors-renamed-files-alist): Add package-x-test.el
[emacs/old-mirror.git] / src / nsterm.m
blobd40541f512550c1d0548517e8d764d325056756e
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       fy += h - cursor_height;
2445       h = cursor_height;
2446     }
2448   r.origin.x = fx, r.origin.y = fy;
2449   r.size.height = h;
2450   r.size.width = w->phys_cursor_width;
2452   /* TODO: only needed in rare cases with last-resort font in HELLO..
2453      should we do this more efficiently? */
2454   ns_clip_to_row (w, glyph_row, ANY_AREA, NO); /* do ns_focus(f, &r, 1); if remove */
2457   face = FACE_FROM_ID (f, phys_cursor_glyph->face_id);
2458   if (face && NS_FACE_BACKGROUND (face)
2459       == ns_index_color (FRAME_CURSOR_COLOR (f), f))
2460     {
2461       [ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), f) set];
2462       hollow_color = FRAME_CURSOR_COLOR (f);
2463     }
2464   else
2465     [FRAME_CURSOR_COLOR (f) set];
2467 #ifdef NS_IMPL_COCOA
2468   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2469            atomic.  Cleaner ways of doing this should be investigated.
2470            One way would be to set a global variable DRAWING_CURSOR
2471            when making the call to draw_phys..(), don't focus in that
2472            case, then move the ns_unfocus() here after that call. */
2473   NSDisableScreenUpdates ();
2474 #endif
2476   switch (cursor_type)
2477     {
2478     case NO_CURSOR:
2479       break;
2480     case FILLED_BOX_CURSOR:
2481       NSRectFill (r);
2482       break;
2483     case HOLLOW_BOX_CURSOR:
2484       NSRectFill (r);
2485       [hollow_color set];
2486       NSRectFill (NSInsetRect (r, 1, 1));
2487       [FRAME_CURSOR_COLOR (f) set];
2488       break;
2489     case HBAR_CURSOR:
2490       NSRectFill (r);
2491       break;
2492     case BAR_CURSOR:
2493       s = r;
2494       /* If the character under cursor is R2L, draw the bar cursor
2495          on the right of its glyph, rather than on the left.  */
2496       cursor_glyph = get_phys_cursor_glyph (w);
2497       if ((cursor_glyph->resolved_level & 1) != 0)
2498         s.origin.x += cursor_glyph->pixel_width - s.size.width;
2500       NSRectFill (s);
2501       break;
2502     }
2503   ns_unfocus (f);
2505   /* draw the character under the cursor */
2506   if (cursor_type != NO_CURSOR)
2507     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2509 #ifdef NS_IMPL_COCOA
2510   NSEnableScreenUpdates ();
2511 #endif
2516 static void
2517 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2518 /* --------------------------------------------------------------------------
2519      External (RIF): Draw a vertical line.
2520    -------------------------------------------------------------------------- */
2522   struct frame *f = XFRAME (WINDOW_FRAME (w));
2523   struct face *face;
2524   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2526   NSTRACE (ns_draw_vertical_window_border);
2528   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2529   if (face)
2530       [ns_lookup_indexed_color(face->foreground, f) set];
2532   ns_focus (f, &r, 1);
2533   NSRectFill(r);
2534   ns_unfocus (f);
2538 static void
2539 ns_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
2540 /* --------------------------------------------------------------------------
2541      External (RIF): Draw a window divider.
2542    -------------------------------------------------------------------------- */
2544   struct frame *f = XFRAME (WINDOW_FRAME (w));
2545   struct face *face;
2546   NSRect r = NSMakeRect (x0, y0, x1-x0, y1-y0);
2548   NSTRACE (ns_draw_window_divider);
2550   face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
2551   if (face)
2552       [ns_lookup_indexed_color(face->foreground, f) set];
2554   ns_focus (f, &r, 1);
2555   NSRectFill(r);
2556   ns_unfocus (f);
2559 static void
2560 ns_show_hourglass (struct frame *f)
2562   /* TODO: add NSProgressIndicator to all frames.  */
2565 static void
2566 ns_hide_hourglass (struct frame *f)
2568   /* TODO: remove NSProgressIndicator from all frames.  */
2571 /* ==========================================================================
2573     Glyph drawing operations
2575    ========================================================================== */
2577 static int
2578 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2579 /* --------------------------------------------------------------------------
2580     Wrapper utility to account for internal border width on full-width lines,
2581     and allow top full-width rows to hit the frame top.  nr should be pointer
2582     to two successive NSRects.  Number of rects actually used is returned.
2583    -------------------------------------------------------------------------- */
2585   int n = get_glyph_string_clip_rects (s, nr, 2);
2586   return n;
2589 /* --------------------------------------------------------------------
2590    Draw a wavy line under glyph string s. The wave fills wave_height
2591    pixels from y.
2593                     x          wave_length = 2
2594                                  --
2595                 y    *   *   *   *   *
2596                      |* * * * * * * * *
2597     wave_height = 3  | *   *   *   *
2598   --------------------------------------------------------------------- */
2600 static void
2601 ns_draw_underwave (struct glyph_string *s, EmacsCGFloat width, EmacsCGFloat x)
2603   int wave_height = 3, wave_length = 2;
2604   int y, dx, dy, odd, xmax;
2605   NSPoint a, b;
2606   NSRect waveClip;
2608   dx = wave_length;
2609   dy = wave_height - 1;
2610   y =  s->ybase - wave_height + 3;
2611   xmax = x + width;
2613   /* Find and set clipping rectangle */
2614   waveClip = NSMakeRect (x, y, width, wave_height);
2615   [[NSGraphicsContext currentContext] saveGraphicsState];
2616   NSRectClip (waveClip);
2618   /* Draw the waves */
2619   a.x = x - ((int)(x) % dx) + (EmacsCGFloat) 0.5;
2620   b.x = a.x + dx;
2621   odd = (int)(a.x/dx) % 2;
2622   a.y = b.y = y + 0.5;
2624   if (odd)
2625     a.y += dy;
2626   else
2627     b.y += dy;
2629   while (a.x <= xmax)
2630     {
2631       [NSBezierPath strokeLineFromPoint:a toPoint:b];
2632       a.x = b.x, a.y = b.y;
2633       b.x += dx, b.y = y + 0.5 + odd*dy;
2634       odd = !odd;
2635     }
2637   /* Restore previous clipping rectangle(s) */
2638   [[NSGraphicsContext currentContext] restoreGraphicsState];
2643 void
2644 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
2645                          NSColor *defaultCol, CGFloat width, CGFloat x)
2646 /* --------------------------------------------------------------------------
2647    Draw underline, overline, and strike-through on glyph string s.
2648    -------------------------------------------------------------------------- */
2650   if (s->for_overlaps)
2651     return;
2653   /* Do underline. */
2654   if (face->underline_p)
2655     {
2656       if (s->face->underline_type == FACE_UNDER_WAVE)
2657         {
2658           if (face->underline_defaulted_p)
2659             [defaultCol set];
2660           else
2661             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2663           ns_draw_underwave (s, width, x);
2664         }
2665       else if (s->face->underline_type == FACE_UNDER_LINE)
2666         {
2668           NSRect r;
2669           unsigned long thickness, position;
2671           /* If the prev was underlined, match its appearance. */
2672           if (s->prev && s->prev->face->underline_p
2673               && s->prev->face->underline_type == FACE_UNDER_LINE
2674               && s->prev->underline_thickness > 0)
2675             {
2676               thickness = s->prev->underline_thickness;
2677               position = s->prev->underline_position;
2678             }
2679           else
2680             {
2681               struct font *font;
2682               unsigned long descent;
2684               font=s->font;
2685               descent = s->y + s->height - s->ybase;
2687               /* Use underline thickness of font, defaulting to 1. */
2688               thickness = (font && font->underline_thickness > 0)
2689                 ? font->underline_thickness : 1;
2691               /* Determine the offset of underlining from the baseline. */
2692               if (x_underline_at_descent_line)
2693                 position = descent - thickness;
2694               else if (x_use_underline_position_properties
2695                        && font && font->underline_position >= 0)
2696                 position = font->underline_position;
2697               else if (font)
2698                 position = lround (font->descent / 2);
2699               else
2700                 position = underline_minimum_offset;
2702               position = max (position, underline_minimum_offset);
2704               /* Ensure underlining is not cropped. */
2705               if (descent <= position)
2706                 {
2707                   position = descent - 1;
2708                   thickness = 1;
2709                 }
2710               else if (descent < position + thickness)
2711                 thickness = 1;
2712             }
2714           s->underline_thickness = thickness;
2715           s->underline_position = position;
2717           r = NSMakeRect (x, s->ybase + position, width, thickness);
2719           if (face->underline_defaulted_p)
2720             [defaultCol set];
2721           else
2722             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2723           NSRectFill (r);
2724         }
2725     }
2726   /* Do overline. We follow other terms in using a thickness of 1
2727      and ignoring overline_margin. */
2728   if (face->overline_p)
2729     {
2730       NSRect r;
2731       r = NSMakeRect (x, s->y, width, 1);
2733       if (face->overline_color_defaulted_p)
2734         [defaultCol set];
2735       else
2736         [ns_lookup_indexed_color (face->overline_color, s->f) set];
2737       NSRectFill (r);
2738     }
2740   /* Do strike-through.  We follow other terms for thickness and
2741      vertical position.*/
2742   if (face->strike_through_p)
2743     {
2744       NSRect r;
2745       unsigned long dy;
2747       dy = lrint ((s->height - 1) / 2);
2748       r = NSMakeRect (x, s->y + dy, width, 1);
2750       if (face->strike_through_color_defaulted_p)
2751         [defaultCol set];
2752       else
2753         [ns_lookup_indexed_color (face->strike_through_color, s->f) set];
2754       NSRectFill (r);
2755     }
2758 static void
2759 ns_draw_box (NSRect r, CGFloat thickness, NSColor *col,
2760              char left_p, char right_p)
2761 /* --------------------------------------------------------------------------
2762     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2763     Note we can't just use an NSDrawRect command, because of the possibility
2764     of some sides not being drawn, and because the rect will be filled.
2765    -------------------------------------------------------------------------- */
2767   NSRect s = r;
2768   [col set];
2770   /* top, bottom */
2771   s.size.height = thickness;
2772   NSRectFill (s);
2773   s.origin.y += r.size.height - thickness;
2774   NSRectFill (s);
2776   s.size.height = r.size.height;
2777   s.origin.y = r.origin.y;
2779   /* left, right (optional) */
2780   s.size.width = thickness;
2781   if (left_p)
2782     NSRectFill (s);
2783   if (right_p)
2784     {
2785       s.origin.x += r.size.width - thickness;
2786       NSRectFill (s);
2787     }
2791 static void
2792 ns_draw_relief (NSRect r, int thickness, char raised_p,
2793                char top_p, char bottom_p, char left_p, char right_p,
2794                struct glyph_string *s)
2795 /* --------------------------------------------------------------------------
2796     Draw a relief rect inside r, optionally leaving some sides open.
2797     Note we can't just use an NSDrawBezel command, because of the possibility
2798     of some sides not being drawn, and because the rect will be filled.
2799    -------------------------------------------------------------------------- */
2801   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2802   NSColor *newBaseCol = nil;
2803   NSRect sr = r;
2805   NSTRACE (ns_draw_relief);
2807   /* set up colors */
2809   if (s->face->use_box_color_for_shadows_p)
2810     {
2811       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2812     }
2813 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2814            && s->img->pixmap
2815            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2816        {
2817          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2818        } */
2819   else
2820     {
2821       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2822     }
2824   if (newBaseCol == nil)
2825     newBaseCol = [NSColor grayColor];
2827   if (newBaseCol != baseCol)  /* TODO: better check */
2828     {
2829       [baseCol release];
2830       baseCol = [newBaseCol retain];
2831       [lightCol release];
2832       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2833       [darkCol release];
2834       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2835     }
2837   [(raised_p ? lightCol : darkCol) set];
2839   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2841   /* top */
2842   sr.size.height = thickness;
2843   if (top_p) NSRectFill (sr);
2845   /* left */
2846   sr.size.height = r.size.height;
2847   sr.size.width = thickness;
2848   if (left_p) NSRectFill (sr);
2850   [(raised_p ? darkCol : lightCol) set];
2852   /* bottom */
2853   sr.size.width = r.size.width;
2854   sr.size.height = thickness;
2855   sr.origin.y += r.size.height - thickness;
2856   if (bottom_p) NSRectFill (sr);
2858   /* right */
2859   sr.size.height = r.size.height;
2860   sr.origin.y = r.origin.y;
2861   sr.size.width = thickness;
2862   sr.origin.x += r.size.width - thickness;
2863   if (right_p) NSRectFill (sr);
2867 static void
2868 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2869 /* --------------------------------------------------------------------------
2870       Function modeled after x_draw_glyph_string_box ().
2871       Sets up parameters for drawing.
2872    -------------------------------------------------------------------------- */
2874   int right_x, last_x;
2875   char left_p, right_p;
2876   struct glyph *last_glyph;
2877   NSRect r;
2878   int thickness;
2879   struct face *face;
2881   if (s->hl == DRAW_MOUSE_FACE)
2882     {
2883       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2884       if (!face)
2885         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2886     }
2887   else
2888     face = s->face;
2890   thickness = face->box_line_width;
2892   NSTRACE (ns_dumpglyphs_box_or_relief);
2894   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2895             ? WINDOW_RIGHT_EDGE_X (s->w)
2896             : window_box_right (s->w, s->area));
2897   last_glyph = (s->cmp || s->img
2898                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2900   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2901               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2903   left_p = (s->first_glyph->left_box_line_p
2904             || (s->hl == DRAW_MOUSE_FACE
2905                 && (s->prev == NULL || s->prev->hl != s->hl)));
2906   right_p = (last_glyph->right_box_line_p
2907              || (s->hl == DRAW_MOUSE_FACE
2908                  && (s->next == NULL || s->next->hl != s->hl)));
2910   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2912   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2913   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2914     {
2915       ns_draw_box (r, abs (thickness),
2916                    ns_lookup_indexed_color (face->box_color, s->f),
2917                   left_p, right_p);
2918     }
2919   else
2920     {
2921       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2922                      1, 1, left_p, right_p, s);
2923     }
2927 static void
2928 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2929 /* --------------------------------------------------------------------------
2930       Modeled after x_draw_glyph_string_background, which draws BG in
2931       certain cases.  Others are left to the text rendering routine.
2932    -------------------------------------------------------------------------- */
2934   NSTRACE (ns_maybe_dumpglyphs_background);
2936   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2937     {
2938       int box_line_width = max (s->face->box_line_width, 0);
2939       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2940           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2941         {
2942           struct face *face;
2943           if (s->hl == DRAW_MOUSE_FACE)
2944             {
2945               face = FACE_FROM_ID (s->f,
2946                                    MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2947               if (!face)
2948                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2949             }
2950           else
2951             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2952           if (!face->stipple)
2953             [(NS_FACE_BACKGROUND (face) != 0
2954               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2955               : FRAME_BACKGROUND_COLOR (s->f)) set];
2956           else
2957             {
2958               struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (s->f);
2959               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2960             }
2962           if (s->hl != DRAW_CURSOR)
2963             {
2964               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2965                                     s->background_width,
2966                                     s->height-2*box_line_width);
2967               NSRectFill (r);
2968             }
2970           s->background_filled_p = 1;
2971         }
2972     }
2976 static void
2977 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2978 /* --------------------------------------------------------------------------
2979       Renders an image and associated borders.
2980    -------------------------------------------------------------------------- */
2982   EmacsImage *img = s->img->pixmap;
2983   int box_line_vwidth = max (s->face->box_line_width, 0);
2984   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2985   int bg_x, bg_y, bg_height;
2986   int th;
2987   char raised_p;
2988   NSRect br;
2989   struct face *face;
2990   NSColor *tdCol;
2992   NSTRACE (ns_dumpglyphs_image);
2994   if (s->face->box != FACE_NO_BOX
2995       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2996     x += abs (s->face->box_line_width);
2998   bg_x = x;
2999   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
3000   bg_height = s->height;
3001   /* other terms have this, but was causing problems w/tabbar mode */
3002   /* - 2 * box_line_vwidth; */
3004   if (s->slice.x == 0) x += s->img->hmargin;
3005   if (s->slice.y == 0) y += s->img->vmargin;
3007   /* Draw BG: if we need larger area than image itself cleared, do that,
3008      otherwise, since we composite the image under NS (instead of mucking
3009      with its background color), we must clear just the image area. */
3010   if (s->hl == DRAW_MOUSE_FACE)
3011     {
3012       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3013       if (!face)
3014        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3015     }
3016   else
3017     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3019   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
3021   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
3022       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
3023     {
3024       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
3025       s->background_filled_p = 1;
3026     }
3027   else
3028     {
3029       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
3030     }
3032   NSRectFill (br);
3034   /* Draw the image.. do we need to draw placeholder if img ==nil? */
3035   if (img != nil)
3036     {
3037 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
3038       NSRect dr = NSMakeRect (x, y, s->slice.width, s->slice.height);
3039       NSRect ir = NSMakeRect (s->slice.x, s->slice.y,
3040                               s->slice.width, s->slice.height);
3041       [img drawInRect: dr
3042              fromRect: ir
3043              operation: NSCompositeSourceOver
3044               fraction: 1.0
3045            respectFlipped: YES
3046                 hints: nil];
3047 #else
3048       [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
3049                   operation: NSCompositeSourceOver];
3050 #endif
3051     }
3053   if (s->hl == DRAW_CURSOR)
3054     {
3055     [FRAME_CURSOR_COLOR (s->f) set];
3056     if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3057       tdCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3058     else
3059       /* Currently on NS img->mask is always 0. Since
3060          get_window_cursor_type specifies a hollow box cursor when on
3061          a non-masked image we never reach this clause. But we put it
3062          in in anticipation of better support for image masks on
3063          NS. */
3064       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3065     }
3066   else
3067     {
3068       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3069     }
3071   /* Draw underline, overline, strike-through. */
3072   ns_draw_text_decoration (s, face, tdCol, br.size.width, br.origin.x);
3074   /* Draw relief, if requested */
3075   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
3076     {
3077       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
3078         {
3079           th = tool_bar_button_relief >= 0 ?
3080             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
3081           raised_p = (s->hl == DRAW_IMAGE_RAISED);
3082         }
3083       else
3084         {
3085           th = abs (s->img->relief);
3086           raised_p = (s->img->relief > 0);
3087         }
3089       r.origin.x = x - th;
3090       r.origin.y = y - th;
3091       r.size.width = s->slice.width + 2*th-1;
3092       r.size.height = s->slice.height + 2*th-1;
3093       ns_draw_relief (r, th, raised_p,
3094                       s->slice.y == 0,
3095                       s->slice.y + s->slice.height == s->img->height,
3096                       s->slice.x == 0,
3097                       s->slice.x + s->slice.width == s->img->width, s);
3098     }
3100   /* If there is no mask, the background won't be seen,
3101      so draw a rectangle on the image for the cursor.
3102      Do this for all images, getting transparency right is not reliable.  */
3103   if (s->hl == DRAW_CURSOR)
3104     {
3105       int thickness = abs (s->img->relief);
3106       if (thickness == 0) thickness = 1;
3107       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
3108     }
3112 static void
3113 ns_dumpglyphs_stretch (struct glyph_string *s)
3115   NSRect r[2];
3116   int n, i;
3117   struct face *face;
3118   NSColor *fgCol, *bgCol;
3120   if (!s->background_filled_p)
3121     {
3122       n = ns_get_glyph_string_clip_rect (s, r);
3123       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
3125       ns_focus (s->f, r, n);
3127       if (s->hl == DRAW_MOUSE_FACE)
3128        {
3129          face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3130          if (!face)
3131            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3132        }
3133       else
3134        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3136       bgCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3137       fgCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3139       for (i = 0; i < n; ++i)
3140         {
3141           if (!s->row->full_width_p)
3142             {
3143               int overrun, leftoverrun;
3145               /* truncate to avoid overwriting fringe and/or scrollbar */
3146               overrun = max (0, (s->x + s->background_width)
3147                              - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
3148                                 - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
3149               r[i].size.width -= overrun;
3151               /* truncate to avoid overwriting to left of the window box */
3152               leftoverrun = (WINDOW_BOX_LEFT_EDGE_X (s->w)
3153                              + WINDOW_LEFT_FRINGE_WIDTH (s->w)) - s->x;
3155               if (leftoverrun > 0)
3156                 {
3157                   r[i].origin.x += leftoverrun;
3158                   r[i].size.width -= leftoverrun;
3159                 }
3161               /* XXX: Try to work between problem where a stretch glyph on
3162                  a partially-visible bottom row will clear part of the
3163                  modeline, and another where list-buffers headers and similar
3164                  rows erroneously have visible_height set to 0.  Not sure
3165                  where this is coming from as other terms seem not to show. */
3166               r[i].size.height = min (s->height, s->row->visible_height);
3167             }
3169           [bgCol set];
3171           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
3172              overwriting cursor (usually when cursor on a tab) */
3173           if (s->hl == DRAW_CURSOR)
3174             {
3175               CGFloat x, width;
3177               x = r[i].origin.x;
3178               width = s->w->phys_cursor_width;
3179               r[i].size.width -= width;
3180               r[i].origin.x += width;
3182               NSRectFill (r[i]);
3184               /* Draw overlining, etc. on the cursor. */
3185               if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3186                 ns_draw_text_decoration (s, face, bgCol, width, x);
3187               else
3188                 ns_draw_text_decoration (s, face, fgCol, width, x);
3189             }
3190           else
3191             {
3192               NSRectFill (r[i]);
3193             }
3195           /* Draw overlining, etc. on the stretch glyph (or the part
3196              of the stretch glyph after the cursor). */
3197           ns_draw_text_decoration (s, face, fgCol, r[i].size.width,
3198                                    r[i].origin.x);
3199         }
3200       ns_unfocus (s->f);
3201       s->background_filled_p = 1;
3202     }
3206 static void
3207 ns_draw_glyph_string (struct glyph_string *s)
3208 /* --------------------------------------------------------------------------
3209       External (RIF): Main draw-text call.
3210    -------------------------------------------------------------------------- */
3212   /* TODO (optimize): focus for box and contents draw */
3213   NSRect r[2];
3214   int n, flags;
3215   char box_drawn_p = 0;
3216   struct font *font = s->face->font;
3217   if (! font) font = FRAME_FONT (s->f);
3219   NSTRACE (ns_draw_glyph_string);
3221   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
3222     {
3223       int width;
3224       struct glyph_string *next;
3226       for (width = 0, next = s->next;
3227            next && width < s->right_overhang;
3228            width += next->width, next = next->next)
3229         if (next->first_glyph->type != IMAGE_GLYPH)
3230           {
3231             if (next->first_glyph->type != STRETCH_GLYPH)
3232               {
3233                 n = ns_get_glyph_string_clip_rect (s->next, r);
3234                 ns_focus (s->f, r, n);
3235                 ns_maybe_dumpglyphs_background (s->next, 1);
3236                 ns_unfocus (s->f);
3237               }
3238             else
3239               {
3240                 ns_dumpglyphs_stretch (s->next);
3241               }
3242             next->num_clips = 0;
3243           }
3244     }
3246   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
3247         && (s->first_glyph->type == CHAR_GLYPH
3248             || s->first_glyph->type == COMPOSITE_GLYPH))
3249     {
3250       n = ns_get_glyph_string_clip_rect (s, r);
3251       ns_focus (s->f, r, n);
3252       ns_maybe_dumpglyphs_background (s, 1);
3253       ns_dumpglyphs_box_or_relief (s);
3254       ns_unfocus (s->f);
3255       box_drawn_p = 1;
3256     }
3258   switch (s->first_glyph->type)
3259     {
3261     case IMAGE_GLYPH:
3262       n = ns_get_glyph_string_clip_rect (s, r);
3263       ns_focus (s->f, r, n);
3264       ns_dumpglyphs_image (s, r[0]);
3265       ns_unfocus (s->f);
3266       break;
3268     case STRETCH_GLYPH:
3269       ns_dumpglyphs_stretch (s);
3270       break;
3272     case CHAR_GLYPH:
3273     case COMPOSITE_GLYPH:
3274       n = ns_get_glyph_string_clip_rect (s, r);
3275       ns_focus (s->f, r, n);
3277       if (s->for_overlaps || (s->cmp_from > 0
3278                               && ! s->first_glyph->u.cmp.automatic))
3279         s->background_filled_p = 1;
3280       else
3281         ns_maybe_dumpglyphs_background
3282           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3284       flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
3285         (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
3286          (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
3287           NS_DUMPGLYPH_NORMAL));
3289       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3290         {
3291           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3292           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3293           NS_FACE_FOREGROUND (s->face) = tmp;
3294         }
3296       {
3297         BOOL isComposite = s->first_glyph->type == COMPOSITE_GLYPH;
3298         int end = isComposite ? s->cmp_to : s->nchars;
3300         font->driver->draw
3301           (s, s->cmp_from, end, s->x, s->ybase,
3302            (flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
3303            || flags == NS_DUMPGLYPH_MOUSEFACE);
3305       }
3307       {
3308         NSColor *col = (NS_FACE_FOREGROUND (s->face) != 0
3309                         ? ns_lookup_indexed_color (NS_FACE_FOREGROUND (s->face),
3310                                                    s->f)
3311                         : FRAME_FOREGROUND_COLOR (s->f));
3312         [col set];
3314         /* Draw underline, overline, strike-through. */
3315         ns_draw_text_decoration (s, s->face, col, s->width, s->x);
3316       }
3318       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3319         {
3320           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3321           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3322           NS_FACE_FOREGROUND (s->face) = tmp;
3323         }
3325       ns_unfocus (s->f);
3326       break;
3328     case GLYPHLESS_GLYPH:
3329       n = ns_get_glyph_string_clip_rect (s, r);
3330       ns_focus (s->f, r, n);
3332       if (s->for_overlaps || (s->cmp_from > 0
3333                               && ! s->first_glyph->u.cmp.automatic))
3334         s->background_filled_p = 1;
3335       else
3336         ns_maybe_dumpglyphs_background
3337           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3338       /* ... */
3339       /* Not yet implemented.  */
3340       /* ... */
3341       ns_unfocus (s->f);
3342       break;
3344     default:
3345       emacs_abort ();
3346     }
3348   /* Draw box if not done already. */
3349   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3350     {
3351       n = ns_get_glyph_string_clip_rect (s, r);
3352       ns_focus (s->f, r, n);
3353       ns_dumpglyphs_box_or_relief (s);
3354       ns_unfocus (s->f);
3355     }
3357   s->num_clips = 0;
3362 /* ==========================================================================
3364     Event loop
3366    ========================================================================== */
3369 static void
3370 ns_send_appdefined (int value)
3371 /* --------------------------------------------------------------------------
3372     Internal: post an appdefined event which EmacsApp-sendEvent will
3373               recognize and take as a command to halt the event loop.
3374    -------------------------------------------------------------------------- */
3376   /*NSTRACE (ns_send_appdefined); */
3378 #ifdef NS_IMPL_GNUSTEP
3379   // GNUstep needs postEvent to happen on the main thread.
3380   if (! [[NSThread currentThread] isMainThread])
3381     {
3382       EmacsApp *app = (EmacsApp *)NSApp;
3383       app->nextappdefined = value;
3384       [app performSelectorOnMainThread:@selector (sendFromMainThread:)
3385                             withObject:nil
3386                          waitUntilDone:YES];
3387       return;
3388     }
3389 #endif
3391   /* Only post this event if we haven't already posted one.  This will end
3392        the [NXApp run] main loop after having processed all events queued at
3393        this moment.  */
3394   if (send_appdefined)
3395     {
3396       NSEvent *nxev;
3398       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3399       send_appdefined = NO;
3401       /* Don't need wakeup timer any more */
3402       if (timed_entry)
3403         {
3404           [timed_entry invalidate];
3405           [timed_entry release];
3406           timed_entry = nil;
3407         }
3409       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3410                                 location: NSMakePoint (0, 0)
3411                            modifierFlags: 0
3412                                timestamp: 0
3413                             windowNumber: [[NSApp mainWindow] windowNumber]
3414                                  context: [NSApp context]
3415                                  subtype: 0
3416                                    data1: value
3417                                    data2: 0];
3419       /* Post an application defined event on the event queue.  When this is
3420          received the [NXApp run] will return, thus having processed all
3421          events which are currently queued.  */
3422       [NSApp postEvent: nxev atStart: NO];
3423     }
3426 #ifdef HAVE_NATIVE_FS
3427 static void
3428 check_native_fs ()
3430   Lisp_Object frame, tail;
3432   if (ns_last_use_native_fullscreen == ns_use_native_fullscreen)
3433     return;
3435   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
3437   FOR_EACH_FRAME (tail, frame)
3438     {
3439       struct frame *f = XFRAME (frame);
3440       if (FRAME_NS_P (f))
3441         {
3442           EmacsView *view = FRAME_NS_VIEW (f);
3443           [view updateCollectionBehavior];
3444         }
3445     }
3447 #endif
3449 /* GNUstep and OSX <= 10.4 does not have cancelTracking.  */
3450 #if defined (NS_IMPL_COCOA) && \
3451   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
3452 /* Check if menu open should be canceled or continued as normal.  */
3453 void
3454 ns_check_menu_open (NSMenu *menu)
3456   /* Click in menu bar? */
3457   NSArray *a = [[NSApp mainMenu] itemArray];
3458   int i;
3459   BOOL found = NO;
3461   if (menu == nil) // Menu tracking ended.
3462     {
3463       if (menu_will_open_state == MENU_OPENING)
3464         menu_will_open_state = MENU_NONE;
3465       return;
3466     }
3468   for (i = 0; ! found && i < [a count]; i++)
3469     found = menu == [[a objectAtIndex:i] submenu];
3470   if (found)
3471     {
3472       if (menu_will_open_state == MENU_NONE && emacs_event)
3473         {
3474           NSEvent *theEvent = [NSApp currentEvent];
3475           struct frame *emacsframe = SELECTED_FRAME ();
3477           [menu cancelTracking];
3478           menu_will_open_state = MENU_PENDING;
3479           emacs_event->kind = MENU_BAR_ACTIVATE_EVENT;
3480           EV_TRAILER (theEvent);
3482           CGEventRef ourEvent = CGEventCreate (NULL);
3483           menu_mouse_point = CGEventGetLocation (ourEvent);
3484           CFRelease (ourEvent);
3485         }
3486       else if (menu_will_open_state == MENU_OPENING)
3487         {
3488           menu_will_open_state = MENU_NONE;
3489         }
3490     }
3493 /* Redo saved menu click if state is MENU_PENDING.  */
3494 void
3495 ns_check_pending_open_menu ()
3497   if (menu_will_open_state == MENU_PENDING)
3498     {
3499       CGEventSourceRef source
3500         = CGEventSourceCreate (kCGEventSourceStateHIDSystemState);
3502       CGEventRef event = CGEventCreateMouseEvent (source,
3503                                                   kCGEventLeftMouseDown,
3504                                                   menu_mouse_point,
3505                                                   kCGMouseButtonLeft);
3506       CGEventSetType (event, kCGEventLeftMouseDown);
3507       CGEventPost (kCGHIDEventTap, event);
3508       CFRelease (event);
3509       CFRelease (source);
3511       menu_will_open_state = MENU_OPENING;
3512     }
3514 #endif /* NS_IMPL_COCOA) && >= MAC_OS_X_VERSION_10_5 */
3516 static int
3517 ns_read_socket (struct terminal *terminal, struct input_event *hold_quit)
3518 /* --------------------------------------------------------------------------
3519      External (hook): Post an event to ourself and keep reading events until
3520      we read it back again.  In effect process all events which were waiting.
3521      From 21+ we have to manage the event buffer ourselves.
3522    -------------------------------------------------------------------------- */
3524   struct input_event ev;
3525   int nevents;
3527 /* NSTRACE (ns_read_socket); */
3529 #ifdef HAVE_NATIVE_FS
3530   check_native_fs ();
3531 #endif
3533   if ([NSApp modalWindow] != nil)
3534     return -1;
3536   if (hold_event_q.nr > 0)
3537     {
3538       int i;
3539       for (i = 0; i < hold_event_q.nr; ++i)
3540         kbd_buffer_store_event_hold (&hold_event_q.q[i], hold_quit);
3541       hold_event_q.nr = 0;
3542       return i;
3543     }
3545   block_input ();
3546   n_emacs_events_pending = 0;
3547   ns_init_events (&ev);
3548   q_event_ptr = hold_quit;
3550   /* we manage autorelease pools by allocate/reallocate each time around
3551      the loop; strict nesting is occasionally violated but seems not to
3552      matter.. earlier methods using full nesting caused major memory leaks */
3553   [outerpool release];
3554   outerpool = [[NSAutoreleasePool alloc] init];
3556   /* If have pending open-file requests, attend to the next one of those. */
3557   if (ns_pending_files && [ns_pending_files count] != 0
3558       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3559     {
3560       [ns_pending_files removeObjectAtIndex: 0];
3561     }
3562   /* Deal with pending service requests. */
3563   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3564     && [(EmacsApp *)
3565          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3566                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3567     {
3568       [ns_pending_service_names removeObjectAtIndex: 0];
3569       [ns_pending_service_args removeObjectAtIndex: 0];
3570     }
3571   else
3572     {
3573       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3574          to ourself, otherwise [NXApp run] will never exit.  */
3575       send_appdefined = YES;
3576       ns_send_appdefined (-1);
3578       if (++apploopnr != 1)
3579         {
3580           emacs_abort ();
3581         }
3582       [NSApp run];
3583       --apploopnr;
3584     }
3586   nevents = n_emacs_events_pending;
3587   n_emacs_events_pending = 0;
3588   ns_finish_events ();
3589   q_event_ptr = NULL;
3590   unblock_input ();
3592   return nevents;
3597 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3598            fd_set *exceptfds, struct timespec const *timeout,
3599            sigset_t const *sigmask)
3600 /* --------------------------------------------------------------------------
3601      Replacement for select, checking for events
3602    -------------------------------------------------------------------------- */
3604   int result;
3605   int t, k, nr = 0;
3606   struct input_event event;
3607   char c;
3609 /*  NSTRACE (ns_select); */
3611 #ifdef HAVE_NATIVE_FS
3612   check_native_fs ();
3613 #endif
3615   if (hold_event_q.nr > 0)
3616     {
3617       /* We already have events pending. */
3618       raise (SIGIO);
3619       errno = EINTR;
3620       return -1;
3621     }
3623   for (k = 0; k < nfds+1; k++)
3624     {
3625       if (readfds && FD_ISSET(k, readfds)) ++nr;
3626       if (writefds && FD_ISSET(k, writefds)) ++nr;
3627     }
3629   if (NSApp == nil
3630       || (timeout && timeout->tv_sec == 0 && timeout->tv_nsec == 0))
3631     return pselect (nfds, readfds, writefds, exceptfds, timeout, sigmask);
3633   [outerpool release];
3634   outerpool = [[NSAutoreleasePool alloc] init];
3637   send_appdefined = YES;
3638   if (nr > 0)
3639     {
3640       pthread_mutex_lock (&select_mutex);
3641       select_nfds = nfds;
3642       select_valid = 0;
3643       if (readfds)
3644         {
3645           select_readfds = *readfds;
3646           select_valid += SELECT_HAVE_READ;
3647         }
3648       if (writefds)
3649         {
3650           select_writefds = *writefds;
3651           select_valid += SELECT_HAVE_WRITE;
3652         }
3654       if (timeout)
3655         {
3656           select_timeout = *timeout;
3657           select_valid += SELECT_HAVE_TMO;
3658         }
3660       pthread_mutex_unlock (&select_mutex);
3662       /* Inform fd_handler that select should be called */
3663       c = 'g';
3664       emacs_write_sig (selfds[1], &c, 1);
3665     }
3666   else if (nr == 0 && timeout)
3667     {
3668       /* No file descriptor, just a timeout, no need to wake fd_handler  */
3669       double time = timespectod (*timeout);
3670       timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3671                                                       target: NSApp
3672                                                     selector:
3673                                   @selector (timeout_handler:)
3674                                                     userInfo: 0
3675                                                      repeats: NO]
3676                       retain];
3677     }
3678   else /* No timeout and no file descriptors, can this happen?  */
3679     {
3680       /* Send appdefined so we exit from the loop */
3681       ns_send_appdefined (-1);
3682     }
3684   block_input ();
3685   ns_init_events (&event);
3686   if (++apploopnr != 1)
3687     {
3688       emacs_abort ();
3689     }
3690   [NSApp run];
3691   --apploopnr;
3692   ns_finish_events ();
3693   if (nr > 0 && readfds)
3694     {
3695       c = 's';
3696       emacs_write_sig (selfds[1], &c, 1);
3697     }
3698   unblock_input ();
3700   t = last_appdefined_event_data;
3702   if (t != NO_APPDEFINED_DATA)
3703     {
3704       last_appdefined_event_data = NO_APPDEFINED_DATA;
3706       if (t == -2)
3707         {
3708           /* The NX_APPDEFINED event we received was a timeout. */
3709           result = 0;
3710         }
3711       else if (t == -1)
3712         {
3713           /* The NX_APPDEFINED event we received was the result of
3714              at least one real input event arriving.  */
3715           errno = EINTR;
3716           result = -1;
3717         }
3718       else
3719         {
3720           /* Received back from select () in fd_handler; copy the results */
3721           pthread_mutex_lock (&select_mutex);
3722           if (readfds) *readfds = select_readfds;
3723           if (writefds) *writefds = select_writefds;
3724           pthread_mutex_unlock (&select_mutex);
3725           result = t;
3726         }
3727     }
3728   else
3729     {
3730       errno = EINTR;
3731       result = -1;
3732     }
3734   return result;
3739 /* ==========================================================================
3741     Scrollbar handling
3743    ========================================================================== */
3746 static void
3747 ns_set_vertical_scroll_bar (struct window *window,
3748                            int portion, int whole, int position)
3749 /* --------------------------------------------------------------------------
3750       External (hook): Update or add scrollbar
3751    -------------------------------------------------------------------------- */
3753   Lisp_Object win;
3754   NSRect r, v;
3755   struct frame *f = XFRAME (WINDOW_FRAME (window));
3756   EmacsView *view = FRAME_NS_VIEW (f);
3757   EmacsScroller *bar;
3758   int window_y, window_height;
3759   int top, left, height, width;
3761   /* optimization; display engine sends WAY too many of these.. */
3762   if (!NILP (window->vertical_scroll_bar))
3763     {
3764       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3765       if ([bar checkSamePosition: position portion: portion whole: whole])
3766         {
3767           if (view->scrollbarsNeedingUpdate == 0)
3768             {
3769               if (!windows_or_buffers_changed)
3770                   return;
3771             }
3772           else
3773             view->scrollbarsNeedingUpdate--;
3774         }
3775     }
3777   NSTRACE (ns_set_vertical_scroll_bar);
3779   /* Get dimensions.  */
3780   window_box (window, ANY_AREA, 0, &window_y, 0, &window_height);
3781   top = window_y;
3782   height = window_height;
3783   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3784   left = WINDOW_SCROLL_BAR_AREA_X (window);
3786   r = NSMakeRect (left, top, width, height);
3787   /* the parent view is flipped, so we need to flip y value */
3788   v = [view frame];
3789   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3791   XSETWINDOW (win, window);
3792   block_input ();
3794   /* we want at least 5 lines to display a scrollbar */
3795   if (WINDOW_TOTAL_LINES (window) < 5)
3796     {
3797       if (!NILP (window->vertical_scroll_bar))
3798         {
3799           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3800           [bar removeFromSuperview];
3801           wset_vertical_scroll_bar (window, Qnil);
3802         }
3803       ns_clear_frame_area (f, left, top, width, height);
3804       unblock_input ();
3805       return;
3806     }
3808   if (NILP (window->vertical_scroll_bar))
3809     {
3810       if (width > 0 && height > 0)
3811         ns_clear_frame_area (f, left, top, width, height);
3813       bar = [[EmacsScroller alloc] initFrame: r window: win];
3814       wset_vertical_scroll_bar (window, make_save_ptr (bar));
3815     }
3816   else
3817     {
3818       NSRect oldRect;
3819       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3820       oldRect = [bar frame];
3821       r.size.width = oldRect.size.width;
3822       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3823         {
3824           if (oldRect.origin.x != r.origin.x)
3825               ns_clear_frame_area (f, left, top, width, height);
3826           [bar setFrame: r];
3827         }
3828     }
3830   [bar setPosition: position portion: portion whole: whole];
3831   unblock_input ();
3835 static void
3836 ns_set_horizontal_scroll_bar (struct window *window,
3837                               int portion, int whole, int position)
3838 /* --------------------------------------------------------------------------
3839       External (hook): Update or add scrollbar
3840    -------------------------------------------------------------------------- */
3842   Lisp_Object win;
3843   NSRect r, v;
3844   struct frame *f = XFRAME (WINDOW_FRAME (window));
3845   EmacsView *view = FRAME_NS_VIEW (f);
3846   EmacsScroller *bar;
3847   int top, height, left, width;
3848   int window_x, window_width;
3849   int pixel_width = WINDOW_PIXEL_WIDTH (window);
3851   /* optimization; display engine sends WAY too many of these.. */
3852   if (!NILP (window->horizontal_scroll_bar))
3853     {
3854       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3855       if ([bar checkSamePosition: position portion: portion whole: whole])
3856         {
3857           if (view->scrollbarsNeedingUpdate == 0)
3858             {
3859               if (!windows_or_buffers_changed)
3860                   return;
3861             }
3862           else
3863             view->scrollbarsNeedingUpdate--;
3864         }
3865     }
3867   NSTRACE (ns_set_horizontal_scroll_bar);
3869   /* Get dimensions.  */
3870   window_box (window, ANY_AREA, 0, &window_x, &window_width, 0);
3871   left = window_x;
3872   width = window_width;
3873   height = WINDOW_CONFIG_SCROLL_BAR_LINES (window) * FRAME_LINE_HEIGHT (f);
3874   top = WINDOW_SCROLL_BAR_AREA_Y (window);
3876   r = NSMakeRect (left, top, width, height);
3877   /* the parent view is flipped, so we need to flip y value */
3878   v = [view frame];
3879   /* ??????? PXW/scrollbars !!!!!!!!!!!!!!!!!!!! */
3880   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3882   XSETWINDOW (win, window);
3883   block_input ();
3885   if (WINDOW_TOTAL_COLS (window) < 5)
3886     {
3887       if (!NILP (window->horizontal_scroll_bar))
3888         {
3889           bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3890           [bar removeFromSuperview];
3891           wset_horizontal_scroll_bar (window, Qnil);
3892         }
3893       ns_clear_frame_area (f, left, top, width, height);
3894       unblock_input ();
3895       return;
3896     }
3898   if (NILP (window->horizontal_scroll_bar))
3899     {
3900       if (width > 0 && height > 0)
3901         ns_clear_frame_area (f, left, top, width, height);
3903       bar = [[EmacsScroller alloc] initFrame: r window: win];
3904       wset_horizontal_scroll_bar (window, make_save_ptr (bar));
3905     }
3906   else
3907     {
3908       NSRect oldRect;
3909       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3910       oldRect = [bar frame];
3911       r.size.width = oldRect.size.width;
3912       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3913         {
3914           if (oldRect.origin.x != r.origin.x)
3915               ns_clear_frame_area (f, left, top, width, height);
3916           [bar setFrame: r];
3917         }
3918     }
3920   [bar setPosition: position portion: portion whole: whole];
3921   unblock_input ();
3925 static void
3926 ns_condemn_scroll_bars (struct frame *f)
3927 /* --------------------------------------------------------------------------
3928      External (hook): arrange for all frame's scrollbars to be removed
3929      at next call to judge_scroll_bars, except for those redeemed.
3930    -------------------------------------------------------------------------- */
3932   int i;
3933   id view;
3934   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3936   NSTRACE (ns_condemn_scroll_bars);
3938   for (i =[subviews count]-1; i >= 0; i--)
3939     {
3940       view = [subviews objectAtIndex: i];
3941       if ([view isKindOfClass: [EmacsScroller class]])
3942         [view condemn];
3943     }
3947 static void
3948 ns_redeem_scroll_bar (struct window *window)
3949 /* --------------------------------------------------------------------------
3950      External (hook): arrange to spare this window's scrollbar
3951      at next call to judge_scroll_bars.
3952    -------------------------------------------------------------------------- */
3954   id bar;
3955   NSTRACE (ns_redeem_scroll_bar);
3956   if (!NILP (window->vertical_scroll_bar))
3957     {
3958       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3959       [bar reprieve];
3960     }
3962   if (!NILP (window->horizontal_scroll_bar))
3963     {
3964       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3965       [bar reprieve];
3966     }
3970 static void
3971 ns_judge_scroll_bars (struct frame *f)
3972 /* --------------------------------------------------------------------------
3973      External (hook): destroy all scrollbars on frame that weren't
3974      redeemed after call to condemn_scroll_bars.
3975    -------------------------------------------------------------------------- */
3977   int i;
3978   id view;
3979   EmacsView *eview = FRAME_NS_VIEW (f);
3980   NSArray *subviews = [[eview superview] subviews];
3981   BOOL removed = NO;
3983   NSTRACE (ns_judge_scroll_bars);
3984   for (i = [subviews count]-1; i >= 0; --i)
3985     {
3986       view = [subviews objectAtIndex: i];
3987       if (![view isKindOfClass: [EmacsScroller class]]) continue;
3988       [view judge];
3989       removed = YES;
3990     }
3992   if (removed)
3993     [eview updateFrameSize: NO];
3996 /* ==========================================================================
3998     Initialization
4000    ========================================================================== */
4003 x_display_pixel_height (struct ns_display_info *dpyinfo)
4005   NSArray *screens = [NSScreen screens];
4006   NSEnumerator *enumerator = [screens objectEnumerator];
4007   NSScreen *screen;
4008   NSRect frame;
4010   frame = NSZeroRect;
4011   while ((screen = [enumerator nextObject]) != nil)
4012     frame = NSUnionRect (frame, [screen frame]);
4014   return NSHeight (frame);
4018 x_display_pixel_width (struct ns_display_info *dpyinfo)
4020   NSArray *screens = [NSScreen screens];
4021   NSEnumerator *enumerator = [screens objectEnumerator];
4022   NSScreen *screen;
4023   NSRect frame;
4025   frame = NSZeroRect;
4026   while ((screen = [enumerator nextObject]) != nil)
4027     frame = NSUnionRect (frame, [screen frame]);
4029   return NSWidth (frame);
4033 static Lisp_Object ns_string_to_lispmod (const char *s)
4034 /* --------------------------------------------------------------------------
4035      Convert modifier name to lisp symbol
4036    -------------------------------------------------------------------------- */
4038   if (!strncmp (SSDATA (SYMBOL_NAME (Qmeta)), s, 10))
4039     return Qmeta;
4040   else if (!strncmp (SSDATA (SYMBOL_NAME (Qsuper)), s, 10))
4041     return Qsuper;
4042   else if (!strncmp (SSDATA (SYMBOL_NAME (Qcontrol)), s, 10))
4043     return Qcontrol;
4044   else if (!strncmp (SSDATA (SYMBOL_NAME (Qalt)), s, 10))
4045     return Qalt;
4046   else if (!strncmp (SSDATA (SYMBOL_NAME (Qhyper)), s, 10))
4047     return Qhyper;
4048   else if (!strncmp (SSDATA (SYMBOL_NAME (Qnone)), s, 10))
4049     return Qnone;
4050   else
4051     return Qnil;
4055 static void
4056 ns_default (const char *parameter, Lisp_Object *result,
4057            Lisp_Object yesval, Lisp_Object noval,
4058            BOOL is_float, BOOL is_modstring)
4059 /* --------------------------------------------------------------------------
4060       Check a parameter value in user's preferences
4061    -------------------------------------------------------------------------- */
4063   const char *value = ns_get_defaults_value (parameter);
4065   if (value)
4066     {
4067       double f;
4068       char *pos;
4069       if (c_strcasecmp (value, "YES") == 0)
4070         *result = yesval;
4071       else if (c_strcasecmp (value, "NO") == 0)
4072         *result = noval;
4073       else if (is_float && (f = strtod (value, &pos), pos != value))
4074         *result = make_float (f);
4075       else if (is_modstring && value)
4076         *result = ns_string_to_lispmod (value);
4077       else fprintf (stderr,
4078                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
4079     }
4083 static void
4084 ns_initialize_display_info (struct ns_display_info *dpyinfo)
4085 /* --------------------------------------------------------------------------
4086       Initialize global info and storage for display.
4087    -------------------------------------------------------------------------- */
4089     NSScreen *screen = [NSScreen mainScreen];
4090     NSWindowDepth depth = [screen depth];
4092     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
4093     dpyinfo->resy = 72.27;
4094     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
4095                                                   NSColorSpaceFromDepth (depth)]
4096                 && ![NSCalibratedWhiteColorSpace isEqualToString:
4097                                                  NSColorSpaceFromDepth (depth)];
4098     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
4099     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
4100     dpyinfo->color_table->colors = NULL;
4101     dpyinfo->root_window = 42; /* a placeholder.. */
4102     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
4103     dpyinfo->n_fonts = 0;
4104     dpyinfo->smallest_font_height = 1;
4105     dpyinfo->smallest_char_width = 1;
4107     reset_mouse_highlight (&dpyinfo->mouse_highlight);
4111 /* This and next define (many of the) public functions in this file. */
4112 /* x_... are generic versions in xdisp.c that we, and other terms, get away
4113          with using despite presence in the "system dependent" redisplay
4114          interface.  In addition, many of the ns_ methods have code that is
4115          shared with all terms, indicating need for further refactoring. */
4116 extern frame_parm_handler ns_frame_parm_handlers[];
4117 static struct redisplay_interface ns_redisplay_interface =
4119   ns_frame_parm_handlers,
4120   x_produce_glyphs,
4121   x_write_glyphs,
4122   x_insert_glyphs,
4123   x_clear_end_of_line,
4124   ns_scroll_run,
4125   ns_after_update_window_line,
4126   ns_update_window_begin,
4127   ns_update_window_end,
4128   0, /* flush_display */
4129   x_clear_window_mouse_face,
4130   x_get_glyph_overhangs,
4131   x_fix_overlapping_area,
4132   ns_draw_fringe_bitmap,
4133   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
4134   0, /* destroy_fringe_bitmap */
4135   ns_compute_glyph_string_overhangs,
4136   ns_draw_glyph_string,
4137   ns_define_frame_cursor,
4138   ns_clear_frame_area,
4139   ns_draw_window_cursor,
4140   ns_draw_vertical_window_border,
4141   ns_draw_window_divider,
4142   ns_shift_glyphs_for_insert,
4143   ns_show_hourglass,
4144   ns_hide_hourglass
4148 static void
4149 ns_delete_display (struct ns_display_info *dpyinfo)
4151   /* TODO... */
4155 /* This function is called when the last frame on a display is deleted. */
4156 static void
4157 ns_delete_terminal (struct terminal *terminal)
4159   struct ns_display_info *dpyinfo = terminal->display_info.ns;
4161   /* Protect against recursive calls.  delete_frame in
4162      delete_terminal calls us back when it deletes our last frame.  */
4163   if (!terminal->name)
4164     return;
4166   block_input ();
4168   x_destroy_all_bitmaps (dpyinfo);
4169   ns_delete_display (dpyinfo);
4170   unblock_input ();
4174 static struct terminal *
4175 ns_create_terminal (struct ns_display_info *dpyinfo)
4176 /* --------------------------------------------------------------------------
4177       Set up use of NS before we make the first connection.
4178    -------------------------------------------------------------------------- */
4180   struct terminal *terminal;
4182   NSTRACE (ns_create_terminal);
4184   terminal = create_terminal (output_ns, &ns_redisplay_interface);
4186   terminal->display_info.ns = dpyinfo;
4187   dpyinfo->terminal = terminal;
4189   terminal->clear_frame_hook = ns_clear_frame;
4190   terminal->ring_bell_hook = ns_ring_bell;
4191   terminal->update_begin_hook = ns_update_begin;
4192   terminal->update_end_hook = ns_update_end;
4193   terminal->read_socket_hook = ns_read_socket;
4194   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
4195   terminal->mouse_position_hook = ns_mouse_position;
4196   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
4197   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
4198   terminal->fullscreen_hook = ns_fullscreen_hook;
4199   terminal->menu_show_hook = ns_menu_show;
4200   terminal->popup_dialog_hook = ns_popup_dialog;
4201   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
4202   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
4203   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
4204   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
4205   terminal->delete_frame_hook = x_destroy_window;
4206   terminal->delete_terminal_hook = ns_delete_terminal;
4207   /* Other hooks are NULL by default.  */
4209   return terminal;
4213 struct ns_display_info *
4214 ns_term_init (Lisp_Object display_name)
4215 /* --------------------------------------------------------------------------
4216      Start the Application and get things rolling.
4217    -------------------------------------------------------------------------- */
4219   struct terminal *terminal;
4220   struct ns_display_info *dpyinfo;
4221   static int ns_initialized = 0;
4222   Lisp_Object tmp;
4224   if (ns_initialized) return x_display_list;
4225   ns_initialized = 1;
4227   NSTRACE (ns_term_init);
4229   [outerpool release];
4230   outerpool = [[NSAutoreleasePool alloc] init];
4232   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
4233   /*GSDebugAllocationActive (YES); */
4234   block_input ();
4236   baud_rate = 38400;
4237   Fset_input_interrupt_mode (Qnil);
4239   if (selfds[0] == -1)
4240     {
4241       if (emacs_pipe (selfds) != 0)
4242         {
4243           fprintf (stderr, "Failed to create pipe: %s\n",
4244                    emacs_strerror (errno));
4245           emacs_abort ();
4246         }
4248       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4249       FD_ZERO (&select_readfds);
4250       FD_ZERO (&select_writefds);
4251       pthread_mutex_init (&select_mutex, NULL);
4252     }
4254   ns_pending_files = [[NSMutableArray alloc] init];
4255   ns_pending_service_names = [[NSMutableArray alloc] init];
4256   ns_pending_service_args = [[NSMutableArray alloc] init];
4258 /* Start app and create the main menu, window, view.
4259      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4260      The view will then ask the NSApp to stop and return to Emacs. */
4261   [EmacsApp sharedApplication];
4262   if (NSApp == nil)
4263     return NULL;
4264   [NSApp setDelegate: NSApp];
4266   /* Start the select thread.  */
4267   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4268                            toTarget:NSApp
4269                          withObject:nil];
4271   /* debugging: log all notifications */
4272   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4273                                          selector: @selector (logNotification:)
4274                                              name: nil object: nil]; */
4276   dpyinfo = xzalloc (sizeof *dpyinfo);
4278   ns_initialize_display_info (dpyinfo);
4279   terminal = ns_create_terminal (dpyinfo);
4281   terminal->kboard = allocate_kboard (Qns);
4282   /* Don't let the initial kboard remain current longer than necessary.
4283      That would cause problems if a file loaded on startup tries to
4284      prompt in the mini-buffer.  */
4285   if (current_kboard == initial_kboard)
4286     current_kboard = terminal->kboard;
4287   terminal->kboard->reference_count++;
4289   dpyinfo->next = x_display_list;
4290   x_display_list = dpyinfo;
4292   dpyinfo->name_list_element = Fcons (display_name, Qnil);
4294   terminal->name = xstrdup (SSDATA (display_name));
4296   unblock_input ();
4298   if (!inhibit_x_resources)
4299     {
4300       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4301                  Qt, Qnil, NO, NO);
4302       tmp = Qnil;
4303       /* this is a standard variable */
4304       ns_default ("AppleAntiAliasingThreshold", &tmp,
4305                  make_float (10.0), make_float (6.0), YES, NO);
4306       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4307     }
4309   {
4310     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4312     if ( cl == nil )
4313       {
4314         Lisp_Object color_file, color_map, color;
4315         unsigned long c;
4316         char *name;
4318         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4319                          Fsymbol_value (intern ("data-directory")));
4321         color_map = Fx_load_color_file (color_file);
4322         if (NILP (color_map))
4323           fatal ("Could not read %s.\n", SDATA (color_file));
4325         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4326         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4327           {
4328             color = XCAR (color_map);
4329             name = SSDATA (XCAR (color));
4330             c = XINT (XCDR (color));
4331             [cl setColor:
4332                   [NSColor colorForEmacsRed: RED_FROM_ULONG (c) / 255.0
4333                                       green: GREEN_FROM_ULONG (c) / 255.0
4334                                        blue: BLUE_FROM_ULONG (c) / 255.0
4335                                       alpha: 1.0]
4336                   forKey: [NSString stringWithUTF8String: name]];
4337           }
4338         [cl writeToFile: nil];
4339       }
4340   }
4342   {
4343 #ifdef NS_IMPL_GNUSTEP
4344     Vwindow_system_version = build_string (gnustep_base_version);
4345 #else
4346     /*PSnextrelease (128, c); */
4347     char c[DBL_BUFSIZE_BOUND];
4348     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4349     Vwindow_system_version = make_unibyte_string (c, len);
4350 #endif
4351   }
4353   delete_keyboard_wait_descriptor (0);
4355   ns_app_name = [[NSProcessInfo processInfo] processName];
4357 /* Set up OS X app menu */
4358 #ifdef NS_IMPL_COCOA
4359   {
4360     NSMenu *appMenu;
4361     NSMenuItem *item;
4362     /* set up the application menu */
4363     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4364     [svcsMenu setAutoenablesItems: NO];
4365     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4366     [appMenu setAutoenablesItems: NO];
4367     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4368     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4370     [appMenu insertItemWithTitle: @"About Emacs"
4371                           action: @selector (orderFrontStandardAboutPanel:)
4372                    keyEquivalent: @""
4373                          atIndex: 0];
4374     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4375     [appMenu insertItemWithTitle: @"Preferences..."
4376                           action: @selector (showPreferencesWindow:)
4377                    keyEquivalent: @","
4378                          atIndex: 2];
4379     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4380     item = [appMenu insertItemWithTitle: @"Services"
4381                                  action: @selector (menuDown:)
4382                           keyEquivalent: @""
4383                                 atIndex: 4];
4384     [appMenu setSubmenu: svcsMenu forItem: item];
4385     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4386     [appMenu insertItemWithTitle: @"Hide Emacs"
4387                           action: @selector (hide:)
4388                    keyEquivalent: @"h"
4389                          atIndex: 6];
4390     item =  [appMenu insertItemWithTitle: @"Hide Others"
4391                           action: @selector (hideOtherApplications:)
4392                    keyEquivalent: @"h"
4393                          atIndex: 7];
4394     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4395     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4396     [appMenu insertItemWithTitle: @"Quit Emacs"
4397                           action: @selector (terminate:)
4398                    keyEquivalent: @"q"
4399                          atIndex: 9];
4401     item = [mainMenu insertItemWithTitle: ns_app_name
4402                                   action: @selector (menuDown:)
4403                            keyEquivalent: @""
4404                                  atIndex: 0];
4405     [mainMenu setSubmenu: appMenu forItem: item];
4406     [dockMenu insertItemWithTitle: @"New Frame"
4407                            action: @selector (newFrame:)
4408                     keyEquivalent: @""
4409                           atIndex: 0];
4411     [NSApp setMainMenu: mainMenu];
4412     [NSApp setAppleMenu: appMenu];
4413     [NSApp setServicesMenu: svcsMenu];
4414     /* Needed at least on Cocoa, to get dock menu to show windows */
4415     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4417     [[NSNotificationCenter defaultCenter]
4418       addObserver: mainMenu
4419          selector: @selector (trackingNotification:)
4420              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4421     [[NSNotificationCenter defaultCenter]
4422       addObserver: mainMenu
4423          selector: @selector (trackingNotification:)
4424              name: NSMenuDidEndTrackingNotification object: mainMenu];
4425   }
4426 #endif /* MAC OS X menu setup */
4428   /* Register our external input/output types, used for determining
4429      applicable services and also drag/drop eligibility. */
4430   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4431   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4432                       retain];
4433   ns_drag_types = [[NSArray arrayWithObjects:
4434                             NSStringPboardType,
4435                             NSTabularTextPboardType,
4436                             NSFilenamesPboardType,
4437                             NSURLPboardType, nil] retain];
4439   /* If fullscreen is in init/default-frame-alist, focus isn't set
4440      right for fullscreen windows, so set this.  */
4441   [NSApp activateIgnoringOtherApps:YES];
4443   [NSApp run];
4444   ns_do_open_file = YES;
4446 #ifdef NS_IMPL_GNUSTEP
4447   /* GNUstep steals SIGCHLD for use in NSTask, but we don't use NSTask.
4448      We must re-catch it so subprocess works.  */
4449   catch_child_signal ();
4450 #endif
4451   return dpyinfo;
4455 void
4456 ns_term_shutdown (int sig)
4458   [[NSUserDefaults standardUserDefaults] synchronize];
4460   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4461   if (STRINGP (Vauto_save_list_file_name))
4462     unlink (SSDATA (Vauto_save_list_file_name));
4464   if (sig == 0 || sig == SIGTERM)
4465     {
4466       [NSApp terminate: NSApp];
4467     }
4468   else // force a stack trace to happen
4469     {
4470       emacs_abort ();
4471     }
4475 /* ==========================================================================
4477     EmacsApp implementation
4479    ========================================================================== */
4482 @implementation EmacsApp
4484 - (id)init
4486   if (self = [super init])
4487     {
4488 #ifdef NS_IMPL_COCOA
4489       self->isFirst = YES;
4490 #endif
4491 #ifdef NS_IMPL_GNUSTEP
4492       self->applicationDidFinishLaunchingCalled = NO;
4493 #endif
4494     }
4496   return self;
4499 #ifdef NS_IMPL_COCOA
4500 - (void)run
4502 #ifndef NSAppKitVersionNumber10_8
4503 #define NSAppKitVersionNumber10_8 1187
4504 #endif
4506   if (NSAppKitVersionNumber <= NSAppKitVersionNumber10_8) 
4507     {
4508       [super run];
4509       return;
4510     }
4512   NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
4514   if (isFirst) [self finishLaunching];
4515   isFirst = NO;
4517   shouldKeepRunning = YES;
4518   do
4519     {
4520       [pool release];
4521       pool = [[NSAutoreleasePool alloc] init];
4523       NSEvent *event =
4524         [self nextEventMatchingMask:NSAnyEventMask
4525                           untilDate:[NSDate distantFuture]
4526                              inMode:NSDefaultRunLoopMode
4527                             dequeue:YES];
4528       [self sendEvent:event];
4529       [self updateWindows];
4530     } while (shouldKeepRunning);
4532   [pool release];
4535 - (void)stop: (id)sender
4537     shouldKeepRunning = NO;
4538     // Stop possible dialog also.  Noop if no dialog present.
4539     // The file dialog still leaks 7k - 10k on 10.9 though.
4540     [super stop:sender];
4542 #endif /* NS_IMPL_COCOA */
4544 - (void)logNotification: (NSNotification *)notification
4546   const char *name = [[notification name] UTF8String];
4547   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4548       && !strstr (name, "WindowNumber"))
4549     NSLog (@"notification: '%@'", [notification name]);
4553 - (void)sendEvent: (NSEvent *)theEvent
4554 /* --------------------------------------------------------------------------
4555      Called when NSApp is running for each event received.  Used to stop
4556      the loop when we choose, since there's no way to just run one iteration.
4557    -------------------------------------------------------------------------- */
4559   int type = [theEvent type];
4560   NSWindow *window = [theEvent window];
4562 /*  NSTRACE (sendEvent); */
4563 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4565 #ifdef NS_IMPL_GNUSTEP
4566   // Keyboard events aren't propagated to file dialogs for some reason.
4567   if ([NSApp modalWindow] != nil &&
4568       (type == NSKeyDown || type == NSKeyUp || type == NSFlagsChanged))
4569     {
4570       [[NSApp modalWindow] sendEvent: theEvent];
4571       return;
4572     }
4573 #endif
4575   if (type == NSApplicationDefined)
4576     {
4577       switch ([theEvent data2])
4578         {
4579 #ifdef NS_IMPL_COCOA
4580         case NSAPP_DATA2_RUNASSCRIPT:
4581           ns_run_ascript ();
4582           [self stop: self];
4583           return;
4584 #endif
4585         case NSAPP_DATA2_RUNFILEDIALOG:
4586           ns_run_file_dialog ();
4587           [self stop: self];
4588           return;
4589         }
4590     }
4592   if (type == NSCursorUpdate && window == nil)
4593     {
4594       fprintf (stderr, "Dropping external cursor update event.\n");
4595       return;
4596     }
4598   if (type == NSApplicationDefined)
4599     {
4600       /* Events posted by ns_send_appdefined interrupt the run loop here.
4601          But, if a modal window is up, an appdefined can still come through,
4602          (e.g., from a makeKeyWindow event) but stopping self also stops the
4603          modal loop. Just defer it until later. */
4604       if ([NSApp modalWindow] == nil)
4605         {
4606           last_appdefined_event_data = [theEvent data1];
4607           [self stop: self];
4608         }
4609       else
4610         {
4611           send_appdefined = YES;
4612         }
4613     }
4616 #ifdef NS_IMPL_COCOA
4617   /* If no dialog and none of our frames have focus and it is a move, skip it.
4618      It is a mouse move in an auxiliary menu, i.e. on the top right on OSX,
4619      such as Wifi, sound, date or similar.
4620      This prevents "spooky" highlighting in the frame under the menu.  */
4621   if (type == NSMouseMoved && [NSApp modalWindow] == nil)
4622     {
4623       struct ns_display_info *di;
4624       BOOL has_focus = NO;
4625       for (di = x_display_list; ! has_focus && di; di = di->next)
4626         has_focus = di->x_focus_frame != 0;
4627       if (! has_focus)
4628         return;
4629     }
4630 #endif
4632   [super sendEvent: theEvent];
4636 - (void)showPreferencesWindow: (id)sender
4638   struct frame *emacsframe = SELECTED_FRAME ();
4639   NSEvent *theEvent = [NSApp currentEvent];
4641   if (!emacs_event)
4642     return;
4643   emacs_event->kind = NS_NONKEY_EVENT;
4644   emacs_event->code = KEY_NS_SHOW_PREFS;
4645   emacs_event->modifiers = 0;
4646   EV_TRAILER (theEvent);
4650 - (void)newFrame: (id)sender
4652   struct frame *emacsframe = SELECTED_FRAME ();
4653   NSEvent *theEvent = [NSApp currentEvent];
4655   if (!emacs_event)
4656     return;
4657   emacs_event->kind = NS_NONKEY_EVENT;
4658   emacs_event->code = KEY_NS_NEW_FRAME;
4659   emacs_event->modifiers = 0;
4660   EV_TRAILER (theEvent);
4664 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4665 - (BOOL) openFile: (NSString *)fileName
4667   struct frame *emacsframe = SELECTED_FRAME ();
4668   NSEvent *theEvent = [NSApp currentEvent];
4670   if (!emacs_event)
4671     return NO;
4673   emacs_event->kind = NS_NONKEY_EVENT;
4674   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4675   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4676   ns_input_line = Qnil; /* can be start or cons start,end */
4677   emacs_event->modifiers =0;
4678   EV_TRAILER (theEvent);
4680   return YES;
4684 /* **************************************************************************
4686       EmacsApp delegate implementation
4688    ************************************************************************** */
4690 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4691 /* --------------------------------------------------------------------------
4692      When application is loaded, terminate event loop in ns_term_init
4693    -------------------------------------------------------------------------- */
4695   NSTRACE (applicationDidFinishLaunching);
4696 #ifdef NS_IMPL_GNUSTEP
4697   ((EmacsApp *)self)->applicationDidFinishLaunchingCalled = YES;
4698 #endif
4699   [NSApp setServicesProvider: NSApp];
4701   [self antialiasThresholdDidChange:nil];
4702 #ifdef NS_IMPL_COCOA
4703 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
4704   [[NSNotificationCenter defaultCenter]
4705     addObserver:self
4706        selector:@selector(antialiasThresholdDidChange:)
4707            name:NSAntialiasThresholdChangedNotification
4708          object:nil];
4709 #endif
4710 #endif
4712   ns_send_appdefined (-2);
4715 - (void)antialiasThresholdDidChange:(NSNotification *)notification
4717 #ifdef NS_IMPL_COCOA
4718 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
4719   macfont_update_antialias_threshold ();
4720 #endif
4721 #endif
4725 /* Termination sequences:
4726     C-x C-c:
4727     Cmd-Q:
4728     MenuBar | File | Exit:
4729     Select Quit from App menubar:
4730         -terminate
4731         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4732         ns_term_shutdown()
4734     Select Quit from Dock menu:
4735     Logout attempt:
4736         -appShouldTerminate
4737           Cancel -> Nothing else
4738           Accept ->
4740           -terminate
4741           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4742           ns_term_shutdown()
4746 - (void) terminate: (id)sender
4748   struct frame *emacsframe = SELECTED_FRAME ();
4750   if (!emacs_event)
4751     return;
4753   emacs_event->kind = NS_NONKEY_EVENT;
4754   emacs_event->code = KEY_NS_POWER_OFF;
4755   emacs_event->arg = Qt; /* mark as non-key event */
4756   EV_TRAILER ((id)nil);
4760 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4762   int ret;
4764   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4765     return NSTerminateNow;
4767     ret = NSRunAlertPanel(ns_app_name,
4768                           @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4769                           @"Save Buffers and Exit", @"Cancel", nil);
4771     if (ret == NSAlertDefaultReturn)
4772         return NSTerminateNow;
4773     else if (ret == NSAlertAlternateReturn)
4774         return NSTerminateCancel;
4775     return NSTerminateNow;  /* just in case */
4778 static int
4779 not_in_argv (NSString *arg)
4781   int k;
4782   const char *a = [arg UTF8String];
4783   for (k = 1; k < initial_argc; ++k)
4784     if (strcmp (a, initial_argv[k]) == 0) return 0;
4785   return 1;
4788 /*   Notification from the Workspace to open a file */
4789 - (BOOL)application: sender openFile: (NSString *)file
4791   if (ns_do_open_file || not_in_argv (file))
4792     [ns_pending_files addObject: file];
4793   return YES;
4797 /*   Open a file as a temporary file */
4798 - (BOOL)application: sender openTempFile: (NSString *)file
4800   if (ns_do_open_file || not_in_argv (file))
4801     [ns_pending_files addObject: file];
4802   return YES;
4806 /*   Notification from the Workspace to open a file noninteractively (?) */
4807 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4809   if (ns_do_open_file || not_in_argv (file))
4810     [ns_pending_files addObject: file];
4811   return YES;
4814 /*   Notification from the Workspace to open multiple files */
4815 - (void)application: sender openFiles: (NSArray *)fileList
4817   NSEnumerator *files = [fileList objectEnumerator];
4818   NSString *file;
4819   /* Don't open files from the command line unconditionally,
4820      Cocoa parses the command line wrong, --option value tries to open value
4821      if --option is the last option.  */
4822   while ((file = [files nextObject]) != nil)
4823     if (ns_do_open_file || not_in_argv (file))
4824       [ns_pending_files addObject: file];
4826   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4831 /* Handle dock menu requests.  */
4832 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4834   return dockMenu;
4838 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4839 - (void)applicationWillBecomeActive: (NSNotification *)notification
4841   //ns_app_active=YES;
4843 - (void)applicationDidBecomeActive: (NSNotification *)notification
4845   NSTRACE (applicationDidBecomeActive);
4847 #ifdef NS_IMPL_GNUSTEP
4848   if (! applicationDidFinishLaunchingCalled)
4849     [self applicationDidFinishLaunching:notification];
4850 #endif
4851   //ns_app_active=YES;
4853   ns_update_auto_hide_menu_bar ();
4854   // No constraining takes place when the application is not active.
4855   ns_constrain_all_frames ();
4857 - (void)applicationDidResignActive: (NSNotification *)notification
4859   //ns_app_active=NO;
4860   ns_send_appdefined (-1);
4865 /* ==========================================================================
4867     EmacsApp aux handlers for managing event loop
4869    ========================================================================== */
4872 - (void)timeout_handler: (NSTimer *)timedEntry
4873 /* --------------------------------------------------------------------------
4874      The timeout specified to ns_select has passed.
4875    -------------------------------------------------------------------------- */
4877   /*NSTRACE (timeout_handler); */
4878   ns_send_appdefined (-2);
4881 #ifdef NS_IMPL_GNUSTEP
4882 - (void)sendFromMainThread:(id)unused
4884   ns_send_appdefined (nextappdefined);
4886 #endif
4888 - (void)fd_handler:(id)unused
4889 /* --------------------------------------------------------------------------
4890      Check data waiting on file descriptors and terminate if so
4891    -------------------------------------------------------------------------- */
4893   int result;
4894   int waiting = 1, nfds;
4895   char c;
4897   fd_set readfds, writefds, *wfds;
4898   struct timespec timeout, *tmo;
4899   NSAutoreleasePool *pool = nil;
4901   /* NSTRACE (fd_handler); */
4903   for (;;)
4904     {
4905       [pool release];
4906       pool = [[NSAutoreleasePool alloc] init];
4908       if (waiting)
4909         {
4910           fd_set fds;
4911           FD_ZERO (&fds);
4912           FD_SET (selfds[0], &fds);
4913           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
4914           if (result > 0 && read (selfds[0], &c, 1) == 1 && c == 'g')
4915             waiting = 0;
4916         }
4917       else
4918         {
4919           pthread_mutex_lock (&select_mutex);
4920           nfds = select_nfds;
4922           if (select_valid & SELECT_HAVE_READ)
4923             readfds = select_readfds;
4924           else
4925             FD_ZERO (&readfds);
4927           if (select_valid & SELECT_HAVE_WRITE)
4928             {
4929               writefds = select_writefds;
4930               wfds = &writefds;
4931             }
4932           else
4933             wfds = NULL;
4934           if (select_valid & SELECT_HAVE_TMO)
4935             {
4936               timeout = select_timeout;
4937               tmo = &timeout;
4938             }
4939           else
4940             tmo = NULL;
4942           pthread_mutex_unlock (&select_mutex);
4944           FD_SET (selfds[0], &readfds);
4945           if (selfds[0] >= nfds) nfds = selfds[0]+1;
4947           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
4949           if (result == 0)
4950             ns_send_appdefined (-2);
4951           else if (result > 0)
4952             {
4953               if (FD_ISSET (selfds[0], &readfds))
4954                 {
4955                   if (read (selfds[0], &c, 1) == 1 && c == 's')
4956                     waiting = 1;
4957                 }
4958               else
4959                 {
4960                   pthread_mutex_lock (&select_mutex);
4961                   if (select_valid & SELECT_HAVE_READ)
4962                     select_readfds = readfds;
4963                   if (select_valid & SELECT_HAVE_WRITE)
4964                     select_writefds = writefds;
4965                   if (select_valid & SELECT_HAVE_TMO)
4966                     select_timeout = timeout;
4967                   pthread_mutex_unlock (&select_mutex);
4969                   ns_send_appdefined (result);
4970                 }
4971             }
4972           waiting = 1;
4973         }
4974     }
4979 /* ==========================================================================
4981     Service provision
4983    ========================================================================== */
4985 /* called from system: queue for next pass through event loop */
4986 - (void)requestService: (NSPasteboard *)pboard
4987               userData: (NSString *)userData
4988                  error: (NSString **)error
4990   [ns_pending_service_names addObject: userData];
4991   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4992       SSDATA (ns_string_from_pasteboard (pboard))]];
4996 /* called from ns_read_socket to clear queue */
4997 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4999   struct frame *emacsframe = SELECTED_FRAME ();
5000   NSEvent *theEvent = [NSApp currentEvent];
5002   if (!emacs_event)
5003     return NO;
5005   emacs_event->kind = NS_NONKEY_EVENT;
5006   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
5007   ns_input_spi_name = build_string ([name UTF8String]);
5008   ns_input_spi_arg = build_string ([arg UTF8String]);
5009   emacs_event->modifiers = EV_MODIFIERS (theEvent);
5010   EV_TRAILER (theEvent);
5012   return YES;
5016 @end  /* EmacsApp */
5020 /* ==========================================================================
5022     EmacsView implementation
5024    ========================================================================== */
5027 @implementation EmacsView
5029 /* needed to inform when window closed from LISP */
5030 - (void) setWindowClosing: (BOOL)closing
5032   windowClosing = closing;
5036 - (void)dealloc
5038   NSTRACE (EmacsView_dealloc);
5039   [toolbar release];
5040   if (fs_state == FULLSCREEN_BOTH)
5041     [nonfs_window release];
5042   [super dealloc];
5046 /* called on font panel selection */
5047 - (void)changeFont: (id)sender
5049   NSEvent *e = [[self window] currentEvent];
5050   struct face *face = FRAME_DEFAULT_FACE (emacsframe);
5051   struct font *font = face->font;
5052   id newFont;
5053   CGFloat size;
5054   NSFont *nsfont;
5056   NSTRACE (changeFont);
5058   if (!emacs_event)
5059     return;
5061   if (EQ (font->driver->type, Qns))
5062     nsfont = ((struct nsfont_info *)font)->nsfont;
5063 #ifdef NS_IMPL_COCOA
5064 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
5065   else
5066     nsfont = (NSFont *) macfont_get_nsctfont (font);
5067 #endif
5068 #endif
5070   if ((newFont = [sender convertFont: nsfont]))
5071     {
5072       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
5074       emacs_event->kind = NS_NONKEY_EVENT;
5075       emacs_event->modifiers = 0;
5076       emacs_event->code = KEY_NS_CHANGE_FONT;
5078       size = [newFont pointSize];
5079       ns_input_fontsize = make_number (lrint (size));
5080       ns_input_font = build_string ([[newFont familyName] UTF8String]);
5081       EV_TRAILER (e);
5082     }
5086 - (BOOL)acceptsFirstResponder
5088   NSTRACE (acceptsFirstResponder);
5089   return YES;
5093 - (void)resetCursorRects
5095   NSRect visible = [self visibleRect];
5096   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
5097   NSTRACE (resetCursorRects);
5099   if (currentCursor == nil)
5100     currentCursor = [NSCursor arrowCursor];
5102   if (!NSIsEmptyRect (visible))
5103     [self addCursorRect: visible cursor: currentCursor];
5104   [currentCursor setOnMouseEntered: YES];
5109 /*****************************************************************************/
5110 /* Keyboard handling. */
5111 #define NS_KEYLOG 0
5113 - (void)keyDown: (NSEvent *)theEvent
5115   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5116   int code;
5117   unsigned fnKeysym = 0;
5118   static NSMutableArray *nsEvArray;
5119 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5120   static BOOL firstTime = YES;
5121 #endif
5122   int left_is_none;
5123   unsigned int flags = [theEvent modifierFlags];
5125   NSTRACE (keyDown);
5127   /* Rhapsody and OS X give up and down events for the arrow keys */
5128   if (ns_fake_keydown == YES)
5129     ns_fake_keydown = NO;
5130   else if ([theEvent type] != NSKeyDown)
5131     return;
5133   if (!emacs_event)
5134     return;
5136  if (![[self window] isKeyWindow]
5137      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
5138      /* we must avoid an infinite loop here. */
5139      && (EmacsView *)[[theEvent window] delegate] != self)
5140    {
5141      /* XXX: There is an occasional condition in which, when Emacs display
5142          updates a different frame from the current one, and temporarily
5143          selects it, then processes some interrupt-driven input
5144          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
5145          for some reason that window has its first responder set to the NSView
5146          most recently updated (I guess), which is not the correct one. */
5147      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
5148      return;
5149    }
5151   if (nsEvArray == nil)
5152     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
5154   [NSCursor setHiddenUntilMouseMoves: YES];
5156   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
5157     {
5158       clear_mouse_face (hlinfo);
5159       hlinfo->mouse_face_hidden = 1;
5160     }
5162   if (!processingCompose)
5163     {
5164       /* When using screen sharing, no left or right information is sent,
5165          so use Left key in those cases.  */
5166       int is_left_key, is_right_key;
5168       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
5169         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
5171       /* (Carbon way: [theEvent keyCode]) */
5173       /* is it a "function key"? */
5174       /* Note: Sometimes a plain key will have the NSNumericPadKeyMask
5175          flag set (this is probably a bug in the OS).
5176       */
5177       if (code < 0x00ff && (flags&NSNumericPadKeyMask))
5178         {
5179           fnKeysym = ns_convert_key ([theEvent keyCode] | NSNumericPadKeyMask);
5180         }
5181       if (fnKeysym == 0)
5182         {
5183           fnKeysym = ns_convert_key (code);
5184         }
5186       if (fnKeysym)
5187         {
5188           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
5189              because Emacs treats Delete and KP-Delete same (in simple.el). */
5190           if ((fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
5191 #ifdef NS_IMPL_GNUSTEP
5192               /*  GNUstep uses incompatible keycodes, even for those that are
5193                   supposed to be hardware independent.  Just check for delete.
5194                   Keypad delete does not have keysym 0xFFFF.
5195                   See http://savannah.gnu.org/bugs/?25395
5196               */
5197               || (fnKeysym == 0xFFFF && code == 127)
5198 #endif
5199             )
5200             code = 0xFF08; /* backspace */
5201           else
5202             code = fnKeysym;
5203         }
5205       /* are there modifiers? */
5206       emacs_event->modifiers = 0;
5208       if (flags & NSHelpKeyMask)
5209           emacs_event->modifiers |= hyper_modifier;
5211       if (flags & NSShiftKeyMask)
5212         emacs_event->modifiers |= shift_modifier;
5214       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
5215       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
5216         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
5218       if (is_right_key)
5219         emacs_event->modifiers |= parse_solitary_modifier
5220           (EQ (ns_right_command_modifier, Qleft)
5221            ? ns_command_modifier
5222            : ns_right_command_modifier);
5224       if (is_left_key)
5225         {
5226           emacs_event->modifiers |= parse_solitary_modifier
5227             (ns_command_modifier);
5229           /* if super (default), take input manager's word so things like
5230              dvorak / qwerty layout work */
5231           if (EQ (ns_command_modifier, Qsuper)
5232               && !fnKeysym
5233               && [[theEvent characters] length] != 0)
5234             {
5235               /* XXX: the code we get will be unshifted, so if we have
5236                  a shift modifier, must convert ourselves */
5237               if (!(flags & NSShiftKeyMask))
5238                 code = [[theEvent characters] characterAtIndex: 0];
5239 #if 0
5240               /* this is ugly and also requires linking w/Carbon framework
5241                  (for LMGetKbdType) so for now leave this rare (?) case
5242                  undealt with.. in future look into CGEvent methods */
5243               else
5244                 {
5245                   long smv = GetScriptManagerVariable (smKeyScript);
5246                   Handle uchrHandle = GetResource
5247                     ('uchr', GetScriptVariable (smv, smScriptKeys));
5248                   UInt32 dummy = 0;
5249                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
5250                                  [[theEvent characters] characterAtIndex: 0],
5251                                  kUCKeyActionDisplay,
5252                                  (flags & ~NSCommandKeyMask) >> 8,
5253                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
5254                                  &dummy, 1, &dummy, &code);
5255                   code &= 0xFF;
5256                 }
5257 #endif
5258             }
5259         }
5261       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
5262       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
5263         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
5265       if (is_right_key)
5266           emacs_event->modifiers |= parse_solitary_modifier
5267               (EQ (ns_right_control_modifier, Qleft)
5268                ? ns_control_modifier
5269                : ns_right_control_modifier);
5271       if (is_left_key)
5272         emacs_event->modifiers |= parse_solitary_modifier
5273           (ns_control_modifier);
5275       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
5276           emacs_event->modifiers |=
5277             parse_solitary_modifier (ns_function_modifier);
5279       left_is_none = NILP (ns_alternate_modifier)
5280         || EQ (ns_alternate_modifier, Qnone);
5282       is_right_key = (flags & NSRightAlternateKeyMask)
5283         == NSRightAlternateKeyMask;
5284       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
5285         || (! is_right_key
5286             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
5288       if (is_right_key)
5289         {
5290           if ((NILP (ns_right_alternate_modifier)
5291                || EQ (ns_right_alternate_modifier, Qnone)
5292                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
5293               && !fnKeysym)
5294             {   /* accept pre-interp alt comb */
5295               if ([[theEvent characters] length] > 0)
5296                 code = [[theEvent characters] characterAtIndex: 0];
5297               /*HACK: clear lone shift modifier to stop next if from firing */
5298               if (emacs_event->modifiers == shift_modifier)
5299                 emacs_event->modifiers = 0;
5300             }
5301           else
5302             emacs_event->modifiers |= parse_solitary_modifier
5303               (EQ (ns_right_alternate_modifier, Qleft)
5304                ? ns_alternate_modifier
5305                : ns_right_alternate_modifier);
5306         }
5308       if (is_left_key) /* default = meta */
5309         {
5310           if (left_is_none && !fnKeysym)
5311             {   /* accept pre-interp alt comb */
5312               if ([[theEvent characters] length] > 0)
5313                 code = [[theEvent characters] characterAtIndex: 0];
5314               /*HACK: clear lone shift modifier to stop next if from firing */
5315               if (emacs_event->modifiers == shift_modifier)
5316                 emacs_event->modifiers = 0;
5317             }
5318           else
5319               emacs_event->modifiers |=
5320                 parse_solitary_modifier (ns_alternate_modifier);
5321         }
5323   if (NS_KEYLOG)
5324     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
5325              code, fnKeysym, flags, emacs_event->modifiers);
5327       /* if it was a function key or had modifiers, pass it directly to emacs */
5328       if (fnKeysym || (emacs_event->modifiers
5329                        && (emacs_event->modifiers != shift_modifier)
5330                        && [[theEvent charactersIgnoringModifiers] length] > 0))
5331 /*[[theEvent characters] length] */
5332         {
5333           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5334           if (code < 0x20)
5335             code |= (1<<28)|(3<<16);
5336           else if (code == 0x7f)
5337             code |= (1<<28)|(3<<16);
5338           else if (!fnKeysym)
5339             emacs_event->kind = code > 0xFF
5340               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5342           emacs_event->code = code;
5343           EV_TRAILER (theEvent);
5344           processingCompose = NO;
5345           return;
5346         }
5347     }
5350 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5351   /* if we get here we should send the key for input manager processing */
5352   /* Disable warning, there is nothing a user can do about it anyway, and
5353      it does not seem to matter.  */
5354 #if 0
5355   if (firstTime && [[NSInputManager currentInputManager]
5356                      wantsToDelayTextChangeNotifications] == NO)
5357     fprintf (stderr,
5358           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
5359 #endif
5360   firstTime = NO;
5361 #endif
5362   if (NS_KEYLOG && !processingCompose)
5363     fprintf (stderr, "keyDown: Begin compose sequence.\n");
5365   processingCompose = YES;
5366   [nsEvArray addObject: theEvent];
5367   [self interpretKeyEvents: nsEvArray];
5368   [nsEvArray removeObject: theEvent];
5372 #ifdef NS_IMPL_COCOA
5373 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
5374    decided not to send key-down for.
5375    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
5376    This only applies on Tiger and earlier.
5377    If it matches one of these, send it on to keyDown. */
5378 -(void)keyUp: (NSEvent *)theEvent
5380   int flags = [theEvent modifierFlags];
5381   int code = [theEvent keyCode];
5382   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5383       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5384     {
5385       if (NS_KEYLOG)
5386         fprintf (stderr, "keyUp: passed test");
5387       ns_fake_keydown = YES;
5388       [self keyDown: theEvent];
5389     }
5391 #endif
5394 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5397 /* <NSTextInput>: called when done composing;
5398    NOTE: also called when we delete over working text, followed immed.
5399          by doCommandBySelector: deleteBackward: */
5400 - (void)insertText: (id)aString
5402   int code;
5403   int len = [(NSString *)aString length];
5404   int i;
5406   if (NS_KEYLOG)
5407     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5408   processingCompose = NO;
5410   if (!emacs_event)
5411     return;
5413   /* first, clear any working text */
5414   if (workingText != nil)
5415     [self deleteWorkingText];
5417   /* now insert the string as keystrokes */
5418   for (i =0; i<len; i++)
5419     {
5420       code = [aString characterAtIndex: i];
5421       /* TODO: still need this? */
5422       if (code == 0x2DC)
5423         code = '~'; /* 0x7E */
5424       if (code != 32) /* Space */
5425         emacs_event->modifiers = 0;
5426       emacs_event->kind
5427         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5428       emacs_event->code = code;
5429       EV_TRAILER ((id)nil);
5430     }
5434 /* <NSTextInput>: inserts display of composing characters */
5435 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5437   NSString *str = [aString respondsToSelector: @selector (string)] ?
5438     [aString string] : aString;
5439   if (NS_KEYLOG)
5440     NSLog (@"setMarkedText '%@' len =%lu range %lu from %lu",
5441            str, (unsigned long)[str length],
5442            (unsigned long)selRange.length,
5443            (unsigned long)selRange.location);
5445   if (workingText != nil)
5446     [self deleteWorkingText];
5447   if ([str length] == 0)
5448     return;
5450   if (!emacs_event)
5451     return;
5453   processingCompose = YES;
5454   workingText = [str copy];
5455   ns_working_text = build_string ([workingText UTF8String]);
5457   emacs_event->kind = NS_TEXT_EVENT;
5458   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5459   EV_TRAILER ((id)nil);
5463 /* delete display of composing characters [not in <NSTextInput>] */
5464 - (void)deleteWorkingText
5466   if (workingText == nil)
5467     return;
5468   if (NS_KEYLOG)
5469     NSLog(@"deleteWorkingText len =%lu\n", (unsigned long)[workingText length]);
5470   [workingText release];
5471   workingText = nil;
5472   processingCompose = NO;
5474   if (!emacs_event)
5475     return;
5477   emacs_event->kind = NS_TEXT_EVENT;
5478   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5479   EV_TRAILER ((id)nil);
5483 - (BOOL)hasMarkedText
5485   return workingText != nil;
5489 - (NSRange)markedRange
5491   NSRange rng = workingText != nil
5492     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5493   if (NS_KEYLOG)
5494     NSLog (@"markedRange request");
5495   return rng;
5499 - (void)unmarkText
5501   if (NS_KEYLOG)
5502     NSLog (@"unmark (accept) text");
5503   [self deleteWorkingText];
5504   processingCompose = NO;
5508 /* used to position char selection windows, etc. */
5509 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5511   NSRect rect;
5512   NSPoint pt;
5513   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5514   if (NS_KEYLOG)
5515     NSLog (@"firstRectForCharRange request");
5517   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5518   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5519   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5520   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5521                                        +FRAME_LINE_HEIGHT (emacsframe));
5523   pt = [self convertPoint: pt toView: nil];
5524   pt = [[self window] convertBaseToScreen: pt];
5525   rect.origin = pt;
5526   return rect;
5530 - (NSInteger)conversationIdentifier
5532   return (NSInteger)self;
5536 - (void)doCommandBySelector: (SEL)aSelector
5538   if (NS_KEYLOG)
5539     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5541   processingCompose = NO;
5542   if (aSelector == @selector (deleteBackward:))
5543     {
5544       /* happens when user backspaces over an ongoing composition:
5545          throw a 'delete' into the event queue */
5546       if (!emacs_event)
5547         return;
5548       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5549       emacs_event->code = 0xFF08;
5550       EV_TRAILER ((id)nil);
5551     }
5554 - (NSArray *)validAttributesForMarkedText
5556   static NSArray *arr = nil;
5557   if (arr == nil) arr = [NSArray new];
5558  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5559   return arr;
5562 - (NSRange)selectedRange
5564   if (NS_KEYLOG)
5565     NSLog (@"selectedRange request");
5566   return NSMakeRange (NSNotFound, 0);
5569 #if defined (NS_IMPL_COCOA) || GNUSTEP_GUI_MAJOR_VERSION > 0 || \
5570     GNUSTEP_GUI_MINOR_VERSION > 22
5571 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5572 #else
5573 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
5574 #endif
5576   if (NS_KEYLOG)
5577     NSLog (@"characterIndexForPoint request");
5578   return 0;
5581 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5583   static NSAttributedString *str = nil;
5584   if (str == nil) str = [NSAttributedString new];
5585   if (NS_KEYLOG)
5586     NSLog (@"attributedSubstringFromRange request");
5587   return str;
5590 /* End <NSTextInput> impl. */
5591 /*****************************************************************************/
5594 /* This is what happens when the user presses a mouse button.  */
5595 - (void)mouseDown: (NSEvent *)theEvent
5597   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5598   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5600   NSTRACE (mouseDown);
5602   [self deleteWorkingText];
5604   if (!emacs_event)
5605     return;
5607   dpyinfo->last_mouse_frame = emacsframe;
5608   /* appears to be needed to prevent spurious movement events generated on
5609      button clicks */
5610   emacsframe->mouse_moved = 0;
5612   if ([theEvent type] == NSScrollWheel)
5613     {
5614       CGFloat delta = [theEvent deltaY];
5615       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5616       if (delta == 0)
5617         {
5618           delta = [theEvent deltaX];
5619           if (delta == 0)
5620             {
5621               NSTRACE (deltaIsZero);
5622               return;
5623             }
5624           emacs_event->kind = HORIZ_WHEEL_EVENT;
5625         }
5626       else
5627         emacs_event->kind = WHEEL_EVENT;
5629       emacs_event->code = 0;
5630       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5631         ((delta > 0) ? up_modifier : down_modifier);
5632     }
5633   else
5634     {
5635       emacs_event->kind = MOUSE_CLICK_EVENT;
5636       emacs_event->code = EV_BUTTON (theEvent);
5637       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5638                              | EV_UDMODIFIERS (theEvent);
5639     }
5640   XSETINT (emacs_event->x, lrint (p.x));
5641   XSETINT (emacs_event->y, lrint (p.y));
5642   EV_TRAILER (theEvent);
5646 - (void)rightMouseDown: (NSEvent *)theEvent
5648   NSTRACE (rightMouseDown);
5649   [self mouseDown: theEvent];
5653 - (void)otherMouseDown: (NSEvent *)theEvent
5655   NSTRACE (otherMouseDown);
5656   [self mouseDown: theEvent];
5660 - (void)mouseUp: (NSEvent *)theEvent
5662   NSTRACE (mouseUp);
5663   [self mouseDown: theEvent];
5667 - (void)rightMouseUp: (NSEvent *)theEvent
5669   NSTRACE (rightMouseUp);
5670   [self mouseDown: theEvent];
5674 - (void)otherMouseUp: (NSEvent *)theEvent
5676   NSTRACE (otherMouseUp);
5677   [self mouseDown: theEvent];
5681 - (void) scrollWheel: (NSEvent *)theEvent
5683   NSTRACE (scrollWheel);
5684   [self mouseDown: theEvent];
5688 /* Tell emacs the mouse has moved. */
5689 - (void)mouseMoved: (NSEvent *)e
5691   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5692   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5693   Lisp_Object frame;
5694   NSPoint pt;
5696 //  NSTRACE (mouseMoved);
5698   dpyinfo->last_mouse_movement_time = EV_TIMESTAMP (e);
5699   pt = [self convertPoint: [e locationInWindow] fromView: nil];
5700   dpyinfo->last_mouse_motion_x = pt.x;
5701   dpyinfo->last_mouse_motion_y = pt.y;
5703   /* update any mouse face */
5704   if (hlinfo->mouse_face_hidden)
5705     {
5706       hlinfo->mouse_face_hidden = 0;
5707       clear_mouse_face (hlinfo);
5708     }
5710   /* tooltip handling */
5711   previous_help_echo_string = help_echo_string;
5712   help_echo_string = Qnil;
5714   if (!NILP (Vmouse_autoselect_window))
5715     {
5716       NSTRACE (mouse_autoselect_window);
5717       static Lisp_Object last_mouse_window;
5718       Lisp_Object window
5719         = window_from_coordinates (emacsframe, pt.x, pt.y, 0, 0);
5721       if (WINDOWP (window)
5722           && !EQ (window, last_mouse_window)
5723           && !EQ (window, selected_window)
5724           && (focus_follows_mouse
5725               || (EQ (XWINDOW (window)->frame,
5726                       XWINDOW (selected_window)->frame))))
5727         {
5728           NSTRACE (in_window);
5729           emacs_event->kind = SELECT_WINDOW_EVENT;
5730           emacs_event->frame_or_window = window;
5731           EV_TRAILER2 (e);
5732         }
5733       /* Remember the last window where we saw the mouse.  */
5734       last_mouse_window = window;
5735     }
5737   if (!note_mouse_movement (emacsframe, pt.x, pt.y))
5738     help_echo_string = previous_help_echo_string;
5740   XSETFRAME (frame, emacsframe);
5741   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5742     {
5743       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5744          (note_mouse_highlight), which is called through the
5745          note_mouse_movement () call above */
5746       any_help_event_p = YES;
5747       gen_help_event (help_echo_string, frame, help_echo_window,
5748                       help_echo_object, help_echo_pos);
5749     }
5751   if (emacsframe->mouse_moved && send_appdefined)
5752     ns_send_appdefined (-1);
5756 - (void)mouseDragged: (NSEvent *)e
5758   NSTRACE (mouseDragged);
5759   [self mouseMoved: e];
5763 - (void)rightMouseDragged: (NSEvent *)e
5765   NSTRACE (rightMouseDragged);
5766   [self mouseMoved: e];
5770 - (void)otherMouseDragged: (NSEvent *)e
5772   NSTRACE (otherMouseDragged);
5773   [self mouseMoved: e];
5777 - (BOOL)windowShouldClose: (id)sender
5779   NSEvent *e =[[self window] currentEvent];
5781   NSTRACE (windowShouldClose);
5782   windowClosing = YES;
5783   if (!emacs_event)
5784     return NO;
5785   emacs_event->kind = DELETE_WINDOW_EVENT;
5786   emacs_event->modifiers = 0;
5787   emacs_event->code = 0;
5788   EV_TRAILER (e);
5789   /* Don't close this window, let this be done from lisp code.  */
5790   return NO;
5793 - (void) updateFrameSize: (BOOL) delay;
5795   NSWindow *window = [self window];
5796   NSRect wr = [window frame];
5797   int extra = 0;
5798   int oldc = cols, oldr = rows;
5799   int oldw = FRAME_PIXEL_WIDTH (emacsframe);
5800   int oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5801   int neww, newh;
5803   NSTRACE (updateFrameSize);
5804   NSTRACE_SIZE ("Original size", NSMakeSize (oldw, oldh));
5806   if (! [self isFullscreen])
5807     {
5808 #ifdef NS_IMPL_GNUSTEP
5809       // GNUstep does not always update the tool bar height.  Force it.
5810       if (toolbar) update_frame_tool_bar (emacsframe);
5811 #endif
5813       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5814         + FRAME_TOOLBAR_HEIGHT (emacsframe);
5815     }
5817   if (wait_for_tool_bar)
5818     {
5819       if (FRAME_TOOLBAR_HEIGHT (emacsframe) == 0)
5820         return;
5821       wait_for_tool_bar = NO;
5822     }
5824   neww = (int)wr.size.width - emacsframe->border_width;
5825   newh = (int)wr.size.height - extra;
5827   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, neww);
5828   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, newh);
5830   if (cols < MINWIDTH)
5831     cols = MINWIDTH;
5833   if (rows < MINHEIGHT)
5834     rows = MINHEIGHT;
5836   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5837     {
5838       NSView *view = FRAME_NS_VIEW (emacsframe);
5839       NSWindow *win = [view window];
5840       NSSize sz = [win resizeIncrements];
5842       change_frame_size (emacsframe,
5843                          FRAME_PIXEL_TO_TEXT_WIDTH (emacsframe, neww),
5844                          FRAME_PIXEL_TO_TEXT_HEIGHT (emacsframe, newh),
5845                          0, delay, 0, 1);
5846       SET_FRAME_GARBAGED (emacsframe);
5847       cancel_mouse_face (emacsframe);
5849       // Did resize increments change because of a font change?
5850       if (sz.width != FRAME_COLUMN_WIDTH (emacsframe) ||
5851           sz.height != FRAME_LINE_HEIGHT (emacsframe) ||
5852           (frame_resize_pixelwise && sz.width != 1))
5853         {
5854           sz.width = frame_resize_pixelwise
5855             ? 1 : FRAME_COLUMN_WIDTH (emacsframe);
5856           sz.height = frame_resize_pixelwise
5857             ? 1 : FRAME_LINE_HEIGHT (emacsframe);
5858           [win setResizeIncrements: sz];
5860           NSTRACE_SIZE ("New size", NSMakeSize (neww, newh));
5861         }
5863       [view setFrame: NSMakeRect (0, 0, neww, newh)];
5864       [self windowDidMove:nil];   // Update top/left.
5865     }
5868 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
5869 /* normalize frame to gridded text size */
5871   int extra = 0;
5873   NSTRACE (windowWillResize);
5874   NSTRACE_SIZE ("Original size", frameSize);
5875 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5877   if (fs_state == FULLSCREEN_MAXIMIZED
5878       && (maximized_width != (int)frameSize.width
5879           || maximized_height != (int)frameSize.height))
5880     [self setFSValue: FULLSCREEN_NONE];
5881   else if (fs_state == FULLSCREEN_WIDTH
5882            && maximized_width != (int)frameSize.width)
5883     [self setFSValue: FULLSCREEN_NONE];
5884   else if (fs_state == FULLSCREEN_HEIGHT
5885            && maximized_height != (int)frameSize.height)
5886     [self setFSValue: FULLSCREEN_NONE];
5887   if (fs_state == FULLSCREEN_NONE)
5888     maximized_width = maximized_height = -1;
5890   if (! [self isFullscreen])
5891     {
5892       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5893         + FRAME_TOOLBAR_HEIGHT (emacsframe);
5894     }
5896   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, frameSize.width);
5897   if (cols < MINWIDTH)
5898     cols = MINWIDTH;
5900   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe,
5901                                            frameSize.height - extra);
5902   if (rows < MINHEIGHT)
5903     rows = MINHEIGHT;
5904 #ifdef NS_IMPL_COCOA
5905   {
5906     /* this sets window title to have size in it; the wm does this under GS */
5907     NSRect r = [[self window] frame];
5908     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5909       {
5910         if (old_title != 0)
5911           {
5912             xfree (old_title);
5913             old_title = 0;
5914           }
5915       }
5916     else if (fs_state == FULLSCREEN_NONE && ! maximizing_resize)
5917       {
5918         char *size_title;
5919         NSWindow *window = [self window];
5920         if (old_title == 0)
5921           {
5922             char *t = strdup ([[[self window] title] UTF8String]);
5923             char *pos = strstr (t, "  â€”  ");
5924             if (pos)
5925               *pos = '\0';
5926             old_title = t;
5927           }
5928         size_title = xmalloc (strlen (old_title) + 40);
5929         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5930         [window setTitle: [NSString stringWithUTF8String: size_title]];
5931         [window display];
5932         xfree (size_title);
5933       }
5934   }
5935 #endif /* NS_IMPL_COCOA */
5936 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5938   return frameSize;
5942 - (void)windowDidResize: (NSNotification *)notification
5944   if (! [self fsIsNative])
5945     {
5946       NSWindow *theWindow = [notification object];
5947       /* We can get notification on the non-FS window when in
5948          fullscreen mode.  */
5949       if ([self window] != theWindow) return;
5950     }
5952 #ifdef NS_IMPL_GNUSTEP
5953   NSWindow *theWindow = [notification object];
5955    /* In GNUstep, at least currently, it's possible to get a didResize
5956       without getting a willResize.. therefore we need to act as if we got
5957       the willResize now */
5958   NSSize sz = [theWindow frame].size;
5959   sz = [self windowWillResize: theWindow toSize: sz];
5960 #endif /* NS_IMPL_GNUSTEP */
5962   NSTRACE (windowDidResize);
5963 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5965 if (cols > 0 && rows > 0)
5966     {
5967       [self updateFrameSize: YES];
5968     }
5970   ns_send_appdefined (-1);
5973 #ifdef NS_IMPL_COCOA
5974 - (void)viewDidEndLiveResize
5976   [super viewDidEndLiveResize];
5977   if (old_title != 0)
5978     {
5979       [[self window] setTitle: [NSString stringWithUTF8String: old_title]];
5980       xfree (old_title);
5981       old_title = 0;
5982     }
5983   maximizing_resize = NO;
5985 #endif /* NS_IMPL_COCOA */
5988 - (void)windowDidBecomeKey: (NSNotification *)notification
5989 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5991   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5992   struct frame *old_focus = dpyinfo->x_focus_frame;
5994   NSTRACE (windowDidBecomeKey);
5996   if (emacsframe != old_focus)
5997     dpyinfo->x_focus_frame = emacsframe;
5999   ns_frame_rehighlight (emacsframe);
6001   if (emacs_event)
6002     {
6003       emacs_event->kind = FOCUS_IN_EVENT;
6004       EV_TRAILER ((id)nil);
6005     }
6009 - (void)windowDidResignKey: (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   BOOL is_focus_frame = dpyinfo->x_focus_frame == emacsframe;
6014   NSTRACE (windowDidResignKey);
6016   if (is_focus_frame)
6017     dpyinfo->x_focus_frame = 0;
6019   emacsframe->mouse_moved = 0;
6020   ns_frame_rehighlight (emacsframe);
6022   /* FIXME: for some reason needed on second and subsequent clicks away
6023             from sole-frame Emacs to get hollow box to show */
6024   if (!windowClosing && [[self window] isVisible] == YES)
6025     {
6026       x_update_cursor (emacsframe, 1);
6027       x_set_frame_alpha (emacsframe);
6028     }
6030   if (any_help_event_p)
6031     {
6032       Lisp_Object frame;
6033       XSETFRAME (frame, emacsframe);
6034       help_echo_string = Qnil;
6035       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6036     }
6038   if (emacs_event && is_focus_frame)
6039     {
6040       [self deleteWorkingText];
6041       emacs_event->kind = FOCUS_OUT_EVENT;
6042       EV_TRAILER ((id)nil);
6043     }
6047 - (void)windowWillMiniaturize: sender
6049   NSTRACE (windowWillMiniaturize);
6053 - (BOOL)isFlipped
6055   return YES;
6059 - (BOOL)isOpaque
6061   return NO;
6065 - initFrameFromEmacs: (struct frame *)f
6067   NSRect r, wr;
6068   Lisp_Object tem;
6069   NSWindow *win;
6070   NSSize sz;
6071   NSColor *col;
6072   NSString *name;
6074   NSTRACE (initFrameFromEmacs);
6076   windowClosing = NO;
6077   processingCompose = NO;
6078   scrollbarsNeedingUpdate = 0;
6079   fs_state = FULLSCREEN_NONE;
6080   fs_before_fs = next_maximized = -1;
6081 #ifdef HAVE_NATIVE_FS
6082   fs_is_native = ns_use_native_fullscreen;
6083 #else
6084   fs_is_native = NO;
6085 #endif
6086   maximized_width = maximized_height = -1;
6087   nonfs_window = nil;
6089 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
6091   ns_userRect = NSMakeRect (0, 0, 0, 0);
6092   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
6093                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
6094   [self initWithFrame: r];
6095   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
6097   FRAME_NS_VIEW (f) = self;
6098   emacsframe = f;
6099 #ifdef NS_IMPL_COCOA
6100   old_title = 0;
6101   maximizing_resize = NO;
6102 #endif
6104   win = [[EmacsWindow alloc]
6105             initWithContentRect: r
6106                       styleMask: (NSResizableWindowMask |
6107 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6108                                   NSTitledWindowMask |
6109 #endif
6110                                   NSMiniaturizableWindowMask |
6111                                   NSClosableWindowMask)
6112                         backing: NSBackingStoreBuffered
6113                           defer: YES];
6115 #ifdef HAVE_NATIVE_FS
6116     [win setCollectionBehavior:NSWindowCollectionBehaviorFullScreenPrimary];
6117 #endif
6119   wr = [win frame];
6120   bwidth = f->border_width = wr.size.width - r.size.width;
6121   tibar_height = FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
6123   [win setAcceptsMouseMovedEvents: YES];
6124   [win setDelegate: self];
6125   [win useOptimizedDrawing: YES];
6127   sz.width = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
6128   sz.height = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
6129   [win setResizeIncrements: sz];
6131   [[win contentView] addSubview: self];
6133   if (ns_drag_types)
6134     [self registerForDraggedTypes: ns_drag_types];
6136   tem = f->name;
6137   name = [NSString stringWithUTF8String:
6138                    NILP (tem) ? "Emacs" : SSDATA (tem)];
6139   [win setTitle: name];
6141   /* toolbar support */
6142   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
6143                          [NSString stringWithFormat: @"Emacs Frame %d",
6144                                    ns_window_num]];
6145   [win setToolbar: toolbar];
6146   [toolbar setVisible: NO];
6148   /* Don't set frame garbaged until tool bar is up to date?
6149      This avoids an extra clear and redraw (flicker) at frame creation.  */
6150   if (FRAME_EXTERNAL_TOOL_BAR (f)) wait_for_tool_bar = YES;
6151   else wait_for_tool_bar = NO;
6154 #ifdef NS_IMPL_COCOA
6155   {
6156     NSButton *toggleButton;
6157   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
6158   [toggleButton setTarget: self];
6159   [toggleButton setAction: @selector (toggleToolbar: )];
6160   }
6161 #endif
6162   FRAME_TOOLBAR_HEIGHT (f) = 0;
6164   tem = f->icon_name;
6165   if (!NILP (tem))
6166     [win setMiniwindowTitle:
6167            [NSString stringWithUTF8String: SSDATA (tem)]];
6169   {
6170     NSScreen *screen = [win screen];
6172     if (screen != 0)
6173       [win setFrameTopLeftPoint: NSMakePoint
6174            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
6175             IN_BOUND (-SCREENMAX,
6176                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
6177   }
6179   [win makeFirstResponder: self];
6181   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6182                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
6183   [win setBackgroundColor: col];
6184   if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6185     [win setOpaque: NO];
6187   [self allocateGState];
6189   [NSApp registerServicesMenuSendTypes: ns_send_types
6190                            returnTypes: nil];
6192   ns_window_num++;
6193   return self;
6197 - (void)windowDidMove: sender
6199   NSWindow *win = [self window];
6200   NSRect r = [win frame];
6201   NSArray *screens = [NSScreen screens];
6202   NSScreen *screen = [screens objectAtIndex: 0];
6204   NSTRACE (windowDidMove);
6206   if (!emacsframe->output_data.ns)
6207     return;
6208   if (screen != nil)
6209     {
6210       emacsframe->left_pos = r.origin.x;
6211       emacsframe->top_pos =
6212         [screen frame].size.height - (r.origin.y + r.size.height);
6213     }
6217 /* Called AFTER method below, but before our windowWillResize call there leads
6218    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
6219    location so set_window_size moves the frame. */
6220 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
6222   emacsframe->output_data.ns->zooming = 1;
6223   return YES;
6227 /* Override to do something slightly nonstandard, but nice.  First click on
6228    zoom button will zoom vertically.  Second will zoom completely.  Third
6229    returns to original. */
6230 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
6231                         defaultFrame:(NSRect)defaultFrame
6233   NSRect result = [sender frame];
6235   NSTRACE (windowWillUseStandardFrame);
6237   if (fs_before_fs != -1) /* Entering fullscreen */
6238       {
6239         result = defaultFrame;
6240       }
6241   else if (next_maximized == FULLSCREEN_HEIGHT
6242       || (next_maximized == -1
6243           && abs (defaultFrame.size.height - result.size.height)
6244           > FRAME_LINE_HEIGHT (emacsframe)))
6245     {
6246       /* first click */
6247       ns_userRect = result;
6248       maximized_height = result.size.height = defaultFrame.size.height;
6249       maximized_width = -1;
6250       result.origin.y = defaultFrame.origin.y;
6251       [self setFSValue: FULLSCREEN_HEIGHT];
6252 #ifdef NS_IMPL_COCOA
6253       maximizing_resize = YES;
6254 #endif
6255     }
6256   else if (next_maximized == FULLSCREEN_WIDTH)
6257     {
6258       ns_userRect = result;
6259       maximized_width = result.size.width = defaultFrame.size.width;
6260       maximized_height = -1;
6261       result.origin.x = defaultFrame.origin.x;
6262       [self setFSValue: FULLSCREEN_WIDTH];
6263     }
6264   else if (next_maximized == FULLSCREEN_MAXIMIZED
6265            || (next_maximized == -1
6266                && abs (defaultFrame.size.width - result.size.width)
6267                > FRAME_COLUMN_WIDTH (emacsframe)))
6268     {
6269       result = defaultFrame;  /* second click */
6270       maximized_width = result.size.width;
6271       maximized_height = result.size.height;
6272       [self setFSValue: FULLSCREEN_MAXIMIZED];
6273 #ifdef NS_IMPL_COCOA
6274       maximizing_resize = YES;
6275 #endif
6276     }
6277   else
6278     {
6279       /* restore */
6280       result = ns_userRect.size.height ? ns_userRect : result;
6281       ns_userRect = NSMakeRect (0, 0, 0, 0);
6282 #ifdef NS_IMPL_COCOA
6283       maximizing_resize = fs_state != FULLSCREEN_NONE;
6284 #endif
6285       [self setFSValue: FULLSCREEN_NONE];
6286       maximized_width = maximized_height = -1;
6287     }
6289   if (fs_before_fs == -1) next_maximized = -1;
6290   [self windowWillResize: sender toSize: result.size];
6291   return result;
6295 - (void)windowDidDeminiaturize: sender
6297   NSTRACE (windowDidDeminiaturize);
6298   if (!emacsframe->output_data.ns)
6299     return;
6301   SET_FRAME_ICONIFIED (emacsframe, 0);
6302   SET_FRAME_VISIBLE (emacsframe, 1);
6303   windows_or_buffers_changed = 63;
6305   if (emacs_event)
6306     {
6307       emacs_event->kind = DEICONIFY_EVENT;
6308       EV_TRAILER ((id)nil);
6309     }
6313 - (void)windowDidExpose: sender
6315   NSTRACE (windowDidExpose);
6316   if (!emacsframe->output_data.ns)
6317     return;
6319   SET_FRAME_VISIBLE (emacsframe, 1);
6320   SET_FRAME_GARBAGED (emacsframe);
6322   if (send_appdefined)
6323     ns_send_appdefined (-1);
6327 - (void)windowDidMiniaturize: sender
6329   NSTRACE (windowDidMiniaturize);
6330   if (!emacsframe->output_data.ns)
6331     return;
6333   SET_FRAME_ICONIFIED (emacsframe, 1);
6334   SET_FRAME_VISIBLE (emacsframe, 0);
6336   if (emacs_event)
6337     {
6338       emacs_event->kind = ICONIFY_EVENT;
6339       EV_TRAILER ((id)nil);
6340     }
6343 #ifdef HAVE_NATIVE_FS
6344 - (NSApplicationPresentationOptions)window:(NSWindow *)window
6345       willUseFullScreenPresentationOptions:
6346   (NSApplicationPresentationOptions)proposedOptions
6348   return proposedOptions|NSApplicationPresentationAutoHideToolbar;
6350 #endif
6352 - (void)windowWillEnterFullScreen:(NSNotification *)notification
6354   fs_before_fs = fs_state;
6357 - (void)windowDidEnterFullScreen:(NSNotification *)notification
6359   [self setFSValue: FULLSCREEN_BOTH];
6360   if (! [self fsIsNative])
6361     {
6362       [self windowDidBecomeKey:notification];
6363       [nonfs_window orderOut:self];
6364     }
6365   else
6366     {
6367       BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (emacsframe) ? YES : NO;
6368 #ifdef NS_IMPL_COCOA
6369 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6370       unsigned val = (unsigned)[NSApp presentationOptions];
6372       // OSX 10.7 bug fix, the menu won't appear without this.
6373       // val is non-zero on other OSX versions.
6374       if (val == 0)
6375         {
6376           NSApplicationPresentationOptions options
6377             = NSApplicationPresentationAutoHideDock
6378             | NSApplicationPresentationAutoHideMenuBar
6379             | NSApplicationPresentationFullScreen
6380             | NSApplicationPresentationAutoHideToolbar;
6382           [NSApp setPresentationOptions: options];
6383         }
6384 #endif
6385 #endif
6386       [toolbar setVisible:tbar_visible];
6387     }
6390 - (void)windowWillExitFullScreen:(NSNotification *)notification
6392   if (next_maximized != -1)
6393     fs_before_fs = next_maximized;
6396 - (void)windowDidExitFullScreen:(NSNotification *)notification
6398   [self setFSValue: fs_before_fs];
6399   fs_before_fs = -1;
6400 #ifdef HAVE_NATIVE_FS
6401   [self updateCollectionBehavior];
6402 #endif
6403   if (FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6404     {
6405       [toolbar setVisible:YES];
6406       update_frame_tool_bar (emacsframe);
6407       [self updateFrameSize:YES];
6408       [[self window] display];
6409     }
6410   else
6411     [toolbar setVisible:NO];
6413   if (next_maximized != -1)
6414     [[self window] performZoom:self];
6417 - (BOOL)fsIsNative
6419   return fs_is_native;
6422 - (BOOL)isFullscreen
6424   if (! fs_is_native) return nonfs_window != nil;
6425 #ifdef HAVE_NATIVE_FS
6426   return ([[self window] styleMask] & NSFullScreenWindowMask) != 0;
6427 #else
6428   return NO;
6429 #endif
6432 #ifdef HAVE_NATIVE_FS
6433 - (void)updateCollectionBehavior
6435   if (! [self isFullscreen])
6436     {
6437       NSWindow *win = [self window];
6438       NSWindowCollectionBehavior b = [win collectionBehavior];
6439       if (ns_use_native_fullscreen)
6440         b |= NSWindowCollectionBehaviorFullScreenPrimary;
6441       else
6442         b &= ~NSWindowCollectionBehaviorFullScreenPrimary;
6444       [win setCollectionBehavior: b];
6445       fs_is_native = ns_use_native_fullscreen;
6446     }
6448 #endif
6450 - (void)toggleFullScreen: (id)sender
6452   NSWindow *w, *fw;
6453   BOOL onFirstScreen;
6454   struct frame *f;
6455   NSSize sz;
6456   NSRect r, wr;
6457   NSColor *col;
6459   if (fs_is_native)
6460     {
6461 #ifdef HAVE_NATIVE_FS
6462       [[self window] toggleFullScreen:sender];
6463 #endif
6464       return;
6465     }
6467   w = [self window];
6468   onFirstScreen = [[w screen] isEqual:[[NSScreen screens] objectAtIndex:0]];
6469   f = emacsframe;
6470   wr = [w frame];
6471   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6472                                  (FRAME_DEFAULT_FACE (f)),
6473                                  f);
6475   sz.width = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
6476   sz.height = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
6478   if (fs_state != FULLSCREEN_BOTH)
6479     {
6480       NSScreen *screen = [w screen];
6482 #if defined (NS_IMPL_COCOA) && \
6483   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
6484       /* Hide ghost menu bar on secondary monitor? */
6485       if (! onFirstScreen)
6486         onFirstScreen = [NSScreen screensHaveSeparateSpaces];
6487 #endif
6488       /* Hide dock and menubar if we are on the primary screen.  */
6489       if (onFirstScreen)
6490         {
6491 #if defined (NS_IMPL_COCOA) && \
6492   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6493           NSApplicationPresentationOptions options
6494             = NSApplicationPresentationAutoHideDock
6495             | NSApplicationPresentationAutoHideMenuBar;
6497           [NSApp setPresentationOptions: options];
6498 #else
6499           [NSMenu setMenuBarVisible:NO];
6500 #endif
6501         }
6503       fw = [[EmacsFSWindow alloc]
6504                        initWithContentRect:[w contentRectForFrameRect:wr]
6505                                  styleMask:NSBorderlessWindowMask
6506                                    backing:NSBackingStoreBuffered
6507                                      defer:YES
6508                                     screen:screen];
6510       [fw setContentView:[w contentView]];
6511       [fw setTitle:[w title]];
6512       [fw setDelegate:self];
6513       [fw setAcceptsMouseMovedEvents: YES];
6514       [fw useOptimizedDrawing: YES];
6515       [fw setResizeIncrements: sz];
6516       [fw setBackgroundColor: col];
6517       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6518         [fw setOpaque: NO];
6520       f->border_width = 0;
6521       FRAME_NS_TITLEBAR_HEIGHT (f) = 0;
6522       tobar_height = FRAME_TOOLBAR_HEIGHT (f);
6523       FRAME_TOOLBAR_HEIGHT (f) = 0;
6525       nonfs_window = w;
6527       [self windowWillEnterFullScreen:nil];
6528       [fw makeKeyAndOrderFront:NSApp];
6529       [fw makeFirstResponder:self];
6530       [w orderOut:self];
6531       r = [fw frameRectForContentRect:[screen frame]];
6532       [fw setFrame: r display:YES animate:YES];
6533       [self windowDidEnterFullScreen:nil];
6534       [fw display];
6535     }
6536   else
6537     {
6538       fw = w;
6539       w = nonfs_window;
6540       nonfs_window = nil;
6542       if (onFirstScreen)
6543         {
6544 #if defined (NS_IMPL_COCOA) && \
6545   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6546           [NSApp setPresentationOptions: NSApplicationPresentationDefault];
6547 #else
6548           [NSMenu setMenuBarVisible:YES];
6549 #endif
6550         }
6552       [w setContentView:[fw contentView]];
6553       [w setResizeIncrements: sz];
6554       [w setBackgroundColor: col];
6555       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6556         [w setOpaque: NO];
6558       f->border_width = bwidth;
6559       FRAME_NS_TITLEBAR_HEIGHT (f) = tibar_height;
6560       if (FRAME_EXTERNAL_TOOL_BAR (f))
6561         FRAME_TOOLBAR_HEIGHT (f) = tobar_height;
6563       [self windowWillExitFullScreen:nil];
6564       [fw setFrame: [w frame] display:YES animate:YES];
6565       [fw close];
6566       [w makeKeyAndOrderFront:NSApp];
6567       [self windowDidExitFullScreen:nil];
6568       [self updateFrameSize:YES];
6569     }
6572 - (void)handleFS
6574   if (fs_state != emacsframe->want_fullscreen)
6575     {
6576       if (fs_state == FULLSCREEN_BOTH)
6577         {
6578           [self toggleFullScreen:self];
6579         }
6581       switch (emacsframe->want_fullscreen)
6582         {
6583         case FULLSCREEN_BOTH:
6584           [self toggleFullScreen:self];
6585           break;
6586         case FULLSCREEN_WIDTH:
6587           next_maximized = FULLSCREEN_WIDTH;
6588           if (fs_state != FULLSCREEN_BOTH)
6589             [[self window] performZoom:self];
6590           break;
6591         case FULLSCREEN_HEIGHT:
6592           next_maximized = FULLSCREEN_HEIGHT;
6593           if (fs_state != FULLSCREEN_BOTH)
6594             [[self window] performZoom:self];
6595           break;
6596         case FULLSCREEN_MAXIMIZED:
6597           next_maximized = FULLSCREEN_MAXIMIZED;
6598           if (fs_state != FULLSCREEN_BOTH)
6599             [[self window] performZoom:self];
6600           break;
6601         case FULLSCREEN_NONE:
6602           if (fs_state != FULLSCREEN_BOTH)
6603             {
6604               next_maximized = FULLSCREEN_NONE;
6605               [[self window] performZoom:self];
6606             }
6607           break;
6608         }
6610       emacsframe->want_fullscreen = FULLSCREEN_NONE;
6611     }
6615 - (void) setFSValue: (int)value
6617   Lisp_Object lval = Qnil;
6618   switch (value)
6619     {
6620     case FULLSCREEN_BOTH:
6621       lval = Qfullboth;
6622       break;
6623     case FULLSCREEN_WIDTH:
6624       lval = Qfullwidth;
6625       break;
6626     case FULLSCREEN_HEIGHT:
6627       lval = Qfullheight;
6628       break;
6629     case FULLSCREEN_MAXIMIZED:
6630       lval = Qmaximized;
6631       break;
6632     }
6633   store_frame_param (emacsframe, Qfullscreen, lval);
6634   fs_state = value;
6637 - (void)mouseEntered: (NSEvent *)theEvent
6639   NSTRACE (mouseEntered);
6640   if (emacsframe)
6641     FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6642       = EV_TIMESTAMP (theEvent);
6646 - (void)mouseExited: (NSEvent *)theEvent
6648   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
6650   NSTRACE (mouseExited);
6652   if (!hlinfo)
6653     return;
6655   FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6656     = EV_TIMESTAMP (theEvent);
6658   if (emacsframe == hlinfo->mouse_face_mouse_frame)
6659     {
6660       clear_mouse_face (hlinfo);
6661       hlinfo->mouse_face_mouse_frame = 0;
6662     }
6666 - menuDown: sender
6668   NSTRACE (menuDown);
6669   if (context_menu_value == -1)
6670     context_menu_value = [sender tag];
6671   else
6672     {
6673       NSInteger tag = [sender tag];
6674       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
6675                                     emacsframe->menu_bar_vector,
6676                                     (void *)tag);
6677     }
6679   ns_send_appdefined (-1);
6680   return self;
6684 - (EmacsToolbar *)toolbar
6686   return toolbar;
6690 /* this gets called on toolbar button click */
6691 - toolbarClicked: (id)item
6693   NSEvent *theEvent;
6694   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
6696   NSTRACE (toolbarClicked);
6698   if (!emacs_event)
6699     return self;
6701   /* send first event (for some reason two needed) */
6702   theEvent = [[self window] currentEvent];
6703   emacs_event->kind = TOOL_BAR_EVENT;
6704   XSETFRAME (emacs_event->arg, emacsframe);
6705   EV_TRAILER (theEvent);
6707   emacs_event->kind = TOOL_BAR_EVENT;
6708 /*   XSETINT (emacs_event->code, 0); */
6709   emacs_event->arg = AREF (emacsframe->tool_bar_items,
6710                            idx + TOOL_BAR_ITEM_KEY);
6711   emacs_event->modifiers = EV_MODIFIERS (theEvent);
6712   EV_TRAILER (theEvent);
6713   return self;
6717 - toggleToolbar: (id)sender
6719   if (!emacs_event)
6720     return self;
6722   emacs_event->kind = NS_NONKEY_EVENT;
6723   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
6724   EV_TRAILER ((id)nil);
6725   return self;
6729 - (void)drawRect: (NSRect)rect
6731   int x = NSMinX (rect), y = NSMinY (rect);
6732   int width = NSWidth (rect), height = NSHeight (rect);
6734   NSTRACE (drawRect);
6736   if (!emacsframe || !emacsframe->output_data.ns)
6737     return;
6739   ns_clear_frame_area (emacsframe, x, y, width, height);
6740   expose_frame (emacsframe, x, y, width, height);
6742   /*
6743     drawRect: may be called (at least in OS X 10.5) for invisible
6744     views as well for some reason.  Thus, do not infer visibility
6745     here.
6747     emacsframe->async_visible = 1;
6748     emacsframe->async_iconified = 0;
6749   */
6753 /* NSDraggingDestination protocol methods.  Actually this is not really a
6754    protocol, but a category of Object.  O well...  */
6756 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
6758   NSTRACE (draggingEntered);
6759   return NSDragOperationGeneric;
6763 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
6765   return YES;
6769 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
6771   id pb;
6772   int x, y;
6773   NSString *type;
6774   NSEvent *theEvent = [[self window] currentEvent];
6775   NSPoint position;
6776   NSDragOperation op = [sender draggingSourceOperationMask];
6777   int modifiers = 0;
6779   NSTRACE (performDragOperation);
6781   if (!emacs_event)
6782     return NO;
6784   position = [self convertPoint: [sender draggingLocation] fromView: nil];
6785   x = lrint (position.x);  y = lrint (position.y);
6787   pb = [sender draggingPasteboard];
6788   type = [pb availableTypeFromArray: ns_drag_types];
6790   if (! (op & (NSDragOperationMove|NSDragOperationDelete)) &&
6791       // URL drags contain all operations (0xf), don't allow all to be set.
6792       (op & 0xf) != 0xf)
6793     {
6794       if (op & NSDragOperationLink)
6795         modifiers |= NSControlKeyMask;
6796       if (op & NSDragOperationCopy)
6797         modifiers |= NSAlternateKeyMask;
6798       if (op & NSDragOperationGeneric)
6799         modifiers |= NSCommandKeyMask;
6800     }
6802   modifiers = EV_MODIFIERS2 (modifiers);
6803   if (type == 0)
6804     {
6805       return NO;
6806     }
6807   else if ([type isEqualToString: NSFilenamesPboardType])
6808     {
6809       NSArray *files;
6810       NSEnumerator *fenum;
6811       NSString *file;
6813       if (!(files = [pb propertyListForType: type]))
6814         return NO;
6816       fenum = [files objectEnumerator];
6817       while ( (file = [fenum nextObject]) )
6818         {
6819           emacs_event->kind = DRAG_N_DROP_EVENT;
6820           XSETINT (emacs_event->x, x);
6821           XSETINT (emacs_event->y, y);
6822           ns_input_file = append2 (ns_input_file,
6823                                    build_string ([file UTF8String]));
6824           emacs_event->modifiers = modifiers;
6825           emacs_event->arg =  list2 (Qfile, build_string ([file UTF8String]));
6826           EV_TRAILER (theEvent);
6827         }
6828       return YES;
6829     }
6830   else if ([type isEqualToString: NSURLPboardType])
6831     {
6832       NSURL *url = [NSURL URLFromPasteboard: pb];
6833       if (url == nil) return NO;
6835       emacs_event->kind = DRAG_N_DROP_EVENT;
6836       XSETINT (emacs_event->x, x);
6837       XSETINT (emacs_event->y, y);
6838       emacs_event->modifiers = modifiers;
6839       emacs_event->arg =  list2 (Qurl,
6840                                  build_string ([[url absoluteString]
6841                                                  UTF8String]));
6842       EV_TRAILER (theEvent);
6844       if ([url isFileURL] != NO)
6845         {
6846           NSString *file = [url path];
6847           ns_input_file = append2 (ns_input_file,
6848                                    build_string ([file UTF8String]));
6849         }
6850       return YES;
6851     }
6852   else if ([type isEqualToString: NSStringPboardType]
6853            || [type isEqualToString: NSTabularTextPboardType])
6854     {
6855       NSString *data;
6857       if (! (data = [pb stringForType: type]))
6858         return NO;
6860       emacs_event->kind = DRAG_N_DROP_EVENT;
6861       XSETINT (emacs_event->x, x);
6862       XSETINT (emacs_event->y, y);
6863       emacs_event->modifiers = modifiers;
6864       emacs_event->arg =  list2 (Qnil, build_string ([data UTF8String]));
6865       EV_TRAILER (theEvent);
6866       return YES;
6867     }
6868   else
6869     {
6870       error ("Invalid data type in dragging pasteboard");
6871       return NO;
6872     }
6876 - (id) validRequestorForSendType: (NSString *)typeSent
6877                       returnType: (NSString *)typeReturned
6879   NSTRACE (validRequestorForSendType);
6880   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
6881       && typeReturned == nil)
6882     {
6883       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
6884         return self;
6885     }
6887   return [super validRequestorForSendType: typeSent
6888                                returnType: typeReturned];
6892 /* The next two methods are part of NSServicesRequests informal protocol,
6893    supposedly called when a services menu item is chosen from this app.
6894    But this should not happen because we override the services menu with our
6895    own entries which call ns-perform-service.
6896    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
6897    So let's at least stub them out until further investigation can be done. */
6899 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
6901   /* we could call ns_string_from_pasteboard(pboard) here but then it should
6902      be written into the buffer in place of the existing selection..
6903      ordinary service calls go through functions defined in ns-win.el */
6904   return NO;
6907 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
6909   NSArray *typesDeclared;
6910   Lisp_Object val;
6912   /* We only support NSStringPboardType */
6913   if ([types containsObject:NSStringPboardType] == NO) {
6914     return NO;
6915   }
6917   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6918   if (CONSP (val) && SYMBOLP (XCAR (val)))
6919     {
6920       val = XCDR (val);
6921       if (CONSP (val) && NILP (XCDR (val)))
6922         val = XCAR (val);
6923     }
6924   if (! STRINGP (val))
6925     return NO;
6927   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
6928   [pb declareTypes:typesDeclared owner:nil];
6929   ns_string_to_pasteboard (pb, val);
6930   return YES;
6934 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
6935    (gives a miniaturized version of the window); currently we use the latter for
6936    frames whose active buffer doesn't correspond to any file
6937    (e.g., '*scratch*') */
6938 - setMiniwindowImage: (BOOL) setMini
6940   id image = [[self window] miniwindowImage];
6941   NSTRACE (setMiniwindowImage);
6943   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
6944      about "AppleDockIconEnabled" notwithstanding, however the set message
6945      below has its effect nonetheless. */
6946   if (image != emacsframe->output_data.ns->miniimage)
6947     {
6948       if (image && [image isKindOfClass: [EmacsImage class]])
6949         [image release];
6950       [[self window] setMiniwindowImage:
6951                        setMini ? emacsframe->output_data.ns->miniimage : nil];
6952     }
6954   return self;
6958 - (void) setRows: (int) r andColumns: (int) c
6960   rows = r;
6961   cols = c;
6964 @end  /* EmacsView */
6968 /* ==========================================================================
6970     EmacsWindow implementation
6972    ========================================================================== */
6974 @implementation EmacsWindow
6976 #ifdef NS_IMPL_COCOA
6977 - (id)accessibilityAttributeValue:(NSString *)attribute
6979   Lisp_Object str = Qnil;
6980   struct frame *f = SELECTED_FRAME ();
6981   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->contents);
6983   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
6984     return NSAccessibilityTextFieldRole;
6986   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
6987       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
6988     {
6989       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6990     }
6991   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
6992     {
6993       if (! NILP (BVAR (curbuf, mark_active)))
6994           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6996       if (NILP (str))
6997         {
6998           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
6999           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
7000           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
7002           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
7003             str = make_uninit_multibyte_string (range, byte_range);
7004           else
7005             str = make_uninit_string (range);
7006           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
7007              Is this a problem?  */
7008           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
7009         }
7010     }
7013   if (! NILP (str))
7014     {
7015       if (CONSP (str) && SYMBOLP (XCAR (str)))
7016         {
7017           str = XCDR (str);
7018           if (CONSP (str) && NILP (XCDR (str)))
7019             str = XCAR (str);
7020         }
7021       if (STRINGP (str))
7022         {
7023           const char *utfStr = SSDATA (str);
7024           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
7025           return nsStr;
7026         }
7027     }
7029   return [super accessibilityAttributeValue:attribute];
7031 #endif /* NS_IMPL_COCOA */
7033 /* If we have multiple monitors, one above the other, we don't want to
7034    restrict the height to just one monitor.  So we override this.  */
7035 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
7037   /* When making the frame visible for the first time or if there is just
7038      one screen, we want to constrain.  Other times not.  */
7039   NSArray *screens = [NSScreen screens];
7040   NSUInteger nr_screens = [screens count], nr_eff_screens = 0, i;
7041   struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
7042   NSTRACE (constrainFrameRect);
7043   NSTRACE_RECT ("input", frameRect);
7045   if (ns_menu_bar_should_be_hidden ())
7046     return frameRect;
7048   if (nr_screens == 1)
7049     return [super constrainFrameRect:frameRect toScreen:screen];
7051 #ifdef NS_IMPL_COCOA
7052 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
7053   // If separate spaces is on, it is like each screen is independent.  There is
7054   // no spanning of frames across screens.
7055   if ([NSScreen screensHaveSeparateSpaces])
7056     return [super constrainFrameRect:frameRect toScreen:screen];
7057 #endif
7058 #endif
7060   for (i = 0; i < nr_screens; ++i) 
7061     {
7062       NSScreen *s = [screens objectAtIndex: i];
7063       NSRect scrrect = [s frame];
7064       NSRect intersect = NSIntersectionRect (frameRect, scrrect);
7066       if (intersect.size.width > 0 || intersect.size.height > 0)
7067         ++nr_eff_screens;
7068     }
7070   if (nr_eff_screens == 1)
7071     return [super constrainFrameRect:frameRect toScreen:screen];
7073   /* The default implementation does two things 1) ensure that the top
7074      of the rectangle is below the menu bar (or below the top of the
7075      screen) and 2) resizes windows larger than the screen. As we
7076      don't want the latter, a smaller rectangle is used. */
7077 #define FAKE_HEIGHT 64
7078   float old_top = frameRect.origin.y + frameRect.size.height;
7079   NSRect r;
7080   r.size.height = FAKE_HEIGHT;
7081   r.size.width = frameRect.size.width;
7082   r.origin.x = frameRect.origin.x;
7083   r.origin.y = old_top - FAKE_HEIGHT;
7085   NSTRACE_RECT ("input to super", r);
7087   r = [super constrainFrameRect:r toScreen:screen];
7089   NSTRACE_RECT ("output from super", r);
7091   float new_top = r.origin.y + FAKE_HEIGHT;
7092   if (new_top < old_top)
7093   {
7094     frameRect.origin.y = new_top - frameRect.size.height;
7095   }
7097   NSTRACE_RECT ("output", frameRect);
7099   return frameRect;
7100 #undef FAKE_HEIGHT
7103 @end /* EmacsWindow */
7106 @implementation EmacsFSWindow
7108 - (BOOL)canBecomeKeyWindow
7110   return YES;
7113 - (BOOL)canBecomeMainWindow
7115   return YES;
7118 @end
7120 /* ==========================================================================
7122     EmacsScroller implementation
7124    ========================================================================== */
7127 @implementation EmacsScroller
7129 /* for repeat button push */
7130 #define SCROLL_BAR_FIRST_DELAY 0.5
7131 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
7133 + (CGFloat) scrollerWidth
7135   /* TODO: if we want to allow variable widths, this is the place to do it,
7136            however neither GNUstep nor Cocoa support it very well */
7137   return [NSScroller scrollerWidth];
7141 - initFrame: (NSRect )r window: (Lisp_Object)nwin
7143   NSTRACE (EmacsScroller_initFrame);
7145   r.size.width = [EmacsScroller scrollerWidth];
7146   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
7147   [self setContinuous: YES];
7148   [self setEnabled: YES];
7150   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
7151      locked against the top and bottom edges, and right edge on OS X, where
7152      scrollers are on right. */
7153 #ifdef NS_IMPL_GNUSTEP
7154   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
7155 #else
7156   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
7157 #endif
7159   win = nwin;
7160   condemned = NO;
7161   pixel_height = NSHeight (r);
7162   if (pixel_height == 0) pixel_height = 1;
7163   min_portion = 20 / pixel_height;
7165   frame = XFRAME (XWINDOW (win)->frame);
7166   if (FRAME_LIVE_P (frame))
7167     {
7168       int i;
7169       EmacsView *view = FRAME_NS_VIEW (frame);
7170       NSView *sview = [[view window] contentView];
7171       NSArray *subs = [sview subviews];
7173       /* disable optimization stopping redraw of other scrollbars */
7174       view->scrollbarsNeedingUpdate = 0;
7175       for (i =[subs count]-1; i >= 0; i--)
7176         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
7177           view->scrollbarsNeedingUpdate++;
7178       [sview addSubview: self];
7179     }
7181 /*  [self setFrame: r]; */
7183   return self;
7187 - (void)setFrame: (NSRect)newRect
7189   NSTRACE (EmacsScroller_setFrame);
7190 /*  block_input (); */
7191   pixel_height = NSHeight (newRect);
7192   if (pixel_height == 0) pixel_height = 1;
7193   min_portion = 20 / pixel_height;
7194   [super setFrame: newRect];
7195   [self display];
7196 /*  unblock_input (); */
7200 - condemn
7202   NSTRACE (condemn);
7203   condemned =YES;
7204   return self;
7208 - reprieve
7210   NSTRACE (reprieve);
7211   condemned =NO;
7212   return self;
7216 - judge
7218   NSTRACE (judge);
7219   if (condemned)
7220     {
7221       EmacsView *view;
7222       block_input ();
7223       /* ensure other scrollbar updates after deletion */
7224       view = (EmacsView *)FRAME_NS_VIEW (frame);
7225       if (view != nil)
7226         view->scrollbarsNeedingUpdate++;
7227       if (!NILP (win))
7228         wset_vertical_scroll_bar (XWINDOW (win), Qnil);
7229       win = Qnil;
7230       [self removeFromSuperview];
7231       [self release];
7232       unblock_input ();
7233     }
7234   return self;
7238 - (void)resetCursorRects
7240   NSRect visible = [self visibleRect];
7241   NSTRACE (resetCursorRects);
7243   if (!NSIsEmptyRect (visible))
7244     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
7245   [[NSCursor arrowCursor] setOnMouseEntered: YES];
7249 - (int) checkSamePosition: (int) position portion: (int) portion
7250                     whole: (int) whole
7252   return em_position ==position && em_portion ==portion && em_whole ==whole
7253     && portion != whole; /* needed for resize empty buf */
7257 - setPosition: (int)position portion: (int)portion whole: (int)whole
7259   NSTRACE (setPosition);
7261   em_position = position;
7262   em_portion = portion;
7263   em_whole = whole;
7265   if (portion >= whole)
7266     {
7267 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7268       [self setKnobProportion: 1.0];
7269       [self setDoubleValue: 1.0];
7270 #else
7271       [self setFloatValue: 0.0 knobProportion: 1.0];
7272 #endif
7273     }
7274   else
7275     {
7276       float pos;
7277       CGFloat por;
7278       portion = max ((float)whole*min_portion/pixel_height, portion);
7279       pos = (float)position / (whole - portion);
7280       por = (CGFloat)portion/whole;
7281 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7282       [self setKnobProportion: por];
7283       [self setDoubleValue: pos];
7284 #else
7285       [self setFloatValue: pos knobProportion: por];
7286 #endif
7287     }
7289   /* Events may come here even if the event loop is not running.
7290      If we don't enter the event loop, the scroll bar will not update.
7291      So send SIGIO to ourselves.  */
7292   if (apploopnr == 0) raise (SIGIO);
7294   return self;
7297 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
7298      drag events will go directly to the EmacsScroller.  Leaving in for now. */
7299 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
7300                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
7302   *part = last_hit_part;
7303   *window = win;
7304   XSETINT (*y, pixel_height);
7305   if ([self floatValue] > 0.999F)
7306     XSETINT (*x, pixel_height);
7307   else
7308     XSETINT (*x, pixel_height * [self floatValue]);
7312 /* set up emacs_event */
7313 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
7315   if (!emacs_event)
7316     return;
7318   emacs_event->part = last_hit_part;
7319   emacs_event->code = 0;
7320   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
7321   emacs_event->frame_or_window = win;
7322   emacs_event->timestamp = EV_TIMESTAMP (e);
7323   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
7324   emacs_event->arg = Qnil;
7325   XSETINT (emacs_event->x, loc * pixel_height);
7326   XSETINT (emacs_event->y, pixel_height-20);
7328   if (q_event_ptr)
7329     {
7330       n_emacs_events_pending++;
7331       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
7332     }
7333   else
7334     hold_event (emacs_event);
7335   EVENT_INIT (*emacs_event);
7336   ns_send_appdefined (-1);
7340 /* called manually thru timer to implement repeated button action w/hold-down */
7341 - repeatScroll: (NSTimer *)scrollEntry
7343   NSEvent *e = [[self window] currentEvent];
7344   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
7345   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
7347   /* clear timer if need be */
7348   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
7349     {
7350         [scroll_repeat_entry invalidate];
7351         [scroll_repeat_entry release];
7352         scroll_repeat_entry = nil;
7354         if (inKnob)
7355           return self;
7357         scroll_repeat_entry
7358           = [[NSTimer scheduledTimerWithTimeInterval:
7359                         SCROLL_BAR_CONTINUOUS_DELAY
7360                                             target: self
7361                                           selector: @selector (repeatScroll:)
7362                                           userInfo: 0
7363                                            repeats: YES]
7364               retain];
7365     }
7367   [self sendScrollEventAtLoc: 0 fromEvent: e];
7368   return self;
7372 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
7373    mouseDragged events without going into a modal loop. */
7374 - (void)mouseDown: (NSEvent *)e
7376   NSRect sr, kr;
7377   /* hitPart is only updated AFTER event is passed on */
7378   NSScrollerPart part = [self testPart: [e locationInWindow]];
7379   CGFloat inc = 0.0, loc, kloc, pos;
7380   int edge = 0;
7382   NSTRACE (EmacsScroller_mouseDown);
7384   switch (part)
7385     {
7386     case NSScrollerDecrementPage:
7387         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
7388     case NSScrollerIncrementPage:
7389         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
7390     case NSScrollerDecrementLine:
7391       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
7392     case NSScrollerIncrementLine:
7393       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
7394     case NSScrollerKnob:
7395       last_hit_part = scroll_bar_handle; break;
7396     case NSScrollerKnobSlot:  /* GNUstep-only */
7397       last_hit_part = scroll_bar_move_ratio; break;
7398     default:  /* NSScrollerNoPart? */
7399       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
7400                (long) part);
7401       return;
7402     }
7404   if (inc != 0.0)
7405     {
7406       pos = 0;      /* ignored */
7408       /* set a timer to repeat, as we can't let superclass do this modally */
7409       scroll_repeat_entry
7410         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
7411                                             target: self
7412                                           selector: @selector (repeatScroll:)
7413                                           userInfo: 0
7414                                            repeats: YES]
7415             retain];
7416     }
7417   else
7418     {
7419       /* handle, or on GNUstep possibly slot */
7420       NSEvent *fake_event;
7422       /* compute float loc in slot and mouse offset on knob */
7423       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7424                       toView: nil];
7425       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7426       if (loc <= 0.0)
7427         {
7428           loc = 0.0;
7429           edge = -1;
7430         }
7431       else if (loc >= NSHeight (sr))
7432         {
7433           loc = NSHeight (sr);
7434           edge = 1;
7435         }
7437       if (edge)
7438         kloc = 0.5 * edge;
7439       else
7440         {
7441           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
7442                           toView: nil];
7443           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
7444         }
7445       last_mouse_offset = kloc;
7447       /* if knob, tell emacs a location offset by knob pos
7448          (to indicate top of handle) */
7449       if (part == NSScrollerKnob)
7450           pos = (loc - last_mouse_offset) / NSHeight (sr);
7451       else
7452         /* else this is a slot click on GNUstep: go straight there */
7453         pos = loc / NSHeight (sr);
7455       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
7456       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
7457                                       location: [e locationInWindow]
7458                                  modifierFlags: [e modifierFlags]
7459                                      timestamp: [e timestamp]
7460                                   windowNumber: [e windowNumber]
7461                                        context: [e context]
7462                                    eventNumber: [e eventNumber]
7463                                     clickCount: [e clickCount]
7464                                       pressure: [e pressure]];
7465       [super mouseUp: fake_event];
7466     }
7468   if (part != NSScrollerKnob)
7469     [self sendScrollEventAtLoc: pos fromEvent: e];
7473 /* Called as we manually track scroller drags, rather than superclass. */
7474 - (void)mouseDragged: (NSEvent *)e
7476     NSRect sr;
7477     double loc, pos;
7479     NSTRACE (EmacsScroller_mouseDragged);
7481       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7482                       toView: nil];
7483       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7485       if (loc <= 0.0)
7486         {
7487           loc = 0.0;
7488         }
7489       else if (loc >= NSHeight (sr) + last_mouse_offset)
7490         {
7491           loc = NSHeight (sr) + last_mouse_offset;
7492         }
7494       pos = (loc - last_mouse_offset) / NSHeight (sr);
7495       [self sendScrollEventAtLoc: pos fromEvent: e];
7499 - (void)mouseUp: (NSEvent *)e
7501   if (scroll_repeat_entry)
7502     {
7503       [scroll_repeat_entry invalidate];
7504       [scroll_repeat_entry release];
7505       scroll_repeat_entry = nil;
7506     }
7507   last_hit_part = scroll_bar_above_handle;
7511 /* treat scrollwheel events in the bar as though they were in the main window */
7512 - (void) scrollWheel: (NSEvent *)theEvent
7514   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
7515   [view mouseDown: theEvent];
7518 @end  /* EmacsScroller */
7521 #ifdef NS_IMPL_GNUSTEP
7522 /* Dummy class to get rid of startup warnings.  */
7523 @implementation EmacsDocument
7525 @end
7526 #endif
7529 /* ==========================================================================
7531    Font-related functions; these used to be in nsfaces.m
7533    ========================================================================== */
7536 Lisp_Object
7537 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7539   struct font *font = XFONT_OBJECT (font_object);
7540   EmacsView *view = FRAME_NS_VIEW (f);
7542   if (fontset < 0)
7543     fontset = fontset_from_font (font_object);
7544   FRAME_FONTSET (f) = fontset;
7546   if (FRAME_FONT (f) == font)
7547     /* This font is already set in frame F.  There's nothing more to
7548        do.  */
7549     return font_object;
7551   FRAME_FONT (f) = font;
7553   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7554   FRAME_COLUMN_WIDTH (f) = font->average_width;
7555   FRAME_LINE_HEIGHT (f) = font->height;
7557   /* Compute the scroll bar width in character columns.  */
7558   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7559     {
7560       int wid = FRAME_COLUMN_WIDTH (f);
7561       FRAME_CONFIG_SCROLL_BAR_COLS (f)
7562         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
7563     }
7564   else
7565     {
7566       int wid = FRAME_COLUMN_WIDTH (f);
7567       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7568     }
7570   /* Compute the scroll bar height in character lines.  */
7571   if (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0)
7572     {
7573       int height = FRAME_LINE_HEIGHT (f);
7574       FRAME_CONFIG_SCROLL_BAR_LINES (f)
7575         = (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) + height - 1) / height;
7576     }
7577   else
7578     {
7579       int height = FRAME_LINE_HEIGHT (f);
7580       FRAME_CONFIG_SCROLL_BAR_LINES (f) = (14 + height - 1) / height;
7581     }
7583   /* Now make the frame display the given font.  */
7584   if (FRAME_NS_WINDOW (f) != 0 && ! [view isFullscreen])
7585     x_set_window_size (f, 0, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
7586                        FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1);
7588   return font_object;
7592 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
7593 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
7594          in 1.43. */
7596 const char *
7597 ns_xlfd_to_fontname (const char *xlfd)
7598 /* --------------------------------------------------------------------------
7599     Convert an X font name (XLFD) to an NS font name.
7600     Only family is used.
7601     The string returned is temporarily allocated.
7602    -------------------------------------------------------------------------- */
7604   char *name = xmalloc (180);
7605   int i, len;
7606   const char *ret;
7608   if (!strncmp (xlfd, "--", 2))
7609     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
7610   else
7611     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
7613   /* stopgap for malformed XLFD input */
7614   if (strlen (name) == 0)
7615     strcpy (name, "Monaco");
7617   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
7618      also uppercase after '-' or ' ' */
7619   name[0] = c_toupper (name[0]);
7620   for (len =strlen (name), i =0; i<len; i++)
7621     {
7622       if (name[i] == '$')
7623         {
7624           name[i] = '-';
7625           if (i+1<len)
7626             name[i+1] = c_toupper (name[i+1]);
7627         }
7628       else if (name[i] == '_')
7629         {
7630           name[i] = ' ';
7631           if (i+1<len)
7632             name[i+1] = c_toupper (name[i+1]);
7633         }
7634     }
7635 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
7636   ret = [[NSString stringWithUTF8String: name] UTF8String];
7637   xfree (name);
7638   return ret;
7642 void
7643 syms_of_nsterm (void)
7645   NSTRACE (syms_of_nsterm);
7647   ns_antialias_threshold = 10.0;
7649   /* from 23+ we need to tell emacs what modifiers there are.. */
7650   DEFSYM (Qmodifier_value, "modifier-value");
7651   DEFSYM (Qalt, "alt");
7652   DEFSYM (Qhyper, "hyper");
7653   DEFSYM (Qmeta, "meta");
7654   DEFSYM (Qsuper, "super");
7655   DEFSYM (Qcontrol, "control");
7656   DEFSYM (QUTF8_STRING, "UTF8_STRING");
7658   DEFSYM (Qfile, "file");
7659   DEFSYM (Qurl, "url");
7661   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
7662   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
7663   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
7664   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
7665   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
7667   DEFVAR_LISP ("ns-input-file", ns_input_file,
7668               "The file specified in the last NS event.");
7669   ns_input_file =Qnil;
7671   DEFVAR_LISP ("ns-working-text", ns_working_text,
7672               "String for visualizing working composition sequence.");
7673   ns_working_text =Qnil;
7675   DEFVAR_LISP ("ns-input-font", ns_input_font,
7676               "The font specified in the last NS event.");
7677   ns_input_font =Qnil;
7679   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
7680               "The fontsize specified in the last NS event.");
7681   ns_input_fontsize =Qnil;
7683   DEFVAR_LISP ("ns-input-line", ns_input_line,
7684                "The line specified in the last NS event.");
7685   ns_input_line =Qnil;
7687   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
7688                "The service name specified in the last NS event.");
7689   ns_input_spi_name =Qnil;
7691   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
7692                "The service argument specified in the last NS event.");
7693   ns_input_spi_arg =Qnil;
7695   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
7696                "This variable describes the behavior of the alternate or option key.\n\
7697 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7698 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7699 at all, allowing it to be used at a lower level for accented character entry.");
7700   ns_alternate_modifier = Qmeta;
7702   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
7703                "This variable describes the behavior of the right alternate or option key.\n\
7704 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7705 Set to left means be the same key as `ns-alternate-modifier'.\n\
7706 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7707 at all, allowing it to be used at a lower level for accented character entry.");
7708   ns_right_alternate_modifier = Qleft;
7710   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
7711                "This variable describes the behavior of the command key.\n\
7712 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7713   ns_command_modifier = Qsuper;
7715   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
7716                "This variable describes the behavior of the right command key.\n\
7717 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7718 Set to left means be the same key as `ns-command-modifier'.\n\
7719 Set to none means that the command / 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_right_command_modifier = Qleft;
7723   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
7724                "This variable describes the behavior of the control key.\n\
7725 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7726   ns_control_modifier = Qcontrol;
7728   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
7729                "This variable describes the behavior of the right control key.\n\
7730 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7731 Set to left means be the same key as `ns-control-modifier'.\n\
7732 Set to none means that the control / option key is not interpreted by Emacs\n\
7733 at all, allowing it to be used at a lower level for accented character entry.");
7734   ns_right_control_modifier = Qleft;
7736   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
7737                "This variable describes the behavior of the function key (on laptops).\n\
7738 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7739 Set to none means that the function key is not interpreted by Emacs at all,\n\
7740 allowing it to be used at a lower level for accented character entry.");
7741   ns_function_modifier = Qnone;
7743   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
7744                "Non-nil (the default) means to render text antialiased.");
7745   ns_antialias_text = Qt;
7747   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
7748                "Whether to confirm application quit using dialog.");
7749   ns_confirm_quit = Qnil;
7751   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
7752                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
7753 Only works on OSX 10.6 or later.  */);
7754   ns_auto_hide_menu_bar = Qnil;
7756   DEFVAR_BOOL ("ns-use-native-fullscreen", ns_use_native_fullscreen,
7757      doc: /*Non-nil means to use native fullscreen on OSX >= 10.7.
7758 Nil means use fullscreen the old (< 10.7) way.  The old way works better with
7759 multiple monitors, but lacks tool bar.  This variable is ignored on OSX < 10.7.
7760 Default is t for OSX >= 10.7, nil otherwise.  */);
7761 #ifdef HAVE_NATIVE_FS
7762   ns_use_native_fullscreen = YES;
7763 #else
7764   ns_use_native_fullscreen = NO;
7765 #endif
7766   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
7768   DEFVAR_BOOL ("ns-use-srgb-colorspace", ns_use_srgb_colorspace,
7769      doc: /*Non-nil means to use sRGB colorspace on OSX >= 10.7.
7770 Note that this does not apply to images.
7771 This variable is ignored on OSX < 10.7 and GNUstep.  */);
7772   ns_use_srgb_colorspace = YES;
7774   /* TODO: move to common code */
7775   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
7776                doc: /* Which toolkit scroll bars Emacs uses, if any.
7777 A value of nil means Emacs doesn't use toolkit scroll bars.
7778 With the X Window system, the value is a symbol describing the
7779 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
7780 With MS Windows or Nextstep, the value is t.  */);
7781   Vx_toolkit_scroll_bars = Qt;
7783   DEFVAR_BOOL ("x-use-underline-position-properties",
7784                x_use_underline_position_properties,
7785      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
7786 A value of nil means ignore them.  If you encounter fonts with bogus
7787 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
7788 to 4.1, set this to nil. */);
7789   x_use_underline_position_properties = 0;
7791   DEFVAR_BOOL ("x-underline-at-descent-line",
7792                x_underline_at_descent_line,
7793      doc: /* Non-nil means to draw the underline at the same place as the descent line.
7794 A value of nil means to draw the underline according to the value of the
7795 variable `x-use-underline-position-properties', which is usually at the
7796 baseline level.  The default value is nil.  */);
7797   x_underline_at_descent_line = 0;
7799   /* Tell Emacs about this window system.  */
7800   Fprovide (Qns, Qnil);
7802   DEFSYM (Qcocoa, "cocoa");
7803   DEFSYM (Qgnustep, "gnustep");
7805   syms_of_nsfont ();
7806 #ifdef NS_IMPL_COCOA
7807   Fprovide (Qcocoa, Qnil);
7808 #if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
7809   syms_of_macfont ();
7810 #endif
7811 #else
7812   Fprovide (Qgnustep, Qnil);
7813 #endif