* todo-mode.el: Offer to convert legacy file. Update commentary.
[emacs.git] / src / nsterm.m
blob93f693fe55e0bbdf12f988bc80e57294f7ff7c8f
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 /* call tracing */
68 #if 0
69 int term_trace_num = 0;
70 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
71                                 __FILE__, __LINE__, ++term_trace_num)
72 #else
73 #define NSTRACE(x)
74 #endif
76 extern NSString *NSMenuDidBeginTrackingNotification;
78 /* ==========================================================================
80     Local declarations
82    ========================================================================== */
84 /* Convert a symbol indexed with an NSxxx value to a value as defined
85    in keyboard.c (lispy_function_key). I hope this is a correct way
86    of doing things... */
87 static unsigned convert_ns_to_X_keysym[] =
89   NSHomeFunctionKey,            0x50,
90   NSLeftArrowFunctionKey,       0x51,
91   NSUpArrowFunctionKey,         0x52,
92   NSRightArrowFunctionKey,      0x53,
93   NSDownArrowFunctionKey,       0x54,
94   NSPageUpFunctionKey,          0x55,
95   NSPageDownFunctionKey,        0x56,
96   NSEndFunctionKey,             0x57,
97   NSBeginFunctionKey,           0x58,
98   NSSelectFunctionKey,          0x60,
99   NSPrintFunctionKey,           0x61,
100   NSClearLineFunctionKey,       0x0B,
101   NSExecuteFunctionKey,         0x62,
102   NSInsertFunctionKey,          0x63,
103   NSUndoFunctionKey,            0x65,
104   NSRedoFunctionKey,            0x66,
105   NSMenuFunctionKey,            0x67,
106   NSFindFunctionKey,            0x68,
107   NSHelpFunctionKey,            0x6A,
108   NSBreakFunctionKey,           0x6B,
110   NSF1FunctionKey,              0xBE,
111   NSF2FunctionKey,              0xBF,
112   NSF3FunctionKey,              0xC0,
113   NSF4FunctionKey,              0xC1,
114   NSF5FunctionKey,              0xC2,
115   NSF6FunctionKey,              0xC3,
116   NSF7FunctionKey,              0xC4,
117   NSF8FunctionKey,              0xC5,
118   NSF9FunctionKey,              0xC6,
119   NSF10FunctionKey,             0xC7,
120   NSF11FunctionKey,             0xC8,
121   NSF12FunctionKey,             0xC9,
122   NSF13FunctionKey,             0xCA,
123   NSF14FunctionKey,             0xCB,
124   NSF15FunctionKey,             0xCC,
125   NSF16FunctionKey,             0xCD,
126   NSF17FunctionKey,             0xCE,
127   NSF18FunctionKey,             0xCF,
128   NSF19FunctionKey,             0xD0,
129   NSF20FunctionKey,             0xD1,
130   NSF21FunctionKey,             0xD2,
131   NSF22FunctionKey,             0xD3,
132   NSF23FunctionKey,             0xD4,
133   NSF24FunctionKey,             0xD5,
135   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
136   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
137   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
139   NSTabCharacter,               0x09,
140   0x19,                         0x09,  /* left tab->regular since pass shift */
141   NSCarriageReturnCharacter,    0x0D,
142   NSNewlineCharacter,           0x0D,
143   NSEnterCharacter,             0x8D,
145   0x41|NSNumericPadKeyMask,     0xAE,  /* KP_Decimal */
146   0x43|NSNumericPadKeyMask,     0xAA,  /* KP_Multiply */
147   0x45|NSNumericPadKeyMask,     0xAB,  /* KP_Add */
148   0x4B|NSNumericPadKeyMask,     0xAF,  /* KP_Divide */
149   0x4E|NSNumericPadKeyMask,     0xAD,  /* KP_Subtract */
150   0x51|NSNumericPadKeyMask,     0xBD,  /* KP_Equal */
151   0x52|NSNumericPadKeyMask,     0xB0,  /* KP_0 */
152   0x53|NSNumericPadKeyMask,     0xB1,  /* KP_1 */
153   0x54|NSNumericPadKeyMask,     0xB2,  /* KP_2 */
154   0x55|NSNumericPadKeyMask,     0xB3,  /* KP_3 */
155   0x56|NSNumericPadKeyMask,     0xB4,  /* KP_4 */
156   0x57|NSNumericPadKeyMask,     0xB5,  /* KP_5 */
157   0x58|NSNumericPadKeyMask,     0xB6,  /* KP_6 */
158   0x59|NSNumericPadKeyMask,     0xB7,  /* KP_7 */
159   0x5B|NSNumericPadKeyMask,     0xB8,  /* KP_8 */
160   0x5C|NSNumericPadKeyMask,     0xB9,  /* KP_9 */
162   0x1B,                         0x1B   /* escape */
165 static Lisp_Object Qmodifier_value;
166 Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper;
167 extern Lisp_Object Qcursor_color, Qcursor_type, Qns, Qleft;
169 static Lisp_Object QUTF8_STRING;
171 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
172    the maximum font size to NOT antialias.  On GNUstep there is currently
173    no way to control this behavior. */
174 float ns_antialias_threshold;
176 /* Used to pick up AppleHighlightColor on OS X */
177 NSString *ns_selection_color;
179 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
180 NSString *ns_app_name = @"Emacs";  /* default changed later */
182 /* Display variables */
183 struct ns_display_info *x_display_list; /* Chain of existing displays */
184 Lisp_Object ns_display_name_list;
185 long context_menu_value = 0;
187 /* display update */
188 NSPoint last_mouse_motion_position;
189 static NSRect last_mouse_glyph;
190 static Time last_mouse_movement_time = 0;
191 static Lisp_Object last_mouse_motion_frame;
192 static EmacsScroller *last_mouse_scroll_bar = nil;
193 static struct frame *ns_updating_frame;
194 static NSView *focus_view = NULL;
195 static int ns_window_num = 0;
196 #ifdef NS_IMPL_GNUSTEP
197 static NSRect uRect;
198 #endif
199 static BOOL gsaved = NO;
200 static BOOL ns_fake_keydown = NO;
201 int ns_tmp_flags; /* FIXME */
202 struct nsfont_info *ns_tmp_font; /* FIXME */
203 #ifdef NS_IMPL_COCOA
204 static BOOL ns_menu_bar_is_hidden = NO;
205 #endif
206 /*static int debug_lock = 0; */
208 /* event loop */
209 static BOOL send_appdefined = YES;
210 #define NO_APPDEFINED_DATA (-8)
211 static int last_appdefined_event_data = NO_APPDEFINED_DATA;
212 static NSTimer *timed_entry = 0;
213 static NSTimer *scroll_repeat_entry = nil;
214 static fd_set select_readfds, select_writefds;
215 enum { SELECT_HAVE_READ = 1, SELECT_HAVE_WRITE = 2, SELECT_HAVE_TMO = 4 };
216 static int select_nfds = 0, select_valid = 0;
217 static EMACS_TIME select_timeout = { 0, 0 };
218 static int selfds[2] = { -1, -1 };
219 static pthread_mutex_t select_mutex;
220 static int apploopnr = 0;
221 static NSAutoreleasePool *outerpool;
222 static struct input_event *emacs_event = NULL;
223 static struct input_event *q_event_ptr = NULL;
224 static int n_emacs_events_pending = 0;
225 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
226   *ns_pending_service_args;
227 static BOOL ns_do_open_file = NO;
228 static BOOL ns_last_use_native_fullscreen;
230 static struct {
231   struct input_event *q;
232   int nr, cap;
233 } hold_event_q = {
234   NULL, 0, 0
237 #ifdef NS_IMPL_COCOA
239  * State for pending menu activation:
240  * MENU_NONE     Normal state
241  * MENU_PENDING  A menu has been clicked on, but has been canceled so we can
242  *               run lisp to update the menu.
243  * MENU_OPENING  Menu is up to date, and the click event is redone so the menu
244  *               will open.
245  */
246 #define MENU_NONE 0
247 #define MENU_PENDING 1
248 #define MENU_OPENING 2
249 static int menu_will_open_state = MENU_NONE;
251 /* Saved position for menu click.  */
252 static CGPoint menu_mouse_point;
254 /* Title for the menu to open.  */
255 static char *menu_pending_title = 0;
256 #endif
258 /* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
259 #define NS_FUNCTION_KEY_MASK 0x800000
260 #define NSLeftControlKeyMask    (0x000001 | NSControlKeyMask)
261 #define NSRightControlKeyMask   (0x002000 | NSControlKeyMask)
262 #define NSLeftCommandKeyMask    (0x000008 | NSCommandKeyMask)
263 #define NSRightCommandKeyMask   (0x000010 | NSCommandKeyMask)
264 #define NSLeftAlternateKeyMask  (0x000020 | NSAlternateKeyMask)
265 #define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
266 #define EV_MODIFIERS(e)                               \
267     ((([e modifierFlags] & NSHelpKeyMask) ?           \
268            hyper_modifier : 0)                        \
269      | (!EQ (ns_right_alternate_modifier, Qleft) && \
270         (([e modifierFlags] & NSRightAlternateKeyMask) \
271          == NSRightAlternateKeyMask) ? \
272            parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
273      | (([e modifierFlags] & NSAlternateKeyMask) ?                 \
274            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
275      | (([e modifierFlags] & NSShiftKeyMask) ?     \
276            shift_modifier : 0)                        \
277      | (!EQ (ns_right_control_modifier, Qleft) && \
278         (([e modifierFlags] & NSRightControlKeyMask) \
279          == NSRightControlKeyMask) ? \
280            parse_solitary_modifier (ns_right_control_modifier) : 0) \
281      | (([e modifierFlags] & NSControlKeyMask) ?      \
282            parse_solitary_modifier (ns_control_modifier) : 0)     \
283      | (([e modifierFlags] & NS_FUNCTION_KEY_MASK) ?  \
284            parse_solitary_modifier (ns_function_modifier) : 0)    \
285      | (!EQ (ns_right_command_modifier, Qleft) && \
286         (([e modifierFlags] & NSRightCommandKeyMask) \
287          == NSRightCommandKeyMask) ? \
288            parse_solitary_modifier (ns_right_command_modifier) : 0) \
289      | (([e modifierFlags] & NSCommandKeyMask) ?      \
290            parse_solitary_modifier (ns_command_modifier):0))
292 #define EV_UDMODIFIERS(e)                                      \
293     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
294      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
295      | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
296      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
297      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
298      | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
299      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
300      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
301      | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
303 #define EV_BUTTON(e)                                                         \
304     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
305       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
306      [e buttonNumber] - 1)
308 /* Convert the time field to a timestamp in milliseconds. */
309 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
311 /* This is a piece of code which is common to all the event handling
312    methods.  Maybe it should even be a function.  */
313 #define EV_TRAILER(e)                                                   \
314     {                                                                   \
315       XSETFRAME (emacs_event->frame_or_window, emacsframe);             \
316       if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
317       if (q_event_ptr)                                                  \
318         {                                                               \
319           n_emacs_events_pending++;                                     \
320           kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
321         }                                                               \
322       else                                                              \
323         hold_event (emacs_event);                                       \
324       EVENT_INIT (*emacs_event);                                        \
325       ns_send_appdefined (-1);                                          \
326     }
328 /* TODO: get rid of need for these forward declarations */
329 static void ns_condemn_scroll_bars (struct frame *f);
330 static void ns_judge_scroll_bars (struct frame *f);
331 void x_set_frame_alpha (struct frame *f);
334 /* ==========================================================================
336     Utilities
338    ========================================================================== */
340 static void
341 hold_event (struct input_event *event)
343   if (hold_event_q.nr == hold_event_q.cap)
344     {
345       if (hold_event_q.cap == 0) hold_event_q.cap = 10;
346       else hold_event_q.cap *= 2;
347       hold_event_q.q = (struct input_event *)
348         xrealloc (hold_event_q.q, hold_event_q.cap * sizeof (*hold_event_q.q));
349     }
351   hold_event_q.q[hold_event_q.nr++] = *event;
352   /* Make sure ns_read_socket is called, i.e. we have input.  */
353   raise (SIGIO);
354   send_appdefined = YES;
357 static Lisp_Object
358 append2 (Lisp_Object list, Lisp_Object item)
359 /* --------------------------------------------------------------------------
360    Utility to append to a list
361    -------------------------------------------------------------------------- */
363   Lisp_Object array[2];
364   array[0] = list;
365   array[1] = Fcons (item, Qnil);
366   return Fnconc (2, &array[0]);
370 const char *
371 ns_etc_directory (void)
372 /* If running as a self-contained app bundle, return as a string the
373    filename of the etc directory, if present; else nil.  */
375   NSBundle *bundle = [NSBundle mainBundle];
376   NSString *resourceDir = [bundle resourcePath];
377   NSString *resourcePath;
378   NSFileManager *fileManager = [NSFileManager defaultManager];
379   BOOL isDir;
381   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
382   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
383     {
384       if (isDir) return [resourcePath UTF8String];
385     }
386   return NULL;
390 const char *
391 ns_exec_path (void)
392 /* If running as a self-contained app bundle, return as a path string
393    the filenames of the libexec and bin directories, ie libexec:bin.
394    Otherwise, return nil.
395    Normally, Emacs does not add its own bin/ directory to the PATH.
396    However, a self-contained NS build has a different layout, with
397    bin/ and libexec/ subdirectories in the directory that contains
398    Emacs.app itself.
399    We put libexec first, because init_callproc_1 uses the first
400    element to initialize exec-directory.  An alternative would be
401    for init_callproc to check for invocation-directory/libexec.
404   NSBundle *bundle = [NSBundle mainBundle];
405   NSString *resourceDir = [bundle resourcePath];
406   NSString *binDir = [bundle bundlePath];
407   NSString *resourcePath, *resourcePaths;
408   NSRange range;
409   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
410   NSFileManager *fileManager = [NSFileManager defaultManager];
411   NSArray *paths;
412   NSEnumerator *pathEnum;
413   BOOL isDir;
415   range = [resourceDir rangeOfString: @"Contents"];
416   if (range.location != NSNotFound)
417     {
418       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
419 #ifdef NS_IMPL_COCOA
420       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
421 #endif
422     }
424   paths = [binDir stringsByAppendingPaths:
425                 [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
426   pathEnum = [paths objectEnumerator];
427   resourcePaths = @"";
429   while ((resourcePath = [pathEnum nextObject]))
430     {
431       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
432         if (isDir)
433           {
434             if ([resourcePaths length] > 0)
435               resourcePaths
436                 = [resourcePaths stringByAppendingString: pathSeparator];
437             resourcePaths
438               = [resourcePaths stringByAppendingString: resourcePath];
439           }
440     }
441   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
443   return NULL;
447 const char *
448 ns_load_path (void)
449 /* If running as a self-contained app bundle, return as a path string
450    the filenames of the site-lisp, lisp and leim directories.
451    Ie, site-lisp:lisp:leim.  Otherwise, return nil.  */
453   NSBundle *bundle = [NSBundle mainBundle];
454   NSString *resourceDir = [bundle resourcePath];
455   NSString *resourcePath, *resourcePaths;
456   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
457   NSFileManager *fileManager = [NSFileManager defaultManager];
458   BOOL isDir;
459   NSArray *paths = [resourceDir stringsByAppendingPaths:
460                               [NSArray arrayWithObjects:
461                                          @"site-lisp", @"lisp", @"leim", nil]];
462   NSEnumerator *pathEnum = [paths objectEnumerator];
463   resourcePaths = @"";
465   /* Hack to skip site-lisp.  */
466   if (no_site_lisp) resourcePath = [pathEnum nextObject];
468   while ((resourcePath = [pathEnum nextObject]))
469     {
470       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
471         if (isDir)
472           {
473             if ([resourcePaths length] > 0)
474               resourcePaths
475                 = [resourcePaths stringByAppendingString: pathSeparator];
476             resourcePaths
477               = [resourcePaths stringByAppendingString: resourcePath];
478           }
479     }
480   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
482   return NULL;
485 static void
486 ns_timeout (int usecs)
487 /* --------------------------------------------------------------------------
488      Blocking timer utility used by ns_ring_bell
489    -------------------------------------------------------------------------- */
491   EMACS_TIME wakeup = add_emacs_time (current_emacs_time (),
492                                       make_emacs_time (0, usecs * 1000));
494   /* Keep waiting until past the time wakeup.  */
495   while (1)
496     {
497       EMACS_TIME timeout, now = current_emacs_time ();
498       if (EMACS_TIME_LE (wakeup, now))
499         break;
500       timeout = sub_emacs_time (wakeup, now);
502       /* Try to wait that long--but we might wake up sooner.  */
503       pselect (0, NULL, NULL, NULL, &timeout, NULL);
504     }
508 void
509 ns_release_object (void *obj)
510 /* --------------------------------------------------------------------------
511     Release an object (callable from C)
512    -------------------------------------------------------------------------- */
514     [(id)obj release];
518 void
519 ns_retain_object (void *obj)
520 /* --------------------------------------------------------------------------
521     Retain an object (callable from C)
522    -------------------------------------------------------------------------- */
524     [(id)obj retain];
528 void *
529 ns_alloc_autorelease_pool (void)
530 /* --------------------------------------------------------------------------
531      Allocate a pool for temporary objects (callable from C)
532    -------------------------------------------------------------------------- */
534   return [[NSAutoreleasePool alloc] init];
538 void
539 ns_release_autorelease_pool (void *pool)
540 /* --------------------------------------------------------------------------
541      Free a pool and temporary objects it refers to (callable from C)
542    -------------------------------------------------------------------------- */
544   ns_release_object (pool);
549 /* ==========================================================================
551     Focus (clipping) and screen update
553    ========================================================================== */
556 // Window constraining
557 // -------------------
559 // To ensure that the windows are not placed under the menu bar, they
560 // are typically moved by the call-back constrainFrameRect. However,
561 // by overriding it, it's possible to inhibit this, leaving the window
562 // in it's original position.
564 // It's possible to hide the menu bar. However, technically, it's only
565 // possible to hide it when the application is active. To ensure that
566 // this work properly, the menu bar and window constraining are
567 // deferred until the application becomes active.
569 // Even though it's not possible to manually move a window above the
570 // top of the screen, it is allowed if it's done programmatically,
571 // when the menu is hidden. This allows the editable area to cover the
572 // full screen height.
574 // Test cases
575 // ----------
577 // Use the following extra files:
579 //    init.el:
580 //       ;; Hide menu and place frame slightly above the top of the screen.
581 //       (setq ns-auto-hide-menu-bar t)
582 //       (set-frame-position (selected-frame) 0 -20)
584 // Test 1:
586 //    emacs -Q -l init.el
588 //    Result: No menu bar, and the title bar should be above the screen.
590 // Test 2:
592 //    emacs -Q
594 //    Result: Menu bar visible, frame placed immediately below the menu.
597 static void
598 ns_constrain_all_frames (void)
600   Lisp_Object tail, frame;
602   FOR_EACH_FRAME (tail, frame)
603     {
604       struct frame *f = XFRAME (frame);
605       if (FRAME_NS_P (f))
606         {
607           NSView *view = FRAME_NS_VIEW (f);
608           /* This no-op will trigger the default window placing
609            * constraint system. */
610           f->output_data.ns->dont_constrain = 0;
611           [[view window] setFrameOrigin:[[view window] frame].origin];
612         }
613     }
617 /* True, if the menu bar should be hidden.  */
619 static BOOL
620 ns_menu_bar_should_be_hidden (void)
622   return !NILP (ns_auto_hide_menu_bar)
623     && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
627 /* Show or hide the menu bar, based on user setting.  */
629 static void
630 ns_update_auto_hide_menu_bar (void)
632 #ifdef NS_IMPL_COCOA
633 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
634   block_input ();
636   NSTRACE (ns_update_auto_hide_menu_bar);
638   if (NSApp != nil
639       && [NSApp isActive]
640       && [NSApp respondsToSelector:@selector(setPresentationOptions:)])
641     {
642       // Note, "setPresentationOptions" triggers an error unless the
643       // application is active.
644       BOOL menu_bar_should_be_hidden = ns_menu_bar_should_be_hidden ();
646       if (menu_bar_should_be_hidden != ns_menu_bar_is_hidden)
647         {
648           NSApplicationPresentationOptions options
649             = NSApplicationPresentationAutoHideDock;
651           if (menu_bar_should_be_hidden)
652             options |= NSApplicationPresentationAutoHideMenuBar;
654           [NSApp setPresentationOptions: options];
656           ns_menu_bar_is_hidden = menu_bar_should_be_hidden;
658           if (!ns_menu_bar_is_hidden)
659             {
660               ns_constrain_all_frames ();
661             }
662         }
663     }
665   unblock_input ();
666 #endif
667 #endif
671 static void
672 ns_update_begin (struct frame *f)
673 /* --------------------------------------------------------------------------
674    Prepare for a grouped sequence of drawing calls
675    external (RIF) call; whole frame, called before update_window_begin
676    -------------------------------------------------------------------------- */
678   NSView *view = FRAME_NS_VIEW (f);
679   NSTRACE (ns_update_begin);
681   ns_update_auto_hide_menu_bar ();
683   ns_updating_frame = f;
684   [view lockFocus];
686   /* drawRect may have been called for say the minibuffer, and then clip path
687      is for the minibuffer.  But the display engine may draw more because
688      we have set the frame as garbaged.  So reset clip path to the whole
689      view.  */
690 #ifdef NS_IMPL_COCOA
691   {
692     NSBezierPath *bp;
693     NSRect r = [view frame];
694   bp = [[NSBezierPath bezierPathWithRect: r] retain];
695   [bp setClip];
696   [bp release];
697   }
698 #endif
700 #ifdef NS_IMPL_GNUSTEP
701   uRect = NSMakeRect (0, 0, 0, 0);
702 #endif
706 static void
707 ns_update_window_begin (struct window *w)
708 /* --------------------------------------------------------------------------
709    Prepare for a grouped sequence of drawing calls
710    external (RIF) call; for one window, called after update_begin
711    -------------------------------------------------------------------------- */
713   struct frame *f = XFRAME (WINDOW_FRAME (w));
714  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
715   NSTRACE (ns_update_window_begin);
716   updated_window = w;
717   set_output_cursor (&w->cursor);
719   block_input ();
721   if (f == hlinfo->mouse_face_mouse_frame)
722     {
723       /* Don't do highlighting for mouse motion during the update.  */
724       hlinfo->mouse_face_defer = 1;
726         /* If the frame needs to be redrawn,
727            simply forget about any prior mouse highlighting.  */
728       if (FRAME_GARBAGED_P (f))
729         hlinfo->mouse_face_window = Qnil;
731       /* (further code for mouse faces ifdef'd out in other terms elided) */
732     }
734   unblock_input ();
738 static void
739 ns_update_window_end (struct window *w, int cursor_on_p,
740                       int mouse_face_overwritten_p)
741 /* --------------------------------------------------------------------------
742    Finished a grouped sequence of drawing calls
743    external (RIF) call; for one window called before update_end
744    -------------------------------------------------------------------------- */
746   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
748   /* note: this fn is nearly identical in all terms */
749   if (!w->pseudo_window_p)
750     {
751       block_input ();
753       if (cursor_on_p)
754         display_and_set_cursor (w, 1,
755                                 output_cursor.hpos, output_cursor.vpos,
756                                 output_cursor.x, output_cursor.y);
758       if (draw_window_fringes (w, 1))
759         x_draw_vertical_border (w);
761       unblock_input ();
762     }
764   /* If a row with mouse-face was overwritten, arrange for
765      frame_up_to_date to redisplay the mouse highlight.  */
766   if (mouse_face_overwritten_p)
767     {
768       hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
769       hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
770       hlinfo->mouse_face_window = Qnil;
771     }
773   updated_window = NULL;
774   NSTRACE (update_window_end);
778 static void
779 ns_update_end (struct frame *f)
780 /* --------------------------------------------------------------------------
781    Finished a grouped sequence of drawing calls
782    external (RIF) call; for whole frame, called after update_window_end
783    -------------------------------------------------------------------------- */
785   EmacsView *view = FRAME_NS_VIEW (f);
787 /*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
788     MOUSE_HL_INFO (f)->mouse_face_defer = 0;
790     block_input ();
792   [view unlockFocus];
793   [[view window] flushWindow];
795   unblock_input ();
796   ns_updating_frame = NULL;
797   NSTRACE (ns_update_end);
801 static void
802 ns_flush (struct frame *f)
803 /* --------------------------------------------------------------------------
804    external (RIF) call
805    NS impl is no-op since currently we flush in ns_update_end and elsewhere
806    -------------------------------------------------------------------------- */
808     NSTRACE (ns_flush);
812 static void
813 ns_focus (struct frame *f, NSRect *r, int n)
814 /* --------------------------------------------------------------------------
815    Internal: Focus on given frame.  During small local updates this is used to
816      draw, however during large updates, ns_update_begin and ns_update_end are
817      called to wrap the whole thing, in which case these calls are stubbed out.
818      Except, on GNUstep, we accumulate the rectangle being drawn into, because
819      the back end won't do this automatically, and will just end up flushing
820      the entire window.
821    -------------------------------------------------------------------------- */
823 //  NSTRACE (ns_focus);
824 /* static int c =0;
825    fprintf (stderr, "focus: %d", c++);
826    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
827    fprintf (stderr, "\n"); */
829   if (f != ns_updating_frame)
830     {
831       NSView *view = FRAME_NS_VIEW (f);
832       if (view != focus_view)
833         {
834           if (focus_view != NULL)
835             {
836               [focus_view unlockFocus];
837               [[focus_view window] flushWindow];
838 /*debug_lock--; */
839             }
841           if (view)
842             [view lockFocus];
843           focus_view = view;
844 /*if (view) debug_lock++; */
845         }
846     }
848   /* clipping */
849   if (r)
850     {
851       [[NSGraphicsContext currentContext] saveGraphicsState];
852       if (n == 2)
853         NSRectClipList (r, 2);
854       else
855         NSRectClip (*r);
856       gsaved = YES;
857     }
861 static void
862 ns_unfocus (struct frame *f)
863 /* --------------------------------------------------------------------------
864      Internal: Remove focus on given frame
865    -------------------------------------------------------------------------- */
867 //  NSTRACE (ns_unfocus);
869   if (gsaved)
870     {
871       [[NSGraphicsContext currentContext] restoreGraphicsState];
872       gsaved = NO;
873     }
875   if (f != ns_updating_frame)
876     {
877       if (focus_view != NULL)
878         {
879           [focus_view unlockFocus];
880           [[focus_view window] flushWindow];
881           focus_view = NULL;
882 /*debug_lock--; */
883         }
884     }
888 static void
889 ns_clip_to_row (struct window *w, struct glyph_row *row, int area, BOOL gc)
890 /* --------------------------------------------------------------------------
891      Internal (but parallels other terms): Focus drawing on given row
892    -------------------------------------------------------------------------- */
894   struct frame *f = XFRAME (WINDOW_FRAME (w));
895   NSRect clip_rect;
896   int window_x, window_y, window_width;
898   window_box (w, area, &window_x, &window_y, &window_width, 0);
900   clip_rect.origin.x = window_x;
901   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
902   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
903   clip_rect.size.width = window_width;
904   clip_rect.size.height = row->visible_height;
906   ns_focus (f, &clip_rect, 1);
910 static void
911 ns_ring_bell (struct frame *f)
912 /* --------------------------------------------------------------------------
913      "Beep" routine
914    -------------------------------------------------------------------------- */
916   NSTRACE (ns_ring_bell);
917   if (visible_bell)
918     {
919       NSAutoreleasePool *pool;
920       struct frame *frame = SELECTED_FRAME ();
921       NSView *view;
923       block_input ();
924       pool = [[NSAutoreleasePool alloc] init];
926       view = FRAME_NS_VIEW (frame);
927       if (view != nil)
928         {
929           NSRect r, surr;
930           NSPoint dim = NSMakePoint (128, 128);
932           r = [view bounds];
933           r.origin.x += (r.size.width - dim.x) / 2;
934           r.origin.y += (r.size.height - dim.y) / 2;
935           r.size.width = dim.x;
936           r.size.height = dim.y;
937           surr = NSInsetRect (r, -2, -2);
938           ns_focus (frame, &surr, 1);
939           [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
940           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
941                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
942           NSRectFill (r);
943           [[view window] flushWindow];
944           ns_timeout (150000);
945           [[view window] restoreCachedImage];
946           [[view window] flushWindow];
947           ns_unfocus (frame);
948         }
949       [pool release];
950       unblock_input ();
951     }
952   else
953     {
954       NSBeep ();
955     }
959 static void
960 ns_reset_terminal_modes (struct terminal *terminal)
961 /*  Externally called as hook */
963   NSTRACE (ns_reset_terminal_modes);
967 static void
968 ns_set_terminal_modes (struct terminal *terminal)
969 /*  Externally called as hook */
971   NSTRACE (ns_set_terminal_modes);
976 /* ==========================================================================
978     Frame / window manager related functions
980    ========================================================================== */
983 static void
984 ns_raise_frame (struct frame *f)
985 /* --------------------------------------------------------------------------
986      Bring window to foreground and make it active
987    -------------------------------------------------------------------------- */
989   NSView *view;
990   check_window_system (f);
991   view = FRAME_NS_VIEW (f);
992   block_input ();
993   if (FRAME_VISIBLE_P (f))
994     [[view window] makeKeyAndOrderFront: NSApp];
995   unblock_input ();
999 static void
1000 ns_lower_frame (struct frame *f)
1001 /* --------------------------------------------------------------------------
1002      Send window to back
1003    -------------------------------------------------------------------------- */
1005   NSView *view;
1006   check_window_system (f);
1007   view = FRAME_NS_VIEW (f);
1008   block_input ();
1009   [[view window] orderBack: NSApp];
1010   unblock_input ();
1014 static void
1015 ns_frame_raise_lower (struct frame *f, int raise)
1016 /* --------------------------------------------------------------------------
1017      External (hook)
1018    -------------------------------------------------------------------------- */
1020   NSTRACE (ns_frame_raise_lower);
1022   if (raise)
1023     ns_raise_frame (f);
1024   else
1025     ns_lower_frame (f);
1029 static void
1030 ns_frame_rehighlight (struct frame *frame)
1031 /* --------------------------------------------------------------------------
1032      External (hook): called on things like window switching within frame
1033    -------------------------------------------------------------------------- */
1035   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
1036   struct frame *old_highlight = dpyinfo->x_highlight_frame;
1038   NSTRACE (ns_frame_rehighlight);
1039   if (dpyinfo->x_focus_frame)
1040     {
1041       dpyinfo->x_highlight_frame
1042         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1043            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1044            : dpyinfo->x_focus_frame);
1045       if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
1046         {
1047           fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
1048           dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
1049         }
1050     }
1051   else
1052       dpyinfo->x_highlight_frame = 0;
1054   if (dpyinfo->x_highlight_frame &&
1055          dpyinfo->x_highlight_frame != old_highlight)
1056     {
1057       if (old_highlight)
1058         {
1059           x_update_cursor (old_highlight, 1);
1060           x_set_frame_alpha (old_highlight);
1061         }
1062       if (dpyinfo->x_highlight_frame)
1063         {
1064           x_update_cursor (dpyinfo->x_highlight_frame, 1);
1065           x_set_frame_alpha (dpyinfo->x_highlight_frame);
1066         }
1067     }
1071 void
1072 x_make_frame_visible (struct frame *f)
1073 /* --------------------------------------------------------------------------
1074      External: Show the window (X11 semantics)
1075    -------------------------------------------------------------------------- */
1077   NSTRACE (x_make_frame_visible);
1078   /* XXX: at some points in past this was not needed, as the only place that
1079      called this (frame.c:Fraise_frame ()) also called raise_lower;
1080      if this ends up the case again, comment this out again. */
1081   if (!FRAME_VISIBLE_P (f))
1082     {
1083       EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1085       SET_FRAME_VISIBLE (f, 1);
1086       ns_raise_frame (f);
1088       /* Making a new frame from a fullscreen frame will make the new frame
1089          fullscreen also.  So skip handleFS as this will print an error.  */
1090       if ([view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH
1091           && [view isFullscreen])
1092         return;
1094       if (f->want_fullscreen != FULLSCREEN_NONE)
1095         {
1096           block_input ();
1097           [view handleFS];
1098           unblock_input ();
1099         }
1100     }
1104 void
1105 x_make_frame_invisible (struct frame *f)
1106 /* --------------------------------------------------------------------------
1107      External: Hide the window (X11 semantics)
1108    -------------------------------------------------------------------------- */
1110   NSView *view;
1111   NSTRACE (x_make_frame_invisible);
1112   check_window_system (f);
1113   view = FRAME_NS_VIEW (f);
1114   [[view window] orderOut: NSApp];
1115   SET_FRAME_VISIBLE (f, 0);
1116   SET_FRAME_ICONIFIED (f, 0);
1120 void
1121 x_iconify_frame (struct frame *f)
1122 /* --------------------------------------------------------------------------
1123      External: Iconify window
1124    -------------------------------------------------------------------------- */
1126   NSView *view;
1127   struct ns_display_info *dpyinfo;
1129   NSTRACE (x_iconify_frame);
1130   check_window_system (f);
1131   view = FRAME_NS_VIEW (f);
1132   dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1134   if (dpyinfo->x_highlight_frame == f)
1135     dpyinfo->x_highlight_frame = 0;
1137   if ([[view window] windowNumber] <= 0)
1138     {
1139       /* the window is still deferred.  Make it very small, bring it
1140          on screen and order it out. */
1141       NSRect s = { { 100, 100}, {0, 0} };
1142       NSRect t;
1143       t = [[view window] frame];
1144       [[view window] setFrame: s display: NO];
1145       [[view window] orderBack: NSApp];
1146       [[view window] orderOut: NSApp];
1147       [[view window] setFrame: t display: NO];
1148     }
1149   [[view window] miniaturize: NSApp];
1152 /* Free X resources of frame F.  */
1154 void
1155 x_free_frame_resources (struct frame *f)
1157   NSView *view;
1158   struct ns_display_info *dpyinfo;
1159   Mouse_HLInfo *hlinfo;
1161   NSTRACE (x_free_frame_resources);
1162   check_window_system (f);
1163   view = FRAME_NS_VIEW (f);
1164   dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1165   hlinfo = MOUSE_HL_INFO (f);
1167   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1169   block_input ();
1171   free_frame_menubar (f);
1173   if (FRAME_FACE_CACHE (f))
1174     free_frame_faces (f);
1176   if (f == dpyinfo->x_focus_frame)
1177     dpyinfo->x_focus_frame = 0;
1178   if (f == dpyinfo->x_highlight_frame)
1179     dpyinfo->x_highlight_frame = 0;
1180   if (f == hlinfo->mouse_face_mouse_frame)
1181     {
1182       hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
1183       hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
1184       hlinfo->mouse_face_window = Qnil;
1185       hlinfo->mouse_face_mouse_frame = 0;
1186     }
1188   if (f->output_data.ns->miniimage != nil)
1189     [f->output_data.ns->miniimage release];
1191   [[view window] close];
1192   [view release];
1194   xfree (f->output_data.ns);
1196   unblock_input ();
1199 void
1200 x_destroy_window (struct frame *f)
1201 /* --------------------------------------------------------------------------
1202      External: Delete the window
1203    -------------------------------------------------------------------------- */
1205   NSTRACE (x_destroy_window);
1206   check_window_system (f);
1207   x_free_frame_resources (f);
1208   ns_window_num--;
1212 void
1213 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1214 /* --------------------------------------------------------------------------
1215      External: Position the window
1216    -------------------------------------------------------------------------- */
1218   NSView *view = FRAME_NS_VIEW (f);
1219   NSArray *screens = [NSScreen screens];
1220   NSScreen *fscreen = [screens objectAtIndex: 0];
1221   NSScreen *screen = [[view window] screen];
1223   NSTRACE (x_set_offset);
1225   block_input ();
1227   f->left_pos = xoff;
1228   f->top_pos = yoff;
1230   if (view != nil && screen && fscreen)
1231     {
1232       f->left_pos = f->size_hint_flags & XNegative
1233         ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
1234         : f->left_pos;
1235       /* We use visibleFrame here to take menu bar into account.
1236          Ideally we should also adjust left/top with visibleFrame.origin.  */
1238       f->top_pos = f->size_hint_flags & YNegative
1239         ? ([screen visibleFrame].size.height + f->top_pos
1240            - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
1241            - FRAME_TOOLBAR_HEIGHT (f))
1242         : f->top_pos;
1243 #ifdef NS_IMPL_GNUSTEP
1244       if (f->left_pos < 100)
1245         f->left_pos = 100;  /* don't overlap menu */
1246 #endif
1247       /* Constrain the setFrameTopLeftPoint so we don't move behind the
1248          menu bar.  */
1249       f->output_data.ns->dont_constrain = 0;
1250       [[view window] setFrameTopLeftPoint:
1251                        NSMakePoint (SCREENMAXBOUND (f->left_pos),
1252                                     SCREENMAXBOUND ([fscreen frame].size.height
1253                                                     - NS_TOP_POS (f)))];
1254       f->size_hint_flags &= ~(XNegative|YNegative);
1255     }
1257   unblock_input ();
1261 void
1262 x_set_window_size (struct frame *f, int change_grav, int cols, int rows)
1263 /* --------------------------------------------------------------------------
1264      Adjust window pixel size based on given character grid size
1265      Impl is a bit more complex than other terms, need to do some
1266      internal clipping.
1267    -------------------------------------------------------------------------- */
1269   EmacsView *view = FRAME_NS_VIEW (f);
1270   NSWindow *window = [view window];
1271   NSRect wr = [window frame];
1272   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1273   int pixelwidth, pixelheight;
1275   NSTRACE (x_set_window_size);
1277   if (view == nil)
1278     return;
1280 /*fprintf (stderr, "\tsetWindowSize: %d x %d, font size %d x %d\n", cols, rows, FRAME_COLUMN_WIDTH (f), FRAME_LINE_HEIGHT (f)); */
1282   block_input ();
1284   check_frame_size (f, &rows, &cols);
1286   f->scroll_bar_actual_width = NS_SCROLL_BAR_WIDTH (f);
1287   compute_fringe_widths (f, 0);
1289   pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, cols);
1290   pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
1292   /* If we have a toolbar, take its height into account. */
1293   if (tb && ! [view isFullscreen])
1294     {
1295     /* NOTE: previously this would generate wrong result if toolbar not
1296              yet displayed and fixing toolbar_height=32 helped, but
1297              now (200903) seems no longer needed */
1298     FRAME_TOOLBAR_HEIGHT (f) =
1299       NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1300         - FRAME_NS_TITLEBAR_HEIGHT (f);
1301 #ifdef NS_IMPL_GNUSTEP
1302       FRAME_TOOLBAR_HEIGHT (f) -= 3;
1303 #endif
1304     }
1305   else
1306     FRAME_TOOLBAR_HEIGHT (f) = 0;
1308   wr.size.width = pixelwidth + f->border_width;
1309   wr.size.height = pixelheight;
1310   if (! [view isFullscreen])
1311     wr.size.height += FRAME_NS_TITLEBAR_HEIGHT (f)
1312       + FRAME_TOOLBAR_HEIGHT (f);
1314   /* Do not try to constrain to this screen.  We may have multiple
1315      screens, and want Emacs to span those.  Constraining to screen
1316      prevents that, and that is not nice to the user.  */
1317  if (f->output_data.ns->zooming)
1318    f->output_data.ns->zooming = 0;
1319  else
1320    wr.origin.y += FRAME_PIXEL_HEIGHT (f) - pixelheight;
1322   [view setRows: rows andColumns: cols];
1323   [window setFrame: wr display: YES];
1325 /*fprintf (stderr, "\tx_set_window_size %d, %d\t%d, %d\n", cols, rows, pixelwidth, pixelheight); */
1327   /* This is a trick to compensate for Emacs' managing the scrollbar area
1328      as a fixed number of standard character columns.  Instead of leaving
1329      blank space for the extra, we chopped it off above.  Now for
1330      left-hand scrollbars, we shift all rendering to the left by the
1331      difference between the real width and Emacs' imagined one.  For
1332      right-hand bars, don't worry about it since the extra is never used.
1333      (Obviously doesn't work for vertically split windows tho..) */
1334   {
1335     NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1336       ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1337                      - NS_SCROLL_BAR_WIDTH (f), 0)
1338       : NSMakePoint (0, 0);
1339     [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1340     [view setBoundsOrigin: origin];
1341   }
1343   change_frame_size (f, rows, cols, 0, 1, 0); /* pretend, delay, safe */
1344   FRAME_PIXEL_WIDTH (f) = pixelwidth;
1345   FRAME_PIXEL_HEIGHT (f) = pixelheight;
1346 /*  SET_FRAME_GARBAGED (f); // this short-circuits expose call in drawRect */
1348   mark_window_cursors_off (XWINDOW (f->root_window));
1349   cancel_mouse_face (f);
1351   unblock_input ();
1355 static void
1356 ns_fullscreen_hook (FRAME_PTR f)
1358   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1360   if (!FRAME_VISIBLE_P (f))
1361     return;
1363    if (! [view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH)
1364     {
1365       /* Old style fs don't initiate correctly if created from
1366          init/default-frame alist, so use a timer (not nice...).
1367       */
1368       [NSTimer scheduledTimerWithTimeInterval: 0.5 target: view
1369                                      selector: @selector (handleFS)
1370                                      userInfo: nil repeats: NO];
1371       return;
1372     }
1374   block_input ();
1375   [view handleFS];
1376   unblock_input ();
1379 /* ==========================================================================
1381     Color management
1383    ========================================================================== */
1386 NSColor *
1387 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1389   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1390   if (idx < 1 || idx >= color_table->avail)
1391     return nil;
1392   return color_table->colors[idx];
1396 unsigned long
1397 ns_index_color (NSColor *color, struct frame *f)
1399   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1400   ptrdiff_t idx;
1401   ptrdiff_t i;
1403   if (!color_table->colors)
1404     {
1405       color_table->size = NS_COLOR_CAPACITY;
1406       color_table->avail = 1; /* skip idx=0 as marker */
1407       color_table->colors = xmalloc (color_table->size * sizeof (NSColor *));
1408       color_table->colors[0] = nil;
1409       color_table->empty_indices = [[NSMutableSet alloc] init];
1410     }
1412   /* do we already have this color ? */
1413   for (i = 1; i < color_table->avail; i++)
1414     if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1415       return i;
1417   if ([color_table->empty_indices count] > 0)
1418     {
1419       NSNumber *index = [color_table->empty_indices anyObject];
1420       [color_table->empty_indices removeObject: index];
1421       idx = [index unsignedLongValue];
1422     }
1423   else
1424     {
1425       if (color_table->avail == color_table->size)
1426         color_table->colors =
1427           xpalloc (color_table->colors, &color_table->size, 1,
1428                    min (ULONG_MAX, PTRDIFF_MAX), sizeof *color_table->colors);
1429       idx = color_table->avail++;
1430     }
1432   color_table->colors[idx] = color;
1433   [color retain];
1434 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1435   return idx;
1439 void
1440 ns_free_indexed_color (unsigned long idx, struct frame *f)
1442   struct ns_color_table *color_table;
1443   NSColor *color;
1444   NSNumber *index;
1446   if (!f)
1447     return;
1449   color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1451   if (idx <= 0 || idx >= color_table->size) {
1452     message1 ("ns_free_indexed_color: Color index out of range.\n");
1453     return;
1454   }
1456   index = [NSNumber numberWithUnsignedInt: idx];
1457   if ([color_table->empty_indices containsObject: index]) {
1458     message1 ("ns_free_indexed_color: attempt to free already freed color.\n");
1459     return;
1460   }
1462   color = color_table->colors[idx];
1463   [color release];
1464   color_table->colors[idx] = nil;
1465   [color_table->empty_indices addObject: index];
1466 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1470 static int
1471 ns_get_color (const char *name, NSColor **col)
1472 /* --------------------------------------------------------------------------
1473      Parse a color name
1474    -------------------------------------------------------------------------- */
1475 /* On *Step, we attempt to mimic the X11 platform here, down to installing an
1476    X11 rgb.txt-compatible color list in Emacs.clr (see ns_term_init()).
1477    See: http://thread.gmane.org/gmane.emacs.devel/113050/focus=113272). */
1479   NSColor *new = nil;
1480   static char hex[20];
1481   int scaling;
1482   float r = -1.0, g, b;
1483   NSString *nsname = [NSString stringWithUTF8String: name];
1485 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1486   block_input ();
1488   if ([nsname isEqualToString: @"ns_selection_color"])
1489     {
1490       nsname = ns_selection_color;
1491       name = [ns_selection_color UTF8String];
1492     }
1494   /* First, check for some sort of numeric specification. */
1495   hex[0] = '\0';
1497   if (name[0] == '0' || name[0] == '1' || name[0] == '.')  /* RGB decimal */
1498     {
1499       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1500       [scanner scanFloat: &r];
1501       [scanner scanFloat: &g];
1502       [scanner scanFloat: &b];
1503     }
1504   else if (!strncmp(name, "rgb:", 4))  /* A newer X11 format -- rgb:r/g/b */
1505     scaling = (snprintf (hex, sizeof hex, "%s", name + 4) - 2) / 3;
1506   else if (name[0] == '#')        /* An old X11 format; convert to newer */
1507     {
1508       int len = (strlen(name) - 1);
1509       int start = (len % 3 == 0) ? 1 : len / 4 + 1;
1510       int i;
1511       scaling = strlen(name+start) / 3;
1512       for (i = 0; i < 3; i++)
1513         sprintf (hex + i * (scaling + 1), "%.*s/", scaling,
1514                  name + start + i * scaling);
1515       hex[3 * (scaling + 1) - 1] = '\0';
1516     }
1518   if (hex[0])
1519     {
1520       int rr, gg, bb;
1521       float fscale = scaling == 4 ? 65535.0 : (scaling == 2 ? 255.0 : 15.0);
1522       if (sscanf (hex, "%x/%x/%x", &rr, &gg, &bb))
1523         {
1524           r = rr / fscale;
1525           g = gg / fscale;
1526           b = bb / fscale;
1527         }
1528     }
1530   if (r >= 0.0F)
1531     {
1532       *col = [NSColor colorWithCalibratedRed: r green: g blue: b alpha: 1.0];
1533       unblock_input ();
1534       return 0;
1535     }
1537   /* Otherwise, color is expected to be from a list */
1538   {
1539     NSEnumerator *lenum, *cenum;
1540     NSString *name;
1541     NSColorList *clist;
1543 #ifdef NS_IMPL_GNUSTEP
1544     /* XXX: who is wrong, the requestor or the implementation? */
1545     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1546         == NSOrderedSame)
1547       nsname = @"highlightColor";
1548 #endif
1550     lenum = [[NSColorList availableColorLists] objectEnumerator];
1551     while ( (clist = [lenum nextObject]) && new == nil)
1552       {
1553         cenum = [[clist allKeys] objectEnumerator];
1554         while ( (name = [cenum nextObject]) && new == nil )
1555           {
1556             if ([name compare: nsname
1557                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1558               new = [clist colorWithKey: name];
1559           }
1560       }
1561   }
1563   if (new)
1564     *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1565   unblock_input ();
1566   return new ? 0 : 1;
1571 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1572 /* --------------------------------------------------------------------------
1573      Convert a Lisp string object to a NS color
1574    -------------------------------------------------------------------------- */
1576   NSTRACE (ns_lisp_to_color);
1577   if (STRINGP (color))
1578     return ns_get_color (SSDATA (color), col);
1579   else if (SYMBOLP (color))
1580     return ns_get_color (SSDATA (SYMBOL_NAME (color)), col);
1581   return 1;
1585 Lisp_Object
1586 ns_color_to_lisp (NSColor *col)
1587 /* --------------------------------------------------------------------------
1588      Convert a color to a lisp string with the RGB equivalent
1589    -------------------------------------------------------------------------- */
1591   EmacsCGFloat red, green, blue, alpha, gray;
1592   char buf[1024];
1593   const char *str;
1594   NSTRACE (ns_color_to_lisp);
1596   block_input ();
1597   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1599       if ((str =[[col colorNameComponent] UTF8String]))
1600         {
1601           unblock_input ();
1602           return build_string ((char *)str);
1603         }
1605     [[col colorUsingColorSpaceName: NSCalibratedRGBColorSpace]
1606         getRed: &red green: &green blue: &blue alpha: &alpha];
1607   if (red ==green && red ==blue)
1608     {
1609       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1610             getWhite: &gray alpha: &alpha];
1611       snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1612                 lrint (gray * 0xff), lrint (gray * 0xff), lrint (gray * 0xff));
1613       unblock_input ();
1614       return build_string (buf);
1615     }
1617   snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1618             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1620   unblock_input ();
1621   return build_string (buf);
1625 void
1626 ns_query_color(void *col, XColor *color_def, int setPixel)
1627 /* --------------------------------------------------------------------------
1628          Get ARGB values out of NSColor col and put them into color_def.
1629          If setPixel, set the pixel to a concatenated version.
1630          and set color_def pixel to the resulting index.
1631    -------------------------------------------------------------------------- */
1633   EmacsCGFloat r, g, b, a;
1635   [((NSColor *)col) getRed: &r green: &g blue: &b alpha: &a];
1636   color_def->red   = r * 65535;
1637   color_def->green = g * 65535;
1638   color_def->blue  = b * 65535;
1640   if (setPixel == YES)
1641     color_def->pixel
1642       = ARGB_TO_ULONG((int)(a*255),
1643                       (int)(r*255), (int)(g*255), (int)(b*255));
1647 bool
1648 ns_defined_color (struct frame *f,
1649                   const char *name,
1650                   XColor *color_def,
1651                   bool alloc,
1652                   bool makeIndex)
1653 /* --------------------------------------------------------------------------
1654          Return true if named color found, and set color_def rgb accordingly.
1655          If makeIndex and alloc are nonzero put the color in the color_table,
1656          and set color_def pixel to the resulting index.
1657          If makeIndex is zero, set color_def pixel to ARGB.
1658          Return false if not found
1659    -------------------------------------------------------------------------- */
1661   NSColor *col;
1662   NSTRACE (ns_defined_color);
1664   block_input ();
1665   if (ns_get_color (name, &col) != 0) /* Color not found  */
1666     {
1667       unblock_input ();
1668       return 0;
1669     }
1670   if (makeIndex && alloc)
1671     color_def->pixel = ns_index_color (col, f);
1672   ns_query_color (col, color_def, !makeIndex);
1673   unblock_input ();
1674   return 1;
1678 void
1679 x_set_frame_alpha (struct frame *f)
1680 /* --------------------------------------------------------------------------
1681      change the entire-frame transparency
1682    -------------------------------------------------------------------------- */
1684   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1685   double alpha = 1.0;
1686   double alpha_min = 1.0;
1688   if (dpyinfo->x_highlight_frame == f)
1689     alpha = f->alpha[0];
1690   else
1691     alpha = f->alpha[1];
1693   if (FLOATP (Vframe_alpha_lower_limit))
1694     alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
1695   else if (INTEGERP (Vframe_alpha_lower_limit))
1696     alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
1698   if (alpha < 0.0)
1699     return;
1700   else if (1.0 < alpha)
1701     alpha = 1.0;
1702   else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
1703     alpha = alpha_min;
1705 #ifdef NS_IMPL_COCOA
1706   {
1707     EmacsView *view = FRAME_NS_VIEW (f);
1708   [[view window] setAlphaValue: alpha];
1709   }
1710 #endif
1714 /* ==========================================================================
1716     Mouse handling
1718    ========================================================================== */
1721 void
1722 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1723 /* --------------------------------------------------------------------------
1724      Programmatically reposition mouse pointer in pixel coordinates
1725    -------------------------------------------------------------------------- */
1727   NSTRACE (x_set_mouse_pixel_position);
1728   ns_raise_frame (f);
1729 #if 0
1730   /* FIXME: this does not work, and what about GNUstep? */
1731 #ifdef NS_IMPL_COCOA
1732   [FRAME_NS_VIEW (f) lockFocus];
1733   PSsetmouse ((float)pix_x, (float)pix_y);
1734   [FRAME_NS_VIEW (f) unlockFocus];
1735 #endif
1736 #endif
1740 void
1741 x_set_mouse_position (struct frame *f, int h, int v)
1742 /* --------------------------------------------------------------------------
1743      Programmatically reposition mouse pointer in character coordinates
1744    -------------------------------------------------------------------------- */
1746   int pix_x, pix_y;
1748   pix_x = FRAME_COL_TO_PIXEL_X (f, h) + FRAME_COLUMN_WIDTH (f) / 2;
1749   pix_y = FRAME_LINE_TO_PIXEL_Y (f, v) + FRAME_LINE_HEIGHT (f) / 2;
1751   if (pix_x < 0) pix_x = 0;
1752   if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
1754   if (pix_y < 0) pix_y = 0;
1755   if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
1757   x_set_mouse_pixel_position (f, pix_x, pix_y);
1761 static int
1762 note_mouse_movement (struct frame *frame, CGFloat x, CGFloat y)
1763 /*   ------------------------------------------------------------------------
1764      Called by EmacsView on mouseMovement events.  Passes on
1765      to emacs mainstream code if we moved off of a rect of interest
1766      known as last_mouse_glyph.
1767      ------------------------------------------------------------------------ */
1769 //  NSTRACE (note_mouse_movement);
1771   XSETFRAME (last_mouse_motion_frame, frame);
1773   /* Note, this doesn't get called for enter/leave, since we don't have a
1774      position.  Those are taken care of in the corresponding NSView methods. */
1776   /* has movement gone beyond last rect we were tracking? */
1777   if (x < last_mouse_glyph.origin.x ||
1778       x >= (last_mouse_glyph.origin.x + last_mouse_glyph.size.width) ||
1779       y < last_mouse_glyph.origin.y ||
1780       y >= (last_mouse_glyph.origin.y + last_mouse_glyph.size.height))
1781     {
1782       ns_update_begin(frame);
1783       frame->mouse_moved = 1;
1784       note_mouse_highlight (frame, x, y);
1785       remember_mouse_glyph (frame, x, y, &last_mouse_glyph);
1786       ns_update_end(frame);
1787       return 1;
1788     }
1790   return 0;
1794 static void
1795 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1796                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1797                    Time *time)
1798 /* --------------------------------------------------------------------------
1799     External (hook): inform emacs about mouse position and hit parts.
1800     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1801     x & y should be position in the scrollbar (the whole bar, not the handle)
1802     and length of scrollbar respectively
1803    -------------------------------------------------------------------------- */
1805   id view;
1806   NSPoint position;
1807   Lisp_Object frame, tail;
1808   struct frame *f;
1809   struct ns_display_info *dpyinfo;
1811   NSTRACE (ns_mouse_position);
1813   if (*fp == NULL)
1814     {
1815       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1816       return;
1817     }
1819   dpyinfo = FRAME_NS_DISPLAY_INFO (*fp);
1821   block_input ();
1823   if (last_mouse_scroll_bar != nil && insist == 0)
1824     {
1825       /* TODO: we do not use this path at the moment because drag events will
1826            go directly to the EmacsScroller.  Leaving code in for now. */
1827       [last_mouse_scroll_bar getMouseMotionPart: (int *)part window: bar_window
1828                                               x: x y: y];
1829       if (time) *time = last_mouse_movement_time;
1830       last_mouse_scroll_bar = nil;
1831     }
1832   else
1833     {
1834       /* Clear the mouse-moved flag for every frame on this display.  */
1835       FOR_EACH_FRAME (tail, frame)
1836         if (FRAME_NS_P (XFRAME (frame))
1837             && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1838           XFRAME (frame)->mouse_moved = 0;
1840       last_mouse_scroll_bar = nil;
1841       if (last_mouse_frame && FRAME_LIVE_P (last_mouse_frame))
1842         f = last_mouse_frame;
1843       else
1844         f = dpyinfo->x_focus_frame ? dpyinfo->x_focus_frame
1845                                     : SELECTED_FRAME ();
1847       if (f && FRAME_NS_P (f))
1848         {
1849           view = FRAME_NS_VIEW (*fp);
1851           position = [[view window] mouseLocationOutsideOfEventStream];
1852           position = [view convertPoint: position fromView: nil];
1853           remember_mouse_glyph (f, position.x, position.y, &last_mouse_glyph);
1854 /*fprintf (stderr, "ns_mouse_position: %.0f, %.0f\n", position.x, position.y); */
1856           if (bar_window) *bar_window = Qnil;
1857           if (part) *part = 0; /*scroll_bar_handle; */
1859           if (x) XSETINT (*x, lrint (position.x));
1860           if (y) XSETINT (*y, lrint (position.y));
1861           if (time) *time = last_mouse_movement_time;
1862           *fp = f;
1863         }
1864     }
1866   unblock_input ();
1870 static void
1871 ns_frame_up_to_date (struct frame *f)
1872 /* --------------------------------------------------------------------------
1873     External (hook): Fix up mouse highlighting right after a full update.
1874     Can't use FRAME_MOUSE_UPDATE due to ns_frame_begin and ns_frame_end calls.
1875    -------------------------------------------------------------------------- */
1877   NSTRACE (ns_frame_up_to_date);
1879   if (FRAME_NS_P (f))
1880     {
1881       Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1882       if (f == hlinfo->mouse_face_mouse_frame)
1883         {
1884           block_input ();
1885           ns_update_begin(f);
1886           if (hlinfo->mouse_face_mouse_frame)
1887             note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
1888                                   hlinfo->mouse_face_mouse_x,
1889                                   hlinfo->mouse_face_mouse_y);
1890           ns_update_end(f);
1891           unblock_input ();
1892         }
1893     }
1897 static void
1898 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1899 /* --------------------------------------------------------------------------
1900     External (RIF): set frame mouse pointer type.
1901    -------------------------------------------------------------------------- */
1903   NSTRACE (ns_define_frame_cursor);
1904   if (FRAME_POINTER_TYPE (f) != cursor)
1905     {
1906       EmacsView *view = FRAME_NS_VIEW (f);
1907       FRAME_POINTER_TYPE (f) = cursor;
1908       [[view window] invalidateCursorRectsForView: view];
1909       /* Redisplay assumes this function also draws the changed frame
1910          cursor, but this function doesn't, so do it explicitly.  */
1911       x_update_cursor (f, 1);
1912     }
1917 /* ==========================================================================
1919     Keyboard handling
1921    ========================================================================== */
1924 static unsigned
1925 ns_convert_key (unsigned code)
1926 /* --------------------------------------------------------------------------
1927     Internal call used by NSView-keyDown.
1928    -------------------------------------------------------------------------- */
1930   const unsigned last_keysym = (sizeof (convert_ns_to_X_keysym)
1931                                 / sizeof (convert_ns_to_X_keysym[0]));
1932   unsigned keysym;
1933   /* An array would be faster, but less easy to read. */
1934   for (keysym = 0; keysym < last_keysym; keysym += 2)
1935     if (code == convert_ns_to_X_keysym[keysym])
1936       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
1937   return 0;
1938 /* if decide to use keyCode and Carbon table, use this line:
1939      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
1943 char *
1944 x_get_keysym_name (int keysym)
1945 /* --------------------------------------------------------------------------
1946     Called by keyboard.c.  Not sure if the return val is important, except
1947     that it be unique.
1948    -------------------------------------------------------------------------- */
1950   static char value[16];
1951   NSTRACE (x_get_keysym_name);
1952   sprintf (value, "%d", keysym);
1953   return value;
1958 /* ==========================================================================
1960     Block drawing operations
1962    ========================================================================== */
1965 static void
1966 ns_redraw_scroll_bars (struct frame *f)
1968   int i;
1969   id view;
1970   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
1971   NSTRACE (ns_redraw_scroll_bars);
1972   for (i =[subviews count]-1; i >= 0; i--)
1973     {
1974       view = [subviews objectAtIndex: i];
1975       if (![view isKindOfClass: [EmacsScroller class]]) continue;
1976       [view display];
1977     }
1981 void
1982 ns_clear_frame (struct frame *f)
1983 /* --------------------------------------------------------------------------
1984       External (hook): Erase the entire frame
1985    -------------------------------------------------------------------------- */
1987   NSView *view = FRAME_NS_VIEW (f);
1988   NSRect r;
1990   NSTRACE (ns_clear_frame);
1992  /* comes on initial frame because we have
1993     after-make-frame-functions = select-frame */
1994  if (!FRAME_DEFAULT_FACE (f))
1995    return;
1997   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
1999   output_cursor.hpos = output_cursor.vpos = 0;
2000   output_cursor.x = -1;
2002   r = [view bounds];
2004   block_input ();
2005   ns_focus (f, &r, 1);
2006   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
2007   NSRectFill (r);
2008   ns_unfocus (f);
2010   /* as of 2006/11 or so this is now needed */
2011   ns_redraw_scroll_bars (f);
2012   unblock_input ();
2016 static void
2017 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
2018 /* --------------------------------------------------------------------------
2019     External (RIF):  Clear section of frame
2020    -------------------------------------------------------------------------- */
2022   NSRect r = NSMakeRect (x, y, width, height);
2023   NSView *view = FRAME_NS_VIEW (f);
2024   struct face *face = FRAME_DEFAULT_FACE (f);
2026   if (!view || !face)
2027     return;
2029   NSTRACE (ns_clear_frame_area);
2031   r = NSIntersectionRect (r, [view frame]);
2032   ns_focus (f, &r, 1);
2033   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
2035   NSRectFill (r);
2037   ns_unfocus (f);
2038   return;
2042 static void
2043 ns_scroll_run (struct window *w, struct run *run)
2044 /* --------------------------------------------------------------------------
2045     External (RIF):  Insert or delete n lines at line vpos
2046    -------------------------------------------------------------------------- */
2048   struct frame *f = XFRAME (w->frame);
2049   int x, y, width, height, from_y, to_y, bottom_y;
2051   NSTRACE (ns_scroll_run);
2053   /* begin copy from other terms */
2054   /* Get frame-relative bounding box of the text display area of W,
2055      without mode lines.  Include in this box the left and right
2056      fringe of W.  */
2057   window_box (w, -1, &x, &y, &width, &height);
2059   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
2060   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
2061   bottom_y = y + height;
2063   if (to_y < from_y)
2064     {
2065       /* Scrolling up.  Make sure we don't copy part of the mode
2066          line at the bottom.  */
2067       if (from_y + run->height > bottom_y)
2068         height = bottom_y - from_y;
2069       else
2070         height = run->height;
2071     }
2072   else
2073     {
2074       /* Scrolling down.  Make sure we don't copy over the mode line.
2075          at the bottom.  */
2076       if (to_y + run->height > bottom_y)
2077         height = bottom_y - to_y;
2078       else
2079         height = run->height;
2080     }
2081   /* end copy from other terms */
2083   if (height == 0)
2084       return;
2086   block_input ();
2088   updated_window = w;
2089   x_clear_cursor (w);
2091   {
2092     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2093     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2094     NSPoint dstOrigin = NSMakePoint (x, to_y);
2096     ns_focus (f, &dstRect, 1);
2097     NSCopyBits (0, srcRect , dstOrigin);
2098     ns_unfocus (f);
2099   }
2101   unblock_input ();
2105 static void
2106 ns_after_update_window_line (struct glyph_row *desired_row)
2107 /* --------------------------------------------------------------------------
2108     External (RIF): preparatory to fringe update after text was updated
2109    -------------------------------------------------------------------------- */
2111   struct window *w = updated_window;
2112   struct frame *f;
2113   int width, height;
2115   NSTRACE (ns_after_update_window_line);
2117   /* begin copy from other terms */
2118   eassert (w);
2120   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2121     desired_row->redraw_fringe_bitmaps_p = 1;
2123   /* When a window has disappeared, make sure that no rest of
2124      full-width rows stays visible in the internal border.  */
2125   if (windows_or_buffers_changed
2126       && desired_row->full_width_p
2127       && (f = XFRAME (w->frame),
2128           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2129           width != 0)
2130       && (height = desired_row->visible_height,
2131           height > 0))
2132     {
2133       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2135       block_input ();
2136       ns_clear_frame_area (f, 0, y, width, height);
2137       ns_clear_frame_area (f,
2138                            FRAME_PIXEL_WIDTH (f) - width,
2139                            y, width, height);
2140       unblock_input ();
2141     }
2145 static void
2146 ns_shift_glyphs_for_insert (struct frame *f,
2147                            int x, int y, int width, int height,
2148                            int shift_by)
2149 /* --------------------------------------------------------------------------
2150     External (RIF): copy an area horizontally, don't worry about clearing src
2151    -------------------------------------------------------------------------- */
2153   NSRect srcRect = NSMakeRect (x, y, width, height);
2154   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2155   NSPoint dstOrigin = dstRect.origin;
2157   NSTRACE (ns_shift_glyphs_for_insert);
2159   ns_focus (f, &dstRect, 1);
2160   NSCopyBits (0, srcRect, dstOrigin);
2161   ns_unfocus (f);
2166 /* ==========================================================================
2168     Character encoding and metrics
2170    ========================================================================== */
2173 static void
2174 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2175 /* --------------------------------------------------------------------------
2176      External (RIF); compute left/right overhang of whole string and set in s
2177    -------------------------------------------------------------------------- */
2179   struct font *font = s->font;
2181   if (s->char2b)
2182     {
2183       struct font_metrics metrics;
2184       unsigned int codes[2];
2185       codes[0] = *(s->char2b);
2186       codes[1] = *(s->char2b + s->nchars - 1);
2188       font->driver->text_extents (font, codes, 2, &metrics);
2189       s->left_overhang = -metrics.lbearing;
2190       s->right_overhang
2191         = metrics.rbearing > metrics.width
2192         ? metrics.rbearing - metrics.width : 0;
2193     }
2194   else
2195     {
2196       s->left_overhang = 0;
2197       s->right_overhang = ((struct nsfont_info *)font)->ital ?
2198         FONT_HEIGHT (font) * 0.2 : 0;
2199     }
2204 /* ==========================================================================
2206     Fringe and cursor drawing
2208    ========================================================================== */
2211 extern int max_used_fringe_bitmap;
2212 static void
2213 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2214                       struct draw_fringe_bitmap_params *p)
2215 /* --------------------------------------------------------------------------
2216     External (RIF); fringe-related
2217    -------------------------------------------------------------------------- */
2219   struct frame *f = XFRAME (WINDOW_FRAME (w));
2220   struct face *face = p->face;
2221   static EmacsImage **bimgs = NULL;
2222   static int nBimgs = 0;
2224   /* grow bimgs if needed */
2225   if (nBimgs < max_used_fringe_bitmap)
2226     {
2227       bimgs = xrealloc (bimgs, max_used_fringe_bitmap * sizeof *bimgs);
2228       memset (bimgs + nBimgs, 0,
2229               (max_used_fringe_bitmap - nBimgs) * sizeof *bimgs);
2230       nBimgs = max_used_fringe_bitmap;
2231     }
2233   /* Must clip because of partially visible lines.  */
2234   ns_clip_to_row (w, row, -1, YES);
2236   if (!p->overlay_p)
2237     {
2238       int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
2240       /* If the fringe is adjacent to the left (right) scroll bar of a
2241          leftmost (rightmost, respectively) window, then extend its
2242          background to the gap between the fringe and the bar.  */
2243       if ((WINDOW_LEFTMOST_P (w)
2244            && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
2245           || (WINDOW_RIGHTMOST_P (w)
2246               && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
2247         {
2248           int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
2250           if (sb_width > 0)
2251             {
2252               int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
2253               int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
2254                                     * FRAME_COLUMN_WIDTH (f));
2256               if (bx < 0)
2257                 {
2258                   /* Bitmap fills the fringe.  */
2259                   if (bar_area_x + bar_area_width == p->x)
2260                     bx = bar_area_x + sb_width;
2261                   else if (p->x + p->wd == bar_area_x)
2262                     bx = bar_area_x;
2263                   if (bx >= 0)
2264                     {
2265                       int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
2267                       nx = bar_area_width - sb_width;
2268                       by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
2269                                                             row->y));
2270                       ny = row->visible_height;
2271                     }
2272                 }
2273               else
2274                 {
2275                   if (bar_area_x + bar_area_width == bx)
2276                     {
2277                       bx = bar_area_x + sb_width;
2278                       nx += bar_area_width - sb_width;
2279                     }
2280                   else if (bx + nx == bar_area_x)
2281                     nx += bar_area_width - sb_width;
2282                 }
2283             }
2284         }
2286       if (bx >= 0 && nx > 0)
2287         {
2288           NSRect r = NSMakeRect (bx, by, nx, ny);
2289           NSRectClip (r);
2290           [ns_lookup_indexed_color (face->background, f) set];
2291           NSRectFill (r);
2292         }
2293     }
2295   if (p->which)
2296     {
2297       NSRect r = NSMakeRect (p->x, p->y, p->wd, p->h);
2298       EmacsImage *img = bimgs[p->which - 1];
2300       if (!img)
2301         {
2302           unsigned short *bits = p->bits + p->dh;
2303           int len = p->h;
2304           int i;
2305           unsigned char *cbits = xmalloc (len);
2307           for (i = 0; i < len; i++)
2308             cbits[i] = ~(bits[i] & 0xff);
2309           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2310                                            flip: NO];
2311           bimgs[p->which - 1] = img;
2312           xfree (cbits);
2313         }
2315       NSRectClip (r);
2316       /* Since we composite the bitmap instead of just blitting it, we need
2317          to erase the whole background. */
2318       [ns_lookup_indexed_color(face->background, f) set];
2319       NSRectFill (r);
2320       [img setXBMColor: ns_lookup_indexed_color(face->foreground, f)];
2321 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
2322       [img drawInRect: r
2323               fromRect: NSZeroRect
2324              operation: NSCompositeSourceOver
2325               fraction: 1.0
2326            respectFlipped: YES
2327                 hints: nil];
2328 #else
2329       {
2330         NSPoint pt = r.origin;
2331         pt.y += p->h;
2332         [img compositeToPoint: pt operation: NSCompositeSourceOver];
2333       }
2334 #endif
2335     }
2336   ns_unfocus (f);
2340 static void
2341 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2342                        int x, int y, int cursor_type, int cursor_width,
2343                        int on_p, int active_p)
2344 /* --------------------------------------------------------------------------
2345      External call (RIF): draw cursor.
2346      Note that CURSOR_WIDTH is meaningful only for (h)bar cursors.
2347    -------------------------------------------------------------------------- */
2349   NSRect r, s;
2350   int fx, fy, h, cursor_height;
2351   struct frame *f = WINDOW_XFRAME (w);
2352   struct glyph *phys_cursor_glyph;
2353   struct glyph *cursor_glyph;
2354   struct face *face;
2355   NSColor *hollow_color = FRAME_BACKGROUND_COLOR (f);
2357   /* If cursor is out of bounds, don't draw garbage.  This can happen
2358      in mini-buffer windows when switching between echo area glyphs
2359      and mini-buffer.  */
2361   NSTRACE (dumpcursor);
2363   if (!on_p)
2364     return;
2366   w->phys_cursor_type = cursor_type;
2367   w->phys_cursor_on_p = on_p;
2369   if (cursor_type == NO_CURSOR)
2370     {
2371       w->phys_cursor_width = 0;
2372       return;
2373     }
2375   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2376     {
2377       if (glyph_row->exact_window_width_line_p
2378           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2379         {
2380           glyph_row->cursor_in_fringe_p = 1;
2381           draw_fringe_bitmap (w, glyph_row, 0);
2382         }
2383       return;
2384     }
2386   /* We draw the cursor (with NSRectFill), then draw the glyph on top
2387      (other terminals do it the other way round).  We must set
2388      w->phys_cursor_width to the cursor width.  For bar cursors, that
2389      is CURSOR_WIDTH; for box cursors, it is the glyph width.  */
2390   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2392   /* The above get_phys_cursor_geometry call set w->phys_cursor_width
2393      to the glyph width; replace with CURSOR_WIDTH for (V)BAR cursors. */
2394   if (cursor_type == BAR_CURSOR)
2395     {
2396       if (cursor_width < 1)
2397         cursor_width = max (FRAME_CURSOR_WIDTH (f), 1);
2398       w->phys_cursor_width = cursor_width;
2399     }
2400   /* If we have an HBAR, "cursor_width" MAY specify height. */
2401   else if (cursor_type == HBAR_CURSOR)
2402     {
2403       cursor_height = (cursor_width < 1) ? lrint (0.25 * h) : cursor_width;
2404       fy += h - cursor_height;
2405       h = cursor_height;
2406     }
2408   r.origin.x = fx, r.origin.y = fy;
2409   r.size.height = h;
2410   r.size.width = w->phys_cursor_width;
2412   /* TODO: only needed in rare cases with last-resort font in HELLO..
2413      should we do this more efficiently? */
2414   ns_clip_to_row (w, glyph_row, -1, NO); /* do ns_focus(f, &r, 1); if remove */
2417   face = FACE_FROM_ID (f, phys_cursor_glyph->face_id);
2418   if (face && NS_FACE_BACKGROUND (face)
2419       == ns_index_color (FRAME_CURSOR_COLOR (f), f))
2420     {
2421       [ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), f) set];
2422       hollow_color = FRAME_CURSOR_COLOR (f);
2423     }
2424   else
2425     [FRAME_CURSOR_COLOR (f) set];
2427 #ifdef NS_IMPL_COCOA
2428   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2429            atomic.  Cleaner ways of doing this should be investigated.
2430            One way would be to set a global variable DRAWING_CURSOR
2431            when making the call to draw_phys..(), don't focus in that
2432            case, then move the ns_unfocus() here after that call. */
2433   NSDisableScreenUpdates ();
2434 #endif
2436   switch (cursor_type)
2437     {
2438     case NO_CURSOR:
2439       break;
2440     case FILLED_BOX_CURSOR:
2441       NSRectFill (r);
2442       break;
2443     case HOLLOW_BOX_CURSOR:
2444       NSRectFill (r);
2445       [hollow_color set];
2446       NSRectFill (NSInsetRect (r, 1, 1));
2447       [FRAME_CURSOR_COLOR (f) set];
2448       break;
2449     case HBAR_CURSOR:
2450       NSRectFill (r);
2451       break;
2452     case BAR_CURSOR:
2453       s = r;
2454       /* If the character under cursor is R2L, draw the bar cursor
2455          on the right of its glyph, rather than on the left.  */
2456       cursor_glyph = get_phys_cursor_glyph (w);
2457       if ((cursor_glyph->resolved_level & 1) != 0)
2458         s.origin.x += cursor_glyph->pixel_width - s.size.width;
2460       NSRectFill (s);
2461       break;
2462     }
2463   ns_unfocus (f);
2465   /* draw the character under the cursor */
2466   if (cursor_type != NO_CURSOR)
2467     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2469 #ifdef NS_IMPL_COCOA
2470   NSEnableScreenUpdates ();
2471 #endif
2476 static void
2477 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2478 /* --------------------------------------------------------------------------
2479      External (RIF): Draw a vertical line.
2480    -------------------------------------------------------------------------- */
2482   struct frame *f = XFRAME (WINDOW_FRAME (w));
2483   struct face *face;
2484   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2486   NSTRACE (ns_draw_vertical_window_border);
2488   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2489   if (face)
2490       [ns_lookup_indexed_color(face->foreground, f) set];
2492   ns_focus (f, &r, 1);
2493   NSRectFill(r);
2494   ns_unfocus (f);
2498 void
2499 show_hourglass (struct atimer *timer)
2501   if (hourglass_shown_p)
2502     return;
2504   block_input ();
2506   /* TODO: add NSProgressIndicator to selected frame (see macfns.c) */
2508   hourglass_shown_p = 1;
2509   unblock_input ();
2513 void
2514 hide_hourglass (void)
2516   if (!hourglass_shown_p)
2517     return;
2519   block_input ();
2521   /* TODO: remove NSProgressIndicator from all frames */
2523   hourglass_shown_p = 0;
2524   unblock_input ();
2529 /* ==========================================================================
2531     Glyph drawing operations
2533    ========================================================================== */
2535 static int
2536 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2537 /* --------------------------------------------------------------------------
2538     Wrapper utility to account for internal border width on full-width lines,
2539     and allow top full-width rows to hit the frame top.  nr should be pointer
2540     to two successive NSRects.  Number of rects actually used is returned.
2541    -------------------------------------------------------------------------- */
2543   int n = get_glyph_string_clip_rects (s, nr, 2);
2544   return n;
2547 /* --------------------------------------------------------------------
2548    Draw a wavy line under glyph string s. The wave fills wave_height
2549    pixels from y.
2551                     x          wave_length = 2
2552                                  --
2553                 y    *   *   *   *   *
2554                      |* * * * * * * * *
2555     wave_height = 3  | *   *   *   *
2556   --------------------------------------------------------------------- */
2558 static void
2559 ns_draw_underwave (struct glyph_string *s, EmacsCGFloat width, EmacsCGFloat x)
2561   int wave_height = 3, wave_length = 2;
2562   int y, dx, dy, odd, xmax;
2563   NSPoint a, b;
2564   NSRect waveClip;
2566   dx = wave_length;
2567   dy = wave_height - 1;
2568   y =  s->ybase - wave_height + 3;
2569   xmax = x + width;
2571   /* Find and set clipping rectangle */
2572   waveClip = NSMakeRect (x, y, width, wave_height);
2573   [[NSGraphicsContext currentContext] saveGraphicsState];
2574   NSRectClip (waveClip);
2576   /* Draw the waves */
2577   a.x = x - ((int)(x) % dx) + (EmacsCGFloat) 0.5;
2578   b.x = a.x + dx;
2579   odd = (int)(a.x/dx) % 2;
2580   a.y = b.y = y + 0.5;
2582   if (odd)
2583     a.y += dy;
2584   else
2585     b.y += dy;
2587   while (a.x <= xmax)
2588     {
2589       [NSBezierPath strokeLineFromPoint:a toPoint:b];
2590       a.x = b.x, a.y = b.y;
2591       b.x += dx, b.y = y + 0.5 + odd*dy;
2592       odd = !odd;
2593     }
2595   /* Restore previous clipping rectangle(s) */
2596   [[NSGraphicsContext currentContext] restoreGraphicsState];
2601 void
2602 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
2603                          NSColor *defaultCol, CGFloat width, CGFloat x)
2604 /* --------------------------------------------------------------------------
2605    Draw underline, overline, and strike-through on glyph string s.
2606    -------------------------------------------------------------------------- */
2608   if (s->for_overlaps)
2609     return;
2611   /* Do underline. */
2612   if (face->underline_p)
2613     {
2614       if (s->face->underline_type == FACE_UNDER_WAVE)
2615         {
2616           if (face->underline_defaulted_p)
2617             [defaultCol set];
2618           else
2619             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2621           ns_draw_underwave (s, width, x);
2622         }
2623       else if (s->face->underline_type == FACE_UNDER_LINE)
2624         {
2626           NSRect r;
2627           unsigned long thickness, position;
2629           /* If the prev was underlined, match its appearance. */
2630           if (s->prev && s->prev->face->underline_p
2631               && s->prev->face->underline_type == FACE_UNDER_LINE
2632               && s->prev->underline_thickness > 0)
2633             {
2634               thickness = s->prev->underline_thickness;
2635               position = s->prev->underline_position;
2636             }
2637           else
2638             {
2639               struct font *font;
2640               unsigned long descent;
2642               font=s->font;
2643               descent = s->y + s->height - s->ybase;
2645               /* Use underline thickness of font, defaulting to 1. */
2646               thickness = (font && font->underline_thickness > 0)
2647                 ? font->underline_thickness : 1;
2649               /* Determine the offset of underlining from the baseline. */
2650               if (x_underline_at_descent_line)
2651                 position = descent - thickness;
2652               else if (x_use_underline_position_properties
2653                        && font && font->underline_position >= 0)
2654                 position = font->underline_position;
2655               else if (font)
2656                 position = lround (font->descent / 2);
2657               else
2658                 position = underline_minimum_offset;
2660               position = max (position, underline_minimum_offset);
2662               /* Ensure underlining is not cropped. */
2663               if (descent <= position)
2664                 {
2665                   position = descent - 1;
2666                   thickness = 1;
2667                 }
2668               else if (descent < position + thickness)
2669                 thickness = 1;
2670             }
2672           s->underline_thickness = thickness;
2673           s->underline_position = position;
2675           r = NSMakeRect (x, s->ybase + position, width, thickness);
2677           if (face->underline_defaulted_p)
2678             [defaultCol set];
2679           else
2680             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2681           NSRectFill (r);
2682         }
2683     }
2684   /* Do overline. We follow other terms in using a thickness of 1
2685      and ignoring overline_margin. */
2686   if (face->overline_p)
2687     {
2688       NSRect r;
2689       r = NSMakeRect (x, s->y, width, 1);
2691       if (face->overline_color_defaulted_p)
2692         [defaultCol set];
2693       else
2694         [ns_lookup_indexed_color (face->overline_color, s->f) set];
2695       NSRectFill (r);
2696     }
2698   /* Do strike-through.  We follow other terms for thickness and
2699      vertical position.*/
2700   if (face->strike_through_p)
2701     {
2702       NSRect r;
2703       unsigned long dy;
2705       dy = lrint ((s->height - 1) / 2);
2706       r = NSMakeRect (x, s->y + dy, width, 1);
2708       if (face->strike_through_color_defaulted_p)
2709         [defaultCol set];
2710       else
2711         [ns_lookup_indexed_color (face->strike_through_color, s->f) set];
2712       NSRectFill (r);
2713     }
2716 static void
2717 ns_draw_box (NSRect r, CGFloat thickness, NSColor *col,
2718              char left_p, char right_p)
2719 /* --------------------------------------------------------------------------
2720     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2721     Note we can't just use an NSDrawRect command, because of the possibility
2722     of some sides not being drawn, and because the rect will be filled.
2723    -------------------------------------------------------------------------- */
2725   NSRect s = r;
2726   [col set];
2728   /* top, bottom */
2729   s.size.height = thickness;
2730   NSRectFill (s);
2731   s.origin.y += r.size.height - thickness;
2732   NSRectFill (s);
2734   s.size.height = r.size.height;
2735   s.origin.y = r.origin.y;
2737   /* left, right (optional) */
2738   s.size.width = thickness;
2739   if (left_p)
2740     NSRectFill (s);
2741   if (right_p)
2742     {
2743       s.origin.x += r.size.width - thickness;
2744       NSRectFill (s);
2745     }
2749 static void
2750 ns_draw_relief (NSRect r, int thickness, char raised_p,
2751                char top_p, char bottom_p, char left_p, char right_p,
2752                struct glyph_string *s)
2753 /* --------------------------------------------------------------------------
2754     Draw a relief rect inside r, optionally leaving some sides open.
2755     Note we can't just use an NSDrawBezel command, because of the possibility
2756     of some sides not being drawn, and because the rect will be filled.
2757    -------------------------------------------------------------------------- */
2759   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2760   NSColor *newBaseCol = nil;
2761   NSRect sr = r;
2763   NSTRACE (ns_draw_relief);
2765   /* set up colors */
2767   if (s->face->use_box_color_for_shadows_p)
2768     {
2769       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2770     }
2771 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2772            && s->img->pixmap
2773            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2774        {
2775          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2776        } */
2777   else
2778     {
2779       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2780     }
2782   if (newBaseCol == nil)
2783     newBaseCol = [NSColor grayColor];
2785   if (newBaseCol != baseCol)  /* TODO: better check */
2786     {
2787       [baseCol release];
2788       baseCol = [newBaseCol retain];
2789       [lightCol release];
2790       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2791       [darkCol release];
2792       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2793     }
2795   [(raised_p ? lightCol : darkCol) set];
2797   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2799   /* top */
2800   sr.size.height = thickness;
2801   if (top_p) NSRectFill (sr);
2803   /* left */
2804   sr.size.height = r.size.height;
2805   sr.size.width = thickness;
2806   if (left_p) NSRectFill (sr);
2808   [(raised_p ? darkCol : lightCol) set];
2810   /* bottom */
2811   sr.size.width = r.size.width;
2812   sr.size.height = thickness;
2813   sr.origin.y += r.size.height - thickness;
2814   if (bottom_p) NSRectFill (sr);
2816   /* right */
2817   sr.size.height = r.size.height;
2818   sr.origin.y = r.origin.y;
2819   sr.size.width = thickness;
2820   sr.origin.x += r.size.width - thickness;
2821   if (right_p) NSRectFill (sr);
2825 static void
2826 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2827 /* --------------------------------------------------------------------------
2828       Function modeled after x_draw_glyph_string_box ().
2829       Sets up parameters for drawing.
2830    -------------------------------------------------------------------------- */
2832   int right_x, last_x;
2833   char left_p, right_p;
2834   struct glyph *last_glyph;
2835   NSRect r;
2836   int thickness;
2837   struct face *face;
2839   if (s->hl == DRAW_MOUSE_FACE)
2840     {
2841       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2842       if (!face)
2843         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2844     }
2845   else
2846     face = s->face;
2848   thickness = face->box_line_width;
2850   NSTRACE (ns_dumpglyphs_box_or_relief);
2852   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2853             ? WINDOW_RIGHT_EDGE_X (s->w)
2854             : window_box_right (s->w, s->area));
2855   last_glyph = (s->cmp || s->img
2856                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2858   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2859               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2861   left_p = (s->first_glyph->left_box_line_p
2862             || (s->hl == DRAW_MOUSE_FACE
2863                 && (s->prev == NULL || s->prev->hl != s->hl)));
2864   right_p = (last_glyph->right_box_line_p
2865              || (s->hl == DRAW_MOUSE_FACE
2866                  && (s->next == NULL || s->next->hl != s->hl)));
2868   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2870   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2871   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2872     {
2873       ns_draw_box (r, abs (thickness),
2874                    ns_lookup_indexed_color (face->box_color, s->f),
2875                   left_p, right_p);
2876     }
2877   else
2878     {
2879       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2880                      1, 1, left_p, right_p, s);
2881     }
2885 static void
2886 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2887 /* --------------------------------------------------------------------------
2888       Modeled after x_draw_glyph_string_background, which draws BG in
2889       certain cases.  Others are left to the text rendering routine.
2890    -------------------------------------------------------------------------- */
2892   NSTRACE (ns_maybe_dumpglyphs_background);
2894   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2895     {
2896       int box_line_width = max (s->face->box_line_width, 0);
2897       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2898           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2899         {
2900           struct face *face;
2901           if (s->hl == DRAW_MOUSE_FACE)
2902             {
2903               face = FACE_FROM_ID (s->f,
2904                                    MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2905               if (!face)
2906                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2907             }
2908           else
2909             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2910           if (!face->stipple)
2911             [(NS_FACE_BACKGROUND (face) != 0
2912               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2913               : FRAME_BACKGROUND_COLOR (s->f)) set];
2914           else
2915             {
2916               struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (s->f);
2917               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2918             }
2920           if (s->hl != DRAW_CURSOR)
2921             {
2922               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2923                                     s->background_width,
2924                                     s->height-2*box_line_width);
2925               NSRectFill (r);
2926             }
2928           s->background_filled_p = 1;
2929         }
2930     }
2934 static void
2935 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2936 /* --------------------------------------------------------------------------
2937       Renders an image and associated borders.
2938    -------------------------------------------------------------------------- */
2940   EmacsImage *img = s->img->pixmap;
2941   int box_line_vwidth = max (s->face->box_line_width, 0);
2942   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2943   int bg_x, bg_y, bg_height;
2944   int th;
2945   char raised_p;
2946   NSRect br;
2947   struct face *face;
2948   NSColor *tdCol;
2950   NSTRACE (ns_dumpglyphs_image);
2952   if (s->face->box != FACE_NO_BOX
2953       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2954     x += abs (s->face->box_line_width);
2956   bg_x = x;
2957   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
2958   bg_height = s->height;
2959   /* other terms have this, but was causing problems w/tabbar mode */
2960   /* - 2 * box_line_vwidth; */
2962   if (s->slice.x == 0) x += s->img->hmargin;
2963   if (s->slice.y == 0) y += s->img->vmargin;
2965   /* Draw BG: if we need larger area than image itself cleared, do that,
2966      otherwise, since we composite the image under NS (instead of mucking
2967      with its background color), we must clear just the image area. */
2968   if (s->hl == DRAW_MOUSE_FACE)
2969     {
2970       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2971       if (!face)
2972        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2973     }
2974   else
2975     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2977   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
2979   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
2980       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
2981     {
2982       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
2983       s->background_filled_p = 1;
2984     }
2985   else
2986     {
2987       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
2988     }
2990   NSRectFill (br);
2992   /* Draw the image.. do we need to draw placeholder if img ==nil? */
2993   if (img != nil)
2994     {
2995 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
2996       NSRect dr = NSMakeRect (x, y, s->slice.width, s->slice.height);
2997       NSRect ir = NSMakeRect (s->slice.x, s->slice.y,
2998                               s->slice.width, s->slice.height);
2999       [img drawInRect: dr
3000              fromRect: ir
3001              operation: NSCompositeSourceOver
3002               fraction: 1.0
3003            respectFlipped: YES
3004                 hints: nil];
3005 #else
3006       [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
3007                   operation: NSCompositeSourceOver];
3008 #endif
3009     }
3011   if (s->hl == DRAW_CURSOR)
3012     {
3013     [FRAME_CURSOR_COLOR (s->f) set];
3014     if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3015       tdCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3016     else
3017       /* Currently on NS img->mask is always 0. Since
3018          get_window_cursor_type specifies a hollow box cursor when on
3019          a non-masked image we never reach this clause. But we put it
3020          in in anticipation of better support for image masks on
3021          NS. */
3022       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3023     }
3024   else
3025     {
3026       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3027     }
3029   /* Draw underline, overline, strike-through. */
3030   ns_draw_text_decoration (s, face, tdCol, br.size.width, br.origin.x);
3032   /* Draw relief, if requested */
3033   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
3034     {
3035       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
3036         {
3037           th = tool_bar_button_relief >= 0 ?
3038             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
3039           raised_p = (s->hl == DRAW_IMAGE_RAISED);
3040         }
3041       else
3042         {
3043           th = abs (s->img->relief);
3044           raised_p = (s->img->relief > 0);
3045         }
3047       r.origin.x = x - th;
3048       r.origin.y = y - th;
3049       r.size.width = s->slice.width + 2*th-1;
3050       r.size.height = s->slice.height + 2*th-1;
3051       ns_draw_relief (r, th, raised_p,
3052                       s->slice.y == 0,
3053                       s->slice.y + s->slice.height == s->img->height,
3054                       s->slice.x == 0,
3055                       s->slice.x + s->slice.width == s->img->width, s);
3056     }
3058   /* If there is no mask, the background won't be seen,
3059      so draw a rectangle on the image for the cursor.
3060      Do this for all images, getting transparency right is not reliable.  */
3061   if (s->hl == DRAW_CURSOR)
3062     {
3063       int thickness = abs (s->img->relief);
3064       if (thickness == 0) thickness = 1;
3065       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
3066     }
3070 static void
3071 ns_dumpglyphs_stretch (struct glyph_string *s)
3073   NSRect r[2];
3074   int n, i;
3075   struct face *face;
3076   NSColor *fgCol, *bgCol;
3078   if (!s->background_filled_p)
3079     {
3080       n = ns_get_glyph_string_clip_rect (s, r);
3081       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
3083       ns_focus (s->f, r, n);
3085       if (s->hl == DRAW_MOUSE_FACE)
3086        {
3087          face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3088          if (!face)
3089            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3090        }
3091       else
3092        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3094       bgCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3095       fgCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3097       for (i = 0; i < n; ++i)
3098         {
3099           if (!s->row->full_width_p)
3100             {
3101               int overrun, leftoverrun;
3103               /* truncate to avoid overwriting fringe and/or scrollbar */
3104               overrun = max (0, (s->x + s->background_width)
3105                              - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
3106                                 - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
3107               r[i].size.width -= overrun;
3109               /* truncate to avoid overwriting to left of the window box */
3110               leftoverrun = (WINDOW_BOX_LEFT_EDGE_X (s->w)
3111                              + WINDOW_LEFT_FRINGE_WIDTH (s->w)) - s->x;
3113               if (leftoverrun > 0)
3114                 {
3115                   r[i].origin.x += leftoverrun;
3116                   r[i].size.width -= leftoverrun;
3117                 }
3119               /* XXX: Try to work between problem where a stretch glyph on
3120                  a partially-visible bottom row will clear part of the
3121                  modeline, and another where list-buffers headers and similar
3122                  rows erroneously have visible_height set to 0.  Not sure
3123                  where this is coming from as other terms seem not to show. */
3124               r[i].size.height = min (s->height, s->row->visible_height);
3125             }
3127           [bgCol set];
3129           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
3130              overwriting cursor (usually when cursor on a tab) */
3131           if (s->hl == DRAW_CURSOR)
3132             {
3133               CGFloat x, width;
3135               x = r[i].origin.x;
3136               width = s->w->phys_cursor_width;
3137               r[i].size.width -= width;
3138               r[i].origin.x += width;
3140               NSRectFill (r[i]);
3142               /* Draw overlining, etc. on the cursor. */
3143               if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3144                 ns_draw_text_decoration (s, face, bgCol, width, x);
3145               else
3146                 ns_draw_text_decoration (s, face, fgCol, width, x);
3147             }
3148           else
3149             {
3150               NSRectFill (r[i]);
3151             }
3153           /* Draw overlining, etc. on the stretch glyph (or the part
3154              of the stretch glyph after the cursor). */
3155           ns_draw_text_decoration (s, face, fgCol, r[i].size.width,
3156                                    r[i].origin.x);
3157         }
3158       ns_unfocus (s->f);
3159       s->background_filled_p = 1;
3160     }
3164 static void
3165 ns_draw_glyph_string (struct glyph_string *s)
3166 /* --------------------------------------------------------------------------
3167       External (RIF): Main draw-text call.
3168    -------------------------------------------------------------------------- */
3170   /* TODO (optimize): focus for box and contents draw */
3171   NSRect r[2];
3172   int n;
3173   char box_drawn_p = 0;
3175   NSTRACE (ns_draw_glyph_string);
3177   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
3178     {
3179       int width;
3180       struct glyph_string *next;
3182       for (width = 0, next = s->next;
3183            next && width < s->right_overhang;
3184            width += next->width, next = next->next)
3185         if (next->first_glyph->type != IMAGE_GLYPH)
3186           {
3187             if (next->first_glyph->type != STRETCH_GLYPH)
3188               {
3189                 n = ns_get_glyph_string_clip_rect (s->next, r);
3190                 ns_focus (s->f, r, n);
3191                 ns_maybe_dumpglyphs_background (s->next, 1);
3192                 ns_unfocus (s->f);
3193               }
3194             else
3195               {
3196                 ns_dumpglyphs_stretch (s->next);
3197               }
3198             next->num_clips = 0;
3199           }
3200     }
3202   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
3203         && (s->first_glyph->type == CHAR_GLYPH
3204             || s->first_glyph->type == COMPOSITE_GLYPH))
3205     {
3206       n = ns_get_glyph_string_clip_rect (s, r);
3207       ns_focus (s->f, r, n);
3208       ns_maybe_dumpglyphs_background (s, 1);
3209       ns_dumpglyphs_box_or_relief (s);
3210       ns_unfocus (s->f);
3211       box_drawn_p = 1;
3212     }
3214   switch (s->first_glyph->type)
3215     {
3217     case IMAGE_GLYPH:
3218       n = ns_get_glyph_string_clip_rect (s, r);
3219       ns_focus (s->f, r, n);
3220       ns_dumpglyphs_image (s, r[0]);
3221       ns_unfocus (s->f);
3222       break;
3224     case STRETCH_GLYPH:
3225       ns_dumpglyphs_stretch (s);
3226       break;
3228     case CHAR_GLYPH:
3229     case COMPOSITE_GLYPH:
3230       n = ns_get_glyph_string_clip_rect (s, r);
3231       ns_focus (s->f, r, n);
3233       if (s->for_overlaps || (s->cmp_from > 0
3234                               && ! s->first_glyph->u.cmp.automatic))
3235         s->background_filled_p = 1;
3236       else
3237         ns_maybe_dumpglyphs_background
3238           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3240       ns_tmp_flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
3241                     (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
3242                      (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
3243                       NS_DUMPGLYPH_NORMAL));
3244       ns_tmp_font = (struct nsfont_info *)s->face->font;
3245       if (ns_tmp_font == NULL)
3246           ns_tmp_font = (struct nsfont_info *)FRAME_FONT (s->f);
3248       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3249         {
3250           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3251           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3252           NS_FACE_FOREGROUND (s->face) = tmp;
3253         }
3255       ns_tmp_font->font.driver->draw
3256         (s, 0, s->nchars, s->x, s->y,
3257          (ns_tmp_flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
3258          || ns_tmp_flags == NS_DUMPGLYPH_MOUSEFACE);
3260       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3261         {
3262           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3263           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3264           NS_FACE_FOREGROUND (s->face) = tmp;
3265         }
3267       ns_unfocus (s->f);
3268       break;
3270     case GLYPHLESS_GLYPH:
3271       n = ns_get_glyph_string_clip_rect (s, r);
3272       ns_focus (s->f, r, n);
3274       if (s->for_overlaps || (s->cmp_from > 0
3275                               && ! s->first_glyph->u.cmp.automatic))
3276         s->background_filled_p = 1;
3277       else
3278         ns_maybe_dumpglyphs_background
3279           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3280       /* ... */
3281       /* Not yet implemented.  */
3282       /* ... */
3283       ns_unfocus (s->f);
3284       break;
3286     default:
3287       emacs_abort ();
3288     }
3290   /* Draw box if not done already. */
3291   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3292     {
3293       n = ns_get_glyph_string_clip_rect (s, r);
3294       ns_focus (s->f, r, n);
3295       ns_dumpglyphs_box_or_relief (s);
3296       ns_unfocus (s->f);
3297     }
3299   s->num_clips = 0;
3304 /* ==========================================================================
3306     Event loop
3308    ========================================================================== */
3311 static void
3312 ns_send_appdefined (int value)
3313 /* --------------------------------------------------------------------------
3314     Internal: post an appdefined event which EmacsApp-sendEvent will
3315               recognize and take as a command to halt the event loop.
3316    -------------------------------------------------------------------------- */
3318   /*NSTRACE (ns_send_appdefined); */
3320 #ifdef NS_IMPL_GNUSTEP
3321   // GNUStep needs postEvent to happen on the main thread.
3322   if (! [[NSThread currentThread] isMainThread])
3323     {
3324       EmacsApp *app = (EmacsApp *)NSApp;
3325       app->nextappdefined = value;
3326       [app performSelectorOnMainThread:@selector (sendFromMainThread:)
3327                             withObject:nil
3328                          waitUntilDone:YES];
3329       return;
3330     }
3331 #endif
3333   /* Only post this event if we haven't already posted one.  This will end
3334        the [NXApp run] main loop after having processed all events queued at
3335        this moment.  */
3336   if (send_appdefined)
3337     {
3338       NSEvent *nxev;
3340       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3341       send_appdefined = NO;
3343       /* Don't need wakeup timer any more */
3344       if (timed_entry)
3345         {
3346           [timed_entry invalidate];
3347           [timed_entry release];
3348           timed_entry = nil;
3349         }
3351       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3352                                 location: NSMakePoint (0, 0)
3353                            modifierFlags: 0
3354                                timestamp: 0
3355                             windowNumber: [[NSApp mainWindow] windowNumber]
3356                                  context: [NSApp context]
3357                                  subtype: 0
3358                                    data1: value
3359                                    data2: 0];
3361       /* Post an application defined event on the event queue.  When this is
3362          received the [NXApp run] will return, thus having processed all
3363          events which are currently queued.  */
3364       [NSApp postEvent: nxev atStart: NO];
3365     }
3368 #ifdef HAVE_NATIVE_FS
3369 static void
3370 check_native_fs ()
3372   Lisp_Object frame, tail;
3374   if (ns_last_use_native_fullscreen == ns_use_native_fullscreen)
3375     return;
3377   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
3379   /* Clear the mouse-moved flag for every frame on this display.  */
3380   FOR_EACH_FRAME (tail, frame)
3381     {
3382       struct frame *f = XFRAME (frame);
3383       if (FRAME_NS_P (f))
3384         {
3385           EmacsView *view = FRAME_NS_VIEW (f);
3386           [view updateCollectionBehaviour];
3387         }
3388     }
3390 #endif
3392 /* GNUStep and OSX <= 10.4 does not have cancelTracking.  */
3393 #if defined (NS_IMPL_COCOA) && \
3394   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
3395 const char *
3396 ns_get_pending_menu_title ()
3398   return menu_pending_title;
3401 /* Check if menu open should be cancelled or continued as normal.  */
3402 void
3403 ns_check_menu_open (NSMenu *menu)
3405   /* Click in menu bar? */
3406   NSArray *a = [[NSApp mainMenu] itemArray];
3407   int i;
3408   BOOL found = NO;
3409   for (i = 0; ! found && i < [a count]; i++)
3410     found = menu == [[a objectAtIndex:i] submenu];
3411   if (found)
3412     {
3413       if (menu_will_open_state == MENU_NONE && emacs_event)
3414         {
3415           NSEvent *theEvent = [NSApp currentEvent];
3416           struct frame *emacsframe = SELECTED_FRAME ();
3418           [menu cancelTracking];
3419           menu_will_open_state = MENU_PENDING;
3420           emacs_event->kind = MENU_BAR_ACTIVATE_EVENT;
3421           EV_TRAILER (theEvent);
3423           CGEventRef ourEvent = CGEventCreate (NULL);
3424           menu_mouse_point = CGEventGetLocation (ourEvent);
3425           CFRelease (ourEvent);
3426           xfree (menu_pending_title);
3427           menu_pending_title = xstrdup ([[menu title] UTF8String]);
3428         }
3429       else if (menu_will_open_state == MENU_OPENING)
3430         {
3431           menu_will_open_state = MENU_NONE;
3432         }
3433     }
3436 /* Redo saved menu click if state is MENU_PENDING.  */
3437 void
3438 ns_check_pending_open_menu ()
3440   if (menu_will_open_state == MENU_PENDING)
3441     {
3442       CGEventSourceRef source
3443         = CGEventSourceCreate (kCGEventSourceStateHIDSystemState);
3445       CGEventRef event = CGEventCreateMouseEvent (source,
3446                                                   kCGEventLeftMouseDown,
3447                                                   menu_mouse_point,
3448                                                   kCGMouseButtonLeft);
3449       CGEventSetType (event, kCGEventLeftMouseDown);
3450       CGEventPost (kCGHIDEventTap, event);
3451       CFRelease (event);
3452       CFRelease (source);
3454       menu_will_open_state = MENU_OPENING;
3455     }
3457 #endif /* NS_IMPL_COCOA) && >= MAC_OS_X_VERSION_10_5 */
3459 static int
3460 ns_read_socket (struct terminal *terminal, struct input_event *hold_quit)
3461 /* --------------------------------------------------------------------------
3462      External (hook): Post an event to ourself and keep reading events until
3463      we read it back again.  In effect process all events which were waiting.
3464      From 21+ we have to manage the event buffer ourselves.
3465    -------------------------------------------------------------------------- */
3467   struct input_event ev;
3468   int nevents;
3470 /* NSTRACE (ns_read_socket); */
3472 #ifdef HAVE_NATIVE_FS
3473   check_native_fs ();
3474 #endif
3476   if ([NSApp modalWindow] != nil)
3477     return -1;
3479   if (hold_event_q.nr > 0)
3480     {
3481       int i;
3482       for (i = 0; i < hold_event_q.nr; ++i)
3483         kbd_buffer_store_event_hold (&hold_event_q.q[i], hold_quit);
3484       hold_event_q.nr = 0;
3485       return i;
3486     }
3488   block_input ();
3489   n_emacs_events_pending = 0;
3490   EVENT_INIT (ev);
3491   emacs_event = &ev;
3492   q_event_ptr = hold_quit;
3494   /* we manage autorelease pools by allocate/reallocate each time around
3495      the loop; strict nesting is occasionally violated but seems not to
3496      matter.. earlier methods using full nesting caused major memory leaks */
3497   [outerpool release];
3498   outerpool = [[NSAutoreleasePool alloc] init];
3500   /* If have pending open-file requests, attend to the next one of those. */
3501   if (ns_pending_files && [ns_pending_files count] != 0
3502       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3503     {
3504       [ns_pending_files removeObjectAtIndex: 0];
3505     }
3506   /* Deal with pending service requests. */
3507   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3508     && [(EmacsApp *)
3509          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3510                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3511     {
3512       [ns_pending_service_names removeObjectAtIndex: 0];
3513       [ns_pending_service_args removeObjectAtIndex: 0];
3514     }
3515   else
3516     {
3517       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3518          to ourself, otherwise [NXApp run] will never exit.  */
3519       send_appdefined = YES;
3520       ns_send_appdefined (-1);
3522       if (++apploopnr != 1)
3523         {
3524           emacs_abort ();
3525         }
3526       [NSApp run];
3527       --apploopnr;
3528     }
3530   nevents = n_emacs_events_pending;
3531   n_emacs_events_pending = 0;
3532   emacs_event = q_event_ptr = NULL;
3533   unblock_input ();
3535   return nevents;
3540 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3541            fd_set *exceptfds, EMACS_TIME *timeout, sigset_t *sigmask)
3542 /* --------------------------------------------------------------------------
3543      Replacement for select, checking for events
3544    -------------------------------------------------------------------------- */
3546   int result;
3547   int t, k, nr = 0;
3548   struct input_event event;
3549   char c;
3551 /*  NSTRACE (ns_select); */
3553 #ifdef HAVE_NATIVE_FS
3554   check_native_fs ();
3555 #endif
3557   if (hold_event_q.nr > 0)
3558     {
3559       /* We already have events pending. */
3560       raise (SIGIO);
3561       errno = EINTR;
3562       return -1;
3563     }
3565   for (k = 0; k < nfds+1; k++)
3566     {
3567       if (readfds && FD_ISSET(k, readfds)) ++nr;
3568       if (writefds && FD_ISSET(k, writefds)) ++nr;
3569     }
3571   if (NSApp == nil
3572       || (timeout && timeout->tv_sec == 0 && timeout->tv_nsec == 0))
3573     return pselect (nfds, readfds, writefds, exceptfds, timeout, sigmask);
3575   [outerpool release];
3576   outerpool = [[NSAutoreleasePool alloc] init];
3579   send_appdefined = YES;
3580   if (nr > 0)
3581     {
3582       pthread_mutex_lock (&select_mutex);
3583       select_nfds = nfds;
3584       select_valid = 0;
3585       if (readfds)
3586         {
3587           select_readfds = *readfds;
3588           select_valid += SELECT_HAVE_READ;
3589         }
3590       if (writefds)
3591         {
3592           select_writefds = *writefds;
3593           select_valid += SELECT_HAVE_WRITE;
3594         }
3596       if (timeout)
3597         {
3598           select_timeout = *timeout;
3599           select_valid += SELECT_HAVE_TMO;
3600         }
3602       pthread_mutex_unlock (&select_mutex);
3604       /* Inform fd_handler that select should be called */
3605       c = 'g';
3606       emacs_write (selfds[1], &c, 1);
3607     }
3608   else if (nr == 0 && timeout)
3609     {
3610       /* No file descriptor, just a timeout, no need to wake fd_handler  */
3611       double time = EMACS_TIME_TO_DOUBLE (*timeout);
3612       timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3613                                                       target: NSApp
3614                                                     selector:
3615                                   @selector (timeout_handler:)
3616                                                     userInfo: 0
3617                                                      repeats: NO]
3618                       retain];
3619     }
3620   else /* No timeout and no file descriptors, can this happen?  */
3621     {
3622       /* Send appdefined so we exit from the loop */
3623       ns_send_appdefined (-1);
3624     }
3626   EVENT_INIT (event);
3627   block_input ();
3628   emacs_event = &event;
3629   if (++apploopnr != 1)
3630     {
3631       emacs_abort ();
3632     }
3633   [NSApp run];
3634   --apploopnr;
3635   emacs_event = NULL;
3636   if (nr > 0 && readfds)
3637     {
3638       c = 's';
3639       emacs_write (selfds[1], &c, 1);
3640     }
3641   unblock_input ();
3643   t = last_appdefined_event_data;
3645   if (t != NO_APPDEFINED_DATA)
3646     {
3647       last_appdefined_event_data = NO_APPDEFINED_DATA;
3649       if (t == -2)
3650         {
3651           /* The NX_APPDEFINED event we received was a timeout. */
3652           result = 0;
3653         }
3654       else if (t == -1)
3655         {
3656           /* The NX_APPDEFINED event we received was the result of
3657              at least one real input event arriving.  */
3658           errno = EINTR;
3659           result = -1;
3660         }
3661       else
3662         {
3663           /* Received back from select () in fd_handler; copy the results */
3664           pthread_mutex_lock (&select_mutex);
3665           if (readfds) *readfds = select_readfds;
3666           if (writefds) *writefds = select_writefds;
3667           if (timeout) *timeout = select_timeout;
3668           pthread_mutex_unlock (&select_mutex);
3669           result = t;
3670         }
3671     }
3672   else
3673     {
3674       errno = EINTR;
3675       result = -1;
3676     }
3678   return result;
3683 /* ==========================================================================
3685     Scrollbar handling
3687    ========================================================================== */
3690 static void
3691 ns_set_vertical_scroll_bar (struct window *window,
3692                            int portion, int whole, int position)
3693 /* --------------------------------------------------------------------------
3694       External (hook): Update or add scrollbar
3695    -------------------------------------------------------------------------- */
3697   Lisp_Object win;
3698   NSRect r, v;
3699   struct frame *f = XFRAME (WINDOW_FRAME (window));
3700   EmacsView *view = FRAME_NS_VIEW (f);
3701   int window_y, window_height;
3702   int top, left, height, width, sb_width, sb_left;
3703   EmacsScroller *bar;
3704   BOOL fringe_extended_p;
3706   /* optimization; display engine sends WAY too many of these.. */
3707   if (!NILP (window->vertical_scroll_bar))
3708     {
3709       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3710       if ([bar checkSamePosition: position portion: portion whole: whole])
3711         {
3712           if (view->scrollbarsNeedingUpdate == 0)
3713             {
3714               if (!windows_or_buffers_changed)
3715                   return;
3716             }
3717           else
3718             view->scrollbarsNeedingUpdate--;
3719         }
3720     }
3722   NSTRACE (ns_set_vertical_scroll_bar);
3724   /* Get dimensions.  */
3725   window_box (window, -1, 0, &window_y, 0, &window_height);
3726   top = window_y;
3727   height = window_height;
3728   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3729   left = WINDOW_SCROLL_BAR_AREA_X (window);
3731   /* allow for displaying a skinnier scrollbar than char area allotted */
3732   sb_width = (WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) > 0) ?
3733     WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) : width;
3734   sb_left = left;
3736   r = NSMakeRect (sb_left, top, sb_width, height);
3737   /* the parent view is flipped, so we need to flip y value */
3738   v = [view frame];
3739   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3741   if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (window))
3742     fringe_extended_p = (WINDOW_LEFTMOST_P (window)
3743                          && WINDOW_LEFT_FRINGE_WIDTH (window)
3744                          && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (window)
3745                              || WINDOW_LEFT_MARGIN_COLS (window) == 0));
3746   else
3747     fringe_extended_p = (WINDOW_RIGHTMOST_P (window)
3748                          && WINDOW_RIGHT_FRINGE_WIDTH (window)
3749                          && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (window)
3750                              || WINDOW_RIGHT_MARGIN_COLS (window) == 0));
3752   XSETWINDOW (win, window);
3753   block_input ();
3755   /* we want at least 5 lines to display a scrollbar */
3756   if (WINDOW_TOTAL_LINES (window) < 5)
3757     {
3758       if (!NILP (window->vertical_scroll_bar))
3759         {
3760           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3761           [bar removeFromSuperview];
3762           wset_vertical_scroll_bar (window, Qnil);
3763         }
3764       ns_clear_frame_area (f, sb_left, top, width, height);
3765       unblock_input ();
3766       return;
3767     }
3769   if (NILP (window->vertical_scroll_bar))
3770     {
3771       if (width > 0 && height > 0)
3772         {
3773           if (fringe_extended_p)
3774             ns_clear_frame_area (f, sb_left, top, sb_width, height);
3775           else
3776             ns_clear_frame_area (f, left, top, width, height);
3777         }
3779       bar = [[EmacsScroller alloc] initFrame: r window: win];
3780       wset_vertical_scroll_bar (window, make_save_pointer (bar));
3781     }
3782   else
3783     {
3784       NSRect oldRect;
3785       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3786       oldRect = [bar frame];
3787       r.size.width = oldRect.size.width;
3788       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3789         {
3790           if (oldRect.origin.x != r.origin.x)
3791               ns_clear_frame_area (f, sb_left, top, width, height);
3792           [bar setFrame: r];
3793         }
3794     }
3796   [bar setPosition: position portion: portion whole: whole];
3797   unblock_input ();
3801 static void
3802 ns_condemn_scroll_bars (struct frame *f)
3803 /* --------------------------------------------------------------------------
3804      External (hook): arrange for all frame's scrollbars to be removed
3805      at next call to judge_scroll_bars, except for those redeemed.
3806    -------------------------------------------------------------------------- */
3808   int i;
3809   id view;
3810   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3812   NSTRACE (ns_condemn_scroll_bars);
3814   for (i =[subviews count]-1; i >= 0; i--)
3815     {
3816       view = [subviews objectAtIndex: i];
3817       if ([view isKindOfClass: [EmacsScroller class]])
3818         [view condemn];
3819     }
3823 static void
3824 ns_redeem_scroll_bar (struct window *window)
3825 /* --------------------------------------------------------------------------
3826      External (hook): arrange to spare this window's scrollbar
3827      at next call to judge_scroll_bars.
3828    -------------------------------------------------------------------------- */
3830   id bar;
3831   NSTRACE (ns_redeem_scroll_bar);
3832   if (!NILP (window->vertical_scroll_bar))
3833     {
3834       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3835       [bar reprieve];
3836     }
3840 static void
3841 ns_judge_scroll_bars (struct frame *f)
3842 /* --------------------------------------------------------------------------
3843      External (hook): destroy all scrollbars on frame that weren't
3844      redeemed after call to condemn_scroll_bars.
3845    -------------------------------------------------------------------------- */
3847   int i;
3848   id view;
3849   EmacsView *eview = FRAME_NS_VIEW (f);
3850   NSArray *subviews = [[eview superview] subviews];
3851   BOOL removed = NO;
3853   NSTRACE (ns_judge_scroll_bars);
3854   for (i = [subviews count]-1; i >= 0; --i)
3855     {
3856       view = [subviews objectAtIndex: i];
3857       if (![view isKindOfClass: [EmacsScroller class]]) continue;
3858       [view judge];
3859       removed = YES;
3860     }
3862   if (removed)
3863     [eview updateFrameSize: NO];
3867 void
3868 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
3870   /* XXX irrelevant under NS */
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];
3970     Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
3972     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
3973     dpyinfo->resy = 72.27;
3974     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
3975                                                   NSColorSpaceFromDepth (depth)]
3976                 && ![NSCalibratedWhiteColorSpace isEqualToString:
3977                                                  NSColorSpaceFromDepth (depth)];
3978     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
3979     dpyinfo->image_cache = make_image_cache ();
3980     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
3981     dpyinfo->color_table->colors = NULL;
3982     dpyinfo->root_window = 42; /* a placeholder.. */
3984     hlinfo->mouse_face_mouse_frame = NULL;
3985     hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
3986     hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
3987     hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
3988     hlinfo->mouse_face_window = hlinfo->mouse_face_overlay = Qnil;
3989     hlinfo->mouse_face_hidden = 0;
3991     hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
3992     hlinfo->mouse_face_defer = 0;
3994     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
3996     dpyinfo->n_fonts = 0;
3997     dpyinfo->smallest_font_height = 1;
3998     dpyinfo->smallest_char_width = 1;
4002 /* This and next define (many of the) public functions in this file. */
4003 /* x_... are generic versions in xdisp.c that we, and other terms, get away
4004          with using despite presence in the "system dependent" redisplay
4005          interface.  In addition, many of the ns_ methods have code that is
4006          shared with all terms, indicating need for further refactoring. */
4007 extern frame_parm_handler ns_frame_parm_handlers[];
4008 static struct redisplay_interface ns_redisplay_interface =
4010   ns_frame_parm_handlers,
4011   x_produce_glyphs,
4012   x_write_glyphs,
4013   x_insert_glyphs,
4014   x_clear_end_of_line,
4015   ns_scroll_run,
4016   ns_after_update_window_line,
4017   ns_update_window_begin,
4018   ns_update_window_end,
4019   x_cursor_to,
4020   ns_flush,
4021   0, /* flush_display_optional */
4022   x_clear_window_mouse_face,
4023   x_get_glyph_overhangs,
4024   x_fix_overlapping_area,
4025   ns_draw_fringe_bitmap,
4026   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
4027   0, /* destroy_fringe_bitmap */
4028   ns_compute_glyph_string_overhangs,
4029   ns_draw_glyph_string, /* interface to nsfont.m */
4030   ns_define_frame_cursor,
4031   ns_clear_frame_area,
4032   ns_draw_window_cursor,
4033   ns_draw_vertical_window_border,
4034   ns_shift_glyphs_for_insert
4038 static void
4039 ns_delete_display (struct ns_display_info *dpyinfo)
4041   /* TODO... */
4045 /* This function is called when the last frame on a display is deleted. */
4046 static void
4047 ns_delete_terminal (struct terminal *terminal)
4049   struct ns_display_info *dpyinfo = terminal->display_info.ns;
4051   /* Protect against recursive calls.  delete_frame in
4052      delete_terminal calls us back when it deletes our last frame.  */
4053   if (!terminal->name)
4054     return;
4056   block_input ();
4058   x_destroy_all_bitmaps (dpyinfo);
4059   ns_delete_display (dpyinfo);
4060   unblock_input ();
4064 static struct terminal *
4065 ns_create_terminal (struct ns_display_info *dpyinfo)
4066 /* --------------------------------------------------------------------------
4067       Set up use of NS before we make the first connection.
4068    -------------------------------------------------------------------------- */
4070   struct terminal *terminal;
4072   NSTRACE (ns_create_terminal);
4074   terminal = create_terminal ();
4076   terminal->type = output_ns;
4077   terminal->display_info.ns = dpyinfo;
4078   dpyinfo->terminal = terminal;
4080   terminal->rif = &ns_redisplay_interface;
4082   terminal->clear_frame_hook = ns_clear_frame;
4083   terminal->ins_del_lines_hook = 0; /* XXX vestigial? */
4084   terminal->delete_glyphs_hook = 0; /* XXX vestigial? */
4085   terminal->ring_bell_hook = ns_ring_bell;
4086   terminal->reset_terminal_modes_hook = ns_reset_terminal_modes;
4087   terminal->set_terminal_modes_hook = ns_set_terminal_modes;
4088   terminal->update_begin_hook = ns_update_begin;
4089   terminal->update_end_hook = ns_update_end;
4090   terminal->set_terminal_window_hook = NULL; /* XXX vestigial? */
4091   terminal->read_socket_hook = ns_read_socket;
4092   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
4093   terminal->mouse_position_hook = ns_mouse_position;
4094   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
4095   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
4097   terminal->fullscreen_hook = ns_fullscreen_hook;
4099   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
4100   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
4101   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
4102   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
4104   terminal->delete_frame_hook = x_destroy_window;
4105   terminal->delete_terminal_hook = ns_delete_terminal;
4107   terminal->scroll_region_ok = 1;
4108   terminal->char_ins_del_ok = 1;
4109   terminal->line_ins_del_ok = 1;
4110   terminal->fast_clear_end_of_line = 1;
4111   terminal->memory_below_frame = 0;
4113   return terminal;
4117 struct ns_display_info *
4118 ns_term_init (Lisp_Object display_name)
4119 /* --------------------------------------------------------------------------
4120      Start the Application and get things rolling.
4121    -------------------------------------------------------------------------- */
4123   struct terminal *terminal;
4124   struct ns_display_info *dpyinfo;
4125   static int ns_initialized = 0;
4126   Lisp_Object tmp;
4128   if (ns_initialized) return x_display_list;
4129   ns_initialized = 1;
4131   NSTRACE (ns_term_init);
4133   [outerpool release];
4134   outerpool = [[NSAutoreleasePool alloc] init];
4136   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
4137   /*GSDebugAllocationActive (YES); */
4138   block_input ();
4140   baud_rate = 38400;
4141   Fset_input_interrupt_mode (Qnil);
4143   if (selfds[0] == -1)
4144     {
4145       if (pipe (selfds) == -1)
4146         {
4147           fprintf (stderr, "Failed to create pipe: %s\n",
4148                    emacs_strerror (errno));
4149           emacs_abort ();
4150         }
4152       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4153       FD_ZERO (&select_readfds);
4154       FD_ZERO (&select_writefds);
4155       pthread_mutex_init (&select_mutex, NULL);
4156     }
4158   ns_pending_files = [[NSMutableArray alloc] init];
4159   ns_pending_service_names = [[NSMutableArray alloc] init];
4160   ns_pending_service_args = [[NSMutableArray alloc] init];
4162 /* Start app and create the main menu, window, view.
4163      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4164      The view will then ask the NSApp to stop and return to Emacs. */
4165   [EmacsApp sharedApplication];
4166   if (NSApp == nil)
4167     return NULL;
4168   [NSApp setDelegate: NSApp];
4170   /* Start the select thread.  */
4171   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4172                            toTarget:NSApp
4173                          withObject:nil];
4175   /* debugging: log all notifications */
4176   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4177                                          selector: @selector (logNotification:)
4178                                              name: nil object: nil]; */
4180   dpyinfo = xzalloc (sizeof *dpyinfo);
4182   ns_initialize_display_info (dpyinfo);
4183   terminal = ns_create_terminal (dpyinfo);
4185   terminal->kboard = xmalloc (sizeof *terminal->kboard);
4186   init_kboard (terminal->kboard);
4187   kset_window_system (terminal->kboard, Qns);
4188   terminal->kboard->next_kboard = all_kboards;
4189   all_kboards = terminal->kboard;
4190   /* Don't let the initial kboard remain current longer than necessary.
4191      That would cause problems if a file loaded on startup tries to
4192      prompt in the mini-buffer.  */
4193   if (current_kboard == initial_kboard)
4194     current_kboard = terminal->kboard;
4195   terminal->kboard->reference_count++;
4197   dpyinfo->next = x_display_list;
4198   x_display_list = dpyinfo;
4200   /* Put it on ns_display_name_list */
4201   ns_display_name_list = Fcons (Fcons (display_name, Qnil),
4202                                 ns_display_name_list);
4203   dpyinfo->name_list_element = XCAR (ns_display_name_list);
4205   terminal->name = xstrdup (SSDATA (display_name));
4207   unblock_input ();
4209   if (!inhibit_x_resources)
4210     {
4211       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4212                  Qt, Qnil, NO, NO);
4213       tmp = Qnil;
4214       /* this is a standard variable */
4215       ns_default ("AppleAntiAliasingThreshold", &tmp,
4216                  make_float (10.0), make_float (6.0), YES, NO);
4217       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4218     }
4220   ns_selection_color = [[NSUserDefaults standardUserDefaults]
4221                          stringForKey: @"AppleHighlightColor"];
4222   if (ns_selection_color == nil)
4223     ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
4225   {
4226     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4228     if ( cl == nil )
4229       {
4230         Lisp_Object color_file, color_map, color;
4231         unsigned long c;
4232         char *name;
4234         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4235                          Fsymbol_value (intern ("data-directory")));
4237         color_map = Fx_load_color_file (color_file);
4238         if (NILP (color_map))
4239           fatal ("Could not read %s.\n", SDATA (color_file));
4241         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4242         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4243           {
4244             color = XCAR (color_map);
4245             name = SSDATA (XCAR (color));
4246             c = XINT (XCDR (color));
4247             [cl setColor:
4248                   [NSColor colorWithCalibratedRed: RED_FROM_ULONG (c) / 255.0
4249                                             green: GREEN_FROM_ULONG (c) / 255.0
4250                                              blue: BLUE_FROM_ULONG (c) / 255.0
4251                                             alpha: 1.0]
4252                   forKey: [NSString stringWithUTF8String: name]];
4253           }
4254         [cl writeToFile: nil];
4255       }
4256   }
4258   {
4259 #ifdef NS_IMPL_GNUSTEP
4260     Vwindow_system_version = build_string (gnustep_base_version);
4261 #else
4262     /*PSnextrelease (128, c); */
4263     char c[DBL_BUFSIZE_BOUND];
4264     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4265     Vwindow_system_version = make_unibyte_string (c, len);
4266 #endif
4267   }
4269   delete_keyboard_wait_descriptor (0);
4271   ns_app_name = [[NSProcessInfo processInfo] processName];
4273 /* Set up OS X app menu */
4274 #ifdef NS_IMPL_COCOA
4275   {
4276     NSMenu *appMenu;
4277     NSMenuItem *item;
4278     /* set up the application menu */
4279     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4280     [svcsMenu setAutoenablesItems: NO];
4281     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4282     [appMenu setAutoenablesItems: NO];
4283     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4284     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4286     [appMenu insertItemWithTitle: @"About Emacs"
4287                           action: @selector (orderFrontStandardAboutPanel:)
4288                    keyEquivalent: @""
4289                          atIndex: 0];
4290     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4291     [appMenu insertItemWithTitle: @"Preferences..."
4292                           action: @selector (showPreferencesWindow:)
4293                    keyEquivalent: @","
4294                          atIndex: 2];
4295     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4296     item = [appMenu insertItemWithTitle: @"Services"
4297                                  action: @selector (menuDown:)
4298                           keyEquivalent: @""
4299                                 atIndex: 4];
4300     [appMenu setSubmenu: svcsMenu forItem: item];
4301     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4302     [appMenu insertItemWithTitle: @"Hide Emacs"
4303                           action: @selector (hide:)
4304                    keyEquivalent: @"h"
4305                          atIndex: 6];
4306     item =  [appMenu insertItemWithTitle: @"Hide Others"
4307                           action: @selector (hideOtherApplications:)
4308                    keyEquivalent: @"h"
4309                          atIndex: 7];
4310     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4311     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4312     [appMenu insertItemWithTitle: @"Quit Emacs"
4313                           action: @selector (terminate:)
4314                    keyEquivalent: @"q"
4315                          atIndex: 9];
4317     item = [mainMenu insertItemWithTitle: ns_app_name
4318                                   action: @selector (menuDown:)
4319                            keyEquivalent: @""
4320                                  atIndex: 0];
4321     [mainMenu setSubmenu: appMenu forItem: item];
4322     [dockMenu insertItemWithTitle: @"New Frame"
4323                            action: @selector (newFrame:)
4324                     keyEquivalent: @""
4325                           atIndex: 0];
4327     [NSApp setMainMenu: mainMenu];
4328     [NSApp setAppleMenu: appMenu];
4329     [NSApp setServicesMenu: svcsMenu];
4330     /* Needed at least on Cocoa, to get dock menu to show windows */
4331     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4333     [[NSNotificationCenter defaultCenter]
4334       addObserver: mainMenu
4335          selector: @selector (trackingNotification:)
4336              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4337     [[NSNotificationCenter defaultCenter]
4338       addObserver: mainMenu
4339          selector: @selector (trackingNotification:)
4340              name: NSMenuDidEndTrackingNotification object: mainMenu];
4341   }
4342 #endif /* MAC OS X menu setup */
4344   /* Register our external input/output types, used for determining
4345      applicable services and also drag/drop eligibility. */
4346   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4347   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4348                       retain];
4349   ns_drag_types = [[NSArray arrayWithObjects:
4350                             NSStringPboardType,
4351                             NSTabularTextPboardType,
4352                             NSFilenamesPboardType,
4353                             NSURLPboardType,
4354                             NSColorPboardType,
4355                             NSFontPboardType, nil] retain];
4357   /* If fullscreen is in init/default-frame-alist, focus isn't set
4358      right for fullscreen windows, so set this.  */
4359   [NSApp activateIgnoringOtherApps:YES];
4361   [NSApp run];
4362   ns_do_open_file = YES;
4364 #ifdef NS_IMPL_GNUSTEP
4365   /* GNUstep steals SIGCHLD for use in NSTask, but we don't use NSTask.
4366      We must re-catch it so subprocess works.  */
4367   catch_child_signal ();
4368 #endif
4369   return dpyinfo;
4373 void
4374 ns_term_shutdown (int sig)
4376   [[NSUserDefaults standardUserDefaults] synchronize];
4378   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4379   if (STRINGP (Vauto_save_list_file_name))
4380     unlink (SSDATA (Vauto_save_list_file_name));
4382   if (sig == 0 || sig == SIGTERM)
4383     {
4384       [NSApp terminate: NSApp];
4385     }
4386   else // force a stack trace to happen
4387     {
4388       emacs_abort ();
4389     }
4393 /* ==========================================================================
4395     EmacsApp implementation
4397    ========================================================================== */
4400 @implementation EmacsApp
4402 - (void)logNotification: (NSNotification *)notification
4404   const char *name = [[notification name] UTF8String];
4405   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4406       && !strstr (name, "WindowNumber"))
4407     NSLog (@"notification: '%@'", [notification name]);
4411 - (void)sendEvent: (NSEvent *)theEvent
4412 /* --------------------------------------------------------------------------
4413      Called when NSApp is running for each event received.  Used to stop
4414      the loop when we choose, since there's no way to just run one iteration.
4415    -------------------------------------------------------------------------- */
4417   int type = [theEvent type];
4418   NSWindow *window = [theEvent window];
4419 /*  NSTRACE (sendEvent); */
4420 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4422 #ifdef NS_IMPL_COCOA
4423   if (type == NSApplicationDefined
4424       && [theEvent data2] == NSAPP_DATA2_RUNASSCRIPT)
4425     {
4426       ns_run_ascript ();
4427       [self stop: self];
4428       return;
4429     }
4430 #endif
4432   if (type == NSCursorUpdate && window == nil)
4433     {
4434       fprintf (stderr, "Dropping external cursor update event.\n");
4435       return;
4436     }
4438   if (type == NSApplicationDefined)
4439     {
4440       /* Events posted by ns_send_appdefined interrupt the run loop here.
4441          But, if a modal window is up, an appdefined can still come through,
4442          (e.g., from a makeKeyWindow event) but stopping self also stops the
4443          modal loop. Just defer it until later. */
4444       if ([NSApp modalWindow] == nil)
4445         {
4446           last_appdefined_event_data = [theEvent data1];
4447           [self stop: self];
4448         }
4449       else
4450         {
4451           send_appdefined = YES;
4452         }
4453     }
4455   [super sendEvent: theEvent];
4459 - (void)showPreferencesWindow: (id)sender
4461   struct frame *emacsframe = SELECTED_FRAME ();
4462   NSEvent *theEvent = [NSApp currentEvent];
4464   if (!emacs_event)
4465     return;
4466   emacs_event->kind = NS_NONKEY_EVENT;
4467   emacs_event->code = KEY_NS_SHOW_PREFS;
4468   emacs_event->modifiers = 0;
4469   EV_TRAILER (theEvent);
4473 - (void)newFrame: (id)sender
4475   struct frame *emacsframe = SELECTED_FRAME ();
4476   NSEvent *theEvent = [NSApp currentEvent];
4478   if (!emacs_event)
4479     return;
4480   emacs_event->kind = NS_NONKEY_EVENT;
4481   emacs_event->code = KEY_NS_NEW_FRAME;
4482   emacs_event->modifiers = 0;
4483   EV_TRAILER (theEvent);
4487 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4488 - (BOOL) openFile: (NSString *)fileName
4490   struct frame *emacsframe = SELECTED_FRAME ();
4491   NSEvent *theEvent = [NSApp currentEvent];
4493   if (!emacs_event)
4494     return NO;
4496   emacs_event->kind = NS_NONKEY_EVENT;
4497   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4498   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4499   ns_input_line = Qnil; /* can be start or cons start,end */
4500   emacs_event->modifiers =0;
4501   EV_TRAILER (theEvent);
4503   return YES;
4507 /* **************************************************************************
4509       EmacsApp delegate implementation
4511    ************************************************************************** */
4513 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4514 /* --------------------------------------------------------------------------
4515      When application is loaded, terminate event loop in ns_term_init
4516    -------------------------------------------------------------------------- */
4518   NSTRACE (applicationDidFinishLaunching);
4519   [NSApp setServicesProvider: NSApp];
4520   ns_send_appdefined (-2);
4524 /* Termination sequences:
4525     C-x C-c:
4526     Cmd-Q:
4527     MenuBar | File | Exit:
4528     Select Quit from App menubar:
4529         -terminate
4530         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4531         ns_term_shutdown()
4533     Select Quit from Dock menu:
4534     Logout attempt:
4535         -appShouldTerminate
4536           Cancel -> Nothing else
4537           Accept ->
4539           -terminate
4540           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4541           ns_term_shutdown()
4545 - (void) terminate: (id)sender
4547   struct frame *emacsframe = SELECTED_FRAME ();
4549   if (!emacs_event)
4550     return;
4552   emacs_event->kind = NS_NONKEY_EVENT;
4553   emacs_event->code = KEY_NS_POWER_OFF;
4554   emacs_event->arg = Qt; /* mark as non-key event */
4555   EV_TRAILER ((id)nil);
4559 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4561   int ret;
4563   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4564     return NSTerminateNow;
4566     ret = NSRunAlertPanel(ns_app_name,
4567                           @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4568                           @"Save Buffers and Exit", @"Cancel", nil);
4570     if (ret == NSAlertDefaultReturn)
4571         return NSTerminateNow;
4572     else if (ret == NSAlertAlternateReturn)
4573         return NSTerminateCancel;
4574     return NSTerminateNow;  /* just in case */
4577 static int
4578 not_in_argv (NSString *arg)
4580   int k;
4581   const char *a = [arg UTF8String];
4582   for (k = 1; k < initial_argc; ++k)
4583     if (strcmp (a, initial_argv[k]) == 0) return 0;
4584   return 1;
4587 /*   Notification from the Workspace to open a file */
4588 - (BOOL)application: sender openFile: (NSString *)file
4590   if (ns_do_open_file || not_in_argv (file))
4591     [ns_pending_files addObject: file];
4592   return YES;
4596 /*   Open a file as a temporary file */
4597 - (BOOL)application: sender openTempFile: (NSString *)file
4599   if (ns_do_open_file || not_in_argv (file))
4600     [ns_pending_files addObject: file];
4601   return YES;
4605 /*   Notification from the Workspace to open a file noninteractively (?) */
4606 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4608   if (ns_do_open_file || not_in_argv (file))
4609     [ns_pending_files addObject: file];
4610   return YES;
4613 /*   Notification from the Workspace to open multiple files */
4614 - (void)application: sender openFiles: (NSArray *)fileList
4616   NSEnumerator *files = [fileList objectEnumerator];
4617   NSString *file;
4618   /* Don't open files from the command line unconditionally,
4619      Cocoa parses the command line wrong, --option value tries to open value
4620      if --option is the last option.  */
4621   while ((file = [files nextObject]) != nil)
4622     if (ns_do_open_file || not_in_argv (file))
4623       [ns_pending_files addObject: file];
4625   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4630 /* Handle dock menu requests.  */
4631 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4633   return dockMenu;
4637 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4638 - (void)applicationWillBecomeActive: (NSNotification *)notification
4640   //ns_app_active=YES;
4642 - (void)applicationDidBecomeActive: (NSNotification *)notification
4644   NSTRACE (applicationDidBecomeActive);
4646   //ns_app_active=YES;
4648   ns_update_auto_hide_menu_bar ();
4649   // No constraining takes place when the application is not active.
4650   ns_constrain_all_frames ();
4652 - (void)applicationDidResignActive: (NSNotification *)notification
4654   //ns_app_active=NO;
4655   ns_send_appdefined (-1);
4660 /* ==========================================================================
4662     EmacsApp aux handlers for managing event loop
4664    ========================================================================== */
4667 - (void)timeout_handler: (NSTimer *)timedEntry
4668 /* --------------------------------------------------------------------------
4669      The timeout specified to ns_select has passed.
4670    -------------------------------------------------------------------------- */
4672   /*NSTRACE (timeout_handler); */
4673   ns_send_appdefined (-2);
4676 #ifdef NS_IMPL_GNUSTEP
4677 - (void)sendFromMainThread:(id)unused
4679   ns_send_appdefined (nextappdefined);
4681 #endif
4683 - (void)fd_handler:(id)unused
4684 /* --------------------------------------------------------------------------
4685      Check data waiting on file descriptors and terminate if so
4686    -------------------------------------------------------------------------- */
4688   int result;
4689   int waiting = 1, nfds;
4690   char c;
4692   SELECT_TYPE readfds, writefds, *wfds;
4693   EMACS_TIME timeout, *tmo;
4694   NSAutoreleasePool *pool = nil;
4696   /* NSTRACE (fd_handler); */
4698   for (;;)
4699     {
4700       [pool release];
4701       pool = [[NSAutoreleasePool alloc] init];
4703       if (waiting)
4704         {
4705           SELECT_TYPE fds;
4706           FD_ZERO (&fds);
4707           FD_SET (selfds[0], &fds);
4708           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
4709           if (result > 0 && read (selfds[0], &c, 1) == 1 && c == 'g')
4710             waiting = 0;
4711         }
4712       else
4713         {
4714           pthread_mutex_lock (&select_mutex);
4715           nfds = select_nfds;
4717           if (select_valid & SELECT_HAVE_READ)
4718             readfds = select_readfds;
4719           else
4720             FD_ZERO (&readfds);
4722           if (select_valid & SELECT_HAVE_WRITE)
4723             {
4724               writefds = select_writefds;
4725               wfds = &writefds;
4726             }
4727           else
4728             wfds = NULL;
4729           if (select_valid & SELECT_HAVE_TMO)
4730             {
4731               timeout = select_timeout;
4732               tmo = &timeout;
4733             }
4734           else
4735             tmo = NULL;
4737           pthread_mutex_unlock (&select_mutex);
4739           FD_SET (selfds[0], &readfds);
4740           if (selfds[0] >= nfds) nfds = selfds[0]+1;
4742           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
4744           if (result == 0)
4745             ns_send_appdefined (-2);
4746           else if (result > 0)
4747             {
4748               if (FD_ISSET (selfds[0], &readfds))
4749                 {
4750                   if (read (selfds[0], &c, 1) == 1 && c == 's')
4751                     waiting = 1;
4752                 }
4753               else
4754                 {
4755                   pthread_mutex_lock (&select_mutex);
4756                   if (select_valid & SELECT_HAVE_READ)
4757                     select_readfds = readfds;
4758                   if (select_valid & SELECT_HAVE_WRITE)
4759                     select_writefds = writefds;
4760                   if (select_valid & SELECT_HAVE_TMO)
4761                     select_timeout = timeout;
4762                   pthread_mutex_unlock (&select_mutex);
4764                   ns_send_appdefined (result);
4765                 }
4766             }
4767           waiting = 1;
4768         }
4769     }
4774 /* ==========================================================================
4776     Service provision
4778    ========================================================================== */
4780 /* called from system: queue for next pass through event loop */
4781 - (void)requestService: (NSPasteboard *)pboard
4782               userData: (NSString *)userData
4783                  error: (NSString **)error
4785   [ns_pending_service_names addObject: userData];
4786   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4787       SSDATA (ns_string_from_pasteboard (pboard))]];
4791 /* called from ns_read_socket to clear queue */
4792 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4794   struct frame *emacsframe = SELECTED_FRAME ();
4795   NSEvent *theEvent = [NSApp currentEvent];
4797   if (!emacs_event)
4798     return NO;
4800   emacs_event->kind = NS_NONKEY_EVENT;
4801   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
4802   ns_input_spi_name = build_string ([name UTF8String]);
4803   ns_input_spi_arg = build_string ([arg UTF8String]);
4804   emacs_event->modifiers = EV_MODIFIERS (theEvent);
4805   EV_TRAILER (theEvent);
4807   return YES;
4811 @end  /* EmacsApp */
4815 /* ==========================================================================
4817     EmacsView implementation
4819    ========================================================================== */
4822 @implementation EmacsView
4824 /* needed to inform when window closed from LISP */
4825 - (void) setWindowClosing: (BOOL)closing
4827   windowClosing = closing;
4831 - (void)dealloc
4833   NSTRACE (EmacsView_dealloc);
4834   [toolbar release];
4835   if (fs_state == FULLSCREEN_BOTH)
4836     [nonfs_window release];
4837   [super dealloc];
4841 /* called on font panel selection */
4842 - (void)changeFont: (id)sender
4844   NSEvent *e =[[self window] currentEvent];
4845   struct face *face =FRAME_DEFAULT_FACE (emacsframe);
4846   id newFont;
4847   CGFloat size;
4849   NSTRACE (changeFont);
4850   if (!emacs_event)
4851     return;
4853   if ((newFont = [sender convertFont:
4854                            ((struct nsfont_info *)face->font)->nsfont]))
4855     {
4856       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
4858       emacs_event->kind = NS_NONKEY_EVENT;
4859       emacs_event->modifiers = 0;
4860       emacs_event->code = KEY_NS_CHANGE_FONT;
4862       size = [newFont pointSize];
4863       ns_input_fontsize = make_number (lrint (size));
4864       ns_input_font = build_string ([[newFont familyName] UTF8String]);
4865       EV_TRAILER (e);
4866     }
4870 - (BOOL)acceptsFirstResponder
4872   NSTRACE (acceptsFirstResponder);
4873   return YES;
4877 - (void)resetCursorRects
4879   NSRect visible = [self visibleRect];
4880   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
4881   NSTRACE (resetCursorRects);
4883   if (currentCursor == nil)
4884     currentCursor = [NSCursor arrowCursor];
4886   if (!NSIsEmptyRect (visible))
4887     [self addCursorRect: visible cursor: currentCursor];
4888   [currentCursor setOnMouseEntered: YES];
4893 /*****************************************************************************/
4894 /* Keyboard handling. */
4895 #define NS_KEYLOG 0
4897 - (void)keyDown: (NSEvent *)theEvent
4899   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
4900   int code;
4901   unsigned fnKeysym = 0;
4902   static NSMutableArray *nsEvArray;
4903 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
4904   static BOOL firstTime = YES;
4905 #endif
4906   int left_is_none;
4907   unsigned int flags = [theEvent modifierFlags];
4909   NSTRACE (keyDown);
4911   /* Rhapsody and OS X give up and down events for the arrow keys */
4912   if (ns_fake_keydown == YES)
4913     ns_fake_keydown = NO;
4914   else if ([theEvent type] != NSKeyDown)
4915     return;
4917   if (!emacs_event)
4918     return;
4920  if (![[self window] isKeyWindow]
4921      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
4922      /* we must avoid an infinite loop here. */
4923      && (EmacsView *)[[theEvent window] delegate] != self)
4924    {
4925      /* XXX: There is an occasional condition in which, when Emacs display
4926          updates a different frame from the current one, and temporarily
4927          selects it, then processes some interrupt-driven input
4928          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
4929          for some reason that window has its first responder set to the NSView
4930          most recently updated (I guess), which is not the correct one. */
4931      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
4932      return;
4933    }
4935   if (nsEvArray == nil)
4936     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
4938   [NSCursor setHiddenUntilMouseMoves: YES];
4940   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
4941     {
4942       clear_mouse_face (hlinfo);
4943       hlinfo->mouse_face_hidden = 1;
4944     }
4946   if (!processingCompose)
4947     {
4948       /* When using screen sharing, no left or right information is sent,
4949          so use Left key in those cases.  */
4950       int is_left_key, is_right_key;
4952       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
4953         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
4955       /* (Carbon way: [theEvent keyCode]) */
4957       /* is it a "function key"? */
4958       fnKeysym = (code < 0x00ff && (flags&NSNumericPadKeyMask))
4959         ? ns_convert_key ([theEvent keyCode] | NSNumericPadKeyMask)
4960         : ns_convert_key (code);
4962       if (fnKeysym)
4963         {
4964           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
4965              because Emacs treats Delete and KP-Delete same (in simple.el). */
4966           if ((fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
4967 #ifdef NS_IMPL_GNUSTEP
4968               /*  GNUstep uses incompatible keycodes, even for those that are
4969                   supposed to be hardware independent.  Just check for delete.
4970                   Keypad delete does not have keysym 0xFFFF.
4971                   See http://savannah.gnu.org/bugs/?25395
4972               */
4973               || (fnKeysym == 0xFFFF && code == 127)
4974 #endif
4975             )
4976             code = 0xFF08; /* backspace */
4977           else
4978             code = fnKeysym;
4979         }
4981       /* are there modifiers? */
4982       emacs_event->modifiers = 0;
4984       if (flags & NSHelpKeyMask)
4985           emacs_event->modifiers |= hyper_modifier;
4987       if (flags & NSShiftKeyMask)
4988         emacs_event->modifiers |= shift_modifier;
4990       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
4991       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
4992         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
4994       if (is_right_key)
4995         emacs_event->modifiers |= parse_solitary_modifier
4996           (EQ (ns_right_command_modifier, Qleft)
4997            ? ns_command_modifier
4998            : ns_right_command_modifier);
5000       if (is_left_key)
5001         {
5002           emacs_event->modifiers |= parse_solitary_modifier
5003             (ns_command_modifier);
5005           /* if super (default), take input manager's word so things like
5006              dvorak / qwerty layout work */
5007           if (EQ (ns_command_modifier, Qsuper)
5008               && !fnKeysym
5009               && [[theEvent characters] length] != 0)
5010             {
5011               /* XXX: the code we get will be unshifted, so if we have
5012                  a shift modifier, must convert ourselves */
5013               if (!(flags & NSShiftKeyMask))
5014                 code = [[theEvent characters] characterAtIndex: 0];
5015 #if 0
5016               /* this is ugly and also requires linking w/Carbon framework
5017                  (for LMGetKbdType) so for now leave this rare (?) case
5018                  undealt with.. in future look into CGEvent methods */
5019               else
5020                 {
5021                   long smv = GetScriptManagerVariable (smKeyScript);
5022                   Handle uchrHandle = GetResource
5023                     ('uchr', GetScriptVariable (smv, smScriptKeys));
5024                   UInt32 dummy = 0;
5025                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
5026                                  [[theEvent characters] characterAtIndex: 0],
5027                                  kUCKeyActionDisplay,
5028                                  (flags & ~NSCommandKeyMask) >> 8,
5029                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
5030                                  &dummy, 1, &dummy, &code);
5031                   code &= 0xFF;
5032                 }
5033 #endif
5034             }
5035         }
5037       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
5038       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
5039         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
5041       if (is_right_key)
5042           emacs_event->modifiers |= parse_solitary_modifier
5043               (EQ (ns_right_control_modifier, Qleft)
5044                ? ns_control_modifier
5045                : ns_right_control_modifier);
5047       if (is_left_key)
5048         emacs_event->modifiers |= parse_solitary_modifier
5049           (ns_control_modifier);
5051       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
5052           emacs_event->modifiers |=
5053             parse_solitary_modifier (ns_function_modifier);
5055       left_is_none = NILP (ns_alternate_modifier)
5056         || EQ (ns_alternate_modifier, Qnone);
5058       is_right_key = (flags & NSRightAlternateKeyMask)
5059         == NSRightAlternateKeyMask;
5060       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
5061         || (! is_right_key
5062             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
5064       if (is_right_key)
5065         {
5066           if ((NILP (ns_right_alternate_modifier)
5067                || EQ (ns_right_alternate_modifier, Qnone)
5068                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
5069               && !fnKeysym)
5070             {   /* accept pre-interp alt comb */
5071               if ([[theEvent characters] length] > 0)
5072                 code = [[theEvent characters] characterAtIndex: 0];
5073               /*HACK: clear lone shift modifier to stop next if from firing */
5074               if (emacs_event->modifiers == shift_modifier)
5075                 emacs_event->modifiers = 0;
5076             }
5077           else
5078             emacs_event->modifiers |= parse_solitary_modifier
5079               (EQ (ns_right_alternate_modifier, Qleft)
5080                ? ns_alternate_modifier
5081                : ns_right_alternate_modifier);
5082         }
5084       if (is_left_key) /* default = meta */
5085         {
5086           if (left_is_none && !fnKeysym)
5087             {   /* accept pre-interp alt comb */
5088               if ([[theEvent characters] length] > 0)
5089                 code = [[theEvent characters] characterAtIndex: 0];
5090               /*HACK: clear lone shift modifier to stop next if from firing */
5091               if (emacs_event->modifiers == shift_modifier)
5092                 emacs_event->modifiers = 0;
5093             }
5094           else
5095               emacs_event->modifiers |=
5096                 parse_solitary_modifier (ns_alternate_modifier);
5097         }
5099   if (NS_KEYLOG)
5100     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
5101              code, fnKeysym, flags, emacs_event->modifiers);
5103       /* if it was a function key or had modifiers, pass it directly to emacs */
5104       if (fnKeysym || (emacs_event->modifiers
5105                        && (emacs_event->modifiers != shift_modifier)
5106                        && [[theEvent charactersIgnoringModifiers] length] > 0))
5107 /*[[theEvent characters] length] */
5108         {
5109           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5110           if (code < 0x20)
5111             code |= (1<<28)|(3<<16);
5112           else if (code == 0x7f)
5113             code |= (1<<28)|(3<<16);
5114           else if (!fnKeysym)
5115             emacs_event->kind = code > 0xFF
5116               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5118           emacs_event->code = code;
5119           EV_TRAILER (theEvent);
5120           processingCompose = NO;
5121           return;
5122         }
5123     }
5126 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
5127   /* if we get here we should send the key for input manager processing */
5128   /* Disable warning, there is nothing a user can do about it anyway, and
5129      it does not seem to matter.  */
5130 #if 0
5131   if (firstTime && [[NSInputManager currentInputManager]
5132                      wantsToDelayTextChangeNotifications] == NO)
5133     fprintf (stderr,
5134           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
5135 #endif
5136   firstTime = NO;
5137 #endif
5138   if (NS_KEYLOG && !processingCompose)
5139     fprintf (stderr, "keyDown: Begin compose sequence.\n");
5141   processingCompose = YES;
5142   [nsEvArray addObject: theEvent];
5143   [self interpretKeyEvents: nsEvArray];
5144   [nsEvArray removeObject: theEvent];
5148 #ifdef NS_IMPL_COCOA
5149 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
5150    decided not to send key-down for.
5151    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
5152    This only applies on Tiger and earlier.
5153    If it matches one of these, send it on to keyDown. */
5154 -(void)keyUp: (NSEvent *)theEvent
5156   int flags = [theEvent modifierFlags];
5157   int code = [theEvent keyCode];
5158   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5159       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5160     {
5161       if (NS_KEYLOG)
5162         fprintf (stderr, "keyUp: passed test");
5163       ns_fake_keydown = YES;
5164       [self keyDown: theEvent];
5165     }
5167 #endif
5170 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5173 /* <NSTextInput>: called when done composing;
5174    NOTE: also called when we delete over working text, followed immed.
5175          by doCommandBySelector: deleteBackward: */
5176 - (void)insertText: (id)aString
5178   int code;
5179   int len = [(NSString *)aString length];
5180   int i;
5182   if (NS_KEYLOG)
5183     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5184   processingCompose = NO;
5186   if (!emacs_event)
5187     return;
5189   /* first, clear any working text */
5190   if (workingText != nil)
5191     [self deleteWorkingText];
5193   /* now insert the string as keystrokes */
5194   for (i =0; i<len; i++)
5195     {
5196       code = [aString characterAtIndex: i];
5197       /* TODO: still need this? */
5198       if (code == 0x2DC)
5199         code = '~'; /* 0x7E */
5200       if (code != 32) /* Space */
5201         emacs_event->modifiers = 0;
5202       emacs_event->kind
5203         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5204       emacs_event->code = code;
5205       EV_TRAILER ((id)nil);
5206     }
5210 /* <NSTextInput>: inserts display of composing characters */
5211 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5213   NSString *str = [aString respondsToSelector: @selector (string)] ?
5214     [aString string] : aString;
5215   if (NS_KEYLOG)
5216     NSLog (@"setMarkedText '%@' len =%d range %d from %d", str, [str length],
5217            selRange.length, selRange.location);
5219   if (workingText != nil)
5220     [self deleteWorkingText];
5221   if ([str length] == 0)
5222     return;
5224   if (!emacs_event)
5225     return;
5227   processingCompose = YES;
5228   workingText = [str copy];
5229   ns_working_text = build_string ([workingText UTF8String]);
5231   emacs_event->kind = NS_TEXT_EVENT;
5232   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5233   EV_TRAILER ((id)nil);
5237 /* delete display of composing characters [not in <NSTextInput>] */
5238 - (void)deleteWorkingText
5240   if (workingText == nil)
5241     return;
5242   if (NS_KEYLOG)
5243     NSLog(@"deleteWorkingText len =%d\n", [workingText length]);
5244   [workingText release];
5245   workingText = nil;
5246   processingCompose = NO;
5248   if (!emacs_event)
5249     return;
5251   emacs_event->kind = NS_TEXT_EVENT;
5252   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5253   EV_TRAILER ((id)nil);
5257 - (BOOL)hasMarkedText
5259   return workingText != nil;
5263 - (NSRange)markedRange
5265   NSRange rng = workingText != nil
5266     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5267   if (NS_KEYLOG)
5268     NSLog (@"markedRange request");
5269   return rng;
5273 - (void)unmarkText
5275   if (NS_KEYLOG)
5276     NSLog (@"unmark (accept) text");
5277   [self deleteWorkingText];
5278   processingCompose = NO;
5282 /* used to position char selection windows, etc. */
5283 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5285   NSRect rect;
5286   NSPoint pt;
5287   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5288   if (NS_KEYLOG)
5289     NSLog (@"firstRectForCharRange request");
5291   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5292   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5293   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5294   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5295                                        +FRAME_LINE_HEIGHT (emacsframe));
5297   pt = [self convertPoint: pt toView: nil];
5298   pt = [[self window] convertBaseToScreen: pt];
5299   rect.origin = pt;
5300   return rect;
5304 - (NSInteger)conversationIdentifier
5306   return (NSInteger)self;
5310 - (void)doCommandBySelector: (SEL)aSelector
5312   if (NS_KEYLOG)
5313     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5315   processingCompose = NO;
5316   if (aSelector == @selector (deleteBackward:))
5317     {
5318       /* happens when user backspaces over an ongoing composition:
5319          throw a 'delete' into the event queue */
5320       if (!emacs_event)
5321         return;
5322       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5323       emacs_event->code = 0xFF08;
5324       EV_TRAILER ((id)nil);
5325     }
5328 - (NSArray *)validAttributesForMarkedText
5330   static NSArray *arr = nil;
5331   if (arr == nil) arr = [NSArray new];
5332  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5333   return arr;
5336 - (NSRange)selectedRange
5338   if (NS_KEYLOG)
5339     NSLog (@"selectedRange request");
5340   return NSMakeRange (NSNotFound, 0);
5343 #if defined (NS_IMPL_COCOA) || GNUSTEP_GUI_MAJOR_VERSION > 0 || \
5344     GNUSTEP_GUI_MINOR_VERSION > 22
5345 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5346 #else
5347 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
5348 #endif
5350   if (NS_KEYLOG)
5351     NSLog (@"characterIndexForPoint request");
5352   return 0;
5355 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5357   static NSAttributedString *str = nil;
5358   if (str == nil) str = [NSAttributedString new];
5359   if (NS_KEYLOG)
5360     NSLog (@"attributedSubstringFromRange request");
5361   return str;
5364 /* End <NSTextInput> impl. */
5365 /*****************************************************************************/
5368 /* This is what happens when the user presses a mouse button.  */
5369 - (void)mouseDown: (NSEvent *)theEvent
5371   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5373   NSTRACE (mouseDown);
5375   [self deleteWorkingText];
5377   if (!emacs_event)
5378     return;
5380   last_mouse_frame = emacsframe;
5381   /* appears to be needed to prevent spurious movement events generated on
5382      button clicks */
5383   last_mouse_frame->mouse_moved = 0;
5385   if ([theEvent type] == NSScrollWheel)
5386     {
5387       CGFloat delta = [theEvent deltaY];
5388       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5389       if (delta == 0)
5390         return;
5391       emacs_event->kind = WHEEL_EVENT;
5392       emacs_event->code = 0;
5393       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5394         ((delta > 0) ? up_modifier : down_modifier);
5395     }
5396   else
5397     {
5398       emacs_event->kind = MOUSE_CLICK_EVENT;
5399       emacs_event->code = EV_BUTTON (theEvent);
5400       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5401                              | EV_UDMODIFIERS (theEvent);
5402     }
5403   XSETINT (emacs_event->x, lrint (p.x));
5404   XSETINT (emacs_event->y, lrint (p.y));
5405   EV_TRAILER (theEvent);
5409 - (void)rightMouseDown: (NSEvent *)theEvent
5411   NSTRACE (rightMouseDown);
5412   [self mouseDown: theEvent];
5416 - (void)otherMouseDown: (NSEvent *)theEvent
5418   NSTRACE (otherMouseDown);
5419   [self mouseDown: theEvent];
5423 - (void)mouseUp: (NSEvent *)theEvent
5425   NSTRACE (mouseUp);
5426   [self mouseDown: theEvent];
5430 - (void)rightMouseUp: (NSEvent *)theEvent
5432   NSTRACE (rightMouseUp);
5433   [self mouseDown: theEvent];
5437 - (void)otherMouseUp: (NSEvent *)theEvent
5439   NSTRACE (otherMouseUp);
5440   [self mouseDown: theEvent];
5444 - (void) scrollWheel: (NSEvent *)theEvent
5446   NSTRACE (scrollWheel);
5447   [self mouseDown: theEvent];
5451 /* Tell emacs the mouse has moved. */
5452 - (void)mouseMoved: (NSEvent *)e
5454   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5455   Lisp_Object frame;
5457 //  NSTRACE (mouseMoved);
5459   last_mouse_movement_time = EV_TIMESTAMP (e);
5460   last_mouse_motion_position
5461     = [self convertPoint: [e locationInWindow] fromView: nil];
5463   /* update any mouse face */
5464   if (hlinfo->mouse_face_hidden)
5465     {
5466       hlinfo->mouse_face_hidden = 0;
5467       clear_mouse_face (hlinfo);
5468     }
5470   /* tooltip handling */
5471   previous_help_echo_string = help_echo_string;
5472   help_echo_string = Qnil;
5474   if (!note_mouse_movement (emacsframe, last_mouse_motion_position.x,
5475                             last_mouse_motion_position.y))
5476     help_echo_string = previous_help_echo_string;
5478   XSETFRAME (frame, emacsframe);
5479   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5480     {
5481       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5482          (note_mouse_highlight), which is called through the
5483          note_mouse_movement () call above */
5484       gen_help_event (help_echo_string, frame, help_echo_window,
5485                       help_echo_object, help_echo_pos);
5486     }
5487   else
5488     {
5489       help_echo_string = Qnil;
5490       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
5491     }
5493   if (emacsframe->mouse_moved && send_appdefined)
5494     ns_send_appdefined (-1);
5498 - (void)mouseDragged: (NSEvent *)e
5500   NSTRACE (mouseDragged);
5501   [self mouseMoved: e];
5505 - (void)rightMouseDragged: (NSEvent *)e
5507   NSTRACE (rightMouseDragged);
5508   [self mouseMoved: e];
5512 - (void)otherMouseDragged: (NSEvent *)e
5514   NSTRACE (otherMouseDragged);
5515   [self mouseMoved: e];
5519 - (BOOL)windowShouldClose: (id)sender
5521   NSEvent *e =[[self window] currentEvent];
5523   NSTRACE (windowShouldClose);
5524   windowClosing = YES;
5525   if (!emacs_event)
5526     return NO;
5527   emacs_event->kind = DELETE_WINDOW_EVENT;
5528   emacs_event->modifiers = 0;
5529   emacs_event->code = 0;
5530   EV_TRAILER (e);
5531   /* Don't close this window, let this be done from lisp code.  */
5532   return NO;
5535 - (void) updateFrameSize: (BOOL) delay;
5537   NSWindow *window = [self window];
5538   NSRect wr = [window frame];
5539   int extra = 0;
5540   int gsextra = 0;
5541 #ifdef NS_IMPL_GNUSTEP
5542   gsextra = 3;
5543 #endif
5545   int oldc = cols, oldr = rows;
5546   int oldw = FRAME_PIXEL_WIDTH (emacsframe),
5547     oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5548   int neww, newh;
5550   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, wr.size.width + gsextra);
5552   if (cols < MINWIDTH)
5553     cols = MINWIDTH;
5555   if (! [self isFullscreen])
5556     {
5557       extra = FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5558         + FRAME_TOOLBAR_HEIGHT (emacsframe) - gsextra;
5559     }
5561   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, wr.size.height - extra);
5563   if (rows < MINHEIGHT)
5564     rows = MINHEIGHT;
5566   neww = (int)wr.size.width - emacsframe->border_width;
5567   newh = (int)wr.size.height - extra;
5569   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5570     {
5571       NSView *view = FRAME_NS_VIEW (emacsframe);
5572       NSWindow *win = [view window];
5573       NSSize sz = [win resizeIncrements];
5575       FRAME_PIXEL_WIDTH (emacsframe) = neww;
5576       FRAME_PIXEL_HEIGHT (emacsframe) = newh;
5577       change_frame_size (emacsframe, rows, cols, 0, delay, 0);
5578       SET_FRAME_GARBAGED (emacsframe);
5579       cancel_mouse_face (emacsframe);
5581       // Did resize increments change because of a font change?
5582       if (sz.width != FRAME_COLUMN_WIDTH (emacsframe) ||
5583           sz.height != FRAME_LINE_HEIGHT (emacsframe))
5584         {
5585           sz.width = FRAME_COLUMN_WIDTH (emacsframe);
5586           sz.height = FRAME_LINE_HEIGHT (emacsframe);
5587           [win setResizeIncrements: sz];
5588         }
5590       [view setFrame: NSMakeRect (0, 0, neww, newh)];
5591       [self windowDidMove:nil];   // Update top/left.
5592     }
5595 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
5596 /* normalize frame to gridded text size */
5598   int extra = 0;
5599   int gsextra = 0;
5600 #ifdef NS_IMPL_GNUSTEP
5601   gsextra = 3;
5602 #endif
5604   NSTRACE (windowWillResize);
5605 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5607   if (fs_state == FULLSCREEN_MAXIMIZED
5608       && (maximized_width != (int)frameSize.width
5609           || maximized_height != (int)frameSize.height))
5610     [self setFSValue: FULLSCREEN_NONE];
5611   else if (fs_state == FULLSCREEN_WIDTH
5612            && maximized_width != (int)frameSize.width)
5613     [self setFSValue: FULLSCREEN_NONE];
5614   else if (fs_state == FULLSCREEN_HEIGHT
5615            && maximized_height != (int)frameSize.height)
5616     [self setFSValue: FULLSCREEN_NONE];
5617   if (fs_state == FULLSCREEN_NONE)
5618     maximized_width = maximized_height = -1;
5620   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe,
5621                                          frameSize.width + gsextra);
5622   if (cols < MINWIDTH)
5623     cols = MINWIDTH;
5625   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe,
5626                                            frameSize.height - extra);
5627   if (rows < MINHEIGHT)
5628     rows = MINHEIGHT;
5629 #ifdef NS_IMPL_COCOA
5630   {
5631     /* this sets window title to have size in it; the wm does this under GS */
5632     NSRect r = [[self window] frame];
5633     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5634       {
5635         if (old_title != 0)
5636           {
5637             xfree (old_title);
5638             old_title = 0;
5639           }
5640       }
5641     else
5642       {
5643         char *size_title;
5644         NSWindow *window = [self window];
5645         if (old_title == 0)
5646           {
5647             const char *t = [[[self window] title] UTF8String];
5648             char *pos = strstr (t, "  â€”  ");
5649             if (pos)
5650               *pos = '\0';
5651             old_title = xstrdup (t);
5652           }
5653         size_title = xmalloc (strlen (old_title) + 40);
5654         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5655         [window setTitle: [NSString stringWithUTF8String: size_title]];
5656         [window display];
5657         xfree (size_title);
5658       }
5659   }
5660 #endif /* NS_IMPL_COCOA */
5661 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5663   return frameSize;
5667 - (void)windowDidResize: (NSNotification *)notification
5669   if (! [self fsIsNative])
5670     {
5671       NSWindow *theWindow = [notification object];
5672       /* We can get notification on the non-FS window when in
5673          fullscreen mode.  */
5674       if ([self window] != theWindow) return;
5675     }
5677 #ifdef NS_IMPL_GNUSTEP
5678   NSWindow *theWindow = [notification object];
5680    /* In GNUstep, at least currently, it's possible to get a didResize
5681       without getting a willResize.. therefore we need to act as if we got
5682       the willResize now */
5683   NSSize sz = [theWindow frame].size;
5684   sz = [self windowWillResize: theWindow toSize: sz];
5685 #endif /* NS_IMPL_GNUSTEP */
5687   NSTRACE (windowDidResize);
5688 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5690 #ifdef NS_IMPL_COCOA
5691   if (old_title != 0)
5692     {
5693       xfree (old_title);
5694       old_title = 0;
5695     }
5696 #endif /* NS_IMPL_COCOA */
5698   if (cols > 0 && rows > 0)
5699     {
5700       [self updateFrameSize: YES];
5701     }
5703   ns_send_appdefined (-1);
5707 - (void)windowDidBecomeKey: (NSNotification *)notification
5708 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5710   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5711   struct frame *old_focus = dpyinfo->x_focus_frame;
5713   NSTRACE (windowDidBecomeKey);
5715   if (emacsframe != old_focus)
5716     dpyinfo->x_focus_frame = emacsframe;
5718   ns_frame_rehighlight (emacsframe);
5720   if (emacs_event)
5721     {
5722       emacs_event->kind = FOCUS_IN_EVENT;
5723       EV_TRAILER ((id)nil);
5724     }
5728 - (void)windowDidResignKey: (NSNotification *)notification
5729 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5731   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5732   NSTRACE (windowDidResignKey);
5734   if (dpyinfo->x_focus_frame == emacsframe)
5735     dpyinfo->x_focus_frame = 0;
5737   ns_frame_rehighlight (emacsframe);
5739   /* FIXME: for some reason needed on second and subsequent clicks away
5740             from sole-frame Emacs to get hollow box to show */
5741   if (!windowClosing && [[self window] isVisible] == YES)
5742     {
5743       x_update_cursor (emacsframe, 1);
5744       x_set_frame_alpha (emacsframe);
5745     }
5747   if (emacs_event)
5748     {
5749       [self deleteWorkingText];
5750       emacs_event->kind = FOCUS_IN_EVENT;
5751       EV_TRAILER ((id)nil);
5752     }
5756 - (void)windowWillMiniaturize: sender
5758   NSTRACE (windowWillMiniaturize);
5762 - (BOOL)isFlipped
5764   return YES;
5768 - (BOOL)isOpaque
5770   return NO;
5774 - initFrameFromEmacs: (struct frame *)f
5776   NSRect r, wr;
5777   Lisp_Object tem;
5778   NSWindow *win;
5779   NSSize sz;
5780   NSColor *col;
5781   NSString *name;
5783   NSTRACE (initFrameFromEmacs);
5785   windowClosing = NO;
5786   processingCompose = NO;
5787   scrollbarsNeedingUpdate = 0;
5788   fs_state = FULLSCREEN_NONE;
5789   fs_before_fs = next_maximized = -1;
5790 #ifdef HAVE_NATIVE_FS
5791   fs_is_native = ns_use_native_fullscreen;
5792 #else
5793   fs_is_native = NO;
5794 #endif
5795   maximized_width = maximized_height = -1;
5796   nonfs_window = nil;
5798 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
5800   ns_userRect = NSMakeRect (0, 0, 0, 0);
5801   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
5802                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
5803   [self initWithFrame: r];
5804   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
5806   FRAME_NS_VIEW (f) = self;
5807   emacsframe = f;
5808   old_title = 0;
5810   win = [[EmacsWindow alloc]
5811             initWithContentRect: r
5812                       styleMask: (NSResizableWindowMask |
5813 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
5814                                   NSTitledWindowMask |
5815 #endif
5816                                   NSMiniaturizableWindowMask |
5817                                   NSClosableWindowMask)
5818                         backing: NSBackingStoreBuffered
5819                           defer: YES];
5821 #ifdef HAVE_NATIVE_FS
5822     [win setCollectionBehavior:NSWindowCollectionBehaviorFullScreenPrimary];
5823 #endif
5825   wr = [win frame];
5826   bwidth = f->border_width = wr.size.width - r.size.width;
5827   tibar_height = FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
5829   [win setAcceptsMouseMovedEvents: YES];
5830   [win setDelegate: self];
5831   [win useOptimizedDrawing: YES];
5833   sz.width = FRAME_COLUMN_WIDTH (f);
5834   sz.height = FRAME_LINE_HEIGHT (f);
5835   [win setResizeIncrements: sz];
5837   [[win contentView] addSubview: self];
5839   if (ns_drag_types)
5840     [self registerForDraggedTypes: ns_drag_types];
5842   tem = f->name;
5843   name = [NSString stringWithUTF8String:
5844                    NILP (tem) ? "Emacs" : SSDATA (tem)];
5845   [win setTitle: name];
5847   /* toolbar support */
5848   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
5849                          [NSString stringWithFormat: @"Emacs Frame %d",
5850                                    ns_window_num]];
5851   [win setToolbar: toolbar];
5852   [toolbar setVisible: NO];
5853 #ifdef NS_IMPL_COCOA
5854   {
5855     NSButton *toggleButton;
5856   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
5857   [toggleButton setTarget: self];
5858   [toggleButton setAction: @selector (toggleToolbar: )];
5859   }
5860 #endif
5861   FRAME_TOOLBAR_HEIGHT (f) = 0;
5863   tem = f->icon_name;
5864   if (!NILP (tem))
5865     [win setMiniwindowTitle:
5866            [NSString stringWithUTF8String: SSDATA (tem)]];
5868   {
5869     NSScreen *screen = [win screen];
5871     if (screen != 0)
5872       [win setFrameTopLeftPoint: NSMakePoint
5873            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
5874             IN_BOUND (-SCREENMAX,
5875                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
5876   }
5878   [win makeFirstResponder: self];
5880   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
5881                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
5882   [win setBackgroundColor: col];
5883   if ([col alphaComponent] != (EmacsCGFloat) 1.0)
5884     [win setOpaque: NO];
5886   [self allocateGState];
5888   [NSApp registerServicesMenuSendTypes: ns_send_types
5889                            returnTypes: nil];
5891   ns_window_num++;
5892   return self;
5896 - (void)windowDidMove: sender
5898   NSWindow *win = [self window];
5899   NSRect r = [win frame];
5900   NSArray *screens = [NSScreen screens];
5901   NSScreen *screen = [screens objectAtIndex: 0];
5903   NSTRACE (windowDidMove);
5905   if (!emacsframe->output_data.ns)
5906     return;
5907   if (screen != nil)
5908     {
5909       emacsframe->left_pos = r.origin.x;
5910       emacsframe->top_pos =
5911         [screen frame].size.height - (r.origin.y + r.size.height);
5912     }
5916 /* Called AFTER method below, but before our windowWillResize call there leads
5917    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
5918    location so set_window_size moves the frame. */
5919 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
5921   emacsframe->output_data.ns->zooming = 1;
5922   return YES;
5926 /* Override to do something slightly nonstandard, but nice.  First click on
5927    zoom button will zoom vertically.  Second will zoom completely.  Third
5928    returns to original. */
5929 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
5930                         defaultFrame:(NSRect)defaultFrame
5932   NSRect result = [sender frame];
5934   NSTRACE (windowWillUseStandardFrame);
5936   if (fs_before_fs != -1) /* Entering fullscreen */
5937       {
5938         result = defaultFrame;
5939       }
5940   else if (next_maximized == FULLSCREEN_HEIGHT
5941       || (next_maximized == -1
5942           && abs (defaultFrame.size.height - result.size.height)
5943           > FRAME_LINE_HEIGHT (emacsframe)))
5944     {
5945       /* first click */
5946       ns_userRect = result;
5947       maximized_height = result.size.height = defaultFrame.size.height;
5948       maximized_width = -1;
5949       result.origin.y = defaultFrame.origin.y;
5950       [self setFSValue: FULLSCREEN_HEIGHT];
5951     }
5952   else if (next_maximized == FULLSCREEN_WIDTH)
5953     {
5954       ns_userRect = result;
5955       maximized_width = result.size.width = defaultFrame.size.width;
5956       maximized_height = -1;
5957       result.origin.x = defaultFrame.origin.x;
5958       [self setFSValue: FULLSCREEN_WIDTH];
5959     }
5960   else if (next_maximized == FULLSCREEN_MAXIMIZED
5961            || (next_maximized == -1
5962                && abs (defaultFrame.size.width - result.size.width)
5963                > FRAME_COLUMN_WIDTH (emacsframe)))
5964     {
5965       result = defaultFrame;  /* second click */
5966       maximized_width = result.size.width;
5967       maximized_height = result.size.height;
5968       [self setFSValue: FULLSCREEN_MAXIMIZED];
5969     }
5970   else
5971     {
5972       /* restore */
5973       result = ns_userRect.size.height ? ns_userRect : result;
5974       ns_userRect = NSMakeRect (0, 0, 0, 0);
5975       [self setFSValue: FULLSCREEN_NONE];
5976       maximized_width = maximized_height = -1;
5977     }
5979   if (fs_before_fs == -1) next_maximized = -1;
5980   [self windowWillResize: sender toSize: result.size];
5981   return result;
5985 - (void)windowDidDeminiaturize: sender
5987   NSTRACE (windowDidDeminiaturize);
5988   if (!emacsframe->output_data.ns)
5989     return;
5991   SET_FRAME_ICONIFIED (emacsframe, 0);
5992   SET_FRAME_VISIBLE (emacsframe, 1);
5993   windows_or_buffers_changed++;
5995   if (emacs_event)
5996     {
5997       emacs_event->kind = DEICONIFY_EVENT;
5998       EV_TRAILER ((id)nil);
5999     }
6003 - (void)windowDidExpose: sender
6005   NSTRACE (windowDidExpose);
6006   if (!emacsframe->output_data.ns)
6007     return;
6009   SET_FRAME_VISIBLE (emacsframe, 1);
6010   SET_FRAME_GARBAGED (emacsframe);
6012   if (send_appdefined)
6013     ns_send_appdefined (-1);
6017 - (void)windowDidMiniaturize: sender
6019   NSTRACE (windowDidMiniaturize);
6020   if (!emacsframe->output_data.ns)
6021     return;
6023   SET_FRAME_ICONIFIED (emacsframe, 1);
6024   SET_FRAME_VISIBLE (emacsframe, 0);
6026   if (emacs_event)
6027     {
6028       emacs_event->kind = ICONIFY_EVENT;
6029       EV_TRAILER ((id)nil);
6030     }
6033 #ifdef HAVE_NATIVE_FS
6034 - (NSApplicationPresentationOptions)window:(NSWindow *)window
6035       willUseFullScreenPresentationOptions:
6036   (NSApplicationPresentationOptions)proposedOptions
6038   return proposedOptions|NSApplicationPresentationAutoHideToolbar;
6040 #endif
6042 - (void)windowWillEnterFullScreen:(NSNotification *)notification
6044   fs_before_fs = fs_state;
6047 - (void)windowDidEnterFullScreen:(NSNotification *)notification
6049   [self setFSValue: FULLSCREEN_BOTH];
6050   if (! [self fsIsNative])
6051     {
6052       [self windowDidBecomeKey:notification];
6053       [nonfs_window orderOut:self];
6054     }
6055   else if (! FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6056     [toolbar setVisible:NO];
6059 - (void)windowWillExitFullScreen:(NSNotification *)notification
6061   if (next_maximized != -1)
6062     fs_before_fs = next_maximized;
6065 - (void)windowDidExitFullScreen:(NSNotification *)notification
6067   [self setFSValue: fs_before_fs];
6068   fs_before_fs = -1;
6069 #ifdef NS_IMPL_COCOA
6070   [self updateCollectionBehaviour];
6071 #endif
6072   if (FRAME_EXTERNAL_TOOL_BAR (emacsframe))
6073     {
6074       [toolbar setVisible:YES];
6075       update_frame_tool_bar (emacsframe);
6076       [self updateFrameSize:YES];
6077       [[self window] display];
6078     }
6079   else
6080     [toolbar setVisible:NO];
6082   if (next_maximized != -1)
6083     [[self window] performZoom:self];
6086 - (BOOL)fsIsNative
6088   return fs_is_native;
6091 - (BOOL)isFullscreen
6093   if (! fs_is_native) return nonfs_window != nil;
6094 #ifdef HAVE_NATIVE_FS
6095   return ([[self window] styleMask] & NSFullScreenWindowMask) != 0;
6096 #else
6097   return NO;
6098 #endif
6101 #ifdef HAVE_NATIVE_FS
6102 - (void)updateCollectionBehaviour
6104   if (! [self isFullscreen])
6105     {
6106       NSWindow *win = [self window];
6107       NSWindowCollectionBehavior b = [win collectionBehavior];
6108       if (ns_use_native_fullscreen)
6109         b |= NSWindowCollectionBehaviorFullScreenPrimary;
6110       else
6111         b &= ~NSWindowCollectionBehaviorFullScreenPrimary;
6113       [win setCollectionBehavior: b];
6114       fs_is_native = ns_use_native_fullscreen;
6115     }
6117 #endif
6119 - (void)toggleFullScreen: (id)sender
6121   NSWindow *w, *fw;
6122   BOOL onFirstScreen;
6123   struct frame *f;
6124   NSSize sz;
6125   NSRect r, wr;
6126   NSColor *col;
6128   if (fs_is_native)
6129     {
6130 #ifdef NS_IMPL_COCOA
6131       [[self window] toggleFullScreen:sender];
6132 #endif
6133       return;
6134     }
6136   w = [self window];
6137   onFirstScreen = [[w screen] isEqual:[[NSScreen screens] objectAtIndex:0]];
6138   f = emacsframe;
6139   wr = [w frame];
6140   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
6141                                  (FRAME_DEFAULT_FACE (f)),
6142                                  f);
6144   sz.width = FRAME_COLUMN_WIDTH (f);
6145   sz.height = FRAME_LINE_HEIGHT (f);
6147   if (fs_state != FULLSCREEN_BOTH)
6148     {
6149       /* Hide dock and menubar if we are on the primary screen.  */
6150       if (onFirstScreen)
6151         {
6152 #if defined (NS_IMPL_COCOA) && \
6153   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6154           NSApplicationPresentationOptions options
6155             = NSApplicationPresentationAutoHideDock
6156             | NSApplicationPresentationAutoHideMenuBar;
6158           [NSApp setPresentationOptions: options];
6159 #else
6160           [NSMenu setMenuBarVisible:NO];
6161 #endif
6162         }
6164       fw = [[EmacsFSWindow alloc]
6165                        initWithContentRect:[w contentRectForFrameRect:wr]
6166                                  styleMask:NSBorderlessWindowMask
6167                                    backing:NSBackingStoreBuffered
6168                                      defer:YES
6169                                     screen:[w screen]];
6171       [fw setContentView:[w contentView]];
6172       [fw setTitle:[w title]];
6173       [fw setDelegate:self];
6174       [fw setAcceptsMouseMovedEvents: YES];
6175       [fw useOptimizedDrawing: YES];
6176       [fw setResizeIncrements: sz];
6177       [fw setBackgroundColor: col];
6178       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6179         [fw setOpaque: NO];
6181       f->border_width = 0;
6182       FRAME_NS_TITLEBAR_HEIGHT (f) = 0;
6183       tobar_height = FRAME_TOOLBAR_HEIGHT (f);
6184       FRAME_TOOLBAR_HEIGHT (f) = 0;
6186       nonfs_window = w;
6188       [self windowWillEnterFullScreen:nil];
6189       [fw makeKeyAndOrderFront:NSApp];
6190       [fw makeFirstResponder:self];
6191       [w orderOut:self];
6192       r = [fw frameRectForContentRect:[[fw screen] frame]];
6193       [fw setFrame: r display:YES animate:YES];
6194       [self windowDidEnterFullScreen:nil];
6195       [fw display];
6196     }
6197   else
6198     {
6199       fw = w;
6200       w = nonfs_window;
6201       nonfs_window = nil;
6203       if (onFirstScreen)
6204         {
6205 #if defined (NS_IMPL_COCOA) && \
6206   MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
6207           [NSApp setPresentationOptions: NSApplicationPresentationDefault];
6208 #else
6209           [NSMenu setMenuBarVisible:YES];
6210 #endif
6211         }
6213       [w setContentView:[fw contentView]];
6214       [w setResizeIncrements: sz];
6215       [w setBackgroundColor: col];
6216       if ([col alphaComponent] != (EmacsCGFloat) 1.0)
6217         [w setOpaque: NO];
6219       f->border_width = bwidth;
6220       FRAME_NS_TITLEBAR_HEIGHT (f) = tibar_height;
6221       if (FRAME_EXTERNAL_TOOL_BAR (f))
6222         FRAME_TOOLBAR_HEIGHT (f) = tobar_height;
6224       [self windowWillExitFullScreen:nil];
6225       [fw setFrame: [w frame] display:YES animate:YES];
6226       [fw close];
6227       [w makeKeyAndOrderFront:NSApp];
6228       [self windowDidExitFullScreen:nil];
6229       [self updateFrameSize:YES];
6230     }
6233 - (void)handleFS
6235   if (fs_state != emacsframe->want_fullscreen)
6236     {
6237       if (fs_state == FULLSCREEN_BOTH)
6238         {
6239           [self toggleFullScreen:self];
6240         }
6242       switch (emacsframe->want_fullscreen)
6243         {
6244         case FULLSCREEN_BOTH:
6245           [self toggleFullScreen:self];
6246           break;
6247         case FULLSCREEN_WIDTH:
6248           next_maximized = FULLSCREEN_WIDTH;
6249           if (fs_state != FULLSCREEN_BOTH)
6250             [[self window] performZoom:self];
6251           break;
6252         case FULLSCREEN_HEIGHT:
6253           next_maximized = FULLSCREEN_HEIGHT;
6254           if (fs_state != FULLSCREEN_BOTH)
6255             [[self window] performZoom:self];
6256           break;
6257         case FULLSCREEN_MAXIMIZED:
6258           next_maximized = FULLSCREEN_MAXIMIZED;
6259           if (fs_state != FULLSCREEN_BOTH)
6260             [[self window] performZoom:self];
6261           break;
6262         case FULLSCREEN_NONE:
6263           if (fs_state != FULLSCREEN_BOTH)
6264             {
6265               next_maximized = FULLSCREEN_NONE;
6266               [[self window] performZoom:self];
6267             }
6268           break;
6269         }
6271       emacsframe->want_fullscreen = FULLSCREEN_NONE;
6272     }
6276 - (void) setFSValue: (int)value
6278   Lisp_Object lval = Qnil;
6279   switch (value)
6280     {
6281     case FULLSCREEN_BOTH:
6282       lval = Qfullboth;
6283       break;
6284     case FULLSCREEN_WIDTH:
6285       lval = Qfullwidth;
6286       break;
6287     case FULLSCREEN_HEIGHT:
6288       lval = Qfullheight;
6289       break;
6290     case FULLSCREEN_MAXIMIZED:
6291       lval = Qmaximized;
6292       break;
6293     }
6294   store_frame_param (emacsframe, Qfullscreen, lval);
6295   fs_state = value;
6298 - (void)mouseEntered: (NSEvent *)theEvent
6300   NSTRACE (mouseEntered);
6301   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
6305 - (void)mouseExited: (NSEvent *)theEvent
6307   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
6309   NSTRACE (mouseExited);
6311   if (!hlinfo)
6312     return;
6314   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
6316   if (emacsframe == hlinfo->mouse_face_mouse_frame)
6317     {
6318       clear_mouse_face (hlinfo);
6319       hlinfo->mouse_face_mouse_frame = 0;
6320     }
6324 - menuDown: sender
6326   NSTRACE (menuDown);
6327   if (context_menu_value == -1)
6328     context_menu_value = [sender tag];
6329   else
6330     {
6331       NSInteger tag = [sender tag];
6332       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
6333                                     emacsframe->menu_bar_vector,
6334                                     (void *)tag);
6335     }
6337   ns_send_appdefined (-1);
6338   return self;
6342 - (EmacsToolbar *)toolbar
6344   return toolbar;
6348 /* this gets called on toolbar button click */
6349 - toolbarClicked: (id)item
6351   NSEvent *theEvent;
6352   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
6354   NSTRACE (toolbarClicked);
6356   if (!emacs_event)
6357     return self;
6359   /* send first event (for some reason two needed) */
6360   theEvent = [[self window] currentEvent];
6361   emacs_event->kind = TOOL_BAR_EVENT;
6362   XSETFRAME (emacs_event->arg, emacsframe);
6363   EV_TRAILER (theEvent);
6365   emacs_event->kind = TOOL_BAR_EVENT;
6366 /*   XSETINT (emacs_event->code, 0); */
6367   emacs_event->arg = AREF (emacsframe->tool_bar_items,
6368                            idx + TOOL_BAR_ITEM_KEY);
6369   emacs_event->modifiers = EV_MODIFIERS (theEvent);
6370   EV_TRAILER (theEvent);
6371   return self;
6375 - toggleToolbar: (id)sender
6377   if (!emacs_event)
6378     return self;
6380   emacs_event->kind = NS_NONKEY_EVENT;
6381   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
6382   EV_TRAILER ((id)nil);
6383   return self;
6387 - (void)drawRect: (NSRect)rect
6389   int x = NSMinX (rect), y = NSMinY (rect);
6390   int width = NSWidth (rect), height = NSHeight (rect);
6392   NSTRACE (drawRect);
6394   if (!emacsframe || !emacsframe->output_data.ns)
6395     return;
6397   ns_clear_frame_area (emacsframe, x, y, width, height);
6398   expose_frame (emacsframe, x, y, width, height);
6400   /*
6401     drawRect: may be called (at least in OS X 10.5) for invisible
6402     views as well for some reason.  Thus, do not infer visibility
6403     here.
6405     emacsframe->async_visible = 1;
6406     emacsframe->async_iconified = 0;
6407   */
6411 /* NSDraggingDestination protocol methods.  Actually this is not really a
6412    protocol, but a category of Object.  O well...  */
6414 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
6416   NSTRACE (draggingEntered);
6417   return NSDragOperationGeneric;
6421 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
6423   return YES;
6427 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
6429   id pb;
6430   int x, y;
6431   NSString *type;
6432   NSEvent *theEvent = [[self window] currentEvent];
6433   NSPoint position;
6435   NSTRACE (performDragOperation);
6437   if (!emacs_event)
6438     return NO;
6440   position = [self convertPoint: [sender draggingLocation] fromView: nil];
6441   x = lrint (position.x);  y = lrint (position.y);
6443   pb = [sender draggingPasteboard];
6444   type = [pb availableTypeFromArray: ns_drag_types];
6445   if (type == 0)
6446     {
6447       return NO;
6448     }
6449   else if ([type isEqualToString: NSFilenamesPboardType])
6450     {
6451       NSArray *files;
6452       NSEnumerator *fenum;
6453       NSString *file;
6455       if (!(files = [pb propertyListForType: type]))
6456         return NO;
6458       fenum = [files objectEnumerator];
6459       while ( (file = [fenum nextObject]) )
6460         {
6461           emacs_event->kind = NS_NONKEY_EVENT;
6462           emacs_event->code = KEY_NS_DRAG_FILE;
6463           XSETINT (emacs_event->x, x);
6464           XSETINT (emacs_event->y, y);
6465           ns_input_file = append2 (ns_input_file,
6466                                    build_string ([file UTF8String]));
6467           emacs_event->modifiers = EV_MODIFIERS (theEvent);
6468           EV_TRAILER (theEvent);
6469         }
6470       return YES;
6471     }
6472   else if ([type isEqualToString: NSURLPboardType])
6473     {
6474       NSString *file;
6475       NSURL *fileURL;
6477       if (!(fileURL = [NSURL URLFromPasteboard: pb]) ||
6478           [fileURL isFileURL] == NO)
6479         return NO;
6481       file = [fileURL path];
6482       emacs_event->kind = NS_NONKEY_EVENT;
6483       emacs_event->code = KEY_NS_DRAG_FILE;
6484       XSETINT (emacs_event->x, x);
6485       XSETINT (emacs_event->y, y);
6486       ns_input_file = append2 (ns_input_file, build_string ([file UTF8String]));
6487       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6488       EV_TRAILER (theEvent);
6489       return YES;
6490     }
6491   else if ([type isEqualToString: NSStringPboardType]
6492            || [type isEqualToString: NSTabularTextPboardType])
6493     {
6494       NSString *data;
6496       if (! (data = [pb stringForType: type]))
6497         return NO;
6499       emacs_event->kind = NS_NONKEY_EVENT;
6500       emacs_event->code = KEY_NS_DRAG_TEXT;
6501       XSETINT (emacs_event->x, x);
6502       XSETINT (emacs_event->y, y);
6503       ns_input_text = build_string ([data UTF8String]);
6504       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6505       EV_TRAILER (theEvent);
6506       return YES;
6507     }
6508   else if ([type isEqualToString: NSColorPboardType])
6509     {
6510       NSColor *c = [NSColor colorFromPasteboard: pb];
6511       emacs_event->kind = NS_NONKEY_EVENT;
6512       emacs_event->code = KEY_NS_DRAG_COLOR;
6513       XSETINT (emacs_event->x, x);
6514       XSETINT (emacs_event->y, y);
6515       ns_input_color = ns_color_to_lisp (c);
6516       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6517       EV_TRAILER (theEvent);
6518       return YES;
6519     }
6520   else if ([type isEqualToString: NSFontPboardType])
6521     {
6522       /* impl based on GNUstep NSTextView.m */
6523       NSData *data = [pb dataForType: NSFontPboardType];
6524       NSDictionary *dict = [NSUnarchiver unarchiveObjectWithData: data];
6525       NSFont *font = [dict objectForKey: NSFontAttributeName];
6526       char fontSize[10];
6528       if (font == nil)
6529         return NO;
6531       emacs_event->kind = NS_NONKEY_EVENT;
6532       emacs_event->code = KEY_NS_CHANGE_FONT;
6533       XSETINT (emacs_event->x, x);
6534       XSETINT (emacs_event->y, y);
6535       ns_input_font = build_string ([[font fontName] UTF8String]);
6536       snprintf (fontSize, 10, "%f", [font pointSize]);
6537       ns_input_fontsize = build_string (fontSize);
6538       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6539       EV_TRAILER (theEvent);
6540       return YES;
6541     }
6542   else
6543     {
6544       error ("Invalid data type in dragging pasteboard.");
6545       return NO;
6546     }
6550 - (id) validRequestorForSendType: (NSString *)typeSent
6551                       returnType: (NSString *)typeReturned
6553   NSTRACE (validRequestorForSendType);
6554   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
6555       && typeReturned == nil)
6556     {
6557       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
6558         return self;
6559     }
6561   return [super validRequestorForSendType: typeSent
6562                                returnType: typeReturned];
6566 /* The next two methods are part of NSServicesRequests informal protocol,
6567    supposedly called when a services menu item is chosen from this app.
6568    But this should not happen because we override the services menu with our
6569    own entries which call ns-perform-service.
6570    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
6571    So let's at least stub them out until further investigation can be done. */
6573 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
6575   /* we could call ns_string_from_pasteboard(pboard) here but then it should
6576      be written into the buffer in place of the existing selection..
6577      ordinary service calls go through functions defined in ns-win.el */
6578   return NO;
6581 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
6583   NSArray *typesDeclared;
6584   Lisp_Object val;
6586   /* We only support NSStringPboardType */
6587   if ([types containsObject:NSStringPboardType] == NO) {
6588     return NO;
6589   }
6591   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6592   if (CONSP (val) && SYMBOLP (XCAR (val)))
6593     {
6594       val = XCDR (val);
6595       if (CONSP (val) && NILP (XCDR (val)))
6596         val = XCAR (val);
6597     }
6598   if (! STRINGP (val))
6599     return NO;
6601   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
6602   [pb declareTypes:typesDeclared owner:nil];
6603   ns_string_to_pasteboard (pb, val);
6604   return YES;
6608 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
6609    (gives a miniaturized version of the window); currently we use the latter for
6610    frames whose active buffer doesn't correspond to any file
6611    (e.g., '*scratch*') */
6612 - setMiniwindowImage: (BOOL) setMini
6614   id image = [[self window] miniwindowImage];
6615   NSTRACE (setMiniwindowImage);
6617   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
6618      about "AppleDockIconEnabled" notwithstanding, however the set message
6619      below has its effect nonetheless. */
6620   if (image != emacsframe->output_data.ns->miniimage)
6621     {
6622       if (image && [image isKindOfClass: [EmacsImage class]])
6623         [image release];
6624       [[self window] setMiniwindowImage:
6625                        setMini ? emacsframe->output_data.ns->miniimage : nil];
6626     }
6628   return self;
6632 - (void) setRows: (int) r andColumns: (int) c
6634   rows = r;
6635   cols = c;
6638 @end  /* EmacsView */
6642 /* ==========================================================================
6644     EmacsWindow implementation
6646    ========================================================================== */
6648 @implementation EmacsWindow
6650 #ifdef NS_IMPL_COCOA
6651 - (id)accessibilityAttributeValue:(NSString *)attribute
6653   Lisp_Object str = Qnil;
6654   struct frame *f = SELECTED_FRAME ();
6655   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->contents);
6657   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
6658     return NSAccessibilityTextFieldRole;
6660   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
6661       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
6662     {
6663       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6664     }
6665   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
6666     {
6667       if (! NILP (BVAR (curbuf, mark_active)))
6668           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6670       if (NILP (str))
6671         {
6672           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
6673           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
6674           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
6676           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
6677             str = make_uninit_multibyte_string (range, byte_range);
6678           else
6679             str = make_uninit_string (range);
6680           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
6681              Is this a problem?  */
6682           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
6683         }
6684     }
6687   if (! NILP (str))
6688     {
6689       if (CONSP (str) && SYMBOLP (XCAR (str)))
6690         {
6691           str = XCDR (str);
6692           if (CONSP (str) && NILP (XCDR (str)))
6693             str = XCAR (str);
6694         }
6695       if (STRINGP (str))
6696         {
6697           const char *utfStr = SSDATA (str);
6698           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
6699           return nsStr;
6700         }
6701     }
6703   return [super accessibilityAttributeValue:attribute];
6705 #endif /* NS_IMPL_COCOA */
6707 /* If we have multiple monitors, one above the other, we don't want to
6708    restrict the height to just one monitor.  So we override this.  */
6709 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
6711   /* When making the frame visible for the first time or if there is just
6712      one screen, we want to constrain.  Other times not.  */
6713   NSUInteger nr_screens = [[NSScreen screens] count];
6714   struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
6715   NSTRACE (constrainFrameRect);
6717   if (nr_screens == 1)
6718     {
6719       NSRect r = [super constrainFrameRect:frameRect toScreen:screen];
6720       return r;
6721     }
6723   if (f->output_data.ns->dont_constrain
6724       || ns_menu_bar_should_be_hidden ())
6725     return frameRect;
6727   f->output_data.ns->dont_constrain = 1;
6728   return [super constrainFrameRect:frameRect toScreen:screen];
6731 @end /* EmacsWindow */
6734 @implementation EmacsFSWindow
6736 - (BOOL)canBecomeKeyWindow
6738   return YES;
6741 - (BOOL)canBecomeMainWindow
6743   return YES;
6746 @end
6748 /* ==========================================================================
6750     EmacsScroller implementation
6752    ========================================================================== */
6755 @implementation EmacsScroller
6757 /* for repeat button push */
6758 #define SCROLL_BAR_FIRST_DELAY 0.5
6759 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
6761 + (CGFloat) scrollerWidth
6763   /* TODO: if we want to allow variable widths, this is the place to do it,
6764            however neither GNUstep nor Cocoa support it very well */
6765   return [NSScroller scrollerWidth];
6769 - initFrame: (NSRect )r window: (Lisp_Object)nwin
6771   NSTRACE (EmacsScroller_initFrame);
6773   r.size.width = [EmacsScroller scrollerWidth];
6774   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
6775   [self setContinuous: YES];
6776   [self setEnabled: YES];
6778   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
6779      locked against the top and bottom edges, and right edge on OS X, where
6780      scrollers are on right. */
6781 #ifdef NS_IMPL_GNUSTEP
6782   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
6783 #else
6784   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
6785 #endif
6787   win = nwin;
6788   condemned = NO;
6789   pixel_height = NSHeight (r);
6790   if (pixel_height == 0) pixel_height = 1;
6791   min_portion = 20 / pixel_height;
6793   frame = XFRAME (XWINDOW (win)->frame);
6794   if (FRAME_LIVE_P (frame))
6795     {
6796       int i;
6797       EmacsView *view = FRAME_NS_VIEW (frame);
6798       NSView *sview = [[view window] contentView];
6799       NSArray *subs = [sview subviews];
6801       /* disable optimization stopping redraw of other scrollbars */
6802       view->scrollbarsNeedingUpdate = 0;
6803       for (i =[subs count]-1; i >= 0; i--)
6804         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
6805           view->scrollbarsNeedingUpdate++;
6806       [sview addSubview: self];
6807     }
6809 /*  [self setFrame: r]; */
6811   return self;
6815 - (void)setFrame: (NSRect)newRect
6817   NSTRACE (EmacsScroller_setFrame);
6818 /*  block_input (); */
6819   pixel_height = NSHeight (newRect);
6820   if (pixel_height == 0) pixel_height = 1;
6821   min_portion = 20 / pixel_height;
6822   [super setFrame: newRect];
6823   [self display];
6824 /*  unblock_input (); */
6828 - (void)dealloc
6830   NSTRACE (EmacsScroller_dealloc);
6831   if (!NILP (win))
6832     wset_vertical_scroll_bar (XWINDOW (win), Qnil);
6833   [super dealloc];
6837 - condemn
6839   NSTRACE (condemn);
6840   condemned =YES;
6841   return self;
6845 - reprieve
6847   NSTRACE (reprieve);
6848   condemned =NO;
6849   return self;
6853 - judge
6855   NSTRACE (judge);
6856   if (condemned)
6857     {
6858       EmacsView *view;
6859       block_input ();
6860       /* ensure other scrollbar updates after deletion */
6861       view = (EmacsView *)FRAME_NS_VIEW (frame);
6862       if (view != nil)
6863         view->scrollbarsNeedingUpdate++;
6864       [self removeFromSuperview];
6865       [self release];
6866       unblock_input ();
6867     }
6868   return self;
6872 - (void)resetCursorRects
6874   NSRect visible = [self visibleRect];
6875   NSTRACE (resetCursorRects);
6877   if (!NSIsEmptyRect (visible))
6878     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
6879   [[NSCursor arrowCursor] setOnMouseEntered: YES];
6883 - (int) checkSamePosition: (int) position portion: (int) portion
6884                     whole: (int) whole
6886   return em_position ==position && em_portion ==portion && em_whole ==whole
6887     && portion != whole; /* needed for resize empty buf */
6891 - setPosition: (int)position portion: (int)portion whole: (int)whole
6893   NSTRACE (setPosition);
6895   em_position = position;
6896   em_portion = portion;
6897   em_whole = whole;
6899   if (portion >= whole)
6900     {
6901 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
6902       [self setKnobProportion: 1.0];
6903       [self setDoubleValue: 1.0];
6904 #else
6905       [self setFloatValue: 0.0 knobProportion: 1.0];
6906 #endif
6907     }
6908   else
6909     {
6910       float pos;
6911       CGFloat por;
6912       portion = max ((float)whole*min_portion/pixel_height, portion);
6913       pos = (float)position / (whole - portion);
6914       por = (CGFloat)portion/whole;
6915 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
6916       [self setKnobProportion: por];
6917       [self setDoubleValue: pos];
6918 #else
6919       [self setFloatValue: pos knobProportion: por];
6920 #endif
6921     }
6923   /* Events may come here even if the event loop is not running.
6924      If we don't enter the event loop, the scroll bar will not update.
6925      So send SIGIO to ourselves.  */
6926   if (apploopnr == 0) raise (SIGIO);
6928   return self;
6931 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
6932      drag events will go directly to the EmacsScroller.  Leaving in for now. */
6933 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
6934                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
6936   *part = last_hit_part;
6937   *window = win;
6938   XSETINT (*y, pixel_height);
6939   if ([self floatValue] > 0.999F)
6940     XSETINT (*x, pixel_height);
6941   else
6942     XSETINT (*x, pixel_height * [self floatValue]);
6946 /* set up emacs_event */
6947 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
6949   if (!emacs_event)
6950     return;
6952   emacs_event->part = last_hit_part;
6953   emacs_event->code = 0;
6954   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
6955   emacs_event->frame_or_window = win;
6956   emacs_event->timestamp = EV_TIMESTAMP (e);
6957   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
6958   emacs_event->arg = Qnil;
6959   XSETINT (emacs_event->x, loc * pixel_height);
6960   XSETINT (emacs_event->y, pixel_height-20);
6962   if (q_event_ptr)
6963     {
6964       n_emacs_events_pending++;
6965       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
6966     }
6967   else
6968     hold_event (emacs_event);
6969   EVENT_INIT (*emacs_event);
6970   ns_send_appdefined (-1);
6974 /* called manually thru timer to implement repeated button action w/hold-down */
6975 - repeatScroll: (NSTimer *)scrollEntry
6977   NSEvent *e = [[self window] currentEvent];
6978   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
6979   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
6981   /* clear timer if need be */
6982   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
6983     {
6984         [scroll_repeat_entry invalidate];
6985         [scroll_repeat_entry release];
6986         scroll_repeat_entry = nil;
6988         if (inKnob)
6989           return self;
6991         scroll_repeat_entry
6992           = [[NSTimer scheduledTimerWithTimeInterval:
6993                         SCROLL_BAR_CONTINUOUS_DELAY
6994                                             target: self
6995                                           selector: @selector (repeatScroll:)
6996                                           userInfo: 0
6997                                            repeats: YES]
6998               retain];
6999     }
7001   [self sendScrollEventAtLoc: 0 fromEvent: e];
7002   return self;
7006 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
7007    mouseDragged events without going into a modal loop. */
7008 - (void)mouseDown: (NSEvent *)e
7010   NSRect sr, kr;
7011   /* hitPart is only updated AFTER event is passed on */
7012   NSScrollerPart part = [self testPart: [e locationInWindow]];
7013   CGFloat inc = 0.0, loc, kloc, pos;
7014   int edge = 0;
7016   NSTRACE (EmacsScroller_mouseDown);
7018   switch (part)
7019     {
7020     case NSScrollerDecrementPage:
7021         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
7022     case NSScrollerIncrementPage:
7023         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
7024     case NSScrollerDecrementLine:
7025       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
7026     case NSScrollerIncrementLine:
7027       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
7028     case NSScrollerKnob:
7029       last_hit_part = scroll_bar_handle; break;
7030     case NSScrollerKnobSlot:  /* GNUstep-only */
7031       last_hit_part = scroll_bar_move_ratio; break;
7032     default:  /* NSScrollerNoPart? */
7033       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
7034                (long) part);
7035       return;
7036     }
7038   if (inc != 0.0)
7039     {
7040       pos = 0;      /* ignored */
7042       /* set a timer to repeat, as we can't let superclass do this modally */
7043       scroll_repeat_entry
7044         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
7045                                             target: self
7046                                           selector: @selector (repeatScroll:)
7047                                           userInfo: 0
7048                                            repeats: YES]
7049             retain];
7050     }
7051   else
7052     {
7053       /* handle, or on GNUstep possibly slot */
7054       NSEvent *fake_event;
7056       /* compute float loc in slot and mouse offset on knob */
7057       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7058                       toView: nil];
7059       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7060       if (loc <= 0.0)
7061         {
7062           loc = 0.0;
7063           edge = -1;
7064         }
7065       else if (loc >= NSHeight (sr))
7066         {
7067           loc = NSHeight (sr);
7068           edge = 1;
7069         }
7071       if (edge)
7072         kloc = 0.5 * edge;
7073       else
7074         {
7075           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
7076                           toView: nil];
7077           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
7078         }
7079       last_mouse_offset = kloc;
7081       /* if knob, tell emacs a location offset by knob pos
7082          (to indicate top of handle) */
7083       if (part == NSScrollerKnob)
7084           pos = (loc - last_mouse_offset) / NSHeight (sr);
7085       else
7086         /* else this is a slot click on GNUstep: go straight there */
7087         pos = loc / NSHeight (sr);
7089       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
7090       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
7091                                       location: [e locationInWindow]
7092                                  modifierFlags: [e modifierFlags]
7093                                      timestamp: [e timestamp]
7094                                   windowNumber: [e windowNumber]
7095                                        context: [e context]
7096                                    eventNumber: [e eventNumber]
7097                                     clickCount: [e clickCount]
7098                                       pressure: [e pressure]];
7099       [super mouseUp: fake_event];
7100     }
7102   if (part != NSScrollerKnob)
7103     [self sendScrollEventAtLoc: pos fromEvent: e];
7107 /* Called as we manually track scroller drags, rather than superclass. */
7108 - (void)mouseDragged: (NSEvent *)e
7110     NSRect sr;
7111     double loc, pos;
7113     NSTRACE (EmacsScroller_mouseDragged);
7115       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
7116                       toView: nil];
7117       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
7119       if (loc <= 0.0)
7120         {
7121           loc = 0.0;
7122         }
7123       else if (loc >= NSHeight (sr) + last_mouse_offset)
7124         {
7125           loc = NSHeight (sr) + last_mouse_offset;
7126         }
7128       pos = (loc - last_mouse_offset) / NSHeight (sr);
7129       [self sendScrollEventAtLoc: pos fromEvent: e];
7133 - (void)mouseUp: (NSEvent *)e
7135   if (scroll_repeat_entry)
7136     {
7137       [scroll_repeat_entry invalidate];
7138       [scroll_repeat_entry release];
7139       scroll_repeat_entry = nil;
7140     }
7141   last_hit_part = 0;
7145 /* treat scrollwheel events in the bar as though they were in the main window */
7146 - (void) scrollWheel: (NSEvent *)theEvent
7148   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
7149   [view mouseDown: theEvent];
7152 @end  /* EmacsScroller */
7155 #ifdef NS_IMPL_GNUSTEP
7156 /* Dummy class to get rid of startup warnings.  */
7157 @implementation EmacsDocument
7159 @end
7160 #endif
7163 /* ==========================================================================
7165    Font-related functions; these used to be in nsfaces.m
7167    ========================================================================== */
7170 Lisp_Object
7171 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7173   struct font *font = XFONT_OBJECT (font_object);
7175   if (fontset < 0)
7176     fontset = fontset_from_font (font_object);
7177   FRAME_FONTSET (f) = fontset;
7179   if (FRAME_FONT (f) == font)
7180     /* This font is already set in frame F.  There's nothing more to
7181        do.  */
7182     return font_object;
7184   FRAME_FONT (f) = font;
7186   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7187   FRAME_COLUMN_WIDTH (f) = font->average_width;
7188   FRAME_LINE_HEIGHT (f) = font->height;
7190   compute_fringe_widths (f, 1);
7192   /* Compute the scroll bar width in character columns.  */
7193   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7194     {
7195       int wid = FRAME_COLUMN_WIDTH (f);
7196       FRAME_CONFIG_SCROLL_BAR_COLS (f)
7197         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
7198     }
7199   else
7200     {
7201       int wid = FRAME_COLUMN_WIDTH (f);
7202       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7203     }
7205   /* Now make the frame display the given font.  */
7206   if (FRAME_NS_WINDOW (f) != 0)
7207         x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7209   return font_object;
7213 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
7214 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
7215          in 1.43. */
7217 const char *
7218 ns_xlfd_to_fontname (const char *xlfd)
7219 /* --------------------------------------------------------------------------
7220     Convert an X font name (XLFD) to an NS font name.
7221     Only family is used.
7222     The string returned is temporarily allocated.
7223    -------------------------------------------------------------------------- */
7225   char *name = xmalloc (180);
7226   int i, len;
7227   const char *ret;
7229   if (!strncmp (xlfd, "--", 2))
7230     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
7231   else
7232     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
7234   /* stopgap for malformed XLFD input */
7235   if (strlen (name) == 0)
7236     strcpy (name, "Monaco");
7238   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
7239      also uppercase after '-' or ' ' */
7240   name[0] = c_toupper (name[0]);
7241   for (len =strlen (name), i =0; i<len; i++)
7242     {
7243       if (name[i] == '$')
7244         {
7245           name[i] = '-';
7246           if (i+1<len)
7247             name[i+1] = c_toupper (name[i+1]);
7248         }
7249       else if (name[i] == '_')
7250         {
7251           name[i] = ' ';
7252           if (i+1<len)
7253             name[i+1] = c_toupper (name[i+1]);
7254         }
7255     }
7256 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
7257   ret = [[NSString stringWithUTF8String: name] UTF8String];
7258   xfree (name);
7259   return ret;
7263 void
7264 syms_of_nsterm (void)
7266   NSTRACE (syms_of_nsterm);
7268   ns_antialias_threshold = 10.0;
7270   /* from 23+ we need to tell emacs what modifiers there are.. */
7271   DEFSYM (Qmodifier_value, "modifier-value");
7272   DEFSYM (Qalt, "alt");
7273   DEFSYM (Qhyper, "hyper");
7274   DEFSYM (Qmeta, "meta");
7275   DEFSYM (Qsuper, "super");
7276   DEFSYM (Qcontrol, "control");
7277   DEFSYM (QUTF8_STRING, "UTF8_STRING");
7279   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
7280   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
7281   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
7282   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
7283   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
7285   DEFVAR_LISP ("ns-input-file", ns_input_file,
7286               "The file specified in the last NS event.");
7287   ns_input_file =Qnil;
7289   DEFVAR_LISP ("ns-input-text", ns_input_text,
7290               "The data received in the last NS text drag event.");
7291   ns_input_text =Qnil;
7293   DEFVAR_LISP ("ns-working-text", ns_working_text,
7294               "String for visualizing working composition sequence.");
7295   ns_working_text =Qnil;
7297   DEFVAR_LISP ("ns-input-font", ns_input_font,
7298               "The font specified in the last NS event.");
7299   ns_input_font =Qnil;
7301   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
7302               "The fontsize specified in the last NS event.");
7303   ns_input_fontsize =Qnil;
7305   DEFVAR_LISP ("ns-input-line", ns_input_line,
7306                "The line specified in the last NS event.");
7307   ns_input_line =Qnil;
7309   DEFVAR_LISP ("ns-input-color", ns_input_color,
7310                "The color specified in the last NS event.");
7311   ns_input_color =Qnil;
7313   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
7314                "The service name specified in the last NS event.");
7315   ns_input_spi_name =Qnil;
7317   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
7318                "The service argument specified in the last NS event.");
7319   ns_input_spi_arg =Qnil;
7321   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
7322                "This variable describes the behavior of the alternate or option key.\n\
7323 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7324 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7325 at all, allowing it to be used at a lower level for accented character entry.");
7326   ns_alternate_modifier = Qmeta;
7328   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
7329                "This variable describes the behavior of the right alternate or option key.\n\
7330 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7331 Set to left means be the same key as `ns-alternate-modifier'.\n\
7332 Set to none means that the alternate / option key is not interpreted by Emacs\n\
7333 at all, allowing it to be used at a lower level for accented character entry.");
7334   ns_right_alternate_modifier = Qleft;
7336   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
7337                "This variable describes the behavior of the command key.\n\
7338 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7339   ns_command_modifier = Qsuper;
7341   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
7342                "This variable describes the behavior of the right command key.\n\
7343 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7344 Set to left means be the same key as `ns-command-modifier'.\n\
7345 Set to none means that the command / option key is not interpreted by Emacs\n\
7346 at all, allowing it to be used at a lower level for accented character entry.");
7347   ns_right_command_modifier = Qleft;
7349   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
7350                "This variable describes the behavior of the control key.\n\
7351 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
7352   ns_control_modifier = Qcontrol;
7354   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
7355                "This variable describes the behavior of the right control key.\n\
7356 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7357 Set to left means be the same key as `ns-control-modifier'.\n\
7358 Set to none means that the control / option key is not interpreted by Emacs\n\
7359 at all, allowing it to be used at a lower level for accented character entry.");
7360   ns_right_control_modifier = Qleft;
7362   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
7363                "This variable describes the behavior of the function key (on laptops).\n\
7364 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
7365 Set to none means that the function key is not interpreted by Emacs at all,\n\
7366 allowing it to be used at a lower level for accented character entry.");
7367   ns_function_modifier = Qnone;
7369   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
7370                "Non-nil (the default) means to render text antialiased.");
7371   ns_antialias_text = Qt;
7373   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
7374                "Whether to confirm application quit using dialog.");
7375   ns_confirm_quit = Qnil;
7377   staticpro (&ns_display_name_list);
7378   ns_display_name_list = Qnil;
7380   staticpro (&last_mouse_motion_frame);
7381   last_mouse_motion_frame = Qnil;
7383   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
7384                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
7385 Only works on OSX 10.6 or later.  */);
7386   ns_auto_hide_menu_bar = Qnil;
7388   DEFVAR_BOOL ("ns-use-native-fullscreen", ns_use_native_fullscreen,
7389      doc: /*Non-nil means to use native fullscreen on OSX >= 10.7.
7390 Nil means use fullscreen the old (< 10.7) way.  The old way works better with
7391 multiple monitors, but lacks tool bar.  This variable is ignored on OSX < 10.7.
7392 Default is t for OSX >= 10.7, nil otherwise. */);
7393 #ifdef HAVE_NATIVE_FS
7394   ns_use_native_fullscreen = YES;
7395 #else
7396   ns_use_native_fullscreen = NO;
7397 #endif
7398   ns_last_use_native_fullscreen = ns_use_native_fullscreen;
7400   /* TODO: move to common code */
7401   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
7402                doc: /* Which toolkit scroll bars Emacs uses, if any.
7403 A value of nil means Emacs doesn't use toolkit scroll bars.
7404 With the X Window system, the value is a symbol describing the
7405 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
7406 With MS Windows or Nextstep, the value is t.  */);
7407   Vx_toolkit_scroll_bars = Qt;
7409   DEFVAR_BOOL ("x-use-underline-position-properties",
7410                x_use_underline_position_properties,
7411      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
7412 A value of nil means ignore them.  If you encounter fonts with bogus
7413 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
7414 to 4.1, set this to nil. */);
7415   x_use_underline_position_properties = 0;
7417   DEFVAR_BOOL ("x-underline-at-descent-line",
7418                x_underline_at_descent_line,
7419      doc: /* Non-nil means to draw the underline at the same place as the descent line.
7420 A value of nil means to draw the underline according to the value of the
7421 variable `x-use-underline-position-properties', which is usually at the
7422 baseline level.  The default value is nil.  */);
7423   x_underline_at_descent_line = 0;
7425   /* Tell emacs about this window system. */
7426   Fprovide (intern ("ns"), Qnil);