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

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

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

Gerd Moellmann's avatar
Gerd Moellmann committed
20 21 22 23 24 25 26 27 28 29 30 31 32
/* 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'
33
   in xdisp.c is the only entry into the inner redisplay code.
Gerd Moellmann's avatar
Gerd Moellmann committed
34 35 36 37 38 39 40 41 42 43 44

   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.

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

57
   What does redisplay do?  Obviously, it has to figure out somehow what
Gerd Moellmann's avatar
Gerd Moellmann committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
   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
78
   You will find a lot of redisplay optimizations when you start
Gerd Moellmann's avatar
Gerd Moellmann committed
79 80
   looking at the innards of redisplay.  The overall goal of all these
   optimizations is to make redisplay fast because it is done
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
   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
      changed, and redraws the rest.

    . 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
114 115 116 117 118 119 120 121 122 123 124 125 126 127

   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
128
   interface functions taking an iterator structure (struct it)
Gerd Moellmann's avatar
Gerd Moellmann committed
129 130
   argument.

Pavel Janík's avatar
Pavel Janík committed
131
   Iteration over things to be displayed is then simple.  It is
132 133 134 135 136 137 138
   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
139 140 141 142 143 144 145 146 147 148
   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
149 150
   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
151 152 153
   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
154 155 156 157 158
   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
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

   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
179 180 181 182 183 184 185 186 187 188
   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
189
   concerned, the effect of calling bidi_move_to_visually_next, the
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
   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
219
   glyph of a suitably computed width.  Both the blanks and the
220 221
   stretch glyph are given the face of the background of the line.
   This way, the terminal-specific back-end can still draw the glyphs
222 223
   left to right, even for R2L lines.

224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
   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

254 255 256 257 258 259 260
   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
261
   delivers.  This is important when functions from the move_it_*
262 263 264 265 266 267 268 269 270 271
   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
272

273
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
274
#include <stdio.h>
275
#include <limits.h>
276

Jim Blandy's avatar
Jim Blandy committed
277
#include "lisp.h"
278
#include "atimer.h"
279
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
280
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
281 282 283
#include "window.h"
#include "termchar.h"
#include "dispextern.h"
Kenichi Handa's avatar
Kenichi Handa committed
284
#include "character.h"
285
#include "buffer.h"
286
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
287 288
#include "indent.h"
#include "commands.h"
289
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
290 291
#include "macros.h"
#include "disptab.h"
292
#include "termhooks.h"
293
#include "termopts.h"
294
#include "intervals.h"
295 296
#include "coding.h"
#include "process.h"
Andreas Schwab's avatar
Andreas Schwab committed
297
#include "region-cache.h"
Kenichi Handa's avatar
Kenichi Handa committed
298
#include "font.h"
Dave Love's avatar
Dave Love committed
299
#include "fontset.h"
300
#include "blockinput.h"
301 302 303
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
304

305 306 307 308
#ifndef FRAME_X_OUTPUT
#define FRAME_X_OUTPUT(f) ((f)->output_data.x)
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
309 310
#define INFINITY 10000000

311
Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
312
Lisp_Object Qwindow_scroll_functions;
313 314
static Lisp_Object Qwindow_text_change_functions;
static Lisp_Object Qredisplay_end_trigger_functions;
315
Lisp_Object Qinhibit_point_motion_hooks;
316 317 318 319 320 321 322
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
323

324
/* Cursor shapes.  */
325 326
Lisp_Object Qbar, Qhbar, Qbox, Qhollow;

327
/* Pointer shapes.  */
328 329
static Lisp_Object Qarrow, Qhand;
Lisp_Object Qtext;
Kenichi Handa's avatar
Kenichi Handa committed
330

331
/* Holds the list (error).  */
332
static Lisp_Object list_of_error;
333

334
static Lisp_Object Qfontification_functions;
Gerd Moellmann's avatar
Gerd Moellmann committed
335

336 337
static Lisp_Object Qwrap_prefix;
static Lisp_Object Qline_prefix;
338
static Lisp_Object Qredisplay_internal;
339

340 341
/* Non-nil means don't actually do any redisplay.  */

342
Lisp_Object Qinhibit_redisplay;
343

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

