src/nsterm.h

   1 /* Definitions and headers for communication with NeXT/Open/GNUstep API.
   2    Copyright (C) 1989, 1993, 2005, 2008-2016 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)fd_handler: (id)unused;
 396 - (void)timeout_handler: (NSTimer *)timedEntry;
 397 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg;
 398 #ifdef NS_IMPL_GNUSTEP
 399 - (void)sendFromMainThread:(id)unused;
 400 #endif
 401 @end
 402
 403 #ifdef NS_IMPL_GNUSTEP
 404 /* Dummy class to get rid of startup warnings.  */
 405 @interface EmacsDocument : NSDocument
 406 {
 407 }
 408 @end
 409 #endif
 410
 411 /* ==========================================================================
 412
 413    The main Emacs view
 414
 415    ========================================================================== */
 416
 417 @class EmacsToolbar;
 418
 419 #ifdef NS_IMPL_COCOA
 420 @interface EmacsView : NSView <NSTextInput, NSWindowDelegate>
 421 #else
 422 @interface EmacsView : NSView <NSTextInput>
 423 #endif
 424    {
 425 #ifdef NS_IMPL_COCOA
 426    char *old_title;
 427    BOOL maximizing_resize;
 428 #endif
 429    BOOL windowClosing;
 430    NSString *workingText;
 431    BOOL processingCompose;
 432    int fs_state, fs_before_fs, next_maximized;
 433    int tibar_height, tobar_height, bwidth;
 434    int maximized_width, maximized_height;
 435    NSWindow *nonfs_window;
 436    BOOL fs_is_native;
 437 @public
 438    struct frame *emacsframe;
 439    int rows, cols;
 440    int scrollbarsNeedingUpdate;
 441    EmacsToolbar *toolbar;
 442    NSRect ns_userRect;
 443    BOOL wait_for_tool_bar;
 444    }
 445
 446 /* AppKit-side interface */
 447 - menuDown: (id)sender;
 448 - toolbarClicked: (id)item;
 449 - toggleToolbar: (id)sender;
 450 - (void)keyDown: (NSEvent *)theEvent;
 451 - (void)mouseDown: (NSEvent *)theEvent;
 452 - (void)mouseUp: (NSEvent *)theEvent;
 453 - setMiniwindowImage: (BOOL)setMini;
 454
 455 /* Emacs-side interface */
 456 - initFrameFromEmacs: (struct frame *) f;
 457 - (void) setRows: (int) r andColumns: (int) c;
 458 - (void) setWindowClosing: (BOOL)closing;
 459 - (EmacsToolbar *) toolbar;
 460 - (void) deleteWorkingText;
 461 - (void) updateFrameSize: (BOOL) delay;
 462 - (void) handleFS;
 463 - (void) setFSValue: (int)value;
 464 - (void) toggleFullScreen: (id) sender;
 465 - (BOOL) fsIsNative;
 466 - (BOOL) isFullscreen;
 467 #ifdef HAVE_NATIVE_FS
 468 - (void) updateCollectionBehavior;
 469 #endif
 470
 471 #ifdef NS_IMPL_GNUSTEP
 472 - (void)windowDidMove: (id)sender;
 473 #endif
 474 - (int)fullscreenState;
 475
 476 /* Non-notification versions of NSView methods. Used for direct calls. */
 477 - (void)windowWillEnterFullScreen;
 478 - (void)windowDidEnterFullScreen;
 479 - (void)windowWillExitFullScreen;
 480 - (void)windowDidExitFullScreen;
 481 - (void)windowDidBecomeKey;
 482 @end
 483
 484
 485 /* Small utility used for processing resize events under Cocoa. */
 486 @interface EmacsWindow : NSWindow
 487 {
 488   NSPoint grabOffset;
 489 }
 490 @end
 491
 492
 493 /* Fullscreen version of the above.  */
 494 @interface EmacsFSWindow : EmacsWindow
 495 {
 496 }
 497 @end
 498
 499 /* ==========================================================================
 500
 501    The main menu implementation
 502
 503    ========================================================================== */
 504
 505 #ifdef NS_IMPL_COCOA
 506 @interface EmacsMenu : NSMenu  <NSMenuDelegate>
 507 #else
 508 @interface EmacsMenu : NSMenu
 509 #endif
 510 {
 511   struct frame *frame;
 512   unsigned long keyEquivModMask;
 513 }
 514
 515 - initWithTitle: (NSString *)title frame: (struct frame *)f;
 516 - (void)setFrame: (struct frame *)f;
 517 - (void)menuNeedsUpdate: (NSMenu *)menu; /* (delegate method) */
 518 - (NSString *)parseKeyEquiv: (const char *)key;
 519 - (NSMenuItem *)addItemWithWidgetValue: (void *)wvptr;
 520 - (void)fillWithWidgetValue: (void *)wvptr;
 521 - (void)fillWithWidgetValue: (void *)wvptr frame: (struct frame *)f;
 522 - (EmacsMenu *)addSubmenuWithTitle: (const char *)title forFrame: (struct frame *)f;
 523 - (void) clear;
 524 - (Lisp_Object)runMenuAt: (NSPoint)p forFrame: (struct frame *)f
 525                  keymaps: (bool)keymaps;
 526 @end
 527
 528
 529 /* ==========================================================================
 530
 531    Toolbar
 532
 533    ========================================================================== */
 534
 535 @class EmacsImage;
 536
 537 #ifdef NS_IMPL_COCOA
 538 @interface EmacsToolbar : NSToolbar <NSToolbarDelegate>
 539 #else
 540 @interface EmacsToolbar : NSToolbar
 541 #endif
 542    {
 543      EmacsView *emacsView;
 544      NSMutableDictionary *identifierToItem;
 545      NSMutableArray *activeIdentifiers;
 546      NSArray *prevIdentifiers;
 547      unsigned long enablement, prevEnablement;
 548    }
 549 - initForView: (EmacsView *)view withIdentifier: (NSString *)identifier;
 550 - (void) clearActive;
 551 - (void) clearAll;
 552 - (BOOL) changed;
 553 - (void) addDisplayItemWithImage: (EmacsImage *)img
 554                              idx: (int)idx
 555                              tag: (int)tag
 556                         helpText: (const char *)help
 557                          enabled: (BOOL)enabled;
 558
 559 /* delegate methods */
 560 - (NSToolbarItem *)toolbar: (NSToolbar *)toolbar
 561      itemForItemIdentifier: (NSString *)itemIdentifier
 562  willBeInsertedIntoToolbar: (BOOL)flag;
 563 - (NSArray *)toolbarDefaultItemIdentifiers: (NSToolbar *)toolbar;
 564 - (NSArray *)toolbarAllowedItemIdentifiers: (NSToolbar *)toolbar;
 565 @end
 566
 567
 568 /* ==========================================================================
 569
 570    Message / question windows
 571
 572    ========================================================================== */
 573
 574 @interface EmacsDialogPanel : NSPanel
 575    {
 576    NSTextField *command;
 577    NSTextField *title;
 578    NSMatrix *matrix;
 579    int rows, cols;
 580    BOOL timer_fired, window_closed;
 581    Lisp_Object dialog_return;
 582    Lisp_Object *button_values;
 583    }
 584 - initFromContents: (Lisp_Object)menu isQuestion: (BOOL)isQ;
 585 - (void)process_dialog: (Lisp_Object)list;
 586 - (void)addButton: (char *)str value: (int)tag row: (int)row;
 587 - (void)addString: (char *)str row: (int)row;
 588 - (void)addSplit;
 589 - (Lisp_Object)runDialogAt: (NSPoint)p;
 590 - (void)timeout_handler: (NSTimer *)timedEntry;
 591 @end
 592
 593 #ifdef NS_IMPL_COCOA
 594 @interface EmacsTooltip : NSObject <NSWindowDelegate>
 595 #else
 596 @interface EmacsTooltip : NSObject
 597 #endif
 598   {
 599     NSWindow *win;
 600     NSTextField *textField;
 601     NSTimer *timer;
 602   }
 603 - init;
 604 - (void) setText: (char *)text;
 605 - (void) showAtX: (int)x Y: (int)y for: (int)seconds;
 606 - (void) hide;
 607 - (BOOL) isActive;
 608 - (NSRect) frame;
 609 @end
 610
 611
 612 /* ==========================================================================
 613
 614    File open/save panels
 615    This and next override methods to handle keyboard input in panels.
 616
 617    ========================================================================== */
 618
 619 @interface EmacsSavePanel : NSSavePanel
 620 {
 621 }
 622 @end
 623 @interface EmacsOpenPanel : NSOpenPanel
 624 {
 625 }
 626 @end
 627
 628 @interface EmacsFileDelegate : NSObject
 629 {
 630 }
 631 - (BOOL)panel: (id)sender isValidFilename: (NSString *)filename;
 632 - (BOOL)panel: (id)sender shouldShowFilename: (NSString *)filename;
 633 - (NSString *)panel: (id)sender userEnteredFilename: (NSString *)filename
 634           confirmed: (BOOL)okFlag;
 635 @end
 636
 637
 638 /* ==========================================================================
 639
 640    Images and stippling
 641
 642    ========================================================================== */
 643
 644 @interface EmacsImage : NSImage
 645 {
 646   NSBitmapImageRep *bmRep; /* used for accessing pixel data */
 647   unsigned char *pixmapData[5]; /* shortcut to access pixel data */
 648   NSColor *stippleMask;
 649   unsigned long xbm_fg;
 650 }
 651 + allocInitFromFile: (Lisp_Object)file;
 652 - (void)dealloc;
 653 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
 654                   fg: (unsigned long)fg bg: (unsigned long)bg;
 655 - setXBMColor: (NSColor *)color;
 656 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height;
 657 - (void)setPixmapData;
 658 - (unsigned long)getPixelAtX: (int)x Y: (int)y;
 659 - (void)setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
 660                green: (unsigned char)g blue: (unsigned char)b
 661               alpha:(unsigned char)a;
 662 - (void)setAlphaAtX: (int)x Y: (int)y to: (unsigned char)a;
 663 - (NSColor *)stippleMask;
 664 @end
 665
 666
 667 /* ==========================================================================
 668
 669    Scrollbars
 670
 671    ========================================================================== */
 672
 673 @interface EmacsScroller : NSScroller
 674   {
 675    struct window *window;
 676    struct frame *frame;
 677    NSResponder *prevResponder;
 678
 679    /* offset to the bottom of knob of last mouse down */
 680    CGFloat last_mouse_offset;
 681    float min_portion;
 682    int pixel_length;
 683    enum scroll_bar_part last_hit_part;
 684
 685    BOOL condemned;
 686
 687    BOOL horizontal;
 688
 689    /* optimize against excessive positioning calls generated by emacs */
 690    int em_position;
 691    int em_portion;
 692    int em_whole;
 693    }
 694
 695 - initFrame: (NSRect )r window: (Lisp_Object)win;
 696 - (void)setFrame: (NSRect)r;
 697
 698 - setPosition: (int) position portion: (int) portion whole: (int) whole;
 699 - (int) checkSamePosition: (int)position portion: (int)portion
 700                     whole: (int)whole;
 701 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e;
 702 - repeatScroll: (NSTimer *)sender;
 703 - condemn;
 704 - reprieve;
 705 - (bool)judge;
 706 + (CGFloat)scrollerWidth;
 707 @end
 708
 709
 710 /* ==========================================================================
 711
 712    Rendering
 713
 714    ========================================================================== */
 715
 716 #ifdef NS_IMPL_COCOA
 717 /* rendering util */
 718 @interface EmacsGlyphStorage : NSObject <NSGlyphStorage>
 719 {
 720 @public
 721   NSAttributedString *attrStr;
 722   NSMutableDictionary *dict;
 723   CGGlyph *cglyphs;
 724   unsigned long maxChar, maxGlyph;
 725   long i, len;
 726 }
 727 - initWithCapacity: (unsigned long) c;
 728 - (void) setString: (NSString *)str font: (NSFont *)font;
 729 @end
 730 #endif  /* NS_IMPL_COCOA */
 731
 732 extern NSArray *ns_send_types, *ns_return_types;
 733 extern NSString *ns_app_name;
 734 extern EmacsMenu *mainMenu, *svcsMenu, *dockMenu;
 735
 736 /* Apple removed the declaration, but kept the implementation */
 737 #if defined (NS_IMPL_COCOA)
 738 @interface NSApplication (EmacsApp)
 739 - (void)setAppleMenu: (NSMenu *)menu;
 740 @end
 741 #endif
 742
 743 #endif  /* __OBJC__ */
 744
 745
 746
 747 /* ==========================================================================
 748
 749    Non-OO stuff
 750
 751    ========================================================================== */
 752
 753 /* Special keycodes that we pass down the event chain */
 754 #define KEY_NS_POWER_OFF               ((1<<28)|(0<<16)|1)
 755 #define KEY_NS_OPEN_FILE               ((1<<28)|(0<<16)|2)
 756 #define KEY_NS_OPEN_TEMP_FILE          ((1<<28)|(0<<16)|3)
 757 #define KEY_NS_CHANGE_FONT             ((1<<28)|(0<<16)|7)
 758 #define KEY_NS_OPEN_FILE_LINE          ((1<<28)|(0<<16)|8)
 759 #define KEY_NS_PUT_WORKING_TEXT        ((1<<28)|(0<<16)|9)
 760 #define KEY_NS_UNPUT_WORKING_TEXT      ((1<<28)|(0<<16)|10)
 761 #define KEY_NS_SPI_SERVICE_CALL        ((1<<28)|(0<<16)|11)
 762 #define KEY_NS_NEW_FRAME               ((1<<28)|(0<<16)|12)
 763 #define KEY_NS_TOGGLE_TOOLBAR          ((1<<28)|(0<<16)|13)
 764 #define KEY_NS_SHOW_PREFS              ((1<<28)|(0<<16)|14)
 765
 766 /* could use list to store these, but rest of emacs has a big infrastructure
 767    for managing a table of bitmap "records" */
 768 struct ns_bitmap_record
 769 {
 770 #ifdef __OBJC__
 771   EmacsImage *img;
 772 #else
 773   void *img;
 774 #endif
 775   char *file;
 776   int refcount;
 777   int height, width, depth;
 778 };
 779
 780 /* this to map between emacs color indices and NSColor objects */
 781 struct ns_color_table
 782 {
 783   ptrdiff_t size;
 784   ptrdiff_t avail;
 785 #ifdef __OBJC__
 786   NSColor **colors;
 787   NSMutableSet *empty_indices;
 788 #else
 789   void **items;
 790   void *availIndices;
 791 #endif
 792 };
 793 #define NS_COLOR_CAPACITY 256
 794
 795 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
 796 #define ARGB_TO_ULONG(a, r, g, b) (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
 797
 798 #define ALPHA_FROM_ULONG(color) ((color) >> 24)
 799 #define RED_FROM_ULONG(color) (((color) >> 16) & 0xff)
 800 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
 801 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
 802
 803 /* Do not change `* 0x101' in the following lines to `<< 8'.  If
 804    changed, image masks in 1-bit depth will not work. */
 805 #define RED16_FROM_ULONG(color) (RED_FROM_ULONG(color) * 0x101)
 806 #define GREEN16_FROM_ULONG(color) (GREEN_FROM_ULONG(color) * 0x101)
 807 #define BLUE16_FROM_ULONG(color) (BLUE_FROM_ULONG(color) * 0x101)
 808
 809 /* this extends font backend font */
 810 struct nsfont_info
 811 {
 812   struct font font;
 813
 814   char *name;  /* PostScript name, uniquely identifies on NS systems */
 815
 816   /* The following metrics are stored as float rather than int. */
 817
 818   float width;  /* Maximum advance for the font.  */
 819   float height;
 820   float underpos;
 821   float underwidth;
 822   float size;
 823 #ifdef __OBJC__
 824   NSFont *nsfont;
 825 #if defined (NS_IMPL_COCOA)
 826   CGFontRef cgfont;
 827 #else /* GNUstep */
 828   void *cgfont;
 829 #endif
 830 #else /* ! OBJC */
 831   void *nsfont;
 832   void *cgfont;
 833 #endif
 834   char bold, ital;  /* convenience flags */
 835   char synthItal;
 836   XCharStruct max_bounds;
 837   /* we compute glyph codes and metrics on-demand in blocks of 256 indexed
 838      by hibyte, lobyte */
 839   unsigned short **glyphs; /* map Unicode index to glyph */
 840   struct font_metrics **metrics;
 841 };
 842
 843
 844 /* init'd in ns_initialize_display_info () */
 845 struct ns_display_info
 846 {
 847   /* Chain of all ns_display_info structures.  */
 848   struct ns_display_info *next;
 849
 850   /* The generic display parameters corresponding to this NS display. */
 851   struct terminal *terminal;
 852
 853   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).  */
 854   Lisp_Object name_list_element;
 855
 856   /* The number of fonts loaded. */
 857   int n_fonts;
 858
 859   /* Minimum width over all characters in all fonts in font_table.  */
 860   int smallest_char_width;
 861
 862   /* Minimum font height over all fonts in font_table.  */
 863   int smallest_font_height;
 864
 865   struct ns_bitmap_record *bitmaps;
 866   ptrdiff_t bitmaps_size;
 867   ptrdiff_t bitmaps_last;
 868
 869   struct ns_color_table *color_table;
 870
 871   /* DPI resolution of this screen */
 872   double resx, resy;
 873
 874   /* Mask of things that cause the mouse to be grabbed */
 875   int grabbed;
 876
 877   int n_planes;
 878
 879   int color_p;
 880
 881   Window root_window;
 882
 883   /* Xism */
 884   XrmDatabase xrdb;
 885
 886   /* The cursor to use for vertical scroll bars. */
 887   Cursor vertical_scroll_bar_cursor;
 888
 889   /* The cursor to use for horizontal scroll bars. */
 890   Cursor horizontal_scroll_bar_cursor;
 891
 892   /* Information about the range of text currently shown in
 893      mouse-face.  */
 894   Mouse_HLInfo mouse_highlight;
 895
 896   struct frame *x_highlight_frame;
 897   struct frame *x_focus_frame;
 898
 899   /* The frame where the mouse was last time we reported a mouse event.  */
 900   struct frame *last_mouse_frame;
 901
 902   /* The frame where the mouse was last time we reported a mouse motion.  */
 903   struct frame *last_mouse_motion_frame;
 904
 905   /* Position where the mouse was last time we reported a motion.
 906      This is a position on last_mouse_motion_frame.  */
 907   int last_mouse_motion_x;
 908   int last_mouse_motion_y;
 909
 910   /* Where the mouse was last time we reported a mouse position.  */
 911   NSRect last_mouse_glyph;
 912
 913   /* Time of last mouse movement.  */
 914   Time last_mouse_movement_time;
 915
 916   /* The scroll bar in which the last motion event occurred.  */
 917 #ifdef __OBJC__
 918   EmacsScroller *last_mouse_scroll_bar;
 919 #else
 920   void *last_mouse_scroll_bar;
 921 #endif
 922 };
 923
 924 /* This is a chain of structures for all the NS displays currently in use.  */
 925 extern struct ns_display_info *x_display_list;
 926
 927 extern struct ns_display_info *ns_display_info_for_name (Lisp_Object name);
 928
 929 struct ns_output
 930 {
 931 #ifdef __OBJC__
 932   EmacsView *view;
 933   id miniimage;
 934   NSColor *cursor_color;
 935   NSColor *foreground_color;
 936   NSColor *background_color;
 937   EmacsToolbar *toolbar;
 938 #else
 939   void *view;
 940   void *miniimage;
 941   void *cursor_color;
 942   void *foreground_color;
 943   void *background_color;
 944   void *toolbar;
 945 #endif
 946
 947   /* NSCursors init'ed in initFrameFromEmacs */
 948   Cursor text_cursor;
 949   Cursor nontext_cursor;
 950   Cursor modeline_cursor;
 951   Cursor hand_cursor;
 952   Cursor hourglass_cursor;
 953   Cursor horizontal_drag_cursor;
 954   Cursor vertical_drag_cursor;
 955
 956   /* NS-specific */
 957   Cursor current_pointer;
 958
 959   /* lord knows why Emacs needs to know about our Window ids.. */
 960   Window window_desc, parent_desc;
 961   char explicit_parent;
 962
 963   struct font *font;
 964   int baseline_offset;
 965
 966   /* If a fontset is specified for this frame instead of font, this
 967      value contains an ID of the fontset, else -1.  */
 968   int fontset; /* only used with font_backend */
 969
 970   int icon_top;
 971   int icon_left;
 972
 973   /* The size of the extra width currently allotted for vertical
 974      scroll bars, in pixels.  */
 975   int vertical_scroll_bar_extra;
 976
 977   /* The height of the titlebar decoration (included in NSWindow's frame). */
 978   int titlebar_height;
 979
 980   /* The height of the toolbar if displayed, else 0. */
 981   int toolbar_height;
 982
 983   /* This is the Emacs structure for the NS display this frame is on.  */
 984   struct ns_display_info *display_info;
 985
 986   /* Non-zero if we are zooming (maximizing) the frame.  */
 987   int zooming;
 988
 989   /* Non-zero if we are doing an animation, e.g. toggling the tool bar. */
 990   int in_animation;
 991 };
 992
 993 /* this dummy decl needed to support TTYs */
 994 struct x_output
 995 {
 996   int unused;
 997 };
 998
 999
