nsterm.m 219 KB
Newer Older
1
/* NeXT/Open/GNUstep / MacOSX communication module.
2

3 4
Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2013 Free Software
Foundation, Inc.
5 6 7

This file is part of GNU Emacs.

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 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
12 13 14 15 16 17 18

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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 23 24 25 26 27 28
Originally by Carl Edman
Updated by Christian Limpach (chris@nice.ch)
OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
*/

29 30
/* This should be the first include, as it may set up #defines affecting
   interpretation of even the system includes. */
Dan Nicolaescu's avatar
Dan Nicolaescu committed
31
#include <config.h>
32

33
#include <fcntl.h>
34
#include <math.h>
35
#include <pthread.h>
36 37
#include <sys/types.h>
#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 46 47 48 49 50 51 52 53 54 55 56 57 58 59

#include "lisp.h"
#include "blockinput.h"
#include "sysselect.h"
#include "nsterm.h"
#include "systime.h"
#include "character.h"
#include "fontset.h"
#include "composite.h"
#include "ccl.h"

#include "termhooks.h"
#include "termchar.h"

#include "window.h"
#include "keyboard.h"
60
#include "buffer.h"
61 62
#include "font.h"

63 64 65 66
#ifdef NS_IMPL_GNUSTEP
#include "process.h"
#endif

67 68 69 70 71 72
#ifdef NS_IMPL_COCOA
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
#include "macfont.h"
#endif
#endif

73 74 75 76 77 78 79 80 81
/* call tracing */
#if 0
int term_trace_num = 0;
#define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
                                __FILE__, __LINE__, ++term_trace_num)
#else
#define NSTRACE(x)
#endif

82
extern NSString *NSMenuDidBeginTrackingNotification;
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

/* ==========================================================================

    Local declarations

   ========================================================================== */

/* Convert a symbol indexed with an NSxxx value to a value as defined
   in keyboard.c (lispy_function_key). I hope this is a correct way
   of doing things... */
static unsigned convert_ns_to_X_keysym[] =
{
  NSHomeFunctionKey,            0x50,
  NSLeftArrowFunctionKey,       0x51,
  NSUpArrowFunctionKey,         0x52,
  NSRightArrowFunctionKey,      0x53,
  NSDownArrowFunctionKey,       0x54,
  NSPageUpFunctionKey,          0x55,
  NSPageDownFunctionKey,        0x56,
  NSEndFunctionKey,             0x57,
  NSBeginFunctionKey,           0x58,
  NSSelectFunctionKey,          0x60,
  NSPrintFunctionKey,           0x61,
106
  NSClearLineFunctionKey,       0x0B,
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
  NSExecuteFunctionKey,         0x62,
  NSInsertFunctionKey,          0x63,
  NSUndoFunctionKey,            0x65,
  NSRedoFunctionKey,            0x66,
  NSMenuFunctionKey,            0x67,
  NSFindFunctionKey,            0x68,
  NSHelpFunctionKey,            0x6A,
  NSBreakFunctionKey,           0x6B,

  NSF1FunctionKey,              0xBE,
  NSF2FunctionKey,              0xBF,
  NSF3FunctionKey,              0xC0,
  NSF4FunctionKey,              0xC1,
  NSF5FunctionKey,              0xC2,
  NSF6FunctionKey,              0xC3,
  NSF7FunctionKey,              0xC4,
  NSF8FunctionKey,              0xC5,
  NSF9FunctionKey,              0xC6,
  NSF10FunctionKey,             0xC7,
  NSF11FunctionKey,             0xC8,
  NSF12FunctionKey,             0xC9,
  NSF13FunctionKey,             0xCA,
  NSF14FunctionKey,             0xCB,
  NSF15FunctionKey,             0xCC,
131 132 133 134 135 136 137 138 139
  NSF16FunctionKey,             0xCD,
  NSF17FunctionKey,             0xCE,
  NSF18FunctionKey,             0xCF,
  NSF19FunctionKey,             0xD0,
  NSF20FunctionKey,             0xD1,
  NSF21FunctionKey,             0xD2,
  NSF22FunctionKey,             0xD3,
  NSF23FunctionKey,             0xD4,
  NSF24FunctionKey,             0xD5,
140 141 142 143 144 145 146 147 148 149 150

  NSBackspaceCharacter,         0x08,  /* 8: Not on some KBs. */
  NSDeleteCharacter,            0xFF,  /* 127: Big 'delete' key upper right. */
  NSDeleteFunctionKey,          0x9F,  /* 63272: Del forw key off main array. */

  NSTabCharacter,		0x09,
  0x19,				0x09,  /* left tab->regular since pass shift */
  NSCarriageReturnCharacter,	0x0D,
  NSNewlineCharacter,		0x0D,
  NSEnterCharacter,		0x8D,

151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
  0x41|NSNumericPadKeyMask,	0xAE,  /* KP_Decimal */
  0x43|NSNumericPadKeyMask,	0xAA,  /* KP_Multiply */
  0x45|NSNumericPadKeyMask,	0xAB,  /* KP_Add */
  0x4B|NSNumericPadKeyMask,	0xAF,  /* KP_Divide */
  0x4E|NSNumericPadKeyMask,	0xAD,  /* KP_Subtract */
  0x51|NSNumericPadKeyMask,	0xBD,  /* KP_Equal */
  0x52|NSNumericPadKeyMask,	0xB0,  /* KP_0 */
  0x53|NSNumericPadKeyMask,	0xB1,  /* KP_1 */
  0x54|NSNumericPadKeyMask,	0xB2,  /* KP_2 */
  0x55|NSNumericPadKeyMask,	0xB3,  /* KP_3 */
  0x56|NSNumericPadKeyMask,	0xB4,  /* KP_4 */
  0x57|NSNumericPadKeyMask,	0xB5,  /* KP_5 */
  0x58|NSNumericPadKeyMask,	0xB6,  /* KP_6 */
  0x59|NSNumericPadKeyMask,	0xB7,  /* KP_7 */
  0x5B|NSNumericPadKeyMask,	0xB8,  /* KP_8 */
  0x5C|NSNumericPadKeyMask,	0xB9,  /* KP_9 */
167

168 169 170 171
  0x1B,				0x1B   /* escape */
};

