dispextern.h 112 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Interface definitions for display code.
2
   Copyright (C) 1985, 1993, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
Glenn Morris's avatar
Glenn Morris committed
3
                 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

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

#ifdef HAVE_X_WINDOWS
27

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

#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;

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

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

50 51
#ifdef HAVE_X_WINDOWS
typedef struct x_display_info Display_Info;
Kenichi Handa's avatar
Kenichi Handa committed
52 53
typedef XImage * XImagePtr;
typedef XImagePtr XImagePtr_or_DC;
54 55 56
#define NativeRectangle XRectangle
#endif

Geoff Voelker's avatar
Geoff Voelker committed
57
#ifdef HAVE_NTGUI
Geoff Voelker's avatar
Geoff Voelker committed
58
#include "w32gui.h"
59
typedef struct w32_display_info Display_Info;
Kenichi Handa's avatar
Kenichi Handa committed
60 61
typedef XImage *XImagePtr;
typedef HDC XImagePtr_or_DC;
Geoff Voelker's avatar
Geoff Voelker committed
62 63
#endif

64 65 66 67 68 69 70 71
#ifdef HAVE_NS
#include "nsgui.h"
/* following typedef needed to accomodate the MSDOS port, believe it or not */
typedef struct ns_display_info Display_Info;
typedef Pixmap XImagePtr;
typedef XImagePtr XImagePtr_or_DC;
#endif

72 73 74 75
#ifndef NativeRectangle
#define NativeRectangle int
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
76 77 78 79 80 81 82 83 84 85 86 87 88
/* 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;


89 90 91 92 93 94 95 96 97 98 99 100
/* 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,
101 102
  ON_RIGHT_MARGIN,
  ON_SCROLL_BAR
103 104
};

Kenichi Handa's avatar
Kenichi Handa committed
105
/* Number of bits allocated to store fringe bitmap numbers.  */
106
#define FRINGE_ID_BITS  16
Kenichi Handa's avatar
Kenichi Handa committed
107

108 109
/* Number of bits allocated to store fringe bitmap height.  */
#define FRINGE_HEIGHT_BITS 8
110

Gerd Moellmann's avatar
Gerd Moellmann committed
111 112 113 114 115 116 117 118 119 120 121 122

/***********************************************************************
			      Debugging
 ***********************************************************************/

/* If GLYPH_DEBUG is non-zero, additional checks are activated.  Turn
   it off by defining the macro GLYPH_DEBUG to zero.  */

#ifndef GLYPH_DEBUG
#define GLYPH_DEBUG 0
#endif

123 124 125 126 127 128 129
/* 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

Gerd Moellmann's avatar
Gerd Moellmann committed
130 131 132 133 134 135 136 137
/* Macros to include code only if GLYPH_DEBUG != 0.  */

#if GLYPH_DEBUG
#define IF_DEBUG(X)	X
#else
#define IF_DEBUG(X)	(void) 0
#endif

138
#if XASSERTS
139
#define xassert(X)	do {if (!(X)) abort ();} while (0)
140 141 142
#else
#define xassert(X)	(void) 0
#endif
143

Gerd Moellmann's avatar
Gerd Moellmann committed
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
/* Macro for displaying traces of redisplay.  If Emacs was compiled
   with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
   a non-zero value in debugging sessions to activate traces.  */

#if GLYPH_DEBUG

extern int trace_redisplay_p;
#include <stdio.h>

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

#else /* GLYPH_DEBUG == 0 */

#define TRACE(X)	(void) 0

#endif /* GLYPH_DEBUG == 0 */

165

Gerd Moellmann's avatar
Gerd Moellmann committed
166 167 168 169 170 171 172 173

/***********************************************************************
			    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.  */
174

Gerd Moellmann's avatar
Gerd Moellmann committed
175 176 177
struct text_pos
{
  /* Character position.  */
178
  EMACS_INT charpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
179 180

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

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

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

/* Decrement text position POS.  */

209
#define DEC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
210 211 212
     do						\
       {					\
	 --(POS).charpos;			\
213 214 215 216
         if (MULTIBYTE_P)			\
	   DEC_POS ((POS).bytepos);		\
	 else					\
	   --(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
217 218 219 220 221 222 223 224 225 226 227 228 229
       }					\
     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)))