1000 /* This gives the ns_display_info structure for the display F is on.  */
1001 #define FRAME_DISPLAY_INFO(f) ((f)->output_data.ns->display_info)
1002 #define FRAME_X_OUTPUT(f) ((f)->output_data.ns)
1003 #define FRAME_NS_WINDOW(f) ((f)->output_data.ns->window_desc)
1004 #define FRAME_X_WINDOW(f) ((f)->output_data.ns->window_desc)
1005
1006 /* This is the `Display *' which frame F is on.  */
1007 #define FRAME_NS_DISPLAY(f) (0)
1008 #define FRAME_X_DISPLAY(f) (0)
1009 #define FRAME_X_SCREEN(f) (0)
1010 #define FRAME_X_VISUAL(f) FRAME_DISPLAY_INFO(f)->visual
1011
1012 #define FRAME_FOREGROUND_COLOR(f) ((f)->output_data.ns->foreground_color)
1013 #define FRAME_BACKGROUND_COLOR(f) ((f)->output_data.ns->background_color)
1014
1015 #define NS_FACE_FOREGROUND(f) ((f)->foreground)
1016 #define NS_FACE_BACKGROUND(f) ((f)->background)
1017 #define FRAME_NS_TITLEBAR_HEIGHT(f) ((f)->output_data.ns->titlebar_height)
1018 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.ns->toolbar_height)
1019
1020 #define FRAME_DEFAULT_FACE(f) FACE_FROM_ID_OR_NULL (f, DEFAULT_FACE_ID)
1021
1022 #define FRAME_NS_VIEW(f) ((f)->output_data.ns->view)
1023 #define FRAME_CURSOR_COLOR(f) ((f)->output_data.ns->cursor_color)
1024 #define FRAME_POINTER_TYPE(f) ((f)->output_data.ns->current_pointer)
1025
1026 #define FRAME_FONT(f) ((f)->output_data.ns->font)
1027
1028 #ifdef __OBJC__
1029 #define XNS_SCROLL_BAR(vec) ((id) XSAVE_POINTER (vec, 0))
1030 #else
1031 #define XNS_SCROLL_BAR(vec) XSAVE_POINTER (vec, 0)
1032 #endif
1033
1034 /* Compute pixel size for vertical scroll bars */
1035 #define NS_SCROLL_BAR_WIDTH(f)                                          \
1036   (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                                   \
1037    ? rint (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0                        \
1038            ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)                          \
1039            : (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)))      \
1040    : 0)
1041
1042 /* Compute pixel size for horizontal scroll bars */
1043 #define NS_SCROLL_BAR_HEIGHT(f)                                         \
1044   (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f)                                 \
1045    ? rint (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0                       \
1046            ? FRAME_CONFIG_SCROLL_BAR_HEIGHT (f)                         \
1047            : (FRAME_SCROLL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)))      \
1048    : 0)
1049
1050 /* Difference btwn char-column-calculated and actual SB widths.
1051    This is only a concern for rendering when SB on left. */
1052 #define NS_SCROLL_BAR_ADJUST(w, f)                              \
1053   (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) ?                 \
1054    (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)          \
1055     - NS_SCROLL_BAR_WIDTH (f)) : 0)
1056
1057 /* Difference btwn char-line-calculated and actual SB heights.
1058    This is only a concern for rendering when SB on top. */
1059 #define NS_SCROLL_BAR_ADJUST_HORIZONTALLY(w, f)         \
1060   (WINDOW_HAS_HORIZONTAL_SCROLL_BARS (w) ?              \
1061    (FRAME_SCROLL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)  \
1062     - NS_SCROLL_BAR_HEIGHT (f)) : 0)
1063
1064 /* XXX: fix for GNUstep inconsistent accounting for titlebar */
1065 #ifdef NS_IMPL_GNUSTEP
1066 #define NS_TOP_POS(f) ((f)->top_pos + 18)
1067 #else
1068 #define NS_TOP_POS(f) ((f)->top_pos)
1069 #endif
1070
1071 #define FRAME_NS_FONT_TABLE(f) (FRAME_DISPLAY_INFO (f)->font_table)
1072
1073 #define FRAME_FONTSET(f) ((f)->output_data.ns->fontset)
1074
1075 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.ns->baseline_offset)
1076 #define BLACK_PIX_DEFAULT(f) 0x000000
1077 #define WHITE_PIX_DEFAULT(f) 0xFFFFFF
1078
1079 /* First position where characters can be shown (instead of scrollbar, if
1080    it is on left. */
1081 #define FIRST_CHAR_POSITION(f)                          \
1082   (! (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)) ? 0   \
1083    : FRAME_SCROLL_BAR_COLS (f))
1084
1085 extern struct ns_display_info *ns_term_init (Lisp_Object display_name);
1086 extern void ns_term_shutdown (int sig);
1087
1088 /* constants for text rendering */
1089 #define NS_DUMPGLYPH_NORMAL             0
1090 #define NS_DUMPGLYPH_CURSOR             1
1091 #define NS_DUMPGLYPH_FOREGROUND         2
1092 #define NS_DUMPGLYPH_MOUSEFACE          3
1093
1094
1095
1096 /* In nsfont, called from fontset.c */
1097 extern void nsfont_make_fontset_for_font (Lisp_Object name,
1098                                          Lisp_Object font_object);
1099
1100 /* In nsfont, for debugging */
1101 struct glyph_string;
1102 void ns_dump_glyphstring (struct glyph_string *s);
1103
1104 /* Implemented in nsterm, published in or needed from nsfns. */
1105 extern Lisp_Object ns_list_fonts (struct frame *f, Lisp_Object pattern,
1106                                   int size, int maxnames);
1107 extern void ns_clear_frame (struct frame *f);
1108
1109 extern const char *ns_xlfd_to_fontname (const char *xlfd);
1110
1111 extern Lisp_Object ns_map_event_to_object (void);
1112 #ifdef __OBJC__
1113 extern Lisp_Object ns_string_from_pasteboard (id pb);
1114 extern void ns_string_to_pasteboard (id pb, Lisp_Object str);
1115 #endif
1116 extern Lisp_Object ns_get_local_selection (Lisp_Object selection_name,
1117                                            Lisp_Object target_type);
1118 extern void nxatoms_of_nsselect (void);
1119 extern int ns_lisp_to_cursor_type (Lisp_Object arg);
1120 extern Lisp_Object ns_cursor_type_to_lisp (int arg);
1121 extern void ns_set_name_as_filename (struct frame *f);
1122 extern void ns_set_doc_edited (void);
1123
1124 extern bool
1125 ns_defined_color (struct frame *f,
1126                   const char *name,
1127                   XColor *color_def, bool alloc,
1128                   bool makeIndex);
1129 extern void
1130 ns_query_color (void *col, XColor *color_def, int setPixel);
1131
1132 #ifdef __OBJC__
1133 extern Lisp_Object ns_color_to_lisp (NSColor *col);
1134 extern int ns_lisp_to_color (Lisp_Object color, NSColor **col);
1135 extern NSColor *ns_lookup_indexed_color (unsigned long idx, struct frame *f);
1136 extern unsigned long ns_index_color (NSColor *color, struct frame *f);
1137 extern void ns_free_indexed_color (unsigned long idx, struct frame *f);
1138 extern const char *ns_get_pending_menu_title (void);
1139 extern void ns_check_menu_open (NSMenu *menu);
1140 extern void ns_check_pending_open_menu (void);
1141 #endif
1142
1143 /* C access to ObjC functionality */
1144 extern void  ns_release_object (void *obj);
1145 extern void  ns_retain_object (void *obj);
1146 extern void *ns_alloc_autorelease_pool (void);
1147 extern void ns_release_autorelease_pool (void *);
1148 extern const char *ns_get_defaults_value (const char *key);
1149 extern void ns_init_locale (void);
1150
1151
1152 /* in nsmenu */
1153 extern void update_frame_tool_bar (struct frame *f);
1154 extern void free_frame_tool_bar (struct frame *f);
1155 extern void find_and_call_menu_selection (struct frame *f,
1156     int menu_bar_items_used, Lisp_Object vector, void *client_data);
1157 extern Lisp_Object find_and_return_menu_selection (struct frame *f,
1158                                                    bool keymaps,
1159                                                    void *client_data);
1160 extern Lisp_Object ns_popup_dialog (struct frame *, Lisp_Object header,
1161                                     Lisp_Object contents);
1162
1163 #define NSAPP_DATA2_RUNASSCRIPT 10
1164 extern void ns_run_ascript (void);
1165
1166 #define NSAPP_DATA2_RUNFILEDIALOG 11
1167 extern void ns_run_file_dialog (void);
1168
1169 extern const char *ns_etc_directory (void);
1170 extern const char *ns_exec_path (void);
1171 extern const char *ns_load_path (void);
1172 extern void syms_of_nsterm (void);
1173 extern void syms_of_nsfns (void);
1174 extern void syms_of_nsmenu (void);
1175 extern void syms_of_nsselect (void);
1176
1177 /* From nsimage.m, needed in image.c */
1178 struct image;
1179 extern void *ns_image_from_XBM (unsigned char *bits, int width, int height,
1180                                 unsigned long fg, unsigned long bg);
1181 extern void *ns_image_for_XPM (int width, int height, int depth);
1182 extern void *ns_image_from_file (Lisp_Object file);
1183 extern bool ns_load_image (struct frame *f, struct image *img,
1184                            Lisp_Object spec_file, Lisp_Object spec_data);
1185 extern int ns_image_width (void *img);
1186 extern int ns_image_height (void *img);
1187 extern unsigned long ns_get_pixel (void *img, int x, int y);
1188 extern void ns_put_pixel (void *img, int x, int y, unsigned long argb);
1189 extern void ns_set_alpha (void *img, int x, int y, unsigned char a);
1190
1191 extern int x_display_pixel_height (struct ns_display_info *);
1192 extern int x_display_pixel_width (struct ns_display_info *);
1193
1194 /* This in nsterm.m */
1195 extern void x_destroy_window (struct frame *f);
1196 extern int ns_select (int nfds, fd_set *readfds, fd_set *writefds,
1197                       fd_set *exceptfds, struct timespec const *timeout,
1198                       sigset_t const *sigmask);
1199 extern unsigned long ns_get_rgb_color (struct frame *f,
1200                                        float r, float g, float b, float a);
1201
1202 extern void ns_init_events ();
1203 extern void ns_finish_events ();
1204
1205 #ifdef __OBJC__
1206 /* From nsterm.m, needed in nsfont.m. */
1207 extern void
1208 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
1209                          NSColor *defaultCol, CGFloat width, CGFloat x);
1210 /* Needed in nsfns.m.  */
1211 extern void
1212 ns_set_represented_filename (NSString* fstr, struct frame *f);
1213
1214 #endif
1215
1216 #ifdef NS_IMPL_GNUSTEP
1217 extern char gnustep_base_version[];  /* version tracking */
1218 #endif
1219
1220 #define MINWIDTH 10
1221 #define MINHEIGHT 10
1222
1223 /* Screen max coordinate
1224  Using larger coordinates causes movewindow/placewindow to abort */
1225 #define SCREENMAX 16000
1226
1227 #define NS_SCROLL_BAR_WIDTH_DEFAULT     [EmacsScroller scrollerWidth]
1228 #define NS_SCROLL_BAR_HEIGHT_DEFAULT    [EmacsScroller scrollerHeight]
1229 /* This is to match emacs on other platforms, ugly though it is. */
1230 #define NS_SELECTION_BG_COLOR_DEFAULT   @"LightGoldenrod2";
1231 #define NS_SELECTION_FG_COLOR_DEFAULT   @"Black";
1232 #define RESIZE_HANDLE_SIZE 12
1233
1234 /* Little utility macros */
1235 #define IN_BOUND(min, x, max) (((x) < (min)) \
1236                                 ? (min) : (((x)>(max)) ? (max) : (x)))
1237 #define SCREENMAXBOUND(x) (IN_BOUND (-SCREENMAX, x, SCREENMAX))
1238
1239 /* macOS 10.12 deprecates a bunch of constants. */
1240 #if !defined (NS_IMPL_COCOA) || \
1241   MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_12
1242 #define NSEventModifierFlagCommand         NSCommandKeyMask
1243 #define NSEventModifierFlagControl         NSControlKeyMask
1244 #define NSEventModifierFlagHelp            NSHelpKeyMask
1245 #define NSEventModifierFlagNumericPad      NSNumericPadKeyMask
1246 #define NSEventModifierFlagOption          NSAlternateKeyMask
1247 #define NSEventModifierFlagShift           NSShiftKeyMask
1248 #define NSCompositingOperationSourceOver   NSCompositeSourceOver
1249 #define NSEventMaskApplicationDefined      NSApplicationDefinedMask
1250 #define NSEventTypeApplicationDefined      NSApplicationDefined
1251 #define NSEventTypeCursorUpdate            NSCursorUpdate
1252 #define NSEventTypeMouseMoved              NSMouseMoved
1253 #define NSEventTypeLeftMouseDown           NSLeftMouseDown
1254 #define NSEventTypeRightMouseDown          NSRightMouseDown
1255 #define NSEventTypeOtherMouseDown          NSOtherMouseDown
1256 #define NSEventTypeLeftMouseUp             NSLeftMouseUp
1257 #define NSEventTypeRightMouseUp            NSRightMouseUp
1258 #define NSEventTypeOtherMouseUp            NSOtherMouseUp
1259 #define NSEventTypeLeftMouseDragged        NSLeftMouseDragged
1260 #define NSEventTypeRightMouseDragged       NSRightMouseDragged
1261 #define NSEventTypeOtherMouseDragged       NSOtherMouseDragged
1262 #define NSEventTypeScrollWheel             NSScrollWheel
1263 #define NSEventTypeKeyDown                 NSKeyDown
1264 #define NSEventTypeKeyUp                   NSKeyUp
1265 #define NSEventTypeFlagsChanged            NSFlagsChanged
1266 #define NSEventMaskAny                     NSAnyEventMask
1267 #define NSWindowStyleMaskBorderless        NSBorderlessWindowMask
1268 #define NSWindowStyleMaskClosable          NSClosableWindowMask
1269 #define NSWindowStyleMaskFullScreen        NSFullScreenWindowMask
1270 #define NSWindowStyleMaskMiniaturizable    NSMiniaturizableWindowMask
1271 #define NSWindowStyleMaskResizable         NSResizableWindowMask
1272 #define NSWindowStyleMaskTitled            NSTitledWindowMask
1273 #define NSAlertStyleCritical               NSCriticalAlertStyle
1274 #define NSControlSizeRegular               NSRegularControlSize
1275 #endif
1276
1277 #endif  /* HAVE_NS */