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 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
111 /* True means SIGWINCH happened when not safe. */
113 static bool delayed_size_change
;
115 /* A glyph for a space. */
117 struct glyph space_glyph
;
119 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
121 /* Counts of allocated structures. These counts serve to diagnose
122 memory leaks and double frees. */
124 static int glyph_matrix_count
;
125 static int glyph_pool_count
;
127 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
129 /* If non-null, the frame whose frame matrices are manipulated. If
130 null, window matrices are worked on. */
132 static struct frame
*frame_matrix_frame
;
134 /* Convert vpos and hpos from frame to window and vice versa.
135 This may only be used for terminal frames. */
139 static int window_to_frame_vpos (struct window
*, int);
140 static int window_to_frame_hpos (struct window
*, int);
141 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
142 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
144 /* One element of the ring buffer containing redisplay history
147 struct redisplay_history
149 char trace
[512 + 100];
152 /* The size of the history buffer. */
154 #define REDISPLAY_HISTORY_SIZE 30
156 /* The redisplay history buffer. */
158 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
160 /* Next free entry in redisplay_history. */
162 static int history_idx
;
164 /* A tick that's incremented each time something is added to the
167 static uprintmax_t history_tick
;
169 /* Add to the redisplay history how window W has been displayed.
170 MSG is a trace containing the information how W's glyph matrix
171 has been constructed. PAUSED_P means that the update
172 has been interrupted for pending input. */
175 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
180 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
182 buf
= redisplay_history
[history_idx
].trace
;
185 snprintf (buf
, sizeof redisplay_history
[0].trace
,
186 "%"pMu
": window %p (`%s')%s\n%s",
189 ((BUFFERP (w
->contents
)
190 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
191 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
193 paused_p
? " ***paused***" : "",
198 /* Add to the redisplay history that frame F has been displayed.
199 PAUSED_P means that the update has been interrupted for
203 add_frame_display_history (struct frame
*f
, bool paused_p
)
208 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
210 buf
= redisplay_history
[history_idx
].trace
;
213 sprintf (buf
, "%"pMu
": update frame %p%s",
215 ptr
, paused_p
? " ***paused***" : "");
219 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
220 Sdump_redisplay_history
, 0, 0, "",
221 doc
: /* Dump redisplay history to stderr. */)
226 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
229 i
= REDISPLAY_HISTORY_SIZE
- 1;
230 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
237 #else /* not GLYPH_DEBUG */
239 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
240 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
242 #endif /* GLYPH_DEBUG */
245 #if (defined PROFILING \
246 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
247 && !HAVE___EXECUTABLE_START)
248 /* This function comes first in the Emacs executable and is used only
249 to estimate the text start for profiling. */
251 __executable_start (void)
257 /***********************************************************************
259 ***********************************************************************/
261 /* Allocate and return a glyph_matrix structure. POOL is the glyph
262 pool from which memory for the matrix should be allocated, or null
263 for window-based redisplay where no glyph pools are used. The
264 member `pool' of the glyph matrix structure returned is set to
265 POOL, the structure is otherwise zeroed. */
267 static struct glyph_matrix
*
268 new_glyph_matrix (struct glyph_pool
*pool
)
270 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
272 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
273 /* Increment number of allocated matrices. This count is used
274 to detect memory leaks. */
275 ++glyph_matrix_count
;
278 /* Set pool and return. */
284 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
286 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
287 glyph_matrix_count is decremented when a matrix is freed. If the count
288 gets negative, more structures were freed than allocated, i.e. one matrix
289 was freed more than once or a bogus pointer was passed to this function.
291 If MATRIX->pool is null, this means that the matrix manages its own
292 glyph memory---this is done for matrices on X frames. Freeing the
293 matrix also frees the glyph memory in this case. */
296 free_glyph_matrix (struct glyph_matrix
*matrix
)
302 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
303 /* Detect the case that more matrices are freed than were
305 --glyph_matrix_count
;
306 eassert (glyph_matrix_count
>= 0);
309 /* Free glyph memory if MATRIX owns it. */
310 if (matrix
->pool
== NULL
)
311 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
312 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
314 /* Free row structures and the matrix itself. */
315 xfree (matrix
->rows
);
321 /* Return the number of glyphs to reserve for a marginal area of
322 window W. TOTAL_GLYPHS is the number of glyphs in a complete
323 display line of window W. MARGIN gives the width of the marginal
324 area in canonical character units. */
327 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
331 int width
= w
->total_cols
;
332 double d
= max (0, margin
);
333 d
= min (width
/ 2 - 1, d
);
334 return (int) ((double) total_glyphs
/ width
* d
);
339 /* Return true if ROW's hash value is correct.
340 Optimized away if ENABLE_CHECKING is not defined. */
343 verify_row_hash (struct glyph_row
*row
)
345 return row
->hash
== row_hash (row
);
348 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
351 W is null if the function is called for a frame glyph matrix.
352 Otherwise it is the window MATRIX is a member of. X and Y are the
353 indices of the first column and row of MATRIX within the frame
354 matrix, if such a matrix exists. They are zero for purely
355 window-based redisplay. DIM is the needed size of the matrix.
357 In window-based redisplay, where no frame matrices exist, glyph
358 matrices manage their own glyph storage. Otherwise, they allocate
359 storage from a common frame glyph pool which can be found in
362 The reason for this memory management strategy is to avoid complete
363 frame redraws if possible. When we allocate from a common pool, a
364 change of the location or size of a sub-matrix within the pool
365 requires a complete redisplay of the frame because we cannot easily
366 make sure that the current matrices of all windows still agree with
367 what is displayed on the screen. While this is usually fast, it
368 leads to screen flickering. */
371 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
375 bool marginal_areas_changed_p
= 0;
376 bool header_line_changed_p
= 0;
377 bool header_line_p
= 0;
378 int left
= -1, right
= -1;
379 int window_width
= -1, window_height
= -1;
381 /* See if W had a header line that has disappeared now, or vice versa.
385 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
387 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
388 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
390 matrix
->header_line_p
= header_line_p
;
392 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
393 Do nothing if MATRIX' size, position, vscroll, and marginal areas
394 haven't changed. This optimization is important because preserving
395 the matrix means preventing redisplay. */
396 if (matrix
->pool
== NULL
)
398 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
399 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
400 eassert (left
>= 0 && right
>= 0);
401 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
402 || right
!= matrix
->right_margin_glyphs
);
404 if (!marginal_areas_changed_p
405 && !XFRAME (w
->frame
)->fonts_changed
406 && !header_line_changed_p
407 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
408 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
409 && matrix
->window_height
== window_height
410 && matrix
->window_vscroll
== w
->vscroll
411 && matrix
->window_width
== window_width
)
415 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
416 if (matrix
->rows_allocated
< dim
.height
)
418 int old_alloc
= matrix
->rows_allocated
;
419 new_rows
= dim
.height
- matrix
->rows_allocated
;
420 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
421 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
422 memset (matrix
->rows
+ old_alloc
, 0,
423 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
428 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
429 on a frame not using window-based redisplay. Set up pointers for
430 each row into the glyph pool. */
433 eassert (matrix
->pool
->glyphs
);
437 left
= margin_glyphs_to_reserve (w
, dim
.width
,
438 w
->left_margin_cols
);
439 right
= margin_glyphs_to_reserve (w
, dim
.width
,
440 w
->right_margin_cols
);
445 for (i
= 0; i
< dim
.height
; ++i
)
447 struct glyph_row
*row
= &matrix
->rows
[i
];
449 row
->glyphs
[LEFT_MARGIN_AREA
]
450 = (matrix
->pool
->glyphs
451 + (y
+ i
) * matrix
->pool
->ncolumns
455 || (row
== matrix
->rows
+ dim
.height
- 1
456 && WINDOW_WANTS_MODELINE_P (w
))
457 || (row
== matrix
->rows
&& matrix
->header_line_p
))
459 row
->glyphs
[TEXT_AREA
]
460 = row
->glyphs
[LEFT_MARGIN_AREA
];
461 row
->glyphs
[RIGHT_MARGIN_AREA
]
462 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
463 row
->glyphs
[LAST_AREA
]
464 = row
->glyphs
[RIGHT_MARGIN_AREA
];
468 row
->glyphs
[TEXT_AREA
]
469 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
470 row
->glyphs
[RIGHT_MARGIN_AREA
]
471 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
472 row
->glyphs
[LAST_AREA
]
473 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
477 matrix
->left_margin_glyphs
= left
;
478 matrix
->right_margin_glyphs
= right
;
482 /* If MATRIX->pool is null, MATRIX is responsible for managing
483 its own memory. It is a window matrix for window-based redisplay.
484 Allocate glyph memory from the heap. */
485 if (dim
.width
> matrix
->matrix_w
487 || header_line_changed_p
488 || marginal_areas_changed_p
)
490 struct glyph_row
*row
= matrix
->rows
;
491 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
495 row
->glyphs
[LEFT_MARGIN_AREA
]
496 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
497 dim
.width
, sizeof (struct glyph
));
499 /* The mode line, if displayed, never has marginal areas. */
500 if ((row
== matrix
->rows
+ dim
.height
- 1
501 && !(w
&& WINDOW_WANTS_MODELINE_P (w
)))
502 || (row
== matrix
->rows
&& matrix
->header_line_p
))
504 row
->glyphs
[TEXT_AREA
]
505 = row
->glyphs
[LEFT_MARGIN_AREA
];
506 row
->glyphs
[RIGHT_MARGIN_AREA
]
507 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
508 row
->glyphs
[LAST_AREA
]
509 = row
->glyphs
[RIGHT_MARGIN_AREA
];
513 row
->glyphs
[TEXT_AREA
]
514 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
515 row
->glyphs
[RIGHT_MARGIN_AREA
]
516 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
517 row
->glyphs
[LAST_AREA
]
518 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
524 eassert (left
>= 0 && right
>= 0);
525 matrix
->left_margin_glyphs
= left
;
526 matrix
->right_margin_glyphs
= right
;
529 /* Number of rows to be used by MATRIX. */
530 matrix
->nrows
= dim
.height
;
531 eassert (matrix
->nrows
>= 0);
535 if (matrix
== w
->current_matrix
)
537 /* Mark rows in a current matrix of a window as not having
538 valid contents. It's important to not do this for
539 desired matrices. When Emacs starts, it may already be
540 building desired matrices when this function runs. */
541 if (window_width
< 0)
542 window_width
= window_box_width (w
, -1);
544 /* Optimize the case that only the height has changed (C-x 2,
545 upper window). Invalidate all rows that are no longer part
547 if (!marginal_areas_changed_p
548 && !header_line_changed_p
550 && dim
.width
== matrix
->matrix_w
551 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
552 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
553 && matrix
->window_width
== window_width
)
555 /* Find the last row in the window. */
556 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
557 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
563 /* Window end is invalid, if inside of the rows that
564 are invalidated below. */
565 if (w
->window_end_vpos
>= i
)
566 w
->window_end_valid
= 0;
568 while (i
< matrix
->nrows
)
569 matrix
->rows
[i
++].enabled_p
= false;
573 for (i
= 0; i
< matrix
->nrows
; ++i
)
574 matrix
->rows
[i
].enabled_p
= false;
577 else if (matrix
== w
->desired_matrix
)
579 /* Rows in desired matrices always have to be cleared;
580 redisplay expects this is the case when it runs, so it
581 had better be the case when we adjust matrices between
583 for (i
= 0; i
< matrix
->nrows
; ++i
)
584 matrix
->rows
[i
].enabled_p
= false;
589 /* Remember last values to be able to optimize frame redraws. */
590 matrix
->matrix_x
= x
;
591 matrix
->matrix_y
= y
;
592 matrix
->matrix_w
= dim
.width
;
593 matrix
->matrix_h
= dim
.height
;
595 /* Record the top y location and height of W at the time the matrix
596 was last adjusted. This is used to optimize redisplay above. */
599 matrix
->window_pixel_left
= WINDOW_LEFT_PIXEL_EDGE (w
);
600 matrix
->window_pixel_top
= WINDOW_TOP_PIXEL_EDGE (w
);
601 matrix
->window_height
= window_height
;
602 matrix
->window_width
= window_width
;
603 matrix
->window_vscroll
= w
->vscroll
;
608 /* Reverse the contents of rows in MATRIX between START and END. The
609 contents of the row at END - 1 end up at START, END - 2 at START +
610 1 etc. This is part of the implementation of rotate_matrix (see
614 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
618 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
620 /* Non-ISO HP/UX compiler doesn't like auto struct
622 struct glyph_row temp
;
623 temp
= matrix
->rows
[i
];
624 matrix
->rows
[i
] = matrix
->rows
[j
];
625 matrix
->rows
[j
] = temp
;
630 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
631 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
632 indices. (Note: this does not copy glyphs, only glyph pointers in
633 row structures are moved around).
635 The algorithm used for rotating the vector was, I believe, first
636 described by Kernighan. See the vector R as consisting of two
637 sub-vectors AB, where A has length BY for BY >= 0. The result
638 after rotating is then BA. Reverse both sub-vectors to get ArBr
639 and reverse the result to get (ArBr)r which is BA. Similar for
643 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
647 /* Up (rotate left, i.e. towards lower indices). */
649 reverse_rows (matrix
, first
, first
+ by
);
650 reverse_rows (matrix
, first
+ by
, last
);
651 reverse_rows (matrix
, first
, last
);
655 /* Down (rotate right, i.e. towards higher indices). */
656 reverse_rows (matrix
, last
- by
, last
);
657 reverse_rows (matrix
, first
, last
- by
);
658 reverse_rows (matrix
, first
, last
);
663 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
664 with indices START <= index < END. Increment positions by DELTA/
668 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
669 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
671 /* Check that START and END are reasonable values. */
672 eassert (start
>= 0 && start
<= matrix
->nrows
);
673 eassert (end
>= 0 && end
<= matrix
->nrows
);
674 eassert (start
<= end
);
676 for (; start
< end
; ++start
)
677 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
681 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
682 START and END are the row indices of the first and last + 1 row to clear. */
685 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
687 eassert (start
<= end
);
688 eassert (start
>= 0 && start
< matrix
->nrows
);
689 eassert (end
>= 0 && end
<= matrix
->nrows
);
691 for (; start
< end
; ++start
)
692 matrix
->rows
[start
].enabled_p
= false;
698 Empty all rows in MATRIX by clearing their enabled_p flags.
699 The function prepare_desired_row will eventually really clear a row
700 when it sees one with a false enabled_p flag.
702 Reset update hints to default values. The only update hint
703 currently present is the flag MATRIX->no_scrolling_p. */
706 clear_glyph_matrix (struct glyph_matrix
*matrix
)
710 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
711 matrix
->no_scrolling_p
= 0;
716 /* Shift part of the glyph matrix MATRIX of window W up or down.
717 Increment y-positions in glyph rows between START and END by DY,
718 and recompute their visible height. */
721 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
725 eassert (start
<= end
);
726 eassert (start
>= 0 && start
< matrix
->nrows
);
727 eassert (end
>= 0 && end
<= matrix
->nrows
);
729 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
730 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
732 for (; start
< end
; ++start
)
734 struct glyph_row
*row
= &matrix
->rows
[start
];
737 row
->visible_height
= row
->height
;
740 row
->visible_height
-= min_y
- row
->y
;
741 if (row
->y
+ row
->height
> max_y
)
742 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
743 if (row
->fringe_bitmap_periodic_p
)
744 row
->redraw_fringe_bitmaps_p
= 1;
749 /* Mark all rows in current matrices of frame F as invalid. Marking
750 invalid is done by setting enabled_p to zero for all rows in a
754 clear_current_matrices (register struct frame
*f
)
756 /* Clear frame current matrix, if we have one. */
757 if (f
->current_matrix
)
758 clear_glyph_matrix (f
->current_matrix
);
760 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
761 /* Clear the matrix of the menu bar window, if such a window exists.
762 The menu bar window is currently used to display menus on X when
763 no toolkit support is compiled in. */
764 if (WINDOWP (f
->menu_bar_window
))
765 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
768 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
769 /* Clear the matrix of the tool-bar window, if any. */
770 if (WINDOWP (f
->tool_bar_window
))
771 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
774 /* Clear current window matrices. */
775 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
776 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
780 /* Clear out all display lines of F for a coming redisplay. */
783 clear_desired_matrices (register struct frame
*f
)
785 if (f
->desired_matrix
)
786 clear_glyph_matrix (f
->desired_matrix
);
788 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
789 if (WINDOWP (f
->menu_bar_window
))
790 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
793 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
794 if (WINDOWP (f
->tool_bar_window
))
795 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
798 /* Do it for window matrices. */
799 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
800 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
804 /* Clear matrices in window tree rooted in W. If DESIRED_P,
805 clear desired matrices, otherwise clear current matrices. */
808 clear_window_matrices (struct window
*w
, bool desired_p
)
812 if (WINDOWP (w
->contents
))
813 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
817 clear_glyph_matrix (w
->desired_matrix
);
820 clear_glyph_matrix (w
->current_matrix
);
821 w
->window_end_valid
= 0;
825 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
831 /***********************************************************************
834 See dispextern.h for an overall explanation of glyph rows.
835 ***********************************************************************/
837 /* Clear glyph row ROW. NOTE: this code relies on the current
838 layout of `glyphs' and `used' fields of `struct glyph_row'. */
841 clear_glyph_row (struct glyph_row
*row
)
843 enum { off
= offsetof (struct glyph_row
, used
) };
845 /* Zero everything except pointers in `glyphs'. */
846 memset (row
->used
, 0, sizeof *row
- off
);
850 /* Make ROW an empty, enabled row of canonical character height,
851 in window W starting at y-position Y. */
854 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
858 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
859 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
861 clear_glyph_row (row
);
863 row
->ascent
= row
->phys_ascent
= 0;
864 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
865 row
->visible_height
= row
->height
;
868 row
->visible_height
-= min_y
- row
->y
;
869 if (row
->y
+ row
->height
> max_y
)
870 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
872 row
->enabled_p
= true;
876 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
877 are the amounts by which to change positions. Note that the first
878 glyph of the text area of a row can have a buffer position even if
879 the used count of the text area is zero. Such rows display line
883 increment_row_positions (struct glyph_row
*row
,
884 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
888 /* Increment start and end positions. */
889 MATRIX_ROW_START_CHARPOS (row
) += delta
;
890 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
891 MATRIX_ROW_END_CHARPOS (row
) += delta
;
892 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
893 CHARPOS (row
->start
.pos
) += delta
;
894 BYTEPOS (row
->start
.pos
) += delta_bytes
;
895 CHARPOS (row
->end
.pos
) += delta
;
896 BYTEPOS (row
->end
.pos
) += delta_bytes
;
901 /* Increment positions in glyphs. */
902 for (area
= 0; area
< LAST_AREA
; ++area
)
903 for (i
= 0; i
< row
->used
[area
]; ++i
)
904 if (BUFFERP (row
->glyphs
[area
][i
].object
)
905 && row
->glyphs
[area
][i
].charpos
> 0)
906 row
->glyphs
[area
][i
].charpos
+= delta
;
908 /* Capture the case of rows displaying a line end. */
909 if (row
->used
[TEXT_AREA
] == 0
910 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
911 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
916 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
917 contents, i.e. glyph structure contents are exchanged between A and
918 B without changing glyph pointers in A and B. */
921 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
925 for (area
= 0; area
< LAST_AREA
; ++area
)
927 /* Number of glyphs to swap. */
928 int max_used
= max (a
->used
[area
], b
->used
[area
]);
930 /* Start of glyphs in area of row A. */
931 struct glyph
*glyph_a
= a
->glyphs
[area
];
933 /* End + 1 of glyphs in area of row A. */
934 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
936 /* Start of glyphs in area of row B. */
937 struct glyph
*glyph_b
= b
->glyphs
[area
];
939 while (glyph_a
< glyph_a_end
)
941 /* Non-ISO HP/UX compiler doesn't like auto struct
955 /* Exchange pointers to glyph memory between glyph rows A and B. Also
956 exchange the used[] array and the hash values of the rows, because
957 these should all go together for the row's hash value to be
961 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
964 unsigned hash_tem
= a
->hash
;
966 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
968 struct glyph
*temp
= a
->glyphs
[i
];
970 a
->glyphs
[i
] = b
->glyphs
[i
];
974 short used_tem
= a
->used
[i
];
976 a
->used
[i
] = b
->used
[i
];
977 b
->used
[i
] = used_tem
;
985 /* Copy glyph row structure FROM to glyph row structure TO, except that
986 glyph pointers, the `used' counts, and the hash values in the structures
987 are left unchanged. NOTE: this code relies on the current layout of
988 `glyphs', `used', `hash' and `x' fields of `struct glyph_row'. */
991 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
993 enum { off
= offsetof (struct glyph_row
, x
) };
995 memcpy (&to
->x
, &from
->x
, sizeof *to
- off
);
999 /* Assign glyph row FROM to glyph row TO. This works like a structure
1000 assignment TO = FROM, except that glyph pointers are not copied but
1001 exchanged between TO and FROM. Pointers must be exchanged to avoid
1005 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1007 swap_glyph_pointers (to
, from
);
1008 copy_row_except_pointers (to
, from
);
1012 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1013 a row in a window matrix, is a slice of the glyph memory of the
1014 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1015 is true if the glyph memory of WINDOW_ROW is part of the glyph
1016 memory of FRAME_ROW. */
1021 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1023 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1024 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1025 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1027 return (frame_glyph_start
<= window_glyph_start
1028 && window_glyph_start
< frame_glyph_end
);
1031 #endif /* GLYPH_DEBUG */
1035 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1036 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1037 in WINDOW_MATRIX is found satisfying the condition. */
1039 static struct glyph_row
*
1040 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1041 struct glyph_matrix
*frame_matrix
, int row
)
1045 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1047 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1048 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1049 frame_matrix
->rows
+ row
))
1052 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1057 /* Prepare ROW for display in windows W. Desired rows are cleared
1058 lazily, i.e. they are only marked as to be cleared by setting their
1059 enabled_p flag to zero. When a row is to be displayed, a prior
1060 call to this function really clears it. In addition, this function
1061 makes sure the marginal areas of ROW are in sync with the window's
1062 display margins. MODE_LINE_P non-zero means we are preparing a
1063 glyph row for header line or mode line. */
1066 prepare_desired_row (struct window
*w
, struct glyph_row
*row
, bool mode_line_p
)
1068 if (!row
->enabled_p
)
1070 bool rp
= row
->reversed_p
;
1072 clear_glyph_row (row
);
1073 row
->enabled_p
= true;
1074 row
->reversed_p
= rp
;
1078 /* Mode and header lines, if displayed, never have marginal
1079 areas. If we are called with MODE_LINE_P non-zero, we are
1080 displaying the mode/header line in this window, and so the
1081 marginal areas of this glyph row should be eliminated. This
1082 is needed when the mode/header line is switched on in a
1083 window that has display margins. */
1084 if (w
->left_margin_cols
> 0)
1085 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
1086 if (w
->right_margin_cols
> 0)
1087 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
];
1091 /* The real number of glyphs reserved for the margins is
1092 recorded in the glyph matrix, and can be different from
1093 window's left_margin_cols and right_margin_cols; see
1094 margin_glyphs_to_reserve for when that happens. */
1095 int left
= w
->desired_matrix
->left_margin_glyphs
;
1096 int right
= w
->desired_matrix
->right_margin_glyphs
;
1098 /* Make sure the marginal areas of this row are in sync with
1099 what the window wants, when the row actually displays text
1100 and not header/mode line. */
1101 if (w
->left_margin_cols
> 0
1102 && (left
!= row
->glyphs
[TEXT_AREA
] - row
->glyphs
[LEFT_MARGIN_AREA
]))
1103 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
1104 if (w
->right_margin_cols
> 0
1105 && (right
!= row
->glyphs
[LAST_AREA
] - row
->glyphs
[RIGHT_MARGIN_AREA
]))
1106 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
] - right
;
1111 /* Return a hash code for glyph row ROW, which may
1112 be from current or desired matrix of frame F. */
1115 line_hash_code (struct frame
*f
, struct glyph_row
*row
)
1121 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1122 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1126 int c
= glyph
->u
.ch
;
1127 int face_id
= glyph
->face_id
;
1128 if (FRAME_MUST_WRITE_SPACES (f
))
1130 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1131 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1143 /* Return the cost of drawing line VPOS in MATRIX, which may
1144 be current or desired matrix of frame F. The cost equals
1145 the number of characters in the line. If must_write_spaces
1146 is zero, leading and trailing spaces are ignored. */
1149 line_draw_cost (struct frame
*f
, struct glyph_matrix
*matrix
, int vpos
)
1151 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1152 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1153 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1155 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1156 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1158 /* Ignore trailing and leading spaces if we can. */
1159 if (!FRAME_MUST_WRITE_SPACES (f
))
1161 /* Skip from the end over trailing spaces. */
1162 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1165 /* All blank line. */
1169 /* Skip over leading spaces. */
1170 while (CHAR_GLYPH_SPACE_P (*beg
))
1174 /* If we don't have a glyph-table, each glyph is one character,
1175 so return the number of glyphs. */
1176 if (glyph_table_base
== 0)
1180 /* Otherwise, scan the glyphs and accumulate their total length
1187 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1189 if (GLYPH_INVALID_P (g
)
1190 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1193 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1203 /* Return true if the glyph rows A and B have equal contents.
1204 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1207 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1209 eassert (verify_row_hash (a
));
1210 eassert (verify_row_hash (b
));
1214 else if (a
->hash
!= b
->hash
)
1218 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1221 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1224 /* Compare glyphs. */
1225 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1227 if (a
->used
[area
] != b
->used
[area
])
1230 a_glyph
= a
->glyphs
[area
];
1231 a_end
= a_glyph
+ a
->used
[area
];
1232 b_glyph
= b
->glyphs
[area
];
1234 while (a_glyph
< a_end
1235 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1236 ++a_glyph
, ++b_glyph
;
1238 if (a_glyph
!= a_end
)
1242 if (a
->fill_line_p
!= b
->fill_line_p
1243 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1244 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1245 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1246 || a
->left_fringe_offset
!= b
->left_fringe_offset
1247 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1248 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1249 || a
->right_fringe_offset
!= b
->right_fringe_offset
1250 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1251 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1252 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1253 || a
->overlapped_p
!= b
->overlapped_p
1254 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1255 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1256 || a
->reversed_p
!= b
->reversed_p
1257 /* Different partially visible characters on left margin. */
1259 /* Different height. */
1260 || a
->ascent
!= b
->ascent
1261 || a
->phys_ascent
!= b
->phys_ascent
1262 || a
->phys_height
!= b
->phys_height
1263 || a
->visible_height
!= b
->visible_height
)
1272 /***********************************************************************
1275 See dispextern.h for an overall explanation of glyph pools.
1276 ***********************************************************************/
1278 /* Allocate a glyph_pool structure. The structure returned is initialized
1279 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1280 variable glyph_pool_count is incremented for each pool allocated. */
1282 static struct glyph_pool
*
1283 new_glyph_pool (void)
1285 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1287 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1288 /* For memory leak and double deletion checking. */
1296 /* Free a glyph_pool structure POOL. The function may be called with
1297 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1298 global variable glyph_pool_count is decremented with every pool structure
1299 freed. If this count gets negative, more structures were freed than
1300 allocated, i.e. one structure must have been freed more than once or
1301 a bogus pointer was passed to free_glyph_pool. */
1304 free_glyph_pool (struct glyph_pool
*pool
)
1308 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1309 /* More freed than allocated? */
1311 eassert (glyph_pool_count
>= 0);
1313 xfree (pool
->glyphs
);
1319 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1320 columns we need. This function never shrinks a pool. The only
1321 case in which this would make sense, would be when a frame's size
1322 is changed from a large value to a smaller one. But, if someone
1323 does it once, we can expect that he will do it again.
1325 Return true if the pool changed in a way which makes
1326 re-adjusting window glyph matrices necessary. */
1329 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1334 changed_p
= (pool
->glyphs
== 0
1335 || matrix_dim
.height
!= pool
->nrows
1336 || matrix_dim
.width
!= pool
->ncolumns
);
1338 /* Enlarge the glyph pool. */
1339 needed
= matrix_dim
.width
;
1340 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1341 memory_full (SIZE_MAX
);
1342 needed
*= matrix_dim
.height
;
1343 if (needed
> pool
->nglyphs
)
1345 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1346 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1347 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1348 memset (pool
->glyphs
+ old_nglyphs
, 0,
1349 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1352 /* Remember the number of rows and columns because (a) we use them
1353 to do sanity checks, and (b) the number of columns determines
1354 where rows in the frame matrix start---this must be available to
1355 determine pointers to rows of window sub-matrices. */
1356 pool
->nrows
= matrix_dim
.height
;
1357 pool
->ncolumns
= matrix_dim
.width
;
1364 /***********************************************************************
1366 ***********************************************************************/
1371 /* Flush standard output. This is sometimes useful to call from the debugger.
1372 XXX Maybe this should be changed to flush the current terminal instead of
1376 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1385 /* Check that no glyph pointers have been lost in MATRIX. If a
1386 pointer has been lost, e.g. by using a structure assignment between
1387 rows, at least one pointer must occur more than once in the rows of
1391 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1395 for (i
= 0; i
< matrix
->nrows
; ++i
)
1396 for (j
= 0; j
< matrix
->nrows
; ++j
)
1398 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1399 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1403 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1406 matrix_row (struct glyph_matrix
*matrix
, int row
)
1408 eassert (matrix
&& matrix
->rows
);
1409 eassert (row
>= 0 && row
< matrix
->nrows
);
1411 /* That's really too slow for normal testing because this function
1412 is called almost everywhere. Although---it's still astonishingly
1413 fast, so it is valuable to have for debugging purposes. */
1415 check_matrix_pointer_lossage (matrix
);
1418 return matrix
->rows
+ row
;
1422 #if 0 /* This function makes invalid assumptions when text is
1423 partially invisible. But it might come handy for debugging
1426 /* Check invariants that must hold for an up to date current matrix of
1430 check_matrix_invariants (struct window
*w
)
1432 struct glyph_matrix
*matrix
= w
->current_matrix
;
1433 int yb
= window_text_bottom_y (w
);
1434 struct glyph_row
*row
= matrix
->rows
;
1435 struct glyph_row
*last_text_row
= NULL
;
1436 struct buffer
*saved
= current_buffer
;
1437 struct buffer
*buffer
= XBUFFER (w
->contents
);
1440 /* This can sometimes happen for a fresh window. */
1441 if (matrix
->nrows
< 2)
1444 set_buffer_temp (buffer
);
1446 /* Note: last row is always reserved for the mode line. */
1447 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1448 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1450 struct glyph_row
*next
= row
+ 1;
1452 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1453 last_text_row
= row
;
1455 /* Check that character and byte positions are in sync. */
1456 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1457 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1458 eassert (BYTEPOS (row
->start
.pos
)
1459 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1461 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1462 have such a position temporarily in case of a minibuffer
1463 displaying something like `[Sole completion]' at its end. */
1464 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1466 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1467 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1468 eassert (BYTEPOS (row
->end
.pos
)
1469 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1472 /* Check that end position of `row' is equal to start position
1474 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1476 eassert (MATRIX_ROW_END_CHARPOS (row
)
1477 == MATRIX_ROW_START_CHARPOS (next
));
1478 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1479 == MATRIX_ROW_START_BYTEPOS (next
));
1480 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1481 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1486 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1487 eassert (w
->desired_matrix
->rows
!= NULL
);
1488 set_buffer_temp (saved
);
1493 #endif /* GLYPH_DEBUG */
1497 /**********************************************************************
1498 Allocating/ Adjusting Glyph Matrices
1499 **********************************************************************/
1501 /* Allocate glyph matrices over a window tree for a frame-based
1504 X and Y are column/row within the frame glyph matrix where
1505 sub-matrices for the window tree rooted at WINDOW must be
1506 allocated. DIM_ONLY_P means that the caller of this
1507 function is only interested in the result matrix dimension, and
1508 matrix adjustments should not be performed.
1510 The function returns the total width/height of the sub-matrices of
1511 the window tree. If called on a frame root window, the computation
1512 will take the mini-buffer window into account.
1514 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1516 NEW_LEAF_MATRIX set if any window in the tree did not have a
1517 glyph matrices yet, and
1519 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1520 any window in the tree will be changed or have been changed (see
1523 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1526 Windows are arranged into chains of windows on the same level
1527 through the next fields of window structures. Such a level can be
1528 either a sequence of horizontally adjacent windows from left to
1529 right, or a sequence of vertically adjacent windows from top to
1530 bottom. Each window in a horizontal sequence can be either a leaf
1531 window or a vertical sequence; a window in a vertical sequence can
1532 be either a leaf or a horizontal sequence. All windows in a
1533 horizontal sequence have the same height, and all windows in a
1534 vertical sequence have the same width.
1536 This function uses, for historical reasons, a more general
1537 algorithm to determine glyph matrix dimensions that would be
1540 The matrix height of a horizontal sequence is determined by the
1541 maximum height of any matrix in the sequence. The matrix width of
1542 a horizontal sequence is computed by adding up matrix widths of
1543 windows in the sequence.
1545 |<------- result width ------->|
1546 +---------+----------+---------+ ---
1549 +---------+ | | result height
1554 The matrix width of a vertical sequence is the maximum matrix width
1555 of any window in the sequence. Its height is computed by adding up
1556 matrix heights of windows in the sequence.
1558 |<---- result width -->|
1566 +------------+---------+ |
1569 +------------+---------+ --- */
1571 /* Bit indicating that a new matrix will be allocated or has been
1574 #define NEW_LEAF_MATRIX (1 << 0)
1576 /* Bit indicating that a matrix will or has changed its location or
1579 #define CHANGED_LEAF_MATRIX (1 << 1)
1582 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1583 bool dim_only_p
, int *window_change_flags
)
1585 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1587 int wmax
= 0, hmax
= 0;
1591 bool in_horz_combination_p
;
1593 /* What combination is WINDOW part of? Compute this once since the
1594 result is the same for all windows in the `next' chain. The
1595 special case of a root window (parent equal to nil) is treated
1596 like a vertical combination because a root window's `next'
1597 points to the mini-buffer window, if any, which is arranged
1598 vertically below other windows. */
1599 in_horz_combination_p
1600 = (!NILP (XWINDOW (window
)->parent
)
1601 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1603 /* For WINDOW and all windows on the same level. */
1606 w
= XWINDOW (window
);
1608 /* Get the dimension of the window sub-matrix for W, depending
1609 on whether this is a combination or a leaf window. */
1610 if (WINDOWP (w
->contents
))
1611 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1613 window_change_flags
);
1616 /* If not already done, allocate sub-matrix structures. */
1617 if (w
->desired_matrix
== NULL
)
1619 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1620 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1621 *window_change_flags
|= NEW_LEAF_MATRIX
;
1624 /* Width and height MUST be chosen so that there are no
1625 holes in the frame matrix. */
1626 dim
.width
= required_matrix_width (w
);
1627 dim
.height
= required_matrix_height (w
);
1629 /* Will matrix be re-allocated? */
1630 if (x
!= w
->desired_matrix
->matrix_x
1631 || y
!= w
->desired_matrix
->matrix_y
1632 || dim
.width
!= w
->desired_matrix
->matrix_w
1633 || dim
.height
!= w
->desired_matrix
->matrix_h
1634 || (margin_glyphs_to_reserve (w
, dim
.width
,
1635 w
->left_margin_cols
)
1636 != w
->desired_matrix
->left_margin_glyphs
)
1637 || (margin_glyphs_to_reserve (w
, dim
.width
,
1638 w
->right_margin_cols
)
1639 != w
->desired_matrix
->right_margin_glyphs
))
1640 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1642 /* Actually change matrices, if allowed. Do not consider
1643 CHANGED_LEAF_MATRIX computed above here because the pool
1644 may have been changed which we don't know here. We trust
1645 that we only will be called with DIM_ONLY_P when
1649 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1650 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1654 /* If we are part of a horizontal combination, advance x for
1655 windows to the right of W; otherwise advance y for windows
1657 if (in_horz_combination_p
)
1662 /* Remember maximum glyph matrix dimensions. */
1663 wmax
= max (wmax
, dim
.width
);
1664 hmax
= max (hmax
, dim
.height
);
1666 /* Next window on same level. */
1669 while (!NILP (window
));
1671 /* Set `total' to the total glyph matrix dimension of this window
1672 level. In a vertical combination, the width is the width of the
1673 widest window; the height is the y we finally reached, corrected
1674 by the y we started with. In a horizontal combination, the total
1675 height is the height of the tallest window, and the width is the
1676 x we finally reached, corrected by the x we started with. */
1677 if (in_horz_combination_p
)
1679 total
.width
= x
- x0
;
1680 total
.height
= hmax
;
1685 total
.height
= y
- y0
;
1692 /* Return the required height of glyph matrices for window W. */
1695 required_matrix_height (struct window
*w
)
1697 #ifdef HAVE_WINDOW_SYSTEM
1698 struct frame
*f
= XFRAME (w
->frame
);
1700 if (FRAME_WINDOW_P (f
))
1702 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1703 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1705 return (((window_pixel_height
+ ch_height
- 1)
1706 / ch_height
) * w
->nrows_scale_factor
1707 /* One partially visible line at the top and
1708 bottom of the window. */
1710 /* 2 for header and mode line. */
1713 #endif /* HAVE_WINDOW_SYSTEM */
1715 return WINDOW_TOTAL_LINES (w
);
1719 /* Return the required width of glyph matrices for window W. */
1722 required_matrix_width (struct window
*w
)
1724 #ifdef HAVE_WINDOW_SYSTEM
1725 struct frame
*f
= XFRAME (w
->frame
);
1726 if (FRAME_WINDOW_P (f
))
1728 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1730 /* Compute number of glyphs needed in a glyph row. */
1731 return (((WINDOW_PIXEL_WIDTH (w
) + ch_width
- 1)
1732 / ch_width
) * w
->ncols_scale_factor
1733 /* 2 partially visible columns in the text area. */
1735 /* One partially visible column at the right
1736 edge of each marginal area. */
1739 #endif /* HAVE_WINDOW_SYSTEM */
1741 return w
->total_cols
;
1745 /* Allocate window matrices for window-based redisplay. W is the
1746 window whose matrices must be allocated/reallocated. */
1749 allocate_matrices_for_window_redisplay (struct window
*w
)
1753 if (WINDOWP (w
->contents
))
1754 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1757 /* W is a leaf window. */
1760 /* If matrices are not yet allocated, allocate them now. */
1761 if (w
->desired_matrix
== NULL
)
1763 w
->desired_matrix
= new_glyph_matrix (NULL
);
1764 w
->current_matrix
= new_glyph_matrix (NULL
);
1767 dim
.width
= required_matrix_width (w
);
1768 dim
.height
= required_matrix_height (w
);
1769 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1770 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1773 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1777 /* Allocate/reallocate glyph matrices of a single frame F.
1778 This function must be called when a new frame is created,
1779 its size changes, or its window configuration changes. */
1782 adjust_frame_glyphs (struct frame
*f
)
1784 /* Block input so that expose events and other events that access
1785 glyph matrices are not processed while we are changing them. */
1788 if (FRAME_WINDOW_P (f
))
1789 adjust_frame_glyphs_for_window_redisplay (f
);
1791 adjust_frame_glyphs_for_frame_redisplay (f
);
1793 /* Don't forget the buffer for decode_mode_spec. */
1794 adjust_decode_mode_spec_buffer (f
);
1796 f
->glyphs_initialized_p
= 1;
1801 /* Return true if any window in the tree has nonzero window margins. See
1802 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1804 showing_window_margins_p (struct window
*w
)
1808 if (WINDOWP (w
->contents
))
1810 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1813 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1816 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1822 /* In the window tree with root W, build current matrices of leaf
1823 windows from the frame's current matrix. */
1826 fake_current_matrices (Lisp_Object window
)
1830 for (; !NILP (window
); window
= w
->next
)
1832 w
= XWINDOW (window
);
1834 if (WINDOWP (w
->contents
))
1835 fake_current_matrices (w
->contents
);
1839 struct frame
*f
= XFRAME (w
->frame
);
1840 struct glyph_matrix
*m
= w
->current_matrix
;
1841 struct glyph_matrix
*fm
= f
->current_matrix
;
1843 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1844 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1846 for (i
= 0; i
< m
->matrix_h
; ++i
)
1848 struct glyph_row
*r
= m
->rows
+ i
;
1849 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1851 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1852 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1854 r
->enabled_p
= fr
->enabled_p
;
1857 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1858 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1859 r
->used
[TEXT_AREA
] = (m
->matrix_w
1860 - r
->used
[LEFT_MARGIN_AREA
]
1861 - r
->used
[RIGHT_MARGIN_AREA
]);
1870 /* Save away the contents of frame F's current frame matrix. Value is
1871 a glyph matrix holding the contents of F's current frame matrix. */
1873 static struct glyph_matrix
*
1874 save_current_matrix (struct frame
*f
)
1877 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1878 saved
->nrows
= f
->current_matrix
->nrows
;
1879 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1881 for (i
= 0; i
< saved
->nrows
; ++i
)
1883 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1884 struct glyph_row
*to
= saved
->rows
+ i
;
1885 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1887 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1888 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1889 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1890 to
->enabled_p
= from
->enabled_p
;
1891 to
->hash
= from
->hash
;
1892 if (from
->used
[LEFT_MARGIN_AREA
])
1894 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1895 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1896 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1897 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1898 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1900 if (from
->used
[RIGHT_MARGIN_AREA
])
1902 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1903 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1904 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1905 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1906 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1914 /* Restore the contents of frame F's current frame matrix from SAVED,
1915 and free memory associated with SAVED. */
1918 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1922 for (i
= 0; i
< saved
->nrows
; ++i
)
1924 struct glyph_row
*from
= saved
->rows
+ i
;
1925 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1926 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1928 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1929 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1930 xfree (from
->glyphs
[TEXT_AREA
]);
1931 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1934 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1935 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1936 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1937 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1940 to
->used
[LEFT_MARGIN_AREA
] = 0;
1941 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1944 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1945 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1946 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1947 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1950 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1953 xfree (saved
->rows
);
1959 /* Allocate/reallocate glyph matrices of a single frame F for
1960 frame-based redisplay. */
1963 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1965 struct dim matrix_dim
;
1966 bool pool_changed_p
;
1967 int window_change_flags
;
1970 if (!FRAME_LIVE_P (f
))
1973 top_window_y
= FRAME_TOP_MARGIN (f
);
1975 /* Allocate glyph pool structures if not already done. */
1976 if (f
->desired_pool
== NULL
)
1978 f
->desired_pool
= new_glyph_pool ();
1979 f
->current_pool
= new_glyph_pool ();
1982 /* Allocate frames matrix structures if needed. */
1983 if (f
->desired_matrix
== NULL
)
1985 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1986 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1989 /* Compute window glyph matrices. (This takes the mini-buffer
1990 window into account). The result is the size of the frame glyph
1991 matrix needed. The variable window_change_flags is set to a bit
1992 mask indicating whether new matrices will be allocated or
1993 existing matrices change their size or location within the frame
1995 window_change_flags
= 0;
1997 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2000 &window_change_flags
);
2002 /* Add in menu bar lines, if any. */
2003 matrix_dim
.height
+= top_window_y
;
2005 /* Enlarge pools as necessary. */
2006 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2007 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2009 /* Set up glyph pointers within window matrices. Do this only if
2010 absolutely necessary since it requires a frame redraw. */
2011 if (pool_changed_p
|| window_change_flags
)
2013 /* Do it for window matrices. */
2014 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2016 &window_change_flags
);
2018 /* Size of frame matrices must equal size of frame. Note
2019 that we are called for X frames with window widths NOT equal
2020 to the frame width (from CHANGE_FRAME_SIZE_1). */
2021 if (matrix_dim
.width
!= FRAME_TOTAL_COLS (f
)
2022 || matrix_dim
.height
!= FRAME_TOTAL_LINES (f
))
2025 eassert (matrix_dim
.width
== FRAME_TOTAL_COLS (f
)
2026 && matrix_dim
.height
== FRAME_TOTAL_LINES (f
));
2028 /* Pointers to glyph memory in glyph rows are exchanged during
2029 the update phase of redisplay, which means in general that a
2030 frame's current matrix consists of pointers into both the
2031 desired and current glyph pool of the frame. Adjusting a
2032 matrix sets the frame matrix up so that pointers are all into
2033 the same pool. If we want to preserve glyph contents of the
2034 current matrix over a call to adjust_glyph_matrix, we must
2035 make a copy of the current glyphs, and restore the current
2036 matrix' contents from that copy. */
2037 if (display_completed
2038 && !FRAME_GARBAGED_P (f
)
2039 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2040 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2041 /* For some reason, the frame glyph matrix gets corrupted if
2042 any of the windows contain margins. I haven't been able
2043 to hunt down the reason, but for the moment this prevents
2044 the problem from manifesting. -- cyd */
2045 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2047 struct glyph_matrix
*copy
= save_current_matrix (f
);
2048 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2049 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2050 restore_current_matrix (f
, copy
);
2051 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2055 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2056 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2057 SET_FRAME_GARBAGED (f
);
2063 /* Allocate/reallocate glyph matrices of a single frame F for
2064 window-based redisplay. */
2067 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2069 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2071 /* Allocate/reallocate window matrices. */
2072 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2074 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2075 /* Allocate/ reallocate matrices of the dummy window used to display
2076 the menu bar under X when no X toolkit support is available. */
2078 /* Allocate a dummy window if not already done. */
2080 if (NILP (f
->menu_bar_window
))
2083 fset_menu_bar_window (f
, make_window ());
2084 w
= XWINDOW (f
->menu_bar_window
);
2085 XSETFRAME (frame
, f
);
2086 wset_frame (w
, frame
);
2087 w
->pseudo_window_p
= 1;
2090 w
= XWINDOW (f
->menu_bar_window
);
2092 /* Set window dimensions to frame dimensions and allocate or
2093 adjust glyph matrices of W. */
2098 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2099 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2100 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2101 w
->pixel_height
= FRAME_MENU_BAR_HEIGHT (f
);
2102 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2103 allocate_matrices_for_window_redisplay (w
);
2107 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2109 /* Allocate/ reallocate matrices of the tool bar window. If we
2110 don't have a tool bar window yet, make one. */
2112 if (NILP (f
->tool_bar_window
))
2115 fset_tool_bar_window (f
, make_window ());
2116 w
= XWINDOW (f
->tool_bar_window
);
2117 XSETFRAME (frame
, f
);
2118 wset_frame (w
, frame
);
2119 w
->pseudo_window_p
= 1;
2122 w
= XWINDOW (f
->tool_bar_window
);
2126 w
->pixel_top
= FRAME_MENU_BAR_HEIGHT (f
);
2127 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2128 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2129 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2130 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2131 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2132 w
->pixel_height
= FRAME_TOOL_BAR_HEIGHT (f
);
2133 allocate_matrices_for_window_redisplay (w
);
2139 /* Re-allocate buffer for decode_mode_spec on frame F. */
2142 adjust_decode_mode_spec_buffer (struct frame
*f
)
2144 int frame_message_buf_size
= FRAME_MESSAGE_BUF_SIZE (f
);
2146 eassert (frame_message_buf_size
>= 0);
2147 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2148 frame_message_buf_size
+ 1);
2153 /**********************************************************************
2154 Freeing Glyph Matrices
2155 **********************************************************************/
2157 /* Free glyph memory for a frame F. F may be null. This function can
2158 be called for the same frame more than once. The root window of
2159 F may be nil when this function is called. This is the case when
2160 the function is called when F is destroyed. */
2163 free_glyphs (struct frame
*f
)
2165 if (f
&& f
->glyphs_initialized_p
)
2167 /* Block interrupt input so that we don't get surprised by an X
2168 event while we're in an inconsistent state. */
2170 f
->glyphs_initialized_p
= 0;
2172 /* Release window sub-matrices. */
2173 if (!NILP (f
->root_window
))
2174 free_window_matrices (XWINDOW (f
->root_window
));
2176 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2177 /* Free the dummy window for menu bars without X toolkit and its
2179 if (!NILP (f
->menu_bar_window
))
2181 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2182 free_glyph_matrix (w
->desired_matrix
);
2183 free_glyph_matrix (w
->current_matrix
);
2184 w
->desired_matrix
= w
->current_matrix
= NULL
;
2185 fset_menu_bar_window (f
, Qnil
);
2189 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2190 /* Free the tool bar window and its glyph matrices. */
2191 if (!NILP (f
->tool_bar_window
))
2193 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2194 free_glyph_matrix (w
->desired_matrix
);
2195 free_glyph_matrix (w
->current_matrix
);
2196 w
->desired_matrix
= w
->current_matrix
= NULL
;
2197 fset_tool_bar_window (f
, Qnil
);
2201 /* Release frame glyph matrices. Reset fields to zero in
2202 case we are called a second time. */
2203 if (f
->desired_matrix
)
2205 free_glyph_matrix (f
->desired_matrix
);
2206 free_glyph_matrix (f
->current_matrix
);
2207 f
->desired_matrix
= f
->current_matrix
= NULL
;
2210 /* Release glyph pools. */
2211 if (f
->desired_pool
)
2213 free_glyph_pool (f
->desired_pool
);
2214 free_glyph_pool (f
->current_pool
);
2215 f
->desired_pool
= f
->current_pool
= NULL
;
2223 /* Free glyph sub-matrices in the window tree rooted at W. This
2224 function may be called with a null pointer, and it may be called on
2225 the same tree more than once. */
2228 free_window_matrices (struct window
*w
)
2232 if (WINDOWP (w
->contents
))
2233 free_window_matrices (XWINDOW (w
->contents
));
2236 /* This is a leaf window. Free its memory and reset fields
2237 to zero in case this function is called a second time for
2239 free_glyph_matrix (w
->current_matrix
);
2240 free_glyph_matrix (w
->desired_matrix
);
2241 w
->current_matrix
= w
->desired_matrix
= NULL
;
2244 /* Next window on same level. */
2245 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2250 /* Check glyph memory leaks. This function is called from
2251 shut_down_emacs. Note that frames are not destroyed when Emacs
2252 exits. We therefore free all glyph memory for all active frames
2253 explicitly and check that nothing is left allocated. */
2256 check_glyph_memory (void)
2258 Lisp_Object tail
, frame
;
2260 /* Free glyph memory for all frames. */
2261 FOR_EACH_FRAME (tail
, frame
)
2262 free_glyphs (XFRAME (frame
));
2264 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2265 /* Check that nothing is left allocated. */
2266 eassert (glyph_matrix_count
== 0);
2267 eassert (glyph_pool_count
== 0);
2273 /**********************************************************************
2274 Building a Frame Matrix
2275 **********************************************************************/
2277 /* Most of the redisplay code works on glyph matrices attached to
2278 windows. This is a good solution most of the time, but it is not
2279 suitable for terminal code. Terminal output functions cannot rely
2280 on being able to set an arbitrary terminal window. Instead they
2281 must be provided with a view of the whole frame, i.e. the whole
2282 screen. We build such a view by constructing a frame matrix from
2283 window matrices in this section.
2285 Windows that must be updated have their must_be_updated_p flag set.
2286 For all such windows, their desired matrix is made part of the
2287 desired frame matrix. For other windows, their current matrix is
2288 made part of the desired frame matrix.
2290 +-----------------+----------------+
2291 | desired | desired |
2293 +-----------------+----------------+
2296 +----------------------------------+
2298 Desired window matrices can be made part of the frame matrix in a
2299 cheap way: We exploit the fact that the desired frame matrix and
2300 desired window matrices share their glyph memory. This is not
2301 possible for current window matrices. Their glyphs are copied to
2302 the desired frame matrix. The latter is equivalent to
2303 preserve_other_columns in the old redisplay.
2305 Used glyphs counters for frame matrix rows are the result of adding
2306 up glyph lengths of the window matrices. A line in the frame
2307 matrix is enabled, if a corresponding line in a window matrix is
2310 After building the desired frame matrix, it will be passed to
2311 terminal code, which will manipulate both the desired and current
2312 frame matrix. Changes applied to the frame's current matrix have
2313 to be visible in current window matrices afterwards, of course.
2315 This problem is solved like this:
2317 1. Window and frame matrices share glyphs. Window matrices are
2318 constructed in a way that their glyph contents ARE the glyph
2319 contents needed in a frame matrix. Thus, any modification of
2320 glyphs done in terminal code will be reflected in window matrices
2323 2. Exchanges of rows in a frame matrix done by terminal code are
2324 intercepted by hook functions so that corresponding row operations
2325 on window matrices can be performed. This is necessary because we
2326 use pointers to glyphs in glyph row structures. To satisfy the
2327 assumption of point 1 above that glyphs are updated implicitly in
2328 window matrices when they are manipulated via the frame matrix,
2329 window and frame matrix must of course agree where to find the
2330 glyphs for their rows. Possible manipulations that must be
2331 mirrored are assignments of rows of the desired frame matrix to the
2332 current frame matrix and scrolling the current frame matrix. */
2334 /* Build frame F's desired matrix from window matrices. Only windows
2335 which have the flag must_be_updated_p set have to be updated. Menu
2336 bar lines of a frame are not covered by window matrices, so make
2337 sure not to touch them in this function. */
2340 build_frame_matrix (struct frame
*f
)
2344 /* F must have a frame matrix when this function is called. */
2345 eassert (!FRAME_WINDOW_P (f
));
2347 /* Clear all rows in the frame matrix covered by window matrices.
2348 Menu bar lines are not covered by windows. */
2349 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2350 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2352 /* Build the matrix by walking the window tree. */
2353 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2354 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2358 /* Walk a window tree, building a frame matrix MATRIX from window
2359 matrices. W is the root of a window tree. */
2362 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2366 if (WINDOWP (w
->contents
))
2367 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2369 build_frame_matrix_from_leaf_window (matrix
, w
);
2371 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2376 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2377 desired frame matrix built. W is a leaf window whose desired or
2378 current matrix is to be added to FRAME_MATRIX. W's flag
2379 must_be_updated_p determines which matrix it contributes to
2380 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2381 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2382 Adding a desired matrix means setting up used counters and such in
2383 frame rows, while adding a current window matrix to FRAME_MATRIX
2384 means copying glyphs. The latter case corresponds to
2385 preserve_other_columns in the old redisplay. */
2388 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2390 struct glyph_matrix
*window_matrix
;
2391 int window_y
, frame_y
;
2392 /* If non-zero, a glyph to insert at the right border of W. */
2393 GLYPH right_border_glyph
;
2395 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2397 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2398 if (w
->must_be_updated_p
)
2400 window_matrix
= w
->desired_matrix
;
2402 /* Decide whether we want to add a vertical border glyph. */
2403 if (!WINDOW_RIGHTMOST_P (w
))
2405 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2408 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2410 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2412 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2413 spec_glyph_lookup_face (w
, &right_border_glyph
);
2416 if (GLYPH_FACE (right_border_glyph
) <= 0)
2417 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2421 window_matrix
= w
->current_matrix
;
2423 /* For all rows in the window matrix and corresponding rows in the
2426 frame_y
= window_matrix
->matrix_y
;
2427 while (window_y
< window_matrix
->nrows
)
2429 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2430 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2431 bool current_row_p
= window_matrix
== w
->current_matrix
;
2433 /* Fill up the frame row with spaces up to the left margin of the
2435 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2437 /* Fill up areas in the window matrix row with spaces. */
2438 fill_up_glyph_row_with_spaces (window_row
);
2440 /* If only part of W's desired matrix has been built, and
2441 window_row wasn't displayed, use the corresponding current
2443 if (window_matrix
== w
->desired_matrix
2444 && !window_row
->enabled_p
)
2446 window_row
= w
->current_matrix
->rows
+ window_y
;
2452 /* Copy window row to frame row. */
2453 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2454 window_row
->glyphs
[0],
2455 window_matrix
->matrix_w
* sizeof (struct glyph
));
2459 eassert (window_row
->enabled_p
);
2461 /* Only when a desired row has been displayed, we want
2462 the corresponding frame row to be updated. */
2463 frame_row
->enabled_p
= true;
2465 /* Maybe insert a vertical border between horizontally adjacent
2467 if (GLYPH_CHAR (right_border_glyph
) != 0)
2469 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2470 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2474 /* Window row window_y must be a slice of frame row
2476 eassert (glyph_row_slice_p (window_row
, frame_row
));
2478 /* If rows are in sync, we don't have to copy glyphs because
2479 frame and window share glyphs. */
2481 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2482 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2486 /* Set number of used glyphs in the frame matrix. Since we fill
2487 up with spaces, and visit leaf windows from left to right it
2488 can be done simply. */
2489 frame_row
->used
[TEXT_AREA
]
2490 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2498 /* Given a user-specified glyph, possibly including a Lisp-level face
2499 ID, return a glyph that has a realized face ID.
2500 This is used for glyphs displayed specially and not part of the text;
2501 for instance, vertical separators, truncation markers, etc. */
2504 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2506 int lface_id
= GLYPH_FACE (*glyph
);
2507 /* Convert the glyph's specified face to a realized (cache) face. */
2510 int face_id
= merge_faces (XFRAME (w
->frame
),
2511 Qt
, lface_id
, DEFAULT_FACE_ID
);
2512 SET_GLYPH_FACE (*glyph
, face_id
);
2516 /* Add spaces to a glyph row ROW in a window matrix.
2518 Each row has the form:
2520 +---------+-----------------------------+------------+
2521 | left | text | right |
2522 +---------+-----------------------------+------------+
2524 Left and right marginal areas are optional. This function adds
2525 spaces to areas so that there are no empty holes between areas.
2526 In other words: If the right area is not empty, the text area
2527 is filled up with spaces up to the right area. If the text area
2528 is not empty, the left area is filled up.
2530 To be called for frame-based redisplay, only. */
2533 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2535 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2536 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2537 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2541 /* Fill area AREA of glyph row ROW with spaces. To be called for
2542 frame-based redisplay only. */
2545 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2547 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2549 struct glyph
*end
= row
->glyphs
[area
+ 1];
2550 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2553 *text
++ = space_glyph
;
2554 row
->used
[area
] = text
- row
->glyphs
[area
];
2559 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2560 reached. In frame matrices only one area, TEXT_AREA, is used. */
2563 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2565 int i
= row
->used
[TEXT_AREA
];
2566 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2569 glyph
[i
++] = space_glyph
;
2571 row
->used
[TEXT_AREA
] = i
;
2576 /**********************************************************************
2577 Mirroring operations on frame matrices in window matrices
2578 **********************************************************************/
2580 /* Set frame being updated via frame-based redisplay to F. This
2581 function must be called before updates to make explicit that we are
2582 working on frame matrices or not. */
2585 set_frame_matrix_frame (struct frame
*f
)
2587 frame_matrix_frame
= f
;
2591 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2592 DESIRED_MATRIX is the desired matrix corresponding to
2593 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2594 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2595 frame_matrix_frame is non-null, this indicates that the exchange is
2596 done in frame matrices, and that we have to perform analogous
2597 operations in window matrices of frame_matrix_frame. */
2600 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2602 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2603 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2604 bool mouse_face_p
= current_row
->mouse_face_p
;
2606 /* Do current_row = desired_row. This exchanges glyph pointers
2607 between both rows, and does a structure assignment otherwise. */
2608 assign_row (current_row
, desired_row
);
2610 /* Enable current_row to mark it as valid. */
2611 current_row
->enabled_p
= true;
2612 current_row
->mouse_face_p
= mouse_face_p
;
2614 /* If we are called on frame matrices, perform analogous operations
2615 for window matrices. */
2616 if (frame_matrix_frame
)
2617 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2621 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2622 W's frame which has been made current (by swapping pointers between
2623 current and desired matrix). Perform analogous operations in the
2624 matrices of leaf windows in the window tree rooted at W. */
2627 mirror_make_current (struct window
*w
, int frame_row
)
2631 if (WINDOWP (w
->contents
))
2632 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2635 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2636 here because the checks performed in debug mode there
2637 will not allow the conversion. */
2638 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2640 /* If FRAME_ROW is within W, assign the desired row to the
2641 current row (exchanging glyph pointers). */
2642 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2644 struct glyph_row
*current_row
2645 = MATRIX_ROW (w
->current_matrix
, row
);
2646 struct glyph_row
*desired_row
2647 = MATRIX_ROW (w
->desired_matrix
, row
);
2649 if (desired_row
->enabled_p
)
2650 assign_row (current_row
, desired_row
);
2652 swap_glyph_pointers (desired_row
, current_row
);
2653 current_row
->enabled_p
= true;
2655 /* Set the Y coordinate of the mode/header line's row.
2656 It is needed in draw_row_with_mouse_face to find the
2657 screen coordinates. (Window-based redisplay sets
2658 this in update_window, but no one seems to do that
2659 for frame-based redisplay.) */
2660 if (current_row
->mode_line_p
)
2661 current_row
->y
= row
;
2665 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2670 /* Perform row dance after scrolling. We are working on the range of
2671 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2672 including) in MATRIX. COPY_FROM is a vector containing, for each
2673 row I in the range 0 <= I < NLINES, the index of the original line
2674 to move to I. This index is relative to the row range, i.e. 0 <=
2675 index < NLINES. RETAINED_P is a vector containing zero for each
2676 row 0 <= I < NLINES which is empty.
2678 This function is called from do_scrolling and do_direct_scrolling. */
2681 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2682 int *copy_from
, char *retained_p
)
2684 /* A copy of original rows. */
2685 struct glyph_row
*old_rows
;
2687 /* Rows to assign to. */
2688 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2692 /* Make a copy of the original rows. */
2694 SAFE_NALLOCA (old_rows
, 1, nlines
);
2695 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2697 /* Assign new rows, maybe clear lines. */
2698 for (i
= 0; i
< nlines
; ++i
)
2700 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2702 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2703 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2704 new_rows
[i
] = old_rows
[copy_from
[i
]];
2705 new_rows
[i
].enabled_p
= enabled_before_p
;
2707 /* RETAINED_P is zero for empty lines. */
2708 if (!retained_p
[copy_from
[i
]])
2709 new_rows
[i
].enabled_p
= false;
2712 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2713 if (frame_matrix_frame
)
2714 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2715 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2721 /* Synchronize glyph pointers in the current matrix of window W with
2722 the current frame matrix. */
2725 sync_window_with_frame_matrix_rows (struct window
*w
)
2727 struct frame
*f
= XFRAME (w
->frame
);
2728 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2729 int left
, right
, x
, width
;
2731 /* Preconditions: W must be a live window on a tty frame. */
2732 eassert (BUFFERP (w
->contents
));
2733 eassert (!FRAME_WINDOW_P (f
));
2735 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2736 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2737 x
= w
->current_matrix
->matrix_x
;
2738 width
= w
->current_matrix
->matrix_w
;
2740 window_row
= w
->current_matrix
->rows
;
2741 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2742 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2744 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2746 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2747 = frame_row
->glyphs
[0] + x
;
2748 window_row
->glyphs
[TEXT_AREA
]
2749 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2750 window_row
->glyphs
[LAST_AREA
]
2751 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2752 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2753 = window_row
->glyphs
[LAST_AREA
] - right
;
2758 /* Return the window in the window tree rooted in W containing frame
2759 row ROW. Value is null if none is found. */
2761 static struct window
*
2762 frame_row_to_window (struct window
*w
, int row
)
2764 struct window
*found
= NULL
;
2768 if (WINDOWP (w
->contents
))
2769 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2770 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2771 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2774 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2781 /* Perform a line dance in the window tree rooted at W, after
2782 scrolling a frame matrix in mirrored_line_dance.
2784 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2785 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2786 COPY_FROM is a vector containing, for each row I in the range 0 <=
2787 I < NLINES, the index of the original line to move to I. This
2788 index is relative to the row range, i.e. 0 <= index < NLINES.
2789 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2793 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2797 if (WINDOWP (w
->contents
))
2798 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2799 nlines
, copy_from
, retained_p
);
2802 /* W is a leaf window, and we are working on its current
2804 struct glyph_matrix
*m
= w
->current_matrix
;
2807 struct glyph_row
*old_rows
;
2809 /* Make a copy of the original rows of matrix m. */
2811 SAFE_NALLOCA (old_rows
, 1, m
->nrows
);
2812 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2814 for (i
= 0; i
< nlines
; ++i
)
2816 /* Frame relative line assigned to. */
2817 int frame_to
= i
+ unchanged_at_top
;
2819 /* Frame relative line assigned. */
2820 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2822 /* Window relative line assigned to. */
2823 int window_to
= frame_to
- m
->matrix_y
;
2825 /* Window relative line assigned. */
2826 int window_from
= frame_from
- m
->matrix_y
;
2828 /* Is assigned line inside window? */
2829 bool from_inside_window_p
2830 = window_from
>= 0 && window_from
< m
->matrix_h
;
2832 /* Is assigned to line inside window? */
2833 bool to_inside_window_p
2834 = window_to
>= 0 && window_to
< m
->matrix_h
;
2836 if (from_inside_window_p
&& to_inside_window_p
)
2838 /* Do the assignment. The enabled_p flag is saved
2839 over the assignment because the old redisplay did
2841 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2842 m
->rows
[window_to
] = old_rows
[window_from
];
2843 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2845 /* If frame line is empty, window line is empty, too. */
2846 if (!retained_p
[copy_from
[i
]])
2847 m
->rows
[window_to
].enabled_p
= false;
2849 else if (to_inside_window_p
)
2851 /* A copy between windows. This is an infrequent
2852 case not worth optimizing. */
2853 struct frame
*f
= XFRAME (w
->frame
);
2854 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2856 struct glyph_matrix
*m2
;
2859 w2
= frame_row_to_window (root
, frame_from
);
2860 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2861 -nw', FROM_FRAME sometimes has no associated window.
2862 This check avoids a segfault if W2 is null. */
2865 m2
= w2
->current_matrix
;
2866 m2_from
= frame_from
- m2
->matrix_y
;
2867 copy_row_except_pointers (m
->rows
+ window_to
,
2868 m2
->rows
+ m2_from
);
2870 /* If frame line is empty, window line is empty, too. */
2871 if (!retained_p
[copy_from
[i
]])
2872 m
->rows
[window_to
].enabled_p
= false;
2876 else if (from_inside_window_p
)
2880 /* If there was a copy between windows, make sure glyph
2881 pointers are in sync with the frame matrix. */
2883 sync_window_with_frame_matrix_rows (w
);
2885 /* Check that no pointers are lost. */
2891 /* Next window on same level. */
2892 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2899 /* Check that window and frame matrices agree about their
2900 understanding where glyphs of the rows are to find. For each
2901 window in the window tree rooted at W, check that rows in the
2902 matrices of leaf window agree with their frame matrices about
2906 check_window_matrix_pointers (struct window
*w
)
2910 if (WINDOWP (w
->contents
))
2911 check_window_matrix_pointers (XWINDOW (w
->contents
));
2914 struct frame
*f
= XFRAME (w
->frame
);
2915 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2916 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2919 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2924 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2925 a window and FRAME_MATRIX is the corresponding frame matrix. For
2926 each row in WINDOW_MATRIX check that it's a slice of the
2927 corresponding frame row. If it isn't, abort. */
2930 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2931 struct glyph_matrix
*frame_matrix
)
2933 /* Row number in WINDOW_MATRIX. */
2936 /* Row number corresponding to I in FRAME_MATRIX. */
2937 int j
= window_matrix
->matrix_y
;
2939 /* For all rows check that the row in the window matrix is a
2940 slice of the row in the frame matrix. If it isn't we didn't
2941 mirror an operation on the frame matrix correctly. */
2942 while (i
< window_matrix
->nrows
)
2944 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2945 frame_matrix
->rows
+ j
))
2951 #endif /* GLYPH_DEBUG */
2955 /**********************************************************************
2956 VPOS and HPOS translations
2957 **********************************************************************/
2961 /* Translate vertical position VPOS which is relative to window W to a
2962 vertical position relative to W's frame. */
2965 window_to_frame_vpos (struct window
*w
, int vpos
)
2967 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2968 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2969 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2970 eassert (vpos
>= 0 && vpos
<= FRAME_TOTAL_LINES (XFRAME (w
->frame
)));
2975 /* Translate horizontal position HPOS which is relative to window W to
2976 a horizontal position relative to W's frame. */
2979 window_to_frame_hpos (struct window
*w
, int hpos
)
2981 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2982 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2986 #endif /* GLYPH_DEBUG */
2990 /**********************************************************************
2992 **********************************************************************/
2994 /* Redraw frame F. */
2997 redraw_frame (struct frame
*f
)
2999 /* Error if F has no glyphs. */
3000 eassert (f
->glyphs_initialized_p
);
3002 if (FRAME_MSDOS_P (f
))
3003 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3005 clear_current_matrices (f
);
3007 windows_or_buffers_changed
= 13;
3008 /* Mark all windows as inaccurate, so that every window will have
3009 its redisplay done. */
3010 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3011 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), true);
3012 f
->garbaged
= false;
3015 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3016 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3017 If FRAME is omitted or nil, the selected frame is used. */)
3020 redraw_frame (decode_live_frame (frame
));
3024 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3025 doc
: /* Clear and redisplay all visible frames. */)
3028 Lisp_Object tail
, frame
;
3030 FOR_EACH_FRAME (tail
, frame
)
3031 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3032 redraw_frame (XFRAME (frame
));
3039 /***********************************************************************
3041 ***********************************************************************/
3043 /* Update frame F based on the data in desired matrices.
3045 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3046 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3048 Value is true if redisplay was stopped due to pending input. */
3051 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3053 /* True means display has been paused because of pending input. */
3055 struct window
*root_window
= XWINDOW (f
->root_window
);
3057 if (redisplay_dont_pause
)
3059 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3065 if (FRAME_WINDOW_P (f
))
3067 /* We are working on window matrix basis. All windows whose
3068 flag must_be_updated_p is set have to be updated. */
3070 /* Record that we are not working on frame matrices. */
3071 set_frame_matrix_frame (NULL
);
3073 /* Update all windows in the window tree of F, maybe stopping
3074 when pending input is detected. */
3077 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3078 /* Update the menu bar on X frames that don't have toolkit
3080 if (WINDOWP (f
->menu_bar_window
))
3081 update_window (XWINDOW (f
->menu_bar_window
), true);
3084 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3085 /* Update the tool-bar window, if present. */
3086 if (WINDOWP (f
->tool_bar_window
))
3088 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3090 /* Update tool-bar window. */
3091 if (w
->must_be_updated_p
)
3095 update_window (w
, true);
3096 w
->must_be_updated_p
= false;
3098 /* Swap tool-bar strings. We swap because we want to
3100 tem
= f
->current_tool_bar_string
;
3101 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3102 fset_desired_tool_bar_string (f
, tem
);
3107 /* Update windows. */
3108 paused_p
= update_window_tree (root_window
, force_p
);
3113 /* We are working on frame matrix basis. Set the frame on whose
3114 frame matrix we operate. */
3115 set_frame_matrix_frame (f
);
3117 /* Build F's desired matrix from window matrices. */
3118 build_frame_matrix (f
);
3120 /* Update the display. */
3122 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
, 1);
3125 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3127 if (FRAME_TTY (f
)->termscript
)
3128 fflush (FRAME_TTY (f
)->termscript
);
3129 if (FRAME_TERMCAP_P (f
))
3130 fflush (FRAME_TTY (f
)->output
);
3133 /* Check window matrices for lost pointers. */
3135 check_window_matrix_pointers (root_window
);
3136 add_frame_display_history (f
, paused_p
);
3141 /* Reset flags indicating that a window should be updated. */
3142 set_window_update_flags (root_window
, false);
3144 display_completed
= !paused_p
;
3148 /* Update a TTY frame F that has a menu dropped down over some of its
3149 glyphs. This is like the second part of update_frame, but it
3150 doesn't call build_frame_matrix, because we already have the
3151 desired matrix prepared, and don't want it to be overwritten by the
3152 text of the normal display.
3154 ROW and COL, if non-negative, are the row and column of the TTY
3155 frame where to position the cursor after the frame update is
3156 complete. Negative values mean ask update_frame_1 to position the
3157 cursor "normally", i.e. at point in the selected window. */
3159 update_frame_with_menu (struct frame
*f
, int row
, int col
)
3161 struct window
*root_window
= XWINDOW (f
->root_window
);
3162 bool paused_p
, cursor_at_point_p
;
3164 eassert (FRAME_TERMCAP_P (f
));
3166 /* We are working on frame matrix basis. Set the frame on whose
3167 frame matrix we operate. */
3168 set_frame_matrix_frame (f
);
3170 /* Update the display. */
3172 cursor_at_point_p
= !(row
>= 0 && col
>= 0);
3173 /* Force update_frame_1 not to stop due to pending input, and not
3175 paused_p
= update_frame_1 (f
, 1, 1, cursor_at_point_p
);
3176 /* ROW and COL tell us where in the menu to position the cursor, so
3177 that screen readers know the active region on the screen. */
3178 if (!cursor_at_point_p
)
3179 cursor_to (f
, row
, col
);
3182 if (FRAME_TTY (f
)->termscript
)
3183 fflush (FRAME_TTY (f
)->termscript
);
3184 fflush (FRAME_TTY (f
)->output
);
3185 /* Check window matrices for lost pointers. */
3188 /* We cannot possibly survive the matrix pointers check, since
3189 we have overwritten parts of the frame glyph matrix without
3190 making any updates to the window matrices. */
3191 check_window_matrix_pointers (root_window
);
3193 add_frame_display_history (f
, paused_p
);
3196 /* Reset flags indicating that a window should be updated. */
3197 set_window_update_flags (root_window
, false);
3198 display_completed
= !paused_p
;
3202 /************************************************************************
3203 Window-based updates
3204 ************************************************************************/
3206 /* Perform updates in window tree rooted at W.
3207 If FORCE_P, don't stop updating if input is pending. */
3210 update_window_tree (struct window
*w
, bool force_p
)
3214 while (w
&& !paused_p
)
3216 if (WINDOWP (w
->contents
))
3217 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3218 else if (w
->must_be_updated_p
)
3219 paused_p
|= update_window (w
, force_p
);
3221 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3228 /* Update window W if its flag must_be_updated_p is set.
3229 If FORCE_P, don't stop updating if input is pending. */
3232 update_single_window (struct window
*w
)
3234 if (w
->must_be_updated_p
)
3236 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3238 /* Record that this is not a frame-based redisplay. */
3239 set_frame_matrix_frame (NULL
);
3243 update_window (w
, true);
3246 /* Reset flag in W. */
3247 w
->must_be_updated_p
= false;
3251 #ifdef HAVE_WINDOW_SYSTEM
3253 /* Redraw lines from the current matrix of window W that are
3254 overlapped by other rows. YB is bottom-most y-position in W. */
3257 redraw_overlapped_rows (struct window
*w
, int yb
)
3260 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3262 /* If rows overlapping others have been changed, the rows being
3263 overlapped have to be redrawn. This won't draw lines that have
3264 already been drawn in update_window_line because overlapped_p in
3265 desired rows is 0, so after row assignment overlapped_p in
3266 current rows is 0. */
3267 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3269 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3271 if (!row
->enabled_p
)
3273 else if (row
->mode_line_p
)
3276 if (row
->overlapped_p
)
3278 enum glyph_row_area area
;
3280 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3282 output_cursor_to (w
, i
, 0, row
->y
,
3283 area
== TEXT_AREA
? row
->x
: 0);
3284 if (row
->used
[area
])
3285 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3286 area
, row
->used
[area
]);
3287 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3290 row
->overlapped_p
= 0;
3293 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3299 /* Redraw lines from the current matrix of window W that overlap
3300 others. YB is bottom-most y-position in W. */
3303 redraw_overlapping_rows (struct window
*w
, int yb
)
3306 struct glyph_row
*row
;
3307 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3309 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3311 row
= w
->current_matrix
->rows
+ i
;
3313 if (!row
->enabled_p
)
3315 else if (row
->mode_line_p
)
3318 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3320 if (row
->overlapping_p
)
3324 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3325 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3326 overlaps
|= OVERLAPS_PRED
;
3327 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3328 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3329 overlaps
|= OVERLAPS_SUCC
;
3333 if (row
->used
[LEFT_MARGIN_AREA
])
3334 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3336 if (row
->used
[TEXT_AREA
])
3337 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3339 if (row
->used
[RIGHT_MARGIN_AREA
])
3340 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3342 /* Record in neighbor rows that ROW overwrites part of
3344 if (overlaps
& OVERLAPS_PRED
)
3345 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3346 if (overlaps
& OVERLAPS_SUCC
)
3347 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3356 #endif /* HAVE_WINDOW_SYSTEM */
3359 #if defined GLYPH_DEBUG && 0
3361 /* Check that no row in the current matrix of window W is enabled
3362 which is below what's displayed in the window. */
3365 check_current_matrix_flags (struct window
*w
)
3367 bool last_seen_p
= 0;
3368 int i
, yb
= window_text_bottom_y (w
);
3370 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3372 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3373 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3375 else if (last_seen_p
&& row
->enabled_p
)
3380 #endif /* GLYPH_DEBUG */
3383 /* Update display of window W.
3384 If FORCE_P, don't stop updating when input is pending. */
3387 update_window (struct window
*w
, bool force_p
)
3389 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3391 int preempt_count
= baud_rate
/ 2400 + 1;
3392 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3394 /* Check that W's frame doesn't have glyph matrices. */
3395 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3398 /* Check pending input the first time so that we can quickly return. */
3400 detect_input_pending_ignore_squeezables ();
3402 /* If forced to complete the update, or if no input is pending, do
3404 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3406 struct glyph_row
*row
, *end
;
3407 struct glyph_row
*mode_line_row
;
3408 struct glyph_row
*header_line_row
;
3410 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3413 rif
->update_window_begin_hook (w
);
3414 yb
= window_text_bottom_y (w
);
3415 row
= MATRIX_ROW (desired_matrix
, 0);
3416 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3418 /* Take note of the header line, if there is one. We will
3419 update it below, after updating all of the window's lines. */
3420 if (row
->mode_line_p
)
3422 header_line_row
= row
;
3426 header_line_row
= NULL
;
3428 /* Update the mode line, if necessary. */
3429 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3430 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3432 mode_line_row
->y
= yb
+ WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
3433 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3435 &mouse_face_overwritten_p
);
3438 /* Find first enabled row. Optimizations in redisplay_internal
3439 may lead to an update with only one row enabled. There may
3440 be also completely empty matrices. */
3441 while (row
< end
&& !row
->enabled_p
)
3444 /* Try reusing part of the display by copying. */
3445 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3447 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3450 /* All rows were found to be equal. */
3456 /* We've scrolled the display. */
3462 /* Update the rest of the lines. */
3463 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3464 /* scrolling_window resets the enabled_p flag of the rows it
3465 reuses from current_matrix. */
3468 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3471 /* We'll have to play a little bit with when to
3472 detect_input_pending. If it's done too often,
3473 scrolling large windows with repeated scroll-up
3474 commands will too quickly pause redisplay. */
3475 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3476 detect_input_pending_ignore_squeezables ();
3477 changed_p
|= update_window_line (w
, vpos
,
3478 &mouse_face_overwritten_p
);
3480 /* Mark all rows below the last visible one in the current
3481 matrix as invalid. This is necessary because of
3482 variable line heights. Consider the case of three
3483 successive redisplays, where the first displays 5
3484 lines, the second 3 lines, and the third 5 lines again.
3485 If the second redisplay wouldn't mark rows in the
3486 current matrix invalid, the third redisplay might be
3487 tempted to optimize redisplay based on lines displayed
3488 in the first redisplay. */
3489 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3490 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3491 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, i
, false);
3494 /* Was display preempted? */
3495 paused_p
= row
< end
;
3499 /* Update the header line after scrolling because a new header
3500 line would otherwise overwrite lines at the top of the window
3501 that can be scrolled. */
3502 if (header_line_row
&& header_line_row
->enabled_p
)
3504 header_line_row
->y
= 0;
3505 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3508 /* Fix the appearance of overlapping/overlapped rows. */
3509 if (!paused_p
&& !w
->pseudo_window_p
)
3511 #ifdef HAVE_WINDOW_SYSTEM
3512 if (changed_p
&& rif
->fix_overlapping_area
)
3514 redraw_overlapped_rows (w
, yb
);
3515 redraw_overlapping_rows (w
, yb
);
3519 /* Make cursor visible at cursor position of W. */
3520 set_window_cursor_after_update (w
);
3522 #if 0 /* Check that current matrix invariants are satisfied. This is
3523 for debugging only. See the comment of check_matrix_invariants. */
3524 IF_DEBUG (check_matrix_invariants (w
));
3529 /* Remember the redisplay method used to display the matrix. */
3530 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3533 #ifdef HAVE_WINDOW_SYSTEM
3534 update_window_fringes (w
, 0);
3537 /* End the update of window W. Don't set the cursor if we
3538 paused updating the display because in this case,
3539 set_window_cursor_after_update hasn't been called, and
3540 W->output_cursor doesn't contain the cursor location. */
3541 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3547 /* check_current_matrix_flags (w); */
3548 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3551 #ifdef HAVE_XWIDGETS
3552 xwidget_end_redisplay(w
, w
->current_matrix
);
3554 clear_glyph_matrix (desired_matrix
);
3560 /* Update the display of area AREA in window W, row number VPOS.
3561 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3564 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3565 enum glyph_row_area area
, int vpos
)
3567 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3568 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3570 /* Set cursor to start of glyphs, write them, and clear to the end
3571 of the area. I don't think that something more sophisticated is
3572 necessary here, since marginal areas will not be the default. */
3573 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3574 if (desired_row
->used
[area
])
3575 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3576 area
, desired_row
->used
[area
]);
3577 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3581 /* Update the display of the text area of row VPOS in window W.
3582 Value is true if display has changed. */
3585 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3587 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3588 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3589 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3592 /* If rows are at different X or Y, or rows have different height,
3593 or the current row is marked invalid, write the entire line. */
3594 if (!current_row
->enabled_p
3595 || desired_row
->y
!= current_row
->y
3596 || desired_row
->ascent
!= current_row
->ascent
3597 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3598 || desired_row
->phys_height
!= current_row
->phys_height
3599 || desired_row
->visible_height
!= current_row
->visible_height
3600 || current_row
->overlapped_p
3601 /* This next line is necessary for correctly redrawing
3602 mouse-face areas after scrolling and other operations.
3603 However, it causes excessive flickering when mouse is moved
3604 across the mode line. Luckily, turning it off for the mode
3605 line doesn't seem to hurt anything. -- cyd.
3606 But it is still needed for the header line. -- kfs. */
3607 || (current_row
->mouse_face_p
3608 && !(current_row
->mode_line_p
&& vpos
> 0))
3609 || current_row
->x
!= desired_row
->x
)
3611 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3613 if (desired_row
->used
[TEXT_AREA
])
3614 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3615 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3617 /* Clear to end of window. */
3618 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3621 /* This erases the cursor. We do this here because
3622 notice_overwritten_cursor cannot easily check this, which
3623 might indicate that the whole functionality of
3624 notice_overwritten_cursor would better be implemented here.
3625 On the other hand, we need notice_overwritten_cursor as long
3626 as mouse highlighting is done asynchronously outside of
3628 if (vpos
== w
->phys_cursor
.vpos
)
3629 w
->phys_cursor_on_p
= 0;
3634 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3635 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3636 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3637 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3638 bool abort_skipping
= 0;
3640 /* If the desired row extends its face to the text area end, and
3641 unless the current row also does so at the same position,
3642 make sure we write at least one glyph, so that the face
3643 extension actually takes place. */
3644 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3645 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3646 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3647 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3650 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3654 /* Loop over glyphs that current and desired row may have
3658 bool can_skip_p
= !abort_skipping
;
3660 /* Skip over glyphs that both rows have in common. These
3661 don't have to be written. We can't skip if the last
3662 current glyph overlaps the glyph to its right. For
3663 example, consider a current row of `if ' with the `f' in
3664 Courier bold so that it overlaps the ` ' to its right.
3665 If the desired row is ` ', we would skip over the space
3666 after the `if' and there would remain a pixel from the
3667 `f' on the screen. */
3668 if (overlapping_glyphs_p
&& i
> 0)
3670 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3673 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3675 can_skip_p
= (right
== 0 && !abort_skipping
);
3683 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3685 x
+= desired_glyph
->pixel_width
;
3686 ++desired_glyph
, ++current_glyph
, ++i
;
3689 /* Consider the case that the current row contains "xxx
3690 ppp ggg" in italic Courier font, and the desired row
3691 is "xxx ggg". The character `p' has lbearing, `g'
3692 has not. The loop above will stop in front of the
3693 first `p' in the current row. If we would start
3694 writing glyphs there, we wouldn't erase the lbearing
3695 of the `p'. The rest of the lbearing problem is then
3696 taken care of by draw_glyphs. */
3697 if (overlapping_glyphs_p
3699 && i
< current_row
->used
[TEXT_AREA
]
3700 && (current_row
->used
[TEXT_AREA
]
3701 != desired_row
->used
[TEXT_AREA
]))
3705 rif
->get_glyph_overhangs (current_glyph
,
3708 while (left
> 0 && i
> 0)
3710 --i
, --desired_glyph
, --current_glyph
;
3711 x
-= desired_glyph
->pixel_width
;
3712 left
-= desired_glyph
->pixel_width
;
3715 /* Abort the skipping algorithm if we end up before
3716 our starting point, to avoid looping (bug#1070).
3717 This can happen when the lbearing is larger than
3719 abort_skipping
= (i
< start_hpos
);
3723 /* Try to avoid writing the entire rest of the desired row
3724 by looking for a resync point. This mainly prevents
3725 mode line flickering in the case the mode line is in
3726 fixed-pitch font, which it usually will be. */
3727 if (i
< desired_row
->used
[TEXT_AREA
])
3729 int start_x
= x
, start_hpos
= i
;
3730 struct glyph
*start
= desired_glyph
;
3732 bool skip_first_p
= !can_skip_p
;
3734 /* Find the next glyph that's equal again. */
3737 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3740 x
+= desired_glyph
->pixel_width
;
3741 current_x
+= current_glyph
->pixel_width
;
3742 ++desired_glyph
, ++current_glyph
, ++i
;
3746 if (i
== start_hpos
|| x
!= current_x
)
3750 desired_glyph
= start
;
3754 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3755 rif
->write_glyphs (w
, updated_row
, start
,
3756 TEXT_AREA
, i
- start_hpos
);
3761 /* Write the rest. */
3762 if (i
< desired_row
->used
[TEXT_AREA
])
3764 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3765 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3766 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3770 /* Maybe clear to end of line. */
3771 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3773 /* If new row extends to the end of the text area, nothing
3774 has to be cleared, if and only if we did a write_glyphs
3775 above. This is made sure by setting desired_stop_pos
3776 appropriately above. */
3777 eassert (i
< desired_row
->used
[TEXT_AREA
]
3778 || ((desired_row
->used
[TEXT_AREA
]
3779 == current_row
->used
[TEXT_AREA
])
3780 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3782 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3784 /* If old row extends to the end of the text area, clear. */
3785 if (i
>= desired_row
->used
[TEXT_AREA
])
3786 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3787 desired_row
->pixel_width
);
3788 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3791 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3793 /* Otherwise clear to the end of the old row. Everything
3794 after that position should be clear already. */
3797 if (i
>= desired_row
->used
[TEXT_AREA
])
3798 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3799 desired_row
->pixel_width
);
3801 /* If cursor is displayed at the end of the line, make sure
3802 it's cleared. Nowadays we don't have a phys_cursor_glyph
3803 with which to erase the cursor (because this method
3804 doesn't work with lbearing/rbearing), so we must do it
3806 if (vpos
== w
->phys_cursor
.vpos
3807 && (desired_row
->reversed_p
3808 ? (w
->phys_cursor
.hpos
< 0)
3809 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3811 w
->phys_cursor_on_p
= 0;
3815 xlim
= current_row
->pixel_width
;
3816 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3825 /* Update row VPOS in window W. Value is true if display has been changed. */
3828 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3830 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3831 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3832 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3835 /* A row can be completely invisible in case a desired matrix was
3836 built with a vscroll and then make_cursor_line_fully_visible shifts
3837 the matrix. Make sure to make such rows current anyway, since
3838 we need the correct y-position, for example, in the current matrix. */
3839 if (desired_row
->mode_line_p
3840 || desired_row
->visible_height
> 0)
3842 eassert (desired_row
->enabled_p
);
3844 /* Update display of the left margin area, if there is one. */
3845 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3848 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3849 /* Setting this flag will ensure the vertical border, if
3850 any, between this window and the one on its left will be
3851 redrawn. This is necessary because updating the left
3852 margin area can potentially draw over the border. */
3853 current_row
->redraw_fringe_bitmaps_p
= 1;
3856 /* Update the display of the text area. */
3857 if (update_text_area (w
, desired_row
, vpos
))
3860 if (current_row
->mouse_face_p
)
3861 *mouse_face_overwritten_p
= 1;
3864 /* Update display of the right margin area, if there is one. */
3865 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3868 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3871 /* Draw truncation marks etc. */
3872 if (!current_row
->enabled_p
3873 || desired_row
->y
!= current_row
->y
3874 || desired_row
->visible_height
!= current_row
->visible_height
3875 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3876 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3877 || current_row
->redraw_fringe_bitmaps_p
3878 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3879 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3880 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3881 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3882 rif
->after_update_window_line_hook (w
, desired_row
);
3885 /* Update current_row from desired_row. */
3886 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3891 /* Set the cursor after an update of window W. This function may only
3892 be called from update_window. */
3895 set_window_cursor_after_update (struct window
*w
)
3897 struct frame
*f
= XFRAME (w
->frame
);
3898 int cx
, cy
, vpos
, hpos
;
3900 /* Not intended for frame matrix updates. */
3901 eassert (FRAME_WINDOW_P (f
));
3903 if (cursor_in_echo_area
3904 && !NILP (echo_area_buffer
[0])
3905 /* If we are showing a message instead of the mini-buffer,
3906 show the cursor for the message instead. */
3907 && XWINDOW (minibuf_window
) == w
3908 && EQ (minibuf_window
, echo_area_window
)
3909 /* These cases apply only to the frame that contains
3910 the active mini-buffer window. */
3911 && FRAME_HAS_MINIBUF_P (f
)
3912 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3914 cx
= cy
= vpos
= hpos
= 0;
3916 if (cursor_in_echo_area
>= 0)
3918 /* If the mini-buffer is several lines high, find the last
3919 line that has any text on it. Note: either all lines
3920 are enabled or none. Otherwise we wouldn't be able to
3922 struct glyph_row
*row
, *last_row
;
3923 struct glyph
*glyph
;
3924 int yb
= window_text_bottom_y (w
);
3927 row
= w
->current_matrix
->rows
;
3928 while (row
->enabled_p
3929 && (last_row
== NULL
3930 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3932 if (row
->used
[TEXT_AREA
]
3933 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3940 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3941 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3943 while (last
> start
&& last
->charpos
< 0)
3946 for (glyph
= start
; glyph
< last
; ++glyph
)
3948 cx
+= glyph
->pixel_width
;
3953 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3961 hpos
= w
->cursor
.hpos
;
3962 vpos
= w
->cursor
.vpos
;
3965 /* Window cursor can be out of sync for horizontally split windows.
3966 Horizontal position is -1 when cursor is on the left fringe. */
3967 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3968 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3969 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3973 /* Set WINDOW->must_be_updated_p to ON_P for all windows in
3974 the window tree rooted at W. */
3977 set_window_update_flags (struct window
*w
, bool on_p
)
3981 if (WINDOWP (w
->contents
))
3982 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3984 w
->must_be_updated_p
= on_p
;
3986 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3992 /***********************************************************************
3993 Window-Based Scrolling
3994 ***********************************************************************/
3996 /* Structure describing rows in scrolling_window. */
4000 /* Number of occurrences of this row in desired and current matrix. */
4001 int old_uses
, new_uses
;
4003 /* Vpos of row in new matrix. */
4004 int new_line_number
;
4006 /* Bucket index of this row_entry in the hash table row_table. */
4009 /* The row described by this entry. */
4010 struct glyph_row
*row
;
4012 /* Hash collision chain. */
4013 struct row_entry
*next
;
4016 /* A pool to allocate row_entry structures from, and the size of the
4017 pool. The pool is reallocated in scrolling_window when we find
4018 that we need a larger one. */
4020 static struct row_entry
*row_entry_pool
;
4021 static ptrdiff_t row_entry_pool_size
;
4023 /* Index of next free entry in row_entry_pool. */
4025 static ptrdiff_t row_entry_idx
;
4027 /* The hash table used during scrolling, and the table's size. This
4028 table is used to quickly identify equal rows in the desired and
4031 static struct row_entry
**row_table
;
4032 static ptrdiff_t row_table_size
;
4034 /* Vectors of pointers to row_entry structures belonging to the
4035 current and desired matrix, and the size of the vectors. */
4037 static struct row_entry
**old_lines
, **new_lines
;
4038 static ptrdiff_t old_lines_size
, new_lines_size
;
4040 /* A pool to allocate run structures from, and its size. */
4042 static struct run
*run_pool
;
4043 static ptrdiff_t runs_size
;
4045 /* A vector of runs of lines found during scrolling. */
4047 static struct run
**runs
;
4049 /* Add glyph row ROW to the scrolling hash table. */
4051 static struct row_entry
*
4052 add_row_entry (struct glyph_row
*row
)
4054 struct row_entry
*entry
;
4055 ptrdiff_t i
= row
->hash
% row_table_size
;
4057 entry
= row_table
[i
];
4058 eassert (entry
|| verify_row_hash (row
));
4059 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4060 entry
= entry
->next
;
4064 entry
= row_entry_pool
+ row_entry_idx
++;
4066 entry
->old_uses
= entry
->new_uses
= 0;
4067 entry
->new_line_number
= 0;
4069 entry
->next
= row_table
[i
];
4070 row_table
[i
] = entry
;
4077 /* Try to reuse part of the current display of W by scrolling lines.
4078 HEADER_LINE_P means W has a header line.
4080 The algorithm is taken from Communications of the ACM, Apr78 "A
4081 Technique for Isolating Differences Between Files." It should take
4084 A short outline of the steps of the algorithm
4086 1. Skip lines equal at the start and end of both matrices.
4088 2. Enter rows in the current and desired matrix into a symbol
4089 table, counting how often they appear in both matrices.
4091 3. Rows that appear exactly once in both matrices serve as anchors,
4092 i.e. we assume that such lines are likely to have been moved.
4094 4. Starting from anchor lines, extend regions to be scrolled both
4095 forward and backward.
4099 -1 if all rows were found to be equal.
4100 0 to indicate that we did not scroll the display, or
4101 1 if we did scroll. */
4104 scrolling_window (struct window
*w
, bool header_line_p
)
4106 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4107 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4108 int yb
= window_text_bottom_y (w
);
4110 int j
, first_old
, first_new
, last_old
, last_new
;
4113 struct row_entry
*entry
;
4114 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4116 /* Skip over rows equal at the start. */
4117 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4119 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4120 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4124 && !d
->redraw_fringe_bitmaps_p
4126 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4127 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4128 && row_equal_p (c
, d
, 1))
4131 d
->enabled_p
= false;
4137 #ifdef HAVE_XWIDGETS
4138 //currently this is needed to detect xwidget movement reliably. or probably not.
4139 //printf("scrolling_window\n");
4143 /* Give up if some rows in the desired matrix are not enabled. */
4144 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4147 first_old
= first_new
= i
;
4149 /* Set last_new to the index + 1 of the row that reaches the
4150 bottom boundary in the desired matrix. Give up if we find a
4151 disabled row before we reach the bottom boundary. */
4153 while (i
< desired_matrix
->nrows
- 1)
4157 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4159 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4168 /* Set last_old to the index + 1 of the row that reaches the bottom
4169 boundary in the current matrix. We don't look at the enabled
4170 flag here because we plan to reuse part of the display even if
4171 other parts are disabled. */
4173 while (i
< current_matrix
->nrows
- 1)
4175 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4184 /* Skip over rows equal at the bottom. */
4187 while (i
- 1 > first_new
4188 && j
- 1 > first_old
4189 && MATRIX_ROW_ENABLED_P (current_matrix
, j
- 1)
4190 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4191 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4192 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4193 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4194 MATRIX_ROW (current_matrix
, j
- 1), 1))
4199 /* Nothing to do if all rows are equal. */
4200 if (last_new
== first_new
)
4203 /* Check for integer overflow in size calculation.
4205 If next_almost_prime checks (N) for divisibility by 2..10, then
4206 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4207 So, set next_almost_prime_increment_max to 10.
4209 It's just a coincidence that next_almost_prime_increment_max ==
4210 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4211 13, then next_almost_prime_increment_max would be 14, e.g.,
4212 because next_almost_prime (113) would be 127. */
4214 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4215 enum { next_almost_prime_increment_max
= 10 };
4216 ptrdiff_t row_table_max
=
4217 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4218 - next_almost_prime_increment_max
);
4219 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4220 if (current_nrows_max
< current_matrix
->nrows
)
4221 memory_full (SIZE_MAX
);
4224 /* Reallocate vectors, tables etc. if necessary. */
4226 if (current_matrix
->nrows
> old_lines_size
)
4227 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4228 current_matrix
->nrows
- old_lines_size
,
4229 INT_MAX
, sizeof *old_lines
);
4231 if (desired_matrix
->nrows
> new_lines_size
)
4232 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4233 desired_matrix
->nrows
- new_lines_size
,
4234 INT_MAX
, sizeof *new_lines
);
4236 n
= desired_matrix
->nrows
;
4237 n
+= current_matrix
->nrows
;
4238 if (row_table_size
< 3 * n
)
4240 ptrdiff_t size
= next_almost_prime (3 * n
);
4241 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4242 row_table_size
= size
;
4243 memset (row_table
, 0, size
* sizeof *row_table
);
4246 if (n
> row_entry_pool_size
)
4247 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4248 n
- row_entry_pool_size
,
4249 -1, sizeof *row_entry_pool
);
4251 if (desired_matrix
->nrows
> runs_size
)
4253 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4254 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4255 runs_size
= desired_matrix
->nrows
;
4258 nruns
= run_idx
= 0;
4261 /* Add rows from the current and desired matrix to the hash table
4262 row_hash_table to be able to find equal ones quickly. */
4264 for (i
= first_old
; i
< last_old
; ++i
)
4266 if (MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4268 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4269 old_lines
[i
] = entry
;
4273 old_lines
[i
] = NULL
;
4276 for (i
= first_new
; i
< last_new
; ++i
)
4278 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4279 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4281 entry
->new_line_number
= i
;
4282 new_lines
[i
] = entry
;
4285 /* Identify moves based on lines that are unique and equal
4286 in both matrices. */
4287 for (i
= first_old
; i
< last_old
;)
4289 && old_lines
[i
]->old_uses
== 1
4290 && old_lines
[i
]->new_uses
== 1)
4293 int new_line
= old_lines
[i
]->new_line_number
;
4294 struct run
*run
= run_pool
+ run_idx
++;
4297 run
->current_vpos
= i
;
4298 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4299 run
->desired_vpos
= new_line
;
4300 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4302 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4304 /* Extend backward. */
4307 while (p
> first_old
4309 && old_lines
[p
] == new_lines
[q
])
4311 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4312 --run
->current_vpos
;
4313 --run
->desired_vpos
;
4316 run
->desired_y
-= h
;
4317 run
->current_y
-= h
;
4321 /* Extend forward. */
4326 && old_lines
[p
] == new_lines
[q
])
4328 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4334 /* Insert run into list of all runs. Order runs by copied
4335 pixel lines. Note that we record runs that don't have to
4336 be copied because they are already in place. This is done
4337 because we can avoid calling update_window_line in this
4339 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4341 for (q
= nruns
; q
> p
; --q
)
4342 runs
[q
] = runs
[q
- 1];
4351 /* Do the moves. Do it in a way that we don't overwrite something
4352 we want to copy later on. This is not solvable in general
4353 because there is only one display and we don't have a way to
4354 exchange areas on this display. Example:
4356 +-----------+ +-----------+
4358 +-----------+ --> +-----------+
4360 +-----------+ +-----------+
4362 Instead, prefer bigger moves, and invalidate moves that would
4363 copy from where we copied to. */
4365 for (i
= 0; i
< nruns
; ++i
)
4366 if (runs
[i
]->nrows
> 0)
4368 struct run
*r
= runs
[i
];
4370 /* Copy on the display. */
4371 if (r
->current_y
!= r
->desired_y
)
4373 rif
->clear_window_mouse_face (w
);
4374 rif
->scroll_run_hook (w
, r
);
4377 /* Truncate runs that copy to where we copied to, and
4378 invalidate runs that copy from where we copied to. */
4379 for (j
= nruns
- 1; j
> i
; --j
)
4381 struct run
*p
= runs
[j
];
4382 bool truncated_p
= 0;
4385 && p
->desired_y
< r
->desired_y
+ r
->height
4386 && p
->desired_y
+ p
->height
> r
->desired_y
)
4388 if (p
->desired_y
< r
->desired_y
)
4390 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4391 p
->height
= r
->desired_y
- p
->desired_y
;
4396 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4399 if (p
->nrows
<= nrows_copied
)
4403 int height_copied
= (r
->desired_y
+ r
->height
4406 p
->current_vpos
+= nrows_copied
;
4407 p
->desired_vpos
+= nrows_copied
;
4408 p
->nrows
-= nrows_copied
;
4409 p
->current_y
+= height_copied
;
4410 p
->desired_y
+= height_copied
;
4411 p
->height
-= height_copied
;
4417 if (r
->current_y
!= r
->desired_y
4418 /* The condition below is equivalent to
4419 ((p->current_y >= r->desired_y
4420 && p->current_y < r->desired_y + r->height)
4421 || (p->current_y + p->height > r->desired_y
4422 && (p->current_y + p->height
4423 <= r->desired_y + r->height)))
4424 because we have 0 < p->height <= r->height. */
4425 && p
->current_y
< r
->desired_y
+ r
->height
4426 && p
->current_y
+ p
->height
> r
->desired_y
)
4429 /* Reorder runs by copied pixel lines if truncated. */
4430 if (truncated_p
&& p
->nrows
> 0)
4434 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4436 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4441 /* Assign matrix rows. */
4442 for (j
= 0; j
< r
->nrows
; ++j
)
4444 struct glyph_row
*from
, *to
;
4445 bool to_overlapped_p
;
4447 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4448 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4449 to_overlapped_p
= to
->overlapped_p
;
4450 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4451 assign_row (to
, from
);
4452 /* The above `assign_row' actually does swap, so if we had
4453 an overlap in the copy destination of two runs, then
4454 the second run would assign a previously disabled bogus
4455 row. But thanks to the truncation code in the
4456 preceding for-loop, we no longer have such an overlap,
4457 and thus the assigned row should always be enabled. */
4458 eassert (to
->enabled_p
);
4459 from
->enabled_p
= false;
4460 to
->overlapped_p
= to_overlapped_p
;
4464 /* Clear the hash table, for the next time. */
4465 for (i
= 0; i
< row_entry_idx
; ++i
)
4466 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4468 /* Value is 1 to indicate that we scrolled the display. */
4474 /************************************************************************
4476 ************************************************************************/
4478 /* Update the desired frame matrix of frame F.
4480 FORCE_P means that the update should not be stopped by pending input.
4481 INHIBIT_ID_P means that scrolling by insert/delete should not be tried.
4482 SET_CURSOR_P false means do not set cursor at point in selected window.
4484 Value is true if update was stopped due to pending input. */
4487 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
,
4490 /* Frame matrices to work on. */
4491 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4492 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4495 int preempt_count
= baud_rate
/ 2400 + 1;
4497 eassert (current_matrix
&& desired_matrix
);
4499 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4500 calculate_costs (f
);
4502 if (preempt_count
<= 0)
4505 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4511 /* If we cannot insert/delete lines, it's no use trying it. */
4512 if (!FRAME_LINE_INS_DEL_OK (f
))
4515 /* See if any of the desired lines are enabled; don't compute for
4516 i/d line if just want cursor motion. */
4517 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4518 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4521 /* Try doing i/d line, if not yet inhibited. */
4522 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4523 force_p
|= scrolling (f
);
4525 /* Update the individual lines as needed. Do bottom line first. */
4526 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4527 update_frame_line (f
, desired_matrix
->nrows
- 1);
4529 /* Now update the rest of the lines. */
4530 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4532 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4534 if (FRAME_TERMCAP_P (f
))
4536 /* Flush out every so many lines.
4537 Also flush out if likely to have more than 1k buffered
4538 otherwise. I'm told that some telnet connections get
4539 really screwed by more than 1k output at once. */
4540 FILE *display_output
= FRAME_TTY (f
)->output
;
4543 ptrdiff_t outq
= __fpending (display_output
);
4545 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4546 fflush (display_output
);
4550 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4551 detect_input_pending_ignore_squeezables ();
4553 update_frame_line (f
, i
);
4557 pause_p
= 0 < i
&& i
< FRAME_TOTAL_LINES (f
) - 1;
4559 /* Now just clean up termcap drivers and set cursor, etc. */
4560 if (!pause_p
&& set_cursor_p
)
4562 if ((cursor_in_echo_area
4563 /* If we are showing a message instead of the mini-buffer,
4564 show the cursor for the message instead of for the
4565 (now hidden) mini-buffer contents. */
4566 || (EQ (minibuf_window
, selected_window
)
4567 && EQ (minibuf_window
, echo_area_window
)
4568 && !NILP (echo_area_buffer
[0])))
4569 /* These cases apply only to the frame that contains
4570 the active mini-buffer window. */
4571 && FRAME_HAS_MINIBUF_P (f
)
4572 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4574 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4577 if (cursor_in_echo_area
< 0)
4579 /* Negative value of cursor_in_echo_area means put
4580 cursor at beginning of line. */
4586 /* Positive value of cursor_in_echo_area means put
4587 cursor at the end of the prompt. If the mini-buffer
4588 is several lines high, find the last line that has
4590 row
= FRAME_TOTAL_LINES (f
);
4596 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4598 /* Frame rows are filled up with spaces that
4599 must be ignored here. */
4600 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4602 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4603 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4606 && (last
- 1)->charpos
< 0)
4612 while (row
> top
&& col
== 0);
4614 /* Make sure COL is not out of range. */
4615 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4617 /* If we have another row, advance cursor into it. */
4618 if (row
< FRAME_TOTAL_LINES (f
) - 1)
4620 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4623 /* Otherwise move it back in range. */
4625 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4629 cursor_to (f
, row
, col
);
4633 /* We have only one cursor on terminal frames. Use it to
4634 display the cursor of the selected window. */
4635 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4636 if (w
->cursor
.vpos
>= 0
4637 /* The cursor vpos may be temporarily out of bounds
4638 in the following situation: There is one window,
4639 with the cursor in the lower half of it. The window
4640 is split, and a message causes a redisplay before
4641 a new cursor position has been computed. */
4642 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4644 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4645 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4647 x
+= max (0, w
->left_margin_cols
);
4648 cursor_to (f
, y
, x
);
4655 clear_desired_matrices (f
);
4660 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4663 scrolling (struct frame
*frame
)
4665 int unchanged_at_top
, unchanged_at_bottom
;
4669 int height
= FRAME_TOTAL_LINES (frame
);
4670 int free_at_end_vpos
= height
;
4671 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4672 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4673 verify (sizeof (int) <= sizeof (unsigned));
4674 verify (alignof (unsigned) % alignof (int) == 0);
4677 SAFE_NALLOCA (old_hash
, 4, height
);
4678 unsigned *new_hash
= old_hash
+ height
;
4679 int *draw_cost
= (int *) (new_hash
+ height
);
4680 int *old_draw_cost
= draw_cost
+ height
;
4682 eassert (current_matrix
);
4684 /* Compute hash codes of all the lines. Also calculate number of
4685 changed lines, number of unchanged lines at the beginning, and
4686 number of unchanged lines at the end. */
4688 unchanged_at_top
= 0;
4689 unchanged_at_bottom
= height
;
4690 for (i
= 0; i
< height
; i
++)
4692 /* Give up on this scrolling if some old lines are not enabled. */
4693 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4698 old_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (current_matrix
, i
));
4699 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4701 /* This line cannot be redrawn, so don't let scrolling mess it. */
4702 new_hash
[i
] = old_hash
[i
];
4703 #define INFINITY 1000000 /* Taken from scroll.c */
4704 draw_cost
[i
] = INFINITY
;
4708 new_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (desired_matrix
, i
));
4709 draw_cost
[i
] = line_draw_cost (frame
, desired_matrix
, i
);
4712 if (old_hash
[i
] != new_hash
[i
])
4715 unchanged_at_bottom
= height
- i
- 1;
4717 else if (i
== unchanged_at_top
)
4719 old_draw_cost
[i
] = line_draw_cost (frame
, current_matrix
, i
);
4722 /* If changed lines are few, don't allow preemption, don't scroll. */
4723 if ((!FRAME_SCROLL_REGION_OK (frame
)
4724 && changed_lines
< baud_rate
/ 2400)
4725 || unchanged_at_bottom
== height
)
4731 window_size
= (height
- unchanged_at_top
4732 - unchanged_at_bottom
);
4734 if (FRAME_SCROLL_REGION_OK (frame
))
4735 free_at_end_vpos
-= unchanged_at_bottom
;
4736 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4737 free_at_end_vpos
= -1;
4739 /* Do id/calc only if small window, or slow terminal, or many lines
4740 in common between current frame and desired frame. But the
4741 window size must be at least 2. */
4742 if ((FRAME_SCROLL_REGION_OK (frame
)
4743 || window_size
< 18 || baud_rate
<= 2400
4745 < 10 * scrolling_max_lines_saved (unchanged_at_top
,
4746 height
- unchanged_at_bottom
,
4747 old_hash
, new_hash
, draw_cost
)))
4748 && 2 <= window_size
)
4749 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4750 draw_cost
+ unchanged_at_top
- 1,
4751 old_draw_cost
+ unchanged_at_top
- 1,
4752 old_hash
+ unchanged_at_top
- 1,
4753 new_hash
+ unchanged_at_top
- 1,
4754 free_at_end_vpos
- unchanged_at_top
);
4761 /* Count the number of blanks at the start of the vector of glyphs R
4762 which is LEN glyphs long. */
4765 count_blanks (struct glyph
*r
, int len
)
4769 for (i
= 0; i
< len
; ++i
)
4770 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4777 /* Count the number of glyphs in common at the start of the glyph
4778 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4779 of STR2. Value is the number of equal glyphs equal at the start. */
4782 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4784 struct glyph
*p1
= str1
;
4785 struct glyph
*p2
= str2
;
4789 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4796 /* Char insertion/deletion cost vector, from term.c */
4798 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4801 /* Perform a frame-based update on line VPOS in frame FRAME. */
4804 update_frame_line (struct frame
*f
, int vpos
)
4806 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4808 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4809 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4810 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4811 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4812 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4813 bool must_write_whole_line_p
;
4814 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4815 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4816 != FACE_TTY_DEFAULT_BG_COLOR
);
4818 if (colored_spaces_p
)
4821 /* Current row not enabled means it has unknown contents. We must
4822 write the whole desired line in that case. */
4823 must_write_whole_line_p
= !current_row
->enabled_p
;
4824 if (must_write_whole_line_p
)
4831 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4832 olen
= current_row
->used
[TEXT_AREA
];
4834 /* Ignore trailing spaces, if we can. */
4835 if (!write_spaces_p
)
4836 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4840 current_row
->enabled_p
= true;
4841 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4843 /* If desired line is empty, just clear the line. */
4844 if (!desired_row
->enabled_p
)
4850 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4851 nlen
= desired_row
->used
[TEXT_AREA
];
4852 nend
= nbody
+ nlen
;
4854 /* If display line has unknown contents, write the whole line. */
4855 if (must_write_whole_line_p
)
4857 /* Ignore spaces at the end, if we can. */
4858 if (!write_spaces_p
)
4859 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4862 /* Write the contents of the desired line. */
4865 cursor_to (f
, vpos
, 0);
4866 write_glyphs (f
, nbody
, nlen
);
4869 /* Don't call clear_end_of_line if we already wrote the whole
4870 line. The cursor will not be at the right margin in that
4871 case but in the line below. */
4872 if (nlen
< FRAME_TOTAL_COLS (f
))
4874 cursor_to (f
, vpos
, nlen
);
4875 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4878 /* Make sure we are in the right row, otherwise cursor movement
4879 with cmgoto might use `ch' in the wrong row. */
4880 cursor_to (f
, vpos
, 0);
4882 make_current (desired_matrix
, current_matrix
, vpos
);
4886 /* Pretend trailing spaces are not there at all,
4887 unless for one reason or another we must write all spaces. */
4888 if (!write_spaces_p
)
4889 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4892 /* If there's no i/d char, quickly do the best we can without it. */
4893 if (!FRAME_CHAR_INS_DEL_OK (f
))
4897 /* Find the first glyph in desired row that doesn't agree with
4898 a glyph in the current row, and write the rest from there on. */
4899 for (i
= 0; i
< nlen
; i
++)
4901 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4903 /* Find the end of the run of different glyphs. */
4907 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4908 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4911 /* Output this run of non-matching chars. */
4912 cursor_to (f
, vpos
, i
);
4913 write_glyphs (f
, nbody
+ i
, j
- i
);
4916 /* Now find the next non-match. */
4920 /* Clear the rest of the line, or the non-clear part of it. */
4923 cursor_to (f
, vpos
, nlen
);
4924 clear_end_of_line (f
, olen
);
4927 /* Make current row = desired row. */
4928 make_current (desired_matrix
, current_matrix
, vpos
);
4932 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4933 characters in a row. */
4937 /* If current line is blank, skip over initial spaces, if
4938 possible, and write the rest. */
4942 nsp
= count_blanks (nbody
, nlen
);
4946 cursor_to (f
, vpos
, nsp
);
4947 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4950 /* Exchange contents between current_frame and new_frame. */
4951 make_current (desired_matrix
, current_matrix
, vpos
);
4955 /* Compute number of leading blanks in old and new contents. */
4956 osp
= count_blanks (obody
, olen
);
4957 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4959 /* Compute number of matching chars starting with first non-blank. */
4960 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4961 nbody
+ nsp
, nbody
+ nlen
);
4963 /* Spaces in new match implicit space past the end of old. */
4964 /* A bug causing this to be a no-op was fixed in 18.29. */
4965 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4968 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4972 /* Avoid doing insert/delete char
4973 just cause number of leading spaces differs
4974 when the following text does not match. */
4975 if (begmatch
== 0 && osp
!= nsp
)
4976 osp
= nsp
= min (osp
, nsp
);
4978 /* Find matching characters at end of line */
4981 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4983 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4988 endmatch
= obody
+ olen
- op1
;
4990 /* tem gets the distance to insert or delete.
4991 endmatch is how many characters we save by doing so.
4994 tem
= (nlen
- nsp
) - (olen
- osp
);
4996 && (!FRAME_CHAR_INS_DEL_OK (f
)
4997 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5000 /* nsp - osp is the distance to insert or delete.
5001 If that is nonzero, begmatch is known to be nonzero also.
5002 begmatch + endmatch is how much we save by doing the ins/del.
5006 && (!FRAME_CHAR_INS_DEL_OK (f
)
5007 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5011 osp
= nsp
= min (osp
, nsp
);
5014 /* Now go through the line, inserting, writing and
5015 deleting as appropriate. */
5019 cursor_to (f
, vpos
, nsp
);
5020 delete_glyphs (f
, osp
- nsp
);
5024 /* If going to delete chars later in line
5025 and insert earlier in the line,
5026 must delete first to avoid losing data in the insert */
5027 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5029 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5030 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5031 olen
= nlen
- (nsp
- osp
);
5033 cursor_to (f
, vpos
, osp
);
5034 insert_glyphs (f
, 0, nsp
- osp
);
5038 tem
= nsp
+ begmatch
+ endmatch
;
5039 if (nlen
!= tem
|| olen
!= tem
)
5041 if (!endmatch
|| nlen
== olen
)
5043 /* If new text being written reaches right margin, there is
5044 no need to do clear-to-eol at the end of this function
5045 (and it would not be safe, since cursor is not going to
5046 be "at the margin" after the text is done). */
5047 if (nlen
== FRAME_TOTAL_COLS (f
))
5050 /* Function write_glyphs is prepared to do nothing
5051 if passed a length <= 0. Check it here to avoid
5052 unnecessary cursor movement. */
5055 cursor_to (f
, vpos
, nsp
+ begmatch
);
5056 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5059 else if (nlen
> olen
)
5061 /* Here, we used to have the following simple code:
5062 ----------------------------------------
5063 write_glyphs (nbody + nsp + begmatch, olen - tem);
5064 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5065 ----------------------------------------
5066 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5067 is a padding glyph. */
5068 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5071 cursor_to (f
, vpos
, nsp
+ begmatch
);
5073 /* Calculate columns we can actually overwrite. */
5074 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5076 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5078 /* If we left columns to be overwritten, we must delete them. */
5079 del
= olen
- tem
- out
;
5081 delete_glyphs (f
, del
);
5083 /* At last, we insert columns not yet written out. */
5084 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5087 else if (olen
> nlen
)
5089 cursor_to (f
, vpos
, nsp
+ begmatch
);
5090 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5091 delete_glyphs (f
, olen
- nlen
);
5097 /* If any unerased characters remain after the new line, erase them. */
5100 cursor_to (f
, vpos
, nlen
);
5101 clear_end_of_line (f
, olen
);
5104 /* Exchange contents between current_frame and new_frame. */
5105 make_current (desired_matrix
, current_matrix
, vpos
);
5110 /***********************************************************************
5111 X/Y Position -> Buffer Position
5112 ***********************************************************************/
5114 /* Determine what's under window-relative pixel position (*X, *Y).
5115 Return the OBJECT (string or buffer) that's there.
5116 Return in *POS the position in that object.
5117 Adjust *X and *Y to character positions.
5118 Return in *DX and *DY the pixel coordinates of the click,
5119 relative to the top left corner of OBJECT, or relative to
5120 the top left corner of the character glyph at (*X, *Y)
5122 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5123 if the coordinates point to an empty area of the display. */
5126 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
)
5129 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5130 struct text_pos startp
;
5132 struct glyph_row
*row
;
5133 #ifdef HAVE_WINDOW_SYSTEM
5134 struct image
*img
= 0;
5136 int x0
, x1
, to_x
, it_vpos
;
5137 void *itdata
= NULL
;
5139 /* We used to set current_buffer directly here, but that does the
5140 wrong thing with `face-remapping-alist' (bug#2044). */
5141 Fset_buffer (w
->contents
);
5142 itdata
= bidi_shelve_cache ();
5143 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5144 start_display (&it
, w
, startp
);
5147 /* First, move to the beginning of the row corresponding to *Y. We
5148 need to be in that row to get the correct value of base paragraph
5149 direction for the text at (*X, *Y). */
5150 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5152 /* TO_X is the pixel position that the iterator will compute for the
5155 if (it
.bidi_it
.paragraph_dir
== R2L
)
5156 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5157 text area. This is because the iterator, even in R2L
5158 paragraphs, delivers glyphs as if they started at the left
5159 margin of the window. (When we actually produce glyphs for
5160 display, we reverse their order in PRODUCE_GLYPHS, but the
5161 iterator doesn't know about that.) The following line adjusts
5162 the pixel position to the iterator geometry, which is what
5163 move_it_* routines use. (The -1 is because in a window whose
5164 text-area width is W, the rightmost pixel position is W-1, and
5165 it should be mirrored into zero pixel position.) */
5166 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5168 /* We need to add it.first_visible_x because iterator positions
5169 include the hscroll. */
5170 to_x
+= it
.first_visible_x
;
5172 /* Now move horizontally in the row to the glyph under *X. Second
5173 argument is ZV to prevent move_it_in_display_line from matching
5174 based on buffer positions. */
5175 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5176 bidi_unshelve_cache (itdata
, 0);
5178 Fset_buffer (old_current_buffer
);
5180 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5181 *dy
= *y
- it
.current_y
;
5183 string
= w
->contents
;
5184 if (STRINGP (it
.string
))
5187 if (it
.what
== IT_COMPOSITION
5188 && it
.cmp_it
.nchars
> 1
5189 && it
.cmp_it
.reversed_p
)
5191 /* The current display element is a grapheme cluster in a
5192 composition. In that case, we need the position of the first
5193 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5194 it.current points to the last character of the cluster, thus
5195 we must move back to the first character of the same
5197 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5198 if (STRINGP (it
.string
))
5199 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5201 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5202 CHARPOS (pos
->pos
));
5205 #ifdef HAVE_WINDOW_SYSTEM
5206 if (it
.what
== IT_IMAGE
)
5208 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5209 && !NILP (img
->spec
))
5210 *object
= img
->spec
;
5214 /* IT's vpos counts from the glyph row that includes the window's
5215 start position, i.e. it excludes the header-line row, but
5216 MATRIX_ROW includes the header-line row. Adjust for a possible
5218 it_vpos
= it
.vpos
+ WINDOW_WANTS_HEADER_LINE_P (w
);
5219 if (it_vpos
< w
->current_matrix
->nrows
5220 && (row
= MATRIX_ROW (w
->current_matrix
, it_vpos
),
5223 if (it
.hpos
< row
->used
[TEXT_AREA
])
5225 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5226 #ifdef HAVE_WINDOW_SYSTEM
5229 *dy
-= row
->ascent
- glyph
->ascent
;
5230 *dx
+= glyph
->slice
.img
.x
;
5231 *dy
+= glyph
->slice
.img
.y
;
5232 /* Image slices positions are still relative to the entire image */
5233 *width
= img
->width
;
5234 *height
= img
->height
;
5239 *width
= glyph
->pixel_width
;
5240 *height
= glyph
->ascent
+ glyph
->descent
;
5246 *height
= row
->height
;
5251 *width
= *height
= 0;
5254 /* Add extra (default width) columns if clicked after EOL. */
5255 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5257 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5266 /* Value is the string under window-relative coordinates X/Y in the
5267 mode line or header line (PART says which) of window W, or nil if none.
5268 *CHARPOS is set to the position in the string returned. */
5271 mode_line_string (struct window
*w
, enum window_part part
,
5272 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5273 int *dx
, int *dy
, int *width
, int *height
)
5275 struct glyph_row
*row
;
5276 struct glyph
*glyph
, *end
;
5278 Lisp_Object string
= Qnil
;
5280 if (part
== ON_MODE_LINE
)
5281 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5283 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5285 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5287 if (row
->mode_line_p
&& row
->enabled_p
)
5289 /* Find the glyph under X. If we find one with a string object,
5290 it's the one we were looking for. */
5291 glyph
= row
->glyphs
[TEXT_AREA
];
5292 end
= glyph
+ row
->used
[TEXT_AREA
];
5293 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5294 x0
-= glyph
->pixel_width
;
5295 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5298 string
= glyph
->object
;
5299 *charpos
= glyph
->charpos
;
5300 *width
= glyph
->pixel_width
;
5301 *height
= glyph
->ascent
+ glyph
->descent
;
5302 #ifdef HAVE_WINDOW_SYSTEM
5303 if (glyph
->type
== IMAGE_GLYPH
)
5306 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5308 *object
= img
->spec
;
5309 y0
-= row
->ascent
- glyph
->ascent
;
5315 /* Add extra (default width) columns if clicked after EOL. */
5316 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5318 *height
= row
->height
;
5325 *width
= *height
= 0;
5335 /* Value is the string under window-relative coordinates X/Y in either
5336 marginal area, or nil if none. *CHARPOS is set to the position in
5337 the string returned. */
5340 marginal_area_string (struct window
*w
, enum window_part part
,
5341 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5342 int *dx
, int *dy
, int *width
, int *height
)
5344 struct glyph_row
*row
= w
->current_matrix
->rows
;
5345 struct glyph
*glyph
, *end
;
5346 int x0
, y0
, i
, wy
= *y
;
5348 Lisp_Object string
= Qnil
;
5350 if (part
== ON_LEFT_MARGIN
)
5351 area
= LEFT_MARGIN_AREA
;
5352 else if (part
== ON_RIGHT_MARGIN
)
5353 area
= RIGHT_MARGIN_AREA
;
5357 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5358 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5361 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5365 /* Find the glyph under X. If we find one with a string object,
5366 it's the one we were looking for. */
5367 if (area
== RIGHT_MARGIN_AREA
)
5368 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5369 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5370 : WINDOW_FRINGES_WIDTH (w
))
5371 + window_box_width (w
, LEFT_MARGIN_AREA
)
5372 + window_box_width (w
, TEXT_AREA
));
5374 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5375 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5378 glyph
= row
->glyphs
[area
];
5379 end
= glyph
+ row
->used
[area
];
5380 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5381 x0
-= glyph
->pixel_width
;
5382 *x
= glyph
- row
->glyphs
[area
];
5385 string
= glyph
->object
;
5386 *charpos
= glyph
->charpos
;
5387 *width
= glyph
->pixel_width
;
5388 *height
= glyph
->ascent
+ glyph
->descent
;
5389 #ifdef HAVE_WINDOW_SYSTEM
5390 if (glyph
->type
== IMAGE_GLYPH
)
5393 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5395 *object
= img
->spec
;
5396 y0
-= row
->ascent
- glyph
->ascent
;
5397 x0
+= glyph
->slice
.img
.x
;
5398 y0
+= glyph
->slice
.img
.y
;
5404 /* Add extra (default width) columns if clicked after EOL. */
5405 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5407 *height
= row
->height
;
5414 *width
= *height
= 0;
5424 /***********************************************************************
5425 Changing Frame Sizes
5426 ***********************************************************************/
5430 static void deliver_window_change_signal (int);
5433 handle_window_change_signal (int sig
)
5436 struct tty_display_info
*tty
;
5438 /* The frame size change obviously applies to a single
5439 termcap-controlled terminal, but we can't decide which.
5440 Therefore, we resize the frames corresponding to each tty.
5442 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5444 if (! tty
->term_initted
)
5447 /* Suspended tty frames have tty->input == NULL avoid trying to
5452 get_tty_size (fileno (tty
->input
), &width
, &height
);
5454 if (width
> 5 && height
> 2) {
5455 Lisp_Object tail
, frame
;
5457 FOR_EACH_FRAME (tail
, frame
)
5458 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5459 /* Record the new sizes, but don't reallocate the data
5460 structures now. Let that be done later outside of the
5462 change_frame_size (XFRAME (frame
), width
,
5463 height
- FRAME_MENU_BAR_LINES (XFRAME (frame
)),
5470 deliver_window_change_signal (int sig
)
5472 deliver_process_signal (sig
, handle_window_change_signal
);
5474 #endif /* SIGWINCH */
5477 /* Do any change in frame size that was requested by a signal.
5478 SAFE means this function is called from a place where it is
5479 safe to change frame sizes while a redisplay is in progress. */
5482 do_pending_window_change (bool safe
)
5484 /* If window change signal handler should have run before, run it now. */
5485 if (redisplaying_p
&& !safe
)
5488 while (delayed_size_change
)
5490 Lisp_Object tail
, frame
;
5492 delayed_size_change
= 0;
5494 FOR_EACH_FRAME (tail
, frame
)
5496 struct frame
*f
= XFRAME (frame
);
5498 if (f
->new_height
!= 0 || f
->new_width
!= 0)
5499 change_frame_size (f
, f
->new_width
, f
->new_height
,
5500 0, 0, safe
, f
->new_pixelwise
);
5507 change_frame_size_1 (struct frame
*f
, int new_width
, int new_height
,
5508 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5510 /* If we can't deal with the change now, queue it for later. */
5511 if (delay
|| (redisplaying_p
&& !safe
))
5513 f
->new_width
= new_width
;
5514 f
->new_height
= new_height
;
5515 f
->new_pixelwise
= pixelwise
;
5516 delayed_size_change
= 1;
5520 /* This size-change overrides any pending one for this frame. */
5523 f
->new_pixelwise
= 0;
5525 /* If an argument is zero, set it to the current value. */
5528 new_width
= (new_width
<= 0) ? FRAME_TEXT_WIDTH (f
) : new_width
;
5529 new_height
= (new_height
<= 0) ? FRAME_TEXT_HEIGHT (f
) : new_height
;
5533 new_width
= (((new_width
<= 0) ? FRAME_COLS (f
) : new_width
)
5534 * FRAME_COLUMN_WIDTH (f
));
5535 new_height
= (((new_height
<= 0) ? FRAME_LINES (f
) : new_height
)
5536 * FRAME_LINE_HEIGHT (f
));
5539 /* Adjust frame size but make sure x_set_window_size does not
5541 adjust_frame_size (f
, new_width
, new_height
, 5, pretend
, Qnil
);
5546 /* Change text height/width of frame F. Values may be given as zero to
5547 indicate that no change is needed.
5549 If DELAY, assume we're being called from a signal handler, and queue
5550 the change for later - perhaps the next redisplay. Since this tries
5551 to resize windows, we can't call it from a signal handler.
5553 SAFE means this function is called from a place where it's safe to
5554 change frame sizes while a redisplay is in progress. */
5556 change_frame_size (struct frame
*f
, int new_width
, int new_height
,
5557 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5559 Lisp_Object tail
, frame
;
5561 if (FRAME_MSDOS_P (f
))
5563 /* On MS-DOS, all frames use the same screen, so a change in
5564 size affects all frames. Termcap now supports multiple
5566 FOR_EACH_FRAME (tail
, frame
)
5567 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5568 change_frame_size_1 (XFRAME (frame
), new_width
, new_height
,
5569 pretend
, delay
, safe
, pixelwise
);
5572 change_frame_size_1 (f
, new_width
, new_height
, pretend
, delay
, safe
,
5576 /***********************************************************************
5577 Terminal Related Lisp Functions
5578 ***********************************************************************/
5580 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5581 1, 1, "FOpen termscript file: ",
5582 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5583 FILE = nil means just close any termscript file currently open. */)
5586 struct tty_display_info
*tty
;
5588 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5589 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5590 error ("Current frame is not on a tty device");
5594 if (tty
->termscript
!= 0)
5597 fclose (tty
->termscript
);
5598 tty
->termscript
= 0;
5604 file
= Fexpand_file_name (file
, Qnil
);
5605 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5606 if (tty
->termscript
== 0)
5607 report_file_error ("Opening termscript", file
);
5613 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5614 Ssend_string_to_terminal
, 1, 2, 0,
5615 doc
: /* Send STRING to the terminal without alteration.
5616 Control characters in STRING will have terminal-dependent effects.
5618 Optional parameter TERMINAL specifies the tty terminal device to use.
5619 It may be a terminal object, a frame, or nil for the terminal used by
5620 the currently selected frame. In batch mode, STRING is sent to stdout
5621 when TERMINAL is nil. */)
5622 (Lisp_Object string
, Lisp_Object terminal
)
5624 struct terminal
*t
= decode_live_terminal (terminal
);
5627 /* ??? Perhaps we should do something special for multibyte strings here. */
5628 CHECK_STRING (string
);
5631 if (t
->type
== output_initial
)
5633 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5634 error ("Device %d is not a termcap terminal device", t
->id
);
5637 struct tty_display_info
*tty
= t
->display_info
.tty
;
5640 error ("Terminal is currently suspended");
5642 if (tty
->termscript
)
5644 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5645 fflush (tty
->termscript
);
5649 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5656 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5657 doc
: /* Beep, or flash the screen.
5658 Also, unless an argument is given,
5659 terminate any keyboard macro currently executing. */)
5667 ring_bell (XFRAME (selected_frame
));
5676 bitch_at_user (void)
5680 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5683 = "Keyboard macro terminated by a command ringing the bell";
5684 Fsignal (Quser_error
, list1 (build_string (msg
)));
5687 ring_bell (XFRAME (selected_frame
));
5692 /***********************************************************************
5694 ***********************************************************************/
5696 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5697 doc
: /* Pause, without updating display, for SECONDS seconds.
5698 SECONDS may be a floating-point value, meaning that you can wait for a
5699 fraction of a second. Optional second arg MILLISECONDS specifies an
5700 additional wait period, in milliseconds; this is for backwards compatibility.
5701 \(Not all operating systems support waiting for a fraction of a second.) */)
5702 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5704 double duration
= extract_float (seconds
);
5706 if (!NILP (milliseconds
))
5708 CHECK_NUMBER (milliseconds
);
5709 duration
+= XINT (milliseconds
) / 1000.0;
5714 struct timespec t
= dtotimespec (duration
);
5715 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5716 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5723 /* This is just like wait_reading_process_output, except that
5726 TIMEOUT is number of seconds to wait (float or integer),
5727 or t to wait forever.
5728 READING is true if reading input.
5729 If DISPLAY_OPTION is >0 display process output while waiting.
5730 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5734 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5738 bool do_display
= display_option
> 0;
5740 swallow_events (do_display
);
5742 if ((detect_input_pending_run_timers (do_display
))
5743 || !NILP (Vexecuting_kbd_macro
))
5746 if (display_option
> 1)
5747 redisplay_preserve_echo_area (2);
5749 if (INTEGERP (timeout
))
5751 sec
= XINT (timeout
);
5756 else if (FLOATP (timeout
))
5758 double seconds
= XFLOAT_DATA (timeout
);
5759 if (! (0 < seconds
))
5763 struct timespec t
= dtotimespec (seconds
);
5764 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5768 else if (EQ (timeout
, Qt
))
5774 wrong_type_argument (Qnumberp
, timeout
);
5781 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5784 return detect_input_pending () ? Qnil
: Qt
;
5788 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5789 doc
: /* Perform redisplay.
5790 Optional arg FORCE, if non-nil, prevents redisplay from being
5791 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5792 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5793 preempted by arriving input, so FORCE does nothing.
5795 Return t if redisplay was performed, nil if redisplay was preempted
5796 immediately by pending input. */)
5801 swallow_events (true);
5802 if ((detect_input_pending_run_timers (1)
5803 && NILP (force
) && !redisplay_dont_pause
)
5804 || !NILP (Vexecuting_kbd_macro
))
5807 count
= SPECPDL_INDEX ();
5808 if (!NILP (force
) && !redisplay_dont_pause
)
5809 specbind (Qredisplay_dont_pause
, Qt
);
5810 redisplay_preserve_echo_area (2);
5811 unbind_to (count
, Qnil
);
5817 /***********************************************************************
5818 Other Lisp Functions
5819 ***********************************************************************/
5821 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5822 session's frames, frame names, buffers, buffer-read-only flags, and
5823 buffer-modified-flags. */
5825 static Lisp_Object frame_and_buffer_state
;
5828 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5829 Sframe_or_buffer_changed_p
, 0, 1, 0,
5830 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5831 VARIABLE is a variable name whose value is either nil or a state vector
5832 that will be updated to contain all frames and buffers,
5833 aside from buffers whose names start with space,
5834 along with the buffers' read-only and modified flags. This allows a fast
5835 check to see whether buffer menus might need to be recomputed.
5836 If this function returns non-nil, it updates the internal vector to reflect
5839 If VARIABLE is nil, an internal variable is used. Users should not
5840 pass nil for VARIABLE. */)
5841 (Lisp_Object variable
)
5843 Lisp_Object state
, tail
, frame
, buf
;
5846 if (! NILP (variable
))
5848 CHECK_SYMBOL (variable
);
5849 state
= Fsymbol_value (variable
);
5850 if (! VECTORP (state
))
5854 state
= frame_and_buffer_state
;
5857 FOR_EACH_FRAME (tail
, frame
)
5859 if (idx
== ASIZE (state
))
5861 if (!EQ (AREF (state
, idx
++), frame
))
5863 if (idx
== ASIZE (state
))
5865 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5868 /* Check that the buffer info matches. */
5869 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5871 /* Ignore buffers that aren't included in buffer lists. */
5872 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5874 if (idx
== ASIZE (state
))
5876 if (!EQ (AREF (state
, idx
++), buf
))
5878 if (idx
== ASIZE (state
))
5880 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5882 if (idx
== ASIZE (state
))
5884 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5887 if (idx
== ASIZE (state
))
5889 /* Detect deletion of a buffer at the end of the list. */
5890 if (EQ (AREF (state
, idx
), Qlambda
))
5893 /* Come here if we decide the data has changed. */
5895 /* Count the size we will need.
5896 Start with 1 so there is room for at least one lambda at the end. */
5898 FOR_EACH_FRAME (tail
, frame
)
5900 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5902 /* Reallocate the vector if data has grown to need it,
5903 or if it has shrunk a lot. */
5904 if (! VECTORP (state
)
5905 || n
> ASIZE (state
)
5906 || n
+ 20 < ASIZE (state
) / 2)
5907 /* Add 20 extra so we grow it less often. */
5909 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5910 if (! NILP (variable
))
5911 Fset (variable
, state
);
5913 frame_and_buffer_state
= state
;
5916 /* Record the new data in the (possibly reallocated) vector. */
5918 FOR_EACH_FRAME (tail
, frame
)
5920 ASET (state
, idx
, frame
);
5922 ASET (state
, idx
, XFRAME (frame
)->name
);
5925 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5927 /* Ignore buffers that aren't included in buffer lists. */
5928 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5930 ASET (state
, idx
, buf
);
5932 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5934 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5937 /* Fill up the vector with lambdas (always at least one). */
5938 ASET (state
, idx
, Qlambda
);
5940 while (idx
< ASIZE (state
))
5942 ASET (state
, idx
, Qlambda
);
5945 /* Make sure we didn't overflow the vector. */
5946 eassert (idx
<= ASIZE (state
));
5952 /***********************************************************************
5954 ***********************************************************************/
5956 /* Initialization done when Emacs fork is started, before doing stty.
5957 Determine terminal type and set terminal_driver. Then invoke its
5958 decoding routine to set up variables in the terminal package. */
5963 char *terminal_type
;
5965 /* Construct the space glyph. */
5966 space_glyph
.type
= CHAR_GLYPH
;
5967 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5968 space_glyph
.charpos
= -1;
5971 cursor_in_echo_area
= 0;
5973 /* Now is the time to initialize this; it's used by init_sys_modes
5975 Vinitial_window_system
= Qnil
;
5977 /* SIGWINCH needs to be handled no matter what display we start
5978 with. Otherwise newly opened tty frames will not resize
5983 #endif /* CANNOT_DUMP */
5985 struct sigaction action
;
5986 emacs_sigaction_init (&action
, deliver_window_change_signal
);
5987 sigaction (SIGWINCH
, &action
, 0);
5989 #endif /* SIGWINCH */
5991 /* If running as a daemon, no need to initialize any frames/terminal. */
5995 /* If the user wants to use a window system, we shouldn't bother
5996 initializing the terminal. This is especially important when the
5997 terminal is so dumb that emacs gives up before and doesn't bother
5998 using the window system.
6000 If the DISPLAY environment variable is set and nonempty,
6001 try to use X, and die with an error message if that doesn't work. */
6003 #ifdef HAVE_X_WINDOWS
6004 if (! inhibit_window_system
&& ! display_arg
)
6007 display
= getenv ("DISPLAY");
6008 display_arg
= (display
!= 0 && *display
!= 0);
6010 if (display_arg
&& !x_display_ok (display
))
6012 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6014 inhibit_window_system
= 1;
6018 if (!inhibit_window_system
&& display_arg
)
6020 Vinitial_window_system
= Qx
;
6022 Vwindow_system_version
= make_number (11);
6025 /* In some versions of ncurses,
6026 tputs crashes if we have not called tgetent.
6028 { char b
[2044]; tgetent (b
, "xterm");}
6032 #endif /* HAVE_X_WINDOWS */
6035 if (!inhibit_window_system
)
6037 Vinitial_window_system
= Qw32
;
6038 Vwindow_system_version
= make_number (1);
6041 #endif /* HAVE_NTGUI */
6044 if (!inhibit_window_system
6050 Vinitial_window_system
= Qns
;
6051 Vwindow_system_version
= make_number (10);
6056 /* If no window system has been specified, try to use the terminal. */
6058 fatal ("standard input is not a tty");
6061 terminal_type
= "w32console";
6063 terminal_type
= getenv ("TERM");
6067 #ifdef HAVE_WINDOW_SYSTEM
6068 if (! inhibit_window_system
)
6069 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6071 #endif /* HAVE_WINDOW_SYSTEM */
6072 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6078 struct frame
*f
= XFRAME (selected_frame
);
6080 init_foreground_group ();
6082 /* Open a display on the controlling tty. */
6083 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6085 /* Convert the initial frame to use the new display. */
6086 if (f
->output_method
!= output_initial
)
6088 f
->output_method
= t
->type
;
6091 t
->reference_count
++;
6093 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6095 if (f
->output_method
== output_termcap
)
6096 create_tty_output (f
);
6098 t
->display_info
.tty
->top_frame
= selected_frame
;
6099 change_frame_size (XFRAME (selected_frame
),
6100 FrameCols (t
->display_info
.tty
),
6101 FrameRows (t
->display_info
.tty
)
6102 - FRAME_MENU_BAR_LINES (f
), 0, 0, 1, 0);
6104 /* Delete the initial terminal. */
6105 if (--initial_terminal
->reference_count
== 0
6106 && initial_terminal
->delete_terminal_hook
)
6107 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6109 /* Update frame parameters to reflect the new type. */
6110 AUTO_FRAME_ARG (tty_type_arg
, Qtty_type
, Ftty_type (selected_frame
));
6111 Fmodify_frame_parameters (selected_frame
, tty_type_arg
);
6112 AUTO_FRAME_ARG (tty_arg
, Qtty
, (t
->display_info
.tty
->name
6113 ? build_string (t
->display_info
.tty
->name
)
6115 Fmodify_frame_parameters (selected_frame
, tty_arg
);
6119 struct frame
*sf
= SELECTED_FRAME ();
6120 int width
= FRAME_TOTAL_COLS (sf
);
6121 int height
= FRAME_TOTAL_LINES (sf
);
6123 /* If these sizes are so big they cause overflow, just ignore the
6124 change. It's not clear what better we could do. The rest of
6125 the code assumes that (width + 2) * height * sizeof (struct glyph)
6126 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6127 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6128 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6129 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6130 < (width
+ 2) * height
))
6131 fatal ("screen size %dx%d too big", width
, height
);
6134 calculate_costs (XFRAME (selected_frame
));
6136 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6139 && NILP (Vinitial_window_system
))
6141 /* For the initial frame, we don't have any way of knowing what
6142 are the foreground and background colors of the terminal. */
6143 struct frame
*sf
= SELECTED_FRAME ();
6145 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6146 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6147 call0 (intern ("tty-set-up-initial-frame-faces"));
6153 /***********************************************************************
6155 ***********************************************************************/
6157 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6158 Sinternal_show_cursor
, 2, 2, 0,
6159 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6160 WINDOW nil means use the selected window. SHOW non-nil means
6161 show a cursor in WINDOW in the next redisplay. SHOW nil means
6162 don't show a cursor. */)
6163 (Lisp_Object window
, Lisp_Object show
)
6165 /* Don't change cursor state while redisplaying. This could confuse
6167 if (!redisplaying_p
)
6168 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6173 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6174 Sinternal_show_cursor_p
, 0, 1, 0,
6175 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6176 WINDOW nil or omitted means report on the selected window. */)
6177 (Lisp_Object window
)
6179 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6182 /***********************************************************************
6184 ***********************************************************************/
6187 syms_of_display (void)
6189 defsubr (&Sredraw_frame
);
6190 defsubr (&Sredraw_display
);
6191 defsubr (&Sframe_or_buffer_changed_p
);
6192 defsubr (&Sopen_termscript
);
6194 defsubr (&Sredisplay
);
6195 defsubr (&Ssleep_for
);
6196 defsubr (&Ssend_string_to_terminal
);
6197 defsubr (&Sinternal_show_cursor
);
6198 defsubr (&Sinternal_show_cursor_p
);
6201 defsubr (&Sdump_redisplay_history
);
6204 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6205 staticpro (&frame_and_buffer_state
);
6207 DEFSYM (Qdisplay_table
, "display-table");
6208 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6210 DEFVAR_INT ("baud-rate", baud_rate
,
6211 doc
: /* The output baud rate of the terminal.
6212 On most systems, changing this value will affect the amount of padding
6213 and the other strategic decisions made during redisplay. */);
6215 DEFVAR_BOOL ("inverse-video", inverse_video
,
6216 doc
: /* Non-nil means invert the entire frame display.
6217 This means everything is in inverse video which otherwise would not be. */);
6219 DEFVAR_BOOL ("visible-bell", visible_bell
,
6220 doc
: /* Non-nil means try to flash the frame to represent a bell.
6222 See also `ring-bell-function'. */);
6224 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6225 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6226 A non-nil value is useful if the terminal can automatically preserve
6227 Emacs's frame display when you reenter Emacs.
6228 It is up to you to set this variable if your terminal can do that. */);
6230 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6231 doc
: /* Name of the window system that Emacs uses for the first frame.
6232 The value is a symbol:
6233 nil for a termcap frame (a character-only terminal),
6234 'x' for an Emacs frame that is really an X window,
6235 'w32' for an Emacs frame that is a window on MS-Windows display,
6236 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6237 'pc' for a direct-write MS-DOS frame.
6239 Use of this variable as a boolean is deprecated. Instead,
6240 use `display-graphic-p' or any of the other `display-*-p'
6241 predicates which report frame's specific UI-related capabilities. */);
6243 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6244 doc
: /* Name of window system through which the selected frame is displayed.
6245 The value is a symbol:
6246 nil for a termcap frame (a character-only terminal),
6247 'x' for an Emacs frame that is really an X window,
6248 'w32' for an Emacs frame that is a window on MS-Windows display,
6249 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6250 'pc' for a direct-write MS-DOS frame.
6252 Use of this variable as a boolean is deprecated. Instead,
6253 use `display-graphic-p' or any of the other `display-*-p'
6254 predicates which report frame's specific UI-related capabilities. */);
6256 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6257 doc
: /* The version number of the window system in use.
6258 For X windows, this is 11. */);
6260 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6261 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6263 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6264 doc
: /* Table defining how to output a glyph code to the frame.
6265 If not nil, this is a vector indexed by glyph code to define the glyph.
6266 Each element can be:
6267 integer: a glyph code which this glyph is an alias for.
6268 string: output this glyph using that string (not impl. in X windows).
6269 nil: this glyph mod 524288 is the code of a character to output,
6270 and this glyph / 524288 is the face number (see `face-id') to use
6271 while outputting it. */);
6272 Vglyph_table
= Qnil
;
6274 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6275 doc
: /* Display table to use for buffers that specify none.
6276 See `buffer-display-table' for more information. */);
6277 Vstandard_display_table
= Qnil
;
6279 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6280 doc
: /* Nil means display update is paused when input is detected. */);
6281 /* Contrary to expectations, a value of "false" can be detrimental to
6282 responsiveness since aborting a redisplay throws away some of the
6283 work already performed. It's usually more efficient (and gives
6284 more prompt feedback to the user) to let the redisplay terminate,
6285 and just completely skip the next command's redisplay (which is
6286 done regardless of this setting if there's pending input at the
6287 beginning of the next redisplay). */
6288 redisplay_dont_pause
= true;
6294 Vinitial_window_system
= Qnil
;
6295 Vwindow_system_version
= Qnil
;