nsterm.m 257 KB
Newer Older
1
/* NeXT/Open/GNUstep / MacOSX communication module.      -*- coding: utf-8 -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1989, 1993-1994, 2005-2006, 2008-2016 Free Software
4
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

#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"
57
#include "menu.h"
58 59
#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
#ifdef NS_IMPL_COCOA
#include "macfont.h"
#endif

71

72 73 74
extern NSString *NSMenuDidBeginTrackingNotification;


75 76 77 78 79 80
/* ==========================================================================

   NSTRACE, Trace support.

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

81
#if NSTRACE_ENABLED
82 83 84 85 86 87 88 89 90 91 92 93 94

/* The following use "volatile" since they can be accessed from
   parallel threads. */
volatile int nstrace_num = 0;
volatile int nstrace_depth = 0;

/* When 0, no trace is emitted.  This is used by NSTRACE_WHEN and
   NSTRACE_UNLESS to silence functions called.

   TODO: This should really be a thread-local variable, to avoid that
   a function with disabled trace thread silence trace output in
   another.  However, in practice this seldom is a problem. */
volatile int nstrace_enabled_global = 1;
95 96 97 98 99 100 101 102 103 104 105

/* Called when nstrace_enabled goes out of scope. */
void nstrace_leave(int * pointer_to_nstrace_enabled)
{
  if (*pointer_to_nstrace_enabled)
    {
      --nstrace_depth;
    }
}


106 107
/* Called when nstrace_saved_enabled_global goes out of scope. */
void nstrace_restore_global_trace_state(int * pointer_to_saved_enabled_global)
108
{
109 110
  nstrace_enabled_global = *pointer_to_saved_enabled_global;
}
111

112 113 114

char const * nstrace_fullscreen_type_name (int fs_type)
{
115 116
  switch (fs_type)
    {
117 118 119 120 121 122 123
    case -1:                   return "-1";
    case FULLSCREEN_NONE:      return "FULLSCREEN_NONE";
    case FULLSCREEN_WIDTH:     return "FULLSCREEN_WIDTH";
    case FULLSCREEN_HEIGHT:    return "FULLSCREEN_HEIGHT";
    case FULLSCREEN_BOTH:      return "FULLSCREEN_BOTH";
    case FULLSCREEN_MAXIMIZED: return "FULLSCREEN_MAXIMIZED";
    default:                   return "FULLSCREEN_?????";
124 125
    }
}
126 127
#endif

128

129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
/* ==========================================================================

   NSColor, EmacsColor category.

   ========================================================================== */
@implementation NSColor (EmacsColor)
+ (NSColor *)colorForEmacsRed:(CGFloat)red green:(CGFloat)green
                         blue:(CGFloat)blue alpha:(CGFloat)alpha
{
#ifdef NS_IMPL_COCOA
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
  if (ns_use_srgb_colorspace)
      return [NSColor colorWithSRGBRed: red
                                 green: green
                                  blue: blue
                                 alpha: alpha];
#endif
#endif
  return [NSColor colorWithCalibratedRed: red
                                   green: green
                                    blue: blue
                                   alpha: alpha];
}

- (NSColor *)colorUsingDefaultColorSpace
{
#ifdef NS_IMPL_COCOA
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
  if (ns_use_srgb_colorspace)
    return [self colorUsingColorSpace: [NSColorSpace sRGBColorSpace]];
#endif
#endif
  return [self colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
}

@end

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
/* ==========================================================================

    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,
188
  NSClearLineFunctionKey,       0x0B,
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
  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,
213 214 215 216 217 218 219 220 221
  NSF16FunctionKey,             0xCD,
  NSF17FunctionKey,             0xCE,
  NSF18FunctionKey,             0xCF,
  NSF19FunctionKey,             0xD0,
  NSF20FunctionKey,             0xD1,
  NSF21FunctionKey,             0xD2,
  NSF22FunctionKey,             0xD3,
  NSF23FunctionKey,             0xD4,
  NSF24FunctionKey,             0xD5,
222 223 224 225 226 227 228 229 230 231 232

  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,

Alan Third's avatar
Alan Third committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
  0x41|NSEventModifierFlagNumericPad,	0xAE,  /* KP_Decimal */
  0x43|NSEventModifierFlagNumericPad,	0xAA,  /* KP_Multiply */
  0x45|NSEventModifierFlagNumericPad,	0xAB,  /* KP_Add */
  0x4B|NSEventModifierFlagNumericPad,	0xAF,  /* KP_Divide */
  0x4E|NSEventModifierFlagNumericPad,	0xAD,  /* KP_Subtract */
  0x51|NSEventModifierFlagNumericPad,	0xBD,  /* KP_Equal */
  0x52|NSEventModifierFlagNumericPad,	0xB0,  /* KP_0 */
  0x53|NSEventModifierFlagNumericPad,	0xB1,  /* KP_1 */
  0x54|NSEventModifierFlagNumericPad,	0xB2,  /* KP_2 */
  0x55|NSEventModifierFlagNumericPad,	0xB3,  /* KP_3 */
  0x56|NSEventModifierFlagNumericPad,	0xB4,  /* KP_4 */
  0x57|NSEventModifierFlagNumericPad,	0xB5,  /* KP_5 */
  0x58|NSEventModifierFlagNumericPad,	0xB6,  /* KP_6 */
  0x59|NSEventModifierFlagNumericPad,	0xB7,  /* KP_7 */
  0x5B|NSEventModifierFlagNumericPad,	0xB8,  /* KP_8 */
  0x5C|NSEventModifierFlagNumericPad,	0xB9,  /* KP_9 */
249

250 251 252 253 254 255 256 257 258
  0x1B,				0x1B   /* escape */
};

