Make pcomplete less eager to add an extra space.
[emacs.git] / src / nsterm.m
blob0b26508dbd0f5e562a4142c4f03447a2827f13a6
1 /* NeXT/Open/GNUstep / MacOSX communication module.
3 Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2012
4   Free Software 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 <math.h>
34 #include <sys/types.h>
35 #include <time.h>
36 #include <signal.h>
37 #include <unistd.h>
39 #include <c-ctype.h>
40 #include <c-strcase.h>
41 #include <ftoastr.h>
43 #ifdef HAVE_FCNTL_H
44 #include <fcntl.h>
45 #endif
47 #include "lisp.h"
48 #include "blockinput.h"
49 #include "sysselect.h"
50 #include "nsterm.h"
51 #include "systime.h"
52 #include "character.h"
53 #include "fontset.h"
54 #include "composite.h"
55 #include "ccl.h"
57 #include "termhooks.h"
58 #include "termopts.h"
59 #include "termchar.h"
61 #include "window.h"
62 #include "keyboard.h"
63 #include "buffer.h"
64 #include "font.h"
66 /* call tracing */
67 #if 0
68 int term_trace_num = 0;
69 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
70                                 __FILE__, __LINE__, ++term_trace_num)
71 #else
72 #define NSTRACE(x)
73 #endif
75 extern NSString *NSMenuDidBeginTrackingNotification;
77 /* ==========================================================================
79     Local declarations
81    ========================================================================== */
83 /* Convert a symbol indexed with an NSxxx value to a value as defined
84    in keyboard.c (lispy_function_key). I hope this is a correct way
85    of doing things... */
86 static unsigned convert_ns_to_X_keysym[] =
88   NSHomeFunctionKey,            0x50,
89   NSLeftArrowFunctionKey,       0x51,
90   NSUpArrowFunctionKey,         0x52,
91   NSRightArrowFunctionKey,      0x53,
92   NSDownArrowFunctionKey,       0x54,
93   NSPageUpFunctionKey,          0x55,
94   NSPageDownFunctionKey,        0x56,
95   NSEndFunctionKey,             0x57,
96   NSBeginFunctionKey,           0x58,
97   NSSelectFunctionKey,          0x60,
98   NSPrintFunctionKey,           0x61,
99   NSExecuteFunctionKey,         0x62,
100   NSInsertFunctionKey,          0x63,
101   NSUndoFunctionKey,            0x65,
102   NSRedoFunctionKey,            0x66,
103   NSMenuFunctionKey,            0x67,
104   NSFindFunctionKey,            0x68,
105   NSHelpFunctionKey,            0x6A,
106   NSBreakFunctionKey,           0x6B,
108   NSF1FunctionKey,              0xBE,
109   NSF2FunctionKey,              0xBF,
110   NSF3FunctionKey,              0xC0,
111   NSF4FunctionKey,              0xC1,
112   NSF5FunctionKey,              0xC2,
113   NSF6FunctionKey,              0xC3,
114   NSF7FunctionKey,              0xC4,
115   NSF8FunctionKey,              0xC5,
116   NSF9FunctionKey,              0xC6,
117   NSF10FunctionKey,             0xC7,
118   NSF11FunctionKey,             0xC8,
119   NSF12FunctionKey,             0xC9,
120   NSF13FunctionKey,             0xCA,
121   NSF14FunctionKey,             0xCB,
122   NSF15FunctionKey,             0xCC,
123   NSF16FunctionKey,             0xCD,
124   NSF17FunctionKey,             0xCE,
125   NSF18FunctionKey,             0xCF,
126   NSF19FunctionKey,             0xD0,
127   NSF20FunctionKey,             0xD1,
128   NSF21FunctionKey,             0xD2,
129   NSF22FunctionKey,             0xD3,
130   NSF23FunctionKey,             0xD4,
131   NSF24FunctionKey,             0xD5,
133   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
134   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
135   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
137   NSTabCharacter,               0x09,
138   0x19,                         0x09,  /* left tab->regular since pass shift */
139   NSCarriageReturnCharacter,    0x0D,
140   NSNewlineCharacter,           0x0D,
141   NSEnterCharacter,             0x8D,
143   0x1B,                         0x1B   /* escape */
146 static Lisp_Object Qmodifier_value;
147 Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper;
148 extern Lisp_Object Qcursor_color, Qcursor_type, Qns, Qleft;
150 static Lisp_Object QUTF8_STRING;
152 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
153    the maximum font size to NOT antialias.  On GNUstep there is currently
154    no way to control this behavior. */
155 float ns_antialias_threshold;
157 /* Used to pick up AppleHighlightColor on OS X */
158 NSString *ns_selection_color;
160 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
161 NSString *ns_app_name = @"Emacs";  /* default changed later */
163 /* Display variables */
164 struct ns_display_info *x_display_list; /* Chain of existing displays */
165 Lisp_Object ns_display_name_list;
166 long context_menu_value = 0;
168 /* display update */
169 NSPoint last_mouse_motion_position;
170 static NSRect last_mouse_glyph;
171 static Time last_mouse_movement_time = 0;
172 static Lisp_Object last_mouse_motion_frame;
173 static EmacsScroller *last_mouse_scroll_bar = nil;
174 static struct frame *ns_updating_frame;
175 static NSView *focus_view = NULL;
176 static int ns_window_num = 0;
177 #ifdef NS_IMPL_GNUSTEP
178 static NSRect uRect;
179 #endif
180 static BOOL gsaved = NO;
181 BOOL ns_in_resize = NO;
182 static BOOL ns_fake_keydown = NO;
183 int ns_tmp_flags; /* FIXME */
184 struct nsfont_info *ns_tmp_font; /* FIXME */
185 static BOOL ns_menu_bar_is_hidden = NO;
186 /*static int debug_lock = 0; */
188 /* event loop */
189 static BOOL send_appdefined = YES;
190 static NSEvent *last_appdefined_event = 0;
191 static NSTimer *timed_entry = 0;
192 static NSTimer *scroll_repeat_entry = nil;
193 static fd_set select_readfds, select_writefds;
194 enum { SELECT_HAVE_READ = 1, SELECT_HAVE_WRITE = 2, SELECT_HAVE_TMO = 4 };
195 static int select_nfds = 0, select_valid = 0;
196 static EMACS_TIME select_timeout = { 0, 0 };
197 static int selfds[2] = { -1, -1 };
198 static pthread_mutex_t select_mutex;
199 static int apploopnr = 0;
200 static NSAutoreleasePool *outerpool;
201 static struct input_event *emacs_event = NULL;
202 static struct input_event *q_event_ptr = NULL;
203 static int n_emacs_events_pending = 0;
204 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
205   *ns_pending_service_args;
206 static BOOL ns_do_open_file = NO;
208 /* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
209 #define NS_FUNCTION_KEY_MASK 0x800000
210 #define NSLeftControlKeyMask    (0x000001 | NSControlKeyMask)
211 #define NSRightControlKeyMask   (0x002000 | NSControlKeyMask)
212 #define NSLeftCommandKeyMask    (0x000008 | NSCommandKeyMask)
213 #define NSRightCommandKeyMask   (0x000010 | NSCommandKeyMask)
214 #define NSLeftAlternateKeyMask  (0x000020 | NSAlternateKeyMask)
215 #define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
216 #define EV_MODIFIERS(e)                               \
217     ((([e modifierFlags] & NSHelpKeyMask) ?           \
218            hyper_modifier : 0)                        \
219      | (!EQ (ns_right_alternate_modifier, Qleft) && \
220         (([e modifierFlags] & NSRightAlternateKeyMask) \
221          == NSRightAlternateKeyMask) ? \
222            parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
223      | (([e modifierFlags] & NSAlternateKeyMask) ?                 \
224            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
225      | (([e modifierFlags] & NSShiftKeyMask) ?     \
226            shift_modifier : 0)                        \
227      | (!EQ (ns_right_control_modifier, Qleft) && \
228         (([e modifierFlags] & NSRightControlKeyMask) \
229          == NSRightControlKeyMask) ? \
230            parse_solitary_modifier (ns_right_control_modifier) : 0) \
231      | (([e modifierFlags] & NSControlKeyMask) ?      \
232            parse_solitary_modifier (ns_control_modifier) : 0)     \
233      | (([e modifierFlags] & NS_FUNCTION_KEY_MASK) ?  \
234            parse_solitary_modifier (ns_function_modifier) : 0)    \
235      | (!EQ (ns_right_command_modifier, Qleft) && \
236         (([e modifierFlags] & NSRightCommandKeyMask) \
237          == NSRightCommandKeyMask) ? \
238            parse_solitary_modifier (ns_right_command_modifier) : 0) \
239      | (([e modifierFlags] & NSCommandKeyMask) ?      \
240            parse_solitary_modifier (ns_command_modifier):0))
242 #define EV_UDMODIFIERS(e)                                      \
243     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
244      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
245      | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
246      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
247      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
248      | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
249      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
250      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
251      | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
253 #define EV_BUTTON(e)                                                         \
254     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
255       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
256      [e buttonNumber] - 1)
258 /* Convert the time field to a timestamp in milliseconds. */
259 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
261 /* This is a piece of code which is common to all the event handling
262    methods.  Maybe it should even be a function.  */
263 #define EV_TRAILER(e)                                                   \
264     {                                                                   \
265       XSETFRAME (emacs_event->frame_or_window, emacsframe);             \
266       if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
267       if (q_event_ptr)                                                  \
268         {                                                               \
269           n_emacs_events_pending++;                                     \
270           kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
271         }                                                               \
272       else                                                              \
273         kbd_buffer_store_event (emacs_event);                           \
274       EVENT_INIT (*emacs_event);                                        \
275       ns_send_appdefined (-1);                                          \
276     }
278 void x_set_cursor_type (struct frame *, Lisp_Object, Lisp_Object);
280 /* TODO: get rid of need for these forward declarations */
281 static void ns_condemn_scroll_bars (struct frame *f);
282 static void ns_judge_scroll_bars (struct frame *f);
283 void x_set_frame_alpha (struct frame *f);
286 /* ==========================================================================
288     Utilities
290    ========================================================================== */
293 static Lisp_Object
294 append2 (Lisp_Object list, Lisp_Object item)
295 /* --------------------------------------------------------------------------
296    Utility to append to a list
297    -------------------------------------------------------------------------- */
299   Lisp_Object array[2];
300   array[0] = list;
301   array[1] = Fcons (item, Qnil);
302   return Fnconc (2, &array[0]);
306 const char *
307 ns_etc_directory (void)
308 /* If running as a self-contained app bundle, return as a string the
309    filename of the etc directory, if present; else nil.  */
311   NSBundle *bundle = [NSBundle mainBundle];
312   NSString *resourceDir = [bundle resourcePath];
313   NSString *resourcePath;
314   NSFileManager *fileManager = [NSFileManager defaultManager];
315   BOOL isDir;
317   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
318   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
319     {
320       if (isDir) return [resourcePath UTF8String];
321     }
322   return NULL;
326 const char *
327 ns_exec_path (void)
328 /* If running as a self-contained app bundle, return as a path string
329    the filenames of the libexec and bin directories, ie libexec:bin.
330    Otherwise, return nil.
331    Normally, Emacs does not add its own bin/ directory to the PATH.
332    However, a self-contained NS build has a different layout, with
333    bin/ and libexec/ subdirectories in the directory that contains
334    Emacs.app itself.
335    We put libexec first, because init_callproc_1 uses the first
336    element to initialize exec-directory.  An alternative would be
337    for init_callproc to check for invocation-directory/libexec.
340   NSBundle *bundle = [NSBundle mainBundle];
341   NSString *resourceDir = [bundle resourcePath];
342   NSString *binDir = [bundle bundlePath];
343   NSString *resourcePath, *resourcePaths;
344   NSRange range;
345   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
346   NSFileManager *fileManager = [NSFileManager defaultManager];
347   NSArray *paths;
348   NSEnumerator *pathEnum;
349   BOOL isDir;
351   range = [resourceDir rangeOfString: @"Contents"];
352   if (range.location != NSNotFound)
353     {
354       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
355 #ifdef NS_IMPL_COCOA
356       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
357 #endif
358     }
360   paths = [binDir stringsByAppendingPaths:
361                 [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
362   pathEnum = [paths objectEnumerator];
363   resourcePaths = @"";
365   while ((resourcePath = [pathEnum nextObject]))
366     {
367       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
368         if (isDir)
369           {
370             if ([resourcePaths length] > 0)
371               resourcePaths
372                 = [resourcePaths stringByAppendingString: pathSeparator];
373             resourcePaths
374               = [resourcePaths stringByAppendingString: resourcePath];
375           }
376     }
377   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
379   return NULL;
383 const char *
384 ns_load_path (void)
385 /* If running as a self-contained app bundle, return as a path string
386    the filenames of the site-lisp, lisp and leim directories.
387    Ie, site-lisp:lisp:leim.  Otherwise, return nil.  */
389   NSBundle *bundle = [NSBundle mainBundle];
390   NSString *resourceDir = [bundle resourcePath];
391   NSString *resourcePath, *resourcePaths;
392   NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
393   NSFileManager *fileManager = [NSFileManager defaultManager];
394   BOOL isDir;
395   NSArray *paths = [resourceDir stringsByAppendingPaths:
396                               [NSArray arrayWithObjects:
397                                          @"site-lisp", @"lisp", @"leim", nil]];
398   NSEnumerator *pathEnum = [paths objectEnumerator];
399   resourcePaths = @"";
401   /* Hack to skip site-lisp.  */
402   if (no_site_lisp) resourcePath = [pathEnum nextObject];
404   while ((resourcePath = [pathEnum nextObject]))
405     {
406       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
407         if (isDir)
408           {
409             if ([resourcePaths length] > 0)
410               resourcePaths
411                 = [resourcePaths stringByAppendingString: pathSeparator];
412             resourcePaths
413               = [resourcePaths stringByAppendingString: resourcePath];
414           }
415     }
416   if ([resourcePaths length] > 0) return [resourcePaths UTF8String];
418   return NULL;
421 static void
422 ns_timeout (int usecs)
423 /* --------------------------------------------------------------------------
424      Blocking timer utility used by ns_ring_bell
425    -------------------------------------------------------------------------- */
427   EMACS_TIME wakeup = add_emacs_time (current_emacs_time (),
428                                       make_emacs_time (0, usecs * 1000));
430   /* Keep waiting until past the time wakeup.  */
431   while (1)
432     {
433       EMACS_TIME timeout, now = current_emacs_time ();
434       if (EMACS_TIME_LE (wakeup, now))
435         break;
436       timeout = sub_emacs_time (wakeup, now);
438       /* Try to wait that long--but we might wake up sooner.  */
439       pselect (0, NULL, NULL, NULL, &timeout, NULL);
440     }
444 void
445 ns_release_object (void *obj)
446 /* --------------------------------------------------------------------------
447     Release an object (callable from C)
448    -------------------------------------------------------------------------- */
450     [(id)obj release];
454 void
455 ns_retain_object (void *obj)
456 /* --------------------------------------------------------------------------
457     Retain an object (callable from C)
458    -------------------------------------------------------------------------- */
460     [(id)obj retain];
464 void *
465 ns_alloc_autorelease_pool (void)
466 /* --------------------------------------------------------------------------
467      Allocate a pool for temporary objects (callable from C)
468    -------------------------------------------------------------------------- */
470   return [[NSAutoreleasePool alloc] init];
474 void
475 ns_release_autorelease_pool (void *pool)
476 /* --------------------------------------------------------------------------
477      Free a pool and temporary objects it refers to (callable from C)
478    -------------------------------------------------------------------------- */
480   ns_release_object (pool);
485 /* ==========================================================================
487     Focus (clipping) and screen update
489    ========================================================================== */
491 static NSRect
492 ns_resize_handle_rect (NSWindow *window)
494   NSRect r = [window frame];
495   r.origin.x = r.size.width - RESIZE_HANDLE_SIZE;
496   r.origin.y = 0;
497   r.size.width = r.size.height = RESIZE_HANDLE_SIZE;
498   return r;
503 // Window constraining
504 // -------------------
506 // To ensure that the windows are not placed under the menu bar, they
507 // are typically moved by the call-back constrainFrameRect. However,
508 // by overriding it, it's possible to inhibit this, leaving the window
509 // in it's original position.
511 // It's possible to hide the menu bar. However, technically, it's only
512 // possible to hide it when the application is active. To ensure that
513 // this work properly, the menu bar and window constraining are
514 // deferred until the application becomes active.
516 // Even though it's not possible to manually move a window above the
517 // top of the screen, it is allowed if it's done programmatically,
518 // when the menu is hidden. This allows the editable area to cover the
519 // full screen height.
521 // Test cases
522 // ----------
524 // Use the following extra files:
526 //    init.el:
527 //       ;; Hide menu and place frame slightly above the top of the screen.
528 //       (setq ns-auto-hide-menu-bar t)
529 //       (set-frame-position (selected-frame) 0 -20)
531 // Test 1:
533 //    emacs -Q -l init.el
535 //    Result: No menu bar, and the title bar should be above the screen.
537 // Test 2:
539 //    emacs -Q
541 //    Result: Menu bar visible, frame placed immediately below the menu.
544 static void
545 ns_constrain_all_frames (void)
547   Lisp_Object tail, frame;
549   FOR_EACH_FRAME (tail, frame)
550     {
551       struct frame *f = XFRAME (frame);
552       if (FRAME_NS_P (f))
553         {
554           NSView *view = FRAME_NS_VIEW (f);
555           /* This no-op will trigger the default window placing
556            * constraint system. */
557           f->output_data.ns->dont_constrain = 0;
558           [[view window] setFrameOrigin:[[view window] frame].origin];
559         }
560     }
564 /* True, if the menu bar should be hidden.  */
566 static BOOL
567 ns_menu_bar_should_be_hidden (void)
569   return !NILP (ns_auto_hide_menu_bar)
570     && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
574 /* Show or hide the menu bar, based on user setting.  */
576 static void
577 ns_update_auto_hide_menu_bar (void)
579 #ifndef MAC_OS_X_VERSION_10_6
580 #define MAC_OS_X_VERSION_10_6 1060
581 #endif
582 #ifdef NS_IMPL_COCOA
583 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
584   BLOCK_INPUT;
586   NSTRACE (ns_update_auto_hide_menu_bar);
588   if (NSApp != nil
589       && [NSApp isActive]
590       && [NSApp respondsToSelector:@selector(setPresentationOptions:)])
591     {
592       // Note, "setPresentationOptions" triggers an error unless the
593       // application is active.
594       BOOL menu_bar_should_be_hidden = ns_menu_bar_should_be_hidden ();
596       if (menu_bar_should_be_hidden != ns_menu_bar_is_hidden)
597         {
598           NSApplicationPresentationOptions options
599             = NSApplicationPresentationAutoHideDock;
601           if (menu_bar_should_be_hidden)
602             options |= NSApplicationPresentationAutoHideMenuBar;
604           [NSApp setPresentationOptions: options];
606           ns_menu_bar_is_hidden = menu_bar_should_be_hidden;
608           if (!ns_menu_bar_is_hidden)
609             {
610               ns_constrain_all_frames ();
611             }
612         }
613     }
615   UNBLOCK_INPUT;
616 #endif
617 #endif
621 static void
622 ns_update_begin (struct frame *f)
623 /* --------------------------------------------------------------------------
624    Prepare for a grouped sequence of drawing calls
625    external (RIF) call; whole frame, called before update_window_begin
626    -------------------------------------------------------------------------- */
628   NSView *view = FRAME_NS_VIEW (f);
629   NSRect r = [view frame];
630   NSBezierPath *bp;
631   NSTRACE (ns_update_begin);
633   ns_update_auto_hide_menu_bar ();
635   ns_updating_frame = f;
636   [view lockFocus];
638   /* drawRect may have been called for say the minibuffer, and then clip path
639      is for the minibuffer.  But the display engine may draw more because
640      we have set the frame as garbaged.  So reset clip path to the whole
641      view.  */
642   bp = [[NSBezierPath bezierPathWithRect: r] retain];
643   [bp setClip];
644   [bp release];
646 #ifdef NS_IMPL_GNUSTEP
647   uRect = NSMakeRect (0, 0, 0, 0);
648 #endif
652 static void
653 ns_update_window_begin (struct window *w)
654 /* --------------------------------------------------------------------------
655    Prepare for a grouped sequence of drawing calls
656    external (RIF) call; for one window, called after update_begin
657    -------------------------------------------------------------------------- */
659   struct frame *f = XFRAME (WINDOW_FRAME (w));
660  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
661   NSTRACE (ns_update_window_begin);
662   updated_window = w;
663   set_output_cursor (&w->cursor);
665   BLOCK_INPUT;
667   if (f == hlinfo->mouse_face_mouse_frame)
668     {
669       /* Don't do highlighting for mouse motion during the update.  */
670       hlinfo->mouse_face_defer = 1;
672         /* If the frame needs to be redrawn,
673            simply forget about any prior mouse highlighting.  */
674       if (FRAME_GARBAGED_P (f))
675         hlinfo->mouse_face_window = Qnil;
677       /* (further code for mouse faces ifdef'd out in other terms elided) */
678     }
680   UNBLOCK_INPUT;
684 static void
685 ns_update_window_end (struct window *w, int cursor_on_p,
686                       int mouse_face_overwritten_p)
687 /* --------------------------------------------------------------------------
688    Finished a grouped sequence of drawing calls
689    external (RIF) call; for one window called before update_end
690    -------------------------------------------------------------------------- */
692   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
694   /* note: this fn is nearly identical in all terms */
695   if (!w->pseudo_window_p)
696     {
697       BLOCK_INPUT;
699       if (cursor_on_p)
700         display_and_set_cursor (w, 1,
701                                 output_cursor.hpos, output_cursor.vpos,
702                                 output_cursor.x, output_cursor.y);
704       if (draw_window_fringes (w, 1))
705         x_draw_vertical_border (w);
707       UNBLOCK_INPUT;
708     }
710   /* If a row with mouse-face was overwritten, arrange for
711      frame_up_to_date to redisplay the mouse highlight.  */
712   if (mouse_face_overwritten_p)
713     {
714       hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
715       hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
716       hlinfo->mouse_face_window = Qnil;
717     }
719   updated_window = NULL;
720   NSTRACE (update_window_end);
724 static void
725 ns_update_end (struct frame *f)
726 /* --------------------------------------------------------------------------
727    Finished a grouped sequence of drawing calls
728    external (RIF) call; for whole frame, called after update_window_end
729    -------------------------------------------------------------------------- */
731   NSView *view = FRAME_NS_VIEW (f);
733 /*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
734     MOUSE_HL_INFO (f)->mouse_face_defer = 0;
736   BLOCK_INPUT;
738 #ifdef NS_IMPL_GNUSTEP
739   /* trigger flush only in the rectangle we tracked as being drawn */
740   [view unlockFocusNeedsFlush: NO];
741 /*fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", uRect.origin.x, uRect.origin.y, uRect.size.width, uRect.size.height); */
742   [view lockFocusInRect: uRect];
743 #endif
745   [view unlockFocus];
746   [[view window] flushWindow];
748   UNBLOCK_INPUT;
749   ns_updating_frame = NULL;
750   NSTRACE (ns_update_end);
754 static void
755 ns_flush (struct frame *f)
756 /* --------------------------------------------------------------------------
757    external (RIF) call
758    NS impl is no-op since currently we flush in ns_update_end and elsewhere
759    -------------------------------------------------------------------------- */
761     NSTRACE (ns_flush);
765 static void
766 ns_focus (struct frame *f, NSRect *r, int n)
767 /* --------------------------------------------------------------------------
768    Internal: Focus on given frame.  During small local updates this is used to
769      draw, however during large updates, ns_update_begin and ns_update_end are
770      called to wrap the whole thing, in which case these calls are stubbed out.
771      Except, on GNUstep, we accumulate the rectangle being drawn into, because
772      the back end won't do this automatically, and will just end up flushing
773      the entire window.
774    -------------------------------------------------------------------------- */
776 //  NSTRACE (ns_focus);
777 #ifdef NS_IMPL_GNUSTEP
778   NSRect u;
779     if (n == 2)
780       u = NSUnionRect (r[0], r[1]);
781     else if (r)
782       u = *r;
783 #endif
784 /* static int c =0;
785    fprintf (stderr, "focus: %d", c++);
786    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
787    fprintf (stderr, "\n"); */
789   if (f != ns_updating_frame)
790     {
791       NSView *view = FRAME_NS_VIEW (f);
792       if (view != focus_view)
793         {
794           if (focus_view != NULL)
795             {
796               [focus_view unlockFocus];
797               [[focus_view window] flushWindow];
798 /*debug_lock--; */
799             }
801           if (view)
802 #ifdef NS_IMPL_GNUSTEP
803             r ? [view lockFocusInRect: u] : [view lockFocus];
804 #else
805             [view lockFocus];
806 #endif
807           focus_view = view;
808 /*if (view) debug_lock++; */
809         }
810 #ifdef NS_IMPL_GNUSTEP
811       else
812         {
813           /* more than one rect being drawn into */
814           if (view && r)
815             {
816               [view unlockFocus]; /* add prev rect to redraw list */
817               [view lockFocusInRect: u]; /* focus for draw in new rect */
818             }
819         }
820 #endif
821     }
822 #ifdef NS_IMPL_GNUSTEP
823   else
824     {
825       /* in batch mode, but in GNUstep must still track rectangles explicitly */
826       uRect = (r ? NSUnionRect (uRect, u) : [FRAME_NS_VIEW (f) visibleRect]);
827     }
828 #endif
830   /* clipping */
831   if (r)
832     {
833       [[NSGraphicsContext currentContext] saveGraphicsState];
834       if (n == 2)
835         NSRectClipList (r, 2);
836       else
837         NSRectClip (*r);
838       gsaved = YES;
839     }
843 static void
844 ns_unfocus (struct frame *f)
845 /* --------------------------------------------------------------------------
846      Internal: Remove focus on given frame
847    -------------------------------------------------------------------------- */
849 //  NSTRACE (ns_unfocus);
851   if (gsaved)
852     {
853       [[NSGraphicsContext currentContext] restoreGraphicsState];
854       gsaved = NO;
855     }
857   if (f != ns_updating_frame)
858     {
859       if (focus_view != NULL)
860         {
861           [focus_view unlockFocus];
862           [[focus_view window] flushWindow];
863           focus_view = NULL;
864 /*debug_lock--; */
865         }
866     }
870 static void
871 ns_clip_to_row (struct window *w, struct glyph_row *row, int area, BOOL gc)
872 /* --------------------------------------------------------------------------
873      Internal (but parallels other terms): Focus drawing on given row
874    -------------------------------------------------------------------------- */
876   struct frame *f = XFRAME (WINDOW_FRAME (w));
877   NSRect clip_rect;
878   int window_x, window_y, window_width;
880   window_box (w, area, &window_x, &window_y, &window_width, 0);
882   clip_rect.origin.x = window_x;
883   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
884   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
885   clip_rect.size.width = window_width;
886   clip_rect.size.height = row->visible_height;
888   ns_focus (f, &clip_rect, 1);
892 static void
893 ns_ring_bell (struct frame *f)
894 /* --------------------------------------------------------------------------
895      "Beep" routine
896    -------------------------------------------------------------------------- */
898   NSTRACE (ns_ring_bell);
899   if (visible_bell)
900     {
901       NSAutoreleasePool *pool;
902       struct frame *frame = SELECTED_FRAME ();
903       NSView *view;
905       BLOCK_INPUT;
906       pool = [[NSAutoreleasePool alloc] init];
908       view = FRAME_NS_VIEW (frame);
909       if (view != nil)
910         {
911           NSRect r, surr;
912           NSPoint dim = NSMakePoint (128, 128);
914           r = [view bounds];
915           r.origin.x += (r.size.width - dim.x) / 2;
916           r.origin.y += (r.size.height - dim.y) / 2;
917           r.size.width = dim.x;
918           r.size.height = dim.y;
919           surr = NSInsetRect (r, -2, -2);
920           ns_focus (frame, &surr, 1);
921           [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
922           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
923                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
924           NSRectFill (r);
925           [[view window] flushWindow];
926           ns_timeout (150000);
927           [[view window] restoreCachedImage];
928           [[view window] flushWindow];
929           ns_unfocus (frame);
930         }
931       [pool release];
932       UNBLOCK_INPUT;
933     }
934   else
935     {
936       NSBeep ();
937     }
941 static void
942 ns_reset_terminal_modes (struct terminal *terminal)
943 /*  Externally called as hook */
945   NSTRACE (ns_reset_terminal_modes);
949 static void
950 ns_set_terminal_modes (struct terminal *terminal)
951 /*  Externally called as hook */
953   NSTRACE (ns_set_terminal_modes);
958 /* ==========================================================================
960     Frame / window manager related functions
962    ========================================================================== */
965 static void
966 ns_raise_frame (struct frame *f)
967 /* --------------------------------------------------------------------------
968      Bring window to foreground and make it active
969    -------------------------------------------------------------------------- */
971   NSView *view = FRAME_NS_VIEW (f);
972   check_ns ();
973   BLOCK_INPUT;
974   FRAME_SAMPLE_VISIBILITY (f);
975   if (FRAME_VISIBLE_P (f))
976     {
977       [[view window] makeKeyAndOrderFront: NSApp];
978     }
979   UNBLOCK_INPUT;
983 static void
984 ns_lower_frame (struct frame *f)
985 /* --------------------------------------------------------------------------
986      Send window to back
987    -------------------------------------------------------------------------- */
989   NSView *view = FRAME_NS_VIEW (f);
990   check_ns ();
991   BLOCK_INPUT;
992   [[view window] orderBack: NSApp];
993   UNBLOCK_INPUT;
997 static void
998 ns_frame_raise_lower (struct frame *f, int raise)
999 /* --------------------------------------------------------------------------
1000      External (hook)
1001    -------------------------------------------------------------------------- */
1003   NSTRACE (ns_frame_raise_lower);
1005   if (raise)
1006     ns_raise_frame (f);
1007   else
1008     ns_lower_frame (f);
1012 static void
1013 ns_frame_rehighlight (struct frame *frame)
1014 /* --------------------------------------------------------------------------
1015      External (hook): called on things like window switching within frame
1016    -------------------------------------------------------------------------- */
1018   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
1019   struct frame *old_highlight = dpyinfo->x_highlight_frame;
1021   NSTRACE (ns_frame_rehighlight);
1022   if (dpyinfo->x_focus_frame)
1023     {
1024       dpyinfo->x_highlight_frame
1025         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1026            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
1027            : dpyinfo->x_focus_frame);
1028       if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
1029         {
1030           fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
1031           dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
1032         }
1033     }
1034   else
1035       dpyinfo->x_highlight_frame = 0;
1037   if (dpyinfo->x_highlight_frame &&
1038          dpyinfo->x_highlight_frame != old_highlight)
1039     {
1040       if (old_highlight)
1041         {
1042           x_update_cursor (old_highlight, 1);
1043           x_set_frame_alpha (old_highlight);
1044         }
1045       if (dpyinfo->x_highlight_frame)
1046         {
1047           x_update_cursor (dpyinfo->x_highlight_frame, 1);
1048           x_set_frame_alpha (dpyinfo->x_highlight_frame);
1049         }
1050     }
1054 void
1055 x_make_frame_visible (struct frame *f)
1056 /* --------------------------------------------------------------------------
1057      External: Show the window (X11 semantics)
1058    -------------------------------------------------------------------------- */
1060   NSTRACE (x_make_frame_visible);
1061   /* XXX: at some points in past this was not needed, as the only place that
1062      called this (frame.c:Fraise_frame ()) also called raise_lower;
1063      if this ends up the case again, comment this out again. */
1064   if (!FRAME_VISIBLE_P (f))
1065     {
1066       f->async_visible = 1;
1067       ns_raise_frame (f);
1068     }
1072 void
1073 x_make_frame_invisible (struct frame *f)
1074 /* --------------------------------------------------------------------------
1075      External: Hide the window (X11 semantics)
1076    -------------------------------------------------------------------------- */
1078   NSView * view = FRAME_NS_VIEW (f);
1079   NSTRACE (x_make_frame_invisible);
1080   check_ns ();
1081   [[view window] orderOut: NSApp];
1082   f->async_visible = 0;
1083   f->async_iconified = 0;
1087 void
1088 x_iconify_frame (struct frame *f)
1089 /* --------------------------------------------------------------------------
1090      External: Iconify window
1091    -------------------------------------------------------------------------- */
1093   NSView * view = FRAME_NS_VIEW (f);
1094   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1095   NSTRACE (x_iconify_frame);
1096   check_ns ();
1098   if (dpyinfo->x_highlight_frame == f)
1099     dpyinfo->x_highlight_frame = 0;
1101   if ([[view window] windowNumber] <= 0)
1102     {
1103       /* the window is still deferred.  Make it very small, bring it
1104          on screen and order it out. */
1105       NSRect s = { { 100, 100}, {0, 0} };
1106       NSRect t;
1107       t = [[view window] frame];
1108       [[view window] setFrame: s display: NO];
1109       [[view window] orderBack: NSApp];
1110       [[view window] orderOut: NSApp];
1111       [[view window] setFrame: t display: NO];
1112     }
1113   [[view window] miniaturize: NSApp];
1116 /* Free X resources of frame F.  */
1118 void
1119 x_free_frame_resources (struct frame *f)
1121   NSView *view = FRAME_NS_VIEW (f);
1122   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1123   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1124   NSTRACE (x_free_frame_resources);
1125   check_ns ();
1127   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1129   BLOCK_INPUT;
1131   free_frame_menubar (f);
1133   if (FRAME_FACE_CACHE (f))
1134     free_frame_faces (f);
1136   if (f == dpyinfo->x_focus_frame)
1137     dpyinfo->x_focus_frame = 0;
1138   if (f == dpyinfo->x_highlight_frame)
1139     dpyinfo->x_highlight_frame = 0;
1140   if (f == hlinfo->mouse_face_mouse_frame)
1141     {
1142       hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
1143       hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
1144       hlinfo->mouse_face_window = Qnil;
1145       hlinfo->mouse_face_deferred_gc = 0;
1146       hlinfo->mouse_face_mouse_frame = 0;
1147     }
1149   if (f->output_data.ns->miniimage != nil)
1150     [f->output_data.ns->miniimage release];
1152   [[view window] close];
1153   [view release];
1155   xfree (f->output_data.ns);
1157   UNBLOCK_INPUT;
1160 void
1161 x_destroy_window (struct frame *f)
1162 /* --------------------------------------------------------------------------
1163      External: Delete the window
1164    -------------------------------------------------------------------------- */
1166   NSTRACE (x_destroy_window);
1167   check_ns ();
1168   x_free_frame_resources (f);
1169   ns_window_num--;
1173 void
1174 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1175 /* --------------------------------------------------------------------------
1176      External: Position the window
1177    -------------------------------------------------------------------------- */
1179   NSView *view = FRAME_NS_VIEW (f);
1180   NSArray *screens = [NSScreen screens];
1181   NSScreen *fscreen = [screens objectAtIndex: 0];
1182   NSScreen *screen = [[view window] screen];
1184   NSTRACE (x_set_offset);
1186   BLOCK_INPUT;
1188   f->left_pos = xoff;
1189   f->top_pos = yoff;
1191   if (view != nil && screen && fscreen)
1192     {
1193       f->left_pos = f->size_hint_flags & XNegative
1194         ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
1195         : f->left_pos;
1196       /* We use visibleFrame here to take menu bar into account.
1197          Ideally we should also adjust left/top with visibleFrame.origin.  */
1199       f->top_pos = f->size_hint_flags & YNegative
1200         ? ([screen visibleFrame].size.height + f->top_pos
1201            - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
1202            - FRAME_TOOLBAR_HEIGHT (f))
1203         : f->top_pos;
1204 #ifdef NS_IMPL_GNUSTEP
1205       if (f->left_pos < 100)
1206         f->left_pos = 100;  /* don't overlap menu */
1207 #endif
1208       /* Constrain the setFrameTopLeftPoint so we don't move behind the
1209          menu bar.  */
1210       f->output_data.ns->dont_constrain = 0;
1211       [[view window] setFrameTopLeftPoint:
1212                        NSMakePoint (SCREENMAXBOUND (f->left_pos),
1213                                     SCREENMAXBOUND ([fscreen frame].size.height
1214                                                     - NS_TOP_POS (f)))];
1215       f->size_hint_flags &= ~(XNegative|YNegative);
1216     }
1218   UNBLOCK_INPUT;
1222 void
1223 x_set_window_size (struct frame *f, int change_grav, int cols, int rows)
1224 /* --------------------------------------------------------------------------
1225      Adjust window pixel size based on given character grid size
1226      Impl is a bit more complex than other terms, need to do some
1227      internal clipping.
1228    -------------------------------------------------------------------------- */
1230   EmacsView *view = FRAME_NS_VIEW (f);
1231   NSWindow *window = [view window];
1232   NSRect wr = [window frame];
1233   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1234   int pixelwidth, pixelheight;
1236   NSTRACE (x_set_window_size);
1238   if (view == nil)
1239     return;
1241 /*fprintf (stderr, "\tsetWindowSize: %d x %d, font size %d x %d\n", cols, rows, FRAME_COLUMN_WIDTH (f), FRAME_LINE_HEIGHT (f)); */
1243   BLOCK_INPUT;
1245   check_frame_size (f, &rows, &cols);
1247   f->scroll_bar_actual_width = NS_SCROLL_BAR_WIDTH (f);
1248   compute_fringe_widths (f, 0);
1250   pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, cols);
1251   pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
1253   /* If we have a toolbar, take its height into account. */
1254   if (tb)
1255     /* NOTE: previously this would generate wrong result if toolbar not
1256              yet displayed and fixing toolbar_height=32 helped, but
1257              now (200903) seems no longer needed */
1258     FRAME_TOOLBAR_HEIGHT (f) =
1259       NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1260         - FRAME_NS_TITLEBAR_HEIGHT (f);
1261   else
1262     FRAME_TOOLBAR_HEIGHT (f) = 0;
1264   wr.size.width = pixelwidth + f->border_width;
1265   wr.size.height = pixelheight + FRAME_NS_TITLEBAR_HEIGHT (f)
1266                   + FRAME_TOOLBAR_HEIGHT (f);
1268   /* Do not try to constrain to this screen.  We may have multiple
1269      screens, and want Emacs to span those.  Constraining to screen
1270      prevents that, and that is not nice to the user.  */
1271  if (f->output_data.ns->zooming)
1272    f->output_data.ns->zooming = 0;
1273  else
1274    wr.origin.y += FRAME_PIXEL_HEIGHT (f) - pixelheight;
1276   [view setRows: rows andColumns: cols];
1277   [window setFrame: wr display: YES];
1279 /*fprintf (stderr, "\tx_set_window_size %d, %d\t%d, %d\n", cols, rows, pixelwidth, pixelheight); */
1281   /* This is a trick to compensate for Emacs' managing the scrollbar area
1282      as a fixed number of standard character columns.  Instead of leaving
1283      blank space for the extra, we chopped it off above.  Now for
1284      left-hand scrollbars, we shift all rendering to the left by the
1285      difference between the real width and Emacs' imagined one.  For
1286      right-hand bars, don't worry about it since the extra is never used.
1287      (Obviously doesn't work for vertically split windows tho..) */
1288   {
1289     NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1290       ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1291                      - NS_SCROLL_BAR_WIDTH (f), 0)
1292       : NSMakePoint (0, 0);
1293     [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1294     [view setBoundsOrigin: origin];
1295   }
1297   change_frame_size (f, rows, cols, 0, 1, 0); /* pretend, delay, safe */
1298   FRAME_PIXEL_WIDTH (f) = pixelwidth;
1299   FRAME_PIXEL_HEIGHT (f) = pixelheight;
1300 /*  SET_FRAME_GARBAGED (f); // this short-circuits expose call in drawRect */
1302   mark_window_cursors_off (XWINDOW (f->root_window));
1303   cancel_mouse_face (f);
1305   UNBLOCK_INPUT;
1310 /* ==========================================================================
1312     Color management
1314    ========================================================================== */
1317 NSColor *
1318 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1320   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1321   if (idx < 1 || idx >= color_table->avail)
1322     return nil;
1323   return color_table->colors[idx];
1327 unsigned long
1328 ns_index_color (NSColor *color, struct frame *f)
1330   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1331   ptrdiff_t idx;
1332   ptrdiff_t i;
1334   if (!color_table->colors)
1335     {
1336       color_table->size = NS_COLOR_CAPACITY;
1337       color_table->avail = 1; /* skip idx=0 as marker */
1338       color_table->colors = xmalloc (color_table->size * sizeof (NSColor *));
1339       color_table->colors[0] = nil;
1340       color_table->empty_indices = [[NSMutableSet alloc] init];
1341     }
1343   /* do we already have this color ? */
1344   for (i = 1; i < color_table->avail; i++)
1345     if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1346       return i;
1348   if ([color_table->empty_indices count] > 0)
1349     {
1350       NSNumber *index = [color_table->empty_indices anyObject];
1351       [color_table->empty_indices removeObject: index];
1352       idx = [index unsignedLongValue];
1353     }
1354   else
1355     {
1356       if (color_table->avail == color_table->size)
1357         color_table->colors =
1358           xpalloc (color_table->colors, &color_table->size, 1,
1359                    min (ULONG_MAX, PTRDIFF_MAX), sizeof *color_table->colors);
1360       idx = color_table->avail++;
1361     }
1363   color_table->colors[idx] = color;
1364   [color retain];
1365 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1366   return idx;
1370 void
1371 ns_free_indexed_color (unsigned long idx, struct frame *f)
1373   struct ns_color_table *color_table;
1374   NSColor *color;
1375   NSNumber *index;
1377   if (!f)
1378     return;
1380   color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1382   if (idx <= 0 || idx >= color_table->size) {
1383     message1 ("ns_free_indexed_color: Color index out of range.\n");
1384     return;
1385   }
1387   index = [NSNumber numberWithUnsignedInt: idx];
1388   if ([color_table->empty_indices containsObject: index]) {
1389     message1 ("ns_free_indexed_color: attempt to free already freed color.\n");
1390     return;
1391   }
1393   color = color_table->colors[idx];
1394   [color release];
1395   color_table->colors[idx] = nil;
1396   [color_table->empty_indices addObject: index];
1397 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1401 static int
1402 ns_get_color (const char *name, NSColor **col)
1403 /* --------------------------------------------------------------------------
1404      Parse a color name
1405    -------------------------------------------------------------------------- */
1406 /* On *Step, we attempt to mimic the X11 platform here, down to installing an
1407    X11 rgb.txt-compatible color list in Emacs.clr (see ns_term_init()).
1408    See: http://thread.gmane.org/gmane.emacs.devel/113050/focus=113272). */
1410   NSColor *new = nil;
1411   static char hex[20];
1412   int scaling;
1413   float r = -1.0, g, b;
1414   NSString *nsname = [NSString stringWithUTF8String: name];
1416 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1417   BLOCK_INPUT;
1419   if ([nsname isEqualToString: @"ns_selection_color"])
1420     {
1421       nsname = ns_selection_color;
1422       name = [ns_selection_color UTF8String];
1423     }
1425   /* First, check for some sort of numeric specification. */
1426   hex[0] = '\0';
1428   if (name[0] == '0' || name[0] == '1' || name[0] == '.')  /* RGB decimal */
1429     {
1430       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1431       [scanner scanFloat: &r];
1432       [scanner scanFloat: &g];
1433       [scanner scanFloat: &b];
1434     }
1435   else if (!strncmp(name, "rgb:", 4))  /* A newer X11 format -- rgb:r/g/b */
1436     scaling = (snprintf (hex, sizeof hex, "%s", name + 4) - 2) / 3;
1437   else if (name[0] == '#')        /* An old X11 format; convert to newer */
1438     {
1439       int len = (strlen(name) - 1);
1440       int start = (len % 3 == 0) ? 1 : len / 4 + 1;
1441       int i;
1442       scaling = strlen(name+start) / 3;
1443       for (i = 0; i < 3; i++)
1444         sprintf (hex + i * (scaling + 1), "%.*s/", scaling,
1445                  name + start + i * scaling);
1446       hex[3 * (scaling + 1) - 1] = '\0';
1447     }
1449   if (hex[0])
1450     {
1451       int rr, gg, bb;
1452       float fscale = scaling == 4 ? 65535.0 : (scaling == 2 ? 255.0 : 15.0);
1453       if (sscanf (hex, "%x/%x/%x", &rr, &gg, &bb))
1454         {
1455           r = rr / fscale;
1456           g = gg / fscale;
1457           b = bb / fscale;
1458         }
1459     }
1461   if (r >= 0.0)
1462     {
1463       *col = [NSColor colorWithCalibratedRed: r green: g blue: b alpha: 1.0];
1464       UNBLOCK_INPUT;
1465       return 0;
1466     }
1468   /* Otherwise, color is expected to be from a list */
1469   {
1470     NSEnumerator *lenum, *cenum;
1471     NSString *name;
1472     NSColorList *clist;
1474 #ifdef NS_IMPL_GNUSTEP
1475     /* XXX: who is wrong, the requestor or the implementation? */
1476     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1477         == NSOrderedSame)
1478       nsname = @"highlightColor";
1479 #endif
1481     lenum = [[NSColorList availableColorLists] objectEnumerator];
1482     while ( (clist = [lenum nextObject]) && new == nil)
1483       {
1484         cenum = [[clist allKeys] objectEnumerator];
1485         while ( (name = [cenum nextObject]) && new == nil )
1486           {
1487             if ([name compare: nsname
1488                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1489               new = [clist colorWithKey: name];
1490           }
1491       }
1492   }
1494   if (new)
1495     *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1496   UNBLOCK_INPUT;
1497   return new ? 0 : 1;
1502 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1503 /* --------------------------------------------------------------------------
1504      Convert a Lisp string object to a NS color
1505    -------------------------------------------------------------------------- */
1507   NSTRACE (ns_lisp_to_color);
1508   if (STRINGP (color))
1509     return ns_get_color (SSDATA (color), col);
1510   else if (SYMBOLP (color))
1511     return ns_get_color (SSDATA (SYMBOL_NAME (color)), col);
1512   return 1;
1516 Lisp_Object
1517 ns_color_to_lisp (NSColor *col)
1518 /* --------------------------------------------------------------------------
1519      Convert a color to a lisp string with the RGB equivalent
1520    -------------------------------------------------------------------------- */
1522   CGFloat red, green, blue, alpha, gray;
1523   char buf[1024];
1524   const char *str;
1525   NSTRACE (ns_color_to_lisp);
1527   BLOCK_INPUT;
1528   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1530       if ((str =[[col colorNameComponent] UTF8String]))
1531         {
1532           UNBLOCK_INPUT;
1533           return build_string ((char *)str);
1534         }
1536     [[col colorUsingColorSpaceName: NSCalibratedRGBColorSpace]
1537         getRed: &red green: &green blue: &blue alpha: &alpha];
1538   if (red ==green && red ==blue)
1539     {
1540       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1541             getWhite: &gray alpha: &alpha];
1542       snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1543                 lrint (gray * 0xff), lrint (gray * 0xff), lrint (gray * 0xff));
1544       UNBLOCK_INPUT;
1545       return build_string (buf);
1546     }
1548   snprintf (buf, sizeof (buf), "#%2.2lx%2.2lx%2.2lx",
1549             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1551   UNBLOCK_INPUT;
1552   return build_string (buf);
1556 void
1557 ns_query_color(void *col, XColor *color_def, int setPixel)
1558 /* --------------------------------------------------------------------------
1559          Get ARGB values out of NSColor col and put them into color_def.
1560          If setPixel, set the pixel to a concatenated version.
1561          and set color_def pixel to the resulting index.
1562    -------------------------------------------------------------------------- */
1564   CGFloat r, g, b, a;
1566   [((NSColor *)col) getRed: &r green: &g blue: &b alpha: &a];
1567   color_def->red   = r * 65535;
1568   color_def->green = g * 65535;
1569   color_def->blue  = b * 65535;
1571   if (setPixel == YES)
1572     color_def->pixel
1573       = ARGB_TO_ULONG((int)(a*255),
1574                       (int)(r*255), (int)(g*255), (int)(b*255));
1579 ns_defined_color (struct frame *f,
1580                   const char *name,
1581                   XColor *color_def,
1582                   int alloc,
1583                   char makeIndex)
1584 /* --------------------------------------------------------------------------
1585          Return 1 if named color found, and set color_def rgb accordingly.
1586          If makeIndex and alloc are nonzero put the color in the color_table,
1587          and set color_def pixel to the resulting index.
1588          If makeIndex is zero, set color_def pixel to ARGB.
1589          Return 0 if not found
1590    -------------------------------------------------------------------------- */
1592   NSColor *col;
1593   NSTRACE (ns_defined_color);
1595   BLOCK_INPUT;
1596   if (ns_get_color (name, &col) != 0) /* Color not found  */
1597     {
1598       UNBLOCK_INPUT;
1599       return 0;
1600     }
1601   if (makeIndex && alloc)
1602     color_def->pixel = ns_index_color (col, f);
1603   ns_query_color (col, color_def, !makeIndex);
1604   UNBLOCK_INPUT;
1605   return 1;
1609 unsigned long
1610 ns_get_rgb_color (struct frame *f, float r, float g, float b, float a)
1611 /* --------------------------------------------------------------------------
1612     return an autoreleased RGB color
1613    -------------------------------------------------------------------------- */
1615 /*static int c = 1; fprintf (stderr, "color request %d\n", c++); */
1616   if (r < 0.0) r = 0.0;
1617   else if (r > 1.0) r = 1.0;
1618   if (g < 0.0) g = 0.0;
1619   else if (g > 1.0) g = 1.0;
1620   if (b < 0.0) b = 0.0;
1621   else if (b > 1.0) b = 1.0;
1622   if (a < 0.0) a = 0.0;
1623   else if (a > 1.0) a = 1.0;
1624   return (unsigned long) ns_index_color(
1625     [NSColor colorWithCalibratedRed: r green: g blue: b alpha: a], f);
1629 void
1630 x_set_frame_alpha (struct frame *f)
1631 /* --------------------------------------------------------------------------
1632      change the entire-frame transparency
1633    -------------------------------------------------------------------------- */
1635   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1636   EmacsView *view = FRAME_NS_VIEW (f);
1637   double alpha = 1.0;
1638   double alpha_min = 1.0;
1640   if (dpyinfo->x_highlight_frame == f)
1641     alpha = f->alpha[0];
1642   else
1643     alpha = f->alpha[1];
1645   if (FLOATP (Vframe_alpha_lower_limit))
1646     alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
1647   else if (INTEGERP (Vframe_alpha_lower_limit))
1648     alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
1650   if (alpha < 0.0)
1651     return;
1652   else if (1.0 < alpha)
1653     alpha = 1.0;
1654   else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
1655     alpha = alpha_min;
1657 #ifdef NS_IMPL_COCOA
1658   [[view window] setAlphaValue: alpha];
1659 #endif
1663 /* ==========================================================================
1665     Mouse handling
1667    ========================================================================== */
1670 void
1671 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1672 /* --------------------------------------------------------------------------
1673      Programmatically reposition mouse pointer in pixel coordinates
1674    -------------------------------------------------------------------------- */
1676   NSTRACE (x_set_mouse_pixel_position);
1677   ns_raise_frame (f);
1678 #if 0
1679   /* FIXME: this does not work, and what about GNUstep? */
1680 #ifdef NS_IMPL_COCOA
1681   [FRAME_NS_VIEW (f) lockFocus];
1682   PSsetmouse ((float)pix_x, (float)pix_y);
1683   [FRAME_NS_VIEW (f) unlockFocus];
1684 #endif
1685 #endif
1689 void
1690 x_set_mouse_position (struct frame *f, int h, int v)
1691 /* --------------------------------------------------------------------------
1692      Programmatically reposition mouse pointer in character coordinates
1693    -------------------------------------------------------------------------- */
1695   int pix_x, pix_y;
1697   pix_x = FRAME_COL_TO_PIXEL_X (f, h) + FRAME_COLUMN_WIDTH (f) / 2;
1698   pix_y = FRAME_LINE_TO_PIXEL_Y (f, v) + FRAME_LINE_HEIGHT (f) / 2;
1700   if (pix_x < 0) pix_x = 0;
1701   if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
1703   if (pix_y < 0) pix_y = 0;
1704   if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
1706   x_set_mouse_pixel_position (f, pix_x, pix_y);
1710 static int
1711 note_mouse_movement (struct frame *frame, float x, float y)
1712 /*   ------------------------------------------------------------------------
1713      Called by EmacsView on mouseMovement events.  Passes on
1714      to emacs mainstream code if we moved off of a rect of interest
1715      known as last_mouse_glyph.
1716      ------------------------------------------------------------------------ */
1718 //  NSTRACE (note_mouse_movement);
1720   XSETFRAME (last_mouse_motion_frame, frame);
1722   /* Note, this doesn't get called for enter/leave, since we don't have a
1723      position.  Those are taken care of in the corresponding NSView methods. */
1725   /* has movement gone beyond last rect we were tracking? */
1726   if (x < last_mouse_glyph.origin.x ||
1727       x >= (last_mouse_glyph.origin.x + last_mouse_glyph.size.width) ||
1728       y < last_mouse_glyph.origin.y ||
1729       y >= (last_mouse_glyph.origin.y + last_mouse_glyph.size.height))
1730     {
1731       ns_update_begin(frame);
1732       frame->mouse_moved = 1;
1733       note_mouse_highlight (frame, x, y);
1734       remember_mouse_glyph (frame, x, y, &last_mouse_glyph);
1735       ns_update_end(frame);
1736       return 1;
1737     }
1739   return 0;
1743 static void
1744 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1745                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1746                    Time *time)
1747 /* --------------------------------------------------------------------------
1748     External (hook): inform emacs about mouse position and hit parts.
1749     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1750     x & y should be position in the scrollbar (the whole bar, not the handle)
1751     and length of scrollbar respectively
1752    -------------------------------------------------------------------------- */
1754   id view;
1755   NSPoint position;
1756   Lisp_Object frame, tail;
1757   struct frame *f;
1758   struct ns_display_info *dpyinfo;
1760   NSTRACE (ns_mouse_position);
1762   if (*fp == NULL)
1763     {
1764       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1765       return;
1766     }
1768   dpyinfo = FRAME_NS_DISPLAY_INFO (*fp);
1770   BLOCK_INPUT;
1772   if (last_mouse_scroll_bar != nil && insist == 0)
1773     {
1774       /* TODO: we do not use this path at the moment because drag events will
1775            go directly to the EmacsScroller.  Leaving code in for now. */
1776       [last_mouse_scroll_bar getMouseMotionPart: (int *)part window: bar_window
1777                                               x: x y: y];
1778       if (time) *time = last_mouse_movement_time;
1779       last_mouse_scroll_bar = nil;
1780     }
1781   else
1782     {
1783       /* Clear the mouse-moved flag for every frame on this display.  */
1784       FOR_EACH_FRAME (tail, frame)
1785         if (FRAME_NS_P (XFRAME (frame))
1786             && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1787           XFRAME (frame)->mouse_moved = 0;
1789       last_mouse_scroll_bar = nil;
1790       if (last_mouse_frame && FRAME_LIVE_P (last_mouse_frame))
1791         f = last_mouse_frame;
1792       else
1793         f = dpyinfo->x_focus_frame ? dpyinfo->x_focus_frame
1794                                     : SELECTED_FRAME ();
1796       if (f && f->output_data.ns)  /* TODO: 2nd check no longer needed? */
1797         {
1798           view = FRAME_NS_VIEW (*fp);
1800           position = [[view window] mouseLocationOutsideOfEventStream];
1801           position = [view convertPoint: position fromView: nil];
1802           remember_mouse_glyph (f, position.x, position.y, &last_mouse_glyph);
1803 /*fprintf (stderr, "ns_mouse_position: %.0f, %.0f\n", position.x, position.y); */
1805           if (bar_window) *bar_window = Qnil;
1806           if (part) *part = 0; /*scroll_bar_handle; */
1808           if (x) XSETINT (*x, lrint (position.x));
1809           if (y) XSETINT (*y, lrint (position.y));
1810           if (time) *time = last_mouse_movement_time;
1811           *fp = f;
1812         }
1813     }
1815   UNBLOCK_INPUT;
1819 static void
1820 ns_frame_up_to_date (struct frame *f)
1821 /* --------------------------------------------------------------------------
1822     External (hook): Fix up mouse highlighting right after a full update.
1823     Some highlighting was deferred if GC was happening during
1824     note_mouse_highlight (), while other highlighting was deferred for update.
1825    -------------------------------------------------------------------------- */
1827   NSTRACE (ns_frame_up_to_date);
1829   if (FRAME_NS_P (f))
1830     {
1831       Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1832       if ((hlinfo->mouse_face_deferred_gc || f ==hlinfo->mouse_face_mouse_frame)
1833       /*&& hlinfo->mouse_face_mouse_frame*/)
1834         {
1835           BLOCK_INPUT;
1836           ns_update_begin(f);
1837           if (hlinfo->mouse_face_mouse_frame)
1838             note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
1839                                   hlinfo->mouse_face_mouse_x,
1840                                   hlinfo->mouse_face_mouse_y);
1841           hlinfo->mouse_face_deferred_gc = 0;
1842           ns_update_end(f);
1843           UNBLOCK_INPUT;
1844         }
1845     }
1849 static void
1850 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1851 /* --------------------------------------------------------------------------
1852     External (RIF): set frame mouse pointer type.
1853    -------------------------------------------------------------------------- */
1855   NSTRACE (ns_define_frame_cursor);
1856   if (FRAME_POINTER_TYPE (f) != cursor)
1857     {
1858       EmacsView *view = FRAME_NS_VIEW (f);
1859       FRAME_POINTER_TYPE (f) = cursor;
1860       [[view window] invalidateCursorRectsForView: view];
1861       /* Redisplay assumes this function also draws the changed frame
1862          cursor, but this function doesn't, so do it explicitly.  */
1863       x_update_cursor (f, 1);
1864     }
1869 /* ==========================================================================
1871     Keyboard handling
1873    ========================================================================== */
1876 static unsigned
1877 ns_convert_key (unsigned code)
1878 /* --------------------------------------------------------------------------
1879     Internal call used by NSView-keyDown.
1880    -------------------------------------------------------------------------- */
1882   const unsigned last_keysym = (sizeof (convert_ns_to_X_keysym)
1883                                 / sizeof (convert_ns_to_X_keysym[0]));
1884   unsigned keysym;
1885   /* An array would be faster, but less easy to read. */
1886   for (keysym = 0; keysym < last_keysym; keysym += 2)
1887     if (code == convert_ns_to_X_keysym[keysym])
1888       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
1889   return 0;
1890 /* if decide to use keyCode and Carbon table, use this line:
1891      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
1895 char *
1896 x_get_keysym_name (int keysym)
1897 /* --------------------------------------------------------------------------
1898     Called by keyboard.c.  Not sure if the return val is important, except
1899     that it be unique.
1900    -------------------------------------------------------------------------- */
1902   static char value[16];
1903   NSTRACE (x_get_keysym_name);
1904   sprintf (value, "%d", keysym);
1905   return value;
1910 /* ==========================================================================
1912     Block drawing operations
1914    ========================================================================== */
1917 static void
1918 ns_redraw_scroll_bars (struct frame *f)
1920   int i;
1921   id view;
1922   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
1923   NSTRACE (ns_redraw_scroll_bars);
1924   for (i =[subviews count]-1; i >= 0; i--)
1925     {
1926       view = [subviews objectAtIndex: i];
1927       if (![view isKindOfClass: [EmacsScroller class]]) continue;
1928       [view display];
1929     }
1933 void
1934 ns_clear_frame (struct frame *f)
1935 /* --------------------------------------------------------------------------
1936       External (hook): Erase the entire frame
1937    -------------------------------------------------------------------------- */
1939   NSView *view = FRAME_NS_VIEW (f);
1940   NSRect r;
1942   NSTRACE (ns_clear_frame);
1943   if (ns_in_resize)
1944     return;
1946  /* comes on initial frame because we have
1947     after-make-frame-functions = select-frame */
1948  if (!FRAME_DEFAULT_FACE (f))
1949    return;
1951   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
1953   output_cursor.hpos = output_cursor.vpos = 0;
1954   output_cursor.x = -1;
1956   r = [view bounds];
1958   BLOCK_INPUT;
1959   ns_focus (f, &r, 1);
1960   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
1961   NSRectFill (r);
1962   ns_unfocus (f);
1964 #ifdef NS_IMPL_COCOA
1965   [[view window] display];  /* redraw resize handle */
1966 #endif
1968   /* as of 2006/11 or so this is now needed */
1969   ns_redraw_scroll_bars (f);
1970   UNBLOCK_INPUT;
1974 static void
1975 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
1976 /* --------------------------------------------------------------------------
1977     External (RIF):  Clear section of frame
1978    -------------------------------------------------------------------------- */
1980   NSRect r = NSMakeRect (x, y, width, height);
1981   NSView *view = FRAME_NS_VIEW (f);
1982   struct face *face = FRAME_DEFAULT_FACE (f);
1984   if (!view || !face)
1985     return;
1987   NSTRACE (ns_clear_frame_area);
1989   r = NSIntersectionRect (r, [view frame]);
1990   ns_focus (f, &r, 1);
1991   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
1993 #ifdef NS_IMPL_COCOA
1994   {
1995     /* clip out the resize handle */
1996     NSWindow *window = [FRAME_NS_VIEW (f) window];
1997     NSRect ir
1998       = [view convertRect: ns_resize_handle_rect (window) fromView: nil];
2000     ir = NSIntersectionRect (r, ir);
2001     if (NSIsEmptyRect (ir))
2002       {
2003 #endif
2005   NSRectFill (r);
2007 #ifdef NS_IMPL_COCOA
2008       }
2009     else
2010       {
2011         NSRect r1 = r, r2 = r; /* upper and lower non-intersecting */
2012         r1.size.height -= ir.size.height;
2013         r2.origin.y += r1.size.height;
2014         r2.size.width -= ir.size.width;
2015         r2.size.height = ir.size.height;
2016         NSRectFill (r1);
2017         NSRectFill (r2);
2018       }
2019   }
2020 #endif
2022   ns_unfocus (f);
2023   return;
2027 static void
2028 ns_scroll_run (struct window *w, struct run *run)
2029 /* --------------------------------------------------------------------------
2030     External (RIF):  Insert or delete n lines at line vpos
2031    -------------------------------------------------------------------------- */
2033   struct frame *f = XFRAME (w->frame);
2034   int x, y, width, height, from_y, to_y, bottom_y;
2036   NSTRACE (ns_scroll_run);
2038   /* begin copy from other terms */
2039   /* Get frame-relative bounding box of the text display area of W,
2040      without mode lines.  Include in this box the left and right
2041      fringe of W.  */
2042   window_box (w, -1, &x, &y, &width, &height);
2044   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
2045   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
2046   bottom_y = y + height;
2048   if (to_y < from_y)
2049     {
2050       /* Scrolling up.  Make sure we don't copy part of the mode
2051          line at the bottom.  */
2052       if (from_y + run->height > bottom_y)
2053         height = bottom_y - from_y;
2054       else
2055         height = run->height;
2056     }
2057   else
2058     {
2059       /* Scrolling down.  Make sure we don't copy over the mode line.
2060          at the bottom.  */
2061       if (to_y + run->height > bottom_y)
2062         height = bottom_y - to_y;
2063       else
2064         height = run->height;
2065     }
2066   /* end copy from other terms */
2068   if (height == 0)
2069       return;
2071   BLOCK_INPUT;
2073   updated_window = w;
2074   x_clear_cursor (w);
2076   {
2077     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2078     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2079     NSPoint dstOrigin = NSMakePoint (x, to_y);
2081     ns_focus (f, &dstRect, 1);
2082     NSCopyBits (0, srcRect , dstOrigin);
2083     ns_unfocus (f);
2084   }
2086   UNBLOCK_INPUT;
2090 static void
2091 ns_after_update_window_line (struct glyph_row *desired_row)
2092 /* --------------------------------------------------------------------------
2093     External (RIF): preparatory to fringe update after text was updated
2094    -------------------------------------------------------------------------- */
2096   struct window *w = updated_window;
2097   struct frame *f;
2098   int width, height;
2100   NSTRACE (ns_after_update_window_line);
2102   /* begin copy from other terms */
2103   eassert (w);
2105   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2106     desired_row->redraw_fringe_bitmaps_p = 1;
2108   /* When a window has disappeared, make sure that no rest of
2109      full-width rows stays visible in the internal border.  */
2110   if (windows_or_buffers_changed
2111       && desired_row->full_width_p
2112       && (f = XFRAME (w->frame),
2113           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2114           width != 0)
2115       && (height = desired_row->visible_height,
2116           height > 0))
2117     {
2118       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2120       BLOCK_INPUT;
2121       ns_clear_frame_area (f, 0, y, width, height);
2122       ns_clear_frame_area (f,
2123                            FRAME_PIXEL_WIDTH (f) - width,
2124                            y, width, height);
2125       UNBLOCK_INPUT;
2126     }
2130 static void
2131 ns_shift_glyphs_for_insert (struct frame *f,
2132                            int x, int y, int width, int height,
2133                            int shift_by)
2134 /* --------------------------------------------------------------------------
2135     External (RIF): copy an area horizontally, don't worry about clearing src
2136    -------------------------------------------------------------------------- */
2138   NSRect srcRect = NSMakeRect (x, y, width, height);
2139   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2140   NSPoint dstOrigin = dstRect.origin;
2142   NSTRACE (ns_shift_glyphs_for_insert);
2144   ns_focus (f, &dstRect, 1);
2145   NSCopyBits (0, srcRect, dstOrigin);
2146   ns_unfocus (f);
2151 /* ==========================================================================
2153     Character encoding and metrics
2155    ========================================================================== */
2158 static inline void
2159 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2160 /* --------------------------------------------------------------------------
2161      External (RIF); compute left/right overhang of whole string and set in s
2162    -------------------------------------------------------------------------- */
2164   struct font *font = s->font;
2166   if (s->char2b)
2167     {
2168       struct font_metrics metrics;
2169       unsigned int codes[2];
2170       codes[0] = *(s->char2b);
2171       codes[1] = *(s->char2b + s->nchars - 1);
2173       font->driver->text_extents (font, codes, 2, &metrics);
2174       s->left_overhang = -metrics.lbearing;
2175       s->right_overhang
2176         = metrics.rbearing > metrics.width
2177         ? metrics.rbearing - metrics.width : 0;
2178     }
2179   else
2180     {
2181       s->left_overhang = 0;
2182       s->right_overhang = ((struct nsfont_info *)font)->ital ?
2183         FONT_HEIGHT (font) * 0.2 : 0;
2184     }
2189 /* ==========================================================================
2191     Fringe and cursor drawing
2193    ========================================================================== */
2196 extern int max_used_fringe_bitmap;
2197 static void
2198 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2199                       struct draw_fringe_bitmap_params *p)
2200 /* --------------------------------------------------------------------------
2201     External (RIF); fringe-related
2202    -------------------------------------------------------------------------- */
2204   struct frame *f = XFRAME (WINDOW_FRAME (w));
2205   struct face *face = p->face;
2206   int rowY;
2207   static EmacsImage **bimgs = NULL;
2208   static int nBimgs = 0;
2210   /* grow bimgs if needed */
2211   if (nBimgs < max_used_fringe_bitmap)
2212     {
2213       bimgs = xrealloc (bimgs, max_used_fringe_bitmap * sizeof *bimgs);
2214       memset (bimgs + nBimgs, 0,
2215               (max_used_fringe_bitmap - nBimgs) * sizeof *bimgs);
2216       nBimgs = max_used_fringe_bitmap;
2217     }
2219   /* Must clip because of partially visible lines.  */
2220   rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
2221   ns_clip_to_row (w, row, -1, YES);
2223   if (!p->overlay_p)
2224     {
2225       int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
2227       /* If the fringe is adjacent to the left (right) scroll bar of a
2228          leftmost (rightmost, respectively) window, then extend its
2229          background to the gap between the fringe and the bar.  */
2230       if ((WINDOW_LEFTMOST_P (w)
2231            && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
2232           || (WINDOW_RIGHTMOST_P (w)
2233               && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
2234         {
2235           int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
2237           if (sb_width > 0)
2238             {
2239               int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
2240               int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
2241                                     * FRAME_COLUMN_WIDTH (f));
2243               if (bx < 0)
2244                 {
2245                   /* Bitmap fills the fringe.  */
2246                   if (bar_area_x + bar_area_width == p->x)
2247                     bx = bar_area_x + sb_width;
2248                   else if (p->x + p->wd == bar_area_x)
2249                     bx = bar_area_x;
2250                   if (bx >= 0)
2251                     {
2252                       int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
2254                       nx = bar_area_width - sb_width;
2255                       by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
2256                                                             row->y));
2257                       ny = row->visible_height;
2258                     }
2259                 }
2260               else
2261                 {
2262                   if (bar_area_x + bar_area_width == bx)
2263                     {
2264                       bx = bar_area_x + sb_width;
2265                       nx += bar_area_width - sb_width;
2266                     }
2267                   else if (bx + nx == bar_area_x)
2268                     nx += bar_area_width - sb_width;
2269                 }
2270             }
2271         }
2273       if (bx >= 0 && nx > 0)
2274         {
2275           NSRect r = NSMakeRect (bx, by, nx, ny);
2276           NSRectClip (r);
2277           [ns_lookup_indexed_color (face->background, f) set];
2278           NSRectFill (r);
2279         }
2280     }
2282   if (p->which)
2283     {
2284       NSRect r = NSMakeRect (p->x, p->y, p->wd, p->h);
2285       EmacsImage *img = bimgs[p->which - 1];
2287       if (!img)
2288         {
2289           unsigned short *bits = p->bits + p->dh;
2290           int len = p->h;
2291           int i;
2292           unsigned char *cbits = xmalloc (len);
2294           for (i = 0; i < len; i++)
2295             cbits[i] = ~(bits[i] & 0xff);
2296           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2297                                            flip: NO];
2298           bimgs[p->which - 1] = img;
2299           xfree (cbits);
2300         }
2302       NSRectClip (r);
2303       /* Since we composite the bitmap instead of just blitting it, we need
2304          to erase the whole background. */
2305       [ns_lookup_indexed_color(face->background, f) set];
2306       NSRectFill (r);
2307       [img setXBMColor: ns_lookup_indexed_color(face->foreground, f)];
2308 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
2309       [img drawInRect: r
2310               fromRect: NSZeroRect
2311              operation: NSCompositeSourceOver
2312               fraction: 1.0
2313            respectFlipped: YES
2314                 hints: nil];
2315 #else
2316       {
2317         NSPoint pt = r.origin;
2318         pt.y += p->h;
2319         [img compositeToPoint: pt operation: NSCompositeSourceOver];
2320       }
2321 #endif
2322     }
2323   ns_unfocus (f);
2327 static void
2328 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2329                        int x, int y, int cursor_type, int cursor_width,
2330                        int on_p, int active_p)
2331 /* --------------------------------------------------------------------------
2332      External call (RIF): draw cursor.
2333      Note that CURSOR_WIDTH is meaningful only for (h)bar cursors.
2334    -------------------------------------------------------------------------- */
2336   NSRect r, s;
2337   int fx, fy, h, cursor_height;
2338   struct frame *f = WINDOW_XFRAME (w);
2339   struct glyph *phys_cursor_glyph;
2340   int overspill;
2341   struct glyph *cursor_glyph;
2342   struct face *face;
2343   NSColor *hollow_color = FRAME_BACKGROUND_COLOR (f);
2345   /* If cursor is out of bounds, don't draw garbage.  This can happen
2346      in mini-buffer windows when switching between echo area glyphs
2347      and mini-buffer.  */
2349   NSTRACE (dumpcursor);
2351   if (!on_p)
2352     return;
2354   w->phys_cursor_type = cursor_type;
2355   w->phys_cursor_on_p = on_p;
2357   if (cursor_type == NO_CURSOR)
2358     {
2359       w->phys_cursor_width = 0;
2360       return;
2361     }
2363   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2364     {
2365       if (glyph_row->exact_window_width_line_p
2366           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2367         {
2368           glyph_row->cursor_in_fringe_p = 1;
2369           draw_fringe_bitmap (w, glyph_row, 0);
2370         }
2371       return;
2372     }
2374   /* We draw the cursor (with NSRectFill), then draw the glyph on top
2375      (other terminals do it the other way round).  We must set
2376      w->phys_cursor_width to the cursor width.  For bar cursors, that
2377      is CURSOR_WIDTH; for box cursors, it is the glyph width.  */
2378   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2380   /* The above get_phys_cursor_geometry call set w->phys_cursor_width
2381      to the glyph width; replace with CURSOR_WIDTH for (V)BAR cursors. */
2382   if (cursor_type == BAR_CURSOR)
2383     {
2384       if (cursor_width < 1)
2385         cursor_width = max (FRAME_CURSOR_WIDTH (f), 1);
2386       w->phys_cursor_width = cursor_width;
2387     }
2388   /* If we have an HBAR, "cursor_width" MAY specify height. */
2389   else if (cursor_type == HBAR_CURSOR)
2390     {
2391       cursor_height = (cursor_width < 1) ? lrint (0.25 * h) : cursor_width;
2392       fy += h - cursor_height;
2393       h = cursor_height;
2394     }
2396   r.origin.x = fx, r.origin.y = fy;
2397   r.size.height = h;
2398   r.size.width = w->phys_cursor_width;
2400   /* TODO: only needed in rare cases with last-resort font in HELLO..
2401      should we do this more efficiently? */
2402   ns_clip_to_row (w, glyph_row, -1, NO); /* do ns_focus(f, &r, 1); if remove */
2405   face = FACE_FROM_ID (f, phys_cursor_glyph->face_id);
2406   if (face && NS_FACE_BACKGROUND (face)
2407       == ns_index_color (FRAME_CURSOR_COLOR (f), f))
2408     {
2409       [ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), f) set];
2410       hollow_color = FRAME_CURSOR_COLOR (f);
2411     }
2412   else
2413     [FRAME_CURSOR_COLOR (f) set];
2415 #ifdef NS_IMPL_COCOA
2416   /* TODO: This makes drawing of cursor plus that of phys_cursor_glyph
2417            atomic.  Cleaner ways of doing this should be investigated.
2418            One way would be to set a global variable DRAWING_CURSOR
2419            when making the call to draw_phys..(), don't focus in that
2420            case, then move the ns_unfocus() here after that call. */
2421   NSDisableScreenUpdates ();
2422 #endif
2424   switch (cursor_type)
2425     {
2426     case NO_CURSOR:
2427       break;
2428     case FILLED_BOX_CURSOR:
2429       NSRectFill (r);
2430       break;
2431     case HOLLOW_BOX_CURSOR:
2432       NSRectFill (r);
2433       [hollow_color set];
2434       NSRectFill (NSInsetRect (r, 1, 1));
2435       [FRAME_CURSOR_COLOR (f) set];
2436       break;
2437     case HBAR_CURSOR:
2438       NSRectFill (r);
2439       break;
2440     case BAR_CURSOR:
2441       s = r;
2442       /* If the character under cursor is R2L, draw the bar cursor
2443          on the right of its glyph, rather than on the left.  */
2444       cursor_glyph = get_phys_cursor_glyph (w);
2445       if ((cursor_glyph->resolved_level & 1) != 0)
2446         s.origin.x += cursor_glyph->pixel_width - s.size.width;
2448       NSRectFill (s);
2449       break;
2450     }
2451   ns_unfocus (f);
2453   /* draw the character under the cursor */
2454   if (cursor_type != NO_CURSOR)
2455     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2457 #ifdef NS_IMPL_COCOA
2458   NSEnableScreenUpdates ();
2459 #endif
2464 static void
2465 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2466 /* --------------------------------------------------------------------------
2467      External (RIF): Draw a vertical line.
2468    -------------------------------------------------------------------------- */
2470   struct frame *f = XFRAME (WINDOW_FRAME (w));
2471   struct face *face;
2472   NSRect r = NSMakeRect (x, y0, 1, y1-y0);
2474   NSTRACE (ns_draw_vertical_window_border);
2476   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2477   if (face)
2478       [ns_lookup_indexed_color(face->foreground, f) set];
2480   ns_focus (f, &r, 1);
2481   NSRectFill(r);
2482   ns_unfocus (f);
2486 void
2487 show_hourglass (struct atimer *timer)
2489   if (hourglass_shown_p)
2490     return;
2492   BLOCK_INPUT;
2494   /* TODO: add NSProgressIndicator to selected frame (see macfns.c) */
2496   hourglass_shown_p = 1;
2497   UNBLOCK_INPUT;
2501 void
2502 hide_hourglass (void)
2504   if (!hourglass_shown_p)
2505     return;
2507   BLOCK_INPUT;
2509   /* TODO: remove NSProgressIndicator from all frames */
2511   hourglass_shown_p = 0;
2512   UNBLOCK_INPUT;
2517 /* ==========================================================================
2519     Glyph drawing operations
2521    ========================================================================== */
2523 static int
2524 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2525 /* --------------------------------------------------------------------------
2526     Wrapper utility to account for internal border width on full-width lines,
2527     and allow top full-width rows to hit the frame top.  nr should be pointer
2528     to two successive NSRects.  Number of rects actually used is returned.
2529    -------------------------------------------------------------------------- */
2531   int n = get_glyph_string_clip_rects (s, nr, 2);
2532   return n;
2535 /* --------------------------------------------------------------------
2536    Draw a wavy line under glyph string s. The wave fills wave_height
2537    pixels from y.
2539                     x          wave_length = 3
2540                                  --
2541                 y    *   *   *   *   *
2542                      |* * * * * * * * *
2543     wave_height = 3  | *   *   *   *
2544   --------------------------------------------------------------------- */
2546 static void
2547 ns_draw_underwave (struct glyph_string *s, CGFloat width, CGFloat x)
2549   int wave_height = 3, wave_length = 3;
2550   int y, dx, dy, odd, xmax;
2551   NSPoint a, b;
2552   NSRect waveClip;
2554   dx = wave_length;
2555   dy = wave_height - 1;
2556   y =  s->ybase + 1;
2557   xmax = x + width;
2559   /* Find and set clipping rectangle */
2560   waveClip = NSMakeRect (x, y, width, wave_height);
2561   [[NSGraphicsContext currentContext] saveGraphicsState];
2562   NSRectClip (waveClip);
2564   /* Draw the waves */
2565   a.x = x - ((int)(x) % dx);
2566   b.x = a.x + dx;
2567   odd = (int)(a.x/dx) % 2;
2568   a.y = b.y = y;
2570   if (odd)
2571     a.y += dy;
2572   else
2573     b.y += dy;
2575   while (a.x <= xmax)
2576     {
2577       [NSBezierPath strokeLineFromPoint:a toPoint:b];
2578       a.x = b.x, a.y = b.y;
2579       b.x += dx, b.y = y + odd*dy;
2580       odd = !odd;
2581     }
2583   /* Restore previous clipping rectangle(s) */
2584   [[NSGraphicsContext currentContext] restoreGraphicsState];
2589 void
2590 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
2591                          NSColor *defaultCol, CGFloat width, CGFloat x)
2592 /* --------------------------------------------------------------------------
2593    Draw underline, overline, and strike-through on glyph string s.
2594    -------------------------------------------------------------------------- */
2596   if (s->for_overlaps)
2597     return;
2599   /* Do underline. */
2600   if (face->underline_p)
2601     {
2602       if (s->face->underline_type == FACE_UNDER_WAVE)
2603         {
2604           if (face->underline_defaulted_p)
2605             [defaultCol set];
2606           else
2607             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2609           ns_draw_underwave (s, width, x);
2610         }
2611       else if (s->face->underline_type == FACE_UNDER_LINE)
2612         {
2614           NSRect r;
2615           unsigned long thickness, position;
2617           /* If the prev was underlined, match its appearance. */
2618           if (s->prev && s->prev->face->underline_p
2619               && s->prev->underline_thickness > 0)
2620             {
2621               thickness = s->prev->underline_thickness;
2622               position = s->prev->underline_position;
2623             }
2624           else
2625             {
2626               struct font *font;
2627               unsigned long descent;
2629               font=s->font;
2630               descent = s->y + s->height - s->ybase;
2632               /* Use underline thickness of font, defaulting to 1. */
2633               thickness = (font && font->underline_thickness > 0)
2634                 ? font->underline_thickness : 1;
2636               /* Determine the offset of underlining from the baseline. */
2637               if (x_underline_at_descent_line)
2638                 position = descent - thickness;
2639               else if (x_use_underline_position_properties
2640                        && font && font->underline_position >= 0)
2641                 position = font->underline_position;
2642               else if (font)
2643                 position = lround (font->descent / 2);
2644               else
2645                 position = underline_minimum_offset;
2647               position = max (position, underline_minimum_offset);
2649               /* Ensure underlining is not cropped. */
2650               if (descent <= position)
2651                 {
2652                   position = descent - 1;
2653                   thickness = 1;
2654                 }
2655               else if (descent < position + thickness)
2656                 thickness = 1;
2657             }
2659           s->underline_thickness = thickness;
2660           s->underline_position = position;
2662           r = NSMakeRect (x, s->ybase + position, width, thickness);
2664           if (face->underline_defaulted_p)
2665             [defaultCol set];
2666           else
2667             [ns_lookup_indexed_color (face->underline_color, s->f) set];
2668           NSRectFill (r);
2669         }
2670     }
2671   /* Do overline. We follow other terms in using a thickness of 1
2672      and ignoring overline_margin. */
2673   if (face->overline_p)
2674     {
2675       NSRect r;
2676       r = NSMakeRect (x, s->y, width, 1);
2678       if (face->overline_color_defaulted_p)
2679         [defaultCol set];
2680       else
2681         [ns_lookup_indexed_color (face->overline_color, s->f) set];
2682       NSRectFill (r);
2683     }
2685   /* Do strike-through.  We follow other terms for thickness and
2686      vertical position.*/
2687   if (face->strike_through_p)
2688     {
2689       NSRect r;
2690       unsigned long dy;
2692       dy = lrint ((s->height - 1) / 2);
2693       r = NSMakeRect (x, s->y + dy, width, 1);
2695       if (face->strike_through_color_defaulted_p)
2696         [defaultCol set];
2697       else
2698         [ns_lookup_indexed_color (face->strike_through_color, s->f) set];
2699       NSRectFill (r);
2700     }
2703 static void
2704 ns_draw_box (NSRect r, float thickness, NSColor *col, char left_p, char right_p)
2705 /* --------------------------------------------------------------------------
2706     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2707     Note we can't just use an NSDrawRect command, because of the possibility
2708     of some sides not being drawn, and because the rect will be filled.
2709    -------------------------------------------------------------------------- */
2711   NSRect s = r;
2712   [col set];
2714   /* top, bottom */
2715   s.size.height = thickness;
2716   NSRectFill (s);
2717   s.origin.y += r.size.height - thickness;
2718   NSRectFill (s);
2720   s.size.height = r.size.height;
2721   s.origin.y = r.origin.y;
2723   /* left, right (optional) */
2724   s.size.width = thickness;
2725   if (left_p)
2726     NSRectFill (s);
2727   if (right_p)
2728     {
2729       s.origin.x += r.size.width - thickness;
2730       NSRectFill (s);
2731     }
2735 static void
2736 ns_draw_relief (NSRect r, int thickness, char raised_p,
2737                char top_p, char bottom_p, char left_p, char right_p,
2738                struct glyph_string *s)
2739 /* --------------------------------------------------------------------------
2740     Draw a relief rect inside r, optionally leaving some sides open.
2741     Note we can't just use an NSDrawBezel command, because of the possibility
2742     of some sides not being drawn, and because the rect will be filled.
2743    -------------------------------------------------------------------------- */
2745   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2746   NSColor *newBaseCol = nil;
2747   NSRect sr = r;
2749   NSTRACE (ns_draw_relief);
2751   /* set up colors */
2753   if (s->face->use_box_color_for_shadows_p)
2754     {
2755       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2756     }
2757 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2758            && s->img->pixmap
2759            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2760        {
2761          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2762        } */
2763   else
2764     {
2765       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2766     }
2768   if (newBaseCol == nil)
2769     newBaseCol = [NSColor grayColor];
2771   if (newBaseCol != baseCol)  /* TODO: better check */
2772     {
2773       [baseCol release];
2774       baseCol = [newBaseCol retain];
2775       [lightCol release];
2776       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2777       [darkCol release];
2778       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2779     }
2781   [(raised_p ? lightCol : darkCol) set];
2783   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2785   /* top */
2786   sr.size.height = thickness;
2787   if (top_p) NSRectFill (sr);
2789   /* left */
2790   sr.size.height = r.size.height;
2791   sr.size.width = thickness;
2792   if (left_p) NSRectFill (sr);
2794   [(raised_p ? darkCol : lightCol) set];
2796   /* bottom */
2797   sr.size.width = r.size.width;
2798   sr.size.height = thickness;
2799   sr.origin.y += r.size.height - thickness;
2800   if (bottom_p) NSRectFill (sr);
2802   /* right */
2803   sr.size.height = r.size.height;
2804   sr.origin.y = r.origin.y;
2805   sr.size.width = thickness;
2806   sr.origin.x += r.size.width - thickness;
2807   if (right_p) NSRectFill (sr);
2811 static void
2812 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2813 /* --------------------------------------------------------------------------
2814       Function modeled after x_draw_glyph_string_box ().
2815       Sets up parameters for drawing.
2816    -------------------------------------------------------------------------- */
2818   int right_x, last_x;
2819   char left_p, right_p;
2820   struct glyph *last_glyph;
2821   NSRect r;
2822   int thickness;
2823   struct face *face;
2825   if (s->hl == DRAW_MOUSE_FACE)
2826     {
2827       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2828       if (!face)
2829         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2830     }
2831   else
2832     face = s->face;
2834   thickness = face->box_line_width;
2836   NSTRACE (ns_dumpglyphs_box_or_relief);
2838   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2839             ? WINDOW_RIGHT_EDGE_X (s->w)
2840             : window_box_right (s->w, s->area));
2841   last_glyph = (s->cmp || s->img
2842                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2844   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2845               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2847   left_p = (s->first_glyph->left_box_line_p
2848             || (s->hl == DRAW_MOUSE_FACE
2849                 && (s->prev == NULL || s->prev->hl != s->hl)));
2850   right_p = (last_glyph->right_box_line_p
2851              || (s->hl == DRAW_MOUSE_FACE
2852                  && (s->next == NULL || s->next->hl != s->hl)));
2854   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2856   /* TODO: Sometimes box_color is 0 and this seems wrong; should investigate. */
2857   if (s->face->box == FACE_SIMPLE_BOX && s->face->box_color)
2858     {
2859       ns_draw_box (r, abs (thickness),
2860                    ns_lookup_indexed_color (face->box_color, s->f),
2861                   left_p, right_p);
2862     }
2863   else
2864     {
2865       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2866                      1, 1, left_p, right_p, s);
2867     }
2871 static void
2872 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2873 /* --------------------------------------------------------------------------
2874       Modeled after x_draw_glyph_string_background, which draws BG in
2875       certain cases.  Others are left to the text rendering routine.
2876    -------------------------------------------------------------------------- */
2878   NSTRACE (ns_maybe_dumpglyphs_background);
2880   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2881     {
2882       int box_line_width = max (s->face->box_line_width, 0);
2883       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2884           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2885         {
2886           struct face *face;
2887           if (s->hl == DRAW_MOUSE_FACE)
2888             {
2889               face = FACE_FROM_ID (s->f,
2890                                    MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2891               if (!face)
2892                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2893             }
2894           else
2895             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2896           if (!face->stipple)
2897             [(NS_FACE_BACKGROUND (face) != 0
2898               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2899               : FRAME_BACKGROUND_COLOR (s->f)) set];
2900           else
2901             {
2902               struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (s->f);
2903               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2904             }
2906           if (s->hl != DRAW_CURSOR)
2907             {
2908               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2909                                     s->background_width,
2910                                     s->height-2*box_line_width);
2911               NSRectFill (r);
2912             }
2914           s->background_filled_p = 1;
2915         }
2916     }
2920 static void
2921 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2922 /* --------------------------------------------------------------------------
2923       Renders an image and associated borders.
2924    -------------------------------------------------------------------------- */
2926   EmacsImage *img = s->img->pixmap;
2927   int box_line_vwidth = max (s->face->box_line_width, 0);
2928   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2929   int bg_x, bg_y, bg_height;
2930   int th;
2931   char raised_p;
2932   NSRect br;
2933   struct face *face;
2934   NSColor *tdCol;
2936   NSTRACE (ns_dumpglyphs_image);
2938   if (s->face->box != FACE_NO_BOX
2939       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2940     x += abs (s->face->box_line_width);
2942   bg_x = x;
2943   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
2944   bg_height = s->height;
2945   /* other terms have this, but was causing problems w/tabbar mode */
2946   /* - 2 * box_line_vwidth; */
2948   if (s->slice.x == 0) x += s->img->hmargin;
2949   if (s->slice.y == 0) y += s->img->vmargin;
2951   /* Draw BG: if we need larger area than image itself cleared, do that,
2952      otherwise, since we composite the image under NS (instead of mucking
2953      with its background color), we must clear just the image area. */
2954   if (s->hl == DRAW_MOUSE_FACE)
2955     {
2956       face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
2957       if (!face)
2958        face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2959     }
2960   else
2961     face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2963   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f) set];
2965   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
2966       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
2967     {
2968       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
2969       s->background_filled_p = 1;
2970     }
2971   else
2972     {
2973       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
2974     }
2976   NSRectFill (br);
2978   /* Draw the image.. do we need to draw placeholder if img ==nil? */
2979   if (img != nil)
2980     {
2981 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
2982       [img drawInRect: br
2983              fromRect: NSZeroRect
2984              operation: NSCompositeSourceOver
2985               fraction: 1.0
2986            respectFlipped: YES
2987                 hints: nil];
2988 #else
2989       [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
2990                   operation: NSCompositeSourceOver];
2991 #endif
2992     }
2994   if (s->hl == DRAW_CURSOR)
2995     {
2996     [FRAME_CURSOR_COLOR (s->f) set];
2997     if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
2998       tdCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
2999     else
3000       /* Currently on NS img->mask is always 0. Since
3001          get_window_cursor_type specifies a hollow box cursor when on
3002          a non-masked image we never reach this clause. But we put it
3003          in in anticipation of better support for image masks on
3004          NS. */
3005       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3006     }
3007   else
3008     {
3009       tdCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3010     }
3012   /* Draw underline, overline, strike-through. */
3013   ns_draw_text_decoration (s, face, tdCol, br.size.width, br.origin.x);
3015   /* Draw relief, if requested */
3016   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
3017     {
3018       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
3019         {
3020           th = tool_bar_button_relief >= 0 ?
3021             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
3022           raised_p = (s->hl == DRAW_IMAGE_RAISED);
3023         }
3024       else
3025         {
3026           th = abs (s->img->relief);
3027           raised_p = (s->img->relief > 0);
3028         }
3030       r.origin.x = x - th;
3031       r.origin.y = y - th;
3032       r.size.width = s->slice.width + 2*th-1;
3033       r.size.height = s->slice.height + 2*th-1;
3034       ns_draw_relief (r, th, raised_p,
3035                       s->slice.y == 0,
3036                       s->slice.y + s->slice.height == s->img->height,
3037                       s->slice.x == 0,
3038                       s->slice.x + s->slice.width == s->img->width, s);
3039     }
3041   /* If there is no mask, the background won't be seen,
3042      so draw a rectangle on the image for the cursor.
3043      Do this for all images, getting transparency right is not reliable.  */
3044   if (s->hl == DRAW_CURSOR)
3045     {
3046       int thickness = abs (s->img->relief);
3047       if (thickness == 0) thickness = 1;
3048       ns_draw_box (br, thickness, FRAME_CURSOR_COLOR (s->f), 1, 1);
3049     }
3053 static void
3054 ns_dumpglyphs_stretch (struct glyph_string *s)
3056   NSRect r[2];
3057   int n, i;
3058   struct face *face;
3059   NSColor *fgCol, *bgCol;
3061   if (!s->background_filled_p)
3062     {
3063       n = ns_get_glyph_string_clip_rect (s, r);
3064       *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
3066       ns_focus (s->f, r, n);
3068       if (s->hl == DRAW_MOUSE_FACE)
3069        {
3070          face = FACE_FROM_ID (s->f, MOUSE_HL_INFO (s->f)->mouse_face_face_id);
3071          if (!face)
3072            face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
3073        }
3074       else
3075        face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
3077       bgCol = ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f);
3078       fgCol = ns_lookup_indexed_color (NS_FACE_FOREGROUND (face), s->f);
3080       for (i = 0; i < n; ++i)
3081         {
3082           if (!s->row->full_width_p)
3083             {
3084               int overrun, leftoverrun;
3086               /* truncate to avoid overwriting fringe and/or scrollbar */
3087               overrun = max (0, (s->x + s->background_width)
3088                              - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
3089                                 - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
3090               r[i].size.width -= overrun;
3092               /* truncate to avoid overwriting to left of the window box */
3093               leftoverrun = (WINDOW_BOX_LEFT_EDGE_X (s->w)
3094                              + WINDOW_LEFT_FRINGE_WIDTH (s->w)) - s->x;
3096               if (leftoverrun > 0)
3097                 {
3098                   r[i].origin.x += leftoverrun;
3099                   r[i].size.width -= leftoverrun;
3100                 }
3102               /* XXX: Try to work between problem where a stretch glyph on
3103                  a partially-visible bottom row will clear part of the
3104                  modeline, and another where list-buffers headers and similar
3105                  rows erroneously have visible_height set to 0.  Not sure
3106                  where this is coming from as other terms seem not to show. */
3107               r[i].size.height = min (s->height, s->row->visible_height);
3108             }
3110           [bgCol set];
3112           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
3113              overwriting cursor (usually when cursor on a tab) */
3114           if (s->hl == DRAW_CURSOR)
3115             {
3116               CGFloat x, width;
3118               x = r[i].origin.x;
3119               width = s->w->phys_cursor_width;
3120               r[i].size.width -= width;
3121               r[i].origin.x += width;
3123               NSRectFill (r[i]);
3125               /* Draw overlining, etc. on the cursor. */
3126               if (s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3127                 ns_draw_text_decoration (s, face, bgCol, width, x);
3128               else
3129                 ns_draw_text_decoration (s, face, fgCol, width, x);
3130             }
3131           else
3132             {
3133               NSRectFill (r[i]);
3134             }
3136           /* Draw overlining, etc. on the stretch glyph (or the part
3137              of the stretch glyph after the cursor). */
3138           ns_draw_text_decoration (s, face, fgCol, r[i].size.width,
3139                                    r[i].origin.x);
3140         }
3141       ns_unfocus (s->f);
3142       s->background_filled_p = 1;
3143     }
3147 static void
3148 ns_draw_glyph_string (struct glyph_string *s)
3149 /* --------------------------------------------------------------------------
3150       External (RIF): Main draw-text call.
3151    -------------------------------------------------------------------------- */
3153   /* TODO (optimize): focus for box and contents draw */
3154   NSRect r[2];
3155   int n;
3156   char box_drawn_p = 0;
3158   NSTRACE (ns_draw_glyph_string);
3160   if (s->next && s->right_overhang && !s->for_overlaps/*&&s->hl!=DRAW_CURSOR*/)
3161     {
3162       int width;
3163       struct glyph_string *next;
3165       for (width = 0, next = s->next;
3166            next && width < s->right_overhang;
3167            width += next->width, next = next->next)
3168         if (next->first_glyph->type != IMAGE_GLYPH)
3169           {
3170             if (next->first_glyph->type != STRETCH_GLYPH)
3171               {
3172                 n = ns_get_glyph_string_clip_rect (s->next, r);
3173                 ns_focus (s->f, r, n);
3174                 ns_maybe_dumpglyphs_background (s->next, 1);
3175                 ns_unfocus (s->f);
3176               }
3177             else
3178               {
3179                 ns_dumpglyphs_stretch (s->next);
3180               }
3181             next->num_clips = 0;
3182           }
3183     }
3185   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
3186         && (s->first_glyph->type == CHAR_GLYPH
3187             || s->first_glyph->type == COMPOSITE_GLYPH))
3188     {
3189       n = ns_get_glyph_string_clip_rect (s, r);
3190       ns_focus (s->f, r, n);
3191       ns_maybe_dumpglyphs_background (s, 1);
3192       ns_dumpglyphs_box_or_relief (s);
3193       ns_unfocus (s->f);
3194       box_drawn_p = 1;
3195     }
3197   switch (s->first_glyph->type)
3198     {
3200     case IMAGE_GLYPH:
3201       n = ns_get_glyph_string_clip_rect (s, r);
3202       ns_focus (s->f, r, n);
3203       ns_dumpglyphs_image (s, r[0]);
3204       ns_unfocus (s->f);
3205       break;
3207     case STRETCH_GLYPH:
3208       ns_dumpglyphs_stretch (s);
3209       break;
3211     case CHAR_GLYPH:
3212     case COMPOSITE_GLYPH:
3213       n = ns_get_glyph_string_clip_rect (s, r);
3214       ns_focus (s->f, r, n);
3216       if (s->for_overlaps || (s->cmp_from > 0
3217                               && ! s->first_glyph->u.cmp.automatic))
3218         s->background_filled_p = 1;
3219       else
3220         ns_maybe_dumpglyphs_background
3221           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3223       ns_tmp_flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
3224                     (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
3225                      (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
3226                       NS_DUMPGLYPH_NORMAL));
3227       ns_tmp_font = (struct nsfont_info *)s->face->font;
3228       if (ns_tmp_font == NULL)
3229           ns_tmp_font = (struct nsfont_info *)FRAME_FONT (s->f);
3231       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3232         {
3233           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3234           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3235           NS_FACE_FOREGROUND (s->face) = tmp;
3236         }
3238       ns_tmp_font->font.driver->draw
3239         (s, 0, s->nchars, s->x, s->y,
3240          (ns_tmp_flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
3241          || ns_tmp_flags == NS_DUMPGLYPH_MOUSEFACE);
3243       if (s->hl == DRAW_CURSOR && s->w->phys_cursor_type == FILLED_BOX_CURSOR)
3244         {
3245           unsigned long tmp = NS_FACE_BACKGROUND (s->face);
3246           NS_FACE_BACKGROUND (s->face) = NS_FACE_FOREGROUND (s->face);
3247           NS_FACE_FOREGROUND (s->face) = tmp;
3248         }
3250       ns_unfocus (s->f);
3251       break;
3253     case GLYPHLESS_GLYPH:
3254       n = ns_get_glyph_string_clip_rect (s, r);
3255       ns_focus (s->f, r, n);
3257       if (s->for_overlaps || (s->cmp_from > 0
3258                               && ! s->first_glyph->u.cmp.automatic))
3259         s->background_filled_p = 1;
3260       else
3261         ns_maybe_dumpglyphs_background
3262           (s, s->first_glyph->type == COMPOSITE_GLYPH);
3263       /* ... */
3264       /* Not yet implemented.  */
3265       /* ... */
3266       ns_unfocus (s->f);
3267       break;
3269     default:
3270       emacs_abort ();
3271     }
3273   /* Draw box if not done already. */
3274   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
3275     {
3276       n = ns_get_glyph_string_clip_rect (s, r);
3277       ns_focus (s->f, r, n);
3278       ns_dumpglyphs_box_or_relief (s);
3279       ns_unfocus (s->f);
3280     }
3282   s->num_clips = 0;
3287 /* ==========================================================================
3289     Event loop
3291    ========================================================================== */
3294 static void
3295 ns_send_appdefined (int value)
3296 /* --------------------------------------------------------------------------
3297     Internal: post an appdefined event which EmacsApp-sendEvent will
3298               recognize and take as a command to halt the event loop.
3299    -------------------------------------------------------------------------- */
3301   /*NSTRACE (ns_send_appdefined); */
3303   /* Only post this event if we haven't already posted one.  This will end
3304        the [NXApp run] main loop after having processed all events queued at
3305        this moment.  */
3306   if (send_appdefined)
3307     {
3308       NSEvent *nxev;
3310       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
3311       send_appdefined = NO;
3313       /* Don't need wakeup timer any more */
3314       if (timed_entry)
3315         {
3316           [timed_entry invalidate];
3317           [timed_entry release];
3318           timed_entry = nil;
3319         }
3321       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3322                                 location: NSMakePoint (0, 0)
3323                            modifierFlags: 0
3324                                timestamp: 0
3325                             windowNumber: [[NSApp mainWindow] windowNumber]
3326                                  context: [NSApp context]
3327                                  subtype: 0
3328                                    data1: value
3329                                    data2: 0];
3331       /* Post an application defined event on the event queue.  When this is
3332          received the [NXApp run] will return, thus having processed all
3333          events which are currently queued.  */
3334       [NSApp postEvent: nxev atStart: NO];
3335     }
3338 static int
3339 ns_read_socket (struct terminal *terminal, int expected,
3340                 struct input_event *hold_quit)
3341 /* --------------------------------------------------------------------------
3342      External (hook): Post an event to ourself and keep reading events until
3343      we read it back again.  In effect process all events which were waiting.
3344      From 21+ we have to manage the event buffer ourselves.
3345    -------------------------------------------------------------------------- */
3347   struct input_event ev;
3348   int nevents;
3350 /* NSTRACE (ns_read_socket); */
3352   if ([NSApp modalWindow] != nil)
3353     return -1;
3355   if (interrupt_input_blocked)
3356     {
3357       interrupt_input_pending = 1;
3358       pending_signals = 1;
3359       return -1;
3360     }
3362   interrupt_input_pending = 0;
3363   pending_signals = pending_atimers;
3365   BLOCK_INPUT;
3366   n_emacs_events_pending = 0;
3367   EVENT_INIT (ev);
3368   emacs_event = &ev;
3369   q_event_ptr = hold_quit;
3371   /* we manage autorelease pools by allocate/reallocate each time around
3372      the loop; strict nesting is occasionally violated but seems not to
3373      matter.. earlier methods using full nesting caused major memory leaks */
3374   [outerpool release];
3375   outerpool = [[NSAutoreleasePool alloc] init];
3377   /* If have pending open-file requests, attend to the next one of those. */
3378   if (ns_pending_files && [ns_pending_files count] != 0
3379       && [(EmacsApp *)NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3380     {
3381       [ns_pending_files removeObjectAtIndex: 0];
3382     }
3383   /* Deal with pending service requests. */
3384   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3385     && [(EmacsApp *)
3386          NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3387                       withArg: [ns_pending_service_args objectAtIndex: 0]])
3388     {
3389       [ns_pending_service_names removeObjectAtIndex: 0];
3390       [ns_pending_service_args removeObjectAtIndex: 0];
3391     }
3392   else
3393     {
3394       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3395          to ourself, otherwise [NXApp run] will never exit.  */
3396       send_appdefined = YES;
3397       ns_send_appdefined (-1);
3399       if (++apploopnr != 1)
3400         {
3401           emacs_abort ();
3402         }
3403       [NSApp run];
3404       --apploopnr;
3405     }
3407   nevents = n_emacs_events_pending;
3408   n_emacs_events_pending = 0;
3409   emacs_event = q_event_ptr = NULL;
3410   UNBLOCK_INPUT;
3412   return nevents;
3417 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3418            fd_set *exceptfds, EMACS_TIME *timeout, sigset_t *sigmask)
3419 /* --------------------------------------------------------------------------
3420      Replacement for select, checking for events
3421    -------------------------------------------------------------------------- */
3423   int result;
3424   NSEvent *ev;
3425   int k, nr = 0;
3426   struct input_event event;
3427   char c;
3429 /*  NSTRACE (ns_select); */
3431   for (k = 0; readfds && k < nfds+1; k++)
3432     if (FD_ISSET(k, readfds)) ++nr;
3434   if (NSApp == nil
3435       || (timeout && timeout->tv_sec == 0 && timeout->tv_nsec == 0))
3436     return pselect (nfds, readfds, writefds, exceptfds, timeout, sigmask);
3438   [outerpool release];
3439   outerpool = [[NSAutoreleasePool alloc] init];
3442   send_appdefined = YES;
3443   if (nr > 0)
3444     {
3445       pthread_mutex_lock (&select_mutex);
3446       select_nfds = nfds;
3447       select_valid = 0;
3448       if (readfds)
3449         {
3450           select_readfds = *readfds;
3451           select_valid += SELECT_HAVE_READ;
3452         }
3453       if (writefds)
3454         {
3455           select_writefds = *writefds;
3456           select_valid += SELECT_HAVE_WRITE;
3457         }
3459       if (timeout)
3460         {
3461           select_timeout = *timeout;
3462           select_valid += SELECT_HAVE_TMO;
3463         }
3465       pthread_mutex_unlock (&select_mutex);
3467       /* Inform fd_handler that select should be called */
3468       c = 'g';
3469       write (selfds[1], &c, 1);
3470     }
3471   else if (nr == 0 && timeout)
3472     {
3473       /* No file descriptor, just a timeout, no need to wake fd_handler  */
3474       double time = EMACS_TIME_TO_DOUBLE (*timeout);
3475       timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3476                                                       target: NSApp
3477                                                     selector:
3478                                   @selector (timeout_handler:)
3479                                                     userInfo: 0
3480                                                      repeats: NO]
3481                       retain];
3482     }
3483   else /* No timeout and no file descriptors, can this happen?  */
3484     {
3485       /* Send appdefined so we exit from the loop */
3486       ns_send_appdefined (-1);
3487     }
3489   EVENT_INIT (event);
3490   BLOCK_INPUT;
3491   emacs_event = &event;
3492   if (++apploopnr != 1)
3493     {
3494       emacs_abort ();
3495     }
3496   [NSApp run];
3497   --apploopnr;
3498   emacs_event = NULL;
3499   if (nr > 0 && readfds)
3500     {
3501       c = 's';
3502       write (selfds[1], &c, 1);
3503     }
3504   UNBLOCK_INPUT;
3506   ev = last_appdefined_event;
3508   if (ev)
3509     {
3510       int t;
3511       if ([ev type] != NSApplicationDefined)
3512         emacs_abort ();
3514       t = [ev data1];
3515       last_appdefined_event = 0;
3517       if (t == -2)
3518         {
3519           /* The NX_APPDEFINED event we received was a timeout. */
3520           result = 0;
3521         }
3522       else if (t == -1)
3523         {
3524           /* The NX_APPDEFINED event we received was the result of
3525              at least one real input event arriving.  */
3526           errno = EINTR;
3527           result = -1;
3528         }
3529       else
3530         {
3531           /* Received back from select () in fd_handler; copy the results */
3532           pthread_mutex_lock (&select_mutex);
3533           if (readfds) *readfds = select_readfds;
3534           if (writefds) *writefds = select_writefds;
3535           if (timeout) *timeout = select_timeout;
3536           pthread_mutex_unlock (&select_mutex);
3537           result = t;
3538         }
3539     }
3541   return result;
3546 /* ==========================================================================
3548     Scrollbar handling
3550    ========================================================================== */
3553 static void
3554 ns_set_vertical_scroll_bar (struct window *window,
3555                            int portion, int whole, int position)
3556 /* --------------------------------------------------------------------------
3557       External (hook): Update or add scrollbar
3558    -------------------------------------------------------------------------- */
3560   Lisp_Object win;
3561   NSRect r, v;
3562   struct frame *f = XFRAME (WINDOW_FRAME (window));
3563   EmacsView *view = FRAME_NS_VIEW (f);
3564   int window_y, window_height;
3565   int top, left, height, width, sb_width, sb_left;
3566   EmacsScroller *bar;
3567   BOOL fringe_extended_p;
3569   /* optimization; display engine sends WAY too many of these.. */
3570   if (!NILP (window->vertical_scroll_bar))
3571     {
3572       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3573       if ([bar checkSamePosition: position portion: portion whole: whole])
3574         {
3575           if (view->scrollbarsNeedingUpdate == 0)
3576             {
3577               if (!windows_or_buffers_changed)
3578                   return;
3579             }
3580           else
3581             view->scrollbarsNeedingUpdate--;
3582         }
3583     }
3585   NSTRACE (ns_set_vertical_scroll_bar);
3587   /* Get dimensions.  */
3588   window_box (window, -1, 0, &window_y, 0, &window_height);
3589   top = window_y;
3590   height = window_height;
3591   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3592   left = WINDOW_SCROLL_BAR_AREA_X (window);
3594   /* allow for displaying a skinnier scrollbar than char area allotted */
3595   sb_width = (WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) > 0) ?
3596     WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) : width;
3597   sb_left = left;
3599   r = NSMakeRect (sb_left, top, sb_width, height);
3600   /* the parent view is flipped, so we need to flip y value */
3601   v = [view frame];
3602   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3604   if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (window))
3605     fringe_extended_p = (WINDOW_LEFTMOST_P (window)
3606                          && WINDOW_LEFT_FRINGE_WIDTH (window)
3607                          && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (window)
3608                              || WINDOW_LEFT_MARGIN_COLS (window) == 0));
3609   else
3610     fringe_extended_p = (WINDOW_RIGHTMOST_P (window)
3611                          && WINDOW_RIGHT_FRINGE_WIDTH (window)
3612                          && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (window)
3613                              || WINDOW_RIGHT_MARGIN_COLS (window) == 0));
3615   XSETWINDOW (win, window);
3616   BLOCK_INPUT;
3618   /* we want at least 5 lines to display a scrollbar */
3619   if (WINDOW_TOTAL_LINES (window) < 5)
3620     {
3621       if (!NILP (window->vertical_scroll_bar))
3622         {
3623           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3624           [bar removeFromSuperview];
3625           wset_vertical_scroll_bar (window, Qnil);
3626         }
3627       ns_clear_frame_area (f, sb_left, top, width, height);
3628       UNBLOCK_INPUT;
3629       return;
3630     }
3632   if (NILP (window->vertical_scroll_bar))
3633     {
3634       if (width > 0 && height > 0)
3635         {
3636           if (fringe_extended_p)
3637             ns_clear_frame_area (f, sb_left, top, sb_width, height);
3638           else
3639             ns_clear_frame_area (f, left, top, width, height);
3640         }
3642       bar = [[EmacsScroller alloc] initFrame: r window: win];
3643       wset_vertical_scroll_bar (window, make_save_value (bar, 0));
3644     }
3645   else
3646     {
3647       NSRect oldRect;
3648       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3649       oldRect = [bar frame];
3650       r.size.width = oldRect.size.width;
3651       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3652         {
3653           if (oldRect.origin.x != r.origin.x)
3654               ns_clear_frame_area (f, sb_left, top, width, height);
3655           [bar setFrame: r];
3656         }
3657     }
3659   [bar setPosition: position portion: portion whole: whole];
3660   UNBLOCK_INPUT;
3664 static void
3665 ns_condemn_scroll_bars (struct frame *f)
3666 /* --------------------------------------------------------------------------
3667      External (hook): arrange for all frame's scrollbars to be removed
3668      at next call to judge_scroll_bars, except for those redeemed.
3669    -------------------------------------------------------------------------- */
3671   int i;
3672   id view;
3673   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3675   NSTRACE (ns_condemn_scroll_bars);
3677   for (i =[subviews count]-1; i >= 0; i--)
3678     {
3679       view = [subviews objectAtIndex: i];
3680       if ([view isKindOfClass: [EmacsScroller class]])
3681         [view condemn];
3682     }
3686 static void
3687 ns_redeem_scroll_bar (struct window *window)
3688 /* --------------------------------------------------------------------------
3689      External (hook): arrange to spare this window's scrollbar
3690      at next call to judge_scroll_bars.
3691    -------------------------------------------------------------------------- */
3693   id bar;
3694   NSTRACE (ns_redeem_scroll_bar);
3695   if (!NILP (window->vertical_scroll_bar))
3696     {
3697       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3698       [bar reprieve];
3699     }
3703 static void
3704 ns_judge_scroll_bars (struct frame *f)
3705 /* --------------------------------------------------------------------------
3706      External (hook): destroy all scrollbars on frame that weren't
3707      redeemed after call to condemn_scroll_bars.
3708    -------------------------------------------------------------------------- */
3710   int i;
3711   id view;
3712   EmacsView *eview = FRAME_NS_VIEW (f);
3713   NSArray *subviews = [[eview superview] subviews];
3714   BOOL removed = NO;
3716   NSTRACE (ns_judge_scroll_bars);
3717   for (i = [subviews count]-1; i >= 0; --i)
3718     {
3719       view = [subviews objectAtIndex: i];
3720       if (![view isKindOfClass: [EmacsScroller class]]) continue;
3721       [view judge];
3722       removed = YES;
3723     }
3725   if (removed)
3726     [eview updateFrameSize: NO];
3730 void
3731 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
3733   /* XXX irrelevant under NS */
3738 /* ==========================================================================
3740     Initialization
3742    ========================================================================== */
3745 x_display_pixel_height (struct ns_display_info *dpyinfo)
3747   NSScreen *screen = [NSScreen mainScreen];
3748   return [screen frame].size.height;
3752 x_display_pixel_width (struct ns_display_info *dpyinfo)
3754   NSScreen *screen = [NSScreen mainScreen];
3755   return [screen frame].size.width;
3759 static Lisp_Object ns_string_to_lispmod (const char *s)
3760 /* --------------------------------------------------------------------------
3761      Convert modifier name to lisp symbol
3762    -------------------------------------------------------------------------- */
3764   if (!strncmp (SSDATA (SYMBOL_NAME (Qmeta)), s, 10))
3765     return Qmeta;
3766   else if (!strncmp (SSDATA (SYMBOL_NAME (Qsuper)), s, 10))
3767     return Qsuper;
3768   else if (!strncmp (SSDATA (SYMBOL_NAME (Qcontrol)), s, 10))
3769     return Qcontrol;
3770   else if (!strncmp (SSDATA (SYMBOL_NAME (Qalt)), s, 10))
3771     return Qalt;
3772   else if (!strncmp (SSDATA (SYMBOL_NAME (Qhyper)), s, 10))
3773     return Qhyper;
3774   else if (!strncmp (SSDATA (SYMBOL_NAME (Qnone)), s, 10))
3775     return Qnone;
3776   else
3777     return Qnil;
3781 static void
3782 ns_default (const char *parameter, Lisp_Object *result,
3783            Lisp_Object yesval, Lisp_Object noval,
3784            BOOL is_float, BOOL is_modstring)
3785 /* --------------------------------------------------------------------------
3786       Check a parameter value in user's preferences
3787    -------------------------------------------------------------------------- */
3789   const char *value = ns_get_defaults_value (parameter);
3791   if (value)
3792     {
3793       double f;
3794       char *pos;
3795       if (c_strcasecmp (value, "YES") == 0)
3796         *result = yesval;
3797       else if (c_strcasecmp (value, "NO") == 0)
3798         *result = noval;
3799       else if (is_float && (f = strtod (value, &pos), pos != value))
3800         *result = make_float (f);
3801       else if (is_modstring && value)
3802         *result = ns_string_to_lispmod (value);
3803       else fprintf (stderr,
3804                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
3805     }
3809 static void
3810 ns_initialize_display_info (struct ns_display_info *dpyinfo)
3811 /* --------------------------------------------------------------------------
3812       Initialize global info and storage for display.
3813    -------------------------------------------------------------------------- */
3815     NSScreen *screen = [NSScreen mainScreen];
3816     NSWindowDepth depth = [screen depth];
3817     Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
3819     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
3820     dpyinfo->resy = 72.27;
3821     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
3822                                                   NSColorSpaceFromDepth (depth)]
3823                 && ![NSCalibratedWhiteColorSpace isEqualToString:
3824                                                  NSColorSpaceFromDepth (depth)];
3825     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
3826     dpyinfo->image_cache = make_image_cache ();
3827     dpyinfo->color_table = xmalloc (sizeof *dpyinfo->color_table);
3828     dpyinfo->color_table->colors = NULL;
3829     dpyinfo->root_window = 42; /* a placeholder.. */
3831     hlinfo->mouse_face_mouse_frame = NULL;
3832     hlinfo->mouse_face_deferred_gc = 0;
3833     hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
3834     hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
3835     hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
3836     hlinfo->mouse_face_window = hlinfo->mouse_face_overlay = Qnil;
3837     hlinfo->mouse_face_hidden = 0;
3839     hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
3840     hlinfo->mouse_face_defer = 0;
3842     dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame = NULL;
3844     dpyinfo->n_fonts = 0;
3845     dpyinfo->smallest_font_height = 1;
3846     dpyinfo->smallest_char_width = 1;
3850 /* This and next define (many of the) public functions in this file. */
3851 /* x_... are generic versions in xdisp.c that we, and other terms, get away
3852          with using despite presence in the "system dependent" redisplay
3853          interface.  In addition, many of the ns_ methods have code that is
3854          shared with all terms, indicating need for further refactoring. */
3855 extern frame_parm_handler ns_frame_parm_handlers[];
3856 static struct redisplay_interface ns_redisplay_interface =
3858   ns_frame_parm_handlers,
3859   x_produce_glyphs,
3860   x_write_glyphs,
3861   x_insert_glyphs,
3862   x_clear_end_of_line,
3863   ns_scroll_run,
3864   ns_after_update_window_line,
3865   ns_update_window_begin,
3866   ns_update_window_end,
3867   x_cursor_to,
3868   ns_flush,
3869   0, /* flush_display_optional */
3870   x_clear_window_mouse_face,
3871   x_get_glyph_overhangs,
3872   x_fix_overlapping_area,
3873   ns_draw_fringe_bitmap,
3874   0, /* define_fringe_bitmap */ /* FIXME: simplify ns_draw_fringe_bitmap */
3875   0, /* destroy_fringe_bitmap */
3876   ns_compute_glyph_string_overhangs,
3877   ns_draw_glyph_string, /* interface to nsfont.m */
3878   ns_define_frame_cursor,
3879   ns_clear_frame_area,
3880   ns_draw_window_cursor,
3881   ns_draw_vertical_window_border,
3882   ns_shift_glyphs_for_insert
3886 static void
3887 ns_delete_display (struct ns_display_info *dpyinfo)
3889   /* TODO... */
3893 /* This function is called when the last frame on a display is deleted. */
3894 static void
3895 ns_delete_terminal (struct terminal *terminal)
3897   struct ns_display_info *dpyinfo = terminal->display_info.ns;
3899   /* Protect against recursive calls.  delete_frame in
3900      delete_terminal calls us back when it deletes our last frame.  */
3901   if (!terminal->name)
3902     return;
3904   BLOCK_INPUT;
3906   x_destroy_all_bitmaps (dpyinfo);
3907   ns_delete_display (dpyinfo);
3908   UNBLOCK_INPUT;
3912 static struct terminal *
3913 ns_create_terminal (struct ns_display_info *dpyinfo)
3914 /* --------------------------------------------------------------------------
3915       Set up use of NS before we make the first connection.
3916    -------------------------------------------------------------------------- */
3918   struct terminal *terminal;
3920   NSTRACE (ns_create_terminal);
3922   terminal = create_terminal ();
3924   terminal->type = output_ns;
3925   terminal->display_info.ns = dpyinfo;
3926   dpyinfo->terminal = terminal;
3928   terminal->rif = &ns_redisplay_interface;
3930   terminal->clear_frame_hook = ns_clear_frame;
3931   terminal->ins_del_lines_hook = 0; /* XXX vestigial? */
3932   terminal->delete_glyphs_hook = 0; /* XXX vestigial? */
3933   terminal->ring_bell_hook = ns_ring_bell;
3934   terminal->reset_terminal_modes_hook = ns_reset_terminal_modes;
3935   terminal->set_terminal_modes_hook = ns_set_terminal_modes;
3936   terminal->update_begin_hook = ns_update_begin;
3937   terminal->update_end_hook = ns_update_end;
3938   terminal->set_terminal_window_hook = NULL; /* XXX vestigial? */
3939   terminal->read_socket_hook = ns_read_socket;
3940   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
3941   terminal->mouse_position_hook = ns_mouse_position;
3942   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
3943   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
3945   terminal->fullscreen_hook = 0; /* see XTfullscreen_hook */
3947   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
3948   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
3949   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
3950   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
3952   terminal->delete_frame_hook = x_destroy_window;
3953   terminal->delete_terminal_hook = ns_delete_terminal;
3955   terminal->scroll_region_ok = 1;
3956   terminal->char_ins_del_ok = 1;
3957   terminal->line_ins_del_ok = 1;
3958   terminal->fast_clear_end_of_line = 1;
3959   terminal->memory_below_frame = 0;
3961   return terminal;
3965 struct ns_display_info *
3966 ns_term_init (Lisp_Object display_name)
3967 /* --------------------------------------------------------------------------
3968      Start the Application and get things rolling.
3969    -------------------------------------------------------------------------- */
3971   struct terminal *terminal;
3972   struct ns_display_info *dpyinfo;
3973   static int ns_initialized = 0;
3974   Lisp_Object tmp;
3976   if (ns_initialized) return x_display_list;
3977   ns_initialized = 1;
3979   NSTRACE (ns_term_init);
3981   [outerpool release];
3982   outerpool = [[NSAutoreleasePool alloc] init];
3984   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
3985   /*GSDebugAllocationActive (YES); */
3986   BLOCK_INPUT;
3988   baud_rate = 38400;
3989   Fset_input_interrupt_mode (Qnil);
3991   if (selfds[0] == -1)
3992     {
3993       if (pipe (selfds) == -1)
3994         {
3995           fprintf (stderr, "Failed to create pipe: %s\n",
3996                    emacs_strerror (errno));
3997           emacs_abort ();
3998         }
4000       fcntl (selfds[0], F_SETFL, O_NONBLOCK|fcntl (selfds[0], F_GETFL));
4001       FD_ZERO (&select_readfds);
4002       FD_ZERO (&select_writefds);
4003       pthread_mutex_init (&select_mutex, NULL);
4004     }
4006   ns_pending_files = [[NSMutableArray alloc] init];
4007   ns_pending_service_names = [[NSMutableArray alloc] init];
4008   ns_pending_service_args = [[NSMutableArray alloc] init];
4010 /* Start app and create the main menu, window, view.
4011      Needs to be here because ns_initialize_display_info () uses AppKit classes.
4012      The view will then ask the NSApp to stop and return to Emacs. */
4013   [EmacsApp sharedApplication];
4014   if (NSApp == nil)
4015     return NULL;
4016   [NSApp setDelegate: NSApp];
4018   /* Start the select thread.  */
4019   [NSThread detachNewThreadSelector:@selector (fd_handler:)
4020                            toTarget:NSApp
4021                          withObject:nil];
4023   /* debugging: log all notifications */
4024   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
4025                                          selector: @selector (logNotification:)
4026                                              name: nil object: nil]; */
4028   dpyinfo = xzalloc (sizeof *dpyinfo);
4030   ns_initialize_display_info (dpyinfo);
4031   terminal = ns_create_terminal (dpyinfo);
4033   terminal->kboard = xmalloc (sizeof *terminal->kboard);
4034   init_kboard (terminal->kboard);
4035   kset_window_system (terminal->kboard, Qns);
4036   terminal->kboard->next_kboard = all_kboards;
4037   all_kboards = terminal->kboard;
4038   /* Don't let the initial kboard remain current longer than necessary.
4039      That would cause problems if a file loaded on startup tries to
4040      prompt in the mini-buffer.  */
4041   if (current_kboard == initial_kboard)
4042     current_kboard = terminal->kboard;
4043   terminal->kboard->reference_count++;
4045   dpyinfo->next = x_display_list;
4046   x_display_list = dpyinfo;
4048   /* Put it on ns_display_name_list */
4049   ns_display_name_list = Fcons (Fcons (display_name, Qnil),
4050                                 ns_display_name_list);
4051   dpyinfo->name_list_element = XCAR (ns_display_name_list);
4053   terminal->name = xstrdup (SSDATA (display_name));
4055   UNBLOCK_INPUT;
4057   if (!inhibit_x_resources)
4058     {
4059       ns_default ("GSFontAntiAlias", &ns_antialias_text,
4060                  Qt, Qnil, NO, NO);
4061       tmp = Qnil;
4062       /* this is a standard variable */
4063       ns_default ("AppleAntiAliasingThreshold", &tmp,
4064                  make_float (10.0), make_float (6.0), YES, NO);
4065       ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
4066     }
4068   ns_selection_color = [[NSUserDefaults standardUserDefaults]
4069                          stringForKey: @"AppleHighlightColor"];
4070   if (ns_selection_color == nil)
4071     ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
4073   {
4074     NSColorList *cl = [NSColorList colorListNamed: @"Emacs"];
4076     if ( cl == nil )
4077       {
4078         Lisp_Object color_file, color_map, color;
4079         unsigned long c;
4080         char *name;
4082         color_file = Fexpand_file_name (build_string ("rgb.txt"),
4083                          Fsymbol_value (intern ("data-directory")));
4084         if (NILP (Ffile_readable_p (color_file)))
4085           fatal ("Could not find %s.\n", SDATA (color_file));
4087         color_map = Fx_load_color_file (color_file);
4088         if (NILP (color_map))
4089           fatal ("Could not read %s.\n", SDATA (color_file));
4091         cl = [[NSColorList alloc] initWithName: @"Emacs"];
4092         for ( ; CONSP (color_map); color_map = XCDR (color_map))
4093           {
4094             color = XCAR (color_map);
4095             name = SSDATA (XCAR (color));
4096             c = XINT (XCDR (color));
4097             [cl setColor:
4098                   [NSColor colorWithCalibratedRed: RED_FROM_ULONG (c) / 255.0
4099                                             green: GREEN_FROM_ULONG (c) / 255.0
4100                                              blue: BLUE_FROM_ULONG (c) / 255.0
4101                                             alpha: 1.0]
4102                   forKey: [NSString stringWithUTF8String: name]];
4103           }
4104         [cl writeToFile: nil];
4105       }
4106   }
4108   {
4109 #ifdef NS_IMPL_GNUSTEP
4110     Vwindow_system_version = build_string (gnustep_base_version);
4111 #else
4112     /*PSnextrelease (128, c); */
4113     char c[DBL_BUFSIZE_BOUND];
4114     int len = dtoastr (c, sizeof c, 0, 0, NSAppKitVersionNumber);
4115     Vwindow_system_version = make_unibyte_string (c, len);
4116 #endif
4117   }
4119   delete_keyboard_wait_descriptor (0);
4121   ns_app_name = [[NSProcessInfo processInfo] processName];
4123 /* Set up OS X app menu */
4124 #ifdef NS_IMPL_COCOA
4125   {
4126     NSMenu *appMenu;
4127     NSMenuItem *item;
4128     /* set up the application menu */
4129     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
4130     [svcsMenu setAutoenablesItems: NO];
4131     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
4132     [appMenu setAutoenablesItems: NO];
4133     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
4134     dockMenu = [[EmacsMenu alloc] initWithTitle: @""];
4136     [appMenu insertItemWithTitle: @"About Emacs"
4137                           action: @selector (orderFrontStandardAboutPanel:)
4138                    keyEquivalent: @""
4139                          atIndex: 0];
4140     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
4141     [appMenu insertItemWithTitle: @"Preferences..."
4142                           action: @selector (showPreferencesWindow:)
4143                    keyEquivalent: @","
4144                          atIndex: 2];
4145     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
4146     item = [appMenu insertItemWithTitle: @"Services"
4147                                  action: @selector (menuDown:)
4148                           keyEquivalent: @""
4149                                 atIndex: 4];
4150     [appMenu setSubmenu: svcsMenu forItem: item];
4151     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
4152     [appMenu insertItemWithTitle: @"Hide Emacs"
4153                           action: @selector (hide:)
4154                    keyEquivalent: @"h"
4155                          atIndex: 6];
4156     item =  [appMenu insertItemWithTitle: @"Hide Others"
4157                           action: @selector (hideOtherApplications:)
4158                    keyEquivalent: @"h"
4159                          atIndex: 7];
4160     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
4161     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
4162     [appMenu insertItemWithTitle: @"Quit Emacs"
4163                           action: @selector (terminate:)
4164                    keyEquivalent: @"q"
4165                          atIndex: 9];
4167     item = [mainMenu insertItemWithTitle: ns_app_name
4168                                   action: @selector (menuDown:)
4169                            keyEquivalent: @""
4170                                  atIndex: 0];
4171     [mainMenu setSubmenu: appMenu forItem: item];
4172     [dockMenu insertItemWithTitle: @"New Frame"
4173                            action: @selector (newFrame:)
4174                     keyEquivalent: @""
4175                           atIndex: 0];
4177     [NSApp setMainMenu: mainMenu];
4178     [NSApp setAppleMenu: appMenu];
4179     [NSApp setServicesMenu: svcsMenu];
4180     /* Needed at least on Cocoa, to get dock menu to show windows */
4181     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
4183     [[NSNotificationCenter defaultCenter]
4184       addObserver: mainMenu
4185          selector: @selector (trackingNotification:)
4186              name: NSMenuDidBeginTrackingNotification object: mainMenu];
4187     [[NSNotificationCenter defaultCenter]
4188       addObserver: mainMenu
4189          selector: @selector (trackingNotification:)
4190              name: NSMenuDidEndTrackingNotification object: mainMenu];
4191   }
4192 #endif /* MAC OS X menu setup */
4194   /* Register our external input/output types, used for determining
4195      applicable services and also drag/drop eligibility. */
4196   ns_send_types = [[NSArray arrayWithObjects: NSStringPboardType, nil] retain];
4197   ns_return_types = [[NSArray arrayWithObjects: NSStringPboardType, nil]
4198                       retain];
4199   ns_drag_types = [[NSArray arrayWithObjects:
4200                             NSStringPboardType,
4201                             NSTabularTextPboardType,
4202                             NSFilenamesPboardType,
4203                             NSURLPboardType,
4204                             NSColorPboardType,
4205                             NSFontPboardType, nil] retain];
4207   
4208   [NSApp run];
4209   ns_do_open_file = YES;
4210   return dpyinfo;
4214 void
4215 ns_term_shutdown (int sig)
4217   [[NSUserDefaults standardUserDefaults] synchronize];
4219   /* code not reached in emacs.c after this is called by shut_down_emacs: */
4220   if (STRINGP (Vauto_save_list_file_name))
4221     unlink (SSDATA (Vauto_save_list_file_name));
4223   if (sig == 0 || sig == SIGTERM)
4224     {
4225       [NSApp terminate: NSApp];
4226     }
4227   else // force a stack trace to happen
4228     {
4229       emacs_abort ();
4230     }
4234 /* ==========================================================================
4236     EmacsApp implementation
4238    ========================================================================== */
4241 @implementation EmacsApp
4243 - (void)logNotification: (NSNotification *)notification
4245   const char *name = [[notification name] UTF8String];
4246   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4247       && !strstr (name, "WindowNumber"))
4248     NSLog (@"notification: '%@'", [notification name]);
4252 - (void)sendEvent: (NSEvent *)theEvent
4253 /* --------------------------------------------------------------------------
4254      Called when NSApp is running for each event received.  Used to stop
4255      the loop when we choose, since there's no way to just run one iteration.
4256    -------------------------------------------------------------------------- */
4258   int type = [theEvent type];
4259   NSWindow *window = [theEvent window];
4260 /*  NSTRACE (sendEvent); */
4261 /*fprintf (stderr, "received event of type %d\t%d\n", type);*/
4263 #ifdef NS_IMPL_COCOA
4264   if (type == NSApplicationDefined
4265       && [theEvent data2] == NSAPP_DATA2_RUNASSCRIPT)
4266     {
4267       ns_run_ascript ();
4268       [self stop: self];
4269       return;
4270     }
4271 #endif
4273   if (type == NSCursorUpdate && window == nil)
4274     {
4275       fprintf (stderr, "Dropping external cursor update event.\n");
4276       return;
4277     }
4279 #ifdef NS_IMPL_COCOA
4280   /* pass mouse down in resize handle and subsequent drags directly to
4281      EmacsWindow so we can generate continuous redisplays */
4282   if (ns_in_resize)
4283     {
4284       if (type == NSLeftMouseDragged)
4285         {
4286           [window mouseDragged: theEvent];
4287           return;
4288         }
4289       else if (type == NSLeftMouseUp)
4290         {
4291           [window mouseUp: theEvent];
4292           return;
4293         }
4294     }
4295   else if (type == NSLeftMouseDown)
4296     {
4297       NSRect r = ns_resize_handle_rect (window);
4298       if (NSPointInRect ([theEvent locationInWindow], r))
4299         {
4300           ns_in_resize = YES;
4301           [window mouseDown: theEvent];
4302           return;
4303         }
4304     }
4305 #endif
4307   if (type == NSApplicationDefined)
4308     {
4309       /* Events posted by ns_send_appdefined interrupt the run loop here.
4310          But, if a modal window is up, an appdefined can still come through,
4311          (e.g., from a makeKeyWindow event) but stopping self also stops the
4312          modal loop. Just defer it until later. */
4313       if ([NSApp modalWindow] == nil)
4314         {
4315           last_appdefined_event = theEvent;
4316           [self stop: self];
4317         }
4318       else
4319         {
4320           send_appdefined = YES;
4321         }
4322     }
4324   [super sendEvent: theEvent];
4328 - (void)showPreferencesWindow: (id)sender
4330   struct frame *emacsframe = SELECTED_FRAME ();
4331   NSEvent *theEvent = [NSApp currentEvent];
4333   if (!emacs_event)
4334     return;
4335   emacs_event->kind = NS_NONKEY_EVENT;
4336   emacs_event->code = KEY_NS_SHOW_PREFS;
4337   emacs_event->modifiers = 0;
4338   EV_TRAILER (theEvent);
4342 - (void)newFrame: (id)sender
4344   struct frame *emacsframe = SELECTED_FRAME ();
4345   NSEvent *theEvent = [NSApp currentEvent];
4347   if (!emacs_event)
4348     return;
4349   emacs_event->kind = NS_NONKEY_EVENT;
4350   emacs_event->code = KEY_NS_NEW_FRAME;
4351   emacs_event->modifiers = 0;
4352   EV_TRAILER (theEvent);
4356 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4357 - (BOOL) openFile: (NSString *)fileName
4359   struct frame *emacsframe = SELECTED_FRAME ();
4360   NSEvent *theEvent = [NSApp currentEvent];
4362   if (!emacs_event)
4363     return NO;
4365   emacs_event->kind = NS_NONKEY_EVENT;
4366   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4367   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4368   ns_input_line = Qnil; /* can be start or cons start,end */
4369   emacs_event->modifiers =0;
4370   EV_TRAILER (theEvent);
4372   return YES;
4376 /* **************************************************************************
4378       EmacsApp delegate implementation
4380    ************************************************************************** */
4382 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4383 /* --------------------------------------------------------------------------
4384      When application is loaded, terminate event loop in ns_term_init
4385    -------------------------------------------------------------------------- */
4387   NSTRACE (applicationDidFinishLaunching);
4388   [NSApp setServicesProvider: NSApp];
4389   ns_send_appdefined (-2);
4393 /* Termination sequences:
4394     C-x C-c:
4395     Cmd-Q:
4396     MenuBar | File | Exit:
4397     Select Quit from App menubar:
4398         -terminate
4399         KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4400         ns_term_shutdown()
4402     Select Quit from Dock menu:
4403     Logout attempt:
4404         -appShouldTerminate
4405           Cancel -> Nothing else
4406           Accept ->
4408           -terminate
4409           KEY_NS_POWER_OFF, (save-buffers-kill-emacs)
4410           ns_term_shutdown()
4414 - (void) terminate: (id)sender
4416   struct frame *emacsframe = SELECTED_FRAME ();
4418   if (!emacs_event)
4419     return;
4421   emacs_event->kind = NS_NONKEY_EVENT;
4422   emacs_event->code = KEY_NS_POWER_OFF;
4423   emacs_event->arg = Qt; /* mark as non-key event */
4424   EV_TRAILER ((id)nil);
4428 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4430   int ret;
4432   if (NILP (ns_confirm_quit)) //   || ns_shutdown_properly  --> TO DO
4433     return NSTerminateNow;
4435     ret = NSRunAlertPanel(ns_app_name,
4436                           @"Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?",
4437                           @"Save Buffers and Exit", @"Cancel", nil);
4439     if (ret == NSAlertDefaultReturn)
4440         return NSTerminateNow;
4441     else if (ret == NSAlertAlternateReturn)
4442         return NSTerminateCancel;
4443     return NSTerminateNow;  /* just in case */
4446 static int
4447 not_in_argv (NSString *arg)
4449   int k;
4450   const char *a = [arg UTF8String];
4451   for (k = 1; k < initial_argc; ++k)
4452     if (strcmp (a, initial_argv[k]) == 0) return 0;
4453   return 1;
4456 /*   Notification from the Workspace to open a file */
4457 - (BOOL)application: sender openFile: (NSString *)file
4459   if (ns_do_open_file || not_in_argv (file))
4460     [ns_pending_files addObject: file];
4461   return YES;
4465 /*   Open a file as a temporary file */
4466 - (BOOL)application: sender openTempFile: (NSString *)file
4468   if (ns_do_open_file || not_in_argv (file))
4469     [ns_pending_files addObject: file];
4470   return YES;
4474 /*   Notification from the Workspace to open a file noninteractively (?) */
4475 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4477   if (ns_do_open_file || not_in_argv (file))
4478     [ns_pending_files addObject: file];
4479   return YES;
4482 /*   Notification from the Workspace to open multiple files */
4483 - (void)application: sender openFiles: (NSArray *)fileList
4485   NSEnumerator *files = [fileList objectEnumerator];
4486   NSString *file;
4487   /* Don't open files from the command line unconditionally,
4488      Cocoa parses the command line wrong, --option value tries to open value
4489      if --option is the last option.  */
4490   while ((file = [files nextObject]) != nil)
4491     if (ns_do_open_file || not_in_argv (file))
4492       [ns_pending_files addObject: file];
4494   [self replyToOpenOrPrint: NSApplicationDelegateReplySuccess];
4499 /* Handle dock menu requests.  */
4500 - (NSMenu *)applicationDockMenu: (NSApplication *) sender
4502   return dockMenu;
4506 /* TODO: these may help w/IO switching btwn terminal and NSApp */
4507 - (void)applicationWillBecomeActive: (NSNotification *)notification
4509   //ns_app_active=YES;
4511 - (void)applicationDidBecomeActive: (NSNotification *)notification
4513   NSTRACE (applicationDidBecomeActive);
4515   //ns_app_active=YES;
4517   ns_update_auto_hide_menu_bar ();
4518   // No constraining takes place when the application is not active.
4519   ns_constrain_all_frames ();
4521 - (void)applicationDidResignActive: (NSNotification *)notification
4523   //ns_app_active=NO;
4524   ns_send_appdefined (-1);
4529 /* ==========================================================================
4531     EmacsApp aux handlers for managing event loop
4533    ========================================================================== */
4536 - (void)timeout_handler: (NSTimer *)timedEntry
4537 /* --------------------------------------------------------------------------
4538      The timeout specified to ns_select has passed.
4539    -------------------------------------------------------------------------- */
4541   /*NSTRACE (timeout_handler); */
4542   ns_send_appdefined (-2);
4545 - (void)fd_handler:(id)unused
4546 /* --------------------------------------------------------------------------
4547      Check data waiting on file descriptors and terminate if so
4548    -------------------------------------------------------------------------- */
4550   int result;
4551   int waiting = 1, nfds;
4552   char c;
4554   SELECT_TYPE readfds, writefds, *wfds;
4555   EMACS_TIME timeout, *tmo;
4556   NSAutoreleasePool *pool = nil;
4558   /* NSTRACE (fd_handler); */
4560   for (;;)
4561     {
4562       [pool release];
4563       pool = [[NSAutoreleasePool alloc] init];
4565       if (waiting)
4566         {
4567           SELECT_TYPE fds;
4569           FD_SET (selfds[0], &fds);
4570           result = select (selfds[0]+1, &fds, NULL, NULL, NULL);
4571           if (result > 0)
4572             {
4573               read (selfds[0], &c, 1);
4574               if (c == 'g') waiting = 0;
4575             }
4576         }
4577       else
4578         {
4579           pthread_mutex_lock (&select_mutex);
4580           nfds = select_nfds;
4582           if (select_valid & SELECT_HAVE_READ)
4583             readfds = select_readfds;
4584           else
4585             FD_ZERO (&readfds);
4587           if (select_valid & SELECT_HAVE_WRITE)
4588             {
4589               writefds = select_writefds;
4590               wfds = &writefds;
4591             }
4592           else
4593             wfds = NULL;
4594           if (select_valid & SELECT_HAVE_TMO)
4595             {
4596               timeout = select_timeout;
4597               tmo = &timeout;
4598             }
4599           else
4600             tmo = NULL;
4602           pthread_mutex_unlock (&select_mutex);
4604           FD_SET (selfds[0], &readfds);
4605           if (selfds[0] >= nfds) nfds = selfds[0]+1;
4607           result = pselect (nfds, &readfds, wfds, NULL, tmo, NULL);
4609           if (result == 0)
4610             ns_send_appdefined (-2);
4611           else if (result > 0)
4612             {
4613               if (FD_ISSET (selfds[0], &readfds))
4614                 {
4615                   read (selfds[0], &c, 1);
4616                   if (c == 's') waiting = 1;
4617                 }
4618               else
4619                 {
4620                   pthread_mutex_lock (&select_mutex);
4621                   if (select_valid & SELECT_HAVE_READ)
4622                     select_readfds = readfds;
4623                   if (select_valid & SELECT_HAVE_WRITE)
4624                     select_writefds = writefds;
4625                   if (select_valid & SELECT_HAVE_TMO)
4626                     select_timeout = timeout;
4627                   pthread_mutex_unlock (&select_mutex);
4629                   ns_send_appdefined (result);
4630                 }
4631             }
4632           waiting = 1;
4633         }
4634     }
4639 /* ==========================================================================
4641     Service provision
4643    ========================================================================== */
4645 /* called from system: queue for next pass through event loop */
4646 - (void)requestService: (NSPasteboard *)pboard
4647               userData: (NSString *)userData
4648                  error: (NSString **)error
4650   [ns_pending_service_names addObject: userData];
4651   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4652       SSDATA (ns_string_from_pasteboard (pboard))]];
4656 /* called from ns_read_socket to clear queue */
4657 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4659   struct frame *emacsframe = SELECTED_FRAME ();
4660   NSEvent *theEvent = [NSApp currentEvent];
4662   if (!emacs_event)
4663     return NO;
4665   emacs_event->kind = NS_NONKEY_EVENT;
4666   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
4667   ns_input_spi_name = build_string ([name UTF8String]);
4668   ns_input_spi_arg = build_string ([arg UTF8String]);
4669   emacs_event->modifiers = EV_MODIFIERS (theEvent);
4670   EV_TRAILER (theEvent);
4672   return YES;
4676 @end  /* EmacsApp */
4680 /* ==========================================================================
4682     EmacsView implementation
4684    ========================================================================== */
4687 @implementation EmacsView
4689 /* needed to inform when window closed from LISP */
4690 - (void) setWindowClosing: (BOOL)closing
4692   windowClosing = closing;
4696 - (void)dealloc
4698   NSTRACE (EmacsView_dealloc);
4699   [toolbar release];
4700   [super dealloc];
4704 /* called on font panel selection */
4705 - (void)changeFont: (id)sender
4707   NSEvent *e =[[self window] currentEvent];
4708   struct face *face =FRAME_DEFAULT_FACE (emacsframe);
4709   id newFont;
4710   float size;
4712   NSTRACE (changeFont);
4713   if (!emacs_event)
4714     return;
4716   if ((newFont = [sender convertFont:
4717                            ((struct nsfont_info *)face->font)->nsfont]))
4718     {
4719       SET_FRAME_GARBAGED (emacsframe); /* now needed as of 2008/10 */
4721       emacs_event->kind = NS_NONKEY_EVENT;
4722       emacs_event->modifiers = 0;
4723       emacs_event->code = KEY_NS_CHANGE_FONT;
4725       size = [newFont pointSize];
4726       ns_input_fontsize = make_number (lrint (size));
4727       ns_input_font = build_string ([[newFont familyName] UTF8String]);
4728       EV_TRAILER (e);
4729     }
4733 - (BOOL)acceptsFirstResponder
4735   NSTRACE (acceptsFirstResponder);
4736   return YES;
4740 - (void)resetCursorRects
4742   NSRect visible = [self visibleRect];
4743   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
4744   NSTRACE (resetCursorRects);
4746   if (currentCursor == nil)
4747     currentCursor = [NSCursor arrowCursor];
4749   if (!NSIsEmptyRect (visible))
4750     [self addCursorRect: visible cursor: currentCursor];
4751   [currentCursor setOnMouseEntered: YES];
4756 /*****************************************************************************/
4757 /* Keyboard handling. */
4758 #define NS_KEYLOG 0
4760 - (void)keyDown: (NSEvent *)theEvent
4762   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
4763   int code;
4764   unsigned fnKeysym = 0;
4765   int flags;
4766   static NSMutableArray *nsEvArray;
4767 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
4768   static BOOL firstTime = YES;
4769 #endif
4770   int left_is_none;
4772   NSTRACE (keyDown);
4774   /* Rhapsody and OS X give up and down events for the arrow keys */
4775   if (ns_fake_keydown == YES)
4776     ns_fake_keydown = NO;
4777   else if ([theEvent type] != NSKeyDown)
4778     return;
4780   if (!emacs_event)
4781     return;
4783  if (![[self window] isKeyWindow]
4784      && [[theEvent window] isKindOfClass: [EmacsWindow class]]
4785      /* we must avoid an infinite loop here. */
4786      && (EmacsView *)[[theEvent window] delegate] != self)
4787    {
4788      /* XXX: There is an occasional condition in which, when Emacs display
4789          updates a different frame from the current one, and temporarily
4790          selects it, then processes some interrupt-driven input
4791          (dispnew.c:3878), OS will send the event to the correct NSWindow, but
4792          for some reason that window has its first responder set to the NSView
4793          most recently updated (I guess), which is not the correct one. */
4794      [(EmacsView *)[[theEvent window] delegate] keyDown: theEvent];
4795      return;
4796    }
4798   if (nsEvArray == nil)
4799     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
4801   [NSCursor setHiddenUntilMouseMoves: YES];
4803   if (hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
4804     {
4805       clear_mouse_face (hlinfo);
4806       hlinfo->mouse_face_hidden = 1;
4807     }
4809   if (!processingCompose)
4810     {
4811       /* When using screen sharing, no left or right information is sent,
4812          so use Left key in those cases.  */
4813       int is_left_key, is_right_key;
4815       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
4816         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
4818       /* (Carbon way: [theEvent keyCode]) */
4820       /* is it a "function key"? */
4821       fnKeysym = ns_convert_key (code);
4822       if (fnKeysym)
4823         {
4824           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
4825              because Emacs treats Delete and KP-Delete same (in simple.el). */
4826           if (fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
4827             code = 0xFF08; /* backspace */
4828           else
4829             code = fnKeysym;
4830         }
4832       /* are there modifiers? */
4833       emacs_event->modifiers = 0;
4834       flags = [theEvent modifierFlags];
4836       if (flags & NSHelpKeyMask)
4837           emacs_event->modifiers |= hyper_modifier;
4839       if (flags & NSShiftKeyMask)
4840         emacs_event->modifiers |= shift_modifier;
4842       is_right_key = (flags & NSRightCommandKeyMask) == NSRightCommandKeyMask;
4843       is_left_key = (flags & NSLeftCommandKeyMask) == NSLeftCommandKeyMask
4844         || (! is_right_key && (flags & NSCommandKeyMask) == NSCommandKeyMask);
4846       if (is_right_key)
4847         emacs_event->modifiers |= parse_solitary_modifier
4848           (EQ (ns_right_command_modifier, Qleft)
4849            ? ns_command_modifier
4850            : ns_right_command_modifier);
4852       if (is_left_key)
4853         {
4854           emacs_event->modifiers |= parse_solitary_modifier
4855             (ns_command_modifier);
4857           /* if super (default), take input manager's word so things like
4858              dvorak / qwerty layout work */
4859           if (EQ (ns_command_modifier, Qsuper)
4860               && !fnKeysym
4861               && [[theEvent characters] length] != 0)
4862             {
4863               /* XXX: the code we get will be unshifted, so if we have
4864                  a shift modifier, must convert ourselves */
4865               if (!(flags & NSShiftKeyMask))
4866                 code = [[theEvent characters] characterAtIndex: 0];
4867 #if 0
4868               /* this is ugly and also requires linking w/Carbon framework
4869                  (for LMGetKbdType) so for now leave this rare (?) case
4870                  undealt with.. in future look into CGEvent methods */
4871               else
4872                 {
4873                   long smv = GetScriptManagerVariable (smKeyScript);
4874                   Handle uchrHandle = GetResource
4875                     ('uchr', GetScriptVariable (smv, smScriptKeys));
4876                   UInt32 dummy = 0;
4877                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
4878                                  [[theEvent characters] characterAtIndex: 0],
4879                                  kUCKeyActionDisplay,
4880                                  (flags & ~NSCommandKeyMask) >> 8,
4881                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
4882                                  &dummy, 1, &dummy, &code);
4883                   code &= 0xFF;
4884                 }
4885 #endif
4886             }
4887         }
4889       is_right_key = (flags & NSRightControlKeyMask) == NSRightControlKeyMask;
4890       is_left_key = (flags & NSLeftControlKeyMask) == NSLeftControlKeyMask
4891         || (! is_right_key && (flags & NSControlKeyMask) == NSControlKeyMask);
4893       if (is_right_key)
4894           emacs_event->modifiers |= parse_solitary_modifier
4895               (EQ (ns_right_control_modifier, Qleft)
4896                ? ns_control_modifier
4897                : ns_right_control_modifier);
4899       if (is_left_key)
4900         emacs_event->modifiers |= parse_solitary_modifier
4901           (ns_control_modifier);
4903       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
4904           emacs_event->modifiers |=
4905             parse_solitary_modifier (ns_function_modifier);
4907       left_is_none = NILP (ns_alternate_modifier)
4908         || EQ (ns_alternate_modifier, Qnone);
4910       is_right_key = (flags & NSRightAlternateKeyMask)
4911         == NSRightAlternateKeyMask;
4912       is_left_key = (flags & NSLeftAlternateKeyMask) == NSLeftAlternateKeyMask
4913         || (! is_right_key
4914             && (flags & NSAlternateKeyMask) == NSAlternateKeyMask);
4916       if (is_right_key)
4917         {
4918           if ((NILP (ns_right_alternate_modifier)
4919                || EQ (ns_right_alternate_modifier, Qnone)
4920                || (EQ (ns_right_alternate_modifier, Qleft) && left_is_none))
4921               && !fnKeysym)
4922             {   /* accept pre-interp alt comb */
4923               if ([[theEvent characters] length] > 0)
4924                 code = [[theEvent characters] characterAtIndex: 0];
4925               /*HACK: clear lone shift modifier to stop next if from firing */
4926               if (emacs_event->modifiers == shift_modifier)
4927                 emacs_event->modifiers = 0;
4928             }
4929           else
4930             emacs_event->modifiers |= parse_solitary_modifier
4931               (EQ (ns_right_alternate_modifier, Qleft)
4932                ? ns_alternate_modifier
4933                : ns_right_alternate_modifier);
4934         }
4936       if (is_left_key) /* default = meta */
4937         {
4938           if (left_is_none && !fnKeysym)
4939             {   /* accept pre-interp alt comb */
4940               if ([[theEvent characters] length] > 0)
4941                 code = [[theEvent characters] characterAtIndex: 0];
4942               /*HACK: clear lone shift modifier to stop next if from firing */
4943               if (emacs_event->modifiers == shift_modifier)
4944                 emacs_event->modifiers = 0;
4945             }
4946           else
4947               emacs_event->modifiers |=
4948                 parse_solitary_modifier (ns_alternate_modifier);
4949         }
4951   if (NS_KEYLOG)
4952     fprintf (stderr, "keyDown: code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",
4953              code, fnKeysym, flags, emacs_event->modifiers);
4955       /* if it was a function key or had modifiers, pass it directly to emacs */
4956       if (fnKeysym || (emacs_event->modifiers
4957                        && (emacs_event->modifiers != shift_modifier)
4958                        && [[theEvent charactersIgnoringModifiers] length] > 0))
4959 /*[[theEvent characters] length] */
4960         {
4961           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4962           if (code < 0x20)
4963             code |= (1<<28)|(3<<16);
4964           else if (code == 0x7f)
4965             code |= (1<<28)|(3<<16);
4966           else if (!fnKeysym)
4967             emacs_event->kind = code > 0xFF
4968               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
4970           emacs_event->code = code;
4971           EV_TRAILER (theEvent);
4972           return;
4973         }
4974     }
4977 #if !defined (NS_IMPL_COCOA) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
4978   /* if we get here we should send the key for input manager processing */
4979   if (firstTime && [[NSInputManager currentInputManager]
4980                      wantsToDelayTextChangeNotifications] == NO)
4981     fprintf (stderr,
4982           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
4983   firstTime = NO;
4984 #endif
4985   if (NS_KEYLOG && !processingCompose)
4986     fprintf (stderr, "keyDown: Begin compose sequence.\n");
4988   processingCompose = YES;
4989   [nsEvArray addObject: theEvent];
4990   [self interpretKeyEvents: nsEvArray];
4991   [nsEvArray removeObject: theEvent];
4995 #ifdef NS_IMPL_COCOA
4996 /* Needed to pick up Ctrl-tab and possibly other events that OS X has
4997    decided not to send key-down for.
4998    See http://osdir.com/ml/editors.vim.mac/2007-10/msg00141.html
4999    This only applies on Tiger and earlier.
5000    If it matches one of these, send it on to keyDown. */
5001 -(void)keyUp: (NSEvent *)theEvent
5003   int flags = [theEvent modifierFlags];
5004   int code = [theEvent keyCode];
5005   if (floor (NSAppKitVersionNumber) <= 824 /*NSAppKitVersionNumber10_4*/ &&
5006       code == 0x30 && (flags & NSControlKeyMask) && !(flags & NSCommandKeyMask))
5007     {
5008       if (NS_KEYLOG)
5009         fprintf (stderr, "keyUp: passed test");
5010       ns_fake_keydown = YES;
5011       [self keyDown: theEvent];
5012     }
5014 #endif
5017 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
5020 /* <NSTextInput>: called when done composing;
5021    NOTE: also called when we delete over working text, followed immed.
5022          by doCommandBySelector: deleteBackward: */
5023 - (void)insertText: (id)aString
5025   int code;
5026   int len = [(NSString *)aString length];
5027   int i;
5029   if (NS_KEYLOG)
5030     NSLog (@"insertText '%@'\tlen = %d", aString, len);
5031   processingCompose = NO;
5033   if (!emacs_event)
5034     return;
5036   /* first, clear any working text */
5037   if (workingText != nil)
5038     [self deleteWorkingText];
5040   /* now insert the string as keystrokes */
5041   for (i =0; i<len; i++)
5042     {
5043       code = [aString characterAtIndex: i];
5044       /* TODO: still need this? */
5045       if (code == 0x2DC)
5046         code = '~'; /* 0x7E */
5047       if (code != 32) /* Space */
5048         emacs_event->modifiers = 0;
5049       emacs_event->kind
5050         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
5051       emacs_event->code = code;
5052       EV_TRAILER ((id)nil);
5053     }
5057 /* <NSTextInput>: inserts display of composing characters */
5058 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
5060   NSString *str = [aString respondsToSelector: @selector (string)] ?
5061     [aString string] : aString;
5062   if (NS_KEYLOG)
5063     NSLog (@"setMarkedText '%@' len =%d range %d from %d", str, [str length],
5064            selRange.length, selRange.location);
5066   if (workingText != nil)
5067     [self deleteWorkingText];
5068   if ([str length] == 0)
5069     return;
5071   if (!emacs_event)
5072     return;
5074   processingCompose = YES;
5075   workingText = [str copy];
5076   ns_working_text = build_string ([workingText UTF8String]);
5078   emacs_event->kind = NS_TEXT_EVENT;
5079   emacs_event->code = KEY_NS_PUT_WORKING_TEXT;
5080   EV_TRAILER ((id)nil);
5084 /* delete display of composing characters [not in <NSTextInput>] */
5085 - (void)deleteWorkingText
5087   if (workingText == nil)
5088     return;
5089   if (NS_KEYLOG)
5090     NSLog(@"deleteWorkingText len =%d\n", [workingText length]);
5091   [workingText release];
5092   workingText = nil;
5093   processingCompose = NO;
5095   if (!emacs_event)
5096     return;
5098   emacs_event->kind = NS_TEXT_EVENT;
5099   emacs_event->code = KEY_NS_UNPUT_WORKING_TEXT;
5100   EV_TRAILER ((id)nil);
5104 - (BOOL)hasMarkedText
5106   return workingText != nil;
5110 - (NSRange)markedRange
5112   NSRange rng = workingText != nil
5113     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
5114   if (NS_KEYLOG)
5115     NSLog (@"markedRange request");
5116   return rng;
5120 - (void)unmarkText
5122   if (NS_KEYLOG)
5123     NSLog (@"unmark (accept) text");
5124   [self deleteWorkingText];
5125   processingCompose = NO;
5129 /* used to position char selection windows, etc. */
5130 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
5132   NSRect rect;
5133   NSPoint pt;
5134   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
5135   if (NS_KEYLOG)
5136     NSLog (@"firstRectForCharRange request");
5138   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
5139   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
5140   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
5141   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
5142                                        +FRAME_LINE_HEIGHT (emacsframe));
5144   pt = [self convertPoint: pt toView: nil];
5145   pt = [[self window] convertBaseToScreen: pt];
5146   rect.origin = pt;
5147   return rect;
5151 - (NSInteger)conversationIdentifier
5153   return (NSInteger)self;
5157 - (void)doCommandBySelector: (SEL)aSelector
5159   if (NS_KEYLOG)
5160     NSLog (@"doCommandBySelector: %@", NSStringFromSelector (aSelector));
5162   if (aSelector == @selector (deleteBackward:))
5163     {
5164       /* happens when user backspaces over an ongoing composition:
5165          throw a 'delete' into the event queue */
5166       if (!emacs_event)
5167         return;
5168       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5169       emacs_event->code = 0xFF08;
5170       EV_TRAILER ((id)nil);
5171     }
5174 - (NSArray *)validAttributesForMarkedText
5176   static NSArray *arr = nil;
5177   if (arr == nil) arr = [NSArray new];
5178  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
5179   return arr;
5182 - (NSRange)selectedRange
5184   if (NS_KEYLOG)
5185     NSLog (@"selectedRange request");
5186   return NSMakeRange (NSNotFound, 0);
5189 - (NSUInteger)characterIndexForPoint: (NSPoint)thePoint
5191   if (NS_KEYLOG)
5192     NSLog (@"characterIndexForPoint request");
5193   return 0;
5196 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
5198   static NSAttributedString *str = nil;
5199   if (str == nil) str = [NSAttributedString new];
5200   if (NS_KEYLOG)
5201     NSLog (@"attributedSubstringFromRange request");
5202   return str;
5205 /* End <NSTextInput> impl. */
5206 /*****************************************************************************/
5209 /* This is what happens when the user presses a mouse button.  */
5210 - (void)mouseDown: (NSEvent *)theEvent
5212   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5214   NSTRACE (mouseDown);
5216   [self deleteWorkingText];
5218   if (!emacs_event)
5219     return;
5221   last_mouse_frame = emacsframe;
5222   /* appears to be needed to prevent spurious movement events generated on
5223      button clicks */
5224   last_mouse_frame->mouse_moved = 0;
5226   if ([theEvent type] == NSScrollWheel)
5227     {
5228       float delta = [theEvent deltaY];
5229       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
5230       if (delta == 0)
5231         return;
5232       emacs_event->kind = WHEEL_EVENT;
5233       emacs_event->code = 0;
5234       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
5235         ((delta > 0) ? up_modifier : down_modifier);
5236     }
5237   else
5238     {
5239       emacs_event->kind = MOUSE_CLICK_EVENT;
5240       emacs_event->code = EV_BUTTON (theEvent);
5241       emacs_event->modifiers = EV_MODIFIERS (theEvent)
5242                              | EV_UDMODIFIERS (theEvent);
5243     }
5244   XSETINT (emacs_event->x, lrint (p.x));
5245   XSETINT (emacs_event->y, lrint (p.y));
5246   EV_TRAILER (theEvent);
5250 - (void)rightMouseDown: (NSEvent *)theEvent
5252   NSTRACE (rightMouseDown);
5253   [self mouseDown: theEvent];
5257 - (void)otherMouseDown: (NSEvent *)theEvent
5259   NSTRACE (otherMouseDown);
5260   [self mouseDown: theEvent];
5264 - (void)mouseUp: (NSEvent *)theEvent
5266   NSTRACE (mouseUp);
5267   [self mouseDown: theEvent];
5271 - (void)rightMouseUp: (NSEvent *)theEvent
5273   NSTRACE (rightMouseUp);
5274   [self mouseDown: theEvent];
5278 - (void)otherMouseUp: (NSEvent *)theEvent
5280   NSTRACE (otherMouseUp);
5281   [self mouseDown: theEvent];
5285 - (void) scrollWheel: (NSEvent *)theEvent
5287   NSTRACE (scrollWheel);
5288   [self mouseDown: theEvent];
5292 /* Tell emacs the mouse has moved. */
5293 - (void)mouseMoved: (NSEvent *)e
5295   Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (emacsframe);
5296   Lisp_Object frame;
5298 //  NSTRACE (mouseMoved);
5300   last_mouse_movement_time = EV_TIMESTAMP (e);
5301   last_mouse_motion_position
5302     = [self convertPoint: [e locationInWindow] fromView: nil];
5304   /* update any mouse face */
5305   if (hlinfo->mouse_face_hidden)
5306     {
5307       hlinfo->mouse_face_hidden = 0;
5308       clear_mouse_face (hlinfo);
5309     }
5311   /* tooltip handling */
5312   previous_help_echo_string = help_echo_string;
5313   help_echo_string = Qnil;
5315   if (!note_mouse_movement (emacsframe, last_mouse_motion_position.x,
5316                             last_mouse_motion_position.y))
5317     help_echo_string = previous_help_echo_string;
5319   XSETFRAME (frame, emacsframe);
5320   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
5321     {
5322       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
5323          (note_mouse_highlight), which is called through the
5324          note_mouse_movement () call above */
5325       gen_help_event (help_echo_string, frame, help_echo_window,
5326                       help_echo_object, help_echo_pos);
5327     }
5328   else
5329     {
5330       help_echo_string = Qnil;
5331       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
5332     }
5334   if (emacsframe->mouse_moved && send_appdefined)
5335     ns_send_appdefined (-1);
5339 - (void)mouseDragged: (NSEvent *)e
5341   NSTRACE (mouseDragged);
5342   [self mouseMoved: e];
5346 - (void)rightMouseDragged: (NSEvent *)e
5348   NSTRACE (rightMouseDragged);
5349   [self mouseMoved: e];
5353 - (void)otherMouseDragged: (NSEvent *)e
5355   NSTRACE (otherMouseDragged);
5356   [self mouseMoved: e];
5360 - (BOOL)windowShouldClose: (id)sender
5362   NSEvent *e =[[self window] currentEvent];
5364   NSTRACE (windowShouldClose);
5365   windowClosing = YES;
5366   if (!emacs_event)
5367     return NO;
5368   emacs_event->kind = DELETE_WINDOW_EVENT;
5369   emacs_event->modifiers = 0;
5370   emacs_event->code = 0;
5371   EV_TRAILER (e);
5372   /* Don't close this window, let this be done from lisp code.  */
5373   return NO;
5376 - (void) updateFrameSize: (BOOL) delay;
5378   NSWindow *window = [self window];
5379   NSRect wr = [window frame];
5380 #ifdef NS_IMPL_GNUSTEP
5381   int extra = 3;
5382 #else
5383   int extra = 0;
5384 #endif
5386   int oldc = cols, oldr = rows;
5387   int oldw = FRAME_PIXEL_WIDTH (emacsframe),
5388     oldh = FRAME_PIXEL_HEIGHT (emacsframe);
5389   int neww, newh;
5391   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe, wr.size.width + extra);
5393   if (cols < MINWIDTH)
5394     cols = MINWIDTH;
5396   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES
5397     (emacsframe, wr.size.height
5398      - FRAME_NS_TITLEBAR_HEIGHT (emacsframe) + extra
5399      - FRAME_TOOLBAR_HEIGHT (emacsframe));
5401   if (rows < MINHEIGHT)
5402     rows = MINHEIGHT;
5404   neww = (int)wr.size.width - emacsframe->border_width;
5405   newh = ((int)wr.size.height
5406           - FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5407           - FRAME_TOOLBAR_HEIGHT (emacsframe));
5409   if (oldr != rows || oldc != cols || neww != oldw || newh != oldh)
5410     {
5411       NSView *view = FRAME_NS_VIEW (emacsframe);
5412       FRAME_PIXEL_WIDTH (emacsframe) = neww;
5413       FRAME_PIXEL_HEIGHT (emacsframe) = newh;
5414       change_frame_size (emacsframe, rows, cols, 0, delay, 0);
5415       SET_FRAME_GARBAGED (emacsframe);
5416       cancel_mouse_face (emacsframe);
5417       [view setFrame: NSMakeRect (0, 0, neww, newh)];
5418     }
5421 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
5422 /* normalize frame to gridded text size */
5424   NSTRACE (windowWillResize);
5425 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5427   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe,
5428 #ifdef NS_IMPL_GNUSTEP
5429                                         frameSize.width + 3);
5430 #else
5431                                         frameSize.width);
5432 #endif
5433   if (cols < MINWIDTH)
5434     cols = MINWIDTH;
5436   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, frameSize.height
5437 #ifdef NS_IMPL_GNUSTEP
5438       - FRAME_NS_TITLEBAR_HEIGHT (emacsframe) + 3
5439         - FRAME_TOOLBAR_HEIGHT (emacsframe));
5440 #else
5441       - FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5442         - FRAME_TOOLBAR_HEIGHT (emacsframe));
5443 #endif
5444   if (rows < MINHEIGHT)
5445     rows = MINHEIGHT;
5446 #ifdef NS_IMPL_COCOA
5447   {
5448     /* this sets window title to have size in it; the wm does this under GS */
5449     NSRect r = [[self window] frame];
5450     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5451       {
5452         if (old_title != 0)
5453           {
5454             xfree (old_title);
5455             old_title = 0;
5456           }
5457       }
5458     else
5459       {
5460         char *size_title;
5461         NSWindow *window = [self window];
5462         if (old_title == 0)
5463           {
5464             const char *t = [[[self window] title] UTF8String];
5465             char *pos = strstr (t, "  â€”  ");
5466             if (pos)
5467               *pos = '\0';
5468             old_title = xstrdup (t);
5469           }
5470         size_title = xmalloc (strlen (old_title) + 40);
5471         esprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5472         [window setTitle: [NSString stringWithUTF8String: size_title]];
5473         [window display];
5474         xfree (size_title);
5475       }
5476   }
5477 #endif /* NS_IMPL_COCOA */
5478 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5480   return frameSize;
5484 - (void)windowDidResize: (NSNotification *)notification
5486 #ifdef NS_IMPL_GNUSTEP
5487   NSWindow *theWindow = [notification object];
5489    /* in GNUstep, at least currently, it's possible to get a didResize
5490       without getting a willResize.. therefore we need to act as if we got
5491       the willResize now */
5492   NSSize sz = [theWindow frame].size;
5493   sz = [self windowWillResize: theWindow toSize: sz];
5494 #endif /* NS_IMPL_GNUSTEP */
5496   NSTRACE (windowDidResize);
5497 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5499 #ifdef NS_IMPL_COCOA
5500   if (old_title != 0)
5501     {
5502       xfree (old_title);
5503       old_title = 0;
5504     }
5505 #endif /* NS_IMPL_COCOA */
5507   /* Avoid loop under GNUstep due to call at beginning of this function.
5508      (x_set_window_size causes a resize which causes
5509      a "windowDidResize" which calls x_set_window_size).  */
5510 #ifndef NS_IMPL_GNUSTEP
5511   if (cols > 0 && rows > 0)
5512     {
5513       if (ns_in_resize)
5514         x_set_window_size (emacsframe, 0, cols, rows);
5515       else
5516         {
5517           [self updateFrameSize: YES];
5518         }
5519     }
5520 #endif
5522   ns_send_appdefined (-1);
5526 - (void)windowDidBecomeKey: (NSNotification *)notification
5527 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5529   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5530   struct frame *old_focus = dpyinfo->x_focus_frame;
5532   NSTRACE (windowDidBecomeKey);
5534   if (emacsframe != old_focus)
5535     dpyinfo->x_focus_frame = emacsframe;
5537   ns_frame_rehighlight (emacsframe);
5539   if (emacs_event)
5540     {
5541       emacs_event->kind = FOCUS_IN_EVENT;
5542       EV_TRAILER ((id)nil);
5543     }
5547 - (void)windowDidResignKey: (NSNotification *)notification
5548 /* cf. x_detect_focus_change(), x_focus_changed(), x_new_focus_frame() */
5550   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5551   NSTRACE (windowDidResignKey);
5553   if (dpyinfo->x_focus_frame == emacsframe)
5554     dpyinfo->x_focus_frame = 0;
5556   ns_frame_rehighlight (emacsframe);
5558   /* FIXME: for some reason needed on second and subsequent clicks away
5559             from sole-frame Emacs to get hollow box to show */
5560   if (!windowClosing && [[self window] isVisible] == YES)
5561     {
5562       x_update_cursor (emacsframe, 1);
5563       x_set_frame_alpha (emacsframe);
5564     }
5566   if (emacs_event)
5567     {
5568       [self deleteWorkingText];
5569       emacs_event->kind = FOCUS_IN_EVENT;
5570       EV_TRAILER ((id)nil);
5571     }
5575 - (void)windowWillMiniaturize: sender
5577   NSTRACE (windowWillMiniaturize);
5581 - (BOOL)isFlipped
5583   return YES;
5587 - (BOOL)isOpaque
5589   return NO;
5593 - initFrameFromEmacs: (struct frame *)f
5595   NSRect r, wr;
5596   Lisp_Object tem;
5597   NSWindow *win;
5598   NSButton *toggleButton;
5599   NSSize sz;
5600   NSColor *col;
5601   NSString *name;
5603   NSTRACE (initFrameFromEmacs);
5605   windowClosing = NO;
5606   processingCompose = NO;
5607   scrollbarsNeedingUpdate = 0;
5609 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
5611   ns_userRect = NSMakeRect (0, 0, 0, 0);
5612   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
5613                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
5614   [self initWithFrame: r];
5615   [self setAutoresizingMask: NSViewWidthSizable | NSViewHeightSizable];
5617   FRAME_NS_VIEW (f) = self;
5618   emacsframe = f;
5619   old_title = 0;
5621   win = [[EmacsWindow alloc]
5622             initWithContentRect: r
5623                       styleMask: (NSResizableWindowMask |
5624 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
5625                                   NSTitledWindowMask |
5626 #endif
5627                                   NSMiniaturizableWindowMask |
5628                                   NSClosableWindowMask)
5629                         backing: NSBackingStoreBuffered
5630                           defer: YES];
5632   wr = [win frame];
5633   f->border_width = wr.size.width - r.size.width;
5634   FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
5636   [win setAcceptsMouseMovedEvents: YES];
5637   [win setDelegate: self];
5638   [win useOptimizedDrawing: YES];
5640   sz.width = FRAME_COLUMN_WIDTH (f);
5641   sz.height = FRAME_LINE_HEIGHT (f);
5642   [win setResizeIncrements: sz];
5644   [[win contentView] addSubview: self];
5646   if (ns_drag_types)
5647     [self registerForDraggedTypes: ns_drag_types];
5649   tem = f->name;
5650   name = [NSString stringWithUTF8String:
5651                    NILP (tem) ? "Emacs" : SSDATA (tem)];
5652   [win setTitle: name];
5654   /* toolbar support */
5655   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
5656                          [NSString stringWithFormat: @"Emacs Frame %d",
5657                                    ns_window_num]];
5658   [win setToolbar: toolbar];
5659   [toolbar setVisible: NO];
5660 #ifdef NS_IMPL_COCOA
5661   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
5662   [toggleButton setTarget: self];
5663   [toggleButton setAction: @selector (toggleToolbar: )];
5664 #endif
5665   FRAME_TOOLBAR_HEIGHT (f) = 0;
5667   tem = f->icon_name;
5668   if (!NILP (tem))
5669     [win setMiniwindowTitle:
5670            [NSString stringWithUTF8String: SSDATA (tem)]];
5672   {
5673     NSScreen *screen = [win screen];
5675     if (screen != 0)
5676       [win setFrameTopLeftPoint: NSMakePoint
5677            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
5678             IN_BOUND (-SCREENMAX,
5679                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
5680   }
5682   [win makeFirstResponder: self];
5684   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
5685                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
5686   [win setBackgroundColor: col];
5687   if ([col alphaComponent] != 1.0)
5688     [win setOpaque: NO];
5690   [self allocateGState];
5692   [NSApp registerServicesMenuSendTypes: ns_send_types
5693                            returnTypes: nil];
5695   ns_window_num++;
5696   return self;
5700 - (void)windowDidMove: sender
5702   NSWindow *win = [self window];
5703   NSRect r = [win frame];
5704   NSArray *screens = [NSScreen screens];
5705   NSScreen *screen = [screens objectAtIndex: 0];
5707   NSTRACE (windowDidMove);
5709   if (!emacsframe->output_data.ns)
5710     return;
5711   if (screen != nil)
5712     {
5713       emacsframe->left_pos = r.origin.x;
5714       emacsframe->top_pos =
5715         [screen frame].size.height - (r.origin.y + r.size.height);
5716     }
5720 /* Called AFTER method below, but before our windowWillResize call there leads
5721    to windowDidResize -> x_set_window_size.  Update emacs' notion of frame
5722    location so set_window_size moves the frame. */
5723 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
5725   emacsframe->output_data.ns->zooming = 1;
5726   return YES;
5730 /* Override to do something slightly nonstandard, but nice.  First click on
5731    zoom button will zoom vertically.  Second will zoom completely.  Third
5732    returns to original. */
5733 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
5734                         defaultFrame:(NSRect)defaultFrame
5736   NSRect result = [sender frame];
5738   NSTRACE (windowWillUseStandardFrame);
5740   if (abs (defaultFrame.size.height - result.size.height)
5741       > FRAME_LINE_HEIGHT (emacsframe))
5742     {
5743       /* first click */
5744       ns_userRect = result;
5745       result.size.height = defaultFrame.size.height;
5746       result.origin.y = defaultFrame.origin.y;
5747     }
5748   else
5749     {
5750       if (abs (defaultFrame.size.width - result.size.width)
5751           > FRAME_COLUMN_WIDTH (emacsframe))
5752         result = defaultFrame;  /* second click */
5753       else
5754         {
5755           /* restore */
5756           result = ns_userRect.size.height ? ns_userRect : result;
5757           ns_userRect = NSMakeRect (0, 0, 0, 0);
5758         }
5759     }
5761   [self windowWillResize: sender toSize: result.size];
5762   return result;
5766 - (void)windowDidDeminiaturize: sender
5768   NSTRACE (windowDidDeminiaturize);
5769   if (!emacsframe->output_data.ns)
5770     return;
5771   emacsframe->async_iconified = 0;
5772   emacsframe->async_visible   = 1;
5773   windows_or_buffers_changed++;
5775   if (emacs_event)
5776     {
5777       emacs_event->kind = ICONIFY_EVENT;
5778       EV_TRAILER ((id)nil);
5779     }
5783 - (void)windowDidExpose: sender
5785   NSTRACE (windowDidExpose);
5786   if (!emacsframe->output_data.ns)
5787     return;
5788   emacsframe->async_visible = 1;
5789   SET_FRAME_GARBAGED (emacsframe);
5791   if (send_appdefined)
5792     ns_send_appdefined (-1);
5796 - (void)windowDidMiniaturize: sender
5798   NSTRACE (windowDidMiniaturize);
5799   if (!emacsframe->output_data.ns)
5800     return;
5802   emacsframe->async_iconified = 1;
5803   emacsframe->async_visible = 0;
5805   if (emacs_event)
5806     {
5807       emacs_event->kind = ICONIFY_EVENT;
5808       EV_TRAILER ((id)nil);
5809     }
5813 - (void)mouseEntered: (NSEvent *)theEvent
5815   NSTRACE (mouseEntered);
5816   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
5820 - (void)mouseExited: (NSEvent *)theEvent
5822   Mouse_HLInfo *hlinfo = emacsframe ? MOUSE_HL_INFO (emacsframe) : NULL;
5824   NSTRACE (mouseExited);
5826   if (!hlinfo)
5827     return;
5829   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
5831   if (emacsframe == hlinfo->mouse_face_mouse_frame)
5832     {
5833       clear_mouse_face (hlinfo);
5834       hlinfo->mouse_face_mouse_frame = 0;
5835     }
5839 - menuDown: sender
5841   NSTRACE (menuDown);
5842   if (context_menu_value == -1)
5843     context_menu_value = [sender tag];
5844   else
5845     {
5846       NSInteger tag = [sender tag];
5847       find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
5848                                     emacsframe->menu_bar_vector,
5849                                     (void *)tag);
5850     }
5852   ns_send_appdefined (-1);
5853   return self;
5857 - (EmacsToolbar *)toolbar
5859   return toolbar;
5863 /* this gets called on toolbar button click */
5864 - toolbarClicked: (id)item
5866   NSEvent *theEvent;
5867   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
5869   NSTRACE (toolbarClicked);
5871   if (!emacs_event)
5872     return self;
5874   /* send first event (for some reason two needed) */
5875   theEvent = [[self window] currentEvent];
5876   emacs_event->kind = TOOL_BAR_EVENT;
5877   XSETFRAME (emacs_event->arg, emacsframe);
5878   EV_TRAILER (theEvent);
5880   emacs_event->kind = TOOL_BAR_EVENT;
5881 /*   XSETINT (emacs_event->code, 0); */
5882   emacs_event->arg = AREF (emacsframe->tool_bar_items,
5883                            idx + TOOL_BAR_ITEM_KEY);
5884   emacs_event->modifiers = EV_MODIFIERS (theEvent);
5885   EV_TRAILER (theEvent);
5886   return self;
5890 - toggleToolbar: (id)sender
5892   if (!emacs_event)
5893     return self;
5895   emacs_event->kind = NS_NONKEY_EVENT;
5896   emacs_event->code = KEY_NS_TOGGLE_TOOLBAR;
5897   EV_TRAILER ((id)nil);
5898   return self;
5902 - (void)drawRect: (NSRect)rect
5904   int x = NSMinX (rect), y = NSMinY (rect);
5905   int width = NSWidth (rect), height = NSHeight (rect);
5907   NSTRACE (drawRect);
5909   if (!emacsframe || !emacsframe->output_data.ns || ns_in_resize)
5910     return;
5912   ns_clear_frame_area (emacsframe, x, y, width, height);
5913   expose_frame (emacsframe, x, y, width, height);
5915   /*
5916     drawRect: may be called (at least in OS X 10.5) for invisible
5917     views as well for some reason.  Thus, do not infer visibility
5918     here.
5920     emacsframe->async_visible = 1;
5921     emacsframe->async_iconified = 0;
5922   */
5926 /* NSDraggingDestination protocol methods.  Actually this is not really a
5927    protocol, but a category of Object.  O well...  */
5929 -(NSUInteger) draggingEntered: (id <NSDraggingInfo>) sender
5931   NSTRACE (draggingEntered);
5932   return NSDragOperationGeneric;
5936 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
5938   return YES;
5942 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
5944   id pb;
5945   int x, y;
5946   NSString *type;
5947   NSEvent *theEvent = [[self window] currentEvent];
5948   NSPoint position;
5950   NSTRACE (performDragOperation);
5952   if (!emacs_event)
5953     return NO;
5955   position = [self convertPoint: [sender draggingLocation] fromView: nil];
5956   x = lrint (position.x);  y = lrint (position.y);
5958   pb = [sender draggingPasteboard];
5959   type = [pb availableTypeFromArray: ns_drag_types];
5960   if (type == 0)
5961     {
5962       return NO;
5963     }
5964   else if ([type isEqualToString: NSFilenamesPboardType])
5965     {
5966       NSArray *files;
5967       NSEnumerator *fenum;
5968       NSString *file;
5970       if (!(files = [pb propertyListForType: type]))
5971         return NO;
5973       fenum = [files objectEnumerator];
5974       while ( (file = [fenum nextObject]) )
5975         {
5976           emacs_event->kind = NS_NONKEY_EVENT;
5977           emacs_event->code = KEY_NS_DRAG_FILE;
5978           XSETINT (emacs_event->x, x);
5979           XSETINT (emacs_event->y, y);
5980           ns_input_file = append2 (ns_input_file,
5981                                    build_string ([file UTF8String]));
5982           emacs_event->modifiers = EV_MODIFIERS (theEvent);
5983           EV_TRAILER (theEvent);
5984         }
5985       return YES;
5986     }
5987   else if ([type isEqualToString: NSURLPboardType])
5988     {
5989       NSString *file;
5990       NSURL *fileURL;
5992       if (!(fileURL = [NSURL URLFromPasteboard: pb]) ||
5993           [fileURL isFileURL] == NO)
5994         return NO;
5996       file = [fileURL path];
5997       emacs_event->kind = NS_NONKEY_EVENT;
5998       emacs_event->code = KEY_NS_DRAG_FILE;
5999       XSETINT (emacs_event->x, x);
6000       XSETINT (emacs_event->y, y);
6001       ns_input_file = append2 (ns_input_file, build_string ([file UTF8String]));
6002       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6003       EV_TRAILER (theEvent);
6004       return YES;
6005     }
6006   else if ([type isEqualToString: NSStringPboardType]
6007            || [type isEqualToString: NSTabularTextPboardType])
6008     {
6009       NSString *data;
6011       if (! (data = [pb stringForType: type]))
6012         return NO;
6014       emacs_event->kind = NS_NONKEY_EVENT;
6015       emacs_event->code = KEY_NS_DRAG_TEXT;
6016       XSETINT (emacs_event->x, x);
6017       XSETINT (emacs_event->y, y);
6018       ns_input_text = build_string ([data UTF8String]);
6019       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6020       EV_TRAILER (theEvent);
6021       return YES;
6022     }
6023   else if ([type isEqualToString: NSColorPboardType])
6024     {
6025       NSColor *c = [NSColor colorFromPasteboard: pb];
6026       emacs_event->kind = NS_NONKEY_EVENT;
6027       emacs_event->code = KEY_NS_DRAG_COLOR;
6028       XSETINT (emacs_event->x, x);
6029       XSETINT (emacs_event->y, y);
6030       ns_input_color = ns_color_to_lisp (c);
6031       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6032       EV_TRAILER (theEvent);
6033       return YES;
6034     }
6035   else if ([type isEqualToString: NSFontPboardType])
6036     {
6037       /* impl based on GNUstep NSTextView.m */
6038       NSData *data = [pb dataForType: NSFontPboardType];
6039       NSDictionary *dict = [NSUnarchiver unarchiveObjectWithData: data];
6040       NSFont *font = [dict objectForKey: NSFontAttributeName];
6041       char fontSize[10];
6043       if (font == nil)
6044         return NO;
6046       emacs_event->kind = NS_NONKEY_EVENT;
6047       emacs_event->code = KEY_NS_CHANGE_FONT;
6048       XSETINT (emacs_event->x, x);
6049       XSETINT (emacs_event->y, y);
6050       ns_input_font = build_string ([[font fontName] UTF8String]);
6051       snprintf (fontSize, 10, "%f", [font pointSize]);
6052       ns_input_fontsize = build_string (fontSize);
6053       emacs_event->modifiers = EV_MODIFIERS (theEvent);
6054       EV_TRAILER (theEvent);
6055       return YES;
6056     }
6057   else
6058     {
6059       error ("Invalid data type in dragging pasteboard.");
6060       return NO;
6061     }
6065 - (id) validRequestorForSendType: (NSString *)typeSent
6066                       returnType: (NSString *)typeReturned
6068   NSTRACE (validRequestorForSendType);
6069   if (typeSent != nil && [ns_send_types indexOfObject: typeSent] != NSNotFound
6070       && typeReturned == nil)
6071     {
6072       if (! NILP (ns_get_local_selection (QPRIMARY, QUTF8_STRING)))
6073         return self;
6074     }
6076   return [super validRequestorForSendType: typeSent
6077                                returnType: typeReturned];
6081 /* The next two methods are part of NSServicesRequests informal protocol,
6082    supposedly called when a services menu item is chosen from this app.
6083    But this should not happen because we override the services menu with our
6084    own entries which call ns-perform-service.
6085    Nonetheless, it appeared to happen (under strange circumstances): bug#1435.
6086    So let's at least stub them out until further investigation can be done. */
6088 - (BOOL) readSelectionFromPasteboard: (NSPasteboard *)pb
6090   /* we could call ns_string_from_pasteboard(pboard) here but then it should
6091      be written into the buffer in place of the existing selection..
6092      ordinary service calls go through functions defined in ns-win.el */
6093   return NO;
6096 - (BOOL) writeSelectionToPasteboard: (NSPasteboard *)pb types: (NSArray *)types
6098   NSArray *typesDeclared;
6099   Lisp_Object val;
6101   /* We only support NSStringPboardType */
6102   if ([types containsObject:NSStringPboardType] == NO) {
6103     return NO;
6104   }
6106   val = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6107   if (CONSP (val) && SYMBOLP (XCAR (val)))
6108     {
6109       val = XCDR (val);
6110       if (CONSP (val) && NILP (XCDR (val)))
6111         val = XCAR (val);
6112     }
6113   if (! STRINGP (val))
6114     return NO;
6116   typesDeclared = [NSArray arrayWithObject:NSStringPboardType];
6117   [pb declareTypes:typesDeclared owner:nil];
6118   ns_string_to_pasteboard (pb, val);
6119   return YES;
6123 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
6124    (gives a miniaturized version of the window); currently we use the latter for
6125    frames whose active buffer doesn't correspond to any file
6126    (e.g., '*scratch*') */
6127 - setMiniwindowImage: (BOOL) setMini
6129   id image = [[self window] miniwindowImage];
6130   NSTRACE (setMiniwindowImage);
6132   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
6133      about "AppleDockIconEnabled" notwithstanding, however the set message
6134      below has its effect nonetheless. */
6135   if (image != emacsframe->output_data.ns->miniimage)
6136     {
6137       if (image && [image isKindOfClass: [EmacsImage class]])
6138         [image release];
6139       [[self window] setMiniwindowImage:
6140                        setMini ? emacsframe->output_data.ns->miniimage : nil];
6141     }
6143   return self;
6147 - (void) setRows: (int) r andColumns: (int) c
6149   rows = r;
6150   cols = c;
6153 @end  /* EmacsView */
6157 /* ==========================================================================
6159     EmacsWindow implementation
6161    ========================================================================== */
6163 @implementation EmacsWindow
6165 #ifdef NS_IMPL_COCOA
6166 - (id)accessibilityAttributeValue:(NSString *)attribute
6168   Lisp_Object str = Qnil;
6169   struct frame *f = SELECTED_FRAME ();
6170   struct buffer *curbuf = XBUFFER (XWINDOW (f->selected_window)->buffer);
6172   if ([attribute isEqualToString:NSAccessibilityRoleAttribute])
6173     return NSAccessibilityTextFieldRole;
6175   if ([attribute isEqualToString:NSAccessibilitySelectedTextAttribute]
6176       && curbuf && ! NILP (BVAR (curbuf, mark_active)))
6177     {
6178       str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6179     }
6180   else if (curbuf && [attribute isEqualToString:NSAccessibilityValueAttribute])
6181     {
6182       if (! NILP (BVAR (curbuf, mark_active)))
6183           str = ns_get_local_selection (QPRIMARY, QUTF8_STRING);
6185       if (NILP (str))
6186         {
6187           ptrdiff_t start_byte = BUF_BEGV_BYTE (curbuf);
6188           ptrdiff_t byte_range = BUF_ZV_BYTE (curbuf) - start_byte;
6189           ptrdiff_t range = BUF_ZV (curbuf) - BUF_BEGV (curbuf);
6191           if (! NILP (BVAR (curbuf, enable_multibyte_characters)))
6192             str = make_uninit_multibyte_string (range, byte_range);
6193           else
6194             str = make_uninit_string (range);
6195           /* To check: This returns emacs-utf-8, which is a superset of utf-8.
6196              Is this a problem?  */
6197           memcpy (SDATA (str), BYTE_POS_ADDR (start_byte), byte_range);
6198         }
6199     }
6202   if (! NILP (str))
6203     {
6204       if (CONSP (str) && SYMBOLP (XCAR (str)))
6205         {
6206           str = XCDR (str);
6207           if (CONSP (str) && NILP (XCDR (str)))
6208             str = XCAR (str);
6209         }
6210       if (STRINGP (str))
6211         {
6212           const char *utfStr = SSDATA (str);
6213           NSString *nsStr = [NSString stringWithUTF8String: utfStr];
6214           return nsStr;
6215         }
6216     }
6218   return [super accessibilityAttributeValue:attribute];
6220 #endif /* NS_IMPL_COCOA */
6222 /* If we have multiple monitors, one above the other, we don't want to
6223    restrict the height to just one monitor.  So we override this.  */
6224 - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen *)screen
6226   /* When making the frame visible for the first time or if there is just
6227      one screen, we want to constrain.  Other times not.  */
6228   NSUInteger nr_screens = [[NSScreen screens] count];
6229   struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
6230   NSTRACE (constrainFrameRect);
6232   if (nr_screens == 1)
6233     {
6234       NSRect r = [super constrainFrameRect:frameRect toScreen:screen];
6235       return r;
6236     }
6238   if (f->output_data.ns->dont_constrain
6239       || ns_menu_bar_should_be_hidden ())
6240     return frameRect;
6242   f->output_data.ns->dont_constrain = 1;
6243   return [super constrainFrameRect:frameRect toScreen:screen];
6247 /* called only on resize clicks by special case in EmacsApp-sendEvent */
6248 - (void)mouseDown: (NSEvent *)theEvent
6250   if (ns_in_resize)
6251     {
6252       NSSize size = [[theEvent window] frame].size;
6253       grabOffset = [theEvent locationInWindow];
6254       grabOffset.x = size.width - grabOffset.x;
6255     }
6256   else
6257     [super mouseDown: theEvent];
6261 /* stop resizing */
6262 - (void)mouseUp: (NSEvent *)theEvent
6264   if (ns_in_resize)
6265     {
6266       struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
6267       ns_in_resize = NO;
6268       ns_set_name_as_filename (f);
6269       [self display];
6270       ns_send_appdefined (-1);
6271     }
6272   else
6273     [super mouseUp: theEvent];
6277 /* send resize events */
6278 - (void)mouseDragged: (NSEvent *)theEvent
6280   if (ns_in_resize)
6281     {
6282       NSPoint p = [theEvent locationInWindow];
6283       NSSize size, vettedSize, origSize = [self frame].size;
6285       size.width = p.x + grabOffset.x;
6286       size.height = origSize.height - p.y + grabOffset.y;
6288       if (size.width == origSize.width && size.height == origSize.height)
6289         return;
6291       vettedSize = [[self delegate] windowWillResize: self toSize: size];
6292       [[NSNotificationCenter defaultCenter]
6293             postNotificationName: NSWindowDidResizeNotification
6294                           object: self];
6295     }
6296   else
6297     [super mouseDragged: theEvent];
6300 @end /* EmacsWindow */
6303 /* ==========================================================================
6305     EmacsScroller implementation
6307    ========================================================================== */
6310 @implementation EmacsScroller
6312 /* for repeat button push */
6313 #define SCROLL_BAR_FIRST_DELAY 0.5
6314 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
6316 + (CGFloat) scrollerWidth
6318   /* TODO: if we want to allow variable widths, this is the place to do it,
6319            however neither GNUstep nor Cocoa support it very well */
6320   return [NSScroller scrollerWidth];
6324 - initFrame: (NSRect )r window: (Lisp_Object)nwin
6326   NSTRACE (EmacsScroller_initFrame);
6328   r.size.width = [EmacsScroller scrollerWidth];
6329   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
6330   [self setContinuous: YES];
6331   [self setEnabled: YES];
6333   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
6334      locked against the top and bottom edges, and right edge on OS X, where
6335      scrollers are on right. */
6336 #ifdef NS_IMPL_GNUSTEP
6337   [self setAutoresizingMask: NSViewMaxXMargin | NSViewHeightSizable];
6338 #else
6339   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
6340 #endif
6342   win = nwin;
6343   condemned = NO;
6344   pixel_height = NSHeight (r);
6345   if (pixel_height == 0) pixel_height = 1;
6346   min_portion = 20 / pixel_height;
6348   frame = XFRAME (XWINDOW (win)->frame);
6349   if (FRAME_LIVE_P (frame))
6350     {
6351       int i;
6352       EmacsView *view = FRAME_NS_VIEW (frame);
6353       NSView *sview = [[view window] contentView];
6354       NSArray *subs = [sview subviews];
6356       /* disable optimization stopping redraw of other scrollbars */
6357       view->scrollbarsNeedingUpdate = 0;
6358       for (i =[subs count]-1; i >= 0; i--)
6359         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
6360           view->scrollbarsNeedingUpdate++;
6361       [sview addSubview: self];
6362     }
6364 /*  [self setFrame: r]; */
6366   return self;
6370 - (void)setFrame: (NSRect)newRect
6372   NSTRACE (EmacsScroller_setFrame);
6373 /*  BLOCK_INPUT; */
6374   pixel_height = NSHeight (newRect);
6375   if (pixel_height == 0) pixel_height = 1;
6376   min_portion = 20 / pixel_height;
6377   [super setFrame: newRect];
6378   [self display];
6379 /*  UNBLOCK_INPUT; */
6383 - (void)dealloc
6385   NSTRACE (EmacsScroller_dealloc);
6386   if (!NILP (win))
6387     wset_vertical_scroll_bar (XWINDOW (win), Qnil);
6388   [super dealloc];
6392 - condemn
6394   NSTRACE (condemn);
6395   condemned =YES;
6396   return self;
6400 - reprieve
6402   NSTRACE (reprieve);
6403   condemned =NO;
6404   return self;
6408 - judge
6410   NSTRACE (judge);
6411   if (condemned)
6412     {
6413       EmacsView *view;
6414       BLOCK_INPUT;
6415       /* ensure other scrollbar updates after deletion */
6416       view = (EmacsView *)FRAME_NS_VIEW (frame);
6417       if (view != nil)
6418         view->scrollbarsNeedingUpdate++;
6419       [self removeFromSuperview];
6420       [self release];
6421       UNBLOCK_INPUT;
6422     }
6423   return self;
6427 - (void)resetCursorRects
6429   NSRect visible = [self visibleRect];
6430   NSTRACE (resetCursorRects);
6432   if (!NSIsEmptyRect (visible))
6433     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
6434   [[NSCursor arrowCursor] setOnMouseEntered: YES];
6438 - (int) checkSamePosition: (int) position portion: (int) portion
6439                     whole: (int) whole
6441   return em_position ==position && em_portion ==portion && em_whole ==whole
6442     && portion != whole; /* needed for resize empty buf */
6446 - setPosition: (int)position portion: (int)portion whole: (int)whole
6448   NSTRACE (setPosition);
6450   em_position = position;
6451   em_portion = portion;
6452   em_whole = whole;
6454   if (portion >= whole)
6455     {
6456 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
6457       [self setKnobProportion: 1.0];
6458       [self setDoubleValue: 1.0];
6459 #else
6460       [self setFloatValue: 0.0 knobProportion: 1.0];
6461 #endif
6462     }
6463   else
6464     {
6465       float pos, por;
6466       portion = max ((float)whole*min_portion/pixel_height, portion);
6467       pos = (float)position / (whole - portion);
6468       por = (float)portion/whole;
6469 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED > MAC_OS_X_VERSION_10_5
6470       [self setKnobProportion: por];
6471       [self setDoubleValue: pos];
6472 #else
6473       [self setFloatValue: pos knobProportion: por];
6474 #endif
6475     }
6476   return self;
6479 /* FIXME: unused at moment (see ns_mouse_position) at the moment because
6480      drag events will go directly to the EmacsScroller.  Leaving in for now. */
6481 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
6482                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
6484   *part = last_hit_part;
6485   *window = win;
6486   XSETINT (*y, pixel_height);
6487   if ([self floatValue] > 0.999)
6488     XSETINT (*x, pixel_height);
6489   else
6490     XSETINT (*x, pixel_height * [self floatValue]);
6494 /* set up emacs_event */
6495 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
6497   if (!emacs_event)
6498     return;
6500   emacs_event->part = last_hit_part;
6501   emacs_event->code = 0;
6502   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
6503   emacs_event->frame_or_window = win;
6504   emacs_event->timestamp = EV_TIMESTAMP (e);
6505   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
6506   emacs_event->arg = Qnil;
6507   XSETINT (emacs_event->x, loc * pixel_height);
6508   XSETINT (emacs_event->y, pixel_height-20);
6510   if (q_event_ptr)
6511     {
6512       n_emacs_events_pending++;
6513       kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
6514     }
6515   else
6516     kbd_buffer_store_event (emacs_event);
6517   EVENT_INIT (*emacs_event);
6518   ns_send_appdefined (-1);
6522 /* called manually thru timer to implement repeated button action w/hold-down */
6523 - repeatScroll: (NSTimer *)scrollEntry
6525   NSEvent *e = [[self window] currentEvent];
6526   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
6527   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
6529   /* clear timer if need be */
6530   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
6531     {
6532         [scroll_repeat_entry invalidate];
6533         [scroll_repeat_entry release];
6534         scroll_repeat_entry = nil;
6536         if (inKnob)
6537           return self;
6539         scroll_repeat_entry
6540           = [[NSTimer scheduledTimerWithTimeInterval:
6541                         SCROLL_BAR_CONTINUOUS_DELAY
6542                                             target: self
6543                                           selector: @selector (repeatScroll:)
6544                                           userInfo: 0
6545                                            repeats: YES]
6546               retain];
6547     }
6549   [self sendScrollEventAtLoc: 0 fromEvent: e];
6550   return self;
6554 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
6555    mouseDragged events without going into a modal loop. */
6556 - (void)mouseDown: (NSEvent *)e
6558   NSRect sr, kr;
6559   /* hitPart is only updated AFTER event is passed on */
6560   NSScrollerPart part = [self testPart: [e locationInWindow]];
6561   double inc = 0.0, loc, kloc, pos;
6562   int edge = 0;
6564   NSTRACE (EmacsScroller_mouseDown);
6566   switch (part)
6567     {
6568     case NSScrollerDecrementPage:
6569         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
6570     case NSScrollerIncrementPage:
6571         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
6572     case NSScrollerDecrementLine:
6573       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
6574     case NSScrollerIncrementLine:
6575       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
6576     case NSScrollerKnob:
6577       last_hit_part = scroll_bar_handle; break;
6578     case NSScrollerKnobSlot:  /* GNUstep-only */
6579       last_hit_part = scroll_bar_move_ratio; break;
6580     default:  /* NSScrollerNoPart? */
6581       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %ld\n",
6582                (long) part);
6583       return;
6584     }
6586   if (inc != 0.0)
6587     {
6588       pos = 0;      /* ignored */
6590       /* set a timer to repeat, as we can't let superclass do this modally */
6591       scroll_repeat_entry
6592         = [[NSTimer scheduledTimerWithTimeInterval: SCROLL_BAR_FIRST_DELAY
6593                                             target: self
6594                                           selector: @selector (repeatScroll:)
6595                                           userInfo: 0
6596                                            repeats: YES]
6597             retain];
6598     }
6599   else
6600     {
6601       /* handle, or on GNUstep possibly slot */
6602       NSEvent *fake_event;
6604       /* compute float loc in slot and mouse offset on knob */
6605       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
6606                       toView: nil];
6607       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
6608       if (loc <= 0.0)
6609         {
6610           loc = 0.0;
6611           edge = -1;
6612         }
6613       else if (loc >= NSHeight (sr))
6614         {
6615           loc = NSHeight (sr);
6616           edge = 1;
6617         }
6619       if (edge)
6620         kloc = 0.5 * edge;
6621       else
6622         {
6623           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
6624                           toView: nil];
6625           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
6626         }
6627       last_mouse_offset = kloc;
6629       /* if knob, tell emacs a location offset by knob pos
6630          (to indicate top of handle) */
6631       if (part == NSScrollerKnob)
6632           pos = (loc - last_mouse_offset) / NSHeight (sr);
6633       else
6634         /* else this is a slot click on GNUstep: go straight there */
6635         pos = loc / NSHeight (sr);
6637       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
6638       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
6639                                       location: [e locationInWindow]
6640                                  modifierFlags: [e modifierFlags]
6641                                      timestamp: [e timestamp]
6642                                   windowNumber: [e windowNumber]
6643                                        context: [e context]
6644                                    eventNumber: [e eventNumber]
6645                                     clickCount: [e clickCount]
6646                                       pressure: [e pressure]];
6647       [super mouseUp: fake_event];
6648     }
6650   if (part != NSScrollerKnob)
6651     [self sendScrollEventAtLoc: pos fromEvent: e];
6655 /* Called as we manually track scroller drags, rather than superclass. */
6656 - (void)mouseDragged: (NSEvent *)e
6658     NSRect sr;
6659     double loc, pos;
6660     int edge = 0;
6662     NSTRACE (EmacsScroller_mouseDragged);
6664       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
6665                       toView: nil];
6666       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
6668       if (loc <= 0.0)
6669         {
6670           loc = 0.0;
6671           edge = -1;
6672         }
6673       else if (loc >= NSHeight (sr) + last_mouse_offset)
6674         {
6675           loc = NSHeight (sr) + last_mouse_offset;
6676           edge = 1;
6677         }
6679       pos = /*(edge ? loc :*/ (loc - last_mouse_offset) / NSHeight (sr);
6680       [self sendScrollEventAtLoc: pos fromEvent: e];
6684 - (void)mouseUp: (NSEvent *)e
6686   if (scroll_repeat_entry)
6687     {
6688       [scroll_repeat_entry invalidate];
6689       [scroll_repeat_entry release];
6690       scroll_repeat_entry = nil;
6691     }
6692   last_hit_part = 0;
6696 /* treat scrollwheel events in the bar as though they were in the main window */
6697 - (void) scrollWheel: (NSEvent *)theEvent
6699   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
6700   [view mouseDown: theEvent];
6703 @end  /* EmacsScroller */
6708 /* ==========================================================================
6710    Font-related functions; these used to be in nsfaces.m
6712    ========================================================================== */
6715 Lisp_Object
6716 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
6718   struct font *font = XFONT_OBJECT (font_object);
6720   if (fontset < 0)
6721     fontset = fontset_from_font (font_object);
6722   FRAME_FONTSET (f) = fontset;
6724   if (FRAME_FONT (f) == font)
6725     /* This font is already set in frame F.  There's nothing more to
6726        do.  */
6727     return font_object;
6729   FRAME_FONT (f) = font;
6731   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
6732   FRAME_COLUMN_WIDTH (f) = font->average_width;
6733   FRAME_SPACE_WIDTH (f) = font->space_width;
6734   FRAME_LINE_HEIGHT (f) = font->height;
6736   compute_fringe_widths (f, 1);
6738   /* Compute the scroll bar width in character columns.  */
6739   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
6740     {
6741       int wid = FRAME_COLUMN_WIDTH (f);
6742       FRAME_CONFIG_SCROLL_BAR_COLS (f)
6743         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
6744     }
6745   else
6746     {
6747       int wid = FRAME_COLUMN_WIDTH (f);
6748       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
6749     }
6751   /* Now make the frame display the given font.  */
6752   if (FRAME_NS_WINDOW (f) != 0)
6753         x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
6755   return font_object;
6759 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
6760 /* Note: ns_font_to_xlfd and ns_fontname_to_xlfd no longer needed, removed
6761          in 1.43. */
6763 const char *
6764 ns_xlfd_to_fontname (const char *xlfd)
6765 /* --------------------------------------------------------------------------
6766     Convert an X font name (XLFD) to an NS font name.
6767     Only family is used.
6768     The string returned is temporarily allocated.
6769    -------------------------------------------------------------------------- */
6771   char *name = xmalloc (180);
6772   int i, len;
6773   const char *ret;
6775   if (!strncmp (xlfd, "--", 2))
6776     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
6777   else
6778     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
6780   /* stopgap for malformed XLFD input */
6781   if (strlen (name) == 0)
6782     strcpy (name, "Monaco");
6784   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
6785      also uppercase after '-' or ' ' */
6786   name[0] = c_toupper (name[0]);
6787   for (len =strlen (name), i =0; i<len; i++)
6788     {
6789       if (name[i] == '$')
6790         {
6791           name[i] = '-';
6792           if (i+1<len)
6793             name[i+1] = c_toupper (name[i+1]);
6794         }
6795       else if (name[i] == '_')
6796         {
6797           name[i] = ' ';
6798           if (i+1<len)
6799             name[i+1] = c_toupper (name[i+1]);
6800         }
6801     }
6802 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
6803   ret = [[NSString stringWithUTF8String: name] UTF8String];
6804   xfree (name);
6805   return ret;
6809 void
6810 syms_of_nsterm (void)
6812   NSTRACE (syms_of_nsterm);
6814   ns_antialias_threshold = 10.0;
6816   /* from 23+ we need to tell emacs what modifiers there are.. */
6817   DEFSYM (Qmodifier_value, "modifier-value");
6818   DEFSYM (Qalt, "alt");
6819   DEFSYM (Qhyper, "hyper");
6820   DEFSYM (Qmeta, "meta");
6821   DEFSYM (Qsuper, "super");
6822   DEFSYM (Qcontrol, "control");
6823   DEFSYM (QUTF8_STRING, "UTF8_STRING");
6825   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
6826   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
6827   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
6828   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
6829   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
6831   DEFVAR_LISP ("ns-input-file", ns_input_file,
6832               "The file specified in the last NS event.");
6833   ns_input_file =Qnil;
6835   DEFVAR_LISP ("ns-input-text", ns_input_text,
6836               "The data received in the last NS text drag event.");
6837   ns_input_text =Qnil;
6839   DEFVAR_LISP ("ns-working-text", ns_working_text,
6840               "String for visualizing working composition sequence.");
6841   ns_working_text =Qnil;
6843   DEFVAR_LISP ("ns-input-font", ns_input_font,
6844               "The font specified in the last NS event.");
6845   ns_input_font =Qnil;
6847   DEFVAR_LISP ("ns-input-fontsize", ns_input_fontsize,
6848               "The fontsize specified in the last NS event.");
6849   ns_input_fontsize =Qnil;
6851   DEFVAR_LISP ("ns-input-line", ns_input_line,
6852                "The line specified in the last NS event.");
6853   ns_input_line =Qnil;
6855   DEFVAR_LISP ("ns-input-color", ns_input_color,
6856                "The color specified in the last NS event.");
6857   ns_input_color =Qnil;
6859   DEFVAR_LISP ("ns-input-spi-name", ns_input_spi_name,
6860                "The service name specified in the last NS event.");
6861   ns_input_spi_name =Qnil;
6863   DEFVAR_LISP ("ns-input-spi-arg", ns_input_spi_arg,
6864                "The service argument specified in the last NS event.");
6865   ns_input_spi_arg =Qnil;
6867   DEFVAR_LISP ("ns-alternate-modifier", ns_alternate_modifier,
6868                "This variable describes the behavior of the alternate or option key.\n\
6869 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6870 Set to none means that the alternate / option key is not interpreted by Emacs\n\
6871 at all, allowing it to be used at a lower level for accented character entry.");
6872   ns_alternate_modifier = Qmeta;
6874   DEFVAR_LISP ("ns-right-alternate-modifier", ns_right_alternate_modifier,
6875                "This variable describes the behavior of the right alternate or option key.\n\
6876 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6877 Set to left means be the same key as `ns-alternate-modifier'.\n\
6878 Set to none means that the alternate / option key is not interpreted by Emacs\n\
6879 at all, allowing it to be used at a lower level for accented character entry.");
6880   ns_right_alternate_modifier = Qleft;
6882   DEFVAR_LISP ("ns-command-modifier", ns_command_modifier,
6883                "This variable describes the behavior of the command key.\n\
6884 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
6885   ns_command_modifier = Qsuper;
6887   DEFVAR_LISP ("ns-right-command-modifier", ns_right_command_modifier,
6888                "This variable describes the behavior of the right command key.\n\
6889 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6890 Set to left means be the same key as `ns-command-modifier'.\n\
6891 Set to none means that the command / option key is not interpreted by Emacs\n\
6892 at all, allowing it to be used at a lower level for accented character entry.");
6893   ns_right_command_modifier = Qleft;
6895   DEFVAR_LISP ("ns-control-modifier", ns_control_modifier,
6896                "This variable describes the behavior of the control key.\n\
6897 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
6898   ns_control_modifier = Qcontrol;
6900   DEFVAR_LISP ("ns-right-control-modifier", ns_right_control_modifier,
6901                "This variable describes the behavior of the right control key.\n\
6902 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6903 Set to left means be the same key as `ns-control-modifier'.\n\
6904 Set to none means that the control / option key is not interpreted by Emacs\n\
6905 at all, allowing it to be used at a lower level for accented character entry.");
6906   ns_right_control_modifier = Qleft;
6908   DEFVAR_LISP ("ns-function-modifier", ns_function_modifier,
6909                "This variable describes the behavior of the function key (on laptops).\n\
6910 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
6911 Set to none means that the function key is not interpreted by Emacs at all,\n\
6912 allowing it to be used at a lower level for accented character entry.");
6913   ns_function_modifier = Qnone;
6915   DEFVAR_LISP ("ns-antialias-text", ns_antialias_text,
6916                "Non-nil (the default) means to render text antialiased. Only has an effect on OS X Panther and above.");
6917   ns_antialias_text = Qt;
6919   DEFVAR_LISP ("ns-confirm-quit", ns_confirm_quit,
6920                "Whether to confirm application quit using dialog.");
6921   ns_confirm_quit = Qnil;
6923   staticpro (&ns_display_name_list);
6924   ns_display_name_list = Qnil;
6926   staticpro (&last_mouse_motion_frame);
6927   last_mouse_motion_frame = Qnil;
6929   DEFVAR_LISP ("ns-auto-hide-menu-bar", ns_auto_hide_menu_bar,
6930                doc: /* Non-nil means that the menu bar is hidden, but appears when the mouse is near.
6931 Only works on OSX 10.6 or later.  */);
6932   ns_auto_hide_menu_bar = Qnil;
6934   /* TODO: move to common code */
6935   DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
6936                doc: /* Which toolkit scroll bars Emacs uses, if any.
6937 A value of nil means Emacs doesn't use toolkit scroll bars.
6938 With the X Window system, the value is a symbol describing the
6939 X toolkit.  Possible values are: gtk, motif, xaw, or xaw3d.
6940 With MS Windows or Nextstep, the value is t.  */);
6941   Vx_toolkit_scroll_bars = Qt;
6943   DEFVAR_BOOL ("x-use-underline-position-properties",
6944                x_use_underline_position_properties,
6945      doc: /*Non-nil means make use of UNDERLINE_POSITION font properties.
6946 A value of nil means ignore them.  If you encounter fonts with bogus
6947 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
6948 to 4.1, set this to nil. */);
6949   x_use_underline_position_properties = 0;
6951   DEFVAR_BOOL ("x-underline-at-descent-line",
6952                x_underline_at_descent_line,
6953      doc: /* Non-nil means to draw the underline at the same place as the descent line.
6954 A value of nil means to draw the underline according to the value of the
6955 variable `x-use-underline-position-properties', which is usually at the
6956 baseline level.  The default value is nil.  */);
6957   x_underline_at_descent_line = 0;
6959   /* Tell emacs about this window system. */
6960   Fprovide (intern ("ns"), Qnil);