dispnew.c 188 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Updating of data structures for redisplay.
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
4
Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
jave's avatar
jave committed
20

21
#include <config.h>
22

23
#include "sysstdio.h"
Andreas Schwab's avatar
Andreas Schwab committed
24 25
#include <unistd.h>

26
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "termchar.h"
28
/* cm.h must come after dispextern.h on Windows.  */
29 30
#include "dispextern.h"
#include "cm.h"
31
#include "character.h"
32
#include "buffer.h"
33
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
34
#include "frame.h"
35
#include "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
36 37 38 39
#include "window.h"
#include "commands.h"
#include "disptab.h"
#include "indent.h"
40
#include "intervals.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
41
#include "blockinput.h"
Andreas Schwab's avatar
Andreas Schwab committed
42
#include "process.h"
Jim Blandy's avatar
Jim Blandy committed
43

Richard M. Stallman's avatar
Richard M. Stallman committed
44
#include "syssignal.h"
Paul Eggert's avatar
Paul Eggert committed
45
#include "tparam.h"
Jim Blandy's avatar
Jim Blandy committed
46

47 48 49
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
50

51 52
#include <errno.h>

Paul Eggert's avatar
Paul Eggert committed
53
#include <fpending.h>
54
#include <timespec.h>
55

56 57 58
#ifdef WINDOWSNT
#include "w32.h"
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61 62 63 64 65 66 67 68 69 70 71

/* Structure to pass dimensions around.  Used for character bounding
   boxes, glyph matrix dimensions and alike.  */

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

72
static void update_frame_line (struct frame *, int);
Andreas Schwab's avatar
Andreas Schwab committed
73 74
static int required_matrix_height (struct window *);
static int required_matrix_width (struct window *);
75
static void increment_row_positions (struct glyph_row *, ptrdiff_t, ptrdiff_t);
76 77 78 79 80 81
static void build_frame_matrix_from_window_tree (struct glyph_matrix *,
                                                 struct window *);
static void build_frame_matrix_from_leaf_window (struct glyph_matrix *,
                                                 struct window *);
static void adjust_decode_mode_spec_buffer (struct frame *);
static void fill_up_glyph_row_with_spaces (struct glyph_row *);
82
static void clear_window_matrices (struct window *, bool);
83
static void fill_up_glyph_row_area_with_spaces (struct glyph_row *, int);
84 85
static int scrolling_window (struct window *, bool);
static bool update_window_line (struct window *, int, bool *);
86
static void mirror_make_current (struct window *, int);
87
#ifdef GLYPH_DEBUG
88 89
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
90
#endif
91
static void mirror_line_dance (struct window *, int, int, int *, char *);
92 93
static bool update_window_tree (struct window *, bool);
static bool update_window (struct window *, bool);
94
static bool update_frame_1 (struct frame *, bool, bool, bool);
95
static bool scrolling (struct frame *);
96 97 98
static void set_window_cursor_after_update (struct window *);
static void adjust_frame_glyphs_for_window_redisplay (struct frame *);
static void adjust_frame_glyphs_for_frame_redisplay (struct frame *);
99
static void set_window_update_flags (struct window *w, bool on_p);
Jim Blandy's avatar
Jim Blandy committed
100

101
/* True means last display completed.  False means it was preempted.  */
Jim Blandy's avatar
Jim Blandy committed
102

103
bool display_completed;
Jim Blandy's avatar
Jim Blandy committed
104

105
/* True means SIGWINCH happened when not safe.  */
Jim Blandy's avatar
Jim Blandy committed
106

107
static bool delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
108

Gerd Moellmann's avatar
Gerd Moellmann committed
109
/* A glyph for a space.  */
Jim Blandy's avatar
Jim Blandy committed
110

Gerd Moellmann's avatar
Gerd Moellmann committed
111
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
112

113 114
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING

Gerd Moellmann's avatar
Gerd Moellmann committed
115 116
/* Counts of allocated structures.  These counts serve to diagnose
   memory leaks and double frees.  */
