*.[chm]: Number every assignment to windows_or_buffers_changed.
[emacs/old-mirror.git] / src / nsterm.m
blob0e7667b6dc653c5b1083ac5d217bee2b76c9b82e
1 /* NeXT/Open/GNUstep / MacOSX communication module.
3 Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2013 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
22 Originally by Carl Edman
23 Updated by Christian Limpach (chris@nice.ch)
24 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
25 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
26 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
29 /* This should be the first include, as it may set up #defines affecting
30    interpretation of even the system includes. */
31 #include <config.h>
33 #include <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"
58 #include "window.h"
59 #include "keyboard.h"
60 #include "buffer.h"
61 #include "font.h"
63 #ifdef NS_IMPL_GNUSTEP
64 #include "process.h"
65 #endif
67 #ifdef NS_IMPL_COCOA
68 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
69 #include "macfont.h"
70 #endif
71 #endif
73 /* call tracing */
74 #if 0
75 int term_trace_num = 0;
76 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
77                                 __FILE__, __LINE__, ++term_trace_num)
78 #else
79 #define NSTRACE(x)
80 #endif
82 extern NSString *NSMenuDidBeginTrackingNotification;
84 /* ==========================================================================
86     Local declarations
88    ========================================================================== */
90 /* Convert a symbol indexed with an NSxxx value to a value as defined
91    in keyboard.c (lispy_function_key). I hope this is a correct way
92    of doing things... */
93 static unsigned convert_ns_to_X_keysym[] =
95   NSHomeFunctionKey,            0x50,
96   NSLeftArrowFunctionKey,       0x51,
97   NSUpArrowFunctionKey,         0x52,
98   NSRightArrowFunctionKey,      0x53,
99   NSDownArrowFunctionKey,       0x54,
100   NSPageUpFunctionKey,          0x55,
101   NSPageDownFunctionKey,        0x56,
102   NSEndFunctionKey,             0x57,
103   NSBeginFunctionKey,           0x58,
104   NSSelectFunctionKey,          0x60,
105   NSPrintFunctionKey,           0x61,
106   NSClearLineFunctionKey,       0x0B,
107   NSExecuteFunctionKey,         0x62,
108   NSInsertFunctionKey,          0x63,
109   NSUndoFunctionKey,            0x65,
110   NSRedoFunctionKey,            0x66,
111   NSMenuFunctionKey,            0x67,
112   NSFindFunctionKey,            0x68,
113   NSHelpFunctionKey,            0x6A,
114   NSBreakFunctionKey,           0x6B,
116   NSF1FunctionKey,              0xBE,
117   NSF2FunctionKey,              0xBF,
118   NSF3FunctionKey,              0xC0,
119   NSF4FunctionKey,              0xC1,
120   NSF5FunctionKey,              0xC2,
121   NSF6FunctionKey,              0xC3,
122   NSF7FunctionKey,              0xC4,
123   NSF8FunctionKey,              0xC5,
124   NSF9FunctionKey,              0xC6,
125   NSF10FunctionKey,             0xC7,
126   NSF11FunctionKey,             0xC8,
127   NSF12FunctionKey,             0xC9,
128   NSF13FunctionKey,             0xCA,
129   NSF14FunctionKey,             0xCB,
130   NSF15FunctionKey,             0xCC,
131   NSF16FunctionKey,             0xCD,
132   NSF17FunctionKey,             0xCE,
133   NSF18FunctionKey,             0xCF,
134   NSF19FunctionKey,             0xD0,
135   NSF20FunctionKey,             0xD1,
136   NSF21FunctionKey,             0xD2,
137   NSF22FunctionKey,             0xD3,
138   NSF23FunctionKey,             0xD4,
139   NSF24FunctionKey,             0xD5,
141   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
142   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
143   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
145   NSTabCharacter,               0x09,
146   0x19,                         0x09,  /* left tab->regular since pass shift */
147   NSCarriageReturnCharacter,    0x0D,
148   NSNewlineCharacter,           0x0D,
149   NSEnterCharacter,             0x8D,
151   0x41|NSNumericPadKeyMask,     0xAE,  /* KP_Decimal */
152   0x43|NSNumericPadKeyMask,     0xAA,  /* KP_Multiply */
153   0x45|NSNumericPadKeyMask,     0xAB,  /* KP_Add */
154   0x4B|NSNumericPadKeyMask,     0xAF,  /* KP_Divide */
155   0x4E|NSNumericPadKeyMask,     0xAD,  /* KP_Subtract */
156   0x51|NSNumericPadKeyMask,     0xBD,  /* KP_Equal */
157   0x52|NSNumericPadKeyMask,     0xB0,  /* KP_0 */
158   0x53|NSNumericPadKeyMask,     0xB1,  /* KP_1 */
159   0x54|NSNumericPadKeyMask,     0xB2,  /* KP_2 */
160   0x55|NSNumericPadKeyMask,     0xB3,  /* KP_3 */
161   0x56|NSNumericPadKeyMask,     0xB4,  /* KP_4 */
162   0x57|NSNumericPadKeyMask,     0xB5,  /* KP_5 */
163   0x58|NSNumericPadKeyMask,     0xB6,  /* KP_6 */
164   0x59|NSNumericPadKeyMask,     0xB7,  /* KP_7 */
165   0x5B|NSNumericPadKeyMask,     0xB8,  /* KP_8 */
166   0x5C|NSNumericPadKeyMask,     0xB9,  /* KP_9 */
168   0x1B,                         0x1B   /* escape */
171 static Lisp_Object Qmodifier_value;
172 Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper;
173 extern Lisp_Object Qcursor_color, Qcursor_type, Qns, Qleft;
175 static Lisp_Object QUTF8_STRING;
176 static Lisp_Object Qcocoa, Qgnustep;
178 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
179    the maximum font size to NOT antialias.  On GNUstep there is currently
180    no way to control this behavior. */
181 float ns_antialias_threshold;
183 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
184 NSString *ns_app_name = @"Emacs";  /* default changed later */
186 /* Display variables */
187 struct ns_display_info *x_display_list; /* Chain of existing displays */
188 long context_menu_value = 0;
190 /* display update */
191 static struct frame *ns_updating_frame;
192 static NSView *focus_view = NULL;
193 static int ns_window_num = 0;
194 #ifdef NS_IMPL_GNUSTEP
195 static NSRect uRect;
196 #endif
197 static BOOL gsaved = NO;
198 static BOOL ns_fake_keydown = NO;
199 #ifdef NS_IMPL_COCOA
200 static BOOL ns_menu_bar_is_hidden = NO;
201 #endif
202 /*static int debug_lock = 0; */
204 /* event loop */
205 static BOOL send_appdefined = YES;
206 #define NO_APPDEFINED_DATA (-8)
207 static int last_appdefined_event_data = NO_APPDEFINED_DATA;
208 static NSTimer *timed_entry = 0;
209 static NSTimer *scroll_repeat_entry = nil;
210 static fd_set select_readfds, select_writefds;
211 enum { SELECT_HAVE_READ = 1, SELECT_HAVE_WRITE = 2, SELECT_HAVE_TMO = 4 };
212 static int select_nfds = 0, select_valid = 0;
213 static struct timespec select_timeout = { 0, 0 };
214 static int selfds[2] = { -1, -1 };
215 static pthread_mutex_t select_mutex;
216 static int apploopnr = 0;
217 static NSAutoreleasePool *outerpool;
218 static struct input_event *emacs_event = NULL;
219 static struct input_event *q_event_ptr = NULL;
220 static int n_emacs_events_pending = 0;
221 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
222   *ns_pending_service_args;
223 static BOOL ns_do_open_file = NO;
224 static BOOL ns_last_use_native_fullscreen;
226 static struct {
227   struct input_event *q;
228   int nr, cap;
229 } hold_event_q = {
230   NULL, 0, 0
233 #ifdef NS_IMPL_COCOA
235  * State for pending menu activation:
236  * MENU_NONE     Normal state
237  * MENU_PENDING  A menu has been clicked on, but has been canceled so we can
238  *               run lisp to update the menu.
239  * MENU_OPENING  Menu is up to date, and the click event is redone so the menu
240  *               will open.
241  */
242 #define MENU_NONE 0
243 #define MENU_PENDING 1
244 #define MENU_OPENING 2
245 static int menu_will_open_state = MENU_NONE;
247 /* Saved position for menu click.  */
248 static CGPoint menu_mouse_point;
249 #endif
251 /* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
252 #define NS_FUNCTION_KEY_MASK 0x800000
253 #define NSLeftControlKeyMask    (0x000001 | NSControlKeyMask)
254 #define NSRightControlKeyMask   (0x002000 | NSControlKeyMask)
255 #define NSLeftCommandKeyMask    (0x000008 | NSCommandKeyMask)
256 #define NSRightCommandKeyMask   (0x000010 | NSCommandKeyMask)
257 #define NSLeftAlternateKeyMask  (0x000020 | NSAlternateKeyMask)
258 #define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
259 #define EV_MODIFIERS(e)                               \
260     ((([e modifierFlags] & NSHelpKeyMask) ?           \
261            hyper_modifier : 0)                        \
262      | (!EQ (ns_right_alternate_modifier, Qleft) && \
263         (([e modifierFlags] & NSRightAlternateKeyMask) \
264          == NSRightAlternateKeyMask) ? \
265            parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
266      | (([e modifierFlags] & NSAlternateKeyMask) ?                 \
267            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
268      | (([e modifierFlags] & NSShiftKeyMask) ?     \
269            shift_modifier : 0)                        \
270      | (!EQ (ns_right_control_modifier, Qleft) && \
271         (([e modifierFlags] & NSRightControlKeyMask) \
272          == NSRightControlKeyMask) ? \
273            parse_solitary_modifier (ns_right_control_modifier) : 0) \
274      | (([e modifierFlags] & NSControlKeyMask) ?      \
275            parse_solitary_modifier (ns_control_modifier) : 0)     \
276      | (([e modifierFlags] & NS_FUNCTION_KEY_MASK) ?  \
277            parse_solitary_modifier (ns_function_modifier) : 0)    \
278      | (!EQ (ns_right_command_modifier, Qleft) && \
279         (([e modifierFlags] & NSRightCommandKeyMask) \
280          == NSRightCommandKeyMask) ? \
281            parse_solitary_modifier (ns_right_command_modifier) : 0) \
282      | (([e modifierFlags] & NSCommandKeyMask) ?      \
283            parse_solitary_modifier (ns_command_modifier):0))
285 #define EV_UDMODIFIERS(e)                                      \
286     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
287      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
288      | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
289      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
290      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
291      | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
292      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
293      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
294      | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
296 #define EV_BUTTON(e)                                                         \
297     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
298       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
299      [e buttonNumber] - 1)
301 /* Convert the time field to a timestamp in milliseconds. */
302 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
304 /* This is a piece of code which is common to all the event handling
305    methods.  Maybe it should even be a function.  */
306 #define EV_TRAILER(e)                                                   \
307   {                                                                     \
308     XSETFRAME (emacs_event->frame_or_window, emacsframe);               \
309     EV_TRAILER2 (e);                                                    \
310   }
312 #define EV_TRAILER2(e)                                                  \
313   {                                                                     \
314       if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
315       if (q_event_ptr)                                                  \
316         {                                                               \
317           n_emacs_events_pending++;                                     \
318           kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
319         }                                                               \
320       else                                                              \
321         hold_event (emacs_event);                                       \
322       EVENT_INIT (*emacs_event);                                        \
323       ns_send_appdefined (-1);                                          \
324     }
326 /* TODO: get rid of need for these forward declarations */
327 static void ns_condemn_scroll_bars (struct frame *f);
328 static void ns_judge_scroll_bars (struct frame *f);
329 void x_set_frame_alpha (struct frame *f);
332 /* ==========================================================================
334     Utilities
336    ========================================================================== */
338 static void
339 hold_event (struct input_event *event)
341   if (hold_event_q.nr == hold_event_q.cap)
342     {
343       if (hold_event_q.cap == 0) hold_event_q.cap = 10;
344       else hold_event_q.cap *= 2;
345       hold_event_q.q =
346         xrealloc (hold_event_q.q, hold_event_q.cap * sizeof *hold_event_q.q);
347     }
349   hold_event_q.q[hold_event_q.nr++] = *event;
350   /* Make sure ns_read_socket is called, i.e. we have input.  */
351   raise (SIGIO);
352   send_appdefined = YES;
355 static Lisp_Object
356 append2 (Lisp_Object list, Lisp_Object item)
357 /* --------------------------------------------------------------------------
358    Utility to append to a list
359    -------------------------------------------------------------------------- */
361   Lisp_Object array[2];
362   array[0] = list;
363   array[1] = list1 (item);
364   return Fnconc (2, &array[0]);
368 const char *
369 ns_etc_directory (void)
370 /* If running as a self-contained app bundle, return as a string the
371    filename of the etc directory, if present; else nil.  */
373   NSBundle *bundle = [NSBundle mainBundle];
374   NSString *resourceDir = [bundle resourcePath];
375   NSString *resourcePath;
376   NSFileManager *fileManager = [NSFileManager defaultManager];
377   BOOL isDir;
379   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
380   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
381     {
382       if (isDir) return [resourcePath UTF8String];
383     }
384   return NULL;
388 const char *
389 ns_exec_path (void)
390 /* If running as a self-contained app bundle, return as a path string
391    the filenames of the libexec and bin directories, ie libexec:bin.
392    Otherwise, return nil.
393    Normally, Emacs does not add its own bin/ directory to the PATH.
394    However, a self-contained NS build has a different layout, with
395    bin/ and libexec/ subdirectories in the directory that contains
396    Emacs.app itself.
397    We put libexec first, because init_callproc_1 uses the first
398    element to initialize exec-directory.  An alternative would be
399    for init_callproc to check for invocation-directory/libexec.
402   NSBundle *bundle = [NSBundle mainBundle];
403   NSString *resourceDir = [bundle resourcePath];
404   NSString *binDir = [bundle bundlePath];
405   NSString *resourcePath, *resourcePaths;
406   NSRange range;
407   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
408   NSFileManager *fileManager = [NSFileManager defaultManager];
409   NSArray *paths;
410   NSEnumerator *pathEnum;
411   BOOL isDir;
413   range = [resourceDir rangeOfString: @"Contents"];
414   if (range.location != NSNotFound)
415     {
416       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
417 #ifdef NS_IMPL_COCOA
418       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
419 #endif
420     }
422   paths = [binDir stringsByAppendingPaths:
423                 [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
424   pathEnum = [paths objectEnumerator];
425   resourcePaths = @"";
427   while ((resourcePath = [pathEnum nextObject]))
428     {
429       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
430         if (isDir)
431           {
432             if ([resourcePaths length] > 0)
433               resourcePaths
434                 = [resourcePaths stringByAppendingString: pathSeparator];
435             resourcePaths
436               = [resourcePaths stringByAppendingString: resourcePath];
437           }
438     }
439   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
441   return NULL;
445 const char *
446 ns_load_path (void)
447 /* If running as a self-contained app bundle, return as a path string
448    the filenames of the site-lisp, lisp and leim directories.
449    Ie, site-lisp:lisp:leim.  Otherwise, return nil.  */
451   NSBundle *bundle = [NSBundle mainBundle];
452   NSString *resourceDir = [bundle resourcePath];
453   NSString *resourcePath, *resourcePaths;
454   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
455   NSFileManager *fileManager = [NSFileManager defaultManager];
456   BOOL isDir;
457   NSArray *paths = [resourceDir stringsByAppendingPaths:
458                               [NSArray arrayWithObjects:
459                                          @"site-lisp", @"lisp", @"leim", nil]];
460   NSEnumerator *pathEnum = [paths objectEnumerator];
461   resourcePaths = @"";
463   /* Hack to skip site-lisp.  */
464   if (no_site_lisp) resourcePath = [pathEnum nextObject];
466   while ((resourcePath = [pathEnum nextObject]))
467     {
468       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
469         if (isDir)
470           {
471             if ([resourcePaths length] > 0)
472               resourcePaths
473                 = [resourcePaths stringByAppendingString: pathSeparator];
474             resourcePaths
475               = [resourcePaths stringByAppendingString: resourcePath];
476           }
477     }
478   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
480   return NULL;
483 static void
484 ns_timeout (int usecs)
485 /* --------------------------------------------------------------------------
486      Blocking timer utility used by ns_ring_bell
487    -------------------------------------------------------------------------- */
489   struct timespec wakeup = timespec_add (current_timespec (),
490                                          make_timespec (0, usecs * 1000));
492   /* Keep waiting until past the time wakeup.  */
493   while (1)
494     {
495       struct timespec timeout, now = current_timespec ();
496       if (timespec_cmp (wakeup, now) <= 0)
497         break;
498       timeout = timespec_sub (wakeup, now);
500       /* Try to wait that long--but we might wake up sooner.  */
501       pselect (0, NULL, NULL, NULL, &timeout, NULL);
502     }
506 void
507 ns_release_object (void *obj)
508 /* --------------------------------------------------------------------------
509     Release an object (callable from C)
510    -------------------------------------------------------------------------- */
512     [(id)obj release];
516 void
517 ns_retain_object (void *obj)
518 /* --------------------------------------------------------------------------
519     Retain an object (callable from C)
520    -------------------------------------------------------------------------- */
522     [(id)obj retain];
526 void *
527 ns_alloc_autorelease_pool (void)
528 /* --------------------------------------------------------------------------
529      Allocate a pool for temporary objects (callable from C)
530    -------------------------------------------------------------------------- */
532   return [[NSAutoreleasePool alloc] init];
536 void
537 ns_release_autorelease_pool (void *pool)
538 /* --------------------------------------------------------------------------
539      Free a pool and temporary objects it refers to (callable from C)
540    -------------------------------------------------------------------------- */
542   ns_release_object (pool);
547 /* ==========================================================================
549     Focus (clipping) and screen update
551    ========================================================================== */
554 // Window constraining
555 // -------------------
557 // To ensure that the windows are not placed under the menu bar, they
558 // are typically moved by the call-back constrainFrameRect. However,
559 // by overriding it, it's possible to inhibit this, leaving the window
560 // in it's original position.
562 // It's possible to hide the menu bar. However, technically, it's only
563 // possible to hide it when the application is active. To ensure that
564 // this work properly, the menu bar and window constraining are
565 // deferred until the application becomes active.
567 // Even though it's not possible to manually move a window above the
568 // top of the screen, it is allowed if it's done programmatically,
569 // when the menu is hidden. This allows the editable area to cover the
570 // full screen height.
572 // Test cases
573 // ----------
575 // Use the following extra files:
577 //    init.el:
578 //       ;; Hide menu and place frame slightly above the top of the screen.
579 //       (setq ns-auto-hide-menu-bar t)
580 //       (set-frame-position (selected-frame) 0 -20)
582 // Test 1:
584 //    emacs -Q -l init.el
586 //    Result: No menu bar, and the title bar should be above the screen.
588 // Test 2:
590 //    emacs -Q
592 //    Result: Menu bar visible, frame placed immediately below the menu.
595 static void
596 ns_constrain_all_frames (void)
598   Lisp_Object tail, frame;
600   FOR_EACH_FRAME (tail, frame)
601     {
602       struct frame *f = XFRAME (frame);
603       if (FRAME_NS_P (f))
604         {
605           NSView *view = FRAME_NS_VIEW (f);
606           /* This no-op will trigger the default window placing
607            * constraint system. */
608           f->output_data.ns->dont_constrain = 0;
609           [[view window] setFrameOrigin:[[view window] frame].origin];
610         }
611     }
615 /* True, if the menu bar should be hidden.  */
617 static BOOL
618 ns_menu_bar_should_be_hidden (void)
620   return !NILP (ns_auto_hide_menu_bar)
621     && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
625 /* Show or hide the menu bar, based on user setting.  */
627 static void
628 ns_update_auto_hide_menu_bar (void)
630 #ifdef NS_IMPL_COCOA
631 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
632   block_input ();
634   NSTRACE (ns_update_auto_hide_menu_bar);
636   if (NSApp != nil && [NSApp isActive])
637     {
638       // Note, "setPresentationOptions" triggers an error unless the
639       // application is active.
640       BOOL menu_bar_should_be_hidden = ns_menu_bar_should_be_hidden ();
642       if (menu_bar_should_be_hidden != ns_menu_bar_is_hidden)
643         {
644           NSApplicationPresentationOptions options
645             = NSApplicationPresentationDefault;
647           if (menu_bar_should_be_hidden)
648             options |= NSApplicationPresentationAutoHideMenuBar
649               | NSApplicationPresentationAutoHideDock;
651           [NSApp setPresentationOptions: options];
653           ns_menu_bar_is_hidden = menu_bar_should_be_hidden;
655           if (!ns_menu_bar_is_hidden)
656             {
657               ns_constrain_all_frames ();
658             }
659         }
660     }
662   unblock_input ();
663 #endif
664 #endif
668 static void
669 ns_update_begin (struct frame *f)
670 /* --------------------------------------------------------------------------
671    Prepare for a grouped sequence of drawing calls
672    external (RIF) call; whole frame, called before update_window_begin
673    -------------------------------------------------------------------------- */
675   EmacsView *view = FRAME_NS_VIEW (f);
676   NSTRACE (ns_update_begin);
678   ns_update_auto_hide_menu_bar ();
680 #ifdef NS_IMPL_COCOA
681   if ([view isFullscreen] && [view fsIsNative])
682   {
683     // Fix reappearing tool bar in fullscreen for OSX 10.7
684     BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (f) ? YES : NO;
685     NSToolbar *toolbar = [FRAME_NS_VIEW (f) toolbar];
686     if (! tbar_visible != ! [toolbar isVisible])
687       [toolbar setVisible: tbar_visible];
688   }
689 #endif
691   ns_updating_frame = f;
692   [view lockFocus];
694   /* drawRect may have been called for say the minibuffer, and then clip path
695      is for the minibuffer.  But the display engine may draw more because
696      we have set the frame as garbaged.  So reset clip path to the whole
697      view.  */
698 #ifdef NS_IMPL_COCOA
699   {
700     NSBezierPath *bp;
701     NSRect r = [view frame];
702     NSRect cr = [[view window] frame];
703     /* If a large frame size is set, r may be larger than the window frame
704        before constrained.  In that case don't change the clip path, as we
705        will clear in to the tool bar and title bar.  */
706     if (r.size.height
707         + FRAME_NS_TITLEBAR_HEIGHT (f)
708         + FRAME_TOOLBAR_HEIGHT (f) <= cr.size.height)
709       {
710         bp = [[NSBezierPath bezierPathWithRect: r] retain];
711         [bp setClip];
712         [bp release];
713       }
714   }
715 #endif
717 #ifdef NS_IMPL_GNUSTEP
718   uRect = NSMakeRect (0, 0, 0, 0);
719 #endif
723 static void
724 ns_update_window_begin (struct window *w)
725 /* --------------------------------------------------------------------------
726    Prepare for a grouped sequence of drawing calls
727    external (RIF) call; for one window, called after update_begin
728    -------------------------------------------------------------------------- */
730   struct frame *f = XFRAME (WINDOW_FRAME (w));
731   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
733   NSTRACE (ns_update_window_begin);
734   w->output_cursor = w->cursor;
736   block_input ();
738   if (f == hlinfo->mouse_face_mouse_frame)
739     {
740       /* Don't do highlighting for mouse motion during the update.  */
741       hlinfo->mouse_face_defer = 1;
743         /* If the frame needs to be redrawn,
744            simply forget about any prior mouse highlighting.  */
745       if (FRAME_GARBAGED_P (f))
746         hlinfo->mouse_face_window = Qnil;
748       /* (further code for mouse faces ifdef'd out in other terms elided) */
749     }
751   unblock_input ();
755 static void
756 ns_update_window_end (struct window *w, bool cursor_on_p,
757                       bool mouse_face_overwritten_p)
758 /* --------------------------------------------------------------------------
759    Finished a grouped sequence of drawing calls
760    external (RIF) call; for one window called before update_end
761    -------------------------------------------------------------------------- */
763   /* note: this fn is nearly identical in all terms */
764   if (!w->pseudo_window_p)
765     {
766       block_input ();
768       if (cursor_on_p)
769         display_and_set_cursor (w, 1,
770                                 w->output_cursor.hpos, w->output_cursor.vpos,
771                                 w->output_cursor.x, w->output_cursor.y);
773       if (draw_window_fringes (w, 1))
774         x_draw_vertical_border (w);
776       unblock_input ();
777     }
779   /* If a row with mouse-face was overwritten, arrange for
780      frame_up_to_date to redisplay the mouse highlight.  */
781   if (mouse_face_overwritten_p)
782     reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
784   NSTRACE (update_window_end);
788 static void
789 ns_update_end (struct frame *f)
790 /* --------------------------------------------------------------------------
791    Finished a grouped sequence of drawing calls
792    external (RIF) call; for whole frame, called after update_window_end
793    -------------------------------------------------------------------------- */
795   EmacsView *view = FRAME_NS_VIEW (f);
797 /*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
798   MOUSE_HL_INFO (f)->mouse_face_defer = 0;
800   block_input ();
802   [view unlockFocus];
803   [[view window] flushWindow];
805   unblock_input ();
806   ns_updating_frame = NULL;
807   NSTRACE (ns_update_end);
810 static void
811 ns_focus (struct frame *f, NSRect *r, int n)
812 /* --------------------------------------------------------------------------
813    Internal: Focus on given frame.  During small local updates this is used to
814      draw, however during large updates, ns_update_begin and ns_update_end are
815      called to wrap the whole thing, in which case these calls are stubbed out.
816      Except, on GNUstep, we accumulate the rectangle being drawn into, because
817      the back end won't do this automatically, and will just end up flushing
818      the entire window.
819    -------------------------------------------------------------------------- */
821 //  NSTRACE (ns_focus);
822 /* static int c =0;
823    fprintf (stderr, "focus: %d", c++);
824    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
825    fprintf (stderr, "\n"); */
827   if (f != ns_updating_frame)
828     {
829       NSView *view = FRAME_NS_VIEW (f);
830       if (view != focus_view)
831         {
832           if (focus_view != NULL)
833             {
834               [focus_view unlockFocus];
835               [[focus_view window] flushWindow];
836 /*debug_lock--; */
837             }
839           if (view)
840             [view lockFocus];
841           focus_view = view;
842 /*if (view) debug_lock++; */
843         }
844     }
846   /* clipping */
847   if (r)
848     {
849       [[NSGraphicsContext currentContext] saveGraphicsState];
850       if (n == 2)
851         NSRectClipList (r, 2);
852       else
853         NSRectClip (*r);
854       gsaved = YES;
855     }
859 static void
860 ns_unfocus (struct frame *f)
861 /* --------------------------------------------------------------------------
862      Internal: Remove focus on given frame
863    -------------------------------------------------------------------------- */
865 //  NSTRACE (ns_unfocus);
867   if (gsaved)
868     {
869       [[NSGraphicsContext currentContext] restoreGraphicsState];
870       gsaved = NO;
871     }
873   if (f != ns_updating_frame)
874     {
875       if (focus_view != NULL)
876         {
877           [focus_view unlockFocus];
878           [[focus_view window] flushWindow];
879           focus_view = NULL;
880 /*debug_lock--; */
881         }
882     }
886 static void
887 ns_clip_to_row (struct window *w, struct glyph_row *row,
888                 enum glyph_row_area area, BOOL gc)
889 /* --------------------------------------------------------------------------
890      Internal (but parallels other terms): Focus drawing on given row
891    -------------------------------------------------------------------------- */
893   struct frame *f = XFRAME (WINDOW_FRAME (w));
894   NSRect clip_rect;
895   int window_x, window_y, window_width;
897   window_box (w, area, &window_x, &window_y, &window_width, 0);
899   clip_rect.origin.x = window_x;
900   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
901   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
902   clip_rect.size.width = window_width;
903   clip_rect.size.height = row->visible_height;
905   ns_focus (f, &clip_rect, 1);
909 static void
910 ns_ring_bell (struct frame *f)
911 /* --------------------------------------------------------------------------
912      "Beep" routine
913    -------------------------------------------------------------------------- */
915   NSTRACE (ns_ring_bell);
916   if (visible_bell)
917     {
918       NSAutoreleasePool *pool;
919       struct frame *frame = SELECTED_FRAME ();
920       NSView *view;
922       block_input ();
923       pool = [[NSAutoreleasePool alloc] init];
925       view = FRAME_NS_VIEW (frame);
926       if (view != nil)
927         {
928           NSRect r, surr;
929           NSPoint dim = NSMakePoint (128, 128);
931           r = [view bounds];
932           r.origin.x += (r.size.width - dim.x) / 2;
933           r.origin.y += (r.size.height - dim.y) / 2;
934           r.size.width = dim.x;
935           r.size.height = dim.y;
936           surr = NSInsetRect (r, -2, -2);
937           ns_focus (frame, &surr, 1);
938           [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
939           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
940                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
941           NSRectFill (r);
942           [[view window] flushWindow];
943           ns_timeout (150000);
944           [[view window] restoreCachedImage];
945           [[view window] flushWindow];
946           ns_unfocus (frame);
947         }
948       [pool release];
949       unblock_input ();
950     }
951   else
952     {
953       NSBeep ();
954     }
957 /* ==========================================================================
959     Frame / window manager related functions
961    ========================================================================== */
964 static void
965 ns_raise_frame (struct frame *f)
966 /* --------------------------------------------------------------------------
967      Bring window to foreground and make it active
968    -------------------------------------------------------------------------- */
970   NSView *view;
971   check_window_system (f);
972   view = FRAME_NS_VIEW (f);
973   block_input ();
974   if (FRAME_VISIBLE_P (f))
975     [[view window] makeKeyAndOrderFront: NSApp];
976   unblock_input ();
980 static void
981 ns_lower_frame (struct frame *f)
982 /* --------------------------------------------------------------------------
983      Send window to back
984    -------------------------------------------------------------------------- */
986   NSView *view;
987   check_window_system (f);
988   view = FRAME_NS_VIEW (f);
989   block_input ();
990   [[view window] orderBack: NSApp];
991   unblock_input ();
995 static void
996 ns_frame_raise_lower (struct frame *f, int raise)
997 /* --------------------------------------------------------------------------
998      External (hook)
999    -------------------------------------------------------------------------- */
1001   NSTRACE (ns_frame_raise_lower);
1003   if (raise)
1004     ns_raise_frame (f);
1005   else
1006     ns_lower_frame (f);
1010 static void
1011 ns_frame_rehighlight (struct frame *frame)
1012 /* --------------------------------------------------------------------------
1013      External (hook): called on things like window switching within frame
1014    -------------------------------------------------------------------------- */
1016   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1017   struct frame *old_highlight = dpyinfo->x_highlight_frame;
1019   NSTRACE (ns_frame_rehighlight);
1020   if (dpyinfo->x_focus_frame)
1021     {
1022       dpyinfo->x_highlight_frame
1023         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1024            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1025            : dpyinfo->x_focus_frame);
1026       if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
1027         {
1028           fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
1029           dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
1030         }
1031     }
1032   else
1033       dpyinfo->x_highlight_frame = 0;
1035   if (dpyinfo->x_highlight_frame &&
1036          dpyinfo->x_highlight_frame != old_highlight)
1037     {
1038       if (old_highlight)
1039         {
1040           x_update_cursor (old_highlight, 1);
1041           x_set_frame_alpha (old_highlight);
1042         }
1043       if (dpyinfo->x_highlight_frame)
1044         {
1045           x_update_cursor (dpyinfo->x_highlight_frame, 1);
1046           x_set_frame_alpha (dpyinfo->x_highlight_frame);
1047         }
1048     }
1052 void
1053 x_make_frame_visible (struct frame *f)
1054 /* --------------------------------------------------------------------------
1055      External: Show the window (X11 semantics)
1056    -------------------------------------------------------------------------- */
1058   NSTRACE (x_make_frame_visible);
1059   /* XXX: at some points in past this was not needed, as the only place that
1060      called this (frame.c:Fraise_frame ()) also called raise_lower;
1061      if this ends up the case again, comment this out again. */
1062   if (!FRAME_VISIBLE_P (f))
1063     {
1064       EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1066       SET_FRAME_VISIBLE (f, 1);
1067       ns_raise_frame (f);
1069       /* Making a new frame from a fullscreen frame will make the new frame
1070          fullscreen also.  So skip handleFS as this will print an error.  */
1071       if ([view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH
1072           && [view isFullscreen])
1073         return;
1075       if (f->want_fullscreen != FULLSCREEN_NONE)
1076         {
1077           block_input ();
1078           [view handleFS];
1079           unblock_input ();
1080         }
1081     }
1085 void
1086 x_make_frame_invisible (struct frame *f)
1087 /* --------------------------------------------------------------------------
1088      External: Hide the window (X11 semantics)
1089    -------------------------------------------------------------------------- */
1091   NSView *view;
1092   NSTRACE (x_make_frame_invisible);
1093   check_window_system (f);
1094   view = FRAME_NS_VIEW (f);
1095   [[view window] orderOut: NSApp];
1096   SET_FRAME_VISIBLE (f, 0);
1097   SET_FRAME_ICONIFIED (f, 0);
1101 void
1102 x_iconify_frame (struct frame *f)
1103 /* --------------------------------------------------------------------------
1104      External: Iconify window
1105    -------------------------------------------------------------------------- */
1107   NSView *view;
1108   struct ns_display_info *dpyinfo;
1110   NSTRACE (x_iconify_frame);
1111   check_window_system (f);
1112   view = FRAME_NS_VIEW (f);
1113   dpyinfo = FRAME_DISPLAY_INFO (f);
1115   if (dpyinfo->x_highlight_frame == f)
1116     dpyinfo->x_highlight_frame = 0;
1118   if ([[view window] windowNumber] <= 0)
1119     {
1120       /* the window is still deferred.  Make it very small, bring it
1121          on screen and order it out. */
1122       NSRect s = { { 100, 100}, {0, 0} };
1123       NSRect t;
1124       t = [[view window] frame];
1125       [[view window] setFrame: s display: NO];
1126       [[view window] orderBack: NSApp];
1127       [[view window] orderOut: NSApp];
1128       [[view window] setFrame: t display: NO];
1129     }
1130   [[view window] miniaturize: NSApp];
1133 /* Free X resources of frame F.  */
1135 void
1136 x_free_frame_resources (struct frame *f)
1138   NSView *view;
1139   struct ns_display_info *dpyinfo;
1140   Mouse_HLInfo *hlinfo;
1142   NSTRACE (x_free_frame_resources);
1143   check_window_system (f);
1144   view = FRAME_NS_VIEW (f);
1145   dpyinfo = FRAME_DISPLAY_INFO (f);
1146   hlinfo = MOUSE_HL_INFO (f);
1148   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1150   block_input ();
1152   free_frame_menubar (f);
1154   if (FRAME_FACE_CACHE (f))
1155     free_frame_faces (f);
1157   if (f == dpyinfo->x_focus_frame)
1158     dpyinfo->x_focus_frame = 0;
1159   if (f == dpyinfo->x_highlight_frame)
1160     dpyinfo->x_highlight_frame = 0;
1161   if (f == hlinfo->mouse_face_mouse_frame)
1162     reset_mouse_highlight (hlinfo);
1164   if (f->output_data.ns->miniimage != nil)
1165     [f->output_data.ns->miniimage release];
1167   [[view window] close];
1168   [view release];
1170   xfree (f->output_data.ns);
1172   unblock_input ();
1175 void
1176 x_destroy_window (struct frame *f)
1177 /* --------------------------------------------------------------------------
1178      External: Delete the window
1179    -------------------------------------------------------------------------- */
1181   NSTRACE (x_destroy_window);
1182   check_window_system (f);
1183   x_free_frame_resources (f);
1184   ns_window_num--;
1188 void
1189 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1190 /* --------------------------------------------------------------------------
1191      External: Position the window
1192    -------------------------------------------------------------------------- */
1194   NSView *view = FRAME_NS_VIEW (f);
1195   NSArray *screens = [NSScreen screens];
1196   NSScreen *fscreen = [screens objectAtIndex: 0];
1197   NSScreen *screen = [[view window] screen];
1199   NSTRACE (x_set_offset);
1201   block_input ();
1203   f->left_pos = xoff;
1204   f->top_pos = yoff;
1206   if (view != nil && screen && fscreen)
1207     {
1208       f->left_pos = f->size_hint_flags & XNegative
1209         ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
1210         : f->left_pos;
1211       /* We use visibleFrame here to take menu bar into account.
1212          Ideally we should also adjust left/top with visibleFrame.origin.  */
1214       f->top_pos = f->size_hint_flags & YNegative
1215         ? ([screen visibleFrame].size.height + f->top_pos
1216            - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
1217            - FRAME_TOOLBAR_HEIGHT (f))
1218         : f->top_pos;
1219 #ifdef NS_IMPL_GNUSTEP
1220       if (f->left_pos < 100)
1221         f->left_pos = 100;  /* don't overlap menu */
1222 #endif
1223       /* Constrain the setFrameTopLeftPoint so we don't move behind the
1224          menu bar.  */
1225       f->output_data.ns->dont_constrain = 0;
1226       [[view window] setFrameTopLeftPoint:
1227                        NSMakePoint (SCREENMAXBOUND (f->left_pos),
1228                                     SCREENMAXBOUND ([fscreen frame].size.height
1229                                                     - NS_TOP_POS (f)))];
1230       f->size_hint_flags &= ~(XNegative|YNegative);
1231     }
1233   unblock_input ();
1237 void
1238 x_set_window_size (struct frame *f, int change_grav, int cols, int rows)
1239 /* --------------------------------------------------------------------------
1240      Adjust window pixel size based on given character grid size
1241      Impl is a bit more complex than other terms, need to do some
1242      internal clipping.
1243    -------------------------------------------------------------------------- */
1245   EmacsView *view = FRAME_NS_VIEW (f);
1246   NSWindow *window = [view window];
1247   NSRect wr = [window frame];
1248   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1249   int pixelwidth, pixelheight;
1251   NSTRACE (x_set_window_size);
1253   if (view == nil)
1254     return;
1256 /*fprintf (stderr, "\tsetWindowSize: %d x %d, font size %d x %d\n", cols, rows, FRAME_COLUMN_WIDTH (f), FRAME_LINE_HEIGHT (f)); */
1258   block_input ();
1260   check_frame_size (f, &rows, &cols);
1262   f->scroll_bar_actual_width = NS_SCROLL_BAR_WIDTH (f);
1263   compute_fringe_widths (f, 0);
1265   pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, cols);
1266   pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
1268   /* If we have a toolbar, take its height into account. */
1269   if (tb && ! [view isFullscreen])
1270     {
1271     /* NOTE: previously this would generate wrong result if toolbar not
1272              yet displayed and fixing toolbar_height=32 helped, but
1273              now (200903) seems no longer needed */
1274     FRAME_TOOLBAR_HEIGHT (f) =
1275       NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1276         - FRAME_NS_TITLEBAR_HEIGHT (f);
1277 #ifdef NS_IMPL_GNUSTEP
1278       FRAME_TOOLBAR_HEIGHT (f) -= 3;
1279 #endif
1280     }
1281   else
1282     FRAME_TOOLBAR_HEIGHT (f) = 0;
1284   wr.size.width = pixelwidth + f->border_width;
1285   wr.size.height = pixelheight;
1286   if (! [view isFullscreen])
1287     wr.size.height += FRAME_NS_TITLEBAR_HEIGHT (f)
1288       + FRAME_TOOLBAR_HEIGHT (f);
1290   /* Do not try to constrain to this screen.  We may have multiple
1291      screens, and want Emacs to span those.  Constraining to screen
1292      prevents that, and that is not nice to the user.  */
1293  if (f->output_data.ns->zooming)
1294    f->output_data.ns->zooming = 0;
1295  else
1296    wr.origin.y += FRAME_PIXEL_HEIGHT (f) - pixelheight;
1298   [view setRows: rows andColumns: cols];
1299   [window setFrame: wr display: YES];
1301 /*fprintf (stderr, "\tx_set_window_size %d, %d\t%d, %d\n", cols, rows, pixelwidth, pixelheight); */
1303   /* This is a trick to compensate for Emacs' managing the scrollbar area
1304      as a fixed number of standard character columns.  Instead of leaving
1305      blank space for the extra, we chopped it off above.  Now for
1306      left-hand scrollbars, we shift all rendering to the left by the
1307      difference between the real width and Emacs' imagined one.  For
1308      right-hand bars, don't worry about it since the extra is never used.
1309      (Obviously doesn't work for vertically split windows tho..) */
1310   {
1311     NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1312       ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1313                      - NS_SCROLL_BAR_WIDTH (f), 0)
1314       : NSMakePoint (0, 0);
1315     [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1316     [view setBoundsOrigin: origin];
1317   }
1319   change_frame_size (f, rows, cols, 0, 1, 0); /* pretend, delay, safe */
1320   FRAME_PIXEL_WIDTH (f) = pixelwidth;
1321   FRAME_PIXEL_HEIGHT (f) = pixelheight;
1322 /*  SET_FRAME_GARBAGED (f); // this short-circuits expose call in drawRect */
1324   mark_window_cursors_off (XWINDOW (f->root_window));
1325   cancel_mouse_face (f);
1327   unblock_input ();
1331 static void
1332 ns_fullscreen_hook (struct frame *f)
1334   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1336   if (!FRAME_VISIBLE_P (f))
1337     return;
1339    if (! [view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH)
1340     {
1341       /* Old style fs don't initiate correctly if created from
1342          init/default-frame alist, so use a timer (not nice...).
1343       */
1344       [NSTimer scheduledTimerWithTimeInterval: 0.5 target: view
1345                                      selector: @selector (handleFS)
1346                                      userInfo: nil repeats: NO];
1347       return;
1348     }
1350   block_input ();
1351   [view handleFS];
1352   unblock_input ();
1355 /* ==========================================================================
1357     Color management
1359    ========================================================================== */
1362 NSColor *
1363 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1365   struct ns_color_table *color_table = FRAME_DISPLAY_INFO (f)->color_table;
1366   if (idx < 1 || idx >= color_table->avail)
1367     return nil;
1368   return color_table->colors[idx];
1372 unsigned long
1373 ns_index_color (NSColor *color, struct frame *f)
1375   struct ns_color_table *color_table = FRAME_DISPLAY_INFO (f)->color_table;
1376   ptrdiff_t idx;
1377   ptrdiff_t i;
1379   if (!color_table->colors)
1380     {
1381       color_table->size = NS_COLOR_CAPACITY;
1382       color_table->avail = 1; /* skip idx=0 as marker */
1383       color_table->colors = xmalloc (color_table->size * sizeof (NSColor *));
1384       color_table->colors[0] = nil;
1385       color_table->empty_indices = [[NSMutableSet alloc] init];
1386     }
1388   /* do we already have this color ? */
1389   for (i = 1; i < color_table->avail; i++)
1390     if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1391       return i;
1393   if ([color_table->empty_indices count] > 0)
1394     {
1395       NSNumber *index = [color_table->empty_indices anyObject];
1396       [color_table->empty_indices removeObject: index];
1397       idx = [index unsignedLongValue];
1398     }
1399   else
1400     {
1401       if (color_table->avail == color_table->size)
1402         color_table->colors =
1403           xpalloc (color_table->colors, &color_table->size, 1,
1404                    min (ULONG_MAX, PTRDIFF_MAX), sizeof *color_table->colors);
1405       idx = color_table->avail++;
1406     }
1408   color_table->colors[idx] = color;
1409   [color retain];
1410 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1411   return idx;
1415 void
1416 ns_free_indexed_color (unsigned long idx, struct frame *f)
1418   struct ns_color_table *color_table;
1419   NSColor *color;
1420   NSNumber *index;
1422   if (!f)
1423     return;
1425   color_table = FRAME_DISPLAY_INFO (f)->color_table;
1427   if (idx <= 0 || idx >= color_table->size) {
1428     message1 ("ns_free_indexed_color: Color index out of range.\n");
1429     return;
1430   }
1432   index = [NSNumber numberWithUnsignedInt: idx];
1433   if ([color_table->empty_indices containsObject: index]) {
1434     message1 ("ns_free_indexed_color: attempt to free already freed color.\n");
1435     return;
1436   }
1438   color = color_table->colors[idx];
1439   [color release];
1440   color_table->colors[idx] = nil;
1441   [color_table->empty_indices addObject: index];
1442 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1446 static int
1447 ns_get_color (const char *name, NSColor **col)
1448 /* --------------------------------------------------------------------------
1449      Parse a color name
1450    -------------------------------------------------------------------------- */
1451 /* On *Step, we attempt to mimic the X11 platform here, down to installing an
1452    X11 rgb.txt-compatible color list in Emacs.clr (see ns_term_init()).
1453    See: http://thread.gmane.org/gmane.emacs.devel/113050/focus=113272). */
1455   NSColor *new = nil;
1456   static char hex[20];
1457   int scaling;
1458   float r = -1.0, g, b;
1459   NSString *nsname = [NSString stringWithUTF8String: name];
1461 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1462   block_input ();
1464   if ([nsname isEqualToString: @"ns_selection_bg_color"])
1465     {
1466 #ifdef NS_IMPL_COCOA
1467       NSString *defname = [[NSUserDefaults standardUserDefaults]
1468                             stringForKey: @"AppleHighlightColor"];
1469       if (defname != nil)
1470         nsname = defname;
1471       else
1472 #endif
1473       if ((new = [NSColor selectedTextBackgroundColor]) != nil)
1474         {
1475           *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1476           unblock_input ();
1477           return 0;
1478         }
1479       else
1480         nsname = NS_SELECTION_BG_COLOR_DEFAULT;
1482       name = [nsname UTF8String];
1483     }
1484   else if ([nsname isEqualToString: @"ns_selection_fg_color"])
1485     {
1486       /* NOTE: OSX applications normally don't set foreground selection, but
1487          text may be unreadable if we don't.
1488       */
1489       if ((new = [NSColor selectedTextColor]) != nil)
1490         {
1491           *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1492           unblock_input ();
1493           return 0;
1494         }
1496       nsname = NS_SELECTION_FG_COLOR_DEFAULT;
1497       name = [nsname UTF8String];
1498     }
1500   /* First, check for some sort of numeric specification. */
1501   hex[0] = '\0';
1503   if (name[0] == '0' || name[0] == '1' || name[0] == '.')  /* RGB decimal */
1504     {
1505       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1506       [scanner scanFloat: &r];
1507       [scanner scanFloat: &g];
1508       [scanner scanFloat: &b];
1509     }
1510   else if (!strncmp(name, "rgb:", 4))  /* A newer X11 format -- rgb:r/g/b */
1511     scaling = (snprintf (hex, sizeof hex, "%s", name + 4) - 2) / 3;
1512   else if (name[0] == '#')        /* An old X11 format; convert to newer */
1513     {
1514       int len = (strlen(name) - 1);
1515       int start = (len % 3 == 0) ? 1 : len / 4 + 1;
1516       int i;
1517       scaling = strlen(name+start) / 3;
1518       for (i = 0; i < 3; i++)
1519         sprintf (hex + i * (scaling + 1), "%.*s/", scaling,
1520                  name + start + i * scaling);
1521       hex[3 * (scaling + 1) - 1] = '\0';
1522     }
1524   if (hex[0])
1525     {
1526       int rr, gg, bb;
1527       float fscale = scaling == 4 ? 65535.0 : (scaling == 2 ? 255.0 : 15.0);
1528       if (sscanf (hex, "%x/%x/%x", &rr, &gg, &bb))
1529         {
1530           r = rr / fscale;
1531           g = gg / fscale;
1532           b = bb / fscale;
1533         }
1534     }
1536   if (r >= 0.0F)
1537     {
1538       *col = [NSColor colorWithCalibratedRed: r green: g blue: b alpha: 1.0];
1539       unblock_input ();
1540       return 0;
1541     }
1543   /* Otherwise, color is expected to be from a list */
1544   {
1545     NSEnumerator *lenum, *cenum;
1546     NSString *name;
1547     NSColorList *clist;
1549 #ifdef NS_IMPL_GNUSTEP
1550     /* XXX: who is wrong, the requestor or the implementation? */
1551     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1552         == NSOrderedSame)
1553       nsname = @"highlightColor";
1554 #endif
1556     lenum = [[NSColorList availableColorLists] objectEnumerator];
1557     while ( (clist = [lenum nextObject]) && new == nil)
1558       {
1559         cenum = [[clist allKeys] objectEnumerator];
1560         while ( (name = [cenum nextObject]) && new == nil )
1561           {
1562             if ([name compare: nsname
1563                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1564               new = [clist colorWithKey: name];
1565           }
1566       }
1567   }
1569   if (new)
1570     *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1571   unblock_input ();
1572   return new ? 0 : 1;
1577 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1578 /* --------------------------------------------------------------------------
1579      Convert a Lisp string object to a NS color
1580    -------------------------------------------------------------------------- */
1582   NSTRACE (ns_lisp_to_color);
1583   if (STRINGP (color))
1584     return ns_get_color (SSDATA (color), col);
1585   else if (SYMBOLP (color))
1586     return ns_get_color (SSDATA (SYMBOL_NAME (color)), col);
1587   return 1;
1591 Lisp_Object
1592 ns_color_to_lisp (NSColor *col)
1593 /* --------------------------------------------------------------------------
1594      Convert a color to a lisp string with the RGB equivalent
1595    -------------------------------------------------------------------------- */
1597   EmacsCGFloat red, green, blue, alpha, gray;
1598   char buf[1024];
1599   const char *str;
1600   NSTRACE (ns_color_to_lisp);
1602   block_input ();
1603   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1605       if ((str =[[col colorNameComponent] UTF8String]))
1606         {
1607           unblock_input ();
1608           return build_string ((char *)str);
1609         }
1611     [[col colorUsingColorSpaceName: NSCalibratedRGBColorSpace]
1612         getRed: &red green: &green blue: &blue alpha: &alpha];
1613   if (red ==green && red ==blue)
1614     {
1615       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1616             getWhite: &gray alpha: &alpha];
1617       snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1618                 lrint (gray * 0xff), lrint (gray * 0xff), lrint (gray * 0xff));
1619       unblock_input ();
1620       return build_string (buf);
1621     }
1623   snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1624             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1626   unblock_input ();
1627   return build_string (buf);
1631 void
1632 ns_query_color(void *col, XColor *color_def, int setPixel)
1633 /* --------------------------------------------------------------------------
1634          Get ARGB values out of NSColor col and put them into color_def.
1635          If setPixel, set the pixel to a concatenated version.
1636          and set color_def pixel to the resulting index.
1637    -------------------------------------------------------------------------- */
1639   EmacsCGFloat r, g, b, a;
1641   [((NSColor *)col) getRed: &r green: &g blue: &b alpha: &a];
1642   color_def->red   = r * 65535;
1643   color_def->green = g * 65535;
1644   color_def->blue  = b * 65535;
1646   if (setPixel == YES)
1647     color_def->pixel
1648       = ARGB_TO_ULONG((int)(a*255),
1649                       (int)(r*255), (int)(g*255), (int)(b*255));
1653 bool
1654 ns_defined_color (struct frame *f,
1655                   const char *name,
1656                   XColor *color_def,
1657                   bool alloc,
1658                   bool makeIndex)
1659 /* --------------------------------------------------------------------------
1660          Return true if named color found, and set color_def rgb accordingly.
1661          If makeIndex and alloc are nonzero put the color in the color_table,
1662          and set color_def pixel to the resulting index.
1663          If makeIndex is zero, set color_def pixel to ARGB.
1664          Return false if not found
1665    -------------------------------------------------------------------------- */
1667   NSColor *col;
1668   NSTRACE (ns_defined_color);
1670   block_input ();
1671   if (ns_get_color (name, &col) != 0) /* Color not found  */
1672     {
1673       unblock_input ();
1674       return 0;
1675     }
1676   if (makeIndex && alloc)
1677     color_def->pixel = ns_index_color (col, f);
1678   ns_query_color (col, color_def, !makeIndex);
1679   unblock_input ();
1680   return 1;
1684 void
1685 x_set_frame_alpha (struct frame *f)
1686 /* --------------------------------------------------------------------------
1687      change the entire-frame transparency
1688    -------------------------------------------------------------------------- */
1690   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
1691   double alpha = 1.0;
1692   double alpha_min = 1.0;
1694   if (dpyinfo->x_highlight_frame == f)
1695     alpha = f->alpha[0];
1696   else
1697     alpha = f->alpha[1];
1699   if (FLOATP (Vframe_alpha_lower_limit))
1700     alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
1701   else if (INTEGERP (Vframe_alpha_lower_limit))
1702     alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
1704   if (alpha < 0.0)
1705     return;
1706   else if (1.0 < alpha)
1707     alpha = 1.0;
1708   else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
1709     alpha = alpha_min;
1711 #ifdef NS_IMPL_COCOA
1712   {
1713     EmacsView *view = FRAME_NS_VIEW (f);
1714   [[view window] setAlphaValue: alpha];
1715   }
1716 #endif
1720 /* ==========================================================================
1722     Mouse handling
1724    ========================================================================== */
1727 void
1728 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1729 /* --------------------------------------------------------------------------
1730      Programmatically reposition mouse pointer in pixel coordinates
1731    -------------------------------------------------------------------------- */
1733   NSTRACE (x_set_mouse_pixel_position);
1734   ns_raise_frame (f);
1735 #if 0
1736   /* FIXME: this does not work, and what about GNUstep? */
1737 #ifdef NS_IMPL_COCOA
1738   [FRAME_NS_VIEW (f) lockFocus];
1739   PSsetmouse ((float)pix_x, (float)pix_y);
1740   [FRAME_NS_VIEW (f) unlockFocus];
1741 #endif
1742 #endif
1746 void
1747 x_set_mouse_position (struct frame *f, int h, int v)
1748 /* --------------------------------------------------------------------------
1749      Programmatically reposition mouse pointer in character coordinates
1750    -------------------------------------------------------------------------- */
1752   int pix_x, pix_y;
1754   pix_x = FRAME_COL_TO_PIXEL_X (f, h) + FRAME_COLUMN_WIDTH (f) / 2;
1755   pix_y = FRAME_LINE_TO_PIXEL_Y (f, v) + FRAME_LINE_HEIGHT (f) / 2;
1757   if (pix_x < 0) pix_x = 0;
1758   if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
1760   if (pix_y < 0) pix_y = 0;
1761   if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
1763   x_set_mouse_pixel_position (f, pix_x, pix_y);
1767 static int
1768 note_mouse_movement (struct frame *frame, CGFloat x, CGFloat y)
1769 /*   ------------------------------------------------------------------------
1770      Called by EmacsView on mouseMovement events.  Passes on
1771      to emacs mainstream code if we moved off of a rect of interest
1772      known as last_mouse_glyph.
1773      ------------------------------------------------------------------------ */
1775   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1776   NSRect *r;
1778 //  NSTRACE (note_mouse_movement);
1780   dpyinfo->last_mouse_motion_frame = frame;
1781   r = &dpyinfo->last_mouse_glyph;
1783   /* Note, this doesn't get called for enter/leave, since we don't have a
1784      position.  Those are taken care of in the corresponding NSView methods. */
1786   /* has movement gone beyond last rect we were tracking? */
1787   if (x < r->origin.x || x >= r->origin.x + r->size.width
1788       || y < r->origin.y || y >= r->origin.y + r->size.height)
1789     {
1790       ns_update_begin (frame);
1791       frame->mouse_moved = 1;
1792       note_mouse_highlight (frame, x, y);
1793       remember_mouse_glyph (frame, x, y, r);
1794       ns_update_end (frame);
1795       return 1;
1796     }
1798   return 0;
1802 static void
1803 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1804                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1805                    Time *time)
1806 /* --------------------------------------------------------------------------
1807     External (hook): inform emacs about mouse position and hit parts.
1808     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1809     x & y should be position in the scrollbar (the whole bar, not the handle)
1810     and length of scrollbar respectively
1811    -------------------------------------------------------------------------- */
1813   id view;
1814   NSPoint position;
1815   Lisp_Object frame, tail;
1816   struct frame *f;
1817   struct ns_display_info *dpyinfo;
1819   NSTRACE (ns_mouse_position);
1821   if (*fp == NULL)
1822     {
1823       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1824       return;
1825     }
1827   dpyinfo = FRAME_DISPLAY_INFO (*fp);
1829   block_input ();
1831   if (dpyinfo->last_mouse_scroll_bar != nil && insist == 0)
1832     {
1833       /* TODO: we do not use this path at the moment because drag events will
1834            go directly to the EmacsScroller.  Leaving code in for now. */
1835       [dpyinfo->last_mouse_scroll_bar
1836           getMouseMotionPart: (int *)part window: bar_window x: x y: y];
1837       if (time)
1838         *time = dpyinfo->last_mouse_movement_time;
1839       dpyinfo->last_mouse_scroll_bar = nil;
1840     }
1841   else
1842     {
1843       /* Clear the mouse-moved flag for every frame on this display.  */
1844       FOR_EACH_FRAME (tail, frame)
1845         if (FRAME_NS_P (XFRAME (frame))
1846             && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1847           XFRAME (frame)->mouse_moved = 0;
1849       dpyinfo->last_mouse_scroll_bar = nil;
1850       if (dpyinfo->last_mouse_frame
1851           && FRAME_LIVE_P (dpyinfo->last_mouse_frame))
1852         f = dpyinfo->last_mouse_frame;
1853       else
1854         f = dpyinfo->x_focus_frame ? dpyinfo->x_focus_frame
1855                                     : SELECTED_FRAME ();
1857       if (f && FRAME_NS_P (f))
1858         {
1859           view = FRAME_NS_VIEW (*fp);
1861           position = [[view window] mouseLocationOutsideOfEventStream];
1862           position = [view convertPoint: position fromView: nil];
1863           remember_mouse_glyph (f, position.x, position.y,
1864                                 &dpyinfo->last_mouse_glyph);
1865 /*fprintf (stderr, "ns_mouse_position: %.0f, %.0f\n", position.x, position.y); */
1867           if (bar_window) *bar_window = Qnil;
1868           if (part) *part = 0; /*scroll_bar_handle; */
1870           if (x) XSETINT (*x, lrint (position.x));
1871           if (y) XSETINT (*y, lrint (position.y));
1872           if (time)
1873             *time = dpyinfo->last_mouse_movement_time;
1874           *fp = f;
1875         }
1876     }
1878   unblock_input ();
1882 static void
1883 ns_frame_up_to_date (struct frame *f)
1884 /* --------------------------------------------------------------------------
1885     External (hook): Fix up mouse highlighting right after a full update.
1886     Can't use FRAME_MOUSE_UPDATE due to ns_frame_begin and ns_frame_end calls.
1887    -------------------------------------------------------------------------- */
1889   NSTRACE (ns_frame_up_to_date);
1891   if (FRAME_NS_P (f))
1892     {
1893       Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1894       if (f == hlinfo->mouse_face_mouse_frame)
1895         {
1896           block_input ();
1897           ns_update_begin(f);
1898           note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
1899                                 hlinfo->mouse_face_mouse_x,
1900                                 hlinfo->mouse_face_mouse_y);
1901           ns_update_end(f);
1902           unblock_input ();
1903         }
1904     }
1908 static void
1909 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1910 /* --------------------------------------------------------------------------
1911     External (RIF): set frame mouse pointer type.
1912    -------------------------------------------------------------------------- */
1914   NSTRACE (ns_define_frame_cursor);
1915   if (FRAME_POINTER_TYPE (f) != cursor)
1916     {
1917       EmacsView *view = FRAME_NS_VIEW (f);
1918       FRAME_POINTER_TYPE (f) = cursor;
1919       [[view window] invalidateCursorRectsForView: view];
1920       /* Redisplay assumes this function also draws the changed frame
1921          cursor, but this function doesn't, so do it explicitly.  */
1922       x_update_cursor (f, 1);
1923     }
1928 /* ==========================================================================
1930     Keyboard handling
1932    ========================================================================== */
1935 static unsigned
1936 ns_convert_key (unsigned code)
1937 /* --------------------------------------------------------------------------
1938     Internal call used by NSView-keyDown.
1939    -------------------------------------------------------------------------- */
1941   const unsigned last_keysym = (sizeof (convert_ns_to_X_keysym)
1942                                 / sizeof (convert_ns_to_X_keysym[0]));
1943   unsigned keysym;
1944   /* An array would be faster, but less easy to read. */
1945   for (keysym = 0; keysym < last_keysym; keysym += 2)
1946     if (code == convert_ns_to_X_keysym[keysym])
1947       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
1948   return 0;
1949 /* if decide to use keyCode and Carbon table, use this line:
1950      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
1954 char *
1955 x_get_keysym_name (int keysym)
1956 /* --------------------------------------------------------------------------
1957     Called by keyboard.c.  Not sure if the return val is important, except
1958     that it be unique.
1959    -------------------------------------------------------------------------- */
1961   static char value[16];
1962   NSTRACE (x_get_keysym_name);
1963   sprintf (value, "%d", keysym);
1964   return value;
1969 /* ==========================================================================
1971     Block drawing operations
1973    ========================================================================== */
1976 static void
1977 ns_redraw_scroll_bars (struct frame *f)
1979   int i;
1980   id view;
1981   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
1982   NSTRACE (ns_redraw_scroll_bars);
1983   for (i =[subviews count]-1; i >= 0; i--)
1984     {
1985       view = [subviews objectAtIndex: i];
1986       if (![view isKindOfClass: [EmacsScroller class]]) continue;
1987       [view display];
1988     }
1992 void
1993 ns_clear_frame (struct frame *f)
1994 /* --------------------------------------------------------------------------
1995       External (hook): Erase the entire frame
1996    -------------------------------------------------------------------------- */
1998   NSView *view = FRAME_NS_VIEW (f);
1999   NSRect r;
2001   NSTRACE (ns_clear_frame);
2003  /* comes on initial frame because we have
2004     after-make-frame-functions = select-frame */
2005  if (!FRAME_DEFAULT_FACE (f))
2006    return;
2008   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2010   r = [view bounds];
2012   block_input ();
2013   ns_focus (f, &r, 1);
2014   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
2015   NSRectFill (r);
2016   ns_unfocus (f);
2018   /* as of 2006/11 or so this is now needed */
2019   ns_redraw_scroll_bars (f);
2020   unblock_input ();
2024 static void
2025 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
2026 /* --------------------------------------------------------------------------
2027     External (RIF):  Clear section of frame
2028    -------------------------------------------------------------------------- */
2030   NSRect r = NSMakeRect (x, y, width, height);
2031   NSView *view = FRAME_NS_VIEW (f);
2032   struct face *face = FRAME_DEFAULT_FACE (f);
2034   if (!view || !face)
2035     return;
2037   NSTRACE (ns_clear_frame_area);
2039   r = NSIntersectionRect (r, [view frame]);
2040   ns_focus (f, &r, 1);
2041   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
2043   NSRectFill (r);
2045   ns_unfocus (f);
2046   return;
2050 static void
2051 ns_scroll_run (struct window *w, struct run *run)
2052 /* --------------------------------------------------------------------------
2053     External (RIF):  Insert or delete n lines at line vpos
2054    -------------------------------------------------------------------------- */
2056   struct frame *f = XFRAME (w->frame);
2057   int x, y, width, height, from_y, to_y, bottom_y;
2059   NSTRACE (ns_scroll_run);
2061   /* begin copy from other terms */
2062   /* Get frame-relative bounding box of the text display area of W,
2063      without mode lines.  Include in this box the left and right
2064      fringe of W.  */
2065   window_box (w, ANY_AREA, &x, &y, &width, &height);
2067   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
2068   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
2069   bottom_y = y + height;
2071   if (to_y < from_y)
2072     {
2073       /* Scrolling up.  Make sure we don't copy part of the mode
2074          line at the bottom.  */
2075       if (from_y + run->height > bottom_y)
2076         height = bottom_y - from_y;
2077       else
2078         height = run->height;
2079     }
2080   else
2081     {
2082       /* Scrolling down.  Make sure we don't copy over the mode line.
2083          at the bottom.  */
2084       if (to_y + run->height > bottom_y)
2085         height = bottom_y - to_y;
2086       else
2087         height = run->height;
2088     }
2089   /* end copy from other terms */
2091   if (height == 0)
2092       return;
2094   block_input ();
2096   x_clear_cursor (w);
2098   {
2099     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2100     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2101     NSPoint dstOrigin = NSMakePoint (x, to_y);
2103     ns_focus (f, &dstRect, 1);
2104     NSCopyBits (0, srcRect , dstOrigin);
2105     ns_unfocus (f);
2106   }
2108   unblock_input ();
2112 static void
2113 ns_after_update_window_line (struct window *w, struct glyph_row *desired_row)
2114 /* --------------------------------------------------------------------------
2115     External (RIF): preparatory to fringe update after text was updated
2116    -------------------------------------------------------------------------- */
2118   struct frame *f;
2119   int width, height;
2121   NSTRACE (ns_after_update_window_line);
2123   /* begin copy from other terms */
2124   eassert (w);
2126   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2127     desired_row->redraw_fringe_bitmaps_p = 1;
2129   /* When a window has disappeared, make sure that no rest of
2130      full-width rows stays visible in the internal border.  */
2131   if (windows_or_buffers_changed
2132       && desired_row->full_width_p
2133       && (f = XFRAME (w->frame),
2134           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2135           width != 0)
2136       && (height = desired_row->visible_height,
2137           height > 0))
2138     {
2139       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2141       block_input ();
2142       ns_clear_frame_area (f, 0, y, width, height);
2143       ns_clear_frame_area (f,
2144                            FRAME_PIXEL_WIDTH (f) - width,
2145                            y, width, height);
2146       unblock_input ();
2147     }
2151 static void
2152 ns_shift_glyphs_for_insert (struct frame *f,
2153                            int x, int y, int width, int height,
2154                            int shift_by)
2155 /* --------------------------------------------------------------------------
2156     External (RIF): copy an area horizontally, don't worry about clearing src
2157    -------------------------------------------------------------------------- */
2159   NSRect srcRect = NSMakeRect (x, y, width, height);
2160   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2161   NSPoint dstOrigin = dstRect.origin;
2163   NSTRACE (ns_shift_glyphs_for_insert);
2165   ns_focus (f, &dstRect, 1);
2166   NSCopyBits (0, srcRect, dstOrigin);
2167   ns_unfocus (f);
2172 /* ==========================================================================
2174     Character encoding and metrics
2176    ========================================================================== */
2179 static void
2180 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2181 /* --------------------------------------------------------------------------
2182      External (RIF); compute left/right overhang of whole string and set in s
2183    -------------------------------------------------------------------------- */
2185   struct font *font = s->font;
2187   if (s->char2b)
2188     {
2189       struct font_metrics metrics;
2190       unsigned int codes[2];
2191       codes[0] = *(s->char2b);
2192       codes[1] = *(s->char2b + s->nchars - 1);
2194       font->driver->text_extents (font, codes, 2, &metrics);
2195       s->left_overhang = -metrics.lbearing;
2196       s->right_overhang
2197         = metrics.rbearing > metrics.width
2198         ? metrics.rbearing - metrics.width : 0;
2199     }
2200   else
2201     {
2202       s->left_overhang = 0;
2203       if (EQ (font->driver->type, Qns))
2204         s->right_overhang = ((struct nsfont_info *)font)->ital ?
2205           FONT_HEIGHT (font) * 0.2 : 0;
2206       else
2207         s->right_overhang = 0;
2208     }
2213 /* ==========================================================================
2215     Fringe and cursor drawing
2217    ========================================================================== */
2220 extern int max_used_fringe_bitmap;
2221 static void
2222 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2223                       struct draw_fringe_bitmap_params *p)
2224 /* --------------------------------------------------------------------------
2225     External (RIF); fringe-related
2226    -------------------------------------------------------------------------- */
2228   struct frame *f = XFRAME (WINDOW_FRAME (w));
2229   struct face *face = p->face;
2230   static EmacsImage **bimgs = NULL;
2231   static int nBimgs = 0;
2233   /* grow bimgs if needed */
2234   if (nBimgs < max_used_fringe_bitmap)
2235     {
2236       bimgs = xrealloc (bimgs, max_used_fringe_bitmap * sizeof *bimgs);
2237       memset (bimgs + nBimgs, 0,
2238               (max_used_fringe_bitmap - nBimgs) * sizeof *bimgs);
2239       nBimgs = max_used_fringe_bitmap;
2240     }
2242   /* Must clip because of partially visible lines.  */
2243   ns_clip_to_row (w, row, ANY_AREA, YES);
2245   if (!p->overlay_p)
2246     {
2247       int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
2249       /* If the fringe is adjacent to the left (right) scroll bar of a
2250          leftmost (rightmost, respectively) window, then extend its
2251          background to the gap between the fringe and the bar.  */
2252       if ((WINDOW_LEFTMOST_P (w)
2253            && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
2254           || (WINDOW_RIGHTMOST_P (w)
2255               && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
2256         {
2257           int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
2259           if (sb_width > 0)
2260             {
2261               int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
2262               int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
2263                                     * FRAME_COLUMN_WIDTH (f));
2265               if (bx < 0)
2266                 {
2267                   /* Bitmap fills the fringe.  */
2268                   if (bar_area_x + bar_area_width == p->x)
2269                     bx = bar_area_x + sb_width;
2270                   else if (p->x + p->wd == bar_area_x)
2271                     bx = bar_area_x;
2272                   if (bx >= 0)
2273                     {
2274                       int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
2276                       nx = bar_area_width - sb_width;
2277                       by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
2278                                                             row->y));
2279                       ny = row->visible_height;
2280                     }
2281                 }
2282               else
2283                 {
2284                   if (bar_area_x + bar_area_width == bx)
2285                     {
2286                       bx = bar_area_x + sb_width;
2287                       nx += bar_area_width - sb_width;
2288                     }
2289                   else if (bx + nx == bar_area_x)
2290                     nx += bar_area_width - sb_width;
2291                 }
2292             }
2293         }
2295       if (bx >= 0 && nx > 0)
2296         {
2297           NSRect r = NSMakeRect (bx, by, nx, ny);
2298           NSRectClip (r);
2299           [ns_lookup_indexed_color (face->background, f) set];
2300           NSRectFill (r);
2301         }
2302     }
2304   if (p->which)
2305     {
2306       NSRect r = NSMakeRect (p->x, p->y, p->wd, p->h);
2307       EmacsImage *img = bimgs[p->which - 1];
2309       if (!img)
2310         {
2311           unsigned short *bits = p->bits + p->dh;
2312           int len = p->h;
2313           int i;
2314           unsigned char *cbits = xmalloc (len);
2316           for (i = 0; i < len; i++)
2317             cbits[i] = ~(bits[i] & 0xff);
2318           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2319                                            flip: NO];
2320           bimgs[p->which - 1] = img;
2321           xfree (cbits);
2322         }
2324       NSRectClip (r);
2325       /* Since we composite the bitmap instead of just blitting it, we need
2326          to erase the whole background. */
2327       [ns_lookup_indexed_color(face->background, f) set];
2328       NSRectFill (r);
2329       [img setXBMColor: ns_lookup_indexed_color(face->foreground, f)];
2330 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
2331       [img drawInRect: r
2332               fromRect: NSZeroRect
2333              operation: NSCompositeSourceOver
2334               fraction: 1.0
2335            respectFlipped: YES
2336                 hints: nil];
2337 #else
2338       {
2339         NSPoint pt = r.origin;
2340         pt.y += p->h;
2341         [img compositeToPoint: pt operation: NSCompositeSourceOver];
2342       }
2343 #endif
2344     }
2345   ns_unfocus (f);
2349 static void
2350 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2351                        int x, int y, enum text_cursor_kinds cursor_type,
2352                        int cursor_width, bool on_p, bool active_p)
2353 /* --------------------------------------------------------------------------
2354      External call (RIF): draw cursor.
2355      Note that CURSOR_WIDTH is meaningful only for (h)bar cursors.
2356    -------------------------------------------------------------------------- */
2358   NSRect r, s;
2359   int fx, fy, h, cursor_height;
2360   struct frame *f = WINDOW_XFRAME (w);
2361   struct glyph *phys_cursor_glyph;
2362   struct glyph *cursor_glyph;
2363   struct face *face;
2364   NSColor *hollow_color = FRAME_BACKGROUND_COLOR (f);
2366   /* If cursor is out of bounds, don't draw garbage.  This can happen
2367      in mini-buffer windows when switching between echo area glyphs
2368      and mini-buffer.  */
2370   NSTRACE (dumpcursor);
2372   if (!on_p)
2373     return;
2375   w->phys_cursor_type = cursor_type;
2376   w->phys_cursor_on_p = on_p;
2378   if (cursor_type == NO_CURSOR)
2379     {
2380       w->phys_cursor_width = 0;
2381       return;
2382     }
2384   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2385     {
2386       if (glyph_row->exact_window_width_line_p
2387           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2388         {
2389           glyph_row->cursor_in_fringe_p = 1;
2390           draw_fringe_bitmap (w, glyph_row, 0);
2391         }
2392       return;
2393     }
2395   /* We draw the cursor (with NSRectFill), then draw the glyph on top
2396      (other terminals do it the other way round).  We must set
2397      w->phys_cursor_width to the cursor width.  For bar cursors, that
2398      is CURSOR_WIDTH; for box cursors, it is the glyph width.  */
2399   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2401   /* The above get_phys_cursor_geometry call set w->phys_cursor_width
2402      to the glyph width; replace with CURSOR_WIDTH for (V)BAR cursors. */
2403   if (cursor_type == BAR_CURSOR)
2404     {
2405       if (cursor_width < 1)
2406         cursor_width = max (FRAME_CURSOR_WIDTH (f), 1);
2407       w->phys_cursor_width = cursor_width;
2408     }
2409   /* If we have an HBAR, "cursor_width" MAY specify height. */
2410   else if (cursor_type == HBAR_CURSOR)
2411     {
2412       cursor_height = (cursor_width < 1) ? lrint (0.25 * h) : cursor_width;
2413       fy += h - cursor_height;
2414       h = cursor_height;
2415     }
2417   r.origin.x = fx, r.origin.y = fy;
2418   r.size.height = h;
2419   r.size.width = w->phys_cursor_width;
2421   /* TODO: only needed in rare cases with last-resort font in HELLO..
2422      should we do this more efficiently? */
2423   ns_clip_to_row (w, glyph_row, ANY_AREA, NO); /* do ns_focus(f, &r, 1); if remove */
2426   face = FACE_FROM_ID (f, phys_cursor_glyph->face_id);
2427   if (face && NS_FACE_BACKGROUND (face)
2428       == ns_index_color (FRAME_CURSOR_COLOR (f), f))
2429     {
2430       [ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), f) set];
2431       hollow_color = FRAME_CURSOR_COLOR (f);
2432     }
2433   else
2434     [FRAME_CURSOR_COLOR (f) set];
2436 #ifdef NS_IMPL_COCOA
2437   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2438            atomic.  Cleaner ways of doing this should be investigated.
2439            One way would be to set a global variable DRAWING_CURSOR
2440            when making the call to draw_phys..(), don't focus in that
2441            case, then move the ns_unfocus() here after that call. */
2442   NSDisableScreenUpdates ();
2443 #endif
2445   switch (cursor_type)
2446     {
2447     case NO_CURSOR:
2448       break;
2449     case FILLED_BOX_CURSOR:
2450       NSRectFill (r);
2451       break;
2452     case HOLLOW_BOX_CURSOR:
2453       NSRectFill (r);
2454       [hollow_color set];
2455       NSRectFill (NSInsetRect (r, 1, 1));
2456       [FRAME_CURSOR_COLOR (f) set];
2457       break;
2458     case HBAR_CURSOR:
2459       NSRectFill (r);
2460       break;
2461     case BAR_CURSOR:
2462       s = r;
2463       /* If the character under cursor is R2L, draw the bar cursor
2464          on the right of its glyph, rather than on the left.  */
2465       cursor_glyph = get_phys_cursor_glyph (w);
2466       if ((cursor_glyph->resolved_level & 1) != 0)
2467         s.origin.x += cursor_glyph->pixel_width - s.size.width;
2469       NSRectFill (s);
2470       break;
2471     }
2472   ns_unfocus (f);
2474   /* draw the character under the cursor */
2475   if (cursor_type != NO_CURSOR)
2476     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2478 #ifdef NS_IMPL_COCOA
2479   NSEnableScreenUpdates ();
2480 #endif
2485 static void
2486 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2487 /* --------------------------------------------------------------------------
2488      External (RIF): Draw a vertical line.
2489    -------------------------------------------------------------------------- */
2491   struct frame *f = XFRAME (WINDOW_FRAME (w));
2492   struct face *face;
2493   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2495   NSTRACE (ns_draw_vertical_window_border);
2497   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2498   if (face)
2499       [ns_lookup_indexed_color(face->foreground, f) set];
2501   ns_focus (f, &r, 1);
2502   NSRectFill(r);
2503   ns_unfocus (f);
2507 void
2508 show_hourglass (struct atimer *timer)
2510   if (hourglass_shown_p)
2511     return;
2513   block_input ();
2515   /* TODO: add NSProgressIndicator to selected frame (see macfns.c) */
2517   hourglass_shown_p = 1;
2518   unblock_input ();
2522 void
2523 hide_hourglass (void)
2525   if (!hourglass_shown_p)
2526     return;
2528   block_input ();
2530   /* TODO: remove NSProgressIndicator from all frames */
2532   hourglass_shown_p = 0;
2533   unblock_input ();
2538 /* ==========================================================================
2540     Glyph drawing operations
2542    ========================================================================== */
2544 static int
2545 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2546 /* --------------------------------------------------------------------------
2547     Wrapper utility to account for internal border width on full-width lines,
2548     and allow top full-width rows to hit the frame top.  nr should be pointer
2549     to two successive NSRects.  Number of rects actually used is returned.
2550    -------------------------------------------------------------------------- */
2552   int n = get_glyph_string_clip_rects (s, nr, 2);
2553   return n;
2556 /* --------------------------------------------------------------------
2557    Draw a wavy line under glyph string s. The wave fills wave_height
2558    pixels from y.
2560                     x          wave_length = 2
2561                                  --
2562                 y    *   *   *   *   *
2563                      |* * * * * * * * *
2564     wave_height = 3  | *   *   *   *
2565   --------------------------------------------------------------------- */
2567 static void
2568 ns_draw_underwave (struct glyph_string *s, EmacsCGFloat width, EmacsCGFloat x)
2570   int wave_height = 3, wave_length = 2;
2571   int y, dx, dy, odd, xmax;
2572   NSPoint a, b;
2573   NSRect waveClip;
2575   dx = wave_length;
2576   dy = wave_height - 1;
2577   y =  s->ybase - wave_height + 3;
2578   xmax = x + width;
2580   /* Find and set clipping rectangle */
2581   waveClip = NSMakeRect (x, y, width, wave_height);
2582   [[NSGraphicsContext currentContext] saveGraphicsState];
2583   NSRectClip (waveClip);
2585   /* Draw the waves */
2586   a.x = x - ((int)(x) % dx) + (EmacsCGFloat) 0.5;
2587   b.x = a.x + dx;
2588   odd = (int)(a.x/dx) % 2;
2589   a.y = b.y = y + 0.5;
2591   if (odd)
2592     a.y += dy;
2593   else
2594     b.y += dy;
2596   while (a.x <= xmax)
2597     {
2598       [NSBezierPath strokeLineFromPoint:a toPoint:b];
2599       a.x = b.x, a.y = b.y;
2600       b.x += dx, b.y = y + 0.5 + odd*dy;
2601       odd = !odd;
2602     }
2604   /* Restore previous clipping rectangle(s) */
2605   [[NSGraphicsContext currentContext] restoreGraphicsState];
2610 void
2611 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
2612                          NSColor *defaultCol, CGFloat width, CGFloat x)
2613 /* --------------------------------------------------------------------------
2614    Draw underline, overline, and strike-through on glyph string s.
2615    -------------------------------------------------------------------------- */
2617   if (s->for_overlaps)
2618     return;
2620   /* Do underline. */
2621   if (face->underline_p)
2622     {
2623       if (s->face->underline_type == FACE_UNDER_WAVE)
2624         {
2625           if (face->underline_defaulted_p)
2626             [defaultCol set];
2627           else
2628             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2630           ns_draw_underwave (s, width, x);
2631         }
2632       else if (s->face->underline_type == FACE_UNDER_LINE)
2633         {
2635           NSRect r;
2636           unsigned long thickness, position;
2638           /* If the prev was underlined, match its appearance. */
2639           if (s->prev && s->prev->face->underline_p
2640               && s->prev->face->underline_type == FACE_UNDER_LINE
2641               && s->prev->underline_thickness > 0)
2642             {
2643               thickness = s->prev->underline_thickness;
2644               position = s->prev->underline_position;
2645             }
2646           else
2647             {
2648               struct font *font;
2649               unsigned long descent;
2651               font=s->font;
2652               descent = s->y + s->height - s->ybase;
2654               /* Use underline thickness of font, defaulting to 1. */
2655               thickness = (font && font->underline_thickness > 0)
2656                 ? font->underline_thickness : 1;
2658               /* Determine the offset of underlining from the baseline. */
2659               if (x_underline_at_descent_line)
2660                 position = descent - thickness;
2661               else if (x_use_underline_position_properties
2662                        && font && font->underline_position >= 0)
2663                 position = font->underline_position;
2664               else if (font)
2665                 position = lround (font->descent / 2);
2666               else
2667                 position = underline_minimum_offset;
2669               position = max (position, underline_minimum_offset);
2671               /* Ensure underlining is not cropped. */
2672               if (descent <= position)
2673                 {
2674                   position = descent - 1;
2675                   thickness = 1;
2676                 }
2677               else if (descent < position + thickness)
2678                 thickness = 1;
2679             }
2681           s->underline_thickness = thickness;
2682           s->underline_position = position;
2684           r = NSMakeRect (x, s->ybase + position, width, thickness);
2686           if (face->underline_defaulted_p)
2687             [defaultCol set];
2688           else
2689             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2690           NSRectFill (r);
2691         }
2692     }
2693   /* Do overline. We follow other terms in using a thickness of 1
2694      and ignoring overline_margin. */
2695   if (face->overline_p)
2696     {
2697       NSRect r;
2698       r = NSMakeRect (x, s->y, width, 1);
2700       if (face->overline_color_defaulted_p)
2701         [defaultCol set];
2702       else
2703         [ns_lookup_indexed_color (face->overline_color, s->f) set];
2704       NSRectFill (r);
2705     }
2707   /* Do strike-through.  We follow other terms for thickness and
2708      vertical position.*/
2709   if (face->strike_through_p)
2710     {
2711       NSRect r;
2712       unsigned long dy;
2714       dy = lrint ((s->height - 1) / 2);
2715       r = NSMakeRect (x, s->y + dy, width, 1);
2717       if (face->strike_through_color_defaulted_p)
2718         [defaultCol set];
2719       else
2720         [ns_lookup_indexed_color (face->strike_through_color, s->f) set];
2721       NSRectFill (r);
2722     }
2725 static void
2726 ns_draw_box (NSRect r, CGFloat thickness, NSColor *col,
2727              char left_p, char right_p)
2728 /* --------------------------------------------------------------------------
2729     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2730     Note we can't just use an NSDrawRect command, because of the possibility
2731     of some sides not being drawn, and because the rect will be filled.
2732    -------------------------------------------------------------------------- */
2734   NSRect s = r;
2735   [col set];
2737   /* top, bottom */
2738   s.size.height = thickness;
2739   NSRectFill (s);
2740   s.origin.y += r.size.height - thickness;
2741   NSRectFill (s);
2743   s.size.height = r.size.height;
2744   s.origin.y = r.origin.y;
2746   /* left, right (optional) */
2747   s.size.width = thickness;
2748   if (left_p)
2749     NSRectFill (s);
2750   if (right_p)
2751     {
2752       s.origin.x += r.size.width - thickness;
2753       NSRectFill (s);
2754     }
2758 static void
2759 ns_draw_relief (NSRect r, int thickness, char raised_p,
2760                char top_p, char bottom_p, char left_p, char right_p,
2761                struct glyph_string *s)
2762 /* --------------------------------------------------------------------------
2763     Draw a relief rect inside r, optionally leaving some sides open.
2764     Note we can't just use an NSDrawBezel command, because of the possibility
2765     of some sides not being drawn, and because the rect will be filled.
2766    -------------------------------------------------------------------------- */
2768   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2769   NSColor *newBaseCol = nil;
2770   NSRect sr = r;
2772   NSTRACE (ns_draw_relief);
2774   /* set up colors */
2776   if (s->face->use_box_color_for_shadows_p)
2777     {
2778       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2779     }
2780 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2781            && s->img->pixmap
2782            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2783        {
2784          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2785        } */
2786   else
2787     {
2788       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2789     }
2791   if (newBaseCol == nil)
2792     newBaseCol = [NSColor grayColor];
2794   if (newBaseCol != baseCol)  /* TODO: better check */
2795     {
2796       [baseCol release];
2797       baseCol = [newBaseCol retain];
2798       [lightCol release];
2799       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2800       [darkCol release];
2801       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2802     }
2804   [(raised_p ? lightCol : darkCol) set];
2806   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2808   /* top */
2809   sr.size.height = thickness;
2810   if (top_p) NSRectFill (sr);
2812   /* left */
2813   sr.size.height = r.size.height;
2814   sr.size.width = thickness;
2815   if (left_p) NSRectFill (sr);
2817   [(raised_p ? darkCol : lightCol) set];
2819   /* bottom */
2820   sr.size.width = r.size.width;
2821   sr.size.height = thickness;
2822   sr.origin.y += r.size.height - thickness;
2823   if (bottom_p) NSRectFill (sr);
2825   /* right */
2826   sr.size.height = r.size.height;
2827   sr.origin.y = r.origin.y;
2828   sr.size.width = thickness;
2829   sr.origin.x += r.size.width - thickness;
2830   if (right_p) NSRectFill (sr);
2834 static void
2835 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2836 /* --------------------------------------------------------------------------
2837       Function modeled after x_draw_glyph_string_box ().
2838       Sets up parameters for drawing.
2839    -------------------------------------------------------------------------- */
2841   int right_x, last_x;
2842   char left_p, right_p;
2843   struct glyph *last_glyph;
2844   NSRect r;
2845   int thickness;
2846   struct face *face;
2848   if (s->hl == DRAW_MOUSE_FACE)
2849     {
2850       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2851       if (!face)
2852         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2853     }
2854   else
2855     face = s->face;
2857   thickness = face->box_line_width;
2859   NSTRACE (ns_dumpglyphs_box_or_relief);
2861   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2862             ? WINDOW_RIGHT_EDGE_X (s->w)
2863             : window_box_right (s->w, s->area));
2864   last_glyph = (s->cmp || s->img
2865                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2867   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2868               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2870   left_p = (s->first_glyph->left_box_line_p
2871             || (s->hl == DRAW_MOUSE_FACE
2872                 && (s->prev == NULL || s->prev->hl != s->hl)));
2873   right_p = (last_glyph->right_box_line_p
2874              || (s->hl == DRAW_MOUSE_FACE
2875                  && (s->next == NULL || s->next->hl != s->hl)));
2877   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2879   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2880   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2881     {
2882       ns_draw_box (r, abs (thickness),
2883                    ns_lookup_indexed_color (face->box_color, s->f),
2884                   left_p, right_p);
2885     }
2886   else
2887     {
2888       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2889                      1, 1, left_p, right_p, s);
2890     }
2894 static void
2895 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2896 /* --------------------------------------------------------------------------
2897       Modeled after x_draw_glyph_string_background, which draws BG in
2898       certain cases.  Others are left to the text rendering routine.
2899    -------------------------------------------------------------------------- */
2901   NSTRACE (ns_maybe_dumpglyphs_background);
2903   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2904     {
2905       int box_line_width = max (s->face->box_line_width, 0);
2906       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2907           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2908         {
2909           struct face *face;
2910           if (s->hl == DRAW_MOUSE_FACE)
2911             {
2912               face = FACE_FROM_ID (s->f,
2913                                    MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2914               if (!face)
2915                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2916             }
2917           else
2918             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2919           if (!face->stipple)
2920             [(NS_FACE_BACKGROUND (face) != 0
2921               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2922               : FRAME_BACKGROUND_COLOR (s->f)) set];
2923           else
2924             {
2925               struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (s->f);
2926               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2927             }
2929           if (s->hl != DRAW_CURSOR)
2930             {
2931               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2932                                     s->background_width,
2933                                     s->height-2*box_line_width);
2934               NSRectFill (r);
2935             }
2937           s->background_filled_p = 1;
2938         }
2939     }
2943 static void
2944 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2945 /* --------------------------------------------------------------------------
2946       Renders an image and associated borders.
2947    -------------------------------------------------------------------------- */
2949   EmacsImage *img = s->img->pixmap;
2950   int box_line_vwidth = max (s->face->box_line_width, 0);
2951   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2952   int bg_x, bg_y, bg_height;
2953   int th;
2954   char raised_p;
2955   NSRect br;
2956   struct face *face;
2957   NSColor *tdCol;
2959   NSTRACE (ns_dumpglyphs_image);
2961   if (s->face->box != FACE_NO_BOX
2962       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2963     x += abs (s->face->box_line_width);
2965   bg_x = x;
2966   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
2967   bg_height = s->height;
2968   /* other terms have this, but was causing problems w/tabbar mode */
2969   /* - 2 * box_line_vwidth; */
2971   if (s->slice.x == 0) x += s->img->hmargin;
2972   if (s->slice.y == 0) y += s->img->vmargin;
2974   /* Draw BG: if we need larger area than image itself cleared, do that,
2975      otherwise, since we composite the image under NS (instead of mucking
2976      with its background color), we must clear just the image area. */
2977   if (s->hl == DRAW_MOUSE_FACE)
2978     {
2979       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2980       if (!face)
2981        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2982     }
2983   else
2984     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2986   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
2988   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
2989       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
2990     {
2991       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
2992       s->background_filled_p = 1;
2993     }
2994   else
2995     {
2996       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
2997     }
2999   NSRectFill (br);
3001   /* Draw the image.. do we need to draw placeholder if img ==nil? */
3002   if (img != nil)
3003     {
3004 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
3005       NSRect dr = NSMakeRect (x, y, s->slice.width, s->slice.height);
3006       NSRect ir = NSMakeRect (s->slice.x, s->slice.y,
3007                               s->slice.width, s->slice.height);
3008       [img drawInRect: dr
3009              fromRect: ir
3010              operation: NSCompositeSourceOver
3011               fraction: 1.0
3012            respectFlipped: YES
3013                 hints: nil];
3014 #else
3015       [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
3016                   operation: NSCompositeSourceOver];
3017 #endif
3018     }
3020   if (s->hl == DRAW_CURSOR)
3021     {
3022     [FRAME_CURSOR_COLOR (s->f) set];
3023     if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3024       tdCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3025     else
3026       /* Currently on NS img->mask is always 0. Since
3027          get_window_cursor_type specifies a hollow box cursor when on
3028          a non-masked image we never reach this clause. But we put it
3029          in in anticipation of better support for image masks on
3030          NS. */
3031       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3032     }
3033   else
3034     {
3035       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3036     }
3038   /* Draw underline, overline, strike-through. */
3039   ns_draw_text_decoration (s, face, tdCol, br.size.width, br.origin.x);
3041   /* Draw relief, if requested */
3042   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
3043     {
3044       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
3045         {
3046           th = tool_bar_button_relief >= 0 ?
3047             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
3048           raised_p = (s->hl == DRAW_IMAGE_RAISED);
3049         }
3050       else
3051         {
3052           th = abs (s->img->relief);
3053           raised_p = (s->img->relief > 0);
3054         }
3056       r.origin.x = x - th;
3057       r.origin.y = y - th;
3058       r.size.width = s->slice.width + 2*th-1;
3059       r.size.height = s->slice.height + 2*th-1;
3060       ns_draw_relief (r, th, raised_p,
3061                       s->slice.y == 0,
3062                       s->slice.y + s->slice.height == s->img->height,
3063                       s->slice.x == 0,
3064                       s->slice.x + s->slice.width == s->img->width, s);
3065     }
3067   /* If there is no mask, the background won't be seen,
3068      so draw a rectangle on the image for the cursor.
3069      Do this for all images, getting transparency right is not reliable.  */
3070   if (s->hl == DRAW_CURSOR)
3071     {
3072       int thickness = abs (s->img->relief);
3073       if (thickness == 0) thickness = 1;
3074       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
3075     }
3079 static void
3080 ns_dumpglyphs_stretch (struct glyph_string *s)
3082   NSRect r[2];
3083   int n, i;
3084   struct face *face;
3085   NSColor *fgCol, *bgCol;
3087   if (!s->background_filled_p)
3088     {
3089       n = ns_get_glyph_string_clip_rect (s, r);
3090       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
3092       ns_focus (s->f, r, n);
3094       if (s->hl == DRAW_MOUSE_FACE)
3095        {
3096          face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3097          if (!face)
3098            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3099        }
3100       else
3101        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3103       bgCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3104       fgCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3106       for (i = 0; i < n; ++i)
3107         {
3108           if (!s->row->full_width_p)
3109             {
3110               int overrun, leftoverrun;
3112               /* truncate to avoid overwriting fringe and/or scrollbar */
3113               overrun = max (0, (s->x + s->background_width)
3114                              - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
3115                                 - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
3116               r[i].size.width -= overrun;
3118               /* truncate to avoid overwriting to left of the window box */
3119               leftoverrun = (WINDOW_BOX_LEFT_EDGE_X (s->w)
3120                              + WINDOW_LEFT_FRINGE_WIDTH (s->w)) - s->x;
3122               if (leftoverrun > 0)
3123                 {
3124                   r[i].origin.x += leftoverrun;
3125                   r[i].size.width -= leftoverrun;
3126                 }
3128               /* XXX: Try to work between problem where a stretch glyph on
3129                  a partially-visible bottom row will clear part of the
3130                  modeline, and another where list-buffers headers and similar
3131                  rows erroneously have visible_height set to 0.  Not sure
3132                  where this is coming from as other terms seem not to show. */
3133               r[i].size.height = min (s->height, s->row->visible_height);
3134             }
3136           [bgCol set];
3138           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
3139              overwriting cursor (usually when cursor on a tab) */
3140           if (s->hl == DRAW_CURSOR)
3141             {
3142               CGFloat x, width;
3144               x = r[i].origin.x;
3145               width = s->w->phys_cursor_width;
3146               r[i].size.width -= width;
3147               r[i].origin.x += width;
3149               NSRectFill (r[i]);
3151               /* Draw overlining, etc. on the cursor. */
3152               if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3153                 ns_draw_text_decoration (s, face, bgCol, width, x);
3154               else
3155                 ns_draw_text_decoration (s, face, fgCol, width, x);
3156             }
3157           else
3158             {
3159               NSRectFill (r[i]);
3160             }
3162           /* Draw overlining, etc. on the stretch glyph (or the part
3163              of the stretch glyph after the cursor). */
3164           ns_draw_text_decoration (s, face, fgCol, r[i].size.width,
3165                                    r[i].origin.x);
3166         }
3167       ns_unfocus (s->f);
3168       s->background_filled_p = 1;
3169     }
3173 static void
3174 ns_draw_glyph_string (struct glyph_string *s)
3175 /* --------------------------------------------------------------------------
3176       External (RIF): Main draw-text call.
3177    -------------------------------------------------------------------------- */
3179   /* TODO (optimize): focus for box and contents draw */
3180   NSRect r[2];
3181   int n, flags;
3182   char box_drawn_p = 0;
3183   struct font *font = s->face->font;
3184   if (! font) font = FRAME_FONT (s->f);
3186   NSTRACE (ns_draw_glyph_string);
3188   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
3189     {
3190       int width;
3191       struct glyph_string *next;
3193       for (width = 0, next = s->next;
3194            next && width < s->right_overhang;
3195            width += next->width, next = next->next)
3196         if (next->first_glyph->type != IMAGE_GLYPH)
3197           {
3198             if (next->first_glyph->type != STRETCH_GLYPH)
3199               {
3200                 n = ns_get_glyph_string_clip_rect (s->next, r);
3201                 ns_focus (s->f, r, n);
3202                 ns_maybe_dumpglyphs_background (s->next, 1);
3203                 ns_unfocus (s->f);
3204               }
3205             else
3206               {
3207                 ns_dumpglyphs_stretch (s->next);
3208               }
3209             next->num_clips = 0;
3210           }
3211     }
3213   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
3214         && (s->first_glyph->type == CHAR_GLYPH
3215             || s->first_glyph->type == COMPOSITE_GLYPH))
3216     {
3217       n = ns_get_glyph_string_clip_rect (s, r);
3218       ns_focus (s->f, r, n);
3219       ns_maybe_dumpglyphs_background (s, 1);
3220       ns_dumpglyphs_box_or_relief (s);
3221       ns_unfocus (s->f);
3222       box_drawn_p = 1;
3223     }
3225   switch (s->first_glyph->type)
3226     {
3228     case IMAGE_GLYPH:
3229       n = ns_get_glyph_string_clip_rect (s, r);
3230       ns_focus (s->f, r, n);
3231       ns_dumpglyphs_image (s, r[0]);
3232       ns_unfocus (s->f);
3233       break;
3235     case STRETCH_GLYPH:
3236       ns_dumpglyphs_stretch (s);
3237       break;
3239     case CHAR_GLYPH:
3240     case COMPOSITE_GLYPH:
3241       n = ns_get_glyph_string_clip_rect (s, r);
3242       ns_focus (s->f, r, n);
3244       if (s->for_overlaps || (s->cmp_from > 0
3245                               && ! s->first_glyph->u.cmp.automatic))
3246         s->background_filled_p = 1;
3247       else
3248         ns_maybe_dumpglyphs_background
3249           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3251       flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
3252         (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
3253          (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
3254           NS_DUMPGLYPH_NORMAL));
3256       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3257         {
3258           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3259           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3260           NS_FACE_FOREGROUND (s->face) = tmp;
3261         }
3263       font->driver->draw
3264         (s, 0, s->nchars, s->x, s->y,
3265          (flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
3266          || flags == NS_DUMPGLYPH_MOUSEFACE);
3268       {
3269         NSColor *col = (NS_FACE_FOREGROUND (s->face) != 0
3270                         ? ns_lookup_indexed_color (NS_FACE_FOREGROUND (s->face),
3271                                                    s->f)
3272                         : FRAME_FOREGROUND_COLOR (s->f));
3273         [col set];
3275         /* Draw underline, overline, strike-through. */
3276         ns_draw_text_decoration (s, s->face, col, s->width, s->x);
3277       }
3279       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3280         {
3281           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3282           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3283           NS_FACE_FOREGROUND (s->face) = tmp;
3284         }
3286       ns_unfocus (s->f);
3287       break;
3289     case GLYPHLESS_GLYPH:
3290       n = ns_get_glyph_string_clip_rect (s, r);
3291       ns_focus (s->f, r, n);
3293       if (s->for_overlaps || (s->cmp_from > 0
3294                               && ! s->first_glyph->u.cmp.automatic))
3295         s->background_filled_p = 1;
3296       else
3297         ns_maybe_dumpglyphs_background
3298           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3299       /* ... */
3300       /* Not yet implemented.  */
3301       /* ... */
3302       ns_unfocus (s->f);
3303       break;
3305     default:
3306       emacs_abort ();
3307     }
3309   /* Draw box if not done already. */
3310   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3311     {
3312       n = ns_get_glyph_string_clip_rect (s, r);
3313       ns_focus (s->f, r, n);
3314       ns_dumpglyphs_box_or_relief (s);
3315       ns_unfocus (s->f);
3316     }
3318   s->num_clips = 0;
3323 /* ==========================================================================
3325     Event loop
3327    ========================================================================== */
3330 static void
3331 ns_send_appdefined (int value)
3332 /* --------------------------------------------------------------------------
3333     Internal: post an appdefined event which EmacsApp-sendEvent will
3334               recognize and take as a command to halt the event loop.
3335    -------------------------------------------------------------------------- */
3337   /*NSTRACE (ns_send_appdefined); */
3339 #ifdef NS_IMPL_GNUSTEP
3340   // GNUStep needs postEvent to happen on the main thread.
3341   if (! [[NSThread currentThread] isMainThread])
3342     {
3343       EmacsApp *app = (EmacsApp *)NSApp;
3344       app->nextappdefined = value;
3345       [app performSelectorOnMainThread:@selector (sendFromMainThread:)
3346                             withObject:nil
3347                          waitUntilDone:YES];
3348       return;
3349     }
3350 #endif
3352   /* Only post this event if we haven't already posted one.  This will end
3353        the [NXApp run] main loop after having processed all events queued at
3354        this moment.  */
3355   if (send_appdefined)
3356     {
3357       NSEvent *nxev;
3359       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3360       send_appdefined = NO;
3362       /* Don't need wakeup timer any more */
3363       if (timed_entry)
3364         {
3365           [timed_entry invalidate];
3366           [timed_entry release];
3367           timed_entry = nil;
3368         }
3370       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3371                                 location: NSMakePoint (0, 0)
3372                            modifierFlags: 0
3373                                timestamp: 0
3374                             windowNumber: [[NSApp mainWindow] windowNumber]
3375                                  context: [NSApp context]
3376                                  subtype: 0
3377                                    data1: value
3378                                    data2: 0];
3380       /* Post an application defined event on the event queue.  When this is
3381          received the [NXApp run] will return, thus having processed all
3382          events which are currently queued.  */
3383       [NSApp postEvent: nxev atStart: NO];
3384     }
3387 #ifdef HAVE_NATIVE_FS
3388 static void
3389 check_native_fs ()
3391   Lisp_Object frame, tail;
3393   if (ns_last_use_native_fullscreen == ns_use_native_fullscreen)
3394     return;
3396   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
3398   FOR_EACH_FRAME (tail, frame)
3399     {
3400       struct frame *f = XFRAME (frame);
3401       if (FRAME_NS_P (f))
3402         {
3403           EmacsView *view = FRAME_NS_VIEW (f);
3404           [view updateCollectionBehaviour];
3405         }
3406     }
3408 #endif
3410 /* GNUStep and OSX <= 10.4 does not have cancelTracking.  */
3411 #if defined (NS_IMPL_COCOA) && \
3412   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
3413 /* Check if menu open should be cancelled or continued as normal.  */
3414 void
3415 ns_check_menu_open (NSMenu *menu)
3417   /* Click in menu bar? */
3418   NSArray *a = [[NSApp mainMenu] itemArray];
3419   int i;
3420   BOOL found = NO;
3422   if (menu == nil) // Menu tracking ended.
3423     {
3424       if (menu_will_open_state == MENU_OPENING)
3425         menu_will_open_state = MENU_NONE;
3426       return;
3427     }
3429   for (i = 0; ! found && i < [a count]; i++)
3430     found = menu == [[a objectAtIndex:i] submenu];
3431   if (found)
3432     {
3433       if (menu_will_open_state == MENU_NONE && emacs_event)
3434         {
3435           NSEvent *theEvent = [NSApp currentEvent];
3436           struct frame *emacsframe = SELECTED_FRAME ();
3438           [menu cancelTracking];
3439           menu_will_open_state = MENU_PENDING;
3440           emacs_event->kind = MENU_BAR_ACTIVATE_EVENT;
3441           EV_TRAILER (theEvent);
3443           CGEventRef ourEvent = CGEventCreate (NULL);
3444           menu_mouse_point = CGEventGetLocation (ourEvent);
3445           CFRelease (ourEvent);
3446         }
3447       else if (menu_will_open_state == MENU_OPENING)
3448         {
3449           menu_will_open_state = MENU_NONE;
3450         }
3451     }
3454 /* Redo saved menu click if state is MENU_PENDING.  */
3455 void
3456 ns_check_pending_open_menu ()
3458   if (menu_will_open_state == MENU_PENDING)
3459     {
3460       CGEventSourceRef source
3461         = CGEventSourceCreate (kCGEventSourceStateHIDSystemState);
3463       CGEventRef event = CGEventCreateMouseEvent (source,
3464                                                   kCGEventLeftMouseDown,
3465                                                   menu_mouse_point,
3466                                                   kCGMouseButtonLeft);
3467       CGEventSetType (event, kCGEventLeftMouseDown);
3468       CGEventPost (kCGHIDEventTap, event);
3469       CFRelease (event);
3470       CFRelease (source);
3472       menu_will_open_state = MENU_OPENING;
3473     }
3475 #endif /* NS_IMPL_COCOA) && >= MAC_OS_X_VERSION_10_5 */
3477 static int
3478 ns_read_socket (struct terminal *terminal, struct input_event *hold_quit)
3479 /* --------------------------------------------------------------------------
3480      External (hook): Post an event to ourself and keep reading events until
3481      we read it back again.  In effect process all events which were waiting.
3482      From 21+ we have to manage the event buffer ourselves.
3483    -------------------------------------------------------------------------- */
3485   struct input_event ev;
3486   int nevents;
3488 /* NSTRACE (ns_read_socket); */
3490 #ifdef HAVE_NATIVE_FS
3491   check_native_fs ();
3492 #endif
3494   if ([NSApp modalWindow] != nil)
3495     return -1;
3497   if (hold_event_q.nr > 0)
3498     {
3499       int i;
3500       for (i = 0; i < hold_event_q.nr; ++i)
3501         kbd_buffer_store_event_hold (&hold_event_q.q[i], hold_quit);
3502       hold_event_q.nr = 0;
3503       return i;
3504     }
3506   block_input ();
3507   n_emacs_events_pending = 0;
3508   EVENT_INIT (ev);
3509   emacs_event = &ev;
3510   q_event_ptr = hold_quit;
3512   /* we manage autorelease pools by allocate/reallocate each time around
3513      the loop; strict nesting is occasionally violated but seems not to
3514      matter.. earlier methods using full nesting caused major memory leaks */
3515   [outerpool release];
3516   outerpool = [[NSAutoreleasePool alloc] init];
3518   /* If have pending open-file requests, attend to the next one of those. */
3519   if (ns_pending_files && [ns_pending_files count] != 0
3520       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3521     {
3522       [ns_pending_files removeObjectAtIndex: 0];
3523     }
3524   /* Deal with pending service requests. */
3525   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3526     && [(EmacsApp *)
3527          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3528                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3529     {
3530       [ns_pending_service_names removeObjectAtIndex: 0];
3531       [ns_pending_service_args removeObjectAtIndex: 0];
3532     }
3533   else
3534     {
3535       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3536          to ourself, otherwise [NXApp run] will never exit.  */
3537       send_appdefined = YES;
3538       ns_send_appdefined (-1);
3540       if (++apploopnr != 1)
3541         {
3542           emacs_abort ();
3543         }
3544       [NSApp run];
3545       --apploopnr;
3546     }
3548   nevents = n_emacs_events_pending;
3549   n_emacs_events_pending = 0;
3550   emacs_event = q_event_ptr = NULL;
3551   unblock_input ();
3553   return nevents;
3558 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3559            fd_set *exceptfds, struct timespec const *timeout,
3560            sigset_t const *sigmask)
3561 /* --------------------------------------------------------------------------
3562      Replacement for select, checking for events
3563    -------------------------------------------------------------------------- */
3565   int result;
3566   int t, k, nr = 0;
3567   struct input_event event;
3568   char c;
3570 /*  NSTRACE (ns_select); */
3572 #ifdef HAVE_NATIVE_FS
3573   check_native_fs ();
3574 #endif
3576   if (hold_event_q.nr > 0)
3577     {
3578       /* We already have events pending. */
3579       raise (SIGIO);
3580       errno = EINTR;
3581       return -1;
3582     }
3584   for (k = 0; k < nfds+1; k++)
3585     {
3586       if (readfds && FD_ISSET(k, readfds)) ++nr;
3587       if (writefds && FD_ISSET(k, writefds)) ++nr;
3588     }
3590   if (NSApp == nil
3591       || (timeout && timeout->tv_sec == 0 && timeout->tv_nsec == 0))
3592     return pselect (nfds, readfds, writefds, exceptfds, timeout, sigmask);
3594   [outerpool release];
3595   outerpool = [[NSAutoreleasePool alloc] init];
3598   send_appdefined = YES;
3599   if (nr > 0)
3600     {
3601       pthread_mutex_lock (&select_mutex);
3602       select_nfds = nfds;
3603       select_valid = 0;
3604       if (readfds)
3605         {
3606           select_readfds = *readfds;
3607           select_valid += SELECT_HAVE_READ;
3608         }
3609       if (writefds)
3610         {
3611           select_writefds = *writefds;
3612           select_valid += SELECT_HAVE_WRITE;
3613         }
3615       if (timeout)
3616         {
3617           select_timeout = *timeout;
3618           select_valid += SELECT_HAVE_TMO;
3619         }
3621       pthread_mutex_unlock (&select_mutex);
3623       /* Inform fd_handler that select should be called */
3624       c = 'g';
3625       emacs_write_sig (selfds[1], &c, 1);
3626     }
3627   else if (nr == 0 && timeout)
3628     {
3629       /* No file descriptor, just a timeout, no need to wake fd_handler  */
3630       double time = timespectod (*timeout);
3631       timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3632                                                       target: NSApp
3633                                                     selector:
3634                                   @selector (timeout_handler:)
3635                                                     userInfo: 0
3636                                                      repeats: NO]
3637                       retain];
3638     }
3639   else /* No timeout and no file descriptors, can this happen?  */
3640     {
3641       /* Send appdefined so we exit from the loop */
3642       ns_send_appdefined (-1);
3643     }
3645   EVENT_INIT (event);
3646   block_input ();
3647   emacs_event = &event;
3648   if (++apploopnr != 1)
3649     {
3650       emacs_abort ();
3651     }
3652   [NSApp run];
3653   --apploopnr;
3654   emacs_event = NULL;
3655   if (nr > 0 && readfds)
3656     {
3657       c = 's';
3658       emacs_write_sig (selfds[1], &c, 1);
3659     }
3660   unblock_input ();
3662   t = last_appdefined_event_data;
3664   if (t != NO_APPDEFINED_DATA)
3665     {
3666       last_appdefined_event_data = NO_APPDEFINED_DATA;
3668       if (t == -2)
3669         {
3670           /* The NX_APPDEFINED event we received was a timeout. */
3671           result = 0;
3672         }
3673       else if (t == -1)
3674         {
3675           /* The NX_APPDEFINED event we received was the result of
3676              at least one real input event arriving.  */
3677           errno = EINTR;
3678           result = -1;
3679         }
3680       else
3681         {
3682           /* Received back from select () in fd_handler; copy the results */
3683           pthread_mutex_lock (&select_mutex);
3684           if (readfds) *readfds = select_readfds;
3685           if (writefds) *writefds = select_writefds;
3686           pthread_mutex_unlock (&select_mutex);
3687           result = t;
3688         }
3689     }
3690   else
3691     {
3692       errno = EINTR;
3693       result = -1;
3694     }
3696   return result;
3701 /* ==========================================================================
3703     Scrollbar handling
3705    ========================================================================== */
3708 static void
3709 ns_set_vertical_scroll_bar (struct window *window,
3710                            int portion, int whole, int position)
3711 /* --------------------------------------------------------------------------
3712       External (hook): Update or add scrollbar
3713    -------------------------------------------------------------------------- */
3715   Lisp_Object win;
3716   NSRect r, v;
3717   struct frame *f = XFRAME (WINDOW_FRAME (window));
3718   EmacsView *view = FRAME_NS_VIEW (f);
3719   int window_y, window_height;
3720   int top, left, height, width, sb_width, sb_left;
3721   EmacsScroller *bar;
3722   BOOL fringe_extended_p;
3724   /* optimization; display engine sends WAY too many of these.. */
3725   if (!NILP (window->vertical_scroll_bar))
3726     {
3727       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3728       if ([bar checkSamePosition: position portion: portion whole: whole])
3729         {
3730           if (view->scrollbarsNeedingUpdate == 0)
3731             {
3732               if (!windows_or_buffers_changed)
3733                   return;
3734             }
3735           else
3736             view->scrollbarsNeedingUpdate--;
3737         }
3738     }
3740   NSTRACE (ns_set_vertical_scroll_bar);
3742   /* Get dimensions.  */
3743   window_box (window, ANY_AREA, 0, &window_y, 0, &window_height);
3744   top = window_y;
3745   height = window_height;
3746   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3747   left = WINDOW_SCROLL_BAR_AREA_X (window);
3749   /* allow for displaying a skinnier scrollbar than char area allotted */
3750   sb_width = (WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) > 0) ?
3751     WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) : width;
3752   sb_left = left;
3754   r = NSMakeRect (sb_left, top, sb_width, height);
3755   /* the parent view is flipped, so we need to flip y value */
3756   v = [view frame];
3757   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3759   fringe_extended_p = WINDOW_FRINGE_EXTENDED_P (window);
3761   XSETWINDOW (win, window);
3762   block_input ();
3764   /* we want at least 5 lines to display a scrollbar */
3765   if (WINDOW_TOTAL_LINES (window) < 5)
3766     {
3767       if (!NILP (window->vertical_scroll_bar))
3768         {
3769           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3770           [bar removeFromSuperview];
3771           wset_vertical_scroll_bar (window, Qnil);
3772         }
3773       ns_clear_frame_area (f, sb_left, top, width, height);
3774       unblock_input ();
3775       return;
3776     }
3778   if (NILP (window->vertical_scroll_bar))
3779     {
3780       if (width > 0 && height > 0)
3781         {
3782           if (fringe_extended_p)
3783             ns_clear_frame_area (f, sb_left, top, sb_width, height);
3784           else
3785             ns_clear_frame_area (f, left, top, width, height);
3786         }
3788       bar = [[EmacsScroller alloc] initFrame: r window: win];
3789       wset_vertical_scroll_bar (window, make_save_ptr (bar));
3790     }
3791   else
3792     {
3793       NSRect oldRect;
3794       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3795       oldRect = [bar frame];
3796       r.size.width = oldRect.size.width;
3797       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3798         {
3799           if (oldRect.origin.x != r.origin.x)
3800               ns_clear_frame_area (f, sb_left, top, width, height);
3801           [bar setFrame: r];
3802         }
3803     }
3805   [bar setPosition: position portion: portion whole: whole];
3806   unblock_input ();
3810 static void
3811 ns_condemn_scroll_bars (struct frame *f)
3812 /* --------------------------------------------------------------------------
3813      External (hook): arrange for all frame's scrollbars to be removed
3814      at next call to judge_scroll_bars, except for those redeemed.
3815    -------------------------------------------------------------------------- */
3817   int i;
3818   id view;
3819   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3821   NSTRACE (ns_condemn_scroll_bars);
3823   for (i =[subviews count]-1; i >= 0; i--)
3824     {
3825       view = [subviews objectAtIndex: i];
3826       if ([view isKindOfClass: [EmacsScroller class]])
3827         [view condemn];
3828     }
3832 static void
3833 ns_redeem_scroll_bar (struct window *window)
3834 /* --------------------------------------------------------------------------
3835      External (hook): arrange to spare this window's scrollbar
3836      at next call to judge_scroll_bars.
3837    -------------------------------------------------------------------------- */
3839   id bar;
3840   NSTRACE (ns_redeem_scroll_bar);
3841   if (!NILP (window->vertical_scroll_bar))
3842     {
3843       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3844       [bar reprieve];
3845     }
3849 static void
3850 ns_judge_scroll_bars (struct frame *f)
3851 /* --------------------------------------------------------------------------
3852      External (hook): destroy all scrollbars on frame that weren't
3853      redeemed after call to condemn_scroll_bars.
3854    -------------------------------------------------------------------------- */
3856   int i;
3857   id view;
3858   EmacsView *eview = FRAME_NS_VIEW (f);
3859   NSArray *subviews = [[eview superview] subviews];
3860   BOOL removed = NO;
3862   NSTRACE (ns_judge_scroll_bars);
3863   for (i = [subviews count]-1; i >= 0; --i)
3864     {
3865       view = [subviews objectAtIndex: i];
3866       if (![view isKindOfClass: [EmacsScroller class]]) continue;
3867       [view judge];
3868       removed = YES;
3869     }
3871   if (removed)
3872     [eview updateFrameSize: NO];
3875 /* ==========================================================================
3877     Initialization
3879    ========================================================================== */
3882 x_display_pixel_height (struct ns_display_info *dpyinfo)
3884   NSArray *screens = [NSScreen screens];
3885   NSEnumerator *enumerator = [screens objectEnumerator];
3886   NSScreen *screen;
3887   NSRect frame;
3889   frame = NSZeroRect;
3890   while ((screen = [enumerator nextObject]) != nil)
3891     frame = NSUnionRect (frame, [screen frame]);
3893   return NSHeight (frame);
3897 x_display_pixel_width (struct ns_display_info *dpyinfo)
3899   NSArray *screens = [NSScreen screens];
3900   NSEnumerator *enumerator = [screens objectEnumerator];
3901   NSScreen *screen;
3902   NSRect frame;
3904   frame = NSZeroRect;
3905   while ((screen = [enumerator nextObject]) != nil)
3906     frame = NSUnionRect (frame, [screen frame]);
3908   return NSWidth (frame);
3912 static Lisp_Object ns_string_to_lispmod (const char *s)
3913 /* --------------------------------------------------------------------------
3914      Convert modifier name to lisp symbol
3915    -------------------------------------------------------------------------- */
3917   if (!strncmp (SSDATA (SYMBOL_NAME (Qmeta)), s, 10))
3918     return Qmeta;
3919   else if (!strncmp (SSDATA (SYMBOL_NAME (Qsuper)), s, 10))
3920     return Qsuper;
3921   else if (!strncmp (SSDATA (SYMBOL_NAME (Qcontrol)), s, 10))
3922     return Qcontrol;
3923   else if (!strncmp (SSDATA (SYMBOL_NAME (Qalt)), s, 10))
3924     return Qalt;
3925   else if (!strncmp (SSDATA (SYMBOL_NAME (Qhyper)), s, 10))
3926     return Qhyper;
3927   else if (!strncmp (SSDATA (SYMBOL_NAME (Qnone)), s, 10))
3928     return Qnone;
3929   else
3930     return Qnil;
3934 static void
3935 ns_default (const char *parameter, Lisp_Object *result,
3936            Lisp_Object yesval, Lisp_Object noval,
3937            BOOL is_float, BOOL is_modstring)
3938 /* --------------------------------------------------------------------------
3939       Check a parameter value in user's preferences
3940    -------------------------------------------------------------------------- */
3942   const char *value = ns_get_defaults_value (parameter);
3944   if (value)
3945     {
3946       double f;
3947       char *pos;
3948       if (c_strcasecmp (value, "YES") == 0)
3949         *result = yesval;
3950       else if (c_strcasecmp (value, "NO") == 0)
3951         *result = noval;
3952       else if (is_float && (f = strtod (value, &pos), pos != value))
3953         *result = make_float (f);
3954       else if (is_modstring && value)
3955         *result = ns_string_to_lispmod (value);
3956       else fprintf (stderr,
3957                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
3958     }
3962 static void
3963 ns_initialize_display_info (struct ns_display_info *dpyinfo)
3964 /* --------------------------------------------------------------------------
3965       Initialize global info and storage for display.
3966    -------------------------------------------------------------------------- */
3968     NSScreen *screen = [NSScreen mainScreen];
3969     NSWindowDepth depth = [screen depth];
3971     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
3972     dpyinfo->resy = 72.27;
3973     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
3974                                                   NSColorSpaceFromDepth (depth)]
3975                 && ![NSCalibratedWhiteColorSpace isEqualToString:
3976                                                  NSColorSpaceFromDepth (depth)];
3977     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
3978     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
3979     dpyinfo->color_table->colors = NULL;
3980     dpyinfo->root_window = 42; /* a placeholder.. */
3981     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
3982     dpyinfo->n_fonts = 0;
3983     dpyinfo->smallest_font_height = 1;
3984     dpyinfo->smallest_char_width = 1;
3986     reset_mouse_highlight (&dpyinfo->mouse_highlight);
3990 /* This and next define (many of the) public functions in this file. */
3991 /* x_... are generic versions in xdisp.c that we, and other terms, get away
3992          with using despite presence in the "system dependent" redisplay
3993          interface.  In addition, many of the ns_ methods have code that is
3994          shared with all terms, indicating need for further refactoring. */
3995 extern frame_parm_handler ns_frame_parm_handlers[];
3996 static struct redisplay_interface ns_redisplay_interface =
3998   ns_frame_parm_handlers,
3999   x_produce_glyphs,
4000   x_write_glyphs,
4001   x_insert_glyphs,
4002   x_clear_end_of_line,
4003   ns_scroll_run,
4004   ns_after_update_window_line,
4005   ns_update_window_begin,
4006   ns_update_window_end,
4007   0, /* flush_display */
4008   x_clear_window_mouse_face,
4009   x_get_glyph_overhangs,
4010   x_fix_overlapping_area,
4011   ns_draw_fringe_bitmap,
4012   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
4013   0, /* destroy_fringe_bitmap */
4014   ns_compute_glyph_string_overhangs,
4015   ns_draw_glyph_string,
4016   ns_define_frame_cursor,
4017   ns_clear_frame_area,
4018   ns_draw_window_cursor,
4019   ns_draw_vertical_window_border,
4020   ns_shift_glyphs_for_insert
4024 static void
4025 ns_delete_display (struct ns_display_info *dpyinfo)
4027   /* TODO... */
4031 /* This function is called when the last frame on a display is deleted. */
4032 static void
4033 ns_delete_terminal (struct terminal *terminal)
4035   struct ns_display_info *dpyinfo = terminal->display_info.ns;
4037   /* Protect against recursive calls.  delete_frame in
4038      delete_terminal calls us back when it deletes our last frame.  */
4039   if (!terminal->name)
4040     return;
4042   block_input ();
4044   x_destroy_all_bitmaps (dpyinfo);
4045   ns_delete_display (dpyinfo);
4046   unblock_input ();
4050 static struct terminal *
4051 ns_create_terminal (struct ns_display_info *dpyinfo)
4052 /* --------------------------------------------------------------------------
4053       Set up use of NS before we make the first connection.
4054    -------------------------------------------------------------------------- */
4056   struct terminal *terminal;
4058   NSTRACE (ns_create_terminal);
4060   terminal = create_terminal ();
4062   terminal->type = output_ns;
4063   terminal->display_info.ns = dpyinfo;
4064   dpyinfo->terminal = terminal;
4066   terminal->rif = &ns_redisplay_interface;
4068   terminal->clear_frame_hook = ns_clear_frame;
4069   terminal->ins_del_lines_hook = 0; /* XXX vestigial? */
4070   terminal->delete_glyphs_hook = 0; /* XXX vestigial? */
4071   terminal->ring_bell_hook = ns_ring_bell;
4072   terminal->reset_terminal_modes_hook = NULL;
4073   terminal->set_terminal_modes_hook = NULL;
4074   terminal->update_begin_hook = ns_update_begin;
4075   terminal->update_end_hook = ns_update_end;
4076   terminal->set_terminal_window_hook = NULL; /* XXX vestigial? */
4077   terminal->read_socket_hook = ns_read_socket;
4078   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
4079   terminal->mouse_position_hook = ns_mouse_position;
4080   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
4081   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
4083   terminal->fullscreen_hook = ns_fullscreen_hook;
4085   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
4086   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
4087   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
4088   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
4090   terminal->delete_frame_hook = x_destroy_window;
4091   terminal->delete_terminal_hook = ns_delete_terminal;
4093   return terminal;
4097 struct ns_display_info *
4098 ns_term_init (Lisp_Object display_name)
4099 /* --------------------------------------------------------------------------
4100      Start the Application and get things rolling.
4101    -------------------------------------------------------------------------- */
4103   struct terminal *terminal;
4104   struct ns_display_info *dpyinfo;
4105   static int ns_initialized = 0;
4106   Lisp_Object tmp;
4108   if (ns_initialized) return x_display_list;
4109   ns_initialized = 1;
4111   NSTRACE (ns_term_init);
4113   [outerpool release];
4114   outerpool = [[NSAutoreleasePool alloc] init];
4116   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
4117   /*GSDebugAllocationActive (YES); */
4118   block_input ();
4120   baud_rate = 38400;
4121   Fset_input_interrupt_mode (Qnil);
4123   if (selfds[0] == -1)
4124     {
4125       if (emacs_pipe (selfds) != 0)
4126         {
4127           fprintf (stderr, "Failed to create pipe: %s\n",
4128                    emacs_strerror (errno));
4129           emacs_abort ();
4130         }
4132       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4133       FD_ZERO (&select_readfds);
4134       FD_ZERO (&select_writefds);
4135       pthread_mutex_init (&select_mutex, NULL);
4136     }
4138   ns_pending_files = [[NSMutableArray alloc] init];
4139   ns_pending_service_names = [[NSMutableArray alloc] init];
4140   ns_pending_service_args = [[NSMutableArray alloc] init];
4142 /* Start app and create the main menu, window, view.
4143      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4144      The view will then ask the NSApp to stop and return to Emacs. */
4145   [EmacsApp sharedApplication];
4146   if (NSApp == nil)
4147     return NULL;
4148   [NSApp setDelegate: NSApp];
4150   /* Start the select thread.  */
4151   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4152                            toTarget:NSApp
4153                          withObject:nil];
4155   /* debugging: log all notifications */
4156   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4157                                          selector: @selector (logNotification:)
4158                                              name: nil object: nil]; */
4160   dpyinfo = xzalloc (sizeof *dpyinfo);
4162   ns_initialize_display_info (dpyinfo);
4163   terminal = ns_create_terminal (dpyinfo);
4165   terminal->kboard = allocate_kboard (Qns);
4166   /* Don't let the initial kboard remain current longer than necessary.
4167      That would cause problems if a file loaded on startup tries to
4168      prompt in the mini-buffer.  */
4169   if (current_kboard == initial_kboard)
4170     current_kboard = terminal->kboard;
4171   terminal->kboard->reference_count++;
4173   dpyinfo->next = x_display_list;
4174   x_display_list = dpyinfo;
4176   dpyinfo->name_list_element = Fcons (display_name, Qnil);
4178   terminal->name = xstrdup (SSDATA (display_name));
4180   unblock_input ();
4182   if (!inhibit_x_resources)
4183     {
4184       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4185                  Qt, Qnil, NO, NO);
4186       tmp = Qnil;
4187       /* this is a standard variable */
4188       ns_default ("AppleAntiAliasingThreshold", &tmp,
4189                  make_float (10.0), make_float (6.0), YES, NO);
4190       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4191     }
4193   {
4194     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4196     if ( cl == nil )
4197       {
4198         Lisp_Object color_file, color_map, color;
4199         unsigned long c;
4200         char *name;
4202         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4203                          Fsymbol_value (intern ("data-directory")));
4205         color_map = Fx_load_color_file (color_file);
4206         if (NILP (color_map))
4207           fatal ("Could not read %s.\n", SDATA (color_file));
4209         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4210         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4211           {
4212             color = XCAR (color_map);
4213             name = SSDATA (XCAR (color));
4214             c = XINT (XCDR (color));
4215             [cl setColor:
4216                   [NSColor colorWithCalibratedRed: RED_FROM_ULONG (c) / 255.0
4217                                             green: GREEN_FROM_ULONG (c) / 255.0
4218                                              blue: BLUE_FROM_ULONG (c) / 255.0
4219                                             alpha: 1.0]
4220                   forKey: [NSString stringWithUTF8String: name]];
4221           }
4222         [cl writeToFile: nil];
4223       }
4224   }
4226   {
4227 #ifdef NS_IMPL_GNUSTEP
4228     Vwindow_system_version = build_string (gnustep_base_version);
4229 #else
4230     /*PSnextrelease (128, c); */
4231     char c[DBL_BUFSIZE_BOUND];
4232     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4233     Vwindow_system_version = make_unibyte_string (c, len);
4234 #endif
4235   }
4237   delete_keyboard_wait_descriptor (0);
4239   ns_app_name = [[NSProcessInfo processInfo] processName];
4241 /* Set up OS X app menu */
4242 #ifdef NS_IMPL_COCOA
4243   {
4244     NSMenu *appMenu;
4245     NSMenuItem *item;
4246     /* set up the application menu */
4247     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4248     [svcsMenu setAutoenablesItems: NO];
4249     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4250     [appMenu setAutoenablesItems: NO];
4251     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4252     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4254     [appMenu insertItemWithTitle: @"About Emacs"
4255                           action: @selector (orderFrontStandardAboutPanel:)
4256                    keyEquivalent: @""
4257                          atIndex: 0];
4258     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4259     [appMenu insertItemWithTitle: @"Preferences..."
4260                           action: @selector (showPreferencesWindow:)
4261                    keyEquivalent: @","
4262                          atIndex: 2];
4263     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4264     item = [appMenu insertItemWithTitle: @"Services"
4265                                  action: @selector (menuDown:)
4266                           keyEquivalent: @""
4267                                 atIndex: 4];
4268     [appMenu setSubmenu: svcsMenu forItem: item];
4269     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4270     [appMenu insertItemWithTitle: @"Hide Emacs"
4271                           action: @selector (hide:)
4272                    keyEquivalent: @"h"
4273                          atIndex: 6];
4274     item =  [appMenu insertItemWithTitle: @"Hide Others"
4275                           action: @selector (hideOtherApplications:)
4276                    keyEquivalent: @"h"
4277                          atIndex: 7];
4278     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4279     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4280     [appMenu insertItemWithTitle: @"Quit Emacs"
4281                           action: @selector (terminate:)
4282                    keyEquivalent: @"q"
4283                          atIndex: 9];
4285     item = [mainMenu insertItemWithTitle: ns_app_name
4286                                   action: @selector (menuDown:)
4287                            keyEquivalent: @""
4288                                  atIndex: 0];
4289     [mainMenu setSubmenu: appMenu forItem: item];
4290     [dockMenu insertItemWithTitle: @"New Frame"
4291                            action: @selector (newFrame:)
4292                     keyEquivalent: @""
4293                           atIndex: 0];
4295     [NSApp setMainMenu: mainMenu];
4296     [NSApp setAppleMenu: appMenu];
4297     [NSApp setServicesMenu: svcsMenu];
4298     /* Needed at least on Cocoa, to get dock menu to show windows */
4299     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4301     [[NSNotificationCenter defaultCenter]
4302       addObserver: mainMenu
4303          selector: @selector (trackingNotification:)
4304              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4305     [[NSNotificationCenter defaultCenter]
4306       addObserver: mainMenu
4307          selector: @selector (trackingNotification:)
4308              name: NSMenuDidEndTrackingNotification object: mainMenu];
4309   }
4310 #endif /* MAC OS X menu setup */
4312   /* Register our external input/output types, used for determining
4313      applicable services and also drag/drop eligibility. */
4314   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4315   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4316                       retain];
4317   ns_drag_types = [[NSArray arrayWithObjects:
4318                             NSStringPboardType,
4319                             NSTabularTextPboardType,
4320                             NSFilenamesPboardType,
4321                             NSURLPboardType,
4322                             NSColorPboardType,
4323                             NSFontPboardType, nil] retain];
4325   /* If fullscreen is in init/default-frame-alist, focus isn't set
4326      right for fullscreen windows, so set this.  */
4327   [NSApp activateIgnoringOtherApps:YES];
4329   [NSApp run];
4330   ns_do_open_file = YES;
4332 #ifdef NS_IMPL_GNUSTEP
4333   /* GNUstep steals SIGCHLD for use in NSTask, but we don't use NSTask.
4334      We must re-catch it so subprocess works.  */
4335   catch_child_signal ();
4336 #endif
4337   return dpyinfo;
4341 void
4342 ns_term_shutdown (int sig)
4344   [[NSUserDefaults standardUserDefaults] synchronize];
4346   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4347   if (STRINGP (Vauto_save_list_file_name))
4348     unlink (SSDATA (Vauto_save_list_file_name));
4350   if (sig == 0 || sig == SIGTERM)
4351     {
4352       [NSApp terminate: NSApp];
4353     }
4354   else // force a stack trace to happen
4355     {
4356       emacs_abort ();
4357     }
4361 /* ==========================================================================
4363     EmacsApp implementation
4365    ========================================================================== */
4368 @implementation EmacsApp
4370 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_9
4371 - (id)init
4373   if (self = [super init])
4374     self->isFirst = YES;
4376   return self;
4379 - (void)run
4381     NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
4383     if (isFirst) [self finishLaunching];
4384     isFirst = NO;
4386     shouldKeepRunning = YES;
4387     do
4388     {
4389         [pool release];
4390         pool = [[NSAutoreleasePool alloc] init];
4392         NSEvent *event =
4393           [self nextEventMatchingMask:NSAnyEventMask
4394                             untilDate:[NSDate distantFuture]
4395                                inMode:NSDefaultRunLoopMode
4396                               dequeue:YES];
4397         [self sendEvent:event];
4398         [self updateWindows];
4399     } while (shouldKeepRunning);
4401     [pool release];
4404 - (void)stop: (id)sender
4406     shouldKeepRunning = NO;
4408 #endif
4410 - (void)logNotification: (NSNotification *)notification
4412   const char *name = [[notification name] UTF8String];
4413   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4414       && !strstr (name, "WindowNumber"))
4415     NSLog (@"notification: '%@'", [notification name]);
4419 - (void)sendEvent: (NSEvent *)theEvent
4420 /* --------------------------------------------------------------------------
4421      Called when NSApp is running for each event received.  Used to stop
4422      the loop when we choose, since there's no way to just run one iteration.
4423    -------------------------------------------------------------------------- */
4425   int type = [theEvent type];
4426   NSWindow *window = [theEvent window];
4428 /*  NSTRACE (sendEvent); */
4429 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4431 #ifdef NS_IMPL_GNUSTEP
4432   // Keyboard events aren't propagated to file dialogs for some reason.
4433   if ([NSApp modalWindow] != nil &&
4434       (type == NSKeyDown || type == NSKeyUp || type == NSFlagsChanged))
4435     {
4436       [[NSApp modalWindow] sendEvent: theEvent];
4437       return;
4438     }
4439 #endif
4441   if (type == NSApplicationDefined)
4442     {
4443       switch ([theEvent data2])
4444         {
4445 #ifdef NS_IMPL_COCOA
4446         case NSAPP_DATA2_RUNASSCRIPT:
4447           ns_run_ascript ();
4448           [self stop: self];
4449           return;
4450 #endif
4451         case NSAPP_DATA2_RUNFILEDIALOG:
4452           ns_run_file_dialog ();
4453           [self stop: self];
4454           return;
4455         }
4456     }
4458   if (type == NSCursorUpdate && window == nil)
4459     {
4460       fprintf (stderr, "Dropping external cursor update event.\n");
4461       return;
4462     }
4464   if (type == NSApplicationDefined)
4465     {
4466       /* Events posted by ns_send_appdefined interrupt the run loop here.
4467          But, if a modal window is up, an appdefined can still come through,
4468          (e.g., from a makeKeyWindow event) but stopping self also stops the
4469          modal loop. Just defer it until later. */
4470       if ([NSApp modalWindow] == nil)
4471         {
4472           last_appdefined_event_data = [theEvent data1];
4473           [self stop: self];
4474         }
4475       else
4476         {
4477           send_appdefined = YES;
4478         }
4479     }
4482 #ifdef NS_IMPL_COCOA
4483   /* If no dialog and none of our frames have focus and it is a move, skip it.
4484      It is a mouse move in an auxiliary menu, i.e. on the top right on OSX,
4485      such as Wifi, sound, date or similar.
4486      This prevents "spooky" highlighting in the frame under the menu.  */
4487   if (type == NSMouseMoved && [NSApp modalWindow] == nil)
4488     {
4489       struct ns_display_info *di;
4490       BOOL has_focus = NO;
4491       for (di = x_display_list; ! has_focus && di; di = di->next)
4492         has_focus = di->x_focus_frame != 0;
4493       if (! has_focus)
4494         return;
4495     }
4496 #endif
4498   [super sendEvent: theEvent];
4502 - (void)showPreferencesWindow: (id)sender
4504   struct frame *emacsframe = SELECTED_FRAME ();
4505   NSEvent *theEvent = [NSApp currentEvent];
4507   if (!emacs_event)
4508     return;
4509   emacs_event->kind = NS_NONKEY_EVENT;
4510   emacs_event->code = KEY_NS_SHOW_PREFS;
4511   emacs_event->modifiers = 0;
4512   EV_TRAILER (theEvent);
4516 - (void)newFrame: (id)sender
4518   struct frame *emacsframe = SELECTED_FRAME ();
4519   NSEvent *theEvent = [NSApp currentEvent];
4521   if (!emacs_event)
4522     return;
4523   emacs_event->kind = NS_NONKEY_EVENT;
4524   emacs_event->code = KEY_NS_NEW_FRAME;
4525   emacs_event->modifiers = 0;
4526   EV_TRAILER (theEvent);
4530 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4531 - (BOOL) openFile: (NSString *)fileName
4533   struct frame *emacsframe = SELECTED_FRAME ();
4534   NSEvent *theEvent = [NSApp currentEvent];
4536   if (!emacs_event)
4537     return NO;
4539   emacs_event->kind = NS_NONKEY_EVENT;
4540   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4541   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4542   ns_input_line = Qnil; /* can be start or cons start,end */
4543   emacs_event->modifiers =0;
4544   EV_TRAILER (theEvent);
4546   return YES;
4550 /* **************************************************************************
4552       EmacsApp delegate implementation
4554    ************************************************************************** */
4556 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4557 /* --------------------------------------------------------------------------
4558      When application is loaded, terminate event loop in ns_term_init
4559    -------------------------------------------------------------------------- */
4561   NSTRACE (applicationDidFinishLaunching);
4562   [NSApp setServicesProvider: NSApp];
4563   ns_send_appdefined (-2);
4567 /* Termination sequences:
4568     C-x C-c:
4569     Cmd-Q:
4570     MenuBar | File | Exit:
4571     Select Quit from App menubar:
4572         -terminate
4573         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4574         ns_term_shutdown()
4576     Select Quit from Dock menu:
4577     Logout attempt:
4578         -appShouldTerminate
4579           Cancel -> Nothing else
4580           Accept ->
4582           -terminate
4583           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4584           ns_term_shutdown()
4588 - (void) terminate: (id)sender
4590   struct frame *emacsframe = SELECTED_FRAME ();
4592   if (!emacs_event)
4593     return;
4595   emacs_event->kind = NS_NONKEY_EVENT;
4596   emacs_event->code = KEY_NS_POWER_OFF;
4597   emacs_event->arg = Qt; /* mark as non-key event */
4598   EV_TRAILER ((id)nil);
4602 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4604   int ret;
4606   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4607     return NSTerminateNow;
4609     ret = NSRunAlertPanel(ns_app_name,
4610                           @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4611                           @"Save Buffers and Exit", @"Cancel", nil);
4613     if (ret == NSAlertDefaultReturn)
4614         return NSTerminateNow;
4615     else if (ret == NSAlertAlternateReturn)
4616         return NSTerminateCancel;
4617     return NSTerminateNow;  /* just in case */
4620 static int
4621 not_in_argv (NSString *arg)
4623   int k;
4624   const char *a = [arg UTF8String];
4625   for (k = 1; k < initial_argc; ++k)
4626     if (strcmp (a, initial_argv[k]) == 0) return 0;
4627   return 1;
4630 /*   Notification from the Workspace to open a file */
4631 - (BOOL)application: sender openFile: (NSString *)file
4633   if (ns_do_open_file || not_in_argv (file))
4634     [ns_pending_files addObject: file];
4635   return YES;
4639 /*   Open a file as a temporary file */
4640 - (BOOL)application: sender openTempFile: (NSString *)file
4642   if (ns_do_open_file || not_in_argv (file))
4643     [ns_pending_files addObject: file];
4644   return YES;
4648 /*   Notification from the Workspace to open a file noninteractively (?) */
4649 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4651   if (ns_do_open_file || not_in_argv (file))
4652     [ns_pending_files addObject: file];
4653   return YES;
4656 /*   Notification from the Workspace to open multiple files */
4657 - (void)application: sender openFiles: (NSArray *)fileList
4659   NSEnumerator *files = [fileList objectEnumerator];
4660   NSString *file;
4661   /* Don't open files from the command line unconditionally,
4662      Cocoa parses the command line wrong, --option value tries to open value
4663      if --option is the last option.  */
4664   while ((file = [files nextObject]) != nil)
4665     if (ns_do_open_file || not_in_argv (file))
4666       [ns_pending_files addObject: file];
4668   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4673 /* Handle dock menu requests.  */
4674 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4676   return dockMenu;
4680 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4681 - (void)applicationWillBecomeActive: (NSNotification *)notification
4683   //ns_app_active=YES;
4685 - (void)applicationDidBecomeActive: (NSNotification *)notification
4687   NSTRACE (applicationDidBecomeActive);
4689   //ns_app_active=YES;
4691   ns_update_auto_hide_menu_bar ();
4692   // No constraining takes place when the application is not active.
4693   ns_constrain_all_frames ();
4695 - (void)applicationDidResignActive: (NSNotification *)notification
4697   //ns_app_active=NO;
4698   ns_send_appdefined (-1);
4703 /* ==========================================================================
4705     EmacsApp aux handlers for managing event loop
4707    ========================================================================== */
4710 - (void)timeout_handler: (NSTimer *)timedEntry
4711 /* --------------------------------------------------------------------------
4712      The timeout specified to ns_select has passed.
4713    -------------------------------------------------------------------------- */
4715   /*NSTRACE (timeout_handler); */
4716   ns_send_appdefined (-2);
4719 #ifdef NS_IMPL_GNUSTEP
4720 - (void)sendFromMainThread:(id)unused
4722   ns_send_appdefined (nextappdefined);
4724 #endif
4726 - (void)fd_handler:(id)unused
4727 /* --------------------------------------------------------------------------
4728      Check data waiting on file descriptors and terminate if so
4729    -------------------------------------------------------------------------- */
4731   int result;
4732   int waiting = 1, nfds;
4733   char c;
4735   fd_set readfds, writefds, *wfds;
4736   struct timespec timeout, *tmo;
4737   NSAutoreleasePool *pool = nil;
4739   /* NSTRACE (fd_handler); */
4741   for (;;)
4742     {
4743       [pool release];
4744       pool = [[NSAutoreleasePool alloc] init];
4746       if (waiting)
4747         {
4748           fd_set fds;
4749           FD_ZERO (&fds);
4750           FD_SET (selfds[0], &fds);
4751           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
4752           if (result > 0 && read (selfds[0], &c, 1) == 1 && c == 'g')
4753             waiting = 0;
4754         }
4755       else
4756         {
4757           pthread_mutex_lock (&select_mutex);
4758           nfds = select_nfds;
4760           if (select_valid & SELECT_HAVE_READ)
4761             readfds = select_readfds;
4762           else
4763             FD_ZERO (&readfds);
4765           if (select_valid & SELECT_HAVE_WRITE)
4766             {
4767               writefds = select_writefds;
4768               wfds = &writefds;
4769             }
4770           else
4771             wfds = NULL;
4772           if (select_valid & SELECT_HAVE_TMO)
4773             {
4774               timeout = select_timeout;
4775               tmo = &timeout;
4776             }
4777           else
4778             tmo = NULL;
4780           pthread_mutex_unlock (&select_mutex);
4782           FD_SET (selfds[0], &readfds);
4783           if (selfds[0] >= nfds) nfds = selfds[0]+1;
4785           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
4787           if (result == 0)
4788             ns_send_appdefined (-2);
4789           else if (result > 0)
4790             {
4791               if (FD_ISSET (selfds[0], &readfds))
4792                 {
4793                   if (read (selfds[0], &c, 1) == 1 && c == 's')
4794                     waiting = 1;
4795                 }
4796               else
4797                 {
4798                   pthread_mutex_lock (&select_mutex);
4799                   if (select_valid & SELECT_HAVE_READ)
4800                     select_readfds = readfds;
4801                   if (select_valid & SELECT_HAVE_WRITE)
4802                     select_writefds = writefds;
4803                   if (select_valid & SELECT_HAVE_TMO)
4804                     select_timeout = timeout;
4805                   pthread_mutex_unlock (&select_mutex);
4807                   ns_send_appdefined (result);
4808                 }
4809             }
4810           waiting = 1;
4811         }
4812     }
4817 /* ==========================================================================
4819     Service provision
4821    ========================================================================== */
4823 /* called from system: queue for next pass through event loop */
4824 - (void)requestService: (NSPasteboard *)pboard
4825               userData: (NSString *)userData
4826                  error: (NSString **)error
4828   [ns_pending_service_names addObject: userData];
4829   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4830       SSDATA (ns_string_from_pasteboard (pboard))]];
4834 /* called from ns_read_socket to clear queue */
4835 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4837   struct frame *emacsframe = SELECTED_FRAME ();
4838   NSEvent *theEvent = [NSApp currentEvent];
4840   if (!emacs_event)
4841     return NO;
4843   emacs_event->kind = NS_NONKEY_EVENT;
4844   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
4845   ns_input_spi_name = build_string ([name UTF8String]);
4846   ns_input_spi_arg = build_string ([arg UTF8String]);
4847   emacs_event->modifiers = EV_MODIFIERS (theEvent);
4848   EV_TRAILER (theEvent);
4850   return YES;
4854 @end  /* EmacsApp */
4858 /* ==========================================================================
4860     EmacsView implementation
4862    ========================================================================== */
4865 @implementation EmacsView
4867 /* needed to inform when window closed from LISP */
4868 - (void) setWindowClosing: (BOOL)closing
4870   windowClosing = closing;
4874 - (void)dealloc
4876   NSTRACE (EmacsView_dealloc);
4877   [toolbar release];
4878   if (fs_state == FULLSCREEN_BOTH)
4879     [nonfs_window release];
4880   [super dealloc];
4884 /* called on font panel selection */
4885 - (void)changeFont: (id)sender
4887   NSEvent *e = [[self window] currentEvent];
4888   struct face *face = FRAME_DEFAULT_FACE (emacsframe);
4889   struct font *font = face->font;
4890   id newFont;
4891   CGFloat size;
4892   NSFont *nsfont;
4894   NSTRACE (changeFont);
4896   if (!emacs_event)
4897     return;
4899   if (EQ (font->driver->type, Qns))
4900     nsfont = ((struct nsfont_info *)font)->nsfont;
4901 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
4902   else
4903     nsfont = (NSFont *) macfont_get_nsctfont (font);
4904 #endif
4906   if ((newFont = [sender convertFont: nsfont]))
4907     {
4908       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
4910       emacs_event->kind = NS_NONKEY_EVENT;
4911       emacs_event->modifiers = 0;
4912       emacs_event->code = KEY_NS_CHANGE_FONT;
4914       size = [newFont pointSize];
4915       ns_input_fontsize = make_number (lrint (size));
4916       ns_input_font = build_string ([[newFont familyName] UTF8String]);
4917       EV_TRAILER (e);
4918     }
4922 - (BOOL)acceptsFirstResponder
4924   NSTRACE (acceptsFirstResponder);
4925   return YES;
4929 - (void)resetCursorRects
4931   NSRect visible = [self visibleRect];
4932   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
4933   NSTRACE (resetCursorRects);
4935   if (currentCursor == nil)
4936     currentCursor = [NSCursor arrowCursor];
4938   if (!NSIsEmptyRect (visible))
4939     [self addCursorRect: visible cursor: currentCursor];
4940   [currentCursor setOnMouseEntered: YES];
4945 /*****************************************************************************/
4946 /* Keyboard handling. */
4947 #define NS_KEYLOG 0
4949 - (void)keyDown: (NSEvent *)theEvent
4951   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
4952   int code;
4953   unsigned fnKeysym = 0;
4954   static NSMutableArray *nsEvArray;
4955 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
4956   static BOOL firstTime = YES;
4957 #endif
4958   int left_is_none;
4959   unsigned int flags = [theEvent modifierFlags];
4961   NSTRACE (keyDown);
4963   /* Rhapsody and OS X give up and down events for the arrow keys */
4964   if (ns_fake_keydown == YES)
4965     ns_fake_keydown = NO;
4966   else if ([theEvent type] != NSKeyDown)
4967     return;
4969   if (!emacs_event)
4970     return;
4972  if (![[self window] isKeyWindow]
4973      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
4974      /* we must avoid an infinite loop here. */
4975      && (EmacsView *)[[theEvent window] delegate] != self)
4976    {
4977      /* XXX: There is an occasional condition in which, when Emacs display
4978          updates a different frame from the current one, and temporarily
4979          selects it, then processes some interrupt-driven input
4980          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
4981          for some reason that window has its first responder set to the NSView
4982          most recently updated (I guess), which is not the correct one. */
4983      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
4984      return;
4985    }
4987   if (nsEvArray == nil)
4988     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
4990   [NSCursor setHiddenUntilMouseMoves: YES];
4992   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
4993     {
4994       clear_mouse_face (hlinfo);
4995       hlinfo->mouse_face_hidden = 1;
4996     }
4998   if (!processingCompose)
4999     {
5000       /* When using screen sharing, no left or right information is sent,
5001          so use Left key in those cases.  */
5002       int is_left_key, is_right_key;
5004       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
5005         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
5007       /* (Carbon way: [theEvent keyCode]) */
5009       /* is it a "function key"? */
5010       fnKeysym = (code < 0x00ff && (flags&NSNumericPadKeyMask))
5011         ? ns_convert_key ([theEvent keyCode] | NSNumericPadKeyMask)
5012         : ns_convert_key (code);
5014       if (fnKeysym)
5015         {
5016           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
5017              because Emacs treats Delete and KP-Delete same (in simple.el). */
5018           if ((fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
5019 #ifdef NS_IMPL_GNUSTEP
5020               /*  GNUstep uses incompatible keycodes, even for those that are
5021                   supposed to be hardware independent.  Just check for delete.
5022                   Keypad delete does not have keysym 0xFFFF.
5023                   See http://savannah.gnu.org/bugs/?25395
5024               */
5025               || (fnKeysym == 0xFFFF && code == 127)
5026 #endif
5027             )
5028             code = 0xFF08; /* backspace */
5029           else
5030             code = fnKeysym;
5031         }
5033       /* are there modifiers? */
5034       emacs_event->modifiers = 0;
5036       if (flags & NSHelpKeyMask)
5037           emacs_event->modifiers |= hyper_modifier;
5039       if (flags & NSShiftKeyMask)
5040         emacs_event->modifiers |= shift_modifier;
5042       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
5043       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
5044         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
5046       if (is_right_key)
5047         emacs_event->modifiers |= parse_solitary_modifier
5048           (EQ (ns_right_command_modifier, Qleft)
5049            ? ns_command_modifier
5050            : ns_right_command_modifier);
5052       if (is_left_key)
5053         {
5054           emacs_event->modifiers |= parse_solitary_modifier
5055             (ns_command_modifier);
5057           /* if super (default), take input manager's word so things like
5058              dvorak / qwerty layout work */
5059           if (EQ (ns_command_modifier, Qsuper)
5060               && !fnKeysym
5061               && [[theEvent characters] length] != 0)
5062             {
5063               /* XXX: the code we get will be unshifted, so if we have
5064                  a shift modifier, must convert ourselves */
5065               if (!(flags & NSShiftKeyMask))
5066                 code = [[theEvent characters] characterAtIndex: 0];
5067 #if 0
5068               /* this is ugly and also requires linking w/Carbon framework
5069                  (for LMGetKbdType) so for now leave this rare (?) case
5070                  undealt with.. in future look into CGEvent methods */
5071               else
5072                 {
5073                   long smv = GetScriptManagerVariable (smKeyScript);
5074                   Handle uchrHandle = GetResource
5075                     ('uchr', GetScriptVariable (smv, smScriptKeys));
5076                   UInt32 dummy = 0;
5077                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
5078                                  [[theEvent characters] characterAtIndex: 0],
5079                                  kUCKeyActionDisplay,
5080                                  (flags & ~NSCommandKeyMask) >> 8,
5081                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
5082                                  &dummy, 1, &dummy, &code);
5083                   code &= 0xFF;
5084                 }
5085 #endif
5086             }
5087         }
5089       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
5090       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
5091         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
5093       if (is_right_key)
5094           emacs_event->modifiers |= parse_solitary_modifier
5095               (EQ (ns_right_control_modifier, Qleft)
5096                ? ns_control_modifier
5097                : ns_right_control_modifier);
5099       if (is_left_key)
5100         emacs_event->modifiers |= parse_solitary_modifier
5101           (ns_control_modifier);
5103       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
5104           emacs_event->modifiers |=
5105             parse_solitary_modifier (ns_function_modifier);
5107       left_is_none = NILP (ns_alternate_modifier)
5108         || EQ (ns_alternate_modifier, Qnone);
5110       is_right_key = (flags & NSRightAlternateKeyMask)
5111         == NSRightAlternateKeyMask;
5112       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
5113         || (! is_right_key
5114             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
5116       if (is_right_key)
5117         {
5118           if ((NILP (ns_right_alternate_modifier)
5119                || EQ (ns_right_alternate_modifier, Qnone)
5120                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
5121               && !fnKeysym)
5122             {   /* accept pre-interp alt comb */
5123               if ([[theEvent characters] length] > 0)
5124                 code = [[theEvent characters] characterAtIndex: 0];
5125               /*HACK: clear lone shift modifier to stop next if from firing */
5126               if (emacs_event->modifiers == shift_modifier)
5127                 emacs_event->modifiers = 0;
5128             }
5129           else
5130             emacs_event->modifiers |= parse_solitary_modifier
5131               (EQ (ns_right_alternate_modifier, Qleft)
5132                ? ns_alternate_modifier
5133                : ns_right_alternate_modifier);
5134         }
5136       if (is_left_key) /* default = meta */
5137         {
5138           if (left_is_none && !fnKeysym)
5139             {   /* accept pre-interp alt comb */
5140               if ([[theEvent characters] length] > 0)
5141                 code = [[theEvent characters] characterAtIndex: 0];
5142               /*HACK: clear lone shift modifier to stop next if from firing */
5143               if (emacs_event->modifiers == shift_modifier)
5144                 emacs_event->modifiers = 0;
5145             }
5146           else
5147               emacs_event->modifiers |=
5148                 parse_solitary_modifier (ns_alternate_modifier);
5149         }
5151   if (NS_KEYLOG)
5152     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
5153              code, fnKeysym, flags, emacs_event->modifiers);
5155       /* if it was a function key or had modifiers, pass it directly to emacs */
5156       if (fnKeysym || (emacs_event->modifiers
5157                        && (emacs_event->modifiers != shift_modifier)
5158                        && [[theEvent charactersIgnoringModifiers] length] > 0))
5159 /*[[theEvent characters] length] */
5160         {
5161           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5162           if (code < 0x20)
5163             code |= (1<<28)|(3<<16);
5164           else if (code == 0x7f)
5165             code |= (1<<28)|(3<<16);
5166           else if (!fnKeysym)
5167             emacs_event->kind = code > 0xFF
5168               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5170           emacs_event->code = code;
5171           EV_TRAILER (theEvent);
5172           processingCompose = NO;
5173           return;
5174         }
5175     }
5178 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5179   /* if we get here we should send the key for input manager processing */
5180   /* Disable warning, there is nothing a user can do about it anyway, and
5181      it does not seem to matter.  */
5182 #if 0
5183   if (firstTime && [[NSInputManager currentInputManager]
5184                      wantsToDelayTextChangeNotifications] == NO)
5185     fprintf (stderr,
5186           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
5187 #endif
5188   firstTime = NO;
5189 #endif
5190   if (NS_KEYLOG && !processingCompose)
5191     fprintf (stderr, "keyDown: Begin compose sequence.\n");
5193   processingCompose = YES;
5194   [nsEvArray addObject: theEvent];
5195   [self interpretKeyEvents: nsEvArray];
5196   [nsEvArray removeObject: theEvent];
5200 #ifdef NS_IMPL_COCOA
5201 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
5202    decided not to send key-down for.
5203    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
5204    This only applies on Tiger and earlier.
5205    If it matches one of these, send it on to keyDown. */
5206 -(void)keyUp: (NSEvent *)theEvent
5208   int flags = [theEvent modifierFlags];
5209   int code = [theEvent keyCode];
5210   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5211       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5212     {
5213       if (NS_KEYLOG)
5214         fprintf (stderr, "keyUp: passed test");
5215       ns_fake_keydown = YES;
5216       [self keyDown: theEvent];
5217     }
5219 #endif
5222 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5225 /* <NSTextInput>: called when done composing;
5226    NOTE: also called when we delete over working text, followed immed.
5227          by doCommandBySelector: deleteBackward: */
5228 - (void)insertText: (id)aString
5230   int code;
5231   int len = [(NSString *)aString length];
5232   int i;
5234   if (NS_KEYLOG)
5235     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5236   processingCompose = NO;
5238   if (!emacs_event)
5239     return;
5241   /* first, clear any working text */
5242   if (workingText != nil)
5243     [self deleteWorkingText];
5245   /* now insert the string as keystrokes */
5246   for (i =0; i<len; i++)
5247     {
5248       code = [aString characterAtIndex: i];
5249       /* TODO: still need this? */
5250       if (code == 0x2DC)
5251         code = '~'; /* 0x7E */
5252       if (code != 32) /* Space */
5253         emacs_event->modifiers = 0;
5254       emacs_event->kind
5255         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5256       emacs_event->code = code;
5257       EV_TRAILER ((id)nil);
5258     }
5262 /* <NSTextInput>: inserts display of composing characters */
5263 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5265   NSString *str = [aString respondsToSelector: @selector (string)] ?
5266     [aString string] : aString;
5267   if (NS_KEYLOG)
5268     NSLog (@"setMarkedText '%@' len =%lu range %lu from %lu",
5269            str, (unsigned long)[str length],
5270            (unsigned long)selRange.length,
5271            (unsigned long)selRange.location);
5273   if (workingText != nil)
5274     [self deleteWorkingText];
5275   if ([str length] == 0)
5276     return;
5278   if (!emacs_event)
5279     return;
5281   processingCompose = YES;
5282   workingText = [str copy];
5283   ns_working_text = build_string ([workingText UTF8String]);
5285   emacs_event->kind = NS_TEXT_EVENT;
5286   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5287   EV_TRAILER ((id)nil);
5291 /* delete display of composing characters [not in <NSTextInput>] */
5292 - (void)deleteWorkingText
5294   if (workingText == nil)
5295     return;
5296   if (NS_KEYLOG)
5297     NSLog(@"deleteWorkingText len =%lu\n", (unsigned long)[workingText length]);
5298   [workingText release];
5299   workingText = nil;
5300   processingCompose = NO;
5302   if (!emacs_event)
5303     return;
5305   emacs_event->kind = NS_TEXT_EVENT;
5306   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5307   EV_TRAILER ((id)nil);
5311 - (BOOL)hasMarkedText
5313   return workingText != nil;
5317 - (NSRange)markedRange
5319   NSRange rng = workingText != nil
5320     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5321   if (NS_KEYLOG)
5322     NSLog (@"markedRange request");
5323   return rng;
5327 - (void)unmarkText
5329   if (NS_KEYLOG)
5330     NSLog (@"unmark (accept) text");
5331   [self deleteWorkingText];
5332   processingCompose = NO;
5336 /* used to position char selection windows, etc. */
5337 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5339   NSRect rect;
5340   NSPoint pt;
5341   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5342   if (NS_KEYLOG)
5343     NSLog (@"firstRectForCharRange request");
5345   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5346   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5347   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5348   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5349                                        +FRAME_LINE_HEIGHT (emacsframe));
5351   pt = [self convertPoint: pt toView: nil];
5352   pt = [[self window] convertBaseToScreen: pt];
5353   rect.origin = pt;
5354   return rect;
5358 - (NSInteger)conversationIdentifier
5360   return (NSInteger)self;
5364 - (void)doCommandBySelector: (SEL)aSelector
5366   if (NS_KEYLOG)
5367     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5369   processingCompose = NO;
5370   if (aSelector == @selector (deleteBackward:))
5371     {
5372       /* happens when user backspaces over an ongoing composition:
5373          throw a 'delete' into the event queue */
5374       if (!emacs_event)
5375         return;
5376       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5377       emacs_event->code = 0xFF08;
5378       EV_TRAILER ((id)nil);
5379     }
5382 - (NSArray *)validAttributesForMarkedText
5384   static NSArray *arr = nil;
5385   if (arr == nil) arr = [NSArray new];
5386  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5387   return arr;
5390 - (NSRange)selectedRange
5392   if (NS_KEYLOG)
5393     NSLog (@"selectedRange request");
5394   return NSMakeRange (NSNotFound, 0);
5397 #if defined (NS_IMPL_COCOA) || GNUSTEP_GUI_MAJOR_VERSION > 0 || \
5398     GNUSTEP_GUI_MINOR_VERSION > 22
5399 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5400 #else
5401 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
5402 #endif
5404   if (NS_KEYLOG)
5405     NSLog (@"characterIndexForPoint request");
5406   return 0;
5409 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5411   static NSAttributedString *str = nil;
5412   if (str == nil) str = [NSAttributedString new];
5413   if (NS_KEYLOG)
5414     NSLog (@"attributedSubstringFromRange request");
5415   return str;
5418 /* End <NSTextInput> impl. */
5419 /*****************************************************************************/
5422 /* This is what happens when the user presses a mouse button.  */
5423 - (void)mouseDown: (NSEvent *)theEvent
5425   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5426   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5428   NSTRACE (mouseDown);
5430   [self deleteWorkingText];
5432   if (!emacs_event)
5433     return;
5435   dpyinfo->last_mouse_frame = emacsframe;
5436   /* appears to be needed to prevent spurious movement events generated on
5437      button clicks */
5438   emacsframe->mouse_moved = 0;
5440   if ([theEvent type] == NSScrollWheel)
5441     {
5442       CGFloat delta = [theEvent deltaY];
5443       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5444       if (delta == 0)
5445         return;
5446       emacs_event->kind = WHEEL_EVENT;
5447       emacs_event->code = 0;
5448       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5449         ((delta > 0) ? up_modifier : down_modifier);
5450     }
5451   else
5452     {
5453       emacs_event->kind = MOUSE_CLICK_EVENT;
5454       emacs_event->code = EV_BUTTON (theEvent);
5455       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5456                              | EV_UDMODIFIERS (theEvent);
5457     }
5458   XSETINT (emacs_event->x, lrint (p.x));
5459   XSETINT (emacs_event->y, lrint (p.y));
5460   EV_TRAILER (theEvent);
5464 - (void)rightMouseDown: (NSEvent *)theEvent
5466   NSTRACE (rightMouseDown);
5467   [self mouseDown: theEvent];
5471 - (void)otherMouseDown: (NSEvent *)theEvent
5473   NSTRACE (otherMouseDown);
5474   [self mouseDown: theEvent];
5478 - (void)mouseUp: (NSEvent *)theEvent
5480   NSTRACE (mouseUp);
5481   [self mouseDown: theEvent];
5485 - (void)rightMouseUp: (NSEvent *)theEvent
5487   NSTRACE (rightMouseUp);
5488   [self mouseDown: theEvent];
5492 - (void)otherMouseUp: (NSEvent *)theEvent
5494   NSTRACE (otherMouseUp);
5495   [self mouseDown: theEvent];
5499 - (void) scrollWheel: (NSEvent *)theEvent
5501   NSTRACE (scrollWheel);
5502   [self mouseDown: theEvent];
5506 /* Tell emacs the mouse has moved. */
5507 - (void)mouseMoved: (NSEvent *)e
5509   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5510   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5511   Lisp_Object frame;
5512   NSPoint pt;
5514 //  NSTRACE (mouseMoved);
5516   dpyinfo->last_mouse_movement_time = EV_TIMESTAMP (e);
5517   pt = [self convertPoint: [e locationInWindow] fromView: nil];
5518   dpyinfo->last_mouse_motion_x = pt.x;
5519   dpyinfo->last_mouse_motion_y = pt.y;
5521   /* update any mouse face */
5522   if (hlinfo->mouse_face_hidden)
5523     {
5524       hlinfo->mouse_face_hidden = 0;
5525       clear_mouse_face (hlinfo);
5526     }
5528   /* tooltip handling */
5529   previous_help_echo_string = help_echo_string;
5530   help_echo_string = Qnil;
5532   if (!NILP (Vmouse_autoselect_window))
5533     {
5534       NSTRACE (mouse_autoselect_window);
5535       static Lisp_Object last_mouse_window;
5536       Lisp_Object window
5537         = window_from_coordinates (emacsframe, pt.x, pt.y, 0, 0);
5539       if (WINDOWP (window)
5540           && !EQ (window, last_mouse_window)
5541           && !EQ (window, selected_window)
5542           && (focus_follows_mouse
5543               || (EQ (XWINDOW (window)->frame,
5544                       XWINDOW (selected_window)->frame))))
5545         {
5546           NSTRACE (in_window);
5547           emacs_event->kind = SELECT_WINDOW_EVENT;
5548           emacs_event->frame_or_window = window;
5549           EV_TRAILER2 (e);
5550         }
5551       /* Remember the last window where we saw the mouse.  */
5552       last_mouse_window = window;
5553     }
5555   if (!note_mouse_movement (emacsframe, pt.x, pt.y))
5556     help_echo_string = previous_help_echo_string;
5558   XSETFRAME (frame, emacsframe);
5559   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5560     {
5561       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5562          (note_mouse_highlight), which is called through the
5563          note_mouse_movement () call above */
5564       gen_help_event (help_echo_string, frame, help_echo_window,
5565                       help_echo_object, help_echo_pos);
5566     }
5567   else
5568     {
5569       help_echo_string = Qnil;
5570       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
5571     }
5573   if (emacsframe->mouse_moved && send_appdefined)
5574     ns_send_appdefined (-1);
5578 - (void)mouseDragged: (NSEvent *)e
5580   NSTRACE (mouseDragged);
5581   [self mouseMoved: e];
5585 - (void)rightMouseDragged: (NSEvent *)e
5587   NSTRACE (rightMouseDragged);
5588   [self mouseMoved: e];
5592 - (void)otherMouseDragged: (NSEvent *)e
5594   NSTRACE (otherMouseDragged);
5595   [self mouseMoved: e];
5599 - (BOOL)windowShouldClose: (id)sender
5601   NSEvent *e =[[self window] currentEvent];
5603   NSTRACE (windowShouldClose);
5604   windowClosing = YES;
5605   if (!emacs_event)
5606     return NO;
5607   emacs_event->kind = DELETE_WINDOW_EVENT;
5608   emacs_event->modifiers = 0;
5609   emacs_event->code = 0;
5610   EV_TRAILER (e);
5611   /* Don't close this window, let this be done from lisp code.  */
5612   return NO;
5615 - (void) updateFrameSize: (BOOL) delay;
5617   NSWindow *window = [self window];
5618   NSRect wr = [window frame];
5619   int extra = 0;
5620   int gsextra = 0;
5621 #ifdef NS_IMPL_GNUSTEP
5622   gsextra = 3;
5623 #endif
5625   int oldc = cols, oldr = rows;
5626   int oldw = FRAME_PIXEL_WIDTH (emacsframe),
5627     oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5628   int neww, newh;
5630   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, wr.size.width + gsextra);
5632   if (cols < MINWIDTH)
5633     cols = MINWIDTH;
5635   if (! [self isFullscreen])
5636     {
5637       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5638         + FRAME_TOOLBAR_HEIGHT (emacsframe) - gsextra;
5639     }
5641   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, wr.size.height - extra);
5643   if (rows < MINHEIGHT)
5644     rows = MINHEIGHT;
5646   neww = (int)wr.size.width - emacsframe->border_width;
5647   newh = (int)wr.size.height - extra;
5649   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5650     {
5651       NSView *view = FRAME_NS_VIEW (emacsframe);
5652       NSWindow *win = [view window];
5653       NSSize sz = [win resizeIncrements];
5655       FRAME_PIXEL_WIDTH (emacsframe) = neww;
5656       FRAME_PIXEL_HEIGHT (emacsframe) = newh;
5657       change_frame_size (emacsframe, rows, cols, 0, delay, 0);
5658       SET_FRAME_GARBAGED (emacsframe);
5659       cancel_mouse_face (emacsframe);
5661       // Did resize increments change because of a font change?
5662       if (sz.width != FRAME_COLUMN_WIDTH (emacsframe) ||
5663           sz.height != FRAME_LINE_HEIGHT (emacsframe))
5664         {
5665           sz.width = FRAME_COLUMN_WIDTH (emacsframe);
5666           sz.height = FRAME_LINE_HEIGHT (emacsframe);
5667           [win setResizeIncrements: sz];
5668         }
5670       [view setFrame: NSMakeRect (0, 0, neww, newh)];
5671       [self windowDidMove:nil];   // Update top/left.
5672     }
5675 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
5676 /* normalize frame to gridded text size */
5678   int extra = 0;
5679   int gsextra = 0;
5680 #ifdef NS_IMPL_GNUSTEP
5681   gsextra = 3;
5682 #endif
5684   NSTRACE (windowWillResize);
5685 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5687   if (fs_state == FULLSCREEN_MAXIMIZED
5688       && (maximized_width != (int)frameSize.width
5689           || maximized_height != (int)frameSize.height))
5690     [self setFSValue: FULLSCREEN_NONE];
5691   else if (fs_state == FULLSCREEN_WIDTH
5692            && maximized_width != (int)frameSize.width)
5693     [self setFSValue: FULLSCREEN_NONE];
5694   else if (fs_state == FULLSCREEN_HEIGHT
5695            && maximized_height != (int)frameSize.height)
5696     [self setFSValue: FULLSCREEN_NONE];
5697   if (fs_state == FULLSCREEN_NONE)
5698     maximized_width = maximized_height = -1;
5700   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe,
5701                                          frameSize.width + gsextra);
5702   if (cols < MINWIDTH)
5703     cols = MINWIDTH;
5705   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe,
5706                                            frameSize.height - extra);
5707   if (rows < MINHEIGHT)
5708     rows = MINHEIGHT;
5709 #ifdef NS_IMPL_COCOA
5710   {
5711     /* this sets window title to have size in it; the wm does this under GS */
5712     NSRect r = [[self window] frame];
5713     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5714       {
5715         if (old_title != 0)
5716           {
5717             xfree (old_title);
5718             old_title = 0;
5719           }
5720       }
5721     else if (fs_state == FULLSCREEN_NONE && ! maximizing_resize)
5722       {
5723         char *size_title;
5724         NSWindow *window = [self window];
5725         if (old_title == 0)
5726           {
5727             char *t = strdup ([[[self window] title] UTF8String]);
5728             char *pos = strstr (t, "  â€”  ");
5729             if (pos)
5730               *pos = '\0';
5731             old_title = t;
5732           }
5733         size_title = xmalloc (strlen (old_title) + 40);
5734         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5735         [window setTitle: [NSString stringWithUTF8String: size_title]];
5736         [window display];
5737         xfree (size_title);
5738       }
5739   }
5740 #endif /* NS_IMPL_COCOA */
5741 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5743   return frameSize;
5747 - (void)windowDidResize: (NSNotification *)notification
5749   if (! [self fsIsNative])
5750     {
5751       NSWindow *theWindow = [notification object];
5752       /* We can get notification on the non-FS window when in
5753          fullscreen mode.  */
5754       if ([self window] != theWindow) return;
5755     }
5757 #ifdef NS_IMPL_GNUSTEP
5758   NSWindow *theWindow = [notification object];
5760    /* In GNUstep, at least currently, it's possible to get a didResize
5761       without getting a willResize.. therefore we need to act as if we got
5762       the willResize now */
5763   NSSize sz = [theWindow frame].size;
5764   sz = [self windowWillResize: theWindow toSize: sz];
5765 #endif /* NS_IMPL_GNUSTEP */
5767   NSTRACE (windowDidResize);
5768 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5770 if (cols > 0 && rows > 0)
5771     {
5772       [self updateFrameSize: YES];
5773     }
5775   ns_send_appdefined (-1);
5778 #ifdef NS_IMPL_COCOA
5779 - (void)viewDidEndLiveResize
5781   [super viewDidEndLiveResize];
5782   if (old_title != 0)
5783     {
5784       [[self window] setTitle: [NSString stringWithUTF8String: old_title]];
5785       xfree (old_title);
5786       old_title = 0;
5787     }
5788   maximizing_resize = NO;
5790 #endif /* NS_IMPL_COCOA */
5793 - (void)windowDidBecomeKey: (NSNotification *)notification
5794 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5796   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5797   struct frame *old_focus = dpyinfo->x_focus_frame;
5799   NSTRACE (windowDidBecomeKey);
5801   if (emacsframe != old_focus)
5802     dpyinfo->x_focus_frame = emacsframe;
5804   ns_frame_rehighlight (emacsframe);
5806   if (emacs_event)
5807     {
5808       emacs_event->kind = FOCUS_IN_EVENT;
5809       EV_TRAILER ((id)nil);
5810     }
5814 - (void)windowDidResignKey: (NSNotification *)notification
5815 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5817   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5818   BOOL is_focus_frame = dpyinfo->x_focus_frame == emacsframe;
5819   NSTRACE (windowDidResignKey);
5821   if (is_focus_frame)
5822     dpyinfo->x_focus_frame = 0;
5824   ns_frame_rehighlight (emacsframe);
5826   /* FIXME: for some reason needed on second and subsequent clicks away
5827             from sole-frame Emacs to get hollow box to show */
5828   if (!windowClosing && [[self window] isVisible] == YES)
5829     {
5830       x_update_cursor (emacsframe, 1);
5831       x_set_frame_alpha (emacsframe);
5832     }
5834   if (emacs_event && is_focus_frame)
5835     {
5836       [self deleteWorkingText];
5837       emacs_event->kind = FOCUS_OUT_EVENT;
5838       EV_TRAILER ((id)nil);
5839     }
5843 - (void)windowWillMiniaturize: sender
5845   NSTRACE (windowWillMiniaturize);
5849 - (BOOL)isFlipped
5851   return YES;
5855 - (BOOL)isOpaque
5857   return NO;
5861 - initFrameFromEmacs: (struct frame *)f
5863   NSRect r, wr;
5864   Lisp_Object tem;
5865   NSWindow *win;
5866   NSSize sz;
5867   NSColor *col;
5868   NSString *name;
5870   NSTRACE (initFrameFromEmacs);
5872   windowClosing = NO;
5873   processingCompose = NO;
5874   scrollbarsNeedingUpdate = 0;
5875   fs_state = FULLSCREEN_NONE;
5876   fs_before_fs = next_maximized = -1;
5877 #ifdef HAVE_NATIVE_FS
5878   fs_is_native = ns_use_native_fullscreen;
5879 #else
5880   fs_is_native = NO;
5881 #endif
5882   maximized_width = maximized_height = -1;
5883   nonfs_window = nil;
5885 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
5887   ns_userRect = NSMakeRect (0, 0, 0, 0);
5888   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
5889                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
5890   [self initWithFrame: r];
5891   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
5893   FRAME_NS_VIEW (f) = self;
5894   emacsframe = f;
5895 #ifdef NS_IMPL_COCOA
5896   old_title = 0;
5897   maximizing_resize = NO;
5898 #endif
5900   win = [[EmacsWindow alloc]
5901             initWithContentRect: r
5902                       styleMask: (NSResizableWindowMask |
5903 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
5904                                   NSTitledWindowMask |
5905 #endif
5906                                   NSMiniaturizableWindowMask |
5907                                   NSClosableWindowMask)
5908                         backing: NSBackingStoreBuffered
5909                           defer: YES];
5911 #ifdef HAVE_NATIVE_FS
5912     [win setCollectionBehavior:NSWindowCollectionBehaviorFullScreenPrimary];
5913 #endif
5915   wr = [win frame];
5916   bwidth = f->border_width = wr.size.width - r.size.width;
5917   tibar_height = FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
5919   [win setAcceptsMouseMovedEvents: YES];
5920   [win setDelegate: self];
5921   [win useOptimizedDrawing: YES];
5923   sz.width = FRAME_COLUMN_WIDTH (f);
5924   sz.height = FRAME_LINE_HEIGHT (f);
5925   [win setResizeIncrements: sz];
5927   [[win contentView] addSubview: self];
5929   if (ns_drag_types)
5930     [self registerForDraggedTypes: ns_drag_types];
5932   tem = f->name;
5933   name = [NSString stringWithUTF8String:
5934                    NILP (tem) ? "Emacs" : SSDATA (tem)];
5935   [win setTitle: name];
5937   /* toolbar support */
5938   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
5939                          [NSString stringWithFormat: @"Emacs Frame %d",
5940                                    ns_window_num]];
5941   [win setToolbar: toolbar];
5942   [toolbar setVisible: NO];
5943 #ifdef NS_IMPL_COCOA
5944   {
5945     NSButton *toggleButton;
5946   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
5947   [toggleButton setTarget: self];
5948   [toggleButton setAction: @selector (toggleToolbar: )];
5949   }
5950 #endif
5951   FRAME_TOOLBAR_HEIGHT (f) = 0;
5953   tem = f->icon_name;
5954   if (!NILP (tem))
5955     [win setMiniwindowTitle:
5956            [NSString stringWithUTF8String: SSDATA (tem)]];
5958   {
5959     NSScreen *screen = [win screen];
5961     if (screen != 0)
5962       [win setFrameTopLeftPoint: NSMakePoint
5963            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
5964             IN_BOUND (-SCREENMAX,
5965                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
5966   }
5968   [win makeFirstResponder: self];
5970   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
5971                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
5972   [win setBackgroundColor: col];
5973   if ([col alphaComponent] != (EmacsCGFloat) 1.0)
5974     [win setOpaque: NO];
5976   [self allocateGState];
5978   [NSApp registerServicesMenuSendTypes: ns_send_types
5979                            returnTypes: nil];
5981   ns_window_num++;
5982   return self;
5986 - (void)windowDidMove: sender
5988   NSWindow *win = [self window];
5989   NSRect r = [win frame];
5990   NSArray *screens = [NSScreen screens];
5991   NSScreen *screen = [screens objectAtIndex: 0];
5993   NSTRACE (windowDidMove);
5995   if (!emacsframe->output_data.ns)
5996     return;
5997   if (screen != nil)
5998     {
5999       emacsframe->left_pos = r.origin.x;
6000       emacsframe->top_pos =
6001         [screen frame].size.height - (r.origin.y + r.size.height);
6002     }
6006 /* Called AFTER method below, but before our windowWillResize call there leads
6007    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
6008    location so set_window_size moves the frame. */
6009 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
6011   emacsframe->output_data.ns->zooming = 1;
6012   return YES;
6016 /* Override to do something slightly nonstandard, but nice.  First click on
6017    zoom button will zoom vertically.  Second will zoom completely.  Third
6018    returns to original. */
6019 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
6020                         defaultFrame:(NSRect)defaultFrame
6022   NSRect result = [sender frame];
6024   NSTRACE (windowWillUseStandardFrame);
6026   if (fs_before_fs != -1) /* Entering fullscreen */
6027       {
6028         result = defaultFrame;
6029       }
6030   else if (next_maximized == FULLSCREEN_HEIGHT
6031       || (next_maximized == -1
6032           && abs (defaultFrame.size.height - result.size.height)
6033           > FRAME_LINE_HEIGHT (emacsframe)))
6034     {
6035       /* first click */
6036       ns_userRect = result;
6037       maximized_height = result.size.height = defaultFrame.size.height;
6038       maximized_width = -1;
6039       result.origin.y = defaultFrame.origin.y;
6040       [self setFSValue: FULLSCREEN_HEIGHT];
6041 #ifdef NS_IMPL_COCOA
6042       maximizing_resize = YES;
6043 #endif
6044     }
6045   else if (next_maximized == FULLSCREEN_WIDTH)
6046     {
6047       ns_userRect = result;
6048       maximized_width = result.size.width = defaultFrame.size.width;
6049       maximized_height = -1;
6050       result.origin.x = defaultFrame.origin.x;
6051       [self setFSValue: FULLSCREEN_WIDTH];
6052     }
6053   else if (next_maximized == FULLSCREEN_MAXIMIZED
6054            || (next_maximized == -1
6055                && abs (defaultFrame.size.width - result.size.width)
6056                > FRAME_COLUMN_WIDTH (emacsframe)))
6057     {
6058       result = defaultFrame;  /* second click */
6059       maximized_width = result.size.width;
6060       maximized_height = result.size.height;
6061       [self setFSValue: FULLSCREEN_MAXIMIZED];
6062 #ifdef NS_IMPL_COCOA
6063       maximizing_resize = YES;
6064 #endif
6065     }
6066   else
6067     {
6068       /* restore */
6069       result = ns_userRect.size.height ? ns_userRect : result;
6070       ns_userRect = NSMakeRect (0, 0, 0, 0);
6071 #ifdef NS_IMPL_COCOA
6072       maximizing_resize = fs_state != FULLSCREEN_NONE;
6073 #endif
6074       [self setFSValue: FULLSCREEN_NONE];
6075       maximized_width = maximized_height = -1;
6076     }
6078   if (fs_before_fs == -1) next_maximized = -1;
6079   [self windowWillResize: sender toSize: result.size];
6080   return result;
6084 - (void)windowDidDeminiaturize: sender
6086   NSTRACE (windowDidDeminiaturize);
6087   if (!emacsframe->output_data.ns)
6088     return;
6090   SET_FRAME_ICONIFIED (emacsframe, 0);
6091   SET_FRAME_VISIBLE (emacsframe, 1);
6092   windows_or_buffers_changed = 63;
6094   if (emacs_event)
6095     {
6096       emacs_event->kind = DEICONIFY_EVENT;
6097       EV_TRAILER ((id)nil);
6098     }
6102 - (void)windowDidExpose: sender
6104   NSTRACE (windowDidExpose);
6105   if (!emacsframe->output_data.ns)
6106     return;
6108   SET_FRAME_VISIBLE (emacsframe, 1);
6109   SET_FRAME_GARBAGED (emacsframe);
6111   if (send_appdefined)
6112     ns_send_appdefined (-1);
6116 - (void)windowDidMiniaturize: sender
6118   NSTRACE (windowDidMiniaturize);
6119   if (!emacsframe->output_data.ns)
6120     return;
6122   SET_FRAME_ICONIFIED (emacsframe, 1);
6123   SET_FRAME_VISIBLE (emacsframe, 0);
6125   if (emacs_event)
6126     {
6127       emacs_event->kind = ICONIFY_EVENT;
6128       EV_TRAILER ((id)nil);
6129     }
6132 #ifdef HAVE_NATIVE_FS
6133 - (NSApplicationPresentationOptions)window:(NSWindow *)window
6134       willUseFullScreenPresentationOptions:
6135   (NSApplicationPresentationOptions)proposedOptions
6137   return proposedOptions|NSApplicationPresentationAutoHideToolbar;
6139 #endif
6141 - (void)windowWillEnterFullScreen:(NSNotification *)notification
6143   fs_before_fs = fs_state;
6146 - (void)windowDidEnterFullScreen:(NSNotification *)notification
6148   [self setFSValue: FULLSCREEN_BOTH];
6149   if (! [self fsIsNative])
6150     {
6151       [self windowDidBecomeKey:notification];
6152       [nonfs_window orderOut:self];
6153     }
6154   else
6155     {
6156       BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (emacsframe) ? YES : NO;
6157 #ifdef NS_IMPL_COCOA
6158 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6159       unsigned val = (unsigned)[NSApp presentationOptions];
6161       // OSX 10.7 bug fix, the menu won't appear without this.
6162       // val is non-zero on other OSX versions.
6163       if (val == 0)
6164         {
6165           NSApplicationPresentationOptions options
6166             = NSApplicationPresentationAutoHideDock
6167             | NSApplicationPresentationAutoHideMenuBar
6168             | NSApplicationPresentationFullScreen
6169             | NSApplicationPresentationAutoHideToolbar;
6171           [NSApp setPresentationOptions: options];
6172         }
6173 #endif
6174 #endif
6175       [toolbar setVisible:tbar_visible];
6176     }
6179 - (void)windowWillExitFullScreen:(NSNotification *)notification
6181   if (next_maximized != -1)
6182     fs_before_fs = next_maximized;
6185 - (void)windowDidExitFullScreen:(NSNotification *)notification
6187   [self setFSValue: fs_before_fs];
6188   fs_before_fs = -1;
6189 #ifdef HAVE_NATIVE_FS
6190   [self updateCollectionBehaviour];
6191 #endif
6192   if (FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6193     {
6194       [toolbar setVisible:YES];
6195       update_frame_tool_bar (emacsframe);
6196       [self updateFrameSize:YES];
6197       [[self window] display];
6198     }
6199   else
6200     [toolbar setVisible:NO];
6202   if (next_maximized != -1)
6203     [[self window] performZoom:self];
6206 - (BOOL)fsIsNative
6208   return fs_is_native;
6211 - (BOOL)isFullscreen
6213   if (! fs_is_native) return nonfs_window != nil;
6214 #ifdef HAVE_NATIVE_FS
6215   return ([[self window] styleMask] & NSFullScreenWindowMask) != 0;
6216 #else
6217   return NO;
6218 #endif
6221 #ifdef HAVE_NATIVE_FS
6222 - (void)updateCollectionBehaviour
6224   if (! [self isFullscreen])
6225     {
6226       NSWindow *win = [self window];
6227       NSWindowCollectionBehavior b = [win collectionBehavior];
6228       if (ns_use_native_fullscreen)
6229         b |= NSWindowCollectionBehaviorFullScreenPrimary;
6230       else
6231         b &= ~NSWindowCollectionBehaviorFullScreenPrimary;
6233       [win setCollectionBehavior: b];
6234       fs_is_native = ns_use_native_fullscreen;
6235     }
6237 #endif
6239 - (void)toggleFullScreen: (id)sender
6241   NSWindow *w, *fw;
6242   BOOL onFirstScreen;
6243   struct frame *f;
6244   NSSize sz;
6245   NSRect r, wr;
6246   NSColor *col;
6248   if (fs_is_native)
6249     {
6250 #ifdef HAVE_NATIVE_FS
6251       [[self window] toggleFullScreen:sender];
6252 #endif
6253       return;
6254     }
6256   w = [self window];
6257   onFirstScreen = [[w screen] isEqual:[[NSScreen screens] objectAtIndex:0]];
6258   f = emacsframe;
6259   wr = [w frame];
6260   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6261                                  (FRAME_DEFAULT_FACE (f)),
6262                                  f);
6264   sz.width = FRAME_COLUMN_WIDTH (f);
6265   sz.height = FRAME_LINE_HEIGHT (f);
6267   if (fs_state != FULLSCREEN_BOTH)
6268     {
6269       /* Hide dock and menubar if we are on the primary screen.  */
6270       if (onFirstScreen)
6271         {
6272 #if defined (NS_IMPL_COCOA) && \
6273   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6274           NSApplicationPresentationOptions options
6275             = NSApplicationPresentationAutoHideDock
6276             | NSApplicationPresentationAutoHideMenuBar;
6278           [NSApp setPresentationOptions: options];
6279 #else
6280           [NSMenu setMenuBarVisible:NO];
6281 #endif
6282         }
6284       fw = [[EmacsFSWindow alloc]
6285                        initWithContentRect:[w contentRectForFrameRect:wr]
6286                                  styleMask:NSBorderlessWindowMask
6287                                    backing:NSBackingStoreBuffered
6288                                      defer:YES
6289                                     screen:[w screen]];
6291       [fw setContentView:[w contentView]];
6292       [fw setTitle:[w title]];
6293       [fw setDelegate:self];
6294       [fw setAcceptsMouseMovedEvents: YES];
6295       [fw useOptimizedDrawing: YES];
6296       [fw setResizeIncrements: sz];
6297       [fw setBackgroundColor: col];
6298       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6299         [fw setOpaque: NO];
6301       f->border_width = 0;
6302       FRAME_NS_TITLEBAR_HEIGHT (f) = 0;
6303       tobar_height = FRAME_TOOLBAR_HEIGHT (f);
6304       FRAME_TOOLBAR_HEIGHT (f) = 0;
6306       nonfs_window = w;
6308       [self windowWillEnterFullScreen:nil];
6309       [fw makeKeyAndOrderFront:NSApp];
6310       [fw makeFirstResponder:self];
6311       [w orderOut:self];
6312       r = [fw frameRectForContentRect:[[fw screen] frame]];
6313       [fw setFrame: r display:YES animate:YES];
6314       [self windowDidEnterFullScreen:nil];
6315       [fw display];
6316     }
6317   else
6318     {
6319       fw = w;
6320       w = nonfs_window;
6321       nonfs_window = nil;
6323       if (onFirstScreen)
6324         {
6325 #if defined (NS_IMPL_COCOA) && \
6326   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6327           [NSApp setPresentationOptions: NSApplicationPresentationDefault];
6328 #else
6329           [NSMenu setMenuBarVisible:YES];
6330 #endif
6331         }
6333       [w setContentView:[fw contentView]];
6334       [w setResizeIncrements: sz];
6335       [w setBackgroundColor: col];
6336       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6337         [w setOpaque: NO];
6339       f->border_width = bwidth;
6340       FRAME_NS_TITLEBAR_HEIGHT (f) = tibar_height;
6341       if (FRAME_EXTERNAL_TOOL_BAR (f))
6342         FRAME_TOOLBAR_HEIGHT (f) = tobar_height;
6344       [self windowWillExitFullScreen:nil];
6345       [fw setFrame: [w frame] display:YES animate:YES];
6346       [fw close];
6347       [w makeKeyAndOrderFront:NSApp];
6348       [self windowDidExitFullScreen:nil];
6349       [self updateFrameSize:YES];
6350     }
6353 - (void)handleFS
6355   if (fs_state != emacsframe->want_fullscreen)
6356     {
6357       if (fs_state == FULLSCREEN_BOTH)
6358         {
6359           [self toggleFullScreen:self];
6360         }
6362       switch (emacsframe->want_fullscreen)
6363         {
6364         case FULLSCREEN_BOTH:
6365           [self toggleFullScreen:self];
6366           break;
6367         case FULLSCREEN_WIDTH:
6368           next_maximized = FULLSCREEN_WIDTH;
6369           if (fs_state != FULLSCREEN_BOTH)
6370             [[self window] performZoom:self];
6371           break;
6372         case FULLSCREEN_HEIGHT:
6373           next_maximized = FULLSCREEN_HEIGHT;
6374           if (fs_state != FULLSCREEN_BOTH)
6375             [[self window] performZoom:self];
6376           break;
6377         case FULLSCREEN_MAXIMIZED:
6378           next_maximized = FULLSCREEN_MAXIMIZED;
6379           if (fs_state != FULLSCREEN_BOTH)
6380             [[self window] performZoom:self];
6381           break;
6382         case FULLSCREEN_NONE:
6383           if (fs_state != FULLSCREEN_BOTH)
6384             {
6385               next_maximized = FULLSCREEN_NONE;
6386               [[self window] performZoom:self];
6387             }
6388           break;
6389         }
6391       emacsframe->want_fullscreen = FULLSCREEN_NONE;
6392     }
6396 - (void) setFSValue: (int)value
6398   Lisp_Object lval = Qnil;
6399   switch (value)
6400     {
6401     case FULLSCREEN_BOTH:
6402       lval = Qfullboth;
6403       break;
6404     case FULLSCREEN_WIDTH:
6405       lval = Qfullwidth;
6406       break;
6407     case FULLSCREEN_HEIGHT:
6408       lval = Qfullheight;
6409       break;
6410     case FULLSCREEN_MAXIMIZED:
6411       lval = Qmaximized;
6412       break;
6413     }
6414   store_frame_param (emacsframe, Qfullscreen, lval);
6415   fs_state = value;
6418 - (void)mouseEntered: (NSEvent *)theEvent
6420   NSTRACE (mouseEntered);
6421   if (emacsframe)
6422     FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6423       = EV_TIMESTAMP (theEvent);
6427 - (void)mouseExited: (NSEvent *)theEvent
6429   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
6431   NSTRACE (mouseExited);
6433   if (!hlinfo)
6434     return;
6436   FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6437     = EV_TIMESTAMP (theEvent);
6439   if (emacsframe == hlinfo->mouse_face_mouse_frame)
6440     {
6441       clear_mouse_face (hlinfo);
6442       hlinfo->mouse_face_mouse_frame = 0;
6443     }
6447 - menuDown: sender
6449   NSTRACE (menuDown);
6450   if (context_menu_value == -1)
6451     context_menu_value = [sender tag];
6452   else
6453     {
6454       NSInteger tag = [sender tag];
6455       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
6456                                     emacsframe->menu_bar_vector,
6457                                     (void *)tag);
6458     }
6460   ns_send_appdefined (-1);
6461   return self;
6465 - (EmacsToolbar *)toolbar
6467   return toolbar;
6471 /* this gets called on toolbar button click */
6472 - toolbarClicked: (id)item
6474   NSEvent *theEvent;
6475   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
6477   NSTRACE (toolbarClicked);
6479   if (!emacs_event)
6480     return self;
6482   /* send first event (for some reason two needed) */
6483   theEvent = [[self window] currentEvent];
6484   emacs_event->kind = TOOL_BAR_EVENT;
6485   XSETFRAME (emacs_event->arg, emacsframe);
6486   EV_TRAILER (theEvent);
6488   emacs_event->kind = TOOL_BAR_EVENT;
6489 /*   XSETINT (emacs_event->code, 0); */
6490   emacs_event->arg = AREF (emacsframe->tool_bar_items,
6491                            idx + TOOL_BAR_ITEM_KEY);
6492   emacs_event->modifiers = EV_MODIFIERS (theEvent);
6493   EV_TRAILER (theEvent);
6494   return self;
6498 - toggleToolbar: (id)sender
6500   if (!emacs_event)
6501     return self;
6503   emacs_event->kind = NS_NONKEY_EVENT;
6504   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
6505   EV_TRAILER ((id)nil);
6506   return self;
6510 - (void)drawRect: (NSRect)rect
6512   int x = NSMinX (rect), y = NSMinY (rect);
6513   int width = NSWidth (rect), height = NSHeight (rect);
6515   NSTRACE (drawRect);
6517   if (!emacsframe || !emacsframe->output_data.ns)
6518     return;
6520   ns_clear_frame_area (emacsframe, x, y, width, height);
6521   expose_frame (emacsframe, x, y, width, height);
6523   /*
6524     drawRect: may be called (at least in OS X 10.5) for invisible
6525     views as well for some reason.  Thus, do not infer visibility
6526     here.
6528     emacsframe->async_visible = 1;
6529     emacsframe->async_iconified = 0;
6530   */
6534 /* NSDraggingDestination protocol methods.  Actually this is not really a
6535    protocol, but a category of Object.  O well...  */
6537 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
6539   NSTRACE (draggingEntered);
6540   return NSDragOperationGeneric;
6544 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
6546   return YES;
6550 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
6552   id pb;
6553   int x, y;
6554   NSString *type;
6555   NSEvent *theEvent = [[self window] currentEvent];
6556   NSPoint position;
6558   NSTRACE (performDragOperation);
6560   if (!emacs_event)
6561     return NO;
6563   position = [self convertPoint: [sender draggingLocation] fromView: nil];
6564   x = lrint (position.x);  y = lrint (position.y);
6566   pb = [sender draggingPasteboard];
6567   type = [pb availableTypeFromArray: ns_drag_types];
6568   if (type == 0)
6569     {
6570       return NO;
6571     }
6572   else if ([type isEqualToString: NSFilenamesPboardType])
6573     {
6574       NSArray *files;
6575       NSEnumerator *fenum;
6576       NSString *file;
6578       if (!(files = [pb propertyListForType: type]))
6579         return NO;
6581       fenum = [files objectEnumerator];
6582       while ( (file = [fenum nextObject]) )
6583         {
6584           emacs_event->kind = NS_NONKEY_EVENT;
6585           emacs_event->code = KEY_NS_DRAG_FILE;
6586           XSETINT (emacs_event->x, x);
6587           XSETINT (emacs_event->y, y);
6588           ns_input_file = append2 (ns_input_file,
6589                                    build_string ([file UTF8String]));
6590           emacs_event->modifiers = EV_MODIFIERS (theEvent);
6591           EV_TRAILER (theEvent);
6592         }
6593       return YES;
6594     }
6595   else if ([type isEqualToString: NSURLPboardType])
6596     {
6597       NSString *file;
6598       NSURL *fileURL;
6600       if (!(fileURL = [NSURL URLFromPasteboard: pb]) ||
6601           [fileURL isFileURL] == NO)
6602         return NO;
6604       file = [fileURL path];
6605       emacs_event->kind = NS_NONKEY_EVENT;
6606       emacs_event->code = KEY_NS_DRAG_FILE;
6607       XSETINT (emacs_event->x, x);
6608       XSETINT (emacs_event->y, y);
6609       ns_input_file = append2 (ns_input_file, build_string ([file UTF8String]));
6610       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6611       EV_TRAILER (theEvent);
6612       return YES;
6613     }
6614   else if ([type isEqualToString: NSStringPboardType]
6615            || [type isEqualToString: NSTabularTextPboardType])
6616     {
6617       NSString *data;
6619       if (! (data = [pb stringForType: type]))
6620         return NO;
6622       emacs_event->kind = NS_NONKEY_EVENT;
6623       emacs_event->code = KEY_NS_DRAG_TEXT;
6624       XSETINT (emacs_event->x, x);
6625       XSETINT (emacs_event->y, y);
6626       ns_input_text = build_string ([data UTF8String]);
6627       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6628       EV_TRAILER (theEvent);
6629       return YES;
6630     }
6631   else if ([type isEqualToString: NSColorPboardType])
6632     {
6633       NSColor *c = [NSColor colorFromPasteboard: pb];
6634       emacs_event->kind = NS_NONKEY_EVENT;
6635       emacs_event->code = KEY_NS_DRAG_COLOR;
6636       XSETINT (emacs_event->x, x);
6637       XSETINT (emacs_event->y, y);
6638       ns_input_color = ns_color_to_lisp (c);
6639       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6640       EV_TRAILER (theEvent);
6641       return YES;
6642     }
6643   else if ([type isEqualToString: NSFontPboardType])
6644     {
6645       /* impl based on GNUstep NSTextView.m */
6646       NSData *data = [pb dataForType: NSFontPboardType];
6647       NSDictionary *dict = [NSUnarchiver unarchiveObjectWithData: data];
6648       NSFont *font = [dict objectForKey: NSFontAttributeName];
6649       char fontSize[10];
6651       if (font == nil)
6652         return NO;
6654       emacs_event->kind = NS_NONKEY_EVENT;
6655       emacs_event->code = KEY_NS_CHANGE_FONT;
6656       XSETINT (emacs_event->x, x);
6657       XSETINT (emacs_event->y, y);
6658       ns_input_font = build_string ([[font fontName] UTF8String]);
6659       snprintf (fontSize, 10, "%f", [font pointSize]);
6660       ns_input_fontsize = build_string (fontSize);
6661       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6662       EV_TRAILER (theEvent);
6663       return YES;
6664     }
6665   else
6666     {
6667       error ("Invalid data type in dragging pasteboard.");
6668       return NO;
6669     }
6673 - (id) validRequestorForSendType: (NSString *)typeSent
6674                       returnType: (NSString *)typeReturned
6676   NSTRACE (validRequestorForSendType);
6677   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
6678       && typeReturned == nil)
6679     {
6680       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
6681         return self;
6682     }
6684   return [super validRequestorForSendType: typeSent
6685                                returnType: typeReturned];
6689 /* The next two methods are part of NSServicesRequests informal protocol,
6690    supposedly called when a services menu item is chosen from this app.
6691    But this should not happen because we override the services menu with our
6692    own entries which call ns-perform-service.
6693    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
6694    So let's at least stub them out until further investigation can be done. */
6696 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
6698   /* we could call ns_string_from_pasteboard(pboard) here but then it should
6699      be written into the buffer in place of the existing selection..
6700      ordinary service calls go through functions defined in ns-win.el */
6701   return NO;
6704 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
6706   NSArray *typesDeclared;
6707   Lisp_Object val;
6709   /* We only support NSStringPboardType */
6710   if ([types containsObject:NSStringPboardType] == NO) {
6711     return NO;
6712   }
6714   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6715   if (CONSP (val) && SYMBOLP (XCAR (val)))
6716     {
6717       val = XCDR (val);
6718       if (CONSP (val) && NILP (XCDR (val)))
6719         val = XCAR (val);
6720     }
6721   if (! STRINGP (val))
6722     return NO;
6724   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
6725   [pb declareTypes:typesDeclared owner:nil];
6726   ns_string_to_pasteboard (pb, val);
6727   return YES;
6731 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
6732    (gives a miniaturized version of the window); currently we use the latter for
6733    frames whose active buffer doesn't correspond to any file
6734    (e.g., '*scratch*') */
6735 - setMiniwindowImage: (BOOL) setMini
6737   id image = [[self window] miniwindowImage];
6738   NSTRACE (setMiniwindowImage);
6740   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
6741      about "AppleDockIconEnabled" notwithstanding, however the set message
6742      below has its effect nonetheless. */
6743   if (image != emacsframe->output_data.ns->miniimage)
6744     {
6745       if (image && [image isKindOfClass: [EmacsImage class]])
6746         [image release];
6747       [[self window] setMiniwindowImage:
6748                        setMini ? emacsframe->output_data.ns->miniimage : nil];
6749     }
6751   return self;
6755 - (void) setRows: (int) r andColumns: (int) c
6757   rows = r;
6758   cols = c;
6761 @end  /* EmacsView */
6765 /* ==========================================================================
6767     EmacsWindow implementation
6769    ========================================================================== */
6771 @implementation EmacsWindow
6773 #ifdef NS_IMPL_COCOA
6774 - (id)accessibilityAttributeValue:(NSString *)attribute
6776   Lisp_Object str = Qnil;
6777   struct frame *f = SELECTED_FRAME ();
6778   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->contents);
6780   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
6781     return NSAccessibilityTextFieldRole;
6783   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
6784       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
6785     {
6786       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6787     }
6788   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
6789     {
6790       if (! NILP (BVAR (curbuf, mark_active)))
6791           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6793       if (NILP (str))
6794         {
6795           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
6796           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
6797           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
6799           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
6800             str = make_uninit_multibyte_string (range, byte_range);
6801           else
6802             str = make_uninit_string (range);
6803           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
6804              Is this a problem?  */
6805           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
6806         }
6807     }
6810   if (! NILP (str))
6811     {
6812       if (CONSP (str) && SYMBOLP (XCAR (str)))
6813         {
6814           str = XCDR (str);
6815           if (CONSP (str) && NILP (XCDR (str)))
6816             str = XCAR (str);
6817         }
6818       if (STRINGP (str))
6819         {
6820           const char *utfStr = SSDATA (str);
6821           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
6822           return nsStr;
6823         }
6824     }
6826   return [super accessibilityAttributeValue:attribute];
6828 #endif /* NS_IMPL_COCOA */
6830 /* If we have multiple monitors, one above the other, we don't want to
6831    restrict the height to just one monitor.  So we override this.  */
6832 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
6834   /* When making the frame visible for the first time or if there is just
6835      one screen, we want to constrain.  Other times not.  */
6836   NSUInteger nr_screens = [[NSScreen screens] count];
6837   struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
6838   NSTRACE (constrainFrameRect);
6840   if (nr_screens == 1)
6841     {
6842       NSRect r = [super constrainFrameRect:frameRect toScreen:screen];
6843       return r;
6844     }
6846   if (f->output_data.ns->dont_constrain
6847       || ns_menu_bar_should_be_hidden ())
6848     return frameRect;
6850   f->output_data.ns->dont_constrain = 1;
6851   return [super constrainFrameRect:frameRect toScreen:screen];
6854 @end /* EmacsWindow */
6857 @implementation EmacsFSWindow
6859 - (BOOL)canBecomeKeyWindow
6861   return YES;
6864 - (BOOL)canBecomeMainWindow
6866   return YES;
6869 @end
6871 /* ==========================================================================
6873     EmacsScroller implementation
6875    ========================================================================== */
6878 @implementation EmacsScroller
6880 /* for repeat button push */
6881 #define SCROLL_BAR_FIRST_DELAY 0.5
6882 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
6884 + (CGFloat) scrollerWidth
6886   /* TODO: if we want to allow variable widths, this is the place to do it,
6887            however neither GNUstep nor Cocoa support it very well */
6888   return [NSScroller scrollerWidth];
6892 - initFrame: (NSRect )r window: (Lisp_Object)nwin
6894   NSTRACE (EmacsScroller_initFrame);
6896   r.size.width = [EmacsScroller scrollerWidth];
6897   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
6898   [self setContinuous: YES];
6899   [self setEnabled: YES];
6901   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
6902      locked against the top and bottom edges, and right edge on OS X, where
6903      scrollers are on right. */
6904 #ifdef NS_IMPL_GNUSTEP
6905   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
6906 #else
6907   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
6908 #endif
6910   win = nwin;
6911   condemned = NO;
6912   pixel_height = NSHeight (r);
6913   if (pixel_height == 0) pixel_height = 1;
6914   min_portion = 20 / pixel_height;
6916   frame = XFRAME (XWINDOW (win)->frame);
6917   if (FRAME_LIVE_P (frame))
6918     {
6919       int i;
6920       EmacsView *view = FRAME_NS_VIEW (frame);
6921       NSView *sview = [[view window] contentView];
6922       NSArray *subs = [sview subviews];
6924       /* disable optimization stopping redraw of other scrollbars */
6925       view->scrollbarsNeedingUpdate = 0;
6926       for (i =[subs count]-1; i >= 0; i--)
6927         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
6928           view->scrollbarsNeedingUpdate++;
6929       [sview addSubview: self];
6930     }
6932 /*  [self setFrame: r]; */
6934   return self;
6938 - (void)setFrame: (NSRect)newRect
6940   NSTRACE (EmacsScroller_setFrame);
6941 /*  block_input (); */
6942   pixel_height = NSHeight (newRect);
6943   if (pixel_height == 0) pixel_height = 1;
6944   min_portion = 20 / pixel_height;
6945   [super setFrame: newRect];
6946   [self display];
6947 /*  unblock_input (); */
6951 - (void)dealloc
6953   NSTRACE (EmacsScroller_dealloc);
6954   if (!NILP (win))
6955     wset_vertical_scroll_bar (XWINDOW (win), Qnil);
6956   [super dealloc];
6960 - condemn
6962   NSTRACE (condemn);
6963   condemned =YES;
6964   return self;
6968 - reprieve
6970   NSTRACE (reprieve);
6971   condemned =NO;
6972   return self;
6976 - judge
6978   NSTRACE (judge);
6979   if (condemned)
6980     {
6981       EmacsView *view;
6982       block_input ();
6983       /* ensure other scrollbar updates after deletion */
6984       view = (EmacsView *)FRAME_NS_VIEW (frame);
6985       if (view != nil)
6986         view->scrollbarsNeedingUpdate++;
6987       [self removeFromSuperview];
6988       [self release];
6989       unblock_input ();
6990     }
6991   return self;
6995 - (void)resetCursorRects
6997   NSRect visible = [self visibleRect];
6998   NSTRACE (resetCursorRects);
7000   if (!NSIsEmptyRect (visible))
7001     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
7002   [[NSCursor arrowCursor] setOnMouseEntered: YES];
7006 - (int) checkSamePosition: (int) position portion: (int) portion
7007                     whole: (int) whole
7009   return em_position ==position && em_portion ==portion && em_whole ==whole
7010     && portion != whole; /* needed for resize empty buf */
7014 - setPosition: (int)position portion: (int)portion whole: (int)whole
7016   NSTRACE (setPosition);
7018   em_position = position;
7019   em_portion = portion;
7020   em_whole = whole;
7022   if (portion >= whole)
7023     {
7024 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7025       [self setKnobProportion: 1.0];
7026       [self setDoubleValue: 1.0];
7027 #else
7028       [self setFloatValue: 0.0 knobProportion: 1.0];
7029 #endif
7030     }
7031   else
7032     {
7033       float pos;
7034       CGFloat por;
7035       portion = max ((float)whole*min_portion/pixel_height, portion);
7036       pos = (float)position / (whole - portion);
7037       por = (CGFloat)portion/whole;
7038 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7039       [self setKnobProportion: por];
7040       [self setDoubleValue: pos];
7041 #else
7042       [self setFloatValue: pos knobProportion: por];
7043 #endif
7044     }
7046   /* Events may come here even if the event loop is not running.
7047      If we don't enter the event loop, the scroll bar will not update.
7048      So send SIGIO to ourselves.  */
7049   if (apploopnr == 0) raise (SIGIO);
7051   return self;
7054 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
7055      drag events will go directly to the EmacsScroller.  Leaving in for now. */
7056 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
7057                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
7059   *part = last_hit_part;
7060   *window = win;
7061   XSETINT (*y, pixel_height);
7062   if ([self floatValue] > 0.999F)
7063     XSETINT (*x, pixel_height);
7064   else
7065     XSETINT (*x, pixel_height * [self floatValue]);
7069 /* set up emacs_event */
7070 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
7072   if (!emacs_event)
7073     return;
7075   emacs_event->part = last_hit_part;
7076   emacs_event->code = 0;
7077   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
7078   emacs_event->frame_or_window = win;
7079   emacs_event->timestamp = EV_TIMESTAMP (e);
7080   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
7081   emacs_event->arg = Qnil;
7082   XSETINT (emacs_event->x, loc * pixel_height);
7083   XSETINT (emacs_event->y, pixel_height-20);
7085   if (q_event_ptr)
7086     {
7087       n_emacs_events_pending++;
7088       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
7089     }
7090   else
7091     hold_event (emacs_event);
7092   EVENT_INIT (*emacs_event);
7093   ns_send_appdefined (-1);
7097 /* called manually thru timer to implement repeated button action w/hold-down */
7098 - repeatScroll: (NSTimer *)scrollEntry
7100   NSEvent *e = [[self window] currentEvent];
7101   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
7102   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
7104   /* clear timer if need be */
7105   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
7106     {
7107         [scroll_repeat_entry invalidate];
7108         [scroll_repeat_entry release];
7109         scroll_repeat_entry = nil;
7111         if (inKnob)
7112           return self;
7114         scroll_repeat_entry
7115           = [[NSTimer scheduledTimerWithTimeInterval:
7116                         SCROLL_BAR_CONTINUOUS_DELAY
7117                                             target: self
7118                                           selector: @selector (repeatScroll:)
7119                                           userInfo: 0
7120                                            repeats: YES]
7121               retain];
7122     }
7124   [self sendScrollEventAtLoc: 0 fromEvent: e];
7125   return self;
7129 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
7130    mouseDragged events without going into a modal loop. */
7131 - (void)mouseDown: (NSEvent *)e
7133   NSRect sr, kr;
7134   /* hitPart is only updated AFTER event is passed on */
7135   NSScrollerPart part = [self testPart: [e locationInWindow]];
7136   CGFloat inc = 0.0, loc, kloc, pos;
7137   int edge = 0;
7139   NSTRACE (EmacsScroller_mouseDown);
7141   switch (part)
7142     {
7143     case NSScrollerDecrementPage:
7144         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
7145     case NSScrollerIncrementPage:
7146         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
7147     case NSScrollerDecrementLine:
7148       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
7149     case NSScrollerIncrementLine:
7150       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
7151     case NSScrollerKnob:
7152       last_hit_part = scroll_bar_handle; break;
7153     case NSScrollerKnobSlot:  /* GNUstep-only */
7154       last_hit_part = scroll_bar_move_ratio; break;
7155     default:  /* NSScrollerNoPart? */
7156       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
7157                (long) part);
7158       return;
7159     }
7161   if (inc != 0.0)
7162     {
7163       pos = 0;      /* ignored */
7165       /* set a timer to repeat, as we can't let superclass do this modally */
7166       scroll_repeat_entry
7167         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
7168                                             target: self
7169                                           selector: @selector (repeatScroll:)
7170                                           userInfo: 0
7171                                            repeats: YES]
7172             retain];
7173     }
7174   else
7175     {
7176       /* handle, or on GNUstep possibly slot */
7177       NSEvent *fake_event;
7179       /* compute float loc in slot and mouse offset on knob */
7180       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7181                       toView: nil];
7182       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7183       if (loc <= 0.0)
7184         {
7185           loc = 0.0;
7186           edge = -1;
7187         }
7188       else if (loc >= NSHeight (sr))
7189         {
7190           loc = NSHeight (sr);
7191           edge = 1;
7192         }
7194       if (edge)
7195         kloc = 0.5 * edge;
7196       else
7197         {
7198           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
7199                           toView: nil];
7200           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
7201         }
7202       last_mouse_offset = kloc;
7204       /* if knob, tell emacs a location offset by knob pos
7205          (to indicate top of handle) */
7206       if (part == NSScrollerKnob)
7207           pos = (loc - last_mouse_offset) / NSHeight (sr);
7208       else
7209         /* else this is a slot click on GNUstep: go straight there */
7210         pos = loc / NSHeight (sr);
7212       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
7213       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
7214                                       location: [e locationInWindow]
7215                                  modifierFlags: [e modifierFlags]
7216                                      timestamp: [e timestamp]
7217                                   windowNumber: [e windowNumber]
7218                                        context: [e context]
7219                                    eventNumber: [e eventNumber]
7220                                     clickCount: [e clickCount]
7221                                       pressure: [e pressure]];
7222       [super mouseUp: fake_event];
7223     }
7225   if (part != NSScrollerKnob)
7226     [self sendScrollEventAtLoc: pos fromEvent: e];
7230 /* Called as we manually track scroller drags, rather than superclass. */
7231 - (void)mouseDragged: (NSEvent *)e
7233     NSRect sr;
7234     double loc, pos;
7236     NSTRACE (EmacsScroller_mouseDragged);
7238       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7239                       toView: nil];
7240       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7242       if (loc <= 0.0)
7243         {
7244           loc = 0.0;
7245         }
7246       else if (loc >= NSHeight (sr) + last_mouse_offset)
7247         {
7248           loc = NSHeight (sr) + last_mouse_offset;
7249         }
7251       pos = (loc - last_mouse_offset) / NSHeight (sr);
7252       [self sendScrollEventAtLoc: pos fromEvent: e];
7256 - (void)mouseUp: (NSEvent *)e
7258   if (scroll_repeat_entry)
7259     {
7260       [scroll_repeat_entry invalidate];
7261       [scroll_repeat_entry release];
7262       scroll_repeat_entry = nil;
7263     }
7264   last_hit_part = 0;
7268 /* treat scrollwheel events in the bar as though they were in the main window */
7269 - (void) scrollWheel: (NSEvent *)theEvent
7271   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
7272   [view mouseDown: theEvent];
7275 @end  /* EmacsScroller */
7278 #ifdef NS_IMPL_GNUSTEP
7279 /* Dummy class to get rid of startup warnings.  */
7280 @implementation EmacsDocument
7282 @end
7283 #endif
7286 /* ==========================================================================
7288    Font-related functions; these used to be in nsfaces.m
7290    ========================================================================== */
7293 Lisp_Object
7294 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7296   struct font *font = XFONT_OBJECT (font_object);
7298   if (fontset < 0)
7299     fontset = fontset_from_font (font_object);
7300   FRAME_FONTSET (f) = fontset;
7302   if (FRAME_FONT (f) == font)
7303     /* This font is already set in frame F.  There's nothing more to
7304        do.  */
7305     return font_object;
7307   FRAME_FONT (f) = font;
7309   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7310   FRAME_COLUMN_WIDTH (f) = font->average_width;
7311   FRAME_LINE_HEIGHT (f) = font->height;
7313   compute_fringe_widths (f, 1);
7315   /* Compute the scroll bar width in character columns.  */
7316   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7317     {
7318       int wid = FRAME_COLUMN_WIDTH (f);
7319       FRAME_CONFIG_SCROLL_BAR_COLS (f)
7320         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
7321     }
7322   else
7323     {
7324       int wid = FRAME_COLUMN_WIDTH (f);
7325       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7326     }
7328   /* Now make the frame display the given font.  */
7329   if (FRAME_NS_WINDOW (f) != 0)
7330         x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7332   return font_object;
7336 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
7337 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
7338          in 1.43. */
7340 const char *
7341 ns_xlfd_to_fontname (const char *xlfd)
7342 /* --------------------------------------------------------------------------
7343     Convert an X font name (XLFD) to an NS font name.
7344     Only family is used.
7345     The string returned is temporarily allocated.
7346    -------------------------------------------------------------------------- */
7348   char *name = xmalloc (180);
7349   int i, len;
7350   const char *ret;
7352   if (!strncmp (xlfd, "--", 2))
7353     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
7354   else
7355     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
7357   /* stopgap for malformed XLFD input */
7358   if (strlen (name) == 0)
7359     strcpy (name, "Monaco");
7361   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
7362      also uppercase after '-' or ' ' */
7363   name[0] = c_toupper (name[0]);
7364   for (len =strlen (name), i =0; i<len; i++)
7365     {
7366       if (name[i] == '$')
7367         {
7368           name[i] = '-';
7369           if (i+1<len)
7370             name[i+1] = c_toupper (name[i+1]);
7371         }
7372       else if (name[i] == '_')
7373         {
7374           name[i] = ' ';
7375           if (i+1<len)
7376             name[i+1] = c_toupper (name[i+1]);
7377         }
7378     }
7379 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
7380   ret = [[NSString stringWithUTF8String: name] UTF8String];
7381   xfree (name);
7382   return ret;
7386 void
7387 syms_of_nsterm (void)
7389   NSTRACE (syms_of_nsterm);
7391   ns_antialias_threshold = 10.0;
7393   /* from 23+ we need to tell emacs what modifiers there are.. */
7394   DEFSYM (Qmodifier_value, "modifier-value");
7395   DEFSYM (Qalt, "alt");
7396   DEFSYM (Qhyper, "hyper");
7397   DEFSYM (Qmeta, "meta");
7398   DEFSYM (Qsuper, "super");
7399   DEFSYM (Qcontrol, "control");
7400   DEFSYM (QUTF8_STRING, "UTF8_STRING");
7402   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
7403   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
7404   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
7405   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
7406   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
7408   DEFVAR_LISP ("ns-input-file", ns_input_file,
7409               "The file specified in the last NS event.");
7410   ns_input_file =Qnil;
7412   DEFVAR_LISP ("ns-input-text", ns_input_text,
7413               "The data received in the last NS text drag event.");
7414   ns_input_text =Qnil;
7416   DEFVAR_LISP ("ns-working-text", ns_working_text,
7417               "String for visualizing working composition sequence.");
7418   ns_working_text =Qnil;
7420   DEFVAR_LISP ("ns-input-font", ns_input_font,
7421               "The font specified in the last NS event.");
7422   ns_input_font =Qnil;
7424   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
7425               "The fontsize specified in the last NS event.");
7426   ns_input_fontsize =Qnil;
7428   DEFVAR_LISP ("ns-input-line", ns_input_line,
7429                "The line specified in the last NS event.");
7430   ns_input_line =Qnil;
7432   DEFVAR_LISP ("ns-input-color", ns_input_color,
7433                "The color specified in the last NS event.");
7434   ns_input_color =Qnil;
7436   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
7437                "The service name specified in the last NS event.");
7438   ns_input_spi_name =Qnil;
7440   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
7441                "The service argument specified in the last NS event.");
7442   ns_input_spi_arg =Qnil;
7444   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
7445                "This variable describes the behavior of the alternate or option key.\n\
7446 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7447 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7448 at all, allowing it to be used at a lower level for accented character entry.");
7449   ns_alternate_modifier = Qmeta;
7451   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
7452                "This variable describes the behavior of the right alternate or option key.\n\
7453 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7454 Set to left means be the same key as `ns-alternate-modifier'.\n\
7455 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7456 at all, allowing it to be used at a lower level for accented character entry.");
7457   ns_right_alternate_modifier = Qleft;
7459   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
7460                "This variable describes the behavior of the command key.\n\
7461 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7462   ns_command_modifier = Qsuper;
7464   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
7465                "This variable describes the behavior of the right command key.\n\
7466 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7467 Set to left means be the same key as `ns-command-modifier'.\n\
7468 Set to none means that the command / option key is not interpreted by Emacs\n\
7469 at all, allowing it to be used at a lower level for accented character entry.");
7470   ns_right_command_modifier = Qleft;
7472   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
7473                "This variable describes the behavior of the control key.\n\
7474 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7475   ns_control_modifier = Qcontrol;
7477   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
7478                "This variable describes the behavior of the right control key.\n\
7479 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7480 Set to left means be the same key as `ns-control-modifier'.\n\
7481 Set to none means that the control / option key is not interpreted by Emacs\n\
7482 at all, allowing it to be used at a lower level for accented character entry.");
7483   ns_right_control_modifier = Qleft;
7485   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
7486                "This variable describes the behavior of the function key (on laptops).\n\
7487 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7488 Set to none means that the function key is not interpreted by Emacs at all,\n\
7489 allowing it to be used at a lower level for accented character entry.");
7490   ns_function_modifier = Qnone;
7492   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
7493                "Non-nil (the default) means to render text antialiased.");
7494   ns_antialias_text = Qt;
7496   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
7497                "Whether to confirm application quit using dialog.");
7498   ns_confirm_quit = Qnil;
7500   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
7501                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
7502 Only works on OSX 10.6 or later.  */);
7503   ns_auto_hide_menu_bar = Qnil;
7505   DEFVAR_BOOL ("ns-use-native-fullscreen", ns_use_native_fullscreen,
7506      doc: /*Non-nil means to use native fullscreen on OSX >= 10.7.
7507 Nil means use fullscreen the old (< 10.7) way.  The old way works better with
7508 multiple monitors, but lacks tool bar.  This variable is ignored on OSX < 10.7.
7509 Default is t for OSX >= 10.7, nil otherwise. */);
7510 #ifdef HAVE_NATIVE_FS
7511   ns_use_native_fullscreen = YES;
7512 #else
7513   ns_use_native_fullscreen = NO;
7514 #endif
7515   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
7517   /* TODO: move to common code */
7518   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
7519                doc: /* Which toolkit scroll bars Emacs uses, if any.
7520 A value of nil means Emacs doesn't use toolkit scroll bars.
7521 With the X Window system, the value is a symbol describing the
7522 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
7523 With MS Windows or Nextstep, the value is t.  */);
7524   Vx_toolkit_scroll_bars = Qt;
7526   DEFVAR_BOOL ("x-use-underline-position-properties",
7527                x_use_underline_position_properties,
7528      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
7529 A value of nil means ignore them.  If you encounter fonts with bogus
7530 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
7531 to 4.1, set this to nil. */);
7532   x_use_underline_position_properties = 0;
7534   DEFVAR_BOOL ("x-underline-at-descent-line",
7535                x_underline_at_descent_line,
7536      doc: /* Non-nil means to draw the underline at the same place as the descent line.
7537 A value of nil means to draw the underline according to the value of the
7538 variable `x-use-underline-position-properties', which is usually at the
7539 baseline level.  The default value is nil.  */);
7540   x_underline_at_descent_line = 0;
7542   /* Tell Emacs about this window system.  */
7543   Fprovide (Qns, Qnil);
7545   DEFSYM (Qcocoa, "cocoa");
7546   DEFSYM (Qgnustep, "gnustep");
7548   syms_of_nsfont ();
7549 #ifdef NS_IMPL_COCOA
7550   Fprovide (Qcocoa, Qnil);
7551 #if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
7552   syms_of_macfont ();
7553 #endif
7554 #else
7555   Fprovide (Qgnustep, Qnil);
7556 #endif
7557