dispextern.h 93.9 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 MAC_OS
62
#include "macgui.h"
63
typedef struct mac_display_info Display_Info;
64
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
65

66

Gerd Moellmann's avatar
Gerd Moellmann committed
67 68 69 70 71 72 73 74 75 76 77 78 79
/* 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;


80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
/* 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
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

/***********************************************************************
			      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
112
#define xassert(X)	do {if (!(X)) abort ();} while (0)
Gerd Moellmann's avatar
Gerd Moellmann committed
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
#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 */

139

Gerd Moellmann's avatar
Gerd Moellmann committed
140 141 142 143 144 145 146 147

/***********************************************************************
			    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.  */
148

Gerd Moellmann's avatar
Gerd Moellmann committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
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.  */

170
#define INC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
171 172 173
     do						\
       {					\
	 ++(POS).charpos;			\
174 175 176 177
         if (MULTIBYTE_P)			\
	   INC_POS ((POS).bytepos);		\
	 else					\
	   ++(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
178 179 180 181 182
       }					\
     while (0)

/* Decrement text position POS.  */

183
#define DEC_TEXT_POS(POS, MULTIBYTE_P)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
184 185 186
     do						\
       {					\
	 --(POS).charpos;			\
187 188 189 190
         if (MULTIBYTE_P)			\
	   DEC_POS ((POS).bytepos);		\
	 else					\
	   --(POS).bytepos;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
191 192 193 194 195 196 197 198 199 200 201 202 203
       }					\
     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)))
204

Gerd Moellmann's avatar
Gerd Moellmann committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
/* 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.  */
251
  CHAR_GLYPH,
Gerd Moellmann's avatar
Gerd Moellmann committed
252

253 254 255
  /* Glyph describes a composition sequence.  */
  COMPOSITE_GLYPH,

Gerd Moellmann's avatar
Gerd Moellmann committed
256 257 258 259 260 261 262 263
  /* 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
264 265 266
/* Glyphs.

   Be extra careful when changing this structure!  Esp. make sure that
267
   functions producing glyphs, like append_glyph, fill ALL of the
Gerd Moellmann's avatar
Gerd Moellmann committed
268 269 270
   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
271 272 273 274 275 276 277 278 279 280 281

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
282
     a string, if the glyph was produced from characters which came from
Gerd Moellmann's avatar
Gerd Moellmann committed
283 284
     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
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  Lisp_Object object;

  /* Width in pixels.  */
  short pixel_width;

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

309 310 311 312 313
  /* 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;

314 315 316 317 318 319 320 321 322
  /* 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
323 324 325
  /* 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.  */
326 327
  unsigned glyph_not_available_p : 1;

328
  /* Face of the glyph.  */
329
  unsigned face_id : 21;
330

331
  /* Type of font used to display the character glyph.  May be used to
332
     determine which set of functions to use to obtain font metrics
333 334 335
     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;
336

Gerd Moellmann's avatar
Gerd Moellmann committed
337 338 339
  /* A union of sub-structures for different glyph types.  */
  union
  {
340 341
    /* Character code for character glyphs (type == CHAR_GLYPH).  */
    unsigned ch;
Gerd Moellmann's avatar
Gerd Moellmann committed
342

343 344
    /* Composition ID for composition glyphs (type == COMPOSITION_GLYPH)  */
    unsigned cmp_id;
345

346 347
    /* Image ID for image glyphs (type == IMAGE_GLYPH).  */
    unsigned img_id;
Gerd Moellmann's avatar
Gerd Moellmann committed
348 349 350 351 352

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

      /* The ascent of the glyph.  */
356
      unsigned ascent  : 16;
Gerd Moellmann's avatar
Gerd Moellmann committed
357 358
    }
    stretch;
359

Gerd Moellmann's avatar
Gerd Moellmann committed
360 361 362 363 364 365
    /* Used to compare all bit-fields above in one step.  */
    unsigned val;
  } u;
};


366 367 368 369
/* Default value of the glyph font_type field.  */

#define FONT_TYPE_UNKNOWN	0

