1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2018 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
28 #include "ptr-bounds.h"
30 /* cm.h must come after dispextern.h on Windows. */
31 #include "dispextern.h"
36 #include "termhooks.h"
40 #include "blockinput.h"
41 #include "syssignal.h"
46 #ifdef HAVE_WINDOW_SYSTEM
48 #endif /* HAVE_WINDOW_SYSTEM */
58 /* Structure to pass dimensions around. Used for character bounding
59 boxes, glyph matrix dimensions and alike. */
68 /* Function prototypes. */
70 static void update_frame_line (struct frame
*, int, bool);
71 static int required_matrix_height (struct window
*);
72 static int required_matrix_width (struct window
*);
73 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
74 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
76 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
78 static void adjust_decode_mode_spec_buffer (struct frame
*);
79 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
80 static void clear_window_matrices (struct window
*, bool);
81 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
82 static int scrolling_window (struct window
*, bool);
83 static bool update_window_line (struct window
*, int, bool *);
84 static void mirror_make_current (struct window
*, int);
86 static void check_matrix_pointers (struct glyph_matrix
*,
87 struct glyph_matrix
*);
89 static void mirror_line_dance (struct window
*, int, int, int *, char *);
90 static bool update_window_tree (struct window
*, bool);
91 static bool update_window (struct window
*, bool);
92 static bool update_frame_1 (struct frame
*, bool, bool, bool, bool);
93 static bool scrolling (struct frame
*);
94 static void set_window_cursor_after_update (struct window
*);
95 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
96 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
97 static void set_window_update_flags (struct window
*w
, bool on_p
);
99 /* True means last display completed. False means it was preempted. */
101 bool display_completed
;
103 /* True means SIGWINCH happened when not safe. */
105 static bool delayed_size_change
;
107 /* A glyph for a space. */
109 struct glyph space_glyph
;
111 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
113 /* Counts of allocated structures. These counts serve to diagnose
114 memory leaks and double frees. */
116 static int glyph_matrix_count
;
117 static int glyph_pool_count
;
119 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
121 /* If non-null, the frame whose frame matrices are manipulated. If
122 null, window matrices are worked on. */
124 static struct frame
*frame_matrix_frame
;
126 /* Convert vpos and hpos from frame to window and vice versa.
127 This may only be used for terminal frames. */
131 static int window_to_frame_vpos (struct window
*, int);
132 static int window_to_frame_hpos (struct window
*, int);
133 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
134 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
136 /* One element of the ring buffer containing redisplay history
139 struct redisplay_history
141 char trace
[512 + 100];
144 /* The size of the history buffer. */
146 #define REDISPLAY_HISTORY_SIZE 30
148 /* The redisplay history buffer. */
150 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
152 /* Next free entry in redisplay_history. */
154 static int history_idx
;
156 /* A tick that's incremented each time something is added to the
159 static uprintmax_t history_tick
;
161 /* Add to the redisplay history how window W has been displayed.
162 MSG is a trace containing the information how W's glyph matrix
163 has been constructed. PAUSED_P means that the update
164 has been interrupted for pending input. */
167 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
172 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
174 buf
= redisplay_history
[history_idx
].trace
;
177 snprintf (buf
, sizeof redisplay_history
[0].trace
,
178 "%"pMu
": window %p (%s)%s\n%s",
181 ((BUFFERP (w
->contents
)
182 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
183 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
185 paused_p
? " ***paused***" : "",
190 /* Add to the redisplay history that frame F has been displayed.
191 PAUSED_P means that the update has been interrupted for
195 add_frame_display_history (struct frame
*f
, bool paused_p
)
200 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
202 buf
= redisplay_history
[history_idx
].trace
;
205 sprintf (buf
, "%"pMu
": update frame %p%s",
207 ptr
, paused_p
? " ***paused***" : "");
211 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
212 Sdump_redisplay_history
, 0, 0, "",
213 doc
: /* Dump redisplay history to stderr. */)
218 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
221 i
= REDISPLAY_HISTORY_SIZE
- 1;
222 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
229 #else /* not GLYPH_DEBUG */
231 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
232 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
234 #endif /* GLYPH_DEBUG */
237 #if defined PROFILING && !HAVE___EXECUTABLE_START
238 /* This function comes first in the Emacs executable and is used only
239 to estimate the text start for profiling. */
241 __executable_start (void)
247 /***********************************************************************
249 ***********************************************************************/
251 /* Allocate and return a glyph_matrix structure. POOL is the glyph
252 pool from which memory for the matrix should be allocated, or null
253 for window-based redisplay where no glyph pools are used. The
254 member `pool' of the glyph matrix structure returned is set to
255 POOL, the structure is otherwise zeroed. */
257 static struct glyph_matrix
*
258 new_glyph_matrix (struct glyph_pool
*pool
)
260 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
262 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
263 /* Increment number of allocated matrices. This count is used
264 to detect memory leaks. */
265 ++glyph_matrix_count
;
268 /* Set pool and return. */
274 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
276 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
277 glyph_matrix_count is decremented when a matrix is freed. If the count
278 gets negative, more structures were freed than allocated, i.e. one matrix
279 was freed more than once or a bogus pointer was passed to this function.
281 If MATRIX->pool is null, this means that the matrix manages its own
282 glyph memory---this is done for matrices on X frames. Freeing the
283 matrix also frees the glyph memory in this case. */
286 free_glyph_matrix (struct glyph_matrix
*matrix
)
292 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
293 /* Detect the case that more matrices are freed than were
295 --glyph_matrix_count
;
296 eassert (glyph_matrix_count
>= 0);
299 /* Free glyph memory if MATRIX owns it. */
300 if (matrix
->pool
== NULL
)
301 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
302 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
304 /* Free row structures and the matrix itself. */
305 xfree (matrix
->rows
);
311 /* Return the number of glyphs to reserve for a marginal area of
312 window W. TOTAL_GLYPHS is the number of glyphs in a complete
313 display line of window W. MARGIN gives the width of the marginal
314 area in canonical character units. */
317 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
321 int width
= w
->total_cols
;
322 double d
= max (0, margin
);
323 d
= min (width
/ 2 - 1, d
);
324 /* Since MARGIN is positive, we cannot possibly have less than
325 one glyph for the marginal area. */
326 return max (1, (int) ((double) total_glyphs
/ width
* d
));
331 /* Return true if ROW's hash value is correct.
332 Optimized away if ENABLE_CHECKING is not defined. */
335 verify_row_hash (struct glyph_row
*row
)
337 return row
->hash
== row_hash (row
);
340 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
343 W is null if the function is called for a frame glyph matrix.
344 Otherwise it is the window MATRIX is a member of. X and Y are the
345 indices of the first column and row of MATRIX within the frame
346 matrix, if such a matrix exists. They are zero for purely
347 window-based redisplay. DIM is the needed size of the matrix.
349 In window-based redisplay, where no frame matrices exist, glyph
350 matrices manage their own glyph storage. Otherwise, they allocate
351 storage from a common frame glyph pool which can be found in
354 The reason for this memory management strategy is to avoid complete
355 frame redraws if possible. When we allocate from a common pool, a
356 change of the location or size of a sub-matrix within the pool
357 requires a complete redisplay of the frame because we cannot easily
358 make sure that the current matrices of all windows still agree with
359 what is displayed on the screen. While this is usually fast, it
360 leads to screen flickering. */
363 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
367 bool marginal_areas_changed_p
= 0;
368 bool header_line_changed_p
= 0;
369 bool header_line_p
= 0;
370 int left
= -1, right
= -1;
371 int window_width
= -1, window_height
= -1;
373 /* See if W had a header line that has disappeared now, or vice versa.
377 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
379 header_line_p
= window_wants_header_line (w
);
380 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
382 matrix
->header_line_p
= header_line_p
;
384 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
385 Do nothing if MATRIX' size, position, vscroll, and marginal areas
386 haven't changed. This optimization is important because preserving
387 the matrix means preventing redisplay. */
388 eassume (w
!= NULL
|| matrix
->pool
!= NULL
);
389 if (matrix
->pool
== NULL
)
391 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
392 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
393 eassert (left
>= 0 && right
>= 0);
394 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
395 || right
!= matrix
->right_margin_glyphs
);
397 if (!marginal_areas_changed_p
398 && !XFRAME (w
->frame
)->fonts_changed
399 && !header_line_changed_p
400 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
401 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
402 && matrix
->window_height
== window_height
403 && matrix
->window_vscroll
== w
->vscroll
404 && matrix
->window_width
== window_width
)
408 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
409 if (matrix
->rows_allocated
< dim
.height
)
411 int old_alloc
= matrix
->rows_allocated
;
412 new_rows
= dim
.height
- matrix
->rows_allocated
;
413 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
414 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
415 memset (matrix
->rows
+ old_alloc
, 0,
416 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
421 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
422 on a frame not using window-based redisplay. Set up pointers for
423 each row into the glyph pool. */
426 eassert (matrix
->pool
->glyphs
);
430 left
= margin_glyphs_to_reserve (w
, dim
.width
,
431 w
->left_margin_cols
);
432 right
= margin_glyphs_to_reserve (w
, dim
.width
,
433 w
->right_margin_cols
);
438 for (i
= 0; i
< dim
.height
; ++i
)
440 struct glyph_row
*row
= &matrix
->rows
[i
];
442 row
->glyphs
[LEFT_MARGIN_AREA
]
443 = (matrix
->pool
->glyphs
444 + (y
+ i
) * matrix
->pool
->ncolumns
448 || (row
== matrix
->rows
+ dim
.height
- 1
449 && window_wants_mode_line (w
))
450 || (row
== matrix
->rows
&& matrix
->header_line_p
))
452 row
->glyphs
[TEXT_AREA
]
453 = row
->glyphs
[LEFT_MARGIN_AREA
];
454 row
->glyphs
[RIGHT_MARGIN_AREA
]
455 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
456 row
->glyphs
[LAST_AREA
]
457 = row
->glyphs
[RIGHT_MARGIN_AREA
];
461 row
->glyphs
[TEXT_AREA
]
462 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
463 row
->glyphs
[RIGHT_MARGIN_AREA
]
464 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
465 row
->glyphs
[LAST_AREA
]
466 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
470 matrix
->left_margin_glyphs
= left
;
471 matrix
->right_margin_glyphs
= right
;
475 /* If MATRIX->pool is null, MATRIX is responsible for managing
476 its own memory. It is a window matrix for window-based redisplay.
477 Allocate glyph memory from the heap. */
478 if (dim
.width
> matrix
->matrix_w
480 || header_line_changed_p
481 || marginal_areas_changed_p
)
483 struct glyph_row
*row
= matrix
->rows
;
484 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
488 row
->glyphs
[LEFT_MARGIN_AREA
]
489 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
490 dim
.width
, sizeof (struct glyph
));
492 /* The mode line, if displayed, never has marginal areas. */
493 if ((row
== matrix
->rows
+ dim
.height
- 1
494 && !(w
&& window_wants_mode_line (w
)))
495 || (row
== matrix
->rows
&& matrix
->header_line_p
))
497 row
->glyphs
[TEXT_AREA
]
498 = row
->glyphs
[LEFT_MARGIN_AREA
];
499 row
->glyphs
[RIGHT_MARGIN_AREA
]
500 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
501 row
->glyphs
[LAST_AREA
]
502 = row
->glyphs
[RIGHT_MARGIN_AREA
];
506 row
->glyphs
[TEXT_AREA
]
507 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
508 row
->glyphs
[RIGHT_MARGIN_AREA
]
509 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
510 row
->glyphs
[LAST_AREA
]
511 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
517 eassert (left
>= 0 && right
>= 0);
518 matrix
->left_margin_glyphs
= left
;
519 matrix
->right_margin_glyphs
= right
;
522 /* Number of rows to be used by MATRIX. */
523 matrix
->nrows
= dim
.height
;
524 eassert (matrix
->nrows
>= 0);
528 if (matrix
== w
->current_matrix
)
530 /* Mark rows in a current matrix of a window as not having
531 valid contents. It's important to not do this for
532 desired matrices. When Emacs starts, it may already be
533 building desired matrices when this function runs. */
534 if (window_width
< 0)
535 window_width
= window_box_width (w
, -1);
537 /* Optimize the case that only the height has changed (C-x 2,
538 upper window). Invalidate all rows that are no longer part
540 if (!marginal_areas_changed_p
541 && !header_line_changed_p
543 && dim
.width
== matrix
->matrix_w
544 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
545 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
546 && matrix
->window_width
== window_width
)
548 /* Find the last row in the window. */
549 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
550 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
556 /* Window end is invalid, if inside of the rows that
557 are invalidated below. */
558 if (w
->window_end_vpos
>= i
)
559 w
->window_end_valid
= 0;
561 while (i
< matrix
->nrows
)
562 matrix
->rows
[i
++].enabled_p
= false;
566 for (i
= 0; i
< matrix
->nrows
; ++i
)
567 matrix
->rows
[i
].enabled_p
= false;
569 /* We've disabled the mode-line row, so force redrawing of
570 the mode line, if any, since otherwise it will remain
571 disabled in the current matrix, and expose events won't
573 if (window_wants_mode_line (w
))
574 w
->update_mode_line
= 1;
576 else if (matrix
== w
->desired_matrix
)
578 /* Rows in desired matrices always have to be cleared;
579 redisplay expects this is the case when it runs, so it
580 had better be the case when we adjust matrices between
582 for (i
= 0; i
< matrix
->nrows
; ++i
)
583 matrix
->rows
[i
].enabled_p
= false;
588 /* Remember last values to be able to optimize frame redraws. */
589 matrix
->matrix_x
= x
;
590 matrix
->matrix_y
= y
;
591 matrix
->matrix_w
= dim
.width
;
592 matrix
->matrix_h
= dim
.height
;
594 /* Record the top y location and height of W at the time the matrix
595 was last adjusted. This is used to optimize redisplay above. */
598 matrix
->window_pixel_left
= WINDOW_LEFT_PIXEL_EDGE (w
);
599 matrix
->window_pixel_top
= WINDOW_TOP_PIXEL_EDGE (w
);
600 matrix
->window_height
= window_height
;
601 matrix
->window_width
= window_width
;
602 matrix
->window_vscroll
= w
->vscroll
;
607 /* Reverse the contents of rows in MATRIX between START and END. The
608 contents of the row at END - 1 end up at START, END - 2 at START +
609 1 etc. This is part of the implementation of rotate_matrix (see
613 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
617 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
619 /* Non-ISO HP/UX compiler doesn't like auto struct
621 struct glyph_row temp
;
622 temp
= matrix
->rows
[i
];
623 matrix
->rows
[i
] = matrix
->rows
[j
];
624 matrix
->rows
[j
] = temp
;
629 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
630 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
631 indices. (Note: this does not copy glyphs, only glyph pointers in
632 row structures are moved around).
634 The algorithm used for rotating the vector was, I believe, first
635 described by Kernighan. See the vector R as consisting of two
636 sub-vectors AB, where A has length BY for BY >= 0. The result
637 after rotating is then BA. Reverse both sub-vectors to get ArBr
638 and reverse the result to get (ArBr)r which is BA. Similar for
642 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
646 /* Up (rotate left, i.e. towards lower indices). */
648 reverse_rows (matrix
, first
, first
+ by
);
649 reverse_rows (matrix
, first
+ by
, last
);
650 reverse_rows (matrix
, first
, last
);
654 /* Down (rotate right, i.e. towards higher indices). */
655 reverse_rows (matrix
, last
- by
, last
);
656 reverse_rows (matrix
, first
, last
- by
);
657 reverse_rows (matrix
, first
, last
);
662 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
663 with indices START <= index < END. Increment positions by DELTA/
667 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
668 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
670 /* Check that START and END are reasonable values. */
671 eassert (start
>= 0 && start
<= matrix
->nrows
);
672 eassert (end
>= 0 && end
<= matrix
->nrows
);
673 eassert (start
<= end
);
675 for (; start
< end
; ++start
)
676 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
680 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
681 START and END are the row indices of the first and last + 1 row to clear. */
684 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
686 eassert (start
<= end
);
687 eassert (start
>= 0 && (start
< matrix
->nrows
688 /* matrix->nrows can be 0 for the initial frame. */
689 || (matrix
->nrows
== 0)));
690 eassert (end
>= 0 && end
<= matrix
->nrows
);
692 for (; start
< end
; ++start
)
693 matrix
->rows
[start
].enabled_p
= false;
699 Empty all rows in MATRIX by clearing their enabled_p flags.
700 The function prepare_desired_row will eventually really clear a row
701 when it sees one with a false enabled_p flag.
703 Reset update hints to default values. The only update hint
704 currently present is the flag MATRIX->no_scrolling_p. */
707 clear_glyph_matrix (struct glyph_matrix
*matrix
)
711 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
712 matrix
->no_scrolling_p
= 0;
717 /* Shift part of the glyph matrix MATRIX of window W up or down.
718 Increment y-positions in glyph rows between START and END by DY,
719 and recompute their visible height. */
722 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
726 eassert (start
<= end
);
727 eassert (start
>= 0 && start
< matrix
->nrows
);
728 eassert (end
>= 0 && end
<= matrix
->nrows
);
730 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
731 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
733 for (; start
< end
; ++start
)
735 struct glyph_row
*row
= &matrix
->rows
[start
];
738 row
->visible_height
= row
->height
;
741 row
->visible_height
-= min_y
- row
->y
;
742 if (row
->y
+ row
->height
> max_y
)
743 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
744 if (row
->fringe_bitmap_periodic_p
)
745 row
->redraw_fringe_bitmaps_p
= 1;
750 /* Mark all rows in current matrices of frame F as invalid. Marking
751 invalid is done by setting enabled_p to zero for all rows in a
755 clear_current_matrices (register struct frame
*f
)
757 /* Clear frame current matrix, if we have one. */
758 if (f
->current_matrix
)
759 clear_glyph_matrix (f
->current_matrix
);
761 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
762 /* Clear the matrix of the menu bar window, if such a window exists.
763 The menu bar window is currently used to display menus on X when
764 no toolkit support is compiled in. */
765 if (WINDOWP (f
->menu_bar_window
))
766 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
769 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
770 /* Clear the matrix of the tool-bar window, if any. */
771 if (WINDOWP (f
->tool_bar_window
))
772 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
775 /* Clear current window matrices. */
776 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
777 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
781 /* Clear out all display lines of F for a coming redisplay. */
784 clear_desired_matrices (register struct frame
*f
)
786 if (f
->desired_matrix
)
787 clear_glyph_matrix (f
->desired_matrix
);
789 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
790 if (WINDOWP (f
->menu_bar_window
))
791 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
794 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
795 if (WINDOWP (f
->tool_bar_window
))
796 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
799 /* Do it for window matrices. */
800 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
801 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
805 /* Clear matrices in window tree rooted in W. If DESIRED_P,
806 clear desired matrices, otherwise clear current matrices. */
809 clear_window_matrices (struct window
*w
, bool desired_p
)
813 if (WINDOWP (w
->contents
))
814 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
818 clear_glyph_matrix (w
->desired_matrix
);
821 clear_glyph_matrix (w
->current_matrix
);
822 w
->window_end_valid
= 0;
826 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
832 /***********************************************************************
835 See dispextern.h for an overall explanation of glyph rows.
836 ***********************************************************************/
838 /* Clear glyph row ROW. NOTE: this code relies on the current
839 layout of `glyphs' and `used' fields of `struct glyph_row'. */
842 clear_glyph_row (struct glyph_row
*row
)
844 enum { off
= offsetof (struct glyph_row
, used
) };
846 /* Zero everything except pointers in `glyphs'. */
847 memset (row
->used
, 0, sizeof *row
- off
);
851 /* Make ROW an empty, enabled row of canonical character height,
852 in window W starting at y-position Y. */
855 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
859 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
860 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
862 clear_glyph_row (row
);
864 row
->ascent
= row
->phys_ascent
= 0;
865 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
866 row
->visible_height
= row
->height
;
869 row
->visible_height
-= min_y
- row
->y
;
870 if (row
->y
+ row
->height
> max_y
)
871 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
873 row
->enabled_p
= true;
877 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
878 are the amounts by which to change positions. Note that the first
879 glyph of the text area of a row can have a buffer position even if
880 the used count of the text area is zero. Such rows display line
884 increment_row_positions (struct glyph_row
*row
,
885 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
889 /* Increment start and end positions. */
890 MATRIX_ROW_START_CHARPOS (row
) += delta
;
891 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
892 MATRIX_ROW_END_CHARPOS (row
) += delta
;
893 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
894 CHARPOS (row
->start
.pos
) += delta
;
895 BYTEPOS (row
->start
.pos
) += delta_bytes
;
896 CHARPOS (row
->end
.pos
) += delta
;
897 BYTEPOS (row
->end
.pos
) += delta_bytes
;
902 /* Increment positions in glyphs. */
903 for (area
= 0; area
< LAST_AREA
; ++area
)
904 for (i
= 0; i
< row
->used
[area
]; ++i
)
905 if (BUFFERP (row
->glyphs
[area
][i
].object
)
906 && row
->glyphs
[area
][i
].charpos
> 0)
907 row
->glyphs
[area
][i
].charpos
+= delta
;
909 /* Capture the case of rows displaying a line end. */
910 if (row
->used
[TEXT_AREA
] == 0
911 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
912 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
917 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
918 contents, i.e. glyph structure contents are exchanged between A and
919 B without changing glyph pointers in A and B. */
922 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
926 for (area
= 0; area
< LAST_AREA
; ++area
)
928 /* Number of glyphs to swap. */
929 int max_used
= max (a
->used
[area
], b
->used
[area
]);
931 /* Start of glyphs in area of row A. */
932 struct glyph
*glyph_a
= a
->glyphs
[area
];
934 /* End + 1 of glyphs in area of row A. */
935 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
937 /* Start of glyphs in area of row B. */
938 struct glyph
*glyph_b
= b
->glyphs
[area
];
940 while (glyph_a
< glyph_a_end
)
942 /* Non-ISO HP/UX compiler doesn't like auto struct
956 /* Exchange pointers to glyph memory between glyph rows A and B. Also
957 exchange the used[] array and the hash values of the rows, because
958 these should all go together for the row's hash value to be
962 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
965 unsigned hash_tem
= a
->hash
;
967 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
969 struct glyph
*temp
= a
->glyphs
[i
];
971 a
->glyphs
[i
] = b
->glyphs
[i
];
975 short used_tem
= a
->used
[i
];
977 a
->used
[i
] = b
->used
[i
];
978 b
->used
[i
] = used_tem
;
986 /* Copy glyph row structure FROM to glyph row structure TO, except that
987 glyph pointers, the `used' counts, and the hash values in the structures
988 are left unchanged. NOTE: this code relies on the current layout of
989 `glyphs', `used', `hash' and `x' fields of `struct glyph_row'. */
992 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
994 enum { off
= offsetof (struct glyph_row
, x
) };
996 memcpy (&to
->x
, &from
->x
, sizeof *to
- off
);
1000 /* Assign glyph row FROM to glyph row TO. This works like a structure
1001 assignment TO = FROM, except that glyph pointers are not copied but
1002 exchanged between TO and FROM. Pointers must be exchanged to avoid
1006 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1008 swap_glyph_pointers (to
, from
);
1009 copy_row_except_pointers (to
, from
);
1013 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1014 a row in a window matrix, is a slice of the glyph memory of the
1015 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1016 is true if the glyph memory of WINDOW_ROW is part of the glyph
1017 memory of FRAME_ROW. */
1022 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1024 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1025 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1026 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1028 return (frame_glyph_start
<= window_glyph_start
1029 && window_glyph_start
< frame_glyph_end
);
1032 #endif /* GLYPH_DEBUG */
1036 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1037 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1038 in WINDOW_MATRIX is found satisfying the condition. */
1040 static struct glyph_row
*
1041 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1042 struct glyph_matrix
*frame_matrix
, int row
)
1046 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1048 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1049 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1050 frame_matrix
->rows
+ row
))
1053 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1058 /* Prepare ROW for display in windows W. Desired rows are cleared
1059 lazily, i.e. they are only marked as to be cleared by setting their
1060 enabled_p flag to zero. When a row is to be displayed, a prior
1061 call to this function really clears it. In addition, this function
1062 makes sure the marginal areas of ROW are in sync with the window's
1063 display margins. MODE_LINE_P non-zero means we are preparing a
1064 glyph row for header line or mode line. */
1067 prepare_desired_row (struct window
*w
, struct glyph_row
*row
, bool mode_line_p
)
1069 if (!row
->enabled_p
)
1071 bool rp
= row
->reversed_p
;
1073 clear_glyph_row (row
);
1074 row
->enabled_p
= true;
1075 row
->reversed_p
= rp
;
1079 /* Mode and header lines, if displayed, never have marginal
1080 areas. If we are called with MODE_LINE_P non-zero, we are
1081 displaying the mode/header line in this window, and so the
1082 marginal areas of this glyph row should be eliminated. This
1083 is needed when the mode/header line is switched on in a
1084 window that has display margins. */
1085 if (w
->left_margin_cols
> 0)
1086 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
1087 if (w
->right_margin_cols
> 0)
1088 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
];
1092 /* The real number of glyphs reserved for the margins is
1093 recorded in the glyph matrix, and can be different from
1094 window's left_margin_cols and right_margin_cols; see
1095 margin_glyphs_to_reserve for when that happens. */
1096 int left
= w
->desired_matrix
->left_margin_glyphs
;
1097 int right
= w
->desired_matrix
->right_margin_glyphs
;
1099 /* Make sure the marginal areas of this row are in sync with
1100 what the window wants, when the row actually displays text
1101 and not header/mode line. */
1102 if (w
->left_margin_cols
> 0
1103 && (left
!= row
->glyphs
[TEXT_AREA
] - row
->glyphs
[LEFT_MARGIN_AREA
]))
1104 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
1105 if (w
->right_margin_cols
> 0
1106 && (right
!= row
->glyphs
[LAST_AREA
] - row
->glyphs
[RIGHT_MARGIN_AREA
]))
1107 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
] - right
;
1112 /* Return a hash code for glyph row ROW, which may
1113 be from current or desired matrix of frame F. */
1116 line_hash_code (struct frame
*f
, struct glyph_row
*row
)
1122 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1123 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1127 int c
= glyph
->u
.ch
;
1128 int face_id
= glyph
->face_id
;
1129 if (FRAME_MUST_WRITE_SPACES (f
))
1131 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1132 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1144 /* Return the cost of drawing line VPOS in MATRIX, which may
1145 be current or desired matrix of frame F. The cost equals
1146 the number of characters in the line. If must_write_spaces
1147 is zero, leading and trailing spaces are ignored. */
1150 line_draw_cost (struct frame
*f
, struct glyph_matrix
*matrix
, int vpos
)
1152 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1153 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1154 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1156 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1157 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1159 /* Ignore trailing and leading spaces if we can. */
1160 if (!FRAME_MUST_WRITE_SPACES (f
))
1162 /* Skip from the end over trailing spaces. */
1163 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1166 /* All blank line. */
1170 /* Skip over leading spaces. */
1171 while (CHAR_GLYPH_SPACE_P (*beg
))
1175 /* If we don't have a glyph-table, each glyph is one character,
1176 so return the number of glyphs. */
1177 if (glyph_table_base
== 0)
1181 /* Otherwise, scan the glyphs and accumulate their total length
1188 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1190 if (GLYPH_INVALID_P (g
)
1191 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1194 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1204 /* Return true if the glyph rows A and B have equal contents.
1205 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1208 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1210 eassert (verify_row_hash (a
));
1211 eassert (verify_row_hash (b
));
1215 else if (a
->hash
!= b
->hash
)
1219 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1222 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1225 /* Compare glyphs. */
1226 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1228 if (a
->used
[area
] != b
->used
[area
])
1231 a_glyph
= a
->glyphs
[area
];
1232 a_end
= a_glyph
+ a
->used
[area
];
1233 b_glyph
= b
->glyphs
[area
];
1235 while (a_glyph
< a_end
1236 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1237 ++a_glyph
, ++b_glyph
;
1239 if (a_glyph
!= a_end
)
1243 if (a
->fill_line_p
!= b
->fill_line_p
1244 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1245 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1246 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1247 || a
->left_fringe_offset
!= b
->left_fringe_offset
1248 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1249 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1250 || a
->right_fringe_offset
!= b
->right_fringe_offset
1251 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1252 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1253 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1254 || a
->overlapped_p
!= b
->overlapped_p
1255 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1256 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1257 || a
->reversed_p
!= b
->reversed_p
1258 /* Different partially visible characters on left margin. */
1260 /* Different height. */
1261 || a
->ascent
!= b
->ascent
1262 || a
->phys_ascent
!= b
->phys_ascent
1263 || a
->phys_height
!= b
->phys_height
1264 || a
->visible_height
!= b
->visible_height
)
1273 /***********************************************************************
1276 See dispextern.h for an overall explanation of glyph pools.
1277 ***********************************************************************/
1279 /* Allocate a glyph_pool structure. The structure returned is initialized
1280 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1281 variable glyph_pool_count is incremented for each pool allocated. */
1283 static struct glyph_pool
* ATTRIBUTE_MALLOC
1284 new_glyph_pool (void)
1286 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1288 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1289 /* For memory leak and double deletion checking. */
1297 /* Free a glyph_pool structure POOL. The function may be called with
1298 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1299 global variable glyph_pool_count is decremented with every pool structure
1300 freed. If this count gets negative, more structures were freed than
1301 allocated, i.e. one structure must have been freed more than once or
1302 a bogus pointer was passed to free_glyph_pool. */
1305 free_glyph_pool (struct glyph_pool
*pool
)
1309 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1310 /* More freed than allocated? */
1312 eassert (glyph_pool_count
>= 0);
1314 xfree (pool
->glyphs
);
1320 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1321 columns we need. This function never shrinks a pool. The only
1322 case in which this would make sense, would be when a frame's size
1323 is changed from a large value to a smaller one. But, if someone
1324 does it once, we can expect that he will do it again.
1326 Return true if the pool changed in a way which makes
1327 re-adjusting window glyph matrices necessary. */
1330 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1335 changed_p
= (pool
->glyphs
== 0
1336 || matrix_dim
.height
!= pool
->nrows
1337 || matrix_dim
.width
!= pool
->ncolumns
);
1339 /* Enlarge the glyph pool. */
1340 if (INT_MULTIPLY_WRAPV (matrix_dim
.height
, matrix_dim
.width
, &needed
))
1341 memory_full (SIZE_MAX
);
1342 if (needed
> pool
->nglyphs
)
1344 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1345 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1346 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1347 memclear (pool
->glyphs
+ old_nglyphs
,
1348 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1351 /* Remember the number of rows and columns because (a) we use them
1352 to do sanity checks, and (b) the number of columns determines
1353 where rows in the frame matrix start---this must be available to
1354 determine pointers to rows of window sub-matrices. */
1355 pool
->nrows
= matrix_dim
.height
;
1356 pool
->ncolumns
= matrix_dim
.width
;
1363 /***********************************************************************
1365 ***********************************************************************/
1370 /* Flush standard output. This is sometimes useful to call from the debugger.
1371 XXX Maybe this should be changed to flush the current terminal instead of
1375 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1384 /* Check that no glyph pointers have been lost in MATRIX. If a
1385 pointer has been lost, e.g. by using a structure assignment between
1386 rows, at least one pointer must occur more than once in the rows of
1390 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1394 for (i
= 0; i
< matrix
->nrows
; ++i
)
1395 for (j
= 0; j
< matrix
->nrows
; ++j
)
1397 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1398 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1402 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1405 matrix_row (struct glyph_matrix
*matrix
, int row
)
1407 eassert (matrix
&& matrix
->rows
);
1408 eassert (row
>= 0 && row
< matrix
->nrows
);
1410 /* That's really too slow for normal testing because this function
1411 is called almost everywhere. Although---it's still astonishingly
1412 fast, so it is valuable to have for debugging purposes. */
1414 check_matrix_pointer_lossage (matrix
);
1417 return matrix
->rows
+ row
;
1421 #if 0 /* This function makes invalid assumptions when text is
1422 partially invisible. But it might come handy for debugging
1425 /* Check invariants that must hold for an up to date current matrix of
1429 check_matrix_invariants (struct window
*w
)
1431 struct glyph_matrix
*matrix
= w
->current_matrix
;
1432 int yb
= window_text_bottom_y (w
);
1433 struct glyph_row
*row
= matrix
->rows
;
1434 struct glyph_row
*last_text_row
= NULL
;
1435 struct buffer
*saved
= current_buffer
;
1436 struct buffer
*buffer
= XBUFFER (w
->contents
);
1439 /* This can sometimes happen for a fresh window. */
1440 if (matrix
->nrows
< 2)
1443 set_buffer_temp (buffer
);
1445 /* Note: last row is always reserved for the mode line. */
1446 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1447 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1449 struct glyph_row
*next
= row
+ 1;
1451 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1452 last_text_row
= row
;
1454 /* Check that character and byte positions are in sync. */
1455 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1456 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1457 eassert (BYTEPOS (row
->start
.pos
)
1458 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1460 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1461 have such a position temporarily in case of a minibuffer
1462 displaying something like `[Sole completion]' at its end. */
1463 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1465 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1466 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1467 eassert (BYTEPOS (row
->end
.pos
)
1468 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1471 /* Check that end position of `row' is equal to start position
1473 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1475 eassert (MATRIX_ROW_END_CHARPOS (row
)
1476 == MATRIX_ROW_START_CHARPOS (next
));
1477 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1478 == MATRIX_ROW_START_BYTEPOS (next
));
1479 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1480 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1485 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1486 eassert (w
->desired_matrix
->rows
!= NULL
);
1487 set_buffer_temp (saved
);
1492 #endif /* GLYPH_DEBUG */
1496 /**********************************************************************
1497 Allocating/ Adjusting Glyph Matrices
1498 **********************************************************************/
1500 /* Allocate glyph matrices over a window tree for a frame-based
1503 X and Y are column/row within the frame glyph matrix where
1504 sub-matrices for the window tree rooted at WINDOW must be
1505 allocated. DIM_ONLY_P means that the caller of this
1506 function is only interested in the result matrix dimension, and
1507 matrix adjustments should not be performed.
1509 The function returns the total width/height of the sub-matrices of
1510 the window tree. If called on a frame root window, the computation
1511 will take the mini-buffer window into account.
1513 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1515 NEW_LEAF_MATRIX set if any window in the tree did not have a
1516 glyph matrices yet, and
1518 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1519 any window in the tree will be changed or have been changed (see
1522 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1525 Windows are arranged into chains of windows on the same level
1526 through the next fields of window structures. Such a level can be
1527 either a sequence of horizontally adjacent windows from left to
1528 right, or a sequence of vertically adjacent windows from top to
1529 bottom. Each window in a horizontal sequence can be either a leaf
1530 window or a vertical sequence; a window in a vertical sequence can
1531 be either a leaf or a horizontal sequence. All windows in a
1532 horizontal sequence have the same height, and all windows in a
1533 vertical sequence have the same width.
1535 This function uses, for historical reasons, a more general
1536 algorithm to determine glyph matrix dimensions that would be
1539 The matrix height of a horizontal sequence is determined by the
1540 maximum height of any matrix in the sequence. The matrix width of
1541 a horizontal sequence is computed by adding up matrix widths of
1542 windows in the sequence.
1544 |<------- result width ------->|
1545 +---------+----------+---------+ ---
1548 +---------+ | | result height
1553 The matrix width of a vertical sequence is the maximum matrix width
1554 of any window in the sequence. Its height is computed by adding up
1555 matrix heights of windows in the sequence.
1557 |<---- result width -->|
1565 +------------+---------+ |
1568 +------------+---------+ --- */
1570 /* Bit indicating that a new matrix will be allocated or has been
1573 #define NEW_LEAF_MATRIX (1 << 0)
1575 /* Bit indicating that a matrix will or has changed its location or
1578 #define CHANGED_LEAF_MATRIX (1 << 1)
1581 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1582 bool dim_only_p
, int *window_change_flags
)
1584 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1586 int wmax
= 0, hmax
= 0;
1590 bool in_horz_combination_p
;
1592 /* What combination is WINDOW part of? Compute this once since the
1593 result is the same for all windows in the `next' chain. The
1594 special case of a root window (parent equal to nil) is treated
1595 like a vertical combination because a root window's `next'
1596 points to the mini-buffer window, if any, which is arranged
1597 vertically below other windows. */
1598 in_horz_combination_p
1599 = (!NILP (XWINDOW (window
)->parent
)
1600 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1602 /* For WINDOW and all windows on the same level. */
1605 w
= XWINDOW (window
);
1607 /* Get the dimension of the window sub-matrix for W, depending
1608 on whether this is a combination or a leaf window. */
1609 if (WINDOWP (w
->contents
))
1610 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1612 window_change_flags
);
1615 /* If not already done, allocate sub-matrix structures. */
1616 if (w
->desired_matrix
== NULL
)
1618 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1619 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1620 *window_change_flags
|= NEW_LEAF_MATRIX
;
1623 /* Width and height MUST be chosen so that there are no
1624 holes in the frame matrix. */
1625 dim
.width
= required_matrix_width (w
);
1626 dim
.height
= required_matrix_height (w
);
1628 /* Will matrix be re-allocated? */
1629 if (x
!= w
->desired_matrix
->matrix_x
1630 || y
!= w
->desired_matrix
->matrix_y
1631 || dim
.width
!= w
->desired_matrix
->matrix_w
1632 || dim
.height
!= w
->desired_matrix
->matrix_h
1633 || (margin_glyphs_to_reserve (w
, dim
.width
,
1634 w
->left_margin_cols
)
1635 != w
->desired_matrix
->left_margin_glyphs
)
1636 || (margin_glyphs_to_reserve (w
, dim
.width
,
1637 w
->right_margin_cols
)
1638 != w
->desired_matrix
->right_margin_glyphs
))
1639 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1641 /* Actually change matrices, if allowed. Do not consider
1642 CHANGED_LEAF_MATRIX computed above here because the pool
1643 may have been changed which we don't know here. We trust
1644 that we only will be called with DIM_ONLY_P when
1648 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1649 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1653 /* If we are part of a horizontal combination, advance x for
1654 windows to the right of W; otherwise advance y for windows
1656 if (in_horz_combination_p
)
1661 /* Remember maximum glyph matrix dimensions. */
1662 wmax
= max (wmax
, dim
.width
);
1663 hmax
= max (hmax
, dim
.height
);
1665 /* Next window on same level. */
1668 while (!NILP (window
));
1670 /* Set `total' to the total glyph matrix dimension of this window
1671 level. In a vertical combination, the width is the width of the
1672 widest window; the height is the y we finally reached, corrected
1673 by the y we started with. In a horizontal combination, the total
1674 height is the height of the tallest window, and the width is the
1675 x we finally reached, corrected by the x we started with. */
1676 if (in_horz_combination_p
)
1678 total
.width
= x
- x0
;
1679 total
.height
= hmax
;
1684 total
.height
= y
- y0
;
1691 /* Return the required height of glyph matrices for window W. */
1694 required_matrix_height (struct window
*w
)
1696 #ifdef HAVE_WINDOW_SYSTEM
1697 struct frame
*f
= XFRAME (w
->frame
);
1699 if (FRAME_WINDOW_P (f
))
1701 /* https://lists.gnu.org/r/emacs-devel/2015-11/msg00194.html */
1702 int ch_height
= max (FRAME_SMALLEST_FONT_HEIGHT (f
), 1);
1703 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1705 return (((window_pixel_height
+ ch_height
- 1)
1706 / ch_height
) * w
->nrows_scale_factor
1707 /* One partially visible line at the top and
1708 bottom of the window. */
1710 /* 2 for header and mode line. */
1713 #endif /* HAVE_WINDOW_SYSTEM */
1715 return WINDOW_TOTAL_LINES (w
);
1719 /* Return the required width of glyph matrices for window W. */
1722 required_matrix_width (struct window
*w
)
1724 #ifdef HAVE_WINDOW_SYSTEM
1725 struct frame
*f
= XFRAME (w
->frame
);
1726 if (FRAME_WINDOW_P (f
))
1728 /* https://lists.gnu.org/r/emacs-devel/2015-11/msg00194.html */
1729 int ch_width
= max (FRAME_SMALLEST_CHAR_WIDTH (f
), 1);
1731 /* Compute number of glyphs needed in a glyph row. */
1732 return (((WINDOW_PIXEL_WIDTH (w
) + ch_width
- 1)
1733 / ch_width
) * w
->ncols_scale_factor
1734 /* 2 partially visible columns in the text area. */
1736 /* One partially visible column at the right
1737 edge of each marginal area. */
1740 #endif /* HAVE_WINDOW_SYSTEM */
1742 return w
->total_cols
;
1746 /* Allocate window matrices for window-based redisplay. W is the
1747 window whose matrices must be allocated/reallocated. */
1750 allocate_matrices_for_window_redisplay (struct window
*w
)
1754 if (WINDOWP (w
->contents
))
1755 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1758 /* W is a leaf window. */
1761 /* If matrices are not yet allocated, allocate them now. */
1762 if (w
->desired_matrix
== NULL
)
1764 w
->desired_matrix
= new_glyph_matrix (NULL
);
1765 w
->current_matrix
= new_glyph_matrix (NULL
);
1768 dim
.width
= required_matrix_width (w
);
1769 dim
.height
= required_matrix_height (w
);
1770 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1771 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1774 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1778 /* Allocate/reallocate glyph matrices of a single frame F.
1779 This function must be called when a new frame is created,
1780 its size changes, or its window configuration changes. */
1783 adjust_frame_glyphs (struct frame
*f
)
1785 /* Block input so that expose events and other events that access
1786 glyph matrices are not processed while we are changing them. */
1789 if (FRAME_WINDOW_P (f
))
1790 adjust_frame_glyphs_for_window_redisplay (f
);
1792 adjust_frame_glyphs_for_frame_redisplay (f
);
1794 /* Don't forget the buffer for decode_mode_spec. */
1795 adjust_decode_mode_spec_buffer (f
);
1797 f
->glyphs_initialized_p
= 1;
1802 /* Return true if any window in the tree has nonzero window margins. See
1803 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1805 showing_window_margins_p (struct window
*w
)
1809 if (WINDOWP (w
->contents
))
1811 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1814 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1817 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1823 /* In the window tree with root W, build current matrices of leaf
1824 windows from the frame's current matrix. */
1827 fake_current_matrices (Lisp_Object window
)
1831 for (; !NILP (window
); window
= w
->next
)
1833 w
= XWINDOW (window
);
1835 if (WINDOWP (w
->contents
))
1836 fake_current_matrices (w
->contents
);
1840 struct frame
*f
= XFRAME (w
->frame
);
1841 struct glyph_matrix
*m
= w
->current_matrix
;
1842 struct glyph_matrix
*fm
= f
->current_matrix
;
1844 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1845 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1847 for (i
= 0; i
< m
->matrix_h
; ++i
)
1849 struct glyph_row
*r
= m
->rows
+ i
;
1850 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1852 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1853 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1855 r
->enabled_p
= fr
->enabled_p
;
1858 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1859 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1860 r
->used
[TEXT_AREA
] = (m
->matrix_w
1861 - r
->used
[LEFT_MARGIN_AREA
]
1862 - r
->used
[RIGHT_MARGIN_AREA
]);
1871 /* Save away the contents of frame F's current frame matrix. Value is
1872 a glyph matrix holding the contents of F's current frame matrix. */
1874 static struct glyph_matrix
*
1875 save_current_matrix (struct frame
*f
)
1878 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1879 saved
->nrows
= f
->current_matrix
->nrows
;
1880 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1882 for (i
= 0; i
< saved
->nrows
; ++i
)
1884 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1885 struct glyph_row
*to
= saved
->rows
+ i
;
1886 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1888 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1889 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1890 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1891 to
->enabled_p
= from
->enabled_p
;
1892 to
->hash
= from
->hash
;
1893 if (from
->used
[LEFT_MARGIN_AREA
])
1895 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1896 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1897 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1898 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1899 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1901 if (from
->used
[RIGHT_MARGIN_AREA
])
1903 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1904 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1905 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1906 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1907 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1915 /* Restore the contents of frame F's current frame matrix from SAVED,
1916 and free memory associated with SAVED. */
1919 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1923 for (i
= 0; i
< saved
->nrows
; ++i
)
1925 struct glyph_row
*from
= saved
->rows
+ i
;
1926 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1927 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1929 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1930 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1931 xfree (from
->glyphs
[TEXT_AREA
]);
1932 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1935 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1936 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1937 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1938 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1941 to
->used
[LEFT_MARGIN_AREA
] = 0;
1942 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1945 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1946 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1947 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1948 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1951 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1954 xfree (saved
->rows
);
1960 /* Allocate/reallocate glyph matrices of a single frame F for
1961 frame-based redisplay. */
1964 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1966 struct dim matrix_dim
;
1967 bool pool_changed_p
;
1968 int window_change_flags
;
1971 if (!FRAME_LIVE_P (f
))
1974 top_window_y
= FRAME_TOP_MARGIN (f
);
1976 /* Allocate glyph pool structures if not already done. */
1977 if (f
->desired_pool
== NULL
)
1979 f
->desired_pool
= new_glyph_pool ();
1980 f
->current_pool
= new_glyph_pool ();
1983 /* Allocate frames matrix structures if needed. */
1984 if (f
->desired_matrix
== NULL
)
1986 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1987 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1990 /* Compute window glyph matrices. (This takes the mini-buffer
1991 window into account). The result is the size of the frame glyph
1992 matrix needed. The variable window_change_flags is set to a bit
1993 mask indicating whether new matrices will be allocated or
1994 existing matrices change their size or location within the frame
1996 window_change_flags
= 0;
1998 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2001 &window_change_flags
);
2003 /* Add in menu bar lines, if any. */
2004 matrix_dim
.height
+= top_window_y
;
2006 /* Enlarge pools as necessary. */
2007 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2008 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2010 /* Set up glyph pointers within window matrices. Do this only if
2011 absolutely necessary since it requires a frame redraw. */
2012 if (pool_changed_p
|| window_change_flags
)
2014 /* Do it for window matrices. */
2015 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2017 &window_change_flags
);
2019 /* Size of frame matrices must equal size of frame. Note
2020 that we are called for X frames with window widths NOT equal
2021 to the frame width (from CHANGE_FRAME_SIZE_1). */
2022 if (matrix_dim
.width
!= FRAME_TOTAL_COLS (f
)
2023 || matrix_dim
.height
!= FRAME_TOTAL_LINES (f
))
2026 eassert (matrix_dim
.width
== FRAME_TOTAL_COLS (f
)
2027 && matrix_dim
.height
== FRAME_TOTAL_LINES (f
));
2029 /* Pointers to glyph memory in glyph rows are exchanged during
2030 the update phase of redisplay, which means in general that a
2031 frame's current matrix consists of pointers into both the
2032 desired and current glyph pool of the frame. Adjusting a
2033 matrix sets the frame matrix up so that pointers are all into
2034 the same pool. If we want to preserve glyph contents of the
2035 current matrix over a call to adjust_glyph_matrix, we must
2036 make a copy of the current glyphs, and restore the current
2037 matrix' contents from that copy. */
2038 if (display_completed
2039 && !FRAME_GARBAGED_P (f
)
2040 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2041 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2042 /* For some reason, the frame glyph matrix gets corrupted if
2043 any of the windows contain margins. I haven't been able
2044 to hunt down the reason, but for the moment this prevents
2045 the problem from manifesting. -- cyd */
2046 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2048 struct glyph_matrix
*copy
= save_current_matrix (f
);
2049 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2050 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2051 restore_current_matrix (f
, copy
);
2052 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2056 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2057 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2058 SET_FRAME_GARBAGED (f
);
2064 /* Allocate/reallocate glyph matrices of a single frame F for
2065 window-based redisplay. */
2068 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2070 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2072 /* Allocate/reallocate window matrices. */
2073 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2075 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2076 /* Allocate/ reallocate matrices of the dummy window used to display
2077 the menu bar under X when no X toolkit support is available. */
2079 /* Allocate a dummy window if not already done. */
2081 if (NILP (f
->menu_bar_window
))
2084 fset_menu_bar_window (f
, make_window ());
2085 w
= XWINDOW (f
->menu_bar_window
);
2086 XSETFRAME (frame
, f
);
2087 wset_frame (w
, frame
);
2088 w
->pseudo_window_p
= 1;
2091 w
= XWINDOW (f
->menu_bar_window
);
2093 /* Set window dimensions to frame dimensions and allocate or
2094 adjust glyph matrices of W. */
2099 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2100 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2101 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2102 w
->pixel_height
= FRAME_MENU_BAR_HEIGHT (f
);
2103 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2104 allocate_matrices_for_window_redisplay (w
);
2108 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2110 /* Allocate/ reallocate matrices of the tool bar window. If we
2111 don't have a tool bar window yet, make one. */
2113 if (NILP (f
->tool_bar_window
))
2116 fset_tool_bar_window (f
, make_window ());
2117 w
= XWINDOW (f
->tool_bar_window
);
2118 XSETFRAME (frame
, f
);
2119 wset_frame (w
, frame
);
2120 w
->pseudo_window_p
= 1;
2123 w
= XWINDOW (f
->tool_bar_window
);
2127 w
->pixel_top
= FRAME_MENU_BAR_HEIGHT (f
);
2128 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2129 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2130 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2131 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2132 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2133 w
->pixel_height
= FRAME_TOOL_BAR_HEIGHT (f
);
2134 allocate_matrices_for_window_redisplay (w
);
2140 /* Re-allocate buffer for decode_mode_spec on frame F. */
2143 adjust_decode_mode_spec_buffer (struct frame
*f
)
2145 int frame_message_buf_size
= FRAME_MESSAGE_BUF_SIZE (f
);
2147 eassert (frame_message_buf_size
>= 0);
2148 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2149 frame_message_buf_size
+ 1);
2154 /**********************************************************************
2155 Freeing Glyph Matrices
2156 **********************************************************************/
2158 /* Free glyph memory for a frame F. F may be null. This function can
2159 be called for the same frame more than once. The root window of
2160 F may be nil when this function is called. This is the case when
2161 the function is called when F is destroyed. */
2164 free_glyphs (struct frame
*f
)
2166 if (f
&& f
->glyphs_initialized_p
)
2168 /* Block interrupt input so that we don't get surprised by an X
2169 event while we're in an inconsistent state. */
2171 f
->glyphs_initialized_p
= 0;
2173 /* Release window sub-matrices. */
2174 if (!NILP (f
->root_window
))
2175 free_window_matrices (XWINDOW (f
->root_window
));
2177 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2178 /* Free the dummy window for menu bars without X toolkit and its
2180 if (!NILP (f
->menu_bar_window
))
2182 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2183 free_glyph_matrix (w
->desired_matrix
);
2184 free_glyph_matrix (w
->current_matrix
);
2185 w
->desired_matrix
= w
->current_matrix
= NULL
;
2186 fset_menu_bar_window (f
, Qnil
);
2190 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2191 /* Free the tool bar window and its glyph matrices. */
2192 if (!NILP (f
->tool_bar_window
))
2194 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2195 free_glyph_matrix (w
->desired_matrix
);
2196 free_glyph_matrix (w
->current_matrix
);
2197 w
->desired_matrix
= w
->current_matrix
= NULL
;
2198 fset_tool_bar_window (f
, Qnil
);
2202 /* Release frame glyph matrices. Reset fields to zero in
2203 case we are called a second time. */
2204 if (f
->desired_matrix
)
2206 free_glyph_matrix (f
->desired_matrix
);
2207 free_glyph_matrix (f
->current_matrix
);
2208 f
->desired_matrix
= f
->current_matrix
= NULL
;
2211 /* Release glyph pools. */
2212 if (f
->desired_pool
)
2214 free_glyph_pool (f
->desired_pool
);
2215 free_glyph_pool (f
->current_pool
);
2216 f
->desired_pool
= f
->current_pool
= NULL
;
2224 /* Free glyph sub-matrices in the window tree rooted at W. This
2225 function may be called with a null pointer, and it may be called on
2226 the same tree more than once. */
2229 free_window_matrices (struct window
*w
)
2233 if (WINDOWP (w
->contents
))
2234 free_window_matrices (XWINDOW (w
->contents
));
2237 /* This is a leaf window. Free its memory and reset fields
2238 to zero in case this function is called a second time for
2240 free_glyph_matrix (w
->current_matrix
);
2241 free_glyph_matrix (w
->desired_matrix
);
2242 w
->current_matrix
= w
->desired_matrix
= NULL
;
2245 /* Next window on same level. */
2246 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2251 /* Check glyph memory leaks. This function is called from
2252 shut_down_emacs. Note that frames are not destroyed when Emacs
2253 exits. We therefore free all glyph memory for all active frames
2254 explicitly and check that nothing is left allocated. */
2257 check_glyph_memory (void)
2259 Lisp_Object tail
, frame
;
2261 /* Free glyph memory for all frames. */
2262 FOR_EACH_FRAME (tail
, frame
)
2263 free_glyphs (XFRAME (frame
));
2265 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2266 /* Check that nothing is left allocated. */
2267 eassert (glyph_matrix_count
== 0);
2268 eassert (glyph_pool_count
== 0);
2274 /**********************************************************************
2275 Building a Frame Matrix
2276 **********************************************************************/
2278 /* Most of the redisplay code works on glyph matrices attached to
2279 windows. This is a good solution most of the time, but it is not
2280 suitable for terminal code. Terminal output functions cannot rely
2281 on being able to set an arbitrary terminal window. Instead they
2282 must be provided with a view of the whole frame, i.e. the whole
2283 screen. We build such a view by constructing a frame matrix from
2284 window matrices in this section.
2286 Windows that must be updated have their must_be_updated_p flag set.
2287 For all such windows, their desired matrix is made part of the
2288 desired frame matrix. For other windows, their current matrix is
2289 made part of the desired frame matrix.
2291 +-----------------+----------------+
2292 | desired | desired |
2294 +-----------------+----------------+
2297 +----------------------------------+
2299 Desired window matrices can be made part of the frame matrix in a
2300 cheap way: We exploit the fact that the desired frame matrix and
2301 desired window matrices share their glyph memory. This is not
2302 possible for current window matrices. Their glyphs are copied to
2303 the desired frame matrix. The latter is equivalent to
2304 preserve_other_columns in the old redisplay.
2306 Used glyphs counters for frame matrix rows are the result of adding
2307 up glyph lengths of the window matrices. A line in the frame
2308 matrix is enabled, if a corresponding line in a window matrix is
2311 After building the desired frame matrix, it will be passed to
2312 terminal code, which will manipulate both the desired and current
2313 frame matrix. Changes applied to the frame's current matrix have
2314 to be visible in current window matrices afterwards, of course.
2316 This problem is solved like this:
2318 1. Window and frame matrices share glyphs. Window matrices are
2319 constructed in a way that their glyph contents ARE the glyph
2320 contents needed in a frame matrix. Thus, any modification of
2321 glyphs done in terminal code will be reflected in window matrices
2324 2. Exchanges of rows in a frame matrix done by terminal code are
2325 intercepted by hook functions so that corresponding row operations
2326 on window matrices can be performed. This is necessary because we
2327 use pointers to glyphs in glyph row structures. To satisfy the
2328 assumption of point 1 above that glyphs are updated implicitly in
2329 window matrices when they are manipulated via the frame matrix,
2330 window and frame matrix must of course agree where to find the
2331 glyphs for their rows. Possible manipulations that must be
2332 mirrored are assignments of rows of the desired frame matrix to the
2333 current frame matrix and scrolling the current frame matrix. */
2335 /* Build frame F's desired matrix from window matrices. Only windows
2336 which have the flag must_be_updated_p set have to be updated. Menu
2337 bar lines of a frame are not covered by window matrices, so make
2338 sure not to touch them in this function. */
2341 build_frame_matrix (struct frame
*f
)
2345 /* F must have a frame matrix when this function is called. */
2346 eassert (!FRAME_WINDOW_P (f
));
2348 /* Clear all rows in the frame matrix covered by window matrices.
2349 Menu bar lines are not covered by windows. */
2350 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2351 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2353 /* Build the matrix by walking the window tree. */
2354 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2355 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2359 /* Walk a window tree, building a frame matrix MATRIX from window
2360 matrices. W is the root of a window tree. */
2363 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2367 if (WINDOWP (w
->contents
))
2368 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2370 build_frame_matrix_from_leaf_window (matrix
, w
);
2372 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2377 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2378 desired frame matrix built. W is a leaf window whose desired or
2379 current matrix is to be added to FRAME_MATRIX. W's flag
2380 must_be_updated_p determines which matrix it contributes to
2381 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2382 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2383 Adding a desired matrix means setting up used counters and such in
2384 frame rows, while adding a current window matrix to FRAME_MATRIX
2385 means copying glyphs. The latter case corresponds to
2386 preserve_other_columns in the old redisplay. */
2389 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2391 struct glyph_matrix
*window_matrix
;
2392 int window_y
, frame_y
;
2393 /* If non-zero, a glyph to insert at the right border of W. */
2394 GLYPH right_border_glyph
;
2396 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2398 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2399 if (w
->must_be_updated_p
)
2401 window_matrix
= w
->desired_matrix
;
2403 /* Decide whether we want to add a vertical border glyph. */
2404 if (!WINDOW_RIGHTMOST_P (w
))
2406 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2409 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2411 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2413 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2414 spec_glyph_lookup_face (w
, &right_border_glyph
);
2417 if (GLYPH_FACE (right_border_glyph
) <= 0)
2418 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2422 window_matrix
= w
->current_matrix
;
2424 /* For all rows in the window matrix and corresponding rows in the
2427 frame_y
= window_matrix
->matrix_y
;
2428 while (window_y
< window_matrix
->nrows
)
2430 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2431 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2432 bool current_row_p
= window_matrix
== w
->current_matrix
;
2434 /* Fill up the frame row with spaces up to the left margin of the
2436 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2438 /* Fill up areas in the window matrix row with spaces. */
2439 fill_up_glyph_row_with_spaces (window_row
);
2441 /* If only part of W's desired matrix has been built, and
2442 window_row wasn't displayed, use the corresponding current
2444 if (window_matrix
== w
->desired_matrix
2445 && !window_row
->enabled_p
)
2447 window_row
= w
->current_matrix
->rows
+ window_y
;
2453 /* Copy window row to frame row. */
2454 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2455 window_row
->glyphs
[0],
2456 window_matrix
->matrix_w
* sizeof (struct glyph
));
2460 eassert (window_row
->enabled_p
);
2462 /* Only when a desired row has been displayed, we want
2463 the corresponding frame row to be updated. */
2464 frame_row
->enabled_p
= true;
2466 /* Maybe insert a vertical border between horizontally adjacent
2468 if (GLYPH_CHAR (right_border_glyph
) != 0)
2470 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2471 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2475 /* Window row window_y must be a slice of frame row
2477 eassert (glyph_row_slice_p (window_row
, frame_row
));
2479 /* If rows are in sync, we don't have to copy glyphs because
2480 frame and window share glyphs. */
2482 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2483 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2487 /* Set number of used glyphs in the frame matrix. Since we fill
2488 up with spaces, and visit leaf windows from left to right it
2489 can be done simply. */
2490 frame_row
->used
[TEXT_AREA
]
2491 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2499 /* Given a user-specified glyph, possibly including a Lisp-level face
2500 ID, return a glyph that has a realized face ID.
2501 This is used for glyphs displayed specially and not part of the text;
2502 for instance, vertical separators, truncation markers, etc. */
2505 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2507 int lface_id
= GLYPH_FACE (*glyph
);
2508 /* Convert the glyph's specified face to a realized (cache) face. */
2511 int face_id
= merge_faces (w
, Qt
, lface_id
, DEFAULT_FACE_ID
);
2512 SET_GLYPH_FACE (*glyph
, face_id
);
2516 /* Add spaces to a glyph row ROW in a window matrix.
2518 Each row has the form:
2520 +---------+-----------------------------+------------+
2521 | left | text | right |
2522 +---------+-----------------------------+------------+
2524 Left and right marginal areas are optional. This function adds
2525 spaces to areas so that there are no empty holes between areas.
2526 In other words: If the right area is not empty, the text area
2527 is filled up with spaces up to the right area. If the text area
2528 is not empty, the left area is filled up.
2530 To be called for frame-based redisplay, only. */
2533 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2535 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2536 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2537 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2541 /* Fill area AREA of glyph row ROW with spaces. To be called for
2542 frame-based redisplay only. */
2545 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2547 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2549 struct glyph
*end
= row
->glyphs
[area
+ 1];
2550 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2553 *text
++ = space_glyph
;
2554 row
->used
[area
] = text
- row
->glyphs
[area
];
2559 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2560 reached. In frame matrices only one area, TEXT_AREA, is used. */
2563 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2565 int i
= row
->used
[TEXT_AREA
];
2566 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2569 glyph
[i
++] = space_glyph
;
2571 row
->used
[TEXT_AREA
] = i
;
2576 /**********************************************************************
2577 Mirroring operations on frame matrices in window matrices
2578 **********************************************************************/
2580 /* Set frame being updated via frame-based redisplay to F. This
2581 function must be called before updates to make explicit that we are
2582 working on frame matrices or not. */
2585 set_frame_matrix_frame (struct frame
*f
)
2587 frame_matrix_frame
= f
;
2591 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2592 DESIRED_MATRIX is the desired matrix corresponding to
2593 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2594 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2595 frame_matrix_frame is non-null, this indicates that the exchange is
2596 done in frame matrices, and that we have to perform analogous
2597 operations in window matrices of frame_matrix_frame. */
2600 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2602 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2603 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2604 bool mouse_face_p
= current_row
->mouse_face_p
;
2606 /* Do current_row = desired_row. This exchanges glyph pointers
2607 between both rows, and does a structure assignment otherwise. */
2608 assign_row (current_row
, desired_row
);
2610 /* Enable current_row to mark it as valid. */
2611 current_row
->enabled_p
= true;
2612 current_row
->mouse_face_p
= mouse_face_p
;
2614 /* If we are called on frame matrices, perform analogous operations
2615 for window matrices. */
2616 if (frame_matrix_frame
)
2617 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2621 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2622 W's frame which has been made current (by swapping pointers between
2623 current and desired matrix). Perform analogous operations in the
2624 matrices of leaf windows in the window tree rooted at W. */
2627 mirror_make_current (struct window
*w
, int frame_row
)
2631 if (WINDOWP (w
->contents
))
2632 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2635 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2636 here because the checks performed in debug mode there
2637 will not allow the conversion. */
2638 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2640 /* If FRAME_ROW is within W, assign the desired row to the
2641 current row (exchanging glyph pointers). */
2642 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2644 struct glyph_row
*current_row
2645 = MATRIX_ROW (w
->current_matrix
, row
);
2646 struct glyph_row
*desired_row
2647 = MATRIX_ROW (w
->desired_matrix
, row
);
2649 if (desired_row
->enabled_p
)
2650 assign_row (current_row
, desired_row
);
2652 swap_glyph_pointers (desired_row
, current_row
);
2653 current_row
->enabled_p
= true;
2655 /* Set the Y coordinate of the mode/header line's row.
2656 It is needed in draw_row_with_mouse_face to find the
2657 screen coordinates. (Window-based redisplay sets
2658 this in update_window, but no one seems to do that
2659 for frame-based redisplay.) */
2660 if (current_row
->mode_line_p
)
2661 current_row
->y
= row
;
2665 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2670 /* Perform row dance after scrolling. We are working on the range of
2671 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2672 including) in MATRIX. COPY_FROM is a vector containing, for each
2673 row I in the range 0 <= I < NLINES, the index of the original line
2674 to move to I. This index is relative to the row range, i.e. 0 <=
2675 index < NLINES. RETAINED_P is a vector containing zero for each
2676 row 0 <= I < NLINES which is empty.
2678 This function is called from do_scrolling and do_direct_scrolling. */
2681 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2682 int *copy_from
, char *retained_p
)
2684 /* A copy of original rows. */
2685 struct glyph_row
*old_rows
;
2687 /* Rows to assign to. */
2688 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2692 /* Make a copy of the original rows. */
2694 SAFE_NALLOCA (old_rows
, 1, nlines
);
2695 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2697 /* Assign new rows, maybe clear lines. */
2698 for (i
= 0; i
< nlines
; ++i
)
2700 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2702 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2703 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2704 new_rows
[i
] = old_rows
[copy_from
[i
]];
2705 new_rows
[i
].enabled_p
= enabled_before_p
;
2707 /* RETAINED_P is zero for empty lines. */
2708 if (!retained_p
[copy_from
[i
]])
2709 new_rows
[i
].enabled_p
= false;
2712 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2713 if (frame_matrix_frame
)
2714 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2715 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2721 /* Synchronize glyph pointers in the current matrix of window W with
2722 the current frame matrix. */
2725 sync_window_with_frame_matrix_rows (struct window
*w
)
2727 struct frame
*f
= XFRAME (w
->frame
);
2728 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2729 int left
, right
, x
, width
;
2731 /* Preconditions: W must be a live window on a tty frame. */
2732 eassert (BUFFERP (w
->contents
));
2733 eassert (!FRAME_WINDOW_P (f
));
2735 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2736 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2737 x
= w
->current_matrix
->matrix_x
;
2738 width
= w
->current_matrix
->matrix_w
;
2740 window_row
= w
->current_matrix
->rows
;
2741 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2742 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2744 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2746 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2747 = frame_row
->glyphs
[0] + x
;
2748 window_row
->glyphs
[TEXT_AREA
]
2749 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2750 window_row
->glyphs
[LAST_AREA
]
2751 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2752 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2753 = window_row
->glyphs
[LAST_AREA
] - right
;
2758 /* Return the window in the window tree rooted in W containing frame
2759 row ROW. Value is null if none is found. */
2761 static struct window
*
2762 frame_row_to_window (struct window
*w
, int row
)
2764 struct window
*found
= NULL
;
2768 if (WINDOWP (w
->contents
))
2769 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2770 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2771 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2774 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2781 /* Perform a line dance in the window tree rooted at W, after
2782 scrolling a frame matrix in mirrored_line_dance.
2784 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2785 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2786 COPY_FROM is a vector containing, for each row I in the range 0 <=
2787 I < NLINES, the index of the original line to move to I. This
2788 index is relative to the row range, i.e. 0 <= index < NLINES.
2789 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2793 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2797 if (WINDOWP (w
->contents
))
2798 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2799 nlines
, copy_from
, retained_p
);
2802 /* W is a leaf window, and we are working on its current
2804 struct glyph_matrix
*m
= w
->current_matrix
;
2807 struct glyph_row
*old_rows
;
2809 /* Make a copy of the original rows of matrix m. */
2811 SAFE_NALLOCA (old_rows
, 1, m
->nrows
);
2812 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2814 for (i
= 0; i
< nlines
; ++i
)
2816 /* Frame relative line assigned to. */
2817 int frame_to
= i
+ unchanged_at_top
;
2819 /* Frame relative line assigned. */
2820 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2822 /* Window relative line assigned to. */
2823 int window_to
= frame_to
- m
->matrix_y
;
2825 /* Window relative line assigned. */
2826 int window_from
= frame_from
- m
->matrix_y
;
2828 /* Is assigned line inside window? */
2829 bool from_inside_window_p
2830 = window_from
>= 0 && window_from
< m
->matrix_h
;
2832 /* Is assigned to line inside window? */
2833 bool to_inside_window_p
2834 = window_to
>= 0 && window_to
< m
->matrix_h
;
2836 if (from_inside_window_p
&& to_inside_window_p
)
2838 /* Do the assignment. The enabled_p flag is saved
2839 over the assignment because the old redisplay did
2841 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2842 m
->rows
[window_to
] = old_rows
[window_from
];
2843 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2845 /* If frame line is empty, window line is empty, too. */
2846 if (!retained_p
[copy_from
[i
]])
2847 m
->rows
[window_to
].enabled_p
= false;
2849 else if (to_inside_window_p
)
2851 /* A copy between windows. This is an infrequent
2852 case not worth optimizing. */
2853 struct frame
*f
= XFRAME (w
->frame
);
2854 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2856 struct glyph_matrix
*m2
;
2859 w2
= frame_row_to_window (root
, frame_from
);
2860 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2861 -nw', FROM_FRAME sometimes has no associated window.
2862 This check avoids a segfault if W2 is null. */
2865 m2
= w2
->current_matrix
;
2866 m2_from
= frame_from
- m2
->matrix_y
;
2867 copy_row_except_pointers (m
->rows
+ window_to
,
2868 m2
->rows
+ m2_from
);
2870 /* If frame line is empty, window line is empty, too. */
2871 if (!retained_p
[copy_from
[i
]])
2872 m
->rows
[window_to
].enabled_p
= false;
2876 else if (from_inside_window_p
)
2880 /* If there was a copy between windows, make sure glyph
2881 pointers are in sync with the frame matrix. */
2883 sync_window_with_frame_matrix_rows (w
);
2885 /* Check that no pointers are lost. */
2891 /* Next window on same level. */
2892 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2899 /* Check that window and frame matrices agree about their
2900 understanding where glyphs of the rows are to find. For each
2901 window in the window tree rooted at W, check that rows in the
2902 matrices of leaf window agree with their frame matrices about
2906 check_window_matrix_pointers (struct window
*w
)
2910 if (WINDOWP (w
->contents
))
2911 check_window_matrix_pointers (XWINDOW (w
->contents
));
2914 struct frame
*f
= XFRAME (w
->frame
);
2915 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2916 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2919 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2924 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2925 a window and FRAME_MATRIX is the corresponding frame matrix. For
2926 each row in WINDOW_MATRIX check that it's a slice of the
2927 corresponding frame row. If it isn't, abort. */
2930 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2931 struct glyph_matrix
*frame_matrix
)
2933 /* Row number in WINDOW_MATRIX. */
2936 /* Row number corresponding to I in FRAME_MATRIX. */
2937 int j
= window_matrix
->matrix_y
;
2939 /* For all rows check that the row in the window matrix is a
2940 slice of the row in the frame matrix. If it isn't we didn't
2941 mirror an operation on the frame matrix correctly. */
2942 while (i
< window_matrix
->nrows
)
2944 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2945 frame_matrix
->rows
+ j
))
2951 #endif /* GLYPH_DEBUG */
2955 /**********************************************************************
2956 VPOS and HPOS translations
2957 **********************************************************************/
2961 /* Translate vertical position VPOS which is relative to window W to a
2962 vertical position relative to W's frame. */
2965 window_to_frame_vpos (struct window
*w
, int vpos
)
2967 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2968 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2969 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2970 eassert (vpos
>= 0 && vpos
<= FRAME_TOTAL_LINES (XFRAME (w
->frame
)));
2975 /* Translate horizontal position HPOS which is relative to window W to
2976 a horizontal position relative to W's frame. */
2979 window_to_frame_hpos (struct window
*w
, int hpos
)
2981 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2982 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2986 #endif /* GLYPH_DEBUG */
2990 /**********************************************************************
2992 **********************************************************************/
2994 /* Redraw frame F. */
2997 redraw_frame (struct frame
*f
)
2999 /* Error if F has no glyphs. */
3000 eassert (f
->glyphs_initialized_p
);
3002 if (FRAME_MSDOS_P (f
))
3003 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3005 clear_current_matrices (f
);
3008 /* Mark all windows as inaccurate, so that every window will have
3009 its redisplay done. */
3010 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3011 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), true);
3012 f
->garbaged
= false;
3015 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3016 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3017 If FRAME is omitted or nil, the selected frame is used. */)
3020 redraw_frame (decode_live_frame (frame
));
3024 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3025 doc
: /* Clear and redisplay all visible frames. */)
3028 Lisp_Object tail
, frame
;
3030 FOR_EACH_FRAME (tail
, frame
)
3031 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3032 redraw_frame (XFRAME (frame
));
3039 /***********************************************************************
3041 ***********************************************************************/
3043 /* Update frame F based on the data in desired matrices.
3045 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3046 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3048 Value is true if redisplay was stopped due to pending input. */
3051 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3053 /* True means display has been paused because of pending input. */
3055 struct window
*root_window
= XWINDOW (f
->root_window
);
3057 if (redisplay_dont_pause
)
3059 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3065 if (FRAME_WINDOW_P (f
))
3067 /* We are working on window matrix basis. All windows whose
3068 flag must_be_updated_p is set have to be updated. */
3070 /* Record that we are not working on frame matrices. */
3071 set_frame_matrix_frame (NULL
);
3073 /* Update all windows in the window tree of F, maybe stopping
3074 when pending input is detected. */
3077 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3078 /* Update the menu bar on X frames that don't have toolkit
3080 if (WINDOWP (f
->menu_bar_window
))
3081 update_window (XWINDOW (f
->menu_bar_window
), true);
3084 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3085 /* Update the tool-bar window, if present. */
3086 if (WINDOWP (f
->tool_bar_window
))
3088 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3090 /* Update tool-bar window. */
3091 if (w
->must_be_updated_p
)
3095 update_window (w
, true);
3096 w
->must_be_updated_p
= false;
3098 /* Swap tool-bar strings. We swap because we want to
3100 tem
= f
->current_tool_bar_string
;
3101 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3102 fset_desired_tool_bar_string (f
, tem
);
3107 /* Update windows. */
3108 paused_p
= update_window_tree (root_window
, force_p
);
3113 /* We are working on frame matrix basis. Set the frame on whose
3114 frame matrix we operate. */
3115 set_frame_matrix_frame (f
);
3117 /* Build F's desired matrix from window matrices. */
3118 build_frame_matrix (f
);
3120 /* Update the display. */
3122 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
, 1, false);
3125 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3127 if (FRAME_TTY (f
)->termscript
)
3128 fflush_unlocked (FRAME_TTY (f
)->termscript
);
3129 if (FRAME_TERMCAP_P (f
))
3130 fflush_unlocked (FRAME_TTY (f
)->output
);
3133 /* Check window matrices for lost pointers. */
3135 check_window_matrix_pointers (root_window
);
3136 add_frame_display_history (f
, paused_p
);
3141 /* Reset flags indicating that a window should be updated. */
3142 set_window_update_flags (root_window
, false);
3144 display_completed
= !paused_p
;
3148 /* Update a TTY frame F that has a menu dropped down over some of its
3149 glyphs. This is like the second part of update_frame, but it
3150 doesn't call build_frame_matrix, because we already have the
3151 desired matrix prepared, and don't want it to be overwritten by the
3152 text of the normal display.
3154 ROW and COL, if non-negative, are the row and column of the TTY
3155 frame where to position the cursor after the frame update is
3156 complete. Negative values mean ask update_frame_1 to position the
3157 cursor "normally", i.e. at point in the selected window. */
3159 update_frame_with_menu (struct frame
*f
, int row
, int col
)
3161 struct window
*root_window
= XWINDOW (f
->root_window
);
3162 bool paused_p
, cursor_at_point_p
;
3164 eassert (FRAME_TERMCAP_P (f
));
3166 /* We are working on frame matrix basis. Set the frame on whose
3167 frame matrix we operate. */
3168 set_frame_matrix_frame (f
);
3170 /* Update the display. */
3172 cursor_at_point_p
= !(row
>= 0 && col
>= 0);
3173 /* Force update_frame_1 not to stop due to pending input, and not
3175 paused_p
= update_frame_1 (f
, 1, 1, cursor_at_point_p
, true);
3176 /* ROW and COL tell us where in the menu to position the cursor, so
3177 that screen readers know the active region on the screen. */
3178 if (!cursor_at_point_p
)
3179 cursor_to (f
, row
, col
);
3182 if (FRAME_TTY (f
)->termscript
)
3183 fflush_unlocked (FRAME_TTY (f
)->termscript
);
3184 fflush_unlocked (FRAME_TTY (f
)->output
);
3185 /* Check window matrices for lost pointers. */
3188 /* We cannot possibly survive the matrix pointers check, since
3189 we have overwritten parts of the frame glyph matrix without
3190 making any updates to the window matrices. */
3191 check_window_matrix_pointers (root_window
);
3193 add_frame_display_history (f
, paused_p
);
3196 /* Reset flags indicating that a window should be updated. */
3197 set_window_update_flags (root_window
, false);
3198 display_completed
= !paused_p
;
3202 /************************************************************************
3203 Window-based updates
3204 ************************************************************************/
3206 /* Perform updates in window tree rooted at W.
3207 If FORCE_P, don't stop updating if input is pending. */
3210 update_window_tree (struct window
*w
, bool force_p
)
3214 while (w
&& !paused_p
)
3216 if (WINDOWP (w
->contents
))
3217 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3218 else if (w
->must_be_updated_p
)
3219 paused_p
|= update_window (w
, force_p
);
3221 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3228 /* Update window W if its flag must_be_updated_p is set.
3229 If FORCE_P, don't stop updating if input is pending. */
3232 update_single_window (struct window
*w
)
3234 if (w
->must_be_updated_p
)
3236 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3238 /* Record that this is not a frame-based redisplay. */
3239 set_frame_matrix_frame (NULL
);
3243 update_window (w
, true);
3246 /* Reset flag in W. */
3247 w
->must_be_updated_p
= false;
3251 #ifdef HAVE_WINDOW_SYSTEM
3253 /* Redraw lines from the current matrix of window W that are
3254 overlapped by other rows. YB is bottom-most y-position in W. */
3257 redraw_overlapped_rows (struct window
*w
, int yb
)
3260 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3262 /* If rows overlapping others have been changed, the rows being
3263 overlapped have to be redrawn. This won't draw lines that have
3264 already been drawn in update_window_line because overlapped_p in
3265 desired rows is 0, so after row assignment overlapped_p in
3266 current rows is 0. */
3267 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3269 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3271 if (!row
->enabled_p
)
3273 else if (row
->mode_line_p
)
3276 if (row
->overlapped_p
)
3278 enum glyph_row_area area
;
3280 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3282 output_cursor_to (w
, i
, 0, row
->y
,
3283 area
== TEXT_AREA
? row
->x
: 0);
3284 if (row
->used
[area
])
3285 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3286 area
, row
->used
[area
]);
3287 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3290 row
->overlapped_p
= 0;
3293 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3299 /* Redraw lines from the current matrix of window W that overlap
3300 others. YB is bottom-most y-position in W. */
3303 redraw_overlapping_rows (struct window
*w
, int yb
)
3306 struct glyph_row
*row
;
3307 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3309 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3311 row
= w
->current_matrix
->rows
+ i
;
3313 if (!row
->enabled_p
)
3315 else if (row
->mode_line_p
)
3318 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3320 if (row
->overlapping_p
)
3324 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3325 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3326 overlaps
|= OVERLAPS_PRED
;
3327 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3328 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3329 overlaps
|= OVERLAPS_SUCC
;
3333 if (row
->used
[LEFT_MARGIN_AREA
])
3334 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3336 if (row
->used
[TEXT_AREA
])
3337 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3339 if (row
->used
[RIGHT_MARGIN_AREA
])
3340 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3342 /* Record in neighbor rows that ROW overwrites part of
3344 if (overlaps
& OVERLAPS_PRED
)
3345 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3346 if (overlaps
& OVERLAPS_SUCC
)
3347 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3356 #endif /* HAVE_WINDOW_SYSTEM */
3359 #if defined GLYPH_DEBUG && 0
3361 /* Check that no row in the current matrix of window W is enabled
3362 which is below what's displayed in the window. */
3365 check_current_matrix_flags (struct window
*w
)
3367 bool last_seen_p
= 0;
3368 int i
, yb
= window_text_bottom_y (w
);
3370 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3372 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3373 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3375 else if (last_seen_p
&& row
->enabled_p
)
3380 #endif /* GLYPH_DEBUG */
3383 /* Update display of window W.
3384 If FORCE_P, don't stop updating when input is pending. */
3387 update_window (struct window
*w
, bool force_p
)
3389 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3391 int preempt_count
= baud_rate
/ 2400 + 1;
3392 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3394 /* Check that W's frame doesn't have glyph matrices. */
3395 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3398 /* Check pending input the first time so that we can quickly return. */
3400 detect_input_pending_ignore_squeezables ();
3402 /* If forced to complete the update, or if no input is pending, do
3404 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3406 struct glyph_row
*row
, *end
;
3407 struct glyph_row
*mode_line_row
;
3408 struct glyph_row
*header_line_row
;
3410 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3413 rif
->update_window_begin_hook (w
);
3414 yb
= window_text_bottom_y (w
);
3415 row
= MATRIX_ROW (desired_matrix
, 0);
3416 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3418 /* Take note of the header line, if there is one. We will
3419 update it below, after updating all of the window's lines. */
3420 if (row
->mode_line_p
)
3422 header_line_row
= row
;
3426 header_line_row
= NULL
;
3428 /* Update the mode line, if necessary. */
3429 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3430 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3432 mode_line_row
->y
= yb
+ WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
3433 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3435 &mouse_face_overwritten_p
);
3438 /* Find first enabled row. Optimizations in redisplay_internal
3439 may lead to an update with only one row enabled. There may
3440 be also completely empty matrices. */
3441 while (row
< end
&& !row
->enabled_p
)
3444 /* Try reusing part of the display by copying. */
3445 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3447 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3450 /* All rows were found to be equal. */
3456 /* We've scrolled the display. */
3462 /* Update the rest of the lines. */
3463 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3464 /* scrolling_window resets the enabled_p flag of the rows it
3465 reuses from current_matrix. */
3468 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3471 /* We'll have to play a little bit with when to
3472 detect_input_pending. If it's done too often,
3473 scrolling large windows with repeated scroll-up
3474 commands will too quickly pause redisplay. */
3475 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3476 detect_input_pending_ignore_squeezables ();
3477 changed_p
|= update_window_line (w
, vpos
,
3478 &mouse_face_overwritten_p
);
3480 /* Mark all rows below the last visible one in the current
3481 matrix as invalid. This is necessary because of
3482 variable line heights. Consider the case of three
3483 successive redisplays, where the first displays 5
3484 lines, the second 3 lines, and the third 5 lines again.
3485 If the second redisplay wouldn't mark rows in the
3486 current matrix invalid, the third redisplay might be
3487 tempted to optimize redisplay based on lines displayed
3488 in the first redisplay. */
3489 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3490 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3491 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, i
, false);
3494 /* Was display preempted? */
3495 paused_p
= row
< end
;
3499 /* Update the header line after scrolling because a new header
3500 line would otherwise overwrite lines at the top of the window
3501 that can be scrolled. */
3502 if (header_line_row
&& header_line_row
->enabled_p
)
3504 header_line_row
->y
= 0;
3505 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3508 /* Fix the appearance of overlapping/overlapped rows. */
3509 if (!paused_p
&& !w
->pseudo_window_p
)
3511 #ifdef HAVE_WINDOW_SYSTEM
3512 if (changed_p
&& rif
->fix_overlapping_area
)
3514 redraw_overlapped_rows (w
, yb
);
3515 redraw_overlapping_rows (w
, yb
);
3519 /* Make cursor visible at cursor position of W. */
3520 set_window_cursor_after_update (w
);
3522 #if 0 /* Check that current matrix invariants are satisfied. This is
3523 for debugging only. See the comment of check_matrix_invariants. */
3524 IF_DEBUG (check_matrix_invariants (w
));
3529 /* Remember the redisplay method used to display the matrix. */
3530 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3533 #ifdef HAVE_WINDOW_SYSTEM
3534 update_window_fringes (w
, 0);
3537 /* End the update of window W. Don't set the cursor if we
3538 paused updating the display because in this case,
3539 set_window_cursor_after_update hasn't been called, and
3540 W->output_cursor doesn't contain the cursor location. */
3541 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3547 /* check_current_matrix_flags (w); */
3548 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3551 xwidget_end_redisplay (w
, w
->current_matrix
);
3552 clear_glyph_matrix (desired_matrix
);
3558 /* Update the display of area AREA in window W, row number VPOS.
3559 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3562 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3563 enum glyph_row_area area
, int vpos
)
3565 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3566 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3568 /* Set cursor to start of glyphs, write them, and clear to the end
3569 of the area. I don't think that something more sophisticated is
3570 necessary here, since marginal areas will not be the default. */
3571 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3572 if (desired_row
->used
[area
])
3573 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3574 area
, desired_row
->used
[area
]);
3575 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3579 /* Update the display of the text area of row VPOS in window W.
3580 Value is true if display has changed. */
3583 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3585 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3586 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3587 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3590 /* If rows are at different X or Y, or rows have different height,
3591 or the current row is marked invalid, write the entire line. */
3592 if (!current_row
->enabled_p
3593 || desired_row
->y
!= current_row
->y
3594 || desired_row
->ascent
!= current_row
->ascent
3595 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3596 || desired_row
->phys_height
!= current_row
->phys_height
3597 || desired_row
->visible_height
!= current_row
->visible_height
3598 || current_row
->overlapped_p
3599 /* This next line is necessary for correctly redrawing
3600 mouse-face areas after scrolling and other operations.
3601 However, it causes excessive flickering when mouse is moved
3602 across the mode line. Luckily, turning it off for the mode
3603 line doesn't seem to hurt anything. -- cyd.
3604 But it is still needed for the header line. -- kfs. */
3605 || (current_row
->mouse_face_p
3606 && !(current_row
->mode_line_p
&& vpos
> 0))
3607 || current_row
->x
!= desired_row
->x
)
3609 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3611 if (desired_row
->used
[TEXT_AREA
])
3612 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3613 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3615 /* Clear to end of window. */
3616 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3619 /* This erases the cursor. We do this here because
3620 notice_overwritten_cursor cannot easily check this, which
3621 might indicate that the whole functionality of
3622 notice_overwritten_cursor would better be implemented here.
3623 On the other hand, we need notice_overwritten_cursor as long
3624 as mouse highlighting is done asynchronously outside of
3626 if (vpos
== w
->phys_cursor
.vpos
)
3627 w
->phys_cursor_on_p
= 0;
3632 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3633 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3634 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3635 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3636 bool abort_skipping
= 0;
3638 /* If the desired row extends its face to the text area end, and
3639 unless the current row also does so at the same position,
3640 make sure we write at least one glyph, so that the face
3641 extension actually takes place. */
3642 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3643 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3644 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3645 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3648 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3652 /* Loop over glyphs that current and desired row may have
3656 bool can_skip_p
= !abort_skipping
;
3658 /* Skip over glyphs that both rows have in common. These
3659 don't have to be written. We can't skip if the last
3660 current glyph overlaps the glyph to its right. For
3661 example, consider a current row of `if ' with the `f' in
3662 Courier bold so that it overlaps the ` ' to its right.
3663 If the desired row is ` ', we would skip over the space
3664 after the `if' and there would remain a pixel from the
3665 `f' on the screen. */
3666 if (overlapping_glyphs_p
&& i
> 0)
3668 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3671 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3673 can_skip_p
= (right
== 0 && !abort_skipping
);
3681 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3683 x
+= desired_glyph
->pixel_width
;
3684 ++desired_glyph
, ++current_glyph
, ++i
;
3687 /* Consider the case that the current row contains "xxx
3688 ppp ggg" in italic Courier font, and the desired row
3689 is "xxx ggg". The character `p' has lbearing, `g'
3690 has not. The loop above will stop in front of the
3691 first `p' in the current row. If we would start
3692 writing glyphs there, we wouldn't erase the lbearing
3693 of the `p'. The rest of the lbearing problem is then
3694 taken care of by draw_glyphs. */
3695 if (overlapping_glyphs_p
3697 && i
< current_row
->used
[TEXT_AREA
]
3698 && (current_row
->used
[TEXT_AREA
]
3699 != desired_row
->used
[TEXT_AREA
]))
3703 rif
->get_glyph_overhangs (current_glyph
,
3706 while (left
> 0 && i
> 0)
3708 --i
, --desired_glyph
, --current_glyph
;
3709 x
-= desired_glyph
->pixel_width
;
3710 left
-= desired_glyph
->pixel_width
;
3713 /* Abort the skipping algorithm if we end up before
3714 our starting point, to avoid looping (bug#1070).
3715 This can happen when the lbearing is larger than
3717 abort_skipping
= (i
< start_hpos
);
3721 /* Try to avoid writing the entire rest of the desired row
3722 by looking for a resync point. This mainly prevents
3723 mode line flickering in the case the mode line is in
3724 fixed-pitch font, which it usually will be. */
3725 if (i
< desired_row
->used
[TEXT_AREA
])
3727 int start_x
= x
, start_hpos
= i
;
3728 struct glyph
*start
= desired_glyph
;
3730 bool skip_first_p
= !can_skip_p
;
3732 /* Find the next glyph that's equal again. */
3735 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3738 x
+= desired_glyph
->pixel_width
;
3739 current_x
+= current_glyph
->pixel_width
;
3740 ++desired_glyph
, ++current_glyph
, ++i
;
3744 if (i
== start_hpos
|| x
!= current_x
)
3748 desired_glyph
= start
;
3752 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3753 rif
->write_glyphs (w
, updated_row
, start
,
3754 TEXT_AREA
, i
- start_hpos
);
3759 /* Write the rest. */
3760 if (i
< desired_row
->used
[TEXT_AREA
])
3762 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3763 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3764 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3768 /* Maybe clear to end of line. */
3769 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3771 /* If new row extends to the end of the text area, nothing
3772 has to be cleared, if and only if we did a write_glyphs
3773 above. This is made sure by setting desired_stop_pos
3774 appropriately above. */
3775 eassert (i
< desired_row
->used
[TEXT_AREA
]
3776 || ((desired_row
->used
[TEXT_AREA
]
3777 == current_row
->used
[TEXT_AREA
])
3778 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3780 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3782 /* If old row extends to the end of the text area, clear. */
3783 if (i
>= desired_row
->used
[TEXT_AREA
])
3784 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3785 desired_row
->pixel_width
);
3786 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3789 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3791 /* Otherwise clear to the end of the old row. Everything
3792 after that position should be clear already. */
3795 if (i
>= desired_row
->used
[TEXT_AREA
])
3796 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3797 desired_row
->pixel_width
);
3799 /* If cursor is displayed at the end of the line, make sure
3800 it's cleared. Nowadays we don't have a phys_cursor_glyph
3801 with which to erase the cursor (because this method
3802 doesn't work with lbearing/rbearing), so we must do it
3804 if (vpos
== w
->phys_cursor
.vpos
3805 && (desired_row
->reversed_p
3806 ? (w
->phys_cursor
.hpos
< 0)
3807 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3809 w
->phys_cursor_on_p
= 0;
3813 xlim
= current_row
->pixel_width
;
3814 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3823 /* Update row VPOS in window W. Value is true if display has been changed. */
3826 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3828 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3829 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3830 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3833 /* A row can be completely invisible in case a desired matrix was
3834 built with a vscroll and then make_cursor_line_fully_visible shifts
3835 the matrix. Make sure to make such rows current anyway, since
3836 we need the correct y-position, for example, in the current matrix. */
3837 if (desired_row
->mode_line_p
3838 || desired_row
->visible_height
> 0)
3840 eassert (desired_row
->enabled_p
);
3842 /* Update display of the left margin area, if there is one. */
3843 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3846 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3847 /* Setting this flag will ensure the vertical border, if
3848 any, between this window and the one on its left will be
3849 redrawn. This is necessary because updating the left
3850 margin area can potentially draw over the border. */
3851 current_row
->redraw_fringe_bitmaps_p
= 1;
3854 /* Update the display of the text area. */
3855 if (update_text_area (w
, desired_row
, vpos
))
3858 if (current_row
->mouse_face_p
)
3859 *mouse_face_overwritten_p
= 1;
3862 /* Update display of the right margin area, if there is one. */
3863 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3866 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3869 /* Draw truncation marks etc. */
3870 if (!current_row
->enabled_p
3871 || desired_row
->y
!= current_row
->y
3872 || desired_row
->visible_height
!= current_row
->visible_height
3873 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3874 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3875 || current_row
->redraw_fringe_bitmaps_p
3876 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3877 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3878 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3879 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3880 rif
->after_update_window_line_hook (w
, desired_row
);
3883 /* Update current_row from desired_row. */
3884 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3889 /* Set the cursor after an update of window W. This function may only
3890 be called from update_window. */
3893 set_window_cursor_after_update (struct window
*w
)
3895 struct frame
*f
= XFRAME (w
->frame
);
3896 int cx
, cy
, vpos
, hpos
;
3898 /* Not intended for frame matrix updates. */
3899 eassert (FRAME_WINDOW_P (f
));
3901 if (cursor_in_echo_area
3902 && !NILP (echo_area_buffer
[0])
3903 /* If we are showing a message instead of the mini-buffer,
3904 show the cursor for the message instead. */
3905 && XWINDOW (minibuf_window
) == w
3906 && EQ (minibuf_window
, echo_area_window
)
3907 /* These cases apply only to the frame that contains
3908 the active mini-buffer window. */
3909 && FRAME_HAS_MINIBUF_P (f
)
3910 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3912 cx
= cy
= vpos
= hpos
= 0;
3914 /* If the mini-buffer is several lines high, find the last
3915 line that has any text on it. Note: either all lines
3916 are enabled or none. Otherwise we wouldn't be able to
3918 struct glyph_row
*last_row
= NULL
;
3919 int yb
= window_text_bottom_y (w
);
3921 for (struct glyph_row
*row
= w
->current_matrix
->rows
;
3922 row
->enabled_p
&& (!last_row
|| MATRIX_ROW_BOTTOM_Y (row
) <= yb
);
3924 if (row
->used
[TEXT_AREA
] && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3929 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3930 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3932 while (last
> start
&& last
->charpos
< 0)
3935 for (struct glyph
*glyph
= start
; glyph
< last
; glyph
++)
3937 cx
+= glyph
->pixel_width
;
3942 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3949 hpos
= w
->cursor
.hpos
;
3950 vpos
= w
->cursor
.vpos
;
3953 /* Window cursor can be out of sync for horizontally split windows.
3954 Horizontal position is -1 when cursor is on the left fringe. */
3955 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3956 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3957 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3961 /* Set WINDOW->must_be_updated_p to ON_P for all windows in
3962 the window tree rooted at W. */
3965 set_window_update_flags (struct window
*w
, bool on_p
)
3969 if (WINDOWP (w
->contents
))
3970 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3972 w
->must_be_updated_p
= on_p
;
3974 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3980 /***********************************************************************
3981 Window-Based Scrolling
3982 ***********************************************************************/
3984 /* Structure describing rows in scrolling_window. */
3988 /* Number of occurrences of this row in desired and current matrix. */
3989 int old_uses
, new_uses
;
3991 /* Vpos of row in new matrix. */
3992 int new_line_number
;
3994 /* Bucket index of this row_entry in the hash table row_table. */
3997 /* The row described by this entry. */
3998 struct glyph_row
*row
;
4000 /* Hash collision chain. */
4001 struct row_entry
*next
;
4004 /* A pool to allocate row_entry structures from, and the size of the
4005 pool. The pool is reallocated in scrolling_window when we find
4006 that we need a larger one. */
4008 static struct row_entry
*row_entry_pool
;
4009 static ptrdiff_t row_entry_pool_size
;
4011 /* Index of next free entry in row_entry_pool. */
4013 static ptrdiff_t row_entry_idx
;
4015 /* The hash table used during scrolling, and the table's size. This
4016 table is used to quickly identify equal rows in the desired and
4019 static struct row_entry
**row_table
;
4020 static ptrdiff_t row_table_size
;
4022 /* Vectors of pointers to row_entry structures belonging to the
4023 current and desired matrix, and the size of the vectors. */
4025 static struct row_entry
**old_lines
, **new_lines
;
4026 static ptrdiff_t old_lines_size
, new_lines_size
;
4028 /* A pool to allocate run structures from, and its size. */
4030 static struct run
*run_pool
;
4031 static ptrdiff_t runs_size
;
4033 /* A vector of runs of lines found during scrolling. */
4035 static struct run
**runs
;
4037 /* Add glyph row ROW to the scrolling hash table. */
4039 static struct row_entry
*
4040 add_row_entry (struct glyph_row
*row
)
4042 struct row_entry
*entry
;
4043 ptrdiff_t i
= row
->hash
% row_table_size
;
4045 entry
= row_table
[i
];
4046 eassert (entry
|| verify_row_hash (row
));
4047 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4048 entry
= entry
->next
;
4052 entry
= row_entry_pool
+ row_entry_idx
++;
4054 entry
->old_uses
= entry
->new_uses
= 0;
4055 entry
->new_line_number
= 0;
4057 entry
->next
= row_table
[i
];
4058 row_table
[i
] = entry
;
4065 /* Try to reuse part of the current display of W by scrolling lines.
4066 HEADER_LINE_P means W has a header line.
4068 The algorithm is taken from Communications of the ACM, Apr78 "A
4069 Technique for Isolating Differences Between Files." It should take
4072 A short outline of the steps of the algorithm
4074 1. Skip lines equal at the start and end of both matrices.
4076 2. Enter rows in the current and desired matrix into a symbol
4077 table, counting how often they appear in both matrices.
4079 3. Rows that appear exactly once in both matrices serve as anchors,
4080 i.e. we assume that such lines are likely to have been moved.
4082 4. Starting from anchor lines, extend regions to be scrolled both
4083 forward and backward.
4087 -1 if all rows were found to be equal.
4088 0 to indicate that we did not scroll the display, or
4089 1 if we did scroll. */
4092 scrolling_window (struct window
*w
, bool header_line_p
)
4094 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4095 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4096 int yb
= window_text_bottom_y (w
);
4098 int j
, first_old
, first_new
, last_old
, last_new
;
4101 struct row_entry
*entry
;
4102 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4104 /* Skip over rows equal at the start. */
4105 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4107 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4108 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4112 && !d
->redraw_fringe_bitmaps_p
4114 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4115 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4116 && row_equal_p (c
, d
, 1))
4119 d
->enabled_p
= false;
4125 #ifdef HAVE_XWIDGETS
4126 /* Currently this seems needed to detect xwidget movement reliably. */
4130 /* Give up if some rows in the desired matrix are not enabled. */
4131 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4134 first_old
= first_new
= i
;
4136 /* Set last_new to the index + 1 of the row that reaches the
4137 bottom boundary in the desired matrix. Give up if we find a
4138 disabled row before we reach the bottom boundary. */
4140 while (i
< desired_matrix
->nrows
- 1)
4144 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4146 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4155 /* Set last_old to the index + 1 of the row that reaches the bottom
4156 boundary in the current matrix. We don't look at the enabled
4157 flag here because we plan to reuse part of the display even if
4158 other parts are disabled. */
4160 while (i
< current_matrix
->nrows
- 1)
4162 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4171 /* Skip over rows equal at the bottom. */
4174 while (i
- 1 > first_new
4175 && j
- 1 > first_old
4176 && MATRIX_ROW_ENABLED_P (current_matrix
, j
- 1)
4177 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4178 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4179 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4180 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4181 MATRIX_ROW (current_matrix
, j
- 1), 1))
4186 /* Nothing to do if all rows are equal. */
4187 if (last_new
== first_new
)
4190 /* Check for integer overflow in size calculation.
4192 If next_almost_prime checks (N) for divisibility by 2..10, then
4193 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4194 So, set next_almost_prime_increment_max to 10.
4196 It's just a coincidence that next_almost_prime_increment_max ==
4197 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4198 13, then next_almost_prime_increment_max would be 14, e.g.,
4199 because next_almost_prime (113) would be 127. */
4201 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4202 enum { next_almost_prime_increment_max
= 10 };
4203 ptrdiff_t row_table_max
=
4204 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4205 - next_almost_prime_increment_max
);
4206 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4207 if (current_nrows_max
< current_matrix
->nrows
)
4208 memory_full (SIZE_MAX
);
4211 /* Reallocate vectors, tables etc. if necessary. */
4213 if (current_matrix
->nrows
> old_lines_size
)
4214 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4215 current_matrix
->nrows
- old_lines_size
,
4216 INT_MAX
, sizeof *old_lines
);
4218 if (desired_matrix
->nrows
> new_lines_size
)
4219 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4220 desired_matrix
->nrows
- new_lines_size
,
4221 INT_MAX
, sizeof *new_lines
);
4223 n
= desired_matrix
->nrows
;
4224 n
+= current_matrix
->nrows
;
4225 if (row_table_size
< 3 * n
)
4227 ptrdiff_t size
= next_almost_prime (3 * n
);
4228 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4229 row_table_size
= size
;
4230 memset (row_table
, 0, size
* sizeof *row_table
);
4233 if (n
> row_entry_pool_size
)
4234 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4235 n
- row_entry_pool_size
,
4236 -1, sizeof *row_entry_pool
);
4238 if (desired_matrix
->nrows
> runs_size
)
4240 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4241 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4242 runs_size
= desired_matrix
->nrows
;
4245 nruns
= run_idx
= 0;
4248 /* Add rows from the current and desired matrix to the hash table
4249 row_hash_table to be able to find equal ones quickly. */
4251 for (i
= first_old
; i
< last_old
; ++i
)
4253 if (MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4255 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4256 old_lines
[i
] = entry
;
4260 old_lines
[i
] = NULL
;
4263 for (i
= first_new
; i
< last_new
; ++i
)
4265 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4266 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4268 entry
->new_line_number
= i
;
4269 new_lines
[i
] = entry
;
4272 /* Identify moves based on lines that are unique and equal
4273 in both matrices. */
4274 for (i
= first_old
; i
< last_old
;)
4276 && old_lines
[i
]->old_uses
== 1
4277 && old_lines
[i
]->new_uses
== 1)
4280 int new_line
= old_lines
[i
]->new_line_number
;
4281 struct run
*run
= run_pool
+ run_idx
++;
4284 run
->current_vpos
= i
;
4285 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4286 run
->desired_vpos
= new_line
;
4287 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4289 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4291 /* Extend backward. */
4294 while (p
> first_old
4296 && old_lines
[p
] == new_lines
[q
])
4298 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4299 --run
->current_vpos
;
4300 --run
->desired_vpos
;
4303 run
->desired_y
-= h
;
4304 run
->current_y
-= h
;
4308 /* Extend forward. */
4313 && old_lines
[p
] == new_lines
[q
])
4315 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4321 /* Insert run into list of all runs. Order runs by copied
4322 pixel lines. Note that we record runs that don't have to
4323 be copied because they are already in place. This is done
4324 because we can avoid calling update_window_line in this
4326 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4328 for (q
= nruns
; q
> p
; --q
)
4329 runs
[q
] = runs
[q
- 1];
4338 /* Do the moves. Do it in a way that we don't overwrite something
4339 we want to copy later on. This is not solvable in general
4340 because there is only one display and we don't have a way to
4341 exchange areas on this display. Example:
4343 +-----------+ +-----------+
4345 +-----------+ --> +-----------+
4347 +-----------+ +-----------+
4349 Instead, prefer bigger moves, and invalidate moves that would
4350 copy from where we copied to. */
4352 for (i
= 0; i
< nruns
; ++i
)
4353 if (runs
[i
]->nrows
> 0)
4355 struct run
*r
= runs
[i
];
4357 /* Copy on the display. */
4358 if (r
->current_y
!= r
->desired_y
)
4360 rif
->clear_window_mouse_face (w
);
4361 rif
->scroll_run_hook (w
, r
);
4364 /* Truncate runs that copy to where we copied to, and
4365 invalidate runs that copy from where we copied to. */
4366 for (j
= nruns
- 1; j
> i
; --j
)
4368 struct run
*p
= runs
[j
];
4369 bool truncated_p
= 0;
4372 && p
->desired_y
< r
->desired_y
+ r
->height
4373 && p
->desired_y
+ p
->height
> r
->desired_y
)
4375 if (p
->desired_y
< r
->desired_y
)
4377 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4378 p
->height
= r
->desired_y
- p
->desired_y
;
4383 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4386 if (p
->nrows
<= nrows_copied
)
4390 int height_copied
= (r
->desired_y
+ r
->height
4393 p
->current_vpos
+= nrows_copied
;
4394 p
->desired_vpos
+= nrows_copied
;
4395 p
->nrows
-= nrows_copied
;
4396 p
->current_y
+= height_copied
;
4397 p
->desired_y
+= height_copied
;
4398 p
->height
-= height_copied
;
4404 if (r
->current_y
!= r
->desired_y
4405 /* The condition below is equivalent to
4406 ((p->current_y >= r->desired_y
4407 && p->current_y < r->desired_y + r->height)
4408 || (p->current_y + p->height > r->desired_y
4409 && (p->current_y + p->height
4410 <= r->desired_y + r->height)))
4411 because we have 0 < p->height <= r->height. */
4412 && p
->current_y
< r
->desired_y
+ r
->height
4413 && p
->current_y
+ p
->height
> r
->desired_y
)
4416 /* Reorder runs by copied pixel lines if truncated. */
4417 if (truncated_p
&& p
->nrows
> 0)
4421 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4423 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4428 /* Assign matrix rows. */
4429 for (j
= 0; j
< r
->nrows
; ++j
)
4431 struct glyph_row
*from
, *to
;
4432 bool to_overlapped_p
;
4434 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4435 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4436 to_overlapped_p
= to
->overlapped_p
;
4437 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4438 assign_row (to
, from
);
4439 /* The above `assign_row' actually does swap, so if we had
4440 an overlap in the copy destination of two runs, then
4441 the second run would assign a previously disabled bogus
4442 row. But thanks to the truncation code in the
4443 preceding for-loop, we no longer have such an overlap,
4444 and thus the assigned row should always be enabled. */
4445 eassert (to
->enabled_p
);
4446 from
->enabled_p
= false;
4447 to
->overlapped_p
= to_overlapped_p
;
4451 /* Clear the hash table, for the next time. */
4452 for (i
= 0; i
< row_entry_idx
; ++i
)
4453 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4455 /* Value is 1 to indicate that we scrolled the display. */
4461 /************************************************************************
4463 ************************************************************************/
4465 /* Update the desired frame matrix of frame F.
4467 FORCE_P means that the update should not be stopped by pending input.
4468 INHIBIT_ID_P means that scrolling by insert/delete should not be tried.
4469 SET_CURSOR_P false means do not set cursor at point in selected window.
4471 Value is true if update was stopped due to pending input. */
4474 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
,
4475 bool set_cursor_p
, bool updating_menu_p
)
4477 /* Frame matrices to work on. */
4478 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4479 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4482 int preempt_count
= baud_rate
/ 2400 + 1;
4484 eassert (current_matrix
&& desired_matrix
);
4486 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4487 calculate_costs (f
);
4489 if (preempt_count
<= 0)
4492 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4498 /* If we cannot insert/delete lines, it's no use trying it. */
4499 if (!FRAME_LINE_INS_DEL_OK (f
))
4502 /* See if any of the desired lines are enabled; don't compute for
4503 i/d line if just want cursor motion. */
4504 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4505 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4508 /* Try doing i/d line, if not yet inhibited. */
4509 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4510 force_p
|= scrolling (f
);
4512 /* Update the individual lines as needed. Do bottom line first. */
4513 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4514 update_frame_line (f
, desired_matrix
->nrows
- 1, updating_menu_p
);
4516 /* Now update the rest of the lines. */
4517 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4519 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4521 if (FRAME_TERMCAP_P (f
))
4523 /* Flush out every so many lines.
4524 Also flush out if likely to have more than 1k buffered
4525 otherwise. I'm told that some telnet connections get
4526 really screwed by more than 1k output at once. */
4527 FILE *display_output
= FRAME_TTY (f
)->output
;
4530 ptrdiff_t outq
= __fpending (display_output
);
4532 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4533 fflush_unlocked (display_output
);
4537 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4538 detect_input_pending_ignore_squeezables ();
4540 update_frame_line (f
, i
, updating_menu_p
);
4544 pause_p
= 0 < i
&& i
< FRAME_TOTAL_LINES (f
) - 1;
4546 /* Now just clean up termcap drivers and set cursor, etc. */
4547 if (!pause_p
&& set_cursor_p
)
4549 if ((cursor_in_echo_area
4550 /* If we are showing a message instead of the mini-buffer,
4551 show the cursor for the message instead of for the
4552 (now hidden) mini-buffer contents. */
4553 || (EQ (minibuf_window
, selected_window
)
4554 && EQ (minibuf_window
, echo_area_window
)
4555 && !NILP (echo_area_buffer
[0])))
4556 /* These cases apply only to the frame that contains
4557 the active mini-buffer window. */
4558 && FRAME_HAS_MINIBUF_P (f
)
4559 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4561 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4564 /* Put cursor at the end of the prompt. If the mini-buffer
4565 is several lines high, find the last line that has
4567 int row
= FRAME_TOTAL_LINES (f
);
4573 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4575 /* Frame rows are filled up with spaces that
4576 must be ignored here. */
4577 struct glyph_row
*r
= MATRIX_ROW (current_matrix
, row
);
4578 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4580 col
= r
->used
[TEXT_AREA
];
4581 while (0 < col
&& start
[col
- 1].charpos
< 0)
4585 while (row
> top
&& col
== 0);
4587 /* Make sure COL is not out of range. */
4588 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4590 /* If we have another row, advance cursor into it. */
4591 if (row
< FRAME_TOTAL_LINES (f
) - 1)
4593 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4596 /* Otherwise move it back in range. */
4598 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4601 cursor_to (f
, row
, col
);
4605 /* We have only one cursor on terminal frames. Use it to
4606 display the cursor of the selected window. */
4607 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4608 if (w
->cursor
.vpos
>= 0
4609 /* The cursor vpos may be temporarily out of bounds
4610 in the following situation: There is one window,
4611 with the cursor in the lower half of it. The window
4612 is split, and a message causes a redisplay before
4613 a new cursor position has been computed. */
4614 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4616 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4617 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4619 x
+= max (0, w
->left_margin_cols
);
4620 cursor_to (f
, y
, x
);
4627 clear_desired_matrices (f
);
4632 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4635 scrolling (struct frame
*frame
)
4637 int unchanged_at_top
, unchanged_at_bottom
;
4641 int height
= FRAME_TOTAL_LINES (frame
);
4642 int free_at_end_vpos
= height
;
4643 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4644 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4645 verify (sizeof (int) <= sizeof (unsigned));
4646 verify (alignof (unsigned) % alignof (int) == 0);
4649 SAFE_NALLOCA (old_hash
, 4, height
);
4650 unsigned *new_hash
= old_hash
+ height
;
4651 int *draw_cost
= (int *) (new_hash
+ height
);
4652 int *old_draw_cost
= draw_cost
+ height
;
4653 old_hash
= ptr_bounds_clip (old_hash
, height
* sizeof *old_hash
);
4654 new_hash
= ptr_bounds_clip (new_hash
, height
* sizeof *new_hash
);
4655 draw_cost
= ptr_bounds_clip (draw_cost
, height
* sizeof *draw_cost
);
4656 old_draw_cost
= ptr_bounds_clip (old_draw_cost
,
4657 height
* sizeof *old_draw_cost
);
4659 eassert (current_matrix
);
4661 /* Compute hash codes of all the lines. Also calculate number of
4662 changed lines, number of unchanged lines at the beginning, and
4663 number of unchanged lines at the end. */
4665 unchanged_at_top
= 0;
4666 unchanged_at_bottom
= height
;
4667 for (i
= 0; i
< height
; i
++)
4669 /* Give up on this scrolling if some old lines are not enabled. */
4670 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4675 old_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (current_matrix
, i
));
4676 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4678 /* This line cannot be redrawn, so don't let scrolling mess it. */
4679 new_hash
[i
] = old_hash
[i
];
4680 draw_cost
[i
] = SCROLL_INFINITY
;
4684 new_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (desired_matrix
, i
));
4685 draw_cost
[i
] = line_draw_cost (frame
, desired_matrix
, i
);
4688 if (old_hash
[i
] != new_hash
[i
])
4691 unchanged_at_bottom
= height
- i
- 1;
4693 else if (i
== unchanged_at_top
)
4695 old_draw_cost
[i
] = line_draw_cost (frame
, current_matrix
, i
);
4698 /* If changed lines are few, don't allow preemption, don't scroll. */
4699 if ((!FRAME_SCROLL_REGION_OK (frame
)
4700 && changed_lines
< baud_rate
/ 2400)
4701 || unchanged_at_bottom
== height
)
4707 window_size
= (height
- unchanged_at_top
4708 - unchanged_at_bottom
);
4710 if (FRAME_SCROLL_REGION_OK (frame
))
4711 free_at_end_vpos
-= unchanged_at_bottom
;
4712 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4713 free_at_end_vpos
= -1;
4715 /* Do id/calc only if small window, or slow terminal, or many lines
4716 in common between current frame and desired frame. But the
4717 window size must be at least 2. */
4718 if ((FRAME_SCROLL_REGION_OK (frame
)
4719 || window_size
< 18 || baud_rate
<= 2400
4721 < 10 * scrolling_max_lines_saved (unchanged_at_top
,
4722 height
- unchanged_at_bottom
,
4723 old_hash
, new_hash
, draw_cost
)))
4724 && 2 <= window_size
)
4725 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4726 draw_cost
+ unchanged_at_top
- 1,
4727 old_draw_cost
+ unchanged_at_top
- 1,
4728 old_hash
+ unchanged_at_top
- 1,
4729 new_hash
+ unchanged_at_top
- 1,
4730 free_at_end_vpos
- unchanged_at_top
);
4737 /* Count the number of blanks at the start of the vector of glyphs R
4738 which is LEN glyphs long. */
4741 count_blanks (struct glyph
*r
, int len
)
4745 for (i
= 0; i
< len
; ++i
)
4746 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4753 /* Count the number of glyphs in common at the start of the glyph
4754 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4755 of STR2. Value is the number of equal glyphs equal at the start. */
4758 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4760 struct glyph
*p1
= str1
;
4761 struct glyph
*p2
= str2
;
4765 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4772 /* Char insertion/deletion cost vector, from term.c */
4774 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4777 /* Perform a frame-based update on line VPOS in frame FRAME. */
4780 update_frame_line (struct frame
*f
, int vpos
, bool updating_menu_p
)
4782 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4784 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4785 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4786 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4787 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4788 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4789 bool must_write_whole_line_p
;
4790 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4791 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4792 != FACE_TTY_DEFAULT_BG_COLOR
);
4794 if (colored_spaces_p
)
4797 /* Current row not enabled means it has unknown contents. We must
4798 write the whole desired line in that case. */
4799 must_write_whole_line_p
= !current_row
->enabled_p
;
4800 if (must_write_whole_line_p
)
4807 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4808 olen
= current_row
->used
[TEXT_AREA
];
4810 /* Ignore trailing spaces, if we can. */
4811 if (!write_spaces_p
)
4812 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4816 current_row
->enabled_p
= true;
4817 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4819 /* For some reason, cursor is sometimes moved behind our back when a
4820 frame with a TTY menu is redrawn. Homing the cursor as below
4822 if (updating_menu_p
)
4823 cursor_to (f
, 0, 0);
4825 /* If desired line is empty, just clear the line. */
4826 if (!desired_row
->enabled_p
)
4832 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4833 nlen
= desired_row
->used
[TEXT_AREA
];
4834 nend
= nbody
+ nlen
;
4836 /* If display line has unknown contents, write the whole line. */
4837 if (must_write_whole_line_p
)
4839 /* Ignore spaces at the end, if we can. */
4840 if (!write_spaces_p
)
4841 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4844 /* Write the contents of the desired line. */
4847 cursor_to (f
, vpos
, 0);
4848 write_glyphs (f
, nbody
, nlen
);
4851 /* Don't call clear_end_of_line if we already wrote the whole
4852 line. The cursor will not be at the right margin in that
4853 case but in the line below. */
4854 if (nlen
< FRAME_TOTAL_COLS (f
))
4856 cursor_to (f
, vpos
, nlen
);
4857 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4860 /* Make sure we are in the right row, otherwise cursor movement
4861 with cmgoto might use `ch' in the wrong row. */
4862 cursor_to (f
, vpos
, 0);
4864 make_current (desired_matrix
, current_matrix
, vpos
);
4868 /* Pretend trailing spaces are not there at all,
4869 unless for one reason or another we must write all spaces. */
4870 if (!write_spaces_p
)
4871 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4874 /* If there's no i/d char, quickly do the best we can without it. */
4875 if (!FRAME_CHAR_INS_DEL_OK (f
))
4879 /* Find the first glyph in desired row that doesn't agree with
4880 a glyph in the current row, and write the rest from there on. */
4881 for (i
= 0; i
< nlen
; i
++)
4883 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4885 /* Find the end of the run of different glyphs. */
4889 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4890 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4893 /* Output this run of non-matching chars. */
4894 cursor_to (f
, vpos
, i
);
4895 write_glyphs (f
, nbody
+ i
, j
- i
);
4898 /* Now find the next non-match. */
4902 /* Clear the rest of the line, or the non-clear part of it. */
4905 cursor_to (f
, vpos
, nlen
);
4906 clear_end_of_line (f
, olen
);
4909 /* Make current row = desired row. */
4910 make_current (desired_matrix
, current_matrix
, vpos
);
4914 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4915 characters in a row. */
4919 /* If current line is blank, skip over initial spaces, if
4920 possible, and write the rest. */
4924 nsp
= count_blanks (nbody
, nlen
);
4928 cursor_to (f
, vpos
, nsp
);
4929 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4932 /* Exchange contents between current_frame and new_frame. */
4933 make_current (desired_matrix
, current_matrix
, vpos
);
4937 /* Compute number of leading blanks in old and new contents. */
4938 osp
= count_blanks (obody
, olen
);
4939 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4941 /* Compute number of matching chars starting with first non-blank. */
4942 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4943 nbody
+ nsp
, nbody
+ nlen
);
4945 /* Spaces in new match implicit space past the end of old. */
4946 /* A bug causing this to be a no-op was fixed in 18.29. */
4947 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4950 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4954 /* Avoid doing insert/delete char
4955 just cause number of leading spaces differs
4956 when the following text does not match. */
4957 if (begmatch
== 0 && osp
!= nsp
)
4958 osp
= nsp
= min (osp
, nsp
);
4960 /* Find matching characters at end of line */
4963 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4965 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4970 endmatch
= obody
+ olen
- op1
;
4972 /* tem gets the distance to insert or delete.
4973 endmatch is how many characters we save by doing so.
4976 tem
= (nlen
- nsp
) - (olen
- osp
);
4978 && (!FRAME_CHAR_INS_DEL_OK (f
)
4979 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4982 /* nsp - osp is the distance to insert or delete.
4983 If that is nonzero, begmatch is known to be nonzero also.
4984 begmatch + endmatch is how much we save by doing the ins/del.
4988 && (!FRAME_CHAR_INS_DEL_OK (f
)
4989 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
4993 osp
= nsp
= min (osp
, nsp
);
4996 /* Now go through the line, inserting, writing and
4997 deleting as appropriate. */
5001 cursor_to (f
, vpos
, nsp
);
5002 delete_glyphs (f
, osp
- nsp
);
5006 /* If going to delete chars later in line
5007 and insert earlier in the line,
5008 must delete first to avoid losing data in the insert */
5009 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5011 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5012 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5013 olen
= nlen
- (nsp
- osp
);
5015 cursor_to (f
, vpos
, osp
);
5016 insert_glyphs (f
, 0, nsp
- osp
);
5020 tem
= nsp
+ begmatch
+ endmatch
;
5021 if (nlen
!= tem
|| olen
!= tem
)
5023 if (!endmatch
|| nlen
== olen
)
5025 /* If new text being written reaches right margin, there is
5026 no need to do clear-to-eol at the end of this function
5027 (and it would not be safe, since cursor is not going to
5028 be "at the margin" after the text is done). */
5029 if (nlen
== FRAME_TOTAL_COLS (f
))
5032 /* Function write_glyphs is prepared to do nothing
5033 if passed a length <= 0. Check it here to avoid
5034 unnecessary cursor movement. */
5037 cursor_to (f
, vpos
, nsp
+ begmatch
);
5038 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5041 else if (nlen
> olen
)
5043 /* Here, we used to have the following simple code:
5044 ----------------------------------------
5045 write_glyphs (nbody + nsp + begmatch, olen - tem);
5046 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5047 ----------------------------------------
5048 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5049 is a padding glyph. */
5050 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5053 cursor_to (f
, vpos
, nsp
+ begmatch
);
5055 /* Calculate columns we can actually overwrite. */
5056 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5058 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5060 /* If we left columns to be overwritten, we must delete them. */
5061 del
= olen
- tem
- out
;
5063 delete_glyphs (f
, del
);
5065 /* At last, we insert columns not yet written out. */
5066 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5069 else if (olen
> nlen
)
5071 cursor_to (f
, vpos
, nsp
+ begmatch
);
5072 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5073 delete_glyphs (f
, olen
- nlen
);
5079 /* If any unerased characters remain after the new line, erase them. */
5082 cursor_to (f
, vpos
, nlen
);
5083 clear_end_of_line (f
, olen
);
5086 /* Exchange contents between current_frame and new_frame. */
5087 make_current (desired_matrix
, current_matrix
, vpos
);
5092 /***********************************************************************
5093 X/Y Position -> Buffer Position
5094 ***********************************************************************/
5096 /* Determine what's under window-relative pixel position (*X, *Y).
5097 Return the OBJECT (string or buffer) that's there.
5098 Return in *POS the position in that object.
5099 Adjust *X and *Y to character positions.
5100 Return in *DX and *DY the pixel coordinates of the click,
5101 relative to the top left corner of OBJECT, or relative to
5102 the top left corner of the character glyph at (*X, *Y)
5104 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5105 if the coordinates point to an empty area of the display. */
5108 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
)
5111 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5112 struct text_pos startp
;
5114 struct glyph_row
*row
;
5115 #ifdef HAVE_WINDOW_SYSTEM
5116 struct image
*img
= 0;
5118 int x0
, x1
, to_x
, it_vpos
;
5119 void *itdata
= NULL
;
5121 /* We used to set current_buffer directly here, but that does the
5122 wrong thing with `face-remapping-alist' (bug#2044). */
5123 Fset_buffer (w
->contents
);
5124 itdata
= bidi_shelve_cache ();
5125 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5126 start_display (&it
, w
, startp
);
5129 /* First, move to the beginning of the row corresponding to *Y. We
5130 need to be in that row to get the correct value of base paragraph
5131 direction for the text at (*X, *Y). */
5132 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5134 /* TO_X is the pixel position that the iterator will compute for the
5137 if (it
.bidi_it
.paragraph_dir
== R2L
)
5138 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5139 text area. This is because the iterator, even in R2L
5140 paragraphs, delivers glyphs as if they started at the left
5141 margin of the window. (When we actually produce glyphs for
5142 display, we reverse their order in PRODUCE_GLYPHS, but the
5143 iterator doesn't know about that.) The following line adjusts
5144 the pixel position to the iterator geometry, which is what
5145 move_it_* routines use. (The -1 is because in a window whose
5146 text-area width is W, the rightmost pixel position is W-1, and
5147 it should be mirrored into zero pixel position.) */
5148 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5150 /* We need to add it.first_visible_x because iterator positions
5151 include the hscroll. */
5152 to_x
+= it
.first_visible_x
;
5154 /* If we are hscrolling only the current line, and Y is at the line
5155 containing point, augment TO_X with the hscroll amount of the
5157 if (it
.line_wrap
== TRUNCATE
5158 && EQ (automatic_hscrolling
, Qcurrent_line
) && IT_CHARPOS (it
) < PT
)
5161 void *it2data
= bidi_shelve_cache ();
5162 it2
.last_visible_x
= 1000000;
5163 /* If the line at Y shows point, the call below to
5164 move_it_in_display_line will succeed in reaching point. */
5165 move_it_in_display_line (&it2
, PT
, -1, MOVE_TO_POS
);
5166 if (IT_CHARPOS (it2
) >= PT
)
5168 to_x
+= (w
->hscroll
- w
->min_hscroll
) * FRAME_COLUMN_WIDTH (it
.f
);
5169 /* We need to pretend the window is hscrolled, so that
5170 move_it_in_display_line below will DTRT with TO_X. */
5171 it
.first_visible_x
+= w
->hscroll
* FRAME_COLUMN_WIDTH (it
.f
);
5172 it
.last_visible_x
+= w
->hscroll
* FRAME_COLUMN_WIDTH (it
.f
);
5174 bidi_unshelve_cache (it2data
, 0);
5177 /* Now move horizontally in the row to the glyph under *X. Second
5178 argument is ZV to prevent move_it_in_display_line from matching
5179 based on buffer positions. */
5180 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5181 bidi_unshelve_cache (itdata
, 0);
5183 Fset_buffer (old_current_buffer
);
5185 *dx
= to_x
- it
.current_x
;
5186 *dy
= *y
- it
.current_y
;
5188 string
= w
->contents
;
5189 if (STRINGP (it
.string
))
5192 if (it
.what
== IT_COMPOSITION
5193 && it
.cmp_it
.nchars
> 1
5194 && it
.cmp_it
.reversed_p
)
5196 /* The current display element is a grapheme cluster in a
5197 composition. In that case, we need the position of the first
5198 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5199 it.current points to the last character of the cluster, thus
5200 we must move back to the first character of the same
5202 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5203 if (STRINGP (it
.string
))
5204 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5206 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5207 CHARPOS (pos
->pos
));
5210 #ifdef HAVE_WINDOW_SYSTEM
5211 if (it
.what
== IT_IMAGE
)
5213 /* Note that this ignores images that are fringe bitmaps,
5214 because their image ID is zero, and so IMAGE_OPT_FROM_ID will
5215 return NULL. This is okay, since fringe bitmaps are not
5216 displayed in the text area, and so are never the object we
5217 are interested in. */
5218 img
= IMAGE_OPT_FROM_ID (it
.f
, it
.image_id
);
5219 if (img
&& !NILP (img
->spec
))
5220 *object
= img
->spec
;
5224 /* IT's vpos counts from the glyph row that includes the window's
5225 start position, i.e. it excludes the header-line row, but
5226 MATRIX_ROW includes the header-line row. Adjust for a possible
5228 it_vpos
= it
.vpos
+ window_wants_header_line (w
);
5229 if (it_vpos
< w
->current_matrix
->nrows
5230 && (row
= MATRIX_ROW (w
->current_matrix
, it_vpos
),
5233 if (it
.hpos
< row
->used
[TEXT_AREA
])
5235 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5236 #ifdef HAVE_WINDOW_SYSTEM
5239 *dy
-= row
->ascent
- glyph
->ascent
;
5240 *dx
+= glyph
->slice
.img
.x
;
5241 *dy
+= glyph
->slice
.img
.y
;
5242 /* Image slices positions are still relative to the entire image */
5243 *width
= img
->width
;
5244 *height
= img
->height
;
5249 *width
= glyph
->pixel_width
;
5250 *height
= glyph
->ascent
+ glyph
->descent
;
5256 *height
= row
->height
;
5261 *width
= *height
= 0;
5264 /* Add extra (default width) columns if clicked after EOL. */
5265 x1
= max (0, it
.current_x
+ it
.pixel_width
);
5267 it
.hpos
+= (to_x
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5276 /* Value is the string under window-relative coordinates X/Y in the
5277 mode line or header line (PART says which) of window W, or nil if none.
5278 *CHARPOS is set to the position in the string returned. */
5281 mode_line_string (struct window
*w
, enum window_part part
,
5282 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5283 int *dx
, int *dy
, int *width
, int *height
)
5285 struct glyph_row
*row
;
5286 struct glyph
*glyph
, *end
;
5288 Lisp_Object string
= Qnil
;
5290 if (part
== ON_MODE_LINE
)
5291 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5293 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5295 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5297 if (row
->mode_line_p
&& row
->enabled_p
)
5299 /* Find the glyph under X. If we find one with a string object,
5300 it's the one we were looking for. */
5301 glyph
= row
->glyphs
[TEXT_AREA
];
5302 end
= glyph
+ row
->used
[TEXT_AREA
];
5303 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5304 x0
-= glyph
->pixel_width
;
5305 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5308 string
= glyph
->object
;
5309 *charpos
= glyph
->charpos
;
5310 *width
= glyph
->pixel_width
;
5311 *height
= glyph
->ascent
+ glyph
->descent
;
5312 #ifdef HAVE_WINDOW_SYSTEM
5313 if (glyph
->type
== IMAGE_GLYPH
)
5316 img
= IMAGE_OPT_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5318 *object
= img
->spec
;
5319 y0
-= row
->ascent
- glyph
->ascent
;
5325 /* Add extra (default width) columns if clicked after EOL. */
5326 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5328 *height
= row
->height
;
5335 *width
= *height
= 0;
5345 /* Value is the string under window-relative coordinates X/Y in either
5346 marginal area, or nil if none. *CHARPOS is set to the position in
5347 the string returned. */
5350 marginal_area_string (struct window
*w
, enum window_part part
,
5351 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5352 int *dx
, int *dy
, int *width
, int *height
)
5354 struct glyph_row
*row
= w
->current_matrix
->rows
;
5355 struct glyph
*glyph
, *end
;
5356 int x0
, y0
, i
, wy
= *y
;
5358 Lisp_Object string
= Qnil
;
5360 if (part
== ON_LEFT_MARGIN
)
5361 area
= LEFT_MARGIN_AREA
;
5362 else if (part
== ON_RIGHT_MARGIN
)
5363 area
= RIGHT_MARGIN_AREA
;
5367 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5368 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5371 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5375 /* Find the glyph under X. If we find one with a string object,
5376 it's the one we were looking for. */
5377 if (area
== RIGHT_MARGIN_AREA
)
5378 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5379 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5380 : WINDOW_FRINGES_WIDTH (w
))
5381 + window_box_width (w
, LEFT_MARGIN_AREA
)
5382 + window_box_width (w
, TEXT_AREA
));
5384 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5385 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5388 glyph
= row
->glyphs
[area
];
5389 end
= glyph
+ row
->used
[area
];
5390 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5391 x0
-= glyph
->pixel_width
;
5392 *x
= glyph
- row
->glyphs
[area
];
5395 string
= glyph
->object
;
5396 *charpos
= glyph
->charpos
;
5397 *width
= glyph
->pixel_width
;
5398 *height
= glyph
->ascent
+ glyph
->descent
;
5399 #ifdef HAVE_WINDOW_SYSTEM
5400 if (glyph
->type
== IMAGE_GLYPH
)
5403 img
= IMAGE_OPT_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5405 *object
= img
->spec
;
5406 y0
-= row
->ascent
- glyph
->ascent
;
5407 x0
+= glyph
->slice
.img
.x
;
5408 y0
+= glyph
->slice
.img
.y
;
5414 /* Add extra (default width) columns if clicked after EOL. */
5415 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5417 *height
= row
->height
;
5424 *width
= *height
= 0;
5434 /***********************************************************************
5435 Changing Frame Sizes
5436 ***********************************************************************/
5440 static void deliver_window_change_signal (int);
5443 handle_window_change_signal (int sig
)
5446 struct tty_display_info
*tty
;
5448 /* The frame size change obviously applies to a single
5449 termcap-controlled terminal, but we can't decide which.
5450 Therefore, we resize the frames corresponding to each tty.
5452 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5454 if (! tty
->term_initted
)
5457 /* Suspended tty frames have tty->input == NULL avoid trying to
5462 get_tty_size (fileno (tty
->input
), &width
, &height
);
5464 if (width
> 5 && height
> 2) {
5465 Lisp_Object tail
, frame
;
5467 FOR_EACH_FRAME (tail
, frame
)
5468 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5469 /* Record the new sizes, but don't reallocate the data
5470 structures now. Let that be done later outside of the
5472 change_frame_size (XFRAME (frame
), width
,
5473 height
- FRAME_MENU_BAR_LINES (XFRAME (frame
)),
5480 deliver_window_change_signal (int sig
)
5482 deliver_process_signal (sig
, handle_window_change_signal
);
5484 #endif /* SIGWINCH */
5487 /* Do any change in frame size that was requested by a signal.
5488 SAFE means this function is called from a place where it is
5489 safe to change frame sizes while a redisplay is in progress. */
5492 do_pending_window_change (bool safe
)
5494 /* If window change signal handler should have run before, run it now. */
5495 if (redisplaying_p
&& !safe
)
5498 while (delayed_size_change
)
5500 Lisp_Object tail
, frame
;
5502 delayed_size_change
= 0;
5504 FOR_EACH_FRAME (tail
, frame
)
5506 struct frame
*f
= XFRAME (frame
);
5508 if (f
->new_height
!= 0 || f
->new_width
!= 0)
5509 change_frame_size (f
, f
->new_width
, f
->new_height
,
5510 0, 0, safe
, f
->new_pixelwise
);
5517 change_frame_size_1 (struct frame
*f
, int new_width
, int new_height
,
5518 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5520 /* If we can't deal with the change now, queue it for later. */
5521 if (delay
|| (redisplaying_p
&& !safe
))
5523 f
->new_width
= new_width
;
5524 f
->new_height
= new_height
;
5525 f
->new_pixelwise
= pixelwise
;
5526 delayed_size_change
= 1;
5530 /* This size-change overrides any pending one for this frame. */
5533 f
->new_pixelwise
= 0;
5535 /* If an argument is zero, set it to the current value. */
5538 new_width
= (new_width
<= 0) ? FRAME_TEXT_WIDTH (f
) : new_width
;
5539 new_height
= (new_height
<= 0) ? FRAME_TEXT_HEIGHT (f
) : new_height
;
5543 new_width
= (((new_width
<= 0) ? FRAME_COLS (f
) : new_width
)
5544 * FRAME_COLUMN_WIDTH (f
));
5545 new_height
= (((new_height
<= 0) ? FRAME_LINES (f
) : new_height
)
5546 * FRAME_LINE_HEIGHT (f
));
5549 /* Adjust frame size but make sure x_set_window_size does not
5551 adjust_frame_size (f
, new_width
, new_height
, 5, pretend
,
5552 Qchange_frame_size
);
5557 /* Change text height/width of frame F. Values may be given as zero to
5558 indicate that no change is needed.
5560 If DELAY, assume we're being called from a signal handler, and queue
5561 the change for later - perhaps the next redisplay. Since this tries
5562 to resize windows, we can't call it from a signal handler.
5564 SAFE means this function is called from a place where it's safe to
5565 change frame sizes while a redisplay is in progress. */
5567 change_frame_size (struct frame
*f
, int new_width
, int new_height
,
5568 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5570 Lisp_Object tail
, frame
;
5572 if (FRAME_MSDOS_P (f
))
5574 /* On MS-DOS, all frames use the same screen, so a change in
5575 size affects all frames. Termcap now supports multiple
5577 FOR_EACH_FRAME (tail
, frame
)
5578 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5579 change_frame_size_1 (XFRAME (frame
), new_width
, new_height
,
5580 pretend
, delay
, safe
, pixelwise
);
5583 change_frame_size_1 (f
, new_width
, new_height
, pretend
, delay
, safe
,
5587 /***********************************************************************
5588 Terminal Related Lisp Functions
5589 ***********************************************************************/
5591 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5592 1, 1, "FOpen termscript file: ",
5593 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5594 FILE = nil means just close any termscript file currently open. */)
5597 struct tty_display_info
*tty
;
5599 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5600 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5601 error ("Current frame is not on a tty device");
5605 if (tty
->termscript
!= 0)
5608 fclose (tty
->termscript
);
5609 tty
->termscript
= 0;
5615 file
= Fexpand_file_name (file
, Qnil
);
5616 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5617 if (tty
->termscript
== 0)
5618 report_file_error ("Opening termscript", file
);
5624 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5625 Ssend_string_to_terminal
, 1, 2, 0,
5626 doc
: /* Send STRING to the terminal without alteration.
5627 Control characters in STRING will have terminal-dependent effects.
5629 Optional parameter TERMINAL specifies the tty terminal device to use.
5630 It may be a terminal object, a frame, or nil for the terminal used by
5631 the currently selected frame. In batch mode, STRING is sent to stdout
5632 when TERMINAL is nil. */)
5633 (Lisp_Object string
, Lisp_Object terminal
)
5635 struct terminal
*t
= decode_live_terminal (terminal
);
5638 /* ??? Perhaps we should do something special for multibyte strings here. */
5639 CHECK_STRING (string
);
5642 if (t
->type
== output_initial
)
5644 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5645 error ("Device %d is not a termcap terminal device", t
->id
);
5648 struct tty_display_info
*tty
= t
->display_info
.tty
;
5651 error ("Terminal is currently suspended");
5653 if (tty
->termscript
)
5655 fwrite_unlocked (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5656 fflush_unlocked (tty
->termscript
);
5660 fwrite_unlocked (SDATA (string
), 1, SBYTES (string
), out
);
5661 fflush_unlocked (out
);
5667 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5668 doc
: /* Beep, or flash the screen.
5669 Also, unless an argument is given,
5670 terminate any keyboard macro currently executing. */)
5676 putchar_unlocked (07);
5678 ring_bell (XFRAME (selected_frame
));
5687 bitch_at_user (void)
5690 putchar_unlocked (07);
5691 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5694 = "Keyboard macro terminated by a command ringing the bell";
5695 Fsignal (Quser_error
, list1 (build_string (msg
)));
5698 ring_bell (XFRAME (selected_frame
));
5703 /***********************************************************************
5705 ***********************************************************************/
5707 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5708 doc
: /* Pause, without updating display, for SECONDS seconds.
5709 SECONDS may be a floating-point value, meaning that you can wait for a
5710 fraction of a second. Optional second arg MILLISECONDS specifies an
5711 additional wait period, in milliseconds; this is for backwards compatibility.
5712 \(Not all operating systems support waiting for a fraction of a second.) */)
5713 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5715 double duration
= extract_float (seconds
);
5717 if (!NILP (milliseconds
))
5719 CHECK_FIXNUM (milliseconds
);
5720 duration
+= XFIXNUM (milliseconds
) / 1000.0;
5725 struct timespec t
= dtotimespec (duration
);
5726 struct timespec tend
= timespec_add (current_timespec (), t
);
5728 /* wait_reading_process_output returns as soon as it detects
5729 output from any subprocess, so we wait in a loop until the
5732 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5733 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5734 t
= timespec_sub (tend
, current_timespec ());
5735 } while (timespec_sign (t
) > 0);
5742 /* This is just like wait_reading_process_output, except that
5745 TIMEOUT is number of seconds to wait (float or integer),
5746 or t to wait forever.
5747 READING is true if reading input.
5748 If DISPLAY_OPTION is >0 display process output while waiting.
5749 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5753 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5757 bool do_display
= display_option
> 0;
5759 swallow_events (do_display
);
5761 if ((detect_input_pending_run_timers (do_display
))
5762 || !NILP (Vexecuting_kbd_macro
))
5765 if (display_option
> 1)
5766 redisplay_preserve_echo_area (2);
5768 if (INTEGERP (timeout
))
5770 if (integer_to_intmax (timeout
, &sec
))
5774 sec
= min (sec
, WAIT_READING_MAX
);
5778 if (NILP (Fnatnump (timeout
)))
5780 sec
= WAIT_READING_MAX
;
5784 else if (FLOATP (timeout
))
5786 double seconds
= XFLOAT_DATA (timeout
);
5787 if (! (0 < seconds
))
5791 struct timespec t
= dtotimespec (seconds
);
5792 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5796 else if (EQ (timeout
, Qt
))
5802 wrong_type_argument (Qnumberp
, timeout
);
5809 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5812 return detect_input_pending () ? Qnil
: Qt
;
5816 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5817 doc
: /* Perform redisplay.
5818 Optional arg FORCE, if non-nil, prevents redisplay from being
5819 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5820 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5821 preempted by arriving input, so FORCE does nothing.
5823 Return t if redisplay was performed, nil if redisplay was preempted
5824 immediately by pending input. */)
5829 swallow_events (true);
5830 if ((detect_input_pending_run_timers (1)
5831 && NILP (force
) && !redisplay_dont_pause
)
5832 || !NILP (Vexecuting_kbd_macro
))
5835 count
= SPECPDL_INDEX ();
5836 if (!NILP (force
) && !redisplay_dont_pause
)
5837 specbind (Qredisplay_dont_pause
, Qt
);
5838 redisplay_preserve_echo_area (2);
5839 return unbind_to (count
, Qt
);
5844 /***********************************************************************
5845 Other Lisp Functions
5846 ***********************************************************************/
5848 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5849 session's frames, frame names, buffers, buffer-read-only flags, and
5850 buffer-modified-flags. */
5852 static Lisp_Object frame_and_buffer_state
;
5855 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5856 Sframe_or_buffer_changed_p
, 0, 1, 0,
5857 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5858 VARIABLE is a variable name whose value is either nil or a state vector
5859 that will be updated to contain all frames and buffers,
5860 aside from buffers whose names start with space,
5861 along with the buffers' read-only and modified flags. This allows a fast
5862 check to see whether buffer menus might need to be recomputed.
5863 If this function returns non-nil, it updates the internal vector to reflect
5866 If VARIABLE is nil, an internal variable is used. Users should not
5867 pass nil for VARIABLE. */)
5868 (Lisp_Object variable
)
5870 Lisp_Object state
, tail
, frame
, buf
;
5873 if (! NILP (variable
))
5875 CHECK_SYMBOL (variable
);
5876 state
= Fsymbol_value (variable
);
5877 if (! VECTORP (state
))
5881 state
= frame_and_buffer_state
;
5884 FOR_EACH_FRAME (tail
, frame
)
5886 if (idx
== ASIZE (state
))
5888 if (!EQ (AREF (state
, idx
++), frame
))
5890 if (idx
== ASIZE (state
))
5892 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5895 /* Check that the buffer info matches. */
5896 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5898 /* Ignore buffers that aren't included in buffer lists. */
5899 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5901 if (idx
== ASIZE (state
))
5903 if (!EQ (AREF (state
, idx
++), buf
))
5905 if (idx
== ASIZE (state
))
5907 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5909 if (idx
== ASIZE (state
))
5911 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5914 if (idx
== ASIZE (state
))
5916 /* Detect deletion of a buffer at the end of the list. */
5917 if (EQ (AREF (state
, idx
), Qlambda
))
5920 /* Come here if we decide the data has changed. */
5922 /* Count the size we will need.
5923 Start with 1 so there is room for at least one lambda at the end. */
5925 FOR_EACH_FRAME (tail
, frame
)
5927 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5929 /* Reallocate the vector if data has grown to need it,
5930 or if it has shrunk a lot. */
5931 if (! VECTORP (state
)
5932 || n
> ASIZE (state
)
5933 || n
+ 20 < ASIZE (state
) / 2)
5934 /* Add 20 extra so we grow it less often. */
5936 state
= Fmake_vector (make_fixnum (n
+ 20), Qlambda
);
5937 if (! NILP (variable
))
5938 Fset (variable
, state
);
5940 frame_and_buffer_state
= state
;
5943 /* Record the new data in the (possibly reallocated) vector. */
5945 FOR_EACH_FRAME (tail
, frame
)
5947 ASET (state
, idx
, frame
);
5949 ASET (state
, idx
, XFRAME (frame
)->name
);
5952 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5954 /* Ignore buffers that aren't included in buffer lists. */
5955 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5957 ASET (state
, idx
, buf
);
5959 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5961 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5964 /* Fill up the vector with lambdas (always at least one). */
5965 ASET (state
, idx
, Qlambda
);
5967 while (idx
< ASIZE (state
))
5969 ASET (state
, idx
, Qlambda
);
5972 /* Make sure we didn't overflow the vector. */
5973 eassert (idx
<= ASIZE (state
));
5979 /***********************************************************************
5981 ***********************************************************************/
5983 /* Initialization done when Emacs fork is started, before doing stty.
5984 Determine terminal type and set terminal_driver. Then invoke its
5985 decoding routine to set up variables in the terminal package. */
5990 char *terminal_type
;
5992 /* Construct the space glyph. */
5993 space_glyph
.type
= CHAR_GLYPH
;
5994 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5995 space_glyph
.charpos
= -1;
5998 cursor_in_echo_area
= false;
6000 /* Now is the time to initialize this; it's used by init_sys_modes
6002 Vinitial_window_system
= Qnil
;
6004 /* SIGWINCH needs to be handled no matter what display we start
6005 with. Otherwise newly opened tty frames will not resize
6010 #endif /* CANNOT_DUMP */
6012 struct sigaction action
;
6013 emacs_sigaction_init (&action
, deliver_window_change_signal
);
6014 sigaction (SIGWINCH
, &action
, 0);
6016 #endif /* SIGWINCH */
6018 /* If running as a daemon, no need to initialize any frames/terminal,
6019 except on Windows, where we at least want to initialize it. */
6025 /* If the user wants to use a window system, we shouldn't bother
6026 initializing the terminal. This is especially important when the
6027 terminal is so dumb that emacs gives up before and doesn't bother
6028 using the window system.
6030 If the DISPLAY environment variable is set and nonempty,
6031 try to use X, and die with an error message if that doesn't work. */
6033 #ifdef HAVE_X_WINDOWS
6034 if (! inhibit_window_system
&& ! display_arg
)
6037 display
= getenv ("DISPLAY");
6038 display_arg
= (display
!= 0 && *display
!= 0);
6040 if (display_arg
&& !x_display_ok (display
))
6042 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6044 inhibit_window_system
= 1;
6048 if (!inhibit_window_system
&& display_arg
)
6050 Vinitial_window_system
= Qx
;
6052 Vwindow_system_version
= make_fixnum (11);
6055 /* In some versions of ncurses,
6056 tputs crashes if we have not called tgetent.
6058 { char b
[2044]; tgetent (b
, "xterm");}
6062 #endif /* HAVE_X_WINDOWS */
6065 if (!inhibit_window_system
)
6067 Vinitial_window_system
= Qw32
;
6068 Vwindow_system_version
= make_fixnum (1);
6071 #endif /* HAVE_NTGUI */
6074 if (!inhibit_window_system
6080 Vinitial_window_system
= Qns
;
6081 Vwindow_system_version
= make_fixnum (10);
6086 /* If no window system has been specified, try to use the terminal. */
6087 if (! isatty (STDIN_FILENO
))
6088 fatal ("standard input is not a tty");
6091 terminal_type
= (char *)"w32console";
6093 terminal_type
= getenv ("TERM");
6097 #ifdef HAVE_WINDOW_SYSTEM
6098 if (! inhibit_window_system
)
6099 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see 'tset').\n");
6101 #endif /* HAVE_WINDOW_SYSTEM */
6102 fprintf (stderr
, "Please set the environment variable TERM; see 'tset'.\n");
6108 struct frame
*f
= XFRAME (selected_frame
);
6110 init_foreground_group ();
6112 /* Open a display on the controlling tty. */
6113 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6115 /* Convert the initial frame to use the new display. */
6116 if (f
->output_method
!= output_initial
)
6118 f
->output_method
= t
->type
;
6121 t
->reference_count
++;
6123 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6125 if (f
->output_method
== output_termcap
)
6126 create_tty_output (f
);
6128 t
->display_info
.tty
->top_frame
= selected_frame
;
6129 change_frame_size (XFRAME (selected_frame
),
6130 FrameCols (t
->display_info
.tty
),
6131 FrameRows (t
->display_info
.tty
)
6132 - FRAME_MENU_BAR_LINES (f
), 0, 0, 1, 0);
6134 /* Delete the initial terminal. */
6135 if (--initial_terminal
->reference_count
== 0
6136 && initial_terminal
->delete_terminal_hook
)
6137 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6139 /* Update frame parameters to reflect the new type. */
6140 AUTO_FRAME_ARG (tty_type_arg
, Qtty_type
, Ftty_type (selected_frame
));
6141 Fmodify_frame_parameters (selected_frame
, tty_type_arg
);
6142 AUTO_FRAME_ARG (tty_arg
, Qtty
, (t
->display_info
.tty
->name
6143 ? build_string (t
->display_info
.tty
->name
)
6145 Fmodify_frame_parameters (selected_frame
, tty_arg
);
6149 struct frame
*sf
= SELECTED_FRAME ();
6150 int width
= FRAME_TOTAL_COLS (sf
);
6151 int height
= FRAME_TOTAL_LINES (sf
);
6154 /* If these sizes are so big they cause overflow, just ignore the
6155 change. It's not clear what better we could do. The rest of
6156 the code assumes that (width + 2) * height * sizeof (struct glyph)
6157 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6158 if (INT_ADD_WRAPV (width
, 2, &area
)
6159 || INT_MULTIPLY_WRAPV (height
, area
, &area
)
6160 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
) < area
)
6161 fatal ("screen size %dx%d too big", width
, height
);
6164 calculate_costs (XFRAME (selected_frame
));
6166 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6169 && NILP (Vinitial_window_system
))
6171 /* For the initial frame, we don't have any way of knowing what
6172 are the foreground and background colors of the terminal. */
6173 struct frame
*sf
= SELECTED_FRAME ();
6175 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6176 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6177 call0 (intern ("tty-set-up-initial-frame-faces"));
6183 /***********************************************************************
6185 ***********************************************************************/
6187 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6188 Sinternal_show_cursor
, 2, 2, 0,
6189 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6190 WINDOW nil means use the selected window. SHOW non-nil means
6191 show a cursor in WINDOW in the next redisplay. SHOW nil means
6192 don't show a cursor. */)
6193 (Lisp_Object window
, Lisp_Object show
)
6195 /* Don't change cursor state while redisplaying. This could confuse
6197 if (!redisplaying_p
)
6198 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6203 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6204 Sinternal_show_cursor_p
, 0, 1, 0,
6205 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6206 WINDOW nil or omitted means report on the selected window. */)
6207 (Lisp_Object window
)
6209 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6212 /***********************************************************************
6214 ***********************************************************************/
6217 syms_of_display (void)
6219 defsubr (&Sredraw_frame
);
6220 defsubr (&Sredraw_display
);
6221 defsubr (&Sframe_or_buffer_changed_p
);
6222 defsubr (&Sopen_termscript
);
6224 defsubr (&Sredisplay
);
6225 defsubr (&Ssleep_for
);
6226 defsubr (&Ssend_string_to_terminal
);
6227 defsubr (&Sinternal_show_cursor
);
6228 defsubr (&Sinternal_show_cursor_p
);
6231 defsubr (&Sdump_redisplay_history
);
6234 frame_and_buffer_state
= Fmake_vector (make_fixnum (20), Qlambda
);
6235 staticpro (&frame_and_buffer_state
);
6237 /* This is the "purpose" slot of a display table. */
6238 DEFSYM (Qdisplay_table
, "display-table");
6240 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6242 DEFVAR_INT ("baud-rate", baud_rate
,
6243 doc
: /* The output baud rate of the terminal.
6244 On most systems, changing this value will affect the amount of padding
6245 and the other strategic decisions made during redisplay. */);
6247 DEFVAR_BOOL ("inverse-video", inverse_video
,
6248 doc
: /* Non-nil means invert the entire frame display.
6249 This means everything is in inverse video which otherwise would not be. */);
6251 DEFVAR_BOOL ("visible-bell", visible_bell
,
6252 doc
: /* Non-nil means try to flash the frame to represent a bell.
6254 See also `ring-bell-function'. */);
6256 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6257 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6258 A non-nil value is useful if the terminal can automatically preserve
6259 Emacs's frame display when you reenter Emacs.
6260 It is up to you to set this variable if your terminal can do that. */);
6262 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6263 doc
: /* Name of the window system that Emacs uses for the first frame.
6264 The value is a symbol:
6265 nil for a termcap frame (a character-only terminal),
6266 `x' for an Emacs frame that is really an X window,
6267 `w32' for an Emacs frame that is a window on MS-Windows display,
6268 `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6269 `pc' for a direct-write MS-DOS frame.
6271 Use of this variable as a boolean is deprecated. Instead,
6272 use `display-graphic-p' or any of the other `display-*-p'
6273 predicates which report frame's specific UI-related capabilities. */);
6275 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6276 doc
: /* Name of window system through which the selected frame is displayed.
6277 The value is a symbol:
6278 nil for a termcap frame (a character-only terminal),
6279 `x' for an Emacs frame that is really an X window,
6280 `w32' for an Emacs frame that is a window on MS-Windows display,
6281 `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6282 `pc' for a direct-write MS-DOS frame.
6284 Use of this variable as a boolean is deprecated. Instead,
6285 use `display-graphic-p' or any of the other `display-*-p'
6286 predicates which report frame's specific UI-related capabilities. */);
6288 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6289 doc
: /* The version number of the window system in use.
6290 For X windows, this is 11. */);
6292 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6293 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6295 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6296 doc
: /* Table defining how to output a glyph code to the frame.
6297 If not nil, this is a vector indexed by glyph code to define the glyph.
6298 Each element can be:
6299 integer: a glyph code which this glyph is an alias for.
6300 string: output this glyph using that string (not impl. in X windows).
6301 nil: this glyph mod 524288 is the code of a character to output,
6302 and this glyph / 524288 is the face number (see `face-id') to use
6303 while outputting it. */);
6304 Vglyph_table
= Qnil
;
6306 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6307 doc
: /* Display table to use for buffers that specify none.
6308 It is also used for standard output and error streams.
6309 See `buffer-display-table' for more information. */);
6310 Vstandard_display_table
= Qnil
;
6312 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6313 doc
: /* Nil means display update is paused when input is detected. */);
6314 /* Contrary to expectations, a value of "false" can be detrimental to
6315 responsiveness since aborting a redisplay throws away some of the
6316 work already performed. It's usually more efficient (and gives
6317 more prompt feedback to the user) to let the redisplay terminate,
6318 and just completely skip the next command's redisplay (which is
6319 done regardless of this setting if there's pending input at the
6320 beginning of the next redisplay). */
6321 redisplay_dont_pause
= true;
6327 Vinitial_window_system
= Qnil
;
6328 Vwindow_system_version
= Qnil
;