Fix bogus crash with -DENABLE_CHECKING.
[emacs.git] / src / dispnew.c
blob5f3c8eacc3d06d332cca31890aad6b650ad99bb0
1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <ctype.h>
28 #ifdef HAVE_UNISTD_H
29 #include <unistd.h>
30 #endif
32 #include "lisp.h"
33 #include "termchar.h"
34 #include "termopts.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 "termhooks.h"
43 #include "window.h"
44 #include "commands.h"
45 #include "disptab.h"
46 #include "indent.h"
47 #include "intervals.h"
48 #include "blockinput.h"
49 #include "process.h"
51 /* I don't know why DEC Alpha OSF1 fail to compile this file if we
52 include the following file. */
53 /* #include "systty.h" */
54 #include "syssignal.h"
56 #ifdef HAVE_X_WINDOWS
57 #include "xterm.h"
58 #endif /* HAVE_X_WINDOWS */
60 #ifdef HAVE_NTGUI
61 #include "w32term.h"
62 #endif /* HAVE_NTGUI */
64 #ifdef MAC_OS
65 #include "macterm.h"
66 #endif /* MAC_OS */
68 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
70 #include "systime.h"
71 #include <errno.h>
73 /* To get the prototype for `sleep'. */
75 #ifdef HAVE_UNISTD_H
76 #include <unistd.h>
77 #endif
79 /* Get number of chars of output now in the buffer of a stdio stream.
80 This ought to be built in in stdio, but it isn't. Some s- files
81 override this because their stdio internals differ. */
83 #ifdef __GNU_LIBRARY__
85 /* The s- file might have overridden the definition with one that
86 works for the system's C library. But we are using the GNU C
87 library, so this is the right definition for every system. */
89 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
90 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
91 #else
92 #undef PENDING_OUTPUT_COUNT
93 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
94 #endif
95 #else /* not __GNU_LIBRARY__ */
96 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
97 #include <stdio_ext.h>
98 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
99 #endif
100 #ifndef PENDING_OUTPUT_COUNT
101 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
102 #endif
103 #endif /* not __GNU_LIBRARY__ */
105 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
106 #include <term.h> /* for tgetent */
107 #endif
109 /* Structure to pass dimensions around. Used for character bounding
110 boxes, glyph matrix dimensions and alike. */
112 struct dim
114 int width;
115 int height;
119 /* Function prototypes. */
121 static struct glyph_matrix *save_current_matrix P_ ((struct frame *));
122 static void restore_current_matrix P_ ((struct frame *, struct glyph_matrix *));
123 static void fake_current_matrices P_ ((Lisp_Object));
124 static void redraw_overlapping_rows P_ ((struct window *, int));
125 static void redraw_overlapped_rows P_ ((struct window *, int));
126 static int count_blanks P_ ((struct glyph *, int));
127 static int count_match P_ ((struct glyph *, struct glyph *,
128 struct glyph *, struct glyph *));
129 static unsigned line_draw_cost P_ ((struct glyph_matrix *, int));
130 static void update_frame_line P_ ((struct frame *, int));
131 static struct dim allocate_matrices_for_frame_redisplay
132 P_ ((Lisp_Object, int, int, int, int *));
133 static void allocate_matrices_for_window_redisplay P_ ((struct window *));
134 static int realloc_glyph_pool P_ ((struct glyph_pool *, struct dim));
135 static void adjust_frame_glyphs P_ ((struct frame *));
136 struct glyph_matrix *new_glyph_matrix P_ ((struct glyph_pool *));
137 static void free_glyph_matrix P_ ((struct glyph_matrix *));
138 static void adjust_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
139 int, int, struct dim));
140 static void change_frame_size_1 P_ ((struct frame *, int, int, int, int, int));
141 static void swap_glyph_pointers P_ ((struct glyph_row *, struct glyph_row *));
142 #if GLYPH_DEBUG
143 static int glyph_row_slice_p P_ ((struct glyph_row *, struct glyph_row *));
144 #endif
145 static void fill_up_frame_row_with_spaces P_ ((struct glyph_row *, int));
146 static void build_frame_matrix_from_window_tree P_ ((struct glyph_matrix *,
147 struct window *));
148 static void build_frame_matrix_from_leaf_window P_ ((struct glyph_matrix *,
149 struct window *));
150 static struct glyph_pool *new_glyph_pool P_ ((void));
151 static void free_glyph_pool P_ ((struct glyph_pool *));
152 static void adjust_frame_glyphs_initially P_ ((void));
153 static void adjust_frame_message_buffer P_ ((struct frame *));
154 static void adjust_decode_mode_spec_buffer P_ ((struct frame *));
155 static void fill_up_glyph_row_with_spaces P_ ((struct glyph_row *));
156 static void build_frame_matrix P_ ((struct frame *));
157 void clear_current_matrices P_ ((struct frame *));
158 void scroll_glyph_matrix_range P_ ((struct glyph_matrix *, int, int,
159 int, int));
160 static void clear_window_matrices P_ ((struct window *, int));
161 static void fill_up_glyph_row_area_with_spaces P_ ((struct glyph_row *, int));
162 static int scrolling_window P_ ((struct window *, int));
163 static int update_window_line P_ ((struct window *, int, int *));
164 static void update_marginal_area P_ ((struct window *, int, int));
165 static int update_text_area P_ ((struct window *, int));
166 static void make_current P_ ((struct glyph_matrix *, struct glyph_matrix *,
167 int));
168 static void mirror_make_current P_ ((struct window *, int));
169 void check_window_matrix_pointers P_ ((struct window *));
170 #if GLYPH_DEBUG
171 static void check_matrix_pointers P_ ((struct glyph_matrix *,
172 struct glyph_matrix *));
173 #endif
174 static void mirror_line_dance P_ ((struct window *, int, int, int *, char *));
175 static int update_window_tree P_ ((struct window *, int));
176 static int update_window P_ ((struct window *, int));
177 static int update_frame_1 P_ ((struct frame *, int, int));
178 static void set_window_cursor_after_update P_ ((struct window *));
179 static int row_equal_p P_ ((struct window *, struct glyph_row *,
180 struct glyph_row *, int));
181 static void adjust_frame_glyphs_for_window_redisplay P_ ((struct frame *));
182 static void adjust_frame_glyphs_for_frame_redisplay P_ ((struct frame *));
183 static void reverse_rows P_ ((struct glyph_matrix *, int, int));
184 static int margin_glyphs_to_reserve P_ ((struct window *, int, Lisp_Object));
185 static void sync_window_with_frame_matrix_rows P_ ((struct window *));
186 struct window *frame_row_to_window P_ ((struct window *, int));
189 /* Non-zero means don't pause redisplay for pending input. (This is
190 for debugging and for a future implementation of EDT-like
191 scrolling. */
193 int redisplay_dont_pause;
195 /* Nonzero upon entry to redisplay means do not assume anything about
196 current contents of actual terminal frame; clear and redraw it. */
198 int frame_garbaged;
200 /* Nonzero means last display completed. Zero means it was preempted. */
202 int display_completed;
204 /* Lisp variable visible-bell; enables use of screen-flash instead of
205 audible bell. */
207 int visible_bell;
209 /* Invert the color of the whole frame, at a low level. */
211 int inverse_video;
213 /* Line speed of the terminal. */
215 EMACS_INT baud_rate;
217 /* Either nil or a symbol naming the window system under which Emacs
218 creates the first frame. */
220 Lisp_Object Vinitial_window_system;
222 /* Version number of X windows: 10, 11 or nil. */
224 Lisp_Object Vwindow_system_version;
226 /* Vector of glyph definitions. Indexed by glyph number, the contents
227 are a string which is how to output the glyph.
229 If Vglyph_table is nil, a glyph is output by using its low 8 bits
230 as a character code.
232 This is an obsolete feature that is no longer used. The variable
233 is retained for compatibility. */
235 Lisp_Object Vglyph_table;
237 /* Display table to use for vectors that don't specify their own. */
239 Lisp_Object Vstandard_display_table;
241 /* Nonzero means reading single-character input with prompt so put
242 cursor on mini-buffer after the prompt. Positive means at end of
243 text in echo area; negative means at beginning of line. */
245 int cursor_in_echo_area;
247 Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
250 /* The currently selected frame. In a single-frame version, this
251 variable always equals the_only_frame. */
253 Lisp_Object selected_frame;
255 /* A frame which is not just a mini-buffer, or 0 if there are no such
256 frames. This is usually the most recent such frame that was
257 selected. In a single-frame version, this variable always holds
258 the address of the_only_frame. */
260 struct frame *last_nonminibuf_frame;
262 /* 1 means SIGWINCH happened when not safe. */
264 int delayed_size_change;
266 /* 1 means glyph initialization has been completed at startup. */
268 static int glyphs_initialized_initially_p;
270 /* Updated window if != 0. Set by update_window. */
272 struct window *updated_window;
274 /* Glyph row updated in update_window_line, and area that is updated. */
276 struct glyph_row *updated_row;
277 int updated_area;
279 /* A glyph for a space. */
281 struct glyph space_glyph;
283 /* Non-zero means update has been performed directly, so that there's
284 no need for redisplay_internal to do much work. Set by
285 direct_output_for_insert. */
287 int redisplay_performed_directly_p;
289 /* Counts of allocated structures. These counts serve to diagnose
290 memory leaks and double frees. */
292 int glyph_matrix_count;
293 int glyph_pool_count;
295 /* If non-null, the frame whose frame matrices are manipulated. If
296 null, window matrices are worked on. */
298 static struct frame *frame_matrix_frame;
300 /* Non-zero means that fonts have been loaded since the last glyph
301 matrix adjustments. Redisplay must stop, and glyph matrices must
302 be adjusted when this flag becomes non-zero during display. The
303 reason fonts can be loaded so late is that fonts of fontsets are
304 loaded on demand. */
306 int fonts_changed_p;
308 /* Convert vpos and hpos from frame to window and vice versa.
309 This may only be used for terminal frames. */
311 #if GLYPH_DEBUG
313 static int window_to_frame_vpos P_ ((struct window *, int));
314 static int window_to_frame_hpos P_ ((struct window *, int));
315 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
316 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
318 /* One element of the ring buffer containing redisplay history
319 information. */
321 struct redisplay_history
323 char trace[512 + 100];
326 /* The size of the history buffer. */
328 #define REDISPLAY_HISTORY_SIZE 30
330 /* The redisplay history buffer. */
332 static struct redisplay_history redisplay_history[REDISPLAY_HISTORY_SIZE];
334 /* Next free entry in redisplay_history. */
336 static int history_idx;
338 /* A tick that's incremented each time something is added to the
339 history. */
341 static unsigned history_tick;
343 static void add_frame_display_history P_ ((struct frame *, int));
344 static void add_window_display_history P_ ((struct window *, char *, int));
347 /* Add to the redisplay history how window W has been displayed.
348 MSG is a trace containing the information how W's glyph matrix
349 has been constructed. PAUSED_P non-zero means that the update
350 has been interrupted for pending input. */
352 static void
353 add_window_display_history (w, msg, paused_p)
354 struct window *w;
355 char *msg;
356 int paused_p;
358 char *buf;
360 if (history_idx >= REDISPLAY_HISTORY_SIZE)
361 history_idx = 0;
362 buf = redisplay_history[history_idx].trace;
363 ++history_idx;
365 sprintf (buf, "%d: window %p (`%s')%s\n",
366 history_tick++,
368 ((BUFFERP (w->buffer)
369 && STRINGP (XBUFFER (w->buffer)->name))
370 ? (char *) SDATA (XBUFFER (w->buffer)->name)
371 : "???"),
372 paused_p ? " ***paused***" : "");
373 strcat (buf, msg);
377 /* Add to the redisplay history that frame F has been displayed.
378 PAUSED_P non-zero means that the update has been interrupted for
379 pending input. */
381 static void
382 add_frame_display_history (f, paused_p)
383 struct frame *f;
384 int paused_p;
386 char *buf;
388 if (history_idx >= REDISPLAY_HISTORY_SIZE)
389 history_idx = 0;
390 buf = redisplay_history[history_idx].trace;
391 ++history_idx;
393 sprintf (buf, "%d: update frame %p%s",
394 history_tick++,
395 f, paused_p ? " ***paused***" : "");
399 DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
400 Sdump_redisplay_history, 0, 0, "",
401 doc: /* Dump redisplay history to stderr. */)
404 int i;
406 for (i = history_idx - 1; i != history_idx; --i)
408 if (i < 0)
409 i = REDISPLAY_HISTORY_SIZE - 1;
410 fprintf (stderr, "%s\n", redisplay_history[i].trace);
413 return Qnil;
417 #else /* GLYPH_DEBUG == 0 */
419 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
420 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
422 #endif /* GLYPH_DEBUG == 0 */
425 /* Like bcopy except never gets confused by overlap. Let this be the
426 first function defined in this file, or change emacs.c where the
427 address of this function is used. */
429 void
430 safe_bcopy (from, to, size)
431 const char *from;
432 char *to;
433 int size;
435 if (size <= 0 || from == to)
436 return;
438 /* If the source and destination don't overlap, then bcopy can
439 handle it. If they do overlap, but the destination is lower in
440 memory than the source, we'll assume bcopy can handle that. */
441 if (to < from || from + size <= to)
442 bcopy (from, to, size);
444 /* Otherwise, we'll copy from the end. */
445 else
447 register const char *endf = from + size;
448 register char *endt = to + size;
450 /* If TO - FROM is large, then we should break the copy into
451 nonoverlapping chunks of TO - FROM bytes each. However, if
452 TO - FROM is small, then the bcopy function call overhead
453 makes this not worth it. The crossover point could be about
454 anywhere. Since I don't think the obvious copy loop is too
455 bad, I'm trying to err in its favor. */
456 if (to - from < 64)
459 *--endt = *--endf;
460 while (endf != from);
462 else
464 for (;;)
466 endt -= (to - from);
467 endf -= (to - from);
469 if (endt < to)
470 break;
472 bcopy (endf, endt, to - from);
475 /* If SIZE wasn't a multiple of TO - FROM, there will be a
476 little left over. The amount left over is (endt + (to -
477 from)) - to, which is endt - from. */
478 bcopy (from, to, endt - from);
485 /***********************************************************************
486 Glyph Matrices
487 ***********************************************************************/
489 /* Allocate and return a glyph_matrix structure. POOL is the glyph
490 pool from which memory for the matrix should be allocated, or null
491 for window-based redisplay where no glyph pools are used. The
492 member `pool' of the glyph matrix structure returned is set to
493 POOL, the structure is otherwise zeroed. */
495 struct glyph_matrix *
496 new_glyph_matrix (pool)
497 struct glyph_pool *pool;
499 struct glyph_matrix *result;
501 /* Allocate and clear. */
502 result = (struct glyph_matrix *) xmalloc (sizeof *result);
503 bzero (result, sizeof *result);
505 /* Increment number of allocated matrices. This count is used
506 to detect memory leaks. */
507 ++glyph_matrix_count;
509 /* Set pool and return. */
510 result->pool = pool;
511 return result;
515 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
517 The global counter glyph_matrix_count is decremented when a matrix
518 is freed. If the count gets negative, more structures were freed
519 than allocated, i.e. one matrix was freed more than once or a bogus
520 pointer was passed to this function.
522 If MATRIX->pool is null, this means that the matrix manages its own
523 glyph memory---this is done for matrices on X frames. Freeing the
524 matrix also frees the glyph memory in this case. */
526 static void
527 free_glyph_matrix (matrix)
528 struct glyph_matrix *matrix;
530 if (matrix)
532 int i;
534 /* Detect the case that more matrices are freed than were
535 allocated. */
536 if (--glyph_matrix_count < 0)
537 abort ();
539 /* Free glyph memory if MATRIX owns it. */
540 if (matrix->pool == NULL)
541 for (i = 0; i < matrix->rows_allocated; ++i)
542 xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
544 /* Free row structures and the matrix itself. */
545 xfree (matrix->rows);
546 xfree (matrix);
551 /* Return the number of glyphs to reserve for a marginal area of
552 window W. TOTAL_GLYPHS is the number of glyphs in a complete
553 display line of window W. MARGIN gives the width of the marginal
554 area in canonical character units. MARGIN should be an integer
555 or a float. */
557 static int
558 margin_glyphs_to_reserve (w, total_glyphs, margin)
559 struct window *w;
560 int total_glyphs;
561 Lisp_Object margin;
563 int n;
565 if (NUMBERP (margin))
567 int width = XFASTINT (w->total_cols);
568 double d = max (0, XFLOATINT (margin));
569 d = min (width / 2 - 1, d);
570 n = (int) ((double) total_glyphs / width * d);
572 else
573 n = 0;
575 return n;
579 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
580 window sizes.
582 W is null if the function is called for a frame glyph matrix.
583 Otherwise it is the window MATRIX is a member of. X and Y are the
584 indices of the first column and row of MATRIX within the frame
585 matrix, if such a matrix exists. They are zero for purely
586 window-based redisplay. DIM is the needed size of the matrix.
588 In window-based redisplay, where no frame matrices exist, glyph
589 matrices manage their own glyph storage. Otherwise, they allocate
590 storage from a common frame glyph pool which can be found in
591 MATRIX->pool.
593 The reason for this memory management strategy is to avoid complete
594 frame redraws if possible. When we allocate from a common pool, a
595 change of the location or size of a sub-matrix within the pool
596 requires a complete redisplay of the frame because we cannot easily
597 make sure that the current matrices of all windows still agree with
598 what is displayed on the screen. While this is usually fast, it
599 leads to screen flickering. */
601 static void
602 adjust_glyph_matrix (w, matrix, x, y, dim)
603 struct window *w;
604 struct glyph_matrix *matrix;
605 int x, y;
606 struct dim dim;
608 int i;
609 int new_rows;
610 int marginal_areas_changed_p = 0;
611 int header_line_changed_p = 0;
612 int header_line_p = 0;
613 int left = -1, right = -1;
614 int window_width = -1, window_height;
616 /* See if W had a header line that has disappeared now, or vice versa.
617 Get W's size. */
618 if (w)
620 window_box (w, -1, 0, 0, &window_width, &window_height);
622 header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
623 header_line_changed_p = header_line_p != matrix->header_line_p;
625 matrix->header_line_p = header_line_p;
627 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
628 Do nothing if MATRIX' size, position, vscroll, and marginal areas
629 haven't changed. This optimization is important because preserving
630 the matrix means preventing redisplay. */
631 if (matrix->pool == NULL)
633 left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
634 right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
635 xassert (left >= 0 && right >= 0);
636 marginal_areas_changed_p = (left != matrix->left_margin_glyphs
637 || right != matrix->right_margin_glyphs);
639 if (!marginal_areas_changed_p
640 && !fonts_changed_p
641 && !header_line_changed_p
642 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
643 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
644 && matrix->window_height == window_height
645 && matrix->window_vscroll == w->vscroll
646 && matrix->window_width == window_width)
647 return;
650 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
651 if (matrix->rows_allocated < dim.height)
653 int size = dim.height * sizeof (struct glyph_row);
654 new_rows = dim.height - matrix->rows_allocated;
655 matrix->rows = (struct glyph_row *) xrealloc (matrix->rows, size);
656 bzero (matrix->rows + matrix->rows_allocated,
657 new_rows * sizeof *matrix->rows);
658 matrix->rows_allocated = dim.height;
660 else
661 new_rows = 0;
663 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
664 on a frame not using window-based redisplay. Set up pointers for
665 each row into the glyph pool. */
666 if (matrix->pool)
668 xassert (matrix->pool->glyphs);
670 if (w)
672 left = margin_glyphs_to_reserve (w, dim.width,
673 w->left_margin_cols);
674 right = margin_glyphs_to_reserve (w, dim.width,
675 w->right_margin_cols);
677 else
678 left = right = 0;
680 for (i = 0; i < dim.height; ++i)
682 struct glyph_row *row = &matrix->rows[i];
684 row->glyphs[LEFT_MARGIN_AREA]
685 = (matrix->pool->glyphs
686 + (y + i) * matrix->pool->ncolumns
687 + x);
689 if (w == NULL
690 || row == matrix->rows + dim.height - 1
691 || (row == matrix->rows && matrix->header_line_p))
693 row->glyphs[TEXT_AREA]
694 = row->glyphs[LEFT_MARGIN_AREA];
695 row->glyphs[RIGHT_MARGIN_AREA]
696 = row->glyphs[TEXT_AREA] + dim.width;
697 row->glyphs[LAST_AREA]
698 = row->glyphs[RIGHT_MARGIN_AREA];
700 else
702 row->glyphs[TEXT_AREA]
703 = row->glyphs[LEFT_MARGIN_AREA] + left;
704 row->glyphs[RIGHT_MARGIN_AREA]
705 = row->glyphs[TEXT_AREA] + dim.width - left - right;
706 row->glyphs[LAST_AREA]
707 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
711 matrix->left_margin_glyphs = left;
712 matrix->right_margin_glyphs = right;
714 else
716 /* If MATRIX->pool is null, MATRIX is responsible for managing
717 its own memory. It is a window matrix for window-based redisplay.
718 Allocate glyph memory from the heap. */
719 if (dim.width > matrix->matrix_w
720 || new_rows
721 || header_line_changed_p
722 || marginal_areas_changed_p)
724 struct glyph_row *row = matrix->rows;
725 struct glyph_row *end = row + matrix->rows_allocated;
727 while (row < end)
729 row->glyphs[LEFT_MARGIN_AREA]
730 = (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
731 (dim.width
732 * sizeof (struct glyph)));
734 /* The mode line never has marginal areas. */
735 if (row == matrix->rows + dim.height - 1
736 || (row == matrix->rows && matrix->header_line_p))
738 row->glyphs[TEXT_AREA]
739 = row->glyphs[LEFT_MARGIN_AREA];
740 row->glyphs[RIGHT_MARGIN_AREA]
741 = row->glyphs[TEXT_AREA] + dim.width;
742 row->glyphs[LAST_AREA]
743 = row->glyphs[RIGHT_MARGIN_AREA];
745 else
747 row->glyphs[TEXT_AREA]
748 = row->glyphs[LEFT_MARGIN_AREA] + left;
749 row->glyphs[RIGHT_MARGIN_AREA]
750 = row->glyphs[TEXT_AREA] + dim.width - left - right;
751 row->glyphs[LAST_AREA]
752 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
754 ++row;
758 xassert (left >= 0 && right >= 0);
759 matrix->left_margin_glyphs = left;
760 matrix->right_margin_glyphs = right;
763 /* Number of rows to be used by MATRIX. */
764 matrix->nrows = dim.height;
765 xassert (matrix->nrows >= 0);
767 if (w)
769 if (matrix == w->current_matrix)
771 /* Mark rows in a current matrix of a window as not having
772 valid contents. It's important to not do this for
773 desired matrices. When Emacs starts, it may already be
774 building desired matrices when this function runs. */
775 if (window_width < 0)
776 window_width = window_box_width (w, -1);
778 /* Optimize the case that only the height has changed (C-x 2,
779 upper window). Invalidate all rows that are no longer part
780 of the window. */
781 if (!marginal_areas_changed_p
782 && !header_line_changed_p
783 && new_rows == 0
784 && dim.width == matrix->matrix_w
785 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
786 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
787 && matrix->window_width == window_width)
789 /* Find the last row in the window. */
790 for (i = 0; i < matrix->nrows && matrix->rows[i].enabled_p; ++i)
791 if (MATRIX_ROW_BOTTOM_Y (matrix->rows + i) >= window_height)
793 ++i;
794 break;
797 /* Window end is invalid, if inside of the rows that
798 are invalidated below. */
799 if (INTEGERP (w->window_end_vpos)
800 && XFASTINT (w->window_end_vpos) >= i)
801 w->window_end_valid = Qnil;
803 while (i < matrix->nrows)
804 matrix->rows[i++].enabled_p = 0;
806 else
808 for (i = 0; i < matrix->nrows; ++i)
809 matrix->rows[i].enabled_p = 0;
812 else if (matrix == w->desired_matrix)
814 /* Rows in desired matrices always have to be cleared;
815 redisplay expects this is the case when it runs, so it
816 had better be the case when we adjust matrices between
817 redisplays. */
818 for (i = 0; i < matrix->nrows; ++i)
819 matrix->rows[i].enabled_p = 0;
824 /* Remember last values to be able to optimize frame redraws. */
825 matrix->matrix_x = x;
826 matrix->matrix_y = y;
827 matrix->matrix_w = dim.width;
828 matrix->matrix_h = dim.height;
830 /* Record the top y location and height of W at the time the matrix
831 was last adjusted. This is used to optimize redisplay above. */
832 if (w)
834 matrix->window_left_col = WINDOW_LEFT_EDGE_COL (w);
835 matrix->window_top_line = WINDOW_TOP_EDGE_LINE (w);
836 matrix->window_height = window_height;
837 matrix->window_width = window_width;
838 matrix->window_vscroll = w->vscroll;
843 /* Reverse the contents of rows in MATRIX between START and END. The
844 contents of the row at END - 1 end up at START, END - 2 at START +
845 1 etc. This is part of the implementation of rotate_matrix (see
846 below). */
848 static void
849 reverse_rows (matrix, start, end)
850 struct glyph_matrix *matrix;
851 int start, end;
853 int i, j;
855 for (i = start, j = end - 1; i < j; ++i, --j)
857 /* Non-ISO HP/UX compiler doesn't like auto struct
858 initialization. */
859 struct glyph_row temp;
860 temp = matrix->rows[i];
861 matrix->rows[i] = matrix->rows[j];
862 matrix->rows[j] = temp;
867 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
868 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
869 indices. (Note: this does not copy glyphs, only glyph pointers in
870 row structures are moved around).
872 The algorithm used for rotating the vector was, I believe, first
873 described by Kernighan. See the vector R as consisting of two
874 sub-vectors AB, where A has length BY for BY >= 0. The result
875 after rotating is then BA. Reverse both sub-vectors to get ArBr
876 and reverse the result to get (ArBr)r which is BA. Similar for
877 rotating right. */
879 void
880 rotate_matrix (matrix, first, last, by)
881 struct glyph_matrix *matrix;
882 int first, last, by;
884 if (by < 0)
886 /* Up (rotate left, i.e. towards lower indices). */
887 by = -by;
888 reverse_rows (matrix, first, first + by);
889 reverse_rows (matrix, first + by, last);
890 reverse_rows (matrix, first, last);
892 else if (by > 0)
894 /* Down (rotate right, i.e. towards higher indices). */
895 reverse_rows (matrix, last - by, last);
896 reverse_rows (matrix, first, last - by);
897 reverse_rows (matrix, first, last);
902 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
903 with indices START <= index < END. Increment positions by DELTA/
904 DELTA_BYTES. */
906 void
907 increment_matrix_positions (matrix, start, end, delta, delta_bytes)
908 struct glyph_matrix *matrix;
909 int start, end, delta, delta_bytes;
911 /* Check that START and END are reasonable values. */
912 xassert (start >= 0 && start <= matrix->nrows);
913 xassert (end >= 0 && end <= matrix->nrows);
914 xassert (start <= end);
916 for (; start < end; ++start)
917 increment_row_positions (matrix->rows + start, delta, delta_bytes);
921 /* Enable a range of rows in glyph matrix MATRIX. START and END are
922 the row indices of the first and last + 1 row to enable. If
923 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
925 void
926 enable_glyph_matrix_rows (matrix, start, end, enabled_p)
927 struct glyph_matrix *matrix;
928 int start, end;
929 int enabled_p;
931 xassert (start <= end);
932 xassert (start >= 0 && start < matrix->nrows);
933 xassert (end >= 0 && end <= matrix->nrows);
935 for (; start < end; ++start)
936 matrix->rows[start].enabled_p = enabled_p != 0;
940 /* Clear MATRIX.
942 This empties all rows in MATRIX by setting the enabled_p flag for
943 all rows of the matrix to zero. The function prepare_desired_row
944 will eventually really clear a row when it sees one with a zero
945 enabled_p flag.
947 Resets update hints to defaults value. The only update hint
948 currently present is the flag MATRIX->no_scrolling_p. */
950 void
951 clear_glyph_matrix (matrix)
952 struct glyph_matrix *matrix;
954 if (matrix)
956 enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
957 matrix->no_scrolling_p = 0;
962 /* Shift part of the glyph matrix MATRIX of window W up or down.
963 Increment y-positions in glyph rows between START and END by DY,
964 and recompute their visible height. */
966 void
967 shift_glyph_matrix (w, matrix, start, end, dy)
968 struct window *w;
969 struct glyph_matrix *matrix;
970 int start, end, dy;
972 int min_y, max_y;
974 xassert (start <= end);
975 xassert (start >= 0 && start < matrix->nrows);
976 xassert (end >= 0 && end <= matrix->nrows);
978 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
979 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
981 for (; start < end; ++start)
983 struct glyph_row *row = &matrix->rows[start];
985 row->y += dy;
986 row->visible_height = row->height;
988 if (row->y < min_y)
989 row->visible_height -= min_y - row->y;
990 if (row->y + row->height > max_y)
991 row->visible_height -= row->y + row->height - max_y;
996 /* Mark all rows in current matrices of frame F as invalid. Marking
997 invalid is done by setting enabled_p to zero for all rows in a
998 current matrix. */
1000 void
1001 clear_current_matrices (f)
1002 register struct frame *f;
1004 /* Clear frame current matrix, if we have one. */
1005 if (f->current_matrix)
1006 clear_glyph_matrix (f->current_matrix);
1008 /* Clear the matrix of the menu bar window, if such a window exists.
1009 The menu bar window is currently used to display menus on X when
1010 no toolkit support is compiled in. */
1011 if (WINDOWP (f->menu_bar_window))
1012 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1014 /* Clear the matrix of the tool-bar window, if any. */
1015 if (WINDOWP (f->tool_bar_window))
1016 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1018 /* Clear current window matrices. */
1019 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1020 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
1024 /* Clear out all display lines of F for a coming redisplay. */
1026 void
1027 clear_desired_matrices (f)
1028 register struct frame *f;
1030 if (f->desired_matrix)
1031 clear_glyph_matrix (f->desired_matrix);
1033 if (WINDOWP (f->menu_bar_window))
1034 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
1036 if (WINDOWP (f->tool_bar_window))
1037 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
1039 /* Do it for window matrices. */
1040 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1041 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
1045 /* Clear matrices in window tree rooted in W. If DESIRED_P is
1046 non-zero clear desired matrices, otherwise clear current matrices. */
1048 static void
1049 clear_window_matrices (w, desired_p)
1050 struct window *w;
1051 int desired_p;
1053 while (w)
1055 if (!NILP (w->hchild))
1057 xassert (WINDOWP (w->hchild));
1058 clear_window_matrices (XWINDOW (w->hchild), desired_p);
1060 else if (!NILP (w->vchild))
1062 xassert (WINDOWP (w->vchild));
1063 clear_window_matrices (XWINDOW (w->vchild), desired_p);
1065 else
1067 if (desired_p)
1068 clear_glyph_matrix (w->desired_matrix);
1069 else
1071 clear_glyph_matrix (w->current_matrix);
1072 w->window_end_valid = Qnil;
1076 w = NILP (w->next) ? 0 : XWINDOW (w->next);
1082 /***********************************************************************
1083 Glyph Rows
1085 See dispextern.h for an overall explanation of glyph rows.
1086 ***********************************************************************/
1088 /* Clear glyph row ROW. Do it in a way that makes it robust against
1089 changes in the glyph_row structure, i.e. addition or removal of
1090 structure members. */
1092 static struct glyph_row null_row;
1094 void
1095 clear_glyph_row (row)
1096 struct glyph_row *row;
1098 struct glyph *p[1 + LAST_AREA];
1100 /* Save pointers. */
1101 p[LEFT_MARGIN_AREA] = row->glyphs[LEFT_MARGIN_AREA];
1102 p[TEXT_AREA] = row->glyphs[TEXT_AREA];
1103 p[RIGHT_MARGIN_AREA] = row->glyphs[RIGHT_MARGIN_AREA];
1104 p[LAST_AREA] = row->glyphs[LAST_AREA];
1106 /* Clear. */
1107 *row = null_row;
1109 /* Restore pointers. */
1110 row->glyphs[LEFT_MARGIN_AREA] = p[LEFT_MARGIN_AREA];
1111 row->glyphs[TEXT_AREA] = p[TEXT_AREA];
1112 row->glyphs[RIGHT_MARGIN_AREA] = p[RIGHT_MARGIN_AREA];
1113 row->glyphs[LAST_AREA] = p[LAST_AREA];
1115 #if 0 /* At some point, some bit-fields of struct glyph were not set,
1116 which made glyphs unequal when compared with GLYPH_EQUAL_P.
1117 Redisplay outputs such glyphs, and flickering effects were
1118 the result. This also depended on the contents of memory
1119 returned by xmalloc. If flickering happens again, activate
1120 the code below. If the flickering is gone with that, chances
1121 are that the flickering has the same reason as here. */
1122 bzero (p[0], (char *) p[LAST_AREA] - (char *) p[0]);
1123 #endif
1127 /* Make ROW an empty, enabled row of canonical character height,
1128 in window W starting at y-position Y. */
1130 void
1131 blank_row (w, row, y)
1132 struct window *w;
1133 struct glyph_row *row;
1134 int y;
1136 int min_y, max_y;
1138 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1139 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1141 clear_glyph_row (row);
1142 row->y = y;
1143 row->ascent = row->phys_ascent = 0;
1144 row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
1145 row->visible_height = row->height;
1147 if (row->y < min_y)
1148 row->visible_height -= min_y - row->y;
1149 if (row->y + row->height > max_y)
1150 row->visible_height -= row->y + row->height - max_y;
1152 row->enabled_p = 1;
1156 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1157 are the amounts by which to change positions. Note that the first
1158 glyph of the text area of a row can have a buffer position even if
1159 the used count of the text area is zero. Such rows display line
1160 ends. */
1162 void
1163 increment_row_positions (row, delta, delta_bytes)
1164 struct glyph_row *row;
1165 int delta, delta_bytes;
1167 int area, i;
1169 /* Increment start and end positions. */
1170 MATRIX_ROW_START_CHARPOS (row) += delta;
1171 MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
1172 MATRIX_ROW_END_CHARPOS (row) += delta;
1173 MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
1175 if (!row->enabled_p)
1176 return;
1178 /* Increment positions in glyphs. */
1179 for (area = 0; area < LAST_AREA; ++area)
1180 for (i = 0; i < row->used[area]; ++i)
1181 if (BUFFERP (row->glyphs[area][i].object)
1182 && row->glyphs[area][i].charpos > 0)
1183 row->glyphs[area][i].charpos += delta;
1185 /* Capture the case of rows displaying a line end. */
1186 if (row->used[TEXT_AREA] == 0
1187 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
1188 row->glyphs[TEXT_AREA]->charpos += delta;
1192 #if 0
1193 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1194 contents, i.e. glyph structure contents are exchanged between A and
1195 B without changing glyph pointers in A and B. */
1197 static void
1198 swap_glyphs_in_rows (a, b)
1199 struct glyph_row *a, *b;
1201 int area;
1203 for (area = 0; area < LAST_AREA; ++area)
1205 /* Number of glyphs to swap. */
1206 int max_used = max (a->used[area], b->used[area]);
1208 /* Start of glyphs in area of row A. */
1209 struct glyph *glyph_a = a->glyphs[area];
1211 /* End + 1 of glyphs in area of row A. */
1212 struct glyph *glyph_a_end = a->glyphs[max_used];
1214 /* Start of glyphs in area of row B. */
1215 struct glyph *glyph_b = b->glyphs[area];
1217 while (glyph_a < glyph_a_end)
1219 /* Non-ISO HP/UX compiler doesn't like auto struct
1220 initialization. */
1221 struct glyph temp;
1222 temp = *glyph_a;
1223 *glyph_a = *glyph_b;
1224 *glyph_b = temp;
1225 ++glyph_a;
1226 ++glyph_b;
1231 #endif /* 0 */
1233 /* Exchange pointers to glyph memory between glyph rows A and B. */
1235 static INLINE void
1236 swap_glyph_pointers (a, b)
1237 struct glyph_row *a, *b;
1239 int i;
1240 for (i = 0; i < LAST_AREA + 1; ++i)
1242 struct glyph *temp = a->glyphs[i];
1243 a->glyphs[i] = b->glyphs[i];
1244 b->glyphs[i] = temp;
1249 /* Copy glyph row structure FROM to glyph row structure TO, except
1250 that glyph pointers in the structures are left unchanged. */
1252 INLINE void
1253 copy_row_except_pointers (to, from)
1254 struct glyph_row *to, *from;
1256 struct glyph *pointers[1 + LAST_AREA];
1258 /* Save glyph pointers of TO. */
1259 bcopy (to->glyphs, pointers, sizeof to->glyphs);
1261 /* Do a structure assignment. */
1262 *to = *from;
1264 /* Restore original pointers of TO. */
1265 bcopy (pointers, to->glyphs, sizeof to->glyphs);
1269 /* Copy contents of glyph row FROM to glyph row TO. Glyph pointers in
1270 TO and FROM are left unchanged. Glyph contents are copied from the
1271 glyph memory of FROM to the glyph memory of TO. Increment buffer
1272 positions in row TO by DELTA/ DELTA_BYTES. */
1274 void
1275 copy_glyph_row_contents (to, from, delta, delta_bytes)
1276 struct glyph_row *to, *from;
1277 int delta, delta_bytes;
1279 int area;
1281 /* This is like a structure assignment TO = FROM, except that
1282 glyph pointers in the rows are left unchanged. */
1283 copy_row_except_pointers (to, from);
1285 /* Copy glyphs from FROM to TO. */
1286 for (area = 0; area < LAST_AREA; ++area)
1287 if (from->used[area])
1288 bcopy (from->glyphs[area], to->glyphs[area],
1289 from->used[area] * sizeof (struct glyph));
1291 /* Increment buffer positions in TO by DELTA. */
1292 increment_row_positions (to, delta, delta_bytes);
1296 /* Assign glyph row FROM to glyph row TO. This works like a structure
1297 assignment TO = FROM, except that glyph pointers are not copied but
1298 exchanged between TO and FROM. Pointers must be exchanged to avoid
1299 a memory leak. */
1301 static INLINE void
1302 assign_row (to, from)
1303 struct glyph_row *to, *from;
1305 swap_glyph_pointers (to, from);
1306 copy_row_except_pointers (to, from);
1310 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1311 a row in a window matrix, is a slice of the glyph memory of the
1312 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1313 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1314 memory of FRAME_ROW. */
1316 #if GLYPH_DEBUG
1318 static int
1319 glyph_row_slice_p (window_row, frame_row)
1320 struct glyph_row *window_row, *frame_row;
1322 struct glyph *window_glyph_start = window_row->glyphs[0];
1323 struct glyph *frame_glyph_start = frame_row->glyphs[0];
1324 struct glyph *frame_glyph_end = frame_row->glyphs[LAST_AREA];
1326 return (frame_glyph_start <= window_glyph_start
1327 && window_glyph_start < frame_glyph_end);
1330 #endif /* GLYPH_DEBUG */
1332 #if 0
1334 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1335 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1336 in WINDOW_MATRIX is found satisfying the condition. */
1338 static struct glyph_row *
1339 find_glyph_row_slice (window_matrix, frame_matrix, row)
1340 struct glyph_matrix *window_matrix, *frame_matrix;
1341 int row;
1343 int i;
1345 xassert (row >= 0 && row < frame_matrix->nrows);
1347 for (i = 0; i < window_matrix->nrows; ++i)
1348 if (glyph_row_slice_p (window_matrix->rows + i,
1349 frame_matrix->rows + row))
1350 break;
1352 return i < window_matrix->nrows ? window_matrix->rows + i : 0;
1355 #endif /* 0 */
1357 /* Prepare ROW for display. Desired rows are cleared lazily,
1358 i.e. they are only marked as to be cleared by setting their
1359 enabled_p flag to zero. When a row is to be displayed, a prior
1360 call to this function really clears it. */
1362 void
1363 prepare_desired_row (row)
1364 struct glyph_row *row;
1366 if (!row->enabled_p)
1368 clear_glyph_row (row);
1369 row->enabled_p = 1;
1374 /* Return a hash code for glyph row ROW. */
1377 line_hash_code (row)
1378 struct glyph_row *row;
1380 int hash = 0;
1382 if (row->enabled_p)
1384 struct glyph *glyph = row->glyphs[TEXT_AREA];
1385 struct glyph *end = glyph + row->used[TEXT_AREA];
1387 while (glyph < end)
1389 int c = glyph->u.ch;
1390 int face_id = glyph->face_id;
1391 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1392 c -= SPACEGLYPH;
1393 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + c;
1394 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + face_id;
1395 ++glyph;
1398 if (hash == 0)
1399 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 (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
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->fill_line_p != b->fill_line_p
1508 || a->cursor_in_fringe_p != b->cursor_in_fringe_p
1509 || a->left_fringe_bitmap != b->left_fringe_bitmap
1510 || a->left_fringe_face_id != b->left_fringe_face_id
1511 || a->right_fringe_bitmap != b->right_fringe_bitmap
1512 || a->right_fringe_face_id != b->right_fringe_face_id
1513 || a->overlay_arrow_bitmap != b->overlay_arrow_bitmap
1514 || a->exact_window_width_line_p != b->exact_window_width_line_p
1515 || a->overlapped_p != b->overlapped_p
1516 || (MATRIX_ROW_CONTINUATION_LINE_P (a)
1517 != MATRIX_ROW_CONTINUATION_LINE_P (b))
1518 /* Different partially visible characters on left margin. */
1519 || a->x != b->x
1520 /* Different height. */
1521 || a->ascent != b->ascent
1522 || a->phys_ascent != b->phys_ascent
1523 || a->phys_height != b->phys_height
1524 || a->visible_height != b->visible_height)
1525 return 0;
1528 return 1;
1533 /***********************************************************************
1534 Glyph Pool
1536 See dispextern.h for an overall explanation of glyph pools.
1537 ***********************************************************************/
1539 /* Allocate a glyph_pool structure. The structure returned is
1540 initialized with zeros. The global variable glyph_pool_count is
1541 incremented for each pool allocated. */
1543 static struct glyph_pool *
1544 new_glyph_pool ()
1546 struct glyph_pool *result;
1548 /* Allocate a new glyph_pool and clear it. */
1549 result = (struct glyph_pool *) xmalloc (sizeof *result);
1550 bzero (result, sizeof *result);
1552 /* For memory leak and double deletion checking. */
1553 ++glyph_pool_count;
1555 return result;
1559 /* Free a glyph_pool structure POOL. The function may be called with
1560 a null POOL pointer. The global variable glyph_pool_count is
1561 decremented with every pool structure freed. If this count gets
1562 negative, more structures were freed than allocated, i.e. one
1563 structure must have been freed more than once or a bogus pointer
1564 was passed to free_glyph_pool. */
1566 static void
1567 free_glyph_pool (pool)
1568 struct glyph_pool *pool;
1570 if (pool)
1572 /* More freed than allocated? */
1573 --glyph_pool_count;
1574 xassert (glyph_pool_count >= 0);
1576 xfree (pool->glyphs);
1577 xfree (pool);
1582 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1583 columns we need. This function never shrinks a pool. The only
1584 case in which this would make sense, would be when a frame's size
1585 is changed from a large value to a smaller one. But, if someone
1586 does it once, we can expect that he will do it again.
1588 Value is non-zero if the pool changed in a way which makes
1589 re-adjusting window glyph matrices necessary. */
1591 static int
1592 realloc_glyph_pool (pool, matrix_dim)
1593 struct glyph_pool *pool;
1594 struct dim matrix_dim;
1596 int needed;
1597 int changed_p;
1599 changed_p = (pool->glyphs == 0
1600 || matrix_dim.height != pool->nrows
1601 || matrix_dim.width != pool->ncolumns);
1603 /* Enlarge the glyph pool. */
1604 needed = matrix_dim.width * matrix_dim.height;
1605 if (needed > pool->nglyphs)
1607 int size = needed * sizeof (struct glyph);
1609 if (pool->glyphs)
1610 pool->glyphs = (struct glyph *) xrealloc (pool->glyphs, size);
1611 else
1613 pool->glyphs = (struct glyph *) xmalloc (size);
1614 bzero (pool->glyphs, size);
1617 pool->nglyphs = needed;
1620 /* Remember the number of rows and columns because (a) we use them
1621 to do sanity checks, and (b) the number of columns determines
1622 where rows in the frame matrix start---this must be available to
1623 determine pointers to rows of window sub-matrices. */
1624 pool->nrows = matrix_dim.height;
1625 pool->ncolumns = matrix_dim.width;
1627 return changed_p;
1632 /***********************************************************************
1633 Debug Code
1634 ***********************************************************************/
1636 #if GLYPH_DEBUG
1639 /* Flush standard output. This is sometimes useful to call from the debugger.
1640 XXX Maybe this should be changed to flush the current terminal instead of
1641 stdout.
1644 void
1645 flush_stdout ()
1647 fflush (stdout);
1651 /* Check that no glyph pointers have been lost in MATRIX. If a
1652 pointer has been lost, e.g. by using a structure assignment between
1653 rows, at least one pointer must occur more than once in the rows of
1654 MATRIX. */
1656 void
1657 check_matrix_pointer_lossage (matrix)
1658 struct glyph_matrix *matrix;
1660 int i, j;
1662 for (i = 0; i < matrix->nrows; ++i)
1663 for (j = 0; j < matrix->nrows; ++j)
1664 xassert (i == j
1665 || (matrix->rows[i].glyphs[TEXT_AREA]
1666 != matrix->rows[j].glyphs[TEXT_AREA]));
1670 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1672 struct glyph_row *
1673 matrix_row (matrix, row)
1674 struct glyph_matrix *matrix;
1675 int row;
1677 xassert (matrix && matrix->rows);
1678 xassert (row >= 0 && row < matrix->nrows);
1680 /* That's really too slow for normal testing because this function
1681 is called almost everywhere. Although---it's still astonishingly
1682 fast, so it is valuable to have for debugging purposes. */
1683 #if 0
1684 check_matrix_pointer_lossage (matrix);
1685 #endif
1687 return matrix->rows + row;
1691 #if 0 /* This function makes invalid assumptions when text is
1692 partially invisible. But it might come handy for debugging
1693 nevertheless. */
1695 /* Check invariants that must hold for an up to date current matrix of
1696 window W. */
1698 static void
1699 check_matrix_invariants (w)
1700 struct window *w;
1702 struct glyph_matrix *matrix = w->current_matrix;
1703 int yb = window_text_bottom_y (w);
1704 struct glyph_row *row = matrix->rows;
1705 struct glyph_row *last_text_row = NULL;
1706 struct buffer *saved = current_buffer;
1707 struct buffer *buffer = XBUFFER (w->buffer);
1708 int c;
1710 /* This can sometimes happen for a fresh window. */
1711 if (matrix->nrows < 2)
1712 return;
1714 set_buffer_temp (buffer);
1716 /* Note: last row is always reserved for the mode line. */
1717 while (MATRIX_ROW_DISPLAYS_TEXT_P (row)
1718 && MATRIX_ROW_BOTTOM_Y (row) < yb)
1720 struct glyph_row *next = row + 1;
1722 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
1723 last_text_row = row;
1725 /* Check that character and byte positions are in sync. */
1726 xassert (MATRIX_ROW_START_BYTEPOS (row)
1727 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row)));
1729 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1730 have such a position temporarily in case of a minibuffer
1731 displaying something like `[Sole completion]' at its end. */
1732 if (MATRIX_ROW_END_CHARPOS (row) < BUF_ZV (current_buffer))
1733 xassert (MATRIX_ROW_END_BYTEPOS (row)
1734 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row)));
1736 /* Check that end position of `row' is equal to start position
1737 of next row. */
1738 if (next->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (next))
1740 xassert (MATRIX_ROW_END_CHARPOS (row)
1741 == MATRIX_ROW_START_CHARPOS (next));
1742 xassert (MATRIX_ROW_END_BYTEPOS (row)
1743 == MATRIX_ROW_START_BYTEPOS (next));
1745 row = next;
1748 xassert (w->current_matrix->nrows == w->desired_matrix->nrows);
1749 xassert (w->desired_matrix->rows != NULL);
1750 set_buffer_temp (saved);
1753 #endif /* 0 */
1755 #endif /* GLYPH_DEBUG != 0 */
1759 /**********************************************************************
1760 Allocating/ Adjusting Glyph Matrices
1761 **********************************************************************/
1763 /* Allocate glyph matrices over a window tree for a frame-based
1764 redisplay
1766 X and Y are column/row within the frame glyph matrix where
1767 sub-matrices for the window tree rooted at WINDOW must be
1768 allocated. CH_DIM contains the dimensions of the smallest
1769 character that could be used during display. DIM_ONLY_P non-zero
1770 means that the caller of this function is only interested in the
1771 result matrix dimension, and matrix adjustments should not be
1772 performed.
1774 The function returns the total width/height of the sub-matrices of
1775 the window tree. If called on a frame root window, the computation
1776 will take the mini-buffer window into account.
1778 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1780 NEW_LEAF_MATRIX set if any window in the tree did not have a
1781 glyph matrices yet, and
1783 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1784 any window in the tree will be changed or have been changed (see
1785 DIM_ONLY_P)
1787 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1788 function.
1790 Windows are arranged into chains of windows on the same level
1791 through the next fields of window structures. Such a level can be
1792 either a sequence of horizontally adjacent windows from left to
1793 right, or a sequence of vertically adjacent windows from top to
1794 bottom. Each window in a horizontal sequence can be either a leaf
1795 window or a vertical sequence; a window in a vertical sequence can
1796 be either a leaf or a horizontal sequence. All windows in a
1797 horizontal sequence have the same height, and all windows in a
1798 vertical sequence have the same width.
1800 This function uses, for historical reasons, a more general
1801 algorithm to determine glyph matrix dimensions that would be
1802 necessary.
1804 The matrix height of a horizontal sequence is determined by the
1805 maximum height of any matrix in the sequence. The matrix width of
1806 a horizontal sequence is computed by adding up matrix widths of
1807 windows in the sequence.
1809 |<------- result width ------->|
1810 +---------+----------+---------+ ---
1811 | | | | |
1812 | | | |
1813 +---------+ | | result height
1814 | +---------+
1815 | | |
1816 +----------+ ---
1818 The matrix width of a vertical sequence is the maximum matrix width
1819 of any window in the sequence. Its height is computed by adding up
1820 matrix heights of windows in the sequence.
1822 |<---- result width -->|
1823 +---------+ ---
1824 | | |
1825 | | |
1826 +---------+--+ |
1827 | | |
1828 | | result height
1830 +------------+---------+ |
1831 | | |
1832 | | |
1833 +------------+---------+ --- */
1835 /* Bit indicating that a new matrix will be allocated or has been
1836 allocated. */
1838 #define NEW_LEAF_MATRIX (1 << 0)
1840 /* Bit indicating that a matrix will or has changed its location or
1841 size. */
1843 #define CHANGED_LEAF_MATRIX (1 << 1)
1845 static struct dim
1846 allocate_matrices_for_frame_redisplay (window, x, y, dim_only_p,
1847 window_change_flags)
1848 Lisp_Object window;
1849 int x, y;
1850 int dim_only_p;
1851 int *window_change_flags;
1853 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1854 int x0 = x, y0 = y;
1855 int wmax = 0, hmax = 0;
1856 struct dim total;
1857 struct dim dim;
1858 struct window *w;
1859 int in_horz_combination_p;
1861 /* What combination is WINDOW part of? Compute this once since the
1862 result is the same for all windows in the `next' chain. The
1863 special case of a root window (parent equal to nil) is treated
1864 like a vertical combination because a root window's `next'
1865 points to the mini-buffer window, if any, which is arranged
1866 vertically below other windows. */
1867 in_horz_combination_p
1868 = (!NILP (XWINDOW (window)->parent)
1869 && !NILP (XWINDOW (XWINDOW (window)->parent)->hchild));
1871 /* For WINDOW and all windows on the same level. */
1874 w = XWINDOW (window);
1876 /* Get the dimension of the window sub-matrix for W, depending
1877 on whether this is a combination or a leaf window. */
1878 if (!NILP (w->hchild))
1879 dim = allocate_matrices_for_frame_redisplay (w->hchild, x, y,
1880 dim_only_p,
1881 window_change_flags);
1882 else if (!NILP (w->vchild))
1883 dim = allocate_matrices_for_frame_redisplay (w->vchild, x, y,
1884 dim_only_p,
1885 window_change_flags);
1886 else
1888 /* If not already done, allocate sub-matrix structures. */
1889 if (w->desired_matrix == NULL)
1891 w->desired_matrix = new_glyph_matrix (f->desired_pool);
1892 w->current_matrix = new_glyph_matrix (f->current_pool);
1893 *window_change_flags |= NEW_LEAF_MATRIX;
1896 /* Width and height MUST be chosen so that there are no
1897 holes in the frame matrix. */
1898 dim.width = required_matrix_width (w);
1899 dim.height = required_matrix_height (w);
1901 /* Will matrix be re-allocated? */
1902 if (x != w->desired_matrix->matrix_x
1903 || y != w->desired_matrix->matrix_y
1904 || dim.width != w->desired_matrix->matrix_w
1905 || dim.height != w->desired_matrix->matrix_h
1906 || (margin_glyphs_to_reserve (w, dim.width,
1907 w->left_margin_cols)
1908 != w->desired_matrix->left_margin_glyphs)
1909 || (margin_glyphs_to_reserve (w, dim.width,
1910 w->right_margin_cols)
1911 != w->desired_matrix->right_margin_glyphs))
1912 *window_change_flags |= CHANGED_LEAF_MATRIX;
1914 /* Actually change matrices, if allowed. Do not consider
1915 CHANGED_LEAF_MATRIX computed above here because the pool
1916 may have been changed which we don't now here. We trust
1917 that we only will be called with DIM_ONLY_P != 0 when
1918 necessary. */
1919 if (!dim_only_p)
1921 adjust_glyph_matrix (w, w->desired_matrix, x, y, dim);
1922 adjust_glyph_matrix (w, w->current_matrix, x, y, dim);
1926 /* If we are part of a horizontal combination, advance x for
1927 windows to the right of W; otherwise advance y for windows
1928 below W. */
1929 if (in_horz_combination_p)
1930 x += dim.width;
1931 else
1932 y += dim.height;
1934 /* Remember maximum glyph matrix dimensions. */
1935 wmax = max (wmax, dim.width);
1936 hmax = max (hmax, dim.height);
1938 /* Next window on same level. */
1939 window = w->next;
1941 while (!NILP (window));
1943 /* Set `total' to the total glyph matrix dimension of this window
1944 level. In a vertical combination, the width is the width of the
1945 widest window; the height is the y we finally reached, corrected
1946 by the y we started with. In a horizontal combination, the total
1947 height is the height of the tallest window, and the width is the
1948 x we finally reached, corrected by the x we started with. */
1949 if (in_horz_combination_p)
1951 total.width = x - x0;
1952 total.height = hmax;
1954 else
1956 total.width = wmax;
1957 total.height = y - y0;
1960 return total;
1964 /* Return the required height of glyph matrices for window W. */
1967 required_matrix_height (w)
1968 struct window *w;
1970 #ifdef HAVE_WINDOW_SYSTEM
1971 struct frame *f = XFRAME (w->frame);
1973 if (FRAME_WINDOW_P (f))
1975 int ch_height = FRAME_SMALLEST_FONT_HEIGHT (f);
1976 int window_pixel_height = window_box_height (w) + abs (w->vscroll);
1977 return (((window_pixel_height + ch_height - 1)
1978 / ch_height) * w->nrows_scale_factor
1979 /* One partially visible line at the top and
1980 bottom of the window. */
1982 /* 2 for header and mode line. */
1983 + 2);
1985 #endif /* HAVE_WINDOW_SYSTEM */
1987 return WINDOW_TOTAL_LINES (w);
1991 /* Return the required width of glyph matrices for window W. */
1994 required_matrix_width (w)
1995 struct window *w;
1997 #ifdef HAVE_WINDOW_SYSTEM
1998 struct frame *f = XFRAME (w->frame);
1999 if (FRAME_WINDOW_P (f))
2001 int ch_width = FRAME_SMALLEST_CHAR_WIDTH (f);
2002 int window_pixel_width = WINDOW_TOTAL_WIDTH (w);
2004 /* Compute number of glyphs needed in a glyph row. */
2005 return (((window_pixel_width + ch_width - 1)
2006 / ch_width) * w->ncols_scale_factor
2007 /* 2 partially visible columns in the text area. */
2009 /* One partially visible column at the right
2010 edge of each marginal area. */
2011 + 1 + 1);
2013 #endif /* HAVE_WINDOW_SYSTEM */
2015 return XINT (w->total_cols);
2019 /* Allocate window matrices for window-based redisplay. W is the
2020 window whose matrices must be allocated/reallocated. CH_DIM is the
2021 size of the smallest character that could potentially be used on W. */
2023 static void
2024 allocate_matrices_for_window_redisplay (w)
2025 struct window *w;
2027 while (w)
2029 if (!NILP (w->vchild))
2030 allocate_matrices_for_window_redisplay (XWINDOW (w->vchild));
2031 else if (!NILP (w->hchild))
2032 allocate_matrices_for_window_redisplay (XWINDOW (w->hchild));
2033 else
2035 /* W is a leaf window. */
2036 struct dim dim;
2038 /* If matrices are not yet allocated, allocate them now. */
2039 if (w->desired_matrix == NULL)
2041 w->desired_matrix = new_glyph_matrix (NULL);
2042 w->current_matrix = new_glyph_matrix (NULL);
2045 dim.width = required_matrix_width (w);
2046 dim.height = required_matrix_height (w);
2047 adjust_glyph_matrix (w, w->desired_matrix, 0, 0, dim);
2048 adjust_glyph_matrix (w, w->current_matrix, 0, 0, dim);
2051 w = NILP (w->next) ? NULL : XWINDOW (w->next);
2056 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
2057 do it for all frames; otherwise do it just for the given frame.
2058 This function must be called when a new frame is created, its size
2059 changes, or its window configuration changes. */
2061 void
2062 adjust_glyphs (f)
2063 struct frame *f;
2065 /* Block input so that expose events and other events that access
2066 glyph matrices are not processed while we are changing them. */
2067 BLOCK_INPUT;
2069 if (f)
2070 adjust_frame_glyphs (f);
2071 else
2073 Lisp_Object tail, lisp_frame;
2075 FOR_EACH_FRAME (tail, lisp_frame)
2076 adjust_frame_glyphs (XFRAME (lisp_frame));
2079 UNBLOCK_INPUT;
2083 /* Adjust frame glyphs when Emacs is initialized.
2085 To be called from init_display.
2087 We need a glyph matrix because redraw will happen soon.
2088 Unfortunately, window sizes on selected_frame are not yet set to
2089 meaningful values. I believe we can assume that there are only two
2090 windows on the frame---the mini-buffer and the root window. Frame
2091 height and width seem to be correct so far. So, set the sizes of
2092 windows to estimated values. */
2094 static void
2095 adjust_frame_glyphs_initially ()
2097 struct frame *sf = SELECTED_FRAME ();
2098 struct window *root = XWINDOW (sf->root_window);
2099 struct window *mini = XWINDOW (root->next);
2100 int frame_lines = FRAME_LINES (sf);
2101 int frame_cols = FRAME_COLS (sf);
2102 int top_margin = FRAME_TOP_MARGIN (sf);
2104 /* Do it for the root window. */
2105 XSETFASTINT (root->top_line, top_margin);
2106 XSETFASTINT (root->total_cols, frame_cols);
2107 set_window_height (sf->root_window, frame_lines - 1 - top_margin, 0);
2109 /* Do it for the mini-buffer window. */
2110 XSETFASTINT (mini->top_line, frame_lines - 1);
2111 XSETFASTINT (mini->total_cols, frame_cols);
2112 set_window_height (root->next, 1, 0);
2114 adjust_frame_glyphs (sf);
2115 glyphs_initialized_initially_p = 1;
2119 /* Allocate/reallocate glyph matrices of a single frame F. */
2121 static void
2122 adjust_frame_glyphs (f)
2123 struct frame *f;
2125 if (FRAME_WINDOW_P (f))
2126 adjust_frame_glyphs_for_window_redisplay (f);
2127 else
2128 adjust_frame_glyphs_for_frame_redisplay (f);
2130 /* Don't forget the message buffer and the buffer for
2131 decode_mode_spec. */
2132 adjust_frame_message_buffer (f);
2133 adjust_decode_mode_spec_buffer (f);
2135 f->glyphs_initialized_p = 1;
2139 /* In the window tree with root W, build current matrices of leaf
2140 windows from the frame's current matrix. */
2142 static void
2143 fake_current_matrices (window)
2144 Lisp_Object window;
2146 struct window *w;
2148 for (; !NILP (window); window = w->next)
2150 w = XWINDOW (window);
2152 if (!NILP (w->hchild))
2153 fake_current_matrices (w->hchild);
2154 else if (!NILP (w->vchild))
2155 fake_current_matrices (w->vchild);
2156 else
2158 int i;
2159 struct frame *f = XFRAME (w->frame);
2160 struct glyph_matrix *m = w->current_matrix;
2161 struct glyph_matrix *fm = f->current_matrix;
2163 xassert (m->matrix_h == WINDOW_TOTAL_LINES (w));
2164 xassert (m->matrix_w == WINDOW_TOTAL_COLS (w));
2166 for (i = 0; i < m->matrix_h; ++i)
2168 struct glyph_row *r = m->rows + i;
2169 struct glyph_row *fr = fm->rows + i + WINDOW_TOP_EDGE_LINE (w);
2171 xassert (r->glyphs[TEXT_AREA] >= fr->glyphs[TEXT_AREA]
2172 && r->glyphs[LAST_AREA] <= fr->glyphs[LAST_AREA]);
2174 r->enabled_p = fr->enabled_p;
2175 if (r->enabled_p)
2177 r->used[LEFT_MARGIN_AREA] = m->left_margin_glyphs;
2178 r->used[RIGHT_MARGIN_AREA] = m->right_margin_glyphs;
2179 r->used[TEXT_AREA] = (m->matrix_w
2180 - r->used[LEFT_MARGIN_AREA]
2181 - r->used[RIGHT_MARGIN_AREA]);
2182 r->mode_line_p = 0;
2190 /* Save away the contents of frame F's current frame matrix. Value is
2191 a glyph matrix holding the contents of F's current frame matrix. */
2193 static struct glyph_matrix *
2194 save_current_matrix (f)
2195 struct frame *f;
2197 int i;
2198 struct glyph_matrix *saved;
2200 saved = (struct glyph_matrix *) xmalloc (sizeof *saved);
2201 bzero (saved, sizeof *saved);
2202 saved->nrows = f->current_matrix->nrows;
2203 saved->rows = (struct glyph_row *) xmalloc (saved->nrows
2204 * sizeof *saved->rows);
2205 bzero (saved->rows, saved->nrows * sizeof *saved->rows);
2207 for (i = 0; i < saved->nrows; ++i)
2209 struct glyph_row *from = f->current_matrix->rows + i;
2210 struct glyph_row *to = saved->rows + i;
2211 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2212 to->glyphs[TEXT_AREA] = (struct glyph *) xmalloc (nbytes);
2213 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2214 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2217 return saved;
2221 /* Restore the contents of frame F's current frame matrix from SAVED,
2222 and free memory associated with SAVED. */
2224 static void
2225 restore_current_matrix (f, saved)
2226 struct frame *f;
2227 struct glyph_matrix *saved;
2229 int i;
2231 for (i = 0; i < saved->nrows; ++i)
2233 struct glyph_row *from = saved->rows + i;
2234 struct glyph_row *to = f->current_matrix->rows + i;
2235 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2236 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2237 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2238 xfree (from->glyphs[TEXT_AREA]);
2241 xfree (saved->rows);
2242 xfree (saved);
2247 /* Allocate/reallocate glyph matrices of a single frame F for
2248 frame-based redisplay. */
2250 static void
2251 adjust_frame_glyphs_for_frame_redisplay (f)
2252 struct frame *f;
2254 struct dim ch_dim;
2255 struct dim matrix_dim;
2256 int pool_changed_p;
2257 int window_change_flags;
2258 int top_window_y;
2260 if (!FRAME_LIVE_P (f))
2261 return;
2263 /* Determine the smallest character in any font for F. On
2264 console windows, all characters have dimension (1, 1). */
2265 ch_dim.width = ch_dim.height = 1;
2267 top_window_y = FRAME_TOP_MARGIN (f);
2269 /* Allocate glyph pool structures if not already done. */
2270 if (f->desired_pool == NULL)
2272 f->desired_pool = new_glyph_pool ();
2273 f->current_pool = new_glyph_pool ();
2276 /* Allocate frames matrix structures if needed. */
2277 if (f->desired_matrix == NULL)
2279 f->desired_matrix = new_glyph_matrix (f->desired_pool);
2280 f->current_matrix = new_glyph_matrix (f->current_pool);
2283 /* Compute window glyph matrices. (This takes the mini-buffer
2284 window into account). The result is the size of the frame glyph
2285 matrix needed. The variable window_change_flags is set to a bit
2286 mask indicating whether new matrices will be allocated or
2287 existing matrices change their size or location within the frame
2288 matrix. */
2289 window_change_flags = 0;
2290 matrix_dim
2291 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2292 0, top_window_y,
2294 &window_change_flags);
2296 /* Add in menu bar lines, if any. */
2297 matrix_dim.height += top_window_y;
2299 /* Enlarge pools as necessary. */
2300 pool_changed_p = realloc_glyph_pool (f->desired_pool, matrix_dim);
2301 realloc_glyph_pool (f->current_pool, matrix_dim);
2303 /* Set up glyph pointers within window matrices. Do this only if
2304 absolutely necessary since it requires a frame redraw. */
2305 if (pool_changed_p || window_change_flags)
2307 /* Do it for window matrices. */
2308 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2309 0, top_window_y, 0,
2310 &window_change_flags);
2312 /* Size of frame matrices must equal size of frame. Note
2313 that we are called for X frames with window widths NOT equal
2314 to the frame width (from CHANGE_FRAME_SIZE_1). */
2315 xassert (matrix_dim.width == FRAME_COLS (f)
2316 && matrix_dim.height == FRAME_LINES (f));
2318 /* Pointers to glyph memory in glyph rows are exchanged during
2319 the update phase of redisplay, which means in general that a
2320 frame's current matrix consists of pointers into both the
2321 desired and current glyph pool of the frame. Adjusting a
2322 matrix sets the frame matrix up so that pointers are all into
2323 the same pool. If we want to preserve glyph contents of the
2324 current matrix over a call to adjust_glyph_matrix, we must
2325 make a copy of the current glyphs, and restore the current
2326 matrix' contents from that copy. */
2327 if (display_completed
2328 && !FRAME_GARBAGED_P (f)
2329 && matrix_dim.width == f->current_matrix->matrix_w
2330 && matrix_dim.height == f->current_matrix->matrix_h)
2332 struct glyph_matrix *copy = save_current_matrix (f);
2333 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2334 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2335 restore_current_matrix (f, copy);
2336 fake_current_matrices (FRAME_ROOT_WINDOW (f));
2338 else
2340 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2341 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2342 SET_FRAME_GARBAGED (f);
2348 /* Allocate/reallocate glyph matrices of a single frame F for
2349 window-based redisplay. */
2351 static void
2352 adjust_frame_glyphs_for_window_redisplay (f)
2353 struct frame *f;
2355 struct dim ch_dim;
2356 struct window *w;
2358 xassert (FRAME_WINDOW_P (f) && FRAME_LIVE_P (f));
2360 /* Get minimum sizes. */
2361 #ifdef HAVE_WINDOW_SYSTEM
2362 ch_dim.width = FRAME_SMALLEST_CHAR_WIDTH (f);
2363 ch_dim.height = FRAME_SMALLEST_FONT_HEIGHT (f);
2364 #else
2365 ch_dim.width = ch_dim.height = 1;
2366 #endif
2368 /* Allocate/reallocate window matrices. */
2369 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f)));
2371 /* Allocate/ reallocate matrices of the dummy window used to display
2372 the menu bar under X when no X toolkit support is available. */
2373 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2375 /* Allocate a dummy window if not already done. */
2376 if (NILP (f->menu_bar_window))
2378 f->menu_bar_window = make_window ();
2379 w = XWINDOW (f->menu_bar_window);
2380 XSETFRAME (w->frame, f);
2381 w->pseudo_window_p = 1;
2383 else
2384 w = XWINDOW (f->menu_bar_window);
2386 /* Set window dimensions to frame dimensions and allocate or
2387 adjust glyph matrices of W. */
2388 XSETFASTINT (w->top_line, 0);
2389 XSETFASTINT (w->left_col, 0);
2390 XSETFASTINT (w->total_lines, FRAME_MENU_BAR_LINES (f));
2391 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2392 allocate_matrices_for_window_redisplay (w);
2394 #endif /* not USE_X_TOOLKIT */
2396 #ifndef USE_GTK
2397 /* Allocate/ reallocate matrices of the tool bar window. If we
2398 don't have a tool bar window yet, make one. */
2399 if (NILP (f->tool_bar_window))
2401 f->tool_bar_window = make_window ();
2402 w = XWINDOW (f->tool_bar_window);
2403 XSETFRAME (w->frame, f);
2404 w->pseudo_window_p = 1;
2406 else
2407 w = XWINDOW (f->tool_bar_window);
2409 XSETFASTINT (w->top_line, FRAME_MENU_BAR_LINES (f));
2410 XSETFASTINT (w->left_col, 0);
2411 XSETFASTINT (w->total_lines, FRAME_TOOL_BAR_LINES (f));
2412 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2413 allocate_matrices_for_window_redisplay (w);
2414 #endif
2418 /* Adjust/ allocate message buffer of frame F.
2420 Note that the message buffer is never freed. Since I could not
2421 find a free in 19.34, I assume that freeing it would be
2422 problematic in some way and don't do it either.
2424 (Implementation note: It should be checked if we can free it
2425 eventually without causing trouble). */
2427 static void
2428 adjust_frame_message_buffer (f)
2429 struct frame *f;
2431 int size = FRAME_MESSAGE_BUF_SIZE (f) + 1;
2433 if (FRAME_MESSAGE_BUF (f))
2435 char *buffer = FRAME_MESSAGE_BUF (f);
2436 char *new_buffer = (char *) xrealloc (buffer, size);
2437 FRAME_MESSAGE_BUF (f) = new_buffer;
2439 else
2440 FRAME_MESSAGE_BUF (f) = (char *) xmalloc (size);
2444 /* Re-allocate buffer for decode_mode_spec on frame F. */
2446 static void
2447 adjust_decode_mode_spec_buffer (f)
2448 struct frame *f;
2450 f->decode_mode_spec_buffer
2451 = (char *) xrealloc (f->decode_mode_spec_buffer,
2452 FRAME_MESSAGE_BUF_SIZE (f) + 1);
2457 /**********************************************************************
2458 Freeing Glyph Matrices
2459 **********************************************************************/
2461 /* Free glyph memory for a frame F. F may be null. This function can
2462 be called for the same frame more than once. The root window of
2463 F may be nil when this function is called. This is the case when
2464 the function is called when F is destroyed. */
2466 void
2467 free_glyphs (f)
2468 struct frame *f;
2470 if (f && f->glyphs_initialized_p)
2472 /* Block interrupt input so that we don't get surprised by an X
2473 event while we're in an inconsistent state. */
2474 BLOCK_INPUT;
2475 f->glyphs_initialized_p = 0;
2477 /* Release window sub-matrices. */
2478 if (!NILP (f->root_window))
2479 free_window_matrices (XWINDOW (f->root_window));
2481 /* Free the dummy window for menu bars without X toolkit and its
2482 glyph matrices. */
2483 if (!NILP (f->menu_bar_window))
2485 struct window *w = XWINDOW (f->menu_bar_window);
2486 free_glyph_matrix (w->desired_matrix);
2487 free_glyph_matrix (w->current_matrix);
2488 w->desired_matrix = w->current_matrix = NULL;
2489 f->menu_bar_window = Qnil;
2492 /* Free the tool bar window and its glyph matrices. */
2493 if (!NILP (f->tool_bar_window))
2495 struct window *w = XWINDOW (f->tool_bar_window);
2496 free_glyph_matrix (w->desired_matrix);
2497 free_glyph_matrix (w->current_matrix);
2498 w->desired_matrix = w->current_matrix = NULL;
2499 f->tool_bar_window = Qnil;
2502 /* Release frame glyph matrices. Reset fields to zero in
2503 case we are called a second time. */
2504 if (f->desired_matrix)
2506 free_glyph_matrix (f->desired_matrix);
2507 free_glyph_matrix (f->current_matrix);
2508 f->desired_matrix = f->current_matrix = NULL;
2511 /* Release glyph pools. */
2512 if (f->desired_pool)
2514 free_glyph_pool (f->desired_pool);
2515 free_glyph_pool (f->current_pool);
2516 f->desired_pool = f->current_pool = NULL;
2519 UNBLOCK_INPUT;
2524 /* Free glyph sub-matrices in the window tree rooted at W. This
2525 function may be called with a null pointer, and it may be called on
2526 the same tree more than once. */
2528 void
2529 free_window_matrices (w)
2530 struct window *w;
2532 while (w)
2534 if (!NILP (w->hchild))
2535 free_window_matrices (XWINDOW (w->hchild));
2536 else if (!NILP (w->vchild))
2537 free_window_matrices (XWINDOW (w->vchild));
2538 else
2540 /* This is a leaf window. Free its memory and reset fields
2541 to zero in case this function is called a second time for
2542 W. */
2543 free_glyph_matrix (w->current_matrix);
2544 free_glyph_matrix (w->desired_matrix);
2545 w->current_matrix = w->desired_matrix = NULL;
2548 /* Next window on same level. */
2549 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2554 /* Check glyph memory leaks. This function is called from
2555 shut_down_emacs. Note that frames are not destroyed when Emacs
2556 exits. We therefore free all glyph memory for all active frames
2557 explicitly and check that nothing is left allocated. */
2559 void
2560 check_glyph_memory ()
2562 Lisp_Object tail, frame;
2564 /* Free glyph memory for all frames. */
2565 FOR_EACH_FRAME (tail, frame)
2566 free_glyphs (XFRAME (frame));
2568 /* Check that nothing is left allocated. */
2569 if (glyph_matrix_count)
2570 abort ();
2571 if (glyph_pool_count)
2572 abort ();
2577 /**********************************************************************
2578 Building a Frame Matrix
2579 **********************************************************************/
2581 /* Most of the redisplay code works on glyph matrices attached to
2582 windows. This is a good solution most of the time, but it is not
2583 suitable for terminal code. Terminal output functions cannot rely
2584 on being able to set an arbitrary terminal window. Instead they
2585 must be provided with a view of the whole frame, i.e. the whole
2586 screen. We build such a view by constructing a frame matrix from
2587 window matrices in this section.
2589 Windows that must be updated have their must_be_update_p flag set.
2590 For all such windows, their desired matrix is made part of the
2591 desired frame matrix. For other windows, their current matrix is
2592 made part of the desired frame matrix.
2594 +-----------------+----------------+
2595 | desired | desired |
2596 | | |
2597 +-----------------+----------------+
2598 | current |
2600 +----------------------------------+
2602 Desired window matrices can be made part of the frame matrix in a
2603 cheap way: We exploit the fact that the desired frame matrix and
2604 desired window matrices share their glyph memory. This is not
2605 possible for current window matrices. Their glyphs are copied to
2606 the desired frame matrix. The latter is equivalent to
2607 preserve_other_columns in the old redisplay.
2609 Used glyphs counters for frame matrix rows are the result of adding
2610 up glyph lengths of the window matrices. A line in the frame
2611 matrix is enabled, if a corresponding line in a window matrix is
2612 enabled.
2614 After building the desired frame matrix, it will be passed to
2615 terminal code, which will manipulate both the desired and current
2616 frame matrix. Changes applied to the frame's current matrix have
2617 to be visible in current window matrices afterwards, of course.
2619 This problem is solved like this:
2621 1. Window and frame matrices share glyphs. Window matrices are
2622 constructed in a way that their glyph contents ARE the glyph
2623 contents needed in a frame matrix. Thus, any modification of
2624 glyphs done in terminal code will be reflected in window matrices
2625 automatically.
2627 2. Exchanges of rows in a frame matrix done by terminal code are
2628 intercepted by hook functions so that corresponding row operations
2629 on window matrices can be performed. This is necessary because we
2630 use pointers to glyphs in glyph row structures. To satisfy the
2631 assumption of point 1 above that glyphs are updated implicitly in
2632 window matrices when they are manipulated via the frame matrix,
2633 window and frame matrix must of course agree where to find the
2634 glyphs for their rows. Possible manipulations that must be
2635 mirrored are assignments of rows of the desired frame matrix to the
2636 current frame matrix and scrolling the current frame matrix. */
2638 /* Build frame F's desired matrix from window matrices. Only windows
2639 which have the flag must_be_updated_p set have to be updated. Menu
2640 bar lines of a frame are not covered by window matrices, so make
2641 sure not to touch them in this function. */
2643 static void
2644 build_frame_matrix (f)
2645 struct frame *f;
2647 int i;
2649 /* F must have a frame matrix when this function is called. */
2650 xassert (!FRAME_WINDOW_P (f));
2652 /* Clear all rows in the frame matrix covered by window matrices.
2653 Menu bar lines are not covered by windows. */
2654 for (i = FRAME_TOP_MARGIN (f); i < f->desired_matrix->nrows; ++i)
2655 clear_glyph_row (MATRIX_ROW (f->desired_matrix, i));
2657 /* Build the matrix by walking the window tree. */
2658 build_frame_matrix_from_window_tree (f->desired_matrix,
2659 XWINDOW (FRAME_ROOT_WINDOW (f)));
2663 /* Walk a window tree, building a frame matrix MATRIX from window
2664 matrices. W is the root of a window tree. */
2666 static void
2667 build_frame_matrix_from_window_tree (matrix, w)
2668 struct glyph_matrix *matrix;
2669 struct window *w;
2671 while (w)
2673 if (!NILP (w->hchild))
2674 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->hchild));
2675 else if (!NILP (w->vchild))
2676 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->vchild));
2677 else
2678 build_frame_matrix_from_leaf_window (matrix, w);
2680 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2685 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2686 desired frame matrix built. W is a leaf window whose desired or
2687 current matrix is to be added to FRAME_MATRIX. W's flag
2688 must_be_updated_p determines which matrix it contributes to
2689 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2690 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2691 Adding a desired matrix means setting up used counters and such in
2692 frame rows, while adding a current window matrix to FRAME_MATRIX
2693 means copying glyphs. The latter case corresponds to
2694 preserve_other_columns in the old redisplay. */
2696 static void
2697 build_frame_matrix_from_leaf_window (frame_matrix, w)
2698 struct glyph_matrix *frame_matrix;
2699 struct window *w;
2701 struct glyph_matrix *window_matrix;
2702 int window_y, frame_y;
2703 /* If non-zero, a glyph to insert at the right border of W. */
2704 GLYPH right_border_glyph = 0;
2706 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2707 if (w->must_be_updated_p)
2709 window_matrix = w->desired_matrix;
2711 /* Decide whether we want to add a vertical border glyph. */
2712 if (!WINDOW_RIGHTMOST_P (w))
2714 struct Lisp_Char_Table *dp = window_display_table (w);
2716 right_border_glyph
2717 = ((dp && INTEGERP (DISP_BORDER_GLYPH (dp)))
2718 ? spec_glyph_lookup_face (w, XINT (DISP_BORDER_GLYPH (dp)))
2719 : '|');
2721 if (FAST_GLYPH_FACE (right_border_glyph) <= 0)
2722 right_border_glyph
2723 = FAST_MAKE_GLYPH (right_border_glyph, VERTICAL_BORDER_FACE_ID);
2726 else
2727 window_matrix = w->current_matrix;
2729 /* For all rows in the window matrix and corresponding rows in the
2730 frame matrix. */
2731 window_y = 0;
2732 frame_y = window_matrix->matrix_y;
2733 while (window_y < window_matrix->nrows)
2735 struct glyph_row *frame_row = frame_matrix->rows + frame_y;
2736 struct glyph_row *window_row = window_matrix->rows + window_y;
2737 int current_row_p = window_matrix == w->current_matrix;
2739 /* Fill up the frame row with spaces up to the left margin of the
2740 window row. */
2741 fill_up_frame_row_with_spaces (frame_row, window_matrix->matrix_x);
2743 /* Fill up areas in the window matrix row with spaces. */
2744 fill_up_glyph_row_with_spaces (window_row);
2746 /* If only part of W's desired matrix has been built, and
2747 window_row wasn't displayed, use the corresponding current
2748 row instead. */
2749 if (window_matrix == w->desired_matrix
2750 && !window_row->enabled_p)
2752 window_row = w->current_matrix->rows + window_y;
2753 current_row_p = 1;
2756 if (current_row_p)
2758 /* Copy window row to frame row. */
2759 bcopy (window_row->glyphs[0],
2760 frame_row->glyphs[TEXT_AREA] + window_matrix->matrix_x,
2761 window_matrix->matrix_w * sizeof (struct glyph));
2763 else
2765 xassert (window_row->enabled_p);
2767 /* Only when a desired row has been displayed, we want
2768 the corresponding frame row to be updated. */
2769 frame_row->enabled_p = 1;
2771 /* Maybe insert a vertical border between horizontally adjacent
2772 windows. */
2773 if (right_border_glyph)
2775 struct glyph *border = window_row->glyphs[LAST_AREA] - 1;
2776 SET_CHAR_GLYPH_FROM_GLYPH (*border, right_border_glyph);
2779 #if GLYPH_DEBUG
2780 /* Window row window_y must be a slice of frame row
2781 frame_y. */
2782 xassert (glyph_row_slice_p (window_row, frame_row));
2784 /* If rows are in sync, we don't have to copy glyphs because
2785 frame and window share glyphs. */
2787 strcpy (w->current_matrix->method, w->desired_matrix->method);
2788 add_window_display_history (w, w->current_matrix->method, 0);
2789 #endif
2792 /* Set number of used glyphs in the frame matrix. Since we fill
2793 up with spaces, and visit leaf windows from left to right it
2794 can be done simply. */
2795 frame_row->used[TEXT_AREA]
2796 = window_matrix->matrix_x + window_matrix->matrix_w;
2798 /* Next row. */
2799 ++window_y;
2800 ++frame_y;
2804 /* Given a user-specified glyph, possibly including a Lisp-level face
2805 ID, return a glyph that has a realized face ID.
2806 This is used for glyphs displayed specially and not part of the text;
2807 for instance, vertical separators, truncation markers, etc. */
2809 GLYPH
2810 spec_glyph_lookup_face (w, glyph)
2811 struct window *w;
2812 GLYPH glyph;
2814 int lface_id = FAST_GLYPH_FACE (glyph);
2815 /* Convert the glyph's specified face to a realized (cache) face. */
2816 if (lface_id > 0)
2818 int face_id = merge_faces (XFRAME (w->frame),
2819 Qt, lface_id, DEFAULT_FACE_ID);
2820 glyph
2821 = FAST_MAKE_GLYPH (FAST_GLYPH_CHAR (glyph), face_id);
2823 return glyph;
2826 /* Add spaces to a glyph row ROW in a window matrix.
2828 Each row has the form:
2830 +---------+-----------------------------+------------+
2831 | left | text | right |
2832 +---------+-----------------------------+------------+
2834 Left and right marginal areas are optional. This function adds
2835 spaces to areas so that there are no empty holes between areas.
2836 In other words: If the right area is not empty, the text area
2837 is filled up with spaces up to the right area. If the text area
2838 is not empty, the left area is filled up.
2840 To be called for frame-based redisplay, only. */
2842 static void
2843 fill_up_glyph_row_with_spaces (row)
2844 struct glyph_row *row;
2846 fill_up_glyph_row_area_with_spaces (row, LEFT_MARGIN_AREA);
2847 fill_up_glyph_row_area_with_spaces (row, TEXT_AREA);
2848 fill_up_glyph_row_area_with_spaces (row, RIGHT_MARGIN_AREA);
2852 /* Fill area AREA of glyph row ROW with spaces. To be called for
2853 frame-based redisplay only. */
2855 static void
2856 fill_up_glyph_row_area_with_spaces (row, area)
2857 struct glyph_row *row;
2858 int area;
2860 if (row->glyphs[area] < row->glyphs[area + 1])
2862 struct glyph *end = row->glyphs[area + 1];
2863 struct glyph *text = row->glyphs[area] + row->used[area];
2865 while (text < end)
2866 *text++ = space_glyph;
2867 row->used[area] = text - row->glyphs[area];
2872 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2873 reached. In frame matrices only one area, TEXT_AREA, is used. */
2875 static void
2876 fill_up_frame_row_with_spaces (row, upto)
2877 struct glyph_row *row;
2878 int upto;
2880 int i = row->used[TEXT_AREA];
2881 struct glyph *glyph = row->glyphs[TEXT_AREA];
2883 while (i < upto)
2884 glyph[i++] = space_glyph;
2886 row->used[TEXT_AREA] = i;
2891 /**********************************************************************
2892 Mirroring operations on frame matrices in window matrices
2893 **********************************************************************/
2895 /* Set frame being updated via frame-based redisplay to F. This
2896 function must be called before updates to make explicit that we are
2897 working on frame matrices or not. */
2899 static INLINE void
2900 set_frame_matrix_frame (f)
2901 struct frame *f;
2903 frame_matrix_frame = f;
2907 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2908 DESIRED_MATRIX is the desired matrix corresponding to
2909 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2910 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2911 frame_matrix_frame is non-null, this indicates that the exchange is
2912 done in frame matrices, and that we have to perform analogous
2913 operations in window matrices of frame_matrix_frame. */
2915 static INLINE void
2916 make_current (desired_matrix, current_matrix, row)
2917 struct glyph_matrix *desired_matrix, *current_matrix;
2918 int row;
2920 struct glyph_row *current_row = MATRIX_ROW (current_matrix, row);
2921 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, row);
2922 int mouse_face_p = current_row->mouse_face_p;
2924 /* Do current_row = desired_row. This exchanges glyph pointers
2925 between both rows, and does a structure assignment otherwise. */
2926 assign_row (current_row, desired_row);
2928 /* Enable current_row to mark it as valid. */
2929 current_row->enabled_p = 1;
2930 current_row->mouse_face_p = mouse_face_p;
2932 /* If we are called on frame matrices, perform analogous operations
2933 for window matrices. */
2934 if (frame_matrix_frame)
2935 mirror_make_current (XWINDOW (frame_matrix_frame->root_window), row);
2939 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2940 W's frame which has been made current (by swapping pointers between
2941 current and desired matrix). Perform analogous operations in the
2942 matrices of leaf windows in the window tree rooted at W. */
2944 static void
2945 mirror_make_current (w, frame_row)
2946 struct window *w;
2947 int frame_row;
2949 while (w)
2951 if (!NILP (w->hchild))
2952 mirror_make_current (XWINDOW (w->hchild), frame_row);
2953 else if (!NILP (w->vchild))
2954 mirror_make_current (XWINDOW (w->vchild), frame_row);
2955 else
2957 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2958 here because the checks performed in debug mode there
2959 will not allow the conversion. */
2960 int row = frame_row - w->desired_matrix->matrix_y;
2962 /* If FRAME_ROW is within W, assign the desired row to the
2963 current row (exchanging glyph pointers). */
2964 if (row >= 0 && row < w->desired_matrix->matrix_h)
2966 struct glyph_row *current_row
2967 = MATRIX_ROW (w->current_matrix, row);
2968 struct glyph_row *desired_row
2969 = MATRIX_ROW (w->desired_matrix, row);
2971 if (desired_row->enabled_p)
2972 assign_row (current_row, desired_row);
2973 else
2974 swap_glyph_pointers (desired_row, current_row);
2975 current_row->enabled_p = 1;
2979 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2984 /* Perform row dance after scrolling. We are working on the range of
2985 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2986 including) in MATRIX. COPY_FROM is a vector containing, for each
2987 row I in the range 0 <= I < NLINES, the index of the original line
2988 to move to I. This index is relative to the row range, i.e. 0 <=
2989 index < NLINES. RETAINED_P is a vector containing zero for each
2990 row 0 <= I < NLINES which is empty.
2992 This function is called from do_scrolling and do_direct_scrolling. */
2994 void
2995 mirrored_line_dance (matrix, unchanged_at_top, nlines, copy_from,
2996 retained_p)
2997 struct glyph_matrix *matrix;
2998 int unchanged_at_top, nlines;
2999 int *copy_from;
3000 char *retained_p;
3002 /* A copy of original rows. */
3003 struct glyph_row *old_rows;
3005 /* Rows to assign to. */
3006 struct glyph_row *new_rows = MATRIX_ROW (matrix, unchanged_at_top);
3008 int i;
3010 /* Make a copy of the original rows. */
3011 old_rows = (struct glyph_row *) alloca (nlines * sizeof *old_rows);
3012 bcopy (new_rows, old_rows, nlines * sizeof *old_rows);
3014 /* Assign new rows, maybe clear lines. */
3015 for (i = 0; i < nlines; ++i)
3017 int enabled_before_p = new_rows[i].enabled_p;
3019 xassert (i + unchanged_at_top < matrix->nrows);
3020 xassert (unchanged_at_top + copy_from[i] < matrix->nrows);
3021 new_rows[i] = old_rows[copy_from[i]];
3022 new_rows[i].enabled_p = enabled_before_p;
3024 /* RETAINED_P is zero for empty lines. */
3025 if (!retained_p[copy_from[i]])
3026 new_rows[i].enabled_p = 0;
3029 /* Do the same for window matrices, if MATRIX is a frame matrix. */
3030 if (frame_matrix_frame)
3031 mirror_line_dance (XWINDOW (frame_matrix_frame->root_window),
3032 unchanged_at_top, nlines, copy_from, retained_p);
3036 /* Synchronize glyph pointers in the current matrix of window W with
3037 the current frame matrix. */
3039 static void
3040 sync_window_with_frame_matrix_rows (w)
3041 struct window *w;
3043 struct frame *f = XFRAME (w->frame);
3044 struct glyph_row *window_row, *window_row_end, *frame_row;
3045 int left, right, x, width;
3047 /* Preconditions: W must be a leaf window on a tty frame. */
3048 xassert (NILP (w->hchild) && NILP (w->vchild));
3049 xassert (!FRAME_WINDOW_P (f));
3051 left = margin_glyphs_to_reserve (w, 1, w->left_margin_cols);
3052 right = margin_glyphs_to_reserve (w, 1, w->right_margin_cols);
3053 x = w->current_matrix->matrix_x;
3054 width = w->current_matrix->matrix_w;
3056 window_row = w->current_matrix->rows;
3057 window_row_end = window_row + w->current_matrix->nrows;
3058 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
3060 for (; window_row < window_row_end; ++window_row, ++frame_row)
3062 window_row->glyphs[LEFT_MARGIN_AREA]
3063 = frame_row->glyphs[0] + x;
3064 window_row->glyphs[TEXT_AREA]
3065 = window_row->glyphs[LEFT_MARGIN_AREA] + left;
3066 window_row->glyphs[LAST_AREA]
3067 = window_row->glyphs[LEFT_MARGIN_AREA] + width;
3068 window_row->glyphs[RIGHT_MARGIN_AREA]
3069 = window_row->glyphs[LAST_AREA] - right;
3074 /* Return the window in the window tree rooted in W containing frame
3075 row ROW. Value is null if none is found. */
3077 struct window *
3078 frame_row_to_window (w, row)
3079 struct window *w;
3080 int row;
3082 struct window *found = NULL;
3084 while (w && !found)
3086 if (!NILP (w->hchild))
3087 found = frame_row_to_window (XWINDOW (w->hchild), row);
3088 else if (!NILP (w->vchild))
3089 found = frame_row_to_window (XWINDOW (w->vchild), row);
3090 else if (row >= WINDOW_TOP_EDGE_LINE (w)
3091 && row < WINDOW_BOTTOM_EDGE_LINE (w))
3092 found = w;
3094 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3097 return found;
3101 /* Perform a line dance in the window tree rooted at W, after
3102 scrolling a frame matrix in mirrored_line_dance.
3104 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
3105 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
3106 COPY_FROM is a vector containing, for each row I in the range 0 <=
3107 I < NLINES, the index of the original line to move to I. This
3108 index is relative to the row range, i.e. 0 <= index < NLINES.
3109 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
3110 which is empty. */
3112 static void
3113 mirror_line_dance (w, unchanged_at_top, nlines, copy_from, retained_p)
3114 struct window *w;
3115 int unchanged_at_top, nlines;
3116 int *copy_from;
3117 char *retained_p;
3119 while (w)
3121 if (!NILP (w->hchild))
3122 mirror_line_dance (XWINDOW (w->hchild), unchanged_at_top,
3123 nlines, copy_from, retained_p);
3124 else if (!NILP (w->vchild))
3125 mirror_line_dance (XWINDOW (w->vchild), unchanged_at_top,
3126 nlines, copy_from, retained_p);
3127 else
3129 /* W is a leaf window, and we are working on its current
3130 matrix m. */
3131 struct glyph_matrix *m = w->current_matrix;
3132 int i, sync_p = 0;
3133 struct glyph_row *old_rows;
3135 /* Make a copy of the original rows of matrix m. */
3136 old_rows = (struct glyph_row *) alloca (m->nrows * sizeof *old_rows);
3137 bcopy (m->rows, old_rows, m->nrows * sizeof *old_rows);
3139 for (i = 0; i < nlines; ++i)
3141 /* Frame relative line assigned to. */
3142 int frame_to = i + unchanged_at_top;
3144 /* Frame relative line assigned. */
3145 int frame_from = copy_from[i] + unchanged_at_top;
3147 /* Window relative line assigned to. */
3148 int window_to = frame_to - m->matrix_y;
3150 /* Window relative line assigned. */
3151 int window_from = frame_from - m->matrix_y;
3153 /* Is assigned line inside window? */
3154 int from_inside_window_p
3155 = window_from >= 0 && window_from < m->matrix_h;
3157 /* Is assigned to line inside window? */
3158 int to_inside_window_p
3159 = window_to >= 0 && window_to < m->matrix_h;
3161 if (from_inside_window_p && to_inside_window_p)
3163 /* Enabled setting before assignment. */
3164 int enabled_before_p;
3166 /* Do the assignment. The enabled_p flag is saved
3167 over the assignment because the old redisplay did
3168 that. */
3169 enabled_before_p = m->rows[window_to].enabled_p;
3170 m->rows[window_to] = old_rows[window_from];
3171 m->rows[window_to].enabled_p = enabled_before_p;
3173 /* If frame line is empty, window line is empty, too. */
3174 if (!retained_p[copy_from[i]])
3175 m->rows[window_to].enabled_p = 0;
3177 else if (to_inside_window_p)
3179 /* A copy between windows. This is an infrequent
3180 case not worth optimizing. */
3181 struct frame *f = XFRAME (w->frame);
3182 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3183 struct window *w2;
3184 struct glyph_matrix *m2;
3185 int m2_from;
3187 w2 = frame_row_to_window (root, frame_from);
3188 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3189 -nw', FROM_FRAME sometimes has no associated window.
3190 This check avoids a segfault if W2 is null. */
3191 if (w2)
3193 m2 = w2->current_matrix;
3194 m2_from = frame_from - m2->matrix_y;
3195 copy_row_except_pointers (m->rows + window_to,
3196 m2->rows + m2_from);
3198 /* If frame line is empty, window line is empty, too. */
3199 if (!retained_p[copy_from[i]])
3200 m->rows[window_to].enabled_p = 0;
3202 sync_p = 1;
3204 else if (from_inside_window_p)
3205 sync_p = 1;
3208 /* If there was a copy between windows, make sure glyph
3209 pointers are in sync with the frame matrix. */
3210 if (sync_p)
3211 sync_window_with_frame_matrix_rows (w);
3213 /* Check that no pointers are lost. */
3214 CHECK_MATRIX (m);
3217 /* Next window on same level. */
3218 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3223 #if GLYPH_DEBUG
3225 /* Check that window and frame matrices agree about their
3226 understanding where glyphs of the rows are to find. For each
3227 window in the window tree rooted at W, check that rows in the
3228 matrices of leaf window agree with their frame matrices about
3229 glyph pointers. */
3231 void
3232 check_window_matrix_pointers (w)
3233 struct window *w;
3235 while (w)
3237 if (!NILP (w->hchild))
3238 check_window_matrix_pointers (XWINDOW (w->hchild));
3239 else if (!NILP (w->vchild))
3240 check_window_matrix_pointers (XWINDOW (w->vchild));
3241 else
3243 struct frame *f = XFRAME (w->frame);
3244 check_matrix_pointers (w->desired_matrix, f->desired_matrix);
3245 check_matrix_pointers (w->current_matrix, f->current_matrix);
3248 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3253 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3254 a window and FRAME_MATRIX is the corresponding frame matrix. For
3255 each row in WINDOW_MATRIX check that it's a slice of the
3256 corresponding frame row. If it isn't, abort. */
3258 static void
3259 check_matrix_pointers (window_matrix, frame_matrix)
3260 struct glyph_matrix *window_matrix, *frame_matrix;
3262 /* Row number in WINDOW_MATRIX. */
3263 int i = 0;
3265 /* Row number corresponding to I in FRAME_MATRIX. */
3266 int j = window_matrix->matrix_y;
3268 /* For all rows check that the row in the window matrix is a
3269 slice of the row in the frame matrix. If it isn't we didn't
3270 mirror an operation on the frame matrix correctly. */
3271 while (i < window_matrix->nrows)
3273 if (!glyph_row_slice_p (window_matrix->rows + i,
3274 frame_matrix->rows + j))
3275 abort ();
3276 ++i, ++j;
3280 #endif /* GLYPH_DEBUG != 0 */
3284 /**********************************************************************
3285 VPOS and HPOS translations
3286 **********************************************************************/
3288 #if GLYPH_DEBUG
3290 /* Translate vertical position VPOS which is relative to window W to a
3291 vertical position relative to W's frame. */
3293 static int
3294 window_to_frame_vpos (w, vpos)
3295 struct window *w;
3296 int vpos;
3298 struct frame *f = XFRAME (w->frame);
3300 xassert (!FRAME_WINDOW_P (f));
3301 xassert (vpos >= 0 && vpos <= w->desired_matrix->nrows);
3302 vpos += WINDOW_TOP_EDGE_LINE (w);
3303 xassert (vpos >= 0 && vpos <= FRAME_LINES (f));
3304 return vpos;
3308 /* Translate horizontal position HPOS which is relative to window W to
3309 a horizontal position relative to W's frame. */
3311 static int
3312 window_to_frame_hpos (w, hpos)
3313 struct window *w;
3314 int hpos;
3316 xassert (!FRAME_WINDOW_P (XFRAME (w->frame)));
3317 hpos += WINDOW_LEFT_EDGE_COL (w);
3318 return hpos;
3321 #endif /* GLYPH_DEBUG */
3325 /**********************************************************************
3326 Redrawing Frames
3327 **********************************************************************/
3329 DEFUN ("redraw-frame", Fredraw_frame, Sredraw_frame, 1, 1, 0,
3330 doc: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3331 (frame)
3332 Lisp_Object frame;
3334 struct frame *f;
3336 CHECK_LIVE_FRAME (frame);
3337 f = XFRAME (frame);
3339 /* Ignore redraw requests, if frame has no glyphs yet.
3340 (Implementation note: It still has to be checked why we are
3341 called so early here). */
3342 if (!glyphs_initialized_initially_p)
3343 return Qnil;
3345 update_begin (f);
3346 #ifdef MSDOS
3347 if (FRAME_MSDOS_P (f))
3348 set_terminal_modes (FRAME_TERMINAL (f));
3349 #endif
3350 clear_frame (f);
3351 clear_current_matrices (f);
3352 update_end (f);
3353 if (FRAME_TERMCAP_P (f))
3354 fflush (FRAME_TTY (f)->output);
3355 windows_or_buffers_changed++;
3356 /* Mark all windows as inaccurate, so that every window will have
3357 its redisplay done. */
3358 mark_window_display_accurate (FRAME_ROOT_WINDOW (f), 0);
3359 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
3360 f->garbaged = 0;
3361 return Qnil;
3365 /* Redraw frame F. This is nothing more than a call to the Lisp
3366 function redraw-frame. */
3368 void
3369 redraw_frame (f)
3370 struct frame *f;
3372 Lisp_Object frame;
3373 XSETFRAME (frame, f);
3374 Fredraw_frame (frame);
3378 DEFUN ("redraw-display", Fredraw_display, Sredraw_display, 0, 0, "",
3379 doc: /* Clear and redisplay all visible frames. */)
3382 Lisp_Object tail, frame;
3384 FOR_EACH_FRAME (tail, frame)
3385 if (FRAME_VISIBLE_P (XFRAME (frame)))
3386 Fredraw_frame (frame);
3388 return Qnil;
3392 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3393 visible frames marked as garbaged. */
3395 void
3396 redraw_garbaged_frames ()
3398 Lisp_Object tail, frame;
3400 FOR_EACH_FRAME (tail, frame)
3401 if (FRAME_VISIBLE_P (XFRAME (frame))
3402 && FRAME_GARBAGED_P (XFRAME (frame)))
3403 Fredraw_frame (frame);
3408 /***********************************************************************
3409 Direct Operations
3410 ***********************************************************************/
3412 /* Try to update display and current glyph matrix directly.
3414 This function is called after a character G has been inserted into
3415 current_buffer. It tries to update the current glyph matrix and
3416 perform appropriate screen output to reflect the insertion. If it
3417 succeeds, the global flag redisplay_performed_directly_p will be
3418 set to 1, and thereby prevent the more costly general redisplay
3419 from running (see redisplay_internal).
3421 This function is not called for `hairy' character insertions.
3422 In particular, it is not called when after or before change
3423 functions exist, like they are used by font-lock. See keyboard.c
3424 for details where this function is called. */
3427 direct_output_for_insert (g)
3428 int g;
3430 register struct frame *f = SELECTED_FRAME ();
3431 struct window *w = XWINDOW (selected_window);
3432 struct it it, it2;
3433 struct glyph_row *glyph_row;
3434 struct glyph *glyphs, *glyph, *end;
3435 int n;
3436 /* Non-null means that redisplay of W is based on window matrices. */
3437 int window_redisplay_p = FRAME_WINDOW_P (f);
3438 /* Non-null means we are in overwrite mode. */
3439 int overwrite_p = !NILP (current_buffer->overwrite_mode);
3440 int added_width;
3441 struct text_pos pos;
3442 int delta, delta_bytes;
3444 /* Not done directly. */
3445 redisplay_performed_directly_p = 0;
3447 /* Quickly give up for some common cases. */
3448 if (cursor_in_echo_area
3449 /* Give up if fonts have changed. */
3450 || fonts_changed_p
3451 /* Give up if face attributes have been changed. */
3452 || face_change_count
3453 /* Give up if cursor position not really known. */
3454 || !display_completed
3455 /* Give up if buffer appears in two places. */
3456 || buffer_shared > 1
3457 /* Give up if currently displaying a message instead of the
3458 minibuffer contents. */
3459 || (EQ (selected_window, minibuf_window)
3460 && EQ (minibuf_window, echo_area_window))
3461 /* Give up for hscrolled mini-buffer because display of the prompt
3462 is handled specially there (see display_line). */
3463 || (MINI_WINDOW_P (w) && XFASTINT (w->hscroll))
3464 /* Give up if overwriting in the middle of a line. */
3465 || (overwrite_p
3466 && PT != ZV
3467 && FETCH_BYTE (PT) != '\n')
3468 /* Give up for tabs and line ends. */
3469 || g == '\t'
3470 || g == '\n'
3471 || g == '\r'
3472 /* Give up if unable to display the cursor in the window. */
3473 || w->cursor.vpos < 0
3474 /* Give up if we are showing a message or just cleared the message
3475 because we might need to resize the echo area window. */
3476 || !NILP (echo_area_buffer[0])
3477 || !NILP (echo_area_buffer[1])
3478 || (glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos),
3479 /* Can't do it in a continued line because continuation
3480 lines would change. */
3481 (glyph_row->continued_p
3482 || glyph_row->exact_window_width_line_p
3483 /* Can't use this method if the line overlaps others or is
3484 overlapped by others because these other lines would
3485 have to be redisplayed. */
3486 || glyph_row->overlapping_p
3487 || glyph_row->overlapped_p))
3488 /* Can't do it for partial width windows on terminal frames
3489 because we can't clear to eol in such a window. */
3490 || (!window_redisplay_p && !WINDOW_FULL_WIDTH_P (w)))
3491 return 0;
3493 /* If we can't insert glyphs, we can use this method only
3494 at the end of a line. */
3495 if (!FRAME_CHAR_INS_DEL_OK (f))
3496 if (PT != ZV && FETCH_BYTE (PT_BYTE) != '\n')
3497 return 0;
3499 /* Set up a display iterator structure for W. Glyphs will be
3500 produced in scratch_glyph_row. Current position is W's cursor
3501 position. */
3502 clear_glyph_row (&scratch_glyph_row);
3503 SET_TEXT_POS (pos, PT, PT_BYTE);
3504 DEC_TEXT_POS (pos, !NILP (current_buffer->enable_multibyte_characters));
3505 init_iterator (&it, w, CHARPOS (pos), BYTEPOS (pos), &scratch_glyph_row,
3506 DEFAULT_FACE_ID);
3508 glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3509 if (glyph_row->mouse_face_p)
3510 return 0;
3512 /* Give up if highlighting trailing whitespace and we have trailing
3513 whitespace in glyph_row. We would have to remove the trailing
3514 whitespace face in that case. */
3515 if (!NILP (Vshow_trailing_whitespace)
3516 && glyph_row->used[TEXT_AREA])
3518 struct glyph *last;
3520 last = glyph_row->glyphs[TEXT_AREA] + glyph_row->used[TEXT_AREA] - 1;
3521 if (last->type == STRETCH_GLYPH
3522 || (last->type == CHAR_GLYPH
3523 && last->u.ch == ' '))
3524 return 0;
3527 /* Give up if there are overlay strings at pos. This would fail
3528 if the overlay string has newlines in it. */
3529 if (STRINGP (it.string))
3530 return 0;
3532 it.hpos = w->cursor.hpos;
3533 it.vpos = w->cursor.vpos;
3534 it.current_x = w->cursor.x + it.first_visible_x;
3535 it.current_y = w->cursor.y;
3536 it.end_charpos = PT;
3537 it.stop_charpos = min (PT, it.stop_charpos);
3538 it.stop_charpos = max (IT_CHARPOS (it), it.stop_charpos);
3540 /* More than one display element may be returned for PT - 1 if
3541 (i) it's a control character which is translated into `\003' or
3542 `^C', or (ii) it has a display table entry, or (iii) it's a
3543 combination of both. */
3544 delta = delta_bytes = 0;
3545 while (get_next_display_element (&it))
3547 PRODUCE_GLYPHS (&it);
3549 /* Give up if glyph doesn't fit completely on the line. */
3550 if (it.current_x >= it.last_visible_x)
3551 return 0;
3553 /* Give up if new glyph has different ascent or descent than
3554 the original row, or if it is not a character glyph. */
3555 if (glyph_row->ascent != it.ascent
3556 || glyph_row->height != it.ascent + it.descent
3557 || glyph_row->phys_ascent != it.phys_ascent
3558 || glyph_row->phys_height != it.phys_ascent + it.phys_descent
3559 || it.what != IT_CHARACTER)
3560 return 0;
3562 delta += 1;
3563 delta_bytes += it.len;
3564 set_iterator_to_next (&it, 1);
3567 /* Give up if we hit the right edge of the window. We would have
3568 to insert truncation or continuation glyphs. */
3569 added_width = it.current_x - (w->cursor.x + it.first_visible_x);
3570 if (glyph_row->pixel_width + added_width >= it.last_visible_x)
3571 return 0;
3573 /* Give up if there is a \t following in the line. */
3574 it2 = it;
3575 it2.end_charpos = ZV;
3576 it2.stop_charpos = min (it2.stop_charpos, ZV);
3577 while (get_next_display_element (&it2)
3578 && !ITERATOR_AT_END_OF_LINE_P (&it2))
3580 if (it2.c == '\t')
3581 return 0;
3582 set_iterator_to_next (&it2, 1);
3585 /* Number of new glyphs produced. */
3586 n = it.glyph_row->used[TEXT_AREA];
3588 /* Start and end of glyphs in original row. */
3589 glyphs = glyph_row->glyphs[TEXT_AREA] + w->cursor.hpos;
3590 end = glyph_row->glyphs[1 + TEXT_AREA];
3592 /* Make room for new glyphs, then insert them. */
3593 xassert (end - glyphs - n >= 0);
3594 safe_bcopy ((char *) glyphs, (char *) (glyphs + n),
3595 (end - glyphs - n) * sizeof (*end));
3596 bcopy (it.glyph_row->glyphs[TEXT_AREA], glyphs, n * sizeof *glyphs);
3597 glyph_row->used[TEXT_AREA] = min (glyph_row->used[TEXT_AREA] + n,
3598 end - glyph_row->glyphs[TEXT_AREA]);
3600 /* Compute new line width. */
3601 glyph = glyph_row->glyphs[TEXT_AREA];
3602 end = glyph + glyph_row->used[TEXT_AREA];
3603 glyph_row->pixel_width = glyph_row->x;
3604 while (glyph < end)
3606 glyph_row->pixel_width += glyph->pixel_width;
3607 ++glyph;
3610 /* Increment buffer positions for glyphs following the newly
3611 inserted ones. */
3612 for (glyph = glyphs + n; glyph < end; ++glyph)
3613 if (glyph->charpos > 0 && BUFFERP (glyph->object))
3614 glyph->charpos += delta;
3616 if (MATRIX_ROW_END_CHARPOS (glyph_row) > 0)
3618 MATRIX_ROW_END_CHARPOS (glyph_row) += delta;
3619 MATRIX_ROW_END_BYTEPOS (glyph_row) += delta_bytes;
3622 /* Adjust positions in lines following the one we are in. */
3623 increment_matrix_positions (w->current_matrix,
3624 w->cursor.vpos + 1,
3625 w->current_matrix->nrows,
3626 delta, delta_bytes);
3628 glyph_row->contains_overlapping_glyphs_p
3629 |= it.glyph_row->contains_overlapping_glyphs_p;
3631 glyph_row->displays_text_p = 1;
3632 w->window_end_vpos = make_number (max (w->cursor.vpos,
3633 XFASTINT (w->window_end_vpos)));
3635 if (!NILP (Vshow_trailing_whitespace))
3636 highlight_trailing_whitespace (it.f, glyph_row);
3638 /* Write glyphs. If at end of row, we can simply call write_glyphs.
3639 In the middle, we have to insert glyphs. Note that this is now
3640 implemented for X frames. The implementation uses updated_window
3641 and updated_row. */
3642 updated_row = glyph_row;
3643 updated_area = TEXT_AREA;
3644 update_begin (f);
3645 if (FRAME_RIF (f))
3647 FRAME_RIF (f)->update_window_begin_hook (w);
3649 if (glyphs == end - n
3650 /* In front of a space added by append_space. */
3651 || (glyphs == end - n - 1
3652 && (end - n)->charpos <= 0))
3653 FRAME_RIF (f)->write_glyphs (glyphs, n);
3654 else
3655 FRAME_RIF (f)->insert_glyphs (glyphs, n);
3657 else
3659 if (glyphs == end - n)
3660 write_glyphs (f, glyphs, n);
3661 else
3662 insert_glyphs (f, glyphs, n);
3665 w->cursor.hpos += n;
3666 w->cursor.x = it.current_x - it.first_visible_x;
3667 xassert (w->cursor.hpos >= 0
3668 && w->cursor.hpos < w->desired_matrix->matrix_w);
3670 /* How to set the cursor differs depending on whether we are
3671 using a frame matrix or a window matrix. Note that when
3672 a frame matrix is used, cursor_to expects frame coordinates,
3673 and the X and Y parameters are not used. */
3674 if (window_redisplay_p)
3675 FRAME_RIF (f)->cursor_to (w->cursor.vpos, w->cursor.hpos,
3676 w->cursor.y, w->cursor.x);
3677 else
3679 int x, y;
3680 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3681 + (INTEGERP (w->left_margin_cols)
3682 ? XFASTINT (w->left_margin_cols)
3683 : 0));
3684 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3685 cursor_to (f, y, x);
3688 #ifdef HAVE_WINDOW_SYSTEM
3689 update_window_fringes (w, 0);
3690 #endif
3692 if (FRAME_RIF (f))
3693 FRAME_RIF (f)->update_window_end_hook (w, 1, 0);
3694 update_end (f);
3695 updated_row = NULL;
3696 if (FRAME_TERMCAP_P (f))
3697 fflush (FRAME_TTY (f)->output);
3699 TRACE ((stderr, "direct output for insert\n"));
3700 mark_window_display_accurate (it.window, 1);
3701 redisplay_performed_directly_p = 1;
3702 return 1;
3706 /* Perform a direct display update for moving PT by N positions
3707 left or right. N < 0 means a movement backwards. This function
3708 is currently only called for N == 1 or N == -1. */
3711 direct_output_forward_char (n)
3712 int n;
3714 struct frame *f = SELECTED_FRAME ();
3715 struct window *w = XWINDOW (selected_window);
3716 struct glyph_row *row;
3718 /* Give up if point moved out of or into a composition. */
3719 if (check_point_in_composition (current_buffer, XINT (w->last_point),
3720 current_buffer, PT))
3721 return 0;
3723 /* Give up if face attributes have been changed. */
3724 if (face_change_count)
3725 return 0;
3727 /* Give up if current matrix is not up to date or we are
3728 displaying a message. */
3729 if (!display_completed || cursor_in_echo_area)
3730 return 0;
3732 /* Give up if the buffer's direction is reversed. */
3733 if (!NILP (XBUFFER (w->buffer)->direction_reversed))
3734 return 0;
3736 /* Can't use direct output if highlighting a region. */
3737 if (!NILP (Vtransient_mark_mode) && !NILP (current_buffer->mark_active))
3738 return 0;
3740 /* Can't use direct output if highlighting trailing whitespace. */
3741 if (!NILP (Vshow_trailing_whitespace))
3742 return 0;
3744 /* Give up if we are showing a message or just cleared the message
3745 because we might need to resize the echo area window. */
3746 if (!NILP (echo_area_buffer[0]) || !NILP (echo_area_buffer[1]))
3747 return 0;
3749 /* Give up if currently displaying a message instead of the
3750 minibuffer contents. */
3751 if (XWINDOW (minibuf_window) == w
3752 && EQ (minibuf_window, echo_area_window))
3753 return 0;
3755 /* Give up if we don't know where the cursor is. */
3756 if (w->cursor.vpos < 0)
3757 return 0;
3759 row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3761 /* Give up if PT is outside of the last known cursor row. */
3762 if (PT <= MATRIX_ROW_START_CHARPOS (row)
3763 || PT >= MATRIX_ROW_END_CHARPOS (row))
3764 return 0;
3766 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
3768 w->last_cursor = w->cursor;
3769 XSETFASTINT (w->last_point, PT);
3771 xassert (w->cursor.hpos >= 0
3772 && w->cursor.hpos < w->desired_matrix->matrix_w);
3774 if (FRAME_WINDOW_P (f))
3775 FRAME_RIF (f)->cursor_to (w->cursor.vpos, w->cursor.hpos,
3776 w->cursor.y, w->cursor.x);
3777 else
3779 int x, y;
3780 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3781 + (INTEGERP (w->left_margin_cols)
3782 ? XFASTINT (w->left_margin_cols)
3783 : 0));
3784 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3785 cursor_to (f, y, x);
3788 if (FRAME_TERMCAP_P (f))
3789 fflush (FRAME_TTY (f)->output);
3790 redisplay_performed_directly_p = 1;
3791 return 1;
3796 /***********************************************************************
3797 Frame Update
3798 ***********************************************************************/
3800 /* Update frame F based on the data in desired matrices.
3802 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3803 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3804 scrolling.
3806 Value is non-zero if redisplay was stopped due to pending input. */
3809 update_frame (f, force_p, inhibit_hairy_id_p)
3810 struct frame *f;
3811 int force_p;
3812 int inhibit_hairy_id_p;
3814 /* 1 means display has been paused because of pending input. */
3815 int paused_p;
3816 struct window *root_window = XWINDOW (f->root_window);
3818 if (FRAME_WINDOW_P (f))
3820 /* We are working on window matrix basis. All windows whose
3821 flag must_be_updated_p is set have to be updated. */
3823 /* Record that we are not working on frame matrices. */
3824 set_frame_matrix_frame (NULL);
3826 /* Update all windows in the window tree of F, maybe stopping
3827 when pending input is detected. */
3828 update_begin (f);
3830 /* Update the menu bar on X frames that don't have toolkit
3831 support. */
3832 if (WINDOWP (f->menu_bar_window))
3833 update_window (XWINDOW (f->menu_bar_window), 1);
3835 /* Update the tool-bar window, if present. */
3836 if (WINDOWP (f->tool_bar_window))
3838 struct window *w = XWINDOW (f->tool_bar_window);
3840 /* Update tool-bar window. */
3841 if (w->must_be_updated_p)
3843 Lisp_Object tem;
3845 update_window (w, 1);
3846 w->must_be_updated_p = 0;
3848 /* Swap tool-bar strings. We swap because we want to
3849 reuse strings. */
3850 tem = f->current_tool_bar_string;
3851 f->current_tool_bar_string = f->desired_tool_bar_string;
3852 f->desired_tool_bar_string = tem;
3857 /* Update windows. */
3858 paused_p = update_window_tree (root_window, force_p);
3859 update_end (f);
3861 /* This flush is a performance bottleneck under X,
3862 and it doesn't seem to be necessary anyway (in general).
3863 It is necessary when resizing the window with the mouse, or
3864 at least the fringes are not redrawn in a timely manner. ++kfs */
3865 if (f->force_flush_display_p)
3867 FRAME_RIF (f)->flush_display (f);
3868 f->force_flush_display_p = 0;
3871 else
3873 /* We are working on frame matrix basis. Set the frame on whose
3874 frame matrix we operate. */
3875 set_frame_matrix_frame (f);
3877 /* Build F's desired matrix from window matrices. */
3878 build_frame_matrix (f);
3880 /* Update the display */
3881 update_begin (f);
3882 paused_p = update_frame_1 (f, force_p, inhibit_hairy_id_p);
3883 update_end (f);
3885 if (FRAME_TERMCAP_P (f))
3887 if (FRAME_TTY (f)->termscript)
3888 fflush (FRAME_TTY (f)->termscript);
3889 fflush (FRAME_TTY (f)->output);
3892 /* Check window matrices for lost pointers. */
3893 #if GLYPH_DEBUG
3894 check_window_matrix_pointers (root_window);
3895 add_frame_display_history (f, paused_p);
3896 #endif
3899 /* Reset flags indicating that a window should be updated. */
3900 set_window_update_flags (root_window, 0);
3902 display_completed = !paused_p;
3903 return paused_p;
3908 /************************************************************************
3909 Window-based updates
3910 ************************************************************************/
3912 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3913 don't stop updating when input is pending. */
3915 static int
3916 update_window_tree (w, force_p)
3917 struct window *w;
3918 int force_p;
3920 int paused_p = 0;
3922 while (w && !paused_p)
3924 if (!NILP (w->hchild))
3925 paused_p |= update_window_tree (XWINDOW (w->hchild), force_p);
3926 else if (!NILP (w->vchild))
3927 paused_p |= update_window_tree (XWINDOW (w->vchild), force_p);
3928 else if (w->must_be_updated_p)
3929 paused_p |= update_window (w, force_p);
3931 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3934 return paused_p;
3938 /* Update window W if its flag must_be_updated_p is non-zero. If
3939 FORCE_P is non-zero, don't stop updating if input is pending. */
3941 void
3942 update_single_window (w, force_p)
3943 struct window *w;
3944 int force_p;
3946 if (w->must_be_updated_p)
3948 struct frame *f = XFRAME (WINDOW_FRAME (w));
3950 /* Record that this is not a frame-based redisplay. */
3951 set_frame_matrix_frame (NULL);
3953 /* Update W. */
3954 update_begin (f);
3955 update_window (w, force_p);
3956 update_end (f);
3958 /* Reset flag in W. */
3959 w->must_be_updated_p = 0;
3963 #ifdef HAVE_WINDOW_SYSTEM
3965 /* Redraw lines from the current matrix of window W that are
3966 overlapped by other rows. YB is bottom-most y-position in W. */
3968 static void
3969 redraw_overlapped_rows (w, yb)
3970 struct window *w;
3971 int yb;
3973 int i;
3974 struct frame *f = XFRAME (WINDOW_FRAME (w));
3976 /* If rows overlapping others have been changed, the rows being
3977 overlapped have to be redrawn. This won't draw lines that have
3978 already been drawn in update_window_line because overlapped_p in
3979 desired rows is 0, so after row assignment overlapped_p in
3980 current rows is 0. */
3981 for (i = 0; i < w->current_matrix->nrows; ++i)
3983 struct glyph_row *row = w->current_matrix->rows + i;
3985 if (!row->enabled_p)
3986 break;
3987 else if (row->mode_line_p)
3988 continue;
3990 if (row->overlapped_p)
3992 enum glyph_row_area area;
3994 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
3996 updated_row = row;
3997 updated_area = area;
3998 FRAME_RIF (f)->cursor_to (i, 0, row->y,
3999 area == TEXT_AREA ? row->x : 0);
4000 if (row->used[area])
4001 FRAME_RIF (f)->write_glyphs (row->glyphs[area],
4002 row->used[area]);
4003 FRAME_RIF (f)->clear_end_of_line (-1);
4006 row->overlapped_p = 0;
4009 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4010 break;
4015 /* Redraw lines from the current matrix of window W that overlap
4016 others. YB is bottom-most y-position in W. */
4018 static void
4019 redraw_overlapping_rows (w, yb)
4020 struct window *w;
4021 int yb;
4023 int i, bottom_y;
4024 struct glyph_row *row;
4025 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4027 for (i = 0; i < w->current_matrix->nrows; ++i)
4029 row = w->current_matrix->rows + i;
4031 if (!row->enabled_p)
4032 break;
4033 else if (row->mode_line_p)
4034 continue;
4036 bottom_y = MATRIX_ROW_BOTTOM_Y (row);
4038 if (row->overlapping_p && i > 0 && bottom_y < yb)
4040 int overlaps = 0;
4042 if (MATRIX_ROW_OVERLAPS_PRED_P (row)
4043 && !MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p)
4044 overlaps |= OVERLAPS_PRED;
4045 if (MATRIX_ROW_OVERLAPS_SUCC_P (row)
4046 && !MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p)
4047 overlaps |= OVERLAPS_SUCC;
4049 if (overlaps)
4051 if (row->used[LEFT_MARGIN_AREA])
4052 rif->fix_overlapping_area (w, row, LEFT_MARGIN_AREA, overlaps);
4054 if (row->used[TEXT_AREA])
4055 rif->fix_overlapping_area (w, row, TEXT_AREA, overlaps);
4057 if (row->used[RIGHT_MARGIN_AREA])
4058 rif->fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, overlaps);
4060 /* Record in neighbour rows that ROW overwrites part of
4061 their display. */
4062 if (overlaps & OVERLAPS_PRED)
4063 MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p = 1;
4064 if (overlaps & OVERLAPS_SUCC)
4065 MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p = 1;
4069 if (bottom_y >= yb)
4070 break;
4074 #endif /* HAVE_WINDOW_SYSTEM */
4077 #ifdef GLYPH_DEBUG
4079 /* Check that no row in the current matrix of window W is enabled
4080 which is below what's displayed in the window. */
4082 void
4083 check_current_matrix_flags (w)
4084 struct window *w;
4086 int last_seen_p = 0;
4087 int i, yb = window_text_bottom_y (w);
4089 for (i = 0; i < w->current_matrix->nrows - 1; ++i)
4091 struct glyph_row *row = MATRIX_ROW (w->current_matrix, i);
4092 if (!last_seen_p && MATRIX_ROW_BOTTOM_Y (row) >= yb)
4093 last_seen_p = 1;
4094 else if (last_seen_p && row->enabled_p)
4095 abort ();
4099 #endif /* GLYPH_DEBUG */
4102 /* Update display of window W. FORCE_P non-zero means that we should
4103 not stop when detecting pending input. */
4105 static int
4106 update_window (w, force_p)
4107 struct window *w;
4108 int force_p;
4110 struct glyph_matrix *desired_matrix = w->desired_matrix;
4111 int paused_p;
4112 int preempt_count = baud_rate / 2400 + 1;
4113 extern int input_pending;
4114 extern Lisp_Object do_mouse_tracking;
4115 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4116 #if GLYPH_DEBUG
4117 /* Check that W's frame doesn't have glyph matrices. */
4118 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w))));
4119 #endif
4121 /* Check pending input the first time so that we can quickly return. */
4122 if (redisplay_dont_pause)
4123 force_p = 1;
4124 else
4125 detect_input_pending_ignore_squeezables ();
4127 /* If forced to complete the update, or if no input is pending, do
4128 the update. */
4129 if (force_p || !input_pending || !NILP (do_mouse_tracking))
4131 struct glyph_row *row, *end;
4132 struct glyph_row *mode_line_row;
4133 struct glyph_row *header_line_row;
4134 int yb, changed_p = 0, mouse_face_overwritten_p = 0, n_updated;
4136 rif->update_window_begin_hook (w);
4137 yb = window_text_bottom_y (w);
4139 /* If window has a header line, update it before everything else.
4140 Adjust y-positions of other rows by the header line height. */
4141 row = desired_matrix->rows;
4142 end = row + desired_matrix->nrows - 1;
4144 if (row->mode_line_p)
4146 header_line_row = row;
4147 ++row;
4149 else
4150 header_line_row = NULL;
4152 /* Update the mode line, if necessary. */
4153 mode_line_row = MATRIX_MODE_LINE_ROW (desired_matrix);
4154 if (mode_line_row->mode_line_p && mode_line_row->enabled_p)
4156 mode_line_row->y = yb;
4157 update_window_line (w, MATRIX_ROW_VPOS (mode_line_row,
4158 desired_matrix),
4159 &mouse_face_overwritten_p);
4160 changed_p = 1;
4163 /* Find first enabled row. Optimizations in redisplay_internal
4164 may lead to an update with only one row enabled. There may
4165 be also completely empty matrices. */
4166 while (row < end && !row->enabled_p)
4167 ++row;
4169 /* Try reusing part of the display by copying. */
4170 if (row < end && !desired_matrix->no_scrolling_p)
4172 int rc = scrolling_window (w, header_line_row != NULL);
4173 if (rc < 0)
4175 /* All rows were found to be equal. */
4176 paused_p = 0;
4177 goto set_cursor;
4179 else if (rc > 0)
4181 /* We've scrolled the display. */
4182 force_p = 1;
4183 changed_p = 1;
4187 /* Update the rest of the lines. */
4188 for (n_updated = 0; row < end && (force_p || !input_pending); ++row)
4189 if (row->enabled_p)
4191 int vpos = MATRIX_ROW_VPOS (row, desired_matrix);
4192 int i;
4194 /* We'll have to play a little bit with when to
4195 detect_input_pending. If it's done too often,
4196 scrolling large windows with repeated scroll-up
4197 commands will too quickly pause redisplay. */
4198 if (!force_p && ++n_updated % preempt_count == 0)
4199 detect_input_pending_ignore_squeezables ();
4201 changed_p |= update_window_line (w, vpos,
4202 &mouse_face_overwritten_p);
4204 /* Mark all rows below the last visible one in the current
4205 matrix as invalid. This is necessary because of
4206 variable line heights. Consider the case of three
4207 successive redisplays, where the first displays 5
4208 lines, the second 3 lines, and the third 5 lines again.
4209 If the second redisplay wouldn't mark rows in the
4210 current matrix invalid, the third redisplay might be
4211 tempted to optimize redisplay based on lines displayed
4212 in the first redisplay. */
4213 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4214 for (i = vpos + 1; i < w->current_matrix->nrows - 1; ++i)
4215 MATRIX_ROW (w->current_matrix, i)->enabled_p = 0;
4218 /* Was display preempted? */
4219 paused_p = row < end;
4221 set_cursor:
4223 /* Update the header line after scrolling because a new header
4224 line would otherwise overwrite lines at the top of the window
4225 that can be scrolled. */
4226 if (header_line_row && header_line_row->enabled_p)
4228 header_line_row->y = 0;
4229 update_window_line (w, 0, &mouse_face_overwritten_p);
4230 changed_p = 1;
4233 /* Fix the appearance of overlapping/overlapped rows. */
4234 if (!paused_p && !w->pseudo_window_p)
4236 #ifdef HAVE_WINDOW_SYSTEM
4237 if (changed_p && rif->fix_overlapping_area)
4239 redraw_overlapped_rows (w, yb);
4240 redraw_overlapping_rows (w, yb);
4242 #endif
4244 /* Make cursor visible at cursor position of W. */
4245 set_window_cursor_after_update (w);
4247 #if 0 /* Check that current matrix invariants are satisfied. This is
4248 for debugging only. See the comment of check_matrix_invariants. */
4249 IF_DEBUG (check_matrix_invariants (w));
4250 #endif
4253 #if GLYPH_DEBUG
4254 /* Remember the redisplay method used to display the matrix. */
4255 strcpy (w->current_matrix->method, w->desired_matrix->method);
4256 #endif
4258 #ifdef HAVE_WINDOW_SYSTEM
4259 update_window_fringes (w, 0);
4260 #endif
4262 /* End the update of window W. Don't set the cursor if we
4263 paused updating the display because in this case,
4264 set_window_cursor_after_update hasn't been called, and
4265 output_cursor doesn't contain the cursor location. */
4266 rif->update_window_end_hook (w, !paused_p, mouse_face_overwritten_p);
4268 else
4269 paused_p = 1;
4271 #if GLYPH_DEBUG
4272 /* check_current_matrix_flags (w); */
4273 add_window_display_history (w, w->current_matrix->method, paused_p);
4274 #endif
4276 clear_glyph_matrix (desired_matrix);
4278 return paused_p;
4282 /* Update the display of area AREA in window W, row number VPOS.
4283 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
4285 static void
4286 update_marginal_area (w, area, vpos)
4287 struct window *w;
4288 int area, vpos;
4290 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4291 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4293 /* Let functions in xterm.c know what area subsequent X positions
4294 will be relative to. */
4295 updated_area = area;
4297 /* Set cursor to start of glyphs, write them, and clear to the end
4298 of the area. I don't think that something more sophisticated is
4299 necessary here, since marginal areas will not be the default. */
4300 rif->cursor_to (vpos, 0, desired_row->y, 0);
4301 if (desired_row->used[area])
4302 rif->write_glyphs (desired_row->glyphs[area], desired_row->used[area]);
4303 rif->clear_end_of_line (-1);
4307 /* Update the display of the text area of row VPOS in window W.
4308 Value is non-zero if display has changed. */
4310 static int
4311 update_text_area (w, vpos)
4312 struct window *w;
4313 int vpos;
4315 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4316 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4317 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4318 int changed_p = 0;
4320 /* Let functions in xterm.c know what area subsequent X positions
4321 will be relative to. */
4322 updated_area = TEXT_AREA;
4324 /* If rows are at different X or Y, or rows have different height,
4325 or the current row is marked invalid, write the entire line. */
4326 if (!current_row->enabled_p
4327 || desired_row->y != current_row->y
4328 || desired_row->ascent != current_row->ascent
4329 || desired_row->phys_ascent != current_row->phys_ascent
4330 || desired_row->phys_height != current_row->phys_height
4331 || desired_row->visible_height != current_row->visible_height
4332 || current_row->overlapped_p
4333 || current_row->mouse_face_p
4334 || current_row->x != desired_row->x)
4336 rif->cursor_to (vpos, 0, desired_row->y, desired_row->x);
4338 if (desired_row->used[TEXT_AREA])
4339 rif->write_glyphs (desired_row->glyphs[TEXT_AREA],
4340 desired_row->used[TEXT_AREA]);
4342 /* Clear to end of window. */
4343 rif->clear_end_of_line (-1);
4344 changed_p = 1;
4346 /* This erases the cursor. We do this here because
4347 notice_overwritten_cursor cannot easily check this, which
4348 might indicate that the whole functionality of
4349 notice_overwritten_cursor would better be implemented here.
4350 On the other hand, we need notice_overwritten_cursor as long
4351 as mouse highlighting is done asynchronously outside of
4352 redisplay. */
4353 if (vpos == w->phys_cursor.vpos)
4354 w->phys_cursor_on_p = 0;
4356 else
4358 int stop, i, x;
4359 struct glyph *current_glyph = current_row->glyphs[TEXT_AREA];
4360 struct glyph *desired_glyph = desired_row->glyphs[TEXT_AREA];
4361 int overlapping_glyphs_p = current_row->contains_overlapping_glyphs_p;
4362 int desired_stop_pos = desired_row->used[TEXT_AREA];
4364 /* If the desired row extends its face to the text area end, and
4365 unless the current row also does so at the same position,
4366 make sure we write at least one glyph, so that the face
4367 extension actually takes place. */
4368 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row)
4369 && (desired_stop_pos < current_row->used[TEXT_AREA]
4370 || (desired_stop_pos == current_row->used[TEXT_AREA]
4371 && !MATRIX_ROW_EXTENDS_FACE_P (current_row))))
4372 --desired_stop_pos;
4374 stop = min (current_row->used[TEXT_AREA], desired_stop_pos);
4375 i = 0;
4376 x = desired_row->x;
4378 /* Loop over glyphs that current and desired row may have
4379 in common. */
4380 while (i < stop)
4382 int can_skip_p = 1;
4384 /* Skip over glyphs that both rows have in common. These
4385 don't have to be written. We can't skip if the last
4386 current glyph overlaps the glyph to its right. For
4387 example, consider a current row of `if ' with the `f' in
4388 Courier bold so that it overlaps the ` ' to its right.
4389 If the desired row is ` ', we would skip over the space
4390 after the `if' and there would remain a pixel from the
4391 `f' on the screen. */
4392 if (overlapping_glyphs_p && i > 0)
4394 struct glyph *glyph = &current_row->glyphs[TEXT_AREA][i - 1];
4395 int left, right;
4397 rif->get_glyph_overhangs (glyph, XFRAME (w->frame),
4398 &left, &right);
4399 can_skip_p = right == 0;
4402 if (can_skip_p)
4404 while (i < stop
4405 && GLYPH_EQUAL_P (desired_glyph, current_glyph))
4407 x += desired_glyph->pixel_width;
4408 ++desired_glyph, ++current_glyph, ++i;
4411 /* Consider the case that the current row contains "xxx
4412 ppp ggg" in italic Courier font, and the desired row
4413 is "xxx ggg". The character `p' has lbearing, `g'
4414 has not. The loop above will stop in front of the
4415 first `p' in the current row. If we would start
4416 writing glyphs there, we wouldn't erase the lbearing
4417 of the `p'. The rest of the lbearing problem is then
4418 taken care of by draw_glyphs. */
4419 if (overlapping_glyphs_p
4420 && i > 0
4421 && i < current_row->used[TEXT_AREA]
4422 && (current_row->used[TEXT_AREA]
4423 != desired_row->used[TEXT_AREA]))
4425 int left, right;
4427 rif->get_glyph_overhangs (current_glyph, XFRAME (w->frame),
4428 &left, &right);
4429 while (left > 0 && i > 0)
4431 --i, --desired_glyph, --current_glyph;
4432 x -= desired_glyph->pixel_width;
4433 left -= desired_glyph->pixel_width;
4438 /* Try to avoid writing the entire rest of the desired row
4439 by looking for a resync point. This mainly prevents
4440 mode line flickering in the case the mode line is in
4441 fixed-pitch font, which it usually will be. */
4442 if (i < desired_row->used[TEXT_AREA])
4444 int start_x = x, start_hpos = i;
4445 struct glyph *start = desired_glyph;
4446 int current_x = x;
4447 int skip_first_p = !can_skip_p;
4449 /* Find the next glyph that's equal again. */
4450 while (i < stop
4451 && (skip_first_p
4452 || !GLYPH_EQUAL_P (desired_glyph, current_glyph))
4453 && x == current_x)
4455 x += desired_glyph->pixel_width;
4456 current_x += current_glyph->pixel_width;
4457 ++desired_glyph, ++current_glyph, ++i;
4458 skip_first_p = 0;
4461 if (i == start_hpos || x != current_x)
4463 i = start_hpos;
4464 x = start_x;
4465 desired_glyph = start;
4466 break;
4469 rif->cursor_to (vpos, start_hpos, desired_row->y, start_x);
4470 rif->write_glyphs (start, i - start_hpos);
4471 changed_p = 1;
4475 /* Write the rest. */
4476 if (i < desired_row->used[TEXT_AREA])
4478 rif->cursor_to (vpos, i, desired_row->y, x);
4479 rif->write_glyphs (desired_glyph, desired_row->used[TEXT_AREA] - i);
4480 changed_p = 1;
4483 /* Maybe clear to end of line. */
4484 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row))
4486 /* If new row extends to the end of the text area, nothing
4487 has to be cleared, if and only if we did a write_glyphs
4488 above. This is made sure by setting desired_stop_pos
4489 appropriately above. */
4490 xassert (i < desired_row->used[TEXT_AREA]
4491 || ((desired_row->used[TEXT_AREA]
4492 == current_row->used[TEXT_AREA])
4493 && MATRIX_ROW_EXTENDS_FACE_P (current_row)));
4495 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row))
4497 /* If old row extends to the end of the text area, clear. */
4498 if (i >= desired_row->used[TEXT_AREA])
4499 rif->cursor_to (vpos, i, desired_row->y,
4500 desired_row->pixel_width);
4501 rif->clear_end_of_line (-1);
4502 changed_p = 1;
4504 else if (desired_row->pixel_width < current_row->pixel_width)
4506 /* Otherwise clear to the end of the old row. Everything
4507 after that position should be clear already. */
4508 int x;
4510 if (i >= desired_row->used[TEXT_AREA])
4511 rif->cursor_to (vpos, i, desired_row->y,
4512 desired_row->pixel_width);
4514 /* If cursor is displayed at the end of the line, make sure
4515 it's cleared. Nowadays we don't have a phys_cursor_glyph
4516 with which to erase the cursor (because this method
4517 doesn't work with lbearing/rbearing), so we must do it
4518 this way. */
4519 if (vpos == w->phys_cursor.vpos
4520 && w->phys_cursor.hpos >= desired_row->used[TEXT_AREA])
4522 w->phys_cursor_on_p = 0;
4523 x = -1;
4525 else
4526 x = current_row->pixel_width;
4527 rif->clear_end_of_line (x);
4528 changed_p = 1;
4532 return changed_p;
4536 /* Update row VPOS in window W. Value is non-zero if display has been
4537 changed. */
4539 static int
4540 update_window_line (w, vpos, mouse_face_overwritten_p)
4541 struct window *w;
4542 int vpos, *mouse_face_overwritten_p;
4544 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4545 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4546 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4547 int changed_p = 0;
4549 /* Set the row being updated. This is important to let xterm.c
4550 know what line height values are in effect. */
4551 updated_row = desired_row;
4553 /* A row can be completely invisible in case a desired matrix was
4554 built with a vscroll and then make_cursor_line_fully_visible shifts
4555 the matrix. Make sure to make such rows current anyway, since
4556 we need the correct y-position, for example, in the current matrix. */
4557 if (desired_row->mode_line_p
4558 || desired_row->visible_height > 0)
4560 xassert (desired_row->enabled_p);
4562 /* Update display of the left margin area, if there is one. */
4563 if (!desired_row->full_width_p
4564 && !NILP (w->left_margin_cols))
4566 changed_p = 1;
4567 update_marginal_area (w, LEFT_MARGIN_AREA, vpos);
4570 /* Update the display of the text area. */
4571 if (update_text_area (w, vpos))
4573 changed_p = 1;
4574 if (current_row->mouse_face_p)
4575 *mouse_face_overwritten_p = 1;
4578 /* Update display of the right margin area, if there is one. */
4579 if (!desired_row->full_width_p
4580 && !NILP (w->right_margin_cols))
4582 changed_p = 1;
4583 update_marginal_area (w, RIGHT_MARGIN_AREA, vpos);
4586 /* Draw truncation marks etc. */
4587 if (!current_row->enabled_p
4588 || desired_row->y != current_row->y
4589 || desired_row->visible_height != current_row->visible_height
4590 || desired_row->cursor_in_fringe_p != current_row->cursor_in_fringe_p
4591 || desired_row->overlay_arrow_bitmap != current_row->overlay_arrow_bitmap
4592 || current_row->redraw_fringe_bitmaps_p
4593 || desired_row->mode_line_p != current_row->mode_line_p
4594 || desired_row->exact_window_width_line_p != current_row->exact_window_width_line_p
4595 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row)
4596 != MATRIX_ROW_CONTINUATION_LINE_P (current_row)))
4597 rif->after_update_window_line_hook (desired_row);
4600 /* Update current_row from desired_row. */
4601 make_current (w->desired_matrix, w->current_matrix, vpos);
4602 updated_row = NULL;
4603 return changed_p;
4607 /* Set the cursor after an update of window W. This function may only
4608 be called from update_window. */
4610 static void
4611 set_window_cursor_after_update (w)
4612 struct window *w;
4614 struct frame *f = XFRAME (w->frame);
4615 struct redisplay_interface *rif = FRAME_RIF (f);
4616 int cx, cy, vpos, hpos;
4618 /* Not intended for frame matrix updates. */
4619 xassert (FRAME_WINDOW_P (f));
4621 if (cursor_in_echo_area
4622 && !NILP (echo_area_buffer[0])
4623 /* If we are showing a message instead of the mini-buffer,
4624 show the cursor for the message instead. */
4625 && XWINDOW (minibuf_window) == w
4626 && EQ (minibuf_window, echo_area_window)
4627 /* These cases apply only to the frame that contains
4628 the active mini-buffer window. */
4629 && FRAME_HAS_MINIBUF_P (f)
4630 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
4632 cx = cy = vpos = hpos = 0;
4634 if (cursor_in_echo_area >= 0)
4636 /* If the mini-buffer is several lines high, find the last
4637 line that has any text on it. Note: either all lines
4638 are enabled or none. Otherwise we wouldn't be able to
4639 determine Y. */
4640 struct glyph_row *row, *last_row;
4641 struct glyph *glyph;
4642 int yb = window_text_bottom_y (w);
4644 last_row = NULL;
4645 row = w->current_matrix->rows;
4646 while (row->enabled_p
4647 && (last_row == NULL
4648 || MATRIX_ROW_BOTTOM_Y (row) <= yb))
4650 if (row->used[TEXT_AREA]
4651 && row->glyphs[TEXT_AREA][0].charpos >= 0)
4652 last_row = row;
4653 ++row;
4656 if (last_row)
4658 struct glyph *start = last_row->glyphs[TEXT_AREA];
4659 struct glyph *last = start + last_row->used[TEXT_AREA] - 1;
4661 while (last > start && last->charpos < 0)
4662 --last;
4664 for (glyph = start; glyph < last; ++glyph)
4666 cx += glyph->pixel_width;
4667 ++hpos;
4670 cy = last_row->y;
4671 vpos = MATRIX_ROW_VPOS (last_row, w->current_matrix);
4675 else
4677 cx = w->cursor.x;
4678 cy = w->cursor.y;
4679 hpos = w->cursor.hpos;
4680 vpos = w->cursor.vpos;
4683 /* Window cursor can be out of sync for horizontally split windows. */
4684 hpos = max (0, hpos);
4685 hpos = min (w->current_matrix->matrix_w - 1, hpos);
4686 vpos = max (0, vpos);
4687 vpos = min (w->current_matrix->nrows - 1, vpos);
4688 rif->cursor_to (vpos, hpos, cy, cx);
4692 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4693 tree rooted at W. */
4695 void
4696 set_window_update_flags (w, on_p)
4697 struct window *w;
4698 int on_p;
4700 while (w)
4702 if (!NILP (w->hchild))
4703 set_window_update_flags (XWINDOW (w->hchild), on_p);
4704 else if (!NILP (w->vchild))
4705 set_window_update_flags (XWINDOW (w->vchild), on_p);
4706 else
4707 w->must_be_updated_p = on_p;
4709 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4715 /***********************************************************************
4716 Window-Based Scrolling
4717 ***********************************************************************/
4719 /* Structure describing rows in scrolling_window. */
4721 struct row_entry
4723 /* Number of occurrences of this row in desired and current matrix. */
4724 int old_uses, new_uses;
4726 /* Vpos of row in new matrix. */
4727 int new_line_number;
4729 /* Bucket index of this row_entry in the hash table row_table. */
4730 int bucket;
4732 /* The row described by this entry. */
4733 struct glyph_row *row;
4735 /* Hash collision chain. */
4736 struct row_entry *next;
4739 /* A pool to allocate row_entry structures from, and the size of the
4740 pool. The pool is reallocated in scrolling_window when we find
4741 that we need a larger one. */
4743 static struct row_entry *row_entry_pool;
4744 static int row_entry_pool_size;
4746 /* Index of next free entry in row_entry_pool. */
4748 static int row_entry_idx;
4750 /* The hash table used during scrolling, and the table's size. This
4751 table is used to quickly identify equal rows in the desired and
4752 current matrix. */
4754 static struct row_entry **row_table;
4755 static int row_table_size;
4757 /* Vectors of pointers to row_entry structures belonging to the
4758 current and desired matrix, and the size of the vectors. */
4760 static struct row_entry **old_lines, **new_lines;
4761 static int old_lines_size, new_lines_size;
4763 /* A pool to allocate run structures from, and its size. */
4765 static struct run *run_pool;
4766 static int runs_size;
4768 /* A vector of runs of lines found during scrolling. */
4770 static struct run **runs;
4772 /* Add glyph row ROW to the scrolling hash table during the scrolling
4773 of window W. */
4775 static INLINE struct row_entry *
4776 add_row_entry (w, row)
4777 struct window *w;
4778 struct glyph_row *row;
4780 struct row_entry *entry;
4781 int i = row->hash % row_table_size;
4783 entry = row_table[i];
4784 while (entry && !row_equal_p (w, entry->row, row, 1))
4785 entry = entry->next;
4787 if (entry == NULL)
4789 entry = row_entry_pool + row_entry_idx++;
4790 entry->row = row;
4791 entry->old_uses = entry->new_uses = 0;
4792 entry->new_line_number = 0;
4793 entry->bucket = i;
4794 entry->next = row_table[i];
4795 row_table[i] = entry;
4798 return entry;
4802 /* Try to reuse part of the current display of W by scrolling lines.
4803 HEADER_LINE_P non-zero means W has a header line.
4805 The algorithm is taken from Communications of the ACM, Apr78 "A
4806 Technique for Isolating Differences Between Files." It should take
4807 O(N) time.
4809 A short outline of the steps of the algorithm
4811 1. Skip lines equal at the start and end of both matrices.
4813 2. Enter rows in the current and desired matrix into a symbol
4814 table, counting how often they appear in both matrices.
4816 3. Rows that appear exactly once in both matrices serve as anchors,
4817 i.e. we assume that such lines are likely to have been moved.
4819 4. Starting from anchor lines, extend regions to be scrolled both
4820 forward and backward.
4822 Value is
4824 -1 if all rows were found to be equal.
4825 0 to indicate that we did not scroll the display, or
4826 1 if we did scroll. */
4828 static int
4829 scrolling_window (w, header_line_p)
4830 struct window *w;
4831 int header_line_p;
4833 struct glyph_matrix *desired_matrix = w->desired_matrix;
4834 struct glyph_matrix *current_matrix = w->current_matrix;
4835 int yb = window_text_bottom_y (w);
4836 int i, j, first_old, first_new, last_old, last_new;
4837 int nruns, nbytes, n, run_idx;
4838 struct row_entry *entry;
4839 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4841 /* Skip over rows equal at the start. */
4842 for (i = header_line_p ? 1 : 0; i < current_matrix->nrows - 1; ++i)
4844 struct glyph_row *d = MATRIX_ROW (desired_matrix, i);
4845 struct glyph_row *c = MATRIX_ROW (current_matrix, i);
4847 if (c->enabled_p
4848 && d->enabled_p
4849 && !d->redraw_fringe_bitmaps_p
4850 && c->y == d->y
4851 && MATRIX_ROW_BOTTOM_Y (c) <= yb
4852 && MATRIX_ROW_BOTTOM_Y (d) <= yb
4853 && row_equal_p (w, c, d, 1))
4855 assign_row (c, d);
4856 d->enabled_p = 0;
4858 else
4859 break;
4862 /* Give up if some rows in the desired matrix are not enabled. */
4863 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4864 return -1;
4866 first_old = first_new = i;
4868 /* Set last_new to the index + 1 of the last enabled row in the
4869 desired matrix. */
4870 i = first_new + 1;
4871 while (i < desired_matrix->nrows - 1
4872 && MATRIX_ROW (desired_matrix, i)->enabled_p
4873 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix, i)) <= yb)
4874 ++i;
4876 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4877 return 0;
4879 last_new = i;
4881 /* Set last_old to the index + 1 of the last enabled row in the
4882 current matrix. We don't look at the enabled flag here because
4883 we plan to reuse part of the display even if other parts are
4884 disabled. */
4885 i = first_old + 1;
4886 while (i < current_matrix->nrows - 1)
4888 int bottom = MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix, i));
4889 if (bottom <= yb)
4890 ++i;
4891 if (bottom >= yb)
4892 break;
4895 last_old = i;
4897 /* Skip over rows equal at the bottom. */
4898 i = last_new;
4899 j = last_old;
4900 while (i - 1 > first_new
4901 && j - 1 > first_old
4902 && MATRIX_ROW (current_matrix, i - 1)->enabled_p
4903 && (MATRIX_ROW (current_matrix, i - 1)->y
4904 == MATRIX_ROW (desired_matrix, j - 1)->y)
4905 && !MATRIX_ROW (desired_matrix, j - 1)->redraw_fringe_bitmaps_p
4906 && row_equal_p (w,
4907 MATRIX_ROW (desired_matrix, i - 1),
4908 MATRIX_ROW (current_matrix, j - 1), 1))
4909 --i, --j;
4910 last_new = i;
4911 last_old = j;
4913 /* Nothing to do if all rows are equal. */
4914 if (last_new == first_new)
4915 return 0;
4917 /* Reallocate vectors, tables etc. if necessary. */
4919 if (current_matrix->nrows > old_lines_size)
4921 old_lines_size = current_matrix->nrows;
4922 nbytes = old_lines_size * sizeof *old_lines;
4923 old_lines = (struct row_entry **) xrealloc (old_lines, nbytes);
4926 if (desired_matrix->nrows > new_lines_size)
4928 new_lines_size = desired_matrix->nrows;
4929 nbytes = new_lines_size * sizeof *new_lines;
4930 new_lines = (struct row_entry **) xrealloc (new_lines, nbytes);
4933 n = desired_matrix->nrows + current_matrix->nrows;
4934 if (3 * n > row_table_size)
4936 row_table_size = next_almost_prime (3 * n);
4937 nbytes = row_table_size * sizeof *row_table;
4938 row_table = (struct row_entry **) xrealloc (row_table, nbytes);
4939 bzero (row_table, nbytes);
4942 if (n > row_entry_pool_size)
4944 row_entry_pool_size = n;
4945 nbytes = row_entry_pool_size * sizeof *row_entry_pool;
4946 row_entry_pool = (struct row_entry *) xrealloc (row_entry_pool, nbytes);
4949 if (desired_matrix->nrows > runs_size)
4951 runs_size = desired_matrix->nrows;
4952 nbytes = runs_size * sizeof *runs;
4953 runs = (struct run **) xrealloc (runs, nbytes);
4954 nbytes = runs_size * sizeof *run_pool;
4955 run_pool = (struct run *) xrealloc (run_pool, nbytes);
4958 nruns = run_idx = 0;
4959 row_entry_idx = 0;
4961 /* Add rows from the current and desired matrix to the hash table
4962 row_hash_table to be able to find equal ones quickly. */
4964 for (i = first_old; i < last_old; ++i)
4966 if (MATRIX_ROW (current_matrix, i)->enabled_p)
4968 entry = add_row_entry (w, MATRIX_ROW (current_matrix, i));
4969 old_lines[i] = entry;
4970 ++entry->old_uses;
4972 else
4973 old_lines[i] = NULL;
4976 for (i = first_new; i < last_new; ++i)
4978 xassert (MATRIX_ROW_ENABLED_P (desired_matrix, i));
4979 entry = add_row_entry (w, MATRIX_ROW (desired_matrix, i));
4980 ++entry->new_uses;
4981 entry->new_line_number = i;
4982 new_lines[i] = entry;
4985 /* Identify moves based on lines that are unique and equal
4986 in both matrices. */
4987 for (i = first_old; i < last_old;)
4988 if (old_lines[i]
4989 && old_lines[i]->old_uses == 1
4990 && old_lines[i]->new_uses == 1)
4992 int j, k;
4993 int new_line = old_lines[i]->new_line_number;
4994 struct run *run = run_pool + run_idx++;
4996 /* Record move. */
4997 run->current_vpos = i;
4998 run->current_y = MATRIX_ROW (current_matrix, i)->y;
4999 run->desired_vpos = new_line;
5000 run->desired_y = MATRIX_ROW (desired_matrix, new_line)->y;
5001 run->nrows = 1;
5002 run->height = MATRIX_ROW (current_matrix, i)->height;
5004 /* Extend backward. */
5005 j = i - 1;
5006 k = new_line - 1;
5007 while (j > first_old
5008 && k > first_new
5009 && old_lines[j] == new_lines[k])
5011 int h = MATRIX_ROW (current_matrix, j)->height;
5012 --run->current_vpos;
5013 --run->desired_vpos;
5014 ++run->nrows;
5015 run->height += h;
5016 run->desired_y -= h;
5017 run->current_y -= h;
5018 --j, --k;
5021 /* Extend forward. */
5022 j = i + 1;
5023 k = new_line + 1;
5024 while (j < last_old
5025 && k < last_new
5026 && old_lines[j] == new_lines[k])
5028 int h = MATRIX_ROW (current_matrix, j)->height;
5029 ++run->nrows;
5030 run->height += h;
5031 ++j, ++k;
5034 /* Insert run into list of all runs. Order runs by copied
5035 pixel lines. Note that we record runs that don't have to
5036 be copied because they are already in place. This is done
5037 because we can avoid calling update_window_line in this
5038 case. */
5039 for (j = 0; j < nruns && runs[j]->height > run->height; ++j)
5041 for (k = nruns; k > j; --k)
5042 runs[k] = runs[k - 1];
5043 runs[j] = run;
5044 ++nruns;
5046 i += run->nrows;
5048 else
5049 ++i;
5051 /* Do the moves. Do it in a way that we don't overwrite something
5052 we want to copy later on. This is not solvable in general
5053 because there is only one display and we don't have a way to
5054 exchange areas on this display. Example:
5056 +-----------+ +-----------+
5057 | A | | B |
5058 +-----------+ --> +-----------+
5059 | B | | A |
5060 +-----------+ +-----------+
5062 Instead, prefer bigger moves, and invalidate moves that would
5063 copy from where we copied to. */
5065 for (i = 0; i < nruns; ++i)
5066 if (runs[i]->nrows > 0)
5068 struct run *r = runs[i];
5070 /* Copy on the display. */
5071 if (r->current_y != r->desired_y)
5073 rif->scroll_run_hook (w, r);
5075 /* Invalidate runs that copy from where we copied to. */
5076 for (j = i + 1; j < nruns; ++j)
5078 struct run *p = runs[j];
5080 if ((p->current_y >= r->desired_y
5081 && p->current_y < r->desired_y + r->height)
5082 || (p->current_y + p->height >= r->desired_y
5083 && (p->current_y + p->height
5084 < r->desired_y + r->height)))
5085 p->nrows = 0;
5089 /* Assign matrix rows. */
5090 for (j = 0; j < r->nrows; ++j)
5092 struct glyph_row *from, *to;
5093 int to_overlapped_p;
5095 to = MATRIX_ROW (current_matrix, r->desired_vpos + j);
5096 from = MATRIX_ROW (desired_matrix, r->desired_vpos + j);
5097 to_overlapped_p = to->overlapped_p;
5098 if (!from->mode_line_p && !w->pseudo_window_p
5099 && (to->left_fringe_bitmap != from->left_fringe_bitmap
5100 || to->right_fringe_bitmap != from->right_fringe_bitmap
5101 || to->left_fringe_face_id != from->left_fringe_face_id
5102 || to->right_fringe_face_id != from->right_fringe_face_id
5103 || to->overlay_arrow_bitmap != from->overlay_arrow_bitmap))
5104 from->redraw_fringe_bitmaps_p = 1;
5105 assign_row (to, from);
5106 to->enabled_p = 1, from->enabled_p = 0;
5107 to->overlapped_p = to_overlapped_p;
5111 /* Clear the hash table, for the next time. */
5112 for (i = 0; i < row_entry_idx; ++i)
5113 row_table[row_entry_pool[i].bucket] = NULL;
5115 /* Value is > 0 to indicate that we scrolled the display. */
5116 return nruns;
5121 /************************************************************************
5122 Frame-Based Updates
5123 ************************************************************************/
5125 /* Update the desired frame matrix of frame F.
5127 FORCE_P non-zero means that the update should not be stopped by
5128 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
5129 should not be tried.
5131 Value is non-zero if update was stopped due to pending input. */
5133 static int
5134 update_frame_1 (f, force_p, inhibit_id_p)
5135 struct frame *f;
5136 int force_p;
5137 int inhibit_id_p;
5139 /* Frame matrices to work on. */
5140 struct glyph_matrix *current_matrix = f->current_matrix;
5141 struct glyph_matrix *desired_matrix = f->desired_matrix;
5142 int i;
5143 int pause;
5144 int preempt_count = baud_rate / 2400 + 1;
5145 extern int input_pending;
5147 xassert (current_matrix && desired_matrix);
5149 if (baud_rate != FRAME_COST_BAUD_RATE (f))
5150 calculate_costs (f);
5152 if (preempt_count <= 0)
5153 preempt_count = 1;
5155 if (redisplay_dont_pause)
5156 force_p = 1;
5157 else if (!force_p && detect_input_pending_ignore_squeezables ())
5159 pause = 1;
5160 goto do_pause;
5163 /* If we cannot insert/delete lines, it's no use trying it. */
5164 if (!FRAME_LINE_INS_DEL_OK (f))
5165 inhibit_id_p = 1;
5167 /* See if any of the desired lines are enabled; don't compute for
5168 i/d line if just want cursor motion. */
5169 for (i = 0; i < desired_matrix->nrows; i++)
5170 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5171 break;
5173 /* Try doing i/d line, if not yet inhibited. */
5174 if (!inhibit_id_p && i < desired_matrix->nrows)
5175 force_p |= scrolling (f);
5177 /* Update the individual lines as needed. Do bottom line first. */
5178 if (MATRIX_ROW_ENABLED_P (desired_matrix, desired_matrix->nrows - 1))
5179 update_frame_line (f, desired_matrix->nrows - 1);
5181 /* Now update the rest of the lines. */
5182 for (i = 0; i < desired_matrix->nrows - 1 && (force_p || !input_pending); i++)
5184 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5186 if (FRAME_TERMCAP_P (f))
5188 /* Flush out every so many lines.
5189 Also flush out if likely to have more than 1k buffered
5190 otherwise. I'm told that some telnet connections get
5191 really screwed by more than 1k output at once. */
5192 int outq = PENDING_OUTPUT_COUNT (FRAME_TTY (f)->output);
5193 if (outq > 900
5194 || (outq > 20 && ((i - 1) % preempt_count == 0)))
5196 fflush (FRAME_TTY (f)->output);
5197 if (preempt_count == 1)
5199 #ifdef EMACS_OUTQSIZE
5200 if (EMACS_OUTQSIZE (0, &outq) < 0)
5201 /* Probably not a tty. Ignore the error and reset
5202 the outq count. */
5203 outq = PENDING_OUTPUT_COUNT (FRAME_TTY (f->output));
5204 #endif
5205 outq *= 10;
5206 if (baud_rate <= outq && baud_rate > 0)
5207 sleep (outq / baud_rate);
5212 if ((i - 1) % preempt_count == 0)
5213 detect_input_pending_ignore_squeezables ();
5215 update_frame_line (f, i);
5219 pause = (i < FRAME_LINES (f) - 1) ? i : 0;
5221 /* Now just clean up termcap drivers and set cursor, etc. */
5222 if (!pause)
5224 if ((cursor_in_echo_area
5225 /* If we are showing a message instead of the mini-buffer,
5226 show the cursor for the message instead of for the
5227 (now hidden) mini-buffer contents. */
5228 || (EQ (minibuf_window, selected_window)
5229 && EQ (minibuf_window, echo_area_window)
5230 && !NILP (echo_area_buffer[0])))
5231 /* These cases apply only to the frame that contains
5232 the active mini-buffer window. */
5233 && FRAME_HAS_MINIBUF_P (f)
5234 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
5236 int top = WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f)));
5237 int row, col;
5239 if (cursor_in_echo_area < 0)
5241 /* Negative value of cursor_in_echo_area means put
5242 cursor at beginning of line. */
5243 row = top;
5244 col = 0;
5246 else
5248 /* Positive value of cursor_in_echo_area means put
5249 cursor at the end of the prompt. If the mini-buffer
5250 is several lines high, find the last line that has
5251 any text on it. */
5252 row = FRAME_LINES (f);
5255 --row;
5256 col = 0;
5258 if (MATRIX_ROW_ENABLED_P (current_matrix, row))
5260 /* Frame rows are filled up with spaces that
5261 must be ignored here. */
5262 struct glyph_row *r = MATRIX_ROW (current_matrix,
5263 row);
5264 struct glyph *start = r->glyphs[TEXT_AREA];
5265 struct glyph *last = start + r->used[TEXT_AREA];
5267 while (last > start
5268 && (last - 1)->charpos < 0)
5269 --last;
5271 col = last - start;
5274 while (row > top && col == 0);
5276 /* Make sure COL is not out of range. */
5277 if (col >= FRAME_CURSOR_X_LIMIT (f))
5279 /* If we have another row, advance cursor into it. */
5280 if (row < FRAME_LINES (f) - 1)
5282 col = FRAME_LEFT_SCROLL_BAR_COLS (f);
5283 row++;
5285 /* Otherwise move it back in range. */
5286 else
5287 col = FRAME_CURSOR_X_LIMIT (f) - 1;
5291 cursor_to (f, row, col);
5293 else
5295 /* We have only one cursor on terminal frames. Use it to
5296 display the cursor of the selected window. */
5297 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
5298 if (w->cursor.vpos >= 0
5299 /* The cursor vpos may be temporarily out of bounds
5300 in the following situation: There is one window,
5301 with the cursor in the lower half of it. The window
5302 is split, and a message causes a redisplay before
5303 a new cursor position has been computed. */
5304 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
5306 int x = WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos);
5307 int y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
5309 if (INTEGERP (w->left_margin_cols))
5310 x += XFASTINT (w->left_margin_cols);
5312 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
5313 cursor_to (f, y, x);
5318 do_pause:
5320 clear_desired_matrices (f);
5321 return pause;
5325 /* Do line insertions/deletions on frame F for frame-based redisplay. */
5328 scrolling (frame)
5329 struct frame *frame;
5331 int unchanged_at_top, unchanged_at_bottom;
5332 int window_size;
5333 int changed_lines;
5334 int *old_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5335 int *new_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5336 int *draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5337 int *old_draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5338 register int i;
5339 int free_at_end_vpos = FRAME_LINES (frame);
5340 struct glyph_matrix *current_matrix = frame->current_matrix;
5341 struct glyph_matrix *desired_matrix = frame->desired_matrix;
5343 if (!current_matrix)
5344 abort ();
5346 /* Compute hash codes of all the lines. Also calculate number of
5347 changed lines, number of unchanged lines at the beginning, and
5348 number of unchanged lines at the end. */
5349 changed_lines = 0;
5350 unchanged_at_top = 0;
5351 unchanged_at_bottom = FRAME_LINES (frame);
5352 for (i = 0; i < FRAME_LINES (frame); i++)
5354 /* Give up on this scrolling if some old lines are not enabled. */
5355 if (!MATRIX_ROW_ENABLED_P (current_matrix, i))
5356 return 0;
5357 old_hash[i] = line_hash_code (MATRIX_ROW (current_matrix, i));
5358 if (! MATRIX_ROW_ENABLED_P (desired_matrix, i))
5360 /* This line cannot be redrawn, so don't let scrolling mess it. */
5361 new_hash[i] = old_hash[i];
5362 #define INFINITY 1000000 /* Taken from scroll.c */
5363 draw_cost[i] = INFINITY;
5365 else
5367 new_hash[i] = line_hash_code (MATRIX_ROW (desired_matrix, i));
5368 draw_cost[i] = line_draw_cost (desired_matrix, i);
5371 if (old_hash[i] != new_hash[i])
5373 changed_lines++;
5374 unchanged_at_bottom = FRAME_LINES (frame) - i - 1;
5376 else if (i == unchanged_at_top)
5377 unchanged_at_top++;
5378 old_draw_cost[i] = line_draw_cost (current_matrix, i);
5381 /* If changed lines are few, don't allow preemption, don't scroll. */
5382 if ((!FRAME_SCROLL_REGION_OK (frame)
5383 && changed_lines < baud_rate / 2400)
5384 || unchanged_at_bottom == FRAME_LINES (frame))
5385 return 1;
5387 window_size = (FRAME_LINES (frame) - unchanged_at_top
5388 - unchanged_at_bottom);
5390 if (FRAME_SCROLL_REGION_OK (frame))
5391 free_at_end_vpos -= unchanged_at_bottom;
5392 else if (FRAME_MEMORY_BELOW_FRAME (frame))
5393 free_at_end_vpos = -1;
5395 /* If large window, fast terminal and few lines in common between
5396 current frame and desired frame, don't bother with i/d calc. */
5397 if (!FRAME_SCROLL_REGION_OK (frame)
5398 && window_size >= 18 && baud_rate > 2400
5399 && (window_size >=
5400 10 * scrolling_max_lines_saved (unchanged_at_top,
5401 FRAME_LINES (frame) - unchanged_at_bottom,
5402 old_hash, new_hash, draw_cost)))
5403 return 0;
5405 if (window_size < 2)
5406 return 0;
5408 scrolling_1 (frame, window_size, unchanged_at_top, unchanged_at_bottom,
5409 draw_cost + unchanged_at_top - 1,
5410 old_draw_cost + unchanged_at_top - 1,
5411 old_hash + unchanged_at_top - 1,
5412 new_hash + unchanged_at_top - 1,
5413 free_at_end_vpos - unchanged_at_top);
5415 return 0;
5419 /* Count the number of blanks at the start of the vector of glyphs R
5420 which is LEN glyphs long. */
5422 static int
5423 count_blanks (r, len)
5424 struct glyph *r;
5425 int len;
5427 int i;
5429 for (i = 0; i < len; ++i)
5430 if (!CHAR_GLYPH_SPACE_P (r[i]))
5431 break;
5433 return i;
5437 /* Count the number of glyphs in common at the start of the glyph
5438 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
5439 of STR2. Value is the number of equal glyphs equal at the start. */
5441 static int
5442 count_match (str1, end1, str2, end2)
5443 struct glyph *str1, *end1, *str2, *end2;
5445 struct glyph *p1 = str1;
5446 struct glyph *p2 = str2;
5448 while (p1 < end1
5449 && p2 < end2
5450 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1, p2))
5451 ++p1, ++p2;
5453 return p1 - str1;
5457 /* Char insertion/deletion cost vector, from term.c */
5459 extern int *char_ins_del_vector;
5460 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
5463 /* Perform a frame-based update on line VPOS in frame FRAME. */
5465 static void
5466 update_frame_line (f, vpos)
5467 struct frame *f;
5468 int vpos;
5470 struct glyph *obody, *nbody, *op1, *op2, *np1, *nend;
5471 int tem;
5472 int osp, nsp, begmatch, endmatch, olen, nlen;
5473 struct glyph_matrix *current_matrix = f->current_matrix;
5474 struct glyph_matrix *desired_matrix = f->desired_matrix;
5475 struct glyph_row *current_row = MATRIX_ROW (current_matrix, vpos);
5476 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, vpos);
5477 int must_write_whole_line_p;
5478 int write_spaces_p = FRAME_MUST_WRITE_SPACES (f);
5479 int colored_spaces_p = (FACE_FROM_ID (f, DEFAULT_FACE_ID)->background
5480 != FACE_TTY_DEFAULT_BG_COLOR);
5482 if (colored_spaces_p)
5483 write_spaces_p = 1;
5485 /* Current row not enabled means it has unknown contents. We must
5486 write the whole desired line in that case. */
5487 must_write_whole_line_p = !current_row->enabled_p;
5488 if (must_write_whole_line_p)
5490 obody = 0;
5491 olen = 0;
5493 else
5495 obody = MATRIX_ROW_GLYPH_START (current_matrix, vpos);
5496 olen = current_row->used[TEXT_AREA];
5498 /* Ignore trailing spaces, if we can. */
5499 if (!write_spaces_p)
5500 while (olen > 0 && CHAR_GLYPH_SPACE_P (obody[olen-1]))
5501 olen--;
5504 current_row->enabled_p = 1;
5505 current_row->used[TEXT_AREA] = desired_row->used[TEXT_AREA];
5507 /* If desired line is empty, just clear the line. */
5508 if (!desired_row->enabled_p)
5510 nlen = 0;
5511 goto just_erase;
5514 nbody = desired_row->glyphs[TEXT_AREA];
5515 nlen = desired_row->used[TEXT_AREA];
5516 nend = nbody + nlen;
5518 /* If display line has unknown contents, write the whole line. */
5519 if (must_write_whole_line_p)
5521 /* Ignore spaces at the end, if we can. */
5522 if (!write_spaces_p)
5523 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5524 --nlen;
5526 /* Write the contents of the desired line. */
5527 if (nlen)
5529 cursor_to (f, vpos, 0);
5530 write_glyphs (f, nbody, nlen);
5533 /* Don't call clear_end_of_line if we already wrote the whole
5534 line. The cursor will not be at the right margin in that
5535 case but in the line below. */
5536 if (nlen < FRAME_TOTAL_COLS (f))
5538 cursor_to (f, vpos, nlen);
5539 clear_end_of_line (f, FRAME_TOTAL_COLS (f));
5541 else
5542 /* Make sure we are in the right row, otherwise cursor movement
5543 with cmgoto might use `ch' in the wrong row. */
5544 cursor_to (f, vpos, 0);
5546 make_current (desired_matrix, current_matrix, vpos);
5547 return;
5550 /* Pretend trailing spaces are not there at all,
5551 unless for one reason or another we must write all spaces. */
5552 if (!write_spaces_p)
5553 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5554 nlen--;
5556 /* If there's no i/d char, quickly do the best we can without it. */
5557 if (!FRAME_CHAR_INS_DEL_OK (f))
5559 int i, j;
5561 /* Find the first glyph in desired row that doesn't agree with
5562 a glyph in the current row, and write the rest from there on. */
5563 for (i = 0; i < nlen; i++)
5565 if (i >= olen || !GLYPH_EQUAL_P (nbody + i, obody + i))
5567 /* Find the end of the run of different glyphs. */
5568 j = i + 1;
5569 while (j < nlen
5570 && (j >= olen
5571 || !GLYPH_EQUAL_P (nbody + j, obody + j)
5572 || CHAR_GLYPH_PADDING_P (nbody[j])))
5573 ++j;
5575 /* Output this run of non-matching chars. */
5576 cursor_to (f, vpos, i);
5577 write_glyphs (f, nbody + i, j - i);
5578 i = j - 1;
5580 /* Now find the next non-match. */
5584 /* Clear the rest of the line, or the non-clear part of it. */
5585 if (olen > nlen)
5587 cursor_to (f, vpos, nlen);
5588 clear_end_of_line (f, olen);
5591 /* Make current row = desired row. */
5592 make_current (desired_matrix, current_matrix, vpos);
5593 return;
5596 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5597 characters in a row. */
5599 if (!olen)
5601 /* If current line is blank, skip over initial spaces, if
5602 possible, and write the rest. */
5603 if (write_spaces_p)
5604 nsp = 0;
5605 else
5606 nsp = count_blanks (nbody, nlen);
5608 if (nlen > nsp)
5610 cursor_to (f, vpos, nsp);
5611 write_glyphs (f, nbody + nsp, nlen - nsp);
5614 /* Exchange contents between current_frame and new_frame. */
5615 make_current (desired_matrix, current_matrix, vpos);
5616 return;
5619 /* Compute number of leading blanks in old and new contents. */
5620 osp = count_blanks (obody, olen);
5621 nsp = (colored_spaces_p ? 0 : count_blanks (nbody, nlen));
5623 /* Compute number of matching chars starting with first non-blank. */
5624 begmatch = count_match (obody + osp, obody + olen,
5625 nbody + nsp, nbody + nlen);
5627 /* Spaces in new match implicit space past the end of old. */
5628 /* A bug causing this to be a no-op was fixed in 18.29. */
5629 if (!write_spaces_p && osp + begmatch == olen)
5631 np1 = nbody + nsp;
5632 while (np1 + begmatch < nend && CHAR_GLYPH_SPACE_P (np1[begmatch]))
5633 ++begmatch;
5636 /* Avoid doing insert/delete char
5637 just cause number of leading spaces differs
5638 when the following text does not match. */
5639 if (begmatch == 0 && osp != nsp)
5640 osp = nsp = min (osp, nsp);
5642 /* Find matching characters at end of line */
5643 op1 = obody + olen;
5644 np1 = nbody + nlen;
5645 op2 = op1 + begmatch - min (olen - osp, nlen - nsp);
5646 while (op1 > op2
5647 && GLYPH_EQUAL_P (op1 - 1, np1 - 1))
5649 op1--;
5650 np1--;
5652 endmatch = obody + olen - op1;
5654 /* tem gets the distance to insert or delete.
5655 endmatch is how many characters we save by doing so.
5656 Is it worth it? */
5658 tem = (nlen - nsp) - (olen - osp);
5659 if (endmatch && tem
5660 && (!FRAME_CHAR_INS_DEL_OK (f)
5661 || endmatch <= char_ins_del_cost (f)[tem]))
5662 endmatch = 0;
5664 /* nsp - osp is the distance to insert or delete.
5665 If that is nonzero, begmatch is known to be nonzero also.
5666 begmatch + endmatch is how much we save by doing the ins/del.
5667 Is it worth it? */
5669 if (nsp != osp
5670 && (!FRAME_CHAR_INS_DEL_OK (f)
5671 || begmatch + endmatch <= char_ins_del_cost (f)[nsp - osp]))
5673 begmatch = 0;
5674 endmatch = 0;
5675 osp = nsp = min (osp, nsp);
5678 /* Now go through the line, inserting, writing and
5679 deleting as appropriate. */
5681 if (osp > nsp)
5683 cursor_to (f, vpos, nsp);
5684 delete_glyphs (f, osp - nsp);
5686 else if (nsp > osp)
5688 /* If going to delete chars later in line
5689 and insert earlier in the line,
5690 must delete first to avoid losing data in the insert */
5691 if (endmatch && nlen < olen + nsp - osp)
5693 cursor_to (f, vpos, nlen - endmatch + osp - nsp);
5694 delete_glyphs (f, olen + nsp - osp - nlen);
5695 olen = nlen - (nsp - osp);
5697 cursor_to (f, vpos, osp);
5698 insert_glyphs (f, 0, nsp - osp);
5700 olen += nsp - osp;
5702 tem = nsp + begmatch + endmatch;
5703 if (nlen != tem || olen != tem)
5705 if (!endmatch || nlen == olen)
5707 /* If new text being written reaches right margin, there is
5708 no need to do clear-to-eol at the end of this function
5709 (and it would not be safe, since cursor is not going to
5710 be "at the margin" after the text is done). */
5711 if (nlen == FRAME_TOTAL_COLS (f))
5712 olen = 0;
5714 /* Function write_glyphs is prepared to do nothing
5715 if passed a length <= 0. Check it here to avoid
5716 unnecessary cursor movement. */
5717 if (nlen - tem > 0)
5719 cursor_to (f, vpos, nsp + begmatch);
5720 write_glyphs (f, nbody + nsp + begmatch, nlen - tem);
5723 else if (nlen > olen)
5725 /* Here, we used to have the following simple code:
5726 ----------------------------------------
5727 write_glyphs (nbody + nsp + begmatch, olen - tem);
5728 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5729 ----------------------------------------
5730 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5731 is a padding glyph. */
5732 int out = olen - tem; /* Columns to be overwritten originally. */
5733 int del;
5735 cursor_to (f, vpos, nsp + begmatch);
5737 /* Calculate columns we can actually overwrite. */
5738 while (CHAR_GLYPH_PADDING_P (nbody[nsp + begmatch + out]))
5739 out--;
5740 write_glyphs (f, nbody + nsp + begmatch, out);
5742 /* If we left columns to be overwritten, we must delete them. */
5743 del = olen - tem - out;
5744 if (del > 0)
5745 delete_glyphs (f, del);
5747 /* At last, we insert columns not yet written out. */
5748 insert_glyphs (f, nbody + nsp + begmatch + out, nlen - olen + del);
5749 olen = nlen;
5751 else if (olen > nlen)
5753 cursor_to (f, vpos, nsp + begmatch);
5754 write_glyphs (f, nbody + nsp + begmatch, nlen - tem);
5755 delete_glyphs (f, olen - nlen);
5756 olen = nlen;
5760 just_erase:
5761 /* If any unerased characters remain after the new line, erase them. */
5762 if (olen > nlen)
5764 cursor_to (f, vpos, nlen);
5765 clear_end_of_line (f, olen);
5768 /* Exchange contents between current_frame and new_frame. */
5769 make_current (desired_matrix, current_matrix, vpos);
5774 /***********************************************************************
5775 X/Y Position -> Buffer Position
5776 ***********************************************************************/
5778 /* Determine what's under window-relative pixel position (*X, *Y).
5779 Return the object (string or buffer) that's there.
5780 Return in *POS the position in that object.
5781 Adjust *X and *Y to character positions. */
5783 Lisp_Object
5784 buffer_posn_from_coords (w, x, y, pos, object, dx, dy, width, height)
5785 struct window *w;
5786 int *x, *y;
5787 struct display_pos *pos;
5788 Lisp_Object *object;
5789 int *dx, *dy;
5790 int *width, *height;
5792 struct it it;
5793 struct buffer *old_current_buffer = current_buffer;
5794 struct text_pos startp;
5795 Lisp_Object string;
5796 struct glyph_row *row;
5797 #ifdef HAVE_WINDOW_SYSTEM
5798 struct image *img = 0;
5799 #endif
5800 int x0, x1;
5802 current_buffer = XBUFFER (w->buffer);
5803 SET_TEXT_POS_FROM_MARKER (startp, w->start);
5804 CHARPOS (startp) = min (ZV, max (BEGV, CHARPOS (startp)));
5805 BYTEPOS (startp) = min (ZV_BYTE, max (BEGV_BYTE, BYTEPOS (startp)));
5806 start_display (&it, w, startp);
5808 x0 = *x - WINDOW_LEFT_MARGIN_WIDTH (w);
5809 move_it_to (&it, -1, x0 + it.first_visible_x, *y, -1,
5810 MOVE_TO_X | MOVE_TO_Y);
5812 current_buffer = old_current_buffer;
5814 *dx = x0 + it.first_visible_x - it.current_x;
5815 *dy = *y - it.current_y;
5817 string = w->buffer;
5818 if (STRINGP (it.string))
5819 string = it.string;
5820 *pos = it.current;
5822 #ifdef HAVE_WINDOW_SYSTEM
5823 if (it.what == IT_IMAGE)
5825 if ((img = IMAGE_FROM_ID (it.f, it.image_id)) != NULL
5826 && !NILP (img->spec))
5827 *object = img->spec;
5829 #endif
5831 if (it.vpos < w->current_matrix->nrows
5832 && (row = MATRIX_ROW (w->current_matrix, it.vpos),
5833 row->enabled_p))
5835 if (it.hpos < row->used[TEXT_AREA])
5837 struct glyph *glyph = row->glyphs[TEXT_AREA] + it.hpos;
5838 #ifdef HAVE_WINDOW_SYSTEM
5839 if (img)
5841 *dy -= row->ascent - glyph->ascent;
5842 *dx += glyph->slice.x;
5843 *dy += glyph->slice.y;
5844 /* Image slices positions are still relative to the entire image */
5845 *width = img->width;
5846 *height = img->height;
5848 else
5849 #endif
5851 *width = glyph->pixel_width;
5852 *height = glyph->ascent + glyph->descent;
5855 else
5857 *width = 0;
5858 *height = row->height;
5861 else
5863 *width = *height = 0;
5866 /* Add extra (default width) columns if clicked after EOL. */
5867 x1 = max(0, it.current_x + it.pixel_width - it.first_visible_x);
5868 if (x0 > x1)
5869 it.hpos += (x0 - x1) / WINDOW_FRAME_COLUMN_WIDTH (w);
5871 *x = it.hpos;
5872 *y = it.vpos;
5874 return string;
5878 /* Value is the string under window-relative coordinates X/Y in the
5879 mode line or header line (PART says which) of window W, or nil if none.
5880 *CHARPOS is set to the position in the string returned. */
5882 Lisp_Object
5883 mode_line_string (w, part, x, y, charpos, object, dx, dy, width, height)
5884 struct window *w;
5885 enum window_part part;
5886 int *x, *y;
5887 int *charpos;
5888 Lisp_Object *object;
5889 int *dx, *dy;
5890 int *width, *height;
5892 struct glyph_row *row;
5893 struct glyph *glyph, *end;
5894 int x0, y0;
5895 Lisp_Object string = Qnil;
5897 if (part == ON_MODE_LINE)
5898 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
5899 else
5900 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
5901 y0 = *y - row->y;
5902 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
5904 if (row->mode_line_p && row->enabled_p)
5906 /* Find the glyph under X. If we find one with a string object,
5907 it's the one we were looking for. */
5908 glyph = row->glyphs[TEXT_AREA];
5909 end = glyph + row->used[TEXT_AREA];
5910 for (x0 = *x; glyph < end && x0 >= glyph->pixel_width; ++glyph)
5911 x0 -= glyph->pixel_width;
5912 *x = glyph - row->glyphs[TEXT_AREA];
5913 if (glyph < end)
5915 string = glyph->object;
5916 *charpos = glyph->charpos;
5917 *width = glyph->pixel_width;
5918 *height = glyph->ascent + glyph->descent;
5919 #ifdef HAVE_WINDOW_SYSTEM
5920 if (glyph->type == IMAGE_GLYPH)
5922 struct image *img;
5923 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
5924 if (img != NULL)
5925 *object = img->spec;
5926 y0 -= row->ascent - glyph->ascent;
5928 #endif
5930 else
5932 /* Add extra (default width) columns if clicked after EOL. */
5933 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
5934 *width = 0;
5935 *height = row->height;
5938 else
5940 *x = 0;
5941 x0 = 0;
5942 *width = *height = 0;
5945 *dx = x0;
5946 *dy = y0;
5948 return string;
5952 /* Value is the string under window-relative coordinates X/Y in either
5953 marginal area, or nil if none. *CHARPOS is set to the position in
5954 the string returned. */
5956 Lisp_Object
5957 marginal_area_string (w, part, x, y, charpos, object, dx, dy, width, height)
5958 struct window *w;
5959 enum window_part part;
5960 int *x, *y;
5961 int *charpos;
5962 Lisp_Object *object;
5963 int *dx, *dy;
5964 int *width, *height;
5966 struct glyph_row *row = w->current_matrix->rows;
5967 struct glyph *glyph, *end;
5968 int x0, y0, i, wy = *y;
5969 int area;
5970 Lisp_Object string = Qnil;
5972 if (part == ON_LEFT_MARGIN)
5973 area = LEFT_MARGIN_AREA;
5974 else if (part == ON_RIGHT_MARGIN)
5975 area = RIGHT_MARGIN_AREA;
5976 else
5977 abort ();
5979 for (i = 0; row->enabled_p && i < w->current_matrix->nrows; ++i, ++row)
5980 if (wy >= row->y && wy < MATRIX_ROW_BOTTOM_Y (row))
5981 break;
5982 y0 = *y - row->y;
5983 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
5985 if (row->enabled_p)
5987 /* Find the glyph under X. If we find one with a string object,
5988 it's the one we were looking for. */
5989 if (area == RIGHT_MARGIN_AREA)
5990 x0 = ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5991 ? WINDOW_LEFT_FRINGE_WIDTH (w)
5992 : WINDOW_TOTAL_FRINGE_WIDTH (w))
5993 + window_box_width (w, LEFT_MARGIN_AREA)
5994 + window_box_width (w, TEXT_AREA));
5995 else
5996 x0 = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5997 ? WINDOW_LEFT_FRINGE_WIDTH (w)
5998 : 0);
6000 glyph = row->glyphs[area];
6001 end = glyph + row->used[area];
6002 for (x0 = *x - x0; glyph < end && x0 >= glyph->pixel_width; ++glyph)
6003 x0 -= glyph->pixel_width;
6004 *x = glyph - row->glyphs[area];
6005 if (glyph < end)
6007 string = glyph->object;
6008 *charpos = glyph->charpos;
6009 *width = glyph->pixel_width;
6010 *height = glyph->ascent + glyph->descent;
6011 #ifdef HAVE_WINDOW_SYSTEM
6012 if (glyph->type == IMAGE_GLYPH)
6014 struct image *img;
6015 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
6016 if (img != NULL)
6017 *object = img->spec;
6018 y0 -= row->ascent - glyph->ascent;
6019 x0 += glyph->slice.x;
6020 y0 += glyph->slice.y;
6022 #endif
6024 else
6026 /* Add extra (default width) columns if clicked after EOL. */
6027 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
6028 *width = 0;
6029 *height = row->height;
6032 else
6034 x0 = 0;
6035 *x = 0;
6036 *width = *height = 0;
6039 *dx = x0;
6040 *dy = y0;
6042 return string;
6046 /***********************************************************************
6047 Changing Frame Sizes
6048 ***********************************************************************/
6050 #ifdef SIGWINCH
6052 SIGTYPE
6053 window_change_signal (signalnum) /* If we don't have an argument, */
6054 int signalnum; /* some compilers complain in signal calls. */
6056 int width, height;
6057 #ifndef USE_CRT_DLL
6058 extern int errno;
6059 #endif
6060 int old_errno = errno;
6062 struct tty_display_info *tty;
6064 signal (SIGWINCH, window_change_signal);
6065 SIGNAL_THREAD_CHECK (signalnum);
6067 /* The frame size change obviously applies to a single
6068 termcap-controlled terminal, but we can't decide which.
6069 Therefore, we resize the frames corresponding to each tty.
6071 for (tty = tty_list; tty; tty = tty->next) {
6073 if (! tty->term_initted)
6074 continue;
6076 get_tty_size (fileno (tty->input), &width, &height);
6078 if (width > 5 && height > 2) {
6079 Lisp_Object tail, frame;
6081 FOR_EACH_FRAME (tail, frame)
6082 if (FRAME_TERMCAP_P (XFRAME (frame)) && FRAME_TTY (XFRAME (frame)) == tty)
6083 /* Record the new sizes, but don't reallocate the data
6084 structures now. Let that be done later outside of the
6085 signal handler. */
6086 change_frame_size (XFRAME (frame), height, width, 0, 1, 0);
6090 errno = old_errno;
6092 #endif /* SIGWINCH */
6095 /* Do any change in frame size that was requested by a signal. SAFE
6096 non-zero means this function is called from a place where it is
6097 safe to change frame sizes while a redisplay is in progress. */
6099 void
6100 do_pending_window_change (safe)
6101 int safe;
6103 /* If window_change_signal should have run before, run it now. */
6104 if (redisplaying_p && !safe)
6105 return;
6107 while (delayed_size_change)
6109 Lisp_Object tail, frame;
6111 delayed_size_change = 0;
6113 FOR_EACH_FRAME (tail, frame)
6115 struct frame *f = XFRAME (frame);
6117 if (f->new_text_lines != 0 || f->new_text_cols != 0)
6118 change_frame_size (f, f->new_text_lines, f->new_text_cols,
6119 0, 0, safe);
6125 /* Change the frame height and/or width. Values may be given as zero to
6126 indicate no change is to take place.
6128 If DELAY is non-zero, then assume we're being called from a signal
6129 handler, and queue the change for later - perhaps the next
6130 redisplay. Since this tries to resize windows, we can't call it
6131 from a signal handler.
6133 SAFE non-zero means this function is called from a place where it's
6134 safe to change frame sizes while a redisplay is in progress. */
6136 void
6137 change_frame_size (f, newheight, newwidth, pretend, delay, safe)
6138 register struct frame *f;
6139 int newheight, newwidth, pretend, delay, safe;
6141 Lisp_Object tail, frame;
6143 if (FRAME_MSDOS_P (f))
6145 /* On MS-DOS, all frames use the same screen, so a change in
6146 size affects all frames. Termcap now supports multiple
6147 ttys. */
6148 FOR_EACH_FRAME (tail, frame)
6149 if (! FRAME_WINDOW_P (XFRAME (frame)))
6150 change_frame_size_1 (XFRAME (frame), newheight, newwidth,
6151 pretend, delay, safe);
6153 else
6154 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe);
6157 static void
6158 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe)
6159 register struct frame *f;
6160 int newheight, newwidth, pretend, delay, safe;
6162 int new_frame_total_cols;
6163 int count = SPECPDL_INDEX ();
6165 /* If we can't deal with the change now, queue it for later. */
6166 if (delay || (redisplaying_p && !safe))
6168 f->new_text_lines = newheight;
6169 f->new_text_cols = newwidth;
6170 delayed_size_change = 1;
6171 return;
6174 /* This size-change overrides any pending one for this frame. */
6175 f->new_text_lines = 0;
6176 f->new_text_cols = 0;
6178 /* If an argument is zero, set it to the current value. */
6179 if (newheight == 0)
6180 newheight = FRAME_LINES (f);
6181 if (newwidth == 0)
6182 newwidth = FRAME_COLS (f);
6184 /* Compute width of windows in F.
6185 This is the width of the frame without vertical scroll bars. */
6186 new_frame_total_cols = FRAME_TOTAL_COLS_ARG (f, newwidth);
6188 /* Round up to the smallest acceptable size. */
6189 check_frame_size (f, &newheight, &newwidth);
6191 /* If we're not changing the frame size, quit now. */
6192 if (newheight == FRAME_LINES (f)
6193 && new_frame_total_cols == FRAME_TOTAL_COLS (f))
6194 return;
6196 BLOCK_INPUT;
6198 #ifdef MSDOS
6199 /* We only can set screen dimensions to certain values supported
6200 by our video hardware. Try to find the smallest size greater
6201 or equal to the requested dimensions. */
6202 dos_set_window_size (&newheight, &newwidth);
6203 #endif
6205 if (newheight != FRAME_LINES (f))
6207 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
6209 /* Frame has both root and mini-buffer. */
6210 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f))->top_line,
6211 FRAME_TOP_MARGIN (f));
6212 set_window_height (FRAME_ROOT_WINDOW (f),
6213 (newheight
6215 - FRAME_TOP_MARGIN (f)),
6217 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f))->top_line,
6218 newheight - 1);
6219 set_window_height (FRAME_MINIBUF_WINDOW (f), 1, 0);
6221 else
6222 /* Frame has just one top-level window. */
6223 set_window_height (FRAME_ROOT_WINDOW (f),
6224 newheight - FRAME_TOP_MARGIN (f), 0);
6226 if (FRAME_TERMCAP_P (f) && !pretend)
6227 FrameRows (FRAME_TTY (f)) = newheight;
6230 if (new_frame_total_cols != FRAME_TOTAL_COLS (f))
6232 set_window_width (FRAME_ROOT_WINDOW (f), new_frame_total_cols, 0);
6233 if (FRAME_HAS_MINIBUF_P (f))
6234 set_window_width (FRAME_MINIBUF_WINDOW (f), new_frame_total_cols, 0);
6236 if (FRAME_TERMCAP_P (f) && !pretend)
6237 FrameCols (FRAME_TTY (f)) = newwidth;
6239 if (WINDOWP (f->tool_bar_window))
6240 XSETFASTINT (XWINDOW (f->tool_bar_window)->total_cols, newwidth);
6243 FRAME_LINES (f) = newheight;
6244 SET_FRAME_COLS (f, newwidth);
6247 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
6248 int text_area_x, text_area_y, text_area_width, text_area_height;
6250 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
6251 &text_area_height);
6252 if (w->cursor.x >= text_area_x + text_area_width)
6253 w->cursor.hpos = w->cursor.x = 0;
6254 if (w->cursor.y >= text_area_y + text_area_height)
6255 w->cursor.vpos = w->cursor.y = 0;
6258 adjust_glyphs (f);
6259 calculate_costs (f);
6260 SET_FRAME_GARBAGED (f);
6261 f->resized_p = 1;
6263 UNBLOCK_INPUT;
6265 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
6267 /* This isn't quite a no-op: it runs window-configuration-change-hook. */
6268 Fset_window_buffer (FRAME_SELECTED_WINDOW (f),
6269 XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer, Qt);
6271 unbind_to (count, Qnil);
6276 /***********************************************************************
6277 Terminal Related Lisp Functions
6278 ***********************************************************************/
6280 DEFUN ("open-termscript", Fopen_termscript, Sopen_termscript,
6281 1, 1, "FOpen termscript file: ",
6282 doc: /* Start writing all terminal output to FILE as well as the terminal.
6283 FILE = nil means just close any termscript file currently open. */)
6284 (file)
6285 Lisp_Object file;
6287 struct tty_display_info *tty;
6289 if (! FRAME_TERMCAP_P (SELECTED_FRAME ()))
6290 error ("Current frame is not on a tty device");
6292 tty = CURTTY ();
6294 if (tty->termscript != 0)
6295 fclose (tty->termscript);
6296 tty->termscript = 0;
6298 if (! NILP (file))
6300 file = Fexpand_file_name (file, Qnil);
6301 tty->termscript = fopen (SDATA (file), "w");
6302 if (tty->termscript == 0)
6303 report_file_error ("Opening termscript", Fcons (file, Qnil));
6305 return Qnil;
6309 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal,
6310 Ssend_string_to_terminal, 1, 2, 0,
6311 doc: /* Send STRING to the terminal without alteration.
6312 Control characters in STRING will have terminal-dependent effects.
6314 Optional parameter TERMINAL specifies the tty terminal device to use.
6315 It may be a terminal id, a frame, or nil for the terminal used by the
6316 currently selected frame. */)
6317 (string, terminal)
6318 Lisp_Object string;
6319 Lisp_Object terminal;
6321 struct terminal *t = get_tty_terminal (terminal);
6322 struct tty_display_info *tty;
6324 /* ??? Perhaps we should do something special for multibyte strings here. */
6325 CHECK_STRING (string);
6327 if (!t)
6328 error ("Unknown terminal device");
6330 tty = t->display_info.tty;
6332 if (tty->termscript)
6334 fwrite (SDATA (string), 1, SBYTES (string), tty->termscript);
6335 fflush (tty->termscript);
6337 fwrite (SDATA (string), 1, SBYTES (string), tty->output);
6338 fflush (tty->output);
6339 return Qnil;
6343 DEFUN ("ding", Fding, Sding, 0, 1, 0,
6344 doc: /* Beep, or flash the screen.
6345 Also, unless an argument is given,
6346 terminate any keyboard macro currently executing. */)
6347 (arg)
6348 Lisp_Object arg;
6350 if (!NILP (arg))
6352 if (noninteractive)
6353 putchar (07);
6354 else
6355 ring_bell (XFRAME (selected_frame));
6357 else
6358 bitch_at_user ();
6360 return Qnil;
6363 void
6364 bitch_at_user ()
6366 if (noninteractive)
6367 putchar (07);
6368 else if (!INTERACTIVE) /* Stop executing a keyboard macro. */
6369 error ("Keyboard macro terminated by a command ringing the bell");
6370 else
6371 ring_bell (XFRAME (selected_frame));
6376 /***********************************************************************
6377 Sleeping, Waiting
6378 ***********************************************************************/
6380 DEFUN ("sleep-for", Fsleep_for, Ssleep_for, 1, 2, 0,
6381 doc: /* Pause, without updating display, for SECONDS seconds.
6382 SECONDS may be a floating-point value, meaning that you can wait for a
6383 fraction of a second. Optional second arg MILLISECONDS specifies an
6384 additional wait period, in milliseconds; this may be useful if your
6385 Emacs was built without floating point support.
6386 \(Not all operating systems support waiting for a fraction of a second.) */)
6387 (seconds, milliseconds)
6388 Lisp_Object seconds, milliseconds;
6390 int sec, usec;
6392 if (NILP (milliseconds))
6393 XSETINT (milliseconds, 0);
6394 else
6395 CHECK_NUMBER (milliseconds);
6396 usec = XINT (milliseconds) * 1000;
6399 double duration = extract_float (seconds);
6400 sec = (int) duration;
6401 usec += (duration - sec) * 1000000;
6404 #ifndef EMACS_HAS_USECS
6405 if (sec == 0 && usec != 0)
6406 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE);
6407 #endif
6409 /* Assure that 0 <= usec < 1000000. */
6410 if (usec < 0)
6412 /* We can't rely on the rounding being correct if usec is negative. */
6413 if (-1000000 < usec)
6414 sec--, usec += 1000000;
6415 else
6416 sec -= -usec / 1000000, usec = 1000000 - (-usec % 1000000);
6418 else
6419 sec += usec / 1000000, usec %= 1000000;
6421 if (sec < 0 || (sec == 0 && usec == 0))
6422 return Qnil;
6424 wait_reading_process_output (sec, usec, 0, 0, Qnil, NULL, 0);
6426 return Qnil;
6430 /* This is just like wait_reading_process_output, except that
6431 it does the redisplay.
6433 It's also much like Fsit_for, except that it can be used for
6434 waiting for input as well. */
6436 Lisp_Object
6437 sit_for (sec, usec, reading, display, initial_display)
6438 int sec, usec, reading, display, initial_display;
6440 swallow_events (display);
6442 if (detect_input_pending_run_timers (display) || !NILP (Vexecuting_kbd_macro))
6443 return Qnil;
6445 if (initial_display)
6446 redisplay_preserve_echo_area (2);
6448 if (sec == 0 && usec == 0)
6449 return Qt;
6451 #ifdef SIGIO
6452 gobble_input (0);
6453 #endif
6455 wait_reading_process_output (sec, usec, reading ? -1 : 1, display,
6456 Qnil, NULL, 0);
6458 return detect_input_pending () ? Qnil : Qt;
6462 DEFUN ("sit-for", Fsit_for, Ssit_for, 1, 3, 0,
6463 doc: /* Perform redisplay, then wait for SECONDS seconds or until input is available.
6464 SECONDS may be a floating-point value, meaning that you can wait for a
6465 fraction of a second.
6466 \(Not all operating systems support waiting for a fraction of a second.)
6467 Optional arg NODISP non-nil means don't redisplay, just wait for input.
6468 Redisplay is preempted as always if input arrives, and does not happen
6469 if input is available before it starts.
6470 Value is t if waited the full time with no input arriving.
6472 An obsolete but still supported form is
6473 \(sit-for SECONDS &optional MILLISECONDS NODISP)
6474 Where the optional arg MILLISECONDS specifies an additional wait period,
6475 in milliseconds; this was useful when Emacs was built without
6476 floating point support.
6477 usage: (sit-for SECONDS &optional NODISP OLD-NODISP) */)
6479 /* The `old-nodisp' stuff is there so that the arglist has the correct
6480 length. Otherwise, `defdvice' will redefine it with fewer args. */
6481 (seconds, milliseconds, nodisp)
6482 Lisp_Object seconds, milliseconds, nodisp;
6484 int sec, usec;
6486 if (NILP (nodisp) && !NUMBERP (milliseconds))
6487 { /* New style. */
6488 nodisp = milliseconds;
6489 milliseconds = Qnil;
6492 if (NILP (milliseconds))
6493 XSETINT (milliseconds, 0);
6494 else
6495 CHECK_NUMBER (milliseconds);
6496 usec = XINT (milliseconds) * 1000;
6499 double duration = extract_float (seconds);
6500 sec = (int) duration;
6501 usec += (duration - sec) * 1000000;
6504 #ifndef EMACS_HAS_USECS
6505 if (usec != 0 && sec == 0)
6506 error ("Millisecond `sit-for' not supported on %s", SYSTEM_TYPE);
6507 #endif
6509 return sit_for (sec, usec, 0, NILP (nodisp), NILP (nodisp));
6514 /***********************************************************************
6515 Other Lisp Functions
6516 ***********************************************************************/
6518 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6519 session's frames, frame names, buffers, buffer-read-only flags, and
6520 buffer-modified-flags. */
6522 static Lisp_Object frame_and_buffer_state;
6525 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p,
6526 Sframe_or_buffer_changed_p, 0, 1, 0,
6527 doc: /* Return non-nil if the frame and buffer state appears to have changed.
6528 VARIABLE is a variable name whose value is either nil or a state vector
6529 that will be updated to contain all frames and buffers,
6530 aside from buffers whose names start with space,
6531 along with the buffers' read-only and modified flags. This allows a fast
6532 check to see whether buffer menus might need to be recomputed.
6533 If this function returns non-nil, it updates the internal vector to reflect
6534 the current state.
6536 If VARIABLE is nil, an internal variable is used. Users should not
6537 pass nil for VARIABLE. */)
6538 (variable)
6539 Lisp_Object variable;
6541 Lisp_Object state, tail, frame, buf;
6542 Lisp_Object *vecp, *end;
6543 int n;
6545 if (! NILP (variable))
6547 CHECK_SYMBOL (variable);
6548 state = Fsymbol_value (variable);
6549 if (! VECTORP (state))
6550 goto changed;
6552 else
6553 state = frame_and_buffer_state;
6555 vecp = XVECTOR (state)->contents;
6556 end = vecp + XVECTOR (state)->size;
6558 FOR_EACH_FRAME (tail, frame)
6560 if (vecp == end)
6561 goto changed;
6562 if (!EQ (*vecp++, frame))
6563 goto changed;
6564 if (vecp == end)
6565 goto changed;
6566 if (!EQ (*vecp++, XFRAME (frame)->name))
6567 goto changed;
6569 /* Check that the buffer info matches. */
6570 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6572 buf = XCDR (XCAR (tail));
6573 /* Ignore buffers that aren't included in buffer lists. */
6574 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6575 continue;
6576 if (vecp == end)
6577 goto changed;
6578 if (!EQ (*vecp++, buf))
6579 goto changed;
6580 if (vecp == end)
6581 goto changed;
6582 if (!EQ (*vecp++, XBUFFER (buf)->read_only))
6583 goto changed;
6584 if (vecp == end)
6585 goto changed;
6586 if (!EQ (*vecp++, Fbuffer_modified_p (buf)))
6587 goto changed;
6589 if (vecp == end)
6590 goto changed;
6591 /* Detect deletion of a buffer at the end of the list. */
6592 if (EQ (*vecp, Qlambda))
6593 return Qnil;
6595 /* Come here if we decide the data has changed. */
6596 changed:
6597 /* Count the size we will need.
6598 Start with 1 so there is room for at least one lambda at the end. */
6599 n = 1;
6600 FOR_EACH_FRAME (tail, frame)
6601 n += 2;
6602 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6603 n += 3;
6604 /* Reallocate the vector if data has grown to need it,
6605 or if it has shrunk a lot. */
6606 if (! VECTORP (state)
6607 || n > XVECTOR (state)->size
6608 || n + 20 < XVECTOR (state)->size / 2)
6609 /* Add 20 extra so we grow it less often. */
6611 state = Fmake_vector (make_number (n + 20), Qlambda);
6612 if (! NILP (variable))
6613 Fset (variable, state);
6614 else
6615 frame_and_buffer_state = state;
6618 /* Record the new data in the (possibly reallocated) vector. */
6619 vecp = XVECTOR (state)->contents;
6620 FOR_EACH_FRAME (tail, frame)
6622 *vecp++ = frame;
6623 *vecp++ = XFRAME (frame)->name;
6625 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6627 buf = XCDR (XCAR (tail));
6628 /* Ignore buffers that aren't included in buffer lists. */
6629 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6630 continue;
6631 *vecp++ = buf;
6632 *vecp++ = XBUFFER (buf)->read_only;
6633 *vecp++ = Fbuffer_modified_p (buf);
6635 /* Fill up the vector with lambdas (always at least one). */
6636 *vecp++ = Qlambda;
6637 while (vecp - XVECTOR (state)->contents
6638 < XVECTOR (state)->size)
6639 *vecp++ = Qlambda;
6640 /* Make sure we didn't overflow the vector. */
6641 if (vecp - XVECTOR (state)->contents
6642 > XVECTOR (state)->size)
6643 abort ();
6644 return Qt;
6649 /***********************************************************************
6650 Initialization
6651 ***********************************************************************/
6653 /* Initialization done when Emacs fork is started, before doing stty.
6654 Determine terminal type and set terminal_driver. Then invoke its
6655 decoding routine to set up variables in the terminal package. */
6657 void
6658 init_display ()
6660 char *terminal_type;
6662 #ifdef HAVE_X_WINDOWS
6663 extern int display_arg;
6664 #endif
6666 /* Construct the space glyph. */
6667 space_glyph.type = CHAR_GLYPH;
6668 SET_CHAR_GLYPH_FROM_GLYPH (space_glyph, ' ');
6669 space_glyph.charpos = -1;
6671 inverse_video = 0;
6672 cursor_in_echo_area = 0;
6673 terminal_type = (char *) 0;
6675 /* Now is the time to initialize this; it's used by init_sys_modes
6676 during startup. */
6677 Vinitial_window_system = Qnil;
6679 /* SIGWINCH needs to be handled no matter what display we start
6680 with. Otherwise newly opened tty frames will not resize
6681 automatically. */
6682 #ifdef SIGWINCH
6683 #ifndef CANNOT_DUMP
6684 if (initialized)
6685 #endif /* CANNOT_DUMP */
6686 signal (SIGWINCH, window_change_signal);
6687 #endif /* SIGWINCH */
6689 /* If the user wants to use a window system, we shouldn't bother
6690 initializing the terminal. This is especially important when the
6691 terminal is so dumb that emacs gives up before and doesn't bother
6692 using the window system.
6694 If the DISPLAY environment variable is set and nonempty,
6695 try to use X, and die with an error message if that doesn't work. */
6697 #ifdef HAVE_X_WINDOWS
6698 if (! display_arg)
6700 char *display;
6701 #ifdef VMS
6702 display = getenv ("DECW$DISPLAY");
6703 #else
6704 display = getenv ("DISPLAY");
6705 #endif
6707 display_arg = (display != 0 && *display != 0);
6710 if (!inhibit_window_system && display_arg
6711 #ifndef CANNOT_DUMP
6712 && initialized
6713 #endif
6716 Vinitial_window_system = intern ("x");
6717 #ifdef HAVE_X11
6718 Vwindow_system_version = make_number (11);
6719 #else
6720 Vwindow_system_version = make_number (10);
6721 #endif
6722 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6723 /* In some versions of ncurses,
6724 tputs crashes if we have not called tgetent.
6725 So call tgetent. */
6726 { char b[2044]; tgetent (b, "xterm");}
6727 #endif
6728 adjust_frame_glyphs_initially ();
6729 return;
6731 #endif /* HAVE_X_WINDOWS */
6733 #ifdef HAVE_NTGUI
6734 if (!inhibit_window_system)
6736 Vinitial_window_system = intern ("w32");
6737 Vwindow_system_version = make_number (1);
6738 adjust_frame_glyphs_initially ();
6739 return;
6741 #endif /* HAVE_NTGUI */
6743 #ifdef MAC_OS
6744 if (!inhibit_window_system)
6746 Vinitial_window_system = intern ("mac");
6747 Vwindow_system_version = make_number (1);
6748 adjust_frame_glyphs_initially ();
6749 return;
6751 #endif /* MAC_OS */
6753 /* If no window system has been specified, try to use the terminal. */
6754 if (! isatty (0))
6756 fatal ("standard input is not a tty");
6757 exit (1);
6760 /* Look at the TERM variable. */
6761 terminal_type = (char *) getenv ("TERM");
6762 if (!terminal_type)
6764 #ifdef VMS
6765 fprintf (stderr, "Please specify your terminal type.\n\
6766 For types defined in VMS, use set term /device=TYPE.\n\
6767 For types not defined in VMS, use define emacs_term \"TYPE\".\n\
6768 \(The quotation marks are necessary since terminal types are lower case.)\n");
6769 #else
6770 fprintf (stderr, "Please set the environment variable TERM; see tset(1).\n");
6771 #endif
6772 exit (1);
6775 #ifdef VMS
6776 /* VMS DCL tends to up-case things, so down-case term type.
6777 Hardly any uppercase letters in terminal types; should be none. */
6779 char *new = (char *) xmalloc (strlen (terminal_type) + 1);
6780 char *p;
6782 strcpy (new, terminal_type);
6784 for (p = new; *p; p++)
6785 if (isupper (*p))
6786 *p = tolower (*p);
6788 terminal_type = new;
6790 #endif /* VMS */
6793 struct terminal *t;
6794 struct frame *f = XFRAME (selected_frame);
6796 /* Open a display on the controlling tty. */
6797 t = init_tty (0, terminal_type, 1); /* Errors are fatal. */
6799 /* Convert the initial frame to use the new display. */
6800 if (f->output_method != output_initial)
6801 abort ();
6802 f->output_method = t->type;
6803 f->terminal = t;
6805 t->reference_count++;
6806 t->display_info.tty->top_frame = selected_frame;
6807 change_frame_size (XFRAME (selected_frame),
6808 FrameRows (t->display_info.tty),
6809 FrameCols (t->display_info.tty), 0, 0, 1);
6811 /* Delete the initial terminal. */
6812 if (--initial_terminal->reference_count == 0
6813 && initial_terminal->delete_terminal_hook)
6814 (*initial_terminal->delete_terminal_hook) (initial_terminal);
6816 /* Update frame parameters to reflect the new type. */
6817 Fmodify_frame_parameters (selected_frame, Fcons (Fcons (Qwindow_system, Qnil), Qnil));
6818 Fmodify_frame_parameters
6819 (selected_frame, Fcons (Fcons (Qtty_type,
6820 Ftty_type (selected_frame)), Qnil));
6821 Fmodify_frame_parameters (selected_frame, Fcons (Fcons (Qtty, Qnil), Qnil));
6825 struct frame *sf = SELECTED_FRAME ();
6826 int width = FRAME_TOTAL_COLS (sf);
6827 int height = FRAME_LINES (sf);
6829 unsigned int total_glyphs = height * (width + 2) * sizeof (struct glyph);
6831 /* If these sizes are so big they cause overflow, just ignore the
6832 change. It's not clear what better we could do. */
6833 if (total_glyphs / sizeof (struct glyph) / height != width + 2)
6834 fatal ("screen size %dx%d too big", width, height);
6837 adjust_frame_glyphs_initially ();
6838 calculate_costs (XFRAME (selected_frame));
6840 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6841 if (initialized
6842 && !noninteractive
6843 #ifdef MSDOS
6844 /* The MSDOS terminal turns on its ``window system'' relatively
6845 late into the startup, so we cannot do the frame faces'
6846 initialization just yet. It will be done later by pc-win.el
6847 and internal_terminal_init. */
6848 && (strcmp (terminal_type, "internal") != 0 || inhibit_window_system)
6849 #endif
6850 && NILP (Vinitial_window_system))
6852 /* For the initial frame, we don't have any way of knowing what
6853 are the foreground and background colors of the terminal. */
6854 struct frame *sf = SELECTED_FRAME();
6856 FRAME_FOREGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_FG_COLOR;
6857 FRAME_BACKGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_BG_COLOR;
6858 call0 (intern ("tty-set-up-initial-frame-faces"));
6864 /***********************************************************************
6865 Blinking cursor
6866 ***********************************************************************/
6868 DEFUN ("internal-show-cursor", Finternal_show_cursor,
6869 Sinternal_show_cursor, 2, 2, 0,
6870 doc: /* Set the cursor-visibility flag of WINDOW to SHOW.
6871 WINDOW nil means use the selected window. SHOW non-nil means
6872 show a cursor in WINDOW in the next redisplay. SHOW nil means
6873 don't show a cursor. */)
6874 (window, show)
6875 Lisp_Object window, show;
6877 /* Don't change cursor state while redisplaying. This could confuse
6878 output routines. */
6879 if (!redisplaying_p)
6881 if (NILP (window))
6882 window = selected_window;
6883 else
6884 CHECK_WINDOW (window);
6886 XWINDOW (window)->cursor_off_p = NILP (show);
6889 return Qnil;
6893 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p,
6894 Sinternal_show_cursor_p, 0, 1, 0,
6895 doc: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6896 WINDOW nil or omitted means report on the selected window. */)
6897 (window)
6898 Lisp_Object window;
6900 struct window *w;
6902 if (NILP (window))
6903 window = selected_window;
6904 else
6905 CHECK_WINDOW (window);
6907 w = XWINDOW (window);
6908 return w->cursor_off_p ? Qnil : Qt;
6912 /***********************************************************************
6913 Initialization
6914 ***********************************************************************/
6916 void
6917 syms_of_display ()
6919 defsubr (&Sredraw_frame);
6920 defsubr (&Sredraw_display);
6921 defsubr (&Sframe_or_buffer_changed_p);
6922 defsubr (&Sopen_termscript);
6923 defsubr (&Sding);
6924 defsubr (&Ssit_for);
6925 defsubr (&Ssleep_for);
6926 defsubr (&Ssend_string_to_terminal);
6927 defsubr (&Sinternal_show_cursor);
6928 defsubr (&Sinternal_show_cursor_p);
6930 #if GLYPH_DEBUG
6931 defsubr (&Sdump_redisplay_history);
6932 #endif
6934 frame_and_buffer_state = Fmake_vector (make_number (20), Qlambda);
6935 staticpro (&frame_and_buffer_state);
6937 Qdisplay_table = intern ("display-table");
6938 staticpro (&Qdisplay_table);
6939 Qredisplay_dont_pause = intern ("redisplay-dont-pause");
6940 staticpro (&Qredisplay_dont_pause);
6942 DEFVAR_INT ("baud-rate", &baud_rate,
6943 doc: /* *The output baud rate of the terminal.
6944 On most systems, changing this value will affect the amount of padding
6945 and the other strategic decisions made during redisplay. */);
6947 DEFVAR_BOOL ("inverse-video", &inverse_video,
6948 doc: /* *Non-nil means invert the entire frame display.
6949 This means everything is in inverse video which otherwise would not be. */);
6951 DEFVAR_BOOL ("visible-bell", &visible_bell,
6952 doc: /* *Non-nil means try to flash the frame to represent a bell.
6954 See also `ring-bell-function'. */);
6956 DEFVAR_BOOL ("no-redraw-on-reenter", &no_redraw_on_reenter,
6957 doc: /* *Non-nil means no need to redraw entire frame after suspending.
6958 A non-nil value is useful if the terminal can automatically preserve
6959 Emacs's frame display when you reenter Emacs.
6960 It is up to you to set this variable if your terminal can do that. */);
6962 DEFVAR_LISP ("initial-window-system", &Vinitial_window_system,
6963 doc: /* Name of the window system that Emacs uses for the first frame.
6964 The value is a symbol--for instance, `x' for X windows.
6965 The value is nil if Emacs is using a text-only terminal. */);
6967 DEFVAR_LISP ("window-system-version", &Vwindow_system_version,
6968 doc: /* The version number of the window system in use.
6969 For X windows, this is 10 or 11. */);
6971 DEFVAR_BOOL ("cursor-in-echo-area", &cursor_in_echo_area,
6972 doc: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6974 DEFVAR_LISP ("glyph-table", &Vglyph_table,
6975 doc: /* Table defining how to output a glyph code to the frame.
6976 If not nil, this is a vector indexed by glyph code to define the glyph.
6977 Each element can be:
6978 integer: a glyph code which this glyph is an alias for.
6979 string: output this glyph using that string (not impl. in X windows).
6980 nil: this glyph mod 524288 is the code of a character to output,
6981 and this glyph / 524288 is the face number (see `face-id') to use
6982 while outputting it. */);
6983 Vglyph_table = Qnil;
6985 DEFVAR_LISP ("standard-display-table", &Vstandard_display_table,
6986 doc: /* Display table to use for buffers that specify none.
6987 See `buffer-display-table' for more information. */);
6988 Vstandard_display_table = Qnil;
6990 DEFVAR_BOOL ("redisplay-dont-pause", &redisplay_dont_pause,
6991 doc: /* *Non-nil means update isn't paused when input is detected. */);
6992 redisplay_dont_pause = 0;
6994 /* Initialize `window-system', unless init_display already decided it. */
6995 #ifdef CANNOT_DUMP
6996 if (noninteractive)
6997 #endif
6999 Vinitial_window_system = Qnil;
7000 Vwindow_system_version = Qnil;
7004 /* arch-tag: 8d812b1f-04a2-4195-a9c4-381f8457a413
7005 (do not change this comment) */