(Excursions): Replace arg `forms' with `body' in `save-excursion'.
[emacs.git] / src / macterm.h
blob277fd2051c6dd50a41835d968b21230a4dc411f9
1 /* Display module for Mac OS.
2 Copyright (C) 2000, 2001, 2002, 2003, 2004,
3 2005 Free Software Foundation, 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
22 /* Contributed by Andrew Choi (akochoi@mac.com). */
24 #include "macgui.h"
25 #include "frame.h"
27 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
29 #define RED_FROM_ULONG(color) ((color) >> 16)
30 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
31 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
33 /* Do not change `* 0x101' in the following lines to `<< 8'. If
34 changed, image masks in 1-bit depth will not work. */
35 #define RED16_FROM_ULONG(color) (RED_FROM_ULONG(color) * 0x101)
36 #define GREEN16_FROM_ULONG(color) (GREEN_FROM_ULONG(color) * 0x101)
37 #define BLUE16_FROM_ULONG(color) (BLUE_FROM_ULONG(color) * 0x101)
39 #define BLACK_PIX_DEFAULT(f) RGB_TO_ULONG(0,0,0)
40 #define WHITE_PIX_DEFAULT(f) RGB_TO_ULONG(255,255,255)
42 #define FONT_WIDTH(f) ((f)->max_bounds.width)
43 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
44 #define FONT_BASE(f) ((f)->ascent)
45 #define FONT_DESCENT(f) ((f)->descent)
47 #define FONT_MAX_WIDTH(f) FONT_WIDTH(f) /* fix later */
49 /* Structure recording bitmaps and reference count.
50 If REFCOUNT is 0 then this record is free to be reused. */
52 struct mac_bitmap_record
54 char *bitmap_data;
55 char *file;
56 int refcount;
57 int height, width;
61 /* For each display (currently only one on mac), we have a structure that
62 records information about it. */
64 struct mac_display_info
66 /* Chain of all mac_display_info structures. */
67 struct mac_display_info *next;
69 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
70 The same cons cell also appears in x_display_name_list. */
71 Lisp_Object name_list_element;
73 /* Number of frames that are on this display. */
74 int reference_count;
76 /* Dots per inch of the screen. */
77 double resx, resy;
79 /* Number of planes on this screen. */
80 int n_planes;
82 /* Whether the screen supports color */
83 int color_p;
85 /* Dimensions of this screen. */
86 int height, width;
88 /* Mask of things that cause the mouse to be grabbed. */
89 int grabbed;
91 #if 0
92 /* Emacs bitmap-id of the default icon bitmap for this frame.
93 Or -1 if none has been allocated yet. */
94 int icon_bitmap_id;
96 #endif
97 /* The root window of this screen. */
98 Window root_window;
100 /* The cursor to use for vertical scroll bars. */
101 Cursor vertical_scroll_bar_cursor;
103 /* Resource data base */
104 XrmDatabase xrdb;
106 /* A table of all the fonts we have already loaded. */
107 struct font_info *font_table;
109 /* The current capacity of font_table. */
110 int font_table_size;
112 /* Minimum width over all characters in all fonts in font_table. */
113 int smallest_char_width;
115 /* Minimum font height over all fonts in font_table. */
116 int smallest_font_height;
118 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
119 GC scratch_cursor_gc;
121 /* These variables describe the range of text currently shown in its
122 mouse-face, together with the window they apply to. As long as
123 the mouse stays within this range, we need not redraw anything on
124 its account. Rows and columns are glyph matrix positions in
125 MOUSE_FACE_WINDOW. */
126 int mouse_face_beg_row, mouse_face_beg_col;
127 int mouse_face_beg_x, mouse_face_beg_y;
128 int mouse_face_end_row, mouse_face_end_col;
129 int mouse_face_end_x, mouse_face_end_y;
130 int mouse_face_past_end;
131 Lisp_Object mouse_face_window;
132 int mouse_face_face_id;
133 Lisp_Object mouse_face_overlay;
135 /* 1 if a mouse motion event came and we didn't handle it right away because
136 gc was in progress. */
137 int mouse_face_deferred_gc;
139 /* FRAME and X, Y position of mouse when last checked for
140 highlighting. X and Y can be negative or out of range for the frame. */
141 struct frame *mouse_face_mouse_frame;
142 int mouse_face_mouse_x, mouse_face_mouse_y;
144 /* Nonzero means defer mouse-motion highlighting. */
145 int mouse_face_defer;
147 /* Nonzero means that the mouse highlight should not be shown. */
148 int mouse_face_hidden;
150 int mouse_face_image_state;
152 char *mac_id_name;
154 /* The number of fonts actually stored in the font table.
155 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
156 n_fonts <= font_table_size and font_table[i].name != 0. */
157 int n_fonts;
159 /* Pointer to bitmap records. */
160 struct mac_bitmap_record *bitmaps;
162 /* Allocated size of bitmaps field. */
163 int bitmaps_size;
165 /* Last used bitmap index. */
166 int bitmaps_last;
168 /* The frame (if any) which has the window that has keyboard focus.
169 Zero if none. This is examined by Ffocus_frame in macfns.c. Note
170 that a mere EnterNotify event can set this; if you need to know the
171 last frame specified in a FocusIn or FocusOut event, use
172 x_focus_event_frame. */
173 struct frame *x_focus_frame;
175 /* The last frame mentioned in a FocusIn or FocusOut event. This is
176 separate from x_focus_frame, because whether or not LeaveNotify
177 events cause us to lose focus depends on whether or not we have
178 received a FocusIn event for it. */
179 struct frame *x_focus_event_frame;
181 /* The frame which currently has the visual highlight, and should get
182 keyboard input (other sorts of input have the frame encoded in the
183 event). It points to the focus frame's selected window's
184 frame. It differs from x_focus_frame when we're using a global
185 minibuffer. */
186 struct frame *x_highlight_frame;
188 /* Cache of images. */
189 struct image_cache *image_cache;
192 /* This checks to make sure we have a display. */
193 extern void check_mac P_ ((void));
195 #define x_display_info mac_display_info
197 /* This is a chain of structures for all the X displays currently in use. */
198 extern struct x_display_info *x_display_list;
200 /* This is a chain of structures for all the displays currently in use. */
201 extern struct mac_display_info one_mac_display_info;
203 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
204 one for each element of x_display_list and in the same order.
205 NAME is the name of the frame.
206 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
207 extern Lisp_Object x_display_name_list;
209 /* A flag to control how to display unibyte 8-bit character. */
210 extern int unibyte_display_via_language_environment;
212 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
213 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
215 extern struct mac_display_info *mac_term_init P_ ((Lisp_Object, char *, char *));
217 extern Lisp_Object x_list_fonts P_ ((struct frame *, Lisp_Object, int, int));
218 extern struct font_info *x_get_font_info P_ ((struct frame *f, int));
219 extern struct font_info *x_load_font P_ ((struct frame *, char *, int));
220 extern struct font_info *x_query_font P_ ((struct frame *, char *));
221 extern void x_find_ccl_program P_ ((struct font_info *));
223 /* When Emacs uses a tty window, tty_display in frame.c points to an
224 x_output struct . */
225 struct x_output
227 unsigned long background_pixel;
228 unsigned long foreground_pixel;
231 /* The collection of data describing a window on the Mac. */
232 struct mac_output {
233 /* Placeholder for things accessed through output_data.x. Must
234 appear first. */
235 struct x_output x_compatible;
237 /* Menubar "widget" handle. */
238 int menubar_widget;
240 FRAME_PTR mFP; /* points back to the frame struct */
242 /* Here are the Graphics Contexts for the default font. */
243 GC normal_gc; /* Normal video */
244 GC reverse_gc; /* Reverse video */
245 GC cursor_gc; /* cursor drawing */
247 /* The window used for this frame.
248 May be zero while the frame object is being created
249 and the window has not yet been created. */
250 Window window_desc;
252 /* The window that is the parent of this window.
253 Usually this is a window that was made by the window manager,
254 but it can be the root window, and it can be explicitly specified
255 (see the explicit_parent field, below). */
256 Window parent_desc;
258 /* Default ASCII font of this frame. */
259 XFontStruct *font;
261 /* The baseline offset of the default ASCII font. */
262 int baseline_offset;
264 /* If a fontset is specified for this frame instead of font, this
265 value contains an ID of the fontset, else -1. */
266 int fontset;
268 /* Pixel values used for various purposes.
269 border_pixel may be -1 meaning use a gray tile. */
270 unsigned long cursor_pixel;
271 unsigned long border_pixel;
272 unsigned long mouse_pixel;
273 unsigned long cursor_foreground_pixel;
275 #if 0
276 /* Foreground color for scroll bars. A value of -1 means use the
277 default (black for non-toolkit scroll bars). */
278 unsigned long scroll_bar_foreground_pixel;
280 /* Background color for scroll bars. A value of -1 means use the
281 default (background color of the frame for non-toolkit scroll
282 bars). */
283 unsigned long scroll_bar_background_pixel;
284 #endif
286 /* Descriptor for the cursor in use for this window. */
287 Cursor text_cursor;
288 Cursor nontext_cursor;
289 Cursor modeline_cursor;
290 Cursor hand_cursor;
291 Cursor hourglass_cursor;
292 Cursor horizontal_drag_cursor;
293 #if 0
294 /* Window whose cursor is hourglass_cursor. This window is temporarily
295 mapped to display a hourglass-cursor. */
296 Window hourglass_window;
298 /* Non-zero means hourglass cursor is currently displayed. */
299 unsigned hourglass_p : 1;
301 /* Flag to set when the window needs to be completely repainted. */
302 int needs_exposure;
304 #endif
306 #if TARGET_API_MAC_CARBON
307 /* The Mac control reference for the hourglass (progress indicator)
308 shown at the upper-right corner of the window. */
309 ControlRef hourglass_control;
310 #endif
312 /* This is the Emacs structure for the display this frame is on. */
313 /* struct w32_display_info *display_info; */
315 /* Nonzero means our parent is another application's window
316 and was explicitly specified. */
317 char explicit_parent;
319 /* Nonzero means tried already to make this frame visible. */
320 char asked_for_visible;
322 /* Nonzero means menubar is currently active. */
323 char menubar_active;
325 /* Nonzero means a menu command is being processed. */
326 char menu_command_in_progress;
328 /* Relief GCs, colors etc. */
329 struct relief
331 GC gc;
332 unsigned long pixel;
333 int allocated_p;
335 black_relief, white_relief;
337 /* The background for which the above relief GCs were set up.
338 They are changed only when a different background is involved. */
339 unsigned long relief_background;
341 /* Hints for the size and the position of a window. */
342 XSizeHints *size_hints;
345 typedef struct mac_output mac_output;
347 /* Return the X output data for frame F. */
348 #define FRAME_X_OUTPUT(f) ((f)->output_data.mac)
350 /* Return the Mac window used for displaying data in frame F. */
351 #define FRAME_MAC_WINDOW(f) ((f)->output_data.mac->window_desc)
352 #define FRAME_X_WINDOW(f) ((f)->output_data.mac->window_desc)
354 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
355 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
357 #define FRAME_FONT(f) ((f)->output_data.mac->font)
358 #define FRAME_FONTSET(f) ((f)->output_data.mac->fontset)
360 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.mac->baseline_offset)
362 #define FRAME_SIZE_HINTS(f) ((f)->output_data.mac->size_hints)
364 /* This gives the mac_display_info structure for the display F is on. */
365 #define FRAME_MAC_DISPLAY_INFO(f) (&one_mac_display_info)
366 #define FRAME_X_DISPLAY_INFO(f) (&one_mac_display_info)
368 /* This is the `Display *' which frame F is on. */
369 #define FRAME_MAC_DISPLAY(f) (0)
370 #define FRAME_X_DISPLAY(f) (0)
372 /* This is the 'font_info *' which frame F has. */
373 #define FRAME_MAC_FONT_TABLE(f) (FRAME_MAC_DISPLAY_INFO (f)->font_table)
375 /* Value is the smallest width of any character in any font on frame F. */
377 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
378 FRAME_MAC_DISPLAY_INFO(F)->smallest_char_width
380 /* Value is the smallest height of any font on frame F. */
382 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
383 FRAME_MAC_DISPLAY_INFO(F)->smallest_font_height
385 /* Return a pointer to the image cache of frame F. */
387 #define FRAME_X_IMAGE_CACHE(F) FRAME_MAC_DISPLAY_INFO ((F))->image_cache
390 /* Mac-specific scroll bar stuff. */
392 /* We represent scroll bars as lisp vectors. This allows us to place
393 references to them in windows without worrying about whether we'll
394 end up with windows referring to dead scroll bars; the garbage
395 collector will free it when its time comes.
397 We use struct scroll_bar as a template for accessing fields of the
398 vector. */
400 struct scroll_bar {
402 /* These fields are shared by all vectors. */
403 EMACS_INT size_from_Lisp_Vector_struct;
404 struct Lisp_Vector *next_from_Lisp_Vector_struct;
406 /* The window we're a scroll bar for. */
407 Lisp_Object window;
409 /* The next and previous in the chain of scroll bars in this frame. */
410 Lisp_Object next, prev;
412 /* The Mac control handle of this scroll bar. Since this is a full
413 32-bit quantity, we store it split into two 32-bit values. */
414 Lisp_Object control_handle_low, control_handle_high;
416 /* The position and size of the scroll bar in pixels, relative to the
417 frame. */
418 Lisp_Object top, left, width, height;
420 /* The starting and ending positions of the handle, relative to the
421 handle area (i.e. zero is the top position, not
422 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
423 hasn't been drawn yet.
425 These are not actually the locations where the beginning and end
426 are drawn; in order to keep handles from becoming invisible when
427 editing large files, we establish a minimum height by always
428 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
429 where they would be normally; the bottom and top are in a
430 different co-ordinate system. */
431 Lisp_Object start, end;
433 /* If the scroll bar handle is currently being dragged by the user,
434 this is the number of pixels from the top of the handle to the
435 place where the user grabbed it. If the handle isn't currently
436 being dragged, this is Qnil. */
437 Lisp_Object dragging;
439 #ifdef USE_TOOLKIT_SCROLL_BARS
440 /* The position and size of the scroll bar handle track area in
441 pixels, relative to the frame. */
442 Lisp_Object track_top, track_height;
443 #endif
446 /* The number of elements a vector holding a struct scroll_bar needs. */
447 #define SCROLL_BAR_VEC_SIZE \
448 ((sizeof (struct scroll_bar) \
449 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
450 / sizeof (Lisp_Object))
452 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
453 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
456 /* Building a 32-bit C integer from two 16-bit lisp integers. */
457 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
459 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
460 #define SCROLL_BAR_UNPACK(low, high, int32) \
461 (XSETINT ((low), (int32) & 0xffff), \
462 XSETINT ((high), ((int32) >> 16) & 0xffff))
465 /* Extract the Mac control handle of the scroll bar from a struct
466 scroll_bar. */
467 #define SCROLL_BAR_CONTROL_HANDLE(ptr) \
468 ((ControlHandle) SCROLL_BAR_PACK ((ptr)->control_handle_low, \
469 (ptr)->control_handle_high))
471 /* Store a Mac control handle in a struct scroll_bar. */
472 #define SET_SCROLL_BAR_CONTROL_HANDLE(ptr, id) \
473 (SCROLL_BAR_UNPACK ((ptr)->control_handle_low, \
474 (ptr)->control_handle_high, (int) id))
476 /* Return the inside width of a vertical scroll bar, given the outside
477 width. */
478 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f, width) \
479 ((width) \
480 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
481 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
482 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
484 /* Return the length of the rectangle within which the top of the
485 handle must stay. This isn't equivalent to the inside height,
486 because the scroll bar handle has a minimum height.
488 This is the real range of motion for the scroll bar, so when we're
489 scaling buffer positions to scroll bar positions, we use this, not
490 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
491 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
492 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) \
493 - VERTICAL_SCROLL_BAR_MIN_HANDLE - UP_AND_DOWN_ARROWS)
495 /* Return the inside height of vertical scroll bar, given the outside
496 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
497 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
498 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER \
499 - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
502 /* Border widths for scroll bars.
504 Scroll bar windows don't have any borders; their border width is
505 set to zero, and we redraw borders ourselves. This makes the code
506 a bit cleaner, since we don't have to convert between outside width
507 (used when relating to the rest of the screen) and inside width
508 (used when sizing and drawing the scroll bar window itself).
510 The handle moves up and down/back and forth in a rectangle inset
511 from the edges of the scroll bar. These are widths by which we
512 inset the handle boundaries from the scroll bar edges. */
513 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
514 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
515 #define VERTICAL_SCROLL_BAR_TOP_BORDER (0)
516 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (0)
518 /* Minimum lengths for scroll bar handles, in pixels. */
519 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (16)
521 /* Combined length of up and down arrow boxes in scroll bars, in pixels. */
522 #define UP_AND_DOWN_ARROWS (32)
524 /* Trimming off a few pixels from each side prevents
525 text from glomming up against the scroll bar */
526 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
528 /* Size of hourglass controls */
529 #define HOURGLASS_WIDTH 16
530 #define HOURGLASS_HEIGHT 16
532 struct frame;
533 struct face;
534 struct image;
536 Lisp_Object display_x_get_resource P_ ((struct x_display_info *,
537 Lisp_Object, Lisp_Object,
538 Lisp_Object, Lisp_Object));
539 struct frame *check_x_frame P_ ((Lisp_Object));
540 EXFUN (Fx_display_color_p, 1);
541 EXFUN (Fx_display_grayscale_p, 1);
542 EXFUN (Fx_display_planes, 1);
543 extern void x_free_gcs P_ ((struct frame *));
544 extern int XParseGeometry P_ ((char *, int *, int *, unsigned int *,
545 unsigned int *));
547 /* Defined in macterm.c. */
549 extern void x_set_window_size P_ ((struct frame *, int, int, int));
550 extern void x_make_frame_visible P_ ((struct frame *));
551 extern void mac_initialize P_ ((void));
552 extern Pixmap XCreatePixmap P_ ((Display *, WindowPtr, unsigned int,
553 unsigned int, unsigned int));
554 extern Pixmap XCreatePixmapFromBitmapData P_ ((Display *, WindowPtr, char *,
555 unsigned int, unsigned int,
556 unsigned long, unsigned long,
557 unsigned int));
558 extern void XFreePixmap P_ ((Display *, Pixmap));
559 extern GC XCreateGC P_ ((Display *, Window, unsigned long, XGCValues *));
560 extern void XSetForeground P_ ((Display *, GC, unsigned long));
561 extern void XSetBackground P_ ((Display *, GC, unsigned long));
562 extern void XSetWindowBackground P_ ((Display *, WindowPtr, unsigned long));
563 extern void mac_draw_line_to_pixmap P_ ((Display *, Pixmap, GC, int, int,
564 int, int));
565 extern void mac_clear_area P_ ((struct frame *, int, int,
566 unsigned int, unsigned int));
567 extern void mac_unload_font P_ ((struct mac_display_info *, XFontStruct *));
568 extern OSErr install_window_handler P_ ((WindowPtr));
569 extern void remove_window_handler P_ ((WindowPtr));
571 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
572 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
574 /* Defined in macselect.c */
576 extern void x_clear_frame_selections P_ ((struct frame *));
578 /* Defined in mac.c. */
580 extern OSErr posix_pathname_to_fsspec P_ ((const char *, FSSpec *));
581 extern OSErr fsspec_to_posix_pathname P_ ((const FSSpec *, char *, int));
582 extern void mac_clear_font_name_table P_ ((void));
583 #if TARGET_API_MAC_CARBON
584 extern CFStringRef cfstring_create_with_utf8_cstring P_ ((const char *));
585 extern CFStringRef cfstring_create_with_string P_ ((Lisp_Object));
586 extern Lisp_Object cfdata_to_lisp P_ ((CFDataRef));
587 extern Lisp_Object cfstring_to_lisp P_ ((CFStringRef));
588 extern Lisp_Object cfnumber_to_lisp P_ ((CFNumberRef));
589 extern Lisp_Object cfdate_to_lisp P_ ((CFDateRef));
590 extern Lisp_Object cfboolean_to_lisp P_ ((CFBooleanRef));
591 extern Lisp_Object cfobject_desc_to_lisp P_ ((CFTypeRef));
592 extern Lisp_Object cfproperty_list_to_lisp P_ ((CFPropertyListRef, int, int));
593 #endif
594 extern void xrm_merge_string_database P_ ((XrmDatabase, char *));
595 extern Lisp_Object xrm_get_resource P_ ((XrmDatabase, char *, char *));
596 extern XrmDatabase xrm_get_preference_database P_ ((char *));
598 /* arch-tag: 6b4ca125-5bef-476d-8ee8-31ed808b7e79
599 (do not change this comment) */