xdisp.c 941 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Display generation from window structure and buffer text.
2

3 4
Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

Gerd Moellmann's avatar
Gerd Moellmann committed
21 22 23 24 25 26 27 28 29 30 31 32 33
/* New redisplay written by Gerd Moellmann <gerd@gnu.org>.

   Redisplay.

   Emacs separates the task of updating the display from code
   modifying global state, e.g. buffer text.  This way functions
   operating on buffers don't also have to be concerned with updating
   the display.

   Updating the display is triggered by the Lisp interpreter when it
   decides it's time to do it.  This is done either automatically for
   you as part of the interpreter's command loop or as the result of
   calling Lisp functions like `sit-for'.  The C function `redisplay'
34
   in xdisp.c is the only entry into the inner redisplay code.
Gerd Moellmann's avatar
Gerd Moellmann committed
35 36 37 38 39 40 41 42 43 44 45

   The following diagram shows how redisplay code is invoked.  As you
   can see, Lisp calls redisplay and vice versa.  Under window systems
   like X, some portions of the redisplay code are also called
   asynchronously during mouse movement or expose events.  It is very
   important that these code parts do NOT use the C library (malloc,
   free) because many C libraries under Unix are not reentrant.  They
   may also NOT call functions of the Lisp interpreter which could
   change the interpreter's state.  If you don't follow these rules,
   you will encounter bugs which are very hard to explain.

46
   +--------------+   redisplay     +----------------+
Gerd Moellmann's avatar
Gerd Moellmann committed
47 48 49 50 51 52 53 54 55 56 57
   | Lisp machine |---------------->| Redisplay code |<--+
   +--------------+   (xdisp.c)     +----------------+   |
	  ^				     |		 |
	  +----------------------------------+           |
	    Don't use this path when called		 |
	    asynchronously!				 |
                                                         |
                           expose_window (asynchronous)  |
                                                         |
			           X expose events  -----+

58
   What does redisplay do?  Obviously, it has to figure out somehow what
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
   has been changed since the last time the display has been updated,
   and to make these changes visible.  Preferably it would do that in
   a moderately intelligent way, i.e. fast.

   Changes in buffer text can be deduced from window and buffer
   structures, and from some global variables like `beg_unchanged' and
   `end_unchanged'.  The contents of the display are additionally
   recorded in a `glyph matrix', a two-dimensional matrix of glyph
   structures.  Each row in such a matrix corresponds to a line on the
   display, and each glyph in a row corresponds to a column displaying
   a character, an image, or what else.  This matrix is called the
   `current glyph matrix' or `current matrix' in redisplay
   terminology.

   For buffer parts that have been changed since the last update, a
   second glyph matrix is constructed, the so called `desired glyph
   matrix' or short `desired matrix'.  Current and desired matrix are
   then compared to find a cheap way to update the display, e.g. by
   reusing part of the display by scrolling lines.

Pavel Janík's avatar
Pavel Janík committed
79
   You will find a lot of redisplay optimizations when you start
Gerd Moellmann's avatar
Gerd Moellmann committed
80 81
   looking at the innards of redisplay.  The overall goal of all these
   optimizations is to make redisplay fast because it is done
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
   frequently.  Some of these optimizations are implemented by the
   following functions:

    . try_cursor_movement

      This function tries to update the display if the text in the
      window did not change and did not scroll, only point moved, and
      it did not move off the displayed portion of the text.

    . try_window_reusing_current_matrix

      This function reuses the current matrix of a window when text
      has not changed, but the window start changed (e.g., due to
      scrolling).

    . try_window_id

      This function attempts to redisplay a window by reusing parts of
      its existing display.  It finds and reuses the part that was not
101 102 103
      changed, and redraws the rest.  (The "id" part in the function's
      name stands for "insert/delete", not for "identification" or
      somesuch.)
104 105 106 107 108 109 110 111 112 113 114 115 116

    . try_window

      This function performs the full redisplay of a single window
      assuming that its fonts were not changed and that the cursor
      will not end up in the scroll margins.  (Loading fonts requires
      re-adjustment of dimensions of glyph matrices, which makes this
      method impossible to use.)

   These optimizations are tried in sequence (some can be skipped if
   it is known that they are not applicable).  If none of the
   optimizations were successful, redisplay calls redisplay_windows,
   which performs a full redisplay of all windows.
Gerd Moellmann's avatar
Gerd Moellmann committed
117

118 119 120 121 122 123 124 125 126 127 128 129 130
   Note that there's one more important optimization up Emacs's
   sleeve, but it is related to actually redrawing the potentially
   changed portions of the window/frame, not to reproducing the
   desired matrices of those potentially changed portions.  Namely,
   the function update_frame and its subroutines, which you will find
   in dispnew.c, compare the desired matrices with the current
   matrices, and only redraw the portions that changed.  So it could
   happen that the functions in this file for some reason decide that
   the entire desired matrix needs to be regenerated from scratch, and
   still only parts of the Emacs display, or even nothing at all, will
   be actually delivered to the glass, because update_frame has found
   that the new and the old screen contents are similar or identical.

Gerd Moellmann's avatar
Gerd Moellmann committed
131 132 133 134 135 136 137 138 139 140 141 142 143
   Desired matrices.

   Desired matrices are always built per Emacs window.  The function
   `display_line' is the central function to look at if you are
   interested.  It constructs one row in a desired matrix given an
   iterator structure containing both a buffer position and a
   description of the environment in which the text is to be
   displayed.  But this is too early, read on.

   Characters and pixmaps displayed for a range of buffer text depend
   on various settings of buffers and windows, on overlays and text
   properties, on display tables, on selective display.  The good news
   is that all this hairy stuff is hidden behind a small set of
144
   interface functions taking an iterator structure (struct it)
Gerd Moellmann's avatar
Gerd Moellmann committed
145 146
   argument.

Pavel Janík's avatar
Pavel Janík committed
147
   Iteration over things to be displayed is then simple.  It is
148 149 150 151 152 153 154
   started by initializing an iterator with a call to init_iterator,
   passing it the buffer position where to start iteration.  For
   iteration over strings, pass -1 as the position to init_iterator,
   and call reseat_to_string when the string is ready, to initialize
   the iterator for that string.  Thereafter, calls to
   get_next_display_element fill the iterator structure with relevant
   information about the next thing to display.  Calls to
Gerd Moellmann's avatar
Gerd Moellmann committed
155 156 157 158 159 160 161 162 163 164
   set_iterator_to_next move the iterator to the next thing.

   Besides this, an iterator also contains information about the
   display environment in which glyphs for display elements are to be
   produced.  It has fields for the width and height of the display,
   the information whether long lines are truncated or continued, a
   current X and Y position, and lots of other stuff you can better
   see in dispextern.h.

   Glyphs in a desired matrix are normally constructed in a loop
165 166
   calling get_next_display_element and then PRODUCE_GLYPHS.  The call
   to PRODUCE_GLYPHS will fill the iterator structure with pixel
Gerd Moellmann's avatar
Gerd Moellmann committed
167 168 169
   information about the element being displayed and at the same time
   produce glyphs for it.  If the display element fits on the line
   being displayed, set_iterator_to_next is called next, otherwise the
170 171 172 173 174
   glyphs produced are discarded.  The function display_line is the
   workhorse of filling glyph rows in the desired matrix with glyphs.
   In addition to producing glyphs, it also handles line truncation
   and continuation, word wrap, and cursor positioning (for the
   latter, see also set_cursor_from_row).
Gerd Moellmann's avatar
Gerd Moellmann committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

   Frame matrices.

   That just couldn't be all, could it?  What about terminal types not
   supporting operations on sub-windows of the screen?  To update the
   display on such a terminal, window-based glyph matrices are not
   well suited.  To be able to reuse part of the display (scrolling
   lines up and down), we must instead have a view of the whole
   screen.  This is what `frame matrices' are for.  They are a trick.

   Frames on terminals like above have a glyph pool.  Windows on such
   a frame sub-allocate their glyph memory from their frame's glyph
   pool.  The frame itself is given its own glyph matrices.  By
   coincidence---or maybe something else---rows in window glyph
   matrices are slices of corresponding rows in frame matrices.  Thus
   writing to window matrices implicitly updates a frame matrix which
   provides us with the view of the whole screen that we originally
   wanted to have without having to move many bytes around.  To be
   honest, there is a little bit more done, but not much more.  If you
   plan to extend that code, take a look at dispnew.c.  The function
195 196 197 198 199 200 201 202 203 204
   build_frame_matrix is a good starting point.

   Bidirectional display.

   Bidirectional display adds quite some hair to this already complex
   design.  The good news are that a large portion of that hairy stuff
   is hidden in bidi.c behind only 3 interfaces.  bidi.c implements a
   reordering engine which is called by set_iterator_to_next and
   returns the next character to display in the visual order.  See
   commentary on bidi.c for more details.  As far as redisplay is
205
   concerned, the effect of calling bidi_move_to_visually_next, the
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
   main interface of the reordering engine, is that the iterator gets
   magically placed on the buffer or string position that is to be
   displayed next.  In other words, a linear iteration through the
   buffer/string is replaced with a non-linear one.  All the rest of
   the redisplay is oblivious to the bidi reordering.

   Well, almost oblivious---there are still complications, most of
   them due to the fact that buffer and string positions no longer
   change monotonously with glyph indices in a glyph row.  Moreover,
   for continued lines, the buffer positions may not even be
   monotonously changing with vertical positions.  Also, accounting
   for face changes, overlays, etc. becomes more complex because
   non-linear iteration could potentially skip many positions with
   changes, and then cross them again on the way back...

   One other prominent effect of bidirectional display is that some
   paragraphs of text need to be displayed starting at the right
   margin of the window---the so-called right-to-left, or R2L
   paragraphs.  R2L paragraphs are displayed with R2L glyph rows,
   which have their reversed_p flag set.  The bidi reordering engine
   produces characters in such rows starting from the character which
   should be the rightmost on display.  PRODUCE_GLYPHS then reverses
   the order, when it fills up the glyph row whose reversed_p flag is
   set, by prepending each new glyph to what is already there, instead
   of appending it.  When the glyph row is complete, the function
   extend_face_to_end_of_line fills the empty space to the left of the
   leftmost character with special glyphs, which will display as,
   well, empty.  On text terminals, these special glyphs are simply
   blank characters.  On graphics terminals, there's a single stretch
235
   glyph of a suitably computed width.  Both the blanks and the
236 237
   stretch glyph are given the face of the background of the line.
   This way, the terminal-specific back-end can still draw the glyphs
238 239
   left to right, even for R2L lines.

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
   Bidirectional display and character compositions

   Some scripts cannot be displayed by drawing each character
   individually, because adjacent characters change each other's shape
   on display.  For example, Arabic and Indic scripts belong to this
   category.

   Emacs display supports this by providing "character compositions",
   most of which is implemented in composite.c.  During the buffer
   scan that delivers characters to PRODUCE_GLYPHS, if the next
   character to be delivered is a composed character, the iteration
   calls composition_reseat_it and next_element_from_composition.  If
   they succeed to compose the character with one or more of the
   following characters, the whole sequence of characters that where
   composed is recorded in the `struct composition_it' object that is
   part of the buffer iterator.  The composed sequence could produce
   one or more font glyphs (called "grapheme clusters") on the screen.
   Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
   in the direction corresponding to the current bidi scan direction
   (recorded in the scan_dir member of the `struct bidi_it' object
   that is part of the buffer iterator).  In particular, if the bidi
   iterator currently scans the buffer backwards, the grapheme
   clusters are delivered back to front.  This reorders the grapheme
   clusters as appropriate for the current bidi context.  Note that
   this means that the grapheme clusters are always stored in the
   LGSTRING object (see composite.c) in the logical order.

   Moving an iterator in bidirectional text
   without producing glyphs

270 271 272 273 274 275 276
   Note one important detail mentioned above: that the bidi reordering
   engine, driven by the iterator, produces characters in R2L rows
   starting at the character that will be the rightmost on display.
   As far as the iterator is concerned, the geometry of such rows is
   still left to right, i.e. the iterator "thinks" the first character
   is at the leftmost pixel position.  The iterator does not know that
   PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
U. Ser's avatar
U. Ser committed
277
   delivers.  This is important when functions from the move_it_*
278 279 280 281 282 283 284 285 286 287
   family are used to get to certain screen position or to match
   screen coordinates with buffer coordinates: these functions use the
   iterator geometry, which is left to right even in R2L paragraphs.
   This works well with most callers of move_it_*, because they need
   to get to a specific column, and columns are still numbered in the
   reading order, i.e. the rightmost character in a R2L paragraph is
   still column zero.  But some callers do not get well with this; a
   notable example is mouse clicks that need to find the character
   that corresponds to certain pixel coordinates.  See
   buffer_posn_from_coords in dispnew.c for how this is handled.  */
