xdisp.c 439 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Display generation from window structure and buffer text.
2
   Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 97, 98, 99, 2000, 2001
Gerd Moellmann's avatar
Gerd Moellmann committed
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
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 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/* 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'
   in xdisp.c is the only entry into the inner redisplay code.  (Or,
   let's say almost---see the the description of direct update
   operations, below.).

   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.

	     (Direct functions, see below)
             direct_output_for_insert, 
             direct_forward_char (dispnew.c)
   	  +---------------------------------+
          |                                 |
	  |                                 V
   +--------------+   redisplay()   +----------------+
   | Lisp machine |---------------->| Redisplay code |<--+
   +--------------+   (xdisp.c)     +----------------+   |
	  ^				     |		 |
	  +----------------------------------+           |
	    Don't use this path when called		 |
	    asynchronously!				 |
                                                         |
                           expose_window (asynchronous)  |
                                                         |
			           X expose events  -----+

   What does redisplay?  Obviously, it has to figure out somehow what
   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.


   Direct operations.

   You will find a lot of of redisplay optimizations when you start
   looking at the innards of redisplay.  The overall goal of all these
   optimizations is to make redisplay fast because it is done
   frequently.

   Two optimizations are not found in xdisp.c.  These are the direct
   operations mentioned above.  As the name suggests they follow a
   different principle than the rest of redisplay.  Instead of
   building a desired matrix and then comparing it with the current
   display, they perform their actions directly on the display and on
   the current matrix.

   One direct operation updates the display after one character has
   been entered.  The other one moves the cursor by one position
   forward or backward.  You find these functions under the names
   `direct_output_for_insert' and `direct_output_forward_char' in
   dispnew.c.

   
   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
   interface functions taking a iterator structure (struct it)
   argument.

   Iteration over things to be be displayed is then simple.  It is
   started by initializing an iterator with a call to init_iterator
   (or init_string_iterator for that matter).  Calls to
   get_next_display_element fill the iterator structure with relevant
   information about the next thing to display.  Calls to
   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
   calling get_next_display_element and then produce_glyphs.  The call
   to produce_glyphs will fill the iterator structure with pixel
   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
   glyphs produced are discarded.


   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
   build_frame_matrix is a good starting point.  */
Jim Blandy's avatar
Jim Blandy committed
169

170
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
171 172
#include <stdio.h>
#include "lisp.h"
173
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
174
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
175 176 177 178
#include "window.h"
#include "termchar.h"
#include "dispextern.h"
#include "buffer.h"
179
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
180 181 182 183
#include "indent.h"
#include "commands.h"
#include "macros.h"
#include "disptab.h"
184
#include "termhooks.h"
185
#include "intervals.h"
186 187
#include "coding.h"
#include "process.h"
Andreas Schwab's avatar
Andreas Schwab committed
188
#include "region-cache.h"
Dave Love's avatar
Dave Love committed
189
#include "fontset.h"
Andreas Schwab's avatar
Andreas Schwab committed
190

191
#ifdef HAVE_X_WINDOWS
Andreas Schwab's avatar
Andreas Schwab committed
192 193
#include "xterm.h"
#endif
194 195 196
#ifdef WINDOWSNT
#include "w32term.h"
#endif
197 198 199
#ifdef macintosh
#include "macterm.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
200

Gerd Moellmann's avatar
Gerd Moellmann committed
201 202 203 204 205
#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

#define INFINITY 10000000

206
#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
207
extern void set_frame_menubar P_ ((struct frame *f, int, int));
208
extern int pending_menu_activation;
209 210
#endif

Jim Blandy's avatar
Jim Blandy committed
211 212 213
extern int interrupt_input;
extern int command_loop_level;

214 215
extern int minibuffer_auto_raise;

216 217
extern Lisp_Object Qface;

218 219
extern Lisp_Object Voverriding_local_map;
extern Lisp_Object Voverriding_local_map_menu_flag;
Gerd Moellmann's avatar
Gerd Moellmann committed
220
extern Lisp_Object Qmenu_item;
221

222
Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
223
Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
224
Lisp_Object Qredisplay_end_trigger_functions;
225
Lisp_Object Qinhibit_point_motion_hooks;
226
Lisp_Object QCeval, Qwhen, QCfile, QCdata;
Gerd Moellmann's avatar
Gerd Moellmann committed
227
Lisp_Object Qfontified;
228
Lisp_Object Qgrow_only;
229
Lisp_Object Qinhibit_eval_during_redisplay;
Gerd Moellmann's avatar
Gerd Moellmann committed
230 231 232 233 234 235

/* Functions called to fontify regions of text.  */

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
239
int auto_raise_tool_bar_buttons_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
240

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

243
Lisp_Object Vtool_bar_button_margin;
Gerd Moellmann's avatar
Gerd Moellmann committed
244

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

