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