src/nsterm.h

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