dispextern.h 91.6 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, 2003
Gerd Moellmann's avatar
Gerd Moellmann committed
3
     Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

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

#ifdef HAVE_X_WINDOWS
28

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

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

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

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

51 52 53 54 55
#ifdef HAVE_X_WINDOWS
typedef struct x_display_info Display_Info;
#define NativeRectangle XRectangle
#endif

Geoff Voelker's avatar
Geoff Voelker committed
56
#ifdef HAVE_NTGUI
Geoff Voelker's avatar
Geoff Voelker committed
57
#include "w32gui.h"
58
typedef struct w32_display_info Display_Info;
Geoff Voelker's avatar
Geoff Voelker committed
59 60
#endif

61
#ifdef HAVE_CARBON
62
#include "macgui.h"
63
typedef struct mac_display_info Display_Info;
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

/* Include Carbon.h to define Cursor and Rect.  */
#undef mktime
#undef DEBUG
#undef Z
#undef free
#undef malloc
#undef realloc
/* Macros max and min defined in lisp.h conflict with those in
   precompiled header Carbon.h.  */
#undef max
#undef min
#undef init_process
#include <Carbon/Carbon.h>
#undef Z
#define Z (current_buffer->text->z)
#undef free
#define free unexec_free
#undef malloc
#define malloc unexec_malloc
#undef realloc
#define realloc unexec_realloc
#undef min
#define min(a, b) ((a) < (b) ? (a) : (b))
#undef max
#define max(a, b) ((a) > (b) ? (a) : (b))
#undef init_process
#define init_process emacs_init_process

93
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
94

95

96 97 98 99 100
#ifndef NativeRectangle
#define NativeRectangle int
#endif


Gerd Moellmann's avatar
Gerd Moellmann committed
101 102 103 104 105 106 107 108 109 110 111 112 113
/* 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;


114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
/* 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,
  ON_RIGHT_MARGIN
};


Gerd Moellmann's avatar
Gerd Moellmann committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145

/***********************************************************************
			      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

/* Macros to include code only if GLYPH_DEBUG != 0.  */

#if GLYPH_DEBUG
#define IF_DEBUG(X)	X
146
#define xassert(X)	do {if (!(X)) abort ();} while (0)
Gerd Moellmann's avatar
Gerd Moellmann committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
#else
#define IF_DEBUG(X)	(void) 0
#define xassert(X)	(void) 0
#endif

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

173

Gerd Moellmann's avatar
Gerd Moellmann committed
174 175 176 177 178 179 180 181

/***********************************************************************
			    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.  */
182

Gerd Moellmann's avatar
Gerd Moellmann committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
struct text_pos
{
  /* Character position.  */
  int charpos;

  /* Corresponding byte position.  */
  int bytepos;
};

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

204
#define INC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
205 206 207
     do						\
       {					\
	 ++(POS).charpos;			\
208 209 210 211
         if (MULTIBYTE_P)			\
	   INC_POS ((POS).bytepos);		\
	 else					\
	   ++(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
212 213 214 215 216
       }					\
     while (0)

/* Decrement text position POS.  */

217
#define DEC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
218 219 220
     do						\
       {					\
	 --(POS).charpos;			\
221 222 223 224
         if (MULTIBYTE_P)			\
	   DEC_POS ((POS).bytepos);		\
	 else					\
	   --(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
225 226 227 228 229 230 231 232 233 234 235 236 237
       }					\
     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)))
238

Gerd Moellmann's avatar
Gerd Moellmann committed
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 277 278 279 280 281 282 283 284
/* 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.  */
285
  CHAR_GLYPH,
Gerd Moellmann's avatar
Gerd Moellmann committed
286

287 288 289
  /* Glyph describes a composition sequence.  */
  COMPOSITE_GLYPH,

Gerd Moellmann's avatar
Gerd Moellmann committed
290 291 292 293 294 295 296 297
  /* Glyph describes an image.  */
  IMAGE_GLYPH,

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


