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 /* A black pixel in a mask bitmap/pixmap means ``draw a source
43 pixel''. A white pixel means ``retain the current pixel''. */
44 #define PIX_MASK_DRAW(f) BLACK_PIX_DEFAULT(f)
45 #define PIX_MASK_RETAIN(f) WHITE_PIX_DEFAULT(f)
47 #define FONT_WIDTH(f) ((f)->max_bounds.width)
48 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
49 #define FONT_BASE(f) ((f)->ascent)
50 #define FONT_DESCENT(f) ((f)->descent)
52 #define FONT_MAX_WIDTH(f) FONT_WIDTH(f) /* fix later */
54 /* Structure recording bitmaps and reference count.
55 If REFCOUNT is 0 then this record is free to be reused. */
57 struct mac_bitmap_record
66 /* For each display (currently only one on mac), we have a structure that
67 records information about it. */
69 struct mac_display_info
71 /* Chain of all mac_display_info structures. */
72 struct mac_display_info
*next
;
74 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
75 The same cons cell also appears in x_display_name_list. */
76 Lisp_Object name_list_element
;
78 /* Number of frames that are on this display. */
81 /* Dots per inch of the screen. */
84 /* Number of planes on this screen. */
87 /* Whether the screen supports color */
91 /* Number of bits per pixel on this screen. */
95 /* Dimensions of this screen. */
98 int height_in
,width_in
;
101 /* Mask of things that cause the mouse to be grabbed. */
105 /* Emacs bitmap-id of the default icon bitmap for this frame.
106 Or -1 if none has been allocated yet. */
110 /* The root window of this screen. */
113 /* The cursor to use for vertical scroll bars. */
114 Cursor vertical_scroll_bar_cursor
;
116 /* Resource data base */
120 /* color palette information. */
122 struct w32_palette_entry
* color_list
;
126 /* deferred action flags checked when starting frame update. */
129 /* Keystroke that has been faked by Emacs and will be ignored when
130 received; value is reset after key is received. */
135 /* A table of all the fonts we have already loaded. */
136 struct font_info
*font_table
;
138 /* The current capacity of font_table. */
141 /* The number of fonts actually stored in the font table.
142 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
143 n_fonts <= font_table_size. and font_table[i].name != 0. */
146 /* Minimum width over all characters in all fonts in font_table. */
147 int smallest_char_width
;
149 /* Minimum font height over all fonts in font_table. */
150 int smallest_font_height
;
152 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
153 GC scratch_cursor_gc
;
155 /* These variables describe the range of text currently shown in its
156 mouse-face, together with the window they apply to. As long as
157 the mouse stays within this range, we need not redraw anything on
158 its account. Rows and columns are glyph matrix positions in
159 MOUSE_FACE_WINDOW. */
160 int mouse_face_beg_row
, mouse_face_beg_col
;
161 int mouse_face_beg_x
, mouse_face_beg_y
;
162 int mouse_face_end_row
, mouse_face_end_col
;
163 int mouse_face_end_x
, mouse_face_end_y
;
164 int mouse_face_past_end
;
165 Lisp_Object mouse_face_window
;
166 int mouse_face_face_id
;
167 Lisp_Object mouse_face_overlay
;
169 /* 1 if a mouse motion event came and we didn't handle it right away because
170 gc was in progress. */
171 int mouse_face_deferred_gc
;
173 /* FRAME and X, Y position of mouse when last checked for
174 highlighting. X and Y can be negative or out of range for the frame. */
175 struct frame
*mouse_face_mouse_frame
;
177 int mouse_face_mouse_x
, mouse_face_mouse_y
;
179 /* Nonzero means defer mouse-motion highlighting. */
180 int mouse_face_defer
;
182 /* Nonzero means that the mouse highlight should not be shown. */
183 int mouse_face_hidden
;
185 int mouse_face_image_state
;
189 /* Pointer to bitmap records. */
190 struct mac_bitmap_record
*bitmaps
;
192 /* Allocated size of bitmaps field. */
195 /* Last used bitmap index. */
198 /* The frame (if any) which has the window that has keyboard focus.
199 Zero if none. This is examined by Ffocus_frame in macfns.c. Note
200 that a mere EnterNotify event can set this; if you need to know the
201 last frame specified in a FocusIn or FocusOut event, use
202 x_focus_event_frame. */
203 struct frame
*x_focus_frame
;
205 /* The last frame mentioned in a FocusIn or FocusOut event. This is
206 separate from x_focus_frame, because whether or not LeaveNotify
207 events cause us to lose focus depends on whether or not we have
208 received a FocusIn event for it. */
209 struct frame
*x_focus_event_frame
;
211 /* The frame which currently has the visual highlight, and should get
212 keyboard input (other sorts of input have the frame encoded in the
213 event). It points to the focus frame's selected window's
214 frame. It differs from x_focus_frame when we're using a global
216 struct frame
*x_highlight_frame
;
218 /* Cache of images. */
219 struct image_cache
*image_cache
;
222 /* This checks to make sure we have a display. */
223 extern void check_mac
P_ ((void));
225 #define x_display_info mac_display_info
227 /* This is a chain of structures for all the X displays currently in use. */
228 extern struct x_display_info
*x_display_list
;
230 /* This is a chain of structures for all the displays currently in use. */
231 extern struct mac_display_info one_mac_display_info
;
233 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
234 one for each element of x_display_list and in the same order.
235 NAME is the name of the frame.
236 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
237 extern Lisp_Object x_display_name_list
;
239 /* A flag to control how to display unibyte 8-bit character. */
240 extern int unibyte_display_via_language_environment
;
242 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
243 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
245 extern struct mac_display_info
*mac_term_init ();
247 extern Lisp_Object x_list_fonts
P_ ((struct frame
*, Lisp_Object
, int, int));
248 extern struct font_info
*x_get_font_info
P_ ((struct frame
*f
, int));
249 extern struct font_info
*x_load_font
P_ ((struct frame
*, char *, int));
250 extern struct font_info
*x_query_font
P_ ((struct frame
*, char *));
251 extern void x_find_ccl_program
P_ ((struct font_info
*));
253 /* When Emacs uses a tty window, tty_display in frame.c points to an
257 unsigned long background_pixel
;
258 unsigned long foreground_pixel
;
261 /* The collection of data describing a window on the Mac. */
263 /* Placeholder for things accessed through output_data.x. Must
265 struct x_output x_compatible
;
267 /* Menubar "widget" handle. */
270 Window mWP
; /* pointer to QuickDraw window */
271 FRAME_PTR mFP
; /* points back to the frame struct */
274 int mNumCols
; /* number of characters per column */
275 int mNumRows
; /* number of characters per row */
276 int mLineHeight
; /* height of one line of text in pixels */
277 int mCharWidth
; /* width of one character in pixels */
278 int mHomeX
; /* X pixel coordinate of lower left
279 corner of character at (0, 0) */
280 int mHomeY
; /* Y pixel coordinate of lower left
281 corner of character at (0, 0) */
282 int mHighlight
; /* current highlight state (0 = off). */
283 int mTermWinSize
; /* num of lines from top of window
284 affected by ins_del_lines; set by
285 set_terminal_window. */
289 /* stuffs used by xfaces.c */
290 struct face
**param_faces
;
292 struct face
**computed_faces
;
293 int n_computed_faces
;
294 int size_computed_faces
;
297 /* Here are the Graphics Contexts for the default font. */
298 GC normal_gc
; /* Normal video */
299 GC reverse_gc
; /* Reverse video */
300 GC cursor_gc
; /* cursor drawing */
302 /* The window used for this frame.
303 May be zero while the frame object is being created
304 and the window has not yet been created. */
307 /* The window that is the parent of this window.
308 Usually this is a window that was made by the window manager,
309 but it can be the root window, and it can be explicitly specified
310 (see the explicit_parent field, below). */
313 /* Default ASCII font of this frame. */
316 /* The baseline offset of the default ASCII font. */
319 /* If a fontset is specified for this frame instead of font, this
320 value contains an ID of the fontset, else -1. */
323 /* Pixel values used for various purposes.
324 border_pixel may be -1 meaning use a gray tile. */
325 unsigned long cursor_pixel
;
326 unsigned long border_pixel
;
327 unsigned long mouse_pixel
;
328 unsigned long cursor_foreground_pixel
;
330 /* Foreground color for scroll bars. A value of -1 means use the
331 default (black for non-toolkit scroll bars). */
332 unsigned long scroll_bar_foreground_pixel
;
334 /* Background color for scroll bars. A value of -1 means use the
335 default (background color of the frame for non-toolkit scroll
337 unsigned long scroll_bar_background_pixel
;
339 /* Descriptor for the cursor in use for this window. */
341 Cursor nontext_cursor
;
342 Cursor modeline_cursor
;
344 Cursor hourglass_cursor
;
345 Cursor horizontal_drag_cursor
;
347 /* Window whose cursor is hourglass_cursor. This window is temporarily
348 mapped to display a hourglass-cursor. */
349 Window hourglass_window
;
351 /* Non-zero means hourglass cursor is currently displayed. */
352 unsigned hourglass_p
: 1;
354 /* Flag to set when the window needs to be completely repainted. */
359 #if TARGET_API_MAC_CARBON
360 /* The Mac control reference for the hourglass (progress indicator)
361 shown at the upper-right corner of the window. */
362 ControlRef hourglass_control
;
369 /* This is the Emacs structure for the display this frame is on. */
370 /* struct w32_display_info *display_info; */
372 /* Nonzero means our parent is another application's window
373 and was explicitly specified. */
374 char explicit_parent
;
376 /* Nonzero means tried already to make this frame visible. */
377 char asked_for_visible
;
379 /* Nonzero means menubar is currently active. */
382 /* Nonzero means a menu command is being processed. */
383 char menu_command_in_progress
;
385 /* Nonzero means menubar is about to become active, but should be
386 brought up to date first. */
387 volatile char pending_menu_activation
;
389 /* Relief GCs, colors etc. */
396 black_relief
, white_relief
;
398 /* The background for which the above relief GCs were set up.
399 They are changed only when a different background is involved. */
400 unsigned long relief_background
;
402 /* Hints for the size and the position of a window. */
403 XSizeHints
*size_hints
;
406 typedef struct mac_output mac_output
;
408 /* Return the X output data for frame F. */
409 #define FRAME_X_OUTPUT(f) ((f)->output_data.mac)
411 /* Return the Mac window used for displaying data in frame F. */
412 #define FRAME_MAC_WINDOW(f) ((f)->output_data.mac->mWP)
413 #define FRAME_X_WINDOW(f) ((f)->output_data.mac->mWP)
415 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
416 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
418 #define FRAME_FONT(f) ((f)->output_data.mac->font)
419 #define FRAME_FONTSET(f) ((f)->output_data.mac->fontset)
421 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.mac->baseline_offset)
423 #define FRAME_SIZE_HINTS(f) ((f)->output_data.mac->size_hints)
425 /* This gives the mac_display_info structure for the display F is on. */
426 #define FRAME_MAC_DISPLAY_INFO(f) (&one_mac_display_info)
427 #define FRAME_X_DISPLAY_INFO(f) (&one_mac_display_info)
429 /* This is the `Display *' which frame F is on. */
430 #define FRAME_MAC_DISPLAY(f) (0)
431 #define FRAME_X_DISPLAY(f) (0)
433 /* This is the 'font_info *' which frame F has. */
434 #define FRAME_MAC_FONT_TABLE(f) (FRAME_MAC_DISPLAY_INFO (f)->font_table)
436 /* Value is the smallest width of any character in any font on frame F. */
438 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
439 FRAME_MAC_DISPLAY_INFO(F)->smallest_char_width
441 /* Value is the smallest height of any font on frame F. */
443 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
444 FRAME_MAC_DISPLAY_INFO(F)->smallest_font_height
446 /* Return a pointer to the image cache of frame F. */
448 #define FRAME_X_IMAGE_CACHE(F) FRAME_MAC_DISPLAY_INFO ((F))->image_cache
451 /* Mac-specific scroll bar stuff. */
453 /* We represent scroll bars as lisp vectors. This allows us to place
454 references to them in windows without worrying about whether we'll
455 end up with windows referring to dead scroll bars; the garbage
456 collector will free it when its time comes.
458 We use struct scroll_bar as a template for accessing fields of the
463 /* These fields are shared by all vectors. */
464 EMACS_INT size_from_Lisp_Vector_struct
;
465 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
467 /* The window we're a scroll bar for. */
470 /* The next and previous in the chain of scroll bars in this frame. */
471 Lisp_Object next
, prev
;
473 /* The Mac control handle of this scroll bar. Since this is a full
474 32-bit quantity, we store it split into two 32-bit values. */
475 Lisp_Object control_handle_low
, control_handle_high
;
477 /* The position and size of the scroll bar in pixels, relative to the
479 Lisp_Object top
, left
, width
, height
;
481 /* The starting and ending positions of the handle, relative to the
482 handle area (i.e. zero is the top position, not
483 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
484 hasn't been drawn yet.
486 These are not actually the locations where the beginning and end
487 are drawn; in order to keep handles from becoming invisible when
488 editing large files, we establish a minimum height by always
489 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
490 where they would be normally; the bottom and top are in a
491 different co-ordinate system. */
492 Lisp_Object start
, end
;
494 /* If the scroll bar handle is currently being dragged by the user,
495 this is the number of pixels from the top of the handle to the
496 place where the user grabbed it. If the handle isn't currently
497 being dragged, this is Qnil. */
498 Lisp_Object dragging
;
500 #ifdef USE_TOOLKIT_SCROLL_BARS
501 /* The position and size of the scroll bar handle track area in
502 pixels, relative to the frame. */
503 Lisp_Object track_top
, track_height
;
507 /* The number of elements a vector holding a struct scroll_bar needs. */
508 #define SCROLL_BAR_VEC_SIZE \
509 ((sizeof (struct scroll_bar) \
510 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
511 / sizeof (Lisp_Object))
513 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
514 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
517 /* Building a 32-bit C integer from two 16-bit lisp integers. */
518 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
520 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
521 #define SCROLL_BAR_UNPACK(low, high, int32) \
522 (XSETINT ((low), (int32) & 0xffff), \
523 XSETINT ((high), ((int32) >> 16) & 0xffff))
526 /* Extract the Mac control handle of the scroll bar from a struct
528 #define SCROLL_BAR_CONTROL_HANDLE(ptr) \
529 ((ControlHandle) SCROLL_BAR_PACK ((ptr)->control_handle_low, \
530 (ptr)->control_handle_high))
532 /* Store a Mac control handle in a struct scroll_bar. */
533 #define SET_SCROLL_BAR_CONTROL_HANDLE(ptr, id) \
534 (SCROLL_BAR_UNPACK ((ptr)->control_handle_low, \
535 (ptr)->control_handle_high, (int) id))
537 /* Return the inside width of a vertical scroll bar, given the outside
539 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
541 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
542 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
543 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
545 /* Return the length of the rectangle within which the top of the
546 handle must stay. This isn't equivalent to the inside height,
547 because the scroll bar handle has a minimum height.
549 This is the real range of motion for the scroll bar, so when we're
550 scaling buffer positions to scroll bar positions, we use this, not
551 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
552 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
553 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) \
554 - VERTICAL_SCROLL_BAR_MIN_HANDLE - UP_AND_DOWN_ARROWS)
556 /* Return the inside height of vertical scroll bar, given the outside
557 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
558 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
559 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER \
560 - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
563 /* Border widths for scroll bars.
565 Scroll bar windows don't have any borders; their border width is
566 set to zero, and we redraw borders ourselves. This makes the code
567 a bit cleaner, since we don't have to convert between outside width
568 (used when relating to the rest of the screen) and inside width
569 (used when sizing and drawing the scroll bar window itself).
571 The handle moves up and down/back and forth in a rectangle inset
572 from the edges of the scroll bar. These are widths by which we
573 inset the handle boundaries from the scroll bar edges. */
574 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
575 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
576 #define VERTICAL_SCROLL_BAR_TOP_BORDER (0)
577 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (0)
579 /* Minimum lengths for scroll bar handles, in pixels. */
580 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (16)
582 /* Combined length of up and down arrow boxes in scroll bars, in pixels. */
583 #define UP_AND_DOWN_ARROWS (32)
585 /* Trimming off a few pixels from each side prevents
586 text from glomming up against the scroll bar */
587 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
589 /* Size of hourglass controls */
590 #define HOURGLASS_WIDTH 16
591 #define HOURGLASS_HEIGHT 16
597 Lisp_Object display_x_get_resource
P_ ((struct x_display_info
*,
598 Lisp_Object
, Lisp_Object
,
599 Lisp_Object
, Lisp_Object
));
600 struct frame
*check_x_frame
P_ ((Lisp_Object
));
601 EXFUN (Fx_display_color_p
, 1);
602 EXFUN (Fx_display_grayscale_p
, 1);
603 EXFUN (Fx_display_planes
, 1);
604 extern void x_free_gcs
P_ ((struct frame
*));
605 extern int XParseGeometry
P_ ((char *, int *, int *, unsigned int *,
608 /* Defined in macterm.c. */
610 extern void x_set_window_size
P_ ((struct frame
*, int, int, int));
611 extern void x_make_frame_visible
P_ ((struct frame
*));
612 extern void mac_initialize
P_ ((void));
613 extern Pixmap XCreatePixmap
P_ ((Display
*, WindowPtr
, unsigned int,
614 unsigned int, unsigned int));
615 extern Pixmap XCreatePixmapFromBitmapData
P_ ((Display
*, WindowPtr
, char *,
616 unsigned int, unsigned int,
617 unsigned long, unsigned long,
619 extern void XFreePixmap
P_ ((Display
*, Pixmap
));
620 extern GC XCreateGC
P_ ((Display
*, Window
, unsigned long, XGCValues
*));
621 extern void XSetForeground
P_ ((Display
*, GC
, unsigned long));
622 extern void XSetBackground
P_ ((Display
*, GC
, unsigned long));
623 extern void XSetWindowBackground
P_ ((Display
*, WindowPtr
, unsigned long));
624 extern void mac_draw_line_to_pixmap
P_ ((Display
*, Pixmap
, GC
, int, int,
626 extern void mac_unload_font
P_ ((struct mac_display_info
*, XFontStruct
*));
627 extern OSErr install_window_handler
P_ ((WindowPtr
));
628 extern void remove_window_handler
P_ ((WindowPtr
));
630 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
631 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
633 /* Defined in macselect.c */
635 extern void x_clear_frame_selections
P_ ((struct frame
*));
637 /* Defined in mac.c. */
639 extern OSErr posix_pathname_to_fsspec
P_ ((const char *, FSSpec
*));
640 extern OSErr fsspec_to_posix_pathname
P_ ((const FSSpec
*, char *, int));
641 extern void mac_clear_font_name_table
P_ ((void));
642 #if TARGET_API_MAC_CARBON
643 extern CFStringRef cfstring_create_with_utf8_cstring
P_ ((const char *));
644 extern CFStringRef cfstring_create_with_string
P_ ((Lisp_Object
));
645 extern Lisp_Object cfdata_to_lisp
P_ ((CFDataRef
));
646 extern Lisp_Object cfstring_to_lisp
P_ ((CFStringRef
));
647 extern Lisp_Object cfnumber_to_lisp
P_ ((CFNumberRef
));
648 extern Lisp_Object cfdate_to_lisp
P_ ((CFDateRef
));
649 extern Lisp_Object cfboolean_to_lisp
P_ ((CFBooleanRef
));
650 extern Lisp_Object cfobject_desc_to_lisp
P_ ((CFTypeRef
));
651 extern Lisp_Object cfproperty_list_to_lisp
P_ ((CFPropertyListRef
, int, int));
653 extern void xrm_merge_string_database
P_ ((XrmDatabase
, char *));
654 extern Lisp_Object xrm_get_resource
P_ ((XrmDatabase
, char *, char *));
655 extern XrmDatabase xrm_get_preference_database
P_ ((char *));
657 /* arch-tag: 6b4ca125-5bef-476d-8ee8-31ed808b7e79
658 (do not change this comment) */