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