dispnew.c 193 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Updating of data structures for redisplay.
2 3
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003,
Glenn Morris's avatar
Glenn Morris committed
4
                 2004, 2005, 2006, 2007, 2008, 2009, 2010 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
#include <signal.h>
23
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
24
#include <ctype.h>
25
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
26

Andreas Schwab's avatar
Andreas Schwab committed
27 28 29 30
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

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

Richard M. Stallman's avatar
Richard M. Stallman committed
50
#include "syssignal.h"
Jim Blandy's avatar
Jim Blandy committed
51

Jim Blandy's avatar
Jim Blandy committed
52 53
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
54
#endif /* HAVE_X_WINDOWS */
Jim Blandy's avatar
Jim Blandy committed
55

56 57 58 59
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

60 61 62 63
#ifdef HAVE_NS
#include "nsterm.h"
#endif

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

Gerd Moellmann's avatar
Gerd Moellmann committed
66
#include "systime.h"
67 68
#include <errno.h>

Gerd Moellmann's avatar
Gerd Moellmann committed
69 70 71 72 73 74
/* To get the prototype for `sleep'.  */

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
75
/* Get number of chars of output now in the buffer of a stdio stream.
Gerd Moellmann's avatar
Gerd Moellmann committed
76 77 78
   This ought to be built in in stdio, but it isn't.  Some s- files
   override this because their stdio internals differ.  */

79
#ifdef __GNU_LIBRARY__
Gerd Moellmann's avatar
Gerd Moellmann committed
80 81 82 83 84

/* The s- file might have overridden the definition with one that
   works for the system's C library.  But we are using the GNU C
   library, so this is the right definition for every system.  */

85 86 87
#ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
#define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
#else
88
#undef	PENDING_OUTPUT_COUNT
89
#define	PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
90 91
#endif
#else /* not __GNU_LIBRARY__ */
92 93 94 95
#if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
#include <stdio_ext.h>
#define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
#endif
96
#ifndef PENDING_OUTPUT_COUNT
Jim Blandy's avatar
Jim Blandy committed
97 98
#define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
99 100
#endif /* not __GNU_LIBRARY__ */

101
#if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
Dave Love's avatar
Dave Love committed
102 103
#include <term.h>		/* for tgetent */
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
104 105 106 107 108 109 110 111 112 113 114 115 116

/* Structure to pass dimensions around.  Used for character bounding
   boxes, glyph matrix dimensions and alike.  */

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

117 118 119 120 121 122 123 124 125 126 127
static struct glyph_matrix *save_current_matrix (struct frame *);
static void restore_current_matrix (struct frame *, struct glyph_matrix *);
static int showing_window_margins_p (struct window *);
static void fake_current_matrices (Lisp_Object);
static void redraw_overlapping_rows (struct window *, int);
static void redraw_overlapped_rows (struct window *, int);
static int count_blanks (struct glyph *, int);
static int count_match (struct glyph *, struct glyph *,
                        struct glyph *, struct glyph *);
static unsigned line_draw_cost (struct glyph_matrix *, int);
static void update_frame_line (struct frame *, int);
Gerd Moellmann's avatar
Gerd Moellmann committed
128
static struct dim allocate_matrices_for_frame_redisplay
129 130 131 132 133 134 135 136 137 138
     (Lisp_Object, int, int, int, int *);
static void allocate_matrices_for_window_redisplay (struct window *);
static int realloc_glyph_pool (struct glyph_pool *, struct dim);
static void adjust_frame_glyphs (struct frame *);
struct glyph_matrix *new_glyph_matrix (struct glyph_pool *);
static void free_glyph_matrix (struct glyph_matrix *);
static void adjust_glyph_matrix (struct window *, struct glyph_matrix *,
                                 int, int, struct dim);
