src/nsterm.h

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