xdisp.c 400 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
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"
Jim Blandy's avatar
Jim Blandy committed
173
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
174 175 176 177
#include "window.h"
#include "termchar.h"
#include "dispextern.h"
#include "buffer.h"
178
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
179 180 181 182
#include "indent.h"
#include "commands.h"
#include "macros.h"
#include "disptab.h"
183
#include "termhooks.h"
184
#include "intervals.h"
Karl Heuer's avatar
Karl Heuer committed
185
#include "keyboard.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
Jim Blandy's avatar
Jim Blandy committed
197

Gerd Moellmann's avatar
Gerd Moellmann committed
198 199 200 201 202
#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

#define INFINITY 10000000

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

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

211 212
extern int minibuffer_auto_raise;

213 214
extern Lisp_Object Qface;

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

219
Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
220
Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
221
Lisp_Object Qredisplay_end_trigger_functions;
222
Lisp_Object Qinhibit_point_motion_hooks;
223
Lisp_Object QCeval, Qwhen, QCfile, QCdata;
Gerd Moellmann's avatar
Gerd Moellmann committed
224 225 226 227 228 229 230
Lisp_Object Qfontified;

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

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
234
int auto_raise_tool_bar_buttons_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
235

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
242
int tool_bar_button_relief;
Gerd Moellmann's avatar
Gerd Moellmann committed
243

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

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

249 250 251 252
/* Non-nil means don't actually do any redisplay.  */

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

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

255 256
Lisp_Object Qdisplay, Qrelative_width, Qalign_to;
extern Lisp_Object Qface, Qinvisible, Qimage, Qwidth;
Gerd Moellmann's avatar
Gerd Moellmann committed
257 258 259 260

/* Symbols used in text property values.  */

Lisp_Object Qspace, QCalign_to, QCrelative_width, QCrelative_height;
261
Lisp_Object Qleft_margin, Qright_margin, Qspace_width, Qraise;
262
Lisp_Object Qmargin;
263
extern Lisp_Object Qheight;
Gerd Moellmann's avatar
Gerd Moellmann committed
264

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

267
Lisp_Object Vshow_trailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
268 269 270 271 272 273 274 275 276 277 278 279

/* 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
280 281 282

int noninteractive_need_newline;

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

285
static int message_log_need_newline;
286

Gerd Moellmann's avatar
Gerd Moellmann committed
287 288 289 290 291

/* 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
292

Gerd Moellmann's avatar
Gerd Moellmann committed
293
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
294

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

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
303 304 305 306 307 308 309
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
310

Gerd Moellmann's avatar
Gerd Moellmann committed
311
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
312 313 314

static struct buffer *this_line_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
315 316
/* Nonzero means truncate lines in all windows less wide than the
   frame.  */
Jim Blandy's avatar
Jim Blandy committed
317 318 319

int truncate_partial_width_windows;

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

322
int unibyte_display_via_language_environment;
Gerd Moellmann's avatar
Gerd Moellmann committed
323 324 325 326
 
/* Nonzero means we have more than one non-mini-buffer-only frame.
   Not guaranteed to be accurate except while parsing
   frame-title-format.  */
327

328 329
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
330 331 332
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
333

Jim Blandy's avatar
Jim Blandy committed
334 335
Lisp_Object Voverlay_arrow_position;

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

Jim Blandy's avatar
Jim Blandy committed
338 339
Lisp_Object Voverlay_arrow_string;

Gerd Moellmann's avatar
Gerd Moellmann committed
340 341 342 343
/* Values of those variables at last redisplay.  However, if
   Voverlay_arrow_position is a marker, last_arrow_position is its
   numerical position.  */

344 345
static Lisp_Object last_arrow_position, last_arrow_string;

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

348 349
Lisp_Object Vframe_title_format;

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

352 353
Lisp_Object Vicon_title_format;

354 355 356
/* 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
357

358 359
static Lisp_Object Vwindow_size_change_functions;

360 361
Lisp_Object Qmenu_bar_update_hook;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
364
static int overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
365

366 367
/* Nonzero means highlight the region even in nonselected windows.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
368 369 370 371 372
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.  */

373
static int scroll_step;
Jim Blandy's avatar
Jim Blandy committed
374

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

378 379
static int scroll_conservatively;

