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
#include "sysstdio.h"
Andreas Schwab's avatar
Andreas Schwab committed
24 25
#include <unistd.h>

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

Richard M. Stallman's avatar
Richard M. Stallman committed
44
#include "syssignal.h"
Jim Blandy's avatar
Jim Blandy committed
45

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

50 51
#include <errno.h>

Paul Eggert's avatar
Paul Eggert committed
52
#include <fpending.h>
53
#include <timespec.h>
54

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

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

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

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

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

107
bool display_completed;
Jim Blandy's avatar
Jim Blandy committed
108

109
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
110

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

113
static bool delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
114

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

Gerd Moellmann's avatar
Gerd Moellmann committed
117
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
118

119 120
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING

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

124 125
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
126

127 128
#endif /* GLYPH_DEBUG and ENABLE_CHECKING */

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

Gerd Moellmann's avatar
Gerd Moellmann committed
132
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
133

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

137
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
138

139 140
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
141 142
#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
143

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
/* 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.  */

167
static uprintmax_t history_tick;
Richard M. Stallman's avatar
Richard M. Stallman committed
168

169 170
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
171
   has been constructed.  PAUSED_P means that the update
172 173 174
   has been interrupted for pending input.  */

static void
175
add_window_display_history (struct window *w, const char *msg, bool paused_p)
176 177
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
178
  void *ptr = w;
179

180 181 182 183
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
184

185 186 187
  snprintf (buf, sizeof redisplay_history[0].trace,
	    "%"pMu": window %p (`%s')%s\n%s",
	    history_tick++,
Paul Eggert's avatar
Paul Eggert committed
188
	    ptr,
189 190 191
	    ((BUFFERP (w->contents)
	      && STRINGP (BVAR (XBUFFER (w->contents), name)))
	     ? SSDATA (BVAR (XBUFFER (w->contents), name))
192 193 194
	     : "???"),
	    paused_p ? " ***paused***" : "",
	    msg);
195 196 197 198
}


/* Add to the redisplay history that frame F has been displayed.
199
   PAUSED_P means that the update has been interrupted for
200 201 202
   pending input.  */

static void
203
add_frame_display_history (struct frame *f, bool paused_p)
204 205
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
206
  void *ptr = f;
207

208 209 210 211
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
212

213
  sprintf (buf, "%"pMu": update frame %p%s",
214
	   history_tick++,
Paul Eggert's avatar
Paul Eggert committed
215
	   ptr, paused_p ? " ***paused***" : "");
216 217 218
}


Paul Eggert's avatar
Paul Eggert committed
219
DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
220
       Sdump_redisplay_history, 0, 0, "",
221
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
222
  (void)
223 224 225 226 227 228 229 230 231 232 233 234 235 236
{
  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;
}


237
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
238

239 240
#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
241

242
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
243 244


245 246 247 248 249
#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
250
void
251
__executable_start (void)
Jim Blandy's avatar
Jim Blandy committed
252
{
253
  emacs_abort ();
254
}
255
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
256 257 258 259 260 261 262 263 264 265 266

/***********************************************************************
			    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.  */

