xdisp.c 452 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, 2002
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
/* 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,
Pavel Janík's avatar
Pavel Janík committed
36
   let's say almost---see the description of direct update
37
   operations, below.)
Gerd Moellmann's avatar
Gerd Moellmann committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

   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
55
   +--------------+   redisplay     +----------------+
Gerd Moellmann's avatar
Gerd Moellmann committed
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
   | 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.

Pavel Janík's avatar
Pavel Janík committed
91
   You will find a lot of redisplay optimizations when you start
Gerd Moellmann's avatar
Gerd Moellmann committed
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
   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.

Pavel Janík's avatar
Pavel Janík committed
126
   Iteration over things to be displayed is then simple.  It is
Gerd Moellmann's avatar
Gerd Moellmann committed
127 128 129
   started by initializing an iterator with a call to init_iterator.
   Calls to get_next_display_element fill the iterator structure with
   relevant information about the next thing to display.  Calls to
Gerd Moellmann's avatar
Gerd Moellmann committed
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
   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
168

169
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
170
#include <stdio.h>
171

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

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

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

203
#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (macintosh)
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, QCpropertize;
Gerd Moellmann's avatar
Gerd Moellmann committed
224
Lisp_Object Qfontified;
225
Lisp_Object Qgrow_only;
226
Lisp_Object Qinhibit_eval_during_redisplay;
227
Lisp_Object Qbuffer_position, Qposition, Qobject;
Gerd Moellmann's avatar
Gerd Moellmann committed
228

229 230 231
/* Holds the list (error).  */
Lisp_Object list_of_error;

Gerd Moellmann's avatar
Gerd Moellmann committed
232 233 234 235 236
/* Functions called to fontify regions of text.  */

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

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

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

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

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

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

248
EMACS_INT tool_bar_button_relief;
Gerd Moellmann's avatar
Gerd Moellmann committed
249

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

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

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

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

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

261
int inhibit_eval_during_redisplay;
262

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

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

/* Symbols used in text property values.  */

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

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

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

/* 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
290 291 292

int noninteractive_need_newline;

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

295
static int message_log_need_newline;
296

297 298 299 300 301 302
/* Three markers that message_dolog uses.
   It could allocate them itself, but that causes trouble
   in handling memory-full errors.  */
static Lisp_Object message_dolog_marker1;
static Lisp_Object message_dolog_marker2;
static Lisp_Object message_dolog_marker3;
Gerd Moellmann's avatar
Gerd Moellmann committed
303 304 305 306 307

/* 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
308

Gerd Moellmann's avatar
Gerd Moellmann committed
309
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
310

Gerd Moellmann's avatar
Gerd Moellmann committed
311 312 313 314 315 316
/* 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
317 318

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
319 320 321 322 323 324 325
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
326

Gerd Moellmann's avatar
Gerd Moellmann committed
327
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
328 329 330

static struct buffer *this_line_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
331 332
/* Nonzero means truncate lines in all windows less wide than the
   frame.  */
Jim Blandy's avatar
Jim Blandy committed
333 334 335

int truncate_partial_width_windows;

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

338
int unibyte_display_via_language_environment;
Gerd Moellmann's avatar
Gerd Moellmann committed
339 340 341 342
 
/* Nonzero means we have more than one non-mini-buffer-only frame.
   Not guaranteed to be accurate except while parsing
   frame-title-format.  */
343

344 345
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
346 347 348
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
349

Jim Blandy's avatar
Jim Blandy committed
350 351
Lisp_Object Voverlay_arrow_position;

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

Jim Blandy's avatar
Jim Blandy committed
354 355
Lisp_Object Voverlay_arrow_string;

Gerd Moellmann's avatar
Gerd Moellmann committed
356 357 358 359
/* Values of those variables at last redisplay.  However, if
   Voverlay_arrow_position is a marker, last_arrow_position is its
   numerical position.  */

360 361
static Lisp_Object last_arrow_position, last_arrow_string;

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

364 365
Lisp_Object Vframe_title_format;

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

368 369
Lisp_Object Vicon_title_format;

370 371 372
/* 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
373

374 375
static Lisp_Object Vwindow_size_change_functions;

376
Lisp_Object Qmenu_bar_update_hook, Vmenu_bar_update_hook;
377

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

Gerd Moellmann's avatar
Gerd Moellmann committed
380
static int overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
381

382 383
/* Nonzero means highlight the region even in nonselected windows.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
384 385 386 387 388
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.  */

389
static EMACS_INT scroll_step;
Jim Blandy's avatar
Jim Blandy committed
390

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

394
static EMACS_INT scroll_conservatively;
395

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

401
EMACS_INT scroll_margin;
402