Gerd Moellmann's avatar
Gerd Moellmann committed
380 381 382 383 384
/* 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.  */

385 386
int scroll_margin;

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

int buffer_shared;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
395
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
396

Gerd Moellmann's avatar
Gerd Moellmann committed
397
/* Nonzero means display mode line highlighted.  */
Jim Blandy's avatar
Jim Blandy committed
398 399 400

int mode_line_inverse_video;

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

403
Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
404

Gerd Moellmann's avatar
Gerd Moellmann committed
405 406 407
/* 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
408
int minibuf_prompt_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
409 410 411 412 413 414
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.  */

415 416
Lisp_Object echo_area_window;

417 418 419 420 421 422 423
/* 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;

424 425
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
426

427 428
int message_enable_multibyte;

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

Jim Blandy's avatar
Jim Blandy committed
431 432
int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
433 434 435
/* Nonzero if window sizes or contents have changed since last
   redisplay that finished */

Jim Blandy's avatar
Jim Blandy committed
436 437
int windows_or_buffers_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
438 439 440
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

441 442 443
int line_number_displayed;

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

445
Lisp_Object Vline_number_display_limit;
Karl Heuer's avatar
Karl Heuer committed
446

447 448 449 450
/* line width to consider when repostioning for line number display */

static int line_number_display_limit_width;

Gerd Moellmann's avatar
Gerd Moellmann committed
451 452 453
/* 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
454
Lisp_Object Vmessage_log_max;
455

456 457 458 459
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
/* 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;

483 484 485
/* Maximum height for resizing mini-windows.  Either a float
   specifying a fraction of the available height, or an integer
   specifying a number of lines.  */
486

487 488 489 490 491 492 493
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;
494

495 496 497 498 499
/* 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
500 501
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
502

Gerd Moellmann's avatar
Gerd Moellmann committed
503 504 505
#define MAX_SCRATCH_GLYPHS 100
struct glyph_row scratch_glyph_row;
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
506

Gerd Moellmann's avatar
Gerd Moellmann committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
/* Ascent and height of the last line processed by move_it_to.  */

static int last_max_ascent, last_height;

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

/* Non-zero means print traces of redisplay if compiled with
   GLYPH_DEBUG != 0.  */

#if GLYPH_DEBUG
int trace_redisplay_p;
#endif

526 527 528 529 530
/* Non-zero means automatically scroll windows horizontally to make
   point visible.  */

int automatic_hscrolling_p;

531 532 533 534
/* A list of symbols, one for each supported image type.  */

Lisp_Object Vimage_types;

Gerd Moellmann's avatar
Gerd Moellmann committed
535 536 537
/* Value returned from text property handlers (see below).  */

enum prop_handled
538
{
Gerd Moellmann's avatar
Gerd Moellmann committed
539 540 541 542 543
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
544

Gerd Moellmann's avatar
Gerd Moellmann committed
545 546
/* A description of text properties that redisplay is interested
   in.  */
547

Gerd Moellmann's avatar
Gerd Moellmann committed
548 549 550 551
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
552

Gerd Moellmann's avatar
Gerd Moellmann committed
553 554 555 556 557 558 559 560 561 562 563
  /* 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 *));
564
static enum prop_handled handle_composition_prop P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
565 566 567 568 569 570
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
571
{
Gerd Moellmann's avatar
Gerd Moellmann committed
572 573 574 575 576 577
  {&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},
578
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
579 580
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
581

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
589 590 591 592
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
593

Gerd Moellmann's avatar
Gerd Moellmann committed
594 595
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
596

Gerd Moellmann's avatar
Gerd Moellmann committed
597 598
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
599

Gerd Moellmann's avatar
Gerd Moellmann committed
600 601 602 603 604 605 606
  /* 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,
607

Gerd Moellmann's avatar
Gerd Moellmann committed
608 609 610
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
611

612

Gerd Moellmann's avatar
Gerd Moellmann committed
613 614 615

/* Function prototypes.  */

616 617 618 619 620 621 622 623 624 625 626 627 628
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 *));
629
static int single_display_prop_intangible_p P_ ((Lisp_Object));
630
static void ensure_echo_area_buffers P_ ((void));
Gerd Moellmann's avatar
Gerd Moellmann committed
631 632 633
static struct glyph_row *row_containing_pos P_ ((struct window *, int,
						 struct glyph_row *,
						 struct glyph_row *));