static Lisp_Object Qmodifier_value;
172
Lisp_Object Qalt, Qcontrol, Qhyper, Qmeta, Qsuper;
173
extern Lisp_Object Qcursor_color, Qcursor_type, Qns, Qleft;
174

175 176
static Lisp_Object QUTF8_STRING;

177 178 179 180 181 182 183 184 185
/* On OS X picks up the default NSGlobalDomain AppleAntiAliasingThreshold,
   the maximum font size to NOT antialias.  On GNUstep there is currently
   no way to control this behavior. */
float ns_antialias_threshold;

/* Used to pick up AppleHighlightColor on OS X */
NSString *ns_selection_color;

NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
186
NSString *ns_app_name = @"Emacs";  /* default changed later */
187 188

/* Display variables */
189
struct ns_display_info *x_display_list; /* Chain of existing displays */
190 191 192 193 194 195
Lisp_Object ns_display_name_list;
long context_menu_value = 0;

/* display update */
NSPoint last_mouse_motion_position;
static NSRect last_mouse_glyph;
196
static Time last_mouse_movement_time = 0;
197 198 199 200
static Lisp_Object last_mouse_motion_frame;
static EmacsScroller *last_mouse_scroll_bar = nil;
static struct frame *ns_updating_frame;
static NSView *focus_view = NULL;
201
static int ns_window_num = 0;
202
#ifdef NS_IMPL_GNUSTEP
203
static NSRect uRect;
204
#endif
205
static BOOL gsaved = NO;
206
static BOOL ns_fake_keydown = NO;
207
#ifdef NS_IMPL_COCOA
208
static BOOL ns_menu_bar_is_hidden = NO;
209
#endif
210 211 212 213
/*static int debug_lock = 0; */

/* event loop */
static BOOL send_appdefined = YES;
214 215
#define NO_APPDEFINED_DATA (-8)
static int last_appdefined_event_data = NO_APPDEFINED_DATA;
216 217
static NSTimer *timed_entry = 0;
static NSTimer *scroll_repeat_entry = nil;
218 219 220
static fd_set select_readfds, select_writefds;
enum { SELECT_HAVE_READ = 1, SELECT_HAVE_WRITE = 2, SELECT_HAVE_TMO = 4 };
static int select_nfds = 0, select_valid = 0;
221
static struct timespec select_timeout = { 0, 0 };
222 223 224
static int selfds[2] = { -1, -1 };
static pthread_mutex_t select_mutex;
static int apploopnr = 0;
225 226 227 228 229 230
static NSAutoreleasePool *outerpool;
static struct input_event *emacs_event = NULL;
static struct input_event *q_event_ptr = NULL;
static int n_emacs_events_pending = 0;
static NSMutableArray *ns_pending_files, *ns_pending_service_names,
  *ns_pending_service_args;
231
static BOOL ns_do_open_file = NO;
232
static BOOL ns_last_use_native_fullscreen;
233

234 235 236 237 238 239 240
static struct {
  struct input_event *q;
  int nr, cap;
} hold_event_q = {
  NULL, 0, 0
};

241
#ifdef NS_IMPL_COCOA
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
/*
 * State for pending menu activation:
 * MENU_NONE     Normal state
 * MENU_PENDING  A menu has been clicked on, but has been canceled so we can
 *               run lisp to update the menu.
 * MENU_OPENING  Menu is up to date, and the click event is redone so the menu
 *               will open.
 */
#define MENU_NONE 0
#define MENU_PENDING 1
#define MENU_OPENING 2
static int menu_will_open_state = MENU_NONE;

/* Saved position for menu click.  */
static CGPoint menu_mouse_point;
257
#endif
258

