(image-dired-cmd-create-thumbnail-options)
[emacs.git] / src / nsterm.m
blob3d8ff3129f814849da9b346415de50e8a9cd14e8
1 /* NeXT/Open/GNUstep / MacOSX communication module.
2    Copyright (C) 1989, 1993, 1994, 2005, 2006, 2008
3      Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
21 Originally by Carl Edman
22 Updated by Christian Limpach (chris@nice.ch)
23 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
24 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
25 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
28 #include <math.h>
29 #include <sys/types.h>
30 #include <time.h>
31 #include <unistd.h>
33 #include "config.h"
34 #include "lisp.h"
35 #include "blockinput.h"
36 #include "sysselect.h"
37 #include "nsterm.h"
38 #include "systime.h"
39 #include "character.h"
40 #include "fontset.h"
41 #include "composite.h"
42 #include "ccl.h"
44 #include "termhooks.h"
45 #include "termopts.h"
46 #include "termchar.h"
48 #include "window.h"
49 #include "keyboard.h"
51 #include "font.h"
53 /* call tracing */
54 #if 0
55 int term_trace_num = 0;
56 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
57                                 __FILE__, __LINE__, ++term_trace_num)
58 #else
59 #define NSTRACE(x)
60 #endif
63 /* ==========================================================================
65     Local declarations
67    ========================================================================== */
69 /* Special keycodes that we pass down the event chain */
70 #define KEY_NS_POWER_OFF               ((1<<28)|(0<<16)|1)
71 #define KEY_NS_OPEN_FILE               ((1<<28)|(0<<16)|2)
72 #define KEY_NS_OPEN_TEMP_FILE          ((1<<28)|(0<<16)|3)
73 #define KEY_NS_DRAG_FILE               ((1<<28)|(0<<16)|4)
74 #define KEY_NS_DRAG_COLOR              ((1<<28)|(0<<16)|5)
75 #define KEY_NS_DRAG_TEXT               ((1<<28)|(0<<16)|6)
76 #define KEY_NS_CHANGE_FONT             ((1<<28)|(0<<16)|7)
77 #define KEY_NS_OPEN_FILE_LINE          ((1<<28)|(0<<16)|8)
78 #define KEY_NS_INSERT_WORKING_TEXT     ((1<<28)|(0<<16)|9)
79 #define KEY_NS_DELETE_WORKING_TEXT     ((1<<28)|(0<<16)|10)
80 #define KEY_NS_SPI_SERVICE_CALL        ((1<<28)|(0<<16)|11)
82 /* Convert a symbol indexed with an NSxxx value to a value as defined
83    in keyboard.c (lispy_function_key). I hope this is a correct way
84    of doing things... */
85 static unsigned convert_ns_to_X_keysym[] =
87   NSHomeFunctionKey,            0x50,
88   NSLeftArrowFunctionKey,       0x51,
89   NSUpArrowFunctionKey,         0x52,
90   NSRightArrowFunctionKey,      0x53,
91   NSDownArrowFunctionKey,       0x54,
92   NSPageUpFunctionKey,          0x55,
93   NSPageDownFunctionKey,        0x56,
94   NSEndFunctionKey,             0x57,
95   NSBeginFunctionKey,           0x58,
96   NSSelectFunctionKey,          0x60,
97   NSPrintFunctionKey,           0x61,
98   NSExecuteFunctionKey,         0x62,
99   NSInsertFunctionKey,          0x63,
100   NSUndoFunctionKey,            0x65,
101   NSRedoFunctionKey,            0x66,
102   NSMenuFunctionKey,            0x67,
103   NSFindFunctionKey,            0x68,
104   NSHelpFunctionKey,            0x6A,
105   NSBreakFunctionKey,           0x6B,
107   NSF1FunctionKey,              0xBE,
108   NSF2FunctionKey,              0xBF,
109   NSF3FunctionKey,              0xC0,
110   NSF4FunctionKey,              0xC1,
111   NSF5FunctionKey,              0xC2,
112   NSF6FunctionKey,              0xC3,
113   NSF7FunctionKey,              0xC4,
114   NSF8FunctionKey,              0xC5,
115   NSF9FunctionKey,              0xC6,
116   NSF10FunctionKey,             0xC7,
117   NSF11FunctionKey,             0xC8,
118   NSF12FunctionKey,             0xC9,
119   NSF13FunctionKey,             0xCA,
120   NSF14FunctionKey,             0xCB,
121   NSF15FunctionKey,             0xCC,
123   NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
124   NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
125   NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */
127   NSTabCharacter,               0x09,
128   0x19,                         0x09,  /* left tab->regular since pass shift */
129   NSCarriageReturnCharacter,    0x0D,
130   NSNewlineCharacter,           0x0D,
131   NSEnterCharacter,             0x8D,
133   0x1B,                         0x1B   /* escape */
137 /* Lisp communications */
138 Lisp_Object ns_input_file, ns_input_font, ns_input_fontsize, ns_input_line;
139 Lisp_Object ns_input_color, ns_input_text, ns_working_text;
140 Lisp_Object ns_input_spi_name, ns_input_spi_arg;
141 Lisp_Object Vx_toolkit_scroll_bars;
142 static Lisp_Object Qmodifier_value;
143 /*PENDING: unsure why these defined in term files, anyway we need in keymap.c */
144 Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper;
145 extern Lisp_Object Qcursor_color, Qcursor_type, Qns;
148 EmacsPrefsController *prefsController;
150 /* Defaults managed through the OpenStep defaults system.  These pertain to
151    the NS interface specifically.  Although a customization group could be
152    created, it's more natural to manage them via defaults. */
154 /* Specifies which emacs modifier should be generated when NS receives
155    the Alternate modifer.  May be Qnone or any of the modifier lisp symbols. */
156 Lisp_Object ns_alternate_modifier;
158 /* Specifies which emacs modifier should be generated when NS receives
159    the Command modifer.  May be any of the modifier lisp symbols. */
160 Lisp_Object ns_command_modifier;
162 /* Specifies which emacs modifier should be generated when NS receives
163    the Control modifer.  May be any of the modifier lisp symbols. */
164 Lisp_Object ns_control_modifier;
166 /* Specifies which emacs modifier should be generated when NS receives
167    the Function modifer (laptops).  May be any of the modifier lisp symbols. */
168 Lisp_Object ns_function_modifier;
170 /* A floating point value specifying the rate at which to blink the cursor.
171    YES indicates 0.5, NO indicates no blinking. */
172 Lisp_Object ns_cursor_blink_rate;
174 /* Used for liason with core emacs cursor-blink-mode. */
175 Lisp_Object ns_cursor_blink_mode;
177 /* A floating point value specifying vertical stretch (positive) or shrink
178   (negative) of text line spacing.  Zero means default spacing.
179   YES indicates 0.5, NO indicates 0.0. */
180 Lisp_Object ns_expand_space;
182 /* Control via default 'GSFontAntiAlias' on OS X and GNUstep. */
183 Lisp_Object ns_antialias_text;
185 /* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
186    the maximum font size to NOT antialias.  On GNUstep there is currently
187    no way to control this behavior. */
188 float ns_antialias_threshold;
190 /* Controls use of an undocumented CG function to do Quickdraw-style font
191    smoothing (less heavy) instead of regular Quartz smoothing. */
192 Lisp_Object ns_use_qd_smoothing;
194 /* Used to pick up AppleHighlightColor on OS X */
195 Lisp_Object ns_use_system_highlight_color;
196 NSString *ns_selection_color;
199 NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
201 /* Display variables */
202 struct ns_display_info *ns_display_list; /* Chain of existing displays */
203 Lisp_Object ns_display_name_list;
204 long context_menu_value = 0;
206 /* display update */
207 NSPoint last_mouse_motion_position;
208 static NSRect last_mouse_glyph;
209 static unsigned long last_mouse_movement_time = 0;
210 static Lisp_Object last_mouse_motion_frame;
211 static EmacsScroller *last_mouse_scroll_bar = nil;
212 static struct frame *ns_updating_frame;
213 static NSView *focus_view = NULL;
214 static int ns_window_num =0;
215 static NSRect uRect;
216 static BOOL gsaved = NO;
217 BOOL ns_in_resize = NO;
218 int ns_tmp_flags; /*PENDING */
219 struct nsfont_info *ns_tmp_font; /*PENDING */
220 /*static int debug_lock = 0; */
222 #ifdef NS_IMPL_COCOA
223 /* This undocumented Quartz function controls how fonts are anti-aliased.
224    (Found from code in Mac wxWindows impl, discovered by running `nm' on
225    the "QD" framework.)
226    Mode 0 is normal anti-aliasing, mode 1 is no anti-aliasing, and mode 2 is
227    4-bit pixel-aligned anti-aliasing (the old QuickDraw standard). */
228 extern void CGContextSetFontRenderingMode (CGContextRef cg, int v);
229 #endif
232 /* event loop */
233 static BOOL send_appdefined = YES;
234 static NSEvent *last_appdefined_event = 0;
235 static NSTimer *timed_entry = 0;
236 static NSTimer *fd_entry = nil;
237 static NSTimer *cursor_blink_entry = nil;
238 static NSTimer *scroll_repeat_entry = nil;
239 static fd_set select_readfds, t_readfds;
240 static struct timeval select_timeout;
241 static int select_nfds;
242 static NSAutoreleasePool *outerpool;
243 static BOOL ns_shutdown_properly = NO;
244 static struct input_event *emacs_event = NULL;
245 static struct input_event *q_event_ptr = NULL;
246 static int n_emacs_events_pending = 0;
247 static NSMutableArray *ns_pending_files, *ns_pending_service_names,
248   *ns_pending_service_args;
249 static BOOL inNsSelect = 0;
251 /* Convert modifiers in a NeXTSTEP event to emacs style modifiers.  */
252 #define NS_FUNCTION_KEY_MASK 0x800000
253 #define EV_MODIFIERS(e)                               \
254     ((([e modifierFlags] & NSHelpKeyMask) ?           \
255            hyper_modifier : 0)                        \
256      | (([e modifierFlags] & NSAlternateKeyMask) ?    \
257            parse_solitary_modifier (ns_alternate_modifier) : 0)   \
258      | (([e modifierFlags] & NSShiftKeyMask) ?        \
259            shift_modifier : 0)                        \
260      | (([e modifierFlags] & NSControlKeyMask) ?      \
261            parse_solitary_modifier (ns_control_modifier) : 0)     \
262      | (([e modifierFlags] & NS_FUNCTION_KEY_MASK) ?  \
263            parse_solitary_modifier (ns_function_modifier) : 0)    \
264      | (([e modifierFlags] & NSCommandKeyMask) ?      \
265            parse_solitary_modifier (ns_command_modifier):0))
267 #define EV_UDMODIFIERS(e)                                      \
268     ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
269      | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
270      | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
271      | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
272      | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
273      | (([e type] == NSRightMouseUp)   ? up_modifier   : 0))
275 #define EV_BUTTON(e)                                                         \
276     ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
277       (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : 1)
279 /* Convert the time field to a timestamp in milliseconds. */
280 #ifdef NS_IMPL_GNUSTEP
281 /* Apple says timestamp is in seconds, but GNUstep seems to be returning msec */
282 #define EV_TIMESTAMP(e) ([e timestamp])
283 #else
284 #define EV_TIMESTAMP(e) ([e timestamp] * 1000)
285 #endif /* not gnustep */
287 /* This is a piece of code which is common to all the event handling
288    methods.  Maybe it should even be a function.  */
289 #define EV_TRAILER(e)                                         \
290   {                                                           \
291   XSETFRAME (emacs_event->frame_or_window, [NSApp isActive] ? \
292              emacsframe : SELECTED_FRAME ());                 \
293   if (e) emacs_event->timestamp = EV_TIMESTAMP (e);           \
294   n_emacs_events_pending++;                                   \
295   kbd_buffer_store_event_hold (emacs_event, q_event_ptr);     \
296   EVENT_INIT (*emacs_event);                                  \
297   ns_send_appdefined (-1);                                    \
298   }
300 /*PENDING: get rid of need for these forward declarations */
301 static void ns_condemn_scroll_bars (struct frame *f),
302             ns_judge_scroll_bars (struct frame *f);
304 /* unused variables needed for compatibility reasons */
305 int x_use_underline_position_properties, x_underline_at_descent_line;
306 /* PENDING: figure out what to do with underline_minimum_offset. */
309 /* ==========================================================================
311     Utilities
313    ========================================================================== */
316 static Lisp_Object
317 append2 (Lisp_Object list, Lisp_Object item)
318 /* --------------------------------------------------------------------------
319    Utility to append to a list
320    -------------------------------------------------------------------------- */
322   Lisp_Object array[2];
323   array[0] = list;
324   array[1] = Fcons (item, Qnil);
325   return Fnconc (2, &array[0]);
329 void
330 ns_init_paths ()
331 /* --------------------------------------------------------------------------
332    Used to allow emacs to find its resources under Emacs.app
333    Called from emacs.c at startup.
334    -------------------------------------------------------------------------- */
336   NSBundle *bundle = [NSBundle mainBundle];
337   NSString *binDir = [bundle bundlePath], *resourceDir = [bundle resourcePath];
338   NSString *resourcePath, *resourcePaths;
339   NSRange range;
340   BOOL onWindows = NO; /* how do I determine this? */
341   NSString *pathSeparator = onWindows ? @";" : @":";
342   NSFileManager *fileManager = [NSFileManager defaultManager];
343   BOOL isDir;
344 /*NSLog (@"ns_init_paths: '%@'\n%@\n", [[NSBundle mainBundle] bundlePath], [[NSBundle mainBundle] resourcePath]); */
346   /* get bindir from base */
347   range = [resourceDir rangeOfString: @"Contents"];
348   if (range.location != NSNotFound)
349     {
350       binDir = [binDir stringByAppendingPathComponent: @"Contents"];
351 #ifdef NS_IMPL_COCOA
352       binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
353 #endif
354     }
356   /* the following based on Andrew Choi's init_mac_osx_environment () */
357   if (!getenv ("EMACSLOADPATH"))
358     {
359       NSArray *paths = [resourceDir stringsByAppendingPaths:
360                                   [NSArray arrayWithObjects:
361                                          @"site-lisp", @"lisp", @"leim", nil]];
362       NSEnumerator *pathEnum = [paths objectEnumerator];
363       resourcePaths = @"";
364       while (resourcePath = [pathEnum nextObject])
365         {
366           if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
367             if (isDir)
368               {
369                 if ([resourcePaths length] > 0)
370                   resourcePaths
371                     = [resourcePaths stringByAppendingString: pathSeparator];
372                 resourcePaths
373                   = [resourcePaths stringByAppendingString: resourcePath];
374               }
375         }
376       if ([resourcePaths length] > 0)
377         setenv ("EMACSLOADPATH", [resourcePaths UTF8String], 1);
378 /*NSLog (@"loadPath: '%s'\n", resourcePaths); */
379     }
381   if (!getenv ("EMACSPATH"))
382     {
383       NSArray *paths = [binDir stringsByAppendingPaths:
384                                   [NSArray arrayWithObjects: @"bin",
385                                                              @"lib-exec", nil]];
386       NSEnumerator *pathEnum = [paths objectEnumerator];
387       resourcePaths = @"";
388       while (resourcePath = [pathEnum nextObject])
389         {
390           if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
391             if (isDir)
392               {
393                 if ([resourcePaths length] > 0)
394                   resourcePaths
395                     = [resourcePaths stringByAppendingString: pathSeparator];
396                 resourcePaths
397                   = [resourcePaths stringByAppendingString: resourcePath];
398               }
399         }
400       if ([resourcePaths length] > 0)
401         setenv ("EMACSPATH", [resourcePaths UTF8String], 1);
402     }
404   resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
405   if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
406     {
407       if (isDir)
408         {
409           if (!getenv ("EMACSDATA"))
410             setenv ("EMACSDATA", [resourcePath UTF8String], 1);
411           if (!getenv ("EMACSDOC"))
412             setenv ("EMACSDOC", [resourcePath UTF8String], 1);
413         }
414     }
416   /*PENDING: append to INFOPATH... */
417   if (!getenv ("INFOPATH"))
418     {
419       resourcePath = [resourceDir stringByAppendingPathComponent: @"info"];
420       if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
421         if (isDir)
422           setenv ("INFOPATH", [resourcePath UTF8String], 1);
423     }
427 static int
428 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
429 /* --------------------------------------------------------------------------
430    Subtract the `struct timeval' values X and Y, storing the result in RESULT.
431    Return 1 if the difference is negative, otherwise 0.
432    -------------------------------------------------------------------------- */
434   /* Perform the carry for the later subtraction by updating y.
435      This is safer because on some systems
436      the tv_sec member is unsigned.  */
437   if (x.tv_usec < y.tv_usec)
438     {
439       int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
440       y.tv_usec -= 1000000 * nsec;
441       y.tv_sec += nsec;
442     }
443   if (x.tv_usec - y.tv_usec > 1000000)
444     {
445       int nsec = (y.tv_usec - x.tv_usec) / 1000000;
446       y.tv_usec += 1000000 * nsec;
447       y.tv_sec -= nsec;
448     }
450   /* Compute the time remaining to wait.  tv_usec is certainly positive.  */
451   result->tv_sec = x.tv_sec - y.tv_sec;
452   result->tv_usec = x.tv_usec - y.tv_usec;
454   /* Return indication of whether the result should be considered negative.  */
455   return x.tv_sec < y.tv_sec;
458 static void
459 ns_timeout (int usecs)
460 /* --------------------------------------------------------------------------
461      Blocking timer utility used by ns_ring_bell
462    -------------------------------------------------------------------------- */
464   struct timeval wakeup;
466   EMACS_GET_TIME (wakeup);
468   /* Compute time to wait until, propagating carry from usecs.  */
469   wakeup.tv_usec += usecs;
470   wakeup.tv_sec += (wakeup.tv_usec / 1000000);
471   wakeup.tv_usec %= 1000000;
473   /* Keep waiting until past the time wakeup.  */
474   while (1)
475     {
476       struct timeval timeout;
478       EMACS_GET_TIME (timeout);
480       /* In effect, timeout = wakeup - timeout.
481          Break if result would be negative.  */
482       if (timeval_subtract (&timeout, wakeup, timeout))
483         break;
485       /* Try to wait that long--but we might wake up sooner.  */
486       select (0, NULL, NULL, NULL, &timeout);
487     }
491 void
492 ns_release_object (void *obj)
493 /* --------------------------------------------------------------------------
494     Release an object (callable from C)
495    -------------------------------------------------------------------------- */
497     [(id)obj release];
501 void
502 ns_retain_object (void *obj)
503 /* --------------------------------------------------------------------------
504     Retain an object (callable from C)
505    -------------------------------------------------------------------------- */
507     [(id)obj retain];
511 void *
512 ns_alloc_autorelease_pool ()
513 /* --------------------------------------------------------------------------
514      Allocate a pool for temporary objects (callable from C)
515    -------------------------------------------------------------------------- */
517   return [[NSAutoreleasePool alloc] init];
521 void
522 ns_release_autorelease_pool (void *pool)
523 /* --------------------------------------------------------------------------
524      Free a pool and temporary objects it refers to (callable from C)
525    -------------------------------------------------------------------------- */
527   ns_release_object (pool);
532 /* ==========================================================================
534     Focus (clipping) and screen update
536    ========================================================================== */
538 static NSRect
539 ns_resize_handle_rect (NSWindow *window)
541   NSRect r = [window frame];
542   r.origin.x = r.size.width - RESIZE_HANDLE_SIZE;
543   r.origin.y = 0;
544   r.size.width = r.size.height = RESIZE_HANDLE_SIZE;
545   return r;
549 static void
550 ns_update_begin (struct frame *f)
551 /* --------------------------------------------------------------------------
552    Prepare for a grouped sequence of drawing calls
553    23: external (RIF) call; now split w/ and called before update_window_begin
554    -------------------------------------------------------------------------- */
556   NSView *view = FRAME_NS_VIEW (f);
557   NSTRACE (ns_update_begin);
558 /*fprintf (stderr, "\\%p\n", f); */
560   ns_updating_frame = f;
561   [view lockFocus];
563 #ifdef NS_IMPL_GNUSTEP
564   uRect = NSMakeRect (0, 0, 0, 0);
565 #endif
569 static void
570 ns_update_window_begin (struct window *w)
571 /* --------------------------------------------------------------------------
572    Prepare for a grouped sequence of drawing calls
573    23: external (RIF) call; now split with and called after update_begin
574    -------------------------------------------------------------------------- */
576   struct frame *f = XFRAME (WINDOW_FRAME (w));
577   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
578   NSTRACE (ns_update_window_begin);
580   updated_window = w;
581   set_output_cursor (&w->cursor);
583   BLOCK_INPUT;
585   if (f == dpyinfo->mouse_face_mouse_frame)
586     {
587       /* Don't do highlighting for mouse motion during the update.  */
588       dpyinfo->mouse_face_defer = 1;
590         /* If the frame needs to be redrawn,
591            simply forget about any prior mouse highlighting.  */
592       if (FRAME_GARBAGED_P (f))
593         dpyinfo->mouse_face_window = Qnil;
595       /* (further code for mouse faces ifdef'd out in other terms elided) */
596     }
598   UNBLOCK_INPUT;
602 static void
603 ns_update_window_end (struct window *w, int cursor_on_p,
604                       int mouse_face_overwritten_p)
605 /* --------------------------------------------------------------------------
606    Finished a grouped sequence of drawing calls
607    23: external (RIF) call; now split with and called before update_window_end
608    -------------------------------------------------------------------------- */
610   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (XFRAME (w->frame));
612   /* note: this fn is nearly identical in all terms */
613   if (!w->pseudo_window_p)
614     {
615       BLOCK_INPUT;
617       if (cursor_on_p)
618         display_and_set_cursor (w, 1,
619                                 output_cursor.hpos, output_cursor.vpos,
620                                 output_cursor.x, output_cursor.y);
622       if (draw_window_fringes (w, 1))
623         x_draw_vertical_border (w);
625       UNBLOCK_INPUT;
626     }
628   /* If a row with mouse-face was overwritten, arrange for
629      frame_up_to_date to redisplay the mouse highlight.  */
630   if (mouse_face_overwritten_p)
631     {
632       dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
633       dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
634       dpyinfo->mouse_face_window = Qnil;
635     }
637   updated_window = NULL;
638   NSTRACE (update_window_end);
642 static void
643 ns_update_end (struct frame *f)
644 /* --------------------------------------------------------------------------
645    Finished a grouped sequence of drawing calls
646    23: external (RIF) call; now split with and called after update_window_end
647    -------------------------------------------------------------------------- */
649   NSView *view = FRAME_NS_VIEW (f);
651 /*   if (f == FRAME_NS_DISPLAY_INFO (f)->mouse_face_mouse_frame) */
652     FRAME_NS_DISPLAY_INFO (f)->mouse_face_defer = 0;
654   BLOCK_INPUT;
656 #ifdef NS_IMPL_GNUSTEP
657   /* trigger flush only in the rectangle we tracked as being drawn */
658   [view unlockFocusNeedsFlush: NO];
659 /*fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", uRect.origin.x, uRect.origin.y, uRect.size.width, uRect.size.height); */
660   [view lockFocusInRect: uRect];
661 #endif
663   [view unlockFocus];
664   [[view window] flushWindow];
666   UNBLOCK_INPUT;
667   ns_updating_frame = NULL;
668   NSTRACE (ns_update_end);
672 static void
673 ns_flush (struct frame *f)
674 /* --------------------------------------------------------------------------
675    23: external (RIF) call
676    NS impl is no-op since currently we flush in ns_update_end and elsewhere
677    -------------------------------------------------------------------------- */
679     NSTRACE (ns_flush);
683 static void
684 ns_focus (struct frame *f, NSRect *r, int n)
685 /* --------------------------------------------------------------------------
686    Internal: Focus on given frame.  During small local updates this is used to
687      draw, however during large updates, ns_update_begin and ns_update_end are
688      called to wrap the whole thing, in which case these calls are stubbed out.
689      Except, on GNUstep, we accumulate the rectangle being drawn into, because
690      the back end won't do this automatically, and will just end up flushing
691      the entire window.
692    -------------------------------------------------------------------------- */
694   NSTRACE (ns_focus);
695 #ifdef NS_IMPL_GNUSTEP
696   NSRect u;
697     if (n == 2)
698       u = NSUnionRect (r[0], r[1]);
699     else if (r)
700       u = *r;
701 #endif
702 /* static int c =0;
703    fprintf (stderr, "focus: %d", c++);
704    if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
705    fprintf (stderr, "\n"); */
707   if (f != ns_updating_frame)
708     {
709       NSView *view = FRAME_NS_VIEW (f);
710       if (view != focus_view)
711         {
712           if (focus_view != NULL)
713             {
714               [focus_view unlockFocus];
715               [[focus_view window] flushWindow];
716 /*debug_lock--; */
717             }
719           if (view)
720 #ifdef NS_IMPL_GNUSTEP
721             r ? [view lockFocusInRect: u] : [view lockFocus];
722 #else
723             [view lockFocus];
724 #endif
725           focus_view = view;
726 /*if (view) debug_lock++; */
727         }
728 #ifdef NS_IMPL_GNUSTEP
729       else
730         {
731           /* more than one rect being drawn into */
732           if (view && r)
733             {
734               [view unlockFocus]; /* add prev rect to redraw list */
735               [view lockFocusInRect: u]; /* focus for draw in new rect */
736             }
737         }
738 #endif
739     }
740 #ifdef NS_IMPL_GNUSTEP
741   else
742     {
743       /* in batch mode, but in GNUstep must still track rectangles explicitly */
744       uRect = (r ? NSUnionRect (uRect, u) : [FRAME_NS_VIEW (f) visibleRect]);
745     }
746 #endif
748   /*23: clipping */
749   if (r)
750     {
751       [[NSGraphicsContext currentContext] saveGraphicsState];
752       if (n == 2)
753         NSRectClipList (r, 2);
754       else
755         NSRectClip (*r);
756       gsaved = YES;
757     }
761 static void
762 ns_unfocus (struct frame *f)
763 /* --------------------------------------------------------------------------
764      Internal: Remove focus on given frame
765    -------------------------------------------------------------------------- */
767   NSTRACE (ns_unfocus);
769   if (gsaved)
770     {
771       [[NSGraphicsContext currentContext] restoreGraphicsState];
772       gsaved = NO;
773     }
775   if (f != ns_updating_frame)
776     {
777       if (focus_view != NULL)
778         {
779           [focus_view unlockFocus];
780           [[focus_view window] flushWindow];
781           focus_view = NULL;
782 /*debug_lock--; */
783         }
784     }
788 static void
789 ns_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
790 /* --------------------------------------------------------------------------
791      23: Internal (but parallels other terms): Focus drawing on given row
792    -------------------------------------------------------------------------- */
794   struct frame *f = XFRAME (WINDOW_FRAME (w));
795   NSRect clip_rect;
796   int window_x, window_y, window_width;
798   window_box (w, area, &window_x, &window_y, &window_width, 0);
800   clip_rect.origin.x = window_x - FRAME_INTERNAL_BORDER_WIDTH (f);
801   clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
802   clip_rect.origin.y = max (clip_rect.origin.y, window_y);
803   clip_rect.size.width = window_width + 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
804   clip_rect.size.height = row->visible_height;
806   /* allow a full-height row at the top when requested
807      (used to draw fringe all the way through internal border area) */
808   if (gc && clip_rect.origin.y < 5)
809     {
810       clip_rect.origin.y -= FRAME_INTERNAL_BORDER_WIDTH (f);
811       clip_rect.size.height += FRAME_INTERNAL_BORDER_WIDTH (f);
812     }
814   /* likewise at bottom */
815   if (gc &&
816       FRAME_PIXEL_HEIGHT (f) - (clip_rect.origin.y + clip_rect.size.height) < 5)
817     clip_rect.size.height += FRAME_INTERNAL_BORDER_WIDTH (f);
819   ns_focus (f, &clip_rect, 1);
823 static void
824 ns_ring_bell ()
825 /* --------------------------------------------------------------------------
826      "Beep" routine
827    -------------------------------------------------------------------------- */
829   NSTRACE (ns_ring_bell);
830   if (visible_bell)
831     {
832       NSAutoreleasePool *pool;
833       struct frame *frame = SELECTED_FRAME ();
834       NSView *view;
836       BLOCK_INPUT;
837       pool = [[NSAutoreleasePool alloc] init];
839       view = FRAME_NS_VIEW (frame);
840       if (view != nil)
841         {
842           NSRect r, surr;
843           NSPoint dim = NSMakePoint (128, 128);
845           r = [view bounds];
846           r.origin.x += (r.size.width - dim.x) / 2;
847           r.origin.y += (r.size.height - dim.y) / 2;
848           r.size.width = dim.x;
849           r.size.height = dim.y;
850           /* PENDING: cacheImageInRect under GNUSTEP does not account for
851              offset in x_set_window_size, so overestimate (4 fine on Cocoa) */
852           surr = NSInsetRect (r, -10, -10);
853           ns_focus (frame, &surr, 1);
854           [[view window] cacheImageInRect: surr];
855           [ns_lookup_indexed_color (NS_FACE_FOREGROUND
856                                       (FRAME_DEFAULT_FACE (frame)), frame) set];
857           NSRectFill (r);
858           [[view window] flushWindow];
859           ns_timeout (150000);
860           [[view window] restoreCachedImage];
861           [[view window] flushWindow];
862           ns_unfocus (frame);
863         }
864       [pool release];
865       UNBLOCK_INPUT;
866     }
867   else
868     {
869       NSBeep ();
870     }
874 static void
875 ns_reset_terminal_modes (struct terminal *terminal)
876 /*  Externally called as hook */
878   NSTRACE (ns_reset_terminal_modes);
881 static void
882 ns_set_terminal_modes (struct terminal *terminal)
883 /*  Externally called as hook */
885   NSTRACE (ns_set_terminal_modes);
890 /* ==========================================================================
892     Frame / window manager related functions
894    ========================================================================== */
897 static void
898 ns_raise_frame (struct frame *f)
899 /* --------------------------------------------------------------------------
900      Bring window to foreground and make it active
901    -------------------------------------------------------------------------- */
903   NSView *view = FRAME_NS_VIEW (f);
904   check_ns ();
905   BLOCK_INPUT;
906   [[view window] makeKeyAndOrderFront: NSApp];
907   UNBLOCK_INPUT;
911 static void
912 ns_lower_frame (struct frame *f)
913 /* --------------------------------------------------------------------------
914      Send window to back
915    -------------------------------------------------------------------------- */
917   NSView *view = FRAME_NS_VIEW (f);
918   check_ns ();
919   BLOCK_INPUT;
920   [[view window] orderBack: NSApp];
921   UNBLOCK_INPUT;
925 static void
926 ns_frame_raise_lower (struct frame *f, int raise)
927 /* --------------------------------------------------------------------------
928      External (hook)
929    -------------------------------------------------------------------------- */
931   NSTRACE (ns_frame_raise_lower);
933   if (raise)
934     ns_raise_frame (f);
935   else
936     ns_lower_frame (f);
940 static void
941 ns_frame_rehighlight (struct frame *frame)
942 /* --------------------------------------------------------------------------
943      External (hook): called on things like window switching within frame
944    -------------------------------------------------------------------------- */
946   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
947   struct frame *old_highlight = dpyinfo->ns_highlight_frame;
949   NSTRACE (ns_frame_rehighlight);
950   if (dpyinfo->ns_focus_frame)
951     {
952       dpyinfo->ns_highlight_frame
953         = (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->ns_focus_frame))
954            ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->ns_focus_frame))
955            : dpyinfo->ns_focus_frame);
956       if (!FRAME_LIVE_P (dpyinfo->ns_highlight_frame))
957         {
958           FRAME_FOCUS_FRAME (dpyinfo->ns_focus_frame) = Qnil;
959           dpyinfo->ns_highlight_frame = dpyinfo->ns_focus_frame;
960         }
961     }
962   else
963       dpyinfo->ns_highlight_frame = 0;
965   if (dpyinfo->ns_highlight_frame &&
966          dpyinfo->ns_highlight_frame != old_highlight)
967     {
968       /* as of 20080602 the lower and raise are superfluous */
969       if (old_highlight)
970         {
971           /*ns_lower_frame (old_highlight); */
972           x_update_cursor (old_highlight, 1);
973         }
974       if (dpyinfo->ns_highlight_frame)
975         {
976           /*ns_raise_frame (dpyinfo->ns_highlight_frame); */
977           x_update_cursor (dpyinfo->ns_highlight_frame, 1);
978         }
979     }
983 void
984 x_make_frame_visible (struct frame *f)
985 /* --------------------------------------------------------------------------
986      External: Show the window (X11 semantics)
987    -------------------------------------------------------------------------- */
989   NSTRACE (x_make_frame_visible);
990   /* PENDING: at some points in past this was not needed, as the only place that
991      called this (frame.c:Fraise_frame ()) also called raise_lower;
992      if this ends up the case again, comment this out again. */
993   if (!FRAME_VISIBLE_P (f))
994     ns_raise_frame (f);
998 void
999 x_make_frame_invisible (struct frame *f)
1000 /* --------------------------------------------------------------------------
1001      External: Hide the window (X11 semantics)
1002    -------------------------------------------------------------------------- */
1004   NSView * view = FRAME_NS_VIEW (f);
1005   NSTRACE (x_make_frame_invisible);
1006   check_ns ();
1007   [[view window] orderOut: NSApp];
1011 void
1012 x_iconify_frame (struct frame *f)
1013 /* --------------------------------------------------------------------------
1014      External: Iconify window
1015    -------------------------------------------------------------------------- */
1017   NSView * view = FRAME_NS_VIEW (f);
1018   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1019   NSTRACE (x_iconify_frame);
1020   check_ns ();
1022   if (dpyinfo->ns_highlight_frame == f)
1023     dpyinfo->ns_highlight_frame = 0;
1025   if ([[view window] windowNumber] <= 0)
1026     {
1027       /* the window is still deferred.  Make it very small, bring it
1028          on screen and order it out. */
1029       NSRect s = { { 100, 100}, {0, 0} };
1030       NSRect t;
1031       t = [[view window] frame];
1032       [[view window] setFrame: s display: NO];
1033       [[view window] orderBack: NSApp];
1034       [[view window] orderOut: NSApp];
1035       [[view window] setFrame: t display: NO];
1036     }
1037   [[view window] miniaturize: NSApp];
1041 void
1042 x_destroy_window (struct frame *f)
1043 /* --------------------------------------------------------------------------
1044      External: Delete the window
1045    -------------------------------------------------------------------------- */
1047   NSView *view = FRAME_NS_VIEW (f);
1048   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1049   NSTRACE (x_destroy_window);
1050   check_ns ();
1052   [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */
1054   BLOCK_INPUT;
1056   free_frame_menubar (f);
1058   if (FRAME_FACE_CACHE (f))
1059     free_frame_faces (f);
1061   if (f == dpyinfo->ns_focus_frame)
1062     dpyinfo->ns_focus_frame = 0;
1063   if (f == dpyinfo->ns_highlight_frame)
1064     dpyinfo->ns_highlight_frame = 0;
1065   if (f == dpyinfo->mouse_face_mouse_frame)
1066     {
1067       dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
1068       dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
1069       dpyinfo->mouse_face_window = Qnil;
1070       dpyinfo->mouse_face_deferred_gc = 0;
1071       dpyinfo->mouse_face_mouse_frame = 0;
1072     }
1074   xfree (f->output_data.ns);
1076   [[view window] close];
1077   [view release];
1079   ns_window_num--;
1080   UNBLOCK_INPUT;
1084 void
1085 x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
1086 /* --------------------------------------------------------------------------
1087      External: Position the window
1088    -------------------------------------------------------------------------- */
1090   NSScreen *screen;
1091   NSView *view = FRAME_NS_VIEW (f);
1093   NSTRACE (x_set_offset);
1095   BLOCK_INPUT;
1097   f->left_pos = xoff;
1098   f->top_pos = yoff;
1099 #ifdef NS_IMPL_GNUSTEP
1100   if (xoff < 100)
1101     f->left_pos = 100;  /* don't overlap menu */
1102 #endif
1103   if (view != nil && (screen = [[view window] screen]))
1104     [[view window] setFrameTopLeftPoint:
1105         NSMakePoint (SCREENMAXBOUND (f->left_pos),
1106                      SCREENMAXBOUND ([screen frame].size.height
1107                                      - NS_TOP_POS (f)))];
1108   UNBLOCK_INPUT;
1112 void
1113 x_set_window_size (struct frame *f, int change_grav, int cols, int rows)
1114 /* --------------------------------------------------------------------------
1115      Adjust window pixel size based on given character grid size
1116      Impl is a bit more complex than other terms, need to do some
1117      internal clipping and also pay attention to screen constraints.
1118    -------------------------------------------------------------------------- */
1120   EmacsView *view = FRAME_NS_VIEW (f);
1121   EmacsToolbar *toolbar = [view toolbar];
1122   NSWindow *window = [view window];
1123   NSScreen *screen = [window screen];
1124   NSRect wr = [window frame];
1125   int tb = FRAME_EXTERNAL_TOOL_BAR (f);
1126   int pixelwidth, pixelheight;
1127   static int oldRows, oldCols, oldFontWidth, oldFontHeight;
1128   static int oldTB;
1129   static struct frame *oldF;
1131   NSTRACE (x_set_window_size);
1133   if (view == nil ||
1134       (f == oldF
1135        && rows == oldRows && cols == oldCols
1136        && oldFontWidth == FRAME_COLUMN_WIDTH (f)
1137        && oldFontHeight == FRAME_LINE_HEIGHT (f)
1138        && oldTB == tb))
1139     return;
1141 /*fprintf (stderr, "\tsetWindowSize: %d x %d, font size %d x %d\n", cols, rows, FRAME_COLUMN_WIDTH (f), FRAME_LINE_HEIGHT (f)); */
1143   BLOCK_INPUT;
1145   check_frame_size (f, &rows, &cols);
1146   oldF = f;
1147   oldRows = rows;
1148   oldCols = cols;
1149   oldFontWidth = FRAME_COLUMN_WIDTH (f);
1150   oldFontHeight = FRAME_LINE_HEIGHT (f);
1151   oldTB = tb;
1153   f->scroll_bar_actual_width = NS_SCROLL_BAR_WIDTH (f);
1154   compute_fringe_widths (f, 0);
1156   pixelwidth =  FRAME_TEXT_COLS_TO_PIXEL_WIDTH   (f, cols);
1157   pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
1158   
1159   /* If we have a change in toolbar display, calculate height */
1160   if (tb)
1161     /* PENDING: GNUstep has not yet implemented the first method below, added
1162                 in Panther, however the second is incorrect under Cocoa. */
1163 #ifdef NS_IMPL_GNUSTEP
1164     FRAME_NS_TOOLBAR_HEIGHT (f)
1165       = NSHeight ([NSWindow frameRectForContentRect: NSMakeRect (0, 0, 0, 0)
1166                             styleMask: [window styleMask]])
1167         - FRAME_NS_TITLEBAR_HEIGHT (f);
1168 #else
1169     FRAME_NS_TOOLBAR_HEIGHT (f) = 32;
1170       /* actually get wrong result here if toolbar not yet displayed
1171          NSHeight ([window frameRectForContentRect: NSMakeRect (0, 0, 0, 0)])
1172          - FRAME_NS_TITLEBAR_HEIGHT (f); */
1173 #endif
1174   else
1175     FRAME_NS_TOOLBAR_HEIGHT (f) = 0;
1177   wr.size.width = pixelwidth + f->border_width;
1178   wr.size.height = pixelheight + FRAME_NS_TITLEBAR_HEIGHT (f) 
1179                   + FRAME_NS_TOOLBAR_HEIGHT (f);
1181   /* constrain to screen if we can */
1182   if (screen)
1183     {
1184       NSSize sz = [screen visibleFrame].size;
1185       NSSize ez = { wr.size.width - sz.width, wr.size.height - sz.height };
1186       if (ez.width > 0)
1187         {
1188           int cr = ez.width / FRAME_COLUMN_WIDTH (f) + 1;
1189           cols -= cr;
1190           oldCols = cols;
1191           wr.size.width -= cr * FRAME_COLUMN_WIDTH (f);
1192           pixelwidth -= cr * FRAME_COLUMN_WIDTH (f);
1193         }
1194       if (ez.height > 0)
1195         {
1196           int rr = ez.height / FRAME_LINE_HEIGHT (f) + 1;
1197           rows -= rr;
1198           oldRows = rows;
1199           wr.size.height -= rr * FRAME_LINE_HEIGHT (f);
1200           pixelheight -= rr * FRAME_LINE_HEIGHT (f);
1201         }
1202       wr.origin.x = f->left_pos;
1203       wr.origin.y = [screen frame].size.height - NS_TOP_POS (f)
1204         - wr.size.height;
1205     }
1207   [view setRows: rows andColumns: cols];
1208   [window setFrame: wr display: YES];
1210 /*fprintf (stderr, "\tx_set_window_size %d, %d\t%d, %d\n", cols, rows, pixelwidth, pixelheight); */
1212   /* This is a trick to compensate for Emacs' managing the scrollbar area
1213      as a fixed number of standard character columns.  Instead of leaving
1214      blank space for the extra, we chopped it off above.  Now for
1215      left-hand scrollbars, we shift all rendering to the left by the
1216      difference between the real width and Emacs' imagined one.  For
1217      right-hand bars, don't worry about it since the extra is never used.
1218      (Obviously doesn't work for vertically split windows tho..) */
1219   NSPoint origin = FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)
1220     ? NSMakePoint (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)
1221                   - NS_SCROLL_BAR_WIDTH (f), 0)
1222     : NSMakePoint (0, 0);
1223   [view setFrame: NSMakeRect (0, 0, pixelwidth, pixelheight)];
1224   [view setBoundsOrigin: origin];
1226   change_frame_size (f, rows, cols, 0, 1, 0); /* pretend, delay, safe */
1227   FRAME_PIXEL_WIDTH (f) = pixelwidth;
1228   FRAME_PIXEL_HEIGHT (f) = pixelheight;
1229 /*  SET_FRAME_GARBAGED (f); // this short-circuits expose call in drawRect */
1231   mark_window_cursors_off (XWINDOW (f->root_window));
1232   cancel_mouse_face (f);
1234   UNBLOCK_INPUT;
1238 /* ==========================================================================
1240     Color management
1242    ========================================================================== */
1244 NSColor *
1245 ns_lookup_indexed_color (unsigned long idx, struct frame *f)
1247   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1248   return color_table->colors[idx];
1252 unsigned long
1253 ns_index_color (NSColor *color, struct frame *f)
1255   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1256   int idx;
1257   NSNumber *index;
1259   if (!color_table->colors)
1260     {
1261       color_table->size = NS_COLOR_CAPACITY;
1262       color_table->avail = 1; /* skip idx=0 as marker */
1263       color_table->colors
1264         = (NSColor **)xmalloc (color_table->size * sizeof (NSColor *));
1265       color_table->empty_indices = [[NSMutableSet alloc] init];
1266     }
1268   /* do we already have this color ? */
1269   {
1270     int i;
1271     for (i = 1; i < color_table->avail; i++)
1272       {
1273         if (color_table->colors[i] && [color_table->colors[i] isEqual: color])
1274           {
1275             [color_table->colors[i] retain];
1276             return i;
1277           }
1278       }
1279   }
1281   if ([color_table->empty_indices count] > 0)
1282     {
1283       index = [color_table->empty_indices anyObject];
1284       [color_table->empty_indices removeObject: index];
1285       idx = [index unsignedIntValue];
1286     }
1287   else
1288     {
1289       if (color_table->avail == color_table->size)
1290         {
1291           color_table->size += NS_COLOR_CAPACITY;
1292           color_table->colors
1293             = (NSColor **)xrealloc (color_table->colors,
1294                                     color_table->size * sizeof (NSColor *));
1295         }
1296       idx = color_table->avail++;
1297       index = [NSNumber numberWithUnsignedInt: idx];
1298     }
1300   color_table->colors[idx] = color;
1301   [color retain];
1302 /*fprintf(stderr, "color_table: allocated %d\n",idx);*/
1303   return idx;
1307 void
1308 ns_free_indexed_color (unsigned long idx, struct frame *f)
1310   struct ns_color_table *color_table = FRAME_NS_DISPLAY_INFO (f)->color_table;
1311   NSColor *color;
1312   if (!idx)
1313     return;
1314   color = color_table->colors[idx];
1315   [color release];
1316   color_table->colors[idx] = nil;
1317   [color_table->empty_indices addObject: [NSNumber numberWithUnsignedInt: idx]];
1318 /*fprintf(stderr, "color_table: FREED %d\n",idx);*/
1322 static int
1323 ns_get_color (const char *name, NSColor **col)
1324 /* --------------------------------------------------------------------------
1325      Parse a color name
1326 /* --------------------------------------------------------------------------
1327 /* On *Step, we recognize several color formats, in addition to a catalog
1328    of colors found in the file Emacs.clr. Color formats include:
1329    - #rrggbb or RGBrrggbb where rr, gg, bb specify red, green and blue in hex
1330    - ARGBaarrggbb is similar, with aa being the alpha channel (FF = opaque)
1331    - HSVhhssvv and AHSVaahhssvv are similar for hue, saturation, value
1332    - CMYKccmmyykk is similar for cyan, magenta, yellow, black. */
1334   NSColor * new = nil;
1335   const char *hex = NULL;
1336   enum { rgb, argb, hsv, ahsv, cmyk, gray } color_space;
1337   NSString *nsname = [NSString stringWithUTF8String: name];
1339 /*fprintf (stderr, "ns_get_color: '%s'\n", name); */
1340   BLOCK_INPUT;
1342   if ([nsname isEqualToString: @"ns_selection_color"])
1343     {
1344       nsname = ns_selection_color;
1345       name = [ns_selection_color UTF8String];
1346     }
1348   if (name[0] == '0' || name[0] == '1' || name[0] == '.')
1349     {
1350       /* RGB decimal */
1351       NSScanner *scanner = [NSScanner scannerWithString: nsname];
1352       float r, g, b;
1353       [scanner scanFloat: &r];
1354       [scanner scanFloat: &g];
1355       [scanner scanFloat: &b];
1356       *col = [NSColor colorWithCalibratedRed: r green: g blue: b alpha: 1.0];
1357       UNBLOCK_INPUT;
1358       return 0;
1359     }
1361   /* 23: PENDING: emacs seems to downcase everything before passing it here,
1362      which we can work around, except for GRAY, since gray##, where ## is
1363      decimal between 0 and 99, is also an X11 colorname. */
1364   if (name[0] == '#')             /* X11 format */
1365     {
1366       hex = name + 1;
1367       color_space = rgb;
1368     }
1369   else if (!memcmp (name, "RGB", 3) || !memcmp (name, "rgb", 3))
1370     {
1371       hex = name + 3;
1372       color_space = rgb;
1373     }
1374   else if (!memcmp (name, "ARGB", 4) || !memcmp (name, "argb", 4))
1375     {
1376       hex = name + 4;
1377       color_space = argb;
1378     }
1379   else if (!memcmp (name, "HSV", 3) || !memcmp (name, "hsv", 3))
1380     {
1381       hex = name + 3;
1382       color_space = hsv;
1383     }
1384   else if (!memcmp (name, "AHSV", 4) || !memcmp (name, "ahsv", 4))
1385     {
1386       hex = name + 4;
1387       color_space = ahsv;
1388     }
1389   else if (!memcmp (name, "CMYK", 4) || !memcmp (name, "cmyk", 4))
1390     {
1391       hex = name + 4;
1392       color_space = cmyk;
1393     }
1394   else if (!memcmp (name, "GRAY", 4) /*|| !memcmp (name, "gray", 4)*/)
1395     {
1396       hex = name + 4;
1397       color_space = gray;
1398     }
1400   /* Direct colors (hex values) */
1401   if (hex)
1402     {
1403       unsigned int color = 0;
1404       if (sscanf (hex, "%x", &color))
1405         {
1406           float f1 = ((color >> 24) & 0xff) / 255.0;
1407           float f2 = ((color >> 16) & 0xff) / 255.0;
1408           float f3 = ((color >>  8) & 0xff) / 255.0;
1409           float f4 = ((color      ) & 0xff) / 255.0;
1411           switch (color_space)
1412             {
1413             case rgb:
1414               *col = [NSColor colorWithCalibratedRed: f2
1415                                                green: f3
1416                                                 blue: f4
1417                                                alpha: 1.0];
1418               break;
1419             case argb:
1420               *col = [NSColor colorWithCalibratedRed: f2
1421                                                green: f3
1422                                                 blue: f4
1423                                                alpha: f1];
1424               break;
1425             case hsv:
1426               *col = [NSColor colorWithCalibratedHue: f2
1427                                           saturation: f3
1428                                           brightness: f4
1429                                                alpha: 1.0];
1430               break;
1431             case ahsv:
1432               *col = [NSColor colorWithCalibratedHue: f2
1433                                           saturation: f3
1434                                           brightness: f4
1435                                                alpha: f1];
1436               break;
1437             case gray:
1438               *col = [NSColor colorWithCalibratedWhite: f3 alpha: f4];
1439               break;
1440             case cmyk:
1441               *col = [NSColor colorWithDeviceCyan: f1
1442                                           magenta: f2
1443                                            yellow: f3
1444                                             black: f4
1445                                             alpha: 1.0];
1446               break;
1447             }
1448           *col = [*col colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1449           UNBLOCK_INPUT;
1450           return 0;
1451         }
1452     }
1454   /* Otherwise, color is expected to be from a list */
1455   {
1456     NSEnumerator *lenum, *cenum;
1457     NSString *name;
1458     NSColorList *clist;
1459 #ifdef NS_IMPL_GNUSTEP
1460     /* PENDING: who is wrong, the requestor or the implementation? */
1461     if ([nsname compare: @"Highlight" options: NSCaseInsensitiveSearch]
1462         == NSOrderedSame)
1463       nsname = @"highlightColor";
1464 #endif
1465     if ([nsname compare: @"dark blue" options: NSCaseInsensitiveSearch]
1466         == NSOrderedSame
1467       || [nsname compare: @"darkblue" options: NSCaseInsensitiveSearch]
1468         == NSOrderedSame)
1469       nsname = @"navy blue";
1471     lenum = [[NSColorList availableColorLists] objectEnumerator];
1472     while ( (clist = [lenum nextObject]) && new == nil)
1473       {
1474         cenum = [[clist allKeys] objectEnumerator];
1475         while ( (name = [cenum nextObject]) && new == nil )
1476           {
1477             if ([name compare: nsname
1478                       options: NSCaseInsensitiveSearch] == NSOrderedSame )
1479               new = [clist colorWithKey: name];
1480           }
1481       }
1482   }
1484   if ( new )
1485     *col = [new colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
1486 /*     else
1487        NSLog (@"Failed to find color '%@'", nsname); */
1488   UNBLOCK_INPUT;
1489   return new ? 0 : 1;
1493 static NSColor *
1494 ns_get_color_default (const char *name, NSColor *dflt)
1495 /* --------------------------------------------------------------------------
1496      Parse a color or use a default value
1497    -------------------------------------------------------------------------- */
1499   NSColor * col;
1501   if (ns_get_color (name, &col))
1502     return dflt;
1503   else
1504     return col;
1509 ns_lisp_to_color (Lisp_Object color, NSColor **col)
1510 /* --------------------------------------------------------------------------
1511      Convert a Lisp string object to a NS color
1512    -------------------------------------------------------------------------- */
1514   NSTRACE (ns_lisp_to_color);
1515   if (STRINGP (color))
1516     return ns_get_color (SDATA (color), col);
1517   else if (SYMBOLP (color))
1518     return ns_get_color (SDATA (SYMBOL_NAME (color)), col);
1519   return 1;
1523 Lisp_Object
1524 ns_color_to_lisp (NSColor *col)
1525 /* --------------------------------------------------------------------------
1526      Convert a color to a lisp string with the RGB equivalent
1527    -------------------------------------------------------------------------- */
1529   float red, green, blue, alpha, gray;
1530   char buf[1024];
1531   const char *str;
1532   NSTRACE (ns_color_to_lisp);
1534   BLOCK_INPUT;
1535   if ([[col colorSpaceName] isEqualToString: NSNamedColorSpace])
1537       if ((str =[[col colorNameComponent] UTF8String]))
1538         {
1539           UNBLOCK_INPUT;
1540           return build_string ((char *)str);
1541         }
1543     [[col colorUsingColorSpaceName: NSCalibratedRGBColorSpace]
1544         getRed: &red green: &green blue: &blue alpha: &alpha];
1545   if (red ==green && red ==blue)
1546     {
1547       [[col colorUsingColorSpaceName: NSCalibratedWhiteColorSpace]
1548             getWhite: &gray alpha: &alpha];
1549       snprintf (buf, sizeof (buf), "GRAY%02.2lx%02.2lx",
1550                lrint (gray * 0xff), lrint (alpha * 0xff));
1551       UNBLOCK_INPUT;
1552       return build_string (buf);
1553     }
1555   snprintf (buf, sizeof (buf), "ARGB%02.2lx%02.2lx%02.2lx%02.2lx",
1556             lrint (alpha*0xff),
1557             lrint (red*0xff), lrint (green*0xff), lrint (blue*0xff));
1559   UNBLOCK_INPUT;
1560   return build_string (buf);
1565 ns_defined_color (struct frame *f, char *name, XColor *color_def, int alloc,
1566                   char makeIndex)
1567 /* --------------------------------------------------------------------------
1568    23:   Return 1 if named color found, and set color_def rgb accordingly.
1569          If makeIndex and alloc are nonzero put the color in the color_table,
1570          and set color_def pixel to the resulting index.
1571          If makeIndex is zero, set color_def pixel to ARGB.
1572          Return 0 if not found
1573    -------------------------------------------------------------------------- */
1575   NSColor *temp;
1576   float r, g, b, a;
1577   int notFound = ns_get_color (name, &temp);
1579   NSTRACE (ns_defined_color);
1581   if (notFound)
1582     return 0;
1584   if (makeIndex && alloc)
1585       color_def->pixel = ns_index_color(temp, f);//[temp retain];
1587   [temp getRed: &r green: &g blue: &b alpha: &a];
1588   color_def->red   = r * 256;
1589   color_def->green = g * 256;
1590   color_def->blue  = b * 256;
1592   if (!makeIndex)
1593     color_def->pixel
1594       = ARGB_TO_ULONG((int)(a*256),
1595                       color_def->red, color_def->green, color_def->blue);
1597   return 1;
1601 unsigned long
1602 ns_get_rgb_color (struct frame *f, float r, float g, float b, float a)
1603 /* --------------------------------------------------------------------------
1604     return an autoreleased RGB color
1605    -------------------------------------------------------------------------- */
1607 /*static int c = 1; fprintf (stderr, "color request %d\n", c++); */
1608   if (r < 0.0) r = 0.0;
1609   else if (r > 1.0) r = 1.0;
1610   if (g < 0.0) g = 0.0;
1611   else if (g > 1.0) g = 1.0;
1612   if (b < 0.0) b = 0.0;
1613   else if (b > 1.0) b = 1.0;
1614   if (a < 0.0) a = 0.0;
1615   else if (a > 1.0) a = 1.0;
1616   return (unsigned long) ns_index_color(
1617     [NSColor colorWithCalibratedRed: r green: g blue: b alpha: a], f);
1622 /* ==========================================================================
1624     Mouse handling
1626    ========================================================================== */
1629 void
1630 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
1631 /* --------------------------------------------------------------------------
1632      Programmatically reposition mouse pointer in pixel coordinates
1633    -------------------------------------------------------------------------- */
1635   NSTRACE (x_set_mouse_pixel_position);
1636   ns_raise_frame (f);
1637 #if 0
1638   /*PENDING: this does not work, and what about GNUstep? */
1639 #ifdef NS_IMPL_COCOA
1640   [FRAME_NS_VIEW (f) lockFocus];
1641   PSsetmouse ((float)pix_x, (float)pix_y);
1642   [FRAME_NS_VIEW (f) unlockFocus];
1643 #endif
1644 #endif
1648 void
1649 x_set_mouse_position (struct frame *f, int h, int v)
1650 /* --------------------------------------------------------------------------
1651      Programmatically reposition mouse pointer in character coordinates
1652    -------------------------------------------------------------------------- */
1654   int pix_x, pix_y;
1656   pix_x = FRAME_COL_TO_PIXEL_X (f, h) + FRAME_COLUMN_WIDTH (f) / 2;
1657   pix_y = FRAME_LINE_TO_PIXEL_Y (f, v) + FRAME_LINE_HEIGHT (f) / 2;
1659   if (pix_x < 0) pix_x = 0;
1660   if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
1662   if (pix_y < 0) pix_y = 0;
1663   if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
1665   x_set_mouse_pixel_position (f, pix_x, pix_y);
1669 static int
1670 note_mouse_movement (struct frame *frame, float x, float y)
1671 /*   ------------------------------------------------------------------------
1672      Called by EmacsView on mouseMovement events.  Passes on
1673      to emacs mainstream code if we moved off of a rect of interest
1674      known as last_mouse_glyph.
1675      ------------------------------------------------------------------------ */
1677   NSTRACE (note_mouse_movement);
1679   XSETFRAME (last_mouse_motion_frame, frame);
1680   
1681   /* Note, this doesn't get called for enter/leave, since we don't have a
1682      position.  Those are taken care of in the corresponding NSView methods. */
1684   /* has movement gone beyond last rect we were tracking? */
1685   if (x < last_mouse_glyph.origin.x ||
1686       x >= (last_mouse_glyph.origin.x + last_mouse_glyph.size.width) ||
1687       y < last_mouse_glyph.origin.y ||
1688       y >= (last_mouse_glyph.origin.y + last_mouse_glyph.size.height))
1689     {
1690       frame->mouse_moved = 1;
1691       note_mouse_highlight (frame, x, y);
1692       remember_mouse_glyph (frame, x, y, &last_mouse_glyph);
1693       return 1;
1694     }
1696   return 0;
1700 static void
1701 ns_mouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
1702                    enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
1703                    unsigned long *time)
1704 /* --------------------------------------------------------------------------
1705     External (hook): inform emacs about mouse position and hit parts.
1706     If a scrollbar is being dragged, set bar_window, part, x, y, time.
1707     x & y should be position in the scrollbar (the whole bar, not the handle)
1708     and length of scrollbar respectively
1709    -------------------------------------------------------------------------- */
1711   id view;
1712   NSPoint position;
1713   int xchar, ychar;
1714   Lisp_Object frame, tail;
1715   struct frame *f;
1716   struct ns_display_info *dpyinfo;
1718   NSTRACE (ns_mouse_position);
1720   if (*fp == NULL)
1721     {
1722       fprintf (stderr, "Warning: ns_mouse_position () called with null *fp.\n");
1723       return;
1724     }
1726   dpyinfo = FRAME_NS_DISPLAY_INFO (*fp);
1728   BLOCK_INPUT;
1730   if (last_mouse_scroll_bar != nil && insist == 0)
1731     {
1732       /* PENDING: we do not use this path at the moment because drag events will
1733          go directly to the EmacsScroller.  Leaving code in for now. */
1734       [last_mouse_scroll_bar getMouseMotionPart: (int *)part window: bar_window
1735                                               x: x y: y];
1736       if (time) *time = last_mouse_movement_time;
1737       last_mouse_scroll_bar = nil;
1738     }
1739   else
1740     {
1741       /* Clear the mouse-moved flag for every frame on this display.  */
1742       FOR_EACH_FRAME (tail, frame)
1743         if (FRAME_NS_P (XFRAME (frame))
1744             && FRAME_NS_DISPLAY (XFRAME (frame)) == FRAME_NS_DISPLAY (*fp))
1745           XFRAME (frame)->mouse_moved = 0;
1747       last_mouse_scroll_bar = nil;
1748       if (last_mouse_frame && FRAME_LIVE_P (last_mouse_frame))
1749         f = last_mouse_frame;
1750       else
1751         f = dpyinfo->ns_focus_frame ? dpyinfo->ns_focus_frame
1752                                     : SELECTED_FRAME ();
1754       if (f && f->output_data.ns)  /*PENDING: 2nd check no longer needed? */
1755         {
1756           view = FRAME_NS_VIEW (*fp);
1758           position = [[view window] mouseLocationOutsideOfEventStream];
1759           position = [view convertPoint: position fromView: nil];
1760           remember_mouse_glyph (f, position.x, position.y, &last_mouse_glyph);
1761 /*fprintf (stderr, "ns_mouse_position: %.0f, %.0f\n", position.x, position.y); */
1763           if (bar_window) *bar_window = Qnil;
1764           if (part) *part = 0; /*scroll_bar_handle; */
1766           if (x) XSETINT (*x, lrint (position.x));
1767           if (y) XSETINT (*y, lrint (position.y));
1768           if (time) *time = last_mouse_movement_time;
1769           *fp = f;
1770         }
1771     }
1773   UNBLOCK_INPUT;
1777 static void
1778 ns_frame_up_to_date (struct frame *f)
1779 /* --------------------------------------------------------------------------
1780     External (hook): Fix up mouse highlighting right after a full update.
1781     Some highlighting was deferred if GC was happening during
1782     note_mouse_highlight (), while other highlighting was deferred for update.
1783    -------------------------------------------------------------------------- */
1785   NSTRACE (ns_frame_up_to_date);
1787   if (FRAME_NS_P (f))
1788     {
1789       struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (f);
1790       if ((dpyinfo->mouse_face_deferred_gc||f ==dpyinfo->mouse_face_mouse_frame)
1791       /*&& dpyinfo->mouse_face_mouse_frame*/)
1792         {
1793           BLOCK_INPUT;
1794           if (dpyinfo->mouse_face_mouse_frame)
1795             note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
1796                                   dpyinfo->mouse_face_mouse_x,
1797                                   dpyinfo->mouse_face_mouse_y);
1798           dpyinfo->mouse_face_deferred_gc = 0;
1799           UNBLOCK_INPUT;
1800         }
1801     }
1805 void
1806 ns_define_frame_cursor (struct frame *f, Cursor cursor)
1807 /* --------------------------------------------------------------------------
1808     External (RIF): set frame mouse pointer type.
1809    -------------------------------------------------------------------------- */
1811   NSTRACE (ns_define_frame_cursor);
1812   if (FRAME_POINTER_TYPE (f) != cursor)
1813     {
1814       EmacsView *view = FRAME_NS_VIEW (f);
1815       FRAME_POINTER_TYPE (f) = cursor;
1816       [[view window] invalidateCursorRectsForView: view];
1817     }
1822 /* ==========================================================================
1824     Keyboard handling
1826    ========================================================================== */
1829 static unsigned
1830 ns_convert_key (unsigned code)
1831 /* --------------------------------------------------------------------------
1832     Internal call used by NSView-keyDown.
1833    -------------------------------------------------------------------------- */
1835   const unsigned last_keysym = (sizeof (convert_ns_to_X_keysym)
1836                                 / sizeof (convert_ns_to_X_keysym[0]));
1837   unsigned keysym;
1838   /* An array would be faster, but less easy to read. */
1839   for (keysym = 0; keysym < last_keysym; keysym += 2)
1840     if (code == convert_ns_to_X_keysym[keysym])
1841       return 0xFF00 | convert_ns_to_X_keysym[keysym+1];
1842   return 0;
1843 /* if decide to use keyCode and Carbon table, use this line:
1844      return code > 0xff ? 0 : 0xFF00 | ns_keycode_to_xkeysym_table[code]; */
1848 char *
1849 x_get_keysym_name (int keysym)
1850 /* --------------------------------------------------------------------------
1851     Called by keyboard.c.  Not sure if the return val is important, except
1852     that it be unique.
1853    -------------------------------------------------------------------------- */
1855   static char value[16];
1856   NSTRACE (x_get_keysym_name);
1857   sprintf (value, "%d", keysym);
1858   return value;
1863 /* ==========================================================================
1865     Block drawing operations
1867    ========================================================================== */
1870 static void
1871 ns_redraw_scroll_bars (struct frame *f)
1873   int i;
1874   id view;
1875   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
1876   NSTRACE (ns_judge_scroll_bars);
1877   for (i =[subviews count]-1; i >= 0; i--)
1878     {
1879       view = [subviews objectAtIndex: i];
1880       if (![view isKindOfClass: [EmacsScroller class]]) continue;
1881       [view display];
1882     }
1886 void
1887 ns_clear_frame (struct frame *f)
1888 /* --------------------------------------------------------------------------
1889       External (hook): Erase the entire frame
1890    -------------------------------------------------------------------------- */
1892   NSView *view = FRAME_NS_VIEW (f);
1893   NSRect r;
1895   NSTRACE (ns_clear_frame);
1896   if (ns_in_resize)
1897     return;
1899  /* comes on initial frame because we have
1900     after-make-frame-functions = select-frame */
1901  if (!FRAME_DEFAULT_FACE (f))
1902    return;
1904   mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
1906   output_cursor.hpos = output_cursor.vpos = 0;
1907   output_cursor.x = -1;
1909   r = [view bounds];
1911   BLOCK_INPUT;
1912   ns_focus (f, &r, 1);
1913   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (FRAME_DEFAULT_FACE (f)), f) set];
1914   NSRectFill (r);
1915   ns_unfocus (f);
1917 #ifdef NS_IMPL_COCOA
1918   [[view window] display];  /* redraw resize handle */
1919 #endif
1921   /* as of 2006/11 or so this is now needed */
1922   ns_redraw_scroll_bars (f);
1923   UNBLOCK_INPUT;
1927 void
1928 ns_clear_frame_area (struct frame *f, int x, int y, int width, int height)
1929 /* --------------------------------------------------------------------------
1930    23: External (RIF):  Clear section of frame
1931    -------------------------------------------------------------------------- */
1933   NSRect r = NSMakeRect (x, y, width, height);
1934   NSView *view = FRAME_NS_VIEW (f);
1935   struct face *face = FRAME_DEFAULT_FACE (f);
1937   if (!view || !face)
1938     return;
1940   r = NSIntersectionRect (r, [view frame]);
1941   ns_focus (f, &r, 1);
1942   [ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), f) set];
1944 #ifdef NS_IMPL_COCOA
1945   {
1946     /* clip out the resize handle */
1947     NSWindow *window = [FRAME_NS_VIEW (f) window];
1948     NSRect ir
1949       = [view convertRect: ns_resize_handle_rect (window) fromView: nil];
1951     ir = NSIntersectionRect (r, ir);
1952     if (NSIsEmptyRect (ir))
1953       {
1954 #endif
1956   NSRectFill (r);
1958 #ifdef NS_IMPL_COCOA
1959       }
1960     else
1961       {
1962         NSRect r1 = r, r2 = r; /* upper and lower non-intersecting */
1963         r1.size.height -= ir.size.height;
1964         r2.origin.y += r1.size.height;
1965         r2.size.width -= ir.size.width;
1966         r2.size.height = ir.size.height;
1967         NSRectFill (r1);
1968         NSRectFill (r2);
1969       }
1970   }
1971 #endif
1973   ns_unfocus (f);
1974   return;
1978 static void
1979 ns_scroll_run (struct window *w, struct run *run)
1980 /* --------------------------------------------------------------------------
1981    23: External (RIF):  Insert or delete n lines at line vpos
1982    -------------------------------------------------------------------------- */
1984   struct frame *f = XFRAME (w->frame);
1985   int x, y, width, height, from_y, to_y, bottom_y;
1987   NSTRACE (ns_scroll_run);
1989   /* begin copy from other terms */
1990   /* Get frame-relative bounding box of the text display area of W,
1991      without mode lines.  Include in this box the left and right
1992      fringe of W.  */
1993   window_box (w, -1, &x, &y, &width, &height);
1995   from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
1996   to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
1997   bottom_y = y + height;
1999   if (to_y < from_y)
2000     {
2001       /* Scrolling up.  Make sure we don't copy part of the mode
2002          line at the bottom.  */
2003       if (from_y + run->height > bottom_y)
2004         height = bottom_y - from_y;
2005       else
2006         height = run->height;
2007     }
2008   else
2009     {
2010       /* Scolling down.  Make sure we don't copy over the mode line.
2011          at the bottom.  */
2012       if (to_y + run->height > bottom_y)
2013         height = bottom_y - to_y;
2014       else
2015         height = run->height;
2016     }
2017   /* end copy from other terms */
2019   if (height == 0)
2020       return;
2022   BLOCK_INPUT;
2024   updated_window = w;
2025   x_clear_cursor (w);
2027   {
2028     NSRect srcRect = NSMakeRect (x, from_y, width, height);
2029     NSRect dstRect = NSMakeRect (x, to_y, width, height);
2030     NSPoint dstOrigin = NSMakePoint (x, to_y);
2032     ns_focus (f, &dstRect, 1);
2033     NSCopyBits (0, srcRect , dstOrigin);
2034     ns_unfocus (f);
2035   }
2037   UNBLOCK_INPUT;
2041 static void
2042 ns_after_update_window_line (struct glyph_row *desired_row)
2043 /* --------------------------------------------------------------------------
2044    23: External (RIF): preparatory to fringe update after text was updated
2045    -------------------------------------------------------------------------- */
2047   struct window *w = updated_window;
2048   struct frame *f;
2049   int width, height;
2051   NSTRACE (ns_after_update_window_line);
2053   /* begin copy from other terms */
2054   xassert (w);
2056   if (!desired_row->mode_line_p && !w->pseudo_window_p)
2057     desired_row->redraw_fringe_bitmaps_p = 1;
2059   /* When a window has disappeared, make sure that no rest of
2060      full-width rows stays visible in the internal border.
2061      Under NS this is drawn inside the fringes. */
2062   if (windows_or_buffers_changed
2063       && (f = XFRAME (w->frame),
2064           width = FRAME_INTERNAL_BORDER_WIDTH (f),
2065           width != 0)
2066       && (height = desired_row->visible_height,
2067           height > 0))
2068     {
2069       int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
2071       /* Internal border is drawn below the tool bar.  */
2072       if (WINDOWP (f->tool_bar_window)
2073           && w == XWINDOW (f->tool_bar_window))
2074         y -= width;
2075       /* end copy from other terms */
2077       BLOCK_INPUT;
2078       if (!desired_row->full_width_p)
2079         {
2080           int x1 = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2081             + WINDOW_LEFT_FRINGE_WIDTH (w);
2082           int x2 = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2083             + FRAME_PIXEL_WIDTH (f) - NS_SCROLL_BAR_WIDTH (f)
2084             - WINDOW_RIGHT_FRINGE_WIDTH (w)
2085             - FRAME_INTERNAL_BORDER_WIDTH (f);
2086           ns_clear_frame_area (f, x1, y, width, height);
2087           ns_clear_frame_area (f, x2, y, width, height);
2088         }
2089       UNBLOCK_INPUT;
2090     }
2094 static void
2095 ns_shift_glyphs_for_insert (struct frame *f,
2096                            int x, int y, int width, int height,
2097                            int shift_by)
2098 /* --------------------------------------------------------------------------
2099    23: External (RIF): copy an area horizontally, don't worry about clearing src
2100    -------------------------------------------------------------------------- */
2102   NSRect srcRect = NSMakeRect (x, y, width, height);
2103   NSRect dstRect = NSMakeRect (x+shift_by, y, width, height);
2104   NSPoint dstOrigin = dstRect.origin;
2106   NSTRACE (ns_shift_glyphs_for_insert);
2108   ns_focus (f, &dstRect, 1);
2109   NSCopyBits (0, srcRect, dstOrigin);
2110   ns_unfocus (f);
2115 /* ==========================================================================
2117     Character encoding and metrics
2119    ========================================================================== */
2122 static inline void
2123 ns_compute_glyph_string_overhangs (struct glyph_string *s)
2124 /* --------------------------------------------------------------------------
2125    23:  External (RIF); compute left/right overhang of whole string and set in s
2126    -------------------------------------------------------------------------- */
2128   struct face *face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2129   struct font *font = s->font; /*face->font; */
2131   if (s->char2b)
2132     {
2133       struct font_metrics metrics;
2134       unsigned int codes[2];
2135       codes[0] = *(s->char2b);
2136       codes[1] = *(s->char2b + s->nchars - 1);
2138       font->driver->text_extents (font, codes, 2, &metrics);
2139       s->left_overhang = -metrics.lbearing;
2140       s->right_overhang
2141         = metrics.rbearing > metrics.width
2142         ? metrics.rbearing - metrics.width : 0;
2143     }
2144   else
2145     {
2146       s->left_overhang = 0;
2147       s->right_overhang = ((struct nsfont_info *)font)->ital ?
2148         FONT_HEIGHT (font) * 0.2 : 0;
2149     }
2154 /* ==========================================================================
2156     Fringe and cursor drawing
2158    ========================================================================== */
2161 extern int max_used_fringe_bitmap;
2162 static void
2163 ns_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
2164                       struct draw_fringe_bitmap_params *p)
2165 /* --------------------------------------------------------------------------
2166    23: External (RIF); fringe-related
2167    -------------------------------------------------------------------------- */
2169   struct frame *f = XFRAME (WINDOW_FRAME (w));
2170   struct face *face = p->face;
2171   int rowY;
2172   static EmacsImage **bimgs = NULL;
2173   static int nBimgs = 0;
2174   /* NS-specific: move internal border inside fringe */
2175   int x = p->bx < 0 ? p->x : p->bx;
2176   int wd = p->bx < 0 ? p->wd : p->nx;
2177   BOOL fringeOnVeryLeft
2178     = x - WINDOW_LEFT_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w)
2179       - FRAME_INTERNAL_BORDER_WIDTH (f) < 10;
2180   BOOL fringeOnVeryRight
2181     = FRAME_PIXEL_WIDTH (f) - x - wd - FRAME_INTERNAL_BORDER_WIDTH (f)
2182       - WINDOW_RIGHT_SCROLL_BAR_COLS (w) * WINDOW_FRAME_COLUMN_WIDTH (w) < 10;
2183   int xAdjust = FRAME_INTERNAL_BORDER_WIDTH (f) *
2184     (fringeOnVeryLeft ? -1 : (fringeOnVeryRight ? 1 : 0));
2186   /* grow bimgs if needed */
2187   if (nBimgs < max_used_fringe_bitmap)
2188     {
2189       EmacsImage **newBimgs
2190         = xmalloc (max_used_fringe_bitmap * sizeof (EmacsImage *));
2191       bzero (newBimgs, max_used_fringe_bitmap * sizeof (EmacsImage *));
2193       if (nBimgs)
2194         {
2195           bcopy (bimgs, newBimgs, nBimgs * sizeof (EmacsImage *));
2196           xfree (bimgs);
2197         }
2199       bimgs = newBimgs;
2200       nBimgs = max_used_fringe_bitmap;
2201     }
2203   /* Must clip because of partially visible lines.  */
2204   rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
2205   if (p->y < rowY)
2206     {
2207       /* Adjust position of "bottom aligned" bitmap on partially
2208          visible last row.  */
2209       int oldY = row->y;
2210       int oldVH = row->visible_height;
2211       row->visible_height = p->h;
2212       row->y -= rowY - p->y;
2213       ns_clip_to_row (w, row, -1, NULL);
2214       row->y = oldY;
2215       row->visible_height = oldVH;
2216     }
2217   else
2218     ns_clip_to_row (w, row, -1, YES);
2220   if (p->bx >= 0 && !p->overlay_p)
2221     {
2222       int yAdjust = rowY - FRAME_INTERNAL_BORDER_WIDTH (f) < 5 ?
2223         -FRAME_INTERNAL_BORDER_WIDTH (f) : 0;
2224       int yIncr = FRAME_PIXEL_HEIGHT (f) - (p->by+yAdjust + p->ny) < 5 ?
2225         FRAME_INTERNAL_BORDER_WIDTH (f) : 0;
2226       if (yAdjust)
2227         yIncr += FRAME_INTERNAL_BORDER_WIDTH (f);
2228       NSRect r = NSMakeRect (p->bx+xAdjust, p->by+yAdjust, p->nx, p->ny+yIncr);
2229       NSRectClip (r);
2230       [ns_lookup_indexed_color(face->background, f) set];
2231       NSRectFill (r);
2232     }
2234   if (p->which)
2235     {
2236       NSRect r = NSMakeRect (p->x+xAdjust, p->y, p->wd, p->h);
2237       NSPoint pt = r.origin;
2238       EmacsImage *img = bimgs[p->which - 1];
2240       if (!img)
2241         {
2242           unsigned short *bits = p->bits + p->dh;
2243           int len = 8 * p->h/8;
2244           int i;
2245           unsigned char *cbits = xmalloc (len);
2247           for (i =0; i<len; i++)
2248             cbits[i] = ~(bits[i] & 0xff);
2249           img = [[EmacsImage alloc] initFromXBM: cbits width: 8 height: p->h
2250                                            flip: NO];
2251           bimgs[p->which - 1] = img;
2252           xfree (cbits);
2253         }
2255       NSRectClip (r);
2256       /* Since we composite the bitmap instead of just blitting it, we need
2257          to erase the whole background. */
2258       [ns_lookup_indexed_color(face->background, f) set];
2259       NSRectFill (r);
2260       pt.y += p->h;
2261       [img setXBMColor: ns_lookup_indexed_color(face->foreground, f)];
2262       [img compositeToPoint: pt operation: NSCompositeSourceOver];
2263     }
2264   ns_unfocus (f);
2268 void
2269 ns_draw_window_cursor (struct window *w, struct glyph_row *glyph_row,
2270                        int x, int y, int cursor_type, int cursor_width,
2271                        int on_p, int active_p)
2272 /* --------------------------------------------------------------------------
2273      External call (RIF): draw cursor
2274    -------------------------------------------------------------------------- */
2276   NSRect r, s;
2277   int fx, fy, h;
2278   struct frame *f = WINDOW_XFRAME (w);
2279   struct glyph *phys_cursor_glyph;
2280   int overspill;
2281   unsigned char drawGlyph = 0, cursorType, oldCursorType;
2283   NSTRACE (dumpcursor);
2285   if (!on_p)
2286       return;
2288   w->phys_cursor_type = cursor_type;
2289   w->phys_cursor_on_p = 1;
2291   if (cursor_type == NO_CURSOR)
2292     {
2293       w->phys_cursor_width = 0;
2294       return;
2295     }
2297   if ((phys_cursor_glyph = get_phys_cursor_glyph (w)) == NULL)
2298     {
2299       if (glyph_row->exact_window_width_line_p
2300           && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
2301         {
2302           glyph_row->cursor_in_fringe_p = 1;
2303           draw_fringe_bitmap (w, glyph_row, 0);
2304         }
2305       return;
2306     }
2308   get_phys_cursor_geometry (w, glyph_row, phys_cursor_glyph, &fx, &fy, &h);
2310   r.origin.x = fx, r.origin.y = fy;
2311   r.size.height = h;
2312   r.size.width = w->phys_cursor_width;
2314   /* PENDING: if we overwrite the internal border area, it does not get erased;
2315      fix by truncating cursor, but better would be to erase properly */
2316   overspill = r.origin.x + r.size.width -
2317     WINDOW_TEXT_TO_FRAME_PIXEL_X (w, WINDOW_BOX_RIGHT_EDGE_X (w) 
2318       - WINDOW_TOTAL_FRINGE_WIDTH (w) - FRAME_INTERNAL_BORDER_WIDTH (f));
2319   if (overspill > 0)
2320     r.size.width -= overspill;
2322   /* PENDING: 23: use emacs stored f->cursor_type instead of ns-specific */
2323   oldCursorType = FRAME_CURSOR (f);
2324   cursorType = FRAME_CURSOR (f) = FRAME_NEW_CURSOR (f);
2325   f->output_data.ns->current_cursor_color
2326     = f->output_data.ns->desired_cursor_color;
2328   /* PENDING: only needed in rare cases with last-resort font in HELLO..
2329      should we do this more efficiently? */
2330   ns_clip_to_row (w, glyph_row, -1, NULL);
2331 /*  ns_focus (f, &r, 1); */
2333   if (FRAME_LAST_INACTIVE (f))
2334     {
2335       /* previously hollow box; clear entire area */
2336       [FRAME_BACKGROUND_COLOR (f) set];
2337       NSRectFill (r);
2338       drawGlyph = 1;
2339       FRAME_LAST_INACTIVE (f) = NO;
2340     }
2342   /* prepare to draw */
2343   if (cursorType == no_highlight || cursor_type == NO_CURSOR)
2344     {
2345       /* clearing for blink: erase the cursor itself */
2346       [FRAME_BACKGROUND_COLOR (f) set];
2347       cursorType = oldCursorType; /* just clear what we had before */
2348     }
2349   else
2350       [FRAME_CURSOR_COLOR (f) set];
2352   if (!active_p)
2353     {
2354       /* inactive window: ignore what we just set and use a hollow box */
2355       cursorType = hollow_box;
2356       [FRAME_CURSOR_COLOR (f) set];
2357     }
2359   switch (cursorType)
2360     {
2361     case no_highlight:
2362       break;
2363     case filled_box:
2364       NSRectFill (r);
2365       drawGlyph = 1;
2366       break;
2367     case hollow_box:
2368       NSRectFill (r);
2369       [FRAME_BACKGROUND_COLOR (f) set];
2370       NSRectFill (NSInsetRect (r, 1, 1));
2371       [FRAME_CURSOR_COLOR (f) set];
2372       drawGlyph = 1;
2373       break;
2374     case underscore:
2375       s = r;
2376       s.origin.y += lrint (0.75 * s.size.height);
2377       s.size.height = lrint (s.size.height * 0.25);
2378       NSRectFill (s);
2379       break;
2380     case bar:
2381       s = r;
2382       s.size.width = 1;
2383       NSRectFill (s);
2384       break;
2385     }
2386   ns_unfocus (f);
2388   /* if needed, draw the character under the cursor */
2389   if (drawGlyph)
2390     draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
2394 static void
2395 ns_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
2396 /* --------------------------------------------------------------------------
2397      External (RIF): Draw a vertical line.
2398    -------------------------------------------------------------------------- */
2400   struct frame *f = XFRAME (WINDOW_FRAME (w));
2401   struct face *face;
2402   NSRect r = NSMakeRect (x, y0, 2, y1-y0);
2404   face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
2405   if (face)
2406       [ns_lookup_indexed_color(face->foreground, f) set];
2408   ns_focus (f, &r, 1);
2409   NSDrawGroove (r, r);
2410   ns_unfocus (f);
2414 void
2415 show_hourglass (struct atimer *timer)
2417   if (hourglass_shown_p)
2418     return;
2420   BLOCK_INPUT;
2422   /*PENDING: add NSProgressIndicator to selected frame (see macfns.c) */
2424   hourglass_shown_p = 1;
2425   UNBLOCK_INPUT;
2429 void
2430 hide_hourglass ()
2432   if (!hourglass_shown_p)
2433     return;
2435   /*PENDING: remove NSProgressIndicator from all frames */
2437   hourglass_shown_p = 0;
2438   UNBLOCK_INPUT;
2443 /* ==========================================================================
2445     Glyph drawing operations
2447    ========================================================================== */
2450 static inline NSRect
2451 /* --------------------------------------------------------------------------
2452     Under NS we draw internal borders inside fringes, and want full-width
2453     rendering to go all the way to edge.  This function makes that correction.
2454    -------------------------------------------------------------------------- */
2455 ns_fix_rect_ibw (NSRect r, int fibw, int frame_pixel_width)
2457   if (r.origin.y <= fibw+1)
2458     {
2459       r.size.height += r.origin.y;
2460       r.origin.y = 0;
2461     }
2462   if (r.origin.x <= fibw+1)
2463     {
2464       r.size.width += r.origin.x;
2465       r.origin.x = 0;
2466     }
2467   if (frame_pixel_width - (r.origin.x+r.size.width) <= fibw+1)
2468     r.size.width += fibw;
2470   return r;
2474 static int
2475 ns_get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2476 /* --------------------------------------------------------------------------
2477     Wrapper utility to account for internal border width on full-width lines,
2478     and allow top full-width rows to hit the frame top.  nr should be pointer
2479     to two successive NSRects.  Number of rects actually used is returned.
2480    -------------------------------------------------------------------------- */
2482   int n = get_glyph_string_clip_rects (s, nr, 2);
2483   if (s->row->full_width_p)
2484     {
2485       *nr = ns_fix_rect_ibw (*nr, FRAME_INTERNAL_BORDER_WIDTH (s->f),
2486                             FRAME_PIXEL_WIDTH (s->f));
2487       if (n == 2)
2488         *nr = ns_fix_rect_ibw (*(nr+1), FRAME_INTERNAL_BORDER_WIDTH (s->f),
2489                               FRAME_PIXEL_WIDTH (s->f));
2490     }
2491   return n;
2495 static void
2496 ns_draw_box (NSRect r, float thickness, NSColor *col, char left_p, char right_p)
2497 /* --------------------------------------------------------------------------
2498     Draw an unfilled rect inside r, optionally leaving left and/or right open.
2499     Note we can't just use an NSDrawRect command, because of the possibility
2500     of some sides not being drawn, and because the rect will be filled.
2501    -------------------------------------------------------------------------- */
2503   NSRect s = r;
2504   [col set];
2506   /* top, bottom */
2507   s.size.height = thickness;
2508   NSRectFill (s);
2509   s.origin.y += r.size.height - thickness;
2510   NSRectFill (s);
2512   s.size.height = r.size.height;
2513   s.origin.y = r.origin.y;
2515   /* left, right (optional) */
2516   s.size.width = thickness;
2517   if (left_p)
2518     NSRectFill (s);
2519   if (right_p)
2520     {
2521       s.origin.x += r.size.width - thickness;
2522       NSRectFill (s);
2523     }
2527 static void
2528 ns_draw_relief (NSRect r, int thickness, char raised_p,
2529                char top_p, char bottom_p, char left_p, char right_p,
2530                struct glyph_string *s)
2531 /* --------------------------------------------------------------------------
2532     Draw a relief rect inside r, optionally leaving some sides open.
2533     Note we can't just use an NSDrawBezel command, because of the possibility
2534     of some sides not being drawn, and because the rect will be filled.
2535    -------------------------------------------------------------------------- */
2537   static NSColor *baseCol = nil, *lightCol = nil, *darkCol = nil;
2538   NSColor *newBaseCol = nil;
2539   NSRect sr = r;
2541   NSTRACE (ns_draw_relief);
2543   /* set up colors */
2545   if (s->face->use_box_color_for_shadows_p)
2546     {
2547       newBaseCol = ns_lookup_indexed_color (s->face->box_color, s->f);
2548     }
2549 /*     else if (s->first_glyph->type == IMAGE_GLYPH
2550            && s->img->pixmap
2551            && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2552        {
2553          newBaseCol = IMAGE_BACKGROUND  (s->img, s->f, 0);
2554        } */
2555   else
2556     {
2557       newBaseCol = ns_lookup_indexed_color (s->face->background, s->f);
2558     }
2560   if (newBaseCol == nil)
2561     newBaseCol = [NSColor grayColor];
2563   if (newBaseCol != baseCol)  /* PENDING: better check */
2564     {
2565       [baseCol release];
2566       baseCol = [newBaseCol retain];
2567       [lightCol release];
2568       lightCol = [[baseCol highlightWithLevel: 0.2] retain];
2569       [darkCol release];
2570       darkCol = [[baseCol shadowWithLevel: 0.3] retain];
2571     }
2573   [(raised_p ? lightCol : darkCol) set];
2575   /* TODO: mitering. Using NSBezierPath doesn't work because of color switch. */
2577   /* top */
2578   sr.size.height = thickness;
2579   if (top_p) NSRectFill (sr);
2581   /* left */
2582   sr.size.height = r.size.height;
2583   sr.size.width = thickness;
2584   if (left_p) NSRectFill (sr);
2586   [(raised_p ? darkCol : lightCol) set];
2588   /* bottom */
2589   sr.size.width = r.size.width;
2590   sr.size.height = thickness;
2591   sr.origin.y += r.size.height - thickness;
2592   if (bottom_p) NSRectFill (sr);
2594   /* right */
2595   sr.size.height = r.size.height;
2596   sr.origin.y = r.origin.y;
2597   sr.size.width = thickness;
2598   sr.origin.x += r.size.width - thickness;
2599   if (right_p) NSRectFill (sr);
2603 static void
2604 ns_dumpglyphs_box_or_relief (struct glyph_string *s)
2605 /* --------------------------------------------------------------------------
2606       Function modeled after x_draw_glyph_string_box ().
2607       Sets up parameters for drawing.
2608    -------------------------------------------------------------------------- */
2610   int right_x, last_x;
2611   char left_p, right_p;
2612   struct glyph *last_glyph;
2613   NSRect r;
2614   int thickness;
2615   struct face *face;
2617   if (s->hl == DRAW_MOUSE_FACE)
2618     {
2619       face = FACE_FROM_ID
2620         (s->f, FRAME_NS_DISPLAY_INFO (s->f)->mouse_face_face_id);
2621       if (!face)
2622         face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2623     }
2624   else
2625     face = s->face;
2627   thickness = face->box_line_width;
2629   NSTRACE (ns_dumpglyphs_box_or_relief);
2631   last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2632             ? WINDOW_RIGHT_EDGE_X (s->w)
2633             : window_box_right (s->w, s->area));
2634   last_glyph = (s->cmp || s->img
2635                 ? s->first_glyph : s->first_glyph + s->nchars-1);
2637   right_x = ((s->row->full_width_p && s->extends_to_end_of_line_p
2638               ? last_x - 1 : min (last_x, s->x + s->background_width) - 1));
2640   left_p = (s->first_glyph->left_box_line_p
2641             || (s->hl == DRAW_MOUSE_FACE
2642                 && (s->prev == NULL || s->prev->hl != s->hl)));
2643   right_p = (last_glyph->right_box_line_p
2644              || (s->hl == DRAW_MOUSE_FACE
2645                  && (s->next == NULL || s->next->hl != s->hl)));
2647   r = NSMakeRect (s->x, s->y, right_x - s->x + 1, s->height);
2649   /* expand full-width row over internal borders */
2650   if (s->row->full_width_p)
2651     r = ns_fix_rect_ibw (r, FRAME_INTERNAL_BORDER_WIDTH (s->f),
2652                         FRAME_PIXEL_WIDTH (s->f));
2654   if (s->face->box == FACE_SIMPLE_BOX)
2655     {
2656       xassert (s->face->box_color != nil);
2657       ns_draw_box (r, abs (thickness),
2658                    ns_lookup_indexed_color (face->box_color, s->f),
2659                   left_p, right_p);
2660     }
2661   else
2662     {
2663       ns_draw_relief (r, abs (thickness), s->face->box == FACE_RAISED_BOX,
2664                      1, 1, left_p, right_p, s);
2665     }
2669 static void
2670 ns_maybe_dumpglyphs_background (struct glyph_string *s, char force_p)
2671 /* --------------------------------------------------------------------------
2672       Modeled after x_draw_glyph_string_background, which draws BG in
2673       certain cases.  Others are left to the text rendering routine.
2674    -------------------------------------------------------------------------- */
2676   NSTRACE (ns_maybe_dumpglyphs_background);
2678   if (!s->background_filled_p/* || s->hl == DRAW_MOUSE_FACE*/)
2679     {
2680       int box_line_width = max (s->face->box_line_width, 0);
2681       if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
2682           || s->font_not_found_p || s->extends_to_end_of_line_p || force_p)
2683         {
2684           struct face *face;
2685           if (s->hl == DRAW_MOUSE_FACE)
2686             {
2687               face = FACE_FROM_ID
2688                 (s->f, FRAME_NS_DISPLAY_INFO (s->f)->mouse_face_face_id);
2689               if (!face)
2690                 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
2691             }
2692           else
2693             face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
2694           if (!face->stipple)
2695             [(NS_FACE_BACKGROUND (face) != 0
2696               ? ns_lookup_indexed_color (NS_FACE_BACKGROUND (face), s->f)
2697               : FRAME_BACKGROUND_COLOR (s->f)) set];
2698           else
2699             {
2700               struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (s->f);
2701               [[dpyinfo->bitmaps[face->stipple-1].img stippleMask] set];
2702             }
2704           if (s->hl != DRAW_CURSOR)
2705             {
2706               NSRect r = NSMakeRect (s->x, s->y + box_line_width,
2707                                     s->background_width,
2708                                     s->height-2*box_line_width);
2710               /* expand full-width row over internal borders */
2711               if (s->row->full_width_p)
2712                 {
2713                   int fibw = FRAME_INTERNAL_BORDER_WIDTH (s->f);
2714                   if (r.origin.y <= fibw+1 + box_line_width)
2715                     {
2716                       r.size.height += r.origin.y;
2717                       r.origin.y = 0;
2718                     }
2719                   if (r.origin.x <= fibw+1)
2720                     {
2721                       r.size.width += 2*r.origin.x;
2722                       r.origin.x = 0;
2723                     }
2724                   if (FRAME_PIXEL_WIDTH (s->f) - (r.origin.x + r.size.width)
2725                       <= fibw+1)
2726                     r.size.width += fibw;
2727                 }
2729               NSRectFill (r);
2730             }
2732           s->background_filled_p = 1;
2733         }
2734     }
2738 static void
2739 ns_dumpglyphs_image (struct glyph_string *s, NSRect r)
2740 /* --------------------------------------------------------------------------
2741       Renders an image and associated borders.
2742    -------------------------------------------------------------------------- */
2744   EmacsImage *img = s->img->pixmap;
2745   int box_line_vwidth = max (s->face->box_line_width, 0);
2746   int x = s->x, y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2747   int bg_x, bg_y, bg_height;
2748   int th;
2749   char raised_p;
2750   NSRect br;
2752   NSTRACE (ns_dumpglyphs_image);
2754   if (s->face->box != FACE_NO_BOX
2755       && s->first_glyph->left_box_line_p && s->slice.x == 0)
2756     x += abs (s->face->box_line_width);
2758   bg_x = x;
2759   bg_y =  s->slice.y == 0 ? s->y : s->y + box_line_vwidth;
2760   bg_height = s->height;
2761   /* other terms have this, but was causing problems w/tabbar mode */
2762   /* - 2 * box_line_vwidth; */
2764   if (s->slice.x == 0) x += s->img->hmargin;
2765   if (s->slice.y == 0) y += s->img->vmargin;
2767   /* Draw BG: if we need larger area than image itself cleared, do that,
2768      otherwise, since we composite the image under NS (instead of mucking
2769      with its background color), we must clear just the image area. */
2770   [ns_lookup_indexed_color (NS_FACE_BACKGROUND
2771             (FACE_FROM_ID (s->f, s->first_glyph->face_id)), s->f) set];
2773   if (bg_height > s->slice.height || s->img->hmargin || s->img->vmargin
2774       || s->img->mask || s->img->pixmap == 0 || s->width != s->background_width)
2775     {
2776       br = NSMakeRect (bg_x, bg_y, s->background_width, bg_height);
2777       s->background_filled_p = 1;
2778     }
2779   else
2780     {
2781       br = NSMakeRect (x, y, s->slice.width, s->slice.height);
2782     }
2784   /* expand full-width row over internal borders */
2785   if (s->row->full_width_p)
2786     {
2787       int fibw = FRAME_INTERNAL_BORDER_WIDTH (s->f);
2788       if (br.origin.y <= fibw+1 + box_line_vwidth)
2789         {
2790           br.size.height += br.origin.y;
2791           br.origin.y = 0;
2792         }
2793       if (br.origin.x <= fibw+1 + box_line_vwidth)
2794         {
2795           br.size.width += br.origin.x;
2796           br.origin.x = 0;
2797         }
2798       if (FRAME_PIXEL_WIDTH (s->f) - (br.origin.x + br.size.width) <= fibw+1)
2799         br.size.width += fibw;
2800     }
2802   NSRectFill (br);
2804   /* Draw the image.. do we need to draw placeholder if img ==nil? */
2805   if (img != nil)
2806     [img compositeToPoint: NSMakePoint (x, y + s->slice.height)
2807                 operation: NSCompositeSourceOver];
2809   /* Draw relief, if requested */
2810   if (s->img->relief || s->hl ==DRAW_IMAGE_RAISED || s->hl ==DRAW_IMAGE_SUNKEN)
2811     {
2812       if (s->hl == DRAW_IMAGE_SUNKEN || s->hl == DRAW_IMAGE_RAISED)
2813         {
2814           th = tool_bar_button_relief >= 0 ?
2815             tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2816           raised_p = (s->hl == DRAW_IMAGE_RAISED);
2817         }
2818       else
2819         {
2820           th = abs (s->img->relief);
2821           raised_p = (s->img->relief > 0);
2822         }
2824       r.origin.x = x - th;
2825       r.origin.y = y - th;
2826       r.size.width = s->slice.width + 2*th-1;
2827       r.size.height = s->slice.height + 2*th-1;
2828       ns_draw_relief (r, th, raised_p,
2829                      s->slice.y == 0,
2830                      s->slice.y + s->slice.height == s->img->height,
2831                      s->slice.x == 0,
2832                      s->slice.x + s->slice.width == s->img->width, s);
2833     }
2837 static void
2838 ns_draw_glyph_string (struct glyph_string *s)
2839 /* --------------------------------------------------------------------------
2840       External (RIF): Main draw-text call.
2841    -------------------------------------------------------------------------- */
2843   /*PENDING (optimize): focus for box and contents draw */
2844   NSRect r[2];
2845   int n;
2846   char box_drawn_p = 0;
2848   NSTRACE (ns_draw_glyph_string);
2850   if (s->next && s->right_overhang && !s->for_overlaps && s->hl != DRAW_CURSOR)
2851     {
2852       xassert (s->next->img == NULL);
2853       n = ns_get_glyph_string_clip_rect (s->next, r);
2854       ns_focus (s->f, r, n);
2855       ns_maybe_dumpglyphs_background (s->next, 1);
2856       ns_unfocus (s->f);
2857     }
2859   if (!s->for_overlaps && s->face->box != FACE_NO_BOX
2860         && (s->first_glyph->type == CHAR_GLYPH
2861             || s->first_glyph->type == COMPOSITE_GLYPH))
2862     {
2863       n = ns_get_glyph_string_clip_rect (s, r);
2864       ns_focus (s->f, r, n);
2865       ns_maybe_dumpglyphs_background (s, 1);
2866       ns_dumpglyphs_box_or_relief (s);
2867       ns_unfocus (s->f);
2868       box_drawn_p = 1;
2869     }
2871   switch (s->first_glyph->type)
2872     {
2874     case IMAGE_GLYPH:
2875       n = ns_get_glyph_string_clip_rect (s, r);
2876       ns_focus (s->f, r, n);
2877       ns_dumpglyphs_image (s, r[0]);
2878       ns_unfocus (s->f);
2879       break;
2881     case STRETCH_GLYPH:
2882       if (!s->background_filled_p)
2883         {
2884           *r = NSMakeRect (s->x, s->y, s->background_width, s->height);
2886           if (!s->row->full_width_p)
2887             {
2888               /* truncate to avoid overwriting fringe and/or scrollbar */
2889               int overrun = max (0, (s->x + s->background_width)
2890                                  - (WINDOW_BOX_RIGHT_EDGE_X (s->w)
2891                                     - WINDOW_RIGHT_FRINGE_WIDTH (s->w)));
2892               r[0].size.width -= overrun;
2894               /* PENDING: Try to work between problem where a stretch glyph on
2895                  a partially-visible bottom row will clear part of the
2896                  modeline, and another where list-buffers headers and similar
2897                  rows erroneously have visible_height set to 0.  Not sure
2898                  where this is coming from as other terms seem not to show. */
2899               r[0].size.height = min (s->height, s->row->visible_height);
2900             }
2902           /* expand full-width rows over internal borders */
2903           else
2904             {
2905               r[0] = ns_fix_rect_ibw (r[0], FRAME_INTERNAL_BORDER_WIDTH (s->f),
2906                                      FRAME_PIXEL_WIDTH (s->f));
2907             }
2909           /* NOTE: under NS this is NOT used to draw cursors, but we must avoid
2910              overwriting cursor (usually when cursor on a tab) */
2911           if (s->hl == DRAW_CURSOR)
2912             {
2913               r[0].origin.x += s->width;
2914               r[0].size.width -= s->width;
2915             }
2917           ns_focus (s->f, r, 1);
2918           [ns_lookup_indexed_color (NS_FACE_BACKGROUND
2919                (FACE_FROM_ID (s->f, s->first_glyph->face_id)), s->f) set];
2920           NSRectFill (r[0]);
2921           ns_unfocus (s->f);
2922           s->background_filled_p = 1;
2923         }
2924       break;
2926     case CHAR_GLYPH:
2927     case COMPOSITE_GLYPH:
2928       n = ns_get_glyph_string_clip_rect (s, r);
2929       ns_focus (s->f, r, n);
2931       if (s->for_overlaps || s->gidx > 0)
2932         s->background_filled_p = 1;
2933       else      /* 1 */
2934         ns_maybe_dumpglyphs_background
2935           (s, s->first_glyph->type == COMPOSITE_GLYPH);
2937       ns_tmp_flags = s->hl == DRAW_CURSOR ? NS_DUMPGLYPH_CURSOR :
2938                     (s->hl == DRAW_MOUSE_FACE ? NS_DUMPGLYPH_MOUSEFACE :
2939                      (s->for_overlaps ? NS_DUMPGLYPH_FOREGROUND :
2940                       NS_DUMPGLYPH_NORMAL));
2941       ns_tmp_font = (struct nsfont_info *)s->face->font;
2942       if (ns_tmp_font == ~0 || ns_tmp_font == NULL)
2943           ns_tmp_font = FRAME_FONT (s->f);
2945       ns_tmp_font->font.driver->draw
2946         (s, 0, s->nchars, s->x, s->y,
2947          (ns_tmp_flags == NS_DUMPGLYPH_NORMAL && !s->background_filled_p)
2948          || ns_tmp_flags == NS_DUMPGLYPH_MOUSEFACE);
2950       ns_unfocus (s->f);
2951       break;
2953     default:
2954       abort ();
2955     }
2957   /* Draw box if not done already. */
2958   if (!s->for_overlaps && !box_drawn_p && s->face->box != FACE_NO_BOX)
2959     {
2960       n = ns_get_glyph_string_clip_rect (s, r);
2961       ns_focus (s->f, r, n);
2962       ns_dumpglyphs_box_or_relief (s);
2963       ns_unfocus (s->f);
2964     }
2970 /* ==========================================================================
2972     Event loop
2974    ========================================================================== */
2977 static void
2978 ns_send_appdefined (int value)
2979 /* --------------------------------------------------------------------------
2980     Internal: post an appdefined event which EmacsApp-sendEvent will
2981               recognize and take as a command to halt the event loop.
2982    -------------------------------------------------------------------------- */
2984   /*NSTRACE (ns_send_appdefined); */
2986   /* Only post this event if we haven't already posted one.  This will end
2987        the [NXApp run] main loop after having processed all events queued at
2988        this moment.  */
2989   if (send_appdefined)
2990     {
2991       NSEvent *nxev;
2993       /* We only need one NX_APPDEFINED event to stop NXApp from running.  */
2994       send_appdefined = NO;
2996       /* Don't need wakeup timer any more */
2997       if (timed_entry)
2998         {
2999           [timed_entry invalidate];
3000           [timed_entry release];
3001           timed_entry = nil;
3002         }
3004       /* Ditto for file descriptor poller */
3005       if (fd_entry)
3006         {
3007           [fd_entry invalidate];
3008           [fd_entry release];
3009           fd_entry = nil;
3010         }
3012       nxev = [NSEvent otherEventWithType: NSApplicationDefined
3013                                 location: NSMakePoint (0, 0)
3014                            modifierFlags: 0
3015                                timestamp: 0
3016                             windowNumber: [[NSApp mainWindow] windowNumber]
3017                                  context: [NSApp context]
3018                                  subtype: 0
3019                                    data1: value
3020                                    data2: 0];
3022       /* Post an application defined event on the event queue.  When this is
3023          received the [NXApp run] will return, thus having processed all
3024          events which are currently queued.  */
3025       [NSApp postEvent: nxev atStart: NO];
3026     }
3030 static int
3031 ns_read_socket (struct terminal *terminal, int expected,
3032                 struct input_event *hold_quit)
3033 /* --------------------------------------------------------------------------
3034      External (hook): Post an event to ourself and keep reading events until
3035      we read it back again.  In effect process all events which were waiting.
3036    23: Now we have to manage the event buffer ourselves.
3037    -------------------------------------------------------------------------- */
3039   struct input_event ev;
3040   int nevents;
3041   static NSDate *lastCheck = nil;
3042 /*  NSTRACE (ns_read_socket); */
3044   if (interrupt_input_blocked)
3045     {
3046       interrupt_input_pending = 1;
3047       return -1;
3048     }
3050   interrupt_input_pending = 0;
3051   BLOCK_INPUT;
3053 #ifdef COCOA_EXPERIMENTAL_CTRL_G
3054   /* causes Feval to abort; unclear on why this isn't in calling code */
3055   ++handling_signal;
3056 #endif
3058   n_emacs_events_pending = 0;
3059   EVENT_INIT (ev);
3060   emacs_event = &ev;
3061   q_event_ptr = hold_quit;
3063   /* we manage autorelease pools by allocate/reallocate each time around
3064      the loop; strict nesting is occasionally violated but seems not to
3065      matter.. earlier methods using full nesting caused major memory leaks */
3066   [outerpool release];
3067   outerpool = [[NSAutoreleasePool alloc] init];
3069   /* If have pending open-file requests, attend to the next one of those. */
3070   if (ns_pending_files && [ns_pending_files count] != 0
3071       && [NSApp openFile: [ns_pending_files objectAtIndex: 0]])
3072     {
3073       [ns_pending_files removeObjectAtIndex: 0];
3074     }
3075   /* Deal with pending service requests. */
3076   else if (ns_pending_service_names && [ns_pending_service_names count] != 0
3077     && [NSApp fulfillService: [ns_pending_service_names objectAtIndex: 0]
3078                      withArg: [ns_pending_service_args objectAtIndex: 0]])
3079     {
3080       [ns_pending_service_names removeObjectAtIndex: 0];
3081       [ns_pending_service_args removeObjectAtIndex: 0];
3082     }
3083   else
3084     {
3085       /* Run and wait for events.  We must always send one NX_APPDEFINED event
3086          to ourself, otherwise [NXApp run] will never exit.  */
3087       send_appdefined = YES;
3089       /*PENDING: from termhooks.h: */
3090       /* XXX Please note that a non-zero value of EXPECTED only means that
3091      there is available input on at least one of the currently opened
3092      terminal devices -- but not necessarily on this device.
3093      Therefore, in most cases EXPECTED should be simply ignored. */
3094       /* However, if in ns_select, this is called from gobble_input, which
3095          appears to set it correctly for our purposes, and always assuming
3096          !expected causes 100% CPU usage. */
3097       if (!inNsSelect || !expected)
3098         {
3099           /* Post an application defined event on the event queue.  When this is
3100              received the [NXApp run] will return, thus having processed all
3101              events which are currently queued, if any.  */
3102           ns_send_appdefined (-1);
3103         }
3105       [NSApp run];
3106     }
3108   nevents = n_emacs_events_pending;
3109   n_emacs_events_pending = 0;
3110   emacs_event = q_event_ptr = NULL;
3112 #ifdef COCOA_EXPERIMENTAL_CTRL_G
3113   --handling_signal;
3114 #endif
3115   UNBLOCK_INPUT;
3116   return nevents;
3121 ns_select (int nfds, fd_set *readfds, fd_set *writefds,
3122            fd_set *exceptfds, struct timeval *timeout)
3123 /* --------------------------------------------------------------------------
3124      Replacement for select, checking for events
3125    -------------------------------------------------------------------------- */
3127   int result;
3128   double time;
3129   NSEvent *ev;
3130 /*  NSTRACE (ns_select); */
3132   if (NSApp == nil /* || ([NSApp isActive] == NO &&
3133                       [NSApp nextEventMatchingMask:NSAnyEventMask untilDate:nil
3134  inMode:NSDefaultRunLoopMode dequeue:NO] == nil) */)
3135     return select (nfds, readfds, writefds, exceptfds, timeout);
3137   /* Save file descriptor set, which gets overwritten in calls to select ()
3138      Note, this is called from process.c, and only readfds is ever set */
3139   if (readfds)
3140     {
3141       memcpy (&select_readfds, readfds, sizeof (fd_set));
3142       select_nfds = nfds;
3143     }
3144   else
3145     select_nfds = 0;
3147     /* Try an initial select for pending data on input files */
3148   select_timeout.tv_sec = select_timeout.tv_usec = 0;
3149   result = select (nfds, readfds, writefds, exceptfds, &select_timeout);
3150   if (result)
3151     return result;
3153   /* if (!timeout || timed_entry || fd_entry)
3154        fprintf (stderr, "assertion failed: timeout null or timed_entry/fd_entry non-null in ns_select\n"); */
3156     /* set a timeout and run the main AppKit event loop while continuing
3157        to monitor the files */
3158   time = ((double) timeout->tv_sec) + ((double) timeout->tv_usec)/1000000.0;
3159   timed_entry = [[NSTimer scheduledTimerWithTimeInterval: time
3160                                            target: NSApp
3161                                          selector: @selector (timeout_handler:)
3162                                          userInfo: 0
3163                                           repeats: YES] /* for safe removal */
3164                                                          retain];
3166   /* set a periodic task to try the select () again */
3167   fd_entry = [[NSTimer scheduledTimerWithTimeInterval: 0.1
3168                                                target: NSApp
3169                                              selector: @selector (fd_handler:)
3170                                              userInfo: 0
3171                                               repeats: YES]
3172                retain];
3174   if (!NILP (ns_cursor_blink_mode) && !cursor_blink_entry)
3175     {
3176       if (!NUMBERP (ns_cursor_blink_rate))
3177         ns_cursor_blink_rate = make_float (0.5);
3178       cursor_blink_entry = [[NSTimer
3179         scheduledTimerWithTimeInterval: XFLOATINT (ns_cursor_blink_rate)
3180                                 target: NSApp
3181                               selector: @selector (cursor_blink_handler:)
3182                               userInfo: 0
3183                                repeats: YES]
3184                              retain];
3185     }
3186   else if (NILP (ns_cursor_blink_mode) && cursor_blink_entry)
3187     {
3188       if (NUMBERP (ns_cursor_blink_rate))
3189           ns_cursor_blink_rate = Qnil;
3190       struct ns_display_info *dpyinfo = ns_display_list; /* HACK */
3191       [cursor_blink_entry invalidate];
3192       [cursor_blink_entry release];
3193       cursor_blink_entry = 0;
3194       if (dpyinfo->ns_highlight_frame)
3195         {
3196           Lisp_Object tem
3197             = get_frame_param (dpyinfo->ns_highlight_frame, Qcursor_type);
3198           dpyinfo->ns_highlight_frame->output_data.ns->desired_cursor
3199             = ns_lisp_to_cursor_type (tem);
3200         }
3201     }
3203   /* Let Application dispatch events until it receives an event of the type
3204        NX_APPDEFINED, which should only be sent by timeout_handler.  */
3205   inNsSelect = 1;
3206   gobble_input (timeout ? 1 : 0);
3207   ev = last_appdefined_event;
3208   inNsSelect = 0;
3210   if (ev)
3211     {
3212       int t;
3213       if ([ev type] != NSApplicationDefined)
3214         abort ();
3216       t = [ev data1];
3217       last_appdefined_event = 0;
3219       if (t == -2)
3220         {
3221           /* The NX_APPDEFINED event we received was a timeout. */
3222           return 0;
3223         }
3224       else if (t == -1)
3225         {
3226           /* The NX_APPDEFINED event we received was the result of
3227              at least one real input event arriving.  */
3228           errno = EINTR;
3229           return -1;
3230         }
3231       else
3232         {
3233           /* Received back from select () in fd_handler; copy the results */
3234           if (readfds)
3235             memcpy (readfds, &select_readfds, sizeof (fd_set));
3236           return t;
3237         }
3238     }
3239   /* never reached, shut compiler up */
3240   return 0;
3245 /* ==========================================================================
3247     Scrollbar handling
3249    ========================================================================== */
3252 static void
3253 ns_set_vertical_scroll_bar (struct window *window,
3254                            int portion, int whole, int position)
3255 /* --------------------------------------------------------------------------
3256       External (hook): Update or add scrollbar
3257    -------------------------------------------------------------------------- */
3259   Lisp_Object win;
3260   NSRect r, v;
3261   struct frame *f = XFRAME (WINDOW_FRAME (window));
3262   EmacsView *view = FRAME_NS_VIEW (f);
3263   int window_y, window_height;
3264   BOOL barOnVeryLeft, barOnVeryRight;
3265   int top, left, height, width, sb_width, sb_left;
3266   EmacsScroller *bar;
3267 static int count = 0;
3269   /* optimization; display engine sends WAY too many of these.. */
3270   if (!NILP (window->vertical_scroll_bar))
3271     {
3272       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3273       if ([bar checkSamePosition: position portion: portion whole: whole])
3274         {
3275           if (view->scrollbarsNeedingUpdate == 0)
3276             {
3277               if (!windows_or_buffers_changed)
3278                   return;
3279             }
3280           else
3281             view->scrollbarsNeedingUpdate--;
3282         }
3283     }
3285   NSTRACE (ns_set_vertical_scroll_bar);
3287   /* Get dimensions.  */
3288   window_box (window, -1, 0, &window_y, 0, &window_height);
3289   top = window_y;
3290   height = window_height;
3291   width = WINDOW_CONFIG_SCROLL_BAR_COLS (window) * FRAME_COLUMN_WIDTH (f);
3292   left = WINDOW_SCROLL_BAR_AREA_X (window);
3294   if (top < 5) /* top scrollbar adjustment */
3295     {
3296       top -= FRAME_INTERNAL_BORDER_WIDTH (f);
3297       height += FRAME_INTERNAL_BORDER_WIDTH (f);
3298     }
3300   /* allow for displaying a skinnier scrollbar than char area allotted */
3301   sb_width = (WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) > 0) ?
3302     WINDOW_CONFIG_SCROLL_BAR_WIDTH (window) : width;
3304   barOnVeryLeft = left < 5;
3305   barOnVeryRight = FRAME_PIXEL_WIDTH (f) - left - width < 5;
3306   sb_left = left + FRAME_INTERNAL_BORDER_WIDTH (f)
3307       * (barOnVeryLeft ? -1 : (barOnVeryRight ? 1 : 0));
3309   r = NSMakeRect (sb_left, top, sb_width, height);
3310   /* the parent view is flipped, so we need to flip y value */
3311   v = [view frame];
3312   r.origin.y = (v.size.height - r.size.height - r.origin.y);
3314   XSETWINDOW (win, window);
3315   BLOCK_INPUT;
3317   /* we want at least 5 lines to display a scrollbar */
3318   if (WINDOW_TOTAL_LINES (window) < 5)
3319     {
3320       if (!NILP (window->vertical_scroll_bar))
3321         {
3322           bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3323           [bar removeFromSuperview];
3324           window->vertical_scroll_bar = Qnil;
3325         }
3326       ns_clear_frame_area (f, sb_left, top, width, height);
3327       UNBLOCK_INPUT;
3328       return;
3329     }
3331   if (NILP (window->vertical_scroll_bar))
3332     {
3333       ns_clear_frame_area (f, sb_left, top, width, height);
3334       bar = [[EmacsScroller alloc] initFrame: r window: win];
3335       window->vertical_scroll_bar = make_save_value (bar, 0);
3336     }
3337   else
3338     {
3339       NSRect oldRect;
3340       bar = XNS_SCROLL_BAR (window->vertical_scroll_bar);
3341       oldRect = [bar frame];
3342       r.size.width = oldRect.size.width;
3343       if (FRAME_LIVE_P (f) && !NSEqualRects (oldRect, r))
3344         {
3345           if (oldRect.origin.x != r.origin.x)
3346               ns_clear_frame_area (f, sb_left, top, width, height);
3347           [bar setFrame: r];
3348         }
3349     }
3351   [bar setPosition: position portion: portion whole: whole];
3352   UNBLOCK_INPUT;
3356 static void
3357 ns_condemn_scroll_bars (struct frame *f)
3358 /* --------------------------------------------------------------------------
3359      External (hook): arrange for all frame's scrollbars to be removed
3360      at next call to judge_scroll_bars, except for those redeemed.
3361    -------------------------------------------------------------------------- */
3363   int i;
3364   id view;
3365   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3367   NSTRACE (ns_condemn_scroll_bars);
3369   for (i =[subviews count]-1; i >= 0; i--)
3370     {
3371       view = [subviews objectAtIndex: i];
3372       if ([view isKindOfClass: [EmacsScroller class]])
3373         [view condemn];
3374     }
3378 static void
3379 ns_redeem_scroll_bar (struct window *window)
3380 /* --------------------------------------------------------------------------
3381      External (hook): arrange to spare this window's scrollbar
3382      at next call to judge_scroll_bars.
3383    -------------------------------------------------------------------------- */
3385   id bar;
3386   NSTRACE (ns_redeem_scroll_bar);
3387   if (!NILP (window->vertical_scroll_bar))
3388     {
3389       bar =XNS_SCROLL_BAR (window->vertical_scroll_bar);
3390       [bar reprieve];
3391     }
3395 static void
3396 ns_judge_scroll_bars (struct frame *f)
3397 /* --------------------------------------------------------------------------
3398      External (hook): destroy all scrollbars on frame that weren't
3399      redeemed after call to condemn_scroll_bars.
3400    -------------------------------------------------------------------------- */
3402   int i;
3403   id view;
3404   NSArray *subviews = [[FRAME_NS_VIEW (f) superview] subviews];
3405   NSTRACE (ns_judge_scroll_bars);
3406   for (i =[subviews count]-1; i >= 0; i--)
3407     {
3408       view = [subviews objectAtIndex: i];
3409       if (![view isKindOfClass: [EmacsScroller class]]) continue;
3410       [view judge];
3411     }
3416 /* ==========================================================================
3418     Miscellaneous, mainly stubbed-out functions added in 23
3420    ========================================================================== */
3423 void
3424 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
3430 /* ==========================================================================
3432     Initialization
3434    ========================================================================== */
3436 static Lisp_Object ns_string_to_lispmod (char *s)
3437 /* --------------------------------------------------------------------------
3438      Convert modifier name to lisp symbol
3439    -------------------------------------------------------------------------- */
3441   if (!strncmp (SDATA (SYMBOL_NAME (Qmeta)), s, 10))
3442     return Qmeta;
3443   else if (!strncmp (SDATA (SYMBOL_NAME (Qsuper)), s, 10))
3444     return Qsuper;
3445   else if (!strncmp (SDATA (SYMBOL_NAME (Qcontrol)), s, 10))
3446     return Qcontrol;
3447   else if (!strncmp (SDATA (SYMBOL_NAME (Qalt)), s, 10))
3448     return Qalt;
3449   else if (!strncmp (SDATA (SYMBOL_NAME (Qhyper)), s, 10))
3450     return Qhyper;
3451   else if (!strncmp (SDATA (SYMBOL_NAME (Qnone)), s, 10))
3452     return Qnone;
3453   else
3454     return Qnil;
3458 static Lisp_Object ns_mod_to_lisp (int m)
3459 /* --------------------------------------------------------------------------
3460      Convert modifier code (see lisp.h) to lisp symbol
3461    -------------------------------------------------------------------------- */
3463   if (m == CHAR_META)
3464     return Qmeta;
3465   else if (m == CHAR_SUPER)
3466     return Qsuper;
3467   else if (m == CHAR_CTL)
3468     return Qcontrol;
3469   else if (m == CHAR_ALT)
3470     return Qalt;
3471   else if (m == CHAR_HYPER)
3472     return Qhyper;
3473   else /* if (m == 0) */
3474     return Qnone;
3478 static void
3479 ns_set_default_prefs ()
3480 /* --------------------------------------------------------------------------
3481       Initialize preference variables to defaults
3482    -------------------------------------------------------------------------- */
3484   ns_alternate_modifier = Qmeta;
3485   ns_command_modifier = Qsuper;
3486   ns_control_modifier = Qcontrol;
3487   ns_function_modifier = Qnone;
3488   ns_cursor_blink_rate = Qnil;
3489   ns_cursor_blink_mode = Qnil;
3490   ns_expand_space = make_float (0.0);
3491   ns_antialias_text = Qt;
3492   ns_antialias_threshold = 10.0; /* not exposed to lisp side */
3493   ns_use_qd_smoothing = Qnil;
3494   ns_use_system_highlight_color = Qt;
3498 static void
3499 ns_default (const char *parameter, Lisp_Object *result,
3500            Lisp_Object yesval, Lisp_Object noval,
3501            BOOL is_float, BOOL is_modstring)
3502 /* --------------------------------------------------------------------------
3503       Check a parameter value in user's preferences
3504    -------------------------------------------------------------------------- */
3506   const char *value;
3508   if ( (value =[[[NSUserDefaults standardUserDefaults]
3509                    stringForKey: [NSString stringWithUTF8String: parameter]]
3510                 UTF8String]) )
3511     {
3512       double f;
3513       char *pos;
3514       if (strcasecmp (value, "YES") == 0)
3515         *result = yesval;
3516       else if (strcasecmp (value, "NO") == 0)
3517         *result = noval;
3518       else if (is_float && (f = strtod (value, &pos), pos != value))
3519         *result = make_float (f);
3520       else if (is_modstring && value)
3521         *result = ns_string_to_lispmod (value);
3522       else fprintf (stderr,
3523                    "Bad value for default \"%s\": \"%s\"\n", parameter, value);
3524     }
3528 void
3529 ns_initialize_display_info (struct ns_display_info *dpyinfo)
3530 /* --------------------------------------------------------------------------
3531       Initialize global info and storage for display.
3532    -------------------------------------------------------------------------- */
3534     NSScreen *screen = [NSScreen mainScreen];
3535     NSWindowDepth depth = [screen depth];
3537     dpyinfo->width = [screen frame].size.width;
3538     dpyinfo->height = [screen frame].size.height;
3539     dpyinfo->resx = 72.27; /* used 75.0, but this makes pt == pixel, expected */
3540     dpyinfo->resy = 72.27;
3541     dpyinfo->color_p = ![NSDeviceWhiteColorSpace isEqualToString:
3542                                                   NSColorSpaceFromDepth (depth)]
3543                 && ![NSCalibratedWhiteColorSpace isEqualToString:
3544                                                  NSColorSpaceFromDepth (depth)];
3545     dpyinfo->n_planes = NSBitsPerPixelFromDepth (depth);
3546     dpyinfo->image_cache = make_image_cache ();
3547     dpyinfo->color_table
3548       = (struct ns_color_table *)xmalloc (sizeof (struct ns_color_table));
3549     dpyinfo->color_table->colors = NULL;
3550     dpyinfo->root_window = 42; /* a placeholder.. */
3552     dpyinfo->mouse_face_mouse_frame = NULL;
3553     dpyinfo->mouse_face_deferred_gc = 0;
3554     dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
3555     dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
3556     dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
3557     dpyinfo->mouse_face_window = dpyinfo->mouse_face_overlay = Qnil;
3558     dpyinfo->mouse_face_hidden = 0;
3560     dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
3561     dpyinfo->mouse_face_defer = 0;
3563     dpyinfo->ns_highlight_frame = dpyinfo->ns_focus_frame = NULL;
3565     dpyinfo->n_fonts = 0;
3566     dpyinfo->smallest_font_height = 1;
3567     dpyinfo->smallest_char_width = 1;
3571 /* 23: Needed as new part of display engine; this and next define public
3572       functions in this file (well, many of them, anyway). */
3573 /* x_... are generic versions in xdisp.c that we, and other terms, get away
3574          with using despite presence in the "system dependent" redisplay
3575          interface.  In addition, many of the ns_ methods have code that is
3576          shared with all terms, indicating need for further refactoring. */
3577 extern frame_parm_handler ns_frame_parm_handlers[];
3578 static struct redisplay_interface ns_redisplay_interface =
3580   ns_frame_parm_handlers,
3581   x_produce_glyphs, /*generic OK */
3582   x_write_glyphs, /*generic OK */
3583   x_insert_glyphs, /*generic OK */
3584   x_clear_end_of_line, /*generic OK */
3585   ns_scroll_run, /*23 */
3586   ns_after_update_window_line, /*23: added */
3587   ns_update_window_begin, /*23: split from update_begin */
3588   ns_update_window_end, /*23: split from update_end */
3589   x_cursor_to, /*generic OK */
3590   ns_flush,
3591   0, /* flush_display_optional */
3592   x_clear_window_mouse_face, /*generic OK */
3593   x_get_glyph_overhangs, /*23: generic OK */
3594   x_fix_overlapping_area, /*generic OK */
3595   ns_draw_fringe_bitmap, /*23 */
3596   0, /* define_fringe_bitmap */ /*PENDING: simplify ns_draw_fringe_bitmap? */
3597   0, /* destroy_fringe_bitmap */
3598   ns_compute_glyph_string_overhangs, /*23 */
3599   ns_draw_glyph_string, /*23: interface to nsfont.m */
3600   ns_define_frame_cursor, /*23 */
3601   ns_clear_frame_area, /*23 */
3602   ns_draw_window_cursor, /*23: revamped ns_dumpcursor */
3603   ns_draw_vertical_window_border,
3604   ns_shift_glyphs_for_insert
3608 static void
3609 ns_delete_display (struct ns_display_info *dpyinfo)
3611   /*PENDING... */
3615 /* This function is called when the last frame on a display is deleted. */
3616 static void
3617 ns_delete_terminal (struct terminal *terminal)
3619   struct ns_display_info *dpyinfo = terminal->display_info.ns;
3620   int i;
3622   /* Protect against recursive calls.  Fdelete_frame in
3623      delete_terminal calls us back when it deletes our last frame.  */
3624   if (!terminal->name)
3625     return;
3627   BLOCK_INPUT;
3629   x_destroy_all_bitmaps (dpyinfo);
3630   ns_delete_display (dpyinfo);
3631   UNBLOCK_INPUT;
3635 static struct terminal *
3636 ns_create_terminal (struct ns_display_info *dpyinfo)
3637 /* --------------------------------------------------------------------------
3638       Set up use of NS before we make the first connection.
3639    -------------------------------------------------------------------------- */
3641   struct terminal *terminal;
3643   NSTRACE (ns_create_terminal);
3645   terminal = create_terminal ();
3647   terminal->type = output_ns;
3648   terminal->display_info.ns = dpyinfo;
3649   dpyinfo->terminal = terminal;
3651   terminal->rif = &ns_redisplay_interface;
3653   terminal->clear_frame_hook = ns_clear_frame;
3654   terminal->ins_del_lines_hook = 0; /* 23: vestigial? */
3655   terminal->delete_glyphs_hook = 0; /* 23: vestigial? */
3656   terminal->ring_bell_hook = ns_ring_bell;
3657   terminal->reset_terminal_modes_hook = ns_reset_terminal_modes;
3658   terminal->set_terminal_modes_hook = ns_set_terminal_modes;
3659   terminal->update_begin_hook = ns_update_begin;
3660   terminal->update_end_hook = ns_update_end;
3661   terminal->set_terminal_window_hook = NULL; /* 23: vestigial? */
3662   terminal->read_socket_hook = ns_read_socket;
3663   terminal->frame_up_to_date_hook = ns_frame_up_to_date;
3664   terminal->mouse_position_hook = ns_mouse_position;
3665   terminal->frame_rehighlight_hook = ns_frame_rehighlight;
3666   terminal->frame_raise_lower_hook = ns_frame_raise_lower;
3668   terminal->fullscreen_hook = 0; /*XTfullscreen_hook;//23.50 */
3670   terminal->set_vertical_scroll_bar_hook = ns_set_vertical_scroll_bar;
3671   terminal->condemn_scroll_bars_hook = ns_condemn_scroll_bars;
3672   terminal->redeem_scroll_bar_hook = ns_redeem_scroll_bar;
3673   terminal->judge_scroll_bars_hook = ns_judge_scroll_bars;
3675   terminal->delete_frame_hook = x_destroy_window;
3676   terminal->delete_terminal_hook = ns_delete_terminal;
3678   terminal->scroll_region_ok = 1;
3679   terminal->char_ins_del_ok = 1;
3680   terminal->line_ins_del_ok = 1;
3681   terminal->fast_clear_end_of_line = 1;
3682   terminal->memory_below_frame = 0;
3684   return terminal;
3688 void
3689 ns_initialize ()
3690 /* --------------------------------------------------------------------------
3691    Mainly vestigial under NS now that ns_create_terminal () does most things.
3692    -------------------------------------------------------------------------- */
3694   baud_rate = 38400;
3695   Fset_input_interrupt_mode (Qt);
3699 struct ns_display_info *
3700 ns_term_init (Lisp_Object display_name)
3701 /* --------------------------------------------------------------------------
3702      Start the Application and get things rolling.
3703    -------------------------------------------------------------------------- */
3705   extern Lisp_Object Fset_input_mode (Lisp_Object, Lisp_Object,
3706                                      Lisp_Object, Lisp_Object);
3707   struct terminal *terminal;
3708   struct ns_display_info *dpyinfo;
3709   static int ns_initialized = 0;
3710   Lisp_Object tmp;
3712   NSTRACE (ns_term_init);
3714   /* count object allocs (About, click icon); on OS X use ObjectAlloc tool */
3715   /*GSDebugAllocationActive (YES); */
3716   BLOCK_INPUT;
3717 handling_signal = 0;
3719   if (!ns_initialized)
3720     {
3721       ns_initialize ();
3722       ns_initialized = 1;
3723     }
3725   ns_pending_files = [[NSMutableArray alloc] init];
3726   ns_pending_service_names = [[NSMutableArray alloc] init];
3727   ns_pending_service_args = [[NSMutableArray alloc] init];
3729   /* Start app and create the main menu, window, view.
3730      Needs to be here because ns_initialize_display_info () uses AppKit classes.
3731      The view will then ask the NSApp to stop and return to Emacs. */
3732   [EmacsApp sharedApplication];
3733   if (NSApp == nil)
3734     return NULL;
3735   [NSApp setDelegate: NSApp];
3737   /* debugging: log all notifications */
3738   /*   [[NSNotificationCenter defaultCenter] addObserver: NSApp
3739                                          selector: @selector (logNotification:)
3740                                              name: nil object: nil]; */
3742   dpyinfo = (struct ns_display_info *)xmalloc (sizeof (struct ns_display_info));
3743   bzero (dpyinfo, sizeof (struct ns_display_info));
3745   ns_initialize_display_info (dpyinfo);
3746   terminal = ns_create_terminal (dpyinfo);
3748   terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
3749   init_kboard (terminal->kboard);
3750   terminal->kboard->Vwindow_system = Qns;
3751   terminal->kboard->next_kboard = all_kboards;
3752   all_kboards = terminal->kboard;
3753   /* Don't let the initial kboard remain current longer than necessary.
3754      That would cause problems if a file loaded on startup tries to
3755      prompt in the mini-buffer.  */
3756   if (current_kboard == initial_kboard)
3757     current_kboard = terminal->kboard;
3758   terminal->kboard->reference_count++;
3760   dpyinfo->next = ns_display_list;
3761   ns_display_list = dpyinfo;
3763   /* Put it on ns_display_name_list */
3764   ns_display_name_list = Fcons (Fcons (display_name, Qnil),
3765                                 ns_display_name_list);
3766 /*      ns_display_name_list = Fcons (Fcons (display_name,
3767                                            Fcons (Qnil, dpyinfo->xrdb)),
3768                                     ns_display_name_list); */
3769   dpyinfo->name_list_element = XCAR (ns_display_name_list);
3771   /* Set the name of the terminal. */
3772   terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
3773   strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
3774   terminal->name[SBYTES (display_name)] = 0;
3776   UNBLOCK_INPUT; 
3778   /* Read various user defaults. */
3779   ns_set_default_prefs ();
3780   ns_default ("AlternateModifier", &ns_alternate_modifier,
3781              Qnil, Qnil, NO, YES);
3782   if (NILP (ns_alternate_modifier))
3783     ns_alternate_modifier = Qmeta;
3784   ns_default ("CommandModifier", &ns_command_modifier,
3785              Qnil, Qnil, NO, YES);
3786   if (NILP (ns_command_modifier))
3787     ns_command_modifier = Qsuper;
3788   ns_default ("ControlModifier", &ns_control_modifier,
3789              Qnil, Qnil, NO, YES);
3790   if (NILP (ns_control_modifier))
3791     ns_control_modifier = Qcontrol;
3792   ns_default ("FunctionModifier", &ns_function_modifier,
3793              Qnil, Qnil, NO, YES);
3794   if (NILP (ns_function_modifier))
3795     ns_function_modifier = Qnone;
3796   ns_default ("CursorBlinkRate", &ns_cursor_blink_rate,
3797              make_float (0.5), Qnil, YES, NO);
3798   if (NUMBERP (ns_cursor_blink_rate))
3799     ns_cursor_blink_mode = Qt;
3800   ns_default ("ExpandSpace", &ns_expand_space,
3801              make_float (0.5), make_float (0.0), YES, NO);
3802   ns_default ("GSFontAntiAlias", &ns_antialias_text,
3803              Qt, Qnil, NO, NO);
3804   tmp = Qnil;
3805   ns_default ("AppleAntiAliasingThreshold", &tmp,
3806              make_float (10.0), make_float (6.0), YES, NO);
3807   ns_antialias_threshold = NILP (tmp) ? 10.0 : XFLOATINT (tmp);
3808   ns_default ("UseQuickdrawSmoothing", &ns_use_qd_smoothing,
3809              Qt, Qnil, NO, NO);
3810 fprintf(stderr, "qd smoothing: %d (%d, %d)\n", ns_use_qd_smoothing, EQ(ns_use_qd_smoothing, Qt), NILP(ns_use_qd_smoothing));
3811   ns_default ("UseSystemHighlightColor", &ns_use_system_highlight_color,
3812              Qt, Qnil, NO, NO);
3813   if (EQ (ns_use_system_highlight_color, Qt))
3814     {
3815       ns_selection_color = [[NSUserDefaults standardUserDefaults]
3816                                stringForKey: @"AppleHighlightColor"];
3817       if (ns_selection_color == nil)
3818         ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
3819     }
3820   else
3821     ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
3823   {
3824     id cl;
3825     Lisp_Object tem, tem1;
3826     extern Lisp_Object Vsource_directory;
3828     cl = [NSColorList colorListNamed: @"Emacs"];
3830     if ( cl == nil )
3831       {
3832         /* first try data_dir, then invocation-dir
3833            and finally source-directory/etc */
3834         tem1 = tem
3835           = Fexpand_file_name (build_string ("Emacs.clr"), Vdata_directory);
3836         if (NILP (Ffile_exists_p (tem)))
3837           {
3838             tem = Fexpand_file_name (build_string ("Emacs.clr"),
3839                                      Vinvocation_directory);
3840             if (NILP (Ffile_exists_p (tem)))
3841               {
3842                 Lisp_Object newdir
3843                   = Fexpand_file_name (build_string ("etc/"),
3844                                        Vsource_directory);
3845                 tem = Fexpand_file_name (build_string ("Emacs.clr"),
3846                                          newdir);
3847               }
3848           }
3850         cl = [[NSColorList alloc]
3851                initWithName: @"Emacs"
3852                    fromFile: [NSString stringWithCString: SDATA (tem)]];
3853         if (cl ==nil)
3854           fatal ("Could not find %s.\n", SDATA (tem1));
3855         [cl writeToFile: nil];
3856       }
3857   }
3859   {
3860     char c[128];
3861 #ifdef NS_IMPL_GNUSTEP
3862     strncpy (c, gnustep_base_version, sizeof (c));
3863 #else
3864     /*PSnextrelease (128, c); */
3865     snprintf (c, sizeof (c), "%g", NSAppKitVersionNumber);
3866 #endif
3867     Vwindow_system_version = build_string (c);
3868   }
3870   delete_keyboard_wait_descriptor (0);
3872 /* Set up OS X app menu */
3873 #ifdef NS_IMPL_COCOA
3874   {
3875     NSMenu *appMenu;
3876     id<NSMenuItem> item;
3877     /* set up the application menu */
3878     svcsMenu = [[EmacsMenu alloc] initWithTitle: @"Services"];
3879     [svcsMenu setAutoenablesItems: NO];
3880     appMenu = [[EmacsMenu alloc] initWithTitle: @"Emacs"];
3881     [appMenu setAutoenablesItems: NO];
3882     mainMenu = [[EmacsMenu alloc] initWithTitle: @""];
3884     [appMenu insertItemWithTitle: @"About Emacs"
3885                           action: @selector (orderFrontStandardAboutPanel:)
3886                    keyEquivalent: @""
3887                          atIndex: 0];
3888     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 1];
3889     [appMenu insertItemWithTitle: @"Preferences..."
3890                           action: @selector (showPreferencesWindow:)
3891                    keyEquivalent: @","
3892                          atIndex: 2];
3893     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 3];
3894     item = [appMenu insertItemWithTitle: @"Services"
3895                                  action: @selector (menuDown:)
3896                           keyEquivalent: @""
3897                                 atIndex: 4];
3898     [appMenu setSubmenu: svcsMenu forItem: item];
3899 /*    [svcsMenu setSupercell: item]; */
3900     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 5];
3901     [appMenu insertItemWithTitle: @"Hide Emacs"
3902                           action: @selector (hide:)
3903                    keyEquivalent: @"h"
3904                          atIndex: 6];
3905     item =  [appMenu insertItemWithTitle: @"Hide Others"
3906                           action: @selector (hideOtherApplications:)
3907                    keyEquivalent: @"h"
3908                          atIndex: 7];
3909     [item setKeyEquivalentModifierMask: NSCommandKeyMask | NSAlternateKeyMask];
3910     [appMenu insertItem: [NSMenuItem separatorItem] atIndex: 8];
3911     [appMenu insertItemWithTitle: @"Quit Emacs"
3912                           action: @selector (terminate:)
3913                    keyEquivalent: @"q"
3914                          atIndex: 9];
3916     item = [mainMenu insertItemWithTitle: @"Emacs"
3917                                   action: @selector (menuDown:)
3918                            keyEquivalent: @""
3919                                  atIndex: 0];
3920     [mainMenu setSubmenu: appMenu forItem: item];
3922     [NSApp setMainMenu: mainMenu];
3923     [NSApp setAppleMenu: appMenu];
3924     [NSApp setServicesMenu: svcsMenu];
3925     /* Needed at least on Cocoa, to get dock menu to show windows */
3926     [NSApp setWindowsMenu: [[NSMenu alloc] init]];
3927   }
3928 #endif /* MAC OS X menu setup */
3930   [NSApp run];
3932   return dpyinfo;
3936 extern Lisp_Object Vauto_save_list_file_name;
3937 void
3938 ns_term_shutdown (int sig)
3940   /* code not reached in emacs.c after this is called by shut_down_emacs: */
3941   if (STRINGP (Vauto_save_list_file_name))
3942     unlink (SDATA (Vauto_save_list_file_name));
3944   ns_shutdown_properly = YES;
3945   [NSApp terminate: NSApp];
3949 void
3950 syms_of_nsterm ()
3952   NSTRACE (syms_of_nsterm);
3953   DEFVAR_LISP ("ns-input-file", &ns_input_file,
3954               "The file specified in the last NS event.");
3955   ns_input_file =Qnil;
3957   DEFVAR_LISP ("ns-input-text", &ns_input_text,
3958               "The data received in the last NS text drag event.");
3959   ns_input_text =Qnil;
3961   DEFVAR_LISP ("ns-working-text", &ns_working_text,
3962               "String for visualizing working composition sequence.");
3963   ns_working_text =Qnil;
3965   DEFVAR_LISP ("ns-input-font", &ns_input_font,
3966               "The font specified in the last NS event.");
3967   ns_input_font =Qnil;
3969   DEFVAR_LISP ("ns-input-fontsize", &ns_input_fontsize,
3970               "The fontsize specified in the last NS event.");
3971   ns_input_fontsize =Qnil;
3973   DEFVAR_LISP ("ns-input-line", &ns_input_line,
3974                "The line specified in the last NS event.");
3975   ns_input_line =Qnil;
3977   DEFVAR_LISP ("ns-input-color", &ns_input_color,
3978                "The color specified in the last NS event.");
3979   ns_input_color =Qnil;
3981   DEFVAR_LISP ("ns-input-spi-name", &ns_input_spi_name,
3982                "The service name specified in the last NS event.");
3983   ns_input_spi_name =Qnil;
3985   DEFVAR_LISP ("ns-input-spi-arg", &ns_input_spi_arg,
3986                "The service argument specified in the last NS event.");
3987   ns_input_spi_arg =Qnil;
3989   DEFVAR_LISP ("ns-alternate-modifier", &ns_alternate_modifier,
3990                "This variable describes the behavior of the alternate or option key.\n\
3991 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
3992 Set to none means that the alternate / option key is not interpreted by Emacs\n\
3993 at all, allowing it to be used at a lower level for accented character entry.");
3995   DEFVAR_LISP ("ns-command-modifier", &ns_command_modifier,
3996                "This variable describes the behavior of the command key.\n\
3997 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
3999   DEFVAR_LISP ("ns-control-modifier", &ns_control_modifier,
4000                "This variable describes the behavior of the control key.\n\
4001 Set to control, meta, alt, super, or hyper means it is taken to be that key.");
4003   DEFVAR_LISP ("ns-function-modifier", &ns_function_modifier,
4004                "This variable describes the behavior of the function key (on laptops).\n\
4005 Set to control, meta, alt, super, or hyper means it is taken to be that key.\n\
4006 Set to none means that the function key is not interpreted by Emacs at all,\n\
4007 allowing it to be used at a lower level for accented character entry.");
4009   DEFVAR_LISP ("ns-cursor-blink-rate", &ns_cursor_blink_rate,
4010                "Rate at which the Emacs cursor blinks (in seconds).\n\
4011 Set to nil to disable blinking.");
4013   DEFVAR_LISP ("ns-cursor-blink-mode", &ns_cursor_blink_mode,
4014                "Internal variable -- use M-x blink-cursor-mode or preferences\n\
4015 panel to control this setting.");
4017   DEFVAR_LISP ("ns-expand-space", &ns_expand_space,
4018                "Amount by which spacing between lines is expanded (positive)\n\
4019 or shrunk (negative).  Zero (the default) means standard line height.\n\
4020 (This variable should only be read, never set.)");
4022   DEFVAR_LISP ("ns-antialias-text", &ns_antialias_text,
4023                "Non-nil (the default) means to render text antialiased. Only has an effect on OS X Panther and above.");
4025   DEFVAR_LISP ("ns-use-qd-smoothing", &ns_use_qd_smoothing,
4026                "Whether to render text using QuickDraw (less heavy) antialiasing. Only has an effect on OS X Panther and above.  Default is nil (use Quartz smoothing).");
4028   DEFVAR_LISP ("ns-use-system-highlight-color",
4029                &ns_use_system_highlight_color,
4030                "Whether to use the system default (on OS X only) for the highlight color.  Nil means to use standard emacs (prior to version 21) 'grey'.");
4032   staticpro (&ns_display_name_list);
4033   ns_display_name_list = Qnil;
4035   staticpro (&last_mouse_motion_frame);
4036   last_mouse_motion_frame = Qnil;
4038 /*23: now apparently we need to tell emacs what modifiers there are.. */
4039   Qmodifier_value = intern ("modifier-value");
4040   Qalt = intern ("alt");
4041   Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
4042   Qhyper = intern ("hyper");
4043   Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
4044   Qmeta = intern ("meta");
4045   Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
4046   Qsuper = intern ("super");
4047   Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
4048   Qcontrol = intern ("control");
4049   Fput (Qcontrol, Qmodifier_value, make_number (ctrl_modifier));
4051   /*PENDING: move to common code */
4052   DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
4053                doc: /* If not nil, Emacs uses toolkit scroll bars.  */);
4054 #ifdef USE_TOOLKIT_SCROLL_BARS
4055   Vx_toolkit_scroll_bars = Qt; 
4056 #else
4057   Vx_toolkit_scroll_bars = Qnil;
4058 #endif
4060   /* these are unsupported but we need the declarations to avoid whining
4061      messages from cus-start.el */
4062   DEFVAR_BOOL ("x-use-underline-position-properties",
4063                &x_use_underline_position_properties,
4064      doc: /* NOT SUPPORTED UNDER NS.
4065 *Non-nil means make use of UNDERLINE_POSITION font properties.
4066 A value of nil means ignore them.  If you encounter fonts with bogus
4067 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
4068 to 4.1, set this to nil.
4070 NOTE: Not supported on Mac yet.  */);
4071   x_use_underline_position_properties = 0;
4073   DEFVAR_BOOL ("x-underline-at-descent-line",
4074                &x_underline_at_descent_line,
4075      doc: /* NOT SUPPORTED UNDER NS.
4076 *Non-nil means to draw the underline at the same place as the descent line.
4077 A value of nil means to draw the underline according to the value of the
4078 variable `x-use-underline-position-properties', which is usually at the
4079 baseline level.  The default value is nil.  */);
4080   x_underline_at_descent_line = 0;
4082   /* Tell emacs about this window system. */
4083   Fprovide (intern ("ns-windowing"), Qnil);
4084   /* PENDING: try to move this back into lisp (ns-win.el loaded too late
4085               right now */
4086   {
4087     Lisp_Object args[3] = { intern ("ns-version-string"), build_string ("9.0"),
4088                     build_string ("NS Window system port version number.") };
4089     Fdefconst (Flist (3, args));
4090   }
4095 /* ==========================================================================
4097     EmacsApp implementation
4099    ========================================================================== */
4102 @implementation EmacsApp
4104 - (void)logNotification: (NSNotification *)notification
4106   const char *name = [[notification name] UTF8String];
4107   if (!strstr (name, "Update") && !strstr (name, "NSMenu")
4108       && !strstr (name, "WindowNumber"))
4109     NSLog (@"notification: '%@'", [notification name]);
4113 - (void)sendEvent: (NSEvent *)theEvent
4114 /* --------------------------------------------------------------------------
4115      Events posted by ns_send_appdefined interrupt the run loop here
4116    -------------------------------------------------------------------------- */
4118   int type = [theEvent type];
4119   NSWindow *window = [theEvent window];
4120 /*  NSTRACE (sendEvent); */
4121 /*fprintf (stderr, "received event of type %d\n", [theEvent type]); */
4123   if (type == NSCursorUpdate && window == nil)
4124     {
4125       fprintf (stderr, "Dropping external cursor update event.\n");
4126       return;
4127     }
4129 #ifdef NS_IMPL_COCOA
4130   /* pass mouse down in resize handle and subsequent drags directly to
4131      EmacsWindow so we can generate continuous redisplays */
4132   if (ns_in_resize)
4133     {
4134       if (type == NSLeftMouseDragged)
4135         {
4136           [window mouseDragged: theEvent];
4137           return;
4138         }
4139       else if (type == NSLeftMouseUp)
4140         {
4141           [window mouseUp: theEvent];
4142           return;
4143         }
4144     }
4145   else if (type == NSLeftMouseDown)
4146     {
4147       NSRect r = ns_resize_handle_rect (window);
4148       if (NSPointInRect ([theEvent locationInWindow], r))
4149         {
4150           ns_in_resize = YES;
4151           [window mouseDown: theEvent];
4152           return;
4153         }
4154     }
4155 #endif
4157   if (type == NSApplicationDefined)
4158     {
4159       last_appdefined_event = theEvent;
4160       [self stop: self];
4161     }
4163   [super sendEvent: theEvent];
4167 - (void)showPreferencesWindow: (id)sender
4169   if (prefsController == nil)
4170     prefsController = [[EmacsPrefsController alloc] init];
4171   [prefsController showForFrame: SELECTED_FRAME ()];
4175 /* **************************************************************************
4177       EmacsApp delegate implementation
4179    ************************************************************************** */
4181 - (void)applicationDidFinishLaunching: (NSNotification *)notification
4182 /* --------------------------------------------------------------------------
4183      When application is loaded, terminate event loop in ns_term_init
4184    -------------------------------------------------------------------------- */
4186   NSTRACE (applicationDidFinishLaunching);
4187   [NSApp setServicesProvider: NSApp];
4188   ns_send_appdefined (-2);
4192 - (void) terminate: (id)sender
4194   BLOCK_INPUT;
4195   if (ns_shutdown_properly)
4196     [super terminate: sender];
4197   else
4198     {
4199 /*    Fkill_emacs (Qnil); */
4200       ns_shutdown_properly = YES;
4201       Feval (Fcons (intern ("save-buffers-kill-emacs"), Qnil));
4202     }
4203   UNBLOCK_INPUT;
4207 - (NSApplicationTerminateReply)applicationShouldTerminate: (id)sender
4209   if (ns_shutdown_properly)
4210     return NSTerminateNow;
4212   Lisp_Object contents = list3 (build_string ("Exit requested.  Would you like to Save Buffers and Exit, or Cancel the request?"),
4213       Fcons (build_string ("Cancel"), Qnil),
4214       Fcons (build_string ("Save and Exit"), Qt));
4215   Lisp_Object res = ns_popup_dialog (Qt, contents, Qnil);
4216 fprintf (stderr, "res = %d\n", EQ (res, Qt)); // FIXME
4217   if (EQ (res, Qt))
4218     {
4219       Feval (Fcons (intern ("save-buffers-kill-emacs"), Qnil));
4220       return NSTerminateNow;
4221     }
4222   return NSTerminateCancel;
4226 /* Open a file (used by below, after going into queue read by ns_read_socket) */
4227 -(BOOL) openFile: (NSString *)fileName
4229   struct frame *emacsframe = SELECTED_FRAME ();
4230   NSEvent *theEvent = [NSApp currentEvent];
4232   if (!emacs_event)
4233     return NO;
4235   emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4236   emacs_event->code = KEY_NS_OPEN_FILE_LINE;
4237   ns_input_file = append2 (ns_input_file, build_string ([fileName UTF8String]));
4238   ns_input_line = Qnil; /* can be start or cons start,end */
4239   emacs_event->modifiers =0;
4240   EV_TRAILER (theEvent);
4242   return YES;
4246 /*   Notification from the Workspace to open a file */
4247 - (BOOL)application: sender openFile: (NSString *)file
4249   [ns_pending_files addObject: file];
4250   return YES;
4254 /*   Open a file as a temporary file */
4255 - (BOOL)application: sender openTempFile: (NSString *)file
4257   [ns_pending_files addObject: file];
4258   return YES;
4262 /*   Notification from the Workspace to open a file noninteractively (?) */
4263 - (BOOL)application: sender openFileWithoutUI: (NSString *)file
4265   [ns_pending_files addObject: file];
4266   return YES;
4270 /*   Notification from the Workspace to open multiple files */
4271 - (void)application: sender openFiles: (NSArray *)fileList
4273   NSEnumerator *files = [fileList objectEnumerator];
4274   NSString *file;
4275   while ((file = [files nextObject]) != nil)
4276     [ns_pending_files addObject: file];
4277   return YES;
4280 /*PENDING: these may help w/IO switching btwn terminal and NSApp */
4281 - (void)applicationDidBecomeActive: (NSNotification *)notification
4284 - (void)applicationDidResignActive: (NSNotification *)notification
4286   ns_send_appdefined (-1);
4291 /* ==========================================================================
4293     EmacsApp aux handlers for managing event loop
4295    ========================================================================== */
4298 - (void)timeout_handler: (NSTimer *)timedEntry
4299 /* --------------------------------------------------------------------------
4300      The timeout specified to ns_select has passed.
4301    -------------------------------------------------------------------------- */
4303   /*NSTRACE (timeout_handler); */
4304   ns_send_appdefined (-2);
4307 extern void update_window_cursor (struct window *w, int on);
4309 - (void)cursor_blink_handler: (NSTimer *)cursorEntry
4310 /* --------------------------------------------------------------------------
4311      Flash the cursor
4312    -------------------------------------------------------------------------- */
4314   struct ns_display_info *dpyinfo = ns_display_list; /*HACK, but OK for now */
4315   struct frame *f = dpyinfo->ns_highlight_frame;
4316   NSTRACE (cursor_blink_handler);
4318   if (!f)
4319     return;
4320   if (f->output_data.ns->current_cursor == no_highlight)
4321     {
4322       Lisp_Object tem = get_frame_param (f, Qcursor_type);
4323       f->output_data.ns->desired_cursor = ns_lisp_to_cursor_type (tem);
4324     }
4325   else
4326     {
4327       f->output_data.ns->desired_cursor = no_highlight;
4328     }
4329   update_window_cursor (XWINDOW (FRAME_SELECTED_WINDOW (f)), 1);
4330   /*x_update_cursor (f, 1); */
4334 - (void)fd_handler: (NSTimer *) fdEntry
4335 /* --------------------------------------------------------------------------
4336      Check data waiting on file descriptors and terminate if so
4337    -------------------------------------------------------------------------- */
4339   int result;
4340   /* NSTRACE (fd_handler); */
4342   if (select_nfds == 0)
4343     return;
4345   memcpy (&t_readfds, &select_readfds, sizeof (fd_set));
4347   select_timeout.tv_sec = select_timeout.tv_usec = 0;
4348   result = select (select_nfds, &t_readfds, (SELECT_TYPE *)0, (SELECT_TYPE *)0,
4349                   &select_timeout);
4350   if (result)
4351     {
4352       memcpy (&select_readfds, &t_readfds, sizeof (fd_set));
4353       ns_send_appdefined (result);
4354     }
4359 /* ==========================================================================
4361     Service provision
4363    ========================================================================== */
4365 /* called from system: queue for next pass through event loop */
4366 - (void)requestService: (NSPasteboard *)pboard
4367               userData: (NSString *)userData
4368                  error: (NSString **)error
4370   [ns_pending_service_names addObject: userData];
4371   [ns_pending_service_args addObject: [NSString stringWithUTF8String:
4372       SDATA (ns_string_from_pasteboard (pboard))]];
4376 /* called from ns_read_socket to clear queue */
4377 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg
4379   struct frame *emacsframe = SELECTED_FRAME ();
4380   NSEvent *theEvent = [NSApp currentEvent];
4382   if (!emacs_event)
4383     return NO;
4385   emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4386   emacs_event->code = KEY_NS_SPI_SERVICE_CALL;
4387   ns_input_spi_name = build_string ([name UTF8String]);
4388   ns_input_spi_arg = build_string ([arg UTF8String]);
4389   emacs_event->modifiers = EV_MODIFIERS (theEvent);
4390   EV_TRAILER (theEvent);
4392   return YES;
4396 @end  /* EmacsApp */
4400 /* ==========================================================================
4402     EmacsView implementation
4404    ========================================================================== */
4407 @implementation EmacsView
4409 /* needed to inform when window closed from LISP */
4410 - (void) setWindowClosing: (BOOL)closing
4412   windowClosing = closing;
4416 - (void)dealloc
4418   NSTRACE (EmacsView_dealloc);
4419   [toolbar release];
4420   [super dealloc];
4424 /* called on font panel selection */
4425 - (void)changeFont: (id)sender
4427   NSEvent *e =[[self window] currentEvent];
4428   struct face *face =FRAME_DEFAULT_FACE (emacsframe);
4429   id newFont;
4430   float size;
4432   NSTRACE (changeFont);
4433   if (!emacs_event)
4434     return;
4436   if (newFont = [sender convertFont:
4437                            ((struct nsfont_info *)face->font)->nsfont])
4438     {
4439       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4440       emacs_event->modifiers = 0;
4441       emacs_event->code = KEY_NS_CHANGE_FONT;
4443       size = [newFont pointSize];
4444       /* PENDING: stick w/integer sizes for now. */
4445 /*        if (size == lrint (size)) */
4446         ns_input_fontsize = make_number (lrint (size));
4447 /*          else
4448             ns_input_fontsize = make_float (size); */
4449       ns_input_font = build_string ([[newFont familyName] UTF8String]);
4450       EV_TRAILER (e);
4451     }
4455 - (BOOL)acceptsFirstResponder
4457   NSTRACE (acceptsFirstResponder);
4458   return YES;
4462 - (void)resetCursorRects
4464   NSRect visible = [self visibleRect];
4465   NSCursor *currentCursor = FRAME_POINTER_TYPE (emacsframe);
4466   NSTRACE (resetCursorRects);
4468   if (currentCursor == nil)
4469     currentCursor = [NSCursor arrowCursor];
4471   if (!NSIsEmptyRect (visible))
4472     [self addCursorRect: visible cursor: currentCursor];
4473   [currentCursor setOnMouseEntered: YES];
4477 /*****************************************************************************/
4478 /* Keyboard handling. */
4479 #define NS_KEYLOG 0
4481 - (void)keyDown: (NSEvent *)theEvent
4483   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
4484   int code;
4485   unsigned fnKeysym = 0;
4486   int flags;
4487   static NSMutableArray *nsEvArray;
4488   static BOOL firstTime = YES;
4490   NSTRACE (keyDown);
4492   /* Rhapsody and OS X give up and down events for the arrow keys */
4493   if ([theEvent type] != NSKeyDown)
4494     return;
4496   if (!emacs_event)
4497     return;
4499 /*#if defined (COCOA_EXPERIMENTAL_CTRL_G) */
4500  if (![[self window] isKeyWindow])
4501    {
4502      /* PENDING: Using NO_SOCK_SIGIO like Carbon causes a condition in which,
4503         when Emacs display updates a different frame from the current one,
4504         and temporarily selects it, then processes some interrupt-driven
4505         input (dispnew.c:3878), OS will send the event to the correct NSWindow,
4506         but for some reason that window has its first responder set to the
4507         NSView most recently updated (I guess), which is not the correct one.
4508         UPDATE: After multi-TTY merge this happens even w/o NO_SOCK_SIGIO */
4509      if ([[theEvent window] isKindOfClass: [EmacsWindow class]])
4510          [[(EmacsView *)[theEvent window] delegate] keyDown: theEvent];
4511      return;
4512    }
4513 /*#endif */
4515   if (nsEvArray == nil)
4516     nsEvArray = [[NSMutableArray alloc] initWithCapacity: 1];
4518   [NSCursor setHiddenUntilMouseMoves: YES];
4520   if (dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
4521     {
4522       clear_mouse_face (dpyinfo);
4523       dpyinfo->mouse_face_hidden = 1;
4524     }
4526   if (!processingCompose)
4527     {
4528       code = ([[theEvent charactersIgnoringModifiers] length] == 0) ?
4529         0 : [[theEvent charactersIgnoringModifiers] characterAtIndex: 0];
4530       /* (Carbon way: [theEvent keyCode]) */
4532       /* is it a "function key"? */
4533       fnKeysym = ns_convert_key (code);
4534       if (fnKeysym)
4535         {
4536           /* COUNTERHACK: map 'Delete' on upper-right main KB to 'Backspace',
4537              because Emacs treats Delete and KP-Delete same (in simple.el). */
4538           if (fnKeysym == 0xFFFF && [theEvent keyCode] == 0x33)
4539             code = 0xFF08; /* backspace */
4540           else
4541             code = fnKeysym;
4542         }
4544       /* are there modifiers? */
4545       emacs_event->modifiers = 0;
4546       flags = [theEvent modifierFlags];
4548       if (flags & NSHelpKeyMask)
4549           emacs_event->modifiers |= hyper_modifier;
4551       if (flags & NSShiftKeyMask)
4552         emacs_event->modifiers |= shift_modifier;
4554       if (flags & NSCommandKeyMask)
4555         {
4556           emacs_event->modifiers |= parse_solitary_modifier (ns_command_modifier);
4557           /* if super (default), take input manager's word so things like
4558              dvorak / qwerty layout work */
4559           if (EQ (ns_command_modifier, Qsuper)
4560               && !fnKeysym
4561               && [[theEvent characters] length] != 0)
4562             {
4563               /* PENDING: the code we get will be unshifted, so if we have
4564                  a shift modifier, must convert ourselves */
4565               if (!(flags & NSShiftKeyMask))
4566                 code = [[theEvent characters] characterAtIndex: 0];
4567 #if 0
4568               /* this is ugly and also requires linking w/Carbon framework
4569                  (for LMGetKbdType) so for now leave this rare (?) case
4570                  undealt with.. in future look into CGEvent methods */
4571               else
4572                 {
4573                   long smv = GetScriptManagerVariable (smKeyScript);
4574                   Handle uchrHandle = GetResource
4575                     ('uchr', GetScriptVariable (smv, smScriptKeys));
4576                   UInt32 dummy = 0;
4577                   UCKeyTranslate ((UCKeyboardLayout*)*uchrHandle,
4578                                  [[theEvent characters] characterAtIndex: 0],
4579                                  kUCKeyActionDisplay,
4580                                  (flags & ~NSCommandKeyMask) >> 8,
4581                                  LMGetKbdType (), kUCKeyTranslateNoDeadKeysMask,
4582                                  &dummy, 1, &dummy, &code);
4583                   code &= 0xFF;
4584                 }
4585 #endif
4586             }
4587         }
4589       if (flags & NSControlKeyMask)
4590           emacs_event->modifiers |= parse_solitary_modifier (ns_control_modifier);
4592       if (flags & NS_FUNCTION_KEY_MASK && !fnKeysym)
4593           emacs_event->modifiers |= parse_solitary_modifier (ns_function_modifier);
4595       if (flags & NSAlternateKeyMask) /* default = meta */
4596         {
4597           if (EQ (ns_alternate_modifier, Qnone) && !fnKeysym)
4598             {   /* accept pre-interp alt comb */
4599               if ([[theEvent characters] length] > 0)
4600                 code = [[theEvent characters] characterAtIndex: 0];
4601               /*HACK: clear lone shift modifier to stop next if from firing */
4602               if (emacs_event->modifiers == shift_modifier)
4603                 emacs_event->modifiers = 0;
4604             }
4605           else
4606               emacs_event->modifiers |= parse_solitary_modifier (ns_alternate_modifier);
4607         }
4609 /*fprintf (stderr,"code =%x\tfnKey =%x\tflags = %x\tmods = %x\n",code,fnKeysym,flags,emacs_event->modifiers); */
4611       /* if it was a function key or had modifiers, pass it directly to emacs */
4612       if (fnKeysym || (emacs_event->modifiers
4613                        && [[theEvent charactersIgnoringModifiers] length] > 0))
4614 /*[[theEvent characters] length] */
4615         {
4616           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4617           if (code < 0x20)
4618             code |= (1<<28)|(3<<16);
4619           else if (code == 0x7f)
4620             code |= (1<<28)|(3<<16);
4621           else if (!fnKeysym)
4622             emacs_event->kind = code > 0xFF
4623               ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
4625           emacs_event->code = code;
4626           EV_TRAILER (theEvent);
4627           return;
4628         }
4629     }
4631   /* if we get here we should send the key for input manager processing */
4632   if (firstTime && [[NSInputManager currentInputManager]
4633                      wantsToDelayTextChangeNotifications] == NO)
4634     fprintf (stderr,
4635           "Emacs: WARNING: TextInput mgr wants marked text to be permanent!\n");
4636   firstTime = NO;
4638   if (NS_KEYLOG && !processingCompose)
4639     fprintf (stderr, "Begin compose sequence.\n");
4641   processingCompose = YES;
4642   [nsEvArray addObject: theEvent];
4643   [self interpretKeyEvents: nsEvArray];
4644   [nsEvArray removeObject: theEvent];
4648 /* <NSTextInput> implementation (called through super interpretKeyEvents:]). */
4651 /* <NSTextInput>: called through when done composing */
4652 - (void)insertText: (id)aString
4654   int code;
4655   int len = [(NSString *)aString length];
4656   int i;
4658 if (NS_KEYLOG) NSLog (@"insertText '%@'\tlen = %d", aString, len);
4659   processingCompose = NO;
4661   if (!emacs_event)
4662     return;
4664   /* first, clear any working text */
4665   if (workingText != nil)
4666     [self deleteWorkingText];
4668   /* now insert the string as keystrokes */
4669   for (i =0; i<len; i++)
4670     {
4671       code = [aString characterAtIndex: i];
4672       /* PENDING: still need this? */
4673       if (code == 0x2DC)
4674         code = '~'; /* 0x7E */
4675       emacs_event->modifiers = 0;
4676       emacs_event->kind
4677         = code > 0xFF ? MULTIBYTE_CHAR_KEYSTROKE_EVENT : ASCII_KEYSTROKE_EVENT;
4678       emacs_event->code = code;
4679       EV_TRAILER ((id)nil);
4680     }
4684 /* <NSTextInput>: inserts display of composing characters */
4685 - (void)setMarkedText: (id)aString selectedRange: (NSRange)selRange
4687   NSString *str = [aString respondsToSelector: @selector (string)] ?
4688     [aString string] : aString;
4689   if (NS_KEYLOG)
4690     NSLog (@"setMarkedText '%@' len =%d range %d from %d", str, [str length],
4691            selRange.length, selRange.location);
4693   if (workingText != nil)
4694     [self deleteWorkingText];
4695   if ([str length] == 0)
4696     return;
4698   if (!emacs_event)
4699     return;
4701   processingCompose = YES;
4702   workingText = [str copy];
4703   ns_working_text = build_string ([workingText UTF8String]);
4705   /* if in "echo area", not true minibuffer, can't show chars in interactive
4706      mode, so call using eval; otherwise we send a key event, which was the
4707      original way this was done */
4708   if (!EQ (Feval (Fcons (intern ("ns-in-echo-area"), Qnil)), Qnil))
4709     {
4710       Feval (Fcons (intern ("ns-echo-working-text"), Qnil));
4711       ns_send_appdefined (-1);
4712     }
4713   else
4714     {
4715       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4716       emacs_event->code = KEY_NS_INSERT_WORKING_TEXT;
4717       EV_TRAILER ((id)nil);
4718     }
4722 /* delete display of composing characters [not in <NSTextInput>] */
4723 - (void)deleteWorkingText
4725   if (workingText == nil)
4726     return;
4727   if (NS_KEYLOG)
4728     fprintf (stderr, "deleteWorkingText len =%d\n", [workingText length]);
4729   [workingText release];
4730   workingText = nil;
4731   processingCompose = NO;
4733   if (!emacs_event)
4734     return;
4736   if (!EQ (Feval (Fcons (intern ("ns-in-echo-area"), Qnil)), Qnil))
4737     {
4738       Feval (Fcons (intern ("ns-unecho-working-text"), Qnil));
4739       ns_send_appdefined (-1);
4740     }
4741   else
4742     {
4743       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4744       emacs_event->code = KEY_NS_DELETE_WORKING_TEXT;
4745       EV_TRAILER ((id)nil);
4746     }
4750 - (BOOL)hasMarkedText
4752   return workingText != nil;
4755 - (NSRange)markedRange
4757   NSRange rng = workingText != nil
4758     ? NSMakeRange (0, [workingText length]) : NSMakeRange (NSNotFound, 0);
4759 if (NS_KEYLOG) NSLog (@"markedRange request");
4760   return rng;
4763 - (void)unmarkText
4765 if (NS_KEYLOG) NSLog (@"unmark (accept) text");
4766   [self deleteWorkingText];
4767   processingCompose = NO;
4770 /* used to position char selection windows, etc. */
4771 - (NSRect)firstRectForCharacterRange: (NSRange)theRange
4773   NSRect rect;
4774   NSPoint pt;
4775   struct window *win = XWINDOW (FRAME_SELECTED_WINDOW (emacsframe));
4776 if (NS_KEYLOG) NSLog (@"firstRectForCharRange request");
4778   rect.size.width = theRange.length * FRAME_COLUMN_WIDTH (emacsframe);
4779   rect.size.height = FRAME_LINE_HEIGHT (emacsframe);
4780   pt.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (win, win->phys_cursor.x);
4781   pt.y = WINDOW_TO_FRAME_PIXEL_Y (win, win->phys_cursor.y
4782                                        +FRAME_LINE_HEIGHT (emacsframe));
4784   pt = [self convertPoint: pt toView: nil];
4785   pt = [[self window] convertBaseToScreen: pt];
4786   rect.origin = pt;
4787   return rect;
4790 - (long)conversationIdentifier
4792   return (long)self;
4795 /*PENDING: below here not yet implemented correctly, but may not be needed */
4797 - (void)doCommandBySelector: (SEL)aSelector
4799   if (NS_KEYLOG) NSLog (@"Do command by selector: %@",
4800                        NSStringFromSelector (aSelector));
4802   if (aSelector == @selector (deleteBackward:))
4803     {
4804       /* happens when user backspaces over an ongoing composition:
4805          throw a 'delete' into the event queue */
4806       if (!emacs_event)
4807         return;
4808       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
4809       emacs_event->code = 0xFF08;
4810       EV_TRAILER ((id)nil);
4811     }
4814 - (NSArray *)validAttributesForMarkedText
4816   static NSArray *arr = nil;
4817   if (arr == nil) arr = [NSArray new];
4818  /* [[NSArray arrayWithObject: NSUnderlineStyleAttributeName] retain]; */
4819   return arr;
4822 - (NSRange)selectedRange
4824 if (NS_KEYLOG) NSLog (@"selectedRange request");
4825   return NSMakeRange (NSNotFound, 0);
4828 - (unsigned int)characterIndexForPoint: (NSPoint)thePoint
4830 if (NS_KEYLOG) NSLog (@"characterIndexForPoint request");
4831   return 0;
4834 - (NSAttributedString *)attributedSubstringFromRange: (NSRange)theRange
4836   static NSAttributedString *str = nil;
4837   if (str == nil) str = [NSAttributedString new];
4838 if (NS_KEYLOG) NSLog (@"attributedSubstringFromRange request");
4839   return str;
4842 /* End <NSTextInput> impl. */
4843 /*****************************************************************************/
4846 /* This is what happens when the user presses a mouse button.  */
4847 - (void)mouseDown: (NSEvent *)theEvent
4849   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
4850   Lisp_Object window;
4852   NSTRACE (mouseDown);
4854   [self deleteWorkingText];
4856   if (!emacs_event)
4857     return;
4859   last_mouse_frame = emacsframe;
4860   /* appears to be needed to prevent spurious movement events generated on
4861      button clicks */
4862   last_mouse_frame->mouse_moved = 0;
4864   if ([theEvent type] == NSScrollWheel)
4865     {
4866       float delta = [theEvent deltaY];
4867       /* Mac notebooks send wheel events w/delta =0 when trackpad scrolling */
4868       if (delta == 0)
4869         return;
4870       emacs_event->kind = WHEEL_EVENT;
4871       emacs_event->code = 0;
4872       emacs_event->modifiers = EV_MODIFIERS (theEvent) |
4873         ((delta > 0) ? up_modifier : down_modifier);
4874     }
4875   else
4876     {
4877       emacs_event->kind = MOUSE_CLICK_EVENT;
4878       emacs_event->code = EV_BUTTON (theEvent);
4879       emacs_event->modifiers = EV_MODIFIERS (theEvent)
4880                              | EV_UDMODIFIERS (theEvent);
4881     }
4882   XSETINT (emacs_event->x, lrint (p.x));
4883   XSETINT (emacs_event->y, lrint (p.y));
4884   EV_TRAILER (theEvent);
4888 - (void)mouseUp: (NSEvent *)theEvent
4890   NSTRACE (mouseUp);
4891   [self mouseDown: theEvent];
4895 - (void)rightMouseDown: (NSEvent *)theEvent
4897   NSTRACE (rightMouseDown);
4898   [self mouseDown: theEvent];
4902 - (void)rightMouseUp: (NSEvent *)theEvent
4904   NSTRACE (rightMouseUp);
4905   [self mouseDown: theEvent];
4909 - (void) scrollWheel: (NSEvent *)theEvent
4911   NSTRACE (scrollWheel);
4912   [self mouseDown: theEvent];
4916 /* Tell emacs the mouse has moved. */
4917 - (void)mouseMoved: (NSEvent *)e
4919   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
4920   Lisp_Object frame;
4922   NSTRACE (mouseMoved);
4924   last_mouse_movement_time = EV_TIMESTAMP (e);
4925   last_mouse_motion_position
4926     = [self convertPoint: [e locationInWindow] fromView: nil];
4928   /* update any mouse face */
4929   if (dpyinfo->mouse_face_hidden)
4930     {
4931       dpyinfo->mouse_face_hidden = 0;
4932       clear_mouse_face (dpyinfo);
4933     }
4935   /* tooltip handling */
4936   previous_help_echo_string = help_echo_string;
4937   help_echo_string = Qnil;
4939   if (!note_mouse_movement (emacsframe, last_mouse_motion_position.x,
4940                             last_mouse_motion_position.y))
4941     help_echo_string = previous_help_echo_string;
4943   XSETFRAME (frame, emacsframe);
4944   if (!NILP (help_echo_string) || !NILP (previous_help_echo_string))
4945     {
4946       /* NOTE: help_echo_{window,pos,object} are set in xdisp.c
4947          (note_mouse_highlight), which is called through the
4948          note_mouse_movement () call above */
4949       gen_help_event (help_echo_string, frame, help_echo_window,
4950                       help_echo_object, help_echo_pos);
4951     }
4952   else
4953     {
4954       help_echo_string = Qnil;
4955       gen_help_event (Qnil, frame, Qnil, Qnil, 0);
4956     }
4958   if (emacsframe->mouse_moved && send_appdefined)
4959     ns_send_appdefined (-1);
4963 - (void)mouseDragged: (NSEvent *)e
4965   NSTRACE (mouseDragged);
4966   [self mouseMoved: e];
4970 - (void)rightMouseDragged: (NSEvent *)e
4972   NSTRACE (rightMouseDragged);
4973   [self mouseMoved: e];
4977 - (BOOL)windowShouldClose: (id)sender
4979   NSEvent *e =[[self window] currentEvent];
4981   NSTRACE (windowShouldClose);
4982   windowClosing = YES;
4983   if (ns_window_num <= 1)
4984     return NO;
4985   if (!emacs_event)
4986     return NO;
4987   emacs_event->kind = DELETE_WINDOW_EVENT;
4988   emacs_event->modifiers = 0;
4989   emacs_event->code = 0;
4990   EV_TRAILER (e);
4991   /* Don't close this window, let this be done from lisp code.  */
4992   return NO;
4996 - (NSSize)windowWillResize: (NSWindow *)sender toSize: (NSSize)frameSize
4997 /* normalize frame to gridded text size */
4999   NSTRACE (windowWillResize);
5000 /*fprintf (stderr,"Window will resize: %.0f x %.0f\n",frameSize.width,frameSize.height); */
5002   cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (emacsframe,
5003 #ifdef NS_IMPL_GNUSTEP
5004                                         frameSize.width + 3);
5005 #else
5006                                         frameSize.width);
5007 #endif
5008   if (cols < MINWIDTH)
5009     cols = MINWIDTH;
5010   frameSize.width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (emacsframe, cols);
5012   rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (emacsframe, frameSize.height
5013 #ifdef NS_IMPL_GNUSTEP
5014       - FRAME_NS_TITLEBAR_HEIGHT (emacsframe) + 3
5015         - FRAME_NS_TOOLBAR_HEIGHT (emacsframe));
5016 #else
5017       - FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5018         - FRAME_NS_TOOLBAR_HEIGHT (emacsframe));
5019 #endif
5020   if (rows < MINHEIGHT)
5021     rows = MINHEIGHT;
5022   frameSize.height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (emacsframe, rows)
5023                        + FRAME_NS_TITLEBAR_HEIGHT (emacsframe)
5024                        + FRAME_NS_TOOLBAR_HEIGHT (emacsframe);
5025 #ifdef NS_IMPL_COCOA
5026   {
5027     /* this sets window title to have size in it; the wm does this under GS */
5028     NSRect r = [[self window] frame];
5029     if (r.size.height == frameSize.height && r.size.width == frameSize.width)
5030       {
5031         if (old_title != 0)
5032           {
5033             xfree (old_title);
5034             old_title = 0;
5035           }
5036       }
5037     else
5038       {
5039         char *size_title;
5040         NSWindow *window = [self window];
5041         if (old_title == 0)
5042           {
5043             const char *t = [[[self window] title] UTF8String];
5044             char *pos = strstr (t, "  â€”  ");
5045             if (pos)
5046               *pos = '\0';
5047             old_title = (char *) xmalloc (strlen (t) + 1);
5048             strcpy (old_title, t);
5049           }
5050         size_title = xmalloc (strlen (old_title) + 40);
5051         sprintf (size_title, "%s  â€”  (%d x %d)", old_title, cols, rows);
5052         [window setTitle: [NSString stringWithUTF8String: size_title]];
5053         [window display];
5054         xfree (size_title);
5055       }
5056   }
5057 #endif /* NS_IMPL_COCOA */
5058 /*fprintf (stderr,"    ...size became %.0f x %.0f  (%d x %d)\n",frameSize.width,frameSize.height,cols,rows); */
5060   return frameSize;
5064 - (void)windowDidResize: (NSNotification *)notification
5066   NSWindow *theWindow = [notification object];
5068 #ifdef NS_IMPL_GNUSTEP
5069    /* in GNUstep, at least currently, it's possible to get a didResize
5070       without getting a willResize.. therefore we need to act as if we got
5071       the willResize now */
5072   NSSize sz = [theWindow frame].size;
5073   sz = [self windowWillResize: theWindow toSize: sz];
5074 #endif /* NS_IMPL_GNUSTEP */
5076   NSTRACE (windowDidResize);
5077 /*fprintf (stderr,"windowDidResize: %.0f\n",[theWindow frame].size.height); */
5079 #ifdef NS_IMPL_COCOA
5080   if (old_title != 0)
5081     {
5082       xfree (old_title);
5083       old_title = 0;
5084     }
5085 #endif /* NS_IMPL_COCOA */
5087   if (cols > 0 && rows > 0)
5088     x_set_window_size (emacsframe, 0, cols, rows);
5090   ns_send_appdefined (-1);
5091   [NSApp stopModal];
5095 - (void)windowDidBecomeKey: (NSNotification *)notification
5097   int val = ns_lisp_to_cursor_type (get_frame_param (emacsframe, Qcursor_type));
5098   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5099   struct frame *old_focus = dpyinfo->ns_focus_frame;
5101   NSTRACE (windowDidBecomeKey);
5103   if (emacsframe != old_focus)
5104     dpyinfo->ns_focus_frame = emacsframe;
5105   /*/last_mouse_frame = emacsframe;? */
5107   if (val >= 0)
5108     {
5109       FRAME_NEW_CURSOR (emacsframe) = val;
5110 /*    x_update_cursor (emacsframe, 1); // will happen in ns_frame_rehighlight */
5111     }
5113   ns_frame_rehighlight (emacsframe);
5115   if (emacs_event)
5116     {
5117       emacs_event->kind = FOCUS_IN_EVENT;
5118       EV_TRAILER ((id)nil);
5119     }
5123 - (void)windowDidResignKey: (NSNotification *)notification
5125   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5126   NSTRACE (windowDidResignKey);
5128   if (!windowClosing && [[self window] isVisible] == YES)
5129     {
5130       FRAME_NEW_CURSOR (emacsframe) = hollow_box;
5131       x_update_cursor (emacsframe, 1);
5132       FRAME_LAST_INACTIVE (emacsframe) = YES;
5133     }
5135   if (dpyinfo->ns_highlight_frame == emacsframe)
5136     dpyinfo->ns_highlight_frame = 0;
5137   if (dpyinfo->ns_focus_frame == emacsframe)
5138     dpyinfo->ns_focus_frame = 0;
5140   if (dpyinfo->mouse_face_mouse_frame == emacsframe)
5141     {
5142       clear_mouse_face (dpyinfo);
5143       dpyinfo->mouse_face_mouse_frame = 0;
5144     }
5146   if (emacs_event)
5147     {
5148       [self deleteWorkingText];
5149       emacs_event->kind = FOCUS_IN_EVENT;
5150       EV_TRAILER ((id)nil);
5151     }
5155 - (void)windowWillMiniaturize: sender
5157   NSTRACE (windowWillMiniaturize);
5161 - (BOOL)isFlipped
5163   return YES;
5167 - (BOOL)isOpaque
5169   return NO;
5173 - initFrameFromEmacs: (struct frame *)f
5175   NSRect r, wr;
5176   Lisp_Object tem;
5177   NSWindow *win;
5178   NSButton *toggleButton;
5179   int vbextra = NS_SCROLL_BAR_WIDTH (f);
5180   NSSize sz;
5181   NSColor *col;
5182   NSString *name;
5184   NSTRACE (initFrameFromEmacs);
5186   windowClosing = NO;
5187   processingCompose = NO;
5188   scrollbarsNeedingUpdate = 0;
5190 /*fprintf (stderr,"init with %d, %d\n",f->text_cols, f->text_lines); */
5192   r = NSMakeRect (0, 0, FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, f->text_cols),
5193                  FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, f->text_lines));
5194   [self initWithFrame: r];
5196   FRAME_NS_VIEW (f) = self;
5197   emacsframe = f;
5198   old_title = 0;
5200   win = [[EmacsWindow alloc]
5201             initWithContentRect: r
5202                       styleMask: (NSResizableWindowMask |
5203                                   NSMiniaturizableWindowMask |
5204                                   NSClosableWindowMask)
5205                         backing: NSBackingStoreBuffered
5206                           defer: YES];
5208   wr = [win frame];
5209   f->border_width = wr.size.width - r.size.width;
5210   FRAME_NS_TITLEBAR_HEIGHT (f) = wr.size.height - r.size.height;
5212   [win setAcceptsMouseMovedEvents: YES];
5213   [win setDelegate: self];
5214   [win useOptimizedDrawing: YES];
5216   sz.width = FRAME_COLUMN_WIDTH (f);
5217   sz.height = FRAME_LINE_HEIGHT (f);
5218   [win setResizeIncrements: sz];
5220   [[win contentView] addSubview: self];
5222   if (ns_drag_types)
5223     [self registerForDraggedTypes: ns_drag_types];
5225   tem = f->name;
5226   name = [NSString stringWithUTF8String:
5227                    NILP (tem) ? (unsigned char *)"Emacs" : SDATA (tem)];
5228   [win setTitle: name];
5230   /* toolbar support */
5231   toolbar = [[EmacsToolbar alloc] initForView: self withIdentifier:
5232                          [NSString stringWithFormat: @"Emacs Frame %d",
5233                                    ns_window_num]];
5234   [win setToolbar: toolbar];
5235   [toolbar setVisible: NO];
5236 #ifdef NS_IMPL_COCOA
5237   toggleButton = [win standardWindowButton: NSWindowToolbarButton];
5238   [toggleButton setTarget: self];
5239   [toggleButton setAction: @selector (toggleToolbar: )];
5240 #endif
5241   FRAME_NS_TOOLBAR_HEIGHT (f) = 0;
5243   tem = f->icon_name;
5244   if (!NILP (tem))
5245     [win setMiniwindowTitle:
5246            [NSString stringWithUTF8String: SDATA (tem)]];
5248   {
5249     NSScreen *screen = [win screen];
5251     if (screen != 0)
5252       [win setFrameTopLeftPoint: NSMakePoint
5253            (IN_BOUND (-SCREENMAX, f->left_pos, SCREENMAX),
5254             IN_BOUND (-SCREENMAX,
5255                      [screen frame].size.height - NS_TOP_POS (f), SCREENMAX))];
5256   }
5258   [win makeFirstResponder: self];
5260   col = ns_lookup_indexed_color (NS_FACE_BACKGROUND
5261                                   (FRAME_DEFAULT_FACE (emacsframe)), emacsframe);
5262   [win setBackgroundColor: col];
5263   if ([col alphaComponent] != 1.0)
5264     [win setOpaque: NO];
5266   [self allocateGState];
5268   ns_window_num++;
5269   return self;
5273 - (void)windowDidMove: sender
5275   NSWindow *win = [self window];
5276   NSRect r = [win frame];
5277   NSScreen *screen = [win screen];
5278   NSRect sr = [screen frame];
5280   NSTRACE (windowDidMove);
5282   if (!emacsframe->output_data.ns)
5283     return;
5284   if (screen != nil)
5285     {
5286       emacsframe->left_pos = r.origin.x; /* - sr.origin.x; */
5287       emacsframe->top_pos = sr.size.height -
5288         (r.origin.y + r.size.height); /* + sr.origin.y; */
5289     }
5292 #ifdef NS_IMPL_COCOA
5293 /* if we don't do this manually, the window will resize but not move */
5294 - (BOOL)windowShouldZoom: (NSWindow *)sender toFrame: (NSRect)newFrame
5296   [[self window] setFrame: newFrame display: NO];
5297   return YES;
5299 #endif
5301 /* Implement this to control size of frame on zoom.
5302 - (NSRect)windowWillUseStandardFrame:(NSWindow *)sender
5303                         defaultFrame:(NSRect)defaultFrame; */
5306 - (void)windowDidDeminiaturize: sender
5308   NSTRACE (windowDidDeminiaturize);
5309   if (!emacsframe->output_data.ns)
5310     return;
5311   emacsframe->async_visible   = 1;
5312   emacsframe->async_iconified = 0;
5313   windows_or_buffers_changed++;
5315   if (emacs_event)
5316     {
5317       emacs_event->kind = ICONIFY_EVENT;
5318       EV_TRAILER ((id)nil);
5319     }
5323 - (void)windowDidExpose: sender
5325   NSTRACE (windowDidExpose);
5326   if (!emacsframe->output_data.ns)
5327     return;
5328   emacsframe->async_visible = 1;
5329   SET_FRAME_GARBAGED (emacsframe);
5331   if (send_appdefined)
5332     ns_send_appdefined (-1);
5336 - (void)windowDidMiniaturize: sender
5338   NSTRACE (windowDidMiniaturize);
5339   if (!emacsframe->output_data.ns)
5340     return;
5342   emacsframe->async_iconified = 1;
5344   if (emacs_event)
5345     {
5346       emacs_event->kind = ICONIFY_EVENT;
5347       EV_TRAILER ((id)nil);
5348     }
5352 - (void)mouseEntered: (NSEvent *)theEvent
5354   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5355   struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (emacsframe);
5356   NSTRACE (mouseEntered);
5358   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
5362 - (void)mouseExited: (NSEvent *)theEvent
5364   NSPoint p = [self convertPoint: [theEvent locationInWindow] fromView: nil];
5365   NSRect r;
5366   struct ns_display_info *dpyinfo
5367     = emacsframe ? FRAME_NS_DISPLAY_INFO (emacsframe) : NULL;
5369   NSTRACE (mouseExited);
5371   if (dpyinfo || !emacsframe)
5372     return;
5374   last_mouse_movement_time = EV_TIMESTAMP (theEvent);
5376   if (emacsframe == dpyinfo->mouse_face_mouse_frame)
5377     {
5378       clear_mouse_face (dpyinfo);
5379       dpyinfo->mouse_face_mouse_frame = 0;
5380     }
5384 - menuDown: sender
5386   NSTRACE (menuDown);
5387   if (context_menu_value == -1)
5388     context_menu_value = [sender tag];
5389   else
5390     find_and_call_menu_selection (emacsframe, emacsframe->menu_bar_items_used,
5391                                   emacsframe->menu_bar_vector, [sender tag]);
5392   ns_send_appdefined (-1);
5393   return self;
5397 - (EmacsToolbar *)toolbar
5399   return toolbar;
5403 /* this gets called on toolbar button click */
5404 - toolbarClicked: (id)item
5406   NSEvent *theEvent;
5407   int idx = [item tag] * TOOL_BAR_ITEM_NSLOTS;
5409   NSTRACE (toolbarClicked);
5411   if (!emacs_event)
5412     return self;
5414   /* send first event (for some reason two needed) */
5415   theEvent =[[self window] currentEvent];
5416   emacs_event->kind = TOOL_BAR_EVENT;
5417   XSETFRAME (emacs_event->arg, emacsframe);
5418   EV_TRAILER (theEvent);
5420   emacs_event->kind = TOOL_BAR_EVENT;
5421 /*   XSETINT (emacs_event->code, 0); */
5422   emacs_event->arg = AREF (emacsframe->tool_bar_items,
5423                           idx + TOOL_BAR_ITEM_KEY);
5424   emacs_event->modifiers = EV_MODIFIERS (theEvent);
5425   EV_TRAILER (theEvent);
5426   return self;
5430 - toggleToolbar: (id)sender
5432   Lisp_Object lispFrame;
5433   XSETFRAME (lispFrame, emacsframe);
5434   Feval (Fcons (intern ("ns-toggle-toolbar"), Fcons (lispFrame, Qnil)));
5435   SET_FRAME_GARBAGED (emacsframe);
5436   ns_send_appdefined (-1);
5440 - (void)drawRect: (NSRect)rect
5442   int x = NSMinX (rect), y = NSMinY (rect);
5443   int width = NSWidth (rect), height = NSHeight (rect);
5445   NSTRACE (drawRect);
5447   if (!emacsframe || !emacsframe->output_data.ns)
5448     return;
5450   if (!ns_in_resize)
5451     ns_clear_frame_area (emacsframe, x, y, width, height);
5452   expose_frame (emacsframe, x, y, width, height);
5454   emacsframe->async_visible = 1;
5455   emacsframe->async_iconified = 0;
5457 /*    SET_FRAME_GARBAGED (emacsframe);
5458       ns_send_appdefined (-1); */
5462 /* NSDraggingDestination protocol methods.  Actually this is not really a
5463    protocol, but a category of Object.  O well...  */
5465 -(unsigned int) draggingEntered: (id <NSDraggingInfo>) sender
5467   NSTRACE (draggingEntered);
5468   return NSDragOperationGeneric;
5472 -(BOOL)prepareForDragOperation: (id <NSDraggingInfo>) sender
5474   return YES;
5478 -(BOOL)performDragOperation: (id <NSDraggingInfo>) sender
5480   id pb;
5481   int x, y;
5482   NSString *type;
5483   NSEvent *theEvent = [[self window] currentEvent];
5484   NSPoint position;
5486   NSTRACE (performDragOperation);
5488   if (!emacs_event)
5489     return;
5491   position = [self convertPoint: [sender draggingLocation] fromView: nil];
5492   x = lrint (position.x);  y = lrint (position.y);
5494   pb = [sender draggingPasteboard];
5495   type = [pb availableTypeFromArray: ns_drag_types];
5496   if (type == 0)
5497     {
5498       return NO;
5499     }
5500   else if ([type isEqualToString: NSFilenamesPboardType])
5501     {
5502       NSArray *files;
5503       NSEnumerator *fenum;
5504       NSString *file;
5506       if (!(files = [pb propertyListForType: type]))
5507         return NO;
5509       fenum = [files objectEnumerator];
5510       while ( (file = [fenum nextObject]) )
5511         {
5512           emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5513           emacs_event->code = KEY_NS_DRAG_FILE;
5514           XSETINT (emacs_event->x, x);
5515           XSETINT (emacs_event->y, y);
5516           ns_input_file = append2 (ns_input_file,
5517                                    build_string ([file UTF8String]));
5518           emacs_event->modifiers = EV_MODIFIERS (theEvent);
5519           EV_TRAILER (theEvent);
5520         }
5521       return YES;
5522     }
5523   else if ([type isEqualToString: NSURLPboardType])
5524     {
5525       NSString *file;
5526       NSURL *fileURL;
5528       if (!(fileURL = [NSURL URLFromPasteboard: pb]) ||
5529           [fileURL isFileURL] == NO)
5530         return NO;
5532       file = [fileURL path];
5533       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5534       emacs_event->code = KEY_NS_DRAG_FILE;
5535       XSETINT (emacs_event->x, x);
5536       XSETINT (emacs_event->y, y);
5537       ns_input_file = append2 (ns_input_file, build_string ([file UTF8String]));
5538       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5539       EV_TRAILER (theEvent);
5540       return YES;
5541     }
5542   else if ([type isEqualToString: NSStringPboardType]
5543            || [type isEqualToString: NSTabularTextPboardType])
5544     {
5545       NSString *data;
5547       if (! (data = [pb stringForType: type]))
5548         return NO;
5550       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5551       emacs_event->code = KEY_NS_DRAG_TEXT;
5552       XSETINT (emacs_event->x, x);
5553       XSETINT (emacs_event->y, y);
5554       ns_input_text = build_string ([data UTF8String]);
5555       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5556       EV_TRAILER (theEvent);
5557       return YES;
5558     }
5559   else if ([type isEqualToString: NSColorPboardType])
5560     {
5561       NSColor *c = [NSColor colorFromPasteboard: pb];
5562       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5563       emacs_event->code = KEY_NS_DRAG_COLOR;
5564       XSETINT (emacs_event->x, x);
5565       XSETINT (emacs_event->y, y);
5566       ns_input_color = ns_color_to_lisp (c);
5567       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5568       EV_TRAILER (theEvent);
5569       return YES;
5570     }
5571   else if ([type isEqualToString: NSFontPboardType])
5572     {
5573       /* impl based on GNUstep NSTextView.m */
5574       NSData *data = [pb dataForType: NSFontPboardType];
5575       NSDictionary *dict = [NSUnarchiver unarchiveObjectWithData: data];
5576       NSFont *font = [dict objectForKey: NSFontAttributeName];
5577       char fontSize[10];
5579       if (font == nil)
5580         return NO;
5582       emacs_event->kind = NON_ASCII_KEYSTROKE_EVENT;
5583       emacs_event->code = KEY_NS_CHANGE_FONT;
5584       XSETINT (emacs_event->x, x);
5585       XSETINT (emacs_event->y, y);
5586       ns_input_font = build_string ([[font fontName] UTF8String]);
5587       snprintf (fontSize, 10, "%f", [font pointSize]);
5588       ns_input_fontsize = build_string (fontSize);
5589       emacs_event->modifiers = EV_MODIFIERS (theEvent);
5590       EV_TRAILER (theEvent);
5591       return YES;
5592     }
5593   else
5594     {
5595       error ("Invalid data type in dragging pasteboard.");
5596       return NO;
5597     }
5601 - validRequestorForSendType: (NSString *)typeSent
5602                  returnType: (NSString *)typeReturned
5604   NSTRACE (validRequestorForSendType);
5605   if ([ns_send_types indexOfObjectIdenticalTo: typeSent] != NSNotFound &&
5606       [ns_return_types indexOfObjectIdenticalTo: typeSent] != NSNotFound)
5607     return self;
5609   return [super validRequestorForSendType: typeSent
5610                                returnType: typeReturned];
5614 /* setMini =YES means set from internal (gives a finder icon), NO means set nil
5615    (gives a miniaturized version of the window); currently we use the latter for
5616    frames whose active buffer doesn't correspond to any file
5617    (e.g., '*scratch*') */
5618 - setMiniwindowImage: (BOOL) setMini
5620   id image = [[self window] miniwindowImage];
5621   NSTRACE (setMiniwindowImage);
5623   /* NOTE: under Cocoa miniwindowImage always returns nil, documentation
5624      about "AppleDockIconEnabled" notwithstanding, however the set message
5625      below has its effect nonetheless. */
5626   if (image != emacsframe->output_data.ns->miniimage)
5627     {
5628       if (image && [image isKindOfClass: [EmacsImage class]])
5629         [image release];
5630       [[self window] setMiniwindowImage:
5631                        setMini ? emacsframe->output_data.ns->miniimage : nil];
5632     }
5634   return self;
5638 - (void) setRows: (int) r andColumns: (int) c
5640   rows = r;
5641   cols = c;
5644 @end  /* EmacsView */
5648 /* ==========================================================================
5650     EmacsWindow implementation
5652    ========================================================================== */
5654 @implementation EmacsWindow
5656 /* called only on resize clicks by special case in EmacsApp-sendEvent */
5657 - (void)mouseDown: (NSEvent *)theEvent
5659   if (ns_in_resize)
5660     {
5661       NSSize size = [[theEvent window] frame].size;
5662       grabOffset = [theEvent locationInWindow];
5663       grabOffset.x = size.width - grabOffset.x;
5664     }
5665   else
5666     [super mouseDown: theEvent];
5670 /* stop resizing */
5671 - (void)mouseUp: (NSEvent *)theEvent
5673   if (ns_in_resize)
5674     {
5675       struct frame *f = ((EmacsView *)[self delegate])->emacsframe;
5676       ns_in_resize = NO;
5677       ns_set_name_as_filename (f);
5678       [self display];
5679       ns_send_appdefined (-1);
5680     }
5681   else
5682     [super mouseUp: theEvent];
5686 /* send resize events */
5687 - (void)mouseDragged: (NSEvent *)theEvent
5689   if (ns_in_resize)
5690     {
5691       NSPoint p = [theEvent locationInWindow];
5692       NSSize size, vettedSize, origSize = [self frame].size;
5694       size.width = p.x + grabOffset.x;
5695       size.height = origSize.height - p.y + grabOffset.y;
5697       if (size.width == origSize.width && size.height == origSize.height)
5698         return;
5700       vettedSize = [[self delegate] windowWillResize: self toSize: size];
5701       if (vettedSize.width != size.width || vettedSize.height != size.height)
5702         {
5703           [[NSNotificationCenter defaultCenter]
5704             postNotificationName: NSWindowDidResizeNotification
5705                           object: self];
5706         }
5707     }
5708   else
5709     [super mouseDragged: theEvent];
5712 @end /* EmacsWindow */
5715 /* ==========================================================================
5717     EmacsScroller implementation
5719    ========================================================================== */
5722 @implementation EmacsScroller
5724 /* for repeat button push */
5725 #define SCROLL_BAR_FIRST_DELAY 0.5
5726 #define SCROLL_BAR_CONTINUOUS_DELAY (1.0 / 15)
5728 + (float) scrollerWidth
5730   /* PENDING: if we want to allow variable widths, this is the place to do it,
5731      however neither GNUstep nor Cocoa support it very well */
5732   return [NSScroller scrollerWidth];
5736 - initFrame: (NSRect )r window: (Lisp_Object)nwin
5738   NSTRACE (EmacsScroller_initFrame);
5740   r.size.width = [EmacsScroller scrollerWidth];
5741   [super initWithFrame: r/*NSMakeRect (0, 0, 0, 0)*/];
5742   [self setContinuous: YES];
5743   [self setEnabled: YES];
5745   /* Ensure auto resizing of scrollbars occurs within the emacs frame's view
5746      locked against the right, top and bottom edges. */
5747   [self setAutoresizingMask: NSViewMinXMargin | NSViewHeightSizable];
5749   win = nwin;
5750   condemned = NO;
5751   pixel_height = NSHeight (r);
5752   min_portion = 20 / pixel_height;
5754   frame = XFRAME (XWINDOW (win)->frame);
5755   if (FRAME_LIVE_P (frame))
5756     {
5757       int i;
5758       EmacsView *view = FRAME_NS_VIEW (frame);
5759       NSView *sview = [[view window] contentView];
5760       NSArray *subs = [sview subviews];
5762       /* disable optimization stopping redraw of other scrollbars */
5763       view->scrollbarsNeedingUpdate = 0;
5764       for (i =[subs count]-1; i >= 0; i--)
5765         if ([[subs objectAtIndex: i] isKindOfClass: [EmacsScroller class]])
5766           view->scrollbarsNeedingUpdate++;
5767       [sview addSubview: self];
5768     }
5770 /*  [self setFrame: r]; */
5772   return self;
5776 - (void)setFrame: (NSRect)newRect
5778   NSTRACE (EmacsScroller_setFrame);
5779 /*  BLOCK_INPUT; */
5780   pixel_height = NSHeight (newRect);
5781   min_portion = 20 / pixel_height;
5782   [super setFrame: newRect];
5783   [self display];
5784 /*  UNBLOCK_INPUT; */
5788 - (void)dealloc
5790   NSTRACE (EmacsScroller_dealloc);
5791   if (!NILP (win))
5792     XWINDOW (win)->vertical_scroll_bar = Qnil;
5793   [super dealloc];
5797 - condemn
5799   NSTRACE (condemn);
5800   condemned =YES;
5801   return self;
5805 - reprieve
5807   NSTRACE (reprieve);
5808   condemned =NO;
5809   return self;
5813 - judge
5815   NSTRACE (judge);
5816   if (condemned)
5817     {
5818       BLOCK_INPUT;
5819       /* ensure other scrollbar updates after deletion */
5820       EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
5821       if (view != nil)
5822         view->scrollbarsNeedingUpdate++;
5823       [self removeFromSuperview];
5824       [self release];
5825       UNBLOCK_INPUT;
5826     }
5827   return self;
5831 - (void)resetCursorRects
5833   NSRect visible = [self visibleRect];
5834   NSTRACE (resetCursorRects);
5836   if (!NSIsEmptyRect (visible))
5837     [self addCursorRect: visible cursor: [NSCursor arrowCursor]];
5838   [[NSCursor arrowCursor] setOnMouseEntered: YES];
5842 - (int) checkSamePosition: (int) position portion: (int) portion
5843                     whole: (int) whole
5845   return em_position ==position && em_portion ==portion && em_whole ==whole
5846     && portion != whole; /* needed for resize empty buf */
5850 - setPosition: (int)position portion: (int)portion whole: (int)whole
5852   NSTRACE (setPosition);
5854   em_position = position;
5855   em_portion = portion;
5856   em_whole = whole;
5858   if (portion >= whole)
5859     [self setFloatValue: 0.0 knobProportion: 1.0];
5860   else
5861     {
5862       float pos, por;
5863       portion = max ((float)whole*min_portion/pixel_height, portion);
5864       pos = (float)position / (whole - portion);
5865       por = (float)portion/whole;
5866       [self setFloatValue: pos knobProportion: por];
5867     }
5868 #ifdef NS_IMPL_GNUSTEP
5869   [self display];
5870 #endif
5871   return self;
5874 /* PENDING: unused at moment (see ns_mouse_position) at the moment because
5875    drag events will go directly to the EmacsScroller.  Leaving in for now. */
5876 -(void)getMouseMotionPart: (int *)part window: (Lisp_Object *)window
5877                         x: (Lisp_Object *)x y: ( Lisp_Object *)y
5879   *part = last_hit_part;
5880   *window = win;
5881   XSETINT (*y, pixel_height);
5882   if ([self floatValue] > 0.999)
5883     XSETINT (*x, pixel_height);
5884   else
5885     XSETINT (*x, pixel_height * [self floatValue]);
5889 /* set up emacs_event */
5890 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e
5892   if (!emacs_event)
5893     return;
5895   emacs_event->part = last_hit_part;
5896   emacs_event->code = 0;
5897   emacs_event->modifiers = EV_MODIFIERS (e) | down_modifier;
5898   emacs_event->frame_or_window = win;
5899   emacs_event->timestamp = EV_TIMESTAMP (e);
5900   emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5901   emacs_event->arg = Qnil;
5902   XSETINT (emacs_event->x, loc * pixel_height);
5903   XSETINT (emacs_event->y, pixel_height-20);
5905   n_emacs_events_pending++;
5906   kbd_buffer_store_event_hold (emacs_event, q_event_ptr);
5907   EVENT_INIT (*emacs_event);
5908   ns_send_appdefined (-1);
5912 /* called manually thru timer to implement repeated button action w/hold-down */
5913 - repeatScroll: (NSTimer *)scrollEntry
5915   NSEvent *e = [[self window] currentEvent];
5916   NSPoint p =  [[self window] mouseLocationOutsideOfEventStream];
5917   BOOL inKnob = [self testPart: p] == NSScrollerKnob;
5919   /* clear timer if need be */
5920   if (inKnob || [scroll_repeat_entry timeInterval] == SCROLL_BAR_FIRST_DELAY)
5921     {
5922         [scroll_repeat_entry invalidate];
5923         [scroll_repeat_entry release];
5924         scroll_repeat_entry = nil;
5926         if (inKnob)
5927           return self;
5929         scroll_repeat_entry
5930           = [[NSTimer scheduledTimerWithTimeInterval:
5931                         SCROLL_BAR_CONTINUOUS_DELAY
5932                                             target: self
5933                                           selector: @selector (repeatScroll:)
5934                                           userInfo: 0
5935                                            repeats: YES]
5936               retain];
5937     }
5939   [self sendScrollEventAtLoc: 0 fromEvent: e];
5940   return self;
5944 /* Asynchronous mouse tracking for scroller.  This allows us to dispatch
5945    mouseDragged events without going into a modal loop. */
5946 - (void)mouseDown: (NSEvent *)e
5948   NSRect sr, kr;
5949   /* hitPart is only updated AFTER event is passed on */
5950   NSScrollerPart part = [self testPart: [e locationInWindow]];
5951   double inc = 0.0, loc, kloc, pos;
5952   int edge = 0;
5954   NSTRACE (EmacsScroller_mouseDown);
5956   switch (part)
5957     {
5958     case NSScrollerDecrementPage:
5959         last_hit_part = scroll_bar_above_handle; inc = -1.0; break;
5960     case NSScrollerIncrementPage:
5961         last_hit_part = scroll_bar_below_handle; inc = 1.0; break;
5962     case NSScrollerDecrementLine:
5963       last_hit_part = scroll_bar_up_arrow; inc = -0.1; break;
5964     case NSScrollerIncrementLine:
5965       last_hit_part = scroll_bar_down_arrow; inc = 0.1; break;
5966     case NSScrollerKnob:
5967       last_hit_part = scroll_bar_handle; break;
5968     case NSScrollerKnobSlot:  /* GNUstep-only */
5969       last_hit_part = scroll_bar_move_ratio; break;
5970     default:  /* NSScrollerNoPart? */
5971       fprintf (stderr, "EmacsScoller-mouseDown: unexpected part %d\n", part);
5972       return;
5973     }
5975   if (inc != 0.0)
5976     {
5977       pos = 0;      /* ignored */
5979       /* set a timer to repeat, as we can't let superclass do this modally */
5980       scroll_repeat_entry
5981         = [[NSTimer scheduledTimerWithTimeInterval: 0.5
5982                                             target: self
5983                                           selector: @selector (repeatScroll:)
5984                                           userInfo: 0
5985                                            repeats: YES]
5986             retain];
5987     }
5988   else
5989     {
5990       /* handle, or on GNUstep possibly slot */
5991       NSEvent *fake_event;
5993       /* compute float loc in slot and mouse offset on knob */
5994       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
5995                       toView: nil];
5996       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
5997       if (loc <= 0.0)
5998         {
5999           loc = 0.0;
6000           edge = -1;
6001         }
6002       else if (loc >= NSHeight (sr))
6003         {
6004           loc = NSHeight (sr);
6005           edge = 1;
6006         }
6008       if (edge)
6009         kloc = 0.5 * edge;
6010       else
6011         {
6012           kr = [self convertRect: [self rectForPart: NSScrollerKnob]
6013                           toView: nil];
6014           kloc = NSHeight (kr) - ([e locationInWindow].y - NSMinY (kr));
6015         }
6016       last_mouse_offset = kloc;
6018       /* if knob, tell emacs a location offset by knob pos
6019          (to indicate top of handle) */
6020       if (part == NSScrollerKnob)
6021           pos = (loc - last_mouse_offset) / NSHeight (sr);
6022       else
6023         /* else this is a slot click on GNUstep: go straight there */
6024         pos = loc / NSHeight (sr);
6026       /* send a fake mouse-up to super to preempt modal -trackKnob: mode */
6027       fake_event = [NSEvent mouseEventWithType: NSLeftMouseUp
6028                                       location: [e locationInWindow]
6029                                  modifierFlags: [e modifierFlags]
6030                                      timestamp: [e timestamp]
6031                                   windowNumber: [e windowNumber]
6032                                        context: [e context]
6033                                    eventNumber: [e eventNumber]
6034                                     clickCount: [e clickCount]
6035                                       pressure: [e pressure]];
6036       [super mouseUp: fake_event];
6037     }
6039   if (part != NSScrollerKnob)
6040     [self sendScrollEventAtLoc: pos fromEvent: e];
6044 /* Called as we manually track scroller drags, rather than superclass. */
6045 - (void)mouseDragged: (NSEvent *)e
6047     NSRect sr;
6048     double loc, pos;
6049     int edge = 0;
6051     NSTRACE (EmacsScroller_mouseDragged);
6053       sr = [self convertRect: [self rectForPart: NSScrollerKnobSlot]
6054                       toView: nil];
6055       loc = NSHeight (sr) - ([e locationInWindow].y - NSMinY (sr));
6057       if (loc <= 0.0)
6058         {
6059           loc = 0.0;
6060           edge = -1;
6061         }
6062       else if (loc >= NSHeight (sr) + last_mouse_offset)
6063         {
6064           loc = NSHeight (sr) + last_mouse_offset;
6065           edge = 1;
6066         }
6068       pos = /*(edge ? loc :*/ (loc - last_mouse_offset) / NSHeight (sr);
6069       [self sendScrollEventAtLoc: pos fromEvent: e];
6073 - (void)mouseUp: (NSEvent *)e
6075   if (scroll_repeat_entry)
6076     {
6077       [scroll_repeat_entry invalidate];
6078       [scroll_repeat_entry release];
6079       scroll_repeat_entry = nil;
6080     }
6081   last_hit_part = 0;
6085 /* treat scrollwheel events in the bar as though they were in the main window */
6086 - (void) scrollWheel: (NSEvent *)theEvent
6088   EmacsView *view = (EmacsView *)FRAME_NS_VIEW (frame);
6089   [view mouseDown: theEvent];
6092 @end  /* EmacsScroller */
6096 /* ==========================================================================
6098     EmacsPrefsController implementation
6100    ========================================================================== */
6103 @implementation EmacsPrefsController
6105 /* in Tiger+, can just do [popup selectItemWithTag: tag]; */
6106 static void selectItemWithTag (NSPopUpButton *popup, int tag)
6108   NSEnumerator *items = [[popup itemArray] objectEnumerator];
6109   NSMenuItem *item;
6110   while (item = [items nextObject])
6111     {
6112       if ([item tag] == tag)
6113         {
6114           [popup selectItem: item];
6115           return;
6116         }
6117     }
6120 - init
6122   [NSBundle loadNibNamed: @"preferences" owner: self];
6123   return self;
6127 - (void) showForFrame: (struct frame *)f
6129   frame = f;
6130   [self setPanelFromValues];
6131   [prefsWindow makeKeyAndOrderFront: self];
6132   [prefsWindow display];
6136 - (void) setPanelFromValues
6138   int cursorType
6139     = ns_lisp_to_cursor_type (get_frame_param (frame, Qcursor_type));
6140   prevExpandSpace = XFLOATINT (ns_expand_space);
6141   prevBlinkRate = NILP (ns_cursor_blink_rate)
6142     ? 0 : XFLOATINT (ns_cursor_blink_rate);
6144 #ifdef NS_IMPL_COCOA
6145   prevUseHighlightColor = ns_use_system_highlight_color;
6146 #endif
6148   [expandSpaceSlider setFloatValue: prevExpandSpace];
6149   [cursorBlinkSlider setFloatValue: prevBlinkRate];
6150   [cursorTypeMatrix selectCellWithTag: (cursorType == filled_box ? 1 :
6151                                         (cursorType == bar ? 2 :
6152                                          (cursorType == underscore ? 3 : 4)))];
6153   selectItemWithTag (alternateModMenu,
6154                      parse_solitary_modifier (ns_alternate_modifier));
6155   selectItemWithTag (commandModMenu,
6156                      parse_solitary_modifier (ns_command_modifier));
6157 #ifdef NS_IMPL_COCOA
6158   selectItemWithTag (controlModMenu,
6159                      parse_solitary_modifier (ns_control_modifier));
6160   selectItemWithTag (functionModMenu,
6161                      parse_solitary_modifier (ns_function_modifier));
6162   [smoothFontsCheck setState: (NILP (ns_antialias_text) ? NO : YES)];
6163   [useQuickdrawCheck setState: (NILP (ns_use_qd_smoothing) ? NO : YES)];
6164   [useSysHiliteCheck setState: (NILP (prevUseHighlightColor) ? NO : YES)];
6165 #endif
6169 - (void) setValuesFromPanel
6171   int cursorTag = [[cursorTypeMatrix selectedCell] tag];
6172   int altTag = [[alternateModMenu selectedItem] tag];
6173   int cmdTag = [[commandModMenu selectedItem] tag];
6174 #ifdef NS_IMPL_COCOA
6175   int ctrlTag = [[controlModMenu selectedItem] tag];
6176   int fnTag = [[functionModMenu selectedItem] tag];
6177 #endif
6178   float blinkRate = [cursorBlinkSlider floatValue];
6179   float expandSpace = [expandSpaceSlider floatValue];
6180   Lisp_Object old_cursor_blink_mode;
6182   if (expandSpace != prevExpandSpace)
6183     {
6184       ns_expand_space = make_float (expandSpace);
6185       /* PENDING: more needed: store needed metrics in nsfont_info, update
6186          frame default font max_bounds and fontp, recompute faces */
6187 /*         FRAME_LINE_HEIGHT (frame) *= (expandSpace / prevExpandSpace);
6188            x_set_window_size (frame, 0, frame->text_cols, frame->text_lines); */
6189       prevExpandSpace = expandSpace;
6190     }
6191   if (blinkRate != prevBlinkRate)
6192     {
6193       old_cursor_blink_mode = ns_cursor_blink_mode;
6194       if (blinkRate == 0.0)
6195         {
6196           ns_cursor_blink_rate = Qnil;
6197           ns_cursor_blink_mode = Qnil;
6198         }
6199       else
6200         {
6201           ns_cursor_blink_rate = make_float (blinkRate);
6202           ns_cursor_blink_mode = Qt;
6203         }
6204       if (!EQ (ns_cursor_blink_mode, old_cursor_blink_mode))
6205           Feval (Fcons (intern ("blink-cursor-mode"), Qnil));
6207       if (blinkRate != 0.0 && prevBlinkRate != 0.0)
6208         {  /* if changed rates, remove blink handler so change picked up */
6209           struct ns_display_info *dpyinfo = FRAME_NS_DISPLAY_INFO (frame);
6210           [cursor_blink_entry invalidate];
6211           [cursor_blink_entry release];
6212           cursor_blink_entry = 0;
6213           if (dpyinfo->ns_highlight_frame)
6214             {
6215               Lisp_Object tem
6216                 = get_frame_param (dpyinfo->ns_highlight_frame, Qcursor_type);
6217               dpyinfo->ns_highlight_frame->output_data.ns->desired_cursor
6218                 = ns_lisp_to_cursor_type (tem);
6219             }
6220         }
6221       prevBlinkRate = blinkRate;
6222     }
6223   FRAME_NEW_CURSOR (frame)
6224     = (cursorTag == 1 ? filled_box
6225        : cursorTag == 2 ? bar
6226        : cursorTag == 3 ? underscore : hollow_box);
6227   store_frame_param (frame, Qcursor_type,
6228                     ns_cursor_type_to_lisp (FRAME_NEW_CURSOR (frame)));
6229   ns_alternate_modifier = ns_mod_to_lisp (altTag);
6230   ns_command_modifier = ns_mod_to_lisp (cmdTag);
6231 #ifdef NS_IMPL_COCOA
6232   ns_control_modifier = ns_mod_to_lisp (ctrlTag);
6233   ns_function_modifier = ns_mod_to_lisp (fnTag);
6234   ns_antialias_text = [smoothFontsCheck state] ? Qt : Qnil;
6235   ns_use_qd_smoothing = [useQuickdrawCheck state] ? Qt : Qnil;
6236   ns_use_system_highlight_color = [useSysHiliteCheck state] ? Qt : Qnil;
6237   if (! EQ (ns_use_system_highlight_color, prevUseHighlightColor))
6238     {
6239       prevUseHighlightColor = ns_use_system_highlight_color;
6240       if (EQ (ns_use_system_highlight_color, Qt))
6241         {
6242           ns_selection_color = [[NSUserDefaults standardUserDefaults]
6243                                  stringForKey: @"AppleHighlightColor"];
6244           if (ns_selection_color == nil)
6245             ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
6246         }
6247       else
6248         ns_selection_color = NS_SELECTION_COLOR_DEFAULT;
6249     }
6250 #endif /* NS_IMPL_COCOA */
6251   Fcall_interactively (intern ("ns-save-preferences"), Qnil, Qnil);
6255 /* buttons */
6256 - (IBAction)cancel: (id)sender
6258   [prefsWindow close];
6262 - (IBAction)ok: (id)sender
6264   [self setValuesFromPanel];
6265   [prefsWindow close];
6269 - (IBAction)resetToDefaults: (id)sender
6271   ns_set_default_prefs ();
6272   [self setPanelFromValues];
6276 - (IBAction)runHelp: (id)sender
6278   Feval (Fcons (intern ("info"),
6279               Fcons (build_string ("(ns-emacs)Preferences Panel"), Qnil)));
6280   SET_FRAME_GARBAGED (frame);
6281   ns_send_appdefined (-1);
6285 - (IBAction)setColors: (id)sender
6287   Lisp_Object lispFrame;
6288   XSETFRAME (lispFrame, frame);
6289   Fns_popup_color_panel (lispFrame);
6293 - (IBAction)setDefaultFont: (id)sender
6295   Lisp_Object lispFrame;
6296   XSETFRAME (lispFrame, frame);
6297   Fns_popup_font_panel (lispFrame);
6300 @end  /* EmacsPrefsController */
6305 /* ==========================================================================
6307    Font-related functions; these used to be in nsfaces.m
6309    ========================================================================== */
6312 Lisp_Object
6313 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
6315   struct font *font = XFONT_OBJECT (font_object);
6317   if (fontset < 0)
6318     fontset = fontset_from_font (font_object);
6319   FRAME_FONTSET (f) = fontset;
6321   if (FRAME_FONT (f) == font)
6322     /* This font is already set in frame F.  There's nothing more to
6323        do.  */
6324     return font_object;
6326   FRAME_FONT (f) = font;
6328   FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
6329   FRAME_COLUMN_WIDTH (f) = font->average_width;
6330   FRAME_SPACE_WIDTH (f) = font->space_width;
6331   FRAME_LINE_HEIGHT (f) = font->height;
6333   compute_fringe_widths (f, 1);
6335   /* Compute the scroll bar width in character columns.  */
6336   if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
6337     {
6338       int wid = FRAME_COLUMN_WIDTH (f);
6339       FRAME_CONFIG_SCROLL_BAR_COLS (f)
6340         = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid - 1) / wid;
6341     }
6342   else
6343     {
6344       int wid = FRAME_COLUMN_WIDTH (f);
6345       FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
6346     }
6348   /* Now make the frame display the given font.  */
6349   if (FRAME_NS_WINDOW (f) != 0)
6350         x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
6352   return font_object;
6356 Lisp_Object
6357 ns_list_fonts (FRAME_PTR f, Lisp_Object pattern, int size, int maxnames)
6358 /* --------------------------------------------------------------------------
6359      This is used by the xfaces system.  It is expected to speak XLFD.
6360    -------------------------------------------------------------------------- */
6362   Lisp_Object list = Qnil,
6363     rpattern,
6364     key,
6365     tem,
6366     args[2];
6367   struct re_pattern_buffer *bufp;
6368   id fm = [NSFontManager sharedFontManager];
6369   NSEnumerator *fenum, *senum;
6370   NSArray *membInfo;
6371   NSString *fontname;
6372   const char *xlfdName;
6373   char *pattFam;
6374   char *patt;
6375   NSString *famName;
6377   NSTRACE (ns_list_fonts);
6379   CHECK_STRING (pattern);
6380   patt = SDATA (pattern);
6382 #if 0
6383 /* temporary: for font_backend, we use fontsets, and when these are defined,
6384    the old XLFD-based system is used; eventually this will be replaced by
6385    backend code, but for now we allow specs that are just family names */
6386       /* if pattern is not XLFD, panic now */
6387       if (patt[0] != '-')
6388         error ("ns_list_fonts: X font name (XLFD) expected.");
6390       /* if unicode encoding not requested, also die */
6391       if (!strstr (patt, "iso10646") && patt[strlen (patt)-3] != '*')
6392         return Qnil;
6393 #endif /* 0 */
6395   key = f ? Fcons (pattern, make_number (maxnames)) : Qnil;
6396   tem = f ? XCDR (FRAME_NS_DISPLAY_INFO (f)->name_list_element) : Qnil;
6398   /* See if we cached the result for this particular query.
6399      The cache is an alist of the form:
6400      ((((PATTERN . MAXNAMES) FONTNAME) ...) ...)
6401   */
6402   if (f && !NILP (list = Fassoc (key, tem)))
6403     {
6404       list = Fcdr_safe (list);
6405       /* We have a cached list.  Don't have to get the list again.  */
6406       if (!NILP (list))
6407         return list;
6408     }
6410   if (patt[0] != '-')
6411       pattFam = patt;
6412   else
6413       pattFam = ns_xlfd_to_fontname (patt);
6414   /*PENDING: '*' at beginning matches literally.. */
6415   if (pattFam[0] == '*')
6416     pattFam[0] = '.';
6418   /* must start w/family name, but can have other stuff afterwards
6419     (usually bold and italic specifiers) */
6420   args[0] = build_string ("^");
6421   args[1] = build_string (pattFam);
6422   rpattern = Fconcat (2, args);
6423   bufp = compile_pattern (rpattern, 0, Vascii_canon_table, 0, 0);
6425   list = Qnil;
6426   fenum = [[fm availableFontFamilies] objectEnumerator];
6427   while ( (famName = [fenum nextObject]) )
6428     {
6429       NSMutableString *tmp = [famName mutableCopy];
6430       const char *fname;
6431       NSRange r;
6433       /* remove spaces, to look like postscript name */
6434       while ((r = [tmp rangeOfString: @" "]).location != NSNotFound)
6435         [tmp deleteCharactersInRange: r];
6437       fname = [tmp UTF8String];
6438       int len = strlen (fname);
6439       BOOL foundItal;
6440       const char *synthItalFont;
6442       if (re_search (bufp, fname, len, 0, len, 0) >= 0)
6443         {
6444           /* Found a family.  Add all variants.  If we have no italic variant,
6445              add a synthItal. */
6446           senum =[[fm availableMembersOfFontFamily: famName] objectEnumerator];
6447           foundItal = NO;
6448           synthItalFont = NULL;
6449           while (membInfo = [senum nextObject])
6450             {
6451               xlfdName
6452                 = ns_fontname_to_xlfd ([[membInfo objectAtIndex: 0]
6453                                          UTF8String]);
6454               list = Fcons (build_string (xlfdName), list);
6455               if (!synthItalFont)
6456                 {
6457                   NSString *synthName
6458                     = [[membInfo objectAtIndex: 0]
6459                         stringByAppendingString: @"-synthItal"];
6460                   synthItalFont = [synthName UTF8String];
6461                 }
6462               else if ([[membInfo objectAtIndex: 3] intValue]
6463                          & NSItalicFontMask)
6464                 foundItal = YES;
6465             }
6466           if (foundItal == NO)
6467             {
6468               xlfdName = ns_fontname_to_xlfd (synthItalFont);
6469               list = Fcons (build_string (xlfdName), list);
6470             }
6471         }
6472       [tmp release];
6473     }
6475   /* fallback */
6476   if (XFASTINT (Flength (list)) == 0)
6477       list = Fcons (build_string (ns_fontname_to_xlfd ("Monaco")), list);
6479   /* store result in cache */
6480   if (f != NULL)
6481     XCDR_AS_LVALUE (FRAME_NS_DISPLAY_INFO (f)->name_list_element)
6482       = Fcons (Fcons (key, list),
6483                XCDR (FRAME_NS_DISPLAY_INFO (f)->name_list_element));
6484   return list;
6488 /* XLFD: -foundry-family-weight-slant-swidth-adstyle-pxlsz-ptSz-resx-resy-spc-avgWidth-rgstry-encoding */
6490 const char *
6491 ns_font_to_xlfd (NSFont *nsfont)
6492 /* --------------------------------------------------------------------------
6493     Convert an NS font name to an X font name (XLFD).
6494     The string returned is temporarily allocated.
6495    -------------------------------------------------------------------------- */
6497   NSFontManager *mgr = [NSFontManager sharedFontManager];
6498   NSString *sname = [nsfont /*familyName*/fontName];
6499   char *famName = [sname UTF8String];
6500   char *weightStr = [mgr fontNamed: sname hasTraits: NSBoldFontMask] ?
6501       "bold" : "medium";
6502   char *slantStr = [mgr fontNamed: sname hasTraits: NSItalicFontMask] ?
6503       "i" : "r";
6504   int size = [nsfont pointSize];
6505   int aWidth = lrint (10.0 * [nsfont widthOfString: @"a"]);
6506   const char *xlfd;
6507   int i, len;
6509   /* change '-' to '$' to avoid messing w/XLFD separator */
6510   for (len =strlen (famName), i =0; i<len; i++)
6511     if (famName[i] == '-')
6512       {
6513         famName[i] = '\0';
6514         break;
6515       }
6517   xlfd = [[NSString stringWithFormat:
6518                        @"-apple-%s-%s-%s-normal--%d-%d-75-75-m-%d-iso10646-1",
6519                        famName, weightStr, slantStr, size, 10*size, aWidth]
6520                   UTF8String];
6521 /*fprintf (stderr, "converted '%s' to '%s'\n",name,xlfd); */
6522   return xlfd;
6525 const char *
6526 ns_fontname_to_xlfd (const char *name)
6527 /* --------------------------------------------------------------------------
6528     Convert an NS font name to an X font name (XLFD).
6529     Sizes are set to 0.
6530     The string returned is temporarily allocated.
6531    -------------------------------------------------------------------------- */
6533   char famName[180];
6534   char *weightStr = strcasestr (name, "bold") ? "bold" : "medium";
6535   char *slantStr = strcasestr (name, "italic") || strcasestr (name, "oblique")
6536     || strcasestr (name, "synthital") ? "i" : "r";
6537   int i, len;
6538   const char *xlfd;
6540   /* change '-' to '$' to avoid messing w/XLFD separator, and ' ' to '_' */
6541   bzero (famName, 180);
6542   bcopy (name, famName, max (strlen (name), 179));
6543   for (len =strlen (famName), i =0; i<len; i++)
6544     {
6545       if (famName[i] == '-')
6546         famName[i] = '$';
6547       else if (famName[i] == ' ')
6548         famName[i] = '_';
6549     }
6551   xlfd = [[NSString stringWithFormat:
6552                            @"-apple-%s-%s-%s-normal--0-0-75-75-m-0-iso10646-1",
6553                            famName, weightStr, slantStr]
6554                   UTF8String];
6555 /*fprintf (stderr, "converted '%s' to '%s'\n",name,xlfd); */
6556   return xlfd;
6560 const char *
6561 ns_xlfd_to_fontname (const char *xlfd)
6562 /* --------------------------------------------------------------------------
6563     Convert an X font name (XLFD) to an NS font name.
6564     Only family is used.
6565     The string returned is temporarily allocated.
6566    -------------------------------------------------------------------------- */
6568   char *name = xmalloc (180);
6569   int i, len;
6570   const char *ret;
6571   
6572   if (!strncmp (xlfd, "--", 2))
6573     sscanf (xlfd, "--%*[^-]-%[^-]179-", name);
6574   else
6575     sscanf (xlfd, "-%*[^-]-%[^-]179-", name);
6577   /* stopgap for malformed XLFD input */
6578   if (strlen (name) == 0)
6579     strcpy (name, "Monaco");
6581   /* undo hack in ns_fontname_to_xlfd, converting '$' to '-', '_' to ' '
6582      also uppercase after '-' or ' ' */
6583   name[0] = toupper (name[0]);
6584   for (len =strlen (name), i =0; i<len; i++)
6585     {
6586       if (name[i] == '$')
6587         {
6588           name[i] = '-';
6589           if (i+1<len)
6590             name[i+1] = toupper (name[i+1]);
6591         }
6592       else if (name[i] == '_')
6593         {
6594           name[i] = ' ';
6595           if (i+1<len)
6596             name[i+1] = toupper (name[i+1]);
6597         }
6598     }
6599 /*fprintf (stderr, "converted '%s' to '%s'\n",xlfd,name);  */
6600   ret = [[NSString stringWithUTF8String: name] UTF8String];
6601   xfree (name);
6602   return ret;
6605 // arch-tag: 6eaa8f7d-a69b-4e1c-b43d-ab31defbe0d2