xdisp.c 783 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Display generation from window structure and buffer text.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003,
Eli Zaretskii's avatar
Eli Zaretskii committed
4 5
                 2004, 2005, 2006, 2007, 2008, 2009, 2010
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

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

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

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

   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.

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

59
   What does redisplay do?  Obviously, it has to figure out somehow what
Gerd Moellmann's avatar
Gerd Moellmann committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
   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
80
   You will find a lot of redisplay optimizations when you start
Gerd Moellmann's avatar
Gerd Moellmann committed
81 82
   looking at the innards of redisplay.  The overall goal of all these
   optimizations is to make redisplay fast because it is done
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 114 115
   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
116 117 118 119 120 121 122 123 124 125 126 127 128 129

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

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

   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
177 178 179 180 181 182 183 184 185 186
   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
187
   concerned, the effect of calling bidi_move_to_visually_next, the
188 189 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 219 220
   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
   glyph with suitably computed width.  Both the blanks and the
   stretch glyph are given the face of the background of the line.
   This way, the terminal-specific back-end can still draw the glyphs
   left to right, even for R2L lines.  */
Jim Blandy's avatar
Jim Blandy committed
221

222
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
223
#include <stdio.h>
224
#include <limits.h>
225
#include <setjmp.h>
226

Jim Blandy's avatar
Jim Blandy committed
227
#include "lisp.h"
228
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
229
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
230 231 232 233
#include "window.h"
#include "termchar.h"
#include "dispextern.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
234
#include "character.h"
235
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
236 237
#include "indent.h"
#include "commands.h"
238
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
239 240
#include "macros.h"
#include "disptab.h"
241
#include "termhooks.h"
242
#include "termopts.h"
243
#include "intervals.h"
244 245
#include "coding.h"
#include "process.h"
Andreas Schwab's avatar
Andreas Schwab committed
246
#include "region-cache.h"
Kenichi Handa's avatar
Kenichi Handa committed
247
#include "font.h"
Dave Love's avatar
Dave Love committed
248
#include "fontset.h"
249
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
250

251
#ifdef HAVE_X_WINDOWS
Andreas Schwab's avatar
Andreas Schwab committed
252 253
#include "xterm.h"
#endif
254 255 256
#ifdef WINDOWSNT
#include "w32term.h"
#endif
257 258 259
#ifdef HAVE_NS
#include "nsterm.h"
#endif
260 261 262
#ifdef USE_GTK
#include "gtkutil.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
263

264 265
#include "font.h"

266 267 268 269
#ifndef FRAME_X_OUTPUT
#define FRAME_X_OUTPUT(f) ((f)->output_data.x)
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
270 271
#define INFINITY 10000000

272
Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
273
Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
274
Lisp_Object Qwindow_text_change_functions, Vwindow_text_change_functions;
275
Lisp_Object Qredisplay_end_trigger_functions, Vredisplay_end_trigger_functions;
276
Lisp_Object Qinhibit_point_motion_hooks;
277
Lisp_Object QCeval, QCfile, QCdata, QCpropertize;
Gerd Moellmann's avatar
Gerd Moellmann committed
278
Lisp_Object Qfontified;
279
Lisp_Object Qgrow_only;
280
Lisp_Object Qinhibit_eval_during_redisplay;
281
Lisp_Object Qbuffer_position, Qposition, Qobject;
282
Lisp_Object Qright_to_left, Qleft_to_right;
Gerd Moellmann's avatar
Gerd Moellmann committed
283

284 285 286
/* Cursor shapes */
Lisp_Object Qbar, Qhbar, Qbox, Qhollow;

Kenichi Handa's avatar
Kenichi Handa committed
287 288 289
/* Pointer shapes */
Lisp_Object Qarrow, Qhand, Qtext;

290 291
Lisp_Object Qrisky_local_variable;

292 293 294
/* Holds the list (error).  */
Lisp_Object list_of_error;

Gerd Moellmann's avatar
Gerd Moellmann committed
295 296 297 298 299
/* Functions called to fontify regions of text.  */

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

300
/* Non-nil means automatically select any window when the mouse
301
   cursor moves into it.  */
302
Lisp_Object Vmouse_autoselect_window;
303

