dispnew.c 194 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Updating of data structures for redisplay.
2
   Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5

This file is part of GNU Emacs.

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

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18

19
#include <config.h>
20
#include <signal.h>
21
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
22
#include <ctype.h>
23
#include <setjmp.h>
Andreas Schwab's avatar
Andreas Schwab committed
24 25
#include <unistd.h>

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

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

Jim Blandy's avatar
Jim Blandy committed
47 48
#ifdef HAVE_X_WINDOWS
#include "xterm.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
49
#endif /* HAVE_X_WINDOWS */
Jim Blandy's avatar
Jim Blandy committed
50

51 52 53 54
#ifdef HAVE_NTGUI
#include "w32term.h"
#endif /* HAVE_NTGUI */

55 56 57 58
#ifdef HAVE_NS
#include "nsterm.h"
#endif

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

Gerd Moellmann's avatar
Gerd Moellmann committed
61
#include "systime.h"
62 63
#include <errno.h>

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

68
#ifdef __GNU_LIBRARY__
Gerd Moellmann's avatar
Gerd Moellmann committed
69 70 71 72 73

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

74 75 76
#ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
#define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
#else
77
#undef	PENDING_OUTPUT_COUNT
78
#define	PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
79 80
#endif
#else /* not __GNU_LIBRARY__ */
81 82 83 84
#if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
#include <stdio_ext.h>
#define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
#endif
85
#ifndef PENDING_OUTPUT_COUNT
Jim Blandy's avatar
Jim Blandy committed
86 87
#define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
88 89
#endif /* not __GNU_LIBRARY__ */

90
#if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
Dave Love's avatar
Dave Love committed
91 92
#include <term.h>		/* for tgetent */
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
93 94 95 96 97 98 99 100 101 102 103 104 105

/* Structure to pass dimensions around.  Used for character bounding
   boxes, glyph matrix dimensions and alike.  */

struct dim
{
  int width;
  int height;
};


/* Function prototypes.  */

106 107 108 109 110 111 112 113 114 115 116
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
117
static struct dim allocate_matrices_for_frame_redisplay
118
     (Lisp_Object, int, int, int, int *);
Andreas Schwab's avatar
Andreas Schwab committed
119 120
static int required_matrix_height (struct window *);
static int required_matrix_width (struct window *);
121 122 123 124 125 126 127 128 129
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 *);
130
#if GLYPH_DEBUG
131
static int glyph_row_slice_p (struct glyph_row *, struct glyph_row *);
132
#endif
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
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 *);
158
#if GLYPH_DEBUG
159 160
static void check_matrix_pointers (struct glyph_matrix *,
                                   struct glyph_matrix *);
161
#endif
162 163 164 165 166 167 168
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 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
169 170


171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/* 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

/* Redisplay preemption timers.  */

static EMACS_TIME preemption_period;
static EMACS_TIME preemption_next_check;

#endif

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

Jim Blandy's avatar
Jim Blandy committed
192
int frame_garbaged;
Jim Blandy's avatar
Jim Blandy committed
193

Gerd Moellmann's avatar
Gerd Moellmann committed
194
/* Nonzero means last display completed.  Zero means it was preempted.  */
Jim Blandy's avatar
Jim Blandy committed
195 196 197

int display_completed;

198
Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
Gerd Moellmann's avatar
Gerd Moellmann committed
199

Jim Blandy's avatar
Jim Blandy committed
200

Gerd Moellmann's avatar
Gerd Moellmann committed
201
/* The currently selected frame.  In a single-frame version, this
202
   variable always equals the_only_frame.  */
Jim Blandy's avatar
Jim Blandy committed
203

204
Lisp_Object selected_frame;
Jim Blandy's avatar
Jim Blandy committed
205

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

Gerd Moellmann's avatar
Gerd Moellmann committed
211
struct frame *last_nonminibuf_frame;
212

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

Gerd Moellmann's avatar
Gerd Moellmann committed
215
int delayed_size_change;
Jim Blandy's avatar
Jim Blandy committed
216

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

Gerd Moellmann's avatar
Gerd Moellmann committed
219
static int glyphs_initialized_initially_p;
Jim Blandy's avatar
Jim Blandy committed
220

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

