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

3 4
Copyright (C) 1985-1988, 1993-1995, 1997-2013 Free Software Foundation,
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/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
22 23 24

#define DISPEXTERN_INLINE EXTERN_INLINE

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
46
#include "syssignal.h"
Jim Blandy's avatar
Jim Blandy committed
47

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

52 53
#include <errno.h>

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

57
#if defined (HAVE_TERM_H) && defined (GNU_LINUX)
Dave Love's avatar
Dave Love committed
58 59
#include <term.h>		/* for tgetent */
#endif
60 61 62 63

#ifdef WINDOWSNT
#include "w32.h"
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
64 65 66 67 68 69 70 71 72 73 74 75 76

/* Structure to pass dimensions around.  Used for character bounding
   boxes, glyph matrix dimensions and alike.  */

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

77
static void update_frame_line (struct frame *, int);
Andreas Schwab's avatar
Andreas Schwab committed
78 79
static int required_matrix_height (struct window *);
static int required_matrix_width (struct window *);
80
static void change_frame_size_1 (struct frame *, int, int, bool, bool, bool);
81
static void increment_row_positions (struct glyph_row *, ptrdiff_t, ptrdiff_t);
82 83 84 85 86 87 88
static void fill_up_frame_row_with_spaces (struct glyph_row *, int);
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 *);
89
static void clear_window_matrices (struct window *, bool);
90
static void fill_up_glyph_row_area_with_spaces (struct glyph_row *, int);
91 92
static int scrolling_window (struct window *, bool);
static bool update_window_line (struct window *, int, bool *);
93
static void mirror_make_current (struct window *, int);
94
#ifdef GLYPH_DEBUG
95 96
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
97
#endif
98
static void mirror_line_dance (struct window *, int, int, int *, char *);
99 100 101 102
static bool update_window_tree (struct window *, bool);
static bool update_window (struct window *, bool);
static bool update_frame_1 (struct frame *, bool, bool);
static bool scrolling (struct frame *);
103 104 105
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 *);
Gerd Moellmann's avatar
Gerd Moellmann committed
106

107
/* True upon entry to redisplay means do not assume anything about
Jim Blandy's avatar
Jim Blandy committed
108
   current contents of actual terminal frame; clear and redraw it.  */
Jim Blandy's avatar
Jim Blandy committed
109

110
bool frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
111

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

114
bool display_completed;
Jim Blandy's avatar
Jim Blandy committed
115

116
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
117

Jim Blandy's avatar
Jim Blandy committed
118

Gerd Moellmann's avatar
Gerd Moellmann committed
119
/* The currently selected frame.  In a single-frame version, this
120
   variable always equals the_only_frame.  */
Jim Blandy's avatar
Jim Blandy committed
121

122
Lisp_Object selected_frame;
Jim Blandy's avatar
Jim Blandy committed
123

Gerd Moellmann's avatar
Gerd Moellmann committed
124
/* A frame which is not just a mini-buffer, or 0 if there are no such
Jim Blandy's avatar
Jim Blandy committed
125
   frames.  This is usually the most recent such frame that was
Morten Welinder's avatar
Morten Welinder committed
126 127
   selected.  In a single-frame version, this variable always holds
   the address of the_only_frame.  */
Jim Blandy's avatar
Jim Blandy committed
128

Gerd Moellmann's avatar
Gerd Moellmann committed
129
struct frame *last_nonminibuf_frame;
130

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

133
static bool delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
134

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

Gerd Moellmann's avatar
Gerd Moellmann committed
137
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
138

139 140
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING

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

144 145
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
146

147 148
#endif /* GLYPH_DEBUG and ENABLE_CHECKING */

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

Gerd Moellmann's avatar
Gerd Moellmann committed
152
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
153

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

157
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
158

159 160
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
161 162
#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
163

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/* 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.  */

187
static uprintmax_t history_tick;
Richard M. Stallman's avatar
Richard M. Stallman committed
188

189 190
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
191
   has been constructed.  PAUSED_P means that the update
192 193 194
   has been interrupted for pending input.  */

static void
195
add_window_display_history (struct window *w, const char *msg, bool paused_p)
196 197
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
198
  void *ptr = w;
199

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

205 206 207
  snprintf (buf, sizeof redisplay_history[0].trace,
	    "%"pMu": window %p (`%s')%s\n%s",
	    history_tick++,
Paul Eggert's avatar
Paul Eggert committed
208
	    ptr,
209 210 211
	    ((BUFFERP (w->contents)
	      && STRINGP (BVAR (XBUFFER (w->contents), name)))
	     ? SSDATA (BVAR (XBUFFER (w->contents), name))
212 213 214
	     : "???"),
	    paused_p ? " ***paused***" : "",
	    msg);
215 216 217 218
}