static void change_frame_size_1 (struct frame *, int, int, int, int, int);
static void swap_glyph_pointers (struct glyph_row *, struct glyph_row *);
139
#if GLYPH_DEBUG
140
static int glyph_row_slice_p (struct glyph_row *, struct glyph_row *);
141
#endif
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
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 struct glyph_pool *new_glyph_pool (void);
static void free_glyph_pool (struct glyph_pool *);
static void adjust_frame_glyphs_initially (void);
static void adjust_frame_message_buffer (struct frame *);
static void adjust_decode_mode_spec_buffer (struct frame *);
static void fill_up_glyph_row_with_spaces (struct glyph_row *);
static void build_frame_matrix (struct frame *);
void clear_current_matrices (struct frame *);
void scroll_glyph_matrix_range (struct glyph_matrix *, int, int,
                                int, int);
static void clear_window_matrices (struct window *, int);
static void fill_up_glyph_row_area_with_spaces (struct glyph_row *, int);
static int scrolling_window (struct window *, int);
static int update_window_line (struct window *, int, int *);
static void update_marginal_area (struct window *, int, int);
static int update_text_area (struct window *, int);
static void make_current (struct glyph_matrix *, struct glyph_matrix *,
                          int);
static void mirror_make_current (struct window *, int);
void check_window_matrix_pointers (struct window *);
167
#if GLYPH_DEBUG
168 169
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
170
#endif
171 172 173 174 175 176 177 178 179 180 181 182 183
static void mirror_line_dance (struct window *, int, int, int *, char *);
static int update_window_tree (struct window *, int);
static int update_window (struct window *, int);
static int update_frame_1 (struct frame *, int, int);
static void set_window_cursor_after_update (struct window *);
static int row_equal_p (struct window *, struct glyph_row *,
                        struct glyph_row *, int);
static void adjust_frame_glyphs_for_window_redisplay (struct frame *);
static void adjust_frame_glyphs_for_frame_redisplay (struct frame *);
static void reverse_rows (struct glyph_matrix *, int, int);
static int margin_glyphs_to_reserve (struct window *, int, Lisp_Object);
static void sync_window_with_frame_matrix_rows (struct window *);
struct window *frame_row_to_window (struct window *, int);
Gerd Moellmann's avatar
Gerd Moellmann committed
184 185 186 187 188


/* Non-zero means don't pause redisplay for pending input.  (This is
   for debugging and for a future implementation of EDT-like
   scrolling.  */
Jim Blandy's avatar
Jim Blandy committed
189

Gerd Moellmann's avatar
Gerd Moellmann committed
190
int redisplay_dont_pause;
191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
   are supported, so we can check for input during redisplay at
   regular intervals.  */
#ifdef EMACS_HAS_USECS
#define PERIODIC_PREEMPTION_CHECKING 1
#else
#define PERIODIC_PREEMPTION_CHECKING 0
#endif

#if PERIODIC_PREEMPTION_CHECKING

/* If a number (float), check for user input every N seconds.  */

Lisp_Object Vredisplay_preemption_period;

/* Redisplay preemption timers.  */

static EMACS_TIME preemption_period;
static EMACS_TIME preemption_next_check;

#endif

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

Jim Blandy's avatar
Jim Blandy committed
217
int frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
218

Gerd Moellmann's avatar
Gerd Moellmann committed
219
/* Nonzero means last display completed.  Zero means it was preempted.  */
Jim Blandy's avatar
Jim Blandy committed
220 221 222

int display_completed;

Gerd Moellmann's avatar
Gerd Moellmann committed
223 224
/* Lisp variable visible-bell; enables use of screen-flash instead of
   audible bell.  */
Jim Blandy's avatar
Jim Blandy committed
225 226 227

int visible_bell;

Jim Blandy's avatar
Jim Blandy committed
228
/* Invert the color of the whole frame, at a low level.  */
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232 233

int inverse_video;

/* Line speed of the terminal.  */

234
EMACS_INT baud_rate;
Jim Blandy's avatar
Jim Blandy committed
235

Gerd Moellmann's avatar
Gerd Moellmann committed
236
/* Either nil or a symbol naming the window system under which Emacs
237
   creates the first frame.  */
Jim Blandy's avatar
Jim Blandy committed
238

239
Lisp_Object Vinitial_window_system;
Jim Blandy's avatar
Jim Blandy committed
240 241

