src/nsterm.m

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