259
/* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
260
#define NS_FUNCTION_KEY_MASK 0x800000
261
#define NSLeftControlKeyMask    (0x000001 | NSControlKeyMask)
262
#define NSRightControlKeyMask   (0x002000 | NSControlKeyMask)
263
#define NSLeftCommandKeyMask    (0x000008 | NSCommandKeyMask)
264
#define NSRightCommandKeyMask   (0x000010 | NSCommandKeyMask)
265 266
#define NSLeftAlternateKeyMask  (0x000020 | NSAlternateKeyMask)
#define NSRightAlternateKeyMask (0x000040 | NSAlternateKeyMask)
267 268 269
#define EV_MODIFIERS(e)                               \
    ((([e modifierFlags] & NSHelpKeyMask) ?           \
           hyper_modifier : 0)                        \
270 271 272 273 274
     | (!EQ (ns_right_alternate_modifier, Qleft) && \
        (([e modifierFlags] & NSRightAlternateKeyMask) \
         == NSRightAlternateKeyMask) ? \
           parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
     | (([e modifierFlags] & NSAlternateKeyMask) ?                 \
275
           parse_solitary_modifier (ns_alternate_modifier) : 0)   \
276
     | (([e modifierFlags] & NSShiftKeyMask) ?     \
277
           shift_modifier : 0)                        \
278 279 280 281
     | (!EQ (ns_right_control_modifier, Qleft) && \
        (([e modifierFlags] & NSRightControlKeyMask) \
         == NSRightControlKeyMask) ? \
           parse_solitary_modifier (ns_right_control_modifier) : 0) \
282
     | (([e modifierFlags] & NSControlKeyMask) ?      \
283
           parse_solitary_modifier (ns_control_modifier) : 0)     \
284
     | (([e modifierFlags] & NS_FUNCTION_KEY_MASK) ?  \
285
           parse_solitary_modifier (ns_function_modifier) : 0)    \
286 287 288 289
     | (!EQ (ns_right_command_modifier, Qleft) && \
        (([e modifierFlags] & NSRightCommandKeyMask) \
         == NSRightCommandKeyMask) ? \
           parse_solitary_modifier (ns_right_command_modifier) : 0) \
290
     | (([e modifierFlags] & NSCommandKeyMask) ?      \
291
           parse_solitary_modifier (ns_command_modifier):0))
292 293 294 295

#define EV_UDMODIFIERS(e)                                      \
    ((([e type] == NSLeftMouseDown) ? down_modifier : 0)       \
     | (([e type] == NSRightMouseDown) ? down_modifier : 0)    \
296
     | (([e type] == NSOtherMouseDown) ? down_modifier : 0)    \
297 298
     | (([e type] == NSLeftMouseDragged) ? down_modifier : 0)  \
     | (([e type] == NSRightMouseDragged) ? down_modifier : 0) \
299
     | (([e type] == NSOtherMouseDragged) ? down_modifier : 0) \
300
     | (([e type] == NSLeftMouseUp)   ? up_modifier   : 0)     \
301 302
     | (([e type] == NSRightMouseUp)   ? up_modifier   : 0)    \
     | (([e type] == NSOtherMouseUp)   ? up_modifier   : 0))
303 304 305

#define EV_BUTTON(e)                                                         \
    ((([e type] == NSLeftMouseDown) || ([e type] == NSLeftMouseUp)) ? 0 :    \
306 307
      (([e type] == NSRightMouseDown) || ([e type] == NSRightMouseUp)) ? 2 : \
     [e buttonNumber] - 1)
308 309 310 311 312 313

/* Convert the time field to a timestamp in milliseconds. */
#define EV_TIMESTAMP(e) ([e timestamp] * 1000)

/* This is a piece of code which is common to all the event handling
   methods.  Maybe it should even be a function.  */
314
#define EV_TRAILER(e)                                                   \
315 316 317 318 319 320 321
  {                                                                     \
    XSETFRAME (emacs_event->frame_or_window, emacsframe);               \
    EV_TRAILER2 (e);                                                    \
  }

#define EV_TRAILER2(e)                                                  \
  {                                                                     \
322 323 324 325 326 327 328
      if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
      if (q_event_ptr)                                                  \
        {                                                               \
          n_emacs_events_pending++;                                     \
          kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
        }                                                               \
      else                                                              \
329
        hold_event (emacs_event);                                       \
330 331 332
      EVENT_INIT (*emacs_event);                                        \
      ns_send_appdefined (-1);                                          \
    }
333

334
/* TODO: get rid of need for these forward declarations */
335 336
static void ns_condemn_scroll_bars (struct frame *f);
static void ns_judge_scroll_bars (struct frame *f);
337
void x_set_frame_alpha (struct frame *f);
338 339 340 341 342 343 344 345


/* ==========================================================================

    Utilities

   ========================================================================== */

346 347 348 349 350 351 352
static void
hold_event (struct input_event *event)
{
  if (hold_event_q.nr == hold_event_q.cap)
    {
      if (hold_event_q.cap == 0) hold_event_q.cap = 10;
      else hold_event_q.cap *= 2;
Paul Eggert's avatar
Paul Eggert committed
353 354
      hold_event_q.q =
        xrealloc (hold_event_q.q, hold_event_q.cap * sizeof *hold_event_q.q);
355 356 357
    }

  hold_event_q.q[hold_event_q.nr++] = *event;
358
  /* Make sure ns_read_socket is called, i.e. we have input.  */
359
  raise (SIGIO);
360
  send_appdefined = YES;
361
}
362 363 364 365 366 367 368 369 370

static Lisp_Object
append2 (Lisp_Object list, Lisp_Object item)
/* --------------------------------------------------------------------------
   Utility to append to a list
   -------------------------------------------------------------------------- */
{
  Lisp_Object array[2];
  array[0] = list;
371
  array[1] = list1 (item);
372 373 374 375
  return Fnconc (2, &array[0]);
}


376
const char *
377 378 379
ns_etc_directory (void)
/* If running as a self-contained app bundle, return as a string the
   filename of the etc directory, if present; else nil.  */
380
{
381 382 383 384 385 386 387 388 389 390 391 392
  NSBundle *bundle = [NSBundle mainBundle];
  NSString *resourceDir = [bundle resourcePath];
  NSString *resourcePath;
  NSFileManager *fileManager = [NSFileManager defaultManager];
  BOOL isDir;

  resourcePath = [resourceDir stringByAppendingPathComponent: @"etc"];
  if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
    {
      if (isDir) return [resourcePath UTF8String];
    }
  return NULL;
393 394
}

