Fix display of composite characters with large fonts
[emacs.git] / src / nsterm.m
blob67a03898d13952dc161c6bc3625cf8692a80ae76
1 /* NeXT/Open/GNUstep / MacOSX communication module.
3 Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2015 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 #include "macfont.h"
69 #endif
71 /* call tracing */
72 #if 0
73 int term_trace_num = 0;
74 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
75                                 __FILE__, __LINE__, ++term_trace_num)
76 #else
77 #define NSTRACE(x)
78 #endif
80 /* Detailed tracing. "S" means "size" and "LL" stands for "lower left". */
81 #if 0
82 int term_trace_num = 0;
83 #define NSTRACE_SIZE(str,size) fprintf (stderr,                         \
84                                    "%s:%d: [%d]   " str                 \
85                                    " (S:%.0f x %.0f)\n", \
86                                    __FILE__, __LINE__, ++term_trace_num,\
87                                    size.height,                       \
88                                    size.width)
89 #define NSTRACE_RECT(s,r) fprintf (stderr,                              \
90                                    "%s:%d: [%d]   " s                   \
91                                    " (LL:%.0f x %.0f -> S:%.0f x %.0f)\n", \
92                                    __FILE__, __LINE__, ++term_trace_num,\
93                                    r.origin.x,                          \
94                                    r.origin.y,                          \
95                                    r.size.height,                       \
96                                    r.size.width)
97 #else
98 #define NSTRACE_SIZE(str,size)
99 #define NSTRACE_RECT(s,r)
100 #endif
102 extern NSString *NSMenuDidBeginTrackingNotification;
104 /* ==========================================================================
106    NSColor, EmacsColor category.
108    ========================================================================== */
109 @implementation NSColor (EmacsColor)
110 + (NSColor *)colorForEmacsRed:(CGFloat)red green:(CGFloat)green
111                          blue:(CGFloat)blue alpha:(CGFloat)alpha
113 #ifdef NS_IMPL_COCOA
114 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
115   if (ns_use_srgb_colorspace)
116       return [NSColor colorWithSRGBRed: red
117                                  green: green
118                                   blue: blue
119                                  alpha: alpha];
120 #endif
121 #endif
122   return [NSColor colorWithCalibratedRed: red
123                                    green: green
124                                     blue: blue
125                                    alpha: alpha];
128 - (NSColor *)colorUsingDefaultColorSpace
130 #ifdef NS_IMPL_COCOA
131 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
132   if (ns_use_srgb_colorspace)
133     return [self colorUsingColorSpace: [NSColorSpace sRGBColorSpace]];
134 #endif
135 #endif
136   return [self colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
139 @end
141 /* ==========================================================================
143     Local declarations
145    ========================================================================== */
147 /* Convert a symbol indexed with an NSxxx value to a value as defined
148    in keyboard.c (lispy_function_key). I hope this is a correct way
149    of doing things... */
150 static unsigned convert_ns_to_X_keysym[] =
152   NSHomeFunctionKey,            0x50,
153   NSLeftArrowFunctionKey,       0x51,
154   NSUpArrowFunctionKey,         0x52,
155   NSRightArrowFunctionKey,      0x53,
156   NSDownArrowFunctionKey,       0x54,
157   NSPageUpFunctionKey,          0x55,
158   NSPageDownFunctionKey,        0x56,
159   NSEndFunctionKey,             0x57,
160   NSBeginFunctionKey,           0x58,
161   NSSelectFunctionKey,          0x60,
162   NSPrintFunctionKey,           0x61,
163   NSClearLineFunctionKey,       0x0B,
164   NSExecuteFunctionKey,         0x62,
165   NSInsertFunctionKey,          0x63,
166   NSUndoFunctionKey,            0x65,
167   NSRedoFunctionKey,            0x66,
168   NSMenuFunctionKey,            0x67,
169   NSFindFunctionKey,            0x68,
170   NSHelpFunctionKey,            0x6A,
171   NSBreakFunctionKey,           0x6B,
173   NSF1FunctionKey,              0xBE,
174   NSF2FunctionKey,              0xBF,
175   NSF3FunctionKey,              0xC0,
176   NSF4FunctionKey,              0xC1,
177   NSF5FunctionKey,              0xC2,
178   NSF6FunctionKey,              0xC3,
179   NSF7FunctionKey,              0xC4,
180   NSF8FunctionKey,              0xC5,
181   NSF9FunctionKey,              0xC6,
182   NSF10FunctionKey,             0xC7,
183   NSF11FunctionKey,             0xC8,
184   NSF12FunctionKey,             0xC9,
185   NSF13FunctionKey,             0xCA,
186   NSF14FunctionKey,             0xCB,
187   NSF15FunctionKey,             0xCC,
188   NSF16FunctionKey,             0xCD,
189   NSF17FunctionKey,             0xCE,
190   NSF18FunctionKey,             0xCF,
191   NSF19FunctionKey,             0xD0,
192   NSF20FunctionKey,             0xD1,
193   NSF21FunctionKey,             0xD2,
194   NSF22FunctionKey,             0xD3,
195   NSF23FunctionKey,             0xD4,
196   NSF24FunctionKey,             0xD5,
198   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
199   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
200   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
202   NSTabCharacter,               0x09,
203   0x19,                         0x09,  /* left tab->regular since pass shift */
204   NSCarriageReturnCharacter,    0x0D,
205   NSNewlineCharacter,           0x0D,
206   NSEnterCharacter,             0x8D,
208   0x41|NSNumericPadKeyMask,     0xAE,  /* KP_Decimal */
209   0x43|NSNumericPadKeyMask,     0xAA,  /* KP_Multiply */
210   0x45|NSNumericPadKeyMask,     0xAB,  /* KP_Add */
211   0x4B|NSNumericPadKeyMask,     0xAF,  /* KP_Divide */
212   0x4E|NSNumericPadKeyMask,     0xAD,  /* KP_Subtract */
213   0x51|NSNumericPadKeyMask,     0xBD,  /* KP_Equal */
214   0x52|NSNumericPadKeyMask,     0xB0,  /* KP_0 */
215   0x53|NSNumericPadKeyMask,     0xB1,  /* KP_1 */
216   0x54|NSNumericPadKeyMask,     0xB2,  /* KP_2 */
217   0x55|NSNumericPadKeyMask,     0xB3,  /* KP_3 */
218   0x56|NSNumericPadKeyMask,     0xB4,  /* KP_4 */
219   0x57|NSNumericPadKeyMask,     0xB5,  /* KP_5 */
220   0x58|NSNumericPadKeyMask,     0xB6,  /* KP_6 */
221   0x59|NSNumericPadKeyMask,     0xB7,  /* KP_7 */
222   0x5B|NSNumericPadKeyMask,     0xB8,  /* KP_8 */
223   0x5C|NSNumericPadKeyMask,     0xB9,  /* KP_9 */
225   0x1B,                         0x1B   /* escape */
228 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
229    the maximum font size to NOT antialias.  On GNUstep there is currently
230    no way to control this behavior. */
231 float ns_antialias_threshold;
233 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
234 NSString *ns_app_name = @"Emacs";  /* default changed later */
236 /* Display variables */
237 struct ns_display_info *x_display_list; /* Chain of existing displays */
238 long context_menu_value = 0;
240 /* display update */
241 static struct frame *ns_updating_frame;
242 static NSView *focus_view = NULL;
243 static int ns_window_num = 0;
244 #ifdef NS_IMPL_GNUSTEP
245 static NSRect uRect;
246 #endif
247 static BOOL gsaved = NO;
248 static BOOL ns_fake_keydown = NO;
249 #ifdef NS_IMPL_COCOA
250 static BOOL ns_menu_bar_is_hidden = NO;
251 #endif
252 /*static int debug_lock = 0; */
254 /* event loop */
255 static BOOL send_appdefined = YES;
256 #define NO_APPDEFINED_DATA (-8)
257 static int last_appdefined_event_data = NO_APPDEFINED_DATA;
258 static NSTimer *timed_entry = 0;
259 static NSTimer *scroll_repeat_entry = nil;
260 static fd_set select_readfds, select_writefds;
261 enum { SELECT_HAVE_READ = 1, SELECT_HAVE_WRITE = 2, SELECT_HAVE_TMO = 4 };
262 static int select_nfds = 0, select_valid = 0;
263 static struct timespec select_timeout = { 0, 0 };
264 static int selfds[2] = { -1, -1 };
265 static pthread_mutex_t select_mutex;
266 static int apploopnr = 0;
267 static NSAutoreleasePool *outerpool;
268 static struct input_event *emacs_event = NULL;
269 static struct input_event *q_event_ptr = NULL;
270 static int n_emacs_events_pending = 0;
271 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
272   *ns_pending_service_args;
273 static BOOL ns_do_open_file = NO;
274 static BOOL ns_last_use_native_fullscreen;
276 /* Non-zero means that a HELP_EVENT has been generated since Emacs
277    start.  */
279 static BOOL any_help_event_p = NO;
281 static struct {
282   struct input_event *q;
283   int nr, cap;
284 } hold_event_q = {
285   NULL, 0, 0
288 static NSString *represented_filename = nil;
289 static struct frame *represented_frame = 0;
291 #ifdef NS_IMPL_COCOA
293  * State for pending menu activation:
294  * MENU_NONE     Normal state
295  * MENU_PENDING  A menu has been clicked on, but has been canceled so we can
296  *               run lisp to update the menu.
297  * MENU_OPENING  Menu is up to date, and the click event is redone so the menu
298  *               will open.
299  */
300 #define MENU_NONE 0
301 #define MENU_PENDING 1
302 #define MENU_OPENING 2
303 static int menu_will_open_state = MENU_NONE;
305 /* Saved position for menu click.  */
306 static CGPoint menu_mouse_point;
307 #endif
309 /* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
310 #define NS_FUNCTION_KEY_MASK 0x800000
311 #define NSLeftControlKeyMask    (0x000001 | NSControlKeyMask)
312 #define NSRightControlKeyMask   (0x002000 | NSControlKeyMask)
313 #define NSLeftCommandKeyMask    (0x000008 | NSCommandKeyMask)
314 #define NSRightCommandKeyMask   (0x000010 | NSCommandKeyMask)
315 #define NSLeftAlternateKeyMask  (0x000020 | NSAlternateKeyMask)
316 #define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
317 #define EV_MODIFIERS2(flags)                          \
318     (((flags & NSHelpKeyMask) ?           \
319            hyper_modifier : 0)                        \
320      | (!EQ (ns_right_alternate_modifier, Qleft) && \
321         ((flags & NSRightAlternateKeyMask) \
322          == NSRightAlternateKeyMask) ? \
323            parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
324      | ((flags & NSAlternateKeyMask) ?                 \
325            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
326      | ((flags & NSShiftKeyMask) ?     \
327            shift_modifier : 0)                        \
328      | (!EQ (ns_right_control_modifier, Qleft) && \
329         ((flags & NSRightControlKeyMask) \
330          == NSRightControlKeyMask) ? \
331            parse_solitary_modifier (ns_right_control_modifier) : 0) \
332      | ((flags & NSControlKeyMask) ?      \
333            parse_solitary_modifier (ns_control_modifier) : 0)     \
334      | ((flags & NS_FUNCTION_KEY_MASK) ?  \
335            parse_solitary_modifier (ns_function_modifier) : 0)    \
336      | (!EQ (ns_right_command_modifier, Qleft) && \
337         ((flags & NSRightCommandKeyMask) \
338          == NSRightCommandKeyMask) ? \
339            parse_solitary_modifier (ns_right_command_modifier) : 0) \
340      | ((flags & NSCommandKeyMask) ?      \
341            parse_solitary_modifier (ns_command_modifier):0))
342 #define EV_MODIFIERS(e) EV_MODIFIERS2 ([e modifierFlags])
344 #define EV_UDMODIFIERS(e)                                      \
345     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
346      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
347      | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
348      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
349      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
350      | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
351      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
352      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
353      | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
355 #define EV_BUTTON(e)                                                         \
356     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
357       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
358      [e buttonNumber] - 1)
360 /* Convert the time field to a timestamp in milliseconds. */
361 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
363 /* This is a piece of code which is common to all the event handling
364    methods.  Maybe it should even be a function.  */
365 #define EV_TRAILER(e)                                                   \
366   {                                                                     \
367     XSETFRAME (emacs_event->frame_or_window, emacsframe);               \
368     EV_TRAILER2 (e);                                                    \
369   }
371 #define EV_TRAILER2(e)                                                  \
372   {                                                                     \
373       if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
374       if (q_event_ptr)                                                  \
375         {                                                               \
376           Lisp_Object tem = Vinhibit_quit;                              \
377           Vinhibit_quit = Qt;                                           \
378           n_emacs_events_pending++;                                     \
379           kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
380           Vinhibit_quit = tem;                                          \
381         }                                                               \
382       else                                                              \
383         hold_event (emacs_event);                                       \
384       EVENT_INIT (*emacs_event);                                        \
385       ns_send_appdefined (-1);                                          \
386     }
388 /* TODO: get rid of need for these forward declarations */
389 static void ns_condemn_scroll_bars (struct frame *f);
390 static void ns_judge_scroll_bars (struct frame *f);
391 void x_set_frame_alpha (struct frame *f);
394 /* ==========================================================================
396     Utilities
398    ========================================================================== */
400 void
401 ns_set_represented_filename (NSString* fstr, struct frame *f)
403   represented_filename = [fstr retain];
404   represented_frame = f;
407 void
408 ns_init_events (struct input_event* ev)
410   EVENT_INIT (*ev);
411   emacs_event = ev;
414 void
415 ns_finish_events ()
417   emacs_event = NULL;
420 static void
421 hold_event (struct input_event *event)
423   if (hold_event_q.nr == hold_event_q.cap)
424     {
425       if (hold_event_q.cap == 0) hold_event_q.cap = 10;
426       else hold_event_q.cap *= 2;
427       hold_event_q.q =
428         xrealloc (hold_event_q.q, hold_event_q.cap * sizeof *hold_event_q.q);
429     }
431   hold_event_q.q[hold_event_q.nr++] = *event;
432   /* Make sure ns_read_socket is called, i.e. we have input.  */
433   raise (SIGIO);
434   send_appdefined = YES;
437 static Lisp_Object
438 append2 (Lisp_Object list, Lisp_Object item)
439 /* --------------------------------------------------------------------------
440    Utility to append to a list
441    -------------------------------------------------------------------------- */
443   Lisp_Object array[2];
444   array[0] = list;
445   array[1] = list1 (item);
446   return Fnconc (2, &array[0]);
450 const char *
451 ns_etc_directory (void)
452 /* If running as a self-contained app bundle, return as a string the
453    filename of the etc directory, if present; else nil.  */
455   NSBundle *bundle = [NSBundle mainBundle];
456   NSString *resourceDir = [bundle resourcePath];
457   NSString *resourcePath;
458   NSFileManager *fileManager = [NSFileManager defaultManager];
459   BOOL isDir;
461   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
462   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
463     {
464       if (isDir) return [resourcePath UTF8String];
465     }
466   return NULL;
470 const char *
471 ns_exec_path (void)
472 /* If running as a self-contained app bundle, return as a path string
473    the filenames of the libexec and bin directories, ie libexec:bin.
474    Otherwise, return nil.
475    Normally, Emacs does not add its own bin/ directory to the PATH.
476    However, a self-contained NS build has a different layout, with
477    bin/ and libexec/ subdirectories in the directory that contains
478    Emacs.app itself.
479    We put libexec first, because init_callproc_1 uses the first
480    element to initialize exec-directory.  An alternative would be
481    for init_callproc to check for invocation-directory/libexec.
484   NSBundle *bundle = [NSBundle mainBundle];
485   NSString *resourceDir = [bundle resourcePath];
486   NSString *binDir = [bundle bundlePath];
487   NSString *resourcePath, *resourcePaths;
488   NSRange range;
489   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
490   NSFileManager *fileManager = [NSFileManager defaultManager];
491   NSArray *paths;
492   NSEnumerator *pathEnum;
493   BOOL isDir;
495   range = [resourceDir rangeOfString: @"Contents"];
496   if (range.location != NSNotFound)
497     {
498       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
499 #ifdef NS_IMPL_COCOA
500       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
501 #endif
502     }
504   paths = [binDir stringsByAppendingPaths:
505                 [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
506   pathEnum = [paths objectEnumerator];
507   resourcePaths = @"";
509   while ((resourcePath = [pathEnum nextObject]))
510     {
511       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
512         if (isDir)
513           {
514             if ([resourcePaths length] > 0)
515               resourcePaths
516                 = [resourcePaths stringByAppendingString: pathSeparator];
517             resourcePaths
518               = [resourcePaths stringByAppendingString: resourcePath];
519           }
520     }
521   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
523   return NULL;
527 const char *
528 ns_load_path (void)
529 /* If running as a self-contained app bundle, return as a path string
530    the filenames of the site-lisp and lisp directories.
531    Ie, site-lisp:lisp.  Otherwise, return nil.  */
533   NSBundle *bundle = [NSBundle mainBundle];
534   NSString *resourceDir = [bundle resourcePath];
535   NSString *resourcePath, *resourcePaths;
536   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
537   NSFileManager *fileManager = [NSFileManager defaultManager];
538   BOOL isDir;
539   NSArray *paths = [resourceDir stringsByAppendingPaths:
540                               [NSArray arrayWithObjects:
541                                          @"site-lisp", @"lisp", nil]];
542   NSEnumerator *pathEnum = [paths objectEnumerator];
543   resourcePaths = @"";
545   /* Hack to skip site-lisp.  */
546   if (no_site_lisp) resourcePath = [pathEnum nextObject];
548   while ((resourcePath = [pathEnum nextObject]))
549     {
550       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
551         if (isDir)
552           {
553             if ([resourcePaths length] > 0)
554               resourcePaths
555                 = [resourcePaths stringByAppendingString: pathSeparator];
556             resourcePaths
557               = [resourcePaths stringByAppendingString: resourcePath];
558           }
559     }
560   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
562   return NULL;
565 static void
566 ns_timeout (int usecs)
567 /* --------------------------------------------------------------------------
568      Blocking timer utility used by ns_ring_bell
569    -------------------------------------------------------------------------- */
571   struct timespec wakeup = timespec_add (current_timespec (),
572                                          make_timespec (0, usecs * 1000));
574   /* Keep waiting until past the time wakeup.  */
575   while (1)
576     {
577       struct timespec timeout, now = current_timespec ();
578       if (timespec_cmp (wakeup, now) <= 0)
579         break;
580       timeout = timespec_sub (wakeup, now);
582       /* Try to wait that long--but we might wake up sooner.  */
583       pselect (0, NULL, NULL, NULL, &timeout, NULL);
584     }
588 void
589 ns_release_object (void *obj)
590 /* --------------------------------------------------------------------------
591     Release an object (callable from C)
592    -------------------------------------------------------------------------- */
594     [(id)obj release];
598 void
599 ns_retain_object (void *obj)
600 /* --------------------------------------------------------------------------
601     Retain an object (callable from C)
602    -------------------------------------------------------------------------- */
604     [(id)obj retain];
608 void *
609 ns_alloc_autorelease_pool (void)
610 /* --------------------------------------------------------------------------
611      Allocate a pool for temporary objects (callable from C)
612    -------------------------------------------------------------------------- */
614   return [[NSAutoreleasePool alloc] init];
618 void
619 ns_release_autorelease_pool (void *pool)
620 /* --------------------------------------------------------------------------
621      Free a pool and temporary objects it refers to (callable from C)
622    -------------------------------------------------------------------------- */
624   ns_release_object (pool);
629 /* ==========================================================================
631     Focus (clipping) and screen update
633    ========================================================================== */
636 // Window constraining
637 // -------------------
639 // To ensure that the windows are not placed under the menu bar, they
640 // are typically moved by the call-back constrainFrameRect. However,
641 // by overriding it, it's possible to inhibit this, leaving the window
642 // in it's original position.
644 // It's possible to hide the menu bar. However, technically, it's only
645 // possible to hide it when the application is active. To ensure that
646 // this work properly, the menu bar and window constraining are
647 // deferred until the application becomes active.
649 // Even though it's not possible to manually move a window above the
650 // top of the screen, it is allowed if it's done programmatically,
651 // when the menu is hidden. This allows the editable area to cover the
652 // full screen height.
654 // Test cases
655 // ----------
657 // Use the following extra files:
659 //    init.el:
660 //       ;; Hide menu and place frame slightly above the top of the screen.
661 //       (setq ns-auto-hide-menu-bar t)
662 //       (set-frame-position (selected-frame) 0 -20)
664 // Test 1:
666 //    emacs -Q -l init.el
668 //    Result: No menu bar, and the title bar should be above the screen.
670 // Test 2:
672 //    emacs -Q
674 //    Result: Menu bar visible, frame placed immediately below the menu.
677 static void
678 ns_constrain_all_frames (void)
680   Lisp_Object tail, frame;
682   FOR_EACH_FRAME (tail, frame)
683     {
684       struct frame *f = XFRAME (frame);
685       if (FRAME_NS_P (f))
686         {
687           NSView *view = FRAME_NS_VIEW (f);
688           /* This no-op will trigger the default window placing
689            * constraint system. */
690           [[view window] setFrameOrigin:[[view window] frame].origin];
691         }
692     }
696 /* True, if the menu bar should be hidden.  */
698 static BOOL
699 ns_menu_bar_should_be_hidden (void)
701   return !NILP (ns_auto_hide_menu_bar)
702     && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
706 /* Show or hide the menu bar, based on user setting.  */
708 static void
709 ns_update_auto_hide_menu_bar (void)
711 #ifdef NS_IMPL_COCOA
712   block_input ();
714   NSTRACE (ns_update_auto_hide_menu_bar);
716   if (NSApp != nil && [NSApp isActive])
717     {
718       // Note, "setPresentationOptions" triggers an error unless the
719       // application is active.
720       BOOL menu_bar_should_be_hidden = ns_menu_bar_should_be_hidden ();
722       if (menu_bar_should_be_hidden != ns_menu_bar_is_hidden)
723         {
724           NSApplicationPresentationOptions options
725             = NSApplicationPresentationDefault;
727           if (menu_bar_should_be_hidden)
728             options |= NSApplicationPresentationAutoHideMenuBar
729               | NSApplicationPresentationAutoHideDock;
731           [NSApp setPresentationOptions: options];
733           ns_menu_bar_is_hidden = menu_bar_should_be_hidden;
735           if (!ns_menu_bar_is_hidden)
736             {
737               ns_constrain_all_frames ();
738             }
739         }
740     }
742   unblock_input ();
743 #endif
747 static void
748 ns_update_begin (struct frame *f)
749 /* --------------------------------------------------------------------------
750    Prepare for a grouped sequence of drawing calls
751    external (RIF) call; whole frame, called before update_window_begin
752    -------------------------------------------------------------------------- */
754   EmacsView *view = FRAME_NS_VIEW (f);
755   NSTRACE (ns_update_begin);
757   ns_update_auto_hide_menu_bar ();
759 #ifdef NS_IMPL_COCOA
760   if ([view isFullscreen] && [view fsIsNative])
761   {
762     // Fix reappearing tool bar in fullscreen for OSX 10.7
763     BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (f) ? YES : NO;
764     NSToolbar *toolbar = [FRAME_NS_VIEW (f) toolbar];
765     if (! tbar_visible != ! [toolbar isVisible])
766       [toolbar setVisible: tbar_visible];
767   }
768 #endif
770   ns_updating_frame = f;
771   [view lockFocus];
773   /* drawRect may have been called for say the minibuffer, and then clip path
774      is for the minibuffer.  But the display engine may draw more because
775      we have set the frame as garbaged.  So reset clip path to the whole
776      view.  */
777 #ifdef NS_IMPL_COCOA
778   {
779     NSBezierPath *bp;
780     NSRect r = [view frame];
781     NSRect cr = [[view window] frame];
782     /* If a large frame size is set, r may be larger than the window frame
783        before constrained.  In that case don't change the clip path, as we
784        will clear in to the tool bar and title bar.  */
785     if (r.size.height
786         + FRAME_NS_TITLEBAR_HEIGHT (f)
787         + FRAME_TOOLBAR_HEIGHT (f) <= cr.size.height)
788       {
789         bp = [[NSBezierPath bezierPathWithRect: r] retain];
790         [bp setClip];
791         [bp release];
792       }
793   }
794 #endif
796 #ifdef NS_IMPL_GNUSTEP
797   uRect = NSMakeRect (0, 0, 0, 0);
798 #endif
802 static void
803 ns_update_window_begin (struct window *w)
804 /* --------------------------------------------------------------------------
805    Prepare for a grouped sequence of drawing calls
806    external (RIF) call; for one window, called after update_begin
807    -------------------------------------------------------------------------- */
809   struct frame *f = XFRAME (WINDOW_FRAME (w));
810   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
812   NSTRACE (ns_update_window_begin);
813   w->output_cursor = w->cursor;
815   block_input ();
817   if (f == hlinfo->mouse_face_mouse_frame)
818     {
819       /* Don't do highlighting for mouse motion during the update.  */
820       hlinfo->mouse_face_defer = 1;
822         /* If the frame needs to be redrawn,
823            simply forget about any prior mouse highlighting.  */
824       if (FRAME_GARBAGED_P (f))
825         hlinfo->mouse_face_window = Qnil;
827       /* (further code for mouse faces ifdef'd out in other terms elided) */
828     }
830   unblock_input ();
834 static void
835 ns_update_window_end (struct window *w, bool cursor_on_p,
836                       bool mouse_face_overwritten_p)
837 /* --------------------------------------------------------------------------
838    Finished a grouped sequence of drawing calls
839    external (RIF) call; for one window called before update_end
840    -------------------------------------------------------------------------- */
842   /* note: this fn is nearly identical in all terms */
843   if (!w->pseudo_window_p)
844     {
845       block_input ();
847       if (cursor_on_p)
848         display_and_set_cursor (w, 1,
849                                 w->output_cursor.hpos, w->output_cursor.vpos,
850                                 w->output_cursor.x, w->output_cursor.y);
852       if (draw_window_fringes (w, 1))
853         {
854           if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
855             x_draw_right_divider (w);
856           else
857             x_draw_vertical_border (w);
858         }
860       unblock_input ();
861     }
863   /* If a row with mouse-face was overwritten, arrange for
864      frame_up_to_date to redisplay the mouse highlight.  */
865   if (mouse_face_overwritten_p)
866     reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
868   NSTRACE (update_window_end);
872 static void
873 ns_update_end (struct frame *f)
874 /* --------------------------------------------------------------------------
875    Finished a grouped sequence of drawing calls
876    external (RIF) call; for whole frame, called after update_window_end
877    -------------------------------------------------------------------------- */
879   EmacsView *view = FRAME_NS_VIEW (f);
881 /*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
882   MOUSE_HL_INFO (f)->mouse_face_defer = 0;
884   block_input ();
886   [view unlockFocus];
887   [[view window] flushWindow];
889   unblock_input ();
890   ns_updating_frame = NULL;
891   NSTRACE (ns_update_end);
894 static void
895 ns_focus (struct frame *f, NSRect *r, int n)
896 /* --------------------------------------------------------------------------
897    Internal: Focus on given frame.  During small local updates this is used to
898      draw, however during large updates, ns_update_begin and ns_update_end are
899      called to wrap the whole thing, in which case these calls are stubbed out.
900      Except, on GNUstep, we accumulate the rectangle being drawn into, because
901      the back end won't do this automatically, and will just end up flushing
902      the entire window.
903    -------------------------------------------------------------------------- */
905 //  NSTRACE (ns_focus);
906 /* static int c =0;
907    fprintf (stderr, "focus: %d", c++);
908    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
909    fprintf (stderr, "\n"); */
911   if (f != ns_updating_frame)
912     {
913       NSView *view = FRAME_NS_VIEW (f);
914       if (view != focus_view)
915         {
916           if (focus_view != NULL)
917             {
918               [focus_view unlockFocus];
919               [[focus_view window] flushWindow];
920 /*debug_lock--; */
921             }
923           if (view)
924             [view lockFocus];
925           focus_view = view;
926 /*if (view) debug_lock++; */
927         }
928     }
930   /* clipping */
931   if (r)
932     {
933       [[NSGraphicsContext currentContext] saveGraphicsState];
934       if (n == 2)
935         NSRectClipList (r, 2);
936       else
937         NSRectClip (*r);
938       gsaved = YES;
939     }
943 static void
944 ns_unfocus (struct frame *f)
945 /* --------------------------------------------------------------------------
946      Internal: Remove focus on given frame
947    -------------------------------------------------------------------------- */
949 //  NSTRACE (ns_unfocus);
951   if (gsaved)
952     {
953       [[NSGraphicsContext currentContext] restoreGraphicsState];
954       gsaved = NO;
955     }
957   if (f != ns_updating_frame)
958     {
959       if (focus_view != NULL)
960         {
961           [focus_view unlockFocus];
962           [[focus_view window] flushWindow];
963           focus_view = NULL;
964 /*debug_lock--; */
965         }
966     }
970 static void
971 ns_clip_to_row (struct window *w, struct glyph_row *row,
972                 enum glyph_row_area area, BOOL gc)
973 /* --------------------------------------------------------------------------
974      Internal (but parallels other terms): Focus drawing on given row
975    -------------------------------------------------------------------------- */
977   struct frame *f = XFRAME (WINDOW_FRAME (w));
978   NSRect clip_rect;
979   int window_x, window_y, window_width;
981   window_box (w, area, &window_x, &window_y, &window_width, 0);
983   clip_rect.origin.x = window_x;
984   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
985   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
986   clip_rect.size.width = window_width;
987   clip_rect.size.height = row->visible_height;
989   ns_focus (f, &clip_rect, 1);
993 static void
994 ns_ring_bell (struct frame *f)
995 /* --------------------------------------------------------------------------
996      "Beep" routine
997    -------------------------------------------------------------------------- */
999   NSTRACE (ns_ring_bell);
1000   if (visible_bell)
1001     {
1002       NSAutoreleasePool *pool;
1003       struct frame *frame = SELECTED_FRAME ();
1004       NSView *view;
1006       block_input ();
1007       pool = [[NSAutoreleasePool alloc] init];
1009       view = FRAME_NS_VIEW (frame);
1010       if (view != nil)
1011         {
1012           NSRect r, surr;
1013           NSPoint dim = NSMakePoint (128, 128);
1015           r = [view bounds];
1016           r.origin.x += (r.size.width - dim.x) / 2;
1017           r.origin.y += (r.size.height - dim.y) / 2;
1018           r.size.width = dim.x;
1019           r.size.height = dim.y;
1020           surr = NSInsetRect (r, -2, -2);
1021           ns_focus (frame, &surr, 1);
1022           [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
1023           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
1024                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
1025           NSRectFill (r);
1026           [[view window] flushWindow];
1027           ns_timeout (150000);
1028           [[view window] restoreCachedImage];
1029           [[view window] flushWindow];
1030           ns_unfocus (frame);
1031         }
1032       [pool release];
1033       unblock_input ();
1034     }
1035   else
1036     {
1037       NSBeep ();
1038     }
1041 /* ==========================================================================
1043     Frame / window manager related functions
1045    ========================================================================== */
1048 static void
1049 ns_raise_frame (struct frame *f)
1050 /* --------------------------------------------------------------------------
1051      Bring window to foreground and make it active
1052    -------------------------------------------------------------------------- */
1054   NSView *view;
1055   check_window_system (f);
1056   view = FRAME_NS_VIEW (f);
1057   block_input ();
1058   if (FRAME_VISIBLE_P (f))
1059     [[view window] makeKeyAndOrderFront: NSApp];
1060   unblock_input ();
1064 static void
1065 ns_lower_frame (struct frame *f)
1066 /* --------------------------------------------------------------------------
1067      Send window to back
1068    -------------------------------------------------------------------------- */
1070   NSView *view;
1071   check_window_system (f);
1072   view = FRAME_NS_VIEW (f);
1073   block_input ();
1074   [[view window] orderBack: NSApp];
1075   unblock_input ();
1079 static void
1080 ns_frame_raise_lower (struct frame *f, bool raise)
1081 /* --------------------------------------------------------------------------
1082      External (hook)
1083    -------------------------------------------------------------------------- */
1085   NSTRACE (ns_frame_raise_lower);
1087   if (raise)
1088     ns_raise_frame (f);
1089   else
1090     ns_lower_frame (f);
1094 static void
1095 ns_frame_rehighlight (struct frame *frame)
1096 /* --------------------------------------------------------------------------
1097      External (hook): called on things like window switching within frame
1098    -------------------------------------------------------------------------- */
1100   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1101   struct frame *old_highlight = dpyinfo->x_highlight_frame;
1103   NSTRACE (ns_frame_rehighlight);
1104   if (dpyinfo->x_focus_frame)
1105     {
1106       dpyinfo->x_highlight_frame
1107         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1108            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1109            : dpyinfo->x_focus_frame);
1110       if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
1111         {
1112           fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
1113           dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
1114         }
1115     }
1116   else
1117       dpyinfo->x_highlight_frame = 0;
1119   if (dpyinfo->x_highlight_frame &&
1120          dpyinfo->x_highlight_frame != old_highlight)
1121     {
1122       if (old_highlight)
1123         {
1124           x_update_cursor (old_highlight, 1);
1125           x_set_frame_alpha (old_highlight);
1126         }
1127       if (dpyinfo->x_highlight_frame)
1128         {
1129           x_update_cursor (dpyinfo->x_highlight_frame, 1);
1130           x_set_frame_alpha (dpyinfo->x_highlight_frame);
1131         }
1132     }
1136 void
1137 x_make_frame_visible (struct frame *f)
1138 /* --------------------------------------------------------------------------
1139      External: Show the window (X11 semantics)
1140    -------------------------------------------------------------------------- */
1142   NSTRACE (x_make_frame_visible);
1143   /* XXX: at some points in past this was not needed, as the only place that
1144      called this (frame.c:Fraise_frame ()) also called raise_lower;
1145      if this ends up the case again, comment this out again. */
1146   if (!FRAME_VISIBLE_P (f))
1147     {
1148       EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1150       SET_FRAME_VISIBLE (f, 1);
1151       ns_raise_frame (f);
1153       /* Making a new frame from a fullscreen frame will make the new frame
1154          fullscreen also.  So skip handleFS as this will print an error.  */
1155       if ([view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH
1156           && [view isFullscreen])
1157         return;
1159       if (f->want_fullscreen != FULLSCREEN_NONE)
1160         {
1161           block_input ();
1162           [view handleFS];
1163           unblock_input ();
1164         }
1165     }
1169 void
1170 x_make_frame_invisible (struct frame *f)
1171 /* --------------------------------------------------------------------------
1172      External: Hide the window (X11 semantics)
1173    -------------------------------------------------------------------------- */
1175   NSView *view;
1176   NSTRACE (x_make_frame_invisible);
1177   check_window_system (f);
1178   view = FRAME_NS_VIEW (f);
1179   [[view window] orderOut: NSApp];
1180   SET_FRAME_VISIBLE (f, 0);
1181   SET_FRAME_ICONIFIED (f, 0);
1185 void
1186 x_iconify_frame (struct frame *f)
1187 /* --------------------------------------------------------------------------
1188      External: Iconify window
1189    -------------------------------------------------------------------------- */
1191   NSView *view;
1192   struct ns_display_info *dpyinfo;
1194   NSTRACE (x_iconify_frame);
1195   check_window_system (f);
1196   view = FRAME_NS_VIEW (f);
1197   dpyinfo = FRAME_DISPLAY_INFO (f);
1199   if (dpyinfo->x_highlight_frame == f)
1200     dpyinfo->x_highlight_frame = 0;
1202   if ([[view window] windowNumber] <= 0)
1203     {
1204       /* the window is still deferred.  Make it very small, bring it
1205          on screen and order it out. */
1206       NSRect s = { { 100, 100}, {0, 0} };
1207       NSRect t;
1208       t = [[view window] frame];
1209       [[view window] setFrame: s display: NO];
1210       [[view window] orderBack: NSApp];
1211       [[view window] orderOut: NSApp];
1212       [[view window] setFrame: t display: NO];
1213     }
1214   [[view window] miniaturize: NSApp];
1217 /* Free X resources of frame F.  */
1219 void
1220 x_free_frame_resources (struct frame *f)
1222   NSView *view;
1223   struct ns_display_info *dpyinfo;
1224   Mouse_HLInfo *hlinfo;
1226   NSTRACE (x_free_frame_resources);
1227   check_window_system (f);
1228   view = FRAME_NS_VIEW (f);
1229   dpyinfo = FRAME_DISPLAY_INFO (f);
1230   hlinfo = MOUSE_HL_INFO (f);
1232   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1234   block_input ();
1236   free_frame_menubar (f);
1237   free_frame_faces (f);
1239   if (f == dpyinfo->x_focus_frame)
1240     dpyinfo->x_focus_frame = 0;
1241   if (f == dpyinfo->x_highlight_frame)
1242     dpyinfo->x_highlight_frame = 0;
1243   if (f == hlinfo->mouse_face_mouse_frame)
1244     reset_mouse_highlight (hlinfo);
1246   if (f->output_data.ns->miniimage != nil)
1247     [f->output_data.ns->miniimage release];
1249   [[view window] close];
1250   [view release];
1252   xfree (f->output_data.ns);
1254   unblock_input ();
1257 void
1258 x_destroy_window (struct frame *f)
1259 /* --------------------------------------------------------------------------
1260      External: Delete the window
1261    -------------------------------------------------------------------------- */
1263   NSTRACE (x_destroy_window);
1264   check_window_system (f);
1265   x_free_frame_resources (f);
1266   ns_window_num--;
1270 void
1271 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1272 /* --------------------------------------------------------------------------
1273      External: Position the window
1274    -------------------------------------------------------------------------- */
1276   NSView *view = FRAME_NS_VIEW (f);
1277   NSArray *screens = [NSScreen screens];
1278   NSScreen *fscreen = [screens objectAtIndex: 0];
1279   NSScreen *screen = [[view window] screen];
1281   NSTRACE (x_set_offset);
1283   block_input ();
1285   f->left_pos = xoff;
1286   f->top_pos = yoff;
1288   if (view != nil && screen && fscreen)
1289     {
1290       f->left_pos = f->size_hint_flags & XNegative
1291         ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
1292         : f->left_pos;
1293       /* We use visibleFrame here to take menu bar into account.
1294          Ideally we should also adjust left/top with visibleFrame.origin.  */
1296       f->top_pos = f->size_hint_flags & YNegative
1297         ? ([screen visibleFrame].size.height + f->top_pos
1298            - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
1299            - FRAME_TOOLBAR_HEIGHT (f))
1300         : f->top_pos;
1301 #ifdef NS_IMPL_GNUSTEP
1302       if (f->left_pos < 100)
1303         f->left_pos = 100;  /* don't overlap menu */
1304 #endif
1305       /* Constrain the setFrameTopLeftPoint so we don't move behind the
1306          menu bar.  */
1307       [[view window] setFrameTopLeftPoint:
1308                        NSMakePoint (SCREENMAXBOUND (f->left_pos),
1309                                     SCREENMAXBOUND ([fscreen frame].size.height
1310                                                     - NS_TOP_POS (f)))];
1311       f->size_hint_flags &= ~(XNegative|YNegative);
1312     }
1314   unblock_input ();
1318 void
1319 x_set_window_size (struct frame *f,
1320                    bool change_gravity,
1321                    int width,
1322                    int height,
1323                    bool pixelwise)
1324 /* --------------------------------------------------------------------------
1325      Adjust window pixel size based on given character grid size
1326      Impl is a bit more complex than other terms, need to do some
1327      internal clipping.
1328    -------------------------------------------------------------------------- */
1330   EmacsView *view = FRAME_NS_VIEW (f);
1331   NSWindow *window = [view window];
1332   NSRect wr = [window frame];
1333   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1334   int pixelwidth, pixelheight;
1335   int rows, cols;
1337   NSTRACE (x_set_window_size);
1339   if (view == nil)
1340     return;
1342 /*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));*/
1344   block_input ();
1346   if (pixelwise)
1347     {
1348       pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
1349       pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
1350       cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pixelwidth);
1351       rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelheight);
1352     }
1353   else
1354     {
1355       pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, width);
1356       pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, height);
1357       cols = width;
1358       rows = height;
1359     }
1361   /* If we have a toolbar, take its height into account. */
1362   if (tb && ! [view isFullscreen])
1363     {
1364     /* NOTE: previously this would generate wrong result if toolbar not
1365              yet displayed and fixing toolbar_height=32 helped, but
1366              now (200903) seems no longer needed */
1367     FRAME_TOOLBAR_HEIGHT (f) =
1368       NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1369         - FRAME_NS_TITLEBAR_HEIGHT (f);
1370 #ifdef NS_IMPL_GNUSTEP
1371       FRAME_TOOLBAR_HEIGHT (f) -= 3;
1372 #endif
1373     }
1374   else
1375     FRAME_TOOLBAR_HEIGHT (f) = 0;
1377   wr.size.width = pixelwidth + f->border_width;
1378   wr.size.height = pixelheight;
1379   if (! [view isFullscreen])
1380     wr.size.height += FRAME_NS_TITLEBAR_HEIGHT (f)
1381       + FRAME_TOOLBAR_HEIGHT (f);
1383   /* Do not try to constrain to this screen.  We may have multiple
1384      screens, and want Emacs to span those.  Constraining to screen
1385      prevents that, and that is not nice to the user.  */
1386  if (f->output_data.ns->zooming)
1387    f->output_data.ns->zooming = 0;
1388  else
1389    wr.origin.y += FRAME_PIXEL_HEIGHT (f) - pixelheight;
1391   [view setRows: rows andColumns: cols];
1392   [window setFrame: wr display: YES];
1394   /* This is a trick to compensate for Emacs' managing the scrollbar area
1395      as a fixed number of standard character columns.  Instead of leaving
1396      blank space for the extra, we chopped it off above.  Now for
1397      left-hand scrollbars, we shift all rendering to the left by the
1398      difference between the real width and Emacs' imagined one.  For
1399      right-hand bars, don't worry about it since the extra is never used.
1400      (Obviously doesn't work for vertically split windows tho..) */
1401   {
1402     NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1403       ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1404                      - NS_SCROLL_BAR_WIDTH (f), 0)
1405       : NSMakePoint (0, 0);
1406     [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1407     [view setBoundsOrigin: origin];
1408   }
1410   [view updateFrameSize: NO];
1411   unblock_input ();
1415 static void
1416 ns_fullscreen_hook (struct frame *f)
1418   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1420   if (!FRAME_VISIBLE_P (f))
1421     return;
1423    if (! [view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH)
1424     {
1425       /* Old style fs don't initiate correctly if created from
1426          init/default-frame alist, so use a timer (not nice...).
1427       */
1428       [NSTimer scheduledTimerWithTimeInterval: 0.5 target: view
1429                                      selector: @selector (handleFS)
1430                                      userInfo: nil repeats: NO];
1431       return;
1432     }
1434   block_input ();
1435   [view handleFS];
1436   unblock_input ();
1439 /* ==========================================================================
1441     Color management
1443    ========================================================================== */
1446 NSColor *
1447 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1449   struct ns_color_table *color_table = FRAME_DISPLAY_INFO (f)->color_table;
1450   if (idx < 1 || idx >= color_table->avail)
1451     return nil;
1452   return color_table->colors[idx];
1456 unsigned long
1457 ns_index_color (NSColor *color, struct frame *f)
1459   struct ns_color_table *color_table = FRAME_DISPLAY_INFO (f)->color_table;
1460   ptrdiff_t idx;
1461   ptrdiff_t i;
1463   if (!color_table->colors)
1464     {
1465       color_table->size = NS_COLOR_CAPACITY;
1466       color_table->avail = 1; /* skip idx=0 as marker */
1467       color_table->colors = xmalloc (color_table->size * sizeof (NSColor *));
1468       color_table->colors[0] = nil;
1469       color_table->empty_indices = [[NSMutableSet alloc] init];
1470     }
1472   /* Do we already have this color?  */
1473   for (i = 1; i < color_table->avail; i++)
1474     if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1475       return i;
1477   if ([color_table->empty_indices count] > 0)
1478     {
1479       NSNumber *index = [color_table->empty_indices anyObject];
1480       [color_table->empty_indices removeObject: index];
1481       idx = [index unsignedLongValue];
1482     }
1483   else
1484     {
1485       if (color_table->avail == color_table->size)
1486         color_table->colors =
1487           xpalloc (color_table->colors, &color_table->size, 1,
1488                    min (ULONG_MAX, PTRDIFF_MAX), sizeof *color_table->colors);
1489       idx = color_table->avail++;
1490     }
1492   color_table->colors[idx] = color;
1493   [color retain];
1494 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1495   return idx;
1499 void
1500 ns_free_indexed_color (unsigned long idx, struct frame *f)
1502   struct ns_color_table *color_table;
1503   NSColor *color;
1504   NSNumber *index;
1506   if (!f)
1507     return;
1509   color_table = FRAME_DISPLAY_INFO (f)->color_table;
1511   if (idx <= 0 || idx >= color_table->size) {
1512     message1 ("ns_free_indexed_color: Color index out of range.\n");
1513     return;
1514   }
1516   index = [NSNumber numberWithUnsignedInt: idx];
1517   if ([color_table->empty_indices containsObject: index]) {
1518     message1 ("ns_free_indexed_color: attempt to free already freed color.\n");
1519     return;
1520   }
1522   color = color_table->colors[idx];
1523   [color release];
1524   color_table->colors[idx] = nil;
1525   [color_table->empty_indices addObject: index];
1526 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1530 static int
1531 ns_get_color (const char *name, NSColor **col)
1532 /* --------------------------------------------------------------------------
1533      Parse a color name
1534    -------------------------------------------------------------------------- */
1535 /* On *Step, we attempt to mimic the X11 platform here, down to installing an
1536    X11 rgb.txt-compatible color list in Emacs.clr (see ns_term_init()).
1537    See: http://thread.gmane.org/gmane.emacs.devel/113050/focus=113272). */
1539   NSColor *new = nil;
1540   static char hex[20];
1541   int scaling = 0;
1542   float r = -1.0, g, b;
1543   NSString *nsname = [NSString stringWithUTF8String: name];
1545 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1546   block_input ();
1548   if ([nsname isEqualToString: @"ns_selection_bg_color"])
1549     {
1550 #ifdef NS_IMPL_COCOA
1551       NSString *defname = [[NSUserDefaults standardUserDefaults]
1552                             stringForKey: @"AppleHighlightColor"];
1553       if (defname != nil)
1554         nsname = defname;
1555       else
1556 #endif
1557       if ((new = [NSColor selectedTextBackgroundColor]) != nil)
1558         {
1559           *col = [new colorUsingDefaultColorSpace];
1560           unblock_input ();
1561           return 0;
1562         }
1563       else
1564         nsname = NS_SELECTION_BG_COLOR_DEFAULT;
1566       name = [nsname UTF8String];
1567     }
1568   else if ([nsname isEqualToString: @"ns_selection_fg_color"])
1569     {
1570       /* NOTE: OSX applications normally don't set foreground selection, but
1571          text may be unreadable if we don't.
1572       */
1573       if ((new = [NSColor selectedTextColor]) != nil)
1574         {
1575           *col = [new colorUsingDefaultColorSpace];
1576           unblock_input ();
1577           return 0;
1578         }
1580       nsname = NS_SELECTION_FG_COLOR_DEFAULT;
1581       name = [nsname UTF8String];
1582     }
1584   /* First, check for some sort of numeric specification. */
1585   hex[0] = '\0';
1587   if (name[0] == '0' || name[0] == '1' || name[0] == '.')  /* RGB decimal */
1588     {
1589       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1590       [scanner scanFloat: &r];
1591       [scanner scanFloat: &g];
1592       [scanner scanFloat: &b];
1593     }
1594   else if (!strncmp(name, "rgb:", 4))  /* A newer X11 format -- rgb:r/g/b */
1595     scaling = (snprintf (hex, sizeof hex, "%s", name + 4) - 2) / 3;
1596   else if (name[0] == '#')        /* An old X11 format; convert to newer */
1597     {
1598       int len = (strlen(name) - 1);
1599       int start = (len % 3 == 0) ? 1 : len / 4 + 1;
1600       int i;
1601       scaling = strlen(name+start) / 3;
1602       for (i = 0; i < 3; i++)
1603         sprintf (hex + i * (scaling + 1), "%.*s/", scaling,
1604                  name + start + i * scaling);
1605       hex[3 * (scaling + 1) - 1] = '\0';
1606     }
1608   if (hex[0])
1609     {
1610       int rr, gg, bb;
1611       float fscale = scaling == 4 ? 65535.0 : (scaling == 2 ? 255.0 : 15.0);
1612       if (sscanf (hex, "%x/%x/%x", &rr, &gg, &bb))
1613         {
1614           r = rr / fscale;
1615           g = gg / fscale;
1616           b = bb / fscale;
1617         }
1618     }
1620   if (r >= 0.0F)
1621     {
1622       *col = [NSColor colorForEmacsRed: r green: g blue: b alpha: 1.0];
1623       unblock_input ();
1624       return 0;
1625     }
1627   /* Otherwise, color is expected to be from a list */
1628   {
1629     NSEnumerator *lenum, *cenum;
1630     NSString *name;
1631     NSColorList *clist;
1633 #ifdef NS_IMPL_GNUSTEP
1634     /* XXX: who is wrong, the requestor or the implementation? */
1635     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1636         == NSOrderedSame)
1637       nsname = @"highlightColor";
1638 #endif
1640     lenum = [[NSColorList availableColorLists] objectEnumerator];
1641     while ( (clist = [lenum nextObject]) && new == nil)
1642       {
1643         cenum = [[clist allKeys] objectEnumerator];
1644         while ( (name = [cenum nextObject]) && new == nil )
1645           {
1646             if ([name compare: nsname
1647                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1648               new = [clist colorWithKey: name];
1649           }
1650       }
1651   }
1653   if (new)
1654     *col = [new colorUsingDefaultColorSpace];
1655   unblock_input ();
1656   return new ? 0 : 1;
1661 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1662 /* --------------------------------------------------------------------------
1663      Convert a Lisp string object to a NS color
1664    -------------------------------------------------------------------------- */
1666   NSTRACE (ns_lisp_to_color);
1667   if (STRINGP (color))
1668     return ns_get_color (SSDATA (color), col);
1669   else if (SYMBOLP (color))
1670     return ns_get_color (SSDATA (SYMBOL_NAME (color)), col);
1671   return 1;
1675 Lisp_Object
1676 ns_color_to_lisp (NSColor *col)
1677 /* --------------------------------------------------------------------------
1678      Convert a color to a lisp string with the RGB equivalent
1679    -------------------------------------------------------------------------- */
1681   EmacsCGFloat red, green, blue, alpha, gray;
1682   char buf[1024];
1683   const char *str;
1684   NSTRACE (ns_color_to_lisp);
1686   block_input ();
1687   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1689       if ((str =[[col colorNameComponent] UTF8String]))
1690         {
1691           unblock_input ();
1692           return build_string ((char *)str);
1693         }
1695     [[col colorUsingDefaultColorSpace]
1696         getRed: &red green: &green blue: &blue alpha: &alpha];
1697   if (red == green && red == blue)
1698     {
1699       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1700             getWhite: &gray alpha: &alpha];
1701       snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1702                 lrint (gray * 0xff), lrint (gray * 0xff), lrint (gray * 0xff));
1703       unblock_input ();
1704       return build_string (buf);
1705     }
1707   snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1708             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1710   unblock_input ();
1711   return build_string (buf);
1715 void
1716 ns_query_color(void *col, XColor *color_def, int setPixel)
1717 /* --------------------------------------------------------------------------
1718          Get ARGB values out of NSColor col and put them into color_def.
1719          If setPixel, set the pixel to a concatenated version.
1720          and set color_def pixel to the resulting index.
1721    -------------------------------------------------------------------------- */
1723   EmacsCGFloat r, g, b, a;
1725   [((NSColor *)col) getRed: &r green: &g blue: &b alpha: &a];
1726   color_def->red   = r * 65535;
1727   color_def->green = g * 65535;
1728   color_def->blue  = b * 65535;
1730   if (setPixel == YES)
1731     color_def->pixel
1732       = ARGB_TO_ULONG((int)(a*255),
1733                       (int)(r*255), (int)(g*255), (int)(b*255));
1737 bool
1738 ns_defined_color (struct frame *f,
1739                   const char *name,
1740                   XColor *color_def,
1741                   bool alloc,
1742                   bool makeIndex)
1743 /* --------------------------------------------------------------------------
1744          Return true if named color found, and set color_def rgb accordingly.
1745          If makeIndex and alloc are nonzero put the color in the color_table,
1746          and set color_def pixel to the resulting index.
1747          If makeIndex is zero, set color_def pixel to ARGB.
1748          Return false if not found
1749    -------------------------------------------------------------------------- */
1751   NSColor *col;
1752   NSTRACE (ns_defined_color);
1754   block_input ();
1755   if (ns_get_color (name, &col) != 0) /* Color not found  */
1756     {
1757       unblock_input ();
1758       return 0;
1759     }
1760   if (makeIndex && alloc)
1761     color_def->pixel = ns_index_color (col, f);
1762   ns_query_color (col, color_def, !makeIndex);
1763   unblock_input ();
1764   return 1;
1768 void
1769 x_set_frame_alpha (struct frame *f)
1770 /* --------------------------------------------------------------------------
1771      change the entire-frame transparency
1772    -------------------------------------------------------------------------- */
1774   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1775   double alpha = 1.0;
1776   double alpha_min = 1.0;
1778   if (dpyinfo->x_highlight_frame == f)
1779     alpha = f->alpha[0];
1780   else
1781     alpha = f->alpha[1];
1783   if (FLOATP (Vframe_alpha_lower_limit))
1784     alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
1785   else if (INTEGERP (Vframe_alpha_lower_limit))
1786     alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
1788   if (alpha < 0.0)
1789     return;
1790   else if (1.0 < alpha)
1791     alpha = 1.0;
1792   else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
1793     alpha = alpha_min;
1795 #ifdef NS_IMPL_COCOA
1796   {
1797     EmacsView *view = FRAME_NS_VIEW (f);
1798   [[view window] setAlphaValue: alpha];
1799   }
1800 #endif
1804 /* ==========================================================================
1806     Mouse handling
1808    ========================================================================== */
1811 void
1812 frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1813 /* --------------------------------------------------------------------------
1814      Programmatically reposition mouse pointer in pixel coordinates
1815    -------------------------------------------------------------------------- */
1817   NSTRACE (frame_set_mouse_pixel_position);
1818   ns_raise_frame (f);
1819 #if 0
1820   /* FIXME: this does not work, and what about GNUstep? */
1821 #ifdef NS_IMPL_COCOA
1822   [FRAME_NS_VIEW (f) lockFocus];
1823   PSsetmouse ((float)pix_x, (float)pix_y);
1824   [FRAME_NS_VIEW (f) unlockFocus];
1825 #endif
1826 #endif
1829 static int
1830 note_mouse_movement (struct frame *frame, CGFloat x, CGFloat y)
1831 /*   ------------------------------------------------------------------------
1832      Called by EmacsView on mouseMovement events.  Passes on
1833      to emacs mainstream code if we moved off of a rect of interest
1834      known as last_mouse_glyph.
1835      ------------------------------------------------------------------------ */
1837   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1838   NSRect *r;
1840 //  NSTRACE (note_mouse_movement);
1842   dpyinfo->last_mouse_motion_frame = frame;
1843   r = &dpyinfo->last_mouse_glyph;
1845   /* Note, this doesn't get called for enter/leave, since we don't have a
1846      position.  Those are taken care of in the corresponding NSView methods. */
1848   /* has movement gone beyond last rect we were tracking? */
1849   if (x < r->origin.x || x >= r->origin.x + r->size.width
1850       || y < r->origin.y || y >= r->origin.y + r->size.height)
1851     {
1852       ns_update_begin (frame);
1853       frame->mouse_moved = 1;
1854       note_mouse_highlight (frame, x, y);
1855       remember_mouse_glyph (frame, x, y, r);
1856       ns_update_end (frame);
1857       return 1;
1858     }
1860   return 0;
1864 static void
1865 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1866                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1867                    Time *time)
1868 /* --------------------------------------------------------------------------
1869     External (hook): inform emacs about mouse position and hit parts.
1870     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1871     x & y should be position in the scrollbar (the whole bar, not the handle)
1872     and length of scrollbar respectively
1873    -------------------------------------------------------------------------- */
1875   id view;
1876   NSPoint position;
1877   Lisp_Object frame, tail;
1878   struct frame *f;
1879   struct ns_display_info *dpyinfo;
1881   NSTRACE (ns_mouse_position);
1883   if (*fp == NULL)
1884     {
1885       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1886       return;
1887     }
1889   dpyinfo = FRAME_DISPLAY_INFO (*fp);
1891   block_input ();
1893   /* Clear the mouse-moved flag for every frame on this display.  */
1894   FOR_EACH_FRAME (tail, frame)
1895     if (FRAME_NS_P (XFRAME (frame))
1896         && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1897       XFRAME (frame)->mouse_moved = 0;
1899   dpyinfo->last_mouse_scroll_bar = nil;
1900   if (dpyinfo->last_mouse_frame
1901       && FRAME_LIVE_P (dpyinfo->last_mouse_frame))
1902     f = dpyinfo->last_mouse_frame;
1903   else
1904     f = dpyinfo->x_focus_frame ? dpyinfo->x_focus_frame : SELECTED_FRAME ();
1906   if (f && FRAME_NS_P (f))
1907     {
1908       view = FRAME_NS_VIEW (*fp);
1910       position = [[view window] mouseLocationOutsideOfEventStream];
1911       position = [view convertPoint: position fromView: nil];
1912       remember_mouse_glyph (f, position.x, position.y,
1913                             &dpyinfo->last_mouse_glyph);
1914 /*fprintf (stderr, "ns_mouse_position: %.0f, %.0f\n", position.x, position.y); */
1916       if (bar_window) *bar_window = Qnil;
1917       if (part) *part = scroll_bar_above_handle;
1919       if (x) XSETINT (*x, lrint (position.x));
1920       if (y) XSETINT (*y, lrint (position.y));
1921       if (time)
1922         *time = dpyinfo->last_mouse_movement_time;
1923       *fp = f;
1924     }
1926   unblock_input ();
1930 static void
1931 ns_frame_up_to_date (struct frame *f)
1932 /* --------------------------------------------------------------------------
1933     External (hook): Fix up mouse highlighting right after a full update.
1934     Can't use FRAME_MOUSE_UPDATE due to ns_frame_begin and ns_frame_end calls.
1935    -------------------------------------------------------------------------- */
1937   NSTRACE (ns_frame_up_to_date);
1939   if (FRAME_NS_P (f))
1940     {
1941       Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1942       if (f == hlinfo->mouse_face_mouse_frame)
1943         {
1944           block_input ();
1945           ns_update_begin(f);
1946           note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
1947                                 hlinfo->mouse_face_mouse_x,
1948                                 hlinfo->mouse_face_mouse_y);
1949           ns_update_end(f);
1950           unblock_input ();
1951         }
1952     }
1956 static void
1957 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1958 /* --------------------------------------------------------------------------
1959     External (RIF): set frame mouse pointer type.
1960    -------------------------------------------------------------------------- */
1962   NSTRACE (ns_define_frame_cursor);
1963   if (FRAME_POINTER_TYPE (f) != cursor)
1964     {
1965       EmacsView *view = FRAME_NS_VIEW (f);
1966       FRAME_POINTER_TYPE (f) = cursor;
1967       [[view window] invalidateCursorRectsForView: view];
1968       /* Redisplay assumes this function also draws the changed frame
1969          cursor, but this function doesn't, so do it explicitly.  */
1970       x_update_cursor (f, 1);
1971     }
1976 /* ==========================================================================
1978     Keyboard handling
1980    ========================================================================== */
1983 static unsigned
1984 ns_convert_key (unsigned code)
1985 /* --------------------------------------------------------------------------
1986     Internal call used by NSView-keyDown.
1987    -------------------------------------------------------------------------- */
1989   const unsigned last_keysym = ARRAYELTS (convert_ns_to_X_keysym);
1990   unsigned keysym;
1991   /* An array would be faster, but less easy to read. */
1992   for (keysym = 0; keysym < last_keysym; keysym += 2)
1993     if (code == convert_ns_to_X_keysym[keysym])
1994       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
1995   return 0;
1996 /* if decide to use keyCode and Carbon table, use this line:
1997      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
2001 char *
2002 x_get_keysym_name (int keysym)
2003 /* --------------------------------------------------------------------------
2004     Called by keyboard.c.  Not sure if the return val is important, except
2005     that it be unique.
2006    -------------------------------------------------------------------------- */
2008   static char value[16];
2009   NSTRACE (x_get_keysym_name);
2010   sprintf (value, "%d", keysym);
2011   return value;
2016 /* ==========================================================================
2018     Block drawing operations
2020    ========================================================================== */
2023 static void
2024 ns_redraw_scroll_bars (struct frame *f)
2026   int i;
2027   id view;
2028   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
2029   NSTRACE (ns_redraw_scroll_bars);
2030   for (i =[subviews count]-1; i >= 0; i--)
2031     {
2032       view = [subviews objectAtIndex: i];
2033       if (![view isKindOfClass: [EmacsScroller class]]) continue;
2034       [view display];
2035     }
2039 void
2040 ns_clear_frame (struct frame *f)
2041 /* --------------------------------------------------------------------------
2042       External (hook): Erase the entire frame
2043    -------------------------------------------------------------------------- */
2045   NSView *view = FRAME_NS_VIEW (f);
2046   NSRect r;
2048   NSTRACE (ns_clear_frame);
2050  /* comes on initial frame because we have
2051     after-make-frame-functions = select-frame */
2052  if (!FRAME_DEFAULT_FACE (f))
2053    return;
2055   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2057   r = [view bounds];
2059   block_input ();
2060   ns_focus (f, &r, 1);
2061   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
2062   NSRectFill (r);
2063   ns_unfocus (f);
2065   /* as of 2006/11 or so this is now needed */
2066   ns_redraw_scroll_bars (f);
2067   unblock_input ();
2071 static void
2072 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
2073 /* --------------------------------------------------------------------------
2074     External (RIF):  Clear section of frame
2075    -------------------------------------------------------------------------- */
2077   NSRect r = NSMakeRect (x, y, width, height);
2078   NSView *view = FRAME_NS_VIEW (f);
2079   struct face *face = FRAME_DEFAULT_FACE (f);
2081   if (!view || !face)
2082     return;
2084   NSTRACE (ns_clear_frame_area);
2086   r = NSIntersectionRect (r, [view frame]);
2087   ns_focus (f, &r, 1);
2088   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
2090   NSRectFill (r);
2092   ns_unfocus (f);
2093   return;
2096 static void
2097 ns_copy_bits (struct frame *f, NSRect src, NSRect dest)
2099   if (FRAME_NS_VIEW (f))
2100     {
2101       ns_focus (f, &dest, 1);
2102       [FRAME_NS_VIEW (f) scrollRect: src
2103                                  by: NSMakeSize (dest.origin.x - src.origin.x,
2104                                                  dest.origin.y - src.origin.y)];
2105       ns_unfocus (f);
2106     }
2109 static void
2110 ns_scroll_run (struct window *w, struct run *run)
2111 /* --------------------------------------------------------------------------
2112     External (RIF):  Insert or delete n lines at line vpos
2113    -------------------------------------------------------------------------- */
2115   struct frame *f = XFRAME (w->frame);
2116   int x, y, width, height, from_y, to_y, bottom_y;
2118   NSTRACE (ns_scroll_run);
2120   /* begin copy from other terms */
2121   /* Get frame-relative bounding box of the text display area of W,
2122      without mode lines.  Include in this box the left and right
2123      fringe of W.  */
2124   window_box (w, ANY_AREA, &x, &y, &width, &height);
2126   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
2127   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
2128   bottom_y = y + height;
2130   if (to_y < from_y)
2131     {
2132       /* Scrolling up.  Make sure we don't copy part of the mode
2133          line at the bottom.  */
2134       if (from_y + run->height > bottom_y)
2135         height = bottom_y - from_y;
2136       else
2137         height = run->height;
2138     }
2139   else
2140     {
2141       /* Scrolling down.  Make sure we don't copy over the mode line.
2142          at the bottom.  */
2143       if (to_y + run->height > bottom_y)
2144         height = bottom_y - to_y;
2145       else
2146         height = run->height;
2147     }
2148   /* end copy from other terms */
2150   if (height == 0)
2151       return;
2153   block_input ();
2155   x_clear_cursor (w);
2157   {
2158     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2159     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2161     ns_copy_bits (f, srcRect , dstRect);
2162   }
2164   unblock_input ();
2168 static void
2169 ns_after_update_window_line (struct window *w, struct glyph_row *desired_row)
2170 /* --------------------------------------------------------------------------
2171     External (RIF): preparatory to fringe update after text was updated
2172    -------------------------------------------------------------------------- */
2174   struct frame *f;
2175   int width, height;
2177   NSTRACE (ns_after_update_window_line);
2179   /* begin copy from other terms */
2180   eassert (w);
2182   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2183     desired_row->redraw_fringe_bitmaps_p = 1;
2185   /* When a window has disappeared, make sure that no rest of
2186      full-width rows stays visible in the internal border.  */
2187   if (windows_or_buffers_changed
2188       && desired_row->full_width_p
2189       && (f = XFRAME (w->frame),
2190           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2191           width != 0)
2192       && (height = desired_row->visible_height,
2193           height > 0))
2194     {
2195       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2197       block_input ();
2198       ns_clear_frame_area (f, 0, y, width, height);
2199       ns_clear_frame_area (f,
2200                            FRAME_PIXEL_WIDTH (f) - width,
2201                            y, width, height);
2202       unblock_input ();
2203     }
2207 static void
2208 ns_shift_glyphs_for_insert (struct frame *f,
2209                            int x, int y, int width, int height,
2210                            int shift_by)
2211 /* --------------------------------------------------------------------------
2212     External (RIF): copy an area horizontally, don't worry about clearing src
2213    -------------------------------------------------------------------------- */
2215   NSRect srcRect = NSMakeRect (x, y, width, height);
2216   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2218   NSTRACE (ns_shift_glyphs_for_insert);
2220   ns_copy_bits (f, srcRect, dstRect);
2225 /* ==========================================================================
2227     Character encoding and metrics
2229    ========================================================================== */
2232 static void
2233 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2234 /* --------------------------------------------------------------------------
2235      External (RIF); compute left/right overhang of whole string and set in s
2236    -------------------------------------------------------------------------- */
2238   struct font *font = s->font;
2240   if (s->char2b)
2241     {
2242       struct font_metrics metrics;
2243       unsigned int codes[2];
2244       codes[0] = *(s->char2b);
2245       codes[1] = *(s->char2b + s->nchars - 1);
2247       font->driver->text_extents (font, codes, 2, &metrics);
2248       s->left_overhang = -metrics.lbearing;
2249       s->right_overhang
2250         = metrics.rbearing > metrics.width
2251         ? metrics.rbearing - metrics.width : 0;
2252     }
2253   else
2254     {
2255       s->left_overhang = 0;
2256       if (EQ (font->driver->type, Qns))
2257         s->right_overhang = ((struct nsfont_info *)font)->ital ?
2258           FONT_HEIGHT (font) * 0.2 : 0;
2259       else
2260         s->right_overhang = 0;
2261     }
2266 /* ==========================================================================
2268     Fringe and cursor drawing
2270    ========================================================================== */
2273 extern int max_used_fringe_bitmap;
2274 static void
2275 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2276                       struct draw_fringe_bitmap_params *p)
2277 /* --------------------------------------------------------------------------
2278     External (RIF); fringe-related
2279    -------------------------------------------------------------------------- */
2281   struct frame *f = XFRAME (WINDOW_FRAME (w));
2282   struct face *face = p->face;
2283   static EmacsImage **bimgs = NULL;
2284   static int nBimgs = 0;
2286   /* grow bimgs if needed */
2287   if (nBimgs < max_used_fringe_bitmap)
2288     {
2289       bimgs = xrealloc (bimgs, max_used_fringe_bitmap * sizeof *bimgs);
2290       memset (bimgs + nBimgs, 0,
2291               (max_used_fringe_bitmap - nBimgs) * sizeof *bimgs);
2292       nBimgs = max_used_fringe_bitmap;
2293     }
2295   /* Must clip because of partially visible lines.  */
2296   ns_clip_to_row (w, row, ANY_AREA, YES);
2298   if (!p->overlay_p)
2299     {
2300       int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
2302       if (bx >= 0 && nx > 0)
2303         {
2304           NSRect r = NSMakeRect (bx, by, nx, ny);
2305           NSRectClip (r);
2306           [ns_lookup_indexed_color (face->background, f) set];
2307           NSRectFill (r);
2308         }
2309     }
2311   if (p->which)
2312     {
2313       NSRect r = NSMakeRect (p->x, p->y, p->wd, p->h);
2314       EmacsImage *img = bimgs[p->which - 1];
2316       if (!img)
2317         {
2318           unsigned short *bits = p->bits + p->dh;
2319           int len = p->h;
2320           int i;
2321           unsigned char *cbits = xmalloc (len);
2323           for (i = 0; i < len; i++)
2324             cbits[i] = ~(bits[i] & 0xff);
2325           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2326                                              fg: 0 bg: 0];
2327           bimgs[p->which - 1] = img;
2328           xfree (cbits);
2329         }
2331       NSRectClip (r);
2332       /* Since we composite the bitmap instead of just blitting it, we need
2333          to erase the whole background. */
2334       [ns_lookup_indexed_color(face->background, f) set];
2335       NSRectFill (r);
2337       {
2338         NSColor *bm_color;
2339         if (!p->cursor_p)
2340           bm_color = ns_lookup_indexed_color(face->foreground, f);
2341         else if (p->overlay_p)
2342           bm_color = ns_lookup_indexed_color(face->background, f);
2343         else
2344           bm_color = f->output_data.ns->cursor_color;
2345         [img setXBMColor: bm_color];
2346       }
2348 #ifdef NS_IMPL_COCOA
2349       [img drawInRect: r
2350               fromRect: NSZeroRect
2351              operation: NSCompositeSourceOver
2352               fraction: 1.0
2353            respectFlipped: YES
2354                 hints: nil];
2355 #else
2356       {
2357         NSPoint pt = r.origin;
2358         pt.y += p->h;
2359         [img compositeToPoint: pt operation: NSCompositeSourceOver];
2360       }
2361 #endif
2362     }
2363   ns_unfocus (f);
2367 static void
2368 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2369                        int x, int y, enum text_cursor_kinds cursor_type,
2370                        int cursor_width, bool on_p, bool active_p)
2371 /* --------------------------------------------------------------------------
2372      External call (RIF): draw cursor.
2373      Note that CURSOR_WIDTH is meaningful only for (h)bar cursors.
2374    -------------------------------------------------------------------------- */
2376   NSRect r, s;
2377   int fx, fy, h, cursor_height;
2378   struct frame *f = WINDOW_XFRAME (w);
2379   struct glyph *phys_cursor_glyph;
2380   struct glyph *cursor_glyph;
2381   struct face *face;
2382   NSColor *hollow_color = FRAME_BACKGROUND_COLOR (f);
2384   /* If cursor is out of bounds, don't draw garbage.  This can happen
2385      in mini-buffer windows when switching between echo area glyphs
2386      and mini-buffer.  */
2388   NSTRACE (dumpcursor);
2390   if (!on_p)
2391     return;
2393   w->phys_cursor_type = cursor_type;
2394   w->phys_cursor_on_p = on_p;
2396   if (cursor_type == NO_CURSOR)
2397     {
2398       w->phys_cursor_width = 0;
2399       return;
2400     }
2402   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2403     {
2404       if (glyph_row->exact_window_width_line_p
2405           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2406         {
2407           glyph_row->cursor_in_fringe_p = 1;
2408           draw_fringe_bitmap (w, glyph_row, 0);
2409         }
2410       return;
2411     }
2413   /* We draw the cursor (with NSRectFill), then draw the glyph on top
2414      (other terminals do it the other way round).  We must set
2415      w->phys_cursor_width to the cursor width.  For bar cursors, that
2416      is CURSOR_WIDTH; for box cursors, it is the glyph width.  */
2417   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2419   /* The above get_phys_cursor_geometry call set w->phys_cursor_width
2420      to the glyph width; replace with CURSOR_WIDTH for (V)BAR cursors. */
2421   if (cursor_type == BAR_CURSOR)
2422     {
2423       if (cursor_width < 1)
2424         cursor_width = max (FRAME_CURSOR_WIDTH (f), 1);
2425       w->phys_cursor_width = cursor_width;
2426     }
2427   /* If we have an HBAR, "cursor_width" MAY specify height. */
2428   else if (cursor_type == HBAR_CURSOR)
2429     {
2430       cursor_height = (cursor_width < 1) ? lrint (0.25 * h) : cursor_width;
2431       if (cursor_height > glyph_row->height)
2432         cursor_height = glyph_row->height;
2433       if (h > cursor_height) // Cursor smaller than line height, move down
2434         fy += h - cursor_height;
2435       h = cursor_height;
2436     }
2438   r.origin.x = fx, r.origin.y = fy;
2439   r.size.height = h;
2440   r.size.width = w->phys_cursor_width;
2442   /* TODO: only needed in rare cases with last-resort font in HELLO..
2443      should we do this more efficiently? */
2444   ns_clip_to_row (w, glyph_row, ANY_AREA, NO); /* do ns_focus(f, &r, 1); if remove */
2447   face = FACE_FROM_ID (f, phys_cursor_glyph->face_id);
2448   if (face && NS_FACE_BACKGROUND (face)
2449       == ns_index_color (FRAME_CURSOR_COLOR (f), f))
2450     {
2451       [ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), f) set];
2452       hollow_color = FRAME_CURSOR_COLOR (f);
2453     }
2454   else
2455     [FRAME_CURSOR_COLOR (f) set];
2457 #ifdef NS_IMPL_COCOA
2458   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2459            atomic.  Cleaner ways of doing this should be investigated.
2460            One way would be to set a global variable DRAWING_CURSOR
2461            when making the call to draw_phys..(), don't focus in that
2462            case, then move the ns_unfocus() here after that call. */
2463   NSDisableScreenUpdates ();
2464 #endif
2466   switch (cursor_type)
2467     {
2468     case DEFAULT_CURSOR:
2469     case NO_CURSOR:
2470       break;
2471     case FILLED_BOX_CURSOR:
2472       NSRectFill (r);
2473       break;
2474     case HOLLOW_BOX_CURSOR:
2475       NSRectFill (r);
2476       [hollow_color set];
2477       NSRectFill (NSInsetRect (r, 1, 1));
2478       [FRAME_CURSOR_COLOR (f) set];
2479       break;
2480     case HBAR_CURSOR:
2481       NSRectFill (r);
2482       break;
2483     case BAR_CURSOR:
2484       s = r;
2485       /* If the character under cursor is R2L, draw the bar cursor
2486          on the right of its glyph, rather than on the left.  */
2487       cursor_glyph = get_phys_cursor_glyph (w);
2488       if ((cursor_glyph->resolved_level & 1) != 0)
2489         s.origin.x += cursor_glyph->pixel_width - s.size.width;
2491       NSRectFill (s);
2492       break;
2493     }
2494   ns_unfocus (f);
2496   /* draw the character under the cursor */
2497   if (cursor_type != NO_CURSOR)
2498     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2500 #ifdef NS_IMPL_COCOA
2501   NSEnableScreenUpdates ();
2502 #endif
2507 static void
2508 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2509 /* --------------------------------------------------------------------------
2510      External (RIF): Draw a vertical line.
2511    -------------------------------------------------------------------------- */
2513   struct frame *f = XFRAME (WINDOW_FRAME (w));
2514   struct face *face;
2515   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2517   NSTRACE (ns_draw_vertical_window_border);
2519   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2520   if (face)
2521       [ns_lookup_indexed_color(face->foreground, f) set];
2523   ns_focus (f, &r, 1);
2524   NSRectFill(r);
2525   ns_unfocus (f);
2529 static void
2530 ns_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
2531 /* --------------------------------------------------------------------------
2532      External (RIF): Draw a window divider.
2533    -------------------------------------------------------------------------- */
2535   struct frame *f = XFRAME (WINDOW_FRAME (w));
2536   struct face *face;
2537   NSRect r = NSMakeRect (x0, y0, x1-x0, y1-y0);
2539   NSTRACE (ns_draw_window_divider);
2541   face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
2542   if (face)
2543       [ns_lookup_indexed_color(face->foreground, f) set];
2545   ns_focus (f, &r, 1);
2546   NSRectFill(r);
2547   ns_unfocus (f);
2550 static void
2551 ns_show_hourglass (struct frame *f)
2553   /* TODO: add NSProgressIndicator to all frames.  */
2556 static void
2557 ns_hide_hourglass (struct frame *f)
2559   /* TODO: remove NSProgressIndicator from all frames.  */
2562 /* ==========================================================================
2564     Glyph drawing operations
2566    ========================================================================== */
2568 static int
2569 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2570 /* --------------------------------------------------------------------------
2571     Wrapper utility to account for internal border width on full-width lines,
2572     and allow top full-width rows to hit the frame top.  nr should be pointer
2573     to two successive NSRects.  Number of rects actually used is returned.
2574    -------------------------------------------------------------------------- */
2576   int n = get_glyph_string_clip_rects (s, nr, 2);
2577   return n;
2580 /* --------------------------------------------------------------------
2581    Draw a wavy line under glyph string s. The wave fills wave_height
2582    pixels from y.
2584                     x          wave_length = 2
2585                                  --
2586                 y    *   *   *   *   *
2587                      |* * * * * * * * *
2588     wave_height = 3  | *   *   *   *
2589   --------------------------------------------------------------------- */
2591 static void
2592 ns_draw_underwave (struct glyph_string *s, EmacsCGFloat width, EmacsCGFloat x)
2594   int wave_height = 3, wave_length = 2;
2595   int y, dx, dy, odd, xmax;
2596   NSPoint a, b;
2597   NSRect waveClip;
2599   dx = wave_length;
2600   dy = wave_height - 1;
2601   y =  s->ybase - wave_height + 3;
2602   xmax = x + width;
2604   /* Find and set clipping rectangle */
2605   waveClip = NSMakeRect (x, y, width, wave_height);
2606   [[NSGraphicsContext currentContext] saveGraphicsState];
2607   NSRectClip (waveClip);
2609   /* Draw the waves */
2610   a.x = x - ((int)(x) % dx) + (EmacsCGFloat) 0.5;
2611   b.x = a.x + dx;
2612   odd = (int)(a.x/dx) % 2;
2613   a.y = b.y = y + 0.5;
2615   if (odd)
2616     a.y += dy;
2617   else
2618     b.y += dy;
2620   while (a.x <= xmax)
2621     {
2622       [NSBezierPath strokeLineFromPoint:a toPoint:b];
2623       a.x = b.x, a.y = b.y;
2624       b.x += dx, b.y = y + 0.5 + odd*dy;
2625       odd = !odd;
2626     }
2628   /* Restore previous clipping rectangle(s) */
2629   [[NSGraphicsContext currentContext] restoreGraphicsState];
2634 void
2635 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
2636                          NSColor *defaultCol, CGFloat width, CGFloat x)
2637 /* --------------------------------------------------------------------------
2638    Draw underline, overline, and strike-through on glyph string s.
2639    -------------------------------------------------------------------------- */
2641   if (s->for_overlaps)
2642     return;
2644   /* Do underline. */
2645   if (face->underline_p)
2646     {
2647       if (s->face->underline_type == FACE_UNDER_WAVE)
2648         {
2649           if (face->underline_defaulted_p)
2650             [defaultCol set];
2651           else
2652             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2654           ns_draw_underwave (s, width, x);
2655         }
2656       else if (s->face->underline_type == FACE_UNDER_LINE)
2657         {
2659           NSRect r;
2660           unsigned long thickness, position;
2662           /* If the prev was underlined, match its appearance. */
2663           if (s->prev && s->prev->face->underline_p
2664               && s->prev->face->underline_type == FACE_UNDER_LINE
2665               && s->prev->underline_thickness > 0)
2666             {
2667               thickness = s->prev->underline_thickness;
2668               position = s->prev->underline_position;
2669             }
2670           else
2671             {
2672               struct font *font;
2673               unsigned long descent;
2675               font=s->font;
2676               descent = s->y + s->height - s->ybase;
2678               /* Use underline thickness of font, defaulting to 1. */
2679               thickness = (font && font->underline_thickness > 0)
2680                 ? font->underline_thickness : 1;
2682               /* Determine the offset of underlining from the baseline. */
2683               if (x_underline_at_descent_line)
2684                 position = descent - thickness;
2685               else if (x_use_underline_position_properties
2686                        && font && font->underline_position >= 0)
2687                 position = font->underline_position;
2688               else if (font)
2689                 position = lround (font->descent / 2);
2690               else
2691                 position = underline_minimum_offset;
2693               position = max (position, underline_minimum_offset);
2695               /* Ensure underlining is not cropped. */
2696               if (descent <= position)
2697                 {
2698                   position = descent - 1;
2699                   thickness = 1;
2700                 }
2701               else if (descent < position + thickness)
2702                 thickness = 1;
2703             }
2705           s->underline_thickness = thickness;
2706           s->underline_position = position;
2708           r = NSMakeRect (x, s->ybase + position, width, thickness);
2710           if (face->underline_defaulted_p)
2711             [defaultCol set];
2712           else
2713             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2714           NSRectFill (r);
2715         }
2716     }
2717   /* Do overline. We follow other terms in using a thickness of 1
2718      and ignoring overline_margin. */
2719   if (face->overline_p)
2720     {
2721       NSRect r;
2722       r = NSMakeRect (x, s->y, width, 1);
2724       if (face->overline_color_defaulted_p)
2725         [defaultCol set];
2726       else
2727         [ns_lookup_indexed_color (face->overline_color, s->f) set];
2728       NSRectFill (r);
2729     }
2731   /* Do strike-through.  We follow other terms for thickness and
2732      vertical position.*/
2733   if (face->strike_through_p)
2734     {
2735       NSRect r;
2736       unsigned long dy;
2738       dy = lrint ((s->height - 1) / 2);
2739       r = NSMakeRect (x, s->y + dy, width, 1);
2741       if (face->strike_through_color_defaulted_p)
2742         [defaultCol set];
2743       else
2744         [ns_lookup_indexed_color (face->strike_through_color, s->f) set];
2745       NSRectFill (r);
2746     }
2749 static void
2750 ns_draw_box (NSRect r, CGFloat thickness, NSColor *col,
2751              char left_p, char right_p)
2752 /* --------------------------------------------------------------------------
2753     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2754     Note we can't just use an NSDrawRect command, because of the possibility
2755     of some sides not being drawn, and because the rect will be filled.
2756    -------------------------------------------------------------------------- */
2758   NSRect s = r;
2759   [col set];
2761   /* top, bottom */
2762   s.size.height = thickness;
2763   NSRectFill (s);
2764   s.origin.y += r.size.height - thickness;
2765   NSRectFill (s);
2767   s.size.height = r.size.height;
2768   s.origin.y = r.origin.y;
2770   /* left, right (optional) */
2771   s.size.width = thickness;
2772   if (left_p)
2773     NSRectFill (s);
2774   if (right_p)
2775     {
2776       s.origin.x += r.size.width - thickness;
2777       NSRectFill (s);
2778     }
2782 static void
2783 ns_draw_relief (NSRect r, int thickness, char raised_p,
2784                char top_p, char bottom_p, char left_p, char right_p,
2785                struct glyph_string *s)
2786 /* --------------------------------------------------------------------------
2787     Draw a relief rect inside r, optionally leaving some sides open.
2788     Note we can't just use an NSDrawBezel command, because of the possibility
2789     of some sides not being drawn, and because the rect will be filled.
2790    -------------------------------------------------------------------------- */
2792   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2793   NSColor *newBaseCol = nil;
2794   NSRect sr = r;
2796   NSTRACE (ns_draw_relief);
2798   /* set up colors */
2800   if (s->face->use_box_color_for_shadows_p)
2801     {
2802       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2803     }
2804 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2805            && s->img->pixmap
2806            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2807        {
2808          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2809        } */
2810   else
2811     {
2812       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2813     }
2815   if (newBaseCol == nil)
2816     newBaseCol = [NSColor grayColor];
2818   if (newBaseCol != baseCol)  /* TODO: better check */
2819     {
2820       [baseCol release];
2821       baseCol = [newBaseCol retain];
2822       [lightCol release];
2823       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2824       [darkCol release];
2825       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2826     }
2828   [(raised_p ? lightCol : darkCol) set];
2830   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2832   /* top */
2833   sr.size.height = thickness;
2834   if (top_p) NSRectFill (sr);
2836   /* left */
2837   sr.size.height = r.size.height;
2838   sr.size.width = thickness;
2839   if (left_p) NSRectFill (sr);
2841   [(raised_p ? darkCol : lightCol) set];
2843   /* bottom */
2844   sr.size.width = r.size.width;
2845   sr.size.height = thickness;
2846   sr.origin.y += r.size.height - thickness;
2847   if (bottom_p) NSRectFill (sr);
2849   /* right */
2850   sr.size.height = r.size.height;
2851   sr.origin.y = r.origin.y;
2852   sr.size.width = thickness;
2853   sr.origin.x += r.size.width - thickness;
2854   if (right_p) NSRectFill (sr);
2858 static void
2859 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2860 /* --------------------------------------------------------------------------
2861       Function modeled after x_draw_glyph_string_box ().
2862       Sets up parameters for drawing.
2863    -------------------------------------------------------------------------- */
2865   int right_x, last_x;
2866   char left_p, right_p;
2867   struct glyph *last_glyph;
2868   NSRect r;
2869   int thickness;
2870   struct face *face;
2872   if (s->hl == DRAW_MOUSE_FACE)
2873     {
2874       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2875       if (!face)
2876         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2877     }
2878   else
2879     face = s->face;
2881   thickness = face->box_line_width;
2883   NSTRACE (ns_dumpglyphs_box_or_relief);
2885   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2886             ? WINDOW_RIGHT_EDGE_X (s->w)
2887             : window_box_right (s->w, s->area));
2888   last_glyph = (s->cmp || s->img
2889                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2891   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2892               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2894   left_p = (s->first_glyph->left_box_line_p
2895             || (s->hl == DRAW_MOUSE_FACE
2896                 && (s->prev == NULL || s->prev->hl != s->hl)));
2897   right_p = (last_glyph->right_box_line_p
2898              || (s->hl == DRAW_MOUSE_FACE
2899                  && (s->next == NULL || s->next->hl != s->hl)));
2901   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2903   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2904   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2905     {
2906       ns_draw_box (r, abs (thickness),
2907                    ns_lookup_indexed_color (face->box_color, s->f),
2908                   left_p, right_p);
2909     }
2910   else
2911     {
2912       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2913                      1, 1, left_p, right_p, s);
2914     }
2918 static void
2919 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2920 /* --------------------------------------------------------------------------
2921       Modeled after x_draw_glyph_string_background, which draws BG in
2922       certain cases.  Others are left to the text rendering routine.
2923    -------------------------------------------------------------------------- */
2925   NSTRACE (ns_maybe_dumpglyphs_background);
2927   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2928     {
2929       int box_line_width = max (s->face->box_line_width, 0);
2930       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2931           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2932         {
2933           struct face *face;
2934           if (s->hl == DRAW_MOUSE_FACE)
2935             {
2936               face = FACE_FROM_ID (s->f,
2937                                    MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2938               if (!face)
2939                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2940             }
2941           else
2942             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2943           if (!face->stipple)
2944             [(NS_FACE_BACKGROUND (face) != 0
2945               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2946               : FRAME_BACKGROUND_COLOR (s->f)) set];
2947           else
2948             {
2949               struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (s->f);
2950               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2951             }
2953           if (s->hl != DRAW_CURSOR)
2954             {
2955               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2956                                     s->background_width,
2957                                     s->height-2*box_line_width);
2958               NSRectFill (r);
2959             }
2961           s->background_filled_p = 1;
2962         }
2963     }
2967 static void
2968 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2969 /* --------------------------------------------------------------------------
2970       Renders an image and associated borders.
2971    -------------------------------------------------------------------------- */
2973   EmacsImage *img = s->img->pixmap;
2974   int box_line_vwidth = max (s->face->box_line_width, 0);
2975   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2976   int bg_x, bg_y, bg_height;
2977   int th;
2978   char raised_p;
2979   NSRect br;
2980   struct face *face;
2981   NSColor *tdCol;
2983   NSTRACE (ns_dumpglyphs_image);
2985   if (s->face->box != FACE_NO_BOX
2986       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2987     x += abs (s->face->box_line_width);
2989   bg_x = x;
2990   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
2991   bg_height = s->height;
2992   /* other terms have this, but was causing problems w/tabbar mode */
2993   /* - 2 * box_line_vwidth; */
2995   if (s->slice.x == 0) x += s->img->hmargin;
2996   if (s->slice.y == 0) y += s->img->vmargin;
2998   /* Draw BG: if we need larger area than image itself cleared, do that,
2999      otherwise, since we composite the image under NS (instead of mucking
3000      with its background color), we must clear just the image area. */
3001   if (s->hl == DRAW_MOUSE_FACE)
3002     {
3003       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3004       if (!face)
3005        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3006     }
3007   else
3008     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3010   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
3012   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
3013       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
3014     {
3015       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
3016       s->background_filled_p = 1;
3017     }
3018   else
3019     {
3020       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
3021     }
3023   NSRectFill (br);
3025   /* Draw the image.. do we need to draw placeholder if img ==nil? */
3026   if (img != nil)
3027     {
3028 #ifdef NS_IMPL_COCOA
3029       NSRect dr = NSMakeRect (x, y, s->slice.width, s->slice.height);
3030       NSRect ir = NSMakeRect (s->slice.x, s->slice.y,
3031                               s->slice.width, s->slice.height);
3032       [img drawInRect: dr
3033              fromRect: ir
3034              operation: NSCompositeSourceOver
3035               fraction: 1.0
3036            respectFlipped: YES
3037                 hints: nil];
3038 #else
3039       [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
3040                   operation: NSCompositeSourceOver];
3041 #endif
3042     }
3044   if (s->hl == DRAW_CURSOR)
3045     {
3046     [FRAME_CURSOR_COLOR (s->f) set];
3047     if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3048       tdCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3049     else
3050       /* Currently on NS img->mask is always 0. Since
3051          get_window_cursor_type specifies a hollow box cursor when on
3052          a non-masked image we never reach this clause. But we put it
3053          in in anticipation of better support for image masks on
3054          NS. */
3055       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3056     }
3057   else
3058     {
3059       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3060     }
3062   /* Draw underline, overline, strike-through. */
3063   ns_draw_text_decoration (s, face, tdCol, br.size.width, br.origin.x);
3065   /* Draw relief, if requested */
3066   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
3067     {
3068       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
3069         {
3070           th = tool_bar_button_relief >= 0 ?
3071             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
3072           raised_p = (s->hl == DRAW_IMAGE_RAISED);
3073         }
3074       else
3075         {
3076           th = abs (s->img->relief);
3077           raised_p = (s->img->relief > 0);
3078         }
3080       r.origin.x = x - th;
3081       r.origin.y = y - th;
3082       r.size.width = s->slice.width + 2*th-1;
3083       r.size.height = s->slice.height + 2*th-1;
3084       ns_draw_relief (r, th, raised_p,
3085                       s->slice.y == 0,
3086                       s->slice.y + s->slice.height == s->img->height,
3087                       s->slice.x == 0,
3088                       s->slice.x + s->slice.width == s->img->width, s);
3089     }
3091   /* If there is no mask, the background won't be seen,
3092      so draw a rectangle on the image for the cursor.
3093      Do this for all images, getting transparency right is not reliable.  */
3094   if (s->hl == DRAW_CURSOR)
3095     {
3096       int thickness = abs (s->img->relief);
3097       if (thickness == 0) thickness = 1;
3098       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
3099     }
3103 static void
3104 ns_dumpglyphs_stretch (struct glyph_string *s)
3106   NSRect r[2];
3107   int n, i;
3108   struct face *face;
3109   NSColor *fgCol, *bgCol;
3111   if (!s->background_filled_p)
3112     {
3113       n = ns_get_glyph_string_clip_rect (s, r);
3114       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
3116       ns_focus (s->f, r, n);
3118       if (s->hl == DRAW_MOUSE_FACE)
3119        {
3120          face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3121          if (!face)
3122            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3123        }
3124       else
3125        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3127       bgCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3128       fgCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3130       for (i = 0; i < n; ++i)
3131         {
3132           if (!s->row->full_width_p)
3133             {
3134               int overrun, leftoverrun;
3136               /* truncate to avoid overwriting fringe and/or scrollbar */
3137               overrun = max (0, (s->x + s->background_width)
3138                              - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
3139                                 - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
3140               r[i].size.width -= overrun;
3142               /* truncate to avoid overwriting to left of the window box */
3143               leftoverrun = (WINDOW_BOX_LEFT_EDGE_X (s->w)
3144                              + WINDOW_LEFT_FRINGE_WIDTH (s->w)) - s->x;
3146               if (leftoverrun > 0)
3147                 {
3148                   r[i].origin.x += leftoverrun;
3149                   r[i].size.width -= leftoverrun;
3150                 }
3152               /* XXX: Try to work between problem where a stretch glyph on
3153                  a partially-visible bottom row will clear part of the
3154                  modeline, and another where list-buffers headers and similar
3155                  rows erroneously have visible_height set to 0.  Not sure
3156                  where this is coming from as other terms seem not to show. */
3157               r[i].size.height = min (s->height, s->row->visible_height);
3158             }
3160           [bgCol set];
3162           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
3163              overwriting cursor (usually when cursor on a tab) */
3164           if (s->hl == DRAW_CURSOR)
3165             {
3166               CGFloat x, width;
3168               x = r[i].origin.x;
3169               width = s->w->phys_cursor_width;
3170               r[i].size.width -= width;
3171               r[i].origin.x += width;
3173               NSRectFill (r[i]);
3175               /* Draw overlining, etc. on the cursor. */
3176               if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3177                 ns_draw_text_decoration (s, face, bgCol, width, x);
3178               else
3179                 ns_draw_text_decoration (s, face, fgCol, width, x);
3180             }
3181           else
3182             {
3183               NSRectFill (r[i]);
3184             }
3186           /* Draw overlining, etc. on the stretch glyph (or the part
3187              of the stretch glyph after the cursor). */
3188           ns_draw_text_decoration (s, face, fgCol, r[i].size.width,
3189                                    r[i].origin.x);
3190         }
3191       ns_unfocus (s->f);
3192       s->background_filled_p = 1;
3193     }
3197 static void
3198 ns_draw_composite_glyph_string_foreground (struct glyph_string *s)
3200   int i, j, x;
3201   struct font *font = s->font;
3203   /* If first glyph of S has a left box line, start drawing the text
3204      of S to the right of that box line.  */
3205   if (s->face && s->face->box != FACE_NO_BOX
3206       && s->first_glyph->left_box_line_p)
3207     x = s->x + eabs (s->face->box_line_width);
3208   else
3209     x = s->x;
3211   /* S is a glyph string for a composition.  S->cmp_from is the index
3212      of the first character drawn for glyphs of this composition.
3213      S->cmp_from == 0 means we are drawing the very first character of
3214      this composition.  */
3216   /* Draw a rectangle for the composition if the font for the very
3217      first character of the composition could not be loaded.  */
3218   if (s->font_not_found_p)
3219     {
3220       if (s->cmp_from == 0)
3221         {
3222           NSRect r = NSMakeRect (s->x, s->y, s->width-1, s->height -1);
3223           ns_draw_box (r, 1, FRAME_CURSOR_COLOR (s->f), 1, 1);
3224         }
3225     }
3226   else if (! s->first_glyph->u.cmp.automatic)
3227     {
3228       int y = s->ybase;
3230       for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
3231         /* TAB in a composition means display glyphs with padding
3232            space on the left or right.  */
3233         if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
3234           {
3235             int xx = x + s->cmp->offsets[j * 2];
3236             int yy = y - s->cmp->offsets[j * 2 + 1];
3238             font->driver->draw (s, j, j + 1, xx, yy, false);
3239             if (s->face->overstrike)
3240               font->driver->draw (s, j, j + 1, xx + 1, yy, false);
3241           }
3242     }
3243   else
3244     {
3245       Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
3246       Lisp_Object glyph;
3247       int y = s->ybase;
3248       int width = 0;
3250       for (i = j = s->cmp_from; i < s->cmp_to; i++)
3251         {
3252           glyph = LGSTRING_GLYPH (gstring, i);
3253           if (NILP (LGLYPH_ADJUSTMENT (glyph)))
3254             width += LGLYPH_WIDTH (glyph);
3255           else
3256             {
3257               int xoff, yoff, wadjust;
3259               if (j < i)
3260                 {
3261                   font->driver->draw (s, j, i, x, y, false);
3262                   if (s->face->overstrike)
3263                     font->driver->draw (s, j, i, x + 1, y, false);
3264                   x += width;
3265                 }
3266               xoff = LGLYPH_XOFF (glyph);
3267               yoff = LGLYPH_YOFF (glyph);
3268               wadjust = LGLYPH_WADJUST (glyph);
3269               font->driver->draw (s, i, i + 1, x + xoff, y + yoff, false);
3270               if (s->face->overstrike)
3271                 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff,
3272                                     false);
3273               x += wadjust;
3274               j = i + 1;
3275               width = 0;
3276             }
3277         }
3278       if (j < i)
3279         {
3280           font->driver->draw (s, j, i, x, y, false);
3281           if (s->face->overstrike)
3282             font->driver->draw (s, j, i, x + 1, y, false);
3283         }
3284     }
3287 static void
3288 ns_draw_glyph_string (struct glyph_string *s)
3289 /* --------------------------------------------------------------------------
3290       External (RIF): Main draw-text call.
3291    -------------------------------------------------------------------------- */
3293   /* TODO (optimize): focus for box and contents draw */
3294   NSRect r[2];
3295   int n, flags;
3296   char box_drawn_p = 0;
3297   struct font *font = s->face->font;
3298   if (! font) font = FRAME_FONT (s->f);
3300   NSTRACE (ns_draw_glyph_string);
3302   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
3303     {
3304       int width;
3305       struct glyph_string *next;
3307       for (width = 0, next = s->next;
3308            next && width < s->right_overhang;
3309            width += next->width, next = next->next)
3310         if (next->first_glyph->type != IMAGE_GLYPH)
3311           {
3312             if (next->first_glyph->type != STRETCH_GLYPH)
3313               {
3314                 n = ns_get_glyph_string_clip_rect (s->next, r);
3315                 ns_focus (s->f, r, n);
3316                 ns_maybe_dumpglyphs_background (s->next, 1);
3317                 ns_unfocus (s->f);
3318               }
3319             else
3320               {
3321                 ns_dumpglyphs_stretch (s->next);
3322               }
3323             next->num_clips = 0;
3324           }
3325     }
3327   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
3328         && (s->first_glyph->type == CHAR_GLYPH
3329             || s->first_glyph->type == COMPOSITE_GLYPH))
3330     {
3331       n = ns_get_glyph_string_clip_rect (s, r);
3332       ns_focus (s->f, r, n);
3333       ns_maybe_dumpglyphs_background (s, 1);
3334       ns_dumpglyphs_box_or_relief (s);
3335       ns_unfocus (s->f);
3336       box_drawn_p = 1;
3337     }
3339   switch (s->first_glyph->type)
3340     {
3342     case IMAGE_GLYPH:
3343       n = ns_get_glyph_string_clip_rect (s, r);
3344       ns_focus (s->f, r, n);
3345       ns_dumpglyphs_image (s, r[0]);
3346       ns_unfocus (s->f);
3347       break;
3349     case STRETCH_GLYPH:
3350       ns_dumpglyphs_stretch (s);
3351       break;
3353     case CHAR_GLYPH:
3354     case COMPOSITE_GLYPH:
3355       n = ns_get_glyph_string_clip_rect (s, r);
3356       ns_focus (s->f, r, n);
3358       if (s->for_overlaps || (s->cmp_from > 0
3359                               && ! s->first_glyph->u.cmp.automatic))
3360         s->background_filled_p = 1;
3361       else
3362         ns_maybe_dumpglyphs_background
3363           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3365       flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
3366         (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
3367          (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
3368           NS_DUMPGLYPH_NORMAL));
3370       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3371         {
3372           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3373           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3374           NS_FACE_FOREGROUND (s->face) = tmp;
3375         }
3377       {
3378         BOOL isComposite = s->first_glyph->type == COMPOSITE_GLYPH;
3380         if (isComposite)
3381           ns_draw_composite_glyph_string_foreground (s);
3382         else
3383           font->driver->draw
3384             (s, s->cmp_from, s->nchars, s->x, s->ybase,
3385              (flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
3386              || flags == NS_DUMPGLYPH_MOUSEFACE);
3387       }
3389       {
3390         NSColor *col = (NS_FACE_FOREGROUND (s->face) != 0
3391                         ? ns_lookup_indexed_color (NS_FACE_FOREGROUND (s->face),
3392                                                    s->f)
3393                         : FRAME_FOREGROUND_COLOR (s->f));
3394         [col set];
3396         /* Draw underline, overline, strike-through. */
3397         ns_draw_text_decoration (s, s->face, col, s->width, s->x);
3398       }
3400       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3401         {
3402           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3403           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3404           NS_FACE_FOREGROUND (s->face) = tmp;
3405         }
3407       ns_unfocus (s->f);
3408       break;
3410     case GLYPHLESS_GLYPH:
3411       n = ns_get_glyph_string_clip_rect (s, r);
3412       ns_focus (s->f, r, n);
3414       if (s->for_overlaps || (s->cmp_from > 0
3415                               && ! s->first_glyph->u.cmp.automatic))
3416         s->background_filled_p = 1;
3417       else
3418         ns_maybe_dumpglyphs_background
3419           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3420       /* ... */
3421       /* Not yet implemented.  */
3422       /* ... */
3423       ns_unfocus (s->f);
3424       break;
3426     default:
3427       emacs_abort ();
3428     }
3430   /* Draw box if not done already. */
3431   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3432     {
3433       n = ns_get_glyph_string_clip_rect (s, r);
3434       ns_focus (s->f, r, n);
3435       ns_dumpglyphs_box_or_relief (s);
3436       ns_unfocus (s->f);
3437     }
3439   s->num_clips = 0;
3444 /* ==========================================================================
3446     Event loop
3448    ========================================================================== */
3451 static void
3452 ns_send_appdefined (int value)
3453 /* --------------------------------------------------------------------------
3454     Internal: post an appdefined event which EmacsApp-sendEvent will
3455               recognize and take as a command to halt the event loop.
3456    -------------------------------------------------------------------------- */
3458   /*NSTRACE (ns_send_appdefined); */
3460 #ifdef NS_IMPL_GNUSTEP
3461   // GNUstep needs postEvent to happen on the main thread.
3462   if (! [[NSThread currentThread] isMainThread])
3463     {
3464       EmacsApp *app = (EmacsApp *)NSApp;
3465       app->nextappdefined = value;
3466       [app performSelectorOnMainThread:@selector (sendFromMainThread:)
3467                             withObject:nil
3468                          waitUntilDone:YES];
3469       return;
3470     }
3471 #endif
3473   /* Only post this event if we haven't already posted one.  This will end
3474        the [NXApp run] main loop after having processed all events queued at
3475        this moment.  */
3477 #ifdef NS_IMPL_COCOA
3478   if (! send_appdefined)
3479     {
3480       /* OSX 10.10.1 swallows the AppDefined event we are sending ourselves
3481          in certain situations (rapid incoming events).
3482          So check if we have one, if not add one.  */
3483       NSEvent *appev = [NSApp nextEventMatchingMask:NSApplicationDefinedMask
3484                                           untilDate:[NSDate distantPast]
3485                                              inMode:NSDefaultRunLoopMode
3486                                             dequeue:NO];
3487       if (! appev) send_appdefined = YES;
3488     }
3489 #endif
3491   if (send_appdefined)
3492     {
3493       NSEvent *nxev;
3495       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3496       send_appdefined = NO;
3498       /* Don't need wakeup timer any more */
3499       if (timed_entry)
3500         {
3501           [timed_entry invalidate];
3502           [timed_entry release];
3503           timed_entry = nil;
3504         }
3506       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3507                                 location: NSMakePoint (0, 0)
3508                            modifierFlags: 0
3509                                timestamp: 0
3510                             windowNumber: [[NSApp mainWindow] windowNumber]
3511                                  context: [NSApp context]
3512                                  subtype: 0
3513                                    data1: value
3514                                    data2: 0];
3516       /* Post an application defined event on the event queue.  When this is
3517          received the [NXApp run] will return, thus having processed all
3518          events which are currently queued.  */
3519       [NSApp postEvent: nxev atStart: NO];
3520     }
3523 #ifdef HAVE_NATIVE_FS
3524 static void
3525 check_native_fs ()
3527   Lisp_Object frame, tail;
3529   if (ns_last_use_native_fullscreen == ns_use_native_fullscreen)
3530     return;
3532   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
3534   FOR_EACH_FRAME (tail, frame)
3535     {
3536       struct frame *f = XFRAME (frame);
3537       if (FRAME_NS_P (f))
3538         {
3539           EmacsView *view = FRAME_NS_VIEW (f);
3540           [view updateCollectionBehavior];
3541         }
3542     }
3544 #endif
3546 /* GNUstep does not have cancelTracking.  */
3547 #ifdef NS_IMPL_COCOA
3548 /* Check if menu open should be canceled or continued as normal.  */
3549 void
3550 ns_check_menu_open (NSMenu *menu)
3552   /* Click in menu bar? */
3553   NSArray *a = [[NSApp mainMenu] itemArray];
3554   int i;
3555   BOOL found = NO;
3557   if (menu == nil) // Menu tracking ended.
3558     {
3559       if (menu_will_open_state == MENU_OPENING)
3560         menu_will_open_state = MENU_NONE;
3561       return;
3562     }
3564   for (i = 0; ! found && i < [a count]; i++)
3565     found = menu == [[a objectAtIndex:i] submenu];
3566   if (found)
3567     {
3568       if (menu_will_open_state == MENU_NONE && emacs_event)
3569         {
3570           NSEvent *theEvent = [NSApp currentEvent];
3571           struct frame *emacsframe = SELECTED_FRAME ();
3573           [menu cancelTracking];
3574           menu_will_open_state = MENU_PENDING;
3575           emacs_event->kind = MENU_BAR_ACTIVATE_EVENT;
3576           EV_TRAILER (theEvent);
3578           CGEventRef ourEvent = CGEventCreate (NULL);
3579           menu_mouse_point = CGEventGetLocation (ourEvent);
3580           CFRelease (ourEvent);
3581         }
3582       else if (menu_will_open_state == MENU_OPENING)
3583         {
3584           menu_will_open_state = MENU_NONE;
3585         }
3586     }
3589 /* Redo saved menu click if state is MENU_PENDING.  */
3590 void
3591 ns_check_pending_open_menu ()
3593   if (menu_will_open_state == MENU_PENDING)
3594     {
3595       CGEventSourceRef source
3596         = CGEventSourceCreate (kCGEventSourceStateHIDSystemState);
3598       CGEventRef event = CGEventCreateMouseEvent (source,
3599                                                   kCGEventLeftMouseDown,
3600                                                   menu_mouse_point,
3601                                                   kCGMouseButtonLeft);
3602       CGEventSetType (event, kCGEventLeftMouseDown);
3603       CGEventPost (kCGHIDEventTap, event);
3604       CFRelease (event);
3605       CFRelease (source);
3607       menu_will_open_state = MENU_OPENING;
3608     }
3610 #endif /* NS_IMPL_COCOA */
3612 static void
3613 unwind_apploopnr (Lisp_Object not_used)
3615   --apploopnr;
3616   n_emacs_events_pending = 0;
3617   ns_finish_events ();
3618   q_event_ptr = NULL;
3621 static int
3622 ns_read_socket (struct terminal *terminal, struct input_event *hold_quit)
3623 /* --------------------------------------------------------------------------
3624      External (hook): Post an event to ourself and keep reading events until
3625      we read it back again.  In effect process all events which were waiting.
3626      From 21+ we have to manage the event buffer ourselves.
3627    -------------------------------------------------------------------------- */
3629   struct input_event ev;
3630   int nevents;
3632 /* NSTRACE (ns_read_socket); */
3634 #ifdef HAVE_NATIVE_FS
3635   check_native_fs ();
3636 #endif
3638   if ([NSApp modalWindow] != nil)
3639     return -1;
3641   if (hold_event_q.nr > 0)
3642     {
3643       int i;
3644       for (i = 0; i < hold_event_q.nr; ++i)
3645         kbd_buffer_store_event_hold (&hold_event_q.q[i], hold_quit);
3646       hold_event_q.nr = 0;
3647       return i;
3648     }
3650   block_input ();
3651   n_emacs_events_pending = 0;
3652   ns_init_events (&ev);
3653   q_event_ptr = hold_quit;
3655   /* we manage autorelease pools by allocate/reallocate each time around
3656      the loop; strict nesting is occasionally violated but seems not to
3657      matter.. earlier methods using full nesting caused major memory leaks */
3658   [outerpool release];
3659   outerpool = [[NSAutoreleasePool alloc] init];
3661   /* If have pending open-file requests, attend to the next one of those. */
3662   if (ns_pending_files && [ns_pending_files count] != 0
3663       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3664     {
3665       [ns_pending_files removeObjectAtIndex: 0];
3666     }
3667   /* Deal with pending service requests. */
3668   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3669     && [(EmacsApp *)
3670          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3671                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3672     {
3673       [ns_pending_service_names removeObjectAtIndex: 0];
3674       [ns_pending_service_args removeObjectAtIndex: 0];
3675     }
3676   else
3677     {
3678       ptrdiff_t specpdl_count = SPECPDL_INDEX ();
3679       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3680          to ourself, otherwise [NXApp run] will never exit.  */
3681       send_appdefined = YES;
3682       ns_send_appdefined (-1);
3684       if (++apploopnr != 1)
3685         {
3686           emacs_abort ();
3687         }
3688       record_unwind_protect (unwind_apploopnr, Qt);
3689       [NSApp run];
3690       unbind_to (specpdl_count, Qnil);  /* calls unwind_apploopnr */
3691     }
3693   nevents = n_emacs_events_pending;
3694   n_emacs_events_pending = 0;
3695   ns_finish_events ();
3696   q_event_ptr = NULL;
3697   unblock_input ();
3699   return nevents;
3704 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3705            fd_set *exceptfds, struct timespec const *timeout,
3706            sigset_t const *sigmask)
3707 /* --------------------------------------------------------------------------
3708      Replacement for select, checking for events
3709    -------------------------------------------------------------------------- */
3711   int result;
3712   int t, k, nr = 0;
3713   struct input_event event;
3714   char c;
3716 /*  NSTRACE (ns_select); */
3718 #ifdef HAVE_NATIVE_FS
3719   check_native_fs ();
3720 #endif
3722   if (hold_event_q.nr > 0)
3723     {
3724       /* We already have events pending. */
3725       raise (SIGIO);
3726       errno = EINTR;
3727       return -1;
3728     }
3730   for (k = 0; k < nfds+1; k++)
3731     {
3732       if (readfds && FD_ISSET(k, readfds)) ++nr;
3733       if (writefds && FD_ISSET(k, writefds)) ++nr;
3734     }
3736   if (NSApp == nil
3737       || (timeout && timeout->tv_sec == 0 && timeout->tv_nsec == 0))
3738     return pselect (nfds, readfds, writefds, exceptfds, timeout, sigmask);
3740   [outerpool release];
3741   outerpool = [[NSAutoreleasePool alloc] init];
3744   send_appdefined = YES;
3745   if (nr > 0)
3746     {
3747       pthread_mutex_lock (&select_mutex);
3748       select_nfds = nfds;
3749       select_valid = 0;
3750       if (readfds)
3751         {
3752           select_readfds = *readfds;
3753           select_valid += SELECT_HAVE_READ;
3754         }
3755       if (writefds)
3756         {
3757           select_writefds = *writefds;
3758           select_valid += SELECT_HAVE_WRITE;
3759         }
3761       if (timeout)
3762         {
3763           select_timeout = *timeout;
3764           select_valid += SELECT_HAVE_TMO;
3765         }
3767       pthread_mutex_unlock (&select_mutex);
3769       /* Inform fd_handler that select should be called */
3770       c = 'g';
3771       emacs_write_sig (selfds[1], &c, 1);
3772     }
3773   else if (nr == 0 && timeout)
3774     {
3775       /* No file descriptor, just a timeout, no need to wake fd_handler  */
3776       double time = timespectod (*timeout);
3777       timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3778                                                       target: NSApp
3779                                                     selector:
3780                                   @selector (timeout_handler:)
3781                                                     userInfo: 0
3782                                                      repeats: NO]
3783                       retain];
3784     }
3785   else /* No timeout and no file descriptors, can this happen?  */
3786     {
3787       /* Send appdefined so we exit from the loop */
3788       ns_send_appdefined (-1);
3789     }
3791   block_input ();
3792   ns_init_events (&event);
3793   if (++apploopnr != 1)
3794     {
3795       emacs_abort ();
3796     }
3798   {
3799     ptrdiff_t specpdl_count = SPECPDL_INDEX ();
3800     record_unwind_protect (unwind_apploopnr, Qt);
3801     [NSApp run];
3802     unbind_to (specpdl_count, Qnil);  /* calls unwind_apploopnr */
3803   }
3805   ns_finish_events ();
3806   if (nr > 0 && readfds)
3807     {
3808       c = 's';
3809       emacs_write_sig (selfds[1], &c, 1);
3810     }
3811   unblock_input ();
3813   t = last_appdefined_event_data;
3815   if (t != NO_APPDEFINED_DATA)
3816     {
3817       last_appdefined_event_data = NO_APPDEFINED_DATA;
3819       if (t == -2)
3820         {
3821           /* The NX_APPDEFINED event we received was a timeout. */
3822           result = 0;
3823         }
3824       else if (t == -1)
3825         {
3826           /* The NX_APPDEFINED event we received was the result of
3827              at least one real input event arriving.  */
3828           errno = EINTR;
3829           result = -1;
3830         }
3831       else
3832         {
3833           /* Received back from select () in fd_handler; copy the results */
3834           pthread_mutex_lock (&select_mutex);
3835           if (readfds) *readfds = select_readfds;
3836           if (writefds) *writefds = select_writefds;
3837           pthread_mutex_unlock (&select_mutex);
3838           result = t;
3839         }
3840     }
3841   else
3842     {
3843       errno = EINTR;
3844       result = -1;
3845     }
3847   return result;
3852 /* ==========================================================================
3854     Scrollbar handling
3856    ========================================================================== */
3859 static void
3860 ns_set_vertical_scroll_bar (struct window *window,
3861                            int portion, int whole, int position)
3862 /* --------------------------------------------------------------------------
3863       External (hook): Update or add scrollbar
3864    -------------------------------------------------------------------------- */
3866   Lisp_Object win;
3867   NSRect r, v;
3868   struct frame *f = XFRAME (WINDOW_FRAME (window));
3869   EmacsView *view = FRAME_NS_VIEW (f);
3870   EmacsScroller *bar;
3871   int window_y, window_height;
3872   int top, left, height, width;
3873   BOOL update_p = YES;
3875   /* optimization; display engine sends WAY too many of these.. */
3876   if (!NILP (window->vertical_scroll_bar))
3877     {
3878       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3879       if ([bar checkSamePosition: position portion: portion whole: whole])
3880         {
3881           if (view->scrollbarsNeedingUpdate == 0)
3882             {
3883               if (!windows_or_buffers_changed)
3884                   return;
3885             }
3886           else
3887             view->scrollbarsNeedingUpdate--;
3888           update_p = NO;
3889         }
3890     }
3892   NSTRACE (ns_set_vertical_scroll_bar);
3894   /* Get dimensions.  */
3895   window_box (window, ANY_AREA, 0, &window_y, 0, &window_height);
3896   top = window_y;
3897   height = window_height;
3898   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3899   left = WINDOW_SCROLL_BAR_AREA_X (window);
3901   r = NSMakeRect (left, top, width, height);
3902   /* the parent view is flipped, so we need to flip y value */
3903   v = [view frame];
3904   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3906   XSETWINDOW (win, window);
3907   block_input ();
3909   /* we want at least 5 lines to display a scrollbar */
3910   if (WINDOW_TOTAL_LINES (window) < 5)
3911     {
3912       if (!NILP (window->vertical_scroll_bar))
3913         {
3914           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3915           [bar removeFromSuperview];
3916           wset_vertical_scroll_bar (window, Qnil);
3917           [bar release];
3918         }
3919       ns_clear_frame_area (f, left, top, width, height);
3920       unblock_input ();
3921       return;
3922     }
3924   if (NILP (window->vertical_scroll_bar))
3925     {
3926       if (width > 0 && height > 0)
3927         ns_clear_frame_area (f, left, top, width, height);
3929       bar = [[EmacsScroller alloc] initFrame: r window: win];
3930       wset_vertical_scroll_bar (window, make_save_ptr (bar));
3931       update_p = YES;
3932     }
3933   else
3934     {
3935       NSRect oldRect;
3936       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3937       oldRect = [bar frame];
3938       r.size.width = oldRect.size.width;
3939       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3940         {
3941           if (oldRect.origin.x != r.origin.x)
3942               ns_clear_frame_area (f, left, top, width, height);
3943           [bar setFrame: r];
3944         }
3945     }
3947   if (update_p)
3948     [bar setPosition: position portion: portion whole: whole];
3949   unblock_input ();
3953 static void
3954 ns_set_horizontal_scroll_bar (struct window *window,
3955                               int portion, int whole, int position)
3956 /* --------------------------------------------------------------------------
3957       External (hook): Update or add scrollbar
3958    -------------------------------------------------------------------------- */
3960   Lisp_Object win;
3961   NSRect r, v;
3962   struct frame *f = XFRAME (WINDOW_FRAME (window));
3963   EmacsView *view = FRAME_NS_VIEW (f);
3964   EmacsScroller *bar;
3965   int top, height, left, width;
3966   int window_x, window_width;
3967   BOOL update_p = YES;
3969   /* optimization; display engine sends WAY too many of these.. */
3970   if (!NILP (window->horizontal_scroll_bar))
3971     {
3972       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
3973       if ([bar checkSamePosition: position portion: portion whole: whole])
3974         {
3975           if (view->scrollbarsNeedingUpdate == 0)
3976             {
3977               if (!windows_or_buffers_changed)
3978                   return;
3979             }
3980           else
3981             view->scrollbarsNeedingUpdate--;
3982           update_p = NO;
3983         }
3984     }
3986   NSTRACE (ns_set_horizontal_scroll_bar);
3988   /* Get dimensions.  */
3989   window_box (window, ANY_AREA, 0, &window_x, &window_width, 0);
3990   left = window_x;
3991   width = window_width;
3992   height = WINDOW_CONFIG_SCROLL_BAR_LINES (window) * FRAME_LINE_HEIGHT (f);
3993   top = WINDOW_SCROLL_BAR_AREA_Y (window);
3995   r = NSMakeRect (left, top, width, height);
3996   /* the parent view is flipped, so we need to flip y value */
3997   v = [view frame];
3998   /* ??????? PXW/scrollbars !!!!!!!!!!!!!!!!!!!! */
3999   r.origin.y = (v.size.height - r.size.height - r.origin.y);
4001   XSETWINDOW (win, window);
4002   block_input ();
4004   if (WINDOW_TOTAL_COLS (window) < 5)
4005     {
4006       if (!NILP (window->horizontal_scroll_bar))
4007         {
4008           bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
4009           [bar removeFromSuperview];
4010           wset_horizontal_scroll_bar (window, Qnil);
4011         }
4012       ns_clear_frame_area (f, left, top, width, height);
4013       unblock_input ();
4014       return;
4015     }
4017   if (NILP (window->horizontal_scroll_bar))
4018     {
4019       if (width > 0 && height > 0)
4020         ns_clear_frame_area (f, left, top, width, height);
4022       bar = [[EmacsScroller alloc] initFrame: r window: win];
4023       wset_horizontal_scroll_bar (window, make_save_ptr (bar));
4024       update_p = YES;
4025     }
4026   else
4027     {
4028       NSRect oldRect;
4029       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
4030       oldRect = [bar frame];
4031       r.size.width = oldRect.size.width;
4032       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
4033         {
4034           if (oldRect.origin.x != r.origin.x)
4035               ns_clear_frame_area (f, left, top, width, height);
4036           [bar setFrame: r];
4037           update_p = YES;
4038         }
4039     }
4041   if (update_p)
4042     [bar setPosition: position portion: portion whole: whole];
4043   unblock_input ();
4047 static void
4048 ns_condemn_scroll_bars (struct frame *f)
4049 /* --------------------------------------------------------------------------
4050      External (hook): arrange for all frame's scrollbars to be removed
4051      at next call to judge_scroll_bars, except for those redeemed.
4052    -------------------------------------------------------------------------- */
4054   int i;
4055   id view;
4056   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
4058   NSTRACE (ns_condemn_scroll_bars);
4060   for (i =[subviews count]-1; i >= 0; i--)
4061     {
4062       view = [subviews objectAtIndex: i];
4063       if ([view isKindOfClass: [EmacsScroller class]])
4064         [view condemn];
4065     }
4069 static void
4070 ns_redeem_scroll_bar (struct window *window)
4071 /* --------------------------------------------------------------------------
4072      External (hook): arrange to spare this window's scrollbar
4073      at next call to judge_scroll_bars.
4074    -------------------------------------------------------------------------- */
4076   id bar;
4077   NSTRACE (ns_redeem_scroll_bar);
4078   if (!NILP (window->vertical_scroll_bar))
4079     {
4080       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
4081       [bar reprieve];
4082     }
4084   if (!NILP (window->horizontal_scroll_bar))
4085     {
4086       bar = XNS_SCROLL_BAR (window->horizontal_scroll_bar);
4087       [bar reprieve];
4088     }
4092 static void
4093 ns_judge_scroll_bars (struct frame *f)
4094 /* --------------------------------------------------------------------------
4095      External (hook): destroy all scrollbars on frame that weren't
4096      redeemed after call to condemn_scroll_bars.
4097    -------------------------------------------------------------------------- */
4099   int i;
4100   id view;
4101   EmacsView *eview = FRAME_NS_VIEW (f);
4102   NSArray *subviews = [[eview superview] subviews];
4103   BOOL removed = NO;
4105   NSTRACE (ns_judge_scroll_bars);
4106   for (i = [subviews count]-1; i >= 0; --i)
4107     {
4108       view = [subviews objectAtIndex: i];
4109       if (![view isKindOfClass: [EmacsScroller class]]) continue;
4110       if ([view judge])
4111         removed = YES;
4112     }
4114   if (removed)
4115     [eview updateFrameSize: NO];
4118 /* ==========================================================================
4120     Initialization
4122    ========================================================================== */
4125 x_display_pixel_height (struct ns_display_info *dpyinfo)
4127   NSArray *screens = [NSScreen screens];
4128   NSEnumerator *enumerator = [screens objectEnumerator];
4129   NSScreen *screen;
4130   NSRect frame;
4132   frame = NSZeroRect;
4133   while ((screen = [enumerator nextObject]) != nil)
4134     frame = NSUnionRect (frame, [screen frame]);
4136   return NSHeight (frame);
4140 x_display_pixel_width (struct ns_display_info *dpyinfo)
4142   NSArray *screens = [NSScreen screens];
4143   NSEnumerator *enumerator = [screens objectEnumerator];
4144   NSScreen *screen;
4145   NSRect frame;
4147   frame = NSZeroRect;
4148   while ((screen = [enumerator nextObject]) != nil)
4149     frame = NSUnionRect (frame, [screen frame]);
4151   return NSWidth (frame);
4155 static Lisp_Object ns_string_to_lispmod (const char *s)
4156 /* --------------------------------------------------------------------------
4157      Convert modifier name to lisp symbol
4158    -------------------------------------------------------------------------- */
4160   if (!strncmp (SSDATA (SYMBOL_NAME (Qmeta)), s, 10))
4161     return Qmeta;
4162   else if (!strncmp (SSDATA (SYMBOL_NAME (Qsuper)), s, 10))
4163     return Qsuper;
4164   else if (!strncmp (SSDATA (SYMBOL_NAME (Qcontrol)), s, 10))
4165     return Qcontrol;
4166   else if (!strncmp (SSDATA (SYMBOL_NAME (Qalt)), s, 10))
4167     return Qalt;
4168   else if (!strncmp (SSDATA (SYMBOL_NAME (Qhyper)), s, 10))
4169     return Qhyper;
4170   else if (!strncmp (SSDATA (SYMBOL_NAME (Qnone)), s, 10))
4171     return Qnone;
4172   else
4173     return Qnil;
4177 static void
4178 ns_default (const char *parameter, Lisp_Object *result,
4179            Lisp_Object yesval, Lisp_Object noval,
4180            BOOL is_float, BOOL is_modstring)
4181 /* --------------------------------------------------------------------------
4182       Check a parameter value in user's preferences
4183    -------------------------------------------------------------------------- */
4185   const char *value = ns_get_defaults_value (parameter);
4187   if (value)
4188     {
4189       double f;
4190       char *pos;
4191       if (c_strcasecmp (value, "YES") == 0)
4192         *result = yesval;
4193       else if (c_strcasecmp (value, "NO") == 0)
4194         *result = noval;
4195       else if (is_float && (f = strtod (value, &pos), pos != value))
4196         *result = make_float (f);
4197       else if (is_modstring && value)
4198         *result = ns_string_to_lispmod (value);
4199       else fprintf (stderr,
4200                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
4201     }
4205 static void
4206 ns_initialize_display_info (struct ns_display_info *dpyinfo)
4207 /* --------------------------------------------------------------------------
4208       Initialize global info and storage for display.
4209    -------------------------------------------------------------------------- */
4211     NSScreen *screen = [NSScreen mainScreen];
4212     NSWindowDepth depth = [screen depth];
4214     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
4215     dpyinfo->resy = 72.27;
4216     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
4217                                                   NSColorSpaceFromDepth (depth)]
4218                 && ![NSCalibratedWhiteColorSpace isEqualToString:
4219                                                  NSColorSpaceFromDepth (depth)];
4220     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
4221     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
4222     dpyinfo->color_table->colors = NULL;
4223     dpyinfo->root_window = 42; /* a placeholder.. */
4224     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
4225     dpyinfo->n_fonts = 0;
4226     dpyinfo->smallest_font_height = 1;
4227     dpyinfo->smallest_char_width = 1;
4229     reset_mouse_highlight (&dpyinfo->mouse_highlight);
4233 /* This and next define (many of the) public functions in this file. */
4234 /* x_... are generic versions in xdisp.c that we, and other terms, get away
4235          with using despite presence in the "system dependent" redisplay
4236          interface.  In addition, many of the ns_ methods have code that is
4237          shared with all terms, indicating need for further refactoring. */
4238 extern frame_parm_handler ns_frame_parm_handlers[];
4239 static struct redisplay_interface ns_redisplay_interface =
4241   ns_frame_parm_handlers,
4242   x_produce_glyphs,
4243   x_write_glyphs,
4244   x_insert_glyphs,
4245   x_clear_end_of_line,
4246   ns_scroll_run,
4247   ns_after_update_window_line,
4248   ns_update_window_begin,
4249   ns_update_window_end,
4250   0, /* flush_display */
4251   x_clear_window_mouse_face,
4252   x_get_glyph_overhangs,
4253   x_fix_overlapping_area,
4254   ns_draw_fringe_bitmap,
4255   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
4256   0, /* destroy_fringe_bitmap */
4257   ns_compute_glyph_string_overhangs,
4258   ns_draw_glyph_string,
4259   ns_define_frame_cursor,
4260   ns_clear_frame_area,
4261   ns_draw_window_cursor,
4262   ns_draw_vertical_window_border,
4263   ns_draw_window_divider,
4264   ns_shift_glyphs_for_insert,
4265   ns_show_hourglass,
4266   ns_hide_hourglass
4270 static void
4271 ns_delete_display (struct ns_display_info *dpyinfo)
4273   /* TODO... */
4277 /* This function is called when the last frame on a display is deleted. */
4278 static void
4279 ns_delete_terminal (struct terminal *terminal)
4281   struct ns_display_info *dpyinfo = terminal->display_info.ns;
4283   /* Protect against recursive calls.  delete_frame in
4284      delete_terminal calls us back when it deletes our last frame.  */
4285   if (!terminal->name)
4286     return;
4288   block_input ();
4290   x_destroy_all_bitmaps (dpyinfo);
4291   ns_delete_display (dpyinfo);
4292   unblock_input ();
4296 static struct terminal *
4297 ns_create_terminal (struct ns_display_info *dpyinfo)
4298 /* --------------------------------------------------------------------------
4299       Set up use of NS before we make the first connection.
4300    -------------------------------------------------------------------------- */
4302   struct terminal *terminal;
4304   NSTRACE (ns_create_terminal);
4306   terminal = create_terminal (output_ns, &ns_redisplay_interface);
4308   terminal->display_info.ns = dpyinfo;
4309   dpyinfo->terminal = terminal;
4311   terminal->clear_frame_hook = ns_clear_frame;
4312   terminal->ring_bell_hook = ns_ring_bell;
4313   terminal->update_begin_hook = ns_update_begin;
4314   terminal->update_end_hook = ns_update_end;
4315   terminal->read_socket_hook = ns_read_socket;
4316   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
4317   terminal->mouse_position_hook = ns_mouse_position;
4318   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
4319   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
4320   terminal->fullscreen_hook = ns_fullscreen_hook;
4321   terminal->menu_show_hook = ns_menu_show;
4322   terminal->popup_dialog_hook = ns_popup_dialog;
4323   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
4324   terminal->set_horizontal_scroll_bar_hook = ns_set_horizontal_scroll_bar;
4325   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
4326   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
4327   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
4328   terminal->delete_frame_hook = x_destroy_window;
4329   terminal->delete_terminal_hook = ns_delete_terminal;
4330   /* Other hooks are NULL by default.  */
4332   return terminal;
4336 struct ns_display_info *
4337 ns_term_init (Lisp_Object display_name)
4338 /* --------------------------------------------------------------------------
4339      Start the Application and get things rolling.
4340    -------------------------------------------------------------------------- */
4342   struct terminal *terminal;
4343   struct ns_display_info *dpyinfo;
4344   static int ns_initialized = 0;
4345   Lisp_Object tmp;
4347   if (ns_initialized) return x_display_list;
4348   ns_initialized = 1;
4350   NSTRACE (ns_term_init);
4352   [outerpool release];
4353   outerpool = [[NSAutoreleasePool alloc] init];
4355   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
4356   /*GSDebugAllocationActive (YES); */
4357   block_input ();
4359   baud_rate = 38400;
4360   Fset_input_interrupt_mode (Qnil);
4362   if (selfds[0] == -1)
4363     {
4364       if (emacs_pipe (selfds) != 0)
4365         {
4366           fprintf (stderr, "Failed to create pipe: %s\n",
4367                    emacs_strerror (errno));
4368           emacs_abort ();
4369         }
4371       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4372       FD_ZERO (&select_readfds);
4373       FD_ZERO (&select_writefds);
4374       pthread_mutex_init (&select_mutex, NULL);
4375     }
4377   ns_pending_files = [[NSMutableArray alloc] init];
4378   ns_pending_service_names = [[NSMutableArray alloc] init];
4379   ns_pending_service_args = [[NSMutableArray alloc] init];
4381 /* Start app and create the main menu, window, view.
4382      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4383      The view will then ask the NSApp to stop and return to Emacs. */
4384   [EmacsApp sharedApplication];
4385   if (NSApp == nil)
4386     return NULL;
4387   [NSApp setDelegate: NSApp];
4389   /* Start the select thread.  */
4390   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4391                            toTarget:NSApp
4392                          withObject:nil];
4394   /* debugging: log all notifications */
4395   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4396                                          selector: @selector (logNotification:)
4397                                              name: nil object: nil]; */
4399   dpyinfo = xzalloc (sizeof *dpyinfo);
4401   ns_initialize_display_info (dpyinfo);
4402   terminal = ns_create_terminal (dpyinfo);
4404   terminal->kboard = allocate_kboard (Qns);
4405   /* Don't let the initial kboard remain current longer than necessary.
4406      That would cause problems if a file loaded on startup tries to
4407      prompt in the mini-buffer.  */
4408   if (current_kboard == initial_kboard)
4409     current_kboard = terminal->kboard;
4410   terminal->kboard->reference_count++;
4412   dpyinfo->next = x_display_list;
4413   x_display_list = dpyinfo;
4415   dpyinfo->name_list_element = Fcons (display_name, Qnil);
4417   terminal->name = xlispstrdup (display_name);
4419   unblock_input ();
4421   if (!inhibit_x_resources)
4422     {
4423       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4424                  Qt, Qnil, NO, NO);
4425       tmp = Qnil;
4426       /* this is a standard variable */
4427       ns_default ("AppleAntiAliasingThreshold", &tmp,
4428                  make_float (10.0), make_float (6.0), YES, NO);
4429       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4430     }
4432   {
4433     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4435     if ( cl == nil )
4436       {
4437         Lisp_Object color_file, color_map, color;
4438         unsigned long c;
4439         char *name;
4441         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4442                          Fsymbol_value (intern ("data-directory")));
4444         color_map = Fx_load_color_file (color_file);
4445         if (NILP (color_map))
4446           fatal ("Could not read %s.\n", SDATA (color_file));
4448         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4449         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4450           {
4451             color = XCAR (color_map);
4452             name = SSDATA (XCAR (color));
4453             c = XINT (XCDR (color));
4454             [cl setColor:
4455                   [NSColor colorForEmacsRed: RED_FROM_ULONG (c) / 255.0
4456                                       green: GREEN_FROM_ULONG (c) / 255.0
4457                                        blue: BLUE_FROM_ULONG (c) / 255.0
4458                                       alpha: 1.0]
4459                   forKey: [NSString stringWithUTF8String: name]];
4460           }
4461         [cl writeToFile: nil];
4462       }
4463   }
4465   {
4466 #ifdef NS_IMPL_GNUSTEP
4467     Vwindow_system_version = build_string (gnustep_base_version);
4468 #else
4469     /*PSnextrelease (128, c); */
4470     char c[DBL_BUFSIZE_BOUND];
4471     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4472     Vwindow_system_version = make_unibyte_string (c, len);
4473 #endif
4474   }
4476   delete_keyboard_wait_descriptor (0);
4478   ns_app_name = [[NSProcessInfo processInfo] processName];
4480 /* Set up OS X app menu */
4481 #ifdef NS_IMPL_COCOA
4482   {
4483     NSMenu *appMenu;
4484     NSMenuItem *item;
4485     /* set up the application menu */
4486     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4487     [svcsMenu setAutoenablesItems: NO];
4488     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4489     [appMenu setAutoenablesItems: NO];
4490     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4491     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4493     [appMenu insertItemWithTitle: @"About Emacs"
4494                           action: @selector (orderFrontStandardAboutPanel:)
4495                    keyEquivalent: @""
4496                          atIndex: 0];
4497     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4498     [appMenu insertItemWithTitle: @"Preferences..."
4499                           action: @selector (showPreferencesWindow:)
4500                    keyEquivalent: @","
4501                          atIndex: 2];
4502     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4503     item = [appMenu insertItemWithTitle: @"Services"
4504                                  action: @selector (menuDown:)
4505                           keyEquivalent: @""
4506                                 atIndex: 4];
4507     [appMenu setSubmenu: svcsMenu forItem: item];
4508     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4509     [appMenu insertItemWithTitle: @"Hide Emacs"
4510                           action: @selector (hide:)
4511                    keyEquivalent: @"h"
4512                          atIndex: 6];
4513     item =  [appMenu insertItemWithTitle: @"Hide Others"
4514                           action: @selector (hideOtherApplications:)
4515                    keyEquivalent: @"h"
4516                          atIndex: 7];
4517     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4518     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4519     [appMenu insertItemWithTitle: @"Quit Emacs"
4520                           action: @selector (terminate:)
4521                    keyEquivalent: @"q"
4522                          atIndex: 9];
4524     item = [mainMenu insertItemWithTitle: ns_app_name
4525                                   action: @selector (menuDown:)
4526                            keyEquivalent: @""
4527                                  atIndex: 0];
4528     [mainMenu setSubmenu: appMenu forItem: item];
4529     [dockMenu insertItemWithTitle: @"New Frame"
4530                            action: @selector (newFrame:)
4531                     keyEquivalent: @""
4532                           atIndex: 0];
4534     [NSApp setMainMenu: mainMenu];
4535     [NSApp setAppleMenu: appMenu];
4536     [NSApp setServicesMenu: svcsMenu];
4537     /* Needed at least on Cocoa, to get dock menu to show windows */
4538     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4540     [[NSNotificationCenter defaultCenter]
4541       addObserver: mainMenu
4542          selector: @selector (trackingNotification:)
4543              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4544     [[NSNotificationCenter defaultCenter]
4545       addObserver: mainMenu
4546          selector: @selector (trackingNotification:)
4547              name: NSMenuDidEndTrackingNotification object: mainMenu];
4548   }
4549 #endif /* MAC OS X menu setup */
4551   /* Register our external input/output types, used for determining
4552      applicable services and also drag/drop eligibility. */
4553   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4554   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4555                       retain];
4556   ns_drag_types = [[NSArray arrayWithObjects:
4557                             NSStringPboardType,
4558                             NSTabularTextPboardType,
4559                             NSFilenamesPboardType,
4560                             NSURLPboardType, nil] retain];
4562   /* If fullscreen is in init/default-frame-alist, focus isn't set
4563      right for fullscreen windows, so set this.  */
4564   [NSApp activateIgnoringOtherApps:YES];
4566   [NSApp run];
4567   ns_do_open_file = YES;
4569 #ifdef NS_IMPL_GNUSTEP
4570   /* GNUstep steals SIGCHLD for use in NSTask, but we don't use NSTask.
4571      We must re-catch it so subprocess works.  */
4572   catch_child_signal ();
4573 #endif
4574   return dpyinfo;
4578 void
4579 ns_term_shutdown (int sig)
4581   [[NSUserDefaults standardUserDefaults] synchronize];
4583   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4584   if (STRINGP (Vauto_save_list_file_name))
4585     unlink (SSDATA (Vauto_save_list_file_name));
4587   if (sig == 0 || sig == SIGTERM)
4588     {
4589       [NSApp terminate: NSApp];
4590     }
4591   else // force a stack trace to happen
4592     {
4593       emacs_abort ();
4594     }
4598 /* ==========================================================================
4600     EmacsApp implementation
4602    ========================================================================== */
4605 @implementation EmacsApp
4607 - (id)init
4609   if ((self = [super init]))
4610     {
4611 #ifdef NS_IMPL_COCOA
4612       self->isFirst = YES;
4613 #endif
4614 #ifdef NS_IMPL_GNUSTEP
4615       self->applicationDidFinishLaunchingCalled = NO;
4616 #endif
4617     }
4619   return self;
4622 #ifdef NS_IMPL_COCOA
4623 - (void)run
4625 #ifndef NSAppKitVersionNumber10_9
4626 #define NSAppKitVersionNumber10_9 1265
4627 #endif
4629     if ((int)NSAppKitVersionNumber != NSAppKitVersionNumber10_9)
4630       {
4631         [super run];
4632         return;
4633       }
4635   NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
4637   if (isFirst) [self finishLaunching];
4638   isFirst = NO;
4640   shouldKeepRunning = YES;
4641   do
4642     {
4643       [pool release];
4644       pool = [[NSAutoreleasePool alloc] init];
4646       NSEvent *event =
4647         [self nextEventMatchingMask:NSAnyEventMask
4648                           untilDate:[NSDate distantFuture]
4649                              inMode:NSDefaultRunLoopMode
4650                             dequeue:YES];
4652       [self sendEvent:event];
4653       [self updateWindows];
4654     } while (shouldKeepRunning);
4656   [pool release];
4659 - (void)stop: (id)sender
4661     shouldKeepRunning = NO;
4662     // Stop possible dialog also.  Noop if no dialog present.
4663     // The file dialog still leaks 7k - 10k on 10.9 though.
4664     [super stop:sender];
4666 #endif /* NS_IMPL_COCOA */
4668 - (void)logNotification: (NSNotification *)notification
4670   const char *name = [[notification name] UTF8String];
4671   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4672       && !strstr (name, "WindowNumber"))
4673     NSLog (@"notification: '%@'", [notification name]);
4677 - (void)sendEvent: (NSEvent *)theEvent
4678 /* --------------------------------------------------------------------------
4679      Called when NSApp is running for each event received.  Used to stop
4680      the loop when we choose, since there's no way to just run one iteration.
4681    -------------------------------------------------------------------------- */
4683   int type = [theEvent type];
4684   NSWindow *window = [theEvent window];
4686 /*  NSTRACE (sendEvent); */
4687 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4689 #ifdef NS_IMPL_GNUSTEP
4690   // Keyboard events aren't propagated to file dialogs for some reason.
4691   if ([NSApp modalWindow] != nil &&
4692       (type == NSKeyDown || type == NSKeyUp || type == NSFlagsChanged))
4693     {
4694       [[NSApp modalWindow] sendEvent: theEvent];
4695       return;
4696     }
4697 #endif
4699   if (represented_filename != nil && represented_frame)
4700     {
4701       NSString *fstr = represented_filename;
4702       NSView *view = FRAME_NS_VIEW (represented_frame);
4703 #ifdef NS_IMPL_COCOA
4704       /* work around a bug observed on 10.3 and later where
4705          setTitleWithRepresentedFilename does not clear out previous state
4706          if given filename does not exist */
4707       if (! [[NSFileManager defaultManager] fileExistsAtPath: fstr])
4708         [[view window] setRepresentedFilename: @""];
4709 #endif
4710       [[view window] setRepresentedFilename: fstr];
4711       [represented_filename release];
4712       represented_filename = nil;
4713       represented_frame = NULL;
4714     }
4716   if (type == NSApplicationDefined)
4717     {
4718       switch ([theEvent data2])
4719         {
4720 #ifdef NS_IMPL_COCOA
4721         case NSAPP_DATA2_RUNASSCRIPT:
4722           ns_run_ascript ();
4723           [self stop: self];
4724           return;
4725 #endif
4726         case NSAPP_DATA2_RUNFILEDIALOG:
4727           ns_run_file_dialog ();
4728           [self stop: self];
4729           return;
4730         }
4731     }
4733   if (type == NSCursorUpdate && window == nil)
4734     {
4735       fprintf (stderr, "Dropping external cursor update event.\n");
4736       return;
4737     }
4739   if (type == NSApplicationDefined)
4740     {
4741       /* Events posted by ns_send_appdefined interrupt the run loop here.
4742          But, if a modal window is up, an appdefined can still come through,
4743          (e.g., from a makeKeyWindow event) but stopping self also stops the
4744          modal loop. Just defer it until later. */
4745       if ([NSApp modalWindow] == nil)
4746         {
4747           last_appdefined_event_data = [theEvent data1];
4748           [self stop: self];
4749         }
4750       else
4751         {
4752           send_appdefined = YES;
4753         }
4754     }
4757 #ifdef NS_IMPL_COCOA
4758   /* If no dialog and none of our frames have focus and it is a move, skip it.
4759      It is a mouse move in an auxiliary menu, i.e. on the top right on OSX,
4760      such as Wifi, sound, date or similar.
4761      This prevents "spooky" highlighting in the frame under the menu.  */
4762   if (type == NSMouseMoved && [NSApp modalWindow] == nil)
4763     {
4764       struct ns_display_info *di;
4765       BOOL has_focus = NO;
4766       for (di = x_display_list; ! has_focus && di; di = di->next)
4767         has_focus = di->x_focus_frame != 0;
4768       if (! has_focus)
4769         return;
4770     }
4771 #endif
4773   [super sendEvent: theEvent];
4777 - (void)showPreferencesWindow: (id)sender
4779   struct frame *emacsframe = SELECTED_FRAME ();
4780   NSEvent *theEvent = [NSApp currentEvent];
4782   if (!emacs_event)
4783     return;
4784   emacs_event->kind = NS_NONKEY_EVENT;
4785   emacs_event->code = KEY_NS_SHOW_PREFS;
4786   emacs_event->modifiers = 0;
4787   EV_TRAILER (theEvent);
4791 - (void)newFrame: (id)sender
4793   struct frame *emacsframe = SELECTED_FRAME ();
4794   NSEvent *theEvent = [NSApp currentEvent];
4796   if (!emacs_event)
4797     return;
4798   emacs_event->kind = NS_NONKEY_EVENT;
4799   emacs_event->code = KEY_NS_NEW_FRAME;
4800   emacs_event->modifiers = 0;
4801   EV_TRAILER (theEvent);
4805 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4806 - (BOOL) openFile: (NSString *)fileName
4808   struct frame *emacsframe = SELECTED_FRAME ();
4809   NSEvent *theEvent = [NSApp currentEvent];
4811   if (!emacs_event)
4812     return NO;
4814   emacs_event->kind = NS_NONKEY_EVENT;
4815   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4816   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4817   ns_input_line = Qnil; /* can be start or cons start,end */
4818   emacs_event->modifiers =0;
4819   EV_TRAILER (theEvent);
4821   return YES;
4825 /* **************************************************************************
4827       EmacsApp delegate implementation
4829    ************************************************************************** */
4831 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4832 /* --------------------------------------------------------------------------
4833      When application is loaded, terminate event loop in ns_term_init
4834    -------------------------------------------------------------------------- */
4836   NSTRACE (applicationDidFinishLaunching);
4837 #ifdef NS_IMPL_GNUSTEP
4838   ((EmacsApp *)self)->applicationDidFinishLaunchingCalled = YES;
4839 #endif
4840   [NSApp setServicesProvider: NSApp];
4842   [self antialiasThresholdDidChange:nil];
4843 #ifdef NS_IMPL_COCOA
4844   [[NSNotificationCenter defaultCenter]
4845     addObserver:self
4846        selector:@selector(antialiasThresholdDidChange:)
4847            name:NSAntialiasThresholdChangedNotification
4848          object:nil];
4849 #endif
4851   ns_send_appdefined (-2);
4854 - (void)antialiasThresholdDidChange:(NSNotification *)notification
4856 #ifdef NS_IMPL_COCOA
4857   macfont_update_antialias_threshold ();
4858 #endif
4862 /* Termination sequences:
4863     C-x C-c:
4864     Cmd-Q:
4865     MenuBar | File | Exit:
4866     Select Quit from App menubar:
4867         -terminate
4868         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4869         ns_term_shutdown()
4871     Select Quit from Dock menu:
4872     Logout attempt:
4873         -appShouldTerminate
4874           Cancel -> Nothing else
4875           Accept ->
4877           -terminate
4878           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4879           ns_term_shutdown()
4883 - (void) terminate: (id)sender
4885   struct frame *emacsframe = SELECTED_FRAME ();
4887   if (!emacs_event)
4888     return;
4890   emacs_event->kind = NS_NONKEY_EVENT;
4891   emacs_event->code = KEY_NS_POWER_OFF;
4892   emacs_event->arg = Qt; /* mark as non-key event */
4893   EV_TRAILER ((id)nil);
4896 static bool
4897 runAlertPanel(NSString *title,
4898               NSString *msgFormat,
4899               NSString *defaultButton,
4900               NSString *alternateButton)
4902 #if !defined (NS_IMPL_COCOA) || \
4903   MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_9
4904   return NSRunAlertPanel(title, msgFormat, defaultButton, alternateButton, nil)
4905     == NSAlertDefaultReturn;
4906 #else
4907   NSAlert *alert = [[NSAlert alloc] init];
4908   [alert setAlertStyle: NSCriticalAlertStyle];
4909   [alert setMessageText: msgFormat];
4910   [alert addButtonWithTitle: defaultButton];
4911   [alert addButtonWithTitle: alternateButton];
4912   NSInteger ret = [alert runModal];
4913   [alert release];
4914   return ret == NSAlertFirstButtonReturn;
4915 #endif
4919 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4921   bool ret;
4923   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4924     return NSTerminateNow;
4926     ret = runAlertPanel(ns_app_name,
4927                         @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4928                         @"Save Buffers and Exit", @"Cancel");
4930     if (ret)
4931         return NSTerminateNow;
4932     else
4933         return NSTerminateCancel;
4934     return NSTerminateNow;  /* just in case */
4937 static int
4938 not_in_argv (NSString *arg)
4940   int k;
4941   const char *a = [arg UTF8String];
4942   for (k = 1; k < initial_argc; ++k)
4943     if (strcmp (a, initial_argv[k]) == 0) return 0;
4944   return 1;
4947 /*   Notification from the Workspace to open a file */
4948 - (BOOL)application: sender openFile: (NSString *)file
4950   if (ns_do_open_file || not_in_argv (file))
4951     [ns_pending_files addObject: file];
4952   return YES;
4956 /*   Open a file as a temporary file */
4957 - (BOOL)application: sender openTempFile: (NSString *)file
4959   if (ns_do_open_file || not_in_argv (file))
4960     [ns_pending_files addObject: file];
4961   return YES;
4965 /*   Notification from the Workspace to open a file noninteractively (?) */
4966 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4968   if (ns_do_open_file || not_in_argv (file))
4969     [ns_pending_files addObject: file];
4970   return YES;
4973 /*   Notification from the Workspace to open multiple files */
4974 - (void)application: sender openFiles: (NSArray *)fileList
4976   NSEnumerator *files = [fileList objectEnumerator];
4977   NSString *file;
4978   /* Don't open files from the command line unconditionally,
4979      Cocoa parses the command line wrong, --option value tries to open value
4980      if --option is the last option.  */
4981   while ((file = [files nextObject]) != nil)
4982     if (ns_do_open_file || not_in_argv (file))
4983       [ns_pending_files addObject: file];
4985   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4990 /* Handle dock menu requests.  */
4991 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4993   return dockMenu;
4997 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4998 - (void)applicationWillBecomeActive: (NSNotification *)notification
5000   //ns_app_active=YES;
5002 - (void)applicationDidBecomeActive: (NSNotification *)notification
5004   NSTRACE (applicationDidBecomeActive);
5006 #ifdef NS_IMPL_GNUSTEP
5007   if (! applicationDidFinishLaunchingCalled)
5008     [self applicationDidFinishLaunching:notification];
5009 #endif
5010   //ns_app_active=YES;
5012   ns_update_auto_hide_menu_bar ();
5013   // No constraining takes place when the application is not active.
5014   ns_constrain_all_frames ();
5016 - (void)applicationDidResignActive: (NSNotification *)notification
5018   //ns_app_active=NO;
5019   ns_send_appdefined (-1);
5024 /* ==========================================================================
5026     EmacsApp aux handlers for managing event loop
5028    ========================================================================== */
5031 - (void)timeout_handler: (NSTimer *)timedEntry
5032 /* --------------------------------------------------------------------------
5033      The timeout specified to ns_select has passed.
5034    -------------------------------------------------------------------------- */
5036   /*NSTRACE (timeout_handler); */
5037   ns_send_appdefined (-2);
5040 #ifdef NS_IMPL_GNUSTEP
5041 - (void)sendFromMainThread:(id)unused
5043   ns_send_appdefined (nextappdefined);
5045 #endif
5047 - (void)fd_handler:(id)unused
5048 /* --------------------------------------------------------------------------
5049      Check data waiting on file descriptors and terminate if so
5050    -------------------------------------------------------------------------- */
5052   int result;
5053   int waiting = 1, nfds;
5054   char c;
5056   fd_set readfds, writefds, *wfds;
5057   struct timespec timeout, *tmo;
5058   NSAutoreleasePool *pool = nil;
5060   /* NSTRACE (fd_handler); */
5062   for (;;)
5063     {
5064       [pool release];
5065       pool = [[NSAutoreleasePool alloc] init];
5067       if (waiting)
5068         {
5069           fd_set fds;
5070           FD_ZERO (&fds);
5071           FD_SET (selfds[0], &fds);
5072           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
5073           if (result > 0 && read (selfds[0], &c, 1) == 1 && c == 'g')
5074             waiting = 0;
5075         }
5076       else
5077         {
5078           pthread_mutex_lock (&select_mutex);
5079           nfds = select_nfds;
5081           if (select_valid & SELECT_HAVE_READ)
5082             readfds = select_readfds;
5083           else
5084             FD_ZERO (&readfds);
5086           if (select_valid & SELECT_HAVE_WRITE)
5087             {
5088               writefds = select_writefds;
5089               wfds = &writefds;
5090             }
5091           else
5092             wfds = NULL;
5093           if (select_valid & SELECT_HAVE_TMO)
5094             {
5095               timeout = select_timeout;
5096               tmo = &timeout;
5097             }
5098           else
5099             tmo = NULL;
5101           pthread_mutex_unlock (&select_mutex);
5103           FD_SET (selfds[0], &readfds);
5104           if (selfds[0] >= nfds) nfds = selfds[0]+1;
5106           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
5108           if (result == 0)
5109             ns_send_appdefined (-2);
5110           else if (result > 0)
5111             {
5112               if (FD_ISSET (selfds[0], &readfds))
5113                 {
5114                   if (read (selfds[0], &c, 1) == 1 && c == 's')
5115                     waiting = 1;
5116                 }
5117               else
5118                 {
5119                   pthread_mutex_lock (&select_mutex);
5120                   if (select_valid & SELECT_HAVE_READ)
5121                     select_readfds = readfds;
5122                   if (select_valid & SELECT_HAVE_WRITE)
5123                     select_writefds = writefds;
5124                   if (select_valid & SELECT_HAVE_TMO)
5125                     select_timeout = timeout;
5126                   pthread_mutex_unlock (&select_mutex);
5128                   ns_send_appdefined (result);
5129                 }
5130             }
5131           waiting = 1;
5132         }
5133     }
5138 /* ==========================================================================
5140     Service provision
5142    ========================================================================== */
5144 /* called from system: queue for next pass through event loop */
5145 - (void)requestService: (NSPasteboard *)pboard
5146               userData: (NSString *)userData
5147                  error: (NSString **)error
5149   [ns_pending_service_names addObject: userData];
5150   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
5151       SSDATA (ns_string_from_pasteboard (pboard))]];
5155 /* called from ns_read_socket to clear queue */
5156 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
5158   struct frame *emacsframe = SELECTED_FRAME ();
5159   NSEvent *theEvent = [NSApp currentEvent];
5161   if (!emacs_event)
5162     return NO;
5164   emacs_event->kind = NS_NONKEY_EVENT;
5165   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
5166   ns_input_spi_name = build_string ([name UTF8String]);
5167   ns_input_spi_arg = build_string ([arg UTF8String]);
5168   emacs_event->modifiers = EV_MODIFIERS (theEvent);
5169   EV_TRAILER (theEvent);
5171   return YES;
5175 @end  /* EmacsApp */
5179 /* ==========================================================================
5181     EmacsView implementation
5183    ========================================================================== */
5186 @implementation EmacsView
5188 /* needed to inform when window closed from LISP */
5189 - (void) setWindowClosing: (BOOL)closing
5191   windowClosing = closing;
5195 - (void)dealloc
5197   NSTRACE (EmacsView_dealloc);
5198   [toolbar release];
5199   if (fs_state == FULLSCREEN_BOTH)
5200     [nonfs_window release];
5201   [super dealloc];
5205 /* called on font panel selection */
5206 - (void)changeFont: (id)sender
5208   NSEvent *e = [[self window] currentEvent];
5209   struct face *face = FRAME_DEFAULT_FACE (emacsframe);
5210   struct font *font = face->font;
5211   id newFont;
5212   CGFloat size;
5213   NSFont *nsfont;
5215   NSTRACE (changeFont);
5217   if (!emacs_event)
5218     return;
5220 #ifdef NS_IMPL_GNUSTEP
5221   nsfont = ((struct nsfont_info *)font)->nsfont;
5222 #endif
5223 #ifdef NS_IMPL_COCOA
5224   nsfont = (NSFont *) macfont_get_nsctfont (font);
5225 #endif
5227   if ((newFont = [sender convertFont: nsfont]))
5228     {
5229       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
5231       emacs_event->kind = NS_NONKEY_EVENT;
5232       emacs_event->modifiers = 0;
5233       emacs_event->code = KEY_NS_CHANGE_FONT;
5235       size = [newFont pointSize];
5236       ns_input_fontsize = make_number (lrint (size));
5237       ns_input_font = build_string ([[newFont familyName] UTF8String]);
5238       EV_TRAILER (e);
5239     }
5243 - (BOOL)acceptsFirstResponder
5245   NSTRACE (acceptsFirstResponder);
5246   return YES;
5250 - (void)resetCursorRects
5252   NSRect visible = [self visibleRect];
5253   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
5254   NSTRACE (resetCursorRects);
5256   if (currentCursor == nil)
5257     currentCursor = [NSCursor arrowCursor];
5259   if (!NSIsEmptyRect (visible))
5260     [self addCursorRect: visible cursor: currentCursor];
5261   [currentCursor setOnMouseEntered: YES];
5266 /*****************************************************************************/
5267 /* Keyboard handling. */
5268 #define NS_KEYLOG 0
5270 - (void)keyDown: (NSEvent *)theEvent
5272   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5273   int code;
5274   unsigned fnKeysym = 0;
5275   static NSMutableArray *nsEvArray;
5276   int left_is_none;
5277   unsigned int flags = [theEvent modifierFlags];
5279   NSTRACE (keyDown);
5281   /* Rhapsody and OS X give up and down events for the arrow keys */
5282   if (ns_fake_keydown == YES)
5283     ns_fake_keydown = NO;
5284   else if ([theEvent type] != NSKeyDown)
5285     return;
5287   if (!emacs_event)
5288     return;
5290  if (![[self window] isKeyWindow]
5291      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
5292      /* we must avoid an infinite loop here. */
5293      && (EmacsView *)[[theEvent window] delegate] != self)
5294    {
5295      /* XXX: There is an occasional condition in which, when Emacs display
5296          updates a different frame from the current one, and temporarily
5297          selects it, then processes some interrupt-driven input
5298          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
5299          for some reason that window has its first responder set to the NSView
5300          most recently updated (I guess), which is not the correct one. */
5301      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
5302      return;
5303    }
5305   if (nsEvArray == nil)
5306     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
5308   [NSCursor setHiddenUntilMouseMoves: YES];
5310   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
5311     {
5312       clear_mouse_face (hlinfo);
5313       hlinfo->mouse_face_hidden = 1;
5314     }
5316   if (!processingCompose)
5317     {
5318       /* When using screen sharing, no left or right information is sent,
5319          so use Left key in those cases.  */
5320       int is_left_key, is_right_key;
5322       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
5323         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
5325       /* (Carbon way: [theEvent keyCode]) */
5327       /* is it a "function key"? */
5328       /* Note: Sometimes a plain key will have the NSNumericPadKeyMask
5329          flag set (this is probably a bug in the OS).
5330       */
5331       if (code < 0x00ff && (flags&NSNumericPadKeyMask))
5332         {
5333           fnKeysym = ns_convert_key ([theEvent keyCode] | NSNumericPadKeyMask);
5334         }
5335       if (fnKeysym == 0)
5336         {
5337           fnKeysym = ns_convert_key (code);
5338         }
5340       if (fnKeysym)
5341         {
5342           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
5343              because Emacs treats Delete and KP-Delete same (in simple.el). */
5344           if ((fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
5345 #ifdef NS_IMPL_GNUSTEP
5346               /*  GNUstep uses incompatible keycodes, even for those that are
5347                   supposed to be hardware independent.  Just check for delete.
5348                   Keypad delete does not have keysym 0xFFFF.
5349                   See http://savannah.gnu.org/bugs/?25395
5350               */
5351               || (fnKeysym == 0xFFFF && code == 127)
5352 #endif
5353             )
5354             code = 0xFF08; /* backspace */
5355           else
5356             code = fnKeysym;
5357         }
5359       /* are there modifiers? */
5360       emacs_event->modifiers = 0;
5362       if (flags & NSHelpKeyMask)
5363           emacs_event->modifiers |= hyper_modifier;
5365       if (flags & NSShiftKeyMask)
5366         emacs_event->modifiers |= shift_modifier;
5368       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
5369       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
5370         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
5372       if (is_right_key)
5373         emacs_event->modifiers |= parse_solitary_modifier
5374           (EQ (ns_right_command_modifier, Qleft)
5375            ? ns_command_modifier
5376            : ns_right_command_modifier);
5378       if (is_left_key)
5379         {
5380           emacs_event->modifiers |= parse_solitary_modifier
5381             (ns_command_modifier);
5383           /* if super (default), take input manager's word so things like
5384              dvorak / qwerty layout work */
5385           if (EQ (ns_command_modifier, Qsuper)
5386               && !fnKeysym
5387               && [[theEvent characters] length] != 0)
5388             {
5389               /* XXX: the code we get will be unshifted, so if we have
5390                  a shift modifier, must convert ourselves */
5391               if (!(flags & NSShiftKeyMask))
5392                 code = [[theEvent characters] characterAtIndex: 0];
5393 #if 0
5394               /* this is ugly and also requires linking w/Carbon framework
5395                  (for LMGetKbdType) so for now leave this rare (?) case
5396                  undealt with.. in future look into CGEvent methods */
5397               else
5398                 {
5399                   long smv = GetScriptManagerVariable (smKeyScript);
5400                   Handle uchrHandle = GetResource
5401                     ('uchr', GetScriptVariable (smv, smScriptKeys));
5402                   UInt32 dummy = 0;
5403                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
5404                                  [[theEvent characters] characterAtIndex: 0],
5405                                  kUCKeyActionDisplay,
5406                                  (flags & ~NSCommandKeyMask) >> 8,
5407                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
5408                                  &dummy, 1, &dummy, &code);
5409                   code &= 0xFF;
5410                 }
5411 #endif
5412             }
5413         }
5415       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
5416       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
5417         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
5419       if (is_right_key)
5420           emacs_event->modifiers |= parse_solitary_modifier
5421               (EQ (ns_right_control_modifier, Qleft)
5422                ? ns_control_modifier
5423                : ns_right_control_modifier);
5425       if (is_left_key)
5426         emacs_event->modifiers |= parse_solitary_modifier
5427           (ns_control_modifier);
5429       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
5430           emacs_event->modifiers |=
5431             parse_solitary_modifier (ns_function_modifier);
5433       left_is_none = NILP (ns_alternate_modifier)
5434         || EQ (ns_alternate_modifier, Qnone);
5436       is_right_key = (flags & NSRightAlternateKeyMask)
5437         == NSRightAlternateKeyMask;
5438       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
5439         || (! is_right_key
5440             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
5442       if (is_right_key)
5443         {
5444           if ((NILP (ns_right_alternate_modifier)
5445                || EQ (ns_right_alternate_modifier, Qnone)
5446                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
5447               && !fnKeysym)
5448             {   /* accept pre-interp alt comb */
5449               if ([[theEvent characters] length] > 0)
5450                 code = [[theEvent characters] characterAtIndex: 0];
5451               /*HACK: clear lone shift modifier to stop next if from firing */
5452               if (emacs_event->modifiers == shift_modifier)
5453                 emacs_event->modifiers = 0;
5454             }
5455           else
5456             emacs_event->modifiers |= parse_solitary_modifier
5457               (EQ (ns_right_alternate_modifier, Qleft)
5458                ? ns_alternate_modifier
5459                : ns_right_alternate_modifier);
5460         }
5462       if (is_left_key) /* default = meta */
5463         {
5464           if (left_is_none && !fnKeysym)
5465             {   /* accept pre-interp alt comb */
5466               if ([[theEvent characters] length] > 0)
5467                 code = [[theEvent characters] characterAtIndex: 0];
5468               /*HACK: clear lone shift modifier to stop next if from firing */
5469               if (emacs_event->modifiers == shift_modifier)
5470                 emacs_event->modifiers = 0;
5471             }
5472           else
5473               emacs_event->modifiers |=
5474                 parse_solitary_modifier (ns_alternate_modifier);
5475         }
5477   if (NS_KEYLOG)
5478     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
5479              code, fnKeysym, flags, emacs_event->modifiers);
5481       /* if it was a function key or had modifiers, pass it directly to emacs */
5482       if (fnKeysym || (emacs_event->modifiers
5483                        && (emacs_event->modifiers != shift_modifier)
5484                        && [[theEvent charactersIgnoringModifiers] length] > 0))
5485 /*[[theEvent characters] length] */
5486         {
5487           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5488           if (code < 0x20)
5489             code |= (1<<28)|(3<<16);
5490           else if (code == 0x7f)
5491             code |= (1<<28)|(3<<16);
5492           else if (!fnKeysym)
5493             emacs_event->kind = code > 0xFF
5494               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5496           emacs_event->code = code;
5497           EV_TRAILER (theEvent);
5498           processingCompose = NO;
5499           return;
5500         }
5501     }
5504   if (NS_KEYLOG && !processingCompose)
5505     fprintf (stderr, "keyDown: Begin compose sequence.\n");
5507   processingCompose = YES;
5508   [nsEvArray addObject: theEvent];
5509   [self interpretKeyEvents: nsEvArray];
5510   [nsEvArray removeObject: theEvent];
5514 #ifdef NS_IMPL_COCOA
5515 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
5516    decided not to send key-down for.
5517    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
5518    This only applies on Tiger and earlier.
5519    If it matches one of these, send it on to keyDown. */
5520 -(void)keyUp: (NSEvent *)theEvent
5522   int flags = [theEvent modifierFlags];
5523   int code = [theEvent keyCode];
5524   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5525       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5526     {
5527       if (NS_KEYLOG)
5528         fprintf (stderr, "keyUp: passed test");
5529       ns_fake_keydown = YES;
5530       [self keyDown: theEvent];
5531     }
5533 #endif
5536 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5539 /* <NSTextInput>: called when done composing;
5540    NOTE: also called when we delete over working text, followed immed.
5541          by doCommandBySelector: deleteBackward: */
5542 - (void)insertText: (id)aString
5544   int code;
5545   int len = [(NSString *)aString length];
5546   int i;
5548   if (NS_KEYLOG)
5549     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5550   processingCompose = NO;
5552   if (!emacs_event)
5553     return;
5555   /* first, clear any working text */
5556   if (workingText != nil)
5557     [self deleteWorkingText];
5559   /* now insert the string as keystrokes */
5560   for (i =0; i<len; i++)
5561     {
5562       code = [aString characterAtIndex: i];
5563       /* TODO: still need this? */
5564       if (code == 0x2DC)
5565         code = '~'; /* 0x7E */
5566       if (code != 32) /* Space */
5567         emacs_event->modifiers = 0;
5568       emacs_event->kind
5569         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5570       emacs_event->code = code;
5571       EV_TRAILER ((id)nil);
5572     }
5576 /* <NSTextInput>: inserts display of composing characters */
5577 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5579   NSString *str = [aString respondsToSelector: @selector (string)] ?
5580     [aString string] : aString;
5581   if (NS_KEYLOG)
5582     NSLog (@"setMarkedText '%@' len =%lu range %lu from %lu",
5583            str, (unsigned long)[str length],
5584            (unsigned long)selRange.length,
5585            (unsigned long)selRange.location);
5587   if (workingText != nil)
5588     [self deleteWorkingText];
5589   if ([str length] == 0)
5590     return;
5592   if (!emacs_event)
5593     return;
5595   processingCompose = YES;
5596   workingText = [str copy];
5597   ns_working_text = build_string ([workingText UTF8String]);
5599   emacs_event->kind = NS_TEXT_EVENT;
5600   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5601   EV_TRAILER ((id)nil);
5605 /* delete display of composing characters [not in <NSTextInput>] */
5606 - (void)deleteWorkingText
5608   if (workingText == nil)
5609     return;
5610   if (NS_KEYLOG)
5611     NSLog(@"deleteWorkingText len =%lu\n", (unsigned long)[workingText length]);
5612   [workingText release];
5613   workingText = nil;
5614   processingCompose = NO;
5616   if (!emacs_event)
5617     return;
5619   emacs_event->kind = NS_TEXT_EVENT;
5620   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5621   EV_TRAILER ((id)nil);
5625 - (BOOL)hasMarkedText
5627   return workingText != nil;
5631 - (NSRange)markedRange
5633   NSRange rng = workingText != nil
5634     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5635   if (NS_KEYLOG)
5636     NSLog (@"markedRange request");
5637   return rng;
5641 - (void)unmarkText
5643   if (NS_KEYLOG)
5644     NSLog (@"unmark (accept) text");
5645   [self deleteWorkingText];
5646   processingCompose = NO;
5650 /* used to position char selection windows, etc. */
5651 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5653   NSRect rect;
5654   NSPoint pt;
5655   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5656   if (NS_KEYLOG)
5657     NSLog (@"firstRectForCharRange request");
5659   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5660   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5661   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5662   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5663                                        +FRAME_LINE_HEIGHT (emacsframe));
5665   pt = [self convertPoint: pt toView: nil];
5666   pt = [[self window] convertBaseToScreen: pt];
5667   rect.origin = pt;
5668   return rect;
5672 - (NSInteger)conversationIdentifier
5674   return (NSInteger)self;
5678 - (void)doCommandBySelector: (SEL)aSelector
5680   if (NS_KEYLOG)
5681     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5683   processingCompose = NO;
5684   if (aSelector == @selector (deleteBackward:))
5685     {
5686       /* happens when user backspaces over an ongoing composition:
5687          throw a 'delete' into the event queue */
5688       if (!emacs_event)
5689         return;
5690       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5691       emacs_event->code = 0xFF08;
5692       EV_TRAILER ((id)nil);
5693     }
5696 - (NSArray *)validAttributesForMarkedText
5698   static NSArray *arr = nil;
5699   if (arr == nil) arr = [NSArray new];
5700  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5701   return arr;
5704 - (NSRange)selectedRange
5706   if (NS_KEYLOG)
5707     NSLog (@"selectedRange request");
5708   return NSMakeRange (NSNotFound, 0);
5711 #if defined (NS_IMPL_COCOA) || GNUSTEP_GUI_MAJOR_VERSION > 0 || \
5712     GNUSTEP_GUI_MINOR_VERSION > 22
5713 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5714 #else
5715 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
5716 #endif
5718   if (NS_KEYLOG)
5719     NSLog (@"characterIndexForPoint request");
5720   return 0;
5723 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5725   static NSAttributedString *str = nil;
5726   if (str == nil) str = [NSAttributedString new];
5727   if (NS_KEYLOG)
5728     NSLog (@"attributedSubstringFromRange request");
5729   return str;
5732 /* End <NSTextInput> impl. */
5733 /*****************************************************************************/
5736 /* This is what happens when the user presses a mouse button.  */
5737 - (void)mouseDown: (NSEvent *)theEvent
5739   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5740   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5742   NSTRACE (mouseDown);
5744   [self deleteWorkingText];
5746   if (!emacs_event)
5747     return;
5749   dpyinfo->last_mouse_frame = emacsframe;
5750   /* appears to be needed to prevent spurious movement events generated on
5751      button clicks */
5752   emacsframe->mouse_moved = 0;
5754   if ([theEvent type] == NSScrollWheel)
5755     {
5756       CGFloat delta = [theEvent deltaY];
5757       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5758       if (delta == 0)
5759         {
5760           delta = [theEvent deltaX];
5761           if (delta == 0)
5762             {
5763               NSTRACE (deltaIsZero);
5764               return;
5765             }
5766           emacs_event->kind = HORIZ_WHEEL_EVENT;
5767         }
5768       else
5769         emacs_event->kind = WHEEL_EVENT;
5771       emacs_event->code = 0;
5772       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5773         ((delta > 0) ? up_modifier : down_modifier);
5774     }
5775   else
5776     {
5777       emacs_event->kind = MOUSE_CLICK_EVENT;
5778       emacs_event->code = EV_BUTTON (theEvent);
5779       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5780                              | EV_UDMODIFIERS (theEvent);
5781     }
5782   XSETINT (emacs_event->x, lrint (p.x));
5783   XSETINT (emacs_event->y, lrint (p.y));
5784   EV_TRAILER (theEvent);
5788 - (void)rightMouseDown: (NSEvent *)theEvent
5790   NSTRACE (rightMouseDown);
5791   [self mouseDown: theEvent];
5795 - (void)otherMouseDown: (NSEvent *)theEvent
5797   NSTRACE (otherMouseDown);
5798   [self mouseDown: theEvent];
5802 - (void)mouseUp: (NSEvent *)theEvent
5804   NSTRACE (mouseUp);
5805   [self mouseDown: theEvent];
5809 - (void)rightMouseUp: (NSEvent *)theEvent
5811   NSTRACE (rightMouseUp);
5812   [self mouseDown: theEvent];
5816 - (void)otherMouseUp: (NSEvent *)theEvent
5818   NSTRACE (otherMouseUp);
5819   [self mouseDown: theEvent];
5823 - (void) scrollWheel: (NSEvent *)theEvent
5825   NSTRACE (scrollWheel);
5826   [self mouseDown: theEvent];
5830 /* Tell emacs the mouse has moved. */
5831 - (void)mouseMoved: (NSEvent *)e
5833   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5834   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5835   Lisp_Object frame;
5836   NSPoint pt;
5838 //  NSTRACE (mouseMoved);
5840   dpyinfo->last_mouse_movement_time = EV_TIMESTAMP (e);
5841   pt = [self convertPoint: [e locationInWindow] fromView: nil];
5842   dpyinfo->last_mouse_motion_x = pt.x;
5843   dpyinfo->last_mouse_motion_y = pt.y;
5845   /* update any mouse face */
5846   if (hlinfo->mouse_face_hidden)
5847     {
5848       hlinfo->mouse_face_hidden = 0;
5849       clear_mouse_face (hlinfo);
5850     }
5852   /* tooltip handling */
5853   previous_help_echo_string = help_echo_string;
5854   help_echo_string = Qnil;
5856   if (!NILP (Vmouse_autoselect_window))
5857     {
5858       NSTRACE (mouse_autoselect_window);
5859       static Lisp_Object last_mouse_window;
5860       Lisp_Object window
5861         = window_from_coordinates (emacsframe, pt.x, pt.y, 0, 0);
5863       if (WINDOWP (window)
5864           && !EQ (window, last_mouse_window)
5865           && !EQ (window, selected_window)
5866           && (focus_follows_mouse
5867               || (EQ (XWINDOW (window)->frame,
5868                       XWINDOW (selected_window)->frame))))
5869         {
5870           NSTRACE (in_window);
5871           emacs_event->kind = SELECT_WINDOW_EVENT;
5872           emacs_event->frame_or_window = window;
5873           EV_TRAILER2 (e);
5874         }
5875       /* Remember the last window where we saw the mouse.  */
5876       last_mouse_window = window;
5877     }
5879   if (!note_mouse_movement (emacsframe, pt.x, pt.y))
5880     help_echo_string = previous_help_echo_string;
5882   XSETFRAME (frame, emacsframe);
5883   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5884     {
5885       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5886          (note_mouse_highlight), which is called through the
5887          note_mouse_movement () call above */
5888       any_help_event_p = YES;
5889       gen_help_event (help_echo_string, frame, help_echo_window,
5890                       help_echo_object, help_echo_pos);
5891     }
5893   if (emacsframe->mouse_moved && send_appdefined)
5894     ns_send_appdefined (-1);
5898 - (void)mouseDragged: (NSEvent *)e
5900   NSTRACE (mouseDragged);
5901   [self mouseMoved: e];
5905 - (void)rightMouseDragged: (NSEvent *)e
5907   NSTRACE (rightMouseDragged);
5908   [self mouseMoved: e];
5912 - (void)otherMouseDragged: (NSEvent *)e
5914   NSTRACE (otherMouseDragged);
5915   [self mouseMoved: e];
5919 - (BOOL)windowShouldClose: (id)sender
5921   NSEvent *e =[[self window] currentEvent];
5923   NSTRACE (windowShouldClose);
5924   windowClosing = YES;
5925   if (!emacs_event)
5926     return NO;
5927   emacs_event->kind = DELETE_WINDOW_EVENT;
5928   emacs_event->modifiers = 0;
5929   emacs_event->code = 0;
5930   EV_TRAILER (e);
5931   /* Don't close this window, let this be done from lisp code.  */
5932   return NO;
5935 - (void) updateFrameSize: (BOOL) delay;
5937   NSWindow *window = [self window];
5938   NSRect wr = [window frame];
5939   int extra = 0;
5940   int oldc = cols, oldr = rows;
5941   int oldw = FRAME_PIXEL_WIDTH (emacsframe);
5942   int oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5943   int neww, newh;
5945   NSTRACE (updateFrameSize);
5946   NSTRACE_SIZE ("Original size", NSMakeSize (oldw, oldh));
5948   if (! [self isFullscreen])
5949     {
5950 #ifdef NS_IMPL_GNUSTEP
5951       // GNUstep does not always update the tool bar height.  Force it.
5952       if (toolbar && [toolbar isVisible])
5953           update_frame_tool_bar (emacsframe);
5954 #endif
5956       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5957         + FRAME_TOOLBAR_HEIGHT (emacsframe);
5958     }
5960   if (wait_for_tool_bar)
5961     {
5962       if (FRAME_TOOLBAR_HEIGHT (emacsframe) == 0)
5963         return;
5964       wait_for_tool_bar = NO;
5965     }
5967   neww = (int)wr.size.width - emacsframe->border_width;
5968   newh = (int)wr.size.height - extra;
5970   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, neww);
5971   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, newh);
5973   if (cols < MINWIDTH)
5974     cols = MINWIDTH;
5976   if (rows < MINHEIGHT)
5977     rows = MINHEIGHT;
5979   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5980     {
5981       NSView *view = FRAME_NS_VIEW (emacsframe);
5982       NSWindow *win = [view window];
5983       NSSize sz = [win resizeIncrements];
5985       change_frame_size (emacsframe,
5986                          FRAME_PIXEL_TO_TEXT_WIDTH (emacsframe, neww),
5987                          FRAME_PIXEL_TO_TEXT_HEIGHT (emacsframe, newh),
5988                          0, delay, 0, 1);
5989       SET_FRAME_GARBAGED (emacsframe);
5990       cancel_mouse_face (emacsframe);
5992       // Did resize increments change because of a font change?
5993       if (sz.width != FRAME_COLUMN_WIDTH (emacsframe) ||
5994           sz.height != FRAME_LINE_HEIGHT (emacsframe) ||
5995           (frame_resize_pixelwise && sz.width != 1))
5996         {
5997           sz.width = frame_resize_pixelwise
5998             ? 1 : FRAME_COLUMN_WIDTH (emacsframe);
5999           sz.height = frame_resize_pixelwise
6000             ? 1 : FRAME_LINE_HEIGHT (emacsframe);
6001           [win setResizeIncrements: sz];
6003           NSTRACE_SIZE ("New size", NSMakeSize (neww, newh));
6004         }
6006       [view setFrame: NSMakeRect (0, 0, neww, newh)];
6007       [self windowDidMove:nil];   // Update top/left.
6008     }
6011 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
6012 /* normalize frame to gridded text size */
6014   int extra = 0;
6016   NSTRACE (windowWillResize);
6017   NSTRACE_SIZE ("Original size", frameSize);
6018 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
6020   if (fs_state == FULLSCREEN_MAXIMIZED
6021       && (maximized_width != (int)frameSize.width
6022           || maximized_height != (int)frameSize.height))
6023     [self setFSValue: FULLSCREEN_NONE];
6024   else if (fs_state == FULLSCREEN_WIDTH
6025            && maximized_width != (int)frameSize.width)
6026     [self setFSValue: FULLSCREEN_NONE];
6027   else if (fs_state == FULLSCREEN_HEIGHT
6028            && maximized_height != (int)frameSize.height)
6029     [self setFSValue: FULLSCREEN_NONE];
6030   if (fs_state == FULLSCREEN_NONE)
6031     maximized_width = maximized_height = -1;
6033   if (! [self isFullscreen])
6034     {
6035       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
6036         + FRAME_TOOLBAR_HEIGHT (emacsframe);
6037     }
6039   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, frameSize.width);
6040   if (cols < MINWIDTH)
6041     cols = MINWIDTH;
6043   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe,
6044                                            frameSize.height - extra);
6045   if (rows < MINHEIGHT)
6046     rows = MINHEIGHT;
6047 #ifdef NS_IMPL_COCOA
6048   {
6049     /* this sets window title to have size in it; the wm does this under GS */
6050     NSRect r = [[self window] frame];
6051     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
6052       {
6053         if (old_title != 0)
6054           {
6055             xfree (old_title);
6056             old_title = 0;
6057           }
6058       }
6059     else if (fs_state == FULLSCREEN_NONE && ! maximizing_resize)
6060       {
6061         char *size_title;
6062         NSWindow *window = [self window];
6063         if (old_title == 0)
6064           {
6065             char *t = strdup ([[[self window] title] UTF8String]);
6066             char *pos = strstr (t, "  â€”  ");
6067             if (pos)
6068               *pos = '\0';
6069             old_title = t;
6070           }
6071         size_title = xmalloc (strlen (old_title) + 40);
6072         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
6073         [window setTitle: [NSString stringWithUTF8String: size_title]];
6074         [window display];
6075         xfree (size_title);
6076       }
6077   }
6078 #endif /* NS_IMPL_COCOA */
6079 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
6081   return frameSize;
6085 - (void)windowDidResize: (NSNotification *)notification
6087   if (! [self fsIsNative])
6088     {
6089       NSWindow *theWindow = [notification object];
6090       /* We can get notification on the non-FS window when in
6091          fullscreen mode.  */
6092       if ([self window] != theWindow) return;
6093     }
6095 #ifdef NS_IMPL_GNUSTEP
6096   NSWindow *theWindow = [notification object];
6098    /* In GNUstep, at least currently, it's possible to get a didResize
6099       without getting a willResize.. therefore we need to act as if we got
6100       the willResize now */
6101   NSSize sz = [theWindow frame].size;
6102   sz = [self windowWillResize: theWindow toSize: sz];
6103 #endif /* NS_IMPL_GNUSTEP */
6105   NSTRACE (windowDidResize);
6106 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
6108 if (cols > 0 && rows > 0)
6109     {
6110       [self updateFrameSize: YES];
6111     }
6113   ns_send_appdefined (-1);
6116 #ifdef NS_IMPL_COCOA
6117 - (void)viewDidEndLiveResize
6119   [super viewDidEndLiveResize];
6120   if (old_title != 0)
6121     {
6122       [[self window] setTitle: [NSString stringWithUTF8String: old_title]];
6123       xfree (old_title);
6124       old_title = 0;
6125     }
6126   maximizing_resize = NO;
6128 #endif /* NS_IMPL_COCOA */
6131 - (void)windowDidBecomeKey: (NSNotification *)notification
6132 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
6134   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
6135   struct frame *old_focus = dpyinfo->x_focus_frame;
6137   NSTRACE (windowDidBecomeKey);
6139   if (emacsframe != old_focus)
6140     dpyinfo->x_focus_frame = emacsframe;
6142   ns_frame_rehighlight (emacsframe);
6144   if (emacs_event)
6145     {
6146       emacs_event->kind = FOCUS_IN_EVENT;
6147       EV_TRAILER ((id)nil);
6148     }
6152 - (void)windowDidResignKey: (NSNotification *)notification
6153 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
6155   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
6156   BOOL is_focus_frame = dpyinfo->x_focus_frame == emacsframe;
6157   NSTRACE (windowDidResignKey);
6159   if (is_focus_frame)
6160     dpyinfo->x_focus_frame = 0;
6162   emacsframe->mouse_moved = 0;
6163   ns_frame_rehighlight (emacsframe);
6165   /* FIXME: for some reason needed on second and subsequent clicks away
6166             from sole-frame Emacs to get hollow box to show */
6167   if (!windowClosing && [[self window] isVisible] == YES)
6168     {
6169       x_update_cursor (emacsframe, 1);
6170       x_set_frame_alpha (emacsframe);
6171     }
6173   if (any_help_event_p)
6174     {
6175       Lisp_Object frame;
6176       XSETFRAME (frame, emacsframe);
6177       help_echo_string = Qnil;
6178       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6179     }
6181   if (emacs_event && is_focus_frame)
6182     {
6183       [self deleteWorkingText];
6184       emacs_event->kind = FOCUS_OUT_EVENT;
6185       EV_TRAILER ((id)nil);
6186     }
6190 - (void)windowWillMiniaturize: sender
6192   NSTRACE (windowWillMiniaturize);
6196 - (BOOL)isFlipped
6198   return YES;
6202 - (BOOL)isOpaque
6204   return NO;
6208 - initFrameFromEmacs: (struct frame *)f
6210   NSRect r, wr;
6211   Lisp_Object tem;
6212   NSWindow *win;
6213   NSSize sz;
6214   NSColor *col;
6215   NSString *name;
6217   NSTRACE (initFrameFromEmacs);
6219   windowClosing = NO;
6220   processingCompose = NO;
6221   scrollbarsNeedingUpdate = 0;
6222   fs_state = FULLSCREEN_NONE;
6223   fs_before_fs = next_maximized = -1;
6224 #ifdef HAVE_NATIVE_FS
6225   fs_is_native = ns_use_native_fullscreen;
6226 #else
6227   fs_is_native = NO;
6228 #endif
6229   maximized_width = maximized_height = -1;
6230   nonfs_window = nil;
6232 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
6234   ns_userRect = NSMakeRect (0, 0, 0, 0);
6235   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
6236                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
6237   [self initWithFrame: r];
6238   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
6240   FRAME_NS_VIEW (f) = self;
6241   emacsframe = f;
6242 #ifdef NS_IMPL_COCOA
6243   old_title = 0;
6244   maximizing_resize = NO;
6245 #endif
6247   win = [[EmacsWindow alloc]
6248             initWithContentRect: r
6249                       styleMask: (NSResizableWindowMask |
6250 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6251                                   NSTitledWindowMask |
6252 #endif
6253                                   NSMiniaturizableWindowMask |
6254                                   NSClosableWindowMask)
6255                         backing: NSBackingStoreBuffered
6256                           defer: YES];
6258 #ifdef HAVE_NATIVE_FS
6259     [win setCollectionBehavior:NSWindowCollectionBehaviorFullScreenPrimary];
6260 #endif
6262   wr = [win frame];
6263   bwidth = f->border_width = wr.size.width - r.size.width;
6264   tibar_height = FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
6266   [win setAcceptsMouseMovedEvents: YES];
6267   [win setDelegate: self];
6268 #if !defined (NS_IMPL_COCOA) || \
6269   MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_9
6270   [win useOptimizedDrawing: YES];
6271 #endif
6272   sz.width = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
6273   sz.height = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
6274   [win setResizeIncrements: sz];
6276   [[win contentView] addSubview: self];
6278   if (ns_drag_types)
6279     [self registerForDraggedTypes: ns_drag_types];
6281   tem = f->name;
6282   name = [NSString stringWithUTF8String:
6283                    NILP (tem) ? "Emacs" : SSDATA (tem)];
6284   [win setTitle: name];
6286   /* toolbar support */
6287   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
6288                          [NSString stringWithFormat: @"Emacs Frame %d",
6289                                    ns_window_num]];
6290   [win setToolbar: toolbar];
6291   [toolbar setVisible: NO];
6293   /* Don't set frame garbaged until tool bar is up to date?
6294      This avoids an extra clear and redraw (flicker) at frame creation.  */
6295   if (FRAME_EXTERNAL_TOOL_BAR (f)) wait_for_tool_bar = YES;
6296   else wait_for_tool_bar = NO;
6299 #ifdef NS_IMPL_COCOA
6300   {
6301     NSButton *toggleButton;
6302   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
6303   [toggleButton setTarget: self];
6304   [toggleButton setAction: @selector (toggleToolbar: )];
6305   }
6306 #endif
6307   FRAME_TOOLBAR_HEIGHT (f) = 0;
6309   tem = f->icon_name;
6310   if (!NILP (tem))
6311     [win setMiniwindowTitle:
6312            [NSString stringWithUTF8String: SSDATA (tem)]];
6314   {
6315     NSScreen *screen = [win screen];
6317     if (screen != 0)
6318       [win setFrameTopLeftPoint: NSMakePoint
6319            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
6320             IN_BOUND (-SCREENMAX,
6321                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
6322   }
6324   [win makeFirstResponder: self];
6326   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6327                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
6328   [win setBackgroundColor: col];
6329   if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6330     [win setOpaque: NO];
6332 #if !defined (NS_IMPL_COCOA) || \
6333   MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_9
6334   [self allocateGState];
6335 #endif
6336   [NSApp registerServicesMenuSendTypes: ns_send_types
6337                            returnTypes: nil];
6339   ns_window_num++;
6340   return self;
6344 - (void)windowDidMove: sender
6346   NSWindow *win = [self window];
6347   NSRect r = [win frame];
6348   NSArray *screens = [NSScreen screens];
6349   NSScreen *screen = [screens objectAtIndex: 0];
6351   NSTRACE (windowDidMove);
6353   if (!emacsframe->output_data.ns)
6354     return;
6355   if (screen != nil)
6356     {
6357       emacsframe->left_pos = r.origin.x;
6358       emacsframe->top_pos =
6359         [screen frame].size.height - (r.origin.y + r.size.height);
6360     }
6364 /* Called AFTER method below, but before our windowWillResize call there leads
6365    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
6366    location so set_window_size moves the frame. */
6367 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
6369   emacsframe->output_data.ns->zooming = 1;
6370   return YES;
6374 /* Override to do something slightly nonstandard, but nice.  First click on
6375    zoom button will zoom vertically.  Second will zoom completely.  Third
6376    returns to original. */
6377 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
6378                         defaultFrame:(NSRect)defaultFrame
6380   NSRect result = [sender frame];
6382   NSTRACE (windowWillUseStandardFrame);
6384   if (fs_before_fs != -1) /* Entering fullscreen */
6385       {
6386         result = defaultFrame;
6387       }
6388   else if (next_maximized == FULLSCREEN_HEIGHT
6389       || (next_maximized == -1
6390           && abs ((int)(defaultFrame.size.height - result.size.height))
6391           > FRAME_LINE_HEIGHT (emacsframe)))
6392     {
6393       /* first click */
6394       ns_userRect = result;
6395       maximized_height = result.size.height = defaultFrame.size.height;
6396       maximized_width = -1;
6397       result.origin.y = defaultFrame.origin.y;
6398       [self setFSValue: FULLSCREEN_HEIGHT];
6399 #ifdef NS_IMPL_COCOA
6400       maximizing_resize = YES;
6401 #endif
6402     }
6403   else if (next_maximized == FULLSCREEN_WIDTH)
6404     {
6405       ns_userRect = result;
6406       maximized_width = result.size.width = defaultFrame.size.width;
6407       maximized_height = -1;
6408       result.origin.x = defaultFrame.origin.x;
6409       [self setFSValue: FULLSCREEN_WIDTH];
6410     }
6411   else if (next_maximized == FULLSCREEN_MAXIMIZED
6412            || (next_maximized == -1
6413                && abs ((int)(defaultFrame.size.width - result.size.width))
6414                > FRAME_COLUMN_WIDTH (emacsframe)))
6415     {
6416       result = defaultFrame;  /* second click */
6417       maximized_width = result.size.width;
6418       maximized_height = result.size.height;
6419       [self setFSValue: FULLSCREEN_MAXIMIZED];
6420 #ifdef NS_IMPL_COCOA
6421       maximizing_resize = YES;
6422 #endif
6423     }
6424   else
6425     {
6426       /* restore */
6427       result = ns_userRect.size.height ? ns_userRect : result;
6428       ns_userRect = NSMakeRect (0, 0, 0, 0);
6429 #ifdef NS_IMPL_COCOA
6430       maximizing_resize = fs_state != FULLSCREEN_NONE;
6431 #endif
6432       [self setFSValue: FULLSCREEN_NONE];
6433       maximized_width = maximized_height = -1;
6434     }
6436   if (fs_before_fs == -1) next_maximized = -1;
6437   [self windowWillResize: sender toSize: result.size];
6438   return result;
6442 - (void)windowDidDeminiaturize: sender
6444   NSTRACE (windowDidDeminiaturize);
6445   if (!emacsframe->output_data.ns)
6446     return;
6448   SET_FRAME_ICONIFIED (emacsframe, 0);
6449   SET_FRAME_VISIBLE (emacsframe, 1);
6450   windows_or_buffers_changed = 63;
6452   if (emacs_event)
6453     {
6454       emacs_event->kind = DEICONIFY_EVENT;
6455       EV_TRAILER ((id)nil);
6456     }
6460 - (void)windowDidExpose: sender
6462   NSTRACE (windowDidExpose);
6463   if (!emacsframe->output_data.ns)
6464     return;
6466   SET_FRAME_VISIBLE (emacsframe, 1);
6467   SET_FRAME_GARBAGED (emacsframe);
6469   if (send_appdefined)
6470     ns_send_appdefined (-1);
6474 - (void)windowDidMiniaturize: sender
6476   NSTRACE (windowDidMiniaturize);
6477   if (!emacsframe->output_data.ns)
6478     return;
6480   SET_FRAME_ICONIFIED (emacsframe, 1);
6481   SET_FRAME_VISIBLE (emacsframe, 0);
6483   if (emacs_event)
6484     {
6485       emacs_event->kind = ICONIFY_EVENT;
6486       EV_TRAILER ((id)nil);
6487     }
6490 #ifdef HAVE_NATIVE_FS
6491 - (NSApplicationPresentationOptions)window:(NSWindow *)window
6492       willUseFullScreenPresentationOptions:
6493   (NSApplicationPresentationOptions)proposedOptions
6495   return proposedOptions|NSApplicationPresentationAutoHideToolbar;
6497 #endif
6499 - (void)windowWillEnterFullScreen:(NSNotification *)notification
6501   fs_before_fs = fs_state;
6504 - (void)windowDidEnterFullScreen:(NSNotification *)notification
6506   [self setFSValue: FULLSCREEN_BOTH];
6507   if (! [self fsIsNative])
6508     {
6509       [self windowDidBecomeKey:notification];
6510       [nonfs_window orderOut:self];
6511     }
6512   else
6513     {
6514       BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (emacsframe) ? YES : NO;
6515 #ifdef NS_IMPL_COCOA
6516 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6517       unsigned val = (unsigned)[NSApp presentationOptions];
6519       // OSX 10.7 bug fix, the menu won't appear without this.
6520       // val is non-zero on other OSX versions.
6521       if (val == 0)
6522         {
6523           NSApplicationPresentationOptions options
6524             = NSApplicationPresentationAutoHideDock
6525             | NSApplicationPresentationAutoHideMenuBar
6526             | NSApplicationPresentationFullScreen
6527             | NSApplicationPresentationAutoHideToolbar;
6529           [NSApp setPresentationOptions: options];
6530         }
6531 #endif
6532 #endif
6533       [toolbar setVisible:tbar_visible];
6534     }
6537 - (void)windowWillExitFullScreen:(NSNotification *)notification
6539   if (next_maximized != -1)
6540     fs_before_fs = next_maximized;
6543 - (void)windowDidExitFullScreen:(NSNotification *)notification
6545   [self setFSValue: fs_before_fs];
6546   fs_before_fs = -1;
6547 #ifdef HAVE_NATIVE_FS
6548   [self updateCollectionBehavior];
6549 #endif
6550   if (FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6551     {
6552       [toolbar setVisible:YES];
6553       update_frame_tool_bar (emacsframe);
6554       [self updateFrameSize:YES];
6555       [[self window] display];
6556     }
6557   else
6558     [toolbar setVisible:NO];
6560   if (next_maximized != -1)
6561     [[self window] performZoom:self];
6564 - (BOOL)fsIsNative
6566   return fs_is_native;
6569 - (BOOL)isFullscreen
6571   if (! fs_is_native) return nonfs_window != nil;
6572 #ifdef HAVE_NATIVE_FS
6573   return ([[self window] styleMask] & NSFullScreenWindowMask) != 0;
6574 #else
6575   return NO;
6576 #endif
6579 #ifdef HAVE_NATIVE_FS
6580 - (void)updateCollectionBehavior
6582   if (! [self isFullscreen])
6583     {
6584       NSWindow *win = [self window];
6585       NSWindowCollectionBehavior b = [win collectionBehavior];
6586       if (ns_use_native_fullscreen)
6587         b |= NSWindowCollectionBehaviorFullScreenPrimary;
6588       else
6589         b &= ~NSWindowCollectionBehaviorFullScreenPrimary;
6591       [win setCollectionBehavior: b];
6592       fs_is_native = ns_use_native_fullscreen;
6593     }
6595 #endif
6597 - (void)toggleFullScreen: (id)sender
6599   NSWindow *w, *fw;
6600   BOOL onFirstScreen;
6601   struct frame *f;
6602   NSSize sz;
6603   NSRect r, wr;
6604   NSColor *col;
6606   if (fs_is_native)
6607     {
6608 #ifdef HAVE_NATIVE_FS
6609       [[self window] toggleFullScreen:sender];
6610 #endif
6611       return;
6612     }
6614   w = [self window];
6615   onFirstScreen = [[w screen] isEqual:[[NSScreen screens] objectAtIndex:0]];
6616   f = emacsframe;
6617   wr = [w frame];
6618   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6619                                  (FRAME_DEFAULT_FACE (f)),
6620                                  f);
6622   sz.width = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
6623   sz.height = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
6625   if (fs_state != FULLSCREEN_BOTH)
6626     {
6627       NSScreen *screen = [w screen];
6629 #if defined (NS_IMPL_COCOA) && \
6630   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
6631       /* Hide ghost menu bar on secondary monitor? */
6632       if (! onFirstScreen)
6633         onFirstScreen = [NSScreen screensHaveSeparateSpaces];
6634 #endif
6635       /* Hide dock and menubar if we are on the primary screen.  */
6636       if (onFirstScreen)
6637         {
6638 #ifdef NS_IMPL_COCOA
6639           NSApplicationPresentationOptions options
6640             = NSApplicationPresentationAutoHideDock
6641             | NSApplicationPresentationAutoHideMenuBar;
6643           [NSApp setPresentationOptions: options];
6644 #else
6645           [NSMenu setMenuBarVisible:NO];
6646 #endif
6647         }
6649       fw = [[EmacsFSWindow alloc]
6650                        initWithContentRect:[w contentRectForFrameRect:wr]
6651                                  styleMask:NSBorderlessWindowMask
6652                                    backing:NSBackingStoreBuffered
6653                                      defer:YES
6654                                     screen:screen];
6656       [fw setContentView:[w contentView]];
6657       [fw setTitle:[w title]];
6658       [fw setDelegate:self];
6659       [fw setAcceptsMouseMovedEvents: YES];
6660 #if !defined (NS_IMPL_COCOA) || \
6661   MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_9
6662       [fw useOptimizedDrawing: YES];
6663 #endif
6664       [fw setResizeIncrements: sz];
6665       [fw setBackgroundColor: col];
6666       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6667         [fw setOpaque: NO];
6669       f->border_width = 0;
6670       FRAME_NS_TITLEBAR_HEIGHT (f) = 0;
6671       tobar_height = FRAME_TOOLBAR_HEIGHT (f);
6672       FRAME_TOOLBAR_HEIGHT (f) = 0;
6674       nonfs_window = w;
6676       [self windowWillEnterFullScreen:nil];
6677       [fw makeKeyAndOrderFront:NSApp];
6678       [fw makeFirstResponder:self];
6679       [w orderOut:self];
6680       r = [fw frameRectForContentRect:[screen frame]];
6681       [fw setFrame: r display:YES animate:ns_use_fullscreen_animation];
6682       [self windowDidEnterFullScreen:nil];
6683       [fw display];
6684     }
6685   else
6686     {
6687       fw = w;
6688       w = nonfs_window;
6689       nonfs_window = nil;
6691       if (onFirstScreen)
6692         {
6693 #ifdef NS_IMPL_COCOA
6694           [NSApp setPresentationOptions: NSApplicationPresentationDefault];
6695 #else
6696           [NSMenu setMenuBarVisible:YES];
6697 #endif
6698         }
6700       [w setContentView:[fw contentView]];
6701       [w setResizeIncrements: sz];
6702       [w setBackgroundColor: col];
6703       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6704         [w setOpaque: NO];
6706       f->border_width = bwidth;
6707       FRAME_NS_TITLEBAR_HEIGHT (f) = tibar_height;
6708       if (FRAME_EXTERNAL_TOOL_BAR (f))
6709         FRAME_TOOLBAR_HEIGHT (f) = tobar_height;
6711       [self windowWillExitFullScreen:nil];
6712       [fw setFrame: [w frame] display:YES animate:ns_use_fullscreen_animation];
6713       [fw close];
6714       [w makeKeyAndOrderFront:NSApp];
6715       [self windowDidExitFullScreen:nil];
6716       [self updateFrameSize:YES];
6717     }
6720 - (void)handleFS
6722   if (fs_state != emacsframe->want_fullscreen)
6723     {
6724       if (fs_state == FULLSCREEN_BOTH)
6725         {
6726           [self toggleFullScreen:self];
6727         }
6729       switch (emacsframe->want_fullscreen)
6730         {
6731         case FULLSCREEN_BOTH:
6732           [self toggleFullScreen:self];
6733           break;
6734         case FULLSCREEN_WIDTH:
6735           next_maximized = FULLSCREEN_WIDTH;
6736           if (fs_state != FULLSCREEN_BOTH)
6737             [[self window] performZoom:self];
6738           break;
6739         case FULLSCREEN_HEIGHT:
6740           next_maximized = FULLSCREEN_HEIGHT;
6741           if (fs_state != FULLSCREEN_BOTH)
6742             [[self window] performZoom:self];
6743           break;
6744         case FULLSCREEN_MAXIMIZED:
6745           next_maximized = FULLSCREEN_MAXIMIZED;
6746           if (fs_state != FULLSCREEN_BOTH)
6747             [[self window] performZoom:self];
6748           break;
6749         case FULLSCREEN_NONE:
6750           if (fs_state != FULLSCREEN_BOTH)
6751             {
6752               next_maximized = FULLSCREEN_NONE;
6753               [[self window] performZoom:self];
6754             }
6755           break;
6756         }
6758       emacsframe->want_fullscreen = FULLSCREEN_NONE;
6759     }
6763 - (void) setFSValue: (int)value
6765   Lisp_Object lval = Qnil;
6766   switch (value)
6767     {
6768     case FULLSCREEN_BOTH:
6769       lval = Qfullboth;
6770       break;
6771     case FULLSCREEN_WIDTH:
6772       lval = Qfullwidth;
6773       break;
6774     case FULLSCREEN_HEIGHT:
6775       lval = Qfullheight;
6776       break;
6777     case FULLSCREEN_MAXIMIZED:
6778       lval = Qmaximized;
6779       break;
6780     }
6781   store_frame_param (emacsframe, Qfullscreen, lval);
6782   fs_state = value;
6785 - (void)mouseEntered: (NSEvent *)theEvent
6787   NSTRACE (mouseEntered);
6788   if (emacsframe)
6789     FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6790       = EV_TIMESTAMP (theEvent);
6794 - (void)mouseExited: (NSEvent *)theEvent
6796   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
6798   NSTRACE (mouseExited);
6800   if (!hlinfo)
6801     return;
6803   FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6804     = EV_TIMESTAMP (theEvent);
6806   if (emacsframe == hlinfo->mouse_face_mouse_frame)
6807     {
6808       clear_mouse_face (hlinfo);
6809       hlinfo->mouse_face_mouse_frame = 0;
6810     }
6814 - menuDown: sender
6816   NSTRACE (menuDown);
6817   if (context_menu_value == -1)
6818     context_menu_value = [sender tag];
6819   else
6820     {
6821       NSInteger tag = [sender tag];
6822       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
6823                                     emacsframe->menu_bar_vector,
6824                                     (void *)tag);
6825     }
6827   ns_send_appdefined (-1);
6828   return self;
6832 - (EmacsToolbar *)toolbar
6834   return toolbar;
6838 /* this gets called on toolbar button click */
6839 - toolbarClicked: (id)item
6841   NSEvent *theEvent;
6842   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
6844   NSTRACE (toolbarClicked);
6846   if (!emacs_event)
6847     return self;
6849   /* send first event (for some reason two needed) */
6850   theEvent = [[self window] currentEvent];
6851   emacs_event->kind = TOOL_BAR_EVENT;
6852   XSETFRAME (emacs_event->arg, emacsframe);
6853   EV_TRAILER (theEvent);
6855   emacs_event->kind = TOOL_BAR_EVENT;
6856 /*   XSETINT (emacs_event->code, 0); */
6857   emacs_event->arg = AREF (emacsframe->tool_bar_items,
6858                            idx + TOOL_BAR_ITEM_KEY);
6859   emacs_event->modifiers = EV_MODIFIERS (theEvent);
6860   EV_TRAILER (theEvent);
6861   return self;
6865 - toggleToolbar: (id)sender
6867   if (!emacs_event)
6868     return self;
6870   emacs_event->kind = NS_NONKEY_EVENT;
6871   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
6872   EV_TRAILER ((id)nil);
6873   return self;
6877 - (void)drawRect: (NSRect)rect
6879   int x = NSMinX (rect), y = NSMinY (rect);
6880   int width = NSWidth (rect), height = NSHeight (rect);
6882   NSTRACE (drawRect);
6884   if (!emacsframe || !emacsframe->output_data.ns)
6885     return;
6887   ns_clear_frame_area (emacsframe, x, y, width, height);
6888   block_input ();
6889   expose_frame (emacsframe, x, y, width, height);
6890   unblock_input ();
6892   /*
6893     drawRect: may be called (at least in OS X 10.5) for invisible
6894     views as well for some reason.  Thus, do not infer visibility
6895     here.
6897     emacsframe->async_visible = 1;
6898     emacsframe->async_iconified = 0;
6899   */
6903 /* NSDraggingDestination protocol methods.  Actually this is not really a
6904    protocol, but a category of Object.  O well...  */
6906 -(NSDragOperation) draggingEntered: (id <NSDraggingInfo>) sender
6908   NSTRACE (draggingEntered);
6909   return NSDragOperationGeneric;
6913 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
6915   return YES;
6919 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
6921   id pb;
6922   int x, y;
6923   NSString *type;
6924   NSEvent *theEvent = [[self window] currentEvent];
6925   NSPoint position;
6926   NSDragOperation op = [sender draggingSourceOperationMask];
6927   int modifiers = 0;
6929   NSTRACE (performDragOperation);
6931   if (!emacs_event)
6932     return NO;
6934   position = [self convertPoint: [sender draggingLocation] fromView: nil];
6935   x = lrint (position.x);  y = lrint (position.y);
6937   pb = [sender draggingPasteboard];
6938   type = [pb availableTypeFromArray: ns_drag_types];
6940   if (! (op & (NSDragOperationMove|NSDragOperationDelete)) &&
6941       // URL drags contain all operations (0xf), don't allow all to be set.
6942       (op & 0xf) != 0xf)
6943     {
6944       if (op & NSDragOperationLink)
6945         modifiers |= NSControlKeyMask;
6946       if (op & NSDragOperationCopy)
6947         modifiers |= NSAlternateKeyMask;
6948       if (op & NSDragOperationGeneric)
6949         modifiers |= NSCommandKeyMask;
6950     }
6952   modifiers = EV_MODIFIERS2 (modifiers);
6953   if (type == 0)
6954     {
6955       return NO;
6956     }
6957   else if ([type isEqualToString: NSFilenamesPboardType])
6958     {
6959       NSArray *files;
6960       NSEnumerator *fenum;
6961       NSString *file;
6963       if (!(files = [pb propertyListForType: type]))
6964         return NO;
6966       fenum = [files objectEnumerator];
6967       while ( (file = [fenum nextObject]) )
6968         {
6969           emacs_event->kind = DRAG_N_DROP_EVENT;
6970           XSETINT (emacs_event->x, x);
6971           XSETINT (emacs_event->y, y);
6972           ns_input_file = append2 (ns_input_file,
6973                                    build_string ([file UTF8String]));
6974           emacs_event->modifiers = modifiers;
6975           emacs_event->arg =  list2 (Qfile, build_string ([file UTF8String]));
6976           EV_TRAILER (theEvent);
6977         }
6978       return YES;
6979     }
6980   else if ([type isEqualToString: NSURLPboardType])
6981     {
6982       NSURL *url = [NSURL URLFromPasteboard: pb];
6983       if (url == nil) return NO;
6985       emacs_event->kind = DRAG_N_DROP_EVENT;
6986       XSETINT (emacs_event->x, x);
6987       XSETINT (emacs_event->y, y);
6988       emacs_event->modifiers = modifiers;
6989       emacs_event->arg =  list2 (Qurl,
6990                                  build_string ([[url absoluteString]
6991                                                  UTF8String]));
6992       EV_TRAILER (theEvent);
6994       if ([url isFileURL] != NO)
6995         {
6996           NSString *file = [url path];
6997           ns_input_file = append2 (ns_input_file,
6998                                    build_string ([file UTF8String]));
6999         }
7000       return YES;
7001     }
7002   else if ([type isEqualToString: NSStringPboardType]
7003            || [type isEqualToString: NSTabularTextPboardType])
7004     {
7005       NSString *data;
7007       if (! (data = [pb stringForType: type]))
7008         return NO;
7010       emacs_event->kind = DRAG_N_DROP_EVENT;
7011       XSETINT (emacs_event->x, x);
7012       XSETINT (emacs_event->y, y);
7013       emacs_event->modifiers = modifiers;
7014       emacs_event->arg =  list2 (Qnil, build_string ([data UTF8String]));
7015       EV_TRAILER (theEvent);
7016       return YES;
7017     }
7018   else
7019     {
7020       fprintf (stderr, "Invalid data type in dragging pasteboard");
7021       return NO;
7022     }
7026 - (id) validRequestorForSendType: (NSString *)typeSent
7027                       returnType: (NSString *)typeReturned
7029   NSTRACE (validRequestorForSendType);
7030   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
7031       && typeReturned == nil)
7032     {
7033       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
7034         return self;
7035     }
7037   return [super validRequestorForSendType: typeSent
7038                                returnType: typeReturned];
7042 /* The next two methods are part of NSServicesRequests informal protocol,
7043    supposedly called when a services menu item is chosen from this app.
7044    But this should not happen because we override the services menu with our
7045    own entries which call ns-perform-service.
7046    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
7047    So let's at least stub them out until further investigation can be done. */
7049 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
7051   /* we could call ns_string_from_pasteboard(pboard) here but then it should
7052      be written into the buffer in place of the existing selection..
7053      ordinary service calls go through functions defined in ns-win.el */
7054   return NO;
7057 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
7059   NSArray *typesDeclared;
7060   Lisp_Object val;
7062   /* We only support NSStringPboardType */
7063   if ([types containsObject:NSStringPboardType] == NO) {
7064     return NO;
7065   }
7067   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
7068   if (CONSP (val) && SYMBOLP (XCAR (val)))
7069     {
7070       val = XCDR (val);
7071       if (CONSP (val) && NILP (XCDR (val)))
7072         val = XCAR (val);
7073     }
7074   if (! STRINGP (val))
7075     return NO;
7077   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
7078   [pb declareTypes:typesDeclared owner:nil];
7079   ns_string_to_pasteboard (pb, val);
7080   return YES;
7084 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
7085    (gives a miniaturized version of the window); currently we use the latter for
7086    frames whose active buffer doesn't correspond to any file
7087    (e.g., '*scratch*') */
7088 - setMiniwindowImage: (BOOL) setMini
7090   id image = [[self window] miniwindowImage];
7091   NSTRACE (setMiniwindowImage);
7093   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
7094      about "AppleDockIconEnabled" notwithstanding, however the set message
7095      below has its effect nonetheless. */
7096   if (image != emacsframe->output_data.ns->miniimage)
7097     {
7098       if (image && [image isKindOfClass: [EmacsImage class]])
7099         [image release];
7100       [[self window] setMiniwindowImage:
7101                        setMini ? emacsframe->output_data.ns->miniimage : nil];
7102     }
7104   return self;
7108 - (void) setRows: (int) r andColumns: (int) c
7110   rows = r;
7111   cols = c;
7114 @end  /* EmacsView */
7118 /* ==========================================================================
7120     EmacsWindow implementation
7122    ========================================================================== */
7124 @implementation EmacsWindow
7126 #ifdef NS_IMPL_COCOA
7127 - (id)accessibilityAttributeValue:(NSString *)attribute
7129   Lisp_Object str = Qnil;
7130   struct frame *f = SELECTED_FRAME ();
7131   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->contents);
7133   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
7134     return NSAccessibilityTextFieldRole;
7136   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
7137       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
7138     {
7139       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
7140     }
7141   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
7142     {
7143       if (! NILP (BVAR (curbuf, mark_active)))
7144           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
7146       if (NILP (str))
7147         {
7148           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
7149           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
7150           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
7152           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
7153             str = make_uninit_multibyte_string (range, byte_range);
7154           else
7155             str = make_uninit_string (range);
7156           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
7157              Is this a problem?  */
7158           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
7159         }
7160     }
7163   if (! NILP (str))
7164     {
7165       if (CONSP (str) && SYMBOLP (XCAR (str)))
7166         {
7167           str = XCDR (str);
7168           if (CONSP (str) && NILP (XCDR (str)))
7169             str = XCAR (str);
7170         }
7171       if (STRINGP (str))
7172         {
7173           const char *utfStr = SSDATA (str);
7174           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
7175           return nsStr;
7176         }
7177     }
7179   return [super accessibilityAttributeValue:attribute];
7181 #endif /* NS_IMPL_COCOA */
7183 /* If we have multiple monitors, one above the other, we don't want to
7184    restrict the height to just one monitor.  So we override this.  */
7185 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
7187   /* When making the frame visible for the first time or if there is just
7188      one screen, we want to constrain.  Other times not.  */
7189   NSArray *screens = [NSScreen screens];
7190   NSUInteger nr_screens = [screens count], nr_eff_screens = 0, i;
7191   NSTRACE (constrainFrameRect);
7192   NSTRACE_RECT ("input", frameRect);
7194   if (ns_menu_bar_should_be_hidden ())
7195     return frameRect;
7197   if (nr_screens == 1)
7198     return [super constrainFrameRect:frameRect toScreen:screen];
7200 #ifdef NS_IMPL_COCOA
7201 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
7202   // If separate spaces is on, it is like each screen is independent.  There is
7203   // no spanning of frames across screens.
7204   if ([NSScreen screensHaveSeparateSpaces])
7205     return [super constrainFrameRect:frameRect toScreen:screen];
7206 #endif
7207 #endif
7209   for (i = 0; i < nr_screens; ++i)
7210     {
7211       NSScreen *s = [screens objectAtIndex: i];
7212       NSRect scrrect = [s frame];
7213       NSRect intersect = NSIntersectionRect (frameRect, scrrect);
7215       if (intersect.size.width > 0 || intersect.size.height > 0)
7216         ++nr_eff_screens;
7217     }
7219   if (nr_eff_screens == 1)
7220     return [super constrainFrameRect:frameRect toScreen:screen];
7222   /* The default implementation does two things 1) ensure that the top
7223      of the rectangle is below the menu bar (or below the top of the
7224      screen) and 2) resizes windows larger than the screen. As we
7225      don't want the latter, a smaller rectangle is used. */
7226 #define FAKE_HEIGHT 64
7227   float old_top = frameRect.origin.y + frameRect.size.height;
7228   NSRect r;
7229   r.size.height = FAKE_HEIGHT;
7230   r.size.width = frameRect.size.width;
7231   r.origin.x = frameRect.origin.x;
7232   r.origin.y = old_top - FAKE_HEIGHT;
7234   NSTRACE_RECT ("input to super", r);
7236   r = [super constrainFrameRect:r toScreen:screen];
7238   NSTRACE_RECT ("output from super", r);
7240   float new_top = r.origin.y + FAKE_HEIGHT;
7241   if (new_top < old_top)
7242   {
7243     frameRect.origin.y = new_top - frameRect.size.height;
7244   }
7246   NSTRACE_RECT ("output", frameRect);
7248   return frameRect;
7249 #undef FAKE_HEIGHT
7252 @end /* EmacsWindow */
7255 @implementation EmacsFSWindow
7257 - (BOOL)canBecomeKeyWindow
7259   return YES;
7262 - (BOOL)canBecomeMainWindow
7264   return YES;
7267 @end
7269 /* ==========================================================================
7271     EmacsScroller implementation
7273    ========================================================================== */
7276 @implementation EmacsScroller
7278 /* for repeat button push */
7279 #define SCROLL_BAR_FIRST_DELAY 0.5
7280 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
7282 + (CGFloat) scrollerWidth
7284   /* TODO: if we want to allow variable widths, this is the place to do it,
7285            however neither GNUstep nor Cocoa support it very well */
7286   CGFloat r;
7287 #if !defined (NS_IMPL_COCOA) || \
7288   MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_7
7289   r = [NSScroller scrollerWidth];
7290 #else
7291   r = [NSScroller scrollerWidthForControlSize: NSRegularControlSize
7292                                 scrollerStyle: NSScrollerStyleLegacy];
7293 #endif
7294   return r;
7298 - initFrame: (NSRect )r window: (Lisp_Object)nwin
7300   NSTRACE (EmacsScroller_initFrame);
7302   r.size.width = [EmacsScroller scrollerWidth];
7303   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
7304   [self setContinuous: YES];
7305   [self setEnabled: YES];
7307   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
7308      locked against the top and bottom edges, and right edge on OS X, where
7309      scrollers are on right. */
7310 #ifdef NS_IMPL_GNUSTEP
7311   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
7312 #else
7313   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
7314 #endif
7316   window = XWINDOW (nwin);
7317   condemned = NO;
7318   pixel_height = NSHeight (r);
7319   if (pixel_height == 0) pixel_height = 1;
7320   min_portion = 20 / pixel_height;
7322   frame = XFRAME (window->frame);
7323   if (FRAME_LIVE_P (frame))
7324     {
7325       int i;
7326       EmacsView *view = FRAME_NS_VIEW (frame);
7327       NSView *sview = [[view window] contentView];
7328       NSArray *subs = [sview subviews];
7330       /* disable optimization stopping redraw of other scrollbars */
7331       view->scrollbarsNeedingUpdate = 0;
7332       for (i =[subs count]-1; i >= 0; i--)
7333         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
7334           view->scrollbarsNeedingUpdate++;
7335       [sview addSubview: self];
7336     }
7338 /*  [self setFrame: r]; */
7340   return self;
7344 - (void)setFrame: (NSRect)newRect
7346   NSTRACE (EmacsScroller_setFrame);
7347 /*  block_input (); */
7348   pixel_height = NSHeight (newRect);
7349   if (pixel_height == 0) pixel_height = 1;
7350   min_portion = 20 / pixel_height;
7351   [super setFrame: newRect];
7352 /*  unblock_input (); */
7356 - (void)dealloc
7358   NSTRACE (EmacsScroller_dealloc);
7359   if (window)
7360     wset_vertical_scroll_bar (window, Qnil);
7361   window = 0;
7362   [super dealloc];
7366 - condemn
7368   NSTRACE (condemn);
7369   condemned =YES;
7370   return self;
7374 - reprieve
7376   NSTRACE (reprieve);
7377   condemned =NO;
7378   return self;
7382 -(bool)judge
7384   NSTRACE (judge);
7385   bool ret = condemned;
7386   if (condemned)
7387     {
7388       EmacsView *view;
7389       block_input ();
7390       /* ensure other scrollbar updates after deletion */
7391       view = (EmacsView *)FRAME_NS_VIEW (frame);
7392       if (view != nil)
7393         view->scrollbarsNeedingUpdate++;
7394       if (window)
7395         wset_vertical_scroll_bar (window, Qnil);
7396       window = 0;
7397       [self removeFromSuperview];
7398       [self release];
7399       unblock_input ();
7400     }
7401   return ret;
7405 - (void)resetCursorRects
7407   NSRect visible = [self visibleRect];
7408   NSTRACE (resetCursorRects);
7410   if (!NSIsEmptyRect (visible))
7411     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
7412   [[NSCursor arrowCursor] setOnMouseEntered: YES];
7416 - (int) checkSamePosition: (int) position portion: (int) portion
7417                     whole: (int) whole
7419   return em_position ==position && em_portion ==portion && em_whole ==whole
7420     && portion != whole; /* needed for resize empty buf */
7424 - setPosition: (int)position portion: (int)portion whole: (int)whole
7426   NSTRACE (setPosition);
7428   em_position = position;
7429   em_portion = portion;
7430   em_whole = whole;
7432   if (portion >= whole)
7433     {
7434 #ifdef NS_IMPL_COCOA
7435       [self setKnobProportion: 1.0];
7436       [self setDoubleValue: 1.0];
7437 #else
7438       [self setFloatValue: 0.0 knobProportion: 1.0];
7439 #endif
7440     }
7441   else
7442     {
7443       float pos;
7444       CGFloat por;
7445       portion = max ((float)whole*min_portion/pixel_height, portion);
7446       pos = (float)position / (whole - portion);
7447       por = (CGFloat)portion/whole;
7448 #ifdef NS_IMPL_COCOA
7449       [self setKnobProportion: por];
7450       [self setDoubleValue: pos];
7451 #else
7452       [self setFloatValue: pos knobProportion: por];
7453 #endif
7454     }
7456   return self;
7459 /* set up emacs_event */
7460 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
7462   Lisp_Object win;
7463   if (!emacs_event)
7464     return;
7466   emacs_event->part = last_hit_part;
7467   emacs_event->code = 0;
7468   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
7469   XSETWINDOW (win, window);
7470   emacs_event->frame_or_window = win;
7471   emacs_event->timestamp = EV_TIMESTAMP (e);
7472   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
7473   emacs_event->arg = Qnil;
7474   XSETINT (emacs_event->x, loc * pixel_height);
7475   XSETINT (emacs_event->y, pixel_height-20);
7477   if (q_event_ptr)
7478     {
7479       n_emacs_events_pending++;
7480       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
7481     }
7482   else
7483     hold_event (emacs_event);
7484   EVENT_INIT (*emacs_event);
7485   ns_send_appdefined (-1);
7489 /* called manually thru timer to implement repeated button action w/hold-down */
7490 - repeatScroll: (NSTimer *)scrollEntry
7492   NSEvent *e = [[self window] currentEvent];
7493   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
7494   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
7496   /* clear timer if need be */
7497   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
7498     {
7499         [scroll_repeat_entry invalidate];
7500         [scroll_repeat_entry release];
7501         scroll_repeat_entry = nil;
7503         if (inKnob)
7504           return self;
7506         scroll_repeat_entry
7507           = [[NSTimer scheduledTimerWithTimeInterval:
7508                         SCROLL_BAR_CONTINUOUS_DELAY
7509                                             target: self
7510                                           selector: @selector (repeatScroll:)
7511                                           userInfo: 0
7512                                            repeats: YES]
7513               retain];
7514     }
7516   [self sendScrollEventAtLoc: 0 fromEvent: e];
7517   return self;
7521 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
7522    mouseDragged events without going into a modal loop. */
7523 - (void)mouseDown: (NSEvent *)e
7525   NSRect sr, kr;
7526   /* hitPart is only updated AFTER event is passed on */
7527   NSScrollerPart part = [self testPart: [e locationInWindow]];
7528   CGFloat inc = 0.0, loc, kloc, pos;
7529   int edge = 0;
7531   NSTRACE (EmacsScroller_mouseDown);
7533   switch (part)
7534     {
7535     case NSScrollerDecrementPage:
7536         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
7537     case NSScrollerIncrementPage:
7538         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
7539     case NSScrollerDecrementLine:
7540       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
7541     case NSScrollerIncrementLine:
7542       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
7543     case NSScrollerKnob:
7544       last_hit_part = scroll_bar_handle; break;
7545     case NSScrollerKnobSlot:  /* GNUstep-only */
7546       last_hit_part = scroll_bar_move_ratio; break;
7547     default:  /* NSScrollerNoPart? */
7548       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
7549                (long) part);
7550       return;
7551     }
7553   if (inc != 0.0)
7554     {
7555       pos = 0;      /* ignored */
7557       /* set a timer to repeat, as we can't let superclass do this modally */
7558       scroll_repeat_entry
7559         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
7560                                             target: self
7561                                           selector: @selector (repeatScroll:)
7562                                           userInfo: 0
7563                                            repeats: YES]
7564             retain];
7565     }
7566   else
7567     {
7568       /* handle, or on GNUstep possibly slot */
7569       NSEvent *fake_event;
7571       /* compute float loc in slot and mouse offset on knob */
7572       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7573                       toView: nil];
7574       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7575       if (loc <= 0.0)
7576         {
7577           loc = 0.0;
7578           edge = -1;
7579         }
7580       else if (loc >= NSHeight (sr))
7581         {
7582           loc = NSHeight (sr);
7583           edge = 1;
7584         }
7586       if (edge)
7587         kloc = 0.5 * edge;
7588       else
7589         {
7590           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
7591                           toView: nil];
7592           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
7593         }
7594       last_mouse_offset = kloc;
7596       /* if knob, tell emacs a location offset by knob pos
7597          (to indicate top of handle) */
7598       if (part == NSScrollerKnob)
7599           pos = (loc - last_mouse_offset) / NSHeight (sr);
7600       else
7601         /* else this is a slot click on GNUstep: go straight there */
7602         pos = loc / NSHeight (sr);
7604       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
7605       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
7606                                       location: [e locationInWindow]
7607                                  modifierFlags: [e modifierFlags]
7608                                      timestamp: [e timestamp]
7609                                   windowNumber: [e windowNumber]
7610                                        context: [e context]
7611                                    eventNumber: [e eventNumber]
7612                                     clickCount: [e clickCount]
7613                                       pressure: [e pressure]];
7614       [super mouseUp: fake_event];
7615     }
7617   if (part != NSScrollerKnob)
7618     [self sendScrollEventAtLoc: pos fromEvent: e];
7622 /* Called as we manually track scroller drags, rather than superclass. */
7623 - (void)mouseDragged: (NSEvent *)e
7625     NSRect sr;
7626     double loc, pos;
7628     NSTRACE (EmacsScroller_mouseDragged);
7630       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7631                       toView: nil];
7632       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7634       if (loc <= 0.0)
7635         {
7636           loc = 0.0;
7637         }
7638       else if (loc >= NSHeight (sr) + last_mouse_offset)
7639         {
7640           loc = NSHeight (sr) + last_mouse_offset;
7641         }
7643       pos = (loc - last_mouse_offset) / NSHeight (sr);
7644       [self sendScrollEventAtLoc: pos fromEvent: e];
7648 - (void)mouseUp: (NSEvent *)e
7650   if (scroll_repeat_entry)
7651     {
7652       [scroll_repeat_entry invalidate];
7653       [scroll_repeat_entry release];
7654       scroll_repeat_entry = nil;
7655     }
7656   last_hit_part = scroll_bar_above_handle;
7660 /* treat scrollwheel events in the bar as though they were in the main window */
7661 - (void) scrollWheel: (NSEvent *)theEvent
7663   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
7664   [view mouseDown: theEvent];
7667 @end  /* EmacsScroller */
7670 #ifdef NS_IMPL_GNUSTEP
7671 /* Dummy class to get rid of startup warnings.  */
7672 @implementation EmacsDocument
7674 @end
7675 #endif
7678 /* ==========================================================================
7680    Font-related functions; these used to be in nsfaces.m
7682    ========================================================================== */
7685 Lisp_Object
7686 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7688   struct font *font = XFONT_OBJECT (font_object);
7689   EmacsView *view = FRAME_NS_VIEW (f);
7691   if (fontset < 0)
7692     fontset = fontset_from_font (font_object);
7693   FRAME_FONTSET (f) = fontset;
7695   if (FRAME_FONT (f) == font)
7696     /* This font is already set in frame F.  There's nothing more to
7697        do.  */
7698     return font_object;
7700   FRAME_FONT (f) = font;
7702   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7703   FRAME_COLUMN_WIDTH (f) = font->average_width;
7704   FRAME_LINE_HEIGHT (f) = font->height;
7706   /* Compute the scroll bar width in character columns.  */
7707   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7708     {
7709       int wid = FRAME_COLUMN_WIDTH (f);
7710       FRAME_CONFIG_SCROLL_BAR_COLS (f)
7711         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
7712     }
7713   else
7714     {
7715       int wid = FRAME_COLUMN_WIDTH (f);
7716       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7717     }
7719   /* Compute the scroll bar height in character lines.  */
7720   if (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0)
7721     {
7722       int height = FRAME_LINE_HEIGHT (f);
7723       FRAME_CONFIG_SCROLL_BAR_LINES (f)
7724         = (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) + height - 1) / height;
7725     }
7726   else
7727     {
7728       int height = FRAME_LINE_HEIGHT (f);
7729       FRAME_CONFIG_SCROLL_BAR_LINES (f) = (14 + height - 1) / height;
7730     }
7732   /* Now make the frame display the given font.  */
7733   if (FRAME_NS_WINDOW (f) != 0 && ! [view isFullscreen])
7734     x_set_window_size (f, false, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
7735                        FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), true);
7737   return font_object;
7741 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
7742 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
7743          in 1.43. */
7745 const char *
7746 ns_xlfd_to_fontname (const char *xlfd)
7747 /* --------------------------------------------------------------------------
7748     Convert an X font name (XLFD) to an NS font name.
7749     Only family is used.
7750     The string returned is temporarily allocated.
7751    -------------------------------------------------------------------------- */
7753   char *name = xmalloc (180);
7754   int i, len;
7755   const char *ret;
7757   if (!strncmp (xlfd, "--", 2))
7758     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
7759   else
7760     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
7762   /* stopgap for malformed XLFD input */
7763   if (strlen (name) == 0)
7764     strcpy (name, "Monaco");
7766   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
7767      also uppercase after '-' or ' ' */
7768   name[0] = c_toupper (name[0]);
7769   for (len =strlen (name), i =0; i<len; i++)
7770     {
7771       if (name[i] == '$')
7772         {
7773           name[i] = '-';
7774           if (i+1<len)
7775             name[i+1] = c_toupper (name[i+1]);
7776         }
7777       else if (name[i] == '_')
7778         {
7779           name[i] = ' ';
7780           if (i+1<len)
7781             name[i+1] = c_toupper (name[i+1]);
7782         }
7783     }
7784 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
7785   ret = [[NSString stringWithUTF8String: name] UTF8String];
7786   xfree (name);
7787   return ret;
7791 void
7792 syms_of_nsterm (void)
7794   NSTRACE (syms_of_nsterm);
7796   ns_antialias_threshold = 10.0;
7798   /* from 23+ we need to tell emacs what modifiers there are.. */
7799   DEFSYM (Qmodifier_value, "modifier-value");
7800   DEFSYM (Qalt, "alt");
7801   DEFSYM (Qhyper, "hyper");
7802   DEFSYM (Qmeta, "meta");
7803   DEFSYM (Qsuper, "super");
7804   DEFSYM (Qcontrol, "control");
7805   DEFSYM (QUTF8_STRING, "UTF8_STRING");
7807   DEFSYM (Qfile, "file");
7808   DEFSYM (Qurl, "url");
7810   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
7811   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
7812   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
7813   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
7814   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
7816   DEFVAR_LISP ("ns-input-file", ns_input_file,
7817               "The file specified in the last NS event.");
7818   ns_input_file =Qnil;
7820   DEFVAR_LISP ("ns-working-text", ns_working_text,
7821               "String for visualizing working composition sequence.");
7822   ns_working_text =Qnil;
7824   DEFVAR_LISP ("ns-input-font", ns_input_font,
7825               "The font specified in the last NS event.");
7826   ns_input_font =Qnil;
7828   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
7829               "The fontsize specified in the last NS event.");
7830   ns_input_fontsize =Qnil;
7832   DEFVAR_LISP ("ns-input-line", ns_input_line,
7833                "The line specified in the last NS event.");
7834   ns_input_line =Qnil;
7836   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
7837                "The service name specified in the last NS event.");
7838   ns_input_spi_name =Qnil;
7840   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
7841                "The service argument specified in the last NS event.");
7842   ns_input_spi_arg =Qnil;
7844   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
7845                "This variable describes the behavior of the alternate or option key.\n\
7846 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7847 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7848 at all, allowing it to be used at a lower level for accented character entry.");
7849   ns_alternate_modifier = Qmeta;
7851   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
7852                "This variable describes the behavior of the right alternate or option key.\n\
7853 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7854 Set to left means be the same key as `ns-alternate-modifier'.\n\
7855 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7856 at all, allowing it to be used at a lower level for accented character entry.");
7857   ns_right_alternate_modifier = Qleft;
7859   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
7860                "This variable describes the behavior of the command key.\n\
7861 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7862   ns_command_modifier = Qsuper;
7864   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
7865                "This variable describes the behavior of the right command key.\n\
7866 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7867 Set to left means be the same key as `ns-command-modifier'.\n\
7868 Set to none means that the command / option key is not interpreted by Emacs\n\
7869 at all, allowing it to be used at a lower level for accented character entry.");
7870   ns_right_command_modifier = Qleft;
7872   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
7873                "This variable describes the behavior of the control key.\n\
7874 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7875   ns_control_modifier = Qcontrol;
7877   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
7878                "This variable describes the behavior of the right control key.\n\
7879 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7880 Set to left means be the same key as `ns-control-modifier'.\n\
7881 Set to none means that the control / option key is not interpreted by Emacs\n\
7882 at all, allowing it to be used at a lower level for accented character entry.");
7883   ns_right_control_modifier = Qleft;
7885   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
7886                "This variable describes the behavior of the function key (on laptops).\n\
7887 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7888 Set to none means that the function key is not interpreted by Emacs at all,\n\
7889 allowing it to be used at a lower level for accented character entry.");
7890   ns_function_modifier = Qnone;
7892   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
7893                "Non-nil (the default) means to render text antialiased.");
7894   ns_antialias_text = Qt;
7896   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
7897                "Whether to confirm application quit using dialog.");
7898   ns_confirm_quit = Qnil;
7900   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
7901                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
7902 Only works on OSX 10.6 or later.  */);
7903   ns_auto_hide_menu_bar = Qnil;
7905   DEFVAR_BOOL ("ns-use-native-fullscreen", ns_use_native_fullscreen,
7906      doc: /*Non-nil means to use native fullscreen on OSX >= 10.7.
7907 Nil means use fullscreen the old (< 10.7) way.  The old way works better with
7908 multiple monitors, but lacks tool bar.  This variable is ignored on OSX < 10.7.
7909 Default is t for OSX >= 10.7, nil otherwise.  */);
7910 #ifdef HAVE_NATIVE_FS
7911   ns_use_native_fullscreen = YES;
7912 #else
7913   ns_use_native_fullscreen = NO;
7914 #endif
7915   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
7917   DEFVAR_BOOL ("ns-use-fullscreen-animation", ns_use_fullscreen_animation,
7918      doc: /*Non-nil means use animation on non-native fullscreen.
7919 For native fullscreen, this does nothing.
7920 Default is nil.  */);
7921   ns_use_fullscreen_animation = NO;
7923   DEFVAR_BOOL ("ns-use-srgb-colorspace", ns_use_srgb_colorspace,
7924      doc: /*Non-nil means to use sRGB colorspace on OSX >= 10.7.
7925 Note that this does not apply to images.
7926 This variable is ignored on OSX < 10.7 and GNUstep.  */);
7927   ns_use_srgb_colorspace = YES;
7929   /* TODO: move to common code */
7930   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
7931                doc: /* Which toolkit scroll bars Emacs uses, if any.
7932 A value of nil means Emacs doesn't use toolkit scroll bars.
7933 With the X Window system, the value is a symbol describing the
7934 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
7935 With MS Windows or Nextstep, the value is t.  */);
7936   Vx_toolkit_scroll_bars = Qt;
7938   DEFVAR_BOOL ("x-use-underline-position-properties",
7939                x_use_underline_position_properties,
7940      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
7941 A value of nil means ignore them.  If you encounter fonts with bogus
7942 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
7943 to 4.1, set this to nil. */);
7944   x_use_underline_position_properties = 0;
7946   DEFVAR_BOOL ("x-underline-at-descent-line",
7947                x_underline_at_descent_line,
7948      doc: /* Non-nil means to draw the underline at the same place as the descent line.
7949 A value of nil means to draw the underline according to the value of the
7950 variable `x-use-underline-position-properties', which is usually at the
7951 baseline level.  The default value is nil.  */);
7952   x_underline_at_descent_line = 0;
7954   /* Tell Emacs about this window system.  */
7955   Fprovide (Qns, Qnil);
7957   DEFSYM (Qcocoa, "cocoa");
7958   DEFSYM (Qgnustep, "gnustep");
7960 #ifdef NS_IMPL_COCOA
7961   Fprovide (Qcocoa, Qnil);
7962   syms_of_macfont ();
7963 #else
7964   Fprovide (Qgnustep, Qnil);
7965   syms_of_nsfont ();
7966 #endif