xdisp.c 678 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Display generation from window structure and buffer text.
Stefan Monnier's avatar
Stefan Monnier committed
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1997, 1998, 1999,
     2000, 2001, 2002, 2003, 2004, 2005  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
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, 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
   | Lisp machine |---------------->| Redisplay code |<--+
   +--------------+   (xdisp.c)     +----------------+   |
	  ^				     |		 |
	  +----------------------------------+           |
	    Don't use this path when called		 |
	    asynchronously!				 |
                                                         |
                           expose_window (asynchronous)  |
                                                         |
			           X expose events  -----+

67
   What does redisplay do?  Obviously, it has to figure out somehow what
Gerd Moellmann's avatar
Gerd Moellmann committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
   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
   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
123
   interface functions taking an iterator structure (struct it)
Gerd Moellmann's avatar
Gerd Moellmann committed
124 125
   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
#include "indent.h"
#include "commands.h"
182
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
183 184
#include "macros.h"
#include "disptab.h"
185
#include "termhooks.h"
186
#include "intervals.h"
187 188
#include "coding.h"
#include "process.h"
Andreas Schwab's avatar
Andreas Schwab committed
189
#include "region-cache.h"
Dave Love's avatar
Dave Love committed
190
#include "fontset.h"
191
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
192

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

203 204 205 206
#ifndef FRAME_X_OUTPUT
#define FRAME_X_OUTPUT(f) ((f)->output_data.x)
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
207 208
#define INFINITY 10000000

Jan Djärv's avatar
Jan Djärv committed
209 210
#if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) || defined (MAC_OS) \
    || defined (USE_GTK)
211
extern void set_frame_menubar P_ ((struct frame *f, int, int));
212
extern int pending_menu_activation;
213 214
#endif

Jim Blandy's avatar
Jim Blandy committed
215 216 217
extern int interrupt_input;
extern int command_loop_level;

218 219
extern Lisp_Object do_mouse_tracking;

220
extern int minibuffer_auto_raise;
221
extern Lisp_Object Vminibuffer_list;
222

223
extern Lisp_Object Qface;
224
extern Lisp_Object Qmode_line, Qmode_line_inactive, Qheader_line;
225

226 227
extern Lisp_Object Voverriding_local_map;
extern Lisp_Object Voverriding_local_map_menu_flag;
Gerd Moellmann's avatar
Gerd Moellmann committed
228
extern Lisp_Object Qmenu_item;
229
extern Lisp_Object Qwhen;
230
extern Lisp_Object Qhelp_echo;
231

232
Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
233
Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
234
Lisp_Object Qredisplay_end_trigger_functions, Vredisplay_end_trigger_functions;
235
Lisp_Object Qinhibit_point_motion_hooks;
236
Lisp_Object QCeval, QCfile, QCdata, QCpropertize;
Gerd Moellmann's avatar
Gerd Moellmann committed
237
Lisp_Object Qfontified;
238
Lisp_Object Qgrow_only;
239
Lisp_Object Qinhibit_eval_during_redisplay;
240
Lisp_Object Qbuffer_position, Qposition, Qobject;
Gerd Moellmann's avatar
Gerd Moellmann committed
241

242 243 244
/* Cursor shapes */
Lisp_Object Qbar, Qhbar, Qbox, Qhollow;

245 246 247
/* Pointer shapes */
Lisp_Object Qarrow, Qhand, Qtext;

248 249
Lisp_Object Qrisky_local_variable;

250 251 252
/* Holds the list (error).  */
Lisp_Object list_of_error;

Gerd Moellmann's avatar
Gerd Moellmann committed
253 254 255 256 257
/* Functions called to fontify regions of text.  */

Lisp_Object Vfontification_functions;
Lisp_Object Qfontification_functions;

258 259 260 261
/* Non-zero means automatically select any window when the mouse
   cursor moves into it.  */
int mouse_autoselect_window;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
265
int auto_raise_tool_bar_buttons_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
266

267 268 269 270
/* Non-zero means to reposition window if cursor line is only partially visible.  */

int make_cursor_line_fully_visible_p;

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