Gerd Moellmann's avatar
Gerd Moellmann committed
298 299 300
/* Glyphs.

   Be extra careful when changing this structure!  Esp. make sure that
301
   functions producing glyphs, like append_glyph, fill ALL of the
Gerd Moellmann's avatar
Gerd Moellmann committed
302 303 304
   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
305 306 307 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.  */
  int charpos;

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

  /* Width in pixels.  */
  short pixel_width;

324 325 326
  /* Ascent and descent in pixels.  */
  short ascent, descent;

Gerd Moellmann's avatar
Gerd Moellmann committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
  /* 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;

346 347 348 349 350
  /* 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;

351 352 353 354 355 356 357 358 359
  /* 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.  Only used for terminal
     frames, and there only to minimize code changes.  A better way
     would probably be to use the width field of glyphs to express
     padding. */
  unsigned padding_p : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
360 361 362
  /* 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.  */
363 364
  unsigned glyph_not_available_p : 1;

365 366
#define FACE_ID_BITS	21

367
  /* Face of the glyph.  */
368
  unsigned face_id : FACE_ID_BITS;
369

370
  /* Type of font used to display the character glyph.  May be used to
371
     determine which set of functions to use to obtain font metrics
372 373 374
     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;
375

Gerd Moellmann's avatar
Gerd Moellmann committed
376 377 378
  /* A union of sub-structures for different glyph types.  */
  union
  {
379 380
    /* Character code for character glyphs (type == CHAR_GLYPH).  */
    unsigned ch;
Gerd Moellmann's avatar
Gerd Moellmann committed
381

382 383
    /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH)  */
    unsigned cmp_id;
384

385 386
    /* Image ID for image glyphs (type == IMAGE_GLYPH).  */
    unsigned img_id;
Gerd Moellmann's avatar
Gerd Moellmann committed
387 388 389 390 391

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

      /* The ascent of the glyph.  */
395
      unsigned ascent  : 16;
Gerd Moellmann's avatar
Gerd Moellmann committed
396 397
    }
    stretch;
398

Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401 402 403 404
    /* Used to compare all bit-fields above in one step.  */
    unsigned val;
  } u;
};


405 406 407 408
/* Default value of the glyph font_type field.  */

#define FONT_TYPE_UNKNOWN	0

Gerd Moellmann's avatar
Gerd Moellmann committed
409 410 411 412 413
/* Is GLYPH a space?  */

#define CHAR_GLYPH_SPACE_P(GLYPH) \
     (GLYPH_FROM_CHAR_GLYPH ((GLYPH)) == SPACEGLYPH)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418
#define GLYPH_EQUAL_P(X, Y)					\
     ((X)->type == (Y)->type					\
      && (X)->u.val == (Y)->u.val				\
419 420
      && (X)->face_id == (Y)->face_id				\
      && (X)->padding_p == (Y)->padding_p			\
Gerd Moellmann's avatar
Gerd Moellmann committed
421 422
      && (X)->left_box_line_p == (Y)->left_box_line_p		\
      && (X)->right_box_line_p == (Y)->right_box_line_p		\
423 424
      && (X)->voffset == (Y)->voffset				\
      && (X)->pixel_width == (Y)->pixel_width)
Gerd Moellmann's avatar
Gerd Moellmann committed
425

426 427 428 429 430 431 432
/* 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
433 434
/* Fill a character glyph GLYPH.  CODE, FACE_ID, PADDING_P correspond
   to the bits defined for the typedef `GLYPH' in lisp.h.  */
435

Gerd Moellmann's avatar
Gerd Moellmann committed
436 437 438
#define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P)	\
     do							\
       {						\
439 440 441
         (GLYPH).u.ch = (CODE);				\
         (GLYPH).face_id = (FACE_ID);			\
         (GLYPH).padding_p = (PADDING_P);		\
Gerd Moellmann's avatar
Gerd Moellmann committed
442 443 444 445 446
       }						\
     while (0)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
448 449 450 451
#define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM)			\
     SET_CHAR_GLYPH ((GLYPH),					\
	 	     FAST_GLYPH_CHAR ((FROM)),			\
		     FAST_GLYPH_FACE ((FROM)),			\
452
		     0)
