international/mule-cmds.el (select-safe-coding-system): Remove a superfluous conditio...
[emacs.git] / src / nsterm.m
blob6625d09b5ca502005e356e13c56c397c3689de61
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;
177 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
178    the maximum font size to NOT antialias.  On GNUstep there is currently
179    no way to control this behavior. */
180 float ns_antialias_threshold;
182 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
183 NSString *ns_app_name = @"Emacs";  /* default changed later */
185 /* Display variables */
186 struct ns_display_info *x_display_list; /* Chain of existing displays */
187 Lisp_Object ns_display_name_list;
188 long context_menu_value = 0;
190 /* display update */
191 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 #ifdef NS_IMPL_COCOA
1465   if ([nsname isEqualToString: @"ns_selection_bg_color"])
1466     {
1467       NSString *defname = [[NSUserDefaults standardUserDefaults]
1468                             stringForKey: @"AppleHighlightColor"];
1470       if (defname != nil)
1471         nsname = defname;
1472       else if ((new = [NSColor selectedTextBackgroundColor]) != nil)
1473         {
1474           *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1475           unblock_input ();
1476           return 0;
1477         }
1478       else
1479         nsname = NS_SELECTION_BG_COLOR_DEFAULT;
1481       name = [nsname UTF8String];
1482     }
1483   else if ([nsname isEqualToString: @"ns_selection_fg_color"])
1484     {
1485       /* NOTE: OSX applications normally don't set foreground selection, but
1486          text may be unreadable if we don't.
1487       */
1488       if ((new = [NSColor selectedTextColor]) != nil)
1489         {
1490           *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1491           unblock_input ();
1492           return 0;
1493         }
1495       nsname = NS_SELECTION_FG_COLOR_DEFAULT;
1496       name = [nsname UTF8String];
1497     }
1498 #endif // NS_IMPL_COCOA
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->image_cache = make_image_cache ();
3979     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
3980     dpyinfo->color_table->colors = NULL;
3981     dpyinfo->root_window = 42; /* a placeholder.. */
3982     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
3983     dpyinfo->n_fonts = 0;
3984     dpyinfo->smallest_font_height = 1;
3985     dpyinfo->smallest_char_width = 1;
3987     reset_mouse_highlight (&dpyinfo->mouse_highlight);
3991 /* This and next define (many of the) public functions in this file. */
3992 /* x_... are generic versions in xdisp.c that we, and other terms, get away
3993          with using despite presence in the "system dependent" redisplay
3994          interface.  In addition, many of the ns_ methods have code that is
3995          shared with all terms, indicating need for further refactoring. */
3996 extern frame_parm_handler ns_frame_parm_handlers[];
3997 static struct redisplay_interface ns_redisplay_interface =
3999   ns_frame_parm_handlers,
4000   x_produce_glyphs,
4001   x_write_glyphs,
4002   x_insert_glyphs,
4003   x_clear_end_of_line,
4004   ns_scroll_run,
4005   ns_after_update_window_line,
4006   ns_update_window_begin,
4007   ns_update_window_end,
4008   0, /* flush_display */
4009   x_clear_window_mouse_face,
4010   x_get_glyph_overhangs,
4011   x_fix_overlapping_area,
4012   ns_draw_fringe_bitmap,
4013   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
4014   0, /* destroy_fringe_bitmap */
4015   ns_compute_glyph_string_overhangs,
4016   ns_draw_glyph_string,
4017   ns_define_frame_cursor,
4018   ns_clear_frame_area,
4019   ns_draw_window_cursor,
4020   ns_draw_vertical_window_border,
4021   ns_shift_glyphs_for_insert
4025 static void
4026 ns_delete_display (struct ns_display_info *dpyinfo)
4028   /* TODO... */
4032 /* This function is called when the last frame on a display is deleted. */
4033 static void
4034 ns_delete_terminal (struct terminal *terminal)
4036   struct ns_display_info *dpyinfo = terminal->display_info.ns;
4038   /* Protect against recursive calls.  delete_frame in
4039      delete_terminal calls us back when it deletes our last frame.  */
4040   if (!terminal->name)
4041     return;
4043   block_input ();
4045   x_destroy_all_bitmaps (dpyinfo);
4046   ns_delete_display (dpyinfo);
4047   unblock_input ();
4051 static struct terminal *
4052 ns_create_terminal (struct ns_display_info *dpyinfo)
4053 /* --------------------------------------------------------------------------
4054       Set up use of NS before we make the first connection.
4055    -------------------------------------------------------------------------- */
4057   struct terminal *terminal;
4059   NSTRACE (ns_create_terminal);
4061   terminal = create_terminal ();
4063   terminal->type = output_ns;
4064   terminal->display_info.ns = dpyinfo;
4065   dpyinfo->terminal = terminal;
4067   terminal->rif = &ns_redisplay_interface;
4069   terminal->clear_frame_hook = ns_clear_frame;
4070   terminal->ins_del_lines_hook = 0; /* XXX vestigial? */
4071   terminal->delete_glyphs_hook = 0; /* XXX vestigial? */
4072   terminal->ring_bell_hook = ns_ring_bell;
4073   terminal->reset_terminal_modes_hook = NULL;
4074   terminal->set_terminal_modes_hook = NULL;
4075   terminal->update_begin_hook = ns_update_begin;
4076   terminal->update_end_hook = ns_update_end;
4077   terminal->set_terminal_window_hook = NULL; /* XXX vestigial? */
4078   terminal->read_socket_hook = ns_read_socket;
4079   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
4080   terminal->mouse_position_hook = ns_mouse_position;
4081   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
4082   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
4084   terminal->fullscreen_hook = ns_fullscreen_hook;
4086   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
4087   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
4088   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
4089   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
4091   terminal->delete_frame_hook = x_destroy_window;
4092   terminal->delete_terminal_hook = ns_delete_terminal;
4094   terminal->scroll_region_ok = 1;
4095   terminal->char_ins_del_ok = 1;
4096   terminal->line_ins_del_ok = 1;
4097   terminal->fast_clear_end_of_line = 1;
4098   terminal->memory_below_frame = 0;
4100   return terminal;
4104 struct ns_display_info *
4105 ns_term_init (Lisp_Object display_name)
4106 /* --------------------------------------------------------------------------
4107      Start the Application and get things rolling.
4108    -------------------------------------------------------------------------- */
4110   struct terminal *terminal;
4111   struct ns_display_info *dpyinfo;
4112   static int ns_initialized = 0;
4113   Lisp_Object tmp;
4115   if (ns_initialized) return x_display_list;
4116   ns_initialized = 1;
4118   NSTRACE (ns_term_init);
4120   [outerpool release];
4121   outerpool = [[NSAutoreleasePool alloc] init];
4123   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
4124   /*GSDebugAllocationActive (YES); */
4125   block_input ();
4127   baud_rate = 38400;
4128   Fset_input_interrupt_mode (Qnil);
4130   if (selfds[0] == -1)
4131     {
4132       if (emacs_pipe (selfds) != 0)
4133         {
4134           fprintf (stderr, "Failed to create pipe: %s\n",
4135                    emacs_strerror (errno));
4136           emacs_abort ();
4137         }
4139       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4140       FD_ZERO (&select_readfds);
4141       FD_ZERO (&select_writefds);
4142       pthread_mutex_init (&select_mutex, NULL);
4143     }
4145   ns_pending_files = [[NSMutableArray alloc] init];
4146   ns_pending_service_names = [[NSMutableArray alloc] init];
4147   ns_pending_service_args = [[NSMutableArray alloc] init];
4149 /* Start app and create the main menu, window, view.
4150      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4151      The view will then ask the NSApp to stop and return to Emacs. */
4152   [EmacsApp sharedApplication];
4153   if (NSApp == nil)
4154     return NULL;
4155   [NSApp setDelegate: NSApp];
4157   /* Start the select thread.  */
4158   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4159                            toTarget:NSApp
4160                          withObject:nil];
4162   /* debugging: log all notifications */
4163   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4164                                          selector: @selector (logNotification:)
4165                                              name: nil object: nil]; */
4167   dpyinfo = xzalloc (sizeof *dpyinfo);
4169   ns_initialize_display_info (dpyinfo);
4170   terminal = ns_create_terminal (dpyinfo);
4172   terminal->kboard = allocate_kboard (Qns);
4173   /* Don't let the initial kboard remain current longer than necessary.
4174      That would cause problems if a file loaded on startup tries to
4175      prompt in the mini-buffer.  */
4176   if (current_kboard == initial_kboard)
4177     current_kboard = terminal->kboard;
4178   terminal->kboard->reference_count++;
4180   dpyinfo->next = x_display_list;
4181   x_display_list = dpyinfo;
4183   /* Put it on ns_display_name_list */
4184   ns_display_name_list = Fcons (Fcons (display_name, Qnil),
4185                                 ns_display_name_list);
4186   dpyinfo->name_list_element = XCAR (ns_display_name_list);
4188   terminal->name = xstrdup (SSDATA (display_name));
4190   unblock_input ();
4192   if (!inhibit_x_resources)
4193     {
4194       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4195                  Qt, Qnil, NO, NO);
4196       tmp = Qnil;
4197       /* this is a standard variable */
4198       ns_default ("AppleAntiAliasingThreshold", &tmp,
4199                  make_float (10.0), make_float (6.0), YES, NO);
4200       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4201     }
4203   {
4204     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4206     if ( cl == nil )
4207       {
4208         Lisp_Object color_file, color_map, color;
4209         unsigned long c;
4210         char *name;
4212         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4213                          Fsymbol_value (intern ("data-directory")));
4215         color_map = Fx_load_color_file (color_file);
4216         if (NILP (color_map))
4217           fatal ("Could not read %s.\n", SDATA (color_file));
4219         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4220         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4221           {
4222             color = XCAR (color_map);
4223             name = SSDATA (XCAR (color));
4224             c = XINT (XCDR (color));
4225             [cl setColor:
4226                   [NSColor colorWithCalibratedRed: RED_FROM_ULONG (c) / 255.0
4227                                             green: GREEN_FROM_ULONG (c) / 255.0
4228                                              blue: BLUE_FROM_ULONG (c) / 255.0
4229                                             alpha: 1.0]
4230                   forKey: [NSString stringWithUTF8String: name]];
4231           }
4232         [cl writeToFile: nil];
4233       }
4234   }
4236   {
4237 #ifdef NS_IMPL_GNUSTEP
4238     Vwindow_system_version = build_string (gnustep_base_version);
4239 #else
4240     /*PSnextrelease (128, c); */
4241     char c[DBL_BUFSIZE_BOUND];
4242     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4243     Vwindow_system_version = make_unibyte_string (c, len);
4244 #endif
4245   }
4247   delete_keyboard_wait_descriptor (0);
4249   ns_app_name = [[NSProcessInfo processInfo] processName];
4251 /* Set up OS X app menu */
4252 #ifdef NS_IMPL_COCOA
4253   {
4254     NSMenu *appMenu;
4255     NSMenuItem *item;
4256     /* set up the application menu */
4257     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4258     [svcsMenu setAutoenablesItems: NO];
4259     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4260     [appMenu setAutoenablesItems: NO];
4261     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4262     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4264     [appMenu insertItemWithTitle: @"About Emacs"
4265                           action: @selector (orderFrontStandardAboutPanel:)
4266                    keyEquivalent: @""
4267                          atIndex: 0];
4268     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4269     [appMenu insertItemWithTitle: @"Preferences..."
4270                           action: @selector (showPreferencesWindow:)
4271                    keyEquivalent: @","
4272                          atIndex: 2];
4273     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4274     item = [appMenu insertItemWithTitle: @"Services"
4275                                  action: @selector (menuDown:)
4276                           keyEquivalent: @""
4277                                 atIndex: 4];
4278     [appMenu setSubmenu: svcsMenu forItem: item];
4279     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4280     [appMenu insertItemWithTitle: @"Hide Emacs"
4281                           action: @selector (hide:)
4282                    keyEquivalent: @"h"
4283                          atIndex: 6];
4284     item =  [appMenu insertItemWithTitle: @"Hide Others"
4285                           action: @selector (hideOtherApplications:)
4286                    keyEquivalent: @"h"
4287                          atIndex: 7];
4288     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4289     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4290     [appMenu insertItemWithTitle: @"Quit Emacs"
4291                           action: @selector (terminate:)
4292                    keyEquivalent: @"q"
4293                          atIndex: 9];
4295     item = [mainMenu insertItemWithTitle: ns_app_name
4296                                   action: @selector (menuDown:)
4297                            keyEquivalent: @""
4298                                  atIndex: 0];
4299     [mainMenu setSubmenu: appMenu forItem: item];
4300     [dockMenu insertItemWithTitle: @"New Frame"
4301                            action: @selector (newFrame:)
4302                     keyEquivalent: @""
4303                           atIndex: 0];
4305     [NSApp setMainMenu: mainMenu];
4306     [NSApp setAppleMenu: appMenu];
4307     [NSApp setServicesMenu: svcsMenu];
4308     /* Needed at least on Cocoa, to get dock menu to show windows */
4309     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4311     [[NSNotificationCenter defaultCenter]
4312       addObserver: mainMenu
4313          selector: @selector (trackingNotification:)
4314              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4315     [[NSNotificationCenter defaultCenter]
4316       addObserver: mainMenu
4317          selector: @selector (trackingNotification:)
4318              name: NSMenuDidEndTrackingNotification object: mainMenu];
4319   }
4320 #endif /* MAC OS X menu setup */
4322   /* Register our external input/output types, used for determining
4323      applicable services and also drag/drop eligibility. */
4324   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4325   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4326                       retain];
4327   ns_drag_types = [[NSArray arrayWithObjects:
4328                             NSStringPboardType,
4329                             NSTabularTextPboardType,
4330                             NSFilenamesPboardType,
4331                             NSURLPboardType,
4332                             NSColorPboardType,
4333                             NSFontPboardType, nil] retain];
4335   /* If fullscreen is in init/default-frame-alist, focus isn't set
4336      right for fullscreen windows, so set this.  */
4337   [NSApp activateIgnoringOtherApps:YES];
4339   [NSApp run];
4340   ns_do_open_file = YES;
4342 #ifdef NS_IMPL_GNUSTEP
4343   /* GNUstep steals SIGCHLD for use in NSTask, but we don't use NSTask.
4344      We must re-catch it so subprocess works.  */
4345   catch_child_signal ();
4346 #endif
4347   return dpyinfo;
4351 void
4352 ns_term_shutdown (int sig)
4354   [[NSUserDefaults standardUserDefaults] synchronize];
4356   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4357   if (STRINGP (Vauto_save_list_file_name))
4358     unlink (SSDATA (Vauto_save_list_file_name));
4360   if (sig == 0 || sig == SIGTERM)
4361     {
4362       [NSApp terminate: NSApp];
4363     }
4364   else // force a stack trace to happen
4365     {
4366       emacs_abort ();
4367     }
4371 /* ==========================================================================
4373     EmacsApp implementation
4375    ========================================================================== */
4378 @implementation EmacsApp
4380 - (void)logNotification: (NSNotification *)notification
4382   const char *name = [[notification name] UTF8String];
4383   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4384       && !strstr (name, "WindowNumber"))
4385     NSLog (@"notification: '%@'", [notification name]);
4389 - (void)sendEvent: (NSEvent *)theEvent
4390 /* --------------------------------------------------------------------------
4391      Called when NSApp is running for each event received.  Used to stop
4392      the loop when we choose, since there's no way to just run one iteration.
4393    -------------------------------------------------------------------------- */
4395   int type = [theEvent type];
4396   NSWindow *window = [theEvent window];
4398 /*  NSTRACE (sendEvent); */
4399 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4401 #ifdef NS_IMPL_GNUSTEP
4402   // Keyboard events aren't propagated to file dialogs for some reason.
4403   if ([NSApp modalWindow] != nil &&
4404       (type == NSKeyDown || type == NSKeyUp || type == NSFlagsChanged))
4405     {
4406       [[NSApp modalWindow] sendEvent: theEvent];
4407       return;
4408     }
4409 #endif
4411   if (type == NSApplicationDefined)
4412     {
4413       switch ([theEvent data2])
4414         {
4415 #ifdef NS_IMPL_COCOA
4416         case NSAPP_DATA2_RUNASSCRIPT:
4417           ns_run_ascript ();
4418           [self stop: self];
4419           return;
4420 #endif
4421         case NSAPP_DATA2_RUNFILEDIALOG:
4422           ns_run_file_dialog ();
4423           [self stop: self];
4424           return;
4425         }
4426     }
4428   if (type == NSCursorUpdate && window == nil)
4429     {
4430       fprintf (stderr, "Dropping external cursor update event.\n");
4431       return;
4432     }
4434   if (type == NSApplicationDefined)
4435     {
4436       /* Events posted by ns_send_appdefined interrupt the run loop here.
4437          But, if a modal window is up, an appdefined can still come through,
4438          (e.g., from a makeKeyWindow event) but stopping self also stops the
4439          modal loop. Just defer it until later. */
4440       if ([NSApp modalWindow] == nil)
4441         {
4442           last_appdefined_event_data = [theEvent data1];
4443           [self stop: self];
4444         }
4445       else
4446         {
4447           send_appdefined = YES;
4448         }
4449     }
4452 #ifdef NS_IMPL_COCOA
4453   /* If no dialog and none of our frames have focus and it is a move, skip it.
4454      It is a mouse move in an auxiliary menu, i.e. on the top right on OSX,
4455      such as Wifi, sound, date or similar.
4456      This prevents "spooky" highlighting in the frame under the menu.  */
4457   if (type == NSMouseMoved && [NSApp modalWindow] == nil)
4458     {
4459       struct ns_display_info *di;
4460       BOOL has_focus = NO;
4461       for (di = x_display_list; ! has_focus && di; di = di->next)
4462         has_focus = di->x_focus_frame != 0;
4463       if (! has_focus)
4464         return;
4465     }
4466 #endif
4468   [super sendEvent: theEvent];
4472 - (void)showPreferencesWindow: (id)sender
4474   struct frame *emacsframe = SELECTED_FRAME ();
4475   NSEvent *theEvent = [NSApp currentEvent];
4477   if (!emacs_event)
4478     return;
4479   emacs_event->kind = NS_NONKEY_EVENT;
4480   emacs_event->code = KEY_NS_SHOW_PREFS;
4481   emacs_event->modifiers = 0;
4482   EV_TRAILER (theEvent);
4486 - (void)newFrame: (id)sender
4488   struct frame *emacsframe = SELECTED_FRAME ();
4489   NSEvent *theEvent = [NSApp currentEvent];
4491   if (!emacs_event)
4492     return;
4493   emacs_event->kind = NS_NONKEY_EVENT;
4494   emacs_event->code = KEY_NS_NEW_FRAME;
4495   emacs_event->modifiers = 0;
4496   EV_TRAILER (theEvent);
4500 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4501 - (BOOL) openFile: (NSString *)fileName
4503   struct frame *emacsframe = SELECTED_FRAME ();
4504   NSEvent *theEvent = [NSApp currentEvent];
4506   if (!emacs_event)
4507     return NO;
4509   emacs_event->kind = NS_NONKEY_EVENT;
4510   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4511   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4512   ns_input_line = Qnil; /* can be start or cons start,end */
4513   emacs_event->modifiers =0;
4514   EV_TRAILER (theEvent);
4516   return YES;
4520 /* **************************************************************************
4522       EmacsApp delegate implementation
4524    ************************************************************************** */
4526 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4527 /* --------------------------------------------------------------------------
4528      When application is loaded, terminate event loop in ns_term_init
4529    -------------------------------------------------------------------------- */
4531   NSTRACE (applicationDidFinishLaunching);
4532   [NSApp setServicesProvider: NSApp];
4533   ns_send_appdefined (-2);
4537 /* Termination sequences:
4538     C-x C-c:
4539     Cmd-Q:
4540     MenuBar | File | Exit:
4541     Select Quit from App menubar:
4542         -terminate
4543         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4544         ns_term_shutdown()
4546     Select Quit from Dock menu:
4547     Logout attempt:
4548         -appShouldTerminate
4549           Cancel -> Nothing else
4550           Accept ->
4552           -terminate
4553           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4554           ns_term_shutdown()
4558 - (void) terminate: (id)sender
4560   struct frame *emacsframe = SELECTED_FRAME ();
4562   if (!emacs_event)
4563     return;
4565   emacs_event->kind = NS_NONKEY_EVENT;
4566   emacs_event->code = KEY_NS_POWER_OFF;
4567   emacs_event->arg = Qt; /* mark as non-key event */
4568   EV_TRAILER ((id)nil);
4572 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4574   int ret;
4576   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4577     return NSTerminateNow;
4579     ret = NSRunAlertPanel(ns_app_name,
4580                           @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4581                           @"Save Buffers and Exit", @"Cancel", nil);
4583     if (ret == NSAlertDefaultReturn)
4584         return NSTerminateNow;
4585     else if (ret == NSAlertAlternateReturn)
4586         return NSTerminateCancel;
4587     return NSTerminateNow;  /* just in case */
4590 static int
4591 not_in_argv (NSString *arg)
4593   int k;
4594   const char *a = [arg UTF8String];
4595   for (k = 1; k < initial_argc; ++k)
4596     if (strcmp (a, initial_argv[k]) == 0) return 0;
4597   return 1;
4600 /*   Notification from the Workspace to open a file */
4601 - (BOOL)application: sender openFile: (NSString *)file
4603   if (ns_do_open_file || not_in_argv (file))
4604     [ns_pending_files addObject: file];
4605   return YES;
4609 /*   Open a file as a temporary file */
4610 - (BOOL)application: sender openTempFile: (NSString *)file
4612   if (ns_do_open_file || not_in_argv (file))
4613     [ns_pending_files addObject: file];
4614   return YES;
4618 /*   Notification from the Workspace to open a file noninteractively (?) */
4619 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4621   if (ns_do_open_file || not_in_argv (file))
4622     [ns_pending_files addObject: file];
4623   return YES;
4626 /*   Notification from the Workspace to open multiple files */
4627 - (void)application: sender openFiles: (NSArray *)fileList
4629   NSEnumerator *files = [fileList objectEnumerator];
4630   NSString *file;
4631   /* Don't open files from the command line unconditionally,
4632      Cocoa parses the command line wrong, --option value tries to open value
4633      if --option is the last option.  */
4634   while ((file = [files nextObject]) != nil)
4635     if (ns_do_open_file || not_in_argv (file))
4636       [ns_pending_files addObject: file];
4638   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4643 /* Handle dock menu requests.  */
4644 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4646   return dockMenu;
4650 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4651 - (void)applicationWillBecomeActive: (NSNotification *)notification
4653   //ns_app_active=YES;
4655 - (void)applicationDidBecomeActive: (NSNotification *)notification
4657   NSTRACE (applicationDidBecomeActive);
4659   //ns_app_active=YES;
4661   ns_update_auto_hide_menu_bar ();
4662   // No constraining takes place when the application is not active.
4663   ns_constrain_all_frames ();
4665 - (void)applicationDidResignActive: (NSNotification *)notification
4667   //ns_app_active=NO;
4668   ns_send_appdefined (-1);
4673 /* ==========================================================================
4675     EmacsApp aux handlers for managing event loop
4677    ========================================================================== */
4680 - (void)timeout_handler: (NSTimer *)timedEntry
4681 /* --------------------------------------------------------------------------
4682      The timeout specified to ns_select has passed.
4683    -------------------------------------------------------------------------- */
4685   /*NSTRACE (timeout_handler); */
4686   ns_send_appdefined (-2);
4689 #ifdef NS_IMPL_GNUSTEP
4690 - (void)sendFromMainThread:(id)unused
4692   ns_send_appdefined (nextappdefined);
4694 #endif
4696 - (void)fd_handler:(id)unused
4697 /* --------------------------------------------------------------------------
4698      Check data waiting on file descriptors and terminate if so
4699    -------------------------------------------------------------------------- */
4701   int result;
4702   int waiting = 1, nfds;
4703   char c;
4705   fd_set readfds, writefds, *wfds;
4706   struct timespec timeout, *tmo;
4707   NSAutoreleasePool *pool = nil;
4709   /* NSTRACE (fd_handler); */
4711   for (;;)
4712     {
4713       [pool release];
4714       pool = [[NSAutoreleasePool alloc] init];
4716       if (waiting)
4717         {
4718           fd_set fds;
4719           FD_ZERO (&fds);
4720           FD_SET (selfds[0], &fds);
4721           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
4722           if (result > 0 && read (selfds[0], &c, 1) == 1 && c == 'g')
4723             waiting = 0;
4724         }
4725       else
4726         {
4727           pthread_mutex_lock (&select_mutex);
4728           nfds = select_nfds;
4730           if (select_valid & SELECT_HAVE_READ)
4731             readfds = select_readfds;
4732           else
4733             FD_ZERO (&readfds);
4735           if (select_valid & SELECT_HAVE_WRITE)
4736             {
4737               writefds = select_writefds;
4738               wfds = &writefds;
4739             }
4740           else
4741             wfds = NULL;
4742           if (select_valid & SELECT_HAVE_TMO)
4743             {
4744               timeout = select_timeout;
4745               tmo = &timeout;
4746             }
4747           else
4748             tmo = NULL;
4750           pthread_mutex_unlock (&select_mutex);
4752           FD_SET (selfds[0], &readfds);
4753           if (selfds[0] >= nfds) nfds = selfds[0]+1;
4755           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
4757           if (result == 0)
4758             ns_send_appdefined (-2);
4759           else if (result > 0)
4760             {
4761               if (FD_ISSET (selfds[0], &readfds))
4762                 {
4763                   if (read (selfds[0], &c, 1) == 1 && c == 's')
4764                     waiting = 1;
4765                 }
4766               else
4767                 {
4768                   pthread_mutex_lock (&select_mutex);
4769                   if (select_valid & SELECT_HAVE_READ)
4770                     select_readfds = readfds;
4771                   if (select_valid & SELECT_HAVE_WRITE)
4772                     select_writefds = writefds;
4773                   if (select_valid & SELECT_HAVE_TMO)
4774                     select_timeout = timeout;
4775                   pthread_mutex_unlock (&select_mutex);
4777                   ns_send_appdefined (result);
4778                 }
4779             }
4780           waiting = 1;
4781         }
4782     }
4787 /* ==========================================================================
4789     Service provision
4791    ========================================================================== */
4793 /* called from system: queue for next pass through event loop */
4794 - (void)requestService: (NSPasteboard *)pboard
4795               userData: (NSString *)userData
4796                  error: (NSString **)error
4798   [ns_pending_service_names addObject: userData];
4799   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4800       SSDATA (ns_string_from_pasteboard (pboard))]];
4804 /* called from ns_read_socket to clear queue */
4805 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4807   struct frame *emacsframe = SELECTED_FRAME ();
4808   NSEvent *theEvent = [NSApp currentEvent];
4810   if (!emacs_event)
4811     return NO;
4813   emacs_event->kind = NS_NONKEY_EVENT;
4814   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
4815   ns_input_spi_name = build_string ([name UTF8String]);
4816   ns_input_spi_arg = build_string ([arg UTF8String]);
4817   emacs_event->modifiers = EV_MODIFIERS (theEvent);
4818   EV_TRAILER (theEvent);
4820   return YES;
4824 @end  /* EmacsApp */
4828 /* ==========================================================================
4830     EmacsView implementation
4832    ========================================================================== */
4835 @implementation EmacsView
4837 /* needed to inform when window closed from LISP */
4838 - (void) setWindowClosing: (BOOL)closing
4840   windowClosing = closing;
4844 - (void)dealloc
4846   NSTRACE (EmacsView_dealloc);
4847   [toolbar release];
4848   if (fs_state == FULLSCREEN_BOTH)
4849     [nonfs_window release];
4850   [super dealloc];
4854 /* called on font panel selection */
4855 - (void)changeFont: (id)sender
4857   NSEvent *e = [[self window] currentEvent];
4858   struct face *face = FRAME_DEFAULT_FACE (emacsframe);
4859   struct font *font = face->font;
4860   id newFont;
4861   CGFloat size;
4862   NSFont *nsfont;
4864   NSTRACE (changeFont);
4866   if (!emacs_event)
4867     return;
4869   if (EQ (font->driver->type, Qns))
4870     nsfont = ((struct nsfont_info *)font)->nsfont;
4871 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
4872   else
4873     nsfont = (NSFont *) macfont_get_nsctfont (font);
4874 #endif
4876   if ((newFont = [sender convertFont: nsfont]))
4877     {
4878       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
4880       emacs_event->kind = NS_NONKEY_EVENT;
4881       emacs_event->modifiers = 0;
4882       emacs_event->code = KEY_NS_CHANGE_FONT;
4884       size = [newFont pointSize];
4885       ns_input_fontsize = make_number (lrint (size));
4886       ns_input_font = build_string ([[newFont familyName] UTF8String]);
4887       EV_TRAILER (e);
4888     }
4892 - (BOOL)acceptsFirstResponder
4894   NSTRACE (acceptsFirstResponder);
4895   return YES;
4899 - (void)resetCursorRects
4901   NSRect visible = [self visibleRect];
4902   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
4903   NSTRACE (resetCursorRects);
4905   if (currentCursor == nil)
4906     currentCursor = [NSCursor arrowCursor];
4908   if (!NSIsEmptyRect (visible))
4909     [self addCursorRect: visible cursor: currentCursor];
4910   [currentCursor setOnMouseEntered: YES];
4915 /*****************************************************************************/
4916 /* Keyboard handling. */
4917 #define NS_KEYLOG 0
4919 - (void)keyDown: (NSEvent *)theEvent
4921   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
4922   int code;
4923   unsigned fnKeysym = 0;
4924   static NSMutableArray *nsEvArray;
4925 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
4926   static BOOL firstTime = YES;
4927 #endif
4928   int left_is_none;
4929   unsigned int flags = [theEvent modifierFlags];
4931   NSTRACE (keyDown);
4933   /* Rhapsody and OS X give up and down events for the arrow keys */
4934   if (ns_fake_keydown == YES)
4935     ns_fake_keydown = NO;
4936   else if ([theEvent type] != NSKeyDown)
4937     return;
4939   if (!emacs_event)
4940     return;
4942  if (![[self window] isKeyWindow]
4943      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
4944      /* we must avoid an infinite loop here. */
4945      && (EmacsView *)[[theEvent window] delegate] != self)
4946    {
4947      /* XXX: There is an occasional condition in which, when Emacs display
4948          updates a different frame from the current one, and temporarily
4949          selects it, then processes some interrupt-driven input
4950          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
4951          for some reason that window has its first responder set to the NSView
4952          most recently updated (I guess), which is not the correct one. */
4953      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
4954      return;
4955    }
4957   if (nsEvArray == nil)
4958     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
4960   [NSCursor setHiddenUntilMouseMoves: YES];
4962   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
4963     {
4964       clear_mouse_face (hlinfo);
4965       hlinfo->mouse_face_hidden = 1;
4966     }
4968   if (!processingCompose)
4969     {
4970       /* When using screen sharing, no left or right information is sent,
4971          so use Left key in those cases.  */
4972       int is_left_key, is_right_key;
4974       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
4975         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
4977       /* (Carbon way: [theEvent keyCode]) */
4979       /* is it a "function key"? */
4980       fnKeysym = (code < 0x00ff && (flags&NSNumericPadKeyMask))
4981         ? ns_convert_key ([theEvent keyCode] | NSNumericPadKeyMask)
4982         : ns_convert_key (code);
4984       if (fnKeysym)
4985         {
4986           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
4987              because Emacs treats Delete and KP-Delete same (in simple.el). */
4988           if ((fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
4989 #ifdef NS_IMPL_GNUSTEP
4990               /*  GNUstep uses incompatible keycodes, even for those that are
4991                   supposed to be hardware independent.  Just check for delete.
4992                   Keypad delete does not have keysym 0xFFFF.
4993                   See http://savannah.gnu.org/bugs/?25395
4994               */
4995               || (fnKeysym == 0xFFFF && code == 127)
4996 #endif
4997             )
4998             code = 0xFF08; /* backspace */
4999           else
5000             code = fnKeysym;
5001         }
5003       /* are there modifiers? */
5004       emacs_event->modifiers = 0;
5006       if (flags & NSHelpKeyMask)
5007           emacs_event->modifiers |= hyper_modifier;
5009       if (flags & NSShiftKeyMask)
5010         emacs_event->modifiers |= shift_modifier;
5012       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
5013       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
5014         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
5016       if (is_right_key)
5017         emacs_event->modifiers |= parse_solitary_modifier
5018           (EQ (ns_right_command_modifier, Qleft)
5019            ? ns_command_modifier
5020            : ns_right_command_modifier);
5022       if (is_left_key)
5023         {
5024           emacs_event->modifiers |= parse_solitary_modifier
5025             (ns_command_modifier);
5027           /* if super (default), take input manager's word so things like
5028              dvorak / qwerty layout work */
5029           if (EQ (ns_command_modifier, Qsuper)
5030               && !fnKeysym
5031               && [[theEvent characters] length] != 0)
5032             {
5033               /* XXX: the code we get will be unshifted, so if we have
5034                  a shift modifier, must convert ourselves */
5035               if (!(flags & NSShiftKeyMask))
5036                 code = [[theEvent characters] characterAtIndex: 0];
5037 #if 0
5038               /* this is ugly and also requires linking w/Carbon framework
5039                  (for LMGetKbdType) so for now leave this rare (?) case
5040                  undealt with.. in future look into CGEvent methods */
5041               else
5042                 {
5043                   long smv = GetScriptManagerVariable (smKeyScript);
5044                   Handle uchrHandle = GetResource
5045                     ('uchr', GetScriptVariable (smv, smScriptKeys));
5046                   UInt32 dummy = 0;
5047                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
5048                                  [[theEvent characters] characterAtIndex: 0],
5049                                  kUCKeyActionDisplay,
5050                                  (flags & ~NSCommandKeyMask) >> 8,
5051                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
5052                                  &dummy, 1, &dummy, &code);
5053                   code &= 0xFF;
5054                 }
5055 #endif
5056             }
5057         }
5059       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
5060       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
5061         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
5063       if (is_right_key)
5064           emacs_event->modifiers |= parse_solitary_modifier
5065               (EQ (ns_right_control_modifier, Qleft)
5066                ? ns_control_modifier
5067                : ns_right_control_modifier);
5069       if (is_left_key)
5070         emacs_event->modifiers |= parse_solitary_modifier
5071           (ns_control_modifier);
5073       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
5074           emacs_event->modifiers |=
5075             parse_solitary_modifier (ns_function_modifier);
5077       left_is_none = NILP (ns_alternate_modifier)
5078         || EQ (ns_alternate_modifier, Qnone);
5080       is_right_key = (flags & NSRightAlternateKeyMask)
5081         == NSRightAlternateKeyMask;
5082       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
5083         || (! is_right_key
5084             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
5086       if (is_right_key)
5087         {
5088           if ((NILP (ns_right_alternate_modifier)
5089                || EQ (ns_right_alternate_modifier, Qnone)
5090                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
5091               && !fnKeysym)
5092             {   /* accept pre-interp alt comb */
5093               if ([[theEvent characters] length] > 0)
5094                 code = [[theEvent characters] characterAtIndex: 0];
5095               /*HACK: clear lone shift modifier to stop next if from firing */
5096               if (emacs_event->modifiers == shift_modifier)
5097                 emacs_event->modifiers = 0;
5098             }
5099           else
5100             emacs_event->modifiers |= parse_solitary_modifier
5101               (EQ (ns_right_alternate_modifier, Qleft)
5102                ? ns_alternate_modifier
5103                : ns_right_alternate_modifier);
5104         }
5106       if (is_left_key) /* default = meta */
5107         {
5108           if (left_is_none && !fnKeysym)
5109             {   /* accept pre-interp alt comb */
5110               if ([[theEvent characters] length] > 0)
5111                 code = [[theEvent characters] characterAtIndex: 0];
5112               /*HACK: clear lone shift modifier to stop next if from firing */
5113               if (emacs_event->modifiers == shift_modifier)
5114                 emacs_event->modifiers = 0;
5115             }
5116           else
5117               emacs_event->modifiers |=
5118                 parse_solitary_modifier (ns_alternate_modifier);
5119         }
5121   if (NS_KEYLOG)
5122     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
5123              code, fnKeysym, flags, emacs_event->modifiers);
5125       /* if it was a function key or had modifiers, pass it directly to emacs */
5126       if (fnKeysym || (emacs_event->modifiers
5127                        && (emacs_event->modifiers != shift_modifier)
5128                        && [[theEvent charactersIgnoringModifiers] length] > 0))
5129 /*[[theEvent characters] length] */
5130         {
5131           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5132           if (code < 0x20)
5133             code |= (1<<28)|(3<<16);
5134           else if (code == 0x7f)
5135             code |= (1<<28)|(3<<16);
5136           else if (!fnKeysym)
5137             emacs_event->kind = code > 0xFF
5138               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5140           emacs_event->code = code;
5141           EV_TRAILER (theEvent);
5142           processingCompose = NO;
5143           return;
5144         }
5145     }
5148 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5149   /* if we get here we should send the key for input manager processing */
5150   /* Disable warning, there is nothing a user can do about it anyway, and
5151      it does not seem to matter.  */
5152 #if 0
5153   if (firstTime && [[NSInputManager currentInputManager]
5154                      wantsToDelayTextChangeNotifications] == NO)
5155     fprintf (stderr,
5156           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
5157 #endif
5158   firstTime = NO;
5159 #endif
5160   if (NS_KEYLOG && !processingCompose)
5161     fprintf (stderr, "keyDown: Begin compose sequence.\n");
5163   processingCompose = YES;
5164   [nsEvArray addObject: theEvent];
5165   [self interpretKeyEvents: nsEvArray];
5166   [nsEvArray removeObject: theEvent];
5170 #ifdef NS_IMPL_COCOA
5171 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
5172    decided not to send key-down for.
5173    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
5174    This only applies on Tiger and earlier.
5175    If it matches one of these, send it on to keyDown. */
5176 -(void)keyUp: (NSEvent *)theEvent
5178   int flags = [theEvent modifierFlags];
5179   int code = [theEvent keyCode];
5180   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5181       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5182     {
5183       if (NS_KEYLOG)
5184         fprintf (stderr, "keyUp: passed test");
5185       ns_fake_keydown = YES;
5186       [self keyDown: theEvent];
5187     }
5189 #endif
5192 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5195 /* <NSTextInput>: called when done composing;
5196    NOTE: also called when we delete over working text, followed immed.
5197          by doCommandBySelector: deleteBackward: */
5198 - (void)insertText: (id)aString
5200   int code;
5201   int len = [(NSString *)aString length];
5202   int i;
5204   if (NS_KEYLOG)
5205     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5206   processingCompose = NO;
5208   if (!emacs_event)
5209     return;
5211   /* first, clear any working text */
5212   if (workingText != nil)
5213     [self deleteWorkingText];
5215   /* now insert the string as keystrokes */
5216   for (i =0; i<len; i++)
5217     {
5218       code = [aString characterAtIndex: i];
5219       /* TODO: still need this? */
5220       if (code == 0x2DC)
5221         code = '~'; /* 0x7E */
5222       if (code != 32) /* Space */
5223         emacs_event->modifiers = 0;
5224       emacs_event->kind
5225         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5226       emacs_event->code = code;
5227       EV_TRAILER ((id)nil);
5228     }
5232 /* <NSTextInput>: inserts display of composing characters */
5233 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5235   NSString *str = [aString respondsToSelector: @selector (string)] ?
5236     [aString string] : aString;
5237   if (NS_KEYLOG)
5238     NSLog (@"setMarkedText '%@' len =%lu range %lu from %lu",
5239            str, (unsigned long)[str length],
5240            (unsigned long)selRange.length,
5241            (unsigned long)selRange.location);
5243   if (workingText != nil)
5244     [self deleteWorkingText];
5245   if ([str length] == 0)
5246     return;
5248   if (!emacs_event)
5249     return;
5251   processingCompose = YES;
5252   workingText = [str copy];
5253   ns_working_text = build_string ([workingText UTF8String]);
5255   emacs_event->kind = NS_TEXT_EVENT;
5256   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5257   EV_TRAILER ((id)nil);
5261 /* delete display of composing characters [not in <NSTextInput>] */
5262 - (void)deleteWorkingText
5264   if (workingText == nil)
5265     return;
5266   if (NS_KEYLOG)
5267     NSLog(@"deleteWorkingText len =%lu\n", (unsigned long)[workingText length]);
5268   [workingText release];
5269   workingText = nil;
5270   processingCompose = NO;
5272   if (!emacs_event)
5273     return;
5275   emacs_event->kind = NS_TEXT_EVENT;
5276   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5277   EV_TRAILER ((id)nil);
5281 - (BOOL)hasMarkedText
5283   return workingText != nil;
5287 - (NSRange)markedRange
5289   NSRange rng = workingText != nil
5290     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5291   if (NS_KEYLOG)
5292     NSLog (@"markedRange request");
5293   return rng;
5297 - (void)unmarkText
5299   if (NS_KEYLOG)
5300     NSLog (@"unmark (accept) text");
5301   [self deleteWorkingText];
5302   processingCompose = NO;
5306 /* used to position char selection windows, etc. */
5307 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5309   NSRect rect;
5310   NSPoint pt;
5311   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5312   if (NS_KEYLOG)
5313     NSLog (@"firstRectForCharRange request");
5315   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5316   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5317   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5318   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5319                                        +FRAME_LINE_HEIGHT (emacsframe));
5321   pt = [self convertPoint: pt toView: nil];
5322   pt = [[self window] convertBaseToScreen: pt];
5323   rect.origin = pt;
5324   return rect;
5328 - (NSInteger)conversationIdentifier
5330   return (NSInteger)self;
5334 - (void)doCommandBySelector: (SEL)aSelector
5336   if (NS_KEYLOG)
5337     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5339   processingCompose = NO;
5340   if (aSelector == @selector (deleteBackward:))
5341     {
5342       /* happens when user backspaces over an ongoing composition:
5343          throw a 'delete' into the event queue */
5344       if (!emacs_event)
5345         return;
5346       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5347       emacs_event->code = 0xFF08;
5348       EV_TRAILER ((id)nil);
5349     }
5352 - (NSArray *)validAttributesForMarkedText
5354   static NSArray *arr = nil;
5355   if (arr == nil) arr = [NSArray new];
5356  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5357   return arr;
5360 - (NSRange)selectedRange
5362   if (NS_KEYLOG)
5363     NSLog (@"selectedRange request");
5364   return NSMakeRange (NSNotFound, 0);
5367 #if defined (NS_IMPL_COCOA) || GNUSTEP_GUI_MAJOR_VERSION > 0 || \
5368     GNUSTEP_GUI_MINOR_VERSION > 22
5369 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5370 #else
5371 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
5372 #endif
5374   if (NS_KEYLOG)
5375     NSLog (@"characterIndexForPoint request");
5376   return 0;
5379 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5381   static NSAttributedString *str = nil;
5382   if (str == nil) str = [NSAttributedString new];
5383   if (NS_KEYLOG)
5384     NSLog (@"attributedSubstringFromRange request");
5385   return str;
5388 /* End <NSTextInput> impl. */
5389 /*****************************************************************************/
5392 /* This is what happens when the user presses a mouse button.  */
5393 - (void)mouseDown: (NSEvent *)theEvent
5395   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5396   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5398   NSTRACE (mouseDown);
5400   [self deleteWorkingText];
5402   if (!emacs_event)
5403     return;
5405   dpyinfo->last_mouse_frame = emacsframe;
5406   /* appears to be needed to prevent spurious movement events generated on
5407      button clicks */
5408   emacsframe->mouse_moved = 0;
5410   if ([theEvent type] == NSScrollWheel)
5411     {
5412       CGFloat delta = [theEvent deltaY];
5413       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5414       if (delta == 0)
5415         return;
5416       emacs_event->kind = WHEEL_EVENT;
5417       emacs_event->code = 0;
5418       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5419         ((delta > 0) ? up_modifier : down_modifier);
5420     }
5421   else
5422     {
5423       emacs_event->kind = MOUSE_CLICK_EVENT;
5424       emacs_event->code = EV_BUTTON (theEvent);
5425       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5426                              | EV_UDMODIFIERS (theEvent);
5427     }
5428   XSETINT (emacs_event->x, lrint (p.x));
5429   XSETINT (emacs_event->y, lrint (p.y));
5430   EV_TRAILER (theEvent);
5434 - (void)rightMouseDown: (NSEvent *)theEvent
5436   NSTRACE (rightMouseDown);
5437   [self mouseDown: theEvent];
5441 - (void)otherMouseDown: (NSEvent *)theEvent
5443   NSTRACE (otherMouseDown);
5444   [self mouseDown: theEvent];
5448 - (void)mouseUp: (NSEvent *)theEvent
5450   NSTRACE (mouseUp);
5451   [self mouseDown: theEvent];
5455 - (void)rightMouseUp: (NSEvent *)theEvent
5457   NSTRACE (rightMouseUp);
5458   [self mouseDown: theEvent];
5462 - (void)otherMouseUp: (NSEvent *)theEvent
5464   NSTRACE (otherMouseUp);
5465   [self mouseDown: theEvent];
5469 - (void) scrollWheel: (NSEvent *)theEvent
5471   NSTRACE (scrollWheel);
5472   [self mouseDown: theEvent];
5476 /* Tell emacs the mouse has moved. */
5477 - (void)mouseMoved: (NSEvent *)e
5479   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5480   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5481   Lisp_Object frame;
5482   NSPoint pt;
5484 //  NSTRACE (mouseMoved);
5486   dpyinfo->last_mouse_movement_time = EV_TIMESTAMP (e);
5487   pt = [self convertPoint: [e locationInWindow] fromView: nil];
5488   dpyinfo->last_mouse_motion_x = pt.x;
5489   dpyinfo->last_mouse_motion_y = pt.y;
5491   /* update any mouse face */
5492   if (hlinfo->mouse_face_hidden)
5493     {
5494       hlinfo->mouse_face_hidden = 0;
5495       clear_mouse_face (hlinfo);
5496     }
5498   /* tooltip handling */
5499   previous_help_echo_string = help_echo_string;
5500   help_echo_string = Qnil;
5502   if (!NILP (Vmouse_autoselect_window))
5503     {
5504       NSTRACE (mouse_autoselect_window);
5505       static Lisp_Object last_mouse_window;
5506       Lisp_Object window
5507         = window_from_coordinates (emacsframe, pt.x, pt.y, 0, 0);
5509       if (WINDOWP (window)
5510           && !EQ (window, last_mouse_window)
5511           && !EQ (window, selected_window)
5512           && (focus_follows_mouse
5513               || (EQ (XWINDOW (window)->frame,
5514                       XWINDOW (selected_window)->frame))))
5515         {
5516           NSTRACE (in_window);
5517           emacs_event->kind = SELECT_WINDOW_EVENT;
5518           emacs_event->frame_or_window = window;
5519           EV_TRAILER2 (e);
5520         }
5521       /* Remember the last window where we saw the mouse.  */
5522       last_mouse_window = window;
5523     }
5525   if (!note_mouse_movement (emacsframe, pt.x, pt.y))
5526     help_echo_string = previous_help_echo_string;
5528   XSETFRAME (frame, emacsframe);
5529   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5530     {
5531       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5532          (note_mouse_highlight), which is called through the
5533          note_mouse_movement () call above */
5534       gen_help_event (help_echo_string, frame, help_echo_window,
5535                       help_echo_object, help_echo_pos);
5536     }
5537   else
5538     {
5539       help_echo_string = Qnil;
5540       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
5541     }
5543   if (emacsframe->mouse_moved && send_appdefined)
5544     ns_send_appdefined (-1);
5548 - (void)mouseDragged: (NSEvent *)e
5550   NSTRACE (mouseDragged);
5551   [self mouseMoved: e];
5555 - (void)rightMouseDragged: (NSEvent *)e
5557   NSTRACE (rightMouseDragged);
5558   [self mouseMoved: e];
5562 - (void)otherMouseDragged: (NSEvent *)e
5564   NSTRACE (otherMouseDragged);
5565   [self mouseMoved: e];
5569 - (BOOL)windowShouldClose: (id)sender
5571   NSEvent *e =[[self window] currentEvent];
5573   NSTRACE (windowShouldClose);
5574   windowClosing = YES;
5575   if (!emacs_event)
5576     return NO;
5577   emacs_event->kind = DELETE_WINDOW_EVENT;
5578   emacs_event->modifiers = 0;
5579   emacs_event->code = 0;
5580   EV_TRAILER (e);
5581   /* Don't close this window, let this be done from lisp code.  */
5582   return NO;
5585 - (void) updateFrameSize: (BOOL) delay;
5587   NSWindow *window = [self window];
5588   NSRect wr = [window frame];
5589   int extra = 0;
5590   int gsextra = 0;
5591 #ifdef NS_IMPL_GNUSTEP
5592   gsextra = 3;
5593 #endif
5595   int oldc = cols, oldr = rows;
5596   int oldw = FRAME_PIXEL_WIDTH (emacsframe),
5597     oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5598   int neww, newh;
5600   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, wr.size.width + gsextra);
5602   if (cols < MINWIDTH)
5603     cols = MINWIDTH;
5605   if (! [self isFullscreen])
5606     {
5607       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5608         + FRAME_TOOLBAR_HEIGHT (emacsframe) - gsextra;
5609     }
5611   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, wr.size.height - extra);
5613   if (rows < MINHEIGHT)
5614     rows = MINHEIGHT;
5616   neww = (int)wr.size.width - emacsframe->border_width;
5617   newh = (int)wr.size.height - extra;
5619   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5620     {
5621       NSView *view = FRAME_NS_VIEW (emacsframe);
5622       NSWindow *win = [view window];
5623       NSSize sz = [win resizeIncrements];
5625       FRAME_PIXEL_WIDTH (emacsframe) = neww;
5626       FRAME_PIXEL_HEIGHT (emacsframe) = newh;
5627       change_frame_size (emacsframe, rows, cols, 0, delay, 0);
5628       SET_FRAME_GARBAGED (emacsframe);
5629       cancel_mouse_face (emacsframe);
5631       // Did resize increments change because of a font change?
5632       if (sz.width != FRAME_COLUMN_WIDTH (emacsframe) ||
5633           sz.height != FRAME_LINE_HEIGHT (emacsframe))
5634         {
5635           sz.width = FRAME_COLUMN_WIDTH (emacsframe);
5636           sz.height = FRAME_LINE_HEIGHT (emacsframe);
5637           [win setResizeIncrements: sz];
5638         }
5640       [view setFrame: NSMakeRect (0, 0, neww, newh)];
5641       [self windowDidMove:nil];   // Update top/left.
5642     }
5645 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
5646 /* normalize frame to gridded text size */
5648   int extra = 0;
5649   int gsextra = 0;
5650 #ifdef NS_IMPL_GNUSTEP
5651   gsextra = 3;
5652 #endif
5654   NSTRACE (windowWillResize);
5655 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5657   if (fs_state == FULLSCREEN_MAXIMIZED
5658       && (maximized_width != (int)frameSize.width
5659           || maximized_height != (int)frameSize.height))
5660     [self setFSValue: FULLSCREEN_NONE];
5661   else if (fs_state == FULLSCREEN_WIDTH
5662            && maximized_width != (int)frameSize.width)
5663     [self setFSValue: FULLSCREEN_NONE];
5664   else if (fs_state == FULLSCREEN_HEIGHT
5665            && maximized_height != (int)frameSize.height)
5666     [self setFSValue: FULLSCREEN_NONE];
5667   if (fs_state == FULLSCREEN_NONE)
5668     maximized_width = maximized_height = -1;
5670   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe,
5671                                          frameSize.width + gsextra);
5672   if (cols < MINWIDTH)
5673     cols = MINWIDTH;
5675   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe,
5676                                            frameSize.height - extra);
5677   if (rows < MINHEIGHT)
5678     rows = MINHEIGHT;
5679 #ifdef NS_IMPL_COCOA
5680   {
5681     /* this sets window title to have size in it; the wm does this under GS */
5682     NSRect r = [[self window] frame];
5683     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5684       {
5685         if (old_title != 0)
5686           {
5687             xfree (old_title);
5688             old_title = 0;
5689           }
5690       }
5691     else if (fs_state == FULLSCREEN_NONE && ! maximizing_resize)
5692       {
5693         char *size_title;
5694         NSWindow *window = [self window];
5695         if (old_title == 0)
5696           {
5697             char *t = strdup ([[[self window] title] UTF8String]);
5698             char *pos = strstr (t, "  â€”  ");
5699             if (pos)
5700               *pos = '\0';
5701             old_title = t;
5702           }
5703         size_title = xmalloc (strlen (old_title) + 40);
5704         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5705         [window setTitle: [NSString stringWithUTF8String: size_title]];
5706         [window display];
5707         xfree (size_title);
5708       }
5709   }
5710 #endif /* NS_IMPL_COCOA */
5711 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5713   return frameSize;
5717 - (void)windowDidResize: (NSNotification *)notification
5719   if (! [self fsIsNative])
5720     {
5721       NSWindow *theWindow = [notification object];
5722       /* We can get notification on the non-FS window when in
5723          fullscreen mode.  */
5724       if ([self window] != theWindow) return;
5725     }
5727 #ifdef NS_IMPL_GNUSTEP
5728   NSWindow *theWindow = [notification object];
5730    /* In GNUstep, at least currently, it's possible to get a didResize
5731       without getting a willResize.. therefore we need to act as if we got
5732       the willResize now */
5733   NSSize sz = [theWindow frame].size;
5734   sz = [self windowWillResize: theWindow toSize: sz];
5735 #endif /* NS_IMPL_GNUSTEP */
5737   NSTRACE (windowDidResize);
5738 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5740 if (cols > 0 && rows > 0)
5741     {
5742       [self updateFrameSize: YES];
5743     }
5745   ns_send_appdefined (-1);
5748 #ifdef NS_IMPL_COCOA
5749 - (void)viewDidEndLiveResize
5751   [super viewDidEndLiveResize];
5752   if (old_title != 0)
5753     {
5754       [[self window] setTitle: [NSString stringWithUTF8String: old_title]];
5755       xfree (old_title);
5756       old_title = 0;
5757     }
5758   maximizing_resize = NO;
5760 #endif /* NS_IMPL_COCOA */
5763 - (void)windowDidBecomeKey: (NSNotification *)notification
5764 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5766   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5767   struct frame *old_focus = dpyinfo->x_focus_frame;
5769   NSTRACE (windowDidBecomeKey);
5771   if (emacsframe != old_focus)
5772     dpyinfo->x_focus_frame = emacsframe;
5774   ns_frame_rehighlight (emacsframe);
5776   if (emacs_event)
5777     {
5778       emacs_event->kind = FOCUS_IN_EVENT;
5779       EV_TRAILER ((id)nil);
5780     }
5784 - (void)windowDidResignKey: (NSNotification *)notification
5785 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5787   struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (emacsframe);
5788   BOOL is_focus_frame = dpyinfo->x_focus_frame == emacsframe;
5789   NSTRACE (windowDidResignKey);
5791   if (is_focus_frame)
5792     dpyinfo->x_focus_frame = 0;
5794   ns_frame_rehighlight (emacsframe);
5796   /* FIXME: for some reason needed on second and subsequent clicks away
5797             from sole-frame Emacs to get hollow box to show */
5798   if (!windowClosing && [[self window] isVisible] == YES)
5799     {
5800       x_update_cursor (emacsframe, 1);
5801       x_set_frame_alpha (emacsframe);
5802     }
5804   if (emacs_event && is_focus_frame)
5805     {
5806       [self deleteWorkingText];
5807       emacs_event->kind = FOCUS_OUT_EVENT;
5808       EV_TRAILER ((id)nil);
5809     }
5813 - (void)windowWillMiniaturize: sender
5815   NSTRACE (windowWillMiniaturize);
5819 - (BOOL)isFlipped
5821   return YES;
5825 - (BOOL)isOpaque
5827   return NO;
5831 - initFrameFromEmacs: (struct frame *)f
5833   NSRect r, wr;
5834   Lisp_Object tem;
5835   NSWindow *win;
5836   NSSize sz;
5837   NSColor *col;
5838   NSString *name;
5840   NSTRACE (initFrameFromEmacs);
5842   windowClosing = NO;
5843   processingCompose = NO;
5844   scrollbarsNeedingUpdate = 0;
5845   fs_state = FULLSCREEN_NONE;
5846   fs_before_fs = next_maximized = -1;
5847 #ifdef HAVE_NATIVE_FS
5848   fs_is_native = ns_use_native_fullscreen;
5849 #else
5850   fs_is_native = NO;
5851 #endif
5852   maximized_width = maximized_height = -1;
5853   nonfs_window = nil;
5855 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
5857   ns_userRect = NSMakeRect (0, 0, 0, 0);
5858   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
5859                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
5860   [self initWithFrame: r];
5861   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
5863   FRAME_NS_VIEW (f) = self;
5864   emacsframe = f;
5865 #ifdef NS_IMPL_COCOA
5866   old_title = 0;
5867   maximizing_resize = NO;
5868 #endif
5870   win = [[EmacsWindow alloc]
5871             initWithContentRect: r
5872                       styleMask: (NSResizableWindowMask |
5873 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
5874                                   NSTitledWindowMask |
5875 #endif
5876                                   NSMiniaturizableWindowMask |
5877                                   NSClosableWindowMask)
5878                         backing: NSBackingStoreBuffered
5879                           defer: YES];
5881 #ifdef HAVE_NATIVE_FS
5882     [win setCollectionBehavior:NSWindowCollectionBehaviorFullScreenPrimary];
5883 #endif
5885   wr = [win frame];
5886   bwidth = f->border_width = wr.size.width - r.size.width;
5887   tibar_height = FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
5889   [win setAcceptsMouseMovedEvents: YES];
5890   [win setDelegate: self];
5891   [win useOptimizedDrawing: YES];
5893   sz.width = FRAME_COLUMN_WIDTH (f);
5894   sz.height = FRAME_LINE_HEIGHT (f);
5895   [win setResizeIncrements: sz];
5897   [[win contentView] addSubview: self];
5899   if (ns_drag_types)
5900     [self registerForDraggedTypes: ns_drag_types];
5902   tem = f->name;
5903   name = [NSString stringWithUTF8String:
5904                    NILP (tem) ? "Emacs" : SSDATA (tem)];
5905   [win setTitle: name];
5907   /* toolbar support */
5908   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
5909                          [NSString stringWithFormat: @"Emacs Frame %d",
5910                                    ns_window_num]];
5911   [win setToolbar: toolbar];
5912   [toolbar setVisible: NO];
5913 #ifdef NS_IMPL_COCOA
5914   {
5915     NSButton *toggleButton;
5916   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
5917   [toggleButton setTarget: self];
5918   [toggleButton setAction: @selector (toggleToolbar: )];
5919   }
5920 #endif
5921   FRAME_TOOLBAR_HEIGHT (f) = 0;
5923   tem = f->icon_name;
5924   if (!NILP (tem))
5925     [win setMiniwindowTitle:
5926            [NSString stringWithUTF8String: SSDATA (tem)]];
5928   {
5929     NSScreen *screen = [win screen];
5931     if (screen != 0)
5932       [win setFrameTopLeftPoint: NSMakePoint
5933            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
5934             IN_BOUND (-SCREENMAX,
5935                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
5936   }
5938   [win makeFirstResponder: self];
5940   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
5941                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
5942   [win setBackgroundColor: col];
5943   if ([col alphaComponent] != (EmacsCGFloat) 1.0)
5944     [win setOpaque: NO];
5946   [self allocateGState];
5948   [NSApp registerServicesMenuSendTypes: ns_send_types
5949                            returnTypes: nil];
5951   ns_window_num++;
5952   return self;
5956 - (void)windowDidMove: sender
5958   NSWindow *win = [self window];
5959   NSRect r = [win frame];
5960   NSArray *screens = [NSScreen screens];
5961   NSScreen *screen = [screens objectAtIndex: 0];
5963   NSTRACE (windowDidMove);
5965   if (!emacsframe->output_data.ns)
5966     return;
5967   if (screen != nil)
5968     {
5969       emacsframe->left_pos = r.origin.x;
5970       emacsframe->top_pos =
5971         [screen frame].size.height - (r.origin.y + r.size.height);
5972     }
5976 /* Called AFTER method below, but before our windowWillResize call there leads
5977    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
5978    location so set_window_size moves the frame. */
5979 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
5981   emacsframe->output_data.ns->zooming = 1;
5982   return YES;
5986 /* Override to do something slightly nonstandard, but nice.  First click on
5987    zoom button will zoom vertically.  Second will zoom completely.  Third
5988    returns to original. */
5989 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
5990                         defaultFrame:(NSRect)defaultFrame
5992   NSRect result = [sender frame];
5994   NSTRACE (windowWillUseStandardFrame);
5996   if (fs_before_fs != -1) /* Entering fullscreen */
5997       {
5998         result = defaultFrame;
5999       }
6000   else if (next_maximized == FULLSCREEN_HEIGHT
6001       || (next_maximized == -1
6002           && abs (defaultFrame.size.height - result.size.height)
6003           > FRAME_LINE_HEIGHT (emacsframe)))
6004     {
6005       /* first click */
6006       ns_userRect = result;
6007       maximized_height = result.size.height = defaultFrame.size.height;
6008       maximized_width = -1;
6009       result.origin.y = defaultFrame.origin.y;
6010       [self setFSValue: FULLSCREEN_HEIGHT];
6011 #ifdef NS_IMPL_COCOA
6012       maximizing_resize = YES;
6013 #endif
6014     }
6015   else if (next_maximized == FULLSCREEN_WIDTH)
6016     {
6017       ns_userRect = result;
6018       maximized_width = result.size.width = defaultFrame.size.width;
6019       maximized_height = -1;
6020       result.origin.x = defaultFrame.origin.x;
6021       [self setFSValue: FULLSCREEN_WIDTH];
6022     }
6023   else if (next_maximized == FULLSCREEN_MAXIMIZED
6024            || (next_maximized == -1
6025                && abs (defaultFrame.size.width - result.size.width)
6026                > FRAME_COLUMN_WIDTH (emacsframe)))
6027     {
6028       result = defaultFrame;  /* second click */
6029       maximized_width = result.size.width;
6030       maximized_height = result.size.height;
6031       [self setFSValue: FULLSCREEN_MAXIMIZED];
6032 #ifdef NS_IMPL_COCOA
6033       maximizing_resize = YES;
6034 #endif
6035     }
6036   else
6037     {
6038       /* restore */
6039       result = ns_userRect.size.height ? ns_userRect : result;
6040       ns_userRect = NSMakeRect (0, 0, 0, 0);
6041 #ifdef NS_IMPL_COCOA
6042       maximizing_resize = fs_state != FULLSCREEN_NONE;
6043 #endif
6044       [self setFSValue: FULLSCREEN_NONE];
6045       maximized_width = maximized_height = -1;
6046     }
6048   if (fs_before_fs == -1) next_maximized = -1;
6049   [self windowWillResize: sender toSize: result.size];
6050   return result;
6054 - (void)windowDidDeminiaturize: sender
6056   NSTRACE (windowDidDeminiaturize);
6057   if (!emacsframe->output_data.ns)
6058     return;
6060   SET_FRAME_ICONIFIED (emacsframe, 0);
6061   SET_FRAME_VISIBLE (emacsframe, 1);
6062   windows_or_buffers_changed++;
6064   if (emacs_event)
6065     {
6066       emacs_event->kind = DEICONIFY_EVENT;
6067       EV_TRAILER ((id)nil);
6068     }
6072 - (void)windowDidExpose: sender
6074   NSTRACE (windowDidExpose);
6075   if (!emacsframe->output_data.ns)
6076     return;
6078   SET_FRAME_VISIBLE (emacsframe, 1);
6079   SET_FRAME_GARBAGED (emacsframe);
6081   if (send_appdefined)
6082     ns_send_appdefined (-1);
6086 - (void)windowDidMiniaturize: sender
6088   NSTRACE (windowDidMiniaturize);
6089   if (!emacsframe->output_data.ns)
6090     return;
6092   SET_FRAME_ICONIFIED (emacsframe, 1);
6093   SET_FRAME_VISIBLE (emacsframe, 0);
6095   if (emacs_event)
6096     {
6097       emacs_event->kind = ICONIFY_EVENT;
6098       EV_TRAILER ((id)nil);
6099     }
6102 #ifdef HAVE_NATIVE_FS
6103 - (NSApplicationPresentationOptions)window:(NSWindow *)window
6104       willUseFullScreenPresentationOptions:
6105   (NSApplicationPresentationOptions)proposedOptions
6107   return proposedOptions|NSApplicationPresentationAutoHideToolbar;
6109 #endif
6111 - (void)windowWillEnterFullScreen:(NSNotification *)notification
6113   fs_before_fs = fs_state;
6116 - (void)windowDidEnterFullScreen:(NSNotification *)notification
6118   [self setFSValue: FULLSCREEN_BOTH];
6119   if (! [self fsIsNative])
6120     {
6121       [self windowDidBecomeKey:notification];
6122       [nonfs_window orderOut:self];
6123     }
6124   else
6125     {
6126       BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (emacsframe) ? YES : NO;
6127 #ifdef NS_IMPL_COCOA
6128 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
6129       unsigned val = (unsigned)[NSApp presentationOptions];
6131       // OSX 10.7 bug fix, the menu won't appear without this.
6132       // val is non-zero on other OSX versions.
6133       if (val == 0)
6134         {
6135           NSApplicationPresentationOptions options
6136             = NSApplicationPresentationAutoHideDock
6137             | NSApplicationPresentationAutoHideMenuBar
6138             | NSApplicationPresentationFullScreen
6139             | NSApplicationPresentationAutoHideToolbar;
6141           [NSApp setPresentationOptions: options];
6142         }
6143 #endif
6144 #endif
6145       [toolbar setVisible:tbar_visible];
6146     }
6149 - (void)windowWillExitFullScreen:(NSNotification *)notification
6151   if (next_maximized != -1)
6152     fs_before_fs = next_maximized;
6155 - (void)windowDidExitFullScreen:(NSNotification *)notification
6157   [self setFSValue: fs_before_fs];
6158   fs_before_fs = -1;
6159 #ifdef HAVE_NATIVE_FS
6160   [self updateCollectionBehaviour];
6161 #endif
6162   if (FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6163     {
6164       [toolbar setVisible:YES];
6165       update_frame_tool_bar (emacsframe);
6166       [self updateFrameSize:YES];
6167       [[self window] display];
6168     }
6169   else
6170     [toolbar setVisible:NO];
6172   if (next_maximized != -1)
6173     [[self window] performZoom:self];
6176 - (BOOL)fsIsNative
6178   return fs_is_native;
6181 - (BOOL)isFullscreen
6183   if (! fs_is_native) return nonfs_window != nil;
6184 #ifdef HAVE_NATIVE_FS
6185   return ([[self window] styleMask] & NSFullScreenWindowMask) != 0;
6186 #else
6187   return NO;
6188 #endif
6191 #ifdef HAVE_NATIVE_FS
6192 - (void)updateCollectionBehaviour
6194   if (! [self isFullscreen])
6195     {
6196       NSWindow *win = [self window];
6197       NSWindowCollectionBehavior b = [win collectionBehavior];
6198       if (ns_use_native_fullscreen)
6199         b |= NSWindowCollectionBehaviorFullScreenPrimary;
6200       else
6201         b &= ~NSWindowCollectionBehaviorFullScreenPrimary;
6203       [win setCollectionBehavior: b];
6204       fs_is_native = ns_use_native_fullscreen;
6205     }
6207 #endif
6209 - (void)toggleFullScreen: (id)sender
6211   NSWindow *w, *fw;
6212   BOOL onFirstScreen;
6213   struct frame *f;
6214   NSSize sz;
6215   NSRect r, wr;
6216   NSColor *col;
6218   if (fs_is_native)
6219     {
6220 #ifdef HAVE_NATIVE_FS
6221       [[self window] toggleFullScreen:sender];
6222 #endif
6223       return;
6224     }
6226   w = [self window];
6227   onFirstScreen = [[w screen] isEqual:[[NSScreen screens] objectAtIndex:0]];
6228   f = emacsframe;
6229   wr = [w frame];
6230   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6231                                  (FRAME_DEFAULT_FACE (f)),
6232                                  f);
6234   sz.width = FRAME_COLUMN_WIDTH (f);
6235   sz.height = FRAME_LINE_HEIGHT (f);
6237   if (fs_state != FULLSCREEN_BOTH)
6238     {
6239       /* Hide dock and menubar if we are on the primary screen.  */
6240       if (onFirstScreen)
6241         {
6242 #if defined (NS_IMPL_COCOA) && \
6243   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6244           NSApplicationPresentationOptions options
6245             = NSApplicationPresentationAutoHideDock
6246             | NSApplicationPresentationAutoHideMenuBar;
6248           [NSApp setPresentationOptions: options];
6249 #else
6250           [NSMenu setMenuBarVisible:NO];
6251 #endif
6252         }
6254       fw = [[EmacsFSWindow alloc]
6255                        initWithContentRect:[w contentRectForFrameRect:wr]
6256                                  styleMask:NSBorderlessWindowMask
6257                                    backing:NSBackingStoreBuffered
6258                                      defer:YES
6259                                     screen:[w screen]];
6261       [fw setContentView:[w contentView]];
6262       [fw setTitle:[w title]];
6263       [fw setDelegate:self];
6264       [fw setAcceptsMouseMovedEvents: YES];
6265       [fw useOptimizedDrawing: YES];
6266       [fw setResizeIncrements: sz];
6267       [fw setBackgroundColor: col];
6268       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6269         [fw setOpaque: NO];
6271       f->border_width = 0;
6272       FRAME_NS_TITLEBAR_HEIGHT (f) = 0;
6273       tobar_height = FRAME_TOOLBAR_HEIGHT (f);
6274       FRAME_TOOLBAR_HEIGHT (f) = 0;
6276       nonfs_window = w;
6278       [self windowWillEnterFullScreen:nil];
6279       [fw makeKeyAndOrderFront:NSApp];
6280       [fw makeFirstResponder:self];
6281       [w orderOut:self];
6282       r = [fw frameRectForContentRect:[[fw screen] frame]];
6283       [fw setFrame: r display:YES animate:YES];
6284       [self windowDidEnterFullScreen:nil];
6285       [fw display];
6286     }
6287   else
6288     {
6289       fw = w;
6290       w = nonfs_window;
6291       nonfs_window = nil;
6293       if (onFirstScreen)
6294         {
6295 #if defined (NS_IMPL_COCOA) && \
6296   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6297           [NSApp setPresentationOptions: NSApplicationPresentationDefault];
6298 #else
6299           [NSMenu setMenuBarVisible:YES];
6300 #endif
6301         }
6303       [w setContentView:[fw contentView]];
6304       [w setResizeIncrements: sz];
6305       [w setBackgroundColor: col];
6306       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6307         [w setOpaque: NO];
6309       f->border_width = bwidth;
6310       FRAME_NS_TITLEBAR_HEIGHT (f) = tibar_height;
6311       if (FRAME_EXTERNAL_TOOL_BAR (f))
6312         FRAME_TOOLBAR_HEIGHT (f) = tobar_height;
6314       [self windowWillExitFullScreen:nil];
6315       [fw setFrame: [w frame] display:YES animate:YES];
6316       [fw close];
6317       [w makeKeyAndOrderFront:NSApp];
6318       [self windowDidExitFullScreen:nil];
6319       [self updateFrameSize:YES];
6320     }
6323 - (void)handleFS
6325   if (fs_state != emacsframe->want_fullscreen)
6326     {
6327       if (fs_state == FULLSCREEN_BOTH)
6328         {
6329           [self toggleFullScreen:self];
6330         }
6332       switch (emacsframe->want_fullscreen)
6333         {
6334         case FULLSCREEN_BOTH:
6335           [self toggleFullScreen:self];
6336           break;
6337         case FULLSCREEN_WIDTH:
6338           next_maximized = FULLSCREEN_WIDTH;
6339           if (fs_state != FULLSCREEN_BOTH)
6340             [[self window] performZoom:self];
6341           break;
6342         case FULLSCREEN_HEIGHT:
6343           next_maximized = FULLSCREEN_HEIGHT;
6344           if (fs_state != FULLSCREEN_BOTH)
6345             [[self window] performZoom:self];
6346           break;
6347         case FULLSCREEN_MAXIMIZED:
6348           next_maximized = FULLSCREEN_MAXIMIZED;
6349           if (fs_state != FULLSCREEN_BOTH)
6350             [[self window] performZoom:self];
6351           break;
6352         case FULLSCREEN_NONE:
6353           if (fs_state != FULLSCREEN_BOTH)
6354             {
6355               next_maximized = FULLSCREEN_NONE;
6356               [[self window] performZoom:self];
6357             }
6358           break;
6359         }
6361       emacsframe->want_fullscreen = FULLSCREEN_NONE;
6362     }
6366 - (void) setFSValue: (int)value
6368   Lisp_Object lval = Qnil;
6369   switch (value)
6370     {
6371     case FULLSCREEN_BOTH:
6372       lval = Qfullboth;
6373       break;
6374     case FULLSCREEN_WIDTH:
6375       lval = Qfullwidth;
6376       break;
6377     case FULLSCREEN_HEIGHT:
6378       lval = Qfullheight;
6379       break;
6380     case FULLSCREEN_MAXIMIZED:
6381       lval = Qmaximized;
6382       break;
6383     }
6384   store_frame_param (emacsframe, Qfullscreen, lval);
6385   fs_state = value;
6388 - (void)mouseEntered: (NSEvent *)theEvent
6390   NSTRACE (mouseEntered);
6391   if (emacsframe)
6392     FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6393       = EV_TIMESTAMP (theEvent);
6397 - (void)mouseExited: (NSEvent *)theEvent
6399   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
6401   NSTRACE (mouseExited);
6403   if (!hlinfo)
6404     return;
6406   FRAME_DISPLAY_INFO (emacsframe)->last_mouse_movement_time
6407     = EV_TIMESTAMP (theEvent);
6409   if (emacsframe == hlinfo->mouse_face_mouse_frame)
6410     {
6411       clear_mouse_face (hlinfo);
6412       hlinfo->mouse_face_mouse_frame = 0;
6413     }
6417 - menuDown: sender
6419   NSTRACE (menuDown);
6420   if (context_menu_value == -1)
6421     context_menu_value = [sender tag];
6422   else
6423     {
6424       NSInteger tag = [sender tag];
6425       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
6426                                     emacsframe->menu_bar_vector,
6427                                     (void *)tag);
6428     }
6430   ns_send_appdefined (-1);
6431   return self;
6435 - (EmacsToolbar *)toolbar
6437   return toolbar;
6441 /* this gets called on toolbar button click */
6442 - toolbarClicked: (id)item
6444   NSEvent *theEvent;
6445   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
6447   NSTRACE (toolbarClicked);
6449   if (!emacs_event)
6450     return self;
6452   /* send first event (for some reason two needed) */
6453   theEvent = [[self window] currentEvent];
6454   emacs_event->kind = TOOL_BAR_EVENT;
6455   XSETFRAME (emacs_event->arg, emacsframe);
6456   EV_TRAILER (theEvent);
6458   emacs_event->kind = TOOL_BAR_EVENT;
6459 /*   XSETINT (emacs_event->code, 0); */
6460   emacs_event->arg = AREF (emacsframe->tool_bar_items,
6461                            idx + TOOL_BAR_ITEM_KEY);
6462   emacs_event->modifiers = EV_MODIFIERS (theEvent);
6463   EV_TRAILER (theEvent);
6464   return self;
6468 - toggleToolbar: (id)sender
6470   if (!emacs_event)
6471     return self;
6473   emacs_event->kind = NS_NONKEY_EVENT;
6474   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
6475   EV_TRAILER ((id)nil);
6476   return self;
6480 - (void)drawRect: (NSRect)rect
6482   int x = NSMinX (rect), y = NSMinY (rect);
6483   int width = NSWidth (rect), height = NSHeight (rect);
6485   NSTRACE (drawRect);
6487   if (!emacsframe || !emacsframe->output_data.ns)
6488     return;
6490   ns_clear_frame_area (emacsframe, x, y, width, height);
6491   expose_frame (emacsframe, x, y, width, height);
6493   /*
6494     drawRect: may be called (at least in OS X 10.5) for invisible
6495     views as well for some reason.  Thus, do not infer visibility
6496     here.
6498     emacsframe->async_visible = 1;
6499     emacsframe->async_iconified = 0;
6500   */
6504 /* NSDraggingDestination protocol methods.  Actually this is not really a
6505    protocol, but a category of Object.  O well...  */
6507 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
6509   NSTRACE (draggingEntered);
6510   return NSDragOperationGeneric;
6514 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
6516   return YES;
6520 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
6522   id pb;
6523   int x, y;
6524   NSString *type;
6525   NSEvent *theEvent = [[self window] currentEvent];
6526   NSPoint position;
6528   NSTRACE (performDragOperation);
6530   if (!emacs_event)
6531     return NO;
6533   position = [self convertPoint: [sender draggingLocation] fromView: nil];
6534   x = lrint (position.x);  y = lrint (position.y);
6536   pb = [sender draggingPasteboard];
6537   type = [pb availableTypeFromArray: ns_drag_types];
6538   if (type == 0)
6539     {
6540       return NO;
6541     }
6542   else if ([type isEqualToString: NSFilenamesPboardType])
6543     {
6544       NSArray *files;
6545       NSEnumerator *fenum;
6546       NSString *file;
6548       if (!(files = [pb propertyListForType: type]))
6549         return NO;
6551       fenum = [files objectEnumerator];
6552       while ( (file = [fenum nextObject]) )
6553         {
6554           emacs_event->kind = NS_NONKEY_EVENT;
6555           emacs_event->code = KEY_NS_DRAG_FILE;
6556           XSETINT (emacs_event->x, x);
6557           XSETINT (emacs_event->y, y);
6558           ns_input_file = append2 (ns_input_file,
6559                                    build_string ([file UTF8String]));
6560           emacs_event->modifiers = EV_MODIFIERS (theEvent);
6561           EV_TRAILER (theEvent);
6562         }
6563       return YES;
6564     }
6565   else if ([type isEqualToString: NSURLPboardType])
6566     {
6567       NSString *file;
6568       NSURL *fileURL;
6570       if (!(fileURL = [NSURL URLFromPasteboard: pb]) ||
6571           [fileURL isFileURL] == NO)
6572         return NO;
6574       file = [fileURL path];
6575       emacs_event->kind = NS_NONKEY_EVENT;
6576       emacs_event->code = KEY_NS_DRAG_FILE;
6577       XSETINT (emacs_event->x, x);
6578       XSETINT (emacs_event->y, y);
6579       ns_input_file = append2 (ns_input_file, build_string ([file UTF8String]));
6580       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6581       EV_TRAILER (theEvent);
6582       return YES;
6583     }
6584   else if ([type isEqualToString: NSStringPboardType]
6585            || [type isEqualToString: NSTabularTextPboardType])
6586     {
6587       NSString *data;
6589       if (! (data = [pb stringForType: type]))
6590         return NO;
6592       emacs_event->kind = NS_NONKEY_EVENT;
6593       emacs_event->code = KEY_NS_DRAG_TEXT;
6594       XSETINT (emacs_event->x, x);
6595       XSETINT (emacs_event->y, y);
6596       ns_input_text = build_string ([data UTF8String]);
6597       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6598       EV_TRAILER (theEvent);
6599       return YES;
6600     }
6601   else if ([type isEqualToString: NSColorPboardType])
6602     {
6603       NSColor *c = [NSColor colorFromPasteboard: pb];
6604       emacs_event->kind = NS_NONKEY_EVENT;
6605       emacs_event->code = KEY_NS_DRAG_COLOR;
6606       XSETINT (emacs_event->x, x);
6607       XSETINT (emacs_event->y, y);
6608       ns_input_color = ns_color_to_lisp (c);
6609       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6610       EV_TRAILER (theEvent);
6611       return YES;
6612     }
6613   else if ([type isEqualToString: NSFontPboardType])
6614     {
6615       /* impl based on GNUstep NSTextView.m */
6616       NSData *data = [pb dataForType: NSFontPboardType];
6617       NSDictionary *dict = [NSUnarchiver unarchiveObjectWithData: data];
6618       NSFont *font = [dict objectForKey: NSFontAttributeName];
6619       char fontSize[10];
6621       if (font == nil)
6622         return NO;
6624       emacs_event->kind = NS_NONKEY_EVENT;
6625       emacs_event->code = KEY_NS_CHANGE_FONT;
6626       XSETINT (emacs_event->x, x);
6627       XSETINT (emacs_event->y, y);
6628       ns_input_font = build_string ([[font fontName] UTF8String]);
6629       snprintf (fontSize, 10, "%f", [font pointSize]);
6630       ns_input_fontsize = build_string (fontSize);
6631       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6632       EV_TRAILER (theEvent);
6633       return YES;
6634     }
6635   else
6636     {
6637       error ("Invalid data type in dragging pasteboard.");
6638       return NO;
6639     }
6643 - (id) validRequestorForSendType: (NSString *)typeSent
6644                       returnType: (NSString *)typeReturned
6646   NSTRACE (validRequestorForSendType);
6647   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
6648       && typeReturned == nil)
6649     {
6650       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
6651         return self;
6652     }
6654   return [super validRequestorForSendType: typeSent
6655                                returnType: typeReturned];
6659 /* The next two methods are part of NSServicesRequests informal protocol,
6660    supposedly called when a services menu item is chosen from this app.
6661    But this should not happen because we override the services menu with our
6662    own entries which call ns-perform-service.
6663    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
6664    So let's at least stub them out until further investigation can be done. */
6666 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
6668   /* we could call ns_string_from_pasteboard(pboard) here but then it should
6669      be written into the buffer in place of the existing selection..
6670      ordinary service calls go through functions defined in ns-win.el */
6671   return NO;
6674 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
6676   NSArray *typesDeclared;
6677   Lisp_Object val;
6679   /* We only support NSStringPboardType */
6680   if ([types containsObject:NSStringPboardType] == NO) {
6681     return NO;
6682   }
6684   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6685   if (CONSP (val) && SYMBOLP (XCAR (val)))
6686     {
6687       val = XCDR (val);
6688       if (CONSP (val) && NILP (XCDR (val)))
6689         val = XCAR (val);
6690     }
6691   if (! STRINGP (val))
6692     return NO;
6694   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
6695   [pb declareTypes:typesDeclared owner:nil];
6696   ns_string_to_pasteboard (pb, val);
6697   return YES;
6701 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
6702    (gives a miniaturized version of the window); currently we use the latter for
6703    frames whose active buffer doesn't correspond to any file
6704    (e.g., '*scratch*') */
6705 - setMiniwindowImage: (BOOL) setMini
6707   id image = [[self window] miniwindowImage];
6708   NSTRACE (setMiniwindowImage);
6710   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
6711      about "AppleDockIconEnabled" notwithstanding, however the set message
6712      below has its effect nonetheless. */
6713   if (image != emacsframe->output_data.ns->miniimage)
6714     {
6715       if (image && [image isKindOfClass: [EmacsImage class]])
6716         [image release];
6717       [[self window] setMiniwindowImage:
6718                        setMini ? emacsframe->output_data.ns->miniimage : nil];
6719     }
6721   return self;
6725 - (void) setRows: (int) r andColumns: (int) c
6727   rows = r;
6728   cols = c;
6731 @end  /* EmacsView */
6735 /* ==========================================================================
6737     EmacsWindow implementation
6739    ========================================================================== */
6741 @implementation EmacsWindow
6743 #ifdef NS_IMPL_COCOA
6744 - (id)accessibilityAttributeValue:(NSString *)attribute
6746   Lisp_Object str = Qnil;
6747   struct frame *f = SELECTED_FRAME ();
6748   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->contents);
6750   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
6751     return NSAccessibilityTextFieldRole;
6753   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
6754       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
6755     {
6756       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6757     }
6758   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
6759     {
6760       if (! NILP (BVAR (curbuf, mark_active)))
6761           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6763       if (NILP (str))
6764         {
6765           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
6766           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
6767           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
6769           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
6770             str = make_uninit_multibyte_string (range, byte_range);
6771           else
6772             str = make_uninit_string (range);
6773           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
6774              Is this a problem?  */
6775           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
6776         }
6777     }
6780   if (! NILP (str))
6781     {
6782       if (CONSP (str) && SYMBOLP (XCAR (str)))
6783         {
6784           str = XCDR (str);
6785           if (CONSP (str) && NILP (XCDR (str)))
6786             str = XCAR (str);
6787         }
6788       if (STRINGP (str))
6789         {
6790           const char *utfStr = SSDATA (str);
6791           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
6792           return nsStr;
6793         }
6794     }
6796   return [super accessibilityAttributeValue:attribute];
6798 #endif /* NS_IMPL_COCOA */
6800 /* If we have multiple monitors, one above the other, we don't want to
6801    restrict the height to just one monitor.  So we override this.  */
6802 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
6804   /* When making the frame visible for the first time or if there is just
6805      one screen, we want to constrain.  Other times not.  */
6806   NSUInteger nr_screens = [[NSScreen screens] count];
6807   struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
6808   NSTRACE (constrainFrameRect);
6810   if (nr_screens == 1)
6811     {
6812       NSRect r = [super constrainFrameRect:frameRect toScreen:screen];
6813       return r;
6814     }
6816   if (f->output_data.ns->dont_constrain
6817       || ns_menu_bar_should_be_hidden ())
6818     return frameRect;
6820   f->output_data.ns->dont_constrain = 1;
6821   return [super constrainFrameRect:frameRect toScreen:screen];
6824 @end /* EmacsWindow */
6827 @implementation EmacsFSWindow
6829 - (BOOL)canBecomeKeyWindow
6831   return YES;
6834 - (BOOL)canBecomeMainWindow
6836   return YES;
6839 @end
6841 /* ==========================================================================
6843     EmacsScroller implementation
6845    ========================================================================== */
6848 @implementation EmacsScroller
6850 /* for repeat button push */
6851 #define SCROLL_BAR_FIRST_DELAY 0.5
6852 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
6854 + (CGFloat) scrollerWidth
6856   /* TODO: if we want to allow variable widths, this is the place to do it,
6857            however neither GNUstep nor Cocoa support it very well */
6858   return [NSScroller scrollerWidth];
6862 - initFrame: (NSRect )r window: (Lisp_Object)nwin
6864   NSTRACE (EmacsScroller_initFrame);
6866   r.size.width = [EmacsScroller scrollerWidth];
6867   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
6868   [self setContinuous: YES];
6869   [self setEnabled: YES];
6871   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
6872      locked against the top and bottom edges, and right edge on OS X, where
6873      scrollers are on right. */
6874 #ifdef NS_IMPL_GNUSTEP
6875   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
6876 #else
6877   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
6878 #endif
6880   win = nwin;
6881   condemned = NO;
6882   pixel_height = NSHeight (r);
6883   if (pixel_height == 0) pixel_height = 1;
6884   min_portion = 20 / pixel_height;
6886   frame = XFRAME (XWINDOW (win)->frame);
6887   if (FRAME_LIVE_P (frame))
6888     {
6889       int i;
6890       EmacsView *view = FRAME_NS_VIEW (frame);
6891       NSView *sview = [[view window] contentView];
6892       NSArray *subs = [sview subviews];
6894       /* disable optimization stopping redraw of other scrollbars */
6895       view->scrollbarsNeedingUpdate = 0;
6896       for (i =[subs count]-1; i >= 0; i--)
6897         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
6898           view->scrollbarsNeedingUpdate++;
6899       [sview addSubview: self];
6900     }
6902 /*  [self setFrame: r]; */
6904   return self;
6908 - (void)setFrame: (NSRect)newRect
6910   NSTRACE (EmacsScroller_setFrame);
6911 /*  block_input (); */
6912   pixel_height = NSHeight (newRect);
6913   if (pixel_height == 0) pixel_height = 1;
6914   min_portion = 20 / pixel_height;
6915   [super setFrame: newRect];
6916   [self display];
6917 /*  unblock_input (); */
6921 - (void)dealloc
6923   NSTRACE (EmacsScroller_dealloc);
6924   if (!NILP (win))
6925     wset_vertical_scroll_bar (XWINDOW (win), Qnil);
6926   [super dealloc];
6930 - condemn
6932   NSTRACE (condemn);
6933   condemned =YES;
6934   return self;
6938 - reprieve
6940   NSTRACE (reprieve);
6941   condemned =NO;
6942   return self;
6946 - judge
6948   NSTRACE (judge);
6949   if (condemned)
6950     {
6951       EmacsView *view;
6952       block_input ();
6953       /* ensure other scrollbar updates after deletion */
6954       view = (EmacsView *)FRAME_NS_VIEW (frame);
6955       if (view != nil)
6956         view->scrollbarsNeedingUpdate++;
6957       [self removeFromSuperview];
6958       [self release];
6959       unblock_input ();
6960     }
6961   return self;
6965 - (void)resetCursorRects
6967   NSRect visible = [self visibleRect];
6968   NSTRACE (resetCursorRects);
6970   if (!NSIsEmptyRect (visible))
6971     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
6972   [[NSCursor arrowCursor] setOnMouseEntered: YES];
6976 - (int) checkSamePosition: (int) position portion: (int) portion
6977                     whole: (int) whole
6979   return em_position ==position && em_portion ==portion && em_whole ==whole
6980     && portion != whole; /* needed for resize empty buf */
6984 - setPosition: (int)position portion: (int)portion whole: (int)whole
6986   NSTRACE (setPosition);
6988   em_position = position;
6989   em_portion = portion;
6990   em_whole = whole;
6992   if (portion >= whole)
6993     {
6994 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
6995       [self setKnobProportion: 1.0];
6996       [self setDoubleValue: 1.0];
6997 #else
6998       [self setFloatValue: 0.0 knobProportion: 1.0];
6999 #endif
7000     }
7001   else
7002     {
7003       float pos;
7004       CGFloat por;
7005       portion = max ((float)whole*min_portion/pixel_height, portion);
7006       pos = (float)position / (whole - portion);
7007       por = (CGFloat)portion/whole;
7008 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
7009       [self setKnobProportion: por];
7010       [self setDoubleValue: pos];
7011 #else
7012       [self setFloatValue: pos knobProportion: por];
7013 #endif
7014     }
7016   /* Events may come here even if the event loop is not running.
7017      If we don't enter the event loop, the scroll bar will not update.
7018      So send SIGIO to ourselves.  */
7019   if (apploopnr == 0) raise (SIGIO);
7021   return self;
7024 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
7025      drag events will go directly to the EmacsScroller.  Leaving in for now. */
7026 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
7027                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
7029   *part = last_hit_part;
7030   *window = win;
7031   XSETINT (*y, pixel_height);
7032   if ([self floatValue] > 0.999F)
7033     XSETINT (*x, pixel_height);
7034   else
7035     XSETINT (*x, pixel_height * [self floatValue]);
7039 /* set up emacs_event */
7040 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
7042   if (!emacs_event)
7043     return;
7045   emacs_event->part = last_hit_part;
7046   emacs_event->code = 0;
7047   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
7048   emacs_event->frame_or_window = win;
7049   emacs_event->timestamp = EV_TIMESTAMP (e);
7050   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
7051   emacs_event->arg = Qnil;
7052   XSETINT (emacs_event->x, loc * pixel_height);
7053   XSETINT (emacs_event->y, pixel_height-20);
7055   if (q_event_ptr)
7056     {
7057       n_emacs_events_pending++;
7058       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
7059     }
7060   else
7061     hold_event (emacs_event);
7062   EVENT_INIT (*emacs_event);
7063   ns_send_appdefined (-1);
7067 /* called manually thru timer to implement repeated button action w/hold-down */
7068 - repeatScroll: (NSTimer *)scrollEntry
7070   NSEvent *e = [[self window] currentEvent];
7071   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
7072   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
7074   /* clear timer if need be */
7075   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
7076     {
7077         [scroll_repeat_entry invalidate];
7078         [scroll_repeat_entry release];
7079         scroll_repeat_entry = nil;
7081         if (inKnob)
7082           return self;
7084         scroll_repeat_entry
7085           = [[NSTimer scheduledTimerWithTimeInterval:
7086                         SCROLL_BAR_CONTINUOUS_DELAY
7087                                             target: self
7088                                           selector: @selector (repeatScroll:)
7089                                           userInfo: 0
7090                                            repeats: YES]
7091               retain];
7092     }
7094   [self sendScrollEventAtLoc: 0 fromEvent: e];
7095   return self;
7099 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
7100    mouseDragged events without going into a modal loop. */
7101 - (void)mouseDown: (NSEvent *)e
7103   NSRect sr, kr;
7104   /* hitPart is only updated AFTER event is passed on */
7105   NSScrollerPart part = [self testPart: [e locationInWindow]];
7106   CGFloat inc = 0.0, loc, kloc, pos;
7107   int edge = 0;
7109   NSTRACE (EmacsScroller_mouseDown);
7111   switch (part)
7112     {
7113     case NSScrollerDecrementPage:
7114         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
7115     case NSScrollerIncrementPage:
7116         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
7117     case NSScrollerDecrementLine:
7118       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
7119     case NSScrollerIncrementLine:
7120       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
7121     case NSScrollerKnob:
7122       last_hit_part = scroll_bar_handle; break;
7123     case NSScrollerKnobSlot:  /* GNUstep-only */
7124       last_hit_part = scroll_bar_move_ratio; break;
7125     default:  /* NSScrollerNoPart? */
7126       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
7127                (long) part);
7128       return;
7129     }
7131   if (inc != 0.0)
7132     {
7133       pos = 0;      /* ignored */
7135       /* set a timer to repeat, as we can't let superclass do this modally */
7136       scroll_repeat_entry
7137         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
7138                                             target: self
7139                                           selector: @selector (repeatScroll:)
7140                                           userInfo: 0
7141                                            repeats: YES]
7142             retain];
7143     }
7144   else
7145     {
7146       /* handle, or on GNUstep possibly slot */
7147       NSEvent *fake_event;
7149       /* compute float loc in slot and mouse offset on knob */
7150       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7151                       toView: nil];
7152       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7153       if (loc <= 0.0)
7154         {
7155           loc = 0.0;
7156           edge = -1;
7157         }
7158       else if (loc >= NSHeight (sr))
7159         {
7160           loc = NSHeight (sr);
7161           edge = 1;
7162         }
7164       if (edge)
7165         kloc = 0.5 * edge;
7166       else
7167         {
7168           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
7169                           toView: nil];
7170           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
7171         }
7172       last_mouse_offset = kloc;
7174       /* if knob, tell emacs a location offset by knob pos
7175          (to indicate top of handle) */
7176       if (part == NSScrollerKnob)
7177           pos = (loc - last_mouse_offset) / NSHeight (sr);
7178       else
7179         /* else this is a slot click on GNUstep: go straight there */
7180         pos = loc / NSHeight (sr);
7182       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
7183       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
7184                                       location: [e locationInWindow]
7185                                  modifierFlags: [e modifierFlags]
7186                                      timestamp: [e timestamp]
7187                                   windowNumber: [e windowNumber]
7188                                        context: [e context]
7189                                    eventNumber: [e eventNumber]
7190                                     clickCount: [e clickCount]
7191                                       pressure: [e pressure]];
7192       [super mouseUp: fake_event];
7193     }
7195   if (part != NSScrollerKnob)
7196     [self sendScrollEventAtLoc: pos fromEvent: e];
7200 /* Called as we manually track scroller drags, rather than superclass. */
7201 - (void)mouseDragged: (NSEvent *)e
7203     NSRect sr;
7204     double loc, pos;
7206     NSTRACE (EmacsScroller_mouseDragged);
7208       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7209                       toView: nil];
7210       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7212       if (loc <= 0.0)
7213         {
7214           loc = 0.0;
7215         }
7216       else if (loc >= NSHeight (sr) + last_mouse_offset)
7217         {
7218           loc = NSHeight (sr) + last_mouse_offset;
7219         }
7221       pos = (loc - last_mouse_offset) / NSHeight (sr);
7222       [self sendScrollEventAtLoc: pos fromEvent: e];
7226 - (void)mouseUp: (NSEvent *)e
7228   if (scroll_repeat_entry)
7229     {
7230       [scroll_repeat_entry invalidate];
7231       [scroll_repeat_entry release];
7232       scroll_repeat_entry = nil;
7233     }
7234   last_hit_part = 0;
7238 /* treat scrollwheel events in the bar as though they were in the main window */
7239 - (void) scrollWheel: (NSEvent *)theEvent
7241   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
7242   [view mouseDown: theEvent];
7245 @end  /* EmacsScroller */
7248 #ifdef NS_IMPL_GNUSTEP
7249 /* Dummy class to get rid of startup warnings.  */
7250 @implementation EmacsDocument
7252 @end
7253 #endif
7256 /* ==========================================================================
7258    Font-related functions; these used to be in nsfaces.m
7260    ========================================================================== */
7263 Lisp_Object
7264 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7266   struct font *font = XFONT_OBJECT (font_object);
7268   if (fontset < 0)
7269     fontset = fontset_from_font (font_object);
7270   FRAME_FONTSET (f) = fontset;
7272   if (FRAME_FONT (f) == font)
7273     /* This font is already set in frame F.  There's nothing more to
7274        do.  */
7275     return font_object;
7277   FRAME_FONT (f) = font;
7279   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7280   FRAME_COLUMN_WIDTH (f) = font->average_width;
7281   FRAME_LINE_HEIGHT (f) = font->height;
7283   compute_fringe_widths (f, 1);
7285   /* Compute the scroll bar width in character columns.  */
7286   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7287     {
7288       int wid = FRAME_COLUMN_WIDTH (f);
7289       FRAME_CONFIG_SCROLL_BAR_COLS (f)
7290         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
7291     }
7292   else
7293     {
7294       int wid = FRAME_COLUMN_WIDTH (f);
7295       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7296     }
7298   /* Now make the frame display the given font.  */
7299   if (FRAME_NS_WINDOW (f) != 0)
7300         x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7302   return font_object;
7306 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
7307 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
7308          in 1.43. */
7310 const char *
7311 ns_xlfd_to_fontname (const char *xlfd)
7312 /* --------------------------------------------------------------------------
7313     Convert an X font name (XLFD) to an NS font name.
7314     Only family is used.
7315     The string returned is temporarily allocated.
7316    -------------------------------------------------------------------------- */
7318   char *name = xmalloc (180);
7319   int i, len;
7320   const char *ret;
7322   if (!strncmp (xlfd, "--", 2))
7323     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
7324   else
7325     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
7327   /* stopgap for malformed XLFD input */
7328   if (strlen (name) == 0)
7329     strcpy (name, "Monaco");
7331   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
7332      also uppercase after '-' or ' ' */
7333   name[0] = c_toupper (name[0]);
7334   for (len =strlen (name), i =0; i<len; i++)
7335     {
7336       if (name[i] == '$')
7337         {
7338           name[i] = '-';
7339           if (i+1<len)
7340             name[i+1] = c_toupper (name[i+1]);
7341         }
7342       else if (name[i] == '_')
7343         {
7344           name[i] = ' ';
7345           if (i+1<len)
7346             name[i+1] = c_toupper (name[i+1]);
7347         }
7348     }
7349 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
7350   ret = [[NSString stringWithUTF8String: name] UTF8String];
7351   xfree (name);
7352   return ret;
7356 void
7357 syms_of_nsterm (void)
7359   NSTRACE (syms_of_nsterm);
7361   ns_antialias_threshold = 10.0;
7363   /* from 23+ we need to tell emacs what modifiers there are.. */
7364   DEFSYM (Qmodifier_value, "modifier-value");
7365   DEFSYM (Qalt, "alt");
7366   DEFSYM (Qhyper, "hyper");
7367   DEFSYM (Qmeta, "meta");
7368   DEFSYM (Qsuper, "super");
7369   DEFSYM (Qcontrol, "control");
7370   DEFSYM (QUTF8_STRING, "UTF8_STRING");
7372   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
7373   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
7374   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
7375   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
7376   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
7378   DEFVAR_LISP ("ns-input-file", ns_input_file,
7379               "The file specified in the last NS event.");
7380   ns_input_file =Qnil;
7382   DEFVAR_LISP ("ns-input-text", ns_input_text,
7383               "The data received in the last NS text drag event.");
7384   ns_input_text =Qnil;
7386   DEFVAR_LISP ("ns-working-text", ns_working_text,
7387               "String for visualizing working composition sequence.");
7388   ns_working_text =Qnil;
7390   DEFVAR_LISP ("ns-input-font", ns_input_font,
7391               "The font specified in the last NS event.");
7392   ns_input_font =Qnil;
7394   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
7395               "The fontsize specified in the last NS event.");
7396   ns_input_fontsize =Qnil;
7398   DEFVAR_LISP ("ns-input-line", ns_input_line,
7399                "The line specified in the last NS event.");
7400   ns_input_line =Qnil;
7402   DEFVAR_LISP ("ns-input-color", ns_input_color,
7403                "The color specified in the last NS event.");
7404   ns_input_color =Qnil;
7406   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
7407                "The service name specified in the last NS event.");
7408   ns_input_spi_name =Qnil;
7410   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
7411                "The service argument specified in the last NS event.");
7412   ns_input_spi_arg =Qnil;
7414   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
7415                "This variable describes the behavior of the alternate or option key.\n\
7416 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7417 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7418 at all, allowing it to be used at a lower level for accented character entry.");
7419   ns_alternate_modifier = Qmeta;
7421   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
7422                "This variable describes the behavior of the right alternate or option key.\n\
7423 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7424 Set to left means be the same key as `ns-alternate-modifier'.\n\
7425 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7426 at all, allowing it to be used at a lower level for accented character entry.");
7427   ns_right_alternate_modifier = Qleft;
7429   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
7430                "This variable describes the behavior of the command key.\n\
7431 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7432   ns_command_modifier = Qsuper;
7434   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
7435                "This variable describes the behavior of the right command key.\n\
7436 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7437 Set to left means be the same key as `ns-command-modifier'.\n\
7438 Set to none means that the command / option key is not interpreted by Emacs\n\
7439 at all, allowing it to be used at a lower level for accented character entry.");
7440   ns_right_command_modifier = Qleft;
7442   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
7443                "This variable describes the behavior of the control key.\n\
7444 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7445   ns_control_modifier = Qcontrol;
7447   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
7448                "This variable describes the behavior of the right control key.\n\
7449 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7450 Set to left means be the same key as `ns-control-modifier'.\n\
7451 Set to none means that the control / option key is not interpreted by Emacs\n\
7452 at all, allowing it to be used at a lower level for accented character entry.");
7453   ns_right_control_modifier = Qleft;
7455   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
7456                "This variable describes the behavior of the function key (on laptops).\n\
7457 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7458 Set to none means that the function key is not interpreted by Emacs at all,\n\
7459 allowing it to be used at a lower level for accented character entry.");
7460   ns_function_modifier = Qnone;
7462   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
7463                "Non-nil (the default) means to render text antialiased.");
7464   ns_antialias_text = Qt;
7466   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
7467                "Whether to confirm application quit using dialog.");
7468   ns_confirm_quit = Qnil;
7470   staticpro (&ns_display_name_list);
7471   ns_display_name_list = Qnil;
7473   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
7474                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
7475 Only works on OSX 10.6 or later.  */);
7476   ns_auto_hide_menu_bar = Qnil;
7478   DEFVAR_BOOL ("ns-use-native-fullscreen", ns_use_native_fullscreen,
7479      doc: /*Non-nil means to use native fullscreen on OSX >= 10.7.
7480 Nil means use fullscreen the old (< 10.7) way.  The old way works better with
7481 multiple monitors, but lacks tool bar.  This variable is ignored on OSX < 10.7.
7482 Default is t for OSX >= 10.7, nil otherwise. */);
7483 #ifdef HAVE_NATIVE_FS
7484   ns_use_native_fullscreen = YES;
7485 #else
7486   ns_use_native_fullscreen = NO;
7487 #endif
7488   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
7490   /* TODO: move to common code */
7491   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
7492                doc: /* Which toolkit scroll bars Emacs uses, if any.
7493 A value of nil means Emacs doesn't use toolkit scroll bars.
7494 With the X Window system, the value is a symbol describing the
7495 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
7496 With MS Windows or Nextstep, the value is t.  */);
7497   Vx_toolkit_scroll_bars = Qt;
7499   DEFVAR_BOOL ("x-use-underline-position-properties",
7500                x_use_underline_position_properties,
7501      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
7502 A value of nil means ignore them.  If you encounter fonts with bogus
7503 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
7504 to 4.1, set this to nil. */);
7505   x_use_underline_position_properties = 0;
7507   DEFVAR_BOOL ("x-underline-at-descent-line",
7508                x_underline_at_descent_line,
7509      doc: /* Non-nil means to draw the underline at the same place as the descent line.
7510 A value of nil means to draw the underline according to the value of the
7511 variable `x-use-underline-position-properties', which is usually at the
7512 baseline level.  The default value is nil.  */);
7513   x_underline_at_descent_line = 0;
7515   /* Tell Emacs about this window system.  */
7516   Fprovide (Qns, Qnil);
7518   syms_of_nsfont ();
7519 #ifdef NS_IMPL_COCOA
7520 #if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
7521   syms_of_macfont ();
7522 #endif
7523 #endif
7524