xdisp.c 442 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
#include <stdio.h>
Gerd Moellmann's avatar
Gerd Moellmann committed
172
#define DOC_STRINGS_IN_COMMENTS
Jim Blandy's avatar
Jim Blandy committed
173
#include "lisp.h"
174
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
175
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
176 177 178 179
#include "window.h"
#include "termchar.h"
#include "dispextern.h"
#include "buffer.h"
180
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
181 182 183 184
#include "indent.h"
#include "commands.h"
#include "macros.h"
#include "disptab.h"
185
#include "termhooks.h"
186
#include "intervals.h"
187 188
#include "coding.h"
#include "process.h"
Andreas Schwab's avatar
Andreas Schwab committed
189
#include "region-cache.h"
Dave Love's avatar
Dave Love committed
190
#include "fontset.h"
Andreas Schwab's avatar
Andreas Schwab committed
191

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

Gerd Moellmann's avatar
Gerd Moellmann committed
202 203
#define INFINITY 10000000

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

Jim Blandy's avatar
Jim Blandy committed
209 210 211
extern int interrupt_input;
extern int command_loop_level;

212 213
extern int minibuffer_auto_raise;

214 215
extern Lisp_Object Qface;

216 217
extern Lisp_Object Voverriding_local_map;
extern Lisp_Object Voverriding_local_map_menu_flag;
Gerd Moellmann's avatar
Gerd Moellmann committed
218
extern Lisp_Object Qmenu_item;
219

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

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

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

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

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

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

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

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

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

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

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

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

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

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

259
int inhibit_eval_during_redisplay;
260

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

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

/* Symbols used in text property values.  */

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

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

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

/* 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
288 289 290

int noninteractive_need_newline;

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

293
static int message_log_need_newline;
294

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

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

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

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

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

static struct buffer *this_line_buffer;

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

int truncate_partial_width_windows;

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

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

336 337
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
338 339 340
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
341

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

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

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

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

352 353
static Lisp_Object last_arrow_position, last_arrow_string;

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

356 357
Lisp_Object Vframe_title_format;

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

360 361
Lisp_Object Vicon_title_format;

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

366 367
static Lisp_Object Vwindow_size_change_functions;

368
Lisp_Object Qmenu_bar_update_hook, Vmenu_bar_update_hook;
369

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

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

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

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

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

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

386 387
static int scroll_conservatively;

Gerd Moellmann's avatar
Gerd Moellmann committed
388 389 390 391 392
/* 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.  */

393 394
int scroll_margin;

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

int buffer_shared;

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

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

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

int mode_line_inverse_video;

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

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

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

427 428
Lisp_Object echo_area_window;

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

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

439 440
int message_enable_multibyte;

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

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

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

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

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

453 454 455
int line_number_displayed;

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

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

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

static int line_number_display_limit_width;

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

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

static Lisp_Object Vmessages_buffer_name;

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/* 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;

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

Lisp_Object Qinhibit_menubar_update;
int inhibit_menubar_update;

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

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

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

static int message_cleared_p;

517 518 519 520 521
/* 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
522 523
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
524

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

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

static int last_max_ascent, last_height;

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

int help_echo_showing_p;

537 538 539 540 541 542
/* 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
543 544 545 546 547 548 549 550
/* 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

551 552
#if GLYPH_DEBUG

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

int trace_redisplay_p;
557

558
#endif /* GLYPH_DEBUG */
559

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

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

int automatic_hscrolling_p;

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

Lisp_Object Vimage_types;