Kenichi Handa's avatar
Kenichi Handa committed
346
Lisp_Object Qdisplay;
Gerd Moellmann's avatar
Gerd Moellmann committed
347

348 349 350 351 352
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
353
Lisp_Object Qcenter;
354 355
static Lisp_Object Qmargin, Qpointer;
static Lisp_Object Qline_height;
Gerd Moellmann's avatar
Gerd Moellmann committed
356

Kenichi Handa's avatar
Kenichi Handa committed
357 358 359 360 361
#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.  */

362 363 364 365 366 367
#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))	\
368
   && (IT)->current_x == (IT)->last_visible_x)
Kenichi Handa's avatar
Kenichi Handa committed
369

370 371
#else /* !HAVE_WINDOW_SYSTEM */
#define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
Kenichi Handa's avatar
Kenichi Handa committed
372 373
#endif /* HAVE_WINDOW_SYSTEM */

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
/* 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'))))		\
389

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

392
static Lisp_Object Qtrailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
393

394 395
/* Name and number of the face used to highlight escape glyphs.  */

396
static Lisp_Object Qescape_glyph;
397

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

400
static Lisp_Object Qnobreak_space;
Juri Linkov's avatar
Juri Linkov committed
401

Gerd Moellmann's avatar
Gerd Moellmann committed
402
/* The symbol `image' which is the car of the lists used to represent
403
   images in Lisp.  Also a tool bar style.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
404 405 406

Lisp_Object Qimage;

Kenichi Handa's avatar
Kenichi Handa committed
407
/* The image map types.  */
408 409 410
Lisp_Object QCmap;
static Lisp_Object QCpointer;
static Lisp_Object Qrect, Qcircle, Qpoly;
Kenichi Handa's avatar
Kenichi Handa committed
411

412
/* Tool bar styles */
413
Lisp_Object Qboth, Qboth_horiz, Qtext_image_horiz;
414

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

418
bool noninteractive_need_newline;
Jim Blandy's avatar
Jim Blandy committed
419

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

422
static bool message_log_need_newline;
423

424 425 426 427 428 429
/* 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
430 431 432 433 434

/* 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
435

Gerd Moellmann's avatar
Gerd Moellmann committed
436
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
437

Gerd Moellmann's avatar
Gerd Moellmann committed
438 439 440 441 442 443
/* 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
444 445

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
446 447 448 449 450 451 452
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
453

454 455 456 457 458 459
/* 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
460
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
461 462 463 464

static struct buffer *this_line_buffer;


Kenichi Handa's avatar
Kenichi Handa committed
465 466 467
/* 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
468 469
   numerical position.  */

470
static Lisp_Object Qlast_arrow_position, Qlast_arrow_string;
Kenichi Handa's avatar
Kenichi Handa committed
471 472 473 474

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

475
static Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
476

477
Lisp_Object Qmenu_bar_update_hook;
478

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

481
static bool overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
482

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

Gerd Moellmann's avatar
Gerd Moellmann committed
485
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
486

Gerd Moellmann's avatar
Gerd Moellmann committed
487 488 489 490
/* 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.  */

491 492
Lisp_Object echo_area_window;

493 494 495 496 497
/* 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.  */

498
static Lisp_Object Vmessage_stack;
499

500 501
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
502

503
static bool message_enable_multibyte;
504

505
/* Nonzero if we should redraw the mode lines on the next redisplay.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
506

Jim Blandy's avatar
Jim Blandy committed
507 508
int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
509
/* Nonzero if window sizes or contents have changed since last
510
   redisplay that finished.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
511

Jim Blandy's avatar
Jim Blandy committed
512 513
int windows_or_buffers_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
514 515 516
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

517
static bool line_number_displayed;
518

519 520 521 522
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

523 524
/* Current, index 0, and last displayed echo area message.  Either
   buffers from echo_buffers, or nil to indicate no message.  */
525 526 527

Lisp_Object echo_area_buffer[2];

528
/* The buffers referenced from echo_area_buffer.  */
529 530 531 532 533 534 535 536 537 538

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

539
static bool display_last_displayed_message_p;
540 541 542 543

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

544
static bool message_buf_print;
545

546 547
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

548 549
static Lisp_Object Qinhibit_menubar_update;
static Lisp_Object Qmessage_truncate_lines;
550