304 305 306
Lisp_Object Vwrap_prefix, Qwrap_prefix;
Lisp_Object Vline_prefix, Qline_prefix;

Gerd Moellmann's avatar
Gerd Moellmann committed
307
/* Non-zero means draw tool bar buttons raised when the mouse moves
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309
   over them.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
310
int auto_raise_tool_bar_buttons_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
311

312 313 314 315
/* Non-zero means to reposition window if cursor line is only partially visible.  */

int make_cursor_line_fully_visible_p;

316 317 318 319 320 321
/* Margin below tool bar in pixels.  0 or nil means no margin.
   If value is `internal-border-width' or `border-width',
   the corresponding frame parameter is used.  */

Lisp_Object Vtool_bar_border;

Gerd Moellmann's avatar
Gerd Moellmann committed
322
/* Margin around tool bar buttons in pixels.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
323

324
Lisp_Object Vtool_bar_button_margin;
Gerd Moellmann's avatar
Gerd Moellmann committed
325

Gerd Moellmann's avatar
Gerd Moellmann committed
326
/* Thickness of shadow to draw around tool bar buttons.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
327

328
EMACS_INT tool_bar_button_relief;
Gerd Moellmann's avatar
Gerd Moellmann committed
329

330 331
/* Non-nil means automatically resize tool-bars so that all tool-bar
   items are visible, and no blank lines remain.
Gerd Moellmann's avatar
Gerd Moellmann committed
332

333 334 335
   If value is `grow-only', only make tool-bar bigger.  */

Lisp_Object Vauto_resize_tool_bars;
336

337 338 339 340 341 342 343 344
/* Type of tool bar.  Can be symbols image, text, both or both-hroiz.  */

Lisp_Object Vtool_bar_style;

/* Maximum number of characters a label can have to be shown.  */

EMACS_INT tool_bar_max_label_size;

345 346 347 348 349 350
/* Non-zero means draw block and hollow cursor as wide as the glyph
   under it.  For example, if a block cursor is over a tab, it will be
   drawn as wide as that tab on the display.  */

int x_stretch_cursor_p;

351 352 353 354
/* Non-nil means don't actually do any redisplay.  */

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

355 356
/* Non-zero means Lisp evaluation during redisplay is inhibited.  */

357
int inhibit_eval_during_redisplay;
358

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

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

/* Symbols used in text property values.  */

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

373
/* Non-nil means highlight trailing whitespace.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
374

375
Lisp_Object Vshow_trailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
376

377 378
/* Non-nil means escape non-break space and hyphens.  */

379
Lisp_Object Vnobreak_char_display;
380

Kenichi Handa's avatar
Kenichi Handa committed
381 382 383 384 385
#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.  */

386 387 388 389 390 391 392 393
#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))	\
   && (IT)->current_x == (IT)->last_visible_x		\
   && (IT)->line_wrap != WORD_WRAP)
Kenichi Handa's avatar
Kenichi Handa committed
394

395 396
#else /* !HAVE_WINDOW_SYSTEM */
#define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
Kenichi Handa's avatar
Kenichi Handa committed
397 398
#endif /* HAVE_WINDOW_SYSTEM */

399 400 401 402 403 404
/* Test if the display element loaded in IT is a space or tab
   character.  This is used to determine word wrapping.  */

#define IT_DISPLAYING_WHITESPACE(it)				\
  (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))

Kenichi Handa's avatar
Kenichi Handa committed
405 406 407 408 409 410
/* Non-nil means show the text cursor in void text areas
   i.e. in blank areas after eol and eob.  This used to be
   the default in 21.3.  */

Lisp_Object Vvoid_text_area_pointer;

Gerd Moellmann's avatar
Gerd Moellmann committed
411 412 413 414
/* Name of the face used to highlight trailing whitespace.  */

Lisp_Object Qtrailing_whitespace;

415 416 417 418
/* Name and number of the face used to highlight escape glyphs.  */

Lisp_Object Qescape_glyph;

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

421
Lisp_Object Qnobreak_space;
Juri Linkov's avatar
Juri Linkov committed
422

