src/nsterm.m

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