Jim Blandy's avatar
Jim Blandy committed
117

118 119
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
120

121 122
#endif /* GLYPH_DEBUG and ENABLE_CHECKING */

Gerd Moellmann's avatar
Gerd Moellmann committed
123 124
/* If non-null, the frame whose frame matrices are manipulated.  If
   null, window matrices are worked on.  */
Jim Blandy's avatar
Jim Blandy committed
125

Gerd Moellmann's avatar
Gerd Moellmann committed
126
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
127

128
/* Convert vpos and hpos from frame to window and vice versa.
Gerd Moellmann's avatar
Gerd Moellmann committed
129
   This may only be used for terminal frames.  */
130

131
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
132

133 134
static int window_to_frame_vpos (struct window *, int);
static int window_to_frame_hpos (struct window *, int);
Gerd Moellmann's avatar
Gerd Moellmann committed
135 136
#define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
#define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
Jim Blandy's avatar
Jim Blandy committed
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
/* One element of the ring buffer containing redisplay history
   information.  */

struct redisplay_history
{
  char trace[512 + 100];
};

/* The size of the history buffer.  */

#define REDISPLAY_HISTORY_SIZE	30

/* The redisplay history buffer.  */

static struct redisplay_history redisplay_history[REDISPLAY_HISTORY_SIZE];

/* Next free entry in redisplay_history.  */

static int history_idx;

/* A tick that's incremented each time something is added to the
   history.  */

161
static uprintmax_t history_tick;
Richard M. Stallman's avatar
Richard M. Stallman committed
162

163 164
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
165
   has been constructed.  PAUSED_P means that the update
166 167 168
   has been interrupted for pending input.  */

static void
169
add_window_display_history (struct window *w, const char *msg, bool paused_p)
170 171
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
172
  void *ptr = w;
173

174 175 176 177
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
Joakim Verona's avatar
Joakim Verona committed
178

179 180 181
  snprintf (buf, sizeof redisplay_history[0].trace,
	    "%"pMu": window %p (`%s')%s\n%s",
	    history_tick++,
Paul Eggert's avatar
Paul Eggert committed
182
	    ptr,
183 184 185
	    ((BUFFERP (w->contents)
	      && STRINGP (BVAR (XBUFFER (w->contents), name)))
	     ? SSDATA (BVAR (XBUFFER (w->contents), name))
186 187 188
	     : "???"),
	    paused_p ? " ***paused***" : "",
	    msg);
Joakim Verona's avatar
Joakim Verona committed
189
}
190 191 192


/* Add to the redisplay history that frame F has been displayed.
193
   PAUSED_P means that the update has been interrupted for
194 195
   pending input.  */

jave's avatar
jave committed
196 197
static void
add_frame_display_history (struct frame *f, bool paused_p)
198 199
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
200
  void *ptr = f;
201

202 203 204 205
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
206

207
  sprintf (buf, "%"pMu": update frame %p%s",
208
	   history_tick++,
Paul Eggert's avatar
Paul Eggert committed
209
	   ptr, paused_p ? " ***paused***" : "");
210 211 212 213 214
}


DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
       Sdump_redisplay_history, 0, 0, "",
215
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
216
  (void)
217 218 219 220 221 222 223 224 225 226 227 228 229 230
{
  int i;

  for (i = history_idx - 1; i != history_idx; --i)
    {
      if (i < 0)
	i = REDISPLAY_HISTORY_SIZE - 1;
      fprintf (stderr, "%s\n", redisplay_history[i].trace);
    }

  return Qnil;
}


231
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
232

233 234
#define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
#define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
Jim Blandy's avatar
Jim Blandy committed
235

236
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
237 238


239 240 241 242 243
#if (defined PROFILING \
     && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
     && !HAVE___EXECUTABLE_START)
/* This function comes first in the Emacs executable and is used only
   to estimate the text start for profiling.  */