Gerd Moellmann's avatar
Gerd Moellmann committed
453

454 455
/* 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
456
   multibyte character.  */
457

458 459 460
#define GLYPH_FROM_CHAR_GLYPH(GLYPH)				\
  ((GLYPH).u.ch < 256						\
   ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS))	\
461
   : -1)
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463

/* Is GLYPH a padding glyph?  */
464

465
#define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
Gerd Moellmann's avatar
Gerd Moellmann committed
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 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



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

557
  /* If this structure describes a window matrix of window W,
558 559 560 561 562 563 564 565
     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
566 567 568 569 570 571 572 573 574 575 576 577

  /* 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
578
  unsigned header_line_p : 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
579 580 581 582 583

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

Gerd Moellmann's avatar
Gerd Moellmann committed
585 586
  /* The buffer this matrix displays.  Set in
     mark_window_display_accurate_1.  */
587 588
  struct buffer *buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
589 590
  /* Values of BEGV and ZV as of last redisplay.  Set in
     mark_window_display_accurate_1.  */
591
  int begv, zv;
Gerd Moellmann's avatar
Gerd Moellmann committed
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 626
};


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

#if GLYPH_DEBUG
void check_matrix_pointer_lossage P_ ((struct glyph_matrix *));
#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.
627

Gerd Moellmann's avatar
Gerd Moellmann committed
628 629 630 631 632 633 634
   +--------------------+-------------+---------------------+
   |  left margin area  |  text area  |  right margin area  |
   +--------------------+-------------+---------------------+
   |                    |             |                     |
   glyphs[LEFT_MARGIN_AREA]           glyphs[RIGHT_MARGIN_AREA]
			|                                   |
			glyphs[TEXT_AREA]                   |
635
			                      glyphs[LAST_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
636 637 638 639 640

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

Gerd Moellmann's avatar
Gerd Moellmann committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
   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
658
     kludge is no longer used, I believe. --gerd).
Gerd Moellmann's avatar
Gerd Moellmann committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

     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
     row.  If y < 0, this means that abs (y) pixels of the row are
     invisible because it is partially visible at the top of a window.
     If x < 0, this means that abs (x) pixels of the first glyph of
     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
677 678
     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
679 680
  int pixel_width;

681 682
  /* 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
683 684
  int ascent, height;

685 686 687 688 689
  /* 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
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  /* 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;

  /* 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
     started, and can thus be less the position of the first glyph
     (e.g. due to invisible text or horizontal scrolling).  */
  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
     glyph position + 1, due to truncation, invisible text etc.  In an
     up-to-date display, this should always be equal to the start
     position of the next row.  */
  struct display_pos end;

  /* 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 the overlay arrow is on this line.  */
  unsigned overlay_arrow_p : 1;
725

Gerd Moellmann's avatar
Gerd Moellmann committed
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749
  /* 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
750
  /* 1 means this row is as wide as the window it is displayed in, including
Kim F. Storm's avatar
Kim F. Storm committed
751
     scroll bars, fringes, and internal borders.  This also
Gerd Moellmann's avatar
Gerd Moellmann committed
752 753 754
     implies that the row doesn't have marginal areas.  */
  unsigned full_width_p : 1;

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

758 759 760
  /* 1 in a current row means this row is overlapped by another row.  */
  unsigned overlapped_p : 1;

761 762 763 764
  /* 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;
765

766 767
  /* 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
768
     previous row, the rest are put in this row.  */
769 770
  unsigned starts_in_middle_of_char_p : 1;

771 772 773
  /* 1 in a current row means this row overlaps others.  */
  unsigned overlapping_p : 1;

774 775 776
  /* 1 means some glyphs in this row are displayed in mouse-face.  */
  unsigned mouse_face_p : 1;

777 778 779
  /* 1 means this row was ended by a newline from a string.  */
  unsigned ends_in_newline_from_string_p : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
  /* Continuation lines width at the start of the row.  */
  int continuation_lines_width;
};