634 635
static Lisp_Object unwind_with_echo_area_buffer P_ ((Lisp_Object));
static Lisp_Object with_echo_area_buffer_unwind_data P_ ((struct window *));
636
static int with_echo_area_buffer P_ ((struct window *, int,
637 638
				      int (*) (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT),
				      EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
639
static void clear_garbaged_frames P_ ((void));
640 641 642
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));
643
static int display_echo_area P_ ((struct window *));
644 645
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));
646
static Lisp_Object unwind_redisplay P_ ((Lisp_Object));
647
static int string_char_and_length P_ ((unsigned char *, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
648 649 650 651 652 653 654
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 *));
static Lisp_Object eval_handler P_ ((Lisp_Object));
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 *));
655
static int append_space P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
656 657 658 659 660 661 662 663 664 665
static void make_cursor_line_fully_visible P_ ((struct window *));
static int try_scrolling P_ ((Lisp_Object, int, int, int, int));
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));
666
static int echo_area_display P_ ((int));
Gerd Moellmann's avatar
Gerd Moellmann committed
667 668 669 670 671 672 673 674 675 676
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 *));
static void display_mode_lines P_ ((struct window *));
static void display_mode_line P_ ((struct window *, enum face_id,
				   Lisp_Object));
static int display_mode_element P_ ((struct it *, int, int, int, Lisp_Object));
677
static char *decode_mode_spec P_ ((struct window *, int, int, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
678 679 680 681 682 683 684 685 686 687 688 689 690
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 *));
static int get_overlay_strings P_ ((struct it *));
static void next_overlay_string P_ ((struct it *));
void set_iterator_to_next 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 *));
691
static void reseat_at_next_visible_line_start P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
692 693 694 695
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 *));
696
static int next_element_from_composition P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
static int next_element_from_image P_ ((struct it *));
static int next_element_from_stretch P_ ((struct it *));
static void load_overlay_strings P_ ((struct it *));
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 *));
static void forward_to_next_line_start P_ ((struct it *));
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,
					   Lisp_Object, struct text_pos *));

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

Gerd Moellmann's avatar
Gerd Moellmann committed
729
#ifdef HAVE_WINDOW_SYSTEM
730

Gerd Moellmann's avatar
Gerd Moellmann committed
731 732 733 734
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 *));
735

Gerd Moellmann's avatar
Gerd Moellmann committed
736
#endif /* HAVE_WINDOW_SYSTEM */
737

Gerd Moellmann's avatar
Gerd Moellmann committed
738 739 740 741

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
742

Gerd Moellmann's avatar
Gerd Moellmann committed
743 744 745 746 747 748 749 750 751 752 753 754 755 756
/* 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);
  
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
757 758
}

759

Gerd Moellmann's avatar
Gerd Moellmann committed
760 761 762
/* 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.  */
763

Gerd Moellmann's avatar
Gerd Moellmann committed
764 765 766 767 768 769 770 771 772
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)
773
    {
774
      width -= FRAME_SCROLL_BAR_WIDTH (f) + FRAME_FLAGS_AREA_COLS (f);
Gerd Moellmann's avatar
Gerd Moellmann committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788
      
      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);
789
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
790 791

  return width * CANON_X_UNIT (f);
792
}
793 794


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

Gerd Moellmann's avatar
Gerd Moellmann committed
798 799 800
INLINE int
window_box_height (w)
     struct window *w;
801
{
Gerd Moellmann's avatar
Gerd Moellmann committed
802 803 804 805 806 807
  struct frame *f = XFRAME (w->frame);
  int height = XFASTINT (w->height) * CANON_Y_UNIT (f);
  
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
808 809
  if (WINDOW_WANTS_HEADER_LINE_P (w))
    height -= CURRENT_HEADER_LINE_HEIGHT (w);
Gerd Moellmann's avatar
Gerd Moellmann committed
810 811

  return height;
Karl Heuer's avatar
Karl Heuer committed
812 813 814
}


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

Gerd Moellmann's avatar
Gerd Moellmann committed
820 821 822 823
INLINE int
window_box_left (w, area)
     struct window *w;
     int area;