395 396 397 398 399 400 401 402 403 404 405 406 407 408

const char *
ns_exec_path (void)
/* If running as a self-contained app bundle, return as a path string
   the filenames of the libexec and bin directories, ie libexec:bin.
   Otherwise, return nil.
   Normally, Emacs does not add its own bin/ directory to the PATH.
   However, a self-contained NS build has a different layout, with
   bin/ and libexec/ subdirectories in the directory that contains
   Emacs.app itself.
   We put libexec first, because init_callproc_1 uses the first
   element to initialize exec-directory.  An alternative would be
   for init_callproc to check for invocation-directory/libexec.
*/
409 410
{
  NSBundle *bundle = [NSBundle mainBundle];
411 412
  NSString *resourceDir = [bundle resourcePath];
  NSString *binDir = [bundle bundlePath];
413 414
  NSString *resourcePath, *resourcePaths;
  NSRange range;
415
  NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
416
  NSFileManager *fileManager = [NSFileManager defaultManager];
417 418
  NSArray *paths;
  NSEnumerator *pathEnum;
419 420 421 422 423
  BOOL isDir;

  range = [resourceDir rangeOfString: @"Contents"];
  if (range.location != NSNotFound)
    {
424
      binDir = [binDir stringByAppendingPathComponent: @"Contents"];
425 426 427 428 429
#ifdef NS_IMPL_COCOA
      binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
#endif
    }

430 431 432 433 434
  paths = [binDir stringsByAppendingPaths:
                [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
  pathEnum = [paths objectEnumerator];
  resourcePaths = @"";

435
  while ((resourcePath = [pathEnum nextObject]))
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
    {
      if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
        if (isDir)
          {
            if ([resourcePaths length] > 0)
              resourcePaths
                = [resourcePaths stringByAppendingString: pathSeparator];
            resourcePaths
              = [resourcePaths stringByAppendingString: resourcePath];
          }
    }
  if ([resourcePaths length] > 0) return [resourcePaths UTF8String];

  return NULL;
}


453 454 455 456 457
const char *
ns_load_path (void)
/* If running as a self-contained app bundle, return as a path string
   the filenames of the site-lisp, lisp and leim directories.
   Ie, site-lisp:lisp:leim.  Otherwise, return nil.  */
458 459 460 461
{
  NSBundle *bundle = [NSBundle mainBundle];
  NSString *resourceDir = [bundle resourcePath];
  NSString *resourcePath, *resourcePaths;
462
  NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
463 464
  NSFileManager *fileManager = [NSFileManager defaultManager];
  BOOL isDir;
465 466 467 468 469
  NSArray *paths = [resourceDir stringsByAppendingPaths:
                              [NSArray arrayWithObjects:
                                         @"site-lisp", @"lisp", @"leim", nil]];
  NSEnumerator *pathEnum = [paths objectEnumerator];
  resourcePaths = @"";
470

471 472 473
  /* Hack to skip site-lisp.  */
  if (no_site_lisp) resourcePath = [pathEnum nextObject];

474
  while ((resourcePath = [pathEnum nextObject]))
475
    {
476 477 478 479 480 481 482 483 484
      if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
        if (isDir)
          {
            if ([resourcePaths length] > 0)
              resourcePaths
                = [resourcePaths stringByAppendingString: pathSeparator];
            resourcePaths
              = [resourcePaths stringByAppendingString: resourcePath];
          }
485
    }
486 487 488
  if ([resourcePaths length] > 0) return [resourcePaths UTF8String];

  return NULL;
489 490 491 492 493 494 495 496
}

static void
ns_timeout (int usecs)
/* --------------------------------------------------------------------------
     Blocking timer utility used by ns_ring_bell
   -------------------------------------------------------------------------- */
{
497 498
  struct timespec wakeup = timespec_add (current_timespec (),
					 make_timespec (0, usecs * 1000));
499 500 501 502

  /* Keep waiting until past the time wakeup.  */
  while (1)
    {
503 504
      struct timespec timeout, now = current_timespec ();
      if (timespec_cmp (wakeup, now) <= 0)
505
	break;
506
      timeout = timespec_sub (wakeup, now);
507 508

      /* Try to wait that long--but we might wake up sooner.  */
509
      pselect (0, NULL, NULL, NULL, &timeout, NULL);
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
    }
}


void
ns_release_object (void *obj)
/* --------------------------------------------------------------------------
    Release an object (callable from C)
   -------------------------------------------------------------------------- */
{
    [(id)obj release];
}


void
ns_retain_object (void *obj)
/* --------------------------------------------------------------------------
    Retain an object (callable from C)
   -------------------------------------------------------------------------- */
{
    [(id)obj retain];
}


void *
535
ns_alloc_autorelease_pool (void)
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
/* --------------------------------------------------------------------------
     Allocate a pool for temporary objects (callable from C)
   -------------------------------------------------------------------------- */
{
  return [[NSAutoreleasePool alloc] init];
}


void
ns_release_autorelease_pool (void *pool)
/* --------------------------------------------------------------------------
     Free a pool and temporary objects it refers to (callable from C)
   -------------------------------------------------------------------------- */
{
  ns_release_object (pool);
}



/* ==========================================================================

    Focus (clipping) and screen update

   ========================================================================== */

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
//
// Window constraining
// -------------------
//
// To ensure that the windows are not placed under the menu bar, they
// are typically moved by the call-back constrainFrameRect. However,
// by overriding it, it's possible to inhibit this, leaving the window
// in it's original position.
//
// It's possible to hide the menu bar. However, technically, it's only
// possible to hide it when the application is active. To ensure that
// this work properly, the menu bar and window constraining are
// deferred until the application becomes active.
//
// Even though it's not possible to manually move a window above the
// top of the screen, it is allowed if it's done programmatically,
// when the menu is hidden. This allows the editable area to cover the
// full screen height.
//
// Test cases
// ----------
//
// Use the following extra files:
//
//    init.el:
//       ;; Hide menu and place frame slightly above the top of the screen.
//       (setq ns-auto-hide-menu-bar t)
//       (set-frame-position (selected-frame) 0 -20)
//
// Test 1:
//
//    emacs -Q -l init.el
//
//    Result: No menu bar, and the title bar should be above the screen.
//
// Test 2:
//
//    emacs -Q
//
//    Result: Menu bar visible, frame placed immediately below the menu.
//

static void
ns_constrain_all_frames (void)
{
  Lisp_Object tail, frame;

  FOR_EACH_FRAME (tail, frame)
    {
      struct frame *f = XFRAME (frame);
      if (FRAME_NS_P (f))
        {
          NSView *view = FRAME_NS_VIEW (f);
          /* This no-op will trigger the default window placing
Paul Eggert's avatar
Paul Eggert committed
615
           * constraint system. */
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
          f->output_data.ns->dont_constrain = 0;
          [[view window] setFrameOrigin:[[view window] frame].origin];
        }
    }
}


/* True, if the menu bar should be hidden.  */

static BOOL
ns_menu_bar_should_be_hidden (void)
{
  return !NILP (ns_auto_hide_menu_bar)
    && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
}


/* Show or hide the menu bar, based on user setting.  */

static void
ns_update_auto_hide_menu_bar (void)
{
638 639
#ifdef NS_IMPL_COCOA
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
640
  block_input ();
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

  NSTRACE (ns_update_auto_hide_menu_bar);

  if (NSApp != nil
      && [NSApp isActive]
      && [NSApp respondsToSelector:@selector(setPresentationOptions:)])
    {
      // Note, "setPresentationOptions" triggers an error unless the
      // application is active.
      BOOL menu_bar_should_be_hidden = ns_menu_bar_should_be_hidden ();

      if (menu_bar_should_be_hidden != ns_menu_bar_is_hidden)
        {
          NSApplicationPresentationOptions options
            = NSApplicationPresentationAutoHideDock;

          if (menu_bar_should_be_hidden)
            options |= NSApplicationPresentationAutoHideMenuBar;

          [NSApp setPresentationOptions: options];

          ns_menu_bar_is_hidden = menu_bar_should_be_hidden;

          if (!ns_menu_bar_is_hidden)
            {
              ns_constrain_all_frames ();
            }
        }
    }

671
  unblock_input ();
672 673
#endif
#endif
674 675 676
}


677 678 679 680
static void
ns_update_begin (struct frame *f)
/* --------------------------------------------------------------------------
   Prepare for a grouped sequence of drawing calls
681
   external (RIF) call; whole frame, called before update_window_begin
682 683 684 685 686
   -------------------------------------------------------------------------- */
{
  NSView *view = FRAME_NS_VIEW (f);
  NSTRACE (ns_update_begin);

687 688
  ns_update_auto_hide_menu_bar ();

689 690 691
  ns_updating_frame = f;
  [view lockFocus];

692 693 694 695
  /* drawRect may have been called for say the minibuffer, and then clip path
     is for the minibuffer.  But the display engine may draw more because
     we have set the frame as garbaged.  So reset clip path to the whole
     view.  */
696 697 698 699
#ifdef NS_IMPL_COCOA
  {
    NSBezierPath *bp;
    NSRect r = [view frame];
700 701 702 703 704 705 706 707 708 709 710 711
    NSRect cr = [[view window] frame];
    /* If a large frame size is set, r may be larger than the window frame
       before constrained.  In that case don't change the clip path, as we
       will clear in to the tool bar and title bar.  */
    if (r.size.height
        + FRAME_NS_TITLEBAR_HEIGHT (f)
        + FRAME_TOOLBAR_HEIGHT (f) <= cr.size.height)
      {
        bp = [[NSBezierPath bezierPathWithRect: r] retain];
        [bp setClip];
        [bp release];
      }
712 713
  }
#endif
714

715 716 717 718 719 720 721 722 723 724
#ifdef NS_IMPL_GNUSTEP
  uRect = NSMakeRect (0, 0, 0, 0);
#endif
}


static void
ns_update_window_begin (struct window *w)
/* --------------------------------------------------------------------------
   Prepare for a grouped sequence of drawing calls
725
   external (RIF) call; for one window, called after update_begin
726 727 728
   -------------------------------------------------------------------------- */
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
729 730
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);

731
  NSTRACE (ns_update_window_begin);
732
  w->output_cursor = w->cursor;
733

734
  block_input ();
735

736
  if (f == hlinfo->mouse_face_mouse_frame)
737 738
    {
      /* Don't do highlighting for mouse motion during the update.  */
739
      hlinfo->mouse_face_defer = 1;
740 741 742 743

        /* If the frame needs to be redrawn,
           simply forget about any prior mouse highlighting.  */
      if (FRAME_GARBAGED_P (f))
744
        hlinfo->mouse_face_window = Qnil;
745 746 747 748

      /* (further code for mouse faces ifdef'd out in other terms elided) */
    }

749
  unblock_input ();
750 751 752 753
}


