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