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