Gerd Moellmann's avatar
Gerd Moellmann committed
247
int tool_bar_button_relief;
Gerd Moellmann's avatar
Gerd Moellmann committed
248

Gerd Moellmann's avatar
Gerd Moellmann committed
249
/* Non-zero means automatically resize tool-bars so that all tool-bar
Gerd Moellmann's avatar
Gerd Moellmann committed
250 251
   items are visible, and no blank lines remain.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
252
int auto_resize_tool_bars_p;
253

254 255 256 257
/* Non-nil means don't actually do any redisplay.  */

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

258 259
/* Non-zero means Lisp evaluation during redisplay is inhibited.  */

260
int inhibit_eval_during_redisplay;
261

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

264 265
Lisp_Object Qdisplay, Qrelative_width, Qalign_to;
extern Lisp_Object Qface, Qinvisible, Qimage, Qwidth;
Gerd Moellmann's avatar
Gerd Moellmann committed
266 267 268 269

/* Symbols used in text property values.  */

Lisp_Object Qspace, QCalign_to, QCrelative_width, QCrelative_height;
270
Lisp_Object Qleft_margin, Qright_margin, Qspace_width, Qraise;
271
Lisp_Object Qmargin;
272
extern Lisp_Object Qheight;
Gerd Moellmann's avatar
Gerd Moellmann committed
273

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

276
Lisp_Object Vshow_trailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
277 278 279 280 281 282 283 284 285 286 287 288

/* Name of the face used to highlight trailing whitespace.  */

Lisp_Object Qtrailing_whitespace;

/* The symbol `image' which is the car of the lists used to represent
   images in Lisp.  */

Lisp_Object Qimage;

/* Non-zero means print newline to stdout before next mini-buffer
   message.  */
Jim Blandy's avatar
Jim Blandy committed
289 290 291

int noninteractive_need_newline;

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

294
static int message_log_need_newline;
295

Gerd Moellmann's avatar
Gerd Moellmann committed
296 297 298 299 300

/* 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
301

Gerd Moellmann's avatar
Gerd Moellmann committed
302
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
303

Gerd Moellmann's avatar
Gerd Moellmann committed
304 305 306 307 308 309
/* 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
310 311

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
312 313 314 315 316 317 318
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
319

Gerd Moellmann's avatar
Gerd Moellmann committed
320
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
321 322 323

static struct buffer *this_line_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
324 325
/* Nonzero means truncate lines in all windows less wide than the
   frame.  */
Jim Blandy's avatar
Jim Blandy committed
326 327 328

int truncate_partial_width_windows;

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

331
int unibyte_display_via_language_environment;
Gerd Moellmann's avatar
Gerd Moellmann committed
332 333 334 335
 
/* Nonzero means we have more than one non-mini-buffer-only frame.
   Not guaranteed to be accurate except while parsing
   frame-title-format.  */
336

337 338
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
339 340 341
Lisp_Object Vglobal_mode_string;

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

Jim Blandy's avatar
Jim Blandy committed
343 344
Lisp_Object Voverlay_arrow_position;

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

Jim Blandy's avatar
Jim Blandy committed
347 348
Lisp_Object Voverlay_arrow_string;

Gerd Moellmann's avatar
Gerd Moellmann committed
349 350 351 352
/* Values of those variables at last redisplay.  However, if
   Voverlay_arrow_position is a marker, last_arrow_position is its
   numerical position.  */

353 354
static Lisp_Object last_arrow_position, last_arrow_string;

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

357 358
Lisp_Object Vframe_title_format;

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

361 362
Lisp_Object Vicon_title_format;

363 364 365
/* 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
366

367 368
static Lisp_Object Vwindow_size_change_functions;

369
Lisp_Object Qmenu_bar_update_hook, Vmenu_bar_update_hook;
370

Jim Blandy's avatar
Jim Blandy committed
371 372
/* Nonzero if overlay arrow has been displayed once in this window.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
373
static int overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
374

375 376
/* Nonzero means highlight the region even in nonselected windows.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
377 378 379 380 381
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.  */

382
static int scroll_step;
Jim Blandy's avatar
Jim Blandy committed
383

Gerd Moellmann's avatar
Gerd Moellmann committed
384 385 386
/* Non-0 means scroll just far enough to bring point back on the
   screen, when appropriate.  */

387 388
static int scroll_conservatively;

Gerd Moellmann's avatar
Gerd Moellmann committed
389 390 391 392 393
/* Recenter the window whenever point gets within this many lines of
   the top or bottom of the window.  This value is translated into a
   pixel value by multiplying it with CANON_Y_UNIT, which means that
   there is really a fixed pixel height scroll margin.  */

394 395
int scroll_margin;

