src/nsterm.h

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