551
/* Set to 1 in clear_message to make redisplay_internal aware
552
   of an emptied echo area.  */
553

554
static bool message_cleared_p;
555

Gerd Moellmann's avatar
Gerd Moellmann committed
556 557
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
558

Gerd Moellmann's avatar
Gerd Moellmann committed
559
#define MAX_SCRATCH_GLYPHS 100
560
static struct glyph_row scratch_glyph_row;
Gerd Moellmann's avatar
Gerd Moellmann committed
561
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
562

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

565
static int last_height;
Gerd Moellmann's avatar
Gerd Moellmann committed
566

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

569
bool help_echo_showing_p;
570

Gerd Moellmann's avatar
Gerd Moellmann committed
571
/* The maximum distance to look ahead for text properties.  Values
572
   that are too small let us call compute_char_face and similar
Gerd Moellmann's avatar
Gerd Moellmann committed
573 574 575 576 577 578
   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

579 580 581 582 583 584 585 586 587 588
/* 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)					\
589
      bidi_unshelve_cache (CACHE, 1);		\
590
    ITCOPY = ITORIG;				\
Juanma Barranquero's avatar
Juanma Barranquero committed
591
    CACHE = bidi_shelve_cache ();		\
592 593 594 595 596 597
  } while (0)

#define RESTORE_IT(pITORIG,pITCOPY,CACHE)	\
  do {						\
    if (pITORIG != pITCOPY)			\
      *(pITORIG) = *(pITCOPY);			\
598
    bidi_unshelve_cache (CACHE, 0);		\
599 600 601
    CACHE = NULL;				\
  } while (0)

602
#ifdef GLYPH_DEBUG
603

Gerd Moellmann's avatar
Gerd Moellmann committed
604
/* Non-zero means print traces of redisplay if compiled with
605
   GLYPH_DEBUG defined.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
606 607

int trace_redisplay_p;
608

609
#endif /* GLYPH_DEBUG */
610

611 612
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
613 614 615 616
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
617
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
618
#endif
619

620
static Lisp_Object Qauto_hscroll_mode;
621

622 623
/* Buffer being redisplayed -- for redisplay_window_error.  */

624
static struct buffer *displayed_buffer;
625

Gerd Moellmann's avatar
Gerd Moellmann committed
626 627 628
/* Value returned from text property handlers (see below).  */

enum prop_handled
629
{
Gerd Moellmann's avatar
Gerd Moellmann committed
630 631 632 633 634
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
635

Gerd Moellmann's avatar
Gerd Moellmann committed
636 637
/* A description of text properties that redisplay is interested
   in.  */
638

Gerd Moellmann's avatar
Gerd Moellmann committed
639 640 641 642
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
643

Gerd Moellmann's avatar
Gerd Moellmann committed
644 645 646 647 648
  /* 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.  */
649
  enum prop_handled (*handler) (struct it *it);
Gerd Moellmann's avatar
Gerd Moellmann committed
650 651
};

652 653 654 655 656 657
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
658 659 660 661

/* Properties handled by iterators.  */