Jim Blandy's avatar
Jim Blandy committed
288

289
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
290
#include <stdio.h>
291
#include <limits.h>
292

Jim Blandy's avatar
Jim Blandy committed
293
#include "lisp.h"
294
#include "atimer.h"
295
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
296
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
297 298 299
#include "window.h"
#include "termchar.h"
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
300
#include "character.h"
301
#include "buffer.h"
302
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
303 304
#include "indent.h"
#include "commands.h"
305
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
306 307
#include "macros.h"
#include "disptab.h"
308
#include "termhooks.h"
309
#include "termopts.h"
310
#include "intervals.h"
311 312
#include "coding.h"
#include "process.h"
Andreas Schwab's avatar
Andreas Schwab committed
313
#include "region-cache.h"
Kenichi Handa's avatar
Kenichi Handa committed
314
#include "font.h"
Dave Love's avatar
Dave Love committed
315
#include "fontset.h"
316
#include "blockinput.h"
317 318 319
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
320

321 322 323 324
#ifndef FRAME_X_OUTPUT
#define FRAME_X_OUTPUT(f) ((f)->output_data.x)
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
325 326
#define INFINITY 10000000

327
Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
328
Lisp_Object Qwindow_scroll_functions;
329 330
static Lisp_Object Qwindow_text_change_functions;
static Lisp_Object Qredisplay_end_trigger_functions;
331
Lisp_Object Qinhibit_point_motion_hooks;
332 333 334 335 336 337 338
static Lisp_Object QCeval, QCpropertize;
Lisp_Object QCfile, QCdata;
static Lisp_Object Qfontified;
static Lisp_Object Qgrow_only;
static Lisp_Object Qinhibit_eval_during_redisplay;
static Lisp_Object Qbuffer_position, Qposition, Qobject;
static Lisp_Object Qright_to_left, Qleft_to_right;
Gerd Moellmann's avatar
Gerd Moellmann committed
339