273
Lisp_Object Vtool_bar_button_margin;
Gerd Moellmann's avatar
Gerd Moellmann committed
274

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

277
EMACS_INT tool_bar_button_relief;
Gerd Moellmann's avatar
Gerd Moellmann committed
278

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

Gerd Moellmann's avatar
Gerd Moellmann committed
282
int auto_resize_tool_bars_p;
283

284 285 286 287 288 289
/* Non-zero means draw block and hollow cursor as wide as the glyph
   under it.  For example, if a block cursor is over a tab, it will be
   drawn as wide as that tab on the display.  */

int x_stretch_cursor_p;

290 291 292 293
/* Non-nil means don't actually do any redisplay.  */

Lisp_Object Vinhibit_redisplay, Qinhibit_redisplay;

294 295
/* Non-zero means Lisp evaluation during redisplay is inhibited.  */

296
int inhibit_eval_during_redisplay;
297

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

300
Lisp_Object Qdisplay;
301
extern Lisp_Object Qface, Qinvisible, Qwidth;
Gerd Moellmann's avatar
Gerd Moellmann committed
302 303 304

/* Symbols used in text property values.  */

305
Lisp_Object Vdisplay_pixels_per_inch;
Gerd Moellmann's avatar
Gerd Moellmann committed
306
Lisp_Object Qspace, QCalign_to, QCrelative_width, QCrelative_height;
307
Lisp_Object Qleft_margin, Qright_margin, Qspace_width, Qraise;
Kim F. Storm's avatar
Kim F. Storm committed
308
Lisp_Object Qslice;
Kim F. Storm's avatar
Kim F. Storm committed
309
Lisp_Object Qcenter;
310
Lisp_Object Qmargin, Qpointer;
311
Lisp_Object Qline_height;
312
extern Lisp_Object Qheight;
313
extern Lisp_Object QCwidth, QCheight, QCascent;
314
extern Lisp_Object Qscroll_bar;
315
extern Lisp_Object Qcursor;
Gerd Moellmann's avatar
Gerd Moellmann committed
316

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

319
Lisp_Object Vshow_trailing_whitespace;
Gerd Moellmann's avatar
Gerd Moellmann committed
320

321 322
/* Non-nil means escape non-break space and hyphens.  */

323
Lisp_Object Vnobreak_char_display;
324

325
#ifdef HAVE_WINDOW_SYSTEM
326
extern Lisp_Object Voverflow_newline_into_fringe;
327 328

/* Test if overflow newline into fringe.  Called with iterator IT
329
   at or past right window margin, and with IT->current_x set.  */
330 331 332 333 334 335 336

#define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it)	\
  (!NILP (Voverflow_newline_into_fringe)	\
   && FRAME_WINDOW_P (it->f)			\
   && WINDOW_RIGHT_FRINGE_WIDTH (it->w) > 0	\
   && it->current_x == it->last_visible_x)

337 338
#endif /* HAVE_WINDOW_SYSTEM */

339 340 341 342
/* Non-nil means show the text cursor in void text areas
   i.e. in blank areas after eol and eob.  This used to be
   the default in 21.3.  */

343
Lisp_Object Vvoid_text_area_pointer;
344

Gerd Moellmann's avatar
Gerd Moellmann committed
345 346 347 348
/* Name of the face used to highlight trailing whitespace.  */

Lisp_Object Qtrailing_whitespace;

349 350 351 352
/* Name and number of the face used to highlight escape glyphs.  */

Lisp_Object Qescape_glyph;

Juri Linkov's avatar
Juri Linkov committed
353 354
/* Name and number of the face used to highlight non-breaking spaces.  */

355
Lisp_Object Qnobreak_space;
Juri Linkov's avatar
Juri Linkov committed
356

Gerd Moellmann's avatar
Gerd Moellmann committed
357 358 359 360 361
/* The symbol `image' which is the car of the lists used to represent
   images in Lisp.  */

Lisp_Object Qimage;

362 363 364 365
/* The image map types.  */
Lisp_Object QCmap, QCpointer;
Lisp_Object Qrect, Qcircle, Qpoly;

