1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 /* cm.h must come after dispextern.h on Windows. */
29 #include "dispextern.h"
31 #include "character.h"
35 #include "termhooks.h"
40 #include "intervals.h"
41 #include "blockinput.h"
44 #include "syssignal.h"
47 #ifdef HAVE_WINDOW_SYSTEM
49 #endif /* HAVE_WINDOW_SYSTEM */
64 /* Structure to pass dimensions around. Used for character bounding
65 boxes, glyph matrix dimensions and alike. */
74 /* Function prototypes. */
76 static void update_frame_line (struct frame
*, int);
77 static int required_matrix_height (struct window
*);
78 static int required_matrix_width (struct window
*);
79 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
80 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
82 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
84 static void adjust_decode_mode_spec_buffer (struct frame
*);
85 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
86 static void clear_window_matrices (struct window
*, bool);
87 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
88 static int scrolling_window (struct window
*, bool);
89 static bool update_window_line (struct window
*, int, bool *);
90 static void mirror_make_current (struct window
*, int);
92 static void check_matrix_pointers (struct glyph_matrix
*,
93 struct glyph_matrix
*);
95 static void mirror_line_dance (struct window
*, int, int, int *, char *);
96 static bool update_window_tree (struct window
*, bool);
97 static bool update_window (struct window
*, bool);
98 static bool update_frame_1 (struct frame
*, bool, bool, bool);
99 static bool scrolling (struct frame
*);
100 static void set_window_cursor_after_update (struct window
*);
101 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
102 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
103 static void set_window_update_flags (struct window
*w
, bool on_p
);
105 /* True means last display completed. False means it was preempted. */
107 bool display_completed
;
109 /* True means SIGWINCH happened when not safe. */
111 static bool delayed_size_change
;
113 /* A glyph for a space. */
115 struct glyph space_glyph
;
117 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
119 /* Counts of allocated structures. These counts serve to diagnose
120 memory leaks and double frees. */
122 static int glyph_matrix_count
;
123 static int glyph_pool_count
;
125 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
127 /* If non-null, the frame whose frame matrices are manipulated. If
128 null, window matrices are worked on. */
130 static struct frame
*frame_matrix_frame
;
132 /* Convert vpos and hpos from frame to window and vice versa.
133 This may only be used for terminal frames. */
137 static int window_to_frame_vpos (struct window
*, int);
138 static int window_to_frame_hpos (struct window
*, int);
139 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
140 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
142 /* One element of the ring buffer containing redisplay history
145 struct redisplay_history
147 char trace
[512 + 100];
150 /* The size of the history buffer. */
152 #define REDISPLAY_HISTORY_SIZE 30
154 /* The redisplay history buffer. */
156 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
158 /* Next free entry in redisplay_history. */
160 static int history_idx
;
162 /* A tick that's incremented each time something is added to the
165 static uprintmax_t history_tick
;
167 /* Add to the redisplay history how window W has been displayed.
168 MSG is a trace containing the information how W's glyph matrix
169 has been constructed. PAUSED_P means that the update
170 has been interrupted for pending input. */
173 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
178 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
180 buf
= redisplay_history
[history_idx
].trace
;
183 snprintf (buf
, sizeof redisplay_history
[0].trace
,
184 "%"pMu
": window %p (`%s')%s\n%s",
187 ((BUFFERP (w
->contents
)
188 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
189 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
191 paused_p
? " ***paused***" : "",
196 /* Add to the redisplay history that frame F has been displayed.
197 PAUSED_P means that the update has been interrupted for
201 add_frame_display_history (struct frame
*f
, bool paused_p
)
206 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
208 buf
= redisplay_history
[history_idx
].trace
;
211 sprintf (buf
, "%"pMu
": update frame %p%s",
213 ptr
, paused_p
? " ***paused***" : "");
217 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
218 Sdump_redisplay_history
, 0, 0, "",
219 doc
: /* Dump redisplay history to stderr. */)
224 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
227 i
= REDISPLAY_HISTORY_SIZE
- 1;
228 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
235 #else /* not GLYPH_DEBUG */
237 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
238 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
240 #endif /* GLYPH_DEBUG */
243 #if (defined PROFILING \
244 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
245 && !HAVE___EXECUTABLE_START)
246 /* This function comes first in the Emacs executable and is used only
247 to estimate the text start for profiling. */
249 __executable_start (void)
255 /***********************************************************************
257 ***********************************************************************/
259 /* Allocate and return a glyph_matrix structure. POOL is the glyph
260 pool from which memory for the matrix should be allocated, or null
261 for window-based redisplay where no glyph pools are used. The
262 member `pool' of the glyph matrix structure returned is set to
263 POOL, the structure is otherwise zeroed. */
265 static struct glyph_matrix
*
266 new_glyph_matrix (struct glyph_pool
*pool
)
268 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
270 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
271 /* Increment number of allocated matrices. This count is used
272 to detect memory leaks. */
273 ++glyph_matrix_count
;
276 /* Set pool and return. */
282 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
284 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
285 glyph_matrix_count is decremented when a matrix is freed. If the count
286 gets negative, more structures were freed than allocated, i.e. one matrix
287 was freed more than once or a bogus pointer was passed to this function.
289 If MATRIX->pool is null, this means that the matrix manages its own
290 glyph memory---this is done for matrices on X frames. Freeing the
291 matrix also frees the glyph memory in this case. */
294 free_glyph_matrix (struct glyph_matrix
*matrix
)
300 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
301 /* Detect the case that more matrices are freed than were
303 --glyph_matrix_count
;
304 eassert (glyph_matrix_count
>= 0);
307 /* Free glyph memory if MATRIX owns it. */
308 if (matrix
->pool
== NULL
)
309 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
310 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
312 /* Free row structures and the matrix itself. */
313 xfree (matrix
->rows
);
319 /* Return the number of glyphs to reserve for a marginal area of
320 window W. TOTAL_GLYPHS is the number of glyphs in a complete
321 display line of window W. MARGIN gives the width of the marginal
322 area in canonical character units. */
325 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
329 int width
= w
->total_cols
;
330 double d
= max (0, margin
);
331 d
= min (width
/ 2 - 1, d
);
332 return (int) ((double) total_glyphs
/ width
* d
);
337 /* Return true if ROW's hash value is correct.
338 Optimized away if ENABLE_CHECKING is not defined. */
341 verify_row_hash (struct glyph_row
*row
)
343 return row
->hash
== row_hash (row
);
346 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
349 W is null if the function is called for a frame glyph matrix.
350 Otherwise it is the window MATRIX is a member of. X and Y are the
351 indices of the first column and row of MATRIX within the frame
352 matrix, if such a matrix exists. They are zero for purely
353 window-based redisplay. DIM is the needed size of the matrix.
355 In window-based redisplay, where no frame matrices exist, glyph
356 matrices manage their own glyph storage. Otherwise, they allocate
357 storage from a common frame glyph pool which can be found in
360 The reason for this memory management strategy is to avoid complete
361 frame redraws if possible. When we allocate from a common pool, a
362 change of the location or size of a sub-matrix within the pool
363 requires a complete redisplay of the frame because we cannot easily
364 make sure that the current matrices of all windows still agree with
365 what is displayed on the screen. While this is usually fast, it
366 leads to screen flickering. */
369 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
373 bool marginal_areas_changed_p
= 0;
374 bool header_line_changed_p
= 0;
375 bool header_line_p
= 0;
376 int left
= -1, right
= -1;
377 int window_width
= -1, window_height
= -1;
379 /* See if W had a header line that has disappeared now, or vice versa.
383 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
385 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
386 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
388 matrix
->header_line_p
= header_line_p
;
390 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
391 Do nothing if MATRIX' size, position, vscroll, and marginal areas
392 haven't changed. This optimization is important because preserving
393 the matrix means preventing redisplay. */
394 if (matrix
->pool
== NULL
)
396 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
397 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
398 eassert (left
>= 0 && right
>= 0);
399 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
400 || right
!= matrix
->right_margin_glyphs
);
402 if (!marginal_areas_changed_p
403 && !XFRAME (w
->frame
)->fonts_changed
404 && !header_line_changed_p
405 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
406 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
407 && matrix
->window_height
== window_height
408 && matrix
->window_vscroll
== w
->vscroll
409 && matrix
->window_width
== window_width
)
413 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
414 if (matrix
->rows_allocated
< dim
.height
)
416 int old_alloc
= matrix
->rows_allocated
;
417 new_rows
= dim
.height
- matrix
->rows_allocated
;
418 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
419 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
420 memset (matrix
->rows
+ old_alloc
, 0,
421 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
426 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
427 on a frame not using window-based redisplay. Set up pointers for
428 each row into the glyph pool. */
431 eassert (matrix
->pool
->glyphs
);
435 left
= margin_glyphs_to_reserve (w
, dim
.width
,
436 w
->left_margin_cols
);
437 right
= margin_glyphs_to_reserve (w
, dim
.width
,
438 w
->right_margin_cols
);
443 for (i
= 0; i
< dim
.height
; ++i
)
445 struct glyph_row
*row
= &matrix
->rows
[i
];
447 row
->glyphs
[LEFT_MARGIN_AREA
]
448 = (matrix
->pool
->glyphs
449 + (y
+ i
) * matrix
->pool
->ncolumns
453 || (row
== matrix
->rows
+ dim
.height
- 1
454 && WINDOW_WANTS_MODELINE_P (w
))
455 || (row
== matrix
->rows
&& matrix
->header_line_p
))
457 row
->glyphs
[TEXT_AREA
]
458 = row
->glyphs
[LEFT_MARGIN_AREA
];
459 row
->glyphs
[RIGHT_MARGIN_AREA
]
460 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
461 row
->glyphs
[LAST_AREA
]
462 = row
->glyphs
[RIGHT_MARGIN_AREA
];
466 row
->glyphs
[TEXT_AREA
]
467 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
468 row
->glyphs
[RIGHT_MARGIN_AREA
]
469 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
470 row
->glyphs
[LAST_AREA
]
471 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
475 matrix
->left_margin_glyphs
= left
;
476 matrix
->right_margin_glyphs
= right
;
480 /* If MATRIX->pool is null, MATRIX is responsible for managing
481 its own memory. It is a window matrix for window-based redisplay.
482 Allocate glyph memory from the heap. */
483 if (dim
.width
> matrix
->matrix_w
485 || header_line_changed_p
486 || marginal_areas_changed_p
)
488 struct glyph_row
*row
= matrix
->rows
;
489 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
493 row
->glyphs
[LEFT_MARGIN_AREA
]
494 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
495 dim
.width
, sizeof (struct glyph
));
497 /* The mode line, if displayed, never has marginal areas. */
498 if ((row
== matrix
->rows
+ dim
.height
- 1
499 && !(w
&& WINDOW_WANTS_MODELINE_P (w
)))
500 || (row
== matrix
->rows
&& matrix
->header_line_p
))
502 row
->glyphs
[TEXT_AREA
]
503 = row
->glyphs
[LEFT_MARGIN_AREA
];
504 row
->glyphs
[RIGHT_MARGIN_AREA
]
505 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
506 row
->glyphs
[LAST_AREA
]
507 = row
->glyphs
[RIGHT_MARGIN_AREA
];
511 row
->glyphs
[TEXT_AREA
]
512 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
513 row
->glyphs
[RIGHT_MARGIN_AREA
]
514 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
515 row
->glyphs
[LAST_AREA
]
516 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
522 eassert (left
>= 0 && right
>= 0);
523 matrix
->left_margin_glyphs
= left
;
524 matrix
->right_margin_glyphs
= right
;
527 /* Number of rows to be used by MATRIX. */
528 matrix
->nrows
= dim
.height
;
529 eassert (matrix
->nrows
>= 0);
533 if (matrix
== w
->current_matrix
)
535 /* Mark rows in a current matrix of a window as not having
536 valid contents. It's important to not do this for
537 desired matrices. When Emacs starts, it may already be
538 building desired matrices when this function runs. */
539 if (window_width
< 0)
540 window_width
= window_box_width (w
, -1);
542 /* Optimize the case that only the height has changed (C-x 2,
543 upper window). Invalidate all rows that are no longer part
545 if (!marginal_areas_changed_p
546 && !header_line_changed_p
548 && dim
.width
== matrix
->matrix_w
549 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
550 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
551 && matrix
->window_width
== window_width
)
553 /* Find the last row in the window. */
554 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
555 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
561 /* Window end is invalid, if inside of the rows that
562 are invalidated below. */
563 if (w
->window_end_vpos
>= i
)
564 w
->window_end_valid
= 0;
566 while (i
< matrix
->nrows
)
567 matrix
->rows
[i
++].enabled_p
= false;
571 for (i
= 0; i
< matrix
->nrows
; ++i
)
572 matrix
->rows
[i
].enabled_p
= false;
575 else if (matrix
== w
->desired_matrix
)
577 /* Rows in desired matrices always have to be cleared;
578 redisplay expects this is the case when it runs, so it
579 had better be the case when we adjust matrices between
581 for (i
= 0; i
< matrix
->nrows
; ++i
)
582 matrix
->rows
[i
].enabled_p
= false;
587 /* Remember last values to be able to optimize frame redraws. */
588 matrix
->matrix_x
= x
;
589 matrix
->matrix_y
= y
;
590 matrix
->matrix_w
= dim
.width
;
591 matrix
->matrix_h
= dim
.height
;
593 /* Record the top y location and height of W at the time the matrix
594 was last adjusted. This is used to optimize redisplay above. */
597 matrix
->window_pixel_left
= WINDOW_LEFT_PIXEL_EDGE (w
);
598 matrix
->window_pixel_top
= WINDOW_TOP_PIXEL_EDGE (w
);
599 matrix
->window_height
= window_height
;
600 matrix
->window_width
= window_width
;
601 matrix
->window_vscroll
= w
->vscroll
;
606 /* Reverse the contents of rows in MATRIX between START and END. The
607 contents of the row at END - 1 end up at START, END - 2 at START +
608 1 etc. This is part of the implementation of rotate_matrix (see
612 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
616 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
618 /* Non-ISO HP/UX compiler doesn't like auto struct
620 struct glyph_row temp
;
621 temp
= matrix
->rows
[i
];
622 matrix
->rows
[i
] = matrix
->rows
[j
];
623 matrix
->rows
[j
] = temp
;
628 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
629 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
630 indices. (Note: this does not copy glyphs, only glyph pointers in
631 row structures are moved around).
633 The algorithm used for rotating the vector was, I believe, first
634 described by Kernighan. See the vector R as consisting of two
635 sub-vectors AB, where A has length BY for BY >= 0. The result
636 after rotating is then BA. Reverse both sub-vectors to get ArBr
637 and reverse the result to get (ArBr)r which is BA. Similar for
641 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
645 /* Up (rotate left, i.e. towards lower indices). */
647 reverse_rows (matrix
, first
, first
+ by
);
648 reverse_rows (matrix
, first
+ by
, last
);
649 reverse_rows (matrix
, first
, last
);
653 /* Down (rotate right, i.e. towards higher indices). */
654 reverse_rows (matrix
, last
- by
, last
);
655 reverse_rows (matrix
, first
, last
- by
);
656 reverse_rows (matrix
, first
, last
);
661 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
662 with indices START <= index < END. Increment positions by DELTA/
666 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
667 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
669 /* Check that START and END are reasonable values. */
670 eassert (start
>= 0 && start
<= matrix
->nrows
);
671 eassert (end
>= 0 && end
<= matrix
->nrows
);
672 eassert (start
<= end
);
674 for (; start
< end
; ++start
)
675 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
679 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
680 START and END are the row indices of the first and last + 1 row to clear. */
683 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
685 eassert (start
<= end
);
686 eassert (start
>= 0 && start
< matrix
->nrows
);
687 eassert (end
>= 0 && end
<= matrix
->nrows
);
689 for (; start
< end
; ++start
)
690 matrix
->rows
[start
].enabled_p
= false;
696 Empty all rows in MATRIX by clearing their enabled_p flags.
697 The function prepare_desired_row will eventually really clear a row
698 when it sees one with a false enabled_p flag.
700 Reset update hints to default values. The only update hint
701 currently present is the flag MATRIX->no_scrolling_p. */
704 clear_glyph_matrix (struct glyph_matrix
*matrix
)
708 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
709 matrix
->no_scrolling_p
= 0;
714 /* Shift part of the glyph matrix MATRIX of window W up or down.
715 Increment y-positions in glyph rows between START and END by DY,
716 and recompute their visible height. */
719 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
723 eassert (start
<= end
);
724 eassert (start
>= 0 && start
< matrix
->nrows
);
725 eassert (end
>= 0 && end
<= matrix
->nrows
);
727 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
728 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
730 for (; start
< end
; ++start
)
732 struct glyph_row
*row
= &matrix
->rows
[start
];
735 row
->visible_height
= row
->height
;
738 row
->visible_height
-= min_y
- row
->y
;
739 if (row
->y
+ row
->height
> max_y
)
740 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
741 if (row
->fringe_bitmap_periodic_p
)
742 row
->redraw_fringe_bitmaps_p
= 1;
747 /* Mark all rows in current matrices of frame F as invalid. Marking
748 invalid is done by setting enabled_p to zero for all rows in a
752 clear_current_matrices (register struct frame
*f
)
754 /* Clear frame current matrix, if we have one. */
755 if (f
->current_matrix
)
756 clear_glyph_matrix (f
->current_matrix
);
758 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
759 /* Clear the matrix of the menu bar window, if such a window exists.
760 The menu bar window is currently used to display menus on X when
761 no toolkit support is compiled in. */
762 if (WINDOWP (f
->menu_bar_window
))
763 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
766 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
767 /* Clear the matrix of the tool-bar window, if any. */
768 if (WINDOWP (f
->tool_bar_window
))
769 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
772 /* Clear current window matrices. */
773 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
774 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
778 /* Clear out all display lines of F for a coming redisplay. */
781 clear_desired_matrices (register struct frame
*f
)
783 if (f
->desired_matrix
)
784 clear_glyph_matrix (f
->desired_matrix
);
786 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
787 if (WINDOWP (f
->menu_bar_window
))
788 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
791 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
792 if (WINDOWP (f
->tool_bar_window
))
793 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
796 /* Do it for window matrices. */
797 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
798 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
802 /* Clear matrices in window tree rooted in W. If DESIRED_P,
803 clear desired matrices, otherwise clear current matrices. */
806 clear_window_matrices (struct window
*w
, bool desired_p
)
810 if (WINDOWP (w
->contents
))
811 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
815 clear_glyph_matrix (w
->desired_matrix
);
818 clear_glyph_matrix (w
->current_matrix
);
819 w
->window_end_valid
= 0;
823 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
829 /***********************************************************************
832 See dispextern.h for an overall explanation of glyph rows.
833 ***********************************************************************/
835 /* Clear glyph row ROW. NOTE: this code relies on the current
836 layout of `glyphs' and `used' fields of `struct glyph_row'. */
839 clear_glyph_row (struct glyph_row
*row
)
841 enum { off
= offsetof (struct glyph_row
, used
) };
843 /* Zero everything except pointers in `glyphs'. */
844 memset (row
->used
, 0, sizeof *row
- off
);
848 /* Make ROW an empty, enabled row of canonical character height,
849 in window W starting at y-position Y. */
852 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
856 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
857 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
859 clear_glyph_row (row
);
861 row
->ascent
= row
->phys_ascent
= 0;
862 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
863 row
->visible_height
= row
->height
;
866 row
->visible_height
-= min_y
- row
->y
;
867 if (row
->y
+ row
->height
> max_y
)
868 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
870 row
->enabled_p
= true;
874 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
875 are the amounts by which to change positions. Note that the first
876 glyph of the text area of a row can have a buffer position even if
877 the used count of the text area is zero. Such rows display line
881 increment_row_positions (struct glyph_row
*row
,
882 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
886 /* Increment start and end positions. */
887 MATRIX_ROW_START_CHARPOS (row
) += delta
;
888 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
889 MATRIX_ROW_END_CHARPOS (row
) += delta
;
890 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
891 CHARPOS (row
->start
.pos
) += delta
;
892 BYTEPOS (row
->start
.pos
) += delta_bytes
;
893 CHARPOS (row
->end
.pos
) += delta
;
894 BYTEPOS (row
->end
.pos
) += delta_bytes
;
899 /* Increment positions in glyphs. */
900 for (area
= 0; area
< LAST_AREA
; ++area
)
901 for (i
= 0; i
< row
->used
[area
]; ++i
)
902 if (BUFFERP (row
->glyphs
[area
][i
].object
)
903 && row
->glyphs
[area
][i
].charpos
> 0)
904 row
->glyphs
[area
][i
].charpos
+= delta
;
906 /* Capture the case of rows displaying a line end. */
907 if (row
->used
[TEXT_AREA
] == 0
908 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
909 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
914 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
915 contents, i.e. glyph structure contents are exchanged between A and
916 B without changing glyph pointers in A and B. */
919 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
923 for (area
= 0; area
< LAST_AREA
; ++area
)
925 /* Number of glyphs to swap. */
926 int max_used
= max (a
->used
[area
], b
->used
[area
]);
928 /* Start of glyphs in area of row A. */
929 struct glyph
*glyph_a
= a
->glyphs
[area
];
931 /* End + 1 of glyphs in area of row A. */
932 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
934 /* Start of glyphs in area of row B. */
935 struct glyph
*glyph_b
= b
->glyphs
[area
];
937 while (glyph_a
< glyph_a_end
)
939 /* Non-ISO HP/UX compiler doesn't like auto struct
953 /* Exchange pointers to glyph memory between glyph rows A and B. Also
954 exchange the used[] array and the hash values of the rows, because
955 these should all go together for the row's hash value to be
959 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
962 unsigned hash_tem
= a
->hash
;
964 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
966 struct glyph
*temp
= a
->glyphs
[i
];
968 a
->glyphs
[i
] = b
->glyphs
[i
];
972 short used_tem
= a
->used
[i
];
974 a
->used
[i
] = b
->used
[i
];
975 b
->used
[i
] = used_tem
;
983 /* Copy glyph row structure FROM to glyph row structure TO, except that
984 glyph pointers, the `used' counts, and the hash values in the structures
985 are left unchanged. NOTE: this code relies on the current layout of
986 `glyphs', `used', `hash' and `x' fields of `struct glyph_row'. */
989 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
991 enum { off
= offsetof (struct glyph_row
, x
) };
993 memcpy (&to
->x
, &from
->x
, sizeof *to
- off
);
997 /* Assign glyph row FROM to glyph row TO. This works like a structure
998 assignment TO = FROM, except that glyph pointers are not copied but
999 exchanged between TO and FROM. Pointers must be exchanged to avoid
1003 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1005 swap_glyph_pointers (to
, from
);
1006 copy_row_except_pointers (to
, from
);
1010 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1011 a row in a window matrix, is a slice of the glyph memory of the
1012 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1013 is true if the glyph memory of WINDOW_ROW is part of the glyph
1014 memory of FRAME_ROW. */
1019 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1021 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1022 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1023 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1025 return (frame_glyph_start
<= window_glyph_start
1026 && window_glyph_start
< frame_glyph_end
);
1029 #endif /* GLYPH_DEBUG */
1033 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1034 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1035 in WINDOW_MATRIX is found satisfying the condition. */
1037 static struct glyph_row
*
1038 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1039 struct glyph_matrix
*frame_matrix
, int row
)
1043 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1045 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1046 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1047 frame_matrix
->rows
+ row
))
1050 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1055 /* Prepare ROW for display in windows W. Desired rows are cleared
1056 lazily, i.e. they are only marked as to be cleared by setting their
1057 enabled_p flag to zero. When a row is to be displayed, a prior
1058 call to this function really clears it. In addition, this function
1059 makes sure the marginal areas of ROW are in sync with the window's
1060 display margins. MODE_LINE_P non-zero means we are preparing a
1061 glyph row for header line or mode line. */
1064 prepare_desired_row (struct window
*w
, struct glyph_row
*row
, bool mode_line_p
)
1066 if (!row
->enabled_p
)
1068 bool rp
= row
->reversed_p
;
1070 clear_glyph_row (row
);
1071 row
->enabled_p
= true;
1072 row
->reversed_p
= rp
;
1076 /* Mode and header lines, if displayed, never have marginal
1077 areas. If we are called with MODE_LINE_P non-zero, we are
1078 displaying the mode/header line in this window, and so the
1079 marginal areas of this glyph row should be eliminated. This
1080 is needed when the mode/header line is switched on in a
1081 window that has display margins. */
1082 if (w
->left_margin_cols
> 0)
1083 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
1084 if (w
->right_margin_cols
> 0)
1085 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
];
1089 /* The real number of glyphs reserved for the margins is
1090 recorded in the glyph matrix, and can be different from
1091 window's left_margin_cols and right_margin_cols; see
1092 margin_glyphs_to_reserve for when that happens. */
1093 int left
= w
->desired_matrix
->left_margin_glyphs
;
1094 int right
= w
->desired_matrix
->right_margin_glyphs
;
1096 /* Make sure the marginal areas of this row are in sync with
1097 what the window wants, when the row actually displays text
1098 and not header/mode line. */
1099 if (w
->left_margin_cols
> 0
1100 && (left
!= row
->glyphs
[TEXT_AREA
] - row
->glyphs
[LEFT_MARGIN_AREA
]))
1101 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
1102 if (w
->right_margin_cols
> 0
1103 && (right
!= row
->glyphs
[LAST_AREA
] - row
->glyphs
[RIGHT_MARGIN_AREA
]))
1104 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
] - right
;
1109 /* Return a hash code for glyph row ROW, which may
1110 be from current or desired matrix of frame F. */
1113 line_hash_code (struct frame
*f
, struct glyph_row
*row
)
1119 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1120 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1124 int c
= glyph
->u
.ch
;
1125 int face_id
= glyph
->face_id
;
1126 if (FRAME_MUST_WRITE_SPACES (f
))
1128 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1129 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1141 /* Return the cost of drawing line VPOS in MATRIX, which may
1142 be current or desired matrix of frame F. The cost equals
1143 the number of characters in the line. If must_write_spaces
1144 is zero, leading and trailing spaces are ignored. */
1147 line_draw_cost (struct frame
*f
, struct glyph_matrix
*matrix
, int vpos
)
1149 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1150 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1151 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1153 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1154 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1156 /* Ignore trailing and leading spaces if we can. */
1157 if (!FRAME_MUST_WRITE_SPACES (f
))
1159 /* Skip from the end over trailing spaces. */
1160 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1163 /* All blank line. */
1167 /* Skip over leading spaces. */
1168 while (CHAR_GLYPH_SPACE_P (*beg
))
1172 /* If we don't have a glyph-table, each glyph is one character,
1173 so return the number of glyphs. */
1174 if (glyph_table_base
== 0)
1178 /* Otherwise, scan the glyphs and accumulate their total length
1185 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1187 if (GLYPH_INVALID_P (g
)
1188 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1191 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1201 /* Return true if the glyph rows A and B have equal contents.
1202 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1205 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1207 eassert (verify_row_hash (a
));
1208 eassert (verify_row_hash (b
));
1212 else if (a
->hash
!= b
->hash
)
1216 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1219 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1222 /* Compare glyphs. */
1223 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1225 if (a
->used
[area
] != b
->used
[area
])
1228 a_glyph
= a
->glyphs
[area
];
1229 a_end
= a_glyph
+ a
->used
[area
];
1230 b_glyph
= b
->glyphs
[area
];
1232 while (a_glyph
< a_end
1233 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1234 ++a_glyph
, ++b_glyph
;
1236 if (a_glyph
!= a_end
)
1240 if (a
->fill_line_p
!= b
->fill_line_p
1241 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1242 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1243 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1244 || a
->left_fringe_offset
!= b
->left_fringe_offset
1245 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1246 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1247 || a
->right_fringe_offset
!= b
->right_fringe_offset
1248 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1249 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1250 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1251 || a
->overlapped_p
!= b
->overlapped_p
1252 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1253 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1254 || a
->reversed_p
!= b
->reversed_p
1255 /* Different partially visible characters on left margin. */
1257 /* Different height. */
1258 || a
->ascent
!= b
->ascent
1259 || a
->phys_ascent
!= b
->phys_ascent
1260 || a
->phys_height
!= b
->phys_height
1261 || a
->visible_height
!= b
->visible_height
)
1270 /***********************************************************************
1273 See dispextern.h for an overall explanation of glyph pools.
1274 ***********************************************************************/
1276 /* Allocate a glyph_pool structure. The structure returned is initialized
1277 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1278 variable glyph_pool_count is incremented for each pool allocated. */
1280 static struct glyph_pool
*
1281 new_glyph_pool (void)
1283 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1285 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1286 /* For memory leak and double deletion checking. */
1294 /* Free a glyph_pool structure POOL. The function may be called with
1295 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1296 global variable glyph_pool_count is decremented with every pool structure
1297 freed. If this count gets negative, more structures were freed than
1298 allocated, i.e. one structure must have been freed more than once or
1299 a bogus pointer was passed to free_glyph_pool. */
1302 free_glyph_pool (struct glyph_pool
*pool
)
1306 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1307 /* More freed than allocated? */
1309 eassert (glyph_pool_count
>= 0);
1311 xfree (pool
->glyphs
);
1317 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1318 columns we need. This function never shrinks a pool. The only
1319 case in which this would make sense, would be when a frame's size
1320 is changed from a large value to a smaller one. But, if someone
1321 does it once, we can expect that he will do it again.
1323 Return true if the pool changed in a way which makes
1324 re-adjusting window glyph matrices necessary. */
1327 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1332 changed_p
= (pool
->glyphs
== 0
1333 || matrix_dim
.height
!= pool
->nrows
1334 || matrix_dim
.width
!= pool
->ncolumns
);
1336 /* Enlarge the glyph pool. */
1337 needed
= matrix_dim
.width
;
1338 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1339 memory_full (SIZE_MAX
);
1340 needed
*= matrix_dim
.height
;
1341 if (needed
> pool
->nglyphs
)
1343 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1344 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1345 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1346 memset (pool
->glyphs
+ old_nglyphs
, 0,
1347 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1350 /* Remember the number of rows and columns because (a) we use them
1351 to do sanity checks, and (b) the number of columns determines
1352 where rows in the frame matrix start---this must be available to
1353 determine pointers to rows of window sub-matrices. */
1354 pool
->nrows
= matrix_dim
.height
;
1355 pool
->ncolumns
= matrix_dim
.width
;
1362 /***********************************************************************
1364 ***********************************************************************/
1369 /* Flush standard output. This is sometimes useful to call from the debugger.
1370 XXX Maybe this should be changed to flush the current terminal instead of
1374 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1383 /* Check that no glyph pointers have been lost in MATRIX. If a
1384 pointer has been lost, e.g. by using a structure assignment between
1385 rows, at least one pointer must occur more than once in the rows of
1389 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1393 for (i
= 0; i
< matrix
->nrows
; ++i
)
1394 for (j
= 0; j
< matrix
->nrows
; ++j
)
1396 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1397 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1401 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1404 matrix_row (struct glyph_matrix
*matrix
, int row
)
1406 eassert (matrix
&& matrix
->rows
);
1407 eassert (row
>= 0 && row
< matrix
->nrows
);
1409 /* That's really too slow for normal testing because this function
1410 is called almost everywhere. Although---it's still astonishingly
1411 fast, so it is valuable to have for debugging purposes. */
1413 check_matrix_pointer_lossage (matrix
);
1416 return matrix
->rows
+ row
;
1420 #if 0 /* This function makes invalid assumptions when text is
1421 partially invisible. But it might come handy for debugging
1424 /* Check invariants that must hold for an up to date current matrix of
1428 check_matrix_invariants (struct window
*w
)
1430 struct glyph_matrix
*matrix
= w
->current_matrix
;
1431 int yb
= window_text_bottom_y (w
);
1432 struct glyph_row
*row
= matrix
->rows
;
1433 struct glyph_row
*last_text_row
= NULL
;
1434 struct buffer
*saved
= current_buffer
;
1435 struct buffer
*buffer
= XBUFFER (w
->contents
);
1438 /* This can sometimes happen for a fresh window. */
1439 if (matrix
->nrows
< 2)
1442 set_buffer_temp (buffer
);
1444 /* Note: last row is always reserved for the mode line. */
1445 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1446 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1448 struct glyph_row
*next
= row
+ 1;
1450 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1451 last_text_row
= row
;
1453 /* Check that character and byte positions are in sync. */
1454 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1455 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1456 eassert (BYTEPOS (row
->start
.pos
)
1457 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1459 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1460 have such a position temporarily in case of a minibuffer
1461 displaying something like `[Sole completion]' at its end. */
1462 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1464 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1465 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1466 eassert (BYTEPOS (row
->end
.pos
)
1467 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1470 /* Check that end position of `row' is equal to start position
1472 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1474 eassert (MATRIX_ROW_END_CHARPOS (row
)
1475 == MATRIX_ROW_START_CHARPOS (next
));
1476 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1477 == MATRIX_ROW_START_BYTEPOS (next
));
1478 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1479 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1484 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1485 eassert (w
->desired_matrix
->rows
!= NULL
);
1486 set_buffer_temp (saved
);
1491 #endif /* GLYPH_DEBUG */
1495 /**********************************************************************
1496 Allocating/ Adjusting Glyph Matrices
1497 **********************************************************************/
1499 /* Allocate glyph matrices over a window tree for a frame-based
1502 X and Y are column/row within the frame glyph matrix where
1503 sub-matrices for the window tree rooted at WINDOW must be
1504 allocated. DIM_ONLY_P means that the caller of this
1505 function is only interested in the result matrix dimension, and
1506 matrix adjustments should not be performed.
1508 The function returns the total width/height of the sub-matrices of
1509 the window tree. If called on a frame root window, the computation
1510 will take the mini-buffer window into account.
1512 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1514 NEW_LEAF_MATRIX set if any window in the tree did not have a
1515 glyph matrices yet, and
1517 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1518 any window in the tree will be changed or have been changed (see
1521 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1524 Windows are arranged into chains of windows on the same level
1525 through the next fields of window structures. Such a level can be
1526 either a sequence of horizontally adjacent windows from left to
1527 right, or a sequence of vertically adjacent windows from top to
1528 bottom. Each window in a horizontal sequence can be either a leaf
1529 window or a vertical sequence; a window in a vertical sequence can
1530 be either a leaf or a horizontal sequence. All windows in a
1531 horizontal sequence have the same height, and all windows in a
1532 vertical sequence have the same width.
1534 This function uses, for historical reasons, a more general
1535 algorithm to determine glyph matrix dimensions that would be
1538 The matrix height of a horizontal sequence is determined by the
1539 maximum height of any matrix in the sequence. The matrix width of
1540 a horizontal sequence is computed by adding up matrix widths of
1541 windows in the sequence.
1543 |<------- result width ------->|
1544 +---------+----------+---------+ ---
1547 +---------+ | | result height
1552 The matrix width of a vertical sequence is the maximum matrix width
1553 of any window in the sequence. Its height is computed by adding up
1554 matrix heights of windows in the sequence.
1556 |<---- result width -->|
1564 +------------+---------+ |
1567 +------------+---------+ --- */
1569 /* Bit indicating that a new matrix will be allocated or has been
1572 #define NEW_LEAF_MATRIX (1 << 0)
1574 /* Bit indicating that a matrix will or has changed its location or
1577 #define CHANGED_LEAF_MATRIX (1 << 1)
1580 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1581 bool dim_only_p
, int *window_change_flags
)
1583 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1585 int wmax
= 0, hmax
= 0;
1589 bool in_horz_combination_p
;
1591 /* What combination is WINDOW part of? Compute this once since the
1592 result is the same for all windows in the `next' chain. The
1593 special case of a root window (parent equal to nil) is treated
1594 like a vertical combination because a root window's `next'
1595 points to the mini-buffer window, if any, which is arranged
1596 vertically below other windows. */
1597 in_horz_combination_p
1598 = (!NILP (XWINDOW (window
)->parent
)
1599 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1601 /* For WINDOW and all windows on the same level. */
1604 w
= XWINDOW (window
);
1606 /* Get the dimension of the window sub-matrix for W, depending
1607 on whether this is a combination or a leaf window. */
1608 if (WINDOWP (w
->contents
))
1609 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1611 window_change_flags
);
1614 /* If not already done, allocate sub-matrix structures. */
1615 if (w
->desired_matrix
== NULL
)
1617 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1618 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1619 *window_change_flags
|= NEW_LEAF_MATRIX
;
1622 /* Width and height MUST be chosen so that there are no
1623 holes in the frame matrix. */
1624 dim
.width
= required_matrix_width (w
);
1625 dim
.height
= required_matrix_height (w
);
1627 /* Will matrix be re-allocated? */
1628 if (x
!= w
->desired_matrix
->matrix_x
1629 || y
!= w
->desired_matrix
->matrix_y
1630 || dim
.width
!= w
->desired_matrix
->matrix_w
1631 || dim
.height
!= w
->desired_matrix
->matrix_h
1632 || (margin_glyphs_to_reserve (w
, dim
.width
,
1633 w
->left_margin_cols
)
1634 != w
->desired_matrix
->left_margin_glyphs
)
1635 || (margin_glyphs_to_reserve (w
, dim
.width
,
1636 w
->right_margin_cols
)
1637 != w
->desired_matrix
->right_margin_glyphs
))
1638 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1640 /* Actually change matrices, if allowed. Do not consider
1641 CHANGED_LEAF_MATRIX computed above here because the pool
1642 may have been changed which we don't know here. We trust
1643 that we only will be called with DIM_ONLY_P when
1647 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1648 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1652 /* If we are part of a horizontal combination, advance x for
1653 windows to the right of W; otherwise advance y for windows
1655 if (in_horz_combination_p
)
1660 /* Remember maximum glyph matrix dimensions. */
1661 wmax
= max (wmax
, dim
.width
);
1662 hmax
= max (hmax
, dim
.height
);
1664 /* Next window on same level. */
1667 while (!NILP (window
));
1669 /* Set `total' to the total glyph matrix dimension of this window
1670 level. In a vertical combination, the width is the width of the
1671 widest window; the height is the y we finally reached, corrected
1672 by the y we started with. In a horizontal combination, the total
1673 height is the height of the tallest window, and the width is the
1674 x we finally reached, corrected by the x we started with. */
1675 if (in_horz_combination_p
)
1677 total
.width
= x
- x0
;
1678 total
.height
= hmax
;
1683 total
.height
= y
- y0
;
1690 /* Return the required height of glyph matrices for window W. */
1693 required_matrix_height (struct window
*w
)
1695 #ifdef HAVE_WINDOW_SYSTEM
1696 struct frame
*f
= XFRAME (w
->frame
);
1698 if (FRAME_WINDOW_P (f
))
1700 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1701 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1703 return (((window_pixel_height
+ ch_height
- 1)
1704 / ch_height
) * w
->nrows_scale_factor
1705 /* One partially visible line at the top and
1706 bottom of the window. */
1708 /* 2 for header and mode line. */
1711 #endif /* HAVE_WINDOW_SYSTEM */
1713 return WINDOW_TOTAL_LINES (w
);
1717 /* Return the required width of glyph matrices for window W. */
1720 required_matrix_width (struct window
*w
)
1722 #ifdef HAVE_WINDOW_SYSTEM
1723 struct frame
*f
= XFRAME (w
->frame
);
1724 if (FRAME_WINDOW_P (f
))
1726 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1728 /* Compute number of glyphs needed in a glyph row. */
1729 return (((WINDOW_PIXEL_WIDTH (w
) + ch_width
- 1)
1730 / ch_width
) * w
->ncols_scale_factor
1731 /* 2 partially visible columns in the text area. */
1733 /* One partially visible column at the right
1734 edge of each marginal area. */
1737 #endif /* HAVE_WINDOW_SYSTEM */
1739 return w
->total_cols
;
1743 /* Allocate window matrices for window-based redisplay. W is the
1744 window whose matrices must be allocated/reallocated. */
1747 allocate_matrices_for_window_redisplay (struct window
*w
)
1751 if (WINDOWP (w
->contents
))
1752 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1755 /* W is a leaf window. */
1758 /* If matrices are not yet allocated, allocate them now. */
1759 if (w
->desired_matrix
== NULL
)
1761 w
->desired_matrix
= new_glyph_matrix (NULL
);
1762 w
->current_matrix
= new_glyph_matrix (NULL
);
1765 dim
.width
= required_matrix_width (w
);
1766 dim
.height
= required_matrix_height (w
);
1767 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1768 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1771 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1775 /* Allocate/reallocate glyph matrices of a single frame F.
1776 This function must be called when a new frame is created,
1777 its size changes, or its window configuration changes. */
1780 adjust_frame_glyphs (struct frame
*f
)
1782 /* Block input so that expose events and other events that access
1783 glyph matrices are not processed while we are changing them. */
1786 if (FRAME_WINDOW_P (f
))
1787 adjust_frame_glyphs_for_window_redisplay (f
);
1789 adjust_frame_glyphs_for_frame_redisplay (f
);
1791 /* Don't forget the buffer for decode_mode_spec. */
1792 adjust_decode_mode_spec_buffer (f
);
1794 f
->glyphs_initialized_p
= 1;
1799 /* Return true if any window in the tree has nonzero window margins. See
1800 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1802 showing_window_margins_p (struct window
*w
)
1806 if (WINDOWP (w
->contents
))
1808 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1811 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1814 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1820 /* In the window tree with root W, build current matrices of leaf
1821 windows from the frame's current matrix. */
1824 fake_current_matrices (Lisp_Object window
)
1828 for (; !NILP (window
); window
= w
->next
)
1830 w
= XWINDOW (window
);
1832 if (WINDOWP (w
->contents
))
1833 fake_current_matrices (w
->contents
);
1837 struct frame
*f
= XFRAME (w
->frame
);
1838 struct glyph_matrix
*m
= w
->current_matrix
;
1839 struct glyph_matrix
*fm
= f
->current_matrix
;
1841 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1842 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1844 for (i
= 0; i
< m
->matrix_h
; ++i
)
1846 struct glyph_row
*r
= m
->rows
+ i
;
1847 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1849 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1850 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1852 r
->enabled_p
= fr
->enabled_p
;
1855 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1856 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1857 r
->used
[TEXT_AREA
] = (m
->matrix_w
1858 - r
->used
[LEFT_MARGIN_AREA
]
1859 - r
->used
[RIGHT_MARGIN_AREA
]);
1868 /* Save away the contents of frame F's current frame matrix. Value is
1869 a glyph matrix holding the contents of F's current frame matrix. */
1871 static struct glyph_matrix
*
1872 save_current_matrix (struct frame
*f
)
1875 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1876 saved
->nrows
= f
->current_matrix
->nrows
;
1877 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1879 for (i
= 0; i
< saved
->nrows
; ++i
)
1881 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1882 struct glyph_row
*to
= saved
->rows
+ i
;
1883 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1885 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1886 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1887 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1888 to
->enabled_p
= from
->enabled_p
;
1889 to
->hash
= from
->hash
;
1890 if (from
->used
[LEFT_MARGIN_AREA
])
1892 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1893 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1894 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1895 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1896 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1898 if (from
->used
[RIGHT_MARGIN_AREA
])
1900 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1901 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1902 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1903 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1904 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1912 /* Restore the contents of frame F's current frame matrix from SAVED,
1913 and free memory associated with SAVED. */
1916 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1920 for (i
= 0; i
< saved
->nrows
; ++i
)
1922 struct glyph_row
*from
= saved
->rows
+ i
;
1923 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1924 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1926 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1927 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1928 xfree (from
->glyphs
[TEXT_AREA
]);
1929 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1932 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1933 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1934 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1935 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1938 to
->used
[LEFT_MARGIN_AREA
] = 0;
1939 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1942 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1943 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1944 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1945 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1948 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1951 xfree (saved
->rows
);
1957 /* Allocate/reallocate glyph matrices of a single frame F for
1958 frame-based redisplay. */
1961 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1963 struct dim matrix_dim
;
1964 bool pool_changed_p
;
1965 int window_change_flags
;
1968 if (!FRAME_LIVE_P (f
))
1971 top_window_y
= FRAME_TOP_MARGIN (f
);
1973 /* Allocate glyph pool structures if not already done. */
1974 if (f
->desired_pool
== NULL
)
1976 f
->desired_pool
= new_glyph_pool ();
1977 f
->current_pool
= new_glyph_pool ();
1980 /* Allocate frames matrix structures if needed. */
1981 if (f
->desired_matrix
== NULL
)
1983 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1984 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1987 /* Compute window glyph matrices. (This takes the mini-buffer
1988 window into account). The result is the size of the frame glyph
1989 matrix needed. The variable window_change_flags is set to a bit
1990 mask indicating whether new matrices will be allocated or
1991 existing matrices change their size or location within the frame
1993 window_change_flags
= 0;
1995 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1998 &window_change_flags
);
2000 /* Add in menu bar lines, if any. */
2001 matrix_dim
.height
+= top_window_y
;
2003 /* Enlarge pools as necessary. */
2004 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2005 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2007 /* Set up glyph pointers within window matrices. Do this only if
2008 absolutely necessary since it requires a frame redraw. */
2009 if (pool_changed_p
|| window_change_flags
)
2011 /* Do it for window matrices. */
2012 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2014 &window_change_flags
);
2016 /* Size of frame matrices must equal size of frame. Note
2017 that we are called for X frames with window widths NOT equal
2018 to the frame width (from CHANGE_FRAME_SIZE_1). */
2019 if (matrix_dim
.width
!= FRAME_TOTAL_COLS (f
)
2020 || matrix_dim
.height
!= FRAME_TOTAL_LINES (f
))
2023 eassert (matrix_dim
.width
== FRAME_TOTAL_COLS (f
)
2024 && matrix_dim
.height
== FRAME_TOTAL_LINES (f
));
2026 /* Pointers to glyph memory in glyph rows are exchanged during
2027 the update phase of redisplay, which means in general that a
2028 frame's current matrix consists of pointers into both the
2029 desired and current glyph pool of the frame. Adjusting a
2030 matrix sets the frame matrix up so that pointers are all into
2031 the same pool. If we want to preserve glyph contents of the
2032 current matrix over a call to adjust_glyph_matrix, we must
2033 make a copy of the current glyphs, and restore the current
2034 matrix' contents from that copy. */
2035 if (display_completed
2036 && !FRAME_GARBAGED_P (f
)
2037 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2038 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2039 /* For some reason, the frame glyph matrix gets corrupted if
2040 any of the windows contain margins. I haven't been able
2041 to hunt down the reason, but for the moment this prevents
2042 the problem from manifesting. -- cyd */
2043 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2045 struct glyph_matrix
*copy
= save_current_matrix (f
);
2046 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2047 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2048 restore_current_matrix (f
, copy
);
2049 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2053 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2054 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2055 SET_FRAME_GARBAGED (f
);
2061 /* Allocate/reallocate glyph matrices of a single frame F for
2062 window-based redisplay. */
2065 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2067 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2069 /* Allocate/reallocate window matrices. */
2070 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2072 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2073 /* Allocate/ reallocate matrices of the dummy window used to display
2074 the menu bar under X when no X toolkit support is available. */
2076 /* Allocate a dummy window if not already done. */
2078 if (NILP (f
->menu_bar_window
))
2081 fset_menu_bar_window (f
, make_window ());
2082 w
= XWINDOW (f
->menu_bar_window
);
2083 XSETFRAME (frame
, f
);
2084 wset_frame (w
, frame
);
2085 w
->pseudo_window_p
= 1;
2088 w
= XWINDOW (f
->menu_bar_window
);
2090 /* Set window dimensions to frame dimensions and allocate or
2091 adjust glyph matrices of W. */
2096 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2097 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2098 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2099 w
->pixel_height
= FRAME_MENU_BAR_HEIGHT (f
);
2100 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2101 allocate_matrices_for_window_redisplay (w
);
2105 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2107 /* Allocate/ reallocate matrices of the tool bar window. If we
2108 don't have a tool bar window yet, make one. */
2110 if (NILP (f
->tool_bar_window
))
2113 fset_tool_bar_window (f
, make_window ());
2114 w
= XWINDOW (f
->tool_bar_window
);
2115 XSETFRAME (frame
, f
);
2116 wset_frame (w
, frame
);
2117 w
->pseudo_window_p
= 1;
2120 w
= XWINDOW (f
->tool_bar_window
);
2124 w
->pixel_top
= FRAME_MENU_BAR_HEIGHT (f
);
2125 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2126 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2127 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2128 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2129 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2130 w
->pixel_height
= FRAME_TOOL_BAR_HEIGHT (f
);
2131 allocate_matrices_for_window_redisplay (w
);
2137 /* Re-allocate buffer for decode_mode_spec on frame F. */
2140 adjust_decode_mode_spec_buffer (struct frame
*f
)
2142 int frame_message_buf_size
= FRAME_MESSAGE_BUF_SIZE (f
);
2144 eassert (frame_message_buf_size
>= 0);
2145 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2146 frame_message_buf_size
+ 1);
2151 /**********************************************************************
2152 Freeing Glyph Matrices
2153 **********************************************************************/
2155 /* Free glyph memory for a frame F. F may be null. This function can
2156 be called for the same frame more than once. The root window of
2157 F may be nil when this function is called. This is the case when
2158 the function is called when F is destroyed. */
2161 free_glyphs (struct frame
*f
)
2163 if (f
&& f
->glyphs_initialized_p
)
2165 /* Block interrupt input so that we don't get surprised by an X
2166 event while we're in an inconsistent state. */
2168 f
->glyphs_initialized_p
= 0;
2170 /* Release window sub-matrices. */
2171 if (!NILP (f
->root_window
))
2172 free_window_matrices (XWINDOW (f
->root_window
));
2174 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2175 /* Free the dummy window for menu bars without X toolkit and its
2177 if (!NILP (f
->menu_bar_window
))
2179 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2180 free_glyph_matrix (w
->desired_matrix
);
2181 free_glyph_matrix (w
->current_matrix
);
2182 w
->desired_matrix
= w
->current_matrix
= NULL
;
2183 fset_menu_bar_window (f
, Qnil
);
2187 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2188 /* Free the tool bar window and its glyph matrices. */
2189 if (!NILP (f
->tool_bar_window
))
2191 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2192 free_glyph_matrix (w
->desired_matrix
);
2193 free_glyph_matrix (w
->current_matrix
);
2194 w
->desired_matrix
= w
->current_matrix
= NULL
;
2195 fset_tool_bar_window (f
, Qnil
);
2199 /* Release frame glyph matrices. Reset fields to zero in
2200 case we are called a second time. */
2201 if (f
->desired_matrix
)
2203 free_glyph_matrix (f
->desired_matrix
);
2204 free_glyph_matrix (f
->current_matrix
);
2205 f
->desired_matrix
= f
->current_matrix
= NULL
;
2208 /* Release glyph pools. */
2209 if (f
->desired_pool
)
2211 free_glyph_pool (f
->desired_pool
);
2212 free_glyph_pool (f
->current_pool
);
2213 f
->desired_pool
= f
->current_pool
= NULL
;
2221 /* Free glyph sub-matrices in the window tree rooted at W. This
2222 function may be called with a null pointer, and it may be called on
2223 the same tree more than once. */
2226 free_window_matrices (struct window
*w
)
2230 if (WINDOWP (w
->contents
))
2231 free_window_matrices (XWINDOW (w
->contents
));
2234 /* This is a leaf window. Free its memory and reset fields
2235 to zero in case this function is called a second time for
2237 free_glyph_matrix (w
->current_matrix
);
2238 free_glyph_matrix (w
->desired_matrix
);
2239 w
->current_matrix
= w
->desired_matrix
= NULL
;
2242 /* Next window on same level. */
2243 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2248 /* Check glyph memory leaks. This function is called from
2249 shut_down_emacs. Note that frames are not destroyed when Emacs
2250 exits. We therefore free all glyph memory for all active frames
2251 explicitly and check that nothing is left allocated. */
2254 check_glyph_memory (void)
2256 Lisp_Object tail
, frame
;
2258 /* Free glyph memory for all frames. */
2259 FOR_EACH_FRAME (tail
, frame
)
2260 free_glyphs (XFRAME (frame
));
2262 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2263 /* Check that nothing is left allocated. */
2264 eassert (glyph_matrix_count
== 0);
2265 eassert (glyph_pool_count
== 0);
2271 /**********************************************************************
2272 Building a Frame Matrix
2273 **********************************************************************/
2275 /* Most of the redisplay code works on glyph matrices attached to
2276 windows. This is a good solution most of the time, but it is not
2277 suitable for terminal code. Terminal output functions cannot rely
2278 on being able to set an arbitrary terminal window. Instead they
2279 must be provided with a view of the whole frame, i.e. the whole
2280 screen. We build such a view by constructing a frame matrix from
2281 window matrices in this section.
2283 Windows that must be updated have their must_be_updated_p flag set.
2284 For all such windows, their desired matrix is made part of the
2285 desired frame matrix. For other windows, their current matrix is
2286 made part of the desired frame matrix.
2288 +-----------------+----------------+
2289 | desired | desired |
2291 +-----------------+----------------+
2294 +----------------------------------+
2296 Desired window matrices can be made part of the frame matrix in a
2297 cheap way: We exploit the fact that the desired frame matrix and
2298 desired window matrices share their glyph memory. This is not
2299 possible for current window matrices. Their glyphs are copied to
2300 the desired frame matrix. The latter is equivalent to
2301 preserve_other_columns in the old redisplay.
2303 Used glyphs counters for frame matrix rows are the result of adding
2304 up glyph lengths of the window matrices. A line in the frame
2305 matrix is enabled, if a corresponding line in a window matrix is
2308 After building the desired frame matrix, it will be passed to
2309 terminal code, which will manipulate both the desired and current
2310 frame matrix. Changes applied to the frame's current matrix have
2311 to be visible in current window matrices afterwards, of course.
2313 This problem is solved like this:
2315 1. Window and frame matrices share glyphs. Window matrices are
2316 constructed in a way that their glyph contents ARE the glyph
2317 contents needed in a frame matrix. Thus, any modification of
2318 glyphs done in terminal code will be reflected in window matrices
2321 2. Exchanges of rows in a frame matrix done by terminal code are
2322 intercepted by hook functions so that corresponding row operations
2323 on window matrices can be performed. This is necessary because we
2324 use pointers to glyphs in glyph row structures. To satisfy the
2325 assumption of point 1 above that glyphs are updated implicitly in
2326 window matrices when they are manipulated via the frame matrix,
2327 window and frame matrix must of course agree where to find the
2328 glyphs for their rows. Possible manipulations that must be
2329 mirrored are assignments of rows of the desired frame matrix to the
2330 current frame matrix and scrolling the current frame matrix. */
2332 /* Build frame F's desired matrix from window matrices. Only windows
2333 which have the flag must_be_updated_p set have to be updated. Menu
2334 bar lines of a frame are not covered by window matrices, so make
2335 sure not to touch them in this function. */
2338 build_frame_matrix (struct frame
*f
)
2342 /* F must have a frame matrix when this function is called. */
2343 eassert (!FRAME_WINDOW_P (f
));
2345 /* Clear all rows in the frame matrix covered by window matrices.
2346 Menu bar lines are not covered by windows. */
2347 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2348 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2350 /* Build the matrix by walking the window tree. */
2351 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2352 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2356 /* Walk a window tree, building a frame matrix MATRIX from window
2357 matrices. W is the root of a window tree. */
2360 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2364 if (WINDOWP (w
->contents
))
2365 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2367 build_frame_matrix_from_leaf_window (matrix
, w
);
2369 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2374 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2375 desired frame matrix built. W is a leaf window whose desired or
2376 current matrix is to be added to FRAME_MATRIX. W's flag
2377 must_be_updated_p determines which matrix it contributes to
2378 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2379 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2380 Adding a desired matrix means setting up used counters and such in
2381 frame rows, while adding a current window matrix to FRAME_MATRIX
2382 means copying glyphs. The latter case corresponds to
2383 preserve_other_columns in the old redisplay. */
2386 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2388 struct glyph_matrix
*window_matrix
;
2389 int window_y
, frame_y
;
2390 /* If non-zero, a glyph to insert at the right border of W. */
2391 GLYPH right_border_glyph
;
2393 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2395 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2396 if (w
->must_be_updated_p
)
2398 window_matrix
= w
->desired_matrix
;
2400 /* Decide whether we want to add a vertical border glyph. */
2401 if (!WINDOW_RIGHTMOST_P (w
))
2403 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2406 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2408 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2410 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2411 spec_glyph_lookup_face (w
, &right_border_glyph
);
2414 if (GLYPH_FACE (right_border_glyph
) <= 0)
2415 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2419 window_matrix
= w
->current_matrix
;
2421 /* For all rows in the window matrix and corresponding rows in the
2424 frame_y
= window_matrix
->matrix_y
;
2425 while (window_y
< window_matrix
->nrows
)
2427 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2428 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2429 bool current_row_p
= window_matrix
== w
->current_matrix
;
2431 /* Fill up the frame row with spaces up to the left margin of the
2433 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2435 /* Fill up areas in the window matrix row with spaces. */
2436 fill_up_glyph_row_with_spaces (window_row
);
2438 /* If only part of W's desired matrix has been built, and
2439 window_row wasn't displayed, use the corresponding current
2441 if (window_matrix
== w
->desired_matrix
2442 && !window_row
->enabled_p
)
2444 window_row
= w
->current_matrix
->rows
+ window_y
;
2450 /* Copy window row to frame row. */
2451 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2452 window_row
->glyphs
[0],
2453 window_matrix
->matrix_w
* sizeof (struct glyph
));
2457 eassert (window_row
->enabled_p
);
2459 /* Only when a desired row has been displayed, we want
2460 the corresponding frame row to be updated. */
2461 frame_row
->enabled_p
= true;
2463 /* Maybe insert a vertical border between horizontally adjacent
2465 if (GLYPH_CHAR (right_border_glyph
) != 0)
2467 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2468 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2472 /* Window row window_y must be a slice of frame row
2474 eassert (glyph_row_slice_p (window_row
, frame_row
));
2476 /* If rows are in sync, we don't have to copy glyphs because
2477 frame and window share glyphs. */
2479 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2480 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2484 /* Set number of used glyphs in the frame matrix. Since we fill
2485 up with spaces, and visit leaf windows from left to right it
2486 can be done simply. */
2487 frame_row
->used
[TEXT_AREA
]
2488 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2496 /* Given a user-specified glyph, possibly including a Lisp-level face
2497 ID, return a glyph that has a realized face ID.
2498 This is used for glyphs displayed specially and not part of the text;
2499 for instance, vertical separators, truncation markers, etc. */
2502 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2504 int lface_id
= GLYPH_FACE (*glyph
);
2505 /* Convert the glyph's specified face to a realized (cache) face. */
2508 int face_id
= merge_faces (XFRAME (w
->frame
),
2509 Qt
, lface_id
, DEFAULT_FACE_ID
);
2510 SET_GLYPH_FACE (*glyph
, face_id
);
2514 /* Add spaces to a glyph row ROW in a window matrix.
2516 Each row has the form:
2518 +---------+-----------------------------+------------+
2519 | left | text | right |
2520 +---------+-----------------------------+------------+
2522 Left and right marginal areas are optional. This function adds
2523 spaces to areas so that there are no empty holes between areas.
2524 In other words: If the right area is not empty, the text area
2525 is filled up with spaces up to the right area. If the text area
2526 is not empty, the left area is filled up.
2528 To be called for frame-based redisplay, only. */
2531 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2533 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2534 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2535 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2539 /* Fill area AREA of glyph row ROW with spaces. To be called for
2540 frame-based redisplay only. */
2543 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2545 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2547 struct glyph
*end
= row
->glyphs
[area
+ 1];
2548 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2551 *text
++ = space_glyph
;
2552 row
->used
[area
] = text
- row
->glyphs
[area
];
2557 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2558 reached. In frame matrices only one area, TEXT_AREA, is used. */
2561 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2563 int i
= row
->used
[TEXT_AREA
];
2564 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2567 glyph
[i
++] = space_glyph
;
2569 row
->used
[TEXT_AREA
] = i
;
2574 /**********************************************************************
2575 Mirroring operations on frame matrices in window matrices
2576 **********************************************************************/
2578 /* Set frame being updated via frame-based redisplay to F. This
2579 function must be called before updates to make explicit that we are
2580 working on frame matrices or not. */
2583 set_frame_matrix_frame (struct frame
*f
)
2585 frame_matrix_frame
= f
;
2589 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2590 DESIRED_MATRIX is the desired matrix corresponding to
2591 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2592 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2593 frame_matrix_frame is non-null, this indicates that the exchange is
2594 done in frame matrices, and that we have to perform analogous
2595 operations in window matrices of frame_matrix_frame. */
2598 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2600 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2601 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2602 bool mouse_face_p
= current_row
->mouse_face_p
;
2604 /* Do current_row = desired_row. This exchanges glyph pointers
2605 between both rows, and does a structure assignment otherwise. */
2606 assign_row (current_row
, desired_row
);
2608 /* Enable current_row to mark it as valid. */
2609 current_row
->enabled_p
= true;
2610 current_row
->mouse_face_p
= mouse_face_p
;
2612 /* If we are called on frame matrices, perform analogous operations
2613 for window matrices. */
2614 if (frame_matrix_frame
)
2615 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2619 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2620 W's frame which has been made current (by swapping pointers between
2621 current and desired matrix). Perform analogous operations in the
2622 matrices of leaf windows in the window tree rooted at W. */
2625 mirror_make_current (struct window
*w
, int frame_row
)
2629 if (WINDOWP (w
->contents
))
2630 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2633 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2634 here because the checks performed in debug mode there
2635 will not allow the conversion. */
2636 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2638 /* If FRAME_ROW is within W, assign the desired row to the
2639 current row (exchanging glyph pointers). */
2640 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2642 struct glyph_row
*current_row
2643 = MATRIX_ROW (w
->current_matrix
, row
);
2644 struct glyph_row
*desired_row
2645 = MATRIX_ROW (w
->desired_matrix
, row
);
2647 if (desired_row
->enabled_p
)
2648 assign_row (current_row
, desired_row
);
2650 swap_glyph_pointers (desired_row
, current_row
);
2651 current_row
->enabled_p
= true;
2653 /* Set the Y coordinate of the mode/header line's row.
2654 It is needed in draw_row_with_mouse_face to find the
2655 screen coordinates. (Window-based redisplay sets
2656 this in update_window, but no one seems to do that
2657 for frame-based redisplay.) */
2658 if (current_row
->mode_line_p
)
2659 current_row
->y
= row
;
2663 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2668 /* Perform row dance after scrolling. We are working on the range of
2669 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2670 including) in MATRIX. COPY_FROM is a vector containing, for each
2671 row I in the range 0 <= I < NLINES, the index of the original line
2672 to move to I. This index is relative to the row range, i.e. 0 <=
2673 index < NLINES. RETAINED_P is a vector containing zero for each
2674 row 0 <= I < NLINES which is empty.
2676 This function is called from do_scrolling and do_direct_scrolling. */
2679 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2680 int *copy_from
, char *retained_p
)
2682 /* A copy of original rows. */
2683 struct glyph_row
*old_rows
;
2685 /* Rows to assign to. */
2686 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2690 /* Make a copy of the original rows. */
2692 SAFE_NALLOCA (old_rows
, 1, nlines
);
2693 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2695 /* Assign new rows, maybe clear lines. */
2696 for (i
= 0; i
< nlines
; ++i
)
2698 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2700 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2701 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2702 new_rows
[i
] = old_rows
[copy_from
[i
]];
2703 new_rows
[i
].enabled_p
= enabled_before_p
;
2705 /* RETAINED_P is zero for empty lines. */
2706 if (!retained_p
[copy_from
[i
]])
2707 new_rows
[i
].enabled_p
= false;
2710 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2711 if (frame_matrix_frame
)
2712 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2713 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2719 /* Synchronize glyph pointers in the current matrix of window W with
2720 the current frame matrix. */
2723 sync_window_with_frame_matrix_rows (struct window
*w
)
2725 struct frame
*f
= XFRAME (w
->frame
);
2726 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2727 int left
, right
, x
, width
;
2729 /* Preconditions: W must be a live window on a tty frame. */
2730 eassert (BUFFERP (w
->contents
));
2731 eassert (!FRAME_WINDOW_P (f
));
2733 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2734 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2735 x
= w
->current_matrix
->matrix_x
;
2736 width
= w
->current_matrix
->matrix_w
;
2738 window_row
= w
->current_matrix
->rows
;
2739 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2740 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2742 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2744 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2745 = frame_row
->glyphs
[0] + x
;
2746 window_row
->glyphs
[TEXT_AREA
]
2747 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2748 window_row
->glyphs
[LAST_AREA
]
2749 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2750 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2751 = window_row
->glyphs
[LAST_AREA
] - right
;
2756 /* Return the window in the window tree rooted in W containing frame
2757 row ROW. Value is null if none is found. */
2759 static struct window
*
2760 frame_row_to_window (struct window
*w
, int row
)
2762 struct window
*found
= NULL
;
2766 if (WINDOWP (w
->contents
))
2767 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2768 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2769 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2772 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2779 /* Perform a line dance in the window tree rooted at W, after
2780 scrolling a frame matrix in mirrored_line_dance.
2782 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2783 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2784 COPY_FROM is a vector containing, for each row I in the range 0 <=
2785 I < NLINES, the index of the original line to move to I. This
2786 index is relative to the row range, i.e. 0 <= index < NLINES.
2787 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2791 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2795 if (WINDOWP (w
->contents
))
2796 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2797 nlines
, copy_from
, retained_p
);
2800 /* W is a leaf window, and we are working on its current
2802 struct glyph_matrix
*m
= w
->current_matrix
;
2805 struct glyph_row
*old_rows
;
2807 /* Make a copy of the original rows of matrix m. */
2809 SAFE_NALLOCA (old_rows
, 1, m
->nrows
);
2810 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2812 for (i
= 0; i
< nlines
; ++i
)
2814 /* Frame relative line assigned to. */
2815 int frame_to
= i
+ unchanged_at_top
;
2817 /* Frame relative line assigned. */
2818 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2820 /* Window relative line assigned to. */
2821 int window_to
= frame_to
- m
->matrix_y
;
2823 /* Window relative line assigned. */
2824 int window_from
= frame_from
- m
->matrix_y
;
2826 /* Is assigned line inside window? */
2827 bool from_inside_window_p
2828 = window_from
>= 0 && window_from
< m
->matrix_h
;
2830 /* Is assigned to line inside window? */
2831 bool to_inside_window_p
2832 = window_to
>= 0 && window_to
< m
->matrix_h
;
2834 if (from_inside_window_p
&& to_inside_window_p
)
2836 /* Do the assignment. The enabled_p flag is saved
2837 over the assignment because the old redisplay did
2839 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2840 m
->rows
[window_to
] = old_rows
[window_from
];
2841 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2843 /* If frame line is empty, window line is empty, too. */
2844 if (!retained_p
[copy_from
[i
]])
2845 m
->rows
[window_to
].enabled_p
= false;
2847 else if (to_inside_window_p
)
2849 /* A copy between windows. This is an infrequent
2850 case not worth optimizing. */
2851 struct frame
*f
= XFRAME (w
->frame
);
2852 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2854 struct glyph_matrix
*m2
;
2857 w2
= frame_row_to_window (root
, frame_from
);
2858 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2859 -nw', FROM_FRAME sometimes has no associated window.
2860 This check avoids a segfault if W2 is null. */
2863 m2
= w2
->current_matrix
;
2864 m2_from
= frame_from
- m2
->matrix_y
;
2865 copy_row_except_pointers (m
->rows
+ window_to
,
2866 m2
->rows
+ m2_from
);
2868 /* If frame line is empty, window line is empty, too. */
2869 if (!retained_p
[copy_from
[i
]])
2870 m
->rows
[window_to
].enabled_p
= false;
2874 else if (from_inside_window_p
)
2878 /* If there was a copy between windows, make sure glyph
2879 pointers are in sync with the frame matrix. */
2881 sync_window_with_frame_matrix_rows (w
);
2883 /* Check that no pointers are lost. */
2889 /* Next window on same level. */
2890 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2897 /* Check that window and frame matrices agree about their
2898 understanding where glyphs of the rows are to find. For each
2899 window in the window tree rooted at W, check that rows in the
2900 matrices of leaf window agree with their frame matrices about
2904 check_window_matrix_pointers (struct window
*w
)
2908 if (WINDOWP (w
->contents
))
2909 check_window_matrix_pointers (XWINDOW (w
->contents
));
2912 struct frame
*f
= XFRAME (w
->frame
);
2913 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2914 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2917 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2922 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2923 a window and FRAME_MATRIX is the corresponding frame matrix. For
2924 each row in WINDOW_MATRIX check that it's a slice of the
2925 corresponding frame row. If it isn't, abort. */
2928 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2929 struct glyph_matrix
*frame_matrix
)
2931 /* Row number in WINDOW_MATRIX. */
2934 /* Row number corresponding to I in FRAME_MATRIX. */
2935 int j
= window_matrix
->matrix_y
;
2937 /* For all rows check that the row in the window matrix is a
2938 slice of the row in the frame matrix. If it isn't we didn't
2939 mirror an operation on the frame matrix correctly. */
2940 while (i
< window_matrix
->nrows
)
2942 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2943 frame_matrix
->rows
+ j
))
2949 #endif /* GLYPH_DEBUG */
2953 /**********************************************************************
2954 VPOS and HPOS translations
2955 **********************************************************************/
2959 /* Translate vertical position VPOS which is relative to window W to a
2960 vertical position relative to W's frame. */
2963 window_to_frame_vpos (struct window
*w
, int vpos
)
2965 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2966 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2967 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2968 eassert (vpos
>= 0 && vpos
<= FRAME_TOTAL_LINES (XFRAME (w
->frame
)));
2973 /* Translate horizontal position HPOS which is relative to window W to
2974 a horizontal position relative to W's frame. */
2977 window_to_frame_hpos (struct window
*w
, int hpos
)
2979 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2980 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2984 #endif /* GLYPH_DEBUG */
2988 /**********************************************************************
2990 **********************************************************************/
2992 /* Redraw frame F. */
2995 redraw_frame (struct frame
*f
)
2997 /* Error if F has no glyphs. */
2998 eassert (f
->glyphs_initialized_p
);
3000 if (FRAME_MSDOS_P (f
))
3001 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3003 clear_current_matrices (f
);
3005 windows_or_buffers_changed
= 13;
3006 /* Mark all windows as inaccurate, so that every window will have
3007 its redisplay done. */
3008 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3009 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), true);
3010 f
->garbaged
= false;
3013 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3014 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3015 If FRAME is omitted or nil, the selected frame is used. */)
3018 redraw_frame (decode_live_frame (frame
));
3022 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3023 doc
: /* Clear and redisplay all visible frames. */)
3026 Lisp_Object tail
, frame
;
3028 FOR_EACH_FRAME (tail
, frame
)
3029 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3030 redraw_frame (XFRAME (frame
));
3037 /***********************************************************************
3039 ***********************************************************************/
3041 /* Update frame F based on the data in desired matrices.
3043 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3044 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3046 Value is true if redisplay was stopped due to pending input. */
3049 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3051 /* True means display has been paused because of pending input. */
3053 struct window
*root_window
= XWINDOW (f
->root_window
);
3055 if (redisplay_dont_pause
)
3057 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3063 if (FRAME_WINDOW_P (f
))
3065 /* We are working on window matrix basis. All windows whose
3066 flag must_be_updated_p is set have to be updated. */
3068 /* Record that we are not working on frame matrices. */
3069 set_frame_matrix_frame (NULL
);
3071 /* Update all windows in the window tree of F, maybe stopping
3072 when pending input is detected. */
3075 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3076 /* Update the menu bar on X frames that don't have toolkit
3078 if (WINDOWP (f
->menu_bar_window
))
3079 update_window (XWINDOW (f
->menu_bar_window
), true);
3082 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3083 /* Update the tool-bar window, if present. */
3084 if (WINDOWP (f
->tool_bar_window
))
3086 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3088 /* Update tool-bar window. */
3089 if (w
->must_be_updated_p
)
3093 update_window (w
, true);
3094 w
->must_be_updated_p
= false;
3096 /* Swap tool-bar strings. We swap because we want to
3098 tem
= f
->current_tool_bar_string
;
3099 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3100 fset_desired_tool_bar_string (f
, tem
);
3105 /* Update windows. */
3106 paused_p
= update_window_tree (root_window
, force_p
);
3111 /* We are working on frame matrix basis. Set the frame on whose
3112 frame matrix we operate. */
3113 set_frame_matrix_frame (f
);
3115 /* Build F's desired matrix from window matrices. */
3116 build_frame_matrix (f
);
3118 /* Update the display. */
3120 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
, 1);
3123 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3125 if (FRAME_TTY (f
)->termscript
)
3126 fflush (FRAME_TTY (f
)->termscript
);
3127 if (FRAME_TERMCAP_P (f
))
3128 fflush (FRAME_TTY (f
)->output
);
3131 /* Check window matrices for lost pointers. */
3133 check_window_matrix_pointers (root_window
);
3134 add_frame_display_history (f
, paused_p
);
3139 /* Reset flags indicating that a window should be updated. */
3140 set_window_update_flags (root_window
, false);
3142 display_completed
= !paused_p
;
3146 /* Update a TTY frame F that has a menu dropped down over some of its
3147 glyphs. This is like the second part of update_frame, but it
3148 doesn't call build_frame_matrix, because we already have the
3149 desired matrix prepared, and don't want it to be overwritten by the
3150 text of the normal display.
3152 ROW and COL, if non-negative, are the row and column of the TTY
3153 frame where to position the cursor after the frame update is
3154 complete. Negative values mean ask update_frame_1 to position the
3155 cursor "normally", i.e. at point in the selected window. */
3157 update_frame_with_menu (struct frame
*f
, int row
, int col
)
3159 struct window
*root_window
= XWINDOW (f
->root_window
);
3160 bool paused_p
, cursor_at_point_p
;
3162 eassert (FRAME_TERMCAP_P (f
));
3164 /* We are working on frame matrix basis. Set the frame on whose
3165 frame matrix we operate. */
3166 set_frame_matrix_frame (f
);
3168 /* Update the display. */
3170 cursor_at_point_p
= !(row
>= 0 && col
>= 0);
3171 /* Force update_frame_1 not to stop due to pending input, and not
3173 paused_p
= update_frame_1 (f
, 1, 1, cursor_at_point_p
);
3174 /* ROW and COL tell us where in the menu to position the cursor, so
3175 that screen readers know the active region on the screen. */
3176 if (!cursor_at_point_p
)
3177 cursor_to (f
, row
, col
);
3180 if (FRAME_TTY (f
)->termscript
)
3181 fflush (FRAME_TTY (f
)->termscript
);
3182 fflush (FRAME_TTY (f
)->output
);
3183 /* Check window matrices for lost pointers. */
3186 /* We cannot possibly survive the matrix pointers check, since
3187 we have overwritten parts of the frame glyph matrix without
3188 making any updates to the window matrices. */
3189 check_window_matrix_pointers (root_window
);
3191 add_frame_display_history (f
, paused_p
);
3194 /* Reset flags indicating that a window should be updated. */
3195 set_window_update_flags (root_window
, false);
3196 display_completed
= !paused_p
;
3200 /************************************************************************
3201 Window-based updates
3202 ************************************************************************/
3204 /* Perform updates in window tree rooted at W.
3205 If FORCE_P, don't stop updating if input is pending. */
3208 update_window_tree (struct window
*w
, bool force_p
)
3212 while (w
&& !paused_p
)
3214 if (WINDOWP (w
->contents
))
3215 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3216 else if (w
->must_be_updated_p
)
3217 paused_p
|= update_window (w
, force_p
);
3219 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3226 /* Update window W if its flag must_be_updated_p is set.
3227 If FORCE_P, don't stop updating if input is pending. */
3230 update_single_window (struct window
*w
)
3232 if (w
->must_be_updated_p
)
3234 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3236 /* Record that this is not a frame-based redisplay. */
3237 set_frame_matrix_frame (NULL
);
3241 update_window (w
, true);
3244 /* Reset flag in W. */
3245 w
->must_be_updated_p
= false;
3249 #ifdef HAVE_WINDOW_SYSTEM
3251 /* Redraw lines from the current matrix of window W that are
3252 overlapped by other rows. YB is bottom-most y-position in W. */
3255 redraw_overlapped_rows (struct window
*w
, int yb
)
3258 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3260 /* If rows overlapping others have been changed, the rows being
3261 overlapped have to be redrawn. This won't draw lines that have
3262 already been drawn in update_window_line because overlapped_p in
3263 desired rows is 0, so after row assignment overlapped_p in
3264 current rows is 0. */
3265 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3267 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3269 if (!row
->enabled_p
)
3271 else if (row
->mode_line_p
)
3274 if (row
->overlapped_p
)
3276 enum glyph_row_area area
;
3278 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3280 output_cursor_to (w
, i
, 0, row
->y
,
3281 area
== TEXT_AREA
? row
->x
: 0);
3282 if (row
->used
[area
])
3283 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3284 area
, row
->used
[area
]);
3285 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3288 row
->overlapped_p
= 0;
3291 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3297 /* Redraw lines from the current matrix of window W that overlap
3298 others. YB is bottom-most y-position in W. */
3301 redraw_overlapping_rows (struct window
*w
, int yb
)
3304 struct glyph_row
*row
;
3305 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3307 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3309 row
= w
->current_matrix
->rows
+ i
;
3311 if (!row
->enabled_p
)
3313 else if (row
->mode_line_p
)
3316 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3318 if (row
->overlapping_p
)
3322 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3323 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3324 overlaps
|= OVERLAPS_PRED
;
3325 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3326 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3327 overlaps
|= OVERLAPS_SUCC
;
3331 if (row
->used
[LEFT_MARGIN_AREA
])
3332 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3334 if (row
->used
[TEXT_AREA
])
3335 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3337 if (row
->used
[RIGHT_MARGIN_AREA
])
3338 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3340 /* Record in neighbor rows that ROW overwrites part of
3342 if (overlaps
& OVERLAPS_PRED
)
3343 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3344 if (overlaps
& OVERLAPS_SUCC
)
3345 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3354 #endif /* HAVE_WINDOW_SYSTEM */
3357 #if defined GLYPH_DEBUG && 0
3359 /* Check that no row in the current matrix of window W is enabled
3360 which is below what's displayed in the window. */
3363 check_current_matrix_flags (struct window
*w
)
3365 bool last_seen_p
= 0;
3366 int i
, yb
= window_text_bottom_y (w
);
3368 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3370 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3371 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3373 else if (last_seen_p
&& row
->enabled_p
)
3378 #endif /* GLYPH_DEBUG */
3381 /* Update display of window W.
3382 If FORCE_P, don't stop updating when input is pending. */
3385 update_window (struct window
*w
, bool force_p
)
3387 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3389 int preempt_count
= baud_rate
/ 2400 + 1;
3390 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3392 /* Check that W's frame doesn't have glyph matrices. */
3393 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3396 /* Check pending input the first time so that we can quickly return. */
3398 detect_input_pending_ignore_squeezables ();
3400 /* If forced to complete the update, or if no input is pending, do
3402 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3404 struct glyph_row
*row
, *end
;
3405 struct glyph_row
*mode_line_row
;
3406 struct glyph_row
*header_line_row
;
3408 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3411 rif
->update_window_begin_hook (w
);
3412 yb
= window_text_bottom_y (w
);
3413 row
= MATRIX_ROW (desired_matrix
, 0);
3414 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3416 /* Take note of the header line, if there is one. We will
3417 update it below, after updating all of the window's lines. */
3418 if (row
->mode_line_p
)
3420 header_line_row
= row
;
3424 header_line_row
= NULL
;
3426 /* Update the mode line, if necessary. */
3427 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3428 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3430 mode_line_row
->y
= yb
+ WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
3431 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3433 &mouse_face_overwritten_p
);
3436 /* Find first enabled row. Optimizations in redisplay_internal
3437 may lead to an update with only one row enabled. There may
3438 be also completely empty matrices. */
3439 while (row
< end
&& !row
->enabled_p
)
3442 /* Try reusing part of the display by copying. */
3443 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3445 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3448 /* All rows were found to be equal. */
3454 /* We've scrolled the display. */
3460 /* Update the rest of the lines. */
3461 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3462 /* scrolling_window resets the enabled_p flag of the rows it
3463 reuses from current_matrix. */
3466 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3469 /* We'll have to play a little bit with when to
3470 detect_input_pending. If it's done too often,
3471 scrolling large windows with repeated scroll-up
3472 commands will too quickly pause redisplay. */
3473 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3474 detect_input_pending_ignore_squeezables ();
3475 changed_p
|= update_window_line (w
, vpos
,
3476 &mouse_face_overwritten_p
);
3478 /* Mark all rows below the last visible one in the current
3479 matrix as invalid. This is necessary because of
3480 variable line heights. Consider the case of three
3481 successive redisplays, where the first displays 5
3482 lines, the second 3 lines, and the third 5 lines again.
3483 If the second redisplay wouldn't mark rows in the
3484 current matrix invalid, the third redisplay might be
3485 tempted to optimize redisplay based on lines displayed
3486 in the first redisplay. */
3487 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3488 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3489 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, i
, false);
3492 /* Was display preempted? */
3493 paused_p
= row
< end
;
3497 /* Update the header line after scrolling because a new header
3498 line would otherwise overwrite lines at the top of the window
3499 that can be scrolled. */
3500 if (header_line_row
&& header_line_row
->enabled_p
)
3502 header_line_row
->y
= 0;
3503 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3506 /* Fix the appearance of overlapping/overlapped rows. */
3507 if (!paused_p
&& !w
->pseudo_window_p
)
3509 #ifdef HAVE_WINDOW_SYSTEM
3510 if (changed_p
&& rif
->fix_overlapping_area
)
3512 redraw_overlapped_rows (w
, yb
);
3513 redraw_overlapping_rows (w
, yb
);
3517 /* Make cursor visible at cursor position of W. */
3518 set_window_cursor_after_update (w
);
3520 #if 0 /* Check that current matrix invariants are satisfied. This is
3521 for debugging only. See the comment of check_matrix_invariants. */
3522 IF_DEBUG (check_matrix_invariants (w
));
3527 /* Remember the redisplay method used to display the matrix. */
3528 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3531 #ifdef HAVE_WINDOW_SYSTEM
3532 update_window_fringes (w
, 0);
3535 /* End the update of window W. Don't set the cursor if we
3536 paused updating the display because in this case,
3537 set_window_cursor_after_update hasn't been called, and
3538 W->output_cursor doesn't contain the cursor location. */
3539 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3545 /* check_current_matrix_flags (w); */
3546 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3549 #ifdef HAVE_XWIDGETS
3550 xwidget_end_redisplay(w
, w
->current_matrix
);
3552 clear_glyph_matrix (desired_matrix
);
3558 /* Update the display of area AREA in window W, row number VPOS.
3559 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3562 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3563 enum glyph_row_area area
, int vpos
)
3565 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3566 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3568 /* Set cursor to start of glyphs, write them, and clear to the end
3569 of the area. I don't think that something more sophisticated is
3570 necessary here, since marginal areas will not be the default. */
3571 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3572 if (desired_row
->used
[area
])
3573 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3574 area
, desired_row
->used
[area
]);
3575 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3579 /* Update the display of the text area of row VPOS in window W.
3580 Value is true if display has changed. */
3583 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3585 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3586 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3587 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3590 /* If rows are at different X or Y, or rows have different height,
3591 or the current row is marked invalid, write the entire line. */
3592 if (!current_row
->enabled_p
3593 || desired_row
->y
!= current_row
->y
3594 || desired_row
->ascent
!= current_row
->ascent
3595 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3596 || desired_row
->phys_height
!= current_row
->phys_height
3597 || desired_row
->visible_height
!= current_row
->visible_height
3598 || current_row
->overlapped_p
3599 /* This next line is necessary for correctly redrawing
3600 mouse-face areas after scrolling and other operations.
3601 However, it causes excessive flickering when mouse is moved
3602 across the mode line. Luckily, turning it off for the mode
3603 line doesn't seem to hurt anything. -- cyd.
3604 But it is still needed for the header line. -- kfs. */
3605 || (current_row
->mouse_face_p
3606 && !(current_row
->mode_line_p
&& vpos
> 0))
3607 || current_row
->x
!= desired_row
->x
)
3609 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3611 if (desired_row
->used
[TEXT_AREA
])
3612 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3613 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3615 /* Clear to end of window. */
3616 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3619 /* This erases the cursor. We do this here because
3620 notice_overwritten_cursor cannot easily check this, which
3621 might indicate that the whole functionality of
3622 notice_overwritten_cursor would better be implemented here.
3623 On the other hand, we need notice_overwritten_cursor as long
3624 as mouse highlighting is done asynchronously outside of
3626 if (vpos
== w
->phys_cursor
.vpos
)
3627 w
->phys_cursor_on_p
= 0;
3632 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3633 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3634 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3635 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3636 bool abort_skipping
= 0;
3638 /* If the desired row extends its face to the text area end, and
3639 unless the current row also does so at the same position,
3640 make sure we write at least one glyph, so that the face
3641 extension actually takes place. */
3642 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3643 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3644 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3645 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3648 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3652 /* Loop over glyphs that current and desired row may have
3656 bool can_skip_p
= !abort_skipping
;
3658 /* Skip over glyphs that both rows have in common. These
3659 don't have to be written. We can't skip if the last
3660 current glyph overlaps the glyph to its right. For
3661 example, consider a current row of `if ' with the `f' in
3662 Courier bold so that it overlaps the ` ' to its right.
3663 If the desired row is ` ', we would skip over the space
3664 after the `if' and there would remain a pixel from the
3665 `f' on the screen. */
3666 if (overlapping_glyphs_p
&& i
> 0)
3668 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3671 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3673 can_skip_p
= (right
== 0 && !abort_skipping
);
3681 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3683 x
+= desired_glyph
->pixel_width
;
3684 ++desired_glyph
, ++current_glyph
, ++i
;
3687 /* Consider the case that the current row contains "xxx
3688 ppp ggg" in italic Courier font, and the desired row
3689 is "xxx ggg". The character `p' has lbearing, `g'
3690 has not. The loop above will stop in front of the
3691 first `p' in the current row. If we would start
3692 writing glyphs there, we wouldn't erase the lbearing
3693 of the `p'. The rest of the lbearing problem is then
3694 taken care of by draw_glyphs. */
3695 if (overlapping_glyphs_p
3697 && i
< current_row
->used
[TEXT_AREA
]
3698 && (current_row
->used
[TEXT_AREA
]
3699 != desired_row
->used
[TEXT_AREA
]))
3703 rif
->get_glyph_overhangs (current_glyph
,
3706 while (left
> 0 && i
> 0)
3708 --i
, --desired_glyph
, --current_glyph
;
3709 x
-= desired_glyph
->pixel_width
;
3710 left
-= desired_glyph
->pixel_width
;
3713 /* Abort the skipping algorithm if we end up before
3714 our starting point, to avoid looping (bug#1070).
3715 This can happen when the lbearing is larger than
3717 abort_skipping
= (i
< start_hpos
);
3721 /* Try to avoid writing the entire rest of the desired row
3722 by looking for a resync point. This mainly prevents
3723 mode line flickering in the case the mode line is in
3724 fixed-pitch font, which it usually will be. */
3725 if (i
< desired_row
->used
[TEXT_AREA
])
3727 int start_x
= x
, start_hpos
= i
;
3728 struct glyph
*start
= desired_glyph
;
3730 bool skip_first_p
= !can_skip_p
;
3732 /* Find the next glyph that's equal again. */
3735 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3738 x
+= desired_glyph
->pixel_width
;
3739 current_x
+= current_glyph
->pixel_width
;
3740 ++desired_glyph
, ++current_glyph
, ++i
;
3744 if (i
== start_hpos
|| x
!= current_x
)
3748 desired_glyph
= start
;
3752 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3753 rif
->write_glyphs (w
, updated_row
, start
,
3754 TEXT_AREA
, i
- start_hpos
);
3759 /* Write the rest. */
3760 if (i
< desired_row
->used
[TEXT_AREA
])
3762 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3763 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3764 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3768 /* Maybe clear to end of line. */
3769 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3771 /* If new row extends to the end of the text area, nothing
3772 has to be cleared, if and only if we did a write_glyphs
3773 above. This is made sure by setting desired_stop_pos
3774 appropriately above. */
3775 eassert (i
< desired_row
->used
[TEXT_AREA
]
3776 || ((desired_row
->used
[TEXT_AREA
]
3777 == current_row
->used
[TEXT_AREA
])
3778 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3780 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3782 /* If old row extends to the end of the text area, clear. */
3783 if (i
>= desired_row
->used
[TEXT_AREA
])
3784 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3785 desired_row
->pixel_width
);
3786 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3789 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3791 /* Otherwise clear to the end of the old row. Everything
3792 after that position should be clear already. */
3795 if (i
>= desired_row
->used
[TEXT_AREA
])
3796 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3797 desired_row
->pixel_width
);
3799 /* If cursor is displayed at the end of the line, make sure
3800 it's cleared. Nowadays we don't have a phys_cursor_glyph
3801 with which to erase the cursor (because this method
3802 doesn't work with lbearing/rbearing), so we must do it
3804 if (vpos
== w
->phys_cursor
.vpos
3805 && (desired_row
->reversed_p
3806 ? (w
->phys_cursor
.hpos
< 0)
3807 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3809 w
->phys_cursor_on_p
= 0;
3813 xlim
= current_row
->pixel_width
;
3814 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3823 /* Update row VPOS in window W. Value is true if display has been changed. */
3826 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3828 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3829 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3830 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3833 /* A row can be completely invisible in case a desired matrix was
3834 built with a vscroll and then make_cursor_line_fully_visible shifts
3835 the matrix. Make sure to make such rows current anyway, since
3836 we need the correct y-position, for example, in the current matrix. */
3837 if (desired_row
->mode_line_p
3838 || desired_row
->visible_height
> 0)
3840 eassert (desired_row
->enabled_p
);
3842 /* Update display of the left margin area, if there is one. */
3843 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3846 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3847 /* Setting this flag will ensure the vertical border, if
3848 any, between this window and the one on its left will be
3849 redrawn. This is necessary because updating the left
3850 margin area can potentially draw over the border. */
3851 current_row
->redraw_fringe_bitmaps_p
= 1;
3854 /* Update the display of the text area. */
3855 if (update_text_area (w
, desired_row
, vpos
))
3858 if (current_row
->mouse_face_p
)
3859 *mouse_face_overwritten_p
= 1;
3862 /* Update display of the right margin area, if there is one. */
3863 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3866 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3869 /* Draw truncation marks etc. */
3870 if (!current_row
->enabled_p
3871 || desired_row
->y
!= current_row
->y
3872 || desired_row
->visible_height
!= current_row
->visible_height
3873 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3874 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3875 || current_row
->redraw_fringe_bitmaps_p
3876 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3877 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3878 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3879 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3880 rif
->after_update_window_line_hook (w
, desired_row
);
3883 /* Update current_row from desired_row. */
3884 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3889 /* Set the cursor after an update of window W. This function may only
3890 be called from update_window. */
3893 set_window_cursor_after_update (struct window
*w
)
3895 struct frame
*f
= XFRAME (w
->frame
);
3896 int cx
, cy
, vpos
, hpos
;
3898 /* Not intended for frame matrix updates. */
3899 eassert (FRAME_WINDOW_P (f
));
3901 if (cursor_in_echo_area
3902 && !NILP (echo_area_buffer
[0])
3903 /* If we are showing a message instead of the mini-buffer,
3904 show the cursor for the message instead. */
3905 && XWINDOW (minibuf_window
) == w
3906 && EQ (minibuf_window
, echo_area_window
)
3907 /* These cases apply only to the frame that contains
3908 the active mini-buffer window. */
3909 && FRAME_HAS_MINIBUF_P (f
)
3910 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3912 cx
= cy
= vpos
= hpos
= 0;
3914 if (cursor_in_echo_area
>= 0)
3916 /* If the mini-buffer is several lines high, find the last
3917 line that has any text on it. Note: either all lines
3918 are enabled or none. Otherwise we wouldn't be able to
3920 struct glyph_row
*row
, *last_row
;
3921 struct glyph
*glyph
;
3922 int yb
= window_text_bottom_y (w
);
3925 row
= w
->current_matrix
->rows
;
3926 while (row
->enabled_p
3927 && (last_row
== NULL
3928 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3930 if (row
->used
[TEXT_AREA
]
3931 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3938 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3939 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3941 while (last
> start
&& last
->charpos
< 0)
3944 for (glyph
= start
; glyph
< last
; ++glyph
)
3946 cx
+= glyph
->pixel_width
;
3951 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3959 hpos
= w
->cursor
.hpos
;
3960 vpos
= w
->cursor
.vpos
;
3963 /* Window cursor can be out of sync for horizontally split windows.
3964 Horizontal position is -1 when cursor is on the left fringe. */
3965 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3966 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3967 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3971 /* Set WINDOW->must_be_updated_p to ON_P for all windows in
3972 the window tree rooted at W. */
3975 set_window_update_flags (struct window
*w
, bool on_p
)
3979 if (WINDOWP (w
->contents
))
3980 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3982 w
->must_be_updated_p
= on_p
;
3984 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3990 /***********************************************************************
3991 Window-Based Scrolling
3992 ***********************************************************************/
3994 /* Structure describing rows in scrolling_window. */
3998 /* Number of occurrences of this row in desired and current matrix. */
3999 int old_uses
, new_uses
;
4001 /* Vpos of row in new matrix. */
4002 int new_line_number
;
4004 /* Bucket index of this row_entry in the hash table row_table. */
4007 /* The row described by this entry. */
4008 struct glyph_row
*row
;
4010 /* Hash collision chain. */
4011 struct row_entry
*next
;
4014 /* A pool to allocate row_entry structures from, and the size of the
4015 pool. The pool is reallocated in scrolling_window when we find
4016 that we need a larger one. */
4018 static struct row_entry
*row_entry_pool
;
4019 static ptrdiff_t row_entry_pool_size
;
4021 /* Index of next free entry in row_entry_pool. */
4023 static ptrdiff_t row_entry_idx
;
4025 /* The hash table used during scrolling, and the table's size. This
4026 table is used to quickly identify equal rows in the desired and
4029 static struct row_entry
**row_table
;
4030 static ptrdiff_t row_table_size
;
4032 /* Vectors of pointers to row_entry structures belonging to the
4033 current and desired matrix, and the size of the vectors. */
4035 static struct row_entry
**old_lines
, **new_lines
;
4036 static ptrdiff_t old_lines_size
, new_lines_size
;
4038 /* A pool to allocate run structures from, and its size. */
4040 static struct run
*run_pool
;
4041 static ptrdiff_t runs_size
;
4043 /* A vector of runs of lines found during scrolling. */
4045 static struct run
**runs
;
4047 /* Add glyph row ROW to the scrolling hash table. */
4049 static struct row_entry
*
4050 add_row_entry (struct glyph_row
*row
)
4052 struct row_entry
*entry
;
4053 ptrdiff_t i
= row
->hash
% row_table_size
;
4055 entry
= row_table
[i
];
4056 eassert (entry
|| verify_row_hash (row
));
4057 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4058 entry
= entry
->next
;
4062 entry
= row_entry_pool
+ row_entry_idx
++;
4064 entry
->old_uses
= entry
->new_uses
= 0;
4065 entry
->new_line_number
= 0;
4067 entry
->next
= row_table
[i
];
4068 row_table
[i
] = entry
;
4075 /* Try to reuse part of the current display of W by scrolling lines.
4076 HEADER_LINE_P means W has a header line.
4078 The algorithm is taken from Communications of the ACM, Apr78 "A
4079 Technique for Isolating Differences Between Files." It should take
4082 A short outline of the steps of the algorithm
4084 1. Skip lines equal at the start and end of both matrices.
4086 2. Enter rows in the current and desired matrix into a symbol
4087 table, counting how often they appear in both matrices.
4089 3. Rows that appear exactly once in both matrices serve as anchors,
4090 i.e. we assume that such lines are likely to have been moved.
4092 4. Starting from anchor lines, extend regions to be scrolled both
4093 forward and backward.
4097 -1 if all rows were found to be equal.
4098 0 to indicate that we did not scroll the display, or
4099 1 if we did scroll. */
4102 scrolling_window (struct window
*w
, bool header_line_p
)
4104 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4105 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4106 int yb
= window_text_bottom_y (w
);
4108 int j
, first_old
, first_new
, last_old
, last_new
;
4111 struct row_entry
*entry
;
4112 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4114 /* Skip over rows equal at the start. */
4115 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4117 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4118 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4122 && !d
->redraw_fringe_bitmaps_p
4124 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4125 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4126 && row_equal_p (c
, d
, 1))
4129 d
->enabled_p
= false;
4135 #ifdef HAVE_XWIDGETS
4136 //currently this is needed to detect xwidget movement reliably. or probably not.
4137 //printf("scrolling_window\n");
4141 /* Give up if some rows in the desired matrix are not enabled. */
4142 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4145 first_old
= first_new
= i
;
4147 /* Set last_new to the index + 1 of the row that reaches the
4148 bottom boundary in the desired matrix. Give up if we find a
4149 disabled row before we reach the bottom boundary. */
4151 while (i
< desired_matrix
->nrows
- 1)
4155 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4157 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4166 /* Set last_old to the index + 1 of the row that reaches the bottom
4167 boundary in the current matrix. We don't look at the enabled
4168 flag here because we plan to reuse part of the display even if
4169 other parts are disabled. */
4171 while (i
< current_matrix
->nrows
- 1)
4173 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4182 /* Skip over rows equal at the bottom. */
4185 while (i
- 1 > first_new
4186 && j
- 1 > first_old
4187 && MATRIX_ROW_ENABLED_P (current_matrix
, j
- 1)
4188 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4189 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4190 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4191 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4192 MATRIX_ROW (current_matrix
, j
- 1), 1))
4197 /* Nothing to do if all rows are equal. */
4198 if (last_new
== first_new
)
4201 /* Check for integer overflow in size calculation.
4203 If next_almost_prime checks (N) for divisibility by 2..10, then
4204 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4205 So, set next_almost_prime_increment_max to 10.
4207 It's just a coincidence that next_almost_prime_increment_max ==
4208 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4209 13, then next_almost_prime_increment_max would be 14, e.g.,
4210 because next_almost_prime (113) would be 127. */
4212 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4213 enum { next_almost_prime_increment_max
= 10 };
4214 ptrdiff_t row_table_max
=
4215 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4216 - next_almost_prime_increment_max
);
4217 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4218 if (current_nrows_max
< current_matrix
->nrows
)
4219 memory_full (SIZE_MAX
);
4222 /* Reallocate vectors, tables etc. if necessary. */
4224 if (current_matrix
->nrows
> old_lines_size
)
4225 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4226 current_matrix
->nrows
- old_lines_size
,
4227 INT_MAX
, sizeof *old_lines
);
4229 if (desired_matrix
->nrows
> new_lines_size
)
4230 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4231 desired_matrix
->nrows
- new_lines_size
,
4232 INT_MAX
, sizeof *new_lines
);
4234 n
= desired_matrix
->nrows
;
4235 n
+= current_matrix
->nrows
;
4236 if (row_table_size
< 3 * n
)
4238 ptrdiff_t size
= next_almost_prime (3 * n
);
4239 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4240 row_table_size
= size
;
4241 memset (row_table
, 0, size
* sizeof *row_table
);
4244 if (n
> row_entry_pool_size
)
4245 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4246 n
- row_entry_pool_size
,
4247 -1, sizeof *row_entry_pool
);
4249 if (desired_matrix
->nrows
> runs_size
)
4251 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4252 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4253 runs_size
= desired_matrix
->nrows
;
4256 nruns
= run_idx
= 0;
4259 /* Add rows from the current and desired matrix to the hash table
4260 row_hash_table to be able to find equal ones quickly. */
4262 for (i
= first_old
; i
< last_old
; ++i
)
4264 if (MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4266 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4267 old_lines
[i
] = entry
;
4271 old_lines
[i
] = NULL
;
4274 for (i
= first_new
; i
< last_new
; ++i
)
4276 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4277 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4279 entry
->new_line_number
= i
;
4280 new_lines
[i
] = entry
;
4283 /* Identify moves based on lines that are unique and equal
4284 in both matrices. */
4285 for (i
= first_old
; i
< last_old
;)
4287 && old_lines
[i
]->old_uses
== 1
4288 && old_lines
[i
]->new_uses
== 1)
4291 int new_line
= old_lines
[i
]->new_line_number
;
4292 struct run
*run
= run_pool
+ run_idx
++;
4295 run
->current_vpos
= i
;
4296 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4297 run
->desired_vpos
= new_line
;
4298 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4300 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4302 /* Extend backward. */
4305 while (p
> first_old
4307 && old_lines
[p
] == new_lines
[q
])
4309 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4310 --run
->current_vpos
;
4311 --run
->desired_vpos
;
4314 run
->desired_y
-= h
;
4315 run
->current_y
-= h
;
4319 /* Extend forward. */
4324 && old_lines
[p
] == new_lines
[q
])
4326 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4332 /* Insert run into list of all runs. Order runs by copied
4333 pixel lines. Note that we record runs that don't have to
4334 be copied because they are already in place. This is done
4335 because we can avoid calling update_window_line in this
4337 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4339 for (q
= nruns
; q
> p
; --q
)
4340 runs
[q
] = runs
[q
- 1];
4349 /* Do the moves. Do it in a way that we don't overwrite something
4350 we want to copy later on. This is not solvable in general
4351 because there is only one display and we don't have a way to
4352 exchange areas on this display. Example:
4354 +-----------+ +-----------+
4356 +-----------+ --> +-----------+
4358 +-----------+ +-----------+
4360 Instead, prefer bigger moves, and invalidate moves that would
4361 copy from where we copied to. */
4363 for (i
= 0; i
< nruns
; ++i
)
4364 if (runs
[i
]->nrows
> 0)
4366 struct run
*r
= runs
[i
];
4368 /* Copy on the display. */
4369 if (r
->current_y
!= r
->desired_y
)
4371 rif
->clear_window_mouse_face (w
);
4372 rif
->scroll_run_hook (w
, r
);
4375 /* Truncate runs that copy to where we copied to, and
4376 invalidate runs that copy from where we copied to. */
4377 for (j
= nruns
- 1; j
> i
; --j
)
4379 struct run
*p
= runs
[j
];
4380 bool truncated_p
= 0;
4383 && p
->desired_y
< r
->desired_y
+ r
->height
4384 && p
->desired_y
+ p
->height
> r
->desired_y
)
4386 if (p
->desired_y
< r
->desired_y
)
4388 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4389 p
->height
= r
->desired_y
- p
->desired_y
;
4394 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4397 if (p
->nrows
<= nrows_copied
)
4401 int height_copied
= (r
->desired_y
+ r
->height
4404 p
->current_vpos
+= nrows_copied
;
4405 p
->desired_vpos
+= nrows_copied
;
4406 p
->nrows
-= nrows_copied
;
4407 p
->current_y
+= height_copied
;
4408 p
->desired_y
+= height_copied
;
4409 p
->height
-= height_copied
;
4415 if (r
->current_y
!= r
->desired_y
4416 /* The condition below is equivalent to
4417 ((p->current_y >= r->desired_y
4418 && p->current_y < r->desired_y + r->height)
4419 || (p->current_y + p->height > r->desired_y
4420 && (p->current_y + p->height
4421 <= r->desired_y + r->height)))
4422 because we have 0 < p->height <= r->height. */
4423 && p
->current_y
< r
->desired_y
+ r
->height
4424 && p
->current_y
+ p
->height
> r
->desired_y
)
4427 /* Reorder runs by copied pixel lines if truncated. */
4428 if (truncated_p
&& p
->nrows
> 0)
4432 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4434 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4439 /* Assign matrix rows. */
4440 for (j
= 0; j
< r
->nrows
; ++j
)
4442 struct glyph_row
*from
, *to
;
4443 bool to_overlapped_p
;
4445 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4446 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4447 to_overlapped_p
= to
->overlapped_p
;
4448 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4449 assign_row (to
, from
);
4450 /* The above `assign_row' actually does swap, so if we had
4451 an overlap in the copy destination of two runs, then
4452 the second run would assign a previously disabled bogus
4453 row. But thanks to the truncation code in the
4454 preceding for-loop, we no longer have such an overlap,
4455 and thus the assigned row should always be enabled. */
4456 eassert (to
->enabled_p
);
4457 from
->enabled_p
= false;
4458 to
->overlapped_p
= to_overlapped_p
;
4462 /* Clear the hash table, for the next time. */
4463 for (i
= 0; i
< row_entry_idx
; ++i
)
4464 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4466 /* Value is 1 to indicate that we scrolled the display. */
4472 /************************************************************************
4474 ************************************************************************/
4476 /* Update the desired frame matrix of frame F.
4478 FORCE_P means that the update should not be stopped by pending input.
4479 INHIBIT_ID_P means that scrolling by insert/delete should not be tried.
4480 SET_CURSOR_P false means do not set cursor at point in selected window.
4482 Value is true if update was stopped due to pending input. */
4485 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
,
4488 /* Frame matrices to work on. */
4489 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4490 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4493 int preempt_count
= baud_rate
/ 2400 + 1;
4495 eassert (current_matrix
&& desired_matrix
);
4497 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4498 calculate_costs (f
);
4500 if (preempt_count
<= 0)
4503 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4509 /* If we cannot insert/delete lines, it's no use trying it. */
4510 if (!FRAME_LINE_INS_DEL_OK (f
))
4513 /* See if any of the desired lines are enabled; don't compute for
4514 i/d line if just want cursor motion. */
4515 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4516 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4519 /* Try doing i/d line, if not yet inhibited. */
4520 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4521 force_p
|= scrolling (f
);
4523 /* Update the individual lines as needed. Do bottom line first. */
4524 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4525 update_frame_line (f
, desired_matrix
->nrows
- 1);
4527 /* Now update the rest of the lines. */
4528 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4530 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4532 if (FRAME_TERMCAP_P (f
))
4534 /* Flush out every so many lines.
4535 Also flush out if likely to have more than 1k buffered
4536 otherwise. I'm told that some telnet connections get
4537 really screwed by more than 1k output at once. */
4538 FILE *display_output
= FRAME_TTY (f
)->output
;
4541 ptrdiff_t outq
= __fpending (display_output
);
4543 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4544 fflush (display_output
);
4548 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4549 detect_input_pending_ignore_squeezables ();
4551 update_frame_line (f
, i
);
4555 pause_p
= 0 < i
&& i
< FRAME_TOTAL_LINES (f
) - 1;
4557 /* Now just clean up termcap drivers and set cursor, etc. */
4558 if (!pause_p
&& set_cursor_p
)
4560 if ((cursor_in_echo_area
4561 /* If we are showing a message instead of the mini-buffer,
4562 show the cursor for the message instead of for the
4563 (now hidden) mini-buffer contents. */
4564 || (EQ (minibuf_window
, selected_window
)
4565 && EQ (minibuf_window
, echo_area_window
)
4566 && !NILP (echo_area_buffer
[0])))
4567 /* These cases apply only to the frame that contains
4568 the active mini-buffer window. */
4569 && FRAME_HAS_MINIBUF_P (f
)
4570 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4572 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4575 if (cursor_in_echo_area
< 0)
4577 /* Negative value of cursor_in_echo_area means put
4578 cursor at beginning of line. */
4584 /* Positive value of cursor_in_echo_area means put
4585 cursor at the end of the prompt. If the mini-buffer
4586 is several lines high, find the last line that has
4588 row
= FRAME_TOTAL_LINES (f
);
4594 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4596 /* Frame rows are filled up with spaces that
4597 must be ignored here. */
4598 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4600 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4601 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4604 && (last
- 1)->charpos
< 0)
4610 while (row
> top
&& col
== 0);
4612 /* Make sure COL is not out of range. */
4613 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4615 /* If we have another row, advance cursor into it. */
4616 if (row
< FRAME_TOTAL_LINES (f
) - 1)
4618 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4621 /* Otherwise move it back in range. */
4623 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4627 cursor_to (f
, row
, col
);
4631 /* We have only one cursor on terminal frames. Use it to
4632 display the cursor of the selected window. */
4633 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4634 if (w
->cursor
.vpos
>= 0
4635 /* The cursor vpos may be temporarily out of bounds
4636 in the following situation: There is one window,
4637 with the cursor in the lower half of it. The window
4638 is split, and a message causes a redisplay before
4639 a new cursor position has been computed. */
4640 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4642 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4643 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4645 x
+= max (0, w
->left_margin_cols
);
4646 cursor_to (f
, y
, x
);
4653 clear_desired_matrices (f
);
4658 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4661 scrolling (struct frame
*frame
)
4663 int unchanged_at_top
, unchanged_at_bottom
;
4667 int height
= FRAME_TOTAL_LINES (frame
);
4668 int free_at_end_vpos
= height
;
4669 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4670 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4671 verify (sizeof (int) <= sizeof (unsigned));
4672 verify (alignof (unsigned) % alignof (int) == 0);
4675 SAFE_NALLOCA (old_hash
, 4, height
);
4676 unsigned *new_hash
= old_hash
+ height
;
4677 int *draw_cost
= (int *) (new_hash
+ height
);
4678 int *old_draw_cost
= draw_cost
+ height
;
4680 eassert (current_matrix
);
4682 /* Compute hash codes of all the lines. Also calculate number of
4683 changed lines, number of unchanged lines at the beginning, and
4684 number of unchanged lines at the end. */
4686 unchanged_at_top
= 0;
4687 unchanged_at_bottom
= height
;
4688 for (i
= 0; i
< height
; i
++)
4690 /* Give up on this scrolling if some old lines are not enabled. */
4691 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4696 old_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (current_matrix
, i
));
4697 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4699 /* This line cannot be redrawn, so don't let scrolling mess it. */
4700 new_hash
[i
] = old_hash
[i
];
4701 #define INFINITY 1000000 /* Taken from scroll.c */
4702 draw_cost
[i
] = INFINITY
;
4706 new_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (desired_matrix
, i
));
4707 draw_cost
[i
] = line_draw_cost (frame
, desired_matrix
, i
);
4710 if (old_hash
[i
] != new_hash
[i
])
4713 unchanged_at_bottom
= height
- i
- 1;
4715 else if (i
== unchanged_at_top
)
4717 old_draw_cost
[i
] = line_draw_cost (frame
, current_matrix
, i
);
4720 /* If changed lines are few, don't allow preemption, don't scroll. */
4721 if ((!FRAME_SCROLL_REGION_OK (frame
)
4722 && changed_lines
< baud_rate
/ 2400)
4723 || unchanged_at_bottom
== height
)
4729 window_size
= (height
- unchanged_at_top
4730 - unchanged_at_bottom
);
4732 if (FRAME_SCROLL_REGION_OK (frame
))
4733 free_at_end_vpos
-= unchanged_at_bottom
;
4734 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4735 free_at_end_vpos
= -1;
4737 /* Do id/calc only if small window, or slow terminal, or many lines
4738 in common between current frame and desired frame. But the
4739 window size must be at least 2. */
4740 if ((FRAME_SCROLL_REGION_OK (frame
)
4741 || window_size
< 18 || baud_rate
<= 2400
4743 < 10 * scrolling_max_lines_saved (unchanged_at_top
,
4744 height
- unchanged_at_bottom
,
4745 old_hash
, new_hash
, draw_cost
)))
4746 && 2 <= window_size
)
4747 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4748 draw_cost
+ unchanged_at_top
- 1,
4749 old_draw_cost
+ unchanged_at_top
- 1,
4750 old_hash
+ unchanged_at_top
- 1,
4751 new_hash
+ unchanged_at_top
- 1,
4752 free_at_end_vpos
- unchanged_at_top
);
4759 /* Count the number of blanks at the start of the vector of glyphs R
4760 which is LEN glyphs long. */
4763 count_blanks (struct glyph
*r
, int len
)
4767 for (i
= 0; i
< len
; ++i
)
4768 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4775 /* Count the number of glyphs in common at the start of the glyph
4776 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4777 of STR2. Value is the number of equal glyphs equal at the start. */
4780 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4782 struct glyph
*p1
= str1
;
4783 struct glyph
*p2
= str2
;
4787 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4794 /* Char insertion/deletion cost vector, from term.c */
4796 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4799 /* Perform a frame-based update on line VPOS in frame FRAME. */
4802 update_frame_line (struct frame
*f
, int vpos
)
4804 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4806 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4807 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4808 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4809 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4810 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4811 bool must_write_whole_line_p
;
4812 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4813 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4814 != FACE_TTY_DEFAULT_BG_COLOR
);
4816 if (colored_spaces_p
)
4819 /* Current row not enabled means it has unknown contents. We must
4820 write the whole desired line in that case. */
4821 must_write_whole_line_p
= !current_row
->enabled_p
;
4822 if (must_write_whole_line_p
)
4829 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4830 olen
= current_row
->used
[TEXT_AREA
];
4832 /* Ignore trailing spaces, if we can. */
4833 if (!write_spaces_p
)
4834 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4838 current_row
->enabled_p
= true;
4839 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4841 /* If desired line is empty, just clear the line. */
4842 if (!desired_row
->enabled_p
)
4848 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4849 nlen
= desired_row
->used
[TEXT_AREA
];
4850 nend
= nbody
+ nlen
;
4852 /* If display line has unknown contents, write the whole line. */
4853 if (must_write_whole_line_p
)
4855 /* Ignore spaces at the end, if we can. */
4856 if (!write_spaces_p
)
4857 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4860 /* Write the contents of the desired line. */
4863 cursor_to (f
, vpos
, 0);
4864 write_glyphs (f
, nbody
, nlen
);
4867 /* Don't call clear_end_of_line if we already wrote the whole
4868 line. The cursor will not be at the right margin in that
4869 case but in the line below. */
4870 if (nlen
< FRAME_TOTAL_COLS (f
))
4872 cursor_to (f
, vpos
, nlen
);
4873 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4876 /* Make sure we are in the right row, otherwise cursor movement
4877 with cmgoto might use `ch' in the wrong row. */
4878 cursor_to (f
, vpos
, 0);
4880 make_current (desired_matrix
, current_matrix
, vpos
);
4884 /* Pretend trailing spaces are not there at all,
4885 unless for one reason or another we must write all spaces. */
4886 if (!write_spaces_p
)
4887 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4890 /* If there's no i/d char, quickly do the best we can without it. */
4891 if (!FRAME_CHAR_INS_DEL_OK (f
))
4895 /* Find the first glyph in desired row that doesn't agree with
4896 a glyph in the current row, and write the rest from there on. */
4897 for (i
= 0; i
< nlen
; i
++)
4899 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4901 /* Find the end of the run of different glyphs. */
4905 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4906 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4909 /* Output this run of non-matching chars. */
4910 cursor_to (f
, vpos
, i
);
4911 write_glyphs (f
, nbody
+ i
, j
- i
);
4914 /* Now find the next non-match. */
4918 /* Clear the rest of the line, or the non-clear part of it. */
4921 cursor_to (f
, vpos
, nlen
);
4922 clear_end_of_line (f
, olen
);
4925 /* Make current row = desired row. */
4926 make_current (desired_matrix
, current_matrix
, vpos
);
4930 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4931 characters in a row. */
4935 /* If current line is blank, skip over initial spaces, if
4936 possible, and write the rest. */
4940 nsp
= count_blanks (nbody
, nlen
);
4944 cursor_to (f
, vpos
, nsp
);
4945 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4948 /* Exchange contents between current_frame and new_frame. */
4949 make_current (desired_matrix
, current_matrix
, vpos
);
4953 /* Compute number of leading blanks in old and new contents. */
4954 osp
= count_blanks (obody
, olen
);
4955 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4957 /* Compute number of matching chars starting with first non-blank. */
4958 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4959 nbody
+ nsp
, nbody
+ nlen
);
4961 /* Spaces in new match implicit space past the end of old. */
4962 /* A bug causing this to be a no-op was fixed in 18.29. */
4963 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4966 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4970 /* Avoid doing insert/delete char
4971 just cause number of leading spaces differs
4972 when the following text does not match. */
4973 if (begmatch
== 0 && osp
!= nsp
)
4974 osp
= nsp
= min (osp
, nsp
);
4976 /* Find matching characters at end of line */
4979 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4981 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4986 endmatch
= obody
+ olen
- op1
;
4988 /* tem gets the distance to insert or delete.
4989 endmatch is how many characters we save by doing so.
4992 tem
= (nlen
- nsp
) - (olen
- osp
);
4994 && (!FRAME_CHAR_INS_DEL_OK (f
)
4995 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4998 /* nsp - osp is the distance to insert or delete.
4999 If that is nonzero, begmatch is known to be nonzero also.
5000 begmatch + endmatch is how much we save by doing the ins/del.
5004 && (!FRAME_CHAR_INS_DEL_OK (f
)
5005 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5009 osp
= nsp
= min (osp
, nsp
);
5012 /* Now go through the line, inserting, writing and
5013 deleting as appropriate. */
5017 cursor_to (f
, vpos
, nsp
);
5018 delete_glyphs (f
, osp
- nsp
);
5022 /* If going to delete chars later in line
5023 and insert earlier in the line,
5024 must delete first to avoid losing data in the insert */
5025 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5027 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5028 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5029 olen
= nlen
- (nsp
- osp
);
5031 cursor_to (f
, vpos
, osp
);
5032 insert_glyphs (f
, 0, nsp
- osp
);
5036 tem
= nsp
+ begmatch
+ endmatch
;
5037 if (nlen
!= tem
|| olen
!= tem
)
5039 if (!endmatch
|| nlen
== olen
)
5041 /* If new text being written reaches right margin, there is
5042 no need to do clear-to-eol at the end of this function
5043 (and it would not be safe, since cursor is not going to
5044 be "at the margin" after the text is done). */
5045 if (nlen
== FRAME_TOTAL_COLS (f
))
5048 /* Function write_glyphs is prepared to do nothing
5049 if passed a length <= 0. Check it here to avoid
5050 unnecessary cursor movement. */
5053 cursor_to (f
, vpos
, nsp
+ begmatch
);
5054 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5057 else if (nlen
> olen
)
5059 /* Here, we used to have the following simple code:
5060 ----------------------------------------
5061 write_glyphs (nbody + nsp + begmatch, olen - tem);
5062 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5063 ----------------------------------------
5064 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5065 is a padding glyph. */
5066 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5069 cursor_to (f
, vpos
, nsp
+ begmatch
);
5071 /* Calculate columns we can actually overwrite. */
5072 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5074 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5076 /* If we left columns to be overwritten, we must delete them. */
5077 del
= olen
- tem
- out
;
5079 delete_glyphs (f
, del
);
5081 /* At last, we insert columns not yet written out. */
5082 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5085 else if (olen
> nlen
)
5087 cursor_to (f
, vpos
, nsp
+ begmatch
);
5088 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5089 delete_glyphs (f
, olen
- nlen
);
5095 /* If any unerased characters remain after the new line, erase them. */
5098 cursor_to (f
, vpos
, nlen
);
5099 clear_end_of_line (f
, olen
);
5102 /* Exchange contents between current_frame and new_frame. */
5103 make_current (desired_matrix
, current_matrix
, vpos
);
5108 /***********************************************************************
5109 X/Y Position -> Buffer Position
5110 ***********************************************************************/
5112 /* Determine what's under window-relative pixel position (*X, *Y).
5113 Return the OBJECT (string or buffer) that's there.
5114 Return in *POS the position in that object.
5115 Adjust *X and *Y to character positions.
5116 Return in *DX and *DY the pixel coordinates of the click,
5117 relative to the top left corner of OBJECT, or relative to
5118 the top left corner of the character glyph at (*X, *Y)
5120 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5121 if the coordinates point to an empty area of the display. */
5124 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
)
5127 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5128 struct text_pos startp
;
5130 struct glyph_row
*row
;
5131 #ifdef HAVE_WINDOW_SYSTEM
5132 struct image
*img
= 0;
5134 int x0
, x1
, to_x
, it_vpos
;
5135 void *itdata
= NULL
;
5137 /* We used to set current_buffer directly here, but that does the
5138 wrong thing with `face-remapping-alist' (bug#2044). */
5139 Fset_buffer (w
->contents
);
5140 itdata
= bidi_shelve_cache ();
5141 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5142 start_display (&it
, w
, startp
);
5145 /* First, move to the beginning of the row corresponding to *Y. We
5146 need to be in that row to get the correct value of base paragraph
5147 direction for the text at (*X, *Y). */
5148 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5150 /* TO_X is the pixel position that the iterator will compute for the
5153 if (it
.bidi_it
.paragraph_dir
== R2L
)
5154 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5155 text area. This is because the iterator, even in R2L
5156 paragraphs, delivers glyphs as if they started at the left
5157 margin of the window. (When we actually produce glyphs for
5158 display, we reverse their order in PRODUCE_GLYPHS, but the
5159 iterator doesn't know about that.) The following line adjusts
5160 the pixel position to the iterator geometry, which is what
5161 move_it_* routines use. (The -1 is because in a window whose
5162 text-area width is W, the rightmost pixel position is W-1, and
5163 it should be mirrored into zero pixel position.) */
5164 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5166 /* We need to add it.first_visible_x because iterator positions
5167 include the hscroll. */
5168 to_x
+= it
.first_visible_x
;
5170 /* Now move horizontally in the row to the glyph under *X. Second
5171 argument is ZV to prevent move_it_in_display_line from matching
5172 based on buffer positions. */
5173 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5174 bidi_unshelve_cache (itdata
, 0);
5176 Fset_buffer (old_current_buffer
);
5178 *dx
= to_x
- it
.current_x
;
5179 *dy
= *y
- it
.current_y
;
5181 string
= w
->contents
;
5182 if (STRINGP (it
.string
))
5185 if (it
.what
== IT_COMPOSITION
5186 && it
.cmp_it
.nchars
> 1
5187 && it
.cmp_it
.reversed_p
)
5189 /* The current display element is a grapheme cluster in a
5190 composition. In that case, we need the position of the first
5191 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5192 it.current points to the last character of the cluster, thus
5193 we must move back to the first character of the same
5195 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5196 if (STRINGP (it
.string
))
5197 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5199 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5200 CHARPOS (pos
->pos
));
5203 #ifdef HAVE_WINDOW_SYSTEM
5204 if (it
.what
== IT_IMAGE
)
5206 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5207 && !NILP (img
->spec
))
5208 *object
= img
->spec
;
5212 /* IT's vpos counts from the glyph row that includes the window's
5213 start position, i.e. it excludes the header-line row, but
5214 MATRIX_ROW includes the header-line row. Adjust for a possible
5216 it_vpos
= it
.vpos
+ WINDOW_WANTS_HEADER_LINE_P (w
);
5217 if (it_vpos
< w
->current_matrix
->nrows
5218 && (row
= MATRIX_ROW (w
->current_matrix
, it_vpos
),
5221 if (it
.hpos
< row
->used
[TEXT_AREA
])
5223 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5224 #ifdef HAVE_WINDOW_SYSTEM
5227 *dy
-= row
->ascent
- glyph
->ascent
;
5228 *dx
+= glyph
->slice
.img
.x
;
5229 *dy
+= glyph
->slice
.img
.y
;
5230 /* Image slices positions are still relative to the entire image */
5231 *width
= img
->width
;
5232 *height
= img
->height
;
5237 *width
= glyph
->pixel_width
;
5238 *height
= glyph
->ascent
+ glyph
->descent
;
5244 *height
= row
->height
;
5249 *width
= *height
= 0;
5252 /* Add extra (default width) columns if clicked after EOL. */
5253 x1
= max (0, it
.current_x
+ it
.pixel_width
);
5255 it
.hpos
+= (to_x
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5264 /* Value is the string under window-relative coordinates X/Y in the
5265 mode line or header line (PART says which) of window W, or nil if none.
5266 *CHARPOS is set to the position in the string returned. */
5269 mode_line_string (struct window
*w
, enum window_part part
,
5270 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5271 int *dx
, int *dy
, int *width
, int *height
)
5273 struct glyph_row
*row
;
5274 struct glyph
*glyph
, *end
;
5276 Lisp_Object string
= Qnil
;
5278 if (part
== ON_MODE_LINE
)
5279 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5281 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5283 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5285 if (row
->mode_line_p
&& row
->enabled_p
)
5287 /* Find the glyph under X. If we find one with a string object,
5288 it's the one we were looking for. */
5289 glyph
= row
->glyphs
[TEXT_AREA
];
5290 end
= glyph
+ row
->used
[TEXT_AREA
];
5291 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5292 x0
-= glyph
->pixel_width
;
5293 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5296 string
= glyph
->object
;
5297 *charpos
= glyph
->charpos
;
5298 *width
= glyph
->pixel_width
;
5299 *height
= glyph
->ascent
+ glyph
->descent
;
5300 #ifdef HAVE_WINDOW_SYSTEM
5301 if (glyph
->type
== IMAGE_GLYPH
)
5304 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5306 *object
= img
->spec
;
5307 y0
-= row
->ascent
- glyph
->ascent
;
5313 /* Add extra (default width) columns if clicked after EOL. */
5314 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5316 *height
= row
->height
;
5323 *width
= *height
= 0;
5333 /* Value is the string under window-relative coordinates X/Y in either
5334 marginal area, or nil if none. *CHARPOS is set to the position in
5335 the string returned. */
5338 marginal_area_string (struct window
*w
, enum window_part part
,
5339 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5340 int *dx
, int *dy
, int *width
, int *height
)
5342 struct glyph_row
*row
= w
->current_matrix
->rows
;
5343 struct glyph
*glyph
, *end
;
5344 int x0
, y0
, i
, wy
= *y
;
5346 Lisp_Object string
= Qnil
;
5348 if (part
== ON_LEFT_MARGIN
)
5349 area
= LEFT_MARGIN_AREA
;
5350 else if (part
== ON_RIGHT_MARGIN
)
5351 area
= RIGHT_MARGIN_AREA
;
5355 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5356 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5359 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5363 /* Find the glyph under X. If we find one with a string object,
5364 it's the one we were looking for. */
5365 if (area
== RIGHT_MARGIN_AREA
)
5366 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5367 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5368 : WINDOW_FRINGES_WIDTH (w
))
5369 + window_box_width (w
, LEFT_MARGIN_AREA
)
5370 + window_box_width (w
, TEXT_AREA
));
5372 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5373 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5376 glyph
= row
->glyphs
[area
];
5377 end
= glyph
+ row
->used
[area
];
5378 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5379 x0
-= glyph
->pixel_width
;
5380 *x
= glyph
- row
->glyphs
[area
];
5383 string
= glyph
->object
;
5384 *charpos
= glyph
->charpos
;
5385 *width
= glyph
->pixel_width
;
5386 *height
= glyph
->ascent
+ glyph
->descent
;
5387 #ifdef HAVE_WINDOW_SYSTEM
5388 if (glyph
->type
== IMAGE_GLYPH
)
5391 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5393 *object
= img
->spec
;
5394 y0
-= row
->ascent
- glyph
->ascent
;
5395 x0
+= glyph
->slice
.img
.x
;
5396 y0
+= glyph
->slice
.img
.y
;
5402 /* Add extra (default width) columns if clicked after EOL. */
5403 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5405 *height
= row
->height
;
5412 *width
= *height
= 0;
5422 /***********************************************************************
5423 Changing Frame Sizes
5424 ***********************************************************************/
5428 static void deliver_window_change_signal (int);
5431 handle_window_change_signal (int sig
)
5434 struct tty_display_info
*tty
;
5436 /* The frame size change obviously applies to a single
5437 termcap-controlled terminal, but we can't decide which.
5438 Therefore, we resize the frames corresponding to each tty.
5440 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5442 if (! tty
->term_initted
)
5445 /* Suspended tty frames have tty->input == NULL avoid trying to
5450 get_tty_size (fileno (tty
->input
), &width
, &height
);
5452 if (width
> 5 && height
> 2) {
5453 Lisp_Object tail
, frame
;
5455 FOR_EACH_FRAME (tail
, frame
)
5456 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5457 /* Record the new sizes, but don't reallocate the data
5458 structures now. Let that be done later outside of the
5460 change_frame_size (XFRAME (frame
), width
,
5461 height
- FRAME_MENU_BAR_LINES (XFRAME (frame
)),
5468 deliver_window_change_signal (int sig
)
5470 deliver_process_signal (sig
, handle_window_change_signal
);
5472 #endif /* SIGWINCH */
5475 /* Do any change in frame size that was requested by a signal.
5476 SAFE means this function is called from a place where it is
5477 safe to change frame sizes while a redisplay is in progress. */
5480 do_pending_window_change (bool safe
)
5482 /* If window change signal handler should have run before, run it now. */
5483 if (redisplaying_p
&& !safe
)
5486 while (delayed_size_change
)
5488 Lisp_Object tail
, frame
;
5490 delayed_size_change
= 0;
5492 FOR_EACH_FRAME (tail
, frame
)
5494 struct frame
*f
= XFRAME (frame
);
5496 if (f
->new_height
!= 0 || f
->new_width
!= 0)
5497 change_frame_size (f
, f
->new_width
, f
->new_height
,
5498 0, 0, safe
, f
->new_pixelwise
);
5505 change_frame_size_1 (struct frame
*f
, int new_width
, int new_height
,
5506 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5508 /* If we can't deal with the change now, queue it for later. */
5509 if (delay
|| (redisplaying_p
&& !safe
))
5511 f
->new_width
= new_width
;
5512 f
->new_height
= new_height
;
5513 f
->new_pixelwise
= pixelwise
;
5514 delayed_size_change
= 1;
5518 /* This size-change overrides any pending one for this frame. */
5521 f
->new_pixelwise
= 0;
5523 /* If an argument is zero, set it to the current value. */
5526 new_width
= (new_width
<= 0) ? FRAME_TEXT_WIDTH (f
) : new_width
;
5527 new_height
= (new_height
<= 0) ? FRAME_TEXT_HEIGHT (f
) : new_height
;
5531 new_width
= (((new_width
<= 0) ? FRAME_COLS (f
) : new_width
)
5532 * FRAME_COLUMN_WIDTH (f
));
5533 new_height
= (((new_height
<= 0) ? FRAME_LINES (f
) : new_height
)
5534 * FRAME_LINE_HEIGHT (f
));
5537 /* Adjust frame size but make sure x_set_window_size does not
5539 adjust_frame_size (f
, new_width
, new_height
, 5, pretend
,
5540 Qchange_frame_size
);
5545 /* Change text height/width of frame F. Values may be given as zero to
5546 indicate that no change is needed.
5548 If DELAY, assume we're being called from a signal handler, and queue
5549 the change for later - perhaps the next redisplay. Since this tries
5550 to resize windows, we can't call it from a signal handler.
5552 SAFE means this function is called from a place where it's safe to
5553 change frame sizes while a redisplay is in progress. */
5555 change_frame_size (struct frame
*f
, int new_width
, int new_height
,
5556 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5558 Lisp_Object tail
, frame
;
5560 if (FRAME_MSDOS_P (f
))
5562 /* On MS-DOS, all frames use the same screen, so a change in
5563 size affects all frames. Termcap now supports multiple
5565 FOR_EACH_FRAME (tail
, frame
)
5566 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5567 change_frame_size_1 (XFRAME (frame
), new_width
, new_height
,
5568 pretend
, delay
, safe
, pixelwise
);
5571 change_frame_size_1 (f
, new_width
, new_height
, pretend
, delay
, safe
,
5575 /***********************************************************************
5576 Terminal Related Lisp Functions
5577 ***********************************************************************/
5579 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5580 1, 1, "FOpen termscript file: ",
5581 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5582 FILE = nil means just close any termscript file currently open. */)
5585 struct tty_display_info
*tty
;
5587 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5588 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5589 error ("Current frame is not on a tty device");
5593 if (tty
->termscript
!= 0)
5596 fclose (tty
->termscript
);
5597 tty
->termscript
= 0;
5603 file
= Fexpand_file_name (file
, Qnil
);
5604 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5605 if (tty
->termscript
== 0)
5606 report_file_error ("Opening termscript", file
);
5612 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5613 Ssend_string_to_terminal
, 1, 2, 0,
5614 doc
: /* Send STRING to the terminal without alteration.
5615 Control characters in STRING will have terminal-dependent effects.
5617 Optional parameter TERMINAL specifies the tty terminal device to use.
5618 It may be a terminal object, a frame, or nil for the terminal used by
5619 the currently selected frame. In batch mode, STRING is sent to stdout
5620 when TERMINAL is nil. */)
5621 (Lisp_Object string
, Lisp_Object terminal
)
5623 struct terminal
*t
= decode_live_terminal (terminal
);
5626 /* ??? Perhaps we should do something special for multibyte strings here. */
5627 CHECK_STRING (string
);
5630 if (t
->type
== output_initial
)
5632 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5633 error ("Device %d is not a termcap terminal device", t
->id
);
5636 struct tty_display_info
*tty
= t
->display_info
.tty
;
5639 error ("Terminal is currently suspended");
5641 if (tty
->termscript
)
5643 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5644 fflush (tty
->termscript
);
5648 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5655 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5656 doc
: /* Beep, or flash the screen.
5657 Also, unless an argument is given,
5658 terminate any keyboard macro currently executing. */)
5666 ring_bell (XFRAME (selected_frame
));
5675 bitch_at_user (void)
5679 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5682 = "Keyboard macro terminated by a command ringing the bell";
5683 Fsignal (Quser_error
, list1 (build_string (msg
)));
5686 ring_bell (XFRAME (selected_frame
));
5691 /***********************************************************************
5693 ***********************************************************************/
5695 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5696 doc
: /* Pause, without updating display, for SECONDS seconds.
5697 SECONDS may be a floating-point value, meaning that you can wait for a
5698 fraction of a second. Optional second arg MILLISECONDS specifies an
5699 additional wait period, in milliseconds; this is for backwards compatibility.
5700 \(Not all operating systems support waiting for a fraction of a second.) */)
5701 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5703 double duration
= extract_float (seconds
);
5705 if (!NILP (milliseconds
))
5707 CHECK_NUMBER (milliseconds
);
5708 duration
+= XINT (milliseconds
) / 1000.0;
5713 struct timespec t
= dtotimespec (duration
);
5714 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5715 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5722 /* This is just like wait_reading_process_output, except that
5725 TIMEOUT is number of seconds to wait (float or integer),
5726 or t to wait forever.
5727 READING is true if reading input.
5728 If DISPLAY_OPTION is >0 display process output while waiting.
5729 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5733 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5737 bool do_display
= display_option
> 0;
5739 swallow_events (do_display
);
5741 if ((detect_input_pending_run_timers (do_display
))
5742 || !NILP (Vexecuting_kbd_macro
))
5745 if (display_option
> 1)
5746 redisplay_preserve_echo_area (2);
5748 if (INTEGERP (timeout
))
5750 sec
= XINT (timeout
);
5755 else if (FLOATP (timeout
))
5757 double seconds
= XFLOAT_DATA (timeout
);
5758 if (! (0 < seconds
))
5762 struct timespec t
= dtotimespec (seconds
);
5763 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5767 else if (EQ (timeout
, Qt
))
5773 wrong_type_argument (Qnumberp
, timeout
);
5780 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5783 return detect_input_pending () ? Qnil
: Qt
;
5787 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5788 doc
: /* Perform redisplay.
5789 Optional arg FORCE, if non-nil, prevents redisplay from being
5790 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5791 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5792 preempted by arriving input, so FORCE does nothing.
5794 Return t if redisplay was performed, nil if redisplay was preempted
5795 immediately by pending input. */)
5800 swallow_events (true);
5801 if ((detect_input_pending_run_timers (1)
5802 && NILP (force
) && !redisplay_dont_pause
)
5803 || !NILP (Vexecuting_kbd_macro
))
5806 count
= SPECPDL_INDEX ();
5807 if (!NILP (force
) && !redisplay_dont_pause
)
5808 specbind (Qredisplay_dont_pause
, Qt
);
5809 redisplay_preserve_echo_area (2);
5810 unbind_to (count
, Qnil
);
5816 /***********************************************************************
5817 Other Lisp Functions
5818 ***********************************************************************/
5820 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5821 session's frames, frame names, buffers, buffer-read-only flags, and
5822 buffer-modified-flags. */
5824 static Lisp_Object frame_and_buffer_state
;
5827 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5828 Sframe_or_buffer_changed_p
, 0, 1, 0,
5829 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5830 VARIABLE is a variable name whose value is either nil or a state vector
5831 that will be updated to contain all frames and buffers,
5832 aside from buffers whose names start with space,
5833 along with the buffers' read-only and modified flags. This allows a fast
5834 check to see whether buffer menus might need to be recomputed.
5835 If this function returns non-nil, it updates the internal vector to reflect
5838 If VARIABLE is nil, an internal variable is used. Users should not
5839 pass nil for VARIABLE. */)
5840 (Lisp_Object variable
)
5842 Lisp_Object state
, tail
, frame
, buf
;
5845 if (! NILP (variable
))
5847 CHECK_SYMBOL (variable
);
5848 state
= Fsymbol_value (variable
);
5849 if (! VECTORP (state
))
5853 state
= frame_and_buffer_state
;
5856 FOR_EACH_FRAME (tail
, frame
)
5858 if (idx
== ASIZE (state
))
5860 if (!EQ (AREF (state
, idx
++), frame
))
5862 if (idx
== ASIZE (state
))
5864 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5867 /* Check that the buffer info matches. */
5868 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5870 /* Ignore buffers that aren't included in buffer lists. */
5871 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5873 if (idx
== ASIZE (state
))
5875 if (!EQ (AREF (state
, idx
++), buf
))
5877 if (idx
== ASIZE (state
))
5879 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5881 if (idx
== ASIZE (state
))
5883 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5886 if (idx
== ASIZE (state
))
5888 /* Detect deletion of a buffer at the end of the list. */
5889 if (EQ (AREF (state
, idx
), Qlambda
))
5892 /* Come here if we decide the data has changed. */
5894 /* Count the size we will need.
5895 Start with 1 so there is room for at least one lambda at the end. */
5897 FOR_EACH_FRAME (tail
, frame
)
5899 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5901 /* Reallocate the vector if data has grown to need it,
5902 or if it has shrunk a lot. */
5903 if (! VECTORP (state
)
5904 || n
> ASIZE (state
)
5905 || n
+ 20 < ASIZE (state
) / 2)
5906 /* Add 20 extra so we grow it less often. */
5908 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5909 if (! NILP (variable
))
5910 Fset (variable
, state
);
5912 frame_and_buffer_state
= state
;
5915 /* Record the new data in the (possibly reallocated) vector. */
5917 FOR_EACH_FRAME (tail
, frame
)
5919 ASET (state
, idx
, frame
);
5921 ASET (state
, idx
, XFRAME (frame
)->name
);
5924 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5926 /* Ignore buffers that aren't included in buffer lists. */
5927 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5929 ASET (state
, idx
, buf
);
5931 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5933 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5936 /* Fill up the vector with lambdas (always at least one). */
5937 ASET (state
, idx
, Qlambda
);
5939 while (idx
< ASIZE (state
))
5941 ASET (state
, idx
, Qlambda
);
5944 /* Make sure we didn't overflow the vector. */
5945 eassert (idx
<= ASIZE (state
));
5951 /***********************************************************************
5953 ***********************************************************************/
5955 /* Initialization done when Emacs fork is started, before doing stty.
5956 Determine terminal type and set terminal_driver. Then invoke its
5957 decoding routine to set up variables in the terminal package. */
5962 char *terminal_type
;
5964 /* Construct the space glyph. */
5965 space_glyph
.type
= CHAR_GLYPH
;
5966 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5967 space_glyph
.charpos
= -1;
5970 cursor_in_echo_area
= 0;
5972 /* Now is the time to initialize this; it's used by init_sys_modes
5974 Vinitial_window_system
= Qnil
;
5976 /* SIGWINCH needs to be handled no matter what display we start
5977 with. Otherwise newly opened tty frames will not resize
5982 #endif /* CANNOT_DUMP */
5984 struct sigaction action
;
5985 emacs_sigaction_init (&action
, deliver_window_change_signal
);
5986 sigaction (SIGWINCH
, &action
, 0);
5988 #endif /* SIGWINCH */
5990 /* If running as a daemon, no need to initialize any frames/terminal. */
5994 /* If the user wants to use a window system, we shouldn't bother
5995 initializing the terminal. This is especially important when the
5996 terminal is so dumb that emacs gives up before and doesn't bother
5997 using the window system.
5999 If the DISPLAY environment variable is set and nonempty,
6000 try to use X, and die with an error message if that doesn't work. */
6002 #ifdef HAVE_X_WINDOWS
6003 if (! inhibit_window_system
&& ! display_arg
)
6006 display
= getenv ("DISPLAY");
6007 display_arg
= (display
!= 0 && *display
!= 0);
6009 if (display_arg
&& !x_display_ok (display
))
6011 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6013 inhibit_window_system
= 1;
6017 if (!inhibit_window_system
&& display_arg
)
6019 Vinitial_window_system
= Qx
;
6021 Vwindow_system_version
= make_number (11);
6024 /* In some versions of ncurses,
6025 tputs crashes if we have not called tgetent.
6027 { char b
[2044]; tgetent (b
, "xterm");}
6031 #endif /* HAVE_X_WINDOWS */
6034 if (!inhibit_window_system
)
6036 Vinitial_window_system
= Qw32
;
6037 Vwindow_system_version
= make_number (1);
6040 #endif /* HAVE_NTGUI */
6043 if (!inhibit_window_system
6049 Vinitial_window_system
= Qns
;
6050 Vwindow_system_version
= make_number (10);
6055 /* If no window system has been specified, try to use the terminal. */
6057 fatal ("standard input is not a tty");
6060 terminal_type
= "w32console";
6062 terminal_type
= getenv ("TERM");
6066 #ifdef HAVE_WINDOW_SYSTEM
6067 if (! inhibit_window_system
)
6068 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6070 #endif /* HAVE_WINDOW_SYSTEM */
6071 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6077 struct frame
*f
= XFRAME (selected_frame
);
6079 init_foreground_group ();
6081 /* Open a display on the controlling tty. */
6082 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6084 /* Convert the initial frame to use the new display. */
6085 if (f
->output_method
!= output_initial
)
6087 f
->output_method
= t
->type
;
6090 t
->reference_count
++;
6092 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6094 if (f
->output_method
== output_termcap
)
6095 create_tty_output (f
);
6097 t
->display_info
.tty
->top_frame
= selected_frame
;
6098 change_frame_size (XFRAME (selected_frame
),
6099 FrameCols (t
->display_info
.tty
),
6100 FrameRows (t
->display_info
.tty
)
6101 - FRAME_MENU_BAR_LINES (f
), 0, 0, 1, 0);
6103 /* Delete the initial terminal. */
6104 if (--initial_terminal
->reference_count
== 0
6105 && initial_terminal
->delete_terminal_hook
)
6106 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6108 /* Update frame parameters to reflect the new type. */
6109 AUTO_FRAME_ARG (tty_type_arg
, Qtty_type
, Ftty_type (selected_frame
));
6110 Fmodify_frame_parameters (selected_frame
, tty_type_arg
);
6111 AUTO_FRAME_ARG (tty_arg
, Qtty
, (t
->display_info
.tty
->name
6112 ? build_string (t
->display_info
.tty
->name
)
6114 Fmodify_frame_parameters (selected_frame
, tty_arg
);
6118 struct frame
*sf
= SELECTED_FRAME ();
6119 int width
= FRAME_TOTAL_COLS (sf
);
6120 int height
= FRAME_TOTAL_LINES (sf
);
6122 /* If these sizes are so big they cause overflow, just ignore the
6123 change. It's not clear what better we could do. The rest of
6124 the code assumes that (width + 2) * height * sizeof (struct glyph)
6125 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6126 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6127 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6128 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6129 < (width
+ 2) * height
))
6130 fatal ("screen size %dx%d too big", width
, height
);
6133 calculate_costs (XFRAME (selected_frame
));
6135 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6138 && NILP (Vinitial_window_system
))
6140 /* For the initial frame, we don't have any way of knowing what
6141 are the foreground and background colors of the terminal. */
6142 struct frame
*sf
= SELECTED_FRAME ();
6144 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6145 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6146 call0 (intern ("tty-set-up-initial-frame-faces"));
6152 /***********************************************************************
6154 ***********************************************************************/
6156 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6157 Sinternal_show_cursor
, 2, 2, 0,
6158 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6159 WINDOW nil means use the selected window. SHOW non-nil means
6160 show a cursor in WINDOW in the next redisplay. SHOW nil means
6161 don't show a cursor. */)
6162 (Lisp_Object window
, Lisp_Object show
)
6164 /* Don't change cursor state while redisplaying. This could confuse
6166 if (!redisplaying_p
)
6167 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6172 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6173 Sinternal_show_cursor_p
, 0, 1, 0,
6174 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6175 WINDOW nil or omitted means report on the selected window. */)
6176 (Lisp_Object window
)
6178 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6181 /***********************************************************************
6183 ***********************************************************************/
6186 syms_of_display (void)
6188 defsubr (&Sredraw_frame
);
6189 defsubr (&Sredraw_display
);
6190 defsubr (&Sframe_or_buffer_changed_p
);
6191 defsubr (&Sopen_termscript
);
6193 defsubr (&Sredisplay
);
6194 defsubr (&Ssleep_for
);
6195 defsubr (&Ssend_string_to_terminal
);
6196 defsubr (&Sinternal_show_cursor
);
6197 defsubr (&Sinternal_show_cursor_p
);
6200 defsubr (&Sdump_redisplay_history
);
6203 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6204 staticpro (&frame_and_buffer_state
);
6206 /* This is the "purpose" slot of a display table. */
6207 DEFSYM (Qdisplay_table
, "display-table");
6209 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6211 DEFVAR_INT ("baud-rate", baud_rate
,
6212 doc
: /* The output baud rate of the terminal.
6213 On most systems, changing this value will affect the amount of padding
6214 and the other strategic decisions made during redisplay. */);
6216 DEFVAR_BOOL ("inverse-video", inverse_video
,
6217 doc
: /* Non-nil means invert the entire frame display.
6218 This means everything is in inverse video which otherwise would not be. */);
6220 DEFVAR_BOOL ("visible-bell", visible_bell
,
6221 doc
: /* Non-nil means try to flash the frame to represent a bell.
6223 See also `ring-bell-function'. */);
6225 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6226 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6227 A non-nil value is useful if the terminal can automatically preserve
6228 Emacs's frame display when you reenter Emacs.
6229 It is up to you to set this variable if your terminal can do that. */);
6231 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6232 doc
: /* Name of the window system that Emacs uses for the first frame.
6233 The value is a symbol:
6234 nil for a termcap frame (a character-only terminal),
6235 'x' for an Emacs frame that is really an X window,
6236 'w32' for an Emacs frame that is a window on MS-Windows display,
6237 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6238 'pc' for a direct-write MS-DOS frame.
6240 Use of this variable as a boolean is deprecated. Instead,
6241 use `display-graphic-p' or any of the other `display-*-p'
6242 predicates which report frame's specific UI-related capabilities. */);
6244 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6245 doc
: /* Name of window system through which the selected frame is displayed.
6246 The value is a symbol:
6247 nil for a termcap frame (a character-only terminal),
6248 'x' for an Emacs frame that is really an X window,
6249 'w32' for an Emacs frame that is a window on MS-Windows display,
6250 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6251 'pc' for a direct-write MS-DOS frame.
6253 Use of this variable as a boolean is deprecated. Instead,
6254 use `display-graphic-p' or any of the other `display-*-p'
6255 predicates which report frame's specific UI-related capabilities. */);
6257 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6258 doc
: /* The version number of the window system in use.
6259 For X windows, this is 11. */);
6261 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6262 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6264 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6265 doc
: /* Table defining how to output a glyph code to the frame.
6266 If not nil, this is a vector indexed by glyph code to define the glyph.
6267 Each element can be:
6268 integer: a glyph code which this glyph is an alias for.
6269 string: output this glyph using that string (not impl. in X windows).
6270 nil: this glyph mod 524288 is the code of a character to output,
6271 and this glyph / 524288 is the face number (see `face-id') to use
6272 while outputting it. */);
6273 Vglyph_table
= Qnil
;
6275 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6276 doc
: /* Display table to use for buffers that specify none.
6277 See `buffer-display-table' for more information. */);
6278 Vstandard_display_table
= Qnil
;
6280 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6281 doc
: /* Nil means display update is paused when input is detected. */);
6282 /* Contrary to expectations, a value of "false" can be detrimental to
6283 responsiveness since aborting a redisplay throws away some of the
6284 work already performed. It's usually more efficient (and gives
6285 more prompt feedback to the user) to let the redisplay terminate,
6286 and just completely skip the next command's redisplay (which is
6287 done regardless of this setting if there's pending input at the
6288 beginning of the next redisplay). */
6289 redisplay_dont_pause
= true;
6295 Vinitial_window_system
= Qnil
;
6296 Vwindow_system_version
= Qnil
;