340
/* Cursor shapes.  */
341 342
Lisp_Object Qbar, Qhbar, Qbox, Qhollow;

343
/* Pointer shapes.  */
344 345
static Lisp_Object Qarrow, Qhand;
Lisp_Object Qtext;
Kenichi Handa's avatar
Kenichi Handa committed
346

347
/* Holds the list (error).  */
348
static Lisp_Object list_of_error;
349

350
static Lisp_Object Qfontification_functions;
Gerd Moellmann's avatar
Gerd Moellmann committed
351

352 353
static Lisp_Object Qwrap_prefix;
static Lisp_Object Qline_prefix;
354
static Lisp_Object Qredisplay_internal;
355

356 357
/* Non-nil means don't actually do any redisplay.  */

358
Lisp_Object Qinhibit_redisplay;
359

Gerd Moellmann's avatar
Gerd Moellmann committed
360 361
/* Names of text properties relevant for redisplay.  */

Kenichi Handa's avatar
Kenichi Handa committed
362
Lisp_Object Qdisplay;
Gerd Moellmann's avatar
Gerd Moellmann committed
363

364 365 366 367 368
Lisp_Object Qspace, QCalign_to;
static Lisp_Object QCrelative_width, QCrelative_height;
Lisp_Object Qleft_margin, Qright_margin;
static Lisp_Object Qspace_width, Qraise;
static Lisp_Object Qslice;
Kenichi Handa's avatar
Kenichi Handa committed
369
Lisp_Object Qcenter;
370 371
static Lisp_Object Qmargin, Qpointer;
static Lisp_Object Qline_height;
Gerd Moellmann's avatar
Gerd Moellmann committed
372