/* 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;

NSArray *ns_send_types =0, *ns_return_types =0, *ns_drag_types =0;
259
NSString *ns_app_name = @"Emacs";  /* default changed later */
260 261

/* Display variables */
262
struct ns_display_info *x_display_list; /* Chain of existing displays */
263 264 265 266 267
long context_menu_value = 0;

/* display update */
static struct frame *ns_updating_frame;
static NSView *focus_view = NULL;
268
static int ns_window_num = 0;
269
#ifdef NS_IMPL_GNUSTEP
270
static NSRect uRect;            // TODO: This is dead, remove it?
271
#endif
272
static BOOL gsaved = NO;
273
static BOOL ns_fake_keydown = NO;
274
#ifdef NS_IMPL_COCOA
275
static BOOL ns_menu_bar_is_hidden = NO;
276
#endif
277 278 279 280
/*static int debug_lock = 0; */

/* event loop */
static BOOL send_appdefined = YES;
281 282
#define NO_APPDEFINED_DATA (-8)
static int last_appdefined_event_data = NO_APPDEFINED_DATA;
283 284
static NSTimer *timed_entry = 0;
static NSTimer *scroll_repeat_entry = nil;
285 286 287
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;
288
static struct timespec select_timeout = { 0, 0 };
289 290 291
static int selfds[2] = { -1, -1 };
static pthread_mutex_t select_mutex;
static int apploopnr = 0;
292 293 294 295 296 297
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;
298
static BOOL ns_do_open_file = NO;
299
static BOOL ns_last_use_native_fullscreen;
300

301 302 303 304 305
/* Non-zero means that a HELP_EVENT has been generated since Emacs
   start.  */

static BOOL any_help_event_p = NO;

306 307 308 309 310 311 312
static struct {
  struct input_event *q;
  int nr, cap;
} hold_event_q = {
  NULL, 0, 0
};

313 314 315
static NSString *represented_filename = nil;
static struct frame *represented_frame = 0;

316
#ifdef NS_IMPL_COCOA
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
/*
 * 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;
332
#endif
333

334
/* Convert modifiers in a NeXTstep event to emacs style modifiers.  */
335
#define NS_FUNCTION_KEY_MASK 0x800000
Alan Third's avatar
Alan Third committed
336 337 338 339 340 341
#define NSLeftControlKeyMask    (0x000001 | NSEventModifierFlagControl)
#define NSRightControlKeyMask   (0x002000 | NSEventModifierFlagControl)
#define NSLeftCommandKeyMask    (0x000008 | NSEventModifierFlagCommand)
#define NSRightCommandKeyMask   (0x000010 | NSEventModifierFlagCommand)
#define NSLeftAlternateKeyMask  (0x000020 | NSEventModifierFlagOption)
#define NSRightAlternateKeyMask (0x000040 | NSEventModifierFlagOption)
342
#define EV_MODIFIERS2(flags)                          \
Alan Third's avatar
Alan Third committed
343
    (((flags & NSEventModifierFlagHelp) ?           \
344
           hyper_modifier : 0)                        \
345
     | (!EQ (ns_right_alternate_modifier, Qleft) && \
346
        ((flags & NSRightAlternateKeyMask) \
347 348
         == NSRightAlternateKeyMask) ? \
           parse_solitary_modifier (ns_right_alternate_modifier) : 0) \
Alan Third's avatar
Alan Third committed
349
     | ((flags & NSEventModifierFlagOption) ?                 \
350
           parse_solitary_modifier (ns_alternate_modifier) : 0)   \
Alan Third's avatar
Alan Third committed
351
     | ((flags & NSEventModifierFlagShift) ?     \
352
           shift_modifier : 0)                        \
353
     | (!EQ (ns_right_control_modifier, Qleft) && \
354
        ((flags & NSRightControlKeyMask) \
355 356
         == NSRightControlKeyMask) ? \
           parse_solitary_modifier (ns_right_control_modifier) : 0) \
Alan Third's avatar
Alan Third committed
357
     | ((flags & NSEventModifierFlagControl) ?      \
358
           parse_solitary_modifier (ns_control_modifier) : 0)     \
359
     | ((flags & NS_FUNCTION_KEY_MASK) ?  \
360
           parse_solitary_modifier (ns_function_modifier) : 0)    \
361
     | (!EQ (ns_right_command_modifier, Qleft) && \
362
        ((flags & NSRightCommandKeyMask) \
363 364
         == NSRightCommandKeyMask) ? \
           parse_solitary_modifier (ns_right_command_modifier) : 0) \
Alan Third's avatar
Alan Third committed
365
     | ((flags & NSEventModifierFlagCommand) ?      \
366
           parse_solitary_modifier (ns_command_modifier):0))
