1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2013 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/>. */
23 #define DISPEXTERN_INLINE EXTERN_INLINE
30 /* cm.h must come after dispextern.h on Windows. */
31 #include "dispextern.h"
33 #include "character.h"
37 #include "termhooks.h"
42 #include "intervals.h"
43 #include "blockinput.h"
46 #include "syssignal.h"
48 #ifdef HAVE_WINDOW_SYSTEM
50 #endif /* HAVE_WINDOW_SYSTEM */
57 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
58 #include <term.h> /* for tgetent */
65 /* Structure to pass dimensions around. Used for character bounding
66 boxes, glyph matrix dimensions and alike. */
75 /* Function prototypes. */
77 static void update_frame_line (struct frame
*, int);
78 static int required_matrix_height (struct window
*);
79 static int required_matrix_width (struct window
*);
80 static void change_frame_size_1 (struct frame
*, int, int, bool, bool, bool);
81 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
82 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
83 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
85 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
87 static void adjust_decode_mode_spec_buffer (struct frame
*);
88 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
89 static void clear_window_matrices (struct window
*, bool);
90 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
91 static int scrolling_window (struct window
*, bool);
92 static bool update_window_line (struct window
*, int, bool *);
93 static void mirror_make_current (struct window
*, int);
95 static void check_matrix_pointers (struct glyph_matrix
*,
96 struct glyph_matrix
*);
98 static void mirror_line_dance (struct window
*, int, int, int *, char *);
99 static bool update_window_tree (struct window
*, bool);
100 static bool update_window (struct window
*, bool);
101 static bool update_frame_1 (struct frame
*, bool, bool);
102 static bool scrolling (struct frame
*);
103 static void set_window_cursor_after_update (struct window
*);
104 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
105 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
107 /* True upon entry to redisplay means do not assume anything about
108 current contents of actual terminal frame; clear and redraw it. */
112 /* True means last display completed. False means it was preempted. */
114 bool display_completed
;
116 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
119 /* The currently selected frame. In a single-frame version, this
120 variable always equals the_only_frame. */
122 Lisp_Object selected_frame
;
124 /* A frame which is not just a mini-buffer, or 0 if there are no such
125 frames. This is usually the most recent such frame that was
126 selected. In a single-frame version, this variable always holds
127 the address of the_only_frame. */
129 struct frame
*last_nonminibuf_frame
;
131 /* True means SIGWINCH happened when not safe. */
133 static bool delayed_size_change
;
135 /* A glyph for a space. */
137 struct glyph space_glyph
;
139 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
141 /* Counts of allocated structures. These counts serve to diagnose
142 memory leaks and double frees. */
144 static int glyph_matrix_count
;
145 static int glyph_pool_count
;
147 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
149 /* If non-null, the frame whose frame matrices are manipulated. If
150 null, window matrices are worked on. */
152 static struct frame
*frame_matrix_frame
;
154 /* Convert vpos and hpos from frame to window and vice versa.
155 This may only be used for terminal frames. */
159 static int window_to_frame_vpos (struct window
*, int);
160 static int window_to_frame_hpos (struct window
*, int);
161 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
162 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
164 /* One element of the ring buffer containing redisplay history
167 struct redisplay_history
169 char trace
[512 + 100];
172 /* The size of the history buffer. */
174 #define REDISPLAY_HISTORY_SIZE 30
176 /* The redisplay history buffer. */
178 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
180 /* Next free entry in redisplay_history. */
182 static int history_idx
;
184 /* A tick that's incremented each time something is added to the
187 static uprintmax_t history_tick
;
189 /* Add to the redisplay history how window W has been displayed.
190 MSG is a trace containing the information how W's glyph matrix
191 has been constructed. PAUSED_P means that the update
192 has been interrupted for pending input. */
195 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
200 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
202 buf
= redisplay_history
[history_idx
].trace
;
205 snprintf (buf
, sizeof redisplay_history
[0].trace
,
206 "%"pMu
": window %p (`%s')%s\n%s",
209 ((BUFFERP (w
->contents
)
210 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
211 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
213 paused_p
? " ***paused***" : "",
218 /* Add to the redisplay history that frame F has been displayed.
219 PAUSED_P means that the update has been interrupted for
223 add_frame_display_history (struct frame
*f
, bool paused_p
)
228 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
230 buf
= redisplay_history
[history_idx
].trace
;
233 sprintf (buf
, "%"pMu
": update frame %p%s",
235 ptr
, paused_p
? " ***paused***" : "");
239 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
240 Sdump_redisplay_history
, 0, 0, "",
241 doc
: /* Dump redisplay history to stderr. */)
246 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
249 i
= REDISPLAY_HISTORY_SIZE
- 1;
250 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
257 #else /* not GLYPH_DEBUG */
259 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
260 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
262 #endif /* GLYPH_DEBUG */
265 #if (defined PROFILING \
266 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
267 && !HAVE___EXECUTABLE_START)
268 /* This function comes first in the Emacs executable and is used only
269 to estimate the text start for profiling. */
271 __executable_start (void)
277 /***********************************************************************
279 ***********************************************************************/
281 /* Allocate and return a glyph_matrix structure. POOL is the glyph
282 pool from which memory for the matrix should be allocated, or null
283 for window-based redisplay where no glyph pools are used. The
284 member `pool' of the glyph matrix structure returned is set to
285 POOL, the structure is otherwise zeroed. */
287 static struct glyph_matrix
*
288 new_glyph_matrix (struct glyph_pool
*pool
)
290 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
292 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
293 /* Increment number of allocated matrices. This count is used
294 to detect memory leaks. */
295 ++glyph_matrix_count
;
298 /* Set pool and return. */
304 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
306 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
307 glyph_matrix_count is decremented when a matrix is freed. If the count
308 gets negative, more structures were freed than allocated, i.e. one matrix
309 was freed more than once or a bogus pointer was passed to this function.
311 If MATRIX->pool is null, this means that the matrix manages its own
312 glyph memory---this is done for matrices on X frames. Freeing the
313 matrix also frees the glyph memory in this case. */
316 free_glyph_matrix (struct glyph_matrix
*matrix
)
322 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
323 /* Detect the case that more matrices are freed than were
325 --glyph_matrix_count
;
326 eassert (glyph_matrix_count
>= 0);
329 /* Free glyph memory if MATRIX owns it. */
330 if (matrix
->pool
== NULL
)
331 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
332 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
334 /* Free row structures and the matrix itself. */
335 xfree (matrix
->rows
);
341 /* Return the number of glyphs to reserve for a marginal area of
342 window W. TOTAL_GLYPHS is the number of glyphs in a complete
343 display line of window W. MARGIN gives the width of the marginal
344 area in canonical character units. */
347 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
351 int width
= w
->total_cols
;
352 double d
= max (0, margin
);
353 d
= min (width
/ 2 - 1, d
);
354 return (int) ((double) total_glyphs
/ width
* d
);
359 /* Return true if ROW's hash value is correct.
360 Optimized away if ENABLE_CHECKING is not defined. */
363 verify_row_hash (struct glyph_row
*row
)
365 return row
->hash
== row_hash (row
);
368 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
371 W is null if the function is called for a frame glyph matrix.
372 Otherwise it is the window MATRIX is a member of. X and Y are the
373 indices of the first column and row of MATRIX within the frame
374 matrix, if such a matrix exists. They are zero for purely
375 window-based redisplay. DIM is the needed size of the matrix.
377 In window-based redisplay, where no frame matrices exist, glyph
378 matrices manage their own glyph storage. Otherwise, they allocate
379 storage from a common frame glyph pool which can be found in
382 The reason for this memory management strategy is to avoid complete
383 frame redraws if possible. When we allocate from a common pool, a
384 change of the location or size of a sub-matrix within the pool
385 requires a complete redisplay of the frame because we cannot easily
386 make sure that the current matrices of all windows still agree with
387 what is displayed on the screen. While this is usually fast, it
388 leads to screen flickering. */
391 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
395 bool marginal_areas_changed_p
= 0;
396 bool header_line_changed_p
= 0;
397 bool header_line_p
= 0;
398 int left
= -1, right
= -1;
399 int window_width
= -1, window_height
= -1;
401 /* See if W had a header line that has disappeared now, or vice versa.
405 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
407 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
408 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
410 matrix
->header_line_p
= header_line_p
;
412 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
413 Do nothing if MATRIX' size, position, vscroll, and marginal areas
414 haven't changed. This optimization is important because preserving
415 the matrix means preventing redisplay. */
416 if (matrix
->pool
== NULL
)
418 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
419 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
420 eassert (left
>= 0 && right
>= 0);
421 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
422 || right
!= matrix
->right_margin_glyphs
);
424 if (!marginal_areas_changed_p
425 && !XFRAME (w
->frame
)->fonts_changed
426 && !header_line_changed_p
427 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
428 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
429 && matrix
->window_height
== window_height
430 && matrix
->window_vscroll
== w
->vscroll
431 && matrix
->window_width
== window_width
)
435 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
436 if (matrix
->rows_allocated
< dim
.height
)
438 int old_alloc
= matrix
->rows_allocated
;
439 new_rows
= dim
.height
- matrix
->rows_allocated
;
440 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
441 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
442 memset (matrix
->rows
+ old_alloc
, 0,
443 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
448 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
449 on a frame not using window-based redisplay. Set up pointers for
450 each row into the glyph pool. */
453 eassert (matrix
->pool
->glyphs
);
457 left
= margin_glyphs_to_reserve (w
, dim
.width
,
458 w
->left_margin_cols
);
459 right
= margin_glyphs_to_reserve (w
, dim
.width
,
460 w
->right_margin_cols
);
465 for (i
= 0; i
< dim
.height
; ++i
)
467 struct glyph_row
*row
= &matrix
->rows
[i
];
469 row
->glyphs
[LEFT_MARGIN_AREA
]
470 = (matrix
->pool
->glyphs
471 + (y
+ i
) * matrix
->pool
->ncolumns
475 || row
== matrix
->rows
+ dim
.height
- 1
476 || (row
== matrix
->rows
&& matrix
->header_line_p
))
478 row
->glyphs
[TEXT_AREA
]
479 = row
->glyphs
[LEFT_MARGIN_AREA
];
480 row
->glyphs
[RIGHT_MARGIN_AREA
]
481 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
482 row
->glyphs
[LAST_AREA
]
483 = row
->glyphs
[RIGHT_MARGIN_AREA
];
487 row
->glyphs
[TEXT_AREA
]
488 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
489 row
->glyphs
[RIGHT_MARGIN_AREA
]
490 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
491 row
->glyphs
[LAST_AREA
]
492 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
496 matrix
->left_margin_glyphs
= left
;
497 matrix
->right_margin_glyphs
= right
;
501 /* If MATRIX->pool is null, MATRIX is responsible for managing
502 its own memory. It is a window matrix for window-based redisplay.
503 Allocate glyph memory from the heap. */
504 if (dim
.width
> matrix
->matrix_w
506 || header_line_changed_p
507 || marginal_areas_changed_p
)
509 struct glyph_row
*row
= matrix
->rows
;
510 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
514 row
->glyphs
[LEFT_MARGIN_AREA
]
515 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
516 dim
.width
, sizeof (struct glyph
));
518 /* The mode line never has marginal areas. */
519 if (row
== matrix
->rows
+ dim
.height
- 1
520 || (row
== matrix
->rows
&& matrix
->header_line_p
))
522 row
->glyphs
[TEXT_AREA
]
523 = row
->glyphs
[LEFT_MARGIN_AREA
];
524 row
->glyphs
[RIGHT_MARGIN_AREA
]
525 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
526 row
->glyphs
[LAST_AREA
]
527 = row
->glyphs
[RIGHT_MARGIN_AREA
];
531 row
->glyphs
[TEXT_AREA
]
532 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
533 row
->glyphs
[RIGHT_MARGIN_AREA
]
534 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
535 row
->glyphs
[LAST_AREA
]
536 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
542 eassert (left
>= 0 && right
>= 0);
543 matrix
->left_margin_glyphs
= left
;
544 matrix
->right_margin_glyphs
= right
;
547 /* Number of rows to be used by MATRIX. */
548 matrix
->nrows
= dim
.height
;
549 eassert (matrix
->nrows
>= 0);
553 if (matrix
== w
->current_matrix
)
555 /* Mark rows in a current matrix of a window as not having
556 valid contents. It's important to not do this for
557 desired matrices. When Emacs starts, it may already be
558 building desired matrices when this function runs. */
559 if (window_width
< 0)
560 window_width
= window_box_width (w
, -1);
562 /* Optimize the case that only the height has changed (C-x 2,
563 upper window). Invalidate all rows that are no longer part
565 if (!marginal_areas_changed_p
566 && !header_line_changed_p
568 && dim
.width
== matrix
->matrix_w
569 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
570 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
571 && matrix
->window_width
== window_width
)
573 /* Find the last row in the window. */
574 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
575 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
581 /* Window end is invalid, if inside of the rows that
582 are invalidated below. */
583 if (w
->window_end_vpos
>= i
)
584 w
->window_end_valid
= 0;
586 while (i
< matrix
->nrows
)
587 matrix
->rows
[i
++].enabled_p
= 0;
591 for (i
= 0; i
< matrix
->nrows
; ++i
)
592 matrix
->rows
[i
].enabled_p
= 0;
595 else if (matrix
== w
->desired_matrix
)
597 /* Rows in desired matrices always have to be cleared;
598 redisplay expects this is the case when it runs, so it
599 had better be the case when we adjust matrices between
601 for (i
= 0; i
< matrix
->nrows
; ++i
)
602 matrix
->rows
[i
].enabled_p
= 0;
607 /* Remember last values to be able to optimize frame redraws. */
608 matrix
->matrix_x
= x
;
609 matrix
->matrix_y
= y
;
610 matrix
->matrix_w
= dim
.width
;
611 matrix
->matrix_h
= dim
.height
;
613 /* Record the top y location and height of W at the time the matrix
614 was last adjusted. This is used to optimize redisplay above. */
617 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
618 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
619 matrix
->window_height
= window_height
;
620 matrix
->window_width
= window_width
;
621 matrix
->window_vscroll
= w
->vscroll
;
626 /* Reverse the contents of rows in MATRIX between START and END. The
627 contents of the row at END - 1 end up at START, END - 2 at START +
628 1 etc. This is part of the implementation of rotate_matrix (see
632 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
636 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
638 /* Non-ISO HP/UX compiler doesn't like auto struct
640 struct glyph_row temp
;
641 temp
= matrix
->rows
[i
];
642 matrix
->rows
[i
] = matrix
->rows
[j
];
643 matrix
->rows
[j
] = temp
;
648 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
649 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
650 indices. (Note: this does not copy glyphs, only glyph pointers in
651 row structures are moved around).
653 The algorithm used for rotating the vector was, I believe, first
654 described by Kernighan. See the vector R as consisting of two
655 sub-vectors AB, where A has length BY for BY >= 0. The result
656 after rotating is then BA. Reverse both sub-vectors to get ArBr
657 and reverse the result to get (ArBr)r which is BA. Similar for
661 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
665 /* Up (rotate left, i.e. towards lower indices). */
667 reverse_rows (matrix
, first
, first
+ by
);
668 reverse_rows (matrix
, first
+ by
, last
);
669 reverse_rows (matrix
, first
, last
);
673 /* Down (rotate right, i.e. towards higher indices). */
674 reverse_rows (matrix
, last
- by
, last
);
675 reverse_rows (matrix
, first
, last
- by
);
676 reverse_rows (matrix
, first
, last
);
681 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
682 with indices START <= index < END. Increment positions by DELTA/
686 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
687 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
689 /* Check that START and END are reasonable values. */
690 eassert (start
>= 0 && start
<= matrix
->nrows
);
691 eassert (end
>= 0 && end
<= matrix
->nrows
);
692 eassert (start
<= end
);
694 for (; start
< end
; ++start
)
695 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
699 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
700 START and END are the row indices of the first and last + 1 row to clear. */
703 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
705 eassert (start
<= end
);
706 eassert (start
>= 0 && start
< matrix
->nrows
);
707 eassert (end
>= 0 && end
<= matrix
->nrows
);
709 for (; start
< end
; ++start
)
710 matrix
->rows
[start
].enabled_p
= 0;
716 Empty all rows in MATRIX by clearing their enabled_p flags.
717 The function prepare_desired_row will eventually really clear a row
718 when it sees one with a false enabled_p flag.
720 Reset update hints to default values. The only update hint
721 currently present is the flag MATRIX->no_scrolling_p. */
724 clear_glyph_matrix (struct glyph_matrix
*matrix
)
728 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
729 matrix
->no_scrolling_p
= 0;
734 /* Shift part of the glyph matrix MATRIX of window W up or down.
735 Increment y-positions in glyph rows between START and END by DY,
736 and recompute their visible height. */
739 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
743 eassert (start
<= end
);
744 eassert (start
>= 0 && start
< matrix
->nrows
);
745 eassert (end
>= 0 && end
<= matrix
->nrows
);
747 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
748 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
750 for (; start
< end
; ++start
)
752 struct glyph_row
*row
= &matrix
->rows
[start
];
755 row
->visible_height
= row
->height
;
758 row
->visible_height
-= min_y
- row
->y
;
759 if (row
->y
+ row
->height
> max_y
)
760 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
761 if (row
->fringe_bitmap_periodic_p
)
762 row
->redraw_fringe_bitmaps_p
= 1;
767 /* Mark all rows in current matrices of frame F as invalid. Marking
768 invalid is done by setting enabled_p to zero for all rows in a
772 clear_current_matrices (register struct frame
*f
)
774 /* Clear frame current matrix, if we have one. */
775 if (f
->current_matrix
)
776 clear_glyph_matrix (f
->current_matrix
);
778 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
779 /* Clear the matrix of the menu bar window, if such a window exists.
780 The menu bar window is currently used to display menus on X when
781 no toolkit support is compiled in. */
782 if (WINDOWP (f
->menu_bar_window
))
783 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
786 /* Clear the matrix of the tool-bar window, if any. */
787 if (WINDOWP (f
->tool_bar_window
))
788 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
790 /* Clear current window matrices. */
791 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
792 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
796 /* Clear out all display lines of F for a coming redisplay. */
799 clear_desired_matrices (register struct frame
*f
)
801 if (f
->desired_matrix
)
802 clear_glyph_matrix (f
->desired_matrix
);
804 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
805 if (WINDOWP (f
->menu_bar_window
))
806 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
809 if (WINDOWP (f
->tool_bar_window
))
810 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
812 /* Do it for window matrices. */
813 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
814 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
818 /* Clear matrices in window tree rooted in W. If DESIRED_P,
819 clear desired matrices, otherwise clear current matrices. */
822 clear_window_matrices (struct window
*w
, bool desired_p
)
826 if (WINDOWP (w
->contents
))
827 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
831 clear_glyph_matrix (w
->desired_matrix
);
834 clear_glyph_matrix (w
->current_matrix
);
835 w
->window_end_valid
= 0;
839 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
845 /***********************************************************************
848 See dispextern.h for an overall explanation of glyph rows.
849 ***********************************************************************/
851 /* Clear glyph row ROW. Do it in a way that makes it robust against
852 changes in the glyph_row structure, i.e. addition or removal of
853 structure members. */
855 static struct glyph_row null_row
;
858 clear_glyph_row (struct glyph_row
*row
)
860 struct glyph
*p
[1 + LAST_AREA
];
863 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
864 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
865 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
866 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
871 /* Restore pointers. */
872 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
873 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
874 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
875 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
877 #if 0 /* At some point, some bit-fields of struct glyph were not set,
878 which made glyphs unequal when compared with GLYPH_EQUAL_P.
879 Redisplay outputs such glyphs, and flickering effects were
880 the result. This also depended on the contents of memory
881 returned by xmalloc. If flickering happens again, activate
882 the code below. If the flickering is gone with that, chances
883 are that the flickering has the same reason as here. */
884 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
889 /* Make ROW an empty, enabled row of canonical character height,
890 in window W starting at y-position Y. */
893 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
897 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
898 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
900 clear_glyph_row (row
);
902 row
->ascent
= row
->phys_ascent
= 0;
903 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
904 row
->visible_height
= row
->height
;
907 row
->visible_height
-= min_y
- row
->y
;
908 if (row
->y
+ row
->height
> max_y
)
909 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
915 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
916 are the amounts by which to change positions. Note that the first
917 glyph of the text area of a row can have a buffer position even if
918 the used count of the text area is zero. Such rows display line
922 increment_row_positions (struct glyph_row
*row
,
923 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
927 /* Increment start and end positions. */
928 MATRIX_ROW_START_CHARPOS (row
) += delta
;
929 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
930 MATRIX_ROW_END_CHARPOS (row
) += delta
;
931 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
932 CHARPOS (row
->start
.pos
) += delta
;
933 BYTEPOS (row
->start
.pos
) += delta_bytes
;
934 CHARPOS (row
->end
.pos
) += delta
;
935 BYTEPOS (row
->end
.pos
) += delta_bytes
;
940 /* Increment positions in glyphs. */
941 for (area
= 0; area
< LAST_AREA
; ++area
)
942 for (i
= 0; i
< row
->used
[area
]; ++i
)
943 if (BUFFERP (row
->glyphs
[area
][i
].object
)
944 && row
->glyphs
[area
][i
].charpos
> 0)
945 row
->glyphs
[area
][i
].charpos
+= delta
;
947 /* Capture the case of rows displaying a line end. */
948 if (row
->used
[TEXT_AREA
] == 0
949 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
950 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
955 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
956 contents, i.e. glyph structure contents are exchanged between A and
957 B without changing glyph pointers in A and B. */
960 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
964 for (area
= 0; area
< LAST_AREA
; ++area
)
966 /* Number of glyphs to swap. */
967 int max_used
= max (a
->used
[area
], b
->used
[area
]);
969 /* Start of glyphs in area of row A. */
970 struct glyph
*glyph_a
= a
->glyphs
[area
];
972 /* End + 1 of glyphs in area of row A. */
973 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
975 /* Start of glyphs in area of row B. */
976 struct glyph
*glyph_b
= b
->glyphs
[area
];
978 while (glyph_a
< glyph_a_end
)
980 /* Non-ISO HP/UX compiler doesn't like auto struct
994 /* Exchange pointers to glyph memory between glyph rows A and B. Also
995 exchange the used[] array and the hash values of the rows, because
996 these should all go together for the row's hash value to be
1000 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1003 unsigned hash_tem
= a
->hash
;
1005 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1007 struct glyph
*temp
= a
->glyphs
[i
];
1009 a
->glyphs
[i
] = b
->glyphs
[i
];
1010 b
->glyphs
[i
] = temp
;
1013 short used_tem
= a
->used
[i
];
1015 a
->used
[i
] = b
->used
[i
];
1016 b
->used
[i
] = used_tem
;
1024 /* Copy glyph row structure FROM to glyph row structure TO, except
1025 that glyph pointers, the `used' counts, and the hash values in the
1026 structures are left unchanged. */
1029 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1031 struct glyph
*pointers
[1 + LAST_AREA
];
1032 short used
[LAST_AREA
];
1035 /* Save glyph pointers of TO. */
1036 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1037 memcpy (used
, to
->used
, sizeof to
->used
);
1040 /* Do a structure assignment. */
1043 /* Restore original pointers of TO. */
1044 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1045 memcpy (to
->used
, used
, sizeof to
->used
);
1050 /* Assign glyph row FROM to glyph row TO. This works like a structure
1051 assignment TO = FROM, except that glyph pointers are not copied but
1052 exchanged between TO and FROM. Pointers must be exchanged to avoid
1056 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1058 swap_glyph_pointers (to
, from
);
1059 copy_row_except_pointers (to
, from
);
1063 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1064 a row in a window matrix, is a slice of the glyph memory of the
1065 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1066 is true if the glyph memory of WINDOW_ROW is part of the glyph
1067 memory of FRAME_ROW. */
1072 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1074 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1075 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1076 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1078 return (frame_glyph_start
<= window_glyph_start
1079 && window_glyph_start
< frame_glyph_end
);
1082 #endif /* GLYPH_DEBUG */
1086 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1087 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1088 in WINDOW_MATRIX is found satisfying the condition. */
1090 static struct glyph_row
*
1091 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1092 struct glyph_matrix
*frame_matrix
, int row
)
1096 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1098 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1099 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1100 frame_matrix
->rows
+ row
))
1103 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1108 /* Prepare ROW for display. Desired rows are cleared lazily,
1109 i.e. they are only marked as to be cleared by setting their
1110 enabled_p flag to zero. When a row is to be displayed, a prior
1111 call to this function really clears it. */
1114 prepare_desired_row (struct glyph_row
*row
)
1116 if (!row
->enabled_p
)
1118 bool rp
= row
->reversed_p
;
1120 clear_glyph_row (row
);
1122 row
->reversed_p
= rp
;
1127 /* Return a hash code for glyph row ROW. */
1130 line_hash_code (struct glyph_row
*row
)
1136 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1137 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1141 int c
= glyph
->u
.ch
;
1142 int face_id
= glyph
->face_id
;
1143 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1145 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1146 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1158 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1159 the number of characters in the line. If must_write_spaces is
1160 zero, leading and trailing spaces are ignored. */
1163 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1165 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1166 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1167 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1169 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1170 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1172 /* Ignore trailing and leading spaces if we can. */
1173 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1175 /* Skip from the end over trailing spaces. */
1176 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1179 /* All blank line. */
1183 /* Skip over leading spaces. */
1184 while (CHAR_GLYPH_SPACE_P (*beg
))
1188 /* If we don't have a glyph-table, each glyph is one character,
1189 so return the number of glyphs. */
1190 if (glyph_table_base
== 0)
1194 /* Otherwise, scan the glyphs and accumulate their total length
1201 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1203 if (GLYPH_INVALID_P (g
)
1204 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1207 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1217 /* Return true if the glyph rows A and B have equal contents.
1218 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1221 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1223 eassert (verify_row_hash (a
));
1224 eassert (verify_row_hash (b
));
1228 else if (a
->hash
!= b
->hash
)
1232 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1235 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1238 /* Compare glyphs. */
1239 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1241 if (a
->used
[area
] != b
->used
[area
])
1244 a_glyph
= a
->glyphs
[area
];
1245 a_end
= a_glyph
+ a
->used
[area
];
1246 b_glyph
= b
->glyphs
[area
];
1248 while (a_glyph
< a_end
1249 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1250 ++a_glyph
, ++b_glyph
;
1252 if (a_glyph
!= a_end
)
1256 if (a
->fill_line_p
!= b
->fill_line_p
1257 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1258 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1259 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1260 || a
->left_fringe_offset
!= b
->left_fringe_offset
1261 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1262 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1263 || a
->right_fringe_offset
!= b
->right_fringe_offset
1264 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1265 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1266 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1267 || a
->overlapped_p
!= b
->overlapped_p
1268 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1269 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1270 || a
->reversed_p
!= b
->reversed_p
1271 /* Different partially visible characters on left margin. */
1273 /* Different height. */
1274 || a
->ascent
!= b
->ascent
1275 || a
->phys_ascent
!= b
->phys_ascent
1276 || a
->phys_height
!= b
->phys_height
1277 || a
->visible_height
!= b
->visible_height
)
1286 /***********************************************************************
1289 See dispextern.h for an overall explanation of glyph pools.
1290 ***********************************************************************/
1292 /* Allocate a glyph_pool structure. The structure returned is initialized
1293 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1294 variable glyph_pool_count is incremented for each pool allocated. */
1296 static struct glyph_pool
*
1297 new_glyph_pool (void)
1299 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1301 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1302 /* For memory leak and double deletion checking. */
1310 /* Free a glyph_pool structure POOL. The function may be called with
1311 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1312 global variable glyph_pool_count is decremented with every pool structure
1313 freed. If this count gets negative, more structures were freed than
1314 allocated, i.e. one structure must have been freed more than once or
1315 a bogus pointer was passed to free_glyph_pool. */
1318 free_glyph_pool (struct glyph_pool
*pool
)
1322 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1323 /* More freed than allocated? */
1325 eassert (glyph_pool_count
>= 0);
1327 xfree (pool
->glyphs
);
1333 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1334 columns we need. This function never shrinks a pool. The only
1335 case in which this would make sense, would be when a frame's size
1336 is changed from a large value to a smaller one. But, if someone
1337 does it once, we can expect that he will do it again.
1339 Return true if the pool changed in a way which makes
1340 re-adjusting window glyph matrices necessary. */
1343 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1348 changed_p
= (pool
->glyphs
== 0
1349 || matrix_dim
.height
!= pool
->nrows
1350 || matrix_dim
.width
!= pool
->ncolumns
);
1352 /* Enlarge the glyph pool. */
1353 needed
= matrix_dim
.width
;
1354 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1355 memory_full (SIZE_MAX
);
1356 needed
*= matrix_dim
.height
;
1357 if (needed
> pool
->nglyphs
)
1359 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1360 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1361 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1362 memset (pool
->glyphs
+ old_nglyphs
, 0,
1363 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1366 /* Remember the number of rows and columns because (a) we use them
1367 to do sanity checks, and (b) the number of columns determines
1368 where rows in the frame matrix start---this must be available to
1369 determine pointers to rows of window sub-matrices. */
1370 pool
->nrows
= matrix_dim
.height
;
1371 pool
->ncolumns
= matrix_dim
.width
;
1378 /***********************************************************************
1380 ***********************************************************************/
1385 /* Flush standard output. This is sometimes useful to call from the debugger.
1386 XXX Maybe this should be changed to flush the current terminal instead of
1390 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1399 /* Check that no glyph pointers have been lost in MATRIX. If a
1400 pointer has been lost, e.g. by using a structure assignment between
1401 rows, at least one pointer must occur more than once in the rows of
1405 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1409 for (i
= 0; i
< matrix
->nrows
; ++i
)
1410 for (j
= 0; j
< matrix
->nrows
; ++j
)
1412 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1413 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1417 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1420 matrix_row (struct glyph_matrix
*matrix
, int row
)
1422 eassert (matrix
&& matrix
->rows
);
1423 eassert (row
>= 0 && row
< matrix
->nrows
);
1425 /* That's really too slow for normal testing because this function
1426 is called almost everywhere. Although---it's still astonishingly
1427 fast, so it is valuable to have for debugging purposes. */
1429 check_matrix_pointer_lossage (matrix
);
1432 return matrix
->rows
+ row
;
1436 #if 0 /* This function makes invalid assumptions when text is
1437 partially invisible. But it might come handy for debugging
1440 /* Check invariants that must hold for an up to date current matrix of
1444 check_matrix_invariants (struct window
*w
)
1446 struct glyph_matrix
*matrix
= w
->current_matrix
;
1447 int yb
= window_text_bottom_y (w
);
1448 struct glyph_row
*row
= matrix
->rows
;
1449 struct glyph_row
*last_text_row
= NULL
;
1450 struct buffer
*saved
= current_buffer
;
1451 struct buffer
*buffer
= XBUFFER (w
->contents
);
1454 /* This can sometimes happen for a fresh window. */
1455 if (matrix
->nrows
< 2)
1458 set_buffer_temp (buffer
);
1460 /* Note: last row is always reserved for the mode line. */
1461 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1462 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1464 struct glyph_row
*next
= row
+ 1;
1466 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1467 last_text_row
= row
;
1469 /* Check that character and byte positions are in sync. */
1470 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1471 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1472 eassert (BYTEPOS (row
->start
.pos
)
1473 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1475 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1476 have such a position temporarily in case of a minibuffer
1477 displaying something like `[Sole completion]' at its end. */
1478 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1480 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1481 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1482 eassert (BYTEPOS (row
->end
.pos
)
1483 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1486 /* Check that end position of `row' is equal to start position
1488 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1490 eassert (MATRIX_ROW_END_CHARPOS (row
)
1491 == MATRIX_ROW_START_CHARPOS (next
));
1492 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1493 == MATRIX_ROW_START_BYTEPOS (next
));
1494 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1495 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1500 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1501 eassert (w
->desired_matrix
->rows
!= NULL
);
1502 set_buffer_temp (saved
);
1507 #endif /* GLYPH_DEBUG */
1511 /**********************************************************************
1512 Allocating/ Adjusting Glyph Matrices
1513 **********************************************************************/
1515 /* Allocate glyph matrices over a window tree for a frame-based
1518 X and Y are column/row within the frame glyph matrix where
1519 sub-matrices for the window tree rooted at WINDOW must be
1520 allocated. DIM_ONLY_P means that the caller of this
1521 function is only interested in the result matrix dimension, and
1522 matrix adjustments should not be performed.
1524 The function returns the total width/height of the sub-matrices of
1525 the window tree. If called on a frame root window, the computation
1526 will take the mini-buffer window into account.
1528 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1530 NEW_LEAF_MATRIX set if any window in the tree did not have a
1531 glyph matrices yet, and
1533 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1534 any window in the tree will be changed or have been changed (see
1537 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1540 Windows are arranged into chains of windows on the same level
1541 through the next fields of window structures. Such a level can be
1542 either a sequence of horizontally adjacent windows from left to
1543 right, or a sequence of vertically adjacent windows from top to
1544 bottom. Each window in a horizontal sequence can be either a leaf
1545 window or a vertical sequence; a window in a vertical sequence can
1546 be either a leaf or a horizontal sequence. All windows in a
1547 horizontal sequence have the same height, and all windows in a
1548 vertical sequence have the same width.
1550 This function uses, for historical reasons, a more general
1551 algorithm to determine glyph matrix dimensions that would be
1554 The matrix height of a horizontal sequence is determined by the
1555 maximum height of any matrix in the sequence. The matrix width of
1556 a horizontal sequence is computed by adding up matrix widths of
1557 windows in the sequence.
1559 |<------- result width ------->|
1560 +---------+----------+---------+ ---
1563 +---------+ | | result height
1568 The matrix width of a vertical sequence is the maximum matrix width
1569 of any window in the sequence. Its height is computed by adding up
1570 matrix heights of windows in the sequence.
1572 |<---- result width -->|
1580 +------------+---------+ |
1583 +------------+---------+ --- */
1585 /* Bit indicating that a new matrix will be allocated or has been
1588 #define NEW_LEAF_MATRIX (1 << 0)
1590 /* Bit indicating that a matrix will or has changed its location or
1593 #define CHANGED_LEAF_MATRIX (1 << 1)
1596 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1597 bool dim_only_p
, int *window_change_flags
)
1599 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1601 int wmax
= 0, hmax
= 0;
1605 bool in_horz_combination_p
;
1607 /* What combination is WINDOW part of? Compute this once since the
1608 result is the same for all windows in the `next' chain. The
1609 special case of a root window (parent equal to nil) is treated
1610 like a vertical combination because a root window's `next'
1611 points to the mini-buffer window, if any, which is arranged
1612 vertically below other windows. */
1613 in_horz_combination_p
1614 = (!NILP (XWINDOW (window
)->parent
)
1615 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1617 /* For WINDOW and all windows on the same level. */
1620 w
= XWINDOW (window
);
1622 /* Get the dimension of the window sub-matrix for W, depending
1623 on whether this is a combination or a leaf window. */
1624 if (WINDOWP (w
->contents
))
1625 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1627 window_change_flags
);
1630 /* If not already done, allocate sub-matrix structures. */
1631 if (w
->desired_matrix
== NULL
)
1633 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1634 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1635 *window_change_flags
|= NEW_LEAF_MATRIX
;
1638 /* Width and height MUST be chosen so that there are no
1639 holes in the frame matrix. */
1640 dim
.width
= required_matrix_width (w
);
1641 dim
.height
= required_matrix_height (w
);
1643 /* Will matrix be re-allocated? */
1644 if (x
!= w
->desired_matrix
->matrix_x
1645 || y
!= w
->desired_matrix
->matrix_y
1646 || dim
.width
!= w
->desired_matrix
->matrix_w
1647 || dim
.height
!= w
->desired_matrix
->matrix_h
1648 || (margin_glyphs_to_reserve (w
, dim
.width
,
1649 w
->left_margin_cols
)
1650 != w
->desired_matrix
->left_margin_glyphs
)
1651 || (margin_glyphs_to_reserve (w
, dim
.width
,
1652 w
->right_margin_cols
)
1653 != w
->desired_matrix
->right_margin_glyphs
))
1654 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1656 /* Actually change matrices, if allowed. Do not consider
1657 CHANGED_LEAF_MATRIX computed above here because the pool
1658 may have been changed which we don't now here. We trust
1659 that we only will be called with DIM_ONLY_P when
1663 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1664 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1668 /* If we are part of a horizontal combination, advance x for
1669 windows to the right of W; otherwise advance y for windows
1671 if (in_horz_combination_p
)
1676 /* Remember maximum glyph matrix dimensions. */
1677 wmax
= max (wmax
, dim
.width
);
1678 hmax
= max (hmax
, dim
.height
);
1680 /* Next window on same level. */
1683 while (!NILP (window
));
1685 /* Set `total' to the total glyph matrix dimension of this window
1686 level. In a vertical combination, the width is the width of the
1687 widest window; the height is the y we finally reached, corrected
1688 by the y we started with. In a horizontal combination, the total
1689 height is the height of the tallest window, and the width is the
1690 x we finally reached, corrected by the x we started with. */
1691 if (in_horz_combination_p
)
1693 total
.width
= x
- x0
;
1694 total
.height
= hmax
;
1699 total
.height
= y
- y0
;
1706 /* Return the required height of glyph matrices for window W. */
1709 required_matrix_height (struct window
*w
)
1711 #ifdef HAVE_WINDOW_SYSTEM
1712 struct frame
*f
= XFRAME (w
->frame
);
1714 if (FRAME_WINDOW_P (f
))
1716 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1717 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1718 return (((window_pixel_height
+ ch_height
- 1)
1719 / ch_height
) * w
->nrows_scale_factor
1720 /* One partially visible line at the top and
1721 bottom of the window. */
1723 /* 2 for header and mode line. */
1726 #endif /* HAVE_WINDOW_SYSTEM */
1728 return WINDOW_TOTAL_LINES (w
);
1732 /* Return the required width of glyph matrices for window W. */
1735 required_matrix_width (struct window
*w
)
1737 #ifdef HAVE_WINDOW_SYSTEM
1738 struct frame
*f
= XFRAME (w
->frame
);
1739 if (FRAME_WINDOW_P (f
))
1741 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1742 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1744 /* Compute number of glyphs needed in a glyph row. */
1745 return (((window_pixel_width
+ ch_width
- 1)
1746 / ch_width
) * w
->ncols_scale_factor
1747 /* 2 partially visible columns in the text area. */
1749 /* One partially visible column at the right
1750 edge of each marginal area. */
1753 #endif /* HAVE_WINDOW_SYSTEM */
1755 return w
->total_cols
;
1759 /* Allocate window matrices for window-based redisplay. W is the
1760 window whose matrices must be allocated/reallocated. */
1763 allocate_matrices_for_window_redisplay (struct window
*w
)
1767 if (WINDOWP (w
->contents
))
1768 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1771 /* W is a leaf window. */
1774 /* If matrices are not yet allocated, allocate them now. */
1775 if (w
->desired_matrix
== NULL
)
1777 w
->desired_matrix
= new_glyph_matrix (NULL
);
1778 w
->current_matrix
= new_glyph_matrix (NULL
);
1781 dim
.width
= required_matrix_width (w
);
1782 dim
.height
= required_matrix_height (w
);
1783 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1784 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1787 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1791 /* Allocate/reallocate glyph matrices of a single frame F.
1792 This function must be called when a new frame is created,
1793 its size changes, or its window configuration changes. */
1796 adjust_frame_glyphs (struct frame
*f
)
1798 /* Block input so that expose events and other events that access
1799 glyph matrices are not processed while we are changing them. */
1802 if (FRAME_WINDOW_P (f
))
1803 adjust_frame_glyphs_for_window_redisplay (f
);
1805 adjust_frame_glyphs_for_frame_redisplay (f
);
1807 /* Don't forget the buffer for decode_mode_spec. */
1808 adjust_decode_mode_spec_buffer (f
);
1810 f
->glyphs_initialized_p
= 1;
1815 /* Return true if any window in the tree has nonzero window margins. See
1816 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1818 showing_window_margins_p (struct window
*w
)
1822 if (WINDOWP (w
->contents
))
1824 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1827 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1830 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1836 /* In the window tree with root W, build current matrices of leaf
1837 windows from the frame's current matrix. */
1840 fake_current_matrices (Lisp_Object window
)
1844 for (; !NILP (window
); window
= w
->next
)
1846 w
= XWINDOW (window
);
1848 if (WINDOWP (w
->contents
))
1849 fake_current_matrices (w
->contents
);
1853 struct frame
*f
= XFRAME (w
->frame
);
1854 struct glyph_matrix
*m
= w
->current_matrix
;
1855 struct glyph_matrix
*fm
= f
->current_matrix
;
1857 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1858 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1860 for (i
= 0; i
< m
->matrix_h
; ++i
)
1862 struct glyph_row
*r
= m
->rows
+ i
;
1863 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1865 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1866 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1868 r
->enabled_p
= fr
->enabled_p
;
1871 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1872 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1873 r
->used
[TEXT_AREA
] = (m
->matrix_w
1874 - r
->used
[LEFT_MARGIN_AREA
]
1875 - r
->used
[RIGHT_MARGIN_AREA
]);
1884 /* Save away the contents of frame F's current frame matrix. Value is
1885 a glyph matrix holding the contents of F's current frame matrix. */
1887 static struct glyph_matrix
*
1888 save_current_matrix (struct frame
*f
)
1891 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1892 saved
->nrows
= f
->current_matrix
->nrows
;
1893 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1895 for (i
= 0; i
< saved
->nrows
; ++i
)
1897 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1898 struct glyph_row
*to
= saved
->rows
+ i
;
1899 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1900 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1901 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1902 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1909 /* Restore the contents of frame F's current frame matrix from SAVED,
1910 and free memory associated with SAVED. */
1913 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1917 for (i
= 0; i
< saved
->nrows
; ++i
)
1919 struct glyph_row
*from
= saved
->rows
+ i
;
1920 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1921 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1922 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1923 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1924 xfree (from
->glyphs
[TEXT_AREA
]);
1927 xfree (saved
->rows
);
1933 /* Allocate/reallocate glyph matrices of a single frame F for
1934 frame-based redisplay. */
1937 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1939 struct dim matrix_dim
;
1940 bool pool_changed_p
;
1941 int window_change_flags
;
1944 if (!FRAME_LIVE_P (f
))
1947 top_window_y
= FRAME_TOP_MARGIN (f
);
1949 /* Allocate glyph pool structures if not already done. */
1950 if (f
->desired_pool
== NULL
)
1952 f
->desired_pool
= new_glyph_pool ();
1953 f
->current_pool
= new_glyph_pool ();
1956 /* Allocate frames matrix structures if needed. */
1957 if (f
->desired_matrix
== NULL
)
1959 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1960 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1963 /* Compute window glyph matrices. (This takes the mini-buffer
1964 window into account). The result is the size of the frame glyph
1965 matrix needed. The variable window_change_flags is set to a bit
1966 mask indicating whether new matrices will be allocated or
1967 existing matrices change their size or location within the frame
1969 window_change_flags
= 0;
1971 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1974 &window_change_flags
);
1976 /* Add in menu bar lines, if any. */
1977 matrix_dim
.height
+= top_window_y
;
1979 /* Enlarge pools as necessary. */
1980 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
1981 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
1983 /* Set up glyph pointers within window matrices. Do this only if
1984 absolutely necessary since it requires a frame redraw. */
1985 if (pool_changed_p
|| window_change_flags
)
1987 /* Do it for window matrices. */
1988 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1990 &window_change_flags
);
1992 /* Size of frame matrices must equal size of frame. Note
1993 that we are called for X frames with window widths NOT equal
1994 to the frame width (from CHANGE_FRAME_SIZE_1). */
1995 eassert (matrix_dim
.width
== FRAME_COLS (f
)
1996 && matrix_dim
.height
== FRAME_LINES (f
));
1998 /* Pointers to glyph memory in glyph rows are exchanged during
1999 the update phase of redisplay, which means in general that a
2000 frame's current matrix consists of pointers into both the
2001 desired and current glyph pool of the frame. Adjusting a
2002 matrix sets the frame matrix up so that pointers are all into
2003 the same pool. If we want to preserve glyph contents of the
2004 current matrix over a call to adjust_glyph_matrix, we must
2005 make a copy of the current glyphs, and restore the current
2006 matrix' contents from that copy. */
2007 if (display_completed
2008 && !FRAME_GARBAGED_P (f
)
2009 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2010 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2011 /* For some reason, the frame glyph matrix gets corrupted if
2012 any of the windows contain margins. I haven't been able
2013 to hunt down the reason, but for the moment this prevents
2014 the problem from manifesting. -- cyd */
2015 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2017 struct glyph_matrix
*copy
= save_current_matrix (f
);
2018 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2019 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2020 restore_current_matrix (f
, copy
);
2021 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2025 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2026 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2027 SET_FRAME_GARBAGED (f
);
2033 /* Allocate/reallocate glyph matrices of a single frame F for
2034 window-based redisplay. */
2037 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2039 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2041 /* Allocate/reallocate window matrices. */
2042 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2044 #ifdef HAVE_X_WINDOWS
2045 /* Allocate/ reallocate matrices of the dummy window used to display
2046 the menu bar under X when no X toolkit support is available. */
2047 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2049 /* Allocate a dummy window if not already done. */
2051 if (NILP (f
->menu_bar_window
))
2054 fset_menu_bar_window (f
, make_window ());
2055 w
= XWINDOW (f
->menu_bar_window
);
2056 XSETFRAME (frame
, f
);
2057 wset_frame (w
, frame
);
2058 w
->pseudo_window_p
= 1;
2061 w
= XWINDOW (f
->menu_bar_window
);
2063 /* Set window dimensions to frame dimensions and allocate or
2064 adjust glyph matrices of W. */
2067 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2068 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2069 allocate_matrices_for_window_redisplay (w
);
2071 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2072 #endif /* HAVE_X_WINDOWS */
2076 /* Allocate/ reallocate matrices of the tool bar window. If we
2077 don't have a tool bar window yet, make one. */
2079 if (NILP (f
->tool_bar_window
))
2082 fset_tool_bar_window (f
, make_window ());
2083 w
= XWINDOW (f
->tool_bar_window
);
2084 XSETFRAME (frame
, f
);
2085 wset_frame (w
, frame
);
2086 w
->pseudo_window_p
= 1;
2089 w
= XWINDOW (f
->tool_bar_window
);
2091 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2093 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2094 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2095 allocate_matrices_for_window_redisplay (w
);
2101 /* Re-allocate buffer for decode_mode_spec on frame F. */
2104 adjust_decode_mode_spec_buffer (struct frame
*f
)
2106 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2107 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2112 /**********************************************************************
2113 Freeing Glyph Matrices
2114 **********************************************************************/
2116 /* Free glyph memory for a frame F. F may be null. This function can
2117 be called for the same frame more than once. The root window of
2118 F may be nil when this function is called. This is the case when
2119 the function is called when F is destroyed. */
2122 free_glyphs (struct frame
*f
)
2124 if (f
&& f
->glyphs_initialized_p
)
2126 /* Block interrupt input so that we don't get surprised by an X
2127 event while we're in an inconsistent state. */
2129 f
->glyphs_initialized_p
= 0;
2131 /* Release window sub-matrices. */
2132 if (!NILP (f
->root_window
))
2133 free_window_matrices (XWINDOW (f
->root_window
));
2135 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2136 /* Free the dummy window for menu bars without X toolkit and its
2138 if (!NILP (f
->menu_bar_window
))
2140 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2141 free_glyph_matrix (w
->desired_matrix
);
2142 free_glyph_matrix (w
->current_matrix
);
2143 w
->desired_matrix
= w
->current_matrix
= NULL
;
2144 fset_menu_bar_window (f
, Qnil
);
2148 /* Free the tool bar window and its glyph matrices. */
2149 if (!NILP (f
->tool_bar_window
))
2151 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2152 free_glyph_matrix (w
->desired_matrix
);
2153 free_glyph_matrix (w
->current_matrix
);
2154 w
->desired_matrix
= w
->current_matrix
= NULL
;
2155 fset_tool_bar_window (f
, Qnil
);
2158 /* Release frame glyph matrices. Reset fields to zero in
2159 case we are called a second time. */
2160 if (f
->desired_matrix
)
2162 free_glyph_matrix (f
->desired_matrix
);
2163 free_glyph_matrix (f
->current_matrix
);
2164 f
->desired_matrix
= f
->current_matrix
= NULL
;
2167 /* Release glyph pools. */
2168 if (f
->desired_pool
)
2170 free_glyph_pool (f
->desired_pool
);
2171 free_glyph_pool (f
->current_pool
);
2172 f
->desired_pool
= f
->current_pool
= NULL
;
2180 /* Free glyph sub-matrices in the window tree rooted at W. This
2181 function may be called with a null pointer, and it may be called on
2182 the same tree more than once. */
2185 free_window_matrices (struct window
*w
)
2189 if (WINDOWP (w
->contents
))
2190 free_window_matrices (XWINDOW (w
->contents
));
2193 /* This is a leaf window. Free its memory and reset fields
2194 to zero in case this function is called a second time for
2196 free_glyph_matrix (w
->current_matrix
);
2197 free_glyph_matrix (w
->desired_matrix
);
2198 w
->current_matrix
= w
->desired_matrix
= NULL
;
2201 /* Next window on same level. */
2202 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2207 /* Check glyph memory leaks. This function is called from
2208 shut_down_emacs. Note that frames are not destroyed when Emacs
2209 exits. We therefore free all glyph memory for all active frames
2210 explicitly and check that nothing is left allocated. */
2213 check_glyph_memory (void)
2215 Lisp_Object tail
, frame
;
2217 /* Free glyph memory for all frames. */
2218 FOR_EACH_FRAME (tail
, frame
)
2219 free_glyphs (XFRAME (frame
));
2221 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2222 /* Check that nothing is left allocated. */
2223 eassert (glyph_matrix_count
== 0);
2224 eassert (glyph_pool_count
== 0);
2230 /**********************************************************************
2231 Building a Frame Matrix
2232 **********************************************************************/
2234 /* Most of the redisplay code works on glyph matrices attached to
2235 windows. This is a good solution most of the time, but it is not
2236 suitable for terminal code. Terminal output functions cannot rely
2237 on being able to set an arbitrary terminal window. Instead they
2238 must be provided with a view of the whole frame, i.e. the whole
2239 screen. We build such a view by constructing a frame matrix from
2240 window matrices in this section.
2242 Windows that must be updated have their must_be_updated_p flag set.
2243 For all such windows, their desired matrix is made part of the
2244 desired frame matrix. For other windows, their current matrix is
2245 made part of the desired frame matrix.
2247 +-----------------+----------------+
2248 | desired | desired |
2250 +-----------------+----------------+
2253 +----------------------------------+
2255 Desired window matrices can be made part of the frame matrix in a
2256 cheap way: We exploit the fact that the desired frame matrix and
2257 desired window matrices share their glyph memory. This is not
2258 possible for current window matrices. Their glyphs are copied to
2259 the desired frame matrix. The latter is equivalent to
2260 preserve_other_columns in the old redisplay.
2262 Used glyphs counters for frame matrix rows are the result of adding
2263 up glyph lengths of the window matrices. A line in the frame
2264 matrix is enabled, if a corresponding line in a window matrix is
2267 After building the desired frame matrix, it will be passed to
2268 terminal code, which will manipulate both the desired and current
2269 frame matrix. Changes applied to the frame's current matrix have
2270 to be visible in current window matrices afterwards, of course.
2272 This problem is solved like this:
2274 1. Window and frame matrices share glyphs. Window matrices are
2275 constructed in a way that their glyph contents ARE the glyph
2276 contents needed in a frame matrix. Thus, any modification of
2277 glyphs done in terminal code will be reflected in window matrices
2280 2. Exchanges of rows in a frame matrix done by terminal code are
2281 intercepted by hook functions so that corresponding row operations
2282 on window matrices can be performed. This is necessary because we
2283 use pointers to glyphs in glyph row structures. To satisfy the
2284 assumption of point 1 above that glyphs are updated implicitly in
2285 window matrices when they are manipulated via the frame matrix,
2286 window and frame matrix must of course agree where to find the
2287 glyphs for their rows. Possible manipulations that must be
2288 mirrored are assignments of rows of the desired frame matrix to the
2289 current frame matrix and scrolling the current frame matrix. */
2291 /* Build frame F's desired matrix from window matrices. Only windows
2292 which have the flag must_be_updated_p set have to be updated. Menu
2293 bar lines of a frame are not covered by window matrices, so make
2294 sure not to touch them in this function. */
2297 build_frame_matrix (struct frame
*f
)
2301 /* F must have a frame matrix when this function is called. */
2302 eassert (!FRAME_WINDOW_P (f
));
2304 /* Clear all rows in the frame matrix covered by window matrices.
2305 Menu bar lines are not covered by windows. */
2306 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2307 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2309 /* Build the matrix by walking the window tree. */
2310 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2311 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2315 /* Walk a window tree, building a frame matrix MATRIX from window
2316 matrices. W is the root of a window tree. */
2319 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2323 if (WINDOWP (w
->contents
))
2324 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2326 build_frame_matrix_from_leaf_window (matrix
, w
);
2328 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2333 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2334 desired frame matrix built. W is a leaf window whose desired or
2335 current matrix is to be added to FRAME_MATRIX. W's flag
2336 must_be_updated_p determines which matrix it contributes to
2337 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2338 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2339 Adding a desired matrix means setting up used counters and such in
2340 frame rows, while adding a current window matrix to FRAME_MATRIX
2341 means copying glyphs. The latter case corresponds to
2342 preserve_other_columns in the old redisplay. */
2345 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2347 struct glyph_matrix
*window_matrix
;
2348 int window_y
, frame_y
;
2349 /* If non-zero, a glyph to insert at the right border of W. */
2350 GLYPH right_border_glyph
;
2352 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2354 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2355 if (w
->must_be_updated_p
)
2357 window_matrix
= w
->desired_matrix
;
2359 /* Decide whether we want to add a vertical border glyph. */
2360 if (!WINDOW_RIGHTMOST_P (w
))
2362 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2365 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2367 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2369 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2370 spec_glyph_lookup_face (w
, &right_border_glyph
);
2373 if (GLYPH_FACE (right_border_glyph
) <= 0)
2374 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2378 window_matrix
= w
->current_matrix
;
2380 /* For all rows in the window matrix and corresponding rows in the
2383 frame_y
= window_matrix
->matrix_y
;
2384 while (window_y
< window_matrix
->nrows
)
2386 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2387 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2388 bool current_row_p
= window_matrix
== w
->current_matrix
;
2390 /* Fill up the frame row with spaces up to the left margin of the
2392 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2394 /* Fill up areas in the window matrix row with spaces. */
2395 fill_up_glyph_row_with_spaces (window_row
);
2397 /* If only part of W's desired matrix has been built, and
2398 window_row wasn't displayed, use the corresponding current
2400 if (window_matrix
== w
->desired_matrix
2401 && !window_row
->enabled_p
)
2403 window_row
= w
->current_matrix
->rows
+ window_y
;
2409 /* Copy window row to frame row. */
2410 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2411 window_row
->glyphs
[0],
2412 window_matrix
->matrix_w
* sizeof (struct glyph
));
2416 eassert (window_row
->enabled_p
);
2418 /* Only when a desired row has been displayed, we want
2419 the corresponding frame row to be updated. */
2420 frame_row
->enabled_p
= 1;
2422 /* Maybe insert a vertical border between horizontally adjacent
2424 if (GLYPH_CHAR (right_border_glyph
) != 0)
2426 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2427 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2431 /* Window row window_y must be a slice of frame row
2433 eassert (glyph_row_slice_p (window_row
, frame_row
));
2435 /* If rows are in sync, we don't have to copy glyphs because
2436 frame and window share glyphs. */
2438 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2439 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2443 /* Set number of used glyphs in the frame matrix. Since we fill
2444 up with spaces, and visit leaf windows from left to right it
2445 can be done simply. */
2446 frame_row
->used
[TEXT_AREA
]
2447 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2455 /* Given a user-specified glyph, possibly including a Lisp-level face
2456 ID, return a glyph that has a realized face ID.
2457 This is used for glyphs displayed specially and not part of the text;
2458 for instance, vertical separators, truncation markers, etc. */
2461 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2463 int lface_id
= GLYPH_FACE (*glyph
);
2464 /* Convert the glyph's specified face to a realized (cache) face. */
2467 int face_id
= merge_faces (XFRAME (w
->frame
),
2468 Qt
, lface_id
, DEFAULT_FACE_ID
);
2469 SET_GLYPH_FACE (*glyph
, face_id
);
2473 /* Add spaces to a glyph row ROW in a window matrix.
2475 Each row has the form:
2477 +---------+-----------------------------+------------+
2478 | left | text | right |
2479 +---------+-----------------------------+------------+
2481 Left and right marginal areas are optional. This function adds
2482 spaces to areas so that there are no empty holes between areas.
2483 In other words: If the right area is not empty, the text area
2484 is filled up with spaces up to the right area. If the text area
2485 is not empty, the left area is filled up.
2487 To be called for frame-based redisplay, only. */
2490 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2492 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2493 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2494 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2498 /* Fill area AREA of glyph row ROW with spaces. To be called for
2499 frame-based redisplay only. */
2502 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2504 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2506 struct glyph
*end
= row
->glyphs
[area
+ 1];
2507 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2510 *text
++ = space_glyph
;
2511 row
->used
[area
] = text
- row
->glyphs
[area
];
2516 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2517 reached. In frame matrices only one area, TEXT_AREA, is used. */
2520 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2522 int i
= row
->used
[TEXT_AREA
];
2523 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2526 glyph
[i
++] = space_glyph
;
2528 row
->used
[TEXT_AREA
] = i
;
2533 /**********************************************************************
2534 Mirroring operations on frame matrices in window matrices
2535 **********************************************************************/
2537 /* Set frame being updated via frame-based redisplay to F. This
2538 function must be called before updates to make explicit that we are
2539 working on frame matrices or not. */
2542 set_frame_matrix_frame (struct frame
*f
)
2544 frame_matrix_frame
= f
;
2548 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2549 DESIRED_MATRIX is the desired matrix corresponding to
2550 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2551 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2552 frame_matrix_frame is non-null, this indicates that the exchange is
2553 done in frame matrices, and that we have to perform analogous
2554 operations in window matrices of frame_matrix_frame. */
2557 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2559 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2560 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2561 bool mouse_face_p
= current_row
->mouse_face_p
;
2563 /* Do current_row = desired_row. This exchanges glyph pointers
2564 between both rows, and does a structure assignment otherwise. */
2565 assign_row (current_row
, desired_row
);
2567 /* Enable current_row to mark it as valid. */
2568 current_row
->enabled_p
= 1;
2569 current_row
->mouse_face_p
= mouse_face_p
;
2571 /* If we are called on frame matrices, perform analogous operations
2572 for window matrices. */
2573 if (frame_matrix_frame
)
2574 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2578 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2579 W's frame which has been made current (by swapping pointers between
2580 current and desired matrix). Perform analogous operations in the
2581 matrices of leaf windows in the window tree rooted at W. */
2584 mirror_make_current (struct window
*w
, int frame_row
)
2588 if (WINDOWP (w
->contents
))
2589 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2592 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2593 here because the checks performed in debug mode there
2594 will not allow the conversion. */
2595 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2597 /* If FRAME_ROW is within W, assign the desired row to the
2598 current row (exchanging glyph pointers). */
2599 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2601 struct glyph_row
*current_row
2602 = MATRIX_ROW (w
->current_matrix
, row
);
2603 struct glyph_row
*desired_row
2604 = MATRIX_ROW (w
->desired_matrix
, row
);
2606 if (desired_row
->enabled_p
)
2607 assign_row (current_row
, desired_row
);
2609 swap_glyph_pointers (desired_row
, current_row
);
2610 current_row
->enabled_p
= 1;
2612 /* Set the Y coordinate of the mode/header line's row.
2613 It is needed in draw_row_with_mouse_face to find the
2614 screen coordinates. (Window-based redisplay sets
2615 this in update_window, but no one seems to do that
2616 for frame-based redisplay.) */
2617 if (current_row
->mode_line_p
)
2618 current_row
->y
= row
;
2622 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2627 /* Perform row dance after scrolling. We are working on the range of
2628 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2629 including) in MATRIX. COPY_FROM is a vector containing, for each
2630 row I in the range 0 <= I < NLINES, the index of the original line
2631 to move to I. This index is relative to the row range, i.e. 0 <=
2632 index < NLINES. RETAINED_P is a vector containing zero for each
2633 row 0 <= I < NLINES which is empty.
2635 This function is called from do_scrolling and do_direct_scrolling. */
2638 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2639 int *copy_from
, char *retained_p
)
2641 /* A copy of original rows. */
2642 struct glyph_row
*old_rows
;
2644 /* Rows to assign to. */
2645 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2649 /* Make a copy of the original rows. */
2650 old_rows
= alloca (nlines
* sizeof *old_rows
);
2651 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2653 /* Assign new rows, maybe clear lines. */
2654 for (i
= 0; i
< nlines
; ++i
)
2656 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2658 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2659 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2660 new_rows
[i
] = old_rows
[copy_from
[i
]];
2661 new_rows
[i
].enabled_p
= enabled_before_p
;
2663 /* RETAINED_P is zero for empty lines. */
2664 if (!retained_p
[copy_from
[i
]])
2665 new_rows
[i
].enabled_p
= 0;
2668 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2669 if (frame_matrix_frame
)
2670 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2671 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2675 /* Synchronize glyph pointers in the current matrix of window W with
2676 the current frame matrix. */
2679 sync_window_with_frame_matrix_rows (struct window
*w
)
2681 struct frame
*f
= XFRAME (w
->frame
);
2682 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2683 int left
, right
, x
, width
;
2685 /* Preconditions: W must be a live window on a tty frame. */
2686 eassert (BUFFERP (w
->contents
));
2687 eassert (!FRAME_WINDOW_P (f
));
2689 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2690 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2691 x
= w
->current_matrix
->matrix_x
;
2692 width
= w
->current_matrix
->matrix_w
;
2694 window_row
= w
->current_matrix
->rows
;
2695 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2696 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2698 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2700 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2701 = frame_row
->glyphs
[0] + x
;
2702 window_row
->glyphs
[TEXT_AREA
]
2703 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2704 window_row
->glyphs
[LAST_AREA
]
2705 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2706 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2707 = window_row
->glyphs
[LAST_AREA
] - right
;
2712 /* Return the window in the window tree rooted in W containing frame
2713 row ROW. Value is null if none is found. */
2715 static struct window
*
2716 frame_row_to_window (struct window
*w
, int row
)
2718 struct window
*found
= NULL
;
2722 if (WINDOWP (w
->contents
))
2723 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2724 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2725 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2728 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2735 /* Perform a line dance in the window tree rooted at W, after
2736 scrolling a frame matrix in mirrored_line_dance.
2738 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2739 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2740 COPY_FROM is a vector containing, for each row I in the range 0 <=
2741 I < NLINES, the index of the original line to move to I. This
2742 index is relative to the row range, i.e. 0 <= index < NLINES.
2743 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2747 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2751 if (WINDOWP (w
->contents
))
2752 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2753 nlines
, copy_from
, retained_p
);
2756 /* W is a leaf window, and we are working on its current
2758 struct glyph_matrix
*m
= w
->current_matrix
;
2761 struct glyph_row
*old_rows
;
2763 /* Make a copy of the original rows of matrix m. */
2764 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2765 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2767 for (i
= 0; i
< nlines
; ++i
)
2769 /* Frame relative line assigned to. */
2770 int frame_to
= i
+ unchanged_at_top
;
2772 /* Frame relative line assigned. */
2773 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2775 /* Window relative line assigned to. */
2776 int window_to
= frame_to
- m
->matrix_y
;
2778 /* Window relative line assigned. */
2779 int window_from
= frame_from
- m
->matrix_y
;
2781 /* Is assigned line inside window? */
2782 bool from_inside_window_p
2783 = window_from
>= 0 && window_from
< m
->matrix_h
;
2785 /* Is assigned to line inside window? */
2786 bool to_inside_window_p
2787 = window_to
>= 0 && window_to
< m
->matrix_h
;
2789 if (from_inside_window_p
&& to_inside_window_p
)
2791 /* Do the assignment. The enabled_p flag is saved
2792 over the assignment because the old redisplay did
2794 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2795 m
->rows
[window_to
] = old_rows
[window_from
];
2796 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2798 /* If frame line is empty, window line is empty, too. */
2799 if (!retained_p
[copy_from
[i
]])
2800 m
->rows
[window_to
].enabled_p
= 0;
2802 else if (to_inside_window_p
)
2804 /* A copy between windows. This is an infrequent
2805 case not worth optimizing. */
2806 struct frame
*f
= XFRAME (w
->frame
);
2807 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2809 struct glyph_matrix
*m2
;
2812 w2
= frame_row_to_window (root
, frame_from
);
2813 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2814 -nw', FROM_FRAME sometimes has no associated window.
2815 This check avoids a segfault if W2 is null. */
2818 m2
= w2
->current_matrix
;
2819 m2_from
= frame_from
- m2
->matrix_y
;
2820 copy_row_except_pointers (m
->rows
+ window_to
,
2821 m2
->rows
+ m2_from
);
2823 /* If frame line is empty, window line is empty, too. */
2824 if (!retained_p
[copy_from
[i
]])
2825 m
->rows
[window_to
].enabled_p
= 0;
2829 else if (from_inside_window_p
)
2833 /* If there was a copy between windows, make sure glyph
2834 pointers are in sync with the frame matrix. */
2836 sync_window_with_frame_matrix_rows (w
);
2838 /* Check that no pointers are lost. */
2842 /* Next window on same level. */
2843 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2850 /* Check that window and frame matrices agree about their
2851 understanding where glyphs of the rows are to find. For each
2852 window in the window tree rooted at W, check that rows in the
2853 matrices of leaf window agree with their frame matrices about
2857 check_window_matrix_pointers (struct window
*w
)
2861 if (WINDOWP (w
->contents
))
2862 check_window_matrix_pointers (XWINDOW (w
->contents
));
2865 struct frame
*f
= XFRAME (w
->frame
);
2866 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2867 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2870 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2875 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2876 a window and FRAME_MATRIX is the corresponding frame matrix. For
2877 each row in WINDOW_MATRIX check that it's a slice of the
2878 corresponding frame row. If it isn't, abort. */
2881 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2882 struct glyph_matrix
*frame_matrix
)
2884 /* Row number in WINDOW_MATRIX. */
2887 /* Row number corresponding to I in FRAME_MATRIX. */
2888 int j
= window_matrix
->matrix_y
;
2890 /* For all rows check that the row in the window matrix is a
2891 slice of the row in the frame matrix. If it isn't we didn't
2892 mirror an operation on the frame matrix correctly. */
2893 while (i
< window_matrix
->nrows
)
2895 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2896 frame_matrix
->rows
+ j
))
2902 #endif /* GLYPH_DEBUG */
2906 /**********************************************************************
2907 VPOS and HPOS translations
2908 **********************************************************************/
2912 /* Translate vertical position VPOS which is relative to window W to a
2913 vertical position relative to W's frame. */
2916 window_to_frame_vpos (struct window
*w
, int vpos
)
2918 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2919 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2920 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2921 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
2926 /* Translate horizontal position HPOS which is relative to window W to
2927 a horizontal position relative to W's frame. */
2930 window_to_frame_hpos (struct window
*w
, int hpos
)
2932 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2933 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2937 #endif /* GLYPH_DEBUG */
2941 /**********************************************************************
2943 **********************************************************************/
2945 /* Redraw frame F. */
2948 redraw_frame (struct frame
*f
)
2950 /* Error if F has no glyphs. */
2951 eassert (f
->glyphs_initialized_p
);
2954 if (FRAME_MSDOS_P (f
))
2955 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
2958 clear_current_matrices (f
);
2960 if (FRAME_TERMCAP_P (f
))
2961 fflush (FRAME_TTY (f
)->output
);
2962 windows_or_buffers_changed
++;
2963 /* Mark all windows as inaccurate, so that every window will have
2964 its redisplay done. */
2965 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
2966 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
2970 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
2971 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
2972 If FRAME is omitted or nil, the selected frame is used. */)
2975 redraw_frame (decode_live_frame (frame
));
2979 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
2980 doc
: /* Clear and redisplay all visible frames. */)
2983 Lisp_Object tail
, frame
;
2985 FOR_EACH_FRAME (tail
, frame
)
2986 if (FRAME_VISIBLE_P (XFRAME (frame
)))
2987 redraw_frame (XFRAME (frame
));
2994 /***********************************************************************
2996 ***********************************************************************/
2998 /* Update frame F based on the data in desired matrices.
3000 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3001 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3003 Value is true if redisplay was stopped due to pending input. */
3006 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3008 /* True means display has been paused because of pending input. */
3010 struct window
*root_window
= XWINDOW (f
->root_window
);
3012 if (redisplay_dont_pause
)
3014 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3020 if (FRAME_WINDOW_P (f
))
3022 /* We are working on window matrix basis. All windows whose
3023 flag must_be_updated_p is set have to be updated. */
3025 /* Record that we are not working on frame matrices. */
3026 set_frame_matrix_frame (NULL
);
3028 /* Update all windows in the window tree of F, maybe stopping
3029 when pending input is detected. */
3032 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3033 /* Update the menu bar on X frames that don't have toolkit
3035 if (WINDOWP (f
->menu_bar_window
))
3036 update_window (XWINDOW (f
->menu_bar_window
), 1);
3039 /* Update the tool-bar window, if present. */
3040 if (WINDOWP (f
->tool_bar_window
))
3042 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3044 /* Update tool-bar window. */
3045 if (w
->must_be_updated_p
)
3049 update_window (w
, 1);
3050 w
->must_be_updated_p
= 0;
3052 /* Swap tool-bar strings. We swap because we want to
3054 tem
= f
->current_tool_bar_string
;
3055 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3056 fset_desired_tool_bar_string (f
, tem
);
3061 /* Update windows. */
3062 paused_p
= update_window_tree (root_window
, force_p
);
3067 /* We are working on frame matrix basis. Set the frame on whose
3068 frame matrix we operate. */
3069 set_frame_matrix_frame (f
);
3071 /* Build F's desired matrix from window matrices. */
3072 build_frame_matrix (f
);
3074 /* Update the display */
3076 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3079 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3081 if (FRAME_TTY (f
)->termscript
)
3082 fflush (FRAME_TTY (f
)->termscript
);
3083 if (FRAME_TERMCAP_P (f
))
3084 fflush (FRAME_TTY (f
)->output
);
3087 /* Check window matrices for lost pointers. */
3089 check_window_matrix_pointers (root_window
);
3090 add_frame_display_history (f
, paused_p
);
3095 /* Reset flags indicating that a window should be updated. */
3096 set_window_update_flags (root_window
, 0);
3098 display_completed
= !paused_p
;
3104 /************************************************************************
3105 Window-based updates
3106 ************************************************************************/
3108 /* Perform updates in window tree rooted at W.
3109 If FORCE_P, don't stop updating if input is pending. */
3112 update_window_tree (struct window
*w
, bool force_p
)
3116 while (w
&& !paused_p
)
3118 if (WINDOWP (w
->contents
))
3119 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3120 else if (w
->must_be_updated_p
)
3121 paused_p
|= update_window (w
, force_p
);
3123 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3130 /* Update window W if its flag must_be_updated_p is set.
3131 If FORCE_P, don't stop updating if input is pending. */
3134 update_single_window (struct window
*w
, bool force_p
)
3136 if (w
->must_be_updated_p
)
3138 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3140 /* Record that this is not a frame-based redisplay. */
3141 set_frame_matrix_frame (NULL
);
3143 if (redisplay_dont_pause
)
3148 update_window (w
, force_p
);
3151 /* Reset flag in W. */
3152 w
->must_be_updated_p
= 0;
3156 #ifdef HAVE_WINDOW_SYSTEM
3158 /* Redraw lines from the current matrix of window W that are
3159 overlapped by other rows. YB is bottom-most y-position in W. */
3162 redraw_overlapped_rows (struct window
*w
, int yb
)
3165 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3167 /* If rows overlapping others have been changed, the rows being
3168 overlapped have to be redrawn. This won't draw lines that have
3169 already been drawn in update_window_line because overlapped_p in
3170 desired rows is 0, so after row assignment overlapped_p in
3171 current rows is 0. */
3172 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3174 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3176 if (!row
->enabled_p
)
3178 else if (row
->mode_line_p
)
3181 if (row
->overlapped_p
)
3183 enum glyph_row_area area
;
3185 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3187 output_cursor_to (w
, i
, 0, row
->y
,
3188 area
== TEXT_AREA
? row
->x
: 0);
3189 if (row
->used
[area
])
3190 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3191 area
, row
->used
[area
]);
3192 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3195 row
->overlapped_p
= 0;
3198 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3204 /* Redraw lines from the current matrix of window W that overlap
3205 others. YB is bottom-most y-position in W. */
3208 redraw_overlapping_rows (struct window
*w
, int yb
)
3211 struct glyph_row
*row
;
3212 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3214 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3216 row
= w
->current_matrix
->rows
+ i
;
3218 if (!row
->enabled_p
)
3220 else if (row
->mode_line_p
)
3223 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3225 if (row
->overlapping_p
)
3229 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3230 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3231 overlaps
|= OVERLAPS_PRED
;
3232 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3233 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3234 overlaps
|= OVERLAPS_SUCC
;
3238 if (row
->used
[LEFT_MARGIN_AREA
])
3239 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3241 if (row
->used
[TEXT_AREA
])
3242 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3244 if (row
->used
[RIGHT_MARGIN_AREA
])
3245 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3247 /* Record in neighbor rows that ROW overwrites part of
3249 if (overlaps
& OVERLAPS_PRED
)
3250 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3251 if (overlaps
& OVERLAPS_SUCC
)
3252 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3261 #endif /* HAVE_WINDOW_SYSTEM */
3264 #if defined GLYPH_DEBUG && 0
3266 /* Check that no row in the current matrix of window W is enabled
3267 which is below what's displayed in the window. */
3270 check_current_matrix_flags (struct window
*w
)
3272 bool last_seen_p
= 0;
3273 int i
, yb
= window_text_bottom_y (w
);
3275 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3277 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3278 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3280 else if (last_seen_p
&& row
->enabled_p
)
3285 #endif /* GLYPH_DEBUG */
3288 /* Update display of window W.
3289 If FORCE_P, don't stop updating when input is pending. */
3292 update_window (struct window
*w
, bool force_p
)
3294 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3296 int preempt_count
= baud_rate
/ 2400 + 1;
3297 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3299 /* Check that W's frame doesn't have glyph matrices. */
3300 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3303 /* Check pending input the first time so that we can quickly return. */
3305 detect_input_pending_ignore_squeezables ();
3307 /* If forced to complete the update, or if no input is pending, do
3309 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3311 struct glyph_row
*row
, *end
;
3312 struct glyph_row
*mode_line_row
;
3313 struct glyph_row
*header_line_row
;
3315 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3318 rif
->update_window_begin_hook (w
);
3319 yb
= window_text_bottom_y (w
);
3320 row
= MATRIX_ROW (desired_matrix
, 0);
3321 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3323 /* Take note of the header line, if there is one. We will
3324 update it below, after updating all of the window's lines. */
3325 if (row
->mode_line_p
)
3327 header_line_row
= row
;
3331 header_line_row
= NULL
;
3333 /* Update the mode line, if necessary. */
3334 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3335 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3337 mode_line_row
->y
= yb
;
3338 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3340 &mouse_face_overwritten_p
);
3343 /* Find first enabled row. Optimizations in redisplay_internal
3344 may lead to an update with only one row enabled. There may
3345 be also completely empty matrices. */
3346 while (row
< end
&& !row
->enabled_p
)
3349 /* Try reusing part of the display by copying. */
3350 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3352 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3355 /* All rows were found to be equal. */
3361 /* We've scrolled the display. */
3367 /* Update the rest of the lines. */
3368 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3369 /* scrolling_window resets the enabled_p flag of the rows it
3370 reuses from current_matrix. */
3373 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3376 /* We'll have to play a little bit with when to
3377 detect_input_pending. If it's done too often,
3378 scrolling large windows with repeated scroll-up
3379 commands will too quickly pause redisplay. */
3380 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3381 detect_input_pending_ignore_squeezables ();
3382 changed_p
|= update_window_line (w
, vpos
,
3383 &mouse_face_overwritten_p
);
3385 /* Mark all rows below the last visible one in the current
3386 matrix as invalid. This is necessary because of
3387 variable line heights. Consider the case of three
3388 successive redisplays, where the first displays 5
3389 lines, the second 3 lines, and the third 5 lines again.
3390 If the second redisplay wouldn't mark rows in the
3391 current matrix invalid, the third redisplay might be
3392 tempted to optimize redisplay based on lines displayed
3393 in the first redisplay. */
3394 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3395 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3396 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3399 /* Was display preempted? */
3400 paused_p
= row
< end
;
3404 /* Update the header line after scrolling because a new header
3405 line would otherwise overwrite lines at the top of the window
3406 that can be scrolled. */
3407 if (header_line_row
&& header_line_row
->enabled_p
)
3409 header_line_row
->y
= 0;
3410 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3413 /* Fix the appearance of overlapping/overlapped rows. */
3414 if (!paused_p
&& !w
->pseudo_window_p
)
3416 #ifdef HAVE_WINDOW_SYSTEM
3417 if (changed_p
&& rif
->fix_overlapping_area
)
3419 redraw_overlapped_rows (w
, yb
);
3420 redraw_overlapping_rows (w
, yb
);
3424 /* Make cursor visible at cursor position of W. */
3425 set_window_cursor_after_update (w
);
3427 #if 0 /* Check that current matrix invariants are satisfied. This is
3428 for debugging only. See the comment of check_matrix_invariants. */
3429 IF_DEBUG (check_matrix_invariants (w
));
3434 /* Remember the redisplay method used to display the matrix. */
3435 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3438 #ifdef HAVE_WINDOW_SYSTEM
3439 update_window_fringes (w
, 0);
3442 /* End the update of window W. Don't set the cursor if we
3443 paused updating the display because in this case,
3444 set_window_cursor_after_update hasn't been called, and
3445 W->output_cursor doesn't contain the cursor location. */
3446 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3452 /* check_current_matrix_flags (w); */
3453 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3456 clear_glyph_matrix (desired_matrix
);
3462 /* Update the display of area AREA in window W, row number VPOS.
3463 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3466 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3467 enum glyph_row_area area
, int vpos
)
3469 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3470 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3472 /* Set cursor to start of glyphs, write them, and clear to the end
3473 of the area. I don't think that something more sophisticated is
3474 necessary here, since marginal areas will not be the default. */
3475 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3476 if (desired_row
->used
[area
])
3477 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3478 area
, desired_row
->used
[area
]);
3479 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3483 /* Update the display of the text area of row VPOS in window W.
3484 Value is true if display has changed. */
3487 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3489 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3490 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3491 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3494 /* If rows are at different X or Y, or rows have different height,
3495 or the current row is marked invalid, write the entire line. */
3496 if (!current_row
->enabled_p
3497 || desired_row
->y
!= current_row
->y
3498 || desired_row
->ascent
!= current_row
->ascent
3499 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3500 || desired_row
->phys_height
!= current_row
->phys_height
3501 || desired_row
->visible_height
!= current_row
->visible_height
3502 || current_row
->overlapped_p
3503 /* This next line is necessary for correctly redrawing
3504 mouse-face areas after scrolling and other operations.
3505 However, it causes excessive flickering when mouse is moved
3506 across the mode line. Luckily, turning it off for the mode
3507 line doesn't seem to hurt anything. -- cyd.
3508 But it is still needed for the header line. -- kfs. */
3509 || (current_row
->mouse_face_p
3510 && !(current_row
->mode_line_p
&& vpos
> 0))
3511 || current_row
->x
!= desired_row
->x
)
3513 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3515 if (desired_row
->used
[TEXT_AREA
])
3516 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3517 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3519 /* Clear to end of window. */
3520 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3523 /* This erases the cursor. We do this here because
3524 notice_overwritten_cursor cannot easily check this, which
3525 might indicate that the whole functionality of
3526 notice_overwritten_cursor would better be implemented here.
3527 On the other hand, we need notice_overwritten_cursor as long
3528 as mouse highlighting is done asynchronously outside of
3530 if (vpos
== w
->phys_cursor
.vpos
)
3531 w
->phys_cursor_on_p
= 0;
3536 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3537 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3538 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3539 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3540 bool abort_skipping
= 0;
3542 /* If the desired row extends its face to the text area end, and
3543 unless the current row also does so at the same position,
3544 make sure we write at least one glyph, so that the face
3545 extension actually takes place. */
3546 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3547 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3548 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3549 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3552 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3556 /* Loop over glyphs that current and desired row may have
3560 bool can_skip_p
= !abort_skipping
;
3562 /* Skip over glyphs that both rows have in common. These
3563 don't have to be written. We can't skip if the last
3564 current glyph overlaps the glyph to its right. For
3565 example, consider a current row of `if ' with the `f' in
3566 Courier bold so that it overlaps the ` ' to its right.
3567 If the desired row is ` ', we would skip over the space
3568 after the `if' and there would remain a pixel from the
3569 `f' on the screen. */
3570 if (overlapping_glyphs_p
&& i
> 0)
3572 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3575 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3577 can_skip_p
= (right
== 0 && !abort_skipping
);
3585 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3587 x
+= desired_glyph
->pixel_width
;
3588 ++desired_glyph
, ++current_glyph
, ++i
;
3591 /* Consider the case that the current row contains "xxx
3592 ppp ggg" in italic Courier font, and the desired row
3593 is "xxx ggg". The character `p' has lbearing, `g'
3594 has not. The loop above will stop in front of the
3595 first `p' in the current row. If we would start
3596 writing glyphs there, we wouldn't erase the lbearing
3597 of the `p'. The rest of the lbearing problem is then
3598 taken care of by draw_glyphs. */
3599 if (overlapping_glyphs_p
3601 && i
< current_row
->used
[TEXT_AREA
]
3602 && (current_row
->used
[TEXT_AREA
]
3603 != desired_row
->used
[TEXT_AREA
]))
3607 rif
->get_glyph_overhangs (current_glyph
,
3610 while (left
> 0 && i
> 0)
3612 --i
, --desired_glyph
, --current_glyph
;
3613 x
-= desired_glyph
->pixel_width
;
3614 left
-= desired_glyph
->pixel_width
;
3617 /* Abort the skipping algorithm if we end up before
3618 our starting point, to avoid looping (bug#1070).
3619 This can happen when the lbearing is larger than
3621 abort_skipping
= (i
< start_hpos
);
3625 /* Try to avoid writing the entire rest of the desired row
3626 by looking for a resync point. This mainly prevents
3627 mode line flickering in the case the mode line is in
3628 fixed-pitch font, which it usually will be. */
3629 if (i
< desired_row
->used
[TEXT_AREA
])
3631 int start_x
= x
, start_hpos
= i
;
3632 struct glyph
*start
= desired_glyph
;
3634 bool skip_first_p
= !can_skip_p
;
3636 /* Find the next glyph that's equal again. */
3639 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3642 x
+= desired_glyph
->pixel_width
;
3643 current_x
+= current_glyph
->pixel_width
;
3644 ++desired_glyph
, ++current_glyph
, ++i
;
3648 if (i
== start_hpos
|| x
!= current_x
)
3652 desired_glyph
= start
;
3656 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3657 rif
->write_glyphs (w
, updated_row
, start
,
3658 TEXT_AREA
, i
- start_hpos
);
3663 /* Write the rest. */
3664 if (i
< desired_row
->used
[TEXT_AREA
])
3666 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3667 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3668 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3672 /* Maybe clear to end of line. */
3673 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3675 /* If new row extends to the end of the text area, nothing
3676 has to be cleared, if and only if we did a write_glyphs
3677 above. This is made sure by setting desired_stop_pos
3678 appropriately above. */
3679 eassert (i
< desired_row
->used
[TEXT_AREA
]
3680 || ((desired_row
->used
[TEXT_AREA
]
3681 == current_row
->used
[TEXT_AREA
])
3682 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3684 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3686 /* If old row extends to the end of the text area, clear. */
3687 if (i
>= desired_row
->used
[TEXT_AREA
])
3688 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3689 desired_row
->pixel_width
);
3690 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3693 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3695 /* Otherwise clear to the end of the old row. Everything
3696 after that position should be clear already. */
3699 if (i
>= desired_row
->used
[TEXT_AREA
])
3700 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3701 desired_row
->pixel_width
);
3703 /* If cursor is displayed at the end of the line, make sure
3704 it's cleared. Nowadays we don't have a phys_cursor_glyph
3705 with which to erase the cursor (because this method
3706 doesn't work with lbearing/rbearing), so we must do it
3708 if (vpos
== w
->phys_cursor
.vpos
3709 && (desired_row
->reversed_p
3710 ? (w
->phys_cursor
.hpos
< 0)
3711 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3713 w
->phys_cursor_on_p
= 0;
3717 xlim
= current_row
->pixel_width
;
3718 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3727 /* Update row VPOS in window W. Value is true if display has been changed. */
3730 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3732 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3733 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3734 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3737 /* A row can be completely invisible in case a desired matrix was
3738 built with a vscroll and then make_cursor_line_fully_visible shifts
3739 the matrix. Make sure to make such rows current anyway, since
3740 we need the correct y-position, for example, in the current matrix. */
3741 if (desired_row
->mode_line_p
3742 || desired_row
->visible_height
> 0)
3744 eassert (desired_row
->enabled_p
);
3746 /* Update display of the left margin area, if there is one. */
3747 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3750 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3751 /* Setting this flag will ensure the vertical border, if
3752 any, between this window and the one on its left will be
3753 redrawn. This is necessary because updating the left
3754 margin area can potentially draw over the border. */
3755 current_row
->redraw_fringe_bitmaps_p
= 1;
3758 /* Update the display of the text area. */
3759 if (update_text_area (w
, desired_row
, vpos
))
3762 if (current_row
->mouse_face_p
)
3763 *mouse_face_overwritten_p
= 1;
3766 /* Update display of the right margin area, if there is one. */
3767 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3770 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3773 /* Draw truncation marks etc. */
3774 if (!current_row
->enabled_p
3775 || desired_row
->y
!= current_row
->y
3776 || desired_row
->visible_height
!= current_row
->visible_height
3777 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3778 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3779 || current_row
->redraw_fringe_bitmaps_p
3780 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3781 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3782 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3783 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3784 rif
->after_update_window_line_hook (w
, desired_row
);
3787 /* Update current_row from desired_row. */
3788 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3793 /* Set the cursor after an update of window W. This function may only
3794 be called from update_window. */
3797 set_window_cursor_after_update (struct window
*w
)
3799 struct frame
*f
= XFRAME (w
->frame
);
3800 int cx
, cy
, vpos
, hpos
;
3802 /* Not intended for frame matrix updates. */
3803 eassert (FRAME_WINDOW_P (f
));
3805 if (cursor_in_echo_area
3806 && !NILP (echo_area_buffer
[0])
3807 /* If we are showing a message instead of the mini-buffer,
3808 show the cursor for the message instead. */
3809 && XWINDOW (minibuf_window
) == w
3810 && EQ (minibuf_window
, echo_area_window
)
3811 /* These cases apply only to the frame that contains
3812 the active mini-buffer window. */
3813 && FRAME_HAS_MINIBUF_P (f
)
3814 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3816 cx
= cy
= vpos
= hpos
= 0;
3818 if (cursor_in_echo_area
>= 0)
3820 /* If the mini-buffer is several lines high, find the last
3821 line that has any text on it. Note: either all lines
3822 are enabled or none. Otherwise we wouldn't be able to
3824 struct glyph_row
*row
, *last_row
;
3825 struct glyph
*glyph
;
3826 int yb
= window_text_bottom_y (w
);
3829 row
= w
->current_matrix
->rows
;
3830 while (row
->enabled_p
3831 && (last_row
== NULL
3832 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3834 if (row
->used
[TEXT_AREA
]
3835 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3842 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3843 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3845 while (last
> start
&& last
->charpos
< 0)
3848 for (glyph
= start
; glyph
< last
; ++glyph
)
3850 cx
+= glyph
->pixel_width
;
3855 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3863 hpos
= w
->cursor
.hpos
;
3864 vpos
= w
->cursor
.vpos
;
3867 /* Window cursor can be out of sync for horizontally split windows.
3868 Horizontal position is -1 when cursor is on the left fringe. */
3869 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3870 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3871 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3875 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
3876 tree rooted at W. */
3879 set_window_update_flags (struct window
*w
, bool on_p
)
3883 if (WINDOWP (w
->contents
))
3884 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3886 w
->must_be_updated_p
= on_p
;
3888 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3894 /***********************************************************************
3895 Window-Based Scrolling
3896 ***********************************************************************/
3898 /* Structure describing rows in scrolling_window. */
3902 /* Number of occurrences of this row in desired and current matrix. */
3903 int old_uses
, new_uses
;
3905 /* Vpos of row in new matrix. */
3906 int new_line_number
;
3908 /* Bucket index of this row_entry in the hash table row_table. */
3911 /* The row described by this entry. */
3912 struct glyph_row
*row
;
3914 /* Hash collision chain. */
3915 struct row_entry
*next
;
3918 /* A pool to allocate row_entry structures from, and the size of the
3919 pool. The pool is reallocated in scrolling_window when we find
3920 that we need a larger one. */
3922 static struct row_entry
*row_entry_pool
;
3923 static ptrdiff_t row_entry_pool_size
;
3925 /* Index of next free entry in row_entry_pool. */
3927 static ptrdiff_t row_entry_idx
;
3929 /* The hash table used during scrolling, and the table's size. This
3930 table is used to quickly identify equal rows in the desired and
3933 static struct row_entry
**row_table
;
3934 static ptrdiff_t row_table_size
;
3936 /* Vectors of pointers to row_entry structures belonging to the
3937 current and desired matrix, and the size of the vectors. */
3939 static struct row_entry
**old_lines
, **new_lines
;
3940 static ptrdiff_t old_lines_size
, new_lines_size
;
3942 /* A pool to allocate run structures from, and its size. */
3944 static struct run
*run_pool
;
3945 static ptrdiff_t runs_size
;
3947 /* A vector of runs of lines found during scrolling. */
3949 static struct run
**runs
;
3951 /* Add glyph row ROW to the scrolling hash table. */
3953 static struct row_entry
*
3954 add_row_entry (struct glyph_row
*row
)
3956 struct row_entry
*entry
;
3957 ptrdiff_t i
= row
->hash
% row_table_size
;
3959 entry
= row_table
[i
];
3960 eassert (entry
|| verify_row_hash (row
));
3961 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
3962 entry
= entry
->next
;
3966 entry
= row_entry_pool
+ row_entry_idx
++;
3968 entry
->old_uses
= entry
->new_uses
= 0;
3969 entry
->new_line_number
= 0;
3971 entry
->next
= row_table
[i
];
3972 row_table
[i
] = entry
;
3979 /* Try to reuse part of the current display of W by scrolling lines.
3980 HEADER_LINE_P means W has a header line.
3982 The algorithm is taken from Communications of the ACM, Apr78 "A
3983 Technique for Isolating Differences Between Files." It should take
3986 A short outline of the steps of the algorithm
3988 1. Skip lines equal at the start and end of both matrices.
3990 2. Enter rows in the current and desired matrix into a symbol
3991 table, counting how often they appear in both matrices.
3993 3. Rows that appear exactly once in both matrices serve as anchors,
3994 i.e. we assume that such lines are likely to have been moved.
3996 4. Starting from anchor lines, extend regions to be scrolled both
3997 forward and backward.
4001 -1 if all rows were found to be equal.
4002 0 to indicate that we did not scroll the display, or
4003 1 if we did scroll. */
4006 scrolling_window (struct window
*w
, bool header_line_p
)
4008 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4009 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4010 int yb
= window_text_bottom_y (w
);
4012 int j
, first_old
, first_new
, last_old
, last_new
;
4015 struct row_entry
*entry
;
4016 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4018 /* Skip over rows equal at the start. */
4019 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4021 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4022 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4026 && !d
->redraw_fringe_bitmaps_p
4028 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4029 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4030 && row_equal_p (c
, d
, 1))
4039 /* Give up if some rows in the desired matrix are not enabled. */
4040 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4043 first_old
= first_new
= i
;
4045 /* Set last_new to the index + 1 of the row that reaches the
4046 bottom boundary in the desired matrix. Give up if we find a
4047 disabled row before we reach the bottom boundary. */
4049 while (i
< desired_matrix
->nrows
- 1)
4053 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4055 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4064 /* Set last_old to the index + 1 of the row that reaches the bottom
4065 boundary in the current matrix. We don't look at the enabled
4066 flag here because we plan to reuse part of the display even if
4067 other parts are disabled. */
4069 while (i
< current_matrix
->nrows
- 1)
4071 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4080 /* Skip over rows equal at the bottom. */
4083 while (i
- 1 > first_new
4084 && j
- 1 > first_old
4085 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4086 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4087 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4088 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4089 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4090 MATRIX_ROW (current_matrix
, j
- 1), 1))
4095 /* Nothing to do if all rows are equal. */
4096 if (last_new
== first_new
)
4099 /* Check for integer overflow in size calculation.
4101 If next_almost_prime checks (N) for divisibility by 2..10, then
4102 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4103 So, set next_almost_prime_increment_max to 10.
4105 It's just a coincidence that next_almost_prime_increment_max ==
4106 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4107 13, then next_almost_prime_increment_max would be 14, e.g.,
4108 because next_almost_prime (113) would be 127. */
4110 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4111 enum { next_almost_prime_increment_max
= 10 };
4112 ptrdiff_t row_table_max
=
4113 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4114 - next_almost_prime_increment_max
);
4115 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4116 if (current_nrows_max
< current_matrix
->nrows
)
4117 memory_full (SIZE_MAX
);
4120 /* Reallocate vectors, tables etc. if necessary. */
4122 if (current_matrix
->nrows
> old_lines_size
)
4123 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4124 current_matrix
->nrows
- old_lines_size
,
4125 INT_MAX
, sizeof *old_lines
);
4127 if (desired_matrix
->nrows
> new_lines_size
)
4128 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4129 desired_matrix
->nrows
- new_lines_size
,
4130 INT_MAX
, sizeof *new_lines
);
4132 n
= desired_matrix
->nrows
;
4133 n
+= current_matrix
->nrows
;
4134 if (row_table_size
< 3 * n
)
4136 ptrdiff_t size
= next_almost_prime (3 * n
);
4137 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4138 row_table_size
= size
;
4139 memset (row_table
, 0, size
* sizeof *row_table
);
4142 if (n
> row_entry_pool_size
)
4143 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4144 n
- row_entry_pool_size
,
4145 -1, sizeof *row_entry_pool
);
4147 if (desired_matrix
->nrows
> runs_size
)
4149 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4150 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4151 runs_size
= desired_matrix
->nrows
;
4154 nruns
= run_idx
= 0;
4157 /* Add rows from the current and desired matrix to the hash table
4158 row_hash_table to be able to find equal ones quickly. */
4160 for (i
= first_old
; i
< last_old
; ++i
)
4162 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4164 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4165 old_lines
[i
] = entry
;
4169 old_lines
[i
] = NULL
;
4172 for (i
= first_new
; i
< last_new
; ++i
)
4174 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4175 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4177 entry
->new_line_number
= i
;
4178 new_lines
[i
] = entry
;
4181 /* Identify moves based on lines that are unique and equal
4182 in both matrices. */
4183 for (i
= first_old
; i
< last_old
;)
4185 && old_lines
[i
]->old_uses
== 1
4186 && old_lines
[i
]->new_uses
== 1)
4189 int new_line
= old_lines
[i
]->new_line_number
;
4190 struct run
*run
= run_pool
+ run_idx
++;
4193 run
->current_vpos
= i
;
4194 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4195 run
->desired_vpos
= new_line
;
4196 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4198 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4200 /* Extend backward. */
4203 while (p
> first_old
4205 && old_lines
[p
] == new_lines
[q
])
4207 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4208 --run
->current_vpos
;
4209 --run
->desired_vpos
;
4212 run
->desired_y
-= h
;
4213 run
->current_y
-= h
;
4217 /* Extend forward. */
4222 && old_lines
[p
] == new_lines
[q
])
4224 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4230 /* Insert run into list of all runs. Order runs by copied
4231 pixel lines. Note that we record runs that don't have to
4232 be copied because they are already in place. This is done
4233 because we can avoid calling update_window_line in this
4235 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4237 for (q
= nruns
; q
> p
; --q
)
4238 runs
[q
] = runs
[q
- 1];
4247 /* Do the moves. Do it in a way that we don't overwrite something
4248 we want to copy later on. This is not solvable in general
4249 because there is only one display and we don't have a way to
4250 exchange areas on this display. Example:
4252 +-----------+ +-----------+
4254 +-----------+ --> +-----------+
4256 +-----------+ +-----------+
4258 Instead, prefer bigger moves, and invalidate moves that would
4259 copy from where we copied to. */
4261 for (i
= 0; i
< nruns
; ++i
)
4262 if (runs
[i
]->nrows
> 0)
4264 struct run
*r
= runs
[i
];
4266 /* Copy on the display. */
4267 if (r
->current_y
!= r
->desired_y
)
4269 rif
->clear_window_mouse_face (w
);
4270 rif
->scroll_run_hook (w
, r
);
4273 /* Truncate runs that copy to where we copied to, and
4274 invalidate runs that copy from where we copied to. */
4275 for (j
= nruns
- 1; j
> i
; --j
)
4277 struct run
*p
= runs
[j
];
4278 bool truncated_p
= 0;
4281 && p
->desired_y
< r
->desired_y
+ r
->height
4282 && p
->desired_y
+ p
->height
> r
->desired_y
)
4284 if (p
->desired_y
< r
->desired_y
)
4286 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4287 p
->height
= r
->desired_y
- p
->desired_y
;
4292 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4295 if (p
->nrows
<= nrows_copied
)
4299 int height_copied
= (r
->desired_y
+ r
->height
4302 p
->current_vpos
+= nrows_copied
;
4303 p
->desired_vpos
+= nrows_copied
;
4304 p
->nrows
-= nrows_copied
;
4305 p
->current_y
+= height_copied
;
4306 p
->desired_y
+= height_copied
;
4307 p
->height
-= height_copied
;
4313 if (r
->current_y
!= r
->desired_y
4314 /* The condition below is equivalent to
4315 ((p->current_y >= r->desired_y
4316 && p->current_y < r->desired_y + r->height)
4317 || (p->current_y + p->height > r->desired_y
4318 && (p->current_y + p->height
4319 <= r->desired_y + r->height)))
4320 because we have 0 < p->height <= r->height. */
4321 && p
->current_y
< r
->desired_y
+ r
->height
4322 && p
->current_y
+ p
->height
> r
->desired_y
)
4325 /* Reorder runs by copied pixel lines if truncated. */
4326 if (truncated_p
&& p
->nrows
> 0)
4330 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4332 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4337 /* Assign matrix rows. */
4338 for (j
= 0; j
< r
->nrows
; ++j
)
4340 struct glyph_row
*from
, *to
;
4341 bool to_overlapped_p
;
4343 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4344 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4345 to_overlapped_p
= to
->overlapped_p
;
4346 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4347 assign_row (to
, from
);
4348 /* The above `assign_row' actually does swap, so if we had
4349 an overlap in the copy destination of two runs, then
4350 the second run would assign a previously disabled bogus
4351 row. But thanks to the truncation code in the
4352 preceding for-loop, we no longer have such an overlap,
4353 and thus the assigned row should always be enabled. */
4354 eassert (to
->enabled_p
);
4355 from
->enabled_p
= 0;
4356 to
->overlapped_p
= to_overlapped_p
;
4360 /* Clear the hash table, for the next time. */
4361 for (i
= 0; i
< row_entry_idx
; ++i
)
4362 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4364 /* Value is 1 to indicate that we scrolled the display. */
4370 /************************************************************************
4372 ************************************************************************/
4374 /* Update the desired frame matrix of frame F.
4376 FORCE_P means that the update should not be stopped by pending input.
4377 INHIBIT_HAIRY_ID_P means that scrolling should not be tried.
4379 Value is true if update was stopped due to pending input. */
4382 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
)
4384 /* Frame matrices to work on. */
4385 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4386 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4389 int preempt_count
= baud_rate
/ 2400 + 1;
4391 eassert (current_matrix
&& desired_matrix
);
4393 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4394 calculate_costs (f
);
4396 if (preempt_count
<= 0)
4399 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4405 /* If we cannot insert/delete lines, it's no use trying it. */
4406 if (!FRAME_LINE_INS_DEL_OK (f
))
4409 /* See if any of the desired lines are enabled; don't compute for
4410 i/d line if just want cursor motion. */
4411 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4412 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4415 /* Try doing i/d line, if not yet inhibited. */
4416 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4417 force_p
|= scrolling (f
);
4419 /* Update the individual lines as needed. Do bottom line first. */
4420 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4421 update_frame_line (f
, desired_matrix
->nrows
- 1);
4423 /* Now update the rest of the lines. */
4424 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4426 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4428 if (FRAME_TERMCAP_P (f
))
4430 /* Flush out every so many lines.
4431 Also flush out if likely to have more than 1k buffered
4432 otherwise. I'm told that some telnet connections get
4433 really screwed by more than 1k output at once. */
4434 FILE *display_output
= FRAME_TTY (f
)->output
;
4437 ptrdiff_t outq
= __fpending (display_output
);
4439 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4440 fflush (display_output
);
4444 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4445 detect_input_pending_ignore_squeezables ();
4447 update_frame_line (f
, i
);
4451 lint_assume (0 <= FRAME_LINES (f
));
4452 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4454 /* Now just clean up termcap drivers and set cursor, etc. */
4457 if ((cursor_in_echo_area
4458 /* If we are showing a message instead of the mini-buffer,
4459 show the cursor for the message instead of for the
4460 (now hidden) mini-buffer contents. */
4461 || (EQ (minibuf_window
, selected_window
)
4462 && EQ (minibuf_window
, echo_area_window
)
4463 && !NILP (echo_area_buffer
[0])))
4464 /* These cases apply only to the frame that contains
4465 the active mini-buffer window. */
4466 && FRAME_HAS_MINIBUF_P (f
)
4467 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4469 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4472 if (cursor_in_echo_area
< 0)
4474 /* Negative value of cursor_in_echo_area means put
4475 cursor at beginning of line. */
4481 /* Positive value of cursor_in_echo_area means put
4482 cursor at the end of the prompt. If the mini-buffer
4483 is several lines high, find the last line that has
4485 row
= FRAME_LINES (f
);
4491 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4493 /* Frame rows are filled up with spaces that
4494 must be ignored here. */
4495 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4497 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4498 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4501 && (last
- 1)->charpos
< 0)
4507 while (row
> top
&& col
== 0);
4509 /* Make sure COL is not out of range. */
4510 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4512 /* If we have another row, advance cursor into it. */
4513 if (row
< FRAME_LINES (f
) - 1)
4515 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4518 /* Otherwise move it back in range. */
4520 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4524 cursor_to (f
, row
, col
);
4528 /* We have only one cursor on terminal frames. Use it to
4529 display the cursor of the selected window. */
4530 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4531 if (w
->cursor
.vpos
>= 0
4532 /* The cursor vpos may be temporarily out of bounds
4533 in the following situation: There is one window,
4534 with the cursor in the lower half of it. The window
4535 is split, and a message causes a redisplay before
4536 a new cursor position has been computed. */
4537 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4539 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4540 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4542 x
+= max (0, w
->left_margin_cols
);
4543 cursor_to (f
, y
, x
);
4550 clear_desired_matrices (f
);
4555 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4558 scrolling (struct frame
*frame
)
4560 int unchanged_at_top
, unchanged_at_bottom
;
4563 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4564 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4565 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4566 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4568 int free_at_end_vpos
= FRAME_LINES (frame
);
4569 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4570 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4572 if (!current_matrix
)
4575 /* Compute hash codes of all the lines. Also calculate number of
4576 changed lines, number of unchanged lines at the beginning, and
4577 number of unchanged lines at the end. */
4579 unchanged_at_top
= 0;
4580 unchanged_at_bottom
= FRAME_LINES (frame
);
4581 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4583 /* Give up on this scrolling if some old lines are not enabled. */
4584 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4586 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4587 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4589 /* This line cannot be redrawn, so don't let scrolling mess it. */
4590 new_hash
[i
] = old_hash
[i
];
4591 #define INFINITY 1000000 /* Taken from scroll.c */
4592 draw_cost
[i
] = INFINITY
;
4596 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4597 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4600 if (old_hash
[i
] != new_hash
[i
])
4603 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4605 else if (i
== unchanged_at_top
)
4607 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4610 /* If changed lines are few, don't allow preemption, don't scroll. */
4611 if ((!FRAME_SCROLL_REGION_OK (frame
)
4612 && changed_lines
< baud_rate
/ 2400)
4613 || unchanged_at_bottom
== FRAME_LINES (frame
))
4616 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4617 - unchanged_at_bottom
);
4619 if (FRAME_SCROLL_REGION_OK (frame
))
4620 free_at_end_vpos
-= unchanged_at_bottom
;
4621 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4622 free_at_end_vpos
= -1;
4624 /* If large window, fast terminal and few lines in common between
4625 current frame and desired frame, don't bother with i/d calc. */
4626 if (!FRAME_SCROLL_REGION_OK (frame
)
4627 && window_size
>= 18 && baud_rate
> 2400
4629 10 * scrolling_max_lines_saved (unchanged_at_top
,
4630 FRAME_LINES (frame
) - unchanged_at_bottom
,
4631 old_hash
, new_hash
, draw_cost
)))
4634 if (window_size
< 2)
4637 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4638 draw_cost
+ unchanged_at_top
- 1,
4639 old_draw_cost
+ unchanged_at_top
- 1,
4640 old_hash
+ unchanged_at_top
- 1,
4641 new_hash
+ unchanged_at_top
- 1,
4642 free_at_end_vpos
- unchanged_at_top
);
4648 /* Count the number of blanks at the start of the vector of glyphs R
4649 which is LEN glyphs long. */
4652 count_blanks (struct glyph
*r
, int len
)
4656 for (i
= 0; i
< len
; ++i
)
4657 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4664 /* Count the number of glyphs in common at the start of the glyph
4665 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4666 of STR2. Value is the number of equal glyphs equal at the start. */
4669 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4671 struct glyph
*p1
= str1
;
4672 struct glyph
*p2
= str2
;
4676 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4683 /* Char insertion/deletion cost vector, from term.c */
4685 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4688 /* Perform a frame-based update on line VPOS in frame FRAME. */
4691 update_frame_line (struct frame
*f
, int vpos
)
4693 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4695 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4696 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4697 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4698 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4699 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4700 bool must_write_whole_line_p
;
4701 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4702 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4703 != FACE_TTY_DEFAULT_BG_COLOR
);
4705 if (colored_spaces_p
)
4708 /* Current row not enabled means it has unknown contents. We must
4709 write the whole desired line in that case. */
4710 must_write_whole_line_p
= !current_row
->enabled_p
;
4711 if (must_write_whole_line_p
)
4718 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4719 olen
= current_row
->used
[TEXT_AREA
];
4721 /* Ignore trailing spaces, if we can. */
4722 if (!write_spaces_p
)
4723 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4727 current_row
->enabled_p
= 1;
4728 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4730 /* If desired line is empty, just clear the line. */
4731 if (!desired_row
->enabled_p
)
4737 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4738 nlen
= desired_row
->used
[TEXT_AREA
];
4739 nend
= nbody
+ nlen
;
4741 /* If display line has unknown contents, write the whole line. */
4742 if (must_write_whole_line_p
)
4744 /* Ignore spaces at the end, if we can. */
4745 if (!write_spaces_p
)
4746 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4749 /* Write the contents of the desired line. */
4752 cursor_to (f
, vpos
, 0);
4753 write_glyphs (f
, nbody
, nlen
);
4756 /* Don't call clear_end_of_line if we already wrote the whole
4757 line. The cursor will not be at the right margin in that
4758 case but in the line below. */
4759 if (nlen
< FRAME_TOTAL_COLS (f
))
4761 cursor_to (f
, vpos
, nlen
);
4762 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4765 /* Make sure we are in the right row, otherwise cursor movement
4766 with cmgoto might use `ch' in the wrong row. */
4767 cursor_to (f
, vpos
, 0);
4769 make_current (desired_matrix
, current_matrix
, vpos
);
4773 /* Pretend trailing spaces are not there at all,
4774 unless for one reason or another we must write all spaces. */
4775 if (!write_spaces_p
)
4776 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4779 /* If there's no i/d char, quickly do the best we can without it. */
4780 if (!FRAME_CHAR_INS_DEL_OK (f
))
4784 /* Find the first glyph in desired row that doesn't agree with
4785 a glyph in the current row, and write the rest from there on. */
4786 for (i
= 0; i
< nlen
; i
++)
4788 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4790 /* Find the end of the run of different glyphs. */
4794 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4795 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4798 /* Output this run of non-matching chars. */
4799 cursor_to (f
, vpos
, i
);
4800 write_glyphs (f
, nbody
+ i
, j
- i
);
4803 /* Now find the next non-match. */
4807 /* Clear the rest of the line, or the non-clear part of it. */
4810 cursor_to (f
, vpos
, nlen
);
4811 clear_end_of_line (f
, olen
);
4814 /* Make current row = desired row. */
4815 make_current (desired_matrix
, current_matrix
, vpos
);
4819 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4820 characters in a row. */
4824 /* If current line is blank, skip over initial spaces, if
4825 possible, and write the rest. */
4829 nsp
= count_blanks (nbody
, nlen
);
4833 cursor_to (f
, vpos
, nsp
);
4834 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4837 /* Exchange contents between current_frame and new_frame. */
4838 make_current (desired_matrix
, current_matrix
, vpos
);
4842 /* Compute number of leading blanks in old and new contents. */
4843 osp
= count_blanks (obody
, olen
);
4844 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4846 /* Compute number of matching chars starting with first non-blank. */
4847 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4848 nbody
+ nsp
, nbody
+ nlen
);
4850 /* Spaces in new match implicit space past the end of old. */
4851 /* A bug causing this to be a no-op was fixed in 18.29. */
4852 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4855 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4859 /* Avoid doing insert/delete char
4860 just cause number of leading spaces differs
4861 when the following text does not match. */
4862 if (begmatch
== 0 && osp
!= nsp
)
4863 osp
= nsp
= min (osp
, nsp
);
4865 /* Find matching characters at end of line */
4868 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4870 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4875 endmatch
= obody
+ olen
- op1
;
4877 /* tem gets the distance to insert or delete.
4878 endmatch is how many characters we save by doing so.
4881 tem
= (nlen
- nsp
) - (olen
- osp
);
4883 && (!FRAME_CHAR_INS_DEL_OK (f
)
4884 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4887 /* nsp - osp is the distance to insert or delete.
4888 If that is nonzero, begmatch is known to be nonzero also.
4889 begmatch + endmatch is how much we save by doing the ins/del.
4893 && (!FRAME_CHAR_INS_DEL_OK (f
)
4894 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
4898 osp
= nsp
= min (osp
, nsp
);
4901 /* Now go through the line, inserting, writing and
4902 deleting as appropriate. */
4906 cursor_to (f
, vpos
, nsp
);
4907 delete_glyphs (f
, osp
- nsp
);
4911 /* If going to delete chars later in line
4912 and insert earlier in the line,
4913 must delete first to avoid losing data in the insert */
4914 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
4916 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
4917 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
4918 olen
= nlen
- (nsp
- osp
);
4920 cursor_to (f
, vpos
, osp
);
4921 insert_glyphs (f
, 0, nsp
- osp
);
4925 tem
= nsp
+ begmatch
+ endmatch
;
4926 if (nlen
!= tem
|| olen
!= tem
)
4928 if (!endmatch
|| nlen
== olen
)
4930 /* If new text being written reaches right margin, there is
4931 no need to do clear-to-eol at the end of this function
4932 (and it would not be safe, since cursor is not going to
4933 be "at the margin" after the text is done). */
4934 if (nlen
== FRAME_TOTAL_COLS (f
))
4937 /* Function write_glyphs is prepared to do nothing
4938 if passed a length <= 0. Check it here to avoid
4939 unnecessary cursor movement. */
4942 cursor_to (f
, vpos
, nsp
+ begmatch
);
4943 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
4946 else if (nlen
> olen
)
4948 /* Here, we used to have the following simple code:
4949 ----------------------------------------
4950 write_glyphs (nbody + nsp + begmatch, olen - tem);
4951 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
4952 ----------------------------------------
4953 but it doesn't work if nbody[nsp + begmatch + olen - tem]
4954 is a padding glyph. */
4955 int out
= olen
- tem
; /* Columns to be overwritten originally. */
4958 cursor_to (f
, vpos
, nsp
+ begmatch
);
4960 /* Calculate columns we can actually overwrite. */
4961 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
4963 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
4965 /* If we left columns to be overwritten, we must delete them. */
4966 del
= olen
- tem
- out
;
4968 delete_glyphs (f
, del
);
4970 /* At last, we insert columns not yet written out. */
4971 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
4974 else if (olen
> nlen
)
4976 cursor_to (f
, vpos
, nsp
+ begmatch
);
4977 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
4978 delete_glyphs (f
, olen
- nlen
);
4984 /* If any unerased characters remain after the new line, erase them. */
4987 cursor_to (f
, vpos
, nlen
);
4988 clear_end_of_line (f
, olen
);
4991 /* Exchange contents between current_frame and new_frame. */
4992 make_current (desired_matrix
, current_matrix
, vpos
);
4997 /***********************************************************************
4998 X/Y Position -> Buffer Position
4999 ***********************************************************************/
5001 /* Determine what's under window-relative pixel position (*X, *Y).
5002 Return the OBJECT (string or buffer) that's there.
5003 Return in *POS the position in that object.
5004 Adjust *X and *Y to character positions.
5005 Return in *DX and *DY the pixel coordinates of the click,
5006 relative to the top left corner of OBJECT, or relative to
5007 the top left corner of the character glyph at (*X, *Y)
5009 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5010 if the coordinates point to an empty area of the display. */
5013 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
)
5016 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5017 struct text_pos startp
;
5019 struct glyph_row
*row
;
5020 #ifdef HAVE_WINDOW_SYSTEM
5021 struct image
*img
= 0;
5024 void *itdata
= NULL
;
5026 /* We used to set current_buffer directly here, but that does the
5027 wrong thing with `face-remapping-alist' (bug#2044). */
5028 Fset_buffer (w
->contents
);
5029 itdata
= bidi_shelve_cache ();
5030 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5031 start_display (&it
, w
, startp
);
5032 /* start_display takes into account the header-line row, but IT's
5033 vpos still counts from the glyph row that includes the window's
5034 start position. Adjust for a possible header-line row. */
5035 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
);
5039 /* First, move to the beginning of the row corresponding to *Y. We
5040 need to be in that row to get the correct value of base paragraph
5041 direction for the text at (*X, *Y). */
5042 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5044 /* TO_X is the pixel position that the iterator will compute for the
5045 glyph at *X. We add it.first_visible_x because iterator
5046 positions include the hscroll. */
5047 to_x
= x0
+ it
.first_visible_x
;
5048 if (it
.bidi_it
.paragraph_dir
== R2L
)
5049 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5050 text area. This is because the iterator, even in R2L
5051 paragraphs, delivers glyphs as if they started at the left
5052 margin of the window. (When we actually produce glyphs for
5053 display, we reverse their order in PRODUCE_GLYPHS, but the
5054 iterator doesn't know about that.) The following line adjusts
5055 the pixel position to the iterator geometry, which is what
5056 move_it_* routines use. (The -1 is because in a window whose
5057 text-area width is W, the rightmost pixel position is W-1, and
5058 it should be mirrored into zero pixel position.) */
5059 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5061 /* Now move horizontally in the row to the glyph under *X. Second
5062 argument is ZV to prevent move_it_in_display_line from matching
5063 based on buffer positions. */
5064 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5065 bidi_unshelve_cache (itdata
, 0);
5067 Fset_buffer (old_current_buffer
);
5069 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5070 *dy
= *y
- it
.current_y
;
5072 string
= w
->contents
;
5073 if (STRINGP (it
.string
))
5076 if (it
.what
== IT_COMPOSITION
5077 && it
.cmp_it
.nchars
> 1
5078 && it
.cmp_it
.reversed_p
)
5080 /* The current display element is a grapheme cluster in a
5081 composition. In that case, we need the position of the first
5082 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5083 it.current points to the last character of the cluster, thus
5084 we must move back to the first character of the same
5086 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5087 if (STRINGP (it
.string
))
5088 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5090 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5091 CHARPOS (pos
->pos
));
5094 #ifdef HAVE_WINDOW_SYSTEM
5095 if (it
.what
== IT_IMAGE
)
5097 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5098 && !NILP (img
->spec
))
5099 *object
= img
->spec
;
5103 if (it
.vpos
< w
->current_matrix
->nrows
5104 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5107 if (it
.hpos
< row
->used
[TEXT_AREA
])
5109 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5110 #ifdef HAVE_WINDOW_SYSTEM
5113 *dy
-= row
->ascent
- glyph
->ascent
;
5114 *dx
+= glyph
->slice
.img
.x
;
5115 *dy
+= glyph
->slice
.img
.y
;
5116 /* Image slices positions are still relative to the entire image */
5117 *width
= img
->width
;
5118 *height
= img
->height
;
5123 *width
= glyph
->pixel_width
;
5124 *height
= glyph
->ascent
+ glyph
->descent
;
5130 *height
= row
->height
;
5135 *width
= *height
= 0;
5138 /* Add extra (default width) columns if clicked after EOL. */
5139 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5141 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5150 /* Value is the string under window-relative coordinates X/Y in the
5151 mode line or header line (PART says which) of window W, or nil if none.
5152 *CHARPOS is set to the position in the string returned. */
5155 mode_line_string (struct window
*w
, enum window_part part
,
5156 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5157 int *dx
, int *dy
, int *width
, int *height
)
5159 struct glyph_row
*row
;
5160 struct glyph
*glyph
, *end
;
5162 Lisp_Object string
= Qnil
;
5164 if (part
== ON_MODE_LINE
)
5165 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5167 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5169 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5171 if (row
->mode_line_p
&& row
->enabled_p
)
5173 /* Find the glyph under X. If we find one with a string object,
5174 it's the one we were looking for. */
5175 glyph
= row
->glyphs
[TEXT_AREA
];
5176 end
= glyph
+ row
->used
[TEXT_AREA
];
5177 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5178 x0
-= glyph
->pixel_width
;
5179 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5182 string
= glyph
->object
;
5183 *charpos
= glyph
->charpos
;
5184 *width
= glyph
->pixel_width
;
5185 *height
= glyph
->ascent
+ glyph
->descent
;
5186 #ifdef HAVE_WINDOW_SYSTEM
5187 if (glyph
->type
== IMAGE_GLYPH
)
5190 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5192 *object
= img
->spec
;
5193 y0
-= row
->ascent
- glyph
->ascent
;
5199 /* Add extra (default width) columns if clicked after EOL. */
5200 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5202 *height
= row
->height
;
5209 *width
= *height
= 0;
5219 /* Value is the string under window-relative coordinates X/Y in either
5220 marginal area, or nil if none. *CHARPOS is set to the position in
5221 the string returned. */
5224 marginal_area_string (struct window
*w
, enum window_part part
,
5225 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5226 int *dx
, int *dy
, int *width
, int *height
)
5228 struct glyph_row
*row
= w
->current_matrix
->rows
;
5229 struct glyph
*glyph
, *end
;
5230 int x0
, y0
, i
, wy
= *y
;
5232 Lisp_Object string
= Qnil
;
5234 if (part
== ON_LEFT_MARGIN
)
5235 area
= LEFT_MARGIN_AREA
;
5236 else if (part
== ON_RIGHT_MARGIN
)
5237 area
= RIGHT_MARGIN_AREA
;
5241 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5242 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5245 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5249 /* Find the glyph under X. If we find one with a string object,
5250 it's the one we were looking for. */
5251 if (area
== RIGHT_MARGIN_AREA
)
5252 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5253 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5254 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5255 + window_box_width (w
, LEFT_MARGIN_AREA
)
5256 + window_box_width (w
, TEXT_AREA
));
5258 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5259 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5262 glyph
= row
->glyphs
[area
];
5263 end
= glyph
+ row
->used
[area
];
5264 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5265 x0
-= glyph
->pixel_width
;
5266 *x
= glyph
- row
->glyphs
[area
];
5269 string
= glyph
->object
;
5270 *charpos
= glyph
->charpos
;
5271 *width
= glyph
->pixel_width
;
5272 *height
= glyph
->ascent
+ glyph
->descent
;
5273 #ifdef HAVE_WINDOW_SYSTEM
5274 if (glyph
->type
== IMAGE_GLYPH
)
5277 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5279 *object
= img
->spec
;
5280 y0
-= row
->ascent
- glyph
->ascent
;
5281 x0
+= glyph
->slice
.img
.x
;
5282 y0
+= glyph
->slice
.img
.y
;
5288 /* Add extra (default width) columns if clicked after EOL. */
5289 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5291 *height
= row
->height
;
5298 *width
= *height
= 0;
5308 /***********************************************************************
5309 Changing Frame Sizes
5310 ***********************************************************************/
5314 static void deliver_window_change_signal (int);
5317 handle_window_change_signal (int sig
)
5320 struct tty_display_info
*tty
;
5322 /* The frame size change obviously applies to a single
5323 termcap-controlled terminal, but we can't decide which.
5324 Therefore, we resize the frames corresponding to each tty.
5326 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5328 if (! tty
->term_initted
)
5331 /* Suspended tty frames have tty->input == NULL avoid trying to
5336 get_tty_size (fileno (tty
->input
), &width
, &height
);
5338 if (width
> 5 && height
> 2) {
5339 Lisp_Object tail
, frame
;
5341 FOR_EACH_FRAME (tail
, frame
)
5342 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5343 /* Record the new sizes, but don't reallocate the data
5344 structures now. Let that be done later outside of the
5346 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5352 deliver_window_change_signal (int sig
)
5354 deliver_process_signal (sig
, handle_window_change_signal
);
5356 #endif /* SIGWINCH */
5359 /* Do any change in frame size that was requested by a signal.
5360 SAFE means this function is called from a place where it is
5361 safe to change frame sizes while a redisplay is in progress. */
5364 do_pending_window_change (bool safe
)
5366 /* If window change signal handler should have run before, run it now. */
5367 if (redisplaying_p
&& !safe
)
5370 while (delayed_size_change
)
5372 Lisp_Object tail
, frame
;
5374 delayed_size_change
= 0;
5376 FOR_EACH_FRAME (tail
, frame
)
5378 struct frame
*f
= XFRAME (frame
);
5380 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5381 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5388 /* Change the frame height and/or width. Values may be given as zero to
5389 indicate no change is to take place.
5391 If DELAY, assume we're being called from a signal handler, and
5392 queue the change for later - perhaps the next redisplay.
5393 Since this tries to resize windows, we can't call it
5394 from a signal handler.
5396 SAFE means this function is called from a place where it's
5397 safe to change frame sizes while a redisplay is in progress. */
5400 change_frame_size (struct frame
*f
, int newheight
, int newwidth
,
5401 bool pretend
, bool delay
, bool safe
)
5403 Lisp_Object tail
, frame
;
5405 if (FRAME_MSDOS_P (f
))
5407 /* On MS-DOS, all frames use the same screen, so a change in
5408 size affects all frames. Termcap now supports multiple
5410 FOR_EACH_FRAME (tail
, frame
)
5411 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5412 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5413 pretend
, delay
, safe
);
5416 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5420 change_frame_size_1 (struct frame
*f
, int newheight
, int newwidth
,
5421 bool pretend
, bool delay
, bool safe
)
5423 int new_frame_total_cols
;
5424 ptrdiff_t count
= SPECPDL_INDEX ();
5426 /* If we can't deal with the change now, queue it for later. */
5427 if (delay
|| (redisplaying_p
&& !safe
))
5429 f
->new_text_lines
= newheight
;
5430 f
->new_text_cols
= newwidth
;
5431 delayed_size_change
= 1;
5435 /* This size-change overrides any pending one for this frame. */
5436 f
->new_text_lines
= 0;
5437 f
->new_text_cols
= 0;
5439 /* If an argument is zero, set it to the current value. */
5441 newheight
= FRAME_LINES (f
);
5443 newwidth
= FRAME_COLS (f
);
5445 /* Compute width of windows in F. */
5446 /* Round up to the smallest acceptable size. */
5447 check_frame_size (f
, &newheight
, &newwidth
);
5449 /* This is the width of the frame with vertical scroll bars and fringe
5450 columns. Do this after rounding - see discussion of bug#9723. */
5451 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5453 /* If we're not changing the frame size, quit now. */
5454 /* Frame width may be unchanged but the text portion may change, for
5455 example, fullscreen and remove/add scroll bar. */
5456 if (newheight
== FRAME_LINES (f
)
5457 /* Text portion unchanged? */
5458 && newwidth
== FRAME_COLS (f
)
5459 /* Frame width unchanged? */
5460 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5466 /* We only can set screen dimensions to certain values supported
5467 by our video hardware. Try to find the smallest size greater
5468 or equal to the requested dimensions. */
5469 dos_set_window_size (&newheight
, &newwidth
);
5472 if (newheight
!= FRAME_LINES (f
))
5474 resize_frame_windows (f
, newheight
, 0);
5476 /* MSDOS frames cannot PRETEND, as they change frame size by
5477 manipulating video hardware. */
5478 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5479 FrameRows (FRAME_TTY (f
)) = newheight
;
5482 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5484 resize_frame_windows (f
, new_frame_total_cols
, 1);
5486 /* MSDOS frames cannot PRETEND, as they change frame size by
5487 manipulating video hardware. */
5488 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5489 FrameCols (FRAME_TTY (f
)) = newwidth
;
5491 if (WINDOWP (f
->tool_bar_window
))
5492 XWINDOW (f
->tool_bar_window
)->total_cols
= newwidth
;
5495 FRAME_LINES (f
) = newheight
;
5496 SET_FRAME_COLS (f
, newwidth
);
5499 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5500 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5502 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5504 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5505 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5506 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5507 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5510 adjust_frame_glyphs (f
);
5511 calculate_costs (f
);
5512 SET_FRAME_GARBAGED (f
);
5517 record_unwind_current_buffer ();
5519 run_window_configuration_change_hook (f
);
5521 unbind_to (count
, Qnil
);
5526 /***********************************************************************
5527 Terminal Related Lisp Functions
5528 ***********************************************************************/
5530 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5531 1, 1, "FOpen termscript file: ",
5532 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5533 FILE = nil means just close any termscript file currently open. */)
5536 struct tty_display_info
*tty
;
5538 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5539 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5540 error ("Current frame is not on a tty device");
5544 if (tty
->termscript
!= 0)
5547 fclose (tty
->termscript
);
5548 tty
->termscript
= 0;
5554 file
= Fexpand_file_name (file
, Qnil
);
5555 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5556 if (tty
->termscript
== 0)
5557 report_file_error ("Opening termscript", file
);
5563 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5564 Ssend_string_to_terminal
, 1, 2, 0,
5565 doc
: /* Send STRING to the terminal without alteration.
5566 Control characters in STRING will have terminal-dependent effects.
5568 Optional parameter TERMINAL specifies the tty terminal device to use.
5569 It may be a terminal object, a frame, or nil for the terminal used by
5570 the currently selected frame. In batch mode, STRING is sent to stdout
5571 when TERMINAL is nil. */)
5572 (Lisp_Object string
, Lisp_Object terminal
)
5574 struct terminal
*t
= get_terminal (terminal
, 1);
5577 /* ??? Perhaps we should do something special for multibyte strings here. */
5578 CHECK_STRING (string
);
5582 error ("Unknown terminal device");
5584 if (t
->type
== output_initial
)
5586 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5587 error ("Device %d is not a termcap terminal device", t
->id
);
5590 struct tty_display_info
*tty
= t
->display_info
.tty
;
5593 error ("Terminal is currently suspended");
5595 if (tty
->termscript
)
5597 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5598 fflush (tty
->termscript
);
5602 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5609 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5610 doc
: /* Beep, or flash the screen.
5611 Also, unless an argument is given,
5612 terminate any keyboard macro currently executing. */)
5620 ring_bell (XFRAME (selected_frame
));
5629 bitch_at_user (void)
5633 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5636 = "Keyboard macro terminated by a command ringing the bell";
5637 Fsignal (Quser_error
, list1 (build_string (msg
)));
5640 ring_bell (XFRAME (selected_frame
));
5645 /***********************************************************************
5647 ***********************************************************************/
5649 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5650 doc
: /* Pause, without updating display, for SECONDS seconds.
5651 SECONDS may be a floating-point value, meaning that you can wait for a
5652 fraction of a second. Optional second arg MILLISECONDS specifies an
5653 additional wait period, in milliseconds; this is for backwards compatibility.
5654 \(Not all operating systems support waiting for a fraction of a second.) */)
5655 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5657 double duration
= extract_float (seconds
);
5659 if (!NILP (milliseconds
))
5661 CHECK_NUMBER (milliseconds
);
5662 duration
+= XINT (milliseconds
) / 1000.0;
5667 struct timespec t
= dtotimespec (duration
);
5668 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5669 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5676 /* This is just like wait_reading_process_output, except that
5679 TIMEOUT is number of seconds to wait (float or integer),
5680 or t to wait forever.
5681 READING is true if reading input.
5682 If DISPLAY_OPTION is >0 display process output while waiting.
5683 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5687 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5691 bool do_display
= display_option
> 0;
5693 swallow_events (do_display
);
5695 if ((detect_input_pending_run_timers (do_display
))
5696 || !NILP (Vexecuting_kbd_macro
))
5699 if (display_option
> 1)
5700 redisplay_preserve_echo_area (2);
5702 if (INTEGERP (timeout
))
5704 sec
= XINT (timeout
);
5709 else if (FLOATP (timeout
))
5711 double seconds
= XFLOAT_DATA (timeout
);
5712 if (! (0 < seconds
))
5716 struct timespec t
= dtotimespec (seconds
);
5717 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5721 else if (EQ (timeout
, Qt
))
5727 wrong_type_argument (Qnumberp
, timeout
);
5734 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5737 return detect_input_pending () ? Qnil
: Qt
;
5741 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5742 doc
: /* Perform redisplay.
5743 Optional arg FORCE, if non-nil, prevents redisplay from being
5744 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5745 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5746 preempted by arriving input, so FORCE does nothing.
5748 Return t if redisplay was performed, nil if redisplay was preempted
5749 immediately by pending input. */)
5755 if ((detect_input_pending_run_timers (1)
5756 && NILP (force
) && !redisplay_dont_pause
)
5757 || !NILP (Vexecuting_kbd_macro
))
5760 count
= SPECPDL_INDEX ();
5761 if (!NILP (force
) && !redisplay_dont_pause
)
5762 specbind (Qredisplay_dont_pause
, Qt
);
5763 redisplay_preserve_echo_area (2);
5764 unbind_to (count
, Qnil
);
5770 /***********************************************************************
5771 Other Lisp Functions
5772 ***********************************************************************/
5774 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5775 session's frames, frame names, buffers, buffer-read-only flags, and
5776 buffer-modified-flags. */
5778 static Lisp_Object frame_and_buffer_state
;
5781 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5782 Sframe_or_buffer_changed_p
, 0, 1, 0,
5783 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5784 VARIABLE is a variable name whose value is either nil or a state vector
5785 that will be updated to contain all frames and buffers,
5786 aside from buffers whose names start with space,
5787 along with the buffers' read-only and modified flags. This allows a fast
5788 check to see whether buffer menus might need to be recomputed.
5789 If this function returns non-nil, it updates the internal vector to reflect
5792 If VARIABLE is nil, an internal variable is used. Users should not
5793 pass nil for VARIABLE. */)
5794 (Lisp_Object variable
)
5796 Lisp_Object state
, tail
, frame
, buf
;
5799 if (! NILP (variable
))
5801 CHECK_SYMBOL (variable
);
5802 state
= Fsymbol_value (variable
);
5803 if (! VECTORP (state
))
5807 state
= frame_and_buffer_state
;
5810 FOR_EACH_FRAME (tail
, frame
)
5812 if (idx
== ASIZE (state
))
5814 if (!EQ (AREF (state
, idx
++), frame
))
5816 if (idx
== ASIZE (state
))
5818 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5821 /* Check that the buffer info matches. */
5822 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5824 /* Ignore buffers that aren't included in buffer lists. */
5825 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5827 if (idx
== ASIZE (state
))
5829 if (!EQ (AREF (state
, idx
++), buf
))
5831 if (idx
== ASIZE (state
))
5833 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5835 if (idx
== ASIZE (state
))
5837 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5840 if (idx
== ASIZE (state
))
5842 /* Detect deletion of a buffer at the end of the list. */
5843 if (EQ (AREF (state
, idx
), Qlambda
))
5846 /* Come here if we decide the data has changed. */
5848 /* Count the size we will need.
5849 Start with 1 so there is room for at least one lambda at the end. */
5851 FOR_EACH_FRAME (tail
, frame
)
5853 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5855 /* Reallocate the vector if data has grown to need it,
5856 or if it has shrunk a lot. */
5857 if (! VECTORP (state
)
5858 || n
> ASIZE (state
)
5859 || n
+ 20 < ASIZE (state
) / 2)
5860 /* Add 20 extra so we grow it less often. */
5862 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5863 if (! NILP (variable
))
5864 Fset (variable
, state
);
5866 frame_and_buffer_state
= state
;
5869 /* Record the new data in the (possibly reallocated) vector. */
5871 FOR_EACH_FRAME (tail
, frame
)
5873 ASET (state
, idx
, frame
);
5875 ASET (state
, idx
, XFRAME (frame
)->name
);
5878 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5880 /* Ignore buffers that aren't included in buffer lists. */
5881 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5883 ASET (state
, idx
, buf
);
5885 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5887 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5890 /* Fill up the vector with lambdas (always at least one). */
5891 ASET (state
, idx
, Qlambda
);
5893 while (idx
< ASIZE (state
))
5895 ASET (state
, idx
, Qlambda
);
5898 /* Make sure we didn't overflow the vector. */
5899 eassert (idx
<= ASIZE (state
));
5905 /***********************************************************************
5907 ***********************************************************************/
5909 /* Initialization done when Emacs fork is started, before doing stty.
5910 Determine terminal type and set terminal_driver. Then invoke its
5911 decoding routine to set up variables in the terminal package. */
5916 char *terminal_type
;
5918 /* Construct the space glyph. */
5919 space_glyph
.type
= CHAR_GLYPH
;
5920 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5921 space_glyph
.charpos
= -1;
5924 cursor_in_echo_area
= 0;
5926 /* Now is the time to initialize this; it's used by init_sys_modes
5928 Vinitial_window_system
= Qnil
;
5930 /* SIGWINCH needs to be handled no matter what display we start
5931 with. Otherwise newly opened tty frames will not resize
5936 #endif /* CANNOT_DUMP */
5938 struct sigaction action
;
5939 emacs_sigaction_init (&action
, deliver_window_change_signal
);
5940 sigaction (SIGWINCH
, &action
, 0);
5942 #endif /* SIGWINCH */
5944 /* If running as a daemon, no need to initialize any frames/terminal. */
5948 /* If the user wants to use a window system, we shouldn't bother
5949 initializing the terminal. This is especially important when the
5950 terminal is so dumb that emacs gives up before and doesn't bother
5951 using the window system.
5953 If the DISPLAY environment variable is set and nonempty,
5954 try to use X, and die with an error message if that doesn't work. */
5956 #ifdef HAVE_X_WINDOWS
5957 if (! inhibit_window_system
&& ! display_arg
)
5960 display
= getenv ("DISPLAY");
5961 display_arg
= (display
!= 0 && *display
!= 0);
5963 if (display_arg
&& !x_display_ok (display
))
5965 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
5967 inhibit_window_system
= 1;
5971 if (!inhibit_window_system
&& display_arg
)
5973 Vinitial_window_system
= Qx
;
5975 Vwindow_system_version
= make_number (11);
5978 /* In some versions of ncurses,
5979 tputs crashes if we have not called tgetent.
5981 { char b
[2044]; tgetent (b
, "xterm");}
5985 #endif /* HAVE_X_WINDOWS */
5988 if (!inhibit_window_system
)
5990 Vinitial_window_system
= Qw32
;
5991 Vwindow_system_version
= make_number (1);
5994 #endif /* HAVE_NTGUI */
5997 if (!inhibit_window_system
6003 Vinitial_window_system
= Qns
;
6004 Vwindow_system_version
= make_number (10);
6009 /* If no window system has been specified, try to use the terminal. */
6011 fatal ("standard input is not a tty");
6014 terminal_type
= "w32console";
6016 terminal_type
= getenv ("TERM");
6020 #ifdef HAVE_WINDOW_SYSTEM
6021 if (! inhibit_window_system
)
6022 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6024 #endif /* HAVE_WINDOW_SYSTEM */
6025 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6031 struct frame
*f
= XFRAME (selected_frame
);
6033 init_foreground_group ();
6035 /* Open a display on the controlling tty. */
6036 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6038 /* Convert the initial frame to use the new display. */
6039 if (f
->output_method
!= output_initial
)
6041 f
->output_method
= t
->type
;
6044 t
->reference_count
++;
6046 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6048 if (f
->output_method
== output_termcap
)
6049 create_tty_output (f
);
6051 t
->display_info
.tty
->top_frame
= selected_frame
;
6052 change_frame_size (XFRAME (selected_frame
),
6053 FrameRows (t
->display_info
.tty
),
6054 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6056 /* Delete the initial terminal. */
6057 if (--initial_terminal
->reference_count
== 0
6058 && initial_terminal
->delete_terminal_hook
)
6059 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6061 /* Update frame parameters to reflect the new type. */
6062 Fmodify_frame_parameters
6063 (selected_frame
, list1 (Fcons (Qtty_type
,
6064 Ftty_type (selected_frame
))));
6065 if (t
->display_info
.tty
->name
)
6066 Fmodify_frame_parameters
6068 list1 (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
))));
6070 Fmodify_frame_parameters (selected_frame
, list1 (Fcons (Qtty
, Qnil
)));
6074 struct frame
*sf
= SELECTED_FRAME ();
6075 int width
= FRAME_TOTAL_COLS (sf
);
6076 int height
= FRAME_LINES (sf
);
6078 /* If these sizes are so big they cause overflow, just ignore the
6079 change. It's not clear what better we could do. The rest of
6080 the code assumes that (width + 2) * height * sizeof (struct glyph)
6081 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6082 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6083 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6084 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6085 < (width
+ 2) * height
))
6086 fatal ("screen size %dx%d too big", width
, height
);
6089 calculate_costs (XFRAME (selected_frame
));
6091 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6094 && NILP (Vinitial_window_system
))
6096 /* For the initial frame, we don't have any way of knowing what
6097 are the foreground and background colors of the terminal. */
6098 struct frame
*sf
= SELECTED_FRAME ();
6100 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6101 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6102 call0 (intern ("tty-set-up-initial-frame-faces"));
6108 /***********************************************************************
6110 ***********************************************************************/
6112 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6113 Sinternal_show_cursor
, 2, 2, 0,
6114 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6115 WINDOW nil means use the selected window. SHOW non-nil means
6116 show a cursor in WINDOW in the next redisplay. SHOW nil means
6117 don't show a cursor. */)
6118 (Lisp_Object window
, Lisp_Object show
)
6120 /* Don't change cursor state while redisplaying. This could confuse
6122 if (!redisplaying_p
)
6123 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6128 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6129 Sinternal_show_cursor_p
, 0, 1, 0,
6130 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6131 WINDOW nil or omitted means report on the selected window. */)
6132 (Lisp_Object window
)
6134 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6137 /***********************************************************************
6139 ***********************************************************************/
6142 syms_of_display (void)
6144 defsubr (&Sredraw_frame
);
6145 defsubr (&Sredraw_display
);
6146 defsubr (&Sframe_or_buffer_changed_p
);
6147 defsubr (&Sopen_termscript
);
6149 defsubr (&Sredisplay
);
6150 defsubr (&Ssleep_for
);
6151 defsubr (&Ssend_string_to_terminal
);
6152 defsubr (&Sinternal_show_cursor
);
6153 defsubr (&Sinternal_show_cursor_p
);
6156 defsubr (&Sdump_redisplay_history
);
6159 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6160 staticpro (&frame_and_buffer_state
);
6162 DEFSYM (Qdisplay_table
, "display-table");
6163 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6165 DEFVAR_INT ("baud-rate", baud_rate
,
6166 doc
: /* The output baud rate of the terminal.
6167 On most systems, changing this value will affect the amount of padding
6168 and the other strategic decisions made during redisplay. */);
6170 DEFVAR_BOOL ("inverse-video", inverse_video
,
6171 doc
: /* Non-nil means invert the entire frame display.
6172 This means everything is in inverse video which otherwise would not be. */);
6174 DEFVAR_BOOL ("visible-bell", visible_bell
,
6175 doc
: /* Non-nil means try to flash the frame to represent a bell.
6177 See also `ring-bell-function'. */);
6179 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6180 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6181 A non-nil value is useful if the terminal can automatically preserve
6182 Emacs's frame display when you reenter Emacs.
6183 It is up to you to set this variable if your terminal can do that. */);
6185 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6186 doc
: /* Name of the window system that Emacs uses for the first frame.
6187 The value is a symbol:
6188 nil for a termcap frame (a character-only terminal),
6189 'x' for an Emacs frame that is really an X window,
6190 'w32' for an Emacs frame that is a window on MS-Windows display,
6191 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6192 'pc' for a direct-write MS-DOS frame.
6194 Use of this variable as a boolean is deprecated. Instead,
6195 use `display-graphic-p' or any of the other `display-*-p'
6196 predicates which report frame's specific UI-related capabilities. */);
6198 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6199 doc
: /* Name of window system through which the selected frame is displayed.
6200 The value is a symbol:
6201 nil for a termcap frame (a character-only terminal),
6202 'x' for an Emacs frame that is really an X window,
6203 'w32' for an Emacs frame that is a window on MS-Windows display,
6204 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6205 'pc' for a direct-write MS-DOS frame.
6207 Use of this variable as a boolean is deprecated. Instead,
6208 use `display-graphic-p' or any of the other `display-*-p'
6209 predicates which report frame's specific UI-related capabilities. */);
6211 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6212 doc
: /* The version number of the window system in use.
6213 For X windows, this is 11. */);
6215 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6216 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6218 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6219 doc
: /* Table defining how to output a glyph code to the frame.
6220 If not nil, this is a vector indexed by glyph code to define the glyph.
6221 Each element can be:
6222 integer: a glyph code which this glyph is an alias for.
6223 string: output this glyph using that string (not impl. in X windows).
6224 nil: this glyph mod 524288 is the code of a character to output,
6225 and this glyph / 524288 is the face number (see `face-id') to use
6226 while outputting it. */);
6227 Vglyph_table
= Qnil
;
6229 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6230 doc
: /* Display table to use for buffers that specify none.
6231 See `buffer-display-table' for more information. */);
6232 Vstandard_display_table
= Qnil
;
6234 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6235 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6236 redisplay_dont_pause
= 1;
6242 Vinitial_window_system
= Qnil
;
6243 Vwindow_system_version
= Qnil
;