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/>. */
28 /* cm.h must come after dispextern.h on Windows. */
29 #include "dispextern.h"
31 #include "character.h"
35 #include "termhooks.h"
40 #include "intervals.h"
41 #include "blockinput.h"
44 #include "syssignal.h"
46 #ifdef HAVE_WINDOW_SYSTEM
48 #endif /* HAVE_WINDOW_SYSTEM */
55 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
56 #include <term.h> /* for tgetent */
63 /* Structure to pass dimensions around. Used for character bounding
64 boxes, glyph matrix dimensions and alike. */
73 /* Function prototypes. */
75 static void update_frame_line (struct frame
*, int);
76 static int required_matrix_height (struct window
*);
77 static int required_matrix_width (struct window
*);
78 static void change_frame_size_1 (struct frame
*, int, int, bool, bool, bool);
79 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
80 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
81 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
83 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
85 static void adjust_decode_mode_spec_buffer (struct frame
*);
86 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
87 static void clear_window_matrices (struct window
*, bool);
88 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
89 static int scrolling_window (struct window
*, bool);
90 static bool update_window_line (struct window
*, int, bool *);
91 static void mirror_make_current (struct window
*, int);
93 static void check_matrix_pointers (struct glyph_matrix
*,
94 struct glyph_matrix
*);
96 static void mirror_line_dance (struct window
*, int, int, int *, char *);
97 static bool update_window_tree (struct window
*, bool);
98 static bool update_window (struct window
*, bool);
99 static bool update_frame_1 (struct frame
*, bool, bool);
100 static bool scrolling (struct frame
*);
101 static void set_window_cursor_after_update (struct window
*);
102 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
103 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
105 /* True means last display completed. False means it was preempted. */
107 bool display_completed
;
109 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
111 /* True means SIGWINCH happened when not safe. */
113 static bool delayed_size_change
;
115 /* A glyph for a space. */
117 struct glyph space_glyph
;
119 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
121 /* Counts of allocated structures. These counts serve to diagnose
122 memory leaks and double frees. */
124 static int glyph_matrix_count
;
125 static int glyph_pool_count
;
127 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
129 /* If non-null, the frame whose frame matrices are manipulated. If
130 null, window matrices are worked on. */
132 static struct frame
*frame_matrix_frame
;
134 /* Convert vpos and hpos from frame to window and vice versa.
135 This may only be used for terminal frames. */
139 static int window_to_frame_vpos (struct window
*, int);
140 static int window_to_frame_hpos (struct window
*, int);
141 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
142 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
144 /* One element of the ring buffer containing redisplay history
147 struct redisplay_history
149 char trace
[512 + 100];
152 /* The size of the history buffer. */
154 #define REDISPLAY_HISTORY_SIZE 30
156 /* The redisplay history buffer. */
158 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
160 /* Next free entry in redisplay_history. */
162 static int history_idx
;
164 /* A tick that's incremented each time something is added to the
167 static uprintmax_t history_tick
;
169 /* Add to the redisplay history how window W has been displayed.
170 MSG is a trace containing the information how W's glyph matrix
171 has been constructed. PAUSED_P means that the update
172 has been interrupted for pending input. */
175 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
180 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
182 buf
= redisplay_history
[history_idx
].trace
;
185 snprintf (buf
, sizeof redisplay_history
[0].trace
,
186 "%"pMu
": window %p (`%s')%s\n%s",
189 ((BUFFERP (w
->contents
)
190 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
191 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
193 paused_p
? " ***paused***" : "",
198 /* Add to the redisplay history that frame F has been displayed.
199 PAUSED_P means that the update has been interrupted for
203 add_frame_display_history (struct frame
*f
, bool paused_p
)
208 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
210 buf
= redisplay_history
[history_idx
].trace
;
213 sprintf (buf
, "%"pMu
": update frame %p%s",
215 ptr
, paused_p
? " ***paused***" : "");
219 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
220 Sdump_redisplay_history
, 0, 0, "",
221 doc
: /* Dump redisplay history to stderr. */)
226 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
229 i
= REDISPLAY_HISTORY_SIZE
- 1;
230 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
237 #else /* not GLYPH_DEBUG */
239 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
240 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
242 #endif /* GLYPH_DEBUG */
245 #if (defined PROFILING \
246 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
247 && !HAVE___EXECUTABLE_START)
248 /* This function comes first in the Emacs executable and is used only
249 to estimate the text start for profiling. */
251 __executable_start (void)
257 /***********************************************************************
259 ***********************************************************************/
261 /* Allocate and return a glyph_matrix structure. POOL is the glyph
262 pool from which memory for the matrix should be allocated, or null
263 for window-based redisplay where no glyph pools are used. The
264 member `pool' of the glyph matrix structure returned is set to
265 POOL, the structure is otherwise zeroed. */
267 static struct glyph_matrix
*
268 new_glyph_matrix (struct glyph_pool
*pool
)
270 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
272 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
273 /* Increment number of allocated matrices. This count is used
274 to detect memory leaks. */
275 ++glyph_matrix_count
;
278 /* Set pool and return. */
284 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
286 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
287 glyph_matrix_count is decremented when a matrix is freed. If the count
288 gets negative, more structures were freed than allocated, i.e. one matrix
289 was freed more than once or a bogus pointer was passed to this function.
291 If MATRIX->pool is null, this means that the matrix manages its own
292 glyph memory---this is done for matrices on X frames. Freeing the
293 matrix also frees the glyph memory in this case. */
296 free_glyph_matrix (struct glyph_matrix
*matrix
)
302 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
303 /* Detect the case that more matrices are freed than were
305 --glyph_matrix_count
;
306 eassert (glyph_matrix_count
>= 0);
309 /* Free glyph memory if MATRIX owns it. */
310 if (matrix
->pool
== NULL
)
311 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
312 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
314 /* Free row structures and the matrix itself. */
315 xfree (matrix
->rows
);
321 /* Return the number of glyphs to reserve for a marginal area of
322 window W. TOTAL_GLYPHS is the number of glyphs in a complete
323 display line of window W. MARGIN gives the width of the marginal
324 area in canonical character units. */
327 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
331 int width
= w
->total_cols
;
332 double d
= max (0, margin
);
333 d
= min (width
/ 2 - 1, d
);
334 return (int) ((double) total_glyphs
/ width
* d
);
339 /* Return true if ROW's hash value is correct.
340 Optimized away if ENABLE_CHECKING is not defined. */
343 verify_row_hash (struct glyph_row
*row
)
345 return row
->hash
== row_hash (row
);
348 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
351 W is null if the function is called for a frame glyph matrix.
352 Otherwise it is the window MATRIX is a member of. X and Y are the
353 indices of the first column and row of MATRIX within the frame
354 matrix, if such a matrix exists. They are zero for purely
355 window-based redisplay. DIM is the needed size of the matrix.
357 In window-based redisplay, where no frame matrices exist, glyph
358 matrices manage their own glyph storage. Otherwise, they allocate
359 storage from a common frame glyph pool which can be found in
362 The reason for this memory management strategy is to avoid complete
363 frame redraws if possible. When we allocate from a common pool, a
364 change of the location or size of a sub-matrix within the pool
365 requires a complete redisplay of the frame because we cannot easily
366 make sure that the current matrices of all windows still agree with
367 what is displayed on the screen. While this is usually fast, it
368 leads to screen flickering. */
371 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
375 bool marginal_areas_changed_p
= 0;
376 bool header_line_changed_p
= 0;
377 bool header_line_p
= 0;
378 int left
= -1, right
= -1;
379 int window_width
= -1, window_height
= -1;
381 /* See if W had a header line that has disappeared now, or vice versa.
385 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
387 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
388 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
390 matrix
->header_line_p
= header_line_p
;
392 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
393 Do nothing if MATRIX' size, position, vscroll, and marginal areas
394 haven't changed. This optimization is important because preserving
395 the matrix means preventing redisplay. */
396 if (matrix
->pool
== NULL
)
398 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
399 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
400 eassert (left
>= 0 && right
>= 0);
401 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
402 || right
!= matrix
->right_margin_glyphs
);
404 if (!marginal_areas_changed_p
405 && !XFRAME (w
->frame
)->fonts_changed
406 && !header_line_changed_p
407 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
408 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
409 && matrix
->window_height
== window_height
410 && matrix
->window_vscroll
== w
->vscroll
411 && matrix
->window_width
== window_width
)
415 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
416 if (matrix
->rows_allocated
< dim
.height
)
418 int old_alloc
= matrix
->rows_allocated
;
419 new_rows
= dim
.height
- matrix
->rows_allocated
;
420 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
421 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
422 memset (matrix
->rows
+ old_alloc
, 0,
423 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
428 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
429 on a frame not using window-based redisplay. Set up pointers for
430 each row into the glyph pool. */
433 eassert (matrix
->pool
->glyphs
);
437 left
= margin_glyphs_to_reserve (w
, dim
.width
,
438 w
->left_margin_cols
);
439 right
= margin_glyphs_to_reserve (w
, dim
.width
,
440 w
->right_margin_cols
);
445 for (i
= 0; i
< dim
.height
; ++i
)
447 struct glyph_row
*row
= &matrix
->rows
[i
];
449 row
->glyphs
[LEFT_MARGIN_AREA
]
450 = (matrix
->pool
->glyphs
451 + (y
+ i
) * matrix
->pool
->ncolumns
455 || row
== matrix
->rows
+ dim
.height
- 1
456 || (row
== matrix
->rows
&& matrix
->header_line_p
))
458 row
->glyphs
[TEXT_AREA
]
459 = row
->glyphs
[LEFT_MARGIN_AREA
];
460 row
->glyphs
[RIGHT_MARGIN_AREA
]
461 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
462 row
->glyphs
[LAST_AREA
]
463 = row
->glyphs
[RIGHT_MARGIN_AREA
];
467 row
->glyphs
[TEXT_AREA
]
468 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
469 row
->glyphs
[RIGHT_MARGIN_AREA
]
470 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
471 row
->glyphs
[LAST_AREA
]
472 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
476 matrix
->left_margin_glyphs
= left
;
477 matrix
->right_margin_glyphs
= right
;
481 /* If MATRIX->pool is null, MATRIX is responsible for managing
482 its own memory. It is a window matrix for window-based redisplay.
483 Allocate glyph memory from the heap. */
484 if (dim
.width
> matrix
->matrix_w
486 || header_line_changed_p
487 || marginal_areas_changed_p
)
489 struct glyph_row
*row
= matrix
->rows
;
490 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
494 row
->glyphs
[LEFT_MARGIN_AREA
]
495 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
496 dim
.width
, sizeof (struct glyph
));
498 /* The mode line never has marginal areas. */
499 if (row
== matrix
->rows
+ dim
.height
- 1
500 || (row
== matrix
->rows
&& matrix
->header_line_p
))
502 row
->glyphs
[TEXT_AREA
]
503 = row
->glyphs
[LEFT_MARGIN_AREA
];
504 row
->glyphs
[RIGHT_MARGIN_AREA
]
505 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
506 row
->glyphs
[LAST_AREA
]
507 = row
->glyphs
[RIGHT_MARGIN_AREA
];
511 row
->glyphs
[TEXT_AREA
]
512 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
513 row
->glyphs
[RIGHT_MARGIN_AREA
]
514 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
515 row
->glyphs
[LAST_AREA
]
516 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
522 eassert (left
>= 0 && right
>= 0);
523 matrix
->left_margin_glyphs
= left
;
524 matrix
->right_margin_glyphs
= right
;
527 /* Number of rows to be used by MATRIX. */
528 matrix
->nrows
= dim
.height
;
529 eassert (matrix
->nrows
>= 0);
533 if (matrix
== w
->current_matrix
)
535 /* Mark rows in a current matrix of a window as not having
536 valid contents. It's important to not do this for
537 desired matrices. When Emacs starts, it may already be
538 building desired matrices when this function runs. */
539 if (window_width
< 0)
540 window_width
= window_box_width (w
, -1);
542 /* Optimize the case that only the height has changed (C-x 2,
543 upper window). Invalidate all rows that are no longer part
545 if (!marginal_areas_changed_p
546 && !header_line_changed_p
548 && dim
.width
== matrix
->matrix_w
549 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
550 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
551 && matrix
->window_width
== window_width
)
553 /* Find the last row in the window. */
554 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
555 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
561 /* Window end is invalid, if inside of the rows that
562 are invalidated below. */
563 if (w
->window_end_vpos
>= i
)
564 w
->window_end_valid
= 0;
566 while (i
< matrix
->nrows
)
567 matrix
->rows
[i
++].enabled_p
= 0;
571 for (i
= 0; i
< matrix
->nrows
; ++i
)
572 matrix
->rows
[i
].enabled_p
= 0;
575 else if (matrix
== w
->desired_matrix
)
577 /* Rows in desired matrices always have to be cleared;
578 redisplay expects this is the case when it runs, so it
579 had better be the case when we adjust matrices between
581 for (i
= 0; i
< matrix
->nrows
; ++i
)
582 matrix
->rows
[i
].enabled_p
= 0;
587 /* Remember last values to be able to optimize frame redraws. */
588 matrix
->matrix_x
= x
;
589 matrix
->matrix_y
= y
;
590 matrix
->matrix_w
= dim
.width
;
591 matrix
->matrix_h
= dim
.height
;
593 /* Record the top y location and height of W at the time the matrix
594 was last adjusted. This is used to optimize redisplay above. */
597 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
598 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
599 matrix
->window_height
= window_height
;
600 matrix
->window_width
= window_width
;
601 matrix
->window_vscroll
= w
->vscroll
;
606 /* Reverse the contents of rows in MATRIX between START and END. The
607 contents of the row at END - 1 end up at START, END - 2 at START +
608 1 etc. This is part of the implementation of rotate_matrix (see
612 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
616 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
618 /* Non-ISO HP/UX compiler doesn't like auto struct
620 struct glyph_row temp
;
621 temp
= matrix
->rows
[i
];
622 matrix
->rows
[i
] = matrix
->rows
[j
];
623 matrix
->rows
[j
] = temp
;
628 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
629 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
630 indices. (Note: this does not copy glyphs, only glyph pointers in
631 row structures are moved around).
633 The algorithm used for rotating the vector was, I believe, first
634 described by Kernighan. See the vector R as consisting of two
635 sub-vectors AB, where A has length BY for BY >= 0. The result
636 after rotating is then BA. Reverse both sub-vectors to get ArBr
637 and reverse the result to get (ArBr)r which is BA. Similar for
641 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
645 /* Up (rotate left, i.e. towards lower indices). */
647 reverse_rows (matrix
, first
, first
+ by
);
648 reverse_rows (matrix
, first
+ by
, last
);
649 reverse_rows (matrix
, first
, last
);
653 /* Down (rotate right, i.e. towards higher indices). */
654 reverse_rows (matrix
, last
- by
, last
);
655 reverse_rows (matrix
, first
, last
- by
);
656 reverse_rows (matrix
, first
, last
);
661 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
662 with indices START <= index < END. Increment positions by DELTA/
666 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
667 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
669 /* Check that START and END are reasonable values. */
670 eassert (start
>= 0 && start
<= matrix
->nrows
);
671 eassert (end
>= 0 && end
<= matrix
->nrows
);
672 eassert (start
<= end
);
674 for (; start
< end
; ++start
)
675 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
679 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
680 START and END are the row indices of the first and last + 1 row to clear. */
683 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
685 eassert (start
<= end
);
686 eassert (start
>= 0 && start
< matrix
->nrows
);
687 eassert (end
>= 0 && end
<= matrix
->nrows
);
689 for (; start
< end
; ++start
)
690 matrix
->rows
[start
].enabled_p
= 0;
696 Empty all rows in MATRIX by clearing their enabled_p flags.
697 The function prepare_desired_row will eventually really clear a row
698 when it sees one with a false enabled_p flag.
700 Reset update hints to default values. The only update hint
701 currently present is the flag MATRIX->no_scrolling_p. */
704 clear_glyph_matrix (struct glyph_matrix
*matrix
)
708 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
709 matrix
->no_scrolling_p
= 0;
714 /* Shift part of the glyph matrix MATRIX of window W up or down.
715 Increment y-positions in glyph rows between START and END by DY,
716 and recompute their visible height. */
719 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
723 eassert (start
<= end
);
724 eassert (start
>= 0 && start
< matrix
->nrows
);
725 eassert (end
>= 0 && end
<= matrix
->nrows
);
727 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
728 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
730 for (; start
< end
; ++start
)
732 struct glyph_row
*row
= &matrix
->rows
[start
];
735 row
->visible_height
= row
->height
;
738 row
->visible_height
-= min_y
- row
->y
;
739 if (row
->y
+ row
->height
> max_y
)
740 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
741 if (row
->fringe_bitmap_periodic_p
)
742 row
->redraw_fringe_bitmaps_p
= 1;
747 /* Mark all rows in current matrices of frame F as invalid. Marking
748 invalid is done by setting enabled_p to zero for all rows in a
752 clear_current_matrices (register struct frame
*f
)
754 /* Clear frame current matrix, if we have one. */
755 if (f
->current_matrix
)
756 clear_glyph_matrix (f
->current_matrix
);
758 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
759 /* Clear the matrix of the menu bar window, if such a window exists.
760 The menu bar window is currently used to display menus on X when
761 no toolkit support is compiled in. */
762 if (WINDOWP (f
->menu_bar_window
))
763 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
766 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
767 /* Clear the matrix of the tool-bar window, if any. */
768 if (WINDOWP (f
->tool_bar_window
))
769 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
772 /* Clear current window matrices. */
773 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
774 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
778 /* Clear out all display lines of F for a coming redisplay. */
781 clear_desired_matrices (register struct frame
*f
)
783 if (f
->desired_matrix
)
784 clear_glyph_matrix (f
->desired_matrix
);
786 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
787 if (WINDOWP (f
->menu_bar_window
))
788 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
791 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
792 if (WINDOWP (f
->tool_bar_window
))
793 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
796 /* Do it for window matrices. */
797 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
798 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
802 /* Clear matrices in window tree rooted in W. If DESIRED_P,
803 clear desired matrices, otherwise clear current matrices. */
806 clear_window_matrices (struct window
*w
, bool desired_p
)
810 if (WINDOWP (w
->contents
))
811 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
815 clear_glyph_matrix (w
->desired_matrix
);
818 clear_glyph_matrix (w
->current_matrix
);
819 w
->window_end_valid
= 0;
823 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
829 /***********************************************************************
832 See dispextern.h for an overall explanation of glyph rows.
833 ***********************************************************************/
835 /* Clear glyph row ROW. NOTE: this code relies on the current
836 layout of `glyphs' and `used' fields of `struct glyph_row'. */
839 clear_glyph_row (struct glyph_row
*row
)
841 enum { off
= offsetof (struct glyph_row
, used
) };
843 /* Zero everything except pointers in `glyphs'. */
844 memset (row
->used
, 0, sizeof *row
- off
);
848 /* Make ROW an empty, enabled row of canonical character height,
849 in window W starting at y-position Y. */
852 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
856 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
857 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
859 clear_glyph_row (row
);
861 row
->ascent
= row
->phys_ascent
= 0;
862 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
863 row
->visible_height
= row
->height
;
866 row
->visible_height
-= min_y
- row
->y
;
867 if (row
->y
+ row
->height
> max_y
)
868 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
874 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
875 are the amounts by which to change positions. Note that the first
876 glyph of the text area of a row can have a buffer position even if
877 the used count of the text area is zero. Such rows display line
881 increment_row_positions (struct glyph_row
*row
,
882 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
886 /* Increment start and end positions. */
887 MATRIX_ROW_START_CHARPOS (row
) += delta
;
888 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
889 MATRIX_ROW_END_CHARPOS (row
) += delta
;
890 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
891 CHARPOS (row
->start
.pos
) += delta
;
892 BYTEPOS (row
->start
.pos
) += delta_bytes
;
893 CHARPOS (row
->end
.pos
) += delta
;
894 BYTEPOS (row
->end
.pos
) += delta_bytes
;
899 /* Increment positions in glyphs. */
900 for (area
= 0; area
< LAST_AREA
; ++area
)
901 for (i
= 0; i
< row
->used
[area
]; ++i
)
902 if (BUFFERP (row
->glyphs
[area
][i
].object
)
903 && row
->glyphs
[area
][i
].charpos
> 0)
904 row
->glyphs
[area
][i
].charpos
+= delta
;
906 /* Capture the case of rows displaying a line end. */
907 if (row
->used
[TEXT_AREA
] == 0
908 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
909 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
914 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
915 contents, i.e. glyph structure contents are exchanged between A and
916 B without changing glyph pointers in A and B. */
919 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
923 for (area
= 0; area
< LAST_AREA
; ++area
)
925 /* Number of glyphs to swap. */
926 int max_used
= max (a
->used
[area
], b
->used
[area
]);
928 /* Start of glyphs in area of row A. */
929 struct glyph
*glyph_a
= a
->glyphs
[area
];
931 /* End + 1 of glyphs in area of row A. */
932 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
934 /* Start of glyphs in area of row B. */
935 struct glyph
*glyph_b
= b
->glyphs
[area
];
937 while (glyph_a
< glyph_a_end
)
939 /* Non-ISO HP/UX compiler doesn't like auto struct
953 /* Exchange pointers to glyph memory between glyph rows A and B. Also
954 exchange the used[] array and the hash values of the rows, because
955 these should all go together for the row's hash value to be
959 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
962 unsigned hash_tem
= a
->hash
;
964 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
966 struct glyph
*temp
= a
->glyphs
[i
];
968 a
->glyphs
[i
] = b
->glyphs
[i
];
972 short used_tem
= a
->used
[i
];
974 a
->used
[i
] = b
->used
[i
];
975 b
->used
[i
] = used_tem
;
983 /* Copy glyph row structure FROM to glyph row structure TO, except that
984 glyph pointers, the `used' counts, and the hash values in the structures
985 are left unchanged. NOTE: this code relies on the current layout of
986 `glyphs', `used', `hash' and `x' fields of `struct glyph_row'. */
989 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
991 enum { off
= offsetof (struct glyph_row
, x
) };
993 memcpy (&to
->x
, &from
->x
, sizeof *to
- off
);
997 /* Assign glyph row FROM to glyph row TO. This works like a structure
998 assignment TO = FROM, except that glyph pointers are not copied but
999 exchanged between TO and FROM. Pointers must be exchanged to avoid
1003 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1005 swap_glyph_pointers (to
, from
);
1006 copy_row_except_pointers (to
, from
);
1010 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1011 a row in a window matrix, is a slice of the glyph memory of the
1012 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1013 is true if the glyph memory of WINDOW_ROW is part of the glyph
1014 memory of FRAME_ROW. */
1019 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1021 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1022 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1023 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1025 return (frame_glyph_start
<= window_glyph_start
1026 && window_glyph_start
< frame_glyph_end
);
1029 #endif /* GLYPH_DEBUG */
1033 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1034 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1035 in WINDOW_MATRIX is found satisfying the condition. */
1037 static struct glyph_row
*
1038 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1039 struct glyph_matrix
*frame_matrix
, int row
)
1043 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1045 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1046 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1047 frame_matrix
->rows
+ row
))
1050 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1055 /* Prepare ROW for display. Desired rows are cleared lazily,
1056 i.e. they are only marked as to be cleared by setting their
1057 enabled_p flag to zero. When a row is to be displayed, a prior
1058 call to this function really clears it. */
1061 prepare_desired_row (struct glyph_row
*row
)
1063 if (!row
->enabled_p
)
1065 bool rp
= row
->reversed_p
;
1067 clear_glyph_row (row
);
1069 row
->reversed_p
= rp
;
1074 /* Return a hash code for glyph row ROW. */
1077 line_hash_code (struct glyph_row
*row
)
1083 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1084 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1088 int c
= glyph
->u
.ch
;
1089 int face_id
= glyph
->face_id
;
1090 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1092 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1093 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1105 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1106 the number of characters in the line. If must_write_spaces is
1107 zero, leading and trailing spaces are ignored. */
1110 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1112 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1113 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1114 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1116 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1117 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1119 /* Ignore trailing and leading spaces if we can. */
1120 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1122 /* Skip from the end over trailing spaces. */
1123 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1126 /* All blank line. */
1130 /* Skip over leading spaces. */
1131 while (CHAR_GLYPH_SPACE_P (*beg
))
1135 /* If we don't have a glyph-table, each glyph is one character,
1136 so return the number of glyphs. */
1137 if (glyph_table_base
== 0)
1141 /* Otherwise, scan the glyphs and accumulate their total length
1148 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1150 if (GLYPH_INVALID_P (g
)
1151 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1154 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1164 /* Return true if the glyph rows A and B have equal contents.
1165 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1168 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1170 eassert (verify_row_hash (a
));
1171 eassert (verify_row_hash (b
));
1175 else if (a
->hash
!= b
->hash
)
1179 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1182 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1185 /* Compare glyphs. */
1186 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1188 if (a
->used
[area
] != b
->used
[area
])
1191 a_glyph
= a
->glyphs
[area
];
1192 a_end
= a_glyph
+ a
->used
[area
];
1193 b_glyph
= b
->glyphs
[area
];
1195 while (a_glyph
< a_end
1196 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1197 ++a_glyph
, ++b_glyph
;
1199 if (a_glyph
!= a_end
)
1203 if (a
->fill_line_p
!= b
->fill_line_p
1204 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1205 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1206 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1207 || a
->left_fringe_offset
!= b
->left_fringe_offset
1208 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1209 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1210 || a
->right_fringe_offset
!= b
->right_fringe_offset
1211 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1212 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1213 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1214 || a
->overlapped_p
!= b
->overlapped_p
1215 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1216 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1217 || a
->reversed_p
!= b
->reversed_p
1218 /* Different partially visible characters on left margin. */
1220 /* Different height. */
1221 || a
->ascent
!= b
->ascent
1222 || a
->phys_ascent
!= b
->phys_ascent
1223 || a
->phys_height
!= b
->phys_height
1224 || a
->visible_height
!= b
->visible_height
)
1233 /***********************************************************************
1236 See dispextern.h for an overall explanation of glyph pools.
1237 ***********************************************************************/
1239 /* Allocate a glyph_pool structure. The structure returned is initialized
1240 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1241 variable glyph_pool_count is incremented for each pool allocated. */
1243 static struct glyph_pool
*
1244 new_glyph_pool (void)
1246 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1248 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1249 /* For memory leak and double deletion checking. */
1257 /* Free a glyph_pool structure POOL. The function may be called with
1258 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1259 global variable glyph_pool_count is decremented with every pool structure
1260 freed. If this count gets negative, more structures were freed than
1261 allocated, i.e. one structure must have been freed more than once or
1262 a bogus pointer was passed to free_glyph_pool. */
1265 free_glyph_pool (struct glyph_pool
*pool
)
1269 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1270 /* More freed than allocated? */
1272 eassert (glyph_pool_count
>= 0);
1274 xfree (pool
->glyphs
);
1280 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1281 columns we need. This function never shrinks a pool. The only
1282 case in which this would make sense, would be when a frame's size
1283 is changed from a large value to a smaller one. But, if someone
1284 does it once, we can expect that he will do it again.
1286 Return true if the pool changed in a way which makes
1287 re-adjusting window glyph matrices necessary. */
1290 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1295 changed_p
= (pool
->glyphs
== 0
1296 || matrix_dim
.height
!= pool
->nrows
1297 || matrix_dim
.width
!= pool
->ncolumns
);
1299 /* Enlarge the glyph pool. */
1300 needed
= matrix_dim
.width
;
1301 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1302 memory_full (SIZE_MAX
);
1303 needed
*= matrix_dim
.height
;
1304 if (needed
> pool
->nglyphs
)
1306 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1307 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1308 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1309 memset (pool
->glyphs
+ old_nglyphs
, 0,
1310 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1313 /* Remember the number of rows and columns because (a) we use them
1314 to do sanity checks, and (b) the number of columns determines
1315 where rows in the frame matrix start---this must be available to
1316 determine pointers to rows of window sub-matrices. */
1317 pool
->nrows
= matrix_dim
.height
;
1318 pool
->ncolumns
= matrix_dim
.width
;
1325 /***********************************************************************
1327 ***********************************************************************/
1332 /* Flush standard output. This is sometimes useful to call from the debugger.
1333 XXX Maybe this should be changed to flush the current terminal instead of
1337 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1346 /* Check that no glyph pointers have been lost in MATRIX. If a
1347 pointer has been lost, e.g. by using a structure assignment between
1348 rows, at least one pointer must occur more than once in the rows of
1352 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1356 for (i
= 0; i
< matrix
->nrows
; ++i
)
1357 for (j
= 0; j
< matrix
->nrows
; ++j
)
1359 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1360 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1364 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1367 matrix_row (struct glyph_matrix
*matrix
, int row
)
1369 eassert (matrix
&& matrix
->rows
);
1370 eassert (row
>= 0 && row
< matrix
->nrows
);
1372 /* That's really too slow for normal testing because this function
1373 is called almost everywhere. Although---it's still astonishingly
1374 fast, so it is valuable to have for debugging purposes. */
1376 check_matrix_pointer_lossage (matrix
);
1379 return matrix
->rows
+ row
;
1383 #if 0 /* This function makes invalid assumptions when text is
1384 partially invisible. But it might come handy for debugging
1387 /* Check invariants that must hold for an up to date current matrix of
1391 check_matrix_invariants (struct window
*w
)
1393 struct glyph_matrix
*matrix
= w
->current_matrix
;
1394 int yb
= window_text_bottom_y (w
);
1395 struct glyph_row
*row
= matrix
->rows
;
1396 struct glyph_row
*last_text_row
= NULL
;
1397 struct buffer
*saved
= current_buffer
;
1398 struct buffer
*buffer
= XBUFFER (w
->contents
);
1401 /* This can sometimes happen for a fresh window. */
1402 if (matrix
->nrows
< 2)
1405 set_buffer_temp (buffer
);
1407 /* Note: last row is always reserved for the mode line. */
1408 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1409 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1411 struct glyph_row
*next
= row
+ 1;
1413 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1414 last_text_row
= row
;
1416 /* Check that character and byte positions are in sync. */
1417 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1418 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1419 eassert (BYTEPOS (row
->start
.pos
)
1420 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1422 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1423 have such a position temporarily in case of a minibuffer
1424 displaying something like `[Sole completion]' at its end. */
1425 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1427 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1428 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1429 eassert (BYTEPOS (row
->end
.pos
)
1430 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1433 /* Check that end position of `row' is equal to start position
1435 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1437 eassert (MATRIX_ROW_END_CHARPOS (row
)
1438 == MATRIX_ROW_START_CHARPOS (next
));
1439 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1440 == MATRIX_ROW_START_BYTEPOS (next
));
1441 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1442 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1447 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1448 eassert (w
->desired_matrix
->rows
!= NULL
);
1449 set_buffer_temp (saved
);
1454 #endif /* GLYPH_DEBUG */
1458 /**********************************************************************
1459 Allocating/ Adjusting Glyph Matrices
1460 **********************************************************************/
1462 /* Allocate glyph matrices over a window tree for a frame-based
1465 X and Y are column/row within the frame glyph matrix where
1466 sub-matrices for the window tree rooted at WINDOW must be
1467 allocated. DIM_ONLY_P means that the caller of this
1468 function is only interested in the result matrix dimension, and
1469 matrix adjustments should not be performed.
1471 The function returns the total width/height of the sub-matrices of
1472 the window tree. If called on a frame root window, the computation
1473 will take the mini-buffer window into account.
1475 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1477 NEW_LEAF_MATRIX set if any window in the tree did not have a
1478 glyph matrices yet, and
1480 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1481 any window in the tree will be changed or have been changed (see
1484 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1487 Windows are arranged into chains of windows on the same level
1488 through the next fields of window structures. Such a level can be
1489 either a sequence of horizontally adjacent windows from left to
1490 right, or a sequence of vertically adjacent windows from top to
1491 bottom. Each window in a horizontal sequence can be either a leaf
1492 window or a vertical sequence; a window in a vertical sequence can
1493 be either a leaf or a horizontal sequence. All windows in a
1494 horizontal sequence have the same height, and all windows in a
1495 vertical sequence have the same width.
1497 This function uses, for historical reasons, a more general
1498 algorithm to determine glyph matrix dimensions that would be
1501 The matrix height of a horizontal sequence is determined by the
1502 maximum height of any matrix in the sequence. The matrix width of
1503 a horizontal sequence is computed by adding up matrix widths of
1504 windows in the sequence.
1506 |<------- result width ------->|
1507 +---------+----------+---------+ ---
1510 +---------+ | | result height
1515 The matrix width of a vertical sequence is the maximum matrix width
1516 of any window in the sequence. Its height is computed by adding up
1517 matrix heights of windows in the sequence.
1519 |<---- result width -->|
1527 +------------+---------+ |
1530 +------------+---------+ --- */
1532 /* Bit indicating that a new matrix will be allocated or has been
1535 #define NEW_LEAF_MATRIX (1 << 0)
1537 /* Bit indicating that a matrix will or has changed its location or
1540 #define CHANGED_LEAF_MATRIX (1 << 1)
1543 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1544 bool dim_only_p
, int *window_change_flags
)
1546 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1548 int wmax
= 0, hmax
= 0;
1552 bool in_horz_combination_p
;
1554 /* What combination is WINDOW part of? Compute this once since the
1555 result is the same for all windows in the `next' chain. The
1556 special case of a root window (parent equal to nil) is treated
1557 like a vertical combination because a root window's `next'
1558 points to the mini-buffer window, if any, which is arranged
1559 vertically below other windows. */
1560 in_horz_combination_p
1561 = (!NILP (XWINDOW (window
)->parent
)
1562 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1564 /* For WINDOW and all windows on the same level. */
1567 w
= XWINDOW (window
);
1569 /* Get the dimension of the window sub-matrix for W, depending
1570 on whether this is a combination or a leaf window. */
1571 if (WINDOWP (w
->contents
))
1572 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1574 window_change_flags
);
1577 /* If not already done, allocate sub-matrix structures. */
1578 if (w
->desired_matrix
== NULL
)
1580 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1581 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1582 *window_change_flags
|= NEW_LEAF_MATRIX
;
1585 /* Width and height MUST be chosen so that there are no
1586 holes in the frame matrix. */
1587 dim
.width
= required_matrix_width (w
);
1588 dim
.height
= required_matrix_height (w
);
1590 /* Will matrix be re-allocated? */
1591 if (x
!= w
->desired_matrix
->matrix_x
1592 || y
!= w
->desired_matrix
->matrix_y
1593 || dim
.width
!= w
->desired_matrix
->matrix_w
1594 || dim
.height
!= w
->desired_matrix
->matrix_h
1595 || (margin_glyphs_to_reserve (w
, dim
.width
,
1596 w
->left_margin_cols
)
1597 != w
->desired_matrix
->left_margin_glyphs
)
1598 || (margin_glyphs_to_reserve (w
, dim
.width
,
1599 w
->right_margin_cols
)
1600 != w
->desired_matrix
->right_margin_glyphs
))
1601 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1603 /* Actually change matrices, if allowed. Do not consider
1604 CHANGED_LEAF_MATRIX computed above here because the pool
1605 may have been changed which we don't now here. We trust
1606 that we only will be called with DIM_ONLY_P when
1610 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1611 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1615 /* If we are part of a horizontal combination, advance x for
1616 windows to the right of W; otherwise advance y for windows
1618 if (in_horz_combination_p
)
1623 /* Remember maximum glyph matrix dimensions. */
1624 wmax
= max (wmax
, dim
.width
);
1625 hmax
= max (hmax
, dim
.height
);
1627 /* Next window on same level. */
1630 while (!NILP (window
));
1632 /* Set `total' to the total glyph matrix dimension of this window
1633 level. In a vertical combination, the width is the width of the
1634 widest window; the height is the y we finally reached, corrected
1635 by the y we started with. In a horizontal combination, the total
1636 height is the height of the tallest window, and the width is the
1637 x we finally reached, corrected by the x we started with. */
1638 if (in_horz_combination_p
)
1640 total
.width
= x
- x0
;
1641 total
.height
= hmax
;
1646 total
.height
= y
- y0
;
1653 /* Return the required height of glyph matrices for window W. */
1656 required_matrix_height (struct window
*w
)
1658 #ifdef HAVE_WINDOW_SYSTEM
1659 struct frame
*f
= XFRAME (w
->frame
);
1661 if (FRAME_WINDOW_P (f
))
1663 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1664 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1665 return (((window_pixel_height
+ ch_height
- 1)
1666 / ch_height
) * w
->nrows_scale_factor
1667 /* One partially visible line at the top and
1668 bottom of the window. */
1670 /* 2 for header and mode line. */
1673 #endif /* HAVE_WINDOW_SYSTEM */
1675 return WINDOW_TOTAL_LINES (w
);
1679 /* Return the required width of glyph matrices for window W. */
1682 required_matrix_width (struct window
*w
)
1684 #ifdef HAVE_WINDOW_SYSTEM
1685 struct frame
*f
= XFRAME (w
->frame
);
1686 if (FRAME_WINDOW_P (f
))
1688 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1689 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1691 /* Compute number of glyphs needed in a glyph row. */
1692 return (((window_pixel_width
+ ch_width
- 1)
1693 / ch_width
) * w
->ncols_scale_factor
1694 /* 2 partially visible columns in the text area. */
1696 /* One partially visible column at the right
1697 edge of each marginal area. */
1700 #endif /* HAVE_WINDOW_SYSTEM */
1702 return w
->total_cols
;
1706 /* Allocate window matrices for window-based redisplay. W is the
1707 window whose matrices must be allocated/reallocated. */
1710 allocate_matrices_for_window_redisplay (struct window
*w
)
1714 if (WINDOWP (w
->contents
))
1715 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1718 /* W is a leaf window. */
1721 /* If matrices are not yet allocated, allocate them now. */
1722 if (w
->desired_matrix
== NULL
)
1724 w
->desired_matrix
= new_glyph_matrix (NULL
);
1725 w
->current_matrix
= new_glyph_matrix (NULL
);
1728 dim
.width
= required_matrix_width (w
);
1729 dim
.height
= required_matrix_height (w
);
1730 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1731 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1734 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1738 /* Allocate/reallocate glyph matrices of a single frame F.
1739 This function must be called when a new frame is created,
1740 its size changes, or its window configuration changes. */
1743 adjust_frame_glyphs (struct frame
*f
)
1745 /* Block input so that expose events and other events that access
1746 glyph matrices are not processed while we are changing them. */
1749 if (FRAME_WINDOW_P (f
))
1750 adjust_frame_glyphs_for_window_redisplay (f
);
1752 adjust_frame_glyphs_for_frame_redisplay (f
);
1754 /* Don't forget the buffer for decode_mode_spec. */
1755 adjust_decode_mode_spec_buffer (f
);
1757 f
->glyphs_initialized_p
= 1;
1762 /* Return true if any window in the tree has nonzero window margins. See
1763 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1765 showing_window_margins_p (struct window
*w
)
1769 if (WINDOWP (w
->contents
))
1771 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1774 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1777 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1783 /* In the window tree with root W, build current matrices of leaf
1784 windows from the frame's current matrix. */
1787 fake_current_matrices (Lisp_Object window
)
1791 for (; !NILP (window
); window
= w
->next
)
1793 w
= XWINDOW (window
);
1795 if (WINDOWP (w
->contents
))
1796 fake_current_matrices (w
->contents
);
1800 struct frame
*f
= XFRAME (w
->frame
);
1801 struct glyph_matrix
*m
= w
->current_matrix
;
1802 struct glyph_matrix
*fm
= f
->current_matrix
;
1804 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1805 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1807 for (i
= 0; i
< m
->matrix_h
; ++i
)
1809 struct glyph_row
*r
= m
->rows
+ i
;
1810 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1812 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1813 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1815 r
->enabled_p
= fr
->enabled_p
;
1818 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1819 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1820 r
->used
[TEXT_AREA
] = (m
->matrix_w
1821 - r
->used
[LEFT_MARGIN_AREA
]
1822 - r
->used
[RIGHT_MARGIN_AREA
]);
1831 /* Save away the contents of frame F's current frame matrix. Value is
1832 a glyph matrix holding the contents of F's current frame matrix. */
1834 static struct glyph_matrix
*
1835 save_current_matrix (struct frame
*f
)
1838 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1839 saved
->nrows
= f
->current_matrix
->nrows
;
1840 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1842 for (i
= 0; i
< saved
->nrows
; ++i
)
1844 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1845 struct glyph_row
*to
= saved
->rows
+ i
;
1846 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1848 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1849 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1850 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1851 to
->enabled_p
= from
->enabled_p
;
1852 to
->hash
= from
->hash
;
1853 if (from
->used
[LEFT_MARGIN_AREA
])
1855 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1856 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1857 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1858 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1859 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1861 if (from
->used
[RIGHT_MARGIN_AREA
])
1863 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1864 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1865 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1866 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1867 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1875 /* Restore the contents of frame F's current frame matrix from SAVED,
1876 and free memory associated with SAVED. */
1879 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1883 for (i
= 0; i
< saved
->nrows
; ++i
)
1885 struct glyph_row
*from
= saved
->rows
+ i
;
1886 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1887 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1889 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1890 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1891 xfree (from
->glyphs
[TEXT_AREA
]);
1892 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1895 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1896 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1897 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1898 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1901 to
->used
[LEFT_MARGIN_AREA
] = 0;
1902 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1905 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1906 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1907 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1908 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1911 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1914 xfree (saved
->rows
);
1920 /* Allocate/reallocate glyph matrices of a single frame F for
1921 frame-based redisplay. */
1924 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1926 struct dim matrix_dim
;
1927 bool pool_changed_p
;
1928 int window_change_flags
;
1931 if (!FRAME_LIVE_P (f
))
1934 top_window_y
= FRAME_TOP_MARGIN (f
);
1936 /* Allocate glyph pool structures if not already done. */
1937 if (f
->desired_pool
== NULL
)
1939 f
->desired_pool
= new_glyph_pool ();
1940 f
->current_pool
= new_glyph_pool ();
1943 /* Allocate frames matrix structures if needed. */
1944 if (f
->desired_matrix
== NULL
)
1946 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1947 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1950 /* Compute window glyph matrices. (This takes the mini-buffer
1951 window into account). The result is the size of the frame glyph
1952 matrix needed. The variable window_change_flags is set to a bit
1953 mask indicating whether new matrices will be allocated or
1954 existing matrices change their size or location within the frame
1956 window_change_flags
= 0;
1958 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1961 &window_change_flags
);
1963 /* Add in menu bar lines, if any. */
1964 matrix_dim
.height
+= top_window_y
;
1966 /* Enlarge pools as necessary. */
1967 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
1968 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
1970 /* Set up glyph pointers within window matrices. Do this only if
1971 absolutely necessary since it requires a frame redraw. */
1972 if (pool_changed_p
|| window_change_flags
)
1974 /* Do it for window matrices. */
1975 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1977 &window_change_flags
);
1979 /* Size of frame matrices must equal size of frame. Note
1980 that we are called for X frames with window widths NOT equal
1981 to the frame width (from CHANGE_FRAME_SIZE_1). */
1982 eassert (matrix_dim
.width
== FRAME_COLS (f
)
1983 && matrix_dim
.height
== FRAME_LINES (f
));
1985 /* Pointers to glyph memory in glyph rows are exchanged during
1986 the update phase of redisplay, which means in general that a
1987 frame's current matrix consists of pointers into both the
1988 desired and current glyph pool of the frame. Adjusting a
1989 matrix sets the frame matrix up so that pointers are all into
1990 the same pool. If we want to preserve glyph contents of the
1991 current matrix over a call to adjust_glyph_matrix, we must
1992 make a copy of the current glyphs, and restore the current
1993 matrix' contents from that copy. */
1994 if (display_completed
1995 && !FRAME_GARBAGED_P (f
)
1996 && matrix_dim
.width
== f
->current_matrix
->matrix_w
1997 && matrix_dim
.height
== f
->current_matrix
->matrix_h
1998 /* For some reason, the frame glyph matrix gets corrupted if
1999 any of the windows contain margins. I haven't been able
2000 to hunt down the reason, but for the moment this prevents
2001 the problem from manifesting. -- cyd */
2002 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2004 struct glyph_matrix
*copy
= save_current_matrix (f
);
2005 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2006 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2007 restore_current_matrix (f
, copy
);
2008 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2012 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2013 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2014 SET_FRAME_GARBAGED (f
);
2020 /* Allocate/reallocate glyph matrices of a single frame F for
2021 window-based redisplay. */
2024 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2026 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2028 /* Allocate/reallocate window matrices. */
2029 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2031 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2032 /* Allocate/ reallocate matrices of the dummy window used to display
2033 the menu bar under X when no X toolkit support is available. */
2035 /* Allocate a dummy window if not already done. */
2037 if (NILP (f
->menu_bar_window
))
2040 fset_menu_bar_window (f
, make_window ());
2041 w
= XWINDOW (f
->menu_bar_window
);
2042 XSETFRAME (frame
, f
);
2043 wset_frame (w
, frame
);
2044 w
->pseudo_window_p
= 1;
2047 w
= XWINDOW (f
->menu_bar_window
);
2049 /* Set window dimensions to frame dimensions and allocate or
2050 adjust glyph matrices of W. */
2053 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2054 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2055 allocate_matrices_for_window_redisplay (w
);
2059 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2061 /* Allocate/ reallocate matrices of the tool bar window. If we
2062 don't have a tool bar window yet, make one. */
2064 if (NILP (f
->tool_bar_window
))
2067 fset_tool_bar_window (f
, make_window ());
2068 w
= XWINDOW (f
->tool_bar_window
);
2069 XSETFRAME (frame
, f
);
2070 wset_frame (w
, frame
);
2071 w
->pseudo_window_p
= 1;
2074 w
= XWINDOW (f
->tool_bar_window
);
2076 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2078 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2079 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2080 allocate_matrices_for_window_redisplay (w
);
2086 /* Re-allocate buffer for decode_mode_spec on frame F. */
2089 adjust_decode_mode_spec_buffer (struct frame
*f
)
2091 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2092 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2097 /**********************************************************************
2098 Freeing Glyph Matrices
2099 **********************************************************************/
2101 /* Free glyph memory for a frame F. F may be null. This function can
2102 be called for the same frame more than once. The root window of
2103 F may be nil when this function is called. This is the case when
2104 the function is called when F is destroyed. */
2107 free_glyphs (struct frame
*f
)
2109 if (f
&& f
->glyphs_initialized_p
)
2111 /* Block interrupt input so that we don't get surprised by an X
2112 event while we're in an inconsistent state. */
2114 f
->glyphs_initialized_p
= 0;
2116 /* Release window sub-matrices. */
2117 if (!NILP (f
->root_window
))
2118 free_window_matrices (XWINDOW (f
->root_window
));
2120 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2121 /* Free the dummy window for menu bars without X toolkit and its
2123 if (!NILP (f
->menu_bar_window
))
2125 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2126 free_glyph_matrix (w
->desired_matrix
);
2127 free_glyph_matrix (w
->current_matrix
);
2128 w
->desired_matrix
= w
->current_matrix
= NULL
;
2129 fset_menu_bar_window (f
, Qnil
);
2133 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2134 /* Free the tool bar window and its glyph matrices. */
2135 if (!NILP (f
->tool_bar_window
))
2137 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2138 free_glyph_matrix (w
->desired_matrix
);
2139 free_glyph_matrix (w
->current_matrix
);
2140 w
->desired_matrix
= w
->current_matrix
= NULL
;
2141 fset_tool_bar_window (f
, Qnil
);
2145 /* Release frame glyph matrices. Reset fields to zero in
2146 case we are called a second time. */
2147 if (f
->desired_matrix
)
2149 free_glyph_matrix (f
->desired_matrix
);
2150 free_glyph_matrix (f
->current_matrix
);
2151 f
->desired_matrix
= f
->current_matrix
= NULL
;
2154 /* Release glyph pools. */
2155 if (f
->desired_pool
)
2157 free_glyph_pool (f
->desired_pool
);
2158 free_glyph_pool (f
->current_pool
);
2159 f
->desired_pool
= f
->current_pool
= NULL
;
2167 /* Free glyph sub-matrices in the window tree rooted at W. This
2168 function may be called with a null pointer, and it may be called on
2169 the same tree more than once. */
2172 free_window_matrices (struct window
*w
)
2176 if (WINDOWP (w
->contents
))
2177 free_window_matrices (XWINDOW (w
->contents
));
2180 /* This is a leaf window. Free its memory and reset fields
2181 to zero in case this function is called a second time for
2183 free_glyph_matrix (w
->current_matrix
);
2184 free_glyph_matrix (w
->desired_matrix
);
2185 w
->current_matrix
= w
->desired_matrix
= NULL
;
2188 /* Next window on same level. */
2189 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2194 /* Check glyph memory leaks. This function is called from
2195 shut_down_emacs. Note that frames are not destroyed when Emacs
2196 exits. We therefore free all glyph memory for all active frames
2197 explicitly and check that nothing is left allocated. */
2200 check_glyph_memory (void)
2202 Lisp_Object tail
, frame
;
2204 /* Free glyph memory for all frames. */
2205 FOR_EACH_FRAME (tail
, frame
)
2206 free_glyphs (XFRAME (frame
));
2208 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2209 /* Check that nothing is left allocated. */
2210 eassert (glyph_matrix_count
== 0);
2211 eassert (glyph_pool_count
== 0);
2217 /**********************************************************************
2218 Building a Frame Matrix
2219 **********************************************************************/
2221 /* Most of the redisplay code works on glyph matrices attached to
2222 windows. This is a good solution most of the time, but it is not
2223 suitable for terminal code. Terminal output functions cannot rely
2224 on being able to set an arbitrary terminal window. Instead they
2225 must be provided with a view of the whole frame, i.e. the whole
2226 screen. We build such a view by constructing a frame matrix from
2227 window matrices in this section.
2229 Windows that must be updated have their must_be_updated_p flag set.
2230 For all such windows, their desired matrix is made part of the
2231 desired frame matrix. For other windows, their current matrix is
2232 made part of the desired frame matrix.
2234 +-----------------+----------------+
2235 | desired | desired |
2237 +-----------------+----------------+
2240 +----------------------------------+
2242 Desired window matrices can be made part of the frame matrix in a
2243 cheap way: We exploit the fact that the desired frame matrix and
2244 desired window matrices share their glyph memory. This is not
2245 possible for current window matrices. Their glyphs are copied to
2246 the desired frame matrix. The latter is equivalent to
2247 preserve_other_columns in the old redisplay.
2249 Used glyphs counters for frame matrix rows are the result of adding
2250 up glyph lengths of the window matrices. A line in the frame
2251 matrix is enabled, if a corresponding line in a window matrix is
2254 After building the desired frame matrix, it will be passed to
2255 terminal code, which will manipulate both the desired and current
2256 frame matrix. Changes applied to the frame's current matrix have
2257 to be visible in current window matrices afterwards, of course.
2259 This problem is solved like this:
2261 1. Window and frame matrices share glyphs. Window matrices are
2262 constructed in a way that their glyph contents ARE the glyph
2263 contents needed in a frame matrix. Thus, any modification of
2264 glyphs done in terminal code will be reflected in window matrices
2267 2. Exchanges of rows in a frame matrix done by terminal code are
2268 intercepted by hook functions so that corresponding row operations
2269 on window matrices can be performed. This is necessary because we
2270 use pointers to glyphs in glyph row structures. To satisfy the
2271 assumption of point 1 above that glyphs are updated implicitly in
2272 window matrices when they are manipulated via the frame matrix,
2273 window and frame matrix must of course agree where to find the
2274 glyphs for their rows. Possible manipulations that must be
2275 mirrored are assignments of rows of the desired frame matrix to the
2276 current frame matrix and scrolling the current frame matrix. */
2278 /* Build frame F's desired matrix from window matrices. Only windows
2279 which have the flag must_be_updated_p set have to be updated. Menu
2280 bar lines of a frame are not covered by window matrices, so make
2281 sure not to touch them in this function. */
2284 build_frame_matrix (struct frame
*f
)
2288 /* F must have a frame matrix when this function is called. */
2289 eassert (!FRAME_WINDOW_P (f
));
2291 /* Clear all rows in the frame matrix covered by window matrices.
2292 Menu bar lines are not covered by windows. */
2293 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2294 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2296 /* Build the matrix by walking the window tree. */
2297 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2298 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2302 /* Walk a window tree, building a frame matrix MATRIX from window
2303 matrices. W is the root of a window tree. */
2306 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2310 if (WINDOWP (w
->contents
))
2311 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2313 build_frame_matrix_from_leaf_window (matrix
, w
);
2315 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2320 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2321 desired frame matrix built. W is a leaf window whose desired or
2322 current matrix is to be added to FRAME_MATRIX. W's flag
2323 must_be_updated_p determines which matrix it contributes to
2324 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2325 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2326 Adding a desired matrix means setting up used counters and such in
2327 frame rows, while adding a current window matrix to FRAME_MATRIX
2328 means copying glyphs. The latter case corresponds to
2329 preserve_other_columns in the old redisplay. */
2332 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2334 struct glyph_matrix
*window_matrix
;
2335 int window_y
, frame_y
;
2336 /* If non-zero, a glyph to insert at the right border of W. */
2337 GLYPH right_border_glyph
;
2339 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2341 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2342 if (w
->must_be_updated_p
)
2344 window_matrix
= w
->desired_matrix
;
2346 /* Decide whether we want to add a vertical border glyph. */
2347 if (!WINDOW_RIGHTMOST_P (w
))
2349 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2352 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2354 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2356 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2357 spec_glyph_lookup_face (w
, &right_border_glyph
);
2360 if (GLYPH_FACE (right_border_glyph
) <= 0)
2361 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2365 window_matrix
= w
->current_matrix
;
2367 /* For all rows in the window matrix and corresponding rows in the
2370 frame_y
= window_matrix
->matrix_y
;
2371 while (window_y
< window_matrix
->nrows
)
2373 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2374 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2375 bool current_row_p
= window_matrix
== w
->current_matrix
;
2377 /* Fill up the frame row with spaces up to the left margin of the
2379 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2381 /* Fill up areas in the window matrix row with spaces. */
2382 fill_up_glyph_row_with_spaces (window_row
);
2384 /* If only part of W's desired matrix has been built, and
2385 window_row wasn't displayed, use the corresponding current
2387 if (window_matrix
== w
->desired_matrix
2388 && !window_row
->enabled_p
)
2390 window_row
= w
->current_matrix
->rows
+ window_y
;
2396 /* Copy window row to frame row. */
2397 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2398 window_row
->glyphs
[0],
2399 window_matrix
->matrix_w
* sizeof (struct glyph
));
2403 eassert (window_row
->enabled_p
);
2405 /* Only when a desired row has been displayed, we want
2406 the corresponding frame row to be updated. */
2407 frame_row
->enabled_p
= 1;
2409 /* Maybe insert a vertical border between horizontally adjacent
2411 if (GLYPH_CHAR (right_border_glyph
) != 0)
2413 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2414 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2418 /* Window row window_y must be a slice of frame row
2420 eassert (glyph_row_slice_p (window_row
, frame_row
));
2422 /* If rows are in sync, we don't have to copy glyphs because
2423 frame and window share glyphs. */
2425 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2426 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2430 /* Set number of used glyphs in the frame matrix. Since we fill
2431 up with spaces, and visit leaf windows from left to right it
2432 can be done simply. */
2433 frame_row
->used
[TEXT_AREA
]
2434 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2442 /* Given a user-specified glyph, possibly including a Lisp-level face
2443 ID, return a glyph that has a realized face ID.
2444 This is used for glyphs displayed specially and not part of the text;
2445 for instance, vertical separators, truncation markers, etc. */
2448 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2450 int lface_id
= GLYPH_FACE (*glyph
);
2451 /* Convert the glyph's specified face to a realized (cache) face. */
2454 int face_id
= merge_faces (XFRAME (w
->frame
),
2455 Qt
, lface_id
, DEFAULT_FACE_ID
);
2456 SET_GLYPH_FACE (*glyph
, face_id
);
2460 /* Add spaces to a glyph row ROW in a window matrix.
2462 Each row has the form:
2464 +---------+-----------------------------+------------+
2465 | left | text | right |
2466 +---------+-----------------------------+------------+
2468 Left and right marginal areas are optional. This function adds
2469 spaces to areas so that there are no empty holes between areas.
2470 In other words: If the right area is not empty, the text area
2471 is filled up with spaces up to the right area. If the text area
2472 is not empty, the left area is filled up.
2474 To be called for frame-based redisplay, only. */
2477 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2479 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2480 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2481 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2485 /* Fill area AREA of glyph row ROW with spaces. To be called for
2486 frame-based redisplay only. */
2489 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2491 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2493 struct glyph
*end
= row
->glyphs
[area
+ 1];
2494 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2497 *text
++ = space_glyph
;
2498 row
->used
[area
] = text
- row
->glyphs
[area
];
2503 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2504 reached. In frame matrices only one area, TEXT_AREA, is used. */
2507 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2509 int i
= row
->used
[TEXT_AREA
];
2510 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2513 glyph
[i
++] = space_glyph
;
2515 row
->used
[TEXT_AREA
] = i
;
2520 /**********************************************************************
2521 Mirroring operations on frame matrices in window matrices
2522 **********************************************************************/
2524 /* Set frame being updated via frame-based redisplay to F. This
2525 function must be called before updates to make explicit that we are
2526 working on frame matrices or not. */
2529 set_frame_matrix_frame (struct frame
*f
)
2531 frame_matrix_frame
= f
;
2535 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2536 DESIRED_MATRIX is the desired matrix corresponding to
2537 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2538 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2539 frame_matrix_frame is non-null, this indicates that the exchange is
2540 done in frame matrices, and that we have to perform analogous
2541 operations in window matrices of frame_matrix_frame. */
2544 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2546 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2547 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2548 bool mouse_face_p
= current_row
->mouse_face_p
;
2550 /* Do current_row = desired_row. This exchanges glyph pointers
2551 between both rows, and does a structure assignment otherwise. */
2552 assign_row (current_row
, desired_row
);
2554 /* Enable current_row to mark it as valid. */
2555 current_row
->enabled_p
= 1;
2556 current_row
->mouse_face_p
= mouse_face_p
;
2558 /* If we are called on frame matrices, perform analogous operations
2559 for window matrices. */
2560 if (frame_matrix_frame
)
2561 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2565 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2566 W's frame which has been made current (by swapping pointers between
2567 current and desired matrix). Perform analogous operations in the
2568 matrices of leaf windows in the window tree rooted at W. */
2571 mirror_make_current (struct window
*w
, int frame_row
)
2575 if (WINDOWP (w
->contents
))
2576 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2579 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2580 here because the checks performed in debug mode there
2581 will not allow the conversion. */
2582 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2584 /* If FRAME_ROW is within W, assign the desired row to the
2585 current row (exchanging glyph pointers). */
2586 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2588 struct glyph_row
*current_row
2589 = MATRIX_ROW (w
->current_matrix
, row
);
2590 struct glyph_row
*desired_row
2591 = MATRIX_ROW (w
->desired_matrix
, row
);
2593 if (desired_row
->enabled_p
)
2594 assign_row (current_row
, desired_row
);
2596 swap_glyph_pointers (desired_row
, current_row
);
2597 current_row
->enabled_p
= 1;
2599 /* Set the Y coordinate of the mode/header line's row.
2600 It is needed in draw_row_with_mouse_face to find the
2601 screen coordinates. (Window-based redisplay sets
2602 this in update_window, but no one seems to do that
2603 for frame-based redisplay.) */
2604 if (current_row
->mode_line_p
)
2605 current_row
->y
= row
;
2609 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2614 /* Perform row dance after scrolling. We are working on the range of
2615 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2616 including) in MATRIX. COPY_FROM is a vector containing, for each
2617 row I in the range 0 <= I < NLINES, the index of the original line
2618 to move to I. This index is relative to the row range, i.e. 0 <=
2619 index < NLINES. RETAINED_P is a vector containing zero for each
2620 row 0 <= I < NLINES which is empty.
2622 This function is called from do_scrolling and do_direct_scrolling. */
2625 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2626 int *copy_from
, char *retained_p
)
2628 /* A copy of original rows. */
2629 struct glyph_row
*old_rows
;
2631 /* Rows to assign to. */
2632 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2636 /* Make a copy of the original rows. */
2637 old_rows
= alloca (nlines
* sizeof *old_rows
);
2638 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2640 /* Assign new rows, maybe clear lines. */
2641 for (i
= 0; i
< nlines
; ++i
)
2643 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2645 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2646 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2647 new_rows
[i
] = old_rows
[copy_from
[i
]];
2648 new_rows
[i
].enabled_p
= enabled_before_p
;
2650 /* RETAINED_P is zero for empty lines. */
2651 if (!retained_p
[copy_from
[i
]])
2652 new_rows
[i
].enabled_p
= 0;
2655 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2656 if (frame_matrix_frame
)
2657 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2658 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2662 /* Synchronize glyph pointers in the current matrix of window W with
2663 the current frame matrix. */
2666 sync_window_with_frame_matrix_rows (struct window
*w
)
2668 struct frame
*f
= XFRAME (w
->frame
);
2669 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2670 int left
, right
, x
, width
;
2672 /* Preconditions: W must be a live window on a tty frame. */
2673 eassert (BUFFERP (w
->contents
));
2674 eassert (!FRAME_WINDOW_P (f
));
2676 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2677 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2678 x
= w
->current_matrix
->matrix_x
;
2679 width
= w
->current_matrix
->matrix_w
;
2681 window_row
= w
->current_matrix
->rows
;
2682 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2683 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2685 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2687 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2688 = frame_row
->glyphs
[0] + x
;
2689 window_row
->glyphs
[TEXT_AREA
]
2690 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2691 window_row
->glyphs
[LAST_AREA
]
2692 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2693 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2694 = window_row
->glyphs
[LAST_AREA
] - right
;
2699 /* Return the window in the window tree rooted in W containing frame
2700 row ROW. Value is null if none is found. */
2702 static struct window
*
2703 frame_row_to_window (struct window
*w
, int row
)
2705 struct window
*found
= NULL
;
2709 if (WINDOWP (w
->contents
))
2710 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2711 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2712 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2715 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2722 /* Perform a line dance in the window tree rooted at W, after
2723 scrolling a frame matrix in mirrored_line_dance.
2725 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2726 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2727 COPY_FROM is a vector containing, for each row I in the range 0 <=
2728 I < NLINES, the index of the original line to move to I. This
2729 index is relative to the row range, i.e. 0 <= index < NLINES.
2730 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2734 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2738 if (WINDOWP (w
->contents
))
2739 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2740 nlines
, copy_from
, retained_p
);
2743 /* W is a leaf window, and we are working on its current
2745 struct glyph_matrix
*m
= w
->current_matrix
;
2748 struct glyph_row
*old_rows
;
2750 /* Make a copy of the original rows of matrix m. */
2751 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2752 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2754 for (i
= 0; i
< nlines
; ++i
)
2756 /* Frame relative line assigned to. */
2757 int frame_to
= i
+ unchanged_at_top
;
2759 /* Frame relative line assigned. */
2760 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2762 /* Window relative line assigned to. */
2763 int window_to
= frame_to
- m
->matrix_y
;
2765 /* Window relative line assigned. */
2766 int window_from
= frame_from
- m
->matrix_y
;
2768 /* Is assigned line inside window? */
2769 bool from_inside_window_p
2770 = window_from
>= 0 && window_from
< m
->matrix_h
;
2772 /* Is assigned to line inside window? */
2773 bool to_inside_window_p
2774 = window_to
>= 0 && window_to
< m
->matrix_h
;
2776 if (from_inside_window_p
&& to_inside_window_p
)
2778 /* Do the assignment. The enabled_p flag is saved
2779 over the assignment because the old redisplay did
2781 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2782 m
->rows
[window_to
] = old_rows
[window_from
];
2783 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2785 /* If frame line is empty, window line is empty, too. */
2786 if (!retained_p
[copy_from
[i
]])
2787 m
->rows
[window_to
].enabled_p
= 0;
2789 else if (to_inside_window_p
)
2791 /* A copy between windows. This is an infrequent
2792 case not worth optimizing. */
2793 struct frame
*f
= XFRAME (w
->frame
);
2794 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2796 struct glyph_matrix
*m2
;
2799 w2
= frame_row_to_window (root
, frame_from
);
2800 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2801 -nw', FROM_FRAME sometimes has no associated window.
2802 This check avoids a segfault if W2 is null. */
2805 m2
= w2
->current_matrix
;
2806 m2_from
= frame_from
- m2
->matrix_y
;
2807 copy_row_except_pointers (m
->rows
+ window_to
,
2808 m2
->rows
+ m2_from
);
2810 /* If frame line is empty, window line is empty, too. */
2811 if (!retained_p
[copy_from
[i
]])
2812 m
->rows
[window_to
].enabled_p
= 0;
2816 else if (from_inside_window_p
)
2820 /* If there was a copy between windows, make sure glyph
2821 pointers are in sync with the frame matrix. */
2823 sync_window_with_frame_matrix_rows (w
);
2825 /* Check that no pointers are lost. */
2829 /* Next window on same level. */
2830 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2837 /* Check that window and frame matrices agree about their
2838 understanding where glyphs of the rows are to find. For each
2839 window in the window tree rooted at W, check that rows in the
2840 matrices of leaf window agree with their frame matrices about
2844 check_window_matrix_pointers (struct window
*w
)
2848 if (WINDOWP (w
->contents
))
2849 check_window_matrix_pointers (XWINDOW (w
->contents
));
2852 struct frame
*f
= XFRAME (w
->frame
);
2853 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2854 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2857 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2862 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2863 a window and FRAME_MATRIX is the corresponding frame matrix. For
2864 each row in WINDOW_MATRIX check that it's a slice of the
2865 corresponding frame row. If it isn't, abort. */
2868 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2869 struct glyph_matrix
*frame_matrix
)
2871 /* Row number in WINDOW_MATRIX. */
2874 /* Row number corresponding to I in FRAME_MATRIX. */
2875 int j
= window_matrix
->matrix_y
;
2877 /* For all rows check that the row in the window matrix is a
2878 slice of the row in the frame matrix. If it isn't we didn't
2879 mirror an operation on the frame matrix correctly. */
2880 while (i
< window_matrix
->nrows
)
2882 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2883 frame_matrix
->rows
+ j
))
2889 #endif /* GLYPH_DEBUG */
2893 /**********************************************************************
2894 VPOS and HPOS translations
2895 **********************************************************************/
2899 /* Translate vertical position VPOS which is relative to window W to a
2900 vertical position relative to W's frame. */
2903 window_to_frame_vpos (struct window
*w
, int vpos
)
2905 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2906 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2907 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2908 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
2913 /* Translate horizontal position HPOS which is relative to window W to
2914 a horizontal position relative to W's frame. */
2917 window_to_frame_hpos (struct window
*w
, int hpos
)
2919 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2920 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2924 #endif /* GLYPH_DEBUG */
2928 /**********************************************************************
2930 **********************************************************************/
2932 /* Redraw frame F. */
2935 redraw_frame (struct frame
*f
)
2937 /* Error if F has no glyphs. */
2938 eassert (f
->glyphs_initialized_p
);
2940 if (FRAME_MSDOS_P (f
))
2941 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
2943 clear_current_matrices (f
);
2945 windows_or_buffers_changed
++;
2946 /* Mark all windows as inaccurate, so that every window will have
2947 its redisplay done. */
2948 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
2949 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), NULL
, 1);
2953 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
2954 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
2955 If FRAME is omitted or nil, the selected frame is used. */)
2958 redraw_frame (decode_live_frame (frame
));
2962 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
2963 doc
: /* Clear and redisplay all visible frames. */)
2966 Lisp_Object tail
, frame
;
2968 FOR_EACH_FRAME (tail
, frame
)
2969 if (FRAME_VISIBLE_P (XFRAME (frame
)))
2970 redraw_frame (XFRAME (frame
));
2977 /***********************************************************************
2979 ***********************************************************************/
2981 /* Update frame F based on the data in desired matrices.
2983 If FORCE_P, don't let redisplay be stopped by detecting pending input.
2984 If INHIBIT_HAIRY_ID_P, don't try scrolling.
2986 Value is true if redisplay was stopped due to pending input. */
2989 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
2991 /* True means display has been paused because of pending input. */
2993 struct window
*root_window
= XWINDOW (f
->root_window
);
2995 if (redisplay_dont_pause
)
2997 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3003 if (FRAME_WINDOW_P (f
))
3005 /* We are working on window matrix basis. All windows whose
3006 flag must_be_updated_p is set have to be updated. */
3008 /* Record that we are not working on frame matrices. */
3009 set_frame_matrix_frame (NULL
);
3011 /* Update all windows in the window tree of F, maybe stopping
3012 when pending input is detected. */
3015 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3016 /* Update the menu bar on X frames that don't have toolkit
3018 if (WINDOWP (f
->menu_bar_window
))
3019 update_window (XWINDOW (f
->menu_bar_window
), 1);
3022 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3023 /* Update the tool-bar window, if present. */
3024 if (WINDOWP (f
->tool_bar_window
))
3026 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3028 /* Update tool-bar window. */
3029 if (w
->must_be_updated_p
)
3033 update_window (w
, 1);
3034 w
->must_be_updated_p
= 0;
3036 /* Swap tool-bar strings. We swap because we want to
3038 tem
= f
->current_tool_bar_string
;
3039 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3040 fset_desired_tool_bar_string (f
, tem
);
3045 /* Update windows. */
3046 paused_p
= update_window_tree (root_window
, force_p
);
3051 /* We are working on frame matrix basis. Set the frame on whose
3052 frame matrix we operate. */
3053 set_frame_matrix_frame (f
);
3055 /* Build F's desired matrix from window matrices. */
3056 build_frame_matrix (f
);
3058 /* Update the display */
3060 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3063 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3065 if (FRAME_TTY (f
)->termscript
)
3066 fflush (FRAME_TTY (f
)->termscript
);
3067 if (FRAME_TERMCAP_P (f
))
3068 fflush (FRAME_TTY (f
)->output
);
3071 /* Check window matrices for lost pointers. */
3073 check_window_matrix_pointers (root_window
);
3074 add_frame_display_history (f
, paused_p
);
3079 /* Reset flags indicating that a window should be updated. */
3080 set_window_update_flags (root_window
, NULL
, 0);
3082 display_completed
= !paused_p
;
3086 /* Update a TTY frame F that has a menu dropped down over some of its
3087 glyphs. This is like the second part of update_frame, but it
3088 doesn't call build_frame_matrix, because we already have the
3089 desired matrix prepared, and don't want it to be overwritten by the
3090 text of the normal display. */
3092 update_frame_with_menu (struct frame
*f
)
3094 struct window
*root_window
= XWINDOW (f
->root_window
);
3097 eassert (FRAME_TERMCAP_P (f
));
3099 /* We are working on frame matrix basis. Set the frame on whose
3100 frame matrix we operate. */
3101 set_frame_matrix_frame (f
);
3103 /* Update the display */
3105 /* Force update_frame_1 not to stop due to pending input, and not
3107 paused_p
= update_frame_1 (f
, 1, 1);
3110 if (FRAME_TTY (f
)->termscript
)
3111 fflush (FRAME_TTY (f
)->termscript
);
3112 fflush (FRAME_TTY (f
)->output
);
3113 /* Check window matrices for lost pointers. */
3116 /* We cannot possibly survive the matrix pointers check, since
3117 we have overwritten parts of the frame glyph matrix without
3118 making any updates to the window matrices. */
3119 check_window_matrix_pointers (root_window
);
3121 add_frame_display_history (f
, paused_p
);
3123 IF_LINT ((void) paused_p
);
3126 /* Reset flags indicating that a window should be updated. */
3127 set_window_update_flags (root_window
, NULL
, 0);
3131 /************************************************************************
3132 Window-based updates
3133 ************************************************************************/
3135 /* Perform updates in window tree rooted at W.
3136 If FORCE_P, don't stop updating if input is pending. */
3139 update_window_tree (struct window
*w
, bool force_p
)
3143 while (w
&& !paused_p
)
3145 if (WINDOWP (w
->contents
))
3146 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3147 else if (w
->must_be_updated_p
)
3148 paused_p
|= update_window (w
, force_p
);
3150 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3157 /* Update window W if its flag must_be_updated_p is set.
3158 If FORCE_P, don't stop updating if input is pending. */
3161 update_single_window (struct window
*w
, bool force_p
)
3163 if (w
->must_be_updated_p
)
3165 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3167 /* Record that this is not a frame-based redisplay. */
3168 set_frame_matrix_frame (NULL
);
3170 if (redisplay_dont_pause
)
3175 update_window (w
, force_p
);
3178 /* Reset flag in W. */
3179 w
->must_be_updated_p
= 0;
3183 #ifdef HAVE_WINDOW_SYSTEM
3185 /* Redraw lines from the current matrix of window W that are
3186 overlapped by other rows. YB is bottom-most y-position in W. */
3189 redraw_overlapped_rows (struct window
*w
, int yb
)
3192 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3194 /* If rows overlapping others have been changed, the rows being
3195 overlapped have to be redrawn. This won't draw lines that have
3196 already been drawn in update_window_line because overlapped_p in
3197 desired rows is 0, so after row assignment overlapped_p in
3198 current rows is 0. */
3199 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3201 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3203 if (!row
->enabled_p
)
3205 else if (row
->mode_line_p
)
3208 if (row
->overlapped_p
)
3210 enum glyph_row_area area
;
3212 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3214 output_cursor_to (w
, i
, 0, row
->y
,
3215 area
== TEXT_AREA
? row
->x
: 0);
3216 if (row
->used
[area
])
3217 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3218 area
, row
->used
[area
]);
3219 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3222 row
->overlapped_p
= 0;
3225 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3231 /* Redraw lines from the current matrix of window W that overlap
3232 others. YB is bottom-most y-position in W. */
3235 redraw_overlapping_rows (struct window
*w
, int yb
)
3238 struct glyph_row
*row
;
3239 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3241 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3243 row
= w
->current_matrix
->rows
+ i
;
3245 if (!row
->enabled_p
)
3247 else if (row
->mode_line_p
)
3250 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3252 if (row
->overlapping_p
)
3256 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3257 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3258 overlaps
|= OVERLAPS_PRED
;
3259 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3260 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3261 overlaps
|= OVERLAPS_SUCC
;
3265 if (row
->used
[LEFT_MARGIN_AREA
])
3266 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3268 if (row
->used
[TEXT_AREA
])
3269 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3271 if (row
->used
[RIGHT_MARGIN_AREA
])
3272 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3274 /* Record in neighbor rows that ROW overwrites part of
3276 if (overlaps
& OVERLAPS_PRED
)
3277 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3278 if (overlaps
& OVERLAPS_SUCC
)
3279 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3288 #endif /* HAVE_WINDOW_SYSTEM */
3291 #if defined GLYPH_DEBUG && 0
3293 /* Check that no row in the current matrix of window W is enabled
3294 which is below what's displayed in the window. */
3297 check_current_matrix_flags (struct window
*w
)
3299 bool last_seen_p
= 0;
3300 int i
, yb
= window_text_bottom_y (w
);
3302 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3304 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3305 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3307 else if (last_seen_p
&& row
->enabled_p
)
3312 #endif /* GLYPH_DEBUG */
3315 /* Update display of window W.
3316 If FORCE_P, don't stop updating when input is pending. */
3319 update_window (struct window
*w
, bool force_p
)
3321 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3323 int preempt_count
= baud_rate
/ 2400 + 1;
3324 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3326 /* Check that W's frame doesn't have glyph matrices. */
3327 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3330 /* Check pending input the first time so that we can quickly return. */
3332 detect_input_pending_ignore_squeezables ();
3334 /* If forced to complete the update, or if no input is pending, do
3336 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3338 struct glyph_row
*row
, *end
;
3339 struct glyph_row
*mode_line_row
;
3340 struct glyph_row
*header_line_row
;
3342 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3345 rif
->update_window_begin_hook (w
);
3346 yb
= window_text_bottom_y (w
);
3347 row
= MATRIX_ROW (desired_matrix
, 0);
3348 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3350 /* Take note of the header line, if there is one. We will
3351 update it below, after updating all of the window's lines. */
3352 if (row
->mode_line_p
)
3354 header_line_row
= row
;
3358 header_line_row
= NULL
;
3360 /* Update the mode line, if necessary. */
3361 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3362 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3364 mode_line_row
->y
= yb
;
3365 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3367 &mouse_face_overwritten_p
);
3370 /* Find first enabled row. Optimizations in redisplay_internal
3371 may lead to an update with only one row enabled. There may
3372 be also completely empty matrices. */
3373 while (row
< end
&& !row
->enabled_p
)
3376 /* Try reusing part of the display by copying. */
3377 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3379 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3382 /* All rows were found to be equal. */
3388 /* We've scrolled the display. */
3394 /* Update the rest of the lines. */
3395 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3396 /* scrolling_window resets the enabled_p flag of the rows it
3397 reuses from current_matrix. */
3400 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3403 /* We'll have to play a little bit with when to
3404 detect_input_pending. If it's done too often,
3405 scrolling large windows with repeated scroll-up
3406 commands will too quickly pause redisplay. */
3407 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3408 detect_input_pending_ignore_squeezables ();
3409 changed_p
|= update_window_line (w
, vpos
,
3410 &mouse_face_overwritten_p
);
3412 /* Mark all rows below the last visible one in the current
3413 matrix as invalid. This is necessary because of
3414 variable line heights. Consider the case of three
3415 successive redisplays, where the first displays 5
3416 lines, the second 3 lines, and the third 5 lines again.
3417 If the second redisplay wouldn't mark rows in the
3418 current matrix invalid, the third redisplay might be
3419 tempted to optimize redisplay based on lines displayed
3420 in the first redisplay. */
3421 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3422 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3423 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3426 /* Was display preempted? */
3427 paused_p
= row
< end
;
3431 /* Update the header line after scrolling because a new header
3432 line would otherwise overwrite lines at the top of the window
3433 that can be scrolled. */
3434 if (header_line_row
&& header_line_row
->enabled_p
)
3436 header_line_row
->y
= 0;
3437 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3440 /* Fix the appearance of overlapping/overlapped rows. */
3441 if (!paused_p
&& !w
->pseudo_window_p
)
3443 #ifdef HAVE_WINDOW_SYSTEM
3444 if (changed_p
&& rif
->fix_overlapping_area
)
3446 redraw_overlapped_rows (w
, yb
);
3447 redraw_overlapping_rows (w
, yb
);
3451 /* Make cursor visible at cursor position of W. */
3452 set_window_cursor_after_update (w
);
3454 #if 0 /* Check that current matrix invariants are satisfied. This is
3455 for debugging only. See the comment of check_matrix_invariants. */
3456 IF_DEBUG (check_matrix_invariants (w
));
3461 /* Remember the redisplay method used to display the matrix. */
3462 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3465 #ifdef HAVE_WINDOW_SYSTEM
3466 update_window_fringes (w
, 0);
3469 /* End the update of window W. Don't set the cursor if we
3470 paused updating the display because in this case,
3471 set_window_cursor_after_update hasn't been called, and
3472 W->output_cursor doesn't contain the cursor location. */
3473 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3479 /* check_current_matrix_flags (w); */
3480 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3483 clear_glyph_matrix (desired_matrix
);
3489 /* Update the display of area AREA in window W, row number VPOS.
3490 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3493 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3494 enum glyph_row_area area
, int vpos
)
3496 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3497 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3499 /* Set cursor to start of glyphs, write them, and clear to the end
3500 of the area. I don't think that something more sophisticated is
3501 necessary here, since marginal areas will not be the default. */
3502 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3503 if (desired_row
->used
[area
])
3504 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3505 area
, desired_row
->used
[area
]);
3506 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3510 /* Update the display of the text area of row VPOS in window W.
3511 Value is true if display has changed. */
3514 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3516 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3517 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3518 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3521 /* If rows are at different X or Y, or rows have different height,
3522 or the current row is marked invalid, write the entire line. */
3523 if (!current_row
->enabled_p
3524 || desired_row
->y
!= current_row
->y
3525 || desired_row
->ascent
!= current_row
->ascent
3526 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3527 || desired_row
->phys_height
!= current_row
->phys_height
3528 || desired_row
->visible_height
!= current_row
->visible_height
3529 || current_row
->overlapped_p
3530 /* This next line is necessary for correctly redrawing
3531 mouse-face areas after scrolling and other operations.
3532 However, it causes excessive flickering when mouse is moved
3533 across the mode line. Luckily, turning it off for the mode
3534 line doesn't seem to hurt anything. -- cyd.
3535 But it is still needed for the header line. -- kfs. */
3536 || (current_row
->mouse_face_p
3537 && !(current_row
->mode_line_p
&& vpos
> 0))
3538 || current_row
->x
!= desired_row
->x
)
3540 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3542 if (desired_row
->used
[TEXT_AREA
])
3543 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3544 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3546 /* Clear to end of window. */
3547 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3550 /* This erases the cursor. We do this here because
3551 notice_overwritten_cursor cannot easily check this, which
3552 might indicate that the whole functionality of
3553 notice_overwritten_cursor would better be implemented here.
3554 On the other hand, we need notice_overwritten_cursor as long
3555 as mouse highlighting is done asynchronously outside of
3557 if (vpos
== w
->phys_cursor
.vpos
)
3558 w
->phys_cursor_on_p
= 0;
3563 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3564 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3565 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3566 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3567 bool abort_skipping
= 0;
3569 /* If the desired row extends its face to the text area end, and
3570 unless the current row also does so at the same position,
3571 make sure we write at least one glyph, so that the face
3572 extension actually takes place. */
3573 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3574 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3575 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3576 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3579 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3583 /* Loop over glyphs that current and desired row may have
3587 bool can_skip_p
= !abort_skipping
;
3589 /* Skip over glyphs that both rows have in common. These
3590 don't have to be written. We can't skip if the last
3591 current glyph overlaps the glyph to its right. For
3592 example, consider a current row of `if ' with the `f' in
3593 Courier bold so that it overlaps the ` ' to its right.
3594 If the desired row is ` ', we would skip over the space
3595 after the `if' and there would remain a pixel from the
3596 `f' on the screen. */
3597 if (overlapping_glyphs_p
&& i
> 0)
3599 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3602 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3604 can_skip_p
= (right
== 0 && !abort_skipping
);
3612 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3614 x
+= desired_glyph
->pixel_width
;
3615 ++desired_glyph
, ++current_glyph
, ++i
;
3618 /* Consider the case that the current row contains "xxx
3619 ppp ggg" in italic Courier font, and the desired row
3620 is "xxx ggg". The character `p' has lbearing, `g'
3621 has not. The loop above will stop in front of the
3622 first `p' in the current row. If we would start
3623 writing glyphs there, we wouldn't erase the lbearing
3624 of the `p'. The rest of the lbearing problem is then
3625 taken care of by draw_glyphs. */
3626 if (overlapping_glyphs_p
3628 && i
< current_row
->used
[TEXT_AREA
]
3629 && (current_row
->used
[TEXT_AREA
]
3630 != desired_row
->used
[TEXT_AREA
]))
3634 rif
->get_glyph_overhangs (current_glyph
,
3637 while (left
> 0 && i
> 0)
3639 --i
, --desired_glyph
, --current_glyph
;
3640 x
-= desired_glyph
->pixel_width
;
3641 left
-= desired_glyph
->pixel_width
;
3644 /* Abort the skipping algorithm if we end up before
3645 our starting point, to avoid looping (bug#1070).
3646 This can happen when the lbearing is larger than
3648 abort_skipping
= (i
< start_hpos
);
3652 /* Try to avoid writing the entire rest of the desired row
3653 by looking for a resync point. This mainly prevents
3654 mode line flickering in the case the mode line is in
3655 fixed-pitch font, which it usually will be. */
3656 if (i
< desired_row
->used
[TEXT_AREA
])
3658 int start_x
= x
, start_hpos
= i
;
3659 struct glyph
*start
= desired_glyph
;
3661 bool skip_first_p
= !can_skip_p
;
3663 /* Find the next glyph that's equal again. */
3666 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3669 x
+= desired_glyph
->pixel_width
;
3670 current_x
+= current_glyph
->pixel_width
;
3671 ++desired_glyph
, ++current_glyph
, ++i
;
3675 if (i
== start_hpos
|| x
!= current_x
)
3679 desired_glyph
= start
;
3683 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3684 rif
->write_glyphs (w
, updated_row
, start
,
3685 TEXT_AREA
, i
- start_hpos
);
3690 /* Write the rest. */
3691 if (i
< desired_row
->used
[TEXT_AREA
])
3693 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3694 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3695 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3699 /* Maybe clear to end of line. */
3700 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3702 /* If new row extends to the end of the text area, nothing
3703 has to be cleared, if and only if we did a write_glyphs
3704 above. This is made sure by setting desired_stop_pos
3705 appropriately above. */
3706 eassert (i
< desired_row
->used
[TEXT_AREA
]
3707 || ((desired_row
->used
[TEXT_AREA
]
3708 == current_row
->used
[TEXT_AREA
])
3709 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3711 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3713 /* If old row extends to the end of the text area, clear. */
3714 if (i
>= desired_row
->used
[TEXT_AREA
])
3715 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3716 desired_row
->pixel_width
);
3717 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3720 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3722 /* Otherwise clear to the end of the old row. Everything
3723 after that position should be clear already. */
3726 if (i
>= desired_row
->used
[TEXT_AREA
])
3727 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3728 desired_row
->pixel_width
);
3730 /* If cursor is displayed at the end of the line, make sure
3731 it's cleared. Nowadays we don't have a phys_cursor_glyph
3732 with which to erase the cursor (because this method
3733 doesn't work with lbearing/rbearing), so we must do it
3735 if (vpos
== w
->phys_cursor
.vpos
3736 && (desired_row
->reversed_p
3737 ? (w
->phys_cursor
.hpos
< 0)
3738 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3740 w
->phys_cursor_on_p
= 0;
3744 xlim
= current_row
->pixel_width
;
3745 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3754 /* Update row VPOS in window W. Value is true if display has been changed. */
3757 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3759 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3760 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3761 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3764 /* A row can be completely invisible in case a desired matrix was
3765 built with a vscroll and then make_cursor_line_fully_visible shifts
3766 the matrix. Make sure to make such rows current anyway, since
3767 we need the correct y-position, for example, in the current matrix. */
3768 if (desired_row
->mode_line_p
3769 || desired_row
->visible_height
> 0)
3771 eassert (desired_row
->enabled_p
);
3773 /* Update display of the left margin area, if there is one. */
3774 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3777 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3778 /* Setting this flag will ensure the vertical border, if
3779 any, between this window and the one on its left will be
3780 redrawn. This is necessary because updating the left
3781 margin area can potentially draw over the border. */
3782 current_row
->redraw_fringe_bitmaps_p
= 1;
3785 /* Update the display of the text area. */
3786 if (update_text_area (w
, desired_row
, vpos
))
3789 if (current_row
->mouse_face_p
)
3790 *mouse_face_overwritten_p
= 1;
3793 /* Update display of the right margin area, if there is one. */
3794 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3797 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3800 /* Draw truncation marks etc. */
3801 if (!current_row
->enabled_p
3802 || desired_row
->y
!= current_row
->y
3803 || desired_row
->visible_height
!= current_row
->visible_height
3804 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3805 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3806 || current_row
->redraw_fringe_bitmaps_p
3807 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3808 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3809 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3810 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3811 rif
->after_update_window_line_hook (w
, desired_row
);
3814 /* Update current_row from desired_row. */
3815 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3820 /* Set the cursor after an update of window W. This function may only
3821 be called from update_window. */
3824 set_window_cursor_after_update (struct window
*w
)
3826 struct frame
*f
= XFRAME (w
->frame
);
3827 int cx
, cy
, vpos
, hpos
;
3829 /* Not intended for frame matrix updates. */
3830 eassert (FRAME_WINDOW_P (f
));
3832 if (cursor_in_echo_area
3833 && !NILP (echo_area_buffer
[0])
3834 /* If we are showing a message instead of the mini-buffer,
3835 show the cursor for the message instead. */
3836 && XWINDOW (minibuf_window
) == w
3837 && EQ (minibuf_window
, echo_area_window
)
3838 /* These cases apply only to the frame that contains
3839 the active mini-buffer window. */
3840 && FRAME_HAS_MINIBUF_P (f
)
3841 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3843 cx
= cy
= vpos
= hpos
= 0;
3845 if (cursor_in_echo_area
>= 0)
3847 /* If the mini-buffer is several lines high, find the last
3848 line that has any text on it. Note: either all lines
3849 are enabled or none. Otherwise we wouldn't be able to
3851 struct glyph_row
*row
, *last_row
;
3852 struct glyph
*glyph
;
3853 int yb
= window_text_bottom_y (w
);
3856 row
= w
->current_matrix
->rows
;
3857 while (row
->enabled_p
3858 && (last_row
== NULL
3859 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3861 if (row
->used
[TEXT_AREA
]
3862 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3869 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3870 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3872 while (last
> start
&& last
->charpos
< 0)
3875 for (glyph
= start
; glyph
< last
; ++glyph
)
3877 cx
+= glyph
->pixel_width
;
3882 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3890 hpos
= w
->cursor
.hpos
;
3891 vpos
= w
->cursor
.vpos
;
3894 /* Window cursor can be out of sync for horizontally split windows.
3895 Horizontal position is -1 when cursor is on the left fringe. */
3896 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3897 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3898 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3902 /* If B is NULL, set WINDOW->must_be_updated_p to ON_P for all windows in
3903 the window tree rooted at W. Otherwise set WINDOW->must_be_updated_p
3904 to ON_P only for windows that displays B. */
3907 set_window_update_flags (struct window
*w
, struct buffer
*b
, bool on_p
)
3911 if (WINDOWP (w
->contents
))
3912 set_window_update_flags (XWINDOW (w
->contents
), b
, on_p
);
3913 else if (!(b
&& b
!= XBUFFER (w
->contents
)))
3914 w
->must_be_updated_p
= on_p
;
3916 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3922 /***********************************************************************
3923 Window-Based Scrolling
3924 ***********************************************************************/
3926 /* Structure describing rows in scrolling_window. */
3930 /* Number of occurrences of this row in desired and current matrix. */
3931 int old_uses
, new_uses
;
3933 /* Vpos of row in new matrix. */
3934 int new_line_number
;
3936 /* Bucket index of this row_entry in the hash table row_table. */
3939 /* The row described by this entry. */
3940 struct glyph_row
*row
;
3942 /* Hash collision chain. */
3943 struct row_entry
*next
;
3946 /* A pool to allocate row_entry structures from, and the size of the
3947 pool. The pool is reallocated in scrolling_window when we find
3948 that we need a larger one. */
3950 static struct row_entry
*row_entry_pool
;
3951 static ptrdiff_t row_entry_pool_size
;
3953 /* Index of next free entry in row_entry_pool. */
3955 static ptrdiff_t row_entry_idx
;
3957 /* The hash table used during scrolling, and the table's size. This
3958 table is used to quickly identify equal rows in the desired and
3961 static struct row_entry
**row_table
;
3962 static ptrdiff_t row_table_size
;
3964 /* Vectors of pointers to row_entry structures belonging to the
3965 current and desired matrix, and the size of the vectors. */
3967 static struct row_entry
**old_lines
, **new_lines
;
3968 static ptrdiff_t old_lines_size
, new_lines_size
;
3970 /* A pool to allocate run structures from, and its size. */
3972 static struct run
*run_pool
;
3973 static ptrdiff_t runs_size
;
3975 /* A vector of runs of lines found during scrolling. */
3977 static struct run
**runs
;
3979 /* Add glyph row ROW to the scrolling hash table. */
3981 static struct row_entry
*
3982 add_row_entry (struct glyph_row
*row
)
3984 struct row_entry
*entry
;
3985 ptrdiff_t i
= row
->hash
% row_table_size
;
3987 entry
= row_table
[i
];
3988 eassert (entry
|| verify_row_hash (row
));
3989 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
3990 entry
= entry
->next
;
3994 entry
= row_entry_pool
+ row_entry_idx
++;
3996 entry
->old_uses
= entry
->new_uses
= 0;
3997 entry
->new_line_number
= 0;
3999 entry
->next
= row_table
[i
];
4000 row_table
[i
] = entry
;
4007 /* Try to reuse part of the current display of W by scrolling lines.
4008 HEADER_LINE_P means W has a header line.
4010 The algorithm is taken from Communications of the ACM, Apr78 "A
4011 Technique for Isolating Differences Between Files." It should take
4014 A short outline of the steps of the algorithm
4016 1. Skip lines equal at the start and end of both matrices.
4018 2. Enter rows in the current and desired matrix into a symbol
4019 table, counting how often they appear in both matrices.
4021 3. Rows that appear exactly once in both matrices serve as anchors,
4022 i.e. we assume that such lines are likely to have been moved.
4024 4. Starting from anchor lines, extend regions to be scrolled both
4025 forward and backward.
4029 -1 if all rows were found to be equal.
4030 0 to indicate that we did not scroll the display, or
4031 1 if we did scroll. */
4034 scrolling_window (struct window
*w
, bool header_line_p
)
4036 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4037 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4038 int yb
= window_text_bottom_y (w
);
4040 int j
, first_old
, first_new
, last_old
, last_new
;
4043 struct row_entry
*entry
;
4044 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4046 /* Skip over rows equal at the start. */
4047 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4049 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4050 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4054 && !d
->redraw_fringe_bitmaps_p
4056 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4057 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4058 && row_equal_p (c
, d
, 1))
4067 /* Give up if some rows in the desired matrix are not enabled. */
4068 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4071 first_old
= first_new
= i
;
4073 /* Set last_new to the index + 1 of the row that reaches the
4074 bottom boundary in the desired matrix. Give up if we find a
4075 disabled row before we reach the bottom boundary. */
4077 while (i
< desired_matrix
->nrows
- 1)
4081 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4083 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4092 /* Set last_old to the index + 1 of the row that reaches the bottom
4093 boundary in the current matrix. We don't look at the enabled
4094 flag here because we plan to reuse part of the display even if
4095 other parts are disabled. */
4097 while (i
< current_matrix
->nrows
- 1)
4099 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4108 /* Skip over rows equal at the bottom. */
4111 while (i
- 1 > first_new
4112 && j
- 1 > first_old
4113 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4114 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4115 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4116 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4117 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4118 MATRIX_ROW (current_matrix
, j
- 1), 1))
4123 /* Nothing to do if all rows are equal. */
4124 if (last_new
== first_new
)
4127 /* Check for integer overflow in size calculation.
4129 If next_almost_prime checks (N) for divisibility by 2..10, then
4130 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4131 So, set next_almost_prime_increment_max to 10.
4133 It's just a coincidence that next_almost_prime_increment_max ==
4134 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4135 13, then next_almost_prime_increment_max would be 14, e.g.,
4136 because next_almost_prime (113) would be 127. */
4138 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4139 enum { next_almost_prime_increment_max
= 10 };
4140 ptrdiff_t row_table_max
=
4141 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4142 - next_almost_prime_increment_max
);
4143 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4144 if (current_nrows_max
< current_matrix
->nrows
)
4145 memory_full (SIZE_MAX
);
4148 /* Reallocate vectors, tables etc. if necessary. */
4150 if (current_matrix
->nrows
> old_lines_size
)
4151 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4152 current_matrix
->nrows
- old_lines_size
,
4153 INT_MAX
, sizeof *old_lines
);
4155 if (desired_matrix
->nrows
> new_lines_size
)
4156 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4157 desired_matrix
->nrows
- new_lines_size
,
4158 INT_MAX
, sizeof *new_lines
);
4160 n
= desired_matrix
->nrows
;
4161 n
+= current_matrix
->nrows
;
4162 if (row_table_size
< 3 * n
)
4164 ptrdiff_t size
= next_almost_prime (3 * n
);
4165 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4166 row_table_size
= size
;
4167 memset (row_table
, 0, size
* sizeof *row_table
);
4170 if (n
> row_entry_pool_size
)
4171 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4172 n
- row_entry_pool_size
,
4173 -1, sizeof *row_entry_pool
);
4175 if (desired_matrix
->nrows
> runs_size
)
4177 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4178 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4179 runs_size
= desired_matrix
->nrows
;
4182 nruns
= run_idx
= 0;
4185 /* Add rows from the current and desired matrix to the hash table
4186 row_hash_table to be able to find equal ones quickly. */
4188 for (i
= first_old
; i
< last_old
; ++i
)
4190 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4192 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4193 old_lines
[i
] = entry
;
4197 old_lines
[i
] = NULL
;
4200 for (i
= first_new
; i
< last_new
; ++i
)
4202 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4203 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4205 entry
->new_line_number
= i
;
4206 new_lines
[i
] = entry
;
4209 /* Identify moves based on lines that are unique and equal
4210 in both matrices. */
4211 for (i
= first_old
; i
< last_old
;)
4213 && old_lines
[i
]->old_uses
== 1
4214 && old_lines
[i
]->new_uses
== 1)
4217 int new_line
= old_lines
[i
]->new_line_number
;
4218 struct run
*run
= run_pool
+ run_idx
++;
4221 run
->current_vpos
= i
;
4222 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4223 run
->desired_vpos
= new_line
;
4224 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4226 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4228 /* Extend backward. */
4231 while (p
> first_old
4233 && old_lines
[p
] == new_lines
[q
])
4235 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4236 --run
->current_vpos
;
4237 --run
->desired_vpos
;
4240 run
->desired_y
-= h
;
4241 run
->current_y
-= h
;
4245 /* Extend forward. */
4250 && old_lines
[p
] == new_lines
[q
])
4252 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4258 /* Insert run into list of all runs. Order runs by copied
4259 pixel lines. Note that we record runs that don't have to
4260 be copied because they are already in place. This is done
4261 because we can avoid calling update_window_line in this
4263 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4265 for (q
= nruns
; q
> p
; --q
)
4266 runs
[q
] = runs
[q
- 1];
4275 /* Do the moves. Do it in a way that we don't overwrite something
4276 we want to copy later on. This is not solvable in general
4277 because there is only one display and we don't have a way to
4278 exchange areas on this display. Example:
4280 +-----------+ +-----------+
4282 +-----------+ --> +-----------+
4284 +-----------+ +-----------+
4286 Instead, prefer bigger moves, and invalidate moves that would
4287 copy from where we copied to. */
4289 for (i
= 0; i
< nruns
; ++i
)
4290 if (runs
[i
]->nrows
> 0)
4292 struct run
*r
= runs
[i
];
4294 /* Copy on the display. */
4295 if (r
->current_y
!= r
->desired_y
)
4297 rif
->clear_window_mouse_face (w
);
4298 rif
->scroll_run_hook (w
, r
);
4301 /* Truncate runs that copy to where we copied to, and
4302 invalidate runs that copy from where we copied to. */
4303 for (j
= nruns
- 1; j
> i
; --j
)
4305 struct run
*p
= runs
[j
];
4306 bool truncated_p
= 0;
4309 && p
->desired_y
< r
->desired_y
+ r
->height
4310 && p
->desired_y
+ p
->height
> r
->desired_y
)
4312 if (p
->desired_y
< r
->desired_y
)
4314 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4315 p
->height
= r
->desired_y
- p
->desired_y
;
4320 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4323 if (p
->nrows
<= nrows_copied
)
4327 int height_copied
= (r
->desired_y
+ r
->height
4330 p
->current_vpos
+= nrows_copied
;
4331 p
->desired_vpos
+= nrows_copied
;
4332 p
->nrows
-= nrows_copied
;
4333 p
->current_y
+= height_copied
;
4334 p
->desired_y
+= height_copied
;
4335 p
->height
-= height_copied
;
4341 if (r
->current_y
!= r
->desired_y
4342 /* The condition below is equivalent to
4343 ((p->current_y >= r->desired_y
4344 && p->current_y < r->desired_y + r->height)
4345 || (p->current_y + p->height > r->desired_y
4346 && (p->current_y + p->height
4347 <= r->desired_y + r->height)))
4348 because we have 0 < p->height <= r->height. */
4349 && p
->current_y
< r
->desired_y
+ r
->height
4350 && p
->current_y
+ p
->height
> r
->desired_y
)
4353 /* Reorder runs by copied pixel lines if truncated. */
4354 if (truncated_p
&& p
->nrows
> 0)
4358 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4360 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4365 /* Assign matrix rows. */
4366 for (j
= 0; j
< r
->nrows
; ++j
)
4368 struct glyph_row
*from
, *to
;
4369 bool to_overlapped_p
;
4371 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4372 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4373 to_overlapped_p
= to
->overlapped_p
;
4374 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4375 assign_row (to
, from
);
4376 /* The above `assign_row' actually does swap, so if we had
4377 an overlap in the copy destination of two runs, then
4378 the second run would assign a previously disabled bogus
4379 row. But thanks to the truncation code in the
4380 preceding for-loop, we no longer have such an overlap,
4381 and thus the assigned row should always be enabled. */
4382 eassert (to
->enabled_p
);
4383 from
->enabled_p
= 0;
4384 to
->overlapped_p
= to_overlapped_p
;
4388 /* Clear the hash table, for the next time. */
4389 for (i
= 0; i
< row_entry_idx
; ++i
)
4390 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4392 /* Value is 1 to indicate that we scrolled the display. */
4398 /************************************************************************
4400 ************************************************************************/
4402 /* Update the desired frame matrix of frame F.
4404 FORCE_P means that the update should not be stopped by pending input.
4405 INHIBIT_HAIRY_ID_P means that scrolling should not be tried.
4407 Value is true if update was stopped due to pending input. */
4410 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
)
4412 /* Frame matrices to work on. */
4413 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4414 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4417 int preempt_count
= baud_rate
/ 2400 + 1;
4419 eassert (current_matrix
&& desired_matrix
);
4421 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4422 calculate_costs (f
);
4424 if (preempt_count
<= 0)
4427 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4433 /* If we cannot insert/delete lines, it's no use trying it. */
4434 if (!FRAME_LINE_INS_DEL_OK (f
))
4437 /* See if any of the desired lines are enabled; don't compute for
4438 i/d line if just want cursor motion. */
4439 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4440 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4443 /* Try doing i/d line, if not yet inhibited. */
4444 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4445 force_p
|= scrolling (f
);
4447 /* Update the individual lines as needed. Do bottom line first. */
4448 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4449 update_frame_line (f
, desired_matrix
->nrows
- 1);
4451 /* Now update the rest of the lines. */
4452 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4454 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4456 if (FRAME_TERMCAP_P (f
))
4458 /* Flush out every so many lines.
4459 Also flush out if likely to have more than 1k buffered
4460 otherwise. I'm told that some telnet connections get
4461 really screwed by more than 1k output at once. */
4462 FILE *display_output
= FRAME_TTY (f
)->output
;
4465 ptrdiff_t outq
= __fpending (display_output
);
4467 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4468 fflush (display_output
);
4472 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4473 detect_input_pending_ignore_squeezables ();
4475 update_frame_line (f
, i
);
4479 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4481 /* Now just clean up termcap drivers and set cursor, etc. */
4484 if ((cursor_in_echo_area
4485 /* If we are showing a message instead of the mini-buffer,
4486 show the cursor for the message instead of for the
4487 (now hidden) mini-buffer contents. */
4488 || (EQ (minibuf_window
, selected_window
)
4489 && EQ (minibuf_window
, echo_area_window
)
4490 && !NILP (echo_area_buffer
[0])))
4491 /* These cases apply only to the frame that contains
4492 the active mini-buffer window. */
4493 && FRAME_HAS_MINIBUF_P (f
)
4494 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4496 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4499 if (cursor_in_echo_area
< 0)
4501 /* Negative value of cursor_in_echo_area means put
4502 cursor at beginning of line. */
4508 /* Positive value of cursor_in_echo_area means put
4509 cursor at the end of the prompt. If the mini-buffer
4510 is several lines high, find the last line that has
4512 row
= FRAME_LINES (f
);
4518 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4520 /* Frame rows are filled up with spaces that
4521 must be ignored here. */
4522 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4524 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4525 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4528 && (last
- 1)->charpos
< 0)
4534 while (row
> top
&& col
== 0);
4536 /* Make sure COL is not out of range. */
4537 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4539 /* If we have another row, advance cursor into it. */
4540 if (row
< FRAME_LINES (f
) - 1)
4542 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4545 /* Otherwise move it back in range. */
4547 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4551 cursor_to (f
, row
, col
);
4555 /* We have only one cursor on terminal frames. Use it to
4556 display the cursor of the selected window. */
4557 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4558 if (w
->cursor
.vpos
>= 0
4559 /* The cursor vpos may be temporarily out of bounds
4560 in the following situation: There is one window,
4561 with the cursor in the lower half of it. The window
4562 is split, and a message causes a redisplay before
4563 a new cursor position has been computed. */
4564 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4566 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4567 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4569 x
+= max (0, w
->left_margin_cols
);
4570 cursor_to (f
, y
, x
);
4577 clear_desired_matrices (f
);
4582 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4585 scrolling (struct frame
*frame
)
4587 int unchanged_at_top
, unchanged_at_bottom
;
4590 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4591 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4592 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4593 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4595 int free_at_end_vpos
= FRAME_LINES (frame
);
4596 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4597 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4599 if (!current_matrix
)
4602 /* Compute hash codes of all the lines. Also calculate number of
4603 changed lines, number of unchanged lines at the beginning, and
4604 number of unchanged lines at the end. */
4606 unchanged_at_top
= 0;
4607 unchanged_at_bottom
= FRAME_LINES (frame
);
4608 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4610 /* Give up on this scrolling if some old lines are not enabled. */
4611 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4613 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4614 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4616 /* This line cannot be redrawn, so don't let scrolling mess it. */
4617 new_hash
[i
] = old_hash
[i
];
4618 #define INFINITY 1000000 /* Taken from scroll.c */
4619 draw_cost
[i
] = INFINITY
;
4623 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4624 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4627 if (old_hash
[i
] != new_hash
[i
])
4630 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4632 else if (i
== unchanged_at_top
)
4634 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4637 /* If changed lines are few, don't allow preemption, don't scroll. */
4638 if ((!FRAME_SCROLL_REGION_OK (frame
)
4639 && changed_lines
< baud_rate
/ 2400)
4640 || unchanged_at_bottom
== FRAME_LINES (frame
))
4643 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4644 - unchanged_at_bottom
);
4646 if (FRAME_SCROLL_REGION_OK (frame
))
4647 free_at_end_vpos
-= unchanged_at_bottom
;
4648 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4649 free_at_end_vpos
= -1;
4651 /* If large window, fast terminal and few lines in common between
4652 current frame and desired frame, don't bother with i/d calc. */
4653 if (!FRAME_SCROLL_REGION_OK (frame
)
4654 && window_size
>= 18 && baud_rate
> 2400
4656 10 * scrolling_max_lines_saved (unchanged_at_top
,
4657 FRAME_LINES (frame
) - unchanged_at_bottom
,
4658 old_hash
, new_hash
, draw_cost
)))
4661 if (window_size
< 2)
4664 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4665 draw_cost
+ unchanged_at_top
- 1,
4666 old_draw_cost
+ unchanged_at_top
- 1,
4667 old_hash
+ unchanged_at_top
- 1,
4668 new_hash
+ unchanged_at_top
- 1,
4669 free_at_end_vpos
- unchanged_at_top
);
4675 /* Count the number of blanks at the start of the vector of glyphs R
4676 which is LEN glyphs long. */
4679 count_blanks (struct glyph
*r
, int len
)
4683 for (i
= 0; i
< len
; ++i
)
4684 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4691 /* Count the number of glyphs in common at the start of the glyph
4692 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4693 of STR2. Value is the number of equal glyphs equal at the start. */
4696 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4698 struct glyph
*p1
= str1
;
4699 struct glyph
*p2
= str2
;
4703 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4710 /* Char insertion/deletion cost vector, from term.c */
4712 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4715 /* Perform a frame-based update on line VPOS in frame FRAME. */
4718 update_frame_line (struct frame
*f
, int vpos
)
4720 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4722 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4723 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4724 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4725 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4726 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4727 bool must_write_whole_line_p
;
4728 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4729 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4730 != FACE_TTY_DEFAULT_BG_COLOR
);
4732 if (colored_spaces_p
)
4735 /* Current row not enabled means it has unknown contents. We must
4736 write the whole desired line in that case. */
4737 must_write_whole_line_p
= !current_row
->enabled_p
;
4738 if (must_write_whole_line_p
)
4745 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4746 olen
= current_row
->used
[TEXT_AREA
];
4748 /* Ignore trailing spaces, if we can. */
4749 if (!write_spaces_p
)
4750 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4754 current_row
->enabled_p
= 1;
4755 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4757 /* If desired line is empty, just clear the line. */
4758 if (!desired_row
->enabled_p
)
4764 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4765 nlen
= desired_row
->used
[TEXT_AREA
];
4766 nend
= nbody
+ nlen
;
4768 /* If display line has unknown contents, write the whole line. */
4769 if (must_write_whole_line_p
)
4771 /* Ignore spaces at the end, if we can. */
4772 if (!write_spaces_p
)
4773 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4776 /* Write the contents of the desired line. */
4779 cursor_to (f
, vpos
, 0);
4780 write_glyphs (f
, nbody
, nlen
);
4783 /* Don't call clear_end_of_line if we already wrote the whole
4784 line. The cursor will not be at the right margin in that
4785 case but in the line below. */
4786 if (nlen
< FRAME_TOTAL_COLS (f
))
4788 cursor_to (f
, vpos
, nlen
);
4789 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4792 /* Make sure we are in the right row, otherwise cursor movement
4793 with cmgoto might use `ch' in the wrong row. */
4794 cursor_to (f
, vpos
, 0);
4796 make_current (desired_matrix
, current_matrix
, vpos
);
4800 /* Pretend trailing spaces are not there at all,
4801 unless for one reason or another we must write all spaces. */
4802 if (!write_spaces_p
)
4803 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4806 /* If there's no i/d char, quickly do the best we can without it. */
4807 if (!FRAME_CHAR_INS_DEL_OK (f
))
4811 /* Find the first glyph in desired row that doesn't agree with
4812 a glyph in the current row, and write the rest from there on. */
4813 for (i
= 0; i
< nlen
; i
++)
4815 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4817 /* Find the end of the run of different glyphs. */
4821 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4822 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4825 /* Output this run of non-matching chars. */
4826 cursor_to (f
, vpos
, i
);
4827 write_glyphs (f
, nbody
+ i
, j
- i
);
4830 /* Now find the next non-match. */
4834 /* Clear the rest of the line, or the non-clear part of it. */
4837 cursor_to (f
, vpos
, nlen
);
4838 clear_end_of_line (f
, olen
);
4841 /* Make current row = desired row. */
4842 make_current (desired_matrix
, current_matrix
, vpos
);
4846 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4847 characters in a row. */
4851 /* If current line is blank, skip over initial spaces, if
4852 possible, and write the rest. */
4856 nsp
= count_blanks (nbody
, nlen
);
4860 cursor_to (f
, vpos
, nsp
);
4861 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4864 /* Exchange contents between current_frame and new_frame. */
4865 make_current (desired_matrix
, current_matrix
, vpos
);
4869 /* Compute number of leading blanks in old and new contents. */
4870 osp
= count_blanks (obody
, olen
);
4871 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4873 /* Compute number of matching chars starting with first non-blank. */
4874 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4875 nbody
+ nsp
, nbody
+ nlen
);
4877 /* Spaces in new match implicit space past the end of old. */
4878 /* A bug causing this to be a no-op was fixed in 18.29. */
4879 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4882 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4886 /* Avoid doing insert/delete char
4887 just cause number of leading spaces differs
4888 when the following text does not match. */
4889 if (begmatch
== 0 && osp
!= nsp
)
4890 osp
= nsp
= min (osp
, nsp
);
4892 /* Find matching characters at end of line */
4895 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4897 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4902 endmatch
= obody
+ olen
- op1
;
4904 /* tem gets the distance to insert or delete.
4905 endmatch is how many characters we save by doing so.
4908 tem
= (nlen
- nsp
) - (olen
- osp
);
4910 && (!FRAME_CHAR_INS_DEL_OK (f
)
4911 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4914 /* nsp - osp is the distance to insert or delete.
4915 If that is nonzero, begmatch is known to be nonzero also.
4916 begmatch + endmatch is how much we save by doing the ins/del.
4920 && (!FRAME_CHAR_INS_DEL_OK (f
)
4921 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
4925 osp
= nsp
= min (osp
, nsp
);
4928 /* Now go through the line, inserting, writing and
4929 deleting as appropriate. */
4933 cursor_to (f
, vpos
, nsp
);
4934 delete_glyphs (f
, osp
- nsp
);
4938 /* If going to delete chars later in line
4939 and insert earlier in the line,
4940 must delete first to avoid losing data in the insert */
4941 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
4943 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
4944 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
4945 olen
= nlen
- (nsp
- osp
);
4947 cursor_to (f
, vpos
, osp
);
4948 insert_glyphs (f
, 0, nsp
- osp
);
4952 tem
= nsp
+ begmatch
+ endmatch
;
4953 if (nlen
!= tem
|| olen
!= tem
)
4955 if (!endmatch
|| nlen
== olen
)
4957 /* If new text being written reaches right margin, there is
4958 no need to do clear-to-eol at the end of this function
4959 (and it would not be safe, since cursor is not going to
4960 be "at the margin" after the text is done). */
4961 if (nlen
== FRAME_TOTAL_COLS (f
))
4964 /* Function write_glyphs is prepared to do nothing
4965 if passed a length <= 0. Check it here to avoid
4966 unnecessary cursor movement. */
4969 cursor_to (f
, vpos
, nsp
+ begmatch
);
4970 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
4973 else if (nlen
> olen
)
4975 /* Here, we used to have the following simple code:
4976 ----------------------------------------
4977 write_glyphs (nbody + nsp + begmatch, olen - tem);
4978 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
4979 ----------------------------------------
4980 but it doesn't work if nbody[nsp + begmatch + olen - tem]
4981 is a padding glyph. */
4982 int out
= olen
- tem
; /* Columns to be overwritten originally. */
4985 cursor_to (f
, vpos
, nsp
+ begmatch
);
4987 /* Calculate columns we can actually overwrite. */
4988 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
4990 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
4992 /* If we left columns to be overwritten, we must delete them. */
4993 del
= olen
- tem
- out
;
4995 delete_glyphs (f
, del
);
4997 /* At last, we insert columns not yet written out. */
4998 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5001 else if (olen
> nlen
)
5003 cursor_to (f
, vpos
, nsp
+ begmatch
);
5004 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5005 delete_glyphs (f
, olen
- nlen
);
5011 /* If any unerased characters remain after the new line, erase them. */
5014 cursor_to (f
, vpos
, nlen
);
5015 clear_end_of_line (f
, olen
);
5018 /* Exchange contents between current_frame and new_frame. */
5019 make_current (desired_matrix
, current_matrix
, vpos
);
5024 /***********************************************************************
5025 X/Y Position -> Buffer Position
5026 ***********************************************************************/
5028 /* Determine what's under window-relative pixel position (*X, *Y).
5029 Return the OBJECT (string or buffer) that's there.
5030 Return in *POS the position in that object.
5031 Adjust *X and *Y to character positions.
5032 Return in *DX and *DY the pixel coordinates of the click,
5033 relative to the top left corner of OBJECT, or relative to
5034 the top left corner of the character glyph at (*X, *Y)
5036 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5037 if the coordinates point to an empty area of the display. */
5040 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
)
5043 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5044 struct text_pos startp
;
5046 struct glyph_row
*row
;
5047 #ifdef HAVE_WINDOW_SYSTEM
5048 struct image
*img
= 0;
5051 void *itdata
= NULL
;
5053 /* We used to set current_buffer directly here, but that does the
5054 wrong thing with `face-remapping-alist' (bug#2044). */
5055 Fset_buffer (w
->contents
);
5056 itdata
= bidi_shelve_cache ();
5057 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5058 start_display (&it
, w
, startp
);
5059 /* start_display takes into account the header-line row, but IT's
5060 vpos still counts from the glyph row that includes the window's
5061 start position. Adjust for a possible header-line row. */
5062 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
);
5066 /* First, move to the beginning of the row corresponding to *Y. We
5067 need to be in that row to get the correct value of base paragraph
5068 direction for the text at (*X, *Y). */
5069 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5071 /* TO_X is the pixel position that the iterator will compute for the
5072 glyph at *X. We add it.first_visible_x because iterator
5073 positions include the hscroll. */
5074 to_x
= x0
+ it
.first_visible_x
;
5075 if (it
.bidi_it
.paragraph_dir
== R2L
)
5076 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5077 text area. This is because the iterator, even in R2L
5078 paragraphs, delivers glyphs as if they started at the left
5079 margin of the window. (When we actually produce glyphs for
5080 display, we reverse their order in PRODUCE_GLYPHS, but the
5081 iterator doesn't know about that.) The following line adjusts
5082 the pixel position to the iterator geometry, which is what
5083 move_it_* routines use. (The -1 is because in a window whose
5084 text-area width is W, the rightmost pixel position is W-1, and
5085 it should be mirrored into zero pixel position.) */
5086 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5088 /* Now move horizontally in the row to the glyph under *X. Second
5089 argument is ZV to prevent move_it_in_display_line from matching
5090 based on buffer positions. */
5091 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5092 bidi_unshelve_cache (itdata
, 0);
5094 Fset_buffer (old_current_buffer
);
5096 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5097 *dy
= *y
- it
.current_y
;
5099 string
= w
->contents
;
5100 if (STRINGP (it
.string
))
5103 if (it
.what
== IT_COMPOSITION
5104 && it
.cmp_it
.nchars
> 1
5105 && it
.cmp_it
.reversed_p
)
5107 /* The current display element is a grapheme cluster in a
5108 composition. In that case, we need the position of the first
5109 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5110 it.current points to the last character of the cluster, thus
5111 we must move back to the first character of the same
5113 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5114 if (STRINGP (it
.string
))
5115 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5117 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5118 CHARPOS (pos
->pos
));
5121 #ifdef HAVE_WINDOW_SYSTEM
5122 if (it
.what
== IT_IMAGE
)
5124 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5125 && !NILP (img
->spec
))
5126 *object
= img
->spec
;
5130 if (it
.vpos
< w
->current_matrix
->nrows
5131 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5134 if (it
.hpos
< row
->used
[TEXT_AREA
])
5136 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5137 #ifdef HAVE_WINDOW_SYSTEM
5140 *dy
-= row
->ascent
- glyph
->ascent
;
5141 *dx
+= glyph
->slice
.img
.x
;
5142 *dy
+= glyph
->slice
.img
.y
;
5143 /* Image slices positions are still relative to the entire image */
5144 *width
= img
->width
;
5145 *height
= img
->height
;
5150 *width
= glyph
->pixel_width
;
5151 *height
= glyph
->ascent
+ glyph
->descent
;
5157 *height
= row
->height
;
5162 *width
= *height
= 0;
5165 /* Add extra (default width) columns if clicked after EOL. */
5166 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5168 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5177 /* Value is the string under window-relative coordinates X/Y in the
5178 mode line or header line (PART says which) of window W, or nil if none.
5179 *CHARPOS is set to the position in the string returned. */
5182 mode_line_string (struct window
*w
, enum window_part part
,
5183 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5184 int *dx
, int *dy
, int *width
, int *height
)
5186 struct glyph_row
*row
;
5187 struct glyph
*glyph
, *end
;
5189 Lisp_Object string
= Qnil
;
5191 if (part
== ON_MODE_LINE
)
5192 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5194 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5196 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5198 if (row
->mode_line_p
&& row
->enabled_p
)
5200 /* Find the glyph under X. If we find one with a string object,
5201 it's the one we were looking for. */
5202 glyph
= row
->glyphs
[TEXT_AREA
];
5203 end
= glyph
+ row
->used
[TEXT_AREA
];
5204 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5205 x0
-= glyph
->pixel_width
;
5206 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5209 string
= glyph
->object
;
5210 *charpos
= glyph
->charpos
;
5211 *width
= glyph
->pixel_width
;
5212 *height
= glyph
->ascent
+ glyph
->descent
;
5213 #ifdef HAVE_WINDOW_SYSTEM
5214 if (glyph
->type
== IMAGE_GLYPH
)
5217 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5219 *object
= img
->spec
;
5220 y0
-= row
->ascent
- glyph
->ascent
;
5226 /* Add extra (default width) columns if clicked after EOL. */
5227 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5229 *height
= row
->height
;
5236 *width
= *height
= 0;
5246 /* Value is the string under window-relative coordinates X/Y in either
5247 marginal area, or nil if none. *CHARPOS is set to the position in
5248 the string returned. */
5251 marginal_area_string (struct window
*w
, enum window_part part
,
5252 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5253 int *dx
, int *dy
, int *width
, int *height
)
5255 struct glyph_row
*row
= w
->current_matrix
->rows
;
5256 struct glyph
*glyph
, *end
;
5257 int x0
, y0
, i
, wy
= *y
;
5259 Lisp_Object string
= Qnil
;
5261 if (part
== ON_LEFT_MARGIN
)
5262 area
= LEFT_MARGIN_AREA
;
5263 else if (part
== ON_RIGHT_MARGIN
)
5264 area
= RIGHT_MARGIN_AREA
;
5268 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5269 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5272 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5276 /* Find the glyph under X. If we find one with a string object,
5277 it's the one we were looking for. */
5278 if (area
== RIGHT_MARGIN_AREA
)
5279 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5280 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5281 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5282 + window_box_width (w
, LEFT_MARGIN_AREA
)
5283 + window_box_width (w
, TEXT_AREA
));
5285 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5286 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5289 glyph
= row
->glyphs
[area
];
5290 end
= glyph
+ row
->used
[area
];
5291 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5292 x0
-= glyph
->pixel_width
;
5293 *x
= glyph
- row
->glyphs
[area
];
5296 string
= glyph
->object
;
5297 *charpos
= glyph
->charpos
;
5298 *width
= glyph
->pixel_width
;
5299 *height
= glyph
->ascent
+ glyph
->descent
;
5300 #ifdef HAVE_WINDOW_SYSTEM
5301 if (glyph
->type
== IMAGE_GLYPH
)
5304 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5306 *object
= img
->spec
;
5307 y0
-= row
->ascent
- glyph
->ascent
;
5308 x0
+= glyph
->slice
.img
.x
;
5309 y0
+= glyph
->slice
.img
.y
;
5315 /* Add extra (default width) columns if clicked after EOL. */
5316 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5318 *height
= row
->height
;
5325 *width
= *height
= 0;
5335 /***********************************************************************
5336 Changing Frame Sizes
5337 ***********************************************************************/
5341 static void deliver_window_change_signal (int);
5344 handle_window_change_signal (int sig
)
5347 struct tty_display_info
*tty
;
5349 /* The frame size change obviously applies to a single
5350 termcap-controlled terminal, but we can't decide which.
5351 Therefore, we resize the frames corresponding to each tty.
5353 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5355 if (! tty
->term_initted
)
5358 /* Suspended tty frames have tty->input == NULL avoid trying to
5363 get_tty_size (fileno (tty
->input
), &width
, &height
);
5365 if (width
> 5 && height
> 2) {
5366 Lisp_Object tail
, frame
;
5368 FOR_EACH_FRAME (tail
, frame
)
5369 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5370 /* Record the new sizes, but don't reallocate the data
5371 structures now. Let that be done later outside of the
5373 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5379 deliver_window_change_signal (int sig
)
5381 deliver_process_signal (sig
, handle_window_change_signal
);
5383 #endif /* SIGWINCH */
5386 /* Do any change in frame size that was requested by a signal.
5387 SAFE means this function is called from a place where it is
5388 safe to change frame sizes while a redisplay is in progress. */
5391 do_pending_window_change (bool safe
)
5393 /* If window change signal handler should have run before, run it now. */
5394 if (redisplaying_p
&& !safe
)
5397 while (delayed_size_change
)
5399 Lisp_Object tail
, frame
;
5401 delayed_size_change
= 0;
5403 FOR_EACH_FRAME (tail
, frame
)
5405 struct frame
*f
= XFRAME (frame
);
5407 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5408 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5415 /* Change the frame height and/or width. Values may be given as zero to
5416 indicate no change is to take place.
5418 If DELAY, assume we're being called from a signal handler, and
5419 queue the change for later - perhaps the next redisplay.
5420 Since this tries to resize windows, we can't call it
5421 from a signal handler.
5423 SAFE means this function is called from a place where it's
5424 safe to change frame sizes while a redisplay is in progress. */
5427 change_frame_size (struct frame
*f
, int newheight
, int newwidth
,
5428 bool pretend
, bool delay
, bool safe
)
5430 Lisp_Object tail
, frame
;
5432 if (FRAME_MSDOS_P (f
))
5434 /* On MS-DOS, all frames use the same screen, so a change in
5435 size affects all frames. Termcap now supports multiple
5437 FOR_EACH_FRAME (tail
, frame
)
5438 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5439 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5440 pretend
, delay
, safe
);
5443 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5447 change_frame_size_1 (struct frame
*f
, int newheight
, int newwidth
,
5448 bool pretend
, bool delay
, bool safe
)
5450 int new_frame_total_cols
;
5451 ptrdiff_t count
= SPECPDL_INDEX ();
5453 /* If we can't deal with the change now, queue it for later. */
5454 if (delay
|| (redisplaying_p
&& !safe
))
5456 f
->new_text_lines
= newheight
;
5457 f
->new_text_cols
= newwidth
;
5458 delayed_size_change
= 1;
5462 /* This size-change overrides any pending one for this frame. */
5463 f
->new_text_lines
= 0;
5464 f
->new_text_cols
= 0;
5466 /* If an argument is zero, set it to the current value. */
5468 newheight
= FRAME_LINES (f
);
5470 newwidth
= FRAME_COLS (f
);
5472 /* Compute width of windows in F. */
5473 /* Round up to the smallest acceptable size. */
5474 check_frame_size (f
, &newheight
, &newwidth
);
5476 /* This is the width of the frame with vertical scroll bars and fringe
5477 columns. Do this after rounding - see discussion of bug#9723. */
5478 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5480 /* If we're not changing the frame size, quit now. */
5481 /* Frame width may be unchanged but the text portion may change, for
5482 example, fullscreen and remove/add scroll bar. */
5483 if (newheight
== FRAME_LINES (f
)
5484 /* Text portion unchanged? */
5485 && newwidth
== FRAME_COLS (f
)
5486 /* Frame width unchanged? */
5487 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5493 /* We only can set screen dimensions to certain values supported
5494 by our video hardware. Try to find the smallest size greater
5495 or equal to the requested dimensions. */
5496 dos_set_window_size (&newheight
, &newwidth
);
5499 if (newheight
!= FRAME_LINES (f
))
5501 resize_frame_windows (f
, newheight
, 0);
5503 /* MSDOS frames cannot PRETEND, as they change frame size by
5504 manipulating video hardware. */
5505 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5506 FrameRows (FRAME_TTY (f
)) = newheight
;
5509 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5511 resize_frame_windows (f
, new_frame_total_cols
, 1);
5513 /* MSDOS frames cannot PRETEND, as they change frame size by
5514 manipulating video hardware. */
5515 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5516 FrameCols (FRAME_TTY (f
)) = newwidth
;
5518 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5519 if (WINDOWP (f
->tool_bar_window
))
5520 XWINDOW (f
->tool_bar_window
)->total_cols
= newwidth
;
5524 FRAME_LINES (f
) = newheight
;
5525 SET_FRAME_COLS (f
, newwidth
);
5528 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5529 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5531 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5533 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5534 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5535 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5536 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5539 adjust_frame_glyphs (f
);
5540 calculate_costs (f
);
5541 SET_FRAME_GARBAGED (f
);
5546 record_unwind_current_buffer ();
5548 run_window_configuration_change_hook (f
);
5550 unbind_to (count
, Qnil
);
5555 /***********************************************************************
5556 Terminal Related Lisp Functions
5557 ***********************************************************************/
5559 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5560 1, 1, "FOpen termscript file: ",
5561 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5562 FILE = nil means just close any termscript file currently open. */)
5565 struct tty_display_info
*tty
;
5567 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5568 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5569 error ("Current frame is not on a tty device");
5573 if (tty
->termscript
!= 0)
5576 fclose (tty
->termscript
);
5577 tty
->termscript
= 0;
5583 file
= Fexpand_file_name (file
, Qnil
);
5584 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5585 if (tty
->termscript
== 0)
5586 report_file_error ("Opening termscript", file
);
5592 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5593 Ssend_string_to_terminal
, 1, 2, 0,
5594 doc
: /* Send STRING to the terminal without alteration.
5595 Control characters in STRING will have terminal-dependent effects.
5597 Optional parameter TERMINAL specifies the tty terminal device to use.
5598 It may be a terminal object, a frame, or nil for the terminal used by
5599 the currently selected frame. In batch mode, STRING is sent to stdout
5600 when TERMINAL is nil. */)
5601 (Lisp_Object string
, Lisp_Object terminal
)
5603 struct terminal
*t
= get_terminal (terminal
, 1);
5606 /* ??? Perhaps we should do something special for multibyte strings here. */
5607 CHECK_STRING (string
);
5611 error ("Unknown terminal device");
5613 if (t
->type
== output_initial
)
5615 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5616 error ("Device %d is not a termcap terminal device", t
->id
);
5619 struct tty_display_info
*tty
= t
->display_info
.tty
;
5622 error ("Terminal is currently suspended");
5624 if (tty
->termscript
)
5626 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5627 fflush (tty
->termscript
);
5631 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5638 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5639 doc
: /* Beep, or flash the screen.
5640 Also, unless an argument is given,
5641 terminate any keyboard macro currently executing. */)
5649 ring_bell (XFRAME (selected_frame
));
5658 bitch_at_user (void)
5662 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5665 = "Keyboard macro terminated by a command ringing the bell";
5666 Fsignal (Quser_error
, list1 (build_string (msg
)));
5669 ring_bell (XFRAME (selected_frame
));
5674 /***********************************************************************
5676 ***********************************************************************/
5678 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5679 doc
: /* Pause, without updating display, for SECONDS seconds.
5680 SECONDS may be a floating-point value, meaning that you can wait for a
5681 fraction of a second. Optional second arg MILLISECONDS specifies an
5682 additional wait period, in milliseconds; this is for backwards compatibility.
5683 \(Not all operating systems support waiting for a fraction of a second.) */)
5684 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5686 double duration
= extract_float (seconds
);
5688 if (!NILP (milliseconds
))
5690 CHECK_NUMBER (milliseconds
);
5691 duration
+= XINT (milliseconds
) / 1000.0;
5696 struct timespec t
= dtotimespec (duration
);
5697 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5698 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5705 /* This is just like wait_reading_process_output, except that
5708 TIMEOUT is number of seconds to wait (float or integer),
5709 or t to wait forever.
5710 READING is true if reading input.
5711 If DISPLAY_OPTION is >0 display process output while waiting.
5712 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5716 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5720 bool do_display
= display_option
> 0;
5722 swallow_events (do_display
);
5724 if ((detect_input_pending_run_timers (do_display
))
5725 || !NILP (Vexecuting_kbd_macro
))
5728 if (display_option
> 1)
5729 redisplay_preserve_echo_area (2);
5731 if (INTEGERP (timeout
))
5733 sec
= XINT (timeout
);
5738 else if (FLOATP (timeout
))
5740 double seconds
= XFLOAT_DATA (timeout
);
5741 if (! (0 < seconds
))
5745 struct timespec t
= dtotimespec (seconds
);
5746 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5750 else if (EQ (timeout
, Qt
))
5756 wrong_type_argument (Qnumberp
, timeout
);
5763 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5766 return detect_input_pending () ? Qnil
: Qt
;
5770 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5771 doc
: /* Perform redisplay.
5772 Optional arg FORCE, if non-nil, prevents redisplay from being
5773 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5774 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5775 preempted by arriving input, so FORCE does nothing.
5777 Return t if redisplay was performed, nil if redisplay was preempted
5778 immediately by pending input. */)
5784 if ((detect_input_pending_run_timers (1)
5785 && NILP (force
) && !redisplay_dont_pause
)
5786 || !NILP (Vexecuting_kbd_macro
))
5789 count
= SPECPDL_INDEX ();
5790 if (!NILP (force
) && !redisplay_dont_pause
)
5791 specbind (Qredisplay_dont_pause
, Qt
);
5792 redisplay_preserve_echo_area (2);
5793 unbind_to (count
, Qnil
);
5799 /***********************************************************************
5800 Other Lisp Functions
5801 ***********************************************************************/
5803 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5804 session's frames, frame names, buffers, buffer-read-only flags, and
5805 buffer-modified-flags. */
5807 static Lisp_Object frame_and_buffer_state
;
5810 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5811 Sframe_or_buffer_changed_p
, 0, 1, 0,
5812 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5813 VARIABLE is a variable name whose value is either nil or a state vector
5814 that will be updated to contain all frames and buffers,
5815 aside from buffers whose names start with space,
5816 along with the buffers' read-only and modified flags. This allows a fast
5817 check to see whether buffer menus might need to be recomputed.
5818 If this function returns non-nil, it updates the internal vector to reflect
5821 If VARIABLE is nil, an internal variable is used. Users should not
5822 pass nil for VARIABLE. */)
5823 (Lisp_Object variable
)
5825 Lisp_Object state
, tail
, frame
, buf
;
5828 if (! NILP (variable
))
5830 CHECK_SYMBOL (variable
);
5831 state
= Fsymbol_value (variable
);
5832 if (! VECTORP (state
))
5836 state
= frame_and_buffer_state
;
5839 FOR_EACH_FRAME (tail
, frame
)
5841 if (idx
== ASIZE (state
))
5843 if (!EQ (AREF (state
, idx
++), frame
))
5845 if (idx
== ASIZE (state
))
5847 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5850 /* Check that the buffer info matches. */
5851 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5853 /* Ignore buffers that aren't included in buffer lists. */
5854 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5856 if (idx
== ASIZE (state
))
5858 if (!EQ (AREF (state
, idx
++), buf
))
5860 if (idx
== ASIZE (state
))
5862 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5864 if (idx
== ASIZE (state
))
5866 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5869 if (idx
== ASIZE (state
))
5871 /* Detect deletion of a buffer at the end of the list. */
5872 if (EQ (AREF (state
, idx
), Qlambda
))
5875 /* Come here if we decide the data has changed. */
5877 /* Count the size we will need.
5878 Start with 1 so there is room for at least one lambda at the end. */
5880 FOR_EACH_FRAME (tail
, frame
)
5882 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5884 /* Reallocate the vector if data has grown to need it,
5885 or if it has shrunk a lot. */
5886 if (! VECTORP (state
)
5887 || n
> ASIZE (state
)
5888 || n
+ 20 < ASIZE (state
) / 2)
5889 /* Add 20 extra so we grow it less often. */
5891 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5892 if (! NILP (variable
))
5893 Fset (variable
, state
);
5895 frame_and_buffer_state
= state
;
5898 /* Record the new data in the (possibly reallocated) vector. */
5900 FOR_EACH_FRAME (tail
, frame
)
5902 ASET (state
, idx
, frame
);
5904 ASET (state
, idx
, XFRAME (frame
)->name
);
5907 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5909 /* Ignore buffers that aren't included in buffer lists. */
5910 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5912 ASET (state
, idx
, buf
);
5914 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
5916 ASET (state
, idx
, Fbuffer_modified_p (buf
));
5919 /* Fill up the vector with lambdas (always at least one). */
5920 ASET (state
, idx
, Qlambda
);
5922 while (idx
< ASIZE (state
))
5924 ASET (state
, idx
, Qlambda
);
5927 /* Make sure we didn't overflow the vector. */
5928 eassert (idx
<= ASIZE (state
));
5934 /***********************************************************************
5936 ***********************************************************************/
5938 /* Initialization done when Emacs fork is started, before doing stty.
5939 Determine terminal type and set terminal_driver. Then invoke its
5940 decoding routine to set up variables in the terminal package. */
5945 char *terminal_type
;
5947 /* Construct the space glyph. */
5948 space_glyph
.type
= CHAR_GLYPH
;
5949 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
5950 space_glyph
.charpos
= -1;
5953 cursor_in_echo_area
= 0;
5955 /* Now is the time to initialize this; it's used by init_sys_modes
5957 Vinitial_window_system
= Qnil
;
5959 /* SIGWINCH needs to be handled no matter what display we start
5960 with. Otherwise newly opened tty frames will not resize
5965 #endif /* CANNOT_DUMP */
5967 struct sigaction action
;
5968 emacs_sigaction_init (&action
, deliver_window_change_signal
);
5969 sigaction (SIGWINCH
, &action
, 0);
5971 #endif /* SIGWINCH */
5973 /* If running as a daemon, no need to initialize any frames/terminal. */
5977 /* If the user wants to use a window system, we shouldn't bother
5978 initializing the terminal. This is especially important when the
5979 terminal is so dumb that emacs gives up before and doesn't bother
5980 using the window system.
5982 If the DISPLAY environment variable is set and nonempty,
5983 try to use X, and die with an error message if that doesn't work. */
5985 #ifdef HAVE_X_WINDOWS
5986 if (! inhibit_window_system
&& ! display_arg
)
5989 display
= getenv ("DISPLAY");
5990 display_arg
= (display
!= 0 && *display
!= 0);
5992 if (display_arg
&& !x_display_ok (display
))
5994 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
5996 inhibit_window_system
= 1;
6000 if (!inhibit_window_system
&& display_arg
)
6002 Vinitial_window_system
= Qx
;
6004 Vwindow_system_version
= make_number (11);
6007 /* In some versions of ncurses,
6008 tputs crashes if we have not called tgetent.
6010 { char b
[2044]; tgetent (b
, "xterm");}
6014 #endif /* HAVE_X_WINDOWS */
6017 if (!inhibit_window_system
)
6019 Vinitial_window_system
= Qw32
;
6020 Vwindow_system_version
= make_number (1);
6023 #endif /* HAVE_NTGUI */
6026 if (!inhibit_window_system
6032 Vinitial_window_system
= Qns
;
6033 Vwindow_system_version
= make_number (10);
6038 /* If no window system has been specified, try to use the terminal. */
6040 fatal ("standard input is not a tty");
6043 terminal_type
= "w32console";
6045 terminal_type
= getenv ("TERM");
6049 #ifdef HAVE_WINDOW_SYSTEM
6050 if (! inhibit_window_system
)
6051 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6053 #endif /* HAVE_WINDOW_SYSTEM */
6054 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6060 struct frame
*f
= XFRAME (selected_frame
);
6062 init_foreground_group ();
6064 /* Open a display on the controlling tty. */
6065 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6067 /* Convert the initial frame to use the new display. */
6068 if (f
->output_method
!= output_initial
)
6070 f
->output_method
= t
->type
;
6073 t
->reference_count
++;
6075 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6077 if (f
->output_method
== output_termcap
)
6078 create_tty_output (f
);
6080 t
->display_info
.tty
->top_frame
= selected_frame
;
6081 change_frame_size (XFRAME (selected_frame
),
6082 FrameRows (t
->display_info
.tty
),
6083 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6085 /* Delete the initial terminal. */
6086 if (--initial_terminal
->reference_count
== 0
6087 && initial_terminal
->delete_terminal_hook
)
6088 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6090 /* Update frame parameters to reflect the new type. */
6091 Fmodify_frame_parameters
6092 (selected_frame
, list1 (Fcons (Qtty_type
,
6093 Ftty_type (selected_frame
))));
6094 if (t
->display_info
.tty
->name
)
6095 Fmodify_frame_parameters
6097 list1 (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
))));
6099 Fmodify_frame_parameters (selected_frame
, list1 (Fcons (Qtty
, Qnil
)));
6103 struct frame
*sf
= SELECTED_FRAME ();
6104 int width
= FRAME_TOTAL_COLS (sf
);
6105 int height
= FRAME_LINES (sf
);
6107 /* If these sizes are so big they cause overflow, just ignore the
6108 change. It's not clear what better we could do. The rest of
6109 the code assumes that (width + 2) * height * sizeof (struct glyph)
6110 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6111 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6112 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6113 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6114 < (width
+ 2) * height
))
6115 fatal ("screen size %dx%d too big", width
, height
);
6118 calculate_costs (XFRAME (selected_frame
));
6120 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6123 && NILP (Vinitial_window_system
))
6125 /* For the initial frame, we don't have any way of knowing what
6126 are the foreground and background colors of the terminal. */
6127 struct frame
*sf
= SELECTED_FRAME ();
6129 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6130 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6131 call0 (intern ("tty-set-up-initial-frame-faces"));
6137 /***********************************************************************
6139 ***********************************************************************/
6141 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6142 Sinternal_show_cursor
, 2, 2, 0,
6143 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6144 WINDOW nil means use the selected window. SHOW non-nil means
6145 show a cursor in WINDOW in the next redisplay. SHOW nil means
6146 don't show a cursor. */)
6147 (Lisp_Object window
, Lisp_Object show
)
6149 /* Don't change cursor state while redisplaying. This could confuse
6151 if (!redisplaying_p
)
6152 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6157 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6158 Sinternal_show_cursor_p
, 0, 1, 0,
6159 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6160 WINDOW nil or omitted means report on the selected window. */)
6161 (Lisp_Object window
)
6163 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6166 /***********************************************************************
6168 ***********************************************************************/
6171 syms_of_display (void)
6173 defsubr (&Sredraw_frame
);
6174 defsubr (&Sredraw_display
);
6175 defsubr (&Sframe_or_buffer_changed_p
);
6176 defsubr (&Sopen_termscript
);
6178 defsubr (&Sredisplay
);
6179 defsubr (&Ssleep_for
);
6180 defsubr (&Ssend_string_to_terminal
);
6181 defsubr (&Sinternal_show_cursor
);
6182 defsubr (&Sinternal_show_cursor_p
);
6185 defsubr (&Sdump_redisplay_history
);
6188 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6189 staticpro (&frame_and_buffer_state
);
6191 DEFSYM (Qdisplay_table
, "display-table");
6192 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6194 DEFVAR_INT ("baud-rate", baud_rate
,
6195 doc
: /* The output baud rate of the terminal.
6196 On most systems, changing this value will affect the amount of padding
6197 and the other strategic decisions made during redisplay. */);
6199 DEFVAR_BOOL ("inverse-video", inverse_video
,
6200 doc
: /* Non-nil means invert the entire frame display.
6201 This means everything is in inverse video which otherwise would not be. */);
6203 DEFVAR_BOOL ("visible-bell", visible_bell
,
6204 doc
: /* Non-nil means try to flash the frame to represent a bell.
6206 See also `ring-bell-function'. */);
6208 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6209 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6210 A non-nil value is useful if the terminal can automatically preserve
6211 Emacs's frame display when you reenter Emacs.
6212 It is up to you to set this variable if your terminal can do that. */);
6214 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6215 doc
: /* Name of the window system that Emacs uses for the first frame.
6216 The value is a symbol:
6217 nil for a termcap frame (a character-only terminal),
6218 'x' for an Emacs frame that is really an X window,
6219 'w32' for an Emacs frame that is a window on MS-Windows display,
6220 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6221 'pc' for a direct-write MS-DOS frame.
6223 Use of this variable as a boolean is deprecated. Instead,
6224 use `display-graphic-p' or any of the other `display-*-p'
6225 predicates which report frame's specific UI-related capabilities. */);
6227 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6228 doc
: /* Name of window system through which the selected frame is displayed.
6229 The value is a symbol:
6230 nil for a termcap frame (a character-only terminal),
6231 'x' for an Emacs frame that is really an X window,
6232 'w32' for an Emacs frame that is a window on MS-Windows display,
6233 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6234 'pc' for a direct-write MS-DOS frame.
6236 Use of this variable as a boolean is deprecated. Instead,
6237 use `display-graphic-p' or any of the other `display-*-p'
6238 predicates which report frame's specific UI-related capabilities. */);
6240 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6241 doc
: /* The version number of the window system in use.
6242 For X windows, this is 11. */);
6244 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6245 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6247 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6248 doc
: /* Table defining how to output a glyph code to the frame.
6249 If not nil, this is a vector indexed by glyph code to define the glyph.
6250 Each element can be:
6251 integer: a glyph code which this glyph is an alias for.
6252 string: output this glyph using that string (not impl. in X windows).
6253 nil: this glyph mod 524288 is the code of a character to output,
6254 and this glyph / 524288 is the face number (see `face-id') to use
6255 while outputting it. */);
6256 Vglyph_table
= Qnil
;
6258 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6259 doc
: /* Display table to use for buffers that specify none.
6260 See `buffer-display-table' for more information. */);
6261 Vstandard_display_table
= Qnil
;
6263 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6264 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6265 redisplay_dont_pause
= 1;
6271 Vinitial_window_system
= Qnil
;
6272 Vwindow_system_version
= Qnil
;