Gerd Moellmann's avatar
Gerd Moellmann committed
366 367
/* Non-zero means print newline to stdout before next mini-buffer
   message.  */
Jim Blandy's avatar
Jim Blandy committed
368 369 370

int noninteractive_need_newline;

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

373
static int message_log_need_newline;
374

375 376 377 378 379 380
/* 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
381 382 383 384 385

/* 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
386

Gerd Moellmann's avatar
Gerd Moellmann committed
387
static struct text_pos this_line_start_pos;
Jim Blandy's avatar
Jim Blandy committed
388

Gerd Moellmann's avatar
Gerd Moellmann committed
389 390 391 392 393 394
/* 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
395 396

static int this_line_vpos;
Gerd Moellmann's avatar
Gerd Moellmann committed
397 398 399 400 401 402 403
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
404

Gerd Moellmann's avatar
Gerd Moellmann committed
405
/* Buffer that this_line_.* variables are referring to.  */
Jim Blandy's avatar
Jim Blandy committed
406 407 408

static struct buffer *this_line_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
409 410
/* Nonzero means truncate lines in all windows less wide than the
   frame.  */
Jim Blandy's avatar
Jim Blandy committed
411 412 413

int truncate_partial_width_windows;

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

416
int unibyte_display_via_language_environment;
417

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

422 423
int multiple_frames;

Jim Blandy's avatar
Jim Blandy committed
424 425
Lisp_Object Vglobal_mode_string;

426 427 428

/* List of variables (symbols) which hold markers for overlay arrows.
   The symbols on this list are examined during redisplay to determine
429
   where to display overlay arrows.  */
430 431 432

Lisp_Object Voverlay_arrow_variable_list;

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

Jim Blandy's avatar
Jim Blandy committed
435 436
Lisp_Object Voverlay_arrow_position;

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

Jim Blandy's avatar
Jim Blandy committed
439 440
Lisp_Object Voverlay_arrow_string;

441 442 443
/* Values of those variables at last redisplay are stored as
   properties on `overlay-arrow-position' symbol.  However, if
   Voverlay_arrow_position is a marker, last-arrow-position is its
Gerd Moellmann's avatar
Gerd Moellmann committed
444 445
   numerical position.  */

446 447 448 449 450 451
Lisp_Object Qlast_arrow_position, Qlast_arrow_string;

/* Alternative overlay-arrow-string and overlay-arrow-bitmap
   properties on a symbol in overlay-arrow-variable-list.  */

Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
452

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

455 456
Lisp_Object Vframe_title_format;

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

459 460
Lisp_Object Vicon_title_format;

461 462 463
/* 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
464

465 466
static Lisp_Object Vwindow_size_change_functions;

467
Lisp_Object Qmenu_bar_update_hook, Vmenu_bar_update_hook;
468

469
/* Nonzero if an overlay arrow has been displayed in this window.  */
Jim Blandy's avatar
Jim Blandy committed
470

Gerd Moellmann's avatar
Gerd Moellmann committed
471
static int overlay_arrow_seen;
Karl Heuer's avatar
Karl Heuer committed
472

473 474
/* Nonzero means highlight the region even in nonselected windows.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
475 476 477 478 479
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.  */

480
static EMACS_INT scroll_step;
Jim Blandy's avatar
Jim Blandy committed
481

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

485
static EMACS_INT scroll_conservatively;
486

