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-2017 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"
Paul Eggert's avatar
Paul Eggert committed
24
#include <stdlib.h>
Andreas Schwab's avatar
Andreas Schwab committed
25 26
#include <unistd.h>

27
#include "lisp.h"
Jim Blandy's avatar
Jim Blandy committed
28
#include "termchar.h"
29
/* cm.h must come after dispextern.h on Windows.  */
30 31
#include "dispextern.h"
#include "cm.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
#include "window.h"
#include "commands.h"
#include "disptab.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39
#include "blockinput.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
40
#include "syssignal.h"
41
#include "systime.h"
Paul Eggert's avatar
Paul Eggert committed
42
#include "tparam.h"
Paul Eggert's avatar
Paul Eggert committed
43
#include "xwidget.h"
Jim Blandy's avatar
Jim Blandy committed
44

45 46 47
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
48

49 50
#include <errno.h>

Paul Eggert's avatar
Paul Eggert committed
51
#include <fpending.h>
52

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

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

69
static void update_frame_line (struct frame *, int);
Andreas Schwab's avatar
Andreas Schwab committed
70 71
static int required_matrix_height (struct window *);
static int required_matrix_width (struct window *);
72
static void increment_row_positions (struct glyph_row *, ptrdiff_t, ptrdiff_t);
73 74 75 76 77 78
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 *);
79
static void clear_window_matrices (struct window *, bool);
80
static void fill_up_glyph_row_area_with_spaces (struct glyph_row *, int);
81 82
static int scrolling_window (struct window *, bool);
static bool update_window_line (struct window *, int, bool *);
83
static void mirror_make_current (struct window *, int);
84
#ifdef GLYPH_DEBUG
85 86
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
87
#endif
88
static void mirror_line_dance (struct window *, int, int, int *, char *);
89 90
static bool update_window_tree (struct window *, bool);
static bool update_window (struct window *, bool);
91
static bool update_frame_1 (struct frame *, bool, bool, bool);
92
static bool scrolling (struct frame *);
93 94 95
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 *);
96
static void set_window_update_flags (struct window *w, bool on_p);
Jim Blandy's avatar
Jim Blandy committed
97

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

100
bool display_completed;
Jim Blandy's avatar
Jim Blandy committed
101

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

104
static bool delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
105

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

Gerd Moellmann's avatar
Gerd Moellmann committed
108
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
109

110 111
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING

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

115 116
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
117

118 119
#endif /* GLYPH_DEBUG and ENABLE_CHECKING */

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

Gerd Moellmann's avatar
Gerd Moellmann committed
123
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
124

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

128
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
129

130 131
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
132 133
#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
134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
/* 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.  */

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

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

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

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


/* Add to the redisplay history that frame F has been displayed.
190
   PAUSED_P means that the update has been interrupted for
191 192
   pending input.  */

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

199 200 201 202
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
203

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


DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
       Sdump_redisplay_history, 0, 0, "",
212
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
213
  (void)
214 215 216 217 218 219 220 221 222 223 224 225 226 227
{
  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;
}


228
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
229

230 231
#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
232

233
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
234 235


236 237 238 239 240
#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
241
void
242
__executable_start (void)
Jim Blandy's avatar
Jim Blandy committed
243
{
244
  emacs_abort ();
245
}
246
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
247 248 249 250 251 252 253 254 255 256 257

/***********************************************************************
			    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.  */

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

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

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


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

277 278 279 280
   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.
281

Gerd Moellmann's avatar
Gerd Moellmann committed
282 283 284 285 286
   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
287
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
288
{
Gerd Moellmann's avatar
Gerd Moellmann committed
289 290 291 292
  if (matrix)
    {
      int i;

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

      /* 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]);
304

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


Gerd Moellmann's avatar
Gerd Moellmann committed
312 313 314
/* 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
315
   area in canonical character units.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
316 317

static int
318
margin_glyphs_to_reserve (struct window *w, int total_glyphs, int margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
319
{
320
  if (margin > 0)
Jim Blandy's avatar
Jim Blandy committed
321
    {
322
      int width = w->total_cols;
323
      double d = max (0, margin);
Gerd Moellmann's avatar
Gerd Moellmann committed
324
      d = min (width / 2 - 1, d);
325 326 327
      /* Since MARGIN is positive, we cannot possibly have less than
	 one glyph for the marginal area.  */
      return max (1, (int) ((double) total_glyphs / width * d));
Gerd Moellmann's avatar
Gerd Moellmann committed
328
    }
329
  return 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
330 331
}

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
344 345 346 347 348
   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.
349

Gerd Moellmann's avatar
Gerd Moellmann committed
350 351 352 353
   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.
354

Gerd Moellmann's avatar
Gerd Moellmann committed
355 356 357 358 359 360 361
   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.  */
362

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

