dispextern.h 115 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Interface definitions for display code.
2

3
Copyright (C) 1985, 1993-1994, 1997-2012  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20
/* New redisplay written by Gerd Moellmann <gerd@gnu.org>.  */
Morten Welinder's avatar
Morten Welinder committed
21

Gerd Moellmann's avatar
Gerd Moellmann committed
22 23
#ifndef DISPEXTERN_H_INCLUDED
#define DISPEXTERN_H_INCLUDED
Jim Blandy's avatar
Jim Blandy committed
24 25

#ifdef HAVE_X_WINDOWS
26

27
#include <X11/Xlib.h>
28 29 30
#ifdef USE_X_TOOLKIT
#include <X11/Intrinsic.h>
#endif /* USE_X_TOOLKIT */
31 32 33 34 35 36 37 38 39 40 41 42

#else /* !HAVE_X_WINDOWS */

/* X-related stuff used by non-X gui code. */

typedef struct {
  unsigned long pixel;
  unsigned short red, green, blue;
  char flags;
  char pad;
} XColor;

43
#endif /* HAVE_X_WINDOWS */
Morten Welinder's avatar
Morten Welinder committed
44 45 46 47

#ifdef MSDOS
#include "msdos.h"
#endif
48

49 50 51 52 53
INLINE_HEADER_BEGIN
#ifndef DISPEXTERN_INLINE
# define DISPEXTERN_INLINE INLINE
#endif

54
#include <c-strcase.h>
55
DISPEXTERN_INLINE int
56 57 58 59 60
xstrcasecmp (char const *a, char const *b)
{
  return c_strcasecmp (a, b);
}

61 62
#ifdef HAVE_X_WINDOWS
typedef struct x_display_info Display_Info;
Kenichi Handa's avatar
Kenichi Handa committed
63 64
typedef XImage * XImagePtr;
typedef XImagePtr XImagePtr_or_DC;
65 66 67
#define NativeRectangle XRectangle
#endif

Geoff Voelker's avatar
Geoff Voelker committed
68
#ifdef HAVE_NTGUI
Geoff Voelker's avatar
Geoff Voelker committed
69
#include "w32gui.h"
70
typedef struct w32_display_info Display_Info;
Kenichi Handa's avatar
Kenichi Handa committed
71 72
typedef XImage *XImagePtr;
typedef HDC XImagePtr_or_DC;
Geoff Voelker's avatar
Geoff Voelker committed
73 74
#endif

75 76
#ifdef HAVE_NS
#include "nsgui.h"
Juanma Barranquero's avatar
Juanma Barranquero committed
77
/* Following typedef needed to accommodate the MSDOS port, believe it or not.  */
78 79 80 81 82
typedef struct ns_display_info Display_Info;
typedef Pixmap XImagePtr;
typedef XImagePtr XImagePtr_or_DC;
#endif

83 84 85 86
#ifdef HAVE_WINDOW_SYSTEM
# include "systime.h"
#endif

87
#ifndef HAVE_WINDOW_SYSTEM
88 89 90 91
typedef int Cursor;
#define No_Cursor (0)
#endif

92 93 94 95
#ifndef NativeRectangle
#define NativeRectangle int
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
96 97 98 99 100 101 102 103 104 105 106 107 108
/* 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
   dispextern.h also includes frame.h and windows.h.  */

struct glyph;
struct glyph_row;
struct glyph_matrix;
struct glyph_pool;
struct frame;
struct window;


109 110 111 112 113 114 115 116 117 118 119 120
/* Values returned from coordinates_in_window.  */

enum window_part
{
  ON_NOTHING,
  ON_TEXT,
  ON_MODE_LINE,
  ON_VERTICAL_BORDER,
  ON_HEADER_LINE,
  ON_LEFT_FRINGE,
  ON_RIGHT_FRINGE,
  ON_LEFT_MARGIN,
121 122
  ON_RIGHT_MARGIN,
  ON_SCROLL_BAR
123 124
};

Kenichi Handa's avatar
Kenichi Handa committed
125
/* Number of bits allocated to store fringe bitmap numbers.  */
126
#define FRINGE_ID_BITS  16
Kenichi Handa's avatar
Kenichi Handa committed
127

128 129
/* Number of bits allocated to store fringe bitmap height.  */
#define FRINGE_HEIGHT_BITS 8
130

Gerd Moellmann's avatar
Gerd Moellmann committed
131 132 133 134 135

/***********************************************************************
			      Debugging
 ***********************************************************************/

136
/* If GLYPH_DEBUG is defined, additional checks are activated.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
137

138
/* Macros to include code only if GLYPH_DEBUG is defined.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
139

140
#ifdef GLYPH_DEBUG
Gerd Moellmann's avatar
Gerd Moellmann committed
141 142 143 144 145 146
#define IF_DEBUG(X)	X
#else
#define IF_DEBUG(X)	(void) 0
#endif

/* Macro for displaying traces of redisplay.  If Emacs was compiled
147
   with GLYPH_DEBUG defined, the variable trace_redisplay_p can be set to
Gerd Moellmann's avatar
Gerd Moellmann committed
148 149
   a non-zero value in debugging sessions to activate traces.  */

150
#ifdef GLYPH_DEBUG
Gerd Moellmann's avatar
Gerd Moellmann committed
151

Paul Eggert's avatar
Paul Eggert committed
152
extern int trace_redisplay_p EXTERNALLY_VISIBLE;
Gerd Moellmann's avatar
Gerd Moellmann committed
153 154 155 156 157 158 159 160
#include <stdio.h>

#define TRACE(X)				\
     if (trace_redisplay_p)			\
       fprintf X;				\
     else					\
       (void) 0

161
#else /* not GLYPH_DEBUG */
Gerd Moellmann's avatar
Gerd Moellmann committed
162 163 164

#define TRACE(X)	(void) 0

165
#endif /* GLYPH_DEBUG */
Gerd Moellmann's avatar
Gerd Moellmann committed
166

167

