* lisp/cedet/semantic/wisent/comp.el (wisent-defcontext): Move declarations
[emacs.git] / src / nsterm.h
blobf59405fe9af69b0560dfaad5b36996b9736b427b
1 /* Definitions and headers for communication with NeXT/Open/GNUstep API.
2 Copyright (C) 1989, 1993, 2005, 2008-2014 Free Software Foundation,
3 Inc.
5 This file is part of GNU Emacs.
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.
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.
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/>. */
21 #include "dispextern.h"
22 #include "frame.h"
23 #include "character.h"
24 #include "font.h"
25 #include "sysselect.h"
27 #ifdef HAVE_NS
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
43 #if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
44 #define HAVE_NATIVE_FS
45 #endif
47 #endif /* NS_IMPL_COCOA */
49 #ifdef __OBJC__
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
62 /* ==========================================================================
64 NSColor, EmacsColor category.
66 ========================================================================== */
67 @interface NSColor (EmacsColor)
68 + (NSColor *)colorForEmacsRed:(CGFloat)red green:(CGFloat)green
69 blue:(CGFloat)blue alpha:(CGFloat)alpha;
70 - (NSColor *)colorUsingDefaultColorSpace;
72 @end
74 /* ==========================================================================
76 The Emacs application
78 ========================================================================== */
80 /* We override sendEvent: as a means to stop/start the event loop */
81 @interface EmacsApp : NSApplication
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
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
106 #ifdef NS_IMPL_GNUSTEP
107 /* Dummy class to get rid of startup warnings. */
108 @interface EmacsDocument : NSDocument
111 @end
112 #endif
114 /* ==========================================================================
116 The main Emacs view
118 ========================================================================== */
120 @class EmacsToolbar;
122 #ifdef NS_IMPL_COCOA
123 @interface EmacsView : NSView <NSTextInput, NSWindowDelegate>
124 #else
125 @interface EmacsView : NSView <NSTextInput>
126 #endif
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;
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;
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
174 #ifdef NS_IMPL_GNUSTEP
175 - (void)windowDidMove: (id)sender;
176 #endif
177 @end
180 /* Small utility used for processing resize events under Cocoa. */
181 @interface EmacsWindow : NSWindow
183 NSPoint grabOffset;
185 @end
188 /* Fullscreen version of the above. */
189 @interface EmacsFSWindow : EmacsWindow
192 @end
194 /* ==========================================================================
196 The main menu implementation
198 ========================================================================== */
200 #ifdef NS_IMPL_COCOA
201 @interface EmacsMenu : NSMenu <NSMenuDelegate>
202 #else
203 @interface EmacsMenu : NSMenu
204 #endif
206 struct frame *frame;
207 unsigned long keyEquivModMask;
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
224 /* ==========================================================================
226 Toolbar
228 ========================================================================== */
230 @class EmacsImage;
232 #ifdef NS_IMPL_COCOA
233 @interface EmacsToolbar : NSToolbar <NSToolbarDelegate>
234 #else
235 @interface EmacsToolbar : NSToolbar
236 #endif
238 EmacsView *emacsView;
239 NSMutableDictionary *identifierToItem;
240 NSMutableArray *activeIdentifiers;
241 NSArray *prevIdentifiers;
242 unsigned long enablement, prevEnablement;
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;
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
263 /* ==========================================================================
265 Message / question windows
267 ========================================================================== */
269 @interface EmacsDialogPanel : NSPanel
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;
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
288 #ifdef NS_IMPL_COCOA
289 @interface EmacsTooltip : NSObject <NSWindowDelegate>
290 #else
291 @interface EmacsTooltip : NSObject
292 #endif
294 NSWindow *win;
295 NSTextField *textField;
296 NSTimer *timer;
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
307 /* ==========================================================================
309 File open/save panels
310 This and next override methods to handle keyboard input in panels.
312 ========================================================================== */
314 @interface EmacsSavePanel : NSSavePanel
317 @end
318 @interface EmacsOpenPanel : NSOpenPanel
321 @end
323 @interface EmacsFileDelegate : NSObject
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
333 /* ==========================================================================
335 Images and stippling
337 ========================================================================== */
339 @interface EmacsImage : NSImage
341 id imageListNext;
342 int refCount;
343 NSBitmapImageRep *bmRep; /* used for accessing pixel data */
344 unsigned char *pixmapData[5]; /* shortcut to access pixel data */
345 NSColor *stippleMask;
347 + allocInitFromFile: (Lisp_Object)file;
348 - reference;
349 - imageListSetNext: (id)arg;
350 - imageListNext;
351 - (void)dealloc;
352 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
353 flip: (BOOL)flip;
354 - initFromSkipXBM: (unsigned char *)bits width: (int)w height: (int)h
355 flip: (BOOL)flip length: (int)length;
356 - setXBMColor: (NSColor *)color;
357 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height;
358 - (void)setPixmapData;
359 - (unsigned long)getPixelAtX: (int)x Y: (int)y;
360 - (void)setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
361 green: (unsigned char)g blue: (unsigned char)b
362 alpha:(unsigned char)a;
363 - (void)setAlphaAtX: (int)x Y: (int)y to: (unsigned char)a;
364 - (NSColor *)stippleMask;
365 @end
368 /* ==========================================================================
370 Scrollbars
372 ========================================================================== */
374 @interface EmacsScroller : NSScroller
376 Lisp_Object win;
377 struct frame *frame;
378 NSResponder *prevResponder;
380 /* offset to the bottom of knob of last mouse down */
381 CGFloat last_mouse_offset;
382 float min_portion;
383 int pixel_height;
384 enum scroll_bar_part last_hit_part;
386 BOOL condemned;
388 /* optimize against excessive positioning calls generated by emacs */
389 int em_position;
390 int em_portion;
391 int em_whole;
394 - initFrame: (NSRect )r window: (Lisp_Object)win;
395 - (void)setFrame: (NSRect)r;
397 - setPosition: (int) position portion: (int) portion whole: (int) whole;
398 - (int) checkSamePosition: (int)position portion: (int)portion
399 whole: (int)whole;
400 - (void) getMouseMotionPart: (int *)part window: (Lisp_Object *)window
401 x: (Lisp_Object *)x y: ( Lisp_Object *)y;
402 - (void) sendScrollEventAtLoc: (float)loc fromEvent: (NSEvent *)e;
403 - repeatScroll: (NSTimer *)sender;
404 - condemn;
405 - reprieve;
406 - judge;
407 @end
410 /* ==========================================================================
412 Rendering
414 ========================================================================== */
416 #ifdef NS_IMPL_COCOA
417 /* rendering util */
418 @interface EmacsGlyphStorage : NSObject <NSGlyphStorage>
420 @public
421 NSAttributedString *attrStr;
422 NSMutableDictionary *dict;
423 CGGlyph *cglyphs;
424 unsigned long maxChar, maxGlyph;
425 long i, len;
427 - initWithCapacity: (unsigned long) c;
428 - (void) setString: (NSString *)str font: (NSFont *)font;
429 @end
430 #endif /* NS_IMPL_COCOA */
432 extern NSArray *ns_send_types, *ns_return_types;
433 extern NSString *ns_app_name;
434 extern EmacsMenu *mainMenu, *svcsMenu, *dockMenu;
436 /* Apple removed the declaration, but kept the implementation */
437 #if defined (NS_IMPL_COCOA)
438 @interface NSApplication (EmacsApp)
439 - (void)setAppleMenu: (NSMenu *)menu;
440 @end
441 #endif
443 #endif /* __OBJC__ */
447 /* ==========================================================================
449 Non-OO stuff
451 ========================================================================== */
453 /* Special keycodes that we pass down the event chain */
454 #define KEY_NS_POWER_OFF ((1<<28)|(0<<16)|1)
455 #define KEY_NS_OPEN_FILE ((1<<28)|(0<<16)|2)
456 #define KEY_NS_OPEN_TEMP_FILE ((1<<28)|(0<<16)|3)
457 #define KEY_NS_CHANGE_FONT ((1<<28)|(0<<16)|7)
458 #define KEY_NS_OPEN_FILE_LINE ((1<<28)|(0<<16)|8)
459 #define KEY_NS_PUT_WORKING_TEXT ((1<<28)|(0<<16)|9)
460 #define KEY_NS_UNPUT_WORKING_TEXT ((1<<28)|(0<<16)|10)
461 #define KEY_NS_SPI_SERVICE_CALL ((1<<28)|(0<<16)|11)
462 #define KEY_NS_NEW_FRAME ((1<<28)|(0<<16)|12)
463 #define KEY_NS_TOGGLE_TOOLBAR ((1<<28)|(0<<16)|13)
464 #define KEY_NS_SHOW_PREFS ((1<<28)|(0<<16)|14)
466 /* could use list to store these, but rest of emacs has a big infrastructure
467 for managing a table of bitmap "records" */
468 struct ns_bitmap_record
470 #ifdef __OBJC__
471 EmacsImage *img;
472 #else
473 void *img;
474 #endif
475 char *file;
476 int refcount;
477 int height, width, depth;
480 /* this to map between emacs color indices and NSColor objects */
481 struct ns_color_table
483 ptrdiff_t size;
484 ptrdiff_t avail;
485 #ifdef __OBJC__
486 NSColor **colors;
487 NSMutableSet *empty_indices;
488 #else
489 void **items;
490 void *availIndices;
491 #endif
493 #define NS_COLOR_CAPACITY 256
495 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
496 #define ARGB_TO_ULONG(a, r, g, b) (((a) << 24) | ((r) << 16) | ((g) << 8) | (b))
498 #define ALPHA_FROM_ULONG(color) ((color) >> 24)
499 #define RED_FROM_ULONG(color) (((color) >> 16) & 0xff)
500 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
501 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
503 /* Do not change `* 0x101' in the following lines to `<< 8'. If
504 changed, image masks in 1-bit depth will not work. */
505 #define RED16_FROM_ULONG(color) (RED_FROM_ULONG(color) * 0x101)
506 #define GREEN16_FROM_ULONG(color) (GREEN_FROM_ULONG(color) * 0x101)
507 #define BLUE16_FROM_ULONG(color) (BLUE_FROM_ULONG(color) * 0x101)
509 /* this extends font backend font */
510 struct nsfont_info
512 struct font font;
514 char *name; /* PostScript name, uniquely identifies on NS systems */
516 /* The following metrics are stored as float rather than int. */
518 float width; /* Maximum advance for the font. */
519 float height;
520 float underpos;
521 float underwidth;
522 float size;
523 #ifdef __OBJC__
524 NSFont *nsfont;
525 #if defined (NS_IMPL_COCOA)
526 CGFontRef cgfont;
527 #else /* GNUstep */
528 void *cgfont;
529 #endif
530 #else /* ! OBJC */
531 void *nsfont;
532 void *cgfont;
533 #endif
534 char bold, ital; /* convenience flags */
535 char synthItal;
536 XCharStruct max_bounds;
537 /* we compute glyph codes and metrics on-demand in blocks of 256 indexed
538 by hibyte, lobyte */
539 unsigned short **glyphs; /* map Unicode index to glyph */
540 struct font_metrics **metrics;
544 /* init'd in ns_initialize_display_info () */
545 struct ns_display_info
547 /* Chain of all ns_display_info structures. */
548 struct ns_display_info *next;
550 /* The generic display parameters corresponding to this NS display. */
551 struct terminal *terminal;
553 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE). */
554 Lisp_Object name_list_element;
556 /* The number of fonts loaded. */
557 int n_fonts;
559 /* Minimum width over all characters in all fonts in font_table. */
560 int smallest_char_width;
562 /* Minimum font height over all fonts in font_table. */
563 int smallest_font_height;
565 struct ns_bitmap_record *bitmaps;
566 ptrdiff_t bitmaps_size;
567 ptrdiff_t bitmaps_last;
569 struct ns_color_table *color_table;
571 /* DPI resolution of this screen */
572 double resx, resy;
574 /* Mask of things that cause the mouse to be grabbed */
575 int grabbed;
577 int n_planes;
579 int color_p;
581 Window root_window;
583 /* Xism */
584 XrmDatabase xrdb;
586 /* The cursor to use for vertical scroll bars. */
587 Cursor vertical_scroll_bar_cursor;
589 /* The cursor to use for horizontal scroll bars. */
590 Cursor horizontal_scroll_bar_cursor;
592 /* Information about the range of text currently shown in
593 mouse-face. */
594 Mouse_HLInfo mouse_highlight;
596 struct frame *x_highlight_frame;
597 struct frame *x_focus_frame;
599 /* The frame where the mouse was last time we reported a mouse event. */
600 struct frame *last_mouse_frame;
602 /* The frame where the mouse was last time we reported a mouse motion. */
603 struct frame *last_mouse_motion_frame;
605 /* Position where the mouse was last time we reported a motion.
606 This is a position on last_mouse_motion_frame. */
607 int last_mouse_motion_x;
608 int last_mouse_motion_y;
610 /* Where the mouse was last time we reported a mouse position. */
611 NSRect last_mouse_glyph;
613 /* Time of last mouse movement. */
614 Time last_mouse_movement_time;
616 /* The scroll bar in which the last motion event occurred. */
617 #ifdef __OBJC__
618 EmacsScroller *last_mouse_scroll_bar;
619 #else
620 void *last_mouse_scroll_bar;
621 #endif
624 /* This is a chain of structures for all the NS displays currently in use. */
625 extern struct ns_display_info *x_display_list;
627 extern struct ns_display_info *ns_display_info_for_name (Lisp_Object name);
629 struct ns_output
631 #ifdef __OBJC__
632 EmacsView *view;
633 id miniimage;
634 NSColor *cursor_color;
635 NSColor *foreground_color;
636 NSColor *background_color;
637 EmacsToolbar *toolbar;
638 #else
639 void *view;
640 void *miniimage;
641 void *cursor_color;
642 void *foreground_color;
643 void *background_color;
644 void *toolbar;
645 #endif
647 /* NSCursors init'ed in initFrameFromEmacs */
648 Cursor text_cursor;
649 Cursor nontext_cursor;
650 Cursor modeline_cursor;
651 Cursor hand_cursor;
652 Cursor hourglass_cursor;
653 Cursor horizontal_drag_cursor;
654 Cursor vertical_drag_cursor;
656 /* NS-specific */
657 Cursor current_pointer;
659 /* lord knows why Emacs needs to know about our Window ids.. */
660 Window window_desc, parent_desc;
661 char explicit_parent;
663 struct font *font;
664 int baseline_offset;
666 /* If a fontset is specified for this frame instead of font, this
667 value contains an ID of the fontset, else -1. */
668 int fontset; /* only used with font_backend */
670 Lisp_Object icon_top;
671 Lisp_Object icon_left;
673 /* The size of the extra width currently allotted for vertical
674 scroll bars, in pixels. */
675 int vertical_scroll_bar_extra;
677 /* The height of the titlebar decoration (included in NSWindow's frame). */
678 int titlebar_height;
680 /* The height of the toolbar if displayed, else 0. */
681 int toolbar_height;
683 /* This is the Emacs structure for the NS display this frame is on. */
684 struct ns_display_info *display_info;
686 /* Non-zero if we are zooming (maximizing) the frame. */
687 int zooming;
690 /* this dummy decl needed to support TTYs */
691 struct x_output
693 int unused;
697 /* This gives the ns_display_info structure for the display F is on. */
698 #define FRAME_DISPLAY_INFO(f) ((f)->output_data.ns->display_info)
699 #define FRAME_X_OUTPUT(f) ((f)->output_data.ns)
700 #define FRAME_NS_WINDOW(f) ((f)->output_data.ns->window_desc)
701 #define FRAME_X_WINDOW(f) ((f)->output_data.ns->window_desc)
703 /* This is the `Display *' which frame F is on. */
704 #define FRAME_NS_DISPLAY(f) (0)
705 #define FRAME_X_DISPLAY(f) (0)
706 #define FRAME_X_SCREEN(f) (0)
707 #define FRAME_X_VISUAL(f) FRAME_DISPLAY_INFO(f)->visual
709 #define FRAME_FOREGROUND_COLOR(f) ((f)->output_data.ns->foreground_color)
710 #define FRAME_BACKGROUND_COLOR(f) ((f)->output_data.ns->background_color)
712 #define NS_FACE_FOREGROUND(f) ((f)->foreground)
713 #define NS_FACE_BACKGROUND(f) ((f)->background)
714 #define FRAME_NS_TITLEBAR_HEIGHT(f) ((f)->output_data.ns->titlebar_height)
715 #define FRAME_TOOLBAR_HEIGHT(f) ((f)->output_data.ns->toolbar_height)
717 #define FRAME_DEFAULT_FACE(f) FACE_FROM_ID (f, DEFAULT_FACE_ID)
719 #define FRAME_NS_VIEW(f) ((f)->output_data.ns->view)
720 #define FRAME_CURSOR_COLOR(f) ((f)->output_data.ns->cursor_color)
721 #define FRAME_POINTER_TYPE(f) ((f)->output_data.ns->current_pointer)
723 #define FRAME_FONT(f) ((f)->output_data.ns->font)
725 #ifdef __OBJC__
726 #define XNS_SCROLL_BAR(vec) ((id) XSAVE_POINTER (vec, 0))
727 #else
728 #define XNS_SCROLL_BAR(vec) XSAVE_POINTER (vec, 0)
729 #endif
731 /* Compute pixel size for vertical scroll bars */
732 #define NS_SCROLL_BAR_WIDTH(f) \
733 (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
734 ? rint (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0 \
735 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f) \
736 : (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f))) \
737 : 0)
739 /* Compute pixel size for horizontal scroll bars */
740 #define NS_SCROLL_BAR_HEIGHT(f) \
741 (FRAME_HAS_HORIZONTAL_SCROLL_BARS (f) \
742 ? rint (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0 \
743 ? FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) \
744 : (FRAME_SCROLL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f))) \
745 : 0)
747 /* Difference btwn char-column-calculated and actual SB widths.
748 This is only a concern for rendering when SB on left. */
749 #define NS_SCROLL_BAR_ADJUST(w, f) \
750 (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w) ? \
751 (FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f) \
752 - NS_SCROLL_BAR_WIDTH (f)) : 0)
754 /* Difference btwn char-line-calculated and actual SB heights.
755 This is only a concern for rendering when SB on top. */
756 #define NS_SCROLL_BAR_ADJUST_HORIZONTALLY(w, f) \
757 (WINDOW_HAS_HORIZONTAL_SCROLL_BARS (w) ? \
758 (FRAME_SCROLL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f) \
759 - NS_SCROLL_BAR_HEIGHT (f)) : 0)
761 /* XXX: fix for GNUstep inconsistent accounting for titlebar */
762 #ifdef NS_IMPL_GNUSTEP
763 #define NS_TOP_POS(f) ((f)->top_pos + 18)
764 #else
765 #define NS_TOP_POS(f) ((f)->top_pos)
766 #endif
768 #define FRAME_NS_FONT_TABLE(f) (FRAME_DISPLAY_INFO (f)->font_table)
770 #define FRAME_FONTSET(f) ((f)->output_data.ns->fontset)
772 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.ns->baseline_offset)
773 #define BLACK_PIX_DEFAULT(f) 0x000000
774 #define WHITE_PIX_DEFAULT(f) 0xFFFFFF
776 /* First position where characters can be shown (instead of scrollbar, if
777 it is on left. */
778 #define FIRST_CHAR_POSITION(f) \
779 (! (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f)) ? 0 \
780 : FRAME_SCROLL_BAR_COLS (f))
782 extern struct ns_display_info *ns_term_init (Lisp_Object display_name);
783 extern void ns_term_shutdown (int sig);
785 /* constants for text rendering */
786 #define NS_DUMPGLYPH_NORMAL 0
787 #define NS_DUMPGLYPH_CURSOR 1
788 #define NS_DUMPGLYPH_FOREGROUND 2
789 #define NS_DUMPGLYPH_MOUSEFACE 3
793 /* In nsfont, called from fontset.c */
794 extern void nsfont_make_fontset_for_font (Lisp_Object name,
795 Lisp_Object font_object);
797 /* In nsfont, for debugging */
798 struct glyph_string;
799 void ns_dump_glyphstring (struct glyph_string *s);
801 /* Implemented in nsterm, published in or needed from nsfns. */
802 extern Lisp_Object Qfontsize;
803 extern Lisp_Object ns_list_fonts (struct frame *f, Lisp_Object pattern,
804 int size, int maxnames);
805 extern void ns_clear_frame (struct frame *f);
807 extern const char *ns_xlfd_to_fontname (const char *xlfd);
809 extern Lisp_Object ns_map_event_to_object (void);
810 #ifdef __OBJC__
811 extern Lisp_Object ns_string_from_pasteboard (id pb);
812 extern void ns_string_to_pasteboard (id pb, Lisp_Object str);
813 #endif
814 extern Lisp_Object ns_get_local_selection (Lisp_Object selection_name,
815 Lisp_Object target_type);
816 extern void nxatoms_of_nsselect (void);
817 extern int ns_lisp_to_cursor_type (Lisp_Object arg);
818 extern Lisp_Object ns_cursor_type_to_lisp (int arg);
819 extern void ns_set_name_as_filename (struct frame *f);
820 extern void ns_set_doc_edited (struct frame *f, Lisp_Object arg);
822 extern bool
823 ns_defined_color (struct frame *f,
824 const char *name,
825 XColor *color_def, bool alloc,
826 bool makeIndex);
827 extern void
828 ns_query_color (void *col, XColor *color_def, int setPixel);
830 #ifdef __OBJC__
831 extern Lisp_Object ns_color_to_lisp (NSColor *col);
832 extern int ns_lisp_to_color (Lisp_Object color, NSColor **col);
833 extern NSColor *ns_lookup_indexed_color (unsigned long idx, struct frame *f);
834 extern unsigned long ns_index_color (NSColor *color, struct frame *f);
835 extern void ns_free_indexed_color (unsigned long idx, struct frame *f);
836 extern const char *ns_get_pending_menu_title (void);
837 extern void ns_check_menu_open (NSMenu *menu);
838 extern void ns_check_pending_open_menu (void);
839 #endif
841 /* C access to ObjC functionality */
842 extern void ns_release_object (void *obj);
843 extern void ns_retain_object (void *obj);
844 extern void *ns_alloc_autorelease_pool (void);
845 extern void ns_release_autorelease_pool (void *);
846 extern const char *ns_get_defaults_value (const char *key);
848 /* in nsmenu */
849 extern void update_frame_tool_bar (struct frame *f);
850 extern void free_frame_tool_bar (struct frame *f);
851 extern void find_and_call_menu_selection (struct frame *f,
852 int menu_bar_items_used, Lisp_Object vector, void *client_data);
853 extern Lisp_Object find_and_return_menu_selection (struct frame *f,
854 bool keymaps,
855 void *client_data);
856 extern Lisp_Object ns_popup_dialog (struct frame *, Lisp_Object header,
857 Lisp_Object contents);
859 #define NSAPP_DATA2_RUNASSCRIPT 10
860 extern void ns_run_ascript (void);
862 #define NSAPP_DATA2_RUNFILEDIALOG 11
863 extern void ns_run_file_dialog (void);
865 extern const char *ns_etc_directory (void);
866 extern const char *ns_exec_path (void);
867 extern const char *ns_load_path (void);
868 extern void syms_of_nsterm (void);
869 extern void syms_of_nsfns (void);
870 extern void syms_of_nsmenu (void);
871 extern void syms_of_nsselect (void);
873 /* From nsimage.m, needed in image.c */
874 struct image;
875 extern void *ns_image_from_XBM (unsigned char *bits, int width, int height);
876 extern void *ns_image_for_XPM (int width, int height, int depth);
877 extern void *ns_image_from_file (Lisp_Object file);
878 extern bool ns_load_image (struct frame *f, struct image *img,
879 Lisp_Object spec_file, Lisp_Object spec_data);
880 extern int ns_image_width (void *img);
881 extern int ns_image_height (void *img);
882 extern unsigned long ns_get_pixel (void *img, int x, int y);
883 extern void ns_put_pixel (void *img, int x, int y, unsigned long argb);
884 extern void ns_set_alpha (void *img, int x, int y, unsigned char a);
886 extern int x_display_pixel_height (struct ns_display_info *);
887 extern int x_display_pixel_width (struct ns_display_info *);
889 /* This in nsterm.m */
890 extern void x_destroy_window (struct frame *f);
891 extern int ns_select (int nfds, fd_set *readfds, fd_set *writefds,
892 fd_set *exceptfds, struct timespec const *timeout,
893 sigset_t const *sigmask);
894 extern unsigned long ns_get_rgb_color (struct frame *f,
895 float r, float g, float b, float a);
897 extern void ns_init_events ();
898 extern void ns_finish_events ();
900 /* From nsterm.m, needed in nsfont.m. */
901 #ifdef __OBJC__
902 extern void
903 ns_draw_text_decoration (struct glyph_string *s, struct face *face,
904 NSColor *defaultCol, CGFloat width, CGFloat x);
905 #endif
907 #ifdef NS_IMPL_GNUSTEP
908 extern char gnustep_base_version[]; /* version tracking */
909 #endif
911 #define MINWIDTH 10
912 #define MINHEIGHT 10
914 /* Screen max coordinate
915 Using larger coordinates causes movewindow/placewindow to abort */
916 #define SCREENMAX 16000
918 #define NS_SCROLL_BAR_WIDTH_DEFAULT [EmacsScroller scrollerWidth]
919 #define NS_SCROLL_BAR_HEIGHT_DEFAULT [EmacsScroller scrollerHeight]
920 /* This is to match emacs on other platforms, ugly though it is. */
921 #define NS_SELECTION_BG_COLOR_DEFAULT @"LightGoldenrod2";
922 #define NS_SELECTION_FG_COLOR_DEFAULT @"Black";
923 #define RESIZE_HANDLE_SIZE 12
925 /* Little utility macros */
926 #define IN_BOUND(min, x, max) (((x) < (min)) \
927 ? (min) : (((x)>(max)) ? (max) : (x)))
928 #define SCREENMAXBOUND(x) (IN_BOUND (-SCREENMAX, x, SCREENMAX))
930 #endif /* HAVE_NS */