dispnew.c 188 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 <stdio.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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
54
#include "systime.h"
55 56
#include <errno.h>

Paul Eggert's avatar
Paul Eggert committed
57
#include <fpending.h>
58

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

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

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

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

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

113
bool frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
114

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

117
bool display_completed;
Jim Blandy's avatar
Jim Blandy committed
118

119
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
120

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

125
Lisp_Object selected_frame;
Jim Blandy's avatar
Jim Blandy committed
126

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

Gerd Moellmann's avatar
Gerd Moellmann committed
132
struct frame *last_nonminibuf_frame;
133

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

136
static bool delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
137

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

Gerd Moellmann's avatar
Gerd Moellmann committed
140
struct window *updated_window;
Jim Blandy's avatar
Jim Blandy committed
141

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

Gerd Moellmann's avatar
Gerd Moellmann committed
144 145
struct glyph_row *updated_row;
int updated_area;
Jim Blandy's avatar
Jim Blandy committed
146

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

Gerd Moellmann's avatar
Gerd Moellmann committed
149
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
150

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

154 155
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
156

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

Gerd Moellmann's avatar
Gerd Moellmann committed
160
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
161

162
/* True means that fonts have been loaded since the last glyph
Gerd Moellmann's avatar
Gerd Moellmann committed
163
   matrix adjustments.  Redisplay must stop, and glyph matrices must
164
   be adjusted when this flag becomes true during display.  The
Gerd Moellmann's avatar
Gerd Moellmann committed
165
   reason fonts can be loaded so late is that fonts of fontsets are
166 167 168
   loaded on demand.  Another reason is that a line contains many
   characters displayed by zero width or very narrow glyphs of
   variable-width fonts.  */
169

170
bool fonts_changed_p;
171

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

175
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
176

177 178
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
179 180
#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
181

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
/* 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.  */

205
static uprintmax_t history_tick;
Richard M. Stallman's avatar
Richard M. Stallman committed
206

207 208
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
209
   has been constructed.  PAUSED_P means that the update
210 211 212
   has been interrupted for pending input.  */

static void
213
add_window_display_history (struct window *w, const char *msg, bool paused_p)
214 215
{
  char *buf;
216

217 218 219 220
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
221

222 223 224 225
  snprintf (buf, sizeof redisplay_history[0].trace,
	    "%"pMu": window %p (`%s')%s\n%s",
	    history_tick++,
	    w,
226 227 228
	    ((BUFFERP (w->buffer)
	      && STRINGP (BVAR (XBUFFER (w->buffer), name)))
	     ? SSDATA (BVAR (XBUFFER (w->buffer), name))
229 230 231
	     : "???"),
	    paused_p ? " ***paused***" : "",
	    msg);
232 233 234 235
}


/* Add to the redisplay history that frame F has been displayed.
236
   PAUSED_P means that the update has been interrupted for
237 238 239
   pending input.  */

static void
240
add_frame_display_history (struct frame *f, bool paused_p)
241 242
{
  char *buf;
243

244 245 246 247
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
248

249
  sprintf (buf, "%"pMu": update frame %p%s",
250 251 252 253 254
	   history_tick++,
	   f, paused_p ? " ***paused***" : "");
}


Paul Eggert's avatar
Paul Eggert committed
255
DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
256
       Sdump_redisplay_history, 0, 0, "",
257
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
258
  (void)
259 260 261 262 263 264 265 266 267 268 269 270 271 272
{
  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;
}


273
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
274

275 276
#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
277

278
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
279 280


281 282 283 284 285
#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
286
void
287
__executable_start (void)
Jim Blandy's avatar
Jim Blandy committed
288
{
289
  emacs_abort ();
290
}
291
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
292 293 294 295 296 297 298 299 300 301 302

/***********************************************************************
			    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.  */