Gerd Moellmann's avatar
Gerd Moellmann committed
168 169 170 171 172 173 174 175

/***********************************************************************
			    Text positions
 ***********************************************************************/

/* Starting with Emacs 20.3, characters from strings and buffers have
   both a character and a byte position associated with them.  The
   following structure holds such a pair of positions.  */
176

Gerd Moellmann's avatar
Gerd Moellmann committed
177 178 179
struct text_pos
{
  /* Character position.  */
180
  ptrdiff_t charpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
181 182

  /* Corresponding byte position.  */
183
  ptrdiff_t bytepos;
Gerd Moellmann's avatar
Gerd Moellmann committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197
};

/* Access character and byte position of POS in a functional form.  */

#define BYTEPOS(POS)	(POS).bytepos
#define CHARPOS(POS)	(POS).charpos

/* Set character position of POS to CHARPOS, byte position to BYTEPOS.  */

#define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
     ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)

/* Increment text position POS.  */

198
#define INC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
199 200 201
     do						\
       {					\
	 ++(POS).charpos;			\
202 203 204 205
         if (MULTIBYTE_P)			\
	   INC_POS ((POS).bytepos);		\
	 else					\
	   ++(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
206 207 208 209 210
       }					\
     while (0)

/* Decrement text position POS.  */

211
#define DEC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
212 213 214
     do						\
       {					\
	 --(POS).charpos;			\
215 216 217 218
         if (MULTIBYTE_P)			\
	   DEC_POS ((POS).bytepos);		\
	 else					\
	   --(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
219 220 221 222 223 224 225 226 227 228 229 230 231
       }					\
     while (0)

/* Set text position POS from marker MARKER.  */

#define SET_TEXT_POS_FROM_MARKER(POS, MARKER)		\
     (CHARPOS (POS) = marker_position ((MARKER)),	\
      BYTEPOS (POS) = marker_byte_position ((MARKER)))

/* Set marker MARKER from text position POS.  */

#define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
     set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
232

Gerd Moellmann's avatar
Gerd Moellmann committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
/* Value is non-zero if character and byte positions of POS1 and POS2
   are equal.  */

#define TEXT_POS_EQUAL_P(POS1, POS2)		\
     ((POS1).charpos == (POS2).charpos		\
      && (POS1).bytepos == (POS2).bytepos)

/* When rendering glyphs, redisplay scans string or buffer text,
   overlay strings in that text, and does display table or control
   character translations.  The following structure captures a
   position taking all this into account.  */

struct display_pos
{
  /* Buffer or string position.  */
  struct text_pos pos;

  /* If this is a position in an overlay string, overlay_string_index
     is the index of that overlay string in the sequence of overlay
     strings at `pos' in the order redisplay processes them.  A value
     < 0 means that this is not a position in an overlay string.  */
254
  ptrdiff_t overlay_string_index;
Gerd Moellmann's avatar
Gerd Moellmann committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

  /* If this is a position in an overlay string, string_pos is the
     position within that string.  */
  struct text_pos string_pos;

  /* If the character at the position above is a control character or
     has a display table entry, dpvec_index is an index in the display
     table or control character translation of that character.  A
     value < 0 means this is not a position in such a translation.  */
  int dpvec_index;
};



/***********************************************************************
				Glyphs
 ***********************************************************************/

/* Enumeration of glyph types.  Glyph structures contain a type field
   containing one of the enumerators defined here.  */

enum glyph_type
{
  /* Glyph describes a character.  */
279
  CHAR_GLYPH,
Gerd Moellmann's avatar
Gerd Moellmann committed
280

281
  /* Glyph describes a static composition.  */
282 283
  COMPOSITE_GLYPH,

284 285 286
  /* Glyph describes a glyphless character.  */
  GLYPHLESS_GLYPH,

Gerd Moellmann's avatar
Gerd Moellmann committed
287 288 289 290 291 292 293 294
  /* Glyph describes an image.  */
  IMAGE_GLYPH,

  /* Glyph is a space of fractional width and/or height.  */
  STRETCH_GLYPH
};


295 296 297 298 299 300 301 302 303 304 305
/* Structure describing how to use partial glyphs (images slicing) */

struct glyph_slice
{
  unsigned x : 16;
  unsigned y : 16;
  unsigned width : 16;
  unsigned height : 16;
};


Gerd Moellmann's avatar
Gerd Moellmann committed
306 307 308
/* Glyphs.

   Be extra careful when changing this structure!  Esp. make sure that
309
   functions producing glyphs, like append_glyph, fill ALL of the
Gerd Moellmann's avatar
Gerd Moellmann committed
310 311 312
   glyph structure, and that GLYPH_EQUAL_P compares all
   display-relevant members of glyphs (not to imply that these are the
   only things to check when you add a member).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
313 314 315 316 317 318 319 320

struct glyph
{
  /* Position from which this glyph was drawn.  If `object' below is a
     Lisp string, this is a position in that string.  If it is a
     buffer, this is a position in that buffer.  A value of -1
     together with a null object means glyph is a truncation glyph at
     the start of a row.  */
321
  ptrdiff_t charpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
322 323

  /* Lisp object source of this glyph.  Currently either a buffer or
324
     a string, if the glyph was produced from characters which came from
Gerd Moellmann's avatar
Gerd Moellmann committed
325 326
     a buffer or a string; or 0 if the glyph was inserted by redisplay
     for its own purposes such as padding.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
327 328 329 330 331
  Lisp_Object object;

  /* Width in pixels.  */
  short pixel_width;

Kenichi Handa's avatar
Kenichi Handa committed
332 333 334
  /* Ascent and descent in pixels.  */
  short ascent, descent;

Gerd Moellmann's avatar
Gerd Moellmann committed
335 336 337 338 339 340
  /* Vertical offset.  If < 0, the glyph is displayed raised, if > 0
     the glyph is displayed lowered.  */
  short voffset;

  /* Which kind of glyph this is---character, image etc.  Value
     should be an enumerator of type enum glyph_type.  */
341
  unsigned type : 3;
Gerd Moellmann's avatar
Gerd Moellmann committed
342 343 344 345 346 347 348 349 350 351 352 353

  /* 1 means this glyph was produced from multibyte text.  Zero
     means it was produced from unibyte text, i.e. charsets aren't
     applicable, and encoding is not performed.  */
  unsigned multibyte_p : 1;

  /* Non-zero means draw a box line at the left or right side of this
     glyph.  This is part of the implementation of the face attribute
     `:box'.  */
  unsigned left_box_line_p : 1;
  unsigned right_box_line_p : 1;

354 355 356 357 358
  /* Non-zero means this glyph's physical ascent or descent is greater
     than its logical ascent/descent, i.e. it may potentially overlap
     glyphs above or below it.  */
  unsigned overlaps_vertically_p : 1;

359 360 361 362 363 364 365 366 367 368
  /* For terminal frames, 1 means glyph is a padding glyph.  Padding
     glyphs are used for characters whose visual shape consists of
     more than one glyph (e.g. Asian characters).  All but the first
     glyph of such a glyph sequence have the padding_p flag set.  This
     flag is used only to minimize code changes.  A better way would
     probably be to use the width field of glyphs to express padding.

     For graphic frames, 1 means the pixel width of the glyph in a
     font is 0, but 1-pixel is padded on displaying for correct cursor
     displaying.  The member `pixel_width' above is set to 1.  */
369 370
  unsigned padding_p : 1;

371 372 373
  /* 1 means the actual glyph is not available, draw using `struct
     glyphless' below instead.  This can happen when a font couldn't
     be loaded, or a character doesn't have a glyph in a font.  */
374 375
  unsigned glyph_not_available_p : 1;

376 377 378
  /* Non-zero means don't display cursor here.  */
  unsigned avoid_cursor_p : 1;

379
  /* Resolved bidirectional level of this character [0..63].  */
380
  unsigned resolved_level : 5;
381 382

  /* Resolved bidirectional type of this character, see enum
383 384 385 386 387
     bidi_type_t below.  Note that according to UAX#9, only some
     values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
     NEUTRAL_B) can appear in the resolved type, so we only reserve
     space for those that can.  */
  unsigned bidi_type : 3;
388

389
#define FACE_ID_BITS	20
Kenichi Handa's avatar
Kenichi Handa committed
390

391 392
  /* Face of the glyph.  This is a realized face ID,
     an index in the face cache of the frame.  */
Kenichi Handa's avatar
Kenichi Handa committed
393
  unsigned face_id : FACE_ID_BITS;
394

395
  /* Type of font used to display the character glyph.  May be used to
396
     determine which set of functions to use to obtain font metrics
397 398 399
     for the glyph.  On W32, value should be an enumerator of the type
     w32_char_font_type.  Otherwise it equals FONT_TYPE_UNKNOWN.  */
  unsigned font_type : 3;
400

401 402 403 404 405
  /* A union of sub-structures for different glyph types.  */
  union
  {
    /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH).  */
    struct glyph_slice img;
Paul Eggert's avatar
Paul Eggert committed
406
    /* Start and end indices of glyphs of a grapheme cluster of a
407 408
       composition (type == COMPOSITE_GLYPH).  */
    struct { int from, to; } cmp;
409 410 411 412 413
    /* Pixel offsets for upper and lower part of the acronym.  */
    struct {
      short upper_xoff, upper_yoff;
      short lower_xoff, lower_yoff;
    } glyphless;
414
  } slice;
415

Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418
  /* A union of sub-structures for different glyph types.  */
  union
  {
419 420
    /* Character code for character glyphs (type == CHAR_GLYPH).  */
    unsigned ch;
Gerd Moellmann's avatar
Gerd Moellmann committed
421

422
    /* Sub-structures for type == COMPOSITE_GLYPH.  */
423 424 425 426 427
    struct
    {
      /* Flag to tell if the composition is automatic or not.  */
      unsigned automatic : 1;
      /* ID of the composition.  */
428
      unsigned id    : 31;
429
    } cmp;
430

431
    /* Image ID for image glyphs (type == IMAGE_GLYPH).  */
432
    int img_id;
Gerd Moellmann's avatar
Gerd Moellmann committed
433 434 435 436 437

    /* Sub-structure for type == STRETCH_GLYPH.  */
    struct
    {
      /* The height of the glyph.  */
438
      unsigned height  : 16;
Gerd Moellmann's avatar
Gerd Moellmann committed
439 440

      /* The ascent of the glyph.  */
441
      unsigned ascent  : 16;
Gerd Moellmann's avatar
Gerd Moellmann committed
442 443
    }
    stretch;
444

445 446 447 448 449 450 451 452 453 454
    /* Sub-stretch for type == GLYPHLESS_GLYPH.  */
    struct
    {
      /* Value is an enum of the type glyphless_display_method.  */
      unsigned method : 2;
      /* 1 iff this glyph is for a character of no font. */
      unsigned for_no_font : 1;
      /* Length of acronym or hexadecimal code string (at most 8).  */
      unsigned len : 4;
      /* Character to display.  Actually we need only 22 bits.  */
455
      unsigned ch : 25;
456 457
    } glyphless;

Gerd Moellmann's avatar
Gerd Moellmann committed
458 459 460 461 462 463
    /* Used to compare all bit-fields above in one step.  */
    unsigned val;
  } u;
};


