(mm-inline-media-tests): Add
[emacs.git] / src / dispnew.c
blob2e9b91754fb0e27b731d727a72901a561e1a640c
1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985, 86, 87, 88, 93, 94, 95, 97, 98, 1999, 2000
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <ctype.h>
27 #ifdef HAVE_UNISTD_H
28 #include <unistd.h>
29 #endif
31 #include "lisp.h"
32 #include "termchar.h"
33 #include "termopts.h"
34 #include "termhooks.h"
35 /* cm.h must come after dispextern.h on Windows. */
36 #include "dispextern.h"
37 #include "cm.h"
38 #include "buffer.h"
39 #include "charset.h"
40 #include "keyboard.h"
41 #include "frame.h"
42 #include "window.h"
43 #include "commands.h"
44 #include "disptab.h"
45 #include "indent.h"
46 #include "intervals.h"
47 #include "blockinput.h"
48 #include "process.h"
50 /* I don't know why DEC Alpha OSF1 fail to compile this file if we
51 include the following file. */
52 /* #include "systty.h" */
53 #include "syssignal.h"
55 #ifdef HAVE_X_WINDOWS
56 #include "xterm.h"
57 #endif /* HAVE_X_WINDOWS */
59 #ifdef HAVE_NTGUI
60 #include "w32term.h"
61 #endif /* HAVE_NTGUI */
63 #ifdef macintosh
64 #include "macterm.h"
65 #endif /* macintosh */
67 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
69 #include "systime.h"
70 #include <errno.h>
72 /* To get the prototype for `sleep'. */
74 #ifdef HAVE_UNISTD_H
75 #include <unistd.h>
76 #endif
78 #define max(a, b) ((a) > (b) ? (a) : (b))
79 #define min(a, b) ((a) < (b) ? (a) : (b))
81 /* Get number of chars of output now in the buffer of a stdio stream.
82 This ought to be built in in stdio, but it isn't. Some s- files
83 override this because their stdio internals differ. */
85 #ifdef __GNU_LIBRARY__
87 /* The s- file might have overridden the definition with one that
88 works for the system's C library. But we are using the GNU C
89 library, so this is the right definition for every system. */
91 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
92 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
93 #else
94 #undef PENDING_OUTPUT_COUNT
95 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
96 #endif
97 #else /* not __GNU_LIBRARY__ */
98 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
99 #include <stdio_ext.h>
100 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
101 #endif
102 #ifndef PENDING_OUTPUT_COUNT
103 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
104 #endif
105 #endif /* not __GNU_LIBRARY__ */
107 #if defined (LINUX) && defined (HAVE_LIBNCURSES)
108 #include <term.h> /* for tgetent */
109 #endif
111 /* Structure to pass dimensions around. Used for character bounding
112 boxes, glyph matrix dimensions and alike. */
114 struct dim
116 int width;
117 int height;
121 /* Function prototypes. */
123 static void save_or_restore_current_matrix P_ ((struct frame *, int));
124 static void fake_current_matrices P_ ((Lisp_Object));
125 static void redraw_overlapping_rows P_ ((struct window *, int));
126 static void redraw_overlapped_rows P_ ((struct window *, int));
127 static int count_blanks P_ ((struct glyph *, int));
128 static int count_match P_ ((struct glyph *, struct glyph *,
129 struct glyph *, struct glyph *));
130 static unsigned line_draw_cost P_ ((struct glyph_matrix *, int));
131 static void update_frame_line P_ ((struct frame *, int));
132 static struct dim allocate_matrices_for_frame_redisplay
133 P_ ((Lisp_Object, int, int, struct dim, int, int *));
134 static void allocate_matrices_for_window_redisplay P_ ((struct window *,
135 struct dim));
136 static int realloc_glyph_pool P_ ((struct glyph_pool *, struct dim));
137 static void adjust_frame_glyphs P_ ((struct frame *));
138 struct glyph_matrix *new_glyph_matrix P_ ((struct glyph_pool *));
139 static void free_glyph_matrix P_ ((struct glyph_matrix *));
140 static void adjust_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
141 int, int, struct dim));
142 static void change_frame_size_1 P_ ((struct frame *, int, int, int, int, int));
143 static void swap_glyph_pointers P_ ((struct glyph_row *, struct glyph_row *));
144 #if GLYPH_DEBUG
145 static int glyph_row_slice_p P_ ((struct glyph_row *, struct glyph_row *));
146 #endif
147 static void fill_up_frame_row_with_spaces P_ ((struct glyph_row *, int));
148 static void build_frame_matrix_from_window_tree P_ ((struct glyph_matrix *,
149 struct window *));
150 static void build_frame_matrix_from_leaf_window P_ ((struct glyph_matrix *,
151 struct window *));
152 static struct glyph_pool *new_glyph_pool P_ ((void));
153 static void free_glyph_pool P_ ((struct glyph_pool *));
154 static void adjust_frame_glyphs_initially P_ ((void));
155 static void adjust_frame_message_buffer P_ ((struct frame *));
156 static void adjust_decode_mode_spec_buffer P_ ((struct frame *));
157 static void fill_up_glyph_row_with_spaces P_ ((struct glyph_row *));
158 static void build_frame_matrix P_ ((struct frame *));
159 void clear_current_matrices P_ ((struct frame *));
160 void scroll_glyph_matrix_range P_ ((struct glyph_matrix *, int, int,
161 int, int));
162 static void clear_window_matrices P_ ((struct window *, int));
163 static void fill_up_glyph_row_area_with_spaces P_ ((struct glyph_row *, int));
164 static int scrolling_window P_ ((struct window *, int));
165 static int update_window_line P_ ((struct window *, int, int *));
166 static void update_marginal_area P_ ((struct window *, int, int));
167 static int update_text_area P_ ((struct window *, int));
168 static void make_current P_ ((struct glyph_matrix *, struct glyph_matrix *,
169 int));
170 static void mirror_make_current P_ ((struct window *, int));
171 void check_window_matrix_pointers P_ ((struct window *));
172 #if GLYPH_DEBUG
173 static void check_matrix_pointers P_ ((struct glyph_matrix *,
174 struct glyph_matrix *));
175 #endif
176 static void mirror_line_dance P_ ((struct window *, int, int, int *, char *));
177 static int update_window_tree P_ ((struct window *, int));
178 static int update_window P_ ((struct window *, int));
179 static int update_frame_1 P_ ((struct frame *, int, int));
180 static void set_window_cursor_after_update P_ ((struct window *));
181 static int row_equal_p P_ ((struct window *, struct glyph_row *,
182 struct glyph_row *, int));
183 static void adjust_frame_glyphs_for_window_redisplay P_ ((struct frame *));
184 static void adjust_frame_glyphs_for_frame_redisplay P_ ((struct frame *));
185 static void reverse_rows P_ ((struct glyph_matrix *, int, int));
186 static int margin_glyphs_to_reserve P_ ((struct window *, int, Lisp_Object));
187 static void sync_window_with_frame_matrix_rows P_ ((struct window *));
188 struct window *frame_row_to_window P_ ((struct window *, int));
191 /* Non-zero means don't pause redisplay for pending input. (This is
192 for debugging and for a future implementation of EDT-like
193 scrolling. */
195 int redisplay_dont_pause;
197 /* Nonzero upon entry to redisplay means do not assume anything about
198 current contents of actual terminal frame; clear and redraw it. */
200 int frame_garbaged;
202 /* Nonzero means last display completed. Zero means it was preempted. */
204 int display_completed;
206 /* Lisp variable visible-bell; enables use of screen-flash instead of
207 audible bell. */
209 int visible_bell;
211 /* Invert the color of the whole frame, at a low level. */
213 int inverse_video;
215 /* Line speed of the terminal. */
217 int baud_rate;
219 /* Either nil or a symbol naming the window system under which Emacs
220 is running. */
222 Lisp_Object Vwindow_system;
224 /* Version number of X windows: 10, 11 or nil. */
226 Lisp_Object Vwindow_system_version;
228 /* Vector of glyph definitions. Indexed by glyph number, the contents
229 are a string which is how to output the glyph.
231 If Vglyph_table is nil, a glyph is output by using its low 8 bits
232 as a character code.
234 This is an obsolete feature that is no longer used. The variable
235 is retained for compatibility. */
237 Lisp_Object Vglyph_table;
239 /* Display table to use for vectors that don't specify their own. */
241 Lisp_Object Vstandard_display_table;
243 /* Nonzero means reading single-character input with prompt so put
244 cursor on mini-buffer after the prompt. positive means at end of
245 text in echo area; negative means at beginning of line. */
247 int cursor_in_echo_area;
249 Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
252 /* The currently selected frame. In a single-frame version, this
253 variable always equals the_only_frame. */
255 Lisp_Object selected_frame;
257 /* A frame which is not just a mini-buffer, or 0 if there are no such
258 frames. This is usually the most recent such frame that was
259 selected. In a single-frame version, this variable always holds
260 the address of the_only_frame. */
262 struct frame *last_nonminibuf_frame;
264 /* Stdio stream being used for copy of all output. */
266 FILE *termscript;
268 /* Structure for info on cursor positioning. */
270 struct cm Wcm;
272 /* 1 means SIGWINCH happened when not safe. */
274 int delayed_size_change;
276 /* 1 means glyph initialization has been completed at startup. */
278 static int glyphs_initialized_initially_p;
280 /* Updated window if != 0. Set by update_window. */
282 struct window *updated_window;
284 /* Glyph row updated in update_window_line, and area that is updated. */
286 struct glyph_row *updated_row;
287 int updated_area;
289 /* A glyph for a space. */
291 struct glyph space_glyph;
293 /* Non-zero means update has been performed directly, so that there's
294 no need for redisplay_internal to do much work. Set by
295 direct_output_for_insert. */
297 int redisplay_performed_directly_p;
299 /* Counts of allocated structures. These counts serve to diagnose
300 memory leaks and double frees. */
302 int glyph_matrix_count;
303 int glyph_pool_count;
305 /* If non-null, the frame whose frame matrices are manipulated. If
306 null, window matrices are worked on. */
308 static struct frame *frame_matrix_frame;
310 /* Current interface for window-based redisplay. Set from init_xterm.
311 A null value means we are not using window-based redisplay. */
313 struct redisplay_interface *rif;
315 /* Non-zero means that fonts have been loaded since the last glyph
316 matrix adjustments. Redisplay must stop, and glyph matrices must
317 be adjusted when this flag becomes non-zero during display. The
318 reason fonts can be loaded so late is that fonts of fontsets are
319 loaded on demand. */
321 int fonts_changed_p;
323 /* Convert vpos and hpos from frame to window and vice versa.
324 This may only be used for terminal frames. */
326 #if GLYPH_DEBUG
328 static int window_to_frame_vpos P_ ((struct window *, int));
329 static int window_to_frame_hpos P_ ((struct window *, int));
330 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
331 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
333 /* One element of the ring buffer containing redisplay history
334 information. */
336 struct redisplay_history
338 char trace[512 + 100];
341 /* The size of the history buffer. */
343 #define REDISPLAY_HISTORY_SIZE 30
345 /* The redisplay history buffer. */
347 static struct redisplay_history redisplay_history[REDISPLAY_HISTORY_SIZE];
349 /* Next free entry in redisplay_history. */
351 static int history_idx;
353 /* A tick that's incremented each time something is added to the
354 history. */
356 static unsigned history_tick;
358 static void add_frame_display_history P_ ((struct frame *, int));
359 static void add_window_display_history P_ ((struct window *, char *, int));
362 /* Add to the redisplay history how window W has been displayed.
363 MSG is a trace containing the information how W's glyph matrix
364 has been contructed. PAUSED_P non-zero means that the update
365 has been interrupted for pending input. */
367 static void
368 add_window_display_history (w, msg, paused_p)
369 struct window *w;
370 char *msg;
371 int paused_p;
373 char *buf;
375 if (history_idx >= REDISPLAY_HISTORY_SIZE)
376 history_idx = 0;
377 buf = redisplay_history[history_idx].trace;
378 ++history_idx;
380 sprintf (buf, "%d: window %p (`%s')%s\n",
381 history_tick++,
383 ((BUFFERP (w->buffer)
384 && STRINGP (XBUFFER (w->buffer)->name))
385 ? (char *) XSTRING (XBUFFER (w->buffer)->name)->data
386 : "???"),
387 paused_p ? " ***paused***" : "");
388 strcat (buf, msg);
392 /* Add to the redisplay history that frame F has been displayed.
393 PAUSED_P non-zero means that the update has been interrupted for
394 pending input. */
396 static void
397 add_frame_display_history (f, paused_p)
398 struct frame *f;
399 int paused_p;
401 char *buf;
403 if (history_idx >= REDISPLAY_HISTORY_SIZE)
404 history_idx = 0;
405 buf = redisplay_history[history_idx].trace;
406 ++history_idx;
408 sprintf (buf, "%d: update frame %p%s",
409 history_tick++,
410 f, paused_p ? " ***paused***" : "");
414 DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
415 Sdump_redisplay_history, 0, 0, "",
416 "Dump redisplay history to stderr.")
419 int i;
421 for (i = history_idx - 1; i != history_idx; --i)
423 if (i < 0)
424 i = REDISPLAY_HISTORY_SIZE - 1;
425 fprintf (stderr, "%s\n", redisplay_history[i].trace);
428 return Qnil;
432 #else /* GLYPH_DEBUG == 0 */
434 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + XFASTINT ((W)->top))
435 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + XFASTINT ((W)->left))
437 #endif /* GLYPH_DEBUG == 0 */
440 /* Like bcopy except never gets confused by overlap. Let this be the
441 first function defined in this file, or change emacs.c where the
442 address of this function is used. */
444 void
445 safe_bcopy (from, to, size)
446 char *from, *to;
447 int size;
449 if (size <= 0 || from == to)
450 return;
452 /* If the source and destination don't overlap, then bcopy can
453 handle it. If they do overlap, but the destination is lower in
454 memory than the source, we'll assume bcopy can handle that. */
455 if (to < from || from + size <= to)
456 bcopy (from, to, size);
458 /* Otherwise, we'll copy from the end. */
459 else
461 register char *endf = from + size;
462 register char *endt = to + size;
464 /* If TO - FROM is large, then we should break the copy into
465 nonoverlapping chunks of TO - FROM bytes each. However, if
466 TO - FROM is small, then the bcopy function call overhead
467 makes this not worth it. The crossover point could be about
468 anywhere. Since I don't think the obvious copy loop is too
469 bad, I'm trying to err in its favor. */
470 if (to - from < 64)
473 *--endt = *--endf;
474 while (endf != from);
476 else
478 for (;;)
480 endt -= (to - from);
481 endf -= (to - from);
483 if (endt < to)
484 break;
486 bcopy (endf, endt, to - from);
489 /* If SIZE wasn't a multiple of TO - FROM, there will be a
490 little left over. The amount left over is (endt + (to -
491 from)) - to, which is endt - from. */
492 bcopy (from, to, endt - from);
499 /***********************************************************************
500 Glyph Matrices
501 ***********************************************************************/
503 /* Allocate and return a glyph_matrix structure. POOL is the glyph
504 pool from which memory for the matrix should be allocated, or null
505 for window-based redisplay where no glyph pools are used. The
506 member `pool' of the glyph matrix structure returned is set to
507 POOL, the structure is otherwise zeroed. */
509 struct glyph_matrix *
510 new_glyph_matrix (pool)
511 struct glyph_pool *pool;
513 struct glyph_matrix *result;
515 /* Allocate and clear. */
516 result = (struct glyph_matrix *) xmalloc (sizeof *result);
517 bzero (result, sizeof *result);
519 /* Increment number of allocated matrices. This count is used
520 to detect memory leaks. */
521 ++glyph_matrix_count;
523 /* Set pool and return. */
524 result->pool = pool;
525 return result;
529 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
531 The global counter glyph_matrix_count is decremented when a matrix
532 is freed. If the count gets negative, more structures were freed
533 than allocated, i.e. one matrix was freed more than once or a bogus
534 pointer was passed to this function.
536 If MATRIX->pool is null, this means that the matrix manages its own
537 glyph memory---this is done for matrices on X frames. Freeing the
538 matrix also frees the glyph memory in this case. */
540 static void
541 free_glyph_matrix (matrix)
542 struct glyph_matrix *matrix;
544 if (matrix)
546 int i;
548 /* Detect the case that more matrices are freed than were
549 allocated. */
550 if (--glyph_matrix_count < 0)
551 abort ();
553 /* Free glyph memory if MATRIX owns it. */
554 if (matrix->pool == NULL)
555 for (i = 0; i < matrix->rows_allocated; ++i)
556 xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
558 /* Free row structures and the matrix itself. */
559 xfree (matrix->rows);
560 xfree (matrix);
565 /* Return the number of glyphs to reserve for a marginal area of
566 window W. TOTAL_GLYPHS is the number of glyphs in a complete
567 display line of window W. MARGIN gives the width of the marginal
568 area in canonical character units. MARGIN should be an integer
569 or a float. */
571 static int
572 margin_glyphs_to_reserve (w, total_glyphs, margin)
573 struct window *w;
574 int total_glyphs;
575 Lisp_Object margin;
577 int n;
579 if (NUMBERP (margin))
581 int width = XFASTINT (w->width);
582 double d = max (0, XFLOATINT (margin));
583 d = min (width / 2 - 1, d);
584 n = (int) ((double) total_glyphs / width * d);
586 else
587 n = 0;
589 return n;
593 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
594 window sizes.
596 W is null if the function is called for a frame glyph matrix.
597 Otherwise it is the window MATRIX is a member of. X and Y are the
598 indices of the first column and row of MATRIX within the frame
599 matrix, if such a matrix exists. They are zero for purely
600 window-based redisplay. DIM is the needed size of the matrix.
602 In window-based redisplay, where no frame matrices exist, glyph
603 matrices manage their own glyph storage. Otherwise, they allocate
604 storage from a common frame glyph pool which can be found in
605 MATRIX->pool.
607 The reason for this memory management strategy is to avoid complete
608 frame redraws if possible. When we allocate from a common pool, a
609 change of the location or size of a sub-matrix within the pool
610 requires a complete redisplay of the frame because we cannot easily
611 make sure that the current matrices of all windows still agree with
612 what is displayed on the screen. While this is usually fast, it
613 leads to screen flickering. */
615 static void
616 adjust_glyph_matrix (w, matrix, x, y, dim)
617 struct window *w;
618 struct glyph_matrix *matrix;
619 int x, y;
620 struct dim dim;
622 int i;
623 int new_rows;
624 int marginal_areas_changed_p = 0;
625 int header_line_changed_p = 0;
626 int header_line_p = 0;
627 int left = -1, right = -1;
628 int window_x, window_y, window_width = -1, window_height;
630 /* See if W had a top line that has disappeared now, or vice versa. */
631 if (w)
633 header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
634 header_line_changed_p = header_line_p != matrix->header_line_p;
636 matrix->header_line_p = header_line_p;
638 /* Do nothing if MATRIX' size, position, vscroll, and marginal areas
639 haven't changed. This optimization is important because preserving
640 the matrix means preventing redisplay. */
641 if (matrix->pool == NULL)
643 window_box (w, -1, &window_x, &window_y, &window_width, &window_height);
644 left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_width);
645 right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_width);
646 xassert (left >= 0 && right >= 0);
647 marginal_areas_changed_p = (left != matrix->left_margin_glyphs
648 || right != matrix->right_margin_glyphs);
650 if (!marginal_areas_changed_p
651 && !fonts_changed_p
652 && !header_line_changed_p
653 && matrix->window_left_x == XFASTINT (w->left)
654 && matrix->window_top_y == XFASTINT (w->top)
655 && matrix->window_height == window_height
656 && matrix->window_vscroll == w->vscroll
657 && matrix->window_width == window_width)
658 return;
661 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
662 if (matrix->rows_allocated < dim.height)
664 int size = dim.height * sizeof (struct glyph_row);
665 new_rows = dim.height - matrix->rows_allocated;
666 matrix->rows = (struct glyph_row *) xrealloc (matrix->rows, size);
667 bzero (matrix->rows + matrix->rows_allocated,
668 new_rows * sizeof *matrix->rows);
669 matrix->rows_allocated = dim.height;
671 else
672 new_rows = 0;
674 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
675 on a frame not using window-based redisplay. Set up pointers for
676 each row into the glyph pool. */
677 if (matrix->pool)
679 xassert (matrix->pool->glyphs);
681 if (w)
683 left = margin_glyphs_to_reserve (w, dim.width,
684 w->left_margin_width);
685 right = margin_glyphs_to_reserve (w, dim.width,
686 w->right_margin_width);
688 else
689 left = right = 0;
691 for (i = 0; i < dim.height; ++i)
693 struct glyph_row *row = &matrix->rows[i];
695 row->glyphs[LEFT_MARGIN_AREA]
696 = (matrix->pool->glyphs
697 + (y + i) * matrix->pool->ncolumns
698 + x);
700 if (w == NULL
701 || row == matrix->rows + dim.height - 1
702 || (row == matrix->rows && matrix->header_line_p))
704 row->glyphs[TEXT_AREA]
705 = row->glyphs[LEFT_MARGIN_AREA];
706 row->glyphs[RIGHT_MARGIN_AREA]
707 = row->glyphs[TEXT_AREA] + dim.width;
708 row->glyphs[LAST_AREA]
709 = row->glyphs[RIGHT_MARGIN_AREA];
711 else
713 row->glyphs[TEXT_AREA]
714 = row->glyphs[LEFT_MARGIN_AREA] + left;
715 row->glyphs[RIGHT_MARGIN_AREA]
716 = row->glyphs[TEXT_AREA] + dim.width - left - right;
717 row->glyphs[LAST_AREA]
718 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
722 matrix->left_margin_glyphs = left;
723 matrix->right_margin_glyphs = right;
725 else
727 /* If MATRIX->pool is null, MATRIX is responsible for managing
728 its own memory. Allocate glyph memory from the heap. */
729 if (dim.width > matrix->matrix_w
730 || new_rows
731 || header_line_changed_p
732 || marginal_areas_changed_p)
734 struct glyph_row *row = matrix->rows;
735 struct glyph_row *end = row + matrix->rows_allocated;
737 while (row < end)
739 row->glyphs[LEFT_MARGIN_AREA]
740 = (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
741 (dim.width
742 * sizeof (struct glyph)));
744 /* The mode line never has marginal areas. */
745 if (row == matrix->rows + dim.height - 1
746 || (row == matrix->rows && matrix->header_line_p))
748 row->glyphs[TEXT_AREA]
749 = row->glyphs[LEFT_MARGIN_AREA];
750 row->glyphs[RIGHT_MARGIN_AREA]
751 = row->glyphs[TEXT_AREA] + dim.width;
752 row->glyphs[LAST_AREA]
753 = row->glyphs[RIGHT_MARGIN_AREA];
755 else
757 row->glyphs[TEXT_AREA]
758 = row->glyphs[LEFT_MARGIN_AREA] + left;
759 row->glyphs[RIGHT_MARGIN_AREA]
760 = row->glyphs[TEXT_AREA] + dim.width - left - right;
761 row->glyphs[LAST_AREA]
762 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
764 ++row;
768 xassert (left >= 0 && right >= 0);
769 matrix->left_margin_glyphs = left;
770 matrix->right_margin_glyphs = right;
773 /* Number of rows to be used by MATRIX. */
774 matrix->nrows = dim.height;
775 xassert (matrix->nrows >= 0);
777 /* Mark rows in a current matrix of a window as not having valid
778 contents. It's important to not do this for desired matrices.
779 When Emacs starts, it may already be building desired matrices
780 when this function runs. */
781 if (w && matrix == w->current_matrix)
783 if (window_width < 0)
784 window_width = window_box_width (w, -1);
786 /* Optimize the case that only the height has changed (C-x 2,
787 upper window). Invalidate all rows that are no longer part
788 of the window. */
789 if (!marginal_areas_changed_p
790 && matrix->window_left_x == XFASTINT (w->left)
791 && matrix->window_top_y == XFASTINT (w->top)
792 && matrix->window_width == window_box_width (w, -1))
794 i = 0;
795 while (matrix->rows[i].enabled_p
796 && (MATRIX_ROW_BOTTOM_Y (matrix->rows + i)
797 < matrix->window_height))
798 ++i;
800 /* Window end is invalid, if inside of the rows that
801 are invalidated. */
802 if (INTEGERP (w->window_end_vpos)
803 && XFASTINT (w->window_end_vpos) >= i)
804 w->window_end_valid = Qnil;
806 while (i < matrix->nrows)
807 matrix->rows[i++].enabled_p = 0;
809 else
811 for (i = 0; i < matrix->nrows; ++i)
812 matrix->rows[i].enabled_p = 0;
816 /* Remember last values to be able to optimize frame redraws. */
817 matrix->matrix_x = x;
818 matrix->matrix_y = y;
819 matrix->matrix_w = dim.width;
820 matrix->matrix_h = dim.height;
822 /* Record the top y location and height of W at the time the matrix
823 was last adjusted. This is used to optimize redisplay above. */
824 if (w)
826 matrix->window_left_x = XFASTINT (w->left);
827 matrix->window_top_y = XFASTINT (w->top);
828 matrix->window_height = window_height;
829 matrix->window_width = window_width;
830 matrix->window_vscroll = w->vscroll;
835 /* Reverse the contents of rows in MATRIX between START and END. The
836 contents of the row at END - 1 end up at START, END - 2 at START +
837 1 etc. This is part of the implementation of rotate_matrix (see
838 below). */
840 static void
841 reverse_rows (matrix, start, end)
842 struct glyph_matrix *matrix;
843 int start, end;
845 int i, j;
847 for (i = start, j = end - 1; i < j; ++i, --j)
849 /* Non-ISO HP/UX compiler doesn't like auto struct
850 initialization. */
851 struct glyph_row temp;
852 temp = matrix->rows[i];
853 matrix->rows[i] = matrix->rows[j];
854 matrix->rows[j] = temp;
859 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
860 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
861 indices. (Note: this does not copy glyphs, only glyph pointers in
862 row structures are moved around).
864 The algorithm used for rotating the vector was, I believe, first
865 described by Kernighan. See the vector R as consisting of two
866 sub-vectors AB, where A has length BY for BY >= 0. The result
867 after rotating is then BA. Reverse both sub-vectors to get ArBr
868 and reverse the result to get (ArBr)r which is BA. Similar for
869 rotating right. */
871 void
872 rotate_matrix (matrix, first, last, by)
873 struct glyph_matrix *matrix;
874 int first, last, by;
876 if (by < 0)
878 /* Up (rotate left, i.e. towards lower indices). */
879 by = -by;
880 reverse_rows (matrix, first, first + by);
881 reverse_rows (matrix, first + by, last);
882 reverse_rows (matrix, first, last);
884 else if (by > 0)
886 /* Down (rotate right, i.e. towards higher indices). */
887 reverse_rows (matrix, last - by, last);
888 reverse_rows (matrix, first, last - by);
889 reverse_rows (matrix, first, last);
894 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
895 with indices START <= index < END. Increment positions by DELTA/
896 DELTA_BYTES. */
898 void
899 increment_matrix_positions (matrix, start, end, delta, delta_bytes)
900 struct glyph_matrix *matrix;
901 int start, end, delta, delta_bytes;
903 /* Check that START and END are reasonable values. */
904 xassert (start >= 0 && start <= matrix->nrows);
905 xassert (end >= 0 && end <= matrix->nrows);
906 xassert (start <= end);
908 for (; start < end; ++start)
909 increment_row_positions (matrix->rows + start, delta, delta_bytes);
913 /* Enable a range of rows in glyph matrix MATRIX. START and END are
914 the row indices of the first and last + 1 row to enable. If
915 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
917 void
918 enable_glyph_matrix_rows (matrix, start, end, enabled_p)
919 struct glyph_matrix *matrix;
920 int start, end;
921 int enabled_p;
923 xassert (start <= end);
924 xassert (start >= 0 && start < matrix->nrows);
925 xassert (end >= 0 && end <= matrix->nrows);
927 for (; start < end; ++start)
928 matrix->rows[start].enabled_p = enabled_p != 0;
932 /* Clear MATRIX.
934 This empties all rows in MATRIX by setting the enabled_p flag for
935 all rows of the matrix to zero. The function prepare_desired_row
936 will eventually really clear a row when it sees one with a zero
937 enabled_p flag.
939 Resets update hints to defaults value. The only update hint
940 currently present is the flag MATRIX->no_scrolling_p. */
942 void
943 clear_glyph_matrix (matrix)
944 struct glyph_matrix *matrix;
946 if (matrix)
948 enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
949 matrix->no_scrolling_p = 0;
954 /* Shift part of the glyph matrix MATRIX of window W up or down.
955 Increment y-positions in glyph rows between START and END by DY,
956 and recompute their visible height. */
958 void
959 shift_glyph_matrix (w, matrix, start, end, dy)
960 struct window *w;
961 struct glyph_matrix *matrix;
962 int start, end, dy;
964 int min_y, max_y;
966 xassert (start <= end);
967 xassert (start >= 0 && start < matrix->nrows);
968 xassert (end >= 0 && end <= matrix->nrows);
970 min_y = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
971 max_y = WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w);
973 for (; start < end; ++start)
975 struct glyph_row *row = &matrix->rows[start];
977 row->y += dy;
979 if (row->y < min_y)
980 row->visible_height = row->height - (min_y - row->y);
981 else if (row->y + row->height > max_y)
982 row->visible_height = row->height - (row->y + row->height - max_y);
983 else
984 row->visible_height = row->height;
989 /* Mark all rows in current matrices of frame F as invalid. Marking
990 invalid is done by setting enabled_p to zero for all rows in a
991 current matrix. */
993 void
994 clear_current_matrices (f)
995 register struct frame *f;
997 /* Clear frame current matrix, if we have one. */
998 if (f->current_matrix)
999 clear_glyph_matrix (f->current_matrix);
1001 /* Clear the matrix of the menu bar window, if such a window exists.
1002 The menu bar window is currently used to display menus on X when
1003 no toolkit support is compiled in. */
1004 if (WINDOWP (f->menu_bar_window))
1005 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1007 /* Clear the matrix of the tool-bar window, if any. */
1008 if (WINDOWP (f->tool_bar_window))
1009 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1011 /* Clear current window matrices. */
1012 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1013 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
1017 /* Clear out all display lines of F for a coming redisplay. */
1019 void
1020 clear_desired_matrices (f)
1021 register struct frame *f;
1023 if (f->desired_matrix)
1024 clear_glyph_matrix (f->desired_matrix);
1026 if (WINDOWP (f->menu_bar_window))
1027 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
1029 if (WINDOWP (f->tool_bar_window))
1030 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
1032 /* Do it for window matrices. */
1033 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1034 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
1038 /* Clear matrices in window tree rooted in W. If DESIRED_P is
1039 non-zero clear desired matrices, otherwise clear current matrices. */
1041 static void
1042 clear_window_matrices (w, desired_p)
1043 struct window *w;
1044 int desired_p;
1046 while (w)
1048 if (!NILP (w->hchild))
1050 xassert (WINDOWP (w->hchild));
1051 clear_window_matrices (XWINDOW (w->hchild), desired_p);
1053 else if (!NILP (w->vchild))
1055 xassert (WINDOWP (w->vchild));
1056 clear_window_matrices (XWINDOW (w->vchild), desired_p);
1058 else
1060 if (desired_p)
1061 clear_glyph_matrix (w->desired_matrix);
1062 else
1064 clear_glyph_matrix (w->current_matrix);
1065 w->window_end_valid = Qnil;
1069 w = NILP (w->next) ? 0 : XWINDOW (w->next);
1075 /***********************************************************************
1076 Glyph Rows
1078 See dispextern.h for an overall explanation of glyph rows.
1079 ***********************************************************************/
1081 /* Clear glyph row ROW. Do it in a way that makes it robust against
1082 changes in the glyph_row structure, i.e. addition or removal of
1083 structure members. */
1085 static struct glyph_row null_row;
1087 void
1088 clear_glyph_row (row)
1089 struct glyph_row *row;
1091 struct glyph *p[1 + LAST_AREA];
1093 /* Save pointers. */
1094 p[LEFT_MARGIN_AREA] = row->glyphs[LEFT_MARGIN_AREA];
1095 p[TEXT_AREA] = row->glyphs[TEXT_AREA];
1096 p[RIGHT_MARGIN_AREA] = row->glyphs[RIGHT_MARGIN_AREA];
1097 p[LAST_AREA] = row->glyphs[LAST_AREA];
1099 /* Clear. */
1100 *row = null_row;
1102 /* Restore pointers. */
1103 row->glyphs[LEFT_MARGIN_AREA] = p[LEFT_MARGIN_AREA];
1104 row->glyphs[TEXT_AREA] = p[TEXT_AREA];
1105 row->glyphs[RIGHT_MARGIN_AREA] = p[RIGHT_MARGIN_AREA];
1106 row->glyphs[LAST_AREA] = p[LAST_AREA];
1108 #if 0 /* At some point, some bit-fields of struct glyph were not set,
1109 which made glyphs unequal when compared with GLYPH_EQUAL_P.
1110 Redisplay outputs such glyphs, and flickering effects were
1111 the result. This also depended on the contents of memory
1112 returned by xmalloc. If flickering happens again, activate
1113 the code below If the flickering is gone with that, chances
1114 are that the flickering has the same reason as here. */
1115 bzero (p[0], (char *) p[LAST_AREA] - (char *) p[0]);
1116 #endif
1120 /* Make ROW an empty, enabled row of canonical character height,
1121 in window W starting at y-position Y. */
1123 void
1124 blank_row (w, row, y)
1125 struct window *w;
1126 struct glyph_row *row;
1127 int y;
1129 int min_y, max_y;
1131 min_y = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
1132 max_y = WINDOW_DISPLAY_HEIGHT_NO_MODE_LINE (w);
1134 clear_glyph_row (row);
1135 row->y = y;
1136 row->ascent = row->phys_ascent = 0;
1137 row->height = row->phys_height = CANON_Y_UNIT (XFRAME (w->frame));
1139 if (row->y < min_y)
1140 row->visible_height = row->height - (min_y - row->y);
1141 else if (row->y + row->height > max_y)
1142 row->visible_height = row->height - (row->y + row->height - max_y);
1143 else
1144 row->visible_height = row->height;
1146 row->enabled_p = 1;
1150 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1151 are the amounts by which to change positions. Note that the first
1152 glyph of the text area of a row can have a buffer position even if
1153 the used count of the text area is zero. Such rows display line
1154 ends. */
1156 void
1157 increment_row_positions (row, delta, delta_bytes)
1158 struct glyph_row *row;
1159 int delta, delta_bytes;
1161 int area, i;
1163 /* Increment start and end positions. */
1164 MATRIX_ROW_START_CHARPOS (row) += delta;
1165 MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
1166 MATRIX_ROW_END_CHARPOS (row) += delta;
1167 MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
1169 /* Increment positions in glyphs. */
1170 for (area = 0; area < LAST_AREA; ++area)
1171 for (i = 0; i < row->used[area]; ++i)
1172 if (BUFFERP (row->glyphs[area][i].object)
1173 && row->glyphs[area][i].charpos > 0)
1174 row->glyphs[area][i].charpos += delta;
1176 /* Capture the case of rows displaying a line end. */
1177 if (row->used[TEXT_AREA] == 0
1178 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
1179 row->glyphs[TEXT_AREA]->charpos += delta;
1183 #if 0
1184 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1185 contents, i.e. glyph structure contents are exchanged between A and
1186 B without changing glyph pointers in A and B. */
1188 static void
1189 swap_glyphs_in_rows (a, b)
1190 struct glyph_row *a, *b;
1192 int area;
1194 for (area = 0; area < LAST_AREA; ++area)
1196 /* Number of glyphs to swap. */
1197 int max_used = max (a->used[area], b->used[area]);
1199 /* Start of glyphs in area of row A. */
1200 struct glyph *glyph_a = a->glyphs[area];
1202 /* End + 1 of glyphs in area of row A. */
1203 struct glyph *glyph_a_end = a->glyphs[max_used];
1205 /* Start of glyphs in area of row B. */
1206 struct glyph *glyph_b = b->glyphs[area];
1208 while (glyph_a < glyph_a_end)
1210 /* Non-ISO HP/UX compiler doesn't like auto struct
1211 initialization. */
1212 struct glyph temp;
1213 temp = *glyph_a;
1214 *glyph_a = *glyph_b;
1215 *glyph_b = temp;
1216 ++glyph_a;
1217 ++glyph_b;
1222 #endif /* 0 */
1224 /* Exchange pointers to glyph memory between glyph rows A and B. */
1226 static INLINE void
1227 swap_glyph_pointers (a, b)
1228 struct glyph_row *a, *b;
1230 int i;
1231 for (i = 0; i < LAST_AREA + 1; ++i)
1233 struct glyph *temp = a->glyphs[i];
1234 a->glyphs[i] = b->glyphs[i];
1235 b->glyphs[i] = temp;
1240 /* Copy glyph row structure FROM to glyph row structure TO, except
1241 that glyph pointers in the structures are left unchanged. */
1243 INLINE void
1244 copy_row_except_pointers (to, from)
1245 struct glyph_row *to, *from;
1247 struct glyph *pointers[1 + LAST_AREA];
1249 /* Save glyph pointers of TO. */
1250 bcopy (to->glyphs, pointers, sizeof to->glyphs);
1252 /* Do a structure assignment. */
1253 *to = *from;
1255 /* Restore original pointers of TO. */
1256 bcopy (pointers, to->glyphs, sizeof to->glyphs);
1260 /* Copy contents of glyph row FROM to glyph row TO. Glyph pointers in
1261 TO and FROM are left unchanged. Glyph contents are copied from the
1262 glyph memory of FROM to the glyph memory of TO. Increment buffer
1263 positions in row TO by DELTA/ DELTA_BYTES. */
1265 void
1266 copy_glyph_row_contents (to, from, delta, delta_bytes)
1267 struct glyph_row *to, *from;
1268 int delta, delta_bytes;
1270 int area;
1272 /* This is like a structure assignment TO = FROM, except that
1273 glyph pointers in the rows are left unchanged. */
1274 copy_row_except_pointers (to, from);
1276 /* Copy glyphs from FROM to TO. */
1277 for (area = 0; area < LAST_AREA; ++area)
1278 if (from->used[area])
1279 bcopy (from->glyphs[area], to->glyphs[area],
1280 from->used[area] * sizeof (struct glyph));
1282 /* Increment buffer positions in TO by DELTA. */
1283 increment_row_positions (to, delta, delta_bytes);
1287 /* Assign glyph row FROM to glyph row TO. This works like a structure
1288 assignment TO = FROM, except that glyph pointers are not copied but
1289 exchanged between TO and FROM. Pointers must be exchanged to avoid
1290 a memory leak. */
1292 static INLINE void
1293 assign_row (to, from)
1294 struct glyph_row *to, *from;
1296 swap_glyph_pointers (to, from);
1297 copy_row_except_pointers (to, from);
1301 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1302 a row in a window matrix, is a slice of the glyph memory of the
1303 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1304 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1305 memory of FRAME_ROW. */
1307 #if GLYPH_DEBUG
1309 static int
1310 glyph_row_slice_p (window_row, frame_row)
1311 struct glyph_row *window_row, *frame_row;
1313 struct glyph *window_glyph_start = window_row->glyphs[0];
1314 struct glyph *frame_glyph_start = frame_row->glyphs[0];
1315 struct glyph *frame_glyph_end = frame_row->glyphs[LAST_AREA];
1317 return (frame_glyph_start <= window_glyph_start
1318 && window_glyph_start < frame_glyph_end);
1321 #endif /* GLYPH_DEBUG */
1323 #if 0
1325 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1326 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1327 in WINDOW_MATRIX is found satisfying the condition. */
1329 static struct glyph_row *
1330 find_glyph_row_slice (window_matrix, frame_matrix, row)
1331 struct glyph_matrix *window_matrix, *frame_matrix;
1332 int row;
1334 int i;
1336 xassert (row >= 0 && row < frame_matrix->nrows);
1338 for (i = 0; i < window_matrix->nrows; ++i)
1339 if (glyph_row_slice_p (window_matrix->rows + i,
1340 frame_matrix->rows + row))
1341 break;
1343 return i < window_matrix->nrows ? window_matrix->rows + i : 0;
1346 #endif /* 0 */
1348 /* Prepare ROW for display. Desired rows are cleared lazily,
1349 i.e. they are only marked as to be cleared by setting their
1350 enabled_p flag to zero. When a row is to be displayed, a prior
1351 call to this function really clears it. */
1353 void
1354 prepare_desired_row (row)
1355 struct glyph_row *row;
1357 if (!row->enabled_p)
1359 clear_glyph_row (row);
1360 row->enabled_p = 1;
1365 /* Return a hash code for glyph row ROW. */
1368 line_hash_code (row)
1369 struct glyph_row *row;
1371 int hash = 0;
1373 if (row->enabled_p)
1375 if (row->inverse_p)
1377 /* Give all highlighted lines the same hash code
1378 so as to encourage scrolling to leave them in place. */
1379 hash = -1;
1381 else
1383 struct glyph *glyph = row->glyphs[TEXT_AREA];
1384 struct glyph *end = glyph + row->used[TEXT_AREA];
1386 while (glyph < end)
1388 int c = glyph->u.ch;
1389 int face_id = glyph->face_id;
1390 if (must_write_spaces)
1391 c -= SPACEGLYPH;
1392 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + c;
1393 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + face_id;
1394 ++glyph;
1397 if (hash == 0)
1398 hash = 1;
1402 return hash;
1406 /* Return the cost of drawing line VPOS In MATRIX. The cost equals
1407 the number of characters in the line. If must_write_spaces is
1408 zero, leading and trailing spaces are ignored. */
1410 static unsigned int
1411 line_draw_cost (matrix, vpos)
1412 struct glyph_matrix *matrix;
1413 int vpos;
1415 struct glyph_row *row = matrix->rows + vpos;
1416 struct glyph *beg = row->glyphs[TEXT_AREA];
1417 struct glyph *end = beg + row->used[TEXT_AREA];
1418 int len;
1419 Lisp_Object *glyph_table_base = GLYPH_TABLE_BASE;
1420 int glyph_table_len = GLYPH_TABLE_LENGTH;
1422 /* Ignore trailing and leading spaces if we can. */
1423 if (!must_write_spaces)
1425 /* Skip from the end over trailing spaces. */
1426 while (end > beg && CHAR_GLYPH_SPACE_P (*(end - 1)))
1427 --end;
1429 /* All blank line. */
1430 if (end == beg)
1431 return 0;
1433 /* Skip over leading spaces. */
1434 while (CHAR_GLYPH_SPACE_P (*beg))
1435 ++beg;
1438 /* If we don't have a glyph-table, each glyph is one character,
1439 so return the number of glyphs. */
1440 if (glyph_table_base == 0)
1441 len = end - beg;
1442 else
1444 /* Otherwise, scan the glyphs and accumulate their total length
1445 in LEN. */
1446 len = 0;
1447 while (beg < end)
1449 GLYPH g = GLYPH_FROM_CHAR_GLYPH (*beg);
1451 if (g < 0
1452 || GLYPH_SIMPLE_P (glyph_table_base, glyph_table_len, g))
1453 len += 1;
1454 else
1455 len += GLYPH_LENGTH (glyph_table_base, g);
1457 ++beg;
1461 return len;
1465 /* Test two glyph rows A and B for equality. Value is non-zero if A
1466 and B have equal contents. W is the window to which the glyphs
1467 rows A and B belong. It is needed here to test for partial row
1468 visibility. MOUSE_FACE_P non-zero means compare the mouse_face_p
1469 flags of A and B, too. */
1471 static INLINE int
1472 row_equal_p (w, a, b, mouse_face_p)
1473 struct window *w;
1474 struct glyph_row *a, *b;
1475 int mouse_face_p;
1477 if (a == b)
1478 return 1;
1479 else if (a->hash != b->hash)
1480 return 0;
1481 else
1483 struct glyph *a_glyph, *b_glyph, *a_end;
1484 int area;
1486 if (mouse_face_p && a->mouse_face_p != b->mouse_face_p)
1487 return 0;
1489 /* Compare glyphs. */
1490 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
1492 if (a->used[area] != b->used[area])
1493 return 0;
1495 a_glyph = a->glyphs[area];
1496 a_end = a_glyph + a->used[area];
1497 b_glyph = b->glyphs[area];
1499 while (a_glyph < a_end
1500 && GLYPH_EQUAL_P (a_glyph, b_glyph))
1501 ++a_glyph, ++b_glyph;
1503 if (a_glyph != a_end)
1504 return 0;
1507 if (a->truncated_on_left_p != b->truncated_on_left_p
1508 || a->inverse_p != b->inverse_p
1509 || a->fill_line_p != b->fill_line_p
1510 || a->truncated_on_right_p != b->truncated_on_right_p
1511 || a->overlay_arrow_p != b->overlay_arrow_p
1512 || a->continued_p != b->continued_p
1513 || a->indicate_empty_line_p != b->indicate_empty_line_p
1514 || a->overlapped_p != b->overlapped_p
1515 || (MATRIX_ROW_CONTINUATION_LINE_P (a)
1516 != MATRIX_ROW_CONTINUATION_LINE_P (b))
1517 /* Different partially visible characters on left margin. */
1518 || a->x != b->x
1519 /* Different height. */
1520 || a->ascent != b->ascent
1521 || a->phys_ascent != b->phys_ascent
1522 || a->phys_height != b->phys_height
1523 || a->visible_height != b->visible_height)
1524 return 0;
1527 return 1;
1532 /***********************************************************************
1533 Glyph Pool
1535 See dispextern.h for an overall explanation of glyph pools.
1536 ***********************************************************************/
1538 /* Allocate a glyph_pool structure. The structure returned is
1539 initialized with zeros. The global variable glyph_pool_count is
1540 incremented for each pool allocated. */
1542 static struct glyph_pool *
1543 new_glyph_pool ()
1545 struct glyph_pool *result;
1547 /* Allocate a new glyph_pool and clear it. */
1548 result = (struct glyph_pool *) xmalloc (sizeof *result);
1549 bzero (result, sizeof *result);
1551 /* For memory leak and double deletion checking. */
1552 ++glyph_pool_count;
1554 return result;
1558 /* Free a glyph_pool structure POOL. The function may be called with
1559 a null POOL pointer. The global variable glyph_pool_count is
1560 decremented with every pool structure freed. If this count gets
1561 negative, more structures were freed than allocated, i.e. one
1562 structure must have been freed more than once or a bogus pointer
1563 was passed to free_glyph_pool. */
1565 static void
1566 free_glyph_pool (pool)
1567 struct glyph_pool *pool;
1569 if (pool)
1571 /* More freed than allocated? */
1572 --glyph_pool_count;
1573 xassert (glyph_pool_count >= 0);
1575 xfree (pool->glyphs);
1576 xfree (pool);
1581 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1582 columns we need. This function never shrinks a pool. The only
1583 case in which this would make sense, would be when a frame's size
1584 is changed from a large value to a smaller one. But, if someone
1585 does it once, we can expect that he will do it again.
1587 Value is non-zero if the pool changed in a way which makes
1588 re-adjusting window glyph matrices necessary. */
1590 static int
1591 realloc_glyph_pool (pool, matrix_dim)
1592 struct glyph_pool *pool;
1593 struct dim matrix_dim;
1595 int needed;
1596 int changed_p;
1598 changed_p = (pool->glyphs == 0
1599 || matrix_dim.height != pool->nrows
1600 || matrix_dim.width != pool->ncolumns);
1602 /* Enlarge the glyph pool. */
1603 needed = matrix_dim.width * matrix_dim.height;
1604 if (needed > pool->nglyphs)
1606 int size = needed * sizeof (struct glyph);
1608 if (pool->glyphs)
1609 pool->glyphs = (struct glyph *) xrealloc (pool->glyphs, size);
1610 else
1612 pool->glyphs = (struct glyph *) xmalloc (size);
1613 bzero (pool->glyphs, size);
1616 pool->nglyphs = needed;
1619 /* Remember the number of rows and columns because (a) we use then
1620 to do sanity checks, and (b) the number of columns determines
1621 where rows in the frame matrix start---this must be available to
1622 determine pointers to rows of window sub-matrices. */
1623 pool->nrows = matrix_dim.height;
1624 pool->ncolumns = matrix_dim.width;
1626 return changed_p;
1631 /***********************************************************************
1632 Debug Code
1633 ***********************************************************************/
1635 #if GLYPH_DEBUG
1638 /* Flush standard output. This is sometimes useful to call from
1639 the debugger. */
1641 void
1642 flush_stdout ()
1644 fflush (stdout);
1648 /* Check that no glyph pointers have been lost in MATRIX. If a
1649 pointer has been lost, e.g. by using a structure assignment between
1650 rows, at least one pointer must occur more than once in the rows of
1651 MATRIX. */
1653 void
1654 check_matrix_pointer_lossage (matrix)
1655 struct glyph_matrix *matrix;
1657 int i, j;
1659 for (i = 0; i < matrix->nrows; ++i)
1660 for (j = 0; j < matrix->nrows; ++j)
1661 xassert (i == j
1662 || (matrix->rows[i].glyphs[TEXT_AREA]
1663 != matrix->rows[j].glyphs[TEXT_AREA]));
1667 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1669 struct glyph_row *
1670 matrix_row (matrix, row)
1671 struct glyph_matrix *matrix;
1672 int row;
1674 xassert (matrix && matrix->rows);
1675 xassert (row >= 0 && row < matrix->nrows);
1677 /* That's really too slow for normal testing because this function
1678 is called almost everywhere. Although---it's still astonishingly
1679 fast, so it is valuable to have for debugging purposes. */
1680 #if 0
1681 check_matrix_pointer_lossage (matrix);
1682 #endif
1684 return matrix->rows + row;
1688 #if 0 /* This function makes invalid assumptions when text is
1689 partially invisible. But it might come handy for debugging
1690 nevertheless. */
1692 /* Check invariants that must hold for an up to date current matrix of
1693 window W. */
1695 static void
1696 check_matrix_invariants (w)
1697 struct window *w;
1699 struct glyph_matrix *matrix = w->current_matrix;
1700 int yb = window_text_bottom_y (w);
1701 struct glyph_row *row = matrix->rows;
1702 struct glyph_row *last_text_row = NULL;
1703 struct buffer *saved = current_buffer;
1704 struct buffer *buffer = XBUFFER (w->buffer);
1705 int c;
1707 /* This can sometimes happen for a fresh window. */
1708 if (matrix->nrows < 2)
1709 return;
1711 set_buffer_temp (buffer);
1713 /* Note: last row is always reserved for the mode line. */
1714 while (MATRIX_ROW_DISPLAYS_TEXT_P (row)
1715 && MATRIX_ROW_BOTTOM_Y (row) < yb)
1717 struct glyph_row *next = row + 1;
1719 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
1720 last_text_row = row;
1722 /* Check that character and byte positions are in sync. */
1723 xassert (MATRIX_ROW_START_BYTEPOS (row)
1724 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row)));
1726 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1727 have such a position temporarily in case of a minibuffer
1728 displaying something like `[Sole completion]' at its end. */
1729 if (MATRIX_ROW_END_CHARPOS (row) < BUF_ZV (current_buffer))
1730 xassert (MATRIX_ROW_END_BYTEPOS (row)
1731 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row)));
1733 /* Check that end position of `row' is equal to start position
1734 of next row. */
1735 if (next->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (next))
1737 xassert (MATRIX_ROW_END_CHARPOS (row)
1738 == MATRIX_ROW_START_CHARPOS (next));
1739 xassert (MATRIX_ROW_END_BYTEPOS (row)
1740 == MATRIX_ROW_START_BYTEPOS (next));
1742 row = next;
1745 xassert (w->current_matrix->nrows == w->desired_matrix->nrows);
1746 xassert (w->desired_matrix->rows != NULL);
1747 set_buffer_temp (saved);
1750 #endif /* 0 */
1752 #endif /* GLYPH_DEBUG != 0 */
1756 /**********************************************************************
1757 Allocating/ Adjusting Glyph Matrices
1758 **********************************************************************/
1760 /* Allocate glyph matrices over a window tree for a frame-based
1761 redisplay
1763 X and Y are column/row within the frame glyph matrix where
1764 sub-matrices for the window tree rooted at WINDOW must be
1765 allocated. CH_DIM contains the dimensions of the smallest
1766 character that could be used during display. DIM_ONLY_P non-zero
1767 means that the caller of this function is only interested in the
1768 result matrix dimension, and matrix adjustments should not be
1769 performed.
1771 The function returns the total width/height of the sub-matrices of
1772 the window tree. If called on a frame root window, the computation
1773 will take the mini-buffer window into account.
1775 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1777 NEW_LEAF_MATRIX set if any window in the tree did not have a
1778 glyph matrices yet, and
1780 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1781 any window in the tree will be changed or have been changed (see
1782 DIM_ONLY_P).
1784 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1785 function.
1787 Windows are arranged into chains of windows on the same level
1788 through the next fields of window structures. Such a level can be
1789 either a sequence of horizontally adjacent windows from left to
1790 right, or a sequence of vertically adjacent windows from top to
1791 bottom. Each window in a horizontal sequence can be either a leaf
1792 window or a vertical sequence; a window in a vertical sequence can
1793 be either a leaf or a horizontal sequence. All windows in a
1794 horizontal sequence have the same height, and all windows in a
1795 vertical sequence have the same width.
1797 This function uses, for historical reasons, a more general
1798 algorithm to determine glyph matrix dimensions that would be
1799 necessary.
1801 The matrix height of a horizontal sequence is determined by the
1802 maximum height of any matrix in the sequence. The matrix width of
1803 a horizontal sequence is computed by adding up matrix widths of
1804 windows in the sequence.
1806 |<------- result width ------->|
1807 +---------+----------+---------+ ---
1808 | | | | |
1809 | | | |
1810 +---------+ | | result height
1811 | +---------+
1812 | | |
1813 +----------+ ---
1815 The matrix width of a vertical sequence is the maximum matrix width
1816 of any window in the sequence. Its height is computed by adding up
1817 matrix heights of windows in the sequence.
1819 |<---- result width -->|
1820 +---------+ ---
1821 | | |
1822 | | |
1823 +---------+--+ |
1824 | | |
1825 | | result height
1827 +------------+---------+ |
1828 | | |
1829 | | |
1830 +------------+---------+ --- */
1832 /* Bit indicating that a new matrix will be allocated or has been
1833 allocated. */
1835 #define NEW_LEAF_MATRIX (1 << 0)
1837 /* Bit indicating that a matrix will or has changed its location or
1838 size. */
1840 #define CHANGED_LEAF_MATRIX (1 << 1)
1842 static struct dim
1843 allocate_matrices_for_frame_redisplay (window, x, y, ch_dim,
1844 dim_only_p, window_change_flags)
1845 Lisp_Object window;
1846 int x, y;
1847 struct dim ch_dim;
1848 int dim_only_p;
1849 int *window_change_flags;
1851 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1852 int x0 = x, y0 = y;
1853 int wmax = 0, hmax = 0;
1854 struct dim total;
1855 struct dim dim;
1856 struct window *w;
1857 int in_horz_combination_p;
1859 /* What combination is WINDOW part of? Compute this once since the
1860 result is the same for all windows in the `next' chain. The
1861 special case of a root window (parent equal to nil) is treated
1862 like a vertical combination because a root window's `next'
1863 points to the mini-buffer window, if any, which is arranged
1864 vertically below other windows. */
1865 in_horz_combination_p
1866 = (!NILP (XWINDOW (window)->parent)
1867 && !NILP (XWINDOW (XWINDOW (window)->parent)->hchild));
1869 /* For WINDOW and all windows on the same level. */
1872 w = XWINDOW (window);
1874 /* Get the dimension of the window sub-matrix for W, depending
1875 on whether this a combination or a leaf window. */
1876 if (!NILP (w->hchild))
1877 dim = allocate_matrices_for_frame_redisplay (w->hchild, x, y, ch_dim,
1878 dim_only_p,
1879 window_change_flags);
1880 else if (!NILP (w->vchild))
1881 dim = allocate_matrices_for_frame_redisplay (w->vchild, x, y, ch_dim,
1882 dim_only_p,
1883 window_change_flags);
1884 else
1886 /* If not already done, allocate sub-matrix structures. */
1887 if (w->desired_matrix == NULL)
1889 w->desired_matrix = new_glyph_matrix (f->desired_pool);
1890 w->current_matrix = new_glyph_matrix (f->current_pool);
1891 *window_change_flags |= NEW_LEAF_MATRIX;
1894 /* Width and height MUST be chosen so that there are no
1895 holes in the frame matrix. */
1896 dim.width = XINT (w->width);
1897 dim.height = XINT (w->height);
1899 /* Will matrix be re-allocated? */
1900 if (x != w->desired_matrix->matrix_x
1901 || y != w->desired_matrix->matrix_y
1902 || dim.width != w->desired_matrix->matrix_w
1903 || dim.height != w->desired_matrix->matrix_h
1904 || (margin_glyphs_to_reserve (w, dim.width,
1905 w->right_margin_width)
1906 != w->desired_matrix->left_margin_glyphs)
1907 || (margin_glyphs_to_reserve (w, dim.width,
1908 w->left_margin_width)
1909 != w->desired_matrix->right_margin_glyphs))
1910 *window_change_flags |= CHANGED_LEAF_MATRIX;
1912 /* Actually change matrices, if allowed. Do not consider
1913 CHANGED_LEAF_MATRIX computed above here because the pool
1914 may have been changed which we don't now here. We trust
1915 that we only will be called with DIM_ONLY_P != 0 when
1916 necessary. */
1917 if (!dim_only_p)
1919 adjust_glyph_matrix (w, w->desired_matrix, x, y, dim);
1920 adjust_glyph_matrix (w, w->current_matrix, x, y, dim);
1924 /* If we are part of a horizontal combination, advance x for
1925 windows to the right of W; otherwise advance y for windows
1926 below W. */
1927 if (in_horz_combination_p)
1928 x += dim.width;
1929 else
1930 y += dim.height;
1932 /* Remember maximum glyph matrix dimensions. */
1933 wmax = max (wmax, dim.width);
1934 hmax = max (hmax, dim.height);
1936 /* Next window on same level. */
1937 window = w->next;
1939 while (!NILP (window));
1941 /* Set `total' to the total glyph matrix dimension of this window
1942 level. In a vertical combination, the width is the width of the
1943 widest window; the height is the y we finally reached, corrected
1944 by the y we started with. In a horizontal combination, the total
1945 height is the height of the tallest window, and the width is the
1946 x we finally reached, corrected by the x we started with. */
1947 if (in_horz_combination_p)
1949 total.width = x - x0;
1950 total.height = hmax;
1952 else
1954 total.width = wmax;
1955 total.height = y - y0;
1958 return total;
1962 /* Allocate window matrices for window-based redisplay. W is the
1963 window whose matrices must be allocated/reallocated. CH_DIM is the
1964 size of the smallest character that could potentially be used on W. */
1966 static void
1967 allocate_matrices_for_window_redisplay (w, ch_dim)
1968 struct window *w;
1969 struct dim ch_dim;
1971 struct frame *f = XFRAME (w->frame);
1973 while (w)
1975 if (!NILP (w->vchild))
1976 allocate_matrices_for_window_redisplay (XWINDOW (w->vchild), ch_dim);
1977 else if (!NILP (w->hchild))
1978 allocate_matrices_for_window_redisplay (XWINDOW (w->hchild), ch_dim);
1979 else
1981 /* W is a leaf window. */
1982 int window_pixel_width = XFLOATINT (w->width) * CANON_X_UNIT (f);
1983 int window_pixel_height = window_box_height (w) + abs (w->vscroll);
1984 struct dim dim;
1986 /* If matrices are not yet allocated, allocate them now. */
1987 if (w->desired_matrix == NULL)
1989 w->desired_matrix = new_glyph_matrix (NULL);
1990 w->current_matrix = new_glyph_matrix (NULL);
1993 /* Compute number of glyphs needed in a glyph row. */
1994 dim.width = (((window_pixel_width + ch_dim.width - 1)
1995 / ch_dim.width)
1996 /* 2 partially visible columns in the text area. */
1998 /* One partially visible column at the right
1999 edge of each marginal area. */
2000 + 1 + 1);
2002 /* Compute number of glyph rows needed. */
2003 dim.height = (((window_pixel_height + ch_dim.height - 1)
2004 / ch_dim.height)
2005 /* One partially visible line at the top and
2006 bottom of the window. */
2008 /* 2 for top and mode line. */
2009 + 2);
2011 /* Change matrices. */
2012 adjust_glyph_matrix (w, w->desired_matrix, 0, 0, dim);
2013 adjust_glyph_matrix (w, w->current_matrix, 0, 0, dim);
2016 w = NILP (w->next) ? NULL : XWINDOW (w->next);
2021 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
2022 do it for all frames; otherwise do it just for the given frame.
2023 This function must be called when a new frame is created, its size
2024 changes, or its window configuration changes. */
2026 void
2027 adjust_glyphs (f)
2028 struct frame *f;
2030 /* Block input so that expose events and other events that access
2031 glyph matrices are not processed while we are changing them. */
2032 BLOCK_INPUT;
2034 if (f)
2035 adjust_frame_glyphs (f);
2036 else
2038 Lisp_Object tail, lisp_frame;
2040 FOR_EACH_FRAME (tail, lisp_frame)
2041 adjust_frame_glyphs (XFRAME (lisp_frame));
2044 UNBLOCK_INPUT;
2048 /* Adjust frame glyphs when Emacs is initialized.
2050 To be called from init_display.
2052 We need a glyph matrix because redraw will happen soon.
2053 Unfortunately, window sizes on selected_frame are not yet set to
2054 meaningful values. I believe we can assume that there are only two
2055 windows on the frame---the mini-buffer and the root window. Frame
2056 height and width seem to be correct so far. So, set the sizes of
2057 windows to estimated values. */
2059 static void
2060 adjust_frame_glyphs_initially ()
2062 struct frame *sf = SELECTED_FRAME ();
2063 struct window *root = XWINDOW (sf->root_window);
2064 struct window *mini = XWINDOW (root->next);
2065 int frame_height = FRAME_HEIGHT (sf);
2066 int frame_width = FRAME_WIDTH (sf);
2067 int top_margin = FRAME_TOP_MARGIN (sf);
2069 /* Do it for the root window. */
2070 XSETFASTINT (root->top, top_margin);
2071 XSETFASTINT (root->width, frame_width);
2072 set_window_height (sf->root_window, frame_height - 1 - top_margin, 0);
2074 /* Do it for the mini-buffer window. */
2075 XSETFASTINT (mini->top, frame_height - 1);
2076 XSETFASTINT (mini->width, frame_width);
2077 set_window_height (root->next, 1, 0);
2079 adjust_frame_glyphs (sf);
2080 glyphs_initialized_initially_p = 1;
2084 /* Allocate/reallocate glyph matrices of a single frame F. */
2086 static void
2087 adjust_frame_glyphs (f)
2088 struct frame *f;
2090 if (FRAME_WINDOW_P (f))
2091 adjust_frame_glyphs_for_window_redisplay (f);
2092 else
2093 adjust_frame_glyphs_for_frame_redisplay (f);
2095 /* Don't forget the message buffer and the buffer for
2096 decode_mode_spec. */
2097 adjust_frame_message_buffer (f);
2098 adjust_decode_mode_spec_buffer (f);
2100 f->glyphs_initialized_p = 1;
2104 /* In the window tree with root W, build current matrices of leaf
2105 windows from the frame's current matrix. */
2107 static void
2108 fake_current_matrices (window)
2109 Lisp_Object window;
2111 struct window *w;
2113 for (; !NILP (window); window = w->next)
2115 w = XWINDOW (window);
2117 if (!NILP (w->hchild))
2118 fake_current_matrices (w->hchild);
2119 else if (!NILP (w->vchild))
2120 fake_current_matrices (w->vchild);
2121 else
2123 int i;
2124 struct frame *f = XFRAME (w->frame);
2125 struct glyph_matrix *m = w->current_matrix;
2126 struct glyph_matrix *fm = f->current_matrix;
2128 xassert (m->matrix_h == XFASTINT (w->height));
2129 xassert (m->matrix_w == XFASTINT (w->width));
2131 for (i = 0; i < m->matrix_h; ++i)
2133 struct glyph_row *r = m->rows + i;
2134 struct glyph_row *fr = fm->rows + i + XFASTINT (w->top);
2136 xassert (r->glyphs[TEXT_AREA] >= fr->glyphs[TEXT_AREA]
2137 && r->glyphs[LAST_AREA] <= fr->glyphs[LAST_AREA]);
2139 r->enabled_p = fr->enabled_p;
2140 if (r->enabled_p)
2142 r->used[LEFT_MARGIN_AREA] = m->left_margin_glyphs;
2143 r->used[RIGHT_MARGIN_AREA] = m->right_margin_glyphs;
2144 r->used[TEXT_AREA] = (m->matrix_w
2145 - r->used[LEFT_MARGIN_AREA]
2146 - r->used[RIGHT_MARGIN_AREA]);
2147 r->mode_line_p = 0;
2148 r->inverse_p = fr->inverse_p;
2156 /* Save or restore the contents of frame F's current frame matrix.
2157 SAVE_P non-zero means save it. */
2159 static void
2160 save_or_restore_current_matrix (f, save_p)
2161 struct frame *f;
2162 int save_p;
2164 struct glyph_row *from, *to, *end;
2166 if (save_p)
2168 from = f->current_matrix->rows;
2169 end = from + f->current_matrix->nrows;
2170 to = f->desired_matrix->rows;
2172 else
2174 from = f->desired_matrix->rows;
2175 end = from + f->desired_matrix->nrows;
2176 to = f->current_matrix->rows;
2179 for (; from < end; ++from, ++to)
2181 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2182 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2183 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2188 /* Allocate/reallocate glyph matrices of a single frame F for
2189 frame-based redisplay. */
2191 static void
2192 adjust_frame_glyphs_for_frame_redisplay (f)
2193 struct frame *f;
2195 struct dim ch_dim;
2196 struct dim matrix_dim;
2197 int pool_changed_p;
2198 int window_change_flags;
2199 int top_window_y;
2201 if (!FRAME_LIVE_P (f))
2202 return;
2204 /* Determine the smallest character in any font for F. On
2205 console windows, all characters have dimension (1, 1). */
2206 ch_dim.width = ch_dim.height = 1;
2208 top_window_y = FRAME_TOP_MARGIN (f);
2210 /* Allocate glyph pool structures if not already done. */
2211 if (f->desired_pool == NULL)
2213 f->desired_pool = new_glyph_pool ();
2214 f->current_pool = new_glyph_pool ();
2217 /* Allocate frames matrix structures if needed. */
2218 if (f->desired_matrix == NULL)
2220 f->desired_matrix = new_glyph_matrix (f->desired_pool);
2221 f->current_matrix = new_glyph_matrix (f->current_pool);
2224 /* Compute window glyph matrices. (This takes the mini-buffer
2225 window into account). The result is the size of the frame glyph
2226 matrix needed. The variable window_change_flags is set to a bit
2227 mask indicating whether new matrices will be allocated or
2228 existing matrices change their size or location within the frame
2229 matrix. */
2230 window_change_flags = 0;
2231 matrix_dim
2232 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2233 0, top_window_y,
2234 ch_dim, 1,
2235 &window_change_flags);
2237 /* Add in menu bar lines, if any. */
2238 matrix_dim.height += top_window_y;
2240 /* Enlarge pools as necessary. */
2241 pool_changed_p = realloc_glyph_pool (f->desired_pool, matrix_dim);
2242 realloc_glyph_pool (f->current_pool, matrix_dim);
2244 /* Set up glyph pointers within window matrices. Do this only if
2245 absolutely necessary since it requires a frame redraw. */
2246 if (pool_changed_p || window_change_flags)
2248 /* Do it for window matrices. */
2249 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2250 0, top_window_y, ch_dim, 0,
2251 &window_change_flags);
2253 /* Size of frame matrices must equal size of frame. Note
2254 that we are called for X frames with window widths NOT equal
2255 to the frame width (from CHANGE_FRAME_SIZE_1). */
2256 xassert (matrix_dim.width == FRAME_WIDTH (f)
2257 && matrix_dim.height == FRAME_HEIGHT (f));
2259 /* Resize frame matrices. */
2260 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2262 /* Pointers to glyph memory in glyph rows are exchanged during
2263 the update phase of redisplay, which means in general that a
2264 frame's current matrix consists of pointers into both the
2265 desired and current glyph pool of the frame. Adjusting a
2266 matrix sets the frame matrix up so that pointers are all into
2267 the same pool. If we want to preserve glyph contents of the
2268 current matrix over a call to adjust_glyph_matrix, we must
2269 make a copy of the current glyphs, and restore the current
2270 matrix' contents from that copy. */
2271 if (display_completed
2272 && !FRAME_GARBAGED_P (f)
2273 && matrix_dim.width == f->current_matrix->matrix_w
2274 && matrix_dim.height == f->current_matrix->matrix_h)
2276 save_or_restore_current_matrix (f, 1);
2277 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2278 save_or_restore_current_matrix (f, 0);
2279 fake_current_matrices (FRAME_ROOT_WINDOW (f));
2281 else
2283 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2284 SET_FRAME_GARBAGED (f);
2290 /* Allocate/reallocate glyph matrices of a single frame F for
2291 window-based redisplay. */
2293 static void
2294 adjust_frame_glyphs_for_window_redisplay (f)
2295 struct frame *f;
2297 struct dim ch_dim;
2298 struct window *w;
2300 xassert (FRAME_WINDOW_P (f) && FRAME_LIVE_P (f));
2302 /* Get minimum sizes. */
2303 #ifdef HAVE_WINDOW_SYSTEM
2304 ch_dim.width = FRAME_SMALLEST_CHAR_WIDTH (f);
2305 ch_dim.height = FRAME_SMALLEST_FONT_HEIGHT (f);
2306 #else
2307 ch_dim.width = ch_dim.height = 1;
2308 #endif
2310 /* Allocate/reallocate window matrices. */
2311 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f)),
2312 ch_dim);
2314 /* Allocate/ reallocate matrices of the dummy window used to display
2315 the menu bar under X when no X toolkit support is available. */
2316 #ifndef USE_X_TOOLKIT
2318 /* Allocate a dummy window if not already done. */
2319 if (NILP (f->menu_bar_window))
2321 f->menu_bar_window = make_window ();
2322 w = XWINDOW (f->menu_bar_window);
2323 XSETFRAME (w->frame, f);
2324 w->pseudo_window_p = 1;
2326 else
2327 w = XWINDOW (f->menu_bar_window);
2329 /* Set window dimensions to frame dimensions and allocate or
2330 adjust glyph matrices of W. */
2331 XSETFASTINT (w->top, 0);
2332 XSETFASTINT (w->left, 0);
2333 XSETFASTINT (w->height, FRAME_MENU_BAR_LINES (f));
2334 XSETFASTINT (w->width, FRAME_WINDOW_WIDTH (f));
2335 allocate_matrices_for_window_redisplay (w, ch_dim);
2337 #endif /* not USE_X_TOOLKIT */
2339 /* Allocate/ reallocate matrices of the tool bar window. If we
2340 don't have a tool bar window yet, make one. */
2341 if (NILP (f->tool_bar_window))
2343 f->tool_bar_window = make_window ();
2344 w = XWINDOW (f->tool_bar_window);
2345 XSETFRAME (w->frame, f);
2346 w->pseudo_window_p = 1;
2348 else
2349 w = XWINDOW (f->tool_bar_window);
2351 XSETFASTINT (w->top, FRAME_MENU_BAR_LINES (f));
2352 XSETFASTINT (w->left, 0);
2353 XSETFASTINT (w->height, FRAME_TOOL_BAR_LINES (f));
2354 XSETFASTINT (w->width, FRAME_WINDOW_WIDTH (f));
2355 allocate_matrices_for_window_redisplay (w, ch_dim);
2359 /* Adjust/ allocate message buffer of frame F.
2361 Note that the message buffer is never freed. Since I could not
2362 find a free in 19.34, I assume that freeing it would be
2363 problematic in some way and don't do it either.
2365 (Implementation note: It should be checked if we can free it
2366 eventually without causing trouble). */
2368 static void
2369 adjust_frame_message_buffer (f)
2370 struct frame *f;
2372 int size = FRAME_MESSAGE_BUF_SIZE (f) + 1;
2374 if (FRAME_MESSAGE_BUF (f))
2376 char *buffer = FRAME_MESSAGE_BUF (f);
2377 char *new_buffer = (char *) xrealloc (buffer, size);
2378 FRAME_MESSAGE_BUF (f) = new_buffer;
2380 else
2381 FRAME_MESSAGE_BUF (f) = (char *) xmalloc (size);
2385 /* Re-allocate buffer for decode_mode_spec on frame F. */
2387 static void
2388 adjust_decode_mode_spec_buffer (f)
2389 struct frame *f;
2391 f->decode_mode_spec_buffer
2392 = (char *) xrealloc (f->decode_mode_spec_buffer,
2393 FRAME_MESSAGE_BUF_SIZE (f) + 1);
2398 /**********************************************************************
2399 Freeing Glyph Matrices
2400 **********************************************************************/
2402 /* Free glyph memory for a frame F. F may be null. This function can
2403 be called for the same frame more than once. The root window of
2404 F may be nil when this function is called. This is the case when
2405 the function is called when F is destroyed. */
2407 void
2408 free_glyphs (f)
2409 struct frame *f;
2411 if (f && f->glyphs_initialized_p)
2413 /* Block interrupt input so that we don't get surprised by an X
2414 event while we're in an inconsistent state. */
2415 BLOCK_INPUT;
2416 f->glyphs_initialized_p = 0;
2418 /* Release window sub-matrices. */
2419 if (!NILP (f->root_window))
2420 free_window_matrices (XWINDOW (f->root_window));
2422 /* Free the dummy window for menu bars without X toolkit and its
2423 glyph matrices. */
2424 if (!NILP (f->menu_bar_window))
2426 struct window *w = XWINDOW (f->menu_bar_window);
2427 free_glyph_matrix (w->desired_matrix);
2428 free_glyph_matrix (w->current_matrix);
2429 w->desired_matrix = w->current_matrix = NULL;
2430 f->menu_bar_window = Qnil;
2433 /* Free the tool bar window and its glyph matrices. */
2434 if (!NILP (f->tool_bar_window))
2436 struct window *w = XWINDOW (f->tool_bar_window);
2437 free_glyph_matrix (w->desired_matrix);
2438 free_glyph_matrix (w->current_matrix);
2439 w->desired_matrix = w->current_matrix = NULL;
2440 f->tool_bar_window = Qnil;
2443 /* Release frame glyph matrices. Reset fields to zero in
2444 case we are called a second time. */
2445 if (f->desired_matrix)
2447 free_glyph_matrix (f->desired_matrix);
2448 free_glyph_matrix (f->current_matrix);
2449 f->desired_matrix = f->current_matrix = NULL;
2452 /* Release glyph pools. */
2453 if (f->desired_pool)
2455 free_glyph_pool (f->desired_pool);
2456 free_glyph_pool (f->current_pool);
2457 f->desired_pool = f->current_pool = NULL;
2460 UNBLOCK_INPUT;
2465 /* Free glyph sub-matrices in the window tree rooted at W. This
2466 function may be called with a null pointer, and it may be called on
2467 the same tree more than once. */
2469 void
2470 free_window_matrices (w)
2471 struct window *w;
2473 while (w)
2475 if (!NILP (w->hchild))
2476 free_window_matrices (XWINDOW (w->hchild));
2477 else if (!NILP (w->vchild))
2478 free_window_matrices (XWINDOW (w->vchild));
2479 else
2481 /* This is a leaf window. Free its memory and reset fields
2482 to zero in case this function is called a second time for
2483 W. */
2484 free_glyph_matrix (w->current_matrix);
2485 free_glyph_matrix (w->desired_matrix);
2486 w->current_matrix = w->desired_matrix = NULL;
2489 /* Next window on same level. */
2490 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2495 /* Check glyph memory leaks. This function is called from
2496 shut_down_emacs. Note that frames are not destroyed when Emacs
2497 exits. We therefore free all glyph memory for all active frames
2498 explicitly and check that nothing is left allocated. */
2500 void
2501 check_glyph_memory ()
2503 Lisp_Object tail, frame;
2505 /* Free glyph memory for all frames. */
2506 FOR_EACH_FRAME (tail, frame)
2507 free_glyphs (XFRAME (frame));
2509 /* Check that nothing is left allocated. */
2510 if (glyph_matrix_count)
2511 abort ();
2512 if (glyph_pool_count)
2513 abort ();
2518 /**********************************************************************
2519 Building a Frame Matrix
2520 **********************************************************************/
2522 /* Most of the redisplay code works on glyph matrices attached to
2523 windows. This is a good solution most of the time, but it is not
2524 suitable for terminal code. Terminal output functions cannot rely
2525 on being able to set an arbitrary terminal window. Instead they
2526 must be provided with a view of the whole frame, i.e. the whole
2527 screen. We build such a view by constructing a frame matrix from
2528 window matrices in this section.
2530 Windows that must be updated have their must_be_update_p flag set.
2531 For all such windows, their desired matrix is made part of the
2532 desired frame matrix. For other windows, their current matrix is
2533 made part of the desired frame matrix.
2535 +-----------------+----------------+
2536 | desired | desired |
2537 | | |
2538 +-----------------+----------------+
2539 | current |
2541 +----------------------------------+
2543 Desired window matrices can be made part of the frame matrix in a
2544 cheap way: We exploit the fact that the desired frame matrix and
2545 desired window matrices share their glyph memory. This is not
2546 possible for current window matrices. Their glyphs are copied to
2547 the desired frame matrix. The latter is equivalent to
2548 preserve_other_columns in the old redisplay.
2550 Used glyphs counters for frame matrix rows are the result of adding
2551 up glyph lengths of the window matrices. A line in the frame
2552 matrix is enabled, if a corresponding line in a window matrix is
2553 enabled.
2555 After building the desired frame matrix, it will be passed to
2556 terminal code, which will manipulate both the desired and current
2557 frame matrix. Changes applied to the frame's current matrix have
2558 to be visible in current window matrices afterwards, of course.
2560 This problem is solved like this:
2562 1. Window and frame matrices share glyphs. Window matrices are
2563 constructed in a way that their glyph contents ARE the glyph
2564 contents needed in a frame matrix. Thus, any modification of
2565 glyphs done in terminal code will be reflected in window matrices
2566 automatically.
2568 2. Exchanges of rows in a frame matrix done by terminal code are
2569 intercepted by hook functions so that corresponding row operations
2570 on window matrices can be performed. This is necessary because we
2571 use pointers to glyphs in glyph row structures. To satisfy the
2572 assumption of point 1 above that glyphs are updated implicitly in
2573 window matrices when they are manipulated via the frame matrix,
2574 window and frame matrix must of course agree where to find the
2575 glyphs for their rows. Possible manipulations that must be
2576 mirrored are assignments of rows of the desired frame matrix to the
2577 current frame matrix and scrolling the current frame matrix. */
2579 /* Build frame F's desired matrix from window matrices. Only windows
2580 which have the flag must_be_updated_p set have to be updated. Menu
2581 bar lines of a frame are not covered by window matrices, so make
2582 sure not to touch them in this function. */
2584 static void
2585 build_frame_matrix (f)
2586 struct frame *f;
2588 int i;
2590 /* F must have a frame matrix when this function is called. */
2591 xassert (!FRAME_WINDOW_P (f));
2593 /* Clear all rows in the frame matrix covered by window matrices.
2594 Menu bar lines are not covered by windows. */
2595 for (i = FRAME_TOP_MARGIN (f); i < f->desired_matrix->nrows; ++i)
2596 clear_glyph_row (MATRIX_ROW (f->desired_matrix, i));
2598 /* Build the matrix by walking the window tree. */
2599 build_frame_matrix_from_window_tree (f->desired_matrix,
2600 XWINDOW (FRAME_ROOT_WINDOW (f)));
2604 /* Walk a window tree, building a frame matrix MATRIX from window
2605 matrices. W is the root of a window tree. */
2607 static void
2608 build_frame_matrix_from_window_tree (matrix, w)
2609 struct glyph_matrix *matrix;
2610 struct window *w;
2612 while (w)
2614 if (!NILP (w->hchild))
2615 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->hchild));
2616 else if (!NILP (w->vchild))
2617 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->vchild));
2618 else
2619 build_frame_matrix_from_leaf_window (matrix, w);
2621 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2626 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2627 desired frame matrix built. W is a leaf window whose desired or
2628 current matrix is to be added to FRAME_MATRIX. W's flag
2629 must_be_updated_p determines which matrix it contributes to
2630 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2631 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2632 Adding a desired matrix means setting up used counters and such in
2633 frame rows, while adding a current window matrix to FRAME_MATRIX
2634 means copying glyphs. The latter case corresponds to
2635 preserve_other_columns in the old redisplay. */
2637 static void
2638 build_frame_matrix_from_leaf_window (frame_matrix, w)
2639 struct glyph_matrix *frame_matrix;
2640 struct window *w;
2642 struct glyph_matrix *window_matrix;
2643 int window_y, frame_y;
2644 /* If non-zero, a glyph to insert at the right border of W. */
2645 GLYPH right_border_glyph = 0;
2647 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2648 if (w->must_be_updated_p)
2650 window_matrix = w->desired_matrix;
2652 /* Decide whether we want to add a vertical border glyph. */
2653 if (!WINDOW_RIGHTMOST_P (w))
2655 struct Lisp_Char_Table *dp = window_display_table (w);
2656 right_border_glyph = (dp && INTEGERP (DISP_BORDER_GLYPH (dp))
2657 ? XINT (DISP_BORDER_GLYPH (dp))
2658 : '|');
2661 else
2662 window_matrix = w->current_matrix;
2664 /* For all rows in the window matrix and corresponding rows in the
2665 frame matrix. */
2666 window_y = 0;
2667 frame_y = window_matrix->matrix_y;
2668 while (window_y < window_matrix->nrows)
2670 struct glyph_row *frame_row = frame_matrix->rows + frame_y;
2671 struct glyph_row *window_row = window_matrix->rows + window_y;
2672 int current_row_p = window_matrix == w->current_matrix;
2674 /* Fill up the frame row with spaces up to the left margin of the
2675 window row. */
2676 fill_up_frame_row_with_spaces (frame_row, window_matrix->matrix_x);
2678 /* Fill up areas in the window matrix row with spaces. */
2679 fill_up_glyph_row_with_spaces (window_row);
2681 /* If only part of W's desired matrix has been built, and
2682 window_row wasn't displayed, use the corresponding current
2683 row instead. */
2684 if (window_matrix == w->desired_matrix
2685 && !window_row->enabled_p)
2687 window_row = w->current_matrix->rows + window_y;
2688 current_row_p = 1;
2691 if (current_row_p)
2693 /* Copy window row to frame row. */
2694 bcopy (window_row->glyphs[0],
2695 frame_row->glyphs[TEXT_AREA] + window_matrix->matrix_x,
2696 window_matrix->matrix_w * sizeof (struct glyph));
2698 else
2700 xassert (window_row->enabled_p);
2702 /* Only when a desired row has been displayed, we want
2703 the corresponding frame row to be updated. */
2704 frame_row->enabled_p = 1;
2706 /* Maybe insert a vertical border between horizontally adjacent
2707 windows. */
2708 if (right_border_glyph)
2710 struct glyph *border = window_row->glyphs[LAST_AREA] - 1;
2711 SET_CHAR_GLYPH_FROM_GLYPH (*border, right_border_glyph);
2714 /* Window row window_y must be a slice of frame row
2715 frame_y. */
2716 xassert (glyph_row_slice_p (window_row, frame_row));
2718 /* If rows are in sync, we don't have to copy glyphs because
2719 frame and window share glyphs. */
2721 #if GLYPH_DEBUG
2722 strcpy (w->current_matrix->method, w->desired_matrix->method);
2723 add_window_display_history (w, w->current_matrix->method, 0);
2724 #endif
2727 /* Set number of used glyphs in the frame matrix. Since we fill
2728 up with spaces, and visit leaf windows from left to right it
2729 can be done simply. */
2730 frame_row->used[TEXT_AREA]
2731 = window_matrix->matrix_x + window_matrix->matrix_w;
2733 /* Or in other flags. */
2734 frame_row->inverse_p |= window_row->inverse_p;
2736 /* Next row. */
2737 ++window_y;
2738 ++frame_y;
2743 /* Add spaces to a glyph row ROW in a window matrix.
2745 Each row has the form:
2747 +---------+-----------------------------+------------+
2748 | left | text | right |
2749 +---------+-----------------------------+------------+
2751 Left and right marginal areas are optional. This function adds
2752 spaces to areas so that there are no empty holes between areas.
2753 In other words: If the right area is not empty, the text area
2754 is filled up with spaces up to the right area. If the text area
2755 is not empty, the left area is filled up.
2757 To be called for frame-based redisplay, only. */
2759 static void
2760 fill_up_glyph_row_with_spaces (row)
2761 struct glyph_row *row;
2763 fill_up_glyph_row_area_with_spaces (row, LEFT_MARGIN_AREA);
2764 fill_up_glyph_row_area_with_spaces (row, TEXT_AREA);
2765 fill_up_glyph_row_area_with_spaces (row, RIGHT_MARGIN_AREA);
2769 /* Fill area AREA of glyph row ROW with spaces. To be called for
2770 frame-based redisplay only. */
2772 static void
2773 fill_up_glyph_row_area_with_spaces (row, area)
2774 struct glyph_row *row;
2775 int area;
2777 if (row->glyphs[area] < row->glyphs[area + 1])
2779 struct glyph *end = row->glyphs[area + 1];
2780 struct glyph *text = row->glyphs[area] + row->used[area];
2782 while (text < end)
2783 *text++ = space_glyph;
2784 row->used[area] = text - row->glyphs[area];
2789 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2790 reached. In frame matrices only one area, TEXT_AREA, is used. */
2792 static void
2793 fill_up_frame_row_with_spaces (row, upto)
2794 struct glyph_row *row;
2795 int upto;
2797 int i = row->used[TEXT_AREA];
2798 struct glyph *glyph = row->glyphs[TEXT_AREA];
2800 while (i < upto)
2801 glyph[i++] = space_glyph;
2803 row->used[TEXT_AREA] = i;
2808 /**********************************************************************
2809 Mirroring operations on frame matrices in window matrices
2810 **********************************************************************/
2812 /* Set frame being updated via frame-based redisplay to F. This
2813 function must be called before updates to make explicit that we are
2814 working on frame matrices or not. */
2816 static INLINE void
2817 set_frame_matrix_frame (f)
2818 struct frame *f;
2820 frame_matrix_frame = f;
2824 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2825 DESIRED_MATRIX is the desired matrix corresponding to
2826 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2827 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2828 frame_matrix_frame is non-null, this indicates that the exchange is
2829 done in frame matrices, and that we have to perform analogous
2830 operations in window matrices of frame_matrix_frame. */
2832 static INLINE void
2833 make_current (desired_matrix, current_matrix, row)
2834 struct glyph_matrix *desired_matrix, *current_matrix;
2835 int row;
2837 struct glyph_row *current_row = MATRIX_ROW (current_matrix, row);
2838 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, row);
2839 int mouse_face_p = current_row->mouse_face_p;
2841 /* Do current_row = desired_row. This exchanges glyph pointers
2842 between both rows, and does a structure assignment otherwise. */
2843 assign_row (current_row, desired_row);
2845 /* Enable current_row to mark it as valid. */
2846 current_row->enabled_p = 1;
2847 current_row->mouse_face_p = mouse_face_p;
2849 /* If we are called on frame matrices, perform analogous operations
2850 for window matrices. */
2851 if (frame_matrix_frame)
2852 mirror_make_current (XWINDOW (frame_matrix_frame->root_window), row);
2856 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2857 W's frame which has been made current (by swapping pointers between
2858 current and desired matrix). Perform analogous operations in the
2859 matrices of leaf windows in the window tree rooted at W. */
2861 static void
2862 mirror_make_current (w, frame_row)
2863 struct window *w;
2864 int frame_row;
2866 while (w)
2868 if (!NILP (w->hchild))
2869 mirror_make_current (XWINDOW (w->hchild), frame_row);
2870 else if (!NILP (w->vchild))
2871 mirror_make_current (XWINDOW (w->vchild), frame_row);
2872 else
2874 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2875 here because the checks performed in debug mode there
2876 will not allow the conversion. */
2877 int row = frame_row - w->desired_matrix->matrix_y;
2879 /* If FRAME_ROW is within W, assign the desired row to the
2880 current row (exchanging glyph pointers). */
2881 if (row >= 0 && row < w->desired_matrix->matrix_h)
2883 struct glyph_row *current_row
2884 = MATRIX_ROW (w->current_matrix, row);
2885 struct glyph_row *desired_row
2886 = MATRIX_ROW (w->desired_matrix, row);
2888 if (desired_row->enabled_p)
2889 assign_row (current_row, desired_row);
2890 else
2891 swap_glyph_pointers (desired_row, current_row);
2892 current_row->enabled_p = 1;
2896 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2901 /* Perform row dance after scrolling. We are working on the range of
2902 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2903 including) in MATRIX. COPY_FROM is a vector containing, for each
2904 row I in the range 0 <= I < NLINES, the index of the original line
2905 to move to I. This index is relative to the row range, i.e. 0 <=
2906 index < NLINES. RETAINED_P is a vector containing zero for each
2907 row 0 <= I < NLINES which is empty.
2909 This function is called from do_scrolling and do_direct_scrolling. */
2911 void
2912 mirrored_line_dance (matrix, unchanged_at_top, nlines, copy_from,
2913 retained_p)
2914 struct glyph_matrix *matrix;
2915 int unchanged_at_top, nlines;
2916 int *copy_from;
2917 char *retained_p;
2919 /* A copy of original rows. */
2920 struct glyph_row *old_rows;
2922 /* Rows to assign to. */
2923 struct glyph_row *new_rows = MATRIX_ROW (matrix, unchanged_at_top);
2925 int i;
2927 /* Make a copy of the original rows. */
2928 old_rows = (struct glyph_row *) alloca (nlines * sizeof *old_rows);
2929 bcopy (new_rows, old_rows, nlines * sizeof *old_rows);
2931 /* Assign new rows, maybe clear lines. */
2932 for (i = 0; i < nlines; ++i)
2934 int enabled_before_p = new_rows[i].enabled_p;
2936 xassert (i + unchanged_at_top < matrix->nrows);
2937 xassert (unchanged_at_top + copy_from[i] < matrix->nrows);
2938 new_rows[i] = old_rows[copy_from[i]];
2939 new_rows[i].enabled_p = enabled_before_p;
2941 /* RETAINED_P is zero for empty lines. */
2942 if (!retained_p[copy_from[i]])
2943 new_rows[i].enabled_p = 0;
2946 /* Do the same for window matrices, if MATRIX Is a frame matrix. */
2947 if (frame_matrix_frame)
2948 mirror_line_dance (XWINDOW (frame_matrix_frame->root_window),
2949 unchanged_at_top, nlines, copy_from, retained_p);
2953 /* Synchronize glyph pointers in the current matrix of window W with
2954 the current frame matrix. W must be full-width, and be on a tty
2955 frame. */
2957 static void
2958 sync_window_with_frame_matrix_rows (w)
2959 struct window *w;
2961 struct frame *f = XFRAME (w->frame);
2962 struct glyph_row *window_row, *window_row_end, *frame_row;
2964 /* Preconditions: W must be a leaf window and full-width. Its frame
2965 must have a frame matrix. */
2966 xassert (NILP (w->hchild) && NILP (w->vchild));
2967 xassert (WINDOW_FULL_WIDTH_P (w));
2968 xassert (!FRAME_WINDOW_P (f));
2970 /* If W is a full-width window, glyph pointers in W's current matrix
2971 have, by definition, to be the same as glyph pointers in the
2972 corresponding frame matrix. */
2973 window_row = w->current_matrix->rows;
2974 window_row_end = window_row + w->current_matrix->nrows;
2975 frame_row = f->current_matrix->rows + XFASTINT (w->top);
2976 while (window_row < window_row_end)
2978 int area;
2980 for (area = LEFT_MARGIN_AREA; area <= LAST_AREA; ++area)
2981 window_row->glyphs[area] = frame_row->glyphs[area];
2983 ++window_row, ++frame_row;
2988 /* Return the window in the window tree rooted in W containing frame
2989 row ROW. Value is null if none is found. */
2991 struct window *
2992 frame_row_to_window (w, row)
2993 struct window *w;
2994 int row;
2996 struct window *found = NULL;
2998 while (w && !found)
3000 if (!NILP (w->hchild))
3001 found = frame_row_to_window (XWINDOW (w->hchild), row);
3002 else if (!NILP (w->vchild))
3003 found = frame_row_to_window (XWINDOW (w->vchild), row);
3004 else if (row >= XFASTINT (w->top)
3005 && row < XFASTINT (w->top) + XFASTINT (w->height))
3006 found = w;
3008 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3011 return found;
3015 /* Perform a line dance in the window tree rooted at W, after
3016 scrolling a frame matrix in mirrored_line_dance.
3018 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
3019 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
3020 COPY_FROM is a vector containing, for each row I in the range 0 <=
3021 I < NLINES, the index of the original line to move to I. This
3022 index is relative to the row range, i.e. 0 <= index < NLINES.
3023 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
3024 which is empty. */
3026 static void
3027 mirror_line_dance (w, unchanged_at_top, nlines, copy_from, retained_p)
3028 struct window *w;
3029 int unchanged_at_top, nlines;
3030 int *copy_from;
3031 char *retained_p;
3033 while (w)
3035 if (!NILP (w->hchild))
3036 mirror_line_dance (XWINDOW (w->hchild), unchanged_at_top,
3037 nlines, copy_from, retained_p);
3038 else if (!NILP (w->vchild))
3039 mirror_line_dance (XWINDOW (w->vchild), unchanged_at_top,
3040 nlines, copy_from, retained_p);
3041 else
3043 /* W is a leaf window, and we are working on its current
3044 matrix m. */
3045 struct glyph_matrix *m = w->current_matrix;
3046 int i, sync_p = 0;
3047 struct glyph_row *old_rows;
3049 /* Make a copy of the original rows of matrix m. */
3050 old_rows = (struct glyph_row *) alloca (m->nrows * sizeof *old_rows);
3051 bcopy (m->rows, old_rows, m->nrows * sizeof *old_rows);
3053 for (i = 0; i < nlines; ++i)
3055 /* Frame relative line assigned to. */
3056 int frame_to = i + unchanged_at_top;
3058 /* Frame relative line assigned. */
3059 int frame_from = copy_from[i] + unchanged_at_top;
3061 /* Window relative line assigned to. */
3062 int window_to = frame_to - m->matrix_y;
3064 /* Window relative line assigned. */
3065 int window_from = frame_from - m->matrix_y;
3067 /* Is assigned line inside window? */
3068 int from_inside_window_p
3069 = window_from >= 0 && window_from < m->matrix_h;
3071 /* Is assigned to line inside window? */
3072 int to_inside_window_p
3073 = window_to >= 0 && window_to < m->matrix_h;
3075 if (from_inside_window_p && to_inside_window_p)
3077 /* Enabled setting before assignment. */
3078 int enabled_before_p;
3080 /* Do the assignment. The enabled_p flag is saved
3081 over the assignment because the old redisplay did
3082 that. */
3083 enabled_before_p = m->rows[window_to].enabled_p;
3084 m->rows[window_to] = old_rows[window_from];
3085 m->rows[window_to].enabled_p = enabled_before_p;
3087 /* If frame line is empty, window line is empty, too. */
3088 if (!retained_p[copy_from[i]])
3089 m->rows[window_to].enabled_p = 0;
3091 else if (to_inside_window_p)
3093 /* A copy between windows. This is an infrequent
3094 case not worth optimizing. */
3095 struct frame *f = XFRAME (w->frame);
3096 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3097 struct window *w2;
3098 struct glyph_matrix *m2;
3099 int m2_from;
3101 w2 = frame_row_to_window (root, frame_to);
3102 m2 = w2->current_matrix;
3103 m2_from = frame_from - m2->matrix_y;
3104 copy_row_except_pointers (m->rows + window_to,
3105 m2->rows + m2_from);
3107 /* If frame line is empty, window line is empty, too. */
3108 if (!retained_p[copy_from[i]])
3109 m->rows[window_to].enabled_p = 0;
3110 sync_p = 1;
3112 else if (from_inside_window_p)
3113 sync_p = 1;
3116 /* If there was a copy between windows, make sure glyph
3117 pointers are in sync with the frame matrix. */
3118 if (sync_p)
3119 sync_window_with_frame_matrix_rows (w);
3121 /* Check that no pointers are lost. */
3122 CHECK_MATRIX (m);
3125 /* Next window on same level. */
3126 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3131 #if GLYPH_DEBUG
3133 /* Check that window and frame matrices agree about their
3134 understanding where glyphs of the rows are to find. For each
3135 window in the window tree rooted at W, check that rows in the
3136 matrices of leaf window agree with their frame matrices about
3137 glyph pointers. */
3139 void
3140 check_window_matrix_pointers (w)
3141 struct window *w;
3143 while (w)
3145 if (!NILP (w->hchild))
3146 check_window_matrix_pointers (XWINDOW (w->hchild));
3147 else if (!NILP (w->vchild))
3148 check_window_matrix_pointers (XWINDOW (w->vchild));
3149 else
3151 struct frame *f = XFRAME (w->frame);
3152 check_matrix_pointers (w->desired_matrix, f->desired_matrix);
3153 check_matrix_pointers (w->current_matrix, f->current_matrix);
3156 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3161 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3162 a window and FRAME_MATRIX is the corresponding frame matrix. For
3163 each row in WINDOW_MATRIX check that it's a slice of the
3164 corresponding frame row. If it isn't, abort. */
3166 static void
3167 check_matrix_pointers (window_matrix, frame_matrix)
3168 struct glyph_matrix *window_matrix, *frame_matrix;
3170 /* Row number in WINDOW_MATRIX. */
3171 int i = 0;
3173 /* Row number corresponding to I in FRAME_MATRIX. */
3174 int j = window_matrix->matrix_y;
3176 /* For all rows check that the row in the window matrix is a
3177 slice of the row in the frame matrix. If it isn't we didn't
3178 mirror an operation on the frame matrix correctly. */
3179 while (i < window_matrix->nrows)
3181 if (!glyph_row_slice_p (window_matrix->rows + i,
3182 frame_matrix->rows + j))
3183 abort ();
3184 ++i, ++j;
3188 #endif /* GLYPH_DEBUG != 0 */
3192 /**********************************************************************
3193 VPOS and HPOS translations
3194 **********************************************************************/
3196 #if GLYPH_DEBUG
3198 /* Translate vertical position VPOS which is relative to window W to a
3199 vertical position relative to W's frame. */
3201 static int
3202 window_to_frame_vpos (w, vpos)
3203 struct window *w;
3204 int vpos;
3206 struct frame *f = XFRAME (w->frame);
3208 xassert (!FRAME_WINDOW_P (f));
3209 xassert (vpos >= 0 && vpos <= w->desired_matrix->nrows);
3210 vpos += XFASTINT (w->top);
3211 xassert (vpos >= 0 && vpos <= FRAME_HEIGHT (f));
3212 return vpos;
3216 /* Translate horizontal position HPOS which is relative to window W to
3217 a vertical position relative to W's frame. */
3219 static int
3220 window_to_frame_hpos (w, hpos)
3221 struct window *w;
3222 int hpos;
3224 struct frame *f = XFRAME (w->frame);
3226 xassert (!FRAME_WINDOW_P (f));
3227 hpos += XFASTINT (w->left);
3228 return hpos;
3231 #endif /* GLYPH_DEBUG */
3235 /**********************************************************************
3236 Redrawing Frames
3237 **********************************************************************/
3239 DEFUN ("redraw-frame", Fredraw_frame, Sredraw_frame, 1, 1, 0,
3240 "Clear frame FRAME and output again what is supposed to appear on it.")
3241 (frame)
3242 Lisp_Object frame;
3244 struct frame *f;
3246 CHECK_LIVE_FRAME (frame, 0);
3247 f = XFRAME (frame);
3249 /* Ignore redraw requests, if frame has no glyphs yet.
3250 (Implementation note: It still has to be checked why we are
3251 called so early here). */
3252 if (!glyphs_initialized_initially_p)
3253 return Qnil;
3255 update_begin (f);
3256 if (FRAME_MSDOS_P (f) || FRAME_W32_CONSOLE_P (f))
3257 set_terminal_modes ();
3258 clear_frame ();
3259 clear_current_matrices (f);
3260 update_end (f);
3261 fflush (stdout);
3262 windows_or_buffers_changed++;
3263 /* Mark all windows as inaccurate, so that every window will have
3264 its redisplay done. */
3265 mark_window_display_accurate (FRAME_ROOT_WINDOW (f), 0);
3266 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
3267 f->garbaged = 0;
3268 return Qnil;
3272 /* Redraw frame F. This is nothing more than a call to the Lisp
3273 function redraw-frame. */
3275 void
3276 redraw_frame (f)
3277 struct frame *f;
3279 Lisp_Object frame;
3280 XSETFRAME (frame, f);
3281 Fredraw_frame (frame);
3285 DEFUN ("redraw-display", Fredraw_display, Sredraw_display, 0, 0, "",
3286 "Clear and redisplay all visible frames.")
3289 Lisp_Object tail, frame;
3291 FOR_EACH_FRAME (tail, frame)
3292 if (FRAME_VISIBLE_P (XFRAME (frame)))
3293 Fredraw_frame (frame);
3295 return Qnil;
3299 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3300 visible frames marked as garbaged. */
3302 void
3303 redraw_garbaged_frames ()
3305 Lisp_Object tail, frame;
3307 FOR_EACH_FRAME (tail, frame)
3308 if (FRAME_VISIBLE_P (XFRAME (frame))
3309 && FRAME_GARBAGED_P (XFRAME (frame)))
3310 Fredraw_frame (frame);
3315 /***********************************************************************
3316 Direct Operations
3317 ***********************************************************************/
3319 /* Try to update display and current glyph matrix directly.
3321 This function is called after a character G has been inserted into
3322 current_buffer. It tries to update the current glyph matrix and
3323 perform appropriate screen output to reflect the insertion. If it
3324 succeeds, the global flag redisplay_performed_directly_p will be
3325 set to 1, and thereby prevent the more costly general redisplay
3326 from running (see redisplay_internal).
3328 This function is not called for `hairy' character insertions.
3329 In particular, it is not called when after or before change
3330 functions exist, like they are used by font-lock. See keyboard.c
3331 for details where this function is called. */
3334 direct_output_for_insert (g)
3335 int g;
3337 register struct frame *f = SELECTED_FRAME ();
3338 struct window *w = XWINDOW (selected_window);
3339 struct it it, it2;
3340 struct glyph_row *glyph_row;
3341 struct glyph *glyphs, *glyph, *end;
3342 int n;
3343 /* Non-null means that Redisplay of W is based on window matrices. */
3344 int window_redisplay_p = FRAME_WINDOW_P (f);
3345 /* Non-null means we are in overwrite mode. */
3346 int overwrite_p = !NILP (current_buffer->overwrite_mode);
3347 int added_width;
3348 struct text_pos pos;
3349 int delta, delta_bytes;
3351 /* Not done directly. */
3352 redisplay_performed_directly_p = 0;
3354 /* Quickly give up for some common cases. */
3355 if (cursor_in_echo_area
3356 /* Give up if fonts have changed. */
3357 || fonts_changed_p
3358 /* Give up if face attributes have been changed. */
3359 || face_change_count
3360 /* Give up if cursor position not really known. */
3361 || !display_completed
3362 /* Give up if buffer appears in two places. */
3363 || buffer_shared > 1
3364 /* Give up if currently displaying a message instead of the
3365 minibuffer contents. */
3366 || (EQ (selected_window, minibuf_window)
3367 && EQ (minibuf_window, echo_area_window))
3368 /* Give up for hscrolled mini-buffer because display of the prompt
3369 is handled specially there (see display_line). */
3370 || (MINI_WINDOW_P (w) && XFASTINT (w->hscroll))
3371 /* Give up if overwriting in the middle of a line. */
3372 || (overwrite_p
3373 && PT != ZV
3374 && FETCH_BYTE (PT) != '\n')
3375 /* Give up for tabs and line ends. */
3376 || g == '\t'
3377 || g == '\n'
3378 || g == '\r'
3379 /* Give up if unable to display the cursor in the window. */
3380 || w->cursor.vpos < 0
3381 || (glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos),
3382 /* Can't do it in a continued line because continuation
3383 lines would change. */
3384 (glyph_row->continued_p
3385 /* Can't use this method if the line overlaps others or is
3386 overlapped by others because these other lines would
3387 have to be redisplayed. */
3388 || glyph_row->overlapping_p
3389 || glyph_row->overlapped_p))
3390 /* Can't do it for partial width windows on terminal frames
3391 because we can't clear to eol in such a window. */
3392 || (!window_redisplay_p && !WINDOW_FULL_WIDTH_P (w)))
3393 return 0;
3395 /* Set up a display iterator structure for W. Glyphs will be
3396 produced in scratch_glyph_row. Current position is W's cursor
3397 position. */
3398 clear_glyph_row (&scratch_glyph_row);
3399 SET_TEXT_POS (pos, PT, PT_BYTE);
3400 DEC_TEXT_POS (pos, !NILP (current_buffer->enable_multibyte_characters));
3401 init_iterator (&it, w, CHARPOS (pos), BYTEPOS (pos), &scratch_glyph_row,
3402 DEFAULT_FACE_ID);
3404 glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3405 if (glyph_row->mouse_face_p)
3406 return 0;
3408 /* Give up if highlighting trailing whitespace and we have trailing
3409 whitespace in glyph_row. We would have to remove the trailing
3410 whitespace face in that case. */
3411 if (!NILP (Vshow_trailing_whitespace)
3412 && glyph_row->used[TEXT_AREA])
3414 struct glyph *last;
3416 last = glyph_row->glyphs[TEXT_AREA] + glyph_row->used[TEXT_AREA] - 1;
3417 if (last->type == STRETCH_GLYPH
3418 || (last->type == CHAR_GLYPH
3419 && last->u.ch == ' '))
3420 return 0;
3423 /* Give up if there are overlay strings at pos. This would fail
3424 if the overlay string has newlines in it. */
3425 if (STRINGP (it.string))
3426 return 0;
3428 it.hpos = w->cursor.hpos;
3429 it.vpos = w->cursor.vpos;
3430 it.current_x = w->cursor.x + it.first_visible_x;
3431 it.current_y = w->cursor.y;
3432 it.end_charpos = PT;
3433 it.stop_charpos = min (PT, it.stop_charpos);
3435 /* More than one display element may be returned for PT - 1 if
3436 (i) it's a control character which is translated into `\003' or
3437 `^C', or (ii) it has a display table entry, or (iii) it's a
3438 combination of both. */
3439 delta = delta_bytes = 0;
3440 while (get_next_display_element (&it))
3442 PRODUCE_GLYPHS (&it);
3444 /* Give up if glyph doesn't fit completely on the line. */
3445 if (it.current_x >= it.last_visible_x)
3446 return 0;
3448 /* Give up if new glyph has different ascent or descent than
3449 the original row, or if it is not a character glyph. */
3450 if (glyph_row->ascent != it.ascent
3451 || glyph_row->height != it.ascent + it.descent
3452 || glyph_row->phys_ascent != it.phys_ascent
3453 || glyph_row->phys_height != it.phys_ascent + it.phys_descent
3454 || it.what != IT_CHARACTER)
3455 return 0;
3457 delta += 1;
3458 delta_bytes += it.len;
3459 set_iterator_to_next (&it, 1);
3462 /* Give up if we hit the right edge of the window. We would have
3463 to insert truncation or continuation glyphs. */
3464 added_width = it.current_x - (w->cursor.x + it.first_visible_x);
3465 if (glyph_row->pixel_width + added_width >= it.last_visible_x)
3466 return 0;
3468 /* Give up if there is a \t following in the line. */
3469 it2 = it;
3470 it2.end_charpos = ZV;
3471 it2.stop_charpos = min (it2.stop_charpos, ZV);
3472 while (get_next_display_element (&it2)
3473 && !ITERATOR_AT_END_OF_LINE_P (&it2))
3475 if (it2.c == '\t')
3476 return 0;
3477 set_iterator_to_next (&it2, 1);
3480 /* Number of new glyphs produced. */
3481 n = it.glyph_row->used[TEXT_AREA];
3483 /* Start and end of glyphs in original row. */
3484 glyphs = glyph_row->glyphs[TEXT_AREA] + w->cursor.hpos;
3485 end = glyph_row->glyphs[1 + TEXT_AREA];
3487 /* Make room for new glyphs, then insert them. */
3488 xassert (end - glyphs - n >= 0);
3489 safe_bcopy ((char *) glyphs, (char *) (glyphs + n),
3490 (end - glyphs - n) * sizeof (*end));
3491 bcopy (it.glyph_row->glyphs[TEXT_AREA], glyphs, n * sizeof *glyphs);
3492 glyph_row->used[TEXT_AREA] = min (glyph_row->used[TEXT_AREA] + n,
3493 end - glyph_row->glyphs[TEXT_AREA]);
3495 /* Compute new line width. */
3496 glyph = glyph_row->glyphs[TEXT_AREA];
3497 end = glyph + glyph_row->used[TEXT_AREA];
3498 glyph_row->pixel_width = glyph_row->x;
3499 while (glyph < end)
3501 glyph_row->pixel_width += glyph->pixel_width;
3502 ++glyph;
3505 /* Increment buffer positions for glyphs following the newly
3506 inserted ones. */
3507 for (glyph = glyphs + n; glyph < end; ++glyph)
3508 if (glyph->charpos > 0 && BUFFERP (glyph->object))
3509 glyph->charpos += delta;
3511 if (MATRIX_ROW_END_CHARPOS (glyph_row) > 0)
3513 MATRIX_ROW_END_CHARPOS (glyph_row) += delta;
3514 MATRIX_ROW_END_BYTEPOS (glyph_row) += delta_bytes;
3517 /* Adjust positions in lines following the one we are in. */
3518 increment_matrix_positions (w->current_matrix,
3519 w->cursor.vpos + 1,
3520 w->current_matrix->nrows,
3521 delta, delta_bytes);
3523 glyph_row->contains_overlapping_glyphs_p
3524 |= it.glyph_row->contains_overlapping_glyphs_p;
3526 glyph_row->displays_text_p = 1;
3527 w->window_end_vpos = make_number (max (w->cursor.vpos,
3528 XFASTINT (w->window_end_vpos)));
3530 if (!NILP (Vshow_trailing_whitespace))
3531 highlight_trailing_whitespace (it.f, glyph_row);
3533 /* Write glyphs. If at end of row, we can simply call write_glyphs.
3534 In the middle, we have to insert glyphs. Note that this is now
3535 implemented for X frames. The implementation uses updated_window
3536 and updated_row. */
3537 updated_row = glyph_row;
3538 update_begin (f);
3539 if (rif)
3541 rif->update_window_begin_hook (w);
3543 if (glyphs == end - n)
3544 rif->write_glyphs (glyphs, n);
3545 else
3546 rif->insert_glyphs (glyphs, n);
3548 else
3550 if (glyphs == end - n)
3551 write_glyphs (glyphs, n);
3552 else
3553 insert_glyphs (glyphs, n);
3556 w->cursor.hpos += n;
3557 w->cursor.x = it.current_x - it.first_visible_x;
3558 xassert (w->cursor.hpos >= 0
3559 && w->cursor.hpos < w->desired_matrix->matrix_w);
3561 /* How to set the cursor differs depending on whether we are
3562 using a frame matrix or a window matrix. Note that when
3563 a frame matrix is used, cursor_to expects frame coordinates,
3564 and the X and Y parameters are not used. */
3565 if (window_redisplay_p)
3566 rif->cursor_to (w->cursor.vpos, w->cursor.hpos,
3567 w->cursor.y, w->cursor.x);
3568 else
3570 int x, y;
3571 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3572 + (INTEGERP (w->left_margin_width)
3573 ? XFASTINT (w->left_margin_width)
3574 : 0));
3575 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3576 cursor_to (y, x);
3579 if (rif)
3580 rif->update_window_end_hook (w, 1, 0);
3581 update_end (f);
3582 updated_row = NULL;
3583 fflush (stdout);
3585 TRACE ((stderr, "direct output for insert\n"));
3587 UNCHANGED_MODIFIED = MODIFF;
3588 BEG_UNCHANGED = GPT - BEG;
3589 XSETFASTINT (w->last_point, PT);
3590 w->last_cursor = w->cursor;
3591 XSETFASTINT (w->last_modified, MODIFF);
3592 XSETFASTINT (w->last_overlay_modified, OVERLAY_MODIFF);
3594 redisplay_performed_directly_p = 1;
3595 return 1;
3599 /* Perform a direct display update for moving PT by N positions
3600 left or right. N < 0 means a movement backwards. This function
3601 is currently only called for N == 1 or N == -1. */
3604 direct_output_forward_char (n)
3605 int n;
3607 struct frame *f = SELECTED_FRAME ();
3608 struct window *w = XWINDOW (selected_window);
3609 struct glyph_row *row;
3611 /* Give up if point moved out of or into a composition. */
3612 if (check_point_in_composition (current_buffer, XINT (w->last_point),
3613 current_buffer, PT))
3614 return 0;
3616 /* Give up if face attributes have been changed. */
3617 if (face_change_count)
3618 return 0;
3620 /* Give up if current matrix is not up to date or we are
3621 displaying a message. */
3622 if (!display_completed || cursor_in_echo_area)
3623 return 0;
3625 /* Give up if the buffer's direction is reversed. */
3626 if (!NILP (XBUFFER (w->buffer)->direction_reversed))
3627 return 0;
3629 /* Can't use direct output if highlighting a region. */
3630 if (!NILP (Vtransient_mark_mode) && !NILP (current_buffer->mark_active))
3631 return 0;
3633 /* Can't use direct output if highlighting trailing whitespace. */
3634 if (!NILP (Vshow_trailing_whitespace))
3635 return 0;
3637 /* Give up if we are showing a message or just cleared the message
3638 because we might need to resize the echo area window. */
3639 if (!NILP (echo_area_buffer[0]) || !NILP (echo_area_buffer[1]))
3640 return 0;
3642 /* Give up if currently displaying a message instead of the
3643 minibuffer contents. */
3644 if (XWINDOW (minibuf_window) == w
3645 && EQ (minibuf_window, echo_area_window))
3646 return 0;
3648 /* Give up if we don't know where the cursor is. */
3649 if (w->cursor.vpos < 0)
3650 return 0;
3652 row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3654 /* Give up if PT is outside of the last known cursor row. */
3655 if (PT <= MATRIX_ROW_START_BYTEPOS (row)
3656 || PT >= MATRIX_ROW_END_BYTEPOS (row))
3657 return 0;
3659 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
3661 w->last_cursor = w->cursor;
3662 XSETFASTINT (w->last_point, PT);
3664 xassert (w->cursor.hpos >= 0
3665 && w->cursor.hpos < w->desired_matrix->matrix_w);
3667 if (FRAME_WINDOW_P (f))
3668 rif->cursor_to (w->cursor.vpos, w->cursor.hpos,
3669 w->cursor.y, w->cursor.x);
3670 else
3672 int x, y;
3673 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3674 + (INTEGERP (w->left_margin_width)
3675 ? XFASTINT (w->left_margin_width)
3676 : 0));
3677 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3678 cursor_to (y, x);
3681 fflush (stdout);
3682 redisplay_performed_directly_p = 1;
3683 return 1;
3688 /***********************************************************************
3689 Frame Update
3690 ***********************************************************************/
3692 /* Update frame F based on the data in desired matrices.
3694 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3695 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3696 scrolling.
3698 Value is non-zero if redisplay was stopped due to pending input. */
3701 update_frame (f, force_p, inhibit_hairy_id_p)
3702 struct frame *f;
3703 int force_p;
3704 int inhibit_hairy_id_p;
3706 /* 1 means display has been paused because of pending input. */
3707 int paused_p;
3708 struct window *root_window = XWINDOW (f->root_window);
3710 if (FRAME_WINDOW_P (f))
3712 /* We are working on window matrix basis. All windows whose
3713 flag must_be_updated_p is set have to be updated. */
3715 /* Record that we are not working on frame matrices. */
3716 set_frame_matrix_frame (NULL);
3718 /* Update all windows in the window tree of F, maybe stopping
3719 when pending input is detected. */
3720 update_begin (f);
3722 /* Update the menu bar on X frames that don't have toolkit
3723 support. */
3724 if (WINDOWP (f->menu_bar_window))
3725 update_window (XWINDOW (f->menu_bar_window), 1);
3727 /* Update the tool-bar window, if present. */
3728 if (WINDOWP (f->tool_bar_window))
3730 Lisp_Object tem;
3731 struct window *w = XWINDOW (f->tool_bar_window);
3733 /* Update tool-bar window. */
3734 if (w->must_be_updated_p)
3736 update_window (w, 1);
3737 w->must_be_updated_p = 0;
3739 /* Swap tool-bar strings. We swap because we want to
3740 reuse strings. */
3741 tem = f->current_tool_bar_string;
3742 f->current_tool_bar_string = f->desired_tool_bar_string;
3743 f->desired_tool_bar_string = tem;
3748 /* Update windows. */
3749 paused_p = update_window_tree (root_window, force_p);
3750 update_end (f);
3752 #if 0 /* This flush is a performance bottleneck under X,
3753 and it doesn't seem to be necessary anyway. */
3754 rif->flush_display (f);
3755 #endif
3757 else
3759 /* We are working on frame matrix basis. Set the frame on whose
3760 frame matrix we operate. */
3761 set_frame_matrix_frame (f);
3763 /* Build F's desired matrix from window matrices. */
3764 build_frame_matrix (f);
3766 /* Update the display */
3767 update_begin (f);
3768 paused_p = update_frame_1 (f, force_p, inhibit_hairy_id_p);
3769 update_end (f);
3771 if (termscript)
3772 fflush (termscript);
3773 fflush (stdout);
3775 /* Check window matrices for lost pointers. */
3776 #if GLYPH_DEBUG
3777 check_window_matrix_pointers (root_window);
3778 add_frame_display_history (f, paused_p);
3779 #endif
3782 /* Reset flags indicating that a window should be updated. */
3783 set_window_update_flags (root_window, 0);
3785 display_completed = !paused_p;
3786 return paused_p;
3791 /************************************************************************
3792 Window-based updates
3793 ************************************************************************/
3795 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3796 don't stop updating when input is pending. */
3798 static int
3799 update_window_tree (w, force_p)
3800 struct window *w;
3801 int force_p;
3803 int paused_p = 0;
3805 while (w && !paused_p)
3807 if (!NILP (w->hchild))
3808 paused_p |= update_window_tree (XWINDOW (w->hchild), force_p);
3809 else if (!NILP (w->vchild))
3810 paused_p |= update_window_tree (XWINDOW (w->vchild), force_p);
3811 else if (w->must_be_updated_p)
3812 paused_p |= update_window (w, force_p);
3814 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3817 return paused_p;
3821 /* Update window W if its flag must_be_updated_p is non-zero. If
3822 FORCE_P is non-zero, don't stop updating if input is pending. */
3824 void
3825 update_single_window (w, force_p)
3826 struct window *w;
3827 int force_p;
3829 if (w->must_be_updated_p)
3831 struct frame *f = XFRAME (WINDOW_FRAME (w));
3833 /* Record that this is not a frame-based redisplay. */
3834 set_frame_matrix_frame (NULL);
3836 /* Update W. */
3837 update_begin (f);
3838 update_window (w, force_p);
3839 update_end (f);
3841 /* Reset flag in W. */
3842 w->must_be_updated_p = 0;
3847 /* Redraw lines from the current matrix of window W that are
3848 overlapped by other rows. YB is bottom-most y-position in W. */
3850 static void
3851 redraw_overlapped_rows (w, yb)
3852 struct window *w;
3853 int yb;
3855 int i;
3857 /* If rows overlapping others have been changed, the rows being
3858 overlapped have to be redrawn. This won't draw lines that have
3859 already been drawn in update_window_line because overlapped_p in
3860 desired rows is 0, so after row assignment overlapped_p in
3861 current rows is 0. */
3862 for (i = 0; i < w->current_matrix->nrows; ++i)
3864 struct glyph_row *row = w->current_matrix->rows + i;
3866 if (!row->enabled_p)
3867 break;
3868 else if (row->mode_line_p)
3869 continue;
3871 if (row->overlapped_p)
3873 enum glyph_row_area area;
3875 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
3877 updated_row = row;
3878 updated_area = area;
3879 rif->cursor_to (i, 0, row->y, area == TEXT_AREA ? row->x : 0);
3880 if (row->used[area])
3881 rif->write_glyphs (row->glyphs[area], row->used[area]);
3882 rif->clear_end_of_line (-1);
3885 row->overlapped_p = 0;
3888 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
3889 break;
3894 /* Redraw lines from the current matrix of window W that overlap
3895 others. YB is bottom-most y-position in W. */
3897 static void
3898 redraw_overlapping_rows (w, yb)
3899 struct window *w;
3900 int yb;
3902 int i, bottom_y;
3903 struct glyph_row *row;
3905 for (i = 0; i < w->current_matrix->nrows; ++i)
3907 row = w->current_matrix->rows + i;
3909 if (!row->enabled_p)
3910 break;
3911 else if (row->mode_line_p)
3912 continue;
3914 bottom_y = MATRIX_ROW_BOTTOM_Y (row);
3916 if (row->overlapping_p && i > 0 && bottom_y < yb)
3918 if (row->used[LEFT_MARGIN_AREA])
3919 rif->fix_overlapping_area (w, row, LEFT_MARGIN_AREA);
3921 if (row->used[TEXT_AREA])
3922 rif->fix_overlapping_area (w, row, TEXT_AREA);
3924 if (row->used[RIGHT_MARGIN_AREA])
3925 rif->fix_overlapping_area (w, row, RIGHT_MARGIN_AREA);
3927 /* Record in neighbor rows that ROW overwrites part of their
3928 display. */
3929 if (row->phys_ascent > row->ascent && i > 0)
3930 MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p = 1;
3931 if ((row->phys_height - row->phys_ascent
3932 > row->height - row->ascent)
3933 && bottom_y < yb)
3934 MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p = 1;
3937 if (bottom_y >= yb)
3938 break;
3943 #ifdef GLYPH_DEBUG
3945 /* Check that no row in the current matrix of window W is enabled
3946 which is below what's displayed in the window. */
3948 void
3949 check_current_matrix_flags (w)
3950 struct window *w;
3952 int last_seen_p = 0;
3953 int i, yb = window_text_bottom_y (w);
3955 for (i = 0; i < w->current_matrix->nrows - 1; ++i)
3957 struct glyph_row *row = MATRIX_ROW (w->current_matrix, i);
3958 if (!last_seen_p && MATRIX_ROW_BOTTOM_Y (row) >= yb)
3959 last_seen_p = 1;
3960 else if (last_seen_p && row->enabled_p)
3961 abort ();
3965 #endif /* GLYPH_DEBUG */
3968 /* Update display of window W. FORCE_P non-zero means that we should
3969 not stop when detecting pending input. */
3971 static int
3972 update_window (w, force_p)
3973 struct window *w;
3974 int force_p;
3976 struct glyph_matrix *desired_matrix = w->desired_matrix;
3977 int paused_p;
3978 int preempt_count = baud_rate / 2400 + 1;
3979 extern int input_pending;
3980 extern Lisp_Object do_mouse_tracking;
3981 #if GLYPH_DEBUG
3982 struct frame *f = XFRAME (WINDOW_FRAME (w));
3983 extern struct frame *updating_frame;
3984 #endif
3986 /* Check that W's frame doesn't have glyph matrices. */
3987 xassert (FRAME_WINDOW_P (f));
3988 xassert (updating_frame != NULL);
3990 /* Check pending input the first time so that we can quickly return. */
3991 if (redisplay_dont_pause)
3992 force_p = 1;
3993 else
3994 detect_input_pending ();
3996 /* If forced to complete the update, or if no input is pending, do
3997 the update. */
3998 if (force_p || !input_pending || !NILP (do_mouse_tracking))
4000 struct glyph_row *row, *end;
4001 struct glyph_row *mode_line_row;
4002 struct glyph_row *header_line_row = NULL;
4003 int yb, changed_p = 0, mouse_face_overwritten_p = 0, n_updated;
4005 rif->update_window_begin_hook (w);
4006 yb = window_text_bottom_y (w);
4008 /* If window has a top line, update it before everything else.
4009 Adjust y-positions of other rows by the top line height. */
4010 row = desired_matrix->rows;
4011 end = row + desired_matrix->nrows - 1;
4012 if (row->mode_line_p)
4013 header_line_row = row++;
4015 /* Update the mode line, if necessary. */
4016 mode_line_row = MATRIX_MODE_LINE_ROW (desired_matrix);
4017 if (mode_line_row->mode_line_p && mode_line_row->enabled_p)
4019 mode_line_row->y = yb;
4020 update_window_line (w, MATRIX_ROW_VPOS (mode_line_row,
4021 desired_matrix),
4022 &mouse_face_overwritten_p);
4023 changed_p = 1;
4026 /* Find first enabled row. Optimizations in redisplay_internal
4027 may lead to an update with only one row enabled. There may
4028 be also completely empty matrices. */
4029 while (row < end && !row->enabled_p)
4030 ++row;
4032 /* Try reusing part of the display by copying. */
4033 if (row < end && !desired_matrix->no_scrolling_p)
4035 int rc = scrolling_window (w, header_line_row != NULL);
4036 if (rc < 0)
4038 /* All rows were found to be equal. */
4039 paused_p = 0;
4040 goto set_cursor;
4042 else if (rc > 0)
4043 force_p = 1;
4044 changed_p = 1;
4047 /* Update the top mode line after scrolling because a new top
4048 line would otherwise overwrite lines at the top of the window
4049 that can be scrolled. */
4050 if (header_line_row && header_line_row->enabled_p)
4052 header_line_row->y = 0;
4053 update_window_line (w, 0, &mouse_face_overwritten_p);
4054 changed_p = 1;
4057 /* Update the rest of the lines. */
4058 for (n_updated = 0; row < end && (force_p || !input_pending); ++row)
4059 if (row->enabled_p)
4061 int vpos = MATRIX_ROW_VPOS (row, desired_matrix);
4062 int i;
4064 /* We'll Have to play a little bit with when to
4065 detect_input_pending. If it's done too often,
4066 scrolling large windows with repeated scroll-up
4067 commands will too quickly pause redisplay. */
4068 if (!force_p && ++n_updated % preempt_count == 0)
4069 detect_input_pending ();
4071 changed_p |= update_window_line (w, vpos,
4072 &mouse_face_overwritten_p);
4074 /* Mark all rows below the last visible one in the current
4075 matrix as invalid. This is necessary because of
4076 variable line heights. Consider the case of three
4077 successive redisplays, where the first displays 5
4078 lines, the second 3 lines, and the third 5 lines again.
4079 If the second redisplay wouldn't mark rows in the
4080 current matrix invalid, the third redisplay might be
4081 tempted to optimize redisplay based on lines displayed
4082 in the first redisplay. */
4083 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4084 for (i = vpos + 1; i < w->current_matrix->nrows - 1; ++i)
4085 MATRIX_ROW (w->current_matrix, i)->enabled_p = 0;
4088 /* Was display preempted? */
4089 paused_p = row < end;
4091 set_cursor:
4093 /* Fix the appearance of overlapping(overlapped rows. */
4094 if (!paused_p && !w->pseudo_window_p)
4096 if (changed_p && rif->fix_overlapping_area)
4098 redraw_overlapped_rows (w, yb);
4099 redraw_overlapping_rows (w, yb);
4102 /* Make cursor visible at cursor position of W. */
4103 set_window_cursor_after_update (w);
4105 #if 0 /* Check that current matrix invariants are satisfied. This is
4106 for debugging only. See the comment of check_matrix_invariants. */
4107 IF_DEBUG (check_matrix_invariants (w));
4108 #endif
4111 #if GLYPH_DEBUG
4112 /* Remember the redisplay method used to display the matrix. */
4113 strcpy (w->current_matrix->method, w->desired_matrix->method);
4114 #endif
4116 /* End of update of window W. */
4117 rif->update_window_end_hook (w, 1, mouse_face_overwritten_p);
4119 else
4120 paused_p = 1;
4122 #if GLYPH_DEBUG
4123 /* check_current_matrix_flags (w); */
4124 add_window_display_history (w, w->current_matrix->method, paused_p);
4125 #endif
4127 clear_glyph_matrix (desired_matrix);
4129 return paused_p;
4133 /* Update the display of area AREA in window W, row number VPOS.
4134 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
4136 static void
4137 update_marginal_area (w, area, vpos)
4138 struct window *w;
4139 int area, vpos;
4141 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4143 /* Let functions in xterm.c know what area subsequent X positions
4144 will be relative to. */
4145 updated_area = area;
4147 /* Set cursor to start of glyphs, write them, and clear to the end
4148 of the area. I don't think that something more sophisticated is
4149 necessary here, since marginal areas will not be the default. */
4150 rif->cursor_to (vpos, 0, desired_row->y, 0);
4151 if (desired_row->used[area])
4152 rif->write_glyphs (desired_row->glyphs[area], desired_row->used[area]);
4153 rif->clear_end_of_line (-1);
4157 /* Update the display of the text area of row VPOS in window W.
4158 Value is non-zero if display has changed. */
4160 static int
4161 update_text_area (w, vpos)
4162 struct window *w;
4163 int vpos;
4165 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4166 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4167 int changed_p = 0;
4169 /* Let functions in xterm.c know what area subsequent X positions
4170 will be relative to. */
4171 updated_area = TEXT_AREA;
4173 /* If rows are at different X or Y, or rows have different height,
4174 or the current row is marked invalid, write the entire line. */
4175 if (!current_row->enabled_p
4176 || desired_row->y != current_row->y
4177 || desired_row->ascent != current_row->ascent
4178 || desired_row->phys_ascent != current_row->phys_ascent
4179 || desired_row->phys_height != current_row->phys_height
4180 || desired_row->visible_height != current_row->visible_height
4181 || current_row->overlapped_p
4182 || current_row->mouse_face_p
4183 || current_row->x != desired_row->x)
4185 rif->cursor_to (vpos, 0, desired_row->y, desired_row->x);
4187 if (desired_row->used[TEXT_AREA])
4188 rif->write_glyphs (desired_row->glyphs[TEXT_AREA],
4189 desired_row->used[TEXT_AREA]);
4191 /* Clear to end of window. */
4192 rif->clear_end_of_line (-1);
4193 changed_p = 1;
4195 else
4197 int stop, i, x;
4198 struct glyph *current_glyph = current_row->glyphs[TEXT_AREA];
4199 struct glyph *desired_glyph = desired_row->glyphs[TEXT_AREA];
4200 int overlapping_glyphs_p = current_row->contains_overlapping_glyphs_p;
4202 /* If the desired row extends its face to the text area end,
4203 make sure we write at least one glyph, so that the face
4204 extension actually takes place. */
4205 int desired_stop_pos = (desired_row->used[TEXT_AREA]
4206 - (MATRIX_ROW_EXTENDS_FACE_P (desired_row)
4207 ? 1 : 0));
4209 stop = min (current_row->used[TEXT_AREA], desired_stop_pos);
4210 i = 0;
4211 x = desired_row->x;
4213 while (i < stop)
4215 int can_skip_p = 1;
4217 /* Skip over glyphs that both rows have in common. These
4218 don't have to be written. We can't skip if the last
4219 current glyph overlaps the glyph to its right. For
4220 example, consider a current row of `if ' with the `f' in
4221 Courier bold so that it overlaps the ` ' to its right.
4222 If the desired row is ` ', we would skip over the space
4223 after the `if' and there would remain a pixel from the
4224 `f' on the screen. */
4225 if (overlapping_glyphs_p && i > 0)
4227 struct glyph *glyph = &current_row->glyphs[TEXT_AREA][i - 1];
4228 int left, right;
4230 rif->get_glyph_overhangs (glyph, XFRAME (w->frame),
4231 &left, &right);
4232 can_skip_p = right == 0;
4235 if (can_skip_p)
4237 while (i < stop
4238 && GLYPH_EQUAL_P (desired_glyph, current_glyph))
4240 x += desired_glyph->pixel_width;
4241 ++desired_glyph, ++current_glyph, ++i;
4244 /* Consider the case that the current row contains "xxx
4245 ppp ggg" in italic Courier font, and the desired row
4246 is "xxx ggg". The character `p' has lbearing, `g'
4247 has not. The loop above will stop in front of the
4248 first `p' in the current row. If we would start
4249 writing glyphs there, we wouldn't erase the lbearing
4250 of the `p'. The rest of the lbearing problem is then
4251 taken care of by x_draw_glyphs. */
4252 if (overlapping_glyphs_p
4253 && i > 0
4254 && i < current_row->used[TEXT_AREA]
4255 && (current_row->used[TEXT_AREA]
4256 != desired_row->used[TEXT_AREA]))
4258 int left, right;
4260 rif->get_glyph_overhangs (current_glyph, XFRAME (w->frame),
4261 &left, &right);
4262 while (left > 0 && i > 0)
4264 --i, --desired_glyph, --current_glyph;
4265 x -= desired_glyph->pixel_width;
4266 left -= desired_glyph->pixel_width;
4271 /* Try to avoid writing the entire rest of the desired row
4272 by looking for a resync point. This mainly prevents
4273 mode line flickering in the case the mode line is in
4274 fixed-pitch font, which it usually will be. */
4275 if (i < desired_row->used[TEXT_AREA])
4277 int start_x = x, start_hpos = i;
4278 struct glyph *start = desired_glyph;
4279 int current_x = x;
4280 int skip_first_p = !can_skip_p;
4282 /* Find the next glyph that's equal again. */
4283 while (i < stop
4284 && (skip_first_p
4285 || !GLYPH_EQUAL_P (desired_glyph, current_glyph))
4286 && x == current_x)
4288 x += desired_glyph->pixel_width;
4289 current_x += current_glyph->pixel_width;
4290 ++desired_glyph, ++current_glyph, ++i;
4291 skip_first_p = 0;
4294 if (i == start_hpos || x != current_x)
4296 i = start_hpos;
4297 x = start_x;
4298 desired_glyph = start;
4299 break;
4302 rif->cursor_to (vpos, start_hpos, desired_row->y, start_x);
4303 rif->write_glyphs (start, i - start_hpos);
4304 changed_p = 1;
4308 /* Write the rest. */
4309 if (i < desired_row->used[TEXT_AREA])
4311 rif->cursor_to (vpos, i, desired_row->y, x);
4312 rif->write_glyphs (desired_glyph, desired_row->used[TEXT_AREA] - i);
4313 changed_p = 1;
4316 /* Maybe clear to end of line. */
4317 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row))
4319 /* If new row extends to the end of the text area, nothing
4320 has to be cleared, if and only if we did a write_glyphs
4321 above. This is made sure by setting desired_stop_pos
4322 appropriately above. */
4323 xassert (i < desired_row->used[TEXT_AREA]);
4325 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row))
4327 /* If old row extends to the end of the text area, clear. */
4328 if (i >= desired_row->used[TEXT_AREA])
4329 rif->cursor_to (vpos, i, desired_row->y,
4330 desired_row->x + desired_row->pixel_width);
4331 rif->clear_end_of_line (-1);
4332 changed_p = 1;
4334 else if (desired_row->pixel_width < current_row->pixel_width)
4336 /* Otherwise clear to the end of the old row. Everything
4337 after that position should be clear already. */
4338 int x;
4340 if (i >= desired_row->used[TEXT_AREA])
4341 rif->cursor_to (vpos, i, desired_row->y,
4342 desired_row->x + desired_row->pixel_width);
4344 /* If cursor is displayed at the end of the line, make sure
4345 it's cleared. Nowadays we don't have a phys_cursor_glyph
4346 with which to erase the cursor (because this method
4347 doesn't work with lbearing/rbearing), so we must do it
4348 this way. */
4349 if (vpos == w->phys_cursor.vpos
4350 && w->phys_cursor.hpos >= desired_row->used[TEXT_AREA])
4352 w->phys_cursor_on_p = 0;
4353 x = -1;
4355 else
4356 x = current_row->x + current_row->pixel_width;
4357 rif->clear_end_of_line (x);
4358 changed_p = 1;
4362 return changed_p;
4366 /* Update row VPOS in window W. Value is non-zero if display has been
4367 changed. */
4369 static int
4370 update_window_line (w, vpos, mouse_face_overwritten_p)
4371 struct window *w;
4372 int vpos, *mouse_face_overwritten_p;
4374 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4375 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4376 int changed_p = 0;
4378 /* Set the row being updated. This is important to let xterm.c
4379 know what line height values are in effect. */
4380 updated_row = desired_row;
4382 /* A row can be completely invisible in case a desired matrix was
4383 built with a vscroll and then make_cursor_line_fully_visible shifts
4384 the matrix. Make sure to make such rows current anyway, since
4385 we need the correct y-position, for example, in the current matrix. */
4386 if (desired_row->mode_line_p
4387 || desired_row->visible_height > 0)
4389 xassert (desired_row->enabled_p);
4391 /* Update display of the left margin area, if there is one. */
4392 if (!desired_row->full_width_p
4393 && !NILP (w->left_margin_width))
4395 changed_p = 1;
4396 update_marginal_area (w, LEFT_MARGIN_AREA, vpos);
4399 /* Update the display of the text area. */
4400 if (update_text_area (w, vpos))
4402 changed_p = 1;
4403 if (current_row->mouse_face_p)
4404 *mouse_face_overwritten_p = 1;
4407 /* Update display of the right margin area, if there is one. */
4408 if (!desired_row->full_width_p
4409 && !NILP (w->right_margin_width))
4411 changed_p = 1;
4412 update_marginal_area (w, RIGHT_MARGIN_AREA, vpos);
4415 /* Draw truncation marks etc. */
4416 if (!current_row->enabled_p
4417 || desired_row->y != current_row->y
4418 || desired_row->visible_height != current_row->visible_height
4419 || desired_row->overlay_arrow_p != current_row->overlay_arrow_p
4420 || desired_row->truncated_on_left_p != current_row->truncated_on_left_p
4421 || desired_row->truncated_on_right_p != current_row->truncated_on_right_p
4422 || desired_row->continued_p != current_row->continued_p
4423 || desired_row->mode_line_p != current_row->mode_line_p
4424 || (desired_row->indicate_empty_line_p
4425 != current_row->indicate_empty_line_p)
4426 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row)
4427 != MATRIX_ROW_CONTINUATION_LINE_P (current_row)))
4428 rif->after_update_window_line_hook (desired_row);
4431 /* Update current_row from desired_row. */
4432 make_current (w->desired_matrix, w->current_matrix, vpos);
4433 updated_row = NULL;
4434 return changed_p;
4438 /* Set the cursor after an update of window W. This function may only
4439 be called from update_window. */
4441 static void
4442 set_window_cursor_after_update (w)
4443 struct window *w;
4445 struct frame *f = XFRAME (w->frame);
4446 int cx, cy, vpos, hpos;
4448 /* Not intended for frame matrix updates. */
4449 xassert (FRAME_WINDOW_P (f));
4451 if (cursor_in_echo_area
4452 && !NILP (echo_area_buffer[0])
4453 /* If we are showing a message instead of the mini-buffer,
4454 show the cursor for the message instead. */
4455 && XWINDOW (minibuf_window) == w
4456 && EQ (minibuf_window, echo_area_window)
4457 /* These cases apply only to the frame that contains
4458 the active mini-buffer window. */
4459 && FRAME_HAS_MINIBUF_P (f)
4460 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
4462 cx = cy = vpos = hpos = 0;
4464 if (cursor_in_echo_area >= 0)
4466 /* If the mini-buffer is several lines high, find the last
4467 line that has any text on it. Note: either all lines
4468 are enabled or none. Otherwise we wouldn't be able to
4469 determine Y. */
4470 struct glyph_row *row, *last_row;
4471 struct glyph *glyph;
4472 int yb = window_text_bottom_y (w);
4474 last_row = NULL;
4475 for (row = MATRIX_ROW (w->current_matrix, 0);
4476 row->enabled_p;
4477 ++row)
4479 if (row->used[TEXT_AREA]
4480 && row->glyphs[TEXT_AREA][0].charpos >= 0)
4481 last_row = row;
4483 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4484 break;
4487 if (last_row)
4489 struct glyph *start = row->glyphs[TEXT_AREA];
4490 struct glyph *last = start + row->used[TEXT_AREA] - 1;
4492 while (last > start && last->charpos < 0)
4493 --last;
4495 for (glyph = start; glyph < last; ++glyph)
4497 cx += glyph->pixel_width;
4498 ++hpos;
4501 cy = last_row->y;
4502 vpos = MATRIX_ROW_VPOS (last_row, w->current_matrix);
4506 else
4508 cx = w->cursor.x;
4509 cy = w->cursor.y;
4510 hpos = w->cursor.hpos;
4511 vpos = w->cursor.vpos;
4514 /* Window cursor can be out of sync for horizontally split windows. */
4515 hpos = max (0, hpos);
4516 hpos = min (w->current_matrix->matrix_w - 1, hpos);
4517 vpos = max (0, vpos);
4518 vpos = min (w->current_matrix->nrows - 1, vpos);
4519 rif->cursor_to (vpos, hpos, cy, cx);
4523 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4524 tree rooted at W. */
4526 void
4527 set_window_update_flags (w, on_p)
4528 struct window *w;
4529 int on_p;
4531 while (w)
4533 if (!NILP (w->hchild))
4534 set_window_update_flags (XWINDOW (w->hchild), on_p);
4535 else if (!NILP (w->vchild))
4536 set_window_update_flags (XWINDOW (w->vchild), on_p);
4537 else
4538 w->must_be_updated_p = on_p;
4540 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4546 /***********************************************************************
4547 Window-Based Scrolling
4548 ***********************************************************************/
4550 /* Structure describing rows in scrolling_window. */
4552 struct row_entry
4554 /* Number of occurrences of this row in desired and current matrix. */
4555 int old_uses, new_uses;
4557 /* Vpos of row in new matrix. */
4558 int new_line_number;
4560 /* Bucket index of this row_entry in the hash table row_table. */
4561 int bucket;
4563 /* The row described by this entry. */
4564 struct glyph_row *row;
4566 /* Hash collision chain. */
4567 struct row_entry *next;
4570 /* A pool to allocate row_entry structures from, and the size of the
4571 pool. The pool is reallocated in scrolling_window when we find
4572 that we need a larger one. */
4574 static struct row_entry *row_entry_pool;
4575 static int row_entry_pool_size;
4577 /* Index of next free entry in row_entry_pool. */
4579 static int row_entry_idx;
4581 /* The hash table used during scrolling, and the table's size. This
4582 table is used to quickly identify equal rows in the desired and
4583 current matrix. */
4585 static struct row_entry **row_table;
4586 static int row_table_size;
4588 /* Vectors of pointers to row_entry structures belonging to the
4589 current and desired matrix, and the size of the vectors. */
4591 static struct row_entry **old_lines, **new_lines;
4592 static int old_lines_size, new_lines_size;
4594 /* A pool to allocate run structures from, and its size. */
4596 static struct run *run_pool;
4597 static int runs_size;
4599 /* A vector of runs of lines found during scrolling. */
4601 static struct run **runs;
4603 static struct row_entry *add_row_entry P_ ((struct window *,
4604 struct glyph_row *));
4607 /* Add glyph row ROW to the scrolling hash table during the scrolling
4608 of window W. */
4610 static INLINE struct row_entry *
4611 add_row_entry (w, row)
4612 struct window *w;
4613 struct glyph_row *row;
4615 struct row_entry *entry;
4616 int i = row->hash % row_table_size;
4618 entry = row_table[i];
4619 while (entry && !row_equal_p (w, entry->row, row, 1))
4620 entry = entry->next;
4622 if (entry == NULL)
4624 entry = row_entry_pool + row_entry_idx++;
4625 entry->row = row;
4626 entry->old_uses = entry->new_uses = 0;
4627 entry->new_line_number = 0;
4628 entry->bucket = i;
4629 entry->next = row_table[i];
4630 row_table[i] = entry;
4633 return entry;
4637 /* Try to reuse part of the current display of W by scrolling lines.
4638 HEADER_LINE_P non-zero means W has a top mode line.
4640 The algorithm is taken from Communications of the ACM, Apr78 "A
4641 Technique for Isolating Differences Between Files." It should take
4642 O(N) time.
4644 A short outline of the steps of the algorithm
4646 1. Skip lines equal at the start and end of both matrices.
4648 2. Enter rows in the current and desired matrix into a symbol
4649 table, counting how often they appear in both matrices.
4651 3. Rows that appear exactly once in both matrices serve as anchors,
4652 i.e. we assume that such lines are likely to have been moved.
4654 4. Starting from anchor lines, extend regions to be scrolled both
4655 forward and backward.
4657 Value is
4659 -1 if all rows were found to be equal.
4660 0 to indicate that we did not scroll the display, or
4661 1 if we did scroll. */
4663 static int
4664 scrolling_window (w, header_line_p)
4665 struct window *w;
4666 int header_line_p;
4668 struct glyph_matrix *desired_matrix = w->desired_matrix;
4669 struct glyph_matrix *current_matrix = w->current_matrix;
4670 int yb = window_text_bottom_y (w);
4671 int i, j, first_old, first_new, last_old, last_new;
4672 int nruns, nbytes, n, run_idx;
4673 struct row_entry *entry;
4675 /* Skip over rows equal at the start. */
4676 for (i = header_line_p ? 1 : 0; i < current_matrix->nrows - 1; ++i)
4678 struct glyph_row *d = MATRIX_ROW (desired_matrix, i);
4679 struct glyph_row *c = MATRIX_ROW (current_matrix, i);
4681 if (c->enabled_p
4682 && d->enabled_p
4683 && c->y == d->y
4684 && MATRIX_ROW_BOTTOM_Y (c) <= yb
4685 && MATRIX_ROW_BOTTOM_Y (d) <= yb
4686 && row_equal_p (w, c, d, 1))
4688 assign_row (c, d);
4689 d->enabled_p = 0;
4691 else
4692 break;
4695 /* Give up if some rows in the desired matrix are not enabled. */
4696 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4697 return -1;
4699 first_old = first_new = i;
4701 /* Set last_new to the index + 1 of the last enabled row in the
4702 desired matrix. */
4703 i = first_new + 1;
4704 while (i < desired_matrix->nrows - 1
4705 && MATRIX_ROW (desired_matrix, i)->enabled_p
4706 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix, i)) <= yb)
4707 ++i;
4709 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4710 return 0;
4712 last_new = i;
4714 /* Set last_old to the index + 1 of the last enabled row in the
4715 current matrix. We don't look at the enabled flag here because
4716 we plan to reuse part of the display even if other parts are
4717 disabled. */
4718 i = first_old + 1;
4719 while (i < current_matrix->nrows - 1)
4721 int bottom = MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix, i));
4722 if (bottom <= yb)
4723 ++i;
4724 if (bottom >= yb)
4725 break;
4728 last_old = i;
4730 /* Skip over rows equal at the bottom. */
4731 i = last_new;
4732 j = last_old;
4733 while (i - 1 > first_new
4734 && j - 1 > first_old
4735 && MATRIX_ROW (current_matrix, i - 1)->enabled_p
4736 && (MATRIX_ROW (current_matrix, i - 1)->y
4737 == MATRIX_ROW (desired_matrix, j - 1)->y)
4738 && row_equal_p (w,
4739 MATRIX_ROW (desired_matrix, i - 1),
4740 MATRIX_ROW (current_matrix, j - 1), 1))
4741 --i, --j;
4742 last_new = i;
4743 last_old = j;
4745 /* Nothing to do if all rows are equal. */
4746 if (last_new == first_new)
4747 return 0;
4749 /* Reallocate vectors, tables etc. if necessary. */
4751 if (current_matrix->nrows > old_lines_size)
4753 old_lines_size = current_matrix->nrows;
4754 nbytes = old_lines_size * sizeof *old_lines;
4755 old_lines = (struct row_entry **) xrealloc (old_lines, nbytes);
4758 if (desired_matrix->nrows > new_lines_size)
4760 new_lines_size = desired_matrix->nrows;
4761 nbytes = new_lines_size * sizeof *new_lines;
4762 new_lines = (struct row_entry **) xrealloc (new_lines, nbytes);
4765 n = desired_matrix->nrows + current_matrix->nrows;
4766 if (3 * n > row_table_size)
4768 row_table_size = next_almost_prime (3 * n);
4769 nbytes = row_table_size * sizeof *row_table;
4770 row_table = (struct row_entry **) xrealloc (row_table, nbytes);
4771 bzero (row_table, nbytes);
4774 if (n > row_entry_pool_size)
4776 row_entry_pool_size = n;
4777 nbytes = row_entry_pool_size * sizeof *row_entry_pool;
4778 row_entry_pool = (struct row_entry *) xrealloc (row_entry_pool, nbytes);
4781 if (desired_matrix->nrows > runs_size)
4783 runs_size = desired_matrix->nrows;
4784 nbytes = runs_size * sizeof *runs;
4785 runs = (struct run **) xrealloc (runs, nbytes);
4786 nbytes = runs_size * sizeof *run_pool;
4787 run_pool = (struct run *) xrealloc (run_pool, nbytes);
4790 nruns = run_idx = 0;
4791 row_entry_idx = 0;
4793 /* Add rows from the current and desired matrix to the hash table
4794 row_hash_table to be able to find equal ones quickly. */
4796 for (i = first_old; i < last_old; ++i)
4798 if (MATRIX_ROW (current_matrix, i)->enabled_p)
4800 entry = add_row_entry (w, MATRIX_ROW (current_matrix, i));
4801 old_lines[i] = entry;
4802 ++entry->old_uses;
4804 else
4805 old_lines[i] = NULL;
4808 for (i = first_new; i < last_new; ++i)
4810 xassert (MATRIX_ROW_ENABLED_P (desired_matrix, i));
4811 entry = add_row_entry (w, MATRIX_ROW (desired_matrix, i));
4812 ++entry->new_uses;
4813 entry->new_line_number = i;
4814 new_lines[i] = entry;
4817 /* Identify moves based on lines that are unique and equal
4818 in both matrices. */
4819 for (i = first_old; i < last_old;)
4820 if (old_lines[i]
4821 && old_lines[i]->old_uses == 1
4822 && old_lines[i]->new_uses == 1)
4824 int j, k;
4825 int new_line = old_lines[i]->new_line_number;
4826 struct run *run = run_pool + run_idx++;
4828 /* Record move. */
4829 run->current_vpos = i;
4830 run->current_y = MATRIX_ROW (current_matrix, i)->y;
4831 run->desired_vpos = new_line;
4832 run->desired_y = MATRIX_ROW (desired_matrix, new_line)->y;
4833 run->nrows = 1;
4834 run->height = MATRIX_ROW (current_matrix, i)->height;
4836 /* Extend backward. */
4837 j = i - 1;
4838 k = new_line - 1;
4839 while (j > first_old
4840 && k > first_new
4841 && old_lines[j] == new_lines[k])
4843 int h = MATRIX_ROW (current_matrix, j)->height;
4844 --run->current_vpos;
4845 --run->desired_vpos;
4846 ++run->nrows;
4847 run->height += h;
4848 run->desired_y -= h;
4849 run->current_y -= h;
4850 --j, --k;
4853 /* Extend forward. */
4854 j = i + 1;
4855 k = new_line + 1;
4856 while (j < last_old
4857 && k < last_new
4858 && old_lines[j] == new_lines[k])
4860 int h = MATRIX_ROW (current_matrix, j)->height;
4861 ++run->nrows;
4862 run->height += h;
4863 ++j, ++k;
4866 /* Insert run into list of all runs. Order runs by copied
4867 pixel lines. Note that we record runs that don't have to
4868 be copied because they are already in place. This is done
4869 because we can avoid calling update_window_line in this
4870 case. */
4871 for (j = 0; j < nruns && runs[j]->height > run->height; ++j)
4873 for (k = nruns; k > j; --k)
4874 runs[k] = runs[k - 1];
4875 runs[j] = run;
4876 ++nruns;
4878 i += run->nrows;
4880 else
4881 ++i;
4883 /* Do the moves. Do it in a way that we don't overwrite something
4884 we want to copy later on. This is not solvable in general
4885 because there is only one display and we don't have a way to
4886 exchange areas on this display. Example:
4888 +-----------+ +-----------+
4889 | A | | B |
4890 +-----------+ --> +-----------+
4891 | B | | A |
4892 +-----------+ +-----------+
4894 Instead, prefer bigger moves, and invalidate moves that would
4895 copy from where we copied to. */
4897 for (i = 0; i < nruns; ++i)
4898 if (runs[i]->nrows > 0)
4900 struct run *r = runs[i];
4902 /* Copy on the display. */
4903 if (r->current_y != r->desired_y)
4905 rif->scroll_run_hook (w, r);
4907 /* Invalidate runs that copy from where we copied to. */
4908 for (j = i + 1; j < nruns; ++j)
4910 struct run *p = runs[j];
4912 if ((p->current_y >= r->desired_y
4913 && p->current_y < r->desired_y + r->height)
4914 || (p->current_y + p->height >= r->desired_y
4915 && (p->current_y + p->height
4916 < r->desired_y + r->height)))
4917 p->nrows = 0;
4921 /* Assign matrix rows. */
4922 for (j = 0; j < r->nrows; ++j)
4924 struct glyph_row *from, *to;
4925 int to_overlapped_p;
4927 to = MATRIX_ROW (current_matrix, r->desired_vpos + j);
4928 from = MATRIX_ROW (desired_matrix, r->desired_vpos + j);
4929 to_overlapped_p = to->overlapped_p;
4930 assign_row (to, from);
4931 to->enabled_p = 1, from->enabled_p = 0;
4932 to->overlapped_p = to_overlapped_p;
4936 /* Clear the hash table, for the next time. */
4937 for (i = 0; i < row_entry_idx; ++i)
4938 row_table[row_entry_pool[i].bucket] = NULL;
4940 /* Value is non-zero to indicate that we scrolled the display. */
4941 return 1;
4946 /************************************************************************
4947 Frame-Based Updates
4948 ************************************************************************/
4950 /* Update the desired frame matrix of frame F.
4952 FORCE_P non-zero means that the update should not be stopped by
4953 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4954 should not be tried.
4956 Value is non-zero if update was stopped due to pending input. */
4958 static int
4959 update_frame_1 (f, force_p, inhibit_id_p)
4960 struct frame *f;
4961 int force_p;
4962 int inhibit_id_p;
4964 /* Frame matrices to work on. */
4965 struct glyph_matrix *current_matrix = f->current_matrix;
4966 struct glyph_matrix *desired_matrix = f->desired_matrix;
4967 int i;
4968 int pause;
4969 int preempt_count = baud_rate / 2400 + 1;
4970 extern int input_pending;
4972 xassert (current_matrix && desired_matrix);
4974 if (baud_rate != FRAME_COST_BAUD_RATE (f))
4975 calculate_costs (f);
4977 if (preempt_count <= 0)
4978 preempt_count = 1;
4980 if (redisplay_dont_pause)
4981 force_p = 1;
4982 else if (!force_p && detect_input_pending ())
4984 pause = 1;
4985 goto do_pause;
4988 /* If we cannot insert/delete lines, it's no use trying it. */
4989 if (!line_ins_del_ok)
4990 inhibit_id_p = 1;
4992 /* See if any of the desired lines are enabled; don't compute for
4993 i/d line if just want cursor motion. */
4994 for (i = 0; i < desired_matrix->nrows; i++)
4995 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
4996 break;
4998 /* Try doing i/d line, if not yet inhibited. */
4999 if (!inhibit_id_p && i < desired_matrix->nrows)
5000 force_p |= scrolling (f);
5002 /* Update the individual lines as needed. Do bottom line first. */
5003 if (MATRIX_ROW_ENABLED_P (desired_matrix, desired_matrix->nrows - 1))
5004 update_frame_line (f, desired_matrix->nrows - 1);
5006 /* Now update the rest of the lines. */
5007 for (i = 0; i < desired_matrix->nrows - 1 && (force_p || !input_pending); i++)
5009 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5011 if (FRAME_TERMCAP_P (f))
5013 /* Flush out every so many lines.
5014 Also flush out if likely to have more than 1k buffered
5015 otherwise. I'm told that some telnet connections get
5016 really screwed by more than 1k output at once. */
5017 int outq = PENDING_OUTPUT_COUNT (stdout);
5018 if (outq > 900
5019 || (outq > 20 && ((i - 1) % preempt_count == 0)))
5021 fflush (stdout);
5022 if (preempt_count == 1)
5024 #ifdef EMACS_OUTQSIZE
5025 if (EMACS_OUTQSIZE (0, &outq) < 0)
5026 /* Probably not a tty. Ignore the error and reset
5027 * the outq count. */
5028 outq = PENDING_OUTPUT_COUNT (stdout);
5029 #endif
5030 outq *= 10;
5031 if (baud_rate <= outq && baud_rate > 0)
5032 sleep (outq / baud_rate);
5037 if ((i - 1) % preempt_count == 0)
5038 detect_input_pending ();
5040 update_frame_line (f, i);
5044 pause = (i < FRAME_HEIGHT (f) - 1) ? i : 0;
5046 /* Now just clean up termcap drivers and set cursor, etc. */
5047 if (!pause)
5049 if ((cursor_in_echo_area
5050 /* If we are showing a message instead of the mini-buffer,
5051 show the cursor for the message instead of for the
5052 (now hidden) mini-buffer contents. */
5053 || (EQ (minibuf_window, selected_window)
5054 && EQ (minibuf_window, echo_area_window)
5055 && !NILP (echo_area_buffer[0])))
5056 /* These cases apply only to the frame that contains
5057 the active mini-buffer window. */
5058 && FRAME_HAS_MINIBUF_P (f)
5059 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
5061 int top = XINT (XWINDOW (FRAME_MINIBUF_WINDOW (f))->top);
5062 int row, col;
5064 if (cursor_in_echo_area < 0)
5066 /* Negative value of cursor_in_echo_area means put
5067 cursor at beginning of line. */
5068 row = top;
5069 col = 0;
5071 else
5073 /* Positive value of cursor_in_echo_area means put
5074 cursor at the end of the prompt. If the mini-buffer
5075 is several lines high, find the last line that has
5076 any text on it. */
5077 row = FRAME_HEIGHT (f);
5080 --row;
5081 col = 0;
5083 if (MATRIX_ROW_ENABLED_P (current_matrix, row))
5085 /* Frame rows are filled up with spaces that
5086 must be ignored here. */
5087 struct glyph_row *r = MATRIX_ROW (current_matrix,
5088 row);
5089 struct glyph *start = r->glyphs[TEXT_AREA];
5090 struct glyph *last = start + r->used[TEXT_AREA];
5092 while (last > start
5093 && (last - 1)->charpos < 0)
5094 --last;
5096 col = last - start;
5099 while (row > top && col == 0);
5101 /* Make sure COL is not out of range. */
5102 if (col >= FRAME_CURSOR_X_LIMIT (f))
5104 /* If we have another row, advance cursor into it. */
5105 if (row < FRAME_HEIGHT (f) - 1)
5107 col = FRAME_LEFT_SCROLL_BAR_WIDTH (f);
5108 row++;
5110 /* Otherwise move it back in range. */
5111 else
5112 col = FRAME_CURSOR_X_LIMIT (f) - 1;
5116 cursor_to (row, col);
5118 else
5120 /* We have only one cursor on terminal frames. Use it to
5121 display the cursor of the selected window. */
5122 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
5123 if (w->cursor.vpos >= 0
5124 /* The cursor vpos may be temporarily out of bounds
5125 in the following situation: There is one window,
5126 with the cursor in the lower half of it. The window
5127 is split, and a message causes a redisplay before
5128 a new cursor position has been computed. */
5129 && w->cursor.vpos < XFASTINT (w->height))
5131 int x = WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos);
5132 int y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
5134 if (INTEGERP (w->left_margin_width))
5135 x += XFASTINT (w->left_margin_width);
5137 /* x = max (min (x, FRAME_WINDOW_WIDTH (f) - 1), 0); */
5138 cursor_to (y, x);
5143 do_pause:
5145 clear_desired_matrices (f);
5146 return pause;
5150 /* Do line insertions/deletions on frame F for frame-based redisplay. */
5153 scrolling (frame)
5154 struct frame *frame;
5156 int unchanged_at_top, unchanged_at_bottom;
5157 int window_size;
5158 int changed_lines;
5159 int *old_hash = (int *) alloca (FRAME_HEIGHT (frame) * sizeof (int));
5160 int *new_hash = (int *) alloca (FRAME_HEIGHT (frame) * sizeof (int));
5161 int *draw_cost = (int *) alloca (FRAME_HEIGHT (frame) * sizeof (int));
5162 int *old_draw_cost = (int *) alloca (FRAME_HEIGHT (frame) * sizeof (int));
5163 register int i;
5164 int free_at_end_vpos = FRAME_HEIGHT (frame);
5165 struct glyph_matrix *current_matrix = frame->current_matrix;
5166 struct glyph_matrix *desired_matrix = frame->desired_matrix;
5168 if (!current_matrix)
5169 abort ();
5171 /* Compute hash codes of all the lines. Also calculate number of
5172 changed lines, number of unchanged lines at the beginning, and
5173 number of unchanged lines at the end. */
5174 changed_lines = 0;
5175 unchanged_at_top = 0;
5176 unchanged_at_bottom = FRAME_HEIGHT (frame);
5177 for (i = 0; i < FRAME_HEIGHT (frame); i++)
5179 /* Give up on this scrolling if some old lines are not enabled. */
5180 if (!MATRIX_ROW_ENABLED_P (current_matrix, i))
5181 return 0;
5182 old_hash[i] = line_hash_code (MATRIX_ROW (current_matrix, i));
5183 if (! MATRIX_ROW_ENABLED_P (desired_matrix, i))
5185 /* This line cannot be redrawn, so don't let scrolling mess it. */
5186 new_hash[i] = old_hash[i];
5187 #define INFINITY 1000000 /* Taken from scroll.c */
5188 draw_cost[i] = INFINITY;
5190 else
5192 new_hash[i] = line_hash_code (MATRIX_ROW (desired_matrix, i));
5193 draw_cost[i] = line_draw_cost (desired_matrix, i);
5196 if (old_hash[i] != new_hash[i])
5198 changed_lines++;
5199 unchanged_at_bottom = FRAME_HEIGHT (frame) - i - 1;
5201 else if (i == unchanged_at_top)
5202 unchanged_at_top++;
5203 old_draw_cost[i] = line_draw_cost (current_matrix, i);
5206 /* If changed lines are few, don't allow preemption, don't scroll. */
5207 if ((!scroll_region_ok && changed_lines < baud_rate / 2400)
5208 || unchanged_at_bottom == FRAME_HEIGHT (frame))
5209 return 1;
5211 window_size = (FRAME_HEIGHT (frame) - unchanged_at_top
5212 - unchanged_at_bottom);
5214 if (scroll_region_ok)
5215 free_at_end_vpos -= unchanged_at_bottom;
5216 else if (memory_below_frame)
5217 free_at_end_vpos = -1;
5219 /* If large window, fast terminal and few lines in common between
5220 current frame and desired frame, don't bother with i/d calc. */
5221 if (!scroll_region_ok && window_size >= 18 && baud_rate > 2400
5222 && (window_size >=
5223 10 * scrolling_max_lines_saved (unchanged_at_top,
5224 FRAME_HEIGHT (frame) - unchanged_at_bottom,
5225 old_hash, new_hash, draw_cost)))
5226 return 0;
5228 if (window_size < 2)
5229 return 0;
5231 scrolling_1 (frame, window_size, unchanged_at_top, unchanged_at_bottom,
5232 draw_cost + unchanged_at_top - 1,
5233 old_draw_cost + unchanged_at_top - 1,
5234 old_hash + unchanged_at_top - 1,
5235 new_hash + unchanged_at_top - 1,
5236 free_at_end_vpos - unchanged_at_top);
5238 return 0;
5242 /* Count the number of blanks at the start of the vector of glyphs R
5243 which is LEN glyphs long. */
5245 static int
5246 count_blanks (r, len)
5247 struct glyph *r;
5248 int len;
5250 int i;
5252 for (i = 0; i < len; ++i)
5253 if (!CHAR_GLYPH_SPACE_P (r[i]))
5254 break;
5256 return i;
5260 /* Count the number of glyphs in common at the start of the glyph
5261 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
5262 of STR2. Value is the number of equal glyphs equal at the start. */
5264 static int
5265 count_match (str1, end1, str2, end2)
5266 struct glyph *str1, *end1, *str2, *end2;
5268 struct glyph *p1 = str1;
5269 struct glyph *p2 = str2;
5271 while (p1 < end1
5272 && p2 < end2
5273 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1, p2))
5274 ++p1, ++p2;
5276 return p1 - str1;
5280 /* Char insertion/deletion cost vector, from term.c */
5282 extern int *char_ins_del_vector;
5283 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_WINDOW_WIDTH((f))])
5286 /* Perform a frame-based update on line VPOS in frame FRAME. */
5288 static void
5289 update_frame_line (frame, vpos)
5290 register struct frame *frame;
5291 int vpos;
5293 struct glyph *obody, *nbody, *op1, *op2, *np1, *nend;
5294 int tem;
5295 int osp, nsp, begmatch, endmatch, olen, nlen;
5296 struct glyph_matrix *current_matrix = frame->current_matrix;
5297 struct glyph_matrix *desired_matrix = frame->desired_matrix;
5298 struct glyph_row *current_row = MATRIX_ROW (current_matrix, vpos);
5299 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, vpos);
5300 int must_write_whole_line_p;
5301 int write_spaces_p = must_write_spaces;
5302 int colored_spaces_p = (FACE_FROM_ID (frame, DEFAULT_FACE_ID)->background
5303 != FACE_TTY_DEFAULT_BG_COLOR);
5305 if (colored_spaces_p)
5306 write_spaces_p = 1;
5308 if (desired_row->inverse_p
5309 != (current_row->enabled_p && current_row->inverse_p))
5311 int n = current_row->enabled_p ? current_row->used[TEXT_AREA] : 0;
5312 change_line_highlight (desired_row->inverse_p, vpos, vpos, n);
5313 current_row->enabled_p = 0;
5315 else
5316 reassert_line_highlight (desired_row->inverse_p, vpos);
5318 /* Current row not enabled means it has unknown contents. We must
5319 write the whole desired line in that case. */
5320 must_write_whole_line_p = !current_row->enabled_p;
5321 if (must_write_whole_line_p)
5323 obody = 0;
5324 olen = 0;
5326 else
5328 obody = MATRIX_ROW_GLYPH_START (current_matrix, vpos);
5329 olen = current_row->used[TEXT_AREA];
5331 if (!current_row->inverse_p)
5333 /* Ignore trailing spaces, if we can. */
5334 if (!write_spaces_p)
5335 while (olen > 0 && CHAR_GLYPH_SPACE_P (obody[olen-1]))
5336 olen--;
5338 else
5340 /* For an inverse-video line, make sure it's filled with
5341 spaces all the way to the frame edge so that the reverse
5342 video extends all the way across. */
5343 while (olen < FRAME_WIDTH (frame) - 1)
5344 obody[olen++] = space_glyph;
5348 current_row->enabled_p = 1;
5349 current_row->used[TEXT_AREA] = desired_row->used[TEXT_AREA];
5350 current_row->inverse_p = desired_row->inverse_p;
5352 /* If desired line is empty, just clear the line. */
5353 if (!desired_row->enabled_p)
5355 nlen = 0;
5356 goto just_erase;
5359 nbody = desired_row->glyphs[TEXT_AREA];
5360 nlen = desired_row->used[TEXT_AREA];
5361 nend = nbody + nlen;
5363 /* If display line has unknown contents, write the whole line. */
5364 if (must_write_whole_line_p)
5366 /* Ignore spaces at the end, if we can. */
5367 if (!write_spaces_p)
5368 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5369 --nlen;
5371 /* Write the contents of the desired line. */
5372 if (nlen)
5374 cursor_to (vpos, 0);
5375 write_glyphs (nbody, nlen);
5378 /* Don't call clear_end_of_line if we already wrote the whole
5379 line. The cursor will not be at the right margin in that
5380 case but in the line below. */
5381 if (nlen < FRAME_WINDOW_WIDTH (frame))
5383 cursor_to (vpos, nlen);
5384 clear_end_of_line (FRAME_WINDOW_WIDTH (frame));
5386 else
5387 /* Make sure we are in the right row, otherwise cursor movement
5388 with cmgoto might use `ch' in the wrong row. */
5389 cursor_to (vpos, 0);
5391 make_current (desired_matrix, current_matrix, vpos);
5392 return;
5395 /* Pretend trailing spaces are not there at all,
5396 unless for one reason or another we must write all spaces. */
5397 if (!desired_row->inverse_p)
5399 if (!write_spaces_p)
5400 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5401 nlen--;
5403 else
5405 /* For an inverse-video line, give it extra trailing spaces all
5406 the way to the frame edge so that the reverse video extends
5407 all the way across. */
5408 while (nlen < FRAME_WIDTH (frame) - 1)
5409 nbody[nlen++] = space_glyph;
5412 /* If there's no i/d char, quickly do the best we can without it. */
5413 if (!char_ins_del_ok)
5415 int i, j;
5417 /* Find the first glyph in desired row that doesn't agree with
5418 a glyph in the current row, and write the rest from there on. */
5419 for (i = 0; i < nlen; i++)
5421 if (i >= olen || !GLYPH_EQUAL_P (nbody + i, obody + i))
5423 /* Find the end of the run of different glyphs. */
5424 j = i + 1;
5425 while (j < nlen
5426 && (j >= olen
5427 || !GLYPH_EQUAL_P (nbody + j, obody + j)
5428 || CHAR_GLYPH_PADDING_P (nbody[j])))
5429 ++j;
5431 /* Output this run of non-matching chars. */
5432 cursor_to (vpos, i);
5433 write_glyphs (nbody + i, j - i);
5434 i = j - 1;
5436 /* Now find the next non-match. */
5440 /* Clear the rest of the line, or the non-clear part of it. */
5441 if (olen > nlen)
5443 cursor_to (vpos, nlen);
5444 clear_end_of_line (olen);
5447 /* Make current row = desired row. */
5448 make_current (desired_matrix, current_matrix, vpos);
5449 return;
5452 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5453 characters in a row. */
5455 if (!olen)
5457 /* If current line is blank, skip over initial spaces, if
5458 possible, and write the rest. */
5459 if (write_spaces_p || desired_row->inverse_p)
5460 nsp = 0;
5461 else
5462 nsp = count_blanks (nbody, nlen);
5464 if (nlen > nsp)
5466 cursor_to (vpos, nsp);
5467 write_glyphs (nbody + nsp, nlen - nsp);
5470 /* Exchange contents between current_frame and new_frame. */
5471 make_current (desired_matrix, current_matrix, vpos);
5472 return;
5475 /* Compute number of leading blanks in old and new contents. */
5476 osp = count_blanks (obody, olen);
5477 nsp = (desired_row->inverse_p || colored_spaces_p
5479 : count_blanks (nbody, nlen));
5481 /* Compute number of matching chars starting with first non-blank. */
5482 begmatch = count_match (obody + osp, obody + olen,
5483 nbody + nsp, nbody + nlen);
5485 /* Spaces in new match implicit space past the end of old. */
5486 /* A bug causing this to be a no-op was fixed in 18.29. */
5487 if (!write_spaces_p && osp + begmatch == olen)
5489 np1 = nbody + nsp;
5490 while (np1 + begmatch < nend && CHAR_GLYPH_SPACE_P (np1[begmatch]))
5491 ++begmatch;
5494 /* Avoid doing insert/delete char
5495 just cause number of leading spaces differs
5496 when the following text does not match. */
5497 if (begmatch == 0 && osp != nsp)
5498 osp = nsp = min (osp, nsp);
5500 /* Find matching characters at end of line */
5501 op1 = obody + olen;
5502 np1 = nbody + nlen;
5503 op2 = op1 + begmatch - min (olen - osp, nlen - nsp);
5504 while (op1 > op2
5505 && GLYPH_EQUAL_P (op1 - 1, np1 - 1))
5507 op1--;
5508 np1--;
5510 endmatch = obody + olen - op1;
5512 /* tem gets the distance to insert or delete.
5513 endmatch is how many characters we save by doing so.
5514 Is it worth it? */
5516 tem = (nlen - nsp) - (olen - osp);
5517 if (endmatch && tem
5518 && (!char_ins_del_ok || endmatch <= char_ins_del_cost (frame)[tem]))
5519 endmatch = 0;
5521 /* nsp - osp is the distance to insert or delete.
5522 If that is nonzero, begmatch is known to be nonzero also.
5523 begmatch + endmatch is how much we save by doing the ins/del.
5524 Is it worth it? */
5526 if (nsp != osp
5527 && (!char_ins_del_ok
5528 || begmatch + endmatch <= char_ins_del_cost (frame)[nsp - osp]))
5530 begmatch = 0;
5531 endmatch = 0;
5532 osp = nsp = min (osp, nsp);
5535 /* Now go through the line, inserting, writing and
5536 deleting as appropriate. */
5538 if (osp > nsp)
5540 cursor_to (vpos, nsp);
5541 delete_glyphs (osp - nsp);
5543 else if (nsp > osp)
5545 /* If going to delete chars later in line
5546 and insert earlier in the line,
5547 must delete first to avoid losing data in the insert */
5548 if (endmatch && nlen < olen + nsp - osp)
5550 cursor_to (vpos, nlen - endmatch + osp - nsp);
5551 delete_glyphs (olen + nsp - osp - nlen);
5552 olen = nlen - (nsp - osp);
5554 cursor_to (vpos, osp);
5555 insert_glyphs (0, nsp - osp);
5557 olen += nsp - osp;
5559 tem = nsp + begmatch + endmatch;
5560 if (nlen != tem || olen != tem)
5562 cursor_to (vpos, nsp + begmatch);
5563 if (!endmatch || nlen == olen)
5565 /* If new text being written reaches right margin,
5566 there is no need to do clear-to-eol at the end.
5567 (and it would not be safe, since cursor is not
5568 going to be "at the margin" after the text is done) */
5569 if (nlen == FRAME_WINDOW_WIDTH (frame))
5570 olen = 0;
5571 write_glyphs (nbody + nsp + begmatch, nlen - tem);
5573 else if (nlen > olen)
5575 /* Here, we used to have the following simple code:
5576 ----------------------------------------
5577 write_glyphs (nbody + nsp + begmatch, olen - tem);
5578 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5579 ----------------------------------------
5580 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5581 is a padding glyph. */
5582 int out = olen - tem; /* Columns to be overwritten originally. */
5583 int del;
5585 /* Calculate columns we can actually overwrite. */
5586 while (CHAR_GLYPH_PADDING_P (nbody[nsp + begmatch + out])) out--;
5587 write_glyphs (nbody + nsp + begmatch, out);
5588 /* If we left columns to be overwritten, we must delete them. */
5589 del = olen - tem - out;
5590 if (del > 0) delete_glyphs (del);
5591 /* At last, we insert columns not yet written out. */
5592 insert_glyphs (nbody + nsp + begmatch + out, nlen - olen + del);
5593 olen = nlen;
5595 else if (olen > nlen)
5597 write_glyphs (nbody + nsp + begmatch, nlen - tem);
5598 delete_glyphs (olen - nlen);
5599 olen = nlen;
5603 just_erase:
5604 /* If any unerased characters remain after the new line, erase them. */
5605 if (olen > nlen)
5607 cursor_to (vpos, nlen);
5608 clear_end_of_line (olen);
5611 /* Exchange contents between current_frame and new_frame. */
5612 make_current (desired_matrix, current_matrix, vpos);
5617 /***********************************************************************
5618 X/Y Position -> Buffer Position
5619 ***********************************************************************/
5621 /* Return the character position of the character at window relative
5622 pixel position (*X, *Y). *X and *Y are adjusted to character
5623 boundaries. */
5626 buffer_posn_from_coords (w, x, y)
5627 struct window *w;
5628 int *x, *y;
5630 struct it it;
5631 struct buffer *old_current_buffer = current_buffer;
5632 struct text_pos startp;
5633 int left_area_width;
5635 current_buffer = XBUFFER (w->buffer);
5636 SET_TEXT_POS_FROM_MARKER (startp, w->start);
5637 CHARPOS (startp) = min (ZV, max (BEGV, CHARPOS (startp)));
5638 BYTEPOS (startp) = min (ZV_BYTE, max (BEGV_BYTE, BYTEPOS (startp)));
5639 start_display (&it, w, startp);
5641 left_area_width = WINDOW_DISPLAY_LEFT_AREA_PIXEL_WIDTH (w);
5642 move_it_to (&it, -1, *x + it.first_visible_x - left_area_width, *y, -1,
5643 MOVE_TO_X | MOVE_TO_Y);
5645 *x = it.current_x - it.first_visible_x + left_area_width;
5646 *y = it.current_y;
5647 current_buffer = old_current_buffer;
5648 return IT_CHARPOS (it);
5652 /* Value is the string under window-relative coordinates X/Y in the
5653 mode or top line of window W, or nil if none. MODE_LINE_P non-zero
5654 means look at the mode line. *CHARPOS is set to the position in
5655 the string returned. */
5657 Lisp_Object
5658 mode_line_string (w, x, y, mode_line_p, charpos)
5659 struct window *w;
5660 int x, y, mode_line_p;
5661 int *charpos;
5663 struct glyph_row *row;
5664 struct glyph *glyph, *end;
5665 struct frame *f = XFRAME (w->frame);
5666 int x0;
5667 Lisp_Object string = Qnil;
5669 if (mode_line_p)
5670 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
5671 else
5672 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
5674 if (row->mode_line_p && row->enabled_p)
5676 /* The mode lines are displayed over scroll bars and bitmap
5677 areas, and X is window-relative. Correct X by the scroll bar
5678 and bitmap area width. */
5679 if (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
5680 x += FRAME_SCROLL_BAR_COLS (f) * CANON_X_UNIT (f);
5681 x += FRAME_LEFT_FLAGS_AREA_WIDTH (f);
5683 /* Find the glyph under X. If we find one with a string object,
5684 it's the one we were looking for. */
5685 glyph = row->glyphs[TEXT_AREA];
5686 end = glyph + row->used[TEXT_AREA];
5687 for (x0 = 0; glyph < end; x0 += glyph->pixel_width, ++glyph)
5688 if (x >= x0 && x < x0 + glyph->pixel_width)
5690 string = glyph->object;
5691 *charpos = glyph->charpos;
5692 break;
5696 return string;
5700 /***********************************************************************
5701 Changing Frame Sizes
5702 ***********************************************************************/
5704 #ifdef SIGWINCH
5706 SIGTYPE
5707 window_change_signal (signalnum) /* If we don't have an argument, */
5708 int signalnum; /* some compilers complain in signal calls. */
5710 int width, height;
5711 #ifndef USE_CRT_DLL
5712 extern int errno;
5713 #endif
5714 int old_errno = errno;
5716 get_frame_size (&width, &height);
5718 /* The frame size change obviously applies to a termcap-controlled
5719 frame. Find such a frame in the list, and assume it's the only
5720 one (since the redisplay code always writes to stdout, not a
5721 FILE * specified in the frame structure). Record the new size,
5722 but don't reallocate the data structures now. Let that be done
5723 later outside of the signal handler. */
5726 Lisp_Object tail, frame;
5728 FOR_EACH_FRAME (tail, frame)
5730 if (FRAME_TERMCAP_P (XFRAME (frame)))
5732 change_frame_size (XFRAME (frame), height, width, 0, 1, 0);
5733 break;
5738 signal (SIGWINCH, window_change_signal);
5739 errno = old_errno;
5741 #endif /* SIGWINCH */
5744 /* Do any change in frame size that was requested by a signal. SAFE
5745 non-zero means this function is called from a place where it is
5746 safe to change frame sizes while a redisplay is in progress. */
5748 void
5749 do_pending_window_change (safe)
5750 int safe;
5752 /* If window_change_signal should have run before, run it now. */
5753 if (redisplaying_p && !safe)
5754 return;
5756 while (delayed_size_change)
5758 Lisp_Object tail, frame;
5760 delayed_size_change = 0;
5762 FOR_EACH_FRAME (tail, frame)
5764 struct frame *f = XFRAME (frame);
5766 int height = FRAME_NEW_HEIGHT (f);
5767 int width = FRAME_NEW_WIDTH (f);
5769 if (height != 0 || width != 0)
5770 change_frame_size (f, height, width, 0, 0, safe);
5776 /* Change the frame height and/or width. Values may be given as zero to
5777 indicate no change is to take place.
5779 If DELAY is non-zero, then assume we're being called from a signal
5780 handler, and queue the change for later - perhaps the next
5781 redisplay. Since this tries to resize windows, we can't call it
5782 from a signal handler.
5784 SAFE non-zero means this function is called from a place where it's
5785 safe to change frame sizes while a redisplay is in progress. */
5787 void
5788 change_frame_size (f, newheight, newwidth, pretend, delay, safe)
5789 register struct frame *f;
5790 int newheight, newwidth, pretend, delay, safe;
5792 Lisp_Object tail, frame;
5794 if (! FRAME_WINDOW_P (f))
5796 /* When using termcap, or on MS-DOS, all frames use
5797 the same screen, so a change in size affects all frames. */
5798 FOR_EACH_FRAME (tail, frame)
5799 if (! FRAME_WINDOW_P (XFRAME (frame)))
5800 change_frame_size_1 (XFRAME (frame), newheight, newwidth,
5801 pretend, delay, safe);
5803 else
5804 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe);
5807 static void
5808 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe)
5809 register struct frame *f;
5810 int newheight, newwidth, pretend, delay, safe;
5812 int new_frame_window_width;
5813 int count = specpdl_ptr - specpdl;
5815 /* If we can't deal with the change now, queue it for later. */
5816 if (delay || (redisplaying_p && !safe))
5818 FRAME_NEW_HEIGHT (f) = newheight;
5819 FRAME_NEW_WIDTH (f) = newwidth;
5820 delayed_size_change = 1;
5821 return;
5824 /* This size-change overrides any pending one for this frame. */
5825 FRAME_NEW_HEIGHT (f) = 0;
5826 FRAME_NEW_WIDTH (f) = 0;
5828 /* If an argument is zero, set it to the current value. */
5829 if (newheight == 0)
5830 newheight = FRAME_HEIGHT (f);
5831 if (newwidth == 0)
5832 newwidth = FRAME_WIDTH (f);
5834 /* Compute width of windows in F.
5835 This is the width of the frame without vertical scroll bars. */
5836 new_frame_window_width = FRAME_WINDOW_WIDTH_ARG (f, newwidth);
5838 /* Round up to the smallest acceptable size. */
5839 check_frame_size (f, &newheight, &newwidth);
5841 /* If we're not changing the frame size, quit now. */
5842 if (newheight == FRAME_HEIGHT (f)
5843 && new_frame_window_width == FRAME_WINDOW_WIDTH (f))
5844 return;
5846 BLOCK_INPUT;
5848 #ifdef MSDOS
5849 /* We only can set screen dimensions to certain values supported
5850 by our video hardware. Try to find the smallest size greater
5851 or equal to the requested dimensions. */
5852 dos_set_window_size (&newheight, &newwidth);
5853 #endif
5855 if (newheight != FRAME_HEIGHT (f))
5857 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
5859 /* Frame has both root and mini-buffer. */
5860 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f))->top,
5861 FRAME_TOP_MARGIN (f));
5862 set_window_height (FRAME_ROOT_WINDOW (f),
5863 (newheight
5865 - FRAME_TOP_MARGIN (f)),
5867 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f))->top,
5868 newheight - 1);
5869 set_window_height (FRAME_MINIBUF_WINDOW (f), 1, 0);
5871 else
5872 /* Frame has just one top-level window. */
5873 set_window_height (FRAME_ROOT_WINDOW (f),
5874 newheight - FRAME_TOP_MARGIN (f), 0);
5876 if (FRAME_TERMCAP_P (f) && !pretend)
5877 FrameRows = newheight;
5880 if (new_frame_window_width != FRAME_WINDOW_WIDTH (f))
5882 set_window_width (FRAME_ROOT_WINDOW (f), new_frame_window_width, 0);
5883 if (FRAME_HAS_MINIBUF_P (f))
5884 set_window_width (FRAME_MINIBUF_WINDOW (f), new_frame_window_width, 0);
5886 if (FRAME_TERMCAP_P (f) && !pretend)
5887 FrameCols = newwidth;
5889 if (WINDOWP (f->tool_bar_window))
5890 XSETFASTINT (XWINDOW (f->tool_bar_window)->width, newwidth);
5893 FRAME_HEIGHT (f) = newheight;
5894 SET_FRAME_WIDTH (f, newwidth);
5897 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
5898 int text_area_x, text_area_y, text_area_width, text_area_height;
5900 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
5901 &text_area_height);
5902 if (w->cursor.x >= text_area_x + text_area_width)
5903 w->cursor.hpos = w->cursor.x = 0;
5904 if (w->cursor.y >= text_area_y + text_area_height)
5905 w->cursor.vpos = w->cursor.y = 0;
5908 adjust_glyphs (f);
5909 SET_FRAME_GARBAGED (f);
5910 calculate_costs (f);
5912 UNBLOCK_INPUT;
5914 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
5916 /* This isn't quite a no-op: it runs window-configuration-change-hook. */
5917 Fset_window_buffer (FRAME_SELECTED_WINDOW (f),
5918 XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer);
5920 unbind_to (count, Qnil);
5925 /***********************************************************************
5926 Terminal Related Lisp Functions
5927 ***********************************************************************/
5929 DEFUN ("open-termscript", Fopen_termscript, Sopen_termscript,
5930 1, 1, "FOpen termscript file: ",
5931 "Start writing all terminal output to FILE as well as the terminal.\n\
5932 FILE = nil means just close any termscript file currently open.")
5933 (file)
5934 Lisp_Object file;
5936 if (termscript != 0) fclose (termscript);
5937 termscript = 0;
5939 if (! NILP (file))
5941 file = Fexpand_file_name (file, Qnil);
5942 termscript = fopen (XSTRING (file)->data, "w");
5943 if (termscript == 0)
5944 report_file_error ("Opening termscript", Fcons (file, Qnil));
5946 return Qnil;
5950 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal,
5951 Ssend_string_to_terminal, 1, 1, 0,
5952 "Send STRING to the terminal without alteration.\n\
5953 Control characters in STRING will have terminal-dependent effects.")
5954 (string)
5955 Lisp_Object string;
5957 /* ??? Perhaps we should do something special for multibyte strings here. */
5958 CHECK_STRING (string, 0);
5959 fwrite (XSTRING (string)->data, 1, STRING_BYTES (XSTRING (string)), stdout);
5960 fflush (stdout);
5961 if (termscript)
5963 fwrite (XSTRING (string)->data, 1, STRING_BYTES (XSTRING (string)),
5964 termscript);
5965 fflush (termscript);
5967 return Qnil;
5971 DEFUN ("ding", Fding, Sding, 0, 1, 0,
5972 "Beep, or flash the screen.\n\
5973 Also, unless an argument is given,\n\
5974 terminate any keyboard macro currently executing.")
5975 (arg)
5976 Lisp_Object arg;
5978 if (!NILP (arg))
5980 if (noninteractive)
5981 putchar (07);
5982 else
5983 ring_bell ();
5984 fflush (stdout);
5986 else
5987 bitch_at_user ();
5989 return Qnil;
5992 void
5993 bitch_at_user ()
5995 if (noninteractive)
5996 putchar (07);
5997 else if (!INTERACTIVE) /* Stop executing a keyboard macro. */
5998 error ("Keyboard macro terminated by a command ringing the bell");
5999 else
6000 ring_bell ();
6001 fflush (stdout);
6006 /***********************************************************************
6007 Sleeping, Waiting
6008 ***********************************************************************/
6010 DEFUN ("sleep-for", Fsleep_for, Ssleep_for, 1, 2, 0,
6011 "Pause, without updating display, for SECONDS seconds.\n\
6012 SECONDS may be a floating-point value, meaning that you can wait for a\n\
6013 fraction of a second. Optional second arg MILLISECONDS specifies an\n\
6014 additional wait period, in milliseconds; this may be useful if your\n\
6015 Emacs was built without floating point support.\n\
6016 \(Not all operating systems support waiting for a fraction of a second.)")
6017 (seconds, milliseconds)
6018 Lisp_Object seconds, milliseconds;
6020 int sec, usec;
6022 if (NILP (milliseconds))
6023 XSETINT (milliseconds, 0);
6024 else
6025 CHECK_NUMBER (milliseconds, 1);
6026 usec = XINT (milliseconds) * 1000;
6029 double duration = extract_float (seconds);
6030 sec = (int) duration;
6031 usec += (duration - sec) * 1000000;
6034 #ifndef EMACS_HAS_USECS
6035 if (sec == 0 && usec != 0)
6036 error ("millisecond `sleep-for' not supported on %s", SYSTEM_TYPE);
6037 #endif
6039 /* Assure that 0 <= usec < 1000000. */
6040 if (usec < 0)
6042 /* We can't rely on the rounding being correct if user is negative. */
6043 if (-1000000 < usec)
6044 sec--, usec += 1000000;
6045 else
6046 sec -= -usec / 1000000, usec = 1000000 - (-usec % 1000000);
6048 else
6049 sec += usec / 1000000, usec %= 1000000;
6051 if (sec < 0 || (sec == 0 && usec == 0))
6052 return Qnil;
6055 Lisp_Object zero;
6057 XSETFASTINT (zero, 0);
6058 wait_reading_process_input (sec, usec, zero, 0);
6061 /* We should always have wait_reading_process_input; we have a dummy
6062 implementation for systems which don't support subprocesses. */
6063 #if 0
6064 /* No wait_reading_process_input */
6065 immediate_quit = 1;
6066 QUIT;
6068 #ifdef VMS
6069 sys_sleep (sec);
6070 #else /* not VMS */
6071 /* The reason this is done this way
6072 (rather than defined (H_S) && defined (H_T))
6073 is because the VMS preprocessor doesn't grok `defined' */
6074 #ifdef HAVE_SELECT
6075 EMACS_GET_TIME (end_time);
6076 EMACS_SET_SECS_USECS (timeout, sec, usec);
6077 EMACS_ADD_TIME (end_time, end_time, timeout);
6079 while (1)
6081 EMACS_GET_TIME (timeout);
6082 EMACS_SUB_TIME (timeout, end_time, timeout);
6083 if (EMACS_TIME_NEG_P (timeout)
6084 || !select (1, 0, 0, 0, &timeout))
6085 break;
6087 #else /* not HAVE_SELECT */
6088 sleep (sec);
6089 #endif /* HAVE_SELECT */
6090 #endif /* not VMS */
6092 immediate_quit = 0;
6093 #endif /* no subprocesses */
6095 return Qnil;
6099 /* This is just like wait_reading_process_input, except that
6100 it does the redisplay.
6102 It's also much like Fsit_for, except that it can be used for
6103 waiting for input as well. */
6105 Lisp_Object
6106 sit_for (sec, usec, reading, display, initial_display)
6107 int sec, usec, reading, display, initial_display;
6109 Lisp_Object read_kbd;
6111 swallow_events (display);
6113 if (detect_input_pending_run_timers (display))
6114 return Qnil;
6116 if (initial_display)
6117 redisplay_preserve_echo_area ();
6119 if (sec == 0 && usec == 0)
6120 return Qt;
6122 #ifdef SIGIO
6123 gobble_input (0);
6124 #endif
6126 XSETINT (read_kbd, reading ? -1 : 1);
6127 wait_reading_process_input (sec, usec, read_kbd, display);
6129 return detect_input_pending () ? Qnil : Qt;
6133 DEFUN ("sit-for", Fsit_for, Ssit_for, 1, 3, 0,
6134 "Perform redisplay, then wait for SECONDS seconds or until input is available.\n\
6135 SECONDS may be a floating-point value, meaning that you can wait for a\n\
6136 fraction of a second. Optional second arg MILLISECONDS specifies an\n\
6137 additional wait period, in milliseconds; this may be useful if your\n\
6138 Emacs was built without floating point support.\n\
6139 \(Not all operating systems support waiting for a fraction of a second.)\n\
6140 Optional third arg NODISP non-nil means don't redisplay, just wait for input.\n\
6141 Redisplay is preempted as always if input arrives, and does not happen\n\
6142 if input is available before it starts.\n\
6143 Value is t if waited the full time with no input arriving.")
6144 (seconds, milliseconds, nodisp)
6145 Lisp_Object seconds, milliseconds, nodisp;
6147 int sec, usec;
6149 if (NILP (milliseconds))
6150 XSETINT (milliseconds, 0);
6151 else
6152 CHECK_NUMBER (milliseconds, 1);
6153 usec = XINT (milliseconds) * 1000;
6156 double duration = extract_float (seconds);
6157 sec = (int) duration;
6158 usec += (duration - sec) * 1000000;
6161 #ifndef EMACS_HAS_USECS
6162 if (usec != 0 && sec == 0)
6163 error ("millisecond `sit-for' not supported on %s", SYSTEM_TYPE);
6164 #endif
6166 return sit_for (sec, usec, 0, NILP (nodisp), NILP (nodisp));
6171 /***********************************************************************
6172 Other Lisp Functions
6173 ***********************************************************************/
6175 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6176 session's frames, frame names, buffers, buffer-read-only flags, and
6177 buffer-modified-flags, and a trailing sentinel (so we don't need to
6178 add length checks). */
6180 static Lisp_Object frame_and_buffer_state;
6183 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p,
6184 Sframe_or_buffer_changed_p, 0, 0, 0,
6185 "Return non-nil if the frame and buffer state appears to have changed.\n\
6186 The state variable is an internal vector containing all frames and buffers,\n\
6187 aside from buffers whose names start with space,\n\
6188 along with the buffers' read-only and modified flags, which allows a fast\n\
6189 check to see whether the menu bars might need to be recomputed.\n\
6190 If this function returns non-nil, it updates the internal vector to reflect\n\
6191 the current state.\n")
6194 Lisp_Object tail, frame, buf;
6195 Lisp_Object *vecp;
6196 int n;
6198 vecp = XVECTOR (frame_and_buffer_state)->contents;
6199 FOR_EACH_FRAME (tail, frame)
6201 if (!EQ (*vecp++, frame))
6202 goto changed;
6203 if (!EQ (*vecp++, XFRAME (frame)->name))
6204 goto changed;
6206 /* Check that the buffer info matches.
6207 No need to test for the end of the vector
6208 because the last element of the vector is lambda
6209 and that will always cause a mismatch. */
6210 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6212 buf = XCDR (XCAR (tail));
6213 /* Ignore buffers that aren't included in buffer lists. */
6214 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
6215 continue;
6216 if (!EQ (*vecp++, buf))
6217 goto changed;
6218 if (!EQ (*vecp++, XBUFFER (buf)->read_only))
6219 goto changed;
6220 if (!EQ (*vecp++, Fbuffer_modified_p (buf)))
6221 goto changed;
6223 /* Detect deletion of a buffer at the end of the list. */
6224 if (EQ (*vecp, Qlambda))
6225 return Qnil;
6226 changed:
6227 /* Start with 1 so there is room for at least one lambda at the end. */
6228 n = 1;
6229 FOR_EACH_FRAME (tail, frame)
6230 n += 2;
6231 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6232 n += 3;
6233 /* Reallocate the vector if it's grown, or if it's shrunk a lot. */
6234 if (n > XVECTOR (frame_and_buffer_state)->size
6235 || n + 20 < XVECTOR (frame_and_buffer_state)->size / 2)
6236 /* Add 20 extra so we grow it less often. */
6237 frame_and_buffer_state = Fmake_vector (make_number (n + 20), Qlambda);
6238 vecp = XVECTOR (frame_and_buffer_state)->contents;
6239 FOR_EACH_FRAME (tail, frame)
6241 *vecp++ = frame;
6242 *vecp++ = XFRAME (frame)->name;
6244 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6246 buf = XCDR (XCAR (tail));
6247 /* Ignore buffers that aren't included in buffer lists. */
6248 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
6249 continue;
6250 *vecp++ = buf;
6251 *vecp++ = XBUFFER (buf)->read_only;
6252 *vecp++ = Fbuffer_modified_p (buf);
6254 /* Fill up the vector with lambdas (always at least one). */
6255 *vecp++ = Qlambda;
6256 while (vecp - XVECTOR (frame_and_buffer_state)->contents
6257 < XVECTOR (frame_and_buffer_state)->size)
6258 *vecp++ = Qlambda;
6259 /* Make sure we didn't overflow the vector. */
6260 if (vecp - XVECTOR (frame_and_buffer_state)->contents
6261 > XVECTOR (frame_and_buffer_state)->size)
6262 abort ();
6263 return Qt;
6268 /***********************************************************************
6269 Initialization
6270 ***********************************************************************/
6272 char *terminal_type;
6274 /* Initialization done when Emacs fork is started, before doing stty.
6275 Determine terminal type and set terminal_driver. Then invoke its
6276 decoding routine to set up variables in the terminal package. */
6278 void
6279 init_display ()
6281 #ifdef HAVE_X_WINDOWS
6282 extern int display_arg;
6283 #endif
6285 /* Construct the space glyph. */
6286 space_glyph.type = CHAR_GLYPH;
6287 SET_CHAR_GLYPH_FROM_GLYPH (space_glyph, ' ');
6288 space_glyph.charpos = -1;
6290 meta_key = 0;
6291 inverse_video = 0;
6292 cursor_in_echo_area = 0;
6293 terminal_type = (char *) 0;
6295 /* Now is the time to initialize this; it's used by init_sys_modes
6296 during startup. */
6297 Vwindow_system = Qnil;
6299 /* If the user wants to use a window system, we shouldn't bother
6300 initializing the terminal. This is especially important when the
6301 terminal is so dumb that emacs gives up before and doesn't bother
6302 using the window system.
6304 If the DISPLAY environment variable is set and nonempty,
6305 try to use X, and die with an error message if that doesn't work. */
6307 #ifdef HAVE_X_WINDOWS
6308 if (! display_arg)
6310 char *display;
6311 #ifdef VMS
6312 display = getenv ("DECW$DISPLAY");
6313 #else
6314 display = getenv ("DISPLAY");
6315 #endif
6317 display_arg = (display != 0 && *display != 0);
6320 if (!inhibit_window_system && display_arg
6321 #ifndef CANNOT_DUMP
6322 && initialized
6323 #endif
6326 Vwindow_system = intern ("x");
6327 #ifdef HAVE_X11
6328 Vwindow_system_version = make_number (11);
6329 #else
6330 Vwindow_system_version = make_number (10);
6331 #endif
6332 #if defined (LINUX) && defined (HAVE_LIBNCURSES)
6333 /* In some versions of ncurses,
6334 tputs crashes if we have not called tgetent.
6335 So call tgetent. */
6336 { char b[2044]; tgetent (b, "xterm");}
6337 #endif
6338 adjust_frame_glyphs_initially ();
6339 return;
6341 #endif /* HAVE_X_WINDOWS */
6343 #ifdef HAVE_NTGUI
6344 if (!inhibit_window_system)
6346 Vwindow_system = intern ("w32");
6347 Vwindow_system_version = make_number (1);
6348 adjust_frame_glyphs_initially ();
6349 return;
6351 #endif /* HAVE_NTGUI */
6353 #ifdef macintosh
6354 if (!inhibit_window_system)
6356 Vwindow_system = intern ("mac");
6357 Vwindow_system_version = make_number (1);
6358 adjust_frame_glyphs_initially ();
6359 return;
6361 #endif /* macintosh */
6363 /* If no window system has been specified, try to use the terminal. */
6364 if (! isatty (0))
6366 fatal ("standard input is not a tty");
6367 exit (1);
6370 /* Look at the TERM variable */
6371 terminal_type = (char *) getenv ("TERM");
6372 if (!terminal_type)
6374 #ifdef VMS
6375 fprintf (stderr, "Please specify your terminal type.\n\
6376 For types defined in VMS, use set term /device=TYPE.\n\
6377 For types not defined in VMS, use define emacs_term \"TYPE\".\n\
6378 \(The quotation marks are necessary since terminal types are lower case.)\n");
6379 #else
6380 fprintf (stderr, "Please set the environment variable TERM; see tset(1).\n");
6381 #endif
6382 exit (1);
6385 #ifdef VMS
6386 /* VMS DCL tends to up-case things, so down-case term type.
6387 Hardly any uppercase letters in terminal types; should be none. */
6389 char *new = (char *) xmalloc (strlen (terminal_type) + 1);
6390 char *p;
6392 strcpy (new, terminal_type);
6394 for (p = new; *p; p++)
6395 if (isupper (*p))
6396 *p = tolower (*p);
6398 terminal_type = new;
6400 #endif /* VMS */
6402 term_init (terminal_type);
6405 struct frame *sf = SELECTED_FRAME ();
6406 int width = FRAME_WINDOW_WIDTH (sf);
6407 int height = FRAME_HEIGHT (sf);
6409 unsigned int total_glyphs = height * (width + 2) * sizeof (struct glyph);
6411 /* If these sizes are so big they cause overflow, just ignore the
6412 change. It's not clear what better we could do. */
6413 if (total_glyphs / sizeof (struct glyph) / height != width + 2)
6414 fatal ("screen size %dx%d too big", width, height);
6417 adjust_frame_glyphs_initially ();
6418 calculate_costs (XFRAME (selected_frame));
6420 #ifdef SIGWINCH
6421 #ifndef CANNOT_DUMP
6422 if (initialized)
6423 #endif /* CANNOT_DUMP */
6424 signal (SIGWINCH, window_change_signal);
6425 #endif /* SIGWINCH */
6427 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6428 if (initialized
6429 && !noninteractive
6430 #ifdef MSDOS
6431 /* The MSDOS terminal turns on its ``window system'' relatively
6432 late into the startup, so we cannot do the frame faces'
6433 initialization just yet. It will be done later by pc-win.el
6434 and internal_terminal_init. */
6435 && (strcmp (terminal_type, "internal") != 0 || inhibit_window_system)
6436 #endif
6437 && NILP (Vwindow_system))
6439 /* For the initial frame, we don't have any way of knowing what
6440 are the foreground and background colors of the terminal. */
6441 struct frame *sf = SELECTED_FRAME();
6443 FRAME_FOREGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_FG_COLOR;
6444 FRAME_BACKGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_BG_COLOR;
6445 call0 (intern ("tty-set-up-initial-frame-faces"));
6451 /***********************************************************************
6452 Blinking cursor
6453 ***********************************************************************/
6455 DEFUN ("internal-show-cursor", Finternal_show_cursor,
6456 Sinternal_show_cursor, 2, 2, 0,
6457 "Set the cursor-visibility flag of WINDOW to SHOW.\n\
6458 WINDOW nil means use the selected window. SHOW non-nil means\n\
6459 show a cursor in WINDOW in the next redisplay. SHOW nil means\n\
6460 don't show a cursor.")
6461 (window, show)
6462 Lisp_Object window, show;
6464 /* Don't change cursor state while redisplaying. This could confuse
6465 output routines. */
6466 if (!redisplaying_p)
6468 if (NILP (window))
6469 window = selected_window;
6470 else
6471 CHECK_WINDOW (window, 2);
6473 XWINDOW (window)->cursor_off_p = NILP (show);
6476 return Qnil;
6480 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p,
6481 Sinternal_show_cursor_p, 0, 1, 0,
6482 "Value is non-nil if next redisplay will display a cursor in WINDOW.\n\
6483 WINDOW nil or omitted means report on the selected window.")
6484 (window)
6485 Lisp_Object window;
6487 struct window *w;
6489 if (NILP (window))
6490 window = selected_window;
6491 else
6492 CHECK_WINDOW (window, 2);
6494 w = XWINDOW (window);
6495 return w->cursor_off_p ? Qnil : Qt;
6499 /***********************************************************************
6500 Initialization
6501 ***********************************************************************/
6503 void
6504 syms_of_display ()
6506 defsubr (&Sredraw_frame);
6507 defsubr (&Sredraw_display);
6508 defsubr (&Sframe_or_buffer_changed_p);
6509 defsubr (&Sopen_termscript);
6510 defsubr (&Sding);
6511 defsubr (&Ssit_for);
6512 defsubr (&Ssleep_for);
6513 defsubr (&Ssend_string_to_terminal);
6514 defsubr (&Sinternal_show_cursor);
6515 defsubr (&Sinternal_show_cursor_p);
6517 #if GLYPH_DEBUG
6518 defsubr (&Sdump_redisplay_history);
6519 #endif
6521 frame_and_buffer_state = Fmake_vector (make_number (20), Qlambda);
6522 staticpro (&frame_and_buffer_state);
6524 Qdisplay_table = intern ("display-table");
6525 staticpro (&Qdisplay_table);
6526 Qredisplay_dont_pause = intern ("redisplay-dont-pause");
6527 staticpro (&Qredisplay_dont_pause);
6529 DEFVAR_INT ("baud-rate", &baud_rate,
6530 "*The output baud rate of the terminal.\n\
6531 On most systems, changing this value will affect the amount of padding\n\
6532 and the other strategic decisions made during redisplay.");
6534 DEFVAR_BOOL ("inverse-video", &inverse_video,
6535 "*Non-nil means invert the entire frame display.\n\
6536 This means everything is in inverse video which otherwise would not be.");
6538 DEFVAR_BOOL ("visible-bell", &visible_bell,
6539 "*Non-nil means try to flash the frame to represent a bell.");
6541 DEFVAR_BOOL ("no-redraw-on-reenter", &no_redraw_on_reenter,
6542 "*Non-nil means no need to redraw entire frame after suspending.\n\
6543 A non-nil value is useful if the terminal can automatically preserve\n\
6544 Emacs's frame display when you reenter Emacs.\n\
6545 It is up to you to set this variable if your terminal can do that.");
6547 DEFVAR_LISP ("window-system", &Vwindow_system,
6548 "A symbol naming the window-system under which Emacs is running\n\
6549 \(such as `x'), or nil if emacs is running on an ordinary terminal.");
6551 DEFVAR_LISP ("window-system-version", &Vwindow_system_version,
6552 "The version number of the window system in use.\n\
6553 For X windows, this is 10 or 11.");
6555 DEFVAR_BOOL ("cursor-in-echo-area", &cursor_in_echo_area,
6556 "Non-nil means put cursor in minibuffer, at end of any message there.");
6558 DEFVAR_LISP ("glyph-table", &Vglyph_table,
6559 "Table defining how to output a glyph code to the frame.\n\
6560 If not nil, this is a vector indexed by glyph code to define the glyph.\n\
6561 Each element can be:\n\
6562 integer: a glyph code which this glyph is an alias for.\n\
6563 string: output this glyph using that string (not impl. in X windows).\n\
6564 nil: this glyph mod 256 is char code to output,\n\
6565 and this glyph / 256 is face code for X windows (see `face-id').");
6566 Vglyph_table = Qnil;
6568 DEFVAR_LISP ("standard-display-table", &Vstandard_display_table,
6569 "Display table to use for buffers that specify none.\n\
6570 See `buffer-display-table' for more information.");
6571 Vstandard_display_table = Qnil;
6573 DEFVAR_BOOL ("redisplay-dont-pause", &redisplay_dont_pause,
6574 "*Non-nil means update isn't paused when input is detected.");
6575 redisplay_dont_pause = 0;
6577 /* Initialize `window-system', unless init_display already decided it. */
6578 #ifdef CANNOT_DUMP
6579 if (noninteractive)
6580 #endif
6582 Vwindow_system = Qnil;
6583 Vwindow_system_version = Qnil;