Gerd Moellmann's avatar
Gerd Moellmann committed
403 404 405
/* 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
406 407 408

int buffer_shared;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
411
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
412

413 414 415 416 417
/* 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
418 419 420

int mode_line_inverse_video;

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

423
Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
424

Gerd Moellmann's avatar
Gerd Moellmann committed
425 426 427
/* 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
428
int minibuf_prompt_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
429 430 431 432 433 434
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.  */

435 436
Lisp_Object echo_area_window;

437 438 439 440 441 442 443
/* 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;

444 445
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
446

447 448
int message_enable_multibyte;

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

Jim Blandy's avatar
Jim Blandy committed
451 452
int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
453
/* Nonzero if window sizes or contents have changed since last
454
   redisplay that finished.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
455

Jim Blandy's avatar
Jim Blandy committed
456 457
int windows_or_buffers_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
458 459 460
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

461 462 463
int line_number_displayed;

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

465
Lisp_Object Vline_number_display_limit;
Karl Heuer's avatar
Karl Heuer committed
466

467
/* Line width to consider when repositioning for line number display.  */
468

469
static EMACS_INT line_number_display_limit_width;
470

Gerd Moellmann's avatar
Gerd Moellmann committed
471 472 473
/* 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
474
Lisp_Object Vmessage_log_max;
475

476 477 478 479
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
/* 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;

503 504 505 506 507
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

Lisp_Object Qinhibit_menubar_update;
int inhibit_menubar_update;

508 509 510
/* Maximum height for resizing mini-windows.  Either a float
   specifying a fraction of the available height, or an integer
   specifying a number of lines.  */
511

512 513 514 515 516 517 518
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;
519

520 521 522 523 524
/* Set to 1 in clear_message to make redisplay_internal aware
   of an emptied echo area.   */

static int message_cleared_p;

525 526 527 528
/* 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;
529
Lisp_Object Qcursor_in_non_selected_windows;
530

Gerd Moellmann's avatar
Gerd Moellmann committed
531 532
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
533

Gerd Moellmann's avatar
Gerd Moellmann committed
534 535 536
#define MAX_SCRATCH_GLYPHS 100
struct glyph_row scratch_glyph_row;
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
537

Gerd Moellmann's avatar
Gerd Moellmann committed
538 539 540 541
/* Ascent and height of the last line processed by move_it_to.  */

static int last_max_ascent, last_height;

542 543 544 545
/* Non-zero if there's a help-echo in the echo area.  */

int help_echo_showing_p;

546 547 548 549 550 551
/* 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
552 553 554 555 556 557 558 559
/* 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

560 561
#if GLYPH_DEBUG

562 563 564 565 566
/* Variables to turn off display optimizations from Lisp.  */

int inhibit_try_window_id, inhibit_try_window_reusing;
int inhibit_try_cursor_movement;

Gerd Moellmann's avatar
Gerd Moellmann committed
567 568 569 570
/* Non-zero means print traces of redisplay if compiled with
   GLYPH_DEBUG != 0.  */

int trace_redisplay_p;
571

572
#endif /* GLYPH_DEBUG */
573

574 575
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
576 577 578 579
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
580
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
581
#endif
582
 
583 584 585 586 587
/* Non-zero means automatically scroll windows horizontally to make
   point visible.  */

int automatic_hscrolling_p;

588 589
/* How close to the margin can point get before the window is scrolled
   horizontally.  */
590
EMACS_INT hscroll_margin;
591 592

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

595 596 597 598
/* A list of symbols, one for each supported image type.  */

Lisp_Object Vimage_types;

599
/* The variable `resize-mini-windows'.  If nil, don't resize
Eli Zaretskii's avatar
Eli Zaretskii committed
600
   mini-windows.  If t, always resize them to fit the text they
601 602 603 604 605
   display.  If `grow-only', let mini-windows grow only until they
   become empty.  */

Lisp_Object Vresize_mini_windows;

606 607 608 609
/* Buffer being redisplayed -- for redisplay_window_error.  */

struct buffer *displayed_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
610 611 612
/* Value returned from text property handlers (see below).  */

