dispnew.c 191 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 92
static void fill_up_frame_row_with_spaces (struct glyph_row *, int);
static void build_frame_matrix_from_window_tree (struct glyph_matrix *,
                                                 struct window *);
static void build_frame_matrix_from_leaf_window (struct glyph_matrix *,
                                                 struct window *);
static void adjust_frame_message_buffer (struct frame *);
static void adjust_decode_mode_spec_buffer (struct frame *);
static void fill_up_glyph_row_with_spaces (struct glyph_row *);
93
static void clear_window_matrices (struct window *, bool);
94
static void fill_up_glyph_row_area_with_spaces (struct glyph_row *, int);
95 96
static int scrolling_window (struct window *, bool);
static bool update_window_line (struct window *, int, bool *);
97
static void mirror_make_current (struct window *, int);
98
#ifdef GLYPH_DEBUG
99 100
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
101
#endif
102
static void mirror_line_dance (struct window *, int, int, int *, char *);
103 104 105 106
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 *);
107 108 109
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
110 111


112 113 114 115 116
/* Redisplay preemption timers.  */

static EMACS_TIME preemption_period;
static EMACS_TIME preemption_next_check;

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

120
bool frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
121

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

124
bool display_completed;
Jim Blandy's avatar
Jim Blandy committed
125

126
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
127

Jim Blandy's avatar
Jim Blandy committed
128

Gerd Moellmann's avatar
Gerd Moellmann committed
129
/* The currently selected frame.  In a single-frame version, this
130
   variable always equals the_only_frame.  */
Jim Blandy's avatar
Jim Blandy committed
131

132
Lisp_Object selected_frame;
Jim Blandy's avatar
Jim Blandy committed
133

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

Gerd Moellmann's avatar
Gerd Moellmann committed
139
struct frame *last_nonminibuf_frame;
140

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

143
static bool delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
144

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

Gerd Moellmann's avatar
Gerd Moellmann committed
147
struct window *updated_window;
Jim Blandy's avatar
Jim Blandy committed
148

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

Gerd Moellmann's avatar
Gerd Moellmann committed
151 152
struct glyph_row *updated_row;
int updated_area;
Jim Blandy's avatar
Jim Blandy committed
153

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

Gerd Moellmann's avatar
Gerd Moellmann committed
156
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
157

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

161 162
static int glyph_matrix_count;
static int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
163

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

Gerd Moellmann's avatar
Gerd Moellmann committed
167
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
168

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

177
bool fonts_changed_p;
178

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

182
#ifdef GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
183

184 185
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
186 187
#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
188

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
/* 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.  */

212
static uprintmax_t history_tick;
Richard M. Stallman's avatar
Richard M. Stallman committed
213

214 215
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
216
   has been constructed.  PAUSED_P means that the update
217 218 219
   has been interrupted for pending input.  */

static void
220
add_window_display_history (struct window *w, const char *msg, bool paused_p)
221 222
{
  char *buf;
223

224 225 226 227
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
228

229 230 231 232
  snprintf (buf, sizeof redisplay_history[0].trace,
	    "%"pMu": window %p (`%s')%s\n%s",
	    history_tick++,
	    w,
233 234 235
	    ((BUFFERP (w->buffer)
	      && STRINGP (BVAR (XBUFFER (w->buffer), name)))
	     ? SSDATA (BVAR (XBUFFER (w->buffer), name))
236 237 238
	     : "???"),
	    paused_p ? " ***paused***" : "",
	    msg);
239 240 241 242
}


/* Add to the redisplay history that frame F has been displayed.
243
   PAUSED_P means that the update has been interrupted for
244 245 246
   pending input.  */

static void
247
add_frame_display_history (struct frame *f, bool paused_p)
248 249
{
  char *buf;
250

251 252 253 254
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
255

256
  sprintf (buf, "%"pMu": update frame %p%s",
257 258 259 260 261
	   history_tick++,
	   f, paused_p ? " ***paused***" : "");
}


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


280
#else /* not GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
281

282 283
#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
284

285
#endif /* GLYPH_DEBUG */
Jim Blandy's avatar
Jim Blandy committed
286 287


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