578
/* The variable `resize-mini-windows'.  If nil, don't resize
Eli Zaretskii's avatar
Eli Zaretskii committed
579
   mini-windows.  If t, always resize them to fit the text they
580 581 582 583 584
   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
585 586 587
/* Value returned from text property handlers (see below).  */

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
603 604 605 606 607 608 609 610 611 612 613
  /* 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 *));
614
static enum prop_handled handle_composition_prop P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
615 616 617 618 619 620
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
621
{
Gerd Moellmann's avatar
Gerd Moellmann committed
622 623 624 625 626 627
  {&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},
628
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
629 630
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
631

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

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

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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
650 651 652 653 654 655 656
  /* 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,
657

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

662

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

666
static void setup_for_ellipsis P_ ((struct it *));
667
static void mark_window_display_accurate_1 P_ ((struct window *, int));
668 669
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
670
static int cursor_row_p P_ ((struct window *, struct glyph_row *));
671
static int redisplay_mode_lines P_ ((Lisp_Object, int));
672 673 674 675 676 677 678 679 680 681 682 683 684
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 *));
685
static int single_display_prop_intangible_p P_ ((Lisp_Object));
686
static void ensure_echo_area_buffers P_ ((void));
687 688
static Lisp_Object unwind_with_echo_area_buffer P_ ((Lisp_Object));
static Lisp_Object with_echo_area_buffer_unwind_data P_ ((struct window *));
689
static int with_echo_area_buffer P_ ((struct window *, int,
690 691
				      int (*) (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT),
				      EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
692
static void clear_garbaged_frames P_ ((void));
693 694 695
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));
696
static int display_echo_area P_ ((struct window *));
697 698
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));
699
static Lisp_Object unwind_redisplay P_ ((Lisp_Object));
700
static int string_char_and_length P_ ((unsigned char *, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
701 702 703
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 *));
704
static Lisp_Object safe_eval_handler P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
705 706 707
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 *));
708
static int append_space P_ ((struct it *, int));
709
static int make_cursor_line_fully_visible P_ ((struct window *));
Gerd Moellmann's avatar
Gerd Moellmann committed
710
static int try_scrolling P_ ((Lisp_Object, int, int, int, int));
711
static int try_cursor_movement P_ ((Lisp_Object, struct text_pos, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
712 713 714 715 716 717
static int trailing_whitespace_p P_ ((int));
static int message_log_check_duplicate P_ ((int, int, int, int));
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));
718
static int echo_area_display P_ ((int));
Gerd Moellmann's avatar
Gerd Moellmann committed
719 720 721 722 723 724
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 *));
725
static int display_mode_lines P_ ((struct window *));
726
static int display_mode_line P_ ((struct window *, enum face_id, Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
727
static int display_mode_element P_ ((struct it *, int, int, int, Lisp_Object));
728
static char *decode_mode_spec P_ ((struct window *, int, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
729 730 731 732 733 734
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 *));
735
static int get_overlay_strings P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
736 737 738 739 740
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 *));
741
static void reseat_at_next_visible_line_start P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
742 743 744 745
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 *));
746
static int next_element_from_composition P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
747 748
static int next_element_from_image P_ ((struct it *));
static int next_element_from_stretch P_ ((struct it *));
749
static void load_overlay_strings P_ ((struct it *, int));
750 751
static int init_from_display_pos P_ ((struct it *, struct window *,
				      struct display_pos *));
Gerd Moellmann's avatar
Gerd Moellmann committed
752 753 754 755 756 757 758
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 *));
759 760
static int init_to_row_end P_ ((struct it *, struct window *,
				struct glyph_row *));
Gerd Moellmann's avatar
Gerd Moellmann committed
761
static void back_to_previous_line_start P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
762
static int forward_to_next_line_start P_ ((struct it *, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
763 764 765 766 767 768 769 770 771 772 773
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,
774 775
					   Lisp_Object, struct text_pos *,
					   int));
776
static int underlying_face_id P_ ((struct it *));
777 778
static int in_ellipses_for_invisible_text_p P_ ((struct display_pos *,
						 struct window *));
Gerd Moellmann's avatar
Gerd Moellmann committed
779 780 781

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

Gerd Moellmann's avatar
Gerd Moellmann committed
783
#ifdef HAVE_WINDOW_SYSTEM
784

Gerd Moellmann's avatar
Gerd Moellmann committed
785 786 787 788
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 *));
789

Gerd Moellmann's avatar
Gerd Moellmann committed
790
#endif /* HAVE_WINDOW_SYSTEM */
791

Gerd Moellmann's avatar
Gerd Moellmann committed
792 793 794 795

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
796

Gerd Moellmann's avatar
Gerd Moellmann committed
797 798 799 800 801 802 803 804 805 806
/* 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);
807

Gerd Moellmann's avatar
Gerd Moellmann committed
808 809 810
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
811 812
}

813

Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816
/* 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.  */
817

Gerd Moellmann's avatar
Gerd Moellmann committed
818 819 820 821 822 823 824 825 826
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)
827
    {
828
      width -= FRAME_SCROLL_BAR_WIDTH (f) + FRAME_FLAGS_AREA_COLS (f);
Gerd Moellmann's avatar
Gerd Moellmann committed
829 830 831 832 833 834 835 836 837 838 839 840 841 842
      
      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);
843
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
844 845

  return width * CANON_X_UNIT (f);
846
}
847 848


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

Gerd Moellmann's avatar
Gerd Moellmann committed
852 853 854
INLINE int
window_box_height (w)
     struct window *w;