Gerd Moellmann's avatar
Gerd Moellmann committed
370 371 372 373 374
/* Is GLYPH a space?  */

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
377 378 379
#define GLYPH_EQUAL_P(X, Y)					\
     ((X)->type == (Y)->type					\
      && (X)->u.val == (Y)->u.val				\
380 381
      && (X)->face_id == (Y)->face_id				\
      && (X)->padding_p == (Y)->padding_p			\
Gerd Moellmann's avatar
Gerd Moellmann committed
382 383
      && (X)->left_box_line_p == (Y)->left_box_line_p		\
      && (X)->right_box_line_p == (Y)->right_box_line_p		\
384 385
      && (X)->voffset == (Y)->voffset				\
      && (X)->pixel_width == (Y)->pixel_width)
Gerd Moellmann's avatar
Gerd Moellmann committed
386

387 388 389 390 391 392 393
/* 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
394 395
/* Fill a character glyph GLYPH.  CODE, FACE_ID, PADDING_P correspond
   to the bits defined for the typedef `GLYPH' in lisp.h.  */
396

Gerd Moellmann's avatar
Gerd Moellmann committed
397 398 399
#define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P)	\
     do							\
       {						\
400 401 402
         (GLYPH).u.ch = (CODE);				\
         (GLYPH).face_id = (FACE_ID);			\
         (GLYPH).padding_p = (PADDING_P);		\
Gerd Moellmann's avatar
Gerd Moellmann committed
403 404 405 406 407
       }						\
     while (0)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
409 410 411 412
#define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM)			\
     SET_CHAR_GLYPH ((GLYPH),					\
	 	     FAST_GLYPH_CHAR ((FROM)),			\
		     FAST_GLYPH_FACE ((FROM)),			\
413
		     0)
Gerd Moellmann's avatar
Gerd Moellmann committed
414

415 416
/* 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
417
   multibyte character.  */
418

419 420 421
#define GLYPH_FROM_CHAR_GLYPH(GLYPH)				\
  ((GLYPH).u.ch < 256						\
   ? ((GLYPH).u.ch | ((GLYPH).face_id << CHARACTERBITS))	\
422
   : -1)
Gerd Moellmann's avatar
Gerd Moellmann committed
423 424

/* Is GLYPH a padding glyph?  */
425

426
#define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
Gerd Moellmann's avatar
Gerd Moellmann committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 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



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

518 519 520 521 522 523 524
  /* If this structure describes a window matrix of window W,
     window_left_x is the value of W->left, window_top_y the value of
     W->top, 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_x, window_top_y, window_height, window_width, window_vscroll;
Gerd Moellmann's avatar
Gerd Moellmann committed
525 526 527 528 529 530 531 532 533 534 535 536

  /* 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
537
  unsigned header_line_p : 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
538 539 540 541 542

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

Gerd Moellmann's avatar
Gerd Moellmann committed
544 545
  /* The buffer this matrix displays.  Set in
     mark_window_display_accurate_1.  */
546 547
  struct buffer *buffer;

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


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

Gerd Moellmann's avatar
Gerd Moellmann committed
587 588 589 590 591 592 593
   +--------------------+-------------+---------------------+
   |  left margin area  |  text area  |  right margin area  |
   +--------------------+-------------+---------------------+
   |                    |             |                     |
   glyphs[LEFT_MARGIN_AREA]           glyphs[RIGHT_MARGIN_AREA]
			|                                   |
			glyphs[TEXT_AREA]                   |
594
			                      glyphs[LAST_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
595 596 597 598 599

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

Gerd Moellmann's avatar
Gerd Moellmann committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
   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
617
     kludge is no longer used, I believe. --gerd).
Gerd Moellmann's avatar
Gerd Moellmann committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635

     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
636 637
     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
638 639
  int pixel_width;

640 641
  /* 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
642 643
  int ascent, height;

644 645 646 647 648
  /* 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
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 675 676 677 678 679 680 681 682 683
  /* 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;
684

Gerd Moellmann's avatar
Gerd Moellmann committed
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
  /* 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
709
  /* 1 means this row is as wide as the window it is displayed in, including
Kim F. Storm's avatar
Kim F. Storm committed
710
     scroll bars, fringes, and internal borders.  This also
Gerd Moellmann's avatar
Gerd Moellmann committed
711 712 713
     implies that the row doesn't have marginal areas.  */
  unsigned full_width_p : 1;

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

