/* Interface definitions for display code.
- Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002, 2003
+ Copyright (C) 1985,93,94,97,98,99, 2000,01,02,03, 2004, 2005
Free Software Foundation, Inc.
This file is part of GNU Emacs.
#ifdef HAVE_X_WINDOWS
typedef struct x_display_info Display_Info;
+typedef XImage * XImagePtr;
+typedef XImagePtr XImagePtr_or_DC;
#define NativeRectangle XRectangle
#endif
#ifdef HAVE_NTGUI
#include "w32gui.h"
typedef struct w32_display_info Display_Info;
+typedef XImage *XImagePtr;
+typedef HDC XImagePtr_or_DC;
#endif
-#ifdef HAVE_CARBON
+#ifdef MAC_OS
#include "macgui.h"
typedef struct mac_display_info Display_Info;
-
-/* Include Carbon.h to define Cursor and Rect. */
-#undef mktime
-#undef DEBUG
-#undef Z
-#undef free
-#undef malloc
-#undef realloc
-/* Macros max and min defined in lisp.h conflict with those in
- precompiled header Carbon.h. */
-#undef max
-#undef min
-#undef init_process
-#include <Carbon/Carbon.h>
-#undef Z
-#define Z (current_buffer->text->z)
-#undef free
-#define free unexec_free
-#undef malloc
-#define malloc unexec_malloc
-#undef realloc
-#define realloc unexec_realloc
-#undef min
-#define min(a, b) ((a) < (b) ? (a) : (b))
-#undef max
-#define max(a, b) ((a) > (b) ? (a) : (b))
-#undef init_process
-#define init_process emacs_init_process
-
+/* Mac equivalent of XImage. */
+typedef Pixmap XImagePtr;
+typedef XImagePtr XImagePtr_or_DC;
#endif
-
#ifndef NativeRectangle
#define NativeRectangle int
#endif
-
/* Structure forward declarations. Some are here because function
prototypes below reference structure types before their definition
in this file. Some are here because not every file including
ON_LEFT_FRINGE,
ON_RIGHT_FRINGE,
ON_LEFT_MARGIN,
- ON_RIGHT_MARGIN
+ ON_RIGHT_MARGIN,
+ ON_SCROLL_BAR
};
/* Number of bits allocated to store fringe bitmap numbers. */
-#define FRINGE_ID_BITS 8
+#define FRINGE_ID_BITS 16
\f
#define GLYPH_DEBUG 0
#endif
+/* If XASSERTS is non-zero, additional consistency checks are activated.
+ Turn it off by defining the macro XASSERTS to zero. */
+
+#ifndef XASSERTS
+#define XASSERTS 0
+#endif
+
/* Macros to include code only if GLYPH_DEBUG != 0. */
#if GLYPH_DEBUG
#define IF_DEBUG(X) X
-#define xassert(X) do {if (!(X)) abort ();} while (0)
#else
#define IF_DEBUG(X) (void) 0
+#endif
+
+#if XASSERTS
+#define xassert(X) do {if (!(X)) abort ();} while (0)
+#else
#define xassert(X) (void) 0
#endif
};
+/* Structure describing how to use partial glyphs (images slicing) */
+
+struct glyph_slice
+{
+ unsigned x : 16;
+ unsigned y : 16;
+ unsigned width : 16;
+ unsigned height : 16;
+};
+
+
/* Glyphs.
Be extra careful when changing this structure! Esp. make sure that
w32_char_font_type. Otherwise it equals FONT_TYPE_UNKNOWN. */
unsigned font_type : 3;
+ struct glyph_slice slice;
+
/* A union of sub-structures for different glyph types. */
union
{
#define CHAR_GLYPH_SPACE_P(GLYPH) \
(GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)
+/* Are glyph slices of glyphs *X and *Y equal */
+
+#define GLYPH_SLICE_EQUAL_P(X, Y) \
+ ((X)->slice.x == (Y)->slice.x \
+ && (X)->slice.y == (Y)->slice.y \
+ && (X)->slice.width == (Y)->slice.width \
+ && (X)->slice.height == (Y)->slice.height)
+
/* Are glyphs *X and *Y displayed equal? */
#define GLYPH_EQUAL_P(X, Y) \
((X)->type == (Y)->type \
&& (X)->u.val == (Y)->u.val \
+ && GLYPH_SLICE_EQUAL_P (X, Y) \
&& (X)->face_id == (Y)->face_id \
&& (X)->padding_p == (Y)->padding_p \
&& (X)->left_box_line_p == (Y)->left_box_line_p \
frames. It may be < 0 in case of completely invisible rows. */
int visible_height;
+ /* Extra line spacing added after this row. Do not consider this
+ in last row when checking if row is fully visible. */
+ int extra_line_spacing;
+
/* Hash code. This hash code is available as soon as the row
is constructed, i.e. after a call to display_line. */
unsigned hash;
position of the next row. */
struct display_pos end;
+ /* Non-zero means the overlay arrow bitmap is on this line.
+ -1 means use default overlay arrow bitmap, else
+ it specifies actual fringe bitmap number. */
+ int overlay_arrow_bitmap;
+
/* Left fringe bitmap number (enum fringe_bitmap_type). */
unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
- /* Face of the left fringe glyph. */
- unsigned left_user_fringe_face_id : FACE_ID_BITS;
-
/* Right fringe bitmap number (enum fringe_bitmap_type). */
unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
- /* Face of the right fringe glyph. */
- unsigned right_user_fringe_face_id : FACE_ID_BITS;
-
/* Left fringe bitmap number (enum fringe_bitmap_type). */
unsigned left_fringe_bitmap : FRINGE_ID_BITS;
- /* Face of the left fringe glyph. */
- unsigned left_fringe_face_id : FACE_ID_BITS;
-
/* Right fringe bitmap number (enum fringe_bitmap_type). */
unsigned right_fringe_bitmap : FRINGE_ID_BITS;
+ /* Face of the left fringe glyph. */
+ unsigned left_user_fringe_face_id : FACE_ID_BITS;
+
+ /* Face of the right fringe glyph. */
+ unsigned right_user_fringe_face_id : FACE_ID_BITS;
+
+ /* Face of the left fringe glyph. */
+ unsigned left_fringe_face_id : FACE_ID_BITS;
+
/* Face of the right fringe glyph. */
unsigned right_fringe_face_id : FACE_ID_BITS;
unsigned truncated_on_left_p : 1;
unsigned truncated_on_right_p : 1;
- /* 1 means the overlay arrow is on this line. */
- unsigned overlay_arrow_p : 1;
-
/* 1 means that this row displays a continued line, i.e. it has a
continuation mark at the right side. */
unsigned continued_p : 1;
/* 1 means this row currently shows the cursor in the right fringe. */
unsigned cursor_in_fringe_p : 1;
+ /* 1 means the last glyph in the row is part of an ellipsis. */
+ unsigned ends_in_ellipsis_p : 1;
+
/* Non-zero means display a bitmap on X frames indicating that this
the first line of the buffer. */
unsigned indicate_bob_p : 1;
#define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
+
+/* Helper macros */
+
+#define MR_PARTIALLY_VISIBLE(ROW) \
+ ((ROW)->height != (ROW)->visible_height)
+
+#define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW) \
+ ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
+
+#define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW) \
+ (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
+ > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
+
/* Non-zero if ROW is not completely visible in window W. */
-#define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW) \
- ((ROW)->height != (ROW)->visible_height)
+#define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW) \
+ (MR_PARTIALLY_VISIBLE ((ROW)) \
+ && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)) \
+ || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
+
+
/* Non-zero if ROW is partially visible at the top of window W. */
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW) \
- (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
- && (ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
+ (MR_PARTIALLY_VISIBLE ((ROW)) \
+ && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
/* Non-zero if ROW is partially visible at the bottom of window W. */
-#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
- (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW)) \
- && (ROW)->y + (ROW)->height > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
+#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW) \
+ (MR_PARTIALLY_VISIBLE ((ROW)) \
+ && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
/* Return the bottom Y + 1 of ROW. */
or a control char, or an overlay string. */
#define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW) \
- ((ROW)->end.dpvec_index >= 0 \
+ ((ROW)->end.dpvec_index > 0 \
|| (ROW)->end.overlay_string_index >= 0 \
|| (ROW)->ends_in_middle_of_char_p)
/* Non-zero if ROW starts in the middle of a character. See above. */
#define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW) \
- ((ROW)->start.dpvec_index >= 0 \
+ ((ROW)->start.dpvec_index > 0 \
|| (ROW)->starts_in_middle_of_char_p \
|| ((ROW)->start.overlay_string_index >= 0 \
&& (ROW)->start.string_pos.charpos > 0))
unsigned for_overlaps_p : 1;
/* The GC to use for drawing this glyph string. */
-#if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
+#if defined(HAVE_X_WINDOWS) || defined(MAC_OS)
GC gc;
#endif
#if defined(HAVE_NTGUI)
/* Image, if any. */
struct image *img;
+ /* Slice */
+ struct glyph_slice slice;
+
+ /* Non-null means the horizontal clipping region starts from the
+ left edge of *clip_head, and ends with the right edge of
+ *clip_tail, not including their overhangs. */
+ struct glyph_string *clip_head, *clip_tail;
+
struct glyph_string *next, *prev;
};
width and height of the bitmap, DH is the height adjustment (if
bitmap is periodic). X and Y are frame coordinates of the area to
display the bitmap, DY is relative offset of the bitmap into that
- area. BX, NX, BY, NY specifies the area to clear if the bitmap
+ area. BX, NX, BY, NY specifies the area to clear if the bitmap
does not fill the entire area. FACE is the fringe face. */
struct draw_fringe_bitmap_params
{
int which; /* enum fringe_bitmap_type */
- unsigned char *bits;
+ unsigned short *bits;
int wd, h, dh;
int x, y;
int bx, nx, by, ny;
};
+struct it_slice
+{
+ Lisp_Object x;
+ Lisp_Object y;
+ Lisp_Object width;
+ Lisp_Object height;
+};
+
+enum it_method {
+ GET_FROM_BUFFER = 0,
+ GET_FROM_DISPLAY_VECTOR,
+ GET_FROM_COMPOSITION,
+ GET_FROM_STRING,
+ GET_FROM_C_STRING,
+ GET_FROM_IMAGE,
+ GET_FROM_STRETCH,
+ NUM_IT_METHODS
+};
+
struct it
{
/* The window in which we iterate over current_buffer (or a string). */
/* The window's frame. */
struct frame *f;
- /* Function to call to load this structure with the next display
- element. */
- int (* method) P_ ((struct it *it));
+ /* Method to use to load this structure with the next display element. */
+ enum it_method method;
/* The next position at which to check for face changes, invisible
text, overlay strings, end of text etc., which see. */
Don't handle some `display' properties in these strings. */
unsigned string_from_display_prop_p : 1;
+ /* When METHOD == next_element_from_display_vector,
+ this is 1 if we're doing an ellipsis. Otherwise meaningless. */
+ unsigned ellipsis_p : 1;
+
/* Display table in effect or null for none. */
struct Lisp_Char_Table *dp;
means that no such character is involved. */
int dpvec_char_len;
+ /* Face id to use for all characters in display vector. -1 if unused. */
+ int dpvec_face_id;
+
/* Face id of the iterator saved in case a glyph from dpvec contains
a face. The face is restored when all glyphs from dpvec have
been delivered. */
/* Vector of overlays to process. Overlay strings are processed
OVERLAY_STRING_CHUNK_SIZE at a time. */
-#define OVERLAY_STRING_CHUNK_SIZE 3
+#define OVERLAY_STRING_CHUNK_SIZE 16
Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
/* Total number of overlay strings to process. This can be >
unsigned multibyte_p : 1;
unsigned string_from_display_prop_p : 1;
unsigned display_ellipsis_p : 1;
+ struct it_slice slice;
Lisp_Object space_width;
short voffset;
Lisp_Object font_height;
skipped due to selective display. */
unsigned face_before_selective_p : 1;
+ /* If 1, adjust current glyph so it does not increase current row
+ descent/ascent (line-height property). Reset after this glyph. */
+ unsigned constrain_row_ascent_descent_p : 1;
+
/* The ID of the default face to use. One of DEFAULT_FACE_ID,
MODE_LINE_FACE_ID, etc, depending on what we are displaying. */
int base_face_id;
/* If what == IT_IMAGE, the id of the image to display. */
int image_id;
+ /* Values from `slice' property. */
+ struct it_slice slice;
+
/* Value of the `space-width' property, if any; nil if none. */
Lisp_Object space_width;
/* Object and position where the current display element came from.
Object can be a Lisp string in case the current display element
- comes from an overlay string, or it is buffer. Position is
- a position in object. */
+ comes from an overlay string, or it is buffer. It may also be nil
+ during mode-line update. Position is a position in object. */
Lisp_Object object;
struct text_pos position;
line, if the window has one. */
int last_visible_y;
- /* Additional space in pixels between lines (for window systems
- only.) */
+ /* Default amount of additional space in pixels between lines (for
+ window systems only.) */
int extra_line_spacing;
+ /* Max extra line spacing added in this row. */
+ int max_extra_line_spacing;
+
+ /* Override font height information for this glyph.
+ Used if override_ascent >= 0. Cleared after this glyph. */
+ int override_ascent, override_descent, override_boff;
+
/* If non-null, glyphs are produced in glyph_row with each call to
produce_glyphs. */
struct glyph_row *glyph_row;
/* Left fringe bitmap number (enum fringe_bitmap_type). */
unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
- /* Face of the left fringe glyph. */
- unsigned left_user_fringe_face_id : FACE_ID_BITS;
-
/* Right fringe bitmap number (enum fringe_bitmap_type). */
unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
+ /* Face of the left fringe glyph. */
+ unsigned left_user_fringe_face_id : FACE_ID_BITS;
+
/* Face of the right fringe glyph. */
unsigned right_user_fringe_face_id : FACE_ID_BITS;
};
struct draw_fringe_bitmap_params *p));
/* Define and destroy fringe bitmap no. WHICH. */
- void (*define_fringe_bitmap) P_ ((int which, unsigned char *bits,
+ void (*define_fringe_bitmap) P_ ((int which, unsigned short *bits,
int h, int wd));
void (*destroy_fringe_bitmap) P_ ((int which));
int (*encode_char) P_ ((int c, XChar2b *char2b,
struct font_info *font_into, int *two_byte_p));
-/* Compute left and right overhang of glyph string S.
+/* Compute left and right overhang of glyph string S.
A NULL pointer if platform does not support this. */
void (*compute_glyph_string_overhangs) P_ ((struct glyph_string *s));
void (*draw_vertical_window_border) P_ ((struct window *w,
int x, int y0, int y1));
-/* Shift display of frame F to make room for inserted glyphs.
+/* Shift display of frame F to make room for inserted glyphs.
The area at pixel (X,Y) of width WIDTH and height HEIGHT is
shifted right by SHIFT_BY pixels. */
void (*shift_glyphs_for_insert) P_ ((struct frame *f,
extern Lisp_Object Vshow_trailing_whitespace;
extern int mode_line_in_non_selected_windows;
extern int redisplaying_p;
-extern Lisp_Object Vimage_types;
extern void add_to_log P_ ((char *, Lisp_Object, Lisp_Object));
extern int help_echo_showing_p;
extern int current_mode_line_height, current_header_line_height;
extern Lisp_Object help_echo_string, help_echo_window;
-extern Lisp_Object help_echo_object, previous_help_echo_string;
+extern Lisp_Object help_echo_object, previous_help_echo_string;
extern int help_echo_pos;
extern struct frame *last_mouse_frame;
extern int last_tool_bar_item;
extern int mouse_autoselect_window;
+extern void reseat_at_previous_visible_line_start P_ ((struct it *));
+
+extern int calc_pixel_width_or_height P_ ((double *, struct it *, Lisp_Object,
+ /* XFontStruct */ void *, int, int *));
#ifdef HAVE_WINDOW_SYSTEM
extern void draw_phys_cursor_glyph P_ ((struct window *,
struct glyph_row *,
enum draw_glyphs_face));
+extern int get_phys_cursor_geometry P_ ((struct window *, struct glyph_row *,
+ struct glyph *, int *));
extern void erase_phys_cursor P_ ((struct window *));
extern void display_and_set_cursor P_ ((struct window *,
int, int, int, int, int));
/* Defined in fringe.c */
-int valid_fringe_bitmap_id_p (int);
+int lookup_fringe_bitmap (Lisp_Object);
void draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, int));
void draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *));
-void draw_window_fringes P_ ((struct window *));
+int draw_window_fringes P_ ((struct window *, int));
int update_window_fringes P_ ((struct window *, int));
void compute_fringe_widths P_ ((struct frame *, int));
void w32_reset_fringes P_ ((void));
#endif
+/* Defined in image.c */
+
+#ifdef HAVE_WINDOW_SYSTEM
+
+extern int x_bitmap_height P_ ((struct frame *, int));
+extern int x_bitmap_width P_ ((struct frame *, int));
+extern int x_bitmap_pixmap P_ ((struct frame *, int));
+extern void x_reference_bitmap P_ ((struct frame *, int));
+extern int x_create_bitmap_from_data P_ ((struct frame *, char *,
+ unsigned int, unsigned int));
+extern int x_create_bitmap_from_file P_ ((struct frame *, Lisp_Object));
+#ifndef x_destroy_bitmap
+extern void x_destroy_bitmap P_ ((struct frame *, int));
+#endif
+extern void x_destroy_all_bitmaps P_ ((Display_Info *));
+extern int x_create_bitmap_mask P_ ((struct frame * , int));
+extern Lisp_Object x_find_image_file P_ ((Lisp_Object));
+
+void x_kill_gs_process P_ ((Pixmap, struct frame *));
+struct image_cache *make_image_cache P_ ((void));
+void free_image_cache P_ ((struct frame *));
+void clear_image_cache P_ ((struct frame *, int));
+void forall_images_in_image_cache P_ ((struct frame *,
+ void (*) P_ ((struct image *))));
+int valid_image_p P_ ((Lisp_Object));
+void prepare_image_for_display P_ ((struct frame *, struct image *));
+int lookup_image P_ ((struct frame *, Lisp_Object));
+
+unsigned long image_background P_ ((struct image *, struct frame *,
+ XImagePtr_or_DC ximg));
+int image_background_transparent P_ ((struct image *, struct frame *,
+ XImagePtr_or_DC mask));
+
+int image_ascent P_ ((struct image *, struct face *, struct glyph_slice *));
+
+#endif
+
/* Defined in sysdep.c */
void get_frame_size P_ ((int *, int *));
void prepare_face_for_display P_ ((struct frame *, struct face *));
int xstricmp P_ ((const unsigned char *, const unsigned char *));
int lookup_face P_ ((struct frame *, Lisp_Object *, int, struct face *));
-int lookup_named_face P_ ((struct frame *, Lisp_Object, int));
+int lookup_named_face P_ ((struct frame *, Lisp_Object, int, int));
int smaller_face P_ ((struct frame *, int, int));
int face_with_height P_ ((struct frame *, int, int));
-int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int));
+int lookup_derived_face P_ ((struct frame *, Lisp_Object, int, int, int));
void init_frame_faces P_ ((struct frame *));
void free_frame_faces P_ ((struct frame *));
void recompute_basic_faces P_ ((struct frame *));
int, int));
int face_at_string_position P_ ((struct window *, Lisp_Object, int, int, int,
int, int *, enum face_id, int));
+int merge_faces P_ ((struct frame *, Lisp_Object, int, int));
int compute_char_face P_ ((struct frame *, int, Lisp_Object));
void free_all_realized_faces P_ ((Lisp_Object));
extern Lisp_Object Qforeground_color, Qbackground_color;
#ifdef WINDOWSNT
void gamma_correct P_ ((struct frame *, COLORREF *));
#endif
+#ifdef MAC_OS
+void gamma_correct P_ ((struct frame *, unsigned long *));
+#endif
#ifdef HAVE_WINDOW_SYSTEM
-void x_kill_gs_process P_ ((Pixmap, struct frame *));
int x_screen_planes P_ ((struct frame *));
void x_implicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
-struct image_cache *make_image_cache P_ ((void));
-void free_image_cache P_ ((struct frame *));
-void clear_image_cache P_ ((struct frame *, int));
-void forall_images_in_image_cache P_ ((struct frame *,
- void (*) P_ ((struct image *))));
-int valid_image_p P_ ((Lisp_Object));
-void prepare_image_for_display P_ ((struct frame *, struct image *));
-int lookup_image P_ ((struct frame *, Lisp_Object));
-
-#ifdef HAVE_X_WINDOWS
-unsigned long image_background P_ ((struct image *, struct frame *,
- XImage *ximg));
-int image_background_transparent P_ ((struct image *, struct frame *,
- XImage *mask));
-#endif /* HAVE_X_WINDOWS */
extern Lisp_Object tip_frame;
extern Window tip_window;
EXFUN (Fx_hide_tip, 0);
extern void start_hourglass P_ ((void));
extern void cancel_hourglass P_ ((void));
+extern int hourglass_started P_ ((void));
extern int display_hourglass_p;
/* Returns the background color of IMG, calculating one heuristically if
extern Lisp_Object buffer_posn_from_coords P_ ((struct window *,
int *, int *,
struct display_pos *,
- Lisp_Object *,
+ Lisp_Object *,
int *, int *, int *, int *));
extern Lisp_Object mode_line_string P_ ((struct window *, enum window_part,
int *, int *, int *,