267
static struct glyph_matrix *
268
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
269
{
Dmitry Antipov's avatar
Dmitry Antipov committed
270
  struct glyph_matrix *result = xzalloc (sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
271

272
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING
Gerd Moellmann's avatar
Gerd Moellmann committed
273 274 275
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
276
#endif
Jim Blandy's avatar
Jim Blandy committed
277

Gerd Moellmann's avatar
Gerd Moellmann committed
278 279 280
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
281 282 283
}


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

286 287 288 289
   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.
290

Gerd Moellmann's avatar
Gerd Moellmann committed
291 292 293 294 295
   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
296
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
297
{
Gerd Moellmann's avatar
Gerd Moellmann committed
298 299 300 301
  if (matrix)
    {
      int i;

302
#if defined GLYPH_DEBUG && defined ENABLE_CHECKING
Gerd Moellmann's avatar
Gerd Moellmann committed
303 304
      /* Detect the case that more matrices are freed than were
	 allocated.  */
305 306 307
      --glyph_matrix_count;
      eassert (glyph_matrix_count >= 0);
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310 311 312

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

Gerd Moellmann's avatar
Gerd Moellmann committed
314 315 316 317 318
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
319 320


Gerd Moellmann's avatar
Gerd Moellmann committed
321 322 323
/* 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
324
   area in canonical character units.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
325 326

static int
327
margin_glyphs_to_reserve (struct window *w, int total_glyphs, int margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
328
{
329
  if (margin > 0)
Jim Blandy's avatar
Jim Blandy committed
330
    {
331
      int width = w->total_cols;
332
      double d = max (0, margin);
Gerd Moellmann's avatar
Gerd Moellmann committed
333
      d = min (width / 2 - 1, d);
334
      return (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
335
    }
336
  return 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
337 338
}

339
/* Return true if ROW's hash value is correct.
340 341
   Optimized away if ENABLE_CHECKING is not defined.  */

342
static bool
343 344
verify_row_hash (struct glyph_row *row)
{
345
  return row->hash == row_hash (row);
346
}
Jim Blandy's avatar
Jim Blandy committed
347

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
362 363 364 365 366 367 368
   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.  */
369

Gerd Moellmann's avatar
Gerd Moellmann committed
370
static void
371
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
372 373 374
{
  int i;
  int new_rows;
375 376 377
  bool marginal_areas_changed_p = 0;
  bool header_line_changed_p = 0;
  bool header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
378
  int left = -1, right = -1;
379
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
380

Kenichi Handa's avatar
Kenichi Handa committed
381 382
  /* 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
383 384
  if (w)
    {
385
      window_box (w, ANY_AREA, 0, 0, &window_width, &window_height);
Kenichi Handa's avatar
Kenichi Handa committed
386

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
387 388
      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
389
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
390
  matrix->header_line_p = header_line_p;
391

Kenichi Handa's avatar
Kenichi Handa committed
392 393
  /* 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
394 395 396 397
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
398 399
      left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
      right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
400
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
401 402 403 404
      marginal_areas_changed_p = (left != matrix->left_margin_glyphs
				  || right != matrix->right_margin_glyphs);

      if (!marginal_areas_changed_p
405
	  && !XFRAME (w->frame)->fonts_changed
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
406
	  && !header_line_changed_p
407 408
	  && 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
409 410 411 412 413
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
414

Gerd Moellmann's avatar
Gerd Moellmann committed
415 416 417
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
418
      int old_alloc = matrix->rows_allocated;
Gerd Moellmann's avatar
Gerd Moellmann committed
419
      new_rows = dim.height - matrix->rows_allocated;
420 421 422 423
      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
424 425 426
    }
  else
    new_rows = 0;
427

Gerd Moellmann's avatar
Gerd Moellmann committed
428 429 430 431 432
  /* 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)
    {
433
      eassert (matrix->pool->glyphs);
434

Gerd Moellmann's avatar
Gerd Moellmann committed
435
      if (w)
436
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
437
	  left = margin_glyphs_to_reserve (w, dim.width,
438
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
439
	  right = margin_glyphs_to_reserve (w, dim.width,
440
					    w->right_margin_cols);
441
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
442 443
      else
	left = right = 0;
444

Gerd Moellmann's avatar
Gerd Moellmann committed
445
      for (i = 0; i < dim.height; ++i)
446
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
447
	  struct glyph_row *row = &matrix->rows[i];
448 449

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
450 451 452
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
453

Gerd Moellmann's avatar
Gerd Moellmann committed
454 455
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
456
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
	    {
	      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;
	    }
474
	}
475

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

Gerd Moellmann's avatar
Gerd Moellmann committed
492 493 494
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
495 496
		= xnrealloc (row->glyphs[LEFT_MARGIN_AREA],
			     dim.width, sizeof (struct glyph));
497

Gerd Moellmann's avatar
Gerd Moellmann committed
498 499
	      /* The mode line never has marginal areas.  */
	      if (row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
500
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
		{
		  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
520 521
	}

522
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
523 524 525
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
526

Gerd Moellmann's avatar
Gerd Moellmann committed
527 528
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
529
  eassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
530

531
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
532
    {
533
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
534
	{
535 536 537 538 539 540
	  /* 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);
541

542 543 544 545
	  /* 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
546 547 548
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
549 550
	      && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	      && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
551
	      && matrix->window_width == window_width)
552
	    {
553 554 555 556
	      /* 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)
		  {
557
		    ++i;
558 559
		    break;
		  }
560 561

	      /* Window end is invalid, if inside of the rows that
562
		 are invalidated below.  */
563
	      if (w->window_end_vpos >= i)
564
		w->window_end_valid = 0;
565

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


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


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

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

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


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

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

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


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

void
683
clear_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
684
{
685 686 687
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
688

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


/* Clear MATRIX.

696 697 698
   Empty all rows in MATRIX by clearing their enabled_p flags.
   The function prepare_desired_row will eventually really clear a row
   when it sees one with a false enabled_p flag.
Gerd Moellmann's avatar
Gerd Moellmann committed
699

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

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

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

/* Shift part of the glyph matrix MATRIX of window W up or down.
   Increment y-positions in glyph rows between START and END by DY,
   and recompute their visible height.  */

void
719
shift_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int start, int end, int dy)
Gerd Moellmann's avatar
Gerd Moellmann committed
720 721
{
  int min_y, max_y;
722

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

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

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

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

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


/* Mark all rows in current matrices of frame F as invalid.  Marking
   invalid is done by setting enabled_p to zero for all rows in a
   current matrix.  */

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

758
#if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
Gerd Moellmann's avatar
Gerd Moellmann committed
759 760 761
  /* Clear the matrix of the menu bar window, if such a window exists.
     The menu bar window is currently used to display menus on X when
     no toolkit support is compiled in.  */
762 763
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
764
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
765

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

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


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

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

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

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

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


802 803
/* Clear matrices in window tree rooted in W.  If DESIRED_P,
   clear desired matrices, otherwise clear current matrices.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
804 805

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

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


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

839 840
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
841
void
842
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
{
  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];
860 861 862 863 864 865

#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
866
	 the code below.  If the flickering is gone with that, chances
867
	 are that the flickering has the same reason as here.  */
868
  memset (p[0], 0, (char *) p[LAST_AREA] - (char *) p[0]);
869
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
870 871 872 873 874 875 876
}


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

void
877
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
878 879
{
  int min_y, max_y;
880

881 882
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
883

Gerd Moellmann's avatar
Gerd Moellmann committed
884 885
  clear_glyph_row (row);
  row->y = y;
886
  row->ascent = row->phys_ascent = 0;
887
  row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
888
  row->visible_height = row->height;
889

Gerd Moellmann's avatar
Gerd Moellmann committed
890
  if (row->y < min_y)
891 892 893
    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
894 895 896 897 898 899 900 901 902 903 904

  row->enabled_p = 1;
}


/* Increment buffer positions in glyph row ROW.  DELTA and DELTA_BYTES
   are the amounts by which to change positions.  Note that the first
   glyph of the text area of a row can have a buffer position even if
   the used count of the text area is zero.  Such rows display line
   ends.  */

905
static void
906
increment_row_positions (struct glyph_row *row,
907
			 ptrdiff_t delta, ptrdiff_t delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
908 909 910 911 912 913 914 915
{
  int area, i;

  /* Increment start and end positions.  */
  MATRIX_ROW_START_CHARPOS (row) += delta;
  MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
  MATRIX_ROW_END_CHARPOS (row) += delta;
  MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
916 917 918 919
  CHARPOS (row->start.pos) += delta;
  BYTEPOS (row->start.pos) += delta_bytes;
  CHARPOS (row->end.pos) += delta;
  BYTEPOS (row->end.pos) += delta_bytes;
Gerd Moellmann's avatar
Gerd Moellmann committed
920

921 922 923
  if (!row->enabled_p)
    return;

Gerd Moellmann's avatar
Gerd Moellmann committed
924 925