Gerd Moellmann's avatar
Gerd Moellmann committed
423
/* The symbol `image' which is the car of the lists used to represent
424
   images in Lisp.  Also a tool bar style.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
425 426 427

Lisp_Object Qimage;

Kenichi Handa's avatar
Kenichi Handa committed
428 429 430 431
/* The image map types.  */
Lisp_Object QCmap, QCpointer;
Lisp_Object Qrect, Qcircle, Qpoly;

432
/* Tool bar styles */
433
Lisp_Object Qboth, Qboth_horiz, Qtext_image_horiz;
434

Gerd Moellmann's avatar
Gerd Moellmann committed
435 436
/* Non-zero means print newline to stdout before next mini-buffer
   message.  */
Jim Blandy's avatar
Jim Blandy committed
437 438 439

int noninteractive_need_newline;

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

442
static int message_log_need_newline;
443

444 445 446 447 448 449
/* 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
450 451 452 453 454

/* 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
455

Gerd Moellmann's avatar
Gerd Moellmann committed
456
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
457

Gerd Moellmann's avatar
Gerd Moellmann committed
458 459 460 461 462 463
/* 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
464 465

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
466 467 468 469 470 471 472
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
473

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

static struct buffer *this_line_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
478 479
/* Nonzero means truncate lines in all windows less wide than the
   frame.  */
Jim Blandy's avatar
Jim Blandy committed
480

481
Lisp_Object Vtruncate_partial_width_windows;
Jim Blandy's avatar
Jim Blandy committed
482

483
/* A flag to control how to display unibyte 8-bit character.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
484

485
int unibyte_display_via_language_environment;
486

Gerd Moellmann's avatar
Gerd Moellmann committed
487 488 489
/* Nonzero means we have more than one non-mini-buffer-only frame.
   Not guaranteed to be accurate except while parsing
   frame-title-format.  */
490

491 492
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
493 494
Lisp_Object Vglobal_mode_string;

Kenichi Handa's avatar
Kenichi Handa committed
495 496 497 498 499 500 501

/* List of variables (symbols) which hold markers for overlay arrows.
   The symbols on this list are examined during redisplay to determine
   where to display overlay arrows.  */

Lisp_Object Voverlay_arrow_variable_list;

Jim Blandy's avatar
Jim Blandy committed
502
/* Marker for where to display an arrow on top of the buffer text.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
503

Jim Blandy's avatar
Jim Blandy committed
504 505
Lisp_Object Voverlay_arrow_position;

Gerd Moellmann's avatar
Gerd Moellmann committed
506 507
/* String to display for the arrow.  Only used on terminal frames.  */

Jim Blandy's avatar
Jim Blandy committed
508 509
Lisp_Object Voverlay_arrow_string;

Kenichi Handa's avatar
Kenichi Handa committed
510 511 512
/* 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
513 514
   numerical position.  */

Kenichi Handa's avatar
Kenichi Handa committed
515 516 517 518 519 520
Lisp_Object Qlast_arrow_position, Qlast_arrow_string;

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

Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
521

Gerd Moellmann's avatar
Gerd Moellmann committed
522 523
/* Like mode-line-format, but for the title bar on a visible frame.  */

524 525
Lisp_Object Vframe_title_format;

Gerd Moellmann's avatar
Gerd Moellmann committed
526 527
/* Like mode-line-format, but for the title bar on an iconified frame.  */

528 529
Lisp_Object Vicon_title_format;

530 531 532
/* List of functions to call when a window's size changes.  These
   functions get one arg, a frame on which one or more windows' sizes
   have changed.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
533

534 535
static Lisp_Object Vwindow_size_change_functions;

536
Lisp_Object Qmenu_bar_update_hook, Vmenu_bar_update_hook;
537

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

Gerd Moellmann's avatar
Gerd Moellmann committed
540
static int overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
541

542 543
/* Nonzero means highlight the region even in nonselected windows.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
544 545 546 547 548
int highlight_nonselected_windows;

/* If cursor motion alone moves point off frame, try scrolling this
   many lines up or down if that will bring it back.  */

549
static EMACS_INT scroll_step;
Jim Blandy's avatar
Jim Blandy committed
550