/* 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
struct glyph_row *matrix_row P_ ((struct glyph_matrix *, int));
#define MATRIX_ROW(MATRIX, ROW)   matrix_row ((MATRIX), (ROW))
#else
#define MATRIX_ROW(MATRIX, ROW)	  ((MATRIX)->rows + (ROW))
#endif

796
/* Return a pointer to the row reserved for the mode line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
797 798 799 800 801
   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
802
/* Return a pointer to the row reserved for the header line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
803 804 805
   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
806
#define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
Gerd Moellmann's avatar
Gerd Moellmann committed
807 808 809 810 811 812 813 814 815 816 817 818 819 820

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

Gerd Moellmann's avatar
Gerd Moellmann committed
822 823 824 825 826
#define MATRIX_ROW_USED(MATRIX, ROW) \
     (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])

/* Return the character/ byte position at which the display of ROW
   starts.  */
827

Gerd Moellmann's avatar
Gerd Moellmann committed
828 829 830
#define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->start.pos.charpos)
#define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->start.pos.bytepos)

Pavel Janík's avatar
Pavel Janík committed
831
/* Return the character/ byte position at which ROW ends.  */
832

Gerd Moellmann's avatar
Gerd Moellmann committed
833 834 835 836
#define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->end.pos.charpos)
#define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->end.pos.bytepos)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
838 839 840 841 842
#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.  */
843

Gerd Moellmann's avatar
Gerd Moellmann committed
844 845 846 847 848 849 850
#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.  */
851

Gerd Moellmann's avatar
Gerd Moellmann committed
852 853 854
#define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
856 857
#define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
     (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
858

Gerd Moellmann's avatar
Gerd Moellmann committed
859 860 861 862 863
#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.  */
864

Gerd Moellmann's avatar
Gerd Moellmann committed
865 866 867
#define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)

/* Non-zero if ROW is not completely visible in window W.  */
868

Gerd Moellmann's avatar
Gerd Moellmann committed
869 870 871 872
#define MATRIX_ROW_PARTIALLY_VISIBLE_P(ROW)	\
     ((ROW)->height != (ROW)->visible_height)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
874 875
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW)		\
     (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW))			\
876
      && (ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
Gerd Moellmann's avatar
Gerd Moellmann committed
877 878

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

Gerd Moellmann's avatar
Gerd Moellmann committed
880 881
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW)		      \
     (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW))				      \
882
      && (ROW)->y + (ROW)->height > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
Gerd Moellmann's avatar
Gerd Moellmann committed
883 884

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

Gerd Moellmann's avatar
Gerd Moellmann committed
886 887 888 889
#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?.  */
890

Gerd Moellmann's avatar
Gerd Moellmann committed
891 892 893 894 895 896 897 898 899 900 901 902 903 904
#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)	\
     ((ROW)->end.dpvec_index >= 0			\
905 906
      || (ROW)->end.overlay_string_index >= 0		\
      || (ROW)->ends_in_middle_of_char_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
907 908 909 910 911 912 913

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

Gerd Moellmann's avatar
Gerd Moellmann committed
915 916
#define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW)	\
     ((ROW)->start.dpvec_index >= 0			\
917
      || (ROW)->starts_in_middle_of_char_p		\
Gerd Moellmann's avatar
Gerd Moellmann committed
918 919 920
      || ((ROW)->start.overlay_string_index >= 0	\
	  && (ROW)->start.string_pos.charpos > 0))

921 922 923 924 925 926 927 928 929 930 931
/* 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
932 933 934 935 936 937 938 939 940 941
/* 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;

942 943 944 945
/* Frame being updated by update_window/update_frame.  */

extern struct frame *updating_frame;

Gerd Moellmann's avatar
Gerd Moellmann committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
/* Window being updated by update_window.  This is non-null as long as
   update_window has not finished, and null otherwise.  It's role is
   analogous to updating_frame.  */

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;

/* Non-zero means redisplay has been performed directly (see also
   direct_output_for_insert and direct_output_forward_char), so that
   no further updating has to be performed.  The function
   redisplay_internal checks this flag, and does nothing but reset it
   to zero if it is non-zero.  */

extern int redisplay_performed_directly_p;

/* A temporary storage area, including a row of glyphs.  Initialized
   in xdisp.c.  Used for various purposes, as an example see
   direct_output_for_insert.  */

extern struct glyph_row scratch_glyph_row;


983 984 985 986 987 988

/************************************************************************
			  Glyph Strings
 ************************************************************************/

/* Enumeration for overriding/changing the face to use for drawing
989
   glyphs in draw_glyphs.  */
990 991 992 993 994 995 996 997 998 999 1000

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

1001 1002
#ifdef HAVE_WINDOW_SYSTEM

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
/* 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.  */
  XFontStruct *font;

  /* Font info for this string.  */
  struct font_info *font_info;

  /* Non-null means this string describes (part of) a composition.
     All characters from char2b are drawn composed.  */
  struct composition *cmp;

  /* Index of this glyph string's first character in the glyph
     definition of CMP.  If this is zero, this glyph string describes
     the first character of a composition.  */
  int gidx;

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

  /* 1 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.  */
  unsigned for_overlaps_p : 1;

  /* The GC to use for drawing this glyph string.  */
#if defined(HAVE_X_WINDOWS) || defined(HAVE_CARBON)
  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;

  struct glyph_string *next, *prev;
};