824
{
Gerd Moellmann's avatar
Gerd Moellmann committed
825 826
  struct frame *f = XFRAME (w->frame);
  int x = FRAME_INTERNAL_BORDER_WIDTH_SAFE (f);
827

Gerd Moellmann's avatar
Gerd Moellmann committed
828
  if (!w->pseudo_window_p)
829
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
830
      x += (WINDOW_LEFT_MARGIN (w) * CANON_X_UNIT (f)
831
	    + FRAME_LEFT_FLAGS_AREA_WIDTH (f));
Gerd Moellmann's avatar
Gerd Moellmann committed
832 833 834 835 836 837
      
      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));
838
    }
839

Gerd Moellmann's avatar
Gerd Moellmann committed
840 841
  return x;
}     
842

843

Gerd Moellmann's avatar
Gerd Moellmann committed
844 845 846 847
/* 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.  */
848

Gerd Moellmann's avatar
Gerd Moellmann committed
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
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
878 879
  if (WINDOW_WANTS_HEADER_LINE_P (w))
    *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
880
}
881 882


Gerd Moellmann's avatar
Gerd Moellmann committed
883 884 885 886 887 888 889
/* 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.  */
890

Gerd Moellmann's avatar
Gerd Moellmann committed
891 892 893 894 895 896
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;
897
{
Gerd Moellmann's avatar
Gerd Moellmann committed
898 899 900 901
  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;
902 903
}

Gerd Moellmann's avatar
Gerd Moellmann committed
904 905 906 907 908 909

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

910 911 912
/* 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
913
   we find one, we return a `?', but with the length of the invalid
914 915 916
   character.  */

static INLINE int
917
string_char_and_length (str, maxlen, len)
918
     unsigned char *str;
919
     int maxlen, *len;
920 921 922 923 924 925
{
  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
926
       don't use this function, i.e. they silently accept invalid
927 928 929 930 931 932 933 934
       characters.  */
    c = '?';

  return c;
}



Gerd Moellmann's avatar
Gerd Moellmann committed
935 936 937 938 939 940 941 942
/* 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
943
{
Gerd Moellmann's avatar
Gerd Moellmann committed
944 945 946 947 948 949 950 951 952 953
  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--)
	{
954
	  string_char_and_length (p, rest, &len);
Gerd Moellmann's avatar
Gerd Moellmann committed
955 956 957 958 959 960 961 962 963 964
	  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;
965 966 967
}


Gerd Moellmann's avatar
Gerd Moellmann committed
968 969 970 971 972 973
/* 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;
974 975
     Lisp_Object string;
{
Gerd Moellmann's avatar
Gerd Moellmann committed
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
  struct text_pos pos;
  xassert (STRINGP (string));
  xassert (charpos >= 0);
  SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
  return pos;
}


/* Value is a text position, i.e. character and byte position, for
   character position CHARPOS in C string S.  MULTIBYTE_P non-zero
   means recognize multibyte characters.  */

static struct text_pos
c_string_pos (charpos, s, multibyte_p)
     int charpos;
     unsigned char *s;
     int multibyte_p;
{
  struct text_pos pos;

  xassert (s != NULL);
  xassert (charpos >= 0);

  if (multibyte_p)
1000
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
1001 1002 1003 1004
      int rest = strlen (s), len;

      SET_TEXT_POS (pos, 0, 0);
      while (charpos--)
1005
	{
1006
	  string_char_and_length (s, rest, &len);
Gerd Moellmann's avatar
Gerd Moellmann committed
1007 1008 1009 1010
	  s += len, rest -= len;
	  xassert (rest >= 0);
	  CHARPOS (pos) += 1;
	  BYTEPOS (pos) += len;
1011 1012
	}
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
1013 1014
  else
    SET_TEXT_POS (pos, charpos, charpos);
1015

Gerd Moellmann's avatar
Gerd Moellmann committed
1016 1017
  return pos;
}
1018 1019


Gerd Moellmann's avatar
Gerd Moellmann committed
1020 1021
/* Value is the number of characters in C string S.  MULTIBYTE_P
   non-zero means recognize multibyte characters.  */
1022

