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