Backport Bug#9990 fix from trunk
[emacs.git] / src / dispnew.c
blobc116c3f7c47986cc422a008a4a3319843bc622dd
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, 2007, 2008, 2009, 2010, 2011 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 3 of the License, or
11 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <signal.h>
23 #include <stdio.h>
24 #include <ctype.h>
25 #include <setjmp.h>
27 #ifdef HAVE_UNISTD_H
28 #include <unistd.h>
29 #endif
31 #include "lisp.h"
32 #include "termchar.h"
33 #include "termopts.h"
34 /* cm.h must come after dispextern.h on Windows. */
35 #include "dispextern.h"
36 #include "cm.h"
37 #include "buffer.h"
38 #include "character.h"
39 #include "keyboard.h"
40 #include "frame.h"
41 #include "termhooks.h"
42 #include "window.h"
43 #include "commands.h"
44 #include "disptab.h"
45 #include "indent.h"
46 #include "intervals.h"
47 #include "blockinput.h"
48 #include "process.h"
50 /* I don't know why DEC Alpha OSF1 fail to compile this file if we
51 include the following file. */
52 /* #include "systty.h" */
53 #include "syssignal.h"
55 #ifdef HAVE_X_WINDOWS
56 #include "xterm.h"
57 #endif /* HAVE_X_WINDOWS */
59 #ifdef HAVE_NTGUI
60 #include "w32term.h"
61 #endif /* HAVE_NTGUI */
63 #ifdef HAVE_NS
64 #include "nsterm.h"
65 #endif
67 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
69 #include "systime.h"
70 #include <errno.h>
72 /* To get the prototype for `sleep'. */
74 #ifdef HAVE_UNISTD_H
75 #include <unistd.h>
76 #endif
78 /* Get number of chars of output now in the buffer of a stdio stream.
79 This ought to be built in in stdio, but it isn't. Some s- files
80 override this because their stdio internals differ. */
82 #ifdef __GNU_LIBRARY__
84 /* The s- file might have overridden the definition with one that
85 works for the system's C library. But we are using the GNU C
86 library, so this is the right definition for every system. */
88 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
89 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
90 #else
91 #undef PENDING_OUTPUT_COUNT
92 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
93 #endif
94 #else /* not __GNU_LIBRARY__ */
95 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
96 #include <stdio_ext.h>
97 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
98 #endif
99 #ifndef PENDING_OUTPUT_COUNT
100 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
101 #endif
102 #endif /* not __GNU_LIBRARY__ */
104 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
105 #include <term.h> /* for tgetent */
106 #endif
108 /* Structure to pass dimensions around. Used for character bounding
109 boxes, glyph matrix dimensions and alike. */
111 struct dim
113 int width;
114 int height;
118 /* Function prototypes. */
120 static struct glyph_matrix *save_current_matrix P_ ((struct frame *));
121 static void restore_current_matrix P_ ((struct frame *, struct glyph_matrix *));
122 static int showing_window_margins_p P_ ((struct window *));
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 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
196 are supported, so we can check for input during redisplay at
197 regular intervals. */
198 #ifdef EMACS_HAS_USECS
199 #define PERIODIC_PREEMPTION_CHECKING 1
200 #else
201 #define PERIODIC_PREEMPTION_CHECKING 0
202 #endif
204 #if PERIODIC_PREEMPTION_CHECKING
206 /* If a number (float), check for user input every N seconds. */
208 Lisp_Object Vredisplay_preemption_period;
210 /* Redisplay preemption timers. */
212 static EMACS_TIME preemption_period;
213 static EMACS_TIME preemption_next_check;
215 #endif
217 /* Nonzero upon entry to redisplay means do not assume anything about
218 current contents of actual terminal frame; clear and redraw it. */
220 int frame_garbaged;
222 /* Nonzero means last display completed. Zero means it was preempted. */
224 int display_completed;
226 /* Lisp variable visible-bell; enables use of screen-flash instead of
227 audible bell. */
229 int visible_bell;
231 /* Invert the color of the whole frame, at a low level. */
233 int inverse_video;
235 /* Line speed of the terminal. */
237 EMACS_INT baud_rate;
239 /* Either nil or a symbol naming the window system under which Emacs
240 creates the first frame. */
242 Lisp_Object Vinitial_window_system;
244 /* Version number of X windows: 10, 11 or nil. */
246 Lisp_Object Vwindow_system_version;
248 /* Vector of glyph definitions. Indexed by glyph number, the contents
249 are a string which is how to output the glyph.
251 If Vglyph_table is nil, a glyph is output by using its low 8 bits
252 as a character code.
254 This is an obsolete feature that is no longer used. The variable
255 is retained for compatibility. */
257 Lisp_Object Vglyph_table;
259 /* Display table to use for vectors that don't specify their own. */
261 Lisp_Object Vstandard_display_table;
263 /* Nonzero means reading single-character input with prompt so put
264 cursor on mini-buffer after the prompt. Positive means at end of
265 text in echo area; negative means at beginning of line. */
267 int cursor_in_echo_area;
269 Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
272 /* The currently selected frame. In a single-frame version, this
273 variable always equals the_only_frame. */
275 Lisp_Object selected_frame;
277 /* A frame which is not just a mini-buffer, or 0 if there are no such
278 frames. This is usually the most recent such frame that was
279 selected. In a single-frame version, this variable always holds
280 the address of the_only_frame. */
282 struct frame *last_nonminibuf_frame;
284 /* 1 means SIGWINCH happened when not safe. */
286 int delayed_size_change;
288 /* 1 means glyph initialization has been completed at startup. */
290 static int glyphs_initialized_initially_p;
292 /* Updated window if != 0. Set by update_window. */
294 struct window *updated_window;
296 /* Glyph row updated in update_window_line, and area that is updated. */
298 struct glyph_row *updated_row;
299 int updated_area;
301 /* A glyph for a space. */
303 struct glyph space_glyph;
305 /* Non-zero means update has been performed directly, so that there's
306 no need for redisplay_internal to do much work. Set by
307 direct_output_for_insert. */
309 int redisplay_performed_directly_p;
311 /* Counts of allocated structures. These counts serve to diagnose
312 memory leaks and double frees. */
314 int glyph_matrix_count;
315 int glyph_pool_count;
317 /* If non-null, the frame whose frame matrices are manipulated. If
318 null, window matrices are worked on. */
320 static struct frame *frame_matrix_frame;
322 /* Non-zero means that fonts have been loaded since the last glyph
323 matrix adjustments. Redisplay must stop, and glyph matrices must
324 be adjusted when this flag becomes non-zero during display. The
325 reason fonts can be loaded so late is that fonts of fontsets are
326 loaded on demand. Another reason is that a line contains many
327 characters displayed by zero width or very narrow glyphs of
328 variable-width fonts. */
330 int fonts_changed_p;
332 /* Convert vpos and hpos from frame to window and vice versa.
333 This may only be used for terminal frames. */
335 #if GLYPH_DEBUG
337 static int window_to_frame_vpos P_ ((struct window *, int));
338 static int window_to_frame_hpos P_ ((struct window *, int));
339 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
340 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
342 /* One element of the ring buffer containing redisplay history
343 information. */
345 struct redisplay_history
347 char trace[512 + 100];
350 /* The size of the history buffer. */
352 #define REDISPLAY_HISTORY_SIZE 30
354 /* The redisplay history buffer. */
356 static struct redisplay_history redisplay_history[REDISPLAY_HISTORY_SIZE];
358 /* Next free entry in redisplay_history. */
360 static int history_idx;
362 /* A tick that's incremented each time something is added to the
363 history. */
365 static unsigned history_tick;
367 static void add_frame_display_history P_ ((struct frame *, int));
368 static void add_window_display_history P_ ((struct window *, char *, int));
370 /* Add to the redisplay history how window W has been displayed.
371 MSG is a trace containing the information how W's glyph matrix
372 has been constructed. PAUSED_P non-zero means that the update
373 has been interrupted for pending input. */
375 static void
376 add_window_display_history (w, msg, paused_p)
377 struct window *w;
378 char *msg;
379 int paused_p;
381 char *buf;
383 if (history_idx >= REDISPLAY_HISTORY_SIZE)
384 history_idx = 0;
385 buf = redisplay_history[history_idx].trace;
386 ++history_idx;
388 sprintf (buf, "%d: window %p (`%s')%s\n",
389 history_tick++,
391 ((BUFFERP (w->buffer)
392 && STRINGP (XBUFFER (w->buffer)->name))
393 ? (char *) SDATA (XBUFFER (w->buffer)->name)
394 : "???"),
395 paused_p ? " ***paused***" : "");
396 strcat (buf, msg);
400 /* Add to the redisplay history that frame F has been displayed.
401 PAUSED_P non-zero means that the update has been interrupted for
402 pending input. */
404 static void
405 add_frame_display_history (f, paused_p)
406 struct frame *f;
407 int paused_p;
409 char *buf;
411 if (history_idx >= REDISPLAY_HISTORY_SIZE)
412 history_idx = 0;
413 buf = redisplay_history[history_idx].trace;
414 ++history_idx;
416 sprintf (buf, "%d: update frame %p%s",
417 history_tick++,
418 f, paused_p ? " ***paused***" : "");
422 DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
423 Sdump_redisplay_history, 0, 0, "",
424 doc: /* Dump redisplay history to stderr. */)
427 int i;
429 for (i = history_idx - 1; i != history_idx; --i)
431 if (i < 0)
432 i = REDISPLAY_HISTORY_SIZE - 1;
433 fprintf (stderr, "%s\n", redisplay_history[i].trace);
436 return Qnil;
440 #else /* GLYPH_DEBUG == 0 */
442 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
443 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
445 #endif /* GLYPH_DEBUG == 0 */
448 /* Like bcopy except never gets confused by overlap. Let this be the
449 first function defined in this file, or change emacs.c where the
450 address of this function is used. */
452 void
453 safe_bcopy (from, to, size)
454 const char *from;
455 char *to;
456 int size;
458 if (size <= 0 || from == to)
459 return;
461 /* If the source and destination don't overlap, then bcopy can
462 handle it. If they do overlap, but the destination is lower in
463 memory than the source, we'll assume bcopy can handle that. */
464 if (to < from || from + size <= to)
465 bcopy (from, to, size);
467 /* Otherwise, we'll copy from the end. */
468 else
470 register const char *endf = from + size;
471 register char *endt = to + size;
473 /* If TO - FROM is large, then we should break the copy into
474 nonoverlapping chunks of TO - FROM bytes each. However, if
475 TO - FROM is small, then the bcopy function call overhead
476 makes this not worth it. The crossover point could be about
477 anywhere. Since I don't think the obvious copy loop is too
478 bad, I'm trying to err in its favor. */
479 if (to - from < 64)
482 *--endt = *--endf;
483 while (endf != from);
485 else
487 for (;;)
489 endt -= (to - from);
490 endf -= (to - from);
492 if (endt < to)
493 break;
495 bcopy (endf, endt, to - from);
498 /* If SIZE wasn't a multiple of TO - FROM, there will be a
499 little left over. The amount left over is (endt + (to -
500 from)) - to, which is endt - from. */
501 bcopy (from, to, endt - from);
508 /***********************************************************************
509 Glyph Matrices
510 ***********************************************************************/
512 /* Allocate and return a glyph_matrix structure. POOL is the glyph
513 pool from which memory for the matrix should be allocated, or null
514 for window-based redisplay where no glyph pools are used. The
515 member `pool' of the glyph matrix structure returned is set to
516 POOL, the structure is otherwise zeroed. */
518 struct glyph_matrix *
519 new_glyph_matrix (pool)
520 struct glyph_pool *pool;
522 struct glyph_matrix *result;
524 /* Allocate and clear. */
525 result = (struct glyph_matrix *) xmalloc (sizeof *result);
526 bzero (result, sizeof *result);
528 /* Increment number of allocated matrices. This count is used
529 to detect memory leaks. */
530 ++glyph_matrix_count;
532 /* Set pool and return. */
533 result->pool = pool;
534 return result;
538 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
540 The global counter glyph_matrix_count is decremented when a matrix
541 is freed. If the count gets negative, more structures were freed
542 than allocated, i.e. one matrix was freed more than once or a bogus
543 pointer was passed to this function.
545 If MATRIX->pool is null, this means that the matrix manages its own
546 glyph memory---this is done for matrices on X frames. Freeing the
547 matrix also frees the glyph memory in this case. */
549 static void
550 free_glyph_matrix (matrix)
551 struct glyph_matrix *matrix;
553 if (matrix)
555 int i;
557 /* Detect the case that more matrices are freed than were
558 allocated. */
559 if (--glyph_matrix_count < 0)
560 abort ();
562 /* Free glyph memory if MATRIX owns it. */
563 if (matrix->pool == NULL)
564 for (i = 0; i < matrix->rows_allocated; ++i)
565 xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
567 /* Free row structures and the matrix itself. */
568 xfree (matrix->rows);
569 xfree (matrix);
574 /* Return the number of glyphs to reserve for a marginal area of
575 window W. TOTAL_GLYPHS is the number of glyphs in a complete
576 display line of window W. MARGIN gives the width of the marginal
577 area in canonical character units. MARGIN should be an integer
578 or a float. */
580 static int
581 margin_glyphs_to_reserve (w, total_glyphs, margin)
582 struct window *w;
583 int total_glyphs;
584 Lisp_Object margin;
586 int n;
588 if (NUMBERP (margin))
590 int width = XFASTINT (w->total_cols);
591 double d = max (0, XFLOATINT (margin));
592 d = min (width / 2 - 1, d);
593 n = (int) ((double) total_glyphs / width * d);
595 else
596 n = 0;
598 return n;
602 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
603 window sizes.
605 W is null if the function is called for a frame glyph matrix.
606 Otherwise it is the window MATRIX is a member of. X and Y are the
607 indices of the first column and row of MATRIX within the frame
608 matrix, if such a matrix exists. They are zero for purely
609 window-based redisplay. DIM is the needed size of the matrix.
611 In window-based redisplay, where no frame matrices exist, glyph
612 matrices manage their own glyph storage. Otherwise, they allocate
613 storage from a common frame glyph pool which can be found in
614 MATRIX->pool.
616 The reason for this memory management strategy is to avoid complete
617 frame redraws if possible. When we allocate from a common pool, a
618 change of the location or size of a sub-matrix within the pool
619 requires a complete redisplay of the frame because we cannot easily
620 make sure that the current matrices of all windows still agree with
621 what is displayed on the screen. While this is usually fast, it
622 leads to screen flickering. */
624 static void
625 adjust_glyph_matrix (w, matrix, x, y, dim)
626 struct window *w;
627 struct glyph_matrix *matrix;
628 int x, y;
629 struct dim dim;
631 int i;
632 int new_rows;
633 int marginal_areas_changed_p = 0;
634 int header_line_changed_p = 0;
635 int header_line_p = 0;
636 int left = -1, right = -1;
637 int window_width = -1, window_height = -1;
639 /* See if W had a header line that has disappeared now, or vice versa.
640 Get W's size. */
641 if (w)
643 window_box (w, -1, 0, 0, &window_width, &window_height);
645 header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
646 header_line_changed_p = header_line_p != matrix->header_line_p;
648 matrix->header_line_p = header_line_p;
650 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
651 Do nothing if MATRIX' size, position, vscroll, and marginal areas
652 haven't changed. This optimization is important because preserving
653 the matrix means preventing redisplay. */
654 if (matrix->pool == NULL)
656 left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
657 right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
658 xassert (left >= 0 && right >= 0);
659 marginal_areas_changed_p = (left != matrix->left_margin_glyphs
660 || right != matrix->right_margin_glyphs);
662 if (!marginal_areas_changed_p
663 && !fonts_changed_p
664 && !header_line_changed_p
665 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
666 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
667 && matrix->window_height == window_height
668 && matrix->window_vscroll == w->vscroll
669 && matrix->window_width == window_width)
670 return;
673 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
674 if (matrix->rows_allocated < dim.height)
676 int size = dim.height * sizeof (struct glyph_row);
677 new_rows = dim.height - matrix->rows_allocated;
678 matrix->rows = (struct glyph_row *) xrealloc (matrix->rows, size);
679 bzero (matrix->rows + matrix->rows_allocated,
680 new_rows * sizeof *matrix->rows);
681 matrix->rows_allocated = dim.height;
683 else
684 new_rows = 0;
686 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
687 on a frame not using window-based redisplay. Set up pointers for
688 each row into the glyph pool. */
689 if (matrix->pool)
691 xassert (matrix->pool->glyphs);
693 if (w)
695 left = margin_glyphs_to_reserve (w, dim.width,
696 w->left_margin_cols);
697 right = margin_glyphs_to_reserve (w, dim.width,
698 w->right_margin_cols);
700 else
701 left = right = 0;
703 for (i = 0; i < dim.height; ++i)
705 struct glyph_row *row = &matrix->rows[i];
707 row->glyphs[LEFT_MARGIN_AREA]
708 = (matrix->pool->glyphs
709 + (y + i) * matrix->pool->ncolumns
710 + x);
712 if (w == NULL
713 || row == matrix->rows + dim.height - 1
714 || (row == matrix->rows && matrix->header_line_p))
716 row->glyphs[TEXT_AREA]
717 = row->glyphs[LEFT_MARGIN_AREA];
718 row->glyphs[RIGHT_MARGIN_AREA]
719 = row->glyphs[TEXT_AREA] + dim.width;
720 row->glyphs[LAST_AREA]
721 = row->glyphs[RIGHT_MARGIN_AREA];
723 else
725 row->glyphs[TEXT_AREA]
726 = row->glyphs[LEFT_MARGIN_AREA] + left;
727 row->glyphs[RIGHT_MARGIN_AREA]
728 = row->glyphs[TEXT_AREA] + dim.width - left - right;
729 row->glyphs[LAST_AREA]
730 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
734 matrix->left_margin_glyphs = left;
735 matrix->right_margin_glyphs = right;
737 else
739 /* If MATRIX->pool is null, MATRIX is responsible for managing
740 its own memory. It is a window matrix for window-based redisplay.
741 Allocate glyph memory from the heap. */
742 if (dim.width > matrix->matrix_w
743 || new_rows
744 || header_line_changed_p
745 || marginal_areas_changed_p)
747 struct glyph_row *row = matrix->rows;
748 struct glyph_row *end = row + matrix->rows_allocated;
750 while (row < end)
752 row->glyphs[LEFT_MARGIN_AREA]
753 = (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
754 (dim.width
755 * sizeof (struct glyph)));
757 /* The mode line never has marginal areas. */
758 if (row == matrix->rows + dim.height - 1
759 || (row == matrix->rows && matrix->header_line_p))
761 row->glyphs[TEXT_AREA]
762 = row->glyphs[LEFT_MARGIN_AREA];
763 row->glyphs[RIGHT_MARGIN_AREA]
764 = row->glyphs[TEXT_AREA] + dim.width;
765 row->glyphs[LAST_AREA]
766 = row->glyphs[RIGHT_MARGIN_AREA];
768 else
770 row->glyphs[TEXT_AREA]
771 = row->glyphs[LEFT_MARGIN_AREA] + left;
772 row->glyphs[RIGHT_MARGIN_AREA]
773 = row->glyphs[TEXT_AREA] + dim.width - left - right;
774 row->glyphs[LAST_AREA]
775 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
777 ++row;
781 xassert (left >= 0 && right >= 0);
782 matrix->left_margin_glyphs = left;
783 matrix->right_margin_glyphs = right;
786 /* Number of rows to be used by MATRIX. */
787 matrix->nrows = dim.height;
788 xassert (matrix->nrows >= 0);
790 if (w)
792 if (matrix == w->current_matrix)
794 /* Mark rows in a current matrix of a window as not having
795 valid contents. It's important to not do this for
796 desired matrices. When Emacs starts, it may already be
797 building desired matrices when this function runs. */
798 if (window_width < 0)
799 window_width = window_box_width (w, -1);
801 /* Optimize the case that only the height has changed (C-x 2,
802 upper window). Invalidate all rows that are no longer part
803 of the window. */
804 if (!marginal_areas_changed_p
805 && !header_line_changed_p
806 && new_rows == 0
807 && dim.width == matrix->matrix_w
808 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
809 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
810 && matrix->window_width == window_width)
812 /* Find the last row in the window. */
813 for (i = 0; i < matrix->nrows && matrix->rows[i].enabled_p; ++i)
814 if (MATRIX_ROW_BOTTOM_Y (matrix->rows + i) >= window_height)
816 ++i;
817 break;
820 /* Window end is invalid, if inside of the rows that
821 are invalidated below. */
822 if (INTEGERP (w->window_end_vpos)
823 && XFASTINT (w->window_end_vpos) >= i)
824 w->window_end_valid = Qnil;
826 while (i < matrix->nrows)
827 matrix->rows[i++].enabled_p = 0;
829 else
831 for (i = 0; i < matrix->nrows; ++i)
832 matrix->rows[i].enabled_p = 0;
835 else if (matrix == w->desired_matrix)
837 /* Rows in desired matrices always have to be cleared;
838 redisplay expects this is the case when it runs, so it
839 had better be the case when we adjust matrices between
840 redisplays. */
841 for (i = 0; i < matrix->nrows; ++i)
842 matrix->rows[i].enabled_p = 0;
847 /* Remember last values to be able to optimize frame redraws. */
848 matrix->matrix_x = x;
849 matrix->matrix_y = y;
850 matrix->matrix_w = dim.width;
851 matrix->matrix_h = dim.height;
853 /* Record the top y location and height of W at the time the matrix
854 was last adjusted. This is used to optimize redisplay above. */
855 if (w)
857 matrix->window_left_col = WINDOW_LEFT_EDGE_COL (w);
858 matrix->window_top_line = WINDOW_TOP_EDGE_LINE (w);
859 matrix->window_height = window_height;
860 matrix->window_width = window_width;
861 matrix->window_vscroll = w->vscroll;
866 /* Reverse the contents of rows in MATRIX between START and END. The
867 contents of the row at END - 1 end up at START, END - 2 at START +
868 1 etc. This is part of the implementation of rotate_matrix (see
869 below). */
871 static void
872 reverse_rows (matrix, start, end)
873 struct glyph_matrix *matrix;
874 int start, end;
876 int i, j;
878 for (i = start, j = end - 1; i < j; ++i, --j)
880 /* Non-ISO HP/UX compiler doesn't like auto struct
881 initialization. */
882 struct glyph_row temp;
883 temp = matrix->rows[i];
884 matrix->rows[i] = matrix->rows[j];
885 matrix->rows[j] = temp;
890 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
891 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
892 indices. (Note: this does not copy glyphs, only glyph pointers in
893 row structures are moved around).
895 The algorithm used for rotating the vector was, I believe, first
896 described by Kernighan. See the vector R as consisting of two
897 sub-vectors AB, where A has length BY for BY >= 0. The result
898 after rotating is then BA. Reverse both sub-vectors to get ArBr
899 and reverse the result to get (ArBr)r which is BA. Similar for
900 rotating right. */
902 void
903 rotate_matrix (matrix, first, last, by)
904 struct glyph_matrix *matrix;
905 int first, last, by;
907 if (by < 0)
909 /* Up (rotate left, i.e. towards lower indices). */
910 by = -by;
911 reverse_rows (matrix, first, first + by);
912 reverse_rows (matrix, first + by, last);
913 reverse_rows (matrix, first, last);
915 else if (by > 0)
917 /* Down (rotate right, i.e. towards higher indices). */
918 reverse_rows (matrix, last - by, last);
919 reverse_rows (matrix, first, last - by);
920 reverse_rows (matrix, first, last);
925 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
926 with indices START <= index < END. Increment positions by DELTA/
927 DELTA_BYTES. */
929 void
930 increment_matrix_positions (matrix, start, end, delta, delta_bytes)
931 struct glyph_matrix *matrix;
932 int start, end, delta, delta_bytes;
934 /* Check that START and END are reasonable values. */
935 xassert (start >= 0 && start <= matrix->nrows);
936 xassert (end >= 0 && end <= matrix->nrows);
937 xassert (start <= end);
939 for (; start < end; ++start)
940 increment_row_positions (matrix->rows + start, delta, delta_bytes);
944 /* Enable a range of rows in glyph matrix MATRIX. START and END are
945 the row indices of the first and last + 1 row to enable. If
946 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
948 void
949 enable_glyph_matrix_rows (matrix, start, end, enabled_p)
950 struct glyph_matrix *matrix;
951 int start, end;
952 int enabled_p;
954 xassert (start <= end);
955 xassert (start >= 0 && start < matrix->nrows);
956 xassert (end >= 0 && end <= matrix->nrows);
958 for (; start < end; ++start)
959 matrix->rows[start].enabled_p = enabled_p != 0;
963 /* Clear MATRIX.
965 This empties all rows in MATRIX by setting the enabled_p flag for
966 all rows of the matrix to zero. The function prepare_desired_row
967 will eventually really clear a row when it sees one with a zero
968 enabled_p flag.
970 Resets update hints to defaults value. The only update hint
971 currently present is the flag MATRIX->no_scrolling_p. */
973 void
974 clear_glyph_matrix (matrix)
975 struct glyph_matrix *matrix;
977 if (matrix)
979 enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
980 matrix->no_scrolling_p = 0;
985 /* Shift part of the glyph matrix MATRIX of window W up or down.
986 Increment y-positions in glyph rows between START and END by DY,
987 and recompute their visible height. */
989 void
990 shift_glyph_matrix (w, matrix, start, end, dy)
991 struct window *w;
992 struct glyph_matrix *matrix;
993 int start, end, dy;
995 int min_y, max_y;
997 xassert (start <= end);
998 xassert (start >= 0 && start < matrix->nrows);
999 xassert (end >= 0 && end <= matrix->nrows);
1001 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1002 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1004 for (; start < end; ++start)
1006 struct glyph_row *row = &matrix->rows[start];
1008 row->y += dy;
1009 row->visible_height = row->height;
1011 if (row->y < min_y)
1012 row->visible_height -= min_y - row->y;
1013 if (row->y + row->height > max_y)
1014 row->visible_height -= row->y + row->height - max_y;
1015 if (row->fringe_bitmap_periodic_p)
1016 row->redraw_fringe_bitmaps_p = 1;
1021 /* Mark all rows in current matrices of frame F as invalid. Marking
1022 invalid is done by setting enabled_p to zero for all rows in a
1023 current matrix. */
1025 void
1026 clear_current_matrices (f)
1027 register struct frame *f;
1029 /* Clear frame current matrix, if we have one. */
1030 if (f->current_matrix)
1031 clear_glyph_matrix (f->current_matrix);
1033 /* Clear the matrix of the menu bar window, if such a window exists.
1034 The menu bar window is currently used to display menus on X when
1035 no toolkit support is compiled in. */
1036 if (WINDOWP (f->menu_bar_window))
1037 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1039 /* Clear the matrix of the tool-bar window, if any. */
1040 if (WINDOWP (f->tool_bar_window))
1041 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1043 /* Clear current window matrices. */
1044 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1045 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
1049 /* Clear out all display lines of F for a coming redisplay. */
1051 void
1052 clear_desired_matrices (f)
1053 register struct frame *f;
1055 if (f->desired_matrix)
1056 clear_glyph_matrix (f->desired_matrix);
1058 if (WINDOWP (f->menu_bar_window))
1059 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
1061 if (WINDOWP (f->tool_bar_window))
1062 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
1064 /* Do it for window matrices. */
1065 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1066 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
1070 /* Clear matrices in window tree rooted in W. If DESIRED_P is
1071 non-zero clear desired matrices, otherwise clear current matrices. */
1073 static void
1074 clear_window_matrices (w, desired_p)
1075 struct window *w;
1076 int desired_p;
1078 while (w)
1080 if (!NILP (w->hchild))
1082 xassert (WINDOWP (w->hchild));
1083 clear_window_matrices (XWINDOW (w->hchild), desired_p);
1085 else if (!NILP (w->vchild))
1087 xassert (WINDOWP (w->vchild));
1088 clear_window_matrices (XWINDOW (w->vchild), desired_p);
1090 else
1092 if (desired_p)
1093 clear_glyph_matrix (w->desired_matrix);
1094 else
1096 clear_glyph_matrix (w->current_matrix);
1097 w->window_end_valid = Qnil;
1101 w = NILP (w->next) ? 0 : XWINDOW (w->next);
1107 /***********************************************************************
1108 Glyph Rows
1110 See dispextern.h for an overall explanation of glyph rows.
1111 ***********************************************************************/
1113 /* Clear glyph row ROW. Do it in a way that makes it robust against
1114 changes in the glyph_row structure, i.e. addition or removal of
1115 structure members. */
1117 static struct glyph_row null_row;
1119 void
1120 clear_glyph_row (row)
1121 struct glyph_row *row;
1123 struct glyph *p[1 + LAST_AREA];
1125 /* Save pointers. */
1126 p[LEFT_MARGIN_AREA] = row->glyphs[LEFT_MARGIN_AREA];
1127 p[TEXT_AREA] = row->glyphs[TEXT_AREA];
1128 p[RIGHT_MARGIN_AREA] = row->glyphs[RIGHT_MARGIN_AREA];
1129 p[LAST_AREA] = row->glyphs[LAST_AREA];
1131 /* Clear. */
1132 *row = null_row;
1134 /* Restore pointers. */
1135 row->glyphs[LEFT_MARGIN_AREA] = p[LEFT_MARGIN_AREA];
1136 row->glyphs[TEXT_AREA] = p[TEXT_AREA];
1137 row->glyphs[RIGHT_MARGIN_AREA] = p[RIGHT_MARGIN_AREA];
1138 row->glyphs[LAST_AREA] = p[LAST_AREA];
1140 #if 0 /* At some point, some bit-fields of struct glyph were not set,
1141 which made glyphs unequal when compared with GLYPH_EQUAL_P.
1142 Redisplay outputs such glyphs, and flickering effects were
1143 the result. This also depended on the contents of memory
1144 returned by xmalloc. If flickering happens again, activate
1145 the code below. If the flickering is gone with that, chances
1146 are that the flickering has the same reason as here. */
1147 bzero (p[0], (char *) p[LAST_AREA] - (char *) p[0]);
1148 #endif
1152 /* Make ROW an empty, enabled row of canonical character height,
1153 in window W starting at y-position Y. */
1155 void
1156 blank_row (w, row, y)
1157 struct window *w;
1158 struct glyph_row *row;
1159 int y;
1161 int min_y, max_y;
1163 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1164 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1166 clear_glyph_row (row);
1167 row->y = y;
1168 row->ascent = row->phys_ascent = 0;
1169 row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
1170 row->visible_height = row->height;
1172 if (row->y < min_y)
1173 row->visible_height -= min_y - row->y;
1174 if (row->y + row->height > max_y)
1175 row->visible_height -= row->y + row->height - max_y;
1177 row->enabled_p = 1;
1181 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1182 are the amounts by which to change positions. Note that the first
1183 glyph of the text area of a row can have a buffer position even if
1184 the used count of the text area is zero. Such rows display line
1185 ends. */
1187 void
1188 increment_row_positions (row, delta, delta_bytes)
1189 struct glyph_row *row;
1190 int delta, delta_bytes;
1192 int area, i;
1194 /* Increment start and end positions. */
1195 MATRIX_ROW_START_CHARPOS (row) += delta;
1196 MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
1197 MATRIX_ROW_END_CHARPOS (row) += delta;
1198 MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
1200 if (!row->enabled_p)
1201 return;
1203 /* Increment positions in glyphs. */
1204 for (area = 0; area < LAST_AREA; ++area)
1205 for (i = 0; i < row->used[area]; ++i)
1206 if (BUFFERP (row->glyphs[area][i].object)
1207 && row->glyphs[area][i].charpos > 0)
1208 row->glyphs[area][i].charpos += delta;
1210 /* Capture the case of rows displaying a line end. */
1211 if (row->used[TEXT_AREA] == 0
1212 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
1213 row->glyphs[TEXT_AREA]->charpos += delta;
1217 #if 0
1218 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1219 contents, i.e. glyph structure contents are exchanged between A and
1220 B without changing glyph pointers in A and B. */
1222 static void
1223 swap_glyphs_in_rows (a, b)
1224 struct glyph_row *a, *b;
1226 int area;
1228 for (area = 0; area < LAST_AREA; ++area)
1230 /* Number of glyphs to swap. */
1231 int max_used = max (a->used[area], b->used[area]);
1233 /* Start of glyphs in area of row A. */
1234 struct glyph *glyph_a = a->glyphs[area];
1236 /* End + 1 of glyphs in area of row A. */
1237 struct glyph *glyph_a_end = a->glyphs[max_used];
1239 /* Start of glyphs in area of row B. */
1240 struct glyph *glyph_b = b->glyphs[area];
1242 while (glyph_a < glyph_a_end)
1244 /* Non-ISO HP/UX compiler doesn't like auto struct
1245 initialization. */
1246 struct glyph temp;
1247 temp = *glyph_a;
1248 *glyph_a = *glyph_b;
1249 *glyph_b = temp;
1250 ++glyph_a;
1251 ++glyph_b;
1256 #endif /* 0 */
1258 /* Exchange pointers to glyph memory between glyph rows A and B. */
1260 static INLINE void
1261 swap_glyph_pointers (a, b)
1262 struct glyph_row *a, *b;
1264 int i;
1265 for (i = 0; i < LAST_AREA + 1; ++i)
1267 struct glyph *temp = a->glyphs[i];
1268 a->glyphs[i] = b->glyphs[i];
1269 b->glyphs[i] = temp;
1274 /* Copy glyph row structure FROM to glyph row structure TO, except
1275 that glyph pointers in the structures are left unchanged. */
1277 INLINE void
1278 copy_row_except_pointers (to, from)
1279 struct glyph_row *to, *from;
1281 struct glyph *pointers[1 + LAST_AREA];
1283 /* Save glyph pointers of TO. */
1284 bcopy (to->glyphs, pointers, sizeof to->glyphs);
1286 /* Do a structure assignment. */
1287 *to = *from;
1289 /* Restore original pointers of TO. */
1290 bcopy (pointers, to->glyphs, sizeof to->glyphs);
1294 /* Copy contents of glyph row FROM to glyph row TO. Glyph pointers in
1295 TO and FROM are left unchanged. Glyph contents are copied from the
1296 glyph memory of FROM to the glyph memory of TO. Increment buffer
1297 positions in row TO by DELTA/ DELTA_BYTES. */
1299 void
1300 copy_glyph_row_contents (to, from, delta, delta_bytes)
1301 struct glyph_row *to, *from;
1302 int delta, delta_bytes;
1304 int area;
1306 /* This is like a structure assignment TO = FROM, except that
1307 glyph pointers in the rows are left unchanged. */
1308 copy_row_except_pointers (to, from);
1310 /* Copy glyphs from FROM to TO. */
1311 for (area = 0; area < LAST_AREA; ++area)
1312 if (from->used[area])
1313 bcopy (from->glyphs[area], to->glyphs[area],
1314 from->used[area] * sizeof (struct glyph));
1316 /* Increment buffer positions in TO by DELTA. */
1317 increment_row_positions (to, delta, delta_bytes);
1321 /* Assign glyph row FROM to glyph row TO. This works like a structure
1322 assignment TO = FROM, except that glyph pointers are not copied but
1323 exchanged between TO and FROM. Pointers must be exchanged to avoid
1324 a memory leak. */
1326 static INLINE void
1327 assign_row (to, from)
1328 struct glyph_row *to, *from;
1330 swap_glyph_pointers (to, from);
1331 copy_row_except_pointers (to, from);
1335 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1336 a row in a window matrix, is a slice of the glyph memory of the
1337 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1338 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1339 memory of FRAME_ROW. */
1341 #if GLYPH_DEBUG
1343 static int
1344 glyph_row_slice_p (window_row, frame_row)
1345 struct glyph_row *window_row, *frame_row;
1347 struct glyph *window_glyph_start = window_row->glyphs[0];
1348 struct glyph *frame_glyph_start = frame_row->glyphs[0];
1349 struct glyph *frame_glyph_end = frame_row->glyphs[LAST_AREA];
1351 return (frame_glyph_start <= window_glyph_start
1352 && window_glyph_start < frame_glyph_end);
1355 #endif /* GLYPH_DEBUG */
1357 #if 0
1359 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1360 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1361 in WINDOW_MATRIX is found satisfying the condition. */
1363 static struct glyph_row *
1364 find_glyph_row_slice (window_matrix, frame_matrix, row)
1365 struct glyph_matrix *window_matrix, *frame_matrix;
1366 int row;
1368 int i;
1370 xassert (row >= 0 && row < frame_matrix->nrows);
1372 for (i = 0; i < window_matrix->nrows; ++i)
1373 if (glyph_row_slice_p (window_matrix->rows + i,
1374 frame_matrix->rows + row))
1375 break;
1377 return i < window_matrix->nrows ? window_matrix->rows + i : 0;
1380 #endif /* 0 */
1382 /* Prepare ROW for display. Desired rows are cleared lazily,
1383 i.e. they are only marked as to be cleared by setting their
1384 enabled_p flag to zero. When a row is to be displayed, a prior
1385 call to this function really clears it. */
1387 void
1388 prepare_desired_row (row)
1389 struct glyph_row *row;
1391 if (!row->enabled_p)
1393 clear_glyph_row (row);
1394 row->enabled_p = 1;
1399 /* Return a hash code for glyph row ROW. */
1402 line_hash_code (row)
1403 struct glyph_row *row;
1405 int hash = 0;
1407 if (row->enabled_p)
1409 struct glyph *glyph = row->glyphs[TEXT_AREA];
1410 struct glyph *end = glyph + row->used[TEXT_AREA];
1412 while (glyph < end)
1414 int c = glyph->u.ch;
1415 int face_id = glyph->face_id;
1416 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1417 c -= SPACEGLYPH;
1418 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + c;
1419 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + face_id;
1420 ++glyph;
1423 if (hash == 0)
1424 hash = 1;
1427 return hash;
1431 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1432 the number of characters in the line. If must_write_spaces is
1433 zero, leading and trailing spaces are ignored. */
1435 static unsigned int
1436 line_draw_cost (matrix, vpos)
1437 struct glyph_matrix *matrix;
1438 int vpos;
1440 struct glyph_row *row = matrix->rows + vpos;
1441 struct glyph *beg = row->glyphs[TEXT_AREA];
1442 struct glyph *end = beg + row->used[TEXT_AREA];
1443 int len;
1444 Lisp_Object *glyph_table_base = GLYPH_TABLE_BASE;
1445 int glyph_table_len = GLYPH_TABLE_LENGTH;
1447 /* Ignore trailing and leading spaces if we can. */
1448 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1450 /* Skip from the end over trailing spaces. */
1451 while (end > beg && CHAR_GLYPH_SPACE_P (*(end - 1)))
1452 --end;
1454 /* All blank line. */
1455 if (end == beg)
1456 return 0;
1458 /* Skip over leading spaces. */
1459 while (CHAR_GLYPH_SPACE_P (*beg))
1460 ++beg;
1463 /* If we don't have a glyph-table, each glyph is one character,
1464 so return the number of glyphs. */
1465 if (glyph_table_base == 0)
1466 len = end - beg;
1467 else
1469 /* Otherwise, scan the glyphs and accumulate their total length
1470 in LEN. */
1471 len = 0;
1472 while (beg < end)
1474 GLYPH g;
1476 SET_GLYPH_FROM_CHAR_GLYPH (g, *beg);
1478 if (GLYPH_INVALID_P (g)
1479 || GLYPH_SIMPLE_P (glyph_table_base, glyph_table_len, g))
1480 len += 1;
1481 else
1482 len += GLYPH_LENGTH (glyph_table_base, g);
1484 ++beg;
1488 return len;
1492 /* Test two glyph rows A and B for equality. Value is non-zero if A
1493 and B have equal contents. W is the window to which the glyphs
1494 rows A and B belong. It is needed here to test for partial row
1495 visibility. MOUSE_FACE_P non-zero means compare the mouse_face_p
1496 flags of A and B, too. */
1498 static INLINE int
1499 row_equal_p (w, a, b, mouse_face_p)
1500 struct window *w;
1501 struct glyph_row *a, *b;
1502 int mouse_face_p;
1504 if (a == b)
1505 return 1;
1506 else if (a->hash != b->hash)
1507 return 0;
1508 else
1510 struct glyph *a_glyph, *b_glyph, *a_end;
1511 int area;
1513 if (mouse_face_p && a->mouse_face_p != b->mouse_face_p)
1514 return 0;
1516 /* Compare glyphs. */
1517 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
1519 if (a->used[area] != b->used[area])
1520 return 0;
1522 a_glyph = a->glyphs[area];
1523 a_end = a_glyph + a->used[area];
1524 b_glyph = b->glyphs[area];
1526 while (a_glyph < a_end
1527 && GLYPH_EQUAL_P (a_glyph, b_glyph))
1528 ++a_glyph, ++b_glyph;
1530 if (a_glyph != a_end)
1531 return 0;
1534 if (a->fill_line_p != b->fill_line_p
1535 || a->cursor_in_fringe_p != b->cursor_in_fringe_p
1536 || a->left_fringe_bitmap != b->left_fringe_bitmap
1537 || a->left_fringe_face_id != b->left_fringe_face_id
1538 || a->left_fringe_offset != b->left_fringe_offset
1539 || a->right_fringe_bitmap != b->right_fringe_bitmap
1540 || a->right_fringe_face_id != b->right_fringe_face_id
1541 || a->right_fringe_offset != b->right_fringe_offset
1542 || a->fringe_bitmap_periodic_p != b->fringe_bitmap_periodic_p
1543 || a->overlay_arrow_bitmap != b->overlay_arrow_bitmap
1544 || a->exact_window_width_line_p != b->exact_window_width_line_p
1545 || a->overlapped_p != b->overlapped_p
1546 || (MATRIX_ROW_CONTINUATION_LINE_P (a)
1547 != MATRIX_ROW_CONTINUATION_LINE_P (b))
1548 /* Different partially visible characters on left margin. */
1549 || a->x != b->x
1550 /* Different height. */
1551 || a->ascent != b->ascent
1552 || a->phys_ascent != b->phys_ascent
1553 || a->phys_height != b->phys_height
1554 || a->visible_height != b->visible_height)
1555 return 0;
1558 return 1;
1563 /***********************************************************************
1564 Glyph Pool
1566 See dispextern.h for an overall explanation of glyph pools.
1567 ***********************************************************************/
1569 /* Allocate a glyph_pool structure. The structure returned is
1570 initialized with zeros. The global variable glyph_pool_count is
1571 incremented for each pool allocated. */
1573 static struct glyph_pool *
1574 new_glyph_pool ()
1576 struct glyph_pool *result;
1578 /* Allocate a new glyph_pool and clear it. */
1579 result = (struct glyph_pool *) xmalloc (sizeof *result);
1580 bzero (result, sizeof *result);
1582 /* For memory leak and double deletion checking. */
1583 ++glyph_pool_count;
1585 return result;
1589 /* Free a glyph_pool structure POOL. The function may be called with
1590 a null POOL pointer. The global variable glyph_pool_count is
1591 decremented with every pool structure freed. If this count gets
1592 negative, more structures were freed than allocated, i.e. one
1593 structure must have been freed more than once or a bogus pointer
1594 was passed to free_glyph_pool. */
1596 static void
1597 free_glyph_pool (pool)
1598 struct glyph_pool *pool;
1600 if (pool)
1602 /* More freed than allocated? */
1603 --glyph_pool_count;
1604 xassert (glyph_pool_count >= 0);
1606 xfree (pool->glyphs);
1607 xfree (pool);
1612 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1613 columns we need. This function never shrinks a pool. The only
1614 case in which this would make sense, would be when a frame's size
1615 is changed from a large value to a smaller one. But, if someone
1616 does it once, we can expect that he will do it again.
1618 Value is non-zero if the pool changed in a way which makes
1619 re-adjusting window glyph matrices necessary. */
1621 static int
1622 realloc_glyph_pool (pool, matrix_dim)
1623 struct glyph_pool *pool;
1624 struct dim matrix_dim;
1626 int needed;
1627 int changed_p;
1629 changed_p = (pool->glyphs == 0
1630 || matrix_dim.height != pool->nrows
1631 || matrix_dim.width != pool->ncolumns);
1633 /* Enlarge the glyph pool. */
1634 needed = matrix_dim.width * matrix_dim.height;
1635 if (needed > pool->nglyphs)
1637 int size = needed * sizeof (struct glyph);
1639 if (pool->glyphs)
1640 pool->glyphs = (struct glyph *) xrealloc (pool->glyphs, size);
1641 else
1643 pool->glyphs = (struct glyph *) xmalloc (size);
1644 bzero (pool->glyphs, size);
1647 pool->nglyphs = needed;
1650 /* Remember the number of rows and columns because (a) we use them
1651 to do sanity checks, and (b) the number of columns determines
1652 where rows in the frame matrix start---this must be available to
1653 determine pointers to rows of window sub-matrices. */
1654 pool->nrows = matrix_dim.height;
1655 pool->ncolumns = matrix_dim.width;
1657 return changed_p;
1662 /***********************************************************************
1663 Debug Code
1664 ***********************************************************************/
1666 #if GLYPH_DEBUG
1669 /* Flush standard output. This is sometimes useful to call from the debugger.
1670 XXX Maybe this should be changed to flush the current terminal instead of
1671 stdout.
1674 void
1675 flush_stdout ()
1677 fflush (stdout);
1681 /* Check that no glyph pointers have been lost in MATRIX. If a
1682 pointer has been lost, e.g. by using a structure assignment between
1683 rows, at least one pointer must occur more than once in the rows of
1684 MATRIX. */
1686 void
1687 check_matrix_pointer_lossage (matrix)
1688 struct glyph_matrix *matrix;
1690 int i, j;
1692 for (i = 0; i < matrix->nrows; ++i)
1693 for (j = 0; j < matrix->nrows; ++j)
1694 xassert (i == j
1695 || (matrix->rows[i].glyphs[TEXT_AREA]
1696 != matrix->rows[j].glyphs[TEXT_AREA]));
1700 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1702 struct glyph_row *
1703 matrix_row (matrix, row)
1704 struct glyph_matrix *matrix;
1705 int row;
1707 xassert (matrix && matrix->rows);
1708 xassert (row >= 0 && row < matrix->nrows);
1710 /* That's really too slow for normal testing because this function
1711 is called almost everywhere. Although---it's still astonishingly
1712 fast, so it is valuable to have for debugging purposes. */
1713 #if 0
1714 check_matrix_pointer_lossage (matrix);
1715 #endif
1717 return matrix->rows + row;
1721 #if 0 /* This function makes invalid assumptions when text is
1722 partially invisible. But it might come handy for debugging
1723 nevertheless. */
1725 /* Check invariants that must hold for an up to date current matrix of
1726 window W. */
1728 static void
1729 check_matrix_invariants (w)
1730 struct window *w;
1732 struct glyph_matrix *matrix = w->current_matrix;
1733 int yb = window_text_bottom_y (w);
1734 struct glyph_row *row = matrix->rows;
1735 struct glyph_row *last_text_row = NULL;
1736 struct buffer *saved = current_buffer;
1737 struct buffer *buffer = XBUFFER (w->buffer);
1738 int c;
1740 /* This can sometimes happen for a fresh window. */
1741 if (matrix->nrows < 2)
1742 return;
1744 set_buffer_temp (buffer);
1746 /* Note: last row is always reserved for the mode line. */
1747 while (MATRIX_ROW_DISPLAYS_TEXT_P (row)
1748 && MATRIX_ROW_BOTTOM_Y (row) < yb)
1750 struct glyph_row *next = row + 1;
1752 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
1753 last_text_row = row;
1755 /* Check that character and byte positions are in sync. */
1756 xassert (MATRIX_ROW_START_BYTEPOS (row)
1757 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row)));
1759 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1760 have such a position temporarily in case of a minibuffer
1761 displaying something like `[Sole completion]' at its end. */
1762 if (MATRIX_ROW_END_CHARPOS (row) < BUF_ZV (current_buffer))
1763 xassert (MATRIX_ROW_END_BYTEPOS (row)
1764 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row)));
1766 /* Check that end position of `row' is equal to start position
1767 of next row. */
1768 if (next->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (next))
1770 xassert (MATRIX_ROW_END_CHARPOS (row)
1771 == MATRIX_ROW_START_CHARPOS (next));
1772 xassert (MATRIX_ROW_END_BYTEPOS (row)
1773 == MATRIX_ROW_START_BYTEPOS (next));
1775 row = next;
1778 xassert (w->current_matrix->nrows == w->desired_matrix->nrows);
1779 xassert (w->desired_matrix->rows != NULL);
1780 set_buffer_temp (saved);
1783 #endif /* 0 */
1785 #endif /* GLYPH_DEBUG != 0 */
1789 /**********************************************************************
1790 Allocating/ Adjusting Glyph Matrices
1791 **********************************************************************/
1793 /* Allocate glyph matrices over a window tree for a frame-based
1794 redisplay
1796 X and Y are column/row within the frame glyph matrix where
1797 sub-matrices for the window tree rooted at WINDOW must be
1798 allocated. DIM_ONLY_P non-zero means that the caller of this
1799 function is only interested in the result matrix dimension, and
1800 matrix adjustments should not be performed.
1802 The function returns the total width/height of the sub-matrices of
1803 the window tree. If called on a frame root window, the computation
1804 will take the mini-buffer window into account.
1806 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1808 NEW_LEAF_MATRIX set if any window in the tree did not have a
1809 glyph matrices yet, and
1811 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1812 any window in the tree will be changed or have been changed (see
1813 DIM_ONLY_P)
1815 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1816 function.
1818 Windows are arranged into chains of windows on the same level
1819 through the next fields of window structures. Such a level can be
1820 either a sequence of horizontally adjacent windows from left to
1821 right, or a sequence of vertically adjacent windows from top to
1822 bottom. Each window in a horizontal sequence can be either a leaf
1823 window or a vertical sequence; a window in a vertical sequence can
1824 be either a leaf or a horizontal sequence. All windows in a
1825 horizontal sequence have the same height, and all windows in a
1826 vertical sequence have the same width.
1828 This function uses, for historical reasons, a more general
1829 algorithm to determine glyph matrix dimensions that would be
1830 necessary.
1832 The matrix height of a horizontal sequence is determined by the
1833 maximum height of any matrix in the sequence. The matrix width of
1834 a horizontal sequence is computed by adding up matrix widths of
1835 windows in the sequence.
1837 |<------- result width ------->|
1838 +---------+----------+---------+ ---
1839 | | | | |
1840 | | | |
1841 +---------+ | | result height
1842 | +---------+
1843 | | |
1844 +----------+ ---
1846 The matrix width of a vertical sequence is the maximum matrix width
1847 of any window in the sequence. Its height is computed by adding up
1848 matrix heights of windows in the sequence.
1850 |<---- result width -->|
1851 +---------+ ---
1852 | | |
1853 | | |
1854 +---------+--+ |
1855 | | |
1856 | | result height
1858 +------------+---------+ |
1859 | | |
1860 | | |
1861 +------------+---------+ --- */
1863 /* Bit indicating that a new matrix will be allocated or has been
1864 allocated. */
1866 #define NEW_LEAF_MATRIX (1 << 0)
1868 /* Bit indicating that a matrix will or has changed its location or
1869 size. */
1871 #define CHANGED_LEAF_MATRIX (1 << 1)
1873 static struct dim
1874 allocate_matrices_for_frame_redisplay (window, x, y, dim_only_p,
1875 window_change_flags)
1876 Lisp_Object window;
1877 int x, y;
1878 int dim_only_p;
1879 int *window_change_flags;
1881 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1882 int x0 = x, y0 = y;
1883 int wmax = 0, hmax = 0;
1884 struct dim total;
1885 struct dim dim;
1886 struct window *w;
1887 int in_horz_combination_p;
1889 /* What combination is WINDOW part of? Compute this once since the
1890 result is the same for all windows in the `next' chain. The
1891 special case of a root window (parent equal to nil) is treated
1892 like a vertical combination because a root window's `next'
1893 points to the mini-buffer window, if any, which is arranged
1894 vertically below other windows. */
1895 in_horz_combination_p
1896 = (!NILP (XWINDOW (window)->parent)
1897 && !NILP (XWINDOW (XWINDOW (window)->parent)->hchild));
1899 /* For WINDOW and all windows on the same level. */
1902 w = XWINDOW (window);
1904 /* Get the dimension of the window sub-matrix for W, depending
1905 on whether this is a combination or a leaf window. */
1906 if (!NILP (w->hchild))
1907 dim = allocate_matrices_for_frame_redisplay (w->hchild, x, y,
1908 dim_only_p,
1909 window_change_flags);
1910 else if (!NILP (w->vchild))
1911 dim = allocate_matrices_for_frame_redisplay (w->vchild, x, y,
1912 dim_only_p,
1913 window_change_flags);
1914 else
1916 /* If not already done, allocate sub-matrix structures. */
1917 if (w->desired_matrix == NULL)
1919 w->desired_matrix = new_glyph_matrix (f->desired_pool);
1920 w->current_matrix = new_glyph_matrix (f->current_pool);
1921 *window_change_flags |= NEW_LEAF_MATRIX;
1924 /* Width and height MUST be chosen so that there are no
1925 holes in the frame matrix. */
1926 dim.width = required_matrix_width (w);
1927 dim.height = required_matrix_height (w);
1929 /* Will matrix be re-allocated? */
1930 if (x != w->desired_matrix->matrix_x
1931 || y != w->desired_matrix->matrix_y
1932 || dim.width != w->desired_matrix->matrix_w
1933 || dim.height != w->desired_matrix->matrix_h
1934 || (margin_glyphs_to_reserve (w, dim.width,
1935 w->left_margin_cols)
1936 != w->desired_matrix->left_margin_glyphs)
1937 || (margin_glyphs_to_reserve (w, dim.width,
1938 w->right_margin_cols)
1939 != w->desired_matrix->right_margin_glyphs))
1940 *window_change_flags |= CHANGED_LEAF_MATRIX;
1942 /* Actually change matrices, if allowed. Do not consider
1943 CHANGED_LEAF_MATRIX computed above here because the pool
1944 may have been changed which we don't now here. We trust
1945 that we only will be called with DIM_ONLY_P != 0 when
1946 necessary. */
1947 if (!dim_only_p)
1949 adjust_glyph_matrix (w, w->desired_matrix, x, y, dim);
1950 adjust_glyph_matrix (w, w->current_matrix, x, y, dim);
1954 /* If we are part of a horizontal combination, advance x for
1955 windows to the right of W; otherwise advance y for windows
1956 below W. */
1957 if (in_horz_combination_p)
1958 x += dim.width;
1959 else
1960 y += dim.height;
1962 /* Remember maximum glyph matrix dimensions. */
1963 wmax = max (wmax, dim.width);
1964 hmax = max (hmax, dim.height);
1966 /* Next window on same level. */
1967 window = w->next;
1969 while (!NILP (window));
1971 /* Set `total' to the total glyph matrix dimension of this window
1972 level. In a vertical combination, the width is the width of the
1973 widest window; the height is the y we finally reached, corrected
1974 by the y we started with. In a horizontal combination, the total
1975 height is the height of the tallest window, and the width is the
1976 x we finally reached, corrected by the x we started with. */
1977 if (in_horz_combination_p)
1979 total.width = x - x0;
1980 total.height = hmax;
1982 else
1984 total.width = wmax;
1985 total.height = y - y0;
1988 return total;
1992 /* Return the required height of glyph matrices for window W. */
1995 required_matrix_height (w)
1996 struct window *w;
1998 #ifdef HAVE_WINDOW_SYSTEM
1999 struct frame *f = XFRAME (w->frame);
2001 if (FRAME_WINDOW_P (f))
2003 int ch_height = FRAME_SMALLEST_FONT_HEIGHT (f);
2004 int window_pixel_height = window_box_height (w) + eabs (w->vscroll);
2005 return (((window_pixel_height + ch_height - 1)
2006 / ch_height) * w->nrows_scale_factor
2007 /* One partially visible line at the top and
2008 bottom of the window. */
2010 /* 2 for header and mode line. */
2011 + 2);
2013 #endif /* HAVE_WINDOW_SYSTEM */
2015 return WINDOW_TOTAL_LINES (w);
2019 /* Return the required width of glyph matrices for window W. */
2022 required_matrix_width (w)
2023 struct window *w;
2025 #ifdef HAVE_WINDOW_SYSTEM
2026 struct frame *f = XFRAME (w->frame);
2027 if (FRAME_WINDOW_P (f))
2029 int ch_width = FRAME_SMALLEST_CHAR_WIDTH (f);
2030 int window_pixel_width = WINDOW_TOTAL_WIDTH (w);
2032 /* Compute number of glyphs needed in a glyph row. */
2033 return (((window_pixel_width + ch_width - 1)
2034 / ch_width) * w->ncols_scale_factor
2035 /* 2 partially visible columns in the text area. */
2037 /* One partially visible column at the right
2038 edge of each marginal area. */
2039 + 1 + 1);
2041 #endif /* HAVE_WINDOW_SYSTEM */
2043 return XINT (w->total_cols);
2047 /* Allocate window matrices for window-based redisplay. W is the
2048 window whose matrices must be allocated/reallocated. */
2050 static void
2051 allocate_matrices_for_window_redisplay (w)
2052 struct window *w;
2054 while (w)
2056 if (!NILP (w->vchild))
2057 allocate_matrices_for_window_redisplay (XWINDOW (w->vchild));
2058 else if (!NILP (w->hchild))
2059 allocate_matrices_for_window_redisplay (XWINDOW (w->hchild));
2060 else
2062 /* W is a leaf window. */
2063 struct dim dim;
2065 /* If matrices are not yet allocated, allocate them now. */
2066 if (w->desired_matrix == NULL)
2068 w->desired_matrix = new_glyph_matrix (NULL);
2069 w->current_matrix = new_glyph_matrix (NULL);
2072 dim.width = required_matrix_width (w);
2073 dim.height = required_matrix_height (w);
2074 adjust_glyph_matrix (w, w->desired_matrix, 0, 0, dim);
2075 adjust_glyph_matrix (w, w->current_matrix, 0, 0, dim);
2078 w = NILP (w->next) ? NULL : XWINDOW (w->next);
2083 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
2084 do it for all frames; otherwise do it just for the given frame.
2085 This function must be called when a new frame is created, its size
2086 changes, or its window configuration changes. */
2088 void
2089 adjust_glyphs (f)
2090 struct frame *f;
2092 /* Block input so that expose events and other events that access
2093 glyph matrices are not processed while we are changing them. */
2094 BLOCK_INPUT;
2096 if (f)
2097 adjust_frame_glyphs (f);
2098 else
2100 Lisp_Object tail, lisp_frame;
2102 FOR_EACH_FRAME (tail, lisp_frame)
2103 adjust_frame_glyphs (XFRAME (lisp_frame));
2106 UNBLOCK_INPUT;
2110 /* Adjust frame glyphs when Emacs is initialized.
2112 To be called from init_display.
2114 We need a glyph matrix because redraw will happen soon.
2115 Unfortunately, window sizes on selected_frame are not yet set to
2116 meaningful values. I believe we can assume that there are only two
2117 windows on the frame---the mini-buffer and the root window. Frame
2118 height and width seem to be correct so far. So, set the sizes of
2119 windows to estimated values. */
2121 static void
2122 adjust_frame_glyphs_initially ()
2124 struct frame *sf = SELECTED_FRAME ();
2125 struct window *root = XWINDOW (sf->root_window);
2126 struct window *mini = XWINDOW (root->next);
2127 int frame_lines = FRAME_LINES (sf);
2128 int frame_cols = FRAME_COLS (sf);
2129 int top_margin = FRAME_TOP_MARGIN (sf);
2131 /* Do it for the root window. */
2132 XSETFASTINT (root->top_line, top_margin);
2133 XSETFASTINT (root->total_cols, frame_cols);
2134 set_window_height (sf->root_window, frame_lines - 1 - top_margin, 0);
2136 /* Do it for the mini-buffer window. */
2137 XSETFASTINT (mini->top_line, frame_lines - 1);
2138 XSETFASTINT (mini->total_cols, frame_cols);
2139 set_window_height (root->next, 1, 0);
2141 adjust_frame_glyphs (sf);
2142 glyphs_initialized_initially_p = 1;
2146 /* Allocate/reallocate glyph matrices of a single frame F. */
2148 static void
2149 adjust_frame_glyphs (f)
2150 struct frame *f;
2152 if (FRAME_WINDOW_P (f))
2153 adjust_frame_glyphs_for_window_redisplay (f);
2154 else
2155 adjust_frame_glyphs_for_frame_redisplay (f);
2157 /* Don't forget the message buffer and the buffer for
2158 decode_mode_spec. */
2159 adjust_frame_message_buffer (f);
2160 adjust_decode_mode_spec_buffer (f);
2162 f->glyphs_initialized_p = 1;
2165 /* Return 1 if any window in the tree has nonzero window margins. See
2166 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
2167 static int
2168 showing_window_margins_p (w)
2169 struct window *w;
2171 while (w)
2173 if (!NILP (w->hchild))
2175 if (showing_window_margins_p (XWINDOW (w->hchild)))
2176 return 1;
2178 else if (!NILP (w->vchild))
2180 if (showing_window_margins_p (XWINDOW (w->vchild)))
2181 return 1;
2183 else if (!NILP (w->left_margin_cols)
2184 || !NILP (w->right_margin_cols))
2185 return 1;
2187 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2189 return 0;
2193 /* In the window tree with root W, build current matrices of leaf
2194 windows from the frame's current matrix. */
2196 static void
2197 fake_current_matrices (window)
2198 Lisp_Object window;
2200 struct window *w;
2202 for (; !NILP (window); window = w->next)
2204 w = XWINDOW (window);
2206 if (!NILP (w->hchild))
2207 fake_current_matrices (w->hchild);
2208 else if (!NILP (w->vchild))
2209 fake_current_matrices (w->vchild);
2210 else
2212 int i;
2213 struct frame *f = XFRAME (w->frame);
2214 struct glyph_matrix *m = w->current_matrix;
2215 struct glyph_matrix *fm = f->current_matrix;
2217 xassert (m->matrix_h == WINDOW_TOTAL_LINES (w));
2218 xassert (m->matrix_w == WINDOW_TOTAL_COLS (w));
2220 for (i = 0; i < m->matrix_h; ++i)
2222 struct glyph_row *r = m->rows + i;
2223 struct glyph_row *fr = fm->rows + i + WINDOW_TOP_EDGE_LINE (w);
2225 xassert (r->glyphs[TEXT_AREA] >= fr->glyphs[TEXT_AREA]
2226 && r->glyphs[LAST_AREA] <= fr->glyphs[LAST_AREA]);
2228 r->enabled_p = fr->enabled_p;
2229 if (r->enabled_p)
2231 r->used[LEFT_MARGIN_AREA] = m->left_margin_glyphs;
2232 r->used[RIGHT_MARGIN_AREA] = m->right_margin_glyphs;
2233 r->used[TEXT_AREA] = (m->matrix_w
2234 - r->used[LEFT_MARGIN_AREA]
2235 - r->used[RIGHT_MARGIN_AREA]);
2236 r->mode_line_p = 0;
2244 /* Save away the contents of frame F's current frame matrix. Value is
2245 a glyph matrix holding the contents of F's current frame matrix. */
2247 static struct glyph_matrix *
2248 save_current_matrix (f)
2249 struct frame *f;
2251 int i;
2252 struct glyph_matrix *saved;
2254 saved = (struct glyph_matrix *) xmalloc (sizeof *saved);
2255 bzero (saved, sizeof *saved);
2256 saved->nrows = f->current_matrix->nrows;
2257 saved->rows = (struct glyph_row *) xmalloc (saved->nrows
2258 * sizeof *saved->rows);
2259 bzero (saved->rows, saved->nrows * sizeof *saved->rows);
2261 for (i = 0; i < saved->nrows; ++i)
2263 struct glyph_row *from = f->current_matrix->rows + i;
2264 struct glyph_row *to = saved->rows + i;
2265 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2266 to->glyphs[TEXT_AREA] = (struct glyph *) xmalloc (nbytes);
2267 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2268 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2271 return saved;
2275 /* Restore the contents of frame F's current frame matrix from SAVED,
2276 and free memory associated with SAVED. */
2278 static void
2279 restore_current_matrix (f, saved)
2280 struct frame *f;
2281 struct glyph_matrix *saved;
2283 int i;
2285 for (i = 0; i < saved->nrows; ++i)
2287 struct glyph_row *from = saved->rows + i;
2288 struct glyph_row *to = f->current_matrix->rows + i;
2289 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2290 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2291 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2292 xfree (from->glyphs[TEXT_AREA]);
2295 xfree (saved->rows);
2296 xfree (saved);
2301 /* Allocate/reallocate glyph matrices of a single frame F for
2302 frame-based redisplay. */
2304 static void
2305 adjust_frame_glyphs_for_frame_redisplay (f)
2306 struct frame *f;
2308 struct dim matrix_dim;
2309 int pool_changed_p;
2310 int window_change_flags;
2311 int top_window_y;
2313 if (!FRAME_LIVE_P (f))
2314 return;
2316 top_window_y = FRAME_TOP_MARGIN (f);
2318 /* Allocate glyph pool structures if not already done. */
2319 if (f->desired_pool == NULL)
2321 f->desired_pool = new_glyph_pool ();
2322 f->current_pool = new_glyph_pool ();
2325 /* Allocate frames matrix structures if needed. */
2326 if (f->desired_matrix == NULL)
2328 f->desired_matrix = new_glyph_matrix (f->desired_pool);
2329 f->current_matrix = new_glyph_matrix (f->current_pool);
2332 /* Compute window glyph matrices. (This takes the mini-buffer
2333 window into account). The result is the size of the frame glyph
2334 matrix needed. The variable window_change_flags is set to a bit
2335 mask indicating whether new matrices will be allocated or
2336 existing matrices change their size or location within the frame
2337 matrix. */
2338 window_change_flags = 0;
2339 matrix_dim
2340 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2341 0, top_window_y,
2343 &window_change_flags);
2345 /* Add in menu bar lines, if any. */
2346 matrix_dim.height += top_window_y;
2348 /* Enlarge pools as necessary. */
2349 pool_changed_p = realloc_glyph_pool (f->desired_pool, matrix_dim);
2350 realloc_glyph_pool (f->current_pool, matrix_dim);
2352 /* Set up glyph pointers within window matrices. Do this only if
2353 absolutely necessary since it requires a frame redraw. */
2354 if (pool_changed_p || window_change_flags)
2356 /* Do it for window matrices. */
2357 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2358 0, top_window_y, 0,
2359 &window_change_flags);
2361 /* Size of frame matrices must equal size of frame. Note
2362 that we are called for X frames with window widths NOT equal
2363 to the frame width (from CHANGE_FRAME_SIZE_1). */
2364 xassert (matrix_dim.width == FRAME_COLS (f)
2365 && matrix_dim.height == FRAME_LINES (f));
2367 /* Pointers to glyph memory in glyph rows are exchanged during
2368 the update phase of redisplay, which means in general that a
2369 frame's current matrix consists of pointers into both the
2370 desired and current glyph pool of the frame. Adjusting a
2371 matrix sets the frame matrix up so that pointers are all into
2372 the same pool. If we want to preserve glyph contents of the
2373 current matrix over a call to adjust_glyph_matrix, we must
2374 make a copy of the current glyphs, and restore the current
2375 matrix' contents from that copy. */
2376 if (display_completed
2377 && !FRAME_GARBAGED_P (f)
2378 && matrix_dim.width == f->current_matrix->matrix_w
2379 && matrix_dim.height == f->current_matrix->matrix_h
2380 /* For some reason, the frame glyph matrix gets corrupted if
2381 any of the windows contain margins. I haven't been able
2382 to hunt down the reason, but for the moment this prevents
2383 the problem from manifesting. -- cyd */
2384 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f))))
2386 struct glyph_matrix *copy = save_current_matrix (f);
2387 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2388 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2389 restore_current_matrix (f, copy);
2390 fake_current_matrices (FRAME_ROOT_WINDOW (f));
2392 else
2394 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2395 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2396 SET_FRAME_GARBAGED (f);
2402 /* Allocate/reallocate glyph matrices of a single frame F for
2403 window-based redisplay. */
2405 static void
2406 adjust_frame_glyphs_for_window_redisplay (f)
2407 struct frame *f;
2409 struct window *w;
2411 xassert (FRAME_WINDOW_P (f) && FRAME_LIVE_P (f));
2413 /* Allocate/reallocate window matrices. */
2414 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f)));
2416 #ifdef HAVE_X_WINDOWS
2417 /* Allocate/ reallocate matrices of the dummy window used to display
2418 the menu bar under X when no X toolkit support is available. */
2419 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2421 /* Allocate a dummy window if not already done. */
2422 if (NILP (f->menu_bar_window))
2424 f->menu_bar_window = make_window ();
2425 w = XWINDOW (f->menu_bar_window);
2426 XSETFRAME (w->frame, f);
2427 w->pseudo_window_p = 1;
2429 else
2430 w = XWINDOW (f->menu_bar_window);
2432 /* Set window dimensions to frame dimensions and allocate or
2433 adjust glyph matrices of W. */
2434 XSETFASTINT (w->top_line, 0);
2435 XSETFASTINT (w->left_col, 0);
2436 XSETFASTINT (w->total_lines, FRAME_MENU_BAR_LINES (f));
2437 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2438 allocate_matrices_for_window_redisplay (w);
2440 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2441 #endif /* HAVE_X_WINDOWS */
2443 #ifndef USE_GTK
2444 /* Allocate/ reallocate matrices of the tool bar window. If we
2445 don't have a tool bar window yet, make one. */
2446 if (NILP (f->tool_bar_window))
2448 f->tool_bar_window = make_window ();
2449 w = XWINDOW (f->tool_bar_window);
2450 XSETFRAME (w->frame, f);
2451 w->pseudo_window_p = 1;
2453 else
2454 w = XWINDOW (f->tool_bar_window);
2456 XSETFASTINT (w->top_line, FRAME_MENU_BAR_LINES (f));
2457 XSETFASTINT (w->left_col, 0);
2458 XSETFASTINT (w->total_lines, FRAME_TOOL_BAR_LINES (f));
2459 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2460 allocate_matrices_for_window_redisplay (w);
2461 #endif
2465 /* Adjust/ allocate message buffer of frame F.
2467 Note that the message buffer is never freed. Since I could not
2468 find a free in 19.34, I assume that freeing it would be
2469 problematic in some way and don't do it either.
2471 (Implementation note: It should be checked if we can free it
2472 eventually without causing trouble). */
2474 static void
2475 adjust_frame_message_buffer (f)
2476 struct frame *f;
2478 int size = FRAME_MESSAGE_BUF_SIZE (f) + 1;
2480 if (FRAME_MESSAGE_BUF (f))
2482 char *buffer = FRAME_MESSAGE_BUF (f);
2483 char *new_buffer = (char *) xrealloc (buffer, size);
2484 FRAME_MESSAGE_BUF (f) = new_buffer;
2486 else
2487 FRAME_MESSAGE_BUF (f) = (char *) xmalloc (size);
2491 /* Re-allocate buffer for decode_mode_spec on frame F. */
2493 static void
2494 adjust_decode_mode_spec_buffer (f)
2495 struct frame *f;
2497 f->decode_mode_spec_buffer
2498 = (char *) xrealloc (f->decode_mode_spec_buffer,
2499 FRAME_MESSAGE_BUF_SIZE (f) + 1);
2504 /**********************************************************************
2505 Freeing Glyph Matrices
2506 **********************************************************************/
2508 /* Free glyph memory for a frame F. F may be null. This function can
2509 be called for the same frame more than once. The root window of
2510 F may be nil when this function is called. This is the case when
2511 the function is called when F is destroyed. */
2513 void
2514 free_glyphs (f)
2515 struct frame *f;
2517 if (f && f->glyphs_initialized_p)
2519 /* Block interrupt input so that we don't get surprised by an X
2520 event while we're in an inconsistent state. */
2521 BLOCK_INPUT;
2522 f->glyphs_initialized_p = 0;
2524 /* Release window sub-matrices. */
2525 if (!NILP (f->root_window))
2526 free_window_matrices (XWINDOW (f->root_window));
2528 /* Free the dummy window for menu bars without X toolkit and its
2529 glyph matrices. */
2530 if (!NILP (f->menu_bar_window))
2532 struct window *w = XWINDOW (f->menu_bar_window);
2533 free_glyph_matrix (w->desired_matrix);
2534 free_glyph_matrix (w->current_matrix);
2535 w->desired_matrix = w->current_matrix = NULL;
2536 f->menu_bar_window = Qnil;
2539 /* Free the tool bar window and its glyph matrices. */
2540 if (!NILP (f->tool_bar_window))
2542 struct window *w = XWINDOW (f->tool_bar_window);
2543 free_glyph_matrix (w->desired_matrix);
2544 free_glyph_matrix (w->current_matrix);
2545 w->desired_matrix = w->current_matrix = NULL;
2546 f->tool_bar_window = Qnil;
2549 /* Release frame glyph matrices. Reset fields to zero in
2550 case we are called a second time. */
2551 if (f->desired_matrix)
2553 free_glyph_matrix (f->desired_matrix);
2554 free_glyph_matrix (f->current_matrix);
2555 f->desired_matrix = f->current_matrix = NULL;
2558 /* Release glyph pools. */
2559 if (f->desired_pool)
2561 free_glyph_pool (f->desired_pool);
2562 free_glyph_pool (f->current_pool);
2563 f->desired_pool = f->current_pool = NULL;
2566 UNBLOCK_INPUT;
2571 /* Free glyph sub-matrices in the window tree rooted at W. This
2572 function may be called with a null pointer, and it may be called on
2573 the same tree more than once. */
2575 void
2576 free_window_matrices (w)
2577 struct window *w;
2579 while (w)
2581 if (!NILP (w->hchild))
2582 free_window_matrices (XWINDOW (w->hchild));
2583 else if (!NILP (w->vchild))
2584 free_window_matrices (XWINDOW (w->vchild));
2585 else
2587 /* This is a leaf window. Free its memory and reset fields
2588 to zero in case this function is called a second time for
2589 W. */
2590 free_glyph_matrix (w->current_matrix);
2591 free_glyph_matrix (w->desired_matrix);
2592 w->current_matrix = w->desired_matrix = NULL;
2595 /* Next window on same level. */
2596 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2601 /* Check glyph memory leaks. This function is called from
2602 shut_down_emacs. Note that frames are not destroyed when Emacs
2603 exits. We therefore free all glyph memory for all active frames
2604 explicitly and check that nothing is left allocated. */
2606 void
2607 check_glyph_memory ()
2609 Lisp_Object tail, frame;
2611 /* Free glyph memory for all frames. */
2612 FOR_EACH_FRAME (tail, frame)
2613 free_glyphs (XFRAME (frame));
2615 /* Check that nothing is left allocated. */
2616 if (glyph_matrix_count)
2617 abort ();
2618 if (glyph_pool_count)
2619 abort ();
2624 /**********************************************************************
2625 Building a Frame Matrix
2626 **********************************************************************/
2628 /* Most of the redisplay code works on glyph matrices attached to
2629 windows. This is a good solution most of the time, but it is not
2630 suitable for terminal code. Terminal output functions cannot rely
2631 on being able to set an arbitrary terminal window. Instead they
2632 must be provided with a view of the whole frame, i.e. the whole
2633 screen. We build such a view by constructing a frame matrix from
2634 window matrices in this section.
2636 Windows that must be updated have their must_be_update_p flag set.
2637 For all such windows, their desired matrix is made part of the
2638 desired frame matrix. For other windows, their current matrix is
2639 made part of the desired frame matrix.
2641 +-----------------+----------------+
2642 | desired | desired |
2643 | | |
2644 +-----------------+----------------+
2645 | current |
2647 +----------------------------------+
2649 Desired window matrices can be made part of the frame matrix in a
2650 cheap way: We exploit the fact that the desired frame matrix and
2651 desired window matrices share their glyph memory. This is not
2652 possible for current window matrices. Their glyphs are copied to
2653 the desired frame matrix. The latter is equivalent to
2654 preserve_other_columns in the old redisplay.
2656 Used glyphs counters for frame matrix rows are the result of adding
2657 up glyph lengths of the window matrices. A line in the frame
2658 matrix is enabled, if a corresponding line in a window matrix is
2659 enabled.
2661 After building the desired frame matrix, it will be passed to
2662 terminal code, which will manipulate both the desired and current
2663 frame matrix. Changes applied to the frame's current matrix have
2664 to be visible in current window matrices afterwards, of course.
2666 This problem is solved like this:
2668 1. Window and frame matrices share glyphs. Window matrices are
2669 constructed in a way that their glyph contents ARE the glyph
2670 contents needed in a frame matrix. Thus, any modification of
2671 glyphs done in terminal code will be reflected in window matrices
2672 automatically.
2674 2. Exchanges of rows in a frame matrix done by terminal code are
2675 intercepted by hook functions so that corresponding row operations
2676 on window matrices can be performed. This is necessary because we
2677 use pointers to glyphs in glyph row structures. To satisfy the
2678 assumption of point 1 above that glyphs are updated implicitly in
2679 window matrices when they are manipulated via the frame matrix,
2680 window and frame matrix must of course agree where to find the
2681 glyphs for their rows. Possible manipulations that must be
2682 mirrored are assignments of rows of the desired frame matrix to the
2683 current frame matrix and scrolling the current frame matrix. */
2685 /* Build frame F's desired matrix from window matrices. Only windows
2686 which have the flag must_be_updated_p set have to be updated. Menu
2687 bar lines of a frame are not covered by window matrices, so make
2688 sure not to touch them in this function. */
2690 static void
2691 build_frame_matrix (f)
2692 struct frame *f;
2694 int i;
2696 /* F must have a frame matrix when this function is called. */
2697 xassert (!FRAME_WINDOW_P (f));
2699 /* Clear all rows in the frame matrix covered by window matrices.
2700 Menu bar lines are not covered by windows. */
2701 for (i = FRAME_TOP_MARGIN (f); i < f->desired_matrix->nrows; ++i)
2702 clear_glyph_row (MATRIX_ROW (f->desired_matrix, i));
2704 /* Build the matrix by walking the window tree. */
2705 build_frame_matrix_from_window_tree (f->desired_matrix,
2706 XWINDOW (FRAME_ROOT_WINDOW (f)));
2710 /* Walk a window tree, building a frame matrix MATRIX from window
2711 matrices. W is the root of a window tree. */
2713 static void
2714 build_frame_matrix_from_window_tree (matrix, w)
2715 struct glyph_matrix *matrix;
2716 struct window *w;
2718 while (w)
2720 if (!NILP (w->hchild))
2721 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->hchild));
2722 else if (!NILP (w->vchild))
2723 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->vchild));
2724 else
2725 build_frame_matrix_from_leaf_window (matrix, w);
2727 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2732 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2733 desired frame matrix built. W is a leaf window whose desired or
2734 current matrix is to be added to FRAME_MATRIX. W's flag
2735 must_be_updated_p determines which matrix it contributes to
2736 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2737 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2738 Adding a desired matrix means setting up used counters and such in
2739 frame rows, while adding a current window matrix to FRAME_MATRIX
2740 means copying glyphs. The latter case corresponds to
2741 preserve_other_columns in the old redisplay. */
2743 static void
2744 build_frame_matrix_from_leaf_window (frame_matrix, w)
2745 struct glyph_matrix *frame_matrix;
2746 struct window *w;
2748 struct glyph_matrix *window_matrix;
2749 int window_y, frame_y;
2750 /* If non-zero, a glyph to insert at the right border of W. */
2751 GLYPH right_border_glyph;
2753 SET_GLYPH_FROM_CHAR (right_border_glyph, 0);
2755 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2756 if (w->must_be_updated_p)
2758 window_matrix = w->desired_matrix;
2760 /* Decide whether we want to add a vertical border glyph. */
2761 if (!WINDOW_RIGHTMOST_P (w))
2763 struct Lisp_Char_Table *dp = window_display_table (w);
2764 Lisp_Object gc;
2766 SET_GLYPH_FROM_CHAR (right_border_glyph, '|');
2767 if (dp
2768 && (gc = DISP_BORDER_GLYPH (dp), GLYPH_CODE_P (gc))
2769 && GLYPH_CODE_CHAR_VALID_P (gc))
2771 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph, gc);
2772 spec_glyph_lookup_face (w, &right_border_glyph);
2775 if (GLYPH_FACE (right_border_glyph) <= 0)
2776 SET_GLYPH_FACE (right_border_glyph, VERTICAL_BORDER_FACE_ID);
2779 else
2780 window_matrix = w->current_matrix;
2782 /* For all rows in the window matrix and corresponding rows in the
2783 frame matrix. */
2784 window_y = 0;
2785 frame_y = window_matrix->matrix_y;
2786 while (window_y < window_matrix->nrows)
2788 struct glyph_row *frame_row = frame_matrix->rows + frame_y;
2789 struct glyph_row *window_row = window_matrix->rows + window_y;
2790 int current_row_p = window_matrix == w->current_matrix;
2792 /* Fill up the frame row with spaces up to the left margin of the
2793 window row. */
2794 fill_up_frame_row_with_spaces (frame_row, window_matrix->matrix_x);
2796 /* Fill up areas in the window matrix row with spaces. */
2797 fill_up_glyph_row_with_spaces (window_row);
2799 /* If only part of W's desired matrix has been built, and
2800 window_row wasn't displayed, use the corresponding current
2801 row instead. */
2802 if (window_matrix == w->desired_matrix
2803 && !window_row->enabled_p)
2805 window_row = w->current_matrix->rows + window_y;
2806 current_row_p = 1;
2809 if (current_row_p)
2811 /* Copy window row to frame row. */
2812 bcopy (window_row->glyphs[0],
2813 frame_row->glyphs[TEXT_AREA] + window_matrix->matrix_x,
2814 window_matrix->matrix_w * sizeof (struct glyph));
2816 else
2818 xassert (window_row->enabled_p);
2820 /* Only when a desired row has been displayed, we want
2821 the corresponding frame row to be updated. */
2822 frame_row->enabled_p = 1;
2824 /* Maybe insert a vertical border between horizontally adjacent
2825 windows. */
2826 if (GLYPH_CHAR (right_border_glyph) != 0)
2828 struct glyph *border = window_row->glyphs[LAST_AREA] - 1;
2829 SET_CHAR_GLYPH_FROM_GLYPH (*border, right_border_glyph);
2832 #if GLYPH_DEBUG
2833 /* Window row window_y must be a slice of frame row
2834 frame_y. */
2835 xassert (glyph_row_slice_p (window_row, frame_row));
2837 /* If rows are in sync, we don't have to copy glyphs because
2838 frame and window share glyphs. */
2840 strcpy (w->current_matrix->method, w->desired_matrix->method);
2841 add_window_display_history (w, w->current_matrix->method, 0);
2842 #endif
2845 /* Set number of used glyphs in the frame matrix. Since we fill
2846 up with spaces, and visit leaf windows from left to right it
2847 can be done simply. */
2848 frame_row->used[TEXT_AREA]
2849 = window_matrix->matrix_x + window_matrix->matrix_w;
2851 /* Next row. */
2852 ++window_y;
2853 ++frame_y;
2857 /* Given a user-specified glyph, possibly including a Lisp-level face
2858 ID, return a glyph that has a realized face ID.
2859 This is used for glyphs displayed specially and not part of the text;
2860 for instance, vertical separators, truncation markers, etc. */
2862 void
2863 spec_glyph_lookup_face (w, glyph)
2864 struct window *w;
2865 GLYPH *glyph;
2867 int lface_id = GLYPH_FACE (*glyph);
2868 /* Convert the glyph's specified face to a realized (cache) face. */
2869 if (lface_id > 0)
2871 int face_id = merge_faces (XFRAME (w->frame),
2872 Qt, lface_id, DEFAULT_FACE_ID);
2873 SET_GLYPH_FACE (*glyph, face_id);
2877 /* Add spaces to a glyph row ROW in a window matrix.
2879 Each row has the form:
2881 +---------+-----------------------------+------------+
2882 | left | text | right |
2883 +---------+-----------------------------+------------+
2885 Left and right marginal areas are optional. This function adds
2886 spaces to areas so that there are no empty holes between areas.
2887 In other words: If the right area is not empty, the text area
2888 is filled up with spaces up to the right area. If the text area
2889 is not empty, the left area is filled up.
2891 To be called for frame-based redisplay, only. */
2893 static void
2894 fill_up_glyph_row_with_spaces (row)
2895 struct glyph_row *row;
2897 fill_up_glyph_row_area_with_spaces (row, LEFT_MARGIN_AREA);
2898 fill_up_glyph_row_area_with_spaces (row, TEXT_AREA);
2899 fill_up_glyph_row_area_with_spaces (row, RIGHT_MARGIN_AREA);
2903 /* Fill area AREA of glyph row ROW with spaces. To be called for
2904 frame-based redisplay only. */
2906 static void
2907 fill_up_glyph_row_area_with_spaces (row, area)
2908 struct glyph_row *row;
2909 int area;
2911 if (row->glyphs[area] < row->glyphs[area + 1])
2913 struct glyph *end = row->glyphs[area + 1];
2914 struct glyph *text = row->glyphs[area] + row->used[area];
2916 while (text < end)
2917 *text++ = space_glyph;
2918 row->used[area] = text - row->glyphs[area];
2923 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2924 reached. In frame matrices only one area, TEXT_AREA, is used. */
2926 static void
2927 fill_up_frame_row_with_spaces (row, upto)
2928 struct glyph_row *row;
2929 int upto;
2931 int i = row->used[TEXT_AREA];
2932 struct glyph *glyph = row->glyphs[TEXT_AREA];
2934 while (i < upto)
2935 glyph[i++] = space_glyph;
2937 row->used[TEXT_AREA] = i;
2942 /**********************************************************************
2943 Mirroring operations on frame matrices in window matrices
2944 **********************************************************************/
2946 /* Set frame being updated via frame-based redisplay to F. This
2947 function must be called before updates to make explicit that we are
2948 working on frame matrices or not. */
2950 static INLINE void
2951 set_frame_matrix_frame (f)
2952 struct frame *f;
2954 frame_matrix_frame = f;
2958 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2959 DESIRED_MATRIX is the desired matrix corresponding to
2960 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2961 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2962 frame_matrix_frame is non-null, this indicates that the exchange is
2963 done in frame matrices, and that we have to perform analogous
2964 operations in window matrices of frame_matrix_frame. */
2966 static INLINE void
2967 make_current (desired_matrix, current_matrix, row)
2968 struct glyph_matrix *desired_matrix, *current_matrix;
2969 int row;
2971 struct glyph_row *current_row = MATRIX_ROW (current_matrix, row);
2972 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, row);
2973 int mouse_face_p = current_row->mouse_face_p;
2975 /* Do current_row = desired_row. This exchanges glyph pointers
2976 between both rows, and does a structure assignment otherwise. */
2977 assign_row (current_row, desired_row);
2979 /* Enable current_row to mark it as valid. */
2980 current_row->enabled_p = 1;
2981 current_row->mouse_face_p = mouse_face_p;
2983 /* If we are called on frame matrices, perform analogous operations
2984 for window matrices. */
2985 if (frame_matrix_frame)
2986 mirror_make_current (XWINDOW (frame_matrix_frame->root_window), row);
2990 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2991 W's frame which has been made current (by swapping pointers between
2992 current and desired matrix). Perform analogous operations in the
2993 matrices of leaf windows in the window tree rooted at W. */
2995 static void
2996 mirror_make_current (w, frame_row)
2997 struct window *w;
2998 int frame_row;
3000 while (w)
3002 if (!NILP (w->hchild))
3003 mirror_make_current (XWINDOW (w->hchild), frame_row);
3004 else if (!NILP (w->vchild))
3005 mirror_make_current (XWINDOW (w->vchild), frame_row);
3006 else
3008 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
3009 here because the checks performed in debug mode there
3010 will not allow the conversion. */
3011 int row = frame_row - w->desired_matrix->matrix_y;
3013 /* If FRAME_ROW is within W, assign the desired row to the
3014 current row (exchanging glyph pointers). */
3015 if (row >= 0 && row < w->desired_matrix->matrix_h)
3017 struct glyph_row *current_row
3018 = MATRIX_ROW (w->current_matrix, row);
3019 struct glyph_row *desired_row
3020 = MATRIX_ROW (w->desired_matrix, row);
3022 if (desired_row->enabled_p)
3023 assign_row (current_row, desired_row);
3024 else
3025 swap_glyph_pointers (desired_row, current_row);
3026 current_row->enabled_p = 1;
3030 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3035 /* Perform row dance after scrolling. We are working on the range of
3036 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
3037 including) in MATRIX. COPY_FROM is a vector containing, for each
3038 row I in the range 0 <= I < NLINES, the index of the original line
3039 to move to I. This index is relative to the row range, i.e. 0 <=
3040 index < NLINES. RETAINED_P is a vector containing zero for each
3041 row 0 <= I < NLINES which is empty.
3043 This function is called from do_scrolling and do_direct_scrolling. */
3045 void
3046 mirrored_line_dance (matrix, unchanged_at_top, nlines, copy_from,
3047 retained_p)
3048 struct glyph_matrix *matrix;
3049 int unchanged_at_top, nlines;
3050 int *copy_from;
3051 char *retained_p;
3053 /* A copy of original rows. */
3054 struct glyph_row *old_rows;
3056 /* Rows to assign to. */
3057 struct glyph_row *new_rows = MATRIX_ROW (matrix, unchanged_at_top);
3059 int i;
3061 /* Make a copy of the original rows. */
3062 old_rows = (struct glyph_row *) alloca (nlines * sizeof *old_rows);
3063 bcopy (new_rows, old_rows, nlines * sizeof *old_rows);
3065 /* Assign new rows, maybe clear lines. */
3066 for (i = 0; i < nlines; ++i)
3068 int enabled_before_p = new_rows[i].enabled_p;
3070 xassert (i + unchanged_at_top < matrix->nrows);
3071 xassert (unchanged_at_top + copy_from[i] < matrix->nrows);
3072 new_rows[i] = old_rows[copy_from[i]];
3073 new_rows[i].enabled_p = enabled_before_p;
3075 /* RETAINED_P is zero for empty lines. */
3076 if (!retained_p[copy_from[i]])
3077 new_rows[i].enabled_p = 0;
3080 /* Do the same for window matrices, if MATRIX is a frame matrix. */
3081 if (frame_matrix_frame)
3082 mirror_line_dance (XWINDOW (frame_matrix_frame->root_window),
3083 unchanged_at_top, nlines, copy_from, retained_p);
3087 /* Synchronize glyph pointers in the current matrix of window W with
3088 the current frame matrix. */
3090 static void
3091 sync_window_with_frame_matrix_rows (w)
3092 struct window *w;
3094 struct frame *f = XFRAME (w->frame);
3095 struct glyph_row *window_row, *window_row_end, *frame_row;
3096 int left, right, x, width;
3098 /* Preconditions: W must be a leaf window on a tty frame. */
3099 xassert (NILP (w->hchild) && NILP (w->vchild));
3100 xassert (!FRAME_WINDOW_P (f));
3102 left = margin_glyphs_to_reserve (w, 1, w->left_margin_cols);
3103 right = margin_glyphs_to_reserve (w, 1, w->right_margin_cols);
3104 x = w->current_matrix->matrix_x;
3105 width = w->current_matrix->matrix_w;
3107 window_row = w->current_matrix->rows;
3108 window_row_end = window_row + w->current_matrix->nrows;
3109 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
3111 for (; window_row < window_row_end; ++window_row, ++frame_row)
3113 window_row->glyphs[LEFT_MARGIN_AREA]
3114 = frame_row->glyphs[0] + x;
3115 window_row->glyphs[TEXT_AREA]
3116 = window_row->glyphs[LEFT_MARGIN_AREA] + left;
3117 window_row->glyphs[LAST_AREA]
3118 = window_row->glyphs[LEFT_MARGIN_AREA] + width;
3119 window_row->glyphs[RIGHT_MARGIN_AREA]
3120 = window_row->glyphs[LAST_AREA] - right;
3125 /* Return the window in the window tree rooted in W containing frame
3126 row ROW. Value is null if none is found. */
3128 struct window *
3129 frame_row_to_window (w, row)
3130 struct window *w;
3131 int row;
3133 struct window *found = NULL;
3135 while (w && !found)
3137 if (!NILP (w->hchild))
3138 found = frame_row_to_window (XWINDOW (w->hchild), row);
3139 else if (!NILP (w->vchild))
3140 found = frame_row_to_window (XWINDOW (w->vchild), row);
3141 else if (row >= WINDOW_TOP_EDGE_LINE (w)
3142 && row < WINDOW_BOTTOM_EDGE_LINE (w))
3143 found = w;
3145 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3148 return found;
3152 /* Perform a line dance in the window tree rooted at W, after
3153 scrolling a frame matrix in mirrored_line_dance.
3155 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
3156 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
3157 COPY_FROM is a vector containing, for each row I in the range 0 <=
3158 I < NLINES, the index of the original line to move to I. This
3159 index is relative to the row range, i.e. 0 <= index < NLINES.
3160 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
3161 which is empty. */
3163 static void
3164 mirror_line_dance (w, unchanged_at_top, nlines, copy_from, retained_p)
3165 struct window *w;
3166 int unchanged_at_top, nlines;
3167 int *copy_from;
3168 char *retained_p;
3170 while (w)
3172 if (!NILP (w->hchild))
3173 mirror_line_dance (XWINDOW (w->hchild), unchanged_at_top,
3174 nlines, copy_from, retained_p);
3175 else if (!NILP (w->vchild))
3176 mirror_line_dance (XWINDOW (w->vchild), unchanged_at_top,
3177 nlines, copy_from, retained_p);
3178 else
3180 /* W is a leaf window, and we are working on its current
3181 matrix m. */
3182 struct glyph_matrix *m = w->current_matrix;
3183 int i, sync_p = 0;
3184 struct glyph_row *old_rows;
3186 /* Make a copy of the original rows of matrix m. */
3187 old_rows = (struct glyph_row *) alloca (m->nrows * sizeof *old_rows);
3188 bcopy (m->rows, old_rows, m->nrows * sizeof *old_rows);
3190 for (i = 0; i < nlines; ++i)
3192 /* Frame relative line assigned to. */
3193 int frame_to = i + unchanged_at_top;
3195 /* Frame relative line assigned. */
3196 int frame_from = copy_from[i] + unchanged_at_top;
3198 /* Window relative line assigned to. */
3199 int window_to = frame_to - m->matrix_y;
3201 /* Window relative line assigned. */
3202 int window_from = frame_from - m->matrix_y;
3204 /* Is assigned line inside window? */
3205 int from_inside_window_p
3206 = window_from >= 0 && window_from < m->matrix_h;
3208 /* Is assigned to line inside window? */
3209 int to_inside_window_p
3210 = window_to >= 0 && window_to < m->matrix_h;
3212 if (from_inside_window_p && to_inside_window_p)
3214 /* Enabled setting before assignment. */
3215 int enabled_before_p;
3217 /* Do the assignment. The enabled_p flag is saved
3218 over the assignment because the old redisplay did
3219 that. */
3220 enabled_before_p = m->rows[window_to].enabled_p;
3221 m->rows[window_to] = old_rows[window_from];
3222 m->rows[window_to].enabled_p = enabled_before_p;
3224 /* If frame line is empty, window line is empty, too. */
3225 if (!retained_p[copy_from[i]])
3226 m->rows[window_to].enabled_p = 0;
3228 else if (to_inside_window_p)
3230 /* A copy between windows. This is an infrequent
3231 case not worth optimizing. */
3232 struct frame *f = XFRAME (w->frame);
3233 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3234 struct window *w2;
3235 struct glyph_matrix *m2;
3236 int m2_from;
3238 w2 = frame_row_to_window (root, frame_from);
3239 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3240 -nw', FROM_FRAME sometimes has no associated window.
3241 This check avoids a segfault if W2 is null. */
3242 if (w2)
3244 m2 = w2->current_matrix;
3245 m2_from = frame_from - m2->matrix_y;
3246 copy_row_except_pointers (m->rows + window_to,
3247 m2->rows + m2_from);
3249 /* If frame line is empty, window line is empty, too. */
3250 if (!retained_p[copy_from[i]])
3251 m->rows[window_to].enabled_p = 0;
3253 sync_p = 1;
3255 else if (from_inside_window_p)
3256 sync_p = 1;
3259 /* If there was a copy between windows, make sure glyph
3260 pointers are in sync with the frame matrix. */
3261 if (sync_p)
3262 sync_window_with_frame_matrix_rows (w);
3264 /* Check that no pointers are lost. */
3265 CHECK_MATRIX (m);
3268 /* Next window on same level. */
3269 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3274 #if GLYPH_DEBUG
3276 /* Check that window and frame matrices agree about their
3277 understanding where glyphs of the rows are to find. For each
3278 window in the window tree rooted at W, check that rows in the
3279 matrices of leaf window agree with their frame matrices about
3280 glyph pointers. */
3282 void
3283 check_window_matrix_pointers (w)
3284 struct window *w;
3286 while (w)
3288 if (!NILP (w->hchild))
3289 check_window_matrix_pointers (XWINDOW (w->hchild));
3290 else if (!NILP (w->vchild))
3291 check_window_matrix_pointers (XWINDOW (w->vchild));
3292 else
3294 struct frame *f = XFRAME (w->frame);
3295 check_matrix_pointers (w->desired_matrix, f->desired_matrix);
3296 check_matrix_pointers (w->current_matrix, f->current_matrix);
3299 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3304 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3305 a window and FRAME_MATRIX is the corresponding frame matrix. For
3306 each row in WINDOW_MATRIX check that it's a slice of the
3307 corresponding frame row. If it isn't, abort. */
3309 static void
3310 check_matrix_pointers (window_matrix, frame_matrix)
3311 struct glyph_matrix *window_matrix, *frame_matrix;
3313 /* Row number in WINDOW_MATRIX. */
3314 int i = 0;
3316 /* Row number corresponding to I in FRAME_MATRIX. */
3317 int j = window_matrix->matrix_y;
3319 /* For all rows check that the row in the window matrix is a
3320 slice of the row in the frame matrix. If it isn't we didn't
3321 mirror an operation on the frame matrix correctly. */
3322 while (i < window_matrix->nrows)
3324 if (!glyph_row_slice_p (window_matrix->rows + i,
3325 frame_matrix->rows + j))
3326 abort ();
3327 ++i, ++j;
3331 #endif /* GLYPH_DEBUG != 0 */
3335 /**********************************************************************
3336 VPOS and HPOS translations
3337 **********************************************************************/
3339 #if GLYPH_DEBUG
3341 /* Translate vertical position VPOS which is relative to window W to a
3342 vertical position relative to W's frame. */
3344 static int
3345 window_to_frame_vpos (w, vpos)
3346 struct window *w;
3347 int vpos;
3349 struct frame *f = XFRAME (w->frame);
3351 xassert (!FRAME_WINDOW_P (f));
3352 xassert (vpos >= 0 && vpos <= w->desired_matrix->nrows);
3353 vpos += WINDOW_TOP_EDGE_LINE (w);
3354 xassert (vpos >= 0 && vpos <= FRAME_LINES (f));
3355 return vpos;
3359 /* Translate horizontal position HPOS which is relative to window W to
3360 a horizontal position relative to W's frame. */
3362 static int
3363 window_to_frame_hpos (w, hpos)
3364 struct window *w;
3365 int hpos;
3367 xassert (!FRAME_WINDOW_P (XFRAME (w->frame)));
3368 hpos += WINDOW_LEFT_EDGE_COL (w);
3369 return hpos;
3372 #endif /* GLYPH_DEBUG */
3376 /**********************************************************************
3377 Redrawing Frames
3378 **********************************************************************/
3380 DEFUN ("redraw-frame", Fredraw_frame, Sredraw_frame, 1, 1, 0,
3381 doc: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3382 (frame)
3383 Lisp_Object frame;
3385 struct frame *f;
3387 CHECK_LIVE_FRAME (frame);
3388 f = XFRAME (frame);
3390 /* Ignore redraw requests, if frame has no glyphs yet.
3391 (Implementation note: It still has to be checked why we are
3392 called so early here). */
3393 if (!glyphs_initialized_initially_p)
3394 return Qnil;
3396 update_begin (f);
3397 #ifdef MSDOS
3398 if (FRAME_MSDOS_P (f))
3399 FRAME_TERMINAL (f)->set_terminal_modes_hook (FRAME_TERMINAL (f));
3400 #endif
3401 clear_frame (f);
3402 clear_current_matrices (f);
3403 update_end (f);
3404 if (FRAME_TERMCAP_P (f))
3405 fflush (FRAME_TTY (f)->output);
3406 windows_or_buffers_changed++;
3407 /* Mark all windows as inaccurate, so that every window will have
3408 its redisplay done. */
3409 mark_window_display_accurate (FRAME_ROOT_WINDOW (f), 0);
3410 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
3411 f->garbaged = 0;
3412 return Qnil;
3416 /* Redraw frame F. This is nothing more than a call to the Lisp
3417 function redraw-frame. */
3419 void
3420 redraw_frame (f)
3421 struct frame *f;
3423 Lisp_Object frame;
3424 XSETFRAME (frame, f);
3425 Fredraw_frame (frame);
3429 DEFUN ("redraw-display", Fredraw_display, Sredraw_display, 0, 0, "",
3430 doc: /* Clear and redisplay all visible frames. */)
3433 Lisp_Object tail, frame;
3435 FOR_EACH_FRAME (tail, frame)
3436 if (FRAME_VISIBLE_P (XFRAME (frame)))
3437 Fredraw_frame (frame);
3439 return Qnil;
3443 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3444 visible frames marked as garbaged. */
3446 void
3447 redraw_garbaged_frames ()
3449 Lisp_Object tail, frame;
3451 FOR_EACH_FRAME (tail, frame)
3452 if (FRAME_VISIBLE_P (XFRAME (frame))
3453 && FRAME_GARBAGED_P (XFRAME (frame)))
3454 Fredraw_frame (frame);
3459 /***********************************************************************
3460 Direct Operations
3461 ***********************************************************************/
3463 /* Try to update display and current glyph matrix directly.
3465 This function is called after a character G has been inserted into
3466 current_buffer. It tries to update the current glyph matrix and
3467 perform appropriate screen output to reflect the insertion. If it
3468 succeeds, the global flag redisplay_performed_directly_p will be
3469 set to 1, and thereby prevent the more costly general redisplay
3470 from running (see redisplay_internal).
3472 This function is not called for `hairy' character insertions.
3473 In particular, it is not called when after or before change
3474 functions exist, like they are used by font-lock. See keyboard.c
3475 for details where this function is called. */
3478 direct_output_for_insert (g)
3479 int g;
3481 register struct frame *f = SELECTED_FRAME ();
3482 struct window *w = XWINDOW (selected_window);
3483 struct it it, it2;
3484 struct glyph_row *glyph_row;
3485 struct glyph *glyphs, *glyph, *end;
3486 int n;
3487 /* Non-null means that redisplay of W is based on window matrices. */
3488 int window_redisplay_p = FRAME_WINDOW_P (f);
3489 /* Non-null means we are in overwrite mode. */
3490 int overwrite_p = !NILP (current_buffer->overwrite_mode);
3491 int added_width;
3492 struct text_pos pos;
3493 int delta, delta_bytes;
3495 /* Not done directly. */
3496 redisplay_performed_directly_p = 0;
3498 /* Quickly give up for some common cases. */
3499 if (cursor_in_echo_area
3500 /* Give up if fonts have changed. */
3501 || fonts_changed_p
3502 /* Give up if face attributes have been changed. */
3503 || face_change_count
3504 /* Give up if cursor position not really known. */
3505 || !display_completed
3506 /* Give up if buffer appears in two places. */
3507 || buffer_shared > 1
3508 /* Give up if currently displaying a message instead of the
3509 minibuffer contents. */
3510 || (EQ (selected_window, minibuf_window)
3511 && EQ (minibuf_window, echo_area_window))
3512 /* Give up for hscrolled mini-buffer because display of the prompt
3513 is handled specially there (see display_line). */
3514 || (MINI_WINDOW_P (w) && XFASTINT (w->hscroll))
3515 /* Give up if overwriting in the middle of a line. */
3516 || (overwrite_p
3517 && PT != ZV
3518 && FETCH_BYTE (PT) != '\n')
3519 /* Give up for tabs and line ends. */
3520 || g == '\t'
3521 || g == '\n'
3522 || g == '\r'
3523 || (g == ' ' && !NILP (current_buffer->word_wrap))
3524 /* Give up if unable to display the cursor in the window. */
3525 || w->cursor.vpos < 0
3526 /* Give up if we are showing a message or just cleared the message
3527 because we might need to resize the echo area window. */
3528 || !NILP (echo_area_buffer[0])
3529 || !NILP (echo_area_buffer[1])
3530 || (glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos),
3531 /* Can't do it in a continued line because continuation
3532 lines would change. */
3533 (glyph_row->continued_p
3534 || glyph_row->exact_window_width_line_p
3535 /* Can't use this method if the line overlaps others or is
3536 overlapped by others because these other lines would
3537 have to be redisplayed. */
3538 || glyph_row->overlapping_p
3539 || glyph_row->overlapped_p))
3540 /* Can't do it for partial width windows on terminal frames
3541 because we can't clear to eol in such a window. */
3542 || (!window_redisplay_p && !WINDOW_FULL_WIDTH_P (w)))
3543 return 0;
3545 /* If we can't insert glyphs, we can use this method only
3546 at the end of a line. */
3547 if (!FRAME_CHAR_INS_DEL_OK (f))
3548 if (PT != ZV && FETCH_BYTE (PT_BYTE) != '\n')
3549 return 0;
3551 /* Set up a display iterator structure for W. Glyphs will be
3552 produced in scratch_glyph_row. Current position is W's cursor
3553 position. */
3554 clear_glyph_row (&scratch_glyph_row);
3555 SET_TEXT_POS (pos, PT, PT_BYTE);
3556 DEC_TEXT_POS (pos, !NILP (current_buffer->enable_multibyte_characters));
3557 init_iterator (&it, w, CHARPOS (pos), BYTEPOS (pos), &scratch_glyph_row,
3558 DEFAULT_FACE_ID);
3560 glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3561 if (glyph_row->mouse_face_p)
3562 return 0;
3564 /* Give up if highlighting trailing whitespace and we have trailing
3565 whitespace in glyph_row. We would have to remove the trailing
3566 whitespace face in that case. */
3567 if (!NILP (Vshow_trailing_whitespace)
3568 && glyph_row->used[TEXT_AREA])
3570 struct glyph *last;
3572 last = glyph_row->glyphs[TEXT_AREA] + glyph_row->used[TEXT_AREA] - 1;
3573 if (last->type == STRETCH_GLYPH
3574 || (last->type == CHAR_GLYPH
3575 && last->u.ch == ' '))
3576 return 0;
3579 /* Give up if there are overlay strings at pos. This would fail
3580 if the overlay string has newlines in it. */
3581 if (STRINGP (it.string))
3582 return 0;
3584 it.hpos = w->cursor.hpos;
3585 it.vpos = w->cursor.vpos;
3586 it.current_x = w->cursor.x + it.first_visible_x;
3587 it.current_y = w->cursor.y;
3588 it.end_charpos = PT;
3589 it.stop_charpos = min (PT, it.stop_charpos);
3590 it.stop_charpos = max (IT_CHARPOS (it), it.stop_charpos);
3592 /* More than one display element may be returned for PT - 1 if
3593 (i) it's a control character which is translated into `\003' or
3594 `^C', or (ii) it has a display table entry, or (iii) it's a
3595 combination of both. */
3596 delta = delta_bytes = 0;
3597 while (get_next_display_element (&it))
3599 PRODUCE_GLYPHS (&it);
3601 /* Give up if glyph doesn't fit completely on the line. */
3602 if (it.current_x >= it.last_visible_x)
3603 return 0;
3605 /* Give up if new glyph has different ascent or descent than
3606 the original row, or if it is not a character glyph. */
3607 if (glyph_row->ascent != it.ascent
3608 || glyph_row->height != it.ascent + it.descent
3609 || glyph_row->phys_ascent != it.phys_ascent
3610 || glyph_row->phys_height != it.phys_ascent + it.phys_descent
3611 || it.what != IT_CHARACTER)
3612 return 0;
3614 delta += 1;
3615 delta_bytes += it.len;
3616 set_iterator_to_next (&it, 1);
3619 /* Give up if we hit the right edge of the window. We would have
3620 to insert truncation or continuation glyphs. */
3621 added_width = it.current_x - (w->cursor.x + it.first_visible_x);
3622 if (glyph_row->pixel_width + added_width >= it.last_visible_x)
3623 return 0;
3625 /* Give up if there is a \t following in the line. */
3626 it2 = it;
3627 it2.end_charpos = ZV;
3628 it2.stop_charpos = min (it2.stop_charpos, ZV);
3629 while (get_next_display_element (&it2)
3630 && !ITERATOR_AT_END_OF_LINE_P (&it2))
3632 if (it2.c == '\t')
3633 return 0;
3634 set_iterator_to_next (&it2, 1);
3637 /* Number of new glyphs produced. */
3638 n = it.glyph_row->used[TEXT_AREA];
3640 /* Start and end of glyphs in original row. */
3641 glyphs = glyph_row->glyphs[TEXT_AREA] + w->cursor.hpos;
3642 end = glyph_row->glyphs[1 + TEXT_AREA];
3644 /* Make room for new glyphs, then insert them. */
3645 xassert (end - glyphs - n >= 0);
3646 safe_bcopy ((char *) glyphs, (char *) (glyphs + n),
3647 (end - glyphs - n) * sizeof (*end));
3648 bcopy (it.glyph_row->glyphs[TEXT_AREA], glyphs, n * sizeof *glyphs);
3649 glyph_row->used[TEXT_AREA] = min (glyph_row->used[TEXT_AREA] + n,
3650 end - glyph_row->glyphs[TEXT_AREA]);
3652 /* Compute new line width. */
3653 glyph = glyph_row->glyphs[TEXT_AREA];
3654 end = glyph + glyph_row->used[TEXT_AREA];
3655 glyph_row->pixel_width = glyph_row->x;
3656 while (glyph < end)
3658 glyph_row->pixel_width += glyph->pixel_width;
3659 ++glyph;
3662 /* Increment buffer positions for glyphs following the newly
3663 inserted ones. */
3664 for (glyph = glyphs + n; glyph < end; ++glyph)
3665 if (glyph->charpos > 0 && BUFFERP (glyph->object))
3666 glyph->charpos += delta;
3668 if (MATRIX_ROW_END_CHARPOS (glyph_row) > 0)
3670 MATRIX_ROW_END_CHARPOS (glyph_row) += delta;
3671 MATRIX_ROW_END_BYTEPOS (glyph_row) += delta_bytes;
3674 /* Adjust positions in lines following the one we are in. */
3675 increment_matrix_positions (w->current_matrix,
3676 w->cursor.vpos + 1,
3677 w->current_matrix->nrows,
3678 delta, delta_bytes);
3680 glyph_row->contains_overlapping_glyphs_p
3681 |= it.glyph_row->contains_overlapping_glyphs_p;
3683 glyph_row->displays_text_p = 1;
3684 w->window_end_vpos = make_number (max (w->cursor.vpos,
3685 XFASTINT (w->window_end_vpos)));
3687 if (!NILP (Vshow_trailing_whitespace))
3688 highlight_trailing_whitespace (it.f, glyph_row);
3690 /* Write glyphs. If at end of row, we can simply call write_glyphs.
3691 In the middle, we have to insert glyphs. Note that this is now
3692 implemented for X frames. The implementation uses updated_window
3693 and updated_row. */
3694 updated_row = glyph_row;
3695 updated_area = TEXT_AREA;
3696 update_begin (f);
3697 if (FRAME_RIF (f))
3699 FRAME_RIF (f)->update_window_begin_hook (w);
3701 if (glyphs == end - n
3702 /* In front of a space added by append_space. */
3703 || (glyphs == end - n - 1
3704 && (end - n)->charpos <= 0))
3705 FRAME_RIF (f)->write_glyphs (glyphs, n);
3706 else
3707 FRAME_RIF (f)->insert_glyphs (glyphs, n);
3709 else
3711 if (glyphs == end - n)
3712 write_glyphs (f, glyphs, n);
3713 else
3714 insert_glyphs (f, glyphs, n);
3717 w->cursor.hpos += n;
3718 w->cursor.x = it.current_x - it.first_visible_x;
3719 xassert (w->cursor.hpos >= 0
3720 && w->cursor.hpos < w->desired_matrix->matrix_w);
3722 /* How to set the cursor differs depending on whether we are
3723 using a frame matrix or a window matrix. Note that when
3724 a frame matrix is used, cursor_to expects frame coordinates,
3725 and the X and Y parameters are not used. */
3726 if (window_redisplay_p)
3727 FRAME_RIF (f)->cursor_to (w->cursor.vpos, w->cursor.hpos,
3728 w->cursor.y, w->cursor.x);
3729 else
3731 int x, y;
3732 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3733 + (INTEGERP (w->left_margin_cols)
3734 ? XFASTINT (w->left_margin_cols)
3735 : 0));
3736 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3737 cursor_to (f, y, x);
3740 #ifdef HAVE_WINDOW_SYSTEM
3741 update_window_fringes (w, 0);
3742 #endif
3744 if (FRAME_RIF (f))
3745 FRAME_RIF (f)->update_window_end_hook (w, 1, 0);
3746 update_end (f);
3747 updated_row = NULL;
3748 if (FRAME_TERMCAP_P (f))
3749 fflush (FRAME_TTY (f)->output);
3751 TRACE ((stderr, "direct output for insert\n"));
3752 mark_window_display_accurate (it.window, 1);
3753 redisplay_performed_directly_p = 1;
3754 return 1;
3758 /* Perform a direct display update for moving PT by N positions
3759 left or right. N < 0 means a movement backwards. This function
3760 is currently only called for N == 1 or N == -1. */
3763 direct_output_forward_char (n)
3764 int n;
3766 struct frame *f = SELECTED_FRAME ();
3767 struct window *w = XWINDOW (selected_window);
3768 struct glyph_row *row;
3770 /* Give up if point moved out of or into a composition. */
3771 if (check_point_in_composition (current_buffer, XINT (w->last_point),
3772 current_buffer, PT))
3773 return 0;
3775 /* Give up if face attributes have been changed. */
3776 if (face_change_count)
3777 return 0;
3779 /* Give up if current matrix is not up to date or we are
3780 displaying a message. */
3781 if (!display_completed || cursor_in_echo_area)
3782 return 0;
3784 /* Give up if the buffer's direction is reversed. */
3785 if (!NILP (XBUFFER (w->buffer)->direction_reversed))
3786 return 0;
3788 /* Can't use direct output if highlighting a region. */
3789 if (!NILP (Vtransient_mark_mode) && !NILP (current_buffer->mark_active))
3790 return 0;
3792 /* Can't use direct output if highlighting trailing whitespace. */
3793 if (!NILP (Vshow_trailing_whitespace))
3794 return 0;
3796 /* Give up if we are showing a message or just cleared the message
3797 because we might need to resize the echo area window. */
3798 if (!NILP (echo_area_buffer[0]) || !NILP (echo_area_buffer[1]))
3799 return 0;
3801 /* Give up if currently displaying a message instead of the
3802 minibuffer contents. */
3803 if (XWINDOW (minibuf_window) == w
3804 && EQ (minibuf_window, echo_area_window))
3805 return 0;
3807 /* Give up if we don't know where the cursor is. */
3808 if (w->cursor.vpos < 0)
3809 return 0;
3811 row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3813 /* Give up if PT is outside of the last known cursor row. */
3814 if (PT <= MATRIX_ROW_START_CHARPOS (row)
3815 || PT >= MATRIX_ROW_END_CHARPOS (row))
3816 return 0;
3818 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
3820 w->last_cursor = w->cursor;
3821 XSETFASTINT (w->last_point, PT);
3823 xassert (w->cursor.hpos >= 0
3824 && w->cursor.hpos < w->desired_matrix->matrix_w);
3826 if (FRAME_WINDOW_P (f))
3827 FRAME_RIF (f)->cursor_to (w->cursor.vpos, w->cursor.hpos,
3828 w->cursor.y, w->cursor.x);
3829 else
3831 int x, y;
3832 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3833 + (INTEGERP (w->left_margin_cols)
3834 ? XFASTINT (w->left_margin_cols)
3835 : 0));
3836 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3837 cursor_to (f, y, x);
3840 if (FRAME_TERMCAP_P (f))
3841 fflush (FRAME_TTY (f)->output);
3842 redisplay_performed_directly_p = 1;
3843 return 1;
3848 /***********************************************************************
3849 Frame Update
3850 ***********************************************************************/
3852 /* Update frame F based on the data in desired matrices.
3854 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3855 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3856 scrolling.
3858 Value is non-zero if redisplay was stopped due to pending input. */
3861 update_frame (f, force_p, inhibit_hairy_id_p)
3862 struct frame *f;
3863 int force_p;
3864 int inhibit_hairy_id_p;
3866 /* 1 means display has been paused because of pending input. */
3867 int paused_p;
3868 struct window *root_window = XWINDOW (f->root_window);
3870 if (redisplay_dont_pause)
3871 force_p = 1;
3872 #if PERIODIC_PREEMPTION_CHECKING
3873 else if (NILP (Vredisplay_preemption_period))
3874 force_p = 1;
3875 else if (!force_p && NUMBERP (Vredisplay_preemption_period))
3877 EMACS_TIME tm;
3878 double p = XFLOATINT (Vredisplay_preemption_period);
3879 int sec, usec;
3881 if (detect_input_pending_ignore_squeezables ())
3883 paused_p = 1;
3884 goto do_pause;
3887 sec = (int) p;
3888 usec = (p - sec) * 1000000;
3890 EMACS_GET_TIME (tm);
3891 EMACS_SET_SECS_USECS (preemption_period, sec, usec);
3892 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
3894 #endif
3896 if (FRAME_WINDOW_P (f))
3898 /* We are working on window matrix basis. All windows whose
3899 flag must_be_updated_p is set have to be updated. */
3901 /* Record that we are not working on frame matrices. */
3902 set_frame_matrix_frame (NULL);
3904 /* Update all windows in the window tree of F, maybe stopping
3905 when pending input is detected. */
3906 update_begin (f);
3908 /* Update the menu bar on X frames that don't have toolkit
3909 support. */
3910 if (WINDOWP (f->menu_bar_window))
3911 update_window (XWINDOW (f->menu_bar_window), 1);
3913 /* Update the tool-bar window, if present. */
3914 if (WINDOWP (f->tool_bar_window))
3916 struct window *w = XWINDOW (f->tool_bar_window);
3918 /* Update tool-bar window. */
3919 if (w->must_be_updated_p)
3921 Lisp_Object tem;
3923 update_window (w, 1);
3924 w->must_be_updated_p = 0;
3926 /* Swap tool-bar strings. We swap because we want to
3927 reuse strings. */
3928 tem = f->current_tool_bar_string;
3929 f->current_tool_bar_string = f->desired_tool_bar_string;
3930 f->desired_tool_bar_string = tem;
3935 /* Update windows. */
3936 paused_p = update_window_tree (root_window, force_p);
3937 update_end (f);
3939 /* This flush is a performance bottleneck under X,
3940 and it doesn't seem to be necessary anyway (in general).
3941 It is necessary when resizing the window with the mouse, or
3942 at least the fringes are not redrawn in a timely manner. ++kfs */
3943 if (f->force_flush_display_p)
3945 FRAME_RIF (f)->flush_display (f);
3946 f->force_flush_display_p = 0;
3949 else
3951 /* We are working on frame matrix basis. Set the frame on whose
3952 frame matrix we operate. */
3953 set_frame_matrix_frame (f);
3955 /* Build F's desired matrix from window matrices. */
3956 build_frame_matrix (f);
3958 /* Update the display */
3959 update_begin (f);
3960 paused_p = update_frame_1 (f, force_p, inhibit_hairy_id_p);
3961 update_end (f);
3963 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
3965 if (FRAME_TTY (f)->termscript)
3966 fflush (FRAME_TTY (f)->termscript);
3967 if (FRAME_TERMCAP_P (f))
3968 fflush (FRAME_TTY (f)->output);
3971 /* Check window matrices for lost pointers. */
3972 #if GLYPH_DEBUG
3973 check_window_matrix_pointers (root_window);
3974 add_frame_display_history (f, paused_p);
3975 #endif
3978 do_pause:
3979 /* Reset flags indicating that a window should be updated. */
3980 set_window_update_flags (root_window, 0);
3982 display_completed = !paused_p;
3983 return paused_p;
3988 /************************************************************************
3989 Window-based updates
3990 ************************************************************************/
3992 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3993 don't stop updating when input is pending. */
3995 static int
3996 update_window_tree (w, force_p)
3997 struct window *w;
3998 int force_p;
4000 int paused_p = 0;
4002 while (w && !paused_p)
4004 if (!NILP (w->hchild))
4005 paused_p |= update_window_tree (XWINDOW (w->hchild), force_p);
4006 else if (!NILP (w->vchild))
4007 paused_p |= update_window_tree (XWINDOW (w->vchild), force_p);
4008 else if (w->must_be_updated_p)
4009 paused_p |= update_window (w, force_p);
4011 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4014 return paused_p;
4018 /* Update window W if its flag must_be_updated_p is non-zero. If
4019 FORCE_P is non-zero, don't stop updating if input is pending. */
4021 void
4022 update_single_window (w, force_p)
4023 struct window *w;
4024 int force_p;
4026 if (w->must_be_updated_p)
4028 struct frame *f = XFRAME (WINDOW_FRAME (w));
4030 /* Record that this is not a frame-based redisplay. */
4031 set_frame_matrix_frame (NULL);
4033 if (redisplay_dont_pause)
4034 force_p = 1;
4035 #if PERIODIC_PREEMPTION_CHECKING
4036 else if (NILP (Vredisplay_preemption_period))
4037 force_p = 1;
4038 else if (!force_p && NUMBERP (Vredisplay_preemption_period))
4040 EMACS_TIME tm;
4041 double p = XFLOATINT (Vredisplay_preemption_period);
4042 int sec, usec;
4044 sec = (int) p;
4045 usec = (p - sec) * 1000000;
4047 EMACS_GET_TIME (tm);
4048 EMACS_SET_SECS_USECS (preemption_period, sec, usec);
4049 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
4051 #endif
4053 /* Update W. */
4054 update_begin (f);
4055 update_window (w, force_p);
4056 update_end (f);
4058 /* Reset flag in W. */
4059 w->must_be_updated_p = 0;
4063 #ifdef HAVE_WINDOW_SYSTEM
4065 /* Redraw lines from the current matrix of window W that are
4066 overlapped by other rows. YB is bottom-most y-position in W. */
4068 static void
4069 redraw_overlapped_rows (w, yb)
4070 struct window *w;
4071 int yb;
4073 int i;
4074 struct frame *f = XFRAME (WINDOW_FRAME (w));
4076 /* If rows overlapping others have been changed, the rows being
4077 overlapped have to be redrawn. This won't draw lines that have
4078 already been drawn in update_window_line because overlapped_p in
4079 desired rows is 0, so after row assignment overlapped_p in
4080 current rows is 0. */
4081 for (i = 0; i < w->current_matrix->nrows; ++i)
4083 struct glyph_row *row = w->current_matrix->rows + i;
4085 if (!row->enabled_p)
4086 break;
4087 else if (row->mode_line_p)
4088 continue;
4090 if (row->overlapped_p)
4092 enum glyph_row_area area;
4094 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
4096 updated_row = row;
4097 updated_area = area;
4098 FRAME_RIF (f)->cursor_to (i, 0, row->y,
4099 area == TEXT_AREA ? row->x : 0);
4100 if (row->used[area])
4101 FRAME_RIF (f)->write_glyphs (row->glyphs[area],
4102 row->used[area]);
4103 FRAME_RIF (f)->clear_end_of_line (-1);
4106 row->overlapped_p = 0;
4109 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4110 break;
4115 /* Redraw lines from the current matrix of window W that overlap
4116 others. YB is bottom-most y-position in W. */
4118 static void
4119 redraw_overlapping_rows (w, yb)
4120 struct window *w;
4121 int yb;
4123 int i, bottom_y;
4124 struct glyph_row *row;
4125 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4127 for (i = 0; i < w->current_matrix->nrows; ++i)
4129 row = w->current_matrix->rows + i;
4131 if (!row->enabled_p)
4132 break;
4133 else if (row->mode_line_p)
4134 continue;
4136 bottom_y = MATRIX_ROW_BOTTOM_Y (row);
4138 if (row->overlapping_p)
4140 int overlaps = 0;
4142 if (MATRIX_ROW_OVERLAPS_PRED_P (row) && i > 0
4143 && !MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p)
4144 overlaps |= OVERLAPS_PRED;
4145 if (MATRIX_ROW_OVERLAPS_SUCC_P (row) && bottom_y < yb
4146 && !MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p)
4147 overlaps |= OVERLAPS_SUCC;
4149 if (overlaps)
4151 if (row->used[LEFT_MARGIN_AREA])
4152 rif->fix_overlapping_area (w, row, LEFT_MARGIN_AREA, overlaps);
4154 if (row->used[TEXT_AREA])
4155 rif->fix_overlapping_area (w, row, TEXT_AREA, overlaps);
4157 if (row->used[RIGHT_MARGIN_AREA])
4158 rif->fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, overlaps);
4160 /* Record in neighbour rows that ROW overwrites part of
4161 their display. */
4162 if (overlaps & OVERLAPS_PRED)
4163 MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p = 1;
4164 if (overlaps & OVERLAPS_SUCC)
4165 MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p = 1;
4169 if (bottom_y >= yb)
4170 break;
4174 #endif /* HAVE_WINDOW_SYSTEM */
4177 #ifdef GLYPH_DEBUG
4179 /* Check that no row in the current matrix of window W is enabled
4180 which is below what's displayed in the window. */
4182 void
4183 check_current_matrix_flags (w)
4184 struct window *w;
4186 int last_seen_p = 0;
4187 int i, yb = window_text_bottom_y (w);
4189 for (i = 0; i < w->current_matrix->nrows - 1; ++i)
4191 struct glyph_row *row = MATRIX_ROW (w->current_matrix, i);
4192 if (!last_seen_p && MATRIX_ROW_BOTTOM_Y (row) >= yb)
4193 last_seen_p = 1;
4194 else if (last_seen_p && row->enabled_p)
4195 abort ();
4199 #endif /* GLYPH_DEBUG */
4202 /* Update display of window W. FORCE_P non-zero means that we should
4203 not stop when detecting pending input. */
4205 static int
4206 update_window (w, force_p)
4207 struct window *w;
4208 int force_p;
4210 struct glyph_matrix *desired_matrix = w->desired_matrix;
4211 int paused_p;
4212 #if !PERIODIC_PREEMPTION_CHECKING
4213 int preempt_count = baud_rate / 2400 + 1;
4214 #endif
4215 extern int input_pending;
4216 extern Lisp_Object do_mouse_tracking;
4217 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4218 #if GLYPH_DEBUG
4219 /* Check that W's frame doesn't have glyph matrices. */
4220 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w))));
4221 #endif
4223 /* Check pending input the first time so that we can quickly return. */
4224 #if !PERIODIC_PREEMPTION_CHECKING
4225 if (!force_p)
4226 detect_input_pending_ignore_squeezables ();
4227 #endif
4229 /* If forced to complete the update, or if no input is pending, do
4230 the update. */
4231 if (force_p || !input_pending || !NILP (do_mouse_tracking))
4233 struct glyph_row *row, *end;
4234 struct glyph_row *mode_line_row;
4235 struct glyph_row *header_line_row;
4236 int yb, changed_p = 0, mouse_face_overwritten_p = 0, n_updated;
4238 rif->update_window_begin_hook (w);
4239 yb = window_text_bottom_y (w);
4241 /* If window has a header line, update it before everything else.
4242 Adjust y-positions of other rows by the header line height. */
4243 row = desired_matrix->rows;
4244 end = row + desired_matrix->nrows - 1;
4246 if (row->mode_line_p)
4248 header_line_row = row;
4249 ++row;
4251 else
4252 header_line_row = NULL;
4254 /* Update the mode line, if necessary. */
4255 mode_line_row = MATRIX_MODE_LINE_ROW (desired_matrix);
4256 if (mode_line_row->mode_line_p && mode_line_row->enabled_p)
4258 mode_line_row->y = yb;
4259 update_window_line (w, MATRIX_ROW_VPOS (mode_line_row,
4260 desired_matrix),
4261 &mouse_face_overwritten_p);
4264 /* Find first enabled row. Optimizations in redisplay_internal
4265 may lead to an update with only one row enabled. There may
4266 be also completely empty matrices. */
4267 while (row < end && !row->enabled_p)
4268 ++row;
4270 /* Try reusing part of the display by copying. */
4271 if (row < end && !desired_matrix->no_scrolling_p)
4273 int rc = scrolling_window (w, header_line_row != NULL);
4274 if (rc < 0)
4276 /* All rows were found to be equal. */
4277 paused_p = 0;
4278 goto set_cursor;
4280 else if (rc > 0)
4282 /* We've scrolled the display. */
4283 force_p = 1;
4284 changed_p = 1;
4288 /* Update the rest of the lines. */
4289 for (n_updated = 0; row < end && (force_p || !input_pending); ++row)
4290 if (row->enabled_p)
4292 int vpos = MATRIX_ROW_VPOS (row, desired_matrix);
4293 int i;
4295 /* We'll have to play a little bit with when to
4296 detect_input_pending. If it's done too often,
4297 scrolling large windows with repeated scroll-up
4298 commands will too quickly pause redisplay. */
4299 #if PERIODIC_PREEMPTION_CHECKING
4300 if (!force_p)
4302 EMACS_TIME tm, dif;
4303 EMACS_GET_TIME (tm);
4304 EMACS_SUB_TIME (dif, preemption_next_check, tm);
4305 if (EMACS_TIME_NEG_P (dif))
4307 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
4308 if (detect_input_pending_ignore_squeezables ())
4309 break;
4312 #else
4313 if (!force_p && ++n_updated % preempt_count == 0)
4314 detect_input_pending_ignore_squeezables ();
4315 #endif
4316 changed_p |= update_window_line (w, vpos,
4317 &mouse_face_overwritten_p);
4319 /* Mark all rows below the last visible one in the current
4320 matrix as invalid. This is necessary because of
4321 variable line heights. Consider the case of three
4322 successive redisplays, where the first displays 5
4323 lines, the second 3 lines, and the third 5 lines again.
4324 If the second redisplay wouldn't mark rows in the
4325 current matrix invalid, the third redisplay might be
4326 tempted to optimize redisplay based on lines displayed
4327 in the first redisplay. */
4328 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4329 for (i = vpos + 1; i < w->current_matrix->nrows - 1; ++i)
4330 MATRIX_ROW (w->current_matrix, i)->enabled_p = 0;
4333 /* Was display preempted? */
4334 paused_p = row < end;
4336 set_cursor:
4338 /* Update the header line after scrolling because a new header
4339 line would otherwise overwrite lines at the top of the window
4340 that can be scrolled. */
4341 if (header_line_row && header_line_row->enabled_p)
4343 header_line_row->y = 0;
4344 update_window_line (w, 0, &mouse_face_overwritten_p);
4347 /* Fix the appearance of overlapping/overlapped rows. */
4348 if (!paused_p && !w->pseudo_window_p)
4350 #ifdef HAVE_WINDOW_SYSTEM
4351 if (changed_p && rif->fix_overlapping_area)
4353 redraw_overlapped_rows (w, yb);
4354 redraw_overlapping_rows (w, yb);
4356 #endif
4358 /* Make cursor visible at cursor position of W. */
4359 set_window_cursor_after_update (w);
4361 #if 0 /* Check that current matrix invariants are satisfied. This is
4362 for debugging only. See the comment of check_matrix_invariants. */
4363 IF_DEBUG (check_matrix_invariants (w));
4364 #endif
4367 #if GLYPH_DEBUG
4368 /* Remember the redisplay method used to display the matrix. */
4369 strcpy (w->current_matrix->method, w->desired_matrix->method);
4370 #endif
4372 #ifdef HAVE_WINDOW_SYSTEM
4373 update_window_fringes (w, 0);
4374 #endif
4376 /* End the update of window W. Don't set the cursor if we
4377 paused updating the display because in this case,
4378 set_window_cursor_after_update hasn't been called, and
4379 output_cursor doesn't contain the cursor location. */
4380 rif->update_window_end_hook (w, !paused_p, mouse_face_overwritten_p);
4382 else
4383 paused_p = 1;
4385 #if GLYPH_DEBUG
4386 /* check_current_matrix_flags (w); */
4387 add_window_display_history (w, w->current_matrix->method, paused_p);
4388 #endif
4390 clear_glyph_matrix (desired_matrix);
4392 return paused_p;
4396 /* Update the display of area AREA in window W, row number VPOS.
4397 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
4399 static void
4400 update_marginal_area (w, area, vpos)
4401 struct window *w;
4402 int area, vpos;
4404 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4405 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4407 /* Let functions in xterm.c know what area subsequent X positions
4408 will be relative to. */
4409 updated_area = area;
4411 /* Set cursor to start of glyphs, write them, and clear to the end
4412 of the area. I don't think that something more sophisticated is
4413 necessary here, since marginal areas will not be the default. */
4414 rif->cursor_to (vpos, 0, desired_row->y, 0);
4415 if (desired_row->used[area])
4416 rif->write_glyphs (desired_row->glyphs[area], desired_row->used[area]);
4417 rif->clear_end_of_line (-1);
4421 /* Update the display of the text area of row VPOS in window W.
4422 Value is non-zero if display has changed. */
4424 static int
4425 update_text_area (w, vpos)
4426 struct window *w;
4427 int vpos;
4429 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4430 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4431 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4432 int changed_p = 0;
4434 /* Let functions in xterm.c know what area subsequent X positions
4435 will be relative to. */
4436 updated_area = TEXT_AREA;
4438 /* If rows are at different X or Y, or rows have different height,
4439 or the current row is marked invalid, write the entire line. */
4440 if (!current_row->enabled_p
4441 || desired_row->y != current_row->y
4442 || desired_row->ascent != current_row->ascent
4443 || desired_row->phys_ascent != current_row->phys_ascent
4444 || desired_row->phys_height != current_row->phys_height
4445 || desired_row->visible_height != current_row->visible_height
4446 || current_row->overlapped_p
4447 /* This next line is necessary for correctly redrawing
4448 mouse-face areas after scrolling and other operations.
4449 However, it causes excessive flickering when mouse is moved
4450 across the mode line. Luckily, turning it off for the mode
4451 line doesn't seem to hurt anything. -- cyd.
4452 But it is still needed for the header line. -- kfs. */
4453 || (current_row->mouse_face_p
4454 && !(current_row->mode_line_p && vpos > 0))
4455 || current_row->x != desired_row->x)
4457 rif->cursor_to (vpos, 0, desired_row->y, desired_row->x);
4459 if (desired_row->used[TEXT_AREA])
4460 rif->write_glyphs (desired_row->glyphs[TEXT_AREA],
4461 desired_row->used[TEXT_AREA]);
4463 /* Clear to end of window. */
4464 rif->clear_end_of_line (-1);
4465 changed_p = 1;
4467 /* This erases the cursor. We do this here because
4468 notice_overwritten_cursor cannot easily check this, which
4469 might indicate that the whole functionality of
4470 notice_overwritten_cursor would better be implemented here.
4471 On the other hand, we need notice_overwritten_cursor as long
4472 as mouse highlighting is done asynchronously outside of
4473 redisplay. */
4474 if (vpos == w->phys_cursor.vpos)
4475 w->phys_cursor_on_p = 0;
4477 else
4479 int stop, i, x;
4480 struct glyph *current_glyph = current_row->glyphs[TEXT_AREA];
4481 struct glyph *desired_glyph = desired_row->glyphs[TEXT_AREA];
4482 int overlapping_glyphs_p = current_row->contains_overlapping_glyphs_p;
4483 int desired_stop_pos = desired_row->used[TEXT_AREA];
4484 int abort_skipping = 0;
4486 /* If the desired row extends its face to the text area end, and
4487 unless the current row also does so at the same position,
4488 make sure we write at least one glyph, so that the face
4489 extension actually takes place. */
4490 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row)
4491 && (desired_stop_pos < current_row->used[TEXT_AREA]
4492 || (desired_stop_pos == current_row->used[TEXT_AREA]
4493 && !MATRIX_ROW_EXTENDS_FACE_P (current_row))))
4494 --desired_stop_pos;
4496 stop = min (current_row->used[TEXT_AREA], desired_stop_pos);
4497 i = 0;
4498 x = desired_row->x;
4500 /* Loop over glyphs that current and desired row may have
4501 in common. */
4502 while (i < stop)
4504 int can_skip_p = !abort_skipping;
4506 /* Skip over glyphs that both rows have in common. These
4507 don't have to be written. We can't skip if the last
4508 current glyph overlaps the glyph to its right. For
4509 example, consider a current row of `if ' with the `f' in
4510 Courier bold so that it overlaps the ` ' to its right.
4511 If the desired row is ` ', we would skip over the space
4512 after the `if' and there would remain a pixel from the
4513 `f' on the screen. */
4514 if (overlapping_glyphs_p && i > 0)
4516 struct glyph *glyph = &current_row->glyphs[TEXT_AREA][i - 1];
4517 int left, right;
4519 rif->get_glyph_overhangs (glyph, XFRAME (w->frame),
4520 &left, &right);
4521 can_skip_p = (right == 0 && !abort_skipping);
4524 if (can_skip_p)
4526 int start_hpos = i;
4528 while (i < stop
4529 && GLYPH_EQUAL_P (desired_glyph, current_glyph))
4531 x += desired_glyph->pixel_width;
4532 ++desired_glyph, ++current_glyph, ++i;
4535 /* Consider the case that the current row contains "xxx
4536 ppp ggg" in italic Courier font, and the desired row
4537 is "xxx ggg". The character `p' has lbearing, `g'
4538 has not. The loop above will stop in front of the
4539 first `p' in the current row. If we would start
4540 writing glyphs there, we wouldn't erase the lbearing
4541 of the `p'. The rest of the lbearing problem is then
4542 taken care of by draw_glyphs. */
4543 if (overlapping_glyphs_p
4544 && i > 0
4545 && i < current_row->used[TEXT_AREA]
4546 && (current_row->used[TEXT_AREA]
4547 != desired_row->used[TEXT_AREA]))
4549 int left, right;
4551 rif->get_glyph_overhangs (current_glyph, XFRAME (w->frame),
4552 &left, &right);
4553 while (left > 0 && i > 0)
4555 --i, --desired_glyph, --current_glyph;
4556 x -= desired_glyph->pixel_width;
4557 left -= desired_glyph->pixel_width;
4560 /* Abort the skipping algorithm if we end up before
4561 our starting point, to avoid looping (bug#1070).
4562 This can happen when the lbearing is larger than
4563 the pixel width. */
4564 abort_skipping = (i < start_hpos);
4568 /* Try to avoid writing the entire rest of the desired row
4569 by looking for a resync point. This mainly prevents
4570 mode line flickering in the case the mode line is in
4571 fixed-pitch font, which it usually will be. */
4572 if (i < desired_row->used[TEXT_AREA])
4574 int start_x = x, start_hpos = i;
4575 struct glyph *start = desired_glyph;
4576 int current_x = x;
4577 int skip_first_p = !can_skip_p;
4579 /* Find the next glyph that's equal again. */
4580 while (i < stop
4581 && (skip_first_p
4582 || !GLYPH_EQUAL_P (desired_glyph, current_glyph))
4583 && x == current_x)
4585 x += desired_glyph->pixel_width;
4586 current_x += current_glyph->pixel_width;
4587 ++desired_glyph, ++current_glyph, ++i;
4588 skip_first_p = 0;
4591 if (i == start_hpos || x != current_x)
4593 i = start_hpos;
4594 x = start_x;
4595 desired_glyph = start;
4596 break;
4599 rif->cursor_to (vpos, start_hpos, desired_row->y, start_x);
4600 rif->write_glyphs (start, i - start_hpos);
4601 changed_p = 1;
4605 /* Write the rest. */
4606 if (i < desired_row->used[TEXT_AREA])
4608 rif->cursor_to (vpos, i, desired_row->y, x);
4609 rif->write_glyphs (desired_glyph, desired_row->used[TEXT_AREA] - i);
4610 changed_p = 1;
4613 /* Maybe clear to end of line. */
4614 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row))
4616 /* If new row extends to the end of the text area, nothing
4617 has to be cleared, if and only if we did a write_glyphs
4618 above. This is made sure by setting desired_stop_pos
4619 appropriately above. */
4620 xassert (i < desired_row->used[TEXT_AREA]
4621 || ((desired_row->used[TEXT_AREA]
4622 == current_row->used[TEXT_AREA])
4623 && MATRIX_ROW_EXTENDS_FACE_P (current_row)));
4625 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row))
4627 /* If old row extends to the end of the text area, clear. */
4628 if (i >= desired_row->used[TEXT_AREA])
4629 rif->cursor_to (vpos, i, desired_row->y,
4630 desired_row->pixel_width);
4631 rif->clear_end_of_line (-1);
4632 changed_p = 1;
4634 else if (desired_row->pixel_width < current_row->pixel_width)
4636 /* Otherwise clear to the end of the old row. Everything
4637 after that position should be clear already. */
4638 int x;
4640 if (i >= desired_row->used[TEXT_AREA])
4641 rif->cursor_to (vpos, i, desired_row->y,
4642 desired_row->pixel_width);
4644 /* If cursor is displayed at the end of the line, make sure
4645 it's cleared. Nowadays we don't have a phys_cursor_glyph
4646 with which to erase the cursor (because this method
4647 doesn't work with lbearing/rbearing), so we must do it
4648 this way. */
4649 if (vpos == w->phys_cursor.vpos
4650 && w->phys_cursor.hpos >= desired_row->used[TEXT_AREA])
4652 w->phys_cursor_on_p = 0;
4653 x = -1;
4655 else
4656 x = current_row->pixel_width;
4657 rif->clear_end_of_line (x);
4658 changed_p = 1;
4662 return changed_p;
4666 /* Update row VPOS in window W. Value is non-zero if display has been
4667 changed. */
4669 static int
4670 update_window_line (w, vpos, mouse_face_overwritten_p)
4671 struct window *w;
4672 int vpos, *mouse_face_overwritten_p;
4674 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4675 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4676 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4677 int changed_p = 0;
4679 /* Set the row being updated. This is important to let xterm.c
4680 know what line height values are in effect. */
4681 updated_row = desired_row;
4683 /* A row can be completely invisible in case a desired matrix was
4684 built with a vscroll and then make_cursor_line_fully_visible shifts
4685 the matrix. Make sure to make such rows current anyway, since
4686 we need the correct y-position, for example, in the current matrix. */
4687 if (desired_row->mode_line_p
4688 || desired_row->visible_height > 0)
4690 xassert (desired_row->enabled_p);
4692 /* Update display of the left margin area, if there is one. */
4693 if (!desired_row->full_width_p
4694 && !NILP (w->left_margin_cols))
4696 changed_p = 1;
4697 update_marginal_area (w, LEFT_MARGIN_AREA, vpos);
4700 /* Update the display of the text area. */
4701 if (update_text_area (w, vpos))
4703 changed_p = 1;
4704 if (current_row->mouse_face_p)
4705 *mouse_face_overwritten_p = 1;
4708 /* Update display of the right margin area, if there is one. */
4709 if (!desired_row->full_width_p
4710 && !NILP (w->right_margin_cols))
4712 changed_p = 1;
4713 update_marginal_area (w, RIGHT_MARGIN_AREA, vpos);
4716 /* Draw truncation marks etc. */
4717 if (!current_row->enabled_p
4718 || desired_row->y != current_row->y
4719 || desired_row->visible_height != current_row->visible_height
4720 || desired_row->cursor_in_fringe_p != current_row->cursor_in_fringe_p
4721 || desired_row->overlay_arrow_bitmap != current_row->overlay_arrow_bitmap
4722 || current_row->redraw_fringe_bitmaps_p
4723 || desired_row->mode_line_p != current_row->mode_line_p
4724 || desired_row->exact_window_width_line_p != current_row->exact_window_width_line_p
4725 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row)
4726 != MATRIX_ROW_CONTINUATION_LINE_P (current_row)))
4727 rif->after_update_window_line_hook (desired_row);
4730 /* Update current_row from desired_row. */
4731 make_current (w->desired_matrix, w->current_matrix, vpos);
4732 updated_row = NULL;
4733 return changed_p;
4737 /* Set the cursor after an update of window W. This function may only
4738 be called from update_window. */
4740 static void
4741 set_window_cursor_after_update (w)
4742 struct window *w;
4744 struct frame *f = XFRAME (w->frame);
4745 struct redisplay_interface *rif = FRAME_RIF (f);
4746 int cx, cy, vpos, hpos;
4748 /* Not intended for frame matrix updates. */
4749 xassert (FRAME_WINDOW_P (f));
4751 if (cursor_in_echo_area
4752 && !NILP (echo_area_buffer[0])
4753 /* If we are showing a message instead of the mini-buffer,
4754 show the cursor for the message instead. */
4755 && XWINDOW (minibuf_window) == w
4756 && EQ (minibuf_window, echo_area_window)
4757 /* These cases apply only to the frame that contains
4758 the active mini-buffer window. */
4759 && FRAME_HAS_MINIBUF_P (f)
4760 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
4762 cx = cy = vpos = hpos = 0;
4764 if (cursor_in_echo_area >= 0)
4766 /* If the mini-buffer is several lines high, find the last
4767 line that has any text on it. Note: either all lines
4768 are enabled or none. Otherwise we wouldn't be able to
4769 determine Y. */
4770 struct glyph_row *row, *last_row;
4771 struct glyph *glyph;
4772 int yb = window_text_bottom_y (w);
4774 last_row = NULL;
4775 row = w->current_matrix->rows;
4776 while (row->enabled_p
4777 && (last_row == NULL
4778 || MATRIX_ROW_BOTTOM_Y (row) <= yb))
4780 if (row->used[TEXT_AREA]
4781 && row->glyphs[TEXT_AREA][0].charpos >= 0)
4782 last_row = row;
4783 ++row;
4786 if (last_row)
4788 struct glyph *start = last_row->glyphs[TEXT_AREA];
4789 struct glyph *last = start + last_row->used[TEXT_AREA] - 1;
4791 while (last > start && last->charpos < 0)
4792 --last;
4794 for (glyph = start; glyph < last; ++glyph)
4796 cx += glyph->pixel_width;
4797 ++hpos;
4800 cy = last_row->y;
4801 vpos = MATRIX_ROW_VPOS (last_row, w->current_matrix);
4805 else
4807 cx = w->cursor.x;
4808 cy = w->cursor.y;
4809 hpos = w->cursor.hpos;
4810 vpos = w->cursor.vpos;
4813 /* Window cursor can be out of sync for horizontally split windows. */
4814 hpos = max (0, hpos);
4815 hpos = min (w->current_matrix->matrix_w - 1, hpos);
4816 vpos = max (0, vpos);
4817 vpos = min (w->current_matrix->nrows - 1, vpos);
4818 rif->cursor_to (vpos, hpos, cy, cx);
4822 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4823 tree rooted at W. */
4825 void
4826 set_window_update_flags (w, on_p)
4827 struct window *w;
4828 int on_p;
4830 while (w)
4832 if (!NILP (w->hchild))
4833 set_window_update_flags (XWINDOW (w->hchild), on_p);
4834 else if (!NILP (w->vchild))
4835 set_window_update_flags (XWINDOW (w->vchild), on_p);
4836 else
4837 w->must_be_updated_p = on_p;
4839 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4845 /***********************************************************************
4846 Window-Based Scrolling
4847 ***********************************************************************/
4849 /* Structure describing rows in scrolling_window. */
4851 struct row_entry
4853 /* Number of occurrences of this row in desired and current matrix. */
4854 int old_uses, new_uses;
4856 /* Vpos of row in new matrix. */
4857 int new_line_number;
4859 /* Bucket index of this row_entry in the hash table row_table. */
4860 int bucket;
4862 /* The row described by this entry. */
4863 struct glyph_row *row;
4865 /* Hash collision chain. */
4866 struct row_entry *next;
4869 /* A pool to allocate row_entry structures from, and the size of the
4870 pool. The pool is reallocated in scrolling_window when we find
4871 that we need a larger one. */
4873 static struct row_entry *row_entry_pool;
4874 static int row_entry_pool_size;
4876 /* Index of next free entry in row_entry_pool. */
4878 static int row_entry_idx;
4880 /* The hash table used during scrolling, and the table's size. This
4881 table is used to quickly identify equal rows in the desired and
4882 current matrix. */
4884 static struct row_entry **row_table;
4885 static int row_table_size;
4887 /* Vectors of pointers to row_entry structures belonging to the
4888 current and desired matrix, and the size of the vectors. */
4890 static struct row_entry **old_lines, **new_lines;
4891 static int old_lines_size, new_lines_size;
4893 /* A pool to allocate run structures from, and its size. */
4895 static struct run *run_pool;
4896 static int runs_size;
4898 /* A vector of runs of lines found during scrolling. */
4900 static struct run **runs;
4902 /* Add glyph row ROW to the scrolling hash table during the scrolling
4903 of window W. */
4905 static INLINE struct row_entry *
4906 add_row_entry (w, row)
4907 struct window *w;
4908 struct glyph_row *row;
4910 struct row_entry *entry;
4911 int i = row->hash % row_table_size;
4913 entry = row_table[i];
4914 while (entry && !row_equal_p (w, entry->row, row, 1))
4915 entry = entry->next;
4917 if (entry == NULL)
4919 entry = row_entry_pool + row_entry_idx++;
4920 entry->row = row;
4921 entry->old_uses = entry->new_uses = 0;
4922 entry->new_line_number = 0;
4923 entry->bucket = i;
4924 entry->next = row_table[i];
4925 row_table[i] = entry;
4928 return entry;
4932 /* Try to reuse part of the current display of W by scrolling lines.
4933 HEADER_LINE_P non-zero means W has a header line.
4935 The algorithm is taken from Communications of the ACM, Apr78 "A
4936 Technique for Isolating Differences Between Files." It should take
4937 O(N) time.
4939 A short outline of the steps of the algorithm
4941 1. Skip lines equal at the start and end of both matrices.
4943 2. Enter rows in the current and desired matrix into a symbol
4944 table, counting how often they appear in both matrices.
4946 3. Rows that appear exactly once in both matrices serve as anchors,
4947 i.e. we assume that such lines are likely to have been moved.
4949 4. Starting from anchor lines, extend regions to be scrolled both
4950 forward and backward.
4952 Value is
4954 -1 if all rows were found to be equal.
4955 0 to indicate that we did not scroll the display, or
4956 1 if we did scroll. */
4958 static int
4959 scrolling_window (w, header_line_p)
4960 struct window *w;
4961 int header_line_p;
4963 struct glyph_matrix *desired_matrix = w->desired_matrix;
4964 struct glyph_matrix *current_matrix = w->current_matrix;
4965 int yb = window_text_bottom_y (w);
4966 int i, j, first_old, first_new, last_old, last_new;
4967 int nruns, nbytes, n, run_idx;
4968 struct row_entry *entry;
4969 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4971 /* Skip over rows equal at the start. */
4972 for (i = header_line_p ? 1 : 0; i < current_matrix->nrows - 1; ++i)
4974 struct glyph_row *d = MATRIX_ROW (desired_matrix, i);
4975 struct glyph_row *c = MATRIX_ROW (current_matrix, i);
4977 if (c->enabled_p
4978 && d->enabled_p
4979 && !d->redraw_fringe_bitmaps_p
4980 && c->y == d->y
4981 && MATRIX_ROW_BOTTOM_Y (c) <= yb
4982 && MATRIX_ROW_BOTTOM_Y (d) <= yb
4983 && row_equal_p (w, c, d, 1))
4985 assign_row (c, d);
4986 d->enabled_p = 0;
4988 else
4989 break;
4992 /* Give up if some rows in the desired matrix are not enabled. */
4993 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4994 return -1;
4996 first_old = first_new = i;
4998 /* Set last_new to the index + 1 of the row that reaches the
4999 bottom boundary in the desired matrix. Give up if we find a
5000 disabled row before we reach the bottom boundary. */
5001 i = first_new + 1;
5002 while (i < desired_matrix->nrows - 1)
5004 int bottom;
5006 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
5007 return 0;
5008 bottom = MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix, i));
5009 if (bottom <= yb)
5010 ++i;
5011 if (bottom >= yb)
5012 break;
5015 last_new = i;
5017 /* Set last_old to the index + 1 of the row that reaches the bottom
5018 boundary in the current matrix. We don't look at the enabled
5019 flag here because we plan to reuse part of the display even if
5020 other parts are disabled. */
5021 i = first_old + 1;
5022 while (i < current_matrix->nrows - 1)
5024 int bottom = MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix, i));
5025 if (bottom <= yb)
5026 ++i;
5027 if (bottom >= yb)
5028 break;
5031 last_old = i;
5033 /* Skip over rows equal at the bottom. */
5034 i = last_new;
5035 j = last_old;
5036 while (i - 1 > first_new
5037 && j - 1 > first_old
5038 && MATRIX_ROW (current_matrix, j - 1)->enabled_p
5039 && (MATRIX_ROW (current_matrix, j - 1)->y
5040 == MATRIX_ROW (desired_matrix, i - 1)->y)
5041 && !MATRIX_ROW (desired_matrix, i - 1)->redraw_fringe_bitmaps_p
5042 && row_equal_p (w,
5043 MATRIX_ROW (desired_matrix, i - 1),
5044 MATRIX_ROW (current_matrix, j - 1), 1))
5045 --i, --j;
5046 last_new = i;
5047 last_old = j;
5049 /* Nothing to do if all rows are equal. */
5050 if (last_new == first_new)
5051 return 0;
5053 /* Reallocate vectors, tables etc. if necessary. */
5055 if (current_matrix->nrows > old_lines_size)
5057 old_lines_size = current_matrix->nrows;
5058 nbytes = old_lines_size * sizeof *old_lines;
5059 old_lines = (struct row_entry **) xrealloc (old_lines, nbytes);
5062 if (desired_matrix->nrows > new_lines_size)
5064 new_lines_size = desired_matrix->nrows;
5065 nbytes = new_lines_size * sizeof *new_lines;
5066 new_lines = (struct row_entry **) xrealloc (new_lines, nbytes);
5069 n = desired_matrix->nrows + current_matrix->nrows;
5070 if (3 * n > row_table_size)
5072 row_table_size = next_almost_prime (3 * n);
5073 nbytes = row_table_size * sizeof *row_table;
5074 row_table = (struct row_entry **) xrealloc (row_table, nbytes);
5075 bzero (row_table, nbytes);
5078 if (n > row_entry_pool_size)
5080 row_entry_pool_size = n;
5081 nbytes = row_entry_pool_size * sizeof *row_entry_pool;
5082 row_entry_pool = (struct row_entry *) xrealloc (row_entry_pool, nbytes);
5085 if (desired_matrix->nrows > runs_size)
5087 runs_size = desired_matrix->nrows;
5088 nbytes = runs_size * sizeof *runs;
5089 runs = (struct run **) xrealloc (runs, nbytes);
5090 nbytes = runs_size * sizeof *run_pool;
5091 run_pool = (struct run *) xrealloc (run_pool, nbytes);
5094 nruns = run_idx = 0;
5095 row_entry_idx = 0;
5097 /* Add rows from the current and desired matrix to the hash table
5098 row_hash_table to be able to find equal ones quickly. */
5100 for (i = first_old; i < last_old; ++i)
5102 if (MATRIX_ROW (current_matrix, i)->enabled_p)
5104 entry = add_row_entry (w, MATRIX_ROW (current_matrix, i));
5105 old_lines[i] = entry;
5106 ++entry->old_uses;
5108 else
5109 old_lines[i] = NULL;
5112 for (i = first_new; i < last_new; ++i)
5114 xassert (MATRIX_ROW_ENABLED_P (desired_matrix, i));
5115 entry = add_row_entry (w, MATRIX_ROW (desired_matrix, i));
5116 ++entry->new_uses;
5117 entry->new_line_number = i;
5118 new_lines[i] = entry;
5121 /* Identify moves based on lines that are unique and equal
5122 in both matrices. */
5123 for (i = first_old; i < last_old;)
5124 if (old_lines[i]
5125 && old_lines[i]->old_uses == 1
5126 && old_lines[i]->new_uses == 1)
5128 int j, k;
5129 int new_line = old_lines[i]->new_line_number;
5130 struct run *run = run_pool + run_idx++;
5132 /* Record move. */
5133 run->current_vpos = i;
5134 run->current_y = MATRIX_ROW (current_matrix, i)->y;
5135 run->desired_vpos = new_line;
5136 run->desired_y = MATRIX_ROW (desired_matrix, new_line)->y;
5137 run->nrows = 1;
5138 run->height = MATRIX_ROW (current_matrix, i)->height;
5140 /* Extend backward. */
5141 j = i - 1;
5142 k = new_line - 1;
5143 while (j > first_old
5144 && k > first_new
5145 && old_lines[j] == new_lines[k])
5147 int h = MATRIX_ROW (current_matrix, j)->height;
5148 --run->current_vpos;
5149 --run->desired_vpos;
5150 ++run->nrows;
5151 run->height += h;
5152 run->desired_y -= h;
5153 run->current_y -= h;
5154 --j, --k;
5157 /* Extend forward. */
5158 j = i + 1;
5159 k = new_line + 1;
5160 while (j < last_old
5161 && k < last_new
5162 && old_lines[j] == new_lines[k])
5164 int h = MATRIX_ROW (current_matrix, j)->height;
5165 ++run->nrows;
5166 run->height += h;
5167 ++j, ++k;
5170 /* Insert run into list of all runs. Order runs by copied
5171 pixel lines. Note that we record runs that don't have to
5172 be copied because they are already in place. This is done
5173 because we can avoid calling update_window_line in this
5174 case. */
5175 for (j = 0; j < nruns && runs[j]->height > run->height; ++j)
5177 for (k = nruns; k > j; --k)
5178 runs[k] = runs[k - 1];
5179 runs[j] = run;
5180 ++nruns;
5182 i += run->nrows;
5184 else
5185 ++i;
5187 /* Do the moves. Do it in a way that we don't overwrite something
5188 we want to copy later on. This is not solvable in general
5189 because there is only one display and we don't have a way to
5190 exchange areas on this display. Example:
5192 +-----------+ +-----------+
5193 | A | | B |
5194 +-----------+ --> +-----------+
5195 | B | | A |
5196 +-----------+ +-----------+
5198 Instead, prefer bigger moves, and invalidate moves that would
5199 copy from where we copied to. */
5201 for (i = 0; i < nruns; ++i)
5202 if (runs[i]->nrows > 0)
5204 struct run *r = runs[i];
5206 /* Copy on the display. */
5207 if (r->current_y != r->desired_y)
5209 rif->clear_window_mouse_face (w);
5210 rif->scroll_run_hook (w, r);
5212 /* Invalidate runs that copy from where we copied to. */
5213 for (j = i + 1; j < nruns; ++j)
5215 struct run *p = runs[j];
5217 if ((p->current_y >= r->desired_y
5218 && p->current_y < r->desired_y + r->height)
5219 || (p->current_y + p->height >= r->desired_y
5220 && (p->current_y + p->height
5221 < r->desired_y + r->height)))
5222 p->nrows = 0;
5226 /* Assign matrix rows. */
5227 for (j = 0; j < r->nrows; ++j)
5229 struct glyph_row *from, *to;
5230 int to_overlapped_p;
5232 to = MATRIX_ROW (current_matrix, r->desired_vpos + j);
5233 from = MATRIX_ROW (desired_matrix, r->desired_vpos + j);
5234 to_overlapped_p = to->overlapped_p;
5235 from->redraw_fringe_bitmaps_p = from->fringe_bitmap_periodic_p;
5236 assign_row (to, from);
5237 to->enabled_p = 1, from->enabled_p = 0;
5238 to->overlapped_p = to_overlapped_p;
5242 /* Clear the hash table, for the next time. */
5243 for (i = 0; i < row_entry_idx; ++i)
5244 row_table[row_entry_pool[i].bucket] = NULL;
5246 /* Value is > 0 to indicate that we scrolled the display. */
5247 return nruns;
5252 /************************************************************************
5253 Frame-Based Updates
5254 ************************************************************************/
5256 /* Update the desired frame matrix of frame F.
5258 FORCE_P non-zero means that the update should not be stopped by
5259 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
5260 should not be tried.
5262 Value is non-zero if update was stopped due to pending input. */
5264 static int
5265 update_frame_1 (f, force_p, inhibit_id_p)
5266 struct frame *f;
5267 int force_p;
5268 int inhibit_id_p;
5270 /* Frame matrices to work on. */
5271 struct glyph_matrix *current_matrix = f->current_matrix;
5272 struct glyph_matrix *desired_matrix = f->desired_matrix;
5273 int i;
5274 int pause;
5275 int preempt_count = baud_rate / 2400 + 1;
5276 extern int input_pending;
5278 xassert (current_matrix && desired_matrix);
5280 if (baud_rate != FRAME_COST_BAUD_RATE (f))
5281 calculate_costs (f);
5283 if (preempt_count <= 0)
5284 preempt_count = 1;
5286 #if !PERIODIC_PREEMPTION_CHECKING
5287 if (!force_p && detect_input_pending_ignore_squeezables ())
5289 pause = 1;
5290 goto do_pause;
5292 #endif
5294 /* If we cannot insert/delete lines, it's no use trying it. */
5295 if (!FRAME_LINE_INS_DEL_OK (f))
5296 inhibit_id_p = 1;
5298 /* See if any of the desired lines are enabled; don't compute for
5299 i/d line if just want cursor motion. */
5300 for (i = 0; i < desired_matrix->nrows; i++)
5301 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5302 break;
5304 /* Try doing i/d line, if not yet inhibited. */
5305 if (!inhibit_id_p && i < desired_matrix->nrows)
5306 force_p |= scrolling (f);
5308 /* Update the individual lines as needed. Do bottom line first. */
5309 if (MATRIX_ROW_ENABLED_P (desired_matrix, desired_matrix->nrows - 1))
5310 update_frame_line (f, desired_matrix->nrows - 1);
5312 /* Now update the rest of the lines. */
5313 for (i = 0; i < desired_matrix->nrows - 1 && (force_p || !input_pending); i++)
5315 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5317 if (FRAME_TERMCAP_P (f))
5319 /* Flush out every so many lines.
5320 Also flush out if likely to have more than 1k buffered
5321 otherwise. I'm told that some telnet connections get
5322 really screwed by more than 1k output at once. */
5323 FILE *display_output = FRAME_TTY (f)->output;
5324 if (display_output)
5326 int outq = PENDING_OUTPUT_COUNT (display_output);
5327 if (outq > 900
5328 || (outq > 20 && ((i - 1) % preempt_count == 0)))
5330 fflush (display_output);
5331 if (preempt_count == 1)
5333 #ifdef EMACS_OUTQSIZE
5334 if (EMACS_OUTQSIZE (0, &outq) < 0)
5335 /* Probably not a tty. Ignore the error and reset
5336 the outq count. */
5337 outq = PENDING_OUTPUT_COUNT (FRAME_TTY (f->output));
5338 #endif
5339 outq *= 10;
5340 if (baud_rate <= outq && baud_rate > 0)
5341 sleep (outq / baud_rate);
5347 #if PERIODIC_PREEMPTION_CHECKING
5348 if (!force_p)
5350 EMACS_TIME tm, dif;
5351 EMACS_GET_TIME (tm);
5352 EMACS_SUB_TIME (dif, preemption_next_check, tm);
5353 if (EMACS_TIME_NEG_P (dif))
5355 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
5356 if (detect_input_pending_ignore_squeezables ())
5357 break;
5360 #else
5361 if (!force_p && (i - 1) % preempt_count == 0)
5362 detect_input_pending_ignore_squeezables ();
5363 #endif
5365 update_frame_line (f, i);
5369 pause = (i < FRAME_LINES (f) - 1) ? i : 0;
5371 /* Now just clean up termcap drivers and set cursor, etc. */
5372 if (!pause)
5374 if ((cursor_in_echo_area
5375 /* If we are showing a message instead of the mini-buffer,
5376 show the cursor for the message instead of for the
5377 (now hidden) mini-buffer contents. */
5378 || (EQ (minibuf_window, selected_window)
5379 && EQ (minibuf_window, echo_area_window)
5380 && !NILP (echo_area_buffer[0])))
5381 /* These cases apply only to the frame that contains
5382 the active mini-buffer window. */
5383 && FRAME_HAS_MINIBUF_P (f)
5384 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
5386 int top = WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f)));
5387 int row, col;
5389 if (cursor_in_echo_area < 0)
5391 /* Negative value of cursor_in_echo_area means put
5392 cursor at beginning of line. */
5393 row = top;
5394 col = 0;
5396 else
5398 /* Positive value of cursor_in_echo_area means put
5399 cursor at the end of the prompt. If the mini-buffer
5400 is several lines high, find the last line that has
5401 any text on it. */
5402 row = FRAME_LINES (f);
5405 --row;
5406 col = 0;
5408 if (MATRIX_ROW_ENABLED_P (current_matrix, row))
5410 /* Frame rows are filled up with spaces that
5411 must be ignored here. */
5412 struct glyph_row *r = MATRIX_ROW (current_matrix,
5413 row);
5414 struct glyph *start = r->glyphs[TEXT_AREA];
5415 struct glyph *last = start + r->used[TEXT_AREA];
5417 while (last > start
5418 && (last - 1)->charpos < 0)
5419 --last;
5421 col = last - start;
5424 while (row > top && col == 0);
5426 /* Make sure COL is not out of range. */
5427 if (col >= FRAME_CURSOR_X_LIMIT (f))
5429 /* If we have another row, advance cursor into it. */
5430 if (row < FRAME_LINES (f) - 1)
5432 col = FRAME_LEFT_SCROLL_BAR_COLS (f);
5433 row++;
5435 /* Otherwise move it back in range. */
5436 else
5437 col = FRAME_CURSOR_X_LIMIT (f) - 1;
5441 cursor_to (f, row, col);
5443 else
5445 /* We have only one cursor on terminal frames. Use it to
5446 display the cursor of the selected window. */
5447 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
5448 if (w->cursor.vpos >= 0
5449 /* The cursor vpos may be temporarily out of bounds
5450 in the following situation: There is one window,
5451 with the cursor in the lower half of it. The window
5452 is split, and a message causes a redisplay before
5453 a new cursor position has been computed. */
5454 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
5456 int x = WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos);
5457 int y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
5459 if (INTEGERP (w->left_margin_cols))
5460 x += XFASTINT (w->left_margin_cols);
5462 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
5463 cursor_to (f, y, x);
5468 do_pause:
5470 clear_desired_matrices (f);
5471 return pause;
5475 /* Do line insertions/deletions on frame F for frame-based redisplay. */
5478 scrolling (frame)
5479 struct frame *frame;
5481 int unchanged_at_top, unchanged_at_bottom;
5482 int window_size;
5483 int changed_lines;
5484 int *old_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5485 int *new_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5486 int *draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5487 int *old_draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5488 register int i;
5489 int free_at_end_vpos = FRAME_LINES (frame);
5490 struct glyph_matrix *current_matrix = frame->current_matrix;
5491 struct glyph_matrix *desired_matrix = frame->desired_matrix;
5493 if (!current_matrix)
5494 abort ();
5496 /* Compute hash codes of all the lines. Also calculate number of
5497 changed lines, number of unchanged lines at the beginning, and
5498 number of unchanged lines at the end. */
5499 changed_lines = 0;
5500 unchanged_at_top = 0;
5501 unchanged_at_bottom = FRAME_LINES (frame);
5502 for (i = 0; i < FRAME_LINES (frame); i++)
5504 /* Give up on this scrolling if some old lines are not enabled. */
5505 if (!MATRIX_ROW_ENABLED_P (current_matrix, i))
5506 return 0;
5507 old_hash[i] = line_hash_code (MATRIX_ROW (current_matrix, i));
5508 if (! MATRIX_ROW_ENABLED_P (desired_matrix, i))
5510 /* This line cannot be redrawn, so don't let scrolling mess it. */
5511 new_hash[i] = old_hash[i];
5512 #define INFINITY 1000000 /* Taken from scroll.c */
5513 draw_cost[i] = INFINITY;
5515 else
5517 new_hash[i] = line_hash_code (MATRIX_ROW (desired_matrix, i));
5518 draw_cost[i] = line_draw_cost (desired_matrix, i);
5521 if (old_hash[i] != new_hash[i])
5523 changed_lines++;
5524 unchanged_at_bottom = FRAME_LINES (frame) - i - 1;
5526 else if (i == unchanged_at_top)
5527 unchanged_at_top++;
5528 old_draw_cost[i] = line_draw_cost (current_matrix, i);
5531 /* If changed lines are few, don't allow preemption, don't scroll. */
5532 if ((!FRAME_SCROLL_REGION_OK (frame)
5533 && changed_lines < baud_rate / 2400)
5534 || unchanged_at_bottom == FRAME_LINES (frame))
5535 return 1;
5537 window_size = (FRAME_LINES (frame) - unchanged_at_top
5538 - unchanged_at_bottom);
5540 if (FRAME_SCROLL_REGION_OK (frame))
5541 free_at_end_vpos -= unchanged_at_bottom;
5542 else if (FRAME_MEMORY_BELOW_FRAME (frame))
5543 free_at_end_vpos = -1;
5545 /* If large window, fast terminal and few lines in common between
5546 current frame and desired frame, don't bother with i/d calc. */
5547 if (!FRAME_SCROLL_REGION_OK (frame)
5548 && window_size >= 18 && baud_rate > 2400
5549 && (window_size >=
5550 10 * scrolling_max_lines_saved (unchanged_at_top,
5551 FRAME_LINES (frame) - unchanged_at_bottom,
5552 old_hash, new_hash, draw_cost)))
5553 return 0;
5555 if (window_size < 2)
5556 return 0;
5558 scrolling_1 (frame, window_size, unchanged_at_top, unchanged_at_bottom,
5559 draw_cost + unchanged_at_top - 1,
5560 old_draw_cost + unchanged_at_top - 1,
5561 old_hash + unchanged_at_top - 1,
5562 new_hash + unchanged_at_top - 1,
5563 free_at_end_vpos - unchanged_at_top);
5565 return 0;
5569 /* Count the number of blanks at the start of the vector of glyphs R
5570 which is LEN glyphs long. */
5572 static int
5573 count_blanks (r, len)
5574 struct glyph *r;
5575 int len;
5577 int i;
5579 for (i = 0; i < len; ++i)
5580 if (!CHAR_GLYPH_SPACE_P (r[i]))
5581 break;
5583 return i;
5587 /* Count the number of glyphs in common at the start of the glyph
5588 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
5589 of STR2. Value is the number of equal glyphs equal at the start. */
5591 static int
5592 count_match (str1, end1, str2, end2)
5593 struct glyph *str1, *end1, *str2, *end2;
5595 struct glyph *p1 = str1;
5596 struct glyph *p2 = str2;
5598 while (p1 < end1
5599 && p2 < end2
5600 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1, p2))
5601 ++p1, ++p2;
5603 return p1 - str1;
5607 /* Char insertion/deletion cost vector, from term.c */
5609 extern int *char_ins_del_vector;
5610 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
5613 /* Perform a frame-based update on line VPOS in frame FRAME. */
5615 static void
5616 update_frame_line (f, vpos)
5617 struct frame *f;
5618 int vpos;
5620 struct glyph *obody, *nbody, *op1, *op2, *np1, *nend;
5621 int tem;
5622 int osp, nsp, begmatch, endmatch, olen, nlen;
5623 struct glyph_matrix *current_matrix = f->current_matrix;
5624 struct glyph_matrix *desired_matrix = f->desired_matrix;
5625 struct glyph_row *current_row = MATRIX_ROW (current_matrix, vpos);
5626 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, vpos);
5627 int must_write_whole_line_p;
5628 int write_spaces_p = FRAME_MUST_WRITE_SPACES (f);
5629 int colored_spaces_p = (FACE_FROM_ID (f, DEFAULT_FACE_ID)->background
5630 != FACE_TTY_DEFAULT_BG_COLOR);
5632 if (colored_spaces_p)
5633 write_spaces_p = 1;
5635 /* Current row not enabled means it has unknown contents. We must
5636 write the whole desired line in that case. */
5637 must_write_whole_line_p = !current_row->enabled_p;
5638 if (must_write_whole_line_p)
5640 obody = 0;
5641 olen = 0;
5643 else
5645 obody = MATRIX_ROW_GLYPH_START (current_matrix, vpos);
5646 olen = current_row->used[TEXT_AREA];
5648 /* Ignore trailing spaces, if we can. */
5649 if (!write_spaces_p)
5650 while (olen > 0 && CHAR_GLYPH_SPACE_P (obody[olen-1]))
5651 olen--;
5654 current_row->enabled_p = 1;
5655 current_row->used[TEXT_AREA] = desired_row->used[TEXT_AREA];
5657 /* If desired line is empty, just clear the line. */
5658 if (!desired_row->enabled_p)
5660 nlen = 0;
5661 goto just_erase;
5664 nbody = desired_row->glyphs[TEXT_AREA];
5665 nlen = desired_row->used[TEXT_AREA];
5666 nend = nbody + nlen;
5668 /* If display line has unknown contents, write the whole line. */
5669 if (must_write_whole_line_p)
5671 /* Ignore spaces at the end, if we can. */
5672 if (!write_spaces_p)
5673 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5674 --nlen;
5676 /* Write the contents of the desired line. */
5677 if (nlen)
5679 cursor_to (f, vpos, 0);
5680 write_glyphs (f, nbody, nlen);
5683 /* Don't call clear_end_of_line if we already wrote the whole
5684 line. The cursor will not be at the right margin in that
5685 case but in the line below. */
5686 if (nlen < FRAME_TOTAL_COLS (f))
5688 cursor_to (f, vpos, nlen);
5689 clear_end_of_line (f, FRAME_TOTAL_COLS (f));
5691 else
5692 /* Make sure we are in the right row, otherwise cursor movement
5693 with cmgoto might use `ch' in the wrong row. */
5694 cursor_to (f, vpos, 0);
5696 make_current (desired_matrix, current_matrix, vpos);
5697 return;
5700 /* Pretend trailing spaces are not there at all,
5701 unless for one reason or another we must write all spaces. */
5702 if (!write_spaces_p)
5703 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5704 nlen--;
5706 /* If there's no i/d char, quickly do the best we can without it. */
5707 if (!FRAME_CHAR_INS_DEL_OK (f))
5709 int i, j;
5711 /* Find the first glyph in desired row that doesn't agree with
5712 a glyph in the current row, and write the rest from there on. */
5713 for (i = 0; i < nlen; i++)
5715 if (i >= olen || !GLYPH_EQUAL_P (nbody + i, obody + i))
5717 /* Find the end of the run of different glyphs. */
5718 j = i + 1;
5719 while (j < nlen
5720 && (j >= olen
5721 || !GLYPH_EQUAL_P (nbody + j, obody + j)
5722 || CHAR_GLYPH_PADDING_P (nbody[j])))
5723 ++j;
5725 /* Output this run of non-matching chars. */
5726 cursor_to (f, vpos, i);
5727 write_glyphs (f, nbody + i, j - i);
5728 i = j - 1;
5730 /* Now find the next non-match. */
5734 /* Clear the rest of the line, or the non-clear part of it. */
5735 if (olen > nlen)
5737 cursor_to (f, vpos, nlen);
5738 clear_end_of_line (f, olen);
5741 /* Make current row = desired row. */
5742 make_current (desired_matrix, current_matrix, vpos);
5743 return;
5746 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5747 characters in a row. */
5749 if (!olen)
5751 /* If current line is blank, skip over initial spaces, if
5752 possible, and write the rest. */
5753 if (write_spaces_p)
5754 nsp = 0;
5755 else
5756 nsp = count_blanks (nbody, nlen);
5758 if (nlen > nsp)
5760 cursor_to (f, vpos, nsp);
5761 write_glyphs (f, nbody + nsp, nlen - nsp);
5764 /* Exchange contents between current_frame and new_frame. */
5765 make_current (desired_matrix, current_matrix, vpos);
5766 return;
5769 /* Compute number of leading blanks in old and new contents. */
5770 osp = count_blanks (obody, olen);
5771 nsp = (colored_spaces_p ? 0 : count_blanks (nbody, nlen));
5773 /* Compute number of matching chars starting with first non-blank. */
5774 begmatch = count_match (obody + osp, obody + olen,
5775 nbody + nsp, nbody + nlen);
5777 /* Spaces in new match implicit space past the end of old. */
5778 /* A bug causing this to be a no-op was fixed in 18.29. */
5779 if (!write_spaces_p && osp + begmatch == olen)
5781 np1 = nbody + nsp;
5782 while (np1 + begmatch < nend && CHAR_GLYPH_SPACE_P (np1[begmatch]))
5783 ++begmatch;
5786 /* Avoid doing insert/delete char
5787 just cause number of leading spaces differs
5788 when the following text does not match. */
5789 if (begmatch == 0 && osp != nsp)
5790 osp = nsp = min (osp, nsp);
5792 /* Find matching characters at end of line */
5793 op1 = obody + olen;
5794 np1 = nbody + nlen;
5795 op2 = op1 + begmatch - min (olen - osp, nlen - nsp);
5796 while (op1 > op2
5797 && GLYPH_EQUAL_P (op1 - 1, np1 - 1))
5799 op1--;
5800 np1--;
5802 endmatch = obody + olen - op1;
5804 /* tem gets the distance to insert or delete.
5805 endmatch is how many characters we save by doing so.
5806 Is it worth it? */
5808 tem = (nlen - nsp) - (olen - osp);
5809 if (endmatch && tem
5810 && (!FRAME_CHAR_INS_DEL_OK (f)
5811 || endmatch <= char_ins_del_cost (f)[tem]))
5812 endmatch = 0;
5814 /* nsp - osp is the distance to insert or delete.
5815 If that is nonzero, begmatch is known to be nonzero also.
5816 begmatch + endmatch is how much we save by doing the ins/del.
5817 Is it worth it? */
5819 if (nsp != osp
5820 && (!FRAME_CHAR_INS_DEL_OK (f)
5821 || begmatch + endmatch <= char_ins_del_cost (f)[nsp - osp]))
5823 begmatch = 0;
5824 endmatch = 0;
5825 osp = nsp = min (osp, nsp);
5828 /* Now go through the line, inserting, writing and
5829 deleting as appropriate. */
5831 if (osp > nsp)
5833 cursor_to (f, vpos, nsp);
5834 delete_glyphs (f, osp - nsp);
5836 else if (nsp > osp)
5838 /* If going to delete chars later in line
5839 and insert earlier in the line,
5840 must delete first to avoid losing data in the insert */
5841 if (endmatch && nlen < olen + nsp - osp)
5843 cursor_to (f, vpos, nlen - endmatch + osp - nsp);
5844 delete_glyphs (f, olen + nsp - osp - nlen);
5845 olen = nlen - (nsp - osp);
5847 cursor_to (f, vpos, osp);
5848 insert_glyphs (f, 0, nsp - osp);
5850 olen += nsp - osp;
5852 tem = nsp + begmatch + endmatch;
5853 if (nlen != tem || olen != tem)
5855 if (!endmatch || nlen == olen)
5857 /* If new text being written reaches right margin, there is
5858 no need to do clear-to-eol at the end of this function
5859 (and it would not be safe, since cursor is not going to
5860 be "at the margin" after the text is done). */
5861 if (nlen == FRAME_TOTAL_COLS (f))
5862 olen = 0;
5864 /* Function write_glyphs is prepared to do nothing
5865 if passed a length <= 0. Check it here to avoid
5866 unnecessary cursor movement. */
5867 if (nlen - tem > 0)
5869 cursor_to (f, vpos, nsp + begmatch);
5870 write_glyphs (f, nbody + nsp + begmatch, nlen - tem);
5873 else if (nlen > olen)
5875 /* Here, we used to have the following simple code:
5876 ----------------------------------------
5877 write_glyphs (nbody + nsp + begmatch, olen - tem);
5878 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5879 ----------------------------------------
5880 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5881 is a padding glyph. */
5882 int out = olen - tem; /* Columns to be overwritten originally. */
5883 int del;
5885 cursor_to (f, vpos, nsp + begmatch);
5887 /* Calculate columns we can actually overwrite. */
5888 while (CHAR_GLYPH_PADDING_P (nbody[nsp + begmatch + out]))
5889 out--;
5890 write_glyphs (f, nbody + nsp + begmatch, out);
5892 /* If we left columns to be overwritten, we must delete them. */
5893 del = olen - tem - out;
5894 if (del > 0)
5895 delete_glyphs (f, del);
5897 /* At last, we insert columns not yet written out. */
5898 insert_glyphs (f, nbody + nsp + begmatch + out, nlen - olen + del);
5899 olen = nlen;
5901 else if (olen > nlen)
5903 cursor_to (f, vpos, nsp + begmatch);
5904 write_glyphs (f, nbody + nsp + begmatch, nlen - tem);
5905 delete_glyphs (f, olen - nlen);
5906 olen = nlen;
5910 just_erase:
5911 /* If any unerased characters remain after the new line, erase them. */
5912 if (olen > nlen)
5914 cursor_to (f, vpos, nlen);
5915 clear_end_of_line (f, olen);
5918 /* Exchange contents between current_frame and new_frame. */
5919 make_current (desired_matrix, current_matrix, vpos);
5924 /***********************************************************************
5925 X/Y Position -> Buffer Position
5926 ***********************************************************************/
5928 /* Determine what's under window-relative pixel position (*X, *Y).
5929 Return the object (string or buffer) that's there.
5930 Return in *POS the position in that object.
5931 Adjust *X and *Y to character positions. */
5933 Lisp_Object
5934 buffer_posn_from_coords (w, x, y, pos, object, dx, dy, width, height)
5935 struct window *w;
5936 int *x, *y;
5937 struct display_pos *pos;
5938 Lisp_Object *object;
5939 int *dx, *dy;
5940 int *width, *height;
5942 struct it it;
5943 Lisp_Object old_current_buffer = Fcurrent_buffer ();
5944 struct text_pos startp;
5945 Lisp_Object string;
5946 struct glyph_row *row;
5947 #ifdef HAVE_WINDOW_SYSTEM
5948 struct image *img = 0;
5949 #endif
5950 int x0, x1;
5952 /* We used to set current_buffer directly here, but that does the
5953 wrong thing with `face-remapping-alist' (bug#2044). */
5954 Fset_buffer (w->buffer);
5955 SET_TEXT_POS_FROM_MARKER (startp, w->start);
5956 CHARPOS (startp) = min (ZV, max (BEGV, CHARPOS (startp)));
5957 BYTEPOS (startp) = min (ZV_BYTE, max (BEGV_BYTE, BYTEPOS (startp)));
5958 start_display (&it, w, startp);
5960 x0 = *x - WINDOW_LEFT_MARGIN_WIDTH (w);
5961 move_it_to (&it, -1, x0 + it.first_visible_x, *y, -1,
5962 MOVE_TO_X | MOVE_TO_Y);
5964 Fset_buffer (old_current_buffer);
5966 *dx = x0 + it.first_visible_x - it.current_x;
5967 *dy = *y - it.current_y;
5969 string = w->buffer;
5970 if (STRINGP (it.string))
5971 string = it.string;
5972 *pos = it.current;
5974 #ifdef HAVE_WINDOW_SYSTEM
5975 if (it.what == IT_IMAGE)
5977 if ((img = IMAGE_FROM_ID (it.f, it.image_id)) != NULL
5978 && !NILP (img->spec))
5979 *object = img->spec;
5981 #endif
5983 if (it.vpos < w->current_matrix->nrows
5984 && (row = MATRIX_ROW (w->current_matrix, it.vpos),
5985 row->enabled_p))
5987 if (it.hpos < row->used[TEXT_AREA])
5989 struct glyph *glyph = row->glyphs[TEXT_AREA] + it.hpos;
5990 #ifdef HAVE_WINDOW_SYSTEM
5991 if (img)
5993 *dy -= row->ascent - glyph->ascent;
5994 *dx += glyph->slice.x;
5995 *dy += glyph->slice.y;
5996 /* Image slices positions are still relative to the entire image */
5997 *width = img->width;
5998 *height = img->height;
6000 else
6001 #endif
6003 *width = glyph->pixel_width;
6004 *height = glyph->ascent + glyph->descent;
6007 else
6009 *width = 0;
6010 *height = row->height;
6013 else
6015 *width = *height = 0;
6018 /* Add extra (default width) columns if clicked after EOL. */
6019 x1 = max(0, it.current_x + it.pixel_width - it.first_visible_x);
6020 if (x0 > x1)
6021 it.hpos += (x0 - x1) / WINDOW_FRAME_COLUMN_WIDTH (w);
6023 *x = it.hpos;
6024 *y = it.vpos;
6026 return string;
6030 /* Value is the string under window-relative coordinates X/Y in the
6031 mode line or header line (PART says which) of window W, or nil if none.
6032 *CHARPOS is set to the position in the string returned. */
6034 Lisp_Object
6035 mode_line_string (w, part, x, y, charpos, object, dx, dy, width, height)
6036 struct window *w;
6037 enum window_part part;
6038 int *x, *y;
6039 int *charpos;
6040 Lisp_Object *object;
6041 int *dx, *dy;
6042 int *width, *height;
6044 struct glyph_row *row;
6045 struct glyph *glyph, *end;
6046 int x0, y0;
6047 Lisp_Object string = Qnil;
6049 if (part == ON_MODE_LINE)
6050 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
6051 else
6052 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
6053 y0 = *y - row->y;
6054 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
6056 if (row->mode_line_p && row->enabled_p)
6058 /* Find the glyph under X. If we find one with a string object,
6059 it's the one we were looking for. */
6060 glyph = row->glyphs[TEXT_AREA];
6061 end = glyph + row->used[TEXT_AREA];
6062 for (x0 = *x; glyph < end && x0 >= glyph->pixel_width; ++glyph)
6063 x0 -= glyph->pixel_width;
6064 *x = glyph - row->glyphs[TEXT_AREA];
6065 if (glyph < end)
6067 string = glyph->object;
6068 *charpos = glyph->charpos;
6069 *width = glyph->pixel_width;
6070 *height = glyph->ascent + glyph->descent;
6071 #ifdef HAVE_WINDOW_SYSTEM
6072 if (glyph->type == IMAGE_GLYPH)
6074 struct image *img;
6075 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
6076 if (img != NULL)
6077 *object = img->spec;
6078 y0 -= row->ascent - glyph->ascent;
6080 #endif
6082 else
6084 /* Add extra (default width) columns if clicked after EOL. */
6085 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
6086 *width = 0;
6087 *height = row->height;
6090 else
6092 *x = 0;
6093 x0 = 0;
6094 *width = *height = 0;
6097 *dx = x0;
6098 *dy = y0;
6100 return string;
6104 /* Value is the string under window-relative coordinates X/Y in either
6105 marginal area, or nil if none. *CHARPOS is set to the position in
6106 the string returned. */
6108 Lisp_Object
6109 marginal_area_string (w, part, x, y, charpos, object, dx, dy, width, height)
6110 struct window *w;
6111 enum window_part part;
6112 int *x, *y;
6113 int *charpos;
6114 Lisp_Object *object;
6115 int *dx, *dy;
6116 int *width, *height;
6118 struct glyph_row *row = w->current_matrix->rows;
6119 struct glyph *glyph, *end;
6120 int x0, y0, i, wy = *y;
6121 int area;
6122 Lisp_Object string = Qnil;
6124 if (part == ON_LEFT_MARGIN)
6125 area = LEFT_MARGIN_AREA;
6126 else if (part == ON_RIGHT_MARGIN)
6127 area = RIGHT_MARGIN_AREA;
6128 else
6129 abort ();
6131 for (i = 0; row->enabled_p && i < w->current_matrix->nrows; ++i, ++row)
6132 if (wy >= row->y && wy < MATRIX_ROW_BOTTOM_Y (row))
6133 break;
6134 y0 = *y - row->y;
6135 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
6137 if (row->enabled_p)
6139 /* Find the glyph under X. If we find one with a string object,
6140 it's the one we were looking for. */
6141 if (area == RIGHT_MARGIN_AREA)
6142 x0 = ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6143 ? WINDOW_LEFT_FRINGE_WIDTH (w)
6144 : WINDOW_TOTAL_FRINGE_WIDTH (w))
6145 + window_box_width (w, LEFT_MARGIN_AREA)
6146 + window_box_width (w, TEXT_AREA));
6147 else
6148 x0 = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6149 ? WINDOW_LEFT_FRINGE_WIDTH (w)
6150 : 0);
6152 glyph = row->glyphs[area];
6153 end = glyph + row->used[area];
6154 for (x0 = *x - x0; glyph < end && x0 >= glyph->pixel_width; ++glyph)
6155 x0 -= glyph->pixel_width;
6156 *x = glyph - row->glyphs[area];
6157 if (glyph < end)
6159 string = glyph->object;
6160 *charpos = glyph->charpos;
6161 *width = glyph->pixel_width;
6162 *height = glyph->ascent + glyph->descent;
6163 #ifdef HAVE_WINDOW_SYSTEM
6164 if (glyph->type == IMAGE_GLYPH)
6166 struct image *img;
6167 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
6168 if (img != NULL)
6169 *object = img->spec;
6170 y0 -= row->ascent - glyph->ascent;
6171 x0 += glyph->slice.x;
6172 y0 += glyph->slice.y;
6174 #endif
6176 else
6178 /* Add extra (default width) columns if clicked after EOL. */
6179 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
6180 *width = 0;
6181 *height = row->height;
6184 else
6186 x0 = 0;
6187 *x = 0;
6188 *width = *height = 0;
6191 *dx = x0;
6192 *dy = y0;
6194 return string;
6198 /***********************************************************************
6199 Changing Frame Sizes
6200 ***********************************************************************/
6202 #ifdef SIGWINCH
6204 SIGTYPE
6205 window_change_signal (signalnum) /* If we don't have an argument, */
6206 int signalnum; /* some compilers complain in signal calls. */
6208 int width, height;
6209 #ifndef USE_CRT_DLL
6210 extern int errno;
6211 #endif
6212 int old_errno = errno;
6214 struct tty_display_info *tty;
6216 signal (SIGWINCH, window_change_signal);
6217 SIGNAL_THREAD_CHECK (signalnum);
6219 /* The frame size change obviously applies to a single
6220 termcap-controlled terminal, but we can't decide which.
6221 Therefore, we resize the frames corresponding to each tty.
6223 for (tty = tty_list; tty; tty = tty->next) {
6225 if (! tty->term_initted)
6226 continue;
6228 /* Suspended tty frames have tty->input == NULL avoid trying to
6229 use it. */
6230 if (!tty->input)
6231 continue;
6233 get_tty_size (fileno (tty->input), &width, &height);
6235 if (width > 5 && height > 2) {
6236 Lisp_Object tail, frame;
6238 FOR_EACH_FRAME (tail, frame)
6239 if (FRAME_TERMCAP_P (XFRAME (frame)) && FRAME_TTY (XFRAME (frame)) == tty)
6240 /* Record the new sizes, but don't reallocate the data
6241 structures now. Let that be done later outside of the
6242 signal handler. */
6243 change_frame_size (XFRAME (frame), height, width, 0, 1, 0);
6247 errno = old_errno;
6249 #endif /* SIGWINCH */
6252 /* Do any change in frame size that was requested by a signal. SAFE
6253 non-zero means this function is called from a place where it is
6254 safe to change frame sizes while a redisplay is in progress. */
6256 void
6257 do_pending_window_change (safe)
6258 int safe;
6260 /* If window_change_signal should have run before, run it now. */
6261 if (redisplaying_p && !safe)
6262 return;
6264 while (delayed_size_change)
6266 Lisp_Object tail, frame;
6268 delayed_size_change = 0;
6270 FOR_EACH_FRAME (tail, frame)
6272 struct frame *f = XFRAME (frame);
6274 if (f->new_text_lines != 0 || f->new_text_cols != 0)
6275 change_frame_size (f, f->new_text_lines, f->new_text_cols,
6276 0, 0, safe);
6282 /* Change the frame height and/or width. Values may be given as zero to
6283 indicate no change is to take place.
6285 If DELAY is non-zero, then assume we're being called from a signal
6286 handler, and queue the change for later - perhaps the next
6287 redisplay. Since this tries to resize windows, we can't call it
6288 from a signal handler.
6290 SAFE non-zero means this function is called from a place where it's
6291 safe to change frame sizes while a redisplay is in progress. */
6293 void
6294 change_frame_size (f, newheight, newwidth, pretend, delay, safe)
6295 register struct frame *f;
6296 int newheight, newwidth, pretend, delay, safe;
6298 Lisp_Object tail, frame;
6300 if (FRAME_MSDOS_P (f))
6302 /* On MS-DOS, all frames use the same screen, so a change in
6303 size affects all frames. Termcap now supports multiple
6304 ttys. */
6305 FOR_EACH_FRAME (tail, frame)
6306 if (! FRAME_WINDOW_P (XFRAME (frame)))
6307 change_frame_size_1 (XFRAME (frame), newheight, newwidth,
6308 pretend, delay, safe);
6310 else
6311 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe);
6314 static void
6315 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe)
6316 register struct frame *f;
6317 int newheight, newwidth, pretend, delay, safe;
6319 int new_frame_total_cols;
6320 int count = SPECPDL_INDEX ();
6322 /* If we can't deal with the change now, queue it for later. */
6323 if (delay || (redisplaying_p && !safe))
6325 f->new_text_lines = newheight;
6326 f->new_text_cols = newwidth;
6327 delayed_size_change = 1;
6328 return;
6331 /* This size-change overrides any pending one for this frame. */
6332 f->new_text_lines = 0;
6333 f->new_text_cols = 0;
6335 /* If an argument is zero, set it to the current value. */
6336 if (newheight == 0)
6337 newheight = FRAME_LINES (f);
6338 if (newwidth == 0)
6339 newwidth = FRAME_COLS (f);
6341 /* Compute width of windows in F.
6342 This is the width of the frame without vertical scroll bars. */
6343 new_frame_total_cols = FRAME_TOTAL_COLS_ARG (f, newwidth);
6345 /* Round up to the smallest acceptable size. */
6346 check_frame_size (f, &newheight, &newwidth);
6348 /* If we're not changing the frame size, quit now. */
6349 /* Frame width may be unchanged but the text portion may change, for example,
6350 fullscreen and remove/add scroll bar. */
6351 if (newheight == FRAME_LINES (f)
6352 && newwidth == FRAME_COLS (f) // text portion unchanged
6353 && new_frame_total_cols == FRAME_TOTAL_COLS (f)) // frame width unchanged
6354 return;
6356 BLOCK_INPUT;
6358 #ifdef MSDOS
6359 /* We only can set screen dimensions to certain values supported
6360 by our video hardware. Try to find the smallest size greater
6361 or equal to the requested dimensions. */
6362 dos_set_window_size (&newheight, &newwidth);
6363 #endif
6365 if (newheight != FRAME_LINES (f))
6367 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
6369 /* Frame has both root and mini-buffer. */
6370 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f))->top_line,
6371 FRAME_TOP_MARGIN (f));
6372 set_window_height (FRAME_ROOT_WINDOW (f),
6373 (newheight
6375 - FRAME_TOP_MARGIN (f)),
6377 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f))->top_line,
6378 newheight - 1);
6379 set_window_height (FRAME_MINIBUF_WINDOW (f), 1, 0);
6381 else
6382 /* Frame has just one top-level window. */
6383 set_window_height (FRAME_ROOT_WINDOW (f),
6384 newheight - FRAME_TOP_MARGIN (f), 2);
6386 /* MSDOS frames cannot PRETEND, as they change frame size by
6387 manipulating video hardware. */
6388 if ((FRAME_TERMCAP_P (f) && !pretend) || FRAME_MSDOS_P (f))
6389 FrameRows (FRAME_TTY (f)) = newheight;
6392 if (new_frame_total_cols != FRAME_TOTAL_COLS (f))
6394 set_window_width (FRAME_ROOT_WINDOW (f), new_frame_total_cols, 2);
6395 if (FRAME_HAS_MINIBUF_P (f))
6396 set_window_width (FRAME_MINIBUF_WINDOW (f), new_frame_total_cols, 0);
6398 /* MSDOS frames cannot PRETEND, as they change frame size by
6399 manipulating video hardware. */
6400 if ((FRAME_TERMCAP_P (f) && !pretend) || FRAME_MSDOS_P (f))
6401 FrameCols (FRAME_TTY (f)) = newwidth;
6403 if (WINDOWP (f->tool_bar_window))
6404 XSETFASTINT (XWINDOW (f->tool_bar_window)->total_cols, newwidth);
6407 FRAME_LINES (f) = newheight;
6408 SET_FRAME_COLS (f, newwidth);
6411 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
6412 int text_area_x, text_area_y, text_area_width, text_area_height;
6414 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
6415 &text_area_height);
6416 if (w->cursor.x >= text_area_x + text_area_width)
6417 w->cursor.hpos = w->cursor.x = 0;
6418 if (w->cursor.y >= text_area_y + text_area_height)
6419 w->cursor.vpos = w->cursor.y = 0;
6422 adjust_glyphs (f);
6423 calculate_costs (f);
6424 SET_FRAME_GARBAGED (f);
6425 f->resized_p = 1;
6427 UNBLOCK_INPUT;
6429 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
6431 run_window_configuration_change_hook (f);
6433 unbind_to (count, Qnil);
6438 /***********************************************************************
6439 Terminal Related Lisp Functions
6440 ***********************************************************************/
6442 DEFUN ("open-termscript", Fopen_termscript, Sopen_termscript,
6443 1, 1, "FOpen termscript file: ",
6444 doc: /* Start writing all terminal output to FILE as well as the terminal.
6445 FILE = nil means just close any termscript file currently open. */)
6446 (file)
6447 Lisp_Object file;
6449 struct tty_display_info *tty;
6451 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
6452 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
6453 error ("Current frame is not on a tty device");
6455 tty = CURTTY ();
6457 if (tty->termscript != 0)
6459 BLOCK_INPUT;
6460 fclose (tty->termscript);
6461 UNBLOCK_INPUT;
6463 tty->termscript = 0;
6465 if (! NILP (file))
6467 file = Fexpand_file_name (file, Qnil);
6468 tty->termscript = fopen (SDATA (file), "w");
6469 if (tty->termscript == 0)
6470 report_file_error ("Opening termscript", Fcons (file, Qnil));
6472 return Qnil;
6476 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal,
6477 Ssend_string_to_terminal, 1, 2, 0,
6478 doc: /* Send STRING to the terminal without alteration.
6479 Control characters in STRING will have terminal-dependent effects.
6481 Optional parameter TERMINAL specifies the tty terminal device to use.
6482 It may be a terminal object, a frame, or nil for the terminal used by
6483 the currently selected frame. In batch mode, STRING is sent to stdout
6484 when TERMINAL is nil. */)
6485 (string, terminal)
6486 Lisp_Object string;
6487 Lisp_Object terminal;
6489 struct terminal *t = get_terminal (terminal, 1);
6490 FILE *out;
6492 /* ??? Perhaps we should do something special for multibyte strings here. */
6493 CHECK_STRING (string);
6494 BLOCK_INPUT;
6496 if (!t)
6497 error ("Unknown terminal device");
6499 if (t->type == output_initial)
6500 out = stdout;
6501 else if (t->type != output_termcap && t->type != output_msdos_raw)
6502 error ("Device %d is not a termcap terminal device", t->id);
6503 else
6505 struct tty_display_info *tty = t->display_info.tty;
6507 if (! tty->output)
6508 error ("Terminal is currently suspended");
6510 if (tty->termscript)
6512 fwrite (SDATA (string), 1, SBYTES (string), tty->termscript);
6513 fflush (tty->termscript);
6515 out = tty->output;
6517 fwrite (SDATA (string), 1, SBYTES (string), out);
6518 fflush (out);
6519 UNBLOCK_INPUT;
6520 return Qnil;
6524 DEFUN ("ding", Fding, Sding, 0, 1, 0,
6525 doc: /* Beep, or flash the screen.
6526 Also, unless an argument is given,
6527 terminate any keyboard macro currently executing. */)
6528 (arg)
6529 Lisp_Object arg;
6531 if (!NILP (arg))
6533 if (noninteractive)
6534 putchar (07);
6535 else
6536 ring_bell (XFRAME (selected_frame));
6538 else
6539 bitch_at_user ();
6541 return Qnil;
6544 void
6545 bitch_at_user ()
6547 if (noninteractive)
6548 putchar (07);
6549 else if (!INTERACTIVE) /* Stop executing a keyboard macro. */
6550 error ("Keyboard macro terminated by a command ringing the bell");
6551 else
6552 ring_bell (XFRAME (selected_frame));
6557 /***********************************************************************
6558 Sleeping, Waiting
6559 ***********************************************************************/
6561 DEFUN ("sleep-for", Fsleep_for, Ssleep_for, 1, 2, 0,
6562 doc: /* Pause, without updating display, for SECONDS seconds.
6563 SECONDS may be a floating-point value, meaning that you can wait for a
6564 fraction of a second. Optional second arg MILLISECONDS specifies an
6565 additional wait period, in milliseconds; this may be useful if your
6566 Emacs was built without floating point support.
6567 \(Not all operating systems support waiting for a fraction of a second.) */)
6568 (seconds, milliseconds)
6569 Lisp_Object seconds, milliseconds;
6571 int sec, usec;
6573 if (NILP (milliseconds))
6574 XSETINT (milliseconds, 0);
6575 else
6576 CHECK_NUMBER (milliseconds);
6577 usec = XINT (milliseconds) * 1000;
6580 double duration = extract_float (seconds);
6581 sec = (int) duration;
6582 usec += (duration - sec) * 1000000;
6585 #ifndef EMACS_HAS_USECS
6586 if (sec == 0 && usec != 0)
6587 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE);
6588 #endif
6590 /* Assure that 0 <= usec < 1000000. */
6591 if (usec < 0)
6593 /* We can't rely on the rounding being correct if usec is negative. */
6594 if (-1000000 < usec)
6595 sec--, usec += 1000000;
6596 else
6597 sec -= -usec / 1000000, usec = 1000000 - (-usec % 1000000);
6599 else
6600 sec += usec / 1000000, usec %= 1000000;
6602 if (sec < 0 || (sec == 0 && usec == 0))
6603 return Qnil;
6605 wait_reading_process_output (sec, usec, 0, 0, Qnil, NULL, 0);
6607 return Qnil;
6611 /* This is just like wait_reading_process_output, except that
6612 it does redisplay.
6614 TIMEOUT is number of seconds to wait (float or integer),
6615 or t to wait forever.
6616 READING is 1 if reading input.
6617 If DO_DISPLAY is >0 display process output while waiting.
6618 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
6621 Lisp_Object
6622 sit_for (timeout, reading, do_display)
6623 Lisp_Object timeout;
6624 int reading, do_display;
6626 int sec, usec;
6628 swallow_events (do_display);
6630 if ((detect_input_pending_run_timers (do_display))
6631 || !NILP (Vexecuting_kbd_macro))
6632 return Qnil;
6634 if (do_display >= 2)
6635 redisplay_preserve_echo_area (2);
6637 if (INTEGERP (timeout))
6639 sec = XINT (timeout);
6640 usec = 0;
6642 else if (FLOATP (timeout))
6644 double seconds = XFLOAT_DATA (timeout);
6645 sec = (int) seconds;
6646 usec = (int) ((seconds - sec) * 1000000);
6648 else if (EQ (timeout, Qt))
6650 sec = 0;
6651 usec = 0;
6653 else
6654 wrong_type_argument (Qnumberp, timeout);
6656 if (sec == 0 && usec == 0 && !EQ (timeout, Qt))
6657 return Qt;
6659 #ifdef SIGIO
6660 gobble_input (0);
6661 #endif
6663 wait_reading_process_output (sec, usec, reading ? -1 : 1, do_display,
6664 Qnil, NULL, 0);
6666 return detect_input_pending () ? Qnil : Qt;
6670 DEFUN ("redisplay", Fredisplay, Sredisplay, 0, 1, 0,
6671 doc: /* Perform redisplay if no input is available.
6672 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
6673 perform a full redisplay even if input is available.
6674 Return t if redisplay was performed, nil otherwise. */)
6675 (force)
6676 Lisp_Object force;
6678 int count;
6680 swallow_events (1);
6681 if ((detect_input_pending_run_timers (1)
6682 && NILP (force) && !redisplay_dont_pause)
6683 || !NILP (Vexecuting_kbd_macro))
6684 return Qnil;
6686 count = SPECPDL_INDEX ();
6687 if (!NILP (force) && !redisplay_dont_pause)
6688 specbind (Qredisplay_dont_pause, Qt);
6689 redisplay_preserve_echo_area (2);
6690 unbind_to (count, Qnil);
6691 return Qt;
6696 /***********************************************************************
6697 Other Lisp Functions
6698 ***********************************************************************/
6700 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6701 session's frames, frame names, buffers, buffer-read-only flags, and
6702 buffer-modified-flags. */
6704 static Lisp_Object frame_and_buffer_state;
6707 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p,
6708 Sframe_or_buffer_changed_p, 0, 1, 0,
6709 doc: /* Return non-nil if the frame and buffer state appears to have changed.
6710 VARIABLE is a variable name whose value is either nil or a state vector
6711 that will be updated to contain all frames and buffers,
6712 aside from buffers whose names start with space,
6713 along with the buffers' read-only and modified flags. This allows a fast
6714 check to see whether buffer menus might need to be recomputed.
6715 If this function returns non-nil, it updates the internal vector to reflect
6716 the current state.
6718 If VARIABLE is nil, an internal variable is used. Users should not
6719 pass nil for VARIABLE. */)
6720 (variable)
6721 Lisp_Object variable;
6723 Lisp_Object state, tail, frame, buf;
6724 Lisp_Object *vecp, *end;
6725 int n;
6727 if (! NILP (variable))
6729 CHECK_SYMBOL (variable);
6730 state = Fsymbol_value (variable);
6731 if (! VECTORP (state))
6732 goto changed;
6734 else
6735 state = frame_and_buffer_state;
6737 vecp = XVECTOR (state)->contents;
6738 end = vecp + XVECTOR_SIZE (state);
6740 FOR_EACH_FRAME (tail, frame)
6742 if (vecp == end)
6743 goto changed;
6744 if (!EQ (*vecp++, frame))
6745 goto changed;
6746 if (vecp == end)
6747 goto changed;
6748 if (!EQ (*vecp++, XFRAME (frame)->name))
6749 goto changed;
6751 /* Check that the buffer info matches. */
6752 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6754 buf = XCDR (XCAR (tail));
6755 /* Ignore buffers that aren't included in buffer lists. */
6756 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6757 continue;
6758 if (vecp == end)
6759 goto changed;
6760 if (!EQ (*vecp++, buf))
6761 goto changed;
6762 if (vecp == end)
6763 goto changed;
6764 if (!EQ (*vecp++, XBUFFER (buf)->read_only))
6765 goto changed;
6766 if (vecp == end)
6767 goto changed;
6768 if (!EQ (*vecp++, Fbuffer_modified_p (buf)))
6769 goto changed;
6771 if (vecp == end)
6772 goto changed;
6773 /* Detect deletion of a buffer at the end of the list. */
6774 if (EQ (*vecp, Qlambda))
6775 return Qnil;
6777 /* Come here if we decide the data has changed. */
6778 changed:
6779 /* Count the size we will need.
6780 Start with 1 so there is room for at least one lambda at the end. */
6781 n = 1;
6782 FOR_EACH_FRAME (tail, frame)
6783 n += 2;
6784 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6785 n += 3;
6786 /* Reallocate the vector if data has grown to need it,
6787 or if it has shrunk a lot. */
6788 if (! VECTORP (state)
6789 || n > XVECTOR_SIZE (state)
6790 || n + 20 < XVECTOR_SIZE (state) / 2)
6791 /* Add 20 extra so we grow it less often. */
6793 state = Fmake_vector (make_number (n + 20), Qlambda);
6794 if (! NILP (variable))
6795 Fset (variable, state);
6796 else
6797 frame_and_buffer_state = state;
6800 /* Record the new data in the (possibly reallocated) vector. */
6801 vecp = XVECTOR (state)->contents;
6802 FOR_EACH_FRAME (tail, frame)
6804 *vecp++ = frame;
6805 *vecp++ = XFRAME (frame)->name;
6807 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6809 buf = XCDR (XCAR (tail));
6810 /* Ignore buffers that aren't included in buffer lists. */
6811 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6812 continue;
6813 *vecp++ = buf;
6814 *vecp++ = XBUFFER (buf)->read_only;
6815 *vecp++ = Fbuffer_modified_p (buf);
6817 /* Fill up the vector with lambdas (always at least one). */
6818 *vecp++ = Qlambda;
6819 while (vecp - XVECTOR (state)->contents
6820 < XVECTOR_SIZE (state))
6821 *vecp++ = Qlambda;
6822 /* Make sure we didn't overflow the vector. */
6823 if (vecp - XVECTOR (state)->contents
6824 > XVECTOR_SIZE (state))
6825 abort ();
6826 return Qt;
6831 /***********************************************************************
6832 Initialization
6833 ***********************************************************************/
6835 /* Initialization done when Emacs fork is started, before doing stty.
6836 Determine terminal type and set terminal_driver. Then invoke its
6837 decoding routine to set up variables in the terminal package. */
6839 void
6840 init_display ()
6842 char *terminal_type;
6844 #ifdef HAVE_X_WINDOWS
6845 extern int display_arg;
6846 #endif
6848 /* Construct the space glyph. */
6849 space_glyph.type = CHAR_GLYPH;
6850 SET_CHAR_GLYPH (space_glyph, ' ', DEFAULT_FACE_ID, 0);
6851 space_glyph.charpos = -1;
6853 inverse_video = 0;
6854 cursor_in_echo_area = 0;
6855 terminal_type = (char *) 0;
6857 /* Now is the time to initialize this; it's used by init_sys_modes
6858 during startup. */
6859 Vinitial_window_system = Qnil;
6861 /* SIGWINCH needs to be handled no matter what display we start
6862 with. Otherwise newly opened tty frames will not resize
6863 automatically. */
6864 #ifdef SIGWINCH
6865 #ifndef CANNOT_DUMP
6866 if (initialized)
6867 #endif /* CANNOT_DUMP */
6868 signal (SIGWINCH, window_change_signal);
6869 #endif /* SIGWINCH */
6871 /* If running as a daemon, no need to initialize any frames/terminal. */
6872 if (IS_DAEMON)
6873 return;
6875 /* If the user wants to use a window system, we shouldn't bother
6876 initializing the terminal. This is especially important when the
6877 terminal is so dumb that emacs gives up before and doesn't bother
6878 using the window system.
6880 If the DISPLAY environment variable is set and nonempty,
6881 try to use X, and die with an error message if that doesn't work. */
6883 #ifdef HAVE_X_WINDOWS
6884 if (! inhibit_window_system && ! display_arg)
6886 char *display;
6887 display = getenv ("DISPLAY");
6888 display_arg = (display != 0 && *display != 0);
6890 if (display_arg && !x_display_ok (display))
6892 fprintf (stderr, "Display %s unavailable, simulating -nw\n",
6893 display);
6894 inhibit_window_system = 1;
6898 if (!inhibit_window_system && display_arg
6899 #ifndef CANNOT_DUMP
6900 && initialized
6901 #endif
6904 Vinitial_window_system = Qx;
6905 #ifdef HAVE_X11
6906 Vwindow_system_version = make_number (11);
6907 #endif
6908 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6909 /* In some versions of ncurses,
6910 tputs crashes if we have not called tgetent.
6911 So call tgetent. */
6912 { char b[2044]; tgetent (b, "xterm");}
6913 #endif
6914 adjust_frame_glyphs_initially ();
6915 return;
6917 #endif /* HAVE_X_WINDOWS */
6919 #ifdef HAVE_NTGUI
6920 if (!inhibit_window_system)
6922 Vinitial_window_system = Qw32;
6923 Vwindow_system_version = make_number (1);
6924 adjust_frame_glyphs_initially ();
6925 return;
6927 #endif /* HAVE_NTGUI */
6929 #ifdef HAVE_NS
6930 if (!inhibit_window_system
6931 #ifndef CANNOT_DUMP
6932 && initialized
6933 #endif
6936 Vinitial_window_system = Qns;
6937 Vwindow_system_version = make_number(10);
6938 adjust_frame_glyphs_initially ();
6939 return;
6941 #endif
6943 /* If no window system has been specified, try to use the terminal. */
6944 if (! isatty (0))
6946 fatal ("standard input is not a tty");
6947 exit (1);
6950 #ifdef WINDOWSNT
6951 terminal_type = "w32console";
6952 #else
6953 /* Look at the TERM variable. */
6954 terminal_type = (char *) getenv ("TERM");
6955 #endif
6956 if (!terminal_type)
6958 #ifdef HAVE_WINDOW_SYSTEM
6959 if (! inhibit_window_system)
6960 fprintf (stderr, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6961 else
6962 #endif /* HAVE_WINDOW_SYSTEM */
6963 fprintf (stderr, "Please set the environment variable TERM; see `tset'.\n");
6964 exit (1);
6968 struct terminal *t;
6969 struct frame *f = XFRAME (selected_frame);
6971 /* Open a display on the controlling tty. */
6972 t = init_tty (0, terminal_type, 1); /* Errors are fatal. */
6974 /* Convert the initial frame to use the new display. */
6975 if (f->output_method != output_initial)
6976 abort ();
6977 f->output_method = t->type;
6978 f->terminal = t;
6980 t->reference_count++;
6981 t->display_info.tty->top_frame = selected_frame;
6982 change_frame_size (XFRAME (selected_frame),
6983 FrameRows (t->display_info.tty),
6984 FrameCols (t->display_info.tty), 0, 0, 1);
6986 /* Delete the initial terminal. */
6987 if (--initial_terminal->reference_count == 0
6988 && initial_terminal->delete_terminal_hook)
6989 (*initial_terminal->delete_terminal_hook) (initial_terminal);
6991 /* Update frame parameters to reflect the new type. */
6992 Fmodify_frame_parameters
6993 (selected_frame, Fcons (Fcons (Qtty_type,
6994 Ftty_type (selected_frame)), Qnil));
6995 if (t->display_info.tty->name)
6996 Fmodify_frame_parameters (selected_frame,
6997 Fcons (Fcons (Qtty, build_string (t->display_info.tty->name)),
6998 Qnil));
6999 else
7000 Fmodify_frame_parameters (selected_frame, Fcons (Fcons (Qtty, Qnil),
7001 Qnil));
7005 struct frame *sf = SELECTED_FRAME ();
7006 int width = FRAME_TOTAL_COLS (sf);
7007 int height = FRAME_LINES (sf);
7009 unsigned int total_glyphs = height * (width + 2) * sizeof (struct glyph);
7011 /* If these sizes are so big they cause overflow, just ignore the
7012 change. It's not clear what better we could do. */
7013 if (total_glyphs / sizeof (struct glyph) / height != width + 2)
7014 fatal ("screen size %dx%d too big", width, height);
7017 adjust_frame_glyphs_initially ();
7018 calculate_costs (XFRAME (selected_frame));
7020 /* Set up faces of the initial terminal frame of a dumped Emacs. */
7021 if (initialized
7022 && !noninteractive
7023 && NILP (Vinitial_window_system))
7025 /* For the initial frame, we don't have any way of knowing what
7026 are the foreground and background colors of the terminal. */
7027 struct frame *sf = SELECTED_FRAME();
7029 FRAME_FOREGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_FG_COLOR;
7030 FRAME_BACKGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_BG_COLOR;
7031 call0 (intern ("tty-set-up-initial-frame-faces"));
7037 /***********************************************************************
7038 Blinking cursor
7039 ***********************************************************************/
7041 DEFUN ("internal-show-cursor", Finternal_show_cursor,
7042 Sinternal_show_cursor, 2, 2, 0,
7043 doc: /* Set the cursor-visibility flag of WINDOW to SHOW.
7044 WINDOW nil means use the selected window. SHOW non-nil means
7045 show a cursor in WINDOW in the next redisplay. SHOW nil means
7046 don't show a cursor. */)
7047 (window, show)
7048 Lisp_Object window, show;
7050 /* Don't change cursor state while redisplaying. This could confuse
7051 output routines. */
7052 if (!redisplaying_p)
7054 if (NILP (window))
7055 window = selected_window;
7056 else
7057 CHECK_WINDOW (window);
7059 XWINDOW (window)->cursor_off_p = NILP (show);
7062 return Qnil;
7066 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p,
7067 Sinternal_show_cursor_p, 0, 1, 0,
7068 doc: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
7069 WINDOW nil or omitted means report on the selected window. */)
7070 (window)
7071 Lisp_Object window;
7073 struct window *w;
7075 if (NILP (window))
7076 window = selected_window;
7077 else
7078 CHECK_WINDOW (window);
7080 w = XWINDOW (window);
7081 return w->cursor_off_p ? Qnil : Qt;
7084 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame,
7085 Slast_nonminibuf_frame, 0, 0, 0,
7086 doc: /* Value is last nonminibuffer frame. */)
7089 Lisp_Object frame = Qnil;
7091 if (last_nonminibuf_frame)
7092 XSETFRAME (frame, last_nonminibuf_frame);
7094 return frame;
7097 /***********************************************************************
7098 Initialization
7099 ***********************************************************************/
7101 void
7102 syms_of_display ()
7104 defsubr (&Sredraw_frame);
7105 defsubr (&Sredraw_display);
7106 defsubr (&Sframe_or_buffer_changed_p);
7107 defsubr (&Sopen_termscript);
7108 defsubr (&Sding);
7109 defsubr (&Sredisplay);
7110 defsubr (&Ssleep_for);
7111 defsubr (&Ssend_string_to_terminal);
7112 defsubr (&Sinternal_show_cursor);
7113 defsubr (&Sinternal_show_cursor_p);
7114 defsubr (&Slast_nonminibuf_frame);
7116 #if GLYPH_DEBUG
7117 defsubr (&Sdump_redisplay_history);
7118 #endif
7120 frame_and_buffer_state = Fmake_vector (make_number (20), Qlambda);
7121 staticpro (&frame_and_buffer_state);
7123 Qdisplay_table = intern_c_string ("display-table");
7124 staticpro (&Qdisplay_table);
7125 Qredisplay_dont_pause = intern_c_string ("redisplay-dont-pause");
7126 staticpro (&Qredisplay_dont_pause);
7128 DEFVAR_INT ("baud-rate", &baud_rate,
7129 doc: /* *The output baud rate of the terminal.
7130 On most systems, changing this value will affect the amount of padding
7131 and the other strategic decisions made during redisplay. */);
7133 DEFVAR_BOOL ("inverse-video", &inverse_video,
7134 doc: /* *Non-nil means invert the entire frame display.
7135 This means everything is in inverse video which otherwise would not be. */);
7137 DEFVAR_BOOL ("visible-bell", &visible_bell,
7138 doc: /* *Non-nil means try to flash the frame to represent a bell.
7140 See also `ring-bell-function'. */);
7142 DEFVAR_BOOL ("no-redraw-on-reenter", &no_redraw_on_reenter,
7143 doc: /* *Non-nil means no need to redraw entire frame after suspending.
7144 A non-nil value is useful if the terminal can automatically preserve
7145 Emacs's frame display when you reenter Emacs.
7146 It is up to you to set this variable if your terminal can do that. */);
7148 DEFVAR_LISP ("initial-window-system", &Vinitial_window_system,
7149 doc: /* Name of the window system that Emacs uses for the first frame.
7150 The value is a symbol:
7151 nil for a termcap frame (a character-only terminal),
7152 'x' for an Emacs frame that is really an X window,
7153 'w32' for an Emacs frame that is a window on MS-Windows display,
7154 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
7155 'pc' for a direct-write MS-DOS frame.
7157 Use of this variable as a boolean is deprecated. Instead,
7158 use `display-graphic-p' or any of the other `display-*-p'
7159 predicates which report frame's specific UI-related capabilities. */);
7161 DEFVAR_KBOARD ("window-system", Vwindow_system,
7162 doc: /* Name of window system through which the selected frame is displayed.
7163 The value is a symbol:
7164 nil for a termcap frame (a character-only terminal),
7165 'x' for an Emacs frame that is really an X window,
7166 'w32' for an Emacs frame that is a window on MS-Windows display,
7167 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
7168 'pc' for a direct-write MS-DOS frame.
7170 Use of this variable as a boolean is deprecated. Instead,
7171 use `display-graphic-p' or any of the other `display-*-p'
7172 predicates which report frame's specific UI-related capabilities. */);
7174 DEFVAR_LISP ("window-system-version", &Vwindow_system_version,
7175 doc: /* The version number of the window system in use.
7176 For X windows, this is 11. */);
7178 DEFVAR_BOOL ("cursor-in-echo-area", &cursor_in_echo_area,
7179 doc: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
7181 DEFVAR_LISP ("glyph-table", &Vglyph_table,
7182 doc: /* Table defining how to output a glyph code to the frame.
7183 If not nil, this is a vector indexed by glyph code to define the glyph.
7184 Each element can be:
7185 integer: a glyph code which this glyph is an alias for.
7186 string: output this glyph using that string (not impl. in X windows).
7187 nil: this glyph mod 524288 is the code of a character to output,
7188 and this glyph / 524288 is the face number (see `face-id') to use
7189 while outputting it. */);
7190 Vglyph_table = Qnil;
7192 DEFVAR_LISP ("standard-display-table", &Vstandard_display_table,
7193 doc: /* Display table to use for buffers that specify none.
7194 See `buffer-display-table' for more information. */);
7195 Vstandard_display_table = Qnil;
7197 DEFVAR_BOOL ("redisplay-dont-pause", &redisplay_dont_pause,
7198 doc: /* *Non-nil means update isn't paused when input is detected. */);
7199 redisplay_dont_pause = 0;
7201 #if PERIODIC_PREEMPTION_CHECKING
7202 DEFVAR_LISP ("redisplay-preemption-period", &Vredisplay_preemption_period,
7203 doc: /* *The period in seconds between checking for input during redisplay.
7204 If input is detected, redisplay is pre-empted, and the input is processed.
7205 If nil, never pre-empt redisplay. */);
7206 Vredisplay_preemption_period = make_float (0.10);
7207 #endif
7209 #ifdef CANNOT_DUMP
7210 if (noninteractive)
7211 #endif
7213 Vinitial_window_system = Qnil;
7214 Vwindow_system_version = Qnil;
7218 /* arch-tag: 8d812b1f-04a2-4195-a9c4-381f8457a413
7219 (do not change this comment) */