static void
754 755
ns_update_window_end (struct window *w, bool cursor_on_p,
                      bool mouse_face_overwritten_p)
756 757
/* --------------------------------------------------------------------------
   Finished a grouped sequence of drawing calls
758
   external (RIF) call; for one window called before update_end
759 760 761 762 763
   -------------------------------------------------------------------------- */
{
  /* note: this fn is nearly identical in all terms */
  if (!w->pseudo_window_p)
    {
764
      block_input ();
765 766 767

      if (cursor_on_p)
	display_and_set_cursor (w, 1,
768 769
				w->output_cursor.hpos, w->output_cursor.vpos,
				w->output_cursor.x, w->output_cursor.y);
770 771 772 773

      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);

774
      unblock_input ();
775 776 777 778 779
    }

  /* If a row with mouse-face was overwritten, arrange for
     frame_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
780
    reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
781 782 783 784 785 786 787 788 789

  NSTRACE (update_window_end);
}


static void
ns_update_end (struct frame *f)
/* --------------------------------------------------------------------------
   Finished a grouped sequence of drawing calls
790
   external (RIF) call; for whole frame, called after update_window_end
791 792
   -------------------------------------------------------------------------- */
{
793
  EmacsView *view = FRAME_NS_VIEW (f);
794

795
/*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
796
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
797

798
  block_input ();
799 800 801 802

  [view unlockFocus];
  [[view window] flushWindow];

803
  unblock_input ();
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
  ns_updating_frame = NULL;
  NSTRACE (ns_update_end);
}

static void
ns_focus (struct frame *f, NSRect *r, int n)
/* --------------------------------------------------------------------------
   Internal: Focus on given frame.  During small local updates this is used to
     draw, however during large updates, ns_update_begin and ns_update_end are
     called to wrap the whole thing, in which case these calls are stubbed out.
     Except, on GNUstep, we accumulate the rectangle being drawn into, because
     the back end won't do this automatically, and will just end up flushing
     the entire window.
   -------------------------------------------------------------------------- */
{
819
//  NSTRACE (ns_focus);
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
/* static int c =0;
   fprintf (stderr, "focus: %d", c++);
   if (r) fprintf (stderr, " (%.0f, %.0f : %.0f x %.0f)", r->origin.x, r->origin.y, r->size.width, r->size.height);
   fprintf (stderr, "\n"); */

  if (f != ns_updating_frame)
    {
      NSView *view = FRAME_NS_VIEW (f);
      if (view != focus_view)
        {
          if (focus_view != NULL)
            {
              [focus_view unlockFocus];
              [[focus_view window] flushWindow];
/*debug_lock--; */
            }

          if (view)
            [view lockFocus];
          focus_view = view;
/*if (view) debug_lock++; */
        }
    }

844
  /* clipping */
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
  if (r)
    {
      [[NSGraphicsContext currentContext] saveGraphicsState];
      if (n == 2)
        NSRectClipList (r, 2);
      else
        NSRectClip (*r);
      gsaved = YES;
    }
}


static void
ns_unfocus (struct frame *f)
/* --------------------------------------------------------------------------
     Internal: Remove focus on given frame
   -------------------------------------------------------------------------- */
{
863
//  NSTRACE (ns_unfocus);
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884

  if (gsaved)
    {
      [[NSGraphicsContext currentContext] restoreGraphicsState];
      gsaved = NO;
    }

  if (f != ns_updating_frame)
    {
      if (focus_view != NULL)
        {
          [focus_view unlockFocus];
          [[focus_view window] flushWindow];
          focus_view = NULL;
/*debug_lock--; */
        }
    }
}


static void
885 886
ns_clip_to_row (struct window *w, struct glyph_row *row,
		enum glyph_row_area area, BOOL gc)
887
/* --------------------------------------------------------------------------
888
     Internal (but parallels other terms): Focus drawing on given row
889 890 891 892 893 894 895 896
   -------------------------------------------------------------------------- */
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  NSRect clip_rect;
  int window_x, window_y, window_width;

  window_box (w, area, &window_x, &window_y, &window_width, 0);

897
  clip_rect.origin.x = window_x;
898 899
  clip_rect.origin.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
  clip_rect.origin.y = max (clip_rect.origin.y, window_y);
900
  clip_rect.size.width = window_width;
901 902 903 904 905 906 907
  clip_rect.size.height = row->visible_height;

  ns_focus (f, &clip_rect, 1);
}