1120
#endif /* HAVE_WINDOW_SYSTEM */
1121

Gerd Moellmann's avatar
Gerd Moellmann committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135

/************************************************************************
			  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
1136
/* Return the height of the header line in glyph matrix MATRIX, or zero
Gerd Moellmann's avatar
Gerd Moellmann committed
1137 1138 1139
   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
1140
#define MATRIX_HEADER_LINE_HEIGHT(MATRIX)	\
Gerd Moellmann's avatar
Gerd Moellmann committed
1141
     ((MATRIX) && (MATRIX)->rows		\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1142
      ? MATRIX_HEADER_LINE_ROW (MATRIX)->height	\
Gerd Moellmann's avatar
Gerd Moellmann committed
1143 1144
      : 0)

1145 1146 1147 1148 1149 1150 1151 1152
/* 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
1153
   which is compared against minibuf_selected_window (if MBW matches).  */
1154 1155

#define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW)		\
1156
     ((!mode_line_in_non_selected_windows			\
1157
       || (SELW) == XWINDOW (selected_window)			\
1158
       || (minibuf_level > 0					\
1159
           && !NILP (minibuf_selected_window)			\
1160
           && (MBW) == XWINDOW (minibuf_window)			\
1161
           && (SCRW) == XWINDOW (minibuf_selected_window)))	\
1162 1163 1164 1165 1166
      ? MODE_LINE_FACE_ID					\
      : MODE_LINE_INACTIVE_FACE_ID)


/* Return the desired face id for the mode line of window W.  */
1167 1168

#define CURRENT_MODE_LINE_FACE_ID(W)		\
1169
	(CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1170

Gerd Moellmann's avatar
Gerd Moellmann committed
1171
/* Return the current height of the mode line of window W.  If not
Gerd Moellmann's avatar
Gerd Moellmann committed
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
   known from current_mode_line_height, look at W's current glyph
   matrix, or return a default based on the height of the font of the
   face `mode-line'.  */

#define CURRENT_MODE_LINE_HEIGHT(W)				\
     (current_mode_line_height >= 0				\
      ? current_mode_line_height				\
      : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix)		\
	 ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix)	\
	 : estimate_mode_line_height (XFRAME ((W)->frame),	\
1182
				      CURRENT_MODE_LINE_FACE_ID (W))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1183

Pavel Janík's avatar
Pavel Janík committed
1184
/* Return the current height of the header line of window W.  If not
Gerd Moellmann's avatar
Gerd Moellmann committed
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
   known from current_header_line_height, look at W's current glyph
   matrix, or return an estimation based on the height of the font of
   the face `header-line'.  */

#define CURRENT_HEADER_LINE_HEIGHT(W)				\
      (current_header_line_height >= 0				\
       ? current_header_line_height				\
       : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix)	\
	  ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix)	\
	  : estimate_mode_line_height (XFRAME ((W)->frame),	\
				       HEADER_LINE_FACE_ID)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1196 1197 1198 1199 1200 1201