Jim Blandy's avatar
Jim Blandy committed
244
void
245
__executable_start (void)
Jim Blandy's avatar
Jim Blandy committed
246
{
247
  emacs_abort ();
248
}
249
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
250 251 252 253 254 255 256 257 258 259 260

/***********************************************************************
			    Glyph Matrices
 ***********************************************************************/

/* Allocate and return a glyph_matrix structure.  POOL is the glyph
   pool from which memory for the matrix should be allocated, or null
   for window-based redisplay where no glyph pools are used.  The
   member `pool' of the glyph matrix structure returned is set to
   POOL, the structure is otherwise zeroed.  */

261
static struct glyph_matrix *
262
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
263
{
Dmitry Antipov's avatar
Dmitry Antipov committed
264
  struct glyph_matrix *result = xzalloc (sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
265

266
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING
Gerd Moellmann's avatar
Gerd Moellmann committed
267 268 269
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
270
#endif
Jim Blandy's avatar
Jim Blandy committed
271

Gerd Moellmann's avatar
Gerd Moellmann committed
272 273 274
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
275 276 277
}


Gerd Moellmann's avatar
Gerd Moellmann committed
278 279
/* Free glyph matrix MATRIX.  Passing in a null MATRIX is allowed.

280 281 282 283
   If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
   glyph_matrix_count is decremented when a matrix is freed.  If the count
   gets negative, more structures were freed than allocated, i.e. one matrix
   was freed more than once or a bogus pointer was passed to this function.
284

Gerd Moellmann's avatar
Gerd Moellmann committed
285 286 287 288 289
   If MATRIX->pool is null, this means that the matrix manages its own
   glyph memory---this is done for matrices on X frames.  Freeing the
   matrix also frees the glyph memory in this case.  */

static void
290
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
291
{
Gerd Moellmann's avatar
Gerd Moellmann committed
292 293 294 295
  if (matrix)
    {
      int i;

296
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING
Gerd Moellmann's avatar
Gerd Moellmann committed
297 298
      /* Detect the case that more matrices are freed than were
	 allocated.  */
299 300 301
      --glyph_matrix_count;
      eassert (glyph_matrix_count >= 0);
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
302 303 304 305 306

      /* Free glyph memory if MATRIX owns it.  */
      if (matrix->pool == NULL)
	for (i = 0; i < matrix->rows_allocated; ++i)
	  xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
307

Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310 311 312
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
313 314


Gerd Moellmann's avatar
Gerd Moellmann committed
315 316 317
/* Return the number of glyphs to reserve for a marginal area of
   window W.  TOTAL_GLYPHS is the number of glyphs in a complete
   display line of window W.  MARGIN gives the width of the marginal
318
   area in canonical character units.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
319 320

static int
321
margin_glyphs_to_reserve (struct window *w, int total_glyphs, int margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
322
{
323
  if (margin > 0)
Jim Blandy's avatar
Jim Blandy committed
324
    {
325
      int width = w->total_cols;
326
      double d = max (0, margin);
Gerd Moellmann's avatar
Gerd Moellmann committed
327
      d = min (width / 2 - 1, d);
328
      return (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
329
    }
330
  return 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
331 332
}

333
/* Return true if ROW's hash value is correct.
334 335
   Optimized away if ENABLE_CHECKING is not defined.  */

336
static bool
337 338
verify_row_hash (struct glyph_row *row)
{
339
  return row->hash == row_hash (row);
340
}
Jim Blandy's avatar
Jim Blandy committed
341

Gerd Moellmann's avatar
Gerd Moellmann committed
342 343
/* Adjust glyph matrix MATRIX on window W or on a frame to changed
   window sizes.
Jim Blandy's avatar
Jim Blandy committed
344

Gerd Moellmann's avatar
Gerd Moellmann committed
345 346 347 348 349
   W is null if the function is called for a frame glyph matrix.
   Otherwise it is the window MATRIX is a member of.  X and Y are the
   indices of the first column and row of MATRIX within the frame
   matrix, if such a matrix exists.  They are zero for purely
   window-based redisplay.  DIM is the needed size of the matrix.
350

Gerd Moellmann's avatar
Gerd Moellmann committed
351 352 353 354
   In window-based redisplay, where no frame matrices exist, glyph
   matrices manage their own glyph storage.  Otherwise, they allocate
   storage from a common frame glyph pool which can be found in
   MATRIX->pool.
355

Gerd Moellmann's avatar
Gerd Moellmann committed
356 357 358 359 360 361 362
   The reason for this memory management strategy is to avoid complete
   frame redraws if possible.  When we allocate from a common pool, a
   change of the location or size of a sub-matrix within the pool
   requires a complete redisplay of the frame because we cannot easily
   make sure that the current matrices of all windows still agree with
   what is displayed on the screen.  While this is usually fast, it
   leads to screen flickering.  */
363

Gerd Moellmann's avatar
Gerd Moellmann committed
364
static void
365
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
366 367 368
{
  int i;
  int new_rows;
369 370 371
  bool marginal_areas_changed_p = 0;
  bool header_line_changed_p = 0;
  bool header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
372
  int left = -1, right = -1;
373
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
374

Kenichi Handa's avatar
Kenichi Handa committed
375 376
  /* See if W had a header line that has disappeared now, or vice versa.
     Get W's size.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
377 378
  if (w)
    {
Joakim Verona's avatar
Joakim Verona committed
379
      window_box (w, ANY_AREA, 0, 0, &window_width, &window_height);
Kenichi Handa's avatar
Kenichi Handa committed
380

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
381 382
      header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
      header_line_changed_p = header_line_p != matrix->header_line_p;
Gerd Moellmann's avatar
Gerd Moellmann committed
383
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
384
  matrix->header_line_p = header_line_p;
385

Kenichi Handa's avatar
Kenichi Handa committed
386 387
  /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
     Do nothing if MATRIX' size, position, vscroll, and marginal areas
Gerd Moellmann's avatar
Gerd Moellmann committed
388 389 390 391
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
392 393
      left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
      right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
394
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397 398
      marginal_areas_changed_p = (left != matrix->left_margin_glyphs
				  || right != matrix->right_margin_glyphs);

      if (!marginal_areas_changed_p
Joakim Verona's avatar
Joakim Verona committed
399
	  && !XFRAME (w->frame)->fonts_changed
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
400
	  && !header_line_changed_p
401 402
	  && matrix->window_pixel_left == WINDOW_LEFT_PIXEL_EDGE (w)
	  && matrix->window_pixel_top == WINDOW_TOP_PIXEL_EDGE (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
403 404 405 406 407
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
408

Gerd Moellmann's avatar
Gerd Moellmann committed
409 410 411
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
412
      int old_alloc = matrix->rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
413
      new_rows = dim.height - matrix->rows_allocated;
414 415 416 417
      matrix->rows = xpalloc (matrix->rows, &matrix->rows_allocated,
			      new_rows, INT_MAX, sizeof *matrix->rows);
      memset (matrix->rows + old_alloc, 0,
	      (matrix->rows_allocated - old_alloc) * sizeof *matrix->rows);
Gerd Moellmann's avatar
Gerd Moellmann committed
418 419 420
    }
  else
    new_rows = 0;
421

Gerd Moellmann's avatar
Gerd Moellmann committed
422 423 424 425 426
  /* If POOL is not null, MATRIX is a frame matrix or a window matrix
     on a frame not using window-based redisplay.  Set up pointers for
     each row into the glyph pool.  */
  if (matrix->pool)
    {
427
      eassert (matrix->pool->glyphs);
428

Gerd Moellmann's avatar
Gerd Moellmann committed
429
      if (w)
430
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
431
	  left = margin_glyphs_to_reserve (w, dim.width,
432
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
433
	  right = margin_glyphs_to_reserve (w, dim.width,
434
					    w->right_margin_cols);
435
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
436 437
      else
	left = right = 0;
438

Gerd Moellmann's avatar
Gerd Moellmann committed
439
      for (i = 0; i < dim.height; ++i)
440
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
441
	  struct glyph_row *row = &matrix->rows[i];
442 443

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
444 445 446
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
447

Gerd Moellmann's avatar
Gerd Moellmann committed
448
	  if (w == NULL
449 450
	      || (row == matrix->rows + dim.height - 1
		  && WINDOW_WANTS_MODELINE_P (w))
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
451
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
	    {
	      row->glyphs[TEXT_AREA]
		= row->glyphs[LEFT_MARGIN_AREA];
	      row->glyphs[RIGHT_MARGIN_AREA]
		= row->glyphs[TEXT_AREA] + dim.width;
	      row->glyphs[LAST_AREA]
		= row->glyphs[RIGHT_MARGIN_AREA];
	    }
	  else
	    {
	      row->glyphs[TEXT_AREA]
		= row->glyphs[LEFT_MARGIN_AREA] + left;
	      row->glyphs[RIGHT_MARGIN_AREA]
		= row->glyphs[TEXT_AREA] + dim.width - left - right;
	      row->glyphs[LAST_AREA]
		= row->glyphs[LEFT_MARGIN_AREA] + dim.width;
	    }
469
	}
470

Gerd Moellmann's avatar
Gerd Moellmann committed
471 472 473 474 475 476
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
  else
    {
      /* If MATRIX->pool is null, MATRIX is responsible for managing
Kenichi Handa's avatar
Kenichi Handa committed
477 478
	 its own memory.  It is a window matrix for window-based redisplay.
	 Allocate glyph memory from the heap.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
479 480
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
481
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
482
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
483
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
484 485
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
486

Gerd Moellmann's avatar
Gerd Moellmann committed
487 488 489
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
490 491
		= xnrealloc (row->glyphs[LEFT_MARGIN_AREA],
			     dim.width, sizeof (struct glyph));
492

493 494 495
	      /* The mode line, if displayed, never has marginal areas.  */
	      if ((row == matrix->rows + dim.height - 1
		   && !(w && WINDOW_WANTS_MODELINE_P (w)))
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
496
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
		{
		  row->glyphs[TEXT_AREA]
		    = row->glyphs[LEFT_MARGIN_AREA];
		  row->glyphs[RIGHT_MARGIN_AREA]
		    = row->glyphs[TEXT_AREA] + dim.width;
		  row->glyphs[LAST_AREA]
		    = row->glyphs[RIGHT_MARGIN_AREA];
		}
	      else
		{
		  row->glyphs[TEXT_AREA]
		    = row->glyphs[LEFT_MARGIN_AREA] + left;
		  row->glyphs[RIGHT_MARGIN_AREA]
		    = row->glyphs[TEXT_AREA] + dim.width - left - right;
		  row->glyphs[LAST_AREA]
		    = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
		}
	      ++row;
	    }
Jim Blandy's avatar
Jim Blandy committed
516 517
	}

518
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
519 520 521
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
522

Gerd Moellmann's avatar
Gerd Moellmann committed
523 524
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
525
  eassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
526

527
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
528
    {
529
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
530
	{
531 532 533 534 535 536
	  /* Mark rows in a current matrix of a window as not having
	     valid contents.  It's important to not do this for
	     desired matrices.  When Emacs starts, it may already be
	     building desired matrices when this function runs.  */
	  if (window_width < 0)
	    window_width = window_box_width (w, -1);
537

538 539 540 541
	  /* Optimize the case that only the height has changed (C-x 2,
	     upper window).  Invalidate all rows that are no longer part
	     of the window.  */
	  if (!marginal_areas_changed_p
542 543 544
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
545 546
	      && matrix->window_pixel_left == WINDOW_LEFT_PIXEL_EDGE (w)
	      && matrix->window_pixel_top == WINDOW_TOP_PIXEL_EDGE (w)
547
	      && matrix->window_width == window_width)
548
	    {
549 550 551 552
	      /* Find the last row in the window.  */
	      for (i = 0; i < matrix->nrows && matrix->rows[i].enabled_p; ++i)
		if (MATRIX_ROW_BOTTOM_Y (matrix->rows + i) >= window_height)
		  {
553
		    ++i;
554 555
		    break;
		  }
556 557

	      /* Window end is invalid, if inside of the rows that
558
		 are invalidated below.  */
559
	      if (w->window_end_vpos >= i)
560
		w->window_end_valid = 0;
561

562
	      while (i < matrix->nrows)
563
		matrix->rows[i++].enabled_p = false;
564 565 566 567
	    }
	  else
	    {
	      for (i = 0; i < matrix->nrows; ++i)
568
		matrix->rows[i].enabled_p = false;
569
	    }
570 571 572 573 574 575
	  /* We've disabled the mode-line row, so force redrawing of
	     the mode line, if any, since otherwise it will remain
	     disabled in the current matrix, and expose events won't
	     redraw it.  */
	  if (WINDOW_WANTS_MODELINE_P (w))
	    w->update_mode_line = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
576
	}
577
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
578
	{
579 580 581 582
	  /* Rows in desired matrices always have to be cleared;
	     redisplay expects this is the case when it runs, so it
	     had better be the case when we adjust matrices between
	     redisplays.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
583
	  for (i = 0; i < matrix->nrows; ++i)
584
	    matrix->rows[i].enabled_p = false;
Jim Blandy's avatar
Jim Blandy committed
585 586
	}
    }
587 588


Gerd Moellmann's avatar
Gerd Moellmann committed
589 590 591 592 593 594 595 596 597
  /* Remember last values to be able to optimize frame redraws.  */
  matrix->matrix_x = x;
  matrix->matrix_y = y;
  matrix->matrix_w = dim.width;
  matrix->matrix_h = dim.height;

  /* Record the top y location and height of W at the time the matrix
     was last adjusted.  This is used to optimize redisplay above.  */
  if (w)
Jim Blandy's avatar
Jim Blandy committed
598
    {
599 600
      matrix->window_pixel_left = WINDOW_LEFT_PIXEL_EDGE (w);
      matrix->window_pixel_top = WINDOW_TOP_PIXEL_EDGE (w);
Gerd Moellmann's avatar
Gerd Moellmann committed
601 602 603 604 605
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
606 607


Gerd Moellmann's avatar
Gerd Moellmann committed
608 609 610 611
/* Reverse the contents of rows in MATRIX between START and END.  The
   contents of the row at END - 1 end up at START, END - 2 at START +
   1 etc.  This is part of the implementation of rotate_matrix (see
   below).  */
612

Gerd Moellmann's avatar
Gerd Moellmann committed
613
static void
614
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
615 616
{
  int i, j;
617

Gerd Moellmann's avatar
Gerd Moellmann committed
618 619 620 621 622 623 624 625 626 627
  for (i = start, j = end - 1; i < j; ++i, --j)
    {
      /* Non-ISO HP/UX compiler doesn't like auto struct
	 initialization.  */
      struct glyph_row temp;
      temp = matrix->rows[i];
      matrix->rows[i] = matrix->rows[j];
      matrix->rows[j] = temp;
    }
}
628 629


Gerd Moellmann's avatar
Gerd Moellmann committed
630 631 632 633
/* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
   1 by BY positions.  BY < 0 means rotate left, i.e. towards lower
   indices.  (Note: this does not copy glyphs, only glyph pointers in
   row structures are moved around).
634

Gerd Moellmann's avatar
Gerd Moellmann committed
635 636 637 638 639 640 641 642
   The algorithm used for rotating the vector was, I believe, first
   described by Kernighan.  See the vector R as consisting of two
   sub-vectors AB, where A has length BY for BY >= 0.  The result
   after rotating is then BA.  Reverse both sub-vectors to get ArBr
   and reverse the result to get (ArBr)r which is BA.  Similar for
   rotating right.  */

void
643
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
{
  if (by < 0)
    {
      /* Up (rotate left, i.e. towards lower indices).  */
      by = -by;
      reverse_rows (matrix, first, first + by);
      reverse_rows (matrix, first + by, last);
      reverse_rows (matrix, first, last);
    }
  else if (by > 0)
    {
      /* Down (rotate right, i.e. towards higher indices).  */
      reverse_rows (matrix, last - by, last);
      reverse_rows (matrix, first, last - by);
      reverse_rows (matrix, first, last);
    }
}


/* Increment buffer positions in glyph rows of MATRIX.  Do it for rows
   with indices START <= index < END.  Increment positions by DELTA/
   DELTA_BYTES.  */

void
668
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end,
669
			    ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
670 671
{
  /* Check that START and END are reasonable values.  */
672 673 674
  eassert (start >= 0 && start <= matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
  eassert (start <= end);
Gerd Moellmann's avatar
Gerd Moellmann committed
675 676

  for (; start < end; ++start)
677
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
678 679 680
}


681 682
/* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
   START and END are the row indices of the first and last + 1 row to clear.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
683 684

void
685
clear_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
686
{
687 688 689
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
690

Gerd Moellmann's avatar
Gerd Moellmann committed
691
  for (; start < end; ++start)
692
    matrix->rows[start].enabled_p = false;
Gerd Moellmann's avatar
Gerd Moellmann committed
693 694 695 696 697
}


/* Clear MATRIX.

698 699 700
   Empty all rows in MATRIX by clearing their enabled_p flags.
   The function prepare_desired_row will eventually really clear a row
   when it sees one with a false enabled_p flag.
Gerd Moellmann's avatar
Gerd Moellmann committed
701

702
   Reset update hints to default values.  The only update hint
Gerd Moellmann's avatar
Gerd Moellmann committed
703 704 705
   currently present is the flag MATRIX->no_scrolling_p.  */

void
706
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
707 708 709
{
  if (matrix)
    {
710
      clear_glyph_matrix_rows (matrix, 0, matrix->nrows);
Gerd Moellmann's avatar
Gerd Moellmann committed
711 712 713
      matrix->no_scrolling_p = 0;
    }
}
714

Gerd Moellmann's avatar
Gerd Moellmann committed
715 716 717 718 719 720

/* Shift part of the glyph matrix MATRIX of window W up or down.
   Increment y-positions in glyph rows between START and END by DY,
   and recompute their visible height.  */

void
721
shift_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int start, int end, int dy)
Gerd Moellmann's avatar
Gerd Moellmann committed
722 723
{
  int min_y, max_y;
724

725 726 727
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
728

729 730
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
731

Gerd Moellmann's avatar
Gerd Moellmann committed
732 733 734
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
735

Gerd Moellmann's avatar
Gerd Moellmann committed
736
      row->y += dy;
737
      row->visible_height = row->height;
738

Gerd Moellmann's avatar
Gerd Moellmann committed
739
      if (row->y < min_y)
740 741 742
	row->visible_height -= min_y - row->y;
      if (row->y + row->height > max_y)
	row->visible_height -= row->y + row->height - max_y;
743 744
      if (row->fringe_bitmap_periodic_p)
	row->redraw_fringe_bitmaps_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
745 746 747 748 749 750 751 752 753
    }
}


/* Mark all rows in current matrices of frame F as invalid.  Marking
   invalid is done by setting enabled_p to zero for all rows in a
   current matrix.  */

void
754
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
755 756 757 758 759
{
  /* Clear frame current matrix, if we have one.  */
  if (f->current_matrix)
    clear_glyph_matrix (f->current_matrix);

760
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
Gerd Moellmann's avatar
Gerd Moellmann committed
761 762 763
  /* Clear the matrix of the menu bar window, if such a window exists.
     The menu bar window is currently used to display menus on X when
     no toolkit support is compiled in.  */
764 765
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
766
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
767

768
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
769
  /* Clear the matrix of the tool-bar window, if any.  */
770 771
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
772
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
773 774

  /* Clear current window matrices.  */
775
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
776 777 778 779 780 781 782
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
}


/* Clear out all display lines of F for a coming redisplay.  */

void
783
clear_desired_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
784 785 786
{
  if (f->desired_matrix)
    clear_glyph_matrix (f->desired_matrix);
787

788
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
789 790
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
791
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
792

793
#if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
794 795
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
796
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
797 798

  /* Do it for window matrices.  */
799
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
800 801 802 803
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
}


804 805
/* Clear matrices in window tree rooted in W.  If DESIRED_P,
   clear desired matrices, otherwise clear current matrices.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
806 807

static void
808
clear_window_matrices (struct window *w, bool desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
809 810 811
{
  while (w)
    {
812 813
      if (WINDOWP (w->contents))
	clear_window_matrices (XWINDOW (w->contents), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816 817 818 819 820
      else
	{
	  if (desired_p)
	    clear_glyph_matrix (w->desired_matrix);
	  else
	    {
	      clear_glyph_matrix (w->current_matrix);
821
	      w->window_end_valid = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
822 823 824
	    }
	}

825
      w = NILP (w->next) ? 0 : XWINDOW (w->next);
Gerd Moellmann's avatar
Gerd Moellmann committed
826 827 828 829 830 831 832 833 834 835 836
    }
}



/***********************************************************************
			      Glyph Rows

      See dispextern.h for an overall explanation of glyph rows.
 ***********************************************************************/

837 838
/* Clear glyph row ROW.  NOTE: this code relies on the current
   layout of `glyphs' and `used' fields of `struct glyph_row'.  */
839

Gerd Moellmann's avatar
Gerd Moellmann committed
840
void
841
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
842
{
843
  enum { off = offsetof (struct glyph_row, used) };
844 845

  /* Zero everything except pointers in `glyphs'.  */
846
  memset (row->used, 0, sizeof *row - off);
Gerd Moellmann's avatar
Gerd Moellmann committed
847 848 849 850 851 852 853
}


/* Make ROW an empty, enabled row of canonical character height,
   in window W starting at y-position Y.  */

void
854
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
855 856
{
  int min_y, max_y;
857

858 859
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
860

Gerd Moellmann's avatar
Gerd Moellmann committed
861 862
  clear_glyph_row (row);
  row->y = y;
863
  row->ascent = row->phys_ascent = 0;
864
  row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
865
  row->visible_height = row->height;
866

Gerd Moellmann's avatar
Gerd Moellmann committed
867
  if (row->y < min_y)
868 869 870
    row->visible_height -= min_y - row->y;
  if (row->y + row->height > max_y)
    row->visible_height -= row->y + row->height - max_y;
Gerd Moellmann's avatar
Gerd Moellmann committed
871

872
  row->enabled_p = true;
Gerd Moellmann's avatar
Gerd Moellmann committed
873 874 875 876 877 878 879 880 881
}


/* Increment buffer positions in glyph row ROW.  DELTA and DELTA_BYTES
   are the amounts by which to change positions.  Note that the first
   glyph of the text area of a row can have a buffer position even if
   the used count of the text area is zero.  Such rows display line
   ends.  */

882
static void
883
increment_row_positions (struct glyph_row *row,
884
			 ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
885 886 887 888 889 890 891 892
{
  int area, i;

  /* Increment start and end positions.  */
  MATRIX_ROW_START_CHARPOS (row) += delta;
  MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
  MATRIX_ROW_END_CHARPOS (row) += delta;
  MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
893 894 895 896
  CHARPOS (row->start.pos) += delta;
  BYTEPOS (row->start.pos) += delta_bytes;
  CHARPOS (row->end.pos) += delta;
  BYTEPOS (row->end.pos) += delta_bytes;
Gerd Moellmann's avatar
Gerd Moellmann committed
897

898 899 900
  if (!row->enabled_p)
    return;