static void
908
ns_ring_bell (struct frame *f)
909 910 911 912 913 914 915 916 917 918 919
/* --------------------------------------------------------------------------
     "Beep" routine
   -------------------------------------------------------------------------- */
{
  NSTRACE (ns_ring_bell);
  if (visible_bell)
    {
      NSAutoreleasePool *pool;
      struct frame *frame = SELECTED_FRAME ();
      NSView *view;

920
      block_input ();
921 922 923 924 925
      pool = [[NSAutoreleasePool alloc] init];

      view = FRAME_NS_VIEW (frame);
      if (view != nil)
        {
926 927 928 929 930 931 932 933 934 935 936 937 938 939
          NSRect r, surr;
          NSPoint dim = NSMakePoint (128, 128);

          r = [view bounds];
          r.origin.x += (r.size.width - dim.x) / 2;
          r.origin.y += (r.size.height - dim.y) / 2;
          r.size.width = dim.x;
          r.size.height = dim.y;
          surr = NSInsetRect (r, -2, -2);
          ns_focus (frame, &surr, 1);
          [[view window] cacheImageInRect: [view convertRect: surr toView:nil]];
          [ns_lookup_indexed_color (NS_FACE_FOREGROUND
                                      (FRAME_DEFAULT_FACE (frame)), frame) set];
          NSRectFill (r);
940 941
          [[view window] flushWindow];
          ns_timeout (150000);
942
          [[view window] restoreCachedImage];
943 944 945 946
          [[view window] flushWindow];
          ns_unfocus (frame);
        }
      [pool release];
947
      unblock_input ();
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
    }
  else
    {
      NSBeep ();
    }
}

