xdisp.c 461 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

   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)
50
             direct_output_for_insert,
Gerd Moellmann's avatar
Gerd Moellmann committed
51 52 53 54
             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
   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.

109

Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
   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
#ifdef MAC_OS
198 199
#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 (MAC_OS)
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
extern Lisp_Object Qface;
214
extern Lisp_Object Qmode_line, Qmode_line_inactive, Qheader_line;
215

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

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

230 231
Lisp_Object Qrisky_local_variable;

232 233 234
/* Holds the list (error).  */
Lisp_Object list_of_error;

Gerd Moellmann's avatar
Gerd Moellmann committed
235 236 237 238 239
/* Functions called to fontify regions of text.  */

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
243
int auto_raise_tool_bar_buttons_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
244

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

247
Lisp_Object Vtool_bar_button_margin;
Gerd Moellmann's avatar
Gerd Moellmann committed
248

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

251
EMACS_INT tool_bar_button_relief;
Gerd Moellmann's avatar
Gerd Moellmann committed
252

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

Gerd Moellmann's avatar
Gerd Moellmann committed
256
int auto_resize_tool_bars_p;
257

258 259 260 261
/* Non-nil means don't actually do any redisplay.  */

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

262 263
/* Non-zero means Lisp evaluation during redisplay is inhibited.  */

264
int inhibit_eval_during_redisplay;
265

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

268
Lisp_Object Qdisplay, Qrelative_width, Qalign_to;
269
extern Lisp_Object Qface, Qinvisible, Qwidth;
Gerd Moellmann's avatar
Gerd Moellmann committed
270 271 272 273

/* Symbols used in text property values.  */

Lisp_Object Qspace, QCalign_to, QCrelative_width, QCrelative_height;
274
Lisp_Object Qleft_margin, Qright_margin, Qspace_width, Qraise;
275
Lisp_Object Qmargin;
276
extern Lisp_Object Qheight;
Gerd Moellmann's avatar
Gerd Moellmann committed
277

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

280
Lisp_Object Vshow_trailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
281 282 283 284 285 286 287 288 289 290 291 292

/* 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
293 294 295

int noninteractive_need_newline;

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

298
static int message_log_need_newline;
299

300 301 302 303 304 305
/* 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
306 307 308 309 310

/* 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
311

Gerd Moellmann's avatar
Gerd Moellmann committed
312
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
313

Gerd Moellmann's avatar
Gerd Moellmann committed
314 315 316 317 318 319
/* 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
320 321

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
322 323 324 325 326 327 328
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
329

Gerd Moellmann's avatar
Gerd Moellmann committed
330
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
331 332 333

static struct buffer *this_line_buffer;

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

int truncate_partial_width_windows;

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

341
int unibyte_display_via_language_environment;
342

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

347 348
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
349 350 351
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
352

Jim Blandy's avatar
Jim Blandy committed
353 354
Lisp_Object Voverlay_arrow_position;

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

Jim Blandy's avatar
Jim Blandy committed
357 358
Lisp_Object Voverlay_arrow_string;

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

363 364
static Lisp_Object last_arrow_position, last_arrow_string;

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

367 368
Lisp_Object Vframe_title_format;

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

371 372
Lisp_Object Vicon_title_format;

373 374 375
/* 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
376

377 378
static Lisp_Object Vwindow_size_change_functions;

379
Lisp_Object Qmenu_bar_update_hook, Vmenu_bar_update_hook;
380

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

Gerd Moellmann's avatar
Gerd Moellmann committed
383
static int overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
384

385 386
/* Nonzero means highlight the region even in nonselected windows.  */

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

392
static EMACS_INT scroll_step;
Jim Blandy's avatar
Jim Blandy committed
393

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

397
static EMACS_INT scroll_conservatively;
398

Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401 402 403
/* 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.  */

404
EMACS_INT scroll_margin;
405

Gerd Moellmann's avatar
Gerd Moellmann committed
406 407 408
/* 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
409 410 411

int buffer_shared;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
414
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
415

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

int mode_line_inverse_video;

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

426
Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
427

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

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

437 438
Lisp_Object echo_area_window;

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

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

449 450
int message_enable_multibyte;

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

Jim Blandy's avatar
Jim Blandy committed
453 454
int update_mode_lines;

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

Jim Blandy's avatar
Jim Blandy committed
458 459
int windows_or_buffers_changed;

460 461 462 463
/* Nonzero means a frame's cursor type has been changed.  */

int cursor_type_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
464 465 466
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

467 468 469
int line_number_displayed;

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

471
Lisp_Object Vline_number_display_limit;
Karl Heuer's avatar
Karl Heuer committed
472

473
/* Line width to consider when repositioning for line number display.  */
474

475
static EMACS_INT line_number_display_limit_width;
476

