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