717 718 719
  /* 1 in a current row means this row is overlapped by another row.  */
  unsigned overlapped_p : 1;

720 721 722 723
  /* 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;
724

725 726
  /* 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
727
     previous row, the rest are put in this row.  */
728 729
  unsigned starts_in_middle_of_char_p : 1;

730 731 732
  /* 1 in a current row means this row overlaps others.  */
  unsigned overlapping_p : 1;

733 734 735
  /* 1 means some glyphs in this row are displayed in mouse-face.  */
  unsigned mouse_face_p : 1;

736 737 738
  /* 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
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
  /* 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

755
/* Return a pointer to the row reserved for the mode line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
756 757 758 759 760
   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
761
/* Return a pointer to the row reserved for the header line in MATRIX.
Gerd Moellmann's avatar
Gerd Moellmann committed
762 763 764
   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
765
#define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
Gerd Moellmann's avatar
Gerd Moellmann committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779

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

Gerd Moellmann's avatar
Gerd Moellmann committed
781 782 783 784 785
#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.  */
786

Gerd Moellmann's avatar
Gerd Moellmann committed
787 788 789
#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
790
/* Return the character/ byte position at which ROW ends.  */
791

Gerd Moellmann's avatar
Gerd Moellmann committed
792 793 794 795
#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.  */
796

Gerd Moellmann's avatar
Gerd Moellmann committed
797 798 799 800 801
#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.  */
802

Gerd Moellmann's avatar
Gerd Moellmann committed
803 804 805 806 807 808 809
#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.  */
810

Gerd Moellmann's avatar
Gerd Moellmann committed
811 812 813
#define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
815 816
#define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
     (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
817

Gerd Moellmann's avatar
Gerd Moellmann committed
818 819 820 821 822
#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.  */
823

Gerd Moellmann's avatar
Gerd Moellmann committed
824 825 826
#define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)

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

Gerd Moellmann's avatar
Gerd Moellmann committed
828 829 830 831
#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.  */
832

Gerd Moellmann's avatar
Gerd Moellmann committed
833 834
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW)		\
     (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW))			\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
835
      && (ROW)->y < WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
Gerd Moellmann's avatar
Gerd Moellmann committed
836 837

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

Gerd Moellmann's avatar
Gerd Moellmann committed
839 840 841 842 843
#define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW)		      \
     (MATRIX_ROW_PARTIALLY_VISIBLE_P ((ROW))				      \
      && (ROW)->y + (ROW)->height > WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE ((W)))

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
850 851 852 853 854 855 856 857 858 859 860 861 862 863
#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			\
864 865
      || (ROW)->end.overlay_string_index >= 0		\
      || (ROW)->ends_in_middle_of_char_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
866 867 868 869 870 871 872

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

Gerd Moellmann's avatar
Gerd Moellmann committed
874 875
#define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW)	\
     ((ROW)->start.dpvec_index >= 0			\
876
      || (ROW)->starts_in_middle_of_char_p		\
Gerd Moellmann's avatar
Gerd Moellmann committed
877 878 879
      || ((ROW)->start.overlay_string_index >= 0	\
	  && (ROW)->start.string_pos.charpos > 0))

880 881 882 883 884 885 886 887 888 889 890
/* 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
891 892 893 894 895 896 897 898 899 900
/* 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;

901 902 903 904
/* Frame being updated by update_window/update_frame.  */

extern struct frame *updating_frame;

Gerd Moellmann's avatar
Gerd Moellmann committed
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
/* 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;


942 943 944 945 946 947

/************************************************************************
			  Glyph Strings
 ************************************************************************/

/* Enumeration for overriding/changing the face to use for drawing
948
   glyphs in draw_glyphs.  */
949 950 951 952 953 954 955 956 957 958 959

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

960 961
#ifdef HAVE_WINDOW_SYSTEM

962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 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
/* 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;
};

1079
#endif /* HAVE_WINDOW_SYSTEM */
1080