Gerd Moellmann's avatar
Gerd Moellmann committed
487 488
/* Recenter the window whenever point gets within this many lines of
   the top or bottom of the window.  This value is translated into a
489 490
   pixel value by multiplying it with FRAME_LINE_HEIGHT, which means
   that there is really a fixed pixel height scroll margin.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
491

492
EMACS_INT scroll_margin;
493

Gerd Moellmann's avatar
Gerd Moellmann committed
494 495 496
/* 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
497 498 499

int buffer_shared;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
502
static Lisp_Object default_invis_vector[3];
Jim Blandy's avatar
Jim Blandy committed
503

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

int mode_line_inverse_video;

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

514
Lisp_Object minibuf_prompt;
Jim Blandy's avatar
Jim Blandy committed
515

Gerd Moellmann's avatar
Gerd Moellmann committed
516 517 518
/* 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
519
int minibuf_prompt_width;
Gerd Moellmann's avatar
Gerd Moellmann committed
520 521 522 523 524

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

525 526
Lisp_Object echo_area_window;

527 528 529 530 531 532 533
/* 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;

534 535
/* Nonzero means multibyte characters were enabled when the echo area
   message was specified.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
536

537 538
int message_enable_multibyte;

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

Jim Blandy's avatar
Jim Blandy committed
541 542
int update_mode_lines;

Gerd Moellmann's avatar
Gerd Moellmann committed
543
/* Nonzero if window sizes or contents have changed since last
544
   redisplay that finished.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
545

Jim Blandy's avatar
Jim Blandy committed
546 547
int windows_or_buffers_changed;

548 549 550 551
/* Nonzero means a frame's cursor type has been changed.  */

int cursor_type_changed;

Gerd Moellmann's avatar
Gerd Moellmann committed
552 553 554
/* Nonzero after display_mode_line if %l was used and it displayed a
   line number.  */

555 556 557
int line_number_displayed;

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

559
Lisp_Object Vline_number_display_limit;
Karl Heuer's avatar
Karl Heuer committed
560

561
/* Line width to consider when repositioning for line number display.  */
562

563
static EMACS_INT line_number_display_limit_width;
564

Gerd Moellmann's avatar
Gerd Moellmann committed
565 566 567
/* 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
568
Lisp_Object Vmessage_log_max;
569

570 571 572 573
/* The name of the *Messages* buffer, a string.  */

static Lisp_Object Vmessages_buffer_name;

574 575 576 577 578 579 580 581
/* Index 0 is the buffer that holds the current (desired) echo area message,
   or nil if none is desired right now.

   Index 1 is the buffer that holds the previously displayed echo area message,
   or nil to indicate no message.  This is normally what's on the screen now.

   These two can point to the same buffer.  That happens when the last
   message output by the user (or made by echoing) has been displayed.  */
582 583 584

Lisp_Object echo_area_buffer[2];

585 586 587 588
/* Permanent pointers to the two buffers that are used for echo area
   purposes.  Once the two buffers are made, and their pointers are
   placed here, these two slots remain unchanged unless those buffers
   need to be created afresh.  */
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

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;

606 607 608 609 610
/* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable.  */

Lisp_Object Qinhibit_menubar_update;
int inhibit_menubar_update;

611 612 613
/* Maximum height for resizing mini-windows.  Either a float
   specifying a fraction of the available height, or an integer
   specifying a number of lines.  */
614

615 616 617 618 619 620 621
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;
622

623 624 625 626 627
/* Set to 1 in clear_message to make redisplay_internal aware
   of an emptied echo area.   */

static int message_cleared_p;

628 629 630
/* How to blink the default frame cursor off.  */
Lisp_Object Vblink_cursor_alist;

Gerd Moellmann's avatar
Gerd Moellmann committed
631 632
/* A scratch glyph row with contents used for generating truncation
   glyphs.  Also used in direct_output_for_insert.  */
633

Gerd Moellmann's avatar
Gerd Moellmann committed
634 635 636
#define MAX_SCRATCH_GLYPHS 100
struct glyph_row scratch_glyph_row;
static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
637

Gerd Moellmann's avatar
Gerd Moellmann committed
638 639 640 641
/* Ascent and height of the last line processed by move_it_to.  */

static int last_max_ascent, last_height;

642 643 644 645
/* Non-zero if there's a help-echo in the echo area.  */

int help_echo_showing_p;

646 647 648 649 650 651
/* 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
652
/* The maximum distance to look ahead for text properties.  Values
653
   that are too small let us call compute_char_face and similar
Gerd Moellmann's avatar
Gerd Moellmann committed
654 655 656 657 658 659
   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

660 661
#if GLYPH_DEBUG

662 663 664 665 666
/* 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
667 668 669 670
/* Non-zero means print traces of redisplay if compiled with
   GLYPH_DEBUG != 0.  */