230

Gerd Moellmann's avatar
Gerd Moellmann committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
/* 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.  */
  int overlay_string_index;

  /* 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.  */
277
  CHAR_GLYPH,
Gerd Moellmann's avatar
Gerd Moellmann committed
278

279
  /* Glyph describes a static composition.  */
280 281
  COMPOSITE_GLYPH,

Gerd Moellmann's avatar
Gerd Moellmann committed
282 283 284 285 286 287 288 289
  /* Glyph describes an image.  */
  IMAGE_GLYPH,

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


290 291 292 293 294 295 296 297 298 299 300
/* 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
301 302 303
/* Glyphs.

   Be extra careful when changing this structure!  Esp. make sure that
304
   functions producing glyphs, like append_glyph, fill ALL of the
Gerd Moellmann's avatar
Gerd Moellmann committed
305 306 307
   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
308 309 310 311 312 313 314 315

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.  */
316
  EMACS_INT charpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
317 318

  /* Lisp object source of this glyph.  Currently either a buffer or
319
     a string, if the glyph was produced from characters which came from
Gerd Moellmann's avatar
Gerd Moellmann committed
320 321
     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
322 323 324 325 326
  Lisp_Object object;

  /* Width in pixels.  */
  short pixel_width;

Kenichi Handa's avatar
Kenichi Handa committed
327 328 329
  /* Ascent and descent in pixels.  */
  short ascent, descent;

Gerd Moellmann's avatar
Gerd Moellmann committed
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
  /* 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.  */
  unsigned type : 2;

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

349 350 351 352 353
  /* 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;

354 355 356 357 358 359 360 361 362 363
  /* 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.  */
364 365
  unsigned padding_p : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
366 367 368
  /* 1 means the actual glyph is not available, draw a box instead.
     This can happen when a font couldn't be loaded, or a character
     doesn't have a glyph in a font.  */
369 370
  unsigned glyph_not_available_p : 1;

371 372 373 374
 
  /* Non-zero means don't display cursor here.  */
  unsigned avoid_cursor_p : 1;

375
  /* Resolved bidirectional level of this character [0..63].  */
376
  unsigned resolved_level : 5;
377 378

  /* Resolved bidirectional type of this character, see enum
379 380 381 382 383
     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;
384

385
#define FACE_ID_BITS	20
Kenichi Handa's avatar
Kenichi Handa committed
386

387 388
  /* 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
389
  unsigned face_id : FACE_ID_BITS;
390

391
  /* Type of font used to display the character glyph.  May be used to
392
     determine which set of functions to use to obtain font metrics
393 394 395
     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;
396

397 398
  struct glyph_slice slice;

Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401
  /* A union of sub-structures for different glyph types.  */
  union
  {
402 403
    /* Character code for character glyphs (type == CHAR_GLYPH).  */
    unsigned ch;
Gerd Moellmann's avatar
Gerd Moellmann committed
404

405 406 407 408 409 410 411
    /* Sub-structures for type == COMPOSITION_GLYPH.  */
    struct
    {
      /* Flag to tell if the composition is automatic or not.  */
      unsigned automatic : 1;
      /* ID of the composition.  */
      unsigned id    : 23;
412
      /* Start and end indices of glyphs of the composition.  */
413 414 415
      unsigned from : 4;
      unsigned to : 4;
    } cmp;
416

417 418
    /* Image ID for image glyphs (type == IMAGE_GLYPH).  */
    unsigned img_id;
Gerd Moellmann's avatar
Gerd Moellmann committed
419 420 421 422 423

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

      /* The ascent of the glyph.  */
427
      unsigned ascent  : 16;
Gerd Moellmann's avatar
Gerd Moellmann committed
428 429
    }
    stretch;
430

Gerd Moellmann's avatar
Gerd Moellmann committed
431 432 433 434 435 436
    /* Used to compare all bit-fields above in one step.  */
    unsigned val;
  } u;
};