Gerd Moellmann's avatar
Gerd Moellmann committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
static int
number_of_chars (s, multibyte_p)
     unsigned char *s;
     int multibyte_p;
{
  int nchars;
  
  if (multibyte_p)
    {
      int rest = strlen (s), len;
      unsigned char *p = (unsigned char *) s;
1034

Gerd Moellmann's avatar
Gerd Moellmann committed
1035 1036
      for (nchars = 0; rest > 0; ++nchars)
	{
1037
	  string_char_and_length (p, rest, &len);
Gerd Moellmann's avatar
Gerd Moellmann committed
1038
	  rest -= len, p += len;
1039 1040
	}
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
1041 1042 1043 1044
  else
    nchars = strlen (s);

  return nchars;
Karl Heuer's avatar
Karl Heuer committed
1045 1046
}

Gerd Moellmann's avatar
Gerd Moellmann committed
1047 1048 1049 1050
     
/* Compute byte position NEWPOS->bytepos corresponding to
   NEWPOS->charpos.  POS is a known position in string STRING.
   NEWPOS->charpos must be >= POS.charpos.  */
1051

Gerd Moellmann's avatar
Gerd Moellmann committed
1052 1053 1054 1055
static void
compute_string_pos (newpos, pos, string)
     struct text_pos *newpos, pos;
     Lisp_Object string;
1056
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1057 1058 1059 1060
  xassert (STRINGP (string));
  xassert (CHARPOS (*newpos) >= CHARPOS (pos));
  
  if (STRING_MULTIBYTE (string))
1061 1062
    *newpos = string_pos_nchars_ahead (pos, string,
				       CHARPOS (*newpos) - CHARPOS (pos));
Gerd Moellmann's avatar
Gerd Moellmann committed
1063 1064
  else
    BYTEPOS (*newpos) = CHARPOS (*newpos);
1065 1066
}

Jim Blandy's avatar
Jim Blandy committed
1067

Gerd Moellmann's avatar
Gerd Moellmann committed
1068 1069 1070 1071 1072

/***********************************************************************
			Lisp form evaluation
 ***********************************************************************/

1073
/* Error handler for eval_form and call_function.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085

static Lisp_Object
eval_handler (arg)
     Lisp_Object arg;
{
  return Qnil;
}


/* Evaluate SEXPR and return the result, or nil if something went
   wrong.  */

1086
Lisp_Object
Gerd Moellmann's avatar
Gerd Moellmann committed
1087 1088 1089 1090
eval_form (sexpr)
     Lisp_Object sexpr;
{
  int count = specpdl_ptr - specpdl;
1091
  struct gcpro gcpro1;
Gerd Moellmann's avatar
Gerd Moellmann committed
1092
  Lisp_Object val;
1093 1094

  GCPRO1 (sexpr);
Gerd Moellmann's avatar
Gerd Moellmann committed
1095 1096
  specbind (Qinhibit_redisplay, Qt);
  val = internal_condition_case_1 (Feval, sexpr, Qerror, eval_handler);
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
  UNGCPRO;
  return unbind_to (count, val);
}


/* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
   Return the result, or nil if something went wrong.  */

Lisp_Object
call_function (nargs, args)
     int nargs;
     Lisp_Object *args;
{
  int count = specpdl_ptr - specpdl;
  Lisp_Object val;
  struct gcpro gcpro1;

  GCPRO1 (args[0]);
  gcpro1.nvars = nargs;
  specbind (Qinhibit_redisplay, Qt);
  val = internal_condition_case_2 (Ffuncall, nargs, args, Qerror,
				   eval_handler);
  UNGCPRO;
Gerd Moellmann's avatar
Gerd Moellmann committed
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
  return unbind_to (count, val);
}



/***********************************************************************
			      Debugging
 ***********************************************************************/

#if 0

/* Define CHECK_IT to perform sanity checks on iterators.
   This is for debugging.  It is too slow to do unconditionally.  */

static void
check_it (it)
     struct it *it;
{
  if (it->method == next_element_from_string)
Jim Blandy's avatar
Jim Blandy committed
1139
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
1140 1141 1142 1143 1144 1145 1146 1147
      xassert (STRINGP (it->string));
      xassert (IT_STRING_CHARPOS (*it) >= 0);
    }
  else if (it->method == next_element_from_buffer)
    {
      /* Check that character and byte positions agree.  */
      xassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
    }