551
/* Nonzero means scroll just far enough to bring point back on the
Gerd Moellmann's avatar
Gerd Moellmann committed
552 553
   screen, when appropriate.  */

554
static EMACS_INT scroll_conservatively;
555

Gerd Moellmann's avatar
Gerd Moellmann committed
556 557
/* Recenter the window whenever point gets within this many lines of
   the top or bottom of the window.  This value is translated into a
558 559
   pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
   that there is really a fixed pixel height scroll margin.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
560

561
EMACS_INT scroll_margin;
562

Gerd Moellmann's avatar
Gerd Moellmann committed
563 564 565
/* Number of windows showing the buffer of the selected window (or
   another buffer with the same base buffer).  keyboard.c refers to
   this.  */
Jim Blandy's avatar
Jim Blandy committed
566 567 568

int buffer_shared;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
571
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
572

573 574 575 576 577
/* Zero means display the mode-line/header-line/menu-bar in the default face
   (this slightly odd definition is for compatibility with previous versions
   of emacs), non-zero means display them using their respective faces.

   This variable is deprecated.  */
Jim Blandy's avatar
Jim Blandy committed
578 579 580

int mode_line_inverse_video;

Gerd Moellmann's avatar
Gerd Moellmann committed
581 582
/* Prompt to display in front of the mini-buffer contents.  */

583
Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
584

Gerd Moellmann's avatar
Gerd Moellmann committed
585 586 587
/* Width of current mini-buffer prompt.  Only set after display_line
   of the line that contains the prompt.  */

Jim Blandy's avatar
Jim Blandy committed
588
int minibuf_prompt_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
589 590 591 592 593

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

594 595
Lisp_Object echo_area_window;

596 597 598 599 600 601 602
/* 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.  */

Lisp_Object Vmessage_stack;

603 604
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
605

606 607
int message_enable_multibyte;

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

Jim Blandy's avatar
Jim Blandy committed
610 611
int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
612
/* Nonzero if window sizes or contents have changed since last
613
   redisplay that finished.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
614

Jim Blandy's avatar
Jim Blandy committed
615 616
int windows_or_buffers_changed;

617 618 619 620
/* Nonzero means a frame's cursor type has been changed.  */

int cursor_type_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
621 622 623
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

624 625 626
int line_number_displayed;

/* Maximum buffer size for which to display line numbers.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
627

628
Lisp_Object Vline_number_display_limit;
Karl Heuer's avatar
Karl Heuer committed
629

630
/* Line width to consider when repositioning for line number display.  */
631

632
static EMACS_INT line_number_display_limit_width;
633

Gerd Moellmann's avatar
Gerd Moellmann committed
634 635 636
/* Number of lines to keep in the message log buffer.  t means
   infinite.  nil means don't log at all.  */

Karl Heuer's avatar
Karl Heuer committed
637
Lisp_Object Vmessage_log_max;
638

639 640 641 642
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

643 644
/* Current, index 0, and last displayed echo area message.  Either
   buffers from echo_buffers, or nil to indicate no message.  */
645 646 647

Lisp_Object echo_area_buffer[2];

648
/* The buffers referenced from echo_area_buffer.  */
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

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

static int display_last_displayed_message_p;

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

int message_buf_print;

666 667 668 669 670
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

Lisp_Object Qinhibit_menubar_update;
int inhibit_menubar_update;

671 672 673 674 675
/* When evaluating expressions from menu bar items (enable conditions,
   for instance), this is the frame they are being processed for.  */

Lisp_Object Vmenu_updating_frame;

676 677 678
/* Maximum height for resizing mini-windows.  Either a float
   specifying a fraction of the available height, or an integer
   specifying a number of lines.  */
679

680 681 682 683 684 685 686
Lisp_Object Vmax_mini_window_height;

/* Non-zero means messages should be displayed with truncated
   lines instead of being continued.  */

int message_truncate_lines;
Lisp_Object Qmessage_truncate_lines;
687

688
/* Set to 1 in clear_message to make redisplay_internal aware
689
   of an emptied echo area.  */
690 691 692

static int message_cleared_p;

693 694 695
/* How to blink the default frame cursor off.  */
Lisp_Object Vblink_cursor_alist;

