src/nsterm.m

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