Gerd Moellmann's avatar
Gerd Moellmann committed
477 478 479
/* 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
480
Lisp_Object Vmessage_log_max;
481

482 483 484 485
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
/* 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;

509 510 511 512 513
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

Lisp_Object Qinhibit_menubar_update;
int inhibit_menubar_update;

514 515 516
/* Maximum height for resizing mini-windows.  Either a float
   specifying a fraction of the available height, or an integer
   specifying a number of lines.  */
517

518 519 520 521 522 523 524
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;
525

526 527 528 529 530
/* Set to 1 in clear_message to make redisplay_internal aware
   of an emptied echo area.   */

static int message_cleared_p;

531 532 533 534
/* 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;
535
Lisp_Object Qcursor_in_non_selected_windows;
536

Gerd Moellmann's avatar
Gerd Moellmann committed
537 538
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
539

Gerd Moellmann's avatar
Gerd Moellmann committed
540 541 542
#define MAX_SCRATCH_GLYPHS 100
struct glyph_row scratch_glyph_row;
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
543

Gerd Moellmann's avatar
Gerd Moellmann committed
544 545 546 547
/* Ascent and height of the last line processed by move_it_to.  */

static int last_max_ascent, last_height;

548 549 550 551
/* Non-zero if there's a help-echo in the echo area.  */

int help_echo_showing_p;

552 553 554 555 556 557
/* 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
558
/* The maximum distance to look ahead for text properties.  Values
559
   that are too small let us call compute_char_face and similar
Gerd Moellmann's avatar
Gerd Moellmann committed
560 561 562 563 564 565
   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

566 567
#if GLYPH_DEBUG

568 569 570 571 572
/* 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
573 574 575 576
/* Non-zero means print traces of redisplay if compiled with
   GLYPH_DEBUG != 0.  */

int trace_redisplay_p;
577

578
#endif /* GLYPH_DEBUG */
579

580 581
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
582 583 584 585
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
586
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
587
#endif
588

589 590 591 592 593
/* Non-zero means automatically scroll windows horizontally to make
   point visible.  */

int automatic_hscrolling_p;

594 595
/* How close to the margin can point get before the window is scrolled
   horizontally.  */
596
EMACS_INT hscroll_margin;
597 598

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

601 602 603 604
/* A list of symbols, one for each supported image type.  */

Lisp_Object Vimage_types;

605
/* The variable `resize-mini-windows'.  If nil, don't resize
Eli Zaretskii's avatar
Eli Zaretskii committed
606
   mini-windows.  If t, always resize them to fit the text they
607 608 609 610 611
   display.  If `grow-only', let mini-windows grow only until they
   become empty.  */

Lisp_Object Vresize_mini_windows;

612 613 614 615
/* Buffer being redisplayed -- for redisplay_window_error.  */

struct buffer *displayed_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
616 617 618
/* Value returned from text property handlers (see below).  */

enum prop_handled
619
{
Gerd Moellmann's avatar
Gerd Moellmann committed
620 621 622 623 624
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
625

Gerd Moellmann's avatar
Gerd Moellmann committed
626 627
/* A description of text properties that redisplay is interested
   in.  */
628

Gerd Moellmann's avatar
Gerd Moellmann committed
629 630 631 632
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
633

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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
670 671 672 673
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
674

Gerd Moellmann's avatar
Gerd Moellmann committed
675 676
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
677

Gerd Moellmann's avatar
Gerd Moellmann committed
678 679
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
680

Gerd Moellmann's avatar
Gerd Moellmann committed
681 682 683
  /* Move within a line ended at the end of a line that must be
     continued.  */
  MOVE_LINE_CONTINUED,
684

Gerd Moellmann's avatar
Gerd Moellmann committed
685 686 687
  /* Move within a line ended at the end of a line that would
     be displayed truncated.  */
  MOVE_LINE_TRUNCATED,
688

Gerd Moellmann's avatar
Gerd Moellmann committed
689 690 691
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
692

693

Gerd Moellmann's avatar
Gerd Moellmann committed
694 695 696

/* Function prototypes.  */

697
static void setup_for_ellipsis P_ ((struct it *));
698
static void mark_window_display_accurate_1 P_ ((struct window *, int));
699 700
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
701
static int cursor_row_p P_ ((struct window *, struct glyph_row *));
702
static int redisplay_mode_lines P_ ((Lisp_Object, int));
703
static char *decode_mode_spec_coding P_ ((Lisp_Object, char *, int));
704 705

#if 0
706
static int invisible_text_between_p P_ ((struct it *, int, int));
707 708
#endif

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
822
#ifdef HAVE_WINDOW_SYSTEM
823

Gerd Moellmann's avatar
Gerd Moellmann committed
824 825 826 827
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 *));
828