Gerd Moellmann's avatar
Gerd Moellmann committed
223
struct window *updated_window;
Jim Blandy's avatar
Jim Blandy committed
224

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

Gerd Moellmann's avatar
Gerd Moellmann committed
227 228
struct glyph_row *updated_row;
int updated_area;
Jim Blandy's avatar
Jim Blandy committed
229

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

Gerd Moellmann's avatar
Gerd Moellmann committed
232
struct glyph space_glyph;
Jim Blandy's avatar
Jim Blandy committed
233

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

Gerd Moellmann's avatar
Gerd Moellmann committed
237 238
int glyph_matrix_count;
int glyph_pool_count;
Jim Blandy's avatar
Jim Blandy committed
239

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

Gerd Moellmann's avatar
Gerd Moellmann committed
243
static struct frame *frame_matrix_frame;
Jim Blandy's avatar
Jim Blandy committed
244

Gerd Moellmann's avatar
Gerd Moellmann committed
245 246 247 248
/* 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
249 250 251
   loaded on demand.  Another reason is that a line contains many
   characters displayed by zero width or very narrow glyphs of
   variable-width fonts.  */
252

Gerd Moellmann's avatar
Gerd Moellmann committed
253
int fonts_changed_p;
254

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

Gerd Moellmann's avatar
Gerd Moellmann committed
258
#if GLYPH_DEBUG
Jim Blandy's avatar
Jim Blandy committed
259

260 261
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
262 263
#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
264

265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
/* 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;

290 291
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
292

293 294
/* Add to the redisplay history how window W has been displayed.
   MSG is a trace containing the information how W's glyph matrix
295
   has been constructed.  PAUSED_P non-zero means that the update
296 297 298
   has been interrupted for pending input.  */

static void
Andreas Schwab's avatar
Andreas Schwab committed
299
add_window_display_history (struct window *w, char *msg, int paused_p)
300 301
{
  char *buf;
302

303 304 305 306
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
307

308 309 310 311 312
  sprintf (buf, "%d: window %p (`%s')%s\n",
	   history_tick++,
	   w,
	   ((BUFFERP (w->buffer)
	     && STRINGP (XBUFFER (w->buffer)->name))
313
	    ? SSDATA (XBUFFER (w->buffer)->name)
314 315 316 317 318 319 320 321 322 323 324
	    : "???"),
	   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
Andreas Schwab's avatar
Andreas Schwab committed
325
add_frame_display_history (struct frame *f, int paused_p)
326 327
{
  char *buf;
328

329 330 331 332
  if (history_idx >= REDISPLAY_HISTORY_SIZE)
    history_idx = 0;
  buf = redisplay_history[history_idx].trace;
  ++history_idx;
333

334 335 336 337 338 339
  sprintf (buf, "%d: update frame %p%s",
	   history_tick++,
	   f, paused_p ? " ***paused***" : "");
}


340
DEFUE ("dump-redisplay-history", Fdump_redisplay_history,
341
       Sdump_redisplay_history, 0, 0, "",
342
       doc: /* Dump redisplay history to stderr.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
343
  (void)
344 345 346 347 348 349 350 351 352 353 354 355 356 357
{
  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
358
#else /* GLYPH_DEBUG == 0 */
Jim Blandy's avatar
Jim Blandy committed
359

360 361
#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
362

Gerd Moellmann's avatar
Gerd Moellmann committed
363
#endif /* GLYPH_DEBUG == 0 */
Jim Blandy's avatar
Jim Blandy committed
364 365


366
#if defined PROFILING && !HAVE___EXECUTABLE_START
367
/* FIXME: only used to find text start for profiling.  */
Jim Blandy's avatar
Jim Blandy committed
368 369

void
370
safe_bcopy (const char *from, char *to, int size)
Jim Blandy's avatar
Jim Blandy committed
371
{
372
  abort ();
373
}
374
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
375 376 377 378 379 380 381 382 383 384 385 386

/***********************************************************************
			    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 *
387
new_glyph_matrix (struct glyph_pool *pool)
Jim Blandy's avatar
Jim Blandy committed
388
{
Gerd Moellmann's avatar
Gerd Moellmann committed
389 390 391 392
  struct glyph_matrix *result;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397
  /* Increment number of allocated matrices.  This count is used
     to detect memory leaks.  */
  ++glyph_matrix_count;
Jim Blandy's avatar
Jim Blandy committed
398

Gerd Moellmann's avatar
Gerd Moellmann committed
399 400 401
  /* Set pool and return.  */
  result->pool = pool;
  return result;
Jim Blandy's avatar
Jim Blandy committed
402 403 404
}


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

Gerd Moellmann's avatar
Gerd Moellmann committed
412 413 414 415 416
   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
417
free_glyph_matrix (struct glyph_matrix *matrix)
Jim Blandy's avatar
Jim Blandy committed
418
{
Gerd Moellmann's avatar
Gerd Moellmann committed
419 420 421 422 423 424 425 426 427 428 429 430 431
  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]);
432

Gerd Moellmann's avatar
Gerd Moellmann committed
433 434 435 436 437
      /* Free row structures and the matrix itself.  */
      xfree (matrix->rows);
      xfree (matrix);
    }
}
Jim Blandy's avatar
Jim Blandy committed
438 439


