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

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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
22 23 24

#define DISPEXTERN_INLINE EXTERN_INLINE

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

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

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

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

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;
Paul Eggert's avatar
Paul Eggert committed
216
  void *ptr = w;
217

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

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


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

static void
241
add_frame_display_history (struct frame *f, bool paused_p)
242 243
{
  char *buf;
Paul Eggert's avatar
Paul Eggert committed
244
  void *ptr = f;
245

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

251
  sprintf (buf, "%"pMu": update frame %p%s",
252
	   history_tick++,
Paul Eggert's avatar
Paul Eggert committed
253
	   ptr, paused_p ? " ***paused***" : "");
254 255 256
}


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


275
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
276

277 278
#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
279

280
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
281 282


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

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

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

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


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

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

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

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

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


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

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

  return n;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
494 495
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
496
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
	    {
	      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;
	    }
514
	}
515

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

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

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

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

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

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

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

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

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


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


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

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

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


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

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

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


720 721
/* 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
722 723

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

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


/* Clear MATRIX.

737 738 739
   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
740

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
754 755 756 757 758 759

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

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

768 769
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
770

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

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

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


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

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

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

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


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

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

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

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

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


839 840
/* 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
841 842

static void
843
clear_window_matrices (struct window *w, bool desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
844 845 846
{
  while (w)
    {
847 848
      if (WINDOWP (w->contents))
	clear_window_matrices (XWINDOW (w->contents), desired_p);
Gerd Moellmann's avatar
Gerd Moellmann committed
849 850 851 852 853 854 855
      else
	{
	  if (desired_p)
	    clear_glyph_matrix (w->desired_matrix);
	  else
	    {
	      clear_glyph_matrix (w->current_matrix);
856
	      w->window_end_valid = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
857 858 859
	    }
	}

860
      w = NILP (w->next) ? 0 : XWINDOW (w->next);
Gerd Moellmann's avatar
Gerd Moellmann committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
    }
}


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

876 877
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
878
void
879
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
{
  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];
897 898 899 900 901 902

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


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

void
914
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
915 916
{
  int min_y, max_y;
917

918 919
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
920

Gerd Moellmann's avatar
Gerd Moellmann committed
921 922
  clear_glyph_row (row);
  row->