int trace_redisplay_p;
671

672
#endif /* GLYPH_DEBUG */
673

674 675
#ifdef DEBUG_TRACE_MOVE
/* Non-zero means trace with TRACE_MOVE to stderr.  */
676 677 678 679
int trace_move;

#define TRACE_MOVE(x)	if (trace_move) fprintf x; else (void) 0
#else
680
#define TRACE_MOVE(x)	(void) 0
Gerd Moellmann's avatar
Gerd Moellmann committed
681
#endif
682

683 684 685 686 687
/* Non-zero means automatically scroll windows horizontally to make
   point visible.  */

int automatic_hscrolling_p;

688 689
/* How close to the margin can point get before the window is scrolled
   horizontally.  */
690
EMACS_INT hscroll_margin;
691 692

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

695
/* The variable `resize-mini-windows'.  If nil, don't resize
Eli Zaretskii's avatar
Eli Zaretskii committed
696
   mini-windows.  If t, always resize them to fit the text they
697 698 699 700 701
   display.  If `grow-only', let mini-windows grow only until they
   become empty.  */

Lisp_Object Vresize_mini_windows;

702 703 704 705
/* Buffer being redisplayed -- for redisplay_window_error.  */

struct buffer *displayed_buffer;

Gerd Moellmann's avatar
Gerd Moellmann committed
706 707 708
/* Value returned from text property handlers (see below).  */

enum prop_handled
709
{
Gerd Moellmann's avatar
Gerd Moellmann committed
710 711 712 713 714
  HANDLED_NORMALLY,
  HANDLED_RECOMPUTE_PROPS,
  HANDLED_OVERLAY_STRING_CONSUMED,
  HANDLED_RETURN
};
715

Gerd Moellmann's avatar
Gerd Moellmann committed
716 717
/* A description of text properties that redisplay is interested
   in.  */
718

Gerd Moellmann's avatar
Gerd Moellmann committed
719 720 721 722
struct props
{
  /* The name of the property.  */
  Lisp_Object *name;
723

Gerd Moellmann's avatar
Gerd Moellmann committed
724 725 726 727 728 729 730 731 732 733 734
  /* 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 *));
735
static enum prop_handled handle_composition_prop P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
736 737 738 739 740 741
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
742
{
Gerd Moellmann's avatar
Gerd Moellmann committed
743 744 745 746 747 748
  {&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},
749
  {&Qcomposition,	COMPOSITION_PROP_IDX,	handle_composition_prop},
Gerd Moellmann's avatar
Gerd Moellmann committed
750 751
  {NULL,		0,			NULL}
};
Karl Heuer's avatar
Karl Heuer committed
752

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
760 761 762 763
enum move_it_result
{
  /* Not used.  Undefined value.  */
  MOVE_UNDEFINED,
764

Gerd Moellmann's avatar
Gerd Moellmann committed
765 766
  /* Move ended at the requested buffer position or ZV.  */
  MOVE_POS_MATCH_OR_ZV,
767

Gerd Moellmann's avatar
Gerd Moellmann committed
768 769
  /* Move ended at the requested X pixel position.  */
  MOVE_X_REACHED,
770

Gerd Moellmann's avatar
Gerd Moellmann committed
771 772 773
  /* Move within a line ended at the end of a line that must be
     continued.  */
  MOVE_LINE_CONTINUED,
774

Gerd Moellmann's avatar
Gerd Moellmann committed
775 776 777
  /* Move within a line ended at the end of a line that would
     be displayed truncated.  */
  MOVE_LINE_TRUNCATED,
778

Gerd Moellmann's avatar
Gerd Moellmann committed
779 780 781
  /* Move within a line ended at a line end.  */
  MOVE_NEWLINE_OR_CR
};
782

783 784 785 786 787 788 789 790
/* This counter is used to clear the face cache every once in a while
   in redisplay_internal.  It is incremented for each redisplay.
   Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
   cleared.  */

#define CLEAR_FACE_CACHE_COUNT	500
static int clear_face_cache_count;

