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