code.delx.au - gnu-emacs/blob - src/nsterm.m

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