791 792 793 794 795 796 797
/* Similarly for the image cache.  */

#ifdef HAVE_WINDOW_SYSTEM
#define CLEAR_IMAGE_CACHE_COUNT	101
static int clear_image_cache_count;
#endif

798 799 800 801 802 803 804 805
/* Record the previous terminal frame we displayed.  */

static struct frame *previous_terminal_frame;

/* Non-zero while redisplay_internal is in progress.  */

int redisplaying_p;

806 807 808
/* Non-zero means don't free realized faces.  Bound while freeing
   realized faces is dangerous because glyph matrices might still
   reference them.  */
809

810 811
int inhibit_free_realized_faces;
Lisp_Object Qinhibit_free_realized_faces;
812

813 814 815 816 817 818 819 820 821 822 823 824
/* If a string, XTread_socket generates an event to display that string.
   (The display is done in read_char.)  */

Lisp_Object help_echo_string;
Lisp_Object help_echo_window;
Lisp_Object help_echo_object;
int help_echo_pos;

/* Temporary variable for XTread_socket.  */

Lisp_Object previous_help_echo_string;

Kim F. Storm's avatar
Kim F. Storm committed
825 826 827
/* Null glyph slice */

static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
828

Gerd Moellmann's avatar
Gerd Moellmann committed
829 830 831

/* Function prototypes.  */

832
static void setup_for_ellipsis P_ ((struct it *, int));
833
static void mark_window_display_accurate_1 P_ ((struct window *, int));
834
static int single_display_spec_string_p P_ ((Lisp_Object, Lisp_Object));
835
static int display_prop_string_p P_ ((Lisp_Object, Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
836
static int cursor_row_p P_ ((struct window *, struct glyph_row *));
837
static int redisplay_mode_lines P_ ((Lisp_Object, int));
838
static char *decode_mode_spec_coding P_ ((Lisp_Object, char *, int));
839 840

#if 0
841
static int invisible_text_between_p P_ ((struct it *, int, int));
842 843
#endif

844
static void pint2str P_ ((char *, int, int));
Lute Kamstra's avatar
Lute Kamstra committed
845
static void pint2hrstr P_ ((char *, int, int));
846 847 848 849
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));
850 851
static void store_mode_line_noprop_char P_ ((char));
static int store_mode_line_noprop P_ ((const unsigned char *, int, int));
852 853 854
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 *));
855
static int single_display_spec_intangible_p P_ ((Lisp_Object));
856
static void ensure_echo_area_buffers P_ ((void));
857 858
static Lisp_Object unwind_with_echo_area_buffer P_ ((Lisp_Object));
static Lisp_Object with_echo_area_buffer_unwind_data P_ ((struct window *));
859
static int with_echo_area_buffer P_ ((struct window *, int,
860 861
				      int (*) (EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT),
				      EMACS_INT, Lisp_Object, EMACS_INT, EMACS_INT));
