src/nsterm.h

   1 /* Definitions and headers for communication with NeXT/Open/GNUstep API.
   2    Copyright (C) 1989, 1993, 2005, 2008-2015 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
  10 (at 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_4
  31 #define MAC_OS_X_VERSION_10_4 1040
  32 #endif
  33 #ifndef MAC_OS_X_VERSION_10_5
  34 #define MAC_OS_X_VERSION_10_5 1050
  35 #endif
  36 #ifndef MAC_OS_X_VERSION_10_6
  37 #define MAC_OS_X_VERSION_10_6 1060
  38 #endif
  39 #ifndef MAC_OS_X_VERSION_10_7
  40 #define MAC_OS_X_VERSION_10_7 1070
  41 #endif
  42 #ifndef MAC_OS_X_VERSION_10_8
  43 #define MAC_OS_X_VERSION_10_8 1080
  44 #endif
  45 #ifndef MAC_OS_X_VERSION_10_9
  46 #define MAC_OS_X_VERSION_10_9 1090
  47 #endif
  48
  49 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
  50 #define HAVE_NATIVE_FS
  51 #endif
  52
  53 #endif /* NS_IMPL_COCOA */
  54
  55 #ifdef __OBJC__
  56
  57 /* CGFloat on GNUstep may be 4 or 8 byte, but functions expect float* for some
  58    versions.
  59    On Cocoa >= 10.5, functions expect CGFloat*. Make compatible type.  */
  60 #ifdef NS_IMPL_COCOA
  61
  62 #ifndef NS_HAVE_NSINTEGER
  63 #if defined (__LP64__) && __LP64__
  64 typedef double CGFloat;
  65 typedef long NSInteger;
  66 typedef unsigned long NSUInteger;
  67 #else
  68 typedef float CGFloat;
  69 typedef int NSInteger;
  70 typedef unsigned int NSUInteger;
  71 #endif /* not LP64 */
  72 #endif /* not NS_HAVE_NSINTEGER */
  73
  74 typedef CGFloat EmacsCGFloat;
  75
  76 #elif GNUSTEP_GUI_MAJOR_VERSION > 0 || GNUSTEP_GUI_MINOR_VERSION >= 22
  77 typedef CGFloat EmacsCGFloat;
  78 #else
  79 typedef float EmacsCGFloat;
  80 #endif
  81
  82 /* ==========================================================================
  83
  84    NSColor, EmacsColor category.
  85
  86    ========================================================================== */
  87 @interface NSColor (EmacsColor)
  88 + (NSColor *)colorForEmacsRed:(CGFloat)red green:(CGFloat)green
  89                          blue:(CGFloat)blue alpha:(CGFloat)alpha;
  90 - (NSColor *)colorUsingDefaultColorSpace;
  91
  92 @end
  93
  94 /* ==========================================================================
  95
  96    The Emacs application
  97
  98    ========================================================================== */
  99
 100 /* We override sendEvent: as a means to stop/start the event loop */
 101 @interface EmacsApp : NSApplication
 102 {
 103 #ifdef NS_IMPL_COCOA
 104   BOOL shouldKeepRunning;
 105   BOOL isFirst;
 106 #endif
 107 #ifdef NS_IMPL_GNUSTEP
 108   BOOL applicationDidFinishLaunchingCalled;
 109 @public
 110   int nextappdefined;
 111 #endif
 112 }
 113 - (void)logNotification: (NSNotification *)notification;
 114 - (void)antialiasThresholdDidChange:(NSNotification *)notification;
 115 - (void)sendEvent: (NSEvent *)theEvent;
 116 - (void)showPreferencesWindow: (id)sender;
 117 - (BOOL) openFile: (NSString *)fileName;
 118 - (void)fd_handler: (id)unused;
 119 - (void)timeout_handler: (NSTimer *)timedEntry;
 120 - (BOOL)fulfillService: (NSString *)name withArg: (NSString *)arg;
 121 #ifdef NS_IMPL_GNUSTEP
 122 - (void)sendFromMainThread:(id)unused;
 123 #endif
 124 @end
 125
 126 #ifdef NS_IMPL_GNUSTEP
 127 /* Dummy class to get rid of startup warnings.  */
 128 @interface EmacsDocument : NSDocument
 129 {
 130 }
 131 @end
 132 #endif
 133
 134 /* ==========================================================================
 135
 136    The main Emacs view
 137
 138    ========================================================================== */
 139
 140 @class EmacsToolbar;
 141
 142 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
 143 @interface EmacsView : NSView <NSTextInput, NSWindowDelegate>
 144 #else
 145 @interface EmacsView : NSView <NSTextInput>
 146 #endif
 147    {
 148 #ifdef NS_IMPL_COCOA
 149    char *old_title;
 150    BOOL maximizing_resize;
 151 #endif
 152    BOOL windowClosing;
 153    NSString *workingText;
 154    BOOL processingCompose;
 155    int fs_state, fs_before_fs, next_maximized;
 156    int tibar_height, tobar_height, bwidth;
 157    int maximized_width, maximized_height;
 158    NSWindow *nonfs_window;
 159    BOOL fs_is_native;
 160 @public
 161    struct frame *emacsframe;
 162    int rows, cols;
 163    int scrollbarsNeedingUpdate;
 164    EmacsToolbar *toolbar;
 165    NSRect ns_userRect;
 166    BOOL wait_for_tool_bar;
 167    }
 168
 169 /* AppKit-side interface */
 170 - menuDown: (id)sender;
 171 - toolbarClicked: (id)item;
 172 - toggleToolbar: (id)sender;
 173 - (void)keyDown: (NSEvent *)theEvent;
 174 - (void)mouseDown: (NSEvent *)theEvent;
 175 - (void)mouseUp: (NSEvent *)theEvent;
 176 - setMiniwindowImage: (BOOL)setMini;
 177
 178 /* Emacs-side interface */
 179 - initFrameFromEmacs: (struct frame *) f;
 180 - (void) setRows: (int) r andColumns: (int) c;
 181 - (void) setWindowClosing: (BOOL)closing;
 182 - (EmacsToolbar *) toolbar;
 183 - (void) deleteWorkingText;
 184 - (void) updateFrameSize: (BOOL) delay;
 185 - (void) handleFS;
 186 - (void) setFSValue: (int)value;
 187 - (void) toggleFullScreen: (id) sender;
 188 - (BOOL) fsIsNative;
 189 - (BOOL) isFullscreen;
 190 #ifdef HAVE_NATIVE_FS
 191 - (void) updateCollectionBehavior;
 192 #endif
 193
 194 #ifdef NS_IMPL_GNUSTEP
 195 - (void)windowDidMove: (id)sender;
 196 #endif
 197 @end
 198
 199
 200 /* Small utility used for processing resize events under Cocoa. */
 201 @interface EmacsWindow : NSWindow
 202 {
 203   NSPoint grabOffset;
 204 }
 205 @end
 206
 207
 208 /* Fullscreen version of the above.  */
 209 @interface EmacsFSWindow : EmacsWindow
 210 {
 211 }
 212 @end
 213
 214 /* ==========================================================================
 215
 216    The main menu implementation
 217
 218    ========================================================================== */
 219
 220 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
 221 @interface EmacsMenu : NSMenu  <NSMenuDelegate>
 222 #else
 223 @interface EmacsMenu : NSMenu
 224 #endif
 225 {
 226   struct frame *frame;
 227   unsigned long keyEquivModMask;
 228 }
 229
 230 - initWithTitle: (NSString *)title frame: (struct frame *)f;
 231 - (void)setFrame: (struct frame *)f;
 232 - (void)menuNeedsUpdate: (NSMenu *)menu; /* (delegate method) */
 233 - (NSString *)parseKeyEquiv: (const char *)key;
 234 - (NSMenuItem *)addItemWithWidgetValue: (void *)wvptr;
 235 - (void)fillWithWidgetValue: (void *)wvptr;
 236 - (void)fillWithWidgetValue: (void *)wvptr frame: (struct frame *)f;
 237 - (EmacsMenu *)addSubmenuWithTitle: (const char *)title forFrame: (struct frame *)f;
 238 - (void) clear;
 239 - (Lisp_Object)runMenuAt: (NSPoint)p forFrame: (struct frame *)f
 240                  keymaps: (bool)keymaps;
 241 @end
 242
 243
 244 /* ==========================================================================
 245
 246    Toolbar
 247
 248    ========================================================================== */
 249
 250 @class EmacsImage;
 251
 252 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
 253 @interface EmacsToolbar : NSToolbar <NSToolbarDelegate>
 254 #else
 255 @interface EmacsToolbar : NSToolbar
 256 #endif
 257    {
 258      EmacsView *emacsView;
 259      NSMutableDictionary *identifierToItem;
 260      NSMutableArray *activeIdentifiers;
 261      NSArray *prevIdentifiers;
 262      unsigned long enablement, prevEnablement;
 263    }
 264 - initForView: (EmacsView *)view withIdentifier: (NSString *)identifier;
 265 - (void) clearActive;
 266 - (void) clearAll;
 267 - (BOOL) changed;
 268 - (void) addDisplayItemWithImage: (EmacsImage *)img
 269                              idx: (int)idx
 270                              tag: (int)tag
 271                         helpText: (const char *)help
 272                          enabled: (BOOL)enabled;
 273
 274 /* delegate methods */
 275 - (NSToolbarItem *)toolbar: (NSToolbar *)toolbar
 276      itemForItemIdentifier: (NSString *)itemIdentifier
 277  willBeInsertedIntoToolbar: (BOOL)flag;
 278 - (NSArray *)toolbarDefaultItemIdentifiers: (NSToolbar *)toolbar;
 279 - (NSArray *)toolbarAllowedItemIdentifiers: (NSToolbar *)toolbar;
 280 @end
 281
 282
 283 /* ==========================================================================
 284
 285    Message / question windows
 286
 287    ========================================================================== */
 288
 289 @interface EmacsDialogPanel : NSPanel
 290    {
 291    NSTextField *command;
 292    NSTextField *title;
 293    NSMatrix *matrix;
 294    int rows, cols;
 295    BOOL timer_fired, window_closed;
 296    Lisp_Object dialog_return;
 297    Lisp_Object *button_values;
 298    }
 299 - initFromContents: (Lisp_Object)menu isQuestion: (BOOL)isQ;
 300 - (void)process_dialog: (Lisp_Object)list;
 301 - (void)addButton: (char *)str value: (int)tag row: (int)row;
 302 - (void)addString: (char *)str row: (int)row;
 303 - (void)addSplit;
 304 - (Lisp_Object)runDialogAt: (NSPoint)p;
 305 - (void)timeout_handler: (NSTimer *)timedEntry;
 306 @end
 307
 308 #if defined (NS_IMPL_COCOA) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
 309 @interface EmacsTooltip : NSObject <NSWindowDelegate>
 310 #else
 311 @interface EmacsTooltip : NSObject
 312 #endif
 313   {
 314     NSWindow *win;
 315     NSTextField *textField;
 316     NSTimer *timer;
 317   }
 318 - init;
 319 - (void) setText: (char *)text;
 320 - (void) showAtX: (int)x Y: (int)y for: (int)seconds;
 321 - (void) hide;
 322 - (BOOL) isActive;
 323 - (NSRect) frame;
 324 @end
 325
 326
 327 /* ==========================================================================
 328
 329    File open/save panels
 330    This and next override methods to handle keyboard input in panels.
 331
 332    ========================================================================== */
 333
 334 @interface EmacsSavePanel : NSSavePanel
 335 {
 336 }
 337 @end
 338 @interface EmacsOpenPanel : NSOpenPanel
 339 {
 340 }
 341 @end
 342
 343 @interface EmacsFileDelegate : NSObject
 344 {
 345 }
 346 - (BOOL)panel: (id)sender isValidFilename: (NSString *)filename;
 347 - (BOOL)panel: (id)sender shouldShowFilename: (NSString *)filename;
 348 - (NSString *)panel: (id)sender userEnteredFilename: (NSString *)filename
 349           confirmed: (BOOL)okFlag;
 350 @end
 351
 352
 353 /* ==========================================================================
 354
 355    Images and stippling
 356
 357    ========================================================================== */
 358
 359 @interface EmacsImage : NSImage
 360 {
 361   NSBitmapImageRep *bmRep; /* used for accessing pixel data */
 362   unsigned char *pixmapData[5]; /* shortcut to access pixel data */
 363   NSColor *stippleMask;
 364 }
 365 + allocInitFromFile: (Lisp_Object)file;
 366 - (void)dealloc;
 367 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
 368          flip: (BOOL)flip;
 369 - initFromSkipXBM: (unsigned char *)bits width: (int)w height: (int)h
 370              flip: (BOOL)flip length: (int)length;
 371 - setXBMColor: (NSColor *)color;
 372 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height;
 373 - (void)setPixmapData;
 374 - (unsigned long)getPixelAtX: (int)x Y: (int)y;
 375 - (void)setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
 376                green: (unsigned char)g blue: (unsigned char)b
 377               alpha:(unsigned char)a;
 378 - (void)setAlphaAtX: (int)x Y: (int)y to: (unsigned char)a;
 379 - (NSColor *)stippleMask;
 380 @end
 381
 382
 383 /* ==========================================================================
 384
 385    Scrollbars
 386
 387    ========================================================================== */
 388
 389 @interface EmacsScroller : NSScroller
 390   {
 391    struct window *window;
 392    struct frame *frame;
 393    NSResponder *prevResponder;
 394
 395    /* offset to the bottom of knob of last mouse down */
 396    CGFloat last_mouse_offset;
 397    float min_portion;
 398    int pixel_height;
 399    int last_hit_part;
 400
 401    BOOL condemned;
 402
 403    /* optimize against excessive positioning calls generated by emacs */
 404    int em_position;
 405    int em_portion;
 406    int em_whole;
 407    }
 408
 409 - initFrame: (NSRect )r window: (Lisp_Object)win;
 410 - (void)setFrame: (NSRect)r;
 411 - (void)dealloc;
 412
 413 - setPosition: (int) position portion: (int) portion whole: (int) whole;
 414 - (int) checkSamePosition: (int)position portion: (int)portion
 415                     whole: (int)whole;
 416 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e;
 417 - repeatScroll: (NSTimer *)sender;
 418 - condemn;
 419 - reprieve;
 420 - (bool)judge;
 421 @end
 422
 423
 424 /* ==========================================================================
 425
 426    Rendering
 427
 428    ========================================================================== */
 429
 430 #ifdef NS_IMPL_COCOA
 431 /* rendering util */
 432 @interface EmacsGlyphStorage : NSObject <NSGlyphStorage>
 433 {
 434 @public
 435   NSAttributedString *attrStr;
 436   NSMutableDictionary *dict;
 437   CGGlyph *cglyphs;
 438   unsigned long maxChar, maxGlyph;
 439   long i, len;
 440 }
 441 - initWithCapacity: (unsigned long) c;
 442 - (void) setString: (NSString *)str font: (NSFont *)font;
 443 @end
 444 #endif  /* NS_IMPL_COCOA */
 445
 446 extern NSArray *ns_send_types, *ns_return_types;
 447 extern NSString *ns_app_name;
 448 extern EmacsMenu *mainMenu, *svcsMenu, *dockMenu;
 449
 450 /* Apple removed the declaration, but kept the implementation */
 451 #if defined (NS_IMPL_COCOA)
 452 @interface NSApplication (EmacsApp)
 453 - (void)setAppleMenu: (NSMenu *)menu;
 454 @end
 455 #endif
 456
 457 #endif  /* __OBJC__ */
 458
 459
 460
 461 /* ==========================================================================
 462
 463    Non-OO stuff
 464
 465    ========================================================================== */
 466
 467 /* Special keycodes that we pass down the event chain */
 468 #define KEY_NS_POWER_OFF               ((1<<28)|(0<<16)|1)
 469 #define KEY_NS_OPEN_FILE               ((1<<28)|(0<<16)|2)
 470 #define KEY_NS_OPEN_TEMP_FILE          ((1<<28)|(0<<16)|3)
 471 #define KEY_NS_CHANGE_FONT             ((1<<28)|(0<<16)|7)
 472 #define KEY_NS_OPEN_FILE_LINE          ((1<<28)|(0<<16)|8)
 473 #define KEY_NS_PUT_WORKING_TEXT        ((1<<28)|(0<<16)|9)
 474 #define KEY_NS_UNPUT_WORKING_TEXT      ((1<<28)|(0<<16)|10)
 475 #define KEY_NS_SPI_SERVICE_CALL        ((1<<28)|(0<<16)|11)
 476 #define KEY_NS_NEW_FRAME               ((1<<28)|(0<<16)|12)
 477 #define KEY_NS_TOGGLE_TOOLBAR          ((1<<28)|(0<<16)|13)
 478 #define KEY_NS_SHOW_PREFS              ((1<<28)|(0<<16)|14)
 479
 480 /* could use list to store these, but rest of emacs has a big infrastructure
 481    for managing a table of bitmap "records" */
 482 struct ns_bitmap_record
 483 {
 484 #ifdef __OBJC__
 485   EmacsImage *img;
 486 #else
 487   void *img;
 488 #endif
 489   char *file;
 490   int refcount;
 491   int height, width, depth;
 492 };
 493
 494 /* this to map between emacs color indices and NSColor objects */
 495 struct ns_color_table
 496 {
 497   ptrdiff_t size;
 498   ptrdiff_t avail;
 499 #ifdef __OBJC__
 500   NSColor **colors;
 501   NSMutableSet *empty_indices;
 502 #else
 503   void **items;
 504   void *availIndices;
 505 #endif
 506 };
 507 #define NS_COLOR_CAPACITY 256
 508
 509 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
 510 #define ARGB_TO_ULONG(a, r, g, b) (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
 511
 512 #define ALPHA_FROM_ULONG(color) ((color) >> 24)
 513 #define RED_FROM_ULONG(color) (((color) >> 16) & 0xff)
 514 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
 515 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
 516
 517 /* Do not change `* 0x101' in the following lines to `<< 8'.  If
 518    changed, image masks in 1-bit depth will not work. */
 519 #define RED16_FROM_ULONG(color) (RED_FROM_ULONG(color) * 0x101)
 520 #define GREEN16_FROM_ULONG(color) (GREEN_FROM_ULONG(color) * 0x101)
 521 #define BLUE16_FROM_ULONG(color) (BLUE_FROM_ULONG(color) * 0x101)
 522
 523 /* this extends font backend font */
 524 struct nsfont_info
 525 {
 526   struct font font;
 527
 528   char *name;  /* PostScript name, uniquely identifies on NS systems */
 529
 530   /* The following metrics are stored as float rather than int. */
 531
 532   float width;  /* Maximum advance for the font.  */
 533   float height;
 534   float underpos;
 535   float underwidth;
 536   float size;
 537 #ifdef __OBJC__
 538   NSFont *nsfont;
 539 #if defined (NS_IMPL_COCOA)
 540   CGFontRef cgfont;
 541 #else /* GNUstep */
 542   void *cgfont;
 543 #endif
 544 #else /* ! OBJC */
 545   void *nsfont;
 546   void *cgfont;
 547 #endif
 548   char bold, ital;  /* convenience flags */
 549   char synthItal;
 550   XCharStruct max_bounds;
 551   /* we compute glyph codes and metrics on-demand in blocks of 256 indexed
 552      by hibyte, lobyte */
 553   unsigned short **glyphs; /* map Unicode index to glyph */
 554   struct font_metrics **metrics;
 555 };
 556
 557
 558 /* init'd in ns_initialize_display_info () */
 559 struct ns_display_info
 560 {
 561   /* Chain of all ns_display_info structures.  */
 562   struct ns_display_info *next;
 563
 564   /* The generic display parameters corresponding to this NS display. */
 565   struct terminal *terminal;
 566
 567   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).  */
 568   Lisp_Object name_list_element;
 569
 570   /* The number of fonts loaded. */
 571   int n_fonts;
 572
 573   /* Minimum width over all characters in all fonts in font_table.  */
 574   int smallest_char_width;
 575
 576   /* Minimum font height over all fonts in font_table.  */
 577   int smallest_font_height;
 578
 579   struct ns_bitmap_record *bitmaps;
 580   ptrdiff_t bitmaps_size;
 581   ptrdiff_t bitmaps_last;
 582
 583   struct ns_color_table *color_table;
 584
 585   /* DPI resolution of this screen */
 586   double resx, resy;
 587
 588   /* Mask of things that cause the mouse to be grabbed */
 589   int grabbed;
 590
 591   int n_planes;
 592
 593   int color_p;
 594
 595   Window root_window;
 596
 597   /* Xism */
 598   XrmDatabase xrdb;
 599
 600   /* The cursor to use for vertical scroll bars. */
 601   Cursor vertical_scroll_bar_cursor;
 602
 603   /* Information about the range of text currently shown in
 604      mouse-face.  */
 605   Mouse_HLInfo mouse_highlight;
 606
 607   struct frame *x_highlight_frame;
 608   struct frame *x_focus_frame;
 609
 610   /* The frame where the mouse was last time we reported a mouse event.  */
 611   struct frame *last_mouse_frame;
 612
 613   /* The frame where the mouse was last time we reported a mouse motion.  */
 614   struct frame *last_mouse_motion_frame;
 615
 616   /* Position where the mouse was last time we reported a motion.
 617      This is a position on last_mouse_motion_frame.  */
 618   int last_mouse_motion_x;
 619   int last_mouse_motion_y;
 620
 621   /* Where the mouse was last time we reported a mouse position.  */
 622   NSRect last_mouse_glyph;
 623
 624   /* Time of last mouse movement.  */
 625   Time last_mouse_movement_time;
 626
 627   /* The scroll bar in which the last motion event occurred.  */
 628 #ifdef __OBJC__
 629   EmacsScroller *last_mouse_scroll_bar;
 630 #else
 631   void *last_mouse_scroll_bar;
 632 #endif
 633 };
 634
 635 /* This is a chain of structures for all the NS displays currently in use.  */
 636 extern struct ns_display_info *x_display_list;
 637
 638 extern struct ns_display_info *ns_display_info_for_name (Lisp_Object name);
 639
 640 struct ns_output
 641 {
 642 #ifdef __OBJC__
 643   EmacsView *view;
 644   id miniimage;
 645   NSColor *cursor_color;
 646   NSColor *foreground_color;
 647   NSColor *background_color;
 648   EmacsToolbar *toolbar;
 649 #else
 650   void *view;
 651   void *miniimage;
 652   void *cursor_color;
 653   void *foreground_color;
 654   void *background_color;
 655   void *toolbar;
 656 #endif
 657
 658   /* NSCursors init'ed in initFrameFromEmacs */
 659   Cursor text_cursor;
 660   Cursor nontext_cursor;
 661   Cursor modeline_cursor;
 662   Cursor hand_cursor;
 663   Cursor hourglass_cursor;
 664   Cursor horizontal_drag_cursor;
 665   Cursor vertical_drag_cursor;
 666
 667   /* NS-specific */
 668   Cursor current_pointer;
 669
 670   /* lord knows why Emacs needs to know about our Window ids.. */
 671   Window window_desc, parent_desc;
 672   char explicit_parent;
 673
 674   struct font *font;
 675   int baseline_offset;
 676
 677   /* If a fontset is specified for this frame instead of font, this
 678      value contains an ID of the fontset, else -1.  */
 679   int fontset; /* only used with font_backend */
 680
 681   int icon_top;
 682   int icon_left;
 683
 684   /* The size of the extra width currently allotted for vertical
 685      scroll bars, in pixels.  */
 686   int vertical_scroll_bar_extra;
 687
 688   /* The height of the titlebar decoration (included in NSWindow's frame). */
 689   int titlebar_height;
 690
 691   /* The height of the toolbar if displayed, else 0. */
 692   int toolbar_height;
 693
 694   /* This is the Emacs structure for the NS display this frame is on.  */
 695   struct ns_display_info *display_info;
 696
 697   /* Non-zero if we are zooming (maximizing) the frame.  */
 698   int zooming;
 699 };
 700
 701 /* this dummy decl needed to support TTYs */
 702 struct x_output
 703 {
 704   int unused;
 705 };
 706
 707
 708 /* This gives the ns_display_info structure for the display F is on.  */
 709 #define FRAME_DISPLAY_INFO(f) ((f)->output_data.ns->display_info)
 710 #define FRAME_X_OUTPUT(f) ((f)->output_data.ns)
 711 #define FRAME_NS_WINDOW(f) ((f)->output_data.ns->window_desc)
 712 #define FRAME_X_WINDOW(f) ((f)->output_data.ns->window_desc)
 713
 714 /* This is the `Display *' which frame F is on.  */
 715 #define FRAME_NS_DISPLAY(f) (0)
 716 #define FRAME_X_DISPLAY(f) (0)
 717 #define FRAME_X_SCREEN(f) (0)
 718 #define FRAME_X_VISUAL(f) FRAME_DISPLAY_INFO(f)->visual
 719
 720 #define FRAME_FOREGROUND_COLOR(f) ((f)->output_data.ns->foreground_color)
 721 #define FRAME_BACKGROUND_COLOR(f) ((f)->output_data.ns->background_color)
 722
 723 #define NS_FACE_FOREGROUND(f) ((f)->foreground)
 724 #define NS_FACE_BACKGROUND(f) ((f)->background)
 725 #define FRAME_NS_TITLEBAR_HEIGHT(f) ((f)->output_data.ns->titlebar_height)
 726 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.ns->toolbar_height)
 727
 728 #define FRAME_DEFAULT_FACE(f) FACE_FROM_ID (f, DEFAULT_FACE_ID)
 729
 730 #define FRAME_NS_VIEW(f) ((f)->output_data.ns->view)
 731 #define FRAME_CURSOR_COLOR(f) ((f)->output_data.ns->cursor_color)
 732 #define FRAME_POINTER_TYPE(f) ((f)->output_data.ns->current_pointer)
 733
 734 #define FRAME_FONT(f) ((f)->output_data.ns->font)
 735
 736 #ifdef __OBJC__
 737 #define XNS_SCROLL_BAR(vec) ((id) XSAVE_POINTER (vec, 0))
 738 #else
 739 #define XNS_SCROLL_BAR(vec) XSAVE_POINTER (vec, 0)
 740 #endif
 741
 742 /* Compute pixel size for vertical scroll bars */
 743 #define NS_SCROLL_BAR_WIDTH(f)                              \
 744 (FRAME_HAS_VERTICAL_SCROLL_BARS (f)                          \
 745  ? rint (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0               \
 746         ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)                 \
 747         : (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)))   \
 748  : 0)
 749
 750 /* Difference btwn char-column-calculated and actual SB widths.
 751    This is only a concern for rendering when SB on left. */
 752 #define NS_SCROLL_BAR_ADJUST(w, f)              \
 753 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) ?   \
 754     (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f) \
 755         - NS_SCROLL_BAR_WIDTH (f)) : 0)
 756
 757 /* XXX: fix for GNUstep inconsistent accounting for titlebar */
 758 #ifdef NS_IMPL_GNUSTEP
 759 #define NS_TOP_POS(f) ((f)->top_pos + 18)
 760 #else
 761 #define NS_TOP_POS(f) ((f)->top_pos)
 762 #endif
 763
 764 #define FRAME_NS_FONT_TABLE(f) (FRAME_DISPLAY_INFO (f)->font_table)
 765
 766 #define FRAME_FONTSET(f) ((f)->output_data.ns->fontset)
 767
 768 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.ns->baseline_offset)
 769 #define BLACK_PIX_DEFAULT(f) 0x000000
 770 #define WHITE_PIX_DEFAULT(f) 0xFFFFFF
 771
 772 /* First position where characters can be shown (instead of scrollbar, if
 773    it is on left. */
 774 #define FIRST_CHAR_POSITION(f) \
 775   (! (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)) ? 0 \
 776    : FRAME_SCROLL_BAR_COLS (f))
 777
 778 extern struct ns_display_info *ns_term_init (Lisp_Object display_name);
 779 extern void ns_term_shutdown (int sig);
 780
 781 /* constants for text rendering */
 782 #define NS_DUMPGLYPH_NORMAL             0
 783 #define NS_DUMPGLYPH_CURSOR             1
 784 #define NS_DUMPGLYPH_FOREGROUND         2
 785 #define NS_DUMPGLYPH_MOUSEFACE          3
 786
 787
 788
 789 /* In nsfont, called from fontset.c */
 790 extern void nsfont_make_fontset_for_font (Lisp_Object name,
 791                                          Lisp_Object font_object);
 792
 793 /* In nsfont, for debugging */
 794 struct glyph_string;
 795 void ns_dump_glyphstring (struct glyph_string *s);
 796
 797 /* Implemented in nsterm, published in or needed from nsfns. */
 798 extern Lisp_Object Qfontsize;
 799 extern Lisp_Object ns_list_fonts (struct frame *f, Lisp_Object pattern,
 800                                   int size, int maxnames);
 801 extern void ns_clear_frame (struct frame *f);
 802
 803 extern const char *ns_xlfd_to_fontname (const char *xlfd);
 804
 805 extern Lisp_Object ns_map_event_to_object (void);
 806 #ifdef __OBJC__
 807 extern Lisp_Object ns_string_from_pasteboard (id pb);
 808 extern void ns_string_to_pasteboard (id pb, Lisp_Object str);
 809 #endif
 810 extern Lisp_Object ns_get_local_selection (Lisp_Object selection_name,
 811                                            Lisp_Object target_type);
 812 extern void nxatoms_of_nsselect (void);
 813 extern int ns_lisp_to_cursor_type (Lisp_Object arg);
 814 extern Lisp_Object ns_cursor_type_to_lisp (int arg);
 815 extern void ns_set_name_as_filename (struct frame *f);
 816 extern void ns_set_doc_edited (void);
 817
 818 extern bool
 819 ns_defined_color (struct frame *f,
 820                   const char *name,
 821                   XColor *color_def, bool alloc,
 822                   bool makeIndex);
 823 extern void
 824 ns_query_color (void *col, XColor *color_def, int setPixel);
 825
 826 #ifdef __OBJC__
 827 extern Lisp_Object ns_color_to_lisp (NSColor *col);
 828 extern int ns_lisp_to_color (Lisp_Object color, NSColor **col);
 829 extern NSColor *ns_lookup_indexed_color (unsigned long idx, struct frame *f);
 830 extern unsigned long ns_index_color (NSColor *color, struct frame *f);
 831 extern void ns_free_indexed_color (unsigned long idx, struct frame *f);
 832 extern const char *ns_get_pending_menu_title (void);
 833 extern void ns_check_menu_open (NSMenu *menu);
 834 extern void ns_check_pending_open_menu (void);
 835 #endif
 836
 837 /* C access to ObjC functionality */
 838 extern void  ns_release_object (void *obj);
 839 extern void  ns_retain_object (void *obj);
 840 extern void *ns_alloc_autorelease_pool (void);
 841 extern void ns_release_autorelease_pool (void *);
 842 extern const char *ns_get_defaults_value (const char *key);
 843
 844 /* in nsmenu */
 845 extern void update_frame_tool_bar (struct frame *f);
 846 extern void free_frame_tool_bar (struct frame *f);
 847 extern void find_and_call_menu_selection (struct frame *f,
 848     int menu_bar_items_used, Lisp_Object vector, void *client_data);
 849 extern Lisp_Object find_and_return_menu_selection (struct frame *f,
 850                                                    bool keymaps,
 851                                                    void *client_data);
 852 extern Lisp_Object ns_popup_dialog (Lisp_Object position, Lisp_Object header,
 853                                     Lisp_Object contents);
 854
 855 #define NSAPP_DATA2_RUNASSCRIPT 10
 856 extern void ns_run_ascript (void);
 857
 858 #define NSAPP_DATA2_RUNFILEDIALOG 11
 859 extern void ns_run_file_dialog (void);
 860
 861 extern const char *ns_etc_directory (void);
 862 extern const char *ns_exec_path (void);
 863 extern const char *ns_load_path (void);
 864 extern void syms_of_nsterm (void);
 865 extern void syms_of_nsfns (void);
 866 extern void syms_of_nsmenu (void);
 867 extern void syms_of_nsselect (void);
 868
 869 /* From nsimage.m, needed in image.c */
 870 struct image;
 871 extern void *ns_image_from_XBM (unsigned char *bits, int width, int height);
 872 extern void *ns_image_for_XPM (int width, int height, int depth);
 873 extern void *ns_image_from_file (Lisp_Object file);
 874 extern bool ns_load_image (struct frame *f, struct image *img,
 875                            Lisp_Object spec_file, Lisp_Object spec_data);
 876 extern int ns_image_width (void *img);
 877 extern int ns_image_height (void *img);
 878 extern unsigned long ns_get_pixel (void *img, int x, int y);
 879 extern void ns_put_pixel (void *img, int x, int y, unsigned long argb);
 880 extern void ns_set_alpha (void *img, int x, int y, unsigned char a);
 881
 882 extern int x_display_pixel_height (struct ns_display_info *);
 883 extern int x_display_pixel_width (struct ns_display_info *);
 884
 885 /* This in nsterm.m */
 886 extern void x_destroy_window (struct frame *f);
 887 extern int ns_select (int nfds, fd_set *readfds, fd_set *writefds,
 888                       fd_set *exceptfds, struct timespec const *timeout,
 889                       sigset_t const *sigmask);
 890 extern unsigned long ns_get_rgb_color (struct frame *f,
 891                                        float r, float g, float b, float a);
 892
 893 #ifdef __OBJC__
 894 /* From nsterm.m, needed in nsfont.m. */
 895 extern void
 896 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
 897                          NSColor *defaultCol, CGFloat width, CGFloat x);
 898 /* Needed in nsfns.m.  */
 899 extern void
 900 ns_set_represented_filename (NSString* fstr, struct frame *f);
 901
 902 #endif
 903
 904 #ifdef NS_IMPL_GNUSTEP
 905 extern char gnustep_base_version[];  /* version tracking */
 906 #endif
 907
 908 #define MINWIDTH 10
 909 #define MINHEIGHT 10
 910
 911 /* Screen max coordinate
 912  Using larger coordinates causes movewindow/placewindow to abort */
 913 #define SCREENMAX 16000
 914
 915 #define NS_SCROLL_BAR_WIDTH_DEFAULT     [EmacsScroller scrollerWidth]
 916 /* This is to match emacs on other platforms, ugly though it is. */
 917 #define NS_SELECTION_BG_COLOR_DEFAULT   @"LightGoldenrod2";
 918 #define NS_SELECTION_FG_COLOR_DEFAULT   @"Black";
 919 #define RESIZE_HANDLE_SIZE 12
 920
 921 /* Little utility macros */
 922 #define IN_BOUND(min, x, max) (((x) < (min)) \
 923                                 ? (min) : (((x)>(max)) ? (max) : (x)))
 924 #define SCREENMAXBOUND(x) (IN_BOUND (-SCREENMAX, x, SCREENMAX))
 925
 926 #endif  /* HAVE_NS */