437 438 439 440
/* Default value of the glyph font_type field.  */

#define FONT_TYPE_UNKNOWN	0

Gerd Moellmann's avatar
Gerd Moellmann committed
441 442 443
/* Is GLYPH a space?  */

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

446 447 448 449 450 451 452 453
/* 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)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
456 457 458
#define GLYPH_EQUAL_P(X, Y)					\
     ((X)->type == (Y)->type					\
      && (X)->u.val == (Y)->u.val				\
459
      && GLYPH_SLICE_EQUAL_P (X, Y)				\
460 461
      && (X)->face_id == (Y)->face_id				\
      && (X)->padding_p == (Y)->padding_p			\
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463
      && (X)->left_box_line_p == (Y)->left_box_line_p		\
      && (X)->right_box_line_p == (Y)->right_box_line_p		\
464 465
      && (X)->voffset == (Y)->voffset				\
      && (X)->pixel_width == (Y)->pixel_width)
Gerd Moellmann's avatar
Gerd Moellmann committed
466

467 468 469 470 471 472 473
/* 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
474 475
/* Fill a character glyph GLYPH.  CODE, FACE_ID, PADDING_P correspond
   to the bits defined for the typedef `GLYPH' in lisp.h.  */
476

Gerd Moellmann's avatar
Gerd Moellmann committed
477 478 479
#define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P)	\
     do							\
       {						\
480 481 482
         (GLYPH).u.ch = (CODE);				\
         (GLYPH).face_id = (FACE_ID);			\
         (GLYPH).padding_p = (PADDING_P);		\
Gerd Moellmann's avatar
Gerd Moellmann committed
483 484 485 486 487
       }						\
     while (0)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
489 490
#define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM)			\
     SET_CHAR_GLYPH ((GLYPH),					\
Kim F. Storm's avatar
Kim F. Storm committed
491 492
	 	     GLYPH_CHAR ((FROM)),			\
		     GLYPH_FACE ((FROM)),			\
493
		     0)
Gerd Moellmann's avatar
Gerd Moellmann committed
494

495 496
/* 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
497
   multibyte character.  */
498

Kim F. Storm's avatar
Kim F. Storm committed
499 500 501 502 503 504 505 506 507 508 509
#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
510 511

/* Is GLYPH a padding glyph?  */
512

513
#define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
Gerd Moellmann's avatar
Gerd Moellmann committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 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 576 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




/***********************************************************************
			     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'.  */
  int nglyphs;

  /* 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.  */
  int rows_allocated;

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

605
  /* If this structure describes a window matrix of window W,
606 607 608 609 610 611 612 613
     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
614 615 616 617 618 619 620 621 622 623 624 625

  /* 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
626
  unsigned header_line_p : 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
627 628 629 630 631

#ifdef GLYPH_DEBUG
  /* A string identifying the method used to display the matrix.  */
  char method[512];
#endif
632

Gerd Moellmann's avatar
Gerd Moellmann committed
633 634
  /* The buffer this matrix displays.  Set in
     mark_window_display_accurate_1.  */
635 636
  struct buffer *buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
637 638
  /* Values of BEGV and ZV as of last redisplay.  Set in
     mark_window_display_accurate_1.  */
639
  int begv, zv;
Gerd Moellmann's avatar
Gerd Moellmann committed
640 641 642 643 644 645 646
};


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

#if GLYPH_DEBUG
Jan D's avatar
Jan D committed
647
void check_matrix_pointer_lossage (struct glyph_matrix *);
Gerd Moellmann's avatar
Gerd Moellmann committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
#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.
675

Gerd Moellmann's avatar
Gerd Moellmann committed
676 677 678 679 680 681 682
   +--------------------+-------------+---------------------+
   |  left margin area  |  text area  |  right margin area  |
   +--------------------+-------------+---------------------+
   |                    |             |                     |
   glyphs[LEFT_MARGIN_AREA]           glyphs[RIGHT_MARGIN_AREA]
			|                                   |
			glyphs[TEXT_AREA]                   |