464 465 466 467
/* Default value of the glyph font_type field.  */

#define FONT_TYPE_UNKNOWN	0

Gerd Moellmann's avatar
Gerd Moellmann committed
468 469 470
/* Is GLYPH a space?  */

#define CHAR_GLYPH_SPACE_P(GLYPH) \
471
  ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
Gerd Moellmann's avatar
Gerd Moellmann committed
472

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
/* Are glyph slices of glyphs *X and *Y equal?  It assumes that both
   glyphs have the same type.

   Note: for composition glyphs, we don't have to compare slice.cmp.to
   because they should be the same if and only if slice.cmp.from are
   the same.  */

#define GLYPH_SLICE_EQUAL_P(X, Y)				\
  ((X)->type == IMAGE_GLYPH					\
   ? ((X)->slice.img.x == (Y)->slice.img.x			\
      && (X)->slice.img.y == (Y)->slice.img.y			\
      && (X)->slice.img.width == (Y)->slice.img.width		\
      && (X)->slice.img.height == (Y)->slice.img.height)	\
   : ((X)->type != COMPOSITE_GLYPH				\
      || (X)->slice.cmp.from == (Y)->slice.cmp.from))
488

Gerd Moellmann's avatar
Gerd Moellmann committed
489
/* Are glyphs *X and *Y displayed equal?  */
490