367
#define EV_MODIFIERS(e) EV_MODIFIERS2 ([e modifierFlags])
368 369

#define EV_UDMODIFIERS(e)                                      \
Alan Third's avatar
Alan Third committed
370 371 372 373 374 375 376 377 378
    ((([e type] == NSEventTypeLeftMouseDown) ? down_modifier : 0)       \
     | (([e type] == NSEventTypeRightMouseDown) ? down_modifier : 0)    \
     | (([e type] == NSEventTypeOtherMouseDown) ? down_modifier : 0)    \
     | (([e type] == NSEventTypeLeftMouseDragged) ? down_modifier : 0)  \
     | (([e type] == NSEventTypeRightMouseDragged) ? down_modifier : 0) \
     | (([e type] == NSEventTypeOtherMouseDragged) ? down_modifier : 0) \
     | (([e type] == NSEventTypeLeftMouseUp)   ? up_modifier   : 0)     \
     | (([e type] == NSEventTypeRightMouseUp)   ? up_modifier   : 0)    \
     | (([e type] == NSEventTypeOtherMouseUp)   ? up_modifier   : 0))
379 380

#define EV_BUTTON(e)                                                         \
Alan Third's avatar
Alan Third committed
381 382
    ((([e type] == NSEventTypeLeftMouseDown) || ([e type] == NSEventTypeLeftMouseUp)) ? 0 :    \
      (([e type] == NSEventTypeRightMouseDown) || ([e type] == NSEventTypeRightMouseUp)) ? 2 : \
383
     [e buttonNumber] - 1)
384 385 386 387 388 389

/* 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.  */
390
#define EV_TRAILER(e)                                                   \
391 392 393 394 395 396 397
  {                                                                     \
    XSETFRAME (emacs_event->frame_or_window, emacsframe);               \
    EV_TRAILER2 (e);                                                    \
  }

#define EV_TRAILER2(e)                                                  \
  {                                                                     \
398 399 400
      if (e) emacs_event->timestamp = EV_TIMESTAMP (e);                 \
      if (q_event_ptr)                                                  \
        {                                                               \
Jan Djärv's avatar
Jan Djärv committed
401 402
          Lisp_Object tem = Vinhibit_quit;                              \
          Vinhibit_quit = Qt;                                           \
403 404
          n_emacs_events_pending++;                                     \
          kbd_buffer_store_event_hold (emacs_event, q_event_ptr);       \
Jan Djärv's avatar
Jan Djärv committed
405
          Vinhibit_quit = tem;                                          \
406 407
        }                                                               \
      else                                                              \
408
        hold_event (emacs_event);                                       \
409 410 411
      EVENT_INIT (*emacs_event);                                        \
      ns_send_appdefined (-1);                                          \
    }
412

413
/* TODO: get rid of need for these forward declarations */
414 415
static void ns_condemn_scroll_bars (struct frame *f);
static void ns_judge_scroll_bars (struct frame *f);
416
void x_set_frame_alpha (struct frame *f);
417 418 419 420 421 422 423 424


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

    Utilities

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

425 426 427 428 429 430 431
void
ns_set_represented_filename (NSString* fstr, struct frame *f)
{
  represented_filename = [fstr retain];
  represented_frame = f;
}

432 433 434 435 436 437 438 439 440 441 442 443 444
void
ns_init_events (struct input_event* ev)
{
  EVENT_INIT (*ev);
  emacs_event = ev;
}