/* ==========================================================================

    Frame / window manager related functions

   ========================================================================== */


static void
ns_raise_frame (struct frame *f)
/* --------------------------------------------------------------------------
     Bring window to foreground and make it active
   -------------------------------------------------------------------------- */
{
968 969 970
  NSView *view;
  check_window_system (f);
  view = FRAME_NS_VIEW (f);
971
  block_input ();
972
  if (FRAME_VISIBLE_P (f))
973
    [[view window] makeKeyAndOrderFront: NSApp];
974
  unblock_input ();
975 976 977 978 979 980 981 982 983
}


static void
ns_lower_frame (struct frame *f)
/* --------------------------------------------------------------------------
     Send window to back
   -------------------------------------------------------------------------- */
{
984 985 986
  NSView *view;
  check_window_system (f);
  view = FRAME_NS_VIEW (f);
987
  block_input ();
988
  [[view window] orderBack: NSApp];
989
  unblock_input ();
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
}


static void
ns_frame_raise_lower (struct frame *f, int raise)
/* --------------------------------------------------------------------------
     External (hook)
   -------------------------------------------------------------------------- */
{
  NSTRACE (ns_frame_raise_lower);

  if (raise)
    ns_raise_frame (f);
  else
    ns_lower_frame (f);
}


static void
ns_frame_rehighlight (struct frame *frame)
/* --------------------------------------------------------------------------
     External (hook): called on things like window switching within frame
   -------------------------------------------------------------------------- */
{
1014
  struct ns_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
1015
  struct frame *old_highlight = dpyinfo->x_highlight_frame;
1016 1017

  NSTRACE (ns_frame_rehighlight);
1018
  if (dpyinfo->x_focus_frame)
1019
    {
1020 1021 1022 1023 1024
      dpyinfo->x_highlight_frame
	= (FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
           ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
           : dpyinfo->x_focus_frame);
      if (!FRAME_LIVE_P (dpyinfo->x_highlight_frame))
1025
        {
1026
          fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
1027
          dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
1028 1029 1030
        }
    }
  else
1031
      dpyinfo->x_highlight_frame = 0;
1032

1033 1034
  if (dpyinfo->x_highlight_frame &&
         dpyinfo->x_highlight_frame != old_highlight)
1035 1036
    {
      if (old_highlight)
1037
	{
1038
          x_update_cursor (old_highlight, 1);
1039 1040
	  x_set_frame_alpha (old_highlight);
	}
1041
      if (dpyinfo->x_highlight_frame)
1042
	{
1043
          x_update_cursor (dpyinfo->x_highlight_frame, 1);
1044 1045
          x_set_frame_alpha (dpyinfo->x_highlight_frame);
	}
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
    }
}


void
x_make_frame_visible (struct frame *f)
/* --------------------------------------------------------------------------
     External: Show the window (X11 semantics)
   -------------------------------------------------------------------------- */
{
  NSTRACE (x_make_frame_visible);
1057
  /* XXX: at some points in past this was not needed, as the only place that
1058 1059 1060
     called this (frame.c:Fraise_frame ()) also called raise_lower;
     if this ends up the case again, comment this out again. */
  if (!FRAME_VISIBLE_P (f))
1061
    {
1062
      EmacsView *view = (EmacsView *)FRAME_NS_VIEW (f);
1063 1064

      SET_FRAME_VISIBLE (f, 1);
1065
      ns_raise_frame (f);
1066 1067 1068

      /* Making a new frame from a fullscreen frame will make the new frame
         fullscreen also.  So skip handleFS as this will print an error.  */
1069 1070
      if ([view fsIsNative] && f->want_fullscreen == FULLSCREEN_BOTH
          && [view isFullscreen])
1071
        return;
1072

1073 1074 1075 1076 1077 1078
      if (f->want_fullscreen != FULLSCREEN_NONE)
        {
          block_input ();
          [view handleFS];
          unblock_input ();
        }
1079
    }
1080 1081 1082 1083 1084 1085 1086 1087 1088
}


void
x_make_frame_invisible (struct frame *f)
/* --------------------------------------------------------------------------
     External: Hide the window (X11 semantics)
   -------------------------------------------------------------------------- */
{
1089
  NSView *view;
1090
  NSTRACE (x_make_frame_invisible);
1091 1092
  check_window_system (f);
  view = FRAME_NS_VIEW (f);
1093
  [[view window] orderOut: NSApp];
1094 1095
  SET_FRAME_VISIBLE (f, 0);
  SET_FRAME_ICONIFIED (f, 0);
1096 1097 1098 1099 1100 1101 1102 1103 1104
}