Gerd Moellmann's avatar
Gerd Moellmann committed
696 697
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
698

Gerd Moellmann's avatar
Gerd Moellmann committed
699 700 701
#define MAX_SCRATCH_GLYPHS 100
struct glyph_row scratch_glyph_row;
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
702

Gerd Moellmann's avatar
Gerd Moellmann committed
703 704 705 706
/* Ascent and height of the last line processed by move_it_to.  */

static int last_max_ascent, last_height;

707 708 709 710
/* Non-zero if there's a help-echo in the echo area.  */

int help_echo_showing_p;

711 712 713 714 715 716
/* If >= 0, computed, exact values of mode-line and header-line height
   to use in the macros CURRENT_MODE_LINE_HEIGHT and
   CURRENT_HEADER_LINE_HEIGHT.  */

int current_mode_line_height, current_header_line_height;

Gerd Moellmann's avatar
Gerd Moellmann committed
717
/* The maximum distance to look ahead for text properties.  Values
718
   that are too small let us call compute_char_face and similar
Gerd Moellmann's avatar
Gerd Moellmann committed
719 720 721 722 723 724
   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

725 726
#if GLYPH_DEBUG

727 728 729 730 731
/* Variables to turn off display optimizations from Lisp.  */

int inhibit_try_window_id, inhibit_try_window_reusing;
int inhibit_try_cursor_movement;

Gerd Moellmann's avatar
Gerd Moellmann committed
732 733 734 735
/* Non-zero means print traces of redisplay if compiled with
   GLYPH_DEBUG != 0.  */

int trace_redisplay_p;
736

737
#endif /* GLYPH_DEBUG */
738

739 740
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
741 742 743 744
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
745
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
746
#endif
747

748 749 750 751
/* Non-zero means automatically scroll windows horizontally to make
   point visible.  */

int automatic_hscrolling_p;
752
Lisp_Object Qauto_hscroll_mode;
753

754 755
/* How close to the margin can point get before the window is scrolled
   horizontally.  */
756
EMACS_INT hscroll_margin;
757 758

/* How much to scroll horizontally when point is inside the above margin.  */
759
Lisp_Object Vhscroll_step;
760

761
/* The variable `resize-mini-windows'.  If nil, don't resize
Eli Zaretskii's avatar
Eli Zaretskii committed
762
   mini-windows.  If t, always resize them to fit the text they
763 764 765 766 767
   display.  If `grow-only', let mini-windows grow only until they
   become empty.  */

Lisp_Object Vresize_mini_windows;

768 769 770 771
/* Buffer being redisplayed -- for redisplay_window_error.  */

struct buffer *displayed_buffer;

772 773 774 775
/* Space between overline and text. */

EMACS_INT overline_margin;

776 777 778 779 780 781
/* Require underline to be at least this many screen pixels below baseline
   This to avoid underline "merging" with the base of letters at small
   font sizes, particularly when x_use_underline_position_properties is on. */

EMACS_INT underline_minimum_offset;

Gerd Moellmann's avatar
Gerd Moellmann committed
782 783 784
/* Value returned from text property handlers (see below).  */

enum prop_handled
785
{
Gerd Moellmann's avatar
Gerd Moellmann committed
786 787 788 789 790
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
791

Gerd Moellmann's avatar
Gerd Moellmann committed
792 793
/* A description of text properties that redisplay is interested
   in.  */
794

Gerd Moellmann's avatar
Gerd Moellmann committed
795 796 797 798
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
799

Gerd Moellmann's avatar
Gerd Moellmann committed
800 801 802 803 804
  /* 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.  */
805
  enum prop_handled (*handler) (struct it *it);
Gerd Moellmann's avatar
Gerd Moellmann committed
806 807
};

808 809 810 811 812 813
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
814 815 816 817

/* Properties handled by iterators.  */