void
ns_finish_events ()
{
  emacs_event = NULL;
}

445 446 447 448 449 450 451
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
452 453
      hold_event_q.q =
        xrealloc (hold_event_q.q, hold_event_q.cap * sizeof *hold_event_q.q);
454 455 456
    }

  hold_event_q.q[hold_event_q.nr++] = *event;
457
  /* Make sure ns_read_socket is called, i.e. we have input.  */
458
  raise (SIGIO);
459
  send_appdefined = YES;
460
}
461 462 463 464 465 466 467

static Lisp_Object
append2 (Lisp_Object list, Lisp_Object item)
/* --------------------------------------------------------------------------
   Utility to append to a list
   -------------------------------------------------------------------------- */
{
468
  return CALLN (Fnconc, list, list1 (item));
469 470 471
}


472
const char *
473 474 475
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.  */
476
{
477 478 479 480 481 482 483 484 485 486 487 488
  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;
489 490
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504

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.
*/
505 506
{
  NSBundle *bundle = [NSBundle mainBundle];
507 508
  NSString *resourceDir = [bundle resourcePath];
  NSString *binDir = [bundle bundlePath];
509 510
  NSString *resourcePath, *resourcePaths;
  NSRange range;
511
  NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
512
  NSFileManager *fileManager = [NSFileManager defaultManager];
513 514
  NSArray *paths;
  NSEnumerator *pathEnum;
515 516 517 518 519
  BOOL isDir;

  range = [resourceDir rangeOfString: @"Contents"];
  if (range.location != NSNotFound)
    {
520
      binDir = [binDir stringByAppendingPathComponent: @"Contents"];
521 522 523 524 525
#ifdef NS_IMPL_COCOA
      binDir = [binDir stringByAppendingPathComponent: @"MacOS"];
#endif
    }

526 527 528 529 530
  paths = [binDir stringsByAppendingPaths:
                [NSArray arrayWithObjects: @"libexec", @"bin", nil]];
  pathEnum = [paths objectEnumerator];
  resourcePaths = @"";

531
  while ((resourcePath = [pathEnum nextObject]))
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
    {
      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;
}


549 550 551
const char *
ns_load_path (void)
/* If running as a self-contained app bundle, return as a path string
552 553
   the filenames of the site-lisp and lisp directories.
   Ie, site-lisp:lisp.  Otherwise, return nil.  */
554 555 556 557
{
  NSBundle *bundle = [NSBundle mainBundle];
  NSString *resourceDir = [bundle resourcePath];
  NSString *resourcePath, *resourcePaths;
558
  NSString *pathSeparator = [NSString stringWithFormat: @"%c", SEPCHAR];
559 560
  NSFileManager *fileManager = [NSFileManager defaultManager];
  BOOL isDir;
561 562
  NSArray *paths = [resourceDir stringsByAppendingPaths:
                              [NSArray arrayWithObjects:
563
                                         @"site-lisp", @"lisp", nil]];
564 565
  NSEnumerator *pathEnum = [paths objectEnumerator];
  resourcePaths = @"";
566

567 568 569
  /* Hack to skip site-lisp.  */
  if (no_site_lisp) resourcePath = [pathEnum nextObject];

570
  while ((resourcePath = [pathEnum nextObject]))
571
    {
572 573 574 575 576 577 578 579 580
      if ([fileManager fileExistsAtPath: resourcePath isDirectory: &isDir])
        if (isDir)
          {
            if ([resourcePaths length] > 0)
              resourcePaths
                = [resourcePaths stringByAppendingString: pathSeparator];
            resourcePaths
              = [resourcePaths stringByAppendingString: resourcePath];
          }
581
    }
582 583 584
  if ([resourcePaths length] > 0) return [resourcePaths UTF8String];

  return NULL;
585 586 587
}


Alan Third's avatar
Alan Third committed
588 589 590 591 592 593 594 595 596 597 598
void
ns_init_locale (void)
/* OS X doesn't set any environment variables for the locale when run
   from the GUI. Get the locale from the OS and set LANG. */
{
  NSLocale *locale = [NSLocale currentLocale];

  NSTRACE ("ns_init_locale");

  @try
    {
599 600 601 602 603 604 605
      /* It seems OS X should probably use UTF-8 everywhere.
         'localeIdentifier' does not specify the encoding, and I can't
         find any way to get the OS to tell us which encoding to use,
         so hard-code '.UTF-8'. */
      NSString *localeID = [NSString stringWithFormat:@"%@.UTF-8",
                                     [locale localeIdentifier]];

Alan Third's avatar
Alan Third committed
606
      /* Set LANG to locale, but not if LANG is already set. */
607
      setenv("LANG", [localeID UTF8String], 0);
Alan Third's avatar
Alan Third committed
608 609 610 611 612 613 614 615
    }
  @catch (NSException *e)
    {
      NSLog (@"Locale detection failed: %@: %@", [e name], [e reason]);
    }
}


616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
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 *
637
ns_alloc_autorelease_pool (void)
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
/* --------------------------------------------------------------------------
     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);
}


656 657
static BOOL
ns_menu_bar_should_be_hidden (void)
658
/* True, if the menu bar should be hidden.  */
659 660 661 662 663 664
{
  return !NILP (ns_auto_hide_menu_bar)
    && [NSApp respondsToSelector:@selector(setPresentationOptions:)];
}


665 666 667 668 669 670 671
struct EmacsMargins
{
  CGFloat top;
  CGFloat bottom;
  CGFloat left;
  CGFloat right;
};
672

673 674 675 676

static struct EmacsMargins
ns_screen_margins (NSScreen *screen)
/* The parts of SCREEN used by the operating system.  */
677
{
678 679 680 681 682 683
  NSTRACE ("ns_screen_margins");

  struct EmacsMargins margins;

  NSRect screenFrame = [screen frame];
  NSRect screenVisibleFrame = [screen visibleFrame];
684

685 686
  /* Sometimes, visibleFrame isn't up-to-date with respect to a hidden
     menu bar, check this explicitly.  */
687 688
  if (ns_menu_bar_should_be_hidden())
    {
689
      margins.top = 0;
690 691 692 693 694 695 696
    }
  else
    {
      CGFloat frameTop = screenFrame.origin.y + screenFrame.size.height;
      CGFloat visibleFrameTop = (screenVisibleFrame.origin.y
                                 + screenVisibleFrame.size.height);

697 698 699 700 701 702 703 704 705 706 707 708
      margins.top = frameTop - visibleFrameTop;
    }

  {
    CGFloat frameRight = screenFrame.origin.x + screenFrame.size.width;
    CGFloat visibleFrameRight = (screenVisibleFrame.origin.x
                                 + screenVisibleFrame.size.width);
    margins.right = frameRight - visibleFrameRight;
  }

  margins.bottom = screenVisibleFrame.origin.y - screenFrame.origin.y;
  margins.left   = screenVisibleFrame.origin.x - screenFrame.origin.x;
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
  NSTRACE_MSG ("left:%g right:%g top:%g bottom:%g",
               margins.left,
               margins.right,
               margins.top,
               margins.bottom);

  return margins;
}


/* A screen margin between 1 and DOCK_IGNORE_LIMIT (inclusive) is
   assumed to contain a hidden dock.  OS X currently use 4 pixels for
   this, however, to be future compatible, a larger value is used.  */
#define DOCK_IGNORE_LIMIT 6

static struct EmacsMargins
ns_screen_margins_ignoring_hidden_dock (NSScreen *screen)
/* The parts of SCREEN used by the operating system, excluding the parts
reserved for an hidden dock.  */
{
  NSTRACE ("ns_screen_margins_ignoring_hidden_dock");

  struct EmacsMargins margins = ns_screen_margins(screen);

  /* OS X (currently) reserved 4 pixels along the edge where a hidden
     dock is located.  Unfortunately, it's not possible to find the
     location and information about if the dock is hidden.  Instead,
     it is assumed that if the margin of an edge is less than
     DOCK_IGNORE_LIMIT, it contains a hidden dock.  */
  if (margins.left <= DOCK_IGNORE_LIMIT)
    {
      margins.left = 0;
    }
  if (margins.right <= DOCK_IGNORE_LIMIT)
    {
      margins.right = 0;
    }
  if (margins.top <= DOCK_IGNORE_LIMIT)
    {
      margins.top = 0;
    }
  /* Note: This doesn't occur in current versions of OS X, but
     included for completeness and future compatibility.  */
  if (margins.bottom <= DOCK_IGNORE_LIMIT)
    {
      margins.bottom = 0;
756 757
    }

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
  NSTRACE_MSG ("left:%g right:%g top:%g bottom:%g",
               margins.left,
               margins.right,
               margins.top,
               margins.bottom);

  return margins;
}


static CGFloat
ns_menu_bar_height (NSScreen *screen)
/* The height of the menu bar, if visible.

   Note: Don't use this when fullscreen is enabled -- the screen
   sometimes includes, sometimes excludes the menu bar area.  */
{
  struct EmacsMargins margins = ns_screen_margins(screen);

  CGFloat res = margins.top;

779
  NSTRACE ("ns_menu_bar_height " NSTRACE_FMT_RETURN " %.0f", res);
780 781 782 783

  return res;
}

784 785 786 787 788 789 790

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

    Focus (clipping) and screen update

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

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
//
// 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.
//

833
static NSRect constrain_frame_rect(NSRect frameRect, bool isFullscreen)
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
{
  NSTRACE ("constrain_frame_rect(" NSTRACE_FMT_RECT ")",
             NSTRACE_ARG_RECT (frameRect));

  // --------------------
  // Collect information about the screen the frame is covering.
  //

  NSArray *screens = [NSScreen screens];
  NSUInteger nr_screens = [screens count];

  int i;

  // The height of the menu bar, if present in any screen the frame is
  // displayed in.
  int menu_bar_height = 0;

  // A rectangle covering all the screen the frame is displayed in.
  NSRect multiscreenRect = NSMakeRect(0, 0, 0, 0);
  for (i = 0; i < nr_screens; ++i )
    {
      NSScreen *s = [screens objectAtIndex: i];
      NSRect scrRect = [s frame];

      NSTRACE_MSG ("Screen %d: " NSTRACE_FMT_RECT,
                   i, NSTRACE_ARG_RECT (scrRect));

      if (NSIntersectionRect (frameRect, scrRect).size.height != 0)
        {
          multiscreenRect = NSUnionRect (multiscreenRect, scrRect);

865 866 867 868 869
          if (!isFullscreen)
            {
              CGFloat screen_menu_bar_height = ns_menu_bar_height (s);
              menu_bar_height = max(menu_bar_height, screen_menu_bar_height);
            }
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
        }
    }

  NSTRACE_RECT ("multiscreenRect", multiscreenRect);

  NSTRACE_MSG ("menu_bar_height: %d", menu_bar_height);

  if (multiscreenRect.size.width == 0
      || multiscreenRect.size.height == 0)
    {
      // Failed to find any monitor, give up.
      NSTRACE_MSG ("multiscreenRect empty");
      NSTRACE_RETURN_RECT (frameRect);
      return frameRect;
    }


  // --------------------
  // Find a suitable placement.
  //

  if (ns_menu_bar_should_be_hidden())
    {
      // When the menu bar is hidden, the user may place part of the
      // frame above the top of the screen, for example to hide the
      // title bar.
      //
      // Hence, keep the original position.
    }
  else
    {
      // Ensure that the frame is below the menu bar, or below the top
      // of the screen.
      //
      // This assume that the menu bar is placed at the top in the
      // rectangle that covers the monitors.  (It doesn't have to be,
      // but if it's not it's hard to do anything useful.)
      CGFloat topOfWorkArea = (multiscreenRect.origin.y
                               + multiscreenRect.size.height
                               - menu_bar_height);

      CGFloat topOfFrame = frameRect.origin.y + frameRect.size.height;
      if (topOfFrame > topOfWorkArea)
        {
          frameRect.origin.y -= topOfFrame - topOfWorkArea;
          NSTRACE_RECT ("After placement adjust", frameRect);
        }
    }

  // Include the following section to restrict frame to the screens.
  // (If so, update it to allow the frame to stretch down below the
  // screen.)
#if 0
  // --------------------
  // Ensure frame doesn't stretch below the screens.
  //

  CGFloat diff = multiscreenRect.origin.y - frameRect.origin.y;

  if (diff > 0)
    {
      frameRect.origin.y = multiscreenRect.origin.y;
      frameRect.size.height -= diff;
    }
#endif

  NSTRACE_RETURN_RECT (frameRect);
  return frameRect;
}


941 942
static void
ns_constrain_all_frames (void)
943 944 945
/* --------------------------------------------------------------------------
     Ensure that the menu bar doesn't cover any frames.
   -------------------------------------------------------------------------- */
946 947 948
{
  Lisp_Object tail, frame;

949 950
  NSTRACE ("ns_constrain_all_frames");

Anders Lindgren's avatar
Anders Lindgren committed
951 952
  block_input ();

953 954 955 956 957
  FOR_EACH_FRAME (tail, frame)
    {
      struct frame *f = XFRAME (frame);
      if (FRAME_NS_P (f))
        {
958 959 960 961 962
          EmacsView *view = FRAME_NS_VIEW (f);

          if (![view isFullscreen])
            {
              [[view window]
963
                setFrame:constrain_frame_rect([[view window] frame], false)
964 965
                 display:NO];
            }
966 967
        }
    }
Anders Lindgren's avatar
Anders Lindgren committed
968 969

  unblock_input ();
970 971 972 973 974
}


static void
ns_update_auto_hide_menu_bar (void)
975 976 977
/* --------------------------------------------------------------------------
     Show or hide the menu bar, based on user setting.
   -------------------------------------------------------------------------- */
978
{
979
#ifdef NS_IMPL_COCOA
980
  NSTRACE ("ns_update_auto_hide_menu_bar");
981

982
  block_input ();
983

984
  if (NSApp != nil && [NSApp isActive])
985 986 987 988 989 990 991 992
    {
      // 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
993
            = NSApplicationPresentationDefault;
994 995

          if (menu_bar_should_be_hidden)
996 997
            options |= NSApplicationPresentationAutoHideMenuBar
              | NSApplicationPresentationAutoHideDock;
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

          [NSApp setPresentationOptions: options];

          ns_menu_bar_is_hidden = menu_bar_should_be_hidden;

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

1010
  unblock_input ();
1011
#endif
1012 1013 1014
}


1015 1016 1017 1018
static void
ns_update_begin (struct frame *f)
/* --------------------------------------------------------------------------
   Prepare for a grouped sequence of drawing calls
1019
   external (RIF) call; whole frame, called before update_window_begin
1020 1021
   -------------------------------------------------------------------------- */
{
1022
  EmacsView *view = FRAME_NS_VIEW (f);
1023
  NSTRACE_WHEN (NSTRACE_GROUP_UPDATES, "ns_update_begin");
1024

1025 1026
  ns_update_auto_hide_menu_bar ();

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
#ifdef NS_IMPL_COCOA
  if ([view isFullscreen] && [view fsIsNative])
  {
    // Fix reappearing tool bar in fullscreen for OSX 10.7
    BOOL tbar_visible = FRAME_EXTERNAL_TOOL_BAR (f) ? YES : NO;
    NSToolbar *toolbar = [FRAME_NS_VIEW (f) toolbar];
    if (! tbar_visible != ! [toolbar isVisible])
      [toolbar setVisible: tbar_visible];
  }
#endif

1038 1039 1040
  ns_updating_frame = f;
  [view lockFocus];

1041 1042 1043 1044
  /* 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.  */
1045 1046 1047 1048
#ifdef NS_IMPL_COCOA
  {
    NSBezierPath *bp;
    NSRect r = [view frame];
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
    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];
      }
1061 1062
  }
#endif
1063

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
#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
1074
   external (RIF) call; for one window, called after update_begin
1075 1076 1077
   -------------------------------------------------------------------------- */
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
1078 1079
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);

1080
  NSTRACE_WHEN (NSTRACE_GROUP_UPDATES, "ns_update_window_begin");
1081
  w->output_cursor = w->cursor;
1082

1083
  block_input ();
1084

1085
  if (f == hlinfo->mouse_face_mouse_frame)
1086 1087
    {
      /* Don't do highlighting for mouse motion during the update.  */
1088
      hlinfo->mouse_face_defer = 1;
1089 1090 1091 1092

        /* If the frame needs to be redrawn,
           simply forget about any prior mouse highlighting.  */
      if (FRAME_GARBAGED_P (f))
1093
        hlinfo->mouse_face_window = Qnil;
1094 1095 1096 1097

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

1098
  unblock_input ();
1099 1100 1101 1102
}


static void
1103 1104
ns_update_window_end (struct window *w, bool cursor_on_p,
                      bool mouse_face_overwritten_p)
1105 1106
/* --------------------------------------------------------------------------
   Finished a grouped sequence of drawing calls
1107
   external (RIF) call; for one window called before update_end
1108 1109
   -------------------------------------------------------------------------- */
{
1110
  NSTRACE_WHEN (NSTRACE_GROUP_UPDATES, "ns_update_window_end");
1111

1112 1113 1114
  /* note: this fn is nearly identical in all terms */
  if (!w->pseudo_window_p)
    {
1115
      block_input ();
1116 1117 1118

      if (cursor_on_p)
	display_and_set_cursor (w, 1,
1119 1120
				w->output_cursor.hpos, w->output_cursor.vpos,
				w->output_cursor.x, w->output_cursor.y);
1121 1122

      if (draw_window_fringes (w, 1))
1123 1124 1125 1126 1127 1128
	{
	  if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
	    x_draw_right_divider (w);
	  else
	    x_draw_vertical_border (w);
	}
1129

1130
      unblock_input ();
1131 1132 1133 1134 1135
    }

  /* If a row with mouse-face was overwritten, arrange for
     frame_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
1136
    reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
1137 1138 1139 1140 1141 1142 1143
}


static void
ns_update_end (struct frame *f)
/* --------------------------------------------------------------------------
   Finished a grouped sequence of drawing calls
1144
   external (RIF) call; for whole frame, called after update_window_end
1145 1146
   -------------------------------------------------------------------------- */
{
1147
  EmacsView *view = FRAME_NS_VIEW (f);
1148

1149
  NSTRACE_WHEN (NSTRACE_GROUP_UPDATES, "ns_update_end");
1150

1151
/*   if (f == MOUSE_HL_INFO (f)->mouse_face_mouse_frame) */
1152
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
1153

1154
  block_input ();
1155 1156 1157 1158

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

1159
  unblock_input ();
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
  ns_updating_frame = NULL;
}

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.
   -------------------------------------------------------------------------- */
{
1174 1175 1176 1177 1178
  NSTRACE_WHEN (NSTRACE_GROUP_FOCUS, "ns_focus");
  if (r != NULL)
    {
      NSTRACE_RECT ("r", *r);
    }
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198

  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++; */
        }
    }

1199
  /* clipping */
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
  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
   -------------------------------------------------------------------------- */
{
1218
  NSTRACE_WHEN (NSTRACE_GROUP_FOCUS, "ns_unfocus");
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239

  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
1240 1241
ns_clip_to_row (struct window *w, struct glyph_row *row,
		enum glyph_row_area area, BOOL gc)
1242
/* --------------------------------------------------------------------------
1243
     Internal (but parallels other terms): Focus drawing on given row
1244 1245 1246 1247 1248 1249 1250 1251
   -------------------------------------------------------------------------- */
{
  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);

1252
  clip_rect.origin.x = window_x;
1253 1254
  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);
1255
  clip_rect.size.width = window_width;
1256 1257 1258 1259 1260 1261
  clip_rect.size.height = row->visible_height;

  ns_focus (f, &clip_rect, 1);
}


