src/nsterm.h

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