Kenichi Handa's avatar
Kenichi Handa committed
373 374 375 376 377
#ifdef HAVE_WINDOW_SYSTEM

/* Test if overflow newline into fringe.  Called with iterator IT
   at or past right window margin, and with IT->current_x set.  */

378 379 380 381 382 383
#define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT)		\
  (!NILP (Voverflow_newline_into_fringe)		\
   && FRAME_WINDOW_P ((IT)->f)				\
   && ((IT)->bidi_it.paragraph_dir == R2L		\
       ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0)	\
       : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0))	\
384
   && (IT)->current_x == (IT)->last_visible_x)
Kenichi Handa's avatar
Kenichi Handa committed
385

386 387
#else /* !HAVE_WINDOW_SYSTEM */
#define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
Kenichi Handa's avatar
Kenichi Handa committed
388 389
#endif /* HAVE_WINDOW_SYSTEM */

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/* Test if the display element loaded in IT, or the underlying buffer
   or string character, is a space or a TAB character.  This is used
   to determine where word wrapping can occur.  */

#define IT_DISPLAYING_WHITESPACE(it)					\
  ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))	\
   || ((STRINGP (it->string)						\
	&& (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' '		\
	    || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t'))	\
       || (it->s							\
	   && (it->s[IT_BYTEPOS (*it)] == ' '				\
	       || it->s[IT_BYTEPOS (*it)] == '\t'))			\
       || (IT_BYTEPOS (*it) < ZV_BYTE					\
	   && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' '			\
	       || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t'))))		\
405

Gerd Moellmann's avatar
Gerd Moellmann committed
406 407
/* Name of the face used to highlight trailing whitespace.  */

408
static Lisp_Object Qtrailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
409

410 411
/* Name and number of the face used to highlight escape glyphs.  */

412
static Lisp_Object Qescape_glyph;
413

Juri Linkov's avatar
Juri Linkov committed
414 415
/* Name and number of the face used to highlight non-breaking spaces.  */

416
static Lisp_Object Qnobreak_space;
Juri Linkov's avatar
Juri Linkov committed
417

Gerd Moellmann's avatar
Gerd Moellmann committed
418
/* The symbol `image' which is the car of the lists used to represent
419
   images in Lisp.  Also a tool bar style.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
420 421 422

Lisp_Object Qimage;

Kenichi Handa's avatar
Kenichi Handa committed
423
/* The image map types.  */
424 425 426
Lisp_Object QCmap;
static Lisp_Object QCpointer;
static Lisp_Object Qrect, Qcircle, Qpoly;
Kenichi Handa's avatar
Kenichi Handa committed
427

428
/* Tool bar styles */
429
Lisp_Object Qboth, Qboth_horiz, Qtext_image_horiz;
430

Gerd Moellmann's avatar
Gerd Moellmann committed
431 432
/* Non-zero means print newline to stdout before next mini-buffer
   message.  */
Jim Blandy's avatar
Jim Blandy committed
433

434
bool noninteractive_need_newline;
Jim Blandy's avatar
Jim Blandy committed
435

Gerd Moellmann's avatar
Gerd Moellmann committed
436
/* Non-zero means print newline to message log before next message.  */
437

438
static bool message_log_need_newline;
439

440 441 442 443 444 445
/* Three markers that message_dolog uses.
   It could allocate them itself, but that causes trouble
   in handling memory-full errors.  */
static Lisp_Object message_dolog_marker1;
static Lisp_Object message_dolog_marker2;
static Lisp_Object message_dolog_marker3;
Gerd Moellmann's avatar
Gerd Moellmann committed
446 447 448 449 450

/* The buffer position of the first character appearing entirely or
   partially on the line of the selected window which contains the
   cursor; <= 0 if not known.  Set by set_cursor_from_row, used for
   redisplay optimization in redisplay_internal.  */
Jim Blandy's avatar
Jim Blandy committed
451

Gerd Moellmann's avatar
Gerd Moellmann committed
452
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
453

Gerd Moellmann's avatar
Gerd Moellmann committed
454 455 456 457 458 459
/* Number of characters past the end of the line above, including the
   terminating newline.  */

static struct text_pos this_line_end_pos;

/* The vertical positions and the height of this line.  */
Jim Blandy's avatar
Jim Blandy committed
460 461

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463 464 465 466 467 468
static int this_line_y;
static int this_line_pixel_height;

/* X position at which this display line starts.  Usually zero;
   negative if first character is partially visible.  */

static int this_line_start_x;
Jim Blandy's avatar
Jim Blandy committed
469

470 471 472 473 474 475
/* The smallest character position seen by move_it_* functions as they
   move across display lines.  Used to set MATRIX_ROW_START_CHARPOS of
   hscrolled lines, see display_line.  */

static struct text_pos this_line_min_pos;

Gerd Moellmann's avatar
Gerd Moellmann committed
476
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
477 478 479 480

static struct buffer *this_line_buffer;


Kenichi Handa's avatar
Kenichi Handa committed
481 482 483
/* Values of those variables at last redisplay are stored as
   properties on `overlay-arrow-position' symbol.  However, if
   Voverlay_arrow_position is a marker, last-arrow-position is its
Gerd Moellmann's avatar
Gerd Moellmann committed
484 485
   numerical position.  */

486
static Lisp_Object Qlast_arrow_position, Qlast_arrow_string;
Kenichi Handa's avatar
Kenichi Handa committed
487 488 489 490

/* Alternative overlay-arrow-string and overlay-arrow-bitmap
   properties on a symbol in overlay-arrow-variable-list.  */

491
static Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
492

493
Lisp_Object Qmenu_bar_update_hook;
494