683
			                      glyphs[LAST_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
684 685 686 687 688

   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.
689

Gerd Moellmann's avatar
Gerd Moellmann committed
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
   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
706
     kludge is no longer used, I believe. --gerd).
Gerd Moellmann's avatar
Gerd Moellmann committed
707 708 709 710 711 712 713 714 715 716

     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
717
     row.  If y < 0, this means that eabs (y) pixels of the row are
Gerd Moellmann's avatar
Gerd Moellmann committed
718
     invisible because it is partially visible at the top of a window.
Eli Zaretskii's avatar
Eli Zaretskii committed
719
     If x < 0, this means that eabs (x) pixels of the first glyph of
Gerd Moellmann's avatar
Gerd Moellmann committed
720 721 722 723 724
     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
725 726
     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
727 728
  int pixel_width;

729 730
  /* 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
731 732
  int ascent, height;

733 734 735 736 737
  /* 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
738 739 740 741 742
  /* 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;

743 744 745 746
  /* 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
747 748 749 750 751 752
  /* 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
753 754 755 756
     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
757 758 759 760
  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
761 762 763 764 765
     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
766 767
  struct display_pos end;

768 769 770 771 772 773 774 775
  /* 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;

776 777 778 779 780
  /* 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
781 782 783 784 785 786 787 788 789 790 791 792
  /* 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;

793 794 795 796 797 798 799 800 801
  /* 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
802 803 804
  /* Face of the right fringe glyph.  */
  unsigned right_fringe_face_id : FACE_ID_BITS;

805 806 807 808 809 810
  /* 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;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
  /* 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
849
  /* 1 means this row is as wide as the window it is displayed in, including
Kim F. Storm's avatar
Kim F. Storm committed
850
     scroll bars, fringes, and internal borders.  This also
Gerd Moellmann's avatar
Gerd Moellmann committed
851 852 853
     implies that the row doesn't have marginal areas.  */
  unsigned full_width_p : 1;

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

857 858 859
  /* 1 in a current row means this row is overlapped by another row.  */
  unsigned overlapped_p : 1;

860 861 862 863
  /* 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;
864

865 866
  /* 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
867
     previous row, the rest are put in this row.  */
868 869
  unsigned starts_in_middle_of_char_p : 1;

870 871 872
  /* 1 in a current row means this row overlaps others.  */
  unsigned overlapping_p : 1;

873 874 875
  /* 1 means some glyphs in this row are displayed in mouse-face.  */
  unsigned mouse_face_p : 1;

876 877 878
  /* 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
879 880 881 882 883 884 885
  /* 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;

886 887 888
  /* 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
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
  /* 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;

905 906 907 908
  /* 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
909 910
  /* Continuation lines width at the start of the row.  */
  int continuation_lines_width;
911

912
#ifdef HAVE_WINDOW_SYSTEM
913 914 915
  /* Non-NULL means the current clipping area.  This is temporarily
     set while exposing a region.  Coordinates are frame-relative.  */
  XRectangle *clip;
916
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
917 918 919 920 921 922 923 924
};


/* Get a pointer to row number ROW in matrix MATRIX.  If GLYPH_DEBUG
   is defined to a non-zero value, the function matrix_row checks that
   we don't try to access rows that are out of bounds.  */

#if GLYPH_DEBUG
Jan D's avatar
Jan D committed
925
struct glyph_row *matrix_row (struct glyph_matrix *, int);
Gerd Moellmann's avatar
Gerd Moellmann committed
926 927 928 929 930
#define MATRIX_ROW(MATRIX, ROW)   matrix_row ((MATRIX), (ROW))
#else
#define MATRIX_ROW(MATRIX, ROW)	  ((MATRIX)->rows + (ROW))
#endif

931
/* Return a pointer to the row reserved for the mode line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
932 933 934 935 936
   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
937
/* Return a pointer to the row reserved for the header line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
938 939 940
   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
941
#define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
Gerd Moellmann's avatar
Gerd Moellmann committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955

/* 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.  */
956

