src/redisplay.h

   1 /* Redisplay data structures.
   2    Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
   3    Copyright (C) 1996 Chuck Thompson.
   4    Copyright (C) 1995, 1996 Ben Wing.
   5
   6 This file is part of XEmacs.
   7
   8 XEmacs is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU General Public License as published by the
  10 Free Software Foundation; either version 2, or (at your option) any
  11 later version.
  12
  13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with XEmacs; see the file COPYING.  If not, write to
  20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 /* Synched up with: Not in FSF. */
  24
  25 #ifndef INCLUDED_redisplay_h_
  26 #define INCLUDED_redisplay_h_
  27
  28 #include "character.h"
  29
  30 /* Redisplay DASSERT types */
  31 #define DB_DISP_POS             1
  32 #define DB_DISP_TEXT_LAYOUT     2
  33 #define DB_DISP_REDISPLAY       4
  34
  35 /* These are the possible return values from pixel_to_glyph_translation. */
  36 #define OVER_MODELINE           0
  37 #define OVER_TEXT               1
  38 #define OVER_OUTSIDE            2
  39 #define OVER_NOTHING            3
  40 #define OVER_BORDER             4
  41 #define OVER_TOOLBAR            5
  42 #define OVER_V_DIVIDER          6
  43
  44 #define NO_BLOCK        -1
  45
  46 /* Imagine that the text in the buffer is displayed on a piece of paper
  47    the width of the frame and very very tall.  The line start cache is
  48    an array of struct line_start_cache's, describing the start and
  49    end buffer positions for a contiguous set of lines on that piece
  50    of paper. */
  51
  52 typedef struct line_start_cache line_start_cache;
  53 struct line_start_cache
  54 {
  55   Bufpos start, end;
  56   int height;
  57 };
  58
  59 typedef struct
  60 {
  61   Dynarr_declare (line_start_cache);
  62 } line_start_cache_dynarr;
  63
  64 /* The possible types of runes.
  65
  66    #### The Lisp_Glyph type is broken.  There should instead be a pixmap
  67    type.  Currently the device-specific output routines have to worry
  68    about whether the glyph is textual or not, etc.  For Mule this is
  69    a big problem because you might need multiple fonts to display the
  70    text.  It also eliminates optimizations that could come from glumping
  71    the text of multiple text glyphs together -- this makes displaying
  72    binary files (with lots of control chars, etc.) very very slow. */
  73
  74 #define RUNE_BLANK      0
  75 #define RUNE_CHAR       1
  76 #define RUNE_DGLYPH     2
  77 #define RUNE_HLINE      3
  78 #define RUNE_VLINE      4
  79
  80 #define CURSOR_ON       0
  81 #define CURSOR_OFF      1
  82 #define NO_CURSOR       2
  83 #define NEXT_CURSOR     3
  84 #define IGNORE_CURSOR   4
  85
  86 #define DEFAULT_INDEX   (face_index) 0
  87 #define MODELINE_INDEX  (face_index) 1
  88
  89 /* A rune is a single display element, such as a printable character
  90    or pixmap.  Any single character in a buffer has one or more runes
  91    (or zero, if the character is invisible) corresponding to it.
  92    (Printable characters typically have one rune associated with them,
  93    but control characters have two -- a ^ and a letter -- and other
  94    non-printing characters (those displayed in octal) have four. */
  95
  96 /* WARNING! In compare_runes (one of the most heavily used functions)
  97    two runes are compared. So please be careful with changes to this
  98    structure. See comments in compare_runes.
  99
 100    #### This should really be made smaller.
 101 */
 102
 103 typedef struct rune rune;
 104 struct rune
 105 {
 106   face_index findex;            /* face rune is displayed with.  The
 107                                    face_index is an index into a
 108                                    window-specific array of face cache
 109                                    elements.  Each face cache element
 110                                    corresponds to one "merged face"
 111                                    (the result of merging all the
 112                                    faces that overlap the rune) and
 113                                    contains the instance values for
 114                                    each of the face properties in this
 115                                    particular window. */
 116
 117   Bufpos bufpos;                /* buffer position this rune is displaying;
 118                                    for the modeline, the value here is a
 119                                    Charcount, but who's looking? */
 120   Bufpos endpos;                /* if set this rune covers a range of pos */
 121                                 /* #### Chuck, what does it mean for a rune
 122                                    to cover a range of pos?  I don't get
 123                                    this. */
 124                                 /* #### This isn't used as an rvalue anywhere!
 125                                    remove! */
 126
 127
 128   short xpos;                   /* horizontal starting position in pixels */
 129   short width;                  /* pixel width of rune */
 130
 131
 132   unsigned char cursor_type;    /* is this rune covered by the cursor? */
 133   unsigned char type;           /* type of rune object */
 134                                 /* We used to do bitfields here, but if I
 135                                    (JV) count correctly that doesn't matter
 136                                    for the size of the structure. All the bit
 137                                    fiddling _does_ slow down redisplay by
 138                                    about 10%. So don't do that */
 139
 140   union                         /* Information specific to the type of rune */
 141   {
 142     /* #### Glyphs are rare. Is it really necessary to waste 8 bytes on every
 143        rune for that?! */
 144     /* DGLYPH */
 145     struct
 146     {
 147       Lisp_Object glyph;
 148       Lisp_Object extent;       /* extent rune is attached to, if any.
 149                                    If this is a rune in the modeline
 150                                    then this might be nil. */
 151
 152       int xoffset;              /* Number of pixels that need to be
 153                                    chopped off the left of the glyph.
 154                                    This has the effect of shifting the
 155                                    glyph to the left while still clipping
 156                                    at XPOS. */
 157     } dglyph;
 158
 159     /* CHAR */
 160     struct Charc cglyph;        /* Character of this rune. */
 161
 162     /* HLINE */
 163     struct
 164     {
 165       short thickness;  /* how thick to make hline */
 166       short yoffset;    /* how far down from top of line to put top */
 167     } hline;
 168   } object;                     /* actual rune object */
 169 };
 170
 171 typedef struct
 172 {
 173   Dynarr_declare (rune);
 174 } rune_dynarr;
 175
 176 /* These must have distinct values.  Note that the ordering actually
 177    represents priority levels.  TEXT has the lowest priority level. */
 178 enum display_type
 179 {
 180   TEXT,
 181   LEFT_OUTSIDE_MARGIN,
 182   LEFT_INSIDE_MARGIN,
 183   RIGHT_INSIDE_MARGIN,
 184   RIGHT_OUTSIDE_MARGIN,
 185   OVERWRITE
 186 };
 187
 188 /* A display block represents a run of text on a single line.
 189    Apparently there is only one display block per line for each
 190    of the types listed in `enum display_type'.
 191
 192    A display block consists mostly of an array of runes, one per
 193    atomic display element (printable character, pixmap, etc.). */
 194
 195 /* #### Yuckity yuckity yuck yuck yuck yuck yuck!!
 196
 197    Chuck, I think you should redo this.  It should not be the
 198    responsibility of the device-specific code to worry about
 199    the different faces.  The generic stuff in redisplay-output.c
 200    should glump things up into sub-blocks, each of which
 201    corresponds to a single pixmap or a single run of text in
 202    the same font.
 203
 204    It might still make sense for the device-specific output routine
 205    to get passed an entire display line.  That way, it can make
 206    calls to XDrawText() (which draws multiple runs of single-font
 207    data) instead of XDrawString().  The reason for this is to
 208    reduce the amount of X traffic, which will help things significantly
 209    on a slow line. */
 210
 211 typedef struct display_block display_block;
 212 struct display_block
 213 {
 214   enum display_type type;       /* type of display block */
 215
 216   int start_pos;                /* starting pixel position of block */
 217   int end_pos;                  /* ending pixel position of block */
 218
 219   rune_dynarr *runes;           /* Dynamic array of runes */
 220 };
 221
 222 typedef struct
 223 {
 224   Dynarr_declare (display_block);
 225 } display_block_dynarr;
 226
 227 typedef struct layout_bounds_type
 228 {
 229   int left_out;
 230   int left_in;
 231   int left_white;
 232   int right_white;
 233   int right_in;
 234   int right_out;
 235 } layout_bounds;
 236
 237 typedef struct glyph_block glyph_block;
 238 struct glyph_block
 239 {
 240   Lisp_Object glyph;
 241   Lisp_Object extent;
 242   /* The rest are only used by margin routines. */
 243   face_index findex;
 244   int active;
 245   int width;
 246 };
 247
 248 typedef struct
 249 {
 250   Dynarr_declare (glyph_block);
 251 } glyph_block_dynarr;
 252
 253 /*************************************************************************/
 254 /*                              display lines                             */
 255 /*************************************************************************/
 256
 257 /*  Modeline commentary: IMO the modeline is handled very badly, we
 258   special case virtually *everything* in the redisplay routines for
 259   the modeline. The fact that dl->bufpos can be either a buffer
 260   position or a char count highlights this. There is no abstraction at
 261   all that I can find and it means that the code is made very ugly as
 262   a result. Either we should treat the modeline *entirely* separately,
 263   or we should abstract to something that applies equally well to the
 264   modeline and to buffer text, the things are not enormously different
 265   after all and handling them identically at some level would
 266   eliminate some bugs that still exist (mainly to do with modeline
 267   handling). This problem doesn't help trying to implement gutters
 268   which are somewhere in between buffer text and modeline text.
 269
 270   Redisplay commentary: Everything in redisplay is tied very tightly
 271   to the things that are being displayed, and the context,
 272   e.g. buffers and windows. According to Chuck this is so that we can
 273   get speed, which seems fine to me, however this usage is extended
 274   too far down the redisplay routines IMO. At some level there should
 275   be functions that know how to display strings with extents and
 276   faces, regardless of buffer etc. After all the window system does
 277   not care. <andy@xemacs.org> */
 278
 279 typedef struct display_line display_line;
 280 struct display_line
 281 {
 282   short ypos;                           /* vertical position in pixels
 283                                            of the baseline for this line. */
 284   unsigned short ascent, descent;       /* maximum values for this line.
 285                                            The ascent is the number of
 286                                            pixels above the baseline, and
 287                                            the descent is the number of
 288                                            pixels below the baseline.
 289                                            The descent includes the baseline
 290                                            pixel-row itself, I think. */
 291   unsigned short clip;                  /* amount of bottom of line to clip
 292                                            in pixels.*/
 293   unsigned short top_clip;              /* amount of top of line to clip
 294                                            in pixels.*/
 295   Bufpos bufpos;                        /* first buffer position on line */
 296   Bufpos end_bufpos;                    /* last buffer position on line */
 297   Charcount offset;                     /* adjustment to bufpos vals */
 298   Charcount num_chars;                  /* # of chars on line
 299                                            including expansion of tabs
 300                                            and control chars */
 301   int cursor_elt;                       /* rune block of TEXT display
 302                                            block cursor is at or -1 */
 303   char used_prop_data;                  /* can't incrementally update if line
 304                                            used propagation data */
 305
 306   layout_bounds bounds;                 /* line boundary positions */
 307
 308   char modeline;                        /* t if this line is a modeline */
 309
 310   char line_continuation;               /* t if this line continues to
 311                                            next display line. */
 312
 313   /* Dynamic array of display blocks */
 314   display_block_dynarr *display_blocks;
 315
 316   /* Dynamic arrays of left and right glyph blocks */
 317   glyph_block_dynarr *left_glyphs;
 318   glyph_block_dynarr *right_glyphs;
 319
 320   face_index    left_margin_findex;
 321   face_index    right_margin_findex;
 322   face_index    default_findex;
 323 };
 324
 325 #define DISPLAY_LINE_HEIGHT(dl) \
 326 (dl->ascent + dl->descent - (dl->clip + dl->top_clip))
 327 #define DISPLAY_LINE_YPOS(dl) \
 328 (dl->ypos - (dl->ascent - dl->top_clip))
 329 #define DISPLAY_LINE_YEND(dl) \
 330 ((dl->ypos + dl->descent) - dl->clip)
 331
 332 typedef struct
 333 {
 334   Dynarr_declare (display_line);
 335 } display_line_dynarr;
 336
 337 /* The following two structures are used to represent an area to
 338 displayed and where to display it. Using these two structures all
 339 combinations of clipping and position can be accommodated.  */
 340
 341 /* This represents an area to be displayed into. */
 342 typedef struct display_box display_box;
 343 struct display_box
 344 {
 345   int xpos;             /* absolute horizontal position of area */
 346   int ypos;             /* absolute vertical position of area */
 347   int width, height;
 348 };
 349
 350 /* This represents the area from a glyph to be displayed. */
 351 typedef struct display_glyph_area display_glyph_area;
 352 struct display_glyph_area
 353 {
 354   int xoffset;          /* horizontal offset of the glyph, +ve means
 355                            display the glyph with x offset by xoffset,
 356                            -ve means display starting xoffset into the
 357                            glyph. */
 358   int yoffset;          /* vertical offset of the glyph, +ve means
 359                            display the glyph with y offset by yoffset,
 360                            -ve means display starting xoffset into the
 361                            glyph. */
 362   int width, height;    /* width and height of glyph to display. */
 363 };
 364
 365 /* It could be argued that the following two structs belong in
 366    extents.h, but they're only used by redisplay and it simplifies
 367    the header files to put them here. */
 368
 369 typedef struct
 370 {
 371   Dynarr_declare (EXTENT);
 372 } EXTENT_dynarr;
 373
 374 struct font_metric_info
 375 {
 376   int width;
 377   int height;                   /* always ascent + descent; for convenience */
 378   int ascent;
 379   int descent;
 380
 381   int proportional_p;
 382 };
 383
 384 /* NOTE NOTE NOTE: Currently the positions in an extent fragment
 385    structure are Bytind's, not Bufpos's.  This could change. */
 386
 387 struct extent_fragment
 388 {
 389   Lisp_Object object; /* buffer or string */
 390   struct frame *frm;
 391   Bytind pos, end;
 392   EXTENT_dynarr *extents;
 393   glyph_block_dynarr *begin_glyphs, *end_glyphs;
 394   unsigned int invisible:1;
 395   unsigned int invisible_ellipses:1;
 396   unsigned int previously_invisible:1;
 397   unsigned int invisible_ellipses_already_displayed:1;
 398 };
 399
 400 #define EDGE_TOP 1
 401 #define EDGE_LEFT 2
 402 #define EDGE_BOTTOM 4
 403 #define EDGE_RIGHT 8
 404 #define EDGE_ALL (EDGE_TOP | EDGE_LEFT | EDGE_BOTTOM | EDGE_RIGHT)
 405
 406 \f
 407 /*************************************************************************/
 408 /*                              change flags                             */
 409 /*************************************************************************/
 410
 411 /* Quick flags to signal redisplay.  redisplay() sets them all to 0
 412    when it finishes.  If none of them are set when it starts, it
 413    assumes that nothing needs to be done.  Functions that make a change
 414    that is (potentially) visible on the screen should set the
 415    appropriate flag.
 416
 417    If any of these flags are set, redisplay will look more carefully
 418    to see if anything has really changed. */
 419
 420 /* Nonzero if the contents of a buffer have changed since the last time
 421    redisplay completed. */
 422 extern int buffers_changed;
 423 extern int buffers_changed_set;
 424
 425 /* Nonzero if head_clip or tail_clip of a buffer has changed
 426    since last redisplay that finished. */
 427 extern int clip_changed;
 428 extern int clip_changed_set;
 429
 430 /* Nonzero if any extent has changed since the last time redisplay completed. */
 431 extern int extents_changed;
 432 extern int extents_changed_set;
 433
 434 /* Nonzero if any face has changed since the last time redisplay completed. */
 435 extern int faces_changed;
 436
 437 /* Nonzero means one or more frames have been marked as garbaged. */
 438 extern int frame_changed;
 439
 440 /* True if any of the builtin display glyphs (continuation,
 441    hscroll, control-arrow, etc) is in need of updating
 442    somewhere. */
 443 extern int glyphs_changed;
 444 extern int glyphs_changed_set;
 445
 446 /* True if any displayed subwindow is in need of updating
 447    somewhere. */
 448 extern int subwindows_changed;
 449 extern int subwindows_changed_set;
 450
 451 /* True if any displayed subwindow is in need of updating
 452    somewhere. */
 453 extern int subwindows_state_changed;
 454 extern int subwindows_state_changed_set;
 455
 456 /* True if an icon is in need of updating somewhere. */
 457 extern int icon_changed;
 458 extern int icon_changed_set;
 459
 460 /* True if a menubar is in need of updating somewhere. */
 461 extern int menubar_changed;
 462 extern int menubar_changed_set;
 463
 464 /* True iff we should redraw the modelines on the next redisplay. */
 465 extern int modeline_changed;
 466 extern int modeline_changed_set;
 467
 468 /* Nonzero if point has changed in some buffer since the last time
 469    redisplay completed. */
 470 extern int point_changed;
 471 extern int point_changed_set;
 472
 473 /* Nonzero if some frame has changed its size. */
 474 extern int size_changed;
 475
 476 /* Nonzero if some device has signaled that it wants to change size. */
 477 extern int asynch_device_change_pending;
 478
 479 /* Nonzero if any toolbar has changed. */
 480 extern int toolbar_changed;
 481 extern int toolbar_changed_set;
 482
 483 /* Nonzero if any gutter has changed. */
 484 extern int gutter_changed;
 485 extern int gutter_changed_set;
 486
 487 /* Nonzero if any window has changed since the last time redisplay completed */
 488 extern int windows_changed;
 489
 490 /* Nonzero if any frame's window structure has changed since the last
 491    time redisplay completed. */
 492 extern int windows_structure_changed;
 493
 494 /* These macros can be relatively expensive.  Since they are often
 495    called numerous times between each call to redisplay, we keep track
 496    if each has already been called and don't bother doing most of the
 497    work if it is currently set. */
 498
 499 #define MARK_TYPE_CHANGED(object) do {                          \
 500   if (!object##_changed_set) {                                  \
 501     Lisp_Object MTC_devcons, MTC_concons;                       \
 502     DEVICE_LOOP_NO_BREAK (MTC_devcons, MTC_concons)             \
 503       {                                                         \
 504         Lisp_Object MTC_frmcons;                                \
 505         struct device *MTC_d = XDEVICE (XCAR (MTC_devcons));    \
 506         DEVICE_FRAME_LOOP (MTC_frmcons, MTC_d)                  \
 507           {                                                     \
 508             struct frame *MTC_f = XFRAME (XCAR (MTC_frmcons));  \
 509             MTC_f->object##_changed = 1;                        \
 510             MTC_f->modiff++;                                    \
 511           }                                                     \
 512         MTC_d->object##_changed = 1;                            \
 513       }                                                         \
 514     object##_changed = 1;                                       \
 515     object##_changed_set = 1; }                                 \
 516   }  while (0)
 517
 518 #define MARK_BUFFERS_CHANGED MARK_TYPE_CHANGED (buffers)
 519 #define MARK_CLIP_CHANGED MARK_TYPE_CHANGED (clip)
 520 #define MARK_EXTENTS_CHANGED MARK_TYPE_CHANGED (extents)
 521 #define MARK_ICON_CHANGED MARK_TYPE_CHANGED (icon)
 522 #define MARK_MENUBAR_CHANGED MARK_TYPE_CHANGED (menubar)
 523 #define MARK_MODELINE_CHANGED MARK_TYPE_CHANGED (modeline)
 524 #define MARK_POINT_CHANGED MARK_TYPE_CHANGED (point)
 525 #define MARK_TOOLBAR_CHANGED MARK_TYPE_CHANGED (toolbar)
 526 #define MARK_GUTTER_CHANGED MARK_TYPE_CHANGED (gutter)
 527 #define MARK_GLYPHS_CHANGED MARK_TYPE_CHANGED (glyphs)
 528 #define MARK_SUBWINDOWS_CHANGED MARK_TYPE_CHANGED (subwindows)
 529 #define MARK_SUBWINDOWS_STATE_CHANGED MARK_TYPE_CHANGED (subwindows_state)
 530
 531
 532 #define CLASS_RESET_CHANGED_FLAGS(p) do {       \
 533   (p)->buffers_changed = 0;                     \
 534   (p)->clip_changed = 0;                        \
 535   (p)->extents_changed = 0;                     \
 536   (p)->faces_changed = 0;                       \
 537   (p)->frame_changed = 0;                       \
 538   (p)->icon_changed = 0;                        \
 539   (p)->menubar_changed = 0;                     \
 540   (p)->modeline_changed = 0;                    \
 541   (p)->point_changed = 0;                       \
 542   (p)->toolbar_changed = 0;                     \
 543   (p)->gutter_changed = 0;                      \
 544   (p)->glyphs_changed = 0;                      \
 545   (p)->subwindows_changed = 0;                  \
 546   (p)->subwindows_state_changed = 0;            \
 547   (p)->windows_changed = 0;                     \
 548   (p)->windows_structure_changed = 0;           \
 549 } while (0)
 550
 551 #define GLOBAL_RESET_CHANGED_FLAGS do {         \
 552   buffers_changed = 0;                          \
 553   clip_changed = 0;                             \
 554   extents_changed = 0;                          \
 555   frame_changed = 0;                            \
 556   icon_changed = 0;                             \
 557   menubar_changed = 0;                          \
 558   modeline_changed = 0;                         \
 559   point_changed = 0;                            \
 560   toolbar_changed = 0;                          \
 561   gutter_changed = 0;                           \
 562   glyphs_changed = 0;                           \
 563   subwindows_changed = 0;                       \
 564   subwindows_state_changed = 0;                 \
 565   windows_changed = 0;                          \
 566   windows_structure_changed = 0;                \
 567 } while (0)
 568
 569 #define CLASS_REDISPLAY_FLAGS_CHANGEDP(p)       \
 570   ( (p)->buffers_changed ||                     \
 571     (p)->clip_changed ||                        \
 572     (p)->extents_changed ||                     \
 573     (p)->faces_changed ||                       \
 574     (p)->frame_changed ||                       \
 575     (p)->icon_changed ||                        \
 576     (p)->menubar_changed ||                     \
 577     (p)->modeline_changed ||                    \
 578     (p)->point_changed ||                       \
 579     (p)->toolbar_changed ||                     \
 580     (p)->gutter_changed ||                      \
 581     (p)->glyphs_changed ||                      \
 582     (p)->size_changed ||                        \
 583     (p)->subwindows_changed ||                  \
 584     (p)->subwindows_state_changed ||            \
 585     (p)->windows_changed ||                     \
 586     (p)->windows_structure_changed )
 587
 588 #define GLOBAL_REDISPLAY_FLAGS_CHANGEDP         \
 589   ( buffers_changed ||                          \
 590     clip_changed ||                             \
 591     extents_changed ||                          \
 592     faces_changed ||                            \
 593     frame_changed ||                            \
 594     icon_changed ||                             \
 595     menubar_changed ||                          \
 596     modeline_changed ||                         \
 597     point_changed ||                            \
 598     toolbar_changed ||                          \
 599     gutter_changed ||                           \
 600     glyphs_changed ||                           \
 601     size_changed ||                             \
 602     subwindows_changed ||                       \
 603     subwindows_state_changed ||                 \
 604     windows_changed ||                          \
 605     windows_structure_changed )
 606
 607
 608 /* Anytime a console, device or frame is added or deleted we need to reset
 609    these flags. */
 610 #define RESET_CHANGED_SET_FLAGS do {    \
 611   buffers_changed_set = 0;              \
 612   clip_changed_set = 0;                 \
 613   extents_changed_set = 0;              \
 614   icon_changed_set = 0;                 \
 615   menubar_changed_set = 0;              \
 616   modeline_changed_set = 0;             \
 617   point_changed_set = 0;                \
 618   toolbar_changed_set = 0;              \
 619   gutter_changed_set = 0;               \
 620   glyphs_changed_set = 0;               \
 621   subwindows_changed_set = 0;           \
 622   subwindows_state_changed_set = 0;     \
 623 } while (0)
 624
 625 \f
 626 /*************************************************************************/
 627 /*                       redisplay global variables                      */
 628 /*************************************************************************/
 629
 630 /* redisplay structure used by various utility routines. */
 631 extern display_line_dynarr *cmotion_display_lines;
 632
 633 /* Nonzero means truncate lines in all windows less wide than the frame. */
 634 extern int truncate_partial_width_windows;
 635
 636 /* Nonzero if we're in a display critical section. */
 637 extern int in_display;
 638
 639 /* Nonzero means no need to redraw the entire frame on resuming
 640    a suspended Emacs.  This is useful on terminals with multiple pages,
 641    where one page is used for Emacs and another for all else. */
 642 extern int no_redraw_on_reenter;
 643
 644 /* Non-nil means flash the frame instead of ringing the bell.  */
 645 extern Lisp_Object Vvisible_bell;
 646
 647 /* Thickness of shadow border around 3D modelines. */
 648 extern Lisp_Object Vmodeline_shadow_thickness;
 649
 650 /* Scroll if point lands on the bottom line and that line is partially
 651    clipped. */
 652 extern int scroll_on_clipped_lines;
 653
 654 extern Lisp_Object Vglobal_mode_string;
 655
 656 /* The following two variables are defined in emacs.c and are used
 657    to convey information discovered on the command line way early
 658    (before *anything* is initialized). */
 659
 660 /* If non-zero, a window-system was specified on the command line.
 661    Defined in emacs.c. */
 662 extern int display_arg;
 663
 664 /* Type of display specified.  Defined in emacs.c. */
 665 extern const char *display_use;
 666
 667 /* Nonzero means reading single-character input with prompt
 668    so put cursor on minibuffer after the prompt.  */
 669
 670 extern int cursor_in_echo_area;
 671
 672 extern Lisp_Object Qbar_cursor, Qcursor_in_echo_area, Vwindow_system;
 673
 674 extern Lisp_Object Qtop_bottom;
 675
 676 \f
 677 /*************************************************************************/
 678 /*                     redisplay exported functions                      */
 679 /*************************************************************************/
 680 EXFUN (Fredraw_frame, 2);
 681
 682 int redisplay_text_width_string (struct window *w, int findex,
 683                                  Bufbyte *nonreloc, Lisp_Object reloc,
 684                                  Bytecount offset, Bytecount len);
 685 int redisplay_frame_text_width_string (struct frame *f,
 686                                        Lisp_Object face,
 687                                        Bufbyte *nonreloc,
 688                                        Lisp_Object reloc,
 689                                        Bytecount offset, Bytecount len);
 690 int redisplay_frame (struct frame *f, int preemption_check);
 691 void redisplay (void);
 692 struct display_block *get_display_block_from_line (struct display_line *dl,
 693                                                    enum display_type type);
 694 layout_bounds calculate_display_line_boundaries (struct window *w,
 695                                                  int modeline);
 696 Bufpos point_at_center (struct window *w, int type, Bufpos start,
 697                         Bufpos point);
 698 int line_at_center (struct window *w, int type, Bufpos start, Bufpos point);
 699 int window_half_pixpos (struct window *w);
 700 void redisplay_echo_area (void);
 701 void free_display_structs (struct window_mirror *mir);
 702 void free_display_lines (display_line_dynarr *dla);
 703 void mark_redisplay_structs (display_line_dynarr *dla);
 704 void generate_displayable_area (struct window *w, Lisp_Object disp_string,
 705                                 int xpos, int ypos, int width, int height,
 706                                 display_line_dynarr* dl,
 707                                 Bufpos start_pos, face_index default_face);
 708 /* `generate_title_string' in frame.c needs this */
 709 void generate_formatted_string_db (Lisp_Object format_str,
 710                                    Lisp_Object result_str,
 711                                    struct window *w,
 712                                    struct display_line *dl,
 713                                    struct display_block *db,
 714                                    face_index findex,
 715                                    int min_pixpos, int max_pixpos, int type);
 716 int real_current_modeline_height (struct window *w);
 717 int pixel_to_glyph_translation (struct frame *f, int x_coord,
 718                                 int y_coord, int *col, int *row,
 719                                 int *obj_x, int *obj_y,
 720                                 struct window **w, Bufpos *bufpos,
 721                                 Bufpos *closest, Charcount *modeline_closest,
 722                                 Lisp_Object *obj1, Lisp_Object *obj2);
 723 void glyph_to_pixel_translation (struct window *w, int char_x,
 724                                  int char_y, int *pix_x, int *pix_y);
 725 void mark_redisplay (void);
 726 int point_in_line_start_cache (struct window *w, Bufpos point,
 727                                int min_past);
 728 int point_would_be_visible (struct window *w, Bufpos startp,
 729                     Bufpos point);
 730 Bufpos start_of_last_line (struct window *w, Bufpos startp);
 731 Bufpos end_of_last_line (struct window *w, Bufpos startp);
 732 Bufpos start_with_line_at_pixpos (struct window *w, Bufpos point,
 733                                   int pixpos);
 734 Bufpos start_with_point_on_display_line (struct window *w, Bufpos point,
 735                                          int line);
 736 int redisplay_variable_changed (Lisp_Object sym, Lisp_Object *val,
 737                                 Lisp_Object in_object, int flags);
 738 void redisplay_glyph_changed (Lisp_Object glyph, Lisp_Object property,
 739                               Lisp_Object locale);
 740
 741 #ifdef MEMORY_USAGE_STATS
 742 int compute_display_line_dynarr_usage (display_line_dynarr *dyn,
 743                                        struct overhead_stats *ovstats);
 744 int compute_line_start_cache_dynarr_usage (line_start_cache_dynarr *dyn,
 745                                            struct overhead_stats *ovstats);
 746 #endif
 747
 748
 749 /* defined in redisplay-output.c */
 750 int get_next_display_block (layout_bounds bounds,
 751                             display_block_dynarr *dba, int start_pos,
 752                             int *next_start);
 753 void redisplay_output_layout (Lisp_Object domain,
 754                               Lisp_Object image_instance,
 755                               struct display_box* db, struct display_glyph_area* dga,
 756                               face_index findex, int cursor_start, int cursor_width,
 757                               int cursor_height);
 758 void redisplay_output_subwindow (struct window *w,
 759                                  Lisp_Object image_instance,
 760                                  struct display_box* db, struct display_glyph_area* dga,
 761                                  face_index findex, int cursor_start, int cursor_width,
 762                                  int cursor_height);
 763 void redisplay_unmap_subwindows_maybe (struct frame* f, int x, int y, int width, int height);
 764 void redisplay_output_pixmap (struct window *w,
 765                               Lisp_Object image_instance,
 766                               struct display_box* db, struct display_glyph_area* dga,
 767                               face_index findex, int cursor_start, int cursor_width,
 768                               int cursor_height, int offset_bitmap);
 769 int redisplay_calculate_display_boxes (struct display_line *dl, int xpos,
 770                                        int xoffset, int start_pixpos, int width,
 771                                        struct display_box* dest,
 772                                        struct display_glyph_area* src);
 773 int redisplay_normalize_glyph_area (struct display_box* dest,
 774                                     struct display_glyph_area* glyphsrc);
 775 void redisplay_clear_to_window_end (struct window *w, int ypos1, int ypos2);
 776 void redisplay_clear_region (Lisp_Object window, face_index findex, int x,
 777                              int y, int width, int height);
 778 void redisplay_clear_top_of_window (struct window *w);
 779 void redisplay_clear_bottom_of_window (struct window *w,
 780                                        display_line_dynarr *ddla,
 781                                        int min_start, int max_end);
 782 void redisplay_update_line (struct window *w, int first_line,
 783                             int last_line, int update_values);
 784 void redisplay_output_window (struct window *w);
 785 void bevel_modeline (struct window *w, struct display_line *dl);
 786 int redisplay_move_cursor (struct window *w, Bufpos new_point,
 787                            int no_output_end);
 788 void redisplay_redraw_cursor (struct frame *f, int run_begin_end_meths);
 789 void output_display_line (struct window *w, display_line_dynarr *cdla,
 790                           display_line_dynarr *ddla, int line,
 791                           int force_start, int force_end);
 792 void sync_display_line_structs (struct window *w, int line, int do_blocks,
 793                                 display_line_dynarr *cdla,
 794                                 display_line_dynarr *ddla);
 795
 796 #endif /* INCLUDED_redisplay_h_ */