Gerd Moellmann's avatar
Gerd Moellmann committed
491 492 493
#define GLYPH_EQUAL_P(X, Y)					\
     ((X)->type == (Y)->type					\
      && (X)->u.val == (Y)->u.val				\
494
      && GLYPH_SLICE_EQUAL_P (X, Y)				\
495 496
      && (X)->face_id == (Y)->face_id				\
      && (X)->padding_p == (Y)->padding_p			\
Gerd Moellmann's avatar
Gerd Moellmann committed
497 498
      && (X)->left_box_line_p == (Y)->left_box_line_p		\
      && (X)->right_box_line_p == (Y)->right_box_line_p		\
499 500
      && (X)->voffset == (Y)->voffset				\
      && (X)->pixel_width == (Y)->pixel_width)
Gerd Moellmann's avatar
Gerd Moellmann committed
501

502 503 504 505 506 507 508
/* Are character codes, faces, padding_ps of glyphs *X and *Y equal?  */

#define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y)	\
  ((X)->u.ch == (Y)->u.ch			\
   && (X)->face_id == (Y)->face_id		\
   && (X)->padding_p == (Y)->padding_p)

Gerd Moellmann's avatar
Gerd Moellmann committed
509 510
/* Fill a character glyph GLYPH.  CODE, FACE_ID, PADDING_P correspond
   to the bits defined for the typedef `GLYPH' in lisp.h.  */
511

Gerd Moellmann's avatar
Gerd Moellmann committed
512 513 514
#define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P)	\
     do							\
       {						\
515 516 517
         (GLYPH).u.ch = (CODE);				\
         (GLYPH).face_id = (FACE_ID);			\
         (GLYPH).padding_p = (PADDING_P);		\
Gerd Moellmann's avatar
Gerd Moellmann committed
518 519 520 521 522
       }						\
     while (0)

/* Fill a character type glyph GLYPH from a glyph typedef FROM as
   defined in lisp.h.  */
523

Gerd Moellmann's avatar
Gerd Moellmann committed
524 525
#define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM)			\
     SET_CHAR_GLYPH ((GLYPH),					\
Kim F. Storm's avatar
Kim F. Storm committed
526 527
	 	     GLYPH_CHAR ((FROM)),			\
		     GLYPH_FACE ((FROM)),			\
528
		     0)
Gerd Moellmann's avatar
Gerd Moellmann committed
529

530 531
/* Construct a glyph code from a character glyph GLYPH.  If the
   character is multibyte, return -1 as we can't use glyph table for a
Pavel Janík's avatar
Pavel Janík committed
532
   multibyte character.  */
533

Kim F. Storm's avatar
Kim F. Storm committed
534 535 536 537 538 539 540 541 542 543 544
#define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH)			\
  do								\
    {								\
      if ((GLYPH).u.ch < 256)					\
	SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id));	\
      else							\
	SET_GLYPH ((G), -1, 0);					\
    }								\
  while (0)

#define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
Gerd Moellmann's avatar
Gerd Moellmann committed
545 546

/* Is GLYPH a padding glyph?  */
547

548
#define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
Gerd Moellmann's avatar
Gerd Moellmann committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575




/***********************************************************************
			     Glyph Pools
 ***********************************************************************/

/* Glyph Pool.

   Glyph memory for frame-based redisplay is allocated from the heap
   in one vector kept in a glyph pool structure which is stored with
   the frame.  The size of the vector is made large enough to cover
   all windows on the frame.

   Both frame and window glyph matrices reference memory from a glyph
   pool in frame-based redisplay.

   In window-based redisplay, no glyphs pools exist; windows allocate
   and free their glyph memory themselves.  */

struct glyph_pool
{
  /* Vector of glyphs allocated from the heap.  */
  struct glyph *glyphs;

  /* Allocated size of `glyphs'.  */
576
  ptrdiff_t nglyphs;
Gerd Moellmann's avatar
Gerd Moellmann committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625

  /* Number of rows and columns in a matrix.  */
  int nrows, ncolumns;
};



/***********************************************************************
			     Glyph Matrix
 ***********************************************************************/

/* Glyph Matrix.

   Three kinds of glyph matrices exist:

   1. Frame glyph matrices.  These are used for terminal frames whose
   redisplay needs a view of the whole screen due to limited terminal
   capabilities.  Frame matrices are used only in the update phase
   of redisplay.  They are built in update_frame and not used after
   the update has been performed.

   2. Window glyph matrices on frames having frame glyph matrices.
   Such matrices are sub-matrices of their corresponding frame matrix,
   i.e. frame glyph matrices and window glyph matrices share the same
   glyph memory which is allocated in form of a glyph_pool structure.
   Glyph rows in such a window matrix are slices of frame matrix rows.

   2. Free-standing window glyph matrices managing their own glyph
   storage.  This form is used in window-based redisplay which
   includes variable width and height fonts etc.

   The size of a window's row vector depends on the height of fonts
   defined on its frame.  It is chosen so that the vector is large
   enough to describe all lines in a window when it is displayed in
   the smallest possible character size.  When new fonts are loaded,
   or window sizes change, the row vector is adjusted accordingly.  */

struct glyph_matrix
{
  /* The pool from which glyph memory is allocated, if any.  This is
     null for frame matrices and for window matrices managing their
     own storage.  */
  struct glyph_pool *pool;