static struct props it_props[] =
Karl Heuer's avatar
Karl Heuer committed
662
{
Gerd Moellmann's avatar
Gerd Moellmann committed
663 664 665 666 667 668
  {&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},
669
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
670 671
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
672

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
680 681 682 683
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
684

Gerd Moellmann's avatar
Gerd Moellmann committed
685 686
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
687

Gerd Moellmann's avatar
Gerd Moellmann committed
688 689
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
690

Gerd Moellmann's avatar
Gerd Moellmann committed
691 692 693
  /* Move within a line ended at the end of a line that must be
     continued.  */
  MOVE_LINE_CONTINUED,
694

Gerd Moellmann's avatar
Gerd Moellmann committed
695 696 697
  /* Move within a line ended at the end of a line that would
     be displayed truncated.  */
  MOVE_LINE_TRUNCATED,
698

Gerd Moellmann's avatar
Gerd Moellmann committed
699 700 701
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
702

703 704 705 706 707 708 709 710
/* 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;

711 712 713 714 715
/* 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
716 717 718

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

721
/* True while redisplay_internal is in progress.  */
722

723
bool redisplaying_p;
724

725
static Lisp_Object Qinhibit_free_realized_faces;
726
static Lisp_Object Qmode_line_default_help_echo;
727

728 729 730 731 732 733
/* 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;
734
ptrdiff_t help_echo_pos;
735 736 737 738 739

/* Temporary variable for XTread_socket.  */

Lisp_Object previous_help_echo_string;

740 741
/* Platform-independent portion of hourglass implementation. */

742 743
#ifdef HAVE_WINDOW_SYSTEM

744
/* Non-zero means an hourglass cursor is currently shown.  */
745
bool hourglass_shown_p;
746 747

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

751 752
#endif /* HAVE_WINDOW_SYSTEM */

753
/* Name of the face used to display glyphless characters.  */
754
static Lisp_Object Qglyphless_char;
755 756

/* Symbol for the purpose of Vglyphless_char_display.  */
757
static Lisp_Object Qglyphless_char_display;
758 759

/* Method symbols for Vglyphless_char_display.  */
760
static Lisp_Object Qhex_code, Qempty_box, Qthin_space, Qzero_width;
761

762 763 764 765
/* Default number of seconds to wait before displaying an hourglass
   cursor.  */
#define DEFAULT_HOURGLASS_DELAY 1

766 767 768 769 770 771 772
#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
773 774
/* Function prototypes.  */

775
static void setup_for_ellipsis (struct it *, int);
776
static void set_iterator_to_next (struct it *, int);
777 778 779
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);
780
static int row_for_charpos_p (struct glyph_row *, ptrdiff_t);
781
static int cursor_row_p (struct glyph_row *);
782 783 784 785 786 787 788
static int redisplay_mode_lines (Lisp_Object, int);
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 *);

789 790
static void pint2str (char *, int, ptrdiff_t);
static void pint2hrstr (char *, int, ptrdiff_t);
791 792
static struct text_pos run_window_scroll_functions (Lisp_Object,
                                                    struct text_pos);
793
static int text_outside_line_unchanged_p (struct window *,
794
					  ptrdiff_t, ptrdiff_t);
795
static void store_mode_line_noprop_char (char);
796
static int store_mode_line_noprop (const char *, int, int);
797
static void handle_stop (struct it *);
798
static void handle_stop_backwards (struct it *, ptrdiff_t);
799
static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
800
static void ensure_echo_area_buffers (void);
801
static void unwind_with_echo_area_buffer (Lisp_Object);
802 803
static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
static int with_echo_area_buffer (struct window *, int,
804 805
                                  int (*) (ptrdiff_t, Lisp_Object),
                                  ptrdiff_t, Lisp_Object);
806
static void clear_garbaged_frames (void);
807 808 809 810
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);
811
static int display_echo_area (struct window *);
812 813
static int display_echo_area_1 (ptrdiff_t, Lisp_Object);
static int resize_mini_window_1 (ptrdiff_t, Lisp_Object);
814
static void unwind_redisplay (void);
815 816 817 818 819 820 821 822 823 824
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);
825
static int try_scrolling (Lisp_Object, int, ptrdiff_t, ptrdiff_t, int, int);
826
static int try_cursor_movement (Lisp_Object, struct text_pos, int *);
827 828
static int trailing_whitespace_p (ptrdiff_t);
static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
829
static void push_it (struct it *, struct text_pos *);
830
static void iterate_out_of_display_property (struct it *);
831 832
static void pop_it (struct it *);
static void sync_frame_with_window_matrix_rows (struct window *);
833
static void redisplay_internal (void);
834 835 836
static int echo_area_display (int);
static void redisplay_windows (Lisp_Object);
static void redisplay_window (Lisp_Object, int);
837
static Lisp_Object redisplay_window_error (Lisp_Object);
838 839
static Lisp_Object redisplay_window_0 (Lisp_Object);
static Lisp_Object redisplay_window_1 (Lisp_Object);
840
static int set_cursor_from_row (struct window *, struct glyph_row *,
841
				struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
842
				int, int);
843 844 845 846 847 848 849
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);
850
static int store_mode_line_string (const char *, Lisp_Object, int, int, int, Lisp_Object);
851
static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
852
static void display_menu_bar (struct window *);
853 854
static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
				      ptrdiff_t *);
