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"
50 #ifdef HAVE_WINDOW_SYSTEM
52 #endif /* HAVE_WINDOW_SYSTEM */
54 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
59 #ifdef DISPNEW_NEEDS_STDIO_EXT
60 #include <stdio_ext.h>
63 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
64 #include <term.h> /* for tgetent */
67 /* Structure to pass dimensions around. Used for character bounding
68 boxes, glyph matrix dimensions and alike. */
77 /* Function prototypes. */
79 static void update_frame_line (struct frame
*, int);
80 static int required_matrix_height (struct window
*);
81 static int required_matrix_width (struct window
*);
82 static void adjust_frame_glyphs (struct frame
*);
83 static void change_frame_size_1 (struct frame
*, int, int, bool, bool, bool);
84 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
85 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
86 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
88 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
90 static void adjust_frame_message_buffer (struct frame
*);
91 static void adjust_decode_mode_spec_buffer (struct frame
*);
92 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
93 static void clear_window_matrices (struct window
*, bool);
94 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
95 static int scrolling_window (struct window
*, bool);
96 static bool update_window_line (struct window
*, int, bool *);
97 static void mirror_make_current (struct window
*, int);
99 static void check_matrix_pointers (struct glyph_matrix
*,
100 struct glyph_matrix
*);
102 static void mirror_line_dance (struct window
*, int, int, int *, char *);
103 static bool update_window_tree (struct window
*, bool);
104 static bool update_window (struct window
*, bool);
105 static bool update_frame_1 (struct frame
*, bool, bool);
106 static bool scrolling (struct frame
*);
107 static void set_window_cursor_after_update (struct window
*);
108 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
109 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
112 /* Redisplay preemption timers. */
114 static EMACS_TIME preemption_period
;
115 static EMACS_TIME preemption_next_check
;
117 /* True upon entry to redisplay means do not assume anything about
118 current contents of actual terminal frame; clear and redraw it. */
122 /* True means last display completed. False means it was preempted. */
124 bool display_completed
;
126 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
129 /* The currently selected frame. In a single-frame version, this
130 variable always equals the_only_frame. */
132 Lisp_Object selected_frame
;
134 /* A frame which is not just a mini-buffer, or 0 if there are no such
135 frames. This is usually the most recent such frame that was
136 selected. In a single-frame version, this variable always holds
137 the address of the_only_frame. */
139 struct frame
*last_nonminibuf_frame
;
141 /* True means SIGWINCH happened when not safe. */
143 static bool delayed_size_change
;
145 /* 1 means glyph initialization has been completed at startup. */
147 static bool glyphs_initialized_initially_p
;
149 /* Updated window if != 0. Set by update_window. */
151 struct window
*updated_window
;
153 /* Glyph row updated in update_window_line, and area that is updated. */
155 struct glyph_row
*updated_row
;
158 /* A glyph for a space. */
160 struct glyph space_glyph
;
162 /* Counts of allocated structures. These counts serve to diagnose
163 memory leaks and double frees. */
165 static int glyph_matrix_count
;
166 static int glyph_pool_count
;
168 /* If non-null, the frame whose frame matrices are manipulated. If
169 null, window matrices are worked on. */
171 static struct frame
*frame_matrix_frame
;
173 /* True means that fonts have been loaded since the last glyph
174 matrix adjustments. Redisplay must stop, and glyph matrices must
175 be adjusted when this flag becomes true during display. The
176 reason fonts can be loaded so late is that fonts of fontsets are
177 loaded on demand. Another reason is that a line contains many
178 characters displayed by zero width or very narrow glyphs of
179 variable-width fonts. */
181 bool fonts_changed_p
;
183 /* Convert vpos and hpos from frame to window and vice versa.
184 This may only be used for terminal frames. */
188 static int window_to_frame_vpos (struct window
*, int);
189 static int window_to_frame_hpos (struct window
*, int);
190 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
191 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
193 /* One element of the ring buffer containing redisplay history
196 struct redisplay_history
198 char trace
[512 + 100];
201 /* The size of the history buffer. */
203 #define REDISPLAY_HISTORY_SIZE 30
205 /* The redisplay history buffer. */
207 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
209 /* Next free entry in redisplay_history. */
211 static int history_idx
;
213 /* A tick that's incremented each time something is added to the
216 static uprintmax_t history_tick
;
218 /* Add to the redisplay history how window W has been displayed.
219 MSG is a trace containing the information how W's glyph matrix
220 has been constructed. PAUSED_P means that the update
221 has been interrupted for pending input. */
224 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
228 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
230 buf
= redisplay_history
[history_idx
].trace
;
233 snprintf (buf
, sizeof redisplay_history
[0].trace
,
234 "%"pMu
": window %p (`%s')%s\n%s",
237 ((BUFFERP (w
->buffer
)
238 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
239 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
241 paused_p
? " ***paused***" : "",
246 /* Add to the redisplay history that frame F has been displayed.
247 PAUSED_P means that the update has been interrupted for
251 add_frame_display_history (struct frame
*f
, bool paused_p
)
255 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
257 buf
= redisplay_history
[history_idx
].trace
;
260 sprintf (buf
, "%"pMu
": update frame %p%s",
262 f
, paused_p
? " ***paused***" : "");
266 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
267 Sdump_redisplay_history
, 0, 0, "",
268 doc
: /* Dump redisplay history to stderr. */)
273 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
276 i
= REDISPLAY_HISTORY_SIZE
- 1;
277 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
284 #else /* not GLYPH_DEBUG */
286 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
287 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
289 #endif /* GLYPH_DEBUG */
292 #if (defined PROFILING \
293 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
294 && !HAVE___EXECUTABLE_START)
295 /* This function comes first in the Emacs executable and is used only
296 to estimate the text start for profiling. */
298 __executable_start (void)
304 /***********************************************************************
306 ***********************************************************************/
308 /* Allocate and return a glyph_matrix structure. POOL is the glyph
309 pool from which memory for the matrix should be allocated, or null
310 for window-based redisplay where no glyph pools are used. The
311 member `pool' of the glyph matrix structure returned is set to
312 POOL, the structure is otherwise zeroed. */
314 static struct glyph_matrix
*
315 new_glyph_matrix (struct glyph_pool
*pool
)
317 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
319 /* Increment number of allocated matrices. This count is used
320 to detect memory leaks. */
321 ++glyph_matrix_count
;
323 /* Set pool and return. */
329 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
331 The global counter glyph_matrix_count is decremented when a matrix
332 is freed. If the count gets negative, more structures were freed
333 than allocated, i.e. one matrix was freed more than once or a bogus
334 pointer was passed to this function.
336 If MATRIX->pool is null, this means that the matrix manages its own
337 glyph memory---this is done for matrices on X frames. Freeing the
338 matrix also frees the glyph memory in this case. */
341 free_glyph_matrix (struct glyph_matrix
*matrix
)
347 /* Detect the case that more matrices are freed than were
349 if (--glyph_matrix_count
< 0)
352 /* Free glyph memory if MATRIX owns it. */
353 if (matrix
->pool
== NULL
)
354 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
355 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
357 /* Free row structures and the matrix itself. */
358 xfree (matrix
->rows
);
364 /* Return the number of glyphs to reserve for a marginal area of
365 window W. TOTAL_GLYPHS is the number of glyphs in a complete
366 display line of window W. MARGIN gives the width of the marginal
367 area in canonical character units. MARGIN should be an integer
371 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
375 if (NUMBERP (margin
))
377 int width
= XFASTINT (w
->total_cols
);
378 double d
= max (0, XFLOATINT (margin
));
379 d
= min (width
/ 2 - 1, d
);
380 n
= (int) ((double) total_glyphs
/ width
* d
);
388 /* Return true if ROW's hash value is correct.
389 Optimized away if ENABLE_CHECKING is not defined. */
392 verify_row_hash (struct glyph_row
*row
)
394 return row
->hash
== row_hash (row
);
397 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
400 W is null if the function is called for a frame glyph matrix.
401 Otherwise it is the window MATRIX is a member of. X and Y are the
402 indices of the first column and row of MATRIX within the frame
403 matrix, if such a matrix exists. They are zero for purely
404 window-based redisplay. DIM is the needed size of the matrix.
406 In window-based redisplay, where no frame matrices exist, glyph
407 matrices manage their own glyph storage. Otherwise, they allocate
408 storage from a common frame glyph pool which can be found in
411 The reason for this memory management strategy is to avoid complete
412 frame redraws if possible. When we allocate from a common pool, a
413 change of the location or size of a sub-matrix within the pool
414 requires a complete redisplay of the frame because we cannot easily
415 make sure that the current matrices of all windows still agree with
416 what is displayed on the screen. While this is usually fast, it
417 leads to screen flickering. */
420 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
424 bool marginal_areas_changed_p
= 0;
425 bool header_line_changed_p
= 0;
426 bool header_line_p
= 0;
427 int left
= -1, right
= -1;
428 int window_width
= -1, window_height
= -1;
430 /* See if W had a header line that has disappeared now, or vice versa.
434 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
436 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
437 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
439 matrix
->header_line_p
= header_line_p
;
441 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
442 Do nothing if MATRIX' size, position, vscroll, and marginal areas
443 haven't changed. This optimization is important because preserving
444 the matrix means preventing redisplay. */
445 if (matrix
->pool
== NULL
)
447 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
448 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
449 eassert (left
>= 0 && right
>= 0);
450 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
451 || right
!= matrix
->right_margin_glyphs
);
453 if (!marginal_areas_changed_p
455 && !header_line_changed_p
456 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
457 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
458 && matrix
->window_height
== window_height
459 && matrix
->window_vscroll
== w
->vscroll
460 && matrix
->window_width
== window_width
)
464 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
465 if (matrix
->rows_allocated
< dim
.height
)
467 int old_alloc
= matrix
->rows_allocated
;
468 new_rows
= dim
.height
- matrix
->rows_allocated
;
469 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
470 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
471 memset (matrix
->rows
+ old_alloc
, 0,
472 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
477 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
478 on a frame not using window-based redisplay. Set up pointers for
479 each row into the glyph pool. */
482 eassert (matrix
->pool
->glyphs
);
486 left
= margin_glyphs_to_reserve (w
, dim
.width
,
487 w
->left_margin_cols
);
488 right
= margin_glyphs_to_reserve (w
, dim
.width
,
489 w
->right_margin_cols
);
494 for (i
= 0; i
< dim
.height
; ++i
)
496 struct glyph_row
*row
= &matrix
->rows
[i
];
498 row
->glyphs
[LEFT_MARGIN_AREA
]
499 = (matrix
->pool
->glyphs
500 + (y
+ i
) * matrix
->pool
->ncolumns
504 || row
== matrix
->rows
+ dim
.height
- 1
505 || (row
== matrix
->rows
&& matrix
->header_line_p
))
507 row
->glyphs
[TEXT_AREA
]
508 = row
->glyphs
[LEFT_MARGIN_AREA
];
509 row
->glyphs
[RIGHT_MARGIN_AREA
]
510 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
511 row
->glyphs
[LAST_AREA
]
512 = row
->glyphs
[RIGHT_MARGIN_AREA
];
516 row
->glyphs
[TEXT_AREA
]
517 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
518 row
->glyphs
[RIGHT_MARGIN_AREA
]
519 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
520 row
->glyphs
[LAST_AREA
]
521 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
525 matrix
->left_margin_glyphs
= left
;
526 matrix
->right_margin_glyphs
= right
;
530 /* If MATRIX->pool is null, MATRIX is responsible for managing
531 its own memory. It is a window matrix for window-based redisplay.
532 Allocate glyph memory from the heap. */
533 if (dim
.width
> matrix
->matrix_w
535 || header_line_changed_p
536 || marginal_areas_changed_p
)
538 struct glyph_row
*row
= matrix
->rows
;
539 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
543 row
->glyphs
[LEFT_MARGIN_AREA
]
544 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
545 dim
.width
, sizeof (struct glyph
));
547 /* The mode line never has marginal areas. */
548 if (row
== matrix
->rows
+ dim
.height
- 1
549 || (row
== matrix
->rows
&& matrix
->header_line_p
))
551 row
->glyphs
[TEXT_AREA
]
552 = row
->glyphs
[LEFT_MARGIN_AREA
];
553 row
->glyphs
[RIGHT_MARGIN_AREA
]
554 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
555 row
->glyphs
[LAST_AREA
]
556 = row
->glyphs
[RIGHT_MARGIN_AREA
];
560 row
->glyphs
[TEXT_AREA
]
561 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
562 row
->glyphs
[RIGHT_MARGIN_AREA
]
563 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
564 row
->glyphs
[LAST_AREA
]
565 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
571 eassert (left
>= 0 && right
>= 0);
572 matrix
->left_margin_glyphs
= left
;
573 matrix
->right_margin_glyphs
= right
;
576 /* Number of rows to be used by MATRIX. */
577 matrix
->nrows
= dim
.height
;
578 eassert (matrix
->nrows
>= 0);
582 if (matrix
== w
->current_matrix
)
584 /* Mark rows in a current matrix of a window as not having
585 valid contents. It's important to not do this for
586 desired matrices. When Emacs starts, it may already be
587 building desired matrices when this function runs. */
588 if (window_width
< 0)
589 window_width
= window_box_width (w
, -1);
591 /* Optimize the case that only the height has changed (C-x 2,
592 upper window). Invalidate all rows that are no longer part
594 if (!marginal_areas_changed_p
595 && !header_line_changed_p
597 && dim
.width
== matrix
->matrix_w
598 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
599 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
600 && matrix
->window_width
== window_width
)
602 /* Find the last row in the window. */
603 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
604 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
610 /* Window end is invalid, if inside of the rows that
611 are invalidated below. */
612 if (INTEGERP (w
->window_end_vpos
)
613 && XFASTINT (w
->window_end_vpos
) >= i
)
614 wset_window_end_valid (w
, Qnil
);
616 while (i
< matrix
->nrows
)
617 matrix
->rows
[i
++].enabled_p
= 0;
621 for (i
= 0; i
< matrix
->nrows
; ++i
)
622 matrix
->rows
[i
].enabled_p
= 0;
625 else if (matrix
== w
->desired_matrix
)
627 /* Rows in desired matrices always have to be cleared;
628 redisplay expects this is the case when it runs, so it
629 had better be the case when we adjust matrices between
631 for (i
= 0; i
< matrix
->nrows
; ++i
)
632 matrix
->rows
[i
].enabled_p
= 0;
637 /* Remember last values to be able to optimize frame redraws. */
638 matrix
->matrix_x
= x
;
639 matrix
->matrix_y
= y
;
640 matrix
->matrix_w
= dim
.width
;
641 matrix
->matrix_h
= dim
.height
;
643 /* Record the top y location and height of W at the time the matrix
644 was last adjusted. This is used to optimize redisplay above. */
647 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
648 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
649 matrix
->window_height
= window_height
;
650 matrix
->window_width
= window_width
;
651 matrix
->window_vscroll
= w
->vscroll
;
656 /* Reverse the contents of rows in MATRIX between START and END. The
657 contents of the row at END - 1 end up at START, END - 2 at START +
658 1 etc. This is part of the implementation of rotate_matrix (see
662 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
666 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
668 /* Non-ISO HP/UX compiler doesn't like auto struct
670 struct glyph_row temp
;
671 temp
= matrix
->rows
[i
];
672 matrix
->rows
[i
] = matrix
->rows
[j
];
673 matrix
->rows
[j
] = temp
;
678 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
679 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
680 indices. (Note: this does not copy glyphs, only glyph pointers in
681 row structures are moved around).
683 The algorithm used for rotating the vector was, I believe, first
684 described by Kernighan. See the vector R as consisting of two
685 sub-vectors AB, where A has length BY for BY >= 0. The result
686 after rotating is then BA. Reverse both sub-vectors to get ArBr
687 and reverse the result to get (ArBr)r which is BA. Similar for
691 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
695 /* Up (rotate left, i.e. towards lower indices). */
697 reverse_rows (matrix
, first
, first
+ by
);
698 reverse_rows (matrix
, first
+ by
, last
);
699 reverse_rows (matrix
, first
, last
);
703 /* Down (rotate right, i.e. towards higher indices). */
704 reverse_rows (matrix
, last
- by
, last
);
705 reverse_rows (matrix
, first
, last
- by
);
706 reverse_rows (matrix
, first
, last
);
711 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
712 with indices START <= index < END. Increment positions by DELTA/
716 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
717 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
719 /* Check that START and END are reasonable values. */
720 eassert (start
>= 0 && start
<= matrix
->nrows
);
721 eassert (end
>= 0 && end
<= matrix
->nrows
);
722 eassert (start
<= end
);
724 for (; start
< end
; ++start
)
725 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
729 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
730 START and END are the row indices of the first and last + 1 row to clear. */
733 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
735 eassert (start
<= end
);
736 eassert (start
>= 0 && start
< matrix
->nrows
);
737 eassert (end
>= 0 && end
<= matrix
->nrows
);
739 for (; start
< end
; ++start
)
740 matrix
->rows
[start
].enabled_p
= 0;
746 Empty all rows in MATRIX by clearing their enabled_p flags.
747 The function prepare_desired_row will eventually really clear a row
748 when it sees one with a false enabled_p flag.
750 Reset update hints to default values. The only update hint
751 currently present is the flag MATRIX->no_scrolling_p. */
754 clear_glyph_matrix (struct glyph_matrix
*matrix
)
758 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
759 matrix
->no_scrolling_p
= 0;
764 /* Shift part of the glyph matrix MATRIX of window W up or down.
765 Increment y-positions in glyph rows between START and END by DY,
766 and recompute their visible height. */
769 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
773 eassert (start
<= end
);
774 eassert (start
>= 0 && start
< matrix
->nrows
);
775 eassert (end
>= 0 && end
<= matrix
->nrows
);
777 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
778 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
780 for (; start
< end
; ++start
)
782 struct glyph_row
*row
= &matrix
->rows
[start
];
785 row
->visible_height
= row
->height
;
788 row
->visible_height
-= min_y
- row
->y
;
789 if (row
->y
+ row
->height
> max_y
)
790 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
791 if (row
->fringe_bitmap_periodic_p
)
792 row
->redraw_fringe_bitmaps_p
= 1;
797 /* Mark all rows in current matrices of frame F as invalid. Marking
798 invalid is done by setting enabled_p to zero for all rows in a
802 clear_current_matrices (register struct frame
*f
)
804 /* Clear frame current matrix, if we have one. */
805 if (f
->current_matrix
)
806 clear_glyph_matrix (f
->current_matrix
);
808 /* Clear the matrix of the menu bar window, if such a window exists.
809 The menu bar window is currently used to display menus on X when
810 no toolkit support is compiled in. */
811 if (WINDOWP (f
->menu_bar_window
))
812 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
814 /* Clear the matrix of the tool-bar window, if any. */
815 if (WINDOWP (f
->tool_bar_window
))
816 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
818 /* Clear current window matrices. */
819 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
820 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
824 /* Clear out all display lines of F for a coming redisplay. */
827 clear_desired_matrices (register struct frame
*f
)
829 if (f
->desired_matrix
)
830 clear_glyph_matrix (f
->desired_matrix
);
832 if (WINDOWP (f
->menu_bar_window
))
833 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
835 if (WINDOWP (f
->tool_bar_window
))
836 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
838 /* Do it for window matrices. */
839 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
840 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
844 /* Clear matrices in window tree rooted in W. If DESIRED_P,
845 clear desired matrices, otherwise clear current matrices. */
848 clear_window_matrices (struct window
*w
, bool desired_p
)
852 if (!NILP (w
->hchild
))
854 eassert (WINDOWP (w
->hchild
));
855 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
857 else if (!NILP (w
->vchild
))
859 eassert (WINDOWP (w
->vchild
));
860 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
865 clear_glyph_matrix (w
->desired_matrix
);
868 clear_glyph_matrix (w
->current_matrix
);
869 wset_window_end_valid (w
, Qnil
);
873 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
879 /***********************************************************************
882 See dispextern.h for an overall explanation of glyph rows.
883 ***********************************************************************/
885 /* Clear glyph row ROW. Do it in a way that makes it robust against
886 changes in the glyph_row structure, i.e. addition or removal of
887 structure members. */
889 static struct glyph_row null_row
;
892 clear_glyph_row (struct glyph_row
*row
)
894 struct glyph
*p
[1 + LAST_AREA
];
897 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
898 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
899 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
900 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
905 /* Restore pointers. */
906 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
907 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
908 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
909 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
911 #if 0 /* At some point, some bit-fields of struct glyph were not set,
912 which made glyphs unequal when compared with GLYPH_EQUAL_P.
913 Redisplay outputs such glyphs, and flickering effects were
914 the result. This also depended on the contents of memory
915 returned by xmalloc. If flickering happens again, activate
916 the code below. If the flickering is gone with that, chances
917 are that the flickering has the same reason as here. */
918 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
923 /* Make ROW an empty, enabled row of canonical character height,
924 in window W starting at y-position Y. */
927 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
931 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
932 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
934 clear_glyph_row (row
);
936 row
->ascent
= row
->phys_ascent
= 0;
937 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
938 row
->visible_height
= row
->height
;
941 row
->visible_height
-= min_y
- row
->y
;
942 if (row
->y
+ row
->height
> max_y
)
943 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
949 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
950 are the amounts by which to change positions. Note that the first
951 glyph of the text area of a row can have a buffer position even if
952 the used count of the text area is zero. Such rows display line
956 increment_row_positions (struct glyph_row
*row
,
957 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
961 /* Increment start and end positions. */
962 MATRIX_ROW_START_CHARPOS (row
) += delta
;
963 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
964 MATRIX_ROW_END_CHARPOS (row
) += delta
;
965 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
966 CHARPOS (row
->start
.pos
) += delta
;
967 BYTEPOS (row
->start
.pos
) += delta_bytes
;
968 CHARPOS (row
->end
.pos
) += delta
;
969 BYTEPOS (row
->end
.pos
) += delta_bytes
;
974 /* Increment positions in glyphs. */
975 for (area
= 0; area
< LAST_AREA
; ++area
)
976 for (i
= 0; i
< row
->used
[area
]; ++i
)
977 if (BUFFERP (row
->glyphs
[area
][i
].object
)
978 && row
->glyphs
[area
][i
].charpos
> 0)
979 row
->glyphs
[area
][i
].charpos
+= delta
;
981 /* Capture the case of rows displaying a line end. */
982 if (row
->used
[TEXT_AREA
] == 0
983 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
984 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
989 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
990 contents, i.e. glyph structure contents are exchanged between A and
991 B without changing glyph pointers in A and B. */
994 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
998 for (area
= 0; area
< LAST_AREA
; ++area
)
1000 /* Number of glyphs to swap. */
1001 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1003 /* Start of glyphs in area of row A. */
1004 struct glyph
*glyph_a
= a
->glyphs
[area
];
1006 /* End + 1 of glyphs in area of row A. */
1007 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1009 /* Start of glyphs in area of row B. */
1010 struct glyph
*glyph_b
= b
->glyphs
[area
];
1012 while (glyph_a
< glyph_a_end
)
1014 /* Non-ISO HP/UX compiler doesn't like auto struct
1018 *glyph_a
= *glyph_b
;
1028 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1029 exchange the used[] array and the hash values of the rows, because
1030 these should all go together for the row's hash value to be
1034 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1037 unsigned hash_tem
= a
->hash
;
1039 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1041 struct glyph
*temp
= a
->glyphs
[i
];
1043 a
->glyphs
[i
] = b
->glyphs
[i
];
1044 b
->glyphs
[i
] = temp
;
1047 short used_tem
= a
->used
[i
];
1049 a
->used
[i
] = b
->used
[i
];
1050 b
->used
[i
] = used_tem
;
1058 /* Copy glyph row structure FROM to glyph row structure TO, except
1059 that glyph pointers, the `used' counts, and the hash values in the
1060 structures are left unchanged. */
1063 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1065 struct glyph
*pointers
[1 + LAST_AREA
];
1066 short used
[LAST_AREA
];
1069 /* Save glyph pointers of TO. */
1070 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1071 memcpy (used
, to
->used
, sizeof to
->used
);
1074 /* Do a structure assignment. */
1077 /* Restore original pointers of TO. */
1078 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1079 memcpy (to
->used
, used
, sizeof to
->used
);
1084 /* Assign glyph row FROM to glyph row TO. This works like a structure
1085 assignment TO = FROM, except that glyph pointers are not copied but
1086 exchanged between TO and FROM. Pointers must be exchanged to avoid
1090 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1092 swap_glyph_pointers (to
, from
);
1093 copy_row_except_pointers (to
, from
);
1097 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1098 a row in a window matrix, is a slice of the glyph memory of the
1099 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1100 is true if the glyph memory of WINDOW_ROW is part of the glyph
1101 memory of FRAME_ROW. */
1106 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1108 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1109 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1110 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1112 return (frame_glyph_start
<= window_glyph_start
1113 && window_glyph_start
< frame_glyph_end
);
1116 #endif /* GLYPH_DEBUG */
1120 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1121 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1122 in WINDOW_MATRIX is found satisfying the condition. */
1124 static struct glyph_row
*
1125 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1126 struct glyph_matrix
*frame_matrix
, int row
)
1130 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1132 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1133 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1134 frame_matrix
->rows
+ row
))
1137 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1142 /* Prepare ROW for display. Desired rows are cleared lazily,
1143 i.e. they are only marked as to be cleared by setting their
1144 enabled_p flag to zero. When a row is to be displayed, a prior
1145 call to this function really clears it. */
1148 prepare_desired_row (struct glyph_row
*row
)
1150 if (!row
->enabled_p
)
1152 bool rp
= row
->reversed_p
;
1154 clear_glyph_row (row
);
1156 row
->reversed_p
= rp
;
1161 /* Return a hash code for glyph row ROW. */
1164 line_hash_code (struct glyph_row
*row
)
1170 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1171 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1175 int c
= glyph
->u
.ch
;
1176 int face_id
= glyph
->face_id
;
1177 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1179 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1180 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1192 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1193 the number of characters in the line. If must_write_spaces is
1194 zero, leading and trailing spaces are ignored. */
1197 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1199 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1200 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1201 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1203 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1204 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1206 /* Ignore trailing and leading spaces if we can. */
1207 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1209 /* Skip from the end over trailing spaces. */
1210 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1213 /* All blank line. */
1217 /* Skip over leading spaces. */
1218 while (CHAR_GLYPH_SPACE_P (*beg
))
1222 /* If we don't have a glyph-table, each glyph is one character,
1223 so return the number of glyphs. */
1224 if (glyph_table_base
== 0)
1228 /* Otherwise, scan the glyphs and accumulate their total length
1235 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1237 if (GLYPH_INVALID_P (g
)
1238 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1241 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1251 /* Return true if the glyph rows A and B have equal contents.
1252 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1255 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1257 eassert (verify_row_hash (a
));
1258 eassert (verify_row_hash (b
));
1262 else if (a
->hash
!= b
->hash
)
1266 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1269 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1272 /* Compare glyphs. */
1273 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1275 if (a
->used
[area
] != b
->used
[area
])
1278 a_glyph
= a
->glyphs
[area
];
1279 a_end
= a_glyph
+ a
->used
[area
];
1280 b_glyph
= b
->glyphs
[area
];
1282 while (a_glyph
< a_end
1283 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1284 ++a_glyph
, ++b_glyph
;
1286 if (a_glyph
!= a_end
)
1290 if (a
->fill_line_p
!= b
->fill_line_p
1291 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1292 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1293 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1294 || a
->left_fringe_offset
!= b
->left_fringe_offset
1295 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1296 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1297 || a
->right_fringe_offset
!= b
->right_fringe_offset
1298 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1299 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1300 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1301 || a
->overlapped_p
!= b
->overlapped_p
1302 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1303 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1304 || a
->reversed_p
!= b
->reversed_p
1305 /* Different partially visible characters on left margin. */
1307 /* Different height. */
1308 || a
->ascent
!= b
->ascent
1309 || a
->phys_ascent
!= b
->phys_ascent
1310 || a
->phys_height
!= b
->phys_height
1311 || a
->visible_height
!= b
->visible_height
)
1320 /***********************************************************************
1323 See dispextern.h for an overall explanation of glyph pools.
1324 ***********************************************************************/
1326 /* Allocate a glyph_pool structure. The structure returned is
1327 initialized with zeros. The global variable glyph_pool_count is
1328 incremented for each pool allocated. */
1330 static struct glyph_pool
*
1331 new_glyph_pool (void)
1333 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1335 /* For memory leak and double deletion checking. */
1342 /* Free a glyph_pool structure POOL. The function may be called with
1343 a null POOL pointer. The global variable glyph_pool_count is
1344 decremented with every pool structure freed. If this count gets
1345 negative, more structures were freed than allocated, i.e. one
1346 structure must have been freed more than once or a bogus pointer
1347 was passed to free_glyph_pool. */
1350 free_glyph_pool (struct glyph_pool
*pool
)
1354 /* More freed than allocated? */
1356 eassert (glyph_pool_count
>= 0);
1358 xfree (pool
->glyphs
);
1364 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1365 columns we need. This function never shrinks a pool. The only
1366 case in which this would make sense, would be when a frame's size
1367 is changed from a large value to a smaller one. But, if someone
1368 does it once, we can expect that he will do it again.
1370 Return true if the pool changed in a way which makes
1371 re-adjusting window glyph matrices necessary. */
1374 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1379 changed_p
= (pool
->glyphs
== 0
1380 || matrix_dim
.height
!= pool
->nrows
1381 || matrix_dim
.width
!= pool
->ncolumns
);
1383 /* Enlarge the glyph pool. */
1384 needed
= matrix_dim
.width
;
1385 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1386 memory_full (SIZE_MAX
);
1387 needed
*= matrix_dim
.height
;
1388 if (needed
> pool
->nglyphs
)
1390 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1391 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1392 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1393 memset (pool
->glyphs
+ old_nglyphs
, 0,
1394 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1397 /* Remember the number of rows and columns because (a) we use them
1398 to do sanity checks, and (b) the number of columns determines
1399 where rows in the frame matrix start---this must be available to
1400 determine pointers to rows of window sub-matrices. */
1401 pool
->nrows
= matrix_dim
.height
;
1402 pool
->ncolumns
= matrix_dim
.width
;
1409 /***********************************************************************
1411 ***********************************************************************/
1416 /* Flush standard output. This is sometimes useful to call from the debugger.
1417 XXX Maybe this should be changed to flush the current terminal instead of
1421 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1430 /* Check that no glyph pointers have been lost in MATRIX. If a
1431 pointer has been lost, e.g. by using a structure assignment between
1432 rows, at least one pointer must occur more than once in the rows of
1436 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1440 for (i
= 0; i
< matrix
->nrows
; ++i
)
1441 for (j
= 0; j
< matrix
->nrows
; ++j
)
1443 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1444 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1448 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1451 matrix_row (struct glyph_matrix
*matrix
, int row
)
1453 eassert (matrix
&& matrix
->rows
);
1454 eassert (row
>= 0 && row
< matrix
->nrows
);
1456 /* That's really too slow for normal testing because this function
1457 is called almost everywhere. Although---it's still astonishingly
1458 fast, so it is valuable to have for debugging purposes. */
1460 check_matrix_pointer_lossage (matrix
);
1463 return matrix
->rows
+ row
;
1467 #if 0 /* This function makes invalid assumptions when text is
1468 partially invisible. But it might come handy for debugging
1471 /* Check invariants that must hold for an up to date current matrix of
1475 check_matrix_invariants (struct window
*w
)
1477 struct glyph_matrix
*matrix
= w
->current_matrix
;
1478 int yb
= window_text_bottom_y (w
);
1479 struct glyph_row
*row
= matrix
->rows
;
1480 struct glyph_row
*last_text_row
= NULL
;
1481 struct buffer
*saved
= current_buffer
;
1482 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1485 /* This can sometimes happen for a fresh window. */
1486 if (matrix
->nrows
< 2)
1489 set_buffer_temp (buffer
);
1491 /* Note: last row is always reserved for the mode line. */
1492 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1493 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1495 struct glyph_row
*next
= row
+ 1;
1497 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1498 last_text_row
= row
;
1500 /* Check that character and byte positions are in sync. */
1501 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1502 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1503 eassert (BYTEPOS (row
->start
.pos
)
1504 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1506 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1507 have such a position temporarily in case of a minibuffer
1508 displaying something like `[Sole completion]' at its end. */
1509 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1511 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1512 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1513 eassert (BYTEPOS (row
->end
.pos
)
1514 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1517 /* Check that end position of `row' is equal to start position
1519 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1521 eassert (MATRIX_ROW_END_CHARPOS (row
)
1522 == MATRIX_ROW_START_CHARPOS (next
));
1523 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1524 == MATRIX_ROW_START_BYTEPOS (next
));
1525 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1526 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1531 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1532 eassert (w
->desired_matrix
->rows
!= NULL
);
1533 set_buffer_temp (saved
);
1538 #endif /* GLYPH_DEBUG */
1542 /**********************************************************************
1543 Allocating/ Adjusting Glyph Matrices
1544 **********************************************************************/
1546 /* Allocate glyph matrices over a window tree for a frame-based
1549 X and Y are column/row within the frame glyph matrix where
1550 sub-matrices for the window tree rooted at WINDOW must be
1551 allocated. DIM_ONLY_P means that the caller of this
1552 function is only interested in the result matrix dimension, and
1553 matrix adjustments should not be performed.
1555 The function returns the total width/height of the sub-matrices of
1556 the window tree. If called on a frame root window, the computation
1557 will take the mini-buffer window into account.
1559 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1561 NEW_LEAF_MATRIX set if any window in the tree did not have a
1562 glyph matrices yet, and
1564 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1565 any window in the tree will be changed or have been changed (see
1568 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1571 Windows are arranged into chains of windows on the same level
1572 through the next fields of window structures. Such a level can be
1573 either a sequence of horizontally adjacent windows from left to
1574 right, or a sequence of vertically adjacent windows from top to
1575 bottom. Each window in a horizontal sequence can be either a leaf
1576 window or a vertical sequence; a window in a vertical sequence can
1577 be either a leaf or a horizontal sequence. All windows in a
1578 horizontal sequence have the same height, and all windows in a
1579 vertical sequence have the same width.
1581 This function uses, for historical reasons, a more general
1582 algorithm to determine glyph matrix dimensions that would be
1585 The matrix height of a horizontal sequence is determined by the
1586 maximum height of any matrix in the sequence. The matrix width of
1587 a horizontal sequence is computed by adding up matrix widths of
1588 windows in the sequence.
1590 |<------- result width ------->|
1591 +---------+----------+---------+ ---
1594 +---------+ | | result height
1599 The matrix width of a vertical sequence is the maximum matrix width
1600 of any window in the sequence. Its height is computed by adding up
1601 matrix heights of windows in the sequence.
1603 |<---- result width -->|
1611 +------------+---------+ |
1614 +------------+---------+ --- */
1616 /* Bit indicating that a new matrix will be allocated or has been
1619 #define NEW_LEAF_MATRIX (1 << 0)
1621 /* Bit indicating that a matrix will or has changed its location or
1624 #define CHANGED_LEAF_MATRIX (1 << 1)
1627 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1628 bool dim_only_p
, int *window_change_flags
)
1630 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1632 int wmax
= 0, hmax
= 0;
1636 bool in_horz_combination_p
;
1638 /* What combination is WINDOW part of? Compute this once since the
1639 result is the same for all windows in the `next' chain. The
1640 special case of a root window (parent equal to nil) is treated
1641 like a vertical combination because a root window's `next'
1642 points to the mini-buffer window, if any, which is arranged
1643 vertically below other windows. */
1644 in_horz_combination_p
1645 = (!NILP (XWINDOW (window
)->parent
)
1646 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1648 /* For WINDOW and all windows on the same level. */
1651 w
= XWINDOW (window
);
1653 /* Get the dimension of the window sub-matrix for W, depending
1654 on whether this is a combination or a leaf window. */
1655 if (!NILP (w
->hchild
))
1656 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1658 window_change_flags
);
1659 else if (!NILP (w
->vchild
))
1660 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1662 window_change_flags
);
1665 /* If not already done, allocate sub-matrix structures. */
1666 if (w
->desired_matrix
== NULL
)
1668 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1669 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1670 *window_change_flags
|= NEW_LEAF_MATRIX
;
1673 /* Width and height MUST be chosen so that there are no
1674 holes in the frame matrix. */
1675 dim
.width
= required_matrix_width (w
);
1676 dim
.height
= required_matrix_height (w
);
1678 /* Will matrix be re-allocated? */
1679 if (x
!= w
->desired_matrix
->matrix_x
1680 || y
!= w
->desired_matrix
->matrix_y
1681 || dim
.width
!= w
->desired_matrix
->matrix_w
1682 || dim
.height
!= w
->desired_matrix
->matrix_h
1683 || (margin_glyphs_to_reserve (w
, dim
.width
,
1684 w
->left_margin_cols
)
1685 != w
->desired_matrix
->left_margin_glyphs
)
1686 || (margin_glyphs_to_reserve (w
, dim
.width
,
1687 w
->right_margin_cols
)
1688 != w
->desired_matrix
->right_margin_glyphs
))
1689 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1691 /* Actually change matrices, if allowed. Do not consider
1692 CHANGED_LEAF_MATRIX computed above here because the pool
1693 may have been changed which we don't now here. We trust
1694 that we only will be called with DIM_ONLY_P when
1698 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1699 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1703 /* If we are part of a horizontal combination, advance x for
1704 windows to the right of W; otherwise advance y for windows
1706 if (in_horz_combination_p
)
1711 /* Remember maximum glyph matrix dimensions. */
1712 wmax
= max (wmax
, dim
.width
);
1713 hmax
= max (hmax
, dim
.height
);
1715 /* Next window on same level. */
1718 while (!NILP (window
));
1720 /* Set `total' to the total glyph matrix dimension of this window
1721 level. In a vertical combination, the width is the width of the
1722 widest window; the height is the y we finally reached, corrected
1723 by the y we started with. In a horizontal combination, the total
1724 height is the height of the tallest window, and the width is the
1725 x we finally reached, corrected by the x we started with. */
1726 if (in_horz_combination_p
)
1728 total
.width
= x
- x0
;
1729 total
.height
= hmax
;
1734 total
.height
= y
- y0
;
1741 /* Return the required height of glyph matrices for window W. */
1744 required_matrix_height (struct window
*w
)
1746 #ifdef HAVE_WINDOW_SYSTEM
1747 struct frame
*f
= XFRAME (w
->frame
);
1749 if (FRAME_WINDOW_P (f
))
1751 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1752 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1753 return (((window_pixel_height
+ ch_height
- 1)
1754 / ch_height
) * w
->nrows_scale_factor
1755 /* One partially visible line at the top and
1756 bottom of the window. */
1758 /* 2 for header and mode line. */
1761 #endif /* HAVE_WINDOW_SYSTEM */
1763 return WINDOW_TOTAL_LINES (w
);
1767 /* Return the required width of glyph matrices for window W. */
1770 required_matrix_width (struct window
*w
)
1772 #ifdef HAVE_WINDOW_SYSTEM
1773 struct frame
*f
= XFRAME (w
->frame
);
1774 if (FRAME_WINDOW_P (f
))
1776 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1777 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1779 /* Compute number of glyphs needed in a glyph row. */
1780 return (((window_pixel_width
+ ch_width
- 1)
1781 / ch_width
) * w
->ncols_scale_factor
1782 /* 2 partially visible columns in the text area. */
1784 /* One partially visible column at the right
1785 edge of each marginal area. */
1788 #endif /* HAVE_WINDOW_SYSTEM */
1790 return XINT (w
->total_cols
);
1794 /* Allocate window matrices for window-based redisplay. W is the
1795 window whose matrices must be allocated/reallocated. */
1798 allocate_matrices_for_window_redisplay (struct window
*w
)
1802 if (!NILP (w
->vchild
))
1803 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1804 else if (!NILP (w
->hchild
))
1805 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1808 /* W is a leaf window. */
1811 /* If matrices are not yet allocated, allocate them now. */
1812 if (w
->desired_matrix
== NULL
)
1814 w
->desired_matrix
= new_glyph_matrix (NULL
);
1815 w
->current_matrix
= new_glyph_matrix (NULL
);
1818 dim
.width
= required_matrix_width (w
);
1819 dim
.height
= required_matrix_height (w
);
1820 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1821 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1824 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1829 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1830 do it for all frames; otherwise do it just for the given frame.
1831 This function must be called when a new frame is created, its size
1832 changes, or its window configuration changes. */
1835 adjust_glyphs (struct frame
*f
)
1837 /* Block input so that expose events and other events that access
1838 glyph matrices are not processed while we are changing them. */
1842 adjust_frame_glyphs (f
);
1845 Lisp_Object tail
, lisp_frame
;
1847 FOR_EACH_FRAME (tail
, lisp_frame
)
1848 adjust_frame_glyphs (XFRAME (lisp_frame
));
1855 /* Adjust frame glyphs when Emacs is initialized.
1857 To be called from init_display.
1859 We need a glyph matrix because redraw will happen soon.
1860 Unfortunately, window sizes on selected_frame are not yet set to
1861 meaningful values. I believe we can assume that there are only two
1862 windows on the frame---the mini-buffer and the root window. Frame
1863 height and width seem to be correct so far. So, set the sizes of
1864 windows to estimated values. */
1867 adjust_frame_glyphs_initially (void)
1869 struct frame
*sf
= SELECTED_FRAME ();
1870 struct window
*root
= XWINDOW (sf
->root_window
);
1871 struct window
*mini
= XWINDOW (root
->next
);
1872 int frame_lines
= FRAME_LINES (sf
);
1873 int frame_cols
= FRAME_COLS (sf
);
1874 int top_margin
= FRAME_TOP_MARGIN (sf
);
1876 /* Do it for the root window. */
1877 wset_top_line (root
, make_number (top_margin
));
1878 wset_total_lines (root
, make_number (frame_lines
- 1 - top_margin
));
1879 wset_total_cols (root
, make_number (frame_cols
));
1881 /* Do it for the mini-buffer window. */
1882 wset_top_line (mini
, make_number (frame_lines
- 1));
1883 wset_total_lines (mini
, make_number (1));
1884 wset_total_cols (mini
, make_number (frame_cols
));
1886 adjust_frame_glyphs (sf
);
1887 glyphs_initialized_initially_p
= 1;
1891 /* Allocate/reallocate glyph matrices of a single frame F. */
1894 adjust_frame_glyphs (struct frame
*f
)
1896 if (FRAME_WINDOW_P (f
))
1897 adjust_frame_glyphs_for_window_redisplay (f
);
1899 adjust_frame_glyphs_for_frame_redisplay (f
);
1901 /* Don't forget the message buffer and the buffer for
1902 decode_mode_spec. */
1903 adjust_frame_message_buffer (f
);
1904 adjust_decode_mode_spec_buffer (f
);
1906 f
->glyphs_initialized_p
= 1;
1909 /* Return true if any window in the tree has nonzero window margins. See
1910 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1912 showing_window_margins_p (struct window
*w
)
1916 if (!NILP (w
->hchild
))
1918 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1921 else if (!NILP (w
->vchild
))
1923 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1926 else if (!NILP (w
->left_margin_cols
)
1927 || !NILP (w
->right_margin_cols
))
1930 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1936 /* In the window tree with root W, build current matrices of leaf
1937 windows from the frame's current matrix. */
1940 fake_current_matrices (Lisp_Object window
)
1944 for (; !NILP (window
); window
= w
->next
)
1946 w
= XWINDOW (window
);
1948 if (!NILP (w
->hchild
))
1949 fake_current_matrices (w
->hchild
);
1950 else if (!NILP (w
->vchild
))
1951 fake_current_matrices (w
->vchild
);
1955 struct frame
*f
= XFRAME (w
->frame
);
1956 struct glyph_matrix
*m
= w
->current_matrix
;
1957 struct glyph_matrix
*fm
= f
->current_matrix
;
1959 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1960 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1962 for (i
= 0; i
< m
->matrix_h
; ++i
)
1964 struct glyph_row
*r
= m
->rows
+ i
;
1965 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1967 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1968 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1970 r
->enabled_p
= fr
->enabled_p
;
1973 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1974 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1975 r
->used
[TEXT_AREA
] = (m
->matrix_w
1976 - r
->used
[LEFT_MARGIN_AREA
]
1977 - r
->used
[RIGHT_MARGIN_AREA
]);
1986 /* Save away the contents of frame F's current frame matrix. Value is
1987 a glyph matrix holding the contents of F's current frame matrix. */
1989 static struct glyph_matrix
*
1990 save_current_matrix (struct frame
*f
)
1993 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1994 saved
->nrows
= f
->current_matrix
->nrows
;
1995 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1997 for (i
= 0; i
< saved
->nrows
; ++i
)
1999 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2000 struct glyph_row
*to
= saved
->rows
+ i
;
2001 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2002 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
2003 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2004 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2011 /* Restore the contents of frame F's current frame matrix from SAVED,
2012 and free memory associated with SAVED. */
2015 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2019 for (i
= 0; i
< saved
->nrows
; ++i
)
2021 struct glyph_row
*from
= saved
->rows
+ i
;
2022 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2023 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2024 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2025 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2026 xfree (from
->glyphs
[TEXT_AREA
]);
2029 xfree (saved
->rows
);
2035 /* Allocate/reallocate glyph matrices of a single frame F for
2036 frame-based redisplay. */
2039 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2041 struct dim matrix_dim
;
2042 bool pool_changed_p
;
2043 int window_change_flags
;
2046 if (!FRAME_LIVE_P (f
))
2049 top_window_y
= FRAME_TOP_MARGIN (f
);
2051 /* Allocate glyph pool structures if not already done. */
2052 if (f
->desired_pool
== NULL
)
2054 f
->desired_pool
= new_glyph_pool ();
2055 f
->current_pool
= new_glyph_pool ();
2058 /* Allocate frames matrix structures if needed. */
2059 if (f
->desired_matrix
== NULL
)
2061 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2062 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2065 /* Compute window glyph matrices. (This takes the mini-buffer
2066 window into account). The result is the size of the frame glyph
2067 matrix needed. The variable window_change_flags is set to a bit
2068 mask indicating whether new matrices will be allocated or
2069 existing matrices change their size or location within the frame
2071 window_change_flags
= 0;
2073 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2076 &window_change_flags
);
2078 /* Add in menu bar lines, if any. */
2079 matrix_dim
.height
+= top_window_y
;
2081 /* Enlarge pools as necessary. */
2082 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2083 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2085 /* Set up glyph pointers within window matrices. Do this only if
2086 absolutely necessary since it requires a frame redraw. */
2087 if (pool_changed_p
|| window_change_flags
)
2089 /* Do it for window matrices. */
2090 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2092 &window_change_flags
);
2094 /* Size of frame matrices must equal size of frame. Note
2095 that we are called for X frames with window widths NOT equal
2096 to the frame width (from CHANGE_FRAME_SIZE_1). */
2097 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2098 && matrix_dim
.height
== FRAME_LINES (f
));
2100 /* Pointers to glyph memory in glyph rows are exchanged during
2101 the update phase of redisplay, which means in general that a
2102 frame's current matrix consists of pointers into both the
2103 desired and current glyph pool of the frame. Adjusting a
2104 matrix sets the frame matrix up so that pointers are all into
2105 the same pool. If we want to preserve glyph contents of the
2106 current matrix over a call to adjust_glyph_matrix, we must
2107 make a copy of the current glyphs, and restore the current
2108 matrix' contents from that copy. */
2109 if (display_completed
2110 && !FRAME_GARBAGED_P (f
)
2111 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2112 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2113 /* For some reason, the frame glyph matrix gets corrupted if
2114 any of the windows contain margins. I haven't been able
2115 to hunt down the reason, but for the moment this prevents
2116 the problem from manifesting. -- cyd */
2117 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2119 struct glyph_matrix
*copy
= save_current_matrix (f
);
2120 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2121 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2122 restore_current_matrix (f
, copy
);
2123 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2127 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2128 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2129 SET_FRAME_GARBAGED (f
);
2135 /* Allocate/reallocate glyph matrices of a single frame F for
2136 window-based redisplay. */
2139 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2141 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2143 /* Allocate/reallocate window matrices. */
2144 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2146 #ifdef HAVE_X_WINDOWS
2147 /* Allocate/ reallocate matrices of the dummy window used to display
2148 the menu bar under X when no X toolkit support is available. */
2149 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2151 /* Allocate a dummy window if not already done. */
2153 if (NILP (f
->menu_bar_window
))
2156 fset_menu_bar_window (f
, make_window ());
2157 w
= XWINDOW (f
->menu_bar_window
);
2158 XSETFRAME (frame
, f
);
2159 wset_frame (w
, frame
);
2160 w
->pseudo_window_p
= 1;
2163 w
= XWINDOW (f
->menu_bar_window
);
2165 /* Set window dimensions to frame dimensions and allocate or
2166 adjust glyph matrices of W. */
2167 wset_top_line (w
, make_number (0));
2168 wset_left_col (w
, make_number (0));
2169 wset_total_lines (w
, make_number (FRAME_MENU_BAR_LINES (f
)));
2170 wset_total_cols (w
, make_number (FRAME_TOTAL_COLS (f
)));
2171 allocate_matrices_for_window_redisplay (w
);
2173 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2174 #endif /* HAVE_X_WINDOWS */
2178 /* Allocate/ reallocate matrices of the tool bar window. If we
2179 don't have a tool bar window yet, make one. */
2181 if (NILP (f
->tool_bar_window
))
2184 fset_tool_bar_window (f
, make_window ());
2185 w
= XWINDOW (f
->tool_bar_window
);
2186 XSETFRAME (frame
, f
);
2187 wset_frame (w
, frame
);
2188 w
->pseudo_window_p
= 1;
2191 w
= XWINDOW (f
->tool_bar_window
);
2193 wset_top_line (w
, make_number (FRAME_MENU_BAR_LINES (f
)));
2194 wset_left_col (w
, make_number (0));
2195 wset_total_lines (w
, make_number (FRAME_TOOL_BAR_LINES (f
)));
2196 wset_total_cols (w
, make_number (FRAME_TOTAL_COLS (f
)));
2197 allocate_matrices_for_window_redisplay (w
);
2203 /* Adjust/ allocate message buffer of frame F.
2205 Note that the message buffer is never freed. Since I could not
2206 find a free in 19.34, I assume that freeing it would be
2207 problematic in some way and don't do it either.
2209 (Implementation note: It should be checked if we can free it
2210 eventually without causing trouble). */
2213 adjust_frame_message_buffer (struct frame
*f
)
2215 FRAME_MESSAGE_BUF (f
) = xrealloc (FRAME_MESSAGE_BUF (f
),
2216 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2220 /* Re-allocate buffer for decode_mode_spec on frame F. */
2223 adjust_decode_mode_spec_buffer (struct frame
*f
)
2225 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2226 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2231 /**********************************************************************
2232 Freeing Glyph Matrices
2233 **********************************************************************/
2235 /* Free glyph memory for a frame F. F may be null. This function can
2236 be called for the same frame more than once. The root window of
2237 F may be nil when this function is called. This is the case when
2238 the function is called when F is destroyed. */
2241 free_glyphs (struct frame
*f
)
2243 if (f
&& f
->glyphs_initialized_p
)
2245 /* Block interrupt input so that we don't get surprised by an X
2246 event while we're in an inconsistent state. */
2248 f
->glyphs_initialized_p
= 0;
2250 /* Release window sub-matrices. */
2251 if (!NILP (f
->root_window
))
2252 free_window_matrices (XWINDOW (f
->root_window
));
2254 /* Free the dummy window for menu bars without X toolkit and its
2256 if (!NILP (f
->menu_bar_window
))
2258 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2259 free_glyph_matrix (w
->desired_matrix
);
2260 free_glyph_matrix (w
->current_matrix
);
2261 w
->desired_matrix
= w
->current_matrix
= NULL
;
2262 fset_menu_bar_window (f
, Qnil
);
2265 /* Free the tool bar window and its glyph matrices. */
2266 if (!NILP (f
->tool_bar_window
))
2268 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2269 free_glyph_matrix (w
->desired_matrix
);
2270 free_glyph_matrix (w
->current_matrix
);
2271 w
->desired_matrix
= w
->current_matrix
= NULL
;
2272 fset_tool_bar_window (f
, Qnil
);
2275 /* Release frame glyph matrices. Reset fields to zero in
2276 case we are called a second time. */
2277 if (f
->desired_matrix
)
2279 free_glyph_matrix (f
->desired_matrix
);
2280 free_glyph_matrix (f
->current_matrix
);
2281 f
->desired_matrix
= f
->current_matrix
= NULL
;
2284 /* Release glyph pools. */
2285 if (f
->desired_pool
)
2287 free_glyph_pool (f
->desired_pool
);
2288 free_glyph_pool (f
->current_pool
);
2289 f
->desired_pool
= f
->current_pool
= NULL
;
2297 /* Free glyph sub-matrices in the window tree rooted at W. This
2298 function may be called with a null pointer, and it may be called on
2299 the same tree more than once. */
2302 free_window_matrices (struct window
*w
)
2306 if (!NILP (w
->hchild
))
2307 free_window_matrices (XWINDOW (w
->hchild
));
2308 else if (!NILP (w
->vchild
))
2309 free_window_matrices (XWINDOW (w
->vchild
));
2312 /* This is a leaf window. Free its memory and reset fields
2313 to zero in case this function is called a second time for
2315 free_glyph_matrix (w
->current_matrix
);
2316 free_glyph_matrix (w
->desired_matrix
);
2317 w
->current_matrix
= w
->desired_matrix
= NULL
;
2320 /* Next window on same level. */
2321 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2326 /* Check glyph memory leaks. This function is called from
2327 shut_down_emacs. Note that frames are not destroyed when Emacs
2328 exits. We therefore free all glyph memory for all active frames
2329 explicitly and check that nothing is left allocated. */
2332 check_glyph_memory (void)
2334 Lisp_Object tail
, frame
;
2336 /* Free glyph memory for all frames. */
2337 FOR_EACH_FRAME (tail
, frame
)
2338 free_glyphs (XFRAME (frame
));
2340 /* Check that nothing is left allocated. */
2341 if (glyph_matrix_count
)
2343 if (glyph_pool_count
)
2349 /**********************************************************************
2350 Building a Frame Matrix
2351 **********************************************************************/
2353 /* Most of the redisplay code works on glyph matrices attached to
2354 windows. This is a good solution most of the time, but it is not
2355 suitable for terminal code. Terminal output functions cannot rely
2356 on being able to set an arbitrary terminal window. Instead they
2357 must be provided with a view of the whole frame, i.e. the whole
2358 screen. We build such a view by constructing a frame matrix from
2359 window matrices in this section.
2361 Windows that must be updated have their must_be_update_p flag set.
2362 For all such windows, their desired matrix is made part of the
2363 desired frame matrix. For other windows, their current matrix is
2364 made part of the desired frame matrix.
2366 +-----------------+----------------+
2367 | desired | desired |
2369 +-----------------+----------------+
2372 +----------------------------------+
2374 Desired window matrices can be made part of the frame matrix in a
2375 cheap way: We exploit the fact that the desired frame matrix and
2376 desired window matrices share their glyph memory. This is not
2377 possible for current window matrices. Their glyphs are copied to
2378 the desired frame matrix. The latter is equivalent to
2379 preserve_other_columns in the old redisplay.
2381 Used glyphs counters for frame matrix rows are the result of adding
2382 up glyph lengths of the window matrices. A line in the frame
2383 matrix is enabled, if a corresponding line in a window matrix is
2386 After building the desired frame matrix, it will be passed to
2387 terminal code, which will manipulate both the desired and current
2388 frame matrix. Changes applied to the frame's current matrix have
2389 to be visible in current window matrices afterwards, of course.
2391 This problem is solved like this:
2393 1. Window and frame matrices share glyphs. Window matrices are
2394 constructed in a way that their glyph contents ARE the glyph
2395 contents needed in a frame matrix. Thus, any modification of
2396 glyphs done in terminal code will be reflected in window matrices
2399 2. Exchanges of rows in a frame matrix done by terminal code are
2400 intercepted by hook functions so that corresponding row operations
2401 on window matrices can be performed. This is necessary because we
2402 use pointers to glyphs in glyph row structures. To satisfy the
2403 assumption of point 1 above that glyphs are updated implicitly in
2404 window matrices when they are manipulated via the frame matrix,
2405 window and frame matrix must of course agree where to find the
2406 glyphs for their rows. Possible manipulations that must be
2407 mirrored are assignments of rows of the desired frame matrix to the
2408 current frame matrix and scrolling the current frame matrix. */
2410 /* Build frame F's desired matrix from window matrices. Only windows
2411 which have the flag must_be_updated_p set have to be updated. Menu
2412 bar lines of a frame are not covered by window matrices, so make
2413 sure not to touch them in this function. */
2416 build_frame_matrix (struct frame
*f
)
2420 /* F must have a frame matrix when this function is called. */
2421 eassert (!FRAME_WINDOW_P (f
));
2423 /* Clear all rows in the frame matrix covered by window matrices.
2424 Menu bar lines are not covered by windows. */
2425 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2426 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2428 /* Build the matrix by walking the window tree. */
2429 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2430 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2434 /* Walk a window tree, building a frame matrix MATRIX from window
2435 matrices. W is the root of a window tree. */
2438 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2442 if (!NILP (w
->hchild
))
2443 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2444 else if (!NILP (w
->vchild
))
2445 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2447 build_frame_matrix_from_leaf_window (matrix
, w
);
2449 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2454 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2455 desired frame matrix built. W is a leaf window whose desired or
2456 current matrix is to be added to FRAME_MATRIX. W's flag
2457 must_be_updated_p determines which matrix it contributes to
2458 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2459 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2460 Adding a desired matrix means setting up used counters and such in
2461 frame rows, while adding a current window matrix to FRAME_MATRIX
2462 means copying glyphs. The latter case corresponds to
2463 preserve_other_columns in the old redisplay. */
2466 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2468 struct glyph_matrix
*window_matrix
;
2469 int window_y
, frame_y
;
2470 /* If non-zero, a glyph to insert at the right border of W. */
2471 GLYPH right_border_glyph
;
2473 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2475 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2476 if (w
->must_be_updated_p
)
2478 window_matrix
= w
->desired_matrix
;
2480 /* Decide whether we want to add a vertical border glyph. */
2481 if (!WINDOW_RIGHTMOST_P (w
))
2483 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2486 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2488 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2490 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2491 spec_glyph_lookup_face (w
, &right_border_glyph
);
2494 if (GLYPH_FACE (right_border_glyph
) <= 0)
2495 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2499 window_matrix
= w
->current_matrix
;
2501 /* For all rows in the window matrix and corresponding rows in the
2504 frame_y
= window_matrix
->matrix_y
;
2505 while (window_y
< window_matrix
->nrows
)
2507 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2508 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2509 bool current_row_p
= window_matrix
== w
->current_matrix
;
2511 /* Fill up the frame row with spaces up to the left margin of the
2513 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2515 /* Fill up areas in the window matrix row with spaces. */
2516 fill_up_glyph_row_with_spaces (window_row
);
2518 /* If only part of W's desired matrix has been built, and
2519 window_row wasn't displayed, use the corresponding current
2521 if (window_matrix
== w
->desired_matrix
2522 && !window_row
->enabled_p
)
2524 window_row
= w
->current_matrix
->rows
+ window_y
;
2530 /* Copy window row to frame row. */
2531 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2532 window_row
->glyphs
[0],
2533 window_matrix
->matrix_w
* sizeof (struct glyph
));
2537 eassert (window_row
->enabled_p
);
2539 /* Only when a desired row has been displayed, we want
2540 the corresponding frame row to be updated. */
2541 frame_row
->enabled_p
= 1;
2543 /* Maybe insert a vertical border between horizontally adjacent
2545 if (GLYPH_CHAR (right_border_glyph
) != 0)
2547 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2548 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2552 /* Window row window_y must be a slice of frame row
2554 eassert (glyph_row_slice_p (window_row
, frame_row
));
2556 /* If rows are in sync, we don't have to copy glyphs because
2557 frame and window share glyphs. */
2559 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2560 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2564 /* Set number of used glyphs in the frame matrix. Since we fill
2565 up with spaces, and visit leaf windows from left to right it
2566 can be done simply. */
2567 frame_row
->used
[TEXT_AREA
]
2568 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2576 /* Given a user-specified glyph, possibly including a Lisp-level face
2577 ID, return a glyph that has a realized face ID.
2578 This is used for glyphs displayed specially and not part of the text;
2579 for instance, vertical separators, truncation markers, etc. */
2582 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2584 int lface_id
= GLYPH_FACE (*glyph
);
2585 /* Convert the glyph's specified face to a realized (cache) face. */
2588 int face_id
= merge_faces (XFRAME (w
->frame
),
2589 Qt
, lface_id
, DEFAULT_FACE_ID
);
2590 SET_GLYPH_FACE (*glyph
, face_id
);
2594 /* Add spaces to a glyph row ROW in a window matrix.
2596 Each row has the form:
2598 +---------+-----------------------------+------------+
2599 | left | text | right |
2600 +---------+-----------------------------+------------+
2602 Left and right marginal areas are optional. This function adds
2603 spaces to areas so that there are no empty holes between areas.
2604 In other words: If the right area is not empty, the text area
2605 is filled up with spaces up to the right area. If the text area
2606 is not empty, the left area is filled up.
2608 To be called for frame-based redisplay, only. */
2611 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2613 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2614 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2615 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2619 /* Fill area AREA of glyph row ROW with spaces. To be called for
2620 frame-based redisplay only. */
2623 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2625 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2627 struct glyph
*end
= row
->glyphs
[area
+ 1];
2628 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2631 *text
++ = space_glyph
;
2632 row
->used
[area
] = text
- row
->glyphs
[area
];
2637 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2638 reached. In frame matrices only one area, TEXT_AREA, is used. */
2641 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2643 int i
= row
->used
[TEXT_AREA
];
2644 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2647 glyph
[i
++] = space_glyph
;
2649 row
->used
[TEXT_AREA
] = i
;
2654 /**********************************************************************
2655 Mirroring operations on frame matrices in window matrices
2656 **********************************************************************/
2658 /* Set frame being updated via frame-based redisplay to F. This
2659 function must be called before updates to make explicit that we are
2660 working on frame matrices or not. */
2663 set_frame_matrix_frame (struct frame
*f
)
2665 frame_matrix_frame
= f
;
2669 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2670 DESIRED_MATRIX is the desired matrix corresponding to
2671 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2672 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2673 frame_matrix_frame is non-null, this indicates that the exchange is
2674 done in frame matrices, and that we have to perform analogous
2675 operations in window matrices of frame_matrix_frame. */
2678 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2680 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2681 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2682 bool mouse_face_p
= current_row
->mouse_face_p
;
2684 /* Do current_row = desired_row. This exchanges glyph pointers
2685 between both rows, and does a structure assignment otherwise. */
2686 assign_row (current_row
, desired_row
);
2688 /* Enable current_row to mark it as valid. */
2689 current_row
->enabled_p
= 1;
2690 current_row
->mouse_face_p
= mouse_face_p
;
2692 /* If we are called on frame matrices, perform analogous operations
2693 for window matrices. */
2694 if (frame_matrix_frame
)
2695 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2699 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2700 W's frame which has been made current (by swapping pointers between
2701 current and desired matrix). Perform analogous operations in the
2702 matrices of leaf windows in the window tree rooted at W. */
2705 mirror_make_current (struct window
*w
, int frame_row
)
2709 if (!NILP (w
->hchild
))
2710 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2711 else if (!NILP (w
->vchild
))
2712 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2715 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2716 here because the checks performed in debug mode there
2717 will not allow the conversion. */
2718 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2720 /* If FRAME_ROW is within W, assign the desired row to the
2721 current row (exchanging glyph pointers). */
2722 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2724 struct glyph_row
*current_row
2725 = MATRIX_ROW (w
->current_matrix
, row
);
2726 struct glyph_row
*desired_row
2727 = MATRIX_ROW (w
->desired_matrix
, row
);
2729 if (desired_row
->enabled_p
)
2730 assign_row (current_row
, desired_row
);
2732 swap_glyph_pointers (desired_row
, current_row
);
2733 current_row
->enabled_p
= 1;
2735 /* Set the Y coordinate of the mode/header line's row.
2736 It is needed in draw_row_with_mouse_face to find the
2737 screen coordinates. (Window-based redisplay sets
2738 this in update_window, but no one seems to do that
2739 for frame-based redisplay.) */
2740 if (current_row
->mode_line_p
)
2741 current_row
->y
= row
;
2745 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2750 /* Perform row dance after scrolling. We are working on the range of
2751 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2752 including) in MATRIX. COPY_FROM is a vector containing, for each
2753 row I in the range 0 <= I < NLINES, the index of the original line
2754 to move to I. This index is relative to the row range, i.e. 0 <=
2755 index < NLINES. RETAINED_P is a vector containing zero for each
2756 row 0 <= I < NLINES which is empty.
2758 This function is called from do_scrolling and do_direct_scrolling. */
2761 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2762 int *copy_from
, char *retained_p
)
2764 /* A copy of original rows. */
2765 struct glyph_row
*old_rows
;
2767 /* Rows to assign to. */
2768 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2772 /* Make a copy of the original rows. */
2773 old_rows
= alloca (nlines
* sizeof *old_rows
);
2774 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2776 /* Assign new rows, maybe clear lines. */
2777 for (i
= 0; i
< nlines
; ++i
)
2779 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2781 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2782 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2783 new_rows
[i
] = old_rows
[copy_from
[i
]];
2784 new_rows
[i
].enabled_p
= enabled_before_p
;
2786 /* RETAINED_P is zero for empty lines. */
2787 if (!retained_p
[copy_from
[i
]])
2788 new_rows
[i
].enabled_p
= 0;
2791 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2792 if (frame_matrix_frame
)
2793 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2794 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2798 /* Synchronize glyph pointers in the current matrix of window W with
2799 the current frame matrix. */
2802 sync_window_with_frame_matrix_rows (struct window
*w
)
2804 struct frame
*f
= XFRAME (w
->frame
);
2805 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2806 int left
, right
, x
, width
;
2808 /* Preconditions: W must be a leaf window on a tty frame. */
2809 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2810 eassert (!FRAME_WINDOW_P (f
));
2812 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2813 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2814 x
= w
->current_matrix
->matrix_x
;
2815 width
= w
->current_matrix
->matrix_w
;
2817 window_row
= w
->current_matrix
->rows
;
2818 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2819 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2821 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2823 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2824 = frame_row
->glyphs
[0] + x
;
2825 window_row
->glyphs
[TEXT_AREA
]
2826 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2827 window_row
->glyphs
[LAST_AREA
]
2828 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2829 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2830 = window_row
->glyphs
[LAST_AREA
] - right
;
2835 /* Return the window in the window tree rooted in W containing frame
2836 row ROW. Value is null if none is found. */
2838 static struct window
*
2839 frame_row_to_window (struct window
*w
, int row
)
2841 struct window
*found
= NULL
;
2845 if (!NILP (w
->hchild
))
2846 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2847 else if (!NILP (w
->vchild
))
2848 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2849 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2850 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2853 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2860 /* Perform a line dance in the window tree rooted at W, after
2861 scrolling a frame matrix in mirrored_line_dance.
2863 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2864 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2865 COPY_FROM is a vector containing, for each row I in the range 0 <=
2866 I < NLINES, the index of the original line to move to I. This
2867 index is relative to the row range, i.e. 0 <= index < NLINES.
2868 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2872 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2876 if (!NILP (w
->hchild
))
2877 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2878 nlines
, copy_from
, retained_p
);
2879 else if (!NILP (w
->vchild
))
2880 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2881 nlines
, copy_from
, retained_p
);
2884 /* W is a leaf window, and we are working on its current
2886 struct glyph_matrix
*m
= w
->current_matrix
;
2889 struct glyph_row
*old_rows
;
2891 /* Make a copy of the original rows of matrix m. */
2892 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2893 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2895 for (i
= 0; i
< nlines
; ++i
)
2897 /* Frame relative line assigned to. */
2898 int frame_to
= i
+ unchanged_at_top
;
2900 /* Frame relative line assigned. */
2901 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2903 /* Window relative line assigned to. */
2904 int window_to
= frame_to
- m
->matrix_y
;
2906 /* Window relative line assigned. */
2907 int window_from
= frame_from
- m
->matrix_y
;
2909 /* Is assigned line inside window? */
2910 bool from_inside_window_p
2911 = window_from
>= 0 && window_from
< m
->matrix_h
;
2913 /* Is assigned to line inside window? */
2914 bool to_inside_window_p
2915 = window_to
>= 0 && window_to
< m
->matrix_h
;
2917 if (from_inside_window_p
&& to_inside_window_p
)
2919 /* Do the assignment. The enabled_p flag is saved
2920 over the assignment because the old redisplay did
2922 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2923 m
->rows
[window_to
] = old_rows
[window_from
];
2924 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2926 /* If frame line is empty, window line is empty, too. */
2927 if (!retained_p
[copy_from
[i
]])
2928 m
->rows
[window_to
].enabled_p
= 0;
2930 else if (to_inside_window_p
)
2932 /* A copy between windows. This is an infrequent
2933 case not worth optimizing. */
2934 struct frame
*f
= XFRAME (w
->frame
);
2935 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2937 struct glyph_matrix
*m2
;
2940 w2
= frame_row_to_window (root
, frame_from
);
2941 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2942 -nw', FROM_FRAME sometimes has no associated window.
2943 This check avoids a segfault if W2 is null. */
2946 m2
= w2
->current_matrix
;
2947 m2_from
= frame_from
- m2
->matrix_y
;
2948 copy_row_except_pointers (m
->rows
+ window_to
,
2949 m2
->rows
+ m2_from
);
2951 /* If frame line is empty, window line is empty, too. */
2952 if (!retained_p
[copy_from
[i
]])
2953 m
->rows
[window_to
].enabled_p
= 0;
2957 else if (from_inside_window_p
)
2961 /* If there was a copy between windows, make sure glyph
2962 pointers are in sync with the frame matrix. */
2964 sync_window_with_frame_matrix_rows (w
);
2966 /* Check that no pointers are lost. */
2970 /* Next window on same level. */
2971 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2978 /* Check that window and frame matrices agree about their
2979 understanding where glyphs of the rows are to find. For each
2980 window in the window tree rooted at W, check that rows in the
2981 matrices of leaf window agree with their frame matrices about
2985 check_window_matrix_pointers (struct window
*w
)
2989 if (!NILP (w
->hchild
))
2990 check_window_matrix_pointers (XWINDOW (w
->hchild
));
2991 else if (!NILP (w
->vchild
))
2992 check_window_matrix_pointers (XWINDOW (w
->vchild
));
2995 struct frame
*f
= XFRAME (w
->frame
);
2996 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2997 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3000 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3005 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3006 a window and FRAME_MATRIX is the corresponding frame matrix. For
3007 each row in WINDOW_MATRIX check that it's a slice of the
3008 corresponding frame row. If it isn't, abort. */
3011 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3012 struct glyph_matrix
*frame_matrix
)
3014 /* Row number in WINDOW_MATRIX. */
3017 /* Row number corresponding to I in FRAME_MATRIX. */
3018 int j
= window_matrix
->matrix_y
;
3020 /* For all rows check that the row in the window matrix is a
3021 slice of the row in the frame matrix. If it isn't we didn't
3022 mirror an operation on the frame matrix correctly. */
3023 while (i
< window_matrix
->nrows
)
3025 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3026 frame_matrix
->rows
+ j
))
3032 #endif /* GLYPH_DEBUG */
3036 /**********************************************************************
3037 VPOS and HPOS translations
3038 **********************************************************************/
3042 /* Translate vertical position VPOS which is relative to window W to a
3043 vertical position relative to W's frame. */
3046 window_to_frame_vpos (struct window
*w
, int vpos
)
3048 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3049 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3050 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3051 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3056 /* Translate horizontal position HPOS which is relative to window W to
3057 a horizontal position relative to W's frame. */
3060 window_to_frame_hpos (struct window
*w
, int hpos
)
3062 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3063 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3067 #endif /* GLYPH_DEBUG */
3071 /**********************************************************************
3073 **********************************************************************/
3075 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3076 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3081 CHECK_LIVE_FRAME (frame
);
3084 /* Ignore redraw requests, if frame has no glyphs yet.
3085 (Implementation note: It still has to be checked why we are
3086 called so early here). */
3087 if (!glyphs_initialized_initially_p
)
3092 if (FRAME_MSDOS_P (f
))
3093 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3096 clear_current_matrices (f
);
3098 if (FRAME_TERMCAP_P (f
))
3099 fflush (FRAME_TTY (f
)->output
);
3100 windows_or_buffers_changed
++;
3101 /* Mark all windows as inaccurate, so that every window will have
3102 its redisplay done. */
3103 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3104 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3110 /* Redraw frame F. This is nothing more than a call to the Lisp
3111 function redraw-frame. */
3114 redraw_frame (struct frame
*f
)
3117 XSETFRAME (frame
, f
);
3118 Fredraw_frame (frame
);
3122 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3123 doc
: /* Clear and redisplay all visible frames. */)
3126 Lisp_Object tail
, frame
;
3128 FOR_EACH_FRAME (tail
, frame
)
3129 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3130 Fredraw_frame (frame
);
3137 /***********************************************************************
3139 ***********************************************************************/
3141 /* Update frame F based on the data in desired matrices.
3143 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3144 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3146 Value is true if redisplay was stopped due to pending input. */
3149 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3151 /* True means display has been paused because of pending input. */
3153 struct window
*root_window
= XWINDOW (f
->root_window
);
3155 if (redisplay_dont_pause
)
3157 else if (NILP (Vredisplay_preemption_period
))
3159 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3161 double p
= XFLOATINT (Vredisplay_preemption_period
);
3163 if (detect_input_pending_ignore_squeezables ())
3169 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3170 preemption_next_check
= add_emacs_time (current_emacs_time (),
3174 if (FRAME_WINDOW_P (f
))
3176 /* We are working on window matrix basis. All windows whose
3177 flag must_be_updated_p is set have to be updated. */
3179 /* Record that we are not working on frame matrices. */
3180 set_frame_matrix_frame (NULL
);
3182 /* Update all windows in the window tree of F, maybe stopping
3183 when pending input is detected. */
3186 /* Update the menu bar on X frames that don't have toolkit
3188 if (WINDOWP (f
->menu_bar_window
))
3189 update_window (XWINDOW (f
->menu_bar_window
), 1);
3191 /* Update the tool-bar window, if present. */
3192 if (WINDOWP (f
->tool_bar_window
))
3194 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3196 /* Update tool-bar window. */
3197 if (w
->must_be_updated_p
)
3201 update_window (w
, 1);
3202 w
->must_be_updated_p
= 0;
3204 /* Swap tool-bar strings. We swap because we want to
3206 tem
= f
->current_tool_bar_string
;
3207 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3208 fset_desired_tool_bar_string (f
, tem
);
3213 /* Update windows. */
3214 paused_p
= update_window_tree (root_window
, force_p
);
3217 /* This flush is a performance bottleneck under X,
3218 and it doesn't seem to be necessary anyway (in general).
3219 It is necessary when resizing the window with the mouse, or
3220 at least the fringes are not redrawn in a timely manner. ++kfs */
3221 if (f
->force_flush_display_p
)
3223 FRAME_RIF (f
)->flush_display (f
);
3224 f
->force_flush_display_p
= 0;
3229 /* We are working on frame matrix basis. Set the frame on whose
3230 frame matrix we operate. */
3231 set_frame_matrix_frame (f
);
3233 /* Build F's desired matrix from window matrices. */
3234 build_frame_matrix (f
);
3236 /* Update the display */
3238 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3241 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3243 if (FRAME_TTY (f
)->termscript
)
3244 fflush (FRAME_TTY (f
)->termscript
);
3245 if (FRAME_TERMCAP_P (f
))
3246 fflush (FRAME_TTY (f
)->output
);
3249 /* Check window matrices for lost pointers. */
3251 check_window_matrix_pointers (root_window
);
3252 add_frame_display_history (f
, paused_p
);
3257 /* Reset flags indicating that a window should be updated. */
3258 set_window_update_flags (root_window
, 0);
3260 display_completed
= !paused_p
;
3266 /************************************************************************
3267 Window-based updates
3268 ************************************************************************/
3270 /* Perform updates in window tree rooted at W.
3271 If FORCE_P, don't stop updating if input is pending. */
3274 update_window_tree (struct window
*w
, bool force_p
)
3278 while (w
&& !paused_p
)
3280 if (!NILP (w
->hchild
))
3281 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3282 else if (!NILP (w
->vchild
))
3283 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3284 else if (w
->must_be_updated_p
)
3285 paused_p
|= update_window (w
, force_p
);
3287 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3294 /* Update window W if its flag must_be_updated_p is set.
3295 If FORCE_P, don't stop updating if input is pending. */
3298 update_single_window (struct window
*w
, bool force_p
)
3300 if (w
->must_be_updated_p
)
3302 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3304 /* Record that this is not a frame-based redisplay. */
3305 set_frame_matrix_frame (NULL
);
3307 if (redisplay_dont_pause
)
3309 else if (NILP (Vredisplay_preemption_period
))
3311 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3313 double p
= XFLOATINT (Vredisplay_preemption_period
);
3314 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3315 preemption_next_check
= add_emacs_time (current_emacs_time (),
3321 update_window (w
, force_p
);
3324 /* Reset flag in W. */
3325 w
->must_be_updated_p
= 0;
3329 #ifdef HAVE_WINDOW_SYSTEM
3331 /* Redraw lines from the current matrix of window W that are
3332 overlapped by other rows. YB is bottom-most y-position in W. */
3335 redraw_overlapped_rows (struct window
*w
, int yb
)
3338 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3340 /* If rows overlapping others have been changed, the rows being
3341 overlapped have to be redrawn. This won't draw lines that have
3342 already been drawn in update_window_line because overlapped_p in
3343 desired rows is 0, so after row assignment overlapped_p in
3344 current rows is 0. */
3345 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3347 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3349 if (!row
->enabled_p
)
3351 else if (row
->mode_line_p
)
3354 if (row
->overlapped_p
)
3356 enum glyph_row_area area
;
3358 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3361 updated_area
= area
;
3362 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3363 area
== TEXT_AREA
? row
->x
: 0);
3364 if (row
->used
[area
])
3365 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3367 FRAME_RIF (f
)->clear_end_of_line (-1);
3370 row
->overlapped_p
= 0;
3373 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3379 /* Redraw lines from the current matrix of window W that overlap
3380 others. YB is bottom-most y-position in W. */
3383 redraw_overlapping_rows (struct window
*w
, int yb
)
3386 struct glyph_row
*row
;
3387 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3389 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3391 row
= w
->current_matrix
->rows
+ i
;
3393 if (!row
->enabled_p
)
3395 else if (row
->mode_line_p
)
3398 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3400 if (row
->overlapping_p
)
3404 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3405 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3406 overlaps
|= OVERLAPS_PRED
;
3407 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3408 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3409 overlaps
|= OVERLAPS_SUCC
;
3413 if (row
->used
[LEFT_MARGIN_AREA
])
3414 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3416 if (row
->used
[TEXT_AREA
])
3417 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3419 if (row
->used
[RIGHT_MARGIN_AREA
])
3420 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3422 /* Record in neighbor rows that ROW overwrites part of
3424 if (overlaps
& OVERLAPS_PRED
)
3425 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3426 if (overlaps
& OVERLAPS_SUCC
)
3427 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3436 #endif /* HAVE_WINDOW_SYSTEM */
3439 #if defined GLYPH_DEBUG && 0
3441 /* Check that no row in the current matrix of window W is enabled
3442 which is below what's displayed in the window. */
3445 check_current_matrix_flags (struct window
*w
)
3447 bool last_seen_p
= 0;
3448 int i
, yb
= window_text_bottom_y (w
);
3450 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3452 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3453 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3455 else if (last_seen_p
&& row
->enabled_p
)
3460 #endif /* GLYPH_DEBUG */
3463 /* Update display of window W.
3464 If FORCE_P, don't stop updating when input is pending. */
3467 update_window (struct window
*w
, bool force_p
)
3469 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3471 #if !PERIODIC_PREEMPTION_CHECKING
3472 int preempt_count
= baud_rate
/ 2400 + 1;
3474 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3476 /* Check that W's frame doesn't have glyph matrices. */
3477 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3480 /* Check pending input the first time so that we can quickly return. */
3481 #if !PERIODIC_PREEMPTION_CHECKING
3483 detect_input_pending_ignore_squeezables ();
3486 /* If forced to complete the update, or if no input is pending, do
3488 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3490 struct glyph_row
*row
, *end
;
3491 struct glyph_row
*mode_line_row
;
3492 struct glyph_row
*header_line_row
;
3494 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3495 #if ! PERIODIC_PREEMPTION_CHECKING
3499 rif
->update_window_begin_hook (w
);
3500 yb
= window_text_bottom_y (w
);
3501 row
= desired_matrix
->rows
;
3502 end
= row
+ desired_matrix
->nrows
- 1;
3504 /* Take note of the header line, if there is one. We will
3505 update it below, after updating all of the window's lines. */
3506 if (row
->mode_line_p
)
3508 header_line_row
= row
;
3512 header_line_row
= NULL
;
3514 /* Update the mode line, if necessary. */
3515 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3516 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3518 mode_line_row
->y
= yb
;
3519 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3521 &mouse_face_overwritten_p
);
3524 /* Find first enabled row. Optimizations in redisplay_internal
3525 may lead to an update with only one row enabled. There may
3526 be also completely empty matrices. */
3527 while (row
< end
&& !row
->enabled_p
)
3530 /* Try reusing part of the display by copying. */
3531 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3533 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3536 /* All rows were found to be equal. */
3542 /* We've scrolled the display. */
3548 /* Update the rest of the lines. */
3549 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3550 /* scrolling_window resets the enabled_p flag of the rows it
3551 reuses from current_matrix. */
3554 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3557 /* We'll have to play a little bit with when to
3558 detect_input_pending. If it's done too often,
3559 scrolling large windows with repeated scroll-up
3560 commands will too quickly pause redisplay. */
3561 #if PERIODIC_PREEMPTION_CHECKING
3564 EMACS_TIME tm
= current_emacs_time ();
3565 if (EMACS_TIME_LT (preemption_next_check
, tm
))
3567 preemption_next_check
= add_emacs_time (tm
,
3569 if (detect_input_pending_ignore_squeezables ())
3574 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3575 detect_input_pending_ignore_squeezables ();
3577 changed_p
|= update_window_line (w
, vpos
,
3578 &mouse_face_overwritten_p
);
3580 /* Mark all rows below the last visible one in the current
3581 matrix as invalid. This is necessary because of
3582 variable line heights. Consider the case of three
3583 successive redisplays, where the first displays 5
3584 lines, the second 3 lines, and the third 5 lines again.
3585 If the second redisplay wouldn't mark rows in the
3586 current matrix invalid, the third redisplay might be
3587 tempted to optimize redisplay based on lines displayed
3588 in the first redisplay. */
3589 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3590 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3591 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3594 /* Was display preempted? */
3595 paused_p
= row
< end
;
3599 /* Update the header line after scrolling because a new header
3600 line would otherwise overwrite lines at the top of the window
3601 that can be scrolled. */
3602 if (header_line_row
&& header_line_row
->enabled_p
)
3604 header_line_row
->y
= 0;
3605 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3608 /* Fix the appearance of overlapping/overlapped rows. */
3609 if (!paused_p
&& !w
->pseudo_window_p
)
3611 #ifdef HAVE_WINDOW_SYSTEM
3612 if (changed_p
&& rif
->fix_overlapping_area
)
3614 redraw_overlapped_rows (w
, yb
);
3615 redraw_overlapping_rows (w
, yb
);
3619 /* Make cursor visible at cursor position of W. */
3620 set_window_cursor_after_update (w
);
3622 #if 0 /* Check that current matrix invariants are satisfied. This is
3623 for debugging only. See the comment of check_matrix_invariants. */
3624 IF_DEBUG (check_matrix_invariants (w
));
3629 /* Remember the redisplay method used to display the matrix. */
3630 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3633 #ifdef HAVE_WINDOW_SYSTEM
3634 update_window_fringes (w
, 0);
3637 /* End the update of window W. Don't set the cursor if we
3638 paused updating the display because in this case,
3639 set_window_cursor_after_update hasn't been called, and
3640 output_cursor doesn't contain the cursor location. */
3641 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3647 /* check_current_matrix_flags (w); */
3648 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3651 clear_glyph_matrix (desired_matrix
);
3657 /* Update the display of area AREA in window W, row number VPOS.
3658 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3661 update_marginal_area (struct window
*w
, int area
, int vpos
)
3663 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3664 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3666 /* Let functions in xterm.c know what area subsequent X positions
3667 will be relative to. */
3668 updated_area
= area
;
3670 /* Set cursor to start of glyphs, write them, and clear to the end
3671 of the area. I don't think that something more sophisticated is
3672 necessary here, since marginal areas will not be the default. */
3673 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3674 if (desired_row
->used
[area
])
3675 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3676 rif
->clear_end_of_line (-1);
3680 /* Update the display of the text area of row VPOS in window W.
3681 Value is true if display has changed. */
3684 update_text_area (struct window
*w
, int vpos
)
3686 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3687 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3688 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3691 /* Let functions in xterm.c know what area subsequent X positions
3692 will be relative to. */
3693 updated_area
= TEXT_AREA
;
3695 /* If rows are at different X or Y, or rows have different height,
3696 or the current row is marked invalid, write the entire line. */
3697 if (!current_row
->enabled_p
3698 || desired_row
->y
!= current_row
->y
3699 || desired_row
->ascent
!= current_row
->ascent
3700 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3701 || desired_row
->phys_height
!= current_row
->phys_height
3702 || desired_row
->visible_height
!= current_row
->visible_height
3703 || current_row
->overlapped_p
3704 /* This next line is necessary for correctly redrawing
3705 mouse-face areas after scrolling and other operations.
3706 However, it causes excessive flickering when mouse is moved
3707 across the mode line. Luckily, turning it off for the mode
3708 line doesn't seem to hurt anything. -- cyd.
3709 But it is still needed for the header line. -- kfs. */
3710 || (current_row
->mouse_face_p
3711 && !(current_row
->mode_line_p
&& vpos
> 0))
3712 || current_row
->x
!= desired_row
->x
)
3714 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3716 if (desired_row
->used
[TEXT_AREA
])
3717 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3718 desired_row
->used
[TEXT_AREA
]);
3720 /* Clear to end of window. */
3721 rif
->clear_end_of_line (-1);
3724 /* This erases the cursor. We do this here because
3725 notice_overwritten_cursor cannot easily check this, which
3726 might indicate that the whole functionality of
3727 notice_overwritten_cursor would better be implemented here.
3728 On the other hand, we need notice_overwritten_cursor as long
3729 as mouse highlighting is done asynchronously outside of
3731 if (vpos
== w
->phys_cursor
.vpos
)
3732 w
->phys_cursor_on_p
= 0;
3737 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3738 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3739 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3740 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3741 bool abort_skipping
= 0;
3743 /* If the desired row extends its face to the text area end, and
3744 unless the current row also does so at the same position,
3745 make sure we write at least one glyph, so that the face
3746 extension actually takes place. */
3747 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3748 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3749 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3750 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3753 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3757 /* Loop over glyphs that current and desired row may have
3761 bool can_skip_p
= !abort_skipping
;
3763 /* Skip over glyphs that both rows have in common. These
3764 don't have to be written. We can't skip if the last
3765 current glyph overlaps the glyph to its right. For
3766 example, consider a current row of `if ' with the `f' in
3767 Courier bold so that it overlaps the ` ' to its right.
3768 If the desired row is ` ', we would skip over the space
3769 after the `if' and there would remain a pixel from the
3770 `f' on the screen. */
3771 if (overlapping_glyphs_p
&& i
> 0)
3773 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3776 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3778 can_skip_p
= (right
== 0 && !abort_skipping
);
3786 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3788 x
+= desired_glyph
->pixel_width
;
3789 ++desired_glyph
, ++current_glyph
, ++i
;
3792 /* Consider the case that the current row contains "xxx
3793 ppp ggg" in italic Courier font, and the desired row
3794 is "xxx ggg". The character `p' has lbearing, `g'
3795 has not. The loop above will stop in front of the
3796 first `p' in the current row. If we would start
3797 writing glyphs there, we wouldn't erase the lbearing
3798 of the `p'. The rest of the lbearing problem is then
3799 taken care of by draw_glyphs. */
3800 if (overlapping_glyphs_p
3802 && i
< current_row
->used
[TEXT_AREA
]
3803 && (current_row
->used
[TEXT_AREA
]
3804 != desired_row
->used
[TEXT_AREA
]))
3808 rif
->get_glyph_overhangs (current_glyph
,
3811 while (left
> 0 && i
> 0)
3813 --i
, --desired_glyph
, --current_glyph
;
3814 x
-= desired_glyph
->pixel_width
;
3815 left
-= desired_glyph
->pixel_width
;
3818 /* Abort the skipping algorithm if we end up before
3819 our starting point, to avoid looping (bug#1070).
3820 This can happen when the lbearing is larger than
3822 abort_skipping
= (i
< start_hpos
);
3826 /* Try to avoid writing the entire rest of the desired row
3827 by looking for a resync point. This mainly prevents
3828 mode line flickering in the case the mode line is in
3829 fixed-pitch font, which it usually will be. */
3830 if (i
< desired_row
->used
[TEXT_AREA
])
3832 int start_x
= x
, start_hpos
= i
;
3833 struct glyph
*start
= desired_glyph
;
3835 bool skip_first_p
= !can_skip_p
;
3837 /* Find the next glyph that's equal again. */
3840 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3843 x
+= desired_glyph
->pixel_width
;
3844 current_x
+= current_glyph
->pixel_width
;
3845 ++desired_glyph
, ++current_glyph
, ++i
;
3849 if (i
== start_hpos
|| x
!= current_x
)
3853 desired_glyph
= start
;
3857 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3858 rif
->write_glyphs (start
, i
- start_hpos
);
3863 /* Write the rest. */
3864 if (i
< desired_row
->used
[TEXT_AREA
])
3866 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3867 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3871 /* Maybe clear to end of line. */
3872 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3874 /* If new row extends to the end of the text area, nothing
3875 has to be cleared, if and only if we did a write_glyphs
3876 above. This is made sure by setting desired_stop_pos
3877 appropriately above. */
3878 eassert (i
< desired_row
->used
[TEXT_AREA
]
3879 || ((desired_row
->used
[TEXT_AREA
]
3880 == current_row
->used
[TEXT_AREA
])
3881 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3883 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3885 /* If old row extends to the end of the text area, clear. */
3886 if (i
>= desired_row
->used
[TEXT_AREA
])
3887 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3888 desired_row
->pixel_width
);
3889 rif
->clear_end_of_line (-1);
3892 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3894 /* Otherwise clear to the end of the old row. Everything
3895 after that position should be clear already. */
3898 if (i
>= desired_row
->used
[TEXT_AREA
])
3899 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3900 desired_row
->pixel_width
);
3902 /* If cursor is displayed at the end of the line, make sure
3903 it's cleared. Nowadays we don't have a phys_cursor_glyph
3904 with which to erase the cursor (because this method
3905 doesn't work with lbearing/rbearing), so we must do it
3907 if (vpos
== w
->phys_cursor
.vpos
3908 && (desired_row
->reversed_p
3909 ? (w
->phys_cursor
.hpos
< 0)
3910 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3912 w
->phys_cursor_on_p
= 0;
3916 xlim
= current_row
->pixel_width
;
3917 rif
->clear_end_of_line (xlim
);
3926 /* Update row VPOS in window W. Value is true if display has been changed. */
3929 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3931 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3932 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3933 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3936 /* Set the row being updated. This is important to let xterm.c
3937 know what line height values are in effect. */
3938 updated_row
= desired_row
;
3940 /* A row can be completely invisible in case a desired matrix was
3941 built with a vscroll and then make_cursor_line_fully_visible shifts
3942 the matrix. Make sure to make such rows current anyway, since
3943 we need the correct y-position, for example, in the current matrix. */
3944 if (desired_row
->mode_line_p
3945 || desired_row
->visible_height
> 0)
3947 eassert (desired_row
->enabled_p
);
3949 /* Update display of the left margin area, if there is one. */
3950 if (!desired_row
->full_width_p
3951 && !NILP (w
->left_margin_cols
))
3954 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
3957 /* Update the display of the text area. */
3958 if (update_text_area (w
, vpos
))
3961 if (current_row
->mouse_face_p
)
3962 *mouse_face_overwritten_p
= 1;
3965 /* Update display of the right margin area, if there is one. */
3966 if (!desired_row
->full_width_p
3967 && !NILP (w
->right_margin_cols
))
3970 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
3973 /* Draw truncation marks etc. */
3974 if (!current_row
->enabled_p
3975 || desired_row
->y
!= current_row
->y
3976 || desired_row
->visible_height
!= current_row
->visible_height
3977 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3978 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3979 || current_row
->redraw_fringe_bitmaps_p
3980 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3981 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3982 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3983 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3984 rif
->after_update_window_line_hook (desired_row
);
3987 /* Update current_row from desired_row. */
3988 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3994 /* Set the cursor after an update of window W. This function may only
3995 be called from update_window. */
3998 set_window_cursor_after_update (struct window
*w
)
4000 struct frame
*f
= XFRAME (w
->frame
);
4001 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4002 int cx
, cy
, vpos
, hpos
;
4004 /* Not intended for frame matrix updates. */
4005 eassert (FRAME_WINDOW_P (f
));
4007 if (cursor_in_echo_area
4008 && !NILP (echo_area_buffer
[0])
4009 /* If we are showing a message instead of the mini-buffer,
4010 show the cursor for the message instead. */
4011 && XWINDOW (minibuf_window
) == w
4012 && EQ (minibuf_window
, echo_area_window
)
4013 /* These cases apply only to the frame that contains
4014 the active mini-buffer window. */
4015 && FRAME_HAS_MINIBUF_P (f
)
4016 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4018 cx
= cy
= vpos
= hpos
= 0;
4020 if (cursor_in_echo_area
>= 0)
4022 /* If the mini-buffer is several lines high, find the last
4023 line that has any text on it. Note: either all lines
4024 are enabled or none. Otherwise we wouldn't be able to
4026 struct glyph_row
*row
, *last_row
;
4027 struct glyph
*glyph
;
4028 int yb
= window_text_bottom_y (w
);
4031 row
= w
->current_matrix
->rows
;
4032 while (row
->enabled_p
4033 && (last_row
== NULL
4034 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4036 if (row
->used
[TEXT_AREA
]
4037 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4044 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4045 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4047 while (last
> start
&& last
->charpos
< 0)
4050 for (glyph
= start
; glyph
< last
; ++glyph
)
4052 cx
+= glyph
->pixel_width
;
4057 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4065 hpos
= w
->cursor
.hpos
;
4066 vpos
= w
->cursor
.vpos
;
4069 /* Window cursor can be out of sync for horizontally split windows. */
4070 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4071 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4072 vpos
= max (0, vpos
);
4073 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4074 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4078 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4079 tree rooted at W. */
4082 set_window_update_flags (struct window
*w
, bool on_p
)
4086 if (!NILP (w
->hchild
))
4087 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4088 else if (!NILP (w
->vchild
))
4089 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4091 w
->must_be_updated_p
= on_p
;
4093 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4099 /***********************************************************************
4100 Window-Based Scrolling
4101 ***********************************************************************/
4103 /* Structure describing rows in scrolling_window. */
4107 /* Number of occurrences of this row in desired and current matrix. */
4108 int old_uses
, new_uses
;
4110 /* Vpos of row in new matrix. */
4111 int new_line_number
;
4113 /* Bucket index of this row_entry in the hash table row_table. */
4116 /* The row described by this entry. */
4117 struct glyph_row
*row
;
4119 /* Hash collision chain. */
4120 struct row_entry
*next
;
4123 /* A pool to allocate row_entry structures from, and the size of the
4124 pool. The pool is reallocated in scrolling_window when we find
4125 that we need a larger one. */
4127 static struct row_entry
*row_entry_pool
;
4128 static ptrdiff_t row_entry_pool_size
;
4130 /* Index of next free entry in row_entry_pool. */
4132 static ptrdiff_t row_entry_idx
;
4134 /* The hash table used during scrolling, and the table's size. This
4135 table is used to quickly identify equal rows in the desired and
4138 static struct row_entry
**row_table
;
4139 static ptrdiff_t row_table_size
;
4141 /* Vectors of pointers to row_entry structures belonging to the
4142 current and desired matrix, and the size of the vectors. */
4144 static struct row_entry
**old_lines
, **new_lines
;
4145 static ptrdiff_t old_lines_size
, new_lines_size
;
4147 /* A pool to allocate run structures from, and its size. */
4149 static struct run
*run_pool
;
4150 static ptrdiff_t runs_size
;
4152 /* A vector of runs of lines found during scrolling. */
4154 static struct run
**runs
;
4156 /* Add glyph row ROW to the scrolling hash table. */
4158 static inline struct row_entry
*
4159 add_row_entry (struct glyph_row
*row
)
4161 struct row_entry
*entry
;
4162 ptrdiff_t i
= row
->hash
% row_table_size
;
4164 entry
= row_table
[i
];
4165 eassert (entry
|| verify_row_hash (row
));
4166 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4167 entry
= entry
->next
;
4171 entry
= row_entry_pool
+ row_entry_idx
++;
4173 entry
->old_uses
= entry
->new_uses
= 0;
4174 entry
->new_line_number
= 0;
4176 entry
->next
= row_table
[i
];
4177 row_table
[i
] = entry
;
4184 /* Try to reuse part of the current display of W by scrolling lines.
4185 HEADER_LINE_P means W has a header line.
4187 The algorithm is taken from Communications of the ACM, Apr78 "A
4188 Technique for Isolating Differences Between Files." It should take
4191 A short outline of the steps of the algorithm
4193 1. Skip lines equal at the start and end of both matrices.
4195 2. Enter rows in the current and desired matrix into a symbol
4196 table, counting how often they appear in both matrices.
4198 3. Rows that appear exactly once in both matrices serve as anchors,
4199 i.e. we assume that such lines are likely to have been moved.
4201 4. Starting from anchor lines, extend regions to be scrolled both
4202 forward and backward.
4206 -1 if all rows were found to be equal.
4207 0 to indicate that we did not scroll the display, or
4208 1 if we did scroll. */
4211 scrolling_window (struct window
*w
, bool header_line_p
)
4213 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4214 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4215 int yb
= window_text_bottom_y (w
);
4217 int j
, first_old
, first_new
, last_old
, last_new
;
4220 struct row_entry
*entry
;
4221 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4223 /* Skip over rows equal at the start. */
4224 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4226 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4227 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4231 && !d
->redraw_fringe_bitmaps_p
4233 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4234 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4235 && row_equal_p (c
, d
, 1))
4244 /* Give up if some rows in the desired matrix are not enabled. */
4245 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4248 first_old
= first_new
= i
;
4250 /* Set last_new to the index + 1 of the row that reaches the
4251 bottom boundary in the desired matrix. Give up if we find a
4252 disabled row before we reach the bottom boundary. */
4254 while (i
< desired_matrix
->nrows
- 1)
4258 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4260 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4269 /* Set last_old to the index + 1 of the row that reaches the bottom
4270 boundary in the current matrix. We don't look at the enabled
4271 flag here because we plan to reuse part of the display even if
4272 other parts are disabled. */
4274 while (i
< current_matrix
->nrows
- 1)
4276 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4285 /* Skip over rows equal at the bottom. */
4288 while (i
- 1 > first_new
4289 && j
- 1 > first_old
4290 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4291 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4292 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4293 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4294 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4295 MATRIX_ROW (current_matrix
, j
- 1), 1))
4300 /* Nothing to do if all rows are equal. */
4301 if (last_new
== first_new
)
4304 /* Check for integer overflow in size calculation.
4306 If next_almost_prime checks (N) for divisibility by 2..10, then
4307 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4308 So, set next_almost_prime_increment_max to 10.
4310 It's just a coincidence that next_almost_prime_increment_max ==
4311 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4312 13, then next_almost_prime_increment_max would be 14, e.g.,
4313 because next_almost_prime (113) would be 127. */
4315 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4316 enum { next_almost_prime_increment_max
= 10 };
4317 ptrdiff_t row_table_max
=
4318 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4319 - next_almost_prime_increment_max
);
4320 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4321 if (current_nrows_max
< current_matrix
->nrows
)
4322 memory_full (SIZE_MAX
);
4325 /* Reallocate vectors, tables etc. if necessary. */
4327 if (current_matrix
->nrows
> old_lines_size
)
4328 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4329 current_matrix
->nrows
- old_lines_size
,
4330 INT_MAX
, sizeof *old_lines
);
4332 if (desired_matrix
->nrows
> new_lines_size
)
4333 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4334 desired_matrix
->nrows
- new_lines_size
,
4335 INT_MAX
, sizeof *new_lines
);
4337 n
= desired_matrix
->nrows
;
4338 n
+= current_matrix
->nrows
;
4339 if (row_table_size
< 3 * n
)
4341 ptrdiff_t size
= next_almost_prime (3 * n
);
4342 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4343 row_table_size
= size
;
4344 memset (row_table
, 0, size
* sizeof *row_table
);
4347 if (n
> row_entry_pool_size
)
4348 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4349 n
- row_entry_pool_size
,
4350 -1, sizeof *row_entry_pool
);
4352 if (desired_matrix
->nrows
> runs_size
)
4354 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4355 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4356 runs_size
= desired_matrix
->nrows
;
4359 nruns
= run_idx
= 0;
4362 /* Add rows from the current and desired matrix to the hash table
4363 row_hash_table to be able to find equal ones quickly. */
4365 for (i
= first_old
; i
< last_old
; ++i
)
4367 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4369 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4370 old_lines
[i
] = entry
;
4374 old_lines
[i
] = NULL
;
4377 for (i
= first_new
; i
< last_new
; ++i
)
4379 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4380 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4382 entry
->new_line_number
= i
;
4383 new_lines
[i
] = entry
;
4386 /* Identify moves based on lines that are unique and equal
4387 in both matrices. */
4388 for (i
= first_old
; i
< last_old
;)
4390 && old_lines
[i
]->old_uses
== 1
4391 && old_lines
[i
]->new_uses
== 1)
4394 int new_line
= old_lines
[i
]->new_line_number
;
4395 struct run
*run
= run_pool
+ run_idx
++;
4398 run
->current_vpos
= i
;
4399 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4400 run
->desired_vpos
= new_line
;
4401 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4403 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4405 /* Extend backward. */
4408 while (p
> first_old
4410 && old_lines
[p
] == new_lines
[q
])
4412 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4413 --run
->current_vpos
;
4414 --run
->desired_vpos
;
4417 run
->desired_y
-= h
;
4418 run
->current_y
-= h
;
4422 /* Extend forward. */
4427 && old_lines
[p
] == new_lines
[q
])
4429 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4435 /* Insert run into list of all runs. Order runs by copied
4436 pixel lines. Note that we record runs that don't have to
4437 be copied because they are already in place. This is done
4438 because we can avoid calling update_window_line in this
4440 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4442 for (q
= nruns
; q
> p
; --q
)
4443 runs
[q
] = runs
[q
- 1];
4452 /* Do the moves. Do it in a way that we don't overwrite something
4453 we want to copy later on. This is not solvable in general
4454 because there is only one display and we don't have a way to
4455 exchange areas on this display. Example:
4457 +-----------+ +-----------+
4459 +-----------+ --> +-----------+
4461 +-----------+ +-----------+
4463 Instead, prefer bigger moves, and invalidate moves that would
4464 copy from where we copied to. */
4466 for (i
= 0; i
< nruns
; ++i
)
4467 if (runs
[i
]->nrows
> 0)
4469 struct run
*r
= runs
[i
];
4471 /* Copy on the display. */
4472 if (r
->current_y
!= r
->desired_y
)
4474 rif
->clear_window_mouse_face (w
);
4475 rif
->scroll_run_hook (w
, r
);
4478 /* Truncate runs that copy to where we copied to, and
4479 invalidate runs that copy from where we copied to. */
4480 for (j
= nruns
- 1; j
> i
; --j
)
4482 struct run
*p
= runs
[j
];
4483 bool truncated_p
= 0;
4486 && p
->desired_y
< r
->desired_y
+ r
->height
4487 && p
->desired_y
+ p
->height
> r
->desired_y
)
4489 if (p
->desired_y
< r
->desired_y
)
4491 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4492 p
->height
= r
->desired_y
- p
->desired_y
;
4497 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4500 if (p
->nrows
<= nrows_copied
)
4504 int height_copied
= (r
->desired_y
+ r
->height
4507 p
->current_vpos
+= nrows_copied
;
4508 p
->desired_vpos
+= nrows_copied
;
4509 p
->nrows
-= nrows_copied
;
4510 p
->current_y
+= height_copied
;
4511 p
->desired_y
+= height_copied
;
4512 p
->height
-= height_copied
;
4518 if (r
->current_y
!= r
->desired_y
4519 /* The condition below is equivalent to
4520 ((p->current_y >= r->desired_y
4521 && p->current_y < r->desired_y + r->height)
4522 || (p->current_y + p->height > r->desired_y
4523 && (p->current_y + p->height
4524 <= r->desired_y + r->height)))
4525 because we have 0 < p->height <= r->height. */
4526 && p
->current_y
< r
->desired_y
+ r
->height
4527 && p
->current_y
+ p
->height
> r
->desired_y
)
4530 /* Reorder runs by copied pixel lines if truncated. */
4531 if (truncated_p
&& p
->nrows
> 0)
4535 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4537 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4542 /* Assign matrix rows. */
4543 for (j
= 0; j
< r
->nrows
; ++j
)
4545 struct glyph_row
*from
, *to
;
4546 bool to_overlapped_p
;
4548 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4549 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4550 to_overlapped_p
= to
->overlapped_p
;
4551 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4552 assign_row (to
, from
);
4553 /* The above `assign_row' actually does swap, so if we had
4554 an overlap in the copy destination of two runs, then
4555 the second run would assign a previously disabled bogus
4556 row. But thanks to the truncation code in the
4557 preceding for-loop, we no longer have such an overlap,
4558 and thus the assigned row should always be enabled. */
4559 eassert (to
->enabled_p
);
4560 from
->enabled_p
= 0;
4561 to
->overlapped_p
= to_overlapped_p
;
4565 /* Clear the hash table, for the next time. */
4566 for (i
= 0; i
< row_entry_idx
; ++i
)
4567 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4569 /* Value is 1 to indicate that we scrolled the display. */
4575 /************************************************************************
4577 ************************************************************************/
4579 /* Update the desired frame matrix of frame F.
4581 FORCE_P means that the update should not be stopped by pending input.
4582 INHIBIT_HAIRY_ID_P means that scrolling should not be tried.
4584 Value is true if update was stopped due to pending input. */
4587 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
)
4589 /* Frame matrices to work on. */
4590 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4591 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4594 int preempt_count
= baud_rate
/ 2400 + 1;
4596 eassert (current_matrix
&& desired_matrix
);
4598 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4599 calculate_costs (f
);
4601 if (preempt_count
<= 0)
4604 #if !PERIODIC_PREEMPTION_CHECKING
4605 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4612 /* If we cannot insert/delete lines, it's no use trying it. */
4613 if (!FRAME_LINE_INS_DEL_OK (f
))
4616 /* See if any of the desired lines are enabled; don't compute for
4617 i/d line if just want cursor motion. */
4618 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4619 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4622 /* Try doing i/d line, if not yet inhibited. */
4623 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4624 force_p
|= scrolling (f
);
4626 /* Update the individual lines as needed. Do bottom line first. */
4627 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4628 update_frame_line (f
, desired_matrix
->nrows
- 1);
4630 /* Now update the rest of the lines. */
4631 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4633 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4635 if (FRAME_TERMCAP_P (f
))
4637 /* Flush out every so many lines.
4638 Also flush out if likely to have more than 1k buffered
4639 otherwise. I'm told that some telnet connections get
4640 really screwed by more than 1k output at once. */
4641 FILE *display_output
= FRAME_TTY (f
)->output
;
4644 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4646 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4648 fflush (display_output
);
4649 if (preempt_count
== 1)
4651 #ifdef EMACS_OUTQSIZE
4652 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4653 /* Probably not a tty. Ignore the error and reset
4655 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4658 if (baud_rate
<= outq
&& baud_rate
> 0)
4659 sleep (outq
/ baud_rate
);
4665 #if PERIODIC_PREEMPTION_CHECKING
4668 EMACS_TIME tm
= current_emacs_time ();
4669 if (EMACS_TIME_LT (preemption_next_check
, tm
))
4671 preemption_next_check
= add_emacs_time (tm
, preemption_period
);
4672 if (detect_input_pending_ignore_squeezables ())
4677 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4678 detect_input_pending_ignore_squeezables ();
4681 update_frame_line (f
, i
);
4685 lint_assume (0 <= FRAME_LINES (f
));
4686 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4688 /* Now just clean up termcap drivers and set cursor, etc. */
4691 if ((cursor_in_echo_area
4692 /* If we are showing a message instead of the mini-buffer,
4693 show the cursor for the message instead of for the
4694 (now hidden) mini-buffer contents. */
4695 || (EQ (minibuf_window
, selected_window
)
4696 && EQ (minibuf_window
, echo_area_window
)
4697 && !NILP (echo_area_buffer
[0])))
4698 /* These cases apply only to the frame that contains
4699 the active mini-buffer window. */
4700 && FRAME_HAS_MINIBUF_P (f
)
4701 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4703 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4706 if (cursor_in_echo_area
< 0)
4708 /* Negative value of cursor_in_echo_area means put
4709 cursor at beginning of line. */
4715 /* Positive value of cursor_in_echo_area means put
4716 cursor at the end of the prompt. If the mini-buffer
4717 is several lines high, find the last line that has
4719 row
= FRAME_LINES (f
);
4725 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4727 /* Frame rows are filled up with spaces that
4728 must be ignored here. */
4729 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4731 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4732 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4735 && (last
- 1)->charpos
< 0)
4741 while (row
> top
&& col
== 0);
4743 /* Make sure COL is not out of range. */
4744 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4746 /* If we have another row, advance cursor into it. */
4747 if (row
< FRAME_LINES (f
) - 1)
4749 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4752 /* Otherwise move it back in range. */
4754 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4758 cursor_to (f
, row
, col
);
4762 /* We have only one cursor on terminal frames. Use it to
4763 display the cursor of the selected window. */
4764 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4765 if (w
->cursor
.vpos
>= 0
4766 /* The cursor vpos may be temporarily out of bounds
4767 in the following situation: There is one window,
4768 with the cursor in the lower half of it. The window
4769 is split, and a message causes a redisplay before
4770 a new cursor position has been computed. */
4771 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4773 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4774 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4776 if (INTEGERP (w
->left_margin_cols
))
4777 x
+= XFASTINT (w
->left_margin_cols
);
4779 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4780 cursor_to (f
, y
, x
);
4785 #if !PERIODIC_PREEMPTION_CHECKING
4789 clear_desired_matrices (f
);
4794 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4797 scrolling (struct frame
*frame
)
4799 int unchanged_at_top
, unchanged_at_bottom
;
4802 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4803 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4804 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4805 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4807 int free_at_end_vpos
= FRAME_LINES (frame
);
4808 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4809 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4811 if (!current_matrix
)
4814 /* Compute hash codes of all the lines. Also calculate number of
4815 changed lines, number of unchanged lines at the beginning, and
4816 number of unchanged lines at the end. */
4818 unchanged_at_top
= 0;
4819 unchanged_at_bottom
= FRAME_LINES (frame
);
4820 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4822 /* Give up on this scrolling if some old lines are not enabled. */
4823 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4825 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4826 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4828 /* This line cannot be redrawn, so don't let scrolling mess it. */
4829 new_hash
[i
] = old_hash
[i
];
4830 #define INFINITY 1000000 /* Taken from scroll.c */
4831 draw_cost
[i
] = INFINITY
;
4835 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4836 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4839 if (old_hash
[i
] != new_hash
[i
])
4842 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4844 else if (i
== unchanged_at_top
)
4846 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4849 /* If changed lines are few, don't allow preemption, don't scroll. */
4850 if ((!FRAME_SCROLL_REGION_OK (frame
)
4851 && changed_lines
< baud_rate
/ 2400)
4852 || unchanged_at_bottom
== FRAME_LINES (frame
))
4855 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4856 - unchanged_at_bottom
);
4858 if (FRAME_SCROLL_REGION_OK (frame
))
4859 free_at_end_vpos
-= unchanged_at_bottom
;
4860 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4861 free_at_end_vpos
= -1;
4863 /* If large window, fast terminal and few lines in common between
4864 current frame and desired frame, don't bother with i/d calc. */
4865 if (!FRAME_SCROLL_REGION_OK (frame
)
4866 && window_size
>= 18 && baud_rate
> 2400
4868 10 * scrolling_max_lines_saved (unchanged_at_top
,
4869 FRAME_LINES (frame
) - unchanged_at_bottom
,
4870 old_hash
, new_hash
, draw_cost
)))
4873 if (window_size
< 2)
4876 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4877 draw_cost
+ unchanged_at_top
- 1,
4878 old_draw_cost
+ unchanged_at_top
- 1,
4879 old_hash
+ unchanged_at_top
- 1,
4880 new_hash
+ unchanged_at_top
- 1,
4881 free_at_end_vpos
- unchanged_at_top
);
4887 /* Count the number of blanks at the start of the vector of glyphs R
4888 which is LEN glyphs long. */
4891 count_blanks (struct glyph
*r
, int len
)
4895 for (i
= 0; i
< len
; ++i
)
4896 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4903 /* Count the number of glyphs in common at the start of the glyph
4904 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4905 of STR2. Value is the number of equal glyphs equal at the start. */
4908 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4910 struct glyph
*p1
= str1
;
4911 struct glyph
*p2
= str2
;
4915 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4922 /* Char insertion/deletion cost vector, from term.c */
4924 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4927 /* Perform a frame-based update on line VPOS in frame FRAME. */
4930 update_frame_line (struct frame
*f
, int vpos
)
4932 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4934 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4935 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4936 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4937 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4938 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4939 bool must_write_whole_line_p
;
4940 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4941 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4942 != FACE_TTY_DEFAULT_BG_COLOR
);
4944 if (colored_spaces_p
)
4947 /* Current row not enabled means it has unknown contents. We must
4948 write the whole desired line in that case. */
4949 must_write_whole_line_p
= !current_row
->enabled_p
;
4950 if (must_write_whole_line_p
)
4957 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4958 olen
= current_row
->used
[TEXT_AREA
];
4960 /* Ignore trailing spaces, if we can. */
4961 if (!write_spaces_p
)
4962 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4966 current_row
->enabled_p
= 1;
4967 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4969 /* If desired line is empty, just clear the line. */
4970 if (!desired_row
->enabled_p
)
4976 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4977 nlen
= desired_row
->used
[TEXT_AREA
];
4978 nend
= nbody
+ nlen
;
4980 /* If display line has unknown contents, write the whole line. */
4981 if (must_write_whole_line_p
)
4983 /* Ignore spaces at the end, if we can. */
4984 if (!write_spaces_p
)
4985 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4988 /* Write the contents of the desired line. */
4991 cursor_to (f
, vpos
, 0);
4992 write_glyphs (f
, nbody
, nlen
);
4995 /* Don't call clear_end_of_line if we already wrote the whole
4996 line. The cursor will not be at the right margin in that
4997 case but in the line below. */
4998 if (nlen
< FRAME_TOTAL_COLS (f
))
5000 cursor_to (f
, vpos
, nlen
);
5001 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5004 /* Make sure we are in the right row, otherwise cursor movement
5005 with cmgoto might use `ch' in the wrong row. */
5006 cursor_to (f
, vpos
, 0);
5008 make_current (desired_matrix
, current_matrix
, vpos
);
5012 /* Pretend trailing spaces are not there at all,
5013 unless for one reason or another we must write all spaces. */
5014 if (!write_spaces_p
)
5015 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5018 /* If there's no i/d char, quickly do the best we can without it. */
5019 if (!FRAME_CHAR_INS_DEL_OK (f
))
5023 /* Find the first glyph in desired row that doesn't agree with
5024 a glyph in the current row, and write the rest from there on. */
5025 for (i
= 0; i
< nlen
; i
++)
5027 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5029 /* Find the end of the run of different glyphs. */
5033 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5034 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5037 /* Output this run of non-matching chars. */
5038 cursor_to (f
, vpos
, i
);
5039 write_glyphs (f
, nbody
+ i
, j
- i
);
5042 /* Now find the next non-match. */
5046 /* Clear the rest of the line, or the non-clear part of it. */
5049 cursor_to (f
, vpos
, nlen
);
5050 clear_end_of_line (f
, olen
);
5053 /* Make current row = desired row. */
5054 make_current (desired_matrix
, current_matrix
, vpos
);
5058 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5059 characters in a row. */
5063 /* If current line is blank, skip over initial spaces, if
5064 possible, and write the rest. */
5068 nsp
= count_blanks (nbody
, nlen
);
5072 cursor_to (f
, vpos
, nsp
);
5073 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5076 /* Exchange contents between current_frame and new_frame. */
5077 make_current (desired_matrix
, current_matrix
, vpos
);
5081 /* Compute number of leading blanks in old and new contents. */
5082 osp
= count_blanks (obody
, olen
);
5083 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5085 /* Compute number of matching chars starting with first non-blank. */
5086 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5087 nbody
+ nsp
, nbody
+ nlen
);
5089 /* Spaces in new match implicit space past the end of old. */
5090 /* A bug causing this to be a no-op was fixed in 18.29. */
5091 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5094 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5098 /* Avoid doing insert/delete char
5099 just cause number of leading spaces differs
5100 when the following text does not match. */
5101 if (begmatch
== 0 && osp
!= nsp
)
5102 osp
= nsp
= min (osp
, nsp
);
5104 /* Find matching characters at end of line */
5107 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5109 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5114 endmatch
= obody
+ olen
- op1
;
5116 /* tem gets the distance to insert or delete.
5117 endmatch is how many characters we save by doing so.
5120 tem
= (nlen
- nsp
) - (olen
- osp
);
5122 && (!FRAME_CHAR_INS_DEL_OK (f
)
5123 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5126 /* nsp - osp is the distance to insert or delete.
5127 If that is nonzero, begmatch is known to be nonzero also.
5128 begmatch + endmatch is how much we save by doing the ins/del.
5132 && (!FRAME_CHAR_INS_DEL_OK (f
)
5133 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5137 osp
= nsp
= min (osp
, nsp
);
5140 /* Now go through the line, inserting, writing and
5141 deleting as appropriate. */
5145 cursor_to (f
, vpos
, nsp
);
5146 delete_glyphs (f
, osp
- nsp
);
5150 /* If going to delete chars later in line
5151 and insert earlier in the line,
5152 must delete first to avoid losing data in the insert */
5153 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5155 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5156 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5157 olen
= nlen
- (nsp
- osp
);
5159 cursor_to (f
, vpos
, osp
);
5160 insert_glyphs (f
, 0, nsp
- osp
);
5164 tem
= nsp
+ begmatch
+ endmatch
;
5165 if (nlen
!= tem
|| olen
!= tem
)
5167 if (!endmatch
|| nlen
== olen
)
5169 /* If new text being written reaches right margin, there is
5170 no need to do clear-to-eol at the end of this function
5171 (and it would not be safe, since cursor is not going to
5172 be "at the margin" after the text is done). */
5173 if (nlen
== FRAME_TOTAL_COLS (f
))
5176 /* Function write_glyphs is prepared to do nothing
5177 if passed a length <= 0. Check it here to avoid
5178 unnecessary cursor movement. */
5181 cursor_to (f
, vpos
, nsp
+ begmatch
);
5182 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5185 else if (nlen
> olen
)
5187 /* Here, we used to have the following simple code:
5188 ----------------------------------------
5189 write_glyphs (nbody + nsp + begmatch, olen - tem);
5190 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5191 ----------------------------------------
5192 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5193 is a padding glyph. */
5194 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5197 cursor_to (f
, vpos
, nsp
+ begmatch
);
5199 /* Calculate columns we can actually overwrite. */
5200 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5202 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5204 /* If we left columns to be overwritten, we must delete them. */
5205 del
= olen
- tem
- out
;
5207 delete_glyphs (f
, del
);
5209 /* At last, we insert columns not yet written out. */
5210 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5213 else if (olen
> nlen
)
5215 cursor_to (f
, vpos
, nsp
+ begmatch
);
5216 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5217 delete_glyphs (f
, olen
- nlen
);
5223 /* If any unerased characters remain after the new line, erase them. */
5226 cursor_to (f
, vpos
, nlen
);
5227 clear_end_of_line (f
, olen
);
5230 /* Exchange contents between current_frame and new_frame. */
5231 make_current (desired_matrix
, current_matrix
, vpos
);
5236 /***********************************************************************
5237 X/Y Position -> Buffer Position
5238 ***********************************************************************/
5240 /* Determine what's under window-relative pixel position (*X, *Y).
5241 Return the OBJECT (string or buffer) that's there.
5242 Return in *POS the position in that object.
5243 Adjust *X and *Y to character positions.
5244 Return in *DX and *DY the pixel coordinates of the click,
5245 relative to the top left corner of OBJECT, or relative to
5246 the top left corner of the character glyph at (*X, *Y)
5248 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5249 if the coordinates point to an empty area of the display. */
5252 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
)
5255 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5256 struct text_pos startp
;
5258 struct glyph_row
*row
;
5259 #ifdef HAVE_WINDOW_SYSTEM
5260 struct image
*img
= 0;
5263 void *itdata
= NULL
;
5265 /* We used to set current_buffer directly here, but that does the
5266 wrong thing with `face-remapping-alist' (bug#2044). */
5267 Fset_buffer (w
->buffer
);
5268 itdata
= bidi_shelve_cache ();
5269 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5270 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5271 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5272 start_display (&it
, w
, startp
);
5273 /* start_display takes into account the header-line row, but IT's
5274 vpos still counts from the glyph row that includes the window's
5275 start position. Adjust for a possible header-line row. */
5276 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
);
5280 /* First, move to the beginning of the row corresponding to *Y. We
5281 need to be in that row to get the correct value of base paragraph
5282 direction for the text at (*X, *Y). */
5283 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5285 /* TO_X is the pixel position that the iterator will compute for the
5286 glyph at *X. We add it.first_visible_x because iterator
5287 positions include the hscroll. */
5288 to_x
= x0
+ it
.first_visible_x
;
5289 if (it
.bidi_it
.paragraph_dir
== R2L
)
5290 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5291 text area. This is because the iterator, even in R2L
5292 paragraphs, delivers glyphs as if they started at the left
5293 margin of the window. (When we actually produce glyphs for
5294 display, we reverse their order in PRODUCE_GLYPHS, but the
5295 iterator doesn't know about that.) The following line adjusts
5296 the pixel position to the iterator geometry, which is what
5297 move_it_* routines use. (The -1 is because in a window whose
5298 text-area width is W, the rightmost pixel position is W-1, and
5299 it should be mirrored into zero pixel position.) */
5300 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5302 /* Now move horizontally in the row to the glyph under *X. Second
5303 argument is ZV to prevent move_it_in_display_line from matching
5304 based on buffer positions. */
5305 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5306 bidi_unshelve_cache (itdata
, 0);
5308 Fset_buffer (old_current_buffer
);
5310 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5311 *dy
= *y
- it
.current_y
;
5314 if (STRINGP (it
.string
))
5317 if (it
.what
== IT_COMPOSITION
5318 && it
.cmp_it
.nchars
> 1
5319 && it
.cmp_it
.reversed_p
)
5321 /* The current display element is a grapheme cluster in a
5322 composition. In that case, we need the position of the first
5323 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5324 it.current points to the last character of the cluster, thus
5325 we must move back to the first character of the same
5327 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5328 if (STRINGP (it
.string
))
5329 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5331 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->buffer
),
5332 CHARPOS (pos
->pos
));
5335 #ifdef HAVE_WINDOW_SYSTEM
5336 if (it
.what
== IT_IMAGE
)
5338 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5339 && !NILP (img
->spec
))
5340 *object
= img
->spec
;
5344 if (it
.vpos
< w
->current_matrix
->nrows
5345 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5348 if (it
.hpos
< row
->used
[TEXT_AREA
])
5350 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5351 #ifdef HAVE_WINDOW_SYSTEM
5354 *dy
-= row
->ascent
- glyph
->ascent
;
5355 *dx
+= glyph
->slice
.img
.x
;
5356 *dy
+= glyph
->slice
.img
.y
;
5357 /* Image slices positions are still relative to the entire image */
5358 *width
= img
->width
;
5359 *height
= img
->height
;
5364 *width
= glyph
->pixel_width
;
5365 *height
= glyph
->ascent
+ glyph
->descent
;
5371 *height
= row
->height
;
5376 *width
= *height
= 0;
5379 /* Add extra (default width) columns if clicked after EOL. */
5380 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5382 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5391 /* Value is the string under window-relative coordinates X/Y in the
5392 mode line or header line (PART says which) of window W, or nil if none.
5393 *CHARPOS is set to the position in the string returned. */
5396 mode_line_string (struct window
*w
, enum window_part part
,
5397 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5398 int *dx
, int *dy
, int *width
, int *height
)
5400 struct glyph_row
*row
;
5401 struct glyph
*glyph
, *end
;
5403 Lisp_Object string
= Qnil
;
5405 if (part
== ON_MODE_LINE
)
5406 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5408 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5410 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5412 if (row
->mode_line_p
&& row
->enabled_p
)
5414 /* Find the glyph under X. If we find one with a string object,
5415 it's the one we were looking for. */
5416 glyph
= row
->glyphs
[TEXT_AREA
];
5417 end
= glyph
+ row
->used
[TEXT_AREA
];
5418 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5419 x0
-= glyph
->pixel_width
;
5420 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5423 string
= glyph
->object
;
5424 *charpos
= glyph
->charpos
;
5425 *width
= glyph
->pixel_width
;
5426 *height
= glyph
->ascent
+ glyph
->descent
;
5427 #ifdef HAVE_WINDOW_SYSTEM
5428 if (glyph
->type
== IMAGE_GLYPH
)
5431 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5433 *object
= img
->spec
;
5434 y0
-= row
->ascent
- glyph
->ascent
;
5440 /* Add extra (default width) columns if clicked after EOL. */
5441 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5443 *height
= row
->height
;
5450 *width
= *height
= 0;
5460 /* Value is the string under window-relative coordinates X/Y in either
5461 marginal area, or nil if none. *CHARPOS is set to the position in
5462 the string returned. */
5465 marginal_area_string (struct window
*w
, enum window_part part
,
5466 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5467 int *dx
, int *dy
, int *width
, int *height
)
5469 struct glyph_row
*row
= w
->current_matrix
->rows
;
5470 struct glyph
*glyph
, *end
;
5471 int x0
, y0
, i
, wy
= *y
;
5473 Lisp_Object string
= Qnil
;
5475 if (part
== ON_LEFT_MARGIN
)
5476 area
= LEFT_MARGIN_AREA
;
5477 else if (part
== ON_RIGHT_MARGIN
)
5478 area
= RIGHT_MARGIN_AREA
;
5482 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5483 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5486 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5490 /* Find the glyph under X. If we find one with a string object,
5491 it's the one we were looking for. */
5492 if (area
== RIGHT_MARGIN_AREA
)
5493 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5494 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5495 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5496 + window_box_width (w
, LEFT_MARGIN_AREA
)
5497 + window_box_width (w
, TEXT_AREA
));
5499 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5500 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5503 glyph
= row
->glyphs
[area
];
5504 end
= glyph
+ row
->used
[area
];
5505 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5506 x0
-= glyph
->pixel_width
;
5507 *x
= glyph
- row
->glyphs
[area
];
5510 string
= glyph
->object
;
5511 *charpos
= glyph
->charpos
;
5512 *width
= glyph
->pixel_width
;
5513 *height
= glyph
->ascent
+ glyph
->descent
;
5514 #ifdef HAVE_WINDOW_SYSTEM
5515 if (glyph
->type
== IMAGE_GLYPH
)
5518 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5520 *object
= img
->spec
;
5521 y0
-= row
->ascent
- glyph
->ascent
;
5522 x0
+= glyph
->slice
.img
.x
;
5523 y0
+= glyph
->slice
.img
.y
;
5529 /* Add extra (default width) columns if clicked after EOL. */
5530 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5532 *height
= row
->height
;
5539 *width
= *height
= 0;
5549 /***********************************************************************
5550 Changing Frame Sizes
5551 ***********************************************************************/
5555 static void deliver_window_change_signal (int);
5558 handle_window_change_signal (int sig
)
5561 struct tty_display_info
*tty
;
5563 signal (SIGWINCH
, deliver_window_change_signal
);
5565 /* The frame size change obviously applies to a single
5566 termcap-controlled terminal, but we can't decide which.
5567 Therefore, we resize the frames corresponding to each tty.
5569 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5571 if (! tty
->term_initted
)
5574 /* Suspended tty frames have tty->input == NULL avoid trying to
5579 get_tty_size (fileno (tty
->input
), &width
, &height
);
5581 if (width
> 5 && height
> 2) {
5582 Lisp_Object tail
, frame
;
5584 FOR_EACH_FRAME (tail
, frame
)
5585 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5586 /* Record the new sizes, but don't reallocate the data
5587 structures now. Let that be done later outside of the
5589 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5595 deliver_window_change_signal (int sig
)
5597 handle_on_main_thread (sig
, handle_window_change_signal
);
5599 #endif /* SIGWINCH */
5602 /* Do any change in frame size that was requested by a signal.
5603 SAFE means this function is called from a place where it is
5604 safe to change frame sizes while a redisplay is in progress. */
5607 do_pending_window_change (bool safe
)
5609 /* If window change signal handler should have run before, run it now. */
5610 if (redisplaying_p
&& !safe
)
5613 while (delayed_size_change
)
5615 Lisp_Object tail
, frame
;
5617 delayed_size_change
= 0;
5619 FOR_EACH_FRAME (tail
, frame
)
5621 struct frame
*f
= XFRAME (frame
);
5623 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5624 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5631 /* Change the frame height and/or width. Values may be given as zero to
5632 indicate no change is to take place.
5634 If DELAY, assume we're being called from a signal handler, and
5635 queue the change for later - perhaps the next redisplay.
5636 Since this tries to resize windows, we can't call it
5637 from a signal handler.
5639 SAFE means this function is called from a place where it's
5640 safe to change frame sizes while a redisplay is in progress. */
5643 change_frame_size (struct frame
*f
, int newheight
, int newwidth
,
5644 bool pretend
, bool delay
, bool safe
)
5646 Lisp_Object tail
, frame
;
5648 if (FRAME_MSDOS_P (f
))
5650 /* On MS-DOS, all frames use the same screen, so a change in
5651 size affects all frames. Termcap now supports multiple
5653 FOR_EACH_FRAME (tail
, frame
)
5654 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5655 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5656 pretend
, delay
, safe
);
5659 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5663 change_frame_size_1 (struct frame
*f
, int newheight
, int newwidth
,
5664 bool pretend
, bool delay
, bool safe
)
5666 int new_frame_total_cols
;
5667 ptrdiff_t count
= SPECPDL_INDEX ();
5669 /* If we can't deal with the change now, queue it for later. */
5670 if (delay
|| (redisplaying_p
&& !safe
))
5672 f
->new_text_lines
= newheight
;
5673 f
->new_text_cols
= newwidth
;
5674 delayed_size_change
= 1;
5678 /* This size-change overrides any pending one for this frame. */
5679 f
->new_text_lines
= 0;
5680 f
->new_text_cols
= 0;
5682 /* If an argument is zero, set it to the current value. */
5684 newheight
= FRAME_LINES (f
);
5686 newwidth
= FRAME_COLS (f
);
5688 /* Compute width of windows in F. */
5689 /* Round up to the smallest acceptable size. */
5690 check_frame_size (f
, &newheight
, &newwidth
);
5692 /* This is the width of the frame with vertical scroll bars and fringe
5693 columns. Do this after rounding - see discussion of bug#9723. */
5694 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5696 /* If we're not changing the frame size, quit now. */
5697 /* Frame width may be unchanged but the text portion may change, for
5698 example, fullscreen and remove/add scroll bar. */
5699 if (newheight
== FRAME_LINES (f
)
5700 /* Text portion unchanged? */
5701 && newwidth
== FRAME_COLS (f
)
5702 /* Frame width unchanged? */
5703 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5709 /* We only can set screen dimensions to certain values supported
5710 by our video hardware. Try to find the smallest size greater
5711 or equal to the requested dimensions. */
5712 dos_set_window_size (&newheight
, &newwidth
);
5715 if (newheight
!= FRAME_LINES (f
))
5717 resize_frame_windows (f
, newheight
, 0);
5719 /* MSDOS frames cannot PRETEND, as they change frame size by
5720 manipulating video hardware. */
5721 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5722 FrameRows (FRAME_TTY (f
)) = newheight
;
5725 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5727 resize_frame_windows (f
, new_frame_total_cols
, 1);
5729 /* MSDOS frames cannot PRETEND, as they change frame size by
5730 manipulating video hardware. */
5731 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5732 FrameCols (FRAME_TTY (f
)) = newwidth
;
5734 if (WINDOWP (f
->tool_bar_window
))
5735 wset_total_cols (XWINDOW (f
->tool_bar_window
), make_number (newwidth
));
5738 FRAME_LINES (f
) = newheight
;
5739 SET_FRAME_COLS (f
, newwidth
);
5742 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5743 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5745 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5747 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5748 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5749 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5750 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5754 calculate_costs (f
);
5755 SET_FRAME_GARBAGED (f
);
5760 record_unwind_current_buffer ();
5762 run_window_configuration_change_hook (f
);
5764 unbind_to (count
, Qnil
);
5769 /***********************************************************************
5770 Terminal Related Lisp Functions
5771 ***********************************************************************/
5773 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5774 1, 1, "FOpen termscript file: ",
5775 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5776 FILE = nil means just close any termscript file currently open. */)
5779 struct tty_display_info
*tty
;
5781 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5782 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5783 error ("Current frame is not on a tty device");
5787 if (tty
->termscript
!= 0)
5790 fclose (tty
->termscript
);
5793 tty
->termscript
= 0;
5797 file
= Fexpand_file_name (file
, Qnil
);
5798 tty
->termscript
= fopen (SSDATA (file
), "w");
5799 if (tty
->termscript
== 0)
5800 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5806 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5807 Ssend_string_to_terminal
, 1, 2, 0,
5808 doc
: /* Send STRING to the terminal without alteration.
5809 Control characters in STRING will have terminal-dependent effects.
5811 Optional parameter TERMINAL specifies the tty terminal device to use.
5812 It may be a terminal object, a frame, or nil for the terminal used by
5813 the currently selected frame. In batch mode, STRING is sent to stdout
5814 when TERMINAL is nil. */)
5815 (Lisp_Object string
, Lisp_Object terminal
)
5817 struct terminal
*t
= get_terminal (terminal
, 1);
5820 /* ??? Perhaps we should do something special for multibyte strings here. */
5821 CHECK_STRING (string
);
5825 error ("Unknown terminal device");
5827 if (t
->type
== output_initial
)
5829 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5830 error ("Device %d is not a termcap terminal device", t
->id
);
5833 struct tty_display_info
*tty
= t
->display_info
.tty
;
5836 error ("Terminal is currently suspended");
5838 if (tty
->termscript
)
5840 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5841 fflush (tty
->termscript
);
5845 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5852 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5853 doc
: /* Beep, or flash the screen.
5854 Also, unless an argument is given,
5855 terminate any keyboard macro currently executing. */)
5863 ring_bell (XFRAME (selected_frame
));
5872 bitch_at_user (void)
5876 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5877 error ("Keyboard macro terminated by a command ringing the bell");
5879 ring_bell (XFRAME (selected_frame
));
5884 /***********************************************************************
5886 ***********************************************************************/
5888 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5889 doc
: /* Pause, without updating display, for SECONDS seconds.
5890 SECONDS may be a floating-point value, meaning that you can wait for a
5891 fraction of a second. Optional second arg MILLISECONDS specifies an
5892 additional wait period, in milliseconds; this is for backwards compatibility.
5893 \(Not all operating systems support waiting for a fraction of a second.) */)
5894 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5896 double duration
= extract_float (seconds
);
5898 if (!NILP (milliseconds
))
5900 CHECK_NUMBER (milliseconds
);
5901 duration
+= XINT (milliseconds
) / 1000.0;
5906 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (duration
);
5907 wait_reading_process_output (min (EMACS_SECS (t
), WAIT_READING_MAX
),
5908 EMACS_NSECS (t
), 0, 0, Qnil
, NULL
, 0);
5915 /* This is just like wait_reading_process_output, except that
5918 TIMEOUT is number of seconds to wait (float or integer),
5919 or t to wait forever.
5920 READING is true if reading input.
5921 If DO_DISPLAY is >0 display process output while waiting.
5922 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5926 sit_for (Lisp_Object timeout
, bool reading
, int do_display
)
5931 swallow_events (do_display
);
5933 if ((detect_input_pending_run_timers (do_display
))
5934 || !NILP (Vexecuting_kbd_macro
))
5937 if (do_display
>= 2)
5938 redisplay_preserve_echo_area (2);
5940 if (INTEGERP (timeout
))
5942 sec
= XINT (timeout
);
5947 else if (FLOATP (timeout
))
5949 double seconds
= XFLOAT_DATA (timeout
);
5950 if (! (0 < seconds
))
5954 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (seconds
);
5955 sec
= min (EMACS_SECS (t
), WAIT_READING_MAX
);
5956 nsec
= EMACS_NSECS (t
);
5959 else if (EQ (timeout
, Qt
))
5965 wrong_type_argument (Qnumberp
, timeout
);
5972 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5975 return detect_input_pending () ? Qnil
: Qt
;
5979 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5980 doc
: /* Perform redisplay.
5981 Optional arg FORCE, if non-nil, prevents redisplay from being
5982 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5983 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5984 preempted by arriving input, so FORCE does nothing.
5986 Return t if redisplay was performed, nil if redisplay was preempted
5987 immediately by pending input. */)
5993 if ((detect_input_pending_run_timers (1)
5994 && NILP (force
) && !redisplay_dont_pause
)
5995 || !NILP (Vexecuting_kbd_macro
))
5998 count
= SPECPDL_INDEX ();
5999 if (!NILP (force
) && !redisplay_dont_pause
)
6000 specbind (Qredisplay_dont_pause
, Qt
);
6001 redisplay_preserve_echo_area (2);
6002 unbind_to (count
, Qnil
);
6008 /***********************************************************************
6009 Other Lisp Functions
6010 ***********************************************************************/
6012 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6013 session's frames, frame names, buffers, buffer-read-only flags, and
6014 buffer-modified-flags. */
6016 static Lisp_Object frame_and_buffer_state
;
6019 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6020 Sframe_or_buffer_changed_p
, 0, 1, 0,
6021 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6022 VARIABLE is a variable name whose value is either nil or a state vector
6023 that will be updated to contain all frames and buffers,
6024 aside from buffers whose names start with space,
6025 along with the buffers' read-only and modified flags. This allows a fast
6026 check to see whether buffer menus might need to be recomputed.
6027 If this function returns non-nil, it updates the internal vector to reflect
6030 If VARIABLE is nil, an internal variable is used. Users should not
6031 pass nil for VARIABLE. */)
6032 (Lisp_Object variable
)
6034 Lisp_Object state
, tail
, frame
, buf
;
6037 if (! NILP (variable
))
6039 CHECK_SYMBOL (variable
);
6040 state
= Fsymbol_value (variable
);
6041 if (! VECTORP (state
))
6045 state
= frame_and_buffer_state
;
6048 FOR_EACH_FRAME (tail
, frame
)
6050 if (idx
== ASIZE (state
))
6052 if (!EQ (AREF (state
, idx
++), frame
))
6054 if (idx
== ASIZE (state
))
6056 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
6059 /* Check that the buffer info matches. */
6060 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6062 buf
= XCDR (XCAR (tail
));
6063 /* Ignore buffers that aren't included in buffer lists. */
6064 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6066 if (idx
== ASIZE (state
))
6068 if (!EQ (AREF (state
, idx
++), buf
))
6070 if (idx
== ASIZE (state
))
6072 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
6074 if (idx
== ASIZE (state
))
6076 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
6079 if (idx
== ASIZE (state
))
6081 /* Detect deletion of a buffer at the end of the list. */
6082 if (EQ (AREF (state
, idx
), Qlambda
))
6085 /* Come here if we decide the data has changed. */
6087 /* Count the size we will need.
6088 Start with 1 so there is room for at least one lambda at the end. */
6090 FOR_EACH_FRAME (tail
, frame
)
6092 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6094 /* Reallocate the vector if data has grown to need it,
6095 or if it has shrunk a lot. */
6096 if (! VECTORP (state
)
6097 || n
> ASIZE (state
)
6098 || n
+ 20 < ASIZE (state
) / 2)
6099 /* Add 20 extra so we grow it less often. */
6101 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6102 if (! NILP (variable
))
6103 Fset (variable
, state
);
6105 frame_and_buffer_state
= state
;
6108 /* Record the new data in the (possibly reallocated) vector. */
6110 FOR_EACH_FRAME (tail
, frame
)
6112 ASET (state
, idx
, frame
);
6114 ASET (state
, idx
, XFRAME (frame
)->name
);
6117 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6119 buf
= XCDR (XCAR (tail
));
6120 /* Ignore buffers that aren't included in buffer lists. */
6121 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6123 ASET (state
, idx
, buf
);
6125 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
6127 ASET (state
, idx
, Fbuffer_modified_p (buf
));
6130 /* Fill up the vector with lambdas (always at least one). */
6131 ASET (state
, idx
, Qlambda
);
6133 while (idx
< ASIZE (state
))
6135 ASET (state
, idx
, Qlambda
);
6138 /* Make sure we didn't overflow the vector. */
6139 eassert (idx
<= ASIZE (state
));
6145 /***********************************************************************
6147 ***********************************************************************/
6149 /* Initialization done when Emacs fork is started, before doing stty.
6150 Determine terminal type and set terminal_driver. Then invoke its
6151 decoding routine to set up variables in the terminal package. */
6156 char *terminal_type
;
6158 /* Construct the space glyph. */
6159 space_glyph
.type
= CHAR_GLYPH
;
6160 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6161 space_glyph
.charpos
= -1;
6164 cursor_in_echo_area
= 0;
6165 terminal_type
= (char *) 0;
6167 /* Now is the time to initialize this; it's used by init_sys_modes
6169 Vinitial_window_system
= Qnil
;
6171 /* SIGWINCH needs to be handled no matter what display we start
6172 with. Otherwise newly opened tty frames will not resize
6177 #endif /* CANNOT_DUMP */
6178 signal (SIGWINCH
, deliver_window_change_signal
);
6179 #endif /* SIGWINCH */
6181 /* If running as a daemon, no need to initialize any frames/terminal. */
6185 /* If the user wants to use a window system, we shouldn't bother
6186 initializing the terminal. This is especially important when the
6187 terminal is so dumb that emacs gives up before and doesn't bother
6188 using the window system.
6190 If the DISPLAY environment variable is set and nonempty,
6191 try to use X, and die with an error message if that doesn't work. */
6193 #ifdef HAVE_X_WINDOWS
6194 if (! inhibit_window_system
&& ! display_arg
)
6197 display
= getenv ("DISPLAY");
6198 display_arg
= (display
!= 0 && *display
!= 0);
6200 if (display_arg
&& !x_display_ok (display
))
6202 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6204 inhibit_window_system
= 1;
6208 if (!inhibit_window_system
&& display_arg
)
6210 Vinitial_window_system
= Qx
;
6212 Vwindow_system_version
= make_number (11);
6215 /* In some versions of ncurses,
6216 tputs crashes if we have not called tgetent.
6218 { char b
[2044]; tgetent (b
, "xterm");}
6220 adjust_frame_glyphs_initially ();
6223 #endif /* HAVE_X_WINDOWS */
6226 if (!inhibit_window_system
)
6228 Vinitial_window_system
= Qw32
;
6229 Vwindow_system_version
= make_number (1);
6230 adjust_frame_glyphs_initially ();
6233 #endif /* HAVE_NTGUI */
6236 if (!inhibit_window_system
6242 Vinitial_window_system
= Qns
;
6243 Vwindow_system_version
= make_number (10);
6244 adjust_frame_glyphs_initially ();
6249 /* If no window system has been specified, try to use the terminal. */
6252 fatal ("standard input is not a tty");
6257 terminal_type
= "w32console";
6259 /* Look at the TERM variable. */
6260 terminal_type
= (char *) getenv ("TERM");
6264 #ifdef HAVE_WINDOW_SYSTEM
6265 if (! inhibit_window_system
)
6266 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6268 #endif /* HAVE_WINDOW_SYSTEM */
6269 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6275 struct frame
*f
= XFRAME (selected_frame
);
6277 /* Open a display on the controlling tty. */
6278 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6280 /* Convert the initial frame to use the new display. */
6281 if (f
->output_method
!= output_initial
)
6283 f
->output_method
= t
->type
;
6286 t
->reference_count
++;
6288 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6290 if (f
->output_method
== output_termcap
)
6291 create_tty_output (f
);
6293 t
->display_info
.tty
->top_frame
= selected_frame
;
6294 change_frame_size (XFRAME (selected_frame
),
6295 FrameRows (t
->display_info
.tty
),
6296 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6298 /* Delete the initial terminal. */
6299 if (--initial_terminal
->reference_count
== 0
6300 && initial_terminal
->delete_terminal_hook
)
6301 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6303 /* Update frame parameters to reflect the new type. */
6304 Fmodify_frame_parameters
6305 (selected_frame
, Fcons (Fcons (Qtty_type
,
6306 Ftty_type (selected_frame
)), Qnil
));
6307 if (t
->display_info
.tty
->name
)
6308 Fmodify_frame_parameters (selected_frame
,
6309 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6312 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6317 struct frame
*sf
= SELECTED_FRAME ();
6318 int width
= FRAME_TOTAL_COLS (sf
);
6319 int height
= FRAME_LINES (sf
);
6321 /* If these sizes are so big they cause overflow, just ignore the
6322 change. It's not clear what better we could do. The rest of
6323 the code assumes that (width + 2) * height * sizeof (struct glyph)
6324 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6325 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6326 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6327 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6328 < (width
+ 2) * height
))
6329 fatal ("screen size %dx%d too big", width
, height
);
6332 adjust_frame_glyphs_initially ();
6333 calculate_costs (XFRAME (selected_frame
));
6335 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6338 && NILP (Vinitial_window_system
))
6340 /* For the initial frame, we don't have any way of knowing what
6341 are the foreground and background colors of the terminal. */
6342 struct frame
*sf
= SELECTED_FRAME ();
6344 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6345 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6346 call0 (intern ("tty-set-up-initial-frame-faces"));
6352 /***********************************************************************
6354 ***********************************************************************/
6356 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6357 Sinternal_show_cursor
, 2, 2, 0,
6358 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6359 WINDOW nil means use the selected window. SHOW non-nil means
6360 show a cursor in WINDOW in the next redisplay. SHOW nil means
6361 don't show a cursor. */)
6362 (Lisp_Object window
, Lisp_Object show
)
6364 /* Don't change cursor state while redisplaying. This could confuse
6366 if (!redisplaying_p
)
6369 window
= selected_window
;
6371 CHECK_WINDOW (window
);
6373 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6380 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6381 Sinternal_show_cursor_p
, 0, 1, 0,
6382 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6383 WINDOW nil or omitted means report on the selected window. */)
6384 (Lisp_Object window
)
6389 window
= selected_window
;
6391 CHECK_WINDOW (window
);
6393 w
= XWINDOW (window
);
6394 return w
->cursor_off_p
? Qnil
: Qt
;
6397 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6398 Slast_nonminibuf_frame
, 0, 0, 0,
6399 doc
: /* Value is last nonminibuffer frame. */)
6402 Lisp_Object frame
= Qnil
;
6404 if (last_nonminibuf_frame
)
6405 XSETFRAME (frame
, last_nonminibuf_frame
);
6410 /***********************************************************************
6412 ***********************************************************************/
6415 syms_of_display (void)
6417 defsubr (&Sredraw_frame
);
6418 defsubr (&Sredraw_display
);
6419 defsubr (&Sframe_or_buffer_changed_p
);
6420 defsubr (&Sopen_termscript
);
6422 defsubr (&Sredisplay
);
6423 defsubr (&Ssleep_for
);
6424 defsubr (&Ssend_string_to_terminal
);
6425 defsubr (&Sinternal_show_cursor
);
6426 defsubr (&Sinternal_show_cursor_p
);
6427 defsubr (&Slast_nonminibuf_frame
);
6430 defsubr (&Sdump_redisplay_history
);
6433 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6434 staticpro (&frame_and_buffer_state
);
6436 DEFSYM (Qdisplay_table
, "display-table");
6437 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6439 DEFVAR_INT ("baud-rate", baud_rate
,
6440 doc
: /* The output baud rate of the terminal.
6441 On most systems, changing this value will affect the amount of padding
6442 and the other strategic decisions made during redisplay. */);
6444 DEFVAR_BOOL ("inverse-video", inverse_video
,
6445 doc
: /* Non-nil means invert the entire frame display.
6446 This means everything is in inverse video which otherwise would not be. */);
6448 DEFVAR_BOOL ("visible-bell", visible_bell
,
6449 doc
: /* Non-nil means try to flash the frame to represent a bell.
6451 See also `ring-bell-function'. */);
6453 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6454 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6455 A non-nil value is useful if the terminal can automatically preserve
6456 Emacs's frame display when you reenter Emacs.
6457 It is up to you to set this variable if your terminal can do that. */);
6459 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6460 doc
: /* Name of the window system that Emacs uses for the first frame.
6461 The value is a symbol:
6462 nil for a termcap frame (a character-only terminal),
6463 'x' for an Emacs frame that is really an X window,
6464 'w32' for an Emacs frame that is a window on MS-Windows display,
6465 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6466 'pc' for a direct-write MS-DOS frame.
6468 Use of this variable as a boolean is deprecated. Instead,
6469 use `display-graphic-p' or any of the other `display-*-p'
6470 predicates which report frame's specific UI-related capabilities. */);
6472 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6473 doc
: /* Name of window system through which the selected frame is displayed.
6474 The value is a symbol:
6475 nil for a termcap frame (a character-only terminal),
6476 'x' for an Emacs frame that is really an X window,
6477 'w32' for an Emacs frame that is a window on MS-Windows display,
6478 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6479 'pc' for a direct-write MS-DOS frame.
6481 Use of this variable as a boolean is deprecated. Instead,
6482 use `display-graphic-p' or any of the other `display-*-p'
6483 predicates which report frame's specific UI-related capabilities. */);
6485 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6486 doc
: /* The version number of the window system in use.
6487 For X windows, this is 11. */);
6489 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6490 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6492 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6493 doc
: /* Table defining how to output a glyph code to the frame.
6494 If not nil, this is a vector indexed by glyph code to define the glyph.
6495 Each element can be:
6496 integer: a glyph code which this glyph is an alias for.
6497 string: output this glyph using that string (not impl. in X windows).
6498 nil: this glyph mod 524288 is the code of a character to output,
6499 and this glyph / 524288 is the face number (see `face-id') to use
6500 while outputting it. */);
6501 Vglyph_table
= Qnil
;
6503 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6504 doc
: /* Display table to use for buffers that specify none.
6505 See `buffer-display-table' for more information. */);
6506 Vstandard_display_table
= Qnil
;
6508 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6509 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6510 redisplay_dont_pause
= 1;
6512 #if PERIODIC_PREEMPTION_CHECKING
6513 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6514 doc
: /* Period in seconds between checking for input during redisplay.
6515 This has an effect only if `redisplay-dont-pause' is nil; in that
6516 case, arriving input preempts redisplay until the input is processed.
6517 If the value is nil, redisplay is never preempted. */);
6518 Vredisplay_preemption_period
= make_float (0.10);
6525 Vinitial_window_system
= Qnil
;
6526 Vwindow_system_version
= Qnil
;