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