/* Return the height of the desired mode line of window W.  */

#define DESIRED_MODE_LINE_HEIGHT(W) \
     MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)

Pavel Janík's avatar
Pavel Janík committed
1202
/* Return the height of the desired header line of window W.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1203

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1204 1205
#define DESIRED_HEADER_LINE_HEIGHT(W) \
     MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
1206

Pavel Janík's avatar
Pavel Janík committed
1207
/* Value is non-zero if window W wants a mode line.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1208 1209

#define WINDOW_WANTS_MODELINE_P(W)					\
1210
     (!MINI_WINDOW_P ((W))						\
Gerd Moellmann's avatar
Gerd Moellmann committed
1211
      && !(W)->pseudo_window_p						\
1212
      && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W))))		\
1213
      && BUFFERP ((W)->buffer)						\
1214
      && !NILP (XBUFFER ((W)->buffer)->mode_line_format)		\
1215
      && WINDOW_TOTAL_LINES (W) > 1)
Gerd Moellmann's avatar
Gerd Moellmann committed
1216

Pavel Janík's avatar
Pavel Janík committed
1217
/* Value is non-zero if window W wants a header line.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1218

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1219
#define WINDOW_WANTS_HEADER_LINE_P(W)					\
1220
     (!MINI_WINDOW_P ((W))						\
Gerd Moellmann's avatar
Gerd Moellmann committed
1221
      && !(W)->pseudo_window_p						\
1222
      && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W))))		\
1223
      && BUFFERP ((W)->buffer)						\
1224
      && !NILP (XBUFFER ((W)->buffer)->header_line_format)		\
1225
      && WINDOW_TOTAL_LINES (W) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
Gerd Moellmann's avatar
Gerd Moellmann committed
1226

1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250

/* Return proper value to be used as baseline offset of font that has
   ASCENT and DESCENT to draw characters by the font at the vertical
   center of the line of frame F.

   Here, our task is to find the value of BOFF in the following figure;

	-------------------------+-----------+-
	 -+-+---------+-+        |           |
	  | |         | |        |           |
	  | |         | |        F_ASCENT    F_HEIGHT
	  | |         | ASCENT   |           |
     HEIGHT |         | |        |           |
	  | |         |-|-+------+-----------|------- baseline
	  | |         | | BOFF   |           |
	  | |---------|-+-+      |           |
	  | |         | DESCENT  |           |
	 -+-+---------+-+        F_DESCENT   |
	-------------------------+-----------+-

	-BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
	BOFF = DESCENT +  (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
	DESCENT = FONT->descent
	HEIGHT = FONT_HEIGHT (FONT)
1251
	F_DESCENT = (FRAME_FONT (F)->descent
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
		     - F->output_data.x->baseline_offset)
	F_HEIGHT = FRAME_LINE_HEIGHT (F)
*/

#define VCENTER_BASELINE_OFFSET(FONT, F)			\
  (FONT_DESCENT (FONT)						\
   + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT))		\
      + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2	\
   - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))

1262

Gerd Moellmann's avatar
Gerd Moellmann committed
1263 1264 1265
/***********************************************************************
				Faces
 ***********************************************************************/
1266

Gerd Moellmann's avatar
Gerd Moellmann committed
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
/* Indices of face attributes in Lisp face vectors.  Slot zero is the
   symbol `face'.  */

enum lface_attribute_index
{
  LFACE_FAMILY_INDEX = 1,
  LFACE_SWIDTH_INDEX,
  LFACE_HEIGHT_INDEX,
  LFACE_WEIGHT_INDEX,
  LFACE_SLANT_INDEX,
  LFACE_UNDERLINE_INDEX,
  LFACE_INVERSE_INDEX,
  LFACE_FOREGROUND_INDEX,
  LFACE_BACKGROUND_INDEX,
  LFACE_STIPPLE_INDEX,
  LFACE_OVERLINE_INDEX,
  LFACE_STRIKE_THROUGH_INDEX,
  LFACE_BOX_INDEX,
1285
  LFACE_FONT_INDEX,
1286
  LFACE_INHERIT_INDEX,
1287
  LFACE_AVGWIDTH_INDEX,
Gerd Moellmann's avatar
Gerd Moellmann committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
  LFACE_VECTOR_SIZE
};