862
static void clear_garbaged_frames P_ ((void));
863 864 865
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));
866
static int display_echo_area P_ ((struct window *));
867 868
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));
869
static Lisp_Object unwind_redisplay P_ ((Lisp_Object));
870
static int string_char_and_length P_ ((const unsigned char *, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
871 872 873
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 *));
874
static Lisp_Object safe_eval_handler P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
875
static void insert_left_trunc_glyphs P_ ((struct it *));
876 877
static struct glyph_row *get_overlay_arrow_glyph_row P_ ((struct window *,
							  Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
878
static void extend_face_to_end_of_line P_ ((struct it *));
Kim F. Storm's avatar
Kim F. Storm committed
879
static int append_space_for_newline P_ ((struct it *, int));
880
static int cursor_row_fully_visible_p P_ ((struct window *, int, int));
881
static int try_scrolling P_ ((Lisp_Object, int, EMACS_INT, EMACS_INT, int, int));
882
static int try_cursor_movement P_ ((Lisp_Object, struct text_pos, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
883 884 885 886 887
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 *));
888
static void select_frame_for_redisplay P_ ((Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
889
static void redisplay_internal P_ ((int));
890
static int echo_area_display P_ ((int));
Gerd Moellmann's avatar
Gerd Moellmann committed
891 892
static void redisplay_windows P_ ((Lisp_Object));
static void redisplay_window P_ ((Lisp_Object, int));
893 894 895
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
896 897 898 899
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 *));
900
static int display_mode_lines P_ ((struct window *));
901
static int display_mode_line P_ ((struct window *, enum face_id, Lisp_Object));
902
static int display_mode_element P_ ((struct it *, int, int, int, Lisp_Object, Lisp_Object, int));
903
static int store_mode_line_string P_ ((char *, Lisp_Object, int, int, int, Lisp_Object));
904
static char *decode_mode_spec P_ ((struct window *, int, int, int, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
905 906 907 908 909 910
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 *));
911
static int get_overlay_strings P_ ((struct it *, int));
Gerd Moellmann's avatar
Gerd Moellmann committed
912 913 914 915
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 *));
916
void reseat_at_previous_visible_line_start P_ ((struct it *));
917
static void reseat_at_next_visible_line_start P_ ((struct it *, int));
918
static int next_element_from_ellipsis P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
919 920 921 922
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 *));
923
static int next_element_from_composition P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
924 925
static int next_element_from_image P_ ((struct it *));
static int next_element_from_stretch P_ ((struct it *));
926
static void load_overlay_strings P_ ((struct it *, int));
927 928
static int init_from_display_pos P_ ((struct it *, struct window *,
				      struct display_pos *));
Gerd Moellmann's avatar
Gerd Moellmann committed
929 930 931 932 933 934 935
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 *));
936 937
static int init_to_row_end P_ ((struct it *, struct window *,
				struct glyph_row *));
Gerd Moellmann's avatar
Gerd Moellmann committed
938
static void back_to_previous_line_start P_ ((struct it *));
Gerd Moellmann's avatar
Gerd Moellmann committed
939
static int forward_to_next_line_start P_ ((struct it *, int *));
Gerd Moellmann's avatar
Gerd Moellmann committed
940 941 942 943 944 945 946 947 948 949
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));
950
static int handle_single_display_spec P_ ((struct it *, Lisp_Object,
951 952
					   Lisp_Object, struct text_pos *,
					   int));
953
static int underlying_face_id P_ ((struct it *));
954 955
static int in_ellipses_for_invisible_text_p P_ ((struct display_pos *,
						 struct window *));
Gerd Moellmann's avatar
Gerd Moellmann committed
956 957 958

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

Gerd Moellmann's avatar
Gerd Moellmann committed
960
#ifdef HAVE_WINDOW_SYSTEM
961

Gerd Moellmann's avatar
Gerd Moellmann committed
962 963 964 965
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 *));
966 967 968 969 970
static void notice_overwritten_cursor P_ ((struct window *,
					   enum glyph_row_area,
					   int, int, int, int));


971

Gerd Moellmann's avatar
Gerd Moellmann committed
972
#endif /* HAVE_WINDOW_SYSTEM */
973

Gerd Moellmann's avatar
Gerd Moellmann committed
974 975 976 977

/***********************************************************************
		      Window display dimensions
 ***********************************************************************/
978

979 980 981 982 983
/* Return the bottom boundary y-position for text lines in window W.
   This is the first y position at which a line cannot start.
   It is relative to the top of the window.

   This is the height of W minus the height of a mode line, if any.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
984 985 986 987 988

INLINE int
window_text_bottom_y (w)
     struct window *w;
{
989
  int height = WINDOW_TOTAL_HEIGHT (w);
990

Gerd Moellmann's avatar
Gerd Moellmann committed
991 992 993
  if (WINDOW_WANTS_MODELINE_P (w))
    height -= CURRENT_MODE_LINE_HEIGHT (w);
  return height;
994 995
}

Gerd Moellmann's avatar
Gerd Moellmann committed
996
/* Return the pixel width of display area AREA of window W.  AREA < 0
Kim F. Storm's avatar
Kim F. Storm committed
997
   means return the total width of W, not including fringes to