855
{
Gerd Moellmann's avatar
Gerd Moellmann committed
856 857
  struct frame *f = XFRAME (w->frame);
  int height = XFASTINT (w->height) * CANON_Y_UNIT (f);
858 859

  xassert (height >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
860
  
861 862 863 864 865 866
  /* 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
867
  if (WINDOW_WANTS_MODELINE_P (w))
868 869 870 871 872 873 874 875 876 877
    {
      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
878

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
879
  if (WINDOW_WANTS_HEADER_LINE_P (w))
880 881 882 883 884 885 886 887 888 889
    {
      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
890 891

  return height;
Karl Heuer's avatar
Karl Heuer committed
892 893 894
}


Gerd Moellmann's avatar
Gerd Moellmann committed
895 896 897 898
/* 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
899

Gerd Moellmann's avatar
Gerd Moellmann committed
900 901 902 903
INLINE int
window_box_left (w, area)
     struct window *w;
     int area;
904
{
Gerd Moellmann's avatar
Gerd Moellmann committed
905 906
  struct frame *f = XFRAME (w->frame);
  int x = FRAME_INTERNAL_BORDER_WIDTH_SAFE (f);
907

Gerd Moellmann's avatar
Gerd Moellmann committed
908
  if (!w->pseudo_window_p)
909
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
910
      x += (WINDOW_LEFT_MARGIN (w) * CANON_X_UNIT (f)
911
	    + FRAME_LEFT_FLAGS_AREA_WIDTH (f));
Gerd Moellmann's avatar
Gerd Moellmann committed
912 913 914 915 916 917
      
      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));
918
    }
919

Gerd Moellmann's avatar
Gerd Moellmann committed
920 921
  return x;
}     
922

923

Gerd Moellmann's avatar
Gerd Moellmann committed
924 925 926 927
/* 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.  */
928

Gerd Moellmann's avatar
Gerd Moellmann committed
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
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
958 959
  if (WINDOW_WANTS_HEADER_LINE_P (w))
    *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
960
}
961 962


Gerd Moellmann's avatar
Gerd Moellmann committed
963 964 965 966 967 968 969
/* 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.  */
970

Gerd Moellmann's avatar
Gerd Moellmann committed
971 972 973 974 975 976
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;
977
{
Gerd Moellmann's avatar
Gerd Moellmann committed
978 979 980 981
  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;
982 983
}

Gerd Moellmann's avatar
Gerd Moellmann committed
984 985 986 987 988 989

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

990 991 992 993 994 995 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
/* 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;
}


1030 1031 1032 1033
/* 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.  */
1034 1035

int
1036
pos_visible_p (w, charpos, fully, exact_mode_line_heights_p)
1037
     struct window *w;
1038
     int charpos, *fully, exact_mode_line_heights_p;
1039 1040 1041
{
  struct it it;
  struct text_pos top;
1042 1043 1044 1045 1046 1047 1048 1049
  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));
    }
1050 1051 1052

  *fully = visible_p = 0;
  SET_TEXT_POS_FROM_MARKER (top, w->start);
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
  
  /* 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);
    }
1067

1068
  start_display (&it, w, top);
1069 1070
  move_it_to (&it, charpos, 0, it.last_visible_y, -1,
	      MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
1071 1072 1073

  /* Note that we may overshoot because of invisible text.  */
  if (IT_CHARPOS (it) >= charpos)
1074
    {
1075 1076
      int top_y = it.current_y;
      int bottom_y = line_bottom_y (&it);
1077
      int window_top_y = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
1078
      
1079 1080 1081
      if (top_y < window_top_y)
	visible_p = bottom_y > window_top_y;
      else if (top_y < it.last_visible_y)
1082 1083
	{
	  visible_p = 1;
1084
	  *fully = bottom_y <= it.last_visible_y;
1085
	}
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
    }
  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;
	}
    }
1096 1097 1098

  if (old_buffer)
    set_buffer_internal_1 (old_buffer);
1099 1100

  current_header_line_height = current_mode_line_height = -1;
1101 1102 1103 1104
  return visible_p;
}


1105 1106 1107
/* 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
1108
   we find one, we return a `?', but with the length of the invalid
1109 1110 1111
   character.  */

static INLINE int
1112
string_char_and_length (str, maxlen, len)
1113
     unsigned char *str;
1114
     int maxlen, *len;
1115 1116 1117 1118 1119 1120
{
  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
1121
       don't use this function, i.e. they silently accept invalid
1122 1123 1124 1125 1126 1127 1128 1129
       characters.  */
    c = '?';

  return c;
}



Gerd Moellmann's avatar
Gerd Moellmann committed
1130 1131 1132 1133 1134 1135 1136 1137
/* 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
1138
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
  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--)
	{
1149
	  string_char_and_length (p, rest, &len);
Gerd Moellmann's avatar
Gerd Moellmann committed
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
	  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;