/* Box types of faces.  */

enum face_box_type
{
  /* No box around text.  */
  FACE_NO_BOX,

  /* Simple box of specified width and color.  Default width is 1, and
     default color is the foreground color of the face.  */
  FACE_SIMPLE_BOX,

  /* Boxes with 3D shadows.  Color equals the background color of the
     face.  Width is specified.  */
  FACE_RAISED_BOX,
  FACE_SUNKEN_BOX
};


/* Structure describing a realized face.

   For each Lisp face, 0..N realized faces can exist for different
   frames and different charsets.  Realized faces are built from Lisp
   faces and text properties/overlays by merging faces and adding
   unspecified attributes from the `default' face.  */

1317
struct face
Gerd Moellmann's avatar
Gerd Moellmann committed
1318 1319 1320 1321 1322 1323
{
  /* The id of this face.  The id equals the index of this face in the
     vector faces_by_id of its face cache.  */
  int id;

#ifdef HAVE_WINDOW_SYSTEM
1324

Eli Zaretskii's avatar
Eli Zaretskii committed
1325 1326
  /* If non-zero, this is a GC that we can use without modification for
     drawing the characters in this face.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1327
  GC gc;
1328

Gerd Moellmann's avatar
Gerd Moellmann committed
1329 1330 1331 1332 1333 1334
  /* Font used for this face, or null if the font could not be loaded
     for some reason.  This points to a `font' slot of a struct
     font_info, and we should not call XFreeFont on it because the
     font may still be used somewhere else.  */
  XFontStruct *font;

1335 1336 1337
  /* Background stipple or bitmap used for this face.  This is
     an id as returned from load_pixmap.  */
  int stipple;
Gerd Moellmann's avatar
Gerd Moellmann committed
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348

#else /* not HAVE_WINDOW_SYSTEM */

  /* Dummy.  */
  int stipple;

#endif /* not HAVE_WINDOW_SYSTEM */

  /* Pixel value of foreground color for X frames.  Color index
     for tty frames.  */
  unsigned long foreground;
1349

Gerd Moellmann's avatar
Gerd Moellmann committed
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
  /* Pixel value or color index of background color.  */
  unsigned long background;

  /* Pixel value or color index of underline color.  */
  unsigned long underline_color;

  /* Pixel value or color index of overlined, strike-through, or box
     color.  */
  unsigned long overline_color;
  unsigned long strike_through_color;
  unsigned long box_color;

  /* The font's name.  This points to a `name' of a font_info, and it
     must not be freed.  */
  char *font_name;

  /* Font info ID for this face's font.  An ID is stored here because
     pointers to font_info structures may change.  The reason is that
     they are pointers into a font table vector that is itself
     reallocated.  */
  int font_info_id;

  /* Fontset ID if this face uses a fontset, or -1.  This is only >= 0
1373 1374
     if the face was realized for a composition sequence.
     Otherwise, a specific font is loaded from the set of fonts
Gerd Moellmann's avatar
Gerd Moellmann committed
1375 1376
     specified by the fontset given by the family attribute of the face.  */
  int fontset;
1377

Gerd Moellmann's avatar
Gerd Moellmann committed
1378 1379
  /* Pixmap width and height.  */
  unsigned int pixmap_w, pixmap_h;
1380

Gerd Moellmann's avatar
Gerd Moellmann committed
1381
  /* Non-zero means characters in this face have a box that thickness
1382 1383
     around them.  If it is negative, the absolute value indicates the
     thickness, and the horizontal lines of box (top and bottom) are
Pavel Janík's avatar
Pavel Janík committed
1384
     drawn inside of characters glyph area.  The vertical lines of box
1385 1386
     (left and right) are drawn as the same way as the case that this
     value is positive.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
  int box_line_width;

  /* Type of box drawn.  A value of FACE_NO_BOX means no box is drawn
     around text in this face.  A value of FACE_SIMPLE_BOX means a box
     of width box_line_width is drawn in color box_color.  A value of
     FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
     shadow colors derived from the background color of the face.  */
  enum face_box_type box;

  /* If `box' above specifies a 3D type, 1 means use box_color for
     drawing shadows.  */
  unsigned use_box_color_for_shadows_p : 1;

  /* The Lisp face attributes this face realizes.  All attributes
     in this vector are non-nil.  */
  Lisp_Object lface[LFACE_VECTOR_SIZE];

  /* The hash value of this face.  */
  unsigned hash;

  /* The charset for which this face was realized if it was realized
1408 1409 1410 1411
     for use in multibyte text.  If fontset >= 0, this is the charset
     of the first character of the composition sequence.  A value of
     charset < 0 means the face was realized for use in unibyte text
     where the idea of Emacs charsets isn't applicable.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
  int charset;

  /* Non-zero if text in this face should be underlined, overlined,
     strike-through or have a box drawn around it.  */
  unsigned underline_p : 1;
  unsigned overline_p : 1;
  unsigned strike_through_p : 1;

  /* 1 means that the colors specified for this face could not be
     loaded, and were replaced by default colors, so they shouldn't be
     freed.  */
  unsigned foreground_defaulted_p : 1;
  unsigned background_defaulted_p : 1;

  /* 1 means that either no color is specified for underlining or that
Gerd Moellmann's avatar
Gerd Moellmann committed
1427
     the specified color couldn't be loaded.  Use the foreground
Gerd Moellmann's avatar
Gerd Moellmann committed
1428
     color when drawing in that case. */
1429
  unsigned underline_defaulted_p : 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
1430 1431

  /* 1 means that either no color is specified for the corresponding
Pavel Janík's avatar
Pavel Janík committed
1432
     attribute or that the specified color couldn't be loaded.
Gerd Moellmann's avatar
Gerd Moellmann committed
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
     Use the foreground color when drawing in that case. */
  unsigned overline_color_defaulted_p : 1;
  unsigned strike_through_color_defaulted_p : 1;
  unsigned box_color_defaulted_p : 1;

  /* TTY appearances.  Blinking is not yet implemented.  Colors are
     found in `lface' with empty color string meaning the default
     color of the TTY.  */
  unsigned tty_bold_p : 1;
  unsigned tty_dim_p : 1;
  unsigned tty_underline_p : 1;
  unsigned tty_alt_charset_p : 1;
  unsigned tty_reverse_p : 1;
  unsigned tty_blinking_p : 1;

1448 1449 1450 1451 1452
  /* 1 means that colors of this face may not be freed because they
     have been copied bitwise from a base face (see
     realize_x_face).  */
  unsigned colors_copied_bitwise_p : 1;

1453 1454 1455
  /* If non-zero, use overstrike (to simulate bold-face).  */
  unsigned overstrike : 1;

Gerd Moellmann's avatar
Gerd Moellmann committed
1456 1457
  /* Next and previous face in hash collision list of face cache.  */
  struct face *next, *prev;
1458 1459 1460 1461

  /* If this face is for ASCII characters, this points this face
     itself.  Otherwise, this points a face for ASCII characters.  */
  struct face *ascii_face;
Gerd Moellmann's avatar
Gerd Moellmann committed
1462 1463 1464 1465 1466 1467 1468
};


/* Color index indicating that face uses a terminal's default color.  */

#define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)

1469 1470 1471 1472
/* Color index indicating that face uses an unknown foreground color.  */

#define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)

Pavel Janík's avatar
Pavel Janík committed
1473
/* Color index indicating that face uses an unknown background color.  */
1474 1475 1476

#define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)

Gerd Moellmann's avatar
Gerd Moellmann committed
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
/* Non-zero if FACE was realized for unibyte use.  */

#define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)


/* IDs of important faces known by the C face code.  These are the IDs
   of the faces for CHARSET_ASCII.  */

enum face_id
{
  DEFAULT_FACE_ID,
  MODE_LINE_FACE_ID,
1489
  MODE_LINE_INACTIVE_FACE_ID,