src/nsterm.h

   1 /* Definitions and headers for communication with NeXT/Open/GNUstep API.
   2    Copyright (C) 1989, 1993, 2005, 2008-2017 Free Software Foundation,
   3    Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or (at
  10 your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20
  21 #include "dispextern.h"
  22 #include "frame.h"
  23 #include "character.h"
  24 #include "font.h"
  25 #include "sysselect.h"
  26
  27 #ifdef HAVE_NS
  28
  29 #ifdef NS_IMPL_COCOA
  30 #ifndef MAC_OS_X_VERSION_10_6
  31 #define MAC_OS_X_VERSION_10_6 1060
  32 #endif
  33 #ifndef MAC_OS_X_VERSION_10_7
  34 #define MAC_OS_X_VERSION_10_7 1070
  35 #endif
  36 #ifndef MAC_OS_X_VERSION_10_8
  37 #define MAC_OS_X_VERSION_10_8 1080
  38 #endif
  39 #ifndef MAC_OS_X_VERSION_10_9
  40 #define MAC_OS_X_VERSION_10_9 1090
  41 #endif
  42 #ifndef MAC_OS_X_VERSION_10_12
  43 #define MAC_OS_X_VERSION_10_12 101200
  44 #endif
  45
  46 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
  47 #define HAVE_NATIVE_FS
  48 #endif
  49
  50 #endif /* NS_IMPL_COCOA */
  51
  52 #ifdef __OBJC__
  53
  54 /* CGFloat on GNUstep may be 4 or 8 byte, but functions expect float* for some
  55    versions.
  56    On Cocoa >= 10.5, functions expect CGFloat*. Make compatible type.  */
  57 #ifdef NS_IMPL_COCOA
  58 typedef CGFloat EmacsCGFloat;
  59 #elif GNUSTEP_GUI_MAJOR_VERSION > 0 || GNUSTEP_GUI_MINOR_VERSION >= 22
  60 typedef CGFloat EmacsCGFloat;
  61 #else
  62 typedef float EmacsCGFloat;
  63 #endif
  64
  65 /* ==========================================================================
  66
  67    Trace support
  68
  69    ========================================================================== */
  70
  71 /* Uncomment the following line to enable trace.
  72
  73    Uncomment suitable NSTRACE_GROUP_xxx lines to trace more.
  74
  75    Hint: keep the trailing whitespace -- the version control system
  76    will reject accidental commits. */
  77
  78 /* #define NSTRACE_ENABLED 1          */
  79
  80
  81 /* When non-zero, trace output is enabled for all parts, except those
  82    explicitly disabled. */
  83 /* #define NSTRACE_ALL_GROUPS     1     */
  84
  85 /* When non-zero, trace output is enabled in the corresponding part. */
  86 /* #define NSTRACE_GROUP_EVENTS  1     */
  87 /* #define NSTRACE_GROUP_UPDATES 1     */
  88 /* #define NSTRACE_GROUP_FRINGE  1     */
  89 /* #define NSTRACE_GROUP_COLOR   1     */
  90 /* #define NSTRACE_GROUP_GLYPHS  1     */
  91 /* #define NSTRACE_GROUP_FOCUS   1     */
  92
  93
  94 /* Print a call tree containing all annotated functions.
  95
  96    The call structure of the functions is represented using
  97    indentation and vertical lines.  Extra information is printed using
  98    horizontal lines that connect to the vertical line.
  99
 100    The return value is represented using the arrow "->>".  For simple
 101    functions, the arrow can be printed on the same line as the
 102    function name.  If more output is printed, it is connected to the
 103    vertical line of the function.
 104
 105    The first column contains the file name, the second the line
 106    number, and the third a number increasing for each trace line.
 107
 108    Note, when trace output from several threads are mixed, the output
 109    can become misaligned, as all threads (currently) share one state.
 110    This is post prominent when the EVENTS part is enabled.
 111
 112    Note that the trace system, when enabled, use the GCC/Clang
 113    "cleanup" extension. */
 114
 115 /*   For example, the following is the output of `M-x
 116      toggle-frame-maximized RET'.
 117
 118      (Long lines manually split to reduced width):
 119
 120 nsterm.m  : 1608: [  354]  ns_fullscreen_hook
 121 nsterm.m  : 7180: [  355]  | [EmacsView handleFS]
 122 nsterm.m  : 7209: [  356]  | +--- FULLSCREEN_MAXIMIZED
 123 nsterm.m  : 7706: [  357]  | | [EmacsWindow performZoom:]
 124 nsterm.m  : 7715: [  358]  | | | [EmacsWindow zoom:]
 125 nsterm.m  :  882: [  359]  | | | | ns_update_auto_hide_menu_bar
 126 nsterm.m  : 6752: [  360]  | | | |
 127   [EmacsView windowWillUseStandardFrame:defaultFrame:(X:0 Y:0)/(W:1600 H:1177)]
 128 nsterm.m  : 6753: [  361]  | | | | +--- fs_state: FULLSCREEN_NONE
 129 nsterm.m  : 6754: [  362]  | | | | +--- fs_before_fs: -1
 130 nsterm.m  : 6755: [  363]  | | | | +--- next_maximized: FULLSCREEN_MAXIMIZED
 131 nsterm.m  : 6756: [  364]  | | | | +--- ns_userRect: (X:0 Y:0)/(W:0 H:0)
 132 nsterm.m  : 6757: [  365]  | | | | +---
 133                                       [sender frame]: (X:0 Y:626)/(W:595 H:551)
 134 nsterm.m  : 6781: [  366]  | | | | +---
 135                                      ns_userRect (2): (X:0 Y:626)/(W:595 H:551)
 136 nsterm.m  : 6821: [  367]  | | | | +--- FULLSCREEN_MAXIMIZED
 137 nsterm.m  : 7232: [  368]  | | | | |
 138                                     [EmacsView setFSValue:FULLSCREEN_MAXIMIZED]
 139 nsterm.m  : 6848: [  369]  | | | | +---
 140                                    Final ns_userRect: (X:0 Y:626)/(W:595 H:551)
 141 nsterm.m  : 6849: [  370]  | | | | +--- Final maximized_width: 1600
 142 nsterm.m  : 6850: [  371]  | | | | +--- Final maximized_height: 1177
 143 nsterm.m  : 6851: [  372]  | | | | +--- Final next_maximized: -1
 144 nsterm.m  : 6322: [  373]  | | | | |
 145                            [EmacsView windowWillResize:toSize: (W:1600 H:1177)]
 146 nsterm.m  : 6323: [  374]  | | | | | +---
 147                                       [sender frame]: (X:0 Y:626)/(W:595 H:551)
 148 nsterm.m  : 6324: [  375]  | | | | | +--- fs_state: FULLSCREEN_MAXIMIZED
 149 nsterm.m  : 7027: [  376]  | | | | | | [EmacsView isFullscreen]
 150 nsterm.m  : 6387: [  377]  | | | | | +--- cols: 223  rows: 79
 151 nsterm.m  : 6412: [  378]  | | | | | +->> (W:1596 H:1167)
 152 nsterm.m  : 6855: [  379]  | | | | +->> (X:0 Y:0)/(W:1600 H:1177)
 153 */
 154
 155 #ifndef NSTRACE_ENABLED
 156 #define NSTRACE_ENABLED 0
 157 #endif
 158
 159 #if NSTRACE_ENABLED
 160
 161 #ifndef NSTRACE_ALL_GROUPS
 162 #define NSTRACE_ALL_GROUPS 0
 163 #endif
 164
 165 #ifndef NSTRACE_GROUP_EVENTS
 166 #define NSTRACE_GROUP_EVENTS NSTRACE_ALL_GROUPS
 167 #endif
 168
 169 #ifndef NSTRACE_GROUP_UPDATES
 170 #define NSTRACE_GROUP_UPDATES NSTRACE_ALL_GROUPS
 171 #endif
 172
 173 #ifndef NSTRACE_GROUP_FRINGE
 174 #define NSTRACE_GROUP_FRINGE NSTRACE_ALL_GROUPS
 175 #endif
 176
 177 #ifndef NSTRACE_GROUP_COLOR
 178 #define NSTRACE_GROUP_COLOR NSTRACE_ALL_GROUPS
 179 #endif
 180
 181 #ifndef NSTRACE_GROUP_GLYPHS
 182 #define NSTRACE_GROUP_GLYPHS NSTRACE_ALL_GROUPS
 183 #endif
 184
 185 #ifndef NSTRACE_GROUP_FOCUS
 186 #define NSTRACE_GROUP_FOCUS NSTRACE_ALL_GROUPS
 187 #endif
 188
 189 extern volatile int nstrace_num;
 190 extern volatile int nstrace_depth;
 191 extern volatile int nstrace_enabled_global;
 192
 193 void nstrace_leave(int *);
 194 void nstrace_restore_global_trace_state(int *);
 195 char const * nstrace_fullscreen_type_name (int);
 196
 197 /* printf-style trace output.  Output is aligned with contained heading. */
 198 #define NSTRACE_MSG_NO_DASHES(...)                                          \
 199   do                                                                        \
 200     {                                                                       \
 201       if (nstrace_enabled)                                                  \
 202         {                                                                   \
 203           fprintf (stderr, "%-10s:%5d: [%5d]%.*s",                          \
 204                    __FILE__, __LINE__, nstrace_num++,                       \
 205                    2*nstrace_depth, "  | | | | | | | | | | | | | | | ..");  \
 206           fprintf (stderr, __VA_ARGS__);                                    \
 207           fprintf (stderr, "\n");                                           \
 208         }                                                                   \
 209     }                                                                       \
 210   while(0)
 211
 212 #define NSTRACE_MSG(...) NSTRACE_MSG_NO_DASHES("+--- " __VA_ARGS__)
 213
 214
 215
 216 /* Macros for printing complex types.
 217
 218    NSTRACE_FMT_what     -- Printf format string for "what".
 219    NSTRACE_ARG_what(x)  -- Printf argument for "what". */
 220
 221 #define NSTRACE_FMT_SIZE        "(W:%.0f H:%.0f)"
 222 #define NSTRACE_ARG_SIZE(elt)   (elt).width, (elt).height
 223
 224 #define NSTRACE_FMT_POINT       "(X:%.0f Y:%.0f)"
 225 #define NSTRACE_ARG_POINT(elt)  (elt).x, (elt).y
 226
 227 #define NSTRACE_FMT_RECT        NSTRACE_FMT_POINT "/" NSTRACE_FMT_SIZE
 228 #define NSTRACE_ARG_RECT(elt)   \
 229   NSTRACE_ARG_POINT((elt).origin), NSTRACE_ARG_SIZE((elt).size)
 230
 231 #define NSTRACE_FMT_FSTYPE      "%s"
 232 #define NSTRACE_ARG_FSTYPE(elt) nstrace_fullscreen_type_name(elt)
 233
 234
 235 /* Macros for printing complex types as extra information. */
 236
 237 #define NSTRACE_SIZE(str,size)                                          \
 238   NSTRACE_MSG (str ": " NSTRACE_FMT_SIZE,                               \
 239                NSTRACE_ARG_SIZE (size));
 240
 241 #define NSTRACE_POINT(str,point)                                        \
 242   NSTRACE_MSG (str ": " NSTRACE_FMT_POINT,                              \
 243                NSTRACE_ARG_POINT (point));
 244
 245 #define NSTRACE_RECT(str,rect)                                          \
 246   NSTRACE_MSG (str ": " NSTRACE_FMT_RECT,                               \
 247                NSTRACE_ARG_RECT (rect));
 248
 249 #define NSTRACE_FSTYPE(str,fs_type)                                     \
 250   NSTRACE_MSG (str ": " NSTRACE_FMT_FSTYPE,                             \
 251                NSTRACE_ARG_FSTYPE (fs_type));
 252
 253
 254 /* Return value macros.
 255
 256    NSTRACE_RETURN(fmt, ...) - Print a return value, support printf-style
 257                               format string and arguments.
 258
 259    NSTRACE_RETURN_what(obj) - Print a return value of kind WHAT.
 260
 261    NSTRACE_FMT_RETURN - A string literal representing a returned
 262                         value.  Useful when creating a format string
 263                         to printf-like constructs like NSTRACE(). */
 264
 265 #define NSTRACE_FMT_RETURN "->>"
 266
 267 #define NSTRACE_RETURN(...) \
 268   NSTRACE_MSG_NO_DASHES ("+" NSTRACE_FMT_RETURN " " __VA_ARGS__)
 269
 270 #define NSTRACE_RETURN_SIZE(size) \
 271   NSTRACE_RETURN(NSTRACE_FMT_SIZE, NSTRACE_ARG_SIZE(size))
 272
 273 #define NSTRACE_RETURN_POINT(point) \
 274   NSTRACE_RETURN(NSTRACE_FMT_POINT, NSTRACE_ARG_POINT(point))
 275
 276 #define NSTRACE_RETURN_RECT(rect) \
 277   NSTRACE_RETURN(NSTRACE_FMT_RECT, NSTRACE_ARG_RECT(rect))
 278
 279
 280 /* Function enter macros.
 281
 282    NSTRACE (fmt, ...) -- Enable trace output in current block
 283                          (typically a function).  Accepts printf-style
 284                          arguments.
 285
 286    NSTRACE_WHEN (cond, fmt, ...) -- Enable trace output when COND is true.
 287
 288    NSTRACE_UNLESS (cond, fmt, ...) -- Enable trace output unless COND is
 289                                       true. */
 290
 291
 292
 293 #define NSTRACE_WHEN(cond, ...)                                         \
 294   __attribute__((cleanup(nstrace_restore_global_trace_state)))          \
 295   int nstrace_saved_enabled_global = nstrace_enabled_global;            \
 296   __attribute__((cleanup(nstrace_leave)))                               \
 297   int nstrace_enabled = nstrace_enabled_global && (cond);               \
 298   if (nstrace_enabled) { ++nstrace_depth; }                             \
 299   else { nstrace_enabled_global = 0; }                                  \
 300   NSTRACE_MSG_NO_DASHES(__VA_ARGS__);
 301
 302 /* Unsilence called functions.
 303
 304    Concretely, this us used to allow "event" functions to be silenced
 305    while trace output can be printed for functions they call. */
 306 #define NSTRACE_UNSILENCE() do { nstrace_enabled_global = 1; } while(0)
 307
 308 #endif /* NSTRACE_ENABLED */
 309
 310 #define NSTRACE(...)              NSTRACE_WHEN(1, __VA_ARGS__)
 311 #define NSTRACE_UNLESS(cond, ...) NSTRACE_WHEN(!(cond), __VA_ARGS__)
 312
 313 /* Non-trace replacement versions. */
 314 #ifndef NSTRACE_WHEN
 315 #define NSTRACE_WHEN(...)
 316 #endif
 317
 318 #ifndef NSTRACE_MSG
 319 #define NSTRACE_MSG(...)
 320 #endif
 321
 322 #ifndef NSTRACE_SIZE
 323 #define NSTRACE_SIZE(str,size)
 324 #endif
 325
 326 #ifndef NSTRACE_POINT
 327 #define NSTRACE_POINT(str,point)
 328 #endif
 329
 330 #ifndef NSTRACE_RECT
 331 #define NSTRACE_RECT(str,rect)
 332 #endif
 333
 334 #ifndef NSTRACE_FSTYPE
 335 #define NSTRACE_FSTYPE(str,fs_type)
 336 #endif
 337
 338 #ifndef NSTRACE_RETURN_SIZE
 339 #define NSTRACE_RETURN_SIZE(size)
 340 #endif
 341
 342 #ifndef NSTRACE_RETURN_POINT
 343 #define NSTRACE_RETURN_POINT(point)
 344 #endif
 345
 346 #ifndef NSTRACE_RETURN_RECT
 347 #define NSTRACE_RETURN_RECT(rect)
 348 #endif
 349
 350 #ifndef NSTRACE_RETURN_FSTYPE
 351 #define NSTRACE_RETURN_FSTYPE(fs_type)
 352 #endif
 353
 354 #ifndef NSTRACE_UNSILENCE
 355 #define NSTRACE_UNSILENCE()
 356 #endif
 357
 358
 359 /* ==========================================================================
 360
 361    NSColor, EmacsColor category.
 362
 363    ========================================================================== */
 364 @interface NSColor (EmacsColor)
 365 + (NSColor *)colorForEmacsRed:(CGFloat)red green:(CGFloat)green
 366                          blue:(CGFloat)blue alpha:(CGFloat)alpha;
 367 - (NSColor *)colorUsingDefaultColorSpace;
 368
 369 @end
 370
 371 /* ==========================================================================
 372
 373    The Emacs application
 374
 375    ========================================================================== */
 376
 377 /* We override sendEvent: as a means to stop/start the event loop */
 378 @interface EmacsApp : NSApplication
 379 {
 380 #ifdef NS_IMPL_COCOA
 381   BOOL shouldKeepRunning;
 382   BOOL isFirst;
 383 #endif
 384 #ifdef NS_IMPL_GNUSTEP
 385   BOOL applicationDidFinishLaunchingCalled;
 386 #endif
 387 @public
 388   int nextappdefined;
 389 }
 390 - (void)logNotification: (NSNotification *)notification;
 391 - (void)antialiasThresholdDidChange:(NSNotification *)notification;
 392 - (void)sendEvent: (NSEvent *)theEvent;
 393 - (void)showPreferencesWindow: (id)sender;
 394 - (BOOL) openFile: (NSString *)fileName;
 395 - (void)timeout_handler: (NSTimer *)timedEntry;
 396 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg;
 397 #ifdef NS_IMPL_GNUSTEP
 398 - (void)sendFromMainThread:(id)unused;
 399 #endif
 400 @end
 401
 402 #ifdef NS_IMPL_GNUSTEP
 403 /* Dummy class to get rid of startup warnings.  */
 404 @interface EmacsDocument : NSDocument
 405 {
 406 }
 407 @end
 408 #endif
 409
 410 /* ==========================================================================
 411
 412    The main Emacs view
 413
 414    ========================================================================== */
 415
 416 @class EmacsToolbar;
 417
 418 #ifdef NS_IMPL_COCOA
 419 @interface EmacsView : NSView <NSTextInput, NSWindowDelegate>
 420 #else
 421 @interface EmacsView : NSView <NSTextInput>
 422 #endif
 423    {
 424 #ifdef NS_IMPL_COCOA
 425    char *old_title;
 426    BOOL maximizing_resize;
 427 #endif
 428    BOOL windowClosing;
 429    NSString *workingText;
 430    BOOL processingCompose;
 431    int fs_state, fs_before_fs, next_maximized;
 432    int tibar_height, tobar_height, bwidth;
 433    int maximized_width, maximized_height;
 434    NSWindow *nonfs_window;
 435    BOOL fs_is_native;
 436 @public
 437    struct frame *emacsframe;
 438    int rows, cols;
 439    int scrollbarsNeedingUpdate;
 440    EmacsToolbar *toolbar;
 441    NSRect ns_userRect;
 442    BOOL wait_for_tool_bar;
 443    }
 444
 445 /* AppKit-side interface */
 446 - menuDown: (id)sender;
 447 - toolbarClicked: (id)item;
 448 - toggleToolbar: (id)sender;
 449 - (void)keyDown: (NSEvent *)theEvent;
 450 - (void)mouseDown: (NSEvent *)theEvent;
 451 - (void)mouseUp: (NSEvent *)theEvent;
 452 - setMiniwindowImage: (BOOL)setMini;
 453
 454 /* Emacs-side interface */
 455 - initFrameFromEmacs: (struct frame *) f;
 456 - (void) setRows: (int) r andColumns: (int) c;
 457 - (void) setWindowClosing: (BOOL)closing;
 458 - (EmacsToolbar *) toolbar;
 459 - (void) deleteWorkingText;
 460 - (void) updateFrameSize: (BOOL) delay;
 461 - (void) handleFS;
 462 - (void) setFSValue: (int)value;
 463 - (void) toggleFullScreen: (id) sender;
 464 - (BOOL) fsIsNative;
 465 - (BOOL) isFullscreen;
 466 #ifdef HAVE_NATIVE_FS
 467 - (void) updateCollectionBehavior;
 468 #endif
 469
 470 #ifdef NS_IMPL_GNUSTEP
 471 - (void)windowDidMove: (id)sender;
 472 #endif
 473 - (int)fullscreenState;
 474
 475 /* Non-notification versions of NSView methods. Used for direct calls. */
 476 - (void)windowWillEnterFullScreen;
 477 - (void)windowDidEnterFullScreen;
 478 - (void)windowWillExitFullScreen;
 479 - (void)windowDidExitFullScreen;
 480 - (void)windowDidBecomeKey;
 481 @end
 482
 483
 484 /* Small utility used for processing resize events under Cocoa. */
 485 @interface EmacsWindow : NSWindow
 486 {
 487   NSPoint grabOffset;
 488 }
 489 @end
 490
 491
 492 /* Fullscreen version of the above.  */
 493 @interface EmacsFSWindow : EmacsWindow
 494 {
 495 }
 496 @end
 497
 498 /* ==========================================================================
 499
 500    The main menu implementation
 501
 502    ========================================================================== */
 503
 504 #ifdef NS_IMPL_COCOA
 505 @interface EmacsMenu : NSMenu  <NSMenuDelegate>
 506 #else
 507 @interface EmacsMenu : NSMenu
 508 #endif
 509 {
 510   struct frame *frame;
 511   unsigned long keyEquivModMask;
 512 }
 513
 514 - initWithTitle: (NSString *)title frame: (struct frame *)f;
 515 - (void)setFrame: (struct frame *)f;
 516 - (void)menuNeedsUpdate: (NSMenu *)menu; /* (delegate method) */
 517 - (NSString *)parseKeyEquiv: (const char *)key;
 518 - (NSMenuItem *)addItemWithWidgetValue: (void *)wvptr;
 519 - (void)fillWithWidgetValue: (void *)wvptr;
 520 - (void)fillWithWidgetValue: (void *)wvptr frame: (struct frame *)f;
 521 - (EmacsMenu *)addSubmenuWithTitle: (const char *)title forFrame: (struct frame *)f;
 522 - (void) clear;
 523 - (Lisp_Object)runMenuAt: (NSPoint)p forFrame: (struct frame *)f
 524                  keymaps: (bool)keymaps;
 525 @end
 526
 527
 528 /* ==========================================================================
 529
 530    Toolbar
 531
 532    ========================================================================== */
 533
 534 @class EmacsImage;
 535
 536 #ifdef NS_IMPL_COCOA
 537 @interface EmacsToolbar : NSToolbar <NSToolbarDelegate>
 538 #else
 539 @interface EmacsToolbar : NSToolbar
 540 #endif
 541    {
 542      EmacsView *emacsView;
 543      NSMutableDictionary *identifierToItem;
 544      NSMutableArray *activeIdentifiers;
 545      NSArray *prevIdentifiers;
 546      unsigned long enablement, prevEnablement;
 547    }
 548 - initForView: (EmacsView *)view withIdentifier: (NSString *)identifier;
 549 - (void) clearActive;
 550 - (void) clearAll;
 551 - (BOOL) changed;
 552 - (void) addDisplayItemWithImage: (EmacsImage *)img
 553                              idx: (int)idx
 554                              tag: (int)tag
 555                         helpText: (const char *)help
 556                          enabled: (BOOL)enabled;
 557
 558 /* delegate methods */
 559 - (NSToolbarItem *)toolbar: (NSToolbar *)toolbar
 560      itemForItemIdentifier: (NSString *)itemIdentifier
 561  willBeInsertedIntoToolbar: (BOOL)flag;
 562 - (NSArray *)toolbarDefaultItemIdentifiers: (NSToolbar *)toolbar;
 563 - (NSArray *)toolbarAllowedItemIdentifiers: (NSToolbar *)toolbar;
 564 @end
 565
 566
 567 /* ==========================================================================
 568
 569    Message / question windows
 570
 571    ========================================================================== */
 572
 573 @interface EmacsDialogPanel : NSPanel
 574    {
 575    NSTextField *command;
 576    NSTextField *title;
 577    NSMatrix *matrix;
 578    int rows, cols;
 579    BOOL timer_fired, window_closed;
 580    Lisp_Object dialog_return;
 581    Lisp_Object *button_values;
 582    }
 583 - initFromContents: (Lisp_Object)menu isQuestion: (BOOL)isQ;
 584 - (void)process_dialog: (Lisp_Object)list;
 585 - (void)addButton: (char *)str value: (int)tag row: (int)row;
 586 - (void)addString: (char *)str row: (int)row;
 587 - (void)addSplit;
 588 - (Lisp_Object)runDialogAt: (NSPoint)p;
 589 - (void)timeout_handler: (NSTimer *)timedEntry;
 590 @end
 591
 592 #ifdef NS_IMPL_COCOA
 593 @interface EmacsTooltip : NSObject <NSWindowDelegate>
 594 #else
 595 @interface EmacsTooltip : NSObject
 596 #endif
 597   {
 598     NSWindow *win;
 599     NSTextField *textField;
 600     NSTimer *timer;
 601   }
 602 - init;
 603 - (void) setText: (char *)text;
 604 - (void) showAtX: (int)x Y: (int)y for: (int)seconds;
 605 - (void) hide;
 606 - (BOOL) isActive;
 607 - (NSRect) frame;
 608 @end
 609
 610
 611 /* ==========================================================================
 612
 613    File open/save panels
 614    This and next override methods to handle keyboard input in panels.
 615
 616    ========================================================================== */
 617
 618 @interface EmacsSavePanel : NSSavePanel
 619 {
 620 }
 621 @end
 622 @interface EmacsOpenPanel : NSOpenPanel
 623 {
 624 }
 625 @end
 626
 627 @interface EmacsFileDelegate : NSObject
 628 {
 629 }
 630 - (BOOL)panel: (id)sender isValidFilename: (NSString *)filename;
 631 - (BOOL)panel: (id)sender shouldShowFilename: (NSString *)filename;
 632 - (NSString *)panel: (id)sender userEnteredFilename: (NSString *)filename
 633           confirmed: (BOOL)okFlag;
 634 @end
 635
 636
 637 /* ==========================================================================
 638
 639    Images and stippling
 640
 641    ========================================================================== */
 642
 643 @interface EmacsImage : NSImage
 644 {
 645   NSBitmapImageRep *bmRep; /* used for accessing pixel data */
 646   unsigned char *pixmapData[5]; /* shortcut to access pixel data */
 647   NSColor *stippleMask;
 648   unsigned long xbm_fg;
 649 }
 650 + allocInitFromFile: (Lisp_Object)file;
 651 - (void)dealloc;
 652 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
 653                   fg: (unsigned long)fg bg: (unsigned long)bg;
 654 - setXBMColor: (NSColor *)color;
 655 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height;
 656 - (void)setPixmapData;
 657 - (unsigned long)getPixelAtX: (int)x Y: (int)y;
 658 - (void)setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
 659                green: (unsigned char)g blue: (unsigned char)b
 660               alpha:(unsigned char)a;
 661 - (void)setAlphaAtX: (int)x Y: (int)y to: (unsigned char)a;
 662 - (NSColor *)stippleMask;
 663 @end
 664
 665
 666 /* ==========================================================================
 667
 668    Scrollbars
 669
 670    ========================================================================== */
 671
 672 @interface EmacsScroller : NSScroller
 673   {
 674    struct window *window;
 675    struct frame *frame;
 676    NSResponder *prevResponder;
 677
 678    /* offset to the bottom of knob of last mouse down */
 679    CGFloat last_mouse_offset;
 680    float min_portion;
 681    int pixel_length;
 682    enum scroll_bar_part last_hit_part;
 683
 684    BOOL condemned;
 685
 686    BOOL horizontal;
 687
 688    /* optimize against excessive positioning calls generated by emacs */
 689    int em_position;
 690    int em_portion;
 691    int em_whole;
 692    }
 693
 694 - initFrame: (NSRect )r window: (Lisp_Object)win;
 695 - (void)setFrame: (NSRect)r;
 696
 697 - setPosition: (int) position portion: (int) portion whole: (int) whole;
 698 - (int) checkSamePosition: (int)position portion: (int)portion
 699                     whole: (int)whole;
 700 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e;
 701 - repeatScroll: (NSTimer *)sender;
 702 - condemn;
 703 - reprieve;
 704 - (bool)judge;
 705 + (CGFloat)scrollerWidth;
 706 @end
 707
 708
 709 /* ==========================================================================
 710
 711    Rendering
 712
 713    ========================================================================== */
 714
 715 #ifdef NS_IMPL_COCOA
 716 /* rendering util */
 717 @interface EmacsGlyphStorage : NSObject <NSGlyphStorage>
 718 {
 719 @public
 720   NSAttributedString *attrStr;
 721   NSMutableDictionary *dict;
 722   CGGlyph *cglyphs;
 723   unsigned long maxChar, maxGlyph;
 724   long i, len;
 725 }
 726 - initWithCapacity: (unsigned long) c;
 727 - (void) setString: (NSString *)str font: (NSFont *)font;
 728 @end
 729 #endif  /* NS_IMPL_COCOA */
 730
 731 extern NSArray *ns_send_types, *ns_return_types;
 732 extern NSString *ns_app_name;
 733 extern EmacsMenu *svcsMenu;
 734
 735 /* Apple removed the declaration, but kept the implementation */
 736 #if defined (NS_IMPL_COCOA)
 737 @interface NSApplication (EmacsApp)
 738 - (void)setAppleMenu: (NSMenu *)menu;
 739 @end
 740 #endif
 741
 742 #endif  /* __OBJC__ */
 743
 744
 745
 746 /* ==========================================================================
 747
 748    Non-OO stuff
 749
 750    ========================================================================== */
 751
 752 /* Special keycodes that we pass down the event chain */
 753 #define KEY_NS_POWER_OFF               ((1<<28)|(0<<16)|1)
 754 #define KEY_NS_OPEN_FILE               ((1<<28)|(0<<16)|2)
 755 #define KEY_NS_OPEN_TEMP_FILE          ((1<<28)|(0<<16)|3)
 756 #define KEY_NS_CHANGE_FONT             ((1<<28)|(0<<16)|7)
 757 #define KEY_NS_OPEN_FILE_LINE          ((1<<28)|(0<<16)|8)
 758 #define KEY_NS_PUT_WORKING_TEXT        ((1<<28)|(0<<16)|9)
 759 #define KEY_NS_UNPUT_WORKING_TEXT      ((1<<28)|(0<<16)|10)
 760 #define KEY_NS_SPI_SERVICE_CALL        ((1<<28)|(0<<16)|11)
 761 #define KEY_NS_NEW_FRAME               ((1<<28)|(0<<16)|12)
 762 #define KEY_NS_TOGGLE_TOOLBAR          ((1<<28)|(0<<16)|13)
 763 #define KEY_NS_SHOW_PREFS              ((1<<28)|(0<<16)|14)
 764
 765 /* could use list to store these, but rest of emacs has a big infrastructure
 766    for managing a table of bitmap "records" */
 767 struct ns_bitmap_record
 768 {
 769 #ifdef __OBJC__
 770   EmacsImage *img;
 771 #else
 772   void *img;
 773 #endif
 774   char *file;
 775   int refcount;
 776   int height, width, depth;
 777 };
 778
 779 /* this to map between emacs color indices and NSColor objects */
 780 struct ns_color_table
 781 {
 782   ptrdiff_t size;
 783   ptrdiff_t avail;
 784 #ifdef __OBJC__
 785   NSColor **colors;
 786   NSMutableSet *empty_indices;
 787 #else
 788   void **items;
 789   void *availIndices;
 790 #endif
 791 };
 792 #define NS_COLOR_CAPACITY 256
 793
 794 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
 795 #define ARGB_TO_ULONG(a, r, g, b) (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
 796
 797 #define ALPHA_FROM_ULONG(color) ((color) >> 24)
 798 #define RED_FROM_ULONG(color) (((color) >> 16) & 0xff)
 799 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
 800 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
 801
 802 /* Do not change `* 0x101' in the following lines to `<< 8'.  If
 803    changed, image masks in 1-bit depth will not work. */
 804 #define RED16_FROM_ULONG(color) (RED_FROM_ULONG(color) * 0x101)
 805 #define GREEN16_FROM_ULONG(color) (GREEN_FROM_ULONG(color) * 0x101)
 806 #define BLUE16_FROM_ULONG(color) (BLUE_FROM_ULONG(color) * 0x101)
 807
 808 /* this extends font backend font */
 809 struct nsfont_info
 810 {
 811   struct font font;
 812
 813   char *name;  /* PostScript name, uniquely identifies on NS systems */
 814
 815   /* The following metrics are stored as float rather than int. */
 816
 817   float width;  /* Maximum advance for the font.  */
 818   float height;
 819   float underpos;
 820   float underwidth;
 821   float size;
 822 #ifdef __OBJC__
 823   NSFont *nsfont;
 824 #if defined (NS_IMPL_COCOA)
 825   CGFontRef cgfont;
 826 #else /* GNUstep */
 827   void *cgfont;
 828 #endif
 829 #else /* ! OBJC */
 830   void *nsfont;
 831   void *cgfont;
 832 #endif
 833   char bold, ital;  /* convenience flags */
 834   char synthItal;
 835   XCharStruct max_bounds;
 836   /* we compute glyph codes and metrics on-demand in blocks of 256 indexed
 837      by hibyte, lobyte */
 838   unsigned short **glyphs; /* map Unicode index to glyph */
 839   struct font_metrics **metrics;
 840 };
 841
 842
 843 /* init'd in ns_initialize_display_info () */
 844 struct ns_display_info
 845 {
 846   /* Chain of all ns_display_info structures.  */
 847   struct ns_display_info *next;
 848
 849   /* The generic display parameters corresponding to this NS display. */
 850   struct terminal *terminal;
 851
 852   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).  */
 853   Lisp_Object name_list_element;
 854
 855   /* The number of fonts loaded. */
 856   int n_fonts;
 857
 858   /* Minimum width over all characters in all fonts in font_table.  */
 859   int smallest_char_width;
 860
 861   /* Minimum font height over all fonts in font_table.  */
 862   int smallest_font_height;
 863
 864   struct ns_bitmap_record *bitmaps;
 865   ptrdiff_t bitmaps_size;
 866   ptrdiff_t bitmaps_last;
 867
 868   struct ns_color_table *color_table;
 869
 870   /* DPI resolution of this screen */
 871   double resx, resy;
 872
 873   /* Mask of things that cause the mouse to be grabbed */
 874   int grabbed;
 875
 876   int n_planes;
 877
 878   int color_p;
 879
 880   Window root_window;
 881
 882   /* Xism */
 883   XrmDatabase xrdb;
 884
 885   /* The cursor to use for vertical scroll bars. */
 886   Cursor vertical_scroll_bar_cursor;
 887
 888   /* The cursor to use for horizontal scroll bars. */
 889   Cursor horizontal_scroll_bar_cursor;
 890
 891   /* Information about the range of text currently shown in
 892      mouse-face.  */
 893   Mouse_HLInfo mouse_highlight;
 894
 895   struct frame *x_highlight_frame;
 896   struct frame *x_focus_frame;
 897
 898   /* The frame where the mouse was last time we reported a mouse event.  */
 899   struct frame *last_mouse_frame;
 900
 901   /* The frame where the mouse was last time we reported a mouse motion.  */
 902   struct frame *last_mouse_motion_frame;
 903
 904   /* Position where the mouse was last time we reported a motion.
 905      This is a position on last_mouse_motion_frame.  */
 906   int last_mouse_motion_x;
 907   int last_mouse_motion_y;
 908
 909   /* Where the mouse was last time we reported a mouse position.  */
 910   NSRect last_mouse_glyph;
 911
 912   /* Time of last mouse movement.  */
 913   Time last_mouse_movement_time;
 914
 915   /* The scroll bar in which the last motion event occurred.  */
 916 #ifdef __OBJC__
 917   EmacsScroller *last_mouse_scroll_bar;
 918 #else
 919   void *last_mouse_scroll_bar;
 920 #endif
 921 };
 922
 923 /* This is a chain of structures for all the NS displays currently in use.  */
 924 extern struct ns_display_info *x_display_list;
 925
 926 struct ns_output
 927 {
 928 #ifdef __OBJC__
 929   EmacsView *view;
 930   id miniimage;
 931   NSColor *cursor_color;
 932   NSColor *foreground_color;
 933   NSColor *background_color;
 934   EmacsToolbar *toolbar;
 935 #else
 936   void *view;
 937   void *miniimage;
 938   void *cursor_color;
 939   void *foreground_color;
 940   void *background_color;
 941   void *toolbar;
 942 #endif
 943
 944   /* NSCursors init'ed in initFrameFromEmacs */
 945   Cursor text_cursor;
 946   Cursor nontext_cursor;
 947   Cursor modeline_cursor;
 948   Cursor hand_cursor;
 949   Cursor hourglass_cursor;
 950   Cursor horizontal_drag_cursor;
 951   Cursor vertical_drag_cursor;
 952
 953   /* NS-specific */
 954   Cursor current_pointer;
 955
 956   /* lord knows why Emacs needs to know about our Window ids.. */
 957   Window window_desc, parent_desc;
 958   char explicit_parent;
 959
 960   struct font *font;
 961   int baseline_offset;
 962
 963   /* If a fontset is specified for this frame instead of font, this
 964      value contains an ID of the fontset, else -1.  */
 965   int fontset; /* only used with font_backend */
 966
 967   int icon_top;
 968   int icon_left;
 969
 970   /* The size of the extra width currently allotted for vertical
 971      scroll bars, in pixels.  */
 972   int vertical_scroll_bar_extra;
 973
 974   /* The height of the titlebar decoration (included in NSWindow's frame). */
 975   int titlebar_height;
 976
 977   /* The height of the toolbar if displayed, else 0. */
 978   int toolbar_height;
 979
 980   /* This is the Emacs structure for the NS display this frame is on.  */
 981   struct ns_display_info *display_info;
 982
 983   /* Non-zero if we are zooming (maximizing) the frame.  */
 984   int zooming;
 985
 986   /* Non-zero if we are doing an animation, e.g. toggling the tool bar. */
 987   int in_animation;
 988 };
 989
 990 /* this dummy decl needed to support TTYs */
 991 struct x_output
 992 {
 993   int unused;
 994 };
 995
 996
 997 /* This gives the ns_display_info structure for the display F is on.  */
 998 #define FRAME_DISPLAY_INFO(f) ((f)->output_data.ns->display_info)
 999 #define FRAME_X_OUTPUT(f) ((f)->output_data.ns)
