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/>. */
22 #define DISPEXTERN_INLINE EXTERN_INLINE
32 /* cm.h must come after dispextern.h on Windows. */
33 #include "dispextern.h"
35 #include "character.h"
39 #include "termhooks.h"
44 #include "intervals.h"
45 #include "blockinput.h"
48 #include "syssignal.h"
52 #endif /* HAVE_X_WINDOWS */
56 #endif /* HAVE_NTGUI */
62 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
67 #ifdef DISPNEW_NEEDS_STDIO_EXT
68 #include <stdio_ext.h>
71 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
72 #include <term.h> /* for tgetent */
75 /* Structure to pass dimensions around. Used for character bounding
76 boxes, glyph matrix dimensions and alike. */
85 /* Function prototypes. */
87 static void update_frame_line (struct frame
*, int);
88 static int required_matrix_height (struct window
*);
89 static int required_matrix_width (struct window
*);
90 static void adjust_frame_glyphs (struct frame
*);
91 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
92 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
93 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
94 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
96 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
98 static void adjust_frame_message_buffer (struct frame
*);
99 static void adjust_decode_mode_spec_buffer (struct frame
*);
100 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
101 static void clear_window_matrices (struct window
*, int);
102 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
103 static int scrolling_window (struct window
*, int);
104 static int update_window_line (struct window
*, int, int *);
105 static void mirror_make_current (struct window
*, int);
107 static void check_matrix_pointers (struct glyph_matrix
*,
108 struct glyph_matrix
*);
110 static void mirror_line_dance (struct window
*, int, int, int *, char *);
111 static int update_window_tree (struct window
*, int);
112 static int update_window (struct window
*, int);
113 static int update_frame_1 (struct frame
*, int, int);
114 static int scrolling (struct frame
*);
115 static void set_window_cursor_after_update (struct window
*);
116 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
117 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
120 /* Redisplay preemption timers. */
122 static EMACS_TIME preemption_period
;
123 static EMACS_TIME preemption_next_check
;
125 /* Nonzero upon entry to redisplay means do not assume anything about
126 current contents of actual terminal frame; clear and redraw it. */
130 /* Nonzero means last display completed. Zero means it was preempted. */
132 int display_completed
;
134 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
137 /* The currently selected frame. In a single-frame version, this
138 variable always equals the_only_frame. */
140 Lisp_Object selected_frame
;
142 /* A frame which is not just a mini-buffer, or 0 if there are no such
143 frames. This is usually the most recent such frame that was
144 selected. In a single-frame version, this variable always holds
145 the address of the_only_frame. */
147 struct frame
*last_nonminibuf_frame
;
149 /* 1 means SIGWINCH happened when not safe. */
151 static int delayed_size_change
;
153 /* 1 means glyph initialization has been completed at startup. */
155 static int glyphs_initialized_initially_p
;
157 /* Updated window if != 0. Set by update_window. */
159 struct window
*updated_window
;
161 /* Glyph row updated in update_window_line, and area that is updated. */
163 struct glyph_row
*updated_row
;
166 /* A glyph for a space. */
168 struct glyph space_glyph
;
170 /* Counts of allocated structures. These counts serve to diagnose
171 memory leaks and double frees. */
173 static int glyph_matrix_count
;
174 static int glyph_pool_count
;
176 /* If non-null, the frame whose frame matrices are manipulated. If
177 null, window matrices are worked on. */
179 static struct frame
*frame_matrix_frame
;
181 /* Non-zero means that fonts have been loaded since the last glyph
182 matrix adjustments. Redisplay must stop, and glyph matrices must
183 be adjusted when this flag becomes non-zero during display. The
184 reason fonts can be loaded so late is that fonts of fontsets are
185 loaded on demand. Another reason is that a line contains many
186 characters displayed by zero width or very narrow glyphs of
187 variable-width fonts. */
191 /* Convert vpos and hpos from frame to window and vice versa.
192 This may only be used for terminal frames. */
196 static int window_to_frame_vpos (struct window
*, int);
197 static int window_to_frame_hpos (struct window
*, int);
198 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
199 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
201 /* One element of the ring buffer containing redisplay history
204 struct redisplay_history
206 char trace
[512 + 100];
209 /* The size of the history buffer. */
211 #define REDISPLAY_HISTORY_SIZE 30
213 /* The redisplay history buffer. */
215 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
217 /* Next free entry in redisplay_history. */
219 static int history_idx
;
221 /* A tick that's incremented each time something is added to the
224 static uprintmax_t history_tick
;
226 static void add_frame_display_history (struct frame
*, int);
228 /* Add to the redisplay history how window W has been displayed.
229 MSG is a trace containing the information how W's glyph matrix
230 has been constructed. PAUSED_P non-zero means that the update
231 has been interrupted for pending input. */
234 add_window_display_history (struct window
*w
, const char *msg
, int paused_p
)
238 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
240 buf
= redisplay_history
[history_idx
].trace
;
243 snprintf (buf
, sizeof redisplay_history
[0].trace
,
244 "%"pMu
": window %p (`%s')%s\n%s",
247 ((BUFFERP (w
->buffer
)
248 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
249 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
251 paused_p
? " ***paused***" : "",
256 /* Add to the redisplay history that frame F has been displayed.
257 PAUSED_P non-zero means that the update has been interrupted for
261 add_frame_display_history (struct frame
*f
, int paused_p
)
265 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
267 buf
= redisplay_history
[history_idx
].trace
;
270 sprintf (buf
, "%"pMu
": update frame %p%s",
272 f
, paused_p
? " ***paused***" : "");
276 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
277 Sdump_redisplay_history
, 0, 0, "",
278 doc
: /* Dump redisplay history to stderr. */)
283 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
286 i
= REDISPLAY_HISTORY_SIZE
- 1;
287 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
294 #else /* not GLYPH_DEBUG */
296 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
297 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
299 #endif /* GLYPH_DEBUG */
302 #if (defined PROFILING \
303 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
304 && !HAVE___EXECUTABLE_START)
305 /* This function comes first in the Emacs executable and is used only
306 to estimate the text start for profiling. */
308 __executable_start (void)
314 /***********************************************************************
316 ***********************************************************************/
318 /* Allocate and return a glyph_matrix structure. POOL is the glyph
319 pool from which memory for the matrix should be allocated, or null
320 for window-based redisplay where no glyph pools are used. The
321 member `pool' of the glyph matrix structure returned is set to
322 POOL, the structure is otherwise zeroed. */
324 static struct glyph_matrix
*
325 new_glyph_matrix (struct glyph_pool
*pool
)
327 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
329 /* Increment number of allocated matrices. This count is used
330 to detect memory leaks. */
331 ++glyph_matrix_count
;
333 /* Set pool and return. */
339 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
341 The global counter glyph_matrix_count is decremented when a matrix
342 is freed. If the count gets negative, more structures were freed
343 than allocated, i.e. one matrix was freed more than once or a bogus
344 pointer was passed to this function.
346 If MATRIX->pool is null, this means that the matrix manages its own
347 glyph memory---this is done for matrices on X frames. Freeing the
348 matrix also frees the glyph memory in this case. */
351 free_glyph_matrix (struct glyph_matrix
*matrix
)
357 /* Detect the case that more matrices are freed than were
359 if (--glyph_matrix_count
< 0)
362 /* Free glyph memory if MATRIX owns it. */
363 if (matrix
->pool
== NULL
)
364 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
365 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
367 /* Free row structures and the matrix itself. */
368 xfree (matrix
->rows
);
374 /* Return the number of glyphs to reserve for a marginal area of
375 window W. TOTAL_GLYPHS is the number of glyphs in a complete
376 display line of window W. MARGIN gives the width of the marginal
377 area in canonical character units. MARGIN should be an integer
381 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
385 if (NUMBERP (margin
))
387 int width
= XFASTINT (w
->total_cols
);
388 double d
= max (0, XFLOATINT (margin
));
389 d
= min (width
/ 2 - 1, d
);
390 n
= (int) ((double) total_glyphs
/ width
* d
);
398 /* Return non-zero if ROW's hash value is correct, zero if not.
399 Optimized away if ENABLE_CHECKING is not defined. */
402 verify_row_hash (struct glyph_row
*row
)
404 return row
->hash
== row_hash (row
);
407 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
410 W is null if the function is called for a frame glyph matrix.
411 Otherwise it is the window MATRIX is a member of. X and Y are the
412 indices of the first column and row of MATRIX within the frame
413 matrix, if such a matrix exists. They are zero for purely
414 window-based redisplay. DIM is the needed size of the matrix.
416 In window-based redisplay, where no frame matrices exist, glyph
417 matrices manage their own glyph storage. Otherwise, they allocate
418 storage from a common frame glyph pool which can be found in
421 The reason for this memory management strategy is to avoid complete
422 frame redraws if possible. When we allocate from a common pool, a
423 change of the location or size of a sub-matrix within the pool
424 requires a complete redisplay of the frame because we cannot easily
425 make sure that the current matrices of all windows still agree with
426 what is displayed on the screen. While this is usually fast, it
427 leads to screen flickering. */
430 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
434 int marginal_areas_changed_p
= 0;
435 int header_line_changed_p
= 0;
436 int header_line_p
= 0;
437 int left
= -1, right
= -1;
438 int window_width
= -1, window_height
= -1;
440 /* See if W had a header line that has disappeared now, or vice versa.
444 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
446 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
447 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
449 matrix
->header_line_p
= header_line_p
;
451 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
452 Do nothing if MATRIX' size, position, vscroll, and marginal areas
453 haven't changed. This optimization is important because preserving
454 the matrix means preventing redisplay. */
455 if (matrix
->pool
== NULL
)
457 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
458 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
459 eassert (left
>= 0 && right
>= 0);
460 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
461 || right
!= matrix
->right_margin_glyphs
);
463 if (!marginal_areas_changed_p
465 && !header_line_changed_p
466 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
467 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
468 && matrix
->window_height
== window_height
469 && matrix
->window_vscroll
== w
->vscroll
470 && matrix
->window_width
== window_width
)
474 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
475 if (matrix
->rows_allocated
< dim
.height
)
477 int old_alloc
= matrix
->rows_allocated
;
478 new_rows
= dim
.height
- matrix
->rows_allocated
;
479 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
480 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
481 memset (matrix
->rows
+ old_alloc
, 0,
482 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
487 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
488 on a frame not using window-based redisplay. Set up pointers for
489 each row into the glyph pool. */
492 eassert (matrix
->pool
->glyphs
);
496 left
= margin_glyphs_to_reserve (w
, dim
.width
,
497 w
->left_margin_cols
);
498 right
= margin_glyphs_to_reserve (w
, dim
.width
,
499 w
->right_margin_cols
);
504 for (i
= 0; i
< dim
.height
; ++i
)
506 struct glyph_row
*row
= &matrix
->rows
[i
];
508 row
->glyphs
[LEFT_MARGIN_AREA
]
509 = (matrix
->pool
->glyphs
510 + (y
+ i
) * matrix
->pool
->ncolumns
514 || row
== matrix
->rows
+ dim
.height
- 1
515 || (row
== matrix
->rows
&& matrix
->header_line_p
))
517 row
->glyphs
[TEXT_AREA
]
518 = row
->glyphs
[LEFT_MARGIN_AREA
];
519 row
->glyphs
[RIGHT_MARGIN_AREA
]
520 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
521 row
->glyphs
[LAST_AREA
]
522 = row
->glyphs
[RIGHT_MARGIN_AREA
];
526 row
->glyphs
[TEXT_AREA
]
527 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
528 row
->glyphs
[RIGHT_MARGIN_AREA
]
529 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
530 row
->glyphs
[LAST_AREA
]
531 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
535 matrix
->left_margin_glyphs
= left
;
536 matrix
->right_margin_glyphs
= right
;
540 /* If MATRIX->pool is null, MATRIX is responsible for managing
541 its own memory. It is a window matrix for window-based redisplay.
542 Allocate glyph memory from the heap. */
543 if (dim
.width
> matrix
->matrix_w
545 || header_line_changed_p
546 || marginal_areas_changed_p
)
548 struct glyph_row
*row
= matrix
->rows
;
549 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
553 row
->glyphs
[LEFT_MARGIN_AREA
]
554 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
555 dim
.width
, sizeof (struct glyph
));
557 /* The mode line never has marginal areas. */
558 if (row
== matrix
->rows
+ dim
.height
- 1
559 || (row
== matrix
->rows
&& matrix
->header_line_p
))
561 row
->glyphs
[TEXT_AREA
]
562 = row
->glyphs
[LEFT_MARGIN_AREA
];
563 row
->glyphs
[RIGHT_MARGIN_AREA
]
564 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
565 row
->glyphs
[LAST_AREA
]
566 = row
->glyphs
[RIGHT_MARGIN_AREA
];
570 row
->glyphs
[TEXT_AREA
]
571 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
572 row
->glyphs
[RIGHT_MARGIN_AREA
]
573 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
574 row
->glyphs
[LAST_AREA
]
575 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
581 eassert (left
>= 0 && right
>= 0);
582 matrix
->left_margin_glyphs
= left
;
583 matrix
->right_margin_glyphs
= right
;
586 /* Number of rows to be used by MATRIX. */
587 matrix
->nrows
= dim
.height
;
588 eassert (matrix
->nrows
>= 0);
592 if (matrix
== w
->current_matrix
)
594 /* Mark rows in a current matrix of a window as not having
595 valid contents. It's important to not do this for
596 desired matrices. When Emacs starts, it may already be
597 building desired matrices when this function runs. */
598 if (window_width
< 0)
599 window_width
= window_box_width (w
, -1);
601 /* Optimize the case that only the height has changed (C-x 2,
602 upper window). Invalidate all rows that are no longer part
604 if (!marginal_areas_changed_p
605 && !header_line_changed_p
607 && dim
.width
== matrix
->matrix_w
608 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
609 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
610 && matrix
->window_width
== window_width
)
612 /* Find the last row in the window. */
613 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
614 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
620 /* Window end is invalid, if inside of the rows that
621 are invalidated below. */
622 if (INTEGERP (w
->window_end_vpos
)
623 && XFASTINT (w
->window_end_vpos
) >= i
)
624 WSET (w
, window_end_valid
, Qnil
);
626 while (i
< matrix
->nrows
)
627 matrix
->rows
[i
++].enabled_p
= 0;
631 for (i
= 0; i
< matrix
->nrows
; ++i
)
632 matrix
->rows
[i
].enabled_p
= 0;
635 else if (matrix
== w
->desired_matrix
)
637 /* Rows in desired matrices always have to be cleared;
638 redisplay expects this is the case when it runs, so it
639 had better be the case when we adjust matrices between
641 for (i
= 0; i
< matrix
->nrows
; ++i
)
642 matrix
->rows
[i
].enabled_p
= 0;
647 /* Remember last values to be able to optimize frame redraws. */
648 matrix
->matrix_x
= x
;
649 matrix
->matrix_y
= y
;
650 matrix
->matrix_w
= dim
.width
;
651 matrix
->matrix_h
= dim
.height
;
653 /* Record the top y location and height of W at the time the matrix
654 was last adjusted. This is used to optimize redisplay above. */
657 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
658 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
659 matrix
->window_height
= window_height
;
660 matrix
->window_width
= window_width
;
661 matrix
->window_vscroll
= w
->vscroll
;
666 /* Reverse the contents of rows in MATRIX between START and END. The
667 contents of the row at END - 1 end up at START, END - 2 at START +
668 1 etc. This is part of the implementation of rotate_matrix (see
672 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
676 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
678 /* Non-ISO HP/UX compiler doesn't like auto struct
680 struct glyph_row temp
;
681 temp
= matrix
->rows
[i
];
682 matrix
->rows
[i
] = matrix
->rows
[j
];
683 matrix
->rows
[j
] = temp
;
688 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
689 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
690 indices. (Note: this does not copy glyphs, only glyph pointers in
691 row structures are moved around).
693 The algorithm used for rotating the vector was, I believe, first
694 described by Kernighan. See the vector R as consisting of two
695 sub-vectors AB, where A has length BY for BY >= 0. The result
696 after rotating is then BA. Reverse both sub-vectors to get ArBr
697 and reverse the result to get (ArBr)r which is BA. Similar for
701 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
705 /* Up (rotate left, i.e. towards lower indices). */
707 reverse_rows (matrix
, first
, first
+ by
);
708 reverse_rows (matrix
, first
+ by
, last
);
709 reverse_rows (matrix
, first
, last
);
713 /* Down (rotate right, i.e. towards higher indices). */
714 reverse_rows (matrix
, last
- by
, last
);
715 reverse_rows (matrix
, first
, last
- by
);
716 reverse_rows (matrix
, first
, last
);
721 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
722 with indices START <= index < END. Increment positions by DELTA/
726 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
727 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
729 /* Check that START and END are reasonable values. */
730 eassert (start
>= 0 && start
<= matrix
->nrows
);
731 eassert (end
>= 0 && end
<= matrix
->nrows
);
732 eassert (start
<= end
);
734 for (; start
< end
; ++start
)
735 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
739 /* Enable a range of rows in glyph matrix MATRIX. START and END are
740 the row indices of the first and last + 1 row to enable. If
741 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
744 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
746 eassert (start
<= end
);
747 eassert (start
>= 0 && start
< matrix
->nrows
);
748 eassert (end
>= 0 && end
<= matrix
->nrows
);
750 for (; start
< end
; ++start
)
751 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
757 This empties all rows in MATRIX by setting the enabled_p flag for
758 all rows of the matrix to zero. The function prepare_desired_row
759 will eventually really clear a row when it sees one with a zero
762 Resets update hints to defaults value. The only update hint
763 currently present is the flag MATRIX->no_scrolling_p. */
766 clear_glyph_matrix (struct glyph_matrix
*matrix
)
770 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
771 matrix
->no_scrolling_p
= 0;
776 /* Shift part of the glyph matrix MATRIX of window W up or down.
777 Increment y-positions in glyph rows between START and END by DY,
778 and recompute their visible height. */
781 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
785 eassert (start
<= end
);
786 eassert (start
>= 0 && start
< matrix
->nrows
);
787 eassert (end
>= 0 && end
<= matrix
->nrows
);
789 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
790 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
792 for (; start
< end
; ++start
)
794 struct glyph_row
*row
= &matrix
->rows
[start
];
797 row
->visible_height
= row
->height
;
800 row
->visible_height
-= min_y
- row
->y
;
801 if (row
->y
+ row
->height
> max_y
)
802 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
803 if (row
->fringe_bitmap_periodic_p
)
804 row
->redraw_fringe_bitmaps_p
= 1;
809 /* Mark all rows in current matrices of frame F as invalid. Marking
810 invalid is done by setting enabled_p to zero for all rows in a
814 clear_current_matrices (register struct frame
*f
)
816 /* Clear frame current matrix, if we have one. */
817 if (f
->current_matrix
)
818 clear_glyph_matrix (f
->current_matrix
);
820 /* Clear the matrix of the menu bar window, if such a window exists.
821 The menu bar window is currently used to display menus on X when
822 no toolkit support is compiled in. */
823 if (WINDOWP (f
->menu_bar_window
))
824 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
826 /* Clear the matrix of the tool-bar window, if any. */
827 if (WINDOWP (f
->tool_bar_window
))
828 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
830 /* Clear current window matrices. */
831 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
832 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
836 /* Clear out all display lines of F for a coming redisplay. */
839 clear_desired_matrices (register struct frame
*f
)
841 if (f
->desired_matrix
)
842 clear_glyph_matrix (f
->desired_matrix
);
844 if (WINDOWP (f
->menu_bar_window
))
845 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
847 if (WINDOWP (f
->tool_bar_window
))
848 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
850 /* Do it for window matrices. */
851 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
852 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
856 /* Clear matrices in window tree rooted in W. If DESIRED_P is
857 non-zero clear desired matrices, otherwise clear current matrices. */
860 clear_window_matrices (struct window
*w
, int desired_p
)
864 if (!NILP (w
->hchild
))
866 eassert (WINDOWP (w
->hchild
));
867 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
869 else if (!NILP (w
->vchild
))
871 eassert (WINDOWP (w
->vchild
));
872 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
877 clear_glyph_matrix (w
->desired_matrix
);
880 clear_glyph_matrix (w
->current_matrix
);
881 WSET (w
, window_end_valid
, Qnil
);
885 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
891 /***********************************************************************
894 See dispextern.h for an overall explanation of glyph rows.
895 ***********************************************************************/
897 /* Clear glyph row ROW. Do it in a way that makes it robust against
898 changes in the glyph_row structure, i.e. addition or removal of
899 structure members. */
901 static struct glyph_row null_row
;
904 clear_glyph_row (struct glyph_row
*row
)
906 struct glyph
*p
[1 + LAST_AREA
];
909 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
910 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
911 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
912 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
917 /* Restore pointers. */
918 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
919 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
920 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
921 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
923 #if 0 /* At some point, some bit-fields of struct glyph were not set,
924 which made glyphs unequal when compared with GLYPH_EQUAL_P.
925 Redisplay outputs such glyphs, and flickering effects were
926 the result. This also depended on the contents of memory
927 returned by xmalloc. If flickering happens again, activate
928 the code below. If the flickering is gone with that, chances
929 are that the flickering has the same reason as here. */
930 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
935 /* Make ROW an empty, enabled row of canonical character height,
936 in window W starting at y-position Y. */
939 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
943 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
944 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
946 clear_glyph_row (row
);
948 row
->ascent
= row
->phys_ascent
= 0;
949 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
950 row
->visible_height
= row
->height
;
953 row
->visible_height
-= min_y
- row
->y
;
954 if (row
->y
+ row
->height
> max_y
)
955 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
961 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
962 are the amounts by which to change positions. Note that the first
963 glyph of the text area of a row can have a buffer position even if
964 the used count of the text area is zero. Such rows display line
968 increment_row_positions (struct glyph_row
*row
,
969 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
973 /* Increment start and end positions. */
974 MATRIX_ROW_START_CHARPOS (row
) += delta
;
975 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
976 MATRIX_ROW_END_CHARPOS (row
) += delta
;
977 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
978 CHARPOS (row
->start
.pos
) += delta
;
979 BYTEPOS (row
->start
.pos
) += delta_bytes
;
980 CHARPOS (row
->end
.pos
) += delta
;
981 BYTEPOS (row
->end
.pos
) += delta_bytes
;
986 /* Increment positions in glyphs. */
987 for (area
= 0; area
< LAST_AREA
; ++area
)
988 for (i
= 0; i
< row
->used
[area
]; ++i
)
989 if (BUFFERP (row
->glyphs
[area
][i
].object
)
990 && row
->glyphs
[area
][i
].charpos
> 0)
991 row
->glyphs
[area
][i
].charpos
+= delta
;
993 /* Capture the case of rows displaying a line end. */
994 if (row
->used
[TEXT_AREA
] == 0
995 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
996 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1001 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1002 contents, i.e. glyph structure contents are exchanged between A and
1003 B without changing glyph pointers in A and B. */
1006 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
1010 for (area
= 0; area
< LAST_AREA
; ++area
)
1012 /* Number of glyphs to swap. */
1013 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1015 /* Start of glyphs in area of row A. */
1016 struct glyph
*glyph_a
= a
->glyphs
[area
];
1018 /* End + 1 of glyphs in area of row A. */
1019 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1021 /* Start of glyphs in area of row B. */
1022 struct glyph
*glyph_b
= b
->glyphs
[area
];
1024 while (glyph_a
< glyph_a_end
)
1026 /* Non-ISO HP/UX compiler doesn't like auto struct
1030 *glyph_a
= *glyph_b
;
1040 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1041 exchange the used[] array and the hash values of the rows, because
1042 these should all go together for the row's hash value to be
1046 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1049 unsigned hash_tem
= a
->hash
;
1051 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1053 struct glyph
*temp
= a
->glyphs
[i
];
1055 a
->glyphs
[i
] = b
->glyphs
[i
];
1056 b
->glyphs
[i
] = temp
;
1059 short used_tem
= a
->used
[i
];
1061 a
->used
[i
] = b
->used
[i
];
1062 b
->used
[i
] = used_tem
;
1070 /* Copy glyph row structure FROM to glyph row structure TO, except
1071 that glyph pointers, the `used' counts, and the hash values in the
1072 structures are left unchanged. */
1075 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1077 struct glyph
*pointers
[1 + LAST_AREA
];
1078 short used
[LAST_AREA
];
1081 /* Save glyph pointers of TO. */
1082 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1083 memcpy (used
, to
->used
, sizeof to
->used
);
1086 /* Do a structure assignment. */
1089 /* Restore original pointers of TO. */
1090 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1091 memcpy (to
->used
, used
, sizeof to
->used
);
1096 /* Assign glyph row FROM to glyph row TO. This works like a structure
1097 assignment TO = FROM, except that glyph pointers are not copied but
1098 exchanged between TO and FROM. Pointers must be exchanged to avoid
1102 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1104 swap_glyph_pointers (to
, from
);
1105 copy_row_except_pointers (to
, from
);
1109 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1110 a row in a window matrix, is a slice of the glyph memory of the
1111 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1112 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1113 memory of FRAME_ROW. */
1118 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1120 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1121 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1122 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1124 return (frame_glyph_start
<= window_glyph_start
1125 && window_glyph_start
< frame_glyph_end
);
1128 #endif /* GLYPH_DEBUG */
1132 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1133 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1134 in WINDOW_MATRIX is found satisfying the condition. */
1136 static struct glyph_row
*
1137 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1138 struct glyph_matrix
*frame_matrix
, int row
)
1142 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1144 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1145 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1146 frame_matrix
->rows
+ row
))
1149 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1154 /* Prepare ROW for display. Desired rows are cleared lazily,
1155 i.e. they are only marked as to be cleared by setting their
1156 enabled_p flag to zero. When a row is to be displayed, a prior
1157 call to this function really clears it. */
1160 prepare_desired_row (struct glyph_row
*row
)
1162 if (!row
->enabled_p
)
1164 int rp
= row
->reversed_p
;
1166 clear_glyph_row (row
);
1168 row
->reversed_p
= rp
;
1173 /* Return a hash code for glyph row ROW. */
1176 line_hash_code (struct glyph_row
*row
)
1182 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1183 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1187 int c
= glyph
->u
.ch
;
1188 int face_id
= glyph
->face_id
;
1189 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1191 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1192 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1204 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1205 the number of characters in the line. If must_write_spaces is
1206 zero, leading and trailing spaces are ignored. */
1209 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1211 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1212 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1213 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1215 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1216 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1218 /* Ignore trailing and leading spaces if we can. */
1219 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1221 /* Skip from the end over trailing spaces. */
1222 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1225 /* All blank line. */
1229 /* Skip over leading spaces. */
1230 while (CHAR_GLYPH_SPACE_P (*beg
))
1234 /* If we don't have a glyph-table, each glyph is one character,
1235 so return the number of glyphs. */
1236 if (glyph_table_base
== 0)
1240 /* Otherwise, scan the glyphs and accumulate their total length
1247 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1249 if (GLYPH_INVALID_P (g
)
1250 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1253 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1263 /* Test two glyph rows A and B for equality. Value is non-zero if A
1264 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1265 mouse_face_p flags of A and B, too. */
1268 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1270 eassert (verify_row_hash (a
));
1271 eassert (verify_row_hash (b
));
1275 else if (a
->hash
!= b
->hash
)
1279 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1282 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1285 /* Compare glyphs. */
1286 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1288 if (a
->used
[area
] != b
->used
[area
])
1291 a_glyph
= a
->glyphs
[area
];
1292 a_end
= a_glyph
+ a
->used
[area
];
1293 b_glyph
= b
->glyphs
[area
];
1295 while (a_glyph
< a_end
1296 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1297 ++a_glyph
, ++b_glyph
;
1299 if (a_glyph
!= a_end
)
1303 if (a
->fill_line_p
!= b
->fill_line_p
1304 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1305 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1306 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1307 || a
->left_fringe_offset
!= b
->left_fringe_offset
1308 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1309 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1310 || a
->right_fringe_offset
!= b
->right_fringe_offset
1311 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1312 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1313 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1314 || a
->overlapped_p
!= b
->overlapped_p
1315 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1316 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1317 || a
->reversed_p
!= b
->reversed_p
1318 /* Different partially visible characters on left margin. */
1320 /* Different height. */
1321 || a
->ascent
!= b
->ascent
1322 || a
->phys_ascent
!= b
->phys_ascent
1323 || a
->phys_height
!= b
->phys_height
1324 || a
->visible_height
!= b
->visible_height
)
1333 /***********************************************************************
1336 See dispextern.h for an overall explanation of glyph pools.
1337 ***********************************************************************/
1339 /* Allocate a glyph_pool structure. The structure returned is
1340 initialized with zeros. The global variable glyph_pool_count is
1341 incremented for each pool allocated. */
1343 static struct glyph_pool
*
1344 new_glyph_pool (void)
1346 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1348 /* For memory leak and double deletion checking. */
1355 /* Free a glyph_pool structure POOL. The function may be called with
1356 a null POOL pointer. The global variable glyph_pool_count is
1357 decremented with every pool structure freed. If this count gets
1358 negative, more structures were freed than allocated, i.e. one
1359 structure must have been freed more than once or a bogus pointer
1360 was passed to free_glyph_pool. */
1363 free_glyph_pool (struct glyph_pool
*pool
)
1367 /* More freed than allocated? */
1369 eassert (glyph_pool_count
>= 0);
1371 xfree (pool
->glyphs
);
1377 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1378 columns we need. This function never shrinks a pool. The only
1379 case in which this would make sense, would be when a frame's size
1380 is changed from a large value to a smaller one. But, if someone
1381 does it once, we can expect that he will do it again.
1383 Value is non-zero if the pool changed in a way which makes
1384 re-adjusting window glyph matrices necessary. */
1387 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1392 changed_p
= (pool
->glyphs
== 0
1393 || matrix_dim
.height
!= pool
->nrows
1394 || matrix_dim
.width
!= pool
->ncolumns
);
1396 /* Enlarge the glyph pool. */
1397 needed
= matrix_dim
.width
;
1398 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1399 memory_full (SIZE_MAX
);
1400 needed
*= matrix_dim
.height
;
1401 if (needed
> pool
->nglyphs
)
1403 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1404 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1405 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1406 memset (pool
->glyphs
+ old_nglyphs
, 0,
1407 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1410 /* Remember the number of rows and columns because (a) we use them
1411 to do sanity checks, and (b) the number of columns determines
1412 where rows in the frame matrix start---this must be available to
1413 determine pointers to rows of window sub-matrices. */
1414 pool
->nrows
= matrix_dim
.height
;
1415 pool
->ncolumns
= matrix_dim
.width
;
1422 /***********************************************************************
1424 ***********************************************************************/
1429 /* Flush standard output. This is sometimes useful to call from the debugger.
1430 XXX Maybe this should be changed to flush the current terminal instead of
1434 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1443 /* Check that no glyph pointers have been lost in MATRIX. If a
1444 pointer has been lost, e.g. by using a structure assignment between
1445 rows, at least one pointer must occur more than once in the rows of
1449 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1453 for (i
= 0; i
< matrix
->nrows
; ++i
)
1454 for (j
= 0; j
< matrix
->nrows
; ++j
)
1456 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1457 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1461 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1464 matrix_row (struct glyph_matrix
*matrix
, int row
)
1466 eassert (matrix
&& matrix
->rows
);
1467 eassert (row
>= 0 && row
< matrix
->nrows
);
1469 /* That's really too slow for normal testing because this function
1470 is called almost everywhere. Although---it's still astonishingly
1471 fast, so it is valuable to have for debugging purposes. */
1473 check_matrix_pointer_lossage (matrix
);
1476 return matrix
->rows
+ row
;
1480 #if 0 /* This function makes invalid assumptions when text is
1481 partially invisible. But it might come handy for debugging
1484 /* Check invariants that must hold for an up to date current matrix of
1488 check_matrix_invariants (struct window
*w
)
1490 struct glyph_matrix
*matrix
= w
->current_matrix
;
1491 int yb
= window_text_bottom_y (w
);
1492 struct glyph_row
*row
= matrix
->rows
;
1493 struct glyph_row
*last_text_row
= NULL
;
1494 struct buffer
*saved
= current_buffer
;
1495 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1498 /* This can sometimes happen for a fresh window. */
1499 if (matrix
->nrows
< 2)
1502 set_buffer_temp (buffer
);
1504 /* Note: last row is always reserved for the mode line. */
1505 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1506 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1508 struct glyph_row
*next
= row
+ 1;
1510 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1511 last_text_row
= row
;
1513 /* Check that character and byte positions are in sync. */
1514 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1515 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1516 eassert (BYTEPOS (row
->start
.pos
)
1517 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1519 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1520 have such a position temporarily in case of a minibuffer
1521 displaying something like `[Sole completion]' at its end. */
1522 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1524 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1525 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1526 eassert (BYTEPOS (row
->end
.pos
)
1527 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1530 /* Check that end position of `row' is equal to start position
1532 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1534 eassert (MATRIX_ROW_END_CHARPOS (row
)
1535 == MATRIX_ROW_START_CHARPOS (next
));
1536 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1537 == MATRIX_ROW_START_BYTEPOS (next
));
1538 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1539 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1544 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1545 eassert (w
->desired_matrix
->rows
!= NULL
);
1546 set_buffer_temp (saved
);
1551 #endif /* GLYPH_DEBUG */
1555 /**********************************************************************
1556 Allocating/ Adjusting Glyph Matrices
1557 **********************************************************************/
1559 /* Allocate glyph matrices over a window tree for a frame-based
1562 X and Y are column/row within the frame glyph matrix where
1563 sub-matrices for the window tree rooted at WINDOW must be
1564 allocated. DIM_ONLY_P non-zero means that the caller of this
1565 function is only interested in the result matrix dimension, and
1566 matrix adjustments should not be performed.
1568 The function returns the total width/height of the sub-matrices of
1569 the window tree. If called on a frame root window, the computation
1570 will take the mini-buffer window into account.
1572 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1574 NEW_LEAF_MATRIX set if any window in the tree did not have a
1575 glyph matrices yet, and
1577 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1578 any window in the tree will be changed or have been changed (see
1581 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1584 Windows are arranged into chains of windows on the same level
1585 through the next fields of window structures. Such a level can be
1586 either a sequence of horizontally adjacent windows from left to
1587 right, or a sequence of vertically adjacent windows from top to
1588 bottom. Each window in a horizontal sequence can be either a leaf
1589 window or a vertical sequence; a window in a vertical sequence can
1590 be either a leaf or a horizontal sequence. All windows in a
1591 horizontal sequence have the same height, and all windows in a
1592 vertical sequence have the same width.
1594 This function uses, for historical reasons, a more general
1595 algorithm to determine glyph matrix dimensions that would be
1598 The matrix height of a horizontal sequence is determined by the
1599 maximum height of any matrix in the sequence. The matrix width of
1600 a horizontal sequence is computed by adding up matrix widths of
1601 windows in the sequence.
1603 |<------- result width ------->|
1604 +---------+----------+---------+ ---
1607 +---------+ | | result height
1612 The matrix width of a vertical sequence is the maximum matrix width
1613 of any window in the sequence. Its height is computed by adding up
1614 matrix heights of windows in the sequence.
1616 |<---- result width -->|
1624 +------------+---------+ |
1627 +------------+---------+ --- */
1629 /* Bit indicating that a new matrix will be allocated or has been
1632 #define NEW_LEAF_MATRIX (1 << 0)
1634 /* Bit indicating that a matrix will or has changed its location or
1637 #define CHANGED_LEAF_MATRIX (1 << 1)
1640 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1641 int dim_only_p
, int *window_change_flags
)
1643 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1645 int wmax
= 0, hmax
= 0;
1649 int in_horz_combination_p
;
1651 /* What combination is WINDOW part of? Compute this once since the
1652 result is the same for all windows in the `next' chain. The
1653 special case of a root window (parent equal to nil) is treated
1654 like a vertical combination because a root window's `next'
1655 points to the mini-buffer window, if any, which is arranged
1656 vertically below other windows. */
1657 in_horz_combination_p
1658 = (!NILP (XWINDOW (window
)->parent
)
1659 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1661 /* For WINDOW and all windows on the same level. */
1664 w
= XWINDOW (window
);
1666 /* Get the dimension of the window sub-matrix for W, depending
1667 on whether this is a combination or a leaf window. */
1668 if (!NILP (w
->hchild
))
1669 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1671 window_change_flags
);
1672 else if (!NILP (w
->vchild
))
1673 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1675 window_change_flags
);
1678 /* If not already done, allocate sub-matrix structures. */
1679 if (w
->desired_matrix
== NULL
)
1681 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1682 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1683 *window_change_flags
|= NEW_LEAF_MATRIX
;
1686 /* Width and height MUST be chosen so that there are no
1687 holes in the frame matrix. */
1688 dim
.width
= required_matrix_width (w
);
1689 dim
.height
= required_matrix_height (w
);
1691 /* Will matrix be re-allocated? */
1692 if (x
!= w
->desired_matrix
->matrix_x
1693 || y
!= w
->desired_matrix
->matrix_y
1694 || dim
.width
!= w
->desired_matrix
->matrix_w
1695 || dim
.height
!= w
->desired_matrix
->matrix_h
1696 || (margin_glyphs_to_reserve (w
, dim
.width
,
1697 w
->left_margin_cols
)
1698 != w
->desired_matrix
->left_margin_glyphs
)
1699 || (margin_glyphs_to_reserve (w
, dim
.width
,
1700 w
->right_margin_cols
)
1701 != w
->desired_matrix
->right_margin_glyphs
))
1702 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1704 /* Actually change matrices, if allowed. Do not consider
1705 CHANGED_LEAF_MATRIX computed above here because the pool
1706 may have been changed which we don't now here. We trust
1707 that we only will be called with DIM_ONLY_P != 0 when
1711 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1712 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1716 /* If we are part of a horizontal combination, advance x for
1717 windows to the right of W; otherwise advance y for windows
1719 if (in_horz_combination_p
)
1724 /* Remember maximum glyph matrix dimensions. */
1725 wmax
= max (wmax
, dim
.width
);
1726 hmax
= max (hmax
, dim
.height
);
1728 /* Next window on same level. */
1731 while (!NILP (window
));
1733 /* Set `total' to the total glyph matrix dimension of this window
1734 level. In a vertical combination, the width is the width of the
1735 widest window; the height is the y we finally reached, corrected
1736 by the y we started with. In a horizontal combination, the total
1737 height is the height of the tallest window, and the width is the
1738 x we finally reached, corrected by the x we started with. */
1739 if (in_horz_combination_p
)
1741 total
.width
= x
- x0
;
1742 total
.height
= hmax
;
1747 total
.height
= y
- y0
;
1754 /* Return the required height of glyph matrices for window W. */
1757 required_matrix_height (struct window
*w
)
1759 #ifdef HAVE_WINDOW_SYSTEM
1760 struct frame
*f
= XFRAME (w
->frame
);
1762 if (FRAME_WINDOW_P (f
))
1764 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1765 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1766 return (((window_pixel_height
+ ch_height
- 1)
1767 / ch_height
) * w
->nrows_scale_factor
1768 /* One partially visible line at the top and
1769 bottom of the window. */
1771 /* 2 for header and mode line. */
1774 #endif /* HAVE_WINDOW_SYSTEM */
1776 return WINDOW_TOTAL_LINES (w
);
1780 /* Return the required width of glyph matrices for window W. */
1783 required_matrix_width (struct window
*w
)
1785 #ifdef HAVE_WINDOW_SYSTEM
1786 struct frame
*f
= XFRAME (w
->frame
);
1787 if (FRAME_WINDOW_P (f
))
1789 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1790 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1792 /* Compute number of glyphs needed in a glyph row. */
1793 return (((window_pixel_width
+ ch_width
- 1)
1794 / ch_width
) * w
->ncols_scale_factor
1795 /* 2 partially visible columns in the text area. */
1797 /* One partially visible column at the right
1798 edge of each marginal area. */
1801 #endif /* HAVE_WINDOW_SYSTEM */
1803 return XINT (w
->total_cols
);
1807 /* Allocate window matrices for window-based redisplay. W is the
1808 window whose matrices must be allocated/reallocated. */
1811 allocate_matrices_for_window_redisplay (struct window
*w
)
1815 if (!NILP (w
->vchild
))
1816 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1817 else if (!NILP (w
->hchild
))
1818 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1821 /* W is a leaf window. */
1824 /* If matrices are not yet allocated, allocate them now. */
1825 if (w
->desired_matrix
== NULL
)
1827 w
->desired_matrix
= new_glyph_matrix (NULL
);
1828 w
->current_matrix
= new_glyph_matrix (NULL
);
1831 dim
.width
= required_matrix_width (w
);
1832 dim
.height
= required_matrix_height (w
);
1833 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1834 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1837 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1842 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1843 do it for all frames; otherwise do it just for the given frame.
1844 This function must be called when a new frame is created, its size
1845 changes, or its window configuration changes. */
1848 adjust_glyphs (struct frame
*f
)
1850 /* Block input so that expose events and other events that access
1851 glyph matrices are not processed while we are changing them. */
1855 adjust_frame_glyphs (f
);
1858 Lisp_Object tail
, lisp_frame
;
1860 FOR_EACH_FRAME (tail
, lisp_frame
)
1861 adjust_frame_glyphs (XFRAME (lisp_frame
));
1868 /* Adjust frame glyphs when Emacs is initialized.
1870 To be called from init_display.
1872 We need a glyph matrix because redraw will happen soon.
1873 Unfortunately, window sizes on selected_frame are not yet set to
1874 meaningful values. I believe we can assume that there are only two
1875 windows on the frame---the mini-buffer and the root window. Frame
1876 height and width seem to be correct so far. So, set the sizes of
1877 windows to estimated values. */
1880 adjust_frame_glyphs_initially (void)
1882 struct frame
*sf
= SELECTED_FRAME ();
1883 struct window
*root
= XWINDOW (sf
->root_window
);
1884 struct window
*mini
= XWINDOW (root
->next
);
1885 int frame_lines
= FRAME_LINES (sf
);
1886 int frame_cols
= FRAME_COLS (sf
);
1887 int top_margin
= FRAME_TOP_MARGIN (sf
);
1889 /* Do it for the root window. */
1890 WSET (root
, top_line
, make_number (top_margin
));
1891 WSET (root
, total_lines
, make_number (frame_lines
- 1 - top_margin
));
1892 WSET (root
, total_cols
, make_number (frame_cols
));
1894 /* Do it for the mini-buffer window. */
1895 WSET (mini
, top_line
, make_number (frame_lines
- 1));
1896 WSET (mini
, total_lines
, make_number (1));
1897 WSET (mini
, total_cols
, make_number (frame_cols
));
1899 adjust_frame_glyphs (sf
);
1900 glyphs_initialized_initially_p
= 1;
1904 /* Allocate/reallocate glyph matrices of a single frame F. */
1907 adjust_frame_glyphs (struct frame
*f
)
1909 if (FRAME_WINDOW_P (f
))
1910 adjust_frame_glyphs_for_window_redisplay (f
);
1912 adjust_frame_glyphs_for_frame_redisplay (f
);
1914 /* Don't forget the message buffer and the buffer for
1915 decode_mode_spec. */
1916 adjust_frame_message_buffer (f
);
1917 adjust_decode_mode_spec_buffer (f
);
1919 f
->glyphs_initialized_p
= 1;
1922 /* Return 1 if any window in the tree has nonzero window margins. See
1923 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1925 showing_window_margins_p (struct window
*w
)
1929 if (!NILP (w
->hchild
))
1931 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1934 else if (!NILP (w
->vchild
))
1936 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1939 else if (!NILP (w
->left_margin_cols
)
1940 || !NILP (w
->right_margin_cols
))
1943 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1949 /* In the window tree with root W, build current matrices of leaf
1950 windows from the frame's current matrix. */
1953 fake_current_matrices (Lisp_Object window
)
1957 for (; !NILP (window
); window
= w
->next
)
1959 w
= XWINDOW (window
);
1961 if (!NILP (w
->hchild
))
1962 fake_current_matrices (w
->hchild
);
1963 else if (!NILP (w
->vchild
))
1964 fake_current_matrices (w
->vchild
);
1968 struct frame
*f
= XFRAME (w
->frame
);
1969 struct glyph_matrix
*m
= w
->current_matrix
;
1970 struct glyph_matrix
*fm
= f
->current_matrix
;
1972 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1973 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1975 for (i
= 0; i
< m
->matrix_h
; ++i
)
1977 struct glyph_row
*r
= m
->rows
+ i
;
1978 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1980 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1981 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1983 r
->enabled_p
= fr
->enabled_p
;
1986 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1987 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1988 r
->used
[TEXT_AREA
] = (m
->matrix_w
1989 - r
->used
[LEFT_MARGIN_AREA
]
1990 - r
->used
[RIGHT_MARGIN_AREA
]);
1999 /* Save away the contents of frame F's current frame matrix. Value is
2000 a glyph matrix holding the contents of F's current frame matrix. */
2002 static struct glyph_matrix
*
2003 save_current_matrix (struct frame
*f
)
2006 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
2007 saved
->nrows
= f
->current_matrix
->nrows
;
2008 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
2010 for (i
= 0; i
< saved
->nrows
; ++i
)
2012 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2013 struct glyph_row
*to
= saved
->rows
+ i
;
2014 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2015 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
2016 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2017 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2024 /* Restore the contents of frame F's current frame matrix from SAVED,
2025 and free memory associated with SAVED. */
2028 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2032 for (i
= 0; i
< saved
->nrows
; ++i
)
2034 struct glyph_row
*from
= saved
->rows
+ i
;
2035 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2036 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2037 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2038 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2039 xfree (from
->glyphs
[TEXT_AREA
]);
2042 xfree (saved
->rows
);
2048 /* Allocate/reallocate glyph matrices of a single frame F for
2049 frame-based redisplay. */
2052 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2054 struct dim matrix_dim
;
2056 int window_change_flags
;
2059 if (!FRAME_LIVE_P (f
))
2062 top_window_y
= FRAME_TOP_MARGIN (f
);
2064 /* Allocate glyph pool structures if not already done. */
2065 if (f
->desired_pool
== NULL
)
2067 f
->desired_pool
= new_glyph_pool ();
2068 f
->current_pool
= new_glyph_pool ();
2071 /* Allocate frames matrix structures if needed. */
2072 if (f
->desired_matrix
== NULL
)
2074 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2075 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2078 /* Compute window glyph matrices. (This takes the mini-buffer
2079 window into account). The result is the size of the frame glyph
2080 matrix needed. The variable window_change_flags is set to a bit
2081 mask indicating whether new matrices will be allocated or
2082 existing matrices change their size or location within the frame
2084 window_change_flags
= 0;
2086 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2089 &window_change_flags
);
2091 /* Add in menu bar lines, if any. */
2092 matrix_dim
.height
+= top_window_y
;
2094 /* Enlarge pools as necessary. */
2095 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2096 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2098 /* Set up glyph pointers within window matrices. Do this only if
2099 absolutely necessary since it requires a frame redraw. */
2100 if (pool_changed_p
|| window_change_flags
)
2102 /* Do it for window matrices. */
2103 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2105 &window_change_flags
);
2107 /* Size of frame matrices must equal size of frame. Note
2108 that we are called for X frames with window widths NOT equal
2109 to the frame width (from CHANGE_FRAME_SIZE_1). */
2110 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2111 && matrix_dim
.height
== FRAME_LINES (f
));
2113 /* Pointers to glyph memory in glyph rows are exchanged during
2114 the update phase of redisplay, which means in general that a
2115 frame's current matrix consists of pointers into both the
2116 desired and current glyph pool of the frame. Adjusting a
2117 matrix sets the frame matrix up so that pointers are all into
2118 the same pool. If we want to preserve glyph contents of the
2119 current matrix over a call to adjust_glyph_matrix, we must
2120 make a copy of the current glyphs, and restore the current
2121 matrix' contents from that copy. */
2122 if (display_completed
2123 && !FRAME_GARBAGED_P (f
)
2124 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2125 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2126 /* For some reason, the frame glyph matrix gets corrupted if
2127 any of the windows contain margins. I haven't been able
2128 to hunt down the reason, but for the moment this prevents
2129 the problem from manifesting. -- cyd */
2130 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2132 struct glyph_matrix
*copy
= save_current_matrix (f
);
2133 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2134 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2135 restore_current_matrix (f
, copy
);
2136 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2140 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2141 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2142 SET_FRAME_GARBAGED (f
);
2148 /* Allocate/reallocate glyph matrices of a single frame F for
2149 window-based redisplay. */
2152 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2154 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2156 /* Allocate/reallocate window matrices. */
2157 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2159 #ifdef HAVE_X_WINDOWS
2160 /* Allocate/ reallocate matrices of the dummy window used to display
2161 the menu bar under X when no X toolkit support is available. */
2162 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2164 /* Allocate a dummy window if not already done. */
2166 if (NILP (f
->menu_bar_window
))
2169 FSET (f
, menu_bar_window
, make_window ());
2170 w
= XWINDOW (f
->menu_bar_window
);
2171 XSETFRAME (frame
, f
);
2172 WSET (w
, frame
, frame
);
2173 w
->pseudo_window_p
= 1;
2176 w
= XWINDOW (f
->menu_bar_window
);
2178 /* Set window dimensions to frame dimensions and allocate or
2179 adjust glyph matrices of W. */
2180 WSET (w
, top_line
, make_number (0));
2181 WSET (w
, left_col
, make_number (0));
2182 WSET (w
, total_lines
, make_number (FRAME_MENU_BAR_LINES (f
)));
2183 WSET (w
, total_cols
, make_number (FRAME_TOTAL_COLS (f
)));
2184 allocate_matrices_for_window_redisplay (w
);
2186 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2187 #endif /* HAVE_X_WINDOWS */
2191 /* Allocate/ reallocate matrices of the tool bar window. If we
2192 don't have a tool bar window yet, make one. */
2194 if (NILP (f
->tool_bar_window
))
2197 FSET (f
, tool_bar_window
, make_window ());
2198 w
= XWINDOW (f
->tool_bar_window
);
2199 XSETFRAME (frame
, f
);
2200 WSET (w
, frame
, frame
);
2201 w
->pseudo_window_p
= 1;
2204 w
= XWINDOW (f
->tool_bar_window
);
2206 WSET (w
, top_line
, make_number (FRAME_MENU_BAR_LINES (f
)));
2207 WSET (w
, left_col
, make_number (0));
2208 WSET (w
, total_lines
, make_number (FRAME_TOOL_BAR_LINES (f
)));
2209 WSET (w
, total_cols
, make_number (FRAME_TOTAL_COLS (f
)));
2210 allocate_matrices_for_window_redisplay (w
);
2216 /* Adjust/ allocate message buffer of frame F.
2218 Note that the message buffer is never freed. Since I could not
2219 find a free in 19.34, I assume that freeing it would be
2220 problematic in some way and don't do it either.
2222 (Implementation note: It should be checked if we can free it
2223 eventually without causing trouble). */
2226 adjust_frame_message_buffer (struct frame
*f
)
2228 FRAME_MESSAGE_BUF (f
) = xrealloc (FRAME_MESSAGE_BUF (f
),
2229 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2233 /* Re-allocate buffer for decode_mode_spec on frame F. */
2236 adjust_decode_mode_spec_buffer (struct frame
*f
)
2238 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2239 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2244 /**********************************************************************
2245 Freeing Glyph Matrices
2246 **********************************************************************/
2248 /* Free glyph memory for a frame F. F may be null. This function can
2249 be called for the same frame more than once. The root window of
2250 F may be nil when this function is called. This is the case when
2251 the function is called when F is destroyed. */
2254 free_glyphs (struct frame
*f
)
2256 if (f
&& f
->glyphs_initialized_p
)
2258 /* Block interrupt input so that we don't get surprised by an X
2259 event while we're in an inconsistent state. */
2261 f
->glyphs_initialized_p
= 0;
2263 /* Release window sub-matrices. */
2264 if (!NILP (f
->root_window
))
2265 free_window_matrices (XWINDOW (f
->root_window
));
2267 /* Free the dummy window for menu bars without X toolkit and its
2269 if (!NILP (f
->menu_bar_window
))
2271 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2272 free_glyph_matrix (w
->desired_matrix
);
2273 free_glyph_matrix (w
->current_matrix
);
2274 w
->desired_matrix
= w
->current_matrix
= NULL
;
2275 FSET (f
, menu_bar_window
, Qnil
);
2278 /* Free the tool bar window and its glyph matrices. */
2279 if (!NILP (f
->tool_bar_window
))
2281 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2282 free_glyph_matrix (w
->desired_matrix
);
2283 free_glyph_matrix (w
->current_matrix
);
2284 w
->desired_matrix
= w
->current_matrix
= NULL
;
2285 FSET (f
, tool_bar_window
, Qnil
);
2288 /* Release frame glyph matrices. Reset fields to zero in
2289 case we are called a second time. */
2290 if (f
->desired_matrix
)
2292 free_glyph_matrix (f
->desired_matrix
);
2293 free_glyph_matrix (f
->current_matrix
);
2294 f
->desired_matrix
= f
->current_matrix
= NULL
;
2297 /* Release glyph pools. */
2298 if (f
->desired_pool
)
2300 free_glyph_pool (f
->desired_pool
);
2301 free_glyph_pool (f
->current_pool
);
2302 f
->desired_pool
= f
->current_pool
= NULL
;
2310 /* Free glyph sub-matrices in the window tree rooted at W. This
2311 function may be called with a null pointer, and it may be called on
2312 the same tree more than once. */
2315 free_window_matrices (struct window
*w
)
2319 if (!NILP (w
->hchild
))
2320 free_window_matrices (XWINDOW (w
->hchild
));
2321 else if (!NILP (w
->vchild
))
2322 free_window_matrices (XWINDOW (w
->vchild
));
2325 /* This is a leaf window. Free its memory and reset fields
2326 to zero in case this function is called a second time for
2328 free_glyph_matrix (w
->current_matrix
);
2329 free_glyph_matrix (w
->desired_matrix
);
2330 w
->current_matrix
= w
->desired_matrix
= NULL
;
2333 /* Next window on same level. */
2334 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2339 /* Check glyph memory leaks. This function is called from
2340 shut_down_emacs. Note that frames are not destroyed when Emacs
2341 exits. We therefore free all glyph memory for all active frames
2342 explicitly and check that nothing is left allocated. */
2345 check_glyph_memory (void)
2347 Lisp_Object tail
, frame
;
2349 /* Free glyph memory for all frames. */
2350 FOR_EACH_FRAME (tail
, frame
)
2351 free_glyphs (XFRAME (frame
));
2353 /* Check that nothing is left allocated. */
2354 if (glyph_matrix_count
)
2356 if (glyph_pool_count
)
2362 /**********************************************************************
2363 Building a Frame Matrix
2364 **********************************************************************/
2366 /* Most of the redisplay code works on glyph matrices attached to
2367 windows. This is a good solution most of the time, but it is not
2368 suitable for terminal code. Terminal output functions cannot rely
2369 on being able to set an arbitrary terminal window. Instead they
2370 must be provided with a view of the whole frame, i.e. the whole
2371 screen. We build such a view by constructing a frame matrix from
2372 window matrices in this section.
2374 Windows that must be updated have their must_be_update_p flag set.
2375 For all such windows, their desired matrix is made part of the
2376 desired frame matrix. For other windows, their current matrix is
2377 made part of the desired frame matrix.
2379 +-----------------+----------------+
2380 | desired | desired |
2382 +-----------------+----------------+
2385 +----------------------------------+
2387 Desired window matrices can be made part of the frame matrix in a
2388 cheap way: We exploit the fact that the desired frame matrix and
2389 desired window matrices share their glyph memory. This is not
2390 possible for current window matrices. Their glyphs are copied to
2391 the desired frame matrix. The latter is equivalent to
2392 preserve_other_columns in the old redisplay.
2394 Used glyphs counters for frame matrix rows are the result of adding
2395 up glyph lengths of the window matrices. A line in the frame
2396 matrix is enabled, if a corresponding line in a window matrix is
2399 After building the desired frame matrix, it will be passed to
2400 terminal code, which will manipulate both the desired and current
2401 frame matrix. Changes applied to the frame's current matrix have
2402 to be visible in current window matrices afterwards, of course.
2404 This problem is solved like this:
2406 1. Window and frame matrices share glyphs. Window matrices are
2407 constructed in a way that their glyph contents ARE the glyph
2408 contents needed in a frame matrix. Thus, any modification of
2409 glyphs done in terminal code will be reflected in window matrices
2412 2. Exchanges of rows in a frame matrix done by terminal code are
2413 intercepted by hook functions so that corresponding row operations
2414 on window matrices can be performed. This is necessary because we
2415 use pointers to glyphs in glyph row structures. To satisfy the
2416 assumption of point 1 above that glyphs are updated implicitly in
2417 window matrices when they are manipulated via the frame matrix,
2418 window and frame matrix must of course agree where to find the
2419 glyphs for their rows. Possible manipulations that must be
2420 mirrored are assignments of rows of the desired frame matrix to the
2421 current frame matrix and scrolling the current frame matrix. */
2423 /* Build frame F's desired matrix from window matrices. Only windows
2424 which have the flag must_be_updated_p set have to be updated. Menu
2425 bar lines of a frame are not covered by window matrices, so make
2426 sure not to touch them in this function. */
2429 build_frame_matrix (struct frame
*f
)
2433 /* F must have a frame matrix when this function is called. */
2434 eassert (!FRAME_WINDOW_P (f
));
2436 /* Clear all rows in the frame matrix covered by window matrices.
2437 Menu bar lines are not covered by windows. */
2438 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2439 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2441 /* Build the matrix by walking the window tree. */
2442 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2443 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2447 /* Walk a window tree, building a frame matrix MATRIX from window
2448 matrices. W is the root of a window tree. */
2451 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2455 if (!NILP (w
->hchild
))
2456 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2457 else if (!NILP (w
->vchild
))
2458 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2460 build_frame_matrix_from_leaf_window (matrix
, w
);
2462 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2467 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2468 desired frame matrix built. W is a leaf window whose desired or
2469 current matrix is to be added to FRAME_MATRIX. W's flag
2470 must_be_updated_p determines which matrix it contributes to
2471 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2472 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2473 Adding a desired matrix means setting up used counters and such in
2474 frame rows, while adding a current window matrix to FRAME_MATRIX
2475 means copying glyphs. The latter case corresponds to
2476 preserve_other_columns in the old redisplay. */
2479 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2481 struct glyph_matrix
*window_matrix
;
2482 int window_y
, frame_y
;
2483 /* If non-zero, a glyph to insert at the right border of W. */
2484 GLYPH right_border_glyph
;
2486 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2488 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2489 if (w
->must_be_updated_p
)
2491 window_matrix
= w
->desired_matrix
;
2493 /* Decide whether we want to add a vertical border glyph. */
2494 if (!WINDOW_RIGHTMOST_P (w
))
2496 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2499 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2501 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2503 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2504 spec_glyph_lookup_face (w
, &right_border_glyph
);
2507 if (GLYPH_FACE (right_border_glyph
) <= 0)
2508 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2512 window_matrix
= w
->current_matrix
;
2514 /* For all rows in the window matrix and corresponding rows in the
2517 frame_y
= window_matrix
->matrix_y
;
2518 while (window_y
< window_matrix
->nrows
)
2520 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2521 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2522 int current_row_p
= window_matrix
== w
->current_matrix
;
2524 /* Fill up the frame row with spaces up to the left margin of the
2526 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2528 /* Fill up areas in the window matrix row with spaces. */
2529 fill_up_glyph_row_with_spaces (window_row
);
2531 /* If only part of W's desired matrix has been built, and
2532 window_row wasn't displayed, use the corresponding current
2534 if (window_matrix
== w
->desired_matrix
2535 && !window_row
->enabled_p
)
2537 window_row
= w
->current_matrix
->rows
+ window_y
;
2543 /* Copy window row to frame row. */
2544 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2545 window_row
->glyphs
[0],
2546 window_matrix
->matrix_w
* sizeof (struct glyph
));
2550 eassert (window_row
->enabled_p
);
2552 /* Only when a desired row has been displayed, we want
2553 the corresponding frame row to be updated. */
2554 frame_row
->enabled_p
= 1;
2556 /* Maybe insert a vertical border between horizontally adjacent
2558 if (GLYPH_CHAR (right_border_glyph
) != 0)
2560 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2561 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2565 /* Window row window_y must be a slice of frame row
2567 eassert (glyph_row_slice_p (window_row
, frame_row
));
2569 /* If rows are in sync, we don't have to copy glyphs because
2570 frame and window share glyphs. */
2572 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2573 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2577 /* Set number of used glyphs in the frame matrix. Since we fill
2578 up with spaces, and visit leaf windows from left to right it
2579 can be done simply. */
2580 frame_row
->used
[TEXT_AREA
]
2581 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2589 /* Given a user-specified glyph, possibly including a Lisp-level face
2590 ID, return a glyph that has a realized face ID.
2591 This is used for glyphs displayed specially and not part of the text;
2592 for instance, vertical separators, truncation markers, etc. */
2595 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2597 int lface_id
= GLYPH_FACE (*glyph
);
2598 /* Convert the glyph's specified face to a realized (cache) face. */
2601 int face_id
= merge_faces (XFRAME (w
->frame
),
2602 Qt
, lface_id
, DEFAULT_FACE_ID
);
2603 SET_GLYPH_FACE (*glyph
, face_id
);
2607 /* Add spaces to a glyph row ROW in a window matrix.
2609 Each row has the form:
2611 +---------+-----------------------------+------------+
2612 | left | text | right |
2613 +---------+-----------------------------+------------+
2615 Left and right marginal areas are optional. This function adds
2616 spaces to areas so that there are no empty holes between areas.
2617 In other words: If the right area is not empty, the text area
2618 is filled up with spaces up to the right area. If the text area
2619 is not empty, the left area is filled up.
2621 To be called for frame-based redisplay, only. */
2624 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2626 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2627 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2628 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2632 /* Fill area AREA of glyph row ROW with spaces. To be called for
2633 frame-based redisplay only. */
2636 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2638 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2640 struct glyph
*end
= row
->glyphs
[area
+ 1];
2641 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2644 *text
++ = space_glyph
;
2645 row
->used
[area
] = text
- row
->glyphs
[area
];
2650 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2651 reached. In frame matrices only one area, TEXT_AREA, is used. */
2654 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2656 int i
= row
->used
[TEXT_AREA
];
2657 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2660 glyph
[i
++] = space_glyph
;
2662 row
->used
[TEXT_AREA
] = i
;
2667 /**********************************************************************
2668 Mirroring operations on frame matrices in window matrices
2669 **********************************************************************/
2671 /* Set frame being updated via frame-based redisplay to F. This
2672 function must be called before updates to make explicit that we are
2673 working on frame matrices or not. */
2676 set_frame_matrix_frame (struct frame
*f
)
2678 frame_matrix_frame
= f
;
2682 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2683 DESIRED_MATRIX is the desired matrix corresponding to
2684 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2685 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2686 frame_matrix_frame is non-null, this indicates that the exchange is
2687 done in frame matrices, and that we have to perform analogous
2688 operations in window matrices of frame_matrix_frame. */
2691 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2693 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2694 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2695 int mouse_face_p
= current_row
->mouse_face_p
;
2697 /* Do current_row = desired_row. This exchanges glyph pointers
2698 between both rows, and does a structure assignment otherwise. */
2699 assign_row (current_row
, desired_row
);
2701 /* Enable current_row to mark it as valid. */
2702 current_row
->enabled_p
= 1;
2703 current_row
->mouse_face_p
= mouse_face_p
;
2705 /* If we are called on frame matrices, perform analogous operations
2706 for window matrices. */
2707 if (frame_matrix_frame
)
2708 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2712 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2713 W's frame which has been made current (by swapping pointers between
2714 current and desired matrix). Perform analogous operations in the
2715 matrices of leaf windows in the window tree rooted at W. */
2718 mirror_make_current (struct window
*w
, int frame_row
)
2722 if (!NILP (w
->hchild
))
2723 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2724 else if (!NILP (w
->vchild
))
2725 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2728 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2729 here because the checks performed in debug mode there
2730 will not allow the conversion. */
2731 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2733 /* If FRAME_ROW is within W, assign the desired row to the
2734 current row (exchanging glyph pointers). */
2735 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2737 struct glyph_row
*current_row
2738 = MATRIX_ROW (w
->current_matrix
, row
);
2739 struct glyph_row
*desired_row
2740 = MATRIX_ROW (w
->desired_matrix
, row
);
2742 if (desired_row
->enabled_p
)
2743 assign_row (current_row
, desired_row
);
2745 swap_glyph_pointers (desired_row
, current_row
);
2746 current_row
->enabled_p
= 1;
2748 /* Set the Y coordinate of the mode/header line's row.
2749 It is needed in draw_row_with_mouse_face to find the
2750 screen coordinates. (Window-based redisplay sets
2751 this in update_window, but no one seems to do that
2752 for frame-based redisplay.) */
2753 if (current_row
->mode_line_p
)
2754 current_row
->y
= row
;
2758 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2763 /* Perform row dance after scrolling. We are working on the range of
2764 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2765 including) in MATRIX. COPY_FROM is a vector containing, for each
2766 row I in the range 0 <= I < NLINES, the index of the original line
2767 to move to I. This index is relative to the row range, i.e. 0 <=
2768 index < NLINES. RETAINED_P is a vector containing zero for each
2769 row 0 <= I < NLINES which is empty.
2771 This function is called from do_scrolling and do_direct_scrolling. */
2774 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2775 int *copy_from
, char *retained_p
)
2777 /* A copy of original rows. */
2778 struct glyph_row
*old_rows
;
2780 /* Rows to assign to. */
2781 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2785 /* Make a copy of the original rows. */
2786 old_rows
= alloca (nlines
* sizeof *old_rows
);
2787 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2789 /* Assign new rows, maybe clear lines. */
2790 for (i
= 0; i
< nlines
; ++i
)
2792 int enabled_before_p
= new_rows
[i
].enabled_p
;
2794 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2795 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2796 new_rows
[i
] = old_rows
[copy_from
[i
]];
2797 new_rows
[i
].enabled_p
= enabled_before_p
;
2799 /* RETAINED_P is zero for empty lines. */
2800 if (!retained_p
[copy_from
[i
]])
2801 new_rows
[i
].enabled_p
= 0;
2804 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2805 if (frame_matrix_frame
)
2806 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2807 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2811 /* Synchronize glyph pointers in the current matrix of window W with
2812 the current frame matrix. */
2815 sync_window_with_frame_matrix_rows (struct window
*w
)
2817 struct frame
*f
= XFRAME (w
->frame
);
2818 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2819 int left
, right
, x
, width
;
2821 /* Preconditions: W must be a leaf window on a tty frame. */
2822 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2823 eassert (!FRAME_WINDOW_P (f
));
2825 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2826 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2827 x
= w
->current_matrix
->matrix_x
;
2828 width
= w
->current_matrix
->matrix_w
;
2830 window_row
= w
->current_matrix
->rows
;
2831 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2832 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2834 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2836 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2837 = frame_row
->glyphs
[0] + x
;
2838 window_row
->glyphs
[TEXT_AREA
]
2839 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2840 window_row
->glyphs
[LAST_AREA
]
2841 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2842 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2843 = window_row
->glyphs
[LAST_AREA
] - right
;
2848 /* Return the window in the window tree rooted in W containing frame
2849 row ROW. Value is null if none is found. */
2851 static struct window
*
2852 frame_row_to_window (struct window
*w
, int row
)
2854 struct window
*found
= NULL
;
2858 if (!NILP (w
->hchild
))
2859 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2860 else if (!NILP (w
->vchild
))
2861 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2862 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2863 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2866 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2873 /* Perform a line dance in the window tree rooted at W, after
2874 scrolling a frame matrix in mirrored_line_dance.
2876 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2877 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2878 COPY_FROM is a vector containing, for each row I in the range 0 <=
2879 I < NLINES, the index of the original line to move to I. This
2880 index is relative to the row range, i.e. 0 <= index < NLINES.
2881 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2885 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2889 if (!NILP (w
->hchild
))
2890 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2891 nlines
, copy_from
, retained_p
);
2892 else if (!NILP (w
->vchild
))
2893 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2894 nlines
, copy_from
, retained_p
);
2897 /* W is a leaf window, and we are working on its current
2899 struct glyph_matrix
*m
= w
->current_matrix
;
2901 struct glyph_row
*old_rows
;
2903 /* Make a copy of the original rows of matrix m. */
2904 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2905 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2907 for (i
= 0; i
< nlines
; ++i
)
2909 /* Frame relative line assigned to. */
2910 int frame_to
= i
+ unchanged_at_top
;
2912 /* Frame relative line assigned. */
2913 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2915 /* Window relative line assigned to. */
2916 int window_to
= frame_to
- m
->matrix_y
;
2918 /* Window relative line assigned. */
2919 int window_from
= frame_from
- m
->matrix_y
;
2921 /* Is assigned line inside window? */
2922 int from_inside_window_p
2923 = window_from
>= 0 && window_from
< m
->matrix_h
;
2925 /* Is assigned to line inside window? */
2926 int to_inside_window_p
2927 = window_to
>= 0 && window_to
< m
->matrix_h
;
2929 if (from_inside_window_p
&& to_inside_window_p
)
2931 /* Enabled setting before assignment. */
2932 int enabled_before_p
;
2934 /* Do the assignment. The enabled_p flag is saved
2935 over the assignment because the old redisplay did
2937 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2938 m
->rows
[window_to
] = old_rows
[window_from
];
2939 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2941 /* If frame line is empty, window line is empty, too. */
2942 if (!retained_p
[copy_from
[i
]])
2943 m
->rows
[window_to
].enabled_p
= 0;
2945 else if (to_inside_window_p
)
2947 /* A copy between windows. This is an infrequent
2948 case not worth optimizing. */
2949 struct frame
*f
= XFRAME (w
->frame
);
2950 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2952 struct glyph_matrix
*m2
;
2955 w2
= frame_row_to_window (root
, frame_from
);
2956 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2957 -nw', FROM_FRAME sometimes has no associated window.
2958 This check avoids a segfault if W2 is null. */
2961 m2
= w2
->current_matrix
;
2962 m2_from
= frame_from
- m2
->matrix_y
;
2963 copy_row_except_pointers (m
->rows
+ window_to
,
2964 m2
->rows
+ m2_from
);
2966 /* If frame line is empty, window line is empty, too. */
2967 if (!retained_p
[copy_from
[i
]])
2968 m
->rows
[window_to
].enabled_p
= 0;
2972 else if (from_inside_window_p
)
2976 /* If there was a copy between windows, make sure glyph
2977 pointers are in sync with the frame matrix. */
2979 sync_window_with_frame_matrix_rows (w
);
2981 /* Check that no pointers are lost. */
2985 /* Next window on same level. */
2986 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2993 /* Check that window and frame matrices agree about their
2994 understanding where glyphs of the rows are to find. For each
2995 window in the window tree rooted at W, check that rows in the
2996 matrices of leaf window agree with their frame matrices about
3000 check_window_matrix_pointers (struct window
*w
)
3004 if (!NILP (w
->hchild
))
3005 check_window_matrix_pointers (XWINDOW (w
->hchild
));
3006 else if (!NILP (w
->vchild
))
3007 check_window_matrix_pointers (XWINDOW (w
->vchild
));
3010 struct frame
*f
= XFRAME (w
->frame
);
3011 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3012 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3015 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3020 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3021 a window and FRAME_MATRIX is the corresponding frame matrix. For
3022 each row in WINDOW_MATRIX check that it's a slice of the
3023 corresponding frame row. If it isn't, abort. */
3026 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3027 struct glyph_matrix
*frame_matrix
)
3029 /* Row number in WINDOW_MATRIX. */
3032 /* Row number corresponding to I in FRAME_MATRIX. */
3033 int j
= window_matrix
->matrix_y
;
3035 /* For all rows check that the row in the window matrix is a
3036 slice of the row in the frame matrix. If it isn't we didn't
3037 mirror an operation on the frame matrix correctly. */
3038 while (i
< window_matrix
->nrows
)
3040 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3041 frame_matrix
->rows
+ j
))
3047 #endif /* GLYPH_DEBUG */
3051 /**********************************************************************
3052 VPOS and HPOS translations
3053 **********************************************************************/
3057 /* Translate vertical position VPOS which is relative to window W to a
3058 vertical position relative to W's frame. */
3061 window_to_frame_vpos (struct window
*w
, int vpos
)
3063 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3064 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3065 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3066 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3071 /* Translate horizontal position HPOS which is relative to window W to
3072 a horizontal position relative to W's frame. */
3075 window_to_frame_hpos (struct window
*w
, int hpos
)
3077 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3078 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3082 #endif /* GLYPH_DEBUG */
3086 /**********************************************************************
3088 **********************************************************************/
3090 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3091 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3096 CHECK_LIVE_FRAME (frame
);
3099 /* Ignore redraw requests, if frame has no glyphs yet.
3100 (Implementation note: It still has to be checked why we are
3101 called so early here). */
3102 if (!glyphs_initialized_initially_p
)
3107 if (FRAME_MSDOS_P (f
))
3108 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3111 clear_current_matrices (f
);
3113 if (FRAME_TERMCAP_P (f
))
3114 fflush (FRAME_TTY (f
)->output
);
3115 windows_or_buffers_changed
++;
3116 /* Mark all windows as inaccurate, so that every window will have
3117 its redisplay done. */
3118 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3119 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3125 /* Redraw frame F. This is nothing more than a call to the Lisp
3126 function redraw-frame. */
3129 redraw_frame (struct frame
*f
)
3132 XSETFRAME (frame
, f
);
3133 Fredraw_frame (frame
);
3137 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3138 doc
: /* Clear and redisplay all visible frames. */)
3141 Lisp_Object tail
, frame
;
3143 FOR_EACH_FRAME (tail
, frame
)
3144 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3145 Fredraw_frame (frame
);
3152 /***********************************************************************
3154 ***********************************************************************/
3156 /* Update frame F based on the data in desired matrices.
3158 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3159 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3162 Value is non-zero if redisplay was stopped due to pending input. */
3165 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3167 /* 1 means display has been paused because of pending input. */
3169 struct window
*root_window
= XWINDOW (f
->root_window
);
3171 if (redisplay_dont_pause
)
3173 else if (NILP (Vredisplay_preemption_period
))
3175 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3177 double p
= XFLOATINT (Vredisplay_preemption_period
);
3179 if (detect_input_pending_ignore_squeezables ())
3185 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3186 preemption_next_check
= add_emacs_time (current_emacs_time (),
3190 if (FRAME_WINDOW_P (f
))
3192 /* We are working on window matrix basis. All windows whose
3193 flag must_be_updated_p is set have to be updated. */
3195 /* Record that we are not working on frame matrices. */
3196 set_frame_matrix_frame (NULL
);
3198 /* Update all windows in the window tree of F, maybe stopping
3199 when pending input is detected. */
3202 /* Update the menu bar on X frames that don't have toolkit
3204 if (WINDOWP (f
->menu_bar_window
))
3205 update_window (XWINDOW (f
->menu_bar_window
), 1);
3207 /* Update the tool-bar window, if present. */
3208 if (WINDOWP (f
->tool_bar_window
))
3210 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3212 /* Update tool-bar window. */
3213 if (w
->must_be_updated_p
)
3217 update_window (w
, 1);
3218 w
->must_be_updated_p
= 0;
3220 /* Swap tool-bar strings. We swap because we want to
3222 tem
= f
->current_tool_bar_string
;
3223 FSET (f
, current_tool_bar_string
, f
->desired_tool_bar_string
);
3224 FSET (f
, desired_tool_bar_string
, tem
);
3229 /* Update windows. */
3230 paused_p
= update_window_tree (root_window
, force_p
);
3233 /* This flush is a performance bottleneck under X,
3234 and it doesn't seem to be necessary anyway (in general).
3235 It is necessary when resizing the window with the mouse, or
3236 at least the fringes are not redrawn in a timely manner. ++kfs */
3237 if (f
->force_flush_display_p
)
3239 FRAME_RIF (f
)->flush_display (f
);
3240 f
->force_flush_display_p
= 0;
3245 /* We are working on frame matrix basis. Set the frame on whose
3246 frame matrix we operate. */
3247 set_frame_matrix_frame (f
);
3249 /* Build F's desired matrix from window matrices. */
3250 build_frame_matrix (f
);
3252 /* Update the display */
3254 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3257 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3259 if (FRAME_TTY (f
)->termscript
)
3260 fflush (FRAME_TTY (f
)->termscript
);
3261 if (FRAME_TERMCAP_P (f
))
3262 fflush (FRAME_TTY (f
)->output
);
3265 /* Check window matrices for lost pointers. */
3267 check_window_matrix_pointers (root_window
);
3268 add_frame_display_history (f
, paused_p
);
3273 /* Reset flags indicating that a window should be updated. */
3274 set_window_update_flags (root_window
, 0);
3276 display_completed
= !paused_p
;
3282 /************************************************************************
3283 Window-based updates
3284 ************************************************************************/
3286 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3287 don't stop updating when input is pending. */
3290 update_window_tree (struct window
*w
, int force_p
)
3294 while (w
&& !paused_p
)
3296 if (!NILP (w
->hchild
))
3297 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3298 else if (!NILP (w
->vchild
))
3299 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3300 else if (w
->must_be_updated_p
)
3301 paused_p
|= update_window (w
, force_p
);
3303 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3310 /* Update window W if its flag must_be_updated_p is non-zero. If
3311 FORCE_P is non-zero, don't stop updating if input is pending. */
3314 update_single_window (struct window
*w
, int force_p
)
3316 if (w
->must_be_updated_p
)
3318 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3320 /* Record that this is not a frame-based redisplay. */
3321 set_frame_matrix_frame (NULL
);
3323 if (redisplay_dont_pause
)
3325 else if (NILP (Vredisplay_preemption_period
))
3327 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3329 double p
= XFLOATINT (Vredisplay_preemption_period
);
3330 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3331 preemption_next_check
= add_emacs_time (current_emacs_time (),
3337 update_window (w
, force_p
);
3340 /* Reset flag in W. */
3341 w
->must_be_updated_p
= 0;
3345 #ifdef HAVE_WINDOW_SYSTEM
3347 /* Redraw lines from the current matrix of window W that are
3348 overlapped by other rows. YB is bottom-most y-position in W. */
3351 redraw_overlapped_rows (struct window
*w
, int yb
)
3354 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3356 /* If rows overlapping others have been changed, the rows being
3357 overlapped have to be redrawn. This won't draw lines that have
3358 already been drawn in update_window_line because overlapped_p in
3359 desired rows is 0, so after row assignment overlapped_p in
3360 current rows is 0. */
3361 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3363 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3365 if (!row
->enabled_p
)
3367 else if (row
->mode_line_p
)
3370 if (row
->overlapped_p
)
3372 enum glyph_row_area area
;
3374 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3377 updated_area
= area
;
3378 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3379 area
== TEXT_AREA
? row
->x
: 0);
3380 if (row
->used
[area
])
3381 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3383 FRAME_RIF (f
)->clear_end_of_line (-1);
3386 row
->overlapped_p
= 0;
3389 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3395 /* Redraw lines from the current matrix of window W that overlap
3396 others. YB is bottom-most y-position in W. */
3399 redraw_overlapping_rows (struct window
*w
, int yb
)
3402 struct glyph_row
*row
;
3403 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3405 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3407 row
= w
->current_matrix
->rows
+ i
;
3409 if (!row
->enabled_p
)
3411 else if (row
->mode_line_p
)
3414 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3416 if (row
->overlapping_p
)
3420 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3421 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3422 overlaps
|= OVERLAPS_PRED
;
3423 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3424 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3425 overlaps
|= OVERLAPS_SUCC
;
3429 if (row
->used
[LEFT_MARGIN_AREA
])
3430 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3432 if (row
->used
[TEXT_AREA
])
3433 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3435 if (row
->used
[RIGHT_MARGIN_AREA
])
3436 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3438 /* Record in neighbor rows that ROW overwrites part of
3440 if (overlaps
& OVERLAPS_PRED
)
3441 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3442 if (overlaps
& OVERLAPS_SUCC
)
3443 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3452 #endif /* HAVE_WINDOW_SYSTEM */
3455 #if defined GLYPH_DEBUG && 0
3457 /* Check that no row in the current matrix of window W is enabled
3458 which is below what's displayed in the window. */
3461 check_current_matrix_flags (struct window
*w
)
3463 int last_seen_p
= 0;
3464 int i
, yb
= window_text_bottom_y (w
);
3466 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3468 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3469 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3471 else if (last_seen_p
&& row
->enabled_p
)
3476 #endif /* GLYPH_DEBUG */
3479 /* Update display of window W. FORCE_P non-zero means that we should
3480 not stop when detecting pending input. */
3483 update_window (struct window
*w
, int force_p
)
3485 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3487 #if !PERIODIC_PREEMPTION_CHECKING
3488 int preempt_count
= baud_rate
/ 2400 + 1;
3490 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3492 /* Check that W's frame doesn't have glyph matrices. */
3493 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3496 /* Check pending input the first time so that we can quickly return. */
3497 #if !PERIODIC_PREEMPTION_CHECKING
3499 detect_input_pending_ignore_squeezables ();
3502 /* If forced to complete the update, or if no input is pending, do
3504 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3506 struct glyph_row
*row
, *end
;
3507 struct glyph_row
*mode_line_row
;
3508 struct glyph_row
*header_line_row
;
3509 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3510 #if ! PERIODIC_PREEMPTION_CHECKING
3514 rif
->update_window_begin_hook (w
);
3515 yb
= window_text_bottom_y (w
);
3516 row
= desired_matrix
->rows
;
3517 end
= row
+ desired_matrix
->nrows
- 1;
3519 /* Take note of the header line, if there is one. We will
3520 update it below, after updating all of the window's lines. */
3521 if (row
->mode_line_p
)
3523 header_line_row
= row
;
3527 header_line_row
= NULL
;
3529 /* Update the mode line, if necessary. */
3530 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3531 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3533 mode_line_row
->y
= yb
;
3534 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3536 &mouse_face_overwritten_p
);
3539 /* Find first enabled row. Optimizations in redisplay_internal
3540 may lead to an update with only one row enabled. There may
3541 be also completely empty matrices. */
3542 while (row
< end
&& !row
->enabled_p
)
3545 /* Try reusing part of the display by copying. */
3546 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3548 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3551 /* All rows were found to be equal. */
3557 /* We've scrolled the display. */
3563 /* Update the rest of the lines. */
3564 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3565 /* scrolling_window resets the enabled_p flag of the rows it
3566 reuses from current_matrix. */
3569 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3572 /* We'll have to play a little bit with when to
3573 detect_input_pending. If it's done too often,
3574 scrolling large windows with repeated scroll-up
3575 commands will too quickly pause redisplay. */
3576 #if PERIODIC_PREEMPTION_CHECKING
3579 EMACS_TIME tm
= current_emacs_time ();
3580 if (EMACS_TIME_LT (preemption_next_check
, tm
))
3582 preemption_next_check
= add_emacs_time (tm
,
3584 if (detect_input_pending_ignore_squeezables ())
3589 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3590 detect_input_pending_ignore_squeezables ();
3592 changed_p
|= update_window_line (w
, vpos
,
3593 &mouse_face_overwritten_p
);
3595 /* Mark all rows below the last visible one in the current
3596 matrix as invalid. This is necessary because of
3597 variable line heights. Consider the case of three
3598 successive redisplays, where the first displays 5
3599 lines, the second 3 lines, and the third 5 lines again.
3600 If the second redisplay wouldn't mark rows in the
3601 current matrix invalid, the third redisplay might be
3602 tempted to optimize redisplay based on lines displayed
3603 in the first redisplay. */
3604 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3605 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3606 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3609 /* Was display preempted? */
3610 paused_p
= row
< end
;
3614 /* Update the header line after scrolling because a new header
3615 line would otherwise overwrite lines at the top of the window
3616 that can be scrolled. */
3617 if (header_line_row
&& header_line_row
->enabled_p
)
3619 header_line_row
->y
= 0;
3620 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3623 /* Fix the appearance of overlapping/overlapped rows. */
3624 if (!paused_p
&& !w
->pseudo_window_p
)
3626 #ifdef HAVE_WINDOW_SYSTEM
3627 if (changed_p
&& rif
->fix_overlapping_area
)
3629 redraw_overlapped_rows (w
, yb
);
3630 redraw_overlapping_rows (w
, yb
);
3634 /* Make cursor visible at cursor position of W. */
3635 set_window_cursor_after_update (w
);
3637 #if 0 /* Check that current matrix invariants are satisfied. This is
3638 for debugging only. See the comment of check_matrix_invariants. */
3639 IF_DEBUG (check_matrix_invariants (w
));
3644 /* Remember the redisplay method used to display the matrix. */
3645 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3648 #ifdef HAVE_WINDOW_SYSTEM
3649 update_window_fringes (w
, 0);
3652 /* End the update of window W. Don't set the cursor if we
3653 paused updating the display because in this case,
3654 set_window_cursor_after_update hasn't been called, and
3655 output_cursor doesn't contain the cursor location. */
3656 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3662 /* check_current_matrix_flags (w); */
3663 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3666 clear_glyph_matrix (desired_matrix
);
3672 /* Update the display of area AREA in window W, row number VPOS.
3673 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3676 update_marginal_area (struct window
*w
, int area
, int vpos
)
3678 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3679 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3681 /* Let functions in xterm.c know what area subsequent X positions
3682 will be relative to. */
3683 updated_area
= area
;
3685 /* Set cursor to start of glyphs, write them, and clear to the end
3686 of the area. I don't think that something more sophisticated is
3687 necessary here, since marginal areas will not be the default. */
3688 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3689 if (desired_row
->used
[area
])
3690 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3691 rif
->clear_end_of_line (-1);
3695 /* Update the display of the text area of row VPOS in window W.
3696 Value is non-zero if display has changed. */
3699 update_text_area (struct window
*w
, int vpos
)
3701 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3702 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3703 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3706 /* Let functions in xterm.c know what area subsequent X positions
3707 will be relative to. */
3708 updated_area
= TEXT_AREA
;
3710 /* If rows are at different X or Y, or rows have different height,
3711 or the current row is marked invalid, write the entire line. */
3712 if (!current_row
->enabled_p
3713 || desired_row
->y
!= current_row
->y
3714 || desired_row
->ascent
!= current_row
->ascent
3715 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3716 || desired_row
->phys_height
!= current_row
->phys_height
3717 || desired_row
->visible_height
!= current_row
->visible_height
3718 || current_row
->overlapped_p
3719 /* This next line is necessary for correctly redrawing
3720 mouse-face areas after scrolling and other operations.
3721 However, it causes excessive flickering when mouse is moved
3722 across the mode line. Luckily, turning it off for the mode
3723 line doesn't seem to hurt anything. -- cyd.
3724 But it is still needed for the header line. -- kfs. */
3725 || (current_row
->mouse_face_p
3726 && !(current_row
->mode_line_p
&& vpos
> 0))
3727 || current_row
->x
!= desired_row
->x
)
3729 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3731 if (desired_row
->used
[TEXT_AREA
])
3732 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3733 desired_row
->used
[TEXT_AREA
]);
3735 /* Clear to end of window. */
3736 rif
->clear_end_of_line (-1);
3739 /* This erases the cursor. We do this here because
3740 notice_overwritten_cursor cannot easily check this, which
3741 might indicate that the whole functionality of
3742 notice_overwritten_cursor would better be implemented here.
3743 On the other hand, we need notice_overwritten_cursor as long
3744 as mouse highlighting is done asynchronously outside of
3746 if (vpos
== w
->phys_cursor
.vpos
)
3747 w
->phys_cursor_on_p
= 0;
3752 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3753 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3754 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3755 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3756 int abort_skipping
= 0;
3758 /* If the desired row extends its face to the text area end, and
3759 unless the current row also does so at the same position,
3760 make sure we write at least one glyph, so that the face
3761 extension actually takes place. */
3762 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3763 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3764 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3765 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3768 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3772 /* Loop over glyphs that current and desired row may have
3776 int can_skip_p
= !abort_skipping
;
3778 /* Skip over glyphs that both rows have in common. These
3779 don't have to be written. We can't skip if the last
3780 current glyph overlaps the glyph to its right. For
3781 example, consider a current row of `if ' with the `f' in
3782 Courier bold so that it overlaps the ` ' to its right.
3783 If the desired row is ` ', we would skip over the space
3784 after the `if' and there would remain a pixel from the
3785 `f' on the screen. */
3786 if (overlapping_glyphs_p
&& i
> 0)
3788 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3791 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3793 can_skip_p
= (right
== 0 && !abort_skipping
);
3801 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3803 x
+= desired_glyph
->pixel_width
;
3804 ++desired_glyph
, ++current_glyph
, ++i
;
3807 /* Consider the case that the current row contains "xxx
3808 ppp ggg" in italic Courier font, and the desired row
3809 is "xxx ggg". The character `p' has lbearing, `g'
3810 has not. The loop above will stop in front of the
3811 first `p' in the current row. If we would start
3812 writing glyphs there, we wouldn't erase the lbearing
3813 of the `p'. The rest of the lbearing problem is then
3814 taken care of by draw_glyphs. */
3815 if (overlapping_glyphs_p
3817 && i
< current_row
->used
[TEXT_AREA
]
3818 && (current_row
->used
[TEXT_AREA
]
3819 != desired_row
->used
[TEXT_AREA
]))
3823 rif
->get_glyph_overhangs (current_glyph
,
3826 while (left
> 0 && i
> 0)
3828 --i
, --desired_glyph
, --current_glyph
;
3829 x
-= desired_glyph
->pixel_width
;
3830 left
-= desired_glyph
->pixel_width
;
3833 /* Abort the skipping algorithm if we end up before
3834 our starting point, to avoid looping (bug#1070).
3835 This can happen when the lbearing is larger than
3837 abort_skipping
= (i
< start_hpos
);
3841 /* Try to avoid writing the entire rest of the desired row
3842 by looking for a resync point. This mainly prevents
3843 mode line flickering in the case the mode line is in
3844 fixed-pitch font, which it usually will be. */
3845 if (i
< desired_row
->used
[TEXT_AREA
])
3847 int start_x
= x
, start_hpos
= i
;
3848 struct glyph
*start
= desired_glyph
;
3850 int skip_first_p
= !can_skip_p
;
3852 /* Find the next glyph that's equal again. */
3855 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3858 x
+= desired_glyph
->pixel_width
;
3859 current_x
+= current_glyph
->pixel_width
;
3860 ++desired_glyph
, ++current_glyph
, ++i
;
3864 if (i
== start_hpos
|| x
!= current_x
)
3868 desired_glyph
= start
;
3872 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3873 rif
->write_glyphs (start
, i
- start_hpos
);
3878 /* Write the rest. */
3879 if (i
< desired_row
->used
[TEXT_AREA
])
3881 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3882 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3886 /* Maybe clear to end of line. */
3887 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3889 /* If new row extends to the end of the text area, nothing
3890 has to be cleared, if and only if we did a write_glyphs
3891 above. This is made sure by setting desired_stop_pos
3892 appropriately above. */
3893 eassert (i
< desired_row
->used
[TEXT_AREA
]
3894 || ((desired_row
->used
[TEXT_AREA
]
3895 == current_row
->used
[TEXT_AREA
])
3896 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3898 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3900 /* If old row extends to the end of the text area, clear. */
3901 if (i
>= desired_row
->used
[TEXT_AREA
])
3902 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3903 desired_row
->pixel_width
);
3904 rif
->clear_end_of_line (-1);
3907 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3909 /* Otherwise clear to the end of the old row. Everything
3910 after that position should be clear already. */
3913 if (i
>= desired_row
->used
[TEXT_AREA
])
3914 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3915 desired_row
->pixel_width
);
3917 /* If cursor is displayed at the end of the line, make sure
3918 it's cleared. Nowadays we don't have a phys_cursor_glyph
3919 with which to erase the cursor (because this method
3920 doesn't work with lbearing/rbearing), so we must do it
3922 if (vpos
== w
->phys_cursor
.vpos
3923 && (desired_row
->reversed_p
3924 ? (w
->phys_cursor
.hpos
< 0)
3925 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3927 w
->phys_cursor_on_p
= 0;
3931 xlim
= current_row
->pixel_width
;
3932 rif
->clear_end_of_line (xlim
);
3941 /* Update row VPOS in window W. Value is non-zero if display has been
3945 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
3947 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3948 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3949 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3952 /* Set the row being updated. This is important to let xterm.c
3953 know what line height values are in effect. */
3954 updated_row
= desired_row
;
3956 /* A row can be completely invisible in case a desired matrix was
3957 built with a vscroll and then make_cursor_line_fully_visible shifts
3958 the matrix. Make sure to make such rows current anyway, since
3959 we need the correct y-position, for example, in the current matrix. */
3960 if (desired_row
->mode_line_p
3961 || desired_row
->visible_height
> 0)
3963 eassert (desired_row
->enabled_p
);
3965 /* Update display of the left margin area, if there is one. */
3966 if (!desired_row
->full_width_p
3967 && !NILP (w
->left_margin_cols
))
3970 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
3973 /* Update the display of the text area. */
3974 if (update_text_area (w
, vpos
))
3977 if (current_row
->mouse_face_p
)
3978 *mouse_face_overwritten_p
= 1;
3981 /* Update display of the right margin area, if there is one. */
3982 if (!desired_row
->full_width_p
3983 && !NILP (w
->right_margin_cols
))
3986 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
3989 /* Draw truncation marks etc. */
3990 if (!current_row
->enabled_p
3991 || desired_row
->y
!= current_row
->y
3992 || desired_row
->visible_height
!= current_row
->visible_height
3993 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3994 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3995 || current_row
->redraw_fringe_bitmaps_p
3996 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3997 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3998 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3999 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4000 rif
->after_update_window_line_hook (desired_row
);
4003 /* Update current_row from desired_row. */
4004 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4010 /* Set the cursor after an update of window W. This function may only
4011 be called from update_window. */
4014 set_window_cursor_after_update (struct window
*w
)
4016 struct frame
*f
= XFRAME (w
->frame
);
4017 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4018 int cx
, cy
, vpos
, hpos
;
4020 /* Not intended for frame matrix updates. */
4021 eassert (FRAME_WINDOW_P (f
));
4023 if (cursor_in_echo_area
4024 && !NILP (echo_area_buffer
[0])
4025 /* If we are showing a message instead of the mini-buffer,
4026 show the cursor for the message instead. */
4027 && XWINDOW (minibuf_window
) == w
4028 && EQ (minibuf_window
, echo_area_window
)
4029 /* These cases apply only to the frame that contains
4030 the active mini-buffer window. */
4031 && FRAME_HAS_MINIBUF_P (f
)
4032 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4034 cx
= cy
= vpos
= hpos
= 0;
4036 if (cursor_in_echo_area
>= 0)
4038 /* If the mini-buffer is several lines high, find the last
4039 line that has any text on it. Note: either all lines
4040 are enabled or none. Otherwise we wouldn't be able to
4042 struct glyph_row
*row
, *last_row
;
4043 struct glyph
*glyph
;
4044 int yb
= window_text_bottom_y (w
);
4047 row
= w
->current_matrix
->rows
;
4048 while (row
->enabled_p
4049 && (last_row
== NULL
4050 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4052 if (row
->used
[TEXT_AREA
]
4053 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4060 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4061 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4063 while (last
> start
&& last
->charpos
< 0)
4066 for (glyph
= start
; glyph
< last
; ++glyph
)
4068 cx
+= glyph
->pixel_width
;
4073 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4081 hpos
= w
->cursor
.hpos
;
4082 vpos
= w
->cursor
.vpos
;
4085 /* Window cursor can be out of sync for horizontally split windows. */
4086 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4087 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4088 vpos
= max (0, vpos
);
4089 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4090 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4094 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4095 tree rooted at W. */
4098 set_window_update_flags (struct window
*w
, int on_p
)
4102 if (!NILP (w
->hchild
))
4103 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4104 else if (!NILP (w
->vchild
))
4105 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4107 w
->must_be_updated_p
= on_p
;
4109 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4115 /***********************************************************************
4116 Window-Based Scrolling
4117 ***********************************************************************/
4119 /* Structure describing rows in scrolling_window. */
4123 /* Number of occurrences of this row in desired and current matrix. */
4124 int old_uses
, new_uses
;
4126 /* Vpos of row in new matrix. */
4127 int new_line_number
;
4129 /* Bucket index of this row_entry in the hash table row_table. */
4132 /* The row described by this entry. */
4133 struct glyph_row
*row
;
4135 /* Hash collision chain. */
4136 struct row_entry
*next
;
4139 /* A pool to allocate row_entry structures from, and the size of the
4140 pool. The pool is reallocated in scrolling_window when we find
4141 that we need a larger one. */
4143 static struct row_entry
*row_entry_pool
;
4144 static ptrdiff_t row_entry_pool_size
;
4146 /* Index of next free entry in row_entry_pool. */
4148 static ptrdiff_t row_entry_idx
;
4150 /* The hash table used during scrolling, and the table's size. This
4151 table is used to quickly identify equal rows in the desired and
4154 static struct row_entry
**row_table
;
4155 static ptrdiff_t row_table_size
;
4157 /* Vectors of pointers to row_entry structures belonging to the
4158 current and desired matrix, and the size of the vectors. */
4160 static struct row_entry
**old_lines
, **new_lines
;
4161 static ptrdiff_t old_lines_size
, new_lines_size
;
4163 /* A pool to allocate run structures from, and its size. */
4165 static struct run
*run_pool
;
4166 static ptrdiff_t runs_size
;
4168 /* A vector of runs of lines found during scrolling. */
4170 static struct run
**runs
;
4172 /* Add glyph row ROW to the scrolling hash table. */
4174 static inline struct row_entry
*
4175 add_row_entry (struct glyph_row
*row
)
4177 struct row_entry
*entry
;
4178 ptrdiff_t i
= row
->hash
% row_table_size
;
4180 entry
= row_table
[i
];
4181 eassert (entry
|| verify_row_hash (row
));
4182 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4183 entry
= entry
->next
;
4187 entry
= row_entry_pool
+ row_entry_idx
++;
4189 entry
->old_uses
= entry
->new_uses
= 0;
4190 entry
->new_line_number
= 0;
4192 entry
->next
= row_table
[i
];
4193 row_table
[i
] = entry
;
4200 /* Try to reuse part of the current display of W by scrolling lines.
4201 HEADER_LINE_P non-zero means W has a header line.
4203 The algorithm is taken from Communications of the ACM, Apr78 "A
4204 Technique for Isolating Differences Between Files." It should take
4207 A short outline of the steps of the algorithm
4209 1. Skip lines equal at the start and end of both matrices.
4211 2. Enter rows in the current and desired matrix into a symbol
4212 table, counting how often they appear in both matrices.
4214 3. Rows that appear exactly once in both matrices serve as anchors,
4215 i.e. we assume that such lines are likely to have been moved.
4217 4. Starting from anchor lines, extend regions to be scrolled both
4218 forward and backward.
4222 -1 if all rows were found to be equal.
4223 0 to indicate that we did not scroll the display, or
4224 1 if we did scroll. */
4227 scrolling_window (struct window
*w
, int header_line_p
)
4229 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4230 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4231 int yb
= window_text_bottom_y (w
);
4233 int j
, first_old
, first_new
, last_old
, last_new
;
4236 struct row_entry
*entry
;
4237 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4239 /* Skip over rows equal at the start. */
4240 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4242 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4243 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4247 && !d
->redraw_fringe_bitmaps_p
4249 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4250 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4251 && row_equal_p (c
, d
, 1))
4260 /* Give up if some rows in the desired matrix are not enabled. */
4261 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4264 first_old
= first_new
= i
;
4266 /* Set last_new to the index + 1 of the row that reaches the
4267 bottom boundary in the desired matrix. Give up if we find a
4268 disabled row before we reach the bottom boundary. */
4270 while (i
< desired_matrix
->nrows
- 1)
4274 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4276 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4285 /* Set last_old to the index + 1 of the row that reaches the bottom
4286 boundary in the current matrix. We don't look at the enabled
4287 flag here because we plan to reuse part of the display even if
4288 other parts are disabled. */
4290 while (i
< current_matrix
->nrows
- 1)
4292 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4301 /* Skip over rows equal at the bottom. */
4304 while (i
- 1 > first_new
4305 && j
- 1 > first_old
4306 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4307 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4308 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4309 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4310 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4311 MATRIX_ROW (current_matrix
, j
- 1), 1))
4316 /* Nothing to do if all rows are equal. */
4317 if (last_new
== first_new
)
4320 /* Check for integer overflow in size calculation.
4322 If next_almost_prime checks (N) for divisibility by 2..10, then
4323 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4324 So, set next_almost_prime_increment_max to 10.
4326 It's just a coincidence that next_almost_prime_increment_max ==
4327 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4328 13, then next_almost_prime_increment_max would be 14, e.g.,
4329 because next_almost_prime (113) would be 127. */
4331 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4332 enum { next_almost_prime_increment_max
= 10 };
4333 ptrdiff_t row_table_max
=
4334 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4335 - next_almost_prime_increment_max
);
4336 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4337 if (current_nrows_max
< current_matrix
->nrows
)
4338 memory_full (SIZE_MAX
);
4341 /* Reallocate vectors, tables etc. if necessary. */
4343 if (current_matrix
->nrows
> old_lines_size
)
4344 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4345 current_matrix
->nrows
- old_lines_size
,
4346 INT_MAX
, sizeof *old_lines
);
4348 if (desired_matrix
->nrows
> new_lines_size
)
4349 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4350 desired_matrix
->nrows
- new_lines_size
,
4351 INT_MAX
, sizeof *new_lines
);
4353 n
= desired_matrix
->nrows
;
4354 n
+= current_matrix
->nrows
;
4355 if (row_table_size
< 3 * n
)
4357 ptrdiff_t size
= next_almost_prime (3 * n
);
4358 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4359 row_table_size
= size
;
4360 memset (row_table
, 0, size
* sizeof *row_table
);
4363 if (n
> row_entry_pool_size
)
4364 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4365 n
- row_entry_pool_size
,
4366 -1, sizeof *row_entry_pool
);
4368 if (desired_matrix
->nrows
> runs_size
)
4370 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4371 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4372 runs_size
= desired_matrix
->nrows
;
4375 nruns
= run_idx
= 0;
4378 /* Add rows from the current and desired matrix to the hash table
4379 row_hash_table to be able to find equal ones quickly. */
4381 for (i
= first_old
; i
< last_old
; ++i
)
4383 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4385 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4386 old_lines
[i
] = entry
;
4390 old_lines
[i
] = NULL
;
4393 for (i
= first_new
; i
< last_new
; ++i
)
4395 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4396 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4398 entry
->new_line_number
= i
;
4399 new_lines
[i
] = entry
;
4402 /* Identify moves based on lines that are unique and equal
4403 in both matrices. */
4404 for (i
= first_old
; i
< last_old
;)
4406 && old_lines
[i
]->old_uses
== 1
4407 && old_lines
[i
]->new_uses
== 1)
4410 int new_line
= old_lines
[i
]->new_line_number
;
4411 struct run
*run
= run_pool
+ run_idx
++;
4414 run
->current_vpos
= i
;
4415 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4416 run
->desired_vpos
= new_line
;
4417 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4419 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4421 /* Extend backward. */
4424 while (p
> first_old
4426 && old_lines
[p
] == new_lines
[q
])
4428 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4429 --run
->current_vpos
;
4430 --run
->desired_vpos
;
4433 run
->desired_y
-= h
;
4434 run
->current_y
-= h
;
4438 /* Extend forward. */
4443 && old_lines
[p
] == new_lines
[q
])
4445 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4451 /* Insert run into list of all runs. Order runs by copied
4452 pixel lines. Note that we record runs that don't have to
4453 be copied because they are already in place. This is done
4454 because we can avoid calling update_window_line in this
4456 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4458 for (q
= nruns
; q
> p
; --q
)
4459 runs
[q
] = runs
[q
- 1];
4468 /* Do the moves. Do it in a way that we don't overwrite something
4469 we want to copy later on. This is not solvable in general
4470 because there is only one display and we don't have a way to
4471 exchange areas on this display. Example:
4473 +-----------+ +-----------+
4475 +-----------+ --> +-----------+
4477 +-----------+ +-----------+
4479 Instead, prefer bigger moves, and invalidate moves that would
4480 copy from where we copied to. */
4482 for (i
= 0; i
< nruns
; ++i
)
4483 if (runs
[i
]->nrows
> 0)
4485 struct run
*r
= runs
[i
];
4487 /* Copy on the display. */
4488 if (r
->current_y
!= r
->desired_y
)
4490 rif
->clear_window_mouse_face (w
);
4491 rif
->scroll_run_hook (w
, r
);
4494 /* Truncate runs that copy to where we copied to, and
4495 invalidate runs that copy from where we copied to. */
4496 for (j
= nruns
- 1; j
> i
; --j
)
4498 struct run
*p
= runs
[j
];
4499 int truncated_p
= 0;
4502 && p
->desired_y
< r
->desired_y
+ r
->height
4503 && p
->desired_y
+ p
->height
> r
->desired_y
)
4505 if (p
->desired_y
< r
->desired_y
)
4507 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4508 p
->height
= r
->desired_y
- p
->desired_y
;
4513 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4516 if (p
->nrows
<= nrows_copied
)
4520 int height_copied
= (r
->desired_y
+ r
->height
4523 p
->current_vpos
+= nrows_copied
;
4524 p
->desired_vpos
+= nrows_copied
;
4525 p
->nrows
-= nrows_copied
;
4526 p
->current_y
+= height_copied
;
4527 p
->desired_y
+= height_copied
;
4528 p
->height
-= height_copied
;
4534 if (r
->current_y
!= r
->desired_y
4535 /* The condition below is equivalent to
4536 ((p->current_y >= r->desired_y
4537 && p->current_y < r->desired_y + r->height)
4538 || (p->current_y + p->height > r->desired_y
4539 && (p->current_y + p->height
4540 <= r->desired_y + r->height)))
4541 because we have 0 < p->height <= r->height. */
4542 && p
->current_y
< r
->desired_y
+ r
->height
4543 && p
->current_y
+ p
->height
> r
->desired_y
)
4546 /* Reorder runs by copied pixel lines if truncated. */
4547 if (truncated_p
&& p
->nrows
> 0)
4551 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4553 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4558 /* Assign matrix rows. */
4559 for (j
= 0; j
< r
->nrows
; ++j
)
4561 struct glyph_row
*from
, *to
;
4562 int to_overlapped_p
;
4564 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4565 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4566 to_overlapped_p
= to
->overlapped_p
;
4567 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4568 assign_row (to
, from
);
4569 /* The above `assign_row' actually does swap, so if we had
4570 an overlap in the copy destination of two runs, then
4571 the second run would assign a previously disabled bogus
4572 row. But thanks to the truncation code in the
4573 preceding for-loop, we no longer have such an overlap,
4574 and thus the assigned row should always be enabled. */
4575 eassert (to
->enabled_p
);
4576 from
->enabled_p
= 0;
4577 to
->overlapped_p
= to_overlapped_p
;
4581 /* Clear the hash table, for the next time. */
4582 for (i
= 0; i
< row_entry_idx
; ++i
)
4583 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4585 /* Value is 1 to indicate that we scrolled the display. */
4591 /************************************************************************
4593 ************************************************************************/
4595 /* Update the desired frame matrix of frame F.
4597 FORCE_P non-zero means that the update should not be stopped by
4598 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4599 should not be tried.
4601 Value is non-zero if update was stopped due to pending input. */
4604 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4606 /* Frame matrices to work on. */
4607 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4608 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4611 int preempt_count
= baud_rate
/ 2400 + 1;
4613 eassert (current_matrix
&& desired_matrix
);
4615 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4616 calculate_costs (f
);
4618 if (preempt_count
<= 0)
4621 #if !PERIODIC_PREEMPTION_CHECKING
4622 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4629 /* If we cannot insert/delete lines, it's no use trying it. */
4630 if (!FRAME_LINE_INS_DEL_OK (f
))
4633 /* See if any of the desired lines are enabled; don't compute for
4634 i/d line if just want cursor motion. */
4635 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4636 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4639 /* Try doing i/d line, if not yet inhibited. */
4640 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4641 force_p
|= scrolling (f
);
4643 /* Update the individual lines as needed. Do bottom line first. */
4644 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4645 update_frame_line (f
, desired_matrix
->nrows
- 1);
4647 /* Now update the rest of the lines. */
4648 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4650 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4652 if (FRAME_TERMCAP_P (f
))
4654 /* Flush out every so many lines.
4655 Also flush out if likely to have more than 1k buffered
4656 otherwise. I'm told that some telnet connections get
4657 really screwed by more than 1k output at once. */
4658 FILE *display_output
= FRAME_TTY (f
)->output
;
4661 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4663 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4665 fflush (display_output
);
4666 if (preempt_count
== 1)
4668 #ifdef EMACS_OUTQSIZE
4669 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4670 /* Probably not a tty. Ignore the error and reset
4672 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4675 if (baud_rate
<= outq
&& baud_rate
> 0)
4676 sleep (outq
/ baud_rate
);
4682 #if PERIODIC_PREEMPTION_CHECKING
4685 EMACS_TIME tm
= current_emacs_time ();
4686 if (EMACS_TIME_LT (preemption_next_check
, tm
))
4688 preemption_next_check
= add_emacs_time (tm
, preemption_period
);
4689 if (detect_input_pending_ignore_squeezables ())
4694 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4695 detect_input_pending_ignore_squeezables ();
4698 update_frame_line (f
, i
);
4702 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4704 /* Now just clean up termcap drivers and set cursor, etc. */
4707 if ((cursor_in_echo_area
4708 /* If we are showing a message instead of the mini-buffer,
4709 show the cursor for the message instead of for the
4710 (now hidden) mini-buffer contents. */
4711 || (EQ (minibuf_window
, selected_window
)
4712 && EQ (minibuf_window
, echo_area_window
)
4713 && !NILP (echo_area_buffer
[0])))
4714 /* These cases apply only to the frame that contains
4715 the active mini-buffer window. */
4716 && FRAME_HAS_MINIBUF_P (f
)
4717 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4719 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4722 if (cursor_in_echo_area
< 0)
4724 /* Negative value of cursor_in_echo_area means put
4725 cursor at beginning of line. */
4731 /* Positive value of cursor_in_echo_area means put
4732 cursor at the end of the prompt. If the mini-buffer
4733 is several lines high, find the last line that has
4735 row
= FRAME_LINES (f
);
4741 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4743 /* Frame rows are filled up with spaces that
4744 must be ignored here. */
4745 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4747 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4748 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4751 && (last
- 1)->charpos
< 0)
4757 while (row
> top
&& col
== 0);
4759 /* Make sure COL is not out of range. */
4760 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4762 /* If we have another row, advance cursor into it. */
4763 if (row
< FRAME_LINES (f
) - 1)
4765 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4768 /* Otherwise move it back in range. */
4770 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4774 cursor_to (f
, row
, col
);
4778 /* We have only one cursor on terminal frames. Use it to
4779 display the cursor of the selected window. */
4780 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4781 if (w
->cursor
.vpos
>= 0
4782 /* The cursor vpos may be temporarily out of bounds
4783 in the following situation: There is one window,
4784 with the cursor in the lower half of it. The window
4785 is split, and a message causes a redisplay before
4786 a new cursor position has been computed. */
4787 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4789 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4790 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4792 if (INTEGERP (w
->left_margin_cols
))
4793 x
+= XFASTINT (w
->left_margin_cols
);
4795 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4796 cursor_to (f
, y
, x
);
4801 #if !PERIODIC_PREEMPTION_CHECKING
4805 clear_desired_matrices (f
);
4810 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4813 scrolling (struct frame
*frame
)
4815 int unchanged_at_top
, unchanged_at_bottom
;
4818 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4819 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4820 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4821 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4823 int free_at_end_vpos
= FRAME_LINES (frame
);
4824 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4825 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4827 if (!current_matrix
)
4830 /* Compute hash codes of all the lines. Also calculate number of
4831 changed lines, number of unchanged lines at the beginning, and
4832 number of unchanged lines at the end. */
4834 unchanged_at_top
= 0;
4835 unchanged_at_bottom
= FRAME_LINES (frame
);
4836 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4838 /* Give up on this scrolling if some old lines are not enabled. */
4839 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4841 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4842 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4844 /* This line cannot be redrawn, so don't let scrolling mess it. */
4845 new_hash
[i
] = old_hash
[i
];
4846 #define INFINITY 1000000 /* Taken from scroll.c */
4847 draw_cost
[i
] = INFINITY
;
4851 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4852 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4855 if (old_hash
[i
] != new_hash
[i
])
4858 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4860 else if (i
== unchanged_at_top
)
4862 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4865 /* If changed lines are few, don't allow preemption, don't scroll. */
4866 if ((!FRAME_SCROLL_REGION_OK (frame
)
4867 && changed_lines
< baud_rate
/ 2400)
4868 || unchanged_at_bottom
== FRAME_LINES (frame
))
4871 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4872 - unchanged_at_bottom
);
4874 if (FRAME_SCROLL_REGION_OK (frame
))
4875 free_at_end_vpos
-= unchanged_at_bottom
;
4876 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4877 free_at_end_vpos
= -1;
4879 /* If large window, fast terminal and few lines in common between
4880 current frame and desired frame, don't bother with i/d calc. */
4881 if (!FRAME_SCROLL_REGION_OK (frame
)
4882 && window_size
>= 18 && baud_rate
> 2400
4884 10 * scrolling_max_lines_saved (unchanged_at_top
,
4885 FRAME_LINES (frame
) - unchanged_at_bottom
,
4886 old_hash
, new_hash
, draw_cost
)))
4889 if (window_size
< 2)
4892 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4893 draw_cost
+ unchanged_at_top
- 1,
4894 old_draw_cost
+ unchanged_at_top
- 1,
4895 old_hash
+ unchanged_at_top
- 1,
4896 new_hash
+ unchanged_at_top
- 1,
4897 free_at_end_vpos
- unchanged_at_top
);
4903 /* Count the number of blanks at the start of the vector of glyphs R
4904 which is LEN glyphs long. */
4907 count_blanks (struct glyph
*r
, int len
)
4911 for (i
= 0; i
< len
; ++i
)
4912 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4919 /* Count the number of glyphs in common at the start of the glyph
4920 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4921 of STR2. Value is the number of equal glyphs equal at the start. */
4924 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4926 struct glyph
*p1
= str1
;
4927 struct glyph
*p2
= str2
;
4931 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4938 /* Char insertion/deletion cost vector, from term.c */
4940 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4943 /* Perform a frame-based update on line VPOS in frame FRAME. */
4946 update_frame_line (struct frame
*f
, int vpos
)
4948 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4950 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4951 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4952 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4953 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4954 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4955 int must_write_whole_line_p
;
4956 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4957 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4958 != FACE_TTY_DEFAULT_BG_COLOR
);
4960 if (colored_spaces_p
)
4963 /* Current row not enabled means it has unknown contents. We must
4964 write the whole desired line in that case. */
4965 must_write_whole_line_p
= !current_row
->enabled_p
;
4966 if (must_write_whole_line_p
)
4973 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4974 olen
= current_row
->used
[TEXT_AREA
];
4976 /* Ignore trailing spaces, if we can. */
4977 if (!write_spaces_p
)
4978 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4982 current_row
->enabled_p
= 1;
4983 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4985 /* If desired line is empty, just clear the line. */
4986 if (!desired_row
->enabled_p
)
4992 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4993 nlen
= desired_row
->used
[TEXT_AREA
];
4994 nend
= nbody
+ nlen
;
4996 /* If display line has unknown contents, write the whole line. */
4997 if (must_write_whole_line_p
)
4999 /* Ignore spaces at the end, if we can. */
5000 if (!write_spaces_p
)
5001 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5004 /* Write the contents of the desired line. */
5007 cursor_to (f
, vpos
, 0);
5008 write_glyphs (f
, nbody
, nlen
);
5011 /* Don't call clear_end_of_line if we already wrote the whole
5012 line. The cursor will not be at the right margin in that
5013 case but in the line below. */
5014 if (nlen
< FRAME_TOTAL_COLS (f
))
5016 cursor_to (f
, vpos
, nlen
);
5017 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5020 /* Make sure we are in the right row, otherwise cursor movement
5021 with cmgoto might use `ch' in the wrong row. */
5022 cursor_to (f
, vpos
, 0);
5024 make_current (desired_matrix
, current_matrix
, vpos
);
5028 /* Pretend trailing spaces are not there at all,
5029 unless for one reason or another we must write all spaces. */
5030 if (!write_spaces_p
)
5031 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5034 /* If there's no i/d char, quickly do the best we can without it. */
5035 if (!FRAME_CHAR_INS_DEL_OK (f
))
5039 /* Find the first glyph in desired row that doesn't agree with
5040 a glyph in the current row, and write the rest from there on. */
5041 for (i
= 0; i
< nlen
; i
++)
5043 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5045 /* Find the end of the run of different glyphs. */
5049 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5050 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5053 /* Output this run of non-matching chars. */
5054 cursor_to (f
, vpos
, i
);
5055 write_glyphs (f
, nbody
+ i
, j
- i
);
5058 /* Now find the next non-match. */
5062 /* Clear the rest of the line, or the non-clear part of it. */
5065 cursor_to (f
, vpos
, nlen
);
5066 clear_end_of_line (f
, olen
);
5069 /* Make current row = desired row. */
5070 make_current (desired_matrix
, current_matrix
, vpos
);
5074 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5075 characters in a row. */
5079 /* If current line is blank, skip over initial spaces, if
5080 possible, and write the rest. */
5084 nsp
= count_blanks (nbody
, nlen
);
5088 cursor_to (f
, vpos
, nsp
);
5089 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5092 /* Exchange contents between current_frame and new_frame. */
5093 make_current (desired_matrix
, current_matrix
, vpos
);
5097 /* Compute number of leading blanks in old and new contents. */
5098 osp
= count_blanks (obody
, olen
);
5099 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5101 /* Compute number of matching chars starting with first non-blank. */
5102 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5103 nbody
+ nsp
, nbody
+ nlen
);
5105 /* Spaces in new match implicit space past the end of old. */
5106 /* A bug causing this to be a no-op was fixed in 18.29. */
5107 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5110 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5114 /* Avoid doing insert/delete char
5115 just cause number of leading spaces differs
5116 when the following text does not match. */
5117 if (begmatch
== 0 && osp
!= nsp
)
5118 osp
= nsp
= min (osp
, nsp
);
5120 /* Find matching characters at end of line */
5123 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5125 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5130 endmatch
= obody
+ olen
- op1
;
5132 /* tem gets the distance to insert or delete.
5133 endmatch is how many characters we save by doing so.
5136 tem
= (nlen
- nsp
) - (olen
- osp
);
5138 && (!FRAME_CHAR_INS_DEL_OK (f
)
5139 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5142 /* nsp - osp is the distance to insert or delete.
5143 If that is nonzero, begmatch is known to be nonzero also.
5144 begmatch + endmatch is how much we save by doing the ins/del.
5148 && (!FRAME_CHAR_INS_DEL_OK (f
)
5149 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5153 osp
= nsp
= min (osp
, nsp
);
5156 /* Now go through the line, inserting, writing and
5157 deleting as appropriate. */
5161 cursor_to (f
, vpos
, nsp
);
5162 delete_glyphs (f
, osp
- nsp
);
5166 /* If going to delete chars later in line
5167 and insert earlier in the line,
5168 must delete first to avoid losing data in the insert */
5169 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5171 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5172 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5173 olen
= nlen
- (nsp
- osp
);
5175 cursor_to (f
, vpos
, osp
);
5176 insert_glyphs (f
, 0, nsp
- osp
);
5180 tem
= nsp
+ begmatch
+ endmatch
;
5181 if (nlen
!= tem
|| olen
!= tem
)
5183 if (!endmatch
|| nlen
== olen
)
5185 /* If new text being written reaches right margin, there is
5186 no need to do clear-to-eol at the end of this function
5187 (and it would not be safe, since cursor is not going to
5188 be "at the margin" after the text is done). */
5189 if (nlen
== FRAME_TOTAL_COLS (f
))
5192 /* Function write_glyphs is prepared to do nothing
5193 if passed a length <= 0. Check it here to avoid
5194 unnecessary cursor movement. */
5197 cursor_to (f
, vpos
, nsp
+ begmatch
);
5198 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5201 else if (nlen
> olen
)
5203 /* Here, we used to have the following simple code:
5204 ----------------------------------------
5205 write_glyphs (nbody + nsp + begmatch, olen - tem);
5206 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5207 ----------------------------------------
5208 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5209 is a padding glyph. */
5210 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5213 cursor_to (f
, vpos
, nsp
+ begmatch
);
5215 /* Calculate columns we can actually overwrite. */
5216 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5218 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5220 /* If we left columns to be overwritten, we must delete them. */
5221 del
= olen
- tem
- out
;
5223 delete_glyphs (f
, del
);
5225 /* At last, we insert columns not yet written out. */
5226 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5229 else if (olen
> nlen
)
5231 cursor_to (f
, vpos
, nsp
+ begmatch
);
5232 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5233 delete_glyphs (f
, olen
- nlen
);
5239 /* If any unerased characters remain after the new line, erase them. */
5242 cursor_to (f
, vpos
, nlen
);
5243 clear_end_of_line (f
, olen
);
5246 /* Exchange contents between current_frame and new_frame. */
5247 make_current (desired_matrix
, current_matrix
, vpos
);
5252 /***********************************************************************
5253 X/Y Position -> Buffer Position
5254 ***********************************************************************/
5256 /* Determine what's under window-relative pixel position (*X, *Y).
5257 Return the OBJECT (string or buffer) that's there.
5258 Return in *POS the position in that object.
5259 Adjust *X and *Y to character positions.
5260 Return in *DX and *DY the pixel coordinates of the click,
5261 relative to the top left corner of OBJECT, or relative to
5262 the top left corner of the character glyph at (*X, *Y)
5264 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5265 if the coordinates point to an empty area of the display. */
5268 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
)
5271 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5272 struct text_pos startp
;
5274 struct glyph_row
*row
;
5275 #ifdef HAVE_WINDOW_SYSTEM
5276 struct image
*img
= 0;
5279 void *itdata
= NULL
;
5281 /* We used to set current_buffer directly here, but that does the
5282 wrong thing with `face-remapping-alist' (bug#2044). */
5283 Fset_buffer (w
->buffer
);
5284 itdata
= bidi_shelve_cache ();
5285 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5286 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5287 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5288 start_display (&it
, w
, startp
);
5289 /* start_display takes into account the header-line row, but IT's
5290 vpos still counts from the glyph row that includes the window's
5291 start position. Adjust for a possible header-line row. */
5292 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
5296 /* First, move to the beginning of the row corresponding to *Y. We
5297 need to be in that row to get the correct value of base paragraph
5298 direction for the text at (*X, *Y). */
5299 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5301 /* TO_X is the pixel position that the iterator will compute for the
5302 glyph at *X. We add it.first_visible_x because iterator
5303 positions include the hscroll. */
5304 to_x
= x0
+ it
.first_visible_x
;
5305 if (it
.bidi_it
.paragraph_dir
== R2L
)
5306 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5307 text area. This is because the iterator, even in R2L
5308 paragraphs, delivers glyphs as if they started at the left
5309 margin of the window. (When we actually produce glyphs for
5310 display, we reverse their order in PRODUCE_GLYPHS, but the
5311 iterator doesn't know about that.) The following line adjusts
5312 the pixel position to the iterator geometry, which is what
5313 move_it_* routines use. (The -1 is because in a window whose
5314 text-area width is W, the rightmost pixel position is W-1, and
5315 it should be mirrored into zero pixel position.) */
5316 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5318 /* Now move horizontally in the row to the glyph under *X. Second
5319 argument is ZV to prevent move_it_in_display_line from matching
5320 based on buffer positions. */
5321 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5322 bidi_unshelve_cache (itdata
, 0);
5324 Fset_buffer (old_current_buffer
);
5326 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5327 *dy
= *y
- it
.current_y
;
5330 if (STRINGP (it
.string
))
5333 if (it
.what
== IT_COMPOSITION
5334 && it
.cmp_it
.nchars
> 1
5335 && it
.cmp_it
.reversed_p
)
5337 /* The current display element is a grapheme cluster in a
5338 composition. In that case, we need the position of the first
5339 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5340 it.current points to the last character of the cluster, thus
5341 we must move back to the first character of the same
5343 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5344 if (STRINGP (it
.string
))
5345 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5347 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->buffer
),
5348 CHARPOS (pos
->pos
));
5351 #ifdef HAVE_WINDOW_SYSTEM
5352 if (it
.what
== IT_IMAGE
)
5354 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5355 && !NILP (img
->spec
))
5356 *object
= img
->spec
;
5360 if (it
.vpos
< w
->current_matrix
->nrows
5361 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5364 if (it
.hpos
< row
->used
[TEXT_AREA
])
5366 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5367 #ifdef HAVE_WINDOW_SYSTEM
5370 *dy
-= row
->ascent
- glyph
->ascent
;
5371 *dx
+= glyph
->slice
.img
.x
;
5372 *dy
+= glyph
->slice
.img
.y
;
5373 /* Image slices positions are still relative to the entire image */
5374 *width
= img
->width
;
5375 *height
= img
->height
;
5380 *width
= glyph
->pixel_width
;
5381 *height
= glyph
->ascent
+ glyph
->descent
;
5387 *height
= row
->height
;
5392 *width
= *height
= 0;
5395 /* Add extra (default width) columns if clicked after EOL. */
5396 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5398 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5407 /* Value is the string under window-relative coordinates X/Y in the
5408 mode line or header line (PART says which) of window W, or nil if none.
5409 *CHARPOS is set to the position in the string returned. */
5412 mode_line_string (struct window
*w
, enum window_part part
,
5413 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5414 int *dx
, int *dy
, int *width
, int *height
)
5416 struct glyph_row
*row
;
5417 struct glyph
*glyph
, *end
;
5419 Lisp_Object string
= Qnil
;
5421 if (part
== ON_MODE_LINE
)
5422 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5424 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5426 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5428 if (row
->mode_line_p
&& row
->enabled_p
)
5430 /* Find the glyph under X. If we find one with a string object,
5431 it's the one we were looking for. */
5432 glyph
= row
->glyphs
[TEXT_AREA
];
5433 end
= glyph
+ row
->used
[TEXT_AREA
];
5434 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5435 x0
-= glyph
->pixel_width
;
5436 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5439 string
= glyph
->object
;
5440 *charpos
= glyph
->charpos
;
5441 *width
= glyph
->pixel_width
;
5442 *height
= glyph
->ascent
+ glyph
->descent
;
5443 #ifdef HAVE_WINDOW_SYSTEM
5444 if (glyph
->type
== IMAGE_GLYPH
)
5447 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5449 *object
= img
->spec
;
5450 y0
-= row
->ascent
- glyph
->ascent
;
5456 /* Add extra (default width) columns if clicked after EOL. */
5457 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5459 *height
= row
->height
;
5466 *width
= *height
= 0;
5476 /* Value is the string under window-relative coordinates X/Y in either
5477 marginal area, or nil if none. *CHARPOS is set to the position in
5478 the string returned. */
5481 marginal_area_string (struct window
*w
, enum window_part part
,
5482 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5483 int *dx
, int *dy
, int *width
, int *height
)
5485 struct glyph_row
*row
= w
->current_matrix
->rows
;
5486 struct glyph
*glyph
, *end
;
5487 int x0
, y0
, i
, wy
= *y
;
5489 Lisp_Object string
= Qnil
;
5491 if (part
== ON_LEFT_MARGIN
)
5492 area
= LEFT_MARGIN_AREA
;
5493 else if (part
== ON_RIGHT_MARGIN
)
5494 area
= RIGHT_MARGIN_AREA
;
5498 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5499 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5502 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5506 /* Find the glyph under X. If we find one with a string object,
5507 it's the one we were looking for. */
5508 if (area
== RIGHT_MARGIN_AREA
)
5509 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5510 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5511 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5512 + window_box_width (w
, LEFT_MARGIN_AREA
)
5513 + window_box_width (w
, TEXT_AREA
));
5515 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5516 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5519 glyph
= row
->glyphs
[area
];
5520 end
= glyph
+ row
->used
[area
];
5521 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5522 x0
-= glyph
->pixel_width
;
5523 *x
= glyph
- row
->glyphs
[area
];
5526 string
= glyph
->object
;
5527 *charpos
= glyph
->charpos
;
5528 *width
= glyph
->pixel_width
;
5529 *height
= glyph
->ascent
+ glyph
->descent
;
5530 #ifdef HAVE_WINDOW_SYSTEM
5531 if (glyph
->type
== IMAGE_GLYPH
)
5534 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5536 *object
= img
->spec
;
5537 y0
-= row
->ascent
- glyph
->ascent
;
5538 x0
+= glyph
->slice
.img
.x
;
5539 y0
+= glyph
->slice
.img
.y
;
5545 /* Add extra (default width) columns if clicked after EOL. */
5546 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5548 *height
= row
->height
;
5555 *width
= *height
= 0;
5565 /***********************************************************************
5566 Changing Frame Sizes
5567 ***********************************************************************/
5572 window_change_signal (int signalnum
) /* If we don't have an argument, */
5573 /* some compilers complain in signal calls. */
5576 int old_errno
= errno
;
5578 struct tty_display_info
*tty
;
5580 signal (SIGWINCH
, window_change_signal
);
5581 SIGNAL_THREAD_CHECK (signalnum
);
5583 /* The frame size change obviously applies to a single
5584 termcap-controlled terminal, but we can't decide which.
5585 Therefore, we resize the frames corresponding to each tty.
5587 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5589 if (! tty
->term_initted
)
5592 /* Suspended tty frames have tty->input == NULL avoid trying to
5597 get_tty_size (fileno (tty
->input
), &width
, &height
);
5599 if (width
> 5 && height
> 2) {
5600 Lisp_Object tail
, frame
;
5602 FOR_EACH_FRAME (tail
, frame
)
5603 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5604 /* Record the new sizes, but don't reallocate the data
5605 structures now. Let that be done later outside of the
5607 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5613 #endif /* SIGWINCH */
5616 /* Do any change in frame size that was requested by a signal. SAFE
5617 non-zero means this function is called from a place where it is
5618 safe to change frame sizes while a redisplay is in progress. */
5621 do_pending_window_change (int safe
)
5623 /* If window_change_signal should have run before, run it now. */
5624 if (redisplaying_p
&& !safe
)
5627 while (delayed_size_change
)
5629 Lisp_Object tail
, frame
;
5631 delayed_size_change
= 0;
5633 FOR_EACH_FRAME (tail
, frame
)
5635 struct frame
*f
= XFRAME (frame
);
5637 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5638 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5645 /* Change the frame height and/or width. Values may be given as zero to
5646 indicate no change is to take place.
5648 If DELAY is non-zero, then assume we're being called from a signal
5649 handler, and queue the change for later - perhaps the next
5650 redisplay. Since this tries to resize windows, we can't call it
5651 from a signal handler.
5653 SAFE non-zero means this function is called from a place where it's
5654 safe to change frame sizes while a redisplay is in progress. */
5657 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5659 Lisp_Object tail
, frame
;
5661 if (FRAME_MSDOS_P (f
))
5663 /* On MS-DOS, all frames use the same screen, so a change in
5664 size affects all frames. Termcap now supports multiple
5666 FOR_EACH_FRAME (tail
, frame
)
5667 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5668 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5669 pretend
, delay
, safe
);
5672 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5676 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5678 int new_frame_total_cols
;
5679 ptrdiff_t count
= SPECPDL_INDEX ();
5681 /* If we can't deal with the change now, queue it for later. */
5682 if (delay
|| (redisplaying_p
&& !safe
))
5684 f
->new_text_lines
= newheight
;
5685 f
->new_text_cols
= newwidth
;
5686 delayed_size_change
= 1;
5690 /* This size-change overrides any pending one for this frame. */
5691 f
->new_text_lines
= 0;
5692 f
->new_text_cols
= 0;
5694 /* If an argument is zero, set it to the current value. */
5696 newheight
= FRAME_LINES (f
);
5698 newwidth
= FRAME_COLS (f
);
5700 /* Compute width of windows in F. */
5701 /* Round up to the smallest acceptable size. */
5702 check_frame_size (f
, &newheight
, &newwidth
);
5704 /* This is the width of the frame with vertical scroll bars and fringe
5705 columns. Do this after rounding - see discussion of bug#9723. */
5706 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5708 /* If we're not changing the frame size, quit now. */
5709 /* Frame width may be unchanged but the text portion may change, for
5710 example, fullscreen and remove/add scroll bar. */
5711 if (newheight
== FRAME_LINES (f
)
5712 /* Text portion unchanged? */
5713 && newwidth
== FRAME_COLS (f
)
5714 /* Frame width unchanged? */
5715 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5721 /* We only can set screen dimensions to certain values supported
5722 by our video hardware. Try to find the smallest size greater
5723 or equal to the requested dimensions. */
5724 dos_set_window_size (&newheight
, &newwidth
);
5727 if (newheight
!= FRAME_LINES (f
))
5729 resize_frame_windows (f
, newheight
, 0);
5731 /* MSDOS frames cannot PRETEND, as they change frame size by
5732 manipulating video hardware. */
5733 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5734 FrameRows (FRAME_TTY (f
)) = newheight
;
5737 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5739 resize_frame_windows (f
, new_frame_total_cols
, 1);
5741 /* MSDOS frames cannot PRETEND, as they change frame size by
5742 manipulating video hardware. */
5743 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5744 FrameCols (FRAME_TTY (f
)) = newwidth
;
5746 if (WINDOWP (f
->tool_bar_window
))
5747 WSET (XWINDOW (f
->tool_bar_window
), total_cols
, make_number (newwidth
));
5750 FRAME_LINES (f
) = newheight
;
5751 SET_FRAME_COLS (f
, newwidth
);
5754 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5755 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5757 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5759 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5760 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5761 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5762 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5766 calculate_costs (f
);
5767 SET_FRAME_GARBAGED (f
);
5772 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5774 run_window_configuration_change_hook (f
);
5776 unbind_to (count
, Qnil
);
5781 /***********************************************************************
5782 Terminal Related Lisp Functions
5783 ***********************************************************************/
5785 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5786 1, 1, "FOpen termscript file: ",
5787 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5788 FILE = nil means just close any termscript file currently open. */)
5791 struct tty_display_info
*tty
;
5793 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5794 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5795 error ("Current frame is not on a tty device");
5799 if (tty
->termscript
!= 0)
5802 fclose (tty
->termscript
);
5805 tty
->termscript
= 0;
5809 file
= Fexpand_file_name (file
, Qnil
);
5810 tty
->termscript
= fopen (SSDATA (file
), "w");
5811 if (tty
->termscript
== 0)
5812 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5818 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5819 Ssend_string_to_terminal
, 1, 2, 0,
5820 doc
: /* Send STRING to the terminal without alteration.
5821 Control characters in STRING will have terminal-dependent effects.
5823 Optional parameter TERMINAL specifies the tty terminal device to use.
5824 It may be a terminal object, a frame, or nil for the terminal used by
5825 the currently selected frame. In batch mode, STRING is sent to stdout
5826 when TERMINAL is nil. */)
5827 (Lisp_Object string
, Lisp_Object terminal
)
5829 struct terminal
*t
= get_terminal (terminal
, 1);
5832 /* ??? Perhaps we should do something special for multibyte strings here. */
5833 CHECK_STRING (string
);
5837 error ("Unknown terminal device");
5839 if (t
->type
== output_initial
)
5841 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5842 error ("Device %d is not a termcap terminal device", t
->id
);
5845 struct tty_display_info
*tty
= t
->display_info
.tty
;
5848 error ("Terminal is currently suspended");
5850 if (tty
->termscript
)
5852 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5853 fflush (tty
->termscript
);
5857 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5864 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5865 doc
: /* Beep, or flash the screen.
5866 Also, unless an argument is given,
5867 terminate any keyboard macro currently executing. */)
5875 ring_bell (XFRAME (selected_frame
));
5884 bitch_at_user (void)
5888 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5889 error ("Keyboard macro terminated by a command ringing the bell");
5891 ring_bell (XFRAME (selected_frame
));
5896 /***********************************************************************
5898 ***********************************************************************/
5900 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5901 doc
: /* Pause, without updating display, for SECONDS seconds.
5902 SECONDS may be a floating-point value, meaning that you can wait for a
5903 fraction of a second. Optional second arg MILLISECONDS specifies an
5904 additional wait period, in milliseconds; this is for backwards compatibility.
5905 \(Not all operating systems support waiting for a fraction of a second.) */)
5906 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5908 double duration
= extract_float (seconds
);
5910 if (!NILP (milliseconds
))
5912 CHECK_NUMBER (milliseconds
);
5913 duration
+= XINT (milliseconds
) / 1000.0;
5918 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (duration
);
5919 wait_reading_process_output (min (EMACS_SECS (t
), WAIT_READING_MAX
),
5920 EMACS_NSECS (t
), 0, 0, Qnil
, NULL
, 0);
5927 /* This is just like wait_reading_process_output, except that
5930 TIMEOUT is number of seconds to wait (float or integer),
5931 or t to wait forever.
5932 READING is 1 if reading input.
5933 If DO_DISPLAY is >0 display process output while waiting.
5934 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5938 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
5943 swallow_events (do_display
);
5945 if ((detect_input_pending_run_timers (do_display
))
5946 || !NILP (Vexecuting_kbd_macro
))
5949 if (do_display
>= 2)
5950 redisplay_preserve_echo_area (2);
5952 if (INTEGERP (timeout
))
5954 sec
= XINT (timeout
);
5959 else if (FLOATP (timeout
))
5961 double seconds
= XFLOAT_DATA (timeout
);
5962 if (! (0 < seconds
))
5966 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (seconds
);
5967 sec
= min (EMACS_SECS (t
), WAIT_READING_MAX
);
5968 nsec
= EMACS_NSECS (t
);
5971 else if (EQ (timeout
, Qt
))
5977 wrong_type_argument (Qnumberp
, timeout
);
5984 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5987 return detect_input_pending () ? Qnil
: Qt
;
5991 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5992 doc
: /* Perform redisplay.
5993 Optional arg FORCE, if non-nil, prevents redisplay from being
5994 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5995 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5996 preempted by arriving input, so FORCE does nothing.
5998 Return t if redisplay was performed, nil if redisplay was preempted
5999 immediately by pending input. */)
6005 if ((detect_input_pending_run_timers (1)
6006 && NILP (force
) && !redisplay_dont_pause
)
6007 || !NILP (Vexecuting_kbd_macro
))
6010 count
= SPECPDL_INDEX ();
6011 if (!NILP (force
) && !redisplay_dont_pause
)
6012 specbind (Qredisplay_dont_pause
, Qt
);
6013 redisplay_preserve_echo_area (2);
6014 unbind_to (count
, Qnil
);
6020 /***********************************************************************
6021 Other Lisp Functions
6022 ***********************************************************************/
6024 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6025 session's frames, frame names, buffers, buffer-read-only flags, and
6026 buffer-modified-flags. */
6028 static Lisp_Object frame_and_buffer_state
;
6031 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6032 Sframe_or_buffer_changed_p
, 0, 1, 0,
6033 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6034 VARIABLE is a variable name whose value is either nil or a state vector
6035 that will be updated to contain all frames and buffers,
6036 aside from buffers whose names start with space,
6037 along with the buffers' read-only and modified flags. This allows a fast
6038 check to see whether buffer menus might need to be recomputed.
6039 If this function returns non-nil, it updates the internal vector to reflect
6042 If VARIABLE is nil, an internal variable is used. Users should not
6043 pass nil for VARIABLE. */)
6044 (Lisp_Object variable
)
6046 Lisp_Object state
, tail
, frame
, buf
;
6047 Lisp_Object
*vecp
, *end
;
6050 if (! NILP (variable
))
6052 CHECK_SYMBOL (variable
);
6053 state
= Fsymbol_value (variable
);
6054 if (! VECTORP (state
))
6058 state
= frame_and_buffer_state
;
6060 vecp
= XVECTOR (state
)->contents
;
6061 end
= vecp
+ ASIZE (state
);
6063 FOR_EACH_FRAME (tail
, frame
)
6067 if (!EQ (*vecp
++, frame
))
6071 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6074 /* Check that the buffer info matches. */
6075 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6077 buf
= XCDR (XCAR (tail
));
6078 /* Ignore buffers that aren't included in buffer lists. */
6079 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6083 if (!EQ (*vecp
++, buf
))
6087 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6091 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6096 /* Detect deletion of a buffer at the end of the list. */
6097 if (EQ (*vecp
, Qlambda
))
6100 /* Come here if we decide the data has changed. */
6102 /* Count the size we will need.
6103 Start with 1 so there is room for at least one lambda at the end. */
6105 FOR_EACH_FRAME (tail
, frame
)
6107 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6109 /* Reallocate the vector if data has grown to need it,
6110 or if it has shrunk a lot. */
6111 if (! VECTORP (state
)
6112 || n
> ASIZE (state
)
6113 || n
+ 20 < ASIZE (state
) / 2)
6114 /* Add 20 extra so we grow it less often. */
6116 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6117 if (! NILP (variable
))
6118 Fset (variable
, state
);
6120 frame_and_buffer_state
= state
;
6123 /* Record the new data in the (possibly reallocated) vector. */
6124 vecp
= XVECTOR (state
)->contents
;
6125 FOR_EACH_FRAME (tail
, frame
)
6128 *vecp
++ = XFRAME (frame
)->name
;
6130 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6132 buf
= XCDR (XCAR (tail
));
6133 /* Ignore buffers that aren't included in buffer lists. */
6134 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6137 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6138 *vecp
++ = Fbuffer_modified_p (buf
);
6140 /* Fill up the vector with lambdas (always at least one). */
6142 while (vecp
- XVECTOR (state
)->contents
6145 /* Make sure we didn't overflow the vector. */
6146 if (vecp
- XVECTOR (state
)->contents
6154 /***********************************************************************
6156 ***********************************************************************/
6158 /* Initialization done when Emacs fork is started, before doing stty.
6159 Determine terminal type and set terminal_driver. Then invoke its
6160 decoding routine to set up variables in the terminal package. */
6165 char *terminal_type
;
6167 /* Construct the space glyph. */
6168 space_glyph
.type
= CHAR_GLYPH
;
6169 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6170 space_glyph
.charpos
= -1;
6173 cursor_in_echo_area
= 0;
6174 terminal_type
= (char *) 0;
6176 /* Now is the time to initialize this; it's used by init_sys_modes
6178 Vinitial_window_system
= Qnil
;
6180 /* SIGWINCH needs to be handled no matter what display we start
6181 with. Otherwise newly opened tty frames will not resize
6186 #endif /* CANNOT_DUMP */
6187 signal (SIGWINCH
, window_change_signal
);
6188 #endif /* SIGWINCH */
6190 /* If running as a daemon, no need to initialize any frames/terminal. */
6194 /* If the user wants to use a window system, we shouldn't bother
6195 initializing the terminal. This is especially important when the
6196 terminal is so dumb that emacs gives up before and doesn't bother
6197 using the window system.
6199 If the DISPLAY environment variable is set and nonempty,
6200 try to use X, and die with an error message if that doesn't work. */
6202 #ifdef HAVE_X_WINDOWS
6203 if (! inhibit_window_system
&& ! display_arg
)
6206 display
= getenv ("DISPLAY");
6207 display_arg
= (display
!= 0 && *display
!= 0);
6209 if (display_arg
&& !x_display_ok (display
))
6211 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6213 inhibit_window_system
= 1;
6217 if (!inhibit_window_system
&& display_arg
)
6219 Vinitial_window_system
= Qx
;
6221 Vwindow_system_version
= make_number (11);
6224 /* In some versions of ncurses,
6225 tputs crashes if we have not called tgetent.
6227 { char b
[2044]; tgetent (b
, "xterm");}
6229 adjust_frame_glyphs_initially ();
6232 #endif /* HAVE_X_WINDOWS */
6235 if (!inhibit_window_system
)
6237 Vinitial_window_system
= Qw32
;
6238 Vwindow_system_version
= make_number (1);
6239 adjust_frame_glyphs_initially ();
6242 #endif /* HAVE_NTGUI */
6245 if (!inhibit_window_system
6251 Vinitial_window_system
= Qns
;
6252 Vwindow_system_version
= make_number (10);
6253 adjust_frame_glyphs_initially ();
6258 /* If no window system has been specified, try to use the terminal. */
6261 fatal ("standard input is not a tty");
6266 terminal_type
= "w32console";
6268 /* Look at the TERM variable. */
6269 terminal_type
= (char *) getenv ("TERM");
6273 #ifdef HAVE_WINDOW_SYSTEM
6274 if (! inhibit_window_system
)
6275 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6277 #endif /* HAVE_WINDOW_SYSTEM */
6278 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6284 struct frame
*f
= XFRAME (selected_frame
);
6286 /* Open a display on the controlling tty. */
6287 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6289 /* Convert the initial frame to use the new display. */
6290 if (f
->output_method
!= output_initial
)
6292 f
->output_method
= t
->type
;
6295 t
->reference_count
++;
6297 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6299 if (f
->output_method
== output_termcap
)
6300 create_tty_output (f
);
6302 t
->display_info
.tty
->top_frame
= selected_frame
;
6303 change_frame_size (XFRAME (selected_frame
),
6304 FrameRows (t
->display_info
.tty
),
6305 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6307 /* Delete the initial terminal. */
6308 if (--initial_terminal
->reference_count
== 0
6309 && initial_terminal
->delete_terminal_hook
)
6310 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6312 /* Update frame parameters to reflect the new type. */
6313 Fmodify_frame_parameters
6314 (selected_frame
, Fcons (Fcons (Qtty_type
,
6315 Ftty_type (selected_frame
)), Qnil
));
6316 if (t
->display_info
.tty
->name
)
6317 Fmodify_frame_parameters (selected_frame
,
6318 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6321 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6326 struct frame
*sf
= SELECTED_FRAME ();
6327 int width
= FRAME_TOTAL_COLS (sf
);
6328 int height
= FRAME_LINES (sf
);
6330 /* If these sizes are so big they cause overflow, just ignore the
6331 change. It's not clear what better we could do. The rest of
6332 the code assumes that (width + 2) * height * sizeof (struct glyph)
6333 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6334 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6335 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6336 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6337 < (width
+ 2) * height
))
6338 fatal ("screen size %dx%d too big", width
, height
);
6341 adjust_frame_glyphs_initially ();
6342 calculate_costs (XFRAME (selected_frame
));
6344 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6347 && NILP (Vinitial_window_system
))
6349 /* For the initial frame, we don't have any way of knowing what
6350 are the foreground and background colors of the terminal. */
6351 struct frame
*sf
= SELECTED_FRAME ();
6353 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6354 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6355 call0 (intern ("tty-set-up-initial-frame-faces"));
6361 /***********************************************************************
6363 ***********************************************************************/
6365 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6366 Sinternal_show_cursor
, 2, 2, 0,
6367 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6368 WINDOW nil means use the selected window. SHOW non-nil means
6369 show a cursor in WINDOW in the next redisplay. SHOW nil means
6370 don't show a cursor. */)
6371 (Lisp_Object window
, Lisp_Object show
)
6373 /* Don't change cursor state while redisplaying. This could confuse
6375 if (!redisplaying_p
)
6378 window
= selected_window
;
6380 CHECK_WINDOW (window
);
6382 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6389 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6390 Sinternal_show_cursor_p
, 0, 1, 0,
6391 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6392 WINDOW nil or omitted means report on the selected window. */)
6393 (Lisp_Object window
)
6398 window
= selected_window
;
6400 CHECK_WINDOW (window
);
6402 w
= XWINDOW (window
);
6403 return w
->cursor_off_p
? Qnil
: Qt
;
6406 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6407 Slast_nonminibuf_frame
, 0, 0, 0,
6408 doc
: /* Value is last nonminibuffer frame. */)
6411 Lisp_Object frame
= Qnil
;
6413 if (last_nonminibuf_frame
)
6414 XSETFRAME (frame
, last_nonminibuf_frame
);
6419 /***********************************************************************
6421 ***********************************************************************/
6424 syms_of_display (void)
6426 defsubr (&Sredraw_frame
);
6427 defsubr (&Sredraw_display
);
6428 defsubr (&Sframe_or_buffer_changed_p
);
6429 defsubr (&Sopen_termscript
);
6431 defsubr (&Sredisplay
);
6432 defsubr (&Ssleep_for
);
6433 defsubr (&Ssend_string_to_terminal
);
6434 defsubr (&Sinternal_show_cursor
);
6435 defsubr (&Sinternal_show_cursor_p
);
6436 defsubr (&Slast_nonminibuf_frame
);
6439 defsubr (&Sdump_redisplay_history
);
6442 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6443 staticpro (&frame_and_buffer_state
);
6445 DEFSYM (Qdisplay_table
, "display-table");
6446 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6448 DEFVAR_INT ("baud-rate", baud_rate
,
6449 doc
: /* The output baud rate of the terminal.
6450 On most systems, changing this value will affect the amount of padding
6451 and the other strategic decisions made during redisplay. */);
6453 DEFVAR_BOOL ("inverse-video", inverse_video
,
6454 doc
: /* Non-nil means invert the entire frame display.
6455 This means everything is in inverse video which otherwise would not be. */);
6457 DEFVAR_BOOL ("visible-bell", visible_bell
,
6458 doc
: /* Non-nil means try to flash the frame to represent a bell.
6460 See also `ring-bell-function'. */);
6462 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6463 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6464 A non-nil value is useful if the terminal can automatically preserve
6465 Emacs's frame display when you reenter Emacs.
6466 It is up to you to set this variable if your terminal can do that. */);
6468 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6469 doc
: /* Name of the window system that Emacs uses for the first frame.
6470 The value is a symbol:
6471 nil for a termcap frame (a character-only terminal),
6472 'x' for an Emacs frame that is really an X window,
6473 'w32' for an Emacs frame that is a window on MS-Windows display,
6474 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6475 'pc' for a direct-write MS-DOS frame.
6477 Use of this variable as a boolean is deprecated. Instead,
6478 use `display-graphic-p' or any of the other `display-*-p'
6479 predicates which report frame's specific UI-related capabilities. */);
6481 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6482 doc
: /* Name of window system through which the selected frame is displayed.
6483 The value is a symbol:
6484 nil for a termcap frame (a character-only terminal),
6485 'x' for an Emacs frame that is really an X window,
6486 'w32' for an Emacs frame that is a window on MS-Windows display,
6487 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6488 'pc' for a direct-write MS-DOS frame.
6490 Use of this variable as a boolean is deprecated. Instead,
6491 use `display-graphic-p' or any of the other `display-*-p'
6492 predicates which report frame's specific UI-related capabilities. */);
6494 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6495 doc
: /* The version number of the window system in use.
6496 For X windows, this is 11. */);
6498 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6499 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6501 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6502 doc
: /* Table defining how to output a glyph code to the frame.
6503 If not nil, this is a vector indexed by glyph code to define the glyph.
6504 Each element can be:
6505 integer: a glyph code which this glyph is an alias for.
6506 string: output this glyph using that string (not impl. in X windows).
6507 nil: this glyph mod 524288 is the code of a character to output,
6508 and this glyph / 524288 is the face number (see `face-id') to use
6509 while outputting it. */);
6510 Vglyph_table
= Qnil
;
6512 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6513 doc
: /* Display table to use for buffers that specify none.
6514 See `buffer-display-table' for more information. */);
6515 Vstandard_display_table
= Qnil
;
6517 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6518 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6519 redisplay_dont_pause
= 1;
6521 #if PERIODIC_PREEMPTION_CHECKING
6522 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6523 doc
: /* Period in seconds between checking for input during redisplay.
6524 This has an effect only if `redisplay-dont-pause' is nil; in that
6525 case, arriving input preempts redisplay until the input is processed.
6526 If the value is nil, redisplay is never preempted. */);
6527 Vredisplay_preemption_period
= make_float (0.10);
6534 Vinitial_window_system
= Qnil
;
6535 Vwindow_system_version
= Qnil
;