src/dispextern.h

   1 /* Interface definitions for display code.
   2
   3 Copyright (C) 1985, 1993-1994, 1997-2011  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.  */
  21
  22 #ifndef DISPEXTERN_H_INCLUDED
  23 #define DISPEXTERN_H_INCLUDED
  24
  25 #ifdef HAVE_X_WINDOWS
  26
  27 #include <X11/Xlib.h>
  28 #ifdef USE_X_TOOLKIT
  29 #include <X11/Intrinsic.h>
  30 #endif /* USE_X_TOOLKIT */
  31
  32 #else /* !HAVE_X_WINDOWS */
  33
  34 /* X-related stuff used by non-X gui code. */
  35
  36 typedef struct {
  37   unsigned long pixel;
  38   unsigned short red, green, blue;
  39   char flags;
  40   char pad;
  41 } XColor;
  42
  43 #endif /* HAVE_X_WINDOWS */
  44
  45 #ifdef MSDOS
  46 #include "msdos.h"
  47 #endif
  48
  49 #ifdef HAVE_X_WINDOWS
  50 typedef struct x_display_info Display_Info;
  51 typedef XImage * XImagePtr;
  52 typedef XImagePtr XImagePtr_or_DC;
  53 #define NativeRectangle XRectangle
  54 #endif
  55
  56 #ifdef HAVE_NTGUI
  57 #include "w32gui.h"
  58 typedef struct w32_display_info Display_Info;
  59 typedef XImage *XImagePtr;
  60 typedef HDC XImagePtr_or_DC;
  61 #endif
  62
  63 #ifdef HAVE_NS
  64 #include "nsgui.h"
  65 /* Following typedef needed to accommodate the MSDOS port, believe it or not.  */
  66 typedef struct ns_display_info Display_Info;
  67 typedef Pixmap XImagePtr;
  68 typedef XImagePtr XImagePtr_or_DC;
  69 #endif
  70
  71 #ifndef HAVE_WINDOW_SYSTEM
  72 typedef int Cursor;
  73 #define No_Cursor (0)
  74 #endif
  75
  76 #ifndef NativeRectangle
  77 #define NativeRectangle int
  78 #endif
  79
  80 /* Structure forward declarations.  Some are here because function
  81    prototypes below reference structure types before their definition
  82    in this file.  Some are here because not every file including
  83    dispextern.h also includes frame.h and windows.h.  */
  84
  85 struct glyph;
  86 struct glyph_row;
  87 struct glyph_matrix;
  88 struct glyph_pool;
  89 struct frame;
  90 struct window;
  91
  92
  93 /* Values returned from coordinates_in_window.  */
  94
  95 enum window_part
  96 {
  97   ON_NOTHING,
  98   ON_TEXT,
  99   ON_MODE_LINE,
 100   ON_VERTICAL_BORDER,
 101   ON_HEADER_LINE,
 102   ON_LEFT_FRINGE,
 103   ON_RIGHT_FRINGE,
 104   ON_LEFT_MARGIN,
 105   ON_RIGHT_MARGIN,
 106   ON_SCROLL_BAR
 107 };
 108
 109 /* Number of bits allocated to store fringe bitmap numbers.  */
 110 #define FRINGE_ID_BITS  16
 111
 112 /* Number of bits allocated to store fringe bitmap height.  */
 113 #define FRINGE_HEIGHT_BITS 8
 114
 115 \f
 116 /***********************************************************************
 117                               Debugging
 118  ***********************************************************************/
 119
 120 /* If GLYPH_DEBUG is non-zero, additional checks are activated.  Turn
 121    it off by defining the macro GLYPH_DEBUG to zero.  */
 122
 123 #ifndef GLYPH_DEBUG
 124 #define GLYPH_DEBUG 0
 125 #endif
 126
 127 /* If XASSERTS is non-zero, additional consistency checks are activated.
 128    Turn it off by defining the macro XASSERTS to zero.  */
 129
 130 #ifndef XASSERTS
 131 #define XASSERTS 0
 132 #endif
 133
 134 /* Macros to include code only if GLYPH_DEBUG != 0.  */
 135
 136 #if GLYPH_DEBUG
 137 #define IF_DEBUG(X)     X
 138 #else
 139 #define IF_DEBUG(X)     (void) 0
 140 #endif
 141
 142 #if XASSERTS
 143 #define xassert(X)      do {if (!(X)) abort ();} while (0)
 144 #else
 145 #define xassert(X)      (void) 0
 146 #endif
 147
 148 /* Macro for displaying traces of redisplay.  If Emacs was compiled
 149    with GLYPH_DEBUG != 0, the variable trace_redisplay_p can be set to
 150    a non-zero value in debugging sessions to activate traces.  */
 151
 152 #if GLYPH_DEBUG
 153
 154 extern int trace_redisplay_p;
 155 #include <stdio.h>
 156
 157 #define TRACE(X)                                \
 158      if (trace_redisplay_p)                     \
 159        fprintf X;                               \
 160      else                                       \
 161        (void) 0
 162
 163 #else /* GLYPH_DEBUG == 0 */
 164
 165 #define TRACE(X)        (void) 0
 166
 167 #endif /* GLYPH_DEBUG == 0 */
 168
 169
 170 \f
 171 /***********************************************************************
 172                             Text positions
 173  ***********************************************************************/
 174
 175 /* Starting with Emacs 20.3, characters from strings and buffers have
 176    both a character and a byte position associated with them.  The
 177    following structure holds such a pair of positions.  */
 178
 179 struct text_pos
 180 {
 181   /* Character position.  */
 182   EMACS_INT charpos;
 183
 184   /* Corresponding byte position.  */
 185   EMACS_INT bytepos;
 186 };
 187
 188 /* Access character and byte position of POS in a functional form.  */
 189
 190 #define BYTEPOS(POS)    (POS).bytepos
 191 #define CHARPOS(POS)    (POS).charpos
 192
 193 /* Set character position of POS to CHARPOS, byte position to BYTEPOS.  */
 194
 195 #define SET_TEXT_POS(POS, CHARPOS, BYTEPOS) \
 196      ((POS).charpos = (CHARPOS), (POS).bytepos = BYTEPOS)
 197
 198 /* Increment text position POS.  */
 199
 200 #define INC_TEXT_POS(POS, MULTIBYTE_P)          \
 201      do                                         \
 202        {                                        \
 203          ++(POS).charpos;                       \
 204          if (MULTIBYTE_P)                       \
 205            INC_POS ((POS).bytepos);             \
 206          else                                   \
 207            ++(POS).bytepos;                     \
 208        }                                        \
 209      while (0)
 210
 211 /* Decrement text position POS.  */
 212
 213 #define DEC_TEXT_POS(POS, MULTIBYTE_P)          \
 214      do                                         \
 215        {                                        \
 216          --(POS).charpos;                       \
 217          if (MULTIBYTE_P)                       \
 218            DEC_POS ((POS).bytepos);             \
 219          else                                   \
 220            --(POS).bytepos;                     \
 221        }                                        \
 222      while (0)
 223
 224 /* Set text position POS from marker MARKER.  */
 225
 226 #define SET_TEXT_POS_FROM_MARKER(POS, MARKER)           \
 227      (CHARPOS (POS) = marker_position ((MARKER)),       \
 228       BYTEPOS (POS) = marker_byte_position ((MARKER)))
 229
 230 /* Set marker MARKER from text position POS.  */
 231
 232 #define SET_MARKER_FROM_TEXT_POS(MARKER, POS) \
 233      set_marker_both ((MARKER), Qnil, CHARPOS ((POS)), BYTEPOS ((POS)))
 234
 235 /* Value is non-zero if character and byte positions of POS1 and POS2
 236    are equal.  */
 237
 238 #define TEXT_POS_EQUAL_P(POS1, POS2)            \
 239      ((POS1).charpos == (POS2).charpos          \
 240       && (POS1).bytepos == (POS2).bytepos)
 241
 242 /* When rendering glyphs, redisplay scans string or buffer text,
 243    overlay strings in that text, and does display table or control
 244    character translations.  The following structure captures a
 245    position taking all this into account.  */
 246
 247 struct display_pos
 248 {
 249   /* Buffer or string position.  */
 250   struct text_pos pos;
 251
 252   /* If this is a position in an overlay string, overlay_string_index
 253      is the index of that overlay string in the sequence of overlay
 254      strings at `pos' in the order redisplay processes them.  A value
 255      < 0 means that this is not a position in an overlay string.  */
 256   int overlay_string_index;
 257
 258   /* If this is a position in an overlay string, string_pos is the
 259      position within that string.  */
 260   struct text_pos string_pos;
 261
 262   /* If the character at the position above is a control character or
 263      has a display table entry, dpvec_index is an index in the display
 264      table or control character translation of that character.  A
 265      value < 0 means this is not a position in such a translation.  */
 266   int dpvec_index;
 267 };
 268
 269
 270 \f
 271 /***********************************************************************
 272                                 Glyphs
 273  ***********************************************************************/
 274
 275 /* Enumeration of glyph types.  Glyph structures contain a type field
 276    containing one of the enumerators defined here.  */
 277
 278 enum glyph_type
 279 {
 280   /* Glyph describes a character.  */
 281   CHAR_GLYPH,
 282
 283   /* Glyph describes a static composition.  */
 284   COMPOSITE_GLYPH,
 285
 286   /* Glyph describes a glyphless character.  */
 287   GLYPHLESS_GLYPH,
 288
 289   /* Glyph describes an image.  */
 290   IMAGE_GLYPH,
 291
 292   /* Glyph is a space of fractional width and/or height.  */
 293   STRETCH_GLYPH
 294 };
 295
 296
 297 /* Structure describing how to use partial glyphs (images slicing) */
 298
 299 struct glyph_slice
 300 {
 301   unsigned x : 16;
 302   unsigned y : 16;
 303   unsigned width : 16;
 304   unsigned height : 16;
 305 };
 306
 307
 308 /* Glyphs.
 309
 310    Be extra careful when changing this structure!  Esp. make sure that
 311    functions producing glyphs, like append_glyph, fill ALL of the
 312    glyph structure, and that GLYPH_EQUAL_P compares all
 313    display-relevant members of glyphs (not to imply that these are the
 314    only things to check when you add a member).  */
 315
 316 struct glyph
 317 {
 318   /* Position from which this glyph was drawn.  If `object' below is a
 319      Lisp string, this is a position in that string.  If it is a
 320      buffer, this is a position in that buffer.  A value of -1
 321      together with a null object means glyph is a truncation glyph at
 322      the start of a row.  */
 323   EMACS_INT charpos;
 324
 325   /* Lisp object source of this glyph.  Currently either a buffer or
 326      a string, if the glyph was produced from characters which came from
 327      a buffer or a string; or 0 if the glyph was inserted by redisplay
 328      for its own purposes such as padding.  */
 329   Lisp_Object object;
 330
 331   /* Width in pixels.  */
 332   short pixel_width;
 333
 334   /* Ascent and descent in pixels.  */
 335   short ascent, descent;
 336
 337   /* Vertical offset.  If < 0, the glyph is displayed raised, if > 0
 338      the glyph is displayed lowered.  */
 339   short voffset;
 340
 341   /* Which kind of glyph this is---character, image etc.  Value
 342      should be an enumerator of type enum glyph_type.  */
 343   unsigned type : 3;
 344
 345   /* 1 means this glyph was produced from multibyte text.  Zero
 346      means it was produced from unibyte text, i.e. charsets aren't
 347      applicable, and encoding is not performed.  */
 348   unsigned multibyte_p : 1;
 349
 350   /* Non-zero means draw a box line at the left or right side of this
 351      glyph.  This is part of the implementation of the face attribute
 352      `:box'.  */
 353   unsigned left_box_line_p : 1;
 354   unsigned right_box_line_p : 1;
 355
 356   /* Non-zero means this glyph's physical ascent or descent is greater
 357      than its logical ascent/descent, i.e. it may potentially overlap
 358      glyphs above or below it.  */
 359   unsigned overlaps_vertically_p : 1;
 360
 361   /* For terminal frames, 1 means glyph is a padding glyph.  Padding
 362      glyphs are used for characters whose visual shape consists of
 363      more than one glyph (e.g. Asian characters).  All but the first
 364      glyph of such a glyph sequence have the padding_p flag set.  This
 365      flag is used only to minimize code changes.  A better way would
 366      probably be to use the width field of glyphs to express padding.
 367
 368      For graphic frames, 1 means the pixel width of the glyph in a
 369      font is 0, but 1-pixel is padded on displaying for correct cursor
 370      displaying.  The member `pixel_width' above is set to 1.  */
 371   unsigned padding_p : 1;
 372
 373   /* 1 means the actual glyph is not available, draw using `struct
 374      glyphless' below instead.  This can happen when a font couldn't
 375      be loaded, or a character doesn't have a glyph in a font.  */
 376   unsigned glyph_not_available_p : 1;
 377
 378   /* Non-zero means don't display cursor here.  */
 379   unsigned avoid_cursor_p : 1;
 380
 381   /* Resolved bidirectional level of this character [0..63].  */
 382   unsigned resolved_level : 5;
 383
 384   /* Resolved bidirectional type of this character, see enum
 385      bidi_type_t below.  Note that according to UAX#9, only some
 386      values (STRONG_L, STRONG_R, WEAK_AN, WEAK_EN, WEAK_BN, and
 387      NEUTRAL_B) can appear in the resolved type, so we only reserve
 388      space for those that can.  */
 389   unsigned bidi_type : 3;
 390
 391 #define FACE_ID_BITS    20
 392
 393   /* Face of the glyph.  This is a realized face ID,
 394      an index in the face cache of the frame.  */
 395   unsigned face_id : FACE_ID_BITS;
 396
 397   /* Type of font used to display the character glyph.  May be used to
 398      determine which set of functions to use to obtain font metrics
 399      for the glyph.  On W32, value should be an enumerator of the type
 400      w32_char_font_type.  Otherwise it equals FONT_TYPE_UNKNOWN.  */
 401   unsigned font_type : 3;
 402
 403   /* A union of sub-structures for different glyph types.  */
 404   union
 405   {
 406     /* Metrics of a partial glyph of an image (type == IMAGE_GLYPH).  */
 407     struct glyph_slice img;
 408     /* Start and end indices of glyphs of a graphme cluster of a
 409        composition (type == COMPOSITE_GLYPH).  */
 410     struct { int from, to; } cmp;
 411     /* Pixel offsets for upper and lower part of the acronym.  */
 412     struct {
 413       short upper_xoff, upper_yoff;
 414       short lower_xoff, lower_yoff;
 415     } glyphless;
 416   } slice;
 417
 418   /* A union of sub-structures for different glyph types.  */
 419   union
 420   {
 421     /* Character code for character glyphs (type == CHAR_GLYPH).  */
 422     unsigned ch;
 423
 424     /* Sub-structures for type == COMPOSITE_GLYPH.  */
 425     struct
 426     {
 427       /* Flag to tell if the composition is automatic or not.  */
 428       unsigned automatic : 1;
 429       /* ID of the composition.  */
 430       unsigned id    : 31;
 431     } cmp;
 432
 433     /* Image ID for image glyphs (type == IMAGE_GLYPH).  */
 434     int img_id;
 435
 436     /* Sub-structure for type == STRETCH_GLYPH.  */
 437     struct
 438     {
 439       /* The height of the glyph.  */
 440       unsigned height  : 16;
 441
 442       /* The ascent of the glyph.  */
 443       unsigned ascent  : 16;
 444     }
 445     stretch;
 446
 447     /* Sub-stretch for type == GLYPHLESS_GLYPH.  */
 448     struct
 449     {
 450       /* Value is an enum of the type glyphless_display_method.  */
 451       unsigned method : 2;
 452       /* 1 iff this glyph is for a character of no font. */
 453       unsigned for_no_font : 1;
 454       /* Length of acronym or hexadecimal code string (at most 8).  */
 455       unsigned len : 4;
 456       /* Character to display.  Actually we need only 22 bits.  */
 457       unsigned ch : 26;
 458     } glyphless;
 459
 460     /* Used to compare all bit-fields above in one step.  */
 461     unsigned val;
 462   } u;
 463 };
 464
 465
 466 /* Default value of the glyph font_type field.  */
 467
 468 #define FONT_TYPE_UNKNOWN       0
 469
 470 /* Is GLYPH a space?  */
 471
 472 #define CHAR_GLYPH_SPACE_P(GLYPH) \
 473   ((GLYPH).u.ch == SPACEGLYPH && (GLYPH).face_id == DEFAULT_FACE_ID)
 474
 475 /* Are glyph slices of glyphs *X and *Y equal?  It assumes that both
 476    glyphs have the same type.
 477
 478    Note: for composition glyphs, we don't have to compare slice.cmp.to
 479    because they should be the same if and only if slice.cmp.from are
 480    the same.  */
 481
 482 #define GLYPH_SLICE_EQUAL_P(X, Y)                               \
 483   ((X)->type == IMAGE_GLYPH                                     \
 484    ? ((X)->slice.img.x == (Y)->slice.img.x                      \
 485       && (X)->slice.img.y == (Y)->slice.img.y                   \
 486       && (X)->slice.img.width == (Y)->slice.img.width           \
 487       && (X)->slice.img.height == (Y)->slice.img.height)        \
 488    : ((X)->type != COMPOSITE_GLYPH                              \
 489       || (X)->slice.cmp.from == (Y)->slice.cmp.from))
 490
 491 /* Are glyphs *X and *Y displayed equal?  */
 492
 493 #define GLYPH_EQUAL_P(X, Y)                                     \
 494      ((X)->type == (Y)->type                                    \
 495       && (X)->u.val == (Y)->u.val                               \
 496       && GLYPH_SLICE_EQUAL_P (X, Y)                             \
 497       && (X)->face_id == (Y)->face_id                           \
 498       && (X)->padding_p == (Y)->padding_p                       \
 499       && (X)->left_box_line_p == (Y)->left_box_line_p           \
 500       && (X)->right_box_line_p == (Y)->right_box_line_p         \
 501       && (X)->voffset == (Y)->voffset                           \
 502       && (X)->pixel_width == (Y)->pixel_width)
 503
 504 /* Are character codes, faces, padding_ps of glyphs *X and *Y equal?  */
 505
 506 #define GLYPH_CHAR_AND_FACE_EQUAL_P(X, Y)       \
 507   ((X)->u.ch == (Y)->u.ch                       \
 508    && (X)->face_id == (Y)->face_id              \
 509    && (X)->padding_p == (Y)->padding_p)
 510
 511 /* Fill a character glyph GLYPH.  CODE, FACE_ID, PADDING_P correspond
 512    to the bits defined for the typedef `GLYPH' in lisp.h.  */
 513
 514 #define SET_CHAR_GLYPH(GLYPH, CODE, FACE_ID, PADDING_P) \
 515      do                                                 \
 516        {                                                \
 517          (GLYPH).u.ch = (CODE);                         \
 518          (GLYPH).face_id = (FACE_ID);                   \
 519          (GLYPH).padding_p = (PADDING_P);               \
 520        }                                                \
 521      while (0)
 522
 523 /* Fill a character type glyph GLYPH from a glyph typedef FROM as
 524    defined in lisp.h.  */
 525
 526 #define SET_CHAR_GLYPH_FROM_GLYPH(GLYPH, FROM)                  \
 527      SET_CHAR_GLYPH ((GLYPH),                                   \
 528                      GLYPH_CHAR ((FROM)),                       \
 529                      GLYPH_FACE ((FROM)),                       \
 530                      0)
 531
 532 /* Construct a glyph code from a character glyph GLYPH.  If the
 533    character is multibyte, return -1 as we can't use glyph table for a
 534    multibyte character.  */
 535
 536 #define SET_GLYPH_FROM_CHAR_GLYPH(G, GLYPH)                     \
 537   do                                                            \
 538     {                                                           \
 539       if ((GLYPH).u.ch < 256)                                   \
 540         SET_GLYPH ((G), (GLYPH).u.ch, ((GLYPH).face_id));       \
 541       else                                                      \
 542         SET_GLYPH ((G), -1, 0);                                 \
 543     }                                                           \
 544   while (0)
 545
 546 #define GLYPH_INVALID_P(GLYPH) (GLYPH_CHAR (GLYPH) < 0)
 547
 548 /* Is GLYPH a padding glyph?  */
 549
 550 #define CHAR_GLYPH_PADDING_P(GLYPH) (GLYPH).padding_p
 551
 552
 553
 554 \f
 555 /***********************************************************************
 556                              Glyph Pools
 557  ***********************************************************************/
 558
 559 /* Glyph Pool.
 560
 561    Glyph memory for frame-based redisplay is allocated from the heap
 562    in one vector kept in a glyph pool structure which is stored with
 563    the frame.  The size of the vector is made large enough to cover
 564    all windows on the frame.
 565
 566    Both frame and window glyph matrices reference memory from a glyph
 567    pool in frame-based redisplay.
 568
 569    In window-based redisplay, no glyphs pools exist; windows allocate
 570    and free their glyph memory themselves.  */
 571
 572 struct glyph_pool
 573 {
 574   /* Vector of glyphs allocated from the heap.  */
 575   struct glyph *glyphs;
 576
 577   /* Allocated size of `glyphs'.  */
 578   int nglyphs;
 579
 580   /* Number of rows and columns in a matrix.  */
 581   int nrows, ncolumns;
 582 };
 583
 584
 585 \f
 586 /***********************************************************************
 587                              Glyph Matrix
 588  ***********************************************************************/
 589
 590 /* Glyph Matrix.
 591
 592    Three kinds of glyph matrices exist:
 593
 594    1. Frame glyph matrices.  These are used for terminal frames whose
 595    redisplay needs a view of the whole screen due to limited terminal
 596    capabilities.  Frame matrices are used only in the update phase
 597    of redisplay.  They are built in update_frame and not used after
 598    the update has been performed.
 599
 600    2. Window glyph matrices on frames having frame glyph matrices.
 601    Such matrices are sub-matrices of their corresponding frame matrix,
 602    i.e. frame glyph matrices and window glyph matrices share the same
 603    glyph memory which is allocated in form of a glyph_pool structure.
 604    Glyph rows in such a window matrix are slices of frame matrix rows.
 605
 606    2. Free-standing window glyph matrices managing their own glyph
 607    storage.  This form is used in window-based redisplay which
 608    includes variable width and height fonts etc.
 609
 610    The size of a window's row vector depends on the height of fonts
 611    defined on its frame.  It is chosen so that the vector is large
 612    enough to describe all lines in a window when it is displayed in
 613    the smallest possible character size.  When new fonts are loaded,
 614    or window sizes change, the row vector is adjusted accordingly.  */
 615
 616 struct glyph_matrix
 617 {
 618   /* The pool from which glyph memory is allocated, if any.  This is
 619      null for frame matrices and for window matrices managing their
 620      own storage.  */
 621   struct glyph_pool *pool;
 622
 623   /* Vector of glyph row structures.  The row at nrows - 1 is reserved
 624      for the mode line.  */
 625   struct glyph_row *rows;
 626
 627   /* Number of elements allocated for the vector rows above.  */
 628   int rows_allocated;
 629
 630   /* The number of rows used by the window if all lines were displayed
 631      with the smallest possible character height.  */
 632   int nrows;
 633
 634   /* Origin within the frame matrix if this is a window matrix on a
 635      frame having a frame matrix.  Both values are zero for
 636      window-based redisplay.  */
 637   int matrix_x, matrix_y;
 638
 639   /* Width and height of the matrix in columns and rows.  */
 640   int matrix_w, matrix_h;
 641
 642   /* If this structure describes a window matrix of window W,
 643      window_left_col is the value of W->left_col, window_top_line the
 644      value of W->top_line, window_height and window_width are width and
 645      height of W, as returned by window_box, and window_vscroll is the
 646      value of W->vscroll at the time the matrix was last adjusted.
 647      Only set for window-based redisplay.  */
 648   int window_left_col, window_top_line;
 649   int window_height, window_width;
 650   int window_vscroll;
 651
 652   /* Number of glyphs reserved for left and right marginal areas when
 653      the matrix was last adjusted.  */
 654   int left_margin_glyphs, right_margin_glyphs;
 655
 656   /* Flag indicating that scrolling should not be tried in
 657      update_window.  This flag is set by functions like try_window_id
 658      which do their own scrolling.  */
 659   unsigned no_scrolling_p : 1;
 660
 661   /* Non-zero means window displayed in this matrix has a top mode
 662      line.  */
 663   unsigned header_line_p : 1;
 664
 665 #if GLYPH_DEBUG
 666   /* A string identifying the method used to display the matrix.  */
 667   char method[512];
 668 #endif
 669
 670   /* The buffer this matrix displays.  Set in
 671      mark_window_display_accurate_1.  */
 672   struct buffer *buffer;
 673
 674   /* Values of BEGV and ZV as of last redisplay.  Set in
 675      mark_window_display_accurate_1.  */
 676   int begv, zv;
 677 };
 678
 679
 680 /* Check that glyph pointers stored in glyph rows of MATRIX are okay.
 681    This aborts if any pointer is found twice.  */
 682
 683 #if GLYPH_DEBUG
 684 void check_matrix_pointer_lossage (struct glyph_matrix *);
 685 #define CHECK_MATRIX(MATRIX) check_matrix_pointer_lossage ((MATRIX))
 686 #else
 687 #define CHECK_MATRIX(MATRIX) (void) 0
 688 #endif
 689
 690
 691 \f
 692 /***********************************************************************
 693                              Glyph Rows
 694  ***********************************************************************/
 695
 696 /* Area in window glyph matrix.  If values are added or removed, the
 697    function mark_object in alloc.c has to be changed.  */
 698
 699 enum glyph_row_area
 700 {
 701   LEFT_MARGIN_AREA,
 702   TEXT_AREA,
 703   RIGHT_MARGIN_AREA,
 704   LAST_AREA
 705 };
 706
 707
 708 /* Rows of glyphs in a windows or frame glyph matrix.
 709
 710    Each row is partitioned into three areas.  The start and end of
 711    each area is recorded in a pointer as shown below.
 712
 713    +--------------------+-------------+---------------------+
 714    |  left margin area  |  text area  |  right margin area  |
 715    +--------------------+-------------+---------------------+
 716    |                    |             |                     |
 717    glyphs[LEFT_MARGIN_AREA]           glyphs[RIGHT_MARGIN_AREA]
 718                         |                                   |
 719                         glyphs[TEXT_AREA]                   |
 720                                               glyphs[LAST_AREA]
 721
 722    Rows in frame matrices reference glyph memory allocated in a frame
 723    glyph pool (see the description of struct glyph_pool).  Rows in
 724    window matrices on frames having frame matrices reference slices of
 725    the glyphs of corresponding rows in the frame matrix.
 726
 727    Rows in window matrices on frames having no frame matrices point to
 728    glyphs allocated from the heap via xmalloc;
 729    glyphs[LEFT_MARGIN_AREA] is the start address of the allocated
 730    glyph structure array.  */
 731
 732 struct glyph_row
 733 {
 734   /* Pointers to beginnings of areas.  The end of an area A is found at
 735      A + 1 in the vector.  The last element of the vector is the end
 736      of the whole row.
 737
 738      Kludge alert: Even if used[TEXT_AREA] == 0, glyphs[TEXT_AREA][0]'s
 739      position field is used.  It is -1 if this row does not correspond
 740      to any text; it is some buffer position if the row corresponds to
 741      an empty display line that displays a line end.  This is what old
 742      redisplay used to do.  (Except in code for terminal frames, this
 743      kludge is no longer used, I believe. --gerd).
 744
 745      See also start, end, displays_text_p and ends_at_zv_p for cleaner
 746      ways to do it.  The special meaning of positions 0 and -1 will be
 747      removed some day, so don't use it in new code.  */
 748   struct glyph *glyphs[1 + LAST_AREA];
 749
 750   /* Number of glyphs actually filled in areas.  */
 751   short used[LAST_AREA];
 752
 753   /* Window-relative x and y-position of the top-left corner of this
 754      row.  If y < 0, this means that eabs (y) pixels of the row are
 755      invisible because it is partially visible at the top of a window.
 756      If x < 0, this means that eabs (x) pixels of the first glyph of
 757      the text area of the row are invisible because the glyph is
 758      partially visible.  */
 759   int x, y;
 760
 761   /* Width of the row in pixels without taking face extension at the
 762      end of the row into account, and without counting truncation
 763      and continuation glyphs at the end of a row on ttys.  */
 764   int pixel_width;
 765
 766   /* Logical ascent/height of this line.  The value of ascent is zero
 767      and height is 1 on terminal frames.  */
 768   int ascent, height;
 769
 770   /* Physical ascent/height of this line.  If max_ascent > ascent,
 771      this line overlaps the line above it on the display.  Otherwise,
 772      if max_height > height, this line overlaps the line beneath it.  */
 773   int phys_ascent, phys_height;
 774
 775   /* Portion of row that is visible.  Partially visible rows may be
 776      found at the top and bottom of a window.  This is 1 for tty
 777      frames.  It may be < 0 in case of completely invisible rows.  */
 778   int visible_height;
 779
 780   /* Extra line spacing added after this row.  Do not consider this
 781      in last row when checking if row is fully visible.  */
 782   int extra_line_spacing;
 783
 784   /* Hash code.  This hash code is available as soon as the row
 785      is constructed, i.e. after a call to display_line.  */
 786   unsigned hash;
 787
 788   /* First position in this row.  This is the text position, including
 789      overlay position information etc, where the display of this row
 790      started, and can thus be less than the position of the first
 791      glyph (e.g. due to invisible text or horizontal scrolling).
 792      BIDI Note: In R2L rows, that have its reversed_p flag set, this
 793      position is at or beyond the right edge of the row.  */
 794   struct display_pos start;
 795
 796   /* Text position at the end of this row.  This is the position after
 797      the last glyph on this row.  It can be greater than the last
 798      glyph position + 1, due to a newline that ends the line,
 799      truncation, invisible text etc.  In an up-to-date display, this
 800      should always be equal to the start position of the next row.
 801      BIDI Note: In R2L rows, this position is at or beyond the left
 802      edge of the row.  */
 803   struct display_pos end;
 804
 805   /* The smallest and the largest buffer positions that contributed to
 806      glyphs in this row.  Note that due to bidi reordering, these are
 807      in general different from the text positions stored in `start'
 808      and `end' members above, and also different from the buffer
 809      positions recorded in the glyphs displayed the leftmost and
 810      rightmost on the screen.  */
 811   struct text_pos minpos, maxpos;
 812
 813   /* Non-zero means the overlay arrow bitmap is on this line.
 814      -1 means use default overlay arrow bitmap, else
 815      it specifies actual fringe bitmap number.  */
 816   int overlay_arrow_bitmap;
 817
 818   /* Left fringe bitmap number (enum fringe_bitmap_type).  */
 819   unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
 820
 821   /* Right fringe bitmap number (enum fringe_bitmap_type).  */
 822   unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
 823
 824   /* Left fringe bitmap number (enum fringe_bitmap_type).  */
 825   unsigned left_fringe_bitmap : FRINGE_ID_BITS;
 826
 827   /* Right fringe bitmap number (enum fringe_bitmap_type).  */
 828   unsigned right_fringe_bitmap : FRINGE_ID_BITS;
 829
 830   /* Face of the left fringe glyph.  */
 831   unsigned left_user_fringe_face_id : FACE_ID_BITS;
 832
 833   /* Face of the right fringe glyph.  */
 834   unsigned right_user_fringe_face_id : FACE_ID_BITS;
 835
 836   /* Face of the left fringe glyph.  */
 837   unsigned left_fringe_face_id : FACE_ID_BITS;
 838
 839   /* Face of the right fringe glyph.  */
 840   unsigned right_fringe_face_id : FACE_ID_BITS;
 841
 842   /* Vertical offset of the left fringe bitmap.  */
 843   signed left_fringe_offset : FRINGE_HEIGHT_BITS;
 844
 845   /* Vertical offset of the right fringe bitmap.  */
 846   signed right_fringe_offset : FRINGE_HEIGHT_BITS;
 847
 848   /* 1 means that we must draw the bitmaps of this row.  */
 849   unsigned redraw_fringe_bitmaps_p : 1;
 850
 851   /* In a desired matrix, 1 means that this row must be updated.  In a
 852      current matrix, 0 means that the row has been invalidated, i.e.
 853      the row's contents do not agree with what is visible on the
 854      screen.  */
 855   unsigned enabled_p : 1;
 856
 857   /* 1 means row displays a text line that is truncated on the left or
 858      right side.  */
 859   unsigned truncated_on_left_p : 1;
 860   unsigned truncated_on_right_p : 1;
 861
 862   /* 1 means that this row displays a continued line, i.e. it has a
 863      continuation mark at the right side.  */
 864   unsigned continued_p : 1;
 865
 866   /* 0 means that this row does not contain any text, i.e. it is
 867      a blank line at the window and buffer end.  */
 868   unsigned displays_text_p : 1;
 869
 870   /* 1 means that this line ends at ZV.  */
 871   unsigned ends_at_zv_p : 1;
 872
 873   /* 1 means the face of the last glyph in the text area is drawn to
 874      the right end of the window.  This flag is used in
 875      update_text_area to optimize clearing to the end of the area.  */
 876   unsigned fill_line_p : 1;
 877
 878   /* Non-zero means display a bitmap on X frames indicating that this
 879      line contains no text and ends in ZV.  */
 880   unsigned indicate_empty_line_p : 1;
 881
 882   /* 1 means this row contains glyphs that overlap each other because
 883      of lbearing or rbearing.  */
 884   unsigned contains_overlapping_glyphs_p : 1;
 885
 886   /* 1 means this row is as wide as the window it is displayed in, including
 887      scroll bars, fringes, and internal borders.  This also
 888      implies that the row doesn't have marginal areas.  */
 889   unsigned full_width_p : 1;
 890
 891   /* Non-zero means row is a mode or header-line.  */
 892   unsigned mode_line_p : 1;
 893
 894   /* 1 in a current row means this row is overlapped by another row.  */
 895   unsigned overlapped_p : 1;
 896
 897   /* 1 means this line ends in the middle of a character consisting
 898      of more than one glyph.  Some glyphs have been put in this row,
 899      the rest are put in rows below this one.  */
 900   unsigned ends_in_middle_of_char_p : 1;
 901
 902   /* 1 means this line starts in the middle of a character consisting
 903      of more than one glyph.  Some glyphs have been put in the
 904      previous row, the rest are put in this row.  */
 905   unsigned starts_in_middle_of_char_p : 1;
 906
 907   /* 1 in a current row means this row overlaps others.  */
 908   unsigned overlapping_p : 1;
 909
 910   /* 1 means some glyphs in this row are displayed in mouse-face.  */
 911   unsigned mouse_face_p : 1;
 912
 913   /* 1 means this row was ended by a newline from a string.  */
 914   unsigned ends_in_newline_from_string_p : 1;
 915
 916   /* 1 means this row width is exactly the width of the window, and the
 917      final newline character is hidden in the right fringe.  */
 918   unsigned exact_window_width_line_p : 1;
 919
 920   /* 1 means this row currently shows the cursor in the right fringe.  */
 921   unsigned cursor_in_fringe_p : 1;
 922
 923   /* 1 means the last glyph in the row is part of an ellipsis.  */
 924   unsigned ends_in_ellipsis_p : 1;
 925
 926   /* Non-zero means display a bitmap on X frames indicating that this
 927      the first line of the buffer.  */
 928   unsigned indicate_bob_p : 1;
 929
 930   /* Non-zero means display a bitmap on X frames indicating that this
 931      the top line of the window, but not start of the buffer.  */
 932   unsigned indicate_top_line_p : 1;
 933
 934   /* Non-zero means display a bitmap on X frames indicating that this
 935      the last line of the buffer.  */
 936   unsigned indicate_eob_p : 1;
 937
 938   /* Non-zero means display a bitmap on X frames indicating that this
 939      the bottom line of the window, but not end of the buffer.  */
 940   unsigned indicate_bottom_line_p : 1;
 941
 942   /* Non-zero means the row was reversed to display text in a
 943      right-to-left paragraph.  */
 944   unsigned reversed_p : 1;
 945
 946   /* Continuation lines width at the start of the row.  */
 947   int continuation_lines_width;
 948
 949 #ifdef HAVE_WINDOW_SYSTEM
 950   /* Non-NULL means the current clipping area.  This is temporarily
 951      set while exposing a region.  Coordinates are frame-relative.  */
 952   XRectangle *clip;
 953 #endif
 954 };
 955
 956
 957 /* Get a pointer to row number ROW in matrix MATRIX.  If GLYPH_DEBUG
 958    is defined to a non-zero value, the function matrix_row checks that
 959    we don't try to access rows that are out of bounds.  */
 960
 961 #if GLYPH_DEBUG
 962 struct glyph_row *matrix_row (struct glyph_matrix *, int);
 963 #define MATRIX_ROW(MATRIX, ROW)   matrix_row ((MATRIX), (ROW))
 964 #else
 965 #define MATRIX_ROW(MATRIX, ROW)   ((MATRIX)->rows + (ROW))
 966 #endif
 967
 968 /* Return a pointer to the row reserved for the mode line in MATRIX.
 969    Row MATRIX->nrows - 1 is always reserved for the mode line.  */
 970
 971 #define MATRIX_MODE_LINE_ROW(MATRIX) \
 972      ((MATRIX)->rows + (MATRIX)->nrows - 1)
 973
 974 /* Return a pointer to the row reserved for the header line in MATRIX.
 975    This is always the first row in MATRIX because that's the only
 976    way that works in frame-based redisplay.  */
 977
 978 #define MATRIX_HEADER_LINE_ROW(MATRIX) (MATRIX)->rows
 979
 980 /* Return a pointer to first row in MATRIX used for text display.  */
 981
 982 #define MATRIX_FIRST_TEXT_ROW(MATRIX) \
 983      ((MATRIX)->rows->mode_line_p ? (MATRIX)->rows + 1 : (MATRIX)->rows)
 984
 985 /* Return a pointer to the first glyph in the text area of a row.
 986    MATRIX is the glyph matrix accessed, and ROW is the row index in
 987    MATRIX.  */
 988
 989 #define MATRIX_ROW_GLYPH_START(MATRIX, ROW) \
 990      (MATRIX_ROW ((MATRIX), (ROW))->glyphs[TEXT_AREA])
 991
 992 /* Return the number of used glyphs in the text area of a row.  */
 993
 994 #define MATRIX_ROW_USED(MATRIX, ROW) \
 995      (MATRIX_ROW ((MATRIX), (ROW))->used[TEXT_AREA])
 996
 997 /* Return the character/ byte position at which the display of ROW
 998    starts.  BIDI Note: this is the smallest character/byte position
 999    among characters in ROW, i.e. the first logical-order character
1000    displayed by ROW, which is not necessarily the smallest horizontal
1001    position.  */
1002
1003 #define MATRIX_ROW_START_CHARPOS(ROW) ((ROW)->minpos.charpos)
1004 #define MATRIX_ROW_START_BYTEPOS(ROW) ((ROW)->minpos.bytepos)
1005
1006 /* Return the character/ byte position at which ROW ends.  BIDI Note:
1007    this is the largest character/byte position among characters in
1008    ROW, i.e. the last logical-order character displayed by ROW, which
1009    is not necessarily the largest horizontal position.  */
1010
1011 #define MATRIX_ROW_END_CHARPOS(ROW) ((ROW)->maxpos.charpos)
1012 #define MATRIX_ROW_END_BYTEPOS(ROW) ((ROW)->maxpos.bytepos)
1013
1014 /* Return the vertical position of ROW in MATRIX.  */
1015
1016 #define MATRIX_ROW_VPOS(ROW, MATRIX) ((ROW) - (MATRIX)->rows)
1017
1018 /* Return the last glyph row + 1 in MATRIX on window W reserved for
1019    text.  If W has a mode line, the last row in the matrix is reserved
1020    for it.  */
1021
1022 #define MATRIX_BOTTOM_TEXT_ROW(MATRIX, W)               \
1023      ((MATRIX)->rows                                    \
1024       + (MATRIX)->nrows                                 \
1025       - (WINDOW_WANTS_MODELINE_P ((W)) ? 1 : 0))
1026
1027 /* Non-zero if the face of the last glyph in ROW's text area has
1028    to be drawn to the end of the text area.  */
1029
1030 #define MATRIX_ROW_EXTENDS_FACE_P(ROW) ((ROW)->fill_line_p)
1031
1032 /* Set and query the enabled_p flag of glyph row ROW in MATRIX.  */
1033
1034 #define SET_MATRIX_ROW_ENABLED_P(MATRIX, ROW, VALUE) \
1035      (MATRIX_ROW ((MATRIX), (ROW))->enabled_p = (VALUE) != 0)
1036
1037 #define MATRIX_ROW_ENABLED_P(MATRIX, ROW) \
1038      (MATRIX_ROW ((MATRIX), (ROW))->enabled_p)
1039
1040 /* Non-zero if ROW displays text.  Value is non-zero if the row is
1041    blank but displays a line end.  */
1042
1043 #define MATRIX_ROW_DISPLAYS_TEXT_P(ROW) ((ROW)->displays_text_p)
1044
1045
1046 /* Helper macros */
1047
1048 #define MR_PARTIALLY_VISIBLE(ROW)       \
1049   ((ROW)->height != (ROW)->visible_height)
1050
1051 #define MR_PARTIALLY_VISIBLE_AT_TOP(W, ROW)  \
1052   ((ROW)->y < WINDOW_HEADER_LINE_HEIGHT ((W)))
1053
1054 #define MR_PARTIALLY_VISIBLE_AT_BOTTOM(W, ROW)  \
1055   (((ROW)->y + (ROW)->height - (ROW)->extra_line_spacing) \
1056    > WINDOW_BOX_HEIGHT_NO_MODE_LINE ((W)))
1057
1058 /* Non-zero if ROW is not completely visible in window W.  */
1059
1060 #define MATRIX_ROW_PARTIALLY_VISIBLE_P(W, ROW)          \
1061   (MR_PARTIALLY_VISIBLE ((ROW))                         \
1062    && (MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW))         \
1063        || MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW))))
1064
1065
1066
1067 /* Non-zero if ROW is partially visible at the top of window W.  */
1068
1069 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P(W, ROW)           \
1070   (MR_PARTIALLY_VISIBLE ((ROW))                                 \
1071    && MR_PARTIALLY_VISIBLE_AT_TOP ((W), (ROW)))
1072
1073 /* Non-zero if ROW is partially visible at the bottom of window W.  */
1074
1075 #define MATRIX_ROW_PARTIALLY_VISIBLE_AT_BOTTOM_P(W, ROW)        \
1076   (MR_PARTIALLY_VISIBLE ((ROW))                                 \
1077    && MR_PARTIALLY_VISIBLE_AT_BOTTOM ((W), (ROW)))
1078
1079 /* Return the bottom Y + 1 of ROW.   */
1080
1081 #define MATRIX_ROW_BOTTOM_Y(ROW) ((ROW)->y + (ROW)->height)
1082
1083 /* Is ROW the last visible one in the display described by the
1084    iterator structure pointed to by IT?.  */
1085
1086 #define MATRIX_ROW_LAST_VISIBLE_P(ROW, IT) \
1087      (MATRIX_ROW_BOTTOM_Y ((ROW)) >= (IT)->last_visible_y)
1088
1089 /* Non-zero if ROW displays a continuation line.  */
1090
1091 #define MATRIX_ROW_CONTINUATION_LINE_P(ROW) \
1092      ((ROW)->continuation_lines_width > 0)
1093
1094 /* Non-zero if ROW ends in the middle of a character.  This is the
1095    case for continued lines showing only part of a display table entry
1096    or a control char, or an overlay string.  */
1097
1098 #define MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P(ROW)        \
1099      ((ROW)->end.dpvec_index > 0                        \
1100       || (ROW)->end.overlay_string_index >= 0           \
1101       || (ROW)->ends_in_middle_of_char_p)
1102
1103 /* Non-zero if ROW ends in the middle of an overlay string.  */
1104
1105 #define MATRIX_ROW_ENDS_IN_OVERLAY_STRING_P(ROW) \
1106      ((ROW)->end.overlay_string_index >= 0)
1107
1108 /* Non-zero if ROW starts in the middle of a character.  See above.  */
1109
1110 #define MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P(ROW)      \
1111      ((ROW)->start.dpvec_index > 0                      \
1112       || (ROW)->starts_in_middle_of_char_p              \
1113       || ((ROW)->start.overlay_string_index >= 0        \
1114           && (ROW)->start.string_pos.charpos > 0))
1115
1116 /* Non-zero means ROW overlaps its predecessor.  */
1117
1118 #define MATRIX_ROW_OVERLAPS_PRED_P(ROW) \
1119      ((ROW)->phys_ascent > (ROW)->ascent)
1120
1121 /* Non-zero means ROW overlaps its successor.  */
1122
1123 #define MATRIX_ROW_OVERLAPS_SUCC_P(ROW)         \
1124       ((ROW)->phys_height - (ROW)->phys_ascent  \
1125        > (ROW)->height - (ROW)->ascent)
1126
1127 /* Non-zero means that fonts have been loaded since the last glyph
1128    matrix adjustments.  The function redisplay_internal adjusts glyph
1129    matrices when this flag is non-zero.  */
1130
1131 extern int fonts_changed_p;
1132
1133 /* A glyph for a space.  */
1134
1135 extern struct glyph space_glyph;
1136
1137 /* Window being updated by update_window.  This is non-null as long as
1138    update_window has not finished, and null otherwise.  */
1139
1140 extern struct window *updated_window;
1141
1142 /* Glyph row and area updated by update_window_line.  */
1143
1144 extern struct glyph_row *updated_row;
1145 extern int updated_area;
1146
1147 /* Non-zero means last display completed.  Zero means it was
1148    preempted.  */
1149
1150 extern int display_completed;
1151
1152
1153 \f
1154 /************************************************************************
1155                           Glyph Strings
1156  ************************************************************************/
1157
1158 /* Enumeration for overriding/changing the face to use for drawing
1159    glyphs in draw_glyphs.  */
1160
1161 enum draw_glyphs_face
1162 {
1163   DRAW_NORMAL_TEXT,
1164   DRAW_INVERSE_VIDEO,
1165   DRAW_CURSOR,
1166   DRAW_MOUSE_FACE,
1167   DRAW_IMAGE_RAISED,
1168   DRAW_IMAGE_SUNKEN
1169 };
1170
1171 #ifdef HAVE_WINDOW_SYSTEM
1172
1173 /* A sequence of glyphs to be drawn in the same face.  */
1174
1175 struct glyph_string
1176 {
1177   /* X-origin of the string.  */
1178   int x;
1179
1180   /* Y-origin and y-position of the base line of this string.  */
1181   int y, ybase;
1182
1183   /* The width of the string, not including a face extension.  */
1184   int width;
1185
1186   /* The width of the string, including a face extension.  */
1187   int background_width;
1188
1189   /* The height of this string.  This is the height of the line this
1190      string is drawn in, and can be different from the height of the
1191      font the string is drawn in.  */
1192   int height;
1193
1194   /* Number of pixels this string overwrites in front of its x-origin.
1195      This number is zero if the string has an lbearing >= 0; it is
1196      -lbearing, if the string has an lbearing < 0.  */
1197   int left_overhang;
1198
1199   /* Number of pixels this string overwrites past its right-most
1200      nominal x-position, i.e. x + width.  Zero if the string's
1201      rbearing is <= its nominal width, rbearing - width otherwise.  */
1202   int right_overhang;
1203
1204   /* The frame on which the glyph string is drawn.  */
1205   struct frame *f;
1206
1207   /* The window on which the glyph string is drawn.  */
1208   struct window *w;
1209
1210   /* X display and window for convenience.  */
1211   Display *display;
1212   Window window;
1213
1214   /* The glyph row for which this string was built.  It determines the
1215      y-origin and height of the string.  */
1216   struct glyph_row *row;
1217
1218   /* The area within row.  */
1219   enum glyph_row_area area;
1220
1221   /* Characters to be drawn, and number of characters.  */
1222   XChar2b *char2b;
1223   int nchars;
1224
1225   /* A face-override for drawing cursors, mouse face and similar.  */
1226   enum draw_glyphs_face hl;
1227
1228   /* Face in which this string is to be drawn.  */
1229   struct face *face;
1230
1231   /* Font in which this string is to be drawn.  */
1232   struct font *font;
1233
1234   /* Non-null means this string describes (part of) a static
1235      composition.  */
1236   struct composition *cmp;
1237
1238   /* If not negative, this string describes a compos.  */
1239   int cmp_id;
1240
1241   /* Start and end glyph indices in a glyph-string.  */
1242   int cmp_from, cmp_to;
1243
1244   /* 1 means this glyph strings face has to be drawn to the right end
1245      of the window's drawing area.  */
1246   unsigned extends_to_end_of_line_p : 1;
1247
1248   /* 1 means the background of this string has been drawn.  */
1249   unsigned background_filled_p : 1;
1250
1251   /* 1 means glyph string must be drawn with 16-bit functions.  */
1252   unsigned two_byte_p : 1;
1253
1254   /* 1 means that the original font determined for drawing this glyph
1255      string could not be loaded.  The member `font' has been set to
1256      the frame's default font in this case.  */
1257   unsigned font_not_found_p : 1;
1258
1259   /* 1 means that the face in which this glyph string is drawn has a
1260      stipple pattern.  */
1261   unsigned stippled_p : 1;
1262
1263 #define OVERLAPS_PRED           (1 << 0)
1264 #define OVERLAPS_SUCC           (1 << 1)
1265 #define OVERLAPS_BOTH           (OVERLAPS_PRED | OVERLAPS_SUCC)
1266 #define OVERLAPS_ERASED_CURSOR  (1 << 2)
1267   /* Non-zero means only the foreground of this glyph string must be
1268      drawn, and we should use the physical height of the line this
1269      glyph string appears in as clip rect.  If the value is
1270      OVERLAPS_ERASED_CURSOR, the clip rect is restricted to the rect
1271      of the erased cursor.  OVERLAPS_PRED and OVERLAPS_SUCC mean we
1272      draw overlaps with the preceding and the succeeding rows,
1273      respectively.  */
1274   unsigned for_overlaps : 3;
1275
1276   /* 1 means that all glyphs in this glyph string has the flag
1277      padding_p set, and thus must be drawn one by one to have 1-pixel
1278      width even though the logical width in the font is zero.  */
1279   unsigned padding_p : 1;
1280
1281   /* The GC to use for drawing this glyph string.  */
1282 #if defined(HAVE_X_WINDOWS)
1283   GC gc;
1284 #endif
1285 #if defined(HAVE_NTGUI)
1286   XGCValues *gc;
1287   HDC hdc;
1288 #endif
1289
1290   /* A pointer to the first glyph in the string.  This glyph
1291      corresponds to char2b[0].  Needed to draw rectangles if
1292      font_not_found_p is 1.  */
1293   struct glyph *first_glyph;
1294
1295   /* Image, if any.  */
1296   struct image *img;
1297
1298   /* Slice */
1299   struct glyph_slice slice;
1300
1301   /* Non-null means the horizontal clipping region starts from the
1302      left edge of *clip_head, and ends with the right edge of
1303      *clip_tail, not including their overhangs.  */
1304   struct glyph_string *clip_head, *clip_tail;
1305
1306   /* The current clipping areas.  */
1307   NativeRectangle clip[2];
1308
1309   /* Number of clipping areas. */
1310   int num_clips;
1311
1312   int underline_position;
1313
1314   int underline_thickness;
1315
1316   struct glyph_string *next, *prev;
1317 };
1318
1319 #endif /* HAVE_WINDOW_SYSTEM */
1320
1321 \f
1322 /************************************************************************
1323                           Display Dimensions
1324  ************************************************************************/
1325
1326 /* Return the height of the mode line in glyph matrix MATRIX, or zero
1327    if not known.  This macro is called under circumstances where
1328    MATRIX might not have been allocated yet.  */
1329
1330 #define MATRIX_MODE_LINE_HEIGHT(MATRIX)         \
1331      ((MATRIX) && (MATRIX)->rows                \
1332       ? MATRIX_MODE_LINE_ROW (MATRIX)->height   \
1333       : 0)
1334
1335 /* Return the height of the header line in glyph matrix MATRIX, or zero
1336    if not known.  This macro is called under circumstances where
1337    MATRIX might not have been allocated yet.  */
1338
1339 #define MATRIX_HEADER_LINE_HEIGHT(MATRIX)       \
1340      ((MATRIX) && (MATRIX)->rows                \
1341       ? MATRIX_HEADER_LINE_ROW (MATRIX)->height \
1342       : 0)
1343
1344 /* Return the desired face id for the mode line of a window, depending
1345    on whether the window is selected or not, or if the window is the
1346    scrolling window for the currently active minibuffer window.
1347
1348    Due to the way display_mode_lines manipulates with the contents of
1349    selected_window, this macro needs three arguments: SELW which is
1350    compared against the current value of selected_window, MBW which is
1351    compared against minibuf_window (if SELW doesn't match), and SCRW
1352    which is compared against minibuf_selected_window (if MBW matches).  */
1353
1354 #define CURRENT_MODE_LINE_FACE_ID_3(SELW, MBW, SCRW)            \
1355      ((!mode_line_in_non_selected_windows                       \
1356        || (SELW) == XWINDOW (selected_window)                   \
1357        || (minibuf_level > 0                                    \
1358            && !NILP (minibuf_selected_window)                   \
1359            && (MBW) == XWINDOW (minibuf_window)                 \
1360            && (SCRW) == XWINDOW (minibuf_selected_window)))     \
1361       ? MODE_LINE_FACE_ID                                       \
1362       : MODE_LINE_INACTIVE_FACE_ID)
1363
1364
1365 /* Return the desired face id for the mode line of window W.  */
1366
1367 #define CURRENT_MODE_LINE_FACE_ID(W)            \
1368         (CURRENT_MODE_LINE_FACE_ID_3((W), XWINDOW (selected_window), (W)))
1369
1370 /* Return the current height of the mode line of window W.  If not
1371    known from current_mode_line_height, look at W's current glyph
1372    matrix, or return a default based on the height of the font of the
1373    face `mode-line'.  */
1374
1375 #define CURRENT_MODE_LINE_HEIGHT(W)                             \
1376      (current_mode_line_height >= 0                             \
1377       ? current_mode_line_height                                \
1378       : (MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix)          \
1379          ? MATRIX_MODE_LINE_HEIGHT ((W)->current_matrix)        \
1380          : estimate_mode_line_height (XFRAME ((W)->frame),      \
1381                                       CURRENT_MODE_LINE_FACE_ID (W))))
1382
1383 /* Return the current height of the header line of window W.  If not
1384    known from current_header_line_height, look at W's current glyph
1385    matrix, or return an estimation based on the height of the font of
1386    the face `header-line'.  */
1387
1388 #define CURRENT_HEADER_LINE_HEIGHT(W)                           \
1389       (current_header_line_height >= 0                          \
1390        ? current_header_line_height                             \
1391        : (MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix)       \
1392           ? MATRIX_HEADER_LINE_HEIGHT ((W)->current_matrix)     \
1393           : estimate_mode_line_height (XFRAME ((W)->frame),     \
1394                                        HEADER_LINE_FACE_ID)))
1395
1396 /* Return the height of the desired mode line of window W.  */
1397
1398 #define DESIRED_MODE_LINE_HEIGHT(W) \
1399      MATRIX_MODE_LINE_HEIGHT ((W)->desired_matrix)
1400
1401 /* Return the height of the desired header line of window W.  */
1402
1403 #define DESIRED_HEADER_LINE_HEIGHT(W) \
1404      MATRIX_HEADER_LINE_HEIGHT ((W)->desired_matrix)
1405
1406 /* Value is non-zero if window W wants a mode line.  */
1407
1408 #define WINDOW_WANTS_MODELINE_P(W)                                      \
1409      (!MINI_WINDOW_P ((W))                                              \
1410       && !(W)->pseudo_window_p                                          \
1411       && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W))))           \
1412       && BUFFERP ((W)->buffer)                                          \
1413       && !NILP (BVAR (XBUFFER ((W)->buffer), mode_line_format))         \
1414       && WINDOW_TOTAL_LINES (W) > 1)
1415
1416 /* Value is non-zero if window W wants a header line.  */
1417
1418 #define WINDOW_WANTS_HEADER_LINE_P(W)                                   \
1419      (!MINI_WINDOW_P ((W))                                              \
1420       && !(W)->pseudo_window_p                                          \
1421       && FRAME_WANTS_MODELINE_P (XFRAME (WINDOW_FRAME ((W))))           \
1422       && BUFFERP ((W)->buffer)                                          \
1423       && !NILP (BVAR (XBUFFER ((W)->buffer), header_line_format))               \
1424       && WINDOW_TOTAL_LINES (W) > 1 + !NILP (BVAR (XBUFFER ((W)->buffer), mode_line_format)))
1425
1426
1427 /* Return proper value to be used as baseline offset of font that has
1428    ASCENT and DESCENT to draw characters by the font at the vertical
1429    center of the line of frame F.
1430
1431    Here, our task is to find the value of BOFF in the following figure;
1432
1433         -------------------------+-----------+-
1434          -+-+---------+-+        |           |
1435           | |         | |        |           |
1436           | |         | |        F_ASCENT    F_HEIGHT
1437           | |         | ASCENT   |           |
1438      HEIGHT |         | |        |           |
1439           | |         |-|-+------+-----------|------- baseline
1440           | |         | | BOFF   |           |
1441           | |---------|-+-+      |           |
1442           | |         | DESCENT  |           |
1443          -+-+---------+-+        F_DESCENT   |
1444         -------------------------+-----------+-
1445
1446         -BOFF + DESCENT + (F_HEIGHT - HEIGHT) / 2 = F_DESCENT
1447         BOFF = DESCENT +  (F_HEIGHT - HEIGHT) / 2 - F_DESCENT
1448         DESCENT = FONT->descent
1449         HEIGHT = FONT_HEIGHT (FONT)
1450         F_DESCENT = (FRAME_FONT (F)->descent
1451                      - F->terminal->output_data.x->baseline_offset)
1452         F_HEIGHT = FRAME_LINE_HEIGHT (F)
1453 */
1454
1455 #define VCENTER_BASELINE_OFFSET(FONT, F)                        \
1456   (FONT_DESCENT (FONT)                                          \
1457    + (FRAME_LINE_HEIGHT ((F)) - FONT_HEIGHT ((FONT))            \
1458       + (FRAME_LINE_HEIGHT ((F)) > FONT_HEIGHT ((FONT)))) / 2   \
1459    - (FONT_DESCENT (FRAME_FONT (F)) - FRAME_BASELINE_OFFSET (F)))
1460
1461 \f
1462 /***********************************************************************
1463                                 Faces
1464  ***********************************************************************/
1465
1466 /* Indices of face attributes in Lisp face vectors.  Slot zero is the
1467    symbol `face'.  */
1468
1469 enum lface_attribute_index
1470 {
1471   LFACE_FAMILY_INDEX = 1,
1472   LFACE_FOUNDRY_INDEX,
1473   LFACE_SWIDTH_INDEX,
1474   LFACE_HEIGHT_INDEX,
1475   LFACE_WEIGHT_INDEX,
1476   LFACE_SLANT_INDEX,
1477   LFACE_UNDERLINE_INDEX,
1478   LFACE_INVERSE_INDEX,
1479   LFACE_FOREGROUND_INDEX,
1480   LFACE_BACKGROUND_INDEX,
1481   LFACE_STIPPLE_INDEX,
1482   LFACE_OVERLINE_INDEX,
1483   LFACE_STRIKE_THROUGH_INDEX,
1484   LFACE_BOX_INDEX,
1485   LFACE_FONT_INDEX,
1486   LFACE_INHERIT_INDEX,
1487   LFACE_FONTSET_INDEX,
1488   LFACE_VECTOR_SIZE
1489 };
1490
1491
1492 /* Box types of faces.  */
1493
1494 enum face_box_type
1495 {
1496   /* No box around text.  */
1497   FACE_NO_BOX,
1498
1499   /* Simple box of specified width and color.  Default width is 1, and
1500      default color is the foreground color of the face.  */
1501   FACE_SIMPLE_BOX,
1502
1503   /* Boxes with 3D shadows.  Color equals the background color of the
1504      face.  Width is specified.  */
1505   FACE_RAISED_BOX,
1506   FACE_SUNKEN_BOX
1507 };
1508
1509
1510 /* Structure describing a realized face.
1511
1512    For each Lisp face, 0..N realized faces can exist for different
1513    frames and different charsets.  Realized faces are built from Lisp
1514    faces and text properties/overlays by merging faces and adding
1515    unspecified attributes from the `default' face.  */
1516
1517 struct face
1518 {
1519   /* The id of this face.  The id equals the index of this face in the
1520      vector faces_by_id of its face cache.  */
1521   int id;
1522
1523 #ifdef HAVE_WINDOW_SYSTEM
1524
1525   /* If non-zero, this is a GC that we can use without modification for
1526      drawing the characters in this face.  */
1527   GC gc;
1528
1529   /* Background stipple or bitmap used for this face.  This is
1530      an id as returned from load_pixmap.  */
1531   int stipple;
1532
1533 #else /* not HAVE_WINDOW_SYSTEM */
1534
1535   /* Dummy.  */
1536   int stipple;
1537
1538 #endif /* not HAVE_WINDOW_SYSTEM */
1539
1540   /* Pixel value of foreground color for X frames.  Color index
1541      for tty frames.  */
1542   unsigned long foreground;
1543
1544   /* Pixel value or color index of background color.  */
1545   unsigned long background;
1546
1547   /* Pixel value or color index of underline color.  */
1548   unsigned long underline_color;
1549
1550   /* Pixel value or color index of overlined, strike-through, or box
1551      color.  */
1552   unsigned long overline_color;
1553   unsigned long strike_through_color;
1554   unsigned long box_color;
1555
1556   struct font *font;
1557
1558   /* Fontset ID if for this face's fontset.  Non-ASCII faces derived
1559      from the same ASCII face have the same fontset.  */
1560   int fontset;
1561
1562   /* Pixmap width and height.  */
1563   unsigned int pixmap_w, pixmap_h;
1564
1565   /* Non-zero means characters in this face have a box that thickness
1566      around them.  If it is negative, the absolute value indicates the
1567      thickness, and the horizontal lines of box (top and bottom) are
1568      drawn inside of characters glyph area.  The vertical lines of box
1569      (left and right) are drawn as the same way as the case that this
1570      value is positive.  */
1571   int box_line_width;
1572
1573   /* Type of box drawn.  A value of FACE_NO_BOX means no box is drawn
1574      around text in this face.  A value of FACE_SIMPLE_BOX means a box
1575      of width box_line_width is drawn in color box_color.  A value of
1576      FACE_RAISED_BOX or FACE_SUNKEN_BOX means a 3D box is drawn with
1577      shadow colors derived from the background color of the face.  */
1578   enum face_box_type box;
1579
1580   /* If `box' above specifies a 3D type, 1 means use box_color for
1581      drawing shadows.  */
1582   unsigned use_box_color_for_shadows_p : 1;
1583
1584   /* Non-zero if text in this face should be underlined, overlined,
1585      strike-through or have a box drawn around it.  */
1586   unsigned underline_p : 1;
1587   unsigned overline_p : 1;
1588   unsigned strike_through_p : 1;
1589
1590   /* 1 means that the colors specified for this face could not be
1591      loaded, and were replaced by default colors, so they shouldn't be
1592      freed.  */
1593   unsigned foreground_defaulted_p : 1;
1594   unsigned background_defaulted_p : 1;
1595
1596   /* 1 means that either no color is specified for underlining or that
1597      the specified color couldn't be loaded.  Use the foreground
1598      color when drawing in that case. */
1599   unsigned underline_defaulted_p : 1;
1600
1601   /* 1 means that either no color is specified for the corresponding
1602      attribute or that the specified color couldn't be loaded.
1603      Use the foreground color when drawing in that case. */
1604   unsigned overline_color_defaulted_p : 1;
1605   unsigned strike_through_color_defaulted_p : 1;
1606   unsigned box_color_defaulted_p : 1;
1607
1608   /* TTY appearances.  Blinking is not yet implemented.  Colors are
1609      found in `lface' with empty color string meaning the default
1610      color of the TTY.  */
1611   unsigned tty_bold_p : 1;
1612   unsigned tty_dim_p : 1;
1613   unsigned tty_underline_p : 1;
1614   unsigned tty_alt_charset_p : 1;
1615   unsigned tty_reverse_p : 1;
1616   unsigned tty_blinking_p : 1;
1617
1618   /* 1 means that colors of this face may not be freed because they
1619      have been copied bitwise from a base face (see
1620      realize_x_face).  */
1621   unsigned colors_copied_bitwise_p : 1;
1622
1623   /* If non-zero, use overstrike (to simulate bold-face).  */
1624   unsigned overstrike : 1;
1625
1626 /* NOTE: this is not used yet, but eventually this impl should be done
1627          similarly to overstrike */
1628 #ifdef HAVE_NS
1629   /* If non-zero, use geometric rotation (to simulate italic).  */
1630   unsigned synth_ital : 1;
1631 #endif
1632
1633   /* The Lisp face attributes this face realizes.  All attributes
1634      in this vector are non-nil.  */
1635   Lisp_Object lface[LFACE_VECTOR_SIZE];
1636
1637   /* The hash value of this face.  */
1638   unsigned hash;
1639
1640   /* Next and previous face in hash collision list of face cache.  */
1641   struct face *next, *prev;
1642
1643   /* If this face is an ASCII face, this points to this face itself.
1644      Otherwise, this points to an ASCII face that has the same
1645      attributes except the font.  */
1646   struct face *ascii_face;
1647
1648   /* Extra member that a font-driver uses privately.  */
1649   void *extra;
1650 };
1651
1652
1653 /* Color index indicating that face uses a terminal's default color.  */
1654
1655 #define FACE_TTY_DEFAULT_COLOR ((unsigned long) -1)
1656
1657 /* Color index indicating that face uses an unknown foreground color.  */
1658
1659 #define FACE_TTY_DEFAULT_FG_COLOR ((unsigned long) -2)
1660
1661 /* Color index indicating that face uses an unknown background color.  */
1662
1663 #define FACE_TTY_DEFAULT_BG_COLOR ((unsigned long) -3)
1664
1665 /* Non-zero if FACE was realized for unibyte use.  */
1666
1667 #define FACE_UNIBYTE_P(FACE) ((FACE)->charset < 0)
1668
1669
1670 /* IDs of important faces known by the C face code.  These are the IDs
1671    of the faces for CHARSET_ASCII.  */
1672
1673 enum face_id
1674 {
1675   DEFAULT_FACE_ID,
1676   MODE_LINE_FACE_ID,
1677   MODE_LINE_INACTIVE_FACE_ID,
1678   TOOL_BAR_FACE_ID,
1679   FRINGE_FACE_ID,
1680   HEADER_LINE_FACE_ID,
1681   SCROLL_BAR_FACE_ID,
1682   BORDER_FACE_ID,
1683   CURSOR_FACE_ID,
1684   MOUSE_FACE_ID,
1685   MENU_FACE_ID,
1686   VERTICAL_BORDER_FACE_ID,
1687   BASIC_FACE_ID_SENTINEL
1688 };
1689
1690 #define MAX_FACE_ID  ((1 << FACE_ID_BITS) - 1)
1691
1692 /* A cache of realized faces.  Each frame has its own cache because
1693    Emacs allows different frame-local face definitions.  */
1694
1695 struct face_cache
1696 {
1697   /* Hash table of cached realized faces.  */
1698   struct face **buckets;
1699
1700   /* Back-pointer to the frame this cache belongs to.  */
1701   struct frame *f;
1702
1703   /* A vector of faces so that faces can be referenced by an ID.  */
1704   struct face **faces_by_id;
1705
1706   /* The allocated size, and number of used slots of faces_by_id.  */
1707   int size, used;
1708
1709   /* Flag indicating that attributes of the `menu' face have been
1710      changed.  */
1711   unsigned menu_face_changed_p : 1;
1712 };
1713
1714
1715 /* Prepare face FACE for use on frame F.  This must be called before
1716    using X resources of FACE.  */
1717
1718 #define PREPARE_FACE_FOR_DISPLAY(F, FACE)       \
1719      if ((FACE)->gc == 0)                       \
1720        prepare_face_for_display ((F), (FACE));  \
1721      else                                       \
1722        (void) 0
1723
1724 /* Return a pointer to the face with ID on frame F, or null if such a
1725    face doesn't exist.  */
1726
1727 #define FACE_FROM_ID(F, ID)                             \
1728      (((unsigned) (ID) < FRAME_FACE_CACHE (F)->used)    \
1729       ? FRAME_FACE_CACHE (F)->faces_by_id[ID]           \
1730       : NULL)
1731
1732 #ifdef HAVE_WINDOW_SYSTEM
1733
1734 /* Non-zero if FACE is suitable for displaying character CHAR.  */
1735
1736 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR)      \
1737   ((FACE) == (FACE)->ascii_face)
1738
1739 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR)    \
1740   (ASCII_CHAR_P (CHAR)                          \
1741    ? FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE)       \
1742    : face_suitable_for_char_p ((FACE), (CHAR)))
1743
1744 /* Return the id of the realized face on frame F that is like the face
1745    with id ID but is suitable for displaying character CHAR.
1746    This macro is only meaningful for multibyte character CHAR.  */
1747
1748 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT)       \
1749   ((ASCII_CHAR_P (CHAR) || CHAR_BYTE8_P (CHAR))         \
1750    ? (FACE)->ascii_face->id                             \
1751    : face_for_char ((F), (FACE), (CHAR), (POS), (OBJECT)))
1752
1753 #else /* not HAVE_WINDOW_SYSTEM */
1754
1755 #define FACE_SUITABLE_FOR_ASCII_CHAR_P(FACE, CHAR) 1
1756 #define FACE_SUITABLE_FOR_CHAR_P(FACE, CHAR) 1
1757 #define FACE_FOR_CHAR(F, FACE, CHAR, POS, OBJECT) ((FACE)->id)
1758
1759 #endif /* not HAVE_WINDOW_SYSTEM */
1760
1761 /* Non-zero means face attributes have been changed since the last
1762    redisplay.  Used in redisplay_internal.  */
1763
1764 extern int face_change_count;
1765
1766 /* For reordering of bidirectional text.  */
1767 #define BIDI_MAXLEVEL 64
1768
1769 /* Data type for describing the bidirectional character types.  The
1770    first 7 must be at the beginning, because they are the only values
1771    valid in the `bidi_type' member of `struct glyph'; we only reserve
1772    3 bits for it, so we cannot use there values larger than 7.  */
1773 typedef enum {
1774   UNKNOWN_BT = 0,
1775   STRONG_L,     /* strong left-to-right */
1776   STRONG_R,     /* strong right-to-left */
1777   WEAK_EN,      /* european number */
1778   WEAK_AN,      /* arabic number */
1779   WEAK_BN,      /* boundary neutral */
1780   NEUTRAL_B,    /* paragraph separator */
1781   STRONG_AL,    /* arabic right-to-left letter */
1782   LRE,          /* left-to-right embedding */
1783   LRO,          /* left-to-right override */
1784   RLE,          /* right-to-left embedding */
1785   RLO,          /* right-to-left override */
1786   PDF,          /* pop directional format */
1787   WEAK_ES,      /* european number separator */
1788   WEAK_ET,      /* european number terminator */
1789   WEAK_CS,      /* common separator */
1790   WEAK_NSM,     /* non-spacing mark */
1791   NEUTRAL_S,    /* segment separator */
1792   NEUTRAL_WS,   /* whitespace */
1793   NEUTRAL_ON    /* other neutrals */
1794 } bidi_type_t;
1795
1796 /* The basic directionality data type.  */
1797 typedef enum { NEUTRAL_DIR, L2R, R2L } bidi_dir_t;
1798
1799 /* Data type for storing information about characters we need to
1800    remember.  */
1801 struct bidi_saved_info {
1802   EMACS_INT bytepos, charpos;   /* character's buffer position */
1803   bidi_type_t type;             /* character's resolved bidi type */
1804   bidi_type_t type_after_w1;    /* original type of the character, after W1 */
1805   bidi_type_t orig_type;        /* type as we found it in the buffer */
1806 };
1807
1808 /* Data type for keeping track of saved embedding levels and override
1809    status information.  */
1810 struct bidi_stack {
1811   int level;
1812   bidi_dir_t override;
1813 };
1814
1815 /* Data type for storing information about a string being iterated on.  */
1816 struct bidi_string_data {
1817   Lisp_Object lstring;          /* Lisp string to reorder, or nil */
1818   const unsigned char *s;       /* string data, or NULL if reordering buffer */
1819   EMACS_INT schars;             /* the number of characters in the string,
1820                                    excluding the terminating null */
1821   EMACS_INT bufpos;             /* buffer position of lstring, or 0 if N/A */
1822   unsigned from_disp_str : 1;   /* 1 means the string comes from a
1823                                    display property */
1824   unsigned unibyte : 1;         /* 1 means the string is unibyte */
1825 };
1826
1827 /* Data type for reordering bidirectional text.  */
1828 struct bidi_it {
1829   EMACS_INT bytepos;            /* iterator's position in buffer/string */
1830   EMACS_INT charpos;
1831   int ch;                       /* character at that position, or u+FFFC
1832                                    ("object replacement character") for a run
1833                                    of characters covered by a display string */
1834   EMACS_INT nchars;             /* its "length", usually 1; it's > 1 for a run
1835                                    of characters covered by a display string */
1836   EMACS_INT ch_len;             /* its length in bytes */
1837   bidi_type_t type;             /* bidi type of this character, after
1838                                    resolving weak and neutral types */
1839   bidi_type_t type_after_w1;    /* original type, after overrides and W1 */
1840   bidi_type_t orig_type;        /* original type, as found in the buffer */
1841   int resolved_level;           /* final resolved level of this character */
1842   int invalid_levels;           /* how many PDFs to ignore */
1843   int invalid_rl_levels;        /* how many PDFs from RLE/RLO to ignore */
1844   int prev_was_pdf;             /* if non-zero, previous char was PDF */
1845   struct bidi_saved_info prev;  /* info about previous character */
1846   struct bidi_saved_info last_strong; /* last-seen strong directional char */
1847   struct bidi_saved_info next_for_neutral; /* surrounding characters for... */
1848   struct bidi_saved_info prev_for_neutral; /* ...resolving neutrals */
1849   struct bidi_saved_info next_for_ws; /* character after sequence of ws */
1850   EMACS_INT next_en_pos;        /* position of next EN char for ET */
1851   EMACS_INT ignore_bn_limit;    /* position until which to ignore BNs */
1852   bidi_dir_t sor;               /* direction of start-of-run in effect */
1853   int scan_dir;                 /* direction of text scan, 1: forw, -1: back */
1854   int stack_idx;                /* index of current data on the stack */
1855   /* Note: Everything from here on is not copied/saved when the bidi
1856      iterator state is saved, pushed, or popped.  So only put here
1857      stuff that is not part of the bidi iterator's state!  */
1858   struct bidi_stack level_stack[BIDI_MAXLEVEL]; /* stack of embedding levels */
1859   struct bidi_string_data string;       /* string to reorder */
1860   bidi_dir_t paragraph_dir;     /* current paragraph direction */
1861   EMACS_INT separator_limit;    /* where paragraph separator should end */
1862   EMACS_INT disp_pos;           /* position of display string after ch */
1863   unsigned first_elt : 1;       /* if non-zero, examine current char first */
1864   unsigned new_paragraph : 1;   /* if non-zero, we expect a new paragraph */
1865   unsigned frame_window_p : 1;  /* non-zero if displaying on a GUI frame */
1866 };
1867
1868 /* Value is non-zero when the bidi iterator is at base paragraph
1869    embedding level.  */
1870 #define BIDI_AT_BASE_LEVEL(BIDI_IT) \
1871   ((BIDI_IT).resolved_level == (BIDI_IT).level_stack[0].level)
1872
1873 \f
1874 /***********************************************************************
1875                                Fringes
1876  ***********************************************************************/
1877
1878 /* Structure used to describe where and how to draw a fringe bitmap.
1879    WHICH is the fringe bitmap to draw.  WD and H is the (adjusted)
1880    width and height of the bitmap, DH is the height adjustment (if
1881    bitmap is periodic).  X and Y are frame coordinates of the area to
1882    display the bitmap, DY is relative offset of the bitmap into that
1883    area.  BX, NX, BY, NY specifies the area to clear if the bitmap
1884    does not fill the entire area.  FACE is the fringe face.  */
1885
1886 struct draw_fringe_bitmap_params
1887 {
1888   int which;  /* enum fringe_bitmap_type */
1889   unsigned short *bits;
1890   int wd, h, dh;
1891   int x, y;
1892   int bx, nx, by, ny;
1893   unsigned cursor_p : 1;
1894   unsigned overlay_p : 1;
1895   struct face *face;
1896 };
1897
1898 #define MAX_FRINGE_BITMAPS (1<<FRINGE_ID_BITS)
1899
1900 \f
1901 /***********************************************************************
1902                             Display Iterator
1903  ***********************************************************************/
1904
1905 /* Iteration over things to display in current_buffer or in a string.
1906
1907    The iterator handles:
1908
1909    1. Overlay strings (after-string, before-string).
1910    2. Face properties.
1911    3. Invisible text properties.
1912    4. Selective display.
1913    5. Translation of characters via display tables.
1914    6. Translation of control characters to the forms `\003' or `^C'.
1915    7. `glyph' and `space-width' properties.
1916
1917    Iterators are initialized by calling init_iterator or one of the
1918    equivalent functions below.  A call to get_next_display_element
1919    loads the iterator structure with information about what next to
1920    display.  A call to set_iterator_to_next increments the iterator's
1921    position.
1922
1923    Characters from overlay strings, display table entries or control
1924    character translations are returned one at a time.  For example, if
1925    we have a text of `a\x01' where `a' has a display table definition
1926    of `cd' and the control character is displayed with a leading
1927    arrow, then the iterator will return:
1928
1929    Call         Return  Source          Call next
1930    -----------------------------------------------------------------
1931    next         c       display table   move
1932    next         d       display table   move
1933    next         ^       control char    move
1934    next         A       control char    move
1935
1936    The same mechanism is also used to return characters for ellipses
1937    displayed at the end of invisible text.
1938
1939    CAVEAT: Under some circumstances, move_.* functions can be called
1940    asynchronously, e.g. when computing a buffer position from an x and
1941    y pixel position.  This means that these functions and functions
1942    called from them SHOULD NOT USE xmalloc and alike.  See also the
1943    comment at the start of xdisp.c.  */
1944
1945 /* Enumeration describing what kind of display element an iterator is
1946    loaded with after a call to get_next_display_element.  */
1947
1948 enum display_element_type
1949 {
1950   /* A normal character.  */
1951   IT_CHARACTER,
1952
1953   /* A composition (static and automatic).  */
1954   IT_COMPOSITION,
1955
1956   /* A glyphless character (e.g. ZWNJ, LRE).  */
1957   IT_GLYPHLESS,
1958
1959   /* An image.  */
1960   IT_IMAGE,
1961
1962   /* A flexible width and height space.  */
1963   IT_STRETCH,
1964
1965   /* End of buffer or string.  */
1966   IT_EOB,
1967
1968   /* Truncation glyphs.  Never returned by get_next_display_element.
1969      Used to get display information about truncation glyphs via
1970      produce_glyphs.  */
1971   IT_TRUNCATION,
1972
1973   /* Continuation glyphs.  See the comment for IT_TRUNCATION.  */
1974   IT_CONTINUATION
1975 };
1976
1977
1978 /* An enumerator for each text property that has a meaning for display
1979    purposes.  */
1980
1981 enum prop_idx
1982 {
1983   FONTIFIED_PROP_IDX,
1984   FACE_PROP_IDX,
1985   INVISIBLE_PROP_IDX,
1986   DISPLAY_PROP_IDX,
1987   COMPOSITION_PROP_IDX,
1988
1989   /* Not a property.  Used to indicate changes in overlays.  */
1990   OVERLAY_PROP_IDX,
1991
1992   /* Sentinel.  */
1993   LAST_PROP_IDX
1994 };
1995
1996 /* An enumerator for the method of wrapping long lines.  */
1997
1998 enum line_wrap_method
1999 {
2000   TRUNCATE,
2001   WORD_WRAP,
2002   WINDOW_WRAP
2003 };
2004
2005 /* An enumerator for the method of displaying glyphless characters.  */
2006
2007 enum glyphless_display_method
2008   {
2009     /* Display a thin (1-pixel width) space.  On a TTY, display a
2010        1-character width space.  */
2011     GLYPHLESS_DISPLAY_THIN_SPACE,
2012     /* Display an empty box of proper width.  */
2013     GLYPHLESS_DISPLAY_EMPTY_BOX,
2014     /* Display an acronym string in a box.  */
2015     GLYPHLESS_DISPLAY_ACRONYM,
2016     /* Display the hexadecimal code of the character in a box.  */
2017     GLYPHLESS_DISPLAY_HEX_CODE
2018   };
2019
2020 struct it_slice
2021 {
2022   Lisp_Object x;
2023   Lisp_Object y;
2024   Lisp_Object width;
2025   Lisp_Object height;
2026 };
2027
2028 /* Input sources for fetching characters or data to display.
2029    The input source is found in the `method' field.  */
2030
2031 enum it_method {
2032   GET_FROM_BUFFER = 0,
2033   GET_FROM_DISPLAY_VECTOR,
2034   GET_FROM_STRING,
2035   GET_FROM_C_STRING,
2036   GET_FROM_IMAGE,
2037   GET_FROM_STRETCH,
2038   NUM_IT_METHODS
2039 };
2040
2041 /* FIXME: What is this?  Why 5?  */
2042 #define IT_STACK_SIZE 5
2043
2044 /* Iterator for composition (both for static and automatic).  */
2045 struct composition_it
2046 {
2047   /* Next position at which to check the composition.  */
2048   EMACS_INT stop_pos;
2049   /* ID number of the composition or glyph-string.  If negative, we
2050      are not iterating over a composition now.  */
2051   int id;
2052   /* If non-negative, character that triggers the automatic
2053      composition at `stop_pos', and this is an automatic composition.
2054      If negative, this is a static composition.  This is set to -2
2055      temporarily if searching of composition reach a limit or a
2056      newline.  */
2057   int ch;
2058   /* If this is an automatic composition, index of a rule for making
2059      the automatic composition.  Provided that ELT is an element of
2060      Vcomposition_function_table for CH, (nth ELT RULE_IDX) is the
2061      rule for the composition.  */
2062   int rule_idx;
2063   /* If this is an automatic composition, how many characters to look
2064      back from the position where a character triggering the
2065      composition exists.  */
2066   int lookback;
2067   /* If non-negative, number of glyphs of the glyph-string.  */
2068   int nglyphs;
2069   /* Nonzero iff the composition is created while buffer is scanned in
2070      reverse order, and thus the grapheme clusters must be rendered
2071      from the last to the first.  */
2072   int reversed_p;
2073
2074   /** The following members contain information about the current
2075       grapheme cluster.  */
2076   /* Position of the first character of the current grapheme cluster.  */
2077   EMACS_INT charpos;
2078   /* Number of characters and bytes of the current grapheme cluster.  */
2079   int nchars, nbytes;
2080   /* Indices of the glyphs for the current grapheme cluster.  */
2081   int from, to;
2082   /* Width of the current grapheme cluster in units of pixels on a
2083      graphic display and in units of canonical characters on a
2084      terminal display.  */
2085   int width;
2086 };
2087
2088 struct it
2089 {
2090   /* The window in which we iterate over current_buffer (or a string).  */
2091   Lisp_Object window;
2092   struct window *w;
2093
2094   /* The window's frame.  */
2095   struct frame *f;
2096
2097   /* Method to use to load this structure with the next display element.  */
2098   enum it_method method;
2099
2100   /* The next position at which to check for face changes, invisible
2101      text, overlay strings, end of text etc., which see.  */
2102   EMACS_INT stop_charpos;
2103
2104   /* Previous stop position, i.e. the last one before the current
2105      iterator position in `current'.  */
2106   EMACS_INT prev_stop;
2107
2108   /* Last stop position iterated across whose bidi embedding level is
2109      equal to the current paragraph's base embedding level.  */
2110   EMACS_INT base_level_stop;
2111
2112   /* Maximum string or buffer position + 1.  ZV when iterating over
2113      current_buffer.  */
2114   EMACS_INT end_charpos;
2115
2116   /* C string to iterate over.  Non-null means get characters from
2117      this string, otherwise characters are read from current_buffer
2118      or it->string.  */
2119   const unsigned char *s;
2120
2121   /* Number of characters in the string (s, or it->string) we iterate
2122      over.  */
2123   EMACS_INT string_nchars;
2124
2125   /* Start and end of a visible region; -1 if the region is not
2126      visible in the window.  */
2127   EMACS_INT region_beg_charpos, region_end_charpos;
2128
2129   /* Position at which redisplay end trigger functions should be run.  */
2130   EMACS_INT redisplay_end_trigger_charpos;
2131
2132   /* 1 means multibyte characters are enabled.  */
2133   unsigned multibyte_p : 1;
2134
2135   /* 1 means window has a mode line at its top.  */
2136   unsigned header_line_p : 1;
2137
2138   /* 1 means `string' is the value of a `display' property.
2139      Don't handle some `display' properties in these strings.  */
2140   unsigned string_from_display_prop_p : 1;
2141
2142   /* 1 means we are iterating an object that came from a value of a
2143      `display' property.  */
2144   unsigned from_disp_prop_p : 1;
2145
2146   /* When METHOD == next_element_from_display_vector,
2147      this is 1 if we're doing an ellipsis.  Otherwise meaningless.  */
2148   unsigned ellipsis_p : 1;
2149
2150   /* True means cursor shouldn't be displayed here.  */
2151   unsigned avoid_cursor_p : 1;
2152
2153   /* Display table in effect or null for none.  */
2154   struct Lisp_Char_Table *dp;
2155
2156   /* Current display table vector to return characters from and its
2157      end.  dpvec null means we are not returning characters from a
2158      display table entry; current.dpvec_index gives the current index
2159      into dpvec.  This same mechanism is also used to return
2160      characters from translated control characters, i.e. `\003' or
2161      `^C'.  */
2162   Lisp_Object *dpvec, *dpend;
2163
2164   /* Length in bytes of the char that filled dpvec.  A value of zero
2165      means that no such character is involved.  A negative value means
2166      the rest of the line from the current iterator position onwards
2167      is hidden by selective display or ellipsis.  */
2168   int dpvec_char_len;
2169
2170   /* Face id to use for all characters in display vector.  -1 if unused. */
2171   int dpvec_face_id;
2172
2173   /* Face id of the iterator saved in case a glyph from dpvec contains
2174      a face.  The face is restored when all glyphs from dpvec have
2175      been delivered.  */
2176   int saved_face_id;
2177
2178   /* Vector of glyphs for control character translation.  The pointer
2179      dpvec is set to ctl_chars when a control character is translated.
2180      This vector is also used for incomplete multibyte character
2181      translation (e.g \222\244).  Such a character is at most 4 bytes,
2182      thus we need at most 16 bytes here.  */
2183   Lisp_Object ctl_chars[16];
2184
2185   /* Initial buffer or string position of the iterator, before skipping
2186      over display properties and invisible text.  */
2187   struct display_pos start;
2188
2189   /* Current buffer or string position of the iterator, including
2190      position in overlay strings etc.  */
2191   struct display_pos current;
2192
2193   /* Total number of overlay strings to process.  This can be >
2194      OVERLAY_STRING_CHUNK_SIZE.  */
2195   int n_overlay_strings;
2196
2197   /* The charpos where n_overlay_strings was calculated.  This should
2198      be set at the same time as n_overlay_strings.  It is needed
2199      because we show before-strings at the start of invisible text;
2200      see handle_invisible_prop in xdisp.c.  */
2201   int overlay_strings_charpos;
2202
2203   /* Vector of overlays to process.  Overlay strings are processed
2204      OVERLAY_STRING_CHUNK_SIZE at a time.  */
2205 #define OVERLAY_STRING_CHUNK_SIZE 16
2206   Lisp_Object overlay_strings[OVERLAY_STRING_CHUNK_SIZE];
2207
2208   /* For each overlay string, the overlay it came from.  */
2209   Lisp_Object string_overlays[OVERLAY_STRING_CHUNK_SIZE];
2210
2211   /* If non-nil, a Lisp string being processed.  If
2212      current.overlay_string_index >= 0, this is an overlay string from
2213      pos.  */
2214   Lisp_Object string;
2215
2216   /* If non-nil, we are processing a string that came
2217      from a `display' property given by an overlay.  */
2218   Lisp_Object from_overlay;
2219
2220   /* Stack of saved values.  New entries are pushed when we begin to
2221      process an overlay string or a string from a `glyph' property.
2222      Entries are popped when we return to deliver display elements
2223      from what we previously had.  */
2224   struct iterator_stack_entry
2225   {
2226     Lisp_Object string;
2227     int string_nchars;
2228     EMACS_INT end_charpos;
2229     EMACS_INT stop_charpos;
2230     EMACS_INT prev_stop;
2231     EMACS_INT base_level_stop;
2232     struct composition_it cmp_it;
2233     int face_id;
2234
2235     /* Save values specific to a given method.  */
2236     union {
2237       /* method == GET_FROM_IMAGE */
2238       struct {
2239         Lisp_Object object;
2240         struct it_slice slice;
2241         int image_id;
2242       } image;
2243       /* method == GET_FROM_COMPOSITION */
2244       struct {
2245         Lisp_Object object;
2246       } comp;
2247       /* method == GET_FROM_STRETCH */
2248       struct {
2249         Lisp_Object object;
2250       } stretch;
2251     } u;
2252
2253     /* current text and display positions.  */
2254     struct text_pos position;
2255     struct display_pos current;
2256     Lisp_Object from_overlay;
2257     enum glyph_row_area area;
2258     enum it_method method;
2259     bidi_dir_t paragraph_embedding;
2260     unsigned multibyte_p : 1;
2261     unsigned string_from_display_prop_p : 1;
2262     unsigned display_ellipsis_p : 1;
2263     unsigned avoid_cursor_p : 1;
2264     unsigned bidi_p:1;
2265     unsigned from_disp_prop_p : 1;
2266     enum line_wrap_method line_wrap;
2267
2268     /* properties from display property that are reset by another display property. */
2269     short voffset;
2270     Lisp_Object space_width;
2271     Lisp_Object font_height;
2272   }
2273   stack[IT_STACK_SIZE];
2274
2275   /* Stack pointer.  */
2276   int sp;
2277
2278   /* -1 means selective display hides everything between a \r and the
2279      next newline; > 0 means hide lines indented more than that value.  */
2280   int selective;
2281
2282   /* An enumeration describing what the next display element is
2283      after a call to get_next_display_element.  */
2284   enum display_element_type what;
2285
2286   /* Face to use.  */
2287   int face_id;
2288
2289   /* Setting of buffer-local variable selective-display-ellipsis.  */
2290   unsigned selective_display_ellipsis_p : 1;
2291
2292   /* 1 means control characters are translated into the form `^C'
2293      where the `^' can be replaced by a display table entry.  */
2294   unsigned ctl_arrow_p : 1;
2295
2296   /* Non-zero means that the current face has a box.  */
2297   unsigned face_box_p : 1;
2298
2299   /* Non-null means that the current character is the first in a run
2300      of characters with box face.  */
2301   unsigned start_of_box_run_p : 1;
2302
2303   /* Non-zero means that the current character is the last in a run
2304      of characters with box face.  */
2305   unsigned end_of_box_run_p : 1;
2306
2307   /* 1 means overlay strings at end_charpos have been processed.  */
2308   unsigned overlay_strings_at_end_processed_p : 1;
2309
2310   /* 1 means to ignore overlay strings at current pos, as they have
2311      already been processed.  */
2312   unsigned ignore_overlay_strings_at_pos_p : 1;
2313
2314   /* 1 means the actual glyph is not available in the current
2315      system.  */
2316   unsigned glyph_not_available_p : 1;
2317
2318   /* 1 means the next line in display_line continues a character
2319      consisting of more than one glyph, and some glyphs of this
2320      character have been put on the previous line.  */
2321   unsigned starts_in_middle_of_char_p : 1;
2322
2323   /* If 1, saved_face_id contains the id of the face in front of text
2324      skipped due to selective display.  */
2325   unsigned face_before_selective_p : 1;
2326
2327   /* If 1, adjust current glyph so it does not increase current row
2328      descent/ascent (line-height property).  Reset after this glyph.  */
2329   unsigned constrain_row_ascent_descent_p : 1;
2330
2331   enum line_wrap_method line_wrap;
2332
2333   /* The ID of the default face to use.  One of DEFAULT_FACE_ID,
2334      MODE_LINE_FACE_ID, etc, depending on what we are displaying.  */
2335   int base_face_id;
2336
2337   /* If `what' == IT_CHARACTER, the character and the length in bytes
2338      of its multibyte sequence.  The character comes from a buffer or
2339      a string.  It may be different from the character displayed in
2340      case that unibyte_display_via_language_environment is set.
2341
2342      If `what' == IT_COMPOSITION, the first component of a composition
2343      and length in bytes of the composition.
2344
2345      If `what' is anything else, these two are undefined (will
2346      probably hold values for the last IT_CHARACTER or IT_COMPOSITION
2347      traversed by the iterator.
2348
2349      The values are updated by get_next_display_element, so they are
2350      out of sync with the value returned by IT_CHARPOS between the
2351      time set_iterator_to_next advances the position and the time
2352      get_next_display_element loads the new values into c and len.  */
2353   int c, len;
2354
2355   /* If what == IT_COMPOSITION, iterator substructure for the
2356      composition.  */
2357   struct composition_it cmp_it;
2358
2359   /* The character to display, possibly translated to multibyte if
2360      multibyte_p is zero or unibyte_display_via_language_environment
2361      is set.  This is set after get_next_display_element has been
2362      called.  If we are setting it->C directly before calling
2363      PRODUCE_GLYPHS, this should be set beforehand too.  */
2364   int char_to_display;
2365
2366   /* If what == IT_GLYPHLESS, the method to display such a
2367      character.  */
2368   enum glyphless_display_method glyphless_method;
2369
2370   /* If what == IT_IMAGE, the id of the image to display.  */
2371   int image_id;
2372
2373   /* Values from `slice' property.  */
2374   struct it_slice slice;
2375
2376   /* Value of the `space-width' property, if any; nil if none.  */
2377   Lisp_Object space_width;
2378
2379   /* Computed from the value of the `raise' property.  */
2380   short voffset;
2381
2382   /* Number of columns per \t.  */
2383   short tab_width;
2384
2385   /* Value of the `height' property, if any; nil if none.  */
2386   Lisp_Object font_height;
2387
2388   /* Object and position where the current display element came from.
2389      Object can be a Lisp string in case the current display element
2390      comes from an overlay string, or it is buffer.  It may also be nil
2391      during mode-line update.  Position is a position in object.  */
2392   Lisp_Object object;
2393   struct text_pos position;
2394
2395   /* Width in pixels of truncation and continuation glyphs.  */
2396   short truncation_pixel_width, continuation_pixel_width;
2397
2398   /* First and last visible x-position in the display area.  If window
2399      is hscrolled by n columns, first_visible_x == n * FRAME_COLUMN_WIDTH
2400      (f), and last_visible_x == pixel width of W + first_visible_x.  */
2401   int first_visible_x, last_visible_x;
2402
2403   /* Last visible y-position + 1 in the display area without a mode
2404      line, if the window has one.  */
2405   int last_visible_y;
2406
2407   /* Default amount of additional space in pixels between lines (for
2408      window systems only.)  */
2409   int extra_line_spacing;
2410
2411   /* Max extra line spacing added in this row.  */
2412   int max_extra_line_spacing;
2413
2414   /* Override font height information for this glyph.
2415      Used if override_ascent >= 0.  Cleared after this glyph.  */
2416   int override_ascent, override_descent, override_boff;
2417
2418   /* If non-null, glyphs are produced in glyph_row with each call to
2419      produce_glyphs.  */
2420   struct glyph_row *glyph_row;
2421
2422   /* The area of glyph_row to which glyphs are added.  */
2423   enum glyph_row_area area;
2424
2425   /* Number of glyphs needed for the last character requested via
2426      produce_glyphs.  This is 1 except for tabs.  */
2427   int nglyphs;
2428
2429   /* Width of the display element in pixels.  Result of
2430      produce_glyphs.  */
2431   int pixel_width;
2432
2433   /* Current, maximum logical, and maximum physical line height
2434      information.  Result of produce_glyphs.  */
2435   int ascent, descent, max_ascent, max_descent;
2436   int phys_ascent, phys_descent, max_phys_ascent, max_phys_descent;
2437
2438   /* Current x pixel position within the display line.  This value
2439      does not include the width of continuation lines in front of the
2440      line.  The value of current_x is automatically incremented by
2441      pixel_width with each call to produce_glyphs.  */
2442   int current_x;
2443
2444   /* Accumulated width of continuation lines.  If > 0, this means we
2445      are currently in a continuation line.  This is initially zero and
2446      incremented/reset by display_line, move_it_to etc.  */
2447   int continuation_lines_width;
2448
2449   /* Buffer position that ends the buffer text line being iterated.
2450      This is normally the position after the newline at EOL.  If this
2451      is the last line of the buffer and it doesn't have a newline,
2452      value is ZV/ZV_BYTE.  Set and used only if IT->bidi_p, for
2453      setting the end position of glyph rows produced for continuation
2454      lines, see display_line.  */
2455   struct text_pos eol_pos;
2456
2457   /* Current y-position.  Automatically incremented by the height of
2458      glyph_row in move_it_to and display_line.  */
2459   int current_y;
2460
2461   /* Vertical matrix position of first text line in window.  */
2462   int first_vpos;
2463
2464   /* Current vertical matrix position, or line number.  Automatically
2465      incremented by move_it_to and display_line.  */
2466   int vpos;
2467
2468   /* Horizontal matrix position reached in move_it_in_display_line.
2469      Only set there, not in display_line.  */
2470   int hpos;
2471
2472   /* Left fringe bitmap number (enum fringe_bitmap_type).  */
2473   unsigned left_user_fringe_bitmap : FRINGE_ID_BITS;
2474
2475   /* Right fringe bitmap number (enum fringe_bitmap_type).  */
2476   unsigned right_user_fringe_bitmap : FRINGE_ID_BITS;
2477
2478   /* Face of the left fringe glyph.  */
2479   unsigned left_user_fringe_face_id : FACE_ID_BITS;
2480
2481   /* Face of the right fringe glyph.  */
2482   unsigned right_user_fringe_face_id : FACE_ID_BITS;
2483
2484   /* Non-zero means we need to reorder bidirectional text for display
2485      in the visual order.  */
2486   unsigned bidi_p : 1;
2487
2488   /* For iterating over bidirectional text.  */
2489   struct bidi_it bidi_it;
2490   bidi_dir_t paragraph_embedding;
2491 };
2492
2493
2494 /* Access to positions of iterator IT.  */
2495
2496 #define IT_CHARPOS(IT)          CHARPOS ((IT).current.pos)
2497 #define IT_BYTEPOS(IT)          BYTEPOS ((IT).current.pos)
2498 #define IT_STRING_CHARPOS(IT)   CHARPOS ((IT).current.string_pos)
2499 #define IT_STRING_BYTEPOS(IT)   BYTEPOS ((IT).current.string_pos)
2500
2501 /* Test if IT has reached the end of its buffer or string.  This will
2502    only work after get_next_display_element has been called.  */
2503
2504 #define ITERATOR_AT_END_P(IT) ((IT)->what == IT_EOB)
2505
2506 /* Non-zero means IT is at the end of a line.  This is the case if it
2507    is either on a newline or on a carriage return and selective
2508    display hides the rest of the line.  */
2509
2510 #define ITERATOR_AT_END_OF_LINE_P(IT)                   \
2511      ((IT)->what == IT_CHARACTER                        \
2512       && ((IT)->c == '\n'                               \
2513           || ((IT)->c == '\r' && (IT)->selective)))
2514
2515 /* Call produce_glyphs or FRAME_RIF->produce_glyphs, if set.  Shortcut
2516    to avoid the function call overhead.  */
2517
2518 #define PRODUCE_GLYPHS(IT)                              \
2519   do {                                                  \
2520     if ((IT)->glyph_row != NULL && (IT)->bidi_p)        \
2521       {                                                 \
2522         if ((IT)->bidi_it.paragraph_dir == R2L)         \
2523           (IT)->glyph_row->reversed_p = 1;              \
2524         else                                            \
2525           (IT)->glyph_row->reversed_p = 0;              \
2526       }                                                 \
2527     if (FRAME_RIF ((IT)->f) != NULL)                    \
2528       FRAME_RIF ((IT)->f)->produce_glyphs ((IT));       \
2529     else                                                \
2530       produce_glyphs ((IT));                            \
2531     if ((IT)->glyph_row != NULL)                        \
2532       inhibit_free_realized_faces = 1;                  \
2533   } while (0)
2534
2535 /* Bit-flags indicating what operation move_it_to should perform.  */
2536
2537 enum move_operation_enum
2538 {
2539   /* Stop if specified x-position is reached.  */
2540   MOVE_TO_X = 0x01,
2541
2542   /* Stop if specified y-position is reached.  */
2543   MOVE_TO_Y = 0x02,
2544
2545   /* Stop if specified vpos is reached.  */
2546   MOVE_TO_VPOS = 0x04,
2547
2548   /* Stop if specified buffer or string position is reached.  */
2549   MOVE_TO_POS = 0x08
2550 };
2551
2552
2553 \f
2554 /***********************************************************************
2555                    Window-based redisplay interface
2556  ***********************************************************************/
2557
2558 /* Structure used to describe runs of lines that must be scrolled.  */
2559
2560 struct run
2561 {
2562   /* Source and destination y pixel position.  */
2563   int desired_y, current_y;
2564
2565   /* Source and destination vpos in matrix.  */
2566   int desired_vpos, current_vpos;
2567
2568   /* Height in pixels, number of glyph rows.  */
2569   int height, nrows;
2570 };
2571
2572
2573 /* Handlers for setting frame parameters.  */
2574
2575 typedef void (*frame_parm_handler) (struct frame *, Lisp_Object, Lisp_Object);
2576
2577
2578 /* Structure holding system-dependent interface functions needed
2579    for window-based redisplay.  */
2580
2581 struct redisplay_interface
2582 {
2583   /* Handlers for setting frame parameters.  */
2584   frame_parm_handler *frame_parm_handlers;
2585
2586   /* Produce glyphs/get display metrics for the display element IT is
2587      loaded with.  */
2588   void (*produce_glyphs) (struct it *it);
2589
2590   /* Write or insert LEN glyphs from STRING at the nominal output
2591      position.  */
2592   void (*write_glyphs) (struct glyph *string, int len);
2593   void (*insert_glyphs) (struct glyph *start, int len);
2594
2595   /* Clear from nominal output position to X.  X < 0 means clear
2596      to right end of display.  */
2597   void (*clear_end_of_line) (int x);
2598
2599   /* Function to call to scroll the display as described by RUN on
2600      window W.  */
2601   void (*scroll_run_hook) (struct window *w, struct run *run);
2602
2603   /* Function to call after a line in a display has been completely
2604      updated.  Used to draw truncation marks and alike.  DESIRED_ROW
2605      is the desired row which has been updated.  */
2606   void (*after_update_window_line_hook) (struct glyph_row *desired_row);
2607
2608   /* Function to call before beginning to update window W in
2609      window-based redisplay.  */
2610   void (*update_window_begin_hook) (struct window *w);
2611
2612   /* Function to call after window W has been updated in window-based
2613      redisplay.  CURSOR_ON_P non-zero means switch cursor on.
2614      MOUSE_FACE_OVERWRITTEN_P non-zero means that some lines in W
2615      that contained glyphs in mouse-face were overwritten, so we
2616      have to update the mouse highlight.  */
2617   void (*update_window_end_hook) (struct window *w, int cursor_on_p,
2618                                   int mouse_face_overwritten_p);
2619
2620   /* Move cursor to row/column position VPOS/HPOS, pixel coordinates
2621      Y/X. HPOS/VPOS are window-relative row and column numbers and X/Y
2622      are window-relative pixel positions.  */
2623   void (*cursor_to) (int vpos, int hpos, int y, int x);
2624
2625   /* Flush the display of frame F.  For X, this is XFlush.  */
2626   void (*flush_display) (struct frame *f);
2627
2628   /* Flush the display of frame F if non-NULL.  This is called
2629      during redisplay, and should be NULL on systems which flushes
2630      automatically before reading input.  */
2631   void (*flush_display_optional) (struct frame *f);
2632
2633   /* Clear the mouse hightlight in window W, if there is any.  */
2634   void (*clear_window_mouse_face) (struct window *w);
2635
2636   /* Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
2637      frame F.  */
2638   void (*get_glyph_overhangs) (struct glyph *glyph, struct frame *f,
2639                                int *left, int *right);
2640
2641   /* Fix the display of AREA of ROW in window W for overlapping rows.
2642      This function is called from redraw_overlapping_rows after
2643      desired rows have been made current.  */
2644   void (*fix_overlapping_area) (struct window *w, struct glyph_row *row,
2645                                 enum glyph_row_area area, int);
2646
2647 #ifdef HAVE_WINDOW_SYSTEM
2648
2649   /* Draw a fringe bitmap in window W of row ROW using parameters P.  */
2650   void (*draw_fringe_bitmap) (struct window *w, struct glyph_row *row,
2651                               struct draw_fringe_bitmap_params *p);
2652
2653   /* Define and destroy fringe bitmap no. WHICH.  */
2654   void (*define_fringe_bitmap) (int which, unsigned short *bits,
2655                                 int h, int wd);
2656   void (*destroy_fringe_bitmap) (int which);
2657
2658 /* Compute left and right overhang of glyph string S.
2659    A NULL pointer if platform does not support this. */
2660   void (*compute_glyph_string_overhangs) (struct glyph_string *s);
2661
2662 /* Draw a glyph string S.  */
2663   void (*draw_glyph_string) (struct glyph_string *s);
2664
2665 /* Define cursor CURSOR on frame F.  */
2666   void (*define_frame_cursor) (struct frame *f, Cursor cursor);
2667
2668 /* Clear the area at (X,Y,WIDTH,HEIGHT) of frame F.  */
2669   void (*clear_frame_area) (struct frame *f, int x, int y,
2670                             int width, int height);
2671
2672 /* Draw specified cursor CURSOR_TYPE of width CURSOR_WIDTH
2673    at row GLYPH_ROW on window W if ON_P is 1.  If ON_P is
2674    0, don't draw cursor.  If ACTIVE_P is 1, system caret
2675    should track this cursor (when applicable).  */
2676   void (*draw_window_cursor) (struct window *w,
2677                               struct glyph_row *glyph_row,
2678                               int x, int y,
2679                               int cursor_type, int cursor_width,
2680                               int on_p, int active_p);
2681
2682 /* Draw vertical border for window W from (X,Y_0) to (X,Y_1).  */
2683   void (*draw_vertical_window_border) (struct window *w,
2684                                        int x, int y_0, int y_1);
2685
2686 /* Shift display of frame F to make room for inserted glyphs.
2687    The area at pixel (X,Y) of width WIDTH and height HEIGHT is
2688    shifted right by SHIFT_BY pixels.  */
2689   void (*shift_glyphs_for_insert) (struct frame *f,
2690                                    int x, int y, int width,
2691                                    int height, int shift_by);
2692
2693 #endif /* HAVE_WINDOW_SYSTEM */
2694 };
2695
2696 \f
2697 /***********************************************************************
2698                                 Images
2699  ***********************************************************************/
2700
2701 #ifdef HAVE_WINDOW_SYSTEM
2702
2703 /* Structure forward declarations.  */
2704
2705 struct image;
2706
2707
2708 /* Each image format (JPEG, TIFF, ...) supported is described by
2709    a structure of the type below.  */
2710
2711 struct image_type
2712 {
2713   /* A symbol uniquely identifying the image type, .e.g `jpeg'.  */
2714   Lisp_Object *type;
2715
2716   /* Check that SPEC is a valid image specification for the given
2717      image type.  Value is non-zero if SPEC is valid.  */
2718   int (* valid_p) (Lisp_Object spec);
2719
2720   /* Load IMG which is used on frame F from information contained in
2721      IMG->spec.  Value is non-zero if successful.  */
2722   int (* load) (struct frame *f, struct image *img);
2723
2724   /* Free resources of image IMG which is used on frame F.  */
2725   void (* free) (struct frame *f, struct image *img);
2726
2727   /* Next in list of all supported image types.  */
2728   struct image_type *next;
2729 };
2730
2731
2732 /* Structure describing an image.  Specific image formats like XBM are
2733    converted into this form, so that display only has to deal with
2734    this type of image.  */
2735
2736 struct image
2737 {
2738   /* The time in seconds at which the image was last displayed.  Set
2739      in prepare_image_for_display.  */
2740   unsigned long timestamp;
2741
2742   /* Pixmaps of the image.  */
2743   Pixmap pixmap, mask;
2744
2745   /* Colors allocated for this image, if any.  Allocated via xmalloc.  */
2746   unsigned long *colors;
2747   int ncolors;
2748
2749   /* A single `background color' for this image, for the use of anyone that
2750      cares about such a thing.  Only valid if the `background_valid' field
2751      is true.  This should generally be accessed by calling the accessor
2752      macro `IMAGE_BACKGROUND', which will heuristically calculate a value
2753      if necessary.  */
2754   unsigned long background;
2755
2756   /* Foreground and background colors of the frame on which the image
2757      is created.  */
2758   unsigned long frame_foreground, frame_background;
2759
2760   /* True if this image has a `transparent' background -- that is, is
2761      uses an image mask.  The accessor macro for this is
2762      `IMAGE_BACKGROUND_TRANSPARENT'.  */
2763   unsigned background_transparent : 1;
2764
2765   /* True if the `background' and `background_transparent' fields are
2766      valid, respectively. */
2767   unsigned background_valid : 1, background_transparent_valid : 1;
2768
2769   /* Width and height of the image.  */
2770   int width, height;
2771
2772   /* These values are used for the rectangles displayed for images
2773      that can't be loaded.  */
2774 #define DEFAULT_IMAGE_WIDTH 30
2775 #define DEFAULT_IMAGE_HEIGHT 30
2776
2777   /* Top/left and bottom/right corner pixel of actual image data.
2778      Used by four_corners_best to consider the real image data,
2779      rather than looking at the optional image margin.  */
2780   int corners[4];
2781 #define TOP_CORNER 0
2782 #define LEFT_CORNER 1
2783 #define BOT_CORNER 2
2784 #define RIGHT_CORNER 3
2785
2786   /* Percent of image height used as ascent.  A value of
2787      CENTERED_IMAGE_ASCENT means draw the image centered on the
2788      line.  */
2789   int ascent;
2790 #define DEFAULT_IMAGE_ASCENT 50
2791 #define CENTERED_IMAGE_ASCENT -1
2792
2793   /* Lisp specification of this image.  */
2794   Lisp_Object spec;
2795
2796   /* List of "references" followed to build the image.
2797      Typically will just contain the name of the image file.
2798      Used to allow fine-grained cache flushing.  */
2799   Lisp_Object dependencies;
2800
2801   /* Relief to draw around the image.  */
2802   int relief;
2803
2804   /* Optional margins around the image.  This includes the relief.  */
2805   int hmargin, vmargin;
2806
2807   /* Reference to the type of the image.  */
2808   struct image_type *type;
2809
2810   /* 1 means that loading the image failed.  Don't try again.  */
2811   unsigned load_failed_p;
2812
2813   /* A place for image types to store additional data.  The member
2814      data.lisp_val is marked during GC, so it's safe to store Lisp data
2815      there.  Image types should free this data when their `free'
2816      function is called.  */
2817   struct
2818   {
2819     int int_val;
2820     void *ptr_val;
2821     Lisp_Object lisp_val;
2822   } data;
2823
2824   /* Hash value of image specification to speed up comparisons.  */
2825   unsigned hash;
2826
2827   /* Image id of this image.  */
2828   int id;
2829
2830   /* Hash collision chain.  */
2831   struct image *next, *prev;
2832 };
2833
2834
2835 /* Cache of images.  Each frame has a cache.  X frames with the same
2836    x_display_info share their caches.  */
2837
2838 struct image_cache
2839 {
2840   /* Hash table of images.  */
2841   struct image **buckets;
2842
2843   /* Vector mapping image ids to images.  */
2844   struct image **images;
2845
2846   /* Allocated size of `images'.  */
2847   unsigned size;
2848
2849   /* Number of images in the cache.  */
2850   unsigned used;
2851
2852   /* Reference count (number of frames sharing this cache).  */
2853   int refcount;
2854 };
2855
2856
2857 /* Value is a pointer to the image with id ID on frame F, or null if
2858    no image with that id exists.  */
2859
2860 #define IMAGE_FROM_ID(F, ID)                                    \
2861      (((ID) >= 0 && (ID) < (FRAME_IMAGE_CACHE (F)->used))       \
2862       ? FRAME_IMAGE_CACHE (F)->images[ID]                       \
2863       : NULL)
2864
2865 /* Size of bucket vector of image caches.  Should be prime.  */
2866
2867 #define IMAGE_CACHE_BUCKETS_SIZE 1001
2868
2869 #endif /* HAVE_WINDOW_SYSTEM */
2870
2871
2872 \f
2873 /***********************************************************************
2874                                Tool-bars
2875  ***********************************************************************/
2876
2877 /* Enumeration defining where to find tool-bar item information in
2878    tool-bar items vectors stored with frames.  Each tool-bar item
2879    occupies TOOL_BAR_ITEM_NSLOTS elements in such a vector.  */
2880
2881 enum tool_bar_item_idx
2882 {
2883   /* The key of the tool-bar item.  Used to remove items when a binding
2884      for `undefined' is found.  */
2885   TOOL_BAR_ITEM_KEY,
2886
2887   /* Non-nil if item is enabled.  */
2888   TOOL_BAR_ITEM_ENABLED_P,
2889
2890   /* Non-nil if item is selected (pressed).  */
2891   TOOL_BAR_ITEM_SELECTED_P,
2892
2893   /* Caption.  */
2894   TOOL_BAR_ITEM_CAPTION,
2895
2896   /* Image(s) to display.  This is either a single image specification
2897      or a vector of specifications.  */
2898   TOOL_BAR_ITEM_IMAGES,
2899
2900   /* The binding.  */
2901   TOOL_BAR_ITEM_BINDING,
2902
2903   /* Button type.  One of nil (default button), t (a separator),
2904      `:radio', or `:toggle'.  The latter two currently do nothing.  */
2905   TOOL_BAR_ITEM_TYPE,
2906
2907   /* Help string.  */
2908   TOOL_BAR_ITEM_HELP,
2909
2910   /* Icon file name of right to left image when an RTL locale is used.  */
2911   TOOL_BAR_ITEM_RTL_IMAGE,
2912
2913   /* Label to show when text labels are enabled.  */
2914   TOOL_BAR_ITEM_LABEL,
2915
2916   /* If we shall show the label only below the icon and not beside it.  */
2917   TOOL_BAR_ITEM_VERT_ONLY,
2918
2919   /* Sentinel = number of slots in tool_bar_items occupied by one
2920      tool-bar item.  */
2921   TOOL_BAR_ITEM_NSLOTS
2922 };
2923
2924
2925 /* An enumeration for the different images that can be specified
2926    for a tool-bar item.  */
2927
2928 enum tool_bar_item_image
2929 {
2930   TOOL_BAR_IMAGE_ENABLED_SELECTED,
2931   TOOL_BAR_IMAGE_ENABLED_DESELECTED,
2932   TOOL_BAR_IMAGE_DISABLED_SELECTED,
2933   TOOL_BAR_IMAGE_DISABLED_DESELECTED
2934 };
2935
2936 #define DEFAULT_TOOL_BAR_LABEL_SIZE 14
2937
2938 /* Default values of the above variables.  */
2939
2940 #define DEFAULT_TOOL_BAR_BUTTON_MARGIN 4
2941 #define DEFAULT_TOOL_BAR_BUTTON_RELIEF 1
2942
2943 /* The height in pixels of the default tool-bar images.  */
2944
2945 #define DEFAULT_TOOL_BAR_IMAGE_HEIGHT 24
2946
2947 \f
2948 /***********************************************************************
2949                          Terminal Capabilities
2950  ***********************************************************************/
2951
2952 /* Each of these is a bit representing a terminal `capability' (bold,
2953    inverse, etc).  They are or'd together to specify the set of
2954    capabilities being queried for when calling `tty_capable_p' (which
2955    returns true if the terminal supports all of them).  */
2956
2957 #define TTY_CAP_INVERSE         0x01
2958 #define TTY_CAP_UNDERLINE       0x02
2959 #define TTY_CAP_BOLD            0x04
2960 #define TTY_CAP_DIM             0x08
2961 #define TTY_CAP_BLINK           0x10
2962 #define TTY_CAP_ALT_CHARSET     0x20
2963
2964 \f
2965 /***********************************************************************
2966                           Function Prototypes
2967  ***********************************************************************/
2968
2969 /* Defined in bidi.c */
2970
2971 extern void bidi_init_it (EMACS_INT, EMACS_INT, int, struct bidi_it *);
2972 extern void bidi_move_to_visually_next (struct bidi_it *);
2973 extern void bidi_paragraph_init (bidi_dir_t, struct bidi_it *, int);
2974 extern int  bidi_mirror_char (int);
2975 extern void bidi_push_it (struct bidi_it *);
2976 extern void bidi_pop_it (struct bidi_it *);
2977 extern void *bidi_shelve_cache (void);
2978 extern void bidi_unshelve_cache (void *);
2979
2980 /* Defined in xdisp.c */
2981
2982 struct glyph_row *row_containing_pos (struct window *, EMACS_INT,
2983                                       struct glyph_row *,
2984                                       struct glyph_row *, int);
2985 int line_bottom_y (struct it *);
2986 int display_prop_intangible_p (Lisp_Object, Lisp_Object, EMACS_INT, EMACS_INT);
2987 void resize_echo_area_exactly (void);
2988 int resize_mini_window (struct window *, int);
2989 #if defined USE_TOOLKIT_SCROLL_BARS && !defined USE_GTK
2990 void set_vertical_scroll_bar (struct window *);
2991 #endif
2992 int try_window (Lisp_Object, struct text_pos, int);
2993 void window_box (struct window *, int, int *, int *, int *, int *);
2994 int window_box_height (struct window *);
2995 int window_text_bottom_y (struct window *);
2996 int window_box_width (struct window *, int);
2997 int window_box_left (struct window *, int);
2998 int window_box_left_offset (struct window *, int);
2999 int window_box_right (struct window *, int);
3000 int window_box_right_offset (struct window *, int);
3001 int estimate_mode_line_height (struct frame *, enum face_id);
3002 void pixel_to_glyph_coords (struct frame *, int, int, int *, int *,
3003                             NativeRectangle *, int);
3004 void remember_mouse_glyph (struct frame *, int, int, NativeRectangle *);
3005
3006 void mark_window_display_accurate (Lisp_Object, int);
3007 void redisplay_preserve_echo_area (int);
3008 void init_iterator (struct it *, struct window *, EMACS_INT,
3009                     EMACS_INT, struct glyph_row *, enum face_id);
3010 void init_iterator_to_row_start (struct it *, struct window *,
3011                                  struct glyph_row *);
3012 void start_display (struct it *, struct window *, struct text_pos);
3013 void move_it_to (struct it *, EMACS_INT, int, int, int, int);
3014 void move_it_vertically (struct it *, int);
3015 void move_it_vertically_backward (struct it *, int);
3016 void move_it_by_lines (struct it *, int);
3017 void move_it_past_eol (struct it *);
3018 void move_it_in_display_line (struct it *it,
3019                               EMACS_INT to_charpos, int to_x,
3020                               enum move_operation_enum op);
3021 int in_display_vector_p (struct it *);
3022 int frame_mode_line_height (struct frame *);
3023 extern Lisp_Object Qtool_bar;
3024 extern int redisplaying_p;
3025 extern int help_echo_showing_p;
3026 extern int current_mode_line_height, current_header_line_height;
3027 extern Lisp_Object help_echo_string, help_echo_window;
3028 extern Lisp_Object help_echo_object, previous_help_echo_string;
3029 extern EMACS_INT help_echo_pos;
3030 extern struct frame *last_mouse_frame;
3031 extern int last_tool_bar_item;
3032 extern void reseat_at_previous_visible_line_start (struct it *);
3033 extern Lisp_Object lookup_glyphless_char_display (int, struct it *);
3034 extern int calc_pixel_width_or_height (double *, struct it *, Lisp_Object,
3035                                        struct font *, int, int *);
3036 extern EMACS_INT compute_display_string_pos (struct text_pos *,
3037                                              struct bidi_string_data *, int);
3038 extern EMACS_INT compute_display_string_end (EMACS_INT,
3039                                              struct bidi_string_data *);
3040
3041 #ifdef HAVE_WINDOW_SYSTEM
3042
3043 #if GLYPH_DEBUG
3044 extern void dump_glyph_string (struct glyph_string *);
3045 #endif
3046
3047 extern void x_get_glyph_overhangs (struct glyph *, struct frame *,
3048                                    int *, int *);
3049 extern void x_produce_glyphs (struct it *);
3050
3051 extern void x_write_glyphs (struct glyph *, int);
3052 extern void x_insert_glyphs (struct glyph *, int len);
3053 extern void x_clear_end_of_line (int);
3054
3055 extern struct cursor_pos output_cursor;
3056
3057 extern void x_fix_overlapping_area (struct window *, struct glyph_row *,
3058                                     enum glyph_row_area, int);
3059 extern void draw_phys_cursor_glyph (struct window *,
3060                                     struct glyph_row *,
3061                                     enum draw_glyphs_face);
3062 extern void get_phys_cursor_geometry (struct window *, struct glyph_row *,
3063                                       struct glyph *, int *, int *, int *);
3064 extern void erase_phys_cursor (struct window *);
3065 extern void display_and_set_cursor (struct window *,
3066                                     int, int, int, int, int);
3067
3068 extern void set_output_cursor (struct cursor_pos *);
3069 extern void x_cursor_to (int, int, int, int);
3070
3071 extern void x_update_cursor (struct frame *, int);
3072 extern void x_clear_cursor (struct window *);
3073 extern void x_draw_vertical_border (struct window *w);
3074
3075 extern int get_glyph_string_clip_rects (struct glyph_string *,
3076                                         NativeRectangle *, int);
3077 extern void get_glyph_string_clip_rect (struct glyph_string *,
3078                                         NativeRectangle *nr);
3079 extern Lisp_Object find_hot_spot (Lisp_Object, int, int);
3080
3081 extern void handle_tool_bar_click (struct frame *,
3082                                    int, int, int, unsigned int);
3083
3084 extern void expose_frame (struct frame *, int, int, int, int);
3085 extern int x_intersect_rectangles (XRectangle *, XRectangle *,
3086                                    XRectangle *);
3087 #endif  /* HAVE_WINDOW_SYSTEM */
3088
3089 extern void note_mouse_highlight (struct frame *, int, int);
3090 extern void x_clear_window_mouse_face (struct window *);
3091 extern void cancel_mouse_face (struct frame *);
3092 extern int clear_mouse_face (Mouse_HLInfo *);
3093 extern int cursor_in_mouse_face_p (struct window *w);
3094 extern void tty_draw_row_with_mouse_face (struct window *, struct glyph_row *,
3095                                           int, int, enum draw_glyphs_face);
3096
3097 /* Flags passed to try_window.  */
3098 #define TRY_WINDOW_CHECK_MARGINS        (1 << 0)
3099 #define TRY_WINDOW_IGNORE_FONTS_CHANGE  (1 << 1)
3100
3101 int lookup_fringe_bitmap (Lisp_Object);
3102 void draw_fringe_bitmap (struct window *, struct glyph_row *, int);
3103 void draw_row_fringe_bitmaps (struct window *, struct glyph_row *);
3104 int draw_window_fringes (struct window *, int);
3105 int update_window_fringes (struct window *, int);
3106 void compute_fringe_widths (struct frame *, int);
3107
3108 #ifdef WINDOWSNT
3109 void w32_init_fringe (struct redisplay_interface *);
3110 void w32_reset_fringes (void);
3111 #endif
3112 /* Defined in image.c */
3113
3114 #ifdef HAVE_WINDOW_SYSTEM
3115
3116 extern int x_bitmap_height (struct frame *, int);
3117 extern int x_bitmap_width (struct frame *, int);
3118 extern int x_bitmap_pixmap (struct frame *, int);
3119 extern void x_reference_bitmap (struct frame *, int);
3120 extern int x_create_bitmap_from_data (struct frame *, char *,
3121                                       unsigned int, unsigned int);
3122 extern int x_create_bitmap_from_file (struct frame *, Lisp_Object);
3123 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3124 extern int x_create_bitmap_from_xpm_data (struct frame *f, const char **bits);
3125 #endif
3126 #ifndef x_destroy_bitmap
3127 extern void x_destroy_bitmap (struct frame *, int);
3128 #endif
3129 extern void x_destroy_all_bitmaps (Display_Info *);
3130 extern int x_create_bitmap_mask (struct frame * , int);
3131 extern Lisp_Object x_find_image_file (Lisp_Object);
3132
3133 void x_kill_gs_process (Pixmap, struct frame *);
3134 struct image_cache *make_image_cache (void);
3135 void free_image_cache (struct frame *);
3136 void clear_image_caches (Lisp_Object);
3137 void mark_image_cache (struct image_cache *);
3138 int valid_image_p (Lisp_Object);
3139 void prepare_image_for_display (struct frame *, struct image *);
3140 int lookup_image (struct frame *, Lisp_Object);
3141
3142 unsigned long image_background (struct image *, struct frame *,
3143                                 XImagePtr_or_DC ximg);
3144 int image_background_transparent (struct image *, struct frame *,
3145                                   XImagePtr_or_DC mask);
3146
3147 int image_ascent (struct image *, struct face *, struct glyph_slice *);
3148
3149 #endif
3150
3151 /* Defined in sysdep.c */
3152
3153 void get_tty_size (int, int *, int *);
3154 void request_sigio (void);
3155 void unrequest_sigio (void);
3156 int tabs_safe_p (int);
3157 void init_baud_rate (int);
3158 void init_sigio (int);
3159
3160 /* Defined in xfaces.c */
3161
3162 #ifdef HAVE_X_WINDOWS
3163 void x_free_colors (struct frame *, unsigned long *, int);
3164 #endif
3165
3166 void update_face_from_frame_parameter (struct frame *, Lisp_Object,
3167                                        Lisp_Object);
3168 Lisp_Object tty_color_name (struct frame *, int);
3169 void clear_face_cache (int);
3170 unsigned long load_color (struct frame *, struct face *, Lisp_Object,
3171                           enum lface_attribute_index);
3172 void unload_color (struct frame *, unsigned long);
3173 char *choose_face_font (struct frame *, Lisp_Object *, Lisp_Object,
3174                         int *);
3175 void prepare_face_for_display (struct frame *, struct face *);
3176 int xstrcasecmp (const char *, const char *);
3177 int lookup_named_face (struct frame *, Lisp_Object, int);
3178 int lookup_basic_face (struct frame *, int);
3179 int smaller_face (struct frame *, int, int);
3180 int face_with_height (struct frame *, int, int);
3181 int lookup_derived_face (struct frame *, Lisp_Object, int, int);
3182 void init_frame_faces (struct frame *);
3183 void free_frame_faces (struct frame *);
3184 void recompute_basic_faces (struct frame *);
3185 int face_at_buffer_position (struct window *w, EMACS_INT pos,
3186                              EMACS_INT region_beg, EMACS_INT region_end,
3187                              EMACS_INT *endptr, EMACS_INT limit,
3188                              int mouse, int base_face_id);
3189 int face_for_overlay_string (struct window *w, EMACS_INT pos,
3190                              EMACS_INT region_beg, EMACS_INT region_end,
3191                              EMACS_INT *endptr, EMACS_INT limit,
3192                              int mouse, Lisp_Object overlay);
3193 int face_at_string_position (struct window *w, Lisp_Object string,
3194                              EMACS_INT pos, EMACS_INT bufpos,
3195                              EMACS_INT region_beg, EMACS_INT region_end,
3196                              EMACS_INT *endptr, enum face_id, int mouse);
3197 int merge_faces (struct frame *, Lisp_Object, int, int);
3198 int compute_char_face (struct frame *, int, Lisp_Object);
3199 void free_all_realized_faces (Lisp_Object);
3200 extern Lisp_Object Qforeground_color, Qbackground_color;
3201 extern Lisp_Object Qframe_set_background_mode;
3202 extern char unspecified_fg[], unspecified_bg[];
3203
3204 /* Defined in xfns.c  */
3205
3206 #ifdef HAVE_X_WINDOWS
3207 void gamma_correct (struct frame *, XColor *);
3208 #endif
3209 #ifdef WINDOWSNT
3210 void gamma_correct (struct frame *, COLORREF *);
3211 #endif
3212
3213 #ifdef HAVE_WINDOW_SYSTEM
3214
3215 void x_implicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
3216
3217 extern Lisp_Object tip_frame;
3218 extern Window tip_window;
3219 EXFUN (Fx_hide_tip, 0);
3220 extern void start_hourglass (void);
3221 extern void cancel_hourglass (void);
3222 extern int hourglass_started (void);
3223 extern int hourglass_shown_p;
3224 struct atimer;                  /* Defined in atimer.h.  */
3225 /* If non-null, an asynchronous timer that, when it expires, displays
3226    an hourglass cursor on all frames.  */
3227 extern struct atimer *hourglass_atimer;
3228
3229 /* Each GUI implements these.  FIXME: move into RIF. */
3230 extern void show_hourglass (struct atimer *);
3231 extern void hide_hourglass (void);
3232
3233 /* Returns the background color of IMG, calculating one heuristically if
3234    necessary.  If non-zero, XIMG is an existing XImage object to use for
3235    the heuristic.  */
3236
3237 #define IMAGE_BACKGROUND(img, f, ximg)                                        \
3238    ((img)->background_valid                                                   \
3239     ? (img)->background                                                       \
3240     : image_background (img, f, ximg))
3241
3242 /* Returns true if IMG has a `transparent' background, using heuristics
3243    to decide if necessary.  If non-zero, MASK is an existing XImage
3244    object to use for the heuristic.  */
3245
3246 #define IMAGE_BACKGROUND_TRANSPARENT(img, f, mask)                            \
3247    ((img)->background_transparent_valid                                       \
3248     ? (img)->background_transparent                                           \
3249     : image_background_transparent (img, f, mask))
3250
3251 #endif /* HAVE_WINDOW_SYSTEM */
3252
3253
3254 /* Defined in xmenu.c  */
3255
3256 int popup_activated (void);
3257
3258 extern Lisp_Object buffer_posn_from_coords (struct window *,
3259                                             int *, int *,
3260                                             struct display_pos *,
3261                                             Lisp_Object *,
3262                                             int *, int *, int *, int *);
3263 extern Lisp_Object mode_line_string (struct window *, enum window_part,
3264                                      int *, int *, EMACS_INT *,
3265                                      Lisp_Object *,
3266                                      int *, int *, int *, int *);
3267 extern Lisp_Object marginal_area_string (struct window *, enum window_part,
3268                                          int *, int *, EMACS_INT *,
3269                                          Lisp_Object *,
3270                                          int *, int *, int *, int *);
3271 extern void redraw_frame (struct frame *);
3272 extern void cancel_line (int, struct frame *);
3273 extern void init_desired_glyphs (struct frame *);
3274 extern int update_frame (struct frame *, int, int);
3275 extern void bitch_at_user (void);
3276 void adjust_glyphs (struct frame *);
3277 void free_glyphs (struct frame *);
3278 void free_window_matrices (struct window *);
3279 void check_glyph_memory (void);
3280 void mirrored_line_dance (struct glyph_matrix *, int, int, int *, char *);
3281 void clear_glyph_matrix (struct glyph_matrix *);
3282 void clear_current_matrices (struct frame *f);
3283 void clear_desired_matrices (struct frame *);
3284 void shift_glyph_matrix (struct window *, struct glyph_matrix *,
3285                          int, int, int);
3286 void rotate_matrix (struct glyph_matrix *, int, int, int);
3287 void increment_matrix_positions (struct glyph_matrix *,
3288                                  int, int, EMACS_INT, EMACS_INT);
3289 void blank_row (struct window *, struct glyph_row *, int);
3290 void enable_glyph_matrix_rows (struct glyph_matrix *, int, int, int);
3291 void clear_glyph_row (struct glyph_row *);
3292 void prepare_desired_row (struct glyph_row *);
3293 void set_window_update_flags (struct window *, int);
3294 void update_single_window (struct window *, int);
3295 void do_pending_window_change (int);
3296 void change_frame_size (struct frame *, int, int, int, int, int);
3297 void init_display (void);
3298 void syms_of_display (void);
3299 extern Lisp_Object Qredisplay_dont_pause;
3300 void spec_glyph_lookup_face (struct window *, GLYPH *);
3301
3302 /* Defined in terminal.c */
3303
3304 extern void ring_bell (struct frame *);
3305 extern void update_begin (struct frame *);
3306 extern void update_end (struct frame *);
3307 extern void set_terminal_window (struct frame *, int);
3308 extern void cursor_to (struct frame *, int, int);
3309 extern void raw_cursor_to (struct frame *, int, int);
3310 extern void clear_to_end (struct frame *);
3311 extern void clear_frame (struct frame *);
3312 extern void clear_end_of_line (struct frame *, int);
3313 extern void write_glyphs (struct frame *, struct glyph *, int);
3314 extern void insert_glyphs (struct frame *, struct glyph *, int);
3315 extern void delete_glyphs (struct frame *, int);
3316 extern void ins_del_lines (struct frame *, int, int);
3317
3318 extern struct terminal *init_initial_terminal (void);
3319
3320
3321 /* Defined in term.c */
3322
3323 extern void tty_turn_off_insert (struct tty_display_info *);
3324 extern int string_cost (const char *);
3325 extern int per_line_cost (const char *);
3326 extern void calculate_costs (struct frame *);
3327 extern void produce_glyphs (struct it *);
3328 extern void produce_special_glyphs (struct it *, enum display_element_type);
3329 extern int tty_capable_p (struct tty_display_info *, unsigned, unsigned long, unsigned long);
3330 extern void set_tty_color_mode (struct tty_display_info *, struct frame *);
3331 extern struct terminal *get_named_tty (const char *);
3332 EXFUN (Ftty_type, 1);
3333 extern void create_tty_output (struct frame *);
3334 extern struct terminal *init_tty (const char *, const char *, int);
3335
3336
3337 /* Defined in scroll.c */
3338
3339 extern int scrolling_max_lines_saved (int, int, int *, int *, int *);
3340 extern void do_line_insertion_deletion_costs (struct frame *, const char *,
3341                                               const char *, const char *,
3342                                               const char *, const char *,
3343                                               const char *, int);
3344 void scrolling_1 (struct frame *, int, int, int, int *, int *, int *,
3345                   int *, int);
3346
3347 /* Defined in frame.c */
3348
3349 #ifdef HAVE_WINDOW_SYSTEM
3350
3351 /* Types we might convert a resource string into.  */
3352 enum resource_types
3353 {
3354   RES_TYPE_NUMBER,
3355   RES_TYPE_FLOAT,
3356   RES_TYPE_BOOLEAN,
3357   RES_TYPE_STRING,
3358   RES_TYPE_SYMBOL,
3359   RES_TYPE_BOOLEAN_NUMBER
3360 };
3361
3362 extern Lisp_Object x_get_arg (Display_Info *, Lisp_Object,
3363                               Lisp_Object, const char *, const char *class,
3364                               enum resource_types);
3365 extern Lisp_Object x_frame_get_and_record_arg (struct frame *, Lisp_Object,
3366                                                Lisp_Object,
3367                                                const char *, const char *,
3368                                                enum resource_types);
3369 extern Lisp_Object x_default_parameter (struct frame *, Lisp_Object,
3370                                         Lisp_Object, Lisp_Object,
3371                                         const char *, const char *,
3372                                         enum resource_types);
3373
3374 #endif /* HAVE_WINDOW_SYSTEM */
3375
3376 #endif /* not DISPEXTERN_H_INCLUDED */