Gerd Moellmann's avatar
Gerd Moellmann committed
396 397 398
/* 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
399 400 401

int buffer_shared;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
404
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
405

406 407 408 409 410
/* 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
411 412 413

int mode_line_inverse_video;

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

416
Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
417

Gerd Moellmann's avatar
Gerd Moellmann committed
418 419 420
/* 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
421
int minibuf_prompt_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
422 423 424 425 426 427
int minibuf_prompt_pixel_width;

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

428 429
Lisp_Object echo_area_window;

430 431 432 433 434 435 436
/* 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;

437 438
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
439

440 441
int message_enable_multibyte;

Gerd Moellmann's avatar
Gerd Moellmann committed
442 443
/* True if we should redraw the mode lines on the next redisplay.  */

Jim Blandy's avatar
Jim Blandy committed
444 445
int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
446 447 448
/* Nonzero if window sizes or contents have changed since last
   redisplay that finished */

Jim Blandy's avatar
Jim Blandy committed
449 450
int windows_or_buffers_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
451 452 453
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

454 455 456
int line_number_displayed;

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

458
Lisp_Object Vline_number_display_limit;
Karl Heuer's avatar
Karl Heuer committed
459

460 461 462 463
/* line width to consider when repostioning for line number display */

static int line_number_display_limit_width;

Gerd Moellmann's avatar
Gerd Moellmann committed
464 465 466
/* 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
467
Lisp_Object Vmessage_log_max;
468

469 470 471 472
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
/* Current, index 0, and last displayed echo area message.  Either
   buffers from echo_buffers, or nil to indicate no message.  */

Lisp_Object echo_area_buffer[2];

/* The buffers referenced from echo_area_buffer.  */

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;

496 497 498 499 500
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

Lisp_Object Qinhibit_menubar_update;
int inhibit_menubar_update;

501 502 503
/* Maximum height for resizing mini-windows.  Either a float
   specifying a fraction of the available height, or an integer
   specifying a number of lines.  */
504

505 506 507 508 509 510 511
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;
512

513 514 515 516 517
/* Set to 1 in clear_message to make redisplay_internal aware
   of an emptied echo area.   */

static int message_cleared_p;

518 519 520 521 522
/* Non-zero means we want a hollow cursor in windows that are not
   selected.  Zero means there's no cursor in such windows.  */

int cursor_in_non_selected_windows;

Gerd Moellmann's avatar
Gerd Moellmann committed
523 524
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
525

Gerd Moellmann's avatar
Gerd Moellmann committed
526 527 528
#define MAX_SCRATCH_GLYPHS 100
struct glyph_row scratch_glyph_row;
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
529

Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532 533
/* Ascent and height of the last line processed by move_it_to.  */

static int last_max_ascent, last_height;

534 535 536 537
/* Non-zero if there's a help-echo in the echo area.  */

int help_echo_showing_p;

538 539 540 541 542 543
/* 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
544 545 546 547 548 549 550 551
/* The maximum distance to look ahead for text properties.  Values
   that are too small let us call compute_char_face and similar 
   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

552 553
#if GLYPH_DEBUG

Gerd Moellmann's avatar
Gerd Moellmann committed
554 555 556 557
/* Non-zero means print traces of redisplay if compiled with
   GLYPH_DEBUG != 0.  */

int trace_redisplay_p;
558

559
#endif /* GLYPH_DEBUG */
560

561 562
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
563 564 565 566
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
567
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
568
#endif
569
 
570 571 572 573 574
/* Non-zero means automatically scroll windows horizontally to make
   point visible.  */

int automatic_hscrolling_p;

575 576 577 578
/* A list of symbols, one for each supported image type.  */

Lisp_Object Vimage_types;

579
/* The variable `resize-mini-windows'.  If nil, don't resize
Eli Zaretskii's avatar
Eli Zaretskii committed
580
   mini-windows.  If t, always resize them to fit the text they
581 582 583 584 585
   display.  If `grow-only', let mini-windows grow only until they
   become empty.  */

Lisp_Object Vresize_mini_windows;

Gerd Moellmann's avatar
Gerd Moellmann committed
586 587 588
/* Value returned from text property handlers (see below).  */

enum prop_handled
589
{
Gerd Moellmann's avatar
Gerd Moellmann committed
590 591 592 593 594
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
595

Gerd Moellmann's avatar
Gerd Moellmann committed
596 597
/* A description of text properties that redisplay is interested
   in.  */
598

Gerd Moellmann's avatar
Gerd Moellmann committed
599 600 601 602
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
603

Gerd Moellmann's avatar
Gerd Moellmann committed
604 605 606 607 608 609 610 611 612 613 614
  /* 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.  */
  enum prop_handled (*handler) P_ ((struct it *it));
};