/* Version number of X windows: 10, 11 or nil.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
242

Jim Blandy's avatar
Jim Blandy committed
243 244
Lisp_Object Vwindow_system_version;

Gerd Moellmann's avatar
Gerd Moellmann committed
245 246
/* Vector of glyph definitions.  Indexed by glyph number, the contents
   are a string which is how to output the glyph.
Jim Blandy's avatar
Jim Blandy committed
247 248

   If Vglyph_table is nil, a glyph is output by using its low 8 bits
Gerd Moellmann's avatar
Gerd Moellmann committed
249 250 251 252
   as a character code.

   This is an obsolete feature that is no longer used.  The variable
   is retained for compatibility.  */
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257 258 259

Lisp_Object Vglyph_table;

/* Display table to use for vectors that don't specify their own.  */

Lisp_Object Vstandard_display_table;

Gerd Moellmann's avatar
Gerd Moellmann committed
260
/* Nonzero means reading single-character input with prompt so put
261
   cursor on mini-buffer after the prompt.  Positive means at end of
Gerd Moellmann's avatar
Gerd Moellmann committed
262 263
   text in echo area; negative means at beginning of line.  */

Jim Blandy's avatar
Jim Blandy committed
264
int cursor_in_echo_area;
265

266
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
267

Jim Blandy's avatar
Jim Blandy committed
268

Gerd Moellmann's avatar
Gerd Moellmann committed
269
/* The currently selected frame.  In a single-frame version, this
270
   variable always equals the_only_frame.  */
Jim Blandy's avatar
Jim Blandy committed
271

272
Lisp_Object selected_frame;
Jim Blandy's avatar
Jim Blandy committed
273

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

Gerd Moellmann's avatar
Gerd Moellmann committed
279
struct frame *last_nonminibuf_frame;
280

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

Gerd Moellmann's avatar
Gerd Moellmann committed
283
int delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
284

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

Gerd Moellmann's avatar
Gerd Moellmann committed
287
static int glyphs_initialized_initially_p;
Jim Blandy's avatar
Jim Blandy committed
288

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

Gerd Moellmann's avatar
Gerd Moellmann committed
291
struct window *updated_window;
Jim Blandy's avatar
Jim Blandy committed
292

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

Gerd Moellmann's avatar
Gerd Moellmann committed
295 296
struct glyph_row *updated_row;
int updated_area;
Jim Blandy's avatar
Jim Blandy committed
297

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

Gerd Moellmann's avatar
Gerd Moellmann committed
300
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
301

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

Gerd Moellmann's avatar
Gerd Moellmann committed
305 306
int glyph_matrix_count;
int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
307

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

Gerd Moellmann's avatar
Gerd Moellmann committed
311
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
312

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

Gerd Moellmann's avatar
Gerd Moellmann committed
321
int fonts_changed_p;
322

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

Gerd Moellmann's avatar
Gerd Moellmann committed
326
#if GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
327

328 329
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
330 331
#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
332

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
/* 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.  */

static unsigned history_tick;

358 359
static void add_frame_display_history (struct frame *, int);
static void add_window_display_history (struct window *, char *, int);
Richard M. Stallman's avatar
Richard M. Stallman committed
360

361 362
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
363
   has been constructed.  PAUSED_P non-zero means that the update
364 365 366 367 368 369 370 371 372
   has been interrupted for pending input.  */

static void
add_window_display_history (w, msg, paused_p)
     struct window *w;
     char *msg;
     int paused_p;
{
  char *buf;
373

374 375 376 377
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
378

379 380 381 382 383
  sprintf (buf, "%d: window %p (`%s')%s\n",
	   history_tick++,
	   w,
	   ((BUFFERP (w->buffer)
	     && STRINGP (XBUFFER (w->buffer)->name))
384
	    ? (char *) SDATA (XBUFFER (w->buffer)->name)
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
	    : "???"),
	   paused_p ? " ***paused***" : "");
  strcat (buf, msg);
}


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

static void
add_frame_display_history (f, paused_p)
     struct frame *f;
     int paused_p;
{
  char *buf;
401

402 403 404 405
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
406

407 408 409 410 411 412 413 414
  sprintf (buf, "%d: update frame %p%s",
	   history_tick++,
	   f, paused_p ? " ***paused***" : "");
}


DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
       Sdump_redisplay_history, 0, 0, "",
415 416
       doc: /* Dump redisplay history to stderr.  */)
     ()
417 418 419 420 421 422 423 424 425 426 427 428 429 430
{
  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;
}


Gerd Moellmann's avatar
Gerd Moellmann committed
431
#else /* GLYPH_DEBUG == 0 */
Jim Blandy's avatar
Jim Blandy committed
432

433 434
#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
435

Gerd Moellmann's avatar
Gerd Moellmann committed
436
#endif /* GLYPH_DEBUG == 0 */
Jim Blandy's avatar
Jim Blandy committed
437 438


439 440
#ifdef PROFILING
/* FIXME: only used to find text start for profiling.  */
Jim Blandy's avatar
Jim Blandy committed
441 442

void
443
safe_bcopy (const char *from, char *to, int size)
Jim Blandy's avatar
Jim Blandy committed
444
{
445
  abort ();
446
}
447
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
448 449 450 451 452 453 454 455 456 457 458 459

/***********************************************************************
			    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.  */

struct glyph_matrix *
460
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
461
{
Gerd Moellmann's avatar
Gerd Moellmann committed
462 463 464 465
  struct glyph_matrix *result;

  /* Allocate and clear.  */
  result = (struct glyph_matrix *) xmalloc (sizeof *result);
466
  memset (result, 0, sizeof *result);
Jim Blandy's avatar
Jim Blandy committed
467

Gerd Moellmann's avatar
Gerd Moellmann committed
468 469 470
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
Jim Blandy's avatar
Jim Blandy committed
471

Gerd Moellmann's avatar
Gerd Moellmann committed
472 473 474
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
475 476 477
}


Gerd Moellmann's avatar
Gerd Moellmann committed
478 479 480 481 482 483
/* 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.
484

Gerd Moellmann's avatar
Gerd Moellmann committed
485 486 487 488 489
   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
490
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
491
{
Gerd Moellmann's avatar
Gerd Moellmann committed
492 493 494 495 496 497 498 499 500 501 502 503 504
  if (matrix)
    {
      int i;

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

      /* Free glyph memory if MATRIX owns it.  */
      if (matrix->pool == NULL)
	for (i = 0; i < matrix->rows_allocated; ++i)
	  xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
505

Gerd Moellmann's avatar
Gerd Moellmann committed
506 507 508 509 510
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
511 512


Gerd Moellmann's avatar
Gerd Moellmann committed
513 514 515 516 517 518 519
/* 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
520
margin_glyphs_to_reserve (struct window *w, int total_glyphs, Lisp_Object margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
521 522
{
  int n;
Jim Blandy's avatar
Jim Blandy committed
523

Gerd Moellmann's avatar
Gerd Moellmann committed
524
  if (NUMBERP (margin))
Jim Blandy's avatar
Jim Blandy committed
525
    {
526
      int width = XFASTINT (w->total_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
527 528
      double d = max (0, XFLOATINT (margin));
      d = min (width / 2 - 1, d);
529
      n = (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532 533 534 535 536
    }
  else
    n = 0;

  return n;
}

Jim Blandy's avatar
Jim Blandy committed
537

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

Gerd Moellmann's avatar
Gerd Moellmann committed
541 542 543 544 545
   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.
546

Gerd Moellmann's avatar
Gerd Moellmann committed
547 548 549 550
   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.
551

Gerd Moellmann's avatar
Gerd Moellmann committed
552 553 554 555 556 557 558
   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.  */
559