void
x_iconify_frame (struct frame *f)
/* --------------------------------------------------------------------------
     External: Iconify window
   -------------------------------------------------------------------------- */
{
1105 1106 1107
  NSView *view;
  struct ns_display_info *dpyinfo;

1108
  NSTRACE (x_iconify_frame);
1109 1110
  check_window_system (f);
  view = FRAME_NS_VIEW (f);
1111
  dpyinfo = FRAME_DISPLAY_INFO (f);
1112

1113 1114
  if (dpyinfo->x_highlight_frame == f)
    dpyinfo->x_highlight_frame = 0;
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130

  if ([[view window] windowNumber] <= 0)
    {
      /* the window is still deferred.  Make it very small, bring it
         on screen and order it out. */
      NSRect s = { { 100, 100}, {0, 0} };
      NSRect t;
      t = [[view window] frame];
      [[view window] setFrame: s display: NO];
      [[view window] orderBack: NSApp];
      [[view window] orderOut: NSApp];
      [[view window] setFrame: t display: NO];
    }
  [[view window] miniaturize: NSApp];
}

1131
/* Free X resources of frame F.  */
1132 1133

void
1134
x_free_frame_resources (struct frame *f)
1135
{
1136 1137 1138 1139
  NSView *view;
  struct ns_display_info *dpyinfo;
  Mouse_HLInfo *hlinfo;

1140
  NSTRACE (x_free_frame_resources);
1141 1142
  check_window_system (f);
  view = FRAME_NS_VIEW (f);
1143
  dpyinfo = FRAME_DISPLAY_INFO (f);
1144
  hlinfo = MOUSE_HL_INFO (f);
1145 1146 1147

  [(EmacsView *)view setWindowClosing: YES]; /* may not have been informed */

1148
  block_input ();
1149 1150 1151 1152 1153 1154

  free_frame_menubar (f);

  if (FRAME_FACE_CACHE (f))
    free_frame_faces (f);

1155 1156 1157 1158
  if (f == dpyinfo->x_focus_frame)
    dpyinfo->x_focus_frame = 0;
  if (f == dpyinfo->x_highlight_frame)
    dpyinfo->x_highlight_frame = 0;
1159
  if (f == hlinfo->mouse_face_mouse_frame)
1160
    reset_mouse_highlight (hlinfo);
1161

1162 1163 1164
  if (f->output_data.ns->miniimage != nil)
    [f->output_data.ns->miniimage release];

1165 1166 1167
  [[view window] close];
  [view release];

1168 1169
  xfree (f->output_data.ns);

1170
  unblock_input ();
1171 1172
}

1173 1174 1175 1176 1177 1178 1179
void
x_destroy_window (struct frame *f)
/* --------------------------------------------------------------------------
     External: Delete the window
   -------------------------------------------------------------------------- */
{
  NSTRACE (x_destroy_window);
1180
  check_window_system (f);
1181 1182 1183 1184
  x_free_frame_resources (f);
  ns_window_num--;
}

1185 1186 1187 1188 1189 1190 1191 1192

void
x_set_offset (struct frame *f, int xoff, int yoff, int change_grav)
/* --------------------------------------------------------------------------
     External: Position the window
   -------------------------------------------------------------------------- */
{
  NSView *view = FRAME_NS_VIEW (f);
1193 1194 1195
  NSArray *screens = [NSScreen screens];
  NSScreen *fscreen = [screens objectAtIndex: 0];
  NSScreen *screen = [[view window] screen];
1196 1197 1198

  NSTRACE (x_set_offset);

1199
  block_input ();
1200 1201 1202

  f->left_pos = xoff;
  f->top_pos = yoff;
1203

1204
  if (view != nil && screen && fscreen)
1205 1206 1207 1208 1209
    {
      f->left_pos = f->size_hint_flags & XNegative
        ? [screen visibleFrame].size.width + f->left_pos - FRAME_PIXEL_WIDTH (f)
        : f->left_pos;
      /* We use visibleFrame here to take menu bar into account.
1210
	 Ideally we should also adjust left/top with visibleFrame.origin.  */
1211

1212 1213 1214 1215 1216
      f->top_pos = f->size_hint_flags & YNegative
        ? ([screen visibleFrame].size.height + f->top_pos
           - FRAME_PIXEL_HEIGHT (f) - FRAME_NS_TITLEBAR_HEIGHT (f)
           - FRAME_TOOLBAR_HEIGHT (f))
        : f->top_pos;
1217
#ifdef NS_IMPL_GNUSTEP
1218 1219
      if (f->left_pos < 100)
        f->left_pos = 100;  /* don't overlap menu */
1220
#endif
1221 1222 1223
      /* Constrain the setFrameTopLeftPoint so we don't move behind the
         menu bar.  */
      f->output_data.ns->dont_constrain = 0;
1224 1225
      [[view window] setFrameTopLeftPoint:
                       NSMakePoint (SCREENMAXBOUND (f->left_pos),
1226
                                    SCREENMAXBOUND ([fscreen frame].size.height
1227 1228 1229
                                                    - NS_TOP_POS (f)))];
      f->size_hint_flags &= ~(XNegative|YNegative);
    }
1230

1231
  unblock_input ();
1232 1233 1234 1235 1236 1237 1238 1239
}


void
x_set_window_size (struct frame *f, int change_grav, int cols, int rows)
/* --------------------------------------------------------------------------
     Adjust window pixel size based on given character grid size
     Impl is a bit more complex than other terms, need to do some
1240
     internal clipping.
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
   -------------------------------------------------------------------------- */
{
  EmacsView *view = FRAME_NS_VIEW (f);
  NSWindow *window = [view window];
  NSRect wr = [window frame];
  int tb = FRAME_EXTERNAL_TOOL_BAR (f);
  int pixelwidth, pixelheight;

  NSTRACE (x_set_window_size);

1251
  if (view == nil)
1252 1253