src/nsterm.h

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