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