495
/* Nonzero if an overlay arrow has been displayed in this window.  */
Jim Blandy's avatar
Jim Blandy committed
496

497
static bool overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
498

Gerd Moellmann's avatar
Gerd Moellmann committed
499
/* Vector containing glyphs for an ellipsis `...'.  */
Jim Blandy's avatar
Jim Blandy committed
500

Gerd Moellmann's avatar
Gerd Moellmann committed
501
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
502

Gerd Moellmann's avatar
Gerd Moellmann committed
503 504 505 506
/* This is the window where the echo area message was displayed.  It
   is always a mini-buffer window, but it may not be the same window
   currently active as a mini-buffer.  */

507 508
Lisp_Object echo_area_window;

509 510 511 512 513
/* List of pairs (MESSAGE . MULTIBYTE).  The function save_message
   pushes the current message and the value of
   message_enable_multibyte on the stack, the function restore_message
   pops the stack and displays MESSAGE again.  */

514
static Lisp_Object Vmessage_stack;
515

516 517
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
518

519
static bool message_enable_multibyte;
520

521 522 523 524 525
/* Nonzero if we should redraw the mode lines on the next redisplay.
   If it has value REDISPLAY_SOME, then only redisplay the mode lines where
   the `redisplay' bit has been set.  Otherwise, redisplay all mode lines
   (the number used is then only used to track down the cause for this
   full-redisplay).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
526

Jim Blandy's avatar
Jim Blandy committed
527 528
int update_mode_lines;

529 530 531 532 533 534
/* Nonzero if window sizes or contents other than selected-window have changed
   since last redisplay that finished.
   If it has value REDISPLAY_SOME, then only redisplay the windows where
   the `redisplay' bit has been set.  Otherwise, redisplay all windows
   (the number used is then only used to track down the cause for this
   full-redisplay).  */
Gerd Moellmann's avatar
Gerd Moellmann committed
535

Jim Blandy's avatar
Jim Blandy committed
536 537
int windows_or_buffers_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
538 539 540
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

541
static bool line_number_displayed;
542

543 544 545 546
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

547 548
/* Current, index 0, and last displayed echo area message.  Either
   buffers from echo_buffers, or nil to indicate no message.  */
549 550 551

Lisp_Object echo_area_buffer[2];

552
/* The buffers referenced from echo_area_buffer.  */
553 554 555 556 557 558 559 560 561 562

static Lisp_Object echo_buffer[2];

/* A vector saved used in with_area_buffer to reduce consing.  */

static Lisp_Object Vwith_echo_area_save_vector;

/* Non-zero means display_echo_area should display the last echo area
   message again.  Set by redisplay_preserve_echo_area.  */

563
static bool display_last_displayed_message_p;
564 565 566 567

/* Nonzero if echo area is being used by print; zero if being used by
   message.  */

568
static bool message_buf_print;
569

570 571
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

572 573
static Lisp_Object Qinhibit_menubar_update;
static Lisp_Object Qmessage_truncate_lines;
574

575
/* Set to 1 in clear_message to make redisplay_internal aware
576
   of an emptied echo area.  */
577

578
static bool message_cleared_p;
579

Gerd Moellmann's avatar
Gerd Moellmann committed
580 581
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
582

Gerd Moellmann's avatar
Gerd Moellmann committed
583
#define MAX_SCRATCH_GLYPHS 100
584
static struct glyph_row scratch_glyph_row;
Gerd Moellmann's avatar
Gerd Moellmann committed
585
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
586

Gerd Moellmann's avatar
Gerd Moellmann committed
587 588
/* Ascent and height of the last line processed by move_it_to.  */

589
static int last_height;
Gerd Moellmann's avatar
Gerd Moellmann committed
590

591 592
/* Non-zero if there's a help-echo in the echo area.  */

593
bool help_echo_showing_p;
594

Gerd Moellmann's avatar
Gerd Moellmann committed
595
/* The maximum distance to look ahead for text properties.  Values
596
   that are too small let us call compute_char_face and similar
Gerd Moellmann's avatar
Gerd Moellmann committed
597 598 599 600 601 602
   functions too often which is expensive.  Values that are too large
   let us call compute_char_face and alike too often because we
   might not be interested in text properties that far away.  */

#define TEXT_PROP_DISTANCE_LIMIT 100

603 604 605 606 607 608 609 610 611 612
/* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
   iterator state and later restore it.  This is needed because the
   bidi iterator on bidi.c keeps a stacked cache of its states, which
   is really a singleton.  When we use scratch iterator objects to
   move around the buffer, we can cause the bidi cache to be pushed or
   popped, and therefore we need to restore the cache state when we
   return to the original iterator.  */
#define SAVE_IT(ITCOPY,ITORIG,CACHE)		\
  do {						\
    if (CACHE)					\
613
      bidi_unshelve_cache (CACHE, 1);		\
614
    ITCOPY = ITORIG;				\
Juanma Barranquero's avatar
Juanma Barranquero committed
615
    CACHE = bidi_shelve_cache ();		\
616 617 618 619 620 621
  } while (0)

#define RESTORE_IT(pITORIG,pITCOPY,CACHE)	\
  do {						\
    if (pITORIG != pITCOPY)			\
      *(pITORIG) = *(pITCOPY);			\
622
    bidi_unshelve_cache (CACHE, 0);		\
623 624 625
    CACHE = NULL;				\
  } while (0)

626 627 628
/* Functions to mark elements as needing redisplay.  */
enum { REDISPLAY_SOME = 2};	/* Arbitrary choice.  */