/* Add to the redisplay history that frame F has been displayed.
219
   PAUSED_P means that the update has been interrupted for
220 221 222
   pending input.  */

static void
223
add_frame_display_history (struct frame *f, bool paused_p)
224 225
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
226
  void *ptr = f;
227

228 229 230 231
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
232

233
  sprintf (buf, "%"pMu": update frame %p%s",
234
	   history_tick++,
Paul Eggert's avatar
Paul Eggert committed
235
	   ptr, paused_p ? " ***paused***" : "");
236 237 238
}


Paul Eggert's avatar
Paul Eggert committed
239
DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
240
       Sdump_redisplay_history, 0, 0, "",
241
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
242
  (void)
243 244 245 246 247 248 249 250 251 252 253 254 255 256
{
  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;
}


257
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
258

259 260
#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
261

262
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
263 264


265 266 267 268 269
#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
270
void
271
__executable_start (void)
Jim Blandy's avatar
Jim Blandy committed
272
{
273
  emacs_abort ();
274
}
275
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
276 277 278 279 280 281 282 283 284 285 286

/***********************************************************************
			    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.  */

287
static struct glyph_matrix *
288
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
289
{
Dmitry Antipov's avatar
Dmitry Antipov committed
290
  struct glyph_matrix *result = xzalloc (sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
291

292
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING
Gerd Moellmann's avatar
Gerd Moellmann committed
293 294 295
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
296
#endif
Jim Blandy's avatar
Jim Blandy committed
297

Gerd Moellmann's avatar
Gerd Moellmann committed
298 299 300
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
301 302 303
}


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

306 307 308 309
   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.
310

Gerd Moellmann's avatar
Gerd Moellmann committed
311 312 313 314 315
   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
316
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
317
{
Gerd Moellmann's avatar
Gerd Moellmann committed
318 319 320 321
  if (matrix)
    {
      int i;

322
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING
Gerd Moellmann's avatar
Gerd Moellmann committed
323 324
      /* Detect the case that more matrices are freed than were
	 allocated.  */
325 326 327
      --glyph_matrix_count;
      eassert (glyph_matrix_count >= 0);
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
328 329 330 331 332

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

Gerd Moellmann's avatar
Gerd Moellmann committed
334 335 336 337 338
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
339 340


Gerd Moellmann's avatar
Gerd Moellmann committed
341 342 343
/* 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
344
   area in canonical character units.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
345 346

static int
347
margin_glyphs_to_reserve (struct window *w, int total_glyphs, int margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
348
{
349
  if (margin > 0)
Jim Blandy's avatar
Jim Blandy committed
350
    {
351
      int width = w->total_cols;
352
      double d = max (0, margin);
Gerd Moellmann's avatar
Gerd Moellmann committed
353
      d = min (width / 2 - 1, d);
354
      return (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
355
    }
356
  return 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
357 358
}

359
/* Return true if ROW's hash value is correct.
360 361
   Optimized away if ENABLE_CHECKING is not defined.  */

362
static bool
363 364
verify_row_hash (struct glyph_row *row)
{
365
  return row->hash == row_hash (row);
366
}
Jim Blandy's avatar
Jim Blandy committed
367

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

Gerd Moellmann's avatar
Gerd Moellmann committed
371 372 373 374 375
   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.
376

Gerd Moellmann's avatar
Gerd Moellmann committed
377 378 379 380
   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.
381

Gerd Moellmann's avatar
Gerd Moellmann committed
382 383 384 385 386 387 388
   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.  */
389

Gerd Moellmann's avatar
Gerd Moellmann committed
390
static void
391
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
392 393 394
{
  int i;
  int new_rows;
395 396 397
  bool marginal_areas_changed_p = 0;
  bool header_line_changed_p = 0;
  bool header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
398
  int left = -1, right = -1;
399
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
400

Kenichi Handa's avatar
Kenichi Handa committed
401 402
  /* 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
403 404
  if (w)
    {
405
      window_box (w, ANY_AREA, 0, 0, &window_width, &window_height);
Kenichi Handa's avatar
Kenichi Handa committed
406

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
407 408
      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
409
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
410
  matrix->header_line_p = header_line_p;
411

Kenichi Handa's avatar
Kenichi Handa committed
412 413
  /* 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
414 415 416 417
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
418 419
      left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
      right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
420
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
421 422 423 424
      marginal_areas_changed_p = (left != matrix->left_margin_glyphs
				  || right != matrix->right_margin_glyphs);

      if (!marginal_areas_changed_p
425
	  && !XFRAME (w->frame)->fonts_changed
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
426
	  && !header_line_changed_p
427 428
	  && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	  && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
429 430 431 432 433
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
434

Gerd Moellmann's avatar
Gerd Moellmann committed
435 436 437
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
438
      int old_alloc = matrix->rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
439
      new_rows = dim.height - matrix->rows_allocated;
440 441 442 443
      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
444 445 446
    }
  else
    new_rows = 0;
447

Gerd Moellmann's avatar
Gerd Moellmann committed
448 449 450 451 452
  /* 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)
    {
453
      eassert (matrix->pool->glyphs);
454

Gerd Moellmann's avatar
Gerd Moellmann committed
455
      if (w)
456
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
457
	  left = margin_glyphs_to_reserve (w, dim.width,
458
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
459
	  right = margin_glyphs_to_reserve (w, dim.width,
460
					    w->right_margin_cols);
461
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463
      else
	left = right = 0;
464

Gerd Moellmann's avatar
Gerd Moellmann committed
465
      for (i = 0; i < dim.height; ++i)
466
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
467
	  struct glyph_row *row = &matrix->rows[i];
468 469

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
470 471 472
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
473

Gerd Moellmann's avatar
Gerd Moellmann committed
474 475
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
476
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
	    {
	      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;
	    }
494
	}
495

Gerd Moellmann's avatar
Gerd Moellmann committed
496 497 498 499 500 501
      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
502 503
	 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
504 505
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
506
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
507
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
508
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
509 510
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
511

Gerd Moellmann's avatar
Gerd Moellmann committed
512 513 514
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
515 516
		= xnrealloc (row->glyphs[LEFT_MARGIN_AREA],
			     dim.width, sizeof (struct glyph));
517

Gerd Moellmann's avatar
Gerd Moellmann committed
518 519
	      /* The mode line never has marginal areas.  */
	      if (row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
520
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
		{
		  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
540 541
	}

542
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
543 544 545
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
546

Gerd Moellmann's avatar
Gerd Moellmann committed
547 548
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
549
  eassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
550

551
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
552
    {
553
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
554
	{
555 556 557 558 559 560
	  /* 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);
561

562 563 564 565
	  /* 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
566 567 568
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
569 570
	      && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	      && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
571
	      && matrix->window_width == window_width)
572
	    {
573 574 575 576
	      /* 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)
		  {
577
		    ++i;
578 579
		    break;
		  }
580 581

	      /* Window end is invalid, if inside of the rows that
582
		 are invalidated below.  */
583
	      if (w->window_end_vpos >= i)
584
		w->window_end_valid = 0;
585

586 587 588 589 590 591 592 593
	      while (i < matrix->nrows)
		matrix->rows[i++].enabled_p = 0;
	    }
	  else
	    {
	      for (i = 0; i < matrix->nrows; ++i)
		matrix->rows[i].enabled_p = 0;
	    }
Gerd Moellmann's avatar
Gerd Moellmann committed
594
	}
595
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
596
	{
597 598 599 600
	  /* 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
601 602
	  for (i = 0; i < matrix->nrows; ++i)
	    matrix->rows[i].enabled_p = 0;
Jim Blandy's avatar
Jim Blandy committed
603 604
	}
    }
605 606


Gerd Moellmann's avatar
Gerd Moellmann committed
607 608 609 610 611 612 613 614 615
  /* 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
616
    {
617 618
      matrix->window_left_col = WINDOW_LEFT_EDGE_COL (w);
      matrix->window_top_line = WINDOW_TOP_EDGE_LINE (w);
Gerd Moellmann's avatar
Gerd Moellmann committed
619 620 621 622 623
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
624 625


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

Gerd Moellmann's avatar
Gerd Moellmann committed
631
static void
632
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
633 634
{
  int i, j;
635

Gerd Moellmann's avatar
Gerd Moellmann committed
636 637 638 639 640 641 642 643 644 645
  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;
    }
}
646 647


Gerd Moellmann's avatar
Gerd Moellmann committed
648 649 650 651
/* 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).
652

Gerd Moellmann's avatar
Gerd Moellmann committed
653 654 655 656 657 658 659 660
   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
661
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
{
  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
686
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end,
687
			    ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
688 689
{
  /* Check that START and END are reasonable values.  */
690 691 692
  eassert (start >= 0 && start <= matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
  eassert (start <= end);
Gerd Moellmann's avatar
Gerd Moellmann committed
693 694

  for (; start < end; ++start)
695
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
696 697 698
}


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

void
703
clear_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
704
{
705 706 707
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
708

Gerd Moellmann's avatar
Gerd Moellmann committed
709
  for (; start < end; ++start)
710
    matrix->rows[start].enabled_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
711 712 713 714 715
}


/* Clear MATRIX.

716 717 718
   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
719

720
   Reset update hints to default values.  The only update hint
Gerd Moellmann's avatar
Gerd Moellmann committed
721 722 723
   currently present is the flag MATRIX->no_scrolling_p.  */

void
724
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
725 726 727
{
  if (matrix)
    {
728
      clear_glyph_matrix_rows (matrix, 0, matrix->nrows);
Gerd Moellmann's avatar
Gerd Moellmann committed
729 730 731
      matrix->no_scrolling_p = 0;
    }
}
732

Gerd Moellmann's avatar
Gerd Moellmann committed
733 734 735 736 737 738

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

743 744 745
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
746

747 748
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
749

Gerd Moellmann's avatar
Gerd Moellmann committed
750 751 752
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
753

Gerd Moellmann's avatar
Gerd Moellmann committed
754
      row->y += dy;
755
      row->visible_height = row->height;
756

Gerd Moellmann's avatar
Gerd Moellmann committed
757
      if (row->y < min_y)
758 759 760
	row->visible_height -= min_y - row->y;
      if (row->y + row->height > max_y)
	row->visible_height -= row->y + row->height - max_y;
761 762
      if (row->fringe_bitmap_periodic_p)
	row->redraw_fringe_bitmaps_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
763 764 765 766 767 768 769 770 771
    }
}


/* 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
772
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
773 774 775 776 777
{
  /* Clear frame current matrix, if we have one.  */
  if (f->current_matrix)
    clear_glyph_matrix (f->current_matrix);

778
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
Gerd Moellmann's avatar
Gerd Moellmann committed
779 780 781
  /* 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.  */
782 783
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
784
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
785

786
  /* Clear the matrix of the tool-bar window, if any.  */
787 788
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
789 790

  /* Clear current window matrices.  */
791
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
792 793 794 795 796 797 798
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
}


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

void
799
clear_desired_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
800 801 802
{
  if (f->desired_matrix)
    clear_glyph_matrix (f->desired_matrix);
803

804
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
805 806
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
807
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
808

809 810
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
811 812

  /* Do it for window matrices.  */
813
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816 817
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
}


818 819
/* 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
820 821

static void
822
clear_window_matrices (struct window *w, bool desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
823 824 825
{
  while (w)
    {
826 827
      if (WINDOWP (w->contents))
	clear_window_matrices (XWINDOW (w->contents), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
828 829 830 831 832 833 834
      else
	{
	  if (desired_p)
	    clear_glyph_matrix (w->desired_matrix);
	  else
	    {
	      clear_glyph_matrix (w->current_matrix);
835
	      w->window_end_valid = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
836 837 838
	    }
	}

839
      w = NILP (w->next) ? 0 : XWINDOW (w->next);
Gerd Moellmann's avatar
Gerd Moellmann committed
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
    }
}


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

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

/* Clear glyph row ROW.  Do it in a way that makes it robust against
   changes in the glyph_row structure, i.e. addition or removal of
   structure members.  */

855 856
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
857
void
858
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
{
  struct glyph *p[1 + LAST_AREA];

  /* Save pointers.  */
  p[LEFT_MARGIN_AREA] = row->glyphs[LEFT_MARGIN_AREA];
  p[TEXT_AREA] = row->glyphs[TEXT_AREA];
  p[RIGHT_MARGIN_AREA] = row->glyphs[RIGHT_MARGIN_AREA];
  p[LAST_AREA] = row->glyphs[LAST_AREA];

  /* Clear.  */
  *row = null_row;

  /* Restore pointers.  */
  row->glyphs[LEFT_MARGIN_AREA] = p[LEFT_MARGIN_AREA];
  row->glyphs[TEXT_AREA] = p[TEXT_AREA];
  row->glyphs[RIGHT_MARGIN_AREA] = p[RIGHT_MARGIN_AREA];
  row->glyphs[LAST_AREA] = p[LAST_AREA];
876 877 878 879 880 881

#if 0 /* At some point, some bit-fields of struct glyph were not set,
	 which made glyphs unequal when compared with GLYPH_EQUAL_P.
	 Redisplay outputs such glyphs, and flickering effects were
	 the result.  This also depended on the contents of memory
	 returned by xmalloc.  If flickering happens again, activate
882
	 the code below.  If the flickering is gone with that, chances
883
	 are that the flickering has the same reason as here.  */
884
  memset (p[0], 0, (char *) p[LAST_AREA] - (char *) p[0]);
885
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
886 887 888 889 890 891 892
}


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

void
893
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
894 895
{
  int min_y, max_y;
896

897 898
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
899

Gerd Moellmann's avatar
Gerd Moellmann committed
900 901
  clear_glyph_row (row);
  row->y = y;
902
  row->ascent = row->phys_ascent = 0;
903
  row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
904
  row->visible_height = row->height;
905

Gerd Moellmann's avatar
Gerd Moellmann committed
906
  if (row->y < min_y)
907 908 909
    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
910 911 912