Gerd Moellmann's avatar
Gerd Moellmann committed
957 958 959 960
#define MATRIX_ROW_USED(MATRIX, ROW) \
     (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])

/* Return the character/ byte position at which the display of ROW
961 962 963 964
   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.  */
965

966 967
#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
968

969 970 971 972
/* 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.  */
973

974 975
#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
976 977

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

Gerd Moellmann's avatar
Gerd Moellmann committed
979 980 981 982 983
#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.  */
984

Gerd Moellmann's avatar
Gerd Moellmann committed
985 986 987 988 989 990 991
#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.  */
992

Gerd Moellmann's avatar
Gerd Moellmann committed
993 994 995
#define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
997 998
#define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
     (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
999

Gerd Moellmann's avatar
Gerd Moellmann committed
1000 1001 1002 1003 1004
#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.  */
1005

Gerd Moellmann's avatar
Gerd Moellmann committed
1006 1007
#define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020

/* 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
1021
/* Non-zero if ROW is not completely visible in window W.  */
1022

1023 1024 1025 1026 1027 1028
#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
1029 1030

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1032
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW)		\
1033 1034
  (MR_PARTIALLY_VISIBLE ((ROW))					\
   && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1035 1036

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

1038 1039 1040
#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
1041 1042

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1044 1045 1046 1047
#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?.  */
1048

Gerd Moellmann's avatar
Gerd Moellmann committed
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
#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)	\
1062
     ((ROW)->end.dpvec_index > 0			\
1063 1064
      || (ROW)->end.overlay_string_index >= 0		\
      || (ROW)->ends_in_middle_of_char_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
1065 1066 1067 1068 1069 1070 1071

/* 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.  */
1072

Gerd Moellmann's avatar
Gerd Moellmann committed
1073
#define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW)	\
1074
     ((ROW)->start.dpvec_index > 0			\
1075
      || (ROW)->starts_in_middle_of_char_p		\
Gerd Moellmann's avatar
Gerd Moellmann committed
1076 1077 1078
      || ((ROW)->start.overlay_string_index >= 0	\
	  && (ROW)->start.string_pos.charpos > 0))

1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
/* 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)

Gerd Moellmann's avatar
Gerd Moellmann committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
/* Non-zero means that fonts have been loaded since the last glyph
   matrix adjustments.  The function redisplay_internal adjusts glyph
   matrices when this flag is non-zero.  */

extern int fonts_changed_p;

/* A glyph for a space.  */

extern struct glyph space_glyph;

/* Window being updated by update_window.  This is non-null as long as
1101
   update_window has not finished, and null otherwise.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122

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 reading single-character input with prompt so put
   cursor on mini-buffer after the prompt.  Positive means at end of
   text in echo area; negative means at beginning of line.  */

extern int cursor_in_echo_area;

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

extern int display_completed;

/* A temporary storage area, including a row of glyphs.  Initialized
   in xdisp.c.  Used for various purposes, as an example see
1123
   get_overlay_arrow_glyph_row.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1124 1125 1126 1127

extern struct glyph_row scratch_glyph_row;


1128 1129 1130 1131 1132 1133

/************************************************************************
			  Glyph Strings
 ************************************************************************/

/* Enumeration for overriding/changing the face to use for drawing
1134
   glyphs in draw_glyphs.  */
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145

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

1146 1147
#ifdef HAVE_WINDOW_SYSTEM

1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 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
/* 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.  */
1207
  struct font *font;
1208

1209 1210
  /* Non-null means this string describes (part of) a static
     composition.  */
1211 1212
  struct composition *cmp;

1213 1214 1215 1216 1217
  /* If not negative, this string describes a compos.  */
  int cmp_id;

  /* Start and end glyph indices in a glyph-string.  */
  int cmp_from, cmp_to;
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237

  /* 1 means this glyph strings face has to be drawn to the right end
     of the window's drawing area.  */
  unsigned extends_to_end_of_line_p : 1;

  /* 1 means the background of this string has been drawn.  */
  unsigned background_filled_p : 1;

  /* 1 means glyph string must be drawn with 16-bit functions.  */
  unsigned two_byte_p : 1;

  /* 1 means that the original font determined for drawing this glyph
     string could not be loaded.  The member `font' has been set to
     the frame's default font in this case.  */
  unsigned font_not_found_p : 1;

  /* 1 means that the face in which this glyph string is drawn has a
     stipple pattern.  */
  unsigned stippled_p : 1;

1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
#define OVERLAPS_PRED		(1 << 0)
#define OVERLAPS_SUCC		(1 << 1)
#define OVERLAPS_BOTH		(OVERLAPS_PRED | OVERLAPS_SUCC)
#define OVERLAPS_ERASED_CURSOR 	(1 << 2)
  /* Non-zero means only the foreground of this glyph string must be
     drawn, and we should use the physical height of the line this
     glyph string appears in as clip rect.  If the value is
     OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
     of the erased cursor.  OVERLAPS_PRED and OVERLAPS_SUCC mean we
     draw overlaps with the preceding and the succeeding rows,
     respectively.  */
  unsigned for_overlaps : 3;
1250

1251 1252 1253 1254 1255
  /* 1 means that all glyphs in this glyph string has the flag
     padding_p set, and thus must be drawn one by one to have 1-pixel
     width even though the logical width in the font is zero.  */
  unsigned padding_p : 1;

1256
  /* The GC to use for drawing this glyph string.  */
1257
#if defined(HAVE_X_WINDOWS)
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
  GC gc;
#endif
#if defined(HAVE_NTGUI)
  XGCValues *gc;
  HDC hdc;
#endif

  /* A pointer to the first glyph in the string.  This glyph
     corresponds to char2b[0].  Needed to draw rectangles if
     font_not_found_p is 1.  */
  struct glyph *first_glyph;

  /* Image, if any.  */
  struct image *img;

1273 1274 1275
  /* Slice */
  struct glyph_slice slice;

1276 1277 1278 1279 1280
  /* 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;

1281 1282 1283 1284 1285
  /* The current clipping areas.  */
  NativeRectangle clip[2];

  /* Number of clipping areas. */
  int num_clips;
1286

1287 1288 1289 1290
  int underline_position;

  int underline_thickness;

1291 1292 1293
  struct glyph_string *next, *prev;
};

1294
#endif /* HAVE_WINDOW_SYSTEM */
1295

Gerd Moellmann's avatar
Gerd Moellmann committed
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309

/************************************************************************
			  Display Dimensions
 ************************************************************************/

/* Return the height of the mode line in glyph matrix MATRIX, or zero
   if not known.  This macro is called under circumstances where
   MATRIX might not have been allocated yet.  */

#define MATRIX_MODE_LINE_HEIGHT(MATRIX)		\
     ((MATRIX) && (MATRIX)->rows		\
      ? MATRIX_MODE_LINE_ROW (MATRIX)->height	\
      : 0)

Pavel Janík's avatar
Pavel Janík committed
1310
/* Return the height of the header line in glyph matrix MATRIX, or zero
Gerd Moellmann's avatar
Gerd Moellmann committed
1311 1312 1313
   if not known.  This macro is called under circumstances where
   MATRIX might not have been allocated yet.  */

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1314
#define MATRIX_HEADER_LINE_HEIGHT(MATRIX)	\
Gerd Moellmann's avatar
Gerd Moellmann committed
1315
     ((MATRIX) && (MATRIX)->rows		\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1316
      ? MATRIX_HEADER_LINE_ROW (MATRIX)->height	\
Gerd Moellmann's avatar
Gerd Moellmann committed
1317 1318
      : 0)

1319 1320 1321 1322 1323 1324 1325 1326
/* Return the desired face id for the mode line of a window, depending
   on whether the window is selected or not, or if the window is the
   scrolling window for the currently active minibuffer window.

   Due to the way display_mode_lines manipulates with the contents of
   selected_window, this macro needs three arguments: SELW which is
   compared against the current value of selected_window, MBW which is
   compared against minibuf_window (if SELW doesn't match), and SCRW
1327
   which is compar