Explain vc-BACKEND-root in Commentary; nfc.
[emacs.git] / src / dispnew.c
bloba4219ead66d8f3b792d7dae51a70ef559e922662
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 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, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <ctype.h>
28 #ifdef HAVE_UNISTD_H
29 #include <unistd.h>
30 #endif
32 #include "lisp.h"
33 #include "termchar.h"
34 #include "termopts.h"
35 /* cm.h must come after dispextern.h on Windows. */
36 #include "dispextern.h"
37 #include "cm.h"
38 #include "buffer.h"
39 #include "character.h"
40 #include "keyboard.h"
41 #include "frame.h"
42 #include "termhooks.h"
43 #include "window.h"
44 #include "commands.h"
45 #include "disptab.h"
46 #include "indent.h"
47 #include "intervals.h"
48 #include "blockinput.h"
49 #include "process.h"
51 /* I don't know why DEC Alpha OSF1 fail to compile this file if we
52 include the following file. */
53 /* #include "systty.h" */
54 #include "syssignal.h"
56 #ifdef HAVE_X_WINDOWS
57 #include "xterm.h"
58 #endif /* HAVE_X_WINDOWS */
60 #ifdef HAVE_NTGUI
61 #include "w32term.h"
62 #endif /* HAVE_NTGUI */
64 #ifdef MAC_OS
65 #include "macterm.h"
66 #endif /* MAC_OS */
68 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
70 #include "systime.h"
71 #include <errno.h>
73 /* To get the prototype for `sleep'. */
75 #ifdef HAVE_UNISTD_H
76 #include <unistd.h>
77 #endif
79 /* Get number of chars of output now in the buffer of a stdio stream.
80 This ought to be built in in stdio, but it isn't. Some s- files
81 override this because their stdio internals differ. */
83 #ifdef __GNU_LIBRARY__
85 /* The s- file might have overridden the definition with one that
86 works for the system's C library. But we are using the GNU C
87 library, so this is the right definition for every system. */
89 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
90 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
91 #else
92 #undef PENDING_OUTPUT_COUNT
93 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
94 #endif
95 #else /* not __GNU_LIBRARY__ */
96 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
97 #include <stdio_ext.h>
98 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
99 #endif
100 #ifndef PENDING_OUTPUT_COUNT
101 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
102 #endif
103 #endif /* not __GNU_LIBRARY__ */
105 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
106 #include <term.h> /* for tgetent */
107 #endif
109 /* Structure to pass dimensions around. Used for character bounding
110 boxes, glyph matrix dimensions and alike. */
112 struct dim
114 int width;
115 int height;
119 /* Function prototypes. */
121 static struct glyph_matrix *save_current_matrix P_ ((struct frame *));
122 static void restore_current_matrix P_ ((struct frame *, struct glyph_matrix *));
123 static int showing_window_margins_p P_ ((struct window *));
124 static void fake_current_matrices P_ ((Lisp_Object));
125 static void redraw_overlapping_rows P_ ((struct window *, int));
126 static void redraw_overlapped_rows P_ ((struct window *, int));
127 static int count_blanks P_ ((struct glyph *, int));
128 static int count_match P_ ((struct glyph *, struct glyph *,
129 struct glyph *, struct glyph *));
130 static unsigned line_draw_cost P_ ((struct glyph_matrix *, int));
131 static void update_frame_line P_ ((struct frame *, int));
132 static struct dim allocate_matrices_for_frame_redisplay
133 P_ ((Lisp_Object, int, int, int, int *));
134 static void allocate_matrices_for_window_redisplay P_ ((struct window *));
135 static int realloc_glyph_pool P_ ((struct glyph_pool *, struct dim));
136 static void adjust_frame_glyphs P_ ((struct frame *));
137 struct glyph_matrix *new_glyph_matrix P_ ((struct glyph_pool *));
138 static void free_glyph_matrix P_ ((struct glyph_matrix *));
139 static void adjust_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
140 int, int, struct dim));
141 static void change_frame_size_1 P_ ((struct frame *, int, int, int, int, int));
142 static void swap_glyph_pointers P_ ((struct glyph_row *, struct glyph_row *));
143 #if GLYPH_DEBUG
144 static int glyph_row_slice_p P_ ((struct glyph_row *, struct glyph_row *));
145 #endif
146 static void fill_up_frame_row_with_spaces P_ ((struct glyph_row *, int));
147 static void build_frame_matrix_from_window_tree P_ ((struct glyph_matrix *,
148 struct window *));
149 static void build_frame_matrix_from_leaf_window P_ ((struct glyph_matrix *,
150 struct window *));
151 static struct glyph_pool *new_glyph_pool P_ ((void));
152 static void free_glyph_pool P_ ((struct glyph_pool *));
153 static void adjust_frame_glyphs_initially P_ ((void));
154 static void adjust_frame_message_buffer P_ ((struct frame *));
155 static void adjust_decode_mode_spec_buffer P_ ((struct frame *));
156 static void fill_up_glyph_row_with_spaces P_ ((struct glyph_row *));
157 static void build_frame_matrix P_ ((struct frame *));
158 void clear_current_matrices P_ ((struct frame *));
159 void scroll_glyph_matrix_range P_ ((struct glyph_matrix *, int, int,
160 int, int));
161 static void clear_window_matrices P_ ((struct window *, int));
162 static void fill_up_glyph_row_area_with_spaces P_ ((struct glyph_row *, int));
163 static int scrolling_window P_ ((struct window *, int));
164 static int update_window_line P_ ((struct window *, int, int *));
165 static void update_marginal_area P_ ((struct window *, int, int));
166 static int update_text_area P_ ((struct window *, int));
167 static void make_current P_ ((struct glyph_matrix *, struct glyph_matrix *,
168 int));
169 static void mirror_make_current P_ ((struct window *, int));
170 void check_window_matrix_pointers P_ ((struct window *));
171 #if GLYPH_DEBUG
172 static void check_matrix_pointers P_ ((struct glyph_matrix *,
173 struct glyph_matrix *));
174 #endif
175 static void mirror_line_dance P_ ((struct window *, int, int, int *, char *));
176 static int update_window_tree P_ ((struct window *, int));
177 static int update_window P_ ((struct window *, int));
178 static int update_frame_1 P_ ((struct frame *, int, int));
179 static void set_window_cursor_after_update P_ ((struct window *));
180 static int row_equal_p P_ ((struct window *, struct glyph_row *,
181 struct glyph_row *, int));
182 static void adjust_frame_glyphs_for_window_redisplay P_ ((struct frame *));
183 static void adjust_frame_glyphs_for_frame_redisplay P_ ((struct frame *));
184 static void reverse_rows P_ ((struct glyph_matrix *, int, int));
185 static int margin_glyphs_to_reserve P_ ((struct window *, int, Lisp_Object));
186 static void sync_window_with_frame_matrix_rows P_ ((struct window *));
187 struct window *frame_row_to_window P_ ((struct window *, int));
190 /* Non-zero means don't pause redisplay for pending input. (This is
191 for debugging and for a future implementation of EDT-like
192 scrolling. */
194 int redisplay_dont_pause;
196 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
197 are supported, so we can check for input during redisplay at
198 regular intervals. */
199 #ifdef EMACS_HAS_USECS
200 #define PERIODIC_PREEMPTION_CHECKING 1
201 #else
202 #define PERIODIC_PREEMPTION_CHECKING 0
203 #endif
205 #if PERIODIC_PREEMPTION_CHECKING
207 /* If a number (float), check for user input every N seconds. */
209 Lisp_Object Vredisplay_preemption_period;
211 /* Redisplay preemption timers. */
213 static EMACS_TIME preemption_period;
214 static EMACS_TIME preemption_next_check;
216 #endif
218 /* Nonzero upon entry to redisplay means do not assume anything about
219 current contents of actual terminal frame; clear and redraw it. */
221 int frame_garbaged;
223 /* Nonzero means last display completed. Zero means it was preempted. */
225 int display_completed;
227 /* Lisp variable visible-bell; enables use of screen-flash instead of
228 audible bell. */
230 int visible_bell;
232 /* Invert the color of the whole frame, at a low level. */
234 int inverse_video;
236 /* Line speed of the terminal. */
238 EMACS_INT baud_rate;
240 /* Either nil or a symbol naming the window system under which Emacs
241 creates the first frame. */
243 Lisp_Object Vinitial_window_system;
245 /* Version number of X windows: 10, 11 or nil. */
247 Lisp_Object Vwindow_system_version;
249 /* Vector of glyph definitions. Indexed by glyph number, the contents
250 are a string which is how to output the glyph.
252 If Vglyph_table is nil, a glyph is output by using its low 8 bits
253 as a character code.
255 This is an obsolete feature that is no longer used. The variable
256 is retained for compatibility. */
258 Lisp_Object Vglyph_table;
260 /* Display table to use for vectors that don't specify their own. */
262 Lisp_Object Vstandard_display_table;
264 /* Nonzero means reading single-character input with prompt so put
265 cursor on mini-buffer after the prompt. Positive means at end of
266 text in echo area; negative means at beginning of line. */
268 int cursor_in_echo_area;
270 Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
273 /* The currently selected frame. In a single-frame version, this
274 variable always equals the_only_frame. */
276 Lisp_Object selected_frame;
278 /* A frame which is not just a mini-buffer, or 0 if there are no such
279 frames. This is usually the most recent such frame that was
280 selected. In a single-frame version, this variable always holds
281 the address of the_only_frame. */
283 struct frame *last_nonminibuf_frame;
285 /* 1 means SIGWINCH happened when not safe. */
287 int delayed_size_change;
289 /* 1 means glyph initialization has been completed at startup. */
291 static int glyphs_initialized_initially_p;
293 /* Updated window if != 0. Set by update_window. */
295 struct window *updated_window;
297 /* Glyph row updated in update_window_line, and area that is updated. */
299 struct glyph_row *updated_row;
300 int updated_area;
302 /* A glyph for a space. */
304 struct glyph space_glyph;
306 /* Non-zero means update has been performed directly, so that there's
307 no need for redisplay_internal to do much work. Set by
308 direct_output_for_insert. */
310 int redisplay_performed_directly_p;
312 /* Counts of allocated structures. These counts serve to diagnose
313 memory leaks and double frees. */
315 int glyph_matrix_count;
316 int glyph_pool_count;
318 /* If non-null, the frame whose frame matrices are manipulated. If
319 null, window matrices are worked on. */
321 static struct frame *frame_matrix_frame;
323 /* Non-zero means that fonts have been loaded since the last glyph
324 matrix adjustments. Redisplay must stop, and glyph matrices must
325 be adjusted when this flag becomes non-zero during display. The
326 reason fonts can be loaded so late is that fonts of fontsets are
327 loaded on demand. */
329 int fonts_changed_p;
331 /* Convert vpos and hpos from frame to window and vice versa.
332 This may only be used for terminal frames. */
334 #if GLYPH_DEBUG
336 static int window_to_frame_vpos P_ ((struct window *, int));
337 static int window_to_frame_hpos P_ ((struct window *, int));
338 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
339 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
341 /* One element of the ring buffer containing redisplay history
342 information. */
344 struct redisplay_history
346 char trace[512 + 100];
349 /* The size of the history buffer. */
351 #define REDISPLAY_HISTORY_SIZE 30
353 /* The redisplay history buffer. */
355 static struct redisplay_history redisplay_history[REDISPLAY_HISTORY_SIZE];
357 /* Next free entry in redisplay_history. */
359 static int history_idx;
361 /* A tick that's incremented each time something is added to the
362 history. */
364 static unsigned history_tick;
366 static void add_frame_display_history P_ ((struct frame *, int));
367 static void add_window_display_history P_ ((struct window *, char *, int));
369 /* Add to the redisplay history how window W has been displayed.
370 MSG is a trace containing the information how W's glyph matrix
371 has been constructed. PAUSED_P non-zero means that the update
372 has been interrupted for pending input. */
374 static void
375 add_window_display_history (w, msg, paused_p)
376 struct window *w;
377 char *msg;
378 int paused_p;
380 char *buf;
382 if (history_idx >= REDISPLAY_HISTORY_SIZE)
383 history_idx = 0;
384 buf = redisplay_history[history_idx].trace;
385 ++history_idx;
387 sprintf (buf, "%d: window %p (`%s')%s\n",
388 history_tick++,
390 ((BUFFERP (w->buffer)
391 && STRINGP (XBUFFER (w->buffer)->name))
392 ? (char *) SDATA (XBUFFER (w->buffer)->name)
393 : "???"),
394 paused_p ? " ***paused***" : "");
395 strcat (buf, msg);
399 /* Add to the redisplay history that frame F has been displayed.
400 PAUSED_P non-zero means that the update has been interrupted for
401 pending input. */
403 static void
404 add_frame_display_history (f, paused_p)
405 struct frame *f;
406 int paused_p;
408 char *buf;
410 if (history_idx >= REDISPLAY_HISTORY_SIZE)
411 history_idx = 0;
412 buf = redisplay_history[history_idx].trace;
413 ++history_idx;
415 sprintf (buf, "%d: update frame %p%s",
416 history_tick++,
417 f, paused_p ? " ***paused***" : "");
421 DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
422 Sdump_redisplay_history, 0, 0, "",
423 doc: /* Dump redisplay history to stderr. */)
426 int i;
428 for (i = history_idx - 1; i != history_idx; --i)
430 if (i < 0)
431 i = REDISPLAY_HISTORY_SIZE - 1;
432 fprintf (stderr, "%s\n", redisplay_history[i].trace);
435 return Qnil;
439 #else /* GLYPH_DEBUG == 0 */
441 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
442 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
444 #endif /* GLYPH_DEBUG == 0 */
447 /* Like bcopy except never gets confused by overlap. Let this be the
448 first function defined in this file, or change emacs.c where the
449 address of this function is used. */
451 void
452 safe_bcopy (from, to, size)
453 const char *from;
454 char *to;
455 int size;
457 if (size <= 0 || from == to)
458 return;
460 /* If the source and destination don't overlap, then bcopy can
461 handle it. If they do overlap, but the destination is lower in
462 memory than the source, we'll assume bcopy can handle that. */
463 if (to < from || from + size <= to)
464 bcopy (from, to, size);
466 /* Otherwise, we'll copy from the end. */
467 else
469 register const char *endf = from + size;
470 register char *endt = to + size;
472 /* If TO - FROM is large, then we should break the copy into
473 nonoverlapping chunks of TO - FROM bytes each. However, if
474 TO - FROM is small, then the bcopy function call overhead
475 makes this not worth it. The crossover point could be about
476 anywhere. Since I don't think the obvious copy loop is too
477 bad, I'm trying to err in its favor. */
478 if (to - from < 64)
481 *--endt = *--endf;
482 while (endf != from);
484 else
486 for (;;)
488 endt -= (to - from);
489 endf -= (to - from);
491 if (endt < to)
492 break;
494 bcopy (endf, endt, to - from);
497 /* If SIZE wasn't a multiple of TO - FROM, there will be a
498 little left over. The amount left over is (endt + (to -
499 from)) - to, which is endt - from. */
500 bcopy (from, to, endt - from);
507 /***********************************************************************
508 Glyph Matrices
509 ***********************************************************************/
511 /* Allocate and return a glyph_matrix structure. POOL is the glyph
512 pool from which memory for the matrix should be allocated, or null
513 for window-based redisplay where no glyph pools are used. The
514 member `pool' of the glyph matrix structure returned is set to
515 POOL, the structure is otherwise zeroed. */
517 struct glyph_matrix *
518 new_glyph_matrix (pool)
519 struct glyph_pool *pool;
521 struct glyph_matrix *result;
523 /* Allocate and clear. */
524 result = (struct glyph_matrix *) xmalloc (sizeof *result);
525 bzero (result, sizeof *result);
527 /* Increment number of allocated matrices. This count is used
528 to detect memory leaks. */
529 ++glyph_matrix_count;
531 /* Set pool and return. */
532 result->pool = pool;
533 return result;
537 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
539 The global counter glyph_matrix_count is decremented when a matrix
540 is freed. If the count gets negative, more structures were freed
541 than allocated, i.e. one matrix was freed more than once or a bogus
542 pointer was passed to this function.
544 If MATRIX->pool is null, this means that the matrix manages its own
545 glyph memory---this is done for matrices on X frames. Freeing the
546 matrix also frees the glyph memory in this case. */
548 static void
549 free_glyph_matrix (matrix)
550 struct glyph_matrix *matrix;
552 if (matrix)
554 int i;
556 /* Detect the case that more matrices are freed than were
557 allocated. */
558 if (--glyph_matrix_count < 0)
559 abort ();
561 /* Free glyph memory if MATRIX owns it. */
562 if (matrix->pool == NULL)
563 for (i = 0; i < matrix->rows_allocated; ++i)
564 xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
566 /* Free row structures and the matrix itself. */
567 xfree (matrix->rows);
568 xfree (matrix);
573 /* Return the number of glyphs to reserve for a marginal area of
574 window W. TOTAL_GLYPHS is the number of glyphs in a complete
575 display line of window W. MARGIN gives the width of the marginal
576 area in canonical character units. MARGIN should be an integer
577 or a float. */
579 static int
580 margin_glyphs_to_reserve (w, total_glyphs, margin)
581 struct window *w;
582 int total_glyphs;
583 Lisp_Object margin;
585 int n;
587 if (NUMBERP (margin))
589 int width = XFASTINT (w->total_cols);
590 double d = max (0, XFLOATINT (margin));
591 d = min (width / 2 - 1, d);
592 n = (int) ((double) total_glyphs / width * d);
594 else
595 n = 0;
597 return n;
601 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
602 window sizes.
604 W is null if the function is called for a frame glyph matrix.
605 Otherwise it is the window MATRIX is a member of. X and Y are the
606 indices of the first column and row of MATRIX within the frame
607 matrix, if such a matrix exists. They are zero for purely
608 window-based redisplay. DIM is the needed size of the matrix.
610 In window-based redisplay, where no frame matrices exist, glyph
611 matrices manage their own glyph storage. Otherwise, they allocate
612 storage from a common frame glyph pool which can be found in
613 MATRIX->pool.
615 The reason for this memory management strategy is to avoid complete
616 frame redraws if possible. When we allocate from a common pool, a
617 change of the location or size of a sub-matrix within the pool
618 requires a complete redisplay of the frame because we cannot easily
619 make sure that the current matrices of all windows still agree with
620 what is displayed on the screen. While this is usually fast, it
621 leads to screen flickering. */
623 static void
624 adjust_glyph_matrix (w, matrix, x, y, dim)
625 struct window *w;
626 struct glyph_matrix *matrix;
627 int x, y;
628 struct dim dim;
630 int i;
631 int new_rows;
632 int marginal_areas_changed_p = 0;
633 int header_line_changed_p = 0;
634 int header_line_p = 0;
635 int left = -1, right = -1;
636 int window_width = -1, window_height;
638 /* See if W had a header line that has disappeared now, or vice versa.
639 Get W's size. */
640 if (w)
642 window_box (w, -1, 0, 0, &window_width, &window_height);
644 header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
645 header_line_changed_p = header_line_p != matrix->header_line_p;
647 matrix->header_line_p = header_line_p;
649 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
650 Do nothing if MATRIX' size, position, vscroll, and marginal areas
651 haven't changed. This optimization is important because preserving
652 the matrix means preventing redisplay. */
653 if (matrix->pool == NULL)
655 left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
656 right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
657 xassert (left >= 0 && right >= 0);
658 marginal_areas_changed_p = (left != matrix->left_margin_glyphs
659 || right != matrix->right_margin_glyphs);
661 if (!marginal_areas_changed_p
662 && !fonts_changed_p
663 && !header_line_changed_p
664 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
665 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
666 && matrix->window_height == window_height
667 && matrix->window_vscroll == w->vscroll
668 && matrix->window_width == window_width)
669 return;
672 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
673 if (matrix->rows_allocated < dim.height)
675 int size = dim.height * sizeof (struct glyph_row);
676 new_rows = dim.height - matrix->rows_allocated;
677 matrix->rows = (struct glyph_row *) xrealloc (matrix->rows, size);
678 bzero (matrix->rows + matrix->rows_allocated,
679 new_rows * sizeof *matrix->rows);
680 matrix->rows_allocated = dim.height;
682 else
683 new_rows = 0;
685 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
686 on a frame not using window-based redisplay. Set up pointers for
687 each row into the glyph pool. */
688 if (matrix->pool)
690 xassert (matrix->pool->glyphs);
692 if (w)
694 left = margin_glyphs_to_reserve (w, dim.width,
695 w->left_margin_cols);
696 right = margin_glyphs_to_reserve (w, dim.width,
697 w->right_margin_cols);
699 else
700 left = right = 0;
702 for (i = 0; i < dim.height; ++i)
704 struct glyph_row *row = &matrix->rows[i];
706 row->glyphs[LEFT_MARGIN_AREA]
707 = (matrix->pool->glyphs
708 + (y + i) * matrix->pool->ncolumns
709 + x);
711 if (w == NULL
712 || row == matrix->rows + dim.height - 1
713 || (row == matrix->rows && matrix->header_line_p))
715 row->glyphs[TEXT_AREA]
716 = row->glyphs[LEFT_MARGIN_AREA];
717 row->glyphs[RIGHT_MARGIN_AREA]
718 = row->glyphs[TEXT_AREA] + dim.width;
719 row->glyphs[LAST_AREA]
720 = row->glyphs[RIGHT_MARGIN_AREA];
722 else
724 row->glyphs[TEXT_AREA]
725 = row->glyphs[LEFT_MARGIN_AREA] + left;
726 row->glyphs[RIGHT_MARGIN_AREA]
727 = row->glyphs[TEXT_AREA] + dim.width - left - right;
728 row->glyphs[LAST_AREA]
729 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
733 matrix->left_margin_glyphs = left;
734 matrix->right_margin_glyphs = right;
736 else
738 /* If MATRIX->pool is null, MATRIX is responsible for managing
739 its own memory. It is a window matrix for window-based redisplay.
740 Allocate glyph memory from the heap. */
741 if (dim.width > matrix->matrix_w
742 || new_rows
743 || header_line_changed_p
744 || marginal_areas_changed_p)
746 struct glyph_row *row = matrix->rows;
747 struct glyph_row *end = row + matrix->rows_allocated;
749 while (row < end)
751 row->glyphs[LEFT_MARGIN_AREA]
752 = (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
753 (dim.width
754 * sizeof (struct glyph)));
756 /* The mode line never has marginal areas. */
757 if (row == matrix->rows + dim.height - 1
758 || (row == matrix->rows && matrix->header_line_p))
760 row->glyphs[TEXT_AREA]
761 = row->glyphs[LEFT_MARGIN_AREA];
762 row->glyphs[RIGHT_MARGIN_AREA]
763 = row->glyphs[TEXT_AREA] + dim.width;
764 row->glyphs[LAST_AREA]
765 = row->glyphs[RIGHT_MARGIN_AREA];
767 else
769 row->glyphs[TEXT_AREA]
770 = row->glyphs[LEFT_MARGIN_AREA] + left;
771 row->glyphs[RIGHT_MARGIN_AREA]
772 = row->glyphs[TEXT_AREA] + dim.width - left - right;
773 row->glyphs[LAST_AREA]
774 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
776 ++row;
780 xassert (left >= 0 && right >= 0);
781 matrix->left_margin_glyphs = left;
782 matrix->right_margin_glyphs = right;
785 /* Number of rows to be used by MATRIX. */
786 matrix->nrows = dim.height;
787 xassert (matrix->nrows >= 0);
789 if (w)
791 if (matrix == w->current_matrix)
793 /* Mark rows in a current matrix of a window as not having
794 valid contents. It's important to not do this for
795 desired matrices. When Emacs starts, it may already be
796 building desired matrices when this function runs. */
797 if (window_width < 0)
798 window_width = window_box_width (w, -1);
800 /* Optimize the case that only the height has changed (C-x 2,
801 upper window). Invalidate all rows that are no longer part
802 of the window. */
803 if (!marginal_areas_changed_p
804 && !header_line_changed_p
805 && new_rows == 0
806 && dim.width == matrix->matrix_w
807 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
808 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
809 && matrix->window_width == window_width)
811 /* Find the last row in the window. */
812 for (i = 0; i < matrix->nrows && matrix->rows[i].enabled_p; ++i)
813 if (MATRIX_ROW_BOTTOM_Y (matrix->rows + i) >= window_height)
815 ++i;
816 break;
819 /* Window end is invalid, if inside of the rows that
820 are invalidated below. */
821 if (INTEGERP (w->window_end_vpos)
822 && XFASTINT (w->window_end_vpos) >= i)
823 w->window_end_valid = Qnil;
825 while (i < matrix->nrows)
826 matrix->rows[i++].enabled_p = 0;
828 else
830 for (i = 0; i < matrix->nrows; ++i)
831 matrix->rows[i].enabled_p = 0;
834 else if (matrix == w->desired_matrix)
836 /* Rows in desired matrices always have to be cleared;
837 redisplay expects this is the case when it runs, so it
838 had better be the case when we adjust matrices between
839 redisplays. */
840 for (i = 0; i < matrix->nrows; ++i)
841 matrix->rows[i].enabled_p = 0;
846 /* Remember last values to be able to optimize frame redraws. */
847 matrix->matrix_x = x;
848 matrix->matrix_y = y;
849 matrix->matrix_w = dim.width;
850 matrix->matrix_h = dim.height;
852 /* Record the top y location and height of W at the time the matrix
853 was last adjusted. This is used to optimize redisplay above. */
854 if (w)
856 matrix->window_left_col = WINDOW_LEFT_EDGE_COL (w);
857 matrix->window_top_line = WINDOW_TOP_EDGE_LINE (w);
858 matrix->window_height = window_height;
859 matrix->window_width = window_width;
860 matrix->window_vscroll = w->vscroll;
865 /* Reverse the contents of rows in MATRIX between START and END. The
866 contents of the row at END - 1 end up at START, END - 2 at START +
867 1 etc. This is part of the implementation of rotate_matrix (see
868 below). */
870 static void
871 reverse_rows (matrix, start, end)
872 struct glyph_matrix *matrix;
873 int start, end;
875 int i, j;
877 for (i = start, j = end - 1; i < j; ++i, --j)
879 /* Non-ISO HP/UX compiler doesn't like auto struct
880 initialization. */
881 struct glyph_row temp;
882 temp = matrix->rows[i];
883 matrix->rows[i] = matrix->rows[j];
884 matrix->rows[j] = temp;
889 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
890 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
891 indices. (Note: this does not copy glyphs, only glyph pointers in
892 row structures are moved around).
894 The algorithm used for rotating the vector was, I believe, first
895 described by Kernighan. See the vector R as consisting of two
896 sub-vectors AB, where A has length BY for BY >= 0. The result
897 after rotating is then BA. Reverse both sub-vectors to get ArBr
898 and reverse the result to get (ArBr)r which is BA. Similar for
899 rotating right. */
901 void
902 rotate_matrix (matrix, first, last, by)
903 struct glyph_matrix *matrix;
904 int first, last, by;
906 if (by < 0)
908 /* Up (rotate left, i.e. towards lower indices). */
909 by = -by;
910 reverse_rows (matrix, first, first + by);
911 reverse_rows (matrix, first + by, last);
912 reverse_rows (matrix, first, last);
914 else if (by > 0)
916 /* Down (rotate right, i.e. towards higher indices). */
917 reverse_rows (matrix, last - by, last);
918 reverse_rows (matrix, first, last - by);
919 reverse_rows (matrix, first, last);
924 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
925 with indices START <= index < END. Increment positions by DELTA/
926 DELTA_BYTES. */
928 void
929 increment_matrix_positions (matrix, start, end, delta, delta_bytes)
930 struct glyph_matrix *matrix;
931 int start, end, delta, delta_bytes;
933 /* Check that START and END are reasonable values. */
934 xassert (start >= 0 && start <= matrix->nrows);
935 xassert (end >= 0 && end <= matrix->nrows);
936 xassert (start <= end);
938 for (; start < end; ++start)
939 increment_row_positions (matrix->rows + start, delta, delta_bytes);
943 /* Enable a range of rows in glyph matrix MATRIX. START and END are
944 the row indices of the first and last + 1 row to enable. If
945 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
947 void
948 enable_glyph_matrix_rows (matrix, start, end, enabled_p)
949 struct glyph_matrix *matrix;
950 int start, end;
951 int enabled_p;
953 xassert (start <= end);
954 xassert (start >= 0 && start < matrix->nrows);
955 xassert (end >= 0 && end <= matrix->nrows);
957 for (; start < end; ++start)
958 matrix->rows[start].enabled_p = enabled_p != 0;
962 /* Clear MATRIX.
964 This empties all rows in MATRIX by setting the enabled_p flag for
965 all rows of the matrix to zero. The function prepare_desired_row
966 will eventually really clear a row when it sees one with a zero
967 enabled_p flag.
969 Resets update hints to defaults value. The only update hint
970 currently present is the flag MATRIX->no_scrolling_p. */
972 void
973 clear_glyph_matrix (matrix)
974 struct glyph_matrix *matrix;
976 if (matrix)
978 enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
979 matrix->no_scrolling_p = 0;
984 /* Shift part of the glyph matrix MATRIX of window W up or down.
985 Increment y-positions in glyph rows between START and END by DY,
986 and recompute their visible height. */
988 void
989 shift_glyph_matrix (w, matrix, start, end, dy)
990 struct window *w;
991 struct glyph_matrix *matrix;
992 int start, end, dy;
994 int min_y, max_y;
996 xassert (start <= end);
997 xassert (start >= 0 && start < matrix->nrows);
998 xassert (end >= 0 && end <= matrix->nrows);
1000 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1001 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1003 for (; start < end; ++start)
1005 struct glyph_row *row = &matrix->rows[start];
1007 row->y += dy;
1008 row->visible_height = row->height;
1010 if (row->y < min_y)
1011 row->visible_height -= min_y - row->y;
1012 if (row->y + row->height > max_y)
1013 row->visible_height -= row->y + row->height - max_y;
1018 /* Mark all rows in current matrices of frame F as invalid. Marking
1019 invalid is done by setting enabled_p to zero for all rows in a
1020 current matrix. */
1022 void
1023 clear_current_matrices (f)
1024 register struct frame *f;
1026 /* Clear frame current matrix, if we have one. */
1027 if (f->current_matrix)
1028 clear_glyph_matrix (f->current_matrix);
1030 /* Clear the matrix of the menu bar window, if such a window exists.
1031 The menu bar window is currently used to display menus on X when
1032 no toolkit support is compiled in. */
1033 if (WINDOWP (f->menu_bar_window))
1034 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1036 /* Clear the matrix of the tool-bar window, if any. */
1037 if (WINDOWP (f->tool_bar_window))
1038 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1040 /* Clear current window matrices. */
1041 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1042 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
1046 /* Clear out all display lines of F for a coming redisplay. */
1048 void
1049 clear_desired_matrices (f)
1050 register struct frame *f;
1052 if (f->desired_matrix)
1053 clear_glyph_matrix (f->desired_matrix);
1055 if (WINDOWP (f->menu_bar_window))
1056 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
1058 if (WINDOWP (f->tool_bar_window))
1059 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
1061 /* Do it for window matrices. */
1062 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1063 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
1067 /* Clear matrices in window tree rooted in W. If DESIRED_P is
1068 non-zero clear desired matrices, otherwise clear current matrices. */
1070 static void
1071 clear_window_matrices (w, desired_p)
1072 struct window *w;
1073 int desired_p;
1075 while (w)
1077 if (!NILP (w->hchild))
1079 xassert (WINDOWP (w->hchild));
1080 clear_window_matrices (XWINDOW (w->hchild), desired_p);
1082 else if (!NILP (w->vchild))
1084 xassert (WINDOWP (w->vchild));
1085 clear_window_matrices (XWINDOW (w->vchild), desired_p);
1087 else
1089 if (desired_p)
1090 clear_glyph_matrix (w->desired_matrix);
1091 else
1093 clear_glyph_matrix (w->current_matrix);
1094 w->window_end_valid = Qnil;
1098 w = NILP (w->next) ? 0 : XWINDOW (w->next);
1104 /***********************************************************************
1105 Glyph Rows
1107 See dispextern.h for an overall explanation of glyph rows.
1108 ***********************************************************************/
1110 /* Clear glyph row ROW. Do it in a way that makes it robust against
1111 changes in the glyph_row structure, i.e. addition or removal of
1112 structure members. */
1114 static struct glyph_row null_row;
1116 void
1117 clear_glyph_row (row)
1118 struct glyph_row *row;
1120 struct glyph *p[1 + LAST_AREA];
1122 /* Save pointers. */
1123 p[LEFT_MARGIN_AREA] = row->glyphs[LEFT_MARGIN_AREA];
1124 p[TEXT_AREA] = row->glyphs[TEXT_AREA];
1125 p[RIGHT_MARGIN_AREA] = row->glyphs[RIGHT_MARGIN_AREA];
1126 p[LAST_AREA] = row->glyphs[LAST_AREA];
1128 /* Clear. */
1129 *row = null_row;
1131 /* Restore pointers. */
1132 row->glyphs[LEFT_MARGIN_AREA] = p[LEFT_MARGIN_AREA];
1133 row->glyphs[TEXT_AREA] = p[TEXT_AREA];
1134 row->glyphs[RIGHT_MARGIN_AREA] = p[RIGHT_MARGIN_AREA];
1135 row->glyphs[LAST_AREA] = p[LAST_AREA];
1137 #if 0 /* At some point, some bit-fields of struct glyph were not set,
1138 which made glyphs unequal when compared with GLYPH_EQUAL_P.
1139 Redisplay outputs such glyphs, and flickering effects were
1140 the result. This also depended on the contents of memory
1141 returned by xmalloc. If flickering happens again, activate
1142 the code below. If the flickering is gone with that, chances
1143 are that the flickering has the same reason as here. */
1144 bzero (p[0], (char *) p[LAST_AREA] - (char *) p[0]);
1145 #endif
1149 /* Make ROW an empty, enabled row of canonical character height,
1150 in window W starting at y-position Y. */
1152 void
1153 blank_row (w, row, y)
1154 struct window *w;
1155 struct glyph_row *row;
1156 int y;
1158 int min_y, max_y;
1160 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1161 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1163 clear_glyph_row (row);
1164 row->y = y;
1165 row->ascent = row->phys_ascent = 0;
1166 row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
1167 row->visible_height = row->height;
1169 if (row->y < min_y)
1170 row->visible_height -= min_y - row->y;
1171 if (row->y + row->height > max_y)
1172 row->visible_height -= row->y + row->height - max_y;
1174 row->enabled_p = 1;
1178 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1179 are the amounts by which to change positions. Note that the first
1180 glyph of the text area of a row can have a buffer position even if
1181 the used count of the text area is zero. Such rows display line
1182 ends. */
1184 void
1185 increment_row_positions (row, delta, delta_bytes)
1186 struct glyph_row *row;
1187 int delta, delta_bytes;
1189 int area, i;
1191 /* Increment start and end positions. */
1192 MATRIX_ROW_START_CHARPOS (row) += delta;
1193 MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
1194 MATRIX_ROW_END_CHARPOS (row) += delta;
1195 MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
1197 if (!row->enabled_p)
1198 return;
1200 /* Increment positions in glyphs. */
1201 for (area = 0; area < LAST_AREA; ++area)
1202 for (i = 0; i < row->used[area]; ++i)
1203 if (BUFFERP (row->glyphs[area][i].object)
1204 && row->glyphs[area][i].charpos > 0)
1205 row->glyphs[area][i].charpos += delta;
1207 /* Capture the case of rows displaying a line end. */
1208 if (row->used[TEXT_AREA] == 0
1209 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
1210 row->glyphs[TEXT_AREA]->charpos += delta;
1214 #if 0
1215 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1216 contents, i.e. glyph structure contents are exchanged between A and
1217 B without changing glyph pointers in A and B. */
1219 static void
1220 swap_glyphs_in_rows (a, b)
1221 struct glyph_row *a, *b;
1223 int area;
1225 for (area = 0; area < LAST_AREA; ++area)
1227 /* Number of glyphs to swap. */
1228 int max_used = max (a->used[area], b->used[area]);
1230 /* Start of glyphs in area of row A. */
1231 struct glyph *glyph_a = a->glyphs[area];
1233 /* End + 1 of glyphs in area of row A. */
1234 struct glyph *glyph_a_end = a->glyphs[max_used];
1236 /* Start of glyphs in area of row B. */
1237 struct glyph *glyph_b = b->glyphs[area];
1239 while (glyph_a < glyph_a_end)
1241 /* Non-ISO HP/UX compiler doesn't like auto struct
1242 initialization. */
1243 struct glyph temp;
1244 temp = *glyph_a;
1245 *glyph_a = *glyph_b;
1246 *glyph_b = temp;
1247 ++glyph_a;
1248 ++glyph_b;
1253 #endif /* 0 */
1255 /* Exchange pointers to glyph memory between glyph rows A and B. */
1257 static INLINE void
1258 swap_glyph_pointers (a, b)
1259 struct glyph_row *a, *b;
1261 int i;
1262 for (i = 0; i < LAST_AREA + 1; ++i)
1264 struct glyph *temp = a->glyphs[i];
1265 a->glyphs[i] = b->glyphs[i];
1266 b->glyphs[i] = temp;
1271 /* Copy glyph row structure FROM to glyph row structure TO, except
1272 that glyph pointers in the structures are left unchanged. */
1274 INLINE void
1275 copy_row_except_pointers (to, from)
1276 struct glyph_row *to, *from;
1278 struct glyph *pointers[1 + LAST_AREA];
1280 /* Save glyph pointers of TO. */
1281 bcopy (to->glyphs, pointers, sizeof to->glyphs);
1283 /* Do a structure assignment. */
1284 *to = *from;
1286 /* Restore original pointers of TO. */
1287 bcopy (pointers, to->glyphs, sizeof to->glyphs);
1291 /* Copy contents of glyph row FROM to glyph row TO. Glyph pointers in
1292 TO and FROM are left unchanged. Glyph contents are copied from the
1293 glyph memory of FROM to the glyph memory of TO. Increment buffer
1294 positions in row TO by DELTA/ DELTA_BYTES. */
1296 void
1297 copy_glyph_row_contents (to, from, delta, delta_bytes)
1298 struct glyph_row *to, *from;
1299 int delta, delta_bytes;
1301 int area;
1303 /* This is like a structure assignment TO = FROM, except that
1304 glyph pointers in the rows are left unchanged. */
1305 copy_row_except_pointers (to, from);
1307 /* Copy glyphs from FROM to TO. */
1308 for (area = 0; area < LAST_AREA; ++area)
1309 if (from->used[area])
1310 bcopy (from->glyphs[area], to->glyphs[area],
1311 from->used[area] * sizeof (struct glyph));
1313 /* Increment buffer positions in TO by DELTA. */
1314 increment_row_positions (to, delta, delta_bytes);
1318 /* Assign glyph row FROM to glyph row TO. This works like a structure
1319 assignment TO = FROM, except that glyph pointers are not copied but
1320 exchanged between TO and FROM. Pointers must be exchanged to avoid
1321 a memory leak. */
1323 static INLINE void
1324 assign_row (to, from)
1325 struct glyph_row *to, *from;
1327 swap_glyph_pointers (to, from);
1328 copy_row_except_pointers (to, from);
1332 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1333 a row in a window matrix, is a slice of the glyph memory of the
1334 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1335 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1336 memory of FRAME_ROW. */
1338 #if GLYPH_DEBUG
1340 static int
1341 glyph_row_slice_p (window_row, frame_row)
1342 struct glyph_row *window_row, *frame_row;
1344 struct glyph *window_glyph_start = window_row->glyphs[0];
1345 struct glyph *frame_glyph_start = frame_row->glyphs[0];
1346 struct glyph *frame_glyph_end = frame_row->glyphs[LAST_AREA];
1348 return (frame_glyph_start <= window_glyph_start
1349 && window_glyph_start < frame_glyph_end);
1352 #endif /* GLYPH_DEBUG */
1354 #if 0
1356 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1357 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1358 in WINDOW_MATRIX is found satisfying the condition. */
1360 static struct glyph_row *
1361 find_glyph_row_slice (window_matrix, frame_matrix, row)
1362 struct glyph_matrix *window_matrix, *frame_matrix;
1363 int row;
1365 int i;
1367 xassert (row >= 0 && row < frame_matrix->nrows);
1369 for (i = 0; i < window_matrix->nrows; ++i)
1370 if (glyph_row_slice_p (window_matrix->rows + i,
1371 frame_matrix->rows + row))
1372 break;
1374 return i < window_matrix->nrows ? window_matrix->rows + i : 0;
1377 #endif /* 0 */
1379 /* Prepare ROW for display. Desired rows are cleared lazily,
1380 i.e. they are only marked as to be cleared by setting their
1381 enabled_p flag to zero. When a row is to be displayed, a prior
1382 call to this function really clears it. */
1384 void
1385 prepare_desired_row (row)
1386 struct glyph_row *row;
1388 if (!row->enabled_p)
1390 clear_glyph_row (row);
1391 row->enabled_p = 1;
1396 /* Return a hash code for glyph row ROW. */
1399 line_hash_code (row)
1400 struct glyph_row *row;
1402 int hash = 0;
1404 if (row->enabled_p)
1406 struct glyph *glyph = row->glyphs[TEXT_AREA];
1407 struct glyph *end = glyph + row->used[TEXT_AREA];
1409 while (glyph < end)
1411 int c = glyph->u.ch;
1412 int face_id = glyph->face_id;
1413 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1414 c -= SPACEGLYPH;
1415 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + c;
1416 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + face_id;
1417 ++glyph;
1420 if (hash == 0)
1421 hash = 1;
1424 return hash;
1428 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1429 the number of characters in the line. If must_write_spaces is
1430 zero, leading and trailing spaces are ignored. */
1432 static unsigned int
1433 line_draw_cost (matrix, vpos)
1434 struct glyph_matrix *matrix;
1435 int vpos;
1437 struct glyph_row *row = matrix->rows + vpos;
1438 struct glyph *beg = row->glyphs[TEXT_AREA];
1439 struct glyph *end = beg + row->used[TEXT_AREA];
1440 int len;
1441 Lisp_Object *glyph_table_base = GLYPH_TABLE_BASE;
1442 int glyph_table_len = GLYPH_TABLE_LENGTH;
1444 /* Ignore trailing and leading spaces if we can. */
1445 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1447 /* Skip from the end over trailing spaces. */
1448 while (end > beg && CHAR_GLYPH_SPACE_P (*(end - 1)))
1449 --end;
1451 /* All blank line. */
1452 if (end == beg)
1453 return 0;
1455 /* Skip over leading spaces. */
1456 while (CHAR_GLYPH_SPACE_P (*beg))
1457 ++beg;
1460 /* If we don't have a glyph-table, each glyph is one character,
1461 so return the number of glyphs. */
1462 if (glyph_table_base == 0)
1463 len = end - beg;
1464 else
1466 /* Otherwise, scan the glyphs and accumulate their total length
1467 in LEN. */
1468 len = 0;
1469 while (beg < end)
1471 GLYPH g = GLYPH_FROM_CHAR_GLYPH (*beg);
1473 if (g < 0
1474 || GLYPH_SIMPLE_P (glyph_table_base, glyph_table_len, g))
1475 len += 1;
1476 else
1477 len += GLYPH_LENGTH (glyph_table_base, g);
1479 ++beg;
1483 return len;
1487 /* Test two glyph rows A and B for equality. Value is non-zero if A
1488 and B have equal contents. W is the window to which the glyphs
1489 rows A and B belong. It is needed here to test for partial row
1490 visibility. MOUSE_FACE_P non-zero means compare the mouse_face_p
1491 flags of A and B, too. */
1493 static INLINE int
1494 row_equal_p (w, a, b, mouse_face_p)
1495 struct window *w;
1496 struct glyph_row *a, *b;
1497 int mouse_face_p;
1499 if (a == b)
1500 return 1;
1501 else if (a->hash != b->hash)
1502 return 0;
1503 else
1505 struct glyph *a_glyph, *b_glyph, *a_end;
1506 int area;
1508 if (mouse_face_p && a->mouse_face_p != b->mouse_face_p)
1509 return 0;
1511 /* Compare glyphs. */
1512 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
1514 if (a->used[area] != b->used[area])
1515 return 0;
1517 a_glyph = a->glyphs[area];
1518 a_end = a_glyph + a->used[area];
1519 b_glyph = b->glyphs[area];
1521 while (a_glyph < a_end
1522 && GLYPH_EQUAL_P (a_glyph, b_glyph))
1523 ++a_glyph, ++b_glyph;
1525 if (a_glyph != a_end)
1526 return 0;
1529 if (a->fill_line_p != b->fill_line_p
1530 || a->cursor_in_fringe_p != b->cursor_in_fringe_p
1531 || a->left_fringe_bitmap != b->left_fringe_bitmap
1532 || a->left_fringe_face_id != b->left_fringe_face_id
1533 || a->right_fringe_bitmap != b->right_fringe_bitmap
1534 || a->right_fringe_face_id != b->right_fringe_face_id
1535 || a->overlay_arrow_bitmap != b->overlay_arrow_bitmap
1536 || a->exact_window_width_line_p != b->exact_window_width_line_p
1537 || a->overlapped_p != b->overlapped_p
1538 || (MATRIX_ROW_CONTINUATION_LINE_P (a)
1539 != MATRIX_ROW_CONTINUATION_LINE_P (b))
1540 /* Different partially visible characters on left margin. */
1541 || a->x != b->x
1542 /* Different height. */
1543 || a->ascent != b->ascent
1544 || a->phys_ascent != b->phys_ascent
1545 || a->phys_height != b->phys_height
1546 || a->visible_height != b->visible_height)
1547 return 0;
1550 return 1;
1555 /***********************************************************************
1556 Glyph Pool
1558 See dispextern.h for an overall explanation of glyph pools.
1559 ***********************************************************************/
1561 /* Allocate a glyph_pool structure. The structure returned is
1562 initialized with zeros. The global variable glyph_pool_count is
1563 incremented for each pool allocated. */
1565 static struct glyph_pool *
1566 new_glyph_pool ()
1568 struct glyph_pool *result;
1570 /* Allocate a new glyph_pool and clear it. */
1571 result = (struct glyph_pool *) xmalloc (sizeof *result);
1572 bzero (result, sizeof *result);
1574 /* For memory leak and double deletion checking. */
1575 ++glyph_pool_count;
1577 return result;
1581 /* Free a glyph_pool structure POOL. The function may be called with
1582 a null POOL pointer. The global variable glyph_pool_count is
1583 decremented with every pool structure freed. If this count gets
1584 negative, more structures were freed than allocated, i.e. one
1585 structure must have been freed more than once or a bogus pointer
1586 was passed to free_glyph_pool. */
1588 static void
1589 free_glyph_pool (pool)
1590 struct glyph_pool *pool;
1592 if (pool)
1594 /* More freed than allocated? */
1595 --glyph_pool_count;
1596 xassert (glyph_pool_count >= 0);
1598 xfree (pool->glyphs);
1599 xfree (pool);
1604 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1605 columns we need. This function never shrinks a pool. The only
1606 case in which this would make sense, would be when a frame's size
1607 is changed from a large value to a smaller one. But, if someone
1608 does it once, we can expect that he will do it again.
1610 Value is non-zero if the pool changed in a way which makes
1611 re-adjusting window glyph matrices necessary. */
1613 static int
1614 realloc_glyph_pool (pool, matrix_dim)
1615 struct glyph_pool *pool;
1616 struct dim matrix_dim;
1618 int needed;
1619 int changed_p;
1621 changed_p = (pool->glyphs == 0
1622 || matrix_dim.height != pool->nrows
1623 || matrix_dim.width != pool->ncolumns);
1625 /* Enlarge the glyph pool. */
1626 needed = matrix_dim.width * matrix_dim.height;
1627 if (needed > pool->nglyphs)
1629 int size = needed * sizeof (struct glyph);
1631 if (pool->glyphs)
1632 pool->glyphs = (struct glyph *) xrealloc (pool->glyphs, size);
1633 else
1635 pool->glyphs = (struct glyph *) xmalloc (size);
1636 bzero (pool->glyphs, size);
1639 pool->nglyphs = needed;
1642 /* Remember the number of rows and columns because (a) we use them
1643 to do sanity checks, and (b) the number of columns determines
1644 where rows in the frame matrix start---this must be available to
1645 determine pointers to rows of window sub-matrices. */
1646 pool->nrows = matrix_dim.height;
1647 pool->ncolumns = matrix_dim.width;
1649 return changed_p;
1654 /***********************************************************************
1655 Debug Code
1656 ***********************************************************************/
1658 #if GLYPH_DEBUG
1661 /* Flush standard output. This is sometimes useful to call from the debugger.
1662 XXX Maybe this should be changed to flush the current terminal instead of
1663 stdout.
1666 void
1667 flush_stdout ()
1669 fflush (stdout);
1673 /* Check that no glyph pointers have been lost in MATRIX. If a
1674 pointer has been lost, e.g. by using a structure assignment between
1675 rows, at least one pointer must occur more than once in the rows of
1676 MATRIX. */
1678 void
1679 check_matrix_pointer_lossage (matrix)
1680 struct glyph_matrix *matrix;
1682 int i, j;
1684 for (i = 0; i < matrix->nrows; ++i)
1685 for (j = 0; j < matrix->nrows; ++j)
1686 xassert (i == j
1687 || (matrix->rows[i].glyphs[TEXT_AREA]
1688 != matrix->rows[j].glyphs[TEXT_AREA]));
1692 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1694 struct glyph_row *
1695 matrix_row (matrix, row)
1696 struct glyph_matrix *matrix;
1697 int row;
1699 xassert (matrix && matrix->rows);
1700 xassert (row >= 0 && row < matrix->nrows);
1702 /* That's really too slow for normal testing because this function
1703 is called almost everywhere. Although---it's still astonishingly
1704 fast, so it is valuable to have for debugging purposes. */
1705 #if 0
1706 check_matrix_pointer_lossage (matrix);
1707 #endif
1709 return matrix->rows + row;
1713 #if 0 /* This function makes invalid assumptions when text is
1714 partially invisible. But it might come handy for debugging
1715 nevertheless. */
1717 /* Check invariants that must hold for an up to date current matrix of
1718 window W. */
1720 static void
1721 check_matrix_invariants (w)
1722 struct window *w;
1724 struct glyph_matrix *matrix = w->current_matrix;
1725 int yb = window_text_bottom_y (w);
1726 struct glyph_row *row = matrix->rows;
1727 struct glyph_row *last_text_row = NULL;
1728 struct buffer *saved = current_buffer;
1729 struct buffer *buffer = XBUFFER (w->buffer);
1730 int c;
1732 /* This can sometimes happen for a fresh window. */
1733 if (matrix->nrows < 2)
1734 return;
1736 set_buffer_temp (buffer);
1738 /* Note: last row is always reserved for the mode line. */
1739 while (MATRIX_ROW_DISPLAYS_TEXT_P (row)
1740 && MATRIX_ROW_BOTTOM_Y (row) < yb)
1742 struct glyph_row *next = row + 1;
1744 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
1745 last_text_row = row;
1747 /* Check that character and byte positions are in sync. */
1748 xassert (MATRIX_ROW_START_BYTEPOS (row)
1749 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row)));
1751 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1752 have such a position temporarily in case of a minibuffer
1753 displaying something like `[Sole completion]' at its end. */
1754 if (MATRIX_ROW_END_CHARPOS (row) < BUF_ZV (current_buffer))
1755 xassert (MATRIX_ROW_END_BYTEPOS (row)
1756 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row)));
1758 /* Check that end position of `row' is equal to start position
1759 of next row. */
1760 if (next->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (next))
1762 xassert (MATRIX_ROW_END_CHARPOS (row)
1763 == MATRIX_ROW_START_CHARPOS (next));
1764 xassert (MATRIX_ROW_END_BYTEPOS (row)
1765 == MATRIX_ROW_START_BYTEPOS (next));
1767 row = next;
1770 xassert (w->current_matrix->nrows == w->desired_matrix->nrows);
1771 xassert (w->desired_matrix->rows != NULL);
1772 set_buffer_temp (saved);
1775 #endif /* 0 */
1777 #endif /* GLYPH_DEBUG != 0 */
1781 /**********************************************************************
1782 Allocating/ Adjusting Glyph Matrices
1783 **********************************************************************/
1785 /* Allocate glyph matrices over a window tree for a frame-based
1786 redisplay
1788 X and Y are column/row within the frame glyph matrix where
1789 sub-matrices for the window tree rooted at WINDOW must be
1790 allocated. DIM_ONLY_P non-zero means that the caller of this
1791 function is only interested in the result matrix dimension, and
1792 matrix adjustments should not be performed.
1794 The function returns the total width/height of the sub-matrices of
1795 the window tree. If called on a frame root window, the computation
1796 will take the mini-buffer window into account.
1798 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1800 NEW_LEAF_MATRIX set if any window in the tree did not have a
1801 glyph matrices yet, and
1803 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1804 any window in the tree will be changed or have been changed (see
1805 DIM_ONLY_P)
1807 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1808 function.
1810 Windows are arranged into chains of windows on the same level
1811 through the next fields of window structures. Such a level can be
1812 either a sequence of horizontally adjacent windows from left to
1813 right, or a sequence of vertically adjacent windows from top to
1814 bottom. Each window in a horizontal sequence can be either a leaf
1815 window or a vertical sequence; a window in a vertical sequence can
1816 be either a leaf or a horizontal sequence. All windows in a
1817 horizontal sequence have the same height, and all windows in a
1818 vertical sequence have the same width.
1820 This function uses, for historical reasons, a more general
1821 algorithm to determine glyph matrix dimensions that would be
1822 necessary.
1824 The matrix height of a horizontal sequence is determined by the
1825 maximum height of any matrix in the sequence. The matrix width of
1826 a horizontal sequence is computed by adding up matrix widths of
1827 windows in the sequence.
1829 |<------- result width ------->|
1830 +---------+----------+---------+ ---
1831 | | | | |
1832 | | | |
1833 +---------+ | | result height
1834 | +---------+
1835 | | |
1836 +----------+ ---
1838 The matrix width of a vertical sequence is the maximum matrix width
1839 of any window in the sequence. Its height is computed by adding up
1840 matrix heights of windows in the sequence.
1842 |<---- result width -->|
1843 +---------+ ---
1844 | | |
1845 | | |
1846 +---------+--+ |
1847 | | |
1848 | | result height
1850 +------------+---------+ |
1851 | | |
1852 | | |
1853 +------------+---------+ --- */
1855 /* Bit indicating that a new matrix will be allocated or has been
1856 allocated. */
1858 #define NEW_LEAF_MATRIX (1 << 0)
1860 /* Bit indicating that a matrix will or has changed its location or
1861 size. */
1863 #define CHANGED_LEAF_MATRIX (1 << 1)
1865 static struct dim
1866 allocate_matrices_for_frame_redisplay (window, x, y, dim_only_p,
1867 window_change_flags)
1868 Lisp_Object window;
1869 int x, y;
1870 int dim_only_p;
1871 int *window_change_flags;
1873 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1874 int x0 = x, y0 = y;
1875 int wmax = 0, hmax = 0;
1876 struct dim total;
1877 struct dim dim;
1878 struct window *w;
1879 int in_horz_combination_p;
1881 /* What combination is WINDOW part of? Compute this once since the
1882 result is the same for all windows in the `next' chain. The
1883 special case of a root window (parent equal to nil) is treated
1884 like a vertical combination because a root window's `next'
1885 points to the mini-buffer window, if any, which is arranged
1886 vertically below other windows. */
1887 in_horz_combination_p
1888 = (!NILP (XWINDOW (window)->parent)
1889 && !NILP (XWINDOW (XWINDOW (window)->parent)->hchild));
1891 /* For WINDOW and all windows on the same level. */
1894 w = XWINDOW (window);
1896 /* Get the dimension of the window sub-matrix for W, depending
1897 on whether this is a combination or a leaf window. */
1898 if (!NILP (w->hchild))
1899 dim = allocate_matrices_for_frame_redisplay (w->hchild, x, y,
1900 dim_only_p,
1901 window_change_flags);
1902 else if (!NILP (w->vchild))
1903 dim = allocate_matrices_for_frame_redisplay (w->vchild, x, y,
1904 dim_only_p,
1905 window_change_flags);
1906 else
1908 /* If not already done, allocate sub-matrix structures. */
1909 if (w->desired_matrix == NULL)
1911 w->desired_matrix = new_glyph_matrix (f->desired_pool);
1912 w->current_matrix = new_glyph_matrix (f->current_pool);
1913 *window_change_flags |= NEW_LEAF_MATRIX;
1916 /* Width and height MUST be chosen so that there are no
1917 holes in the frame matrix. */
1918 dim.width = required_matrix_width (w);
1919 dim.height = required_matrix_height (w);
1921 /* Will matrix be re-allocated? */
1922 if (x != w->desired_matrix->matrix_x
1923 || y != w->desired_matrix->matrix_y
1924 || dim.width != w->desired_matrix->matrix_w
1925 || dim.height != w->desired_matrix->matrix_h
1926 || (margin_glyphs_to_reserve (w, dim.width,
1927 w->left_margin_cols)
1928 != w->desired_matrix->left_margin_glyphs)
1929 || (margin_glyphs_to_reserve (w, dim.width,
1930 w->right_margin_cols)
1931 != w->desired_matrix->right_margin_glyphs))
1932 *window_change_flags |= CHANGED_LEAF_MATRIX;
1934 /* Actually change matrices, if allowed. Do not consider
1935 CHANGED_LEAF_MATRIX computed above here because the pool
1936 may have been changed which we don't now here. We trust
1937 that we only will be called with DIM_ONLY_P != 0 when
1938 necessary. */
1939 if (!dim_only_p)
1941 adjust_glyph_matrix (w, w->desired_matrix, x, y, dim);
1942 adjust_glyph_matrix (w, w->current_matrix, x, y, dim);
1946 /* If we are part of a horizontal combination, advance x for
1947 windows to the right of W; otherwise advance y for windows
1948 below W. */
1949 if (in_horz_combination_p)
1950 x += dim.width;
1951 else
1952 y += dim.height;
1954 /* Remember maximum glyph matrix dimensions. */
1955 wmax = max (wmax, dim.width);
1956 hmax = max (hmax, dim.height);
1958 /* Next window on same level. */
1959 window = w->next;
1961 while (!NILP (window));
1963 /* Set `total' to the total glyph matrix dimension of this window
1964 level. In a vertical combination, the width is the width of the
1965 widest window; the height is the y we finally reached, corrected
1966 by the y we started with. In a horizontal combination, the total
1967 height is the height of the tallest window, and the width is the
1968 x we finally reached, corrected by the x we started with. */
1969 if (in_horz_combination_p)
1971 total.width = x - x0;
1972 total.height = hmax;
1974 else
1976 total.width = wmax;
1977 total.height = y - y0;
1980 return total;
1984 /* Return the required height of glyph matrices for window W. */
1987 required_matrix_height (w)
1988 struct window *w;
1990 #ifdef HAVE_WINDOW_SYSTEM
1991 struct frame *f = XFRAME (w->frame);
1993 if (FRAME_WINDOW_P (f))
1995 int ch_height = FRAME_SMALLEST_FONT_HEIGHT (f);
1996 int window_pixel_height = window_box_height (w) + eabs (w->vscroll);
1997 return (((window_pixel_height + ch_height - 1)
1998 / ch_height) * w->nrows_scale_factor
1999 /* One partially visible line at the top and
2000 bottom of the window. */
2002 /* 2 for header and mode line. */
2003 + 2);
2005 #endif /* HAVE_WINDOW_SYSTEM */
2007 return WINDOW_TOTAL_LINES (w);
2011 /* Return the required width of glyph matrices for window W. */
2014 required_matrix_width (w)
2015 struct window *w;
2017 #ifdef HAVE_WINDOW_SYSTEM
2018 struct frame *f = XFRAME (w->frame);
2019 if (FRAME_WINDOW_P (f))
2021 int ch_width = FRAME_SMALLEST_CHAR_WIDTH (f);
2022 int window_pixel_width = WINDOW_TOTAL_WIDTH (w);
2024 /* Compute number of glyphs needed in a glyph row. */
2025 return (((window_pixel_width + ch_width - 1)
2026 / ch_width) * w->ncols_scale_factor
2027 /* 2 partially visible columns in the text area. */
2029 /* One partially visible column at the right
2030 edge of each marginal area. */
2031 + 1 + 1);
2033 #endif /* HAVE_WINDOW_SYSTEM */
2035 return XINT (w->total_cols);
2039 /* Allocate window matrices for window-based redisplay. W is the
2040 window whose matrices must be allocated/reallocated. */
2042 static void
2043 allocate_matrices_for_window_redisplay (w)
2044 struct window *w;
2046 while (w)
2048 if (!NILP (w->vchild))
2049 allocate_matrices_for_window_redisplay (XWINDOW (w->vchild));
2050 else if (!NILP (w->hchild))
2051 allocate_matrices_for_window_redisplay (XWINDOW (w->hchild));
2052 else
2054 /* W is a leaf window. */
2055 struct dim dim;
2057 /* If matrices are not yet allocated, allocate them now. */
2058 if (w->desired_matrix == NULL)
2060 w->desired_matrix = new_glyph_matrix (NULL);
2061 w->current_matrix = new_glyph_matrix (NULL);
2064 dim.width = required_matrix_width (w);
2065 dim.height = required_matrix_height (w);
2066 adjust_glyph_matrix (w, w->desired_matrix, 0, 0, dim);
2067 adjust_glyph_matrix (w, w->current_matrix, 0, 0, dim);
2070 w = NILP (w->next) ? NULL : XWINDOW (w->next);
2075 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
2076 do it for all frames; otherwise do it just for the given frame.
2077 This function must be called when a new frame is created, its size
2078 changes, or its window configuration changes. */
2080 void
2081 adjust_glyphs (f)
2082 struct frame *f;
2084 /* Block input so that expose events and other events that access
2085 glyph matrices are not processed while we are changing them. */
2086 BLOCK_INPUT;
2088 if (f)
2089 adjust_frame_glyphs (f);
2090 else
2092 Lisp_Object tail, lisp_frame;
2094 FOR_EACH_FRAME (tail, lisp_frame)
2095 adjust_frame_glyphs (XFRAME (lisp_frame));
2098 UNBLOCK_INPUT;
2102 /* Adjust frame glyphs when Emacs is initialized.
2104 To be called from init_display.
2106 We need a glyph matrix because redraw will happen soon.
2107 Unfortunately, window sizes on selected_frame are not yet set to
2108 meaningful values. I believe we can assume that there are only two
2109 windows on the frame---the mini-buffer and the root window. Frame
2110 height and width seem to be correct so far. So, set the sizes of
2111 windows to estimated values. */
2113 static void
2114 adjust_frame_glyphs_initially ()
2116 struct frame *sf = SELECTED_FRAME ();
2117 struct window *root = XWINDOW (sf->root_window);
2118 struct window *mini = XWINDOW (root->next);
2119 int frame_lines = FRAME_LINES (sf);
2120 int frame_cols = FRAME_COLS (sf);
2121 int top_margin = FRAME_TOP_MARGIN (sf);
2123 /* Do it for the root window. */
2124 XSETFASTINT (root->top_line, top_margin);
2125 XSETFASTINT (root->total_cols, frame_cols);
2126 set_window_height (sf->root_window, frame_lines - 1 - top_margin, 0);
2128 /* Do it for the mini-buffer window. */
2129 XSETFASTINT (mini->top_line, frame_lines - 1);
2130 XSETFASTINT (mini->total_cols, frame_cols);
2131 set_window_height (root->next, 1, 0);
2133 adjust_frame_glyphs (sf);
2134 glyphs_initialized_initially_p = 1;
2138 /* Allocate/reallocate glyph matrices of a single frame F. */
2140 static void
2141 adjust_frame_glyphs (f)
2142 struct frame *f;
2144 if (FRAME_WINDOW_P (f))
2145 adjust_frame_glyphs_for_window_redisplay (f);
2146 else
2147 adjust_frame_glyphs_for_frame_redisplay (f);
2149 /* Don't forget the message buffer and the buffer for
2150 decode_mode_spec. */
2151 adjust_frame_message_buffer (f);
2152 adjust_decode_mode_spec_buffer (f);
2154 f->glyphs_initialized_p = 1;
2157 /* Return 1 if any window in the tree has nonzero window margins. See
2158 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
2159 static int
2160 showing_window_margins_p (w)
2161 struct window *w;
2163 while (w)
2165 if (!NILP (w->hchild))
2167 if (showing_window_margins_p (XWINDOW (w->hchild)))
2168 return 1;
2170 else if (!NILP (w->vchild))
2172 if (showing_window_margins_p (XWINDOW (w->vchild)))
2173 return 1;
2175 else if (!NILP (w->left_margin_cols)
2176 || !NILP (w->right_margin_cols))
2177 return 1;
2179 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2181 return 0;
2185 /* In the window tree with root W, build current matrices of leaf
2186 windows from the frame's current matrix. */
2188 static void
2189 fake_current_matrices (window)
2190 Lisp_Object window;
2192 struct window *w;
2194 for (; !NILP (window); window = w->next)
2196 w = XWINDOW (window);
2198 if (!NILP (w->hchild))
2199 fake_current_matrices (w->hchild);
2200 else if (!NILP (w->vchild))
2201 fake_current_matrices (w->vchild);
2202 else
2204 int i;
2205 struct frame *f = XFRAME (w->frame);
2206 struct glyph_matrix *m = w->current_matrix;
2207 struct glyph_matrix *fm = f->current_matrix;
2209 xassert (m->matrix_h == WINDOW_TOTAL_LINES (w));
2210 xassert (m->matrix_w == WINDOW_TOTAL_COLS (w));
2212 for (i = 0; i < m->matrix_h; ++i)
2214 struct glyph_row *r = m->rows + i;
2215 struct glyph_row *fr = fm->rows + i + WINDOW_TOP_EDGE_LINE (w);
2217 xassert (r->glyphs[TEXT_AREA] >= fr->glyphs[TEXT_AREA]
2218 && r->glyphs[LAST_AREA] <= fr->glyphs[LAST_AREA]);
2220 r->enabled_p = fr->enabled_p;
2221 if (r->enabled_p)
2223 r->used[LEFT_MARGIN_AREA] = m->left_margin_glyphs;
2224 r->used[RIGHT_MARGIN_AREA] = m->right_margin_glyphs;
2225 r->used[TEXT_AREA] = (m->matrix_w
2226 - r->used[LEFT_MARGIN_AREA]
2227 - r->used[RIGHT_MARGIN_AREA]);
2228 r->mode_line_p = 0;
2236 /* Save away the contents of frame F's current frame matrix. Value is
2237 a glyph matrix holding the contents of F's current frame matrix. */
2239 static struct glyph_matrix *
2240 save_current_matrix (f)
2241 struct frame *f;
2243 int i;
2244 struct glyph_matrix *saved;
2246 saved = (struct glyph_matrix *) xmalloc (sizeof *saved);
2247 bzero (saved, sizeof *saved);
2248 saved->nrows = f->current_matrix->nrows;
2249 saved->rows = (struct glyph_row *) xmalloc (saved->nrows
2250 * sizeof *saved->rows);
2251 bzero (saved->rows, saved->nrows * sizeof *saved->rows);
2253 for (i = 0; i < saved->nrows; ++i)
2255 struct glyph_row *from = f->current_matrix->rows + i;
2256 struct glyph_row *to = saved->rows + i;
2257 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2258 to->glyphs[TEXT_AREA] = (struct glyph *) xmalloc (nbytes);
2259 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2260 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2263 return saved;
2267 /* Restore the contents of frame F's current frame matrix from SAVED,
2268 and free memory associated with SAVED. */
2270 static void
2271 restore_current_matrix (f, saved)
2272 struct frame *f;
2273 struct glyph_matrix *saved;
2275 int i;
2277 for (i = 0; i < saved->nrows; ++i)
2279 struct glyph_row *from = saved->rows + i;
2280 struct glyph_row *to = f->current_matrix->rows + i;
2281 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2282 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2283 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2284 xfree (from->glyphs[TEXT_AREA]);
2287 xfree (saved->rows);
2288 xfree (saved);
2293 /* Allocate/reallocate glyph matrices of a single frame F for
2294 frame-based redisplay. */
2296 static void
2297 adjust_frame_glyphs_for_frame_redisplay (f)
2298 struct frame *f;
2300 struct dim matrix_dim;
2301 int pool_changed_p;
2302 int window_change_flags;
2303 int top_window_y;
2305 if (!FRAME_LIVE_P (f))
2306 return;
2308 top_window_y = FRAME_TOP_MARGIN (f);
2310 /* Allocate glyph pool structures if not already done. */
2311 if (f->desired_pool == NULL)
2313 f->desired_pool = new_glyph_pool ();
2314 f->current_pool = new_glyph_pool ();
2317 /* Allocate frames matrix structures if needed. */
2318 if (f->desired_matrix == NULL)
2320 f->desired_matrix = new_glyph_matrix (f->desired_pool);
2321 f->current_matrix = new_glyph_matrix (f->current_pool);
2324 /* Compute window glyph matrices. (This takes the mini-buffer
2325 window into account). The result is the size of the frame glyph
2326 matrix needed. The variable window_change_flags is set to a bit
2327 mask indicating whether new matrices will be allocated or
2328 existing matrices change their size or location within the frame
2329 matrix. */
2330 window_change_flags = 0;
2331 matrix_dim
2332 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2333 0, top_window_y,
2335 &window_change_flags);
2337 /* Add in menu bar lines, if any. */
2338 matrix_dim.height += top_window_y;
2340 /* Enlarge pools as necessary. */
2341 pool_changed_p = realloc_glyph_pool (f->desired_pool, matrix_dim);
2342 realloc_glyph_pool (f->current_pool, matrix_dim);
2344 /* Set up glyph pointers within window matrices. Do this only if
2345 absolutely necessary since it requires a frame redraw. */
2346 if (pool_changed_p || window_change_flags)
2348 /* Do it for window matrices. */
2349 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2350 0, top_window_y, 0,
2351 &window_change_flags);
2353 /* Size of frame matrices must equal size of frame. Note
2354 that we are called for X frames with window widths NOT equal
2355 to the frame width (from CHANGE_FRAME_SIZE_1). */
2356 xassert (matrix_dim.width == FRAME_COLS (f)
2357 && matrix_dim.height == FRAME_LINES (f));
2359 /* Pointers to glyph memory in glyph rows are exchanged during
2360 the update phase of redisplay, which means in general that a
2361 frame's current matrix consists of pointers into both the
2362 desired and current glyph pool of the frame. Adjusting a
2363 matrix sets the frame matrix up so that pointers are all into
2364 the same pool. If we want to preserve glyph contents of the
2365 current matrix over a call to adjust_glyph_matrix, we must
2366 make a copy of the current glyphs, and restore the current
2367 matrix' contents from that copy. */
2368 if (display_completed
2369 && !FRAME_GARBAGED_P (f)
2370 && matrix_dim.width == f->current_matrix->matrix_w
2371 && matrix_dim.height == f->current_matrix->matrix_h
2372 /* For some reason, the frame glyph matrix gets corrupted if
2373 any of the windows contain margins. I haven't been able
2374 to hunt down the reason, but for the moment this prevents
2375 the problem from manifesting. -- cyd */
2376 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f))))
2378 struct glyph_matrix *copy = save_current_matrix (f);
2379 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2380 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2381 restore_current_matrix (f, copy);
2382 fake_current_matrices (FRAME_ROOT_WINDOW (f));
2384 else
2386 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2387 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2388 SET_FRAME_GARBAGED (f);
2394 /* Allocate/reallocate glyph matrices of a single frame F for
2395 window-based redisplay. */
2397 static void
2398 adjust_frame_glyphs_for_window_redisplay (f)
2399 struct frame *f;
2401 struct window *w;
2403 xassert (FRAME_WINDOW_P (f) && FRAME_LIVE_P (f));
2405 /* Allocate/reallocate window matrices. */
2406 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f)));
2408 #ifdef HAVE_X_WINDOWS
2409 /* Allocate/ reallocate matrices of the dummy window used to display
2410 the menu bar under X when no X toolkit support is available. */
2411 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2413 /* Allocate a dummy window if not already done. */
2414 if (NILP (f->menu_bar_window))
2416 f->menu_bar_window = make_window ();
2417 w = XWINDOW (f->menu_bar_window);
2418 XSETFRAME (w->frame, f);
2419 w->pseudo_window_p = 1;
2421 else
2422 w = XWINDOW (f->menu_bar_window);
2424 /* Set window dimensions to frame dimensions and allocate or
2425 adjust glyph matrices of W. */
2426 XSETFASTINT (w->top_line, 0);
2427 XSETFASTINT (w->left_col, 0);
2428 XSETFASTINT (w->total_lines, FRAME_MENU_BAR_LINES (f));
2429 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2430 allocate_matrices_for_window_redisplay (w);
2432 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2433 #endif /* HAVE_X_WINDOWS */
2435 #ifndef USE_GTK
2436 /* Allocate/ reallocate matrices of the tool bar window. If we
2437 don't have a tool bar window yet, make one. */
2438 if (NILP (f->tool_bar_window))
2440 f->tool_bar_window = make_window ();
2441 w = XWINDOW (f->tool_bar_window);
2442 XSETFRAME (w->frame, f);
2443 w->pseudo_window_p = 1;
2445 else
2446 w = XWINDOW (f->tool_bar_window);
2448 XSETFASTINT (w->top_line, FRAME_MENU_BAR_LINES (f));
2449 XSETFASTINT (w->left_col, 0);
2450 XSETFASTINT (w->total_lines, FRAME_TOOL_BAR_LINES (f));
2451 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2452 allocate_matrices_for_window_redisplay (w);
2453 #endif
2457 /* Adjust/ allocate message buffer of frame F.
2459 Note that the message buffer is never freed. Since I could not
2460 find a free in 19.34, I assume that freeing it would be
2461 problematic in some way and don't do it either.
2463 (Implementation note: It should be checked if we can free it
2464 eventually without causing trouble). */
2466 static void
2467 adjust_frame_message_buffer (f)
2468 struct frame *f;
2470 int size = FRAME_MESSAGE_BUF_SIZE (f) + 1;
2472 if (FRAME_MESSAGE_BUF (f))
2474 char *buffer = FRAME_MESSAGE_BUF (f);
2475 char *new_buffer = (char *) xrealloc (buffer, size);
2476 FRAME_MESSAGE_BUF (f) = new_buffer;
2478 else
2479 FRAME_MESSAGE_BUF (f) = (char *) xmalloc (size);
2483 /* Re-allocate buffer for decode_mode_spec on frame F. */
2485 static void
2486 adjust_decode_mode_spec_buffer (f)
2487 struct frame *f;
2489 f->decode_mode_spec_buffer
2490 = (char *) xrealloc (f->decode_mode_spec_buffer,
2491 FRAME_MESSAGE_BUF_SIZE (f) + 1);
2496 /**********************************************************************
2497 Freeing Glyph Matrices
2498 **********************************************************************/
2500 /* Free glyph memory for a frame F. F may be null. This function can
2501 be called for the same frame more than once. The root window of
2502 F may be nil when this function is called. This is the case when
2503 the function is called when F is destroyed. */
2505 void
2506 free_glyphs (f)
2507 struct frame *f;
2509 if (f && f->glyphs_initialized_p)
2511 /* Block interrupt input so that we don't get surprised by an X
2512 event while we're in an inconsistent state. */
2513 BLOCK_INPUT;
2514 f->glyphs_initialized_p = 0;
2516 /* Release window sub-matrices. */
2517 if (!NILP (f->root_window))
2518 free_window_matrices (XWINDOW (f->root_window));
2520 /* Free the dummy window for menu bars without X toolkit and its
2521 glyph matrices. */
2522 if (!NILP (f->menu_bar_window))
2524 struct window *w = XWINDOW (f->menu_bar_window);
2525 free_glyph_matrix (w->desired_matrix);
2526 free_glyph_matrix (w->current_matrix);
2527 w->desired_matrix = w->current_matrix = NULL;
2528 f->menu_bar_window = Qnil;
2531 /* Free the tool bar window and its glyph matrices. */
2532 if (!NILP (f->tool_bar_window))
2534 struct window *w = XWINDOW (f->tool_bar_window);
2535 free_glyph_matrix (w->desired_matrix);
2536 free_glyph_matrix (w->current_matrix);
2537 w->desired_matrix = w->current_matrix = NULL;
2538 f->tool_bar_window = Qnil;
2541 /* Release frame glyph matrices. Reset fields to zero in
2542 case we are called a second time. */
2543 if (f->desired_matrix)
2545 free_glyph_matrix (f->desired_matrix);
2546 free_glyph_matrix (f->current_matrix);
2547 f->desired_matrix = f->current_matrix = NULL;
2550 /* Release glyph pools. */
2551 if (f->desired_pool)
2553 free_glyph_pool (f->desired_pool);
2554 free_glyph_pool (f->current_pool);
2555 f->desired_pool = f->current_pool = NULL;
2558 UNBLOCK_INPUT;
2563 /* Free glyph sub-matrices in the window tree rooted at W. This
2564 function may be called with a null pointer, and it may be called on
2565 the same tree more than once. */
2567 void
2568 free_window_matrices (w)
2569 struct window *w;
2571 while (w)
2573 if (!NILP (w->hchild))
2574 free_window_matrices (XWINDOW (w->hchild));
2575 else if (!NILP (w->vchild))
2576 free_window_matrices (XWINDOW (w->vchild));
2577 else
2579 /* This is a leaf window. Free its memory and reset fields
2580 to zero in case this function is called a second time for
2581 W. */
2582 free_glyph_matrix (w->current_matrix);
2583 free_glyph_matrix (w->desired_matrix);
2584 w->current_matrix = w->desired_matrix = NULL;
2587 /* Next window on same level. */
2588 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2593 /* Check glyph memory leaks. This function is called from
2594 shut_down_emacs. Note that frames are not destroyed when Emacs
2595 exits. We therefore free all glyph memory for all active frames
2596 explicitly and check that nothing is left allocated. */
2598 void
2599 check_glyph_memory ()
2601 Lisp_Object tail, frame;
2603 /* Free glyph memory for all frames. */
2604 FOR_EACH_FRAME (tail, frame)
2605 free_glyphs (XFRAME (frame));
2607 /* Check that nothing is left allocated. */
2608 if (glyph_matrix_count)
2609 abort ();
2610 if (glyph_pool_count)
2611 abort ();
2616 /**********************************************************************
2617 Building a Frame Matrix
2618 **********************************************************************/
2620 /* Most of the redisplay code works on glyph matrices attached to
2621 windows. This is a good solution most of the time, but it is not
2622 suitable for terminal code. Terminal output functions cannot rely
2623 on being able to set an arbitrary terminal window. Instead they
2624 must be provided with a view of the whole frame, i.e. the whole
2625 screen. We build such a view by constructing a frame matrix from
2626 window matrices in this section.
2628 Windows that must be updated have their must_be_update_p flag set.
2629 For all such windows, their desired matrix is made part of the
2630 desired frame matrix. For other windows, their current matrix is
2631 made part of the desired frame matrix.
2633 +-----------------+----------------+
2634 | desired | desired |
2635 | | |
2636 +-----------------+----------------+
2637 | current |
2639 +----------------------------------+
2641 Desired window matrices can be made part of the frame matrix in a
2642 cheap way: We exploit the fact that the desired frame matrix and
2643 desired window matrices share their glyph memory. This is not
2644 possible for current window matrices. Their glyphs are copied to
2645 the desired frame matrix. The latter is equivalent to
2646 preserve_other_columns in the old redisplay.
2648 Used glyphs counters for frame matrix rows are the result of adding
2649 up glyph lengths of the window matrices. A line in the frame
2650 matrix is enabled, if a corresponding line in a window matrix is
2651 enabled.
2653 After building the desired frame matrix, it will be passed to
2654 terminal code, which will manipulate both the desired and current
2655 frame matrix. Changes applied to the frame's current matrix have
2656 to be visible in current window matrices afterwards, of course.
2658 This problem is solved like this:
2660 1. Window and frame matrices share glyphs. Window matrices are
2661 constructed in a way that their glyph contents ARE the glyph
2662 contents needed in a frame matrix. Thus, any modification of
2663 glyphs done in terminal code will be reflected in window matrices
2664 automatically.
2666 2. Exchanges of rows in a frame matrix done by terminal code are
2667 intercepted by hook functions so that corresponding row operations
2668 on window matrices can be performed. This is necessary because we
2669 use pointers to glyphs in glyph row structures. To satisfy the
2670 assumption of point 1 above that glyphs are updated implicitly in
2671 window matrices when they are manipulated via the frame matrix,
2672 window and frame matrix must of course agree where to find the
2673 glyphs for their rows. Possible manipulations that must be
2674 mirrored are assignments of rows of the desired frame matrix to the
2675 current frame matrix and scrolling the current frame matrix. */
2677 /* Build frame F's desired matrix from window matrices. Only windows
2678 which have the flag must_be_updated_p set have to be updated. Menu
2679 bar lines of a frame are not covered by window matrices, so make
2680 sure not to touch them in this function. */
2682 static void
2683 build_frame_matrix (f)
2684 struct frame *f;
2686 int i;
2688 /* F must have a frame matrix when this function is called. */
2689 xassert (!FRAME_WINDOW_P (f));
2691 /* Clear all rows in the frame matrix covered by window matrices.
2692 Menu bar lines are not covered by windows. */
2693 for (i = FRAME_TOP_MARGIN (f); i < f->desired_matrix->nrows; ++i)
2694 clear_glyph_row (MATRIX_ROW (f->desired_matrix, i));
2696 /* Build the matrix by walking the window tree. */
2697 build_frame_matrix_from_window_tree (f->desired_matrix,
2698 XWINDOW (FRAME_ROOT_WINDOW (f)));
2702 /* Walk a window tree, building a frame matrix MATRIX from window
2703 matrices. W is the root of a window tree. */
2705 static void
2706 build_frame_matrix_from_window_tree (matrix, w)
2707 struct glyph_matrix *matrix;
2708 struct window *w;
2710 while (w)
2712 if (!NILP (w->hchild))
2713 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->hchild));
2714 else if (!NILP (w->vchild))
2715 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->vchild));
2716 else
2717 build_frame_matrix_from_leaf_window (matrix, w);
2719 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2724 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2725 desired frame matrix built. W is a leaf window whose desired or
2726 current matrix is to be added to FRAME_MATRIX. W's flag
2727 must_be_updated_p determines which matrix it contributes to
2728 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2729 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2730 Adding a desired matrix means setting up used counters and such in
2731 frame rows, while adding a current window matrix to FRAME_MATRIX
2732 means copying glyphs. The latter case corresponds to
2733 preserve_other_columns in the old redisplay. */
2735 static void
2736 build_frame_matrix_from_leaf_window (frame_matrix, w)
2737 struct glyph_matrix *frame_matrix;
2738 struct window *w;
2740 struct glyph_matrix *window_matrix;
2741 int window_y, frame_y;
2742 /* If non-zero, a glyph to insert at the right border of W. */
2743 GLYPH right_border_glyph = 0;
2745 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2746 if (w->must_be_updated_p)
2748 window_matrix = w->desired_matrix;
2750 /* Decide whether we want to add a vertical border glyph. */
2751 if (!WINDOW_RIGHTMOST_P (w))
2753 struct Lisp_Char_Table *dp = window_display_table (w);
2755 right_border_glyph
2756 = ((dp && INTEGERP (DISP_BORDER_GLYPH (dp)))
2757 ? spec_glyph_lookup_face (w, XINT (DISP_BORDER_GLYPH (dp)))
2758 : '|');
2760 if (FAST_GLYPH_FACE (right_border_glyph) <= 0)
2761 right_border_glyph
2762 = FAST_MAKE_GLYPH (right_border_glyph, VERTICAL_BORDER_FACE_ID);
2765 else
2766 window_matrix = w->current_matrix;
2768 /* For all rows in the window matrix and corresponding rows in the
2769 frame matrix. */
2770 window_y = 0;
2771 frame_y = window_matrix->matrix_y;
2772 while (window_y < window_matrix->nrows)
2774 struct glyph_row *frame_row = frame_matrix->rows + frame_y;
2775 struct glyph_row *window_row = window_matrix->rows + window_y;
2776 int current_row_p = window_matrix == w->current_matrix;
2778 /* Fill up the frame row with spaces up to the left margin of the
2779 window row. */
2780 fill_up_frame_row_with_spaces (frame_row, window_matrix->matrix_x);
2782 /* Fill up areas in the window matrix row with spaces. */
2783 fill_up_glyph_row_with_spaces (window_row);
2785 /* If only part of W's desired matrix has been built, and
2786 window_row wasn't displayed, use the corresponding current
2787 row instead. */
2788 if (window_matrix == w->desired_matrix
2789 && !window_row->enabled_p)
2791 window_row = w->current_matrix->rows + window_y;
2792 current_row_p = 1;
2795 if (current_row_p)
2797 /* Copy window row to frame row. */
2798 bcopy (window_row->glyphs[0],
2799 frame_row->glyphs[TEXT_AREA] + window_matrix->matrix_x,
2800 window_matrix->matrix_w * sizeof (struct glyph));
2802 else
2804 xassert (window_row->enabled_p);
2806 /* Only when a desired row has been displayed, we want
2807 the corresponding frame row to be updated. */
2808 frame_row->enabled_p = 1;
2810 /* Maybe insert a vertical border between horizontally adjacent
2811 windows. */
2812 if (right_border_glyph)
2814 struct glyph *border = window_row->glyphs[LAST_AREA] - 1;
2815 SET_CHAR_GLYPH_FROM_GLYPH (*border, right_border_glyph);
2818 #if GLYPH_DEBUG
2819 /* Window row window_y must be a slice of frame row
2820 frame_y. */
2821 xassert (glyph_row_slice_p (window_row, frame_row));
2823 /* If rows are in sync, we don't have to copy glyphs because
2824 frame and window share glyphs. */
2826 strcpy (w->current_matrix->method, w->desired_matrix->method);
2827 add_window_display_history (w, w->current_matrix->method, 0);
2828 #endif
2831 /* Set number of used glyphs in the frame matrix. Since we fill
2832 up with spaces, and visit leaf windows from left to right it
2833 can be done simply. */
2834 frame_row->used[TEXT_AREA]
2835 = window_matrix->matrix_x + window_matrix->matrix_w;
2837 /* Next row. */
2838 ++window_y;
2839 ++frame_y;
2843 /* Given a user-specified glyph, possibly including a Lisp-level face
2844 ID, return a glyph that has a realized face ID.
2845 This is used for glyphs displayed specially and not part of the text;
2846 for instance, vertical separators, truncation markers, etc. */
2848 GLYPH
2849 spec_glyph_lookup_face (w, glyph)
2850 struct window *w;
2851 GLYPH glyph;
2853 int lface_id = FAST_GLYPH_FACE (glyph);
2854 /* Convert the glyph's specified face to a realized (cache) face. */
2855 if (lface_id > 0)
2857 int face_id = merge_faces (XFRAME (w->frame),
2858 Qt, lface_id, DEFAULT_FACE_ID);
2859 glyph
2860 = FAST_MAKE_GLYPH (FAST_GLYPH_CHAR (glyph), face_id);
2862 return glyph;
2865 /* Add spaces to a glyph row ROW in a window matrix.
2867 Each row has the form:
2869 +---------+-----------------------------+------------+
2870 | left | text | right |
2871 +---------+-----------------------------+------------+
2873 Left and right marginal areas are optional. This function adds
2874 spaces to areas so that there are no empty holes between areas.
2875 In other words: If the right area is not empty, the text area
2876 is filled up with spaces up to the right area. If the text area
2877 is not empty, the left area is filled up.
2879 To be called for frame-based redisplay, only. */
2881 static void
2882 fill_up_glyph_row_with_spaces (row)
2883 struct glyph_row *row;
2885 fill_up_glyph_row_area_with_spaces (row, LEFT_MARGIN_AREA);
2886 fill_up_glyph_row_area_with_spaces (row, TEXT_AREA);
2887 fill_up_glyph_row_area_with_spaces (row, RIGHT_MARGIN_AREA);
2891 /* Fill area AREA of glyph row ROW with spaces. To be called for
2892 frame-based redisplay only. */
2894 static void
2895 fill_up_glyph_row_area_with_spaces (row, area)
2896 struct glyph_row *row;
2897 int area;
2899 if (row->glyphs[area] < row->glyphs[area + 1])
2901 struct glyph *end = row->glyphs[area + 1];
2902 struct glyph *text = row->glyphs[area] + row->used[area];
2904 while (text < end)
2905 *text++ = space_glyph;
2906 row->used[area] = text - row->glyphs[area];
2911 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2912 reached. In frame matrices only one area, TEXT_AREA, is used. */
2914 static void
2915 fill_up_frame_row_with_spaces (row, upto)
2916 struct glyph_row *row;
2917 int upto;
2919 int i = row->used[TEXT_AREA];
2920 struct glyph *glyph = row->glyphs[TEXT_AREA];
2922 while (i < upto)
2923 glyph[i++] = space_glyph;
2925 row->used[TEXT_AREA] = i;
2930 /**********************************************************************
2931 Mirroring operations on frame matrices in window matrices
2932 **********************************************************************/
2934 /* Set frame being updated via frame-based redisplay to F. This
2935 function must be called before updates to make explicit that we are
2936 working on frame matrices or not. */
2938 static INLINE void
2939 set_frame_matrix_frame (f)
2940 struct frame *f;
2942 frame_matrix_frame = f;
2946 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2947 DESIRED_MATRIX is the desired matrix corresponding to
2948 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2949 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2950 frame_matrix_frame is non-null, this indicates that the exchange is
2951 done in frame matrices, and that we have to perform analogous
2952 operations in window matrices of frame_matrix_frame. */
2954 static INLINE void
2955 make_current (desired_matrix, current_matrix, row)
2956 struct glyph_matrix *desired_matrix, *current_matrix;
2957 int row;
2959 struct glyph_row *current_row = MATRIX_ROW (current_matrix, row);
2960 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, row);
2961 int mouse_face_p = current_row->mouse_face_p;
2963 /* Do current_row = desired_row. This exchanges glyph pointers
2964 between both rows, and does a structure assignment otherwise. */
2965 assign_row (current_row, desired_row);
2967 /* Enable current_row to mark it as valid. */
2968 current_row->enabled_p = 1;
2969 current_row->mouse_face_p = mouse_face_p;
2971 /* If we are called on frame matrices, perform analogous operations
2972 for window matrices. */
2973 if (frame_matrix_frame)
2974 mirror_make_current (XWINDOW (frame_matrix_frame->root_window), row);
2978 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2979 W's frame which has been made current (by swapping pointers between
2980 current and desired matrix). Perform analogous operations in the
2981 matrices of leaf windows in the window tree rooted at W. */
2983 static void
2984 mirror_make_current (w, frame_row)
2985 struct window *w;
2986 int frame_row;
2988 while (w)
2990 if (!NILP (w->hchild))
2991 mirror_make_current (XWINDOW (w->hchild), frame_row);
2992 else if (!NILP (w->vchild))
2993 mirror_make_current (XWINDOW (w->vchild), frame_row);
2994 else
2996 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2997 here because the checks performed in debug mode there
2998 will not allow the conversion. */
2999 int row = frame_row - w->desired_matrix->matrix_y;
3001 /* If FRAME_ROW is within W, assign the desired row to the
3002 current row (exchanging glyph pointers). */
3003 if (row >= 0 && row < w->desired_matrix->matrix_h)
3005 struct glyph_row *current_row
3006 = MATRIX_ROW (w->current_matrix, row);
3007 struct glyph_row *desired_row
3008 = MATRIX_ROW (w->desired_matrix, row);
3010 if (desired_row->enabled_p)
3011 assign_row (current_row, desired_row);
3012 else
3013 swap_glyph_pointers (desired_row, current_row);
3014 current_row->enabled_p = 1;
3018 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3023 /* Perform row dance after scrolling. We are working on the range of
3024 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
3025 including) in MATRIX. COPY_FROM is a vector containing, for each
3026 row I in the range 0 <= I < NLINES, the index of the original line
3027 to move to I. This index is relative to the row range, i.e. 0 <=
3028 index < NLINES. RETAINED_P is a vector containing zero for each
3029 row 0 <= I < NLINES which is empty.
3031 This function is called from do_scrolling and do_direct_scrolling. */
3033 void
3034 mirrored_line_dance (matrix, unchanged_at_top, nlines, copy_from,
3035 retained_p)
3036 struct glyph_matrix *matrix;
3037 int unchanged_at_top, nlines;
3038 int *copy_from;
3039 char *retained_p;
3041 /* A copy of original rows. */
3042 struct glyph_row *old_rows;
3044 /* Rows to assign to. */
3045 struct glyph_row *new_rows = MATRIX_ROW (matrix, unchanged_at_top);
3047 int i;
3049 /* Make a copy of the original rows. */
3050 old_rows = (struct glyph_row *) alloca (nlines * sizeof *old_rows);
3051 bcopy (new_rows, old_rows, nlines * sizeof *old_rows);
3053 /* Assign new rows, maybe clear lines. */
3054 for (i = 0; i < nlines; ++i)
3056 int enabled_before_p = new_rows[i].enabled_p;
3058 xassert (i + unchanged_at_top < matrix->nrows);
3059 xassert (unchanged_at_top + copy_from[i] < matrix->nrows);
3060 new_rows[i] = old_rows[copy_from[i]];
3061 new_rows[i].enabled_p = enabled_before_p;
3063 /* RETAINED_P is zero for empty lines. */
3064 if (!retained_p[copy_from[i]])
3065 new_rows[i].enabled_p = 0;
3068 /* Do the same for window matrices, if MATRIX is a frame matrix. */
3069 if (frame_matrix_frame)
3070 mirror_line_dance (XWINDOW (frame_matrix_frame->root_window),
3071 unchanged_at_top, nlines, copy_from, retained_p);
3075 /* Synchronize glyph pointers in the current matrix of window W with
3076 the current frame matrix. */
3078 static void
3079 sync_window_with_frame_matrix_rows (w)
3080 struct window *w;
3082 struct frame *f = XFRAME (w->frame);
3083 struct glyph_row *window_row, *window_row_end, *frame_row;
3084 int left, right, x, width;
3086 /* Preconditions: W must be a leaf window on a tty frame. */
3087 xassert (NILP (w->hchild) && NILP (w->vchild));
3088 xassert (!FRAME_WINDOW_P (f));
3090 left = margin_glyphs_to_reserve (w, 1, w->left_margin_cols);
3091 right = margin_glyphs_to_reserve (w, 1, w->right_margin_cols);
3092 x = w->current_matrix->matrix_x;
3093 width = w->current_matrix->matrix_w;
3095 window_row = w->current_matrix->rows;
3096 window_row_end = window_row + w->current_matrix->nrows;
3097 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
3099 for (; window_row < window_row_end; ++window_row, ++frame_row)
3101 window_row->glyphs[LEFT_MARGIN_AREA]
3102 = frame_row->glyphs[0] + x;
3103 window_row->glyphs[TEXT_AREA]
3104 = window_row->glyphs[LEFT_MARGIN_AREA] + left;
3105 window_row->glyphs[LAST_AREA]
3106 = window_row->glyphs[LEFT_MARGIN_AREA] + width;
3107 window_row->glyphs[RIGHT_MARGIN_AREA]
3108 = window_row->glyphs[LAST_AREA] - right;
3113 /* Return the window in the window tree rooted in W containing frame
3114 row ROW. Value is null if none is found. */
3116 struct window *
3117 frame_row_to_window (w, row)
3118 struct window *w;
3119 int row;
3121 struct window *found = NULL;
3123 while (w && !found)
3125 if (!NILP (w->hchild))
3126 found = frame_row_to_window (XWINDOW (w->hchild), row);
3127 else if (!NILP (w->vchild))
3128 found = frame_row_to_window (XWINDOW (w->vchild), row);
3129 else if (row >= WINDOW_TOP_EDGE_LINE (w)
3130 && row < WINDOW_BOTTOM_EDGE_LINE (w))
3131 found = w;
3133 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3136 return found;
3140 /* Perform a line dance in the window tree rooted at W, after
3141 scrolling a frame matrix in mirrored_line_dance.
3143 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
3144 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
3145 COPY_FROM is a vector containing, for each row I in the range 0 <=
3146 I < NLINES, the index of the original line to move to I. This
3147 index is relative to the row range, i.e. 0 <= index < NLINES.
3148 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
3149 which is empty. */
3151 static void
3152 mirror_line_dance (w, unchanged_at_top, nlines, copy_from, retained_p)
3153 struct window *w;
3154 int unchanged_at_top, nlines;
3155 int *copy_from;
3156 char *retained_p;
3158 while (w)
3160 if (!NILP (w->hchild))
3161 mirror_line_dance (XWINDOW (w->hchild), unchanged_at_top,
3162 nlines, copy_from, retained_p);
3163 else if (!NILP (w->vchild))
3164 mirror_line_dance (XWINDOW (w->vchild), unchanged_at_top,
3165 nlines, copy_from, retained_p);
3166 else
3168 /* W is a leaf window, and we are working on its current
3169 matrix m. */
3170 struct glyph_matrix *m = w->current_matrix;
3171 int i, sync_p = 0;
3172 struct glyph_row *old_rows;
3174 /* Make a copy of the original rows of matrix m. */
3175 old_rows = (struct glyph_row *) alloca (m->nrows * sizeof *old_rows);
3176 bcopy (m->rows, old_rows, m->nrows * sizeof *old_rows);
3178 for (i = 0; i < nlines; ++i)
3180 /* Frame relative line assigned to. */
3181 int frame_to = i + unchanged_at_top;
3183 /* Frame relative line assigned. */
3184 int frame_from = copy_from[i] + unchanged_at_top;
3186 /* Window relative line assigned to. */
3187 int window_to = frame_to - m->matrix_y;
3189 /* Window relative line assigned. */
3190 int window_from = frame_from - m->matrix_y;
3192 /* Is assigned line inside window? */
3193 int from_inside_window_p
3194 = window_from >= 0 && window_from < m->matrix_h;
3196 /* Is assigned to line inside window? */
3197 int to_inside_window_p
3198 = window_to >= 0 && window_to < m->matrix_h;
3200 if (from_inside_window_p && to_inside_window_p)
3202 /* Enabled setting before assignment. */
3203 int enabled_before_p;
3205 /* Do the assignment. The enabled_p flag is saved
3206 over the assignment because the old redisplay did
3207 that. */
3208 enabled_before_p = m->rows[window_to].enabled_p;
3209 m->rows[window_to] = old_rows[window_from];
3210 m->rows[window_to].enabled_p = enabled_before_p;
3212 /* If frame line is empty, window line is empty, too. */
3213 if (!retained_p[copy_from[i]])
3214 m->rows[window_to].enabled_p = 0;
3216 else if (to_inside_window_p)
3218 /* A copy between windows. This is an infrequent
3219 case not worth optimizing. */
3220 struct frame *f = XFRAME (w->frame);
3221 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3222 struct window *w2;
3223 struct glyph_matrix *m2;
3224 int m2_from;
3226 w2 = frame_row_to_window (root, frame_from);
3227 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3228 -nw', FROM_FRAME sometimes has no associated window.
3229 This check avoids a segfault if W2 is null. */
3230 if (w2)
3232 m2 = w2->current_matrix;
3233 m2_from = frame_from - m2->matrix_y;
3234 copy_row_except_pointers (m->rows + window_to,
3235 m2->rows + m2_from);
3237 /* If frame line is empty, window line is empty, too. */
3238 if (!retained_p[copy_from[i]])
3239 m->rows[window_to].enabled_p = 0;
3241 sync_p = 1;
3243 else if (from_inside_window_p)
3244 sync_p = 1;
3247 /* If there was a copy between windows, make sure glyph
3248 pointers are in sync with the frame matrix. */
3249 if (sync_p)
3250 sync_window_with_frame_matrix_rows (w);
3252 /* Check that no pointers are lost. */
3253 CHECK_MATRIX (m);
3256 /* Next window on same level. */
3257 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3262 #if GLYPH_DEBUG
3264 /* Check that window and frame matrices agree about their
3265 understanding where glyphs of the rows are to find. For each
3266 window in the window tree rooted at W, check that rows in the
3267 matrices of leaf window agree with their frame matrices about
3268 glyph pointers. */
3270 void
3271 check_window_matrix_pointers (w)
3272 struct window *w;
3274 while (w)
3276 if (!NILP (w->hchild))
3277 check_window_matrix_pointers (XWINDOW (w->hchild));
3278 else if (!NILP (w->vchild))
3279 check_window_matrix_pointers (XWINDOW (w->vchild));
3280 else
3282 struct frame *f = XFRAME (w->frame);
3283 check_matrix_pointers (w->desired_matrix, f->desired_matrix);
3284 check_matrix_pointers (w->current_matrix, f->current_matrix);
3287 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3292 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3293 a window and FRAME_MATRIX is the corresponding frame matrix. For
3294 each row in WINDOW_MATRIX check that it's a slice of the
3295 corresponding frame row. If it isn't, abort. */
3297 static void
3298 check_matrix_pointers (window_matrix, frame_matrix)
3299 struct glyph_matrix *window_matrix, *frame_matrix;
3301 /* Row number in WINDOW_MATRIX. */
3302 int i = 0;
3304 /* Row number corresponding to I in FRAME_MATRIX. */
3305 int j = window_matrix->matrix_y;
3307 /* For all rows check that the row in the window matrix is a
3308 slice of the row in the frame matrix. If it isn't we didn't
3309 mirror an operation on the frame matrix correctly. */
3310 while (i < window_matrix->nrows)
3312 if (!glyph_row_slice_p (window_matrix->rows + i,
3313 frame_matrix->rows + j))
3314 abort ();
3315 ++i, ++j;
3319 #endif /* GLYPH_DEBUG != 0 */
3323 /**********************************************************************
3324 VPOS and HPOS translations
3325 **********************************************************************/
3327 #if GLYPH_DEBUG
3329 /* Translate vertical position VPOS which is relative to window W to a
3330 vertical position relative to W's frame. */
3332 static int
3333 window_to_frame_vpos (w, vpos)
3334 struct window *w;
3335 int vpos;
3337 struct frame *f = XFRAME (w->frame);
3339 xassert (!FRAME_WINDOW_P (f));
3340 xassert (vpos >= 0 && vpos <= w->desired_matrix->nrows);
3341 vpos += WINDOW_TOP_EDGE_LINE (w);
3342 xassert (vpos >= 0 && vpos <= FRAME_LINES (f));
3343 return vpos;
3347 /* Translate horizontal position HPOS which is relative to window W to
3348 a horizontal position relative to W's frame. */
3350 static int
3351 window_to_frame_hpos (w, hpos)
3352 struct window *w;
3353 int hpos;
3355 xassert (!FRAME_WINDOW_P (XFRAME (w->frame)));
3356 hpos += WINDOW_LEFT_EDGE_COL (w);
3357 return hpos;
3360 #endif /* GLYPH_DEBUG */
3364 /**********************************************************************
3365 Redrawing Frames
3366 **********************************************************************/
3368 DEFUN ("redraw-frame", Fredraw_frame, Sredraw_frame, 1, 1, 0,
3369 doc: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3370 (frame)
3371 Lisp_Object frame;
3373 struct frame *f;
3375 CHECK_LIVE_FRAME (frame);
3376 f = XFRAME (frame);
3378 /* Ignore redraw requests, if frame has no glyphs yet.
3379 (Implementation note: It still has to be checked why we are
3380 called so early here). */
3381 if (!glyphs_initialized_initially_p)
3382 return Qnil;
3384 update_begin (f);
3385 #ifdef MSDOS
3386 if (FRAME_MSDOS_P (f))
3387 set_terminal_modes (FRAME_TERMINAL (f));
3388 #endif
3389 clear_frame (f);
3390 clear_current_matrices (f);
3391 update_end (f);
3392 if (FRAME_TERMCAP_P (f))
3393 fflush (FRAME_TTY (f)->output);
3394 windows_or_buffers_changed++;
3395 /* Mark all windows as inaccurate, so that every window will have
3396 its redisplay done. */
3397 mark_window_display_accurate (FRAME_ROOT_WINDOW (f), 0);
3398 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
3399 f->garbaged = 0;
3400 return Qnil;
3404 /* Redraw frame F. This is nothing more than a call to the Lisp
3405 function redraw-frame. */
3407 void
3408 redraw_frame (f)
3409 struct frame *f;
3411 Lisp_Object frame;
3412 XSETFRAME (frame, f);
3413 Fredraw_frame (frame);
3417 DEFUN ("redraw-display", Fredraw_display, Sredraw_display, 0, 0, "",
3418 doc: /* Clear and redisplay all visible frames. */)
3421 Lisp_Object tail, frame;
3423 FOR_EACH_FRAME (tail, frame)
3424 if (FRAME_VISIBLE_P (XFRAME (frame)))
3425 Fredraw_frame (frame);
3427 return Qnil;
3431 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3432 visible frames marked as garbaged. */
3434 void
3435 redraw_garbaged_frames ()
3437 Lisp_Object tail, frame;
3439 FOR_EACH_FRAME (tail, frame)
3440 if (FRAME_VISIBLE_P (XFRAME (frame))
3441 && FRAME_GARBAGED_P (XFRAME (frame)))
3442 Fredraw_frame (frame);
3447 /***********************************************************************
3448 Direct Operations
3449 ***********************************************************************/
3451 /* Try to update display and current glyph matrix directly.
3453 This function is called after a character G has been inserted into
3454 current_buffer. It tries to update the current glyph matrix and
3455 perform appropriate screen output to reflect the insertion. If it
3456 succeeds, the global flag redisplay_performed_directly_p will be
3457 set to 1, and thereby prevent the more costly general redisplay
3458 from running (see redisplay_internal).
3460 This function is not called for `hairy' character insertions.
3461 In particular, it is not called when after or before change
3462 functions exist, like they are used by font-lock. See keyboard.c
3463 for details where this function is called. */
3466 direct_output_for_insert (g)
3467 int g;
3469 register struct frame *f = SELECTED_FRAME ();
3470 struct window *w = XWINDOW (selected_window);
3471 struct it it, it2;
3472 struct glyph_row *glyph_row;
3473 struct glyph *glyphs, *glyph, *end;
3474 int n;
3475 /* Non-null means that redisplay of W is based on window matrices. */
3476 int window_redisplay_p = FRAME_WINDOW_P (f);
3477 /* Non-null means we are in overwrite mode. */
3478 int overwrite_p = !NILP (current_buffer->overwrite_mode);
3479 int added_width;
3480 struct text_pos pos;
3481 int delta, delta_bytes;
3483 /* Not done directly. */
3484 redisplay_performed_directly_p = 0;
3486 /* Quickly give up for some common cases. */
3487 if (cursor_in_echo_area
3488 /* Give up if fonts have changed. */
3489 || fonts_changed_p
3490 /* Give up if face attributes have been changed. */
3491 || face_change_count
3492 /* Give up if cursor position not really known. */
3493 || !display_completed
3494 /* Give up if buffer appears in two places. */
3495 || buffer_shared > 1
3496 /* Give up if currently displaying a message instead of the
3497 minibuffer contents. */
3498 || (EQ (selected_window, minibuf_window)
3499 && EQ (minibuf_window, echo_area_window))
3500 /* Give up for hscrolled mini-buffer because display of the prompt
3501 is handled specially there (see display_line). */
3502 || (MINI_WINDOW_P (w) && XFASTINT (w->hscroll))
3503 /* Give up if overwriting in the middle of a line. */
3504 || (overwrite_p
3505 && PT != ZV
3506 && FETCH_BYTE (PT) != '\n')
3507 /* Give up for tabs and line ends. */
3508 || g == '\t'
3509 || g == '\n'
3510 || g == '\r'
3511 /* Give up if unable to display the cursor in the window. */
3512 || w->cursor.vpos < 0
3513 /* Give up if we are showing a message or just cleared the message
3514 because we might need to resize the echo area window. */
3515 || !NILP (echo_area_buffer[0])
3516 || !NILP (echo_area_buffer[1])
3517 || (glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos),
3518 /* Can't do it in a continued line because continuation
3519 lines would change. */
3520 (glyph_row->continued_p
3521 || glyph_row->exact_window_width_line_p
3522 /* Can't use this method if the line overlaps others or is
3523 overlapped by others because these other lines would
3524 have to be redisplayed. */
3525 || glyph_row->overlapping_p
3526 || glyph_row->overlapped_p))
3527 /* Can't do it for partial width windows on terminal frames
3528 because we can't clear to eol in such a window. */
3529 || (!window_redisplay_p && !WINDOW_FULL_WIDTH_P (w)))
3530 return 0;
3532 /* If we can't insert glyphs, we can use this method only
3533 at the end of a line. */
3534 if (!FRAME_CHAR_INS_DEL_OK (f))
3535 if (PT != ZV && FETCH_BYTE (PT_BYTE) != '\n')
3536 return 0;
3538 /* Set up a display iterator structure for W. Glyphs will be
3539 produced in scratch_glyph_row. Current position is W's cursor
3540 position. */
3541 clear_glyph_row (&scratch_glyph_row);
3542 SET_TEXT_POS (pos, PT, PT_BYTE);
3543 DEC_TEXT_POS (pos, !NILP (current_buffer->enable_multibyte_characters));
3544 init_iterator (&it, w, CHARPOS (pos), BYTEPOS (pos), &scratch_glyph_row,
3545 DEFAULT_FACE_ID);
3547 glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3548 if (glyph_row->mouse_face_p)
3549 return 0;
3551 /* Give up if highlighting trailing whitespace and we have trailing
3552 whitespace in glyph_row. We would have to remove the trailing
3553 whitespace face in that case. */
3554 if (!NILP (Vshow_trailing_whitespace)
3555 && glyph_row->used[TEXT_AREA])
3557 struct glyph *last;
3559 last = glyph_row->glyphs[TEXT_AREA] + glyph_row->used[TEXT_AREA] - 1;
3560 if (last->type == STRETCH_GLYPH
3561 || (last->type == CHAR_GLYPH
3562 && last->u.ch == ' '))
3563 return 0;
3566 /* Give up if there are overlay strings at pos. This would fail
3567 if the overlay string has newlines in it. */
3568 if (STRINGP (it.string))
3569 return 0;
3571 it.hpos = w->cursor.hpos;
3572 it.vpos = w->cursor.vpos;
3573 it.current_x = w->cursor.x + it.first_visible_x;
3574 it.current_y = w->cursor.y;
3575 it.end_charpos = PT;
3576 it.stop_charpos = min (PT, it.stop_charpos);
3577 it.stop_charpos = max (IT_CHARPOS (it), it.stop_charpos);
3579 /* More than one display element may be returned for PT - 1 if
3580 (i) it's a control character which is translated into `\003' or
3581 `^C', or (ii) it has a display table entry, or (iii) it's a
3582 combination of both. */
3583 delta = delta_bytes = 0;
3584 while (get_next_display_element (&it))
3586 PRODUCE_GLYPHS (&it);
3588 /* Give up if glyph doesn't fit completely on the line. */
3589 if (it.current_x >= it.last_visible_x)
3590 return 0;
3592 /* Give up if new glyph has different ascent or descent than
3593 the original row, or if it is not a character glyph. */
3594 if (glyph_row->ascent != it.ascent
3595 || glyph_row->height != it.ascent + it.descent
3596 || glyph_row->phys_ascent != it.phys_ascent
3597 || glyph_row->phys_height != it.phys_ascent + it.phys_descent
3598 || it.what != IT_CHARACTER)
3599 return 0;
3601 delta += 1;
3602 delta_bytes += it.len;
3603 set_iterator_to_next (&it, 1);
3606 /* Give up if we hit the right edge of the window. We would have
3607 to insert truncation or continuation glyphs. */
3608 added_width = it.current_x - (w->cursor.x + it.first_visible_x);
3609 if (glyph_row->pixel_width + added_width >= it.last_visible_x)
3610 return 0;
3612 /* Give up if there is a \t following in the line. */
3613 it2 = it;
3614 it2.end_charpos = ZV;
3615 it2.stop_charpos = min (it2.stop_charpos, ZV);
3616 while (get_next_display_element (&it2)
3617 && !ITERATOR_AT_END_OF_LINE_P (&it2))
3619 if (it2.c == '\t')
3620 return 0;
3621 set_iterator_to_next (&it2, 1);
3624 /* Number of new glyphs produced. */
3625 n = it.glyph_row->used[TEXT_AREA];
3627 /* Start and end of glyphs in original row. */
3628 glyphs = glyph_row->glyphs[TEXT_AREA] + w->cursor.hpos;
3629 end = glyph_row->glyphs[1 + TEXT_AREA];
3631 /* Make room for new glyphs, then insert them. */
3632 xassert (end - glyphs - n >= 0);
3633 safe_bcopy ((char *) glyphs, (char *) (glyphs + n),
3634 (end - glyphs - n) * sizeof (*end));
3635 bcopy (it.glyph_row->glyphs[TEXT_AREA], glyphs, n * sizeof *glyphs);
3636 glyph_row->used[TEXT_AREA] = min (glyph_row->used[TEXT_AREA] + n,
3637 end - glyph_row->glyphs[TEXT_AREA]);
3639 /* Compute new line width. */
3640 glyph = glyph_row->glyphs[TEXT_AREA];
3641 end = glyph + glyph_row->used[TEXT_AREA];
3642 glyph_row->pixel_width = glyph_row->x;
3643 while (glyph < end)
3645 glyph_row->pixel_width += glyph->pixel_width;
3646 ++glyph;
3649 /* Increment buffer positions for glyphs following the newly
3650 inserted ones. */
3651 for (glyph = glyphs + n; glyph < end; ++glyph)
3652 if (glyph->charpos > 0 && BUFFERP (glyph->object))
3653 glyph->charpos += delta;
3655 if (MATRIX_ROW_END_CHARPOS (glyph_row) > 0)
3657 MATRIX_ROW_END_CHARPOS (glyph_row) += delta;
3658 MATRIX_ROW_END_BYTEPOS (glyph_row) += delta_bytes;
3661 /* Adjust positions in lines following the one we are in. */
3662 increment_matrix_positions (w->current_matrix,
3663 w->cursor.vpos + 1,
3664 w->current_matrix->nrows,
3665 delta, delta_bytes);
3667 glyph_row->contains_overlapping_glyphs_p
3668 |= it.glyph_row->contains_overlapping_glyphs_p;
3670 glyph_row->displays_text_p = 1;
3671 w->window_end_vpos = make_number (max (w->cursor.vpos,
3672 XFASTINT (w->window_end_vpos)));
3674 if (!NILP (Vshow_trailing_whitespace))
3675 highlight_trailing_whitespace (it.f, glyph_row);
3677 /* Write glyphs. If at end of row, we can simply call write_glyphs.
3678 In the middle, we have to insert glyphs. Note that this is now
3679 implemented for X frames. The implementation uses updated_window
3680 and updated_row. */
3681 updated_row = glyph_row;
3682 updated_area = TEXT_AREA;
3683 update_begin (f);
3684 if (FRAME_RIF (f))
3686 FRAME_RIF (f)->update_window_begin_hook (w);
3688 if (glyphs == end - n
3689 /* In front of a space added by append_space. */
3690 || (glyphs == end - n - 1
3691 && (end - n)->charpos <= 0))
3692 FRAME_RIF (f)->write_glyphs (glyphs, n);
3693 else
3694 FRAME_RIF (f)->insert_glyphs (glyphs, n);
3696 else
3698 if (glyphs == end - n)
3699 write_glyphs (f, glyphs, n);
3700 else
3701 insert_glyphs (f, glyphs, n);
3704 w->cursor.hpos += n;
3705 w->cursor.x = it.current_x - it.first_visible_x;
3706 xassert (w->cursor.hpos >= 0
3707 && w->cursor.hpos < w->desired_matrix->matrix_w);
3709 /* How to set the cursor differs depending on whether we are
3710 using a frame matrix or a window matrix. Note that when
3711 a frame matrix is used, cursor_to expects frame coordinates,
3712 and the X and Y parameters are not used. */
3713 if (window_redisplay_p)
3714 FRAME_RIF (f)->cursor_to (w->cursor.vpos, w->cursor.hpos,
3715 w->cursor.y, w->cursor.x);
3716 else
3718 int x, y;
3719 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3720 + (INTEGERP (w->left_margin_cols)
3721 ? XFASTINT (w->left_margin_cols)
3722 : 0));
3723 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3724 cursor_to (f, y, x);
3727 #ifdef HAVE_WINDOW_SYSTEM
3728 update_window_fringes (w, 0);
3729 #endif
3731 if (FRAME_RIF (f))
3732 FRAME_RIF (f)->update_window_end_hook (w, 1, 0);
3733 update_end (f);
3734 updated_row = NULL;
3735 if (FRAME_TERMCAP_P (f))
3736 fflush (FRAME_TTY (f)->output);
3738 TRACE ((stderr, "direct output for insert\n"));
3739 mark_window_display_accurate (it.window, 1);
3740 redisplay_performed_directly_p = 1;
3741 return 1;
3745 /* Perform a direct display update for moving PT by N positions
3746 left or right. N < 0 means a movement backwards. This function
3747 is currently only called for N == 1 or N == -1. */
3750 direct_output_forward_char (n)
3751 int n;
3753 struct frame *f = SELECTED_FRAME ();
3754 struct window *w = XWINDOW (selected_window);
3755 struct glyph_row *row;
3757 /* Give up if point moved out of or into a composition. */
3758 if (check_point_in_composition (current_buffer, XINT (w->last_point),
3759 current_buffer, PT))
3760 return 0;
3762 /* Give up if face attributes have been changed. */
3763 if (face_change_count)
3764 return 0;
3766 /* Give up if current matrix is not up to date or we are
3767 displaying a message. */
3768 if (!display_completed || cursor_in_echo_area)
3769 return 0;
3771 /* Give up if the buffer's direction is reversed. */
3772 if (!NILP (XBUFFER (w->buffer)->direction_reversed))
3773 return 0;
3775 /* Can't use direct output if highlighting a region. */
3776 if (!NILP (Vtransient_mark_mode) && !NILP (current_buffer->mark_active))
3777 return 0;
3779 /* Can't use direct output if highlighting trailing whitespace. */
3780 if (!NILP (Vshow_trailing_whitespace))
3781 return 0;
3783 /* Give up if we are showing a message or just cleared the message
3784 because we might need to resize the echo area window. */
3785 if (!NILP (echo_area_buffer[0]) || !NILP (echo_area_buffer[1]))
3786 return 0;
3788 /* Give up if currently displaying a message instead of the
3789 minibuffer contents. */
3790 if (XWINDOW (minibuf_window) == w
3791 && EQ (minibuf_window, echo_area_window))
3792 return 0;
3794 /* Give up if we don't know where the cursor is. */
3795 if (w->cursor.vpos < 0)
3796 return 0;
3798 row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3800 /* Give up if PT is outside of the last known cursor row. */
3801 if (PT <= MATRIX_ROW_START_CHARPOS (row)
3802 || PT >= MATRIX_ROW_END_CHARPOS (row))
3803 return 0;
3805 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
3807 w->last_cursor = w->cursor;
3808 XSETFASTINT (w->last_point, PT);
3810 xassert (w->cursor.hpos >= 0
3811 && w->cursor.hpos < w->desired_matrix->matrix_w);
3813 if (FRAME_WINDOW_P (f))
3814 FRAME_RIF (f)->cursor_to (w->cursor.vpos, w->cursor.hpos,
3815 w->cursor.y, w->cursor.x);
3816 else
3818 int x, y;
3819 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3820 + (INTEGERP (w->left_margin_cols)
3821 ? XFASTINT (w->left_margin_cols)
3822 : 0));
3823 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3824 cursor_to (f, y, x);
3827 if (FRAME_TERMCAP_P (f))
3828 fflush (FRAME_TTY (f)->output);
3829 redisplay_performed_directly_p = 1;
3830 return 1;
3835 /***********************************************************************
3836 Frame Update
3837 ***********************************************************************/
3839 /* Update frame F based on the data in desired matrices.
3841 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3842 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3843 scrolling.
3845 Value is non-zero if redisplay was stopped due to pending input. */
3848 update_frame (f, force_p, inhibit_hairy_id_p)
3849 struct frame *f;
3850 int force_p;
3851 int inhibit_hairy_id_p;
3853 /* 1 means display has been paused because of pending input. */
3854 int paused_p;
3855 struct window *root_window = XWINDOW (f->root_window);
3857 if (redisplay_dont_pause)
3858 force_p = 1;
3859 #if PERIODIC_PREEMPTION_CHECKING
3860 else if (NILP (Vredisplay_preemption_period))
3861 force_p = 1;
3862 else if (!force_p && NUMBERP (Vredisplay_preemption_period))
3864 EMACS_TIME tm;
3865 double p = XFLOATINT (Vredisplay_preemption_period);
3866 int sec, usec;
3868 if (detect_input_pending_ignore_squeezables ())
3870 paused_p = 1;
3871 goto do_pause;
3874 sec = (int) p;
3875 usec = (p - sec) * 1000000;
3877 EMACS_GET_TIME (tm);
3878 EMACS_SET_SECS_USECS (preemption_period, sec, usec);
3879 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
3881 #endif
3883 if (FRAME_WINDOW_P (f))
3885 /* We are working on window matrix basis. All windows whose
3886 flag must_be_updated_p is set have to be updated. */
3888 /* Record that we are not working on frame matrices. */
3889 set_frame_matrix_frame (NULL);
3891 /* Update all windows in the window tree of F, maybe stopping
3892 when pending input is detected. */
3893 update_begin (f);
3895 /* Update the menu bar on X frames that don't have toolkit
3896 support. */
3897 if (WINDOWP (f->menu_bar_window))
3898 update_window (XWINDOW (f->menu_bar_window), 1);
3900 /* Update the tool-bar window, if present. */
3901 if (WINDOWP (f->tool_bar_window))
3903 struct window *w = XWINDOW (f->tool_bar_window);
3905 /* Update tool-bar window. */
3906 if (w->must_be_updated_p)
3908 Lisp_Object tem;
3910 update_window (w, 1);
3911 w->must_be_updated_p = 0;
3913 /* Swap tool-bar strings. We swap because we want to
3914 reuse strings. */
3915 tem = f->current_tool_bar_string;
3916 f->current_tool_bar_string = f->desired_tool_bar_string;
3917 f->desired_tool_bar_string = tem;
3922 /* Update windows. */
3923 paused_p = update_window_tree (root_window, force_p);
3924 update_end (f);
3926 /* This flush is a performance bottleneck under X,
3927 and it doesn't seem to be necessary anyway (in general).
3928 It is necessary when resizing the window with the mouse, or
3929 at least the fringes are not redrawn in a timely manner. ++kfs */
3930 if (f->force_flush_display_p)
3932 FRAME_RIF (f)->flush_display (f);
3933 f->force_flush_display_p = 0;
3936 else
3938 /* We are working on frame matrix basis. Set the frame on whose
3939 frame matrix we operate. */
3940 set_frame_matrix_frame (f);
3942 /* Build F's desired matrix from window matrices. */
3943 build_frame_matrix (f);
3945 /* Update the display */
3946 update_begin (f);
3947 paused_p = update_frame_1 (f, force_p, inhibit_hairy_id_p);
3948 update_end (f);
3950 if (FRAME_TERMCAP_P (f))
3952 if (FRAME_TTY (f)->termscript)
3953 fflush (FRAME_TTY (f)->termscript);
3954 fflush (FRAME_TTY (f)->output);
3957 /* Check window matrices for lost pointers. */
3958 #if GLYPH_DEBUG
3959 check_window_matrix_pointers (root_window);
3960 add_frame_display_history (f, paused_p);
3961 #endif
3964 do_pause:
3965 /* Reset flags indicating that a window should be updated. */
3966 set_window_update_flags (root_window, 0);
3968 display_completed = !paused_p;
3969 return paused_p;
3974 /************************************************************************
3975 Window-based updates
3976 ************************************************************************/
3978 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3979 don't stop updating when input is pending. */
3981 static int
3982 update_window_tree (w, force_p)
3983 struct window *w;
3984 int force_p;
3986 int paused_p = 0;
3988 while (w && !paused_p)
3990 if (!NILP (w->hchild))
3991 paused_p |= update_window_tree (XWINDOW (w->hchild), force_p);
3992 else if (!NILP (w->vchild))
3993 paused_p |= update_window_tree (XWINDOW (w->vchild), force_p);
3994 else if (w->must_be_updated_p)
3995 paused_p |= update_window (w, force_p);
3997 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4000 return paused_p;
4004 /* Update window W if its flag must_be_updated_p is non-zero. If
4005 FORCE_P is non-zero, don't stop updating if input is pending. */
4007 void
4008 update_single_window (w, force_p)
4009 struct window *w;
4010 int force_p;
4012 if (w->must_be_updated_p)
4014 struct frame *f = XFRAME (WINDOW_FRAME (w));
4016 /* Record that this is not a frame-based redisplay. */
4017 set_frame_matrix_frame (NULL);
4019 if (redisplay_dont_pause)
4020 force_p = 1;
4021 #if PERIODIC_PREEMPTION_CHECKING
4022 else if (NILP (Vredisplay_preemption_period))
4023 force_p = 1;
4024 else if (!force_p && NUMBERP (Vredisplay_preemption_period))
4026 EMACS_TIME tm;
4027 double p = XFLOATINT (Vredisplay_preemption_period);
4028 int sec, usec;
4030 sec = (int) p;
4031 usec = (p - sec) * 1000000;
4033 EMACS_GET_TIME (tm);
4034 EMACS_SET_SECS_USECS (preemption_period, sec, usec);
4035 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
4037 #endif
4039 /* Update W. */
4040 update_begin (f);
4041 update_window (w, force_p);
4042 update_end (f);
4044 /* Reset flag in W. */
4045 w->must_be_updated_p = 0;
4049 #ifdef HAVE_WINDOW_SYSTEM
4051 /* Redraw lines from the current matrix of window W that are
4052 overlapped by other rows. YB is bottom-most y-position in W. */
4054 static void
4055 redraw_overlapped_rows (w, yb)
4056 struct window *w;
4057 int yb;
4059 int i;
4060 struct frame *f = XFRAME (WINDOW_FRAME (w));
4062 /* If rows overlapping others have been changed, the rows being
4063 overlapped have to be redrawn. This won't draw lines that have
4064 already been drawn in update_window_line because overlapped_p in
4065 desired rows is 0, so after row assignment overlapped_p in
4066 current rows is 0. */
4067 for (i = 0; i < w->current_matrix->nrows; ++i)
4069 struct glyph_row *row = w->current_matrix->rows + i;
4071 if (!row->enabled_p)
4072 break;
4073 else if (row->mode_line_p)
4074 continue;
4076 if (row->overlapped_p)
4078 enum glyph_row_area area;
4080 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
4082 updated_row = row;
4083 updated_area = area;
4084 FRAME_RIF (f)->cursor_to (i, 0, row->y,
4085 area == TEXT_AREA ? row->x : 0);
4086 if (row->used[area])
4087 FRAME_RIF (f)->write_glyphs (row->glyphs[area],
4088 row->used[area]);
4089 FRAME_RIF (f)->clear_end_of_line (-1);
4092 row->overlapped_p = 0;
4095 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4096 break;
4101 /* Redraw lines from the current matrix of window W that overlap
4102 others. YB is bottom-most y-position in W. */
4104 static void
4105 redraw_overlapping_rows (w, yb)
4106 struct window *w;
4107 int yb;
4109 int i, bottom_y;
4110 struct glyph_row *row;
4111 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4113 for (i = 0; i < w->current_matrix->nrows; ++i)
4115 row = w->current_matrix->rows + i;
4117 if (!row->enabled_p)
4118 break;
4119 else if (row->mode_line_p)
4120 continue;
4122 bottom_y = MATRIX_ROW_BOTTOM_Y (row);
4124 if (row->overlapping_p && i > 0 && bottom_y < yb)
4126 int overlaps = 0;
4128 if (MATRIX_ROW_OVERLAPS_PRED_P (row)
4129 && !MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p)
4130 overlaps |= OVERLAPS_PRED;
4131 if (MATRIX_ROW_OVERLAPS_SUCC_P (row)
4132 && !MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p)
4133 overlaps |= OVERLAPS_SUCC;
4135 if (overlaps)
4137 if (row->used[LEFT_MARGIN_AREA])
4138 rif->fix_overlapping_area (w, row, LEFT_MARGIN_AREA, overlaps);
4140 if (row->used[TEXT_AREA])
4141 rif->fix_overlapping_area (w, row, TEXT_AREA, overlaps);
4143 if (row->used[RIGHT_MARGIN_AREA])
4144 rif->fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, overlaps);
4146 /* Record in neighbour rows that ROW overwrites part of
4147 their display. */
4148 if (overlaps & OVERLAPS_PRED)
4149 MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p = 1;
4150 if (overlaps & OVERLAPS_SUCC)
4151 MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p = 1;
4155 if (bottom_y >= yb)
4156 break;
4160 #endif /* HAVE_WINDOW_SYSTEM */
4163 #ifdef GLYPH_DEBUG
4165 /* Check that no row in the current matrix of window W is enabled
4166 which is below what's displayed in the window. */
4168 void
4169 check_current_matrix_flags (w)
4170 struct window *w;
4172 int last_seen_p = 0;
4173 int i, yb = window_text_bottom_y (w);
4175 for (i = 0; i < w->current_matrix->nrows - 1; ++i)
4177 struct glyph_row *row = MATRIX_ROW (w->current_matrix, i);
4178 if (!last_seen_p && MATRIX_ROW_BOTTOM_Y (row) >= yb)
4179 last_seen_p = 1;
4180 else if (last_seen_p && row->enabled_p)
4181 abort ();
4185 #endif /* GLYPH_DEBUG */
4188 /* Update display of window W. FORCE_P non-zero means that we should
4189 not stop when detecting pending input. */
4191 static int
4192 update_window (w, force_p)
4193 struct window *w;
4194 int force_p;
4196 struct glyph_matrix *desired_matrix = w->desired_matrix;
4197 int paused_p;
4198 #if !PERIODIC_PREEMPTION_CHECKING
4199 int preempt_count = baud_rate / 2400 + 1;
4200 #endif
4201 extern int input_pending;
4202 extern Lisp_Object do_mouse_tracking;
4203 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4204 #if GLYPH_DEBUG
4205 /* Check that W's frame doesn't have glyph matrices. */
4206 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w))));
4207 #endif
4209 /* Check pending input the first time so that we can quickly return. */
4210 #if !PERIODIC_PREEMPTION_CHECKING
4211 if (!force_p)
4212 detect_input_pending_ignore_squeezables ();
4213 #endif
4215 /* If forced to complete the update, or if no input is pending, do
4216 the update. */
4217 if (force_p || !input_pending || !NILP (do_mouse_tracking))
4219 struct glyph_row *row, *end;
4220 struct glyph_row *mode_line_row;
4221 struct glyph_row *header_line_row;
4222 int yb, changed_p = 0, mouse_face_overwritten_p = 0, n_updated;
4224 rif->update_window_begin_hook (w);
4225 yb = window_text_bottom_y (w);
4227 /* If window has a header line, update it before everything else.
4228 Adjust y-positions of other rows by the header line height. */
4229 row = desired_matrix->rows;
4230 end = row + desired_matrix->nrows - 1;
4232 if (row->mode_line_p)
4234 header_line_row = row;
4235 ++row;
4237 else
4238 header_line_row = NULL;
4240 /* Update the mode line, if necessary. */
4241 mode_line_row = MATRIX_MODE_LINE_ROW (desired_matrix);
4242 if (mode_line_row->mode_line_p && mode_line_row->enabled_p)
4244 mode_line_row->y = yb;
4245 update_window_line (w, MATRIX_ROW_VPOS (mode_line_row,
4246 desired_matrix),
4247 &mouse_face_overwritten_p);
4250 /* Find first enabled row. Optimizations in redisplay_internal
4251 may lead to an update with only one row enabled. There may
4252 be also completely empty matrices. */
4253 while (row < end && !row->enabled_p)
4254 ++row;
4256 /* Try reusing part of the display by copying. */
4257 if (row < end && !desired_matrix->no_scrolling_p)
4259 int rc = scrolling_window (w, header_line_row != NULL);
4260 if (rc < 0)
4262 /* All rows were found to be equal. */
4263 paused_p = 0;
4264 goto set_cursor;
4266 else if (rc > 0)
4268 /* We've scrolled the display. */
4269 force_p = 1;
4270 changed_p = 1;
4274 /* Update the rest of the lines. */
4275 for (n_updated = 0; row < end && (force_p || !input_pending); ++row)
4276 if (row->enabled_p)
4278 int vpos = MATRIX_ROW_VPOS (row, desired_matrix);
4279 int i;
4281 /* We'll have to play a little bit with when to
4282 detect_input_pending. If it's done too often,
4283 scrolling large windows with repeated scroll-up
4284 commands will too quickly pause redisplay. */
4285 #if PERIODIC_PREEMPTION_CHECKING
4286 if (!force_p)
4288 EMACS_TIME tm, dif;
4289 EMACS_GET_TIME (tm);
4290 EMACS_SUB_TIME (dif, preemption_next_check, tm);
4291 if (EMACS_TIME_NEG_P (dif))
4293 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
4294 if (detect_input_pending_ignore_squeezables ())
4295 break;
4298 #else
4299 if (!force_p && ++n_updated % preempt_count == 0)
4300 detect_input_pending_ignore_squeezables ();
4301 #endif
4302 changed_p |= update_window_line (w, vpos,
4303 &mouse_face_overwritten_p);
4305 /* Mark all rows below the last visible one in the current
4306 matrix as invalid. This is necessary because of
4307 variable line heights. Consider the case of three
4308 successive redisplays, where the first displays 5
4309 lines, the second 3 lines, and the third 5 lines again.
4310 If the second redisplay wouldn't mark rows in the
4311 current matrix invalid, the third redisplay might be
4312 tempted to optimize redisplay based on lines displayed
4313 in the first redisplay. */
4314 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4315 for (i = vpos + 1; i < w->current_matrix->nrows - 1; ++i)
4316 MATRIX_ROW (w->current_matrix, i)->enabled_p = 0;
4319 /* Was display preempted? */
4320 paused_p = row < end;
4322 set_cursor:
4324 /* Update the header line after scrolling because a new header
4325 line would otherwise overwrite lines at the top of the window
4326 that can be scrolled. */
4327 if (header_line_row && header_line_row->enabled_p)
4329 header_line_row->y = 0;
4330 update_window_line (w, 0, &mouse_face_overwritten_p);
4333 /* Fix the appearance of overlapping/overlapped rows. */
4334 if (!paused_p && !w->pseudo_window_p)
4336 #ifdef HAVE_WINDOW_SYSTEM
4337 if (changed_p && rif->fix_overlapping_area)
4339 redraw_overlapped_rows (w, yb);
4340 redraw_overlapping_rows (w, yb);
4342 #endif
4344 /* Make cursor visible at cursor position of W. */
4345 set_window_cursor_after_update (w);
4347 #if 0 /* Check that current matrix invariants are satisfied. This is
4348 for debugging only. See the comment of check_matrix_invariants. */
4349 IF_DEBUG (check_matrix_invariants (w));
4350 #endif
4353 #if GLYPH_DEBUG
4354 /* Remember the redisplay method used to display the matrix. */
4355 strcpy (w->current_matrix->method, w->desired_matrix->method);
4356 #endif
4358 #ifdef HAVE_WINDOW_SYSTEM
4359 update_window_fringes (w, 0);
4360 #endif
4362 /* End the update of window W. Don't set the cursor if we
4363 paused updating the display because in this case,
4364 set_window_cursor_after_update hasn't been called, and
4365 output_cursor doesn't contain the cursor location. */
4366 rif->update_window_end_hook (w, !paused_p, mouse_face_overwritten_p);
4368 else
4369 paused_p = 1;
4371 #if GLYPH_DEBUG
4372 /* check_current_matrix_flags (w); */
4373 add_window_display_history (w, w->current_matrix->method, paused_p);
4374 #endif
4376 clear_glyph_matrix (desired_matrix);
4378 return paused_p;
4382 /* Update the display of area AREA in window W, row number VPOS.
4383 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
4385 static void
4386 update_marginal_area (w, area, vpos)
4387 struct window *w;
4388 int area, vpos;
4390 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4391 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4393 /* Let functions in xterm.c know what area subsequent X positions
4394 will be relative to. */
4395 updated_area = area;
4397 /* Set cursor to start of glyphs, write them, and clear to the end
4398 of the area. I don't think that something more sophisticated is
4399 necessary here, since marginal areas will not be the default. */
4400 rif->cursor_to (vpos, 0, desired_row->y, 0);
4401 if (desired_row->used[area])
4402 rif->write_glyphs (desired_row->glyphs[area], desired_row->used[area]);
4403 rif->clear_end_of_line (-1);
4407 /* Update the display of the text area of row VPOS in window W.
4408 Value is non-zero if display has changed. */
4410 static int
4411 update_text_area (w, vpos)
4412 struct window *w;
4413 int vpos;
4415 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4416 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4417 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4418 int changed_p = 0;
4420 /* Let functions in xterm.c know what area subsequent X positions
4421 will be relative to. */
4422 updated_area = TEXT_AREA;
4424 /* If rows are at different X or Y, or rows have different height,
4425 or the current row is marked invalid, write the entire line. */
4426 if (!current_row->enabled_p
4427 || desired_row->y != current_row->y
4428 || desired_row->ascent != current_row->ascent
4429 || desired_row->phys_ascent != current_row->phys_ascent
4430 || desired_row->phys_height != current_row->phys_height
4431 || desired_row->visible_height != current_row->visible_height
4432 || current_row->overlapped_p
4433 /* This next line is necessary for correctly redrawing
4434 mouse-face areas after scrolling and other operations.
4435 However, it causes excessive flickering when mouse is moved
4436 across the mode line. Luckily, turning it off for the mode
4437 line doesn't seem to hurt anything. -- cyd.
4438 But it is still needed for the header line. -- kfs. */
4439 || (current_row->mouse_face_p
4440 && !(current_row->mode_line_p && vpos > 0))
4441 || current_row->x != desired_row->x)
4443 rif->cursor_to (vpos, 0, desired_row->y, desired_row->x);
4445 if (desired_row->used[TEXT_AREA])
4446 rif->write_glyphs (desired_row->glyphs[TEXT_AREA],
4447 desired_row->used[TEXT_AREA]);
4449 /* Clear to end of window. */
4450 rif->clear_end_of_line (-1);
4451 changed_p = 1;
4453 /* This erases the cursor. We do this here because
4454 notice_overwritten_cursor cannot easily check this, which
4455 might indicate that the whole functionality of
4456 notice_overwritten_cursor would better be implemented here.
4457 On the other hand, we need notice_overwritten_cursor as long
4458 as mouse highlighting is done asynchronously outside of
4459 redisplay. */
4460 if (vpos == w->phys_cursor.vpos)
4461 w->phys_cursor_on_p = 0;
4463 else
4465 int stop, i, x;
4466 struct glyph *current_glyph = current_row->glyphs[TEXT_AREA];
4467 struct glyph *desired_glyph = desired_row->glyphs[TEXT_AREA];
4468 int overlapping_glyphs_p = current_row->contains_overlapping_glyphs_p;
4469 int desired_stop_pos = desired_row->used[TEXT_AREA];
4471 /* If the desired row extends its face to the text area end, and
4472 unless the current row also does so at the same position,
4473 make sure we write at least one glyph, so that the face
4474 extension actually takes place. */
4475 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row)
4476 && (desired_stop_pos < current_row->used[TEXT_AREA]
4477 || (desired_stop_pos == current_row->used[TEXT_AREA]
4478 && !MATRIX_ROW_EXTENDS_FACE_P (current_row))))
4479 --desired_stop_pos;
4481 stop = min (current_row->used[TEXT_AREA], desired_stop_pos);
4482 i = 0;
4483 x = desired_row->x;
4485 /* Loop over glyphs that current and desired row may have
4486 in common. */
4487 while (i < stop)
4489 int can_skip_p = 1;
4491 /* Skip over glyphs that both rows have in common. These
4492 don't have to be written. We can't skip if the last
4493 current glyph overlaps the glyph to its right. For
4494 example, consider a current row of `if ' with the `f' in
4495 Courier bold so that it overlaps the ` ' to its right.
4496 If the desired row is ` ', we would skip over the space
4497 after the `if' and there would remain a pixel from the
4498 `f' on the screen. */
4499 if (overlapping_glyphs_p && i > 0)
4501 struct glyph *glyph = &current_row->glyphs[TEXT_AREA][i - 1];
4502 int left, right;
4504 rif->get_glyph_overhangs (glyph, XFRAME (w->frame),
4505 &left, &right);
4506 can_skip_p = right == 0;
4509 if (can_skip_p)
4511 while (i < stop
4512 && GLYPH_EQUAL_P (desired_glyph, current_glyph))
4514 x += desired_glyph->pixel_width;
4515 ++desired_glyph, ++current_glyph, ++i;
4518 /* Consider the case that the current row contains "xxx
4519 ppp ggg" in italic Courier font, and the desired row
4520 is "xxx ggg". The character `p' has lbearing, `g'
4521 has not. The loop above will stop in front of the
4522 first `p' in the current row. If we would start
4523 writing glyphs there, we wouldn't erase the lbearing
4524 of the `p'. The rest of the lbearing problem is then
4525 taken care of by draw_glyphs. */
4526 if (overlapping_glyphs_p
4527 && i > 0
4528 && i < current_row->used[TEXT_AREA]
4529 && (current_row->used[TEXT_AREA]
4530 != desired_row->used[TEXT_AREA]))
4532 int left, right;
4534 rif->get_glyph_overhangs (current_glyph, XFRAME (w->frame),
4535 &left, &right);
4536 while (left > 0 && i > 0)
4538 --i, --desired_glyph, --current_glyph;
4539 x -= desired_glyph->pixel_width;
4540 left -= desired_glyph->pixel_width;
4545 /* Try to avoid writing the entire rest of the desired row
4546 by looking for a resync point. This mainly prevents
4547 mode line flickering in the case the mode line is in
4548 fixed-pitch font, which it usually will be. */
4549 if (i < desired_row->used[TEXT_AREA])
4551 int start_x = x, start_hpos = i;
4552 struct glyph *start = desired_glyph;
4553 int current_x = x;
4554 int skip_first_p = !can_skip_p;
4556 /* Find the next glyph that's equal again. */
4557 while (i < stop
4558 && (skip_first_p
4559 || !GLYPH_EQUAL_P (desired_glyph, current_glyph))
4560 && x == current_x)
4562 x += desired_glyph->pixel_width;
4563 current_x += current_glyph->pixel_width;
4564 ++desired_glyph, ++current_glyph, ++i;
4565 skip_first_p = 0;
4568 if (i == start_hpos || x != current_x)
4570 i = start_hpos;
4571 x = start_x;
4572 desired_glyph = start;
4573 break;
4576 rif->cursor_to (vpos, start_hpos, desired_row->y, start_x);
4577 rif->write_glyphs (start, i - start_hpos);
4578 changed_p = 1;
4582 /* Write the rest. */
4583 if (i < desired_row->used[TEXT_AREA])
4585 rif->cursor_to (vpos, i, desired_row->y, x);
4586 rif->write_glyphs (desired_glyph, desired_row->used[TEXT_AREA] - i);
4587 changed_p = 1;
4590 /* Maybe clear to end of line. */
4591 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row))
4593 /* If new row extends to the end of the text area, nothing
4594 has to be cleared, if and only if we did a write_glyphs
4595 above. This is made sure by setting desired_stop_pos
4596 appropriately above. */
4597 xassert (i < desired_row->used[TEXT_AREA]
4598 || ((desired_row->used[TEXT_AREA]
4599 == current_row->used[TEXT_AREA])
4600 && MATRIX_ROW_EXTENDS_FACE_P (current_row)));
4602 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row))
4604 /* If old row extends to the end of the text area, clear. */
4605 if (i >= desired_row->used[TEXT_AREA])
4606 rif->cursor_to (vpos, i, desired_row->y,
4607 desired_row->pixel_width);
4608 rif->clear_end_of_line (-1);
4609 changed_p = 1;
4611 else if (desired_row->pixel_width < current_row->pixel_width)
4613 /* Otherwise clear to the end of the old row. Everything
4614 after that position should be clear already. */
4615 int x;
4617 if (i >= desired_row->used[TEXT_AREA])
4618 rif->cursor_to (vpos, i, desired_row->y,
4619 desired_row->pixel_width);
4621 /* If cursor is displayed at the end of the line, make sure
4622 it's cleared. Nowadays we don't have a phys_cursor_glyph
4623 with which to erase the cursor (because this method
4624 doesn't work with lbearing/rbearing), so we must do it
4625 this way. */
4626 if (vpos == w->phys_cursor.vpos
4627 && w->phys_cursor.hpos >= desired_row->used[TEXT_AREA])
4629 w->phys_cursor_on_p = 0;
4630 x = -1;
4632 else
4633 x = current_row->pixel_width;
4634 rif->clear_end_of_line (x);
4635 changed_p = 1;
4639 return changed_p;
4643 /* Update row VPOS in window W. Value is non-zero if display has been
4644 changed. */
4646 static int
4647 update_window_line (w, vpos, mouse_face_overwritten_p)
4648 struct window *w;
4649 int vpos, *mouse_face_overwritten_p;
4651 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4652 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4653 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4654 int changed_p = 0;
4656 /* Set the row being updated. This is important to let xterm.c
4657 know what line height values are in effect. */
4658 updated_row = desired_row;
4660 /* A row can be completely invisible in case a desired matrix was
4661 built with a vscroll and then make_cursor_line_fully_visible shifts
4662 the matrix. Make sure to make such rows current anyway, since
4663 we need the correct y-position, for example, in the current matrix. */
4664 if (desired_row->mode_line_p
4665 || desired_row->visible_height > 0)
4667 xassert (desired_row->enabled_p);
4669 /* Update display of the left margin area, if there is one. */
4670 if (!desired_row->full_width_p
4671 && !NILP (w->left_margin_cols))
4673 changed_p = 1;
4674 update_marginal_area (w, LEFT_MARGIN_AREA, vpos);
4677 /* Update the display of the text area. */
4678 if (update_text_area (w, vpos))
4680 changed_p = 1;
4681 if (current_row->mouse_face_p)
4682 *mouse_face_overwritten_p = 1;
4685 /* Update display of the right margin area, if there is one. */
4686 if (!desired_row->full_width_p
4687 && !NILP (w->right_margin_cols))
4689 changed_p = 1;
4690 update_marginal_area (w, RIGHT_MARGIN_AREA, vpos);
4693 /* Draw truncation marks etc. */
4694 if (!current_row->enabled_p
4695 || desired_row->y != current_row->y
4696 || desired_row->visible_height != current_row->visible_height
4697 || desired_row->cursor_in_fringe_p != current_row->cursor_in_fringe_p
4698 || desired_row->overlay_arrow_bitmap != current_row->overlay_arrow_bitmap
4699 || current_row->redraw_fringe_bitmaps_p
4700 || desired_row->mode_line_p != current_row->mode_line_p
4701 || desired_row->exact_window_width_line_p != current_row->exact_window_width_line_p
4702 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row)
4703 != MATRIX_ROW_CONTINUATION_LINE_P (current_row)))
4704 rif->after_update_window_line_hook (desired_row);
4707 /* Update current_row from desired_row. */
4708 make_current (w->desired_matrix, w->current_matrix, vpos);
4709 updated_row = NULL;
4710 return changed_p;
4714 /* Set the cursor after an update of window W. This function may only
4715 be called from update_window. */
4717 static void
4718 set_window_cursor_after_update (w)
4719 struct window *w;
4721 struct frame *f = XFRAME (w->frame);
4722 struct redisplay_interface *rif = FRAME_RIF (f);
4723 int cx, cy, vpos, hpos;
4725 /* Not intended for frame matrix updates. */
4726 xassert (FRAME_WINDOW_P (f));
4728 if (cursor_in_echo_area
4729 && !NILP (echo_area_buffer[0])
4730 /* If we are showing a message instead of the mini-buffer,
4731 show the cursor for the message instead. */
4732 && XWINDOW (minibuf_window) == w
4733 && EQ (minibuf_window, echo_area_window)
4734 /* These cases apply only to the frame that contains
4735 the active mini-buffer window. */
4736 && FRAME_HAS_MINIBUF_P (f)
4737 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
4739 cx = cy = vpos = hpos = 0;
4741 if (cursor_in_echo_area >= 0)
4743 /* If the mini-buffer is several lines high, find the last
4744 line that has any text on it. Note: either all lines
4745 are enabled or none. Otherwise we wouldn't be able to
4746 determine Y. */
4747 struct glyph_row *row, *last_row;
4748 struct glyph *glyph;
4749 int yb = window_text_bottom_y (w);
4751 last_row = NULL;
4752 row = w->current_matrix->rows;
4753 while (row->enabled_p
4754 && (last_row == NULL
4755 || MATRIX_ROW_BOTTOM_Y (row) <= yb))
4757 if (row->used[TEXT_AREA]
4758 && row->glyphs[TEXT_AREA][0].charpos >= 0)
4759 last_row = row;
4760 ++row;
4763 if (last_row)
4765 struct glyph *start = last_row->glyphs[TEXT_AREA];
4766 struct glyph *last = start + last_row->used[TEXT_AREA] - 1;
4768 while (last > start && last->charpos < 0)
4769 --last;
4771 for (glyph = start; glyph < last; ++glyph)
4773 cx += glyph->pixel_width;
4774 ++hpos;
4777 cy = last_row->y;
4778 vpos = MATRIX_ROW_VPOS (last_row, w->current_matrix);
4782 else
4784 cx = w->cursor.x;
4785 cy = w->cursor.y;
4786 hpos = w->cursor.hpos;
4787 vpos = w->cursor.vpos;
4790 /* Window cursor can be out of sync for horizontally split windows. */
4791 hpos = max (0, hpos);
4792 hpos = min (w->current_matrix->matrix_w - 1, hpos);
4793 vpos = max (0, vpos);
4794 vpos = min (w->current_matrix->nrows - 1, vpos);
4795 rif->cursor_to (vpos, hpos, cy, cx);
4799 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4800 tree rooted at W. */
4802 void
4803 set_window_update_flags (w, on_p)
4804 struct window *w;
4805 int on_p;
4807 while (w)
4809 if (!NILP (w->hchild))
4810 set_window_update_flags (XWINDOW (w->hchild), on_p);
4811 else if (!NILP (w->vchild))
4812 set_window_update_flags (XWINDOW (w->vchild), on_p);
4813 else
4814 w->must_be_updated_p = on_p;
4816 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4822 /***********************************************************************
4823 Window-Based Scrolling
4824 ***********************************************************************/
4826 /* Structure describing rows in scrolling_window. */
4828 struct row_entry
4830 /* Number of occurrences of this row in desired and current matrix. */
4831 int old_uses, new_uses;
4833 /* Vpos of row in new matrix. */
4834 int new_line_number;
4836 /* Bucket index of this row_entry in the hash table row_table. */
4837 int bucket;
4839 /* The row described by this entry. */
4840 struct glyph_row *row;
4842 /* Hash collision chain. */
4843 struct row_entry *next;
4846 /* A pool to allocate row_entry structures from, and the size of the
4847 pool. The pool is reallocated in scrolling_window when we find
4848 that we need a larger one. */
4850 static struct row_entry *row_entry_pool;
4851 static int row_entry_pool_size;
4853 /* Index of next free entry in row_entry_pool. */
4855 static int row_entry_idx;
4857 /* The hash table used during scrolling, and the table's size. This
4858 table is used to quickly identify equal rows in the desired and
4859 current matrix. */
4861 static struct row_entry **row_table;
4862 static int row_table_size;
4864 /* Vectors of pointers to row_entry structures belonging to the
4865 current and desired matrix, and the size of the vectors. */
4867 static struct row_entry **old_lines, **new_lines;
4868 static int old_lines_size, new_lines_size;
4870 /* A pool to allocate run structures from, and its size. */
4872 static struct run *run_pool;
4873 static int runs_size;
4875 /* A vector of runs of lines found during scrolling. */
4877 static struct run **runs;
4879 /* Add glyph row ROW to the scrolling hash table during the scrolling
4880 of window W. */
4882 static INLINE struct row_entry *
4883 add_row_entry (w, row)
4884 struct window *w;
4885 struct glyph_row *row;
4887 struct row_entry *entry;
4888 int i = row->hash % row_table_size;
4890 entry = row_table[i];
4891 while (entry && !row_equal_p (w, entry->row, row, 1))
4892 entry = entry->next;
4894 if (entry == NULL)
4896 entry = row_entry_pool + row_entry_idx++;
4897 entry->row = row;
4898 entry->old_uses = entry->new_uses = 0;
4899 entry->new_line_number = 0;
4900 entry->bucket = i;
4901 entry->next = row_table[i];
4902 row_table[i] = entry;
4905 return entry;
4909 /* Try to reuse part of the current display of W by scrolling lines.
4910 HEADER_LINE_P non-zero means W has a header line.
4912 The algorithm is taken from Communications of the ACM, Apr78 "A
4913 Technique for Isolating Differences Between Files." It should take
4914 O(N) time.
4916 A short outline of the steps of the algorithm
4918 1. Skip lines equal at the start and end of both matrices.
4920 2. Enter rows in the current and desired matrix into a symbol
4921 table, counting how often they appear in both matrices.
4923 3. Rows that appear exactly once in both matrices serve as anchors,
4924 i.e. we assume that such lines are likely to have been moved.
4926 4. Starting from anchor lines, extend regions to be scrolled both
4927 forward and backward.
4929 Value is
4931 -1 if all rows were found to be equal.
4932 0 to indicate that we did not scroll the display, or
4933 1 if we did scroll. */
4935 static int
4936 scrolling_window (w, header_line_p)
4937 struct window *w;
4938 int header_line_p;
4940 struct glyph_matrix *desired_matrix = w->desired_matrix;
4941 struct glyph_matrix *current_matrix = w->current_matrix;
4942 int yb = window_text_bottom_y (w);
4943 int i, j, first_old, first_new, last_old, last_new;
4944 int nruns, nbytes, n, run_idx;
4945 struct row_entry *entry;
4946 struct redisplay_interface *rif = FRAME_RIF (XFRAME (WINDOW_FRAME (w)));
4948 /* Skip over rows equal at the start. */
4949 for (i = header_line_p ? 1 : 0; i < current_matrix->nrows - 1; ++i)
4951 struct glyph_row *d = MATRIX_ROW (desired_matrix, i);
4952 struct glyph_row *c = MATRIX_ROW (current_matrix, i);
4954 if (c->enabled_p
4955 && d->enabled_p
4956 && !d->redraw_fringe_bitmaps_p
4957 && c->y == d->y
4958 && MATRIX_ROW_BOTTOM_Y (c) <= yb
4959 && MATRIX_ROW_BOTTOM_Y (d) <= yb
4960 && row_equal_p (w, c, d, 1))
4962 assign_row (c, d);
4963 d->enabled_p = 0;
4965 else
4966 break;
4969 /* Give up if some rows in the desired matrix are not enabled. */
4970 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4971 return -1;
4973 first_old = first_new = i;
4975 /* Set last_new to the index + 1 of the last enabled row in the
4976 desired matrix. */
4977 i = first_new + 1;
4978 while (i < desired_matrix->nrows - 1
4979 && MATRIX_ROW (desired_matrix, i)->enabled_p
4980 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix, i)) <= yb)
4981 ++i;
4983 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4984 return 0;
4986 last_new = i;
4988 /* Set last_old to the index + 1 of the last enabled row in the
4989 current matrix. We don't look at the enabled flag here because
4990 we plan to reuse part of the display even if other parts are
4991 disabled. */
4992 i = first_old + 1;
4993 while (i < current_matrix->nrows - 1)
4995 int bottom = MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix, i));
4996 if (bottom <= yb)
4997 ++i;
4998 if (bottom >= yb)
4999 break;
5002 last_old = i;
5004 /* Skip over rows equal at the bottom. */
5005 i = last_new;
5006 j = last_old;
5007 while (i - 1 > first_new
5008 && j - 1 > first_old
5009 && MATRIX_ROW (current_matrix, i - 1)->enabled_p
5010 && (MATRIX_ROW (current_matrix, i - 1)->y
5011 == MATRIX_ROW (desired_matrix, j - 1)->y)
5012 && !MATRIX_ROW (desired_matrix, j - 1)->redraw_fringe_bitmaps_p
5013 && row_equal_p (w,
5014 MATRIX_ROW (desired_matrix, i - 1),
5015 MATRIX_ROW (current_matrix, j - 1), 1))
5016 --i, --j;
5017 last_new = i;
5018 last_old = j;
5020 /* Nothing to do if all rows are equal. */
5021 if (last_new == first_new)
5022 return 0;
5024 /* Reallocate vectors, tables etc. if necessary. */
5026 if (current_matrix->nrows > old_lines_size)
5028 old_lines_size = current_matrix->nrows;
5029 nbytes = old_lines_size * sizeof *old_lines;
5030 old_lines = (struct row_entry **) xrealloc (old_lines, nbytes);
5033 if (desired_matrix->nrows > new_lines_size)
5035 new_lines_size = desired_matrix->nrows;
5036 nbytes = new_lines_size * sizeof *new_lines;
5037 new_lines = (struct row_entry **) xrealloc (new_lines, nbytes);
5040 n = desired_matrix->nrows + current_matrix->nrows;
5041 if (3 * n > row_table_size)
5043 row_table_size = next_almost_prime (3 * n);
5044 nbytes = row_table_size * sizeof *row_table;
5045 row_table = (struct row_entry **) xrealloc (row_table, nbytes);
5046 bzero (row_table, nbytes);
5049 if (n > row_entry_pool_size)
5051 row_entry_pool_size = n;
5052 nbytes = row_entry_pool_size * sizeof *row_entry_pool;
5053 row_entry_pool = (struct row_entry *) xrealloc (row_entry_pool, nbytes);
5056 if (desired_matrix->nrows > runs_size)
5058 runs_size = desired_matrix->nrows;
5059 nbytes = runs_size * sizeof *runs;
5060 runs = (struct run **) xrealloc (runs, nbytes);
5061 nbytes = runs_size * sizeof *run_pool;
5062 run_pool = (struct run *) xrealloc (run_pool, nbytes);
5065 nruns = run_idx = 0;
5066 row_entry_idx = 0;
5068 /* Add rows from the current and desired matrix to the hash table
5069 row_hash_table to be able to find equal ones quickly. */
5071 for (i = first_old; i < last_old; ++i)
5073 if (MATRIX_ROW (current_matrix, i)->enabled_p)
5075 entry = add_row_entry (w, MATRIX_ROW (current_matrix, i));
5076 old_lines[i] = entry;
5077 ++entry->old_uses;
5079 else
5080 old_lines[i] = NULL;
5083 for (i = first_new; i < last_new; ++i)
5085 xassert (MATRIX_ROW_ENABLED_P (desired_matrix, i));
5086 entry = add_row_entry (w, MATRIX_ROW (desired_matrix, i));
5087 ++entry->new_uses;
5088 entry->new_line_number = i;
5089 new_lines[i] = entry;
5092 /* Identify moves based on lines that are unique and equal
5093 in both matrices. */
5094 for (i = first_old; i < last_old;)
5095 if (old_lines[i]
5096 && old_lines[i]->old_uses == 1
5097 && old_lines[i]->new_uses == 1)
5099 int j, k;
5100 int new_line = old_lines[i]->new_line_number;
5101 struct run *run = run_pool + run_idx++;
5103 /* Record move. */
5104 run->current_vpos = i;
5105 run->current_y = MATRIX_ROW (current_matrix, i)->y;
5106 run->desired_vpos = new_line;
5107 run->desired_y = MATRIX_ROW (desired_matrix, new_line)->y;
5108 run->nrows = 1;
5109 run->height = MATRIX_ROW (current_matrix, i)->height;
5111 /* Extend backward. */
5112 j = i - 1;
5113 k = new_line - 1;
5114 while (j > first_old
5115 && k > first_new
5116 && old_lines[j] == new_lines[k])
5118 int h = MATRIX_ROW (current_matrix, j)->height;
5119 --run->current_vpos;
5120 --run->desired_vpos;
5121 ++run->nrows;
5122 run->height += h;
5123 run->desired_y -= h;
5124 run->current_y -= h;
5125 --j, --k;
5128 /* Extend forward. */
5129 j = i + 1;
5130 k = new_line + 1;
5131 while (j < last_old
5132 && k < last_new
5133 && old_lines[j] == new_lines[k])
5135 int h = MATRIX_ROW (current_matrix, j)->height;
5136 ++run->nrows;
5137 run->height += h;
5138 ++j, ++k;
5141 /* Insert run into list of all runs. Order runs by copied
5142 pixel lines. Note that we record runs that don't have to
5143 be copied because they are already in place. This is done
5144 because we can avoid calling update_window_line in this
5145 case. */
5146 for (j = 0; j < nruns && runs[j]->height > run->height; ++j)
5148 for (k = nruns; k > j; --k)
5149 runs[k] = runs[k - 1];
5150 runs[j] = run;
5151 ++nruns;
5153 i += run->nrows;
5155 else
5156 ++i;
5158 /* Do the moves. Do it in a way that we don't overwrite something
5159 we want to copy later on. This is not solvable in general
5160 because there is only one display and we don't have a way to
5161 exchange areas on this display. Example:
5163 +-----------+ +-----------+
5164 | A | | B |
5165 +-----------+ --> +-----------+
5166 | B | | A |
5167 +-----------+ +-----------+
5169 Instead, prefer bigger moves, and invalidate moves that would
5170 copy from where we copied to. */
5172 for (i = 0; i < nruns; ++i)
5173 if (runs[i]->nrows > 0)
5175 struct run *r = runs[i];
5177 /* Copy on the display. */
5178 if (r->current_y != r->desired_y)
5180 rif->scroll_run_hook (w, r);
5182 /* Invalidate runs that copy from where we copied to. */
5183 for (j = i + 1; j < nruns; ++j)
5185 struct run *p = runs[j];
5187 if ((p->current_y >= r->desired_y
5188 && p->current_y < r->desired_y + r->height)
5189 || (p->current_y + p->height >= r->desired_y
5190 && (p->current_y + p->height
5191 < r->desired_y + r->height)))
5192 p->nrows = 0;
5196 /* Assign matrix rows. */
5197 for (j = 0; j < r->nrows; ++j)
5199 struct glyph_row *from, *to;
5200 int to_overlapped_p;
5202 to = MATRIX_ROW (current_matrix, r->desired_vpos + j);
5203 from = MATRIX_ROW (desired_matrix, r->desired_vpos + j);
5204 to_overlapped_p = to->overlapped_p;
5205 if (!from->mode_line_p && !w->pseudo_window_p
5206 && (to->left_fringe_bitmap != from->left_fringe_bitmap
5207 || to->right_fringe_bitmap != from->right_fringe_bitmap
5208 || to->left_fringe_face_id != from->left_fringe_face_id
5209 || to->right_fringe_face_id != from->right_fringe_face_id
5210 || to->overlay_arrow_bitmap != from->overlay_arrow_bitmap))
5211 from->redraw_fringe_bitmaps_p = 1;
5212 assign_row (to, from);
5213 to->enabled_p = 1, from->enabled_p = 0;
5214 to->overlapped_p = to_overlapped_p;
5218 /* Clear the hash table, for the next time. */
5219 for (i = 0; i < row_entry_idx; ++i)
5220 row_table[row_entry_pool[i].bucket] = NULL;
5222 /* Value is > 0 to indicate that we scrolled the display. */
5223 return nruns;
5228 /************************************************************************
5229 Frame-Based Updates
5230 ************************************************************************/
5232 /* Update the desired frame matrix of frame F.
5234 FORCE_P non-zero means that the update should not be stopped by
5235 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
5236 should not be tried.
5238 Value is non-zero if update was stopped due to pending input. */
5240 static int
5241 update_frame_1 (f, force_p, inhibit_id_p)
5242 struct frame *f;
5243 int force_p;
5244 int inhibit_id_p;
5246 /* Frame matrices to work on. */
5247 struct glyph_matrix *current_matrix = f->current_matrix;
5248 struct glyph_matrix *desired_matrix = f->desired_matrix;
5249 int i;
5250 int pause;
5251 int preempt_count = baud_rate / 2400 + 1;
5252 extern int input_pending;
5254 xassert (current_matrix && desired_matrix);
5256 if (baud_rate != FRAME_COST_BAUD_RATE (f))
5257 calculate_costs (f);
5259 if (preempt_count <= 0)
5260 preempt_count = 1;
5262 #if !PERIODIC_PREEMPTION_CHECKING
5263 if (!force_p && detect_input_pending_ignore_squeezables ())
5265 pause = 1;
5266 goto do_pause;
5268 #endif
5270 /* If we cannot insert/delete lines, it's no use trying it. */
5271 if (!FRAME_LINE_INS_DEL_OK (f))
5272 inhibit_id_p = 1;
5274 /* See if any of the desired lines are enabled; don't compute for
5275 i/d line if just want cursor motion. */
5276 for (i = 0; i < desired_matrix->nrows; i++)
5277 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5278 break;
5280 /* Try doing i/d line, if not yet inhibited. */
5281 if (!inhibit_id_p && i < desired_matrix->nrows)
5282 force_p |= scrolling (f);
5284 /* Update the individual lines as needed. Do bottom line first. */
5285 if (MATRIX_ROW_ENABLED_P (desired_matrix, desired_matrix->nrows - 1))
5286 update_frame_line (f, desired_matrix->nrows - 1);
5288 /* Now update the rest of the lines. */
5289 for (i = 0; i < desired_matrix->nrows - 1 && (force_p || !input_pending); i++)
5291 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5293 if (FRAME_TERMCAP_P (f))
5295 /* Flush out every so many lines.
5296 Also flush out if likely to have more than 1k buffered
5297 otherwise. I'm told that some telnet connections get
5298 really screwed by more than 1k output at once. */
5299 int outq = PENDING_OUTPUT_COUNT (FRAME_TTY (f)->output);
5300 if (outq > 900
5301 || (outq > 20 && ((i - 1) % preempt_count == 0)))
5303 fflush (FRAME_TTY (f)->output);
5304 if (preempt_count == 1)
5306 #ifdef EMACS_OUTQSIZE
5307 if (EMACS_OUTQSIZE (0, &outq) < 0)
5308 /* Probably not a tty. Ignore the error and reset
5309 the outq count. */
5310 outq = PENDING_OUTPUT_COUNT (FRAME_TTY (f->output));
5311 #endif
5312 outq *= 10;
5313 if (baud_rate <= outq && baud_rate > 0)
5314 sleep (outq / baud_rate);
5319 #if PERIODIC_PREEMPTION_CHECKING
5320 if (!force_p)
5322 EMACS_TIME tm, dif;
5323 EMACS_GET_TIME (tm);
5324 EMACS_SUB_TIME (dif, preemption_next_check, tm);
5325 if (EMACS_TIME_NEG_P (dif))
5327 EMACS_ADD_TIME (preemption_next_check, tm, preemption_period);
5328 if (detect_input_pending_ignore_squeezables ())
5329 break;
5332 #else
5333 if (!force_p && (i - 1) % preempt_count == 0)
5334 detect_input_pending_ignore_squeezables ();
5335 #endif
5337 update_frame_line (f, i);
5341 pause = (i < FRAME_LINES (f) - 1) ? i : 0;
5343 /* Now just clean up termcap drivers and set cursor, etc. */
5344 if (!pause)
5346 if ((cursor_in_echo_area
5347 /* If we are showing a message instead of the mini-buffer,
5348 show the cursor for the message instead of for the
5349 (now hidden) mini-buffer contents. */
5350 || (EQ (minibuf_window, selected_window)
5351 && EQ (minibuf_window, echo_area_window)
5352 && !NILP (echo_area_buffer[0])))
5353 /* These cases apply only to the frame that contains
5354 the active mini-buffer window. */
5355 && FRAME_HAS_MINIBUF_P (f)
5356 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
5358 int top = WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f)));
5359 int row, col;
5361 if (cursor_in_echo_area < 0)
5363 /* Negative value of cursor_in_echo_area means put
5364 cursor at beginning of line. */
5365 row = top;
5366 col = 0;
5368 else
5370 /* Positive value of cursor_in_echo_area means put
5371 cursor at the end of the prompt. If the mini-buffer
5372 is several lines high, find the last line that has
5373 any text on it. */
5374 row = FRAME_LINES (f);
5377 --row;
5378 col = 0;
5380 if (MATRIX_ROW_ENABLED_P (current_matrix, row))
5382 /* Frame rows are filled up with spaces that
5383 must be ignored here. */
5384 struct glyph_row *r = MATRIX_ROW (current_matrix,
5385 row);
5386 struct glyph *start = r->glyphs[TEXT_AREA];
5387 struct glyph *last = start + r->used[TEXT_AREA];
5389 while (last > start
5390 && (last - 1)->charpos < 0)
5391 --last;
5393 col = last - start;
5396 while (row > top && col == 0);
5398 /* Make sure COL is not out of range. */
5399 if (col >= FRAME_CURSOR_X_LIMIT (f))
5401 /* If we have another row, advance cursor into it. */
5402 if (row < FRAME_LINES (f) - 1)
5404 col = FRAME_LEFT_SCROLL_BAR_COLS (f);
5405 row++;
5407 /* Otherwise move it back in range. */
5408 else
5409 col = FRAME_CURSOR_X_LIMIT (f) - 1;
5413 cursor_to (f, row, col);
5415 else
5417 /* We have only one cursor on terminal frames. Use it to
5418 display the cursor of the selected window. */
5419 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
5420 if (w->cursor.vpos >= 0
5421 /* The cursor vpos may be temporarily out of bounds
5422 in the following situation: There is one window,
5423 with the cursor in the lower half of it. The window
5424 is split, and a message causes a redisplay before
5425 a new cursor position has been computed. */
5426 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
5428 int x = WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos);
5429 int y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
5431 if (INTEGERP (w->left_margin_cols))
5432 x += XFASTINT (w->left_margin_cols);
5434 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
5435 cursor_to (f, y, x);
5440 do_pause:
5442 clear_desired_matrices (f);
5443 return pause;
5447 /* Do line insertions/deletions on frame F for frame-based redisplay. */
5450 scrolling (frame)
5451 struct frame *frame;
5453 int unchanged_at_top, unchanged_at_bottom;
5454 int window_size;
5455 int changed_lines;
5456 int *old_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5457 int *new_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5458 int *draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5459 int *old_draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5460 register int i;
5461 int free_at_end_vpos = FRAME_LINES (frame);
5462 struct glyph_matrix *current_matrix = frame->current_matrix;
5463 struct glyph_matrix *desired_matrix = frame->desired_matrix;
5465 if (!current_matrix)
5466 abort ();
5468 /* Compute hash codes of all the lines. Also calculate number of
5469 changed lines, number of unchanged lines at the beginning, and
5470 number of unchanged lines at the end. */
5471 changed_lines = 0;
5472 unchanged_at_top = 0;
5473 unchanged_at_bottom = FRAME_LINES (frame);
5474 for (i = 0; i < FRAME_LINES (frame); i++)
5476 /* Give up on this scrolling if some old lines are not enabled. */
5477 if (!MATRIX_ROW_ENABLED_P (current_matrix, i))
5478 return 0;
5479 old_hash[i] = line_hash_code (MATRIX_ROW (current_matrix, i));
5480 if (! MATRIX_ROW_ENABLED_P (desired_matrix, i))
5482 /* This line cannot be redrawn, so don't let scrolling mess it. */
5483 new_hash[i] = old_hash[i];
5484 #define INFINITY 1000000 /* Taken from scroll.c */
5485 draw_cost[i] = INFINITY;
5487 else
5489 new_hash[i] = line_hash_code (MATRIX_ROW (desired_matrix, i));
5490 draw_cost[i] = line_draw_cost (desired_matrix, i);
5493 if (old_hash[i] != new_hash[i])
5495 changed_lines++;
5496 unchanged_at_bottom = FRAME_LINES (frame) - i - 1;
5498 else if (i == unchanged_at_top)
5499 unchanged_at_top++;
5500 old_draw_cost[i] = line_draw_cost (current_matrix, i);
5503 /* If changed lines are few, don't allow preemption, don't scroll. */
5504 if ((!FRAME_SCROLL_REGION_OK (frame)
5505 && changed_lines < baud_rate / 2400)
5506 || unchanged_at_bottom == FRAME_LINES (frame))
5507 return 1;
5509 window_size = (FRAME_LINES (frame) - unchanged_at_top
5510 - unchanged_at_bottom);
5512 if (FRAME_SCROLL_REGION_OK (frame))
5513 free_at_end_vpos -= unchanged_at_bottom;
5514 else if (FRAME_MEMORY_BELOW_FRAME (frame))
5515 free_at_end_vpos = -1;
5517 /* If large window, fast terminal and few lines in common between
5518 current frame and desired frame, don't bother with i/d calc. */
5519 if (!FRAME_SCROLL_REGION_OK (frame)
5520 && window_size >= 18 && baud_rate > 2400
5521 && (window_size >=
5522 10 * scrolling_max_lines_saved (unchanged_at_top,
5523 FRAME_LINES (frame) - unchanged_at_bottom,
5524 old_hash, new_hash, draw_cost)))
5525 return 0;
5527 if (window_size < 2)
5528 return 0;
5530 scrolling_1 (frame, window_size, unchanged_at_top, unchanged_at_bottom,
5531 draw_cost + unchanged_at_top - 1,
5532 old_draw_cost + unchanged_at_top - 1,
5533 old_hash + unchanged_at_top - 1,
5534 new_hash + unchanged_at_top - 1,
5535 free_at_end_vpos - unchanged_at_top);
5537 return 0;
5541 /* Count the number of blanks at the start of the vector of glyphs R
5542 which is LEN glyphs long. */
5544 static int
5545 count_blanks (r, len)
5546 struct glyph *r;
5547 int len;
5549 int i;
5551 for (i = 0; i < len; ++i)
5552 if (!CHAR_GLYPH_SPACE_P (r[i]))
5553 break;
5555 return i;
5559 /* Count the number of glyphs in common at the start of the glyph
5560 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
5561 of STR2. Value is the number of equal glyphs equal at the start. */
5563 static int
5564 count_match (str1, end1, str2, end2)
5565 struct glyph *str1, *end1, *str2, *end2;
5567 struct glyph *p1 = str1;
5568 struct glyph *p2 = str2;
5570 while (p1 < end1
5571 && p2 < end2
5572 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1, p2))
5573 ++p1, ++p2;
5575 return p1 - str1;
5579 /* Char insertion/deletion cost vector, from term.c */
5581 extern int *char_ins_del_vector;
5582 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
5585 /* Perform a frame-based update on line VPOS in frame FRAME. */
5587 static void
5588 update_frame_line (f, vpos)
5589 struct frame *f;
5590 int vpos;
5592 struct glyph *obody, *nbody, *op1, *op2, *np1, *nend;
5593 int tem;
5594 int osp, nsp, begmatch, endmatch, olen, nlen;
5595 struct glyph_matrix *current_matrix = f->current_matrix;
5596 struct glyph_matrix *desired_matrix = f->desired_matrix;
5597 struct glyph_row *current_row = MATRIX_ROW (current_matrix, vpos);
5598 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, vpos);
5599 int must_write_whole_line_p;
5600 int write_spaces_p = FRAME_MUST_WRITE_SPACES (f);
5601 int colored_spaces_p = (FACE_FROM_ID (f, DEFAULT_FACE_ID)->background
5602 != FACE_TTY_DEFAULT_BG_COLOR);
5604 if (colored_spaces_p)
5605 write_spaces_p = 1;
5607 /* Current row not enabled means it has unknown contents. We must
5608 write the whole desired line in that case. */
5609 must_write_whole_line_p = !current_row->enabled_p;
5610 if (must_write_whole_line_p)
5612 obody = 0;
5613 olen = 0;
5615 else
5617 obody = MATRIX_ROW_GLYPH_START (current_matrix, vpos);
5618 olen = current_row->used[TEXT_AREA];
5620 /* Ignore trailing spaces, if we can. */
5621 if (!write_spaces_p)
5622 while (olen > 0 && CHAR_GLYPH_SPACE_P (obody[olen-1]))
5623 olen--;
5626 current_row->enabled_p = 1;
5627 current_row->used[TEXT_AREA] = desired_row->used[TEXT_AREA];
5629 /* If desired line is empty, just clear the line. */
5630 if (!desired_row->enabled_p)
5632 nlen = 0;
5633 goto just_erase;
5636 nbody = desired_row->glyphs[TEXT_AREA];
5637 nlen = desired_row->used[TEXT_AREA];
5638 nend = nbody + nlen;
5640 /* If display line has unknown contents, write the whole line. */
5641 if (must_write_whole_line_p)
5643 /* Ignore spaces at the end, if we can. */
5644 if (!write_spaces_p)
5645 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5646 --nlen;
5648 /* Write the contents of the desired line. */
5649 if (nlen)
5651 cursor_to (f, vpos, 0);
5652 write_glyphs (f, nbody, nlen);
5655 /* Don't call clear_end_of_line if we already wrote the whole
5656 line. The cursor will not be at the right margin in that
5657 case but in the line below. */
5658 if (nlen < FRAME_TOTAL_COLS (f))
5660 cursor_to (f, vpos, nlen);
5661 clear_end_of_line (f, FRAME_TOTAL_COLS (f));
5663 else
5664 /* Make sure we are in the right row, otherwise cursor movement
5665 with cmgoto might use `ch' in the wrong row. */
5666 cursor_to (f, vpos, 0);
5668 make_current (desired_matrix, current_matrix, vpos);
5669 return;
5672 /* Pretend trailing spaces are not there at all,
5673 unless for one reason or another we must write all spaces. */
5674 if (!write_spaces_p)
5675 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5676 nlen--;
5678 /* If there's no i/d char, quickly do the best we can without it. */
5679 if (!FRAME_CHAR_INS_DEL_OK (f))
5681 int i, j;
5683 /* Find the first glyph in desired row that doesn't agree with
5684 a glyph in the current row, and write the rest from there on. */
5685 for (i = 0; i < nlen; i++)
5687 if (i >= olen || !GLYPH_EQUAL_P (nbody + i, obody + i))
5689 /* Find the end of the run of different glyphs. */
5690 j = i + 1;
5691 while (j < nlen
5692 && (j >= olen
5693 || !GLYPH_EQUAL_P (nbody + j, obody + j)
5694 || CHAR_GLYPH_PADDING_P (nbody[j])))
5695 ++j;
5697 /* Output this run of non-matching chars. */
5698 cursor_to (f, vpos, i);
5699 write_glyphs (f, nbody + i, j - i);
5700 i = j - 1;
5702 /* Now find the next non-match. */
5706 /* Clear the rest of the line, or the non-clear part of it. */
5707 if (olen > nlen)
5709 cursor_to (f, vpos, nlen);
5710 clear_end_of_line (f, olen);
5713 /* Make current row = desired row. */
5714 make_current (desired_matrix, current_matrix, vpos);
5715 return;
5718 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5719 characters in a row. */
5721 if (!olen)
5723 /* If current line is blank, skip over initial spaces, if
5724 possible, and write the rest. */
5725 if (write_spaces_p)
5726 nsp = 0;
5727 else
5728 nsp = count_blanks (nbody, nlen);
5730 if (nlen > nsp)
5732 cursor_to (f, vpos, nsp);
5733 write_glyphs (f, nbody + nsp, nlen - nsp);
5736 /* Exchange contents between current_frame and new_frame. */
5737 make_current (desired_matrix, current_matrix, vpos);
5738 return;
5741 /* Compute number of leading blanks in old and new contents. */
5742 osp = count_blanks (obody, olen);
5743 nsp = (colored_spaces_p ? 0 : count_blanks (nbody, nlen));
5745 /* Compute number of matching chars starting with first non-blank. */
5746 begmatch = count_match (obody + osp, obody + olen,
5747 nbody + nsp, nbody + nlen);
5749 /* Spaces in new match implicit space past the end of old. */
5750 /* A bug causing this to be a no-op was fixed in 18.29. */
5751 if (!write_spaces_p && osp + begmatch == olen)
5753 np1 = nbody + nsp;
5754 while (np1 + begmatch < nend && CHAR_GLYPH_SPACE_P (np1[begmatch]))
5755 ++begmatch;
5758 /* Avoid doing insert/delete char
5759 just cause number of leading spaces differs
5760 when the following text does not match. */
5761 if (begmatch == 0 && osp != nsp)
5762 osp = nsp = min (osp, nsp);
5764 /* Find matching characters at end of line */
5765 op1 = obody + olen;
5766 np1 = nbody + nlen;
5767 op2 = op1 + begmatch - min (olen - osp, nlen - nsp);
5768 while (op1 > op2
5769 && GLYPH_EQUAL_P (op1 - 1, np1 - 1))
5771 op1--;
5772 np1--;
5774 endmatch = obody + olen - op1;
5776 /* tem gets the distance to insert or delete.
5777 endmatch is how many characters we save by doing so.
5778 Is it worth it? */
5780 tem = (nlen - nsp) - (olen - osp);
5781 if (endmatch && tem
5782 && (!FRAME_CHAR_INS_DEL_OK (f)
5783 || endmatch <= char_ins_del_cost (f)[tem]))
5784 endmatch = 0;
5786 /* nsp - osp is the distance to insert or delete.
5787 If that is nonzero, begmatch is known to be nonzero also.
5788 begmatch + endmatch is how much we save by doing the ins/del.
5789 Is it worth it? */
5791 if (nsp != osp
5792 && (!FRAME_CHAR_INS_DEL_OK (f)
5793 || begmatch + endmatch <= char_ins_del_cost (f)[nsp - osp]))
5795 begmatch = 0;
5796 endmatch = 0;
5797 osp = nsp = min (osp, nsp);
5800 /* Now go through the line, inserting, writing and
5801 deleting as appropriate. */
5803 if (osp > nsp)
5805 cursor_to (f, vpos, nsp);
5806 delete_glyphs (f, osp - nsp);
5808 else if (nsp > osp)
5810 /* If going to delete chars later in line
5811 and insert earlier in the line,
5812 must delete first to avoid losing data in the insert */
5813 if (endmatch && nlen < olen + nsp - osp)
5815 cursor_to (f, vpos, nlen - endmatch + osp - nsp);
5816 delete_glyphs (f, olen + nsp - osp - nlen);
5817 olen = nlen - (nsp - osp);
5819 cursor_to (f, vpos, osp);
5820 insert_glyphs (f, 0, nsp - osp);
5822 olen += nsp - osp;
5824 tem = nsp + begmatch + endmatch;
5825 if (nlen != tem || olen != tem)
5827 if (!endmatch || nlen == olen)
5829 /* If new text being written reaches right margin, there is
5830 no need to do clear-to-eol at the end of this function
5831 (and it would not be safe, since cursor is not going to
5832 be "at the margin" after the text is done). */
5833 if (nlen == FRAME_TOTAL_COLS (f))
5834 olen = 0;
5836 /* Function write_glyphs is prepared to do nothing
5837 if passed a length <= 0. Check it here to avoid
5838 unnecessary cursor movement. */
5839 if (nlen - tem > 0)
5841 cursor_to (f, vpos, nsp + begmatch);
5842 write_glyphs (f, nbody + nsp + begmatch, nlen - tem);
5845 else if (nlen > olen)
5847 /* Here, we used to have the following simple code:
5848 ----------------------------------------
5849 write_glyphs (nbody + nsp + begmatch, olen - tem);
5850 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5851 ----------------------------------------
5852 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5853 is a padding glyph. */
5854 int out = olen - tem; /* Columns to be overwritten originally. */
5855 int del;
5857 cursor_to (f, vpos, nsp + begmatch);
5859 /* Calculate columns we can actually overwrite. */
5860 while (CHAR_GLYPH_PADDING_P (nbody[nsp + begmatch + out]))
5861 out--;
5862 write_glyphs (f, nbody + nsp + begmatch, out);
5864 /* If we left columns to be overwritten, we must delete them. */
5865 del = olen - tem - out;
5866 if (del > 0)
5867 delete_glyphs (f, del);
5869 /* At last, we insert columns not yet written out. */
5870 insert_glyphs (f, nbody + nsp + begmatch + out, nlen - olen + del);
5871 olen = nlen;
5873 else if (olen > nlen)
5875 cursor_to (f, vpos, nsp + begmatch);
5876 write_glyphs (f, nbody + nsp + begmatch, nlen - tem);
5877 delete_glyphs (f, olen - nlen);
5878 olen = nlen;
5882 just_erase:
5883 /* If any unerased characters remain after the new line, erase them. */
5884 if (olen > nlen)
5886 cursor_to (f, vpos, nlen);
5887 clear_end_of_line (f, olen);
5890 /* Exchange contents between current_frame and new_frame. */
5891 make_current (desired_matrix, current_matrix, vpos);
5896 /***********************************************************************
5897 X/Y Position -> Buffer Position
5898 ***********************************************************************/
5900 /* Determine what's under window-relative pixel position (*X, *Y).
5901 Return the object (string or buffer) that's there.
5902 Return in *POS the position in that object.
5903 Adjust *X and *Y to character positions. */
5905 Lisp_Object
5906 buffer_posn_from_coords (w, x, y, pos, object, dx, dy, width, height)
5907 struct window *w;
5908 int *x, *y;
5909 struct display_pos *pos;
5910 Lisp_Object *object;
5911 int *dx, *dy;
5912 int *width, *height;
5914 struct it it;
5915 struct buffer *old_current_buffer = current_buffer;
5916 struct text_pos startp;
5917 Lisp_Object string;
5918 struct glyph_row *row;
5919 #ifdef HAVE_WINDOW_SYSTEM
5920 struct image *img = 0;
5921 #endif
5922 int x0, x1;
5924 current_buffer = XBUFFER (w->buffer);
5925 SET_TEXT_POS_FROM_MARKER (startp, w->start);
5926 CHARPOS (startp) = min (ZV, max (BEGV, CHARPOS (startp)));
5927 BYTEPOS (startp) = min (ZV_BYTE, max (BEGV_BYTE, BYTEPOS (startp)));
5928 start_display (&it, w, startp);
5930 x0 = *x - WINDOW_LEFT_MARGIN_WIDTH (w);
5931 move_it_to (&it, -1, x0 + it.first_visible_x, *y, -1,
5932 MOVE_TO_X | MOVE_TO_Y);
5934 current_buffer = old_current_buffer;
5936 *dx = x0 + it.first_visible_x - it.current_x;
5937 *dy = *y - it.current_y;
5939 string = w->buffer;
5940 if (STRINGP (it.string))
5941 string = it.string;
5942 *pos = it.current;
5944 #ifdef HAVE_WINDOW_SYSTEM
5945 if (it.what == IT_IMAGE)
5947 if ((img = IMAGE_FROM_ID (it.f, it.image_id)) != NULL
5948 && !NILP (img->spec))
5949 *object = img->spec;
5951 #endif
5953 if (it.vpos < w->current_matrix->nrows
5954 && (row = MATRIX_ROW (w->current_matrix, it.vpos),
5955 row->enabled_p))
5957 if (it.hpos < row->used[TEXT_AREA])
5959 struct glyph *glyph = row->glyphs[TEXT_AREA] + it.hpos;
5960 #ifdef HAVE_WINDOW_SYSTEM
5961 if (img)
5963 *dy -= row->ascent - glyph->ascent;
5964 *dx += glyph->slice.x;
5965 *dy += glyph->slice.y;
5966 /* Image slices positions are still relative to the entire image */
5967 *width = img->width;
5968 *height = img->height;
5970 else
5971 #endif
5973 *width = glyph->pixel_width;
5974 *height = glyph->ascent + glyph->descent;
5977 else
5979 *width = 0;
5980 *height = row->height;
5983 else
5985 *width = *height = 0;
5988 /* Add extra (default width) columns if clicked after EOL. */
5989 x1 = max(0, it.current_x + it.pixel_width - it.first_visible_x);
5990 if (x0 > x1)
5991 it.hpos += (x0 - x1) / WINDOW_FRAME_COLUMN_WIDTH (w);
5993 *x = it.hpos;
5994 *y = it.vpos;
5996 return string;
6000 /* Value is the string under window-relative coordinates X/Y in the
6001 mode line or header line (PART says which) of window W, or nil if none.
6002 *CHARPOS is set to the position in the string returned. */
6004 Lisp_Object
6005 mode_line_string (w, part, x, y, charpos, object, dx, dy, width, height)
6006 struct window *w;
6007 enum window_part part;
6008 int *x, *y;
6009 int *charpos;
6010 Lisp_Object *object;
6011 int *dx, *dy;
6012 int *width, *height;
6014 struct glyph_row *row;
6015 struct glyph *glyph, *end;
6016 int x0, y0;
6017 Lisp_Object string = Qnil;
6019 if (part == ON_MODE_LINE)
6020 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
6021 else
6022 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
6023 y0 = *y - row->y;
6024 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
6026 if (row->mode_line_p && row->enabled_p)
6028 /* Find the glyph under X. If we find one with a string object,
6029 it's the one we were looking for. */
6030 glyph = row->glyphs[TEXT_AREA];
6031 end = glyph + row->used[TEXT_AREA];
6032 for (x0 = *x; glyph < end && x0 >= glyph->pixel_width; ++glyph)
6033 x0 -= glyph->pixel_width;
6034 *x = glyph - row->glyphs[TEXT_AREA];
6035 if (glyph < end)
6037 string = glyph->object;
6038 *charpos = glyph->charpos;
6039 *width = glyph->pixel_width;
6040 *height = glyph->ascent + glyph->descent;
6041 #ifdef HAVE_WINDOW_SYSTEM
6042 if (glyph->type == IMAGE_GLYPH)
6044 struct image *img;
6045 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
6046 if (img != NULL)
6047 *object = img->spec;
6048 y0 -= row->ascent - glyph->ascent;
6050 #endif
6052 else
6054 /* Add extra (default width) columns if clicked after EOL. */
6055 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
6056 *width = 0;
6057 *height = row->height;
6060 else
6062 *x = 0;
6063 x0 = 0;
6064 *width = *height = 0;
6067 *dx = x0;
6068 *dy = y0;
6070 return string;
6074 /* Value is the string under window-relative coordinates X/Y in either
6075 marginal area, or nil if none. *CHARPOS is set to the position in
6076 the string returned. */
6078 Lisp_Object
6079 marginal_area_string (w, part, x, y, charpos, object, dx, dy, width, height)
6080 struct window *w;
6081 enum window_part part;
6082 int *x, *y;
6083 int *charpos;
6084 Lisp_Object *object;
6085 int *dx, *dy;
6086 int *width, *height;
6088 struct glyph_row *row = w->current_matrix->rows;
6089 struct glyph *glyph, *end;
6090 int x0, y0, i, wy = *y;
6091 int area;
6092 Lisp_Object string = Qnil;
6094 if (part == ON_LEFT_MARGIN)
6095 area = LEFT_MARGIN_AREA;
6096 else if (part == ON_RIGHT_MARGIN)
6097 area = RIGHT_MARGIN_AREA;
6098 else
6099 abort ();
6101 for (i = 0; row->enabled_p && i < w->current_matrix->nrows; ++i, ++row)
6102 if (wy >= row->y && wy < MATRIX_ROW_BOTTOM_Y (row))
6103 break;
6104 y0 = *y - row->y;
6105 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
6107 if (row->enabled_p)
6109 /* Find the glyph under X. If we find one with a string object,
6110 it's the one we were looking for. */
6111 if (area == RIGHT_MARGIN_AREA)
6112 x0 = ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6113 ? WINDOW_LEFT_FRINGE_WIDTH (w)
6114 : WINDOW_TOTAL_FRINGE_WIDTH (w))
6115 + window_box_width (w, LEFT_MARGIN_AREA)
6116 + window_box_width (w, TEXT_AREA));
6117 else
6118 x0 = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
6119 ? WINDOW_LEFT_FRINGE_WIDTH (w)
6120 : 0);
6122 glyph = row->glyphs[area];
6123 end = glyph + row->used[area];
6124 for (x0 = *x - x0; glyph < end && x0 >= glyph->pixel_width; ++glyph)
6125 x0 -= glyph->pixel_width;
6126 *x = glyph - row->glyphs[area];
6127 if (glyph < end)
6129 string = glyph->object;
6130 *charpos = glyph->charpos;
6131 *width = glyph->pixel_width;
6132 *height = glyph->ascent + glyph->descent;
6133 #ifdef HAVE_WINDOW_SYSTEM
6134 if (glyph->type == IMAGE_GLYPH)
6136 struct image *img;
6137 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
6138 if (img != NULL)
6139 *object = img->spec;
6140 y0 -= row->ascent - glyph->ascent;
6141 x0 += glyph->slice.x;
6142 y0 += glyph->slice.y;
6144 #endif
6146 else
6148 /* Add extra (default width) columns if clicked after EOL. */
6149 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
6150 *width = 0;
6151 *height = row->height;
6154 else
6156 x0 = 0;
6157 *x = 0;
6158 *width = *height = 0;
6161 *dx = x0;
6162 *dy = y0;
6164 return string;
6168 /***********************************************************************
6169 Changing Frame Sizes
6170 ***********************************************************************/
6172 #ifdef SIGWINCH
6174 SIGTYPE
6175 window_change_signal (signalnum) /* If we don't have an argument, */
6176 int signalnum; /* some compilers complain in signal calls. */
6178 int width, height;
6179 #ifndef USE_CRT_DLL
6180 extern int errno;
6181 #endif
6182 int old_errno = errno;
6184 struct tty_display_info *tty;
6186 signal (SIGWINCH, window_change_signal);
6187 SIGNAL_THREAD_CHECK (signalnum);
6189 /* The frame size change obviously applies to a single
6190 termcap-controlled terminal, but we can't decide which.
6191 Therefore, we resize the frames corresponding to each tty.
6193 for (tty = tty_list; tty; tty = tty->next) {
6195 if (! tty->term_initted)
6196 continue;
6198 get_tty_size (fileno (tty->input), &width, &height);
6200 if (width > 5 && height > 2) {
6201 Lisp_Object tail, frame;
6203 FOR_EACH_FRAME (tail, frame)
6204 if (FRAME_TERMCAP_P (XFRAME (frame)) && FRAME_TTY (XFRAME (frame)) == tty)
6205 /* Record the new sizes, but don't reallocate the data
6206 structures now. Let that be done later outside of the
6207 signal handler. */
6208 change_frame_size (XFRAME (frame), height, width, 0, 1, 0);
6212 errno = old_errno;
6214 #endif /* SIGWINCH */
6217 /* Do any change in frame size that was requested by a signal. SAFE
6218 non-zero means this function is called from a place where it is
6219 safe to change frame sizes while a redisplay is in progress. */
6221 void
6222 do_pending_window_change (safe)
6223 int safe;
6225 /* If window_change_signal should have run before, run it now. */
6226 if (redisplaying_p && !safe)
6227 return;
6229 while (delayed_size_change)
6231 Lisp_Object tail, frame;
6233 delayed_size_change = 0;
6235 FOR_EACH_FRAME (tail, frame)
6237 struct frame *f = XFRAME (frame);
6239 if (f->new_text_lines != 0 || f->new_text_cols != 0)
6240 change_frame_size (f, f->new_text_lines, f->new_text_cols,
6241 0, 0, safe);
6247 /* Change the frame height and/or width. Values may be given as zero to
6248 indicate no change is to take place.
6250 If DELAY is non-zero, then assume we're being called from a signal
6251 handler, and queue the change for later - perhaps the next
6252 redisplay. Since this tries to resize windows, we can't call it
6253 from a signal handler.
6255 SAFE non-zero means this function is called from a place where it's
6256 safe to change frame sizes while a redisplay is in progress. */
6258 void
6259 change_frame_size (f, newheight, newwidth, pretend, delay, safe)
6260 register struct frame *f;
6261 int newheight, newwidth, pretend, delay, safe;
6263 Lisp_Object tail, frame;
6265 if (FRAME_MSDOS_P (f))
6267 /* On MS-DOS, all frames use the same screen, so a change in
6268 size affects all frames. Termcap now supports multiple
6269 ttys. */
6270 FOR_EACH_FRAME (tail, frame)
6271 if (! FRAME_WINDOW_P (XFRAME (frame)))
6272 change_frame_size_1 (XFRAME (frame), newheight, newwidth,
6273 pretend, delay, safe);
6275 else
6276 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe);
6279 static void
6280 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe)
6281 register struct frame *f;
6282 int newheight, newwidth, pretend, delay, safe;
6284 int new_frame_total_cols;
6285 int count = SPECPDL_INDEX ();
6287 /* If we can't deal with the change now, queue it for later. */
6288 if (delay || (redisplaying_p && !safe))
6290 f->new_text_lines = newheight;
6291 f->new_text_cols = newwidth;
6292 delayed_size_change = 1;
6293 return;
6296 /* This size-change overrides any pending one for this frame. */
6297 f->new_text_lines = 0;
6298 f->new_text_cols = 0;
6300 /* If an argument is zero, set it to the current value. */
6301 if (newheight == 0)
6302 newheight = FRAME_LINES (f);
6303 if (newwidth == 0)
6304 newwidth = FRAME_COLS (f);
6306 /* Compute width of windows in F.
6307 This is the width of the frame without vertical scroll bars. */
6308 new_frame_total_cols = FRAME_TOTAL_COLS_ARG (f, newwidth);
6310 /* Round up to the smallest acceptable size. */
6311 check_frame_size (f, &newheight, &newwidth);
6313 /* If we're not changing the frame size, quit now. */
6314 if (newheight == FRAME_LINES (f)
6315 && new_frame_total_cols == FRAME_TOTAL_COLS (f))
6316 return;
6318 BLOCK_INPUT;
6320 #ifdef MSDOS
6321 /* We only can set screen dimensions to certain values supported
6322 by our video hardware. Try to find the smallest size greater
6323 or equal to the requested dimensions. */
6324 dos_set_window_size (&newheight, &newwidth);
6325 #endif
6327 if (newheight != FRAME_LINES (f))
6329 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
6331 /* Frame has both root and mini-buffer. */
6332 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f))->top_line,
6333 FRAME_TOP_MARGIN (f));
6334 set_window_height (FRAME_ROOT_WINDOW (f),
6335 (newheight
6337 - FRAME_TOP_MARGIN (f)),
6339 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f))->top_line,
6340 newheight - 1);
6341 set_window_height (FRAME_MINIBUF_WINDOW (f), 1, 0);
6343 else
6344 /* Frame has just one top-level window. */
6345 set_window_height (FRAME_ROOT_WINDOW (f),
6346 newheight - FRAME_TOP_MARGIN (f), 0);
6348 if (FRAME_TERMCAP_P (f) && !pretend)
6349 FrameRows (FRAME_TTY (f)) = newheight;
6352 if (new_frame_total_cols != FRAME_TOTAL_COLS (f))
6354 set_window_width (FRAME_ROOT_WINDOW (f), new_frame_total_cols, 0);
6355 if (FRAME_HAS_MINIBUF_P (f))
6356 set_window_width (FRAME_MINIBUF_WINDOW (f), new_frame_total_cols, 0);
6358 if (FRAME_TERMCAP_P (f) && !pretend)
6359 FrameCols (FRAME_TTY (f)) = newwidth;
6361 if (WINDOWP (f->tool_bar_window))
6362 XSETFASTINT (XWINDOW (f->tool_bar_window)->total_cols, newwidth);
6365 FRAME_LINES (f) = newheight;
6366 SET_FRAME_COLS (f, newwidth);
6369 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
6370 int text_area_x, text_area_y, text_area_width, text_area_height;
6372 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
6373 &text_area_height);
6374 if (w->cursor.x >= text_area_x + text_area_width)
6375 w->cursor.hpos = w->cursor.x = 0;
6376 if (w->cursor.y >= text_area_y + text_area_height)
6377 w->cursor.vpos = w->cursor.y = 0;
6380 adjust_glyphs (f);
6381 calculate_costs (f);
6382 SET_FRAME_GARBAGED (f);
6383 f->resized_p = 1;
6385 UNBLOCK_INPUT;
6387 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
6389 run_window_configuration_change_hook (f);
6391 unbind_to (count, Qnil);
6396 /***********************************************************************
6397 Terminal Related Lisp Functions
6398 ***********************************************************************/
6400 DEFUN ("open-termscript", Fopen_termscript, Sopen_termscript,
6401 1, 1, "FOpen termscript file: ",
6402 doc: /* Start writing all terminal output to FILE as well as the terminal.
6403 FILE = nil means just close any termscript file currently open. */)
6404 (file)
6405 Lisp_Object file;
6407 struct tty_display_info *tty;
6409 if (! FRAME_TERMCAP_P (SELECTED_FRAME ()))
6410 error ("Current frame is not on a tty device");
6412 tty = CURTTY ();
6414 if (tty->termscript != 0)
6416 BLOCK_INPUT;
6417 fclose (tty->termscript);
6418 UNBLOCK_INPUT;
6420 tty->termscript = 0;
6422 if (! NILP (file))
6424 file = Fexpand_file_name (file, Qnil);
6425 tty->termscript = fopen (SDATA (file), "w");
6426 if (tty->termscript == 0)
6427 report_file_error ("Opening termscript", Fcons (file, Qnil));
6429 return Qnil;
6433 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal,
6434 Ssend_string_to_terminal, 1, 2, 0,
6435 doc: /* Send STRING to the terminal without alteration.
6436 Control characters in STRING will have terminal-dependent effects.
6438 Optional parameter TERMINAL specifies the tty terminal device to use.
6439 It may be a terminal id, a frame, or nil for the terminal used by the
6440 currently selected frame. */)
6441 (string, terminal)
6442 Lisp_Object string;
6443 Lisp_Object terminal;
6445 struct terminal *t = get_tty_terminal (terminal, 1);
6446 struct tty_display_info *tty;
6448 /* ??? Perhaps we should do something special for multibyte strings here. */
6449 CHECK_STRING (string);
6450 BLOCK_INPUT;
6452 if (!t)
6453 error ("Unknown terminal device");
6455 tty = t->display_info.tty;
6457 if (tty->termscript)
6459 fwrite (SDATA (string), 1, SBYTES (string), tty->termscript);
6460 fflush (tty->termscript);
6462 fwrite (SDATA (string), 1, SBYTES (string), tty->output);
6463 fflush (tty->output);
6464 UNBLOCK_INPUT;
6465 return Qnil;
6469 DEFUN ("ding", Fding, Sding, 0, 1, 0,
6470 doc: /* Beep, or flash the screen.
6471 Also, unless an argument is given,
6472 terminate any keyboard macro currently executing. */)
6473 (arg)
6474 Lisp_Object arg;
6476 if (!NILP (arg))
6478 if (noninteractive)
6479 putchar (07);
6480 else
6481 ring_bell (XFRAME (selected_frame));
6483 else
6484 bitch_at_user ();
6486 return Qnil;
6489 void
6490 bitch_at_user ()
6492 if (noninteractive)
6493 putchar (07);
6494 else if (!INTERACTIVE) /* Stop executing a keyboard macro. */
6495 error ("Keyboard macro terminated by a command ringing the bell");
6496 else
6497 ring_bell (XFRAME (selected_frame));
6502 /***********************************************************************
6503 Sleeping, Waiting
6504 ***********************************************************************/
6506 DEFUN ("sleep-for", Fsleep_for, Ssleep_for, 1, 2, 0,
6507 doc: /* Pause, without updating display, for SECONDS seconds.
6508 SECONDS may be a floating-point value, meaning that you can wait for a
6509 fraction of a second. Optional second arg MILLISECONDS specifies an
6510 additional wait period, in milliseconds; this may be useful if your
6511 Emacs was built without floating point support.
6512 \(Not all operating systems support waiting for a fraction of a second.) */)
6513 (seconds, milliseconds)
6514 Lisp_Object seconds, milliseconds;
6516 int sec, usec;
6518 if (NILP (milliseconds))
6519 XSETINT (milliseconds, 0);
6520 else
6521 CHECK_NUMBER (milliseconds);
6522 usec = XINT (milliseconds) * 1000;
6525 double duration = extract_float (seconds);
6526 sec = (int) duration;
6527 usec += (duration - sec) * 1000000;
6530 #ifndef EMACS_HAS_USECS
6531 if (sec == 0 && usec != 0)
6532 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE);
6533 #endif
6535 /* Assure that 0 <= usec < 1000000. */
6536 if (usec < 0)
6538 /* We can't rely on the rounding being correct if usec is negative. */
6539 if (-1000000 < usec)
6540 sec--, usec += 1000000;
6541 else
6542 sec -= -usec / 1000000, usec = 1000000 - (-usec % 1000000);
6544 else
6545 sec += usec / 1000000, usec %= 1000000;
6547 if (sec < 0 || (sec == 0 && usec == 0))
6548 return Qnil;
6550 wait_reading_process_output (sec, usec, 0, 0, Qnil, NULL, 0);
6552 return Qnil;
6556 /* This is just like wait_reading_process_output, except that
6557 it does redisplay.
6559 TIMEOUT is number of seconds to wait (float or integer),
6560 or t to wait forever.
6561 READING is 1 if reading input.
6562 If DO_DISPLAY is >0 display process output while waiting.
6563 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
6566 Lisp_Object
6567 sit_for (timeout, reading, do_display)
6568 Lisp_Object timeout;
6569 int reading, do_display;
6571 int sec, usec;
6573 swallow_events (do_display);
6575 if ((detect_input_pending_run_timers (do_display))
6576 || !NILP (Vexecuting_kbd_macro))
6577 return Qnil;
6579 if (do_display >= 2)
6580 redisplay_preserve_echo_area (2);
6582 if (INTEGERP (timeout))
6584 sec = XINT (timeout);
6585 usec = 0;
6587 else if (FLOATP (timeout))
6589 double seconds = XFLOAT_DATA (timeout);
6590 sec = (int) seconds;
6591 usec = (int) ((seconds - sec) * 1000000);
6593 else if (EQ (timeout, Qt))
6595 sec = 0;
6596 usec = 0;
6598 else
6599 wrong_type_argument (Qnumberp, timeout);
6601 if (sec == 0 && usec == 0 && !EQ (timeout, Qt))
6602 return Qt;
6604 #ifdef SIGIO
6605 gobble_input (0);
6606 #endif
6608 wait_reading_process_output (sec, usec, reading ? -1 : 1, do_display,
6609 Qnil, NULL, 0);
6611 return detect_input_pending () ? Qnil : Qt;
6615 DEFUN ("redisplay", Fredisplay, Sredisplay, 0, 1, 0,
6616 doc: /* Perform redisplay if no input is available.
6617 If optional arg FORCE is non-nil or `redisplay-dont-pause' is non-nil,
6618 perform a full redisplay even if input is available.
6619 Return t if redisplay was performed, nil otherwise. */)
6620 (force)
6621 Lisp_Object force;
6623 int count;
6625 swallow_events (1);
6626 if ((detect_input_pending_run_timers (1)
6627 && NILP (force) && !redisplay_dont_pause)
6628 || !NILP (Vexecuting_kbd_macro))
6629 return Qnil;
6631 count = SPECPDL_INDEX ();
6632 if (!NILP (force) && !redisplay_dont_pause)
6633 specbind (Qredisplay_dont_pause, Qt);
6634 redisplay_preserve_echo_area (2);
6635 unbind_to (count, Qnil);
6636 return Qt;
6641 /***********************************************************************
6642 Other Lisp Functions
6643 ***********************************************************************/
6645 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6646 session's frames, frame names, buffers, buffer-read-only flags, and
6647 buffer-modified-flags. */
6649 static Lisp_Object frame_and_buffer_state;
6652 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p,
6653 Sframe_or_buffer_changed_p, 0, 1, 0,
6654 doc: /* Return non-nil if the frame and buffer state appears to have changed.
6655 VARIABLE is a variable name whose value is either nil or a state vector
6656 that will be updated to contain all frames and buffers,
6657 aside from buffers whose names start with space,
6658 along with the buffers' read-only and modified flags. This allows a fast
6659 check to see whether buffer menus might need to be recomputed.
6660 If this function returns non-nil, it updates the internal vector to reflect
6661 the current state.
6663 If VARIABLE is nil, an internal variable is used. Users should not
6664 pass nil for VARIABLE. */)
6665 (variable)
6666 Lisp_Object variable;
6668 Lisp_Object state, tail, frame, buf;
6669 Lisp_Object *vecp, *end;
6670 int n;
6672 if (! NILP (variable))
6674 CHECK_SYMBOL (variable);
6675 state = Fsymbol_value (variable);
6676 if (! VECTORP (state))
6677 goto changed;
6679 else
6680 state = frame_and_buffer_state;
6682 vecp = XVECTOR (state)->contents;
6683 end = vecp + XVECTOR (state)->size;
6685 FOR_EACH_FRAME (tail, frame)
6687 if (vecp == end)
6688 goto changed;
6689 if (!EQ (*vecp++, frame))
6690 goto changed;
6691 if (vecp == end)
6692 goto changed;
6693 if (!EQ (*vecp++, XFRAME (frame)->name))
6694 goto changed;
6696 /* Check that the buffer info matches. */
6697 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6699 buf = XCDR (XCAR (tail));
6700 /* Ignore buffers that aren't included in buffer lists. */
6701 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6702 continue;
6703 if (vecp == end)
6704 goto changed;
6705 if (!EQ (*vecp++, buf))
6706 goto changed;
6707 if (vecp == end)
6708 goto changed;
6709 if (!EQ (*vecp++, XBUFFER (buf)->read_only))
6710 goto changed;
6711 if (vecp == end)
6712 goto changed;
6713 if (!EQ (*vecp++, Fbuffer_modified_p (buf)))
6714 goto changed;
6716 if (vecp == end)
6717 goto changed;
6718 /* Detect deletion of a buffer at the end of the list. */
6719 if (EQ (*vecp, Qlambda))
6720 return Qnil;
6722 /* Come here if we decide the data has changed. */
6723 changed:
6724 /* Count the size we will need.
6725 Start with 1 so there is room for at least one lambda at the end. */
6726 n = 1;
6727 FOR_EACH_FRAME (tail, frame)
6728 n += 2;
6729 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6730 n += 3;
6731 /* Reallocate the vector if data has grown to need it,
6732 or if it has shrunk a lot. */
6733 if (! VECTORP (state)
6734 || n > XVECTOR (state)->size
6735 || n + 20 < XVECTOR (state)->size / 2)
6736 /* Add 20 extra so we grow it less often. */
6738 state = Fmake_vector (make_number (n + 20), Qlambda);
6739 if (! NILP (variable))
6740 Fset (variable, state);
6741 else
6742 frame_and_buffer_state = state;
6745 /* Record the new data in the (possibly reallocated) vector. */
6746 vecp = XVECTOR (state)->contents;
6747 FOR_EACH_FRAME (tail, frame)
6749 *vecp++ = frame;
6750 *vecp++ = XFRAME (frame)->name;
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 *vecp++ = buf;
6759 *vecp++ = XBUFFER (buf)->read_only;
6760 *vecp++ = Fbuffer_modified_p (buf);
6762 /* Fill up the vector with lambdas (always at least one). */
6763 *vecp++ = Qlambda;
6764 while (vecp - XVECTOR (state)->contents
6765 < XVECTOR (state)->size)
6766 *vecp++ = Qlambda;
6767 /* Make sure we didn't overflow the vector. */
6768 if (vecp - XVECTOR (state)->contents
6769 > XVECTOR (state)->size)
6770 abort ();
6771 return Qt;
6776 /***********************************************************************
6777 Initialization
6778 ***********************************************************************/
6780 /* Initialization done when Emacs fork is started, before doing stty.
6781 Determine terminal type and set terminal_driver. Then invoke its
6782 decoding routine to set up variables in the terminal package. */
6784 void
6785 init_display ()
6787 char *terminal_type;
6789 #ifdef HAVE_X_WINDOWS
6790 extern int display_arg;
6791 #endif
6793 /* Construct the space glyph. */
6794 space_glyph.type = CHAR_GLYPH;
6795 SET_CHAR_GLYPH_FROM_GLYPH (space_glyph, ' ');
6796 space_glyph.charpos = -1;
6798 inverse_video = 0;
6799 cursor_in_echo_area = 0;
6800 terminal_type = (char *) 0;
6802 /* Now is the time to initialize this; it's used by init_sys_modes
6803 during startup. */
6804 Vinitial_window_system = Qnil;
6806 /* SIGWINCH needs to be handled no matter what display we start
6807 with. Otherwise newly opened tty frames will not resize
6808 automatically. */
6809 #ifdef SIGWINCH
6810 #ifndef CANNOT_DUMP
6811 if (initialized)
6812 #endif /* CANNOT_DUMP */
6813 signal (SIGWINCH, window_change_signal);
6814 #endif /* SIGWINCH */
6816 /* If the user wants to use a window system, we shouldn't bother
6817 initializing the terminal. This is especially important when the
6818 terminal is so dumb that emacs gives up before and doesn't bother
6819 using the window system.
6821 If the DISPLAY environment variable is set and nonempty,
6822 try to use X, and die with an error message if that doesn't work. */
6824 #ifdef HAVE_X_WINDOWS
6825 if (! inhibit_window_system && ! display_arg)
6827 char *display;
6828 #ifdef VMS
6829 display = getenv ("DECW$DISPLAY");
6830 #else
6831 display = getenv ("DISPLAY");
6832 #endif
6834 display_arg = (display != 0 && *display != 0);
6836 if (display_arg && !x_display_ok (display))
6838 fprintf (stderr, "Display %s unavailable, simulating -nw\n",
6839 display);
6840 inhibit_window_system = 1;
6844 if (!inhibit_window_system && display_arg
6845 #ifndef CANNOT_DUMP
6846 && initialized
6847 #endif
6850 Vinitial_window_system = intern ("x");
6851 #ifdef HAVE_X11
6852 Vwindow_system_version = make_number (11);
6853 #else
6854 Vwindow_system_version = make_number (10);
6855 #endif
6856 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6857 /* In some versions of ncurses,
6858 tputs crashes if we have not called tgetent.
6859 So call tgetent. */
6860 { char b[2044]; tgetent (b, "xterm");}
6861 #endif
6862 adjust_frame_glyphs_initially ();
6863 return;
6865 #endif /* HAVE_X_WINDOWS */
6867 #ifdef HAVE_NTGUI
6868 if (!inhibit_window_system)
6870 Vinitial_window_system = intern ("w32");
6871 Vwindow_system_version = make_number (1);
6872 adjust_frame_glyphs_initially ();
6873 return;
6875 #endif /* HAVE_NTGUI */
6877 #ifdef MAC_OS
6878 if (!inhibit_window_system)
6880 Vinitial_window_system = intern ("mac");
6881 Vwindow_system_version = make_number (1);
6882 adjust_frame_glyphs_initially ();
6883 return;
6885 #endif /* MAC_OS */
6887 /* If no window system has been specified, try to use the terminal. */
6888 if (! isatty (0))
6890 fatal ("standard input is not a tty");
6891 exit (1);
6894 #ifdef WINDOWSNT
6895 terminal_type = "w32console";
6896 #else
6897 /* Look at the TERM variable. */
6898 terminal_type = (char *) getenv ("TERM");
6899 #endif
6900 if (!terminal_type)
6902 #ifdef VMS
6903 fprintf (stderr, "Please specify your terminal type.\n\
6904 For types defined in VMS, use set term /device=TYPE.\n\
6905 For types not defined in VMS, use define emacs_term \"TYPE\".\n\
6906 \(The quotation marks are necessary since terminal types are lower case.)\n");
6907 #else /* not VMS */
6909 #ifdef HAVE_WINDOW_SYSTEM
6910 if (! inhibit_window_system)
6911 fprintf (stderr, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6912 else
6913 #endif /* HAVE_WINDOW_SYSTEM */
6914 fprintf (stderr, "Please set the environment variable TERM; see `tset'.\n");
6915 #endif /* not VMS */
6916 exit (1);
6919 #ifdef VMS
6920 /* VMS DCL tends to up-case things, so down-case term type.
6921 Hardly any uppercase letters in terminal types; should be none. */
6923 char *new = (char *) xmalloc (strlen (terminal_type) + 1);
6924 char *p;
6926 strcpy (new, terminal_type);
6928 for (p = new; *p; p++)
6929 if (isupper (*p))
6930 *p = tolower (*p);
6932 terminal_type = new;
6934 #endif /* VMS */
6937 struct terminal *t;
6938 struct frame *f = XFRAME (selected_frame);
6940 /* Open a display on the controlling tty. */
6941 t = init_tty (0, terminal_type, 1); /* Errors are fatal. */
6943 /* Convert the initial frame to use the new display. */
6944 if (f->output_method != output_initial)
6945 abort ();
6946 f->output_method = t->type;
6947 f->terminal = t;
6949 t->reference_count++;
6950 t->display_info.tty->top_frame = selected_frame;
6951 change_frame_size (XFRAME (selected_frame),
6952 FrameRows (t->display_info.tty),
6953 FrameCols (t->display_info.tty), 0, 0, 1);
6955 /* Delete the initial terminal. */
6956 if (--initial_terminal->reference_count == 0
6957 && initial_terminal->delete_terminal_hook)
6958 (*initial_terminal->delete_terminal_hook) (initial_terminal);
6960 /* Update frame parameters to reflect the new type. */
6961 Fmodify_frame_parameters
6962 (selected_frame, Fcons (Fcons (Qtty_type,
6963 Ftty_type (selected_frame)), Qnil));
6964 Fmodify_frame_parameters (selected_frame, Fcons (Fcons (Qtty, Qnil), Qnil));
6968 struct frame *sf = SELECTED_FRAME ();
6969 int width = FRAME_TOTAL_COLS (sf);
6970 int height = FRAME_LINES (sf);
6972 unsigned int total_glyphs = height * (width + 2) * sizeof (struct glyph);
6974 /* If these sizes are so big they cause overflow, just ignore the
6975 change. It's not clear what better we could do. */
6976 if (total_glyphs / sizeof (struct glyph) / height != width + 2)
6977 fatal ("screen size %dx%d too big", width, height);
6980 adjust_frame_glyphs_initially ();
6981 calculate_costs (XFRAME (selected_frame));
6983 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6984 if (initialized
6985 && !noninteractive
6986 #ifdef MSDOS
6987 /* The MSDOS terminal turns on its ``window system'' relatively
6988 late into the startup, so we cannot do the frame faces'
6989 initialization just yet. It will be done later by pc-win.el
6990 and internal_terminal_init. */
6991 && (strcmp (terminal_type, "internal") != 0 || inhibit_window_system)
6992 #endif
6993 && NILP (Vinitial_window_system))
6995 /* For the initial frame, we don't have any way of knowing what
6996 are the foreground and background colors of the terminal. */
6997 struct frame *sf = SELECTED_FRAME();
6999 FRAME_FOREGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_FG_COLOR;
7000 FRAME_BACKGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_BG_COLOR;
7001 call0 (intern ("tty-set-up-initial-frame-faces"));
7007 /***********************************************************************
7008 Blinking cursor
7009 ***********************************************************************/
7011 DEFUN ("internal-show-cursor", Finternal_show_cursor,
7012 Sinternal_show_cursor, 2, 2, 0,
7013 doc: /* Set the cursor-visibility flag of WINDOW to SHOW.
7014 WINDOW nil means use the selected window. SHOW non-nil means
7015 show a cursor in WINDOW in the next redisplay. SHOW nil means
7016 don't show a cursor. */)
7017 (window, show)
7018 Lisp_Object window, show;
7020 /* Don't change cursor state while redisplaying. This could confuse
7021 output routines. */
7022 if (!redisplaying_p)
7024 if (NILP (window))
7025 window = selected_window;
7026 else
7027 CHECK_WINDOW (window);
7029 XWINDOW (window)->cursor_off_p = NILP (show);
7032 return Qnil;
7036 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p,
7037 Sinternal_show_cursor_p, 0, 1, 0,
7038 doc: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
7039 WINDOW nil or omitted means report on the selected window. */)
7040 (window)
7041 Lisp_Object window;
7043 struct window *w;
7045 if (NILP (window))
7046 window = selected_window;
7047 else
7048 CHECK_WINDOW (window);
7050 w = XWINDOW (window);
7051 return w->cursor_off_p ? Qnil : Qt;
7055 /***********************************************************************
7056 Initialization
7057 ***********************************************************************/
7059 void
7060 syms_of_display ()
7062 defsubr (&Sredraw_frame);
7063 defsubr (&Sredraw_display);
7064 defsubr (&Sframe_or_buffer_changed_p);
7065 defsubr (&Sopen_termscript);
7066 defsubr (&Sding);
7067 defsubr (&Sredisplay);
7068 defsubr (&Ssleep_for);
7069 defsubr (&Ssend_string_to_terminal);
7070 defsubr (&Sinternal_show_cursor);
7071 defsubr (&Sinternal_show_cursor_p);
7073 #if GLYPH_DEBUG
7074 defsubr (&Sdump_redisplay_history);
7075 #endif
7077 frame_and_buffer_state = Fmake_vector (make_number (20), Qlambda);
7078 staticpro (&frame_and_buffer_state);
7080 Qdisplay_table = intern ("display-table");
7081 staticpro (&Qdisplay_table);
7082 Qredisplay_dont_pause = intern ("redisplay-dont-pause");
7083 staticpro (&Qredisplay_dont_pause);
7085 DEFVAR_INT ("baud-rate", &baud_rate,
7086 doc: /* *The output baud rate of the terminal.
7087 On most systems, changing this value will affect the amount of padding
7088 and the other strategic decisions made during redisplay. */);
7090 DEFVAR_BOOL ("inverse-video", &inverse_video,
7091 doc: /* *Non-nil means invert the entire frame display.
7092 This means everything is in inverse video which otherwise would not be. */);
7094 DEFVAR_BOOL ("visible-bell", &visible_bell,
7095 doc: /* *Non-nil means try to flash the frame to represent a bell.
7097 See also `ring-bell-function'. */);
7099 DEFVAR_BOOL ("no-redraw-on-reenter", &no_redraw_on_reenter,
7100 doc: /* *Non-nil means no need to redraw entire frame after suspending.
7101 A non-nil value is useful if the terminal can automatically preserve
7102 Emacs's frame display when you reenter Emacs.
7103 It is up to you to set this variable if your terminal can do that. */);
7105 DEFVAR_LISP ("initial-window-system", &Vinitial_window_system,
7106 doc: /* Name of the window system that Emacs uses for the first frame.
7107 The value is a symbol--for instance, `x' for X windows.
7108 The value is nil if Emacs is using a text-only terminal. */);
7110 DEFVAR_KBOARD ("window-system", Vwindow_system,
7111 doc: /* Name of window system through which the selected frame is displayed.
7112 The value is a symbol--for instance, `x' for X windows.
7113 The value is nil if the selected frame is on a text-only-terminal. */);
7115 DEFVAR_LISP ("window-system-version", &Vwindow_system_version,
7116 doc: /* The version number of the window system in use.
7117 For X windows, this is 11. */);
7119 DEFVAR_BOOL ("cursor-in-echo-area", &cursor_in_echo_area,
7120 doc: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
7122 DEFVAR_LISP ("glyph-table", &Vglyph_table,
7123 doc: /* Table defining how to output a glyph code to the frame.
7124 If not nil, this is a vector indexed by glyph code to define the glyph.
7125 Each element can be:
7126 integer: a glyph code which this glyph is an alias for.
7127 string: output this glyph using that string (not impl. in X windows).
7128 nil: this glyph mod 524288 is the code of a character to output,
7129 and this glyph / 524288 is the face number (see `face-id') to use
7130 while outputting it. */);
7131 Vglyph_table = Qnil;
7133 DEFVAR_LISP ("standard-display-table", &Vstandard_display_table,
7134 doc: /* Display table to use for buffers that specify none.
7135 See `buffer-display-table' for more information. */);
7136 Vstandard_display_table = Qnil;
7138 DEFVAR_BOOL ("redisplay-dont-pause", &redisplay_dont_pause,
7139 doc: /* *Non-nil means update isn't paused when input is detected. */);
7140 redisplay_dont_pause = 0;
7142 #if PERIODIC_PREEMPTION_CHECKING
7143 DEFVAR_LISP ("redisplay-preemption-period", &Vredisplay_preemption_period,
7144 doc: /* *The period in seconds between checking for input during redisplay.
7145 If input is detected, redisplay is pre-empted, and the input is processed.
7146 If nil, never pre-empt redisplay. */);
7147 Vredisplay_preemption_period = make_float (0.10);
7148 #endif
7150 #ifdef CANNOT_DUMP
7151 if (noninteractive)
7152 #endif
7154 Vinitial_window_system = Qnil;
7155 Vwindow_system_version = Qnil;
7159 /* arch-tag: 8d812b1f-04a2-4195-a9c4-381f8457a413
7160 (do not change this comment) */