  /* Vector of glyph row structures.  The row at nrows - 1 is reserved
     for the mode line.  */
  struct glyph_row *rows;

  /* Number of elements allocated for the vector rows above.  */
626
  ptrdiff_t rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
627 628 629 630 631 632 633 634 635 636 637 638 639

  /* The number of rows used by the window if all lines were displayed
     with the smallest possible character height.  */
  int nrows;

  /* Origin within the frame matrix if this is a window matrix on a
     frame having a frame matrix.  Both values are zero for
     window-based redisplay.  */
  int matrix_x, matrix_y;

  /* Width and height of the matrix in columns and rows.  */
  int matrix_w, matrix_h;

640
  /* If this structure describes a window matrix of window W,
641 642 643 644 645 646 647 648
     window_left_col is the value of W->left_col, window_top_line the
     value of W->top_line, window_height and window_width are width and
     height of W, as returned by window_box, and window_vscroll is the
     value of W->vscroll at the time the matrix was last adjusted.
     Only set for window-based redisplay.  */
  int window_left_col, window_top_line;
  int window_height, window_width;
  int window_vscroll;
Gerd Moellmann's avatar
Gerd Moellmann committed
649 650 651 652 653 654 655 656 657 658 659 660

  /* Number of glyphs reserved for left and right marginal areas when
     the matrix was last adjusted.  */
  int left_margin_glyphs, right_margin_glyphs;

  /* Flag indicating that scrolling should not be tried in
     update_window.  This flag is set by functions like try_window_id
     which do their own scrolling.  */
  unsigned no_scrolling_p : 1;

  /* Non-zero means window displayed in this matrix has a top mode
     line.  */
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
661
  unsigned header_line_p : 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
662

663
#ifdef GLYPH_DEBUG
Gerd Moellmann's avatar
Gerd Moellmann committed
664 665 666
  /* A string identifying the method used to display the matrix.  */
  char method[512];
#endif
667

Gerd Moellmann's avatar
Gerd Moellmann committed
668 669
  /* The buffer this matrix displays.  Set in
     mark_window_display_accurate_1.  */
670 671
  struct buffer *buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
672 673
  /* Values of BEGV and ZV as of last redisplay.  Set in
     mark_window_display_accurate_1.  */
674
  ptrdiff_t begv, zv;
Gerd Moellmann's avatar
Gerd Moellmann committed
675 676 677 678 679 680
};


/* Check that glyph pointers stored in glyph rows of MATRIX are okay.
   This aborts if any pointer is found twice.  */

681
#ifdef GLYPH_DEBUG
Jan D's avatar
Jan D committed
682
void check_matrix_pointer_lossage (struct glyph_matrix *);
Gerd Moellmann's avatar
Gerd Moellmann committed
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
#define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
#else
#define CHECK_MATRIX(MATRIX) (void) 0
#endif



/***********************************************************************
			     Glyph Rows
 ***********************************************************************/

/* Area in window glyph matrix.  If values are added or removed, the
   function mark_object in alloc.c has to be changed.  */

enum glyph_row_area
{
  LEFT_MARGIN_AREA,
  TEXT_AREA,
  RIGHT_MARGIN_AREA,
  LAST_AREA
};


/* Rows of glyphs in a windows or frame glyph matrix.

   Each row is partitioned into three areas.  The start and end of
   each area is recorded in a pointer as shown below.
710

Gerd Moellmann's avatar
Gerd Moellmann committed
711 712 713 714 715 716 717
   +--------------------+-------------+---------------------+
   |  left margin area  |  text area  |  right margin area  |
   +--------------------+-------------+---------------------+
   |                    |             |                     |
   glyphs[LEFT_MARGIN_AREA]           glyphs[RIGHT_MARGIN_AREA]
			|                                   |
			glyphs[TEXT_AREA]                   |
718
			                      glyphs[LAST_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
719 720 721 722 723

   Rows in frame matrices reference glyph memory allocated in a frame
   glyph pool (see the description of struct glyph_pool).  Rows in
   window matrices on frames having frame matrices reference slices of
   the glyphs of corresponding rows in the frame matrix.
724

Gerd Moellmann's avatar
Gerd Moellmann committed
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
   Rows in window matrices on frames having no frame matrices point to
   glyphs allocated from the heap via xmalloc;
   glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
   glyph structure array.  */

struct glyph_row
{
  /* Pointers to beginnings of areas.  The end of an area A is found at
     A + 1 in the vector.  The last element of the vector is the end
     of the whole row.

     Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
     position field is used.  It is -1 if this row does not correspond
     to any text; it is some buffer position if the row corresponds to
     an empty display line that displays a line end.  This is what old
     redisplay used to do.  (Except in code for terminal frames, this
Pavel Janík's avatar
Pavel Janík committed
741
     kludge is no longer used, I believe. --gerd).
Gerd Moellmann's avatar
Gerd Moellmann committed
742 743 744 745 746 747 748 749 750 751

     See also start, end, displays_text_p and ends_at_zv_p for cleaner
     ways to do it.  The special meaning of positions 0 and -1 will be
     removed some day, so don't use it in new code.  */
  struct glyph *glyphs[1 + LAST_AREA];

  /* Number of glyphs actually filled in areas.  */
  short used[LAST_AREA];

  /* Window-relative x and y-position of the top-left corner of this
Eli Zaretskii's avatar
Eli Zaretskii committed
752
     row.  If y < 0, this means that eabs (y) pixels of the row are
Gerd Moellmann's avatar
Gerd Moellmann committed
753
     invisible because it is partially visible at the top of a window.
Eli Zaretskii's avatar
Eli Zaretskii committed
754
     If x < 0, this means that eabs (x) pixels of the first glyph of
Gerd Moellmann's avatar
Gerd Moellmann committed
755 756 757 758 759
     the text area of the row are invisible because the glyph is
     partially visible.  */
  int x, y;

