1 /* Display module for Mac OS.
2 Copyright (C) 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Contributed by Andrew Choi (akochoi@mac.com). */
26 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
28 #define RED_FROM_ULONG(color) ((color) >> 16)
29 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
30 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
32 /* Do not change `* 0x101' in the following lines to `<< 8'. If
33 changed, image masks in 1-bit depth will not work. */
34 #define RED16_FROM_ULONG(color) (RED_FROM_ULONG(color) * 0x101)
35 #define GREEN16_FROM_ULONG(color) (GREEN_FROM_ULONG(color) * 0x101)
36 #define BLUE16_FROM_ULONG(color) (BLUE_FROM_ULONG(color) * 0x101)
38 #define BLACK_PIX_DEFAULT(f) RGB_TO_ULONG(0,0,0)
39 #define WHITE_PIX_DEFAULT(f) RGB_TO_ULONG(255,255,255)
41 /* A black pixel in a mask bitmap/pixmap means ``draw a source
42 pixel''. A white pixel means ``retain the current pixel''. */
43 #define PIX_MASK_DRAW(f) BLACK_PIX_DEFAULT(f)
44 #define PIX_MASK_RETAIN(f) WHITE_PIX_DEFAULT(f)
46 #define FONT_WIDTH(f) ((f)->max_bounds.width)
47 #define FONT_HEIGHT(f) ((f)->ascent + (f)->descent)
48 #define FONT_BASE(f) ((f)->ascent)
49 #define FONT_DESCENT(f) ((f)->descent)
51 #define FONT_MAX_WIDTH(f) FONT_WIDTH(f) /* fix later */
53 /* Structure recording bitmaps and reference count.
54 If REFCOUNT is 0 then this record is free to be reused. */
56 struct mac_bitmap_record
65 /* For each display (currently only one on mac), we have a structure that
66 records information about it. */
68 struct mac_display_info
70 /* Chain of all mac_display_info structures. */
71 struct mac_display_info
*next
;
73 /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
74 The same cons cell also appears in x_display_name_list. */
75 Lisp_Object name_list_element
;
77 /* Number of frames that are on this display. */
80 /* Dots per inch of the screen. */
83 /* Number of planes on this screen. */
86 /* Whether the screen supports color */
90 /* Number of bits per pixel on this screen. */
94 /* Dimensions of this screen. */
97 int height_in
,width_in
;
100 /* Mask of things that cause the mouse to be grabbed. */
104 /* Emacs bitmap-id of the default icon bitmap for this frame.
105 Or -1 if none has been allocated yet. */
109 /* The root window of this screen. */
112 /* The cursor to use for vertical scroll bars. */
113 Cursor vertical_scroll_bar_cursor
;
115 /* Resource data base */
119 /* color palette information. */
121 struct w32_palette_entry
* color_list
;
125 /* deferred action flags checked when starting frame update. */
128 /* Keystroke that has been faked by Emacs and will be ignored when
129 received; value is reset after key is received. */
134 /* A table of all the fonts we have already loaded. */
135 struct font_info
*font_table
;
137 /* The current capacity of font_table. */
140 /* The number of fonts actually stored in the font table.
141 font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
142 n_fonts <= font_table_size. and font_table[i].name != 0. */
145 /* Minimum width over all characters in all fonts in font_table. */
146 int smallest_char_width
;
148 /* Minimum font height over all fonts in font_table. */
149 int smallest_font_height
;
151 /* Reusable Graphics Context for drawing a cursor in a non-default face. */
152 XGCValues
*scratch_cursor_gc
;
154 /* These variables describe the range of text currently shown in its
155 mouse-face, together with the window they apply to. As long as
156 the mouse stays within this range, we need not redraw anything on
157 its account. Rows and columns are glyph matrix positions in
158 MOUSE_FACE_WINDOW. */
159 int mouse_face_beg_row
, mouse_face_beg_col
;
160 int mouse_face_beg_x
, mouse_face_beg_y
;
161 int mouse_face_end_row
, mouse_face_end_col
;
162 int mouse_face_end_x
, mouse_face_end_y
;
163 int mouse_face_past_end
;
164 Lisp_Object mouse_face_window
;
165 int mouse_face_face_id
;
166 Lisp_Object mouse_face_overlay
;
168 /* 1 if a mouse motion event came and we didn't handle it right away because
169 gc was in progress. */
170 int mouse_face_deferred_gc
;
172 /* FRAME and X, Y position of mouse when last checked for
173 highlighting. X and Y can be negative or out of range for the frame. */
174 struct frame
*mouse_face_mouse_frame
;
176 int mouse_face_mouse_x
, mouse_face_mouse_y
;
178 /* Nonzero means defer mouse-motion highlighting. */
179 int mouse_face_defer
;
181 /* Nonzero means that the mouse highlight should not be shown. */
182 int mouse_face_hidden
;
184 int mouse_face_image_state
;
188 /* Pointer to bitmap records. */
189 struct mac_bitmap_record
*bitmaps
;
191 /* Allocated size of bitmaps field. */
194 /* Last used bitmap index. */
197 /* The frame (if any) which has the window that has keyboard focus.
198 Zero if none. This is examined by Ffocus_frame in w32fns.c. Note
199 that a mere EnterNotify event can set this; if you need to know the
200 last frame specified in a FocusIn or FocusOut event, use
201 w32_focus_event_frame. */
202 struct frame
*x_focus_frame
;
204 /* The last frame mentioned in a FocusIn or FocusOut event. This is
205 separate from w32_focus_frame, because whether or not LeaveNotify
206 events cause us to lose focus depends on whether or not we have
207 received a FocusIn event for it. */
208 struct frame
*x_focus_event_frame
;
210 /* The frame which currently has the visual highlight, and should get
211 keyboard input (other sorts of input have the frame encoded in the
212 event). It points to the focus frame's selected window's
213 frame. It differs from w32_focus_frame when we're using a global
215 struct frame
*x_highlight_frame
;
217 /* Cache of images. */
218 struct image_cache
*image_cache
;
221 #define x_display_info mac_display_info
223 /* This is a chain of structures for all the X displays currently in use. */
224 extern struct x_display_info
*x_display_list
;
226 /* This is a chain of structures for all the displays currently in use. */
227 extern struct mac_display_info one_mac_display_info
;
229 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
230 one for each element of x_display_list and in the same order.
231 NAME is the name of the frame.
232 FONT-LIST-CACHE records previous values returned by x-list-fonts. */
233 extern Lisp_Object x_display_name_list
;
235 /* A flag to control how to display unibyte 8-bit character. */
236 extern int unibyte_display_via_language_environment
;
238 extern struct x_display_info
*x_display_info_for_display
P_ ((Display
*));
239 extern struct x_display_info
*x_display_info_for_name
P_ ((Lisp_Object
));
241 extern struct mac_display_info
*mac_term_init ();
243 /* When Emacs uses a tty window, tty_display in frame.c points to an
247 unsigned long background_pixel
;
248 unsigned long foreground_pixel
;
251 /* The collection of data describing a window on the Mac. */
253 /* Placeholder for things accessed through output_data.x. Must
255 struct x_output x_compatible
;
257 /* Menubar "widget" handle. */
260 Window mWP
; /* pointer to QuickDraw window */
261 FRAME_PTR mFP
; /* points back to the frame struct */
264 int mNumCols
; /* number of characters per column */
265 int mNumRows
; /* number of characters per row */
266 int mLineHeight
; /* height of one line of text in pixels */
267 int mCharWidth
; /* width of one character in pixels */
268 int mHomeX
; /* X pixel coordinate of lower left
269 corner of character at (0, 0) */
270 int mHomeY
; /* Y pixel coordinate of lower left
271 corner of character at (0, 0) */
272 int mHighlight
; /* current highlight state (0 = off). */
273 int mTermWinSize
; /* num of lines from top of window
274 affected by ins_del_lines; set by
275 set_terminal_window. */
279 /* stuffs used by xfaces.c */
280 struct face
**param_faces
;
282 struct face
**computed_faces
;
283 int n_computed_faces
;
284 int size_computed_faces
;
287 /* Here are the Graphics Contexts for the default font. */
288 GC normal_gc
; /* Normal video */
289 GC reverse_gc
; /* Reverse video */
290 GC cursor_gc
; /* cursor drawing */
292 /* The window used for this frame.
293 May be zero while the frame object is being created
294 and the window has not yet been created. */
297 /* The window that is the parent of this window.
298 Usually this is a window that was made by the window manager,
299 but it can be the root window, and it can be explicitly specified
300 (see the explicit_parent field, below). */
303 /* Default ASCII font of this frame. */
306 /* The baseline offset of the default ASCII font. */
309 /* If a fontset is specified for this frame instead of font, this
310 value contains an ID of the fontset, else -1. */
313 /* Pixel values used for various purposes.
314 border_pixel may be -1 meaning use a gray tile. */
315 unsigned long cursor_pixel
;
316 unsigned long border_pixel
;
317 unsigned long mouse_pixel
;
318 unsigned long cursor_foreground_pixel
;
320 /* Foreground color for scroll bars. A value of -1 means use the
321 default (black for non-toolkit scroll bars). */
322 unsigned long scroll_bar_foreground_pixel
;
324 /* Background color for scroll bars. A value of -1 means use the
325 default (background color of the frame for non-toolkit scroll
327 unsigned long scroll_bar_background_pixel
;
329 /* Descriptor for the cursor in use for this window. */
331 Cursor nontext_cursor
;
332 Cursor modeline_cursor
;
334 Cursor hourglass_cursor
;
335 Cursor horizontal_drag_cursor
;
337 /* Window whose cursor is hourglass_cursor. This window is temporarily
338 mapped to display a hourglass-cursor. */
339 Window hourglass_window
;
341 /* Non-zero means hourglass cursor is currently displayed. */
342 unsigned hourglass_p
: 1;
344 /* Flag to set when the window needs to be completely repainted. */
353 /* This is the Emacs structure for the display this frame is on. */
354 /* struct w32_display_info *display_info; */
356 /* Nonzero means our parent is another application's window
357 and was explicitly specified. */
358 char explicit_parent
;
360 /* Nonzero means tried already to make this frame visible. */
361 char asked_for_visible
;
363 /* Nonzero means menubar is currently active. */
366 /* Nonzero means a menu command is being processed. */
367 char menu_command_in_progress
;
369 /* Nonzero means menubar is about to become active, but should be
370 brought up to date first. */
371 volatile char pending_menu_activation
;
373 /* Relief GCs, colors etc. */
380 black_relief
, white_relief
;
382 /* The background for which the above relief GCs were set up.
383 They are changed only when a different background is involved. */
384 unsigned long relief_background
;
387 typedef struct mac_output mac_output
;
389 /* Return the X output data for frame F. */
390 #define FRAME_X_OUTPUT(f) ((f)->output_data.mac)
392 /* Return the Mac window used for displaying data in frame F. */
393 #define FRAME_MAC_WINDOW(f) ((f)->output_data.mac->mWP)
394 #define FRAME_X_WINDOW(f) ((f)->output_data.mac->mWP)
396 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
397 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
399 #define FRAME_FONT(f) ((f)->output_data.mac->font)
400 #define FRAME_FONTSET(f) ((f)->output_data.mac->fontset)
402 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.mac->baseline_offset)
404 /* This gives the w32_display_info structure for the display F is on. */
405 #define FRAME_MAC_DISPLAY_INFO(f) (&one_mac_display_info)
406 #define FRAME_X_DISPLAY_INFO(f) (&one_mac_display_info)
408 /* This is the `Display *' which frame F is on. */
409 #define FRAME_MAC_DISPLAY(f) (0)
410 #define FRAME_X_DISPLAY(f) (0)
412 /* This is the 'font_info *' which frame F has. */
413 #define FRAME_MAC_FONT_TABLE(f) (FRAME_MAC_DISPLAY_INFO (f)->font_table)
415 /* Value is the smallest width of any character in any font on frame F. */
417 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
418 FRAME_MAC_DISPLAY_INFO(F)->smallest_char_width
420 /* Value is the smallest height of any font on frame F. */
422 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
423 FRAME_MAC_DISPLAY_INFO(F)->smallest_font_height
425 /* Return a pointer to the image cache of frame F. */
427 #define FRAME_X_IMAGE_CACHE(F) FRAME_MAC_DISPLAY_INFO ((F))->image_cache
430 /* Mac-specific scroll bar stuff. */
432 /* We represent scroll bars as lisp vectors. This allows us to place
433 references to them in windows without worrying about whether we'll
434 end up with windows referring to dead scroll bars; the garbage
435 collector will free it when its time comes.
437 We use struct scroll_bar as a template for accessing fields of the
442 /* These fields are shared by all vectors. */
443 EMACS_INT size_from_Lisp_Vector_struct
;
444 struct Lisp_Vector
*next_from_Lisp_Vector_struct
;
446 /* The window we're a scroll bar for. */
449 /* The next and previous in the chain of scroll bars in this frame. */
450 Lisp_Object next
, prev
;
452 /* The Mac control handle of this scroll bar. Since this is a full
453 32-bit quantity, we store it split into two 32-bit values. */
454 Lisp_Object control_handle_low
, control_handle_high
;
456 /* The position and size of the scroll bar in pixels, relative to the
458 Lisp_Object top
, left
, width
, height
;
460 /* The starting and ending positions of the handle, relative to the
461 handle area (i.e. zero is the top position, not
462 SCROLL_BAR_TOP_BORDER). If they're equal, that means the handle
463 hasn't been drawn yet.
465 These are not actually the locations where the beginning and end
466 are drawn; in order to keep handles from becoming invisible when
467 editing large files, we establish a minimum height by always
468 drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
469 where they would be normally; the bottom and top are in a
470 different co-ordinate system. */
471 Lisp_Object start
, end
;
473 /* If the scroll bar handle is currently being dragged by the user,
474 this is the number of pixels from the top of the handle to the
475 place where the user grabbed it. If the handle isn't currently
476 being dragged, this is Qnil. */
477 Lisp_Object dragging
;
480 /* The number of elements a vector holding a struct scroll_bar needs. */
481 #define SCROLL_BAR_VEC_SIZE \
482 ((sizeof (struct scroll_bar) \
483 - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *)) \
484 / sizeof (Lisp_Object))
486 /* Turning a lisp vector value into a pointer to a struct scroll_bar. */
487 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
490 /* Building a 32-bit C integer from two 16-bit lisp integers. */
491 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
493 /* Setting two lisp integers to the low and high words of a 32-bit C int. */
494 #define SCROLL_BAR_UNPACK(low, high, int32) \
495 (XSETINT ((low), (int32) & 0xffff), \
496 XSETINT ((high), ((int32) >> 16) & 0xffff))
499 /* Extract the Mac control handle of the scroll bar from a struct
501 #define SCROLL_BAR_CONTROL_HANDLE(ptr) \
502 ((ControlHandle) SCROLL_BAR_PACK ((ptr)->control_handle_low, \
503 (ptr)->control_handle_high))
505 /* Store a Mac control handle in a struct scroll_bar. */
506 #define SET_SCROLL_BAR_CONTROL_HANDLE(ptr, id) \
507 (SCROLL_BAR_UNPACK ((ptr)->control_handle_low, \
508 (ptr)->control_handle_high, (int) id))
510 /* Return the inside width of a vertical scroll bar, given the outside
512 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
514 - VERTICAL_SCROLL_BAR_LEFT_BORDER \
515 - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
516 - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
518 /* Return the length of the rectangle within which the top of the
519 handle must stay. This isn't equivalent to the inside height,
520 because the scroll bar handle has a minimum height.
522 This is the real range of motion for the scroll bar, so when we're
523 scaling buffer positions to scroll bar positions, we use this, not
524 VERTICAL_SCROLL_BAR_INSIDE_HEIGHT. */
525 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
526 (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) \
527 - VERTICAL_SCROLL_BAR_MIN_HANDLE - UP_AND_DOWN_ARROWS)
529 /* Return the inside height of vertical scroll bar, given the outside
530 height. See VERTICAL_SCROLL_BAR_TOP_RANGE too. */
531 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
532 ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER \
533 - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
536 /* Border widths for scroll bars.
538 Scroll bar windows don't have any borders; their border width is
539 set to zero, and we redraw borders ourselves. This makes the code
540 a bit cleaner, since we don't have to convert between outside width
541 (used when relating to the rest of the screen) and inside width
542 (used when sizing and drawing the scroll bar window itself).
544 The handle moves up and down/back and forth in a rectangle inset
545 from the edges of the scroll bar. These are widths by which we
546 inset the handle boundaries from the scroll bar edges. */
547 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
548 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
549 #define VERTICAL_SCROLL_BAR_TOP_BORDER (0)
550 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (0)
552 /* Minimum lengths for scroll bar handles, in pixels. */
553 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (16)
555 /* Combined length of up and down arrow boxes in scroll bars, in pixels. */
556 #define UP_AND_DOWN_ARROWS (32)
558 /* Trimming off a few pixels from each side prevents
559 text from glomming up against the scroll bar */
560 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
563 struct frame
* check_x_frame (Lisp_Object
);
565 void activate_scroll_bars (FRAME_PTR
);
566 void deactivate_scroll_bars (FRAME_PTR
);
568 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
569 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
571 /* arch-tag: 6b4ca125-5bef-476d-8ee8-31ed808b7e79
572 (do not change this comment) */