629 630
void
redisplay_other_windows (void)
631 632 633 634 635
{
  if (!windows_or_buffers_changed)
    windows_or_buffers_changed = REDISPLAY_SOME;
}

636 637
void
wset_redisplay (struct window *w)
638
{
639 640 641
  /* Beware: selected_window can be nil during early stages.  */
  if (!EQ (make_lisp_ptr (w, Lisp_Vectorlike), selected_window))
    redisplay_other_windows ();
642 643 644
  w->redisplay = true;
}

645 646
void
fset_redisplay (struct frame *f)
647 648 649 650 651
{
  redisplay_other_windows ();
  f->redisplay = true;
}

652 653
void
bset_redisplay (struct buffer *b)
654 655 656 657 658 659 660 661 662 663 664 665 666 667
{
  int count = buffer_window_count (b);
  if (count > 0)
    {
      /* ... it's visible in other window than selected,  */
      if (count > 1 || b != XBUFFER (XWINDOW (selected_window)->contents))
	redisplay_other_windows ();
      /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
	 so that if we later set windows_or_buffers_changed, this buffer will
	 not be omitted.  */
      b->text->redisplay = true;
    }
}

668 669
void
bset_update_mode_line (struct buffer *b)
670 671 672 673 674 675
{
  if (!update_mode_lines)
    update_mode_lines = REDISPLAY_SOME;
  b->text->redisplay = true;
}

676
#ifdef GLYPH_DEBUG
677

Gerd Moellmann's avatar
Gerd Moellmann committed
678
/* Non-zero means print traces of redisplay if compiled with
679
   GLYPH_DEBUG defined.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
680

681
bool trace_redisplay_p;
682

683
#endif /* GLYPH_DEBUG */
684

685 686
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
687 688 689 690
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
691
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
692
#endif
693

694
static Lisp_Object Qauto_hscroll_mode;
695

696 697
/* Buffer being redisplayed -- for redisplay_window_error.  */

698
static struct buffer *displayed_buffer;
699

Gerd Moellmann's avatar
Gerd Moellmann committed
700 701 702
/* Value returned from text property handlers (see below).  */

enum prop_handled
703
{
Gerd Moellmann's avatar
Gerd Moellmann committed
704 705 706 707 708
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
709

Gerd Moellmann's avatar
Gerd Moellmann committed
710 711
/* A description of text properties that redisplay is interested
   in.  */
712

Gerd Moellmann's avatar
Gerd Moellmann committed
713 714 715 716
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
717

Gerd Moellmann's avatar
Gerd Moellmann committed
718 719 720 721 722
  /* A unique index for the property.  */
  enum prop_idx idx;

  /* A handler function called to set up iterator IT from the property
     at IT's current position.  Value is used to steer handle_stop.  */
723
  enum prop_handled (*handler) (struct it *it);
Gerd Moellmann's avatar
Gerd Moellmann committed
724 725
};

726 727 728 729 730 731
static enum prop_handled handle_face_prop (struct it *);
static enum prop_handled handle_invisible_prop (struct it *);
static enum prop_handled handle_display_prop (struct it *);
static enum prop_handled handle_composition_prop (struct it *);
static enum prop_handled handle_overlay_change (struct it *);
static enum prop_handled handle_fontified_prop (struct it *);
Gerd Moellmann's avatar
Gerd Moellmann committed
732 733 734 735

/* Properties handled by iterators.  */