enum prop_handled
613
{
Gerd Moellmann's avatar
Gerd Moellmann committed
614 615 616 617 618
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
619

Gerd Moellmann's avatar
Gerd Moellmann committed
620 621
/* A description of text properties that redisplay is interested
   in.  */
622

Gerd Moellmann's avatar
Gerd Moellmann committed
623 624 625 626
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
627

Gerd Moellmann's avatar
Gerd Moellmann committed
628 629 630 631 632 633 634 635 636 637 638
  /* 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 *));
639
static enum prop_handled handle_composition_prop P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
640 641 642 643 644 645
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
646
{
Gerd Moellmann's avatar
Gerd Moellmann committed
647 648 649 650 651 652
  {&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},
653
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
654 655
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
656

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
664 665 666 667
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
668

Gerd Moellmann's avatar
Gerd Moellmann committed
669 670
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
671

Gerd Moellmann's avatar
Gerd Moellmann committed
672 673
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
674

Gerd Moellmann's avatar
Gerd Moellmann committed
675 676 677 678 679 680 681
  /* 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,
682

Gerd Moellmann's avatar
Gerd Moellmann committed
683 684 685
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
686

687

Gerd Moellmann's avatar
Gerd Moellmann committed
688 689 690

/* Function prototypes.  */

691
static void setup_for_ellipsis P_ ((struct it *));
692
static void mark_window_display_accurate_1 P_ ((struct window *, int));
693 694
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
695
static int cursor_row_p P_ ((struct window *, struct glyph_row *));
696
static int redisplay_mode_lines P_ ((Lisp_Object, int));
697
static char *decode_mode_spec_coding P_ ((Lisp_Object, char *, int));
698 699

#if 0
700
static int invisible_text_between_p P_ ((struct it *, int, int));
701 702
#endif

703 704 705 706 707 708 709 710 711 712 713
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 *));
714
static int single_display_prop_intangible_p P_ ((Lisp_Object));
715
static void ensure_echo_area_buffers P_ ((void));
716 717
static Lisp_Object unwind_with_echo_area_buffer P_ ((Lisp_Object));
static Lisp_Object with_echo_area_buffer_unwind_data P_ ((struct window *));
718
static int with_echo_area_buffer P_ ((struct window *, int,
719 720
				      int (*) (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT),
				      EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
721
static void clear_garbaged_frames P_ ((void));
722 723 724
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));
725
static int display_echo_area P_ ((struct window *));
726 727
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));
728
static Lisp_Object unwind_redisplay P_ ((Lisp_Object));
729
static int string_char_and_length P_ ((unsigned char *, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
730 731 732
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 *));
733
static Lisp_Object safe_eval_handler P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
734 735 736
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 *));
737
static int append_space P_ ((struct it *, int));
738
static int make_cursor_line_fully_visible P_ ((struct window *));
739
static int try_scrolling P_ ((Lisp_Object, int, EMACS_INT, EMACS_INT, int));
740
static int try_cursor_movement P_ ((Lisp_Object, struct text_pos, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
741 742 743 744 745 746
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));
747
static int echo_area_display P_ ((int));
Gerd Moellmann's avatar
Gerd Moellmann committed
748 749
static void redisplay_windows P_ ((Lisp_Object));
static void redisplay_window P_ ((Lisp_Object, int));
750 751 752
static Lisp_Object redisplay_window_error ();
static Lisp_Object redisplay_window_0 P_ ((Lisp_Object));
static Lisp_Object redisplay_window_1 P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
753 754 755 756
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 *));
757
static int display_mode_lines P_ ((struct window *));
758
static int display_mode_line P_ ((struct window *, enum face_id, Lisp_Object));
759
static int display_mode_element P_ ((struct it *, int, int, int, Lisp_Object, Lisp_Object));
760
static char *decode_mode_spec P_ ((struct window *, int, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
761 762 763 764 765 766
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 *));
767
static int get_overlay_strings P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
768 769 770 771 772
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 *));
773
static void reseat_at_next_visible_line_start P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
774 775 776 777
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 *));
778
static int next_element_from_composition P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
779 780
static int next_element_from_image P_ ((struct it *));
static int next_element_from_stretch P_ ((struct it *));
781
static void load_overlay_strings P_ ((struct it *, int));
782 783
static int init_from_display_pos P_ ((struct it *, struct window *,
				      struct display_pos *));
Gerd Moellmann's avatar
Gerd Moellmann committed
784 785 786 787 788 789 790
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 *));
791 792
static int init_to_row_end P_ ((struct it *, struct window *,
				struct glyph_row *));
Gerd Moellmann's avatar
Gerd Moellmann committed
793
static void back_to_previous_line_start P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
794
static int forward_to_next_line_start P_ ((struct it *, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
795 796 797 798 799 800 801 802 803 804 805
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,
806 807
					   Lisp_Object, struct text_pos *,
					   int));
808
static int underlying_face_id P_ ((struct it *));
809 810
static int in_ellipses_for_invisible_text_p P_ ((struct display_pos *,
						 struct window *));
Gerd Moellmann's avatar
Gerd Moellmann committed
811 812 813

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

Gerd Moellmann's avatar
Gerd Moellmann committed
815
#ifdef HAVE_WINDOW_SYSTEM
816

Gerd Moellmann's avatar
Gerd Moellmann committed
817 818 819 820
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 *));
821

Gerd Moellmann's avatar
Gerd Moellmann committed
822
#endif /* HAVE_WINDOW_SYSTEM */
823