Gerd Moellmann's avatar
Gerd Moellmann committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

/************************************************************************
			  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
1095
/* Return the height of the header line in glyph matrix MATRIX, or zero
Gerd Moellmann's avatar
Gerd Moellmann committed
1096 1097 1098
   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
1099
#define MATRIX_HEADER_LINE_HEIGHT(MATRIX)	\
Gerd Moellmann's avatar
Gerd Moellmann committed
1100
     ((MATRIX) && (MATRIX)->rows		\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1101
      ? MATRIX_HEADER_LINE_ROW (MATRIX)->height	\
Gerd Moellmann's avatar
Gerd Moellmann committed
1102 1103
      : 0)

1104 1105 1106 1107 1108 1109 1110 1111
/* 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
1112
   which is compared against minibuf_selected_window (if MBW matches).  */
1113 1114

#define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW)		\
1115
     ((!mode_line_in_non_selected_windows			\
1116
       || (SELW) == XWINDOW (selected_window)			\
1117
       || (minibuf_level > 0					\
1118
           && !NILP (minibuf_selected_window)			\
1119
           && (MBW) == XWINDOW (minibuf_window)			\
1120
           && (SCRW) == XWINDOW (minibuf_selected_window)))	\
1121 1122 1123 1124 1125
      ? MODE_LINE_FACE_ID					\
      : MODE_LINE_INACTIVE_FACE_ID)


/* Return the desired face id for the mode line of window W.  */
1126 1127

#define CURRENT_MODE_LINE_FACE_ID(W)		\
1128
	(CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1129

Gerd Moellmann's avatar
Gerd Moellmann committed
1130
/* Return the current height of the mode line of window W.  If not
Gerd Moellmann's avatar
Gerd Moellmann committed
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
   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),	\
1141
				      CURRENT_MODE_LINE_FACE_ID (W))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1142

Pavel Janík's avatar
Pavel Janík committed
1143
/* Return the current height of the header line of window W.  If not
Gerd Moellmann's avatar
Gerd Moellmann committed
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
   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
1155 1156 1157 1158 1159 1160

/* 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
1161
/* Return the height of the desired header line of window W.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1162

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1163 1164
#define DESIRED_HEADER_LINE_HEIGHT(W) \
     MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
1165 1166 1167 1168 1169 1170 1171 1172 1173 1174

/* Like FRAME_INTERNAL_BORDER_WIDTH but checks whether frame F is a
   window-system frame.  */

#define FRAME_INTERNAL_BORDER_WIDTH_SAFE(F) \
     (FRAME_WINDOW_P (F) ? FRAME_INTERNAL_BORDER_WIDTH (F) : 0)

/* Width of display region of window W.  For terminal frames, this
   equals the width of W since there are no vertical scroll bars.  For
   window system frames, the value has to be corrected by the pixel
Kim F. Storm's avatar
Kim F. Storm committed
1175
   width of vertical scroll bars, and fringes.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1176 1177 1178 1179

#define WINDOW_DISPLAY_PIXEL_WIDTH(W)					\
     (((XFASTINT ((W)->width)						\
        - FRAME_SCROLL_BAR_WIDTH (XFRAME (WINDOW_FRAME ((W))))		\
Kim F. Storm's avatar
Kim F. Storm committed
1180
	- FRAME_FRINGE_COLS (XFRAME (WINDOW_FRAME ((W)))))		\
Gerd Moellmann's avatar
Gerd Moellmann committed
1181 1182 1183
       * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))

/* Height of the display region of W, including a mode line, if any.  */
1184

Gerd Moellmann's avatar
Gerd Moellmann committed
1185 1186 1187 1188 1189 1190
#define WINDOW_DISPLAY_PIXEL_HEIGHT(W)					\
     (XFASTINT ((W)->height)						\
      * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W)))))

/* Height in pixels of the mode line.  May be zero if W doesn't have a
   mode line.  */
1191

Gerd Moellmann's avatar
Gerd Moellmann committed
1192 1193 1194 1195 1196
#define WINDOW_DISPLAY_MODE_LINE_HEIGHT(W)	\
     (WINDOW_WANTS_MODELINE_P ((W))		\
      ? CURRENT_MODE_LINE_HEIGHT (W)		\
      : 0)