static struct props it_props[] =
Karl Heuer's avatar
Karl Heuer committed
736
{
Gerd Moellmann's avatar
Gerd Moellmann committed
737 738 739 740 741 742
  {&Qfontified,		FONTIFIED_PROP_IDX,	handle_fontified_prop},
  /* Handle `face' before `display' because some sub-properties of
     `display' need to know the face.  */
  {&Qface,		FACE_PROP_IDX,		handle_face_prop},
  {&Qdisplay,		DISPLAY_PROP_IDX,	handle_display_prop},
  {&Qinvisible,		INVISIBLE_PROP_IDX,	handle_invisible_prop},
743
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
744 745
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
746

Gerd Moellmann's avatar
Gerd Moellmann committed
747 748
/* Value is the position described by X.  If X is a marker, value is
   the marker_position of X.  Otherwise, value is X.  */
749

Gerd Moellmann's avatar
Gerd Moellmann committed
750
#define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
751

Gerd Moellmann's avatar
Gerd Moellmann committed
752
/* Enumeration returned by some move_it_.* functions internally.  */
753

Gerd Moellmann's avatar
Gerd Moellmann committed
754 755 756 757
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
758

Gerd Moellmann's avatar
Gerd Moellmann committed
759 760
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
761

Gerd Moellmann's avatar
Gerd Moellmann committed
762 763
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
764

Gerd Moellmann's avatar
Gerd Moellmann committed
765 766 767
  /* Move within a line ended at the end of a line that must be
     continued.  */
  MOVE_LINE_CONTINUED,
768

Gerd Moellmann's avatar
Gerd Moellmann committed
769 770 771
  /* Move within a line ended at the end of a line that would
     be displayed truncated.  */
  MOVE_LINE_TRUNCATED,
772

Gerd Moellmann's avatar
Gerd Moellmann committed
773 774 775
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
776

777 778 779 780 781 782 783 784
/* This counter is used to clear the face cache every once in a while
   in redisplay_internal.  It is incremented for each redisplay.
   Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
   cleared.  */

#define CLEAR_FACE_CACHE_COUNT	500
static int clear_face_cache_count;

785 786 787 788 789
/* Similarly for the image cache.  */

#ifdef HAVE_WINDOW_SYSTEM
#define CLEAR_IMAGE_CACHE_COUNT	101
static int clear_image_cache_count;
Eli Zaretskii's avatar
Eli Zaretskii committed
790 791 792

/* Null glyph slice */
static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
793 794
#endif

795
/* True while redisplay_internal is in progress.  */
796

797
bool redisplaying_p;
798

799
static Lisp_Object Qinhibit_free_realized_faces;
800
static Lisp_Object Qmode_line_default_help_echo;
801

802 803 804 805 806 807
/* If a string, XTread_socket generates an event to display that string.
   (The display is done in read_char.)  */

Lisp_Object help_echo_string;
Lisp_Object help_echo_window;
Lisp_Object help_echo_object;
808
ptrdiff_t help_echo_pos;
809 810 811 812 813

/* Temporary variable for XTread_socket.  */

Lisp_Object previous_help_echo_string;

814
/* Platform-independent portion of hourglass implementation.  */
815

816 817
#ifdef HAVE_WINDOW_SYSTEM

818
/* Non-zero means an hourglass cursor is currently shown.  */
819
bool hourglass_shown_p;
820 821

/* If non-null, an asynchronous timer that, when it expires, displays
822
   an hourglass cursor on all frames.  */
823 824
struct atimer *hourglass_atimer;

825 826
#endif /* HAVE_WINDOW_SYSTEM */

827
/* Name of the face used to display glyphless characters.  */
828
static Lisp_Object Qglyphless_char;
829 830

/* Symbol for the purpose of Vglyphless_char_display.  */
831
static Lisp_Object Qglyphless_char_display;
832 833

/* Method symbols for Vglyphless_char_display.  */
834
static Lisp_Object Qhex_code, Qempty_box, Qthin_space, Qzero_width;
835

836 837 838 839
/* Default number of seconds to wait before displaying an hourglass
   cursor.  */
#define DEFAULT_HOURGLASS_DELAY 1

840 841 842 843 844 845 846
#ifdef HAVE_WINDOW_SYSTEM

/* Default pixel width of `thin-space' display method.  */
#define THIN_SPACE_WIDTH 1

#endif /* HAVE_WINDOW_SYSTEM */

Gerd Moellmann's avatar
Gerd Moellmann committed
847 848
/* Function prototypes.  */

849
static void setup_for_ellipsis (struct it *, int);
850
static void set_iterator_to_next (struct it *, int);
851 852 853
static void mark_window_display_accurate_1 (struct window *, int);
static int single_display_spec_string_p (Lisp_Object, Lisp_Object);
static int display_prop_string_p (Lisp_Object, Lisp_Object);
854
static int row_for_charpos_p (struct glyph_row *, ptrdiff_t);
855
static int cursor_row_p (struct glyph_row *);
856
static int redisplay_mode_lines (Lisp_Object, bool);
857 858 859 860 861 862
static char *decode_mode_spec_coding (Lisp_Object, char *, int);

static Lisp_Object get_it_property (struct it *it, Lisp_Object prop);

static void handle_line_prefix (struct it *);

863 864
static void pint2str (char *, int, ptrdiff_t);
static void pint2hrstr (char *, int, ptrdiff_t);
865 866
static struct text_pos run_window_scroll_functions (Lisp_Object,
                                                    struct text_pos);
867
static int text_outside_line_unchanged_p (struct window *,
868
					  ptrdiff_t, ptrdiff_t);
869
static void store_mode_line_noprop_char (char);
870
static int store_mode_line_noprop (const char *, int, int);
871
static void handle_stop (struct it *);
872
static void handle_stop_backwards (struct it *, ptrdiff_t);
873
static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
874
static void ensure_echo_area_buffers (void);
875
static void unwind_with_echo_area_buffer (Lisp_Object);
876 877
static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
static int with_echo_area_buffer (struct window *, int,
878 879
                                  int (*) (ptrdiff_t, Lisp_Object),
                                  ptrdiff_t, Lisp_Object);
880
static void clear_garbaged_frames (void);
881 882 883 884
static int current_message_1 (ptrdiff_t, Lisp_Object);
static int truncate_message_1 (ptrdiff_t, Lisp_Object);
static void set_message (Lisp_Object);
static int set_message_1 (ptrdiff_t, Lisp_Object);
885
static int display_echo_area (struct window *);
886 887
static int display_echo_area_1 (ptrdiff_t, Lisp_Object);
static int resize_mini_window_1 (ptrdiff_t, Lisp_Object);
888
static void unwind_redisplay (void);
889 890 891 892 893 894 895 896 897 898
static int string_char_and_length (const unsigned char *, int *);
static struct text_pos display_prop_end (struct it *, Lisp_Object,
                                         struct text_pos);
static int compute_window_start_on_continuation_line (struct window *);
static void insert_left_trunc_glyphs (struct it *);
static struct glyph_row *get_overlay_arrow_glyph_row (struct window *,
                                                      Lisp_Object);
static void extend_face_to_end_of_line (struct it *);
static int append_space_for_newline (struct it *, int);
static int cursor_row_fully_visible_p (struct window *, int, int);
899
static int try_scrolling (Lisp_Object, int, ptrdiff_t, ptrdiff_t, int, int);
900
static int try_cursor_movement (Lisp_Object, struct text_pos, int *);
901 902
static int trailing_whitespace_p (ptrdiff_t);
static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
903
static void push_it (struct it *, struct text_pos *);
904
static void iterate_out_of_display_property (struct it *);
905 906
static void pop_it (struct it *);
static void sync_frame_with_window_matrix_rows (struct window *);
907
static void redisplay_internal (void);
908 909
static int echo_area_display (int);
static void redisplay_windows (Lisp_Object);
910
static void redisplay_window (Lisp_Object, bool);
911
static Lisp_Object redisplay_window_error (Lisp_Object);
912 913
static Lisp_Object redisplay_window_0 (Lisp_Object);
static Lisp_Object redisplay_window_1 (Lisp_Object);
914
static int set_cursor_from_row (struct window *, struct glyph_row *,
915
				struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
916
				int, int);
917 918 919 920 921 922 923
static int update_menu_bar (struct frame *, int, int);
static int try_window_reusing_current_matrix (struct window *);
static int try_window_id (struct window *);
static int display_line (struct it *);
static int display_mode_lines (struct window *);
static int display_mode_line (struct window *, enum face_id, Lisp_Object);
static int display_mode_element (struct it *, int, int, int, Lisp_Object, Lisp_Object, int);
924
static int store_mode_line_string (const char *, Lisp_Object, int, int, int, Lisp_Object);
925
static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
926
static void display_menu_bar (struct window *);
927 928
static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
				      ptrdiff_t *);