Gerd Moellmann's avatar
Gerd Moellmann committed
824 825 826 827

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
828

Gerd Moellmann's avatar
Gerd Moellmann committed
829 830 831 832 833 834 835 836 837 838
/* 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);
839

Gerd Moellmann's avatar
Gerd Moellmann committed
840 841 842
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
843 844
}

845

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

Gerd Moellmann's avatar
Gerd Moellmann committed
850 851 852 853 854 855 856 857 858
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)
859
    {
Kim F. Storm's avatar
Kim F. Storm committed
860
      width -= FRAME_SCROLL_BAR_WIDTH (f) + FRAME_FRINGE_COLS (f);
Gerd Moellmann's avatar
Gerd Moellmann committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874
      
      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);
875
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
876 877

  return width * CANON_X_UNIT (f);
878
}
879 880


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

Gerd Moellmann's avatar
Gerd Moellmann committed
884 885 886
INLINE int
window_box_height (w)
     struct window *w;
887
{
Gerd Moellmann's avatar
Gerd Moellmann committed
888 889
  struct frame *f = XFRAME (w->frame);
  int height = XFASTINT (w->height) * CANON_Y_UNIT (f);
890 891

  xassert (height >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
892
  
893 894 895 896 897 898
  /* 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
899
  if (WINDOW_WANTS_MODELINE_P (w))
900 901 902 903 904 905 906 907
    {
      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
908
	height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
909
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
910

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
911
  if (WINDOW_WANTS_HEADER_LINE_P (w))
912 913 914 915 916 917 918 919 920 921
    {
      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
922

923 924 925
  /* With a very small font and a mode-line that's taller than
     default, we might end up with a negative height.  */
  return max (0, height);
Karl Heuer's avatar
Karl Heuer committed
926 927 928
}


Gerd Moellmann's avatar
Gerd Moellmann committed
929 930
/* 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
Kim F. Storm's avatar
Kim F. Storm committed
931
   whole window, to the right of the left fringe of W.  */
Karl Heuer's avatar
Karl Heuer committed
932

Gerd Moellmann's avatar
Gerd Moellmann committed
933 934 935 936
INLINE int
window_box_left (w, area)
     struct window *w;
     int area;
937
{
Gerd Moellmann's avatar
Gerd Moellmann committed
938 939
  struct frame *f = XFRAME (w->frame);
  int x = FRAME_INTERNAL_BORDER_WIDTH_SAFE (f);
940

Gerd Moellmann's avatar
Gerd Moellmann committed
941
  if (!w->pseudo_window_p)
942
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
943
      x += (WINDOW_LEFT_MARGIN (w) * CANON_X_UNIT (f)
Kim F. Storm's avatar
Kim F. Storm committed
944
	    + FRAME_LEFT_FRINGE_WIDTH (f));
Gerd Moellmann's avatar
Gerd Moellmann committed
945 946 947 948 949 950
      
      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));
951
    }
952

Gerd Moellmann's avatar
Gerd Moellmann committed
953 954
  return x;
}     
955

956

Gerd Moellmann's avatar
Gerd Moellmann committed
957 958
/* 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
Kim F. Storm's avatar
Kim F. Storm committed
959
   whole window, to the left of the right fringe of W.  */
960

Gerd Moellmann's avatar
Gerd Moellmann committed
961 962 963 964 965 966 967 968 969 970 971
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
Kim F. Storm's avatar
Kim F. Storm committed
972
   whole window, not including the left and right fringes of
Gerd Moellmann's avatar
Gerd Moellmann committed
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
   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
990 991
  if (WINDOW_WANTS_HEADER_LINE_P (w))
    *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
992
}
993 994


Gerd Moellmann's avatar
Gerd Moellmann committed
995
/* Get the bounding box of the display area AREA of window W, without
Kim F. Storm's avatar
Kim F. Storm committed
996 997
   mode lines.  AREA < 0 means the whole window, not including the
   left and right fringe of the window.  Return in *TOP_LEFT_X
Gerd Moellmann's avatar
Gerd Moellmann committed
998 999 1000 1001
   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.  */
1002

Gerd Moellmann's avatar
Gerd Moellmann committed
1003 1004 1005 1006 1007 1008
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;
1009
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1010 1011 1012 1013
  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;
1014 1015
}

Gerd Moellmann's avatar
Gerd Moellmann committed
1016 1017 1018 1019 1020 1021

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

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
/* 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;
}


1062 1063 1064 1065
/* 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.  */
1066 1067

int
1068
pos_visible_p (w, charpos, fully, exact_mode_line_heights_p)
1069
     struct window *w;
1070
     int charpos, *fully, exact_mode_line_heights_p;
1071 1072 1073
{
  struct it it;
  struct text_pos top;
1074 1075 1076 1077 1078 1079 1080 1081
  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));
    }