  /* Width of the row in pixels without taking face extension at the
Gerd Moellmann's avatar
Gerd Moellmann committed
760 761
     end of the row into account, and without counting truncation
     and continuation glyphs at the end of a row on ttys.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
762 763
  int pixel_width;

764 765
  /* Logical ascent/height of this line.  The value of ascent is zero
     and height is 1 on terminal frames.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
766 767
  int ascent, height;

768 769 770 771 772
  /* Physical ascent/height of this line.  If max_ascent > ascent,
     this line overlaps the line above it on the display.  Otherwise,
     if max_height > height, this line overlaps the line beneath it.  */
  int phys_ascent, phys_height;

Gerd Moellmann's avatar
Gerd Moellmann committed
773 774 775 776 777
  /* Portion of row that is visible.  Partially visible rows may be
     found at the top and bottom of a window.  This is 1 for tty
     frames.  It may be < 0 in case of completely invisible rows.  */
  int visible_height;

778 779 780 781
  /* 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;

Gerd Moellmann's avatar
Gerd Moellmann committed
782 783 784 785 786 787
  /* Hash code.  This hash code is available as soon as the row
     is constructed, i.e. after a call to display_line.  */
  unsigned hash;

  /* First position in this row.  This is the text position, including
     overlay position information etc, where the display of this row
788 789 790 791
     started, and can thus be less than the position of the first
     glyph (e.g. due to invisible text or horizontal scrolling).
     BIDI Note: In R2L rows, that have its reversed_p flag set, this
     position is at or beyond the right edge of the row.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
792 793 794 795
  struct display_pos start;

  /* Text position at the end of this row.  This is the position after
     the last glyph on this row.  It can be greater than the last
796 797 798 799 800
     glyph position + 1, due to a newline that ends the line,
     truncation, invisible text etc.  In an up-to-date display, this
     should always be equal to the start position of the next row.
     BIDI Note: In R2L rows, this position is at or beyond the left
     edge of the row.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
801 802
  struct display_pos end;

803 804 805 806 807 808 809 810
  /* The smallest and the largest buffer positions that contributed to
     glyphs in this row.  Note that due to bidi reordering, these are
     in general different from the text positions stored in `start'
     and `end' members above, and also different from the buffer
     positions recorded in the glyphs displayed the leftmost and
     rightmost on the screen.  */
  struct text_pos minpos, maxpos;

811 812 813 814 815
  /* 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;

Kenichi Handa's avatar
Kenichi Handa committed
816 817 818 819 820 821 822 823 824 825 826 827
  /* Left fringe bitmap number (enum fringe_bitmap_type).  */
  unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;

  /* Right fringe bitmap number (enum fringe_bitmap_type).  */
  unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;

  /* Left fringe bitmap number (enum fringe_bitmap_type).  */
  unsigned left_fringe_bitmap : FRINGE_ID_BITS;

  /* Right fringe bitmap number (enum fringe_bitmap_type).  */
  unsigned right_fringe_bitmap : FRINGE_ID_BITS;

828 829 830 831 832 833 834 835 836
  /* 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;

Kenichi Handa's avatar
Kenichi Handa committed
837 838 839
  /* Face of the right fringe glyph.  */
  unsigned right_fringe_face_id : FACE_ID_BITS;

840 841 842 843 844 845
  /* Vertical offset of the left fringe bitmap.  */
  signed left_fringe_offset : FRINGE_HEIGHT_BITS;

  /* Vertical offset of the right fringe bitmap.  */
  signed right_fringe_offset : FRINGE_HEIGHT_BITS;

846 847 848 849
  /* 1 means that at least one of the left and right fringe bitmaps is
     periodic and thus depends on the y-position of the row.  */
  unsigned fringe_bitmap_periodic_p : 1;

Kenichi Handa's avatar
Kenichi Handa committed
850 851 852
  /* 1 means that we must draw the bitmaps of this row.  */
  unsigned redraw_fringe_bitmaps_p : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
  /* In a desired matrix, 1 means that this row must be updated.  In a
     current matrix, 0 means that the row has been invalidated, i.e.
     the row's contents do not agree with what is visible on the
     screen.  */
  unsigned enabled_p : 1;

  /* 1 means row displays a text line that is truncated on the left or
     right side.  */
  unsigned truncated_on_left_p : 1;
  unsigned truncated_on_right_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;

  /* 0 means that this row does not contain any text, i.e. it is
     a blank line at the window and buffer end.  */
  unsigned displays_text_p : 1;

  /* 1 means that this line ends at ZV.  */
  unsigned ends_at_zv_p : 1;

  /* 1 means the face of the last glyph in the text area is drawn to
     the right end of the window.  This flag is used in
     update_text_area to optimize clearing to the end of the area.  */
  unsigned fill_line_p : 1;

  /* Non-zero means display a bitmap on X frames indicating that this
     line contains no text and ends in ZV.  */
  unsigned indicate_empty_line_p : 1;

  /* 1 means this row contains glyphs that overlap each other because
     of lbearing or rbearing.  */
  unsigned contains_overlapping_glyphs_p : 1;

Pavel Janík's avatar
Pavel Janík committed
888
  /* 1 means this row is as wide as the window it is displayed in, including
Kim F. Storm's avatar
Kim F. Storm committed
889
     scroll bars, fringes, and internal borders.  This also
Gerd Moellmann's avatar
Gerd Moellmann committed
890 891 892
     implies that the row doesn't have marginal areas.  */
  unsigned full_width_p : 1;

Pavel Janík's avatar
Pavel Janík committed
893
  /* Non-zero means row is a mode or header-line.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
894 895
  unsigned mode_line_p : 1;

896 897 898
  /* 1 in a current row means this row is overlapped by another row.  */
  unsigned overlapped_p : 1;

899 900 901 902
  /* 1 means this line ends in the middle of a character consisting
     of more than one glyph.  Some glyphs have been put in this row,
     the rest are put in rows below this one.  */
  unsigned ends_in_middle_of_char_p : 1;
903

904 905
  /* 1 means this line starts in the middle of a character consisting
     of more than one glyph.  Some glyphs have been put in the
Pavel Janík's avatar
Pavel Janík committed
906
     previous row, the rest are put in this row.  */
907 908
  unsigned starts_in_middle_of_char_p : 1;

909 910 911
  /* 1 in a current row means this row overlaps others.  */
  unsigned overlapping_p : 1;

912 913 914
  /* 1 means some glyphs in this row are displayed in mouse-face.  */
  unsigned mouse_face_p : 1;

915 916 917
  /* 1 means this row was ended by a newline from a string.  */
  unsigned ends_in_newline_from_string_p : 1;

Kenichi Handa's avatar
Kenichi Handa committed
918 919 920 921 922 923 924
  /* 1 means this row width is exactly the width of the window, and the
     final newline character is hidden in the right fringe.  */
  unsigned exact_window_width_line_p : 1;

