src/nsterm.m

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