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-2016 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 "buffer.h"
32
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
33
#include "frame.h"
34
#include "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
35 36 37
#include "window.h"
#include "commands.h"
#include "disptab.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
38
#include "blockinput.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
39
#include "syssignal.h"
40
#include "systime.h"
Paul Eggert's avatar
Paul Eggert committed
41
#include "tparam.h"
Paul Eggert's avatar
Paul Eggert committed
42
#include "xwidget.h"
Jim Blandy's avatar
Jim Blandy committed
43

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

48 49
#include <errno.h>

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

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

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

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

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

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

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

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

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

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

109 110
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING

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

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

117 118
#endif /* GLYPH_DEBUG and ENABLE_CHECKING */

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

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

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

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

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

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

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

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

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

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


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

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

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

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


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


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

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

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


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

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

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

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


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

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

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

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

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

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


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

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

329
/* Return true if ROW's hash value is correct.
330 331
   Optimized away if ENABLE_CHECKING is not defined.  */

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
341 342 343 344 345
   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.
346

Gerd Moellmann's avatar
Gerd Moellmann committed
347 348 349 350
   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.
351

Gerd Moellmann's avatar
Gerd Moellmann committed
352 353 354 355 356 357 358
   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.  */
359

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

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

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
377 378
      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
379
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
380
  matrix->header_line_p = header_line_p;
381

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

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

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

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

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

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

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

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

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

489 490 491
	      /* 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
492
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
		{
		  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
512 513
	}

514
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
515 516 517
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
518

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

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

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

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

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


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


Gerd Moellmann's avatar
Gerd Moellmann committed
604 605 606 607
/* 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).  */
608

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

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


Gerd Moellmann's avatar
Gerd Moellmann committed
626 627 628 629
/* 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).
630

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

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


677 678
/* 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
679 680

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

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


/* Clear MATRIX.

696 697 698
   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
699

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
713 714 715 716 717 718

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

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

727 728
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
729

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

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

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


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

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

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

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


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

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

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

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

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


802 803
/* 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
804 805

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

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


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

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

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

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

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


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

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

856 857
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
858

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

Gerd Moellmann's avatar
Gerd Moellmann committed
865
  if (row->y < min_y)
866 867 868
    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
869

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


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

880
static void
881
increment_row_positions (struct glyph_row *row,
882
			 ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
883 884 885 886 887 888 889 890
{
  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;
891 892 893 894
  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
895

896 897 898
  if (!row->enabled_p)
    return;

Gerd Moellmann's avatar
Gerd Moellmann committed
899 900 901 902 903 904 905 906 907 908 909 910 911 912
  /* Increment positions in glyphs.  */
  for (area = 0; area < LAST_AREA; ++area)
    for (i = 0; i < row->used[area]; ++i)
      if (BUFFERP (row->glyphs[area][i].object)
	  && row->glyphs[area][i].charpos > 0)
	row->glyphs[area][i].charpos += delta;

  /* Capture the case of rows displaying a line end.  */
  if (row->used[TEXT_AREA] == 0
      && MATRIX_ROW_DISPLAYS_TEXT_P (row))
    row->glyphs[TEXT_AREA]->charpos += delta;
}


913
#if 0
Gerd Moellmann's avatar
Gerd Moellmann committed
914 915 916 917 918
/* Swap glyphs between two glyph rows A and B.  This exchanges glyph
   contents, i.e. glyph structure contents are exchanged between A and
   B without changing glyph pointers in A and B.  */

static void
Andreas Schwab's avatar
Andreas Schwab committed
919
swap_glyphs_in_rows (struct glyph_row *a, struct glyph_row *b)
Gerd Moellmann's avatar
Gerd Moellmann committed
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
{
  int area;

  for (area = 0; area < LAST_AREA; ++area)
    {
      /* Number of glyphs to swap.  */
      int max_used = max (a->used[area], b->used[area]);

      /* Start of glyphs in area of row A.  */
      struct glyph *glyph_a = a->glyphs[area];

      /* End + 1 of glyphs in area of row A.  */
      struct glyph *glyph_a_end = a->glyphs[max_used];

      /* Start of glyphs in area of row B.  */
      struct glyph *glyph_b = b->glyphs[area];

      while (glyph_a < glyph_a_end)
	{
	  /* Non-ISO HP/UX compiler doesn't like auto struct
             initialization.  */
	  struct glyph temp;
	  temp = *glyph_a;
	  *glyph_a = *glyph_b;
	  *glyph_b = temp;
	  ++glyph_a;
	  ++glyph_b;
	}
    }
}

951
#endif /* 0 */
Gerd Moellmann's avatar
Gerd Moellmann committed
952

953 954 955 956
/* Exchange pointers to glyph memory between glyph rows A and B.  Also
   exchange the used[] array and the hash values of the rows, because
   these should all go together for the row's hash value to be
   correct.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
957

958
static void
959
swap_glyph_pointers (struct glyph_row *a, struct glyph_row *b)
Gerd Moellmann's avatar
Gerd Moellmann committed
960 961
{
  int i;
962 963
  unsigned hash_tem = a->hash;

Gerd Moellmann's avatar
Gerd Moellmann committed
964 965 966
  for (i = 0; i < LAST_AREA + 1; ++i)
    {
      struct glyph *temp = a->glyphs[i];
967

Gerd Moellmann's avatar
Gerd Moellmann committed
968 969
      a->glyphs[i] = b->glyphs[i];
      b->glyphs[i] = temp;
970 971 972 973 974 975 976
      if (i < LAST_AREA)
	{
	  short used_tem = a->used[i];

	  a->used[i] = b->used[i];
	  b->used[i] = used_tem;
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
977
    }
978 979
  a->hash = b->hash;
  b->hash = hash_tem;
Gerd Moellmann's avatar
Gerd Moellmann committed
980 981 982
}


983 984 985 986
/* Copy glyph row structure FROM to glyph row structure TO, except that
   glyph pointers, the `used' counts, and the hash values in the structures
   are left unchanged.  NOTE: this code relies on the current layout of
   `glyphs', `used', `hash' and `x' fields of `struct glyph_row'.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
987

988
static void
989
copy_row_except_pointers (struct glyph_row *to, struct glyph_row *from)
Gerd Moellmann's avatar
Gerd Moellmann committed
990
{
991
  enum { off = offsetof (struct glyph_row, x) };
992

993
  memcpy (&to->x, &from->x, sizeof *to - off);
Gerd Moellmann's avatar
Gerd Moellmann committed
994 995 996 997 998 999 1000 1001
}


/* Assign glyph row FROM to glyph row TO.  This works like a structure
   assignment TO = FROM, except that glyph pointers are not copied but
   exchanged between TO and FROM.  Pointers must be excha