1262 1263
/* ==========================================================================

Paul Eggert's avatar
Paul Eggert committed
1264
    Visible bell and beep.
1265 1266 1267 1268

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


1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
// This bell implementation shows the visual bell image asynchronously
// from the rest of Emacs. This is done by adding a NSView to the
// superview of the Emacs window and removing it using a timer.
//
// Unfortunately, some Emacs operations, like scrolling, is done using
// low-level primitives that copy the content of the window, including
// the bell image. To some extent, this is handled by removing the
// image prior to scrolling and marking that the window is in need for
// redisplay.
//
// To test this code, make sure that there is no artifacts of the bell
// image in the following situations. Use a non-empty buffer (like the
// tutorial) to ensure that a scroll is performed:
//
// * Single-window: C-g C-v
//
// * Side-by-windows: C-x 3 C-g C-v
//
// * Windows above each other: C-x 2 C-g C-v

1289 1290 1291 1292
@interface EmacsBell : NSImageView
{
  // Number of currently active bell:s.
  unsigned int nestCount;
1293
  NSView * mView;
1294
  bool isAttached;
1295 1296 1297
}
- (void)show:(NSView *)view;
- (void)hide;
1298
- (void)remove;
1299 1300 1301 1302 1303 1304
@end

@implementation EmacsBell

- (id)init;
{
Anders Lindgren's avatar
Anders Lindgren committed
1305
  NSTRACE ("[EmacsBell init]");
1306 1307 1308
  if ((self = [super init]))
    {
      nestCount = 0;
1309
      isAttached = false;
Anders Lindgren's avatar
Anders Lindgren committed
1310 1311 1312 1313
#ifdef NS_IMPL_GNUSTEP
      // GNUstep doesn't provide named images.  This was reported in
      // 2011, see https://savannah.gnu.org/bugs/?33396
      //
Paul Eggert's avatar
Paul Eggert committed
1314
      // As a drop in replacement, a semitransparent gray square is used.
1315
      self.image = [[NSImage alloc] initWithSize:NSMakeSize(32 * 5, 32 * 5)];
Anders Lindgren's avatar
Anders Lindgren committed
1316 1317 1318 1319 1320
      [self.image lockFocus];
      [[NSColor colorForEmacsRed:0.5 green:0.5 blue:0.5 alpha:0.5] set];
      NSRectFill(NSMakeRect(0, 0, 32, 32));
      [self.image unlockFocus];
#else
1321
      self.image = [NSImage imageNamed:NSImageNameCaution];
1322 1323
      [self.image setSize:NSMakeSize(self.image.size.width * 5,
                                     self.image.size.height * 5)];
Anders Lindgren's avatar
Anders Lindgren committed
1324
#endif
1325 1326 1327 1328 1329 1330