  /* 1 means this row currently shows the cursor in the right fringe.  */
  unsigned cursor_in_fringe_p : 1;

925 926 927
  /* 1 means the last glyph in the row is part of an ellipsis.  */
  unsigned ends_in_ellipsis_p : 1;

Kenichi Handa's avatar
Kenichi Handa committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
  /* Non-zero means display a bitmap on X frames indicating that this
     the first line of the buffer.  */
  unsigned indicate_bob_p : 1;

  /* Non-zero means display a bitmap on X frames indicating that this
     the top line of the window, but not start of the buffer.  */
  unsigned indicate_top_line_p : 1;

  /* Non-zero means display a bitmap on X frames indicating that this
     the last line of the buffer.  */
  unsigned indicate_eob_p : 1;

  /* Non-zero means display a bitmap on X frames indicating that this
     the bottom line of the window, but not end of the buffer.  */
  unsigned indicate_bottom_line_p : 1;

944 945 946 947
  /* Non-zero means the row was reversed to display text in a
     right-to-left paragraph.  */
  unsigned reversed_p : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
948 949
  /* Continuation lines width at the start of the row.  */
  int continuation_lines_width;
950

951
#ifdef HAVE_WINDOW_SYSTEM
952 953 954
  /* Non-NULL means the current clipping area.  This is temporarily
     set while exposing a region.  Coordinates are frame-relative.  */
  XRectangle *clip;
955
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
956 957 958 959
};


/* Get a pointer to row number ROW in matrix MATRIX.  If GLYPH_DEBUG
960 961
   is defined, the function matrix_row checks that we don't try to
   access rows that are out of bounds.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
962

963
#ifdef GLYPH_DEBUG
Jan D's avatar
Jan D committed
964
struct glyph_row *matrix_row (struct glyph_matrix *, int);
Gerd Moellmann's avatar
Gerd Moellmann committed
965 966 967 968 969
#define MATRIX_ROW(MATRIX, ROW)   matrix_row ((MATRIX), (ROW))
#else
#define MATRIX_ROW(MATRIX, ROW)	  ((MATRIX)->rows + (ROW))
#endif

970
/* Return a pointer to the row reserved for the mode line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
971 972 973 974 975
   Row MATRIX->nrows - 1 is always reserved for the mode line.  */

#define MATRIX_MODE_LINE_ROW(MATRIX) \
     ((MATRIX)->rows + (MATRIX)->nrows - 1)

Pavel Janík's avatar
Pavel Janík committed
976
/* Return a pointer to the row reserved for the header line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
977 978 979
   This is always the first row in MATRIX because that's the only
   way that works in frame-based redisplay.  */

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
980
#define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
Gerd Moellmann's avatar
Gerd Moellmann committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994

/* Return a pointer to first row in MATRIX used for text display.  */

#define MATRIX_FIRST_TEXT_ROW(MATRIX) \
     ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)

/* Return a pointer to the first glyph in the text area of a row.
   MATRIX is the glyph matrix accessed, and ROW is the row index in
   MATRIX.  */

#define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
     (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])

/* Return the number of used glyphs in the text area of a row.  */
995

Gerd Moellmann's avatar
Gerd Moellmann committed
996 997 998 999
#define MATRIX_ROW_USED(MATRIX, ROW) \
     (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])

/* Return the character/ byte position at which the display of ROW
1000 1001 1002 1003
   starts.  BIDI Note: this is the smallest character/byte position
   among characters in ROW, i.e. the first logical-order character
   displayed by ROW, which is not necessarily the smallest horizontal
   position.  */
1004

1005 1006
#define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
#define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
Gerd Moellmann's avatar
Gerd Moellmann committed
1007

1008 1009 1010 1011
/* Return the character/ byte position at which ROW ends.  BIDI Note:
   this is the largest character/byte position among characters in
   ROW, i.e. the last logical-order character displayed by ROW, which
   is not necessarily the largest horizontal position.  */
1012

1013 1014
#define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
#define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
Gerd Moellmann's avatar
Gerd Moellmann committed
1015 1016

/* Return the vertical position of ROW in MATRIX.  */
1017

Gerd Moellmann's avatar
Gerd Moellmann committed
1018 1019 1020 1021 1022
#define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)

/* Return the last glyph row + 1 in MATRIX on window W reserved for
   text.  If W has a mode line, the last row in the matrix is reserved
   for it.  */
1023

Gerd Moellmann's avatar
Gerd Moellmann committed
1024 1025 1026 1027 1028 1029 1030
#define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W)		\
     ((MATRIX)->rows					\
      + (MATRIX)->nrows					\
      - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))

/* Non-zero if the face of the last glyph in ROW's text area has
   to be drawn to the end of the text area.  */
1031

Gerd Moellmann's avatar
Gerd Moellmann committed
1032 1033 1034
#define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)

/* Set and query the enabled_p flag of glyph row ROW in MATRIX.  */
1035