929
static int display_string (const char *, Lisp_Object, Lisp_Object,
930
                           ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
931 932
static void compute_line_metrics (struct it *);
static void run_redisplay_end_trigger_hook (struct it *);
933 934
static int get_overlay_strings (struct it *, ptrdiff_t);
static int get_overlay_strings_1 (struct it *, ptrdiff_t, int);
935 936 937 938 939 940 941 942 943 944 945 946 947
static void next_overlay_string (struct it *);
static void reseat (struct it *, struct text_pos, int);
static void reseat_1 (struct it *, struct text_pos, int);
static void back_to_previous_visible_line_start (struct it *);
static void reseat_at_next_visible_line_start (struct it *, int);
static int next_element_from_ellipsis (struct it *);
static int next_element_from_display_vector (struct it *);
static int next_element_from_string (struct it *);
static int next_element_from_c_string (struct it *);
static int next_element_from_buffer (struct it *);
static int next_element_from_composition (struct it *);
static int next_element_from_image (struct it *);
static int next_element_from_stretch (struct it *);
948
static void load_overlay_strings (struct it *, ptrdiff_t);
949 950
static int init_from_display_pos (struct it *, struct window *,
                                  struct display_pos *);
951
static void reseat_to_string (struct it *, const char *,
952
                              Lisp_Object, ptrdiff_t, ptrdiff_t, int, int);
953
static int get_next_display_element (struct it *);
954
static enum move_it_result
955
       move_it_in_display_line_to (struct it *, ptrdiff_t, int,
956
				   enum move_operation_enum);
957
static void get_visually_first_element (struct it *);
958 959 960 961 962
static void init_to_row_start (struct it *, struct window *,
                               struct glyph_row *);
static int init_to_row_end (struct it *, struct window *,
                            struct glyph_row *);
static void back_to_previous_line_start (struct it *);
963
static int forward_to_next_line_start (struct it *, int *, struct bidi_it *);
964
static struct text_pos string_pos_nchars_ahead (struct text_pos,
965 966
                                                Lisp_Object, ptrdiff_t);
static struct text_pos string_pos (ptrdiff_t, Lisp_Object);
967 968
static struct text_pos c_string_pos (ptrdiff_t, const char *, bool);
static ptrdiff_t number_of_chars (const char *, bool);
969 970 971 972
static void compute_stop_pos (struct it *);
static void compute_string_pos (struct text_pos *, struct text_pos,
                                Lisp_Object);
static int face_before_or_after_it_pos (struct it *, int);
973
static ptrdiff_t next_overlay_change (ptrdiff_t);
974
static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
975
				Lisp_Object, struct text_pos *, ptrdiff_t, int);
976 977
static int handle_single_display_spec (struct it *, Lisp_Object,
                                       Lisp_Object, Lisp_Object,
978
                                       struct text_pos *, ptrdiff_t, int, int);
979 980 981
static int underlying_face_id (struct it *);
static int in_ellipses_for_invisible_text_p (struct display_pos *,
                                             struct window *);
Gerd Moellmann's avatar
Gerd Moellmann committed
982 983 984

#define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
#define face_after_it_pos(IT)  face_before_or_after_it_pos ((IT), 0)
985

Gerd Moellmann's avatar
Gerd Moellmann committed
986
#ifdef HAVE_WINDOW_SYSTEM
987

988
static void x_consider_frame_title (Lisp_Object);
989 990
static void update_tool_bar (struct frame *, int);
static int redisplay_tool_bar (struct frame *);
991
static void x_draw_bottom_divider (struct window *w);
992 993 994 995 996
static void notice_overwritten_cursor (struct window *,
                                       enum glyph_row_area,
                                       int, int, int, int);
static void append_stretch_glyph (struct it *, Lisp_Object,
                                  int, int, int);
997

998

Gerd Moellmann's avatar
Gerd Moellmann committed
999
#endif /* HAVE_WINDOW_SYSTEM */
1000

1001
static void produce_special_glyphs (struct it *, enum display_element_type);
1002
static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
1003
static bool coords_in_mouse_face_p (struct window *, int, int);
1004 1005


Gerd Moellmann's avatar
Gerd Moellmann committed
1006 1007 1008 1009

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
1010

1011 1012 1013 1014 1015
/* Return the bottom boundary y-position for text lines in window W.
   This is the first y position at which a line cannot start.
   It is relative to the top of the window.

   This is the height of W minus the height of a mode line, if any.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1016