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