1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 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
11 (at 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 <http://www.gnu.org/licenses/>. */
28 /* cm.h must come after dispextern.h on Windows. */
29 #include "dispextern.h"
31 #include "character.h"
35 #include "termhooks.h"
40 #include "intervals.h"
41 #include "blockinput.h"
44 #include "syssignal.h"
47 #ifdef HAVE_WINDOW_SYSTEM
49 #endif /* HAVE_WINDOW_SYSTEM */
64 /* Structure to pass dimensions around. Used for character bounding
65 boxes, glyph matrix dimensions and alike. */
74 /* Function prototypes. */
76 static void update_frame_line (struct frame
*, int);
77 static int required_matrix_height (struct window
*);
78 static int required_matrix_width (struct window
*);
79 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
80 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
82 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
84 static void adjust_decode_mode_spec_buffer (struct frame
*);
85 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
86 static void clear_window_matrices (struct window
*, bool);
87 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
88 static int scrolling_window (struct window
*, bool);
89 static bool update_window_line (struct window
*, int, bool *);
90 static void mirror_make_current (struct window
*, int);
92 static void check_matrix_pointers (struct glyph_matrix
*,
93 struct glyph_matrix
*);
95 static void mirror_line_dance (struct window
*, int, int, int *, char *);
96 static bool update_window_tree (struct window
*, bool);
97 static bool update_window (struct window
*, bool);
98 static bool update_frame_1 (struct frame
*, bool, bool, bool);
99 static bool scrolling (struct frame
*);
100 static void set_window_cursor_after_update (struct window
*);
101 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
102 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
103 static void set_window_update_flags (struct window
*w
, bool on_p
);
105 /* True means last display completed. False means it was preempted. */
107 bool display_completed
;
109 /* True means SIGWINCH happened when not safe. */
111 static bool delayed_size_change
;
113 /* A glyph for a space. */
115 struct glyph space_glyph
;
117 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
119 /* Counts of allocated structures. These counts serve to diagnose
120 memory leaks and double frees. */
122 static int glyph_matrix_count
;
123 static int glyph_pool_count
;
125 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
127 /* If non-null, the frame whose frame matrices are manipulated. If
128 null, window matrices are worked on. */
130 static struct frame
*frame_matrix_frame
;
132 /* Convert vpos and hpos from frame to window and vice versa.
133 This may only be used for terminal frames. */
137 static int window_to_frame_vpos (struct window
*, int);
138 static int window_to_frame_hpos (struct window
*, int);
139 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
140 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
142 /* One element of the ring buffer containing redisplay history
145 struct redisplay_history
147 char trace
[512 + 100];
150 /* The size of the history buffer. */
152 #define REDISPLAY_HISTORY_SIZE 30
154 /* The redisplay history buffer. */
156 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
158 /* Next free entry in redisplay_history. */
160 static int history_idx
;
162 /* A tick that's incremented each time something is added to the
165 static uprintmax_t history_tick
;
167 /* Add to the redisplay history how window W has been displayed.
168 MSG is a trace containing the information how W's glyph matrix
169 has been constructed. PAUSED_P means that the update
170 has been interrupted for pending input. */
173 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
178 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
180 buf
= redisplay_history
[history_idx
].trace
;
183 snprintf (buf
, sizeof redisplay_history
[0].trace
,
184 "%"pMu
": window %p (`%s')%s\n%s",
187 ((BUFFERP (w
->contents
)
188 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
189 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
191 paused_p
? " ***paused***" : "",
196 /* Add to the redisplay history that frame F has been displayed.
197 PAUSED_P means that the update has been interrupted for
201 add_frame_display_history (struct frame
*f
, bool paused_p
)
206 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
208 buf
= redisplay_history
[history_idx
].trace
;
211 sprintf (buf
, "%"pMu
": update frame %p%s",
213 ptr
, paused_p
? " ***paused***" : "");
217 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
218 Sdump_redisplay_history
, 0, 0, "",
219 doc
: /* Dump redisplay history to stderr. */)
224 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
227 i
= REDISPLAY_HISTORY_SIZE
- 1;
228 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
235 #else /* not GLYPH_DEBUG */
237 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
238 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
240 #endif /* GLYPH_DEBUG */
243 #if (defined PROFILING \
244 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
245 && !HAVE___EXECUTABLE_START)
246 /* This function comes first in the Emacs executable and is used only
247 to estimate the text start for profiling. */
249 __executable_start (void)
255 /***********************************************************************
257 ***********************************************************************/
259 /* Allocate and return a glyph_matrix structure. POOL is the glyph
260 pool from which memory for the matrix should be allocated, or null
261 for window-based redisplay where no glyph pools are used. The
262 member `pool' of the glyph matrix structure returned is set to
263 POOL, the structure is otherwise zeroed. */
265 static struct glyph_matrix
*
266 new_glyph_matrix (struct glyph_pool
*pool
)
268 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
270 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
271 /* Increment number of allocated matrices. This count is used
272 to detect memory leaks. */
273 ++glyph_matrix_count
;
276 /* Set pool and return. */
282 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
284 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
285 glyph_matrix_count is decremented when a matrix is freed. If the count
286 gets negative, more structures were freed than allocated, i.e. one matrix
287 was freed more than once or a bogus pointer was passed to this function.
289 If MATRIX->pool is null, this means that the matrix manages its own
290 glyph memory---this is done for matrices on X frames. Freeing the
291 matrix also frees the glyph memory in this case. */
294 free_glyph_matrix (struct glyph_matrix
*matrix
)
300 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
301 /* Detect the case that more matrices are freed than were
303 --glyph_matrix_count
;
304 eassert (glyph_matrix_count
>= 0);
307 /* Free glyph memory if MATRIX owns it. */
308 if (matrix
->pool
== NULL
)
309 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
310 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
312 /* Free row structures and the matrix itself. */
313 xfree (matrix
->rows
);
319 /* Return the number of glyphs to reserve for a marginal area of
320 window W. TOTAL_GLYPHS is the number of glyphs in a complete
321 display line of window W. MARGIN gives the width of the marginal
322 area in canonical character units. */
325 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
329 int width
= w
->total_cols
;
330 double d
= max (0, margin
);
331 d
= min (width
/ 2 - 1, d
);
332 return (int) ((double) total_glyphs
/ width
* d
);
337 /* Return true if ROW's hash value is correct.
338 Optimized away if ENABLE_CHECKING is not defined. */
341 verify_row_hash (struct glyph_row
*row
)
343 return row
->hash
== row_hash (row
);
346 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
349 W is null if the function is called for a frame glyph matrix.
350 Otherwise it is the window MATRIX is a member of. X and Y are the
351 indices of the first column and row of MATRIX within the frame
352 matrix, if such a matrix exists. They are zero for purely
353 window-based redisplay. DIM is the needed size of the matrix.
355 In window-based redisplay, where no frame matrices exist, glyph
356 matrices manage their own glyph storage. Otherwise, they allocate
357 storage from a common frame glyph pool which can be found in
360 The reason for this memory management strategy is to avoid complete
361 frame redraws if possible. When we allocate from a common pool, a
362 change of the location or size of a sub-matrix within the pool
363 requires a complete redisplay of the frame because we cannot easily
364 make sure that the current matrices of all windows still agree with
365 what is displayed on the screen. While this is usually fast, it
366 leads to screen flickering. */
369 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
373 bool marginal_areas_changed_p
= 0;
374 bool header_line_changed_p
= 0;
375 bool header_line_p
= 0;
376 int left
= -1, right
= -1;
377 int window_width
= -1, window_height
= -1;
379 /* See if W had a header line that has disappeared now, or vice versa.
383 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
385 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
386 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
388 matrix
->header_line_p
= header_line_p
;
390 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
391 Do nothing if MATRIX' size, position, vscroll, and marginal areas
392 haven't changed. This optimization is important because preserving
393 the matrix means preventing redisplay. */
394 if (matrix
->pool
== NULL
)
396 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
397 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
398 eassert (left
>= 0 && right
>= 0);
399 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
400 || right
!= matrix
->right_margin_glyphs
);
402 if (!marginal_areas_changed_p
403 && !XFRAME (w
->frame
)->fonts_changed
404 && !header_line_changed_p
405 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
406 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
407 && matrix
->window_height
== window_height
408 && matrix
->window_vscroll
== w
->vscroll
409 && matrix
->window_width
== window_width
)
413 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
414 if (matrix
->rows_allocated
< dim
.height
)
416 int old_alloc
= matrix
->rows_allocated
;
417 new_rows
= dim
.height
- matrix
->rows_allocated
;
418 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
419 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
420 memset (matrix
->rows
+ old_alloc
, 0,
421 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
426 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
427 on a frame not using window-based redisplay. Set up pointers for
428 each row into the glyph pool. */
431 eassert (matrix
->pool
->glyphs
);
435 left
= margin_glyphs_to_reserve (w
, dim
.width
,
436 w
->left_margin_cols
);
437 right
= margin_glyphs_to_reserve (w
, dim
.width
,
438 w
->right_margin_cols
);
443 for (i
= 0; i
< dim
.height
; ++i
)
445 struct glyph_row
*row
= &matrix
->rows
[i
];
447 row
->glyphs
[LEFT_MARGIN_AREA
]
448 = (matrix
->pool
->glyphs
449 + (y
+ i
) * matrix
->pool
->ncolumns
453 || (row
== matrix
->rows
+ dim
.height
- 1
454 && WINDOW_WANTS_MODELINE_P (w
))
455 || (row
== matrix
->rows
&& matrix
->header_line_p
))
457 row
->glyphs
[TEXT_AREA
]
458 = row
->glyphs
[LEFT_MARGIN_AREA
];
459 row
->glyphs
[RIGHT_MARGIN_AREA
]
460 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
461 row
->glyphs
[LAST_AREA
]
462 = row
->glyphs
[RIGHT_MARGIN_AREA
];
466 row
->glyphs
[TEXT_AREA
]
467 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
468 row
->glyphs
[RIGHT_MARGIN_AREA
]
469 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
470 row
->glyphs
[LAST_AREA
]
471 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
475 matrix
->left_margin_glyphs
= left
;
476 matrix
->right_margin_glyphs
= right
;
480 /* If MATRIX->pool is null, MATRIX is responsible for managing
481 its own memory. It is a window matrix for window-based redisplay.
482 Allocate glyph memory from the heap. */
483 if (dim
.width
> matrix
->matrix_w
485 || header_line_changed_p
486 || marginal_areas_changed_p
)
488 struct glyph_row
*row
= matrix
->rows
;
489 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
493 row
->glyphs
[LEFT_MARGIN_AREA
]
494 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
495 dim
.width
, sizeof (struct glyph
));
497 /* The mode line, if displayed, never has marginal areas. */
498 if ((row
== matrix
->rows
+ dim
.height
- 1
499 && !(w
&& WINDOW_WANTS_MODELINE_P (w
)))
500 || (row
== matrix
->rows
&& matrix
->header_line_p
))
502 row
->glyphs
[TEXT_AREA
]
503 = row
->glyphs
[LEFT_MARGIN_AREA
];
504 row
->glyphs
[RIGHT_MARGIN_AREA
]
505 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
506 row
->glyphs
[LAST_AREA
]
507 = row
->glyphs
[RIGHT_MARGIN_AREA
];
511 row
->glyphs
[TEXT_AREA
]
512 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
513 row
->glyphs
[RIGHT_MARGIN_AREA
]
514 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
515 row
->glyphs
[LAST_AREA
]
516 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
522 eassert (left
>= 0 && right
>= 0);
523 matrix
->left_margin_glyphs
= left
;
524 matrix
->right_margin_glyphs
= right
;
527 /* Number of rows to be used by MATRIX. */
528 matrix
->nrows
= dim
.height
;
529 eassert (matrix
->nrows
>= 0);
533 if (matrix
== w
->current_matrix
)
535 /* Mark rows in a current matrix of a window as not having
536 valid contents. It's important to not do this for
537 desired matrices. When Emacs starts, it may already be
538 building desired matrices when this function runs. */
539 if (window_width
< 0)
540 window_width
= window_box_width (w
, -1);
542 /* Optimize the case that only the height has changed (C-x 2,
543 upper window). Invalidate all rows that are no longer part
545 if (!marginal_areas_changed_p
546 && !header_line_changed_p
548 && dim
.width
== matrix
->matrix_w
549 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
550 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
551 && matrix
->window_width
== window_width
)
553 /* Find the last row in the window. */
554 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
555 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
561 /* Window end is invalid, if inside of the rows that
562 are invalidated below. */
563 if (w
->window_end_vpos
>= i
)
564 w
->window_end_valid
= 0;
566 while (i
< matrix
->nrows
)
567 matrix
->rows
[i
++].enabled_p
= false;
571 for (i
= 0; i
< matrix
->nrows
; ++i
)
572 matrix
->rows
[i
].enabled_p
= false;
575 else if (matrix
== w
->desired_matrix
)
577 /* Rows in desired matrices always have to be cleared;
578 redisplay expects this is the case when it runs, so it
579 had better be the case when we adjust matrices between
581 for (i
= 0; i
< matrix
->nrows
; ++i
)
582 matrix
->rows
[i
].enabled_p
= false;
587 /* Remember last values to be able to optimize frame redraws. */
588 matrix
->matrix_x
= x
;
589 matrix
->matrix_y
= y
;
590 matrix
->matrix_w
= dim
.width
;
591 matrix
->matrix_h
= dim
.height
;
593 /* Record the top y location and height of W at the time the matrix
594 was last adjusted. This is used to optimize redisplay above. */
597 matrix
->window_pixel_left
= WINDOW_LEFT_PIXEL_EDGE (w
);
598 matrix
->window_pixel_top
= WINDOW_TOP_PIXEL_EDGE (w
);
599 matrix
->window_height
= window_height
;
600 matrix
->window_width
= window_width
;
601 matrix
->window_vscroll
= w
->vscroll
;
606 /* Reverse the contents of rows in MATRIX between START and END. The
607 contents of the row at END - 1 end up at START, END - 2 at START +
608 1 etc. This is part of the implementation of rotate_matrix (see
612 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
616 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
618 /* Non-ISO HP/UX compiler doesn't like auto struct
620 struct glyph_row temp
;
621 temp
= matrix
->rows
[i
];
622 matrix
->rows
[i
] = matrix
->rows
[j
];
623 matrix
->rows
[j
] = temp
;
628 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
629 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
630 indices. (Note: this does not copy glyphs, only glyph pointers in
631 row structures are moved around).
633 The algorithm used for rotating the vector was, I believe, first
634 described by Kernighan. See the vector R as consisting of two
635 sub-vectors AB, where A has length BY for BY >= 0. The result
636 after rotating is then BA. Reverse both sub-vectors to get ArBr
637 and reverse the result to get (ArBr)r which is BA. Similar for
641 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
645 /* Up (rotate left, i.e. towards lower indices). */
647 reverse_rows (matrix
, first
, first
+ by
);
648 reverse_rows (matrix
, first
+ by
, last
);
649 reverse_rows (matrix
, first
, last
);
653 /* Down (rotate right, i.e. towards higher indices). */
654 reverse_rows (matrix
, last
- by
, last
);
655 reverse_rows (matrix
, first
, last
- by
);
656 reverse_rows (matrix
, first
, last
);
661 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
662 with indices START <= index < END. Increment positions by DELTA/
666 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
667 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
669 /* Check that START and END are reasonable values. */
670 eassert (start
>= 0 && start
<= matrix
->nrows
);
671 eassert (end
>= 0 && end
<= matrix
->nrows
);
672 eassert (start
<= end
);
674 for (; start
< end
; ++start
)
675 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
679 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
680 START and END are the row indices of the first and last + 1 row to clear. */
683 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
685 eassert (start
<= end
);
686 eassert (start
>= 0 && start
< matrix
->nrows
);
687 eassert (end
>= 0 && end
<= matrix
->nrows
);
689 for (; start
< end
; ++start
)
690 matrix
->rows
[start
].enabled_p
= false;
696 Empty all rows in MATRIX by clearing their enabled_p flags.
697 The function prepare_desired_row will eventually really clear a row
698 when it sees one with a false enabled_p flag.
700 Reset update hints to default values. The only update hint
701 currently present is the flag MATRIX->no_scrolling_p. */
704 clear_glyph_matrix (struct glyph_matrix
*matrix
)
708 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
709 matrix
->no_scrolling_p
= 0;
714 /* Shift part of the glyph matrix MATRIX of window W up or down.
715 Increment y-positions in glyph rows between START and END by DY,
716 and recompute their visible height. */
719 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
723 eassert (start
<= end
);
724 eassert (start
>= 0 && start
< matrix
->nrows
);
725 eassert (end
>= 0 && end
<= matrix
->nrows
);
727 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
728 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
730 for (; start
< end
; ++start
)
732 struct glyph_row
*row
= &matrix
->rows
[start
];
735 row
->visible_height
= row
->height
;
738 row
->visible_height
-= min_y
- row
->y
;
739 if (row
->y
+ row
->height
> max_y
)
740 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
741 if (row
->fringe_bitmap_periodic_p
)
742 row
->redraw_fringe_bitmaps_p
= 1;
747 /* Mark all rows in current matrices of frame F as invalid. Marking
748 invalid is done by setting enabled_p to zero for all rows in a
752 clear_current_matrices (register struct frame
*f
)
754 /* Clear frame current matrix, if we have one. */
755 if (f
->current_matrix
)
756 clear_glyph_matrix (f
->current_matrix
);
758 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
759 /* Clear the matrix of the menu bar window, if such a window exists.
760 The menu bar window is currently used to display menus on X when
761 no toolkit support is compiled in. */
762 if (WINDOWP (f
->menu_bar_window
))
763 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
766 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
767 /* Clear the matrix of the tool-bar window, if any. */
768 if (WINDOWP (f
->tool_bar_window
))
769 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
772 /* Clear current window matrices. */
773 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
774 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
778 /* Clear out all display lines of F for a coming redisplay. */
781 clear_desired_matrices (register struct frame
*f
)
783 if (f
->desired_matrix
)
784 clear_glyph_matrix (f
->desired_matrix
);
786 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
787 if (WINDOWP (f
->menu_bar_window
))
788 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
791 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
792 if (WINDOWP (f
->tool_bar_window
))
793 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
796 /* Do it for window matrices. */
797 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
798 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
802 /* Clear matrices in window tree rooted in W. If DESIRED_P,
803 clear desired matrices, otherwise clear current matrices. */
806 clear_window_matrices (struct window
*w
, bool desired_p
)
810 if (WINDOWP (w
->contents
))
811 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
815 clear_glyph_matrix (w
->desired_matrix
);
818 clear_glyph_matrix (w
->current_matrix
);
819 w
->window_end_valid
= 0;
823 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
829 /***********************************************************************
832 See dispextern.h for an overall explanation of glyph rows.
833 ***********************************************************************/
835 /* Clear glyph row ROW. NOTE: this code relies on the current
836 layout of `glyphs' and `used' fields of `struct glyph_row'. */
839 clear_glyph_row (struct glyph_row
*row
)
841 enum { off
= offsetof (struct glyph_row
, used
) };
843 /* Zero everything except pointers in `glyphs'. */
844 memset (row
->used
, 0, sizeof *row
- off
);
848 /* Make ROW an empty, enabled row of canonical character height,
849 in window W starting at y-position Y. */
852 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
856 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
857 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
859 clear_glyph_row (row
);
861 row
->ascent
= row
->phys_ascent
= 0;
862 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
863 row
->visible_height
= row
->height
;
866 row
->visible_height
-= min_y
- row
->y
;
867 if (row
->y
+ row
->height
> max_y
)
868 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
870 row
->enabled_p
= true;
874 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
875 are the amounts by which to change positions. Note that the first
876 glyph of the text area of a row can have a buffer position even if
877 the used count of the text area is zero. Such rows display line
881 increment_row_positions (struct glyph_row
*row
,
882 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
886 /* Increment start and end positions. */
887 MATRIX_ROW_START_CHARPOS (row
) += delta
;
888 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
889 MATRIX_ROW_END_CHARPOS (row
) += delta
;
890 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
891 CHARPOS (row
->start
.pos
) += delta
;
892 BYTEPOS (row
->start
.pos
) += delta_bytes
;
893 CHARPOS (row
->end
.pos
) += delta
;
894 BYTEPOS (row
->end
.pos
) += delta_bytes
;
899 /* Increment positions in glyphs. */
900 for (area
= 0; area
< LAST_AREA
; ++area
)
901 for (i
= 0; i
< row
->used
[area
]; ++i
)
902 if (BUFFERP (row
->glyphs
[area
][i
].object
)
903 && row
->glyphs
[area
][i
].charpos
> 0)
904 row
->glyphs
[area
][i
].charpos
+= delta
;
906 /* Capture the case of rows displaying a line end. */
907 if (row
->used
[TEXT_AREA
] == 0
908 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
909 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
914 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
915 contents, i.e. glyph structure contents are exchanged between A and
916 B without changing glyph pointers in A and B. */
919 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
923 for (area
= 0; area
< LAST_AREA
; ++area
)
925 /* Number of glyphs to swap. */
926 int max_used
= max (a
->used
[area
], b
->used
[area
]);
928 /* Start of glyphs in area of row A. */
929 struct glyph
*glyph_a
= a
->glyphs
[area
];
931 /* End + 1 of glyphs in area of row A. */
932 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
934 /* Start of glyphs in area of row B. */
935 struct glyph
*glyph_b
= b
->glyphs
[area
];
937 while (glyph_a
< glyph_a_end
)
939 /* Non-ISO HP/UX compiler doesn't like auto struct
953 /* Exchange pointers to glyph memory between glyph rows A and B. Also
954 exchange the used[] array and the hash values of the rows, because
955 these should all go together for the row's hash value to be
959 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
962 unsigned hash_tem
= a
->hash
;
964 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
966 struct glyph
*temp
= a
->glyphs
[i
];
968 a
->glyphs
[i
] = b
->glyphs
[i
];
972 short used_tem
= a
->used
[i
];
974 a
->used
[i
] = b
->used
[i
];
975 b
->used
[i
] = used_tem
;
983 /* Copy glyph row structure FROM to glyph row structure TO, except that
984 glyph pointers, the `used' counts, and the hash values in the structures
985 are left unchanged. NOTE: this code relies on the current layout of
986 `glyphs', `used', `hash' and `x' fields of `struct glyph_row'. */
989 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
991 enum { off
= offsetof (struct glyph_row
, x
) };
993 memcpy (&to
->x
, &from
->x
, sizeof *to
- off
);
997 /* Assign glyph row FROM to glyph row TO. This works like a structure
998 assignment TO = FROM, except that glyph pointers are not copied but
999 exchanged between TO and FROM. Pointers must be exchanged to avoid
1003 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1005 swap_glyph_pointers (to
, from
);
1006 copy_row_except_pointers (to
, from
);
1010 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1011 a row in a window matrix, is a slice of the glyph memory of the
1012 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1013 is true if the glyph memory of WINDOW_ROW is part of the glyph
1014 memory of FRAME_ROW. */
1019 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1021 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1022 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1023 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1025 return (frame_glyph_start
<= window_glyph_start
1026 && window_glyph_start
< frame_glyph_end
);
1029 #endif /* GLYPH_DEBUG */
1033 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1034 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1035 in WINDOW_MATRIX is found satisfying the condition. */
1037 static struct glyph_row
*
1038 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1039 struct glyph_matrix
*frame_matrix
, int row
)
1043 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1045 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1046 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1047 frame_matrix
->rows
+ row
))
1050 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1055 /* Prepare ROW for display in windows W. Desired rows are cleared
1056 lazily, i.e. they are only marked as to be cleared by setting their
1057 enabled_p flag to zero. When a row is to be displayed, a prior
1058 call to this function really clears it. In addition, this function
1059 makes sure the marginal areas of ROW are in sync with the window's
1060 display margins. MODE_LINE_P non-zero means we are preparing a
1061 glyph row for header line or mode line. */
1064 prepare_desired_row (struct window
*w
, struct glyph_row
*row
, bool mode_line_p
)
1066 if (!row
->enabled_p
)
1068 bool rp
= row
->reversed_p
;
1070 clear_glyph_row (row
);
1071 row
->enabled_p
= true;
1072 row
->reversed_p
= rp
;
1076 /* Mode and header lines, if displayed, never have marginal
1077 areas. If we are called with MODE_LINE_P non-zero, we are
1078 displaying the mode/header line in this window, and so the
1079 marginal areas of this glyph row should be eliminated. This
1080 is needed when the mode/header line is switched on in a
1081 window that has display margins. */
1082 if (w
->left_margin_cols
> 0)
1083 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
1084 if (w
->right_margin_cols
> 0)
1085 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
];
1089 /* The real number of glyphs reserved for the margins is
1090 recorded in the glyph matrix, and can be different from
1091 window's left_margin_cols and right_margin_cols; see
1092 margin_glyphs_to_reserve for when that happens. */
1093 int left
= w
->desired_matrix
->left_margin_glyphs
;
1094 int right
= w
->desired_matrix
->right_margin_glyphs
;
1096 /* Make sure the marginal areas of this row are in sync with
1097 what the window wants, when the row actually displays text
1098 and not header/mode line. */
1099 if (w
->left_margin_cols
> 0
1100 && (left
!= row
->glyphs
[TEXT_AREA
] - row
->glyphs
[LEFT_MARGIN_AREA
]))
1101 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
1102 if (w
->right_margin_cols
> 0
1103 && (right
!= row
->glyphs
[LAST_AREA
] - row
->glyphs
[RIGHT_MARGIN_AREA
]))
1104 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
] - right
;
1109 /* Return a hash code for glyph row ROW, which may
1110 be from current or desired matrix of frame F. */
1113 line_hash_code (struct frame
*f
, struct glyph_row
*row
)
1119 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1120 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1124 int c
= glyph
->u
.ch
;
1125 int face_id
= glyph
->face_id
;
1126 if (FRAME_MUST_WRITE_SPACES (f
))
1128 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1129 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1141 /* Return the cost of drawing line VPOS in MATRIX, which may
1142 be current or desired matrix of frame F. The cost equals
1143 the number of characters in the line. If must_write_spaces
1144 is zero, leading and trailing spaces are ignored. */
1147 line_draw_cost (struct frame
*f
, struct glyph_matrix
*matrix
, int vpos
)
1149 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1150 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1151 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1153 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1154 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1156 /* Ignore trailing and leading spaces if we can. */
1157 if (!FRAME_MUST_WRITE_SPACES (f
))
1159 /* Skip from the end over trailing spaces. */
1160 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1163 /* All blank line. */
1167 /* Skip over leading spaces. */
1168 while (CHAR_GLYPH_SPACE_P (*beg
))
1172 /* If we don't have a glyph-table, each glyph is one character,
1173 so return the number of glyphs. */
1174 if (glyph_table_base
== 0)
1178 /* Otherwise, scan the glyphs and accumulate their total length
1185 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1187 if (GLYPH_INVALID_P (g
)
1188 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1191 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1201 /* Return true if the glyph rows A and B have equal contents.
1202 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1205 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1207 eassert (verify_row_hash (a
));
1208 eassert (verify_row_hash (b
));
1212 else if (a
->hash
!= b
->hash
)
1216 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1219 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1222 /* Compare glyphs. */
1223 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1225 if (a
->used
[area
] != b
->used
[area
])
1228 a_glyph
= a
->glyphs
[area
];
1229 a_end
= a_glyph
+ a
->used
[area
];
1230 b_glyph
= b
->glyphs
[area
];
1232 while (a_glyph
< a_end
1233 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1234 ++a_glyph
, ++b_glyph
;
1236 if (a_glyph
!= a_end
)
1240 if (a
->fill_line_p
!= b
->fill_line_p
1241 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1242 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1243 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1244 || a
->left_fringe_offset
!= b
->left_fringe_offset
1245 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1246 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1247 || a
->right_fringe_offset
!= b
->right_fringe_offset
1248 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1249 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1250 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1251 || a
->overlapped_p
!= b
->overlapped_p
1252 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1253 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1254 || a
->reversed_p
!= b
->reversed_p
1255 /* Different partially visible characters on left margin. */
1257 /* Different height. */
1258 || a
->ascent
!= b
->ascent
1259 || a
->phys_ascent
!= b
->phys_ascent
1260 || a
->phys_height
!= b
->phys_height
1261 || a
->visible_height
!= b
->visible_height
)
1270 /***********************************************************************
1273 See dispextern.h for an overall explanation of glyph pools.
1274 ***********************************************************************/
1276 /* Allocate a glyph_pool structure. The structure returned is initialized
1277 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1278 variable glyph_pool_count is incremented for each pool allocated. */
1280 static struct glyph_pool
*
1281 new_glyph_pool (void)
1283 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1285 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1286 /* For memory leak and double deletion checking. */
1294 /* Free a glyph_pool structure POOL. The function may be called with
1295 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1296 global variable glyph_pool_count is decremented with every pool structure
1297 freed. If this count gets negative, more structures were freed than
1298 allocated, i.e. one structure must have been freed more than once or
1299 a bogus pointer was passed to free_glyph_pool. */
1302 free_glyph_pool (struct glyph_pool
*pool
)
1306 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1307 /* More freed than allocated? */
1309 eassert (glyph_pool_count
>= 0);
1311 xfree (pool
->glyphs
);
1317 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1318 columns we need. This function never shrinks a pool. The only
1319 case in which this would make sense, would be when a frame's size
1320 is changed from a large value to a smaller one. But, if someone
1321 does it once, we can expect that he will do it again.
1323 Return true if the pool changed in a way which makes
1324 re-adjusting window glyph matrices necessary. */
1327 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1332 changed_p
= (pool
->glyphs
== 0
1333 || matrix_dim
.height
!= pool
->nrows
1334 || matrix_dim
.width
!= pool
->ncolumns
);
1336 /* Enlarge the glyph pool. */
1337 needed
= matrix_dim
.width
;
1338 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1339 memory_full (SIZE_MAX
);
1340 needed
*= matrix_dim
.height
;
1341 if (needed
> pool
->nglyphs
)
1343 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1344 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1345 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1347 /* Redisplay relies on nil as the object of special glyphs
1348 (truncation and continuation glyphs and also blanks used to
1349 extend each line on a TTY), so verify that memset does this. */
1350 verify (NIL_IS_ZERO
);
1352 memset (pool
->glyphs
+ old_nglyphs
, 0,
1353 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1356 /* Remember the number of rows and columns because (a) we use them
1357 to do sanity checks, and (b) the number of columns determines
1358 where rows in the frame matrix start---this must be available to
1359 determine pointers to rows of window sub-matrices. */
1360 pool
->nrows
= matrix_dim
.height
;
1361 pool
->ncolumns
= matrix_dim
.width
;
1368 /***********************************************************************
1370 ***********************************************************************/
1375 /* Flush standard output. This is sometimes useful to call from the debugger.
1376 XXX Maybe this should be changed to flush the current terminal instead of
1380 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1389 /* Check that no glyph pointers have been lost in MATRIX. If a
1390 pointer has been lost, e.g. by using a structure assignment between
1391 rows, at least one pointer must occur more than once in the rows of
1395 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1399 for (i
= 0; i
< matrix
->nrows
; ++i
)
1400 for (j
= 0; j
< matrix
->nrows
; ++j
)
1402 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1403 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1407 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1410 matrix_row (struct glyph_matrix
*matrix
, int row
)
1412 eassert (matrix
&& matrix
->rows
);
1413 eassert (row
>= 0 && row
< matrix
->nrows
);
1415 /* That's really too slow for normal testing because this function
1416 is called almost everywhere. Although---it's still astonishingly
1417 fast, so it is valuable to have for debugging purposes. */
1419 check_matrix_pointer_lossage (matrix
);
1422 return matrix
->rows
+ row
;
1426 #if 0 /* This function makes invalid assumptions when text is
1427 partially invisible. But it might come handy for debugging
1430 /* Check invariants that must hold for an up to date current matrix of
1434 check_matrix_invariants (struct window
*w
)
1436 struct glyph_matrix
*matrix
= w
->current_matrix
;
1437 int yb
= window_text_bottom_y (w
);
1438 struct glyph_row
*row
= matrix
->rows
;
1439 struct glyph_row
*last_text_row
= NULL
;
1440 struct buffer
*saved
= current_buffer
;
1441 struct buffer
*buffer
= XBUFFER (w
->contents
);
1444 /* This can sometimes happen for a fresh window. */
1445 if (matrix
->nrows
< 2)
1448 set_buffer_temp (buffer
);
1450 /* Note: last row is always reserved for the mode line. */
1451 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1452 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1454 struct glyph_row
*next
= row
+ 1;
1456 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1457 last_text_row
= row
;
1459 /* Check that character and byte positions are in sync. */
1460 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1461 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1462 eassert (BYTEPOS (row
->start
.pos
)
1463 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1465 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1466 have such a position temporarily in case of a minibuffer
1467 displaying something like `[Sole completion]' at its end. */
1468 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1470 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1471 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1472 eassert (BYTEPOS (row
->end
.pos
)
1473 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1476 /* Check that end position of `row' is equal to start position
1478 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1480 eassert (MATRIX_ROW_END_CHARPOS (row
)
1481 == MATRIX_ROW_START_CHARPOS (next
));
1482 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1483 == MATRIX_ROW_START_BYTEPOS (next
));
1484 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1485 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1490 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1491 eassert (w
->desired_matrix
->rows
!= NULL
);
1492 set_buffer_temp (saved
);
1497 #endif /* GLYPH_DEBUG */
1501 /**********************************************************************
1502 Allocating/ Adjusting Glyph Matrices
1503 **********************************************************************/
1505 /* Allocate glyph matrices over a window tree for a frame-based
1508 X and Y are column/row within the frame glyph matrix where
1509 sub-matrices for the window tree rooted at WINDOW must be
1510 allocated. DIM_ONLY_P means that the caller of this
1511 function is only interested in the result matrix dimension, and
1512 matrix adjustments should not be performed.
1514 The function returns the total width/height of the sub-matrices of
1515 the window tree. If called on a frame root window, the computation
1516 will take the mini-buffer window into account.
1518 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1520 NEW_LEAF_MATRIX set if any window in the tree did not have a
1521 glyph matrices yet, and
1523 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1524 any window in the tree will be changed or have been changed (see
1527 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1530 Windows are arranged into chains of windows on the same level
1531 through the next fields of window structures. Such a level can be
1532 either a sequence of horizontally adjacent windows from left to
1533 right, or a sequence of vertically adjacent windows from top to
1534 bottom. Each window in a horizontal sequence can be either a leaf
1535 window or a vertical sequence; a window in a vertical sequence can
1536 be either a leaf or a horizontal sequence. All windows in a
1537 horizontal sequence have the same height, and all windows in a
1538 vertical sequence have the same width.
1540 This function uses, for historical reasons, a more general
1541 algorithm to determine glyph matrix dimensions that would be
1544 The matrix height of a horizontal sequence is determined by the
1545 maximum height of any matrix in the sequence. The matrix width of
1546 a horizontal sequence is computed by adding up matrix widths of
1547 windows in the sequence.
1549 |<------- result width ------->|
1550 +---------+----------+---------+ ---
1553 +---------+ | | result height
1558 The matrix width of a vertical sequence is the maximum matrix width
1559 of any window in the sequence. Its height is computed by adding up
1560 matrix heights of windows in the sequence.
1562 |<---- result width -->|
1570 +------------+---------+ |
1573 +------------+---------+ --- */
1575 /* Bit indicating that a new matrix will be allocated or has been
1578 #define NEW_LEAF_MATRIX (1 << 0)
1580 /* Bit indicating that a matrix will or has changed its location or
1583 #define CHANGED_LEAF_MATRIX (1 << 1)
1586 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1587 bool dim_only_p
, int *window_change_flags
)
1589 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1591 int wmax
= 0, hmax
= 0;
1595 bool in_horz_combination_p
;
1597 /* What combination is WINDOW part of? Compute this once since the
1598 result is the same for all windows in the `next' chain. The
1599 special case of a root window (parent equal to nil) is treated
1600 like a vertical combination because a root window's `next'
1601 points to the mini-buffer window, if any, which is arranged
1602 vertically below other windows. */
1603 in_horz_combination_p
1604 = (!NILP (XWINDOW (window
)->parent
)
1605 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1607 /* For WINDOW and all windows on the same level. */
1610 w
= XWINDOW (window
);
1612 /* Get the dimension of the window sub-matrix for W, depending
1613 on whether this is a combination or a leaf window. */
1614 if (WINDOWP (w
->contents
))
1615 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1617 window_change_flags
);
1620 /* If not already done, allocate sub-matrix structures. */
1621 if (w
->desired_matrix
== NULL
)
1623 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1624 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1625 *window_change_flags
|= NEW_LEAF_MATRIX
;
1628 /* Width and height MUST be chosen so that there are no
1629 holes in the frame matrix. */
1630 dim
.width
= required_matrix_width (w
);
1631 dim
.height
= required_matrix_height (w
);
1633 /* Will matrix be re-allocated? */
1634 if (x
!= w
->desired_matrix
->matrix_x
1635 || y
!= w
->desired_matrix
->matrix_y
1636 || dim
.width
!= w
->desired_matrix
->matrix_w
1637 || dim
.height
!= w
->desired_matrix
->matrix_h
1638 || (margin_glyphs_to_reserve (w
, dim
.width
,
1639 w
->left_margin_cols
)
1640 != w
->desired_matrix
->left_margin_glyphs
)
1641 || (margin_glyphs_to_reserve (w
, dim
.width
,
1642 w
->right_margin_cols
)
1643 != w
->desired_matrix
->right_margin_glyphs
))
1644 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1646 /* Actually change matrices, if allowed. Do not consider
1647 CHANGED_LEAF_MATRIX computed above here because the pool
1648 may have been changed which we don't know here. We trust
1649 that we only will be called with DIM_ONLY_P when
1653 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1654 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1658 /* If we are part of a horizontal combination, advance x for
1659 windows to the right of W; otherwise advance y for windows
1661 if (in_horz_combination_p
)
1666 /* Remember maximum glyph matrix dimensions. */
1667 wmax
= max (wmax
, dim
.width
);
1668 hmax
= max (hmax
, dim
.height
);
1670 /* Next window on same level. */
1673 while (!NILP (window
));
1675 /* Set `total' to the total glyph matrix dimension of this window
1676 level. In a vertical combination, the width is the width of the
1677 widest window; the height is the y we finally reached, corrected
1678 by the y we started with. In a horizontal combination, the total
1679 height is the height of the tallest window, and the width is the
1680 x we finally reached, corrected by the x we started with. */
1681 if (in_horz_combination_p
)
1683 total
.width
= x
- x0
;
1684 total
.height
= hmax
;
1689 total
.height
= y
- y0
;
1696 /* Return the required height of glyph matrices for window W. */
1699 required_matrix_height (struct window
*w
)
1701 #ifdef HAVE_WINDOW_SYSTEM
1702 struct frame
*f
= XFRAME (w
->frame
);
1704 if (FRAME_WINDOW_P (f
))
1706 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1707 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1709 return (((window_pixel_height
+ ch_height
- 1)
1710 / ch_height
) * w
->nrows_scale_factor
1711 /* One partially visible line at the top and
1712 bottom of the window. */
1714 /* 2 for header and mode line. */
1717 #endif /* HAVE_WINDOW_SYSTEM */
1719 return WINDOW_TOTAL_LINES (w
);
1723 /* Return the required width of glyph matrices for window W. */
1726 required_matrix_width (struct window
*w
)
1728 #ifdef HAVE_WINDOW_SYSTEM
1729 struct frame
*f
= XFRAME (w
->frame
);
1730 if (FRAME_WINDOW_P (f
))
1732 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1734 /* Compute number of glyphs needed in a glyph row. */
1735 return (((WINDOW_PIXEL_WIDTH (w
) + ch_width
- 1)
1736 / ch_width
) * w
->ncols_scale_factor
1737 /* 2 partially visible columns in the text area. */
1739 /* One partially visible column at the right
1740 edge of each marginal area. */
1743 #endif /* HAVE_WINDOW_SYSTEM */
1745 return w
->total_cols
;
1749 /* Allocate window matrices for window-based redisplay. W is the
1750 window whose matrices must be allocated/reallocated. */
1753 allocate_matrices_for_window_redisplay (struct window
*w
)
1757 if (WINDOWP (w
->contents
))
1758 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1761 /* W is a leaf window. */
1764 /* If matrices are not yet allocated, allocate them now. */
1765 if (w
->desired_matrix
== NULL
)
1767 w
->desired_matrix
= new_glyph_matrix (NULL
);
1768 w
->current_matrix
= new_glyph_matrix (NULL
);
1771 dim
.width
= required_matrix_width (w
);
1772 dim
.height
= required_matrix_height (w
);
1773 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1774 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1777 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1781 /* Allocate/reallocate glyph matrices of a single frame F.
1782 This function must be called when a new frame is created,
1783 its size changes, or its window configuration changes. */
1786 adjust_frame_glyphs (struct frame
*f
)
1788 /* Block input so that expose events and other events that access
1789 glyph matrices are not processed while we are changing them. */
1792 if (FRAME_WINDOW_P (f
))
1793 adjust_frame_glyphs_for_window_redisplay (f
);
1795 adjust_frame_glyphs_for_frame_redisplay (f
);
1797 /* Don't forget the buffer for decode_mode_spec. */
1798 adjust_decode_mode_spec_buffer (f
);
1800 f
->glyphs_initialized_p
= 1;
1805 /* Return true if any window in the tree has nonzero window margins. See
1806 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1808 showing_window_margins_p (struct window
*w
)
1812 if (WINDOWP (w
->contents
))
1814 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1817 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1820 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1826 /* In the window tree with root W, build current matrices of leaf
1827 windows from the frame's current matrix. */
1830 fake_current_matrices (Lisp_Object window
)
1834 for (; !NILP (window
); window
= w
->next
)
1836 w
= XWINDOW (window
);
1838 if (WINDOWP (w
->contents
))
1839 fake_current_matrices (w
->contents
);
1843 struct frame
*f
= XFRAME (w
->frame
);
1844 struct glyph_matrix
*m
= w
->current_matrix
;
1845 struct glyph_matrix
*fm
= f
->current_matrix
;
1847 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1848 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1850 for (i
= 0; i
< m
->matrix_h
; ++i
)
1852 struct glyph_row
*r
= m
->rows
+ i
;
1853 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1855 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1856 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1858 r
->enabled_p
= fr
->enabled_p
;
1861 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1862 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1863 r
->used
[TEXT_AREA
] = (m
->matrix_w
1864 - r
->used
[LEFT_MARGIN_AREA
]
1865 - r
->used
[RIGHT_MARGIN_AREA
]);
1874 /* Save away the contents of frame F's current frame matrix. Value is
1875 a glyph matrix holding the contents of F's current frame matrix. */
1877 static struct glyph_matrix
*
1878 save_current_matrix (struct frame
*f
)
1881 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1882 saved
->nrows
= f
->current_matrix
->nrows
;
1883 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1885 for (i
= 0; i
< saved
->nrows
; ++i
)
1887 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1888 struct glyph_row
*to
= saved
->rows
+ i
;
1889 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1891 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1892 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1893 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1894 to
->enabled_p
= from
->enabled_p
;
1895 to
->hash
= from
->hash
;
1896 if (from
->used
[LEFT_MARGIN_AREA
])
1898 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1899 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1900 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1901 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1902 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1904 if (from
->used
[RIGHT_MARGIN_AREA
])
1906 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1907 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1908 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1909 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1910 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1918 /* Restore the contents of frame F's current frame matrix from SAVED,
1919 and free memory associated with SAVED. */
1922 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1926 for (i
= 0; i
< saved
->nrows
; ++i
)
1928 struct glyph_row
*from
= saved
->rows
+ i
;
1929 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1930 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1932 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1933 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1934 xfree (from
->glyphs
[TEXT_AREA
]);
1935 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1938 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1939 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1940 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1941 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1944 to
->used
[LEFT_MARGIN_AREA
] = 0;
1945 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1948 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1949 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1950 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1951 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1954 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1957 xfree (saved
->rows
);
1963 /* Allocate/reallocate glyph matrices of a single frame F for
1964 frame-based redisplay. */
1967 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1969 struct dim matrix_dim
;
1970 bool pool_changed_p
;
1971 int window_change_flags
;
1974 if (!FRAME_LIVE_P (f
))
1977 top_window_y
= FRAME_TOP_MARGIN (f
);
1979 /* Allocate glyph pool structures if not already done. */
1980 if (f
->desired_pool
== NULL
)
1982 f
->desired_pool
= new_glyph_pool ();
1983 f
->current_pool
= new_glyph_pool ();
1986 /* Allocate frames matrix structures if needed. */
1987 if (f
->desired_matrix
== NULL
)
1989 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1990 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1993 /* Compute window glyph matrices. (This takes the mini-buffer
1994 window into account). The result is the size of the frame glyph
1995 matrix needed. The variable window_change_flags is set to a bit
1996 mask indicating whether new matrices will be allocated or
1997 existing matrices change their size or location within the frame
1999 window_change_flags
= 0;
2001 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2004 &window_change_flags
);
2006 /* Add in menu bar lines, if any. */
2007 matrix_dim
.height
+= top_window_y
;
2009 /* Enlarge pools as necessary. */
2010 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2011 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2013 /* Set up glyph pointers within window matrices. Do this only if
2014 absolutely necessary since it requires a frame redraw. */
2015 if (pool_changed_p
|| window_change_flags
)
2017 /* Do it for window matrices. */
2018 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2020 &window_change_flags
);
2022 /* Size of frame matrices must equal size of frame. Note
2023 that we are called for X frames with window widths NOT equal
2024 to the frame width (from CHANGE_FRAME_SIZE_1). */
2025 if (matrix_dim
.width
!= FRAME_TOTAL_COLS (f
)
2026 || matrix_dim
.height
!= FRAME_TOTAL_LINES (f
))
2029 eassert (matrix_dim
.width
== FRAME_TOTAL_COLS (f
)
2030 && matrix_dim
.height
== FRAME_TOTAL_LINES (f
));
2032 /* Pointers to glyph memory in glyph rows are exchanged during
2033 the update phase of redisplay, which means in general that a
2034 frame's current matrix consists of pointers into both the
2035 desired and current glyph pool of the frame. Adjusting a
2036 matrix sets the frame matrix up so that pointers are all into
2037 the same pool. If we want to preserve glyph contents of the
2038 current matrix over a call to adjust_glyph_matrix, we must
2039 make a copy of the current glyphs, and restore the current
2040 matrix' contents from that copy. */
2041 if (display_completed
2042 && !FRAME_GARBAGED_P (f
)
2043 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2044 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2045 /* For some reason, the frame glyph matrix gets corrupted if
2046 any of the windows contain margins. I haven't been able
2047 to hunt down the reason, but for the moment this prevents
2048 the problem from manifesting. -- cyd */
2049 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2051 struct glyph_matrix
*copy
= save_current_matrix (f
);
2052 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2053 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2054 restore_current_matrix (f
, copy
);
2055 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2059 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2060 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2061 SET_FRAME_GARBAGED (f
);
2067 /* Allocate/reallocate glyph matrices of a single frame F for
2068 window-based redisplay. */
2071 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2073 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2075 /* Allocate/reallocate window matrices. */
2076 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2078 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2079 /* Allocate/ reallocate matrices of the dummy window used to display
2080 the menu bar under X when no X toolkit support is available. */
2082 /* Allocate a dummy window if not already done. */
2084 if (NILP (f
->menu_bar_window
))
2087 fset_menu_bar_window (f
, make_window ());
2088 w
= XWINDOW (f
->menu_bar_window
);
2089 XSETFRAME (frame
, f
);
2090 wset_frame (w
, frame
);
2091 w
->pseudo_window_p
= 1;
2094 w
= XWINDOW (f
->menu_bar_window
);
2096 /* Set window dimensions to frame dimensions and allocate or
2097 adjust glyph matrices of W. */
2102 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2103 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2104 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2105 w
->pixel_height
= FRAME_MENU_BAR_HEIGHT (f
);
2106 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2107 allocate_matrices_for_window_redisplay (w
);
2111 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2113 /* Allocate/ reallocate matrices of the tool bar window. If we
2114 don't have a tool bar window yet, make one. */
2116 if (NILP (f
->tool_bar_window
))
2119 fset_tool_bar_window (f
, make_window ());
2120 w
= XWINDOW (f
->tool_bar_window
);
2121 XSETFRAME (frame
, f
);
2122 wset_frame (w
, frame
);
2123 w
->pseudo_window_p
= 1;
2126 w
= XWINDOW (f
->tool_bar_window
);
2130 w
->pixel_top
= FRAME_MENU_BAR_HEIGHT (f
);
2131 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2132 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2133 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2134 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2135 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2136 w
->pixel_height
= FRAME_TOOL_BAR_HEIGHT (f
);
2137 allocate_matrices_for_window_redisplay (w
);
2143 /* Re-allocate buffer for decode_mode_spec on frame F. */
2146 adjust_decode_mode_spec_buffer (struct frame
*f
)
2148 int frame_message_buf_size
= FRAME_MESSAGE_BUF_SIZE (f
);
2150 eassert (frame_message_buf_size
>= 0);
2151 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2152 frame_message_buf_size
+ 1);
2157 /**********************************************************************
2158 Freeing Glyph Matrices
2159 **********************************************************************/
2161 /* Free glyph memory for a frame F. F may be null. This function can
2162 be called for the same frame more than once. The root window of
2163 F may be nil when this function is called. This is the case when
2164 the function is called when F is destroyed. */
2167 free_glyphs (struct frame
*f
)
2169 if (f
&& f
->glyphs_initialized_p
)
2171 /* Block interrupt input so that we don't get surprised by an X
2172 event while we're in an inconsistent state. */
2174 f
->glyphs_initialized_p
= 0;
2176 /* Release window sub-matrices. */
2177 if (!NILP (f
->root_window
))
2178 free_window_matrices (XWINDOW (f
->root_window
));
2180 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2181 /* Free the dummy window for menu bars without X toolkit and its
2183 if (!NILP (f
->menu_bar_window
))
2185 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2186 free_glyph_matrix (w
->desired_matrix
);
2187 free_glyph_matrix (w
->current_matrix
);
2188 w
->desired_matrix
= w
->current_matrix
= NULL
;
2189 fset_menu_bar_window (f
, Qnil
);
2193 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2194 /* Free the tool bar window and its glyph matrices. */
2195 if (!NILP (f
->tool_bar_window
))
2197 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2198 free_glyph_matrix (w
->desired_matrix
);
2199 free_glyph_matrix (w
->current_matrix
);
2200 w
->desired_matrix
= w
->current_matrix
= NULL
;
2201 fset_tool_bar_window (f
, Qnil
);
2205 /* Release frame glyph matrices. Reset fields to zero in
2206 case we are called a second time. */
2207 if (f
->desired_matrix
)
2209 free_glyph_matrix (f
->desired_matrix
);
2210 free_glyph_matrix (f
->current_matrix
);
2211 f
->desired_matrix
= f
->current_matrix
= NULL
;
2214 /* Release glyph pools. */
2215 if (f
->desired_pool
)
2217 free_glyph_pool (f
->desired_pool
);
2218 free_glyph_pool (f
->current_pool
);
2219 f
->desired_pool
= f
->current_pool
= NULL
;
2227 /* Free glyph sub-matrices in the window tree rooted at W. This
2228 function may be called with a null pointer, and it may be called on
2229 the same tree more than once. */
2232 free_window_matrices (struct window
*w
)
2236 if (WINDOWP (w
->contents
))
2237 free_window_matrices (XWINDOW (w
->contents
));
2240 /* This is a leaf window. Free its memory and reset fields
2241 to zero in case this function is called a second time for
2243 free_glyph_matrix (w
->current_matrix
);
2244 free_glyph_matrix (w
->desired_matrix
);
2245 w
->current_matrix
= w
->desired_matrix
= NULL
;
2248 /* Next window on same level. */
2249 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2254 /* Check glyph memory leaks. This function is called from
2255 shut_down_emacs. Note that frames are not destroyed when Emacs
2256 exits. We therefore free all glyph memory for all active frames
2257 explicitly and check that nothing is left allocated. */
2260 check_glyph_memory (void)
2262 Lisp_Object tail
, frame
;
2264 /* Free glyph memory for all frames. */
2265 FOR_EACH_FRAME (tail
, frame
)
2266 free_glyphs (XFRAME (frame
));
2268 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2269 /* Check that nothing is left allocated. */
2270 eassert (glyph_matrix_count
== 0);
2271 eassert (glyph_pool_count
== 0);
2277 /**********************************************************************
2278 Building a Frame Matrix
2279 **********************************************************************/
2281 /* Most of the redisplay code works on glyph matrices attached to
2282 windows. This is a good solution most of the time, but it is not
2283 suitable for terminal code. Terminal output functions cannot rely
2284 on being able to set an arbitrary terminal window. Instead they
2285 must be provided with a view of the whole frame, i.e. the whole
2286 screen. We build such a view by constructing a frame matrix from
2287 window matrices in this section.
2289 Windows that must be updated have their must_be_updated_p flag set.
2290 For all such windows, their desired matrix is made part of the
2291 desired frame matrix. For other windows, their current matrix is
2292 made part of the desired frame matrix.
2294 +-----------------+----------------+
2295 | desired | desired |
2297 +-----------------+----------------+
2300 +----------------------------------+
2302 Desired window matrices can be made part of the frame matrix in a
2303 cheap way: We exploit the fact that the desired frame matrix and
2304 desired window matrices share their glyph memory. This is not
2305 possible for current window matrices. Their glyphs are copied to
2306 the desired frame matrix. The latter is equivalent to
2307 preserve_other_columns in the old redisplay.
2309 Used glyphs counters for frame matrix rows are the result of adding
2310 up glyph lengths of the window matrices. A line in the frame
2311 matrix is enabled, if a corresponding line in a window matrix is
2314 After building the desired frame matrix, it will be passed to
2315 terminal code, which will manipulate both the desired and current
2316 frame matrix. Changes applied to the frame's current matrix have
2317 to be visible in current window matrices afterwards, of course.
2319 This problem is solved like this:
2321 1. Window and frame matrices share glyphs. Window matrices are
2322 constructed in a way that their glyph contents ARE the glyph
2323 contents needed in a frame matrix. Thus, any modification of
2324 glyphs done in terminal code will be reflected in window matrices
2327 2. Exchanges of rows in a frame matrix done by terminal code are
2328 intercepted by hook functions so that corresponding row operations
2329 on window matrices can be performed. This is necessary because we
2330 use pointers to glyphs in glyph row structures. To satisfy the
2331 assumption of point 1 above that glyphs are updated implicitly in
2332 window matrices when they are manipulated via the frame matrix,
2333 window and frame matrix must of course agree where to find the
2334 glyphs for their rows. Possible manipulations that must be
2335 mirrored are assignments of rows of the desired frame matrix to the
2336 current frame matrix and scrolling the current frame matrix. */
2338 /* Build frame F's desired matrix from window matrices. Only windows
2339 which have the flag must_be_updated_p set have to be updated. Menu
2340 bar lines of a frame are not covered by window matrices, so make
2341 sure not to touch them in this function. */
2344 build_frame_matrix (struct frame
*f
)
2348 /* F must have a frame matrix when this function is called. */
2349 eassert (!FRAME_WINDOW_P (f
));
2351 /* Clear all rows in the frame matrix covered by window matrices.
2352 Menu bar lines are not covered by windows. */
2353 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2354 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2356 /* Build the matrix by walking the window tree. */
2357 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2358 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2362 /* Walk a window tree, building a frame matrix MATRIX from window
2363 matrices. W is the root of a window tree. */
2366 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2370 if (WINDOWP (w
->contents
))
2371 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2373 build_frame_matrix_from_leaf_window (matrix
, w
);
2375 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2380 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2381 desired frame matrix built. W is a leaf window whose desired or
2382 current matrix is to be added to FRAME_MATRIX. W's flag
2383 must_be_updated_p determines which matrix it contributes to
2384 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2385 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2386 Adding a desired matrix means setting up used counters and such in
2387 frame rows, while adding a current window matrix to FRAME_MATRIX
2388 means copying glyphs. The latter case corresponds to
2389 preserve_other_columns in the old redisplay. */
2392 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2394 struct glyph_matrix
*window_matrix
;
2395 int window_y
, frame_y
;
2396 /* If non-zero, a glyph to insert at the right border of W. */
2397 GLYPH right_border_glyph
;
2399 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2401 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2402 if (w
->must_be_updated_p
)
2404 window_matrix
= w
->desired_matrix
;
2406 /* Decide whether we want to add a vertical border glyph. */
2407 if (!WINDOW_RIGHTMOST_P (w
))
2409 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2412 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2414 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2416 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2417 spec_glyph_lookup_face (w
, &right_border_glyph
);
2420 if (GLYPH_FACE (right_border_glyph
) <= 0)
2421 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2425 window_matrix
= w
->current_matrix
;
2427 /* For all rows in the window matrix and corresponding rows in the
2430 frame_y
= window_matrix
->matrix_y
;
2431 while (window_y
< window_matrix
->nrows
)
2433 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2434 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2435 bool current_row_p
= window_matrix
== w
->current_matrix
;
2437 /* Fill up the frame row with spaces up to the left margin of the
2439 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2441 /* Fill up areas in the window matrix row with spaces. */
2442 fill_up_glyph_row_with_spaces (window_row
);
2444 /* If only part of W's desired matrix has been built, and
2445 window_row wasn't displayed, use the corresponding current
2447 if (window_matrix
== w
->desired_matrix
2448 && !window_row
->enabled_p
)
2450 window_row
= w
->current_matrix
->rows
+ window_y
;
2456 /* Copy window row to frame row. */
2457 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2458 window_row
->glyphs
[0],
2459 window_matrix
->matrix_w
* sizeof (struct glyph
));
2463 eassert (window_row
->enabled_p
);
2465 /* Only when a desired row has been displayed, we want
2466 the corresponding frame row to be updated. */
2467 frame_row
->enabled_p
= true;
2469 /* Maybe insert a vertical border between horizontally adjacent
2471 if (GLYPH_CHAR (right_border_glyph
) != 0)
2473 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2474 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2478 /* Window row window_y must be a slice of frame row
2480 eassert (glyph_row_slice_p (window_row
, frame_row
));
2482 /* If rows are in sync, we don't have to copy glyphs because
2483 frame and window share glyphs. */
2485 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2486 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2490 /* Set number of used glyphs in the frame matrix. Since we fill
2491 up with spaces, and visit leaf windows from left to right it
2492 can be done simply. */
2493 frame_row
->used
[TEXT_AREA
]
2494 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2502 /* Given a user-specified glyph, possibly including a Lisp-level face
2503 ID, return a glyph that has a realized face ID.
2504 This is used for glyphs displayed specially and not part of the text;
2505 for instance, vertical separators, truncation markers, etc. */
2508 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2510 int lface_id
= GLYPH_FACE (*glyph
);
2511 /* Convert the glyph's specified face to a realized (cache) face. */
2514 int face_id
= merge_faces (XFRAME (w
->frame
),
2515 Qt
, lface_id
, DEFAULT_FACE_ID
);
2516 SET_GLYPH_FACE (*glyph
, face_id
);
2520 /* Add spaces to a glyph row ROW in a window matrix.
2522 Each row has the form:
2524 +---------+-----------------------------+------------+
2525 | left | text | right |
2526 +---------+-----------------------------+------------+
2528 Left and right marginal areas are optional. This function adds
2529 spaces to areas so that there are no empty holes between areas.
2530 In other words: If the right area is not empty, the text area
2531 is filled up with spaces up to the right area. If the text area
2532 is not empty, the left area is filled up.
2534 To be called for frame-based redisplay, only. */
2537 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2539 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2540 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2541 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2545 /* Fill area AREA of glyph row ROW with spaces. To be called for
2546 frame-based redisplay only. */
2549 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2551 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2553 struct glyph
*end
= row
->glyphs
[area
+ 1];
2554 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2557 *text
++ = space_glyph
;
2558 row
->used
[area
] = text
- row
->glyphs
[area
];
2563 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2564 reached. In frame matrices only one area, TEXT_AREA, is used. */
2567 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2569 int i
= row
->used
[TEXT_AREA
];
2570 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2573 glyph
[i
++] = space_glyph
;
2575 row
->used
[TEXT_AREA
] = i
;
2580 /**********************************************************************
2581 Mirroring operations on frame matrices in window matrices
2582 **********************************************************************/
2584 /* Set frame being updated via frame-based redisplay to F. This
2585 function must be called before updates to make explicit that we are
2586 working on frame matrices or not. */
2589 set_frame_matrix_frame (struct frame
*f
)
2591 frame_matrix_frame
= f
;
2595 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2596 DESIRED_MATRIX is the desired matrix corresponding to
2597 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2598 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2599 frame_matrix_frame is non-null, this indicates that the exchange is
2600 done in frame matrices, and that we have to perform analogous
2601 operations in window matrices of frame_matrix_frame. */
2604 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2606 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2607 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2608 bool mouse_face_p
= current_row
->mouse_face_p
;
2610 /* Do current_row = desired_row. This exchanges glyph pointers
2611 between both rows, and does a structure assignment otherwise. */
2612 assign_row (current_row
, desired_row
);
2614 /* Enable current_row to mark it as valid. */
2615 current_row
->enabled_p
= true;
2616 current_row
->mouse_face_p
= mouse_face_p
;
2618 /* If we are called on frame matrices, perform analogous operations
2619 for window matrices. */
2620 if (frame_matrix_frame
)
2621 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2625 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2626 W's frame which has been made current (by swapping pointers between
2627 current and desired matrix). Perform analogous operations in the
2628 matrices of leaf windows in the window tree rooted at W. */
2631 mirror_make_current (struct window
*w
, int frame_row
)
2635 if (WINDOWP (w
->contents
))
2636 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2639 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2640 here because the checks performed in debug mode there
2641 will not allow the conversion. */
2642 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2644 /* If FRAME_ROW is within W, assign the desired row to the
2645 current row (exchanging glyph pointers). */
2646 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2648 struct glyph_row
*current_row
2649 = MATRIX_ROW (w
->current_matrix
, row
);
2650 struct glyph_row
*desired_row
2651 = MATRIX_ROW (w
->desired_matrix
, row
);
2653 if (desired_row
->enabled_p
)
2654 assign_row (current_row
, desired_row
);
2656 swap_glyph_pointers (desired_row
, current_row
);
2657 current_row
->enabled_p
= true;
2659 /* Set the Y coordinate of the mode/header line's row.
2660 It is needed in draw_row_with_mouse_face to find the
2661 screen coordinates. (Window-based redisplay sets
2662 this in update_window, but no one seems to do that
2663 for frame-based redisplay.) */
2664 if (current_row
->mode_line_p
)
2665 current_row
->y
= row
;
2669 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2674 /* Perform row dance after scrolling. We are working on the range of
2675 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2676 including) in MATRIX. COPY_FROM is a vector containing, for each
2677 row I in the range 0 <= I < NLINES, the index of the original line
2678 to move to I. This index is relative to the row range, i.e. 0 <=
2679 index < NLINES. RETAINED_P is a vector containing zero for each
2680 row 0 <= I < NLINES which is empty.
2682 This function is called from do_scrolling and do_direct_scrolling. */
2685 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2686 int *copy_from
, char *retained_p
)
2688 /* A copy of original rows. */
2689 struct glyph_row
*old_rows
;
2691 /* Rows to assign to. */
2692 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2696 /* Make a copy of the original rows. */
2698 SAFE_NALLOCA (old_rows
, 1, nlines
);
2699 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2701 /* Assign new rows, maybe clear lines. */
2702 for (i
= 0; i
< nlines
; ++i
)
2704 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2706 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2707 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2708 new_rows
[i
] = old_rows
[copy_from
[i
]];
2709 new_rows
[i
].enabled_p
= enabled_before_p
;
2711 /* RETAINED_P is zero for empty lines. */
2712 if (!retained_p
[copy_from
[i
]])
2713 new_rows
[i
].enabled_p
= false;
2716 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2717 if (frame_matrix_frame
)
2718 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2719 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2725 /* Synchronize glyph pointers in the current matrix of window W with
2726 the current frame matrix. */
2729 sync_window_with_frame_matrix_rows (struct window
*w
)
2731 struct frame
*f
= XFRAME (w
->frame
);
2732 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2733 int left
, right
, x
, width
;
2735 /* Preconditions: W must be a live window on a tty frame. */
2736 eassert (BUFFERP (w
->contents
));
2737 eassert (!FRAME_WINDOW_P (f
));
2739 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2740 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2741 x
= w
->current_matrix
->matrix_x
;
2742 width
= w
->current_matrix
->matrix_w
;
2744 window_row
= w
->current_matrix
->rows
;
2745 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2746 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2748 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2750 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2751 = frame_row
->glyphs
[0] + x
;
2752 window_row
->glyphs
[TEXT_AREA
]
2753 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2754 window_row
->glyphs
[LAST_AREA
]
2755 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2756 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2757 = window_row
->glyphs
[LAST_AREA
] - right
;
2762 /* Return the window in the window tree rooted in W containing frame
2763 row ROW. Value is null if none is found. */
2765 static struct window
*
2766 frame_row_to_window (struct window
*w
, int row
)
2768 struct window
*found
= NULL
;
2772 if (WINDOWP (w
->contents
))
2773 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2774 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2775 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2778 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2785 /* Perform a line dance in the window tree rooted at W, after
2786 scrolling a frame matrix in mirrored_line_dance.
2788 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2789 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2790 COPY_FROM is a vector containing, for each row I in the range 0 <=
2791 I < NLINES, the index of the original line to move to I. This
2792 index is relative to the row range, i.e. 0 <= index < NLINES.
2793 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2797 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2801 if (WINDOWP (w
->contents
))
2802 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2803 nlines
, copy_from
, retained_p
);
2806 /* W is a leaf window, and we are working on its current
2808 struct glyph_matrix
*m
= w
->current_matrix
;
2811 struct glyph_row
*old_rows
;
2813 /* Make a copy of the original rows of matrix m. */
2815 SAFE_NALLOCA (old_rows
, 1, m
->nrows
);
2816 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2818 for (i
= 0; i
< nlines
; ++i
)
2820 /* Frame relative line assigned to. */
2821 int frame_to
= i
+ unchanged_at_top
;
2823 /* Frame relative line assigned. */
2824 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2826 /* Window relative line assigned to. */
2827 int window_to
= frame_to
- m
->matrix_y
;
2829 /* Window relative line assigned. */
2830 int window_from
= frame_from
- m
->matrix_y
;
2832 /* Is assigned line inside window? */
2833 bool from_inside_window_p
2834 = window_from
>= 0 && window_from
< m
->matrix_h
;
2836 /* Is assigned to line inside window? */
2837 bool to_inside_window_p
2838 = window_to
>= 0 && window_to
< m
->matrix_h
;
2840 if (from_inside_window_p
&& to_inside_window_p
)
2842 /* Do the assignment. The enabled_p flag is saved
2843 over the assignment because the old redisplay did
2845 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2846 m
->rows
[window_to
] = old_rows
[window_from
];
2847 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2849 /* If frame line is empty, window line is empty, too. */
2850 if (!retained_p
[copy_from
[i
]])
2851 m
->rows
[window_to
].enabled_p
= false;
2853 else if (to_inside_window_p
)
2855 /* A copy between windows. This is an infrequent
2856 case not worth optimizing. */
2857 struct frame
*f
= XFRAME (w
->frame
);
2858 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2860 struct glyph_matrix
*m2
;
2863 w2
= frame_row_to_window (root
, frame_from
);
2864 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2865 -nw', FROM_FRAME sometimes has no associated window.
2866 This check avoids a segfault if W2 is null. */
2869 m2
= w2
->current_matrix
;
2870 m2_from
= frame_from
- m2
->matrix_y
;
2871 copy_row_except_pointers (m
->rows
+ window_to
,
2872 m2
->rows
+ m2_from
);
2874 /* If frame line is empty, window line is empty, too. */
2875 if (!retained_p
[copy_from
[i
]])
2876 m
->rows
[window_to
].enabled_p
= false;
2880 else if (from_inside_window_p
)
2884 /* If there was a copy between windows, make sure glyph
2885 pointers are in sync with the frame matrix. */
2887 sync_window_with_frame_matrix_rows (w
);
2889 /* Check that no pointers are lost. */
2895 /* Next window on same level. */
2896 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2903 /* Check that window and frame matrices agree about their
2904 understanding where glyphs of the rows are to find. For each
2905 window in the window tree rooted at W, check that rows in the
2906 matrices of leaf window agree with their frame matrices about
2910 check_window_matrix_pointers (struct window
*w
)
2914 if (WINDOWP (w
->contents
))
2915 check_window_matrix_pointers (XWINDOW (w
->contents
));
2918 struct frame
*f
= XFRAME (w
->frame
);
2919 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2920 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2923 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2928 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2929 a window and FRAME_MATRIX is the corresponding frame matrix. For
2930 each row in WINDOW_MATRIX check that it's a slice of the
2931 corresponding frame row. If it isn't, abort. */
2934 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2935 struct glyph_matrix
*frame_matrix
)
2937 /* Row number in WINDOW_MATRIX. */
2940 /* Row number corresponding to I in FRAME_MATRIX. */
2941 int j
= window_matrix
->matrix_y
;
2943 /* For all rows check that the row in the window matrix is a
2944 slice of the row in the frame matrix. If it isn't we didn't
2945 mirror an operation on the frame matrix correctly. */
2946 while (i
< window_matrix
->nrows
)
2948 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2949 frame_matrix
->rows
+ j
))
2955 #endif /* GLYPH_DEBUG */
2959 /**********************************************************************
2960 VPOS and HPOS translations
2961 **********************************************************************/
2965 /* Translate vertical position VPOS which is relative to window W to a
2966 vertical position relative to W's frame. */
2969 window_to_frame_vpos (struct window
*w
, int vpos
)
2971 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2972 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2973 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2974 eassert (vpos
>= 0 && vpos
<= FRAME_TOTAL_LINES (XFRAME (w
->frame
)));
2979 /* Translate horizontal position HPOS which is relative to window W to
2980 a horizontal position relative to W's frame. */
2983 window_to_frame_hpos (struct window
*w
, int hpos
)
2985 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2986 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2990 #endif /* GLYPH_DEBUG */
2994 /**********************************************************************
2996 **********************************************************************/
2998 /* Redraw frame F. */
3001 redraw_frame (struct frame
*f
)
3003 /* Error if F has no glyphs. */
3004 eassert (f
->glyphs_initialized_p
);
3006 if (FRAME_MSDOS_P (f
))
3007 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3009 clear_current_matrices (f
);
3011 windows_or_buffers_changed
= 13;
3012 /* Mark all windows as inaccurate, so that every window will have
3013 its redisplay done. */
3014 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3015 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), true);
3016 f
->garbaged
= false;
3019 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3020 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3021 If FRAME is omitted or nil, the selected frame is used. */)
3024 redraw_frame (decode_live_frame (frame
));
3028 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3029 doc
: /* Clear and redisplay all visible frames. */)
3032 Lisp_Object tail
, frame
;
3034 FOR_EACH_FRAME (tail
, frame
)
3035 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3036 redraw_frame (XFRAME (frame
));
3043 /***********************************************************************
3045 ***********************************************************************/
3047 /* Update frame F based on the data in desired matrices.
3049 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3050 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3052 Value is true if redisplay was stopped due to pending input. */
3055 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3057 /* True means display has been paused because of pending input. */
3059 struct window
*root_window
= XWINDOW (f
->root_window
);
3061 if (redisplay_dont_pause
)
3063 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3069 if (FRAME_WINDOW_P (f
))
3071 /* We are working on window matrix basis. All windows whose
3072 flag must_be_updated_p is set have to be updated. */
3074 /* Record that we are not working on frame matrices. */
3075 set_frame_matrix_frame (NULL
);
3077 /* Update all windows in the window tree of F, maybe stopping
3078 when pending input is detected. */
3081 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3082 /* Update the menu bar on X frames that don't have toolkit
3084 if (WINDOWP (f
->menu_bar_window
))
3085 update_window (XWINDOW (f
->menu_bar_window
), true);
3088 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3089 /* Update the tool-bar window, if present. */
3090 if (WINDOWP (f
->tool_bar_window
))
3092 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3094 /* Update tool-bar window. */
3095 if (w
->must_be_updated_p
)
3099 update_window (w
, true);
3100 w
->must_be_updated_p
= false;
3102 /* Swap tool-bar strings. We swap because we want to
3104 tem
= f
->current_tool_bar_string
;
3105 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3106 fset_desired_tool_bar_string (f
, tem
);
3111 /* Update windows. */
3112 paused_p
= update_window_tree (root_window
, force_p
);
3117 /* We are working on frame matrix basis. Set the frame on whose
3118 frame matrix we operate. */
3119 set_frame_matrix_frame (f
);
3121 /* Build F's desired matrix from window matrices. */
3122 build_frame_matrix (f
);
3124 /* Update the display. */
3126 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
, 1);
3129 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3131 if (FRAME_TTY (f
)->termscript
)
3132 fflush (FRAME_TTY (f
)->termscript
);
3133 if (FRAME_TERMCAP_P (f
))
3134 fflush (FRAME_TTY (f
)->output
);
3137 /* Check window matrices for lost pointers. */
3139 check_window_matrix_pointers (root_window
);
3140 add_frame_display_history (f
, paused_p
);
3145 /* Reset flags indicating that a window should be updated. */
3146 set_window_update_flags (root_window
, false);
3148 display_completed
= !paused_p
;
3152 /* Update a TTY frame F that has a menu dropped down over some of its
3153 glyphs. This is like the second part of update_frame, but it
3154 doesn't call build_frame_matrix, because we already have the
3155 desired matrix prepared, and don't want it to be overwritten by the
3156 text of the normal display.
3158 ROW and COL, if non-negative, are the row and column of the TTY
3159 frame where to position the cursor after the frame update is
3160 complete. Negative values mean ask update_frame_1 to position the
3161 cursor "normally", i.e. at point in the selected window. */
3163 update_frame_with_menu (struct frame
*f
, int row
, int col
)
3165 struct window
*root_window
= XWINDOW (f
->root_window
);
3166 bool paused_p
, cursor_at_point_p
;
3168 eassert (FRAME_TERMCAP_P (f
));
3170 /* We are working on frame matrix basis. Set the frame on whose
3171 frame matrix we operate. */
3172 set_frame_matrix_frame (f
);
3174 /* Update the display. */
3176 cursor_at_point_p
= !(row
>= 0 && col
>= 0);
3177 /* Force update_frame_1 not to stop due to pending input, and not
3179 paused_p
= update_frame_1 (f
, 1, 1, cursor_at_point_p
);
3180 /* ROW and COL tell us where in the menu to position the cursor, so
3181 that screen readers know the active region on the screen. */
3182 if (!cursor_at_point_p
)
3183 cursor_to (f
, row
, col
);
3186 if (FRAME_TTY (f
)->termscript
)
3187 fflush (FRAME_TTY (f
)->termscript
);
3188 fflush (FRAME_TTY (f
)->output
);
3189 /* Check window matrices for lost pointers. */
3192 /* We cannot possibly survive the matrix pointers check, since
3193 we have overwritten parts of the frame glyph matrix without
3194 making any updates to the window matrices. */
3195 check_window_matrix_pointers (root_window
);
3197 add_frame_display_history (f
, paused_p
);
3200 /* Reset flags indicating that a window should be updated. */
3201 set_window_update_flags (root_window
, false);
3202 display_completed
= !paused_p
;
3206 /************************************************************************
3207 Window-based updates
3208 ************************************************************************/
3210 /* Perform updates in window tree rooted at W.
3211 If FORCE_P, don't stop updating if input is pending. */
3214 update_window_tree (struct window
*w
, bool force_p
)
3218 while (w
&& !paused_p
)
3220 if (WINDOWP (w
->contents
))
3221 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3222 else if (w
->must_be_updated_p
)
3223 paused_p
|= update_window (w
, force_p
);
3225 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3232 /* Update window W if its flag must_be_updated_p is set.
3233 If FORCE_P, don't stop updating if input is pending. */
3236 update_single_window (struct window
*w
)
3238 if (w
->must_be_updated_p
)
3240 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3242 /* Record that this is not a frame-based redisplay. */
3243 set_frame_matrix_frame (NULL
);
3247 update_window (w
, true);
3250 /* Reset flag in W. */
3251 w
->must_be_updated_p
= false;
3255 #ifdef HAVE_WINDOW_SYSTEM
3257 /* Redraw lines from the current matrix of window W that are
3258 overlapped by other rows. YB is bottom-most y-position in W. */
3261 redraw_overlapped_rows (struct window
*w
, int yb
)
3264 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3266 /* If rows overlapping others have been changed, the rows being
3267 overlapped have to be redrawn. This won't draw lines that have
3268 already been drawn in update_window_line because overlapped_p in
3269 desired rows is 0, so after row assignment overlapped_p in
3270 current rows is 0. */
3271 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3273 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3275 if (!row
->enabled_p
)
3277 else if (row
->mode_line_p
)
3280 if (row
->overlapped_p
)
3282 enum glyph_row_area area
;
3284 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3286 output_cursor_to (w
, i
, 0, row
->y
,
3287 area
== TEXT_AREA
? row
->x
: 0);
3288 if (row
->used
[area
])
3289 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3290 area
, row
->used
[area
]);
3291 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3294 row
->overlapped_p
= 0;
3297 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3303 /* Redraw lines from the current matrix of window W that overlap
3304 others. YB is bottom-most y-position in W. */
3307 redraw_overlapping_rows (struct window
*w
, int yb
)
3310 struct glyph_row
*row
;
3311 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3313 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3315 row
= w
->current_matrix
->rows
+ i
;
3317 if (!row
->enabled_p
)
3319 else if (row
->mode_line_p
)
3322 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3324 if (row
->overlapping_p
)
3328 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3329 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3330 overlaps
|= OVERLAPS_PRED
;
3331 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3332 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3333 overlaps
|= OVERLAPS_SUCC
;
3337 if (row
->used
[LEFT_MARGIN_AREA
])
3338 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3340 if (row
->used
[TEXT_AREA
])
3341 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3343 if (row
->used
[RIGHT_MARGIN_AREA
])
3344 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3346 /* Record in neighbor rows that ROW overwrites part of
3348 if (overlaps
& OVERLAPS_PRED
)
3349 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3350 if (overlaps
& OVERLAPS_SUCC
)
3351 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3360 #endif /* HAVE_WINDOW_SYSTEM */
3363 #if defined GLYPH_DEBUG && 0
3365 /* Check that no row in the current matrix of window W is enabled
3366 which is below what's displayed in the window. */
3369 check_current_matrix_flags (struct window
*w
)
3371 bool last_seen_p
= 0;
3372 int i
, yb
= window_text_bottom_y (w
);
3374 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3376 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3377 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3379 else if (last_seen_p
&& row
->enabled_p
)
3384 #endif /* GLYPH_DEBUG */
3387 /* Update display of window W.
3388 If FORCE_P, don't stop updating when input is pending. */
3391 update_window (struct window
*w
, bool force_p
)
3393 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3395 int preempt_count
= baud_rate
/ 2400 + 1;
3396 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3398 /* Check that W's frame doesn't have glyph matrices. */
3399 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3402 /* Check pending input the first time so that we can quickly return. */
3404 detect_input_pending_ignore_squeezables ();
3406 /* If forced to complete the update, or if no input is pending, do
3408 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3410 struct glyph_row
*row
, *end
;
3411 struct glyph_row
*mode_line_row
;
3412 struct glyph_row
*header_line_row
;
3414 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3417 rif
->update_window_begin_hook (w
);
3418 yb
= window_text_bottom_y (w
);
3419 row
= MATRIX_ROW (desired_matrix
, 0);
3420 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3422 /* Take note of the header line, if there is one. We will
3423 update it below, after updating all of the window's lines. */
3424 if (row
->mode_line_p
)
3426 header_line_row
= row
;
3430 header_line_row
= NULL
;
3432 /* Update the mode line, if necessary. */
3433 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3434 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3436 mode_line_row
->y
= yb
+ WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
3437 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3439 &mouse_face_overwritten_p
);
3442 /* Find first enabled row. Optimizations in redisplay_internal
3443 may lead to an update with only one row enabled. There may
3444 be also completely empty matrices. */
3445 while (row
< end
&& !row
->enabled_p
)
3448 /* Try reusing part of the display by copying. */
3449 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3451 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3454 /* All rows were found to be equal. */
3460 /* We've scrolled the display. */
3466 /* Update the rest of the lines. */
3467 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3468 /* scrolling_window resets the enabled_p flag of the rows it
3469 reuses from current_matrix. */
3472 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3475 /* We'll have to play a little bit with when to
3476 detect_input_pending. If it's done too often,
3477 scrolling large windows with repeated scroll-up
3478 commands will too quickly pause redisplay. */
3479 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3480 detect_input_pending_ignore_squeezables ();
3481 changed_p
|= update_window_line (w
, vpos
,
3482 &mouse_face_overwritten_p
);
3484 /* Mark all rows below the last visible one in the current
3485 matrix as invalid. This is necessary because of
3486 variable line heights. Consider the case of three
3487 successive redisplays, where the first displays 5
3488 lines, the second 3 lines, and the third 5 lines again.
3489 If the second redisplay wouldn't mark rows in the
3490 current matrix invalid, the third redisplay might be
3491 tempted to optimize redisplay based on lines displayed
3492 in the first redisplay. */
3493 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3494 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3495 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, i
, false);
3498 /* Was display preempted? */
3499 paused_p
= row
< end
;
3503 /* Update the header line after scrolling because a new header
3504 line would otherwise overwrite lines at the top of the window
3505 that can be scrolled. */
3506 if (header_line_row
&& header_line_row
->enabled_p
)
3508 header_line_row
->y
= 0;
3509 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3512 /* Fix the appearance of overlapping/overlapped rows. */
3513 if (!paused_p
&& !w
->pseudo_window_p
)
3515 #ifdef HAVE_WINDOW_SYSTEM
3516 if (changed_p
&& rif
->fix_overlapping_area
)
3518 redraw_overlapped_rows (w
, yb
);
3519 redraw_overlapping_rows (w
, yb
);
3523 /* Make cursor visible at cursor position of W. */
3524 set_window_cursor_after_update (w
);
3526 #if 0 /* Check that current matrix invariants are satisfied. This is
3527 for debugging only. See the comment of check_matrix_invariants. */
3528 IF_DEBUG (check_matrix_invariants (w
));
3533 /* Remember the redisplay method used to display the matrix. */
3534 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3537 #ifdef HAVE_WINDOW_SYSTEM
3538 update_window_fringes (w
, 0);
3541 /* End the update of window W. Don't set the cursor if we
3542 paused updating the display because in this case,
3543 set_window_cursor_after_update hasn't been called, and
3544 W->output_cursor doesn't contain the cursor location. */
3545 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3551 /* check_current_matrix_flags (w); */
3552 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3555 #ifdef HAVE_XWIDGETS
3556 xwidget_end_redisplay(w
, w
->current_matrix
);
3558 clear_glyph_matrix (desired_matrix
);
3564 /* Update the display of area AREA in window W, row number VPOS.
3565 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3568 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3569 enum glyph_row_area area
, int vpos
)
3571 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3572 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3574 /* Set cursor to start of glyphs, write them, and clear to the end
3575 of the area. I don't think that something more sophisticated is
3576 necessary here, since marginal areas will not be the default. */
3577 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3578 if (desired_row
->used
[area
])
3579 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3580 area
, desired_row
->used
[area
]);
3581 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3585 /* Update the display of the text area of row VPOS in window W.
3586 Value is true if display has changed. */
3589 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3591 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3592 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3593 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3596 /* If rows are at different X or Y, or rows have different height,
3597 or the current row is marked invalid, write the entire line. */
3598 if (!current_row
->enabled_p
3599 || desired_row
->y
!= current_row
->y
3600 || desired_row
->ascent
!= current_row
->ascent
3601 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3602 || desired_row
->phys_height
!= current_row
->phys_height
3603 || desired_row
->visible_height
!= current_row
->visible_height
3604 || current_row
->overlapped_p
3605 /* This next line is necessary for correctly redrawing
3606 mouse-face areas after scrolling and other operations.
3607 However, it causes excessive flickering when mouse is moved
3608 across the mode line. Luckily, turning it off for the mode
3609 line doesn't seem to hurt anything. -- cyd.
3610 But it is still needed for the header line. -- kfs. */
3611 || (current_row
->mouse_face_p
3612 && !(current_row
->mode_line_p
&& vpos
> 0))
3613 || current_row
->x
!= desired_row
->x
)
3615 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3617 if (desired_row
->used
[TEXT_AREA
])
3618 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3619 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3621 /* Clear to end of window. */
3622 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3625 /* This erases the cursor. We do this here because
3626 notice_overwritten_cursor cannot easily check this, which
3627 might indicate that the whole functionality of
3628 notice_overwritten_cursor would better be implemented here.
3629 On the other hand, we need notice_overwritten_cursor as long
3630 as mouse highlighting is done asynchronously outside of
3632 if (vpos
== w
->phys_cursor
.vpos
)
3633 w
->phys_cursor_on_p
= 0;
3638 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3639 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3640 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3641 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3642 bool abort_skipping
= 0;
3644 /* If the desired row extends its face to the text area end, and
3645 unless the current row also does so at the same position,
3646 make sure we write at least one glyph, so that the face
3647 extension actually takes place. */
3648 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3649 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3650 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3651 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3654 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3658 /* Loop over glyphs that current and desired row may have
3662 bool can_skip_p
= !abort_skipping
;
3664 /* Skip over glyphs that both rows have in common. These
3665 don't have to be written. We can't skip if the last
3666 current glyph overlaps the glyph to its right. For
3667 example, consider a current row of `if ' with the `f' in
3668 Courier bold so that it overlaps the ` ' to its right.
3669 If the desired row is ` ', we would skip over the space
3670 after the `if' and there would remain a pixel from the
3671 `f' on the screen. */
3672 if (overlapping_glyphs_p
&& i
> 0)
3674 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3677 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3679 can_skip_p
= (right
== 0 && !abort_skipping
);
3687 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3689 x
+= desired_glyph
->pixel_width
;
3690 ++desired_glyph
, ++current_glyph
, ++i
;
3693 /* Consider the case that the current row contains "xxx
3694 ppp ggg" in italic Courier font, and the desired row
3695 is "xxx ggg". The character `p' has lbearing, `g'
3696 has not. The loop above will stop in front of the
3697 first `p' in the current row. If we would start
3698 writing glyphs there, we wouldn't erase the lbearing
3699 of the `p'. The rest of the lbearing problem is then
3700 taken care of by draw_glyphs. */
3701 if (overlapping_glyphs_p
3703 && i
< current_row
->used
[TEXT_AREA
]
3704 && (current_row
->used
[TEXT_AREA
]
3705 != desired_row
->used
[TEXT_AREA
]))
3709 rif
->get_glyph_overhangs (current_glyph
,
3712 while (left
> 0 && i
> 0)
3714 --i
, --desired_glyph
, --current_glyph
;
3715 x
-= desired_glyph
->pixel_width
;
3716 left
-= desired_glyph
->pixel_width
;
3719 /* Abort the skipping algorithm if we end up before
3720 our starting point, to avoid looping (bug#1070).
3721 This can happen when the lbearing is larger than
3723 abort_skipping
= (i
< start_hpos
);
3727 /* Try to avoid writing the entire rest of the desired row
3728 by looking for a resync point. This mainly prevents
3729 mode line flickering in the case the mode line is in
3730 fixed-pitch font, which it usually will be. */
3731 if (i
< desired_row
->used
[TEXT_AREA
])
3733 int start_x
= x
, start_hpos
= i
;
3734 struct glyph
*start
= desired_glyph
;
3736 bool skip_first_p
= !can_skip_p
;
3738 /* Find the next glyph that's equal again. */
3741 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3744 x
+= desired_glyph
->pixel_width
;
3745 current_x
+= current_glyph
->pixel_width
;
3746 ++desired_glyph
, ++current_glyph
, ++i
;
3750 if (i
== start_hpos
|| x
!= current_x
)
3754 desired_glyph
= start
;
3758 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3759 rif
->write_glyphs (w
, updated_row
, start
,
3760 TEXT_AREA
, i
- start_hpos
);
3765 /* Write the rest. */
3766 if (i
< desired_row
->used
[TEXT_AREA
])
3768 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3769 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3770 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3774 /* Maybe clear to end of line. */
3775 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3777 /* If new row extends to the end of the text area, nothing
3778 has to be cleared, if and only if we did a write_glyphs
3779 above. This is made sure by setting desired_stop_pos
3780 appropriately above. */
3781 eassert (i
< desired_row
->used
[TEXT_AREA
]
3782 || ((desired_row
->used
[TEXT_AREA
]
3783 == current_row
->used
[TEXT_AREA
])
3784 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3786 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3788 /* If old row extends to the end of the text area, clear. */
3789 if (i
>= desired_row
->used
[TEXT_AREA
])
3790 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3791 desired_row
->pixel_width
);
3792 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3795 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3797 /* Otherwise clear to the end of the old row. Everything
3798 after that position should be clear already. */
3801 if (i
>= desired_row
->used
[TEXT_AREA
])
3802 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3803 desired_row
->pixel_width
);
3805 /* If cursor is displayed at the end of the line, make sure
3806 it's cleared. Nowadays we don't have a phys_cursor_glyph
3807 with which to erase the cursor (because this method
3808 doesn't work with lbearing/rbearing), so we must do it
3810 if (vpos
== w
->phys_cursor
.vpos
3811 && (desired_row
->reversed_p
3812 ? (w
->phys_cursor
.hpos
< 0)
3813 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3815 w
->phys_cursor_on_p
= 0;
3819 xlim
= current_row
->pixel_width
;
3820 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3829 /* Update row VPOS in window W. Value is true if display has been changed. */
3832 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3834 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3835 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3836 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3839 /* A row can be completely invisible in case a desired matrix was
3840 built with a vscroll and then make_cursor_line_fully_visible shifts
3841 the matrix. Make sure to make such rows current anyway, since
3842 we need the correct y-position, for example, in the current matrix. */
3843 if (desired_row
->mode_line_p
3844 || desired_row
->visible_height
> 0)
3846 eassert (desired_row
->enabled_p
);
3848 /* Update display of the left margin area, if there is one. */
3849 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3852 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3853 /* Setting this flag will ensure the vertical border, if
3854 any, between this window and the one on its left will be
3855 redrawn. This is necessary because updating the left
3856 margin area can potentially draw over the border. */
3857 current_row
->redraw_fringe_bitmaps_p
= 1;
3860 /* Update the display of the text area. */
3861 if (update_text_area (w
, desired_row
, vpos
))
3864 if (current_row
->mouse_face_p
)
3865 *mouse_face_overwritten_p
= 1;
3868 /* Update display of the right margin area, if there is one. */
3869 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3872 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3875 /* Draw truncation marks etc. */
3876 if (!current_row
->enabled_p
3877 || desired_row
->y
!= current_row
->y
3878 || desired_row
->visible_height
!= current_row
->visible_height
3879 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3880 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3881 || current_row
->redraw_fringe_bitmaps_p
3882 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3883 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3884 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3885 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3886 rif
->after_update_window_line_hook (w
, desired_row
);
3889 /* Update current_row from desired_row. */
3890 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3895 /* Set the cursor after an update of window W. This function may only
3896 be called from update_window. */
3899 set_window_cursor_after_update (struct window
*w
)
3901 struct frame
*f
= XFRAME (w
->frame
);
3902 int cx
, cy
, vpos
, hpos
;
3904 /* Not intended for frame matrix updates. */
3905 eassert (FRAME_WINDOW_P (f
));
3907 if (cursor_in_echo_area
3908 && !NILP (echo_area_buffer
[0])
3909 /* If we are showing a message instead of the mini-buffer,
3910 show the cursor for the message instead. */
3911 && XWINDOW (minibuf_window
) == w
3912 && EQ (minibuf_window
, echo_area_window
)
3913 /* These cases apply only to the frame that contains
3914 the active mini-buffer window. */
3915 && FRAME_HAS_MINIBUF_P (f
)
3916 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3918 cx
= cy
= vpos
= hpos
= 0;
3920 if (cursor_in_echo_area
>= 0)
3922 /* If the mini-buffer is several lines high, find the last
3923 line that has any text on it. Note: either all lines
3924 are enabled or none. Otherwise we wouldn't be able to
3926 struct glyph_row
*row
, *last_row
;
3927 struct glyph
*glyph
;
3928 int yb
= window_text_bottom_y (w
);
3931 row
= w
->current_matrix
->rows
;
3932 while (row
->enabled_p
3933 && (last_row
== NULL
3934 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3936 if (row
->used
[TEXT_AREA
]
3937 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3944 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3945 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3947 while (last
> start
&& last
->charpos
< 0)
3950 for (glyph
= start
; glyph
< last
; ++glyph
)
3952 cx
+= glyph
->pixel_width
;
3957 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3965 hpos
= w
->cursor
.hpos
;
3966 vpos
= w
->cursor
.vpos
;
3969 /* Window cursor can be out of sync for horizontally split windows.
3970 Horizontal position is -1 when cursor is on the left fringe. */
3971 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3972 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3973 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3977 /* Set WINDOW->must_be_updated_p to ON_P for all windows in
3978 the window tree rooted at W. */
3981 set_window_update_flags (struct window
*w
, bool on_p
)
3985 if (WINDOWP (w
->contents
))
3986 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3988 w
->must_be_updated_p
= on_p
;
3990 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3996 /***********************************************************************
3997 Window-Based Scrolling
3998 ***********************************************************************/
4000 /* Structure describing rows in scrolling_window. */
4004 /* Number of occurrences of this row in desired and current matrix. */
4005 int old_uses
, new_uses
;
4007 /* Vpos of row in new matrix. */
4008 int new_line_number
;
4010 /* Bucket index of this row_entry in the hash table row_table. */
4013 /* The row described by this entry. */
4014 struct glyph_row
*row
;
4016 /* Hash collision chain. */
4017 struct row_entry
*next
;
4020 /* A pool to allocate row_entry structures from, and the size of the
4021 pool. The pool is reallocated in scrolling_window when we find
4022 that we need a larger one. */
4024 static struct row_entry
*row_entry_pool
;
4025 static ptrdiff_t row_entry_pool_size
;
4027 /* Index of next free entry in row_entry_pool. */
4029 static ptrdiff_t row_entry_idx
;
4031 /* The hash table used during scrolling, and the table's size. This
4032 table is used to quickly identify equal rows in the desired and
4035 static struct row_entry
**row_table
;
4036 static ptrdiff_t row_table_size
;
4038 /* Vectors of pointers to row_entry structures belonging to the
4039 current and desired matrix, and the size of the vectors. */
4041 static struct row_entry
**old_lines
, **new_lines
;
4042 static ptrdiff_t old_lines_size
, new_lines_size
;
4044 /* A pool to allocate run structures from, and its size. */
4046 static struct run
*run_pool
;
4047 static ptrdiff_t runs_size
;
4049 /* A vector of runs of lines found during scrolling. */
4051 static struct run
**runs
;
4053 /* Add glyph row ROW to the scrolling hash table. */
4055 static struct row_entry
*
4056 add_row_entry (struct glyph_row
*row
)
4058 struct row_entry
*entry
;
4059 ptrdiff_t i
= row
->hash
% row_table_size
;
4061 entry
= row_table
[i
];
4062 eassert (entry
|| verify_row_hash (row
));
4063 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4064 entry
= entry
->next
;
4068 entry
= row_entry_pool
+ row_entry_idx
++;
4070 entry
->old_uses
= entry
->new_uses
= 0;
4071 entry
->new_line_number
= 0;
4073 entry
->next
= row_table
[i
];
4074 row_table
[i
] = entry
;
4081 /* Try to reuse part of the current display of W by scrolling lines.
4082 HEADER_LINE_P means W has a header line.
4084 The algorithm is taken from Communications of the ACM, Apr78 "A
4085 Technique for Isolating Differences Between Files." It should take
4088 A short outline of the steps of the algorithm
4090 1. Skip lines equal at the start and end of both matrices.
4092 2. Enter rows in the current and desired matrix into a symbol
4093 table, counting how often they appear in both matrices.
4095 3. Rows that appear exactly once in both matrices serve as anchors,
4096 i.e. we assume that such lines are likely to have been moved.
4098 4. Starting from anchor lines, extend regions to be scrolled both
4099 forward and backward.
4103 -1 if all rows were found to be equal.
4104 0 to indicate that we did not scroll the display, or
4105 1 if we did scroll. */
4108 scrolling_window (struct window
*w
, bool header_line_p
)
4110 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4111 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4112 int yb
= window_text_bottom_y (w
);
4114 int j
, first_old
, first_new
, last_old
, last_new
;
4117 struct row_entry
*entry
;
4118 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4120 /* Skip over rows equal at the start. */
4121 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4123 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4124 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4128 && !d
->redraw_fringe_bitmaps_p
4130 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4131 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4132 && row_equal_p (c
, d
, 1))
4135 d
->enabled_p
= false;
4141 #ifdef HAVE_XWIDGETS
4142 //currently this is needed to detect xwidget movement reliably. or probably not.
4143 //printf("scrolling_window\n");
4147 /* Give up if some rows in the desired matrix are not enabled. */
4148 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4151 first_old
= first_new
= i
;
4153 /* Set last_new to the index + 1 of the row that reaches the
4154 bottom boundary in the desired matrix. Give up if we find a
4155 disabled row before we reach the bottom boundary. */
4157 while (i
< desired_matrix
->nrows
- 1)
4161 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4163 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4172 /* Set last_old to the index + 1 of the row that reaches the bottom
4173 boundary in the current matrix. We don't look at the enabled
4174 flag here because we plan to reuse part of the display even if
4175 other parts are disabled. */
4177 while (i
< current_matrix
->nrows
- 1)
4179 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4188 /* Skip over rows equal at the bottom. */
4191 while (i
- 1 > first_new
4192 && j
- 1 > first_old
4193 && MATRIX_ROW_ENABLED_P (current_matrix
, j
- 1)
4194 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4195 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4196 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4197 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4198 MATRIX_ROW (current_matrix
, j
- 1), 1))
4203 /* Nothing to do if all rows are equal. */
4204 if (last_new
== first_new
)
4207 /* Check for integer overflow in size calculation.
4209 If next_almost_prime checks (N) for divisibility by 2..10, then
4210 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4211 So, set next_almost_prime_increment_max to 10.
4213 It's just a coincidence that next_almost_prime_increment_max ==
4214 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4215 13, then next_almost_prime_increment_max would be 14, e.g.,
4216 because next_almost_prime (113) would be 127. */
4218 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4219 enum { next_almost_prime_increment_max
= 10 };
4220 ptrdiff_t row_table_max
=
4221 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4222 - next_almost_prime_increment_max
);
4223 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4224 if (current_nrows_max
< current_matrix
->nrows
)
4225 memory_full (SIZE_MAX
);
4228 /* Reallocate vectors, tables etc. if necessary. */
4230 if (current_matrix
->nrows
> old_lines_size
)
4231 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4232 current_matrix
->nrows
- old_lines_size
,
4233 INT_MAX
, sizeof *old_lines
);
4235 if (desired_matrix
->nrows
> new_lines_size
)
4236 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4237 desired_matrix
->nrows
- new_lines_size
,
4238 INT_MAX
, sizeof *new_lines
);
4240 n
= desired_matrix
->nrows
;
4241 n
+= current_matrix
->nrows
;
4242 if (row_table_size
< 3 * n
)
4244 ptrdiff_t size
= next_almost_prime (3 * n
);
4245 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4246 row_table_size
= size
;
4247 memset (row_table
, 0, size
* sizeof *row_table
);
4250 if (n
> row_entry_pool_size
)
4251 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4252 n
- row_entry_pool_size
,
4253 -1, sizeof *row_entry_pool
);
4255 if (desired_matrix
->nrows
> runs_size
)
4257 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4258 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4259 runs_size
= desired_matrix
->nrows
;
4262 nruns
= run_idx
= 0;
4265 /* Add rows from the current and desired matrix to the hash table
4266 row_hash_table to be able to find equal ones quickly. */
4268 for (i
= first_old
; i
< last_old
; ++i
)
4270 if (MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4272 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4273 old_lines
[i
] = entry
;
4277 old_lines
[i
] = NULL
;
4280 for (i
= first_new
; i
< last_new
; ++i
)
4282 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4283 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4285 entry
->new_line_number
= i
;
4286 new_lines
[i
] = entry
;
4289 /* Identify moves based on lines that are unique and equal
4290 in both matrices. */
4291 for (i
= first_old
; i
< last_old
;)
4293 && old_lines
[i
]->old_uses
== 1
4294 && old_lines
[i
]->new_uses
== 1)
4297 int new_line
= old_lines
[i
]->new_line_number
;
4298 struct run
*run
= run_pool
+ run_idx
++;
4301 run
->current_vpos
= i
;
4302 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4303 run
->desired_vpos
= new_line
;
4304 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4306 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4308 /* Extend backward. */
4311 while (p
> first_old
4313 && old_lines
[p
] == new_lines
[q
])
4315 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4316 --run
->current_vpos
;
4317 --run
->desired_vpos
;
4320 run
->desired_y
-= h
;
4321 run
->current_y
-= h
;
4325 /* Extend forward. */
4330 && old_lines
[p
] == new_lines
[q
])
4332 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4338 /* Insert run into list of all runs. Order runs by copied
4339 pixel lines. Note that we record runs that don't have to
4340 be copied because they are already in place. This is done
4341 because we can avoid calling update_window_line in this
4343 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4345 for (q
= nruns
; q
> p
; --q
)
4346 runs
[q
] = runs
[q
- 1];
4355 /* Do the moves. Do it in a way that we don't overwrite something
4356 we want to copy later on. This is not solvable in general
4357 because there is only one display and we don't have a way to
4358 exchange areas on this display. Example:
4360 +-----------+ +-----------+
4362 +-----------+ --> +-----------+
4364 +-----------+ +-----------+
4366 Instead, prefer bigger moves, and invalidate moves that would
4367 copy from where we copied to. */
4369 for (i
= 0; i
< nruns
; ++i
)
4370 if (runs
[i
]->nrows
> 0)
4372 struct run
*r
= runs
[i
];
4374 /* Copy on the display. */
4375 if (r
->current_y
!= r
->desired_y
)
4377 rif
->clear_window_mouse_face (w
);
4378 rif
->scroll_run_hook (w
, r
);
4381 /* Truncate runs that copy to where we copied to, and
4382 invalidate runs that copy from where we copied to. */
4383 for (j
= nruns
- 1; j
> i
; --j
)
4385 struct run
*p
= runs
[j
];
4386 bool truncated_p
= 0;
4389 && p
->desired_y
< r
->desired_y
+ r
->height
4390 && p
->desired_y
+ p
->height
> r
->desired_y
)
4392 if (p
->desired_y
< r
->desired_y
)
4394 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4395 p
->height
= r
->desired_y
- p
->desired_y
;
4400 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4403 if (p
->nrows
<= nrows_copied
)
4407 int height_copied
= (r
->desired_y
+ r
->height
4410 p
->current_vpos
+= nrows_copied
;
4411 p
->desired_vpos
+= nrows_copied
;
4412 p
->nrows
-= nrows_copied
;
4413 p
->current_y
+= height_copied
;
4414 p
->desired_y
+= height_copied
;
4415 p
->height
-= height_copied
;
4421 if (r
->current_y
!= r
->desired_y
4422 /* The condition below is equivalent to
4423 ((p->current_y >= r->desired_y
4424 && p->current_y < r->desired_y + r->height)
4425 || (p->current_y + p->height > r->desired_y
4426 && (p->current_y + p->height
4427 <= r->desired_y + r->height)))
4428 because we have 0 < p->height <= r->height. */
4429 && p
->current_y
< r
->desired_y
+ r
->height
4430 && p
->current_y
+ p
->height
> r
->desired_y
)
4433 /* Reorder runs by copied pixel lines if truncated. */
4434 if (truncated_p
&& p
->nrows
> 0)
4438 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4440 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4445 /* Assign matrix rows. */
4446 for (j
= 0; j
< r
->nrows
; ++j
)
4448 struct glyph_row
*from
, *to
;
4449 bool to_overlapped_p
;
4451 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4452 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4453 to_overlapped_p
= to
->overlapped_p
;
4454 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4455 assign_row (to
, from
);
4456 /* The above `assign_row' actually does swap, so if we had
4457 an overlap in the copy destination of two runs, then
4458 the second run would assign a previously disabled bogus
4459 row. But thanks to the truncation code in the
4460 preceding for-loop, we no longer have such an overlap,
4461 and thus the assigned row should always be enabled. */
4462 eassert (to
->enabled_p
);
4463 from
->enabled_p
= false;
4464 to
->overlapped_p
= to_overlapped_p
;
4468 /* Clear the hash table, for the next time. */
4469 for (i
= 0; i
< row_entry_idx
; ++i
)
4470 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4472 /* Value is 1 to indicate that we scrolled the display. */
4478 /************************************************************************
4480 ************************************************************************/
4482 /* Update the desired frame matrix of frame F.
4484 FORCE_P means that the update should not be stopped by pending input.
4485 INHIBIT_ID_P means that scrolling by insert/delete should not be tried.
4486 SET_CURSOR_P false means do not set cursor at point in selected window.
4488 Value is true if update was stopped due to pending input. */
4491 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
,
4494 /* Frame matrices to work on. */
4495 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4496 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4499 int preempt_count
= baud_rate
/ 2400 + 1;
4501 eassert (current_matrix
&& desired_matrix
);
4503 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4504 calculate_costs (f
);
4506 if (preempt_count
<= 0)
4509 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4515 /* If we cannot insert/delete lines, it's no use trying it. */
4516 if (!FRAME_LINE_INS_DEL_OK (f
))
4519 /* See if any of the desired lines are enabled; don't compute for
4520 i/d line if just want cursor motion. */
4521 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4522 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4525 /* Try doing i/d line, if not yet inhibited. */
4526 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4527 force_p
|= scrolling (f
);
4529 /* Update the individual lines as needed. Do bottom line first. */
4530 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4531 update_frame_line (f
, desired_matrix
->nrows
- 1);
4533 /* Now update the rest of the lines. */
4534 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4536 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4538 if (FRAME_TERMCAP_P (f
))
4540 /* Flush out every so many lines.
4541 Also flush out if likely to have more than 1k buffered
4542 otherwise. I'm told that some telnet connections get
4543 really screwed by more than 1k output at once. */
4544 FILE *display_output
= FRAME_TTY (f
)->output
;
4547 ptrdiff_t outq
= __fpending (display_output
);
4549 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4550 fflush (display_output
);
4554 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4555 detect_input_pending_ignore_squeezables ();
4557 update_frame_line (f
, i
);
4561 pause_p
= 0 < i
&& i
< FRAME_TOTAL_LINES (f
) - 1;
4563 /* Now just clean up termcap drivers and set cursor, etc. */
4564 if (!pause_p
&& set_cursor_p
)
4566 if ((cursor_in_echo_area
4567 /* If we are showing a message instead of the mini-buffer,
4568 show the cursor for the message instead of for the
4569 (now hidden) mini-buffer contents. */
4570 || (EQ (minibuf_window
, selected_window
)
4571 && EQ (minibuf_window
, echo_area_window
)
4572 && !NILP (echo_area_buffer
[0])))
4573 /* These cases apply only to the frame that contains
4574 the active mini-buffer window. */
4575 && FRAME_HAS_MINIBUF_P (f
)
4576 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4578 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4581 if (cursor_in_echo_area
< 0)
4583 /* Negative value of cursor_in_echo_area means put
4584 cursor at beginning of line. */
4590 /* Positive value of cursor_in_echo_area means put
4591 cursor at the end of the prompt. If the mini-buffer
4592 is several lines high, find the last line that has
4594 row
= FRAME_TOTAL_LINES (f
);
4600 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4602 /* Frame rows are filled up with spaces that
4603 must be ignored here. */
4604 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4606 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4607 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4610 && (last
- 1)->charpos
< 0)
4616 while (row
> top
&& col
== 0);
4618 /* Make sure COL is not out of range. */
4619 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4621 /* If we have another row, advance cursor into it. */
4622 if (row
< FRAME_TOTAL_LINES (f
) - 1)
4624 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4627 /* Otherwise move it back in range. */
4629 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4633 cursor_to (f
, row
, col
);
4637 /* We have only one cursor on terminal frames. Use it to
4638 display the cursor of the selected window. */
4639 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4640 if (w
->cursor
.vpos
>= 0
4641 /* The cursor vpos may be temporarily out of bounds
4642 in the following situation: There is one window,
4643 with the cursor in the lower half of it. The window
4644 is split, and a message causes a redisplay before
4645 a new cursor position has been computed. */
4646 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4648 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4649 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4651 x
+= max (0, w
->left_margin_cols
);
4652 cursor_to (f
, y
, x
);
4659 clear_desired_matrices (f
);
4664 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4667 scrolling (struct frame
*frame
)
4669 int unchanged_at_top
, unchanged_at_bottom
;
4673 int height
= FRAME_TOTAL_LINES (frame
);
4674 int free_at_end_vpos
= height
;
4675 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4676 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4677 verify (sizeof (int) <= sizeof (unsigned));
4678 verify (alignof (unsigned) % alignof (int) == 0);
4681 SAFE_NALLOCA (old_hash
, 4, height
);
4682 unsigned *new_hash
= old_hash
+ height
;
4683 int *draw_cost
= (int *) (new_hash
+ height
);
4684 int *old_draw_cost
= draw_cost
+ height
;
4686 eassert (current_matrix
);
4688 /* Compute hash codes of all the lines. Also calculate number of
4689 changed lines, number of unchanged lines at the beginning, and
4690 number of unchanged lines at the end. */
4692 unchanged_at_top
= 0;
4693 unchanged_at_bottom
= height
;
4694 for (i
= 0; i
< height
; i
++)
4696 /* Give up on this scrolling if some old lines are not enabled. */
4697 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4702 old_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (current_matrix
, i
));
4703 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4705 /* This line cannot be redrawn, so don't let scrolling mess it. */
4706 new_hash
[i
] = old_hash
[i
];
4707 #define INFINITY 1000000 /* Taken from scroll.c */
4708 draw_cost
[i
] = INFINITY
;
4712 new_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (desired_matrix
, i
));
4713 draw_cost
[i
] = line_draw_cost (frame
, desired_matrix
, i
);
4716 if (old_hash
[i
] != new_hash
[i
])
4719 unchanged_at_bottom
= height
- i
- 1;
4721 else if (i
== unchanged_at_top
)
4723 old_draw_cost
[i
] = line_draw_cost (frame
, current_matrix
, i
);
4726 /* If changed lines are few, don't allow preemption, don't scroll. */
4727 if ((!FRAME_SCROLL_REGION_OK (frame
)
4728 && changed_lines
< baud_rate
/ 2400)
4729 || unchanged_at_bottom
== height
)
4735 window_size
= (height
- unchanged_at_top
4736 - unchanged_at_bottom
);
4738 if (FRAME_SCROLL_REGION_OK (frame
))
4739 free_at_end_vpos
-= unchanged_at_bottom
;
4740 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4741 free_at_end_vpos
= -1;
4743 /* Do id/calc only if small window, or slow terminal, or many lines
4744 in common between current frame and desired frame. But the
4745 window size must be at least 2. */
4746 if ((FRAME_SCROLL_REGION_OK (frame
)
4747 || window_size
< 18 || baud_rate
<= 2400
4749 < 10 * scrolling_max_lines_saved (unchanged_at_top
,
4750 height
- unchanged_at_bottom
,
4751 old_hash
, new_hash
, draw_cost
)))
4752 && 2 <= window_size
)
4753 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4754 draw_cost
+ unchanged_at_top
- 1,
4755 old_draw_cost
+ unchanged_at_top
- 1,
4756 old_hash
+ unchanged_at_top
- 1,
4757 new_hash
+ unchanged_at_top
- 1,
4758 free_at_end_vpos
- unchanged_at_top
);
4765 /* Count the number of blanks at the start of the vector of glyphs R
4766 which is LEN glyphs long. */
4769 count_blanks (struct glyph
*r
, int len
)
4773 for (i
= 0; i
< len
; ++i
)
4774 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4781 /* Count the number of glyphs in common at the start of the glyph
4782 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4783 of STR2. Value is the number of equal glyphs equal at the start. */
4786 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4788 struct glyph
*p1
= str1
;
4789 struct glyph
*p2
= str2
;
4793 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4800 /* Char insertion/deletion cost vector, from term.c */
4802 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4805 /* Perform a frame-based update on line VPOS in frame FRAME. */
4808 update_frame_line (struct frame
*f
, int vpos
)
4810 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4812 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4813 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4814 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4815 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4816 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4817 bool must_write_whole_line_p
;
4818 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4819 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4820 != FACE_TTY_DEFAULT_BG_COLOR
);
4822 if (colored_spaces_p
)
4825 /* Current row not enabled means it has unknown contents. We must
4826 write the whole desired line in that case. */
4827 must_write_whole_line_p
= !current_row
->enabled_p
;
4828 if (must_write_whole_line_p
)
4835 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4836 olen
= current_row
->used
[TEXT_AREA
];
4838 /* Ignore trailing spaces, if we can. */
4839 if (!write_spaces_p
)
4840 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4844 current_row
->enabled_p
= true;
4845 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4847 /* If desired line is empty, just clear the line. */
4848 if (!desired_row
->enabled_p
)
4854 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4855 nlen
= desired_row
->used
[TEXT_AREA
];
4856 nend
= nbody
+ nlen
;
4858 /* If display line has unknown contents, write the whole line. */
4859 if (must_write_whole_line_p
)
4861 /* Ignore spaces at the end, if we can. */
4862 if (!write_spaces_p
)
4863 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4866 /* Write the contents of the desired line. */
4869 cursor_to (f
, vpos
, 0);
4870 write_glyphs (f
, nbody
, nlen
);
4873 /* Don't call clear_end_of_line if we already wrote the whole
4874 line. The cursor will not be at the right margin in that
4875 case but in the line below. */
4876 if (nlen
< FRAME_TOTAL_COLS (f
))
4878 cursor_to (f
, vpos
, nlen
);
4879 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4882 /* Make sure we are in the right row, otherwise cursor movement
4883 with cmgoto might use `ch' in the wrong row. */
4884 cursor_to (f
, vpos
, 0);
4886 make_current (desired_matrix
, current_matrix
, vpos
);
4890 /* Pretend trailing spaces are not there at all,
4891 unless for one reason or another we must write all spaces. */
4892 if (!write_spaces_p
)
4893 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4896 /* If there's no i/d char, quickly do the best we can without it. */
4897 if (!FRAME_CHAR_INS_DEL_OK (f
))
4901 /* Find the first glyph in desired row that doesn't agree with
4902 a glyph in the current row, and write the rest from there on. */
4903 for (i
= 0; i
< nlen
; i
++)
4905 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4907 /* Find the end of the run of different glyphs. */
4911 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4912 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4915 /* Output this run of non-matching chars. */
4916 cursor_to (f
, vpos
, i
);
4917 write_glyphs (f
, nbody
+ i
, j
- i
);
4920 /* Now find the next non-match. */
4924 /* Clear the rest of the line, or the non-clear part of it. */
4927 cursor_to (f
, vpos
, nlen
);
4928 clear_end_of_line (f
, olen
);
4931 /* Make current row = desired row. */
4932 make_current (desired_matrix
, current_matrix
, vpos
);
4936 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4937 characters in a row. */
4941 /* If current line is blank, skip over initial spaces, if
4942 possible, and write the rest. */
4946 nsp
= count_blanks (nbody
, nlen
);
4950 cursor_to (f
, vpos
, nsp
);
4951 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4954 /* Exchange contents between current_frame and new_frame. */
4955 make_current (desired_matrix
, current_matrix
, vpos
);
4959 /* Compute number of leading blanks in old and new contents. */
4960 osp
= count_blanks (obody
, olen
);
4961 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4963 /* Compute number of matching chars starting with first non-blank. */
4964 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4965 nbody
+ nsp
, nbody
+ nlen
);
4967 /* Spaces in new match implicit space past the end of old. */
4968 /* A bug causing this to be a no-op was fixed in 18.29. */
4969 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4972 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4976 /* Avoid doing insert/delete char
4977 just cause number of leading spaces differs
4978 when the following text does not match. */
4979 if (begmatch
== 0 && osp
!= nsp
)
4980 osp
= nsp
= min (osp
, nsp
);
4982 /* Find matching characters at end of line */
4985 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4987 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4992 endmatch
= obody
+ olen
- op1
;
4994 /* tem gets the distance to insert or delete.
4995 endmatch is how many characters we save by doing so.
4998 tem
= (nlen
- nsp
) - (olen
- osp
);
5000 && (!FRAME_CHAR_INS_DEL_OK (f
)
5001 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5004 /* nsp - osp is the distance to insert or delete.
5005 If that is nonzero, begmatch is known to be nonzero also.
5006 begmatch + endmatch is how much we save by doing the ins/del.
5010 && (!FRAME_CHAR_INS_DEL_OK (f
)
5011 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5015 osp
= nsp
= min (osp
, nsp
);
5018 /* Now go through the line, inserting, writing and
5019 deleting as appropriate. */
5023 cursor_to (f
, vpos
, nsp
);
5024 delete_glyphs (f
, osp
- nsp
);
5028 /* If going to delete chars later in line
5029 and insert earlier in the line,
5030 must delete first to avoid losing data in the insert */
5031 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5033 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5034 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5035 olen
= nlen
- (nsp
- osp
);
5037 cursor_to (f
, vpos
, osp
);
5038 insert_glyphs (f
, 0, nsp
- osp
);
5042 tem
= nsp
+ begmatch
+ endmatch
;
5043 if (nlen
!= tem
|| olen
!= tem
)
5045 if (!endmatch
|| nlen
== olen
)
5047 /* If new text being written reaches right margin, there is
5048 no need to do clear-to-eol at the end of this function
5049 (and it would not be safe, since cursor is not going to
5050 be "at the margin" after the text is done). */
5051 if (nlen
== FRAME_TOTAL_COLS (f
))
5054 /* Function write_glyphs is prepared to do nothing
5055 if passed a length <= 0. Check it here to avoid
5056 unnecessary cursor movement. */
5059 cursor_to (f
, vpos
, nsp
+ begmatch
);
5060 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5063 else if (nlen
> olen
)
5065 /* Here, we used to have the following simple code:
5066 ----------------------------------------
5067 write_glyphs (nbody + nsp + begmatch, olen - tem);
5068 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5069 ----------------------------------------
5070 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5071 is a padding glyph. */
5072 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5075 cursor_to (f
, vpos
, nsp
+ begmatch
);
5077 /* Calculate columns we can actually overwrite. */
5078 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5080 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5082 /* If we left columns to be overwritten, we must delete them. */
5083 del
= olen
- tem
- out
;
5085 delete_glyphs (f
, del
);
5087 /* At last, we insert columns not yet written out. */
5088 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5091 else if (olen
> nlen
)
5093 cursor_to (f
, vpos
, nsp
+ begmatch
);
5094 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5095 delete_glyphs (f
, olen
- nlen
);
5101 /* If any unerased characters remain after the new line, erase them. */
5104 cursor_to (f
, vpos
, nlen
);
5105 clear_end_of_line (f
, olen
);
5108 /* Exchange contents between current_frame and new_frame. */
5109 make_current (desired_matrix
, current_matrix
, vpos
);
5114 /***********************************************************************
5115 X/Y Position -> Buffer Position
5116 ***********************************************************************/
5118 /* Determine what's under window-relative pixel position (*X, *Y).
5119 Return the OBJECT (string or buffer) that's there.
5120 Return in *POS the position in that object.
5121 Adjust *X and *Y to character positions.
5122 Return in *DX and *DY the pixel coordinates of the click,
5123 relative to the top left corner of OBJECT, or relative to
5124 the top left corner of the character glyph at (*X, *Y)
5126 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5127 if the coordinates point to an empty area of the display. */
5130 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
)
5133 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5134 struct text_pos startp
;
5136 struct glyph_row
*row
;
5137 #ifdef HAVE_WINDOW_SYSTEM
5138 struct image
*img
= 0;
5140 int x0
, x1
, to_x
, it_vpos
;
5141 void *itdata
= NULL
;
5143 /* We used to set current_buffer directly here, but that does the
5144 wrong thing with `face-remapping-alist' (bug#2044). */
5145 Fset_buffer (w
->contents
);
5146 itdata
= bidi_shelve_cache ();
5147 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5148 start_display (&it
, w
, startp
);
5151 /* First, move to the beginning of the row corresponding to *Y. We
5152 need to be in that row to get the correct value of base paragraph
5153 direction for the text at (*X, *Y). */
5154 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5156 /* TO_X is the pixel position that the iterator will compute for the
5159 if (it
.bidi_it
.paragraph_dir
== R2L
)
5160 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5161 text area. This is because the iterator, even in R2L
5162 paragraphs, delivers glyphs as if they started at the left
5163 margin of the window. (When we actually produce glyphs for
5164 display, we reverse their order in PRODUCE_GLYPHS, but the
5165 iterator doesn't know about that.) The following line adjusts
5166 the pixel position to the iterator geometry, which is what
5167 move_it_* routines use. (The -1 is because in a window whose
5168 text-area width is W, the rightmost pixel position is W-1, and
5169 it should be mirrored into zero pixel position.) */
5170 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5172 /* We need to add it.first_visible_x because iterator positions
5173 include the hscroll. */
5174 to_x
+= it
.first_visible_x
;
5176 /* Now move horizontally in the row to the glyph under *X. Second
5177 argument is ZV to prevent move_it_in_display_line from matching
5178 based on buffer positions. */
5179 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5180 bidi_unshelve_cache (itdata
, 0);
5182 Fset_buffer (old_current_buffer
);
5184 *dx
= to_x
- it
.current_x
;
5185 *dy
= *y
- it
.current_y
;
5187 string
= w
->contents
;
5188 if (STRINGP (it
.string
))
5191 if (it
.what
== IT_COMPOSITION
5192 && it
.cmp_it
.nchars
> 1
5193 && it
.cmp_it
.reversed_p
)
5195 /* The current display element is a grapheme cluster in a
5196 composition. In that case, we need the position of the first
5197 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5198 it.current points to the last character of the cluster, thus
5199 we must move back to the first character of the same
5201 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5202 if (STRINGP (it
.string
))
5203 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5205 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5206 CHARPOS (pos
->pos
));
5209 #ifdef HAVE_WINDOW_SYSTEM
5210 if (it
.what
== IT_IMAGE
)
5212 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5213 && !NILP (img
->spec
))
5214 *object
= img
->spec
;
5218 /* IT's vpos counts from the glyph row that includes the window's
5219 start position, i.e. it excludes the header-line row, but
5220 MATRIX_ROW includes the header-line row. Adjust for a possible
5222 it_vpos
= it
.vpos
+ WINDOW_WANTS_HEADER_LINE_P (w
);
5223 if (it_vpos
< w
->current_matrix
->nrows
5224 && (row
= MATRIX_ROW (w
->current_matrix
, it_vpos
),
5227 if (it
.hpos
< row
->used
[TEXT_AREA
])
5229 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5230 #ifdef HAVE_WINDOW_SYSTEM
5233 *dy
-= row
->ascent
- glyph
->ascent
;
5234 *dx
+= glyph
->slice
.img
.x
;
5235 *dy
+= glyph
->slice
.img
.y
;
5236 /* Image slices positions are still relative to the entire image */
5237 *width
= img
->width
;
5238 *height
= img
->height
;
5243 *width
= glyph
->pixel_width
;
5244 *height
= glyph
->ascent
+ glyph
->descent
;
5250 *height
= row
->height
;
5255 *width
= *height
= 0;
5258 /* Add extra (default width) columns if clicked after EOL. */
5259 x1
= max (0, it
.current_x
+ it
.pixel_width
);
5261 it
.hpos
+= (to_x
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5270 /* Value is the string under window-relative coordinates X/Y in the
5271 mode line or header line (PART says which) of window W, or nil if none.
5272 *CHARPOS is set to the position in the string returned. */
5275 mode_line_string (struct window
*w
, enum window_part part
,
5276 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5277 int *dx
, int *dy
, int *width
, int *height
)
5279 struct glyph_row
*row
;
5280 struct glyph
*glyph
, *end
;
5282 Lisp_Object string
= Qnil
;
5284 if (part
== ON_MODE_LINE
)
5285 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5287 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5289 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5291 if (row
->mode_line_p
&& row
->enabled_p
)
5293 /* Find the glyph under X. If we find one with a string object,
5294 it's the one we were looking for. */
5295 glyph
= row
->glyphs
[TEXT_AREA
];
5296 end
= glyph
+ row
->used
[TEXT_AREA
];
5297 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5298 x0
-= glyph
->pixel_width
;
5299 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5302 string
= glyph
->object
;
5303 *charpos
= glyph
->charpos
;
5304 *width
= glyph
->pixel_width
;
5305 *height
= glyph
->ascent
+ glyph
->descent
;
5306 #ifdef HAVE_WINDOW_SYSTEM
5307 if (glyph
->type
== IMAGE_GLYPH
)
5310 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5312 *object
= img
->spec
;
5313 y0
-= row
->ascent
- glyph
->ascent
;
5319 /* Add extra (default width) columns if clicked after EOL. */
5320 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5322 *height
= row
->height
;
5329 *width
= *height
= 0;
5339 /* Value is the string under window-relative coordinates X/Y in either
5340 marginal area, or nil if none. *CHARPOS is set to the position in
5341 the string returned. */
5344 marginal_area_string (struct window
*w
, enum window_part part
,
5345 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5346 int *dx
, int *dy
, int *width
, int *height
)
5348 struct glyph_row
*row
= w
->current_matrix
->rows
;
5349 struct glyph
*glyph
, *end
;
5350 int x0
, y0
, i
, wy
= *y
;
5352 Lisp_Object string
= Qnil
;
5354 if (part
== ON_LEFT_MARGIN
)
5355 area
= LEFT_MARGIN_AREA
;
5356 else if (part
== ON_RIGHT_MARGIN
)
5357 area
= RIGHT_MARGIN_AREA
;
5361 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5362 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5365 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5369 /* Find the glyph under X. If we find one with a string object,
5370 it's the one we were looking for. */
5371 if (area
== RIGHT_MARGIN_AREA
)
5372 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5373 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5374 : WINDOW_FRINGES_WIDTH (w
))
5375 + window_box_width (w
, LEFT_MARGIN_AREA
)
5376 + window_box_width (w
, TEXT_AREA
));
5378 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5379 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5382 glyph
= row
->glyphs
[area
];
5383 end
= glyph
+ row
->used
[area
];
5384 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5385 x0
-= glyph
->pixel_width
;
5386 *x
= glyph
- row
->glyphs
[area
];
5389 string
= glyph
->object
;
5390 *charpos
= glyph
->charpos
;
5391 *width
= glyph
->pixel_width
;
5392 *height
= glyph
->ascent
+ glyph
->descent
;
5393 #ifdef HAVE_WINDOW_SYSTEM
5394 if (glyph
->type
== IMAGE_GLYPH
)
5397 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5399 *object
= img
->spec
;
5400 y0
-= row
->ascent
- glyph
->ascent
;
5401 x0
+= glyph
->slice
.img
.x
;
5402 y0
+= glyph
->slice
.img
.y
;
5408 /* Add extra (default width) columns if clicked after EOL. */
5409 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5411 *height
= row
->height
;
5418 *width
= *height
= 0;
5428 /***********************************************************************
5429 Changing Frame Sizes
5430 ***********************************************************************/
5434 static void deliver_window_change_signal (int);
5437 handle_window_change_signal (int sig
)
5440 struct tty_display_info
*tty
;
5442 /* The frame size change obviously applies to a single
5443 termcap-controlled terminal, but we can't decide which.
5444 Therefore, we resize the frames corresponding to each tty.
5446 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5448 if (! tty
->term_initted
)
5451 /* Suspended tty frames have tty->input == NULL avoid trying to
5456 get_tty_size (fileno (tty
->input
), &width
, &height
);
5458 if (width
> 5 && height
> 2) {
5459 Lisp_Object tail
, frame
;
5461 FOR_EACH_FRAME (tail
, frame
)
5462 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5463 /* Record the new sizes, but don't reallocate the data
5464 structures now. Let that be done later outside of the
5466 change_frame_size (XFRAME (frame
), width
,
5467 height
- FRAME_MENU_BAR_LINES (XFRAME (frame
)),
5474 deliver_window_change_signal (int sig
)
5476 deliver_process_signal (sig
, handle_window_change_signal
);
5478 #endif /* SIGWINCH */
5481 /* Do any change in frame size that was requested by a signal.
5482 SAFE means this function is called from a place where it is
5483 safe to change frame sizes while a redisplay is in progress. */
5486 do_pending_window_change (bool safe
)
5488 /* If window change signal handler should have run before, run it now. */
5489 if (redisplaying_p
&& !safe
)
5492 while (delayed_size_change
)
5494 Lisp_Object tail
, frame
;
5496 delayed_size_change
= 0;
5498 FOR_EACH_FRAME (tail
, frame
)
5500 struct frame
*f
= XFRAME (frame
);
5502 if (f
->new_height
!= 0 || f
->new_width
!= 0)
5503 change_frame_size (f
, f
->new_width
, f
->new_height
,
5504 0, 0, safe
, f
->new_pixelwise
);
5511 change_frame_size_1 (struct frame
*f
, int new_width
, int new_height
,
5512 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5514 /* If we can't deal with the change now, queue it for later. */
5515 if (delay
|| (redisplaying_p
&& !safe
))
5517 f
->new_width
= new_width
;
5518 f
->new_height
= new_height
;
5519 f
->new_pixelwise
= pixelwise
;
5520 delayed_size_change
= 1;
5524 /* This size-change overrides any pending one for this frame. */
5527 f
->new_pixelwise
= 0;
5529 /* If an argument is zero, set it to the current value. */
5532 new_width
= (new_width
<= 0) ? FRAME_TEXT_WIDTH (f
) : new_width
;
5533 new_height
= (new_height
<= 0) ? FRAME_TEXT_HEIGHT (f
) : new_height
;
5537 new_width
= (((new_width
<= 0) ? FRAME_COLS (f
) : new_width
)
5538 * FRAME_COLUMN_WIDTH (f
));
5539 new_height
= (((new_height
<= 0) ? FRAME_LINES (f
) : new_height
)
5540 * FRAME_LINE_HEIGHT (f
));
5543 /* Adjust frame size but make sure x_set_window_size does not
5545 adjust_frame_size (f
, new_width
, new_height
, 5, pretend
,
5546 Qchange_frame_size
);
5551 /* Change text height/width of frame F. Values may be given as zero to
5552 indicate that no change is needed.
5554 If DELAY, assume we're being called from a signal handler, and queue
5555 the change for later - perhaps the next redisplay. Since this tries
5556 to resize windows, we can't call it from a signal handler.
5558 SAFE means this function is called from a place where it's safe to
5559 change frame sizes while a redisplay is in progress. */
5561 change_frame_size (struct frame
*f
, int new_width
, int new_height
,
5562 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5564 Lisp_Object tail
, frame
;
5566 if (FRAME_MSDOS_P (f
))
5568 /* On MS-DOS, all frames use the same screen, so a change in
5569 size affects all frames. Termcap now supports multiple
5571 FOR_EACH_FRAME (tail
, frame
)
5572 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5573 change_frame_size_1 (XFRAME (frame
), new_width
, new_height
,
5574 pretend
, delay
, safe
, pixelwise
);
5577 change_frame_size_1 (f
, new_width
, new_height
, pretend
, delay
, safe
,
5581 /***********************************************************************
5582 Terminal Related Lisp Functions
5583 ***********************************************************************/
5585 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5586 1, 1, "FOpen termscript file: ",
5587 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5588 FILE = nil means just close any termscript file currently open. */)
5591 struct tty_display_info
*tty
;
5593 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5594 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5595 error ("Current frame is not on a tty device");
5599 if (tty
->termscript
!= 0)
5602 fclose (tty
->termscript
);
5603 tty
->termscript
= 0;
5609 file
= Fexpand_file_name (file
, Qnil
);
5610 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5611 if (tty
->termscript
== 0)
5612 report_file_error ("Opening termscript", file
);
5618 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5619 Ssend_string_to_terminal
, 1, 2, 0,
5620 doc
: /* Send STRING to the terminal without alteration.
5621 Control characters in STRING will have terminal-dependent effects.
5623 Optional parameter TERMINAL specifies the tty terminal device to use.
5624 It may be a terminal object, a frame, or nil for the terminal used by
5625 the currently selected frame. In batch mode, STRING is sent to stdout
5626 when TERMINAL is nil. */)
5627 (Lisp_Object string
, Lisp_Object terminal
)
5629 struct terminal
*t
= decode_live_terminal (terminal
);
5632 /* ??? Perhaps we should do something special for multibyte strings here. */
5633 CHECK_STRING (string
);
5636 if (t
->type
== output_initial
)
5638 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5639 error ("Device %d is not a termcap terminal device", t
->id
);
5642 struct tty_display_info
*tty
= t
->display_info
.tty
;
5645 error ("Terminal is currently suspended");
5647 if (tty
->termscript
)
5649 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5650 fflush (tty
->termscript
);
5654 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5661 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5662 doc
: /* Beep, or flash the screen.
5663 Also, unless an argument is given,
5664 terminate any keyboard macro currently executing. */)
5672 ring_bell (XFRAME (selected_frame
));
5681 bitch_at_user (void)
5685 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5688 = "Keyboard macro terminated by a command ringing the bell";
5689 Fsignal (Quser_error
, list1 (build_string (msg
)));
5692 ring_bell (XFRAME (selected_frame
));
5697 /***********************************************************************
5699 ***********************************************************************/
5701 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5702 doc
: /* Pause, without updating display, for SECONDS seconds.
5703 SECONDS may be a floating-point value, meaning that you can wait for a
5704 fraction of a second. Optional second arg MILLISECONDS specifies an
5705 additional wait period, in milliseconds; this is for backwards compatibility.
5706 \(Not all operating systems support waiting for a fraction of a second.) */)
5707 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5709 double duration
= extract_float (seconds
);
5711 if (!NILP (milliseconds
))
5713 CHECK_NUMBER (milliseconds
);
5714 duration
+= XINT (milliseconds
) / 1000.0;
5719 struct timespec t
= dtotimespec (duration
);
5720 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5721 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5728 /* This is just like wait_reading_process_output, except that
5731 TIMEOUT is number of seconds to wait (float or integer),
5732 or t to wait forever.
5733 READING is true if reading input.
5734 If DISPLAY_OPTION is >0 display process output while waiting.
5735 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5739 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5743 bool do_display
= display_option
> 0;
5745 swallow_events (do_display
);
5747 if ((detect_input_pending_run_timers (do_display
))
5748 || !NILP (Vexecuting_kbd_macro
))
5751 if (display_option
> 1)
5752 redisplay_preserve_echo_area (2);
5754 if (INTEGERP (timeout
))
5756 sec
= XINT (timeout
);
5761 else if (FLOATP (timeout
))
5763 double seconds
= XFLOAT_DATA (timeout
);
5764 if (! (0 < seconds
))
5768 struct timespec t
= dtotimespec (seconds
);
5769 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5773 else if (EQ (timeout
, Qt
))
5779 wrong_type_argument (Qnumberp
, timeout
);
5786 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5789 return detect_input_pending () ? Qnil
: Qt
;
5793 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5794 doc
: /* Perform redisplay.
5795 Optional arg FORCE, if non-nil, prevents redisplay from being
5796 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5797 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5798 preempted by arriving input, so FORCE does nothing.
5800 Return t if redisplay was performed, nil if redisplay was preempted
5801 immediately by pending input. */)
5806 swallow_events (true);
5807 if ((detect_input_pending_run_timers (1)
5808 && NILP (force
) && !redisplay_dont_pause
)
5809 || !NILP (Vexecuting_kbd_macro
))
5812 count
= SPECPDL_INDEX ();
5813 if (!NILP (force
) && !redisplay_dont_pause
)
5814 specbind (Qredisplay_dont_pause
, Qt
);
5815 redisplay_preserve_echo_area (2);
5816 unbind_to (count
, Qnil
);
5822 /***********************************************************************
5823 Other Lisp Functions
5824 ***********************************************************************/
5826 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5827 session's frames, frame names, buffers, buffer-read-only flags, and
5828 buffer-modified-flags. */
5830 static Lisp_Object frame_and_buffer_state
;
5833 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5834 Sframe_or_buffer_changed_p
, 0, 1, 0,
5835 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5836 VARIABLE is a variable name whose value is either nil or a state vector
5837 that will be updated to contain all frames and buffers,
5838 aside from buffers whose names start with space,
5839 along with the buffers' read-only and modified flags. This allows a fast
5840 check to see whether buffer menus might need to be recomputed.
5841 If this function returns non-nil, it updates the internal vector to reflect
5844 If VARIABLE is nil, an internal variable is used. Users should not
5845 pass nil for VARIABLE. */)
5846 (Lisp_Object variable
)
5848 Lisp_Object state
, tail
, frame
, buf
;
5851 if (! NILP (variable
))
5853 CHECK_SYMBOL (variable
);
5854 state
= Fsymbol_value (variable
);
5855 if (! VECTORP (state
))
5859 state
= frame_and_buffer_state
;
5862 FOR_EACH_FRAME (tail
, frame
)
5864 if (idx
== ASIZE (state
))
5866 if (!EQ (AREF (state
, idx
++), frame
))
5868 if (idx
== ASIZE (state
))
5870 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5873 /* Check that the buffer info matches. */
5874 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5876 /* Ignore buffers that aren't included in buffer lists. */
5877 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5879 if (idx
== ASIZE (state
))
5881 if (!EQ (AREF (state
, idx
++), buf
))
5883 if (idx
== ASIZE (state
))
5885 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5887 if (idx
== ASIZE (state
))
5889 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5892 if (idx
== ASIZE (state
))
5894 /* Detect deletion of a buffer at the end of the list. */
5895 if (EQ (AREF (state
, idx
), Qlambda
))
5898 /* Come here if we decide the data has changed. */
5900 /* Count the size we will need.
5901 Start with 1 so there is room for at least one lambda at the end. */
5903 FOR_EACH_FRAME (tail
, frame
)
5905 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5907 /* Reallocate the vector if data has grown to need it,
5908 or if it has shrunk a lot. */
5909 if (! VECTORP (state
)
5910 || n
> ASIZE (state
)
5911 || n
+ 20 < ASIZE (state
) / 2)
5912 /* Add 20 extra so we grow it less often. */
5914 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5915 if (! NILP (variable
))
5916 Fset (variable
, state
);
5918 frame_and_buffer_state
= state
;
5921 /* Record the new data in the (possibly reallocated) vector. */
5923 FOR_EACH_FRAME (tail
, frame
)
5925 ASET (state
, idx
, frame
);
5927 ASET (state
, idx
, XFRAME (frame
)->name
);
5930 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5932 /* Ignore buffers that aren't included in buffer lists. */
5933 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5935 ASET (state
, idx
, buf
);
5937 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5939 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5942 /* Fill up the vector with lambdas (always at least one). */
5943 ASET (state
, idx
, Qlambda
);
5945 while (idx
< ASIZE (state
))
5947 ASET (state
, idx
, Qlambda
);
5950 /* Make sure we didn't overflow the vector. */
5951 eassert (idx
<= ASIZE (state
));
5957 /***********************************************************************
5959 ***********************************************************************/
5961 /* Initialization done when Emacs fork is started, before doing stty.
5962 Determine terminal type and set terminal_driver. Then invoke its
5963 decoding routine to set up variables in the terminal package. */
5968 char *terminal_type
;
5970 /* Construct the space glyph. */
5971 space_glyph
.type
= CHAR_GLYPH
;
5972 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5973 space_glyph
.charpos
= -1;
5976 cursor_in_echo_area
= 0;
5978 /* Now is the time to initialize this; it's used by init_sys_modes
5980 Vinitial_window_system
= Qnil
;
5982 /* SIGWINCH needs to be handled no matter what display we start
5983 with. Otherwise newly opened tty frames will not resize
5988 #endif /* CANNOT_DUMP */
5990 struct sigaction action
;
5991 emacs_sigaction_init (&action
, deliver_window_change_signal
);
5992 sigaction (SIGWINCH
, &action
, 0);
5994 #endif /* SIGWINCH */
5996 /* If running as a daemon, no need to initialize any frames/terminal. */
6000 /* If the user wants to use a window system, we shouldn't bother
6001 initializing the terminal. This is especially important when the
6002 terminal is so dumb that emacs gives up before and doesn't bother
6003 using the window system.
6005 If the DISPLAY environment variable is set and nonempty,
6006 try to use X, and die with an error message if that doesn't work. */
6008 #ifdef HAVE_X_WINDOWS
6009 if (! inhibit_window_system
&& ! display_arg
)
6012 display
= getenv ("DISPLAY");
6013 display_arg
= (display
!= 0 && *display
!= 0);
6015 if (display_arg
&& !x_display_ok (display
))
6017 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6019 inhibit_window_system
= 1;
6023 if (!inhibit_window_system
&& display_arg
)
6025 Vinitial_window_system
= Qx
;
6027 Vwindow_system_version
= make_number (11);
6030 /* In some versions of ncurses,
6031 tputs crashes if we have not called tgetent.
6033 { char b
[2044]; tgetent (b
, "xterm");}
6037 #endif /* HAVE_X_WINDOWS */
6040 if (!inhibit_window_system
)
6042 Vinitial_window_system
= Qw32
;
6043 Vwindow_system_version
= make_number (1);
6046 #endif /* HAVE_NTGUI */
6049 if (!inhibit_window_system
6055 Vinitial_window_system
= Qns
;
6056 Vwindow_system_version
= make_number (10);
6061 /* If no window system has been specified, try to use the terminal. */
6063 fatal ("standard input is not a tty");
6066 terminal_type
= "w32console";
6068 terminal_type
= getenv ("TERM");
6072 #ifdef HAVE_WINDOW_SYSTEM
6073 if (! inhibit_window_system
)
6074 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6076 #endif /* HAVE_WINDOW_SYSTEM */
6077 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6083 struct frame
*f
= XFRAME (selected_frame
);
6085 init_foreground_group ();
6087 /* Open a display on the controlling tty. */
6088 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6090 /* Convert the initial frame to use the new display. */
6091 if (f
->output_method
!= output_initial
)
6093 f
->output_method
= t
->type
;
6096 t
->reference_count
++;
6098 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6100 if (f
->output_method
== output_termcap
)
6101 create_tty_output (f
);
6103 t
->display_info
.tty
->top_frame
= selected_frame
;
6104 change_frame_size (XFRAME (selected_frame
),
6105 FrameCols (t
->display_info
.tty
),
6106 FrameRows (t
->display_info
.tty
)
6107 - FRAME_MENU_BAR_LINES (f
), 0, 0, 1, 0);
6109 /* Delete the initial terminal. */
6110 if (--initial_terminal
->reference_count
== 0
6111 && initial_terminal
->delete_terminal_hook
)
6112 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6114 /* Update frame parameters to reflect the new type. */
6115 AUTO_FRAME_ARG (tty_type_arg
, Qtty_type
, Ftty_type (selected_frame
));
6116 Fmodify_frame_parameters (selected_frame
, tty_type_arg
);
6117 AUTO_FRAME_ARG (tty_arg
, Qtty
, (t
->display_info
.tty
->name
6118 ? build_string (t
->display_info
.tty
->name
)
6120 Fmodify_frame_parameters (selected_frame
, tty_arg
);
6124 struct frame
*sf
= SELECTED_FRAME ();
6125 int width
= FRAME_TOTAL_COLS (sf
);
6126 int height
= FRAME_TOTAL_LINES (sf
);
6128 /* If these sizes are so big they cause overflow, just ignore the
6129 change. It's not clear what better we could do. The rest of
6130 the code assumes that (width + 2) * height * sizeof (struct glyph)
6131 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6132 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6133 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6134 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6135 < (width
+ 2) * height
))
6136 fatal ("screen size %dx%d too big", width
, height
);
6139 calculate_costs (XFRAME (selected_frame
));
6141 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6144 && NILP (Vinitial_window_system
))
6146 /* For the initial frame, we don't have any way of knowing what
6147 are the foreground and background colors of the terminal. */
6148 struct frame
*sf
= SELECTED_FRAME ();
6150 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6151 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6152 call0 (intern ("tty-set-up-initial-frame-faces"));
6158 /***********************************************************************
6160 ***********************************************************************/
6162 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6163 Sinternal_show_cursor
, 2, 2, 0,
6164 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6165 WINDOW nil means use the selected window. SHOW non-nil means
6166 show a cursor in WINDOW in the next redisplay. SHOW nil means
6167 don't show a cursor. */)
6168 (Lisp_Object window
, Lisp_Object show
)
6170 /* Don't change cursor state while redisplaying. This could confuse
6172 if (!redisplaying_p
)
6173 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6178 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6179 Sinternal_show_cursor_p
, 0, 1, 0,
6180 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6181 WINDOW nil or omitted means report on the selected window. */)
6182 (Lisp_Object window
)
6184 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6187 /***********************************************************************
6189 ***********************************************************************/
6192 syms_of_display (void)
6194 defsubr (&Sredraw_frame
);
6195 defsubr (&Sredraw_display
);
6196 defsubr (&Sframe_or_buffer_changed_p
);
6197 defsubr (&Sopen_termscript
);
6199 defsubr (&Sredisplay
);
6200 defsubr (&Ssleep_for
);
6201 defsubr (&Ssend_string_to_terminal
);
6202 defsubr (&Sinternal_show_cursor
);
6203 defsubr (&Sinternal_show_cursor_p
);
6206 defsubr (&Sdump_redisplay_history
);
6209 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6210 staticpro (&frame_and_buffer_state
);
6212 /* This is the "purpose" slot of a display table. */
6213 DEFSYM (Qdisplay_table
, "display-table");
6215 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6217 DEFVAR_INT ("baud-rate", baud_rate
,
6218 doc
: /* The output baud rate of the terminal.
6219 On most systems, changing this value will affect the amount of padding
6220 and the other strategic decisions made during redisplay. */);
6222 DEFVAR_BOOL ("inverse-video", inverse_video
,
6223 doc
: /* Non-nil means invert the entire frame display.
6224 This means everything is in inverse video which otherwise would not be. */);
6226 DEFVAR_BOOL ("visible-bell", visible_bell
,
6227 doc
: /* Non-nil means try to flash the frame to represent a bell.
6229 See also `ring-bell-function'. */);
6231 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6232 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6233 A non-nil value is useful if the terminal can automatically preserve
6234 Emacs's frame display when you reenter Emacs.
6235 It is up to you to set this variable if your terminal can do that. */);
6237 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6238 doc
: /* Name of the window system that Emacs uses for the first frame.
6239 The value is a symbol:
6240 nil for a termcap frame (a character-only terminal),
6241 'x' for an Emacs frame that is really an X window,
6242 'w32' for an Emacs frame that is a window on MS-Windows display,
6243 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6244 'pc' for a direct-write MS-DOS frame.
6246 Use of this variable as a boolean is deprecated. Instead,
6247 use `display-graphic-p' or any of the other `display-*-p'
6248 predicates which report frame's specific UI-related capabilities. */);
6250 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6251 doc
: /* Name of window system through which the selected frame is displayed.
6252 The value is a symbol:
6253 nil for a termcap frame (a character-only terminal),
6254 'x' for an Emacs frame that is really an X window,
6255 'w32' for an Emacs frame that is a window on MS-Windows display,
6256 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6257 'pc' for a direct-write MS-DOS frame.
6259 Use of this variable as a boolean is deprecated. Instead,
6260 use `display-graphic-p' or any of the other `display-*-p'
6261 predicates which report frame's specific UI-related capabilities. */);
6263 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6264 doc
: /* The version number of the window system in use.
6265 For X windows, this is 11. */);
6267 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6268 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6270 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6271 doc
: /* Table defining how to output a glyph code to the frame.
6272 If not nil, this is a vector indexed by glyph code to define the glyph.
6273 Each element can be:
6274 integer: a glyph code which this glyph is an alias for.
6275 string: output this glyph using that string (not impl. in X windows).
6276 nil: this glyph mod 524288 is the code of a character to output,
6277 and this glyph / 524288 is the face number (see `face-id') to use
6278 while outputting it. */);
6279 Vglyph_table
= Qnil
;
6281 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6282 doc
: /* Display table to use for buffers that specify none.
6283 See `buffer-display-table' for more information. */);
6284 Vstandard_display_table
= Qnil
;
6286 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6287 doc
: /* Nil means display update is paused when input is detected. */);
6288 /* Contrary to expectations, a value of "false" can be detrimental to
6289 responsiveness since aborting a redisplay throws away some of the
6290 work already performed. It's usually more efficient (and gives
6291 more prompt feedback to the user) to let the redisplay terminate,
6292 and just completely skip the next command's redisplay (which is
6293 done regardless of this setting if there's pending input at the
6294 beginning of the next redisplay). */
6295 redisplay_dont_pause
= true;
6301 Vinitial_window_system
= Qnil
;
6302 Vwindow_system_version
= Qnil
;