static enum prop_handled handle_face_prop P_ ((struct it *));
static enum prop_handled handle_invisible_prop P_ ((struct it *));
static enum prop_handled handle_display_prop P_ ((struct it *));
615
static enum prop_handled handle_composition_prop P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
616 617 618 619 620 621
static enum prop_handled handle_overlay_change P_ ((struct it *));
static enum prop_handled handle_fontified_prop P_ ((struct it *));

/* Properties handled by iterators.  */

static struct props it_props[] =
Karl Heuer's avatar
Karl Heuer committed
622
{
Gerd Moellmann's avatar
Gerd Moellmann committed
623 624 625 626 627 628
  {&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},
629
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
630 631
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
632

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
640 641 642 643
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
644

Gerd Moellmann's avatar
Gerd Moellmann committed
645 646
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
647

Gerd Moellmann's avatar
Gerd Moellmann committed
648 649
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
650

Gerd Moellmann's avatar
Gerd Moellmann committed
651 652 653 654 655 656 657
  /* Move within a line ended at the end of a line that must be
     continued.  */
  MOVE_LINE_CONTINUED,
  
  /* Move within a line ended at the end of a line that would
     be displayed truncated.  */
  MOVE_LINE_TRUNCATED,
658

Gerd Moellmann's avatar
Gerd Moellmann committed
659 660 661
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
662

663

Gerd Moellmann's avatar
Gerd Moellmann committed
664 665 666

/* Function prototypes.  */

667
static void setup_for_ellipsis P_ ((struct it *));
668
static void mark_window_display_accurate_1 P_ ((struct window *, int));
669 670
static int single_display_prop_string_p P_ ((Lisp_Object, Lisp_Object));
static int display_prop_string_p P_ ((Lisp_Object, Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
671
static int cursor_row_p P_ ((struct window *, struct glyph_row *));
672
static int redisplay_mode_lines P_ ((Lisp_Object, int));
673 674 675 676 677 678 679 680 681 682 683 684 685
static char *decode_mode_spec_coding P_ ((Lisp_Object, char *, int));
static int invisible_text_between_p P_ ((struct it *, int, int));
static int next_element_from_ellipsis P_ ((struct it *));
static void pint2str P_ ((char *, int, int));
static struct text_pos run_window_scroll_functions P_ ((Lisp_Object,
							struct text_pos));
static void reconsider_clip_changes P_ ((struct window *, struct buffer *));
static int text_outside_line_unchanged_p P_ ((struct window *, int, int));
static void store_frame_title_char P_ ((char));
static int store_frame_title P_ ((unsigned char *, int, int));
static void x_consider_frame_title P_ ((Lisp_Object));
static void handle_stop P_ ((struct it *));
static int tool_bar_lines_needed P_ ((struct frame *));
686
static int single_display_prop_intangible_p P_ ((Lisp_Object));
687
static void ensure_echo_area_buffers P_ ((void));
Gerd Moellmann's avatar
Gerd Moellmann committed
688 689 690
static struct glyph_row *row_containing_pos P_ ((struct window *, int,
						 struct glyph_row *,
						 struct glyph_row *));
691 692
static Lisp_Object unwind_with_echo_area_buffer P_ ((Lisp_Object));
static Lisp_Object with_echo_area_buffer_unwind_data P_ ((struct window *));
693
static int with_echo_area_buffer P_ ((struct window *, int,
694 695
				      int (*) (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT),
				      EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
696
static void clear_garbaged_frames P_ ((void));
697 698 699
static int current_message_1 P_ ((EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
static int truncate_message_1 P_ ((EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
static int set_message_1 P_ ((EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
700
static int display_echo_area P_ ((struct window *));
701 702
static int display_echo_area_1 P_ ((EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
static int resize_mini_window_1 P_ ((EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
703
static Lisp_Object unwind_redisplay P_ ((Lisp_Object));
704
static int string_char_and_length P_ ((unsigned char *, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
705 706 707
static struct text_pos display_prop_end P_ ((struct it *, Lisp_Object,
					     struct text_pos));
static int compute_window_start_on_continuation_line P_ ((struct window *));
708
static Lisp_Object safe_eval_handler P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
709 710 711
static void insert_left_trunc_glyphs P_ ((struct it *));
static struct glyph_row *get_overlay_arrow_glyph_row P_ ((struct window *));
static void extend_face_to_end_of_line P_ ((struct it *));
712
static int append_space P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
713 714
static void make_cursor_line_fully_visible P_ ((struct window *));
static int try_scrolling P_ ((Lisp_Object, int, int, int, int));
715
static int try_cursor_movement P_ ((Lisp_Object, struct text_pos, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
716 717 718 719 720 721 722 723
static int trailing_whitespace_p P_ ((int));
static int message_log_check_duplicate P_ ((int, int, int, int));
int invisible_p P_ ((Lisp_Object, Lisp_Object));
int invisible_ellipsis_p P_ ((Lisp_Object, Lisp_Object));
static void push_it P_ ((struct it *));
static void pop_it P_ ((struct it *));
static void sync_frame_with_window_matrix_rows P_ ((struct window *));
static void redisplay_internal P_ ((int));
724
static int echo_area_display P_ ((int));
Gerd Moellmann's avatar
Gerd Moellmann committed
725 726 727 728 729 730
static void redisplay_windows P_ ((Lisp_Object));
static void redisplay_window P_ ((Lisp_Object, int));
static void update_menu_bar P_ ((struct frame *, int));
static int try_window_reusing_current_matrix P_ ((struct window *));
static int try_window_id P_ ((struct window *));
static int display_line P_ ((struct it *));
731
static int display_mode_lines P_ ((struct window *));
732
static int display_mode_line P_ ((struct window *, enum face_id, Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
733
static int display_mode_element P_ ((struct it *, int, int, int, Lisp_Object));
734
static char *decode_mode_spec P_ ((struct window *, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
735 736 737 738 739 740
static void display_menu_bar P_ ((struct window *));
static int display_count_lines P_ ((int, int, int, int, int *));
static int display_string P_ ((unsigned char *, Lisp_Object, Lisp_Object,
			       int, int, struct it *, int, int, int, int));
static void compute_line_metrics P_ ((struct it *));
static void run_redisplay_end_trigger_hook P_ ((struct it *));
741
static int get_overlay_strings P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
742 743 744 745 746
static void next_overlay_string P_ ((struct it *));
static void reseat P_ ((struct it *, struct text_pos, int));
static void reseat_1 P_ ((struct it *, struct text_pos, int));
static void back_to_previous_visible_line_start P_ ((struct it *));
static void reseat_at_previous_visible_line_start P_ ((struct it *));
747
static void reseat_at_next_visible_line_start P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
748 749 750 751
static int next_element_from_display_vector P_ ((struct it *));
static int next_element_from_string P_ ((struct it *));
static int next_element_from_c_string P_ ((struct it *));
static int next_element_from_buffer P_ ((struct it *));
752
static int next_element_from_composition P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
753 754
static int next_element_from_image P_ ((struct it *));
static int next_element_from_stretch P_ ((struct it *));
755
static void load_overlay_strings P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
756 757 758 759 760 761 762 763 764 765 766 767
static void init_from_display_pos P_ ((struct it *, struct window *,
				       struct display_pos *));
static void reseat_to_string P_ ((struct it *, unsigned char *,
				  Lisp_Object, int, int, int, int));
static enum move_it_result move_it_in_display_line_to P_ ((struct it *,
							   int, int, int));
void move_it_vertically_backward P_ ((struct it *, int));
static void init_to_row_start P_ ((struct it *, struct window *,
				   struct glyph_row *));
static void init_to_row_end P_ ((struct it *, struct window *,
				 struct glyph_row *));
static void back_to_previous_line_start P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
768
static int forward_to_next_line_start P_ ((struct it *, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
769 770 771 772 773 774 775 776 777 778 779
static struct text_pos string_pos_nchars_ahead P_ ((struct text_pos,
						    Lisp_Object, int));
static struct text_pos string_pos P_ ((int, Lisp_Object));
static struct text_pos c_string_pos P_ ((int, unsigned char *, int));
static int number_of_chars P_ ((unsigned char *, int));
static void compute_stop_pos P_ ((struct it *));
static void compute_string_pos P_ ((struct text_pos *, struct text_pos,
				    Lisp_Object));
static int face_before_or_after_it_pos P_ ((struct it *, int));
static int next_overlay_change P_ ((int));
static int handle_single_display_prop P_ ((struct it *, Lisp_Object,
780 781
					   Lisp_Object, struct text_pos *,
					   int));
782
static int underlying_face_id P_ ((struct it *));
783 784
static int in_ellipses_for_invisible_text_p P_ ((struct display_pos *,
						 struct window *));
Gerd Moellmann's avatar
Gerd Moellmann committed
785 786 787

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

Gerd Moellmann's avatar
Gerd Moellmann committed
789
#ifdef HAVE_WINDOW_SYSTEM
790

Gerd Moellmann's avatar
Gerd Moellmann committed
791 792 793 794
static void update_tool_bar P_ ((struct frame *, int));
static void build_desired_tool_bar_string P_ ((struct frame *f));
static int redisplay_tool_bar P_ ((struct frame *));
static void display_tool_bar_line P_ ((struct it *));
795

Gerd Moellmann's avatar
Gerd Moellmann committed
796
#endif /* HAVE_WINDOW_SYSTEM */
797

Gerd Moellmann's avatar
Gerd Moellmann committed
798 799 800 801

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
802

Gerd Moellmann's avatar
Gerd Moellmann committed
803 804 805 806 807 808 809 810 811 812
/* Return the window-relative maximum y + 1 for glyph rows displaying
   text in window W.  This is the height of W minus the height of a
   mode line, if any.  */

INLINE int
window_text_bottom_y (w)
     struct window *w;
{
  struct frame *f = XFRAME (w->frame);
  int height = XFASTINT (w->height) * CANON_Y_UNIT (f);
813

Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
817 818
}

819

Gerd Moellmann's avatar
Gerd Moellmann committed
820 821 822
/* Return the pixel width of display area AREA of window W.  AREA < 0
   means return the total width of W, not including bitmap areas to
   the left and right of the window.  */
823

Gerd Moellmann's avatar
Gerd Moellmann committed
824 825 826 827 828 829 830 831 832
INLINE int
window_box_width (w, area)
     struct window *w;
     int area;
{
  struct frame *f = XFRAME (w->frame);
  int width = XFASTINT (w->width);
  
  if (!w->pseudo_window_p)
833
    {
834
      width -= FRAME_SCROLL_BAR_WIDTH (f) + FRAME_FLAGS_AREA_COLS (f);
Gerd Moellmann's avatar
Gerd Moellmann committed
835 836 837 838 839 840 841 842 843 844 845 846 847 848
      
      if (area == TEXT_AREA)
	{
	  if (INTEGERP (w->left_margin_width))
	    width -= XFASTINT (w->left_margin_width);
	  if (INTEGERP (w->right_margin_width))
	    width -= XFASTINT (w->right_margin_width);
	}
      else if (area == LEFT_MARGIN_AREA)
	width = (INTEGERP (w->left_margin_width)
		 ? XFASTINT (w->left_margin_width) : 0);
      else if (area == RIGHT_MARGIN_AREA)
	width = (INTEGERP (w->right_margin_width)
		 ? XFASTINT (w->right_margin_width) : 0);
849
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
850 851

  return width * CANON_X_UNIT (f);
852
}
853 854


Gerd Moellmann's avatar
Gerd Moellmann committed
855 856
/* Return the pixel height of the display area of window W, not
   including mode lines of W, if any..  */
857

Gerd Moellmann's avatar
Gerd Moellmann committed
858 859 860
INLINE int
window_box_height (w)
     struct window *w;
861
{
Gerd Moellmann's avatar
Gerd Moellmann committed
862 863
  struct frame *f = XFRAME (w->frame);
  int height = XFASTINT (w->height) * CANON_Y_UNIT (f);
864 865

  xassert (height >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
866
  
867 868 869 870 871 872
  /* Note: the code below that determines the mode-line/header-line
     height is essentially the same as that contained in the macro
     CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
     the appropriate glyph row has its `mode_line_p' flag set,
     and if it doesn't, uses estimate_mode_line_height instead.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
873
  if (WINDOW_WANTS_MODELINE_P (w))
874 875 876 877 878 879 880 881 882 883
    {
      struct glyph_row *ml_row
	= (w->current_matrix && w->current_matrix->rows
	   ? MATRIX_MODE_LINE_ROW (w->current_matrix)
	   : 0);
      if (ml_row && ml_row->mode_line_p)
	height -= ml_row->height;
      else
	height -= estimate_mode_line_height (f, MODE_LINE_FACE_ID);
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
884

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
885
  if (WINDOW_WANTS_HEADER_LINE_P (w))
886 887 888 889 890 891 892 893 894 895
    {
      struct glyph_row *hl_row
	= (w->current_matrix && w->current_matrix->rows
	   ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
	   : 0);
      if (hl_row && hl_row->mode_line_p)
	height -= hl_row->height;
      else
	height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
896 897

  return height;
Karl Heuer's avatar
Karl Heuer committed
898 899 900
}


Gerd Moellmann's avatar
Gerd Moellmann committed
901 902 903 904
/* Return the frame-relative coordinate of the left edge of display
   area AREA of window W.  AREA < 0 means return the left edge of the
   whole window, to the right of any bitmap area at the left side of
   W.  */
Karl Heuer's avatar
Karl Heuer committed
905

Gerd Moellmann's avatar
Gerd Moellmann committed
906 907 908 909
INLINE int
window_box_left (w, area)
     struct window *w;
     int area;
910
{
Gerd Moellmann's avatar
Gerd Moellmann committed
911 912
  struct frame *f = XFRAME (w->frame);
  int x = FRAME_INTERNAL_BORDER_WIDTH_SAFE (f);
913

Gerd Moellmann's avatar
Gerd Moellmann committed
914
  if (!w->pseudo_window_p)
915
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
916
      x += (WINDOW_LEFT_MARGIN (w) * CANON_X_UNIT (f)
917
	    + FRAME_LEFT_FLAGS_AREA_WIDTH (f));
Gerd Moellmann's avatar
Gerd Moellmann committed
918 919 920 921 922 923
      
      if (area == TEXT_AREA)
	x += window_box_width (w, LEFT_MARGIN_AREA);
      else if (area == RIGHT_MARGIN_AREA)
	x += (window_box_width (w, LEFT_MARGIN_AREA)
	      + window_box_width (w, TEXT_AREA));
924
    }
925

Gerd Moellmann's avatar
Gerd Moellmann committed
926 927
  return x;
}     
928

929

Gerd Moellmann's avatar
Gerd Moellmann committed
930 931 932 933
/* Return the frame-relative coordinate of the right edge of display
   area AREA of window W.  AREA < 0 means return the left edge of the
   whole window, to the left of any bitmap area at the right side of
   W.  */
934

Gerd Moellmann's avatar
Gerd Moellmann committed
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
INLINE int
window_box_right (w, area)
     struct window *w;
     int area;
{
  return window_box_left (w, area) + window_box_width (w, area);
}     
     

/* Get the bounding box of the display area AREA of window W, without
   mode lines, in frame-relative coordinates.  AREA < 0 means the
   whole window, not including bitmap areas to the left and right of
   the window.  Return in *BOX_X and *BOX_Y the frame-relative pixel
   coordinates of the upper-left corner of the box.  Return in
   *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box.  */

INLINE void
window_box (w, area, box_x, box_y, box_width, box_height)
     struct window *w;
     int area;
     int *box_x, *box_y, *box_width, *box_height;
{
  struct frame *f = XFRAME (w->frame);
  
  *box_width = window_box_width (w, area);
  *box_height = window_box_height (w);
  *box_x = window_box_left (w, area);
  *box_y = (FRAME_INTERNAL_BORDER_WIDTH_SAFE (f)
	    + XFASTINT (w->top) * CANON_Y_UNIT (f));
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
964 965
  if (WINDOW_WANTS_HEADER_LINE_P (w))
    *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
966
}
967 968


Gerd Moellmann's avatar
Gerd Moellmann committed
969 970 971 972 973 974 975
/* Get the bounding box of the display area AREA of window W, without
   mode lines.  AREA < 0 means the whole window, not including bitmap
   areas to the left and right of the window.  Return in *TOP_LEFT_X
   and TOP_LEFT_Y the frame-relative pixel coordinates of the
   upper-left corner of the box.  Return in *BOTTOM_RIGHT_X, and
   *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
   box.  */
976

Gerd Moellmann's avatar
Gerd Moellmann committed
977 978 979 980 981 982
INLINE void
window_box_edges (w, area, top_left_x, top_left_y,
		  bottom_right_x, bottom_right_y)
     struct window *w;
     int area;
     int *top_left_x, *top_left_y, *bottom_right_x, *bottom_right_y;
983
{
Gerd Moellmann's avatar
Gerd Moellmann committed
984 985 986 987
  window_box (w, area, top_left_x, top_left_y, bottom_right_x,
	      bottom_right_y);
  *bottom_right_x += *top_left_x;
  *bottom_right_y += *top_left_y;
988 989
}

Gerd Moellmann's avatar
Gerd Moellmann committed
990 991 992 993 994 995


/***********************************************************************
			      Utilities
 ***********************************************************************/

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
/* Return the bottom y-position of the line the iterator IT is in.
   This can modify IT's settings.  */

int
line_bottom_y (it)
     struct it *it;
{
  int line_height = it->max_ascent + it->max_descent;
  int line_top_y = it->current_y;
  
  if (line_height == 0)
    {
      if (last_height)
	line_height = last_height;
      else if (IT_CHARPOS (*it) < ZV)
	{
	  move_it_by_lines (it, 1, 1);
	  line_height = (it->max_ascent || it->max_descent
			 ? it->max_ascent + it->max_descent
			 : last_height);
	}
      else
	{
	  struct glyph_row *row = it->glyph_row;
	  
	  /* Use the default character height.  */
	  it->glyph_row = NULL;
	  it->what = IT_CHARACTER;
	  it->c = ' ';
	  it->len = 1;
	  PRODUCE_GLYPHS (it);
	  line_height = it->ascent + it->descent;
	  it->glyph_row = row;
	}
    }

  return line_top_y + line_height;
}


1036 1037 1038 1039
/* Return 1 if position CHARPOS is visible in window W.  Set *FULLY to
   1 if POS is visible and the line containing POS is fully visible.
   EXACT_MODE_LINE_HEIGHTS_P non-zero means compute exact mode-line
   and header-lines heights.  */
1040 1041

int
1042
pos_visible_p (w, charpos, fully, exact_mode_line_heights_p)
1043
     struct window *w;
1044
     int charpos, *fully, exact_mode_line_heights_p;
1045 1046 1047
{
  struct it it;
  struct text_pos top;
1048 1049 1050 1051 1052 1053 1054 1055
  int visible_p;
  struct buffer *old_buffer = NULL;

  if (XBUFFER (w->buffer) != current_buffer)
    {
      old_buffer = current_buffer;
      set_buffer_internal_1 (XBUFFER (w->buffer));
    }
1056 1057 1058

  *fully = visible_p = 0;
  SET_TEXT_POS_FROM_MARKER (top, w->start);
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
  
  /* Compute exact mode line heights, if requested.  */
  if (exact_mode_line_heights_p)
    {
      if (WINDOW_WANTS_MODELINE_P (w))
	current_mode_line_height
	  = display_mode_line (w, MODE_LINE_FACE_ID,
			       current_buffer->mode_line_format);
  
      if (WINDOW_WANTS_HEADER_LINE_P (w))
	current_header_line_height
	  = display_mode_line (w, HEADER_LINE_FACE_ID,
			       current_buffer->header_line_format);
    }
1073

1074
  start_display (&it, w, top);
1075 1076
  move_it_to (&it, charpos, 0, it.last_visible_y, -1,
	      MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
1077 1078 1079

  /* Note that we may overshoot because of invisible text.  */
  if (IT_CHARPOS (it) >= charpos)
1080
    {
1081 1082
      int top_y = it.current_y;
      int bottom_y = line_bottom_y (&it);
1083
      int window_top_y = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
1084
      
1085 1086 1087
      if (top_y < window_top_y)
	visible_p = bottom_y > window_top_y;
      else if (top_y < it.last_visible_y)
1088 1089
	{
	  visible_p = 1;
1090
	  *fully = bottom_y <= it.last_visible_y;
1091
	}
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
    }
  else if (it.current_y + it.max_ascent + it.max_descent > it.last_visible_y)
    {
      move_it_by_lines (&it, 1, 0);
      if (charpos < IT_CHARPOS (it))
	{
	  visible_p = 1;
	  *fully  = 0;
	}
    }
1102 1103 1104

  if (old_buffer)
    set_buffer_internal_1 (old_buffer);
1105 1106

  current_header_line_height = current_mode_line_height = -1;
1107 1108 1109 1110
  return visible_p;
}


1111 1112 1113
/* Return the next character from STR which is MAXLEN bytes long.
   Return in *LEN the length of the character.  This is like
   STRING_CHAR_AND_LENGTH but never returns an invalid character.  If
1114
   we find one, we return a `?', but with the length of the invalid
1115 1116 1117
   character.  */

static INLINE int
1118
string_char_and_length (str, maxlen, len)
1119
     unsigned char *str;
1120
     int maxlen, *len;
1121 1122 1123 1124 1125 1126
{
  int c;

  c = STRING_CHAR_AND_LENGTH (str, maxlen, *len);
  if (!CHAR_VALID_P (c, 1))
    /* We may not change the length here because other places in Emacs
1127
       don't use this function, i.e. they silently accept invalid
1128 1129 1130 1131 1132 1133 1134 1135
       characters.  */
    c = '?';

  return c;
}



Gerd Moellmann's avatar
Gerd Moellmann committed
1136 1137 1138 1139 1140 1141 1142 1143
/* Given a position POS containing a valid character and byte position
   in STRING, return the position NCHARS ahead (NCHARS >= 0).  */

static struct text_pos
string_pos_nchars_ahead (pos, string, nchars)
     struct text_pos pos;
     Lisp_Object string;
     int nchars;
Karl Heuer's avatar
Karl Heuer committed
1144
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
  xassert (STRINGP (string) && nchars >= 0);

  if (STRING_MULTIBYTE (string))
    {
      int rest = STRING_BYTES (XSTRING (string)) - BYTEPOS (pos);
      unsigned char *p = XSTRING (string)->data + BYTEPOS (pos);
      int len;

      while (nchars--)
	{
1155
	  string_char_and_length (p, rest, &len);
Gerd Moellmann's avatar
Gerd Moellmann committed
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
	  p += len, rest -= len;
	  xassert (rest >= 0);
	  CHARPOS (pos) += 1;
	  BYTEPOS (pos) += len;
	}
    }
  else
    SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);

  return pos;
1166 1167 1168
}


Gerd Moellmann's avatar
Gerd Moellmann committed
1169 1170 1171 1172 1173 1174
/* Value is the text position, i.e. character and byte position,
   for character position CHARPOS in STRING.  */

static INLINE struct text_pos
string_pos (charpos, string)
     int charpos;
Richard M. Stallman's avatar