static struct props it_props[] =
Karl Heuer's avatar
Karl Heuer committed
818
{
Gerd Moellmann's avatar
Gerd Moellmann committed
819 820 821 822 823 824
  {&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},
825
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
826 827
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
828

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
836 837 838 839
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
840

Gerd Moellmann's avatar
Gerd Moellmann committed
841 842
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
843

Gerd Moellmann's avatar
Gerd Moellmann committed
844 845
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
846

Gerd Moellmann's avatar
Gerd Moellmann committed
847 848 849
  /* Move within a line ended at the end of a line that must be
     continued.  */
  MOVE_LINE_CONTINUED,
850

Gerd Moellmann's avatar
Gerd Moellmann committed
851 852 853
  /* Move within a line ended at the end of a line that would
     be displayed truncated.  */
  MOVE_LINE_TRUNCATED,
854

Gerd Moellmann's avatar
Gerd Moellmann committed
855 856 857
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
858

859 860 861 862 863 864 865 866
/* 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;

867 868 869 870 871 872 873
/* Similarly for the image cache.  */

#ifdef HAVE_WINDOW_SYSTEM
#define CLEAR_IMAGE_CACHE_COUNT	101
static int clear_image_cache_count;
#endif

874 875 876 877
/* Non-zero while redisplay_internal is in progress.  */

int redisplaying_p;

878 879 880
/* Non-zero means don't free realized faces.  Bound while freeing
   realized faces is dangerous because glyph matrices might still
   reference them.  */
881

882 883
int inhibit_free_realized_faces;
Lisp_Object Qinhibit_free_realized_faces;
884

885 886 887 888 889 890 891 892 893 894 895 896
/* 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;
int help_echo_pos;

/* Temporary variable for XTread_socket.  */

Lisp_Object previous_help_echo_string;

Kim F. Storm's avatar
Kim F. Storm committed
897 898 899
/* Null glyph slice */

static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
900

901 902 903 904 905 906 907 908 909
/* Platform-independent portion of hourglass implementation. */

/* Non-zero means we're allowed to display a hourglass pointer.  */
int display_hourglass_p;

/* Non-zero means an hourglass cursor is currently shown.  */
int hourglass_shown_p;

/* If non-null, an asynchronous timer that, when it expires, displays
910
   an hourglass cursor on all frames.  */
911 912 913
struct atimer *hourglass_atimer;

/* Number of seconds to wait before displaying an hourglass cursor.  */
914
Lisp_Object Vhourglass_delay;
915 916 917 918 919

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

Gerd Moellmann's avatar
Gerd Moellmann committed
920 921 922

/* Function prototypes.  */

923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
static void setup_for_ellipsis (struct it *, int);
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);
static int cursor_row_p (struct window *, struct glyph_row *);
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 *);

static void pint2str (char *, int, int);
static void pint2hrstr (char *, int, int);
static struct text_pos run_window_scroll_functions (Lisp_Object,
                                                    struct text_pos);
static void reconsider_clip_changes (struct window *, struct buffer *);
static int text_outside_line_unchanged_p (struct window *, int, int);
static void store_mode_line_noprop_char (char);
static int store_mode_line_noprop (const unsigned char *, int, int);
static void x_consider_frame_title (Lisp_Object);
static void handle_stop (struct it *);
static void handle_stop_backwards (struct it *, EMACS_INT);
static int tool_bar_lines_needed (struct frame *, int *);
static int single_display_spec_intangible_p (Lisp_Object);
static void ensure_echo_area_buffers (void);
static Lisp_Object unwind_with_echo_area_buffer (Lisp_Object);
static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
static int with_echo_area_buffer (struct window *, int,
                                  int (*) (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT),
                                  EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT);
static void clear_garbaged_frames (void);
static int current_message_1 (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT);
static int truncate_message_1 (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT);
static int set_message_1 (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT);
static int display_echo_area (struct window *);
static int display_echo_area_1 (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT);
static int resize_mini_window_1 (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT);
static Lisp_Object unwind_redisplay (Lisp_Object);
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 Lisp_Object safe_eval_handler (Lisp_Object);
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);
static int try_scrolling (Lisp_Object, int, EMACS_INT, EMACS_INT, int, int);
static int try_cursor_movement (Lisp_Object, struct text_pos, int *);
static int trailing_whitespace_p (int);
static int message_log_check_duplicate (int, int, int, int);
static void push_it (struct it *);
static void pop_it (struct it *);
static void sync_frame_with_window_matrix_rows (struct window *);
static void select_frame_for_redisplay (Lisp_Object);
static void redisplay_internal (int);
static int echo_area_display (int);
static void redisplay_windows (Lisp_Object);
static void redisplay_window (Lisp_Object, int);
985
static Lisp_Object redisplay_window_error (Lisp_Object);
986 987 988 989 990 991 992 993 994
static Lisp_Object redisplay_window_0 (Lisp_Object);
static Lisp_Object redisplay_window_1 (Lisp_Object);
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);
995 996 997
static int store_mode_line_string (const char *, Lisp_Object, int, int, int, Lisp_Object);
static const char *decode_mode_spec (struct window *, int, int, int,
				     Lisp_Object *);
