src/nsterm.h

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