Gerd Moellmann's avatar
Gerd Moellmann committed
440 441 442 443 444 445 446
/* 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
447
margin_glyphs_to_reserve (struct window *w, int total_glyphs, Lisp_Object margin)
Gerd Moellmann's avatar
Gerd Moellmann committed
448 449
{
  int n;
Jim Blandy's avatar
Jim Blandy committed
450

Gerd Moellmann's avatar
Gerd Moellmann committed
451
  if (NUMBERP (margin))
Jim Blandy's avatar
Jim Blandy committed
452
    {
453
      int width = XFASTINT (w->total_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
454 455
      double d = max (0, XFLOATINT (margin));
      d = min (width / 2 - 1, d);
456
      n = (int) ((double) total_glyphs / width * d);
Gerd Moellmann's avatar
Gerd Moellmann committed
457 458 459 460 461 462 463
    }
  else
    n = 0;

  return n;
}

Jim Blandy's avatar
Jim Blandy committed
464

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

Gerd Moellmann's avatar
Gerd Moellmann committed
468 469 470 471 472
   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.
473

Gerd Moellmann's avatar
Gerd Moellmann committed
474 475 476 477
   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.
478

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

Gerd Moellmann's avatar
Gerd Moellmann committed
487
static void
488
adjust_glyph_matrix (struct window *w, struct glyph_matrix *matrix, int x, int y, struct dim dim)
Gerd Moellmann's avatar
Gerd Moellmann committed
489 490 491 492
{
  int i;
  int new_rows;
  int marginal_areas_changed_p = 0;
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
493 494
  int header_line_changed_p = 0;
  int header_line_p = 0;
Gerd Moellmann's avatar
Gerd Moellmann committed
495
  int left = -1, right = -1;
496
  int window_width = -1, window_height = -1;
Gerd Moellmann's avatar
Gerd Moellmann committed
497

Kenichi Handa's avatar
Kenichi Handa committed
498 499
  /* 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
500 501
  if (w)
    {
Kenichi Handa's avatar
Kenichi Handa committed
502 503
      window_box (w, -1, 0, 0, &window_width, &window_height);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
504 505
      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
506
    }
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
507
  matrix->header_line_p = header_line_p;
508

Kenichi Handa's avatar
Kenichi Handa committed
509 510
  /* 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
511 512 513 514
     haven't changed.  This optimization is important because preserving
     the matrix means preventing redisplay.  */
  if (matrix->pool == NULL)
    {
515 516
      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
517 518 519 520 521 522
      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
523
	  && !header_line_changed_p
524 525
	  && 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
526 527 528 529 530
	  && matrix->window_height == window_height
	  && matrix->window_vscroll == w->vscroll
	  && matrix->window_width == window_width)
	return;
    }
531

