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

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

This file is part of GNU Emacs.

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

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

20
#include <config.h>
21
#include <signal.h>
22
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
23
#include <ctype.h>
24
#include <setjmp.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 29
#include "termchar.h"
#include "termopts.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

Jim Blandy's avatar
Jim Blandy committed
48 49
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
50
#endif /* HAVE_X_WINDOWS */
Jim Blandy's avatar
Jim Blandy committed
51

52 53 54 55
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

56 57 58 59
#ifdef HAVE_NS
#include "nsterm.h"
#endif

Gerd Moellmann's avatar
Gerd Moellmann committed
60
/* Include systime.h after xterm.h to avoid double inclusion of time.h.  */
61

Gerd Moellmann's avatar
Gerd Moellmann committed
62
#include "systime.h"
63 64
#include <errno.h>

Jim Blandy's avatar
Jim Blandy committed
65
/* Get number of chars of output now in the buffer of a stdio stream.
66
   This ought to be built in stdio, but it isn't.  Some s- files
Gerd Moellmann's avatar
Gerd Moellmann committed
67
   override this because their stdio internals differ.  */
68
#ifdef __GNU_LIBRARY__
Gerd Moellmann's avatar
Gerd Moellmann committed
69 70 71 72

/* The s- file might have overridden the definition with one that
   works for the system's C library.  But we are using the GNU C
   library, so this is the right definition for every system.  */
73 74 75
#ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
#define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
#else
76
#undef	PENDING_OUTPUT_COUNT
77
#define	PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
78
#endif
79 80 81 82 83

/* not __GNU_LIBRARY__ and no PENDING_OUTPUT_COUNT defined  */
#elif !defined (PENDING_OUTPUT_COUNT)

#if HAVE_STDIO_EXT_H && HAVE___FPENDING
84 85
#include <stdio_ext.h>
#define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
86
#else
Jim Blandy's avatar
Jim Blandy committed
87 88
#define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
#endif
89 90

#endif /* not __GNU_LIBRARY__ and no PENDING_OUTPUT_COUNT defined */
Gerd Moellmann's avatar
Gerd Moellmann committed
91

92
#if defined (HAVE_TERM_H) && defined (GNU_LINUX)
Dave Love's avatar
Dave Love committed
93 94
#include <term.h>		/* for tgetent */
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
95 96 97 98 99 100 101 102 103 104 105 106 107

/* Structure to pass dimensions around.  Used for character bounding
   boxes, glyph matrix dimensions and alike.  */

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

108
static void update_frame_line (struct frame *, int);
Andreas Schwab's avatar
Andreas Schwab committed
109 110
static int required_matrix_height (struct window *);
static int required_matrix_width (struct window *);
111 112
static void adjust_frame_glyphs (struct frame *);
static void change_frame_size_1 (struct frame *, int, int, int, int, int);
113
static void increment_row_positions (struct glyph_row *, ptrdiff_t, ptrdiff_t);
114 115 116 117 118 119 120 121 122 123 124 125 126
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_frame_message_buffer (struct frame *);
static void adjust_decode_mode_spec_buffer (struct frame *);
static void fill_up_glyph_row_with_spaces (struct glyph_row *);
static void clear_window_matrices (struct window *, int);
static void fill_up_glyph_row_area_with_spaces (struct glyph_row *, int);
static int scrolling_window (struct window *, int);
static int update_window_line (struct window *, int, int *);
static void mirror_make_current (struct window *, int);
127
#ifdef GLYPH_DEBUG
128 129
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
130
#endif
131 132 133 134
static void mirror_line_dance (struct window *, int, int, int *, char *);
static int update_window_tree (struct window *, int);
static int update_window (struct window *, int);
static int update_frame_1 (struct frame *, int, int);
135
static int scrolling (struct frame *);
136 137 138
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
139 140


141 142 143 144 145
/* Redisplay preemption timers.  */

static EMACS_TIME preemption_period;
static EMACS_TIME preemption_next_check;

Jim Blandy's avatar
Jim Blandy committed
146
/* Nonzero upon entry to redisplay means do not assume anything about
Jim Blandy's avatar
Jim Blandy committed
147
   current contents of actual terminal frame; clear and redraw it.  */
Jim Blandy's avatar
Jim Blandy committed
148

Jim Blandy's avatar
Jim Blandy committed
149
int frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
150

Gerd Moellmann's avatar
Gerd Moellmann committed
151
/* Nonzero means last display completed.  Zero means it was preempted.  */
Jim Blandy's avatar
Jim Blandy committed
152 153 154