Gerd Moellmann's avatar
Gerd Moellmann committed
560
static void
561
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
562 563 564 565
{
  int i;
  int new_rows;
  int marginal_areas_changed_p = 0;
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
566 567
  int header_line_changed_p = 0;
  int header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
568
  int left = -1, right = -1;
569
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
570

Kenichi Handa's avatar
Kenichi Handa committed
571 572
  /* 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
573 574
  if (w)
    {
Kenichi Handa's avatar
Kenichi Handa committed
575 576
      window_box (w, -1, 0, 0, &window_width, &window_height);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
577 578
      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
579
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
580
  matrix->header_line_p = header_line_p;
581

Kenichi Handa's avatar
Kenichi Handa committed
582 583
  /* 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
584 585 586 587
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
588 589
      left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
      right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
590 591 592 593 594 595
      xassert (left >= 0 && right >= 0);
      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
596
	  && !header_line_changed_p
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_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
604

Gerd Moellmann's avatar
Gerd Moellmann committed
605 606 607 608 609 610
  /* Enlarge MATRIX->rows if necessary.  New rows are cleared.  */
  if (matrix->rows_allocated < dim.height)
    {
      int size = dim.height * sizeof (struct glyph_row);
      new_rows = dim.height - matrix->rows_allocated;
      matrix->rows = (struct glyph_row *) xrealloc (matrix->rows, size);
611 612
      memset (matrix->rows + matrix->rows_allocated, 0,
	      new_rows * sizeof *matrix->rows);
Gerd Moellmann's avatar
Gerd Moellmann committed
613 614 615 616
      matrix->rows_allocated = dim.height;
    }
  else
    new_rows = 0;
617

Gerd Moellmann's avatar
Gerd Moellmann committed
618 619 620 621 622 623
  /* 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)
    {
      xassert (matrix->pool->glyphs);
624

Gerd Moellmann's avatar
Gerd Moellmann committed
625
      if (w)
626
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
627
	  left = margin_glyphs_to_reserve (w, dim.width,
628
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
629
	  right = margin_glyphs_to_reserve (w, dim.width,
630
					    w->right_margin_cols);
631
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
632 633
      else
	left = right = 0;
634

Gerd Moellmann's avatar
Gerd Moellmann committed
635
      for (i = 0; i < dim.height; ++i)
636
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
637
	  struct glyph_row *row = &matrix->rows[i];
638 639

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
640 641 642
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
643

Gerd Moellmann's avatar
Gerd Moellmann committed
644 645
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
646
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
	    {
	      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;
	    }
664
	}
665

Gerd Moellmann's avatar
Gerd Moellmann committed
666 667 668 669 670 671
      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
672 673
	 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
674 675
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
676
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
677
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
678
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
679 680
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
681

Gerd Moellmann's avatar
Gerd Moellmann committed
682 683 684 685 686 687
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
		= (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
					     (dim.width
					      * sizeof (struct glyph)));
688

Gerd Moellmann's avatar
Gerd Moellmann committed
689 690
	      /* The mode line never has marginal areas.  */
	      if (row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
691
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
		{
		  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
711 712
	}

Gerd Moellmann's avatar
Gerd Moellmann committed
713 714 715 716
      xassert (left >= 0 && right >= 0);
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
717

Gerd Moellmann's avatar
Gerd Moellmann committed
718 719
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
720
  xassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
721

722
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
723
    {
724
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
725
	{
726 727 728 729 730 731
	  /* 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);
732

733 734 735 736
	  /* 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
737 738 739
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
740 741
	      && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	      && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
742
	      && matrix->window_width == window_width)
743
	    {
744 745 746 747
	      /* 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)
		  {
748
		    ++i;
749 750
		    break;
		  }
751 752

	      /* Window end is invalid, if inside of the rows that
753
		 are invalidated below.  */
754 755 756
	      if (INTEGERP (w->window_end_vpos)
		  && XFASTINT (w->window_end_vpos) >= i)
		w->window_end_valid = Qnil;
757

758 759 760 761 762 763 764 765
	      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
766
	}
767
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
768
	{
769 770 771 772
	  /* 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
773 774
	  for (i = 0; i < matrix->nrows; ++i)
	    matrix->rows[i].enabled_p = 0;
Jim Blandy's avatar
Jim Blandy committed
775 776
	}
    }
777 778


Gerd Moellmann's avatar
Gerd Moellmann committed
779 780 781 782 783 784 785 786 787
  /* 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
788
    {
789 790
      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
791 792 793 794 795
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
796 797


Gerd Moellmann's avatar
Gerd Moellmann committed
798 799 800 801
/* 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).  */
802

Gerd Moellmann's avatar
Gerd Moellmann committed
803
static void
804
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
805 806
{
  int i, j;
807

Gerd Moellmann's avatar
Gerd Moellmann committed
808 809 810 811 812 813 814 815 816 817
  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;
    }
}
818 819


Gerd Moellmann's avatar
Gerd Moellmann committed
820 821 822 823
/* 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).
824

Gerd Moellmann's avatar
Gerd Moellmann committed
825 826 827 828 829 830 831 832
   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
833
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
{
  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
858
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end, int delta, int delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
859 860 861 862 863 864 865
{
  /* Check that START and END are reasonable values.  */
  xassert (start >= 0 && start <= matrix->nrows);
  xassert (end >= 0 && end <= matrix->nrows);
  xassert (start <= end);

  for (; start < end; ++start)
866
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
867 868 869 870 871 872 873 874
}


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

void
875
enable_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end, int enabled_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
876
{
877 878 879
  xassert (start <= end);
  xassert (start >= 0 && start < matrix->nrows);
  xassert (end >= 0 && end <= matrix->nrows);
880

Gerd Moellmann's avatar
Gerd Moellmann committed
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
  for (; start < end; ++start)
    matrix->rows[start].enabled_p = enabled_p != 0;
}


/* Clear MATRIX.

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

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

void
897
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
898 899 900 901 902 903 904
{
  if (matrix)
    {
      enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
      matrix->no_scrolling_p = 0;
    }
}
905

Gerd Moellmann's avatar
Gerd Moellmann committed
906 907 908 909 910 911

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

Gerd Moellmann's avatar
Gerd Moellmann committed
916 917 918
  xassert (start <= end);
  xassert (start >= 0 && start < matrix->nrows);
  xassert (end >= 0 && end <= matrix->nrows);
919

920 921
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
922

Gerd Moellmann's avatar
Gerd Moellmann committed
923 924 925
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
926

Gerd Moellmann's avatar
Gerd Moellmann committed
927
      row->y += dy;
928
      row->visible_height = row->height;
929

Gerd Moellmann's avatar
Gerd Moellmann committed
930
      if (row->y < min_y)
931 932 933
	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
934 935 936 937 938 939 940 941 942
    }
}


/* 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
943
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
944 945 946 947 948 949 950 951 952 953 954
{
  /* 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.  */
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);

955 956 957
  /* Clear the matrix of the tool-bar window, if any.  */
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
958 959 960 961 962 963 964 965 966 967

  /* Clear current window matrices.  */
  xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
}


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