998 999
static void display_menu_bar (struct window *);
static int display_count_lines (int, int, int, int, int *);
1000
static int display_string (const unsigned char *, Lisp_Object, Lisp_Object,
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
                           EMACS_INT, EMACS_INT, struct it *, int, int, int, int);
static void compute_line_metrics (struct it *);
static void run_redisplay_end_trigger_hook (struct it *);
static int get_overlay_strings (struct it *, int);
static int get_overlay_strings_1 (struct it *, int, int);
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 *);
void reseat_at_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 *);
static void load_overlay_strings (struct it *, int);
static int init_from_display_pos (struct it *, struct window *,
                                  struct display_pos *);
1023
static void reseat_to_string (struct it *, const unsigned char *,
1024
                              Lisp_Object, int, int, int, int);
1025 1026 1027
static enum move_it_result
       move_it_in_display_line_to (struct it *, EMACS_INT, int,
				   enum move_operation_enum);
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
void move_it_vertically_backward (struct it *, int);
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 *);
static int forward_to_next_line_start (struct it *, int *);
static struct text_pos string_pos_nchars_ahead (struct text_pos,
                                                Lisp_Object, int);
static struct text_pos string_pos (int, Lisp_Object);
1038 1039
static struct text_pos c_string_pos (int, const unsigned char *, int);
static int number_of_chars (const unsigned char *, int);
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
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);
static EMACS_INT next_overlay_change (EMACS_INT);
static int handle_single_display_spec (struct it *, Lisp_Object,
                                       Lisp_Object, Lisp_Object,
                                       struct text_pos *, int);
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
1051 1052 1053

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

Gerd Moellmann's avatar
Gerd Moellmann committed
1055
#ifdef HAVE_WINDOW_SYSTEM
1056

1057 1058 1059 1060 1061 1062 1063 1064 1065
static void update_tool_bar (struct frame *, int);
static void build_desired_tool_bar_string (struct frame *f);
static int redisplay_tool_bar (struct frame *);
static void display_tool_bar_line (struct it *, int);
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);
1066 1067


1068

Gerd Moellmann's avatar
Gerd Moellmann committed
1069
#endif /* HAVE_WINDOW_SYSTEM */
1070

Gerd Moellmann's avatar
Gerd Moellmann committed
1071 1072 1073 1074

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
1075

1076 1077 1078 1079 1080
/* 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
1081 1082

INLINE int
1083
window_text_bottom_y (struct window *w)
Gerd Moellmann's avatar
Gerd Moellmann committed
1084
{
1085
  int height = WINDOW_TOTAL_HEIGHT (w);
1086

Gerd Moellmann's avatar
Gerd Moellmann committed
1087 1088 1089
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
1090 1091
}

Gerd Moellmann's avatar
Gerd Moellmann committed
1092
/* Return the pixel width of display area AREA of window W.  AREA < 0
Kim F. Storm's avatar
Kim F. Storm committed
1093
   means return the total width of W, not including fringes to
Gerd Moellmann's avatar
Gerd Moellmann committed
1094
   the left and right of the window.  */
1095

Gerd Moellmann's avatar
Gerd Moellmann committed
1096
INLINE int
1097
window_box_width (struct window *w, int area)
Gerd Moellmann's avatar
Gerd Moellmann committed
1098
{
1099 1100
  int cols = XFASTINT (w->total_cols);
  int pixels = 0;
1101

Gerd Moellmann's avatar
Gerd Moellmann committed
1102
  if (!w->pseudo_window_p)
1103
    {
1104