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