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
33 /* cm.h must come after dispextern.h on Windows. */
34 #include "dispextern.h"
36 #include "character.h"
40 #include "termhooks.h"
45 #include "intervals.h"
46 #include "blockinput.h"
49 #include "syssignal.h"
53 #endif /* HAVE_X_WINDOWS */
57 #endif /* HAVE_NTGUI */
63 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
68 #ifdef DISPNEW_NEEDS_STDIO_EXT
69 #include <stdio_ext.h>
72 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
73 #include <term.h> /* for tgetent */
76 /* Structure to pass dimensions around. Used for character bounding
77 boxes, glyph matrix dimensions and alike. */
86 /* Function prototypes. */
88 static void update_frame_line (struct frame
*, int);
89 static int required_matrix_height (struct window
*);
90 static int required_matrix_width (struct window
*);
91 static void adjust_frame_glyphs (struct frame
*);
92 static void change_frame_size_1 (struct frame
*, int, int, int, int, int);
93 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
94 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
95 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
97 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
99 static void adjust_frame_message_buffer (struct frame
*);
100 static void adjust_decode_mode_spec_buffer (struct frame
*);
101 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
102 static void clear_window_matrices (struct window
*, int);
103 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
104 static int scrolling_window (struct window
*, int);
105 static int update_window_line (struct window
*, int, int *);
106 static void mirror_make_current (struct window
*, int);
108 static void check_matrix_pointers (struct glyph_matrix
*,
109 struct glyph_matrix
*);
111 static void mirror_line_dance (struct window
*, int, int, int *, char *);
112 static int update_window_tree (struct window
*, int);
113 static int update_window (struct window
*, int);
114 static int update_frame_1 (struct frame
*, int, int);
115 static int scrolling (struct frame
*);
116 static void set_window_cursor_after_update (struct window
*);
117 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
118 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
121 /* Redisplay preemption timers. */
123 static EMACS_TIME preemption_period
;
124 static EMACS_TIME preemption_next_check
;
126 /* Nonzero upon entry to redisplay means do not assume anything about
127 current contents of actual terminal frame; clear and redraw it. */
131 /* Nonzero means last display completed. Zero means it was preempted. */
133 int display_completed
;
135 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
138 /* The currently selected frame. In a single-frame version, this
139 variable always equals the_only_frame. */
141 Lisp_Object selected_frame
;
143 /* A frame which is not just a mini-buffer, or 0 if there are no such
144 frames. This is usually the most recent such frame that was
145 selected. In a single-frame version, this variable always holds
146 the address of the_only_frame. */
148 struct frame
*last_nonminibuf_frame
;
150 /* 1 means SIGWINCH happened when not safe. */
152 static int delayed_size_change
;
154 /* 1 means glyph initialization has been completed at startup. */
156 static int glyphs_initialized_initially_p
;
158 /* Updated window if != 0. Set by update_window. */
160 struct window
*updated_window
;
162 /* Glyph row updated in update_window_line, and area that is updated. */
164 struct glyph_row
*updated_row
;
167 /* A glyph for a space. */
169 struct glyph space_glyph
;
171 /* Counts of allocated structures. These counts serve to diagnose
172 memory leaks and double frees. */
174 static int glyph_matrix_count
;
175 static int glyph_pool_count
;
177 /* If non-null, the frame whose frame matrices are manipulated. If
178 null, window matrices are worked on. */
180 static struct frame
*frame_matrix_frame
;
182 /* Non-zero means that fonts have been loaded since the last glyph
183 matrix adjustments. Redisplay must stop, and glyph matrices must
184 be adjusted when this flag becomes non-zero during display. The
185 reason fonts can be loaded so late is that fonts of fontsets are
186 loaded on demand. Another reason is that a line contains many
187 characters displayed by zero width or very narrow glyphs of
188 variable-width fonts. */
192 /* Convert vpos and hpos from frame to window and vice versa.
193 This may only be used for terminal frames. */
197 static int window_to_frame_vpos (struct window
*, int);
198 static int window_to_frame_hpos (struct window
*, int);
199 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
200 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
202 /* One element of the ring buffer containing redisplay history
205 struct redisplay_history
207 char trace
[512 + 100];
210 /* The size of the history buffer. */
212 #define REDISPLAY_HISTORY_SIZE 30
214 /* The redisplay history buffer. */
216 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
218 /* Next free entry in redisplay_history. */
220 static int history_idx
;
222 /* A tick that's incremented each time something is added to the
225 static uprintmax_t history_tick
;
227 static void add_frame_display_history (struct frame
*, int);
229 /* Add to the redisplay history how window W has been displayed.
230 MSG is a trace containing the information how W's glyph matrix
231 has been constructed. PAUSED_P non-zero means that the update
232 has been interrupted for pending input. */
235 add_window_display_history (struct window
*w
, const char *msg
, int paused_p
)
239 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
241 buf
= redisplay_history
[history_idx
].trace
;
244 snprintf (buf
, sizeof redisplay_history
[0].trace
,
245 "%"pMu
": window %p (`%s')%s\n%s",
248 ((BUFFERP (WGET (w
, buffer
))
249 && STRINGP (BVAR (XBUFFER (WGET (w
, buffer
)), name
)))
250 ? SSDATA (BVAR (XBUFFER (WGET (w
, buffer
)), name
))
252 paused_p
? " ***paused***" : "",
257 /* Add to the redisplay history that frame F has been displayed.
258 PAUSED_P non-zero means that the update has been interrupted for
262 add_frame_display_history (struct frame
*f
, int paused_p
)
266 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
268 buf
= redisplay_history
[history_idx
].trace
;
271 sprintf (buf
, "%"pMu
": update frame %p%s",
273 f
, paused_p
? " ***paused***" : "");
277 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
278 Sdump_redisplay_history
, 0, 0, "",
279 doc
: /* Dump redisplay history to stderr. */)
284 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
287 i
= REDISPLAY_HISTORY_SIZE
- 1;
288 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
295 #else /* not GLYPH_DEBUG */
297 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
298 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
300 #endif /* GLYPH_DEBUG */
303 #if (defined PROFILING \
304 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
305 && !HAVE___EXECUTABLE_START)
306 /* This function comes first in the Emacs executable and is used only
307 to estimate the text start for profiling. */
309 __executable_start (void)
315 /***********************************************************************
317 ***********************************************************************/
319 /* Allocate and return a glyph_matrix structure. POOL is the glyph
320 pool from which memory for the matrix should be allocated, or null
321 for window-based redisplay where no glyph pools are used. The
322 member `pool' of the glyph matrix structure returned is set to
323 POOL, the structure is otherwise zeroed. */
325 static struct glyph_matrix
*
326 new_glyph_matrix (struct glyph_pool
*pool
)
328 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
330 /* Increment number of allocated matrices. This count is used
331 to detect memory leaks. */
332 ++glyph_matrix_count
;
334 /* Set pool and return. */
340 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
342 The global counter glyph_matrix_count is decremented when a matrix
343 is freed. If the count gets negative, more structures were freed
344 than allocated, i.e. one matrix was freed more than once or a bogus
345 pointer was passed to this function.
347 If MATRIX->pool is null, this means that the matrix manages its own
348 glyph memory---this is done for matrices on X frames. Freeing the
349 matrix also frees the glyph memory in this case. */
352 free_glyph_matrix (struct glyph_matrix
*matrix
)
358 /* Detect the case that more matrices are freed than were
360 if (--glyph_matrix_count
< 0)
363 /* Free glyph memory if MATRIX owns it. */
364 if (matrix
->pool
== NULL
)
365 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
366 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
368 /* Free row structures and the matrix itself. */
369 xfree (matrix
->rows
);
375 /* Return the number of glyphs to reserve for a marginal area of
376 window W. TOTAL_GLYPHS is the number of glyphs in a complete
377 display line of window W. MARGIN gives the width of the marginal
378 area in canonical character units. MARGIN should be an integer
382 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
386 if (NUMBERP (margin
))
388 int width
= XFASTINT (WGET (w
, total_cols
));
389 double d
= max (0, XFLOATINT (margin
));
390 d
= min (width
/ 2 - 1, d
);
391 n
= (int) ((double) total_glyphs
/ width
* d
);
399 /* Return non-zero if ROW's hash value is correct, zero if not.
400 Optimized away if ENABLE_CHECKING is not defined. */
403 verify_row_hash (struct glyph_row
*row
)
405 return row
->hash
== row_hash (row
);
408 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
411 W is null if the function is called for a frame glyph matrix.
412 Otherwise it is the window MATRIX is a member of. X and Y are the
413 indices of the first column and row of MATRIX within the frame
414 matrix, if such a matrix exists. They are zero for purely
415 window-based redisplay. DIM is the needed size of the matrix.
417 In window-based redisplay, where no frame matrices exist, glyph
418 matrices manage their own glyph storage. Otherwise, they allocate
419 storage from a common frame glyph pool which can be found in
422 The reason for this memory management strategy is to avoid complete
423 frame redraws if possible. When we allocate from a common pool, a
424 change of the location or size of a sub-matrix within the pool
425 requires a complete redisplay of the frame because we cannot easily
426 make sure that the current matrices of all windows still agree with
427 what is displayed on the screen. While this is usually fast, it
428 leads to screen flickering. */
431 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
435 int marginal_areas_changed_p
= 0;
436 int header_line_changed_p
= 0;
437 int header_line_p
= 0;
438 int left
= -1, right
= -1;
439 int window_width
= -1, window_height
= -1;
441 /* See if W had a header line that has disappeared now, or vice versa.
445 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
447 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
448 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
450 matrix
->header_line_p
= header_line_p
;
452 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
453 Do nothing if MATRIX' size, position, vscroll, and marginal areas
454 haven't changed. This optimization is important because preserving
455 the matrix means preventing redisplay. */
456 if (matrix
->pool
== NULL
)
458 left
= margin_glyphs_to_reserve (w
, dim
.width
, WGET (w
, left_margin_cols
));
459 right
= margin_glyphs_to_reserve (w
, dim
.width
, WGET (w
, right_margin_cols
));
460 eassert (left
>= 0 && right
>= 0);
461 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
462 || right
!= matrix
->right_margin_glyphs
);
464 if (!marginal_areas_changed_p
466 && !header_line_changed_p
467 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
468 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
469 && matrix
->window_height
== window_height
470 && matrix
->window_vscroll
== w
->vscroll
471 && matrix
->window_width
== window_width
)
475 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
476 if (matrix
->rows_allocated
< dim
.height
)
478 int old_alloc
= matrix
->rows_allocated
;
479 new_rows
= dim
.height
- matrix
->rows_allocated
;
480 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
481 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
482 memset (matrix
->rows
+ old_alloc
, 0,
483 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
488 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
489 on a frame not using window-based redisplay. Set up pointers for
490 each row into the glyph pool. */
493 eassert (matrix
->pool
->glyphs
);
497 left
= margin_glyphs_to_reserve (w
, dim
.width
,
498 WGET (w
, left_margin_cols
));
499 right
= margin_glyphs_to_reserve (w
, dim
.width
,
500 WGET (w
, right_margin_cols
));
505 for (i
= 0; i
< dim
.height
; ++i
)
507 struct glyph_row
*row
= &matrix
->rows
[i
];
509 row
->glyphs
[LEFT_MARGIN_AREA
]
510 = (matrix
->pool
->glyphs
511 + (y
+ i
) * matrix
->pool
->ncolumns
515 || row
== matrix
->rows
+ dim
.height
- 1
516 || (row
== matrix
->rows
&& matrix
->header_line_p
))
518 row
->glyphs
[TEXT_AREA
]
519 = row
->glyphs
[LEFT_MARGIN_AREA
];
520 row
->glyphs
[RIGHT_MARGIN_AREA
]
521 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
522 row
->glyphs
[LAST_AREA
]
523 = row
->glyphs
[RIGHT_MARGIN_AREA
];
527 row
->glyphs
[TEXT_AREA
]
528 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
529 row
->glyphs
[RIGHT_MARGIN_AREA
]
530 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
531 row
->glyphs
[LAST_AREA
]
532 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
536 matrix
->left_margin_glyphs
= left
;
537 matrix
->right_margin_glyphs
= right
;
541 /* If MATRIX->pool is null, MATRIX is responsible for managing
542 its own memory. It is a window matrix for window-based redisplay.
543 Allocate glyph memory from the heap. */
544 if (dim
.width
> matrix
->matrix_w
546 || header_line_changed_p
547 || marginal_areas_changed_p
)
549 struct glyph_row
*row
= matrix
->rows
;
550 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
554 row
->glyphs
[LEFT_MARGIN_AREA
]
555 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
556 dim
.width
, sizeof (struct glyph
));
558 /* The mode line never has marginal areas. */
559 if (row
== matrix
->rows
+ dim
.height
- 1
560 || (row
== matrix
->rows
&& matrix
->header_line_p
))
562 row
->glyphs
[TEXT_AREA
]
563 = row
->glyphs
[LEFT_MARGIN_AREA
];
564 row
->glyphs
[RIGHT_MARGIN_AREA
]
565 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
566 row
->glyphs
[LAST_AREA
]
567 = row
->glyphs
[RIGHT_MARGIN_AREA
];
571 row
->glyphs
[TEXT_AREA
]
572 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
573 row
->glyphs
[RIGHT_MARGIN_AREA
]
574 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
575 row
->glyphs
[LAST_AREA
]
576 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
582 eassert (left
>= 0 && right
>= 0);
583 matrix
->left_margin_glyphs
= left
;
584 matrix
->right_margin_glyphs
= right
;
587 /* Number of rows to be used by MATRIX. */
588 matrix
->nrows
= dim
.height
;
589 eassert (matrix
->nrows
>= 0);
593 if (matrix
== w
->current_matrix
)
595 /* Mark rows in a current matrix of a window as not having
596 valid contents. It's important to not do this for
597 desired matrices. When Emacs starts, it may already be
598 building desired matrices when this function runs. */
599 if (window_width
< 0)
600 window_width
= window_box_width (w
, -1);
602 /* Optimize the case that only the height has changed (C-x 2,
603 upper window). Invalidate all rows that are no longer part
605 if (!marginal_areas_changed_p
606 && !header_line_changed_p
608 && dim
.width
== matrix
->matrix_w
609 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
610 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
611 && matrix
->window_width
== window_width
)
613 /* Find the last row in the window. */
614 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
615 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
621 /* Window end is invalid, if inside of the rows that
622 are invalidated below. */
623 if (INTEGERP (WGET (w
, window_end_vpos
))
624 && XFASTINT (WGET (w
, window_end_vpos
)) >= i
)
625 WSET (w
, window_end_valid
, Qnil
);
627 while (i
< matrix
->nrows
)
628 matrix
->rows
[i
++].enabled_p
= 0;
632 for (i
= 0; i
< matrix
->nrows
; ++i
)
633 matrix
->rows
[i
].enabled_p
= 0;
636 else if (matrix
== w
->desired_matrix
)
638 /* Rows in desired matrices always have to be cleared;
639 redisplay expects this is the case when it runs, so it
640 had better be the case when we adjust matrices between
642 for (i
= 0; i
< matrix
->nrows
; ++i
)
643 matrix
->rows
[i
].enabled_p
= 0;
648 /* Remember last values to be able to optimize frame redraws. */
649 matrix
->matrix_x
= x
;
650 matrix
->matrix_y
= y
;
651 matrix
->matrix_w
= dim
.width
;
652 matrix
->matrix_h
= dim
.height
;
654 /* Record the top y location and height of W at the time the matrix
655 was last adjusted. This is used to optimize redisplay above. */
658 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
659 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
660 matrix
->window_height
= window_height
;
661 matrix
->window_width
= window_width
;
662 matrix
->window_vscroll
= w
->vscroll
;
667 /* Reverse the contents of rows in MATRIX between START and END. The
668 contents of the row at END - 1 end up at START, END - 2 at START +
669 1 etc. This is part of the implementation of rotate_matrix (see
673 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
677 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
679 /* Non-ISO HP/UX compiler doesn't like auto struct
681 struct glyph_row temp
;
682 temp
= matrix
->rows
[i
];
683 matrix
->rows
[i
] = matrix
->rows
[j
];
684 matrix
->rows
[j
] = temp
;
689 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
690 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
691 indices. (Note: this does not copy glyphs, only glyph pointers in
692 row structures are moved around).
694 The algorithm used for rotating the vector was, I believe, first
695 described by Kernighan. See the vector R as consisting of two
696 sub-vectors AB, where A has length BY for BY >= 0. The result
697 after rotating is then BA. Reverse both sub-vectors to get ArBr
698 and reverse the result to get (ArBr)r which is BA. Similar for
702 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
706 /* Up (rotate left, i.e. towards lower indices). */
708 reverse_rows (matrix
, first
, first
+ by
);
709 reverse_rows (matrix
, first
+ by
, last
);
710 reverse_rows (matrix
, first
, last
);
714 /* Down (rotate right, i.e. towards higher indices). */
715 reverse_rows (matrix
, last
- by
, last
);
716 reverse_rows (matrix
, first
, last
- by
);
717 reverse_rows (matrix
, first
, last
);
722 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
723 with indices START <= index < END. Increment positions by DELTA/
727 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
728 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
730 /* Check that START and END are reasonable values. */
731 eassert (start
>= 0 && start
<= matrix
->nrows
);
732 eassert (end
>= 0 && end
<= matrix
->nrows
);
733 eassert (start
<= end
);
735 for (; start
< end
; ++start
)
736 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
740 /* Enable a range of rows in glyph matrix MATRIX. START and END are
741 the row indices of the first and last + 1 row to enable. If
742 ENABLED_P is non-zero, enabled_p flags in rows will be set to 1. */
745 enable_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
, int enabled_p
)
747 eassert (start
<= end
);
748 eassert (start
>= 0 && start
< matrix
->nrows
);
749 eassert (end
>= 0 && end
<= matrix
->nrows
);
751 for (; start
< end
; ++start
)
752 matrix
->rows
[start
].enabled_p
= enabled_p
!= 0;
758 This empties all rows in MATRIX by setting the enabled_p flag for
759 all rows of the matrix to zero. The function prepare_desired_row
760 will eventually really clear a row when it sees one with a zero
763 Resets update hints to defaults value. The only update hint
764 currently present is the flag MATRIX->no_scrolling_p. */
767 clear_glyph_matrix (struct glyph_matrix
*matrix
)
771 enable_glyph_matrix_rows (matrix
, 0, matrix
->nrows
, 0);
772 matrix
->no_scrolling_p
= 0;
777 /* Shift part of the glyph matrix MATRIX of window W up or down.
778 Increment y-positions in glyph rows between START and END by DY,
779 and recompute their visible height. */
782 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
786 eassert (start
<= end
);
787 eassert (start
>= 0 && start
< matrix
->nrows
);
788 eassert (end
>= 0 && end
<= matrix
->nrows
);
790 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
791 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
793 for (; start
< end
; ++start
)
795 struct glyph_row
*row
= &matrix
->rows
[start
];
798 row
->visible_height
= row
->height
;
801 row
->visible_height
-= min_y
- row
->y
;
802 if (row
->y
+ row
->height
> max_y
)
803 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
804 if (row
->fringe_bitmap_periodic_p
)
805 row
->redraw_fringe_bitmaps_p
= 1;
810 /* Mark all rows in current matrices of frame F as invalid. Marking
811 invalid is done by setting enabled_p to zero for all rows in a
815 clear_current_matrices (register struct frame
*f
)
817 /* Clear frame current matrix, if we have one. */
818 if (f
->current_matrix
)
819 clear_glyph_matrix (f
->current_matrix
);
821 /* Clear the matrix of the menu bar window, if such a window exists.
822 The menu bar window is currently used to display menus on X when
823 no toolkit support is compiled in. */
824 if (WINDOWP (f
->menu_bar_window
))
825 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
827 /* Clear the matrix of the tool-bar window, if any. */
828 if (WINDOWP (f
->tool_bar_window
))
829 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
831 /* Clear current window matrices. */
832 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
833 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
837 /* Clear out all display lines of F for a coming redisplay. */
840 clear_desired_matrices (register struct frame
*f
)
842 if (f
->desired_matrix
)
843 clear_glyph_matrix (f
->desired_matrix
);
845 if (WINDOWP (f
->menu_bar_window
))
846 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
848 if (WINDOWP (f
->tool_bar_window
))
849 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
851 /* Do it for window matrices. */
852 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
853 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
857 /* Clear matrices in window tree rooted in W. If DESIRED_P is
858 non-zero clear desired matrices, otherwise clear current matrices. */
861 clear_window_matrices (struct window
*w
, int desired_p
)
865 if (!NILP (WGET (w
, hchild
)))
867 eassert (WINDOWP (WGET (w
, hchild
)));
868 clear_window_matrices (XWINDOW (WGET (w
, hchild
)), desired_p
);
870 else if (!NILP (WGET (w
, vchild
)))
872 eassert (WINDOWP (WGET (w
, vchild
)));
873 clear_window_matrices (XWINDOW (WGET (w
, vchild
)), desired_p
);
878 clear_glyph_matrix (w
->desired_matrix
);
881 clear_glyph_matrix (w
->current_matrix
);
882 WSET (w
, window_end_valid
, Qnil
);
886 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
892 /***********************************************************************
895 See dispextern.h for an overall explanation of glyph rows.
896 ***********************************************************************/
898 /* Clear glyph row ROW. Do it in a way that makes it robust against
899 changes in the glyph_row structure, i.e. addition or removal of
900 structure members. */
902 static struct glyph_row null_row
;
905 clear_glyph_row (struct glyph_row
*row
)
907 struct glyph
*p
[1 + LAST_AREA
];
910 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
911 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
912 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
913 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
918 /* Restore pointers. */
919 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
920 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
921 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
922 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
924 #if 0 /* At some point, some bit-fields of struct glyph were not set,
925 which made glyphs unequal when compared with GLYPH_EQUAL_P.
926 Redisplay outputs such glyphs, and flickering effects were
927 the result. This also depended on the contents of memory
928 returned by xmalloc. If flickering happens again, activate
929 the code below. If the flickering is gone with that, chances
930 are that the flickering has the same reason as here. */
931 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
936 /* Make ROW an empty, enabled row of canonical character height,
937 in window W starting at y-position Y. */
940 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
944 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
945 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
947 clear_glyph_row (row
);
949 row
->ascent
= row
->phys_ascent
= 0;
950 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (WGET (w
, frame
)));
951 row
->visible_height
= row
->height
;
954 row
->visible_height
-= min_y
- row
->y
;
955 if (row
->y
+ row
->height
> max_y
)
956 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
962 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
963 are the amounts by which to change positions. Note that the first
964 glyph of the text area of a row can have a buffer position even if
965 the used count of the text area is zero. Such rows display line
969 increment_row_positions (struct glyph_row
*row
,
970 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
974 /* Increment start and end positions. */
975 MATRIX_ROW_START_CHARPOS (row
) += delta
;
976 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
977 MATRIX_ROW_END_CHARPOS (row
) += delta
;
978 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
979 CHARPOS (row
->start
.pos
) += delta
;
980 BYTEPOS (row
->start
.pos
) += delta_bytes
;
981 CHARPOS (row
->end
.pos
) += delta
;
982 BYTEPOS (row
->end
.pos
) += delta_bytes
;
987 /* Increment positions in glyphs. */
988 for (area
= 0; area
< LAST_AREA
; ++area
)
989 for (i
= 0; i
< row
->used
[area
]; ++i
)
990 if (BUFFERP (row
->glyphs
[area
][i
].object
)
991 && row
->glyphs
[area
][i
].charpos
> 0)
992 row
->glyphs
[area
][i
].charpos
+= delta
;
994 /* Capture the case of rows displaying a line end. */
995 if (row
->used
[TEXT_AREA
] == 0
996 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
997 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
1002 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
1003 contents, i.e. glyph structure contents are exchanged between A and
1004 B without changing glyph pointers in A and B. */
1007 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
1011 for (area
= 0; area
< LAST_AREA
; ++area
)
1013 /* Number of glyphs to swap. */
1014 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1016 /* Start of glyphs in area of row A. */
1017 struct glyph
*glyph_a
= a
->glyphs
[area
];
1019 /* End + 1 of glyphs in area of row A. */
1020 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1022 /* Start of glyphs in area of row B. */
1023 struct glyph
*glyph_b
= b
->glyphs
[area
];
1025 while (glyph_a
< glyph_a_end
)
1027 /* Non-ISO HP/UX compiler doesn't like auto struct
1031 *glyph_a
= *glyph_b
;
1041 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1042 exchange the used[] array and the hash values of the rows, because
1043 these should all go together for the row's hash value to be
1047 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1050 unsigned hash_tem
= a
->hash
;
1052 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1054 struct glyph
*temp
= a
->glyphs
[i
];
1056 a
->glyphs
[i
] = b
->glyphs
[i
];
1057 b
->glyphs
[i
] = temp
;
1060 short used_tem
= a
->used
[i
];
1062 a
->used
[i
] = b
->used
[i
];
1063 b
->used
[i
] = used_tem
;
1071 /* Copy glyph row structure FROM to glyph row structure TO, except
1072 that glyph pointers, the `used' counts, and the hash values in the
1073 structures are left unchanged. */
1076 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1078 struct glyph
*pointers
[1 + LAST_AREA
];
1079 short used
[LAST_AREA
];
1082 /* Save glyph pointers of TO. */
1083 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1084 memcpy (used
, to
->used
, sizeof to
->used
);
1087 /* Do a structure assignment. */
1090 /* Restore original pointers of TO. */
1091 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1092 memcpy (to
->used
, used
, sizeof to
->used
);
1097 /* Assign glyph row FROM to glyph row TO. This works like a structure
1098 assignment TO = FROM, except that glyph pointers are not copied but
1099 exchanged between TO and FROM. Pointers must be exchanged to avoid
1103 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1105 swap_glyph_pointers (to
, from
);
1106 copy_row_except_pointers (to
, from
);
1110 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1111 a row in a window matrix, is a slice of the glyph memory of the
1112 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1113 is non-zero if the glyph memory of WINDOW_ROW is part of the glyph
1114 memory of FRAME_ROW. */
1119 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1121 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1122 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1123 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1125 return (frame_glyph_start
<= window_glyph_start
1126 && window_glyph_start
< frame_glyph_end
);
1129 #endif /* GLYPH_DEBUG */
1133 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1134 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1135 in WINDOW_MATRIX is found satisfying the condition. */
1137 static struct glyph_row
*
1138 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1139 struct glyph_matrix
*frame_matrix
, int row
)
1143 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1145 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1146 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1147 frame_matrix
->rows
+ row
))
1150 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1155 /* Prepare ROW for display. Desired rows are cleared lazily,
1156 i.e. they are only marked as to be cleared by setting their
1157 enabled_p flag to zero. When a row is to be displayed, a prior
1158 call to this function really clears it. */
1161 prepare_desired_row (struct glyph_row
*row
)
1163 if (!row
->enabled_p
)
1165 int rp
= row
->reversed_p
;
1167 clear_glyph_row (row
);
1169 row
->reversed_p
= rp
;
1174 /* Return a hash code for glyph row ROW. */
1177 line_hash_code (struct glyph_row
*row
)
1183 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1184 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1188 int c
= glyph
->u
.ch
;
1189 int face_id
= glyph
->face_id
;
1190 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1192 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1193 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1205 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1206 the number of characters in the line. If must_write_spaces is
1207 zero, leading and trailing spaces are ignored. */
1210 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1212 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1213 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1214 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1216 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1217 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1219 /* Ignore trailing and leading spaces if we can. */
1220 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1222 /* Skip from the end over trailing spaces. */
1223 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1226 /* All blank line. */
1230 /* Skip over leading spaces. */
1231 while (CHAR_GLYPH_SPACE_P (*beg
))
1235 /* If we don't have a glyph-table, each glyph is one character,
1236 so return the number of glyphs. */
1237 if (glyph_table_base
== 0)
1241 /* Otherwise, scan the glyphs and accumulate their total length
1248 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1250 if (GLYPH_INVALID_P (g
)
1251 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1254 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1264 /* Test two glyph rows A and B for equality. Value is non-zero if A
1265 and B have equal contents. MOUSE_FACE_P non-zero means compare the
1266 mouse_face_p flags of A and B, too. */
1269 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, int mouse_face_p
)
1271 eassert (verify_row_hash (a
));
1272 eassert (verify_row_hash (b
));
1276 else if (a
->hash
!= b
->hash
)
1280 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1283 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1286 /* Compare glyphs. */
1287 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1289 if (a
->used
[area
] != b
->used
[area
])
1292 a_glyph
= a
->glyphs
[area
];
1293 a_end
= a_glyph
+ a
->used
[area
];
1294 b_glyph
= b
->glyphs
[area
];
1296 while (a_glyph
< a_end
1297 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1298 ++a_glyph
, ++b_glyph
;
1300 if (a_glyph
!= a_end
)
1304 if (a
->fill_line_p
!= b
->fill_line_p
1305 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1306 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1307 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1308 || a
->left_fringe_offset
!= b
->left_fringe_offset
1309 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1310 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1311 || a
->right_fringe_offset
!= b
->right_fringe_offset
1312 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1313 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1314 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1315 || a
->overlapped_p
!= b
->overlapped_p
1316 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1317 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1318 || a
->reversed_p
!= b
->reversed_p
1319 /* Different partially visible characters on left margin. */
1321 /* Different height. */
1322 || a
->ascent
!= b
->ascent
1323 || a
->phys_ascent
!= b
->phys_ascent
1324 || a
->phys_height
!= b
->phys_height
1325 || a
->visible_height
!= b
->visible_height
)
1334 /***********************************************************************
1337 See dispextern.h for an overall explanation of glyph pools.
1338 ***********************************************************************/
1340 /* Allocate a glyph_pool structure. The structure returned is
1341 initialized with zeros. The global variable glyph_pool_count is
1342 incremented for each pool allocated. */
1344 static struct glyph_pool
*
1345 new_glyph_pool (void)
1347 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1349 /* For memory leak and double deletion checking. */
1356 /* Free a glyph_pool structure POOL. The function may be called with
1357 a null POOL pointer. The global variable glyph_pool_count is
1358 decremented with every pool structure freed. If this count gets
1359 negative, more structures were freed than allocated, i.e. one
1360 structure must have been freed more than once or a bogus pointer
1361 was passed to free_glyph_pool. */
1364 free_glyph_pool (struct glyph_pool
*pool
)
1368 /* More freed than allocated? */
1370 eassert (glyph_pool_count
>= 0);
1372 xfree (pool
->glyphs
);
1378 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1379 columns we need. This function never shrinks a pool. The only
1380 case in which this would make sense, would be when a frame's size
1381 is changed from a large value to a smaller one. But, if someone
1382 does it once, we can expect that he will do it again.
1384 Value is non-zero if the pool changed in a way which makes
1385 re-adjusting window glyph matrices necessary. */
1388 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1393 changed_p
= (pool
->glyphs
== 0
1394 || matrix_dim
.height
!= pool
->nrows
1395 || matrix_dim
.width
!= pool
->ncolumns
);
1397 /* Enlarge the glyph pool. */
1398 needed
= matrix_dim
.width
;
1399 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1400 memory_full (SIZE_MAX
);
1401 needed
*= matrix_dim
.height
;
1402 if (needed
> pool
->nglyphs
)
1404 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1405 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1406 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1407 memset (pool
->glyphs
+ old_nglyphs
, 0,
1408 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1411 /* Remember the number of rows and columns because (a) we use them
1412 to do sanity checks, and (b) the number of columns determines
1413 where rows in the frame matrix start---this must be available to
1414 determine pointers to rows of window sub-matrices. */
1415 pool
->nrows
= matrix_dim
.height
;
1416 pool
->ncolumns
= matrix_dim
.width
;
1423 /***********************************************************************
1425 ***********************************************************************/
1430 /* Flush standard output. This is sometimes useful to call from the debugger.
1431 XXX Maybe this should be changed to flush the current terminal instead of
1435 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1444 /* Check that no glyph pointers have been lost in MATRIX. If a
1445 pointer has been lost, e.g. by using a structure assignment between
1446 rows, at least one pointer must occur more than once in the rows of
1450 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1454 for (i
= 0; i
< matrix
->nrows
; ++i
)
1455 for (j
= 0; j
< matrix
->nrows
; ++j
)
1457 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1458 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1462 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1465 matrix_row (struct glyph_matrix
*matrix
, int row
)
1467 eassert (matrix
&& matrix
->rows
);
1468 eassert (row
>= 0 && row
< matrix
->nrows
);
1470 /* That's really too slow for normal testing because this function
1471 is called almost everywhere. Although---it's still astonishingly
1472 fast, so it is valuable to have for debugging purposes. */
1474 check_matrix_pointer_lossage (matrix
);
1477 return matrix
->rows
+ row
;
1481 #if 0 /* This function makes invalid assumptions when text is
1482 partially invisible. But it might come handy for debugging
1485 /* Check invariants that must hold for an up to date current matrix of
1489 check_matrix_invariants (struct window
*w
)
1491 struct glyph_matrix
*matrix
= w
->current_matrix
;
1492 int yb
= window_text_bottom_y (w
);
1493 struct glyph_row
*row
= matrix
->rows
;
1494 struct glyph_row
*last_text_row
= NULL
;
1495 struct buffer
*saved
= current_buffer
;
1496 struct buffer
*buffer
= XBUFFER (WGET (w
, buffer
));
1499 /* This can sometimes happen for a fresh window. */
1500 if (matrix
->nrows
< 2)
1503 set_buffer_temp (buffer
);
1505 /* Note: last row is always reserved for the mode line. */
1506 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1507 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1509 struct glyph_row
*next
= row
+ 1;
1511 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1512 last_text_row
= row
;
1514 /* Check that character and byte positions are in sync. */
1515 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1516 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1517 eassert (BYTEPOS (row
->start
.pos
)
1518 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1520 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1521 have such a position temporarily in case of a minibuffer
1522 displaying something like `[Sole completion]' at its end. */
1523 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1525 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1526 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1527 eassert (BYTEPOS (row
->end
.pos
)
1528 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1531 /* Check that end position of `row' is equal to start position
1533 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1535 eassert (MATRIX_ROW_END_CHARPOS (row
)
1536 == MATRIX_ROW_START_CHARPOS (next
));
1537 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1538 == MATRIX_ROW_START_BYTEPOS (next
));
1539 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1540 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1545 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1546 eassert (w
->desired_matrix
->rows
!= NULL
);
1547 set_buffer_temp (saved
);
1552 #endif /* GLYPH_DEBUG */
1556 /**********************************************************************
1557 Allocating/ Adjusting Glyph Matrices
1558 **********************************************************************/
1560 /* Allocate glyph matrices over a window tree for a frame-based
1563 X and Y are column/row within the frame glyph matrix where
1564 sub-matrices for the window tree rooted at WINDOW must be
1565 allocated. DIM_ONLY_P non-zero means that the caller of this
1566 function is only interested in the result matrix dimension, and
1567 matrix adjustments should not be performed.
1569 The function returns the total width/height of the sub-matrices of
1570 the window tree. If called on a frame root window, the computation
1571 will take the mini-buffer window into account.
1573 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1575 NEW_LEAF_MATRIX set if any window in the tree did not have a
1576 glyph matrices yet, and
1578 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1579 any window in the tree will be changed or have been changed (see
1582 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1585 Windows are arranged into chains of windows on the same level
1586 through the next fields of window structures. Such a level can be
1587 either a sequence of horizontally adjacent windows from left to
1588 right, or a sequence of vertically adjacent windows from top to
1589 bottom. Each window in a horizontal sequence can be either a leaf
1590 window or a vertical sequence; a window in a vertical sequence can
1591 be either a leaf or a horizontal sequence. All windows in a
1592 horizontal sequence have the same height, and all windows in a
1593 vertical sequence have the same width.
1595 This function uses, for historical reasons, a more general
1596 algorithm to determine glyph matrix dimensions that would be
1599 The matrix height of a horizontal sequence is determined by the
1600 maximum height of any matrix in the sequence. The matrix width of
1601 a horizontal sequence is computed by adding up matrix widths of
1602 windows in the sequence.
1604 |<------- result width ------->|
1605 +---------+----------+---------+ ---
1608 +---------+ | | result height
1613 The matrix width of a vertical sequence is the maximum matrix width
1614 of any window in the sequence. Its height is computed by adding up
1615 matrix heights of windows in the sequence.
1617 |<---- result width -->|
1625 +------------+---------+ |
1628 +------------+---------+ --- */
1630 /* Bit indicating that a new matrix will be allocated or has been
1633 #define NEW_LEAF_MATRIX (1 << 0)
1635 /* Bit indicating that a matrix will or has changed its location or
1638 #define CHANGED_LEAF_MATRIX (1 << 1)
1641 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1642 int dim_only_p
, int *window_change_flags
)
1644 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1646 int wmax
= 0, hmax
= 0;
1650 int in_horz_combination_p
;
1652 /* What combination is WINDOW part of? Compute this once since the
1653 result is the same for all windows in the `next' chain. The
1654 special case of a root window (parent equal to nil) is treated
1655 like a vertical combination because a root window's `next'
1656 points to the mini-buffer window, if any, which is arranged
1657 vertically below other windows. */
1658 in_horz_combination_p
1659 = (!NILP (WGET (XWINDOW (window
), parent
))
1660 && !NILP (WGET (XWINDOW (WGET (XWINDOW (window
), parent
)), hchild
)));
1662 /* For WINDOW and all windows on the same level. */
1665 w
= XWINDOW (window
);
1667 /* Get the dimension of the window sub-matrix for W, depending
1668 on whether this is a combination or a leaf window. */
1669 if (!NILP (WGET (w
, hchild
)))
1670 dim
= allocate_matrices_for_frame_redisplay (WGET (w
, hchild
), x
, y
,
1672 window_change_flags
);
1673 else if (!NILP (WGET (w
, vchild
)))
1674 dim
= allocate_matrices_for_frame_redisplay (WGET (w
, vchild
), x
, y
,
1676 window_change_flags
);
1679 /* If not already done, allocate sub-matrix structures. */
1680 if (w
->desired_matrix
== NULL
)
1682 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1683 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1684 *window_change_flags
|= NEW_LEAF_MATRIX
;
1687 /* Width and height MUST be chosen so that there are no
1688 holes in the frame matrix. */
1689 dim
.width
= required_matrix_width (w
);
1690 dim
.height
= required_matrix_height (w
);
1692 /* Will matrix be re-allocated? */
1693 if (x
!= w
->desired_matrix
->matrix_x
1694 || y
!= w
->desired_matrix
->matrix_y
1695 || dim
.width
!= w
->desired_matrix
->matrix_w
1696 || dim
.height
!= w
->desired_matrix
->matrix_h
1697 || (margin_glyphs_to_reserve (w
, dim
.width
,
1698 WGET (w
, left_margin_cols
))
1699 != w
->desired_matrix
->left_margin_glyphs
)
1700 || (margin_glyphs_to_reserve (w
, dim
.width
,
1701 WGET (w
, right_margin_cols
))
1702 != w
->desired_matrix
->right_margin_glyphs
))
1703 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1705 /* Actually change matrices, if allowed. Do not consider
1706 CHANGED_LEAF_MATRIX computed above here because the pool
1707 may have been changed which we don't now here. We trust
1708 that we only will be called with DIM_ONLY_P != 0 when
1712 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1713 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1717 /* If we are part of a horizontal combination, advance x for
1718 windows to the right of W; otherwise advance y for windows
1720 if (in_horz_combination_p
)
1725 /* Remember maximum glyph matrix dimensions. */
1726 wmax
= max (wmax
, dim
.width
);
1727 hmax
= max (hmax
, dim
.height
);
1729 /* Next window on same level. */
1730 window
= WGET (w
, next
);
1732 while (!NILP (window
));
1734 /* Set `total' to the total glyph matrix dimension of this window
1735 level. In a vertical combination, the width is the width of the
1736 widest window; the height is the y we finally reached, corrected
1737 by the y we started with. In a horizontal combination, the total
1738 height is the height of the tallest window, and the width is the
1739 x we finally reached, corrected by the x we started with. */
1740 if (in_horz_combination_p
)
1742 total
.width
= x
- x0
;
1743 total
.height
= hmax
;
1748 total
.height
= y
- y0
;
1755 /* Return the required height of glyph matrices for window W. */
1758 required_matrix_height (struct window
*w
)
1760 #ifdef HAVE_WINDOW_SYSTEM
1761 struct frame
*f
= XFRAME (WGET (w
, frame
));
1763 if (FRAME_WINDOW_P (f
))
1765 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1766 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1767 return (((window_pixel_height
+ ch_height
- 1)
1768 / ch_height
) * w
->nrows_scale_factor
1769 /* One partially visible line at the top and
1770 bottom of the window. */
1772 /* 2 for header and mode line. */
1775 #endif /* HAVE_WINDOW_SYSTEM */
1777 return WINDOW_TOTAL_LINES (w
);
1781 /* Return the required width of glyph matrices for window W. */
1784 required_matrix_width (struct window
*w
)
1786 #ifdef HAVE_WINDOW_SYSTEM
1787 struct frame
*f
= XFRAME (WGET (w
, frame
));
1788 if (FRAME_WINDOW_P (f
))
1790 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1791 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1793 /* Compute number of glyphs needed in a glyph row. */
1794 return (((window_pixel_width
+ ch_width
- 1)
1795 / ch_width
) * w
->ncols_scale_factor
1796 /* 2 partially visible columns in the text area. */
1798 /* One partially visible column at the right
1799 edge of each marginal area. */
1802 #endif /* HAVE_WINDOW_SYSTEM */
1804 return XINT (WGET (w
, total_cols
));
1808 /* Allocate window matrices for window-based redisplay. W is the
1809 window whose matrices must be allocated/reallocated. */
1812 allocate_matrices_for_window_redisplay (struct window
*w
)
1816 if (!NILP (WGET (w
, vchild
)))
1817 allocate_matrices_for_window_redisplay (XWINDOW (WGET (w
, vchild
)));
1818 else if (!NILP (WGET (w
, hchild
)))
1819 allocate_matrices_for_window_redisplay (XWINDOW (WGET (w
, hchild
)));
1822 /* W is a leaf window. */
1825 /* If matrices are not yet allocated, allocate them now. */
1826 if (w
->desired_matrix
== NULL
)
1828 w
->desired_matrix
= new_glyph_matrix (NULL
);
1829 w
->current_matrix
= new_glyph_matrix (NULL
);
1832 dim
.width
= required_matrix_width (w
);
1833 dim
.height
= required_matrix_height (w
);
1834 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1835 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1838 w
= NILP (WGET (w
, next
)) ? NULL
: XWINDOW (WGET (w
, next
));
1843 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1844 do it for all frames; otherwise do it just for the given frame.
1845 This function must be called when a new frame is created, its size
1846 changes, or its window configuration changes. */
1849 adjust_glyphs (struct frame
*f
)
1851 /* Block input so that expose events and other events that access
1852 glyph matrices are not processed while we are changing them. */
1856 adjust_frame_glyphs (f
);
1859 Lisp_Object tail
, lisp_frame
;
1861 FOR_EACH_FRAME (tail
, lisp_frame
)
1862 adjust_frame_glyphs (XFRAME (lisp_frame
));
1869 /* Adjust frame glyphs when Emacs is initialized.
1871 To be called from init_display.
1873 We need a glyph matrix because redraw will happen soon.
1874 Unfortunately, window sizes on selected_frame are not yet set to
1875 meaningful values. I believe we can assume that there are only two
1876 windows on the frame---the mini-buffer and the root window. Frame
1877 height and width seem to be correct so far. So, set the sizes of
1878 windows to estimated values. */
1881 adjust_frame_glyphs_initially (void)
1883 struct frame
*sf
= SELECTED_FRAME ();
1884 struct window
*root
= XWINDOW (sf
->root_window
);
1885 struct window
*mini
= XWINDOW (WGET (root
, next
));
1886 int frame_lines
= FRAME_LINES (sf
);
1887 int frame_cols
= FRAME_COLS (sf
);
1888 int top_margin
= FRAME_TOP_MARGIN (sf
);
1890 /* Do it for the root window. */
1891 WSET (root
, top_line
, make_number (top_margin
));
1892 WSET (root
, total_lines
, make_number (frame_lines
- 1 - top_margin
));
1893 WSET (root
, total_cols
, make_number (frame_cols
));
1895 /* Do it for the mini-buffer window. */
1896 WSET (mini
, top_line
, make_number (frame_lines
- 1));
1897 WSET (mini
, total_lines
, make_number (1));
1898 WSET (mini
, total_cols
, make_number (frame_cols
));
1900 adjust_frame_glyphs (sf
);
1901 glyphs_initialized_initially_p
= 1;
1905 /* Allocate/reallocate glyph matrices of a single frame F. */
1908 adjust_frame_glyphs (struct frame
*f
)
1910 if (FRAME_WINDOW_P (f
))
1911 adjust_frame_glyphs_for_window_redisplay (f
);
1913 adjust_frame_glyphs_for_frame_redisplay (f
);
1915 /* Don't forget the message buffer and the buffer for
1916 decode_mode_spec. */
1917 adjust_frame_message_buffer (f
);
1918 adjust_decode_mode_spec_buffer (f
);
1920 f
->glyphs_initialized_p
= 1;
1923 /* Return 1 if any window in the tree has nonzero window margins. See
1924 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1926 showing_window_margins_p (struct window
*w
)
1930 if (!NILP (WGET (w
, hchild
)))
1932 if (showing_window_margins_p (XWINDOW (WGET (w
, hchild
))))
1935 else if (!NILP (WGET (w
, vchild
)))
1937 if (showing_window_margins_p (XWINDOW (WGET (w
, vchild
))))
1940 else if (!NILP (WGET (w
, left_margin_cols
))
1941 || !NILP (WGET (w
, right_margin_cols
)))
1944 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
1950 /* In the window tree with root W, build current matrices of leaf
1951 windows from the frame's current matrix. */
1954 fake_current_matrices (Lisp_Object window
)
1958 for (; !NILP (window
); window
= WGET (w
, next
))
1960 w
= XWINDOW (window
);
1962 if (!NILP (WGET (w
, hchild
)))
1963 fake_current_matrices (WGET (w
, hchild
));
1964 else if (!NILP (WGET (w
, vchild
)))
1965 fake_current_matrices (WGET (w
, vchild
));
1969 struct frame
*f
= XFRAME (WGET (w
, frame
));
1970 struct glyph_matrix
*m
= w
->current_matrix
;
1971 struct glyph_matrix
*fm
= f
->current_matrix
;
1973 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1974 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1976 for (i
= 0; i
< m
->matrix_h
; ++i
)
1978 struct glyph_row
*r
= m
->rows
+ i
;
1979 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1981 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1982 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1984 r
->enabled_p
= fr
->enabled_p
;
1987 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1988 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1989 r
->used
[TEXT_AREA
] = (m
->matrix_w
1990 - r
->used
[LEFT_MARGIN_AREA
]
1991 - r
->used
[RIGHT_MARGIN_AREA
]);
2000 /* Save away the contents of frame F's current frame matrix. Value is
2001 a glyph matrix holding the contents of F's current frame matrix. */
2003 static struct glyph_matrix
*
2004 save_current_matrix (struct frame
*f
)
2007 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
2008 saved
->nrows
= f
->current_matrix
->nrows
;
2009 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
2011 for (i
= 0; i
< saved
->nrows
; ++i
)
2013 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
2014 struct glyph_row
*to
= saved
->rows
+ i
;
2015 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2016 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
2017 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2018 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2025 /* Restore the contents of frame F's current frame matrix from SAVED,
2026 and free memory associated with SAVED. */
2029 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
2033 for (i
= 0; i
< saved
->nrows
; ++i
)
2035 struct glyph_row
*from
= saved
->rows
+ i
;
2036 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
2037 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
2038 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
2039 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
2040 xfree (from
->glyphs
[TEXT_AREA
]);
2043 xfree (saved
->rows
);
2049 /* Allocate/reallocate glyph matrices of a single frame F for
2050 frame-based redisplay. */
2053 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2055 struct dim matrix_dim
;
2057 int window_change_flags
;
2060 if (!FRAME_LIVE_P (f
))
2063 top_window_y
= FRAME_TOP_MARGIN (f
);
2065 /* Allocate glyph pool structures if not already done. */
2066 if (f
->desired_pool
== NULL
)
2068 f
->desired_pool
= new_glyph_pool ();
2069 f
->current_pool
= new_glyph_pool ();
2072 /* Allocate frames matrix structures if needed. */
2073 if (f
->desired_matrix
== NULL
)
2075 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2076 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2079 /* Compute window glyph matrices. (This takes the mini-buffer
2080 window into account). The result is the size of the frame glyph
2081 matrix needed. The variable window_change_flags is set to a bit
2082 mask indicating whether new matrices will be allocated or
2083 existing matrices change their size or location within the frame
2085 window_change_flags
= 0;
2087 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2090 &window_change_flags
);
2092 /* Add in menu bar lines, if any. */
2093 matrix_dim
.height
+= top_window_y
;
2095 /* Enlarge pools as necessary. */
2096 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2097 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2099 /* Set up glyph pointers within window matrices. Do this only if
2100 absolutely necessary since it requires a frame redraw. */
2101 if (pool_changed_p
|| window_change_flags
)
2103 /* Do it for window matrices. */
2104 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2106 &window_change_flags
);
2108 /* Size of frame matrices must equal size of frame. Note
2109 that we are called for X frames with window widths NOT equal
2110 to the frame width (from CHANGE_FRAME_SIZE_1). */
2111 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2112 && matrix_dim
.height
== FRAME_LINES (f
));
2114 /* Pointers to glyph memory in glyph rows are exchanged during
2115 the update phase of redisplay, which means in general that a
2116 frame's current matrix consists of pointers into both the
2117 desired and current glyph pool of the frame. Adjusting a
2118 matrix sets the frame matrix up so that pointers are all into
2119 the same pool. If we want to preserve glyph contents of the
2120 current matrix over a call to adjust_glyph_matrix, we must
2121 make a copy of the current glyphs, and restore the current
2122 matrix' contents from that copy. */
2123 if (display_completed
2124 && !FRAME_GARBAGED_P (f
)
2125 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2126 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2127 /* For some reason, the frame glyph matrix gets corrupted if
2128 any of the windows contain margins. I haven't been able
2129 to hunt down the reason, but for the moment this prevents
2130 the problem from manifesting. -- cyd */
2131 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2133 struct glyph_matrix
*copy
= save_current_matrix (f
);
2134 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2135 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2136 restore_current_matrix (f
, copy
);
2137 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2141 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2142 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2143 SET_FRAME_GARBAGED (f
);
2149 /* Allocate/reallocate glyph matrices of a single frame F for
2150 window-based redisplay. */
2153 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2155 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2157 /* Allocate/reallocate window matrices. */
2158 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2160 #ifdef HAVE_X_WINDOWS
2161 /* Allocate/ reallocate matrices of the dummy window used to display
2162 the menu bar under X when no X toolkit support is available. */
2163 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2165 /* Allocate a dummy window if not already done. */
2167 if (NILP (f
->menu_bar_window
))
2170 FSET (f
, menu_bar_window
, make_window ());
2171 w
= XWINDOW (f
->menu_bar_window
);
2172 XSETFRAME (frame
, f
);
2173 WSET (w
, frame
, frame
);
2174 w
->pseudo_window_p
= 1;
2177 w
= XWINDOW (f
->menu_bar_window
);
2179 /* Set window dimensions to frame dimensions and allocate or
2180 adjust glyph matrices of W. */
2181 WSET (w
, top_line
, make_number (0));
2182 WSET (w
, left_col
, make_number (0));
2183 WSET (w
, total_lines
, make_number (FRAME_MENU_BAR_LINES (f
)));
2184 WSET (w
, total_cols
, make_number (FRAME_TOTAL_COLS (f
)));
2185 allocate_matrices_for_window_redisplay (w
);
2187 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2188 #endif /* HAVE_X_WINDOWS */
2192 /* Allocate/ reallocate matrices of the tool bar window. If we
2193 don't have a tool bar window yet, make one. */
2195 if (NILP (f
->tool_bar_window
))
2198 FSET (f
, tool_bar_window
, make_window ());
2199 w
= XWINDOW (f
->tool_bar_window
);
2200 XSETFRAME (frame
, f
);
2201 WSET (w
, frame
, frame
);
2202 w
->pseudo_window_p
= 1;
2205 w
= XWINDOW (f
->tool_bar_window
);
2207 WSET (w
, top_line
, make_number (FRAME_MENU_BAR_LINES (f
)));
2208 WSET (w
, left_col
, make_number (0));
2209 WSET (w
, total_lines
, make_number (FRAME_TOOL_BAR_LINES (f
)));
2210 WSET (w
, total_cols
, make_number (FRAME_TOTAL_COLS (f
)));
2211 allocate_matrices_for_window_redisplay (w
);
2217 /* Adjust/ allocate message buffer of frame F.
2219 Note that the message buffer is never freed. Since I could not
2220 find a free in 19.34, I assume that freeing it would be
2221 problematic in some way and don't do it either.
2223 (Implementation note: It should be checked if we can free it
2224 eventually without causing trouble). */
2227 adjust_frame_message_buffer (struct frame
*f
)
2229 FRAME_MESSAGE_BUF (f
) = xrealloc (FRAME_MESSAGE_BUF (f
),
2230 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2234 /* Re-allocate buffer for decode_mode_spec on frame F. */
2237 adjust_decode_mode_spec_buffer (struct frame
*f
)
2239 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2240 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2245 /**********************************************************************
2246 Freeing Glyph Matrices
2247 **********************************************************************/
2249 /* Free glyph memory for a frame F. F may be null. This function can
2250 be called for the same frame more than once. The root window of
2251 F may be nil when this function is called. This is the case when
2252 the function is called when F is destroyed. */
2255 free_glyphs (struct frame
*f
)
2257 if (f
&& f
->glyphs_initialized_p
)
2259 /* Block interrupt input so that we don't get surprised by an X
2260 event while we're in an inconsistent state. */
2262 f
->glyphs_initialized_p
= 0;
2264 /* Release window sub-matrices. */
2265 if (!NILP (f
->root_window
))
2266 free_window_matrices (XWINDOW (f
->root_window
));
2268 /* Free the dummy window for menu bars without X toolkit and its
2270 if (!NILP (f
->menu_bar_window
))
2272 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2273 free_glyph_matrix (w
->desired_matrix
);
2274 free_glyph_matrix (w
->current_matrix
);
2275 w
->desired_matrix
= w
->current_matrix
= NULL
;
2276 FSET (f
, menu_bar_window
, Qnil
);
2279 /* Free the tool bar window and its glyph matrices. */
2280 if (!NILP (f
->tool_bar_window
))
2282 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2283 free_glyph_matrix (w
->desired_matrix
);
2284 free_glyph_matrix (w
->current_matrix
);
2285 w
->desired_matrix
= w
->current_matrix
= NULL
;
2286 FSET (f
, tool_bar_window
, Qnil
);
2289 /* Release frame glyph matrices. Reset fields to zero in
2290 case we are called a second time. */
2291 if (f
->desired_matrix
)
2293 free_glyph_matrix (f
->desired_matrix
);
2294 free_glyph_matrix (f
->current_matrix
);
2295 f
->desired_matrix
= f
->current_matrix
= NULL
;
2298 /* Release glyph pools. */
2299 if (f
->desired_pool
)
2301 free_glyph_pool (f
->desired_pool
);
2302 free_glyph_pool (f
->current_pool
);
2303 f
->desired_pool
= f
->current_pool
= NULL
;
2311 /* Free glyph sub-matrices in the window tree rooted at W. This
2312 function may be called with a null pointer, and it may be called on
2313 the same tree more than once. */
2316 free_window_matrices (struct window
*w
)
2320 if (!NILP (WGET (w
, hchild
)))
2321 free_window_matrices (XWINDOW (WGET (w
, hchild
)));
2322 else if (!NILP (WGET (w
, vchild
)))
2323 free_window_matrices (XWINDOW (WGET (w
, vchild
)));
2326 /* This is a leaf window. Free its memory and reset fields
2327 to zero in case this function is called a second time for
2329 free_glyph_matrix (w
->current_matrix
);
2330 free_glyph_matrix (w
->desired_matrix
);
2331 w
->current_matrix
= w
->desired_matrix
= NULL
;
2334 /* Next window on same level. */
2335 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
2340 /* Check glyph memory leaks. This function is called from
2341 shut_down_emacs. Note that frames are not destroyed when Emacs
2342 exits. We therefore free all glyph memory for all active frames
2343 explicitly and check that nothing is left allocated. */
2346 check_glyph_memory (void)
2348 Lisp_Object tail
, frame
;
2350 /* Free glyph memory for all frames. */
2351 FOR_EACH_FRAME (tail
, frame
)
2352 free_glyphs (XFRAME (frame
));
2354 /* Check that nothing is left allocated. */
2355 if (glyph_matrix_count
)
2357 if (glyph_pool_count
)
2363 /**********************************************************************
2364 Building a Frame Matrix
2365 **********************************************************************/
2367 /* Most of the redisplay code works on glyph matrices attached to
2368 windows. This is a good solution most of the time, but it is not
2369 suitable for terminal code. Terminal output functions cannot rely
2370 on being able to set an arbitrary terminal window. Instead they
2371 must be provided with a view of the whole frame, i.e. the whole
2372 screen. We build such a view by constructing a frame matrix from
2373 window matrices in this section.
2375 Windows that must be updated have their must_be_update_p flag set.
2376 For all such windows, their desired matrix is made part of the
2377 desired frame matrix. For other windows, their current matrix is
2378 made part of the desired frame matrix.
2380 +-----------------+----------------+
2381 | desired | desired |
2383 +-----------------+----------------+
2386 +----------------------------------+
2388 Desired window matrices can be made part of the frame matrix in a
2389 cheap way: We exploit the fact that the desired frame matrix and
2390 desired window matrices share their glyph memory. This is not
2391 possible for current window matrices. Their glyphs are copied to
2392 the desired frame matrix. The latter is equivalent to
2393 preserve_other_columns in the old redisplay.
2395 Used glyphs counters for frame matrix rows are the result of adding
2396 up glyph lengths of the window matrices. A line in the frame
2397 matrix is enabled, if a corresponding line in a window matrix is
2400 After building the desired frame matrix, it will be passed to
2401 terminal code, which will manipulate both the desired and current
2402 frame matrix. Changes applied to the frame's current matrix have
2403 to be visible in current window matrices afterwards, of course.
2405 This problem is solved like this:
2407 1. Window and frame matrices share glyphs. Window matrices are
2408 constructed in a way that their glyph contents ARE the glyph
2409 contents needed in a frame matrix. Thus, any modification of
2410 glyphs done in terminal code will be reflected in window matrices
2413 2. Exchanges of rows in a frame matrix done by terminal code are
2414 intercepted by hook functions so that corresponding row operations
2415 on window matrices can be performed. This is necessary because we
2416 use pointers to glyphs in glyph row structures. To satisfy the
2417 assumption of point 1 above that glyphs are updated implicitly in
2418 window matrices when they are manipulated via the frame matrix,
2419 window and frame matrix must of course agree where to find the
2420 glyphs for their rows. Possible manipulations that must be
2421 mirrored are assignments of rows of the desired frame matrix to the
2422 current frame matrix and scrolling the current frame matrix. */
2424 /* Build frame F's desired matrix from window matrices. Only windows
2425 which have the flag must_be_updated_p set have to be updated. Menu
2426 bar lines of a frame are not covered by window matrices, so make
2427 sure not to touch them in this function. */
2430 build_frame_matrix (struct frame
*f
)
2434 /* F must have a frame matrix when this function is called. */
2435 eassert (!FRAME_WINDOW_P (f
));
2437 /* Clear all rows in the frame matrix covered by window matrices.
2438 Menu bar lines are not covered by windows. */
2439 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2440 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2442 /* Build the matrix by walking the window tree. */
2443 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2444 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2448 /* Walk a window tree, building a frame matrix MATRIX from window
2449 matrices. W is the root of a window tree. */
2452 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2456 if (!NILP (WGET (w
, hchild
)))
2457 build_frame_matrix_from_window_tree (matrix
, XWINDOW (WGET (w
, hchild
)));
2458 else if (!NILP (WGET (w
, vchild
)))
2459 build_frame_matrix_from_window_tree (matrix
, XWINDOW (WGET (w
, vchild
)));
2461 build_frame_matrix_from_leaf_window (matrix
, w
);
2463 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
2468 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2469 desired frame matrix built. W is a leaf window whose desired or
2470 current matrix is to be added to FRAME_MATRIX. W's flag
2471 must_be_updated_p determines which matrix it contributes to
2472 FRAME_MATRIX. If must_be_updated_p is non-zero, W's desired matrix
2473 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2474 Adding a desired matrix means setting up used counters and such in
2475 frame rows, while adding a current window matrix to FRAME_MATRIX
2476 means copying glyphs. The latter case corresponds to
2477 preserve_other_columns in the old redisplay. */
2480 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2482 struct glyph_matrix
*window_matrix
;
2483 int window_y
, frame_y
;
2484 /* If non-zero, a glyph to insert at the right border of W. */
2485 GLYPH right_border_glyph
;
2487 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2489 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2490 if (w
->must_be_updated_p
)
2492 window_matrix
= w
->desired_matrix
;
2494 /* Decide whether we want to add a vertical border glyph. */
2495 if (!WINDOW_RIGHTMOST_P (w
))
2497 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2500 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2502 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2504 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2505 spec_glyph_lookup_face (w
, &right_border_glyph
);
2508 if (GLYPH_FACE (right_border_glyph
) <= 0)
2509 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2513 window_matrix
= w
->current_matrix
;
2515 /* For all rows in the window matrix and corresponding rows in the
2518 frame_y
= window_matrix
->matrix_y
;
2519 while (window_y
< window_matrix
->nrows
)
2521 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2522 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2523 int current_row_p
= window_matrix
== w
->current_matrix
;
2525 /* Fill up the frame row with spaces up to the left margin of the
2527 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2529 /* Fill up areas in the window matrix row with spaces. */
2530 fill_up_glyph_row_with_spaces (window_row
);
2532 /* If only part of W's desired matrix has been built, and
2533 window_row wasn't displayed, use the corresponding current
2535 if (window_matrix
== w
->desired_matrix
2536 && !window_row
->enabled_p
)
2538 window_row
= w
->current_matrix
->rows
+ window_y
;
2544 /* Copy window row to frame row. */
2545 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2546 window_row
->glyphs
[0],
2547 window_matrix
->matrix_w
* sizeof (struct glyph
));
2551 eassert (window_row
->enabled_p
);
2553 /* Only when a desired row has been displayed, we want
2554 the corresponding frame row to be updated. */
2555 frame_row
->enabled_p
= 1;
2557 /* Maybe insert a vertical border between horizontally adjacent
2559 if (GLYPH_CHAR (right_border_glyph
) != 0)
2561 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2562 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2566 /* Window row window_y must be a slice of frame row
2568 eassert (glyph_row_slice_p (window_row
, frame_row
));
2570 /* If rows are in sync, we don't have to copy glyphs because
2571 frame and window share glyphs. */
2573 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2574 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2578 /* Set number of used glyphs in the frame matrix. Since we fill
2579 up with spaces, and visit leaf windows from left to right it
2580 can be done simply. */
2581 frame_row
->used
[TEXT_AREA
]
2582 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2590 /* Given a user-specified glyph, possibly including a Lisp-level face
2591 ID, return a glyph that has a realized face ID.
2592 This is used for glyphs displayed specially and not part of the text;
2593 for instance, vertical separators, truncation markers, etc. */
2596 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2598 int lface_id
= GLYPH_FACE (*glyph
);
2599 /* Convert the glyph's specified face to a realized (cache) face. */
2602 int face_id
= merge_faces (XFRAME (WGET (w
, frame
)),
2603 Qt
, lface_id
, DEFAULT_FACE_ID
);
2604 SET_GLYPH_FACE (*glyph
, face_id
);
2608 /* Add spaces to a glyph row ROW in a window matrix.
2610 Each row has the form:
2612 +---------+-----------------------------+------------+
2613 | left | text | right |
2614 +---------+-----------------------------+------------+
2616 Left and right marginal areas are optional. This function adds
2617 spaces to areas so that there are no empty holes between areas.
2618 In other words: If the right area is not empty, the text area
2619 is filled up with spaces up to the right area. If the text area
2620 is not empty, the left area is filled up.
2622 To be called for frame-based redisplay, only. */
2625 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2627 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2628 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2629 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2633 /* Fill area AREA of glyph row ROW with spaces. To be called for
2634 frame-based redisplay only. */
2637 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2639 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2641 struct glyph
*end
= row
->glyphs
[area
+ 1];
2642 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2645 *text
++ = space_glyph
;
2646 row
->used
[area
] = text
- row
->glyphs
[area
];
2651 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2652 reached. In frame matrices only one area, TEXT_AREA, is used. */
2655 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2657 int i
= row
->used
[TEXT_AREA
];
2658 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2661 glyph
[i
++] = space_glyph
;
2663 row
->used
[TEXT_AREA
] = i
;
2668 /**********************************************************************
2669 Mirroring operations on frame matrices in window matrices
2670 **********************************************************************/
2672 /* Set frame being updated via frame-based redisplay to F. This
2673 function must be called before updates to make explicit that we are
2674 working on frame matrices or not. */
2677 set_frame_matrix_frame (struct frame
*f
)
2679 frame_matrix_frame
= f
;
2683 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2684 DESIRED_MATRIX is the desired matrix corresponding to
2685 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2686 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2687 frame_matrix_frame is non-null, this indicates that the exchange is
2688 done in frame matrices, and that we have to perform analogous
2689 operations in window matrices of frame_matrix_frame. */
2692 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2694 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2695 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2696 int mouse_face_p
= current_row
->mouse_face_p
;
2698 /* Do current_row = desired_row. This exchanges glyph pointers
2699 between both rows, and does a structure assignment otherwise. */
2700 assign_row (current_row
, desired_row
);
2702 /* Enable current_row to mark it as valid. */
2703 current_row
->enabled_p
= 1;
2704 current_row
->mouse_face_p
= mouse_face_p
;
2706 /* If we are called on frame matrices, perform analogous operations
2707 for window matrices. */
2708 if (frame_matrix_frame
)
2709 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2713 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2714 W's frame which has been made current (by swapping pointers between
2715 current and desired matrix). Perform analogous operations in the
2716 matrices of leaf windows in the window tree rooted at W. */
2719 mirror_make_current (struct window
*w
, int frame_row
)
2723 if (!NILP (WGET (w
, hchild
)))
2724 mirror_make_current (XWINDOW (WGET (w
, hchild
)), frame_row
);
2725 else if (!NILP (WGET (w
, vchild
)))
2726 mirror_make_current (XWINDOW (WGET (w
, vchild
)), frame_row
);
2729 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2730 here because the checks performed in debug mode there
2731 will not allow the conversion. */
2732 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2734 /* If FRAME_ROW is within W, assign the desired row to the
2735 current row (exchanging glyph pointers). */
2736 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2738 struct glyph_row
*current_row
2739 = MATRIX_ROW (w
->current_matrix
, row
);
2740 struct glyph_row
*desired_row
2741 = MATRIX_ROW (w
->desired_matrix
, row
);
2743 if (desired_row
->enabled_p
)
2744 assign_row (current_row
, desired_row
);
2746 swap_glyph_pointers (desired_row
, current_row
);
2747 current_row
->enabled_p
= 1;
2749 /* Set the Y coordinate of the mode/header line's row.
2750 It is needed in draw_row_with_mouse_face to find the
2751 screen coordinates. (Window-based redisplay sets
2752 this in update_window, but no one seems to do that
2753 for frame-based redisplay.) */
2754 if (current_row
->mode_line_p
)
2755 current_row
->y
= row
;
2759 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
2764 /* Perform row dance after scrolling. We are working on the range of
2765 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2766 including) in MATRIX. COPY_FROM is a vector containing, for each
2767 row I in the range 0 <= I < NLINES, the index of the original line
2768 to move to I. This index is relative to the row range, i.e. 0 <=
2769 index < NLINES. RETAINED_P is a vector containing zero for each
2770 row 0 <= I < NLINES which is empty.
2772 This function is called from do_scrolling and do_direct_scrolling. */
2775 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2776 int *copy_from
, char *retained_p
)
2778 /* A copy of original rows. */
2779 struct glyph_row
*old_rows
;
2781 /* Rows to assign to. */
2782 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2786 /* Make a copy of the original rows. */
2787 old_rows
= alloca (nlines
* sizeof *old_rows
);
2788 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2790 /* Assign new rows, maybe clear lines. */
2791 for (i
= 0; i
< nlines
; ++i
)
2793 int enabled_before_p
= new_rows
[i
].enabled_p
;
2795 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2796 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2797 new_rows
[i
] = old_rows
[copy_from
[i
]];
2798 new_rows
[i
].enabled_p
= enabled_before_p
;
2800 /* RETAINED_P is zero for empty lines. */
2801 if (!retained_p
[copy_from
[i
]])
2802 new_rows
[i
].enabled_p
= 0;
2805 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2806 if (frame_matrix_frame
)
2807 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2808 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2812 /* Synchronize glyph pointers in the current matrix of window W with
2813 the current frame matrix. */
2816 sync_window_with_frame_matrix_rows (struct window
*w
)
2818 struct frame
*f
= XFRAME (WGET (w
, frame
));
2819 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2820 int left
, right
, x
, width
;
2822 /* Preconditions: W must be a leaf window on a tty frame. */
2823 eassert (NILP (WGET (w
, hchild
)) && NILP (WGET (w
, vchild
)));
2824 eassert (!FRAME_WINDOW_P (f
));
2826 left
= margin_glyphs_to_reserve (w
, 1, WGET (w
, left_margin_cols
));
2827 right
= margin_glyphs_to_reserve (w
, 1, WGET (w
, right_margin_cols
));
2828 x
= w
->current_matrix
->matrix_x
;
2829 width
= w
->current_matrix
->matrix_w
;
2831 window_row
= w
->current_matrix
->rows
;
2832 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2833 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2835 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2837 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2838 = frame_row
->glyphs
[0] + x
;
2839 window_row
->glyphs
[TEXT_AREA
]
2840 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2841 window_row
->glyphs
[LAST_AREA
]
2842 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2843 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2844 = window_row
->glyphs
[LAST_AREA
] - right
;
2849 /* Return the window in the window tree rooted in W containing frame
2850 row ROW. Value is null if none is found. */
2852 static struct window
*
2853 frame_row_to_window (struct window
*w
, int row
)
2855 struct window
*found
= NULL
;
2859 if (!NILP (WGET (w
, hchild
)))
2860 found
= frame_row_to_window (XWINDOW (WGET (w
, hchild
)), row
);
2861 else if (!NILP (WGET (w
, vchild
)))
2862 found
= frame_row_to_window (XWINDOW (WGET (w
, vchild
)), row
);
2863 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2864 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2867 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
2874 /* Perform a line dance in the window tree rooted at W, after
2875 scrolling a frame matrix in mirrored_line_dance.
2877 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2878 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2879 COPY_FROM is a vector containing, for each row I in the range 0 <=
2880 I < NLINES, the index of the original line to move to I. This
2881 index is relative to the row range, i.e. 0 <= index < NLINES.
2882 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2886 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2890 if (!NILP (WGET (w
, hchild
)))
2891 mirror_line_dance (XWINDOW (WGET (w
, hchild
)), unchanged_at_top
,
2892 nlines
, copy_from
, retained_p
);
2893 else if (!NILP (WGET (w
, vchild
)))
2894 mirror_line_dance (XWINDOW (WGET (w
, vchild
)), unchanged_at_top
,
2895 nlines
, copy_from
, retained_p
);
2898 /* W is a leaf window, and we are working on its current
2900 struct glyph_matrix
*m
= w
->current_matrix
;
2902 struct glyph_row
*old_rows
;
2904 /* Make a copy of the original rows of matrix m. */
2905 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2906 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2908 for (i
= 0; i
< nlines
; ++i
)
2910 /* Frame relative line assigned to. */
2911 int frame_to
= i
+ unchanged_at_top
;
2913 /* Frame relative line assigned. */
2914 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2916 /* Window relative line assigned to. */
2917 int window_to
= frame_to
- m
->matrix_y
;
2919 /* Window relative line assigned. */
2920 int window_from
= frame_from
- m
->matrix_y
;
2922 /* Is assigned line inside window? */
2923 int from_inside_window_p
2924 = window_from
>= 0 && window_from
< m
->matrix_h
;
2926 /* Is assigned to line inside window? */
2927 int to_inside_window_p
2928 = window_to
>= 0 && window_to
< m
->matrix_h
;
2930 if (from_inside_window_p
&& to_inside_window_p
)
2932 /* Enabled setting before assignment. */
2933 int enabled_before_p
;
2935 /* Do the assignment. The enabled_p flag is saved
2936 over the assignment because the old redisplay did
2938 enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2939 m
->rows
[window_to
] = old_rows
[window_from
];
2940 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2942 /* If frame line is empty, window line is empty, too. */
2943 if (!retained_p
[copy_from
[i
]])
2944 m
->rows
[window_to
].enabled_p
= 0;
2946 else if (to_inside_window_p
)
2948 /* A copy between windows. This is an infrequent
2949 case not worth optimizing. */
2950 struct frame
*f
= XFRAME (WGET (w
, frame
));
2951 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2953 struct glyph_matrix
*m2
;
2956 w2
= frame_row_to_window (root
, frame_from
);
2957 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2958 -nw', FROM_FRAME sometimes has no associated window.
2959 This check avoids a segfault if W2 is null. */
2962 m2
= w2
->current_matrix
;
2963 m2_from
= frame_from
- m2
->matrix_y
;
2964 copy_row_except_pointers (m
->rows
+ window_to
,
2965 m2
->rows
+ m2_from
);
2967 /* If frame line is empty, window line is empty, too. */
2968 if (!retained_p
[copy_from
[i
]])
2969 m
->rows
[window_to
].enabled_p
= 0;
2973 else if (from_inside_window_p
)
2977 /* If there was a copy between windows, make sure glyph
2978 pointers are in sync with the frame matrix. */
2980 sync_window_with_frame_matrix_rows (w
);
2982 /* Check that no pointers are lost. */
2986 /* Next window on same level. */
2987 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
2994 /* Check that window and frame matrices agree about their
2995 understanding where glyphs of the rows are to find. For each
2996 window in the window tree rooted at W, check that rows in the
2997 matrices of leaf window agree with their frame matrices about
3001 check_window_matrix_pointers (struct window
*w
)
3005 if (!NILP (WGET (w
, hchild
)))
3006 check_window_matrix_pointers (XWINDOW (WGET (w
, hchild
)));
3007 else if (!NILP (WGET (w
, vchild
)))
3008 check_window_matrix_pointers (XWINDOW (WGET (w
, vchild
)));
3011 struct frame
*f
= XFRAME (WGET (w
, frame
));
3012 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
3013 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
3016 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
3021 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
3022 a window and FRAME_MATRIX is the corresponding frame matrix. For
3023 each row in WINDOW_MATRIX check that it's a slice of the
3024 corresponding frame row. If it isn't, abort. */
3027 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
3028 struct glyph_matrix
*frame_matrix
)
3030 /* Row number in WINDOW_MATRIX. */
3033 /* Row number corresponding to I in FRAME_MATRIX. */
3034 int j
= window_matrix
->matrix_y
;
3036 /* For all rows check that the row in the window matrix is a
3037 slice of the row in the frame matrix. If it isn't we didn't
3038 mirror an operation on the frame matrix correctly. */
3039 while (i
< window_matrix
->nrows
)
3041 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
3042 frame_matrix
->rows
+ j
))
3048 #endif /* GLYPH_DEBUG */
3052 /**********************************************************************
3053 VPOS and HPOS translations
3054 **********************************************************************/
3058 /* Translate vertical position VPOS which is relative to window W to a
3059 vertical position relative to W's frame. */
3062 window_to_frame_vpos (struct window
*w
, int vpos
)
3064 eassert (!FRAME_WINDOW_P (XFRAME (WGET (w
, frame
))));
3065 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3066 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3067 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (WGET (w
, frame
))));
3072 /* Translate horizontal position HPOS which is relative to window W to
3073 a horizontal position relative to W's frame. */
3076 window_to_frame_hpos (struct window
*w
, int hpos
)
3078 eassert (!FRAME_WINDOW_P (XFRAME (WGET (w
, frame
))));
3079 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3083 #endif /* GLYPH_DEBUG */
3087 /**********************************************************************
3089 **********************************************************************/
3091 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 1, 1, 0,
3092 doc
: /* Clear frame FRAME and output again what is supposed to appear on it. */)
3097 CHECK_LIVE_FRAME (frame
);
3100 /* Ignore redraw requests, if frame has no glyphs yet.
3101 (Implementation note: It still has to be checked why we are
3102 called so early here). */
3103 if (!glyphs_initialized_initially_p
)
3108 if (FRAME_MSDOS_P (f
))
3109 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3112 clear_current_matrices (f
);
3114 if (FRAME_TERMCAP_P (f
))
3115 fflush (FRAME_TTY (f
)->output
);
3116 windows_or_buffers_changed
++;
3117 /* Mark all windows as inaccurate, so that every window will have
3118 its redisplay done. */
3119 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3120 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3126 /* Redraw frame F. This is nothing more than a call to the Lisp
3127 function redraw-frame. */
3130 redraw_frame (struct frame
*f
)
3133 XSETFRAME (frame
, f
);
3134 Fredraw_frame (frame
);
3138 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3139 doc
: /* Clear and redisplay all visible frames. */)
3142 Lisp_Object tail
, frame
;
3144 FOR_EACH_FRAME (tail
, frame
)
3145 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3146 Fredraw_frame (frame
);
3153 /***********************************************************************
3155 ***********************************************************************/
3157 /* Update frame F based on the data in desired matrices.
3159 If FORCE_P is non-zero, don't let redisplay be stopped by detecting
3160 pending input. If INHIBIT_HAIRY_ID_P is non-zero, don't try
3163 Value is non-zero if redisplay was stopped due to pending input. */
3166 update_frame (struct frame
*f
, int force_p
, int inhibit_hairy_id_p
)
3168 /* 1 means display has been paused because of pending input. */
3170 struct window
*root_window
= XWINDOW (f
->root_window
);
3172 if (redisplay_dont_pause
)
3174 else if (NILP (Vredisplay_preemption_period
))
3176 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3178 double p
= XFLOATINT (Vredisplay_preemption_period
);
3180 if (detect_input_pending_ignore_squeezables ())
3186 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3187 preemption_next_check
= add_emacs_time (current_emacs_time (),
3191 if (FRAME_WINDOW_P (f
))
3193 /* We are working on window matrix basis. All windows whose
3194 flag must_be_updated_p is set have to be updated. */
3196 /* Record that we are not working on frame matrices. */
3197 set_frame_matrix_frame (NULL
);
3199 /* Update all windows in the window tree of F, maybe stopping
3200 when pending input is detected. */
3203 /* Update the menu bar on X frames that don't have toolkit
3205 if (WINDOWP (f
->menu_bar_window
))
3206 update_window (XWINDOW (f
->menu_bar_window
), 1);
3208 /* Update the tool-bar window, if present. */
3209 if (WINDOWP (f
->tool_bar_window
))
3211 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3213 /* Update tool-bar window. */
3214 if (w
->must_be_updated_p
)
3218 update_window (w
, 1);
3219 w
->must_be_updated_p
= 0;
3221 /* Swap tool-bar strings. We swap because we want to
3223 tem
= f
->current_tool_bar_string
;
3224 FSET (f
, current_tool_bar_string
, f
->desired_tool_bar_string
);
3225 FSET (f
, desired_tool_bar_string
, tem
);
3230 /* Update windows. */
3231 paused_p
= update_window_tree (root_window
, force_p
);
3234 /* This flush is a performance bottleneck under X,
3235 and it doesn't seem to be necessary anyway (in general).
3236 It is necessary when resizing the window with the mouse, or
3237 at least the fringes are not redrawn in a timely manner. ++kfs */
3238 if (f
->force_flush_display_p
)
3240 FRAME_RIF (f
)->flush_display (f
);
3241 f
->force_flush_display_p
= 0;
3246 /* We are working on frame matrix basis. Set the frame on whose
3247 frame matrix we operate. */
3248 set_frame_matrix_frame (f
);
3250 /* Build F's desired matrix from window matrices. */
3251 build_frame_matrix (f
);
3253 /* Update the display */
3255 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3258 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3260 if (FRAME_TTY (f
)->termscript
)
3261 fflush (FRAME_TTY (f
)->termscript
);
3262 if (FRAME_TERMCAP_P (f
))
3263 fflush (FRAME_TTY (f
)->output
);
3266 /* Check window matrices for lost pointers. */
3268 check_window_matrix_pointers (root_window
);
3269 add_frame_display_history (f
, paused_p
);
3274 /* Reset flags indicating that a window should be updated. */
3275 set_window_update_flags (root_window
, 0);
3277 display_completed
= !paused_p
;
3283 /************************************************************************
3284 Window-based updates
3285 ************************************************************************/
3287 /* Perform updates in window tree rooted at W. FORCE_P non-zero means
3288 don't stop updating when input is pending. */
3291 update_window_tree (struct window
*w
, int force_p
)
3295 while (w
&& !paused_p
)
3297 if (!NILP (WGET (w
, hchild
)))
3298 paused_p
|= update_window_tree (XWINDOW (WGET (w
, hchild
)), force_p
);
3299 else if (!NILP (WGET (w
, vchild
)))
3300 paused_p
|= update_window_tree (XWINDOW (WGET (w
, vchild
)), force_p
);
3301 else if (w
->must_be_updated_p
)
3302 paused_p
|= update_window (w
, force_p
);
3304 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
3311 /* Update window W if its flag must_be_updated_p is non-zero. If
3312 FORCE_P is non-zero, don't stop updating if input is pending. */
3315 update_single_window (struct window
*w
, int force_p
)
3317 if (w
->must_be_updated_p
)
3319 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3321 /* Record that this is not a frame-based redisplay. */
3322 set_frame_matrix_frame (NULL
);
3324 if (redisplay_dont_pause
)
3326 else if (NILP (Vredisplay_preemption_period
))
3328 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3330 double p
= XFLOATINT (Vredisplay_preemption_period
);
3331 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3332 preemption_next_check
= add_emacs_time (current_emacs_time (),
3338 update_window (w
, force_p
);
3341 /* Reset flag in W. */
3342 w
->must_be_updated_p
= 0;
3346 #ifdef HAVE_WINDOW_SYSTEM
3348 /* Redraw lines from the current matrix of window W that are
3349 overlapped by other rows. YB is bottom-most y-position in W. */
3352 redraw_overlapped_rows (struct window
*w
, int yb
)
3355 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3357 /* If rows overlapping others have been changed, the rows being
3358 overlapped have to be redrawn. This won't draw lines that have
3359 already been drawn in update_window_line because overlapped_p in
3360 desired rows is 0, so after row assignment overlapped_p in
3361 current rows is 0. */
3362 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3364 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3366 if (!row
->enabled_p
)
3368 else if (row
->mode_line_p
)
3371 if (row
->overlapped_p
)
3373 enum glyph_row_area area
;
3375 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3378 updated_area
= area
;
3379 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3380 area
== TEXT_AREA
? row
->x
: 0);
3381 if (row
->used
[area
])
3382 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3384 FRAME_RIF (f
)->clear_end_of_line (-1);
3387 row
->overlapped_p
= 0;
3390 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3396 /* Redraw lines from the current matrix of window W that overlap
3397 others. YB is bottom-most y-position in W. */
3400 redraw_overlapping_rows (struct window
*w
, int yb
)
3403 struct glyph_row
*row
;
3404 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3406 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3408 row
= w
->current_matrix
->rows
+ i
;
3410 if (!row
->enabled_p
)
3412 else if (row
->mode_line_p
)
3415 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3417 if (row
->overlapping_p
)
3421 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3422 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3423 overlaps
|= OVERLAPS_PRED
;
3424 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3425 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3426 overlaps
|= OVERLAPS_SUCC
;
3430 if (row
->used
[LEFT_MARGIN_AREA
])
3431 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3433 if (row
->used
[TEXT_AREA
])
3434 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3436 if (row
->used
[RIGHT_MARGIN_AREA
])
3437 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3439 /* Record in neighbor rows that ROW overwrites part of
3441 if (overlaps
& OVERLAPS_PRED
)
3442 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3443 if (overlaps
& OVERLAPS_SUCC
)
3444 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3453 #endif /* HAVE_WINDOW_SYSTEM */
3456 #if defined GLYPH_DEBUG && 0
3458 /* Check that no row in the current matrix of window W is enabled
3459 which is below what's displayed in the window. */
3462 check_current_matrix_flags (struct window
*w
)
3464 int last_seen_p
= 0;
3465 int i
, yb
= window_text_bottom_y (w
);
3467 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3469 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3470 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3472 else if (last_seen_p
&& row
->enabled_p
)
3477 #endif /* GLYPH_DEBUG */
3480 /* Update display of window W. FORCE_P non-zero means that we should
3481 not stop when detecting pending input. */
3484 update_window (struct window
*w
, int force_p
)
3486 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3488 #if !PERIODIC_PREEMPTION_CHECKING
3489 int preempt_count
= baud_rate
/ 2400 + 1;
3491 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3493 /* Check that W's frame doesn't have glyph matrices. */
3494 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3497 /* Check pending input the first time so that we can quickly return. */
3498 #if !PERIODIC_PREEMPTION_CHECKING
3500 detect_input_pending_ignore_squeezables ();
3503 /* If forced to complete the update, or if no input is pending, do
3505 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3507 struct glyph_row
*row
, *end
;
3508 struct glyph_row
*mode_line_row
;
3509 struct glyph_row
*header_line_row
;
3510 int yb
, changed_p
= 0, mouse_face_overwritten_p
= 0;
3511 #if ! PERIODIC_PREEMPTION_CHECKING
3515 rif
->update_window_begin_hook (w
);
3516 yb
= window_text_bottom_y (w
);
3517 row
= desired_matrix
->rows
;
3518 end
= row
+ desired_matrix
->nrows
- 1;
3520 /* Take note of the header line, if there is one. We will
3521 update it below, after updating all of the window's lines. */
3522 if (row
->mode_line_p
)
3524 header_line_row
= row
;
3528 header_line_row
= NULL
;
3530 /* Update the mode line, if necessary. */
3531 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3532 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3534 mode_line_row
->y
= yb
;
3535 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3537 &mouse_face_overwritten_p
);
3540 /* Find first enabled row. Optimizations in redisplay_internal
3541 may lead to an update with only one row enabled. There may
3542 be also completely empty matrices. */
3543 while (row
< end
&& !row
->enabled_p
)
3546 /* Try reusing part of the display by copying. */
3547 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3549 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3552 /* All rows were found to be equal. */
3558 /* We've scrolled the display. */
3564 /* Update the rest of the lines. */
3565 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3566 /* scrolling_window resets the enabled_p flag of the rows it
3567 reuses from current_matrix. */
3570 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3573 /* We'll have to play a little bit with when to
3574 detect_input_pending. If it's done too often,
3575 scrolling large windows with repeated scroll-up
3576 commands will too quickly pause redisplay. */
3577 #if PERIODIC_PREEMPTION_CHECKING
3580 EMACS_TIME tm
= current_emacs_time ();
3581 if (EMACS_TIME_LT (preemption_next_check
, tm
))
3583 preemption_next_check
= add_emacs_time (tm
,
3585 if (detect_input_pending_ignore_squeezables ())
3590 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3591 detect_input_pending_ignore_squeezables ();
3593 changed_p
|= update_window_line (w
, vpos
,
3594 &mouse_face_overwritten_p
);
3596 /* Mark all rows below the last visible one in the current
3597 matrix as invalid. This is necessary because of
3598 variable line heights. Consider the case of three
3599 successive redisplays, where the first displays 5
3600 lines, the second 3 lines, and the third 5 lines again.
3601 If the second redisplay wouldn't mark rows in the
3602 current matrix invalid, the third redisplay might be
3603 tempted to optimize redisplay based on lines displayed
3604 in the first redisplay. */
3605 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3606 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3607 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3610 /* Was display preempted? */
3611 paused_p
= row
< end
;
3615 /* Update the header line after scrolling because a new header
3616 line would otherwise overwrite lines at the top of the window
3617 that can be scrolled. */
3618 if (header_line_row
&& header_line_row
->enabled_p
)
3620 header_line_row
->y
= 0;
3621 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3624 /* Fix the appearance of overlapping/overlapped rows. */
3625 if (!paused_p
&& !w
->pseudo_window_p
)
3627 #ifdef HAVE_WINDOW_SYSTEM
3628 if (changed_p
&& rif
->fix_overlapping_area
)
3630 redraw_overlapped_rows (w
, yb
);
3631 redraw_overlapping_rows (w
, yb
);
3635 /* Make cursor visible at cursor position of W. */
3636 set_window_cursor_after_update (w
);
3638 #if 0 /* Check that current matrix invariants are satisfied. This is
3639 for debugging only. See the comment of check_matrix_invariants. */
3640 IF_DEBUG (check_matrix_invariants (w
));
3645 /* Remember the redisplay method used to display the matrix. */
3646 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3649 #ifdef HAVE_WINDOW_SYSTEM
3650 update_window_fringes (w
, 0);
3653 /* End the update of window W. Don't set the cursor if we
3654 paused updating the display because in this case,
3655 set_window_cursor_after_update hasn't been called, and
3656 output_cursor doesn't contain the cursor location. */
3657 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3663 /* check_current_matrix_flags (w); */
3664 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3667 clear_glyph_matrix (desired_matrix
);
3673 /* Update the display of area AREA in window W, row number VPOS.
3674 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3677 update_marginal_area (struct window
*w
, int area
, int vpos
)
3679 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3680 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3682 /* Let functions in xterm.c know what area subsequent X positions
3683 will be relative to. */
3684 updated_area
= area
;
3686 /* Set cursor to start of glyphs, write them, and clear to the end
3687 of the area. I don't think that something more sophisticated is
3688 necessary here, since marginal areas will not be the default. */
3689 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3690 if (desired_row
->used
[area
])
3691 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3692 rif
->clear_end_of_line (-1);
3696 /* Update the display of the text area of row VPOS in window W.
3697 Value is non-zero if display has changed. */
3700 update_text_area (struct window
*w
, int vpos
)
3702 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3703 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3704 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3707 /* Let functions in xterm.c know what area subsequent X positions
3708 will be relative to. */
3709 updated_area
= TEXT_AREA
;
3711 /* If rows are at different X or Y, or rows have different height,
3712 or the current row is marked invalid, write the entire line. */
3713 if (!current_row
->enabled_p
3714 || desired_row
->y
!= current_row
->y
3715 || desired_row
->ascent
!= current_row
->ascent
3716 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3717 || desired_row
->phys_height
!= current_row
->phys_height
3718 || desired_row
->visible_height
!= current_row
->visible_height
3719 || current_row
->overlapped_p
3720 /* This next line is necessary for correctly redrawing
3721 mouse-face areas after scrolling and other operations.
3722 However, it causes excessive flickering when mouse is moved
3723 across the mode line. Luckily, turning it off for the mode
3724 line doesn't seem to hurt anything. -- cyd.
3725 But it is still needed for the header line. -- kfs. */
3726 || (current_row
->mouse_face_p
3727 && !(current_row
->mode_line_p
&& vpos
> 0))
3728 || current_row
->x
!= desired_row
->x
)
3730 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3732 if (desired_row
->used
[TEXT_AREA
])
3733 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3734 desired_row
->used
[TEXT_AREA
]);
3736 /* Clear to end of window. */
3737 rif
->clear_end_of_line (-1);
3740 /* This erases the cursor. We do this here because
3741 notice_overwritten_cursor cannot easily check this, which
3742 might indicate that the whole functionality of
3743 notice_overwritten_cursor would better be implemented here.
3744 On the other hand, we need notice_overwritten_cursor as long
3745 as mouse highlighting is done asynchronously outside of
3747 if (vpos
== w
->phys_cursor
.vpos
)
3748 w
->phys_cursor_on_p
= 0;
3753 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3754 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3755 int overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3756 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3757 int abort_skipping
= 0;
3759 /* If the desired row extends its face to the text area end, and
3760 unless the current row also does so at the same position,
3761 make sure we write at least one glyph, so that the face
3762 extension actually takes place. */
3763 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3764 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3765 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3766 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3769 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3773 /* Loop over glyphs that current and desired row may have
3777 int can_skip_p
= !abort_skipping
;
3779 /* Skip over glyphs that both rows have in common. These
3780 don't have to be written. We can't skip if the last
3781 current glyph overlaps the glyph to its right. For
3782 example, consider a current row of `if ' with the `f' in
3783 Courier bold so that it overlaps the ` ' to its right.
3784 If the desired row is ` ', we would skip over the space
3785 after the `if' and there would remain a pixel from the
3786 `f' on the screen. */
3787 if (overlapping_glyphs_p
&& i
> 0)
3789 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3792 rif
->get_glyph_overhangs (glyph
, XFRAME (WGET (w
, frame
)),
3794 can_skip_p
= (right
== 0 && !abort_skipping
);
3802 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3804 x
+= desired_glyph
->pixel_width
;
3805 ++desired_glyph
, ++current_glyph
, ++i
;
3808 /* Consider the case that the current row contains "xxx
3809 ppp ggg" in italic Courier font, and the desired row
3810 is "xxx ggg". The character `p' has lbearing, `g'
3811 has not. The loop above will stop in front of the
3812 first `p' in the current row. If we would start
3813 writing glyphs there, we wouldn't erase the lbearing
3814 of the `p'. The rest of the lbearing problem is then
3815 taken care of by draw_glyphs. */
3816 if (overlapping_glyphs_p
3818 && i
< current_row
->used
[TEXT_AREA
]
3819 && (current_row
->used
[TEXT_AREA
]
3820 != desired_row
->used
[TEXT_AREA
]))
3824 rif
->get_glyph_overhangs (current_glyph
,
3825 XFRAME (WGET (w
, frame
)),
3827 while (left
> 0 && i
> 0)
3829 --i
, --desired_glyph
, --current_glyph
;
3830 x
-= desired_glyph
->pixel_width
;
3831 left
-= desired_glyph
->pixel_width
;
3834 /* Abort the skipping algorithm if we end up before
3835 our starting point, to avoid looping (bug#1070).
3836 This can happen when the lbearing is larger than
3838 abort_skipping
= (i
< start_hpos
);
3842 /* Try to avoid writing the entire rest of the desired row
3843 by looking for a resync point. This mainly prevents
3844 mode line flickering in the case the mode line is in
3845 fixed-pitch font, which it usually will be. */
3846 if (i
< desired_row
->used
[TEXT_AREA
])
3848 int start_x
= x
, start_hpos
= i
;
3849 struct glyph
*start
= desired_glyph
;
3851 int skip_first_p
= !can_skip_p
;
3853 /* Find the next glyph that's equal again. */
3856 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3859 x
+= desired_glyph
->pixel_width
;
3860 current_x
+= current_glyph
->pixel_width
;
3861 ++desired_glyph
, ++current_glyph
, ++i
;
3865 if (i
== start_hpos
|| x
!= current_x
)
3869 desired_glyph
= start
;
3873 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3874 rif
->write_glyphs (start
, i
- start_hpos
);
3879 /* Write the rest. */
3880 if (i
< desired_row
->used
[TEXT_AREA
])
3882 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3883 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3887 /* Maybe clear to end of line. */
3888 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3890 /* If new row extends to the end of the text area, nothing
3891 has to be cleared, if and only if we did a write_glyphs
3892 above. This is made sure by setting desired_stop_pos
3893 appropriately above. */
3894 eassert (i
< desired_row
->used
[TEXT_AREA
]
3895 || ((desired_row
->used
[TEXT_AREA
]
3896 == current_row
->used
[TEXT_AREA
])
3897 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3899 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3901 /* If old row extends to the end of the text area, clear. */
3902 if (i
>= desired_row
->used
[TEXT_AREA
])
3903 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3904 desired_row
->pixel_width
);
3905 rif
->clear_end_of_line (-1);
3908 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3910 /* Otherwise clear to the end of the old row. Everything
3911 after that position should be clear already. */
3914 if (i
>= desired_row
->used
[TEXT_AREA
])
3915 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3916 desired_row
->pixel_width
);
3918 /* If cursor is displayed at the end of the line, make sure
3919 it's cleared. Nowadays we don't have a phys_cursor_glyph
3920 with which to erase the cursor (because this method
3921 doesn't work with lbearing/rbearing), so we must do it
3923 if (vpos
== w
->phys_cursor
.vpos
3924 && (desired_row
->reversed_p
3925 ? (w
->phys_cursor
.hpos
< 0)
3926 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3928 w
->phys_cursor_on_p
= 0;
3932 xlim
= current_row
->pixel_width
;
3933 rif
->clear_end_of_line (xlim
);
3942 /* Update row VPOS in window W. Value is non-zero if display has been
3946 update_window_line (struct window
*w
, int vpos
, int *mouse_face_overwritten_p
)
3948 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3949 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3950 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3953 /* Set the row being updated. This is important to let xterm.c
3954 know what line height values are in effect. */
3955 updated_row
= desired_row
;
3957 /* A row can be completely invisible in case a desired matrix was
3958 built with a vscroll and then make_cursor_line_fully_visible shifts
3959 the matrix. Make sure to make such rows current anyway, since
3960 we need the correct y-position, for example, in the current matrix. */
3961 if (desired_row
->mode_line_p
3962 || desired_row
->visible_height
> 0)
3964 eassert (desired_row
->enabled_p
);
3966 /* Update display of the left margin area, if there is one. */
3967 if (!desired_row
->full_width_p
3968 && !NILP (WGET (w
, left_margin_cols
)))
3971 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
3974 /* Update the display of the text area. */
3975 if (update_text_area (w
, vpos
))
3978 if (current_row
->mouse_face_p
)
3979 *mouse_face_overwritten_p
= 1;
3982 /* Update display of the right margin area, if there is one. */
3983 if (!desired_row
->full_width_p
3984 && !NILP (WGET (w
, right_margin_cols
)))
3987 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
3990 /* Draw truncation marks etc. */
3991 if (!current_row
->enabled_p
3992 || desired_row
->y
!= current_row
->y
3993 || desired_row
->visible_height
!= current_row
->visible_height
3994 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3995 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3996 || current_row
->redraw_fringe_bitmaps_p
3997 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3998 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3999 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
4000 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
4001 rif
->after_update_window_line_hook (desired_row
);
4004 /* Update current_row from desired_row. */
4005 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
4011 /* Set the cursor after an update of window W. This function may only
4012 be called from update_window. */
4015 set_window_cursor_after_update (struct window
*w
)
4017 struct frame
*f
= XFRAME (WGET (w
, frame
));
4018 struct redisplay_interface
*rif
= FRAME_RIF (f
);
4019 int cx
, cy
, vpos
, hpos
;
4021 /* Not intended for frame matrix updates. */
4022 eassert (FRAME_WINDOW_P (f
));
4024 if (cursor_in_echo_area
4025 && !NILP (echo_area_buffer
[0])
4026 /* If we are showing a message instead of the mini-buffer,
4027 show the cursor for the message instead. */
4028 && XWINDOW (minibuf_window
) == w
4029 && EQ (minibuf_window
, echo_area_window
)
4030 /* These cases apply only to the frame that contains
4031 the active mini-buffer window. */
4032 && FRAME_HAS_MINIBUF_P (f
)
4033 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4035 cx
= cy
= vpos
= hpos
= 0;
4037 if (cursor_in_echo_area
>= 0)
4039 /* If the mini-buffer is several lines high, find the last
4040 line that has any text on it. Note: either all lines
4041 are enabled or none. Otherwise we wouldn't be able to
4043 struct glyph_row
*row
, *last_row
;
4044 struct glyph
*glyph
;
4045 int yb
= window_text_bottom_y (w
);
4048 row
= w
->current_matrix
->rows
;
4049 while (row
->enabled_p
4050 && (last_row
== NULL
4051 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
4053 if (row
->used
[TEXT_AREA
]
4054 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
4061 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4062 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4064 while (last
> start
&& last
->charpos
< 0)
4067 for (glyph
= start
; glyph
< last
; ++glyph
)
4069 cx
+= glyph
->pixel_width
;
4074 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4082 hpos
= w
->cursor
.hpos
;
4083 vpos
= w
->cursor
.vpos
;
4086 /* Window cursor can be out of sync for horizontally split windows. */
4087 hpos
= max (-1, hpos
); /* -1 is for when cursor is on the left fringe */
4088 hpos
= min (w
->current_matrix
->matrix_w
- 1, hpos
);
4089 vpos
= max (0, vpos
);
4090 vpos
= min (w
->current_matrix
->nrows
- 1, vpos
);
4091 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4095 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4096 tree rooted at W. */
4099 set_window_update_flags (struct window
*w
, int on_p
)
4103 if (!NILP (WGET (w
, hchild
)))
4104 set_window_update_flags (XWINDOW (WGET (w
, hchild
)), on_p
);
4105 else if (!NILP (WGET (w
, vchild
)))
4106 set_window_update_flags (XWINDOW (WGET (w
, vchild
)), on_p
);
4108 w
->must_be_updated_p
= on_p
;
4110 w
= NILP (WGET (w
, next
)) ? 0 : XWINDOW (WGET (w
, next
));
4116 /***********************************************************************
4117 Window-Based Scrolling
4118 ***********************************************************************/
4120 /* Structure describing rows in scrolling_window. */
4124 /* Number of occurrences of this row in desired and current matrix. */
4125 int old_uses
, new_uses
;
4127 /* Vpos of row in new matrix. */
4128 int new_line_number
;
4130 /* Bucket index of this row_entry in the hash table row_table. */
4133 /* The row described by this entry. */
4134 struct glyph_row
*row
;
4136 /* Hash collision chain. */
4137 struct row_entry
*next
;
4140 /* A pool to allocate row_entry structures from, and the size of the
4141 pool. The pool is reallocated in scrolling_window when we find
4142 that we need a larger one. */
4144 static struct row_entry
*row_entry_pool
;
4145 static ptrdiff_t row_entry_pool_size
;
4147 /* Index of next free entry in row_entry_pool. */
4149 static ptrdiff_t row_entry_idx
;
4151 /* The hash table used during scrolling, and the table's size. This
4152 table is used to quickly identify equal rows in the desired and
4155 static struct row_entry
**row_table
;
4156 static ptrdiff_t row_table_size
;
4158 /* Vectors of pointers to row_entry structures belonging to the
4159 current and desired matrix, and the size of the vectors. */
4161 static struct row_entry
**old_lines
, **new_lines
;
4162 static ptrdiff_t old_lines_size
, new_lines_size
;
4164 /* A pool to allocate run structures from, and its size. */
4166 static struct run
*run_pool
;
4167 static ptrdiff_t runs_size
;
4169 /* A vector of runs of lines found during scrolling. */
4171 static struct run
**runs
;
4173 /* Add glyph row ROW to the scrolling hash table. */
4175 static inline struct row_entry
*
4176 add_row_entry (struct glyph_row
*row
)
4178 struct row_entry
*entry
;
4179 ptrdiff_t i
= row
->hash
% row_table_size
;
4181 entry
= row_table
[i
];
4182 eassert (entry
|| verify_row_hash (row
));
4183 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4184 entry
= entry
->next
;
4188 entry
= row_entry_pool
+ row_entry_idx
++;
4190 entry
->old_uses
= entry
->new_uses
= 0;
4191 entry
->new_line_number
= 0;
4193 entry
->next
= row_table
[i
];
4194 row_table
[i
] = entry
;
4201 /* Try to reuse part of the current display of W by scrolling lines.
4202 HEADER_LINE_P non-zero means W has a header line.
4204 The algorithm is taken from Communications of the ACM, Apr78 "A
4205 Technique for Isolating Differences Between Files." It should take
4208 A short outline of the steps of the algorithm
4210 1. Skip lines equal at the start and end of both matrices.
4212 2. Enter rows in the current and desired matrix into a symbol
4213 table, counting how often they appear in both matrices.
4215 3. Rows that appear exactly once in both matrices serve as anchors,
4216 i.e. we assume that such lines are likely to have been moved.
4218 4. Starting from anchor lines, extend regions to be scrolled both
4219 forward and backward.
4223 -1 if all rows were found to be equal.
4224 0 to indicate that we did not scroll the display, or
4225 1 if we did scroll. */
4228 scrolling_window (struct window
*w
, int header_line_p
)
4230 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4231 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4232 int yb
= window_text_bottom_y (w
);
4234 int j
, first_old
, first_new
, last_old
, last_new
;
4237 struct row_entry
*entry
;
4238 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4240 /* Skip over rows equal at the start. */
4241 for (i
= header_line_p
? 1 : 0; i
< current_matrix
->nrows
- 1; ++i
)
4243 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4244 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4248 && !d
->redraw_fringe_bitmaps_p
4250 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4251 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4252 && row_equal_p (c
, d
, 1))
4261 /* Give up if some rows in the desired matrix are not enabled. */
4262 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4265 first_old
= first_new
= i
;
4267 /* Set last_new to the index + 1 of the row that reaches the
4268 bottom boundary in the desired matrix. Give up if we find a
4269 disabled row before we reach the bottom boundary. */
4271 while (i
< desired_matrix
->nrows
- 1)
4275 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4277 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4286 /* Set last_old to the index + 1 of the row that reaches the bottom
4287 boundary in the current matrix. We don't look at the enabled
4288 flag here because we plan to reuse part of the display even if
4289 other parts are disabled. */
4291 while (i
< current_matrix
->nrows
- 1)
4293 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4302 /* Skip over rows equal at the bottom. */
4305 while (i
- 1 > first_new
4306 && j
- 1 > first_old
4307 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4308 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4309 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4310 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4311 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4312 MATRIX_ROW (current_matrix
, j
- 1), 1))
4317 /* Nothing to do if all rows are equal. */
4318 if (last_new
== first_new
)
4321 /* Check for integer overflow in size calculation.
4323 If next_almost_prime checks (N) for divisibility by 2..10, then
4324 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4325 So, set next_almost_prime_increment_max to 10.
4327 It's just a coincidence that next_almost_prime_increment_max ==
4328 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4329 13, then next_almost_prime_increment_max would be 14, e.g.,
4330 because next_almost_prime (113) would be 127. */
4332 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4333 enum { next_almost_prime_increment_max
= 10 };
4334 ptrdiff_t row_table_max
=
4335 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4336 - next_almost_prime_increment_max
);
4337 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4338 if (current_nrows_max
< current_matrix
->nrows
)
4339 memory_full (SIZE_MAX
);
4342 /* Reallocate vectors, tables etc. if necessary. */
4344 if (current_matrix
->nrows
> old_lines_size
)
4345 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4346 current_matrix
->nrows
- old_lines_size
,
4347 INT_MAX
, sizeof *old_lines
);
4349 if (desired_matrix
->nrows
> new_lines_size
)
4350 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4351 desired_matrix
->nrows
- new_lines_size
,
4352 INT_MAX
, sizeof *new_lines
);
4354 n
= desired_matrix
->nrows
;
4355 n
+= current_matrix
->nrows
;
4356 if (row_table_size
< 3 * n
)
4358 ptrdiff_t size
= next_almost_prime (3 * n
);
4359 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4360 row_table_size
= size
;
4361 memset (row_table
, 0, size
* sizeof *row_table
);
4364 if (n
> row_entry_pool_size
)
4365 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4366 n
- row_entry_pool_size
,
4367 -1, sizeof *row_entry_pool
);
4369 if (desired_matrix
->nrows
> runs_size
)
4371 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4372 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4373 runs_size
= desired_matrix
->nrows
;
4376 nruns
= run_idx
= 0;
4379 /* Add rows from the current and desired matrix to the hash table
4380 row_hash_table to be able to find equal ones quickly. */
4382 for (i
= first_old
; i
< last_old
; ++i
)
4384 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4386 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4387 old_lines
[i
] = entry
;
4391 old_lines
[i
] = NULL
;
4394 for (i
= first_new
; i
< last_new
; ++i
)
4396 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4397 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4399 entry
->new_line_number
= i
;
4400 new_lines
[i
] = entry
;
4403 /* Identify moves based on lines that are unique and equal
4404 in both matrices. */
4405 for (i
= first_old
; i
< last_old
;)
4407 && old_lines
[i
]->old_uses
== 1
4408 && old_lines
[i
]->new_uses
== 1)
4411 int new_line
= old_lines
[i
]->new_line_number
;
4412 struct run
*run
= run_pool
+ run_idx
++;
4415 run
->current_vpos
= i
;
4416 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4417 run
->desired_vpos
= new_line
;
4418 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4420 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4422 /* Extend backward. */
4425 while (p
> first_old
4427 && old_lines
[p
] == new_lines
[q
])
4429 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4430 --run
->current_vpos
;
4431 --run
->desired_vpos
;
4434 run
->desired_y
-= h
;
4435 run
->current_y
-= h
;
4439 /* Extend forward. */
4444 && old_lines
[p
] == new_lines
[q
])
4446 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4452 /* Insert run into list of all runs. Order runs by copied
4453 pixel lines. Note that we record runs that don't have to
4454 be copied because they are already in place. This is done
4455 because we can avoid calling update_window_line in this
4457 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4459 for (q
= nruns
; q
> p
; --q
)
4460 runs
[q
] = runs
[q
- 1];
4469 /* Do the moves. Do it in a way that we don't overwrite something
4470 we want to copy later on. This is not solvable in general
4471 because there is only one display and we don't have a way to
4472 exchange areas on this display. Example:
4474 +-----------+ +-----------+
4476 +-----------+ --> +-----------+
4478 +-----------+ +-----------+
4480 Instead, prefer bigger moves, and invalidate moves that would
4481 copy from where we copied to. */
4483 for (i
= 0; i
< nruns
; ++i
)
4484 if (runs
[i
]->nrows
> 0)
4486 struct run
*r
= runs
[i
];
4488 /* Copy on the display. */
4489 if (r
->current_y
!= r
->desired_y
)
4491 rif
->clear_window_mouse_face (w
);
4492 rif
->scroll_run_hook (w
, r
);
4495 /* Truncate runs that copy to where we copied to, and
4496 invalidate runs that copy from where we copied to. */
4497 for (j
= nruns
- 1; j
> i
; --j
)
4499 struct run
*p
= runs
[j
];
4500 int truncated_p
= 0;
4503 && p
->desired_y
< r
->desired_y
+ r
->height
4504 && p
->desired_y
+ p
->height
> r
->desired_y
)
4506 if (p
->desired_y
< r
->desired_y
)
4508 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4509 p
->height
= r
->desired_y
- p
->desired_y
;
4514 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4517 if (p
->nrows
<= nrows_copied
)
4521 int height_copied
= (r
->desired_y
+ r
->height
4524 p
->current_vpos
+= nrows_copied
;
4525 p
->desired_vpos
+= nrows_copied
;
4526 p
->nrows
-= nrows_copied
;
4527 p
->current_y
+= height_copied
;
4528 p
->desired_y
+= height_copied
;
4529 p
->height
-= height_copied
;
4535 if (r
->current_y
!= r
->desired_y
4536 /* The condition below is equivalent to
4537 ((p->current_y >= r->desired_y
4538 && p->current_y < r->desired_y + r->height)
4539 || (p->current_y + p->height > r->desired_y
4540 && (p->current_y + p->height
4541 <= r->desired_y + r->height)))
4542 because we have 0 < p->height <= r->height. */
4543 && p
->current_y
< r
->desired_y
+ r
->height
4544 && p
->current_y
+ p
->height
> r
->desired_y
)
4547 /* Reorder runs by copied pixel lines if truncated. */
4548 if (truncated_p
&& p
->nrows
> 0)
4552 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4554 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4559 /* Assign matrix rows. */
4560 for (j
= 0; j
< r
->nrows
; ++j
)
4562 struct glyph_row
*from
, *to
;
4563 int to_overlapped_p
;
4565 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4566 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4567 to_overlapped_p
= to
->overlapped_p
;
4568 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4569 assign_row (to
, from
);
4570 /* The above `assign_row' actually does swap, so if we had
4571 an overlap in the copy destination of two runs, then
4572 the second run would assign a previously disabled bogus
4573 row. But thanks to the truncation code in the
4574 preceding for-loop, we no longer have such an overlap,
4575 and thus the assigned row should always be enabled. */
4576 eassert (to
->enabled_p
);
4577 from
->enabled_p
= 0;
4578 to
->overlapped_p
= to_overlapped_p
;
4582 /* Clear the hash table, for the next time. */
4583 for (i
= 0; i
< row_entry_idx
; ++i
)
4584 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4586 /* Value is 1 to indicate that we scrolled the display. */
4592 /************************************************************************
4594 ************************************************************************/
4596 /* Update the desired frame matrix of frame F.
4598 FORCE_P non-zero means that the update should not be stopped by
4599 pending input. INHIBIT_HAIRY_ID_P non-zero means that scrolling
4600 should not be tried.
4602 Value is non-zero if update was stopped due to pending input. */
4605 update_frame_1 (struct frame
*f
, int force_p
, int inhibit_id_p
)
4607 /* Frame matrices to work on. */
4608 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4609 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4612 int preempt_count
= baud_rate
/ 2400 + 1;
4614 eassert (current_matrix
&& desired_matrix
);
4616 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4617 calculate_costs (f
);
4619 if (preempt_count
<= 0)
4622 #if !PERIODIC_PREEMPTION_CHECKING
4623 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4630 /* If we cannot insert/delete lines, it's no use trying it. */
4631 if (!FRAME_LINE_INS_DEL_OK (f
))
4634 /* See if any of the desired lines are enabled; don't compute for
4635 i/d line if just want cursor motion. */
4636 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4637 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4640 /* Try doing i/d line, if not yet inhibited. */
4641 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4642 force_p
|= scrolling (f
);
4644 /* Update the individual lines as needed. Do bottom line first. */
4645 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4646 update_frame_line (f
, desired_matrix
->nrows
- 1);
4648 /* Now update the rest of the lines. */
4649 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4651 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4653 if (FRAME_TERMCAP_P (f
))
4655 /* Flush out every so many lines.
4656 Also flush out if likely to have more than 1k buffered
4657 otherwise. I'm told that some telnet connections get
4658 really screwed by more than 1k output at once. */
4659 FILE *display_output
= FRAME_TTY (f
)->output
;
4662 int outq
= PENDING_OUTPUT_COUNT (display_output
);
4664 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4666 fflush (display_output
);
4667 if (preempt_count
== 1)
4669 #ifdef EMACS_OUTQSIZE
4670 if (EMACS_OUTQSIZE (0, &outq
) < 0)
4671 /* Probably not a tty. Ignore the error and reset
4673 outq
= PENDING_OUTPUT_COUNT (FRAME_TTY (f
->output
));
4676 if (baud_rate
<= outq
&& baud_rate
> 0)
4677 sleep (outq
/ baud_rate
);
4683 #if PERIODIC_PREEMPTION_CHECKING
4686 EMACS_TIME tm
= current_emacs_time ();
4687 if (EMACS_TIME_LT (preemption_next_check
, tm
))
4689 preemption_next_check
= add_emacs_time (tm
, preemption_period
);
4690 if (detect_input_pending_ignore_squeezables ())
4695 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4696 detect_input_pending_ignore_squeezables ();
4699 update_frame_line (f
, i
);
4703 pause_p
= (i
< FRAME_LINES (f
) - 1) ? i
: 0;
4705 /* Now just clean up termcap drivers and set cursor, etc. */
4708 if ((cursor_in_echo_area
4709 /* If we are showing a message instead of the mini-buffer,
4710 show the cursor for the message instead of for the
4711 (now hidden) mini-buffer contents. */
4712 || (EQ (minibuf_window
, selected_window
)
4713 && EQ (minibuf_window
, echo_area_window
)
4714 && !NILP (echo_area_buffer
[0])))
4715 /* These cases apply only to the frame that contains
4716 the active mini-buffer window. */
4717 && FRAME_HAS_MINIBUF_P (f
)
4718 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4720 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4723 if (cursor_in_echo_area
< 0)
4725 /* Negative value of cursor_in_echo_area means put
4726 cursor at beginning of line. */
4732 /* Positive value of cursor_in_echo_area means put
4733 cursor at the end of the prompt. If the mini-buffer
4734 is several lines high, find the last line that has
4736 row
= FRAME_LINES (f
);
4742 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4744 /* Frame rows are filled up with spaces that
4745 must be ignored here. */
4746 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4748 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4749 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4752 && (last
- 1)->charpos
< 0)
4758 while (row
> top
&& col
== 0);
4760 /* Make sure COL is not out of range. */
4761 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4763 /* If we have another row, advance cursor into it. */
4764 if (row
< FRAME_LINES (f
) - 1)
4766 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4769 /* Otherwise move it back in range. */
4771 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4775 cursor_to (f
, row
, col
);
4779 /* We have only one cursor on terminal frames. Use it to
4780 display the cursor of the selected window. */
4781 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4782 if (w
->cursor
.vpos
>= 0
4783 /* The cursor vpos may be temporarily out of bounds
4784 in the following situation: There is one window,
4785 with the cursor in the lower half of it. The window
4786 is split, and a message causes a redisplay before
4787 a new cursor position has been computed. */
4788 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4790 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4791 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4793 if (INTEGERP (WGET (w
, left_margin_cols
)))
4794 x
+= XFASTINT (WGET (w
, left_margin_cols
));
4796 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4797 cursor_to (f
, y
, x
);
4802 #if !PERIODIC_PREEMPTION_CHECKING
4806 clear_desired_matrices (f
);
4811 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4814 scrolling (struct frame
*frame
)
4816 int unchanged_at_top
, unchanged_at_bottom
;
4819 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4820 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4821 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4822 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4824 int free_at_end_vpos
= FRAME_LINES (frame
);
4825 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4826 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4828 if (!current_matrix
)
4831 /* Compute hash codes of all the lines. Also calculate number of
4832 changed lines, number of unchanged lines at the beginning, and
4833 number of unchanged lines at the end. */
4835 unchanged_at_top
= 0;
4836 unchanged_at_bottom
= FRAME_LINES (frame
);
4837 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4839 /* Give up on this scrolling if some old lines are not enabled. */
4840 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4842 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4843 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4845 /* This line cannot be redrawn, so don't let scrolling mess it. */
4846 new_hash
[i
] = old_hash
[i
];
4847 #define INFINITY 1000000 /* Taken from scroll.c */
4848 draw_cost
[i
] = INFINITY
;
4852 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4853 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4856 if (old_hash
[i
] != new_hash
[i
])
4859 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4861 else if (i
== unchanged_at_top
)
4863 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4866 /* If changed lines are few, don't allow preemption, don't scroll. */
4867 if ((!FRAME_SCROLL_REGION_OK (frame
)
4868 && changed_lines
< baud_rate
/ 2400)
4869 || unchanged_at_bottom
== FRAME_LINES (frame
))
4872 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4873 - unchanged_at_bottom
);
4875 if (FRAME_SCROLL_REGION_OK (frame
))
4876 free_at_end_vpos
-= unchanged_at_bottom
;
4877 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4878 free_at_end_vpos
= -1;
4880 /* If large window, fast terminal and few lines in common between
4881 current frame and desired frame, don't bother with i/d calc. */
4882 if (!FRAME_SCROLL_REGION_OK (frame
)
4883 && window_size
>= 18 && baud_rate
> 2400
4885 10 * scrolling_max_lines_saved (unchanged_at_top
,
4886 FRAME_LINES (frame
) - unchanged_at_bottom
,
4887 old_hash
, new_hash
, draw_cost
)))
4890 if (window_size
< 2)
4893 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4894 draw_cost
+ unchanged_at_top
- 1,
4895 old_draw_cost
+ unchanged_at_top
- 1,
4896 old_hash
+ unchanged_at_top
- 1,
4897 new_hash
+ unchanged_at_top
- 1,
4898 free_at_end_vpos
- unchanged_at_top
);
4904 /* Count the number of blanks at the start of the vector of glyphs R
4905 which is LEN glyphs long. */
4908 count_blanks (struct glyph
*r
, int len
)
4912 for (i
= 0; i
< len
; ++i
)
4913 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4920 /* Count the number of glyphs in common at the start of the glyph
4921 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4922 of STR2. Value is the number of equal glyphs equal at the start. */
4925 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4927 struct glyph
*p1
= str1
;
4928 struct glyph
*p2
= str2
;
4932 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4939 /* Char insertion/deletion cost vector, from term.c */
4941 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4944 /* Perform a frame-based update on line VPOS in frame FRAME. */
4947 update_frame_line (struct frame
*f
, int vpos
)
4949 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4951 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4952 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4953 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4954 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4955 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4956 int must_write_whole_line_p
;
4957 int write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4958 int colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4959 != FACE_TTY_DEFAULT_BG_COLOR
);
4961 if (colored_spaces_p
)
4964 /* Current row not enabled means it has unknown contents. We must
4965 write the whole desired line in that case. */
4966 must_write_whole_line_p
= !current_row
->enabled_p
;
4967 if (must_write_whole_line_p
)
4974 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4975 olen
= current_row
->used
[TEXT_AREA
];
4977 /* Ignore trailing spaces, if we can. */
4978 if (!write_spaces_p
)
4979 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4983 current_row
->enabled_p
= 1;
4984 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4986 /* If desired line is empty, just clear the line. */
4987 if (!desired_row
->enabled_p
)
4993 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4994 nlen
= desired_row
->used
[TEXT_AREA
];
4995 nend
= nbody
+ nlen
;
4997 /* If display line has unknown contents, write the whole line. */
4998 if (must_write_whole_line_p
)
5000 /* Ignore spaces at the end, if we can. */
5001 if (!write_spaces_p
)
5002 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5005 /* Write the contents of the desired line. */
5008 cursor_to (f
, vpos
, 0);
5009 write_glyphs (f
, nbody
, nlen
);
5012 /* Don't call clear_end_of_line if we already wrote the whole
5013 line. The cursor will not be at the right margin in that
5014 case but in the line below. */
5015 if (nlen
< FRAME_TOTAL_COLS (f
))
5017 cursor_to (f
, vpos
, nlen
);
5018 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
5021 /* Make sure we are in the right row, otherwise cursor movement
5022 with cmgoto might use `ch' in the wrong row. */
5023 cursor_to (f
, vpos
, 0);
5025 make_current (desired_matrix
, current_matrix
, vpos
);
5029 /* Pretend trailing spaces are not there at all,
5030 unless for one reason or another we must write all spaces. */
5031 if (!write_spaces_p
)
5032 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
5035 /* If there's no i/d char, quickly do the best we can without it. */
5036 if (!FRAME_CHAR_INS_DEL_OK (f
))
5040 /* Find the first glyph in desired row that doesn't agree with
5041 a glyph in the current row, and write the rest from there on. */
5042 for (i
= 0; i
< nlen
; i
++)
5044 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
5046 /* Find the end of the run of different glyphs. */
5050 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
5051 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
5054 /* Output this run of non-matching chars. */
5055 cursor_to (f
, vpos
, i
);
5056 write_glyphs (f
, nbody
+ i
, j
- i
);
5059 /* Now find the next non-match. */
5063 /* Clear the rest of the line, or the non-clear part of it. */
5066 cursor_to (f
, vpos
, nlen
);
5067 clear_end_of_line (f
, olen
);
5070 /* Make current row = desired row. */
5071 make_current (desired_matrix
, current_matrix
, vpos
);
5075 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5076 characters in a row. */
5080 /* If current line is blank, skip over initial spaces, if
5081 possible, and write the rest. */
5085 nsp
= count_blanks (nbody
, nlen
);
5089 cursor_to (f
, vpos
, nsp
);
5090 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5093 /* Exchange contents between current_frame and new_frame. */
5094 make_current (desired_matrix
, current_matrix
, vpos
);
5098 /* Compute number of leading blanks in old and new contents. */
5099 osp
= count_blanks (obody
, olen
);
5100 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5102 /* Compute number of matching chars starting with first non-blank. */
5103 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5104 nbody
+ nsp
, nbody
+ nlen
);
5106 /* Spaces in new match implicit space past the end of old. */
5107 /* A bug causing this to be a no-op was fixed in 18.29. */
5108 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5111 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5115 /* Avoid doing insert/delete char
5116 just cause number of leading spaces differs
5117 when the following text does not match. */
5118 if (begmatch
== 0 && osp
!= nsp
)
5119 osp
= nsp
= min (osp
, nsp
);
5121 /* Find matching characters at end of line */
5124 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5126 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5131 endmatch
= obody
+ olen
- op1
;
5133 /* tem gets the distance to insert or delete.
5134 endmatch is how many characters we save by doing so.
5137 tem
= (nlen
- nsp
) - (olen
- osp
);
5139 && (!FRAME_CHAR_INS_DEL_OK (f
)
5140 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5143 /* nsp - osp is the distance to insert or delete.
5144 If that is nonzero, begmatch is known to be nonzero also.
5145 begmatch + endmatch is how much we save by doing the ins/del.
5149 && (!FRAME_CHAR_INS_DEL_OK (f
)
5150 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5154 osp
= nsp
= min (osp
, nsp
);
5157 /* Now go through the line, inserting, writing and
5158 deleting as appropriate. */
5162 cursor_to (f
, vpos
, nsp
);
5163 delete_glyphs (f
, osp
- nsp
);
5167 /* If going to delete chars later in line
5168 and insert earlier in the line,
5169 must delete first to avoid losing data in the insert */
5170 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5172 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5173 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5174 olen
= nlen
- (nsp
- osp
);
5176 cursor_to (f
, vpos
, osp
);
5177 insert_glyphs (f
, 0, nsp
- osp
);
5181 tem
= nsp
+ begmatch
+ endmatch
;
5182 if (nlen
!= tem
|| olen
!= tem
)
5184 if (!endmatch
|| nlen
== olen
)
5186 /* If new text being written reaches right margin, there is
5187 no need to do clear-to-eol at the end of this function
5188 (and it would not be safe, since cursor is not going to
5189 be "at the margin" after the text is done). */
5190 if (nlen
== FRAME_TOTAL_COLS (f
))
5193 /* Function write_glyphs is prepared to do nothing
5194 if passed a length <= 0. Check it here to avoid
5195 unnecessary cursor movement. */
5198 cursor_to (f
, vpos
, nsp
+ begmatch
);
5199 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5202 else if (nlen
> olen
)
5204 /* Here, we used to have the following simple code:
5205 ----------------------------------------
5206 write_glyphs (nbody + nsp + begmatch, olen - tem);
5207 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5208 ----------------------------------------
5209 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5210 is a padding glyph. */
5211 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5214 cursor_to (f
, vpos
, nsp
+ begmatch
);
5216 /* Calculate columns we can actually overwrite. */
5217 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5219 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5221 /* If we left columns to be overwritten, we must delete them. */
5222 del
= olen
- tem
- out
;
5224 delete_glyphs (f
, del
);
5226 /* At last, we insert columns not yet written out. */
5227 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5230 else if (olen
> nlen
)
5232 cursor_to (f
, vpos
, nsp
+ begmatch
);
5233 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5234 delete_glyphs (f
, olen
- nlen
);
5240 /* If any unerased characters remain after the new line, erase them. */
5243 cursor_to (f
, vpos
, nlen
);
5244 clear_end_of_line (f
, olen
);
5247 /* Exchange contents between current_frame and new_frame. */
5248 make_current (desired_matrix
, current_matrix
, vpos
);
5253 /***********************************************************************
5254 X/Y Position -> Buffer Position
5255 ***********************************************************************/
5257 /* Determine what's under window-relative pixel position (*X, *Y).
5258 Return the OBJECT (string or buffer) that's there.
5259 Return in *POS the position in that object.
5260 Adjust *X and *Y to character positions.
5261 Return in *DX and *DY the pixel coordinates of the click,
5262 relative to the top left corner of OBJECT, or relative to
5263 the top left corner of the character glyph at (*X, *Y)
5265 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5266 if the coordinates point to an empty area of the display. */
5269 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
)
5272 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5273 struct text_pos startp
;
5275 struct glyph_row
*row
;
5276 #ifdef HAVE_WINDOW_SYSTEM
5277 struct image
*img
= 0;
5280 void *itdata
= NULL
;
5282 /* We used to set current_buffer directly here, but that does the
5283 wrong thing with `face-remapping-alist' (bug#2044). */
5284 Fset_buffer (WGET (w
, buffer
));
5285 itdata
= bidi_shelve_cache ();
5286 SET_TEXT_POS_FROM_MARKER (startp
, WGET (w
, start
));
5287 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5288 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5289 start_display (&it
, w
, startp
);
5290 /* start_display takes into account the header-line row, but IT's
5291 vpos still counts from the glyph row that includes the window's
5292 start position. Adjust for a possible header-line row. */
5293 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
5297 /* First, move to the beginning of the row corresponding to *Y. We
5298 need to be in that row to get the correct value of base paragraph
5299 direction for the text at (*X, *Y). */
5300 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5302 /* TO_X is the pixel position that the iterator will compute for the
5303 glyph at *X. We add it.first_visible_x because iterator
5304 positions include the hscroll. */
5305 to_x
= x0
+ it
.first_visible_x
;
5306 if (it
.bidi_it
.paragraph_dir
== R2L
)
5307 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5308 text area. This is because the iterator, even in R2L
5309 paragraphs, delivers glyphs as if they started at the left
5310 margin of the window. (When we actually produce glyphs for
5311 display, we reverse their order in PRODUCE_GLYPHS, but the
5312 iterator doesn't know about that.) The following line adjusts
5313 the pixel position to the iterator geometry, which is what
5314 move_it_* routines use. (The -1 is because in a window whose
5315 text-area width is W, the rightmost pixel position is W-1, and
5316 it should be mirrored into zero pixel position.) */
5317 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5319 /* Now move horizontally in the row to the glyph under *X. Second
5320 argument is ZV to prevent move_it_in_display_line from matching
5321 based on buffer positions. */
5322 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5323 bidi_unshelve_cache (itdata
, 0);
5325 Fset_buffer (old_current_buffer
);
5327 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5328 *dy
= *y
- it
.current_y
;
5330 string
= WGET (w
, buffer
);
5331 if (STRINGP (it
.string
))
5334 if (it
.what
== IT_COMPOSITION
5335 && it
.cmp_it
.nchars
> 1
5336 && it
.cmp_it
.reversed_p
)
5338 /* The current display element is a grapheme cluster in a
5339 composition. In that case, we need the position of the first
5340 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5341 it.current points to the last character of the cluster, thus
5342 we must move back to the first character of the same
5344 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5345 if (STRINGP (it
.string
))
5346 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5348 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (WGET (w
, buffer
)),
5349 CHARPOS (pos
->pos
));
5352 #ifdef HAVE_WINDOW_SYSTEM
5353 if (it
.what
== IT_IMAGE
)
5355 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5356 && !NILP (img
->spec
))
5357 *object
= img
->spec
;
5361 if (it
.vpos
< w
->current_matrix
->nrows
5362 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5365 if (it
.hpos
< row
->used
[TEXT_AREA
])
5367 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5368 #ifdef HAVE_WINDOW_SYSTEM
5371 *dy
-= row
->ascent
- glyph
->ascent
;
5372 *dx
+= glyph
->slice
.img
.x
;
5373 *dy
+= glyph
->slice
.img
.y
;
5374 /* Image slices positions are still relative to the entire image */
5375 *width
= img
->width
;
5376 *height
= img
->height
;
5381 *width
= glyph
->pixel_width
;
5382 *height
= glyph
->ascent
+ glyph
->descent
;
5388 *height
= row
->height
;
5393 *width
= *height
= 0;
5396 /* Add extra (default width) columns if clicked after EOL. */
5397 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5399 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5408 /* Value is the string under window-relative coordinates X/Y in the
5409 mode line or header line (PART says which) of window W, or nil if none.
5410 *CHARPOS is set to the position in the string returned. */
5413 mode_line_string (struct window
*w
, enum window_part part
,
5414 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5415 int *dx
, int *dy
, int *width
, int *height
)
5417 struct glyph_row
*row
;
5418 struct glyph
*glyph
, *end
;
5420 Lisp_Object string
= Qnil
;
5422 if (part
== ON_MODE_LINE
)
5423 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5425 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5427 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5429 if (row
->mode_line_p
&& row
->enabled_p
)
5431 /* Find the glyph under X. If we find one with a string object,
5432 it's the one we were looking for. */
5433 glyph
= row
->glyphs
[TEXT_AREA
];
5434 end
= glyph
+ row
->used
[TEXT_AREA
];
5435 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5436 x0
-= glyph
->pixel_width
;
5437 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5440 string
= glyph
->object
;
5441 *charpos
= glyph
->charpos
;
5442 *width
= glyph
->pixel_width
;
5443 *height
= glyph
->ascent
+ glyph
->descent
;
5444 #ifdef HAVE_WINDOW_SYSTEM
5445 if (glyph
->type
== IMAGE_GLYPH
)
5448 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5450 *object
= img
->spec
;
5451 y0
-= row
->ascent
- glyph
->ascent
;
5457 /* Add extra (default width) columns if clicked after EOL. */
5458 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5460 *height
= row
->height
;
5467 *width
= *height
= 0;
5477 /* Value is the string under window-relative coordinates X/Y in either
5478 marginal area, or nil if none. *CHARPOS is set to the position in
5479 the string returned. */
5482 marginal_area_string (struct window
*w
, enum window_part part
,
5483 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5484 int *dx
, int *dy
, int *width
, int *height
)
5486 struct glyph_row
*row
= w
->current_matrix
->rows
;
5487 struct glyph
*glyph
, *end
;
5488 int x0
, y0
, i
, wy
= *y
;
5490 Lisp_Object string
= Qnil
;
5492 if (part
== ON_LEFT_MARGIN
)
5493 area
= LEFT_MARGIN_AREA
;
5494 else if (part
== ON_RIGHT_MARGIN
)
5495 area
= RIGHT_MARGIN_AREA
;
5499 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5500 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5503 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5507 /* Find the glyph under X. If we find one with a string object,
5508 it's the one we were looking for. */
5509 if (area
== RIGHT_MARGIN_AREA
)
5510 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5511 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5512 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5513 + window_box_width (w
, LEFT_MARGIN_AREA
)
5514 + window_box_width (w
, TEXT_AREA
));
5516 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5517 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5520 glyph
= row
->glyphs
[area
];
5521 end
= glyph
+ row
->used
[area
];
5522 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5523 x0
-= glyph
->pixel_width
;
5524 *x
= glyph
- row
->glyphs
[area
];
5527 string
= glyph
->object
;
5528 *charpos
= glyph
->charpos
;
5529 *width
= glyph
->pixel_width
;
5530 *height
= glyph
->ascent
+ glyph
->descent
;
5531 #ifdef HAVE_WINDOW_SYSTEM
5532 if (glyph
->type
== IMAGE_GLYPH
)
5535 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5537 *object
= img
->spec
;
5538 y0
-= row
->ascent
- glyph
->ascent
;
5539 x0
+= glyph
->slice
.img
.x
;
5540 y0
+= glyph
->slice
.img
.y
;
5546 /* Add extra (default width) columns if clicked after EOL. */
5547 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5549 *height
= row
->height
;
5556 *width
= *height
= 0;
5566 /***********************************************************************
5567 Changing Frame Sizes
5568 ***********************************************************************/
5573 window_change_signal (int signalnum
) /* If we don't have an argument, */
5574 /* some compilers complain in signal calls. */
5577 int old_errno
= errno
;
5579 struct tty_display_info
*tty
;
5581 signal (SIGWINCH
, window_change_signal
);
5582 SIGNAL_THREAD_CHECK (signalnum
);
5584 /* The frame size change obviously applies to a single
5585 termcap-controlled terminal, but we can't decide which.
5586 Therefore, we resize the frames corresponding to each tty.
5588 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5590 if (! tty
->term_initted
)
5593 /* Suspended tty frames have tty->input == NULL avoid trying to
5598 get_tty_size (fileno (tty
->input
), &width
, &height
);
5600 if (width
> 5 && height
> 2) {
5601 Lisp_Object tail
, frame
;
5603 FOR_EACH_FRAME (tail
, frame
)
5604 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5605 /* Record the new sizes, but don't reallocate the data
5606 structures now. Let that be done later outside of the
5608 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5614 #endif /* SIGWINCH */
5617 /* Do any change in frame size that was requested by a signal. SAFE
5618 non-zero means this function is called from a place where it is
5619 safe to change frame sizes while a redisplay is in progress. */
5622 do_pending_window_change (int safe
)
5624 /* If window_change_signal should have run before, run it now. */
5625 if (redisplaying_p
&& !safe
)
5628 while (delayed_size_change
)
5630 Lisp_Object tail
, frame
;
5632 delayed_size_change
= 0;
5634 FOR_EACH_FRAME (tail
, frame
)
5636 struct frame
*f
= XFRAME (frame
);
5638 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5639 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5646 /* Change the frame height and/or width. Values may be given as zero to
5647 indicate no change is to take place.
5649 If DELAY is non-zero, then assume we're being called from a signal
5650 handler, and queue the change for later - perhaps the next
5651 redisplay. Since this tries to resize windows, we can't call it
5652 from a signal handler.
5654 SAFE non-zero means this function is called from a place where it's
5655 safe to change frame sizes while a redisplay is in progress. */
5658 change_frame_size (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5660 Lisp_Object tail
, frame
;
5662 if (FRAME_MSDOS_P (f
))
5664 /* On MS-DOS, all frames use the same screen, so a change in
5665 size affects all frames. Termcap now supports multiple
5667 FOR_EACH_FRAME (tail
, frame
)
5668 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5669 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5670 pretend
, delay
, safe
);
5673 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5677 change_frame_size_1 (register struct frame
*f
, int newheight
, int newwidth
, int pretend
, int delay
, int safe
)
5679 int new_frame_total_cols
;
5680 ptrdiff_t count
= SPECPDL_INDEX ();
5682 /* If we can't deal with the change now, queue it for later. */
5683 if (delay
|| (redisplaying_p
&& !safe
))
5685 f
->new_text_lines
= newheight
;
5686 f
->new_text_cols
= newwidth
;
5687 delayed_size_change
= 1;
5691 /* This size-change overrides any pending one for this frame. */
5692 f
->new_text_lines
= 0;
5693 f
->new_text_cols
= 0;
5695 /* If an argument is zero, set it to the current value. */
5697 newheight
= FRAME_LINES (f
);
5699 newwidth
= FRAME_COLS (f
);
5701 /* Compute width of windows in F. */
5702 /* Round up to the smallest acceptable size. */
5703 check_frame_size (f
, &newheight
, &newwidth
);
5705 /* This is the width of the frame with vertical scroll bars and fringe
5706 columns. Do this after rounding - see discussion of bug#9723. */
5707 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5709 /* If we're not changing the frame size, quit now. */
5710 /* Frame width may be unchanged but the text portion may change, for
5711 example, fullscreen and remove/add scroll bar. */
5712 if (newheight
== FRAME_LINES (f
)
5713 /* Text portion unchanged? */
5714 && newwidth
== FRAME_COLS (f
)
5715 /* Frame width unchanged? */
5716 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5722 /* We only can set screen dimensions to certain values supported
5723 by our video hardware. Try to find the smallest size greater
5724 or equal to the requested dimensions. */
5725 dos_set_window_size (&newheight
, &newwidth
);
5728 if (newheight
!= FRAME_LINES (f
))
5730 resize_frame_windows (f
, newheight
, 0);
5732 /* MSDOS frames cannot PRETEND, as they change frame size by
5733 manipulating video hardware. */
5734 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5735 FrameRows (FRAME_TTY (f
)) = newheight
;
5738 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5740 resize_frame_windows (f
, new_frame_total_cols
, 1);
5742 /* MSDOS frames cannot PRETEND, as they change frame size by
5743 manipulating video hardware. */
5744 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5745 FrameCols (FRAME_TTY (f
)) = newwidth
;
5747 if (WINDOWP (f
->tool_bar_window
))
5748 WSET (XWINDOW (f
->tool_bar_window
),
5749 total_cols
, make_number (newwidth
));
5752 FRAME_LINES (f
) = newheight
;
5753 SET_FRAME_COLS (f
, newwidth
);
5756 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5757 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5759 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5761 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5762 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5763 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5764 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5768 calculate_costs (f
);
5769 SET_FRAME_GARBAGED (f
);
5774 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
5776 run_window_configuration_change_hook (f
);
5778 unbind_to (count
, Qnil
);
5783 /***********************************************************************
5784 Terminal Related Lisp Functions
5785 ***********************************************************************/
5787 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5788 1, 1, "FOpen termscript file: ",
5789 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5790 FILE = nil means just close any termscript file currently open. */)
5793 struct tty_display_info
*tty
;
5795 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5796 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5797 error ("Current frame is not on a tty device");
5801 if (tty
->termscript
!= 0)
5804 fclose (tty
->termscript
);
5807 tty
->termscript
= 0;
5811 file
= Fexpand_file_name (file
, Qnil
);
5812 tty
->termscript
= fopen (SSDATA (file
), "w");
5813 if (tty
->termscript
== 0)
5814 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5820 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5821 Ssend_string_to_terminal
, 1, 2, 0,
5822 doc
: /* Send STRING to the terminal without alteration.
5823 Control characters in STRING will have terminal-dependent effects.
5825 Optional parameter TERMINAL specifies the tty terminal device to use.
5826 It may be a terminal object, a frame, or nil for the terminal used by
5827 the currently selected frame. In batch mode, STRING is sent to stdout
5828 when TERMINAL is nil. */)
5829 (Lisp_Object string
, Lisp_Object terminal
)
5831 struct terminal
*t
= get_terminal (terminal
, 1);
5834 /* ??? Perhaps we should do something special for multibyte strings here. */
5835 CHECK_STRING (string
);
5839 error ("Unknown terminal device");
5841 if (t
->type
== output_initial
)
5843 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5844 error ("Device %d is not a termcap terminal device", t
->id
);
5847 struct tty_display_info
*tty
= t
->display_info
.tty
;
5850 error ("Terminal is currently suspended");
5852 if (tty
->termscript
)
5854 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5855 fflush (tty
->termscript
);
5859 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5866 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5867 doc
: /* Beep, or flash the screen.
5868 Also, unless an argument is given,
5869 terminate any keyboard macro currently executing. */)
5877 ring_bell (XFRAME (selected_frame
));
5886 bitch_at_user (void)
5890 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5891 error ("Keyboard macro terminated by a command ringing the bell");
5893 ring_bell (XFRAME (selected_frame
));
5898 /***********************************************************************
5900 ***********************************************************************/
5902 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5903 doc
: /* Pause, without updating display, for SECONDS seconds.
5904 SECONDS may be a floating-point value, meaning that you can wait for a
5905 fraction of a second. Optional second arg MILLISECONDS specifies an
5906 additional wait period, in milliseconds; this is for backwards compatibility.
5907 \(Not all operating systems support waiting for a fraction of a second.) */)
5908 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5910 double duration
= extract_float (seconds
);
5912 if (!NILP (milliseconds
))
5914 CHECK_NUMBER (milliseconds
);
5915 duration
+= XINT (milliseconds
) / 1000.0;
5920 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (duration
);
5921 wait_reading_process_output (min (EMACS_SECS (t
), WAIT_READING_MAX
),
5922 EMACS_NSECS (t
), 0, 0, Qnil
, NULL
, 0);
5929 /* This is just like wait_reading_process_output, except that
5932 TIMEOUT is number of seconds to wait (float or integer),
5933 or t to wait forever.
5934 READING is 1 if reading input.
5935 If DO_DISPLAY is >0 display process output while waiting.
5936 If DO_DISPLAY is >1 perform an initial redisplay before waiting.
5940 sit_for (Lisp_Object timeout
, int reading
, int do_display
)
5945 swallow_events (do_display
);
5947 if ((detect_input_pending_run_timers (do_display
))
5948 || !NILP (Vexecuting_kbd_macro
))
5951 if (do_display
>= 2)
5952 redisplay_preserve_echo_area (2);
5954 if (INTEGERP (timeout
))
5956 sec
= XINT (timeout
);
5961 else if (FLOATP (timeout
))
5963 double seconds
= XFLOAT_DATA (timeout
);
5964 if (! (0 < seconds
))
5968 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (seconds
);
5969 sec
= min (EMACS_SECS (t
), WAIT_READING_MAX
);
5970 nsec
= EMACS_NSECS (t
);
5973 else if (EQ (timeout
, Qt
))
5979 wrong_type_argument (Qnumberp
, timeout
);
5986 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5989 return detect_input_pending () ? Qnil
: Qt
;
5993 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5994 doc
: /* Perform redisplay.
5995 Optional arg FORCE, if non-nil, prevents redisplay from being
5996 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5997 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5998 preempted by arriving input, so FORCE does nothing.
6000 Return t if redisplay was performed, nil if redisplay was preempted
6001 immediately by pending input. */)
6007 if ((detect_input_pending_run_timers (1)
6008 && NILP (force
) && !redisplay_dont_pause
)
6009 || !NILP (Vexecuting_kbd_macro
))
6012 count
= SPECPDL_INDEX ();
6013 if (!NILP (force
) && !redisplay_dont_pause
)
6014 specbind (Qredisplay_dont_pause
, Qt
);
6015 redisplay_preserve_echo_area (2);
6016 unbind_to (count
, Qnil
);
6022 /***********************************************************************
6023 Other Lisp Functions
6024 ***********************************************************************/
6026 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
6027 session's frames, frame names, buffers, buffer-read-only flags, and
6028 buffer-modified-flags. */
6030 static Lisp_Object frame_and_buffer_state
;
6033 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
6034 Sframe_or_buffer_changed_p
, 0, 1, 0,
6035 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
6036 VARIABLE is a variable name whose value is either nil or a state vector
6037 that will be updated to contain all frames and buffers,
6038 aside from buffers whose names start with space,
6039 along with the buffers' read-only and modified flags. This allows a fast
6040 check to see whether buffer menus might need to be recomputed.
6041 If this function returns non-nil, it updates the internal vector to reflect
6044 If VARIABLE is nil, an internal variable is used. Users should not
6045 pass nil for VARIABLE. */)
6046 (Lisp_Object variable
)
6048 Lisp_Object state
, tail
, frame
, buf
;
6049 Lisp_Object
*vecp
, *end
;
6052 if (! NILP (variable
))
6054 CHECK_SYMBOL (variable
);
6055 state
= Fsymbol_value (variable
);
6056 if (! VECTORP (state
))
6060 state
= frame_and_buffer_state
;
6062 vecp
= XVECTOR (state
)->contents
;
6063 end
= vecp
+ ASIZE (state
);
6065 FOR_EACH_FRAME (tail
, frame
)
6069 if (!EQ (*vecp
++, frame
))
6073 if (!EQ (*vecp
++, XFRAME (frame
)->name
))
6076 /* Check that the buffer info matches. */
6077 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6079 buf
= XCDR (XCAR (tail
));
6080 /* Ignore buffers that aren't included in buffer lists. */
6081 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6085 if (!EQ (*vecp
++, buf
))
6089 if (!EQ (*vecp
++, BVAR (XBUFFER (buf
), read_only
)))
6093 if (!EQ (*vecp
++, Fbuffer_modified_p (buf
)))
6098 /* Detect deletion of a buffer at the end of the list. */
6099 if (EQ (*vecp
, Qlambda
))
6102 /* Come here if we decide the data has changed. */
6104 /* Count the size we will need.
6105 Start with 1 so there is room for at least one lambda at the end. */
6107 FOR_EACH_FRAME (tail
, frame
)
6109 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6111 /* Reallocate the vector if data has grown to need it,
6112 or if it has shrunk a lot. */
6113 if (! VECTORP (state
)
6114 || n
> ASIZE (state
)
6115 || n
+ 20 < ASIZE (state
) / 2)
6116 /* Add 20 extra so we grow it less often. */
6118 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6119 if (! NILP (variable
))
6120 Fset (variable
, state
);
6122 frame_and_buffer_state
= state
;
6125 /* Record the new data in the (possibly reallocated) vector. */
6126 vecp
= XVECTOR (state
)->contents
;
6127 FOR_EACH_FRAME (tail
, frame
)
6130 *vecp
++ = XFRAME (frame
)->name
;
6132 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6134 buf
= XCDR (XCAR (tail
));
6135 /* Ignore buffers that aren't included in buffer lists. */
6136 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6139 *vecp
++ = BVAR (XBUFFER (buf
), read_only
);
6140 *vecp
++ = Fbuffer_modified_p (buf
);
6142 /* Fill up the vector with lambdas (always at least one). */
6144 while (vecp
- XVECTOR (state
)->contents
6147 /* Make sure we didn't overflow the vector. */
6148 if (vecp
- XVECTOR (state
)->contents
6156 /***********************************************************************
6158 ***********************************************************************/
6160 /* Initialization done when Emacs fork is started, before doing stty.
6161 Determine terminal type and set terminal_driver. Then invoke its
6162 decoding routine to set up variables in the terminal package. */
6167 char *terminal_type
;
6169 /* Construct the space glyph. */
6170 space_glyph
.type
= CHAR_GLYPH
;
6171 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6172 space_glyph
.charpos
= -1;
6175 cursor_in_echo_area
= 0;
6176 terminal_type
= (char *) 0;
6178 /* Now is the time to initialize this; it's used by init_sys_modes
6180 Vinitial_window_system
= Qnil
;
6182 /* SIGWINCH needs to be handled no matter what display we start
6183 with. Otherwise newly opened tty frames will not resize
6188 #endif /* CANNOT_DUMP */
6189 signal (SIGWINCH
, window_change_signal
);
6190 #endif /* SIGWINCH */
6192 /* If running as a daemon, no need to initialize any frames/terminal. */
6196 /* If the user wants to use a window system, we shouldn't bother
6197 initializing the terminal. This is especially important when the
6198 terminal is so dumb that emacs gives up before and doesn't bother
6199 using the window system.
6201 If the DISPLAY environment variable is set and nonempty,
6202 try to use X, and die with an error message if that doesn't work. */
6204 #ifdef HAVE_X_WINDOWS
6205 if (! inhibit_window_system
&& ! display_arg
)
6208 display
= getenv ("DISPLAY");
6209 display_arg
= (display
!= 0 && *display
!= 0);
6211 if (display_arg
&& !x_display_ok (display
))
6213 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6215 inhibit_window_system
= 1;
6219 if (!inhibit_window_system
&& display_arg
)
6221 Vinitial_window_system
= Qx
;
6223 Vwindow_system_version
= make_number (11);
6226 /* In some versions of ncurses,
6227 tputs crashes if we have not called tgetent.
6229 { char b
[2044]; tgetent (b
, "xterm");}
6231 adjust_frame_glyphs_initially ();
6234 #endif /* HAVE_X_WINDOWS */
6237 if (!inhibit_window_system
)
6239 Vinitial_window_system
= Qw32
;
6240 Vwindow_system_version
= make_number (1);
6241 adjust_frame_glyphs_initially ();
6244 #endif /* HAVE_NTGUI */
6247 if (!inhibit_window_system
6253 Vinitial_window_system
= Qns
;
6254 Vwindow_system_version
= make_number (10);
6255 adjust_frame_glyphs_initially ();
6260 /* If no window system has been specified, try to use the terminal. */
6263 fatal ("standard input is not a tty");
6268 terminal_type
= "w32console";
6270 /* Look at the TERM variable. */
6271 terminal_type
= (char *) getenv ("TERM");
6275 #ifdef HAVE_WINDOW_SYSTEM
6276 if (! inhibit_window_system
)
6277 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6279 #endif /* HAVE_WINDOW_SYSTEM */
6280 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6286 struct frame
*f
= XFRAME (selected_frame
);
6288 /* Open a display on the controlling tty. */
6289 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6291 /* Convert the initial frame to use the new display. */
6292 if (f
->output_method
!= output_initial
)
6294 f
->output_method
= t
->type
;
6297 t
->reference_count
++;
6299 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6301 if (f
->output_method
== output_termcap
)
6302 create_tty_output (f
);
6304 t
->display_info
.tty
->top_frame
= selected_frame
;
6305 change_frame_size (XFRAME (selected_frame
),
6306 FrameRows (t
->display_info
.tty
),
6307 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6309 /* Delete the initial terminal. */
6310 if (--initial_terminal
->reference_count
== 0
6311 && initial_terminal
->delete_terminal_hook
)
6312 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6314 /* Update frame parameters to reflect the new type. */
6315 Fmodify_frame_parameters
6316 (selected_frame
, Fcons (Fcons (Qtty_type
,
6317 Ftty_type (selected_frame
)), Qnil
));
6318 if (t
->display_info
.tty
->name
)
6319 Fmodify_frame_parameters (selected_frame
,
6320 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6323 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6328 struct frame
*sf
= SELECTED_FRAME ();
6329 int width
= FRAME_TOTAL_COLS (sf
);
6330 int height
= FRAME_LINES (sf
);
6332 /* If these sizes are so big they cause overflow, just ignore the
6333 change. It's not clear what better we could do. The rest of
6334 the code assumes that (width + 2) * height * sizeof (struct glyph)
6335 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6336 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6337 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6338 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6339 < (width
+ 2) * height
))
6340 fatal ("screen size %dx%d too big", width
, height
);
6343 adjust_frame_glyphs_initially ();
6344 calculate_costs (XFRAME (selected_frame
));
6346 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6349 && NILP (Vinitial_window_system
))
6351 /* For the initial frame, we don't have any way of knowing what
6352 are the foreground and background colors of the terminal. */
6353 struct frame
*sf
= SELECTED_FRAME ();
6355 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6356 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6357 call0 (intern ("tty-set-up-initial-frame-faces"));
6363 /***********************************************************************
6365 ***********************************************************************/
6367 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6368 Sinternal_show_cursor
, 2, 2, 0,
6369 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6370 WINDOW nil means use the selected window. SHOW non-nil means
6371 show a cursor in WINDOW in the next redisplay. SHOW nil means
6372 don't show a cursor. */)
6373 (Lisp_Object window
, Lisp_Object show
)
6375 /* Don't change cursor state while redisplaying. This could confuse
6377 if (!redisplaying_p
)
6380 window
= selected_window
;
6382 CHECK_WINDOW (window
);
6384 XWINDOW (window
)->cursor_off_p
= NILP (show
);
6391 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6392 Sinternal_show_cursor_p
, 0, 1, 0,
6393 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6394 WINDOW nil or omitted means report on the selected window. */)
6395 (Lisp_Object window
)
6400 window
= selected_window
;
6402 CHECK_WINDOW (window
);
6404 w
= XWINDOW (window
);
6405 return w
->cursor_off_p
? Qnil
: Qt
;
6408 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6409 Slast_nonminibuf_frame
, 0, 0, 0,
6410 doc
: /* Value is last nonminibuffer frame. */)
6413 Lisp_Object frame
= Qnil
;
6415 if (last_nonminibuf_frame
)
6416 XSETFRAME (frame
, last_nonminibuf_frame
);
6421 /***********************************************************************
6423 ***********************************************************************/
6426 syms_of_display (void)
6428 defsubr (&Sredraw_frame
);
6429 defsubr (&Sredraw_display
);
6430 defsubr (&Sframe_or_buffer_changed_p
);
6431 defsubr (&Sopen_termscript
);
6433 defsubr (&Sredisplay
);
6434 defsubr (&Ssleep_for
);
6435 defsubr (&Ssend_string_to_terminal
);
6436 defsubr (&Sinternal_show_cursor
);
6437 defsubr (&Sinternal_show_cursor_p
);
6438 defsubr (&Slast_nonminibuf_frame
);
6441 defsubr (&Sdump_redisplay_history
);
6444 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6445 staticpro (&frame_and_buffer_state
);
6447 DEFSYM (Qdisplay_table
, "display-table");
6448 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6450 DEFVAR_INT ("baud-rate", baud_rate
,
6451 doc
: /* The output baud rate of the terminal.
6452 On most systems, changing this value will affect the amount of padding
6453 and the other strategic decisions made during redisplay. */);
6455 DEFVAR_BOOL ("inverse-video", inverse_video
,
6456 doc
: /* Non-nil means invert the entire frame display.
6457 This means everything is in inverse video which otherwise would not be. */);
6459 DEFVAR_BOOL ("visible-bell", visible_bell
,
6460 doc
: /* Non-nil means try to flash the frame to represent a bell.
6462 See also `ring-bell-function'. */);
6464 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6465 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6466 A non-nil value is useful if the terminal can automatically preserve
6467 Emacs's frame display when you reenter Emacs.
6468 It is up to you to set this variable if your terminal can do that. */);
6470 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6471 doc
: /* Name of the window system that Emacs uses for the first frame.
6472 The value is a symbol:
6473 nil for a termcap frame (a character-only terminal),
6474 'x' for an Emacs frame that is really an X window,
6475 'w32' for an Emacs frame that is a window on MS-Windows display,
6476 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6477 'pc' for a direct-write MS-DOS frame.
6479 Use of this variable as a boolean is deprecated. Instead,
6480 use `display-graphic-p' or any of the other `display-*-p'
6481 predicates which report frame's specific UI-related capabilities. */);
6483 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6484 doc
: /* Name of window system through which the selected frame is displayed.
6485 The value is a symbol:
6486 nil for a termcap frame (a character-only terminal),
6487 'x' for an Emacs frame that is really an X window,
6488 'w32' for an Emacs frame that is a window on MS-Windows display,
6489 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6490 'pc' for a direct-write MS-DOS frame.
6492 Use of this variable as a boolean is deprecated. Instead,
6493 use `display-graphic-p' or any of the other `display-*-p'
6494 predicates which report frame's specific UI-related capabilities. */);
6496 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6497 doc
: /* The version number of the window system in use.
6498 For X windows, this is 11. */);
6500 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6501 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6503 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6504 doc
: /* Table defining how to output a glyph code to the frame.
6505 If not nil, this is a vector indexed by glyph code to define the glyph.
6506 Each element can be:
6507 integer: a glyph code which this glyph is an alias for.
6508 string: output this glyph using that string (not impl. in X windows).
6509 nil: this glyph mod 524288 is the code of a character to output,
6510 and this glyph / 524288 is the face number (see `face-id') to use
6511 while outputting it. */);
6512 Vglyph_table
= Qnil
;
6514 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6515 doc
: /* Display table to use for buffers that specify none.
6516 See `buffer-display-table' for more information. */);
6517 Vstandard_display_table
= Qnil
;
6519 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6520 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6521 redisplay_dont_pause
= 1;
6523 #if PERIODIC_PREEMPTION_CHECKING
6524 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6525 doc
: /* Period in seconds between checking for input during redisplay.
6526 This has an effect only if `redisplay-dont-pause' is nil; in that
6527 case, arriving input preempts redisplay until the input is processed.
6528 If the value is nil, redisplay is never preempted. */);
6529 Vredisplay_preemption_period
= make_float (0.10);
6536 Vinitial_window_system
= Qnil
;
6537 Vwindow_system_version
= Qnil
;