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)
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). */
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
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. */
76 /* Dots per inch of the screen. */
79 /* Number of planes on this screen. */
82 /* Whether the screen supports color */
86 /* Number of bits per pixel on this screen. */
90 /* Dimensions of this screen. */
93 int height_in
,width_in
;
96 /* Mask of things that cause the mouse to be grabbed. */
100 /* Emacs bitmap-id of the default icon bitmap for this frame.
101 Or -1 if none has been allocated yet. */
105 /* The root window of this screen. */
108 /* The cursor to use for vertical scroll bars. */
109 Cursor vertical_scroll_bar_cursor
;
111 /* Resource data base */
115 /* color palette information. */
117 struct w32_palette_entry
* color_list
;
121 /* deferred action flags checked when starting frame update. */
124 /* Keystroke that has been faked by Emacs and will be ignored when
125 received; value is reset after key is received. */
130 /* A table of all the fonts we have already loaded. */
131 struct font_info
*font_table
;
133 /* The current capacity of font_table. */
136 /* The number of fonts actually stored in the font table.
137 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
138 n_fonts <= font_table_size. and font_table[i].name != 0. */
141 /* Minimum width over all characters in all fonts in font_table. */
142 int smallest_char_width
;
144 /* Minimum font height over all fonts in font_table. */
145 int smallest_font_height
;
147 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
148 GC scratch_cursor_gc
;
150 /* These variables describe the range of text currently shown in its
151 mouse-face, together with the window they apply to. As long as
152 the mouse stays within this range, we need not redraw anything on
153 its account. Rows and columns are glyph matrix positions in
154 MOUSE_FACE_WINDOW. */
155 int mouse_face_beg_row
, mouse_face_beg_col
;
156 int mouse_face_beg_x
, mouse_face_beg_y
;
157 int mouse_face_end_row
, mouse_face_end_col
;
158 int mouse_face_end_x
, mouse_face_end_y
;
159 int mouse_face_past_end
;
160 Lisp_Object mouse_face_window
;
161 int mouse_face_face_id
;
162 Lisp_Object mouse_face_overlay
;
164 /* 1 if a mouse motion event came and we didn't handle it right away because
165 gc was in progress. */
166 int mouse_face_deferred_gc
;
168 /* FRAME and X, Y position of mouse when last checked for
169 highlighting. X and Y can be negative or out of range for the frame. */
170 struct frame
*mouse_face_mouse_frame
;
172 int mouse_face_mouse_x
, mouse_face_mouse_y
;
174 /* Nonzero means defer mouse-motion highlighting. */
175 int mouse_face_defer
;
177 /* Nonzero means that the mouse highlight should not be shown. */
178 int mouse_face_hidden
;
180 int mouse_face_image_state
;
184 /* Pointer to bitmap records. */
185 struct mac_bitmap_record
*bitmaps
;
187 /* Allocated size of bitmaps field. */
190 /* Last used bitmap index. */
193 /* The frame (if any) which has the window that has keyboard focus.
194 Zero if none. This is examined by Ffocus_frame in macfns.c. Note
195 that a mere EnterNotify event can set this; if you need to know the
196 last frame specified in a FocusIn or FocusOut event, use
197 x_focus_event_frame. */
198 struct frame
*x_focus_frame
;
200 /* The last frame mentioned in a FocusIn or FocusOut event. This is
201 separate from x_focus_frame, because whether or not LeaveNotify
202 events cause us to lose focus depends on whether or not we have
203 received a FocusIn event for it. */
204 struct frame
*x_focus_event_frame
;
206 /* The frame which currently has the visual highlight, and should get
207 keyboard input (other sorts of input have the frame encoded in the
208 event). It points to the focus frame's selected window's
209 frame. It differs from x_focus_frame when we're using a global
211 struct frame
*x_highlight_frame
;
213 /* Cache of images. */
214 struct image_cache
*image_cache
;
217 /* This checks to make sure we have a display. */
218 extern void check_mac
P_ ((void));
220 #define x_display_info mac_display_info
222 /* This is a chain of structures for all the X displays currently in use. */
223 extern struct x_display_info
*x_display_list
;
225 /* This is a chain of structures for all the displays currently in use. */
226 extern struct mac_display_info one_mac_display_info
;
228 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
229 one for each element of x_display_list and in the same order.
230 NAME is the name of the frame.
231 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
232 extern Lisp_Object x_display_name_list
;
234 /* A flag to control how to display unibyte 8-bit character. */
235 extern int unibyte_display_via_language_environment
;
237 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
238 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
240 extern struct mac_display_info
*mac_term_init ();
242 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
243 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
244 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
245 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
246 extern void x_find_ccl_program
P_ ((struct font_info
*));
248 /* When Emacs uses a tty window, tty_display in frame.c points to an
252 unsigned long background_pixel
;
253 unsigned long foreground_pixel
;
256 /* The collection of data describing a window on the Mac. */
258 /* Placeholder for things accessed through output_data.x. Must
260 struct x_output x_compatible
;
262 /* Menubar "widget" handle. */
265 Window mWP
; /* pointer to QuickDraw window */
266 FRAME_PTR mFP
; /* points back to the frame struct */
269 int mNumCols
; /* number of characters per column */
270 int mNumRows
; /* number of characters per row */
271 int mLineHeight
; /* height of one line of text in pixels */
272 int mCharWidth
; /* width of one character in pixels */
273 int mHomeX
; /* X pixel coordinate of lower left
274 corner of character at (0, 0) */
275 int mHomeY
; /* Y pixel coordinate of lower left
276 corner of character at (0, 0) */
277 int mHighlight
; /* current highlight state (0 = off). */
278 int mTermWinSize
; /* num of lines from top of window
279 affected by ins_del_lines; set by
280 set_terminal_window. */
284 /* stuffs used by xfaces.c */
285 struct face
**param_faces
;
287 struct face
**computed_faces
;
288 int n_computed_faces
;
289 int size_computed_faces
;
292 /* Here are the Graphics Contexts for the default font. */
293 GC normal_gc
; /* Normal video */
294 GC reverse_gc
; /* Reverse video */
295 GC cursor_gc
; /* cursor drawing */
297 /* The window used for this frame.
298 May be zero while the frame object is being created
299 and the window has not yet been created. */
302 /* The window that is the parent of this window.
303 Usually this is a window that was made by the window manager,
304 but it can be the root window, and it can be explicitly specified
305 (see the explicit_parent field, below). */
308 /* Default ASCII font of this frame. */
311 /* The baseline offset of the default ASCII font. */
314 /* If a fontset is specified for this frame instead of font, this
315 value contains an ID of the fontset, else -1. */
318 /* Pixel values used for various purposes.
319 border_pixel may be -1 meaning use a gray tile. */
320 unsigned long cursor_pixel
;
321 unsigned long border_pixel
;
322 unsigned long mouse_pixel
;
323 unsigned long cursor_foreground_pixel
;
325 /* Foreground color for scroll bars. A value of -1 means use the
326 default (black for non-toolkit scroll bars). */
327 unsigned long scroll_bar_foreground_pixel
;
329 /* Background color for scroll bars. A value of -1 means use the
330 default (background color of the frame for non-toolkit scroll
332 unsigned long scroll_bar_background_pixel
;
334 /* Descriptor for the cursor in use for this window. */
336 Cursor nontext_cursor
;
337 Cursor modeline_cursor
;
339 Cursor hourglass_cursor
;
340 Cursor horizontal_drag_cursor
;
342 /* Window whose cursor is hourglass_cursor. This window is temporarily
343 mapped to display a hourglass-cursor. */
344 Window hourglass_window
;
346 /* Non-zero means hourglass cursor is currently displayed. */
347 unsigned hourglass_p
: 1;
349 /* Flag to set when the window needs to be completely repainted. */
354 #if TARGET_API_MAC_CARBON
355 /* The Mac control reference for the hourglass (progress indicator)
356 shown at the upper-right corner of the window. */
357 ControlRef hourglass_control
;
364 /* This is the Emacs structure for the display this frame is on. */
365 /* struct w32_display_info *display_info; */
367 /* Nonzero means our parent is another application's window
368 and was explicitly specified. */
369 char explicit_parent
;
371 /* Nonzero means tried already to make this frame visible. */
372 char asked_for_visible
;
374 /* Nonzero means menubar is currently active. */
377 /* Nonzero means a menu command is being processed. */
378 char menu_command_in_progress
;
380 /* Nonzero means menubar is about to become active, but should be
381 brought up to date first. */
382 volatile char pending_menu_activation
;
384 /* Relief GCs, colors etc. */
391 black_relief
, white_relief
;
393 /* The background for which the above relief GCs were set up.
394 They are changed only when a different background is involved. */
395 unsigned long relief_background
;
397 /* Hints for the size and the position of a window. */
398 XSizeHints
*size_hints
;
401 typedef struct mac_output mac_output
;
403 /* Return the X output data for frame F. */
404 #define FRAME_X_OUTPUT(f) ((f)->output_data.mac)
406 /* Return the Mac window used for displaying data in frame F. */
407 #define FRAME_MAC_WINDOW(f) ((f)->output_data.mac->mWP)
408 #define FRAME_X_WINDOW(f) ((f)->output_data.mac->mWP)
410 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
411 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
413 #define FRAME_FONT(f) ((f)->output_data.mac->font)
414 #define FRAME_FONTSET(f) ((f)->output_data.mac->fontset)
416 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.mac->baseline_offset)
418 #define FRAME_SIZE_HINTS(f) ((f)->output_data.mac->size_hints)
420 /* This gives the mac_display_info structure for the display F is on. */
421 #define FRAME_MAC_DISPLAY_INFO(f) (&one_mac_display_info)
422 #define FRAME_X_DISPLAY_INFO(f) (&one_mac_display_info)
424 /* This is the `Display *' which frame F is on. */
425 #define FRAME_MAC_DISPLAY(f) (0)
426 #define FRAME_X_DISPLAY(f) (0)
428 /* This is the 'font_info *' which frame F has. */
429 #define FRAME_MAC_FONT_TABLE(f) (FRAME_MAC_DISPLAY_INFO (f)->font_table)
431 /* Value is the smallest width of any character in any font on frame F. */
433 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
434 FRAME_MAC_DISPLAY_INFO(F)->smallest_char_width
436 /* Value is the smallest height of any font on frame F. */
438 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
439 FRAME_MAC_DISPLAY_INFO(F)->smallest_font_height
441 /* Return a pointer to the image cache of frame F. */
443 #define FRAME_X_IMAGE_CACHE(F) FRAME_MAC_DISPLAY_INFO ((F))->image_cache
446 /* Mac-specific scroll bar stuff. */
448 /* We represent scroll bars as lisp vectors. This allows us to place
449 references to them in windows without worrying about whether we'll
450 end up with windows referring to dead scroll bars; the garbage
451 collector will free it when its time comes.
453 We use struct scroll_bar as a template for accessing fields of the
458 /* These fields are shared by all vectors. */
459 EMACS_INT size_from_Lisp_Vector_struct
;
460 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
462 /* The window we're a scroll bar for. */
465 /* The next and previous in the chain of scroll bars in this frame. */
466 Lisp_Object next
, prev
;
468 /* The Mac control handle of this scroll bar. Since this is a full
469 32-bit quantity, we store it split into two 32-bit values. */
470 Lisp_Object control_handle_low
, control_handle_high
;
472 /* The position and size of the scroll bar in pixels, relative to the
474 Lisp_Object top
, left
, width
, height
;
476 /* The starting and ending positions of the handle, relative to the
477 handle area (i.e. zero is the top position, not
478 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
479 hasn't been drawn yet.
481 These are not actually the locations where the beginning and end
482 are drawn; in order to keep handles from becoming invisible when
483 editing large files, we establish a minimum height by always
484 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
485 where they would be normally; the bottom and top are in a
486 different co-ordinate system. */
487 Lisp_Object start
, end
;
489 /* If the scroll bar handle is currently being dragged by the user,
490 this is the number of pixels from the top of the handle to the
491 place where the user grabbed it. If the handle isn't currently
492 being dragged, this is Qnil. */
493 Lisp_Object dragging
;
495 #ifdef USE_TOOLKIT_SCROLL_BARS
496 /* The position and size of the scroll bar handle track area in
497 pixels, relative to the frame. */
498 Lisp_Object track_top
, track_height
;
502 /* The number of elements a vector holding a struct scroll_bar needs. */
503 #define SCROLL_BAR_VEC_SIZE \
504 ((sizeof (struct scroll_bar) \
505 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
506 / sizeof (Lisp_Object))
508 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
509 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
512 /* Building a 32-bit C integer from two 16-bit lisp integers. */
513 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
515 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
516 #define SCROLL_BAR_UNPACK(low, high, int32) \
517 (XSETINT ((low), (int32) & 0xffff), \
518 XSETINT ((high), ((int32) >> 16) & 0xffff))
521 /* Extract the Mac control handle of the scroll bar from a struct
523 #define SCROLL_BAR_CONTROL_HANDLE(ptr) \
524 ((ControlHandle) SCROLL_BAR_PACK ((ptr)->control_handle_low, \
525 (ptr)->control_handle_high))
527 /* Store a Mac control handle in a struct scroll_bar. */
528 #define SET_SCROLL_BAR_CONTROL_HANDLE(ptr, id) \
529 (SCROLL_BAR_UNPACK ((ptr)->control_handle_low, \
530 (ptr)->control_handle_high, (int) id))
532 /* Return the inside width of a vertical scroll bar, given the outside
534 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
536 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
537 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
538 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
540 /* Return the length of the rectangle within which the top of the
541 handle must stay. This isn't equivalent to the inside height,
542 because the scroll bar handle has a minimum height.
544 This is the real range of motion for the scroll bar, so when we're
545 scaling buffer positions to scroll bar positions, we use this, not
546 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
547 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
548 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) \
549 - VERTICAL_SCROLL_BAR_MIN_HANDLE - UP_AND_DOWN_ARROWS)
551 /* Return the inside height of vertical scroll bar, given the outside
552 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
553 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
554 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER \
555 - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
558 /* Border widths for scroll bars.
560 Scroll bar windows don't have any borders; their border width is
561 set to zero, and we redraw borders ourselves. This makes the code
562 a bit cleaner, since we don't have to convert between outside width
563 (used when relating to the rest of the screen) and inside width
564 (used when sizing and drawing the scroll bar window itself).
566 The handle moves up and down/back and forth in a rectangle inset
567 from the edges of the scroll bar. These are widths by which we
568 inset the handle boundaries from the scroll bar edges. */
569 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
570 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
571 #define VERTICAL_SCROLL_BAR_TOP_BORDER (0)
572 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (0)
574 /* Minimum lengths for scroll bar handles, in pixels. */
575 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (16)
577 /* Combined length of up and down arrow boxes in scroll bars, in pixels. */
578 #define UP_AND_DOWN_ARROWS (32)
580 /* Trimming off a few pixels from each side prevents
581 text from glomming up against the scroll bar */
582 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
584 /* Size of hourglass controls */
585 #define HOURGLASS_WIDTH 16
586 #define HOURGLASS_HEIGHT 16
592 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
593 Lisp_Object
, Lisp_Object
,
594 Lisp_Object
, Lisp_Object
));
595 struct frame
*check_x_frame
P_ ((Lisp_Object
));
596 EXFUN (Fx_display_color_p
, 1);
597 EXFUN (Fx_display_grayscale_p
, 1);
598 EXFUN (Fx_display_planes
, 1);
599 extern void x_free_gcs
P_ ((struct frame
*));
600 extern int XParseGeometry
P_ ((char *, int *, int *, unsigned int *,
603 /* Defined in macterm.c. */
605 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
606 extern void x_make_frame_visible
P_ ((struct frame
*));
607 extern void mac_initialize
P_ ((void));
608 extern Pixmap XCreatePixmap
P_ ((Display
*, WindowPtr
, unsigned int,
609 unsigned int, unsigned int));
610 extern Pixmap XCreatePixmapFromBitmapData
P_ ((Display
*, WindowPtr
, char *,
611 unsigned int, unsigned int,
612 unsigned long, unsigned long,
614 extern void XFreePixmap
P_ ((Display
*, Pixmap
));
615 extern GC XCreateGC
P_ ((Display
*, Window
, unsigned long, XGCValues
*));
616 extern void XSetForeground
P_ ((Display
*, GC
, unsigned long));
617 extern void XSetBackground
P_ ((Display
*, GC
, unsigned long));
618 extern void XSetWindowBackground
P_ ((Display
*, WindowPtr
, unsigned long));
619 extern void mac_draw_line_to_pixmap
P_ ((Display
*, Pixmap
, GC
, int, int,
621 extern void mac_unload_font
P_ ((struct mac_display_info
*, XFontStruct
*));
622 extern OSErr install_window_handler
P_ ((WindowPtr
));
623 extern void remove_window_handler
P_ ((WindowPtr
));
625 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
626 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
628 /* Defined in macselect.c */
630 extern void x_clear_frame_selections
P_ ((struct frame
*));
632 /* Defined in mac.c. */
634 extern OSErr posix_pathname_to_fsspec
P_ ((const char *, FSSpec
*));
635 extern OSErr fsspec_to_posix_pathname
P_ ((const FSSpec
*, char *, int));
636 extern void mac_clear_font_name_table
P_ ((void));
637 #if TARGET_API_MAC_CARBON
638 extern CFStringRef cfstring_create_with_utf8_cstring
P_ ((const char *));
639 extern CFStringRef cfstring_create_with_string
P_ ((Lisp_Object
));
640 extern Lisp_Object cfdata_to_lisp
P_ ((CFDataRef
));
641 extern Lisp_Object cfstring_to_lisp
P_ ((CFStringRef
));
642 extern Lisp_Object cfnumber_to_lisp
P_ ((CFNumberRef
));
643 extern Lisp_Object cfdate_to_lisp
P_ ((CFDateRef
));
644 extern Lisp_Object cfboolean_to_lisp
P_ ((CFBooleanRef
));
645 extern Lisp_Object cfobject_desc_to_lisp
P_ ((CFTypeRef
));
646 extern Lisp_Object cfproperty_list_to_lisp
P_ ((CFPropertyListRef
, int, int));
648 extern void xrm_merge_string_database
P_ ((XrmDatabase
, char *));
649 extern Lisp_Object xrm_get_resource
P_ ((XrmDatabase
, char *, char *));
650 extern XrmDatabase xrm_get_preference_database
P_ ((char *));
652 /* arch-tag: 6b4ca125-5bef-476d-8ee8-31ed808b7e79
653 (do not change this comment) */