855
static int display_string (const char *, Lisp_Object, Lisp_Object,
856
                           ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
857 858
static void compute_line_metrics (struct it *);
static void run_redisplay_end_trigger_hook (struct it *);
859 860
static int get_overlay_strings (struct it *, ptrdiff_t);
static int get_overlay_strings_1 (struct it *, ptrdiff_t, int);
861 862 863 864 865 866 867 868 869 870 871 872 873
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 *);
874
static void load_overlay_strings (struct it *, ptrdiff_t);
875 876
static int init_from_display_pos (struct it *, struct window *,
                                  struct display_pos *);
877
static void reseat_to_string (struct it *, const char *,
878
                              Lisp_Object, ptrdiff_t, ptrdiff_t, int, int);
879
static int get_next_display_element (struct it *);
880
static enum move_it_result
881
       move_it_in_display_line_to (struct it *, ptrdiff_t, int,
882
				   enum move_operation_enum);
883
static void get_visually_first_element (struct it *);
884 885 886 887 888
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 *);
889
static int forward_to_next_line_start (struct it *, int *, struct bidi_it *);
890
static struct text_pos string_pos_nchars_ahead (struct text_pos,
891 892
                                                Lisp_Object, ptrdiff_t);
static struct text_pos string_pos (ptrdiff_t, Lisp_Object);
893 894
static struct text_pos c_string_pos (ptrdiff_t, const char *, bool);
static ptrdiff_t number_of_chars (const char *, bool);
895 896 897 898
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);
899
static ptrdiff_t next_overlay_change (ptrdiff_t);
900
static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
901
				Lisp_Object, struct text_pos *, ptrdiff_t, int);
902 903
static int handle_single_display_spec (struct it *, Lisp_Object,
                                       Lisp_Object, Lisp_Object,
904
                                       struct text_pos *, ptrdiff_t, int, int);
905 906 907
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
908 909 910

#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)
911

Gerd Moellmann's avatar
Gerd Moellmann committed
912
#ifdef HAVE_WINDOW_SYSTEM
913

914
static void x_consider_frame_title (Lisp_Object);
915 916 917 918 919 920 921
static void update_tool_bar (struct frame *, int);
static int redisplay_tool_bar (struct frame *);
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);
922

923

Gerd Moellmann's avatar
Gerd Moellmann committed
924
#endif /* HAVE_WINDOW_SYSTEM */
925

926
static void produce_special_glyphs (struct it *, enum display_element_type);
927
static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
928 929 930
static int coords_in_mouse_face_p (struct window *, int, int);


Gerd Moellmann's avatar
Gerd Moellmann committed
931 932 933 934

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
935

936 937 938 939 940
/* 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
941

942
int
943
window_text_bottom_y (struct window *w)
Gerd Moellmann's avatar
Gerd Moellmann committed
944
{
945
  int height = WINDOW_TOTAL_HEIGHT (w);
946

Gerd Moellmann's avatar
Gerd Moellmann committed
947 948 949
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
950 951
}

952 953 954
/* Return the pixel width of display area AREA of window W.
   ANY_AREA means return the total width of W, not including
   fringes to the left and right of the window.  */
955

956
int
957
window_box_width (struct window *w, enum glyph_row_area area)
Gerd Moellmann's avatar
Gerd Moellmann committed
958
{
959
  int cols = w->total_cols;
960
  int pixels = 0;
961

Gerd Moellmann's avatar
Gerd Moellmann committed
962
  if (!w->pseudo_window_p)
963
    {
964
      cols -= WINDOW_SCROLL_BAR_COLS (w);
965

Gerd Moellmann's avatar
Gerd Moellmann committed
966 967
      if (area == TEXT_AREA)
	{
968 969
	  cols -= max (0, w->left_margin_cols);
	  cols -= max (0, w->right_margin_cols);
970
	  pixels = -WINDOW_TOTAL_FRINGE_WIDTH (w);
Gerd Moellmann's avatar
Gerd Moellmann committed
971 972
	}
      else if (area == LEFT_MARGIN_AREA)
973
	{
974
	  cols = max (0, w->left_margin_cols);
975 976
	  pixels = 0;
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
977
      else if (area == RIGHT_MARGIN_AREA)
978
	{
979
	  cols = max (0, w->right_margin_cols);
980 981
	  pixels = 0;
	}
982
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
983

984