Gerd Moellmann's avatar
Gerd Moellmann committed
1036 1037
#define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
     (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1038

Gerd Moellmann's avatar
Gerd Moellmann committed
1039 1040 1041 1042 1043
#define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
     (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)

/* Non-zero if ROW displays text.  Value is non-zero if the row is
   blank but displays a line end.  */
1044

Gerd Moellmann's avatar
Gerd Moellmann committed
1045 1046
#define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059

/* 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)))

Gerd Moellmann's avatar
Gerd Moellmann committed
1060
/* Non-zero if ROW is not completely visible in window W.  */
1061

1062 1063 1064 1065 1066 1067
#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))))


Gerd Moellmann's avatar
Gerd Moellmann committed
1068 1069

/* Non-zero if ROW is partially visible at the top of window W.  */
1070

Gerd Moellmann's avatar
Gerd Moellmann committed
1071
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW)		\
1072 1073
  (MR_PARTIALLY_VISIBLE ((ROW))					\
   && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1074 1075

/* Non-zero if ROW is partially visible at the bottom of window W.  */
1076

1077 1078 1079
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW)	\
  (MR_PARTIALLY_VISIBLE ((ROW))					\
   && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1080 1081

/* Return the bottom Y + 1 of ROW.   */
1082

Gerd Moellmann's avatar
Gerd Moellmann committed
1083 1084 1085 1086
#define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)

/* Is ROW the last visible one in the display described by the
   iterator structure pointed to by IT?.  */
1087

Gerd Moellmann's avatar
Gerd Moellmann committed
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
#define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
     (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)

/* Non-zero if ROW displays a continuation line.  */

#define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
     ((ROW)->continuation_lines_width > 0)

/* Non-zero if ROW ends in the middle of a character.  This is the
   case for continued lines showing only part of a display table entry
   or a control char, or an overlay string.  */

#define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW)	\
1101
     ((ROW)->end.dpvec_index > 0			\
1102 1103
      || (ROW)->end.overlay_string_index >= 0		\
      || (ROW)->ends_in_middle_of_char_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
1104 1105 1106 1107 1108 1109 1110

/* Non-zero if ROW ends in the middle of an overlay string.  */

#define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
     ((ROW)->end.overlay_string_index >= 0)

/* Non-zero if ROW starts in the middle of a character.  See above.  */
1111

Gerd Moellmann's avatar
Gerd Moellmann committed
1112
#define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW)	\
1113
     ((ROW)->start.dpvec_index > 0			\
1114
      || (ROW)->starts_in_middle_of_char_p		\
Gerd Moellmann's avatar
Gerd Moellmann committed
1115 1116 1117
      || ((ROW)->start.overlay_string_index >= 0	\
	  && (ROW)->start.string_pos.charpos > 0))

1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
/* Non-zero means ROW overlaps its predecessor.  */

#define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
     ((ROW)->phys_ascent > (ROW)->ascent)

/* Non-zero means ROW overlaps its successor.  */

#define MATRIX_ROW_OVERLAPS_SUCC_P(ROW)		\
      ((ROW)->phys_height - (ROW)->phys_ascent	\
       > (ROW)->height - (ROW)->ascent)

1129
/* True means that fonts have been loaded since the last glyph
Gerd Moellmann's avatar
Gerd Moellmann committed
1130
   matrix adjustments.  The function redisplay_internal adjusts glyph
1131
   matrices when this flag is true.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1132

1133
extern bool fonts_changed_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
1134 1135 1136 1137 1138 1139

/* A glyph for a space.  */

extern struct glyph space_glyph;

/* Window being updated by update_window.  This is non-null as long as
1140
   update_window has not finished, and null otherwise.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151

extern struct window *updated_window;

/* Glyph row and area updated by update_window_line.  */

extern struct glyph_row *updated_row;
extern int updated_area;

/* Non-zero means last display completed.  Zero means it was
   preempted.  */

1152
extern bool display_completed;
Gerd Moellmann's avatar
Gerd Moellmann committed
1153 1154


1155 1156 1157 1158 1159 1160

/************************************************************************
			  Glyph Strings
 ************************************************************************/

/* Enumeration for overriding/changing the face to use for drawing
1161
   glyphs in draw_glyphs.  */
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172

enum draw_glyphs_face
{
  DRAW_NORMAL_TEXT,
  DRAW_INVERSE_VIDEO,
  DRAW_CURSOR,
  DRAW_MOUSE_FACE,
  DRAW_IMAGE_RAISED,
  DRAW_IMAGE_SUNKEN
};

1173 1174
#ifdef HAVE_WINDOW_SYSTEM

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
/* A sequence of glyphs to be drawn in the same face.  */

struct glyph_string
{
  /* X-origin of the string.  */
  int x;

  /* Y-origin and y-position of the base line of this string.  */
  int y, ybase;

  /* The width of the string, not including a face extension.  */
  int width;

  /* The width of the string, including a face extension.  */
  int background_width;

  /* The height of this string.  This is the height of the line this
     string is drawn in, and can be different from the height of the
     font the string is drawn in.  */
  int height;

  /* Number of pixels this string overwrites in front of its x-origin.
     This number is zero if the string has an lbearing >= 0; it is
     -lbearing, if the string has an lbearing < 0.  */
  int left_overhang;

  /* Number of pixels this string overwrites past its right-most
     nominal x-position, i.e. x + width.  Zero if the string's
     rbearing is <= its nominal width, rbearing - width otherwise.  */
  int right_overhang;

  /* The frame on which the glyph string is drawn.  */
  struct frame *f;

  /* The window on which the glyph string is drawn.  */
  struct window *w;

  /* X display and window for convenience.  */
  Display *display;
  Window window;

  /* The glyph row for which this string was built.  It determines the
     y-origin and height of the string.  */
  struct glyph_row *row;

  /* The area within row.  */
  enum glyph_row_area area;

  /* Characters to be drawn, and number of characters.  */
  XChar2b *char2b;
  int nchars;

  /* A face-override for drawing cursors, mouse face and similar.  */
  enum draw_glyphs_face hl;

  /* Face in which this string is to be drawn.  */
  struct face *face;

  /* Font in which this string is to be drawn.  */
1234
  struct font *font;
1235

1236 1237
  /* Non-null means this string describes (part of) a static
     composition.  */