Gerd Moellmann's avatar
Gerd Moellmann committed
532 533 534 535 536 537
  /* 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);
538 539
      memset (matrix->rows + matrix->rows_allocated, 0,
	      new_rows * sizeof *matrix->rows);
Gerd Moellmann's avatar
Gerd Moellmann committed
540 541 542 543
      matrix->rows_allocated = dim.height;
    }
  else
    new_rows = 0;
544

Gerd Moellmann's avatar
Gerd Moellmann committed
545 546 547 548 549 550
  /* 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);
551

Gerd Moellmann's avatar
Gerd Moellmann committed
552
      if (w)
553
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
554
	  left = margin_glyphs_to_reserve (w, dim.width,
555
					   w->left_margin_cols);
Gerd Moellmann's avatar
Gerd Moellmann committed
556
	  right = margin_glyphs_to_reserve (w, dim.width,
557
					    w->right_margin_cols);
558
	}
Gerd Moellmann's avatar
Gerd Moellmann committed
559 560
      else
	left = right = 0;
561

Gerd Moellmann's avatar
Gerd Moellmann committed
562
      for (i = 0; i < dim.height; ++i)
563
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
564
	  struct glyph_row *row = &matrix->rows[i];
565 566

	  row->glyphs[LEFT_MARGIN_AREA]
Gerd Moellmann's avatar
Gerd Moellmann committed
567 568 569
	    = (matrix->pool->glyphs
	       + (y + i) * matrix->pool->ncolumns
	       + x);
570

Gerd Moellmann's avatar
Gerd Moellmann committed
571 572
	  if (w == NULL
	      || row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
573
	      || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
	    {
	      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;
	    }
591
	}
592

Gerd Moellmann's avatar
Gerd Moellmann committed
593 594 595 596 597 598
      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
599 600
	 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
601 602
      if (dim.width > matrix->matrix_w
	  || new_rows
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
603
	  || header_line_changed_p
Gerd Moellmann's avatar
Gerd Moellmann committed
604
	  || marginal_areas_changed_p)
Jim Blandy's avatar
Jim Blandy committed
605
	{
Gerd Moellmann's avatar
Gerd Moellmann committed
606 607
	  struct glyph_row *row = matrix->rows;
	  struct glyph_row *end = row + matrix->rows_allocated;
608

Gerd Moellmann's avatar
Gerd Moellmann committed
609 610 611 612 613 614
	  while (row < end)
	    {
	      row->glyphs[LEFT_MARGIN_AREA]
		= (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
					     (dim.width
					      * sizeof (struct glyph)));
615

Gerd Moellmann's avatar
Gerd Moellmann committed
616 617
	      /* The mode line never has marginal areas.  */
	      if (row == matrix->rows + dim.height - 1
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
618
		  || (row == matrix->rows && matrix->header_line_p))
Gerd Moellmann's avatar
Gerd Moellmann committed
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
		{
		  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
638 639
	}

Gerd Moellmann's avatar
Gerd Moellmann committed
640 641 642 643
      xassert (left >= 0 && right >= 0);
      matrix->left_margin_glyphs = left;
      matrix->right_margin_glyphs = right;
    }
644

Gerd Moellmann's avatar
Gerd Moellmann committed
645 646
  /* Number of rows to be used by MATRIX.  */
  matrix->nrows = dim.height;
647
  xassert (matrix->nrows >= 0);
Gerd Moellmann's avatar
Gerd Moellmann committed
648

649
  if (w)