Pavel Janík's avatar
Pavel Janík committed
1197
/* Height in pixels of the header line.  Zero if W doesn't have a header
Gerd Moellmann's avatar
Gerd Moellmann committed
1198
   line.  */
1199

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1200 1201 1202
#define WINDOW_DISPLAY_HEADER_LINE_HEIGHT(W)	\
     (WINDOW_WANTS_HEADER_LINE_P ((W))		\
      ? CURRENT_HEADER_LINE_HEIGHT (W)		\
Gerd Moellmann's avatar
Gerd Moellmann committed
1203 1204 1205
      : 0)

/* Pixel height of window W without mode line.  */
1206

Gerd Moellmann's avatar
Gerd Moellmann committed
1207 1208 1209 1210
#define WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE(W)	\
     (WINDOW_DISPLAY_PIXEL_HEIGHT ((W))		\
      - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W)))

Pavel Janík's avatar
Pavel Janík committed
1211
/* Pixel height of window W without mode and header line.  */
1212

Gerd Moellmann's avatar
Gerd Moellmann committed
1213 1214 1215
#define WINDOW_DISPLAY_TEXT_HEIGHT(W)		\
     (WINDOW_DISPLAY_PIXEL_HEIGHT ((W))		\
      - WINDOW_DISPLAY_MODE_LINE_HEIGHT ((W))	\
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1216
      - WINDOW_DISPLAY_HEADER_LINE_HEIGHT ((W)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1217 1218

/* Left edge of W in pixels relative to its frame.  */
1219

Gerd Moellmann's avatar
Gerd Moellmann committed
1220 1221 1222 1223
#define WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X(W)				\
     (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W))))	\
      + (WINDOW_LEFT_MARGIN ((W))					\
         * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W)))))			\
Kim F. Storm's avatar
Kim F. Storm committed
1224
      + FRAME_LEFT_FRINGE_WIDTH (XFRAME (WINDOW_FRAME ((W)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1225 1226

/* Right edge of window W in pixels, relative to its frame.  */
1227

Gerd Moellmann's avatar
Gerd Moellmann committed
1228 1229 1230 1231 1232
#define WINDOW_DISPLAY_RIGHT_EDGE_PIXEL_X(W)		\
     (WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W))		\
      + WINDOW_DISPLAY_PIXEL_WIDTH ((W)))

/* Top edge of W in pixels relative to its frame.  */
1233

Gerd Moellmann's avatar
Gerd Moellmann committed
1234 1235 1236 1237 1238 1239
#define WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y(W)				\
     (FRAME_INTERNAL_BORDER_WIDTH_SAFE (XFRAME (WINDOW_FRAME ((W))))	\
      + (XFASTINT ((W)->top)						\
         * CANON_Y_UNIT (XFRAME (WINDOW_FRAME ((W))))))

/* Bottom edge of window W relative to its frame.  */
1240

Gerd Moellmann's avatar
Gerd Moellmann committed
1241 1242 1243
#define WINDOW_DISPLAY_BOTTOM_EDGE_PIXEL_Y(W)		\
     (WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W))		\
      + WINDOW_DISPLAY_PIXEL_HEIGHT ((W)))
1244

Gerd Moellmann's avatar
Gerd Moellmann committed
1245
/* Convert window W relative pixel X to frame pixel coordinates.  */
1246

Gerd Moellmann's avatar
Gerd Moellmann committed
1247 1248 1249 1250
#define WINDOW_TO_FRAME_PIXEL_X(W, X) \
     ((X) + WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))

/* Convert window W relative pixel Y to frame pixel coordinates.  */
1251

Gerd Moellmann's avatar
Gerd Moellmann committed
1252 1253 1254 1255
#define WINDOW_TO_FRAME_PIXEL_Y(W, Y) \
     ((Y) + WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))

/* Convert frame relative pixel X to window relative pixel X.  */
1256

Gerd Moellmann's avatar
Gerd Moellmann committed
1257 1258 1259
#define FRAME_TO_WINDOW_PIXEL_X(W, X) \
     ((X) - WINDOW_DISPLAY_LEFT_EDGE_PIXEL_X ((W)))