310
static struct glyph_matrix *
311
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
312
{
Dmitry Antipov's avatar
Dmitry Antipov committed
313
  struct glyph_matrix *result = xzalloc (sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
314

Gerd Moellmann's avatar
Gerd Moellmann committed
315 316 317
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
Jim Blandy's avatar
Jim Blandy committed
318

Gerd Moellmann's avatar
Gerd Moellmann committed
319 320 321
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
322 323 324
}


Gerd Moellmann's avatar
Gerd Moellmann committed
325 326 327 328 329 330
/* 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.
331

Gerd Moellmann's avatar
Gerd Moellmann committed
332 333 334 335 336
   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
337
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
338
{
Gerd Moellmann's avatar
Gerd Moellmann committed
339 340 341 342 343 344 345
  if (matrix)
    {
      int i;

      /* Detect the case that more matrices are freed than were
	 allocated.  */
      if (--glyph_matrix_count < 0)
346
	emacs_abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
347 348 349 350 351

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

Gerd Moellmann's avatar
Gerd Moellmann committed
353 354 355 356 357
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
358 359


Gerd Moellmann's avatar
Gerd Moellmann committed
360 361 362 363 364 365 366
/* 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
367
margin_glyphs_to_reserve (struct window *w, int total_glyphs, Lisp_Object margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
368 369
{
  int n;
Jim Blandy's avatar
Jim Blandy committed
370

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

  return n;
}

384
/* Return true if ROW's hash value is correct.
385 386
   Optimized away if ENABLE_CHECKING is not defined.  */

387
static bool
388 389
verify_row_hash (struct glyph_row *row)
{
390
  return row->hash == row_hash (row);
391
}
Jim Blandy's avatar
Jim Blandy committed
392

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
407 408 409 410 411 412 413
   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.  */
414

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

Kenichi Handa's avatar
Kenichi Handa committed
426 427
  /* 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
428 429
  if (w)
    {
Kenichi Handa's avatar
Kenichi Handa committed
430 431
      window_box (w, -1, 0, 0, &window_width, &window_height);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
432 433
      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
434
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
435
  matrix->header_line_p = header_line_p;
436

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
473 474 475 476 477
  /* 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)
    {
478
      eassert (matrix->pool->glyphs);
479

Gerd Moellmann's avatar
Gerd Moellmann committed
480
      if (w)
481
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
482
	  left = margin_glyphs_to_reserve (w, dim.width,
483
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
484
	  right = margin_glyphs_to_reserve (w, dim.width,
485
					    w->right_margin_cols);
486
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
487 488
      else
	left = right = 0;
489

Gerd Moellmann's avatar
Gerd Moellmann committed
490
      for (i = 0; i < dim.height; ++i)
491
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
492
	  struct glyph_row *row = &matrix->rows[i];
493 494

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
495 496 497
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
498

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
537 538 539
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
540 541
		= xnrealloc (row->glyphs[LEFT_MARGIN_AREA],
			     dim.width, sizeof (struct glyph));
542

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

567
      eassert (left >= 0 && right >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
568 569 570
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
571

Gerd Moellmann's avatar
Gerd Moellmann committed
572 573
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
574
  eassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
575

576
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
577
    {
578
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
579
	{
580 581 582 583 584 585
	  /* 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);
586

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

	      /* Window end is invalid, if inside of the rows that
607
		 are invalidated below.  */
608 609
	      if (INTEGERP (w->window_end_vpos)
		  && XFASTINT (w->window_end_vpos) >= i)
610
		w->window_end_valid = 0;
611

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


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


Gerd Moellmann's avatar
Gerd Moellmann committed
652 653 654 655
/* 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).  */
656

Gerd Moellmann's avatar
Gerd Moellmann committed
657
static void
658
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
659 660
{
  int i, j;
661

Gerd Moellmann's avatar
Gerd Moellmann committed
662 663 664 665 666 667 668 669 670 671
  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;
    }
}
672 673


Gerd Moellmann's avatar
Gerd Moellmann committed
674 675 676 677
/* 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).
678

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

  for (; start < end; ++start)
721
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
722 723 724
}


725 726
/* 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
727 728

void
729
clear_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
730
{
731 732 733
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
734

Gerd Moellmann's avatar
Gerd Moellmann committed
735
  for (; start < end; ++start)
736
    matrix->rows[start].enabled_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
737 738 739 740 741
}


/* Clear MATRIX.

742 743 744
   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
745

746
   Reset update hints to default values.  The only update hint
Gerd Moellmann's avatar
Gerd Moellmann committed
747 748 749
   currently present is the flag MATRIX->no_scrolling_p.  */

void
750
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
751 752 753
{
  if (matrix)
    {
754
      clear_glyph_matrix_rows (matrix, 0, matrix->nrows);
Gerd Moellmann's avatar
Gerd Moellmann committed
755 756 757
      matrix->no_scrolling_p = 0;
    }
}
758

Gerd Moellmann's avatar
Gerd Moellmann committed
759 760 761 762 763 764

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

769 770 771
  eassert (start <= end);
  eassert (start >= 0 && start < matrix->nrows);
  eassert (end >= 0 && end <= matrix->nrows);
772

773 774
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
775

Gerd Moellmann's avatar
Gerd Moellmann committed
776 777 778
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
779

Gerd Moellmann's avatar
Gerd Moellmann committed
780
      row->y += dy;
781
      row->visible_height = row->height;
782

Gerd Moellmann's avatar
Gerd Moellmann committed
783
      if (row->y < min_y)
784 785 786
	row->visible_height -= min_y - row->y;
      if (row->y + row->height > max_y)
	row->visible_height -= row->y + row->height - max_y;
787 788
      if (row->fringe_bitmap_periodic_p)
	row->redraw_fringe_bitmaps_p = 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
789 790 791 792 793 794 795 796 797
    }
}


/* 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
798
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
799 800 801 802 803 804 805 806
{
  /* Clear frame current matrix, if we have one.  */
  if (f->current_matrix)
    clear_glyph_matrix (f->current_matrix);

  /* Clear the matrix of the menu bar window, if such a window exists.
     The menu bar window is currently used to display menus on X when
     no toolkit support is compiled in.  */
807 808
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
809

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

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


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

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

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

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

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


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

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

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


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

885 886
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
887
void
888
clear_glyph_row (struct glyph_row *row)