Gerd Moellmann's avatar
Gerd Moellmann committed
650
    {
651
      if (matrix == w->current_matrix)
Jim Blandy's avatar
Jim Blandy committed
652
	{
653 654 655 656 657 658
	  /* 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);
659

660 661 662 663
	  /* 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
664 665 666
	      && !header_line_changed_p
	      && new_rows == 0
	      && dim.width == matrix->matrix_w
667 668
	      && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
	      && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
669
	      && matrix->window_width == window_width)
670
	    {
671 672 673 674
	      /* 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)
		  {
675
		    ++i;
676 677
		    break;
		  }
678 679

	      /* Window end is invalid, if inside of the rows that
680
		 are invalidated below.  */
681 682 683
	      if (INTEGERP (w->window_end_vpos)
		  && XFASTINT (w->window_end_vpos) >= i)
		w->window_end_valid = Qnil;
684

685 686 687 688 689 690 691 692
	      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
693
	}
694
      else if (matrix == w->desired_matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
695
	{
696 697 698 699
	  /* 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
700 701
	  for (i = 0; i < matrix->nrows; ++i)
	    matrix->rows[i].enabled_p = 0;
Jim Blandy's avatar
Jim Blandy committed
702 703
	}
    }
704 705


Gerd Moellmann's avatar
Gerd Moellmann committed
706 707 708 709 710 711 712 713 714
  /* 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
715
    {
716 717
      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
718 719 720 721 722
      matrix->window_height = window_height;
      matrix->window_width = window_width;
      matrix->window_vscroll = w->vscroll;
    }
}
Jim Blandy's avatar
Jim Blandy committed
723 724


Gerd Moellmann's avatar
Gerd Moellmann committed
725 726 727 728
/* 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).  */
729

Gerd Moellmann's avatar
Gerd Moellmann committed
730
static void
731
reverse_rows (struct glyph_matrix *matrix, int start, int end)
Gerd Moellmann's avatar
Gerd Moellmann committed
732 733
{
  int i, j;
734

Gerd Moellmann's avatar
Gerd Moellmann committed
735 736 737 738 739 740 741 742 743 744
  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;
    }
}
745 746


Gerd Moellmann's avatar
Gerd Moellmann committed
747 748 749 750
/* 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).
751

Gerd Moellmann's avatar
Gerd Moellmann committed
752 753 754 755 756 757 758 759
   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
760
rotate_matrix (struct glyph_matrix *matrix, int first, int last, int by)
Gerd Moellmann's avatar
Gerd Moellmann committed
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
{
  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
785 786
increment_matrix_positions (struct glyph_matrix *matrix, int start, int end,
			    EMACS_INT delta, EMACS_INT delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
787 788 789 790 791 792 793
{
  /* 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)
794
    increment_row_positions (matrix->rows + start, delta, delta_bytes);
Gerd Moellmann's avatar
Gerd Moellmann committed
795 796 797 798 799 800 801 802
}


/* 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
803
enable_glyph_matrix_rows (struct glyph_matrix *matrix, int start, int end, int enabled_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
804
{
805 806 807
  xassert (start <= end);
  xassert (start >= 0 && start < matrix->nrows);
  xassert (end >= 0 && end <= matrix->nrows);
808

Gerd Moellmann's avatar
Gerd Moellmann committed
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
  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
825
clear_glyph_matrix (struct glyph_matrix *matrix)
Gerd Moellmann's avatar
Gerd Moellmann committed
826 827 828 829 830 831 832
{
  if (matrix)
    {
      enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
      matrix->no_scrolling_p = 0;
    }
}
833

Gerd Moellmann's avatar
Gerd Moellmann committed
834 835 836 837 838 839

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

Gerd Moellmann's avatar
Gerd Moellmann committed
844 845 846
  xassert (start <= end);
  xassert (start >= 0 && start < matrix->nrows);
  xassert (end >= 0 && end <= matrix->nrows);
847

848 849
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
850

Gerd Moellmann's avatar
Gerd Moellmann committed
851 852 853
  for (; start < end; ++start)
    {
      struct glyph_row *row = &matrix->rows[start];
854

Gerd Moellmann's avatar
Gerd Moellmann committed
855
      row->y += dy;
856
      row->visible_height = row->height;
857

Gerd Moellmann's avatar
Gerd Moellmann committed
858
      if (row->y < min_y)
859 860 861
	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
862 863 864 865 866 867 868 869 870
    }
}


/* 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
871
clear_current_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
872 873 874 875 876 877 878 879 880 881 882
{
  /* 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);

883 884 885
  /* 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
886 887 888 889 890 891 892 893 894 895

  /* 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
896
clear_desired_matrices (register struct frame *f)
Gerd Moellmann's avatar
Gerd Moellmann committed
897 898 899
{
  if (f->desired_matrix)
    clear_glyph_matrix (f->desired_matrix);
900

Gerd Moellmann's avatar
Gerd Moellmann committed
901 902 903
  if (WINDOWP (f->menu_bar_window))
    clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);

904 905
  if (WINDOWP (f->tool_bar_window))
    clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
Gerd Moellmann's avatar
Gerd Moellmann committed
906 907 908 909 910 911 912 913 914 915 916

  /* 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
917
clear_window_matrices (struct window *w, int desired_p)
Gerd Moellmann's avatar
Gerd Moellmann committed
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
{
  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.  */

958 959
static struct glyph_row null_row;

Gerd Moellmann's avatar
Gerd Moellmann committed
960
void
961
clear_glyph_row (struct glyph_row *row)
Gerd Moellmann's avatar
Gerd Moellmann committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
{
  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];
979 980 981 982 983 984

#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
985
	 the code below.  If the flickering is gone with that, chances
986
	 are that the flickering has the same reason as here.  */
987
  memset (p[0], 0, (char *) p[LAST_AREA] - (char *) p[0]);
988
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
989 990 991 992 993 994 995
}


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

void
996
blank_row (struct window *w, struct glyph_row *row, int y)
Gerd Moellmann's avatar
Gerd Moellmann committed
997 998
{
  int min_y, max_y;
999

1000 1001
  min_y = WINDOW_HEADER_LINE_HEIGHT (w);
  max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1002

Gerd Moellmann's avatar
Gerd Moellmann committed
1003 1004
  clear_glyph_row (row);
  row->y = y;
1005
  row->ascent = row->phys_ascent = 0;
1006
  row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
1007
  row->visible_height = row->height;
1008

Gerd Moellmann's avatar
Gerd Moellmann committed
1009
  if (row->y < min_y)
1010 1011 1012
    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
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024

  row->enabled_p = 1;
}


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

void
1025 1026
increment_row_positions (struct glyph_row *row,
			 EMACS_INT delta, EMACS_INT delta_bytes)
Gerd Moellmann's avatar
Gerd Moellmann committed
1027 1028 1029 1030 1031 1032 1033 1034
{
  int area, i;

  /* Increment start and end positions.  */
  MATRIX_ROW_START_CHARPOS (row) += delta;
  MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
  MATRIX_ROW_END_CHARPOS (row) += delta;
  MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
1035 1036 1037 1038
  CHARPOS (row->start.pos) += delta;
  BYTEPOS (row->start.pos) += delta_bytes;
  CHARPOS (row->end.pos) += delta;
  BYTEPOS (row->end.pos) += delta_bytes;
Gerd Moellmann's avatar
Gerd Moellmann committed
1039

1040 1041 1042
  if (!row->enabled_p)
    return;

Gerd Moellmann's avatar
Gerd Moellmann committed
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  /* Increment positions in glyphs.  */
  for (area = 0; area < LAST_AREA; ++area)
    for (i = 0; i < row->used[area]; ++i)
      if (BUFFERP (row->glyphs[area][i].object)
	  && row->glyphs[area][i].charpos > 0)
	row->glyphs[area][i].charpos += delta;

  /* Capture the case of rows displaying a line end.  */
  if (row->used[TEXT_AREA] == 0
      && MATRIX_ROW_DISPLAYS_TEXT_P (row))
    row->glyphs[TEXT_AREA]->charpos += delta;
}


1057
#if 0
Gerd Moellmann's avatar
Gerd Moellmann committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
/* Swap glyphs between two glyph rows A and B.  This exchanges glyph
   contents, i.e. glyph structure contents are exchanged between A and
   B without changing glyph pointers in A and B.  */

static void
swap_glyphs_in_rows (a, b)
     struct glyph_row *a, *b;
{
  int area;

  for (area = 0; area < LAST_AREA; ++area)
    {
      /* Number of glyphs to swap.  */
      int max_used = max (a->used[area], b->used[area]);

      /* Start of glyphs in area of row A.  */
      struct glyph *glyph_a = a->glyphs[area];

      /* End + 1 of glyphs in area of row A.  */
      struct glyph *glyph_a_end = a->glyphs[max_used];

      /* Start of glyphs in area of row B.  */
      struct glyph *glyph_b = b->glyphs[area];

      while (glyph_a < glyph_a_end)
	{
	  /* Non-ISO HP/UX compiler doesn't like auto struct
             initialization.  */
	  struct glyph temp;
	  temp = *glyph_a;
	  *glyph_a = *glyph_b;
	  *glyph_b = temp;
	  ++glyph_a;
	  ++glyph_b;
	}
    }
}

1096
#endif /* 0 */
Gerd Moellmann's avatar
Gerd Moellmann committed
1097 1098 1099 1100

/* Exchange pointers to glyph memory between glyph rows A and B.  */

static INLINE void
1101
swap_glyph_pointers (struct glyph_row *a, struct glyph_row *b)
Gerd Moellmann's avatar
Gerd Moellmann committed
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
{
  int i;
  for (i = 0; i < LAST_AREA + 1; ++i)
    {
      struct glyph *temp = a->glyphs[i];
      a->glyphs[i] = b->glyphs[i];
      b->glyphs[i] = temp;
    }
}


/* Copy glyph row structure FROM to glyph row structure TO, except
   that glyph pointers in the structures are left unchanged.  */

1116
static INLINE void
1117
copy_row_except_pointers (struct glyph_row *to, struct glyph_row *from)
Gerd Moellmann's avatar
Gerd Moellmann committed
1118 1119 1120 1121
{
  struct glyph *pointers[1 + LAST_AREA];

  /* Save glyph pointers of TO.  */
1122
  memcpy (pointers, to->glyphs, sizeof to->glyphs);
Gerd Moellmann's avatar
Gerd Moellmann committed
1123 1124 1125 1126 1127

  /* Do a structure assignment.  */
  *to = *from;

  /* Restore original pointers of TO.  */
1128
  memcpy (to->glyphs, pointers, sizeof to->glyphs);
Gerd Moellmann's avatar
Gerd Moellmann committed
1129 1130 1131 1132 1133 1134 1135 1136 1137
}


/* Assign glyph row FROM to glyph row TO.  This works like a structure
   assignment TO = FROM, except that glyph pointers are not copied but
   exchanged between TO and FROM.  Pointers must be exchanged to avoid
   a memory leak.  */

static INLINE void
1138
assign_row (struct glyph_row *to, struct glyph_row *from)
Gerd Moellmann's avatar
Gerd Moellmann committed
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
{
  swap_glyph_pointers (to, from);
  copy_row_except_pointers (to, from);
}


/* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
   a row in a window matrix, is a slice of the glyph memory of the
   glyph row FRAME_ROW which is a row in a frame glyph matrix.  Value
   is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
   memory of FRAME_ROW.  */

1151
#if GLYPH_DEBUG
1152

Gerd Moellmann's avatar
Gerd Moellmann committed
1153
static int
Andreas Schwab's avatar
Andreas Schwab committed
1154
glyph_row_slice_p (struct glyph_row *window_row, struct glyph_row *frame_row)
Gerd Moellmann's avatar
Gerd Moellmann committed
1155 1156 1157 1158 1159 1160 1161 1162 1163
{
  struct glyph *window_glyph_start = window_row->glyphs[0];
  struct glyph *frame_glyph_start = frame_row->glyphs[0];
  struct glyph *frame_glyph_end = frame_row->glyphs[LAST_AREA];

  return (frame_glyph_start <= window_glyph_start
	  && window_glyph_start < frame_glyph_end);
}

1164
#endif /* GLYPH_DEBUG */
Gerd Moellmann's avatar
Gerd Moellmann committed
1165

1166 1167
#if 0

Gerd Moellmann's avatar
Gerd Moellmann committed
1168 1169 1170 1171 1172
/* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
   of ROW in the frame matrix FRAME_MATRIX.  Value is null if no row
   in WINDOW_MATRIX is found satisfying the condition.  */

static struct glyph_row *
Andreas Schwab's avatar
Andreas Schwab committed
1173 1174
find_glyph_row_slice (struct glyph_matrix *window_matrix,
		      struct glyph_matrix *frame_matrix, int row)
Gerd Moellmann's avatar
Gerd Moellmann committed
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
{
  int i;

  xassert (row >= 0 && row < frame_matrix->nrows);

  for (i = 0; i < window_matrix->nrows; ++i)
    if (glyph_row_slice_p (window_matrix->rows + i,
			   frame_matrix->rows + row))
      break;

  return i < window_matrix->nrows ? window_matrix->rows + i : 0;
}

1188
#endif /* 0 */