Gerd Moellmann's avatar
Gerd Moellmann committed
829
#endif /* HAVE_WINDOW_SYSTEM */
830

Gerd Moellmann's avatar
Gerd Moellmann committed
831 832 833 834

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
835

Gerd Moellmann's avatar
Gerd Moellmann committed
836 837 838 839 840 841 842 843 844 845
/* 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);
846

Gerd Moellmann's avatar
Gerd Moellmann committed
847 848 849
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
850 851
}

852

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

Gerd Moellmann's avatar
Gerd Moellmann committed
857 858 859 860 861 862 863
INLINE int
window_box_width (w, area)
     struct window *w;
     int area;
{
  struct frame *f = XFRAME (w->frame);
  int width = XFASTINT (w->width);
864

Gerd Moellmann's avatar
Gerd Moellmann committed
865
  if (!w->pseudo_window_p)
866
    {
Kim F. Storm's avatar
Kim F. Storm committed
867
      width -= FRAME_SCROLL_BAR_WIDTH (f) + FRAME_FRINGE_COLS (f);
868

Gerd Moellmann's avatar
Gerd Moellmann committed
869 870 871 872 873 874 875 876 877 878 879 880 881
      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);
882
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
883 884

  return width * CANON_X_UNIT (f);
885
}
886 887


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

Gerd Moellmann's avatar
Gerd Moellmann committed
891 892 893
INLINE int
window_box_height (w)
     struct window *w;
894
{
Gerd Moellmann's avatar
Gerd Moellmann committed
895 896
  struct frame *f = XFRAME (w->frame);
  int height = XFASTINT (w->height) * CANON_Y_UNIT (f);
897 898

  xassert (height >= 0);
899

900 901 902 903 904 905
  /* 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
906
  if (WINDOW_WANTS_MODELINE_P (w))
907 908 909 910 911 912 913 914
    {
      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
915
	height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
916
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
917

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
918
  if (WINDOW_WANTS_HEADER_LINE_P (w))
919 920 921 922 923 924 925 926 927 928
    {
      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
929

930 931 932
  /* 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
933 934 935
}


Gerd Moellmann's avatar
Gerd Moellmann committed
936 937
/* 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
938
   whole window, to the right of the left fringe of W.  */
Karl Heuer's avatar
Karl Heuer committed
939

Gerd Moellmann's avatar
Gerd Moellmann committed
940 941 942 943
INLINE int
window_box_left (w, area)
     struct window *w;
     int area;
944
{
Gerd Moellmann's avatar
Gerd Moellmann committed
945 946
  struct frame *f = XFRAME (w->frame);
  int x = FRAME_INTERNAL_BORDER_WIDTH_SAFE (f);
947

Gerd Moellmann's avatar
Gerd Moellmann committed
948
  if (!w->pseudo_window_p)
949
    {
Gerd Moellmann's avatar
Gerd Moellmann committed
950
      x += (WINDOW_LEFT_MARGIN (w) * CANON_X_UNIT (f)
Kim F. Storm's avatar
Kim F. Storm committed
951
	    + FRAME_LEFT_FRINGE_WIDTH (f));
952

Gerd Moellmann's avatar
Gerd Moellmann committed
953 954 955 956 957
      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));
958
    }
959

Gerd Moellmann's avatar
Gerd Moellmann committed
960
  return x;
961
}
962

963

Gerd Moellmann's avatar
Gerd Moellmann committed
964 965
/* 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
966
   whole window, to the left of the right fringe of W.  */
967

Gerd Moellmann's avatar
Gerd Moellmann committed
968 969 970 971 972 973
INLINE int
window_box_right (w, area)
     struct window *w;
     int area;
{
  return window_box_left (w, area) + window_box_width (w, area);
974 975
}

Gerd Moellmann's avatar
Gerd Moellmann committed
976 977 978

/* 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
979
   whole window, not including the left and right fringes of
Gerd Moellmann's avatar
Gerd Moellmann committed
980 981 982 983 984 985 986 987 988 989 990
   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);
991

Gerd Moellmann's avatar
Gerd Moellmann committed
992 993 994 995 996
  *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
997 998
  if (WINDOW_WANTS_HEADER_LINE_P (w))
    *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
999
}
1000 1001


Gerd Moellmann's avatar
Gerd Moellmann committed
1002
/* Get the bounding box of the display area AREA of window W, without
Kim F. Storm's avatar
Kim F. Storm committed
1003 1004
   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
1005 1006 1007 1008
   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.  */
1009

Gerd Moellmann's avatar
Gerd Moellmann committed
1010 1011 1012 1013 1014 1015
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;
1016
{
Gerd Moellmann's avatar
Gerd Moellmann committed
1017 1018 1019 1020
  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;
1021 1022
}