Pavel Janík's avatar
Pavel Janík committed
1260
/* Convert frame relative pixel Y to window relative pixel Y.  */
1261

Gerd Moellmann's avatar
Gerd Moellmann committed
1262 1263 1264 1265
#define FRAME_TO_WINDOW_PIXEL_Y(W, Y) \
     ((Y) - WINDOW_DISPLAY_TOP_EDGE_PIXEL_Y ((W)))

/* Width of left margin area in pixels.  */
1266

Gerd Moellmann's avatar
Gerd Moellmann committed
1267 1268 1269 1270 1271
#define WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH(W)		\
     (NILP ((W)->left_margin_width)			\
      ? 0						\
      : (XINT ((W)->left_margin_width)			\
	 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))
1272

Gerd Moellmann's avatar
Gerd Moellmann committed
1273
/* Width of right marginal area in pixels.  */
1274

Gerd Moellmann's avatar
Gerd Moellmann committed
1275 1276 1277 1278 1279 1280 1281
#define WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH(W)	\
     (NILP ((W)->right_margin_width)			\
      ? 0						\
      : (XINT ((W)->right_margin_width)			\
	 * CANON_X_UNIT (XFRAME (WINDOW_FRAME ((W))))))

/* Width of text area in pixels.  */
1282

Gerd Moellmann's avatar
Gerd Moellmann committed
1283 1284 1285 1286 1287 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
#define WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH(W)		\
     (WINDOW_DISPLAY_PIXEL_WIDTH ((W))			\
      - WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W))	\
      - WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W)))

/* Convert a text area relative x-position in window W to frame X
   pixel coordinates.  */

#define WINDOW_TEXT_TO_FRAME_PIXEL_X(W, X)		\
     (WINDOW_TO_FRAME_PIXEL_X ((W), (X))		\
      + WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W)))

/* Translate an x-position relative to AREA in window W to frame pixel
   coordinates.  */

#define WINDOW_AREA_TO_FRAME_PIXEL_X(W, AREA, X)	\
     (WINDOW_TO_FRAME_PIXEL_X ((W), (X))		\
      + (((AREA) > LEFT_MARGIN_AREA)			\
	 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W))	\
	 : 0)						\
      + (((AREA) > TEXT_AREA)				\
	 ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W))	\
	 : 0))

/* Return the pixel width of AREA in W.  */

#define WINDOW_AREA_PIXEL_WIDTH(W, AREA)		\
     (((AREA) == TEXT_AREA)				\
      ? WINDOW_DISPLAY_TEXT_AREA_PIXEL_WIDTH ((W))	\
      : (((AREA) == LEFT_MARGIN_AREA)			\
	 ? WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH ((W))	\
	 : WINDOW_DISPLAY_RIGHT_AREA_PIXEL_WIDTH ((W))))
1315

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

#define WINDOW_WANTS_MODELINE_P(W)					\
1319
     (!MINI_WINDOW_P ((W))						\
Gerd Moellmann's avatar
Gerd Moellmann committed
1320
      && !(W)->pseudo_window_p						\
1321
      && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W))))		\
1322
      && BUFFERP ((W)->buffer)						\
1323
      && !NILP (XBUFFER ((W)->buffer)->mode_line_format)		\
1324
      && XFASTINT ((W)->height) > 1)
Gerd Moellmann's avatar
Gerd Moellmann committed
1325

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

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1328
#define WINDOW_WANTS_HEADER_LINE_P(W)					\
1329
     (!MINI_WINDOW_P ((W))						\
Gerd Moellmann's avatar
Gerd Moellmann committed
1330
      && !(W)->pseudo_window_p						\
1331
      && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W))))		\
1332
      && BUFFERP ((W)->buffer)						\
1333
      && !NILP (XBUFFER ((W)->buffer)->header_line_format)		\
1334
      && XFASTINT ((W)->height) > 1 + !NILP (XBUFFER ((W)->buffer)->mode_line_format))
Gerd Moellmann's avatar
Gerd Moellmann committed
1335

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370

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