303
static struct glyph_matrix *
304
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
305
{
Dmitry Antipov's avatar
Dmitry Antipov committed
306
  struct glyph_matrix *result = xzalloc (sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
307

Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
Jim Blandy's avatar
Jim Blandy committed
311

Gerd Moellmann's avatar
Gerd Moellmann committed
312 313 314
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
315 316 317
}


Gerd Moellmann's avatar
Gerd Moellmann committed
318 319 320 321 322 323
/* 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.
324

Gerd Moellmann's avatar
Gerd Moellmann committed
325 326 327 328 329
   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
330
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
331
{
Gerd Moellmann's avatar
Gerd Moellmann committed
332 333 334 335 336 337 338
  if (matrix)
    {
      int i;

      /* Detect the case that more matrices are freed than were
	 allocated.  */
      if (--glyph_matrix_count < 0)
339
	emacs_abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
340 341 342 343 344

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

Gerd Moellmann's avatar
Gerd Moellmann committed
346 347 348 349 350
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
351 352


Gerd Moellmann's avatar
Gerd Moellmann committed
353 354 355 356 357 358 359
/* 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
360
margin_glyphs_to_reserve (struct window *w, int total_glyphs, Lisp_Object margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
361 362
{
  int n;
Jim Blandy's avatar
Jim Blandy committed
363

Gerd Moellmann's avatar
Gerd Moellmann committed
364
  if (NUMBERP (margin))
Jim Blandy's avatar
Jim Blandy committed
365
    {
366
      int width = w->total_cols;
Gerd Moellmann's avatar
Gerd Moellmann committed
367 368
      double d = max (0, XFLOATINT (margin));
      d = min (width / 2 - 1, d);
369
      n = (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
370 371 372 373 374 375 376
    }
  else
    n = 0;

  return n;
}

377
/* Return true if ROW's hash value is correct.
378 379
   Optimized away if ENABLE_CHECKING is not defined.  */

380
static bool
381 382
verify_row_hash (struct glyph_row *row)
{
383
  return row->hash == row_hash (row);
384
}
Jim Blandy's avatar
Jim Blandy committed
385

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

Gerd Moellmann's avatar
Gerd Moellmann committed
389 390 391 392 393
   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.
394

Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397 398
   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.
399

Gerd Moellmann's avatar
Gerd Moellmann committed
400 401 402 403 404 405 406
   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.  */
407

Gerd Moellmann's avatar
Gerd Moellmann committed
408
static void
409
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
410 411 412
{
  int i;
  int new_rows;
413 414 415
  bool marginal_areas_changed_p = 0;
  bool header_line_changed_p = 0;
  bool header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
416
  int left = -1, right = -1;
417
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
418

Kenichi Handa's avatar
Kenichi Handa committed
419 420
  /* 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
421 422
  if (w)
    {
Kenichi Handa's avatar
Kenichi Handa committed
423 424
      window_box (w, -1, 0, 0, &window_width, &window_height);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
425 426
      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
427
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
428
  matrix->header_line_p = header_line_p;
429

Kenichi Handa's avatar
Kenichi Handa committed
430 431
  /* 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
432 433 434 435
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
436 437
      left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
      right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
438
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
439 440 441 442 443
      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
444
	  && !header_line_changed_p
445 446
	  && 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
447 448 449 450 451
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
452

Gerd Moellmann's avatar
Gerd Moellmann committed
453 454 455
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
456
      int old_alloc = matrix->rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
457
      new_rows = dim.height - matrix->rows_allocated;
458 459 460 461
      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
462 463 464
    }
  else
    new_rows = 0;
465

Gerd Moellmann's avatar
Gerd Moellmann committed
466 467 468 469 470
  /* 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)
    {
471
      eassert (matrix->pool->glyphs);
472

Gerd Moellmann's avatar
Gerd Moellmann committed
473
      if (w)
474
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
475
	  left = margin_glyphs_to_reserve (w, dim.width,
476
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
477
	  right = margin_glyphs_to_reserve (w, dim.width,
478
					    w->right_margin_cols);
479
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
480 481
      else
	left = right = 0;
482

Gerd Moellmann's avatar
Gerd Moellmann committed
483
      for (i = 0; i < dim.height; ++i)
484
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
485
	  struct glyph_row *row = &matrix->rows[i];
486 487

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
488 489 490
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
491

Gerd Moellmann's avatar
Gerd Moellmann committed
492 493
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
494
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
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;
	    }
512
	}
513

Gerd Moellmann's avatar
Gerd Moellmann committed
514 515 516 517 518 519
      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
520 521
	 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
522 523
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
524
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
525
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
526
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
527 528
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
529

Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
533 534
		= xnrealloc (row->glyphs[LEFT_MARGIN_AREA],
			     dim.width, sizeof (struct glyph));
535

Gerd Moellmann's avatar
Gerd Moellmann committed
536 537
	      /* The mode line never has marginal areas.  */
	      if (row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
538
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
		{
		  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
558 559
	}

560
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
561 562 563
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
564

Gerd Moellmann's avatar
Gerd Moellmann committed
565 566
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
567
  eassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
568

569
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
570
    {
571
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
572
	{
573 574 575 576 577 578
	  /* 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);
579

580 581 582 583
	  /* 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
584 585 586
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
587 588
	      && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	      && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
589
	      && matrix->window_width == window_width)
590
	    {
591 592 593 594
	      /* 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)
		  {
595
		    ++i;
596 597
		    break;
		  }
598 599

	      /* Window end is invalid, if inside of the rows that
600
		 are invalidated below.  */
601 602
	      if (INTEGERP (w->window_end_vpos)
		  && XFASTINT (w->window_end_vpos) >= i)
603
		w->window_end_valid = 0;
604

605 606 607 608 609 610 611 612
	      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
613
	}
614
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
615
	{
616 617 618 619
	  /* 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
620 621
	  for (i = 0; i < matrix->nrows; ++i)
	    matrix->rows[i].enabled_p = 0;
Jim Blandy's avatar
Jim Blandy committed
622 623
	}
    }
624 625


Gerd Moellmann's avatar
Gerd Moellmann committed
626 627 628 629 630 631 632 633 634
  /* 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
635
    {
636 637
      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
638 639 640 641 642
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
643 644


Gerd Moellmann's avatar
Gerd Moellmann committed
645 646 647 648
/* 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).  */
649

Gerd Moellmann's avatar
Gerd Moellmann committed
650
static void
651
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
652 653
{
  int i, j;
654

Gerd Moellmann's avatar
Gerd Moellmann committed
655 656 657 658 659 660 661 662 663 664
  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;
    }
}
665 666


Gerd Moellmann's avatar
Gerd Moellmann committed
667 668 669 670
/* 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).
671

Gerd Moellmann's avatar
Gerd Moellmann committed
672 673 674 675 676 677 678 679
   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
680
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
{
  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
705
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end,
706
			    ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
707 708
{
  /* Check that START and END are reasonable values.  */
709 710 711
  eassert (start >= 0 && start <= matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
  eassert (start <= end);
Gerd Moellmann's avatar
Gerd Moellmann committed
712 713

  for (; start < end; ++start)
714
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
715 716 717
}


718 719
/* 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
720 721

void
722
clear_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
723
{
724 725 726
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
727

Gerd Moellmann's avatar
Gerd Moellmann committed
728
  for (; start < end; ++start)
729
    matrix->rows[start].enabled_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
730 731 732 733 734
}


/* Clear MATRIX.

735 736 737
   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
738

739
   Reset update hints to default values.  The only update hint
Gerd Moellmann's avatar
Gerd Moellmann committed
740 741 742
   currently present is the flag MATRIX->no_scrolling_p.  */

void
743
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
744 745 746
{
  if (matrix)
    {
747
      clear_glyph_matrix_rows (matrix, 0, matrix->nrows);
Gerd Moellmann's avatar
Gerd Moellmann committed
748 749 750
      matrix->no_scrolling_p = 0;
    }
}
751

Gerd Moellmann's avatar
Gerd Moellmann committed
752 753 754 755 756 757

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

762 763 764
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
765

766 767
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
768

Gerd Moellmann's avatar
Gerd Moellmann committed
769 770 771
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
772

Gerd Moellmann's avatar
Gerd Moellmann committed
773
      row->y += dy;
774
      row->visible_height = row->height;
775

Gerd Moellmann's avatar
Gerd Moellmann committed
776
      if (row->y < min_y)
777 778 779
	row->visible_height -= min_y - row->y;
      if (row->y + row->height > max_y)
	row->visible_height -= row->y + row->height - max_y;
780 781
      if (row->fringe_bitmap_periodic_p)
	row->redraw_fringe_bitmaps_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
782 783 784 785 786 787 788 789 790
    }
}


/* 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
791
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
792 793 794 795 796
{
  /* Clear frame current matrix, if we have one.  */
  if (f->current_matrix)
    clear_glyph_matrix (f->current_matrix);

797
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
Gerd Moellmann's avatar
Gerd Moellmann committed
798 799 800
  /* 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.  */
801 802
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
803
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
804

805
  /* Clear the matrix of the tool-bar window, if any.  */
806 807
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
808 809

  /* Clear current window matrices.  */
810
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
811 812 813 814 815 816 817
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
}


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

void
818
clear_desired_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
819 820 821
{
  if (f->desired_matrix)
    clear_glyph_matrix (f->desired_matrix);
822

823
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
824 825
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
826
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
827

828 829
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
830 831

  /* Do it for window matrices.  */
832
  eassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
Gerd Moellmann's avatar
Gerd Moellmann committed
833 834 835 836
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
}


837 838
/* 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
839 840

static void
841
clear_window_matrices (struct window *w, bool desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
842 843 844
{
  while (w)
    {
845
      if (!NILP (w->hchild))
Gerd Moellmann's avatar
Gerd Moellmann committed
846
	{
847 848
	  eassert (WINDOWP (w->hchild));
	  clear_window_matrices (XWINDOW (w->hchild), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
849
	}
850
      else if (!NILP (w->vchild))
Gerd Moellmann's avatar
Gerd Moellmann committed
851
	{
852 853
	  eassert (WINDOWP (w->vchild));
	  clear_window_matrices (XWINDOW (w->vchild), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
854 855 856 857 858 859 860 861
	}
      else
	{
	  if (desired_p)
	    clear_glyph_matrix (w->desired_matrix);
	  else
	    {
	      clear_glyph_matrix (w->current_matrix);
862
	      w->window_end_valid = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
863 864 865
	    }
	}

866
      w = NILP (w->next) ? 0 : XWINDOW (w->next);
Gerd Moellmann's avatar
Gerd Moellmann committed
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
    }
}


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

882 883
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
884
void
885
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
{
  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];
903 904 905 906 907 908

#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
909
	 the code below.  If the flickering is gone with that, chances
910
	 are that the flickering has the same reason as here.  */
911
  memset (p[0], 0, (char *) p[LAST_AREA] - (char *) p[0]);
912
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
913 914 915 916 917 918 919
}


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

void
920
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
921 922
{
  int min_y, max_y;
923

924 925
  min_y =