int display_completed;

155
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
156

Jim Blandy's avatar
Jim Blandy committed
157

Gerd Moellmann's avatar
Gerd Moellmann committed
158
/* The currently selected frame.  In a single-frame version, this
159
   variable always equals the_only_frame.  */
Jim Blandy's avatar
Jim Blandy committed
160

161
Lisp_Object selected_frame;
Jim Blandy's avatar
Jim Blandy committed
162

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

Gerd Moellmann's avatar
Gerd Moellmann committed
168
struct frame *last_nonminibuf_frame;
169

Gerd Moellmann's avatar
Gerd Moellmann committed
170
/* 1 means SIGWINCH happened when not safe.  */
Jim Blandy's avatar
Jim Blandy committed
171

172
static int delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
173

Gerd Moellmann's avatar
Gerd Moellmann committed
174
/* 1 means glyph initialization has been completed at startup.  */
Jim Blandy's avatar
Jim Blandy committed
175

Gerd Moellmann's avatar
Gerd Moellmann committed
176
static int glyphs_initialized_initially_p;
Jim Blandy's avatar
Jim Blandy committed
177

Gerd Moellmann's avatar
Gerd Moellmann committed
178
/* Updated window if != 0.  Set by update_window.  */
Jim Blandy's avatar
Jim Blandy committed
179

Gerd Moellmann's avatar
Gerd Moellmann committed
180
struct window *updated_window;
Jim Blandy's avatar
Jim Blandy committed
181

Gerd Moellmann's avatar
Gerd Moellmann committed
182
/* Glyph row updated in update_window_line, and area that is updated.  */
Jim Blandy's avatar
Jim Blandy committed
183

Gerd Moellmann's avatar
Gerd Moellmann committed
184 185
struct glyph_row *updated_row;
int updated_area;
Jim Blandy's avatar
Jim Blandy committed
186

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

Gerd Moellmann's avatar
Gerd Moellmann committed
189
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
190

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

194 195
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
196

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

Gerd Moellmann's avatar
Gerd Moellmann committed
200
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
201

Gerd Moellmann's avatar
Gerd Moellmann committed
202 203 204 205
/* Non-zero means that fonts have been loaded since the last glyph
   matrix adjustments.  Redisplay must stop, and glyph matrices must
   be adjusted when this flag becomes non-zero during display.  The
   reason fonts can be loaded so late is that fonts of fontsets are
206 207 208
   loaded on demand.  Another reason is that a line contains many
   characters displayed by zero width or very narrow glyphs of
   variable-width fonts.  */
209

Gerd Moellmann's avatar
Gerd Moellmann committed
210
int fonts_changed_p;
211

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

215
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
216

217 218
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
219 220
#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
221

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
/* 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.  */

245
static uprintmax_t history_tick;
246

247
static void add_frame_display_history (struct frame *, int);
Richard M. Stallman's avatar
Richard M. Stallman committed
248

249 250
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
251
   has been constructed.  PAUSED_P non-zero means that the update
252 253 254
   has been interrupted for pending input.  */

static void
255
add_window_display_history (struct window *w, const char *msg, int paused_p)
256 257
{
  char *buf;
258

259 260 261 262
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
263

264 265 266 267
  snprintf (buf, sizeof redisplay_history[0].trace,
	    "%"pMu": window %p (`%s')%s\n%s",
	    history_tick++,
	    w,
268 269 270
	    ((BUFFERP (WVAR (w, buffer))
	      && STRINGP (BVAR (XBUFFER (WVAR (w, buffer)), name)))
	     ? SSDATA (BVAR (XBUFFER (WVAR (w, buffer)), name))
271 272 273
	     : "???"),
	    paused_p ? " ***paused***" : "",
	    msg);
274 275 276 277 278 279 280 281
}


/* Add to the redisplay history that frame F has been displayed.
   PAUSED_P non-zero means that the update has been interrupted for
   pending input.  */

static void
Andreas Schwab's avatar
Andreas Schwab committed
282
add_frame_display_history (struct frame *f, int paused_p)
283 284
{
  char *buf;
285

286 287 288 289
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
290

291
  sprintf (buf, "%"pMu": update frame %p%s",
292 293 294 295 296
	   history_tick++,
	   f, paused_p ? " ***paused***" : "");
}


Paul Eggert's avatar
Paul Eggert committed
297
DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
298
       Sdump_redisplay_history, 0, 0, "",
299
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
300
  (void)
