1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 /* cm.h must come after dispextern.h on Windows. */
31 #include "dispextern.h"
34 #include "character.h"
37 #include "termhooks.h"
42 #include "intervals.h"
43 #include "blockinput.h"
46 #include "syssignal.h"
50 #endif /* HAVE_X_WINDOWS */
54 #endif /* HAVE_NTGUI */
60 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
65 /* Get number of chars of output now in the buffer of a stdio stream.
66 This ought to be built in stdio, but it isn't. Some s- files
67 override this because their stdio internals differ. */
69 #ifdef __GNU_LIBRARY__
71 /* The s- file might have overridden the definition with one that
72 works for the system's C library. But we are using the GNU C
73 library, so this is the right definition for every system. */
75 #ifdef GNU_LIBRARY_PENDING_OUTPUT_COUNT
76 #define PENDING_OUTPUT_COUNT GNU_LIBRARY_PENDING_OUTPUT_COUNT
78 #undef PENDING_OUTPUT_COUNT
79 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
81 #else /* not __GNU_LIBRARY__ */
82 #if !defined (PENDING_OUTPUT_COUNT) && HAVE_STDIO_EXT_H && HAVE___FPENDING
83 #include <stdio_ext.h>
84 #define PENDING_OUTPUT_COUNT(FILE) __fpending (FILE)
86 #ifndef PENDING_OUTPUT_COUNT
87 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
89 #endif /* not __GNU_LIBRARY__ */
91 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
92 #include <term.h> /* for tgetent */
95 /* Structure to pass dimensions around. Used for character bounding
96 boxes, glyph matrix dimensions and alike. */
105 /* Function prototypes. */
107 static void update_frame_line (struct frame
*, int);
108 static int required_matrix_height (struct window
*);
109 static int required_matrix_width (struct window
*);
110 static void adjust_frame_glyphs (struct frame
*);
111 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
112 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
113 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
114 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
116 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
118 static void adjust_frame_message_buffer (struct frame
*);
119 static void adjust_decode_mode_spec_buffer (struct frame
*);
120 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
121 static void clear_window_matrices (struct window
*, int);
122 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
123 static int scrolling_window (struct window
*, int);
124 static int update_window_line (struct window
*, int, int *);
125 static void mirror_make_current (struct window
*, int);
127 static void check_matrix_pointers (struct glyph_matrix
*,
128 struct glyph_matrix
*);
130 static void mirror_line_dance (struct window
*, int, int, int *, char *);
131 static int update_window_tree (struct window
*, int);
132 static int update_window (struct window
*, int);
133 static int update_frame_1 (struct frame
*, int, int);
134 static int scrolling (struct frame
*);
135 static void set_window_cursor_after_update (struct window
*);
136 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
137 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
140 /* Define PERIODIC_PREEMPTION_CHECKING to 1, if micro-second timers
141 are supported, so we can check for input during redisplay at
142 regular intervals. */
143 #ifdef EMACS_HAS_USECS
144 #define PERIODIC_PREEMPTION_CHECKING 1
146 #define PERIODIC_PREEMPTION_CHECKING 0
149 #if PERIODIC_PREEMPTION_CHECKING
151 /* Redisplay preemption timers. */
153 static EMACS_TIME preemption_period
;
154 static EMACS_TIME preemption_next_check
;
158 /* Nonzero upon entry to redisplay means do not assume anything about
159 current contents of actual terminal frame; clear and redraw it. */
163 /* Nonzero means last display completed. Zero means it was preempted. */
165 int display_completed
;
167 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
170 /* The currently selected frame. In a single-frame version, this
171 variable always equals the_only_frame. */
173 Lisp_Object selected_frame
;
175 /* A frame which is not just a mini-buffer, or 0 if there are no such
176 frames. This is usually the most recent such frame that was
177 selected. In a single-frame version, this variable always holds
178 the address of the_only_frame. */
180 struct frame
*last_nonminibuf_frame
;
182 /* 1 means SIGWINCH happened when not safe. */
184 static int delayed_size_change
;
186 /* 1 means glyph initialization has been completed at startup. */
188 static int glyphs_initialized_initially_p
;
190 /* Updated window if != 0. Set by update_window. */
192 struct window
*updated_window
;
194 /* Glyph row updated in update_window_line, and area that is updated. */
196 struct glyph_row
*updated_row
;
199 /* A glyph for a space. */
201 struct glyph space_glyph
;
203 /* Counts of allocated structures. These counts serve to diagnose
204 memory leaks and double frees. */
206 static int glyph_matrix_count
;
207 static int glyph_pool_count
;
209 /* If non-null, the frame whose frame matrices are manipulated. If
210 null, window matrices are worked on. */
212 static struct frame
*frame_matrix_frame
;
214 /* Non-zero means that fonts have been loaded since the last glyph
215 matrix adjustments. Redisplay must stop, and glyph matrices must
216 be adjusted when this flag becomes non-zero during display. The
217 reason fonts can be loaded so late is that fonts of fontsets are
218 loaded on demand. Another reason is that a line contains many
219 characters displayed by zero width or very narrow glyphs of
220 variable-width fonts. */
224 /* Convert vpos and hpos from frame to window and vice versa.
225 This may only be used for terminal frames. */
229 static int window_to_frame_vpos (struct window
*, int);
230 static int window_to_frame_hpos (struct window
*, int);
231 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
232 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
234 /* One element of the ring buffer containing redisplay history
237 struct redisplay_history
239 char trace
[512 + 100];
242 /* The size of the history buffer. */
244 #define REDISPLAY_HISTORY_SIZE 30
246 /* The redisplay history buffer. */
248 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
250 /* Next free entry in redisplay_history. */
252 static int history_idx
;
254 /* A tick that's incremented each time something is added to the
257 static uprintmax_t history_tick
;
259 static void add_frame_display_history (struct frame
*, int);
261 /* Add to the redisplay history how window W has been displayed.
262 MSG is a trace containing the information how W's glyph matrix
263 has been constructed. PAUSED_P non-zero means that the update
264 has been interrupted for pending input. */
267 add_window_display_history (struct window
*w
, const char *msg
, int paused_p
)
271 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
273 buf
= redisplay_history
[history_idx
].trace
;
276 snprintf (buf
, sizeof redisplay_history
[0].trace
,
277 "%"pMu
": window %p (`%s')%s\n%s",
280 ((BUFFERP (w
->buffer
)
281 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
282 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
284 paused_p
? " ***paused***" : "",
289 /* Add to the redisplay history that frame F has been displayed.
290 PAUSED_P non-zero means that the update has been interrupted for
294 add_frame_display_history (struct frame
*f
, int paused_p
)
298 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
300 buf
= redisplay_history
[history_idx
].trace
;
303 sprintf (buf
, "%"pMu
": update frame %p%s",
305 f
, paused_p
? " ***paused***" : "");
309 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
310 Sdump_redisplay_history
, 0, 0, "",
311 doc
: /* Dump redisplay history to stderr. */)
316 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
319 i
= REDISPLAY_HISTORY_SIZE
- 1;
320 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
327 #else /* GLYPH_DEBUG == 0 */
329 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
330 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
332 #endif /* GLYPH_DEBUG == 0 */
335 #if (defined PROFILING \
336 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
337 && !HAVE___EXECUTABLE_START)
338 /* This function comes first in the Emacs executable and is used only
339 to estimate the text start for profiling. */
341 __executable_start (void)
347 /***********************************************************************
349 ***********************************************************************/
351 /* Allocate and return a glyph_matrix structure. POOL is the glyph
352 pool from which memory for the matrix should be allocated, or null
353 for window-based redisplay where no glyph pools are used. The
354 member `pool' of the glyph matrix structure returned is set to
355 POOL, the structure is otherwise zeroed. */
357 static struct glyph_matrix
*
358 new_glyph_matrix (struct glyph_pool
*pool
)
360 struct glyph_matrix
*result
;
362 /* Allocate and clear. */
363 result
= (struct glyph_matrix
*) xmalloc (sizeof *result
);
364 memset (result
, 0, sizeof *result
);
366 /* Increment number of allocated matrices. This count is used
367 to detect memory leaks. */
368 ++glyph_matrix_count
;
370 /* Set pool and return. */
376 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
378 The global counter glyph_matrix_count is decremented when a matrix
379 is freed. If the count gets negative, more structures were freed
380 than allocated, i.e. one matrix was freed more than once or a bogus
381 pointer was passed to this function.
383 If MATRIX->pool is null, this means that the matrix manages its own
384 glyph memory---this is done for matrices on X frames. Freeing the
385 matrix also frees the glyph memory in this case. */
388 free_glyph_matrix (struct glyph_matrix
*matrix
)
394 /* Detect the case that more matrices are freed than were
396 if (--glyph_matrix_count
< 0)
399 /* Free glyph memory if MATRIX owns it. */
400 if (matrix
->pool
== NULL
)
401 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
402 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
404 /* Free row structures and the matrix itself. */
405 xfree (matrix
->rows
);
411 /* Return the number of glyphs to reserve for a marginal area of
412 window W. TOTAL_GLYPHS is the number of glyphs in a complete
413 display line of window W. MARGIN gives the width of the marginal
414 area in canonical character units. MARGIN should be an integer
418 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
422 if (NUMBERP (margin
))
424 int width
= XFASTINT (w
->total_cols
);
425 double d
= max (0, XFLOATINT (margin
));
426 d
= min (width
/ 2 - 1, d
);
427 n
= (int) ((double) total_glyphs
/ width
* d
);
436 /* Return non-zero if ROW's hash value is correct, zero if not. */
438 verify_row_hash (struct glyph_row
*row
)
440 return row
->hash
== row_hash (row
);
444 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
447 W is null if the function is called for a frame glyph matrix.
448 Otherwise it is the window MATRIX is a member of. X and Y are the
449 indices of the first column and row of MATRIX within the frame
450 matrix, if such a matrix exists. They are zero for purely
451 window-based redisplay. DIM is the needed size of the matrix.
453 In window-based redisplay, where no frame matrices exist, glyph
454 matrices manage their own glyph storage. Otherwise, they allocate
455 storage from a common frame glyph pool which can be found in
458 The reason for this memory management strategy is to avoid complete
459 frame redraws if possible. When we allocate from a common pool, a
460 change of the location or size of a sub-matrix within the pool
461 requires a complete redisplay of the frame because we cannot easily
462 make sure that the current matrices of all windows still agree with
463 what is displayed on the screen. While this is usually fast, it
464 leads to screen flickering. */
467 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
471 int marginal_areas_changed_p
= 0;
472 int header_line_changed_p
= 0;
473 int header_line_p
= 0;
474 int left
= -1, right
= -1;
475 int window_width
= -1, window_height
= -1;
477 /* See if W had a header line that has disappeared now, or vice versa.
481 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
483 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
484 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
486 matrix
->header_line_p
= header_line_p
;
488 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
489 Do nothing if MATRIX' size, position, vscroll, and marginal areas
490 haven't changed. This optimization is important because preserving
491 the matrix means preventing redisplay. */
492 if (matrix
->pool
== NULL
)
494 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
495 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
496 xassert (left
>= 0 && right
>= 0);
497 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
498 || right
!= matrix
->right_margin_glyphs
);
500 if (!marginal_areas_changed_p
502 && !header_line_changed_p
503 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
504 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
505 && matrix
->window_height
== window_height
506 && matrix
->window_vscroll
== w
->vscroll
507 && matrix
->window_width
== window_width
)
511 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
512 if (matrix
->rows_allocated
< dim
.height
)
514 int old_alloc
= matrix
->rows_allocated
;
515 new_rows
= dim
.height
- matrix
->rows_allocated
;
516 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
517 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
518 memset (matrix
->rows
+ old_alloc
, 0,
519 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
524 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
525 on a frame not using window-based redisplay. Set up pointers for
526 each row into the glyph pool. */
529 xassert (matrix
->pool
->glyphs
);
533 left
= margin_glyphs_to_reserve (w
, dim
.width
,
534 w
->left_margin_cols
);
535 right
= margin_glyphs_to_reserve (w
, dim
.width
,
536 w
->right_margin_cols
);
541 for (i
= 0; i
< dim
.height
; ++i
)
543 struct glyph_row
*row
= &matrix
->rows
[i
];
545 row
->glyphs
[LEFT_MARGIN_AREA
]
546 = (matrix
->pool
->glyphs
547 + (y
+ i
) * matrix
->pool
->ncolumns
551 || row
== matrix
->rows
+ dim
.height
- 1
552 || (row
== matrix
->rows
&& matrix
->header_line_p
))
554 row
->glyphs
[TEXT_AREA
]
555 = row
->glyphs
[LEFT_MARGIN_AREA
];
556 row
->glyphs
[RIGHT_MARGIN_AREA
]
557 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
558 row
->glyphs
[LAST_AREA
]
559 = row
->glyphs
[RIGHT_MARGIN_AREA
];
563 row
->glyphs
[TEXT_AREA
]
564 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
565 row
->glyphs
[RIGHT_MARGIN_AREA
]
566 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
567 row
->glyphs
[LAST_AREA
]
568 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
572 matrix
->left_margin_glyphs
= left
;
573 matrix
->right_margin_glyphs
= right
;
577 /* If MATRIX->pool is null, MATRIX is responsible for managing
578 its own memory. It is a window matrix for window-based redisplay.
579 Allocate glyph memory from the heap. */
580 if (dim
.width
> matrix
->matrix_w
582 || header_line_changed_p
583 || marginal_areas_changed_p
)
585 struct glyph_row
*row
= matrix
->rows
;
586 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
590 row
->glyphs
[LEFT_MARGIN_AREA
]
591 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
592 dim
.width
, sizeof (struct glyph
));
594 /* The mode line never has marginal areas. */
595 if (row
== matrix
->rows
+ dim
.height
- 1
596 || (row
== matrix
->rows
&& matrix
->header_line_p
))
598 row
->glyphs
[TEXT_AREA
]
599 = row
->glyphs
[LEFT_MARGIN_AREA
];
600 row
->glyphs
[RIGHT_MARGIN_AREA
]
601 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
602 row
->glyphs
[LAST_AREA
]
603 = row
->glyphs
[RIGHT_MARGIN_AREA
];
607 row
->glyphs
[TEXT_AREA
]
608 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
609 row
->glyphs
[RIGHT_MARGIN_AREA
]
610 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
611 row
->glyphs
[LAST_AREA
]
612 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
618 xassert (left
>= 0 && right
>= 0);
619 matrix
->left_margin_glyphs
= left
;
620 matrix
->right_margin_glyphs
= right
;
623 /* Number of rows to be used by MATRIX. */
624 matrix
->nrows
= dim
.height
;
625 xassert (matrix
->nrows
>= 0);
629 if (matrix
== w
->current_matrix
)
631 /* Mark rows in a current matrix of a window as not having
632 valid contents. It's important to not do this for
633 desired matrices. When Emacs starts, it may already be
634 building desired matrices when this function runs. */
635 if (window_width
< 0)
636 window_width
= window_box_width (w
, -1);
638 /* Optimize the case that only the height has changed (C-x 2,
639 upper window). Invalidate all rows that are no longer part
641 if (!marginal_areas_changed_p
642 && !header_line_changed_p
644 && dim
.width
== matrix
->matrix_w
645 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
646 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
647 && matrix
->window_width
== window_width
)
649 /* Find the last row in the window. */
650 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
651 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
657 /* Window end is invalid, if inside of the rows that
658 are invalidated below. */
659 if (INTEGERP (w
->window_end_vpos
)
660 && XFASTINT (w
->window_end_vpos
) >= i
)
661 w
->window_end_valid
= Qnil
;
663 while (i
< matrix
->nrows
)
664 matrix
->rows
[i
++].enabled_p
= 0;
668 for (i
= 0; i
< matrix
->nrows
; ++i
)
669 matrix
->rows
[i
].enabled_p
= 0;
672 else if (matrix
== w
->desired_matrix
)
674 /* Rows in desired matrices always have to be cleared;
675 redisplay expects this is the case when it runs, so it
676 had better be the case when we adjust matrices between
678 for (i
= 0; i
< matrix
->nrows
; ++i
)
679 matrix
->rows
[i
].enabled_p
= 0;
684 /* Remember last values to be able to optimize frame redraws. */
685 matrix
->matrix_x
= x
;
686 matrix
->matrix_y
= y
;
687 matrix
->matrix_w
= dim
.width
;
688 matrix
->matrix_h
= dim
.height
;
690 /* Record the top y location and height of W at the time the matrix
691 was last adjusted. This is used to optimize redisplay above. */
694 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
695 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
696 matrix
->window_height
= window_height
;
697 matrix
->window_width
= window_width
;
698 matrix
->window_vscroll
= w
->vscroll
;
703 /* Reverse the contents of rows in MATRIX between START and END. The
704 contents of the row at END - 1 end up at START, END - 2 at START +
705 1 etc. This is part of the implementation of rotate_matrix (see
709 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
713 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
715 /* Non-ISO HP/UX compiler doesn't like auto struct
717 struct glyph_row temp
;
718 temp
= matrix
->rows
[i
];
719 matrix
->rows
[i
] = matrix
->rows
[j
];
720 matrix
->rows
[j
] = temp
;
725 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
726 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
727 indices. (Note: this does not copy glyphs, only glyph pointers in
728 row structures are moved around).
730 The algorithm used for rotating the vector was, I believe, first
731 described by Kernighan. See the vector R as consisting of two
732 sub-vectors AB, where A has length BY for BY >= 0. The result
733 after rotating is then BA. Reverse both sub-vectors to get ArBr
734 and reverse the result to get (ArBr)r which is BA. Similar for
738 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
742 /* Up (rotate left, i.e. towards lower indices). */
744 reverse_rows (matrix
, first
, first
+ by
);
745 reverse_rows (matrix
, first
+ by
, last
);
746 reverse_rows (matrix
, first
, last
);
750 /* Down (rotate right, i.e. towards higher indices). */
751 reverse_rows (matrix
, last
- by
, last
);
752 reverse_rows (matrix
, first
, last
- by
);
753 reverse_rows (matrix
, first
, last
);
758 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
759 with indices START <= index < END. Increment positions by DELTA/
763 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
764 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
766 /* Check that START and END are reasonable values. */
767 xassert (start
>= 0 && start
<= matrix
->nrows
);
768 xassert (end
>= 0 && end
<= matrix
->nrows
);
769 xassert (start
<= end
);
771 for (; start
< end
; ++start
)
772 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
776 /* Enable a range of rows in glyph matrix MATRIX. START and END are
777 the row indices of the first and last + 1 row to enable. If
778 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
781 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
783 xassert (start
<= end
);
784 xassert (start
>= 0 && start
< matrix
->nrows
);
785 xassert (end
>= 0 && end
<= matrix
->nrows
);
787 for (; start
< end
; ++start
)
788 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
794 This empties all rows in MATRIX by setting the enabled_p flag for
795 all rows of the matrix to zero. The function prepare_desired_row
796 will eventually really clear a row when it sees one with a zero
799 Resets update hints to defaults value. The only update hint
800 currently present is the flag MATRIX->no_scrolling_p. */
803 clear_glyph_matrix (struct glyph_matrix
*matrix
)
807 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
808 matrix
->no_scrolling_p
= 0;
813 /* Shift part of the glyph matrix MATRIX of window W up or down.
814 Increment y-positions in glyph rows between START and END by DY,
815 and recompute their visible height. */
818 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
822 xassert (start
<= end
);
823 xassert (start
>= 0 && start
< matrix
->nrows
);
824 xassert (end
>= 0 && end
<= matrix
->nrows
);
826 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
827 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
829 for (; start
< end
; ++start
)
831 struct glyph_row
*row
= &matrix
->rows
[start
];
834 row
->visible_height
= row
->height
;
837 row
->visible_height
-= min_y
- row
->y
;
838 if (row
->y
+ row
->height
> max_y
)
839 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
840 if (row
->fringe_bitmap_periodic_p
)
841 row
->redraw_fringe_bitmaps_p
= 1;
846 /* Mark all rows in current matrices of frame F as invalid. Marking
847 invalid is done by setting enabled_p to zero for all rows in a
851 clear_current_matrices (register struct frame
*f
)
853 /* Clear frame current matrix, if we have one. */
854 if (f
->current_matrix
)
855 clear_glyph_matrix (f
->current_matrix
);
857 /* Clear the matrix of the menu bar window, if such a window exists.
858 The menu bar window is currently used to display menus on X when
859 no toolkit support is compiled in. */
860 if (WINDOWP (f
->menu_bar_window
))
861 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
863 /* Clear the matrix of the tool-bar window, if any. */
864 if (WINDOWP (f
->tool_bar_window
))
865 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
867 /* Clear current window matrices. */
868 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
869 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
873 /* Clear out all display lines of F for a coming redisplay. */
876 clear_desired_matrices (register struct frame
*f
)
878 if (f
->desired_matrix
)
879 clear_glyph_matrix (f
->desired_matrix
);
881 if (WINDOWP (f
->menu_bar_window
))
882 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
884 if (WINDOWP (f
->tool_bar_window
))
885 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
887 /* Do it for window matrices. */
888 xassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
889 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
893 /* Clear matrices in window tree rooted in W. If DESIRED_P is
894 non-zero clear desired matrices, otherwise clear current matrices. */
897 clear_window_matrices (struct window
*w
, int desired_p
)
901 if (!NILP (w
->hchild
))
903 xassert (WINDOWP (w
->hchild
));
904 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
906 else if (!NILP (w
->vchild
))
908 xassert (WINDOWP (w
->vchild
));
909 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
914 clear_glyph_matrix (w
->desired_matrix
);
917 clear_glyph_matrix (w
->current_matrix
);
918 w
->window_end_valid
= Qnil
;
922 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
928 /***********************************************************************
931 See dispextern.h for an overall explanation of glyph rows.
932 ***********************************************************************/
934 /* Clear glyph row ROW. Do it in a way that makes it robust against
935 changes in the glyph_row structure, i.e. addition or removal of
936 structure members. */
938 static struct glyph_row null_row
;
941 clear_glyph_row (struct glyph_row
*row
)
943 struct glyph
*p
[1 + LAST_AREA
];
946 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
947 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
948 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
949 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
954 /* Restore pointers. */
955 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
956 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
957 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
958 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
960 #if 0 /* At some point, some bit-fields of struct glyph were not set,
961 which made glyphs unequal when compared with GLYPH_EQUAL_P.
962 Redisplay outputs such glyphs, and flickering effects were
963 the result. This also depended on the contents of memory
964 returned by xmalloc. If flickering happens again, activate
965 the code below. If the flickering is gone with that, chances
966 are that the flickering has the same reason as here. */
967 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
972 /* Make ROW an empty, enabled row of canonical character height,
973 in window W starting at y-position Y. */
976 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
980 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
981 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
983 clear_glyph_row (row
);
985 row
->ascent
= row
->phys_ascent
= 0;
986 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
987 row
->visible_height
= row
->height
;
990 row
->visible_height
-= min_y
- row
->y
;
991 if (row
->y
+ row
->height
> max_y
)
992 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
998 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
999 are the amounts by which to change positions. Note that the first
1000 glyph of the text area of a row can have a buffer position even if
1001 the used count of the text area is zero. Such rows display line
1005 increment_row_positions (struct glyph_row
*row
,
1006 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
1010 /* Increment start and end positions. */
1011 MATRIX_ROW_START_CHARPOS (row
) += delta
;
1012 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
1013 MATRIX_ROW_END_CHARPOS (row
) += delta
;
1014 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
1015 CHARPOS (row
->start
.pos
) += delta
;
1016 BYTEPOS (row
->start
.pos
) += delta_bytes
;
1017 CHARPOS (row
->end
.pos
) += delta
;
1018 BYTEPOS (row
->end
.pos
) += delta_bytes
;
1020 if (!row
->enabled_p
)
1023 /* Increment positions in glyphs. */
1024 for (area
= 0; area
< LAST_AREA
; ++area
)
1025 for (i
= 0; i
< row
->used
[area
]; ++i
)
1026 if (BUFFERP (row
->glyphs
[area
][i
].object
)
1027 && row
->glyphs
[area
][i
].charpos
> 0)
1028 row
->glyphs
[area
][i
].charpos
+= delta
;
1030 /* Capture the case of rows displaying a line end. */
1031 if (row
->used
[TEXT_AREA
] == 0
1032 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1033 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1038 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1039 contents, i.e. glyph structure contents are exchanged between A and
1040 B without changing glyph pointers in A and B. */
1043 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
1047 for (area
= 0; area
< LAST_AREA
; ++area
)
1049 /* Number of glyphs to swap. */
1050 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1052 /* Start of glyphs in area of row A. */
1053 struct glyph
*glyph_a
= a
->glyphs
[area
];
1055 /* End + 1 of glyphs in area of row A. */
1056 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1058 /* Start of glyphs in area of row B. */
1059 struct glyph
*glyph_b
= b
->glyphs
[area
];
1061 while (glyph_a
< glyph_a_end
)
1063 /* Non-ISO HP/UX compiler doesn't like auto struct
1067 *glyph_a
= *glyph_b
;
1077 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1078 exchange the used[] array and the hash values of the rows, because
1079 these should all go together for the row's hash value to be
1083 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1086 unsigned hash_tem
= a
->hash
;
1088 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1090 struct glyph
*temp
= a
->glyphs
[i
];
1092 a
->glyphs
[i
] = b
->glyphs
[i
];
1093 b
->glyphs
[i
] = temp
;
1096 short used_tem
= a
->used
[i
];
1098 a
->used
[i
] = b
->used
[i
];
1099 b
->used
[i
] = used_tem
;
1107 /* Copy glyph row structure FROM to glyph row structure TO, except
1108 that glyph pointers, the `used' counts, and the hash values in the
1109 structures are left unchanged. */
1112 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1114 struct glyph
*pointers
[1 + LAST_AREA
];
1115 short used
[LAST_AREA
];
1118 /* Save glyph pointers of TO. */
1119 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1120 memcpy (used
, to
->used
, sizeof to
->used
);
1123 /* Do a structure assignment. */
1126 /* Restore original pointers of TO. */
1127 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1128 memcpy (to
->used
, used
, sizeof to
->used
);
1133 /* Assign glyph row FROM to glyph row TO. This works like a structure
1134 assignment TO = FROM, except that glyph pointers are not copied but
1135 exchanged between TO and FROM. Pointers must be exchanged to avoid
1139 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1141 swap_glyph_pointers (to
, from
);
1142 copy_row_except_pointers (to
, from
);
1146 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1147 a row in a window matrix, is a slice of the glyph memory of the
1148 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1149 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1150 memory of FRAME_ROW. */
1155 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1157 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1158 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1159 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1161 return (frame_glyph_start
<= window_glyph_start
1162 && window_glyph_start
< frame_glyph_end
);
1165 #endif /* GLYPH_DEBUG */
1169 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1170 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1171 in WINDOW_MATRIX is found satisfying the condition. */
1173 static struct glyph_row
*
1174 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1175 struct glyph_matrix
*frame_matrix
, int row
)
1179 xassert (row
>= 0 && row
< frame_matrix
->nrows
);
1181 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1182 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1183 frame_matrix
->rows
+ row
))
1186 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1191 /* Prepare ROW for display. Desired rows are cleared lazily,
1192 i.e. they are only marked as to be cleared by setting their
1193 enabled_p flag to zero. When a row is to be displayed, a prior
1194 call to this function really clears it. */
1197 prepare_desired_row (struct glyph_row
*row
)
1199 if (!row
->enabled_p
)
1201 int rp
= row
->reversed_p
;
1203 clear_glyph_row (row
);
1205 row
->reversed_p
= rp
;
1210 /* Return a hash code for glyph row ROW. */
1213 line_hash_code (struct glyph_row
*row
)
1219 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1220 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1224 int c
= glyph
->u
.ch
;
1225 int face_id
= glyph
->face_id
;
1226 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1228 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1229 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1241 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1242 the number of characters in the line. If must_write_spaces is
1243 zero, leading and trailing spaces are ignored. */
1246 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1248 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1249 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1250 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1252 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1253 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1255 /* Ignore trailing and leading spaces if we can. */
1256 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1258 /* Skip from the end over trailing spaces. */
1259 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1262 /* All blank line. */
1266 /* Skip over leading spaces. */
1267 while (CHAR_GLYPH_SPACE_P (*beg
))
1271 /* If we don't have a glyph-table, each glyph is one character,
1272 so return the number of glyphs. */
1273 if (glyph_table_base
== 0)
1277 /* Otherwise, scan the glyphs and accumulate their total length
1284 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1286 if (GLYPH_INVALID_P (g
)
1287 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1290 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1300 /* Test two glyph rows A and B for equality. Value is non-zero if A
1301 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1302 mouse_face_p flags of A and B, too. */
1305 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1307 xassert (verify_row_hash (a
));
1308 xassert (verify_row_hash (b
));
1312 else if (a
->hash
!= b
->hash
)
1316 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1319 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1322 /* Compare glyphs. */
1323 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1325 if (a
->used
[area
] != b
->used
[area
])
1328 a_glyph
= a
->glyphs
[area
];
1329 a_end
= a_glyph
+ a
->used
[area
];
1330 b_glyph
= b
->glyphs
[area
];
1332 while (a_glyph
< a_end
1333 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1334 ++a_glyph
, ++b_glyph
;
1336 if (a_glyph
!= a_end
)
1340 if (a
->fill_line_p
!= b
->fill_line_p
1341 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1342 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1343 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1344 || a
->left_fringe_offset
!= b
->left_fringe_offset
1345 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1346 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1347 || a
->right_fringe_offset
!= b
->right_fringe_offset
1348 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1349 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1350 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1351 || a
->overlapped_p
!= b
->overlapped_p
1352 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1353 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1354 || a
->reversed_p
!= b
->reversed_p
1355 /* Different partially visible characters on left margin. */
1357 /* Different height. */
1358 || a
->ascent
!= b
->ascent
1359 || a
->phys_ascent
!= b
->phys_ascent
1360 || a
->phys_height
!= b
->phys_height
1361 || a
->visible_height
!= b
->visible_height
)
1370 /***********************************************************************
1373 See dispextern.h for an overall explanation of glyph pools.
1374 ***********************************************************************/
1376 /* Allocate a glyph_pool structure. The structure returned is
1377 initialized with zeros. The global variable glyph_pool_count is
1378 incremented for each pool allocated. */
1380 static struct glyph_pool
*
1381 new_glyph_pool (void)
1383 struct glyph_pool
*result
;
1385 /* Allocate a new glyph_pool and clear it. */
1386 result
= (struct glyph_pool
*) xmalloc (sizeof *result
);
1387 memset (result
, 0, sizeof *result
);
1389 /* For memory leak and double deletion checking. */
1396 /* Free a glyph_pool structure POOL. The function may be called with
1397 a null POOL pointer. The global variable glyph_pool_count is
1398 decremented with every pool structure freed. If this count gets
1399 negative, more structures were freed than allocated, i.e. one
1400 structure must have been freed more than once or a bogus pointer
1401 was passed to free_glyph_pool. */
1404 free_glyph_pool (struct glyph_pool
*pool
)
1408 /* More freed than allocated? */
1410 xassert (glyph_pool_count
>= 0);
1412 xfree (pool
->glyphs
);
1418 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1419 columns we need. This function never shrinks a pool. The only
1420 case in which this would make sense, would be when a frame's size
1421 is changed from a large value to a smaller one. But, if someone
1422 does it once, we can expect that he will do it again.
1424 Value is non-zero if the pool changed in a way which makes
1425 re-adjusting window glyph matrices necessary. */
1428 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1433 changed_p
= (pool
->glyphs
== 0
1434 || matrix_dim
.height
!= pool
->nrows
1435 || matrix_dim
.width
!= pool
->ncolumns
);
1437 /* Enlarge the glyph pool. */
1438 needed
= matrix_dim
.width
;
1439 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1440 memory_full (SIZE_MAX
);
1441 needed
*= matrix_dim
.height
;
1442 if (needed
> pool
->nglyphs
)
1444 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1445 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1446 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1447 memset (pool
->glyphs
+ old_nglyphs
, 0,
1448 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1451 /* Remember the number of rows and columns because (a) we use them
1452 to do sanity checks, and (b) the number of columns determines
1453 where rows in the frame matrix start---this must be available to
1454 determine pointers to rows of window sub-matrices. */
1455 pool
->nrows
= matrix_dim
.height
;
1456 pool
->ncolumns
= matrix_dim
.width
;
1463 /***********************************************************************
1465 ***********************************************************************/
1470 /* Flush standard output. This is sometimes useful to call from the debugger.
1471 XXX Maybe this should be changed to flush the current terminal instead of
1475 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1484 /* Check that no glyph pointers have been lost in MATRIX. If a
1485 pointer has been lost, e.g. by using a structure assignment between
1486 rows, at least one pointer must occur more than once in the rows of
1490 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1494 for (i
= 0; i
< matrix
->nrows
; ++i
)
1495 for (j
= 0; j
< matrix
->nrows
; ++j
)
1497 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1498 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1502 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1505 matrix_row (struct glyph_matrix
*matrix
, int row
)
1507 xassert (matrix
&& matrix
->rows
);
1508 xassert (row
>= 0 && row
< matrix
->nrows
);
1510 /* That's really too slow for normal testing because this function
1511 is called almost everywhere. Although---it's still astonishingly
1512 fast, so it is valuable to have for debugging purposes. */
1514 check_matrix_pointer_lossage (matrix
);
1517 return matrix
->rows
+ row
;
1521 #if 0 /* This function makes invalid assumptions when text is
1522 partially invisible. But it might come handy for debugging
1525 /* Check invariants that must hold for an up to date current matrix of
1529 check_matrix_invariants (struct window
*w
)
1531 struct glyph_matrix
*matrix
= w
->current_matrix
;
1532 int yb
= window_text_bottom_y (w
);
1533 struct glyph_row
*row
= matrix
->rows
;
1534 struct glyph_row
*last_text_row
= NULL
;
1535 struct buffer
*saved
= current_buffer
;
1536 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1539 /* This can sometimes happen for a fresh window. */
1540 if (matrix
->nrows
< 2)
1543 set_buffer_temp (buffer
);
1545 /* Note: last row is always reserved for the mode line. */
1546 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1547 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1549 struct glyph_row
*next
= row
+ 1;
1551 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1552 last_text_row
= row
;
1554 /* Check that character and byte positions are in sync. */
1555 xassert (MATRIX_ROW_START_BYTEPOS (row
)
1556 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1557 xassert (BYTEPOS (row
->start
.pos
)
1558 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1560 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1561 have such a position temporarily in case of a minibuffer
1562 displaying something like `[Sole completion]' at its end. */
1563 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1565 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1566 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1567 xassert (BYTEPOS (row
->end
.pos
)
1568 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1571 /* Check that end position of `row' is equal to start position
1573 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1575 xassert (MATRIX_ROW_END_CHARPOS (row
)
1576 == MATRIX_ROW_START_CHARPOS (next
));
1577 xassert (MATRIX_ROW_END_BYTEPOS (row
)
1578 == MATRIX_ROW_START_BYTEPOS (next
));
1579 xassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1580 xassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1585 xassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1586 xassert (w
->desired_matrix
->rows
!= NULL
);
1587 set_buffer_temp (saved
);
1592 #endif /* GLYPH_DEBUG != 0 */
1596 /**********************************************************************
1597 Allocating/ Adjusting Glyph Matrices
1598 **********************************************************************/
1600 /* Allocate glyph matrices over a window tree for a frame-based
1603 X and Y are column/row within the frame glyph matrix where
1604 sub-matrices for the window tree rooted at WINDOW must be
1605 allocated. DIM_ONLY_P non-zero means that the caller of this
1606 function is only interested in the result matrix dimension, and
1607 matrix adjustments should not be performed.
1609 The function returns the total width/height of the sub-matrices of
1610 the window tree. If called on a frame root window, the computation
1611 will take the mini-buffer window into account.
1613 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1615 NEW_LEAF_MATRIX set if any window in the tree did not have a
1616 glyph matrices yet, and
1618 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1619 any window in the tree will be changed or have been changed (see
1622 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1625 Windows are arranged into chains of windows on the same level
1626 through the next fields of window structures. Such a level can be
1627 either a sequence of horizontally adjacent windows from left to
1628 right, or a sequence of vertically adjacent windows from top to
1629 bottom. Each window in a horizontal sequence can be either a leaf
1630 window or a vertical sequence; a window in a vertical sequence can
1631 be either a leaf or a horizontal sequence. All windows in a
1632 horizontal sequence have the same height, and all windows in a
1633 vertical sequence have the same width.
1635 This function uses, for historical reasons, a more general
1636 algorithm to determine glyph matrix dimensions that would be
1639 The matrix height of a horizontal sequence is determined by the
1640 maximum height of any matrix in the sequence. The matrix width of
1641 a horizontal sequence is computed by adding up matrix widths of
1642 windows in the sequence.
1644 |<------- result width ------->|
1645 +---------+----------+---------+ ---
1648 +---------+ | | result height
1653 The matrix width of a vertical sequence is the maximum matrix width
1654 of any window in the sequence. Its height is computed by adding up
1655 matrix heights of windows in the sequence.
1657 |<---- result width -->|
1665 +------------+---------+ |
1668 +------------+---------+ --- */
1670 /* Bit indicating that a new matrix will be allocated or has been
1673 #define NEW_LEAF_MATRIX (1 << 0)
1675 /* Bit indicating that a matrix will or has changed its location or
1678 #define CHANGED_LEAF_MATRIX (1 << 1)
1681 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1682 int dim_only_p
, int *window_change_flags
)
1684 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1686 int wmax
= 0, hmax
= 0;
1690 int in_horz_combination_p
;
1692 /* What combination is WINDOW part of? Compute this once since the
1693 result is the same for all windows in the `next' chain. The
1694 special case of a root window (parent equal to nil) is treated
1695 like a vertical combination because a root window's `next'
1696 points to the mini-buffer window, if any, which is arranged
1697 vertically below other windows. */
1698 in_horz_combination_p
1699 = (!NILP (XWINDOW (window
)->parent
)
1700 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1702 /* For WINDOW and all windows on the same level. */
1705 w
= XWINDOW (window
);
1707 /* Get the dimension of the window sub-matrix for W, depending
1708 on whether this is a combination or a leaf window. */
1709 if (!NILP (w
->hchild
))
1710 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1712 window_change_flags
);
1713 else if (!NILP (w
->vchild
))
1714 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1716 window_change_flags
);
1719 /* If not already done, allocate sub-matrix structures. */
1720 if (w
->desired_matrix
== NULL
)
1722 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1723 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1724 *window_change_flags
|= NEW_LEAF_MATRIX
;
1727 /* Width and height MUST be chosen so that there are no
1728 holes in the frame matrix. */
1729 dim
.width
= required_matrix_width (w
);
1730 dim
.height
= required_matrix_height (w
);
1732 /* Will matrix be re-allocated? */
1733 if (x
!= w
->desired_matrix
->matrix_x
1734 || y
!= w
->desired_matrix
->matrix_y
1735 || dim
.width
!= w
->desired_matrix
->matrix_w
1736 || dim
.height
!= w
->desired_matrix
->matrix_h
1737 || (margin_glyphs_to_reserve (w
, dim
.width
,
1738 w
->left_margin_cols
)
1739 != w
->desired_matrix
->left_margin_glyphs
)
1740 || (margin_glyphs_to_reserve (w
, dim
.width
,
1741 w
->right_margin_cols
)
1742 != w
->desired_matrix
->right_margin_glyphs
))
1743 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1745 /* Actually change matrices, if allowed. Do not consider
1746 CHANGED_LEAF_MATRIX computed above here because the pool
1747 may have been changed which we don't now here. We trust
1748 that we only will be called with DIM_ONLY_P != 0 when
1752 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1753 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1757 /* If we are part of a horizontal combination, advance x for
1758 windows to the right of W; otherwise advance y for windows
1760 if (in_horz_combination_p
)
1765 /* Remember maximum glyph matrix dimensions. */
1766 wmax
= max (wmax
, dim
.width
);
1767 hmax
= max (hmax
, dim
.height
);
1769 /* Next window on same level. */
1772 while (!NILP (window
));
1774 /* Set `total' to the total glyph matrix dimension of this window
1775 level. In a vertical combination, the width is the width of the
1776 widest window; the height is the y we finally reached, corrected
1777 by the y we started with. In a horizontal combination, the total
1778 height is the height of the tallest window, and the width is the
1779 x we finally reached, corrected by the x we started with. */
1780 if (in_horz_combination_p
)
1782 total
.width
= x
- x0
;
1783 total
.height
= hmax
;
1788 total
.height
= y
- y0
;
1795 /* Return the required height of glyph matrices for window W. */
1798 required_matrix_height (struct window
*w
)
1800 #ifdef HAVE_WINDOW_SYSTEM
1801 struct frame
*f
= XFRAME (w
->frame
);
1803 if (FRAME_WINDOW_P (f
))
1805 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1806 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1807 return (((window_pixel_height
+ ch_height
- 1)
1808 / ch_height
) * w
->nrows_scale_factor
1809 /* One partially visible line at the top and
1810 bottom of the window. */
1812 /* 2 for header and mode line. */
1815 #endif /* HAVE_WINDOW_SYSTEM */
1817 return WINDOW_TOTAL_LINES (w
);
1821 /* Return the required width of glyph matrices for window W. */
1824 required_matrix_width (struct window
*w
)
1826 #ifdef HAVE_WINDOW_SYSTEM
1827 struct frame
*f
= XFRAME (w
->frame
);
1828 if (FRAME_WINDOW_P (f
))
1830 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1831 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1833 /* Compute number of glyphs needed in a glyph row. */
1834 return (((window_pixel_width
+ ch_width
- 1)
1835 / ch_width
) * w
->ncols_scale_factor
1836 /* 2 partially visible columns in the text area. */
1838 /* One partially visible column at the right
1839 edge of each marginal area. */
1842 #endif /* HAVE_WINDOW_SYSTEM */
1844 return XINT (w
->total_cols
);
1848 /* Allocate window matrices for window-based redisplay. W is the
1849 window whose matrices must be allocated/reallocated. */
1852 allocate_matrices_for_window_redisplay (struct window
*w
)
1856 if (!NILP (w
->vchild
))
1857 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1858 else if (!NILP (w
->hchild
))
1859 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1862 /* W is a leaf window. */
1865 /* If matrices are not yet allocated, allocate them now. */
1866 if (w
->desired_matrix
== NULL
)
1868 w
->desired_matrix
= new_glyph_matrix (NULL
);
1869 w
->current_matrix
= new_glyph_matrix (NULL
);
1872 dim
.width
= required_matrix_width (w
);
1873 dim
.height
= required_matrix_height (w
);
1874 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1875 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1878 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1883 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1884 do it for all frames; otherwise do it just for the given frame.
1885 This function must be called when a new frame is created, its size
1886 changes, or its window configuration changes. */
1889 adjust_glyphs (struct frame
*f
)
1891 /* Block input so that expose events and other events that access
1892 glyph matrices are not processed while we are changing them. */
1896 adjust_frame_glyphs (f
);
1899 Lisp_Object tail
, lisp_frame
;
1901 FOR_EACH_FRAME (tail
, lisp_frame
)
1902 adjust_frame_glyphs (XFRAME (lisp_frame
));
1909 /* Adjust frame glyphs when Emacs is initialized.
1911 To be called from init_display.
1913 We need a glyph matrix because redraw will happen soon.
1914 Unfortunately, window sizes on selected_frame are not yet set to
1915 meaningful values. I believe we can assume that there are only two
1916 windows on the frame---the mini-buffer and the root window. Frame
1917 height and width seem to be correct so far. So, set the sizes of
1918 windows to estimated values. */
1921 adjust_frame_glyphs_initially (void)
1923 struct frame
*sf
= SELECTED_FRAME ();
1924 struct window
*root
= XWINDOW (sf
->root_window
);
1925 struct window
*mini
= XWINDOW (root
->next
);
1926 int frame_lines
= FRAME_LINES (sf
);
1927 int frame_cols
= FRAME_COLS (sf
);
1928 int top_margin
= FRAME_TOP_MARGIN (sf
);
1930 /* Do it for the root window. */
1931 XSETFASTINT (root
->top_line
, top_margin
);
1932 XSETFASTINT (root
->total_lines
, frame_lines
- 1 - top_margin
);
1933 XSETFASTINT (root
->total_cols
, frame_cols
);
1935 /* Do it for the mini-buffer window. */
1936 XSETFASTINT (mini
->top_line
, frame_lines
- 1);
1937 XSETFASTINT (mini
->total_lines
, 1);
1938 XSETFASTINT (mini
->total_cols
, frame_cols
);
1940 adjust_frame_glyphs (sf
);
1941 glyphs_initialized_initially_p
= 1;
1945 /* Allocate/reallocate glyph matrices of a single frame F. */
1948 adjust_frame_glyphs (struct frame
*f
)
1950 if (FRAME_WINDOW_P (f
))
1951 adjust_frame_glyphs_for_window_redisplay (f
);
1953 adjust_frame_glyphs_for_frame_redisplay (f
);
1955 /* Don't forget the message buffer and the buffer for
1956 decode_mode_spec. */
1957 adjust_frame_message_buffer (f
);
1958 adjust_decode_mode_spec_buffer (f
);
1960 f
->glyphs_initialized_p
= 1;
1963 /* Return 1 if any window in the tree has nonzero window margins. See
1964 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1966 showing_window_margins_p (struct window
*w
)
1970 if (!NILP (w
->hchild
))
1972 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1975 else if (!NILP (w
->vchild
))
1977 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1980 else if (!NILP (w
->left_margin_cols
)
1981 || !NILP (w
->right_margin_cols
))
1984 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1990 /* In the window tree with root W, build current matrices of leaf
1991 windows from the frame's current matrix. */
1994 fake_current_matrices (Lisp_Object window
)
1998 for (; !NILP (window
); window
= w
->next
)
2000 w
= XWINDOW (window
);
2002 if (!NILP (w
->hchild
))
2003 fake_current_matrices (w
->hchild
);
2004 else if (!NILP (w
->vchild
))
2005 fake_current_matrices (w
->vchild
);
2009 struct frame
*f
= XFRAME (w
->frame
);
2010 struct glyph_matrix
*m
= w
->current_matrix
;
2011 struct glyph_matrix
*fm
= f
->current_matrix
;
2013 xassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
2014 xassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
2016 for (i
= 0; i
< m
->matrix_h
; ++i
)
2018 struct glyph_row
*r
= m
->rows
+ i
;
2019 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
2021 xassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
2022 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
2024 r
->enabled_p
= fr
->enabled_p
;
2027 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
2028 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
2029 r
->used
[TEXT_AREA
] = (m
->matrix_w
2030 - r
->used
[LEFT_MARGIN_AREA
]
2031 - r
->used
[RIGHT_MARGIN_AREA
]);
2040 /* Save away the contents of frame F's current frame matrix. Value is
2041 a glyph matrix holding the contents of F's current frame matrix. */
2043 static struct glyph_matrix
*
2044 save_current_matrix (struct frame
*f
)
2047 struct glyph_matrix
*saved
;
2049 saved
= (struct glyph_matrix
*) xmalloc (sizeof *saved
);
2050 memset (saved
, 0, sizeof *saved
);
2051 saved
->nrows
= f
->current_matrix
->nrows
;
2052 saved
->rows
= (struct glyph_row
*) xmalloc (saved
->nrows
2053 * sizeof *saved
->rows
);
2054 memset (saved
->rows
, 0, saved
->nrows
* sizeof *saved
->rows
);
2056 for (i
= 0; i
< saved
->nrows
; ++i
)
2058 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2059 struct glyph_row
*to
= saved
->rows
+ i
;
2060 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2061 to
->glyphs
[TEXT_AREA
] = (struct glyph
*) xmalloc (nbytes
);
2062 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2063 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2070 /* Restore the contents of frame F's current frame matrix from SAVED,
2071 and free memory associated with SAVED. */
2074 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2078 for (i
= 0; i
< saved
->nrows
; ++i
)
2080 struct glyph_row
*from
= saved
->rows
+ i
;
2081 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2082 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2083 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2084 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2085 xfree (from
->glyphs
[TEXT_AREA
]);
2088 xfree (saved
->rows
);
2094 /* Allocate/reallocate glyph matrices of a single frame F for
2095 frame-based redisplay. */
2098 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2100 struct dim matrix_dim
;
2102 int window_change_flags
;
2105 if (!FRAME_LIVE_P (f
))
2108 top_window_y
= FRAME_TOP_MARGIN (f
);
2110 /* Allocate glyph pool structures if not already done. */
2111 if (f
->desired_pool
== NULL
)
2113 f
->desired_pool
= new_glyph_pool ();
2114 f
->current_pool
= new_glyph_pool ();
2117 /* Allocate frames matrix structures if needed. */
2118 if (f
->desired_matrix
== NULL
)
2120 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2121 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2124 /* Compute window glyph matrices. (This takes the mini-buffer
2125 window into account). The result is the size of the frame glyph
2126 matrix needed. The variable window_change_flags is set to a bit
2127 mask indicating whether new matrices will be allocated or
2128 existing matrices change their size or location within the frame
2130 window_change_flags
= 0;
2132 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2135 &window_change_flags
);
2137 /* Add in menu bar lines, if any. */
2138 matrix_dim
.height
+= top_window_y
;
2140 /* Enlarge pools as necessary. */
2141 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2142 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2144 /* Set up glyph pointers within window matrices. Do this only if
2145 absolutely necessary since it requires a frame redraw. */
2146 if (pool_changed_p
|| window_change_flags
)
2148 /* Do it for window matrices. */
2149 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2151 &window_change_flags
);
2153 /* Size of frame matrices must equal size of frame. Note
2154 that we are called for X frames with window widths NOT equal
2155 to the frame width (from CHANGE_FRAME_SIZE_1). */
2156 xassert (matrix_dim
.width
== FRAME_COLS (f
)
2157 && matrix_dim
.height
== FRAME_LINES (f
));
2159 /* Pointers to glyph memory in glyph rows are exchanged during
2160 the update phase of redisplay, which means in general that a
2161 frame's current matrix consists of pointers into both the
2162 desired and current glyph pool of the frame. Adjusting a
2163 matrix sets the frame matrix up so that pointers are all into
2164 the same pool. If we want to preserve glyph contents of the
2165 current matrix over a call to adjust_glyph_matrix, we must
2166 make a copy of the current glyphs, and restore the current
2167 matrix' contents from that copy. */
2168 if (display_completed
2169 && !FRAME_GARBAGED_P (f
)
2170 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2171 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2172 /* For some reason, the frame glyph matrix gets corrupted if
2173 any of the windows contain margins. I haven't been able
2174 to hunt down the reason, but for the moment this prevents
2175 the problem from manifesting. -- cyd */
2176 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2178 struct glyph_matrix
*copy
= save_current_matrix (f
);
2179 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2180 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2181 restore_current_matrix (f
, copy
);
2182 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2186 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2187 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2188 SET_FRAME_GARBAGED (f
);
2194 /* Allocate/reallocate glyph matrices of a single frame F for
2195 window-based redisplay. */
2198 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2200 xassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2202 /* Allocate/reallocate window matrices. */
2203 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2205 #ifdef HAVE_X_WINDOWS
2206 /* Allocate/ reallocate matrices of the dummy window used to display
2207 the menu bar under X when no X toolkit support is available. */
2208 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2210 /* Allocate a dummy window if not already done. */
2212 if (NILP (f
->menu_bar_window
))
2214 f
->menu_bar_window
= make_window ();
2215 w
= XWINDOW (f
->menu_bar_window
);
2216 XSETFRAME (w
->frame
, f
);
2217 w
->pseudo_window_p
= 1;
2220 w
= XWINDOW (f
->menu_bar_window
);
2222 /* Set window dimensions to frame dimensions and allocate or
2223 adjust glyph matrices of W. */
2224 XSETFASTINT (w
->top_line
, 0);
2225 XSETFASTINT (w
->left_col
, 0);
2226 XSETFASTINT (w
->total_lines
, FRAME_MENU_BAR_LINES (f
));
2227 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2228 allocate_matrices_for_window_redisplay (w
);
2230 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2231 #endif /* HAVE_X_WINDOWS */
2235 /* Allocate/ reallocate matrices of the tool bar window. If we
2236 don't have a tool bar window yet, make one. */
2238 if (NILP (f
->tool_bar_window
))
2240 f
->tool_bar_window
= make_window ();
2241 w
= XWINDOW (f
->tool_bar_window
);
2242 XSETFRAME (w
->frame
, f
);
2243 w
->pseudo_window_p
= 1;
2246 w
= XWINDOW (f
->tool_bar_window
);
2248 XSETFASTINT (w
->top_line
, FRAME_MENU_BAR_LINES (f
));
2249 XSETFASTINT (w
->left_col
, 0);
2250 XSETFASTINT (w
->total_lines
, FRAME_TOOL_BAR_LINES (f
));
2251 XSETFASTINT (w
->total_cols
, FRAME_TOTAL_COLS (f
));
2252 allocate_matrices_for_window_redisplay (w
);
2258 /* Adjust/ allocate message buffer of frame F.
2260 Note that the message buffer is never freed. Since I could not
2261 find a free in 19.34, I assume that freeing it would be
2262 problematic in some way and don't do it either.
2264 (Implementation note: It should be checked if we can free it
2265 eventually without causing trouble). */
2268 adjust_frame_message_buffer (struct frame
*f
)
2270 ptrdiff_t size
= FRAME_MESSAGE_BUF_SIZE (f
) + 1;
2272 if (FRAME_MESSAGE_BUF (f
))
2274 char *buffer
= FRAME_MESSAGE_BUF (f
);
2275 char *new_buffer
= (char *) xrealloc (buffer
, size
);
2276 FRAME_MESSAGE_BUF (f
) = new_buffer
;
2279 FRAME_MESSAGE_BUF (f
) = (char *) xmalloc (size
);
2283 /* Re-allocate buffer for decode_mode_spec on frame F. */
2286 adjust_decode_mode_spec_buffer (struct frame
*f
)
2288 f
->decode_mode_spec_buffer
2289 = (char *) xrealloc (f
->decode_mode_spec_buffer
,
2290 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2295 /**********************************************************************
2296 Freeing Glyph Matrices
2297 **********************************************************************/
2299 /* Free glyph memory for a frame F. F may be null. This function can
2300 be called for the same frame more than once. The root window of
2301 F may be nil when this function is called. This is the case when
2302 the function is called when F is destroyed. */
2305 free_glyphs (struct frame
*f
)
2307 if (f
&& f
->glyphs_initialized_p
)
2309 /* Block interrupt input so that we don't get surprised by an X
2310 event while we're in an inconsistent state. */
2312 f
->glyphs_initialized_p
= 0;
2314 /* Release window sub-matrices. */
2315 if (!NILP (f
->root_window
))
2316 free_window_matrices (XWINDOW (f
->root_window
));
2318 /* Free the dummy window for menu bars without X toolkit and its
2320 if (!NILP (f
->menu_bar_window
))
2322 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2323 free_glyph_matrix (w
->desired_matrix
);
2324 free_glyph_matrix (w
->current_matrix
);
2325 w
->desired_matrix
= w
->current_matrix
= NULL
;
2326 f
->menu_bar_window
= Qnil
;
2329 /* Free the tool bar window and its glyph matrices. */
2330 if (!NILP (f
->tool_bar_window
))
2332 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2333 free_glyph_matrix (w
->desired_matrix
);
2334 free_glyph_matrix (w
->current_matrix
);
2335 w
->desired_matrix
= w
->current_matrix
= NULL
;
2336 f
->tool_bar_window
= Qnil
;
2339 /* Release frame glyph matrices. Reset fields to zero in
2340 case we are called a second time. */
2341 if (f
->desired_matrix
)
2343 free_glyph_matrix (f
->desired_matrix
);
2344 free_glyph_matrix (f
->current_matrix
);
2345 f
->desired_matrix
= f
->current_matrix
= NULL
;
2348 /* Release glyph pools. */
2349 if (f
->desired_pool
)
2351 free_glyph_pool (f
->desired_pool
);
2352 free_glyph_pool (f
->current_pool
);
2353 f
->desired_pool
= f
->current_pool
= NULL
;
2361 /* Free glyph sub-matrices in the window tree rooted at W. This
2362 function may be called with a null pointer, and it may be called on
2363 the same tree more than once. */
2366 free_window_matrices (struct window
*w
)
2370 if (!NILP (w
->hchild
))
2371 free_window_matrices (XWINDOW (w
->hchild
));
2372 else if (!NILP (w
->vchild
))
2373 free_window_matrices (XWINDOW (w
->vchild
));
2376 /* This is a leaf window. Free its memory and reset fields
2377 to zero in case this function is called a second time for
2379 free_glyph_matrix (w
->current_matrix
);
2380 free_glyph_matrix (w
->desired_matrix
);
2381 w
->current_matrix
= w
->desired_matrix
= NULL
;
2384 /* Next window on same level. */
2385 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2390 /* Check glyph memory leaks. This function is called from
2391 shut_down_emacs. Note that frames are not destroyed when Emacs
2392 exits. We therefore free all glyph memory for all active frames
2393 explicitly and check that nothing is left allocated. */
2396 check_glyph_memory (void)
2398 Lisp_Object tail
, frame
;
2400 /* Free glyph memory for all frames. */
2401 FOR_EACH_FRAME (tail
, frame
)
2402 free_glyphs (XFRAME (frame
));
2404 /* Check that nothing is left allocated. */
2405 if (glyph_matrix_count
)
2407 if (glyph_pool_count
)
2413 /**********************************************************************
2414 Building a Frame Matrix
2415 **********************************************************************/
2417 /* Most of the redisplay code works on glyph matrices attached to
2418 windows. This is a good solution most of the time, but it is not
2419 suitable for terminal code. Terminal output functions cannot rely
2420 on being able to set an arbitrary terminal window. Instead they
2421 must be provided with a view of the whole frame, i.e. the whole
2422 screen. We build such a view by constructing a frame matrix from
2423 window matrices in this section.
2425 Windows that must be updated have their must_be_update_p flag set.
2426 For all such windows, their desired matrix is made part of the
2427 desired frame matrix. For other windows, their current matrix is
2428 made part of the desired frame matrix.
2430 +-----------------+----------------+
2431 | desired | desired |
2433 +-----------------+----------------+
2436 +----------------------------------+
2438 Desired window matrices can be made part of the frame matrix in a
2439 cheap way: We exploit the fact that the desired frame matrix and
2440 desired window matrices share their glyph memory. This is not
2441 possible for current window matrices. Their glyphs are copied to
2442 the desired frame matrix. The latter is equivalent to
2443 preserve_other_columns in the old redisplay.
2445 Used glyphs counters for frame matrix rows are the result of adding
2446 up glyph lengths of the window matrices. A line in the frame
2447 matrix is enabled, if a corresponding line in a window matrix is
2450 After building the desired frame matrix, it will be passed to
2451 terminal code, which will manipulate both the desired and current
2452 frame matrix. Changes applied to the frame's current matrix have
2453 to be visible in current window matrices afterwards, of course.
2455 This problem is solved like this:
2457 1. Window and frame matrices share glyphs. Window matrices are
2458 constructed in a way that their glyph contents ARE the glyph
2459 contents needed in a frame matrix. Thus, any modification of
2460 glyphs done in terminal code will be reflected in window matrices
2463 2. Exchanges of rows in a frame matrix done by terminal code are
2464 intercepted by hook functions so that corresponding row operations
2465 on window matrices can be performed. This is necessary because we
2466 use pointers to glyphs in glyph row structures. To satisfy the
2467 assumption of point 1 above that glyphs are updated implicitly in
2468 window matrices when they are manipulated via the frame matrix,
2469 window and frame matrix must of course agree where to find the
2470 glyphs for their rows. Possible manipulations that must be
2471 mirrored are assignments of rows of the desired frame matrix to the
2472 current frame matrix and scrolling the current frame matrix. */
2474 /* Build frame F's desired matrix from window matrices. Only windows
2475 which have the flag must_be_updated_p set have to be updated. Menu
2476 bar lines of a frame are not covered by window matrices, so make
2477 sure not to touch them in this function. */
2480 build_frame_matrix (struct frame
*f
)
2484 /* F must have a frame matrix when this function is called. */
2485 xassert (!FRAME_WINDOW_P (f
));
2487 /* Clear all rows in the frame matrix covered by window matrices.
2488 Menu bar lines are not covered by windows. */
2489 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2490 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2492 /* Build the matrix by walking the window tree. */
2493 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2494 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2498 /* Walk a window tree, building a frame matrix MATRIX from window
2499 matrices. W is the root of a window tree. */
2502 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2506 if (!NILP (w
->hchild
))
2507 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2508 else if (!NILP (w
->vchild
))
2509 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2511 build_frame_matrix_from_leaf_window (matrix
, w
);
2513 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2518 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2519 desired frame matrix built. W is a leaf window whose desired or
2520 current matrix is to be added to FRAME_MATRIX. W's flag
2521 must_be_updated_p determines which matrix it contributes to
2522 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2523 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2524 Adding a desired matrix means setting up used counters and such in
2525 frame rows, while adding a current window matrix to FRAME_MATRIX
2526 means copying glyphs. The latter case corresponds to
2527 preserve_other_columns in the old redisplay. */
2530 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2532 struct glyph_matrix
*window_matrix
;
2533 int window_y
, frame_y
;
2534 /* If non-zero, a glyph to insert at the right border of W. */
2535 GLYPH right_border_glyph
;
2537 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2539 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2540 if (w
->must_be_updated_p
)
2542 window_matrix
= w
->desired_matrix
;
2544 /* Decide whether we want to add a vertical border glyph. */
2545 if (!WINDOW_RIGHTMOST_P (w
))
2547 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2550 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2552 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2554 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2555 spec_glyph_lookup_face (w
, &right_border_glyph
);
2558 if (GLYPH_FACE (right_border_glyph
) <= 0)
2559 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2563 window_matrix
= w
->current_matrix
;
2565 /* For all rows in the window matrix and corresponding rows in the
2568 frame_y
= window_matrix
->matrix_y
;
2569 while (window_y
< window_matrix
->nrows
)
2571 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2572 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2573 int current_row_p
= window_matrix
== w
->current_matrix
;
2575 /* Fill up the frame row with spaces up to the left margin of the
2577 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2579 /* Fill up areas in the window matrix row with spaces. */
2580 fill_up_glyph_row_with_spaces (window_row
);
2582 /* If only part of W's desired matrix has been built, and
2583 window_row wasn't displayed, use the corresponding current
2585 if (window_matrix
== w
->desired_matrix
2586 && !window_row
->enabled_p
)
2588 window_row
= w
->current_matrix
->rows
+ window_y
;
2594 /* Copy window row to frame row. */
2595 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2596 window_row
->glyphs
[0],
2597 window_matrix
->matrix_w
* sizeof (struct glyph
));
2601 xassert (window_row
->enabled_p
);
2603 /* Only when a desired row has been displayed, we want
2604 the corresponding frame row to be updated. */
2605 frame_row
->enabled_p
= 1;
2607 /* Maybe insert a vertical border between horizontally adjacent
2609 if (GLYPH_CHAR (right_border_glyph
) != 0)
2611 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2612 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2616 /* Window row window_y must be a slice of frame row
2618 xassert (glyph_row_slice_p (window_row
, frame_row
));
2620 /* If rows are in sync, we don't have to copy glyphs because
2621 frame and window share glyphs. */
2623 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2624 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2628 /* Set number of used glyphs in the frame matrix. Since we fill
2629 up with spaces, and visit leaf windows from left to right it
2630 can be done simply. */
2631 frame_row
->used
[TEXT_AREA
]
2632 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2640 /* Given a user-specified glyph, possibly including a Lisp-level face
2641 ID, return a glyph that has a realized face ID.
2642 This is used for glyphs displayed specially and not part of the text;
2643 for instance, vertical separators, truncation markers, etc. */
2646 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2648 int lface_id
= GLYPH_FACE (*glyph
);
2649 /* Convert the glyph's specified face to a realized (cache) face. */
2652 int face_id
= merge_faces (XFRAME (w
->frame
),
2653 Qt
, lface_id
, DEFAULT_FACE_ID
);
2654 SET_GLYPH_FACE (*glyph
, face_id
);
2658 /* Add spaces to a glyph row ROW in a window matrix.
2660 Each row has the form:
2662 +---------+-----------------------------+------------+
2663 | left | text | right |
2664 +---------+-----------------------------+------------+
2666 Left and right marginal areas are optional. This function adds
2667 spaces to areas so that there are no empty holes between areas.
2668 In other words: If the right area is not empty, the text area
2669 is filled up with spaces up to the right area. If the text area
2670 is not empty, the left area is filled up.
2672 To be called for frame-based redisplay, only. */
2675 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2677 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2678 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2679 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2683 /* Fill area AREA of glyph row ROW with spaces. To be called for
2684 frame-based redisplay only. */
2687 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2689 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2691 struct glyph
*end
= row
->glyphs
[area
+ 1];
2692 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2695 *text
++ = space_glyph
;
2696 row
->used
[area
] = text
- row
->glyphs
[area
];
2701 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2702 reached. In frame matrices only one area, TEXT_AREA, is used. */
2705 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2707 int i
= row
->used
[TEXT_AREA
];
2708 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2711 glyph
[i
++] = space_glyph
;
2713 row
->used
[TEXT_AREA
] = i
;
2718 /**********************************************************************
2719 Mirroring operations on frame matrices in window matrices
2720 **********************************************************************/
2722 /* Set frame being updated via frame-based redisplay to F. This
2723 function must be called before updates to make explicit that we are
2724 working on frame matrices or not. */
2727 set_frame_matrix_frame (struct frame
*f
)
2729 frame_matrix_frame
= f
;
2733 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2734 DESIRED_MATRIX is the desired matrix corresponding to
2735 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2736 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2737 frame_matrix_frame is non-null, this indicates that the exchange is
2738 done in frame matrices, and that we have to perform analogous
2739 operations in window matrices of frame_matrix_frame. */
2742 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2744 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2745 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2746 int mouse_face_p
= current_row
->mouse_face_p
;
2748 /* Do current_row = desired_row. This exchanges glyph pointers
2749 between both rows, and does a structure assignment otherwise. */
2750 assign_row (current_row
, desired_row
);
2752 /* Enable current_row to mark it as valid. */
2753 current_row
->enabled_p
= 1;
2754 current_row
->mouse_face_p
= mouse_face_p
;
2756 /* If we are called on frame matrices, perform analogous operations
2757 for window matrices. */
2758 if (frame_matrix_frame
)
2759 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2763 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2764 W's frame which has been made current (by swapping pointers between
2765 current and desired matrix). Perform analogous operations in the
2766 matrices of leaf windows in the window tree rooted at W. */
2769 mirror_make_current (struct window
*w
, int frame_row
)
2773 if (!NILP (w
->hchild
))
2774 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2775 else if (!NILP (w
->vchild
))
2776 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2779 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2780 here because the checks performed in debug mode there
2781 will not allow the conversion. */
2782 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2784 /* If FRAME_ROW is within W, assign the desired row to the
2785 current row (exchanging glyph pointers). */
2786 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2788 struct glyph_row
*current_row
2789 = MATRIX_ROW (w
->current_matrix
, row
);
2790 struct glyph_row
*desired_row
2791 = MATRIX_ROW (w
->desired_matrix
, row
);
2793 if (desired_row
->enabled_p
)
2794 assign_row (current_row
, desired_row
);
2796 swap_glyph_pointers (desired_row
, current_row
);
2797 current_row
->enabled_p
= 1;
2799 /* Set the Y coordinate of the mode/header line's row.
2800 It is needed in draw_row_with_mouse_face to find the
2801 screen coordinates. (Window-based redisplay sets
2802 this in update_window, but no one seems to do that
2803 for frame-based redisplay.) */
2804 if (current_row
->mode_line_p
)
2805 current_row
->y
= row
;
2809 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2814 /* Perform row dance after scrolling. We are working on the range of
2815 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2816 including) in MATRIX. COPY_FROM is a vector containing, for each
2817 row I in the range 0 <= I < NLINES, the index of the original line
2818 to move to I. This index is relative to the row range, i.e. 0 <=
2819 index < NLINES. RETAINED_P is a vector containing zero for each
2820 row 0 <= I < NLINES which is empty.
2822 This function is called from do_scrolling and do_direct_scrolling. */
2825 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2826 int *copy_from
, char *retained_p
)
2828 /* A copy of original rows. */
2829 struct glyph_row
*old_rows
;
2831 /* Rows to assign to. */
2832 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2836 /* Make a copy of the original rows. */
2837 old_rows
= (struct glyph_row
*) alloca (nlines
* sizeof *old_rows
);
2838 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2840 /* Assign new rows, maybe clear lines. */
2841 for (i
= 0; i
< nlines
; ++i
)
2843 int enabled_before_p
= new_rows
[i
].enabled_p
;
2845 xassert (i
+ unchanged_at_top
< matrix
->nrows
);
2846 xassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2847 new_rows
[i
] = old_rows
[copy_from
[i
]];
2848 new_rows
[i
].enabled_p
= enabled_before_p
;
2850 /* RETAINED_P is zero for empty lines. */
2851 if (!retained_p
[copy_from
[i
]])
2852 new_rows
[i
].enabled_p
= 0;
2855 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2856 if (frame_matrix_frame
)
2857 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2858 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2862 /* Synchronize glyph pointers in the current matrix of window W with
2863 the current frame matrix. */
2866 sync_window_with_frame_matrix_rows (struct window
*w
)
2868 struct frame
*f
= XFRAME (w
->frame
);
2869 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2870 int left
, right
, x
, width
;
2872 /* Preconditions: W must be a leaf window on a tty frame. */
2873 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2874 xassert (!FRAME_WINDOW_P (f
));
2876 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2877 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2878 x
= w
->current_matrix
->matrix_x
;
2879 width
= w
->current_matrix
->matrix_w
;
2881 window_row
= w
->current_matrix
->rows
;
2882 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2883 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2885 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2887 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2888 = frame_row
->glyphs
[0] + x
;
2889 window_row
->glyphs
[TEXT_AREA
]
2890 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2891 window_row
->glyphs
[LAST_AREA
]
2892 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2893 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2894 = window_row
->glyphs
[LAST_AREA
] - right
;
2899 /* Return the window in the window tree rooted in W containing frame
2900 row ROW. Value is null if none is found. */
2902 static struct window
*
2903 frame_row_to_window (struct window
*w
, int row
)
2905 struct window
*found
= NULL
;
2909 if (!NILP (w
->hchild
))
2910 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2911 else if (!NILP (w
->vchild
))
2912 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2913 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2914 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2917 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2924 /* Perform a line dance in the window tree rooted at W, after
2925 scrolling a frame matrix in mirrored_line_dance.
2927 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2928 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2929 COPY_FROM is a vector containing, for each row I in the range 0 <=
2930 I < NLINES, the index of the original line to move to I. This
2931 index is relative to the row range, i.e. 0 <= index < NLINES.
2932 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2936 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2940 if (!NILP (w
->hchild
))
2941 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2942 nlines
, copy_from
, retained_p
);
2943 else if (!NILP (w
->vchild
))
2944 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2945 nlines
, copy_from
, retained_p
);
2948 /* W is a leaf window, and we are working on its current
2950 struct glyph_matrix
*m
= w
->current_matrix
;
2952 struct glyph_row
*old_rows
;
2954 /* Make a copy of the original rows of matrix m. */
2955 old_rows
= (struct glyph_row
*) alloca (m
->nrows
* sizeof *old_rows
);
2956 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2958 for (i
= 0; i
< nlines
; ++i
)
2960 /* Frame relative line assigned to. */
2961 int frame_to
= i
+ unchanged_at_top
;
2963 /* Frame relative line assigned. */
2964 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2966 /* Window relative line assigned to. */
2967 int window_to
= frame_to
- m
->matrix_y
;
2969 /* Window relative line assigned. */
2970 int window_from
= frame_from
- m
->matrix_y
;
2972 /* Is assigned line inside window? */
2973 int from_inside_window_p
2974 = window_from
>= 0 && window_from
< m
->matrix_h
;
2976 /* Is assigned to line inside window? */
2977 int to_inside_window_p
2978 = window_to
>= 0 && window_to
< m
->matrix_h
;
2980 if (from_inside_window_p
&& to_inside_window_p
)
2982 /* Enabled setting before assignment. */
2983 int enabled_before_p
;
2985 /* Do the assignment. The enabled_p flag is saved
2986 over the assignment because the old redisplay did
2988 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2989 m
->rows
[window_to
] = old_rows
[window_from
];
2990 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2992 /* If frame line is empty, window line is empty, too. */
2993 if (!retained_p
[copy_from
[i
]])
2994 m
->rows
[window_to
].enabled_p
= 0;
2996 else if (to_inside_window_p
)
2998 /* A copy between windows. This is an infrequent
2999 case not worth optimizing. */
3000 struct frame
*f
= XFRAME (w
->frame
);
3001 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
3003 struct glyph_matrix
*m2
;
3006 w2
= frame_row_to_window (root
, frame_from
);
3007 /* ttn@surf.glug.org: when enabling menu bar using `emacs
3008 -nw', FROM_FRAME sometimes has no associated window.
3009 This check avoids a segfault if W2 is null. */
3012 m2
= w2
->current_matrix
;
3013 m2_from
= frame_from
- m2
->matrix_y
;
3014 copy_row_except_pointers (m
->rows
+ window_to
,
3015 m2
->rows
+ m2_from
);
3017 /* If frame line is empty, window line is empty, too. */
3018 if (!retained_p
[copy_from
[i
]])
3019 m
->rows
[window_to
].enabled_p
= 0;
3023 else if (from_inside_window_p
)
3027 /* If there was a copy between windows, make sure glyph
3028 pointers are in sync with the frame matrix. */
3030 sync_window_with_frame_matrix_rows (w
);
3032 /* Check that no pointers are lost. */
3036 /* Next window on same level. */
3037 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3044 /* Check that window and frame matrices agree about their
3045 understanding where glyphs of the rows are to find. For each
3046 window in the window tree rooted at W, check that rows in the
3047 matrices of leaf window agree with their frame matrices about
3051 check_window_matrix_pointers (struct window
*w
)
3055 if (!NILP (w
->hchild
))
3056 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3057 else if (!NILP (w
->vchild
))
3058 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3061 struct frame
*f
= XFRAME (w
->frame
);
3062 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3063 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3066 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3071 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3072 a window and FRAME_MATRIX is the corresponding frame matrix. For
3073 each row in WINDOW_MATRIX check that it's a slice of the
3074 corresponding frame row. If it isn't, abort. */
3077 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3078 struct glyph_matrix
*frame_matrix
)
3080 /* Row number in WINDOW_MATRIX. */
3083 /* Row number corresponding to I in FRAME_MATRIX. */
3084 int j
= window_matrix
->matrix_y
;
3086 /* For all rows check that the row in the window matrix is a
3087 slice of the row in the frame matrix. If it isn't we didn't
3088 mirror an operation on the frame matrix correctly. */
3089 while (i
< window_matrix
->nrows
)
3091 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3092 frame_matrix
->rows
+ j
))
3098 #endif /* GLYPH_DEBUG != 0 */
3102 /**********************************************************************
3103 VPOS and HPOS translations
3104 **********************************************************************/
3108 /* Translate vertical position VPOS which is relative to window W to a
3109 vertical position relative to W's frame. */
3112 window_to_frame_vpos (struct window
*w
, int vpos
)
3114 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3115 xassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3116 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3117 xassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3122 /* Translate horizontal position HPOS which is relative to window W to
3123 a horizontal position relative to W's frame. */
3126 window_to_frame_hpos (struct window
*w
, int hpos
)
3128 xassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3129 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3133 #endif /* GLYPH_DEBUG */
3137 /**********************************************************************
3139 **********************************************************************/
3141 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3142 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3147 CHECK_LIVE_FRAME (frame
);
3150 /* Ignore redraw requests, if frame has no glyphs yet.
3151 (Implementation note: It still has to be checked why we are
3152 called so early here). */
3153 if (!glyphs_initialized_initially_p
)
3158 if (FRAME_MSDOS_P (f
))
3159 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3162 clear_current_matrices (f
);
3164 if (FRAME_TERMCAP_P (f
))
3165 fflush (FRAME_TTY (f
)->output
);
3166 windows_or_buffers_changed
++;
3167 /* Mark all windows as inaccurate, so that every window will have
3168 its redisplay done. */
3169 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3170 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3176 /* Redraw frame F. This is nothing more than a call to the Lisp
3177 function redraw-frame. */
3180 redraw_frame (struct frame
*f
)
3183 XSETFRAME (frame
, f
);
3184 Fredraw_frame (frame
);
3188 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3189 doc
: /* Clear and redisplay all visible frames. */)
3192 Lisp_Object tail
, frame
;
3194 FOR_EACH_FRAME (tail
, frame
)
3195 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3196 Fredraw_frame (frame
);
3203 /***********************************************************************
3205 ***********************************************************************/
3207 /* Update frame F based on the data in desired matrices.
3209 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3210 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3213 Value is non-zero if redisplay was stopped due to pending input. */
3216 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3218 /* 1 means display has been paused because of pending input. */
3220 struct window
*root_window
= XWINDOW (f
->root_window
);
3222 if (redisplay_dont_pause
)
3224 #if PERIODIC_PREEMPTION_CHECKING
3225 else if (NILP (Vredisplay_preemption_period
))
3227 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3230 double p
= XFLOATINT (Vredisplay_preemption_period
);
3233 if (detect_input_pending_ignore_squeezables ())
3240 usec
= (p
- sec
) * 1000000;
3242 EMACS_GET_TIME (tm
);
3243 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3244 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3248 if (FRAME_WINDOW_P (f
))
3250 /* We are working on window matrix basis. All windows whose
3251 flag must_be_updated_p is set have to be updated. */
3253 /* Record that we are not working on frame matrices. */
3254 set_frame_matrix_frame (NULL
);
3256 /* Update all windows in the window tree of F, maybe stopping
3257 when pending input is detected. */
3260 /* Update the menu bar on X frames that don't have toolkit
3262 if (WINDOWP (f
->menu_bar_window
))
3263 update_window (XWINDOW (f
->menu_bar_window
), 1);
3265 /* Update the tool-bar window, if present. */
3266 if (WINDOWP (f
->tool_bar_window
))
3268 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3270 /* Update tool-bar window. */
3271 if (w
->must_be_updated_p
)
3275 update_window (w
, 1);
3276 w
->must_be_updated_p
= 0;
3278 /* Swap tool-bar strings. We swap because we want to
3280 tem
= f
->current_tool_bar_string
;
3281 f
->current_tool_bar_string
= f
->desired_tool_bar_string
;
3282 f
->desired_tool_bar_string
= tem
;
3287 /* Update windows. */
3288 paused_p
= update_window_tree (root_window
, force_p
);
3291 /* This flush is a performance bottleneck under X,
3292 and it doesn't seem to be necessary anyway (in general).
3293 It is necessary when resizing the window with the mouse, or
3294 at least the fringes are not redrawn in a timely manner. ++kfs */
3295 if (f
->force_flush_display_p
)
3297 FRAME_RIF (f
)->flush_display (f
);
3298 f
->force_flush_display_p
= 0;
3303 /* We are working on frame matrix basis. Set the frame on whose
3304 frame matrix we operate. */
3305 set_frame_matrix_frame (f
);
3307 /* Build F's desired matrix from window matrices. */
3308 build_frame_matrix (f
);
3310 /* Update the display */
3312 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3315 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3317 if (FRAME_TTY (f
)->termscript
)
3318 fflush (FRAME_TTY (f
)->termscript
);
3319 if (FRAME_TERMCAP_P (f
))
3320 fflush (FRAME_TTY (f
)->output
);
3323 /* Check window matrices for lost pointers. */
3325 check_window_matrix_pointers (root_window
);
3326 add_frame_display_history (f
, paused_p
);
3330 #if PERIODIC_PREEMPTION_CHECKING
3333 /* Reset flags indicating that a window should be updated. */
3334 set_window_update_flags (root_window
, 0);
3336 display_completed
= !paused_p
;
3340 /* Update a TTY frame F that has a menu dropped down over some of its
3341 glyphs. This is like the second part of update_frame, but it
3342 doesn't call build_frame_matrix, because we already have the
3343 desired matrix prepared, and don't want it to be overwritten by the
3344 text of the normal display. */
3346 update_frame_with_menu (struct frame
*f
)
3348 struct window
*root_window
= XWINDOW (f
->root_window
);
3350 xassert (FRAME_TERMCAP_P (f
));
3352 /* We are working on frame matrix basis. Set the frame on whose
3353 frame matrix we operate. */
3354 set_frame_matrix_frame (f
);
3356 /* Update the display */
3358 paused_p
= update_frame_1 (f
, 1, 1);
3361 if (FRAME_TTY (f
)->termscript
)
3362 fflush (FRAME_TTY (f
)->termscript
);
3363 fflush (FRAME_TTY (f
)->output
);
3364 /* Check window matrices for lost pointers. */
3366 check_window_matrix_pointers (root_window
);
3367 add_frame_display_history (f
, paused_p
);
3370 /* Reset flags indicating that a window should be updated. */
3371 set_window_update_flags (root_window
, 0);
3375 /************************************************************************
3376 Window-based updates
3377 ************************************************************************/
3379 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3380 don't stop updating when input is pending. */
3383 update_window_tree (struct window
*w
, int force_p
)
3387 while (w
&& !paused_p
)
3389 if (!NILP (w
->hchild
))
3390 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3391 else if (!NILP (w
->vchild
))
3392 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3393 else if (w
->must_be_updated_p
)
3394 paused_p
|= update_window (w
, force_p
);
3396 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3403 /* Update window W if its flag must_be_updated_p is non-zero. If
3404 FORCE_P is non-zero, don't stop updating if input is pending. */
3407 update_single_window (struct window
*w
, int force_p
)
3409 if (w
->must_be_updated_p
)
3411 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3413 /* Record that this is not a frame-based redisplay. */
3414 set_frame_matrix_frame (NULL
);
3416 if (redisplay_dont_pause
)
3418 #if PERIODIC_PREEMPTION_CHECKING
3419 else if (NILP (Vredisplay_preemption_period
))
3421 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3424 double p
= XFLOATINT (Vredisplay_preemption_period
);
3428 usec
= (p
- sec
) * 1000000;
3430 EMACS_GET_TIME (tm
);
3431 EMACS_SET_SECS_USECS (preemption_period
, sec
, usec
);
3432 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3438 update_window (w
, force_p
);
3441 /* Reset flag in W. */
3442 w
->must_be_updated_p
= 0;
3446 #ifdef HAVE_WINDOW_SYSTEM
3448 /* Redraw lines from the current matrix of window W that are
3449 overlapped by other rows. YB is bottom-most y-position in W. */
3452 redraw_overlapped_rows (struct window
*w
, int yb
)
3455 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3457 /* If rows overlapping others have been changed, the rows being
3458 overlapped have to be redrawn. This won't draw lines that have
3459 already been drawn in update_window_line because overlapped_p in
3460 desired rows is 0, so after row assignment overlapped_p in
3461 current rows is 0. */
3462 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3464 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3466 if (!row
->enabled_p
)
3468 else if (row
->mode_line_p
)
3471 if (row
->overlapped_p
)
3473 enum glyph_row_area area
;
3475 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3478 updated_area
= area
;
3479 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3480 area
== TEXT_AREA
? row
->x
: 0);
3481 if (row
->used
[area
])
3482 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3484 FRAME_RIF (f
)->clear_end_of_line (-1);
3487 row
->overlapped_p
= 0;
3490 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3496 /* Redraw lines from the current matrix of window W that overlap
3497 others. YB is bottom-most y-position in W. */
3500 redraw_overlapping_rows (struct window
*w
, int yb
)
3503 struct glyph_row
*row
;
3504 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3506 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3508 row
= w
->current_matrix
->rows
+ i
;
3510 if (!row
->enabled_p
)
3512 else if (row
->mode_line_p
)
3515 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3517 if (row
->overlapping_p
)
3521 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3522 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3523 overlaps
|= OVERLAPS_PRED
;
3524 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3525 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3526 overlaps
|= OVERLAPS_SUCC
;
3530 if (row
->used
[LEFT_MARGIN_AREA
])
3531 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3533 if (row
->used
[TEXT_AREA
])
3534 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3536 if (row
->used
[RIGHT_MARGIN_AREA
])
3537 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3539 /* Record in neighbor rows that ROW overwrites part of
3541 if (overlaps
& OVERLAPS_PRED
)
3542 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3543 if (overlaps
& OVERLAPS_SUCC
)
3544 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3553 #endif /* HAVE_WINDOW_SYSTEM */
3556 #if defined GLYPH_DEBUG && 0
3558 /* Check that no row in the current matrix of window W is enabled
3559 which is below what's displayed in the window. */
3562 check_current_matrix_flags (struct window
*w
)
3564 int last_seen_p
= 0;
3565 int i
, yb
= window_text_bottom_y (w
);
3567 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3569 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3570 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3572 else if (last_seen_p
&& row
->enabled_p
)
3577 #endif /* GLYPH_DEBUG */
3580 /* Update display of window W. FORCE_P non-zero means that we should
3581 not stop when detecting pending input. */
3584 update_window (struct window
*w
, int force_p
)
3586 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3588 #if !PERIODIC_PREEMPTION_CHECKING
3589 int preempt_count
= baud_rate
/ 2400 + 1;
3591 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3593 /* Check that W's frame doesn't have glyph matrices. */
3594 xassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3597 /* Check pending input the first time so that we can quickly return. */
3598 #if !PERIODIC_PREEMPTION_CHECKING
3600 detect_input_pending_ignore_squeezables ();
3603 /* If forced to complete the update, or if no input is pending, do
3605 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3607 struct glyph_row
*row
, *end
;
3608 struct glyph_row
*mode_line_row
;
3609 struct glyph_row
*header_line_row
;
3610 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3611 #if ! PERIODIC_PREEMPTION_CHECKING
3615 rif
->update_window_begin_hook (w
);
3616 yb
= window_text_bottom_y (w
);
3617 row
= desired_matrix
->rows
;
3618 end
= row
+ desired_matrix
->nrows
- 1;
3620 /* Take note of the header line, if there is one. We will
3621 update it below, after updating all of the window's lines. */
3622 if (row
->mode_line_p
)
3624 header_line_row
= row
;
3628 header_line_row
= NULL
;
3630 /* Update the mode line, if necessary. */
3631 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3632 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3634 mode_line_row
->y
= yb
;
3635 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3637 &mouse_face_overwritten_p
);
3640 /* Find first enabled row. Optimizations in redisplay_internal
3641 may lead to an update with only one row enabled. There may
3642 be also completely empty matrices. */
3643 while (row
< end
&& !row
->enabled_p
)
3646 /* Try reusing part of the display by copying. */
3647 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3649 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3652 /* All rows were found to be equal. */
3658 /* We've scrolled the display. */
3664 /* Update the rest of the lines. */
3665 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3666 /* scrolling_window resets the enabled_p flag of the rows it
3667 reuses from current_matrix. */
3670 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3673 /* We'll have to play a little bit with when to
3674 detect_input_pending. If it's done too often,
3675 scrolling large windows with repeated scroll-up
3676 commands will too quickly pause redisplay. */
3677 #if PERIODIC_PREEMPTION_CHECKING
3681 EMACS_GET_TIME (tm
);
3682 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
3683 if (EMACS_TIME_NEG_P (dif
))
3685 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
3686 if (detect_input_pending_ignore_squeezables ())
3691 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3692 detect_input_pending_ignore_squeezables ();
3694 changed_p
|= update_window_line (w
, vpos
,
3695 &mouse_face_overwritten_p
);
3697 /* Mark all rows below the last visible one in the current
3698 matrix as invalid. This is necessary because of
3699 variable line heights. Consider the case of three
3700 successive redisplays, where the first displays 5
3701 lines, the second 3 lines, and the third 5 lines again.
3702 If the second redisplay wouldn't mark rows in the
3703 current matrix invalid, the third redisplay might be
3704 tempted to optimize redisplay based on lines displayed
3705 in the first redisplay. */
3706 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3707 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3708 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3711 /* Was display preempted? */
3712 paused_p
= row
< end
;
3716 /* Update the header line after scrolling because a new header
3717 line would otherwise overwrite lines at the top of the window
3718 that can be scrolled. */
3719 if (header_line_row
&& header_line_row
->enabled_p
)
3721 header_line_row
->y
= 0;
3722 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3725 /* Fix the appearance of overlapping/overlapped rows. */
3726 if (!paused_p
&& !w
->pseudo_window_p
)
3728 #ifdef HAVE_WINDOW_SYSTEM
3729 if (changed_p
&& rif
->fix_overlapping_area
)
3731 redraw_overlapped_rows (w
, yb
);
3732 redraw_overlapping_rows (w
, yb
);
3736 /* Make cursor visible at cursor position of W. */
3737 set_window_cursor_after_update (w
);
3739 #if 0 /* Check that current matrix invariants are satisfied. This is
3740 for debugging only. See the comment of check_matrix_invariants. */
3741 IF_DEBUG (check_matrix_invariants (w
));
3746 /* Remember the redisplay method used to display the matrix. */
3747 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3750 #ifdef HAVE_WINDOW_SYSTEM
3751 update_window_fringes (w
, 0);
3754 /* End the update of window W. Don't set the cursor if we
3755 paused updating the display because in this case,
3756 set_window_cursor_after_update hasn't been called, and
3757 output_cursor doesn't contain the cursor location. */
3758 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3764 /* check_current_matrix_flags (w); */
3765 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3768 clear_glyph_matrix (desired_matrix
);
3774 /* Update the display of area AREA in window W, row number VPOS.
3775 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3778 update_marginal_area (struct window
*w
, int area
, int vpos
)
3780 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3781 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3783 /* Let functions in xterm.c know what area subsequent X positions
3784 will be relative to. */
3785 updated_area
= area
;
3787 /* Set cursor to start of glyphs, write them, and clear to the end
3788 of the area. I don't think that something more sophisticated is
3789 necessary here, since marginal areas will not be the default. */
3790 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3791 if (desired_row
->used
[area
])
3792 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3793 rif
->clear_end_of_line (-1);
3797 /* Update the display of the text area of row VPOS in window W.
3798 Value is non-zero if display has changed. */
3801 update_text_area (struct window
*w
, int vpos
)
3803 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3804 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3805 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3808 /* Let functions in xterm.c know what area subsequent X positions
3809 will be relative to. */
3810 updated_area
= TEXT_AREA
;
3812 /* If rows are at different X or Y, or rows have different height,
3813 or the current row is marked invalid, write the entire line. */
3814 if (!current_row
->enabled_p
3815 || desired_row
->y
!= current_row
->y
3816 || desired_row
->ascent
!= current_row
->ascent
3817 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3818 || desired_row
->phys_height
!= current_row
->phys_height
3819 || desired_row
->visible_height
!= current_row
->visible_height
3820 || current_row
->overlapped_p
3821 /* This next line is necessary for correctly redrawing
3822 mouse-face areas after scrolling and other operations.
3823 However, it causes excessive flickering when mouse is moved
3824 across the mode line. Luckily, turning it off for the mode
3825 line doesn't seem to hurt anything. -- cyd.
3826 But it is still needed for the header line. -- kfs. */
3827 || (current_row
->mouse_face_p
3828 && !(current_row
->mode_line_p
&& vpos
> 0))
3829 || current_row
->x
!= desired_row
->x
)
3831 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3833 if (desired_row
->used
[TEXT_AREA
])
3834 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3835 desired_row
->used
[TEXT_AREA
]);
3837 /* Clear to end of window. */
3838 rif
->clear_end_of_line (-1);
3841 /* This erases the cursor. We do this here because
3842 notice_overwritten_cursor cannot easily check this, which
3843 might indicate that the whole functionality of
3844 notice_overwritten_cursor would better be implemented here.
3845 On the other hand, we need notice_overwritten_cursor as long
3846 as mouse highlighting is done asynchronously outside of
3848 if (vpos
== w
->phys_cursor
.vpos
)
3849 w
->phys_cursor_on_p
= 0;
3854 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3855 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3856 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3857 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3858 int abort_skipping
= 0;
3860 /* If the desired row extends its face to the text area end, and
3861 unless the current row also does so at the same position,
3862 make sure we write at least one glyph, so that the face
3863 extension actually takes place. */
3864 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3865 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3866 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3867 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3870 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3874 /* Loop over glyphs that current and desired row may have
3878 int can_skip_p
= !abort_skipping
;
3880 /* Skip over glyphs that both rows have in common. These
3881 don't have to be written. We can't skip if the last
3882 current glyph overlaps the glyph to its right. For
3883 example, consider a current row of `if ' with the `f' in
3884 Courier bold so that it overlaps the ` ' to its right.
3885 If the desired row is ` ', we would skip over the space
3886 after the `if' and there would remain a pixel from the
3887 `f' on the screen. */
3888 if (overlapping_glyphs_p
&& i
> 0)
3890 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3893 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3895 can_skip_p
= (right
== 0 && !abort_skipping
);
3903 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3905 x
+= desired_glyph
->pixel_width
;
3906 ++desired_glyph
, ++current_glyph
, ++i
;
3909 /* Consider the case that the current row contains "xxx
3910 ppp ggg" in italic Courier font, and the desired row
3911 is "xxx ggg". The character `p' has lbearing, `g'
3912 has not. The loop above will stop in front of the
3913 first `p' in the current row. If we would start
3914 writing glyphs there, we wouldn't erase the lbearing
3915 of the `p'. The rest of the lbearing problem is then
3916 taken care of by draw_glyphs. */
3917 if (overlapping_glyphs_p
3919 && i
< current_row
->used
[TEXT_AREA
]
3920 && (current_row
->used
[TEXT_AREA
]
3921 != desired_row
->used
[TEXT_AREA
]))
3925 rif
->get_glyph_overhangs (current_glyph
, XFRAME (w
->frame
),
3927 while (left
> 0 && i
> 0)
3929 --i
, --desired_glyph
, --current_glyph
;
3930 x
-= desired_glyph
->pixel_width
;
3931 left
-= desired_glyph
->pixel_width
;
3934 /* Abort the skipping algorithm if we end up before
3935 our starting point, to avoid looping (bug#1070).
3936 This can happen when the lbearing is larger than
3938 abort_skipping
= (i
< start_hpos
);
3942 /* Try to avoid writing the entire rest of the desired row
3943 by looking for a resync point. This mainly prevents
3944 mode line flickering in the case the mode line is in
3945 fixed-pitch font, which it usually will be. */
3946 if (i
< desired_row
->used
[TEXT_AREA
])
3948 int start_x
= x
, start_hpos
= i
;
3949 struct glyph
*start
= desired_glyph
;
3951 int skip_first_p
= !can_skip_p
;
3953 /* Find the next glyph that's equal again. */
3956 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3959 x
+= desired_glyph
->pixel_width
;
3960 current_x
+= current_glyph
->pixel_width
;
3961 ++desired_glyph
, ++current_glyph
, ++i
;
3965 if (i
== start_hpos
|| x
!= current_x
)
3969 desired_glyph
= start
;
3973 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3974 rif
->write_glyphs (start
, i
- start_hpos
);
3979 /* Write the rest. */
3980 if (i
< desired_row
->used
[TEXT_AREA
])
3982 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3983 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3987 /* Maybe clear to end of line. */
3988 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3990 /* If new row extends to the end of the text area, nothing
3991 has to be cleared, if and only if we did a write_glyphs
3992 above. This is made sure by setting desired_stop_pos
3993 appropriately above. */
3994 xassert (i
< desired_row
->used
[TEXT_AREA
]
3995 || ((desired_row
->used
[TEXT_AREA
]
3996 == current_row
->used
[TEXT_AREA
])
3997 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3999 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
4001 /* If old row extends to the end of the text area, clear. */
4002 if (i
>= desired_row
->used
[TEXT_AREA
])
4003 rif
->cursor_to (vpos
, i
, desired_row
->y
,
4004 desired_row
->pixel_width
);
4005 rif
->clear_end_of_line (-1);
4008 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
4010 /* Otherwise clear to the end of the old row. Everything
4011 after that position should be clear already. */
4014 if (i
>= desired_row
->used
[TEXT_AREA
])
4015 rif
->cursor_to (vpos
, i
, desired_row
->y
,
4016 desired_row
->pixel_width
);
4018 /* If cursor is displayed at the end of the line, make sure
4019 it's cleared. Nowadays we don't have a phys_cursor_glyph
4020 with which to erase the cursor (because this method
4021 doesn't work with lbearing/rbearing), so we must do it
4023 if (vpos
== w
->phys_cursor
.vpos
4024 && (desired_row
->reversed_p
4025 ? (w
->phys_cursor
.hpos
< 0)
4026 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
4028 w
->phys_cursor_on_p
= 0;
4032 xlim
= current_row
->pixel_width
;
4033 rif
->clear_end_of_line (xlim
);
4042 /* Update row VPOS in window W. Value is non-zero if display has been
4046 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
4048 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
4049 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
4050 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4053 /* Set the row being updated. This is important to let xterm.c
4054 know what line height values are in effect. */
4055 updated_row
= desired_row
;
4057 /* A row can be completely invisible in case a desired matrix was
4058 built with a vscroll and then make_cursor_line_fully_visible shifts
4059 the matrix. Make sure to make such rows current anyway, since
4060 we need the correct y-position, for example, in the current matrix. */
4061 if (desired_row
->mode_line_p
4062 || desired_row
->visible_height
> 0)
4064 xassert (desired_row
->enabled_p
);
4066 /* Update display of the left margin area, if there is one. */
4067 if (!desired_row
->full_width_p
4068 && !NILP (w
->left_margin_cols
))
4071 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
4074 /* Update the display of the text area. */
4075 if (update_text_area (w
, vpos
))
4078 if (current_row
->mouse_face_p
)
4079 *mouse_face_overwritten_p
= 1;
4082 /* Update display of the right margin area, if there is one. */
4083 if (!desired_row
->full_width_p
4084 && !NILP (w
->right_margin_cols
))
4087 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
4090 /* Draw truncation marks etc. */
4091 if (!current_row
->enabled_p
4092 || desired_row
->y
!= current_row
->y
4093 || desired_row
->visible_height
!= current_row
->visible_height
4094 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
4095 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
4096 || current_row
->redraw_fringe_bitmaps_p
4097 || desired_row
->mode_line_p
!= current_row
->mode_line_p
4098 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
4099 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4100 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4101 rif
->after_update_window_line_hook (desired_row
);
4104 /* Update current_row from desired_row. */
4105 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4111 /* Set the cursor after an update of window W. This function may only
4112 be called from update_window. */
4115 set_window_cursor_after_update (struct window
*w
)
4117 struct frame
*f
= XFRAME (w
->frame
);
4118 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4119 int cx
, cy
, vpos
, hpos
;
4121 /* Not intended for frame matrix updates. */
4122 xassert (FRAME_WINDOW_P (f
));
4124 if (cursor_in_echo_area
4125 && !NILP (echo_area_buffer
[0])
4126 /* If we are showing a message instead of the mini-buffer,
4127 show the cursor for the message instead. */
4128 && XWINDOW (minibuf_window
) == w
4129 && EQ (minibuf_window
, echo_area_window
)
4130 /* These cases apply only to the frame that contains
4131 the active mini-buffer window. */
4132 && FRAME_HAS_MINIBUF_P (f
)
4133 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4135 cx
= cy
= vpos
= hpos
= 0;
4137 if (cursor_in_echo_area
>= 0)
4139 /* If the mini-buffer is several lines high, find the last
4140 line that has any text on it. Note: either all lines
4141 are enabled or none. Otherwise we wouldn't be able to
4143 struct glyph_row
*row
, *last_row
;
4144 struct glyph
*glyph
;
4145 int yb
= window_text_bottom_y (w
);
4148 row
= w
->current_matrix
->rows
;
4149 while (row
->enabled_p
4150 && (last_row
== NULL
4151 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4153 if (row
->used
[TEXT_AREA
]
4154 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4161 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4162 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4164 while (last
> start
&& last
->charpos
< 0)
4167 for (glyph
= start
; glyph
< last
; ++glyph
)
4169 cx
+= glyph
->pixel_width
;
4174 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4182 hpos
= w
->cursor
.hpos
;
4183 vpos
= w
->cursor
.vpos
;
4186 /* Window cursor can be out of sync for horizontally split windows. */
4187 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4188 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4189 vpos
= max (0, vpos
);
4190 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4191 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4195 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4196 tree rooted at W. */
4199 set_window_update_flags (struct window
*w
, int on_p
)
4203 if (!NILP (w
->hchild
))
4204 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4205 else if (!NILP (w
->vchild
))
4206 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4208 w
->must_be_updated_p
= on_p
;
4210 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4216 /***********************************************************************
4217 Window-Based Scrolling
4218 ***********************************************************************/
4220 /* Structure describing rows in scrolling_window. */
4224 /* Number of occurrences of this row in desired and current matrix. */
4225 int old_uses
, new_uses
;
4227 /* Vpos of row in new matrix. */
4228 int new_line_number
;
4230 /* Bucket index of this row_entry in the hash table row_table. */
4233 /* The row described by this entry. */
4234 struct glyph_row
*row
;
4236 /* Hash collision chain. */
4237 struct row_entry
*next
;
4240 /* A pool to allocate row_entry structures from, and the size of the
4241 pool. The pool is reallocated in scrolling_window when we find
4242 that we need a larger one. */
4244 static struct row_entry
*row_entry_pool
;
4245 static ptrdiff_t row_entry_pool_size
;
4247 /* Index of next free entry in row_entry_pool. */
4249 static ptrdiff_t row_entry_idx
;
4251 /* The hash table used during scrolling, and the table's size. This
4252 table is used to quickly identify equal rows in the desired and
4255 static struct row_entry
**row_table
;
4256 static ptrdiff_t row_table_size
;
4258 /* Vectors of pointers to row_entry structures belonging to the
4259 current and desired matrix, and the size of the vectors. */
4261 static struct row_entry
**old_lines
, **new_lines
;
4262 static ptrdiff_t old_lines_size
, new_lines_size
;
4264 /* A pool to allocate run structures from, and its size. */
4266 static struct run
*run_pool
;
4267 static ptrdiff_t runs_size
;
4269 /* A vector of runs of lines found during scrolling. */
4271 static struct run
**runs
;
4273 /* Add glyph row ROW to the scrolling hash table. */
4275 static inline struct row_entry
*
4276 add_row_entry (struct glyph_row
*row
)
4278 struct row_entry
*entry
;
4279 ptrdiff_t i
= row
->hash
% row_table_size
;
4281 entry
= row_table
[i
];
4282 xassert (entry
|| verify_row_hash (row
));
4283 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4284 entry
= entry
->next
;
4288 entry
= row_entry_pool
+ row_entry_idx
++;
4290 entry
->old_uses
= entry
->new_uses
= 0;
4291 entry
->new_line_number
= 0;
4293 entry
->next
= row_table
[i
];
4294 row_table
[i
] = entry
;
4301 /* Try to reuse part of the current display of W by scrolling lines.
4302 HEADER_LINE_P non-zero means W has a header line.
4304 The algorithm is taken from Communications of the ACM, Apr78 "A
4305 Technique for Isolating Differences Between Files." It should take
4308 A short outline of the steps of the algorithm
4310 1. Skip lines equal at the start and end of both matrices.
4312 2. Enter rows in the current and desired matrix into a symbol
4313 table, counting how often they appear in both matrices.
4315 3. Rows that appear exactly once in both matrices serve as anchors,
4316 i.e. we assume that such lines are likely to have been moved.
4318 4. Starting from anchor lines, extend regions to be scrolled both
4319 forward and backward.
4323 -1 if all rows were found to be equal.
4324 0 to indicate that we did not scroll the display, or
4325 1 if we did scroll. */
4328 scrolling_window (struct window
*w
, int header_line_p
)
4330 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4331 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4332 int yb
= window_text_bottom_y (w
);
4334 int j
, first_old
, first_new
, last_old
, last_new
;
4337 struct row_entry
*entry
;
4338 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4340 /* Skip over rows equal at the start. */
4341 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4343 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4344 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4348 && !d
->redraw_fringe_bitmaps_p
4350 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4351 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4352 && row_equal_p (c
, d
, 1))
4361 /* Give up if some rows in the desired matrix are not enabled. */
4362 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4365 first_old
= first_new
= i
;
4367 /* Set last_new to the index + 1 of the row that reaches the
4368 bottom boundary in the desired matrix. Give up if we find a
4369 disabled row before we reach the bottom boundary. */
4371 while (i
< desired_matrix
->nrows
- 1)
4375 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4377 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4386 /* Set last_old to the index + 1 of the row that reaches the bottom
4387 boundary in the current matrix. We don't look at the enabled
4388 flag here because we plan to reuse part of the display even if
4389 other parts are disabled. */
4391 while (i
< current_matrix
->nrows
- 1)
4393 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4402 /* Skip over rows equal at the bottom. */
4405 while (i
- 1 > first_new
4406 && j
- 1 > first_old
4407 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4408 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4409 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4410 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4411 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4412 MATRIX_ROW (current_matrix
, j
- 1), 1))
4417 /* Nothing to do if all rows are equal. */
4418 if (last_new
== first_new
)
4421 /* Check for integer overflow in size calculation.
4423 If next_almost_prime checks (N) for divisibility by 2..10, then
4424 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4425 So, set next_almost_prime_increment_max to 10.
4427 It's just a coincidence that next_almost_prime_increment_max ==
4428 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4429 13, then next_almost_prime_increment_max would be 14, e.g.,
4430 because next_almost_prime (113) would be 127. */
4432 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4433 enum { next_almost_prime_increment_max
= 10 };
4434 ptrdiff_t row_table_max
=
4435 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4436 - next_almost_prime_increment_max
);
4437 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4438 if (current_nrows_max
< current_matrix
->nrows
)
4439 memory_full (SIZE_MAX
);
4442 /* Reallocate vectors, tables etc. if necessary. */
4444 if (current_matrix
->nrows
> old_lines_size
)
4445 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4446 current_matrix
->nrows
- old_lines_size
,
4447 INT_MAX
, sizeof *old_lines
);
4449 if (desired_matrix
->nrows
> new_lines_size
)
4450 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4451 desired_matrix
->nrows
- new_lines_size
,
4452 INT_MAX
, sizeof *new_lines
);
4454 n
= desired_matrix
->nrows
;
4455 n
+= current_matrix
->nrows
;
4456 if (row_table_size
< 3 * n
)
4458 ptrdiff_t size
= next_almost_prime (3 * n
);
4459 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4460 row_table_size
= size
;
4461 memset (row_table
, 0, size
* sizeof *row_table
);
4464 if (n
> row_entry_pool_size
)
4465 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4466 n
- row_entry_pool_size
,
4467 -1, sizeof *row_entry_pool
);
4469 if (desired_matrix
->nrows
> runs_size
)
4471 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4472 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4473 runs_size
= desired_matrix
->nrows
;
4476 nruns
= run_idx
= 0;
4479 /* Add rows from the current and desired matrix to the hash table
4480 row_hash_table to be able to find equal ones quickly. */
4482 for (i
= first_old
; i
< last_old
; ++i
)
4484 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4486 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4487 old_lines
[i
] = entry
;
4491 old_lines
[i
] = NULL
;
4494 for (i
= first_new
; i
< last_new
; ++i
)
4496 xassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4497 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4499 entry
->new_line_number
= i
;
4500 new_lines
[i
] = entry
;
4503 /* Identify moves based on lines that are unique and equal
4504 in both matrices. */
4505 for (i
= first_old
; i
< last_old
;)
4507 && old_lines
[i
]->old_uses
== 1
4508 && old_lines
[i
]->new_uses
== 1)
4511 int new_line
= old_lines
[i
]->new_line_number
;
4512 struct run
*run
= run_pool
+ run_idx
++;
4515 run
->current_vpos
= i
;
4516 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4517 run
->desired_vpos
= new_line
;
4518 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4520 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4522 /* Extend backward. */
4525 while (p
> first_old
4527 && old_lines
[p
] == new_lines
[q
])
4529 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4530 --run
->current_vpos
;
4531 --run
->desired_vpos
;
4534 run
->desired_y
-= h
;
4535 run
->current_y
-= h
;
4539 /* Extend forward. */
4544 && old_lines
[p
] == new_lines
[q
])
4546 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4552 /* Insert run into list of all runs. Order runs by copied
4553 pixel lines. Note that we record runs that don't have to
4554 be copied because they are already in place. This is done
4555 because we can avoid calling update_window_line in this
4557 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4559 for (q
= nruns
; q
> p
; --q
)
4560 runs
[q
] = runs
[q
- 1];
4569 /* Do the moves. Do it in a way that we don't overwrite something
4570 we want to copy later on. This is not solvable in general
4571 because there is only one display and we don't have a way to
4572 exchange areas on this display. Example:
4574 +-----------+ +-----------+
4576 +-----------+ --> +-----------+
4578 +-----------+ +-----------+
4580 Instead, prefer bigger moves, and invalidate moves that would
4581 copy from where we copied to. */
4583 for (i
= 0; i
< nruns
; ++i
)
4584 if (runs
[i
]->nrows
> 0)
4586 struct run
*r
= runs
[i
];
4588 /* Copy on the display. */
4589 if (r
->current_y
!= r
->desired_y
)
4591 rif
->clear_window_mouse_face (w
);
4592 rif
->scroll_run_hook (w
, r
);
4595 /* Truncate runs that copy to where we copied to, and
4596 invalidate runs that copy from where we copied to. */
4597 for (j
= nruns
- 1; j
> i
; --j
)
4599 struct run
*p
= runs
[j
];
4600 int truncated_p
= 0;
4603 && p
->desired_y
< r
->desired_y
+ r
->height
4604 && p
->desired_y
+ p
->height
> r
->desired_y
)
4606 if (p
->desired_y
< r
->desired_y
)
4608 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4609 p
->height
= r
->desired_y
- p
->desired_y
;
4614 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4617 if (p
->nrows
<= nrows_copied
)
4621 int height_copied
= (r
->desired_y
+ r
->height
4624 p
->current_vpos
+= nrows_copied
;
4625 p
->desired_vpos
+= nrows_copied
;
4626 p
->nrows
-= nrows_copied
;
4627 p
->current_y
+= height_copied
;
4628 p
->desired_y
+= height_copied
;
4629 p
->height
-= height_copied
;
4635 if (r
->current_y
!= r
->desired_y
4636 /* The condition below is equivalent to
4637 ((p->current_y >= r->desired_y
4638 && p->current_y < r->desired_y + r->height)
4639 || (p->current_y + p->height > r->desired_y
4640 && (p->current_y + p->height
4641 <= r->desired_y + r->height)))
4642 because we have 0 < p->height <= r->height. */
4643 && p
->current_y
< r
->desired_y
+ r
->height
4644 && p
->current_y
+ p
->height
> r
->desired_y
)
4647 /* Reorder runs by copied pixel lines if truncated. */
4648 if (truncated_p
&& p
->nrows
> 0)
4652 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4654 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4659 /* Assign matrix rows. */
4660 for (j
= 0; j
< r
->nrows
; ++j
)
4662 struct glyph_row
*from
, *to
;
4663 int to_overlapped_p
;
4665 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4666 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4667 to_overlapped_p
= to
->overlapped_p
;
4668 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4669 assign_row (to
, from
);
4670 /* The above `assign_row' actually does swap, so if we had
4671 an overlap in the copy destination of two runs, then
4672 the second run would assign a previously disabled bogus
4673 row. But thanks to the truncation code in the
4674 preceding for-loop, we no longer have such an overlap,
4675 and thus the assigned row should always be enabled. */
4676 xassert (to
->enabled_p
);
4677 from
->enabled_p
= 0;
4678 to
->overlapped_p
= to_overlapped_p
;
4682 /* Clear the hash table, for the next time. */
4683 for (i
= 0; i
< row_entry_idx
; ++i
)
4684 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4686 /* Value is 1 to indicate that we scrolled the display. */
4692 /************************************************************************
4694 ************************************************************************/
4696 /* Update the desired frame matrix of frame F.
4698 FORCE_P non-zero means that the update should not be stopped by
4699 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4700 should not be tried.
4702 Value is non-zero if update was stopped due to pending input. */
4705 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4707 /* Frame matrices to work on. */
4708 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4709 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4712 int preempt_count
= baud_rate
/ 2400 + 1;
4714 xassert (current_matrix
&& desired_matrix
);
4716 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4717 calculate_costs (f
);
4719 if (preempt_count
<= 0)
4722 #if !PERIODIC_PREEMPTION_CHECKING
4723 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4730 /* If we cannot insert/delete lines, it's no use trying it. */
4731 if (!FRAME_LINE_INS_DEL_OK (f
))
4734 /* See if any of the desired lines are enabled; don't compute for
4735 i/d line if just want cursor motion. */
4736 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4737 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4740 /* Try doing i/d line, if not yet inhibited. */
4741 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4742 force_p
|= scrolling (f
);
4744 /* Update the individual lines as needed. Do bottom line first. */
4745 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4746 update_frame_line (f
, desired_matrix
->nrows
- 1);
4748 /* Now update the rest of the lines. */
4749 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4751 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4753 if (FRAME_TERMCAP_P (f
))
4755 /* Flush out every so many lines.
4756 Also flush out if likely to have more than 1k buffered
4757 otherwise. I'm told that some telnet connections get
4758 really screwed by more than 1k output at once. */
4759 FILE *display_output
= FRAME_TTY (f
)->output
;
4762 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4764 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4766 fflush (display_output
);
4767 if (preempt_count
== 1)
4769 #ifdef EMACS_OUTQSIZE
4770 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4771 /* Probably not a tty. Ignore the error and reset
4773 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4776 if (baud_rate
<= outq
&& baud_rate
> 0)
4777 sleep (outq
/ baud_rate
);
4783 #if PERIODIC_PREEMPTION_CHECKING
4787 EMACS_GET_TIME (tm
);
4788 EMACS_SUB_TIME (dif
, preemption_next_check
, tm
);
4789 if (EMACS_TIME_NEG_P (dif
))
4791 EMACS_ADD_TIME (preemption_next_check
, tm
, preemption_period
);
4792 if (detect_input_pending_ignore_squeezables ())
4797 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4798 detect_input_pending_ignore_squeezables ();
4801 update_frame_line (f
, i
);
4805 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4807 /* Now just clean up termcap drivers and set cursor, etc. */
4810 if ((cursor_in_echo_area
4811 /* If we are showing a message instead of the mini-buffer,
4812 show the cursor for the message instead of for the
4813 (now hidden) mini-buffer contents. */
4814 || (EQ (minibuf_window
, selected_window
)
4815 && EQ (minibuf_window
, echo_area_window
)
4816 && !NILP (echo_area_buffer
[0])))
4817 /* These cases apply only to the frame that contains
4818 the active mini-buffer window. */
4819 && FRAME_HAS_MINIBUF_P (f
)
4820 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4822 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4825 if (cursor_in_echo_area
< 0)
4827 /* Negative value of cursor_in_echo_area means put
4828 cursor at beginning of line. */
4834 /* Positive value of cursor_in_echo_area means put
4835 cursor at the end of the prompt. If the mini-buffer
4836 is several lines high, find the last line that has
4838 row
= FRAME_LINES (f
);
4844 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4846 /* Frame rows are filled up with spaces that
4847 must be ignored here. */
4848 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4850 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4851 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4854 && (last
- 1)->charpos
< 0)
4860 while (row
> top
&& col
== 0);
4862 /* Make sure COL is not out of range. */
4863 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4865 /* If we have another row, advance cursor into it. */
4866 if (row
< FRAME_LINES (f
) - 1)
4868 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4871 /* Otherwise move it back in range. */
4873 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4877 cursor_to (f
, row
, col
);
4881 /* We have only one cursor on terminal frames. Use it to
4882 display the cursor of the selected window. */
4883 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4884 if (w
->cursor
.vpos
>= 0
4885 /* The cursor vpos may be temporarily out of bounds
4886 in the following situation: There is one window,
4887 with the cursor in the lower half of it. The window
4888 is split, and a message causes a redisplay before
4889 a new cursor position has been computed. */
4890 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4892 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4893 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4895 if (INTEGERP (w
->left_margin_cols
))
4896 x
+= XFASTINT (w
->left_margin_cols
);
4898 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4899 cursor_to (f
, y
, x
);
4904 #if !PERIODIC_PREEMPTION_CHECKING
4908 clear_desired_matrices (f
);
4913 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4916 scrolling (struct frame
*frame
)
4918 int unchanged_at_top
, unchanged_at_bottom
;
4921 int *old_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4922 int *new_hash
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4923 int *draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4924 int *old_draw_cost
= (int *) alloca (FRAME_LINES (frame
) * sizeof (int));
4926 int free_at_end_vpos
= FRAME_LINES (frame
);
4927 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4928 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4930 if (!current_matrix
)
4933 /* Compute hash codes of all the lines. Also calculate number of
4934 changed lines, number of unchanged lines at the beginning, and
4935 number of unchanged lines at the end. */
4937 unchanged_at_top
= 0;
4938 unchanged_at_bottom
= FRAME_LINES (frame
);
4939 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4941 /* Give up on this scrolling if some old lines are not enabled. */
4942 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4944 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4945 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4947 /* This line cannot be redrawn, so don't let scrolling mess it. */
4948 new_hash
[i
] = old_hash
[i
];
4949 #define INFINITY 1000000 /* Taken from scroll.c */
4950 draw_cost
[i
] = INFINITY
;
4954 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4955 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4958 if (old_hash
[i
] != new_hash
[i
])
4961 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4963 else if (i
== unchanged_at_top
)
4965 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4968 /* If changed lines are few, don't allow preemption, don't scroll. */
4969 if ((!FRAME_SCROLL_REGION_OK (frame
)
4970 && changed_lines
< baud_rate
/ 2400)
4971 || unchanged_at_bottom
== FRAME_LINES (frame
))
4974 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4975 - unchanged_at_bottom
);
4977 if (FRAME_SCROLL_REGION_OK (frame
))
4978 free_at_end_vpos
-= unchanged_at_bottom
;
4979 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4980 free_at_end_vpos
= -1;
4982 /* If large window, fast terminal and few lines in common between
4983 current frame and desired frame, don't bother with i/d calc. */
4984 if (!FRAME_SCROLL_REGION_OK (frame
)
4985 && window_size
>= 18 && baud_rate
> 2400
4987 10 * scrolling_max_lines_saved (unchanged_at_top
,
4988 FRAME_LINES (frame
) - unchanged_at_bottom
,
4989 old_hash
, new_hash
, draw_cost
)))
4992 if (window_size
< 2)
4995 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4996 draw_cost
+ unchanged_at_top
- 1,
4997 old_draw_cost
+ unchanged_at_top
- 1,
4998 old_hash
+ unchanged_at_top
- 1,
4999 new_hash
+ unchanged_at_top
- 1,
5000 free_at_end_vpos
- unchanged_at_top
);
5006 /* Count the number of blanks at the start of the vector of glyphs R
5007 which is LEN glyphs long. */
5010 count_blanks (struct glyph
*r
, int len
)
5014 for (i
= 0; i
< len
; ++i
)
5015 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
5022 /* Count the number of glyphs in common at the start of the glyph
5023 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
5024 of STR2. Value is the number of equal glyphs equal at the start. */
5027 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
5029 struct glyph
*p1
= str1
;
5030 struct glyph
*p2
= str2
;
5034 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
5041 /* Char insertion/deletion cost vector, from term.c */
5043 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
5046 /* Perform a frame-based update on line VPOS in frame FRAME. */
5049 update_frame_line (struct frame
*f
, int vpos
)
5051 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
5053 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
5054 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
5055 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
5056 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
5057 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
5058 int must_write_whole_line_p
;
5059 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
5060 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
5061 != FACE_TTY_DEFAULT_BG_COLOR
);
5063 if (colored_spaces_p
)
5066 /* Current row not enabled means it has unknown contents. We must
5067 write the whole desired line in that case. */
5068 must_write_whole_line_p
= !current_row
->enabled_p
;
5069 if (must_write_whole_line_p
)
5076 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
5077 olen
= current_row
->used
[TEXT_AREA
];
5079 /* Ignore trailing spaces, if we can. */
5080 if (!write_spaces_p
)
5081 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
5085 current_row
->enabled_p
= 1;
5086 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
5088 /* If desired line is empty, just clear the line. */
5089 if (!desired_row
->enabled_p
)
5095 nbody
= desired_row
->glyphs
[TEXT_AREA
];
5096 nlen
= desired_row
->used
[TEXT_AREA
];
5097 nend
= nbody
+ nlen
;
5099 /* If display line has unknown contents, write the whole line. */
5100 if (must_write_whole_line_p
)
5102 /* Ignore spaces at the end, if we can. */
5103 if (!write_spaces_p
)
5104 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5107 /* Write the contents of the desired line. */
5110 cursor_to (f
, vpos
, 0);
5111 write_glyphs (f
, nbody
, nlen
);
5114 /* Don't call clear_end_of_line if we already wrote the whole
5115 line. The cursor will not be at the right margin in that
5116 case but in the line below. */
5117 if (nlen
< FRAME_TOTAL_COLS (f
))
5119 cursor_to (f
, vpos
, nlen
);
5120 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5123 /* Make sure we are in the right row, otherwise cursor movement
5124 with cmgoto might use `ch' in the wrong row. */
5125 cursor_to (f
, vpos
, 0);
5127 make_current (desired_matrix
, current_matrix
, vpos
);
5131 /* Pretend trailing spaces are not there at all,
5132 unless for one reason or another we must write all spaces. */
5133 if (!write_spaces_p
)
5134 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5137 /* If there's no i/d char, quickly do the best we can without it. */
5138 if (!FRAME_CHAR_INS_DEL_OK (f
))
5142 /* Find the first glyph in desired row that doesn't agree with
5143 a glyph in the current row, and write the rest from there on. */
5144 for (i
= 0; i
< nlen
; i
++)
5146 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5148 /* Find the end of the run of different glyphs. */
5152 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5153 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5156 /* Output this run of non-matching chars. */
5157 cursor_to (f
, vpos
, i
);
5158 write_glyphs (f
, nbody
+ i
, j
- i
);
5161 /* Now find the next non-match. */
5165 /* Clear the rest of the line, or the non-clear part of it. */
5168 cursor_to (f
, vpos
, nlen
);
5169 clear_end_of_line (f
, olen
);
5172 /* Make current row = desired row. */
5173 make_current (desired_matrix
, current_matrix
, vpos
);
5177 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5178 characters in a row. */
5182 /* If current line is blank, skip over initial spaces, if
5183 possible, and write the rest. */
5187 nsp
= count_blanks (nbody
, nlen
);
5191 cursor_to (f
, vpos
, nsp
);
5192 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5195 /* Exchange contents between current_frame and new_frame. */
5196 make_current (desired_matrix
, current_matrix
, vpos
);
5200 /* Compute number of leading blanks in old and new contents. */
5201 osp
= count_blanks (obody
, olen
);
5202 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5204 /* Compute number of matching chars starting with first non-blank. */
5205 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5206 nbody
+ nsp
, nbody
+ nlen
);
5208 /* Spaces in new match implicit space past the end of old. */
5209 /* A bug causing this to be a no-op was fixed in 18.29. */
5210 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5213 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5217 /* Avoid doing insert/delete char
5218 just cause number of leading spaces differs
5219 when the following text does not match. */
5220 if (begmatch
== 0 && osp
!= nsp
)
5221 osp
= nsp
= min (osp
, nsp
);
5223 /* Find matching characters at end of line */
5226 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5228 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5233 endmatch
= obody
+ olen
- op1
;
5235 /* tem gets the distance to insert or delete.
5236 endmatch is how many characters we save by doing so.
5239 tem
= (nlen
- nsp
) - (olen
- osp
);
5241 && (!FRAME_CHAR_INS_DEL_OK (f
)
5242 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5245 /* nsp - osp is the distance to insert or delete.
5246 If that is nonzero, begmatch is known to be nonzero also.
5247 begmatch + endmatch is how much we save by doing the ins/del.
5251 && (!FRAME_CHAR_INS_DEL_OK (f
)
5252 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5256 osp
= nsp
= min (osp
, nsp
);
5259 /* Now go through the line, inserting, writing and
5260 deleting as appropriate. */
5264 cursor_to (f
, vpos
, nsp
);
5265 delete_glyphs (f
, osp
- nsp
);
5269 /* If going to delete chars later in line
5270 and insert earlier in the line,
5271 must delete first to avoid losing data in the insert */
5272 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5274 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5275 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5276 olen
= nlen
- (nsp
- osp
);
5278 cursor_to (f
, vpos
, osp
);
5279 insert_glyphs (f
, 0, nsp
- osp
);
5283 tem
= nsp
+ begmatch
+ endmatch
;
5284 if (nlen
!= tem
|| olen
!= tem
)
5286 if (!endmatch
|| nlen
== olen
)
5288 /* If new text being written reaches right margin, there is
5289 no need to do clear-to-eol at the end of this function
5290 (and it would not be safe, since cursor is not going to
5291 be "at the margin" after the text is done). */
5292 if (nlen
== FRAME_TOTAL_COLS (f
))
5295 /* Function write_glyphs is prepared to do nothing
5296 if passed a length <= 0. Check it here to avoid
5297 unnecessary cursor movement. */
5300 cursor_to (f
, vpos
, nsp
+ begmatch
);
5301 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5304 else if (nlen
> olen
)
5306 /* Here, we used to have the following simple code:
5307 ----------------------------------------
5308 write_glyphs (nbody + nsp + begmatch, olen - tem);
5309 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5310 ----------------------------------------
5311 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5312 is a padding glyph. */
5313 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5316 cursor_to (f
, vpos
, nsp
+ begmatch
);
5318 /* Calculate columns we can actually overwrite. */
5319 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5321 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5323 /* If we left columns to be overwritten, we must delete them. */
5324 del
= olen
- tem
- out
;
5326 delete_glyphs (f
, del
);
5328 /* At last, we insert columns not yet written out. */
5329 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5332 else if (olen
> nlen
)
5334 cursor_to (f
, vpos
, nsp
+ begmatch
);
5335 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5336 delete_glyphs (f
, olen
- nlen
);
5342 /* If any unerased characters remain after the new line, erase them. */
5345 cursor_to (f
, vpos
, nlen
);
5346 clear_end_of_line (f
, olen
);
5349 /* Exchange contents between current_frame and new_frame. */
5350 make_current (desired_matrix
, current_matrix
, vpos
);
5355 /***********************************************************************
5356 X/Y Position -> Buffer Position
5357 ***********************************************************************/
5359 /* Determine what's under window-relative pixel position (*X, *Y).
5360 Return the OBJECT (string or buffer) that's there.
5361 Return in *POS the position in that object.
5362 Adjust *X and *Y to character positions.
5363 Return in *DX and *DY the pixel coordinates of the click,
5364 relative to the top left corner of OBJECT, or relative to
5365 the top left corner of the character glyph at (*X, *Y)
5367 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5368 if the coordinates point to an empty area of the display. */
5371 buffer_posn_from_coords (struct window
*w
, int *x
, int *y
, struct display_pos
*pos
, Lisp_Object
*object
, int *dx
, int *dy
, int *width
, int *height
)
5374 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5375 struct text_pos startp
;
5377 struct glyph_row
*row
;
5378 #ifdef HAVE_WINDOW_SYSTEM
5379 struct image
*img
= 0;
5382 void *itdata
= NULL
;
5384 /* We used to set current_buffer directly here, but that does the
5385 wrong thing with `face-remapping-alist' (bug#2044). */
5386 Fset_buffer (w
->buffer
);
5387 itdata
= bidi_shelve_cache ();
5388 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5389 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5390 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5391 start_display (&it
, w
, startp
);
5392 /* start_display takes into account the header-line row, but IT's
5393 vpos still counts from the glyph row that includes the window's
5394 start position. Adjust for a possible header-line row. */
5395 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
5399 /* First, move to the beginning of the row corresponding to *Y. We
5400 need to be in that row to get the correct value of base paragraph
5401 direction for the text at (*X, *Y). */
5402 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5404 /* TO_X is the pixel position that the iterator will compute for the
5405 glyph at *X. We add it.first_visible_x because iterator
5406 positions include the hscroll. */
5407 to_x
= x0
+ it
.first_visible_x
;
5408 if (it
.bidi_it
.paragraph_dir
== R2L
)
5409 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5410 text area. This is because the iterator, even in R2L
5411 paragraphs, delivers glyphs as if they started at the left
5412 margin of the window. (When we actually produce glyphs for
5413 display, we reverse their order in PRODUCE_GLYPHS, but the
5414 iterator doesn't know about that.) The following line adjusts
5415 the pixel position to the iterator geometry, which is what
5416 move_it_* routines use. (The -1 is because in a window whose
5417 text-area width is W, the rightmost pixel position is W-1, and
5418 it should be mirrored into zero pixel position.) */
5419 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5421 /* Now move horizontally in the row to the glyph under *X. Second
5422 argument is ZV to prevent move_it_in_display_line from matching
5423 based on buffer positions. */
5424 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5425 bidi_unshelve_cache (itdata
, 0);
5427 Fset_buffer (old_current_buffer
);
5429 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5430 *dy
= *y
- it
.current_y
;
5433 if (STRINGP (it
.string
))
5436 if (it
.what
== IT_COMPOSITION
5437 && it
.cmp_it
.nchars
> 1
5438 && it
.cmp_it
.reversed_p
)
5440 /* The current display element is a grapheme cluster in a
5441 composition. In that case, we need the position of the first
5442 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5443 it.current points to the last character of the cluster, thus
5444 we must move back to the first character of the same
5446 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5447 if (STRINGP (it
.string
))
5448 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5450 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->buffer
),
5451 CHARPOS (pos
->pos
));
5454 #ifdef HAVE_WINDOW_SYSTEM
5455 if (it
.what
== IT_IMAGE
)
5457 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5458 && !NILP (img
->spec
))
5459 *object
= img
->spec
;
5463 if (it
.vpos
< w
->current_matrix
->nrows
5464 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5467 if (it
.hpos
< row
->used
[TEXT_AREA
])
5469 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5470 #ifdef HAVE_WINDOW_SYSTEM
5473 *dy
-= row
->ascent
- glyph
->ascent
;
5474 *dx
+= glyph
->slice
.img
.x
;
5475 *dy
+= glyph
->slice
.img
.y
;
5476 /* Image slices positions are still relative to the entire image */
5477 *width
= img
->width
;
5478 *height
= img
->height
;
5483 *width
= glyph
->pixel_width
;
5484 *height
= glyph
->ascent
+ glyph
->descent
;
5490 *height
= row
->height
;
5495 *width
= *height
= 0;
5498 /* Add extra (default width) columns if clicked after EOL. */
5499 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5501 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5510 /* Value is the string under window-relative coordinates X/Y in the
5511 mode line or header line (PART says which) of window W, or nil if none.
5512 *CHARPOS is set to the position in the string returned. */
5515 mode_line_string (struct window
*w
, enum window_part part
,
5516 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5517 int *dx
, int *dy
, int *width
, int *height
)
5519 struct glyph_row
*row
;
5520 struct glyph
*glyph
, *end
;
5522 Lisp_Object string
= Qnil
;
5524 if (part
== ON_MODE_LINE
)
5525 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5527 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5529 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5531 if (row
->mode_line_p
&& row
->enabled_p
)
5533 /* Find the glyph under X. If we find one with a string object,
5534 it's the one we were looking for. */
5535 glyph
= row
->glyphs
[TEXT_AREA
];
5536 end
= glyph
+ row
->used
[TEXT_AREA
];
5537 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5538 x0
-= glyph
->pixel_width
;
5539 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5542 string
= glyph
->object
;
5543 *charpos
= glyph
->charpos
;
5544 *width
= glyph
->pixel_width
;
5545 *height
= glyph
->ascent
+ glyph
->descent
;
5546 #ifdef HAVE_WINDOW_SYSTEM
5547 if (glyph
->type
== IMAGE_GLYPH
)
5550 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5552 *object
= img
->spec
;
5553 y0
-= row
->ascent
- glyph
->ascent
;
5559 /* Add extra (default width) columns if clicked after EOL. */
5560 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5562 *height
= row
->height
;
5569 *width
= *height
= 0;
5579 /* Value is the string under window-relative coordinates X/Y in either
5580 marginal area, or nil if none. *CHARPOS is set to the position in
5581 the string returned. */
5584 marginal_area_string (struct window
*w
, enum window_part part
,
5585 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5586 int *dx
, int *dy
, int *width
, int *height
)
5588 struct glyph_row
*row
= w
->current_matrix
->rows
;
5589 struct glyph
*glyph
, *end
;
5590 int x0
, y0
, i
, wy
= *y
;
5592 Lisp_Object string
= Qnil
;
5594 if (part
== ON_LEFT_MARGIN
)
5595 area
= LEFT_MARGIN_AREA
;
5596 else if (part
== ON_RIGHT_MARGIN
)
5597 area
= RIGHT_MARGIN_AREA
;
5601 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5602 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5605 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5609 /* Find the glyph under X. If we find one with a string object,
5610 it's the one we were looking for. */
5611 if (area
== RIGHT_MARGIN_AREA
)
5612 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5613 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5614 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5615 + window_box_width (w
, LEFT_MARGIN_AREA
)
5616 + window_box_width (w
, TEXT_AREA
));
5618 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5619 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5622 glyph
= row
->glyphs
[area
];
5623 end
= glyph
+ row
->used
[area
];
5624 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5625 x0
-= glyph
->pixel_width
;
5626 *x
= glyph
- row
->glyphs
[area
];
5629 string
= glyph
->object
;
5630 *charpos
= glyph
->charpos
;
5631 *width
= glyph
->pixel_width
;
5632 *height
= glyph
->ascent
+ glyph
->descent
;
5633 #ifdef HAVE_WINDOW_SYSTEM
5634 if (glyph
->type
== IMAGE_GLYPH
)
5637 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5639 *object
= img
->spec
;
5640 y0
-= row
->ascent
- glyph
->ascent
;
5641 x0
+= glyph
->slice
.img
.x
;
5642 y0
+= glyph
->slice
.img
.y
;
5648 /* Add extra (default width) columns if clicked after EOL. */
5649 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5651 *height
= row
->height
;
5658 *width
= *height
= 0;
5668 /***********************************************************************
5669 Changing Frame Sizes
5670 ***********************************************************************/
5675 window_change_signal (int signalnum
) /* If we don't have an argument, */
5676 /* some compilers complain in signal calls. */
5679 int old_errno
= errno
;
5681 struct tty_display_info
*tty
;
5683 signal (SIGWINCH
, window_change_signal
);
5684 SIGNAL_THREAD_CHECK (signalnum
);
5686 /* The frame size change obviously applies to a single
5687 termcap-controlled terminal, but we can't decide which.
5688 Therefore, we resize the frames corresponding to each tty.
5690 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5692 if (! tty
->term_initted
)
5695 /* Suspended tty frames have tty->input == NULL avoid trying to
5700 get_tty_size (fileno (tty
->input
), &width
, &height
);
5702 if (width
> 5 && height
> 2) {
5703 Lisp_Object tail
, frame
;
5705 FOR_EACH_FRAME (tail
, frame
)
5706 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5707 /* Record the new sizes, but don't reallocate the data
5708 structures now. Let that be done later outside of the
5710 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5716 #endif /* SIGWINCH */
5719 /* Do any change in frame size that was requested by a signal. SAFE
5720 non-zero means this function is called from a place where it is
5721 safe to change frame sizes while a redisplay is in progress. */
5724 do_pending_window_change (int safe
)
5726 /* If window_change_signal should have run before, run it now. */
5727 if (redisplaying_p
&& !safe
)
5730 while (delayed_size_change
)
5732 Lisp_Object tail
, frame
;
5734 delayed_size_change
= 0;
5736 FOR_EACH_FRAME (tail
, frame
)
5738 struct frame
*f
= XFRAME (frame
);
5740 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5741 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5748 /* Change the frame height and/or width. Values may be given as zero to
5749 indicate no change is to take place.
5751 If DELAY is non-zero, then assume we're being called from a signal
5752 handler, and queue the change for later - perhaps the next
5753 redisplay. Since this tries to resize windows, we can't call it
5754 from a signal handler.
5756 SAFE non-zero means this function is called from a place where it's
5757 safe to change frame sizes while a redisplay is in progress. */
5760 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5762 Lisp_Object tail
, frame
;
5764 if (FRAME_MSDOS_P (f
))
5766 /* On MS-DOS, all frames use the same screen, so a change in
5767 size affects all frames. Termcap now supports multiple
5769 FOR_EACH_FRAME (tail
, frame
)
5770 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5771 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5772 pretend
, delay
, safe
);
5775 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5779 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5781 int new_frame_total_cols
;
5782 ptrdiff_t count
= SPECPDL_INDEX ();
5784 /* If we can't deal with the change now, queue it for later. */
5785 if (delay
|| (redisplaying_p
&& !safe
))
5787 f
->new_text_lines
= newheight
;
5788 f
->new_text_cols
= newwidth
;
5789 delayed_size_change
= 1;
5793 /* This size-change overrides any pending one for this frame. */
5794 f
->new_text_lines
= 0;
5795 f
->new_text_cols
= 0;
5797 /* If an argument is zero, set it to the current value. */
5799 newheight
= FRAME_LINES (f
);
5801 newwidth
= FRAME_COLS (f
);
5803 /* Compute width of windows in F. */
5804 /* Round up to the smallest acceptable size. */
5805 check_frame_size (f
, &newheight
, &newwidth
);
5807 /* This is the width of the frame with vertical scroll bars and fringe
5808 columns. Do this after rounding - see discussion of bug#9723. */
5809 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5811 /* If we're not changing the frame size, quit now. */
5812 /* Frame width may be unchanged but the text portion may change, for
5813 example, fullscreen and remove/add scroll bar. */
5814 if (newheight
== FRAME_LINES (f
)
5815 /* Text portion unchanged? */
5816 && newwidth
== FRAME_COLS (f
)
5817 /* Frame width unchanged? */
5818 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5824 /* We only can set screen dimensions to certain values supported
5825 by our video hardware. Try to find the smallest size greater
5826 or equal to the requested dimensions. */
5827 dos_set_window_size (&newheight
, &newwidth
);
5830 if (newheight
!= FRAME_LINES (f
))
5832 resize_frame_windows (f
, newheight
, 0);
5834 /* MSDOS frames cannot PRETEND, as they change frame size by
5835 manipulating video hardware. */
5836 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5837 FrameRows (FRAME_TTY (f
)) = newheight
;
5840 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5842 resize_frame_windows (f
, new_frame_total_cols
, 1);
5844 /* MSDOS frames cannot PRETEND, as they change frame size by
5845 manipulating video hardware. */
5846 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5847 FrameCols (FRAME_TTY (f
)) = newwidth
;
5849 if (WINDOWP (f
->tool_bar_window
))
5850 XSETFASTINT (XWINDOW (f
->tool_bar_window
)->total_cols
, newwidth
);
5853 FRAME_LINES (f
) = newheight
;
5854 SET_FRAME_COLS (f
, newwidth
);
5857 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5858 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5860 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5862 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5863 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5864 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5865 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5869 calculate_costs (f
);
5870 SET_FRAME_GARBAGED (f
);
5875 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5877 run_window_configuration_change_hook (f
);
5879 unbind_to (count
, Qnil
);
5884 /***********************************************************************
5885 Terminal Related Lisp Functions
5886 ***********************************************************************/
5888 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5889 1, 1, "FOpen termscript file: ",
5890 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5891 FILE = nil means just close any termscript file currently open. */)
5894 struct tty_display_info
*tty
;
5896 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5897 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5898 error ("Current frame is not on a tty device");
5902 if (tty
->termscript
!= 0)
5905 fclose (tty
->termscript
);
5908 tty
->termscript
= 0;
5912 file
= Fexpand_file_name (file
, Qnil
);
5913 tty
->termscript
= fopen (SSDATA (file
), "w");
5914 if (tty
->termscript
== 0)
5915 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5921 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5922 Ssend_string_to_terminal
, 1, 2, 0,
5923 doc
: /* Send STRING to the terminal without alteration.
5924 Control characters in STRING will have terminal-dependent effects.
5926 Optional parameter TERMINAL specifies the tty terminal device to use.
5927 It may be a terminal object, a frame, or nil for the terminal used by
5928 the currently selected frame. In batch mode, STRING is sent to stdout
5929 when TERMINAL is nil. */)
5930 (Lisp_Object string
, Lisp_Object terminal
)
5932 struct terminal
*t
= get_terminal (terminal
, 1);
5935 /* ??? Perhaps we should do something special for multibyte strings here. */
5936 CHECK_STRING (string
);
5940 error ("Unknown terminal device");
5942 if (t
->type
== output_initial
)
5944 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5945 error ("Device %d is not a termcap terminal device", t
->id
);
5948 struct tty_display_info
*tty
= t
->display_info
.tty
;
5951 error ("Terminal is currently suspended");
5953 if (tty
->termscript
)
5955 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5956 fflush (tty
->termscript
);
5960 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5967 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5968 doc
: /* Beep, or flash the screen.
5969 Also, unless an argument is given,
5970 terminate any keyboard macro currently executing. */)
5978 ring_bell (XFRAME (selected_frame
));
5987 bitch_at_user (void)
5991 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5992 error ("Keyboard macro terminated by a command ringing the bell");
5994 ring_bell (XFRAME (selected_frame
));
5999 /***********************************************************************
6001 ***********************************************************************/
6003 /* Convert a positive value DURATION to a seconds count *PSEC plus a
6004 microseconds count *PUSEC, rounding up. On overflow return the
6007 duration_to_sec_usec (double duration
, int *psec
, int *pusec
)
6009 int MILLION
= 1000000;
6010 int sec
= INT_MAX
, usec
= MILLION
- 1;
6012 if (duration
< INT_MAX
+ 1.0)
6015 double usdouble
= (duration
- s
) * MILLION
;
6016 int usfloor
= usdouble
;
6017 int usceil
= usfloor
+ (usfloor
< usdouble
);
6019 if (usceil
< MILLION
)
6024 else if (sec
< INT_MAX
)
6035 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
6036 doc
: /* Pause, without updating display, for SECONDS seconds.
6037 SECONDS may be a floating-point value, meaning that you can wait for a
6038 fraction of a second. Optional second arg MILLISECONDS specifies an
6039 additional wait period, in milliseconds; this may be useful if your
6040 Emacs was built without floating point support.
6041 \(Not all operating systems support waiting for a fraction of a second.) */)
6042 (Lisp_Object seconds
, Lisp_Object milliseconds
)
6045 double duration
= extract_float (seconds
);
6047 if (!NILP (milliseconds
))
6049 CHECK_NUMBER (milliseconds
);
6050 duration
+= XINT (milliseconds
) / 1000.0;
6053 if (! (0 < duration
))
6056 duration_to_sec_usec (duration
, &sec
, &usec
);
6058 #ifndef EMACS_HAS_USECS
6059 if (sec
== 0 && usec
!= 0)
6060 error ("Millisecond `sleep-for' not supported on %s", SYSTEM_TYPE
);
6063 wait_reading_process_output (sec
, usec
, 0, 0, Qnil
, NULL
, 0);
6069 /* This is just like wait_reading_process_output, except that
6072 TIMEOUT is number of seconds to wait (float or integer),
6073 or t to wait forever.
6074 READING is 1 if reading input.
6075 If DO_DISPLAY is >0 display process output while waiting.
6076 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
6080 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
6084 swallow_events (do_display
);
6086 if ((detect_input_pending_run_timers (do_display
))
6087 || !NILP (Vexecuting_kbd_macro
))
6090 if (do_display
>= 2)
6091 redisplay_preserve_echo_area (2);
6093 if (EQ (timeout
, Qt
))
6100 double duration
= extract_float (timeout
);
6102 if (! (0 < duration
))
6105 duration_to_sec_usec (duration
, &sec
, &usec
);
6112 wait_reading_process_output (sec
, usec
, reading
? -1 : 1, do_display
,
6115 return detect_input_pending () ? Qnil
: Qt
;
6119 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
6120 doc
: /* Perform redisplay.
6121 Optional arg FORCE, if non-nil, prevents redisplay from being
6122 preempted by arriving input, even if `redisplay-dont-pause' is nil.
6123 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
6124 preempted by arriving input, so FORCE does nothing.
6126 Return t if redisplay was performed, nil if redisplay was preempted
6127 immediately by pending input. */)
6133 if ((detect_input_pending_run_timers (1)
6134 && NILP (force
) && !redisplay_dont_pause
)
6135 || !NILP (Vexecuting_kbd_macro
))
6138 count
= SPECPDL_INDEX ();
6139 if (!NILP (force
) && !redisplay_dont_pause
)
6140 specbind (Qredisplay_dont_pause
, Qt
);
6141 redisplay_preserve_echo_area (2);
6142 unbind_to (count
, Qnil
);
6148 /***********************************************************************
6149 Other Lisp Functions
6150 ***********************************************************************/
6152 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6153 session's frames, frame names, buffers, buffer-read-only flags, and
6154 buffer-modified-flags. */
6156 static Lisp_Object frame_and_buffer_state
;
6159 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6160 Sframe_or_buffer_changed_p
, 0, 1, 0,
6161 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6162 VARIABLE is a variable name whose value is either nil or a state vector
6163 that will be updated to contain all frames and buffers,
6164 aside from buffers whose names start with space,
6165 along with the buffers' read-only and modified flags. This allows a fast
6166 check to see whether buffer menus might need to be recomputed.
6167 If this function returns non-nil, it updates the internal vector to reflect
6170 If VARIABLE is nil, an internal variable is used. Users should not
6171 pass nil for VARIABLE. */)
6172 (Lisp_Object variable
)
6174 Lisp_Object state
, tail
, frame
, buf
;
6175 Lisp_Object
*vecp
, *end
;
6178 if (! NILP (variable
))
6180 CHECK_SYMBOL (variable
);
6181 state
= Fsymbol_value (variable
);
6182 if (! VECTORP (state
))
6186 state
= frame_and_buffer_state
;
6188 vecp
= XVECTOR (state
)->contents
;
6189 end
= vecp
+ ASIZE (state
);
6191 FOR_EACH_FRAME (tail
, frame
)
6195 if (!EQ (*vecp
++, frame
))
6199 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6202 /* Check that the buffer info matches. */
6203 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6205 buf
= XCDR (XCAR (tail
));
6206 /* Ignore buffers that aren't included in buffer lists. */
6207 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6211 if (!EQ (*vecp
++, buf
))
6215 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6219 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6224 /* Detect deletion of a buffer at the end of the list. */
6225 if (EQ (*vecp
, Qlambda
))
6228 /* Come here if we decide the data has changed. */
6230 /* Count the size we will need.
6231 Start with 1 so there is room for at least one lambda at the end. */
6233 FOR_EACH_FRAME (tail
, frame
)
6235 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6237 /* Reallocate the vector if data has grown to need it,
6238 or if it has shrunk a lot. */
6239 if (! VECTORP (state
)
6240 || n
> ASIZE (state
)
6241 || n
+ 20 < ASIZE (state
) / 2)
6242 /* Add 20 extra so we grow it less often. */
6244 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6245 if (! NILP (variable
))
6246 Fset (variable
, state
);
6248 frame_and_buffer_state
= state
;
6251 /* Record the new data in the (possibly reallocated) vector. */
6252 vecp
= XVECTOR (state
)->contents
;
6253 FOR_EACH_FRAME (tail
, frame
)
6256 *vecp
++ = XFRAME (frame
)->name
;
6258 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6260 buf
= XCDR (XCAR (tail
));
6261 /* Ignore buffers that aren't included in buffer lists. */
6262 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6265 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6266 *vecp
++ = Fbuffer_modified_p (buf
);
6268 /* Fill up the vector with lambdas (always at least one). */
6270 while (vecp
- XVECTOR (state
)->contents
6273 /* Make sure we didn't overflow the vector. */
6274 if (vecp
- XVECTOR (state
)->contents
6282 /***********************************************************************
6284 ***********************************************************************/
6286 /* Initialization done when Emacs fork is started, before doing stty.
6287 Determine terminal type and set terminal_driver. Then invoke its
6288 decoding routine to set up variables in the terminal package. */
6293 char *terminal_type
;
6295 /* Construct the space glyph. */
6296 space_glyph
.type
= CHAR_GLYPH
;
6297 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6298 space_glyph
.charpos
= -1;
6301 cursor_in_echo_area
= 0;
6302 terminal_type
= (char *) 0;
6304 /* Now is the time to initialize this; it's used by init_sys_modes
6306 Vinitial_window_system
= Qnil
;
6308 /* SIGWINCH needs to be handled no matter what display we start
6309 with. Otherwise newly opened tty frames will not resize
6314 #endif /* CANNOT_DUMP */
6315 signal (SIGWINCH
, window_change_signal
);
6316 #endif /* SIGWINCH */
6318 /* If running as a daemon, no need to initialize any frames/terminal. */
6322 /* If the user wants to use a window system, we shouldn't bother
6323 initializing the terminal. This is especially important when the
6324 terminal is so dumb that emacs gives up before and doesn't bother
6325 using the window system.
6327 If the DISPLAY environment variable is set and nonempty,
6328 try to use X, and die with an error message if that doesn't work. */
6330 #ifdef HAVE_X_WINDOWS
6331 if (! inhibit_window_system
&& ! display_arg
)
6334 display
= getenv ("DISPLAY");
6335 display_arg
= (display
!= 0 && *display
!= 0);
6337 if (display_arg
&& !x_display_ok (display
))
6339 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6341 inhibit_window_system
= 1;
6345 if (!inhibit_window_system
&& display_arg
)
6347 Vinitial_window_system
= Qx
;
6349 Vwindow_system_version
= make_number (11);
6352 /* In some versions of ncurses,
6353 tputs crashes if we have not called tgetent.
6355 { char b
[2044]; tgetent (b
, "xterm");}
6357 adjust_frame_glyphs_initially ();
6360 #endif /* HAVE_X_WINDOWS */
6363 if (!inhibit_window_system
)
6365 Vinitial_window_system
= Qw32
;
6366 Vwindow_system_version
= make_number (1);
6367 adjust_frame_glyphs_initially ();
6370 #endif /* HAVE_NTGUI */
6373 if (!inhibit_window_system
6379 Vinitial_window_system
= Qns
;
6380 Vwindow_system_version
= make_number (10);
6381 adjust_frame_glyphs_initially ();
6386 /* If no window system has been specified, try to use the terminal. */
6389 fatal ("standard input is not a tty");
6394 terminal_type
= "w32console";
6396 /* Look at the TERM variable. */
6397 terminal_type
= (char *) getenv ("TERM");
6401 #ifdef HAVE_WINDOW_SYSTEM
6402 if (! inhibit_window_system
)
6403 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6405 #endif /* HAVE_WINDOW_SYSTEM */
6406 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6412 struct frame
*f
= XFRAME (selected_frame
);
6414 /* Open a display on the controlling tty. */
6415 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6417 /* Convert the initial frame to use the new display. */
6418 if (f
->output_method
!= output_initial
)
6420 f
->output_method
= t
->type
;
6423 t
->reference_count
++;
6425 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6427 if (f
->output_method
== output_termcap
)
6428 create_tty_output (f
);
6430 t
->display_info
.tty
->top_frame
= selected_frame
;
6431 change_frame_size (XFRAME (selected_frame
),
6432 FrameRows (t
->display_info
.tty
),
6433 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6435 /* Delete the initial terminal. */
6436 if (--initial_terminal
->reference_count
== 0
6437 && initial_terminal
->delete_terminal_hook
)
6438 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6440 /* Update frame parameters to reflect the new type. */
6441 Fmodify_frame_parameters
6442 (selected_frame
, Fcons (Fcons (Qtty_type
,
6443 Ftty_type (selected_frame
)), Qnil
));
6444 if (t
->display_info
.tty
->name
)
6445 Fmodify_frame_parameters (selected_frame
,
6446 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6449 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6454 struct frame
*sf
= SELECTED_FRAME ();
6455 int width
= FRAME_TOTAL_COLS (sf
);
6456 int height
= FRAME_LINES (sf
);
6458 /* If these sizes are so big they cause overflow, just ignore the
6459 change. It's not clear what better we could do. The rest of
6460 the code assumes that (width + 2) * height * sizeof (struct glyph)
6461 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6462 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6463 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6464 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6465 < (width
+ 2) * height
))
6466 fatal ("screen size %dx%d too big", width
, height
);
6469 adjust_frame_glyphs_initially ();
6470 calculate_costs (XFRAME (selected_frame
));
6472 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6475 && NILP (Vinitial_window_system
))
6477 /* For the initial frame, we don't have any way of knowing what
6478 are the foreground and background colors of the terminal. */
6479 struct frame
*sf
= SELECTED_FRAME ();
6481 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6482 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6483 call0 (intern ("tty-set-up-initial-frame-faces"));
6489 /***********************************************************************
6491 ***********************************************************************/
6493 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6494 Sinternal_show_cursor
, 2, 2, 0,
6495 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6496 WINDOW nil means use the selected window. SHOW non-nil means
6497 show a cursor in WINDOW in the next redisplay. SHOW nil means
6498 don't show a cursor. */)
6499 (Lisp_Object window
, Lisp_Object show
)
6501 /* Don't change cursor state while redisplaying. This could confuse
6503 if (!redisplaying_p
)
6506 window
= selected_window
;
6508 CHECK_WINDOW (window
);
6510 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6517 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6518 Sinternal_show_cursor_p
, 0, 1, 0,
6519 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6520 WINDOW nil or omitted means report on the selected window. */)
6521 (Lisp_Object window
)
6526 window
= selected_window
;
6528 CHECK_WINDOW (window
);
6530 w
= XWINDOW (window
);
6531 return w
->cursor_off_p
? Qnil
: Qt
;
6534 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6535 Slast_nonminibuf_frame
, 0, 0, 0,
6536 doc
: /* Value is last nonminibuffer frame. */)
6539 Lisp_Object frame
= Qnil
;
6541 if (last_nonminibuf_frame
)
6542 XSETFRAME (frame
, last_nonminibuf_frame
);
6547 /***********************************************************************
6549 ***********************************************************************/
6552 syms_of_display (void)
6554 defsubr (&Sredraw_frame
);
6555 defsubr (&Sredraw_display
);
6556 defsubr (&Sframe_or_buffer_changed_p
);
6557 defsubr (&Sopen_termscript
);
6559 defsubr (&Sredisplay
);
6560 defsubr (&Ssleep_for
);
6561 defsubr (&Ssend_string_to_terminal
);
6562 defsubr (&Sinternal_show_cursor
);
6563 defsubr (&Sinternal_show_cursor_p
);
6564 defsubr (&Slast_nonminibuf_frame
);
6567 defsubr (&Sdump_redisplay_history
);
6570 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6571 staticpro (&frame_and_buffer_state
);
6573 DEFSYM (Qdisplay_table
, "display-table");
6574 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6576 DEFVAR_INT ("baud-rate", baud_rate
,
6577 doc
: /* The output baud rate of the terminal.
6578 On most systems, changing this value will affect the amount of padding
6579 and the other strategic decisions made during redisplay. */);
6581 DEFVAR_BOOL ("inverse-video", inverse_video
,
6582 doc
: /* Non-nil means invert the entire frame display.
6583 This means everything is in inverse video which otherwise would not be. */);
6585 DEFVAR_BOOL ("visible-bell", visible_bell
,
6586 doc
: /* Non-nil means try to flash the frame to represent a bell.
6588 See also `ring-bell-function'. */);
6590 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6591 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6592 A non-nil value is useful if the terminal can automatically preserve
6593 Emacs's frame display when you reenter Emacs.
6594 It is up to you to set this variable if your terminal can do that. */);
6596 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6597 doc
: /* Name of the window system that Emacs uses for the first frame.
6598 The value is a symbol:
6599 nil for a termcap frame (a character-only terminal),
6600 'x' for an Emacs frame that is really an X window,
6601 'w32' for an Emacs frame that is a window on MS-Windows display,
6602 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6603 'pc' for a direct-write MS-DOS frame.
6605 Use of this variable as a boolean is deprecated. Instead,
6606 use `display-graphic-p' or any of the other `display-*-p'
6607 predicates which report frame's specific UI-related capabilities. */);
6609 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6610 doc
: /* Name of window system through which the selected frame is displayed.
6611 The value is a symbol:
6612 nil for a termcap frame (a character-only terminal),
6613 'x' for an Emacs frame that is really an X window,
6614 'w32' for an Emacs frame that is a window on MS-Windows display,
6615 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6616 'pc' for a direct-write MS-DOS frame.
6618 Use of this variable as a boolean is deprecated. Instead,
6619 use `display-graphic-p' or any of the other `display-*-p'
6620 predicates which report frame's specific UI-related capabilities. */);
6622 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6623 doc
: /* The version number of the window system in use.
6624 For X windows, this is 11. */);
6626 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6627 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6629 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6630 doc
: /* Table defining how to output a glyph code to the frame.
6631 If not nil, this is a vector indexed by glyph code to define the glyph.
6632 Each element can be:
6633 integer: a glyph code which this glyph is an alias for.
6634 string: output this glyph using that string (not impl. in X windows).
6635 nil: this glyph mod 524288 is the code of a character to output,
6636 and this glyph / 524288 is the face number (see `face-id') to use
6637 while outputting it. */);
6638 Vglyph_table
= Qnil
;
6640 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6641 doc
: /* Display table to use for buffers that specify none.
6642 See `buffer-display-table' for more information. */);
6643 Vstandard_display_table
= Qnil
;
6645 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6646 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6647 redisplay_dont_pause
= 1;
6649 #if PERIODIC_PREEMPTION_CHECKING
6650 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6651 doc
: /* Period in seconds between checking for input during redisplay.
6652 This has an effect only if `redisplay-dont-pause' is nil; in that
6653 case, arriving input preempts redisplay until the input is processed.
6654 If the value is nil, redisplay is never preempted. */);
6655 Vredisplay_preemption_period
= make_float (0.10);
6662 Vinitial_window_system
= Qnil
;
6663 Vwindow_system_version
= Qnil
;