Mention `redisplay-dont-pause' in doc string of
[emacs.git] / src / dispnew.c
blobcbe0e3fb52170f71cbcc882cfe563500f3f8e9e2
1 /* Updating of data structures for redisplay.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995,
3 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 2004, 2005, 2006 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 #include <config.h>
24 #include <signal.h>
25 #include <stdio.h>
26 #include <ctype.h>
28 #ifdef HAVE_UNISTD_H
29 #include <unistd.h>
30 #endif
32 #include "lisp.h"
33 #include "termchar.h"
34 #include "termopts.h"
35 #include "termhooks.h"
36 /* cm.h must come after dispextern.h on Windows. */
37 #include "dispextern.h"
38 #include "cm.h"
39 #include "buffer.h"
40 #include "charset.h"
41 #include "keyboard.h"
42 #include "frame.h"
43 #include "window.h"
44 #include "commands.h"
45 #include "disptab.h"
46 #include "indent.h"
47 #include "intervals.h"
48 #include "blockinput.h"
49 #include "process.h"
51 /* I don't know why DEC Alpha OSF1 fail to compile this file if we
52 include the following file. */
53 /* #include "systty.h" */
54 #include "syssignal.h"
56 #ifdef HAVE_X_WINDOWS
57 #include "xterm.h"
58 #endif /* HAVE_X_WINDOWS */
60 #ifdef HAVE_NTGUI
61 #include "w32term.h"
62 #endif /* HAVE_NTGUI */
64 #ifdef MAC_OS
65 #include "macterm.h"
66 #endif /* MAC_OS */
68 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
70 #include "systime.h"
71 #include <errno.h>
73 /* To get the prototype for `sleep'. */
75 #ifdef HAVE_UNISTD_H
76 #include <unistd.h>
77 #endif
79 /* Get number of chars of output now in the buffer of a stdio stream.
80 This ought to be built in in stdio, but it isn't. Some s- files
81 override this because their stdio internals differ. */
83 #ifdef __GNU_LIBRARY__
85 /* The s- file might have overridden the definition with one that
86 works for the system's C library. But we are using the GNU C
87 library, so this is the right definition for every system. */
89 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
90 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
91 #else
92 #undef PENDING_OUTPUT_COUNT
93 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
94 #endif
95 #else /* not __GNU_LIBRARY__ */
96 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
97 #include <stdio_ext.h>
98 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
99 #endif
100 #ifndef PENDING_OUTPUT_COUNT
101 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
102 #endif
103 #endif /* not __GNU_LIBRARY__ */
105 #if defined(HAVE_TERM_H) && defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
106 #include <term.h> /* for tgetent */
107 #endif
109 /* Structure to pass dimensions around. Used for character bounding
110 boxes, glyph matrix dimensions and alike. */
112 struct dim
114 int width;
115 int height;
119 /* Function prototypes. */
121 static struct glyph_matrix *save_current_matrix P_ ((struct frame *));
122 static void restore_current_matrix P_ ((struct frame *, struct glyph_matrix *));
123 static void fake_current_matrices P_ ((Lisp_Object));
124 static void redraw_overlapping_rows P_ ((struct window *, int));
125 static void redraw_overlapped_rows P_ ((struct window *, int));
126 static int count_blanks P_ ((struct glyph *, int));
127 static int count_match P_ ((struct glyph *, struct glyph *,
128 struct glyph *, struct glyph *));
129 static unsigned line_draw_cost P_ ((struct glyph_matrix *, int));
130 static void update_frame_line P_ ((struct frame *, int));
131 static struct dim allocate_matrices_for_frame_redisplay
132 P_ ((Lisp_Object, int, int, int, int *));
133 static void allocate_matrices_for_window_redisplay P_ ((struct window *));
134 static int realloc_glyph_pool P_ ((struct glyph_pool *, struct dim));
135 static void adjust_frame_glyphs P_ ((struct frame *));
136 struct glyph_matrix *new_glyph_matrix P_ ((struct glyph_pool *));
137 static void free_glyph_matrix P_ ((struct glyph_matrix *));
138 static void adjust_glyph_matrix P_ ((struct window *, struct glyph_matrix *,
139 int, int, struct dim));
140 static void change_frame_size_1 P_ ((struct frame *, int, int, int, int, int));
141 static void swap_glyph_pointers P_ ((struct glyph_row *, struct glyph_row *));
142 #if GLYPH_DEBUG
143 static int glyph_row_slice_p P_ ((struct glyph_row *, struct glyph_row *));
144 #endif
145 static void fill_up_frame_row_with_spaces P_ ((struct glyph_row *, int));
146 static void build_frame_matrix_from_window_tree P_ ((struct glyph_matrix *,
147 struct window *));
148 static void build_frame_matrix_from_leaf_window P_ ((struct glyph_matrix *,
149 struct window *));
150 static struct glyph_pool *new_glyph_pool P_ ((void));
151 static void free_glyph_pool P_ ((struct glyph_pool *));
152 static void adjust_frame_glyphs_initially P_ ((void));
153 static void adjust_frame_message_buffer P_ ((struct frame *));
154 static void adjust_decode_mode_spec_buffer P_ ((struct frame *));
155 static void fill_up_glyph_row_with_spaces P_ ((struct glyph_row *));
156 static void build_frame_matrix P_ ((struct frame *));
157 void clear_current_matrices P_ ((struct frame *));
158 void scroll_glyph_matrix_range P_ ((struct glyph_matrix *, int, int,
159 int, int));
160 static void clear_window_matrices P_ ((struct window *, int));
161 static void fill_up_glyph_row_area_with_spaces P_ ((struct glyph_row *, int));
162 static int scrolling_window P_ ((struct window *, int));
163 static int update_window_line P_ ((struct window *, int, int *));
164 static void update_marginal_area P_ ((struct window *, int, int));
165 static int update_text_area P_ ((struct window *, int));
166 static void make_current P_ ((struct glyph_matrix *, struct glyph_matrix *,
167 int));
168 static void mirror_make_current P_ ((struct window *, int));
169 void check_window_matrix_pointers P_ ((struct window *));
170 #if GLYPH_DEBUG
171 static void check_matrix_pointers P_ ((struct glyph_matrix *,
172 struct glyph_matrix *));
173 #endif
174 static void mirror_line_dance P_ ((struct window *, int, int, int *, char *));
175 static int update_window_tree P_ ((struct window *, int));
176 static int update_window P_ ((struct window *, int));
177 static int update_frame_1 P_ ((struct frame *, int, int));
178 static void set_window_cursor_after_update P_ ((struct window *));
179 static int row_equal_p P_ ((struct window *, struct glyph_row *,
180 struct glyph_row *, int));
181 static void adjust_frame_glyphs_for_window_redisplay P_ ((struct frame *));
182 static void adjust_frame_glyphs_for_frame_redisplay P_ ((struct frame *));
183 static void reverse_rows P_ ((struct glyph_matrix *, int, int));
184 static int margin_glyphs_to_reserve P_ ((struct window *, int, Lisp_Object));
185 static void sync_window_with_frame_matrix_rows P_ ((struct window *));
186 struct window *frame_row_to_window P_ ((struct window *, int));
189 /* Non-zero means don't pause redisplay for pending input. (This is
190 for debugging and for a future implementation of EDT-like
191 scrolling. */
193 int redisplay_dont_pause;
195 /* Nonzero upon entry to redisplay means do not assume anything about
196 current contents of actual terminal frame; clear and redraw it. */
198 int frame_garbaged;
200 /* Nonzero means last display completed. Zero means it was preempted. */
202 int display_completed;
204 /* Lisp variable visible-bell; enables use of screen-flash instead of
205 audible bell. */
207 int visible_bell;
209 /* Invert the color of the whole frame, at a low level. */
211 int inverse_video;
213 /* Line speed of the terminal. */
215 EMACS_INT baud_rate;
217 /* Either nil or a symbol naming the window system under which Emacs
218 is running. */
220 Lisp_Object Vwindow_system;
222 /* Version number of X windows: 10, 11 or nil. */
224 Lisp_Object Vwindow_system_version;
226 /* Vector of glyph definitions. Indexed by glyph number, the contents
227 are a string which is how to output the glyph.
229 If Vglyph_table is nil, a glyph is output by using its low 8 bits
230 as a character code.
232 This is an obsolete feature that is no longer used. The variable
233 is retained for compatibility. */
235 Lisp_Object Vglyph_table;
237 /* Display table to use for vectors that don't specify their own. */
239 Lisp_Object Vstandard_display_table;
241 /* Nonzero means reading single-character input with prompt so put
242 cursor on mini-buffer after the prompt. Positive means at end of
243 text in echo area; negative means at beginning of line. */
245 int cursor_in_echo_area;
247 Lisp_Object Qdisplay_table, Qredisplay_dont_pause;
250 /* The currently selected frame. In a single-frame version, this
251 variable always equals the_only_frame. */
253 Lisp_Object selected_frame;
255 /* A frame which is not just a mini-buffer, or 0 if there are no such
256 frames. This is usually the most recent such frame that was
257 selected. In a single-frame version, this variable always holds
258 the address of the_only_frame. */
260 struct frame *last_nonminibuf_frame;
262 /* Stdio stream being used for copy of all output. */
264 FILE *termscript;
266 /* Structure for info on cursor positioning. */
268 struct cm Wcm;
270 /* 1 means SIGWINCH happened when not safe. */
272 int delayed_size_change;
274 /* 1 means glyph initialization has been completed at startup. */
276 static int glyphs_initialized_initially_p;
278 /* Updated window if != 0. Set by update_window. */
280 struct window *updated_window;
282 /* Glyph row updated in update_window_line, and area that is updated. */
284 struct glyph_row *updated_row;
285 int updated_area;
287 /* A glyph for a space. */
289 struct glyph space_glyph;
291 /* Non-zero means update has been performed directly, so that there's
292 no need for redisplay_internal to do much work. Set by
293 direct_output_for_insert. */
295 int redisplay_performed_directly_p;
297 /* Counts of allocated structures. These counts serve to diagnose
298 memory leaks and double frees. */
300 int glyph_matrix_count;
301 int glyph_pool_count;
303 /* If non-null, the frame whose frame matrices are manipulated. If
304 null, window matrices are worked on. */
306 static struct frame *frame_matrix_frame;
308 /* Current interface for window-based redisplay. Set from init_xterm.
309 A null value means we are not using window-based redisplay. */
311 struct redisplay_interface *rif;
313 /* Non-zero means that fonts have been loaded since the last glyph
314 matrix adjustments. Redisplay must stop, and glyph matrices must
315 be adjusted when this flag becomes non-zero during display. The
316 reason fonts can be loaded so late is that fonts of fontsets are
317 loaded on demand. */
319 int fonts_changed_p;
321 /* Convert vpos and hpos from frame to window and vice versa.
322 This may only be used for terminal frames. */
324 #if GLYPH_DEBUG
326 static int window_to_frame_vpos P_ ((struct window *, int));
327 static int window_to_frame_hpos P_ ((struct window *, int));
328 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
329 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
331 /* One element of the ring buffer containing redisplay history
332 information. */
334 struct redisplay_history
336 char trace[512 + 100];
339 /* The size of the history buffer. */
341 #define REDISPLAY_HISTORY_SIZE 30
343 /* The redisplay history buffer. */
345 static struct redisplay_history redisplay_history[REDISPLAY_HISTORY_SIZE];
347 /* Next free entry in redisplay_history. */
349 static int history_idx;
351 /* A tick that's incremented each time something is added to the
352 history. */
354 static unsigned history_tick;
356 static void add_frame_display_history P_ ((struct frame *, int));
357 static void add_window_display_history P_ ((struct window *, char *, int));
359 /* Add to the redisplay history how window W has been displayed.
360 MSG is a trace containing the information how W's glyph matrix
361 has been constructed. PAUSED_P non-zero means that the update
362 has been interrupted for pending input. */
364 static void
365 add_window_display_history (w, msg, paused_p)
366 struct window *w;
367 char *msg;
368 int paused_p;
370 char *buf;
372 if (history_idx >= REDISPLAY_HISTORY_SIZE)
373 history_idx = 0;
374 buf = redisplay_history[history_idx].trace;
375 ++history_idx;
377 sprintf (buf, "%d: window %p (`%s')%s\n",
378 history_tick++,
380 ((BUFFERP (w->buffer)
381 && STRINGP (XBUFFER (w->buffer)->name))
382 ? (char *) SDATA (XBUFFER (w->buffer)->name)
383 : "???"),
384 paused_p ? " ***paused***" : "");
385 strcat (buf, msg);
389 /* Add to the redisplay history that frame F has been displayed.
390 PAUSED_P non-zero means that the update has been interrupted for
391 pending input. */
393 static void
394 add_frame_display_history (f, paused_p)
395 struct frame *f;
396 int paused_p;
398 char *buf;
400 if (history_idx >= REDISPLAY_HISTORY_SIZE)
401 history_idx = 0;
402 buf = redisplay_history[history_idx].trace;
403 ++history_idx;
405 sprintf (buf, "%d: update frame %p%s",
406 history_tick++,
407 f, paused_p ? " ***paused***" : "");
411 DEFUN ("dump-redisplay-history", Fdump_redisplay_history,
412 Sdump_redisplay_history, 0, 0, "",
413 doc: /* Dump redisplay history to stderr. */)
416 int i;
418 for (i = history_idx - 1; i != history_idx; --i)
420 if (i < 0)
421 i = REDISPLAY_HISTORY_SIZE - 1;
422 fprintf (stderr, "%s\n", redisplay_history[i].trace);
425 return Qnil;
429 #else /* GLYPH_DEBUG == 0 */
431 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
432 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
434 #endif /* GLYPH_DEBUG == 0 */
437 /* Like bcopy except never gets confused by overlap. Let this be the
438 first function defined in this file, or change emacs.c where the
439 address of this function is used. */
441 void
442 safe_bcopy (from, to, size)
443 const char *from;
444 char *to;
445 int size;
447 if (size <= 0 || from == to)
448 return;
450 /* If the source and destination don't overlap, then bcopy can
451 handle it. If they do overlap, but the destination is lower in
452 memory than the source, we'll assume bcopy can handle that. */
453 if (to < from || from + size <= to)
454 bcopy (from, to, size);
456 /* Otherwise, we'll copy from the end. */
457 else
459 register const char *endf = from + size;
460 register char *endt = to + size;
462 /* If TO - FROM is large, then we should break the copy into
463 nonoverlapping chunks of TO - FROM bytes each. However, if
464 TO - FROM is small, then the bcopy function call overhead
465 makes this not worth it. The crossover point could be about
466 anywhere. Since I don't think the obvious copy loop is too
467 bad, I'm trying to err in its favor. */
468 if (to - from < 64)
471 *--endt = *--endf;
472 while (endf != from);
474 else
476 for (;;)
478 endt -= (to - from);
479 endf -= (to - from);
481 if (endt < to)
482 break;
484 bcopy (endf, endt, to - from);
487 /* If SIZE wasn't a multiple of TO - FROM, there will be a
488 little left over. The amount left over is (endt + (to -
489 from)) - to, which is endt - from. */
490 bcopy (from, to, endt - from);
497 /***********************************************************************
498 Glyph Matrices
499 ***********************************************************************/
501 /* Allocate and return a glyph_matrix structure. POOL is the glyph
502 pool from which memory for the matrix should be allocated, or null
503 for window-based redisplay where no glyph pools are used. The
504 member `pool' of the glyph matrix structure returned is set to
505 POOL, the structure is otherwise zeroed. */
507 struct glyph_matrix *
508 new_glyph_matrix (pool)
509 struct glyph_pool *pool;
511 struct glyph_matrix *result;
513 /* Allocate and clear. */
514 result = (struct glyph_matrix *) xmalloc (sizeof *result);
515 bzero (result, sizeof *result);
517 /* Increment number of allocated matrices. This count is used
518 to detect memory leaks. */
519 ++glyph_matrix_count;
521 /* Set pool and return. */
522 result->pool = pool;
523 return result;
527 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
529 The global counter glyph_matrix_count is decremented when a matrix
530 is freed. If the count gets negative, more structures were freed
531 than allocated, i.e. one matrix was freed more than once or a bogus
532 pointer was passed to this function.
534 If MATRIX->pool is null, this means that the matrix manages its own
535 glyph memory---this is done for matrices on X frames. Freeing the
536 matrix also frees the glyph memory in this case. */
538 static void
539 free_glyph_matrix (matrix)
540 struct glyph_matrix *matrix;
542 if (matrix)
544 int i;
546 /* Detect the case that more matrices are freed than were
547 allocated. */
548 if (--glyph_matrix_count < 0)
549 abort ();
551 /* Free glyph memory if MATRIX owns it. */
552 if (matrix->pool == NULL)
553 for (i = 0; i < matrix->rows_allocated; ++i)
554 xfree (matrix->rows[i].glyphs[LEFT_MARGIN_AREA]);
556 /* Free row structures and the matrix itself. */
557 xfree (matrix->rows);
558 xfree (matrix);
563 /* Return the number of glyphs to reserve for a marginal area of
564 window W. TOTAL_GLYPHS is the number of glyphs in a complete
565 display line of window W. MARGIN gives the width of the marginal
566 area in canonical character units. MARGIN should be an integer
567 or a float. */
569 static int
570 margin_glyphs_to_reserve (w, total_glyphs, margin)
571 struct window *w;
572 int total_glyphs;
573 Lisp_Object margin;
575 int n;
577 if (NUMBERP (margin))
579 int width = XFASTINT (w->total_cols);
580 double d = max (0, XFLOATINT (margin));
581 d = min (width / 2 - 1, d);
582 n = (int) ((double) total_glyphs / width * d);
584 else
585 n = 0;
587 return n;
591 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
592 window sizes.
594 W is null if the function is called for a frame glyph matrix.
595 Otherwise it is the window MATRIX is a member of. X and Y are the
596 indices of the first column and row of MATRIX within the frame
597 matrix, if such a matrix exists. They are zero for purely
598 window-based redisplay. DIM is the needed size of the matrix.
600 In window-based redisplay, where no frame matrices exist, glyph
601 matrices manage their own glyph storage. Otherwise, they allocate
602 storage from a common frame glyph pool which can be found in
603 MATRIX->pool.
605 The reason for this memory management strategy is to avoid complete
606 frame redraws if possible. When we allocate from a common pool, a
607 change of the location or size of a sub-matrix within the pool
608 requires a complete redisplay of the frame because we cannot easily
609 make sure that the current matrices of all windows still agree with
610 what is displayed on the screen. While this is usually fast, it
611 leads to screen flickering. */
613 static void
614 adjust_glyph_matrix (w, matrix, x, y, dim)
615 struct window *w;
616 struct glyph_matrix *matrix;
617 int x, y;
618 struct dim dim;
620 int i;
621 int new_rows;
622 int marginal_areas_changed_p = 0;
623 int header_line_changed_p = 0;
624 int header_line_p = 0;
625 int left = -1, right = -1;
626 int window_width = -1, window_height;
628 /* See if W had a header line that has disappeared now, or vice versa.
629 Get W's size. */
630 if (w)
632 window_box (w, -1, 0, 0, &window_width, &window_height);
634 header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
635 header_line_changed_p = header_line_p != matrix->header_line_p;
637 matrix->header_line_p = header_line_p;
639 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
640 Do nothing if MATRIX' size, position, vscroll, and marginal areas
641 haven't changed. This optimization is important because preserving
642 the matrix means preventing redisplay. */
643 if (matrix->pool == NULL)
645 left = margin_glyphs_to_reserve (w, dim.width, w->left_margin_cols);
646 right = margin_glyphs_to_reserve (w, dim.width, w->right_margin_cols);
647 xassert (left >= 0 && right >= 0);
648 marginal_areas_changed_p = (left != matrix->left_margin_glyphs
649 || right != matrix->right_margin_glyphs);
651 if (!marginal_areas_changed_p
652 && !fonts_changed_p
653 && !header_line_changed_p
654 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
655 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
656 && matrix->window_height == window_height
657 && matrix->window_vscroll == w->vscroll
658 && matrix->window_width == window_width)
659 return;
662 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
663 if (matrix->rows_allocated < dim.height)
665 int size = dim.height * sizeof (struct glyph_row);
666 new_rows = dim.height - matrix->rows_allocated;
667 matrix->rows = (struct glyph_row *) xrealloc (matrix->rows, size);
668 bzero (matrix->rows + matrix->rows_allocated,
669 new_rows * sizeof *matrix->rows);
670 matrix->rows_allocated = dim.height;
672 else
673 new_rows = 0;
675 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
676 on a frame not using window-based redisplay. Set up pointers for
677 each row into the glyph pool. */
678 if (matrix->pool)
680 xassert (matrix->pool->glyphs);
682 if (w)
684 left = margin_glyphs_to_reserve (w, dim.width,
685 w->left_margin_cols);
686 right = margin_glyphs_to_reserve (w, dim.width,
687 w->right_margin_cols);
689 else
690 left = right = 0;
692 for (i = 0; i < dim.height; ++i)
694 struct glyph_row *row = &matrix->rows[i];
696 row->glyphs[LEFT_MARGIN_AREA]
697 = (matrix->pool->glyphs
698 + (y + i) * matrix->pool->ncolumns
699 + x);
701 if (w == NULL
702 || row == matrix->rows + dim.height - 1
703 || (row == matrix->rows && matrix->header_line_p))
705 row->glyphs[TEXT_AREA]
706 = row->glyphs[LEFT_MARGIN_AREA];
707 row->glyphs[RIGHT_MARGIN_AREA]
708 = row->glyphs[TEXT_AREA] + dim.width;
709 row->glyphs[LAST_AREA]
710 = row->glyphs[RIGHT_MARGIN_AREA];
712 else
714 row->glyphs[TEXT_AREA]
715 = row->glyphs[LEFT_MARGIN_AREA] + left;
716 row->glyphs[RIGHT_MARGIN_AREA]
717 = row->glyphs[TEXT_AREA] + dim.width - left - right;
718 row->glyphs[LAST_AREA]
719 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
723 matrix->left_margin_glyphs = left;
724 matrix->right_margin_glyphs = right;
726 else
728 /* If MATRIX->pool is null, MATRIX is responsible for managing
729 its own memory. It is a window matrix for window-based redisplay.
730 Allocate glyph memory from the heap. */
731 if (dim.width > matrix->matrix_w
732 || new_rows
733 || header_line_changed_p
734 || marginal_areas_changed_p)
736 struct glyph_row *row = matrix->rows;
737 struct glyph_row *end = row + matrix->rows_allocated;
739 while (row < end)
741 row->glyphs[LEFT_MARGIN_AREA]
742 = (struct glyph *) xrealloc (row->glyphs[LEFT_MARGIN_AREA],
743 (dim.width
744 * sizeof (struct glyph)));
746 /* The mode line never has marginal areas. */
747 if (row == matrix->rows + dim.height - 1
748 || (row == matrix->rows && matrix->header_line_p))
750 row->glyphs[TEXT_AREA]
751 = row->glyphs[LEFT_MARGIN_AREA];
752 row->glyphs[RIGHT_MARGIN_AREA]
753 = row->glyphs[TEXT_AREA] + dim.width;
754 row->glyphs[LAST_AREA]
755 = row->glyphs[RIGHT_MARGIN_AREA];
757 else
759 row->glyphs[TEXT_AREA]
760 = row->glyphs[LEFT_MARGIN_AREA] + left;
761 row->glyphs[RIGHT_MARGIN_AREA]
762 = row->glyphs[TEXT_AREA] + dim.width - left - right;
763 row->glyphs[LAST_AREA]
764 = row->glyphs[LEFT_MARGIN_AREA] + dim.width;
766 ++row;
770 xassert (left >= 0 && right >= 0);
771 matrix->left_margin_glyphs = left;
772 matrix->right_margin_glyphs = right;
775 /* Number of rows to be used by MATRIX. */
776 matrix->nrows = dim.height;
777 xassert (matrix->nrows >= 0);
779 if (w)
781 if (matrix == w->current_matrix)
783 /* Mark rows in a current matrix of a window as not having
784 valid contents. It's important to not do this for
785 desired matrices. When Emacs starts, it may already be
786 building desired matrices when this function runs. */
787 if (window_width < 0)
788 window_width = window_box_width (w, -1);
790 /* Optimize the case that only the height has changed (C-x 2,
791 upper window). Invalidate all rows that are no longer part
792 of the window. */
793 if (!marginal_areas_changed_p
794 && !header_line_changed_p
795 && new_rows == 0
796 && dim.width == matrix->matrix_w
797 && matrix->window_left_col == WINDOW_LEFT_EDGE_COL (w)
798 && matrix->window_top_line == WINDOW_TOP_EDGE_LINE (w)
799 && matrix->window_width == window_width)
801 /* Find the last row in the window. */
802 for (i = 0; i < matrix->nrows && matrix->rows[i].enabled_p; ++i)
803 if (MATRIX_ROW_BOTTOM_Y (matrix->rows + i) >= window_height)
805 ++i;
806 break;
809 /* Window end is invalid, if inside of the rows that
810 are invalidated below. */
811 if (INTEGERP (w->window_end_vpos)
812 && XFASTINT (w->window_end_vpos) >= i)
813 w->window_end_valid = Qnil;
815 while (i < matrix->nrows)
816 matrix->rows[i++].enabled_p = 0;
818 else
820 for (i = 0; i < matrix->nrows; ++i)
821 matrix->rows[i].enabled_p = 0;
824 else if (matrix == w->desired_matrix)
826 /* Rows in desired matrices always have to be cleared;
827 redisplay expects this is the case when it runs, so it
828 had better be the case when we adjust matrices between
829 redisplays. */
830 for (i = 0; i < matrix->nrows; ++i)
831 matrix->rows[i].enabled_p = 0;
836 /* Remember last values to be able to optimize frame redraws. */
837 matrix->matrix_x = x;
838 matrix->matrix_y = y;
839 matrix->matrix_w = dim.width;
840 matrix->matrix_h = dim.height;
842 /* Record the top y location and height of W at the time the matrix
843 was last adjusted. This is used to optimize redisplay above. */
844 if (w)
846 matrix->window_left_col = WINDOW_LEFT_EDGE_COL (w);
847 matrix->window_top_line = WINDOW_TOP_EDGE_LINE (w);
848 matrix->window_height = window_height;
849 matrix->window_width = window_width;
850 matrix->window_vscroll = w->vscroll;
855 /* Reverse the contents of rows in MATRIX between START and END. The
856 contents of the row at END - 1 end up at START, END - 2 at START +
857 1 etc. This is part of the implementation of rotate_matrix (see
858 below). */
860 static void
861 reverse_rows (matrix, start, end)
862 struct glyph_matrix *matrix;
863 int start, end;
865 int i, j;
867 for (i = start, j = end - 1; i < j; ++i, --j)
869 /* Non-ISO HP/UX compiler doesn't like auto struct
870 initialization. */
871 struct glyph_row temp;
872 temp = matrix->rows[i];
873 matrix->rows[i] = matrix->rows[j];
874 matrix->rows[j] = temp;
879 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
880 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
881 indices. (Note: this does not copy glyphs, only glyph pointers in
882 row structures are moved around).
884 The algorithm used for rotating the vector was, I believe, first
885 described by Kernighan. See the vector R as consisting of two
886 sub-vectors AB, where A has length BY for BY >= 0. The result
887 after rotating is then BA. Reverse both sub-vectors to get ArBr
888 and reverse the result to get (ArBr)r which is BA. Similar for
889 rotating right. */
891 void
892 rotate_matrix (matrix, first, last, by)
893 struct glyph_matrix *matrix;
894 int first, last, by;
896 if (by < 0)
898 /* Up (rotate left, i.e. towards lower indices). */
899 by = -by;
900 reverse_rows (matrix, first, first + by);
901 reverse_rows (matrix, first + by, last);
902 reverse_rows (matrix, first, last);
904 else if (by > 0)
906 /* Down (rotate right, i.e. towards higher indices). */
907 reverse_rows (matrix, last - by, last);
908 reverse_rows (matrix, first, last - by);
909 reverse_rows (matrix, first, last);
914 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
915 with indices START <= index < END. Increment positions by DELTA/
916 DELTA_BYTES. */
918 void
919 increment_matrix_positions (matrix, start, end, delta, delta_bytes)
920 struct glyph_matrix *matrix;
921 int start, end, delta, delta_bytes;
923 /* Check that START and END are reasonable values. */
924 xassert (start >= 0 && start <= matrix->nrows);
925 xassert (end >= 0 && end <= matrix->nrows);
926 xassert (start <= end);
928 for (; start < end; ++start)
929 increment_row_positions (matrix->rows + start, delta, delta_bytes);
933 /* Enable a range of rows in glyph matrix MATRIX. START and END are
934 the row indices of the first and last + 1 row to enable. If
935 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
937 void
938 enable_glyph_matrix_rows (matrix, start, end, enabled_p)
939 struct glyph_matrix *matrix;
940 int start, end;
941 int enabled_p;
943 xassert (start <= end);
944 xassert (start >= 0 && start < matrix->nrows);
945 xassert (end >= 0 && end <= matrix->nrows);
947 for (; start < end; ++start)
948 matrix->rows[start].enabled_p = enabled_p != 0;
952 /* Clear MATRIX.
954 This empties all rows in MATRIX by setting the enabled_p flag for
955 all rows of the matrix to zero. The function prepare_desired_row
956 will eventually really clear a row when it sees one with a zero
957 enabled_p flag.
959 Resets update hints to defaults value. The only update hint
960 currently present is the flag MATRIX->no_scrolling_p. */
962 void
963 clear_glyph_matrix (matrix)
964 struct glyph_matrix *matrix;
966 if (matrix)
968 enable_glyph_matrix_rows (matrix, 0, matrix->nrows, 0);
969 matrix->no_scrolling_p = 0;
974 /* Shift part of the glyph matrix MATRIX of window W up or down.
975 Increment y-positions in glyph rows between START and END by DY,
976 and recompute their visible height. */
978 void
979 shift_glyph_matrix (w, matrix, start, end, dy)
980 struct window *w;
981 struct glyph_matrix *matrix;
982 int start, end, dy;
984 int min_y, max_y;
986 xassert (start <= end);
987 xassert (start >= 0 && start < matrix->nrows);
988 xassert (end >= 0 && end <= matrix->nrows);
990 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
991 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
993 for (; start < end; ++start)
995 struct glyph_row *row = &matrix->rows[start];
997 row->y += dy;
998 row->visible_height = row->height;
1000 if (row->y < min_y)
1001 row->visible_height -= min_y - row->y;
1002 if (row->y + row->height > max_y)
1003 row->visible_height -= row->y + row->height - max_y;
1008 /* Mark all rows in current matrices of frame F as invalid. Marking
1009 invalid is done by setting enabled_p to zero for all rows in a
1010 current matrix. */
1012 void
1013 clear_current_matrices (f)
1014 register struct frame *f;
1016 /* Clear frame current matrix, if we have one. */
1017 if (f->current_matrix)
1018 clear_glyph_matrix (f->current_matrix);
1020 /* Clear the matrix of the menu bar window, if such a window exists.
1021 The menu bar window is currently used to display menus on X when
1022 no toolkit support is compiled in. */
1023 if (WINDOWP (f->menu_bar_window))
1024 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->current_matrix);
1026 /* Clear the matrix of the tool-bar window, if any. */
1027 if (WINDOWP (f->tool_bar_window))
1028 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1030 /* Clear current window matrices. */
1031 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1032 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 0);
1036 /* Clear out all display lines of F for a coming redisplay. */
1038 void
1039 clear_desired_matrices (f)
1040 register struct frame *f;
1042 if (f->desired_matrix)
1043 clear_glyph_matrix (f->desired_matrix);
1045 if (WINDOWP (f->menu_bar_window))
1046 clear_glyph_matrix (XWINDOW (f->menu_bar_window)->desired_matrix);
1048 if (WINDOWP (f->tool_bar_window))
1049 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->desired_matrix);
1051 /* Do it for window matrices. */
1052 xassert (WINDOWP (FRAME_ROOT_WINDOW (f)));
1053 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
1057 /* Clear matrices in window tree rooted in W. If DESIRED_P is
1058 non-zero clear desired matrices, otherwise clear current matrices. */
1060 static void
1061 clear_window_matrices (w, desired_p)
1062 struct window *w;
1063 int desired_p;
1065 while (w)
1067 if (!NILP (w->hchild))
1069 xassert (WINDOWP (w->hchild));
1070 clear_window_matrices (XWINDOW (w->hchild), desired_p);
1072 else if (!NILP (w->vchild))
1074 xassert (WINDOWP (w->vchild));
1075 clear_window_matrices (XWINDOW (w->vchild), desired_p);
1077 else
1079 if (desired_p)
1080 clear_glyph_matrix (w->desired_matrix);
1081 else
1083 clear_glyph_matrix (w->current_matrix);
1084 w->window_end_valid = Qnil;
1088 w = NILP (w->next) ? 0 : XWINDOW (w->next);
1094 /***********************************************************************
1095 Glyph Rows
1097 See dispextern.h for an overall explanation of glyph rows.
1098 ***********************************************************************/
1100 /* Clear glyph row ROW. Do it in a way that makes it robust against
1101 changes in the glyph_row structure, i.e. addition or removal of
1102 structure members. */
1104 static struct glyph_row null_row;
1106 void
1107 clear_glyph_row (row)
1108 struct glyph_row *row;
1110 struct glyph *p[1 + LAST_AREA];
1112 /* Save pointers. */
1113 p[LEFT_MARGIN_AREA] = row->glyphs[LEFT_MARGIN_AREA];
1114 p[TEXT_AREA] = row->glyphs[TEXT_AREA];
1115 p[RIGHT_MARGIN_AREA] = row->glyphs[RIGHT_MARGIN_AREA];
1116 p[LAST_AREA] = row->glyphs[LAST_AREA];
1118 /* Clear. */
1119 *row = null_row;
1121 /* Restore pointers. */
1122 row->glyphs[LEFT_MARGIN_AREA] = p[LEFT_MARGIN_AREA];
1123 row->glyphs[TEXT_AREA] = p[TEXT_AREA];
1124 row->glyphs[RIGHT_MARGIN_AREA] = p[RIGHT_MARGIN_AREA];
1125 row->glyphs[LAST_AREA] = p[LAST_AREA];
1127 #if 0 /* At some point, some bit-fields of struct glyph were not set,
1128 which made glyphs unequal when compared with GLYPH_EQUAL_P.
1129 Redisplay outputs such glyphs, and flickering effects were
1130 the result. This also depended on the contents of memory
1131 returned by xmalloc. If flickering happens again, activate
1132 the code below. If the flickering is gone with that, chances
1133 are that the flickering has the same reason as here. */
1134 bzero (p[0], (char *) p[LAST_AREA] - (char *) p[0]);
1135 #endif
1139 /* Make ROW an empty, enabled row of canonical character height,
1140 in window W starting at y-position Y. */
1142 void
1143 blank_row (w, row, y)
1144 struct window *w;
1145 struct glyph_row *row;
1146 int y;
1148 int min_y, max_y;
1150 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
1151 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (w);
1153 clear_glyph_row (row);
1154 row->y = y;
1155 row->ascent = row->phys_ascent = 0;
1156 row->height = row->phys_height = FRAME_LINE_HEIGHT (XFRAME (w->frame));
1157 row->visible_height = row->height;
1159 if (row->y < min_y)
1160 row->visible_height -= min_y - row->y;
1161 if (row->y + row->height > max_y)
1162 row->visible_height -= row->y + row->height - max_y;
1164 row->enabled_p = 1;
1168 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
1169 are the amounts by which to change positions. Note that the first
1170 glyph of the text area of a row can have a buffer position even if
1171 the used count of the text area is zero. Such rows display line
1172 ends. */
1174 void
1175 increment_row_positions (row, delta, delta_bytes)
1176 struct glyph_row *row;
1177 int delta, delta_bytes;
1179 int area, i;
1181 /* Increment start and end positions. */
1182 MATRIX_ROW_START_CHARPOS (row) += delta;
1183 MATRIX_ROW_START_BYTEPOS (row) += delta_bytes;
1184 MATRIX_ROW_END_CHARPOS (row) += delta;
1185 MATRIX_ROW_END_BYTEPOS (row) += delta_bytes;
1187 if (!row->enabled_p)
1188 return;
1190 /* Increment positions in glyphs. */
1191 for (area = 0; area < LAST_AREA; ++area)
1192 for (i = 0; i < row->used[area]; ++i)
1193 if (BUFFERP (row->glyphs[area][i].object)
1194 && row->glyphs[area][i].charpos > 0)
1195 row->glyphs[area][i].charpos += delta;
1197 /* Capture the case of rows displaying a line end. */
1198 if (row->used[TEXT_AREA] == 0
1199 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
1200 row->glyphs[TEXT_AREA]->charpos += delta;
1204 #if 0
1205 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1206 contents, i.e. glyph structure contents are exchanged between A and
1207 B without changing glyph pointers in A and B. */
1209 static void
1210 swap_glyphs_in_rows (a, b)
1211 struct glyph_row *a, *b;
1213 int area;
1215 for (area = 0; area < LAST_AREA; ++area)
1217 /* Number of glyphs to swap. */
1218 int max_used = max (a->used[area], b->used[area]);
1220 /* Start of glyphs in area of row A. */
1221 struct glyph *glyph_a = a->glyphs[area];
1223 /* End + 1 of glyphs in area of row A. */
1224 struct glyph *glyph_a_end = a->glyphs[max_used];
1226 /* Start of glyphs in area of row B. */
1227 struct glyph *glyph_b = b->glyphs[area];
1229 while (glyph_a < glyph_a_end)
1231 /* Non-ISO HP/UX compiler doesn't like auto struct
1232 initialization. */
1233 struct glyph temp;
1234 temp = *glyph_a;
1235 *glyph_a = *glyph_b;
1236 *glyph_b = temp;
1237 ++glyph_a;
1238 ++glyph_b;
1243 #endif /* 0 */
1245 /* Exchange pointers to glyph memory between glyph rows A and B. */
1247 static INLINE void
1248 swap_glyph_pointers (a, b)
1249 struct glyph_row *a, *b;
1251 int i;
1252 for (i = 0; i < LAST_AREA + 1; ++i)
1254 struct glyph *temp = a->glyphs[i];
1255 a->glyphs[i] = b->glyphs[i];
1256 b->glyphs[i] = temp;
1261 /* Copy glyph row structure FROM to glyph row structure TO, except
1262 that glyph pointers in the structures are left unchanged. */
1264 INLINE void
1265 copy_row_except_pointers (to, from)
1266 struct glyph_row *to, *from;
1268 struct glyph *pointers[1 + LAST_AREA];
1270 /* Save glyph pointers of TO. */
1271 bcopy (to->glyphs, pointers, sizeof to->glyphs);
1273 /* Do a structure assignment. */
1274 *to = *from;
1276 /* Restore original pointers of TO. */
1277 bcopy (pointers, to->glyphs, sizeof to->glyphs);
1281 /* Copy contents of glyph row FROM to glyph row TO. Glyph pointers in
1282 TO and FROM are left unchanged. Glyph contents are copied from the
1283 glyph memory of FROM to the glyph memory of TO. Increment buffer
1284 positions in row TO by DELTA/ DELTA_BYTES. */
1286 void
1287 copy_glyph_row_contents (to, from, delta, delta_bytes)
1288 struct glyph_row *to, *from;
1289 int delta, delta_bytes;
1291 int area;
1293 /* This is like a structure assignment TO = FROM, except that
1294 glyph pointers in the rows are left unchanged. */
1295 copy_row_except_pointers (to, from);
1297 /* Copy glyphs from FROM to TO. */
1298 for (area = 0; area < LAST_AREA; ++area)
1299 if (from->used[area])
1300 bcopy (from->glyphs[area], to->glyphs[area],
1301 from->used[area] * sizeof (struct glyph));
1303 /* Increment buffer positions in TO by DELTA. */
1304 increment_row_positions (to, delta, delta_bytes);
1308 /* Assign glyph row FROM to glyph row TO. This works like a structure
1309 assignment TO = FROM, except that glyph pointers are not copied but
1310 exchanged between TO and FROM. Pointers must be exchanged to avoid
1311 a memory leak. */
1313 static INLINE void
1314 assign_row (to, from)
1315 struct glyph_row *to, *from;
1317 swap_glyph_pointers (to, from);
1318 copy_row_except_pointers (to, from);
1322 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1323 a row in a window matrix, is a slice of the glyph memory of the
1324 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1325 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1326 memory of FRAME_ROW. */
1328 #if GLYPH_DEBUG
1330 static int
1331 glyph_row_slice_p (window_row, frame_row)
1332 struct glyph_row *window_row, *frame_row;
1334 struct glyph *window_glyph_start = window_row->glyphs[0];
1335 struct glyph *frame_glyph_start = frame_row->glyphs[0];
1336 struct glyph *frame_glyph_end = frame_row->glyphs[LAST_AREA];
1338 return (frame_glyph_start <= window_glyph_start
1339 && window_glyph_start < frame_glyph_end);
1342 #endif /* GLYPH_DEBUG */
1344 #if 0
1346 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1347 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1348 in WINDOW_MATRIX is found satisfying the condition. */
1350 static struct glyph_row *
1351 find_glyph_row_slice (window_matrix, frame_matrix, row)
1352 struct glyph_matrix *window_matrix, *frame_matrix;
1353 int row;
1355 int i;
1357 xassert (row >= 0 && row < frame_matrix->nrows);
1359 for (i = 0; i < window_matrix->nrows; ++i)
1360 if (glyph_row_slice_p (window_matrix->rows + i,
1361 frame_matrix->rows + row))
1362 break;
1364 return i < window_matrix->nrows ? window_matrix->rows + i : 0;
1367 #endif /* 0 */
1369 /* Prepare ROW for display. Desired rows are cleared lazily,
1370 i.e. they are only marked as to be cleared by setting their
1371 enabled_p flag to zero. When a row is to be displayed, a prior
1372 call to this function really clears it. */
1374 void
1375 prepare_desired_row (row)
1376 struct glyph_row *row;
1378 if (!row->enabled_p)
1380 clear_glyph_row (row);
1381 row->enabled_p = 1;
1386 /* Return a hash code for glyph row ROW. */
1389 line_hash_code (row)
1390 struct glyph_row *row;
1392 int hash = 0;
1394 if (row->enabled_p)
1396 struct glyph *glyph = row->glyphs[TEXT_AREA];
1397 struct glyph *end = glyph + row->used[TEXT_AREA];
1399 while (glyph < end)
1401 int c = glyph->u.ch;
1402 int face_id = glyph->face_id;
1403 if (must_write_spaces)
1404 c -= SPACEGLYPH;
1405 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + c;
1406 hash = (((hash << 4) + (hash >> 24)) & 0x0fffffff) + face_id;
1407 ++glyph;
1410 if (hash == 0)
1411 hash = 1;
1414 return hash;
1418 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1419 the number of characters in the line. If must_write_spaces is
1420 zero, leading and trailing spaces are ignored. */
1422 static unsigned int
1423 line_draw_cost (matrix, vpos)
1424 struct glyph_matrix *matrix;
1425 int vpos;
1427 struct glyph_row *row = matrix->rows + vpos;
1428 struct glyph *beg = row->glyphs[TEXT_AREA];
1429 struct glyph *end = beg + row->used[TEXT_AREA];
1430 int len;
1431 Lisp_Object *glyph_table_base = GLYPH_TABLE_BASE;
1432 int glyph_table_len = GLYPH_TABLE_LENGTH;
1434 /* Ignore trailing and leading spaces if we can. */
1435 if (!must_write_spaces)
1437 /* Skip from the end over trailing spaces. */
1438 while (end > beg && CHAR_GLYPH_SPACE_P (*(end - 1)))
1439 --end;
1441 /* All blank line. */
1442 if (end == beg)
1443 return 0;
1445 /* Skip over leading spaces. */
1446 while (CHAR_GLYPH_SPACE_P (*beg))
1447 ++beg;
1450 /* If we don't have a glyph-table, each glyph is one character,
1451 so return the number of glyphs. */
1452 if (glyph_table_base == 0)
1453 len = end - beg;
1454 else
1456 /* Otherwise, scan the glyphs and accumulate their total length
1457 in LEN. */
1458 len = 0;
1459 while (beg < end)
1461 GLYPH g = GLYPH_FROM_CHAR_GLYPH (*beg);
1463 if (g < 0
1464 || GLYPH_SIMPLE_P (glyph_table_base, glyph_table_len, g))
1465 len += 1;
1466 else
1467 len += GLYPH_LENGTH (glyph_table_base, g);
1469 ++beg;
1473 return len;
1477 /* Test two glyph rows A and B for equality. Value is non-zero if A
1478 and B have equal contents. W is the window to which the glyphs
1479 rows A and B belong. It is needed here to test for partial row
1480 visibility. MOUSE_FACE_P non-zero means compare the mouse_face_p
1481 flags of A and B, too. */
1483 static INLINE int
1484 row_equal_p (w, a, b, mouse_face_p)
1485 struct window *w;
1486 struct glyph_row *a, *b;
1487 int mouse_face_p;
1489 if (a == b)
1490 return 1;
1491 else if (a->hash != b->hash)
1492 return 0;
1493 else
1495 struct glyph *a_glyph, *b_glyph, *a_end;
1496 int area;
1498 if (mouse_face_p && a->mouse_face_p != b->mouse_face_p)
1499 return 0;
1501 /* Compare glyphs. */
1502 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
1504 if (a->used[area] != b->used[area])
1505 return 0;
1507 a_glyph = a->glyphs[area];
1508 a_end = a_glyph + a->used[area];
1509 b_glyph = b->glyphs[area];
1511 while (a_glyph < a_end
1512 && GLYPH_EQUAL_P (a_glyph, b_glyph))
1513 ++a_glyph, ++b_glyph;
1515 if (a_glyph != a_end)
1516 return 0;
1519 if (a->fill_line_p != b->fill_line_p
1520 || a->cursor_in_fringe_p != b->cursor_in_fringe_p
1521 || a->left_fringe_bitmap != b->left_fringe_bitmap
1522 || a->left_fringe_face_id != b->left_fringe_face_id
1523 || a->right_fringe_bitmap != b->right_fringe_bitmap
1524 || a->right_fringe_face_id != b->right_fringe_face_id
1525 || a->overlay_arrow_bitmap != b->overlay_arrow_bitmap
1526 || a->exact_window_width_line_p != b->exact_window_width_line_p
1527 || a->overlapped_p != b->overlapped_p
1528 || (MATRIX_ROW_CONTINUATION_LINE_P (a)
1529 != MATRIX_ROW_CONTINUATION_LINE_P (b))
1530 /* Different partially visible characters on left margin. */
1531 || a->x != b->x
1532 /* Different height. */
1533 || a->ascent != b->ascent
1534 || a->phys_ascent != b->phys_ascent
1535 || a->phys_height != b->phys_height
1536 || a->visible_height != b->visible_height)
1537 return 0;
1540 return 1;
1545 /***********************************************************************
1546 Glyph Pool
1548 See dispextern.h for an overall explanation of glyph pools.
1549 ***********************************************************************/
1551 /* Allocate a glyph_pool structure. The structure returned is
1552 initialized with zeros. The global variable glyph_pool_count is
1553 incremented for each pool allocated. */
1555 static struct glyph_pool *
1556 new_glyph_pool ()
1558 struct glyph_pool *result;
1560 /* Allocate a new glyph_pool and clear it. */
1561 result = (struct glyph_pool *) xmalloc (sizeof *result);
1562 bzero (result, sizeof *result);
1564 /* For memory leak and double deletion checking. */
1565 ++glyph_pool_count;
1567 return result;
1571 /* Free a glyph_pool structure POOL. The function may be called with
1572 a null POOL pointer. The global variable glyph_pool_count is
1573 decremented with every pool structure freed. If this count gets
1574 negative, more structures were freed than allocated, i.e. one
1575 structure must have been freed more than once or a bogus pointer
1576 was passed to free_glyph_pool. */
1578 static void
1579 free_glyph_pool (pool)
1580 struct glyph_pool *pool;
1582 if (pool)
1584 /* More freed than allocated? */
1585 --glyph_pool_count;
1586 xassert (glyph_pool_count >= 0);
1588 xfree (pool->glyphs);
1589 xfree (pool);
1594 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1595 columns we need. This function never shrinks a pool. The only
1596 case in which this would make sense, would be when a frame's size
1597 is changed from a large value to a smaller one. But, if someone
1598 does it once, we can expect that he will do it again.
1600 Value is non-zero if the pool changed in a way which makes
1601 re-adjusting window glyph matrices necessary. */
1603 static int
1604 realloc_glyph_pool (pool, matrix_dim)
1605 struct glyph_pool *pool;
1606 struct dim matrix_dim;
1608 int needed;
1609 int changed_p;
1611 changed_p = (pool->glyphs == 0
1612 || matrix_dim.height != pool->nrows
1613 || matrix_dim.width != pool->ncolumns);
1615 /* Enlarge the glyph pool. */
1616 needed = matrix_dim.width * matrix_dim.height;
1617 if (needed > pool->nglyphs)
1619 int size = needed * sizeof (struct glyph);
1621 if (pool->glyphs)
1622 pool->glyphs = (struct glyph *) xrealloc (pool->glyphs, size);
1623 else
1625 pool->glyphs = (struct glyph *) xmalloc (size);
1626 bzero (pool->glyphs, size);
1629 pool->nglyphs = needed;
1632 /* Remember the number of rows and columns because (a) we use them
1633 to do sanity checks, and (b) the number of columns determines
1634 where rows in the frame matrix start---this must be available to
1635 determine pointers to rows of window sub-matrices. */
1636 pool->nrows = matrix_dim.height;
1637 pool->ncolumns = matrix_dim.width;
1639 return changed_p;
1644 /***********************************************************************
1645 Debug Code
1646 ***********************************************************************/
1648 #if GLYPH_DEBUG
1651 /* Flush standard output. This is sometimes useful to call from
1652 the debugger. */
1654 void
1655 flush_stdout ()
1657 fflush (stdout);
1661 /* Check that no glyph pointers have been lost in MATRIX. If a
1662 pointer has been lost, e.g. by using a structure assignment between
1663 rows, at least one pointer must occur more than once in the rows of
1664 MATRIX. */
1666 void
1667 check_matrix_pointer_lossage (matrix)
1668 struct glyph_matrix *matrix;
1670 int i, j;
1672 for (i = 0; i < matrix->nrows; ++i)
1673 for (j = 0; j < matrix->nrows; ++j)
1674 xassert (i == j
1675 || (matrix->rows[i].glyphs[TEXT_AREA]
1676 != matrix->rows[j].glyphs[TEXT_AREA]));
1680 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1682 struct glyph_row *
1683 matrix_row (matrix, row)
1684 struct glyph_matrix *matrix;
1685 int row;
1687 xassert (matrix && matrix->rows);
1688 xassert (row >= 0 && row < matrix->nrows);
1690 /* That's really too slow for normal testing because this function
1691 is called almost everywhere. Although---it's still astonishingly
1692 fast, so it is valuable to have for debugging purposes. */
1693 #if 0
1694 check_matrix_pointer_lossage (matrix);
1695 #endif
1697 return matrix->rows + row;
1701 #if 0 /* This function makes invalid assumptions when text is
1702 partially invisible. But it might come handy for debugging
1703 nevertheless. */
1705 /* Check invariants that must hold for an up to date current matrix of
1706 window W. */
1708 static void
1709 check_matrix_invariants (w)
1710 struct window *w;
1712 struct glyph_matrix *matrix = w->current_matrix;
1713 int yb = window_text_bottom_y (w);
1714 struct glyph_row *row = matrix->rows;
1715 struct glyph_row *last_text_row = NULL;
1716 struct buffer *saved = current_buffer;
1717 struct buffer *buffer = XBUFFER (w->buffer);
1718 int c;
1720 /* This can sometimes happen for a fresh window. */
1721 if (matrix->nrows < 2)
1722 return;
1724 set_buffer_temp (buffer);
1726 /* Note: last row is always reserved for the mode line. */
1727 while (MATRIX_ROW_DISPLAYS_TEXT_P (row)
1728 && MATRIX_ROW_BOTTOM_Y (row) < yb)
1730 struct glyph_row *next = row + 1;
1732 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
1733 last_text_row = row;
1735 /* Check that character and byte positions are in sync. */
1736 xassert (MATRIX_ROW_START_BYTEPOS (row)
1737 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row)));
1739 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1740 have such a position temporarily in case of a minibuffer
1741 displaying something like `[Sole completion]' at its end. */
1742 if (MATRIX_ROW_END_CHARPOS (row) < BUF_ZV (current_buffer))
1743 xassert (MATRIX_ROW_END_BYTEPOS (row)
1744 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row)));
1746 /* Check that end position of `row' is equal to start position
1747 of next row. */
1748 if (next->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (next))
1750 xassert (MATRIX_ROW_END_CHARPOS (row)
1751 == MATRIX_ROW_START_CHARPOS (next));
1752 xassert (MATRIX_ROW_END_BYTEPOS (row)
1753 == MATRIX_ROW_START_BYTEPOS (next));
1755 row = next;
1758 xassert (w->current_matrix->nrows == w->desired_matrix->nrows);
1759 xassert (w->desired_matrix->rows != NULL);
1760 set_buffer_temp (saved);
1763 #endif /* 0 */
1765 #endif /* GLYPH_DEBUG != 0 */
1769 /**********************************************************************
1770 Allocating/ Adjusting Glyph Matrices
1771 **********************************************************************/
1773 /* Allocate glyph matrices over a window tree for a frame-based
1774 redisplay
1776 X and Y are column/row within the frame glyph matrix where
1777 sub-matrices for the window tree rooted at WINDOW must be
1778 allocated. CH_DIM contains the dimensions of the smallest
1779 character that could be used during display. DIM_ONLY_P non-zero
1780 means that the caller of this function is only interested in the
1781 result matrix dimension, and matrix adjustments should not be
1782 performed.
1784 The function returns the total width/height of the sub-matrices of
1785 the window tree. If called on a frame root window, the computation
1786 will take the mini-buffer window into account.
1788 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1790 NEW_LEAF_MATRIX set if any window in the tree did not have a
1791 glyph matrices yet, and
1793 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1794 any window in the tree will be changed or have been changed (see
1795 DIM_ONLY_P)
1797 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1798 function.
1800 Windows are arranged into chains of windows on the same level
1801 through the next fields of window structures. Such a level can be
1802 either a sequence of horizontally adjacent windows from left to
1803 right, or a sequence of vertically adjacent windows from top to
1804 bottom. Each window in a horizontal sequence can be either a leaf
1805 window or a vertical sequence; a window in a vertical sequence can
1806 be either a leaf or a horizontal sequence. All windows in a
1807 horizontal sequence have the same height, and all windows in a
1808 vertical sequence have the same width.
1810 This function uses, for historical reasons, a more general
1811 algorithm to determine glyph matrix dimensions that would be
1812 necessary.
1814 The matrix height of a horizontal sequence is determined by the
1815 maximum height of any matrix in the sequence. The matrix width of
1816 a horizontal sequence is computed by adding up matrix widths of
1817 windows in the sequence.
1819 |<------- result width ------->|
1820 +---------+----------+---------+ ---
1821 | | | | |
1822 | | | |
1823 +---------+ | | result height
1824 | +---------+
1825 | | |
1826 +----------+ ---
1828 The matrix width of a vertical sequence is the maximum matrix width
1829 of any window in the sequence. Its height is computed by adding up
1830 matrix heights of windows in the sequence.
1832 |<---- result width -->|
1833 +---------+ ---
1834 | | |
1835 | | |
1836 +---------+--+ |
1837 | | |
1838 | | result height
1840 +------------+---------+ |
1841 | | |
1842 | | |
1843 +------------+---------+ --- */
1845 /* Bit indicating that a new matrix will be allocated or has been
1846 allocated. */
1848 #define NEW_LEAF_MATRIX (1 << 0)
1850 /* Bit indicating that a matrix will or has changed its location or
1851 size. */
1853 #define CHANGED_LEAF_MATRIX (1 << 1)
1855 static struct dim
1856 allocate_matrices_for_frame_redisplay (window, x, y, dim_only_p,
1857 window_change_flags)
1858 Lisp_Object window;
1859 int x, y;
1860 int dim_only_p;
1861 int *window_change_flags;
1863 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
1864 int x0 = x, y0 = y;
1865 int wmax = 0, hmax = 0;
1866 struct dim total;
1867 struct dim dim;
1868 struct window *w;
1869 int in_horz_combination_p;
1871 /* What combination is WINDOW part of? Compute this once since the
1872 result is the same for all windows in the `next' chain. The
1873 special case of a root window (parent equal to nil) is treated
1874 like a vertical combination because a root window's `next'
1875 points to the mini-buffer window, if any, which is arranged
1876 vertically below other windows. */
1877 in_horz_combination_p
1878 = (!NILP (XWINDOW (window)->parent)
1879 && !NILP (XWINDOW (XWINDOW (window)->parent)->hchild));
1881 /* For WINDOW and all windows on the same level. */
1884 w = XWINDOW (window);
1886 /* Get the dimension of the window sub-matrix for W, depending
1887 on whether this is a combination or a leaf window. */
1888 if (!NILP (w->hchild))
1889 dim = allocate_matrices_for_frame_redisplay (w->hchild, x, y,
1890 dim_only_p,
1891 window_change_flags);
1892 else if (!NILP (w->vchild))
1893 dim = allocate_matrices_for_frame_redisplay (w->vchild, x, y,
1894 dim_only_p,
1895 window_change_flags);
1896 else
1898 /* If not already done, allocate sub-matrix structures. */
1899 if (w->desired_matrix == NULL)
1901 w->desired_matrix = new_glyph_matrix (f->desired_pool);
1902 w->current_matrix = new_glyph_matrix (f->current_pool);
1903 *window_change_flags |= NEW_LEAF_MATRIX;
1906 /* Width and height MUST be chosen so that there are no
1907 holes in the frame matrix. */
1908 dim.width = required_matrix_width (w);
1909 dim.height = required_matrix_height (w);
1911 /* Will matrix be re-allocated? */
1912 if (x != w->desired_matrix->matrix_x
1913 || y != w->desired_matrix->matrix_y
1914 || dim.width != w->desired_matrix->matrix_w
1915 || dim.height != w->desired_matrix->matrix_h
1916 || (margin_glyphs_to_reserve (w, dim.width,
1917 w->left_margin_cols)
1918 != w->desired_matrix->left_margin_glyphs)
1919 || (margin_glyphs_to_reserve (w, dim.width,
1920 w->right_margin_cols)
1921 != w->desired_matrix->right_margin_glyphs))
1922 *window_change_flags |= CHANGED_LEAF_MATRIX;
1924 /* Actually change matrices, if allowed. Do not consider
1925 CHANGED_LEAF_MATRIX computed above here because the pool
1926 may have been changed which we don't now here. We trust
1927 that we only will be called with DIM_ONLY_P != 0 when
1928 necessary. */
1929 if (!dim_only_p)
1931 adjust_glyph_matrix (w, w->desired_matrix, x, y, dim);
1932 adjust_glyph_matrix (w, w->current_matrix, x, y, dim);
1936 /* If we are part of a horizontal combination, advance x for
1937 windows to the right of W; otherwise advance y for windows
1938 below W. */
1939 if (in_horz_combination_p)
1940 x += dim.width;
1941 else
1942 y += dim.height;
1944 /* Remember maximum glyph matrix dimensions. */
1945 wmax = max (wmax, dim.width);
1946 hmax = max (hmax, dim.height);
1948 /* Next window on same level. */
1949 window = w->next;
1951 while (!NILP (window));
1953 /* Set `total' to the total glyph matrix dimension of this window
1954 level. In a vertical combination, the width is the width of the
1955 widest window; the height is the y we finally reached, corrected
1956 by the y we started with. In a horizontal combination, the total
1957 height is the height of the tallest window, and the width is the
1958 x we finally reached, corrected by the x we started with. */
1959 if (in_horz_combination_p)
1961 total.width = x - x0;
1962 total.height = hmax;
1964 else
1966 total.width = wmax;
1967 total.height = y - y0;
1970 return total;
1974 /* Return the required height of glyph matrices for window W. */
1977 required_matrix_height (w)
1978 struct window *w;
1980 #ifdef HAVE_WINDOW_SYSTEM
1981 struct frame *f = XFRAME (w->frame);
1983 if (FRAME_WINDOW_P (f))
1985 int ch_height = FRAME_SMALLEST_FONT_HEIGHT (f);
1986 int window_pixel_height = window_box_height (w) + abs (w->vscroll);
1987 return (((window_pixel_height + ch_height - 1)
1988 / ch_height) * w->nrows_scale_factor
1989 /* One partially visible line at the top and
1990 bottom of the window. */
1992 /* 2 for header and mode line. */
1993 + 2);
1995 #endif /* HAVE_WINDOW_SYSTEM */
1997 return WINDOW_TOTAL_LINES (w);
2001 /* Return the required width of glyph matrices for window W. */
2004 required_matrix_width (w)
2005 struct window *w;
2007 #ifdef HAVE_WINDOW_SYSTEM
2008 struct frame *f = XFRAME (w->frame);
2009 if (FRAME_WINDOW_P (f))
2011 int ch_width = FRAME_SMALLEST_CHAR_WIDTH (f);
2012 int window_pixel_width = WINDOW_TOTAL_WIDTH (w);
2014 /* Compute number of glyphs needed in a glyph row. */
2015 return (((window_pixel_width + ch_width - 1)
2016 / ch_width) * w->ncols_scale_factor
2017 /* 2 partially visible columns in the text area. */
2019 /* One partially visible column at the right
2020 edge of each marginal area. */
2021 + 1 + 1);
2023 #endif /* HAVE_WINDOW_SYSTEM */
2025 return XINT (w->total_cols);
2029 /* Allocate window matrices for window-based redisplay. W is the
2030 window whose matrices must be allocated/reallocated. CH_DIM is the
2031 size of the smallest character that could potentially be used on W. */
2033 static void
2034 allocate_matrices_for_window_redisplay (w)
2035 struct window *w;
2037 while (w)
2039 if (!NILP (w->vchild))
2040 allocate_matrices_for_window_redisplay (XWINDOW (w->vchild));
2041 else if (!NILP (w->hchild))
2042 allocate_matrices_for_window_redisplay (XWINDOW (w->hchild));
2043 else
2045 /* W is a leaf window. */
2046 struct dim dim;
2048 /* If matrices are not yet allocated, allocate them now. */
2049 if (w->desired_matrix == NULL)
2051 w->desired_matrix = new_glyph_matrix (NULL);
2052 w->current_matrix = new_glyph_matrix (NULL);
2055 dim.width = required_matrix_width (w);
2056 dim.height = required_matrix_height (w);
2057 adjust_glyph_matrix (w, w->desired_matrix, 0, 0, dim);
2058 adjust_glyph_matrix (w, w->current_matrix, 0, 0, dim);
2061 w = NILP (w->next) ? NULL : XWINDOW (w->next);
2066 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
2067 do it for all frames; otherwise do it just for the given frame.
2068 This function must be called when a new frame is created, its size
2069 changes, or its window configuration changes. */
2071 void
2072 adjust_glyphs (f)
2073 struct frame *f;
2075 /* Block input so that expose events and other events that access
2076 glyph matrices are not processed while we are changing them. */
2077 BLOCK_INPUT;
2079 if (f)
2080 adjust_frame_glyphs (f);
2081 else
2083 Lisp_Object tail, lisp_frame;
2085 FOR_EACH_FRAME (tail, lisp_frame)
2086 adjust_frame_glyphs (XFRAME (lisp_frame));
2089 UNBLOCK_INPUT;
2093 /* Adjust frame glyphs when Emacs is initialized.
2095 To be called from init_display.
2097 We need a glyph matrix because redraw will happen soon.
2098 Unfortunately, window sizes on selected_frame are not yet set to
2099 meaningful values. I believe we can assume that there are only two
2100 windows on the frame---the mini-buffer and the root window. Frame
2101 height and width seem to be correct so far. So, set the sizes of
2102 windows to estimated values. */
2104 static void
2105 adjust_frame_glyphs_initially ()
2107 struct frame *sf = SELECTED_FRAME ();
2108 struct window *root = XWINDOW (sf->root_window);
2109 struct window *mini = XWINDOW (root->next);
2110 int frame_lines = FRAME_LINES (sf);
2111 int frame_cols = FRAME_COLS (sf);
2112 int top_margin = FRAME_TOP_MARGIN (sf);
2114 /* Do it for the root window. */
2115 XSETFASTINT (root->top_line, top_margin);
2116 XSETFASTINT (root->total_cols, frame_cols);
2117 set_window_height (sf->root_window, frame_lines - 1 - top_margin, 0);
2119 /* Do it for the mini-buffer window. */
2120 XSETFASTINT (mini->top_line, frame_lines - 1);
2121 XSETFASTINT (mini->total_cols, frame_cols);
2122 set_window_height (root->next, 1, 0);
2124 adjust_frame_glyphs (sf);
2125 glyphs_initialized_initially_p = 1;
2129 /* Allocate/reallocate glyph matrices of a single frame F. */
2131 static void
2132 adjust_frame_glyphs (f)
2133 struct frame *f;
2135 if (FRAME_WINDOW_P (f))
2136 adjust_frame_glyphs_for_window_redisplay (f);
2137 else
2138 adjust_frame_glyphs_for_frame_redisplay (f);
2140 /* Don't forget the message buffer and the buffer for
2141 decode_mode_spec. */
2142 adjust_frame_message_buffer (f);
2143 adjust_decode_mode_spec_buffer (f);
2145 f->glyphs_initialized_p = 1;
2149 /* In the window tree with root W, build current matrices of leaf
2150 windows from the frame's current matrix. */
2152 static void
2153 fake_current_matrices (window)
2154 Lisp_Object window;
2156 struct window *w;
2158 for (; !NILP (window); window = w->next)
2160 w = XWINDOW (window);
2162 if (!NILP (w->hchild))
2163 fake_current_matrices (w->hchild);
2164 else if (!NILP (w->vchild))
2165 fake_current_matrices (w->vchild);
2166 else
2168 int i;
2169 struct frame *f = XFRAME (w->frame);
2170 struct glyph_matrix *m = w->current_matrix;
2171 struct glyph_matrix *fm = f->current_matrix;
2173 xassert (m->matrix_h == WINDOW_TOTAL_LINES (w));
2174 xassert (m->matrix_w == WINDOW_TOTAL_COLS (w));
2176 for (i = 0; i < m->matrix_h; ++i)
2178 struct glyph_row *r = m->rows + i;
2179 struct glyph_row *fr = fm->rows + i + WINDOW_TOP_EDGE_LINE (w);
2181 xassert (r->glyphs[TEXT_AREA] >= fr->glyphs[TEXT_AREA]
2182 && r->glyphs[LAST_AREA] <= fr->glyphs[LAST_AREA]);
2184 r->enabled_p = fr->enabled_p;
2185 if (r->enabled_p)
2187 r->used[LEFT_MARGIN_AREA] = m->left_margin_glyphs;
2188 r->used[RIGHT_MARGIN_AREA] = m->right_margin_glyphs;
2189 r->used[TEXT_AREA] = (m->matrix_w
2190 - r->used[LEFT_MARGIN_AREA]
2191 - r->used[RIGHT_MARGIN_AREA]);
2192 r->mode_line_p = 0;
2200 /* Save away the contents of frame F's current frame matrix. Value is
2201 a glyph matrix holding the contents of F's current frame matrix. */
2203 static struct glyph_matrix *
2204 save_current_matrix (f)
2205 struct frame *f;
2207 int i;
2208 struct glyph_matrix *saved;
2210 saved = (struct glyph_matrix *) xmalloc (sizeof *saved);
2211 bzero (saved, sizeof *saved);
2212 saved->nrows = f->current_matrix->nrows;
2213 saved->rows = (struct glyph_row *) xmalloc (saved->nrows
2214 * sizeof *saved->rows);
2215 bzero (saved->rows, saved->nrows * sizeof *saved->rows);
2217 for (i = 0; i < saved->nrows; ++i)
2219 struct glyph_row *from = f->current_matrix->rows + i;
2220 struct glyph_row *to = saved->rows + i;
2221 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2222 to->glyphs[TEXT_AREA] = (struct glyph *) xmalloc (nbytes);
2223 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2224 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2227 return saved;
2231 /* Restore the contents of frame F's current frame matrix from SAVED,
2232 and free memory associated with SAVED. */
2234 static void
2235 restore_current_matrix (f, saved)
2236 struct frame *f;
2237 struct glyph_matrix *saved;
2239 int i;
2241 for (i = 0; i < saved->nrows; ++i)
2243 struct glyph_row *from = saved->rows + i;
2244 struct glyph_row *to = f->current_matrix->rows + i;
2245 size_t nbytes = from->used[TEXT_AREA] * sizeof (struct glyph);
2246 bcopy (from->glyphs[TEXT_AREA], to->glyphs[TEXT_AREA], nbytes);
2247 to->used[TEXT_AREA] = from->used[TEXT_AREA];
2248 xfree (from->glyphs[TEXT_AREA]);
2251 xfree (saved->rows);
2252 xfree (saved);
2257 /* Allocate/reallocate glyph matrices of a single frame F for
2258 frame-based redisplay. */
2260 static void
2261 adjust_frame_glyphs_for_frame_redisplay (f)
2262 struct frame *f;
2264 struct dim ch_dim;
2265 struct dim matrix_dim;
2266 int pool_changed_p;
2267 int window_change_flags;
2268 int top_window_y;
2270 if (!FRAME_LIVE_P (f))
2271 return;
2273 /* Determine the smallest character in any font for F. On
2274 console windows, all characters have dimension (1, 1). */
2275 ch_dim.width = ch_dim.height = 1;
2277 top_window_y = FRAME_TOP_MARGIN (f);
2279 /* Allocate glyph pool structures if not already done. */
2280 if (f->desired_pool == NULL)
2282 f->desired_pool = new_glyph_pool ();
2283 f->current_pool = new_glyph_pool ();
2286 /* Allocate frames matrix structures if needed. */
2287 if (f->desired_matrix == NULL)
2289 f->desired_matrix = new_glyph_matrix (f->desired_pool);
2290 f->current_matrix = new_glyph_matrix (f->current_pool);
2293 /* Compute window glyph matrices. (This takes the mini-buffer
2294 window into account). The result is the size of the frame glyph
2295 matrix needed. The variable window_change_flags is set to a bit
2296 mask indicating whether new matrices will be allocated or
2297 existing matrices change their size or location within the frame
2298 matrix. */
2299 window_change_flags = 0;
2300 matrix_dim
2301 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2302 0, top_window_y,
2304 &window_change_flags);
2306 /* Add in menu bar lines, if any. */
2307 matrix_dim.height += top_window_y;
2309 /* Enlarge pools as necessary. */
2310 pool_changed_p = realloc_glyph_pool (f->desired_pool, matrix_dim);
2311 realloc_glyph_pool (f->current_pool, matrix_dim);
2313 /* Set up glyph pointers within window matrices. Do this only if
2314 absolutely necessary since it requires a frame redraw. */
2315 if (pool_changed_p || window_change_flags)
2317 /* Do it for window matrices. */
2318 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f),
2319 0, top_window_y, 0,
2320 &window_change_flags);
2322 /* Size of frame matrices must equal size of frame. Note
2323 that we are called for X frames with window widths NOT equal
2324 to the frame width (from CHANGE_FRAME_SIZE_1). */
2325 xassert (matrix_dim.width == FRAME_COLS (f)
2326 && matrix_dim.height == FRAME_LINES (f));
2328 /* Pointers to glyph memory in glyph rows are exchanged during
2329 the update phase of redisplay, which means in general that a
2330 frame's current matrix consists of pointers into both the
2331 desired and current glyph pool of the frame. Adjusting a
2332 matrix sets the frame matrix up so that pointers are all into
2333 the same pool. If we want to preserve glyph contents of the
2334 current matrix over a call to adjust_glyph_matrix, we must
2335 make a copy of the current glyphs, and restore the current
2336 matrix' contents from that copy. */
2337 if (display_completed
2338 && !FRAME_GARBAGED_P (f)
2339 && matrix_dim.width == f->current_matrix->matrix_w
2340 && matrix_dim.height == f->current_matrix->matrix_h)
2342 struct glyph_matrix *copy = save_current_matrix (f);
2343 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2344 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2345 restore_current_matrix (f, copy);
2346 fake_current_matrices (FRAME_ROOT_WINDOW (f));
2348 else
2350 adjust_glyph_matrix (NULL, f->desired_matrix, 0, 0, matrix_dim);
2351 adjust_glyph_matrix (NULL, f->current_matrix, 0, 0, matrix_dim);
2352 SET_FRAME_GARBAGED (f);
2358 /* Allocate/reallocate glyph matrices of a single frame F for
2359 window-based redisplay. */
2361 static void
2362 adjust_frame_glyphs_for_window_redisplay (f)
2363 struct frame *f;
2365 struct dim ch_dim;
2366 struct window *w;
2368 xassert (FRAME_WINDOW_P (f) && FRAME_LIVE_P (f));
2370 /* Get minimum sizes. */
2371 #ifdef HAVE_WINDOW_SYSTEM
2372 ch_dim.width = FRAME_SMALLEST_CHAR_WIDTH (f);
2373 ch_dim.height = FRAME_SMALLEST_FONT_HEIGHT (f);
2374 #else
2375 ch_dim.width = ch_dim.height = 1;
2376 #endif
2378 /* Allocate/reallocate window matrices. */
2379 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f)));
2381 /* Allocate/ reallocate matrices of the dummy window used to display
2382 the menu bar under X when no X toolkit support is available. */
2383 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2385 /* Allocate a dummy window if not already done. */
2386 if (NILP (f->menu_bar_window))
2388 f->menu_bar_window = make_window ();
2389 w = XWINDOW (f->menu_bar_window);
2390 XSETFRAME (w->frame, f);
2391 w->pseudo_window_p = 1;
2393 else
2394 w = XWINDOW (f->menu_bar_window);
2396 /* Set window dimensions to frame dimensions and allocate or
2397 adjust glyph matrices of W. */
2398 XSETFASTINT (w->top_line, 0);
2399 XSETFASTINT (w->left_col, 0);
2400 XSETFASTINT (w->total_lines, FRAME_MENU_BAR_LINES (f));
2401 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2402 allocate_matrices_for_window_redisplay (w);
2404 #endif /* not USE_X_TOOLKIT */
2406 #ifndef USE_GTK
2407 /* Allocate/ reallocate matrices of the tool bar window. If we
2408 don't have a tool bar window yet, make one. */
2409 if (NILP (f->tool_bar_window))
2411 f->tool_bar_window = make_window ();
2412 w = XWINDOW (f->tool_bar_window);
2413 XSETFRAME (w->frame, f);
2414 w->pseudo_window_p = 1;
2416 else
2417 w = XWINDOW (f->tool_bar_window);
2419 XSETFASTINT (w->top_line, FRAME_MENU_BAR_LINES (f));
2420 XSETFASTINT (w->left_col, 0);
2421 XSETFASTINT (w->total_lines, FRAME_TOOL_BAR_LINES (f));
2422 XSETFASTINT (w->total_cols, FRAME_TOTAL_COLS (f));
2423 allocate_matrices_for_window_redisplay (w);
2424 #endif
2428 /* Adjust/ allocate message buffer of frame F.
2430 Note that the message buffer is never freed. Since I could not
2431 find a free in 19.34, I assume that freeing it would be
2432 problematic in some way and don't do it either.
2434 (Implementation note: It should be checked if we can free it
2435 eventually without causing trouble). */
2437 static void
2438 adjust_frame_message_buffer (f)
2439 struct frame *f;
2441 int size = FRAME_MESSAGE_BUF_SIZE (f) + 1;
2443 if (FRAME_MESSAGE_BUF (f))
2445 char *buffer = FRAME_MESSAGE_BUF (f);
2446 char *new_buffer = (char *) xrealloc (buffer, size);
2447 FRAME_MESSAGE_BUF (f) = new_buffer;
2449 else
2450 FRAME_MESSAGE_BUF (f) = (char *) xmalloc (size);
2454 /* Re-allocate buffer for decode_mode_spec on frame F. */
2456 static void
2457 adjust_decode_mode_spec_buffer (f)
2458 struct frame *f;
2460 f->decode_mode_spec_buffer
2461 = (char *) xrealloc (f->decode_mode_spec_buffer,
2462 FRAME_MESSAGE_BUF_SIZE (f) + 1);
2467 /**********************************************************************
2468 Freeing Glyph Matrices
2469 **********************************************************************/
2471 /* Free glyph memory for a frame F. F may be null. This function can
2472 be called for the same frame more than once. The root window of
2473 F may be nil when this function is called. This is the case when
2474 the function is called when F is destroyed. */
2476 void
2477 free_glyphs (f)
2478 struct frame *f;
2480 if (f && f->glyphs_initialized_p)
2482 /* Block interrupt input so that we don't get surprised by an X
2483 event while we're in an inconsistent state. */
2484 BLOCK_INPUT;
2485 f->glyphs_initialized_p = 0;
2487 /* Release window sub-matrices. */
2488 if (!NILP (f->root_window))
2489 free_window_matrices (XWINDOW (f->root_window));
2491 /* Free the dummy window for menu bars without X toolkit and its
2492 glyph matrices. */
2493 if (!NILP (f->menu_bar_window))
2495 struct window *w = XWINDOW (f->menu_bar_window);
2496 free_glyph_matrix (w->desired_matrix);
2497 free_glyph_matrix (w->current_matrix);
2498 w->desired_matrix = w->current_matrix = NULL;
2499 f->menu_bar_window = Qnil;
2502 /* Free the tool bar window and its glyph matrices. */
2503 if (!NILP (f->tool_bar_window))
2505 struct window *w = XWINDOW (f->tool_bar_window);
2506 free_glyph_matrix (w->desired_matrix);
2507 free_glyph_matrix (w->current_matrix);
2508 w->desired_matrix = w->current_matrix = NULL;
2509 f->tool_bar_window = Qnil;
2512 /* Release frame glyph matrices. Reset fields to zero in
2513 case we are called a second time. */
2514 if (f->desired_matrix)
2516 free_glyph_matrix (f->desired_matrix);
2517 free_glyph_matrix (f->current_matrix);
2518 f->desired_matrix = f->current_matrix = NULL;
2521 /* Release glyph pools. */
2522 if (f->desired_pool)
2524 free_glyph_pool (f->desired_pool);
2525 free_glyph_pool (f->current_pool);
2526 f->desired_pool = f->current_pool = NULL;
2529 UNBLOCK_INPUT;
2534 /* Free glyph sub-matrices in the window tree rooted at W. This
2535 function may be called with a null pointer, and it may be called on
2536 the same tree more than once. */
2538 void
2539 free_window_matrices (w)
2540 struct window *w;
2542 while (w)
2544 if (!NILP (w->hchild))
2545 free_window_matrices (XWINDOW (w->hchild));
2546 else if (!NILP (w->vchild))
2547 free_window_matrices (XWINDOW (w->vchild));
2548 else
2550 /* This is a leaf window. Free its memory and reset fields
2551 to zero in case this function is called a second time for
2552 W. */
2553 free_glyph_matrix (w->current_matrix);
2554 free_glyph_matrix (w->desired_matrix);
2555 w->current_matrix = w->desired_matrix = NULL;
2558 /* Next window on same level. */
2559 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2564 /* Check glyph memory leaks. This function is called from
2565 shut_down_emacs. Note that frames are not destroyed when Emacs
2566 exits. We therefore free all glyph memory for all active frames
2567 explicitly and check that nothing is left allocated. */
2569 void
2570 check_glyph_memory ()
2572 Lisp_Object tail, frame;
2574 /* Free glyph memory for all frames. */
2575 FOR_EACH_FRAME (tail, frame)
2576 free_glyphs (XFRAME (frame));
2578 /* Check that nothing is left allocated. */
2579 if (glyph_matrix_count)
2580 abort ();
2581 if (glyph_pool_count)
2582 abort ();
2587 /**********************************************************************
2588 Building a Frame Matrix
2589 **********************************************************************/
2591 /* Most of the redisplay code works on glyph matrices attached to
2592 windows. This is a good solution most of the time, but it is not
2593 suitable for terminal code. Terminal output functions cannot rely
2594 on being able to set an arbitrary terminal window. Instead they
2595 must be provided with a view of the whole frame, i.e. the whole
2596 screen. We build such a view by constructing a frame matrix from
2597 window matrices in this section.
2599 Windows that must be updated have their must_be_update_p flag set.
2600 For all such windows, their desired matrix is made part of the
2601 desired frame matrix. For other windows, their current matrix is
2602 made part of the desired frame matrix.
2604 +-----------------+----------------+
2605 | desired | desired |
2606 | | |
2607 +-----------------+----------------+
2608 | current |
2610 +----------------------------------+
2612 Desired window matrices can be made part of the frame matrix in a
2613 cheap way: We exploit the fact that the desired frame matrix and
2614 desired window matrices share their glyph memory. This is not
2615 possible for current window matrices. Their glyphs are copied to
2616 the desired frame matrix. The latter is equivalent to
2617 preserve_other_columns in the old redisplay.
2619 Used glyphs counters for frame matrix rows are the result of adding
2620 up glyph lengths of the window matrices. A line in the frame
2621 matrix is enabled, if a corresponding line in a window matrix is
2622 enabled.
2624 After building the desired frame matrix, it will be passed to
2625 terminal code, which will manipulate both the desired and current
2626 frame matrix. Changes applied to the frame's current matrix have
2627 to be visible in current window matrices afterwards, of course.
2629 This problem is solved like this:
2631 1. Window and frame matrices share glyphs. Window matrices are
2632 constructed in a way that their glyph contents ARE the glyph
2633 contents needed in a frame matrix. Thus, any modification of
2634 glyphs done in terminal code will be reflected in window matrices
2635 automatically.
2637 2. Exchanges of rows in a frame matrix done by terminal code are
2638 intercepted by hook functions so that corresponding row operations
2639 on window matrices can be performed. This is necessary because we
2640 use pointers to glyphs in glyph row structures. To satisfy the
2641 assumption of point 1 above that glyphs are updated implicitly in
2642 window matrices when they are manipulated via the frame matrix,
2643 window and frame matrix must of course agree where to find the
2644 glyphs for their rows. Possible manipulations that must be
2645 mirrored are assignments of rows of the desired frame matrix to the
2646 current frame matrix and scrolling the current frame matrix. */
2648 /* Build frame F's desired matrix from window matrices. Only windows
2649 which have the flag must_be_updated_p set have to be updated. Menu
2650 bar lines of a frame are not covered by window matrices, so make
2651 sure not to touch them in this function. */
2653 static void
2654 build_frame_matrix (f)
2655 struct frame *f;
2657 int i;
2659 /* F must have a frame matrix when this function is called. */
2660 xassert (!FRAME_WINDOW_P (f));
2662 /* Clear all rows in the frame matrix covered by window matrices.
2663 Menu bar lines are not covered by windows. */
2664 for (i = FRAME_TOP_MARGIN (f); i < f->desired_matrix->nrows; ++i)
2665 clear_glyph_row (MATRIX_ROW (f->desired_matrix, i));
2667 /* Build the matrix by walking the window tree. */
2668 build_frame_matrix_from_window_tree (f->desired_matrix,
2669 XWINDOW (FRAME_ROOT_WINDOW (f)));
2673 /* Walk a window tree, building a frame matrix MATRIX from window
2674 matrices. W is the root of a window tree. */
2676 static void
2677 build_frame_matrix_from_window_tree (matrix, w)
2678 struct glyph_matrix *matrix;
2679 struct window *w;
2681 while (w)
2683 if (!NILP (w->hchild))
2684 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->hchild));
2685 else if (!NILP (w->vchild))
2686 build_frame_matrix_from_window_tree (matrix, XWINDOW (w->vchild));
2687 else
2688 build_frame_matrix_from_leaf_window (matrix, w);
2690 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2695 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2696 desired frame matrix built. W is a leaf window whose desired or
2697 current matrix is to be added to FRAME_MATRIX. W's flag
2698 must_be_updated_p determines which matrix it contributes to
2699 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2700 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2701 Adding a desired matrix means setting up used counters and such in
2702 frame rows, while adding a current window matrix to FRAME_MATRIX
2703 means copying glyphs. The latter case corresponds to
2704 preserve_other_columns in the old redisplay. */
2706 static void
2707 build_frame_matrix_from_leaf_window (frame_matrix, w)
2708 struct glyph_matrix *frame_matrix;
2709 struct window *w;
2711 struct glyph_matrix *window_matrix;
2712 int window_y, frame_y;
2713 /* If non-zero, a glyph to insert at the right border of W. */
2714 GLYPH right_border_glyph = 0;
2716 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2717 if (w->must_be_updated_p)
2719 window_matrix = w->desired_matrix;
2721 /* Decide whether we want to add a vertical border glyph. */
2722 if (!WINDOW_RIGHTMOST_P (w))
2724 struct Lisp_Char_Table *dp = window_display_table (w);
2726 right_border_glyph
2727 = ((dp && INTEGERP (DISP_BORDER_GLYPH (dp)))
2728 ? spec_glyph_lookup_face (w, XINT (DISP_BORDER_GLYPH (dp)))
2729 : '|');
2731 if (FAST_GLYPH_FACE (right_border_glyph) <= 0)
2732 right_border_glyph
2733 = FAST_MAKE_GLYPH (right_border_glyph, VERTICAL_BORDER_FACE_ID);
2736 else
2737 window_matrix = w->current_matrix;
2739 /* For all rows in the window matrix and corresponding rows in the
2740 frame matrix. */
2741 window_y = 0;
2742 frame_y = window_matrix->matrix_y;
2743 while (window_y < window_matrix->nrows)
2745 struct glyph_row *frame_row = frame_matrix->rows + frame_y;
2746 struct glyph_row *window_row = window_matrix->rows + window_y;
2747 int current_row_p = window_matrix == w->current_matrix;
2749 /* Fill up the frame row with spaces up to the left margin of the
2750 window row. */
2751 fill_up_frame_row_with_spaces (frame_row, window_matrix->matrix_x);
2753 /* Fill up areas in the window matrix row with spaces. */
2754 fill_up_glyph_row_with_spaces (window_row);
2756 /* If only part of W's desired matrix has been built, and
2757 window_row wasn't displayed, use the corresponding current
2758 row instead. */
2759 if (window_matrix == w->desired_matrix
2760 && !window_row->enabled_p)
2762 window_row = w->current_matrix->rows + window_y;
2763 current_row_p = 1;
2766 if (current_row_p)
2768 /* Copy window row to frame row. */
2769 bcopy (window_row->glyphs[0],
2770 frame_row->glyphs[TEXT_AREA] + window_matrix->matrix_x,
2771 window_matrix->matrix_w * sizeof (struct glyph));
2773 else
2775 xassert (window_row->enabled_p);
2777 /* Only when a desired row has been displayed, we want
2778 the corresponding frame row to be updated. */
2779 frame_row->enabled_p = 1;
2781 /* Maybe insert a vertical border between horizontally adjacent
2782 windows. */
2783 if (right_border_glyph)
2785 struct glyph *border = window_row->glyphs[LAST_AREA] - 1;
2786 SET_CHAR_GLYPH_FROM_GLYPH (*border, right_border_glyph);
2789 #if GLYPH_DEBUG
2790 /* Window row window_y must be a slice of frame row
2791 frame_y. */
2792 xassert (glyph_row_slice_p (window_row, frame_row));
2794 /* If rows are in sync, we don't have to copy glyphs because
2795 frame and window share glyphs. */
2797 strcpy (w->current_matrix->method, w->desired_matrix->method);
2798 add_window_display_history (w, w->current_matrix->method, 0);
2799 #endif
2802 /* Set number of used glyphs in the frame matrix. Since we fill
2803 up with spaces, and visit leaf windows from left to right it
2804 can be done simply. */
2805 frame_row->used[TEXT_AREA]
2806 = window_matrix->matrix_x + window_matrix->matrix_w;
2808 /* Next row. */
2809 ++window_y;
2810 ++frame_y;
2814 /* Given a user-specified glyph, possibly including a Lisp-level face
2815 ID, return a glyph that has a realized face ID.
2816 This is used for glyphs displayed specially and not part of the text;
2817 for instance, vertical separators, truncation markers, etc. */
2819 GLYPH
2820 spec_glyph_lookup_face (w, glyph)
2821 struct window *w;
2822 GLYPH glyph;
2824 int lface_id = FAST_GLYPH_FACE (glyph);
2825 /* Convert the glyph's specified face to a realized (cache) face. */
2826 if (lface_id > 0)
2828 int face_id = merge_faces (XFRAME (w->frame),
2829 Qt, lface_id, DEFAULT_FACE_ID);
2830 glyph
2831 = FAST_MAKE_GLYPH (FAST_GLYPH_CHAR (glyph), face_id);
2833 return glyph;
2836 /* Add spaces to a glyph row ROW in a window matrix.
2838 Each row has the form:
2840 +---------+-----------------------------+------------+
2841 | left | text | right |
2842 +---------+-----------------------------+------------+
2844 Left and right marginal areas are optional. This function adds
2845 spaces to areas so that there are no empty holes between areas.
2846 In other words: If the right area is not empty, the text area
2847 is filled up with spaces up to the right area. If the text area
2848 is not empty, the left area is filled up.
2850 To be called for frame-based redisplay, only. */
2852 static void
2853 fill_up_glyph_row_with_spaces (row)
2854 struct glyph_row *row;
2856 fill_up_glyph_row_area_with_spaces (row, LEFT_MARGIN_AREA);
2857 fill_up_glyph_row_area_with_spaces (row, TEXT_AREA);
2858 fill_up_glyph_row_area_with_spaces (row, RIGHT_MARGIN_AREA);
2862 /* Fill area AREA of glyph row ROW with spaces. To be called for
2863 frame-based redisplay only. */
2865 static void
2866 fill_up_glyph_row_area_with_spaces (row, area)
2867 struct glyph_row *row;
2868 int area;
2870 if (row->glyphs[area] < row->glyphs[area + 1])
2872 struct glyph *end = row->glyphs[area + 1];
2873 struct glyph *text = row->glyphs[area] + row->used[area];
2875 while (text < end)
2876 *text++ = space_glyph;
2877 row->used[area] = text - row->glyphs[area];
2882 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2883 reached. In frame matrices only one area, TEXT_AREA, is used. */
2885 static void
2886 fill_up_frame_row_with_spaces (row, upto)
2887 struct glyph_row *row;
2888 int upto;
2890 int i = row->used[TEXT_AREA];
2891 struct glyph *glyph = row->glyphs[TEXT_AREA];
2893 while (i < upto)
2894 glyph[i++] = space_glyph;
2896 row->used[TEXT_AREA] = i;
2901 /**********************************************************************
2902 Mirroring operations on frame matrices in window matrices
2903 **********************************************************************/
2905 /* Set frame being updated via frame-based redisplay to F. This
2906 function must be called before updates to make explicit that we are
2907 working on frame matrices or not. */
2909 static INLINE void
2910 set_frame_matrix_frame (f)
2911 struct frame *f;
2913 frame_matrix_frame = f;
2917 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2918 DESIRED_MATRIX is the desired matrix corresponding to
2919 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2920 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2921 frame_matrix_frame is non-null, this indicates that the exchange is
2922 done in frame matrices, and that we have to perform analogous
2923 operations in window matrices of frame_matrix_frame. */
2925 static INLINE void
2926 make_current (desired_matrix, current_matrix, row)
2927 struct glyph_matrix *desired_matrix, *current_matrix;
2928 int row;
2930 struct glyph_row *current_row = MATRIX_ROW (current_matrix, row);
2931 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, row);
2932 int mouse_face_p = current_row->mouse_face_p;
2934 /* Do current_row = desired_row. This exchanges glyph pointers
2935 between both rows, and does a structure assignment otherwise. */
2936 assign_row (current_row, desired_row);
2938 /* Enable current_row to mark it as valid. */
2939 current_row->enabled_p = 1;
2940 current_row->mouse_face_p = mouse_face_p;
2942 /* If we are called on frame matrices, perform analogous operations
2943 for window matrices. */
2944 if (frame_matrix_frame)
2945 mirror_make_current (XWINDOW (frame_matrix_frame->root_window), row);
2949 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2950 W's frame which has been made current (by swapping pointers between
2951 current and desired matrix). Perform analogous operations in the
2952 matrices of leaf windows in the window tree rooted at W. */
2954 static void
2955 mirror_make_current (w, frame_row)
2956 struct window *w;
2957 int frame_row;
2959 while (w)
2961 if (!NILP (w->hchild))
2962 mirror_make_current (XWINDOW (w->hchild), frame_row);
2963 else if (!NILP (w->vchild))
2964 mirror_make_current (XWINDOW (w->vchild), frame_row);
2965 else
2967 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2968 here because the checks performed in debug mode there
2969 will not allow the conversion. */
2970 int row = frame_row - w->desired_matrix->matrix_y;
2972 /* If FRAME_ROW is within W, assign the desired row to the
2973 current row (exchanging glyph pointers). */
2974 if (row >= 0 && row < w->desired_matrix->matrix_h)
2976 struct glyph_row *current_row
2977 = MATRIX_ROW (w->current_matrix, row);
2978 struct glyph_row *desired_row
2979 = MATRIX_ROW (w->desired_matrix, row);
2981 if (desired_row->enabled_p)
2982 assign_row (current_row, desired_row);
2983 else
2984 swap_glyph_pointers (desired_row, current_row);
2985 current_row->enabled_p = 1;
2989 w = NILP (w->next) ? 0 : XWINDOW (w->next);
2994 /* Perform row dance after scrolling. We are working on the range of
2995 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2996 including) in MATRIX. COPY_FROM is a vector containing, for each
2997 row I in the range 0 <= I < NLINES, the index of the original line
2998 to move to I. This index is relative to the row range, i.e. 0 <=
2999 index < NLINES. RETAINED_P is a vector containing zero for each
3000 row 0 <= I < NLINES which is empty.
3002 This function is called from do_scrolling and do_direct_scrolling. */
3004 void
3005 mirrored_line_dance (matrix, unchanged_at_top, nlines, copy_from,
3006 retained_p)
3007 struct glyph_matrix *matrix;
3008 int unchanged_at_top, nlines;
3009 int *copy_from;
3010 char *retained_p;
3012 /* A copy of original rows. */
3013 struct glyph_row *old_rows;
3015 /* Rows to assign to. */
3016 struct glyph_row *new_rows = MATRIX_ROW (matrix, unchanged_at_top);
3018 int i;
3020 /* Make a copy of the original rows. */
3021 old_rows = (struct glyph_row *) alloca (nlines * sizeof *old_rows);
3022 bcopy (new_rows, old_rows, nlines * sizeof *old_rows);
3024 /* Assign new rows, maybe clear lines. */
3025 for (i = 0; i < nlines; ++i)
3027 int enabled_before_p = new_rows[i].enabled_p;
3029 xassert (i + unchanged_at_top < matrix->nrows);
3030 xassert (unchanged_at_top + copy_from[i] < matrix->nrows);
3031 new_rows[i] = old_rows[copy_from[i]];
3032 new_rows[i].enabled_p = enabled_before_p;
3034 /* RETAINED_P is zero for empty lines. */
3035 if (!retained_p[copy_from[i]])
3036 new_rows[i].enabled_p = 0;
3039 /* Do the same for window matrices, if MATRIX is a frame matrix. */
3040 if (frame_matrix_frame)
3041 mirror_line_dance (XWINDOW (frame_matrix_frame->root_window),
3042 unchanged_at_top, nlines, copy_from, retained_p);
3046 /* Synchronize glyph pointers in the current matrix of window W with
3047 the current frame matrix. */
3049 static void
3050 sync_window_with_frame_matrix_rows (w)
3051 struct window *w;
3053 struct frame *f = XFRAME (w->frame);
3054 struct glyph_row *window_row, *window_row_end, *frame_row;
3055 int left, right, x, width;
3057 /* Preconditions: W must be a leaf window on a tty frame. */
3058 xassert (NILP (w->hchild) && NILP (w->vchild));
3059 xassert (!FRAME_WINDOW_P (f));
3061 left = margin_glyphs_to_reserve (w, 1, w->left_margin_cols);
3062 right = margin_glyphs_to_reserve (w, 1, w->right_margin_cols);
3063 x = w->current_matrix->matrix_x;
3064 width = w->current_matrix->matrix_w;
3066 window_row = w->current_matrix->rows;
3067 window_row_end = window_row + w->current_matrix->nrows;
3068 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
3070 for (; window_row < window_row_end; ++window_row, ++frame_row)
3072 window_row->glyphs[LEFT_MARGIN_AREA]
3073 = frame_row->glyphs[0] + x;
3074 window_row->glyphs[TEXT_AREA]
3075 = window_row->glyphs[LEFT_MARGIN_AREA] + left;
3076 window_row->glyphs[LAST_AREA]
3077 = window_row->glyphs[LEFT_MARGIN_AREA] + width;
3078 window_row->glyphs[RIGHT_MARGIN_AREA]
3079 = window_row->glyphs[LAST_AREA] - right;
3084 /* Return the window in the window tree rooted in W containing frame
3085 row ROW. Value is null if none is found. */
3087 struct window *
3088 frame_row_to_window (w, row)
3089 struct window *w;
3090 int row;
3092 struct window *found = NULL;
3094 while (w && !found)
3096 if (!NILP (w->hchild))
3097 found = frame_row_to_window (XWINDOW (w->hchild), row);
3098 else if (!NILP (w->vchild))
3099 found = frame_row_to_window (XWINDOW (w->vchild), row);
3100 else if (row >= WINDOW_TOP_EDGE_LINE (w)
3101 && row < WINDOW_BOTTOM_EDGE_LINE (w))
3102 found = w;
3104 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3107 return found;
3111 /* Perform a line dance in the window tree rooted at W, after
3112 scrolling a frame matrix in mirrored_line_dance.
3114 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
3115 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
3116 COPY_FROM is a vector containing, for each row I in the range 0 <=
3117 I < NLINES, the index of the original line to move to I. This
3118 index is relative to the row range, i.e. 0 <= index < NLINES.
3119 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
3120 which is empty. */
3122 static void
3123 mirror_line_dance (w, unchanged_at_top, nlines, copy_from, retained_p)
3124 struct window *w;
3125 int unchanged_at_top, nlines;
3126 int *copy_from;
3127 char *retained_p;
3129 while (w)
3131 if (!NILP (w->hchild))
3132 mirror_line_dance (XWINDOW (w->hchild), unchanged_at_top,
3133 nlines, copy_from, retained_p);
3134 else if (!NILP (w->vchild))
3135 mirror_line_dance (XWINDOW (w->vchild), unchanged_at_top,
3136 nlines, copy_from, retained_p);
3137 else
3139 /* W is a leaf window, and we are working on its current
3140 matrix m. */
3141 struct glyph_matrix *m = w->current_matrix;
3142 int i, sync_p = 0;
3143 struct glyph_row *old_rows;
3145 /* Make a copy of the original rows of matrix m. */
3146 old_rows = (struct glyph_row *) alloca (m->nrows * sizeof *old_rows);
3147 bcopy (m->rows, old_rows, m->nrows * sizeof *old_rows);
3149 for (i = 0; i < nlines; ++i)
3151 /* Frame relative line assigned to. */
3152 int frame_to = i + unchanged_at_top;
3154 /* Frame relative line assigned. */
3155 int frame_from = copy_from[i] + unchanged_at_top;
3157 /* Window relative line assigned to. */
3158 int window_to = frame_to - m->matrix_y;
3160 /* Window relative line assigned. */
3161 int window_from = frame_from - m->matrix_y;
3163 /* Is assigned line inside window? */
3164 int from_inside_window_p
3165 = window_from >= 0 && window_from < m->matrix_h;
3167 /* Is assigned to line inside window? */
3168 int to_inside_window_p
3169 = window_to >= 0 && window_to < m->matrix_h;
3171 if (from_inside_window_p && to_inside_window_p)
3173 /* Enabled setting before assignment. */
3174 int enabled_before_p;
3176 /* Do the assignment. The enabled_p flag is saved
3177 over the assignment because the old redisplay did
3178 that. */
3179 enabled_before_p = m->rows[window_to].enabled_p;
3180 m->rows[window_to] = old_rows[window_from];
3181 m->rows[window_to].enabled_p = enabled_before_p;
3183 /* If frame line is empty, window line is empty, too. */
3184 if (!retained_p[copy_from[i]])
3185 m->rows[window_to].enabled_p = 0;
3187 else if (to_inside_window_p)
3189 /* A copy between windows. This is an infrequent
3190 case not worth optimizing. */
3191 struct frame *f = XFRAME (w->frame);
3192 struct window *root = XWINDOW (FRAME_ROOT_WINDOW (f));
3193 struct window *w2;
3194 struct glyph_matrix *m2;
3195 int m2_from;
3197 w2 = frame_row_to_window (root, frame_from);
3198 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3199 -nw', FROM_FRAME sometimes has no associated window.
3200 This check avoids a segfault if W2 is null. */
3201 if (w2)
3203 m2 = w2->current_matrix;
3204 m2_from = frame_from - m2->matrix_y;
3205 copy_row_except_pointers (m->rows + window_to,
3206 m2->rows + m2_from);
3208 /* If frame line is empty, window line is empty, too. */
3209 if (!retained_p[copy_from[i]])
3210 m->rows[window_to].enabled_p = 0;
3212 sync_p = 1;
3214 else if (from_inside_window_p)
3215 sync_p = 1;
3218 /* If there was a copy between windows, make sure glyph
3219 pointers are in sync with the frame matrix. */
3220 if (sync_p)
3221 sync_window_with_frame_matrix_rows (w);
3223 /* Check that no pointers are lost. */
3224 CHECK_MATRIX (m);
3227 /* Next window on same level. */
3228 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3233 #if GLYPH_DEBUG
3235 /* Check that window and frame matrices agree about their
3236 understanding where glyphs of the rows are to find. For each
3237 window in the window tree rooted at W, check that rows in the
3238 matrices of leaf window agree with their frame matrices about
3239 glyph pointers. */
3241 void
3242 check_window_matrix_pointers (w)
3243 struct window *w;
3245 while (w)
3247 if (!NILP (w->hchild))
3248 check_window_matrix_pointers (XWINDOW (w->hchild));
3249 else if (!NILP (w->vchild))
3250 check_window_matrix_pointers (XWINDOW (w->vchild));
3251 else
3253 struct frame *f = XFRAME (w->frame);
3254 check_matrix_pointers (w->desired_matrix, f->desired_matrix);
3255 check_matrix_pointers (w->current_matrix, f->current_matrix);
3258 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3263 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3264 a window and FRAME_MATRIX is the corresponding frame matrix. For
3265 each row in WINDOW_MATRIX check that it's a slice of the
3266 corresponding frame row. If it isn't, abort. */
3268 static void
3269 check_matrix_pointers (window_matrix, frame_matrix)
3270 struct glyph_matrix *window_matrix, *frame_matrix;
3272 /* Row number in WINDOW_MATRIX. */
3273 int i = 0;
3275 /* Row number corresponding to I in FRAME_MATRIX. */
3276 int j = window_matrix->matrix_y;
3278 /* For all rows check that the row in the window matrix is a
3279 slice of the row in the frame matrix. If it isn't we didn't
3280 mirror an operation on the frame matrix correctly. */
3281 while (i < window_matrix->nrows)
3283 if (!glyph_row_slice_p (window_matrix->rows + i,
3284 frame_matrix->rows + j))
3285 abort ();
3286 ++i, ++j;
3290 #endif /* GLYPH_DEBUG != 0 */
3294 /**********************************************************************
3295 VPOS and HPOS translations
3296 **********************************************************************/
3298 #if GLYPH_DEBUG
3300 /* Translate vertical position VPOS which is relative to window W to a
3301 vertical position relative to W's frame. */
3303 static int
3304 window_to_frame_vpos (w, vpos)
3305 struct window *w;
3306 int vpos;
3308 struct frame *f = XFRAME (w->frame);
3310 xassert (!FRAME_WINDOW_P (f));
3311 xassert (vpos >= 0 && vpos <= w->desired_matrix->nrows);
3312 vpos += WINDOW_TOP_EDGE_LINE (w);
3313 xassert (vpos >= 0 && vpos <= FRAME_LINES (f));
3314 return vpos;
3318 /* Translate horizontal position HPOS which is relative to window W to
3319 a horizontal position relative to W's frame. */
3321 static int
3322 window_to_frame_hpos (w, hpos)
3323 struct window *w;
3324 int hpos;
3326 xassert (!FRAME_WINDOW_P (XFRAME (w->frame)));
3327 hpos += WINDOW_LEFT_EDGE_COL (w);
3328 return hpos;
3331 #endif /* GLYPH_DEBUG */
3335 /**********************************************************************
3336 Redrawing Frames
3337 **********************************************************************/
3339 DEFUN ("redraw-frame", Fredraw_frame, Sredraw_frame, 1, 1, 0,
3340 doc: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3341 (frame)
3342 Lisp_Object frame;
3344 struct frame *f;
3346 CHECK_LIVE_FRAME (frame);
3347 f = XFRAME (frame);
3349 /* Ignore redraw requests, if frame has no glyphs yet.
3350 (Implementation note: It still has to be checked why we are
3351 called so early here). */
3352 if (!glyphs_initialized_initially_p)
3353 return Qnil;
3355 update_begin (f);
3356 if (FRAME_MSDOS_P (f))
3357 set_terminal_modes ();
3358 clear_frame ();
3359 clear_current_matrices (f);
3360 update_end (f);
3361 fflush (stdout);
3362 windows_or_buffers_changed++;
3363 /* Mark all windows as inaccurate, so that every window will have
3364 its redisplay done. */
3365 mark_window_display_accurate (FRAME_ROOT_WINDOW (f), 0);
3366 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f)), 1);
3367 f->garbaged = 0;
3368 return Qnil;
3372 /* Redraw frame F. This is nothing more than a call to the Lisp
3373 function redraw-frame. */
3375 void
3376 redraw_frame (f)
3377 struct frame *f;
3379 Lisp_Object frame;
3380 XSETFRAME (frame, f);
3381 Fredraw_frame (frame);
3385 DEFUN ("redraw-display", Fredraw_display, Sredraw_display, 0, 0, "",
3386 doc: /* Clear and redisplay all visible frames. */)
3389 Lisp_Object tail, frame;
3391 FOR_EACH_FRAME (tail, frame)
3392 if (FRAME_VISIBLE_P (XFRAME (frame)))
3393 Fredraw_frame (frame);
3395 return Qnil;
3399 /* This is used when frame_garbaged is set. Call Fredraw_frame on all
3400 visible frames marked as garbaged. */
3402 void
3403 redraw_garbaged_frames ()
3405 Lisp_Object tail, frame;
3407 FOR_EACH_FRAME (tail, frame)
3408 if (FRAME_VISIBLE_P (XFRAME (frame))
3409 && FRAME_GARBAGED_P (XFRAME (frame)))
3410 Fredraw_frame (frame);
3415 /***********************************************************************
3416 Direct Operations
3417 ***********************************************************************/
3419 /* Try to update display and current glyph matrix directly.
3421 This function is called after a character G has been inserted into
3422 current_buffer. It tries to update the current glyph matrix and
3423 perform appropriate screen output to reflect the insertion. If it
3424 succeeds, the global flag redisplay_performed_directly_p will be
3425 set to 1, and thereby prevent the more costly general redisplay
3426 from running (see redisplay_internal).
3428 This function is not called for `hairy' character insertions.
3429 In particular, it is not called when after or before change
3430 functions exist, like they are used by font-lock. See keyboard.c
3431 for details where this function is called. */
3434 direct_output_for_insert (g)
3435 int g;
3437 register struct frame *f = SELECTED_FRAME ();
3438 struct window *w = XWINDOW (selected_window);
3439 struct it it, it2;
3440 struct glyph_row *glyph_row;
3441 struct glyph *glyphs, *glyph, *end;
3442 int n;
3443 /* Non-null means that redisplay of W is based on window matrices. */
3444 int window_redisplay_p = FRAME_WINDOW_P (f);
3445 /* Non-null means we are in overwrite mode. */
3446 int overwrite_p = !NILP (current_buffer->overwrite_mode);
3447 int added_width;
3448 struct text_pos pos;
3449 int delta, delta_bytes;
3451 /* Not done directly. */
3452 redisplay_performed_directly_p = 0;
3454 /* Quickly give up for some common cases. */
3455 if (cursor_in_echo_area
3456 /* Give up if fonts have changed. */
3457 || fonts_changed_p
3458 /* Give up if face attributes have been changed. */
3459 || face_change_count
3460 /* Give up if cursor position not really known. */
3461 || !display_completed
3462 /* Give up if buffer appears in two places. */
3463 || buffer_shared > 1
3464 /* Give up if currently displaying a message instead of the
3465 minibuffer contents. */
3466 || (EQ (selected_window, minibuf_window)
3467 && EQ (minibuf_window, echo_area_window))
3468 /* Give up for hscrolled mini-buffer because display of the prompt
3469 is handled specially there (see display_line). */
3470 || (MINI_WINDOW_P (w) && XFASTINT (w->hscroll))
3471 /* Give up if overwriting in the middle of a line. */
3472 || (overwrite_p
3473 && PT != ZV
3474 && FETCH_BYTE (PT) != '\n')
3475 /* Give up for tabs and line ends. */
3476 || g == '\t'
3477 || g == '\n'
3478 || g == '\r'
3479 /* Give up if unable to display the cursor in the window. */
3480 || w->cursor.vpos < 0
3481 /* Give up if we are showing a message or just cleared the message
3482 because we might need to resize the echo area window. */
3483 || !NILP (echo_area_buffer[0])
3484 || !NILP (echo_area_buffer[1])
3485 || (glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos),
3486 /* Can't do it in a continued line because continuation
3487 lines would change. */
3488 (glyph_row->continued_p
3489 || glyph_row->exact_window_width_line_p
3490 /* Can't use this method if the line overlaps others or is
3491 overlapped by others because these other lines would
3492 have to be redisplayed. */
3493 || glyph_row->overlapping_p
3494 || glyph_row->overlapped_p))
3495 /* Can't do it for partial width windows on terminal frames
3496 because we can't clear to eol in such a window. */
3497 || (!window_redisplay_p && !WINDOW_FULL_WIDTH_P (w)))
3498 return 0;
3500 /* If we can't insert glyphs, we can use this method only
3501 at the end of a line. */
3502 if (!char_ins_del_ok)
3503 if (PT != ZV && FETCH_BYTE (PT_BYTE) != '\n')
3504 return 0;
3506 /* Set up a display iterator structure for W. Glyphs will be
3507 produced in scratch_glyph_row. Current position is W's cursor
3508 position. */
3509 clear_glyph_row (&scratch_glyph_row);
3510 SET_TEXT_POS (pos, PT, PT_BYTE);
3511 DEC_TEXT_POS (pos, !NILP (current_buffer->enable_multibyte_characters));
3512 init_iterator (&it, w, CHARPOS (pos), BYTEPOS (pos), &scratch_glyph_row,
3513 DEFAULT_FACE_ID);
3515 glyph_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3516 if (glyph_row->mouse_face_p)
3517 return 0;
3519 /* Give up if highlighting trailing whitespace and we have trailing
3520 whitespace in glyph_row. We would have to remove the trailing
3521 whitespace face in that case. */
3522 if (!NILP (Vshow_trailing_whitespace)
3523 && glyph_row->used[TEXT_AREA])
3525 struct glyph *last;
3527 last = glyph_row->glyphs[TEXT_AREA] + glyph_row->used[TEXT_AREA] - 1;
3528 if (last->type == STRETCH_GLYPH
3529 || (last->type == CHAR_GLYPH
3530 && last->u.ch == ' '))
3531 return 0;
3534 /* Give up if there are overlay strings at pos. This would fail
3535 if the overlay string has newlines in it. */
3536 if (STRINGP (it.string))
3537 return 0;
3539 it.hpos = w->cursor.hpos;
3540 it.vpos = w->cursor.vpos;
3541 it.current_x = w->cursor.x + it.first_visible_x;
3542 it.current_y = w->cursor.y;
3543 it.end_charpos = PT;
3544 it.stop_charpos = min (PT, it.stop_charpos);
3545 it.stop_charpos = max (IT_CHARPOS (it), it.stop_charpos);
3547 /* More than one display element may be returned for PT - 1 if
3548 (i) it's a control character which is translated into `\003' or
3549 `^C', or (ii) it has a display table entry, or (iii) it's a
3550 combination of both. */
3551 delta = delta_bytes = 0;
3552 while (get_next_display_element (&it))
3554 PRODUCE_GLYPHS (&it);
3556 /* Give up if glyph doesn't fit completely on the line. */
3557 if (it.current_x >= it.last_visible_x)
3558 return 0;
3560 /* Give up if new glyph has different ascent or descent than
3561 the original row, or if it is not a character glyph. */
3562 if (glyph_row->ascent != it.ascent
3563 || glyph_row->height != it.ascent + it.descent
3564 || glyph_row->phys_ascent != it.phys_ascent
3565 || glyph_row->phys_height != it.phys_ascent + it.phys_descent
3566 || it.what != IT_CHARACTER)
3567 return 0;
3569 delta += 1;
3570 delta_bytes += it.len;
3571 set_iterator_to_next (&it, 1);
3574 /* Give up if we hit the right edge of the window. We would have
3575 to insert truncation or continuation glyphs. */
3576 added_width = it.current_x - (w->cursor.x + it.first_visible_x);
3577 if (glyph_row->pixel_width + added_width >= it.last_visible_x)
3578 return 0;
3580 /* Give up if there is a \t following in the line. */
3581 it2 = it;
3582 it2.end_charpos = ZV;
3583 it2.stop_charpos = min (it2.stop_charpos, ZV);
3584 while (get_next_display_element (&it2)
3585 && !ITERATOR_AT_END_OF_LINE_P (&it2))
3587 if (it2.c == '\t')
3588 return 0;
3589 set_iterator_to_next (&it2, 1);
3592 /* Number of new glyphs produced. */
3593 n = it.glyph_row->used[TEXT_AREA];
3595 /* Start and end of glyphs in original row. */
3596 glyphs = glyph_row->glyphs[TEXT_AREA] + w->cursor.hpos;
3597 end = glyph_row->glyphs[1 + TEXT_AREA];
3599 /* Make room for new glyphs, then insert them. */
3600 xassert (end - glyphs - n >= 0);
3601 safe_bcopy ((char *) glyphs, (char *) (glyphs + n),
3602 (end - glyphs - n) * sizeof (*end));
3603 bcopy (it.glyph_row->glyphs[TEXT_AREA], glyphs, n * sizeof *glyphs);
3604 glyph_row->used[TEXT_AREA] = min (glyph_row->used[TEXT_AREA] + n,
3605 end - glyph_row->glyphs[TEXT_AREA]);
3607 /* Compute new line width. */
3608 glyph = glyph_row->glyphs[TEXT_AREA];
3609 end = glyph + glyph_row->used[TEXT_AREA];
3610 glyph_row->pixel_width = glyph_row->x;
3611 while (glyph < end)
3613 glyph_row->pixel_width += glyph->pixel_width;
3614 ++glyph;
3617 /* Increment buffer positions for glyphs following the newly
3618 inserted ones. */
3619 for (glyph = glyphs + n; glyph < end; ++glyph)
3620 if (glyph->charpos > 0 && BUFFERP (glyph->object))
3621 glyph->charpos += delta;
3623 if (MATRIX_ROW_END_CHARPOS (glyph_row) > 0)
3625 MATRIX_ROW_END_CHARPOS (glyph_row) += delta;
3626 MATRIX_ROW_END_BYTEPOS (glyph_row) += delta_bytes;
3629 /* Adjust positions in lines following the one we are in. */
3630 increment_matrix_positions (w->current_matrix,
3631 w->cursor.vpos + 1,
3632 w->current_matrix->nrows,
3633 delta, delta_bytes);
3635 glyph_row->contains_overlapping_glyphs_p
3636 |= it.glyph_row->contains_overlapping_glyphs_p;
3638 glyph_row->displays_text_p = 1;
3639 w->window_end_vpos = make_number (max (w->cursor.vpos,
3640 XFASTINT (w->window_end_vpos)));
3642 if (!NILP (Vshow_trailing_whitespace))
3643 highlight_trailing_whitespace (it.f, glyph_row);
3645 /* Write glyphs. If at end of row, we can simply call write_glyphs.
3646 In the middle, we have to insert glyphs. Note that this is now
3647 implemented for X frames. The implementation uses updated_window
3648 and updated_row. */
3649 updated_row = glyph_row;
3650 updated_area = TEXT_AREA;
3651 update_begin (f);
3652 if (rif)
3654 rif->update_window_begin_hook (w);
3656 if (glyphs == end - n
3657 /* In front of a space added by append_space. */
3658 || (glyphs == end - n - 1
3659 && (end - n)->charpos <= 0))
3660 rif->write_glyphs (glyphs, n);
3661 else
3662 rif->insert_glyphs (glyphs, n);
3664 else
3666 if (glyphs == end - n)
3667 write_glyphs (glyphs, n);
3668 else
3669 insert_glyphs (glyphs, n);
3672 w->cursor.hpos += n;
3673 w->cursor.x = it.current_x - it.first_visible_x;
3674 xassert (w->cursor.hpos >= 0
3675 && w->cursor.hpos < w->desired_matrix->matrix_w);
3677 /* How to set the cursor differs depending on whether we are
3678 using a frame matrix or a window matrix. Note that when
3679 a frame matrix is used, cursor_to expects frame coordinates,
3680 and the X and Y parameters are not used. */
3681 if (window_redisplay_p)
3682 rif->cursor_to (w->cursor.vpos, w->cursor.hpos,
3683 w->cursor.y, w->cursor.x);
3684 else
3686 int x, y;
3687 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3688 + (INTEGERP (w->left_margin_cols)
3689 ? XFASTINT (w->left_margin_cols)
3690 : 0));
3691 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3692 cursor_to (y, x);
3695 #ifdef HAVE_WINDOW_SYSTEM
3696 update_window_fringes (w, 0);
3697 #endif
3699 if (rif)
3700 rif->update_window_end_hook (w, 1, 0);
3701 update_end (f);
3702 updated_row = NULL;
3703 fflush (stdout);
3705 TRACE ((stderr, "direct output for insert\n"));
3706 mark_window_display_accurate (it.window, 1);
3707 redisplay_performed_directly_p = 1;
3708 return 1;
3712 /* Perform a direct display update for moving PT by N positions
3713 left or right. N < 0 means a movement backwards. This function
3714 is currently only called for N == 1 or N == -1. */
3717 direct_output_forward_char (n)
3718 int n;
3720 struct frame *f = SELECTED_FRAME ();
3721 struct window *w = XWINDOW (selected_window);
3722 struct glyph_row *row;
3724 /* Give up if point moved out of or into a composition. */
3725 if (check_point_in_composition (current_buffer, XINT (w->last_point),
3726 current_buffer, PT))
3727 return 0;
3729 /* Give up if face attributes have been changed. */
3730 if (face_change_count)
3731 return 0;
3733 /* Give up if current matrix is not up to date or we are
3734 displaying a message. */
3735 if (!display_completed || cursor_in_echo_area)
3736 return 0;
3738 /* Give up if the buffer's direction is reversed. */
3739 if (!NILP (XBUFFER (w->buffer)->direction_reversed))
3740 return 0;
3742 /* Can't use direct output if highlighting a region. */
3743 if (!NILP (Vtransient_mark_mode) && !NILP (current_buffer->mark_active))
3744 return 0;
3746 /* Can't use direct output if highlighting trailing whitespace. */
3747 if (!NILP (Vshow_trailing_whitespace))
3748 return 0;
3750 /* Give up if we are showing a message or just cleared the message
3751 because we might need to resize the echo area window. */
3752 if (!NILP (echo_area_buffer[0]) || !NILP (echo_area_buffer[1]))
3753 return 0;
3755 /* Give up if currently displaying a message instead of the
3756 minibuffer contents. */
3757 if (XWINDOW (minibuf_window) == w
3758 && EQ (minibuf_window, echo_area_window))
3759 return 0;
3761 /* Give up if we don't know where the cursor is. */
3762 if (w->cursor.vpos < 0)
3763 return 0;
3765 row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
3767 /* Give up if PT is outside of the last known cursor row. */
3768 if (PT <= MATRIX_ROW_START_CHARPOS (row)
3769 || PT >= MATRIX_ROW_END_CHARPOS (row))
3770 return 0;
3772 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
3774 w->last_cursor = w->cursor;
3775 XSETFASTINT (w->last_point, PT);
3777 xassert (w->cursor.hpos >= 0
3778 && w->cursor.hpos < w->desired_matrix->matrix_w);
3780 if (FRAME_WINDOW_P (f))
3781 rif->cursor_to (w->cursor.vpos, w->cursor.hpos,
3782 w->cursor.y, w->cursor.x);
3783 else
3785 int x, y;
3786 x = (WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos)
3787 + (INTEGERP (w->left_margin_cols)
3788 ? XFASTINT (w->left_margin_cols)
3789 : 0));
3790 y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
3791 cursor_to (y, x);
3794 fflush (stdout);
3795 redisplay_performed_directly_p = 1;
3796 return 1;
3801 /***********************************************************************
3802 Frame Update
3803 ***********************************************************************/
3805 /* Update frame F based on the data in desired matrices.
3807 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3808 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3809 scrolling.
3811 Value is non-zero if redisplay was stopped due to pending input. */
3814 update_frame (f, force_p, inhibit_hairy_id_p)
3815 struct frame *f;
3816 int force_p;
3817 int inhibit_hairy_id_p;
3819 /* 1 means display has been paused because of pending input. */
3820 int paused_p;
3821 struct window *root_window = XWINDOW (f->root_window);
3823 if (FRAME_WINDOW_P (f))
3825 /* We are working on window matrix basis. All windows whose
3826 flag must_be_updated_p is set have to be updated. */
3828 /* Record that we are not working on frame matrices. */
3829 set_frame_matrix_frame (NULL);
3831 /* Update all windows in the window tree of F, maybe stopping
3832 when pending input is detected. */
3833 update_begin (f);
3835 /* Update the menu bar on X frames that don't have toolkit
3836 support. */
3837 if (WINDOWP (f->menu_bar_window))
3838 update_window (XWINDOW (f->menu_bar_window), 1);
3840 /* Update the tool-bar window, if present. */
3841 if (WINDOWP (f->tool_bar_window))
3843 struct window *w = XWINDOW (f->tool_bar_window);
3845 /* Update tool-bar window. */
3846 if (w->must_be_updated_p)
3848 Lisp_Object tem;
3850 update_window (w, 1);
3851 w->must_be_updated_p = 0;
3853 /* Swap tool-bar strings. We swap because we want to
3854 reuse strings. */
3855 tem = f->current_tool_bar_string;
3856 f->current_tool_bar_string = f->desired_tool_bar_string;
3857 f->desired_tool_bar_string = tem;
3862 /* Update windows. */
3863 paused_p = update_window_tree (root_window, force_p);
3864 update_end (f);
3866 /* This flush is a performance bottleneck under X,
3867 and it doesn't seem to be necessary anyway (in general).
3868 It is necessary when resizing the window with the mouse, or
3869 at least the fringes are not redrawn in a timely manner. ++kfs */
3870 if (f->force_flush_display_p)
3872 rif->flush_display (f);
3873 f->force_flush_display_p = 0;
3876 else
3878 /* We are working on frame matrix basis. Set the frame on whose
3879 frame matrix we operate. */
3880 set_frame_matrix_frame (f);
3882 /* Build F's desired matrix from window matrices. */
3883 build_frame_matrix (f);
3885 /* Update the display */
3886 update_begin (f);
3887 paused_p = update_frame_1 (f, force_p, inhibit_hairy_id_p);
3888 update_end (f);
3890 if (termscript)
3891 fflush (termscript);
3892 fflush (stdout);
3894 /* Check window matrices for lost pointers. */
3895 #if GLYPH_DEBUG
3896 check_window_matrix_pointers (root_window);
3897 add_frame_display_history (f, paused_p);
3898 #endif
3901 /* Reset flags indicating that a window should be updated. */
3902 set_window_update_flags (root_window, 0);
3904 display_completed = !paused_p;
3905 return paused_p;
3910 /************************************************************************
3911 Window-based updates
3912 ************************************************************************/
3914 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3915 don't stop updating when input is pending. */
3917 static int
3918 update_window_tree (w, force_p)
3919 struct window *w;
3920 int force_p;
3922 int paused_p = 0;
3924 while (w && !paused_p)
3926 if (!NILP (w->hchild))
3927 paused_p |= update_window_tree (XWINDOW (w->hchild), force_p);
3928 else if (!NILP (w->vchild))
3929 paused_p |= update_window_tree (XWINDOW (w->vchild), force_p);
3930 else if (w->must_be_updated_p)
3931 paused_p |= update_window (w, force_p);
3933 w = NILP (w->next) ? 0 : XWINDOW (w->next);
3936 return paused_p;
3940 /* Update window W if its flag must_be_updated_p is non-zero. If
3941 FORCE_P is non-zero, don't stop updating if input is pending. */
3943 void
3944 update_single_window (w, force_p)
3945 struct window *w;
3946 int force_p;
3948 if (w->must_be_updated_p)
3950 struct frame *f = XFRAME (WINDOW_FRAME (w));
3952 /* Record that this is not a frame-based redisplay. */
3953 set_frame_matrix_frame (NULL);
3955 /* Update W. */
3956 update_begin (f);
3957 update_window (w, force_p);
3958 update_end (f);
3960 /* Reset flag in W. */
3961 w->must_be_updated_p = 0;
3965 #ifdef HAVE_WINDOW_SYSTEM
3967 /* Redraw lines from the current matrix of window W that are
3968 overlapped by other rows. YB is bottom-most y-position in W. */
3970 static void
3971 redraw_overlapped_rows (w, yb)
3972 struct window *w;
3973 int yb;
3975 int i;
3977 /* If rows overlapping others have been changed, the rows being
3978 overlapped have to be redrawn. This won't draw lines that have
3979 already been drawn in update_window_line because overlapped_p in
3980 desired rows is 0, so after row assignment overlapped_p in
3981 current rows is 0. */
3982 for (i = 0; i < w->current_matrix->nrows; ++i)
3984 struct glyph_row *row = w->current_matrix->rows + i;
3986 if (!row->enabled_p)
3987 break;
3988 else if (row->mode_line_p)
3989 continue;
3991 if (row->overlapped_p)
3993 enum glyph_row_area area;
3995 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
3997 updated_row = row;
3998 updated_area = area;
3999 rif->cursor_to (i, 0, row->y, area == TEXT_AREA ? row->x : 0);
4000 if (row->used[area])
4001 rif->write_glyphs (row->glyphs[area], row->used[area]);
4002 rif->clear_end_of_line (-1);
4005 row->overlapped_p = 0;
4008 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4009 break;
4014 /* Redraw lines from the current matrix of window W that overlap
4015 others. YB is bottom-most y-position in W. */
4017 static void
4018 redraw_overlapping_rows (w, yb)
4019 struct window *w;
4020 int yb;
4022 int i, bottom_y;
4023 struct glyph_row *row;
4025 for (i = 0; i < w->current_matrix->nrows; ++i)
4027 row = w->current_matrix->rows + i;
4029 if (!row->enabled_p)
4030 break;
4031 else if (row->mode_line_p)
4032 continue;
4034 bottom_y = MATRIX_ROW_BOTTOM_Y (row);
4036 if (row->overlapping_p && i > 0 && bottom_y < yb)
4038 int overlaps = 0;
4040 if (MATRIX_ROW_OVERLAPS_PRED_P (row)
4041 && !MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p)
4042 overlaps |= OVERLAPS_PRED;
4043 if (MATRIX_ROW_OVERLAPS_SUCC_P (row)
4044 && !MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p)
4045 overlaps |= OVERLAPS_SUCC;
4047 if (overlaps)
4049 if (row->used[LEFT_MARGIN_AREA])
4050 rif->fix_overlapping_area (w, row, LEFT_MARGIN_AREA, overlaps);
4052 if (row->used[TEXT_AREA])
4053 rif->fix_overlapping_area (w, row, TEXT_AREA, overlaps);
4055 if (row->used[RIGHT_MARGIN_AREA])
4056 rif->fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, overlaps);
4058 /* Record in neighbour rows that ROW overwrites part of
4059 their display. */
4060 if (overlaps & OVERLAPS_PRED)
4061 MATRIX_ROW (w->current_matrix, i - 1)->overlapped_p = 1;
4062 if (overlaps & OVERLAPS_SUCC)
4063 MATRIX_ROW (w->current_matrix, i + 1)->overlapped_p = 1;
4067 if (bottom_y >= yb)
4068 break;
4072 #endif /* HAVE_WINDOW_SYSTEM */
4075 #ifdef GLYPH_DEBUG
4077 /* Check that no row in the current matrix of window W is enabled
4078 which is below what's displayed in the window. */
4080 void
4081 check_current_matrix_flags (w)
4082 struct window *w;
4084 int last_seen_p = 0;
4085 int i, yb = window_text_bottom_y (w);
4087 for (i = 0; i < w->current_matrix->nrows - 1; ++i)
4089 struct glyph_row *row = MATRIX_ROW (w->current_matrix, i);
4090 if (!last_seen_p && MATRIX_ROW_BOTTOM_Y (row) >= yb)
4091 last_seen_p = 1;
4092 else if (last_seen_p && row->enabled_p)
4093 abort ();
4097 #endif /* GLYPH_DEBUG */
4100 /* Update display of window W. FORCE_P non-zero means that we should
4101 not stop when detecting pending input. */
4103 static int
4104 update_window (w, force_p)
4105 struct window *w;
4106 int force_p;
4108 struct glyph_matrix *desired_matrix = w->desired_matrix;
4109 int paused_p;
4110 int preempt_count = baud_rate / 2400 + 1;
4111 extern int input_pending;
4112 extern Lisp_Object do_mouse_tracking;
4113 #if GLYPH_DEBUG
4114 /* Check that W's frame doesn't have glyph matrices. */
4115 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w))));
4116 xassert (updating_frame != NULL);
4117 #endif
4119 /* Check pending input the first time so that we can quickly return. */
4120 if (redisplay_dont_pause)
4121 force_p = 1;
4122 else
4123 detect_input_pending_ignore_squeezables ();
4125 /* If forced to complete the update, or if no input is pending, do
4126 the update. */
4127 if (force_p || !input_pending || !NILP (do_mouse_tracking))
4129 struct glyph_row *row, *end;
4130 struct glyph_row *mode_line_row;
4131 struct glyph_row *header_line_row;
4132 int yb, changed_p = 0, mouse_face_overwritten_p = 0, n_updated;
4134 rif->update_window_begin_hook (w);
4135 yb = window_text_bottom_y (w);
4137 /* If window has a header line, update it before everything else.
4138 Adjust y-positions of other rows by the header line height. */
4139 row = desired_matrix->rows;
4140 end = row + desired_matrix->nrows - 1;
4142 if (row->mode_line_p)
4144 header_line_row = row;
4145 ++row;
4147 else
4148 header_line_row = NULL;
4150 /* Update the mode line, if necessary. */
4151 mode_line_row = MATRIX_MODE_LINE_ROW (desired_matrix);
4152 if (mode_line_row->mode_line_p && mode_line_row->enabled_p)
4154 mode_line_row->y = yb;
4155 update_window_line (w, MATRIX_ROW_VPOS (mode_line_row,
4156 desired_matrix),
4157 &mouse_face_overwritten_p);
4160 /* Find first enabled row. Optimizations in redisplay_internal
4161 may lead to an update with only one row enabled. There may
4162 be also completely empty matrices. */
4163 while (row < end && !row->enabled_p)
4164 ++row;
4166 /* Try reusing part of the display by copying. */
4167 if (row < end && !desired_matrix->no_scrolling_p)
4169 int rc = scrolling_window (w, header_line_row != NULL);
4170 if (rc < 0)
4172 /* All rows were found to be equal. */
4173 paused_p = 0;
4174 goto set_cursor;
4176 else if (rc > 0)
4178 /* We've scrolled the display. */
4179 force_p = 1;
4180 changed_p = 1;
4184 /* Update the rest of the lines. */
4185 for (n_updated = 0; row < end && (force_p || !input_pending); ++row)
4186 if (row->enabled_p)
4188 int vpos = MATRIX_ROW_VPOS (row, desired_matrix);
4189 int i;
4191 /* We'll have to play a little bit with when to
4192 detect_input_pending. If it's done too often,
4193 scrolling large windows with repeated scroll-up
4194 commands will too quickly pause redisplay. */
4195 if (!force_p && ++n_updated % preempt_count == 0)
4196 detect_input_pending_ignore_squeezables ();
4198 changed_p |= update_window_line (w, vpos,
4199 &mouse_face_overwritten_p);
4201 /* Mark all rows below the last visible one in the current
4202 matrix as invalid. This is necessary because of
4203 variable line heights. Consider the case of three
4204 successive redisplays, where the first displays 5
4205 lines, the second 3 lines, and the third 5 lines again.
4206 If the second redisplay wouldn't mark rows in the
4207 current matrix invalid, the third redisplay might be
4208 tempted to optimize redisplay based on lines displayed
4209 in the first redisplay. */
4210 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
4211 for (i = vpos + 1; i < w->current_matrix->nrows - 1; ++i)
4212 MATRIX_ROW (w->current_matrix, i)->enabled_p = 0;
4215 /* Was display preempted? */
4216 paused_p = row < end;
4218 set_cursor:
4220 /* Update the header line after scrolling because a new header
4221 line would otherwise overwrite lines at the top of the window
4222 that can be scrolled. */
4223 if (header_line_row && header_line_row->enabled_p)
4225 header_line_row->y = 0;
4226 update_window_line (w, 0, &mouse_face_overwritten_p);
4229 /* Fix the appearance of overlapping/overlapped rows. */
4230 if (!paused_p && !w->pseudo_window_p)
4232 #ifdef HAVE_WINDOW_SYSTEM
4233 if (changed_p && rif->fix_overlapping_area)
4235 redraw_overlapped_rows (w, yb);
4236 redraw_overlapping_rows (w, yb);
4238 #endif
4240 /* Make cursor visible at cursor position of W. */
4241 set_window_cursor_after_update (w);
4243 #if 0 /* Check that current matrix invariants are satisfied. This is
4244 for debugging only. See the comment of check_matrix_invariants. */
4245 IF_DEBUG (check_matrix_invariants (w));
4246 #endif
4249 #if GLYPH_DEBUG
4250 /* Remember the redisplay method used to display the matrix. */
4251 strcpy (w->current_matrix->method, w->desired_matrix->method);
4252 #endif
4254 #ifdef HAVE_WINDOW_SYSTEM
4255 update_window_fringes (w, 0);
4256 #endif
4258 /* End the update of window W. Don't set the cursor if we
4259 paused updating the display because in this case,
4260 set_window_cursor_after_update hasn't been called, and
4261 output_cursor doesn't contain the cursor location. */
4262 rif->update_window_end_hook (w, !paused_p, mouse_face_overwritten_p);
4264 else
4265 paused_p = 1;
4267 #if GLYPH_DEBUG
4268 /* check_current_matrix_flags (w); */
4269 add_window_display_history (w, w->current_matrix->method, paused_p);
4270 #endif
4272 clear_glyph_matrix (desired_matrix);
4274 return paused_p;
4278 /* Update the display of area AREA in window W, row number VPOS.
4279 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
4281 static void
4282 update_marginal_area (w, area, vpos)
4283 struct window *w;
4284 int area, vpos;
4286 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4288 /* Let functions in xterm.c know what area subsequent X positions
4289 will be relative to. */
4290 updated_area = area;
4292 /* Set cursor to start of glyphs, write them, and clear to the end
4293 of the area. I don't think that something more sophisticated is
4294 necessary here, since marginal areas will not be the default. */
4295 rif->cursor_to (vpos, 0, desired_row->y, 0);
4296 if (desired_row->used[area])
4297 rif->write_glyphs (desired_row->glyphs[area], desired_row->used[area]);
4298 rif->clear_end_of_line (-1);
4302 /* Update the display of the text area of row VPOS in window W.
4303 Value is non-zero if display has changed. */
4305 static int
4306 update_text_area (w, vpos)
4307 struct window *w;
4308 int vpos;
4310 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4311 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4312 int changed_p = 0;
4314 /* Let functions in xterm.c know what area subsequent X positions
4315 will be relative to. */
4316 updated_area = TEXT_AREA;
4318 /* If rows are at different X or Y, or rows have different height,
4319 or the current row is marked invalid, write the entire line. */
4320 if (!current_row->enabled_p
4321 || desired_row->y != current_row->y
4322 || desired_row->ascent != current_row->ascent
4323 || desired_row->phys_ascent != current_row->phys_ascent
4324 || desired_row->phys_height != current_row->phys_height
4325 || desired_row->visible_height != current_row->visible_height
4326 || current_row->overlapped_p
4327 || current_row->mouse_face_p
4328 || current_row->x != desired_row->x)
4330 rif->cursor_to (vpos, 0, desired_row->y, desired_row->x);
4332 if (desired_row->used[TEXT_AREA])
4333 rif->write_glyphs (desired_row->glyphs[TEXT_AREA],
4334 desired_row->used[TEXT_AREA]);
4336 /* Clear to end of window. */
4337 rif->clear_end_of_line (-1);
4338 changed_p = 1;
4340 /* This erases the cursor. We do this here because
4341 notice_overwritten_cursor cannot easily check this, which
4342 might indicate that the whole functionality of
4343 notice_overwritten_cursor would better be implemented here.
4344 On the other hand, we need notice_overwritten_cursor as long
4345 as mouse highlighting is done asynchronously outside of
4346 redisplay. */
4347 if (vpos == w->phys_cursor.vpos)
4348 w->phys_cursor_on_p = 0;
4350 else
4352 int stop, i, x;
4353 struct glyph *current_glyph = current_row->glyphs[TEXT_AREA];
4354 struct glyph *desired_glyph = desired_row->glyphs[TEXT_AREA];
4355 int overlapping_glyphs_p = current_row->contains_overlapping_glyphs_p;
4356 int desired_stop_pos = desired_row->used[TEXT_AREA];
4358 /* If the desired row extends its face to the text area end, and
4359 unless the current row also does so at the same position,
4360 make sure we write at least one glyph, so that the face
4361 extension actually takes place. */
4362 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row)
4363 && (desired_stop_pos < current_row->used[TEXT_AREA]
4364 || (desired_stop_pos == current_row->used[TEXT_AREA]
4365 && !MATRIX_ROW_EXTENDS_FACE_P (current_row))))
4366 --desired_stop_pos;
4368 stop = min (current_row->used[TEXT_AREA], desired_stop_pos);
4369 i = 0;
4370 x = desired_row->x;
4372 /* Loop over glyphs that current and desired row may have
4373 in common. */
4374 while (i < stop)
4376 int can_skip_p = 1;
4378 /* Skip over glyphs that both rows have in common. These
4379 don't have to be written. We can't skip if the last
4380 current glyph overlaps the glyph to its right. For
4381 example, consider a current row of `if ' with the `f' in
4382 Courier bold so that it overlaps the ` ' to its right.
4383 If the desired row is ` ', we would skip over the space
4384 after the `if' and there would remain a pixel from the
4385 `f' on the screen. */
4386 if (overlapping_glyphs_p && i > 0)
4388 struct glyph *glyph = &current_row->glyphs[TEXT_AREA][i - 1];
4389 int left, right;
4391 rif->get_glyph_overhangs (glyph, XFRAME (w->frame),
4392 &left, &right);
4393 can_skip_p = right == 0;
4396 if (can_skip_p)
4398 while (i < stop
4399 && GLYPH_EQUAL_P (desired_glyph, current_glyph))
4401 x += desired_glyph->pixel_width;
4402 ++desired_glyph, ++current_glyph, ++i;
4405 /* Consider the case that the current row contains "xxx
4406 ppp ggg" in italic Courier font, and the desired row
4407 is "xxx ggg". The character `p' has lbearing, `g'
4408 has not. The loop above will stop in front of the
4409 first `p' in the current row. If we would start
4410 writing glyphs there, we wouldn't erase the lbearing
4411 of the `p'. The rest of the lbearing problem is then
4412 taken care of by draw_glyphs. */
4413 if (overlapping_glyphs_p
4414 && i > 0
4415 && i < current_row->used[TEXT_AREA]
4416 && (current_row->used[TEXT_AREA]
4417 != desired_row->used[TEXT_AREA]))
4419 int left, right;
4421 rif->get_glyph_overhangs (current_glyph, XFRAME (w->frame),
4422 &left, &right);
4423 while (left > 0 && i > 0)
4425 --i, --desired_glyph, --current_glyph;
4426 x -= desired_glyph->pixel_width;
4427 left -= desired_glyph->pixel_width;
4432 /* Try to avoid writing the entire rest of the desired row
4433 by looking for a resync point. This mainly prevents
4434 mode line flickering in the case the mode line is in
4435 fixed-pitch font, which it usually will be. */
4436 if (i < desired_row->used[TEXT_AREA])
4438 int start_x = x, start_hpos = i;
4439 struct glyph *start = desired_glyph;
4440 int current_x = x;
4441 int skip_first_p = !can_skip_p;
4443 /* Find the next glyph that's equal again. */
4444 while (i < stop
4445 && (skip_first_p
4446 || !GLYPH_EQUAL_P (desired_glyph, current_glyph))
4447 && x == current_x)
4449 x += desired_glyph->pixel_width;
4450 current_x += current_glyph->pixel_width;
4451 ++desired_glyph, ++current_glyph, ++i;
4452 skip_first_p = 0;
4455 if (i == start_hpos || x != current_x)
4457 i = start_hpos;
4458 x = start_x;
4459 desired_glyph = start;
4460 break;
4463 rif->cursor_to (vpos, start_hpos, desired_row->y, start_x);
4464 rif->write_glyphs (start, i - start_hpos);
4465 changed_p = 1;
4469 /* Write the rest. */
4470 if (i < desired_row->used[TEXT_AREA])
4472 rif->cursor_to (vpos, i, desired_row->y, x);
4473 rif->write_glyphs (desired_glyph, desired_row->used[TEXT_AREA] - i);
4474 changed_p = 1;
4477 /* Maybe clear to end of line. */
4478 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row))
4480 /* If new row extends to the end of the text area, nothing
4481 has to be cleared, if and only if we did a write_glyphs
4482 above. This is made sure by setting desired_stop_pos
4483 appropriately above. */
4484 xassert (i < desired_row->used[TEXT_AREA]
4485 || ((desired_row->used[TEXT_AREA]
4486 == current_row->used[TEXT_AREA])
4487 && MATRIX_ROW_EXTENDS_FACE_P (current_row)));
4489 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row))
4491 /* If old row extends to the end of the text area, clear. */
4492 if (i >= desired_row->used[TEXT_AREA])
4493 rif->cursor_to (vpos, i, desired_row->y,
4494 desired_row->pixel_width);
4495 rif->clear_end_of_line (-1);
4496 changed_p = 1;
4498 else if (desired_row->pixel_width < current_row->pixel_width)
4500 /* Otherwise clear to the end of the old row. Everything
4501 after that position should be clear already. */
4502 int x;
4504 if (i >= desired_row->used[TEXT_AREA])
4505 rif->cursor_to (vpos, i, desired_row->y,
4506 desired_row->pixel_width);
4508 /* If cursor is displayed at the end of the line, make sure
4509 it's cleared. Nowadays we don't have a phys_cursor_glyph
4510 with which to erase the cursor (because this method
4511 doesn't work with lbearing/rbearing), so we must do it
4512 this way. */
4513 if (vpos == w->phys_cursor.vpos
4514 && w->phys_cursor.hpos >= desired_row->used[TEXT_AREA])
4516 w->phys_cursor_on_p = 0;
4517 x = -1;
4519 else
4520 x = current_row->pixel_width;
4521 rif->clear_end_of_line (x);
4522 changed_p = 1;
4526 return changed_p;
4530 /* Update row VPOS in window W. Value is non-zero if display has been
4531 changed. */
4533 static int
4534 update_window_line (w, vpos, mouse_face_overwritten_p)
4535 struct window *w;
4536 int vpos, *mouse_face_overwritten_p;
4538 struct glyph_row *current_row = MATRIX_ROW (w->current_matrix, vpos);
4539 struct glyph_row *desired_row = MATRIX_ROW (w->desired_matrix, vpos);
4540 int changed_p = 0;
4542 /* Set the row being updated. This is important to let xterm.c
4543 know what line height values are in effect. */
4544 updated_row = desired_row;
4546 /* A row can be completely invisible in case a desired matrix was
4547 built with a vscroll and then make_cursor_line_fully_visible shifts
4548 the matrix. Make sure to make such rows current anyway, since
4549 we need the correct y-position, for example, in the current matrix. */
4550 if (desired_row->mode_line_p
4551 || desired_row->visible_height > 0)
4553 xassert (desired_row->enabled_p);
4555 /* Update display of the left margin area, if there is one. */
4556 if (!desired_row->full_width_p
4557 && !NILP (w->left_margin_cols))
4559 changed_p = 1;
4560 update_marginal_area (w, LEFT_MARGIN_AREA, vpos);
4563 /* Update the display of the text area. */
4564 if (update_text_area (w, vpos))
4566 changed_p = 1;
4567 if (current_row->mouse_face_p)
4568 *mouse_face_overwritten_p = 1;
4571 /* Update display of the right margin area, if there is one. */
4572 if (!desired_row->full_width_p
4573 && !NILP (w->right_margin_cols))
4575 changed_p = 1;
4576 update_marginal_area (w, RIGHT_MARGIN_AREA, vpos);
4579 /* Draw truncation marks etc. */
4580 if (!current_row->enabled_p
4581 || desired_row->y != current_row->y
4582 || desired_row->visible_height != current_row->visible_height
4583 || desired_row->cursor_in_fringe_p != current_row->cursor_in_fringe_p
4584 || desired_row->overlay_arrow_bitmap != current_row->overlay_arrow_bitmap
4585 || current_row->redraw_fringe_bitmaps_p
4586 || desired_row->mode_line_p != current_row->mode_line_p
4587 || desired_row->exact_window_width_line_p != current_row->exact_window_width_line_p
4588 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row)
4589 != MATRIX_ROW_CONTINUATION_LINE_P (current_row)))
4590 rif->after_update_window_line_hook (desired_row);
4593 /* Update current_row from desired_row. */
4594 make_current (w->desired_matrix, w->current_matrix, vpos);
4595 updated_row = NULL;
4596 return changed_p;
4600 /* Set the cursor after an update of window W. This function may only
4601 be called from update_window. */
4603 static void
4604 set_window_cursor_after_update (w)
4605 struct window *w;
4607 struct frame *f = XFRAME (w->frame);
4608 int cx, cy, vpos, hpos;
4610 /* Not intended for frame matrix updates. */
4611 xassert (FRAME_WINDOW_P (f));
4613 if (cursor_in_echo_area
4614 && !NILP (echo_area_buffer[0])
4615 /* If we are showing a message instead of the mini-buffer,
4616 show the cursor for the message instead. */
4617 && XWINDOW (minibuf_window) == w
4618 && EQ (minibuf_window, echo_area_window)
4619 /* These cases apply only to the frame that contains
4620 the active mini-buffer window. */
4621 && FRAME_HAS_MINIBUF_P (f)
4622 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
4624 cx = cy = vpos = hpos = 0;
4626 if (cursor_in_echo_area >= 0)
4628 /* If the mini-buffer is several lines high, find the last
4629 line that has any text on it. Note: either all lines
4630 are enabled or none. Otherwise we wouldn't be able to
4631 determine Y. */
4632 struct glyph_row *row, *last_row;
4633 struct glyph *glyph;
4634 int yb = window_text_bottom_y (w);
4636 last_row = NULL;
4637 row = w->current_matrix->rows;
4638 while (row->enabled_p
4639 && (last_row == NULL
4640 || MATRIX_ROW_BOTTOM_Y (row) <= yb))
4642 if (row->used[TEXT_AREA]
4643 && row->glyphs[TEXT_AREA][0].charpos >= 0)
4644 last_row = row;
4645 ++row;
4648 if (last_row)
4650 struct glyph *start = last_row->glyphs[TEXT_AREA];
4651 struct glyph *last = start + last_row->used[TEXT_AREA] - 1;
4653 while (last > start && last->charpos < 0)
4654 --last;
4656 for (glyph = start; glyph < last; ++glyph)
4658 cx += glyph->pixel_width;
4659 ++hpos;
4662 cy = last_row->y;
4663 vpos = MATRIX_ROW_VPOS (last_row, w->current_matrix);
4667 else
4669 cx = w->cursor.x;
4670 cy = w->cursor.y;
4671 hpos = w->cursor.hpos;
4672 vpos = w->cursor.vpos;
4675 /* Window cursor can be out of sync for horizontally split windows. */
4676 hpos = max (0, hpos);
4677 hpos = min (w->current_matrix->matrix_w - 1, hpos);
4678 vpos = max (0, vpos);
4679 vpos = min (w->current_matrix->nrows - 1, vpos);
4680 rif->cursor_to (vpos, hpos, cy, cx);
4684 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4685 tree rooted at W. */
4687 void
4688 set_window_update_flags (w, on_p)
4689 struct window *w;
4690 int on_p;
4692 while (w)
4694 if (!NILP (w->hchild))
4695 set_window_update_flags (XWINDOW (w->hchild), on_p);
4696 else if (!NILP (w->vchild))
4697 set_window_update_flags (XWINDOW (w->vchild), on_p);
4698 else
4699 w->must_be_updated_p = on_p;
4701 w = NILP (w->next) ? 0 : XWINDOW (w->next);
4707 /***********************************************************************
4708 Window-Based Scrolling
4709 ***********************************************************************/
4711 /* Structure describing rows in scrolling_window. */
4713 struct row_entry
4715 /* Number of occurrences of this row in desired and current matrix. */
4716 int old_uses, new_uses;
4718 /* Vpos of row in new matrix. */
4719 int new_line_number;
4721 /* Bucket index of this row_entry in the hash table row_table. */
4722 int bucket;
4724 /* The row described by this entry. */
4725 struct glyph_row *row;
4727 /* Hash collision chain. */
4728 struct row_entry *next;
4731 /* A pool to allocate row_entry structures from, and the size of the
4732 pool. The pool is reallocated in scrolling_window when we find
4733 that we need a larger one. */
4735 static struct row_entry *row_entry_pool;
4736 static int row_entry_pool_size;
4738 /* Index of next free entry in row_entry_pool. */
4740 static int row_entry_idx;
4742 /* The hash table used during scrolling, and the table's size. This
4743 table is used to quickly identify equal rows in the desired and
4744 current matrix. */
4746 static struct row_entry **row_table;
4747 static int row_table_size;
4749 /* Vectors of pointers to row_entry structures belonging to the
4750 current and desired matrix, and the size of the vectors. */
4752 static struct row_entry **old_lines, **new_lines;
4753 static int old_lines_size, new_lines_size;
4755 /* A pool to allocate run structures from, and its size. */
4757 static struct run *run_pool;
4758 static int runs_size;
4760 /* A vector of runs of lines found during scrolling. */
4762 static struct run **runs;
4764 /* Add glyph row ROW to the scrolling hash table during the scrolling
4765 of window W. */
4767 static INLINE struct row_entry *
4768 add_row_entry (w, row)
4769 struct window *w;
4770 struct glyph_row *row;
4772 struct row_entry *entry;
4773 int i = row->hash % row_table_size;
4775 entry = row_table[i];
4776 while (entry && !row_equal_p (w, entry->row, row, 1))
4777 entry = entry->next;
4779 if (entry == NULL)
4781 entry = row_entry_pool + row_entry_idx++;
4782 entry->row = row;
4783 entry->old_uses = entry->new_uses = 0;
4784 entry->new_line_number = 0;
4785 entry->bucket = i;
4786 entry->next = row_table[i];
4787 row_table[i] = entry;
4790 return entry;
4794 /* Try to reuse part of the current display of W by scrolling lines.
4795 HEADER_LINE_P non-zero means W has a header line.
4797 The algorithm is taken from Communications of the ACM, Apr78 "A
4798 Technique for Isolating Differences Between Files." It should take
4799 O(N) time.
4801 A short outline of the steps of the algorithm
4803 1. Skip lines equal at the start and end of both matrices.
4805 2. Enter rows in the current and desired matrix into a symbol
4806 table, counting how often they appear in both matrices.
4808 3. Rows that appear exactly once in both matrices serve as anchors,
4809 i.e. we assume that such lines are likely to have been moved.
4811 4. Starting from anchor lines, extend regions to be scrolled both
4812 forward and backward.
4814 Value is
4816 -1 if all rows were found to be equal.
4817 0 to indicate that we did not scroll the display, or
4818 1 if we did scroll. */
4820 static int
4821 scrolling_window (w, header_line_p)
4822 struct window *w;
4823 int header_line_p;
4825 struct glyph_matrix *desired_matrix = w->desired_matrix;
4826 struct glyph_matrix *current_matrix = w->current_matrix;
4827 int yb = window_text_bottom_y (w);
4828 int i, j, first_old, first_new, last_old, last_new;
4829 int nruns, nbytes, n, run_idx;
4830 struct row_entry *entry;
4832 /* Skip over rows equal at the start. */
4833 for (i = header_line_p ? 1 : 0; i < current_matrix->nrows - 1; ++i)
4835 struct glyph_row *d = MATRIX_ROW (desired_matrix, i);
4836 struct glyph_row *c = MATRIX_ROW (current_matrix, i);
4838 if (c->enabled_p
4839 && d->enabled_p
4840 && !d->redraw_fringe_bitmaps_p
4841 && c->y == d->y
4842 && MATRIX_ROW_BOTTOM_Y (c) <= yb
4843 && MATRIX_ROW_BOTTOM_Y (d) <= yb
4844 && row_equal_p (w, c, d, 1))
4846 assign_row (c, d);
4847 d->enabled_p = 0;
4849 else
4850 break;
4853 /* Give up if some rows in the desired matrix are not enabled. */
4854 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4855 return -1;
4857 first_old = first_new = i;
4859 /* Set last_new to the index + 1 of the last enabled row in the
4860 desired matrix. */
4861 i = first_new + 1;
4862 while (i < desired_matrix->nrows - 1
4863 && MATRIX_ROW (desired_matrix, i)->enabled_p
4864 && MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix, i)) <= yb)
4865 ++i;
4867 if (!MATRIX_ROW (desired_matrix, i)->enabled_p)
4868 return 0;
4870 last_new = i;
4872 /* Set last_old to the index + 1 of the last enabled row in the
4873 current matrix. We don't look at the enabled flag here because
4874 we plan to reuse part of the display even if other parts are
4875 disabled. */
4876 i = first_old + 1;
4877 while (i < current_matrix->nrows - 1)
4879 int bottom = MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix, i));
4880 if (bottom <= yb)
4881 ++i;
4882 if (bottom >= yb)
4883 break;
4886 last_old = i;
4888 /* Skip over rows equal at the bottom. */
4889 i = last_new;
4890 j = last_old;
4891 while (i - 1 > first_new
4892 && j - 1 > first_old
4893 && MATRIX_ROW (current_matrix, i - 1)->enabled_p
4894 && (MATRIX_ROW (current_matrix, i - 1)->y
4895 == MATRIX_ROW (desired_matrix, j - 1)->y)
4896 && !MATRIX_ROW (desired_matrix, j - 1)->redraw_fringe_bitmaps_p
4897 && row_equal_p (w,
4898 MATRIX_ROW (desired_matrix, i - 1),
4899 MATRIX_ROW (current_matrix, j - 1), 1))
4900 --i, --j;
4901 last_new = i;
4902 last_old = j;
4904 /* Nothing to do if all rows are equal. */
4905 if (last_new == first_new)
4906 return 0;
4908 /* Reallocate vectors, tables etc. if necessary. */
4910 if (current_matrix->nrows > old_lines_size)
4912 old_lines_size = current_matrix->nrows;
4913 nbytes = old_lines_size * sizeof *old_lines;
4914 old_lines = (struct row_entry **) xrealloc (old_lines, nbytes);
4917 if (desired_matrix->nrows > new_lines_size)
4919 new_lines_size = desired_matrix->nrows;
4920 nbytes = new_lines_size * sizeof *new_lines;
4921 new_lines = (struct row_entry **) xrealloc (new_lines, nbytes);
4924 n = desired_matrix->nrows + current_matrix->nrows;
4925 if (3 * n > row_table_size)
4927 row_table_size = next_almost_prime (3 * n);
4928 nbytes = row_table_size * sizeof *row_table;
4929 row_table = (struct row_entry **) xrealloc (row_table, nbytes);
4930 bzero (row_table, nbytes);
4933 if (n > row_entry_pool_size)
4935 row_entry_pool_size = n;
4936 nbytes = row_entry_pool_size * sizeof *row_entry_pool;
4937 row_entry_pool = (struct row_entry *) xrealloc (row_entry_pool, nbytes);
4940 if (desired_matrix->nrows > runs_size)
4942 runs_size = desired_matrix->nrows;
4943 nbytes = runs_size * sizeof *runs;
4944 runs = (struct run **) xrealloc (runs, nbytes);
4945 nbytes = runs_size * sizeof *run_pool;
4946 run_pool = (struct run *) xrealloc (run_pool, nbytes);
4949 nruns = run_idx = 0;
4950 row_entry_idx = 0;
4952 /* Add rows from the current and desired matrix to the hash table
4953 row_hash_table to be able to find equal ones quickly. */
4955 for (i = first_old; i < last_old; ++i)
4957 if (MATRIX_ROW (current_matrix, i)->enabled_p)
4959 entry = add_row_entry (w, MATRIX_ROW (current_matrix, i));
4960 old_lines[i] = entry;
4961 ++entry->old_uses;
4963 else
4964 old_lines[i] = NULL;
4967 for (i = first_new; i < last_new; ++i)
4969 xassert (MATRIX_ROW_ENABLED_P (desired_matrix, i));
4970 entry = add_row_entry (w, MATRIX_ROW (desired_matrix, i));
4971 ++entry->new_uses;
4972 entry->new_line_number = i;
4973 new_lines[i] = entry;
4976 /* Identify moves based on lines that are unique and equal
4977 in both matrices. */
4978 for (i = first_old; i < last_old;)
4979 if (old_lines[i]
4980 && old_lines[i]->old_uses == 1
4981 && old_lines[i]->new_uses == 1)
4983 int j, k;
4984 int new_line = old_lines[i]->new_line_number;
4985 struct run *run = run_pool + run_idx++;
4987 /* Record move. */
4988 run->current_vpos = i;
4989 run->current_y = MATRIX_ROW (current_matrix, i)->y;
4990 run->desired_vpos = new_line;
4991 run->desired_y = MATRIX_ROW (desired_matrix, new_line)->y;
4992 run->nrows = 1;
4993 run->height = MATRIX_ROW (current_matrix, i)->height;
4995 /* Extend backward. */
4996 j = i - 1;
4997 k = new_line - 1;
4998 while (j > first_old
4999 && k > first_new
5000 && old_lines[j] == new_lines[k])
5002 int h = MATRIX_ROW (current_matrix, j)->height;
5003 --run->current_vpos;
5004 --run->desired_vpos;
5005 ++run->nrows;
5006 run->height += h;
5007 run->desired_y -= h;
5008 run->current_y -= h;
5009 --j, --k;
5012 /* Extend forward. */
5013 j = i + 1;
5014 k = new_line + 1;
5015 while (j < last_old
5016 && k < last_new
5017 && old_lines[j] == new_lines[k])
5019 int h = MATRIX_ROW (current_matrix, j)->height;
5020 ++run->nrows;
5021 run->height += h;
5022 ++j, ++k;
5025 /* Insert run into list of all runs. Order runs by copied
5026 pixel lines. Note that we record runs that don't have to
5027 be copied because they are already in place. This is done
5028 because we can avoid calling update_window_line in this
5029 case. */
5030 for (j = 0; j < nruns && runs[j]->height > run->height; ++j)
5032 for (k = nruns; k > j; --k)
5033 runs[k] = runs[k - 1];
5034 runs[j] = run;
5035 ++nruns;
5037 i += run->nrows;
5039 else
5040 ++i;
5042 /* Do the moves. Do it in a way that we don't overwrite something
5043 we want to copy later on. This is not solvable in general
5044 because there is only one display and we don't have a way to
5045 exchange areas on this display. Example:
5047 +-----------+ +-----------+
5048 | A | | B |
5049 +-----------+ --> +-----------+
5050 | B | | A |
5051 +-----------+ +-----------+
5053 Instead, prefer bigger moves, and invalidate moves that would
5054 copy from where we copied to. */
5056 for (i = 0; i < nruns; ++i)
5057 if (runs[i]->nrows > 0)
5059 struct run *r = runs[i];
5061 /* Copy on the display. */
5062 if (r->current_y != r->desired_y)
5064 rif->scroll_run_hook (w, r);
5066 /* Invalidate runs that copy from where we copied to. */
5067 for (j = i + 1; j < nruns; ++j)
5069 struct run *p = runs[j];
5071 if ((p->current_y >= r->desired_y
5072 && p->current_y < r->desired_y + r->height)
5073 || (p->current_y + p->height >= r->desired_y
5074 && (p->current_y + p->height
5075 < r->desired_y + r->height)))
5076 p->nrows = 0;
5080 /* Assign matrix rows. */
5081 for (j = 0; j < r->nrows; ++j)
5083 struct glyph_row *from, *to;
5084 int to_overlapped_p;
5086 to = MATRIX_ROW (current_matrix, r->desired_vpos + j);
5087 from = MATRIX_ROW (desired_matrix, r->desired_vpos + j);
5088 to_overlapped_p = to->overlapped_p;
5089 if (!from->mode_line_p && !w->pseudo_window_p
5090 && (to->left_fringe_bitmap != from->left_fringe_bitmap
5091 || to->right_fringe_bitmap != from->right_fringe_bitmap
5092 || to->left_fringe_face_id != from->left_fringe_face_id
5093 || to->right_fringe_face_id != from->right_fringe_face_id
5094 || to->overlay_arrow_bitmap != from->overlay_arrow_bitmap))
5095 from->redraw_fringe_bitmaps_p = 1;
5096 assign_row (to, from);
5097 to->enabled_p = 1, from->enabled_p = 0;
5098 to->overlapped_p = to_overlapped_p;
5102 /* Clear the hash table, for the next time. */
5103 for (i = 0; i < row_entry_idx; ++i)
5104 row_table[row_entry_pool[i].bucket] = NULL;
5106 /* Value is > 0 to indicate that we scrolled the display. */
5107 return nruns;
5112 /************************************************************************
5113 Frame-Based Updates
5114 ************************************************************************/
5116 /* Update the desired frame matrix of frame F.
5118 FORCE_P non-zero means that the update should not be stopped by
5119 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
5120 should not be tried.
5122 Value is non-zero if update was stopped due to pending input. */
5124 static int
5125 update_frame_1 (f, force_p, inhibit_id_p)
5126 struct frame *f;
5127 int force_p;
5128 int inhibit_id_p;
5130 /* Frame matrices to work on. */
5131 struct glyph_matrix *current_matrix = f->current_matrix;
5132 struct glyph_matrix *desired_matrix = f->desired_matrix;
5133 int i;
5134 int pause;
5135 int preempt_count = baud_rate / 2400 + 1;
5136 extern int input_pending;
5138 xassert (current_matrix && desired_matrix);
5140 if (baud_rate != FRAME_COST_BAUD_RATE (f))
5141 calculate_costs (f);
5143 if (preempt_count <= 0)
5144 preempt_count = 1;
5146 if (redisplay_dont_pause)
5147 force_p = 1;
5148 else if (!force_p && detect_input_pending_ignore_squeezables ())
5150 pause = 1;
5151 goto do_pause;
5154 /* If we cannot insert/delete lines, it's no use trying it. */
5155 if (!line_ins_del_ok)
5156 inhibit_id_p = 1;
5158 /* See if any of the desired lines are enabled; don't compute for
5159 i/d line if just want cursor motion. */
5160 for (i = 0; i < desired_matrix->nrows; i++)
5161 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5162 break;
5164 /* Try doing i/d line, if not yet inhibited. */
5165 if (!inhibit_id_p && i < desired_matrix->nrows)
5166 force_p |= scrolling (f);
5168 /* Update the individual lines as needed. Do bottom line first. */
5169 if (MATRIX_ROW_ENABLED_P (desired_matrix, desired_matrix->nrows - 1))
5170 update_frame_line (f, desired_matrix->nrows - 1);
5172 /* Now update the rest of the lines. */
5173 for (i = 0; i < desired_matrix->nrows - 1 && (force_p || !input_pending); i++)
5175 if (MATRIX_ROW_ENABLED_P (desired_matrix, i))
5177 if (FRAME_TERMCAP_P (f))
5179 /* Flush out every so many lines.
5180 Also flush out if likely to have more than 1k buffered
5181 otherwise. I'm told that some telnet connections get
5182 really screwed by more than 1k output at once. */
5183 int outq = PENDING_OUTPUT_COUNT (stdout);
5184 if (outq > 900
5185 || (outq > 20 && ((i - 1) % preempt_count == 0)))
5187 fflush (stdout);
5188 if (preempt_count == 1)
5190 #ifdef EMACS_OUTQSIZE
5191 if (EMACS_OUTQSIZE (0, &outq) < 0)
5192 /* Probably not a tty. Ignore the error and reset
5193 the outq count. */
5194 outq = PENDING_OUTPUT_COUNT (stdout);
5195 #endif
5196 outq *= 10;
5197 if (baud_rate <= outq && baud_rate > 0)
5198 sleep (outq / baud_rate);
5203 if ((i - 1) % preempt_count == 0)
5204 detect_input_pending_ignore_squeezables ();
5206 update_frame_line (f, i);
5210 pause = (i < FRAME_LINES (f) - 1) ? i : 0;
5212 /* Now just clean up termcap drivers and set cursor, etc. */
5213 if (!pause)
5215 if ((cursor_in_echo_area
5216 /* If we are showing a message instead of the mini-buffer,
5217 show the cursor for the message instead of for the
5218 (now hidden) mini-buffer contents. */
5219 || (EQ (minibuf_window, selected_window)
5220 && EQ (minibuf_window, echo_area_window)
5221 && !NILP (echo_area_buffer[0])))
5222 /* These cases apply only to the frame that contains
5223 the active mini-buffer window. */
5224 && FRAME_HAS_MINIBUF_P (f)
5225 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
5227 int top = WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f)));
5228 int row, col;
5230 if (cursor_in_echo_area < 0)
5232 /* Negative value of cursor_in_echo_area means put
5233 cursor at beginning of line. */
5234 row = top;
5235 col = 0;
5237 else
5239 /* Positive value of cursor_in_echo_area means put
5240 cursor at the end of the prompt. If the mini-buffer
5241 is several lines high, find the last line that has
5242 any text on it. */
5243 row = FRAME_LINES (f);
5246 --row;
5247 col = 0;
5249 if (MATRIX_ROW_ENABLED_P (current_matrix, row))
5251 /* Frame rows are filled up with spaces that
5252 must be ignored here. */
5253 struct glyph_row *r = MATRIX_ROW (current_matrix,
5254 row);
5255 struct glyph *start = r->glyphs[TEXT_AREA];
5256 struct glyph *last = start + r->used[TEXT_AREA];
5258 while (last > start
5259 && (last - 1)->charpos < 0)
5260 --last;
5262 col = last - start;
5265 while (row > top && col == 0);
5267 /* Make sure COL is not out of range. */
5268 if (col >= FRAME_CURSOR_X_LIMIT (f))
5270 /* If we have another row, advance cursor into it. */
5271 if (row < FRAME_LINES (f) - 1)
5273 col = FRAME_LEFT_SCROLL_BAR_COLS (f);
5274 row++;
5276 /* Otherwise move it back in range. */
5277 else
5278 col = FRAME_CURSOR_X_LIMIT (f) - 1;
5282 cursor_to (row, col);
5284 else
5286 /* We have only one cursor on terminal frames. Use it to
5287 display the cursor of the selected window. */
5288 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
5289 if (w->cursor.vpos >= 0
5290 /* The cursor vpos may be temporarily out of bounds
5291 in the following situation: There is one window,
5292 with the cursor in the lower half of it. The window
5293 is split, and a message causes a redisplay before
5294 a new cursor position has been computed. */
5295 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
5297 int x = WINDOW_TO_FRAME_HPOS (w, w->cursor.hpos);
5298 int y = WINDOW_TO_FRAME_VPOS (w, w->cursor.vpos);
5300 if (INTEGERP (w->left_margin_cols))
5301 x += XFASTINT (w->left_margin_cols);
5303 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
5304 cursor_to (y, x);
5309 do_pause:
5311 clear_desired_matrices (f);
5312 return pause;
5316 /* Do line insertions/deletions on frame F for frame-based redisplay. */
5319 scrolling (frame)
5320 struct frame *frame;
5322 int unchanged_at_top, unchanged_at_bottom;
5323 int window_size;
5324 int changed_lines;
5325 int *old_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5326 int *new_hash = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5327 int *draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5328 int *old_draw_cost = (int *) alloca (FRAME_LINES (frame) * sizeof (int));
5329 register int i;
5330 int free_at_end_vpos = FRAME_LINES (frame);
5331 struct glyph_matrix *current_matrix = frame->current_matrix;
5332 struct glyph_matrix *desired_matrix = frame->desired_matrix;
5334 if (!current_matrix)
5335 abort ();
5337 /* Compute hash codes of all the lines. Also calculate number of
5338 changed lines, number of unchanged lines at the beginning, and
5339 number of unchanged lines at the end. */
5340 changed_lines = 0;
5341 unchanged_at_top = 0;
5342 unchanged_at_bottom = FRAME_LINES (frame);
5343 for (i = 0; i < FRAME_LINES (frame); i++)
5345 /* Give up on this scrolling if some old lines are not enabled. */
5346 if (!MATRIX_ROW_ENABLED_P (current_matrix, i))
5347 return 0;
5348 old_hash[i] = line_hash_code (MATRIX_ROW (current_matrix, i));
5349 if (! MATRIX_ROW_ENABLED_P (desired_matrix, i))
5351 /* This line cannot be redrawn, so don't let scrolling mess it. */
5352 new_hash[i] = old_hash[i];
5353 #define INFINITY 1000000 /* Taken from scroll.c */
5354 draw_cost[i] = INFINITY;
5356 else
5358 new_hash[i] = line_hash_code (MATRIX_ROW (desired_matrix, i));
5359 draw_cost[i] = line_draw_cost (desired_matrix, i);
5362 if (old_hash[i] != new_hash[i])
5364 changed_lines++;
5365 unchanged_at_bottom = FRAME_LINES (frame) - i - 1;
5367 else if (i == unchanged_at_top)
5368 unchanged_at_top++;
5369 old_draw_cost[i] = line_draw_cost (current_matrix, i);
5372 /* If changed lines are few, don't allow preemption, don't scroll. */
5373 if ((!scroll_region_ok && changed_lines < baud_rate / 2400)
5374 || unchanged_at_bottom == FRAME_LINES (frame))
5375 return 1;
5377 window_size = (FRAME_LINES (frame) - unchanged_at_top
5378 - unchanged_at_bottom);
5380 if (scroll_region_ok)
5381 free_at_end_vpos -= unchanged_at_bottom;
5382 else if (memory_below_frame)
5383 free_at_end_vpos = -1;
5385 /* If large window, fast terminal and few lines in common between
5386 current frame and desired frame, don't bother with i/d calc. */
5387 if (!scroll_region_ok && window_size >= 18 && baud_rate > 2400
5388 && (window_size >=
5389 10 * scrolling_max_lines_saved (unchanged_at_top,
5390 FRAME_LINES (frame) - unchanged_at_bottom,
5391 old_hash, new_hash, draw_cost)))
5392 return 0;
5394 if (window_size < 2)
5395 return 0;
5397 scrolling_1 (frame, window_size, unchanged_at_top, unchanged_at_bottom,
5398 draw_cost + unchanged_at_top - 1,
5399 old_draw_cost + unchanged_at_top - 1,
5400 old_hash + unchanged_at_top - 1,
5401 new_hash + unchanged_at_top - 1,
5402 free_at_end_vpos - unchanged_at_top);
5404 return 0;
5408 /* Count the number of blanks at the start of the vector of glyphs R
5409 which is LEN glyphs long. */
5411 static int
5412 count_blanks (r, len)
5413 struct glyph *r;
5414 int len;
5416 int i;
5418 for (i = 0; i < len; ++i)
5419 if (!CHAR_GLYPH_SPACE_P (r[i]))
5420 break;
5422 return i;
5426 /* Count the number of glyphs in common at the start of the glyph
5427 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
5428 of STR2. Value is the number of equal glyphs equal at the start. */
5430 static int
5431 count_match (str1, end1, str2, end2)
5432 struct glyph *str1, *end1, *str2, *end2;
5434 struct glyph *p1 = str1;
5435 struct glyph *p2 = str2;
5437 while (p1 < end1
5438 && p2 < end2
5439 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1, p2))
5440 ++p1, ++p2;
5442 return p1 - str1;
5446 /* Char insertion/deletion cost vector, from term.c */
5448 extern int *char_ins_del_vector;
5449 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS((f))])
5452 /* Perform a frame-based update on line VPOS in frame FRAME. */
5454 static void
5455 update_frame_line (f, vpos)
5456 struct frame *f;
5457 int vpos;
5459 struct glyph *obody, *nbody, *op1, *op2, *np1, *nend;
5460 int tem;
5461 int osp, nsp, begmatch, endmatch, olen, nlen;
5462 struct glyph_matrix *current_matrix = f->current_matrix;
5463 struct glyph_matrix *desired_matrix = f->desired_matrix;
5464 struct glyph_row *current_row = MATRIX_ROW (current_matrix, vpos);
5465 struct glyph_row *desired_row = MATRIX_ROW (desired_matrix, vpos);
5466 int must_write_whole_line_p;
5467 int write_spaces_p = must_write_spaces;
5468 int colored_spaces_p = (FACE_FROM_ID (f, DEFAULT_FACE_ID)->background
5469 != FACE_TTY_DEFAULT_BG_COLOR);
5471 if (colored_spaces_p)
5472 write_spaces_p = 1;
5474 /* Current row not enabled means it has unknown contents. We must
5475 write the whole desired line in that case. */
5476 must_write_whole_line_p = !current_row->enabled_p;
5477 if (must_write_whole_line_p)
5479 obody = 0;
5480 olen = 0;
5482 else
5484 obody = MATRIX_ROW_GLYPH_START (current_matrix, vpos);
5485 olen = current_row->used[TEXT_AREA];
5487 /* Ignore trailing spaces, if we can. */
5488 if (!write_spaces_p)
5489 while (olen > 0 && CHAR_GLYPH_SPACE_P (obody[olen-1]))
5490 olen--;
5493 current_row->enabled_p = 1;
5494 current_row->used[TEXT_AREA] = desired_row->used[TEXT_AREA];
5496 /* If desired line is empty, just clear the line. */
5497 if (!desired_row->enabled_p)
5499 nlen = 0;
5500 goto just_erase;
5503 nbody = desired_row->glyphs[TEXT_AREA];
5504 nlen = desired_row->used[TEXT_AREA];
5505 nend = nbody + nlen;
5507 /* If display line has unknown contents, write the whole line. */
5508 if (must_write_whole_line_p)
5510 /* Ignore spaces at the end, if we can. */
5511 if (!write_spaces_p)
5512 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5513 --nlen;
5515 /* Write the contents of the desired line. */
5516 if (nlen)
5518 cursor_to (vpos, 0);
5519 write_glyphs (nbody, nlen);
5522 /* Don't call clear_end_of_line if we already wrote the whole
5523 line. The cursor will not be at the right margin in that
5524 case but in the line below. */
5525 if (nlen < FRAME_TOTAL_COLS (f))
5527 cursor_to (vpos, nlen);
5528 clear_end_of_line (FRAME_TOTAL_COLS (f));
5530 else
5531 /* Make sure we are in the right row, otherwise cursor movement
5532 with cmgoto might use `ch' in the wrong row. */
5533 cursor_to (vpos, 0);
5535 make_current (desired_matrix, current_matrix, vpos);
5536 return;
5539 /* Pretend trailing spaces are not there at all,
5540 unless for one reason or another we must write all spaces. */
5541 if (!write_spaces_p)
5542 while (nlen > 0 && CHAR_GLYPH_SPACE_P (nbody[nlen - 1]))
5543 nlen--;
5545 /* If there's no i/d char, quickly do the best we can without it. */
5546 if (!char_ins_del_ok)
5548 int i, j;
5550 /* Find the first glyph in desired row that doesn't agree with
5551 a glyph in the current row, and write the rest from there on. */
5552 for (i = 0; i < nlen; i++)
5554 if (i >= olen || !GLYPH_EQUAL_P (nbody + i, obody + i))
5556 /* Find the end of the run of different glyphs. */
5557 j = i + 1;
5558 while (j < nlen
5559 && (j >= olen
5560 || !GLYPH_EQUAL_P (nbody + j, obody + j)
5561 || CHAR_GLYPH_PADDING_P (nbody[j])))
5562 ++j;
5564 /* Output this run of non-matching chars. */
5565 cursor_to (vpos, i);
5566 write_glyphs (nbody + i, j - i);
5567 i = j - 1;
5569 /* Now find the next non-match. */
5573 /* Clear the rest of the line, or the non-clear part of it. */
5574 if (olen > nlen)
5576 cursor_to (vpos, nlen);
5577 clear_end_of_line (olen);
5580 /* Make current row = desired row. */
5581 make_current (desired_matrix, current_matrix, vpos);
5582 return;
5585 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5586 characters in a row. */
5588 if (!olen)
5590 /* If current line is blank, skip over initial spaces, if
5591 possible, and write the rest. */
5592 if (write_spaces_p)
5593 nsp = 0;
5594 else
5595 nsp = count_blanks (nbody, nlen);
5597 if (nlen > nsp)
5599 cursor_to (vpos, nsp);
5600 write_glyphs (nbody + nsp, nlen - nsp);
5603 /* Exchange contents between current_frame and new_frame. */
5604 make_current (desired_matrix, current_matrix, vpos);
5605 return;
5608 /* Compute number of leading blanks in old and new contents. */
5609 osp = count_blanks (obody, olen);
5610 nsp = (colored_spaces_p ? 0 : count_blanks (nbody, nlen));
5612 /* Compute number of matching chars starting with first non-blank. */
5613 begmatch = count_match (obody + osp, obody + olen,
5614 nbody + nsp, nbody + nlen);
5616 /* Spaces in new match implicit space past the end of old. */
5617 /* A bug causing this to be a no-op was fixed in 18.29. */
5618 if (!write_spaces_p && osp + begmatch == olen)
5620 np1 = nbody + nsp;
5621 while (np1 + begmatch < nend && CHAR_GLYPH_SPACE_P (np1[begmatch]))
5622 ++begmatch;
5625 /* Avoid doing insert/delete char
5626 just cause number of leading spaces differs
5627 when the following text does not match. */
5628 if (begmatch == 0 && osp != nsp)
5629 osp = nsp = min (osp, nsp);
5631 /* Find matching characters at end of line */
5632 op1 = obody + olen;
5633 np1 = nbody + nlen;
5634 op2 = op1 + begmatch - min (olen - osp, nlen - nsp);
5635 while (op1 > op2
5636 && GLYPH_EQUAL_P (op1 - 1, np1 - 1))
5638 op1--;
5639 np1--;
5641 endmatch = obody + olen - op1;
5643 /* tem gets the distance to insert or delete.
5644 endmatch is how many characters we save by doing so.
5645 Is it worth it? */
5647 tem = (nlen - nsp) - (olen - osp);
5648 if (endmatch && tem
5649 && (!char_ins_del_ok || endmatch <= char_ins_del_cost (f)[tem]))
5650 endmatch = 0;
5652 /* nsp - osp is the distance to insert or delete.
5653 If that is nonzero, begmatch is known to be nonzero also.
5654 begmatch + endmatch is how much we save by doing the ins/del.
5655 Is it worth it? */
5657 if (nsp != osp
5658 && (!char_ins_del_ok
5659 || begmatch + endmatch <= char_ins_del_cost (f)[nsp - osp]))
5661 begmatch = 0;
5662 endmatch = 0;
5663 osp = nsp = min (osp, nsp);
5666 /* Now go through the line, inserting, writing and
5667 deleting as appropriate. */
5669 if (osp > nsp)
5671 cursor_to (vpos, nsp);
5672 delete_glyphs (osp - nsp);
5674 else if (nsp > osp)
5676 /* If going to delete chars later in line
5677 and insert earlier in the line,
5678 must delete first to avoid losing data in the insert */
5679 if (endmatch && nlen < olen + nsp - osp)
5681 cursor_to (vpos, nlen - endmatch + osp - nsp);
5682 delete_glyphs (olen + nsp - osp - nlen);
5683 olen = nlen - (nsp - osp);
5685 cursor_to (vpos, osp);
5686 insert_glyphs (0, nsp - osp);
5688 olen += nsp - osp;
5690 tem = nsp + begmatch + endmatch;
5691 if (nlen != tem || olen != tem)
5693 if (!endmatch || nlen == olen)
5695 /* If new text being written reaches right margin, there is
5696 no need to do clear-to-eol at the end of this function
5697 (and it would not be safe, since cursor is not going to
5698 be "at the margin" after the text is done). */
5699 if (nlen == FRAME_TOTAL_COLS (f))
5700 olen = 0;
5702 /* Function write_glyphs is prepared to do nothing
5703 if passed a length <= 0. Check it here to avoid
5704 unnecessary cursor movement. */
5705 if (nlen - tem > 0)
5707 cursor_to (vpos, nsp + begmatch);
5708 write_glyphs (nbody + nsp + begmatch, nlen - tem);
5711 else if (nlen > olen)
5713 /* Here, we used to have the following simple code:
5714 ----------------------------------------
5715 write_glyphs (nbody + nsp + begmatch, olen - tem);
5716 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5717 ----------------------------------------
5718 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5719 is a padding glyph. */
5720 int out = olen - tem; /* Columns to be overwritten originally. */
5721 int del;
5723 cursor_to (vpos, nsp + begmatch);
5725 /* Calculate columns we can actually overwrite. */
5726 while (CHAR_GLYPH_PADDING_P (nbody[nsp + begmatch + out]))
5727 out--;
5728 write_glyphs (nbody + nsp + begmatch, out);
5730 /* If we left columns to be overwritten, we must delete them. */
5731 del = olen - tem - out;
5732 if (del > 0)
5733 delete_glyphs (del);
5735 /* At last, we insert columns not yet written out. */
5736 insert_glyphs (nbody + nsp + begmatch + out, nlen - olen + del);
5737 olen = nlen;
5739 else if (olen > nlen)
5741 cursor_to (vpos, nsp + begmatch);
5742 write_glyphs (nbody + nsp + begmatch, nlen - tem);
5743 delete_glyphs (olen - nlen);
5744 olen = nlen;
5748 just_erase:
5749 /* If any unerased characters remain after the new line, erase them. */
5750 if (olen > nlen)
5752 cursor_to (vpos, nlen);
5753 clear_end_of_line (olen);
5756 /* Exchange contents between current_frame and new_frame. */
5757 make_current (desired_matrix, current_matrix, vpos);
5762 /***********************************************************************
5763 X/Y Position -> Buffer Position
5764 ***********************************************************************/
5766 /* Determine what's under window-relative pixel position (*X, *Y).
5767 Return the object (string or buffer) that's there.
5768 Return in *POS the position in that object.
5769 Adjust *X and *Y to character positions. */
5771 Lisp_Object
5772 buffer_posn_from_coords (w, x, y, pos, object, dx, dy, width, height)
5773 struct window *w;
5774 int *x, *y;
5775 struct display_pos *pos;
5776 Lisp_Object *object;
5777 int *dx, *dy;
5778 int *width, *height;
5780 struct it it;
5781 struct buffer *old_current_buffer = current_buffer;
5782 struct text_pos startp;
5783 Lisp_Object string;
5784 struct glyph_row *row;
5785 #ifdef HAVE_WINDOW_SYSTEM
5786 struct image *img = 0;
5787 #endif
5788 int x0, x1;
5790 current_buffer = XBUFFER (w->buffer);
5791 SET_TEXT_POS_FROM_MARKER (startp, w->start);
5792 CHARPOS (startp) = min (ZV, max (BEGV, CHARPOS (startp)));
5793 BYTEPOS (startp) = min (ZV_BYTE, max (BEGV_BYTE, BYTEPOS (startp)));
5794 start_display (&it, w, startp);
5796 x0 = *x - WINDOW_LEFT_MARGIN_WIDTH (w);
5797 move_it_to (&it, -1, x0 + it.first_visible_x, *y, -1,
5798 MOVE_TO_X | MOVE_TO_Y);
5800 current_buffer = old_current_buffer;
5802 *dx = x0 + it.first_visible_x - it.current_x;
5803 *dy = *y - it.current_y;
5805 string = w->buffer;
5806 if (STRINGP (it.string))
5807 string = it.string;
5808 *pos = it.current;
5810 #ifdef HAVE_WINDOW_SYSTEM
5811 if (it.what == IT_IMAGE)
5813 if ((img = IMAGE_FROM_ID (it.f, it.image_id)) != NULL
5814 && !NILP (img->spec))
5815 *object = img->spec;
5817 #endif
5819 if (it.vpos < w->current_matrix->nrows
5820 && (row = MATRIX_ROW (w->current_matrix, it.vpos),
5821 row->enabled_p))
5823 if (it.hpos < row->used[TEXT_AREA])
5825 struct glyph *glyph = row->glyphs[TEXT_AREA] + it.hpos;
5826 #ifdef HAVE_WINDOW_SYSTEM
5827 if (img)
5829 *dy -= row->ascent - glyph->ascent;
5830 *dx += glyph->slice.x;
5831 *dy += glyph->slice.y;
5832 /* Image slices positions are still relative to the entire image */
5833 *width = img->width;
5834 *height = img->height;
5836 else
5837 #endif
5839 *width = glyph->pixel_width;
5840 *height = glyph->ascent + glyph->descent;
5843 else
5845 *width = 0;
5846 *height = row->height;
5849 else
5851 *width = *height = 0;
5854 /* Add extra (default width) columns if clicked after EOL. */
5855 x1 = max(0, it.current_x + it.pixel_width - it.first_visible_x);
5856 if (x0 > x1)
5857 it.hpos += (x0 - x1) / WINDOW_FRAME_COLUMN_WIDTH (w);
5859 *x = it.hpos;
5860 *y = it.vpos;
5862 return string;
5866 /* Value is the string under window-relative coordinates X/Y in the
5867 mode line or header line (PART says which) of window W, or nil if none.
5868 *CHARPOS is set to the position in the string returned. */
5870 Lisp_Object
5871 mode_line_string (w, part, x, y, charpos, object, dx, dy, width, height)
5872 struct window *w;
5873 enum window_part part;
5874 int *x, *y;
5875 int *charpos;
5876 Lisp_Object *object;
5877 int *dx, *dy;
5878 int *width, *height;
5880 struct glyph_row *row;
5881 struct glyph *glyph, *end;
5882 int x0, y0;
5883 Lisp_Object string = Qnil;
5885 if (part == ON_MODE_LINE)
5886 row = MATRIX_MODE_LINE_ROW (w->current_matrix);
5887 else
5888 row = MATRIX_HEADER_LINE_ROW (w->current_matrix);
5889 y0 = *y - row->y;
5890 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
5892 if (row->mode_line_p && row->enabled_p)
5894 /* Find the glyph under X. If we find one with a string object,
5895 it's the one we were looking for. */
5896 glyph = row->glyphs[TEXT_AREA];
5897 end = glyph + row->used[TEXT_AREA];
5898 for (x0 = *x; glyph < end && x0 >= glyph->pixel_width; ++glyph)
5899 x0 -= glyph->pixel_width;
5900 *x = glyph - row->glyphs[TEXT_AREA];
5901 if (glyph < end)
5903 string = glyph->object;
5904 *charpos = glyph->charpos;
5905 *width = glyph->pixel_width;
5906 *height = glyph->ascent + glyph->descent;
5907 #ifdef HAVE_WINDOW_SYSTEM
5908 if (glyph->type == IMAGE_GLYPH)
5910 struct image *img;
5911 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
5912 if (img != NULL)
5913 *object = img->spec;
5914 y0 -= row->ascent - glyph->ascent;
5916 #endif
5918 else
5920 /* Add extra (default width) columns if clicked after EOL. */
5921 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
5922 *width = 0;
5923 *height = row->height;
5926 else
5928 *x = 0;
5929 x0 = 0;
5930 *width = *height = 0;
5933 *dx = x0;
5934 *dy = y0;
5936 return string;
5940 /* Value is the string under window-relative coordinates X/Y in either
5941 marginal area, or nil if none. *CHARPOS is set to the position in
5942 the string returned. */
5944 Lisp_Object
5945 marginal_area_string (w, part, x, y, charpos, object, dx, dy, width, height)
5946 struct window *w;
5947 enum window_part part;
5948 int *x, *y;
5949 int *charpos;
5950 Lisp_Object *object;
5951 int *dx, *dy;
5952 int *width, *height;
5954 struct glyph_row *row = w->current_matrix->rows;
5955 struct glyph *glyph, *end;
5956 int x0, y0, i, wy = *y;
5957 int area;
5958 Lisp_Object string = Qnil;
5960 if (part == ON_LEFT_MARGIN)
5961 area = LEFT_MARGIN_AREA;
5962 else if (part == ON_RIGHT_MARGIN)
5963 area = RIGHT_MARGIN_AREA;
5964 else
5965 abort ();
5967 for (i = 0; row->enabled_p && i < w->current_matrix->nrows; ++i, ++row)
5968 if (wy >= row->y && wy < MATRIX_ROW_BOTTOM_Y (row))
5969 break;
5970 y0 = *y - row->y;
5971 *y = row - MATRIX_FIRST_TEXT_ROW (w->current_matrix);
5973 if (row->enabled_p)
5975 /* Find the glyph under X. If we find one with a string object,
5976 it's the one we were looking for. */
5977 if (area == RIGHT_MARGIN_AREA)
5978 x0 = ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5979 ? WINDOW_LEFT_FRINGE_WIDTH (w)
5980 : WINDOW_TOTAL_FRINGE_WIDTH (w))
5981 + window_box_width (w, LEFT_MARGIN_AREA)
5982 + window_box_width (w, TEXT_AREA));
5983 else
5984 x0 = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5985 ? WINDOW_LEFT_FRINGE_WIDTH (w)
5986 : 0);
5988 glyph = row->glyphs[area];
5989 end = glyph + row->used[area];
5990 for (x0 = *x - x0; glyph < end && x0 >= glyph->pixel_width; ++glyph)
5991 x0 -= glyph->pixel_width;
5992 *x = glyph - row->glyphs[area];
5993 if (glyph < end)
5995 string = glyph->object;
5996 *charpos = glyph->charpos;
5997 *width = glyph->pixel_width;
5998 *height = glyph->ascent + glyph->descent;
5999 #ifdef HAVE_WINDOW_SYSTEM
6000 if (glyph->type == IMAGE_GLYPH)
6002 struct image *img;
6003 img = IMAGE_FROM_ID (WINDOW_XFRAME (w), glyph->u.img_id);
6004 if (img != NULL)
6005 *object = img->spec;
6006 y0 -= row->ascent - glyph->ascent;
6007 x0 += glyph->slice.x;
6008 y0 += glyph->slice.y;
6010 #endif
6012 else
6014 /* Add extra (default width) columns if clicked after EOL. */
6015 *x += x0 / WINDOW_FRAME_COLUMN_WIDTH (w);
6016 *width = 0;
6017 *height = row->height;
6020 else
6022 x0 = 0;
6023 *x = 0;
6024 *width = *height = 0;
6027 *dx = x0;
6028 *dy = y0;
6030 return string;
6034 /***********************************************************************
6035 Changing Frame Sizes
6036 ***********************************************************************/
6038 #ifdef SIGWINCH
6040 SIGTYPE
6041 window_change_signal (signalnum) /* If we don't have an argument, */
6042 int signalnum; /* some compilers complain in signal calls. */
6044 int width, height;
6045 #ifndef USE_CRT_DLL
6046 extern int errno;
6047 #endif
6048 int old_errno = errno;
6050 signal (SIGWINCH, window_change_signal);
6051 SIGNAL_THREAD_CHECK (signalnum);
6053 get_frame_size (&width, &height);
6055 /* The frame size change obviously applies to a termcap-controlled
6056 frame. Find such a frame in the list, and assume it's the only
6057 one (since the redisplay code always writes to stdout, not a
6058 FILE * specified in the frame structure). Record the new size,
6059 but don't reallocate the data structures now. Let that be done
6060 later outside of the signal handler. */
6063 Lisp_Object tail, frame;
6065 FOR_EACH_FRAME (tail, frame)
6067 if (FRAME_TERMCAP_P (XFRAME (frame)))
6069 change_frame_size (XFRAME (frame), height, width, 0, 1, 0);
6070 break;
6075 errno = old_errno;
6077 #endif /* SIGWINCH */
6080 /* Do any change in frame size that was requested by a signal. SAFE
6081 non-zero means this function is called from a place where it is
6082 safe to change frame sizes while a redisplay is in progress. */
6084 void
6085 do_pending_window_change (safe)
6086 int safe;
6088 /* If window_change_signal should have run before, run it now. */
6089 if (redisplaying_p && !safe)
6090 return;
6092 while (delayed_size_change)
6094 Lisp_Object tail, frame;
6096 delayed_size_change = 0;
6098 FOR_EACH_FRAME (tail, frame)
6100 struct frame *f = XFRAME (frame);
6102 if (f->new_text_lines != 0 || f->new_text_cols != 0)
6103 change_frame_size (f, f->new_text_lines, f->new_text_cols,
6104 0, 0, safe);
6110 /* Change the frame height and/or width. Values may be given as zero to
6111 indicate no change is to take place.
6113 If DELAY is non-zero, then assume we're being called from a signal
6114 handler, and queue the change for later - perhaps the next
6115 redisplay. Since this tries to resize windows, we can't call it
6116 from a signal handler.
6118 SAFE non-zero means this function is called from a place where it's
6119 safe to change frame sizes while a redisplay is in progress. */
6121 void
6122 change_frame_size (f, newheight, newwidth, pretend, delay, safe)
6123 register struct frame *f;
6124 int newheight, newwidth, pretend, delay, safe;
6126 Lisp_Object tail, frame;
6128 if (! FRAME_WINDOW_P (f))
6130 /* When using termcap, or on MS-DOS, all frames use
6131 the same screen, so a change in size affects all frames. */
6132 FOR_EACH_FRAME (tail, frame)
6133 if (! FRAME_WINDOW_P (XFRAME (frame)))
6134 change_frame_size_1 (XFRAME (frame), newheight, newwidth,
6135 pretend, delay, safe);
6137 else
6138 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe);
6141 static void
6142 change_frame_size_1 (f, newheight, newwidth, pretend, delay, safe)
6143 register struct frame *f;
6144 int newheight, newwidth, pretend, delay, safe;
6146 int new_frame_total_cols;
6147 int count = SPECPDL_INDEX ();
6149 /* If we can't deal with the change now, queue it for later. */
6150 if (delay || (redisplaying_p && !safe))
6152 f->new_text_lines = newheight;
6153 f->new_text_cols = newwidth;
6154 delayed_size_change = 1;
6155 return;
6158 /* This size-change overrides any pending one for this frame. */
6159 f->new_text_lines = 0;
6160 f->new_text_cols = 0;
6162 /* If an argument is zero, set it to the current value. */
6163 if (newheight == 0)
6164 newheight = FRAME_LINES (f);
6165 if (newwidth == 0)
6166 newwidth = FRAME_COLS (f);
6168 /* Compute width of windows in F.
6169 This is the width of the frame without vertical scroll bars. */
6170 new_frame_total_cols = FRAME_TOTAL_COLS_ARG (f, newwidth);
6172 /* Round up to the smallest acceptable size. */
6173 check_frame_size (f, &newheight, &newwidth);
6175 /* If we're not changing the frame size, quit now. */
6176 if (newheight == FRAME_LINES (f)
6177 && new_frame_total_cols == FRAME_TOTAL_COLS (f))
6178 return;
6180 BLOCK_INPUT;
6182 #ifdef MSDOS
6183 /* We only can set screen dimensions to certain values supported
6184 by our video hardware. Try to find the smallest size greater
6185 or equal to the requested dimensions. */
6186 dos_set_window_size (&newheight, &newwidth);
6187 #endif
6189 if (newheight != FRAME_LINES (f))
6191 if (FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
6193 /* Frame has both root and mini-buffer. */
6194 XSETFASTINT (XWINDOW (FRAME_ROOT_WINDOW (f))->top_line,
6195 FRAME_TOP_MARGIN (f));
6196 set_window_height (FRAME_ROOT_WINDOW (f),
6197 (newheight
6199 - FRAME_TOP_MARGIN (f)),
6201 XSETFASTINT (XWINDOW (FRAME_MINIBUF_WINDOW (f))->top_line,
6202 newheight - 1);
6203 set_window_height (FRAME_MINIBUF_WINDOW (f), 1, 0);
6205 else
6206 /* Frame has just one top-level window. */
6207 set_window_height (FRAME_ROOT_WINDOW (f),
6208 newheight - FRAME_TOP_MARGIN (f), 0);
6210 if (FRAME_TERMCAP_P (f) && !pretend)
6211 FrameRows = newheight;
6214 if (new_frame_total_cols != FRAME_TOTAL_COLS (f))
6216 set_window_width (FRAME_ROOT_WINDOW (f), new_frame_total_cols, 0);
6217 if (FRAME_HAS_MINIBUF_P (f))
6218 set_window_width (FRAME_MINIBUF_WINDOW (f), new_frame_total_cols, 0);
6220 if (FRAME_TERMCAP_P (f) && !pretend)
6221 FrameCols = newwidth;
6223 if (WINDOWP (f->tool_bar_window))
6224 XSETFASTINT (XWINDOW (f->tool_bar_window)->total_cols, newwidth);
6227 FRAME_LINES (f) = newheight;
6228 SET_FRAME_COLS (f, newwidth);
6231 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
6232 int text_area_x, text_area_y, text_area_width, text_area_height;
6234 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
6235 &text_area_height);
6236 if (w->cursor.x >= text_area_x + text_area_width)
6237 w->cursor.hpos = w->cursor.x = 0;
6238 if (w->cursor.y >= text_area_y + text_area_height)
6239 w->cursor.vpos = w->cursor.y = 0;
6242 adjust_glyphs (f);
6243 calculate_costs (f);
6244 SET_FRAME_GARBAGED (f);
6245 f->resized_p = 1;
6247 UNBLOCK_INPUT;
6249 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
6251 /* This isn't quite a no-op: it runs window-configuration-change-hook. */
6252 Fset_window_buffer (FRAME_SELECTED_WINDOW (f),
6253 XWINDOW (FRAME_SELECTED_WINDOW (f))->buffer, Qt);
6255 unbind_to (count, Qnil);
6260 /***********************************************************************
6261 Terminal Related Lisp Functions
6262 ***********************************************************************/
6264 DEFUN ("open-termscript", Fopen_termscript, Sopen_termscript,
6265 1, 1, "FOpen termscript file: ",
6266 doc: /* Start writing all terminal output to FILE as well as the terminal.
6267 FILE = nil means just close any termscript file currently open. */)
6268 (file)
6269 Lisp_Object file;
6271 if (termscript != 0) fclose (termscript);
6272 termscript = 0;
6274 if (! NILP (file))
6276 file = Fexpand_file_name (file, Qnil);
6277 termscript = fopen (SDATA (file), "w");
6278 if (termscript == 0)
6279 report_file_error ("Opening termscript", Fcons (file, Qnil));
6281 return Qnil;
6285 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal,
6286 Ssend_string_to_terminal, 1, 1, 0,
6287 doc: /* Send STRING to the terminal without alteration.
6288 Control characters in STRING will have terminal-dependent effects. */)
6289 (string)
6290 Lisp_Object string;
6292 /* ??? Perhaps we should do something special for multibyte strings here. */
6293 CHECK_STRING (string);
6294 fwrite (SDATA (string), 1, SBYTES (string), stdout);
6295 fflush (stdout);
6296 if (termscript)
6298 fwrite (SDATA (string), 1, SBYTES (string),
6299 termscript);
6300 fflush (termscript);
6302 return Qnil;
6306 DEFUN ("ding", Fding, Sding, 0, 1, 0,
6307 doc: /* Beep, or flash the screen.
6308 Also, unless an argument is given,
6309 terminate any keyboard macro currently executing. */)
6310 (arg)
6311 Lisp_Object arg;
6313 if (!NILP (arg))
6315 if (noninteractive)
6316 putchar (07);
6317 else
6318 ring_bell ();
6319 fflush (stdout);
6321 else
6322 bitch_at_user ();
6324 return Qnil;
6327 void
6328 bitch_at_user ()
6330 if (noninteractive)
6331 putchar (07);
6332 else if (!INTERACTIVE) /* Stop executing a keyboard macro. */
6333 error ("Keyboard macro terminated by a command ringing the bell");
6334 else
6335 ring_bell ();
6336 fflush (stdout);
6341 /***********************************************************************
6342 Sleeping, Waiting
6343 ***********************************************************************/
6345 DEFUN ("sleep-for", Fsleep_for, Ssleep_for, 1, 2, 0,
6346 doc: /* Pause, without updating display, for SECONDS seconds.
6347 SECONDS may be a floating-point value, meaning that you can wait for a
6348 fraction of a second. Optional second arg MILLISECONDS specifies an
6349 additional wait period, in milliseconds; this may be useful if your
6350 Emacs was built without floating point support.
6351 \(Not all operating systems support waiting for a fraction of a second.) */)
6352 (seconds, milliseconds)
6353 Lisp_Object seconds, milliseconds;
6355 int sec, usec;
6357 if (NILP (milliseconds))
6358 XSETINT (milliseconds, 0);
6359 else
6360 CHECK_NUMBER (milliseconds);
6361 usec = XINT (milliseconds) * 1000;
6364 double duration = extract_float (seconds);
6365 sec = (int) duration;
6366 usec += (duration - sec) * 1000000;
6369 #ifndef EMACS_HAS_USECS
6370 if (sec == 0 && usec != 0)
6371 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE);
6372 #endif
6374 /* Assure that 0 <= usec < 1000000. */
6375 if (usec < 0)
6377 /* We can't rely on the rounding being correct if usec is negative. */
6378 if (-1000000 < usec)
6379 sec--, usec += 1000000;
6380 else
6381 sec -= -usec / 1000000, usec = 1000000 - (-usec % 1000000);
6383 else
6384 sec += usec / 1000000, usec %= 1000000;
6386 if (sec < 0 || (sec == 0 && usec == 0))
6387 return Qnil;
6389 wait_reading_process_output (sec, usec, 0, 0, Qnil, NULL, 0);
6391 return Qnil;
6395 /* This is just like wait_reading_process_output, except that
6396 it does the redisplay.
6398 It's also much like Fsit_for, except that it can be used for
6399 waiting for input as well. */
6401 Lisp_Object
6402 sit_for (sec, usec, reading, display, initial_display)
6403 int sec, usec, reading, display, initial_display;
6405 swallow_events (display);
6407 if ((detect_input_pending_run_timers (display)
6408 && !redisplay_dont_pause)
6409 || !NILP (Vexecuting_kbd_macro))
6410 return Qnil;
6412 if (initial_display)
6413 redisplay_preserve_echo_area (2);
6415 if (sec == 0 && usec == 0)
6416 return Qt;
6418 #ifdef SIGIO
6419 gobble_input (0);
6420 #endif
6422 wait_reading_process_output (sec, usec, reading ? -1 : 1, display,
6423 Qnil, NULL, 0);
6425 return detect_input_pending () ? Qnil : Qt;
6429 DEFUN ("sit-for", Fsit_for, Ssit_for, 1, 3, 0,
6430 doc: /* Perform redisplay, then wait for SECONDS seconds or until input is available.
6431 SECONDS may be a floating-point value, meaning that you can wait for a
6432 fraction of a second.
6433 \(Not all operating systems support waiting for a fraction of a second.)
6434 Optional arg NODISP non-nil means don't redisplay, just wait for input.
6435 Redisplay is preempted as always if input arrives, and does not happen
6436 if input is available before it starts.
6437 Value is t if waited the full time with no input arriving.
6439 Redisplay will occur even when input is available if you bind
6440 `redisplay-dont-pause' to a non-nil value.
6442 An obsolete but still supported form is
6443 \(sit-for SECONDS &optional MILLISECONDS NODISP)
6444 Where the optional arg MILLISECONDS specifies an additional wait period,
6445 in milliseconds; this was useful when Emacs was built without
6446 floating point support.
6447 usage: (sit-for SECONDS &optional NODISP OLD-NODISP) */)
6449 /* The `old-nodisp' stuff is there so that the arglist has the correct
6450 length. Otherwise, `defdvice' will redefine it with fewer args. */
6451 (seconds, milliseconds, nodisp)
6452 Lisp_Object seconds, milliseconds, nodisp;
6454 int sec, usec;
6456 if (NILP (nodisp) && !NUMBERP (milliseconds))
6457 { /* New style. */
6458 nodisp = milliseconds;
6459 milliseconds = Qnil;
6462 if (NILP (milliseconds))
6463 XSETINT (milliseconds, 0);
6464 else
6465 CHECK_NUMBER (milliseconds);
6466 usec = XINT (milliseconds) * 1000;
6469 double duration = extract_float (seconds);
6470 sec = (int) duration;
6471 usec += (duration - sec) * 1000000;
6474 #ifndef EMACS_HAS_USECS
6475 if (usec != 0 && sec == 0)
6476 error ("Millisecond `sit-for' not supported on %s", SYSTEM_TYPE);
6477 #endif
6479 return sit_for (sec, usec, 0, NILP (nodisp), NILP (nodisp));
6484 /***********************************************************************
6485 Other Lisp Functions
6486 ***********************************************************************/
6488 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6489 session's frames, frame names, buffers, buffer-read-only flags, and
6490 buffer-modified-flags. */
6492 static Lisp_Object frame_and_buffer_state;
6495 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p,
6496 Sframe_or_buffer_changed_p, 0, 1, 0,
6497 doc: /* Return non-nil if the frame and buffer state appears to have changed.
6498 VARIABLE is a variable name whose value is either nil or a state vector
6499 that will be updated to contain all frames and buffers,
6500 aside from buffers whose names start with space,
6501 along with the buffers' read-only and modified flags. This allows a fast
6502 check to see whether buffer menus might need to be recomputed.
6503 If this function returns non-nil, it updates the internal vector to reflect
6504 the current state.
6506 If VARIABLE is nil, an internal variable is used. Users should not
6507 pass nil for VARIABLE. */)
6508 (variable)
6509 Lisp_Object variable;
6511 Lisp_Object state, tail, frame, buf;
6512 Lisp_Object *vecp, *end;
6513 int n;
6515 if (! NILP (variable))
6517 CHECK_SYMBOL (variable);
6518 state = Fsymbol_value (variable);
6519 if (! VECTORP (state))
6520 goto changed;
6522 else
6523 state = frame_and_buffer_state;
6525 vecp = XVECTOR (state)->contents;
6526 end = vecp + XVECTOR (state)->size;
6528 FOR_EACH_FRAME (tail, frame)
6530 if (vecp == end)
6531 goto changed;
6532 if (!EQ (*vecp++, frame))
6533 goto changed;
6534 if (vecp == end)
6535 goto changed;
6536 if (!EQ (*vecp++, XFRAME (frame)->name))
6537 goto changed;
6539 /* Check that the buffer info matches. */
6540 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6542 buf = XCDR (XCAR (tail));
6543 /* Ignore buffers that aren't included in buffer lists. */
6544 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6545 continue;
6546 if (vecp == end)
6547 goto changed;
6548 if (!EQ (*vecp++, buf))
6549 goto changed;
6550 if (vecp == end)
6551 goto changed;
6552 if (!EQ (*vecp++, XBUFFER (buf)->read_only))
6553 goto changed;
6554 if (vecp == end)
6555 goto changed;
6556 if (!EQ (*vecp++, Fbuffer_modified_p (buf)))
6557 goto changed;
6559 if (vecp == end)
6560 goto changed;
6561 /* Detect deletion of a buffer at the end of the list. */
6562 if (EQ (*vecp, Qlambda))
6563 return Qnil;
6565 /* Come here if we decide the data has changed. */
6566 changed:
6567 /* Count the size we will need.
6568 Start with 1 so there is room for at least one lambda at the end. */
6569 n = 1;
6570 FOR_EACH_FRAME (tail, frame)
6571 n += 2;
6572 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6573 n += 3;
6574 /* Reallocate the vector if data has grown to need it,
6575 or if it has shrunk a lot. */
6576 if (! VECTORP (state)
6577 || n > XVECTOR (state)->size
6578 || n + 20 < XVECTOR (state)->size / 2)
6579 /* Add 20 extra so we grow it less often. */
6581 state = Fmake_vector (make_number (n + 20), Qlambda);
6582 if (! NILP (variable))
6583 Fset (variable, state);
6584 else
6585 frame_and_buffer_state = state;
6588 /* Record the new data in the (possibly reallocated) vector. */
6589 vecp = XVECTOR (state)->contents;
6590 FOR_EACH_FRAME (tail, frame)
6592 *vecp++ = frame;
6593 *vecp++ = XFRAME (frame)->name;
6595 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
6597 buf = XCDR (XCAR (tail));
6598 /* Ignore buffers that aren't included in buffer lists. */
6599 if (SREF (XBUFFER (buf)->name, 0) == ' ')
6600 continue;
6601 *vecp++ = buf;
6602 *vecp++ = XBUFFER (buf)->read_only;
6603 *vecp++ = Fbuffer_modified_p (buf);
6605 /* Fill up the vector with lambdas (always at least one). */
6606 *vecp++ = Qlambda;
6607 while (vecp - XVECTOR (state)->contents
6608 < XVECTOR (state)->size)
6609 *vecp++ = Qlambda;
6610 /* Make sure we didn't overflow the vector. */
6611 if (vecp - XVECTOR (state)->contents
6612 > XVECTOR (state)->size)
6613 abort ();
6614 return Qt;
6619 /***********************************************************************
6620 Initialization
6621 ***********************************************************************/
6623 char *terminal_type;
6625 /* Initialization done when Emacs fork is started, before doing stty.
6626 Determine terminal type and set terminal_driver. Then invoke its
6627 decoding routine to set up variables in the terminal package. */
6629 void
6630 init_display ()
6632 #ifdef HAVE_X_WINDOWS
6633 extern int display_arg;
6634 #endif
6636 /* Construct the space glyph. */
6637 space_glyph.type = CHAR_GLYPH;
6638 SET_CHAR_GLYPH_FROM_GLYPH (space_glyph, ' ');
6639 space_glyph.charpos = -1;
6641 meta_key = 0;
6642 inverse_video = 0;
6643 cursor_in_echo_area = 0;
6644 terminal_type = (char *) 0;
6646 /* Now is the time to initialize this; it's used by init_sys_modes
6647 during startup. */
6648 Vwindow_system = Qnil;
6650 /* If the user wants to use a window system, we shouldn't bother
6651 initializing the terminal. This is especially important when the
6652 terminal is so dumb that emacs gives up before and doesn't bother
6653 using the window system.
6655 If the DISPLAY environment variable is set and nonempty,
6656 try to use X, and die with an error message if that doesn't work. */
6658 #ifdef HAVE_X_WINDOWS
6659 if (! inhibit_window_system && ! display_arg)
6661 char *display;
6662 #ifdef VMS
6663 display = getenv ("DECW$DISPLAY");
6664 #else
6665 display = getenv ("DISPLAY");
6666 #endif
6668 display_arg = (display != 0 && *display != 0);
6670 if (display_arg && !x_display_ok (display))
6672 fprintf (stderr, "Display %s unavailable, simulating -nw\n",
6673 display);
6674 inhibit_window_system = 1;
6678 if (!inhibit_window_system && display_arg
6679 #ifndef CANNOT_DUMP
6680 && initialized
6681 #endif
6684 Vwindow_system = intern ("x");
6685 #ifdef HAVE_X11
6686 Vwindow_system_version = make_number (11);
6687 #else
6688 Vwindow_system_version = make_number (10);
6689 #endif
6690 #if defined (GNU_LINUX) && defined (HAVE_LIBNCURSES)
6691 /* In some versions of ncurses,
6692 tputs crashes if we have not called tgetent.
6693 So call tgetent. */
6694 { char b[2044]; tgetent (b, "xterm");}
6695 #endif
6696 adjust_frame_glyphs_initially ();
6697 return;
6699 #endif /* HAVE_X_WINDOWS */
6701 #ifdef HAVE_NTGUI
6702 if (!inhibit_window_system)
6704 Vwindow_system = intern ("w32");
6705 Vwindow_system_version = make_number (1);
6706 adjust_frame_glyphs_initially ();
6707 return;
6709 #endif /* HAVE_NTGUI */
6711 #ifdef MAC_OS
6712 if (!inhibit_window_system)
6714 Vwindow_system = intern ("mac");
6715 Vwindow_system_version = make_number (1);
6716 adjust_frame_glyphs_initially ();
6717 return;
6719 #endif /* MAC_OS */
6721 /* If no window system has been specified, try to use the terminal. */
6722 if (! isatty (0))
6724 fatal ("standard input is not a tty");
6725 exit (1);
6728 /* Look at the TERM variable. */
6729 terminal_type = (char *) getenv ("TERM");
6730 if (!terminal_type)
6732 #ifdef VMS
6733 fprintf (stderr, "Please specify your terminal type.\n\
6734 For types defined in VMS, use set term /device=TYPE.\n\
6735 For types not defined in VMS, use define emacs_term \"TYPE\".\n\
6736 \(The quotation marks are necessary since terminal types are lower case.)\n");
6737 #else
6738 fprintf (stderr, "Please set the environment variable TERM; see tset(1).\n");
6739 #endif
6740 exit (1);
6743 #ifdef VMS
6744 /* VMS DCL tends to up-case things, so down-case term type.
6745 Hardly any uppercase letters in terminal types; should be none. */
6747 char *new = (char *) xmalloc (strlen (terminal_type) + 1);
6748 char *p;
6750 strcpy (new, terminal_type);
6752 for (p = new; *p; p++)
6753 if (isupper (*p))
6754 *p = tolower (*p);
6756 terminal_type = new;
6758 #endif /* VMS */
6760 term_init (terminal_type);
6763 struct frame *sf = SELECTED_FRAME ();
6764 int width = FRAME_TOTAL_COLS (sf);
6765 int height = FRAME_LINES (sf);
6767 unsigned int total_glyphs = height * (width + 2) * sizeof (struct glyph);
6769 /* If these sizes are so big they cause overflow, just ignore the
6770 change. It's not clear what better we could do. */
6771 if (total_glyphs / sizeof (struct glyph) / height != width + 2)
6772 fatal ("screen size %dx%d too big", width, height);
6775 adjust_frame_glyphs_initially ();
6776 calculate_costs (XFRAME (selected_frame));
6778 #ifdef SIGWINCH
6779 #ifndef CANNOT_DUMP
6780 if (initialized)
6781 #endif /* CANNOT_DUMP */
6782 signal (SIGWINCH, window_change_signal);
6783 #endif /* SIGWINCH */
6785 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6786 if (initialized
6787 && !noninteractive
6788 #ifdef MSDOS
6789 /* The MSDOS terminal turns on its ``window system'' relatively
6790 late into the startup, so we cannot do the frame faces'
6791 initialization just yet. It will be done later by pc-win.el
6792 and internal_terminal_init. */
6793 && (strcmp (terminal_type, "internal") != 0 || inhibit_window_system)
6794 #endif
6795 && NILP (Vwindow_system))
6797 /* For the initial frame, we don't have any way of knowing what
6798 are the foreground and background colors of the terminal. */
6799 struct frame *sf = SELECTED_FRAME();
6801 FRAME_FOREGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_FG_COLOR;
6802 FRAME_BACKGROUND_PIXEL (sf) = FACE_TTY_DEFAULT_BG_COLOR;
6803 call0 (intern ("tty-set-up-initial-frame-faces"));
6809 /***********************************************************************
6810 Blinking cursor
6811 ***********************************************************************/
6813 DEFUN ("internal-show-cursor", Finternal_show_cursor,
6814 Sinternal_show_cursor, 2, 2, 0,
6815 doc: /* Set the cursor-visibility flag of WINDOW to SHOW.
6816 WINDOW nil means use the selected window. SHOW non-nil means
6817 show a cursor in WINDOW in the next redisplay. SHOW nil means
6818 don't show a cursor. */)
6819 (window, show)
6820 Lisp_Object window, show;
6822 /* Don't change cursor state while redisplaying. This could confuse
6823 output routines. */
6824 if (!redisplaying_p)
6826 if (NILP (window))
6827 window = selected_window;
6828 else
6829 CHECK_WINDOW (window);
6831 XWINDOW (window)->cursor_off_p = NILP (show);
6834 return Qnil;
6838 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p,
6839 Sinternal_show_cursor_p, 0, 1, 0,
6840 doc: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6841 WINDOW nil or omitted means report on the selected window. */)
6842 (window)
6843 Lisp_Object window;
6845 struct window *w;
6847 if (NILP (window))
6848 window = selected_window;
6849 else
6850 CHECK_WINDOW (window);
6852 w = XWINDOW (window);
6853 return w->cursor_off_p ? Qnil : Qt;
6857 /***********************************************************************
6858 Initialization
6859 ***********************************************************************/
6861 void
6862 syms_of_display ()
6864 defsubr (&Sredraw_frame);
6865 defsubr (&Sredraw_display);
6866 defsubr (&Sframe_or_buffer_changed_p);
6867 defsubr (&Sopen_termscript);
6868 defsubr (&Sding);
6869 defsubr (&Ssit_for);
6870 defsubr (&Ssleep_for);
6871 defsubr (&Ssend_string_to_terminal);
6872 defsubr (&Sinternal_show_cursor);
6873 defsubr (&Sinternal_show_cursor_p);
6875 #if GLYPH_DEBUG
6876 defsubr (&Sdump_redisplay_history);
6877 #endif
6879 frame_and_buffer_state = Fmake_vector (make_number (20), Qlambda);
6880 staticpro (&frame_and_buffer_state);
6882 Qdisplay_table = intern ("display-table");
6883 staticpro (&Qdisplay_table);
6884 Qredisplay_dont_pause = intern ("redisplay-dont-pause");
6885 staticpro (&Qredisplay_dont_pause);
6887 DEFVAR_INT ("baud-rate", &baud_rate,
6888 doc: /* *The output baud rate of the terminal.
6889 On most systems, changing this value will affect the amount of padding
6890 and the other strategic decisions made during redisplay. */);
6892 DEFVAR_BOOL ("inverse-video", &inverse_video,
6893 doc: /* *Non-nil means invert the entire frame display.
6894 This means everything is in inverse video which otherwise would not be. */);
6896 DEFVAR_BOOL ("visible-bell", &visible_bell,
6897 doc: /* *Non-nil means try to flash the frame to represent a bell.
6899 See also `ring-bell-function'. */);
6901 DEFVAR_BOOL ("no-redraw-on-reenter", &no_redraw_on_reenter,
6902 doc: /* *Non-nil means no need to redraw entire frame after suspending.
6903 A non-nil value is useful if the terminal can automatically preserve
6904 Emacs's frame display when you reenter Emacs.
6905 It is up to you to set this variable if your terminal can do that. */);
6907 DEFVAR_LISP ("window-system", &Vwindow_system,
6908 doc: /* Name of window system that Emacs is displaying through.
6909 The value is a symbol--for instance, `x' for X windows.
6910 The value is nil if Emacs is using a text-only terminal. */);
6912 DEFVAR_LISP ("window-system-version", &Vwindow_system_version,
6913 doc: /* The version number of the window system in use.
6914 For X windows, this is 10 or 11. */);
6916 DEFVAR_BOOL ("cursor-in-echo-area", &cursor_in_echo_area,
6917 doc: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6919 DEFVAR_LISP ("glyph-table", &Vglyph_table,
6920 doc: /* Table defining how to output a glyph code to the frame.
6921 If not nil, this is a vector indexed by glyph code to define the glyph.
6922 Each element can be:
6923 integer: a glyph code which this glyph is an alias for.
6924 string: output this glyph using that string (not impl. in X windows).
6925 nil: this glyph mod 524288 is the code of a character to output,
6926 and this glyph / 524288 is the face number (see `face-id') to use
6927 while outputting it. */);
6928 Vglyph_table = Qnil;
6930 DEFVAR_LISP ("standard-display-table", &Vstandard_display_table,
6931 doc: /* Display table to use for buffers that specify none.
6932 See `buffer-display-table' for more information. */);
6933 Vstandard_display_table = Qnil;
6935 DEFVAR_BOOL ("redisplay-dont-pause", &redisplay_dont_pause,
6936 doc: /* *Non-nil means update isn't paused when input is detected. */);
6937 redisplay_dont_pause = 0;
6939 /* Initialize `window-system', unless init_display already decided it. */
6940 #ifdef CANNOT_DUMP
6941 if (noninteractive)
6942 #endif
6944 Vwindow_system = Qnil;
6945 Vwindow_system_version = Qnil;
6949 /* arch-tag: 8d812b1f-04a2-4195-a9c4-381f8457a413
6950 (do not change this comment) */