void
968
clear_desired_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
969 970 971
{
  if (f->desired_matrix)
    clear_glyph_matrix (f->desired_matrix);
972

Gerd Moellmann's avatar
Gerd Moellmann committed
973 974 975
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);

976 977
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
978 979 980 981 982 983 984 985 986 987 988

  /* Do it for window matrices.  */
  xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
  clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
}


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

static void
989
clear_window_matrices (struct window *w, int desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
{
  while (w)
    {
      if (!NILP (w->hchild))
	{
	  xassert (WINDOWP (w->hchild));
	  clear_window_matrices (XWINDOW (w->hchild), desired_p);
	}
      else if (!NILP (w->vchild))
	{
	  xassert (WINDOWP (w->vchild));
	  clear_window_matrices (XWINDOW (w->vchild), desired_p);
	}
      else
	{
	  if (desired_p)
	    clear_glyph_matrix (w->desired_matrix);
	  else
	    {
	      clear_glyph_matrix (w->current_matrix);
	      w->window_end_valid = Qnil;
	    }
	}

      w = NILP (w->next) ? 0 : XWINDOW (w->next);
    }
}


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

1030 1031
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
1032
void
1033
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
{
  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];
1051 1052 1053 1054 1055 1056

#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
1057
	 the code below.  If the flickering is gone with that, chances
1058
	 are that the flickering has the same reason as here.  */
1059
  memset (p[0], 0, (char *) p[LAST_AREA] - (char *) p[0]);
1060
#endif