1000 #define FRAME_NS_WINDOW(f) ((f)->output_data.ns->window_desc)
1001 #define FRAME_X_WINDOW(f) ((f)->output_data.ns->window_desc)
1002
1003 /* This is the `Display *' which frame F is on.  */
1004 #define FRAME_NS_DISPLAY(f) (0)
1005 #define FRAME_X_DISPLAY(f) (0)
1006 #define FRAME_X_SCREEN(f) (0)
1007 #define FRAME_X_VISUAL(f) FRAME_DISPLAY_INFO(f)->visual
1008
1009 #define FRAME_FOREGROUND_COLOR(f) ((f)->output_data.ns->foreground_color)
1010 #define FRAME_BACKGROUND_COLOR(f) ((f)->output_data.ns->background_color)
1011
1012 #define NS_FACE_FOREGROUND(f) ((f)->foreground)
1013 #define NS_FACE_BACKGROUND(f) ((f)->background)
1014 #define FRAME_NS_TITLEBAR_HEIGHT(f) ((f)->output_data.ns->titlebar_height)
1015 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.ns->toolbar_height)
1016
1017 #define FRAME_DEFAULT_FACE(f) FACE_FROM_ID_OR_NULL (f, DEFAULT_FACE_ID)
1018
1019 #define FRAME_NS_VIEW(f) ((f)->output_data.ns->view)
1020 #define FRAME_CURSOR_COLOR(f) ((f)->output_data.ns->cursor_color)
1021 #define FRAME_POINTER_TYPE(f) ((f)->output_data.ns->current_pointer)
1022
1023 #define FRAME_FONT(f) ((f)->output_data.ns->font)
1024
1025 #ifdef __OBJC__
1026 #define XNS_SCROLL_BAR(vec) ((id) XSAVE_POINTER (vec, 0))
1027 #else
1028 #define XNS_SCROLL_BAR(vec) XSAVE_POINTER (vec, 0)
1029 #endif
1030
1031 /* Compute pixel size for vertical scroll bars */
1032 #define NS_SCROLL_BAR_WIDTH(f)                                          \
1033   (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                                   \
1034    ? rint (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0                        \
1035            ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)                          \
1036            : (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)))      \
1037    : 0)
1038
1039 /* Compute pixel size for horizontal scroll bars */
1040 #define NS_SCROLL_BAR_HEIGHT(f)                                         \
1041   (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f)                                 \
1042    ? rint (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0                       \
1043            ? FRAME_CONFIG_SCROLL_BAR_HEIGHT (f)                         \
1044            : (FRAME_SCROLL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)))      \
1045    : 0)
1046
1047 /* Difference btwn char-column-calculated and actual SB widths.
1048    This is only a concern for rendering when SB on left. */
1049 #define NS_SCROLL_BAR_ADJUST(w, f)                              \
1050   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) ?                 \
1051    (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)          \
1052     - NS_SCROLL_BAR_WIDTH (f)) : 0)
1053
1054 /* Difference btwn char-line-calculated and actual SB heights.
1055    This is only a concern for rendering when SB on top. */
1056 #define NS_SCROLL_BAR_ADJUST_HORIZONTALLY(w, f)         \
1057   (WINDOW_HAS_HORIZONTAL_SCROLL_BARS (w) ?              \
1058    (FRAME_SCROLL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)  \
1059     - NS_SCROLL_BAR_HEIGHT (f)) : 0)
1060
1061 /* XXX: fix for GNUstep inconsistent accounting for titlebar */
1062 #ifdef NS_IMPL_GNUSTEP
1063 #define NS_TOP_POS(f) ((f)->top_pos + 18)
1064 #else
1065 #define NS_TOP_POS(f) ((f)->top_pos)
1066 #endif
1067
1068 #define FRAME_NS_FONT_TABLE(f) (FRAME_DISPLAY_INFO (f)->font_table)
1069
1070 #define FRAME_FONTSET(f) ((f)->output_data.ns->fontset)
1071
1072 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.ns->baseline_offset)
1073 #define BLACK_PIX_DEFAULT(f) 0x000000
1074 #define WHITE_PIX_DEFAULT(f) 0xFFFFFF
1075
1076 /* First position where characters can be shown (instead of scrollbar, if
1077    it is on left. */
1078 #define FIRST_CHAR_POSITION(f)                          \
1079   (! (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)) ? 0   \
1080    : FRAME_SCROLL_BAR_COLS (f))
1081
1082 extern struct ns_display_info *ns_term_init (Lisp_Object display_name);
1083 extern void ns_term_shutdown (int sig);
1084
1085 /* constants for text rendering */
1086 #define NS_DUMPGLYPH_NORMAL             0
1087 #define NS_DUMPGLYPH_CURSOR             1
1088 #define NS_DUMPGLYPH_FOREGROUND         2
1089 #define NS_DUMPGLYPH_MOUSEFACE          3
1090
1091
1092
1093 /* In nsfont, called from fontset.c */
1094 extern void nsfont_make_fontset_for_font (Lisp_Object name,
1095                                          Lisp_Object font_object);
1096
1097 /* In nsfont, for debugging */
1098 struct glyph_string;
1099 void ns_dump_glyphstring (struct glyph_string *s) EXTERNALLY_VISIBLE;
1100
1101 /* Implemented in nsterm, published in or needed from nsfns. */
1102 extern Lisp_Object ns_list_fonts (struct frame *f, Lisp_Object pattern,
1103                                   int size, int maxnames);
1104 extern void ns_clear_frame (struct frame *f);
1105
1106 extern const char *ns_xlfd_to_fontname (const char *xlfd);
1107
1108 extern Lisp_Object ns_map_event_to_object (void);
1109 #ifdef __OBJC__
1110 extern Lisp_Object ns_string_from_pasteboard (id pb);
1111 extern void ns_string_to_pasteboard (id pb, Lisp_Object str);
1112 #endif
1113 extern Lisp_Object ns_get_local_selection (Lisp_Object selection_name,
1114                                            Lisp_Object target_type);
1115 extern void nxatoms_of_nsselect (void);
1116 extern void ns_set_doc_edited (void);
1117
1118 extern bool
1119 ns_defined_color (struct frame *f,
1120                   const char *name,
1121                   XColor *color_def, bool alloc,
1122                   bool makeIndex);
1123 extern void
1124 ns_query_color (void *col, XColor *color_def, int setPixel);
1125
1126 #ifdef __OBJC__
1127 extern int ns_lisp_to_color (Lisp_Object color, NSColor **col);
1128 extern NSColor *ns_lookup_indexed_color (unsigned long idx, struct frame *f);
1129 extern unsigned long ns_index_color (NSColor *color, struct frame *f);
1130 extern const char *ns_get_pending_menu_title (void);
1131 extern void ns_check_menu_open (NSMenu *menu);
1132 extern void ns_check_pending_open_menu (void);
1133 #endif
1134
1135 /* C access to ObjC functionality */
1136 extern void  ns_release_object (void *obj);
1137 extern void  ns_retain_object (void *obj);
1138 extern void *ns_alloc_autorelease_pool (void);
1139 extern void ns_release_autorelease_pool (void *);
1140 extern const char *ns_get_defaults_value (const char *key);
1141 extern void ns_init_locale (void);
1142
1143
1144 /* in nsmenu */
1145 extern void update_frame_tool_bar (struct frame *f);
1146 extern void free_frame_tool_bar (struct frame *f);
1147 extern Lisp_Object find_and_return_menu_selection (struct frame *f,
1148                                                    bool keymaps,
1149                                                    void *client_data);
1150 extern Lisp_Object ns_popup_dialog (struct frame *, Lisp_Object header,
1151                                     Lisp_Object contents);
1152
1153 #define NSAPP_DATA2_RUNASSCRIPT 10
1154 extern void ns_run_ascript (void);
1155
1156 #define NSAPP_DATA2_RUNFILEDIALOG 11
1157 extern void ns_run_file_dialog (void);
1158
1159 extern const char *ns_etc_directory (void);
1160 extern const char *ns_exec_path (void);
1161 extern const char *ns_load_path (void);
1162 extern void syms_of_nsterm (void);
1163 extern void syms_of_nsfns (void);
1164 extern void syms_of_nsmenu (void);
1165 extern void syms_of_nsselect (void);
1166
1167 /* From nsimage.m, needed in image.c */
1168 struct image;
1169 extern void *ns_image_from_XBM (char *bits, int width, int height,
1170                                 unsigned long fg, unsigned long bg);
1171 extern void *ns_image_for_XPM (int width, int height, int depth);
1172 extern void *ns_image_from_file (Lisp_Object file);
1173 extern bool ns_load_image (struct frame *f, struct image *img,
1174                            Lisp_Object spec_file, Lisp_Object spec_data);
1175 extern int ns_image_width (void *img);
1176 extern int ns_image_height (void *img);
1177 extern unsigned long ns_get_pixel (void *img, int x, int y);
1178 extern void ns_put_pixel (void *img, int x, int y, unsigned long argb);
1179 extern void ns_set_alpha (void *img, int x, int y, unsigned char a);
1180
1181 extern int x_display_pixel_height (struct ns_display_info *);
1182 extern int x_display_pixel_width (struct ns_display_info *);
1183
1184 /* This in nsterm.m */
1185 extern float ns_antialias_threshold;
1186 extern void x_destroy_window (struct frame *f);
1187 extern int ns_select (int nfds, fd_set *readfds, fd_set *writefds,
1188                       fd_set *exceptfds, struct timespec const *timeout,
1189                       sigset_t const *sigmask);
1190 extern unsigned long ns_get_rgb_color (struct frame *f,
1191                                        float r, float g, float b, float a);
1192
1193 struct input_event;
1194 extern void ns_init_events (struct input_event *);
1195 extern void ns_finish_events (void);
1196
1197 #ifdef __OBJC__
1198 /* Needed in nsfns.m.  */
1199 extern void
1200 ns_set_represented_filename (NSString* fstr, struct frame *f);
1201
1202 #endif
1203
1204 #ifdef NS_IMPL_GNUSTEP
1205 extern char gnustep_base_version[];  /* version tracking */
1206 #endif
1207
1208 #define MINWIDTH 10
1209 #define MINHEIGHT 10
1210
1211 /* Screen max coordinate
1212  Using larger coordinates causes movewindow/placewindow to abort */
1213 #define SCREENMAX 16000
1214
1215 #define NS_SCROLL_BAR_WIDTH_DEFAULT     [EmacsScroller scrollerWidth]
1216 #define NS_SCROLL_BAR_HEIGHT_DEFAULT    [EmacsScroller scrollerHeight]
1217 /* This is to match emacs on other platforms, ugly though it is. */
1218 #define NS_SELECTION_BG_COLOR_DEFAULT   @"LightGoldenrod2";
1219 #define NS_SELECTION_FG_COLOR_DEFAULT   @"Black";
1220 #define RESIZE_HANDLE_SIZE 12
1221
1222 /* Little utility macros */
1223 #define IN_BOUND(min, x, max) (((x) < (min)) \
1224                                 ? (min) : (((x)>(max)) ? (max) : (x)))
1225 #define SCREENMAXBOUND(x) (IN_BOUND (-SCREENMAX, x, SCREENMAX))
1226
1227 /* macOS 10.12 deprecates a bunch of constants. */
1228 #if !defined (NS_IMPL_COCOA) || \
1229   MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_12
1230 #define NSEventModifierFlagCommand         NSCommandKeyMask
1231 #define NSEventModifierFlagControl         NSControlKeyMask
1232 #define NSEventModifierFlagHelp            NSHelpKeyMask
1233 #define NSEventModifierFlagNumericPad      NSNumericPadKeyMask
1234 #define NSEventModifierFlagOption          NSAlternateKeyMask
1235 #define NSEventModifierFlagShift           NSShiftKeyMask
1236 #define NSCompositingOperationSourceOver   NSCompositeSourceOver
1237 #define NSEventMaskApplicationDefined      NSApplicationDefinedMask
1238 #define NSEventTypeApplicationDefined      NSApplicationDefined
1239 #define NSEventTypeCursorUpdate            NSCursorUpdate
1240 #define NSEventTypeMouseMoved              NSMouseMoved
1241 #define NSEventTypeLeftMouseDown           NSLeftMouseDown
1242 #define NSEventTypeRightMouseDown          NSRightMouseDown
1243 #define NSEventTypeOtherMouseDown          NSOtherMouseDown
1244 #define NSEventTypeLeftMouseUp             NSLeftMouseUp
1245 #define NSEventTypeRightMouseUp            NSRightMouseUp
1246 #define NSEventTypeOtherMouseUp            NSOtherMouseUp
1247 #define NSEventTypeLeftMouseDragged        NSLeftMouseDragged
1248 #define NSEventTypeRightMouseDragged       NSRightMouseDragged
1249 #define NSEventTypeOtherMouseDragged       NSOtherMouseDragged
1250 #define NSEventTypeScrollWheel             NSScrollWheel
1251 #define NSEventTypeKeyDown                 NSKeyDown
1252 #define NSEventTypeKeyUp                   NSKeyUp
1253 #define NSEventTypeFlagsChanged            NSFlagsChanged
1254 #define NSEventMaskAny                     NSAnyEventMask
1255 #define NSWindowStyleMaskBorderless        NSBorderlessWindowMask
1256 #define NSWindowStyleMaskClosable          NSClosableWindowMask
1257 #define NSWindowStyleMaskFullScreen        NSFullScreenWindowMask
1258 #define NSWindowStyleMaskMiniaturizable    NSMiniaturizableWindowMask
1259 #define NSWindowStyleMaskResizable         NSResizableWindowMask
1260 #define NSWindowStyleMaskTitled            NSTitledWindowMask
1261 #define NSAlertStyleCritical               NSCriticalAlertStyle
1262 #define NSControlSizeRegular               NSRegularControlSize
1263 #endif
1264
1265 #endif  /* HAVE_NS */