301 302 303 304 305 306 307 308 309 310 311 312 313 314
{
  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;
}


315
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
316

317 318
#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
319

320
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
321 322


323 324 325 326 327
#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
328
void
329
__executable_start (void)
Jim Blandy's avatar
Jim Blandy committed
330
{
331
  abort ();
332
}
333
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
334 335 336 337 338 339 340 341 342 343 344

/***********************************************************************
			    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.  */

345
static struct glyph_matrix *
346
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
347
{
Dmitry Antipov's avatar
Dmitry Antipov committed
348
  struct glyph_matrix *result = xzalloc (sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
349

Gerd Moellmann's avatar
Gerd Moellmann committed
350 351 352
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
Jim Blandy's avatar
Jim Blandy committed
353

Gerd Moellmann's avatar
Gerd Moellmann committed
354 355 356
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
357 358 359
}


Gerd Moellmann's avatar
Gerd Moellmann committed
360 361 362 363 364 365
/* Free glyph matrix MATRIX.  Passing in a null MATRIX is allowed.

   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.
366

Gerd Moellmann's avatar
Gerd Moellmann committed
367 368 369 370 371
   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
372
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
373
{
Gerd Moellmann's avatar
Gerd Moellmann committed
374 375 376 377 378 379 380 381 382 383 384 385 386
  if (matrix)
    {
      int i;

      /* Detect the case that more matrices are freed than were
	 allocated.  */
      if (--glyph_matrix_count < 0)
	abort ();

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

Gerd Moellmann's avatar
Gerd Moellmann committed
388 389 390 391 392
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
393 394


Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397 398 399 400 401
/* 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
   area in canonical character units.  MARGIN should be an integer
   or a float.  */

static int
402
margin_glyphs_to_reserve (struct window *w, int total_glyphs, Lisp_Object margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
403 404
{
  int n;
Jim Blandy's avatar
Jim Blandy committed
405

Gerd Moellmann's avatar
Gerd Moellmann committed
406
  if (NUMBERP (margin))
Jim Blandy's avatar
Jim Blandy committed
407
    {
408
      int width = XFASTINT (WVAR (w, total_cols));
Gerd Moellmann's avatar
Gerd Moellmann committed
409 410
      double d = max (0, XFLOATINT (margin));
      d = min (width / 2 - 1, d);
411
      n = (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
412 413 414 415 416 417 418
    }
  else
    n = 0;

  return n;
}

419 420 421
/* Return non-zero if ROW's hash value is correct, zero if not.
   Optimized away if ENABLE_CHECKING is not defined.  */

422
static int
423 424
verify_row_hash (struct glyph_row *row)
{
425
  return row->hash == row_hash (row);
426
}
Jim Blandy's avatar
Jim Blandy committed
427

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

Gerd Moellmann's avatar
Gerd Moellmann committed
431 432 433 434 435
   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.
436

Gerd Moellmann's avatar
Gerd Moellmann committed
437 438 439 440
   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.
441

Gerd Moellmann's avatar
Gerd Moellmann committed
442 443 444 445 446 447 448
   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.  */
449

Gerd Moellmann's avatar
Gerd Moellmann committed
450
static void
451
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
452 453 454 455
{
  int i;
  int new_rows;
  int marginal_areas_changed_p = 0;
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
456 457
  int header_line_changed_p = 0;
  int header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
458
  int left = -1, right = -1;
459
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
460

Kenichi Handa's avatar
Kenichi Handa committed
461 462
  /* 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
463 464
  if (w)
    {
Kenichi Handa's avatar
Kenichi Handa committed
465 466
      window_box (w, -1, 0, 0, &window_width, &window_height);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
467 468
      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
469
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
470
  matrix->header_line_p = header_line_p;
471

Kenichi Handa's avatar
Kenichi Handa committed
472 473
  /* 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
474 475 476 477
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
478 479
      left = margin_glyphs_to_reserve (w, dim.width, WVAR (w, left_margin_cols));
      right = margin_glyphs_to_reserve (w, dim.width, WVAR (w, right_margin_cols));
480
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
481 482 483 484 485
      marginal_areas_changed_p = (left != matrix->left_margin_glyphs
				  || right != matrix->right_margin_glyphs);

      if (!marginal_areas_changed_p
	  && !fonts_changed_p
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
486
	  && !header_line_changed_p
487 488
	  && 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
489 490 491 492 493
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
494

Gerd Moellmann's avatar
Gerd Moellmann committed
495 496 497
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
498
      int old_alloc = matrix->rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
499
      new_rows = dim.height - matrix->rows_allocated;
500 501 502 503
      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
504 505 506
    }
  else
    new_rows = 0;
507

Gerd Moellmann's avatar
Gerd Moellmann committed
508 509 510 511 512
  /* 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)
    {
513
      eassert (matrix->pool->glyphs);
514

Gerd Moellmann's avatar
Gerd Moellmann committed
515
      if (w)
516
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
517
	  left = margin_glyphs_to_reserve (w, dim.width,
518
					   WVAR (w, left_margin_cols));
Gerd Moellmann's avatar
Gerd Moellmann committed
519
	  right = margin_glyphs_to_reserve (w, dim.width,
520
					    WVAR (w, right_margin_cols));
521
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
522 523
      else
	left = right = 0;
524

Gerd Moellmann's avatar
Gerd Moellmann committed
525
      for (i = 0; i < dim.height; ++i)
526
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
527
	  struct glyph_row *row = &matrix->rows[i];
528 529

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
533

Gerd Moellmann's avatar
Gerd Moellmann committed
534 535
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
536
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
	    {
	      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;
	    }
554
	}
555

Gerd Moellmann's avatar
Gerd Moellmann committed
556 557 558 559 560 561
      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
562 563
	 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
564 565
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
566
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
567
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
568
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
569 570
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
571

Gerd Moellmann's avatar
Gerd Moellmann committed
572 573 574
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
575 576
		= xnrealloc (row->glyphs[LEFT_MARGIN_AREA],
			     dim.width, sizeof (struct glyph));
577

Gerd Moellmann's avatar
Gerd Moellmann committed
578 579
	      /* The mode line never has marginal areas.  */
	      if (row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
580
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
		{
		  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
600 601
	}

602
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
603 604 605
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
606

Gerd Moellmann's avatar
Gerd Moellmann committed
607 608
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
609
  eassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
610

611
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
612
    {
613
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
614
	{
615 616 617 618 619 620
	  /* 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);
621

622 623 624 625
	  /* 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
626 627 628
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
629 630
	      && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	      && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
631
	      && matrix->window_width == window_width)
632
	    {
633 634 635 636
	      /* 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)
		  {
637
		    ++i;
638 639
		    break;
		  }
640 641

	      /* Window end is invalid, if inside of the rows that
642
		 are invalidated below.  */
643 644 645
	      if (INTEGERP (WVAR (w, window_end_vpos))
		  && XFASTINT (WVAR (w, window_end_vpos)) >= i)
		WVAR (w, window_end_valid) = Qnil;
646

647 648 649 650 651 652 653 654
	      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
655
	}
656
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
657
	{
658 659 660 661
	  /* 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
662 663
	  for (i = 0; i < matrix->nrows; ++i)
	    matrix->rows[i].enabled_p = 0;
Jim Blandy's avatar
Jim Blandy committed
664 665
	}
    }
666 667


Gerd Moellmann's avatar
Gerd Moellmann committed
668 669 670 671 672 673 674 675 676
  /* 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
677
    {
678 679
      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
680 681 682 683 684
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
685 686


Gerd Moellmann's avatar
Gerd Moellmann committed
687 688 689 690
/* 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).  */
691

Gerd Moellmann's avatar
Gerd Moellmann committed
692
static void
693
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
694 695
{
  int i, j;
696

Gerd Moellmann's avatar
Gerd Moellmann committed
697 698 699 700 701 702 703 704 705 706
  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;
    }
}
707 708


Gerd Moellmann's avatar
Gerd Moellmann committed
709 710 711 712
/* 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).
713

Gerd Moellmann's avatar
Gerd Moellmann committed
714 715 716 717 718 719 720 721
   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
722
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
{
  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
747
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end,
748
			    ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
749 750
{
  /* Check that START and END are reasonable values.  */
751 752 753
  eassert (start >= 0 && start <= matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
  eassert (start <= end);
Gerd Moellmann's avatar
Gerd Moellmann committed
754 755

  for (; start < end; ++start)
756
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
757 758 759 760 761 762 763 764
}


/* Enable a range of rows in glyph matrix MATRIX.  START and END are
   the row indices of the first and last + 1 row to enable.  If
   ENABLED_P is non-zero, enabled_p flags in rows will be set to 1.  */

void
765
enable_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end, int enabled_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
766
{
767 768 769
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
770

Gerd Moellmann's avatar
Gerd Moellmann committed
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
  for (; start < end; ++start)
    matrix->rows[start].enabled_p = enabled_p != 0;
}


/* Clear MATRIX.

   This empties all rows in MATRIX by setting the enabled_p flag for
   all rows of the matrix to zero.  The function prepare_desired_row
   will eventually really clear a row when it sees one with a zero
   enabled_p flag.

   Resets update hints to defaults value.  The only update hint
   currently present is the flag MATRIX->no_scrolling_p.  */

void
787
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
788 789 790 791 792 793 794
{
  if (matrix)
    {
      enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
      matrix->no_scrolling_p = 0;
    }
}
795

Gerd Moellmann's avatar
Gerd Moellmann committed
796 797 798 799 800 801

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

806 807 808
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
809

810 811
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
812

Gerd Moellmann's avatar
Gerd Moellmann committed
813 814 815
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
816

Gerd Moellmann's avatar
Gerd Moellmann committed
817
      row->y += dy;
818
      row->visible_height = row->height;
819

Gerd Moellmann's avatar
Gerd Moellmann committed
820
      if (row->y < min_y)
821 822 823
	row->visible_height -= min_y - row->y;
      if (row->y + row->height > max_y)
	row->visible_height -= row->y + row->height - max_y;
824 825
      if (row->fringe_bitmap_periodic_p)
	row->redraw_fringe_bitmaps_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
826 827 828 829 830 831 832 833 834
    }
}


/* 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
835
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
836 837 838 839 840 841 842 843
{
  /* Clear frame current matrix, if we have one.  */
  if (f->current_matrix)
    clear_glyph_matrix (f->current_matrix);

  /* 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.  */
844 845
  if (WINDOWP (FVAR (f, menu_bar_window)))
    clear_glyph_matrix (XWINDOW (FVAR (f, menu_bar_window))->current_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
846

847
  /* Clear the matrix of the tool-bar window, if any.  */
848 849
  if (WINDOWP (FVAR (f, tool_bar_window)))
    clear_glyph_matrix (XWINDOW (FVAR (f, tool_bar_window))->current_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
850 851

  /* Clear current window matrices.  */
852
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
853 854 855 856 857 858 859
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
}


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

void
860
clear_desired_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
861 862 863
{
  if (f->desired_matrix)
    clear_glyph_matrix (f->desired_matrix);
864

865 866
  if (WINDOWP (FVAR (f, menu_bar_window)))
    clear_glyph_matrix (XWINDOW (FVAR (f, menu_bar_window))->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
867

868 869
  if (WINDOWP (FVAR (f, tool_bar_window)))
    clear_glyph_matrix (XWINDOW (FVAR (f, tool_bar_window))->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
870 871

  /* Do it for window matrices.  */
872
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
873 874 875 876 877 878 879 880
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
}


/* Clear matrices in window tree rooted in W.  If DESIRED_P is
   non-zero clear desired matrices, otherwise clear current matrices.  */

static void
881
clear_window_matrices (struct window *w, int desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
882 883 884
{
  while (w)
    {
885
      if (!NILP (WVAR (w, hchild)))
Gerd Moellmann's avatar
Gerd Moellmann committed
886
	{
887 888
	  eassert (WINDOWP (WVAR (w, hchild)));
	  clear_window_matrices (XWINDOW (WVAR (w, hchild)), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
889
	}
890
      else if (!NILP (WVAR (w, vchild)))
Gerd Moellmann's avatar
Gerd Moellmann committed
891
	{
892 893
	  eassert (WINDOWP (WVAR (w, vchild)));
	  clear_window_matrices (XWINDOW (WVAR (w, vchild)), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
894 895 896 897 898 899 900 901
	}
      else
	{
	  if (desired_p)
	    clear_glyph_matrix (w->desired_matrix);
	  else
	    {
	      clear_glyph_matrix (w->current_matrix);
902
	      WVAR (w, window_end_valid) = Qnil;
Gerd Moellmann's avatar
Gerd Moellmann committed
903 904 905
	    }
	}

906
      w = NILP (WVAR (w, next)) ? 0 : XWINDOW (WVAR (w, next));
Gerd Moellmann's avatar
Gerd Moellmann committed
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921
    }
}


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

922 923
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
924
void
925
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
{
  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];
943 944 945 946 947 948

#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
949
	 the code below.  If the flickering is gone with that, chances
950
	 are that the flickering has the same reason as here.  */
951
  memset (p[0], 0, (char *) p[LAST_AREA] - (char *) p[0]);
952
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
953 954 955 956 957 958 959
}


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

void
960
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
961 962
{
  int min_y, max_y;
963