Kenichi Handa's avatar
Kenichi Handa committed
374 375
  /* 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
376 377
  if (w)
    {
Joakim Verona's avatar
Joakim Verona committed
378
      window_box (w, ANY_AREA, 0, 0, &window_width, &window_height);
Kenichi Handa's avatar
Kenichi Handa committed
379

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

Kenichi Handa's avatar
Kenichi Handa committed
385 386
  /* 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
387 388 389 390
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
391 392
      left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
      right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
393
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
394 395 396 397
      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
398
	  && !XFRAME (w->frame)->fonts_changed
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
399
	  && !header_line_changed_p
400 401
	  && 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
402 403 404 405 406
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
407

Gerd Moellmann's avatar
Gerd Moellmann committed
408 409 410
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
411
      int old_alloc = matrix->rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
412
      new_rows = dim.height - matrix->rows_allocated;
413 414 415 416
      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
417 418 419
    }
  else
    new_rows = 0;
420

Gerd Moellmann's avatar
Gerd Moellmann committed
421 422 423 424 425
  /* 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)
    {
426
      eassert (matrix->pool->glyphs);
427

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
447
	  if (w == NULL
448
	      || (row == matrix->rows + dim.height - 1
449
		  && window_wants_mode_line (w))
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
450
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
	    {
	      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;
	    }
468
	}
469

Gerd Moellmann's avatar
Gerd Moellmann committed
470 471 472 473 474 475
      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
476 477
	 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
478 479
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
480
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
481
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
482
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
483 484
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
485

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

492 493
	      /* The mode line, if displayed, never has marginal areas.  */
	      if ((row == matrix->rows + dim.height - 1
494
		   && !(w && window_wants_mode_line (w)))
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
495
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
		{
		  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
515 516
	}

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

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

526
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
527
    {
528
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
529
	{
530 531 532 533 534 535
	  /* 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);
536

537 538 539 540
	  /* 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
541 542 543
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
544 545
	      && matrix->window_pixel_left == WINDOW_LEFT_PIXEL_EDGE (w)
	      && matrix->window_pixel_top == WINDOW_TOP_PIXEL_EDGE (w)
546
	      && matrix->window_width == window_width)
547
	    {
548 549 550 551
	      /* 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)
		  {
552
		    ++i;
553 554
		    break;
		  }
555 556

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

561
	      while (i < matrix->nrows)
562
		matrix->rows[i++].enabled_p = false;
563 564 565 566
	    }
	  else
	    {
	      for (i = 0; i < matrix->nrows; ++i)
567
		matrix->rows[i].enabled_p = false;
568
	    }
569 570 571 572
	  /* 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.  */
573
	  if (window_wants_mode_line (w))
574
	    w->update_mode_line = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
575
	}
576
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
577
	{
578 579 580 581
	  /* 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
582
	  for (i = 0; i < matrix->nrows; ++i)
583
	    matrix->rows[i].enabled_p = false;
Jim Blandy's avatar
Jim Blandy committed
584 585
	}
    }
586 587


Gerd Moellmann's avatar
Gerd Moellmann committed
588 589 590 591 592 593 594 595 596
  /* 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
597
    {
598 599
      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
600 601 602 603 604
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
605 606


Gerd Moellmann's avatar
Gerd Moellmann committed
607 608 609 610
/* 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).  */
611

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

Gerd Moellmann's avatar
Gerd Moellmann committed
617 618 619 620 621 622 623 624 625 626
  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;
    }
}
627 628


Gerd Moellmann's avatar
Gerd Moellmann committed
629 630 631 632
/* 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).
633

Gerd Moellmann's avatar
Gerd Moellmann committed
634 635 636 637 638 639 640 641
   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
642
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
{
  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
667
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end,
668
			    ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
669 670
{
  /* Check that START and END are reasonable values.  */
671 672 673
  eassert (start >= 0 && start <= matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
  eassert (start <= end);
Gerd Moellmann's avatar
Gerd Moellmann committed
674 675

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


680 681
/* 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
682 683

void
684
clear_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
685
{
686
  eassert (start <= end);
Chris Feng's avatar
Chris Feng committed
687 688 689
  eassert (start >= 0 && (start < matrix->nrows
			  /* matrix->nrows can be 0 for the initial frame.  */
			  || (matrix->nrows == 0)));
690
  eassert (end >= 0 && end <= matrix->nrows);
691

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


/* Clear MATRIX.

699 700 701
   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
702

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

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

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

/* 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
722
shift_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int start, int end, int dy)
Gerd Moellmann's avatar
Gerd Moellmann committed
723 724
{
  int min_y, max_y;
725

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

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

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

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

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


/* 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
755
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
756 757 758 759 760
{
  /* Clear frame current matrix, if we have one.  */
  if (f->current_matrix)
    clear_glyph_matrix (f->current_matrix);

761
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
Gerd Moellmann's avatar
Gerd Moellmann committed
762 763 764
  /* 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.  */
765 766
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
767
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
768

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

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


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

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

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

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

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


805 806
/* 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
807 808

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

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


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

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

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

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

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


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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
868
  if (row->y < min_y)
869 870 871
    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
872

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


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

883
static void
884
increment_row_positions (struct glyph_row *row,
885
			 ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
886 887 888 889 890