1148

Gerd Moellmann's avatar
Gerd Moellmann committed
1149 1150 1151 1152 1153
  if (it->dpvec)
    xassert (it->current.dpvec_index >= 0);
  else
    xassert (it->current.dpvec_index < 0);
}
1154

Gerd Moellmann's avatar
Gerd Moellmann committed
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
#define CHECK_IT(IT)	check_it ((IT))

#else /* not 0 */

#define CHECK_IT(IT)	(void) 0

#endif /* not 0 */


#if GLYPH_DEBUG

/* Check that the window end of window W is what we expect it
   to be---the last row in the current matrix displaying text.  */

static void
check_window_end (w)
     struct window *w;
{
  if (!MINI_WINDOW_P (w)
      && !NILP (w->window_end_valid))
    {
      struct glyph_row *row;
      xassert ((row = MATRIX_ROW (w->current_matrix,
				  XFASTINT (w->window_end_vpos)),
		!row->enabled_p
		|| MATRIX_ROW_DISPLAYS_TEXT_P (row)
		|| MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
    }
}

#define CHECK_WINDOW_END(W)	check_window_end ((W))

#else /* not GLYPH_DEBUG */

#define CHECK_WINDOW_END(W)	(void) 0

#endif /* not GLYPH_DEBUG */



/***********************************************************************
		       Iterator initialization
 ***********************************************************************/

/* Initialize IT for displaying current_buffer in window W, starting
   at character position CHARPOS.  CHARPOS < 0 means that no buffer
   position is specified which is useful when the iterator is assigned
   a position later.  BYTEPOS is the byte position corresponding to
   CHARPOS.  BYTEPOS <= 0 means compute it from CHARPOS.

   If ROW is not null, calls to produce_glyphs with IT as parameter
   will produce glyphs in that row.

   BASE_FACE_ID is the id of a base face to use.  It must be one of
   DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID or
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1210
   HEADER_LINE_FACE_ID for displaying mode lines, or TOOL_BAR_FACE_ID for
Gerd Moellmann's avatar
Gerd Moellmann committed
1211
   displaying the tool-bar.
Gerd Moellmann's avatar
Gerd Moellmann committed
1212 1213
   
   If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID or
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1214
   HEADER_LINE_FACE_ID, the iterator will be initialized to use the
Gerd Moellmann's avatar
Gerd Moellmann committed
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
   corresponding mode line glyph row of the desired matrix of W.  */

void
init_iterator (it, w, charpos, bytepos, row, base_face_id)
     struct it *it;
     struct window *w;
     int charpos, bytepos;
     struct glyph_row *row;
     enum face_id base_face_id;
{
  int highlight_region_p;

  /* Some precondition checks.  */
  xassert (w != NULL && it != NULL);
  xassert (charpos < 0 || (charpos > 0 && charpos <= ZV));

  /* If face attributes have been changed since the last redisplay,
     free realized faces now because they depend on face definitions
     that might have changed.  */
  if (face_change_count)
    {
      face_change_count = 0;
      free_all_realized_faces (Qnil);
    }

  /* Use one of the mode line rows of W's desired matrix if
     appropriate.  */
  if (row == NULL)
    {
      if (base_face_id == MODE_LINE_FACE_ID)
	row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
1246 1247
      else if (base_face_id == HEADER_LINE_FACE_ID)
	row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
    }
  
  /* Clear IT.  */
  bzero (it, sizeof *it);
  it->current.overlay_string_index = -1;
  it->current.dpvec_index = -1;
  it->base_face_id = base_face_id;

  /* The window in which we iterate over current_buffer:  */
  XSETWINDOW (it->window, w);
  it->w = w;
  it->f = XFRAME (w->frame);

1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
  /* Extra space between lines (on window systems only).  */
  if (base_face_id == DEFAULT_FACE_ID
      && FRAME_WINDOW_P (it->f))
    {
      if (NATNUMP (current_buffer->extra_line_spacing))
	it->extra_line_spacing = XFASTINT (current_buffer->extra_line_spacing);
      else if (it->f->extra_line_spacing > 0)
	it->extra_line_spacing = it->f->extra_line_spacing;
    }

Gerd Moellmann's avatar
Gerd Moellmann committed
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291