1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 /* cm.h must come after dispextern.h on Windows. */
29 #include "dispextern.h"
31 #include "character.h"
35 #include "termhooks.h"
40 #include "intervals.h"
41 #include "blockinput.h"
44 #include "syssignal.h"
47 #ifdef HAVE_WINDOW_SYSTEM
49 #endif /* HAVE_WINDOW_SYSTEM */
60 /* Structure to pass dimensions around. Used for character bounding
61 boxes, glyph matrix dimensions and alike. */
70 /* Function prototypes. */
72 static void update_frame_line (struct frame
*, int);
73 static int required_matrix_height (struct window
*);
74 static int required_matrix_width (struct window
*);
75 static void change_frame_size_1 (struct frame
*, int, int, bool, bool, bool, bool);
76 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
77 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
79 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
81 static void adjust_decode_mode_spec_buffer (struct frame
*);
82 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
83 static void clear_window_matrices (struct window
*, bool);
84 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
85 static int scrolling_window (struct window
*, bool);
86 static bool update_window_line (struct window
*, int, bool *);
87 static void mirror_make_current (struct window
*, int);
89 static void check_matrix_pointers (struct glyph_matrix
*,
90 struct glyph_matrix
*);
92 static void mirror_line_dance (struct window
*, int, int, int *, char *);
93 static bool update_window_tree (struct window
*, bool);
94 static bool update_window (struct window
*, bool);
95 static bool update_frame_1 (struct frame
*, bool, bool, bool);
96 static bool scrolling (struct frame
*);
97 static void set_window_cursor_after_update (struct window
*);
98 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
99 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
100 static void set_window_update_flags (struct window
*w
, bool on_p
);
102 /* True means last display completed. False means it was preempted. */
104 bool display_completed
;
106 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
108 /* True means SIGWINCH happened when not safe. */
110 static bool delayed_size_change
;
112 /* A glyph for a space. */
114 struct glyph space_glyph
;
116 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
118 /* Counts of allocated structures. These counts serve to diagnose
119 memory leaks and double frees. */
121 static int glyph_matrix_count
;
122 static int glyph_pool_count
;
124 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
126 /* If non-null, the frame whose frame matrices are manipulated. If
127 null, window matrices are worked on. */
129 static struct frame
*frame_matrix_frame
;
131 /* Convert vpos and hpos from frame to window and vice versa.
132 This may only be used for terminal frames. */
136 static int window_to_frame_vpos (struct window
*, int);
137 static int window_to_frame_hpos (struct window
*, int);
138 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
139 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
141 /* One element of the ring buffer containing redisplay history
144 struct redisplay_history
146 char trace
[512 + 100];
149 /* The size of the history buffer. */
151 #define REDISPLAY_HISTORY_SIZE 30
153 /* The redisplay history buffer. */
155 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
157 /* Next free entry in redisplay_history. */
159 static int history_idx
;
161 /* A tick that's incremented each time something is added to the
164 static uprintmax_t history_tick
;
166 /* Add to the redisplay history how window W has been displayed.
167 MSG is a trace containing the information how W's glyph matrix
168 has been constructed. PAUSED_P means that the update
169 has been interrupted for pending input. */
172 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
177 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
179 buf
= redisplay_history
[history_idx
].trace
;
182 snprintf (buf
, sizeof redisplay_history
[0].trace
,
183 "%"pMu
": window %p (`%s')%s\n%s",
186 ((BUFFERP (w
->contents
)
187 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
188 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
190 paused_p
? " ***paused***" : "",
195 /* Add to the redisplay history that frame F has been displayed.
196 PAUSED_P means that the update has been interrupted for
200 add_frame_display_history (struct frame
*f
, bool paused_p
)
205 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
207 buf
= redisplay_history
[history_idx
].trace
;
210 sprintf (buf
, "%"pMu
": update frame %p%s",
212 ptr
, paused_p
? " ***paused***" : "");
216 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
217 Sdump_redisplay_history
, 0, 0, "",
218 doc
: /* Dump redisplay history to stderr. */)
223 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
226 i
= REDISPLAY_HISTORY_SIZE
- 1;
227 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
234 #else /* not GLYPH_DEBUG */
236 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
237 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
239 #endif /* GLYPH_DEBUG */
242 #if (defined PROFILING \
243 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
244 && !HAVE___EXECUTABLE_START)
245 /* This function comes first in the Emacs executable and is used only
246 to estimate the text start for profiling. */
248 __executable_start (void)
254 /***********************************************************************
256 ***********************************************************************/
258 /* Allocate and return a glyph_matrix structure. POOL is the glyph
259 pool from which memory for the matrix should be allocated, or null
260 for window-based redisplay where no glyph pools are used. The
261 member `pool' of the glyph matrix structure returned is set to
262 POOL, the structure is otherwise zeroed. */
264 static struct glyph_matrix
*
265 new_glyph_matrix (struct glyph_pool
*pool
)
267 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
269 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
270 /* Increment number of allocated matrices. This count is used
271 to detect memory leaks. */
272 ++glyph_matrix_count
;
275 /* Set pool and return. */
281 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
283 If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global counter
284 glyph_matrix_count is decremented when a matrix is freed. If the count
285 gets negative, more structures were freed than allocated, i.e. one matrix
286 was freed more than once or a bogus pointer was passed to this function.
288 If MATRIX->pool is null, this means that the matrix manages its own
289 glyph memory---this is done for matrices on X frames. Freeing the
290 matrix also frees the glyph memory in this case. */
293 free_glyph_matrix (struct glyph_matrix
*matrix
)
299 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
300 /* Detect the case that more matrices are freed than were
302 --glyph_matrix_count
;
303 eassert (glyph_matrix_count
>= 0);
306 /* Free glyph memory if MATRIX owns it. */
307 if (matrix
->pool
== NULL
)
308 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
309 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
311 /* Free row structures and the matrix itself. */
312 xfree (matrix
->rows
);
318 /* Return the number of glyphs to reserve for a marginal area of
319 window W. TOTAL_GLYPHS is the number of glyphs in a complete
320 display line of window W. MARGIN gives the width of the marginal
321 area in canonical character units. */
324 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, int margin
)
328 int width
= w
->total_cols
;
329 double d
= max (0, margin
);
330 d
= min (width
/ 2 - 1, d
);
331 return (int) ((double) total_glyphs
/ width
* d
);
336 /* Return true if ROW's hash value is correct.
337 Optimized away if ENABLE_CHECKING is not defined. */
340 verify_row_hash (struct glyph_row
*row
)
342 return row
->hash
== row_hash (row
);
345 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
348 W is null if the function is called for a frame glyph matrix.
349 Otherwise it is the window MATRIX is a member of. X and Y are the
350 indices of the first column and row of MATRIX within the frame
351 matrix, if such a matrix exists. They are zero for purely
352 window-based redisplay. DIM is the needed size of the matrix.
354 In window-based redisplay, where no frame matrices exist, glyph
355 matrices manage their own glyph storage. Otherwise, they allocate
356 storage from a common frame glyph pool which can be found in
359 The reason for this memory management strategy is to avoid complete
360 frame redraws if possible. When we allocate from a common pool, a
361 change of the location or size of a sub-matrix within the pool
362 requires a complete redisplay of the frame because we cannot easily
363 make sure that the current matrices of all windows still agree with
364 what is displayed on the screen. While this is usually fast, it
365 leads to screen flickering. */
368 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
372 bool marginal_areas_changed_p
= 0;
373 bool header_line_changed_p
= 0;
374 bool header_line_p
= 0;
375 int left
= -1, right
= -1;
376 int window_width
= -1, window_height
= -1;
378 /* See if W had a header line that has disappeared now, or vice versa.
382 window_box (w
, ANY_AREA
, 0, 0, &window_width
, &window_height
);
384 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
385 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
387 matrix
->header_line_p
= header_line_p
;
389 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
390 Do nothing if MATRIX' size, position, vscroll, and marginal areas
391 haven't changed. This optimization is important because preserving
392 the matrix means preventing redisplay. */
393 if (matrix
->pool
== NULL
)
395 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
396 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
397 eassert (left
>= 0 && right
>= 0);
398 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
399 || right
!= matrix
->right_margin_glyphs
);
401 if (!marginal_areas_changed_p
402 && !XFRAME (w
->frame
)->fonts_changed
403 && !header_line_changed_p
404 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
405 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
406 && matrix
->window_height
== window_height
407 && matrix
->window_vscroll
== w
->vscroll
408 && matrix
->window_width
== window_width
)
412 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
413 if (matrix
->rows_allocated
< dim
.height
)
415 int old_alloc
= matrix
->rows_allocated
;
416 new_rows
= dim
.height
- matrix
->rows_allocated
;
417 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
418 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
419 memset (matrix
->rows
+ old_alloc
, 0,
420 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
425 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
426 on a frame not using window-based redisplay. Set up pointers for
427 each row into the glyph pool. */
430 eassert (matrix
->pool
->glyphs
);
434 left
= margin_glyphs_to_reserve (w
, dim
.width
,
435 w
->left_margin_cols
);
436 right
= margin_glyphs_to_reserve (w
, dim
.width
,
437 w
->right_margin_cols
);
442 for (i
= 0; i
< dim
.height
; ++i
)
444 struct glyph_row
*row
= &matrix
->rows
[i
];
446 row
->glyphs
[LEFT_MARGIN_AREA
]
447 = (matrix
->pool
->glyphs
448 + (y
+ i
) * matrix
->pool
->ncolumns
452 || (row
== matrix
->rows
+ dim
.height
- 1
453 && WINDOW_WANTS_MODELINE_P (w
))
454 || (row
== matrix
->rows
&& matrix
->header_line_p
))
456 row
->glyphs
[TEXT_AREA
]
457 = row
->glyphs
[LEFT_MARGIN_AREA
];
458 row
->glyphs
[RIGHT_MARGIN_AREA
]
459 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
460 row
->glyphs
[LAST_AREA
]
461 = row
->glyphs
[RIGHT_MARGIN_AREA
];
465 row
->glyphs
[TEXT_AREA
]
466 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
467 row
->glyphs
[RIGHT_MARGIN_AREA
]
468 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
469 row
->glyphs
[LAST_AREA
]
470 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
474 matrix
->left_margin_glyphs
= left
;
475 matrix
->right_margin_glyphs
= right
;
479 /* If MATRIX->pool is null, MATRIX is responsible for managing
480 its own memory. It is a window matrix for window-based redisplay.
481 Allocate glyph memory from the heap. */
482 if (dim
.width
> matrix
->matrix_w
484 || header_line_changed_p
485 || marginal_areas_changed_p
)
487 struct glyph_row
*row
= matrix
->rows
;
488 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
492 row
->glyphs
[LEFT_MARGIN_AREA
]
493 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
494 dim
.width
, sizeof (struct glyph
));
496 /* The mode line, if displayed, never has marginal areas. */
497 if ((row
== matrix
->rows
+ dim
.height
- 1
498 && !(w
&& WINDOW_WANTS_MODELINE_P (w
)))
499 || (row
== matrix
->rows
&& matrix
->header_line_p
))
501 row
->glyphs
[TEXT_AREA
]
502 = row
->glyphs
[LEFT_MARGIN_AREA
];
503 row
->glyphs
[RIGHT_MARGIN_AREA
]
504 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
505 row
->glyphs
[LAST_AREA
]
506 = row
->glyphs
[RIGHT_MARGIN_AREA
];
510 row
->glyphs
[TEXT_AREA
]
511 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
512 row
->glyphs
[RIGHT_MARGIN_AREA
]
513 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
514 row
->glyphs
[LAST_AREA
]
515 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
521 eassert (left
>= 0 && right
>= 0);
522 matrix
->left_margin_glyphs
= left
;
523 matrix
->right_margin_glyphs
= right
;
526 /* Number of rows to be used by MATRIX. */
527 matrix
->nrows
= dim
.height
;
528 eassert (matrix
->nrows
>= 0);
532 if (matrix
== w
->current_matrix
)
534 /* Mark rows in a current matrix of a window as not having
535 valid contents. It's important to not do this for
536 desired matrices. When Emacs starts, it may already be
537 building desired matrices when this function runs. */
538 if (window_width
< 0)
539 window_width
= window_box_width (w
, -1);
541 /* Optimize the case that only the height has changed (C-x 2,
542 upper window). Invalidate all rows that are no longer part
544 if (!marginal_areas_changed_p
545 && !header_line_changed_p
547 && dim
.width
== matrix
->matrix_w
548 && matrix
->window_pixel_left
== WINDOW_LEFT_PIXEL_EDGE (w
)
549 && matrix
->window_pixel_top
== WINDOW_TOP_PIXEL_EDGE (w
)
550 && matrix
->window_width
== window_width
)
552 /* Find the last row in the window. */
553 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
554 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
560 /* Window end is invalid, if inside of the rows that
561 are invalidated below. */
562 if (w
->window_end_vpos
>= i
)
563 w
->window_end_valid
= 0;
565 while (i
< matrix
->nrows
)
566 matrix
->rows
[i
++].enabled_p
= false;
570 for (i
= 0; i
< matrix
->nrows
; ++i
)
571 matrix
->rows
[i
].enabled_p
= false;
574 else if (matrix
== w
->desired_matrix
)
576 /* Rows in desired matrices always have to be cleared;
577 redisplay expects this is the case when it runs, so it
578 had better be the case when we adjust matrices between
580 for (i
= 0; i
< matrix
->nrows
; ++i
)
581 matrix
->rows
[i
].enabled_p
= false;
586 /* Remember last values to be able to optimize frame redraws. */
587 matrix
->matrix_x
= x
;
588 matrix
->matrix_y
= y
;
589 matrix
->matrix_w
= dim
.width
;
590 matrix
->matrix_h
= dim
.height
;
592 /* Record the top y location and height of W at the time the matrix
593 was last adjusted. This is used to optimize redisplay above. */
596 matrix
->window_pixel_left
= WINDOW_LEFT_PIXEL_EDGE (w
);
597 matrix
->window_pixel_top
= WINDOW_TOP_PIXEL_EDGE (w
);
598 matrix
->window_height
= window_height
;
599 matrix
->window_width
= window_width
;
600 matrix
->window_vscroll
= w
->vscroll
;
605 /* Reverse the contents of rows in MATRIX between START and END. The
606 contents of the row at END - 1 end up at START, END - 2 at START +
607 1 etc. This is part of the implementation of rotate_matrix (see
611 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
615 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
617 /* Non-ISO HP/UX compiler doesn't like auto struct
619 struct glyph_row temp
;
620 temp
= matrix
->rows
[i
];
621 matrix
->rows
[i
] = matrix
->rows
[j
];
622 matrix
->rows
[j
] = temp
;
627 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
628 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
629 indices. (Note: this does not copy glyphs, only glyph pointers in
630 row structures are moved around).
632 The algorithm used for rotating the vector was, I believe, first
633 described by Kernighan. See the vector R as consisting of two
634 sub-vectors AB, where A has length BY for BY >= 0. The result
635 after rotating is then BA. Reverse both sub-vectors to get ArBr
636 and reverse the result to get (ArBr)r which is BA. Similar for
640 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
644 /* Up (rotate left, i.e. towards lower indices). */
646 reverse_rows (matrix
, first
, first
+ by
);
647 reverse_rows (matrix
, first
+ by
, last
);
648 reverse_rows (matrix
, first
, last
);
652 /* Down (rotate right, i.e. towards higher indices). */
653 reverse_rows (matrix
, last
- by
, last
);
654 reverse_rows (matrix
, first
, last
- by
);
655 reverse_rows (matrix
, first
, last
);
660 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
661 with indices START <= index < END. Increment positions by DELTA/
665 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
666 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
668 /* Check that START and END are reasonable values. */
669 eassert (start
>= 0 && start
<= matrix
->nrows
);
670 eassert (end
>= 0 && end
<= matrix
->nrows
);
671 eassert (start
<= end
);
673 for (; start
< end
; ++start
)
674 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
678 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
679 START and END are the row indices of the first and last + 1 row to clear. */
682 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
684 eassert (start
<= end
);
685 eassert (start
>= 0 && start
< matrix
->nrows
);
686 eassert (end
>= 0 && end
<= matrix
->nrows
);
688 for (; start
< end
; ++start
)
689 matrix
->rows
[start
].enabled_p
= false;
695 Empty all rows in MATRIX by clearing their enabled_p flags.
696 The function prepare_desired_row will eventually really clear a row
697 when it sees one with a false enabled_p flag.
699 Reset update hints to default values. The only update hint
700 currently present is the flag MATRIX->no_scrolling_p. */
703 clear_glyph_matrix (struct glyph_matrix
*matrix
)
707 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
708 matrix
->no_scrolling_p
= 0;
713 /* Shift part of the glyph matrix MATRIX of window W up or down.
714 Increment y-positions in glyph rows between START and END by DY,
715 and recompute their visible height. */
718 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
722 eassert (start
<= end
);
723 eassert (start
>= 0 && start
< matrix
->nrows
);
724 eassert (end
>= 0 && end
<= matrix
->nrows
);
726 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
727 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
729 for (; start
< end
; ++start
)
731 struct glyph_row
*row
= &matrix
->rows
[start
];
734 row
->visible_height
= row
->height
;
737 row
->visible_height
-= min_y
- row
->y
;
738 if (row
->y
+ row
->height
> max_y
)
739 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
740 if (row
->fringe_bitmap_periodic_p
)
741 row
->redraw_fringe_bitmaps_p
= 1;
746 /* Mark all rows in current matrices of frame F as invalid. Marking
747 invalid is done by setting enabled_p to zero for all rows in a
751 clear_current_matrices (register struct frame
*f
)
753 /* Clear frame current matrix, if we have one. */
754 if (f
->current_matrix
)
755 clear_glyph_matrix (f
->current_matrix
);
757 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
758 /* Clear the matrix of the menu bar window, if such a window exists.
759 The menu bar window is currently used to display menus on X when
760 no toolkit support is compiled in. */
761 if (WINDOWP (f
->menu_bar_window
))
762 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
765 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
766 /* Clear the matrix of the tool-bar window, if any. */
767 if (WINDOWP (f
->tool_bar_window
))
768 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
771 /* Clear current window matrices. */
772 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
773 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
777 /* Clear out all display lines of F for a coming redisplay. */
780 clear_desired_matrices (register struct frame
*f
)
782 if (f
->desired_matrix
)
783 clear_glyph_matrix (f
->desired_matrix
);
785 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
786 if (WINDOWP (f
->menu_bar_window
))
787 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
790 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
791 if (WINDOWP (f
->tool_bar_window
))
792 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
795 /* Do it for window matrices. */
796 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
797 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
801 /* Clear matrices in window tree rooted in W. If DESIRED_P,
802 clear desired matrices, otherwise clear current matrices. */
805 clear_window_matrices (struct window
*w
, bool desired_p
)
809 if (WINDOWP (w
->contents
))
810 clear_window_matrices (XWINDOW (w
->contents
), desired_p
);
814 clear_glyph_matrix (w
->desired_matrix
);
817 clear_glyph_matrix (w
->current_matrix
);
818 w
->window_end_valid
= 0;
822 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
828 /***********************************************************************
831 See dispextern.h for an overall explanation of glyph rows.
832 ***********************************************************************/
834 /* Clear glyph row ROW. NOTE: this code relies on the current
835 layout of `glyphs' and `used' fields of `struct glyph_row'. */
838 clear_glyph_row (struct glyph_row
*row
)
840 enum { off
= offsetof (struct glyph_row
, used
) };
842 /* Zero everything except pointers in `glyphs'. */
843 memset (row
->used
, 0, sizeof *row
- off
);
847 /* Make ROW an empty, enabled row of canonical character height,
848 in window W starting at y-position Y. */
851 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
855 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
856 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
858 clear_glyph_row (row
);
860 row
->ascent
= row
->phys_ascent
= 0;
861 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
862 row
->visible_height
= row
->height
;
865 row
->visible_height
-= min_y
- row
->y
;
866 if (row
->y
+ row
->height
> max_y
)
867 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
869 row
->enabled_p
= true;
873 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
874 are the amounts by which to change positions. Note that the first
875 glyph of the text area of a row can have a buffer position even if
876 the used count of the text area is zero. Such rows display line
880 increment_row_positions (struct glyph_row
*row
,
881 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
885 /* Increment start and end positions. */
886 MATRIX_ROW_START_CHARPOS (row
) += delta
;
887 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
888 MATRIX_ROW_END_CHARPOS (row
) += delta
;
889 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
890 CHARPOS (row
->start
.pos
) += delta
;
891 BYTEPOS (row
->start
.pos
) += delta_bytes
;
892 CHARPOS (row
->end
.pos
) += delta
;
893 BYTEPOS (row
->end
.pos
) += delta_bytes
;
898 /* Increment positions in glyphs. */
899 for (area
= 0; area
< LAST_AREA
; ++area
)
900 for (i
= 0; i
< row
->used
[area
]; ++i
)
901 if (BUFFERP (row
->glyphs
[area
][i
].object
)
902 && row
->glyphs
[area
][i
].charpos
> 0)
903 row
->glyphs
[area
][i
].charpos
+= delta
;
905 /* Capture the case of rows displaying a line end. */
906 if (row
->used
[TEXT_AREA
] == 0
907 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
908 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
913 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
914 contents, i.e. glyph structure contents are exchanged between A and
915 B without changing glyph pointers in A and B. */
918 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
922 for (area
= 0; area
< LAST_AREA
; ++area
)
924 /* Number of glyphs to swap. */
925 int max_used
= max (a
->used
[area
], b
->used
[area
]);
927 /* Start of glyphs in area of row A. */
928 struct glyph
*glyph_a
= a
->glyphs
[area
];
930 /* End + 1 of glyphs in area of row A. */
931 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
933 /* Start of glyphs in area of row B. */
934 struct glyph
*glyph_b
= b
->glyphs
[area
];
936 while (glyph_a
< glyph_a_end
)
938 /* Non-ISO HP/UX compiler doesn't like auto struct
952 /* Exchange pointers to glyph memory between glyph rows A and B. Also
953 exchange the used[] array and the hash values of the rows, because
954 these should all go together for the row's hash value to be
958 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
961 unsigned hash_tem
= a
->hash
;
963 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
965 struct glyph
*temp
= a
->glyphs
[i
];
967 a
->glyphs
[i
] = b
->glyphs
[i
];
971 short used_tem
= a
->used
[i
];
973 a
->used
[i
] = b
->used
[i
];
974 b
->used
[i
] = used_tem
;
982 /* Copy glyph row structure FROM to glyph row structure TO, except that
983 glyph pointers, the `used' counts, and the hash values in the structures
984 are left unchanged. NOTE: this code relies on the current layout of
985 `glyphs', `used', `hash' and `x' fields of `struct glyph_row'. */
988 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
990 enum { off
= offsetof (struct glyph_row
, x
) };
992 memcpy (&to
->x
, &from
->x
, sizeof *to
- off
);
996 /* Assign glyph row FROM to glyph row TO. This works like a structure
997 assignment TO = FROM, except that glyph pointers are not copied but
998 exchanged between TO and FROM. Pointers must be exchanged to avoid
1002 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1004 swap_glyph_pointers (to
, from
);
1005 copy_row_except_pointers (to
, from
);
1009 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1010 a row in a window matrix, is a slice of the glyph memory of the
1011 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1012 is true if the glyph memory of WINDOW_ROW is part of the glyph
1013 memory of FRAME_ROW. */
1018 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1020 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1021 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1022 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1024 return (frame_glyph_start
<= window_glyph_start
1025 && window_glyph_start
< frame_glyph_end
);
1028 #endif /* GLYPH_DEBUG */
1032 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1033 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1034 in WINDOW_MATRIX is found satisfying the condition. */
1036 static struct glyph_row
*
1037 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1038 struct glyph_matrix
*frame_matrix
, int row
)
1042 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1044 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1045 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1046 frame_matrix
->rows
+ row
))
1049 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1054 /* Prepare ROW for display in windows W. Desired rows are cleared
1055 lazily, i.e. they are only marked as to be cleared by setting their
1056 enabled_p flag to zero. When a row is to be displayed, a prior
1057 call to this function really clears it. In addition, this function
1058 makes sure the marginal areas of ROW are in sync with the window's
1059 display margins. MODE_LINE_P non-zero means we are preparing a
1060 glyph row for header line or mode line. */
1063 prepare_desired_row (struct window
*w
, struct glyph_row
*row
, bool mode_line_p
)
1065 if (!row
->enabled_p
)
1067 bool rp
= row
->reversed_p
;
1069 clear_glyph_row (row
);
1070 row
->enabled_p
= true;
1071 row
->reversed_p
= rp
;
1075 /* Mode and header lines, if displayed, never have marginal
1076 areas. If we are called with MODE_LINE_P non-zero, we are
1077 displaying the mode/header line in this window, and so the
1078 marginal areas of this glyph row should be eliminated. This
1079 is needed when the mode/header line is switched on in a
1080 window that has display margins. */
1081 if (w
->left_margin_cols
> 0)
1082 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
1083 if (w
->right_margin_cols
> 0)
1084 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
];
1086 else if (row
== MATRIX_MODE_LINE_ROW (w
->desired_matrix
)
1087 || row
== MATRIX_HEADER_LINE_ROW (w
->desired_matrix
))
1089 /* The real number of glyphs reserved for the margins is
1090 recorded in the glyph matrix, and can be different from
1091 window's left_margin_cols and right_margin_cols; see
1092 margin_glyphs_to_reserve for when that happens. */
1093 int left
= w
->desired_matrix
->left_margin_glyphs
;
1094 int right
= w
->desired_matrix
->right_margin_glyphs
;
1096 /* Make sure the marginal areas of this row are in sync with
1097 what the window wants, when the 1st/last row of the matrix
1098 actually displays text and not header/mode line. */
1099 if (w
->left_margin_cols
> 0
1100 && (left
!= row
->glyphs
[TEXT_AREA
] - row
->glyphs
[LEFT_MARGIN_AREA
]))
1101 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
1102 if (w
->right_margin_cols
> 0
1103 && (right
!= row
->glyphs
[LAST_AREA
] - row
->glyphs
[RIGHT_MARGIN_AREA
]))
1104 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
] - right
;
1109 /* Return a hash code for glyph row ROW, which may
1110 be from current or desired matrix of frame F. */
1113 line_hash_code (struct frame
*f
, struct glyph_row
*row
)
1119 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1120 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1124 int c
= glyph
->u
.ch
;
1125 int face_id
= glyph
->face_id
;
1126 if (FRAME_MUST_WRITE_SPACES (f
))
1128 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1129 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1141 /* Return the cost of drawing line VPOS in MATRIX, which may
1142 be current or desired matrix of frame F. The cost equals
1143 the number of characters in the line. If must_write_spaces
1144 is zero, leading and trailing spaces are ignored. */
1147 line_draw_cost (struct frame
*f
, struct glyph_matrix
*matrix
, int vpos
)
1149 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1150 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1151 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1153 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1154 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1156 /* Ignore trailing and leading spaces if we can. */
1157 if (!FRAME_MUST_WRITE_SPACES (f
))
1159 /* Skip from the end over trailing spaces. */
1160 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1163 /* All blank line. */
1167 /* Skip over leading spaces. */
1168 while (CHAR_GLYPH_SPACE_P (*beg
))
1172 /* If we don't have a glyph-table, each glyph is one character,
1173 so return the number of glyphs. */
1174 if (glyph_table_base
== 0)
1178 /* Otherwise, scan the glyphs and accumulate their total length
1185 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1187 if (GLYPH_INVALID_P (g
)
1188 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1191 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1201 /* Return true if the glyph rows A and B have equal contents.
1202 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1205 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1207 eassert (verify_row_hash (a
));
1208 eassert (verify_row_hash (b
));
1212 else if (a
->hash
!= b
->hash
)
1216 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1219 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1222 /* Compare glyphs. */
1223 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1225 if (a
->used
[area
] != b
->used
[area
])
1228 a_glyph
= a
->glyphs
[area
];
1229 a_end
= a_glyph
+ a
->used
[area
];
1230 b_glyph
= b
->glyphs
[area
];
1232 while (a_glyph
< a_end
1233 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1234 ++a_glyph
, ++b_glyph
;
1236 if (a_glyph
!= a_end
)
1240 if (a
->fill_line_p
!= b
->fill_line_p
1241 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1242 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1243 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1244 || a
->left_fringe_offset
!= b
->left_fringe_offset
1245 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1246 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1247 || a
->right_fringe_offset
!= b
->right_fringe_offset
1248 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1249 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1250 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1251 || a
->overlapped_p
!= b
->overlapped_p
1252 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1253 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1254 || a
->reversed_p
!= b
->reversed_p
1255 /* Different partially visible characters on left margin. */
1257 /* Different height. */
1258 || a
->ascent
!= b
->ascent
1259 || a
->phys_ascent
!= b
->phys_ascent
1260 || a
->phys_height
!= b
->phys_height
1261 || a
->visible_height
!= b
->visible_height
)
1270 /***********************************************************************
1273 See dispextern.h for an overall explanation of glyph pools.
1274 ***********************************************************************/
1276 /* Allocate a glyph_pool structure. The structure returned is initialized
1277 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1278 variable glyph_pool_count is incremented for each pool allocated. */
1280 static struct glyph_pool
*
1281 new_glyph_pool (void)
1283 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1285 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1286 /* For memory leak and double deletion checking. */
1294 /* Free a glyph_pool structure POOL. The function may be called with
1295 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1296 global variable glyph_pool_count is decremented with every pool structure
1297 freed. If this count gets negative, more structures were freed than
1298 allocated, i.e. one structure must have been freed more than once or
1299 a bogus pointer was passed to free_glyph_pool. */
1302 free_glyph_pool (struct glyph_pool
*pool
)
1306 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1307 /* More freed than allocated? */
1309 eassert (glyph_pool_count
>= 0);
1311 xfree (pool
->glyphs
);
1317 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1318 columns we need. This function never shrinks a pool. The only
1319 case in which this would make sense, would be when a frame's size
1320 is changed from a large value to a smaller one. But, if someone
1321 does it once, we can expect that he will do it again.
1323 Return true if the pool changed in a way which makes
1324 re-adjusting window glyph matrices necessary. */
1327 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1332 changed_p
= (pool
->glyphs
== 0
1333 || matrix_dim
.height
!= pool
->nrows
1334 || matrix_dim
.width
!= pool
->ncolumns
);
1336 /* Enlarge the glyph pool. */
1337 needed
= matrix_dim
.width
;
1338 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1339 memory_full (SIZE_MAX
);
1340 needed
*= matrix_dim
.height
;
1341 if (needed
> pool
->nglyphs
)
1343 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1344 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1345 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1346 memset (pool
->glyphs
+ old_nglyphs
, 0,
1347 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1350 /* Remember the number of rows and columns because (a) we use them
1351 to do sanity checks, and (b) the number of columns determines
1352 where rows in the frame matrix start---this must be available to
1353 determine pointers to rows of window sub-matrices. */
1354 pool
->nrows
= matrix_dim
.height
;
1355 pool
->ncolumns
= matrix_dim
.width
;
1362 /***********************************************************************
1364 ***********************************************************************/
1369 /* Flush standard output. This is sometimes useful to call from the debugger.
1370 XXX Maybe this should be changed to flush the current terminal instead of
1374 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1383 /* Check that no glyph pointers have been lost in MATRIX. If a
1384 pointer has been lost, e.g. by using a structure assignment between
1385 rows, at least one pointer must occur more than once in the rows of
1389 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1393 for (i
= 0; i
< matrix
->nrows
; ++i
)
1394 for (j
= 0; j
< matrix
->nrows
; ++j
)
1396 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1397 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1401 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1404 matrix_row (struct glyph_matrix
*matrix
, int row
)
1406 eassert (matrix
&& matrix
->rows
);
1407 eassert (row
>= 0 && row
< matrix
->nrows
);
1409 /* That's really too slow for normal testing because this function
1410 is called almost everywhere. Although---it's still astonishingly
1411 fast, so it is valuable to have for debugging purposes. */
1413 check_matrix_pointer_lossage (matrix
);
1416 return matrix
->rows
+ row
;
1420 #if 0 /* This function makes invalid assumptions when text is
1421 partially invisible. But it might come handy for debugging
1424 /* Check invariants that must hold for an up to date current matrix of
1428 check_matrix_invariants (struct window
*w
)
1430 struct glyph_matrix
*matrix
= w
->current_matrix
;
1431 int yb
= window_text_bottom_y (w
);
1432 struct glyph_row
*row
= matrix
->rows
;
1433 struct glyph_row
*last_text_row
= NULL
;
1434 struct buffer
*saved
= current_buffer
;
1435 struct buffer
*buffer
= XBUFFER (w
->contents
);
1438 /* This can sometimes happen for a fresh window. */
1439 if (matrix
->nrows
< 2)
1442 set_buffer_temp (buffer
);
1444 /* Note: last row is always reserved for the mode line. */
1445 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1446 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1448 struct glyph_row
*next
= row
+ 1;
1450 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1451 last_text_row
= row
;
1453 /* Check that character and byte positions are in sync. */
1454 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1455 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1456 eassert (BYTEPOS (row
->start
.pos
)
1457 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1459 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1460 have such a position temporarily in case of a minibuffer
1461 displaying something like `[Sole completion]' at its end. */
1462 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1464 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1465 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1466 eassert (BYTEPOS (row
->end
.pos
)
1467 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1470 /* Check that end position of `row' is equal to start position
1472 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1474 eassert (MATRIX_ROW_END_CHARPOS (row
)
1475 == MATRIX_ROW_START_CHARPOS (next
));
1476 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1477 == MATRIX_ROW_START_BYTEPOS (next
));
1478 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1479 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1484 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1485 eassert (w
->desired_matrix
->rows
!= NULL
);
1486 set_buffer_temp (saved
);
1491 #endif /* GLYPH_DEBUG */
1495 /**********************************************************************
1496 Allocating/ Adjusting Glyph Matrices
1497 **********************************************************************/
1499 /* Allocate glyph matrices over a window tree for a frame-based
1502 X and Y are column/row within the frame glyph matrix where
1503 sub-matrices for the window tree rooted at WINDOW must be
1504 allocated. DIM_ONLY_P means that the caller of this
1505 function is only interested in the result matrix dimension, and
1506 matrix adjustments should not be performed.
1508 The function returns the total width/height of the sub-matrices of
1509 the window tree. If called on a frame root window, the computation
1510 will take the mini-buffer window into account.
1512 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1514 NEW_LEAF_MATRIX set if any window in the tree did not have a
1515 glyph matrices yet, and
1517 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1518 any window in the tree will be changed or have been changed (see
1521 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1524 Windows are arranged into chains of windows on the same level
1525 through the next fields of window structures. Such a level can be
1526 either a sequence of horizontally adjacent windows from left to
1527 right, or a sequence of vertically adjacent windows from top to
1528 bottom. Each window in a horizontal sequence can be either a leaf
1529 window or a vertical sequence; a window in a vertical sequence can
1530 be either a leaf or a horizontal sequence. All windows in a
1531 horizontal sequence have the same height, and all windows in a
1532 vertical sequence have the same width.
1534 This function uses, for historical reasons, a more general
1535 algorithm to determine glyph matrix dimensions that would be
1538 The matrix height of a horizontal sequence is determined by the
1539 maximum height of any matrix in the sequence. The matrix width of
1540 a horizontal sequence is computed by adding up matrix widths of
1541 windows in the sequence.
1543 |<------- result width ------->|
1544 +---------+----------+---------+ ---
1547 +---------+ | | result height
1552 The matrix width of a vertical sequence is the maximum matrix width
1553 of any window in the sequence. Its height is computed by adding up
1554 matrix heights of windows in the sequence.
1556 |<---- result width -->|
1564 +------------+---------+ |
1567 +------------+---------+ --- */
1569 /* Bit indicating that a new matrix will be allocated or has been
1572 #define NEW_LEAF_MATRIX (1 << 0)
1574 /* Bit indicating that a matrix will or has changed its location or
1577 #define CHANGED_LEAF_MATRIX (1 << 1)
1580 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1581 bool dim_only_p
, int *window_change_flags
)
1583 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1585 int wmax
= 0, hmax
= 0;
1589 bool in_horz_combination_p
;
1591 /* What combination is WINDOW part of? Compute this once since the
1592 result is the same for all windows in the `next' chain. The
1593 special case of a root window (parent equal to nil) is treated
1594 like a vertical combination because a root window's `next'
1595 points to the mini-buffer window, if any, which is arranged
1596 vertically below other windows. */
1597 in_horz_combination_p
1598 = (!NILP (XWINDOW (window
)->parent
)
1599 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1601 /* For WINDOW and all windows on the same level. */
1604 w
= XWINDOW (window
);
1606 /* Get the dimension of the window sub-matrix for W, depending
1607 on whether this is a combination or a leaf window. */
1608 if (WINDOWP (w
->contents
))
1609 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1611 window_change_flags
);
1614 /* If not already done, allocate sub-matrix structures. */
1615 if (w
->desired_matrix
== NULL
)
1617 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1618 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1619 *window_change_flags
|= NEW_LEAF_MATRIX
;
1622 /* Width and height MUST be chosen so that there are no
1623 holes in the frame matrix. */
1624 dim
.width
= required_matrix_width (w
);
1625 dim
.height
= required_matrix_height (w
);
1627 /* Will matrix be re-allocated? */
1628 if (x
!= w
->desired_matrix
->matrix_x
1629 || y
!= w
->desired_matrix
->matrix_y
1630 || dim
.width
!= w
->desired_matrix
->matrix_w
1631 || dim
.height
!= w
->desired_matrix
->matrix_h
1632 || (margin_glyphs_to_reserve (w
, dim
.width
,
1633 w
->left_margin_cols
)
1634 != w
->desired_matrix
->left_margin_glyphs
)
1635 || (margin_glyphs_to_reserve (w
, dim
.width
,
1636 w
->right_margin_cols
)
1637 != w
->desired_matrix
->right_margin_glyphs
))
1638 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1640 /* Actually change matrices, if allowed. Do not consider
1641 CHANGED_LEAF_MATRIX computed above here because the pool
1642 may have been changed which we don't now here. We trust
1643 that we only will be called with DIM_ONLY_P when
1647 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1648 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1652 /* If we are part of a horizontal combination, advance x for
1653 windows to the right of W; otherwise advance y for windows
1655 if (in_horz_combination_p
)
1660 /* Remember maximum glyph matrix dimensions. */
1661 wmax
= max (wmax
, dim
.width
);
1662 hmax
= max (hmax
, dim
.height
);
1664 /* Next window on same level. */
1667 while (!NILP (window
));
1669 /* Set `total' to the total glyph matrix dimension of this window
1670 level. In a vertical combination, the width is the width of the
1671 widest window; the height is the y we finally reached, corrected
1672 by the y we started with. In a horizontal combination, the total
1673 height is the height of the tallest window, and the width is the
1674 x we finally reached, corrected by the x we started with. */
1675 if (in_horz_combination_p
)
1677 total
.width
= x
- x0
;
1678 total
.height
= hmax
;
1683 total
.height
= y
- y0
;
1690 /* Return the required height of glyph matrices for window W. */
1693 required_matrix_height (struct window
*w
)
1695 #ifdef HAVE_WINDOW_SYSTEM
1696 struct frame
*f
= XFRAME (w
->frame
);
1698 if (FRAME_WINDOW_P (f
))
1700 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1701 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1703 return (((window_pixel_height
+ ch_height
- 1)
1704 / ch_height
) * w
->nrows_scale_factor
1705 /* One partially visible line at the top and
1706 bottom of the window. */
1708 /* 2 for header and mode line. */
1711 #endif /* HAVE_WINDOW_SYSTEM */
1713 return WINDOW_TOTAL_LINES (w
);
1717 /* Return the required width of glyph matrices for window W. */
1720 required_matrix_width (struct window
*w
)
1722 #ifdef HAVE_WINDOW_SYSTEM
1723 struct frame
*f
= XFRAME (w
->frame
);
1724 if (FRAME_WINDOW_P (f
))
1726 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1728 /* Compute number of glyphs needed in a glyph row. */
1729 return (((WINDOW_PIXEL_WIDTH (w
) + ch_width
- 1)
1730 / ch_width
) * w
->ncols_scale_factor
1731 /* 2 partially visible columns in the text area. */
1733 /* One partially visible column at the right
1734 edge of each marginal area. */
1737 #endif /* HAVE_WINDOW_SYSTEM */
1739 return w
->total_cols
;
1743 /* Allocate window matrices for window-based redisplay. W is the
1744 window whose matrices must be allocated/reallocated. */
1747 allocate_matrices_for_window_redisplay (struct window
*w
)
1751 if (WINDOWP (w
->contents
))
1752 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1755 /* W is a leaf window. */
1758 /* If matrices are not yet allocated, allocate them now. */
1759 if (w
->desired_matrix
== NULL
)
1761 w
->desired_matrix
= new_glyph_matrix (NULL
);
1762 w
->current_matrix
= new_glyph_matrix (NULL
);
1765 dim
.width
= required_matrix_width (w
);
1766 dim
.height
= required_matrix_height (w
);
1767 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1768 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1771 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1775 /* Allocate/reallocate glyph matrices of a single frame F.
1776 This function must be called when a new frame is created,
1777 its size changes, or its window configuration changes. */
1780 adjust_frame_glyphs (struct frame
*f
)
1782 /* Block input so that expose events and other events that access
1783 glyph matrices are not processed while we are changing them. */
1786 if (FRAME_WINDOW_P (f
))
1787 adjust_frame_glyphs_for_window_redisplay (f
);
1789 adjust_frame_glyphs_for_frame_redisplay (f
);
1791 /* Don't forget the buffer for decode_mode_spec. */
1792 adjust_decode_mode_spec_buffer (f
);
1794 f
->glyphs_initialized_p
= 1;
1799 /* Return true if any window in the tree has nonzero window margins. See
1800 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1802 showing_window_margins_p (struct window
*w
)
1806 if (WINDOWP (w
->contents
))
1808 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1811 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1814 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1820 /* In the window tree with root W, build current matrices of leaf
1821 windows from the frame's current matrix. */
1824 fake_current_matrices (Lisp_Object window
)
1828 for (; !NILP (window
); window
= w
->next
)
1830 w
= XWINDOW (window
);
1832 if (WINDOWP (w
->contents
))
1833 fake_current_matrices (w
->contents
);
1837 struct frame
*f
= XFRAME (w
->frame
);
1838 struct glyph_matrix
*m
= w
->current_matrix
;
1839 struct glyph_matrix
*fm
= f
->current_matrix
;
1841 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1842 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1844 for (i
= 0; i
< m
->matrix_h
; ++i
)
1846 struct glyph_row
*r
= m
->rows
+ i
;
1847 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1849 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1850 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1852 r
->enabled_p
= fr
->enabled_p
;
1855 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1856 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1857 r
->used
[TEXT_AREA
] = (m
->matrix_w
1858 - r
->used
[LEFT_MARGIN_AREA
]
1859 - r
->used
[RIGHT_MARGIN_AREA
]);
1868 /* Save away the contents of frame F's current frame matrix. Value is
1869 a glyph matrix holding the contents of F's current frame matrix. */
1871 static struct glyph_matrix
*
1872 save_current_matrix (struct frame
*f
)
1875 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1876 saved
->nrows
= f
->current_matrix
->nrows
;
1877 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1879 for (i
= 0; i
< saved
->nrows
; ++i
)
1881 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1882 struct glyph_row
*to
= saved
->rows
+ i
;
1883 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1885 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1886 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1887 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1888 to
->enabled_p
= from
->enabled_p
;
1889 to
->hash
= from
->hash
;
1890 if (from
->used
[LEFT_MARGIN_AREA
])
1892 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1893 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1894 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1895 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1896 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1898 if (from
->used
[RIGHT_MARGIN_AREA
])
1900 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1901 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1902 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1903 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1904 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1912 /* Restore the contents of frame F's current frame matrix from SAVED,
1913 and free memory associated with SAVED. */
1916 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1920 for (i
= 0; i
< saved
->nrows
; ++i
)
1922 struct glyph_row
*from
= saved
->rows
+ i
;
1923 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1924 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1926 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1927 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1928 xfree (from
->glyphs
[TEXT_AREA
]);
1929 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1932 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1933 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1934 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1935 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1938 to
->used
[LEFT_MARGIN_AREA
] = 0;
1939 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1942 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1943 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1944 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1945 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1948 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1951 xfree (saved
->rows
);
1957 /* Allocate/reallocate glyph matrices of a single frame F for
1958 frame-based redisplay. */
1961 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1963 struct dim matrix_dim
;
1964 bool pool_changed_p
;
1965 int window_change_flags
;
1968 if (!FRAME_LIVE_P (f
))
1971 top_window_y
= FRAME_TOP_MARGIN (f
);
1973 /* Allocate glyph pool structures if not already done. */
1974 if (f
->desired_pool
== NULL
)
1976 f
->desired_pool
= new_glyph_pool ();
1977 f
->current_pool
= new_glyph_pool ();
1980 /* Allocate frames matrix structures if needed. */
1981 if (f
->desired_matrix
== NULL
)
1983 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1984 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1987 /* Compute window glyph matrices. (This takes the mini-buffer
1988 window into account). The result is the size of the frame glyph
1989 matrix needed. The variable window_change_flags is set to a bit
1990 mask indicating whether new matrices will be allocated or
1991 existing matrices change their size or location within the frame
1993 window_change_flags
= 0;
1995 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1998 &window_change_flags
);
2000 /* Add in menu bar lines, if any. */
2001 matrix_dim
.height
+= top_window_y
;
2003 /* Enlarge pools as necessary. */
2004 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2005 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2007 /* Set up glyph pointers within window matrices. Do this only if
2008 absolutely necessary since it requires a frame redraw. */
2009 if (pool_changed_p
|| window_change_flags
)
2011 /* Do it for window matrices. */
2012 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2014 &window_change_flags
);
2016 /* Size of frame matrices must equal size of frame. Note
2017 that we are called for X frames with window widths NOT equal
2018 to the frame width (from CHANGE_FRAME_SIZE_1). */
2019 if (matrix_dim
.width
!= FRAME_COLS (f
)
2020 || matrix_dim
.height
!= FRAME_LINES (f
))
2023 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2024 && matrix_dim
.height
== FRAME_LINES (f
));
2026 /* Pointers to glyph memory in glyph rows are exchanged during
2027 the update phase of redisplay, which means in general that a
2028 frame's current matrix consists of pointers into both the
2029 desired and current glyph pool of the frame. Adjusting a
2030 matrix sets the frame matrix up so that pointers are all into
2031 the same pool. If we want to preserve glyph contents of the
2032 current matrix over a call to adjust_glyph_matrix, we must
2033 make a copy of the current glyphs, and restore the current
2034 matrix' contents from that copy. */
2035 if (display_completed
2036 && !FRAME_GARBAGED_P (f
)
2037 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2038 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2039 /* For some reason, the frame glyph matrix gets corrupted if
2040 any of the windows contain margins. I haven't been able
2041 to hunt down the reason, but for the moment this prevents
2042 the problem from manifesting. -- cyd */
2043 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2045 struct glyph_matrix
*copy
= save_current_matrix (f
);
2046 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2047 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2048 restore_current_matrix (f
, copy
);
2049 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2053 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2054 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2055 SET_FRAME_GARBAGED (f
);
2061 /* Allocate/reallocate glyph matrices of a single frame F for
2062 window-based redisplay. */
2065 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2067 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2069 /* Allocate/reallocate window matrices. */
2070 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2072 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2073 /* Allocate/ reallocate matrices of the dummy window used to display
2074 the menu bar under X when no X toolkit support is available. */
2076 /* Allocate a dummy window if not already done. */
2078 if (NILP (f
->menu_bar_window
))
2081 fset_menu_bar_window (f
, make_window ());
2082 w
= XWINDOW (f
->menu_bar_window
);
2083 XSETFRAME (frame
, f
);
2084 wset_frame (w
, frame
);
2085 w
->pseudo_window_p
= 1;
2088 w
= XWINDOW (f
->menu_bar_window
);
2090 /* Set window dimensions to frame dimensions and allocate or
2091 adjust glyph matrices of W. */
2096 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2097 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2098 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2099 w
->pixel_height
= FRAME_MENU_BAR_HEIGHT (f
);
2100 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2101 allocate_matrices_for_window_redisplay (w
);
2105 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2107 /* Allocate/ reallocate matrices of the tool bar window. If we
2108 don't have a tool bar window yet, make one. */
2110 if (NILP (f
->tool_bar_window
))
2113 fset_tool_bar_window (f
, make_window ());
2114 w
= XWINDOW (f
->tool_bar_window
);
2115 XSETFRAME (frame
, f
);
2116 wset_frame (w
, frame
);
2117 w
->pseudo_window_p
= 1;
2120 w
= XWINDOW (f
->tool_bar_window
);
2124 w
->pixel_top
= FRAME_MENU_BAR_HEIGHT (f
);
2125 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2126 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2127 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2128 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2129 w
->pixel_height
= FRAME_TOOL_BAR_HEIGHT (f
);
2130 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2131 allocate_matrices_for_window_redisplay (w
);
2137 /* Re-allocate buffer for decode_mode_spec on frame F. */
2140 adjust_decode_mode_spec_buffer (struct frame
*f
)
2142 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2143 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2148 /**********************************************************************
2149 Freeing Glyph Matrices
2150 **********************************************************************/
2152 /* Free glyph memory for a frame F. F may be null. This function can
2153 be called for the same frame more than once. The root window of
2154 F may be nil when this function is called. This is the case when
2155 the function is called when F is destroyed. */
2158 free_glyphs (struct frame
*f
)
2160 if (f
&& f
->glyphs_initialized_p
)
2162 /* Block interrupt input so that we don't get surprised by an X
2163 event while we're in an inconsistent state. */
2165 f
->glyphs_initialized_p
= 0;
2167 /* Release window sub-matrices. */
2168 if (!NILP (f
->root_window
))
2169 free_window_matrices (XWINDOW (f
->root_window
));
2171 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2172 /* Free the dummy window for menu bars without X toolkit and its
2174 if (!NILP (f
->menu_bar_window
))
2176 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2177 free_glyph_matrix (w
->desired_matrix
);
2178 free_glyph_matrix (w
->current_matrix
);
2179 w
->desired_matrix
= w
->current_matrix
= NULL
;
2180 fset_menu_bar_window (f
, Qnil
);
2184 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2185 /* Free the tool bar window and its glyph matrices. */
2186 if (!NILP (f
->tool_bar_window
))
2188 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2189 free_glyph_matrix (w
->desired_matrix
);
2190 free_glyph_matrix (w
->current_matrix
);
2191 w
->desired_matrix
= w
->current_matrix
= NULL
;
2192 fset_tool_bar_window (f
, Qnil
);
2196 /* Release frame glyph matrices. Reset fields to zero in
2197 case we are called a second time. */
2198 if (f
->desired_matrix
)
2200 free_glyph_matrix (f
->desired_matrix
);
2201 free_glyph_matrix (f
->current_matrix
);
2202 f
->desired_matrix
= f
->current_matrix
= NULL
;
2205 /* Release glyph pools. */
2206 if (f
->desired_pool
)
2208 free_glyph_pool (f
->desired_pool
);
2209 free_glyph_pool (f
->current_pool
);
2210 f
->desired_pool
= f
->current_pool
= NULL
;
2218 /* Free glyph sub-matrices in the window tree rooted at W. This
2219 function may be called with a null pointer, and it may be called on
2220 the same tree more than once. */
2223 free_window_matrices (struct window
*w
)
2227 if (WINDOWP (w
->contents
))
2228 free_window_matrices (XWINDOW (w
->contents
));
2231 /* This is a leaf window. Free its memory and reset fields
2232 to zero in case this function is called a second time for
2234 free_glyph_matrix (w
->current_matrix
);
2235 free_glyph_matrix (w
->desired_matrix
);
2236 w
->current_matrix
= w
->desired_matrix
= NULL
;
2239 /* Next window on same level. */
2240 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2245 /* Check glyph memory leaks. This function is called from
2246 shut_down_emacs. Note that frames are not destroyed when Emacs
2247 exits. We therefore free all glyph memory for all active frames
2248 explicitly and check that nothing is left allocated. */
2251 check_glyph_memory (void)
2253 Lisp_Object tail
, frame
;
2255 /* Free glyph memory for all frames. */
2256 FOR_EACH_FRAME (tail
, frame
)
2257 free_glyphs (XFRAME (frame
));
2259 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2260 /* Check that nothing is left allocated. */
2261 eassert (glyph_matrix_count
== 0);
2262 eassert (glyph_pool_count
== 0);
2268 /**********************************************************************
2269 Building a Frame Matrix
2270 **********************************************************************/
2272 /* Most of the redisplay code works on glyph matrices attached to
2273 windows. This is a good solution most of the time, but it is not
2274 suitable for terminal code. Terminal output functions cannot rely
2275 on being able to set an arbitrary terminal window. Instead they
2276 must be provided with a view of the whole frame, i.e. the whole
2277 screen. We build such a view by constructing a frame matrix from
2278 window matrices in this section.
2280 Windows that must be updated have their must_be_updated_p flag set.
2281 For all such windows, their desired matrix is made part of the
2282 desired frame matrix. For other windows, their current matrix is
2283 made part of the desired frame matrix.
2285 +-----------------+----------------+
2286 | desired | desired |
2288 +-----------------+----------------+
2291 +----------------------------------+
2293 Desired window matrices can be made part of the frame matrix in a
2294 cheap way: We exploit the fact that the desired frame matrix and
2295 desired window matrices share their glyph memory. This is not
2296 possible for current window matrices. Their glyphs are copied to
2297 the desired frame matrix. The latter is equivalent to
2298 preserve_other_columns in the old redisplay.
2300 Used glyphs counters for frame matrix rows are the result of adding
2301 up glyph lengths of the window matrices. A line in the frame
2302 matrix is enabled, if a corresponding line in a window matrix is
2305 After building the desired frame matrix, it will be passed to
2306 terminal code, which will manipulate both the desired and current
2307 frame matrix. Changes applied to the frame's current matrix have
2308 to be visible in current window matrices afterwards, of course.
2310 This problem is solved like this:
2312 1. Window and frame matrices share glyphs. Window matrices are
2313 constructed in a way that their glyph contents ARE the glyph
2314 contents needed in a frame matrix. Thus, any modification of
2315 glyphs done in terminal code will be reflected in window matrices
2318 2. Exchanges of rows in a frame matrix done by terminal code are
2319 intercepted by hook functions so that corresponding row operations
2320 on window matrices can be performed. This is necessary because we
2321 use pointers to glyphs in glyph row structures. To satisfy the
2322 assumption of point 1 above that glyphs are updated implicitly in
2323 window matrices when they are manipulated via the frame matrix,
2324 window and frame matrix must of course agree where to find the
2325 glyphs for their rows. Possible manipulations that must be
2326 mirrored are assignments of rows of the desired frame matrix to the
2327 current frame matrix and scrolling the current frame matrix. */
2329 /* Build frame F's desired matrix from window matrices. Only windows
2330 which have the flag must_be_updated_p set have to be updated. Menu
2331 bar lines of a frame are not covered by window matrices, so make
2332 sure not to touch them in this function. */
2335 build_frame_matrix (struct frame
*f
)
2339 /* F must have a frame matrix when this function is called. */
2340 eassert (!FRAME_WINDOW_P (f
));
2342 /* Clear all rows in the frame matrix covered by window matrices.
2343 Menu bar lines are not covered by windows. */
2344 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2345 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2347 /* Build the matrix by walking the window tree. */
2348 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2349 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2353 /* Walk a window tree, building a frame matrix MATRIX from window
2354 matrices. W is the root of a window tree. */
2357 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2361 if (WINDOWP (w
->contents
))
2362 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2364 build_frame_matrix_from_leaf_window (matrix
, w
);
2366 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2371 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2372 desired frame matrix built. W is a leaf window whose desired or
2373 current matrix is to be added to FRAME_MATRIX. W's flag
2374 must_be_updated_p determines which matrix it contributes to
2375 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2376 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2377 Adding a desired matrix means setting up used counters and such in
2378 frame rows, while adding a current window matrix to FRAME_MATRIX
2379 means copying glyphs. The latter case corresponds to
2380 preserve_other_columns in the old redisplay. */
2383 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2385 struct glyph_matrix
*window_matrix
;
2386 int window_y
, frame_y
;
2387 /* If non-zero, a glyph to insert at the right border of W. */
2388 GLYPH right_border_glyph
;
2390 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2392 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2393 if (w
->must_be_updated_p
)
2395 window_matrix
= w
->desired_matrix
;
2397 /* Decide whether we want to add a vertical border glyph. */
2398 if (!WINDOW_RIGHTMOST_P (w
))
2400 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2403 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2405 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2407 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2408 spec_glyph_lookup_face (w
, &right_border_glyph
);
2411 if (GLYPH_FACE (right_border_glyph
) <= 0)
2412 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2416 window_matrix
= w
->current_matrix
;
2418 /* For all rows in the window matrix and corresponding rows in the
2421 frame_y
= window_matrix
->matrix_y
;
2422 while (window_y
< window_matrix
->nrows
)
2424 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2425 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2426 bool current_row_p
= window_matrix
== w
->current_matrix
;
2428 /* Fill up the frame row with spaces up to the left margin of the
2430 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2432 /* Fill up areas in the window matrix row with spaces. */
2433 fill_up_glyph_row_with_spaces (window_row
);
2435 /* If only part of W's desired matrix has been built, and
2436 window_row wasn't displayed, use the corresponding current
2438 if (window_matrix
== w
->desired_matrix
2439 && !window_row
->enabled_p
)
2441 window_row
= w
->current_matrix
->rows
+ window_y
;
2447 /* Copy window row to frame row. */
2448 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2449 window_row
->glyphs
[0],
2450 window_matrix
->matrix_w
* sizeof (struct glyph
));
2454 eassert (window_row
->enabled_p
);
2456 /* Only when a desired row has been displayed, we want
2457 the corresponding frame row to be updated. */
2458 frame_row
->enabled_p
= true;
2460 /* Maybe insert a vertical border between horizontally adjacent
2462 if (GLYPH_CHAR (right_border_glyph
) != 0)
2464 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2465 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2469 /* Window row window_y must be a slice of frame row
2471 eassert (glyph_row_slice_p (window_row
, frame_row
));
2473 /* If rows are in sync, we don't have to copy glyphs because
2474 frame and window share glyphs. */
2476 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2477 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2481 /* Set number of used glyphs in the frame matrix. Since we fill
2482 up with spaces, and visit leaf windows from left to right it
2483 can be done simply. */
2484 frame_row
->used
[TEXT_AREA
]
2485 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2493 /* Given a user-specified glyph, possibly including a Lisp-level face
2494 ID, return a glyph that has a realized face ID.
2495 This is used for glyphs displayed specially and not part of the text;
2496 for instance, vertical separators, truncation markers, etc. */
2499 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2501 int lface_id
= GLYPH_FACE (*glyph
);
2502 /* Convert the glyph's specified face to a realized (cache) face. */
2505 int face_id
= merge_faces (XFRAME (w
->frame
),
2506 Qt
, lface_id
, DEFAULT_FACE_ID
);
2507 SET_GLYPH_FACE (*glyph
, face_id
);
2511 /* Add spaces to a glyph row ROW in a window matrix.
2513 Each row has the form:
2515 +---------+-----------------------------+------------+
2516 | left | text | right |
2517 +---------+-----------------------------+------------+
2519 Left and right marginal areas are optional. This function adds
2520 spaces to areas so that there are no empty holes between areas.
2521 In other words: If the right area is not empty, the text area
2522 is filled up with spaces up to the right area. If the text area
2523 is not empty, the left area is filled up.
2525 To be called for frame-based redisplay, only. */
2528 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2530 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2531 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2532 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2536 /* Fill area AREA of glyph row ROW with spaces. To be called for
2537 frame-based redisplay only. */
2540 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2542 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2544 struct glyph
*end
= row
->glyphs
[area
+ 1];
2545 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2548 *text
++ = space_glyph
;
2549 row
->used
[area
] = text
- row
->glyphs
[area
];
2554 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2555 reached. In frame matrices only one area, TEXT_AREA, is used. */
2558 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2560 int i
= row
->used
[TEXT_AREA
];
2561 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2564 glyph
[i
++] = space_glyph
;
2566 row
->used
[TEXT_AREA
] = i
;
2571 /**********************************************************************
2572 Mirroring operations on frame matrices in window matrices
2573 **********************************************************************/
2575 /* Set frame being updated via frame-based redisplay to F. This
2576 function must be called before updates to make explicit that we are
2577 working on frame matrices or not. */
2580 set_frame_matrix_frame (struct frame
*f
)
2582 frame_matrix_frame
= f
;
2586 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2587 DESIRED_MATRIX is the desired matrix corresponding to
2588 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2589 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2590 frame_matrix_frame is non-null, this indicates that the exchange is
2591 done in frame matrices, and that we have to perform analogous
2592 operations in window matrices of frame_matrix_frame. */
2595 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2597 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2598 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2599 bool mouse_face_p
= current_row
->mouse_face_p
;
2601 /* Do current_row = desired_row. This exchanges glyph pointers
2602 between both rows, and does a structure assignment otherwise. */
2603 assign_row (current_row
, desired_row
);
2605 /* Enable current_row to mark it as valid. */
2606 current_row
->enabled_p
= true;
2607 current_row
->mouse_face_p
= mouse_face_p
;
2609 /* If we are called on frame matrices, perform analogous operations
2610 for window matrices. */
2611 if (frame_matrix_frame
)
2612 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2616 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2617 W's frame which has been made current (by swapping pointers between
2618 current and desired matrix). Perform analogous operations in the
2619 matrices of leaf windows in the window tree rooted at W. */
2622 mirror_make_current (struct window
*w
, int frame_row
)
2626 if (WINDOWP (w
->contents
))
2627 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2630 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2631 here because the checks performed in debug mode there
2632 will not allow the conversion. */
2633 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2635 /* If FRAME_ROW is within W, assign the desired row to the
2636 current row (exchanging glyph pointers). */
2637 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2639 struct glyph_row
*current_row
2640 = MATRIX_ROW (w
->current_matrix
, row
);
2641 struct glyph_row
*desired_row
2642 = MATRIX_ROW (w
->desired_matrix
, row
);
2644 if (desired_row
->enabled_p
)
2645 assign_row (current_row
, desired_row
);
2647 swap_glyph_pointers (desired_row
, current_row
);
2648 current_row
->enabled_p
= true;
2650 /* Set the Y coordinate of the mode/header line's row.
2651 It is needed in draw_row_with_mouse_face to find the
2652 screen coordinates. (Window-based redisplay sets
2653 this in update_window, but no one seems to do that
2654 for frame-based redisplay.) */
2655 if (current_row
->mode_line_p
)
2656 current_row
->y
= row
;
2660 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2665 /* Perform row dance after scrolling. We are working on the range of
2666 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2667 including) in MATRIX. COPY_FROM is a vector containing, for each
2668 row I in the range 0 <= I < NLINES, the index of the original line
2669 to move to I. This index is relative to the row range, i.e. 0 <=
2670 index < NLINES. RETAINED_P is a vector containing zero for each
2671 row 0 <= I < NLINES which is empty.
2673 This function is called from do_scrolling and do_direct_scrolling. */
2676 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2677 int *copy_from
, char *retained_p
)
2679 /* A copy of original rows. */
2680 struct glyph_row
*old_rows
;
2682 /* Rows to assign to. */
2683 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2687 /* Make a copy of the original rows. */
2688 old_rows
= alloca (nlines
* sizeof *old_rows
);
2689 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2691 /* Assign new rows, maybe clear lines. */
2692 for (i
= 0; i
< nlines
; ++i
)
2694 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2696 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2697 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2698 new_rows
[i
] = old_rows
[copy_from
[i
]];
2699 new_rows
[i
].enabled_p
= enabled_before_p
;
2701 /* RETAINED_P is zero for empty lines. */
2702 if (!retained_p
[copy_from
[i
]])
2703 new_rows
[i
].enabled_p
= false;
2706 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2707 if (frame_matrix_frame
)
2708 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2709 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2713 /* Synchronize glyph pointers in the current matrix of window W with
2714 the current frame matrix. */
2717 sync_window_with_frame_matrix_rows (struct window
*w
)
2719 struct frame
*f
= XFRAME (w
->frame
);
2720 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2721 int left
, right
, x
, width
;
2723 /* Preconditions: W must be a live window on a tty frame. */
2724 eassert (BUFFERP (w
->contents
));
2725 eassert (!FRAME_WINDOW_P (f
));
2727 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2728 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2729 x
= w
->current_matrix
->matrix_x
;
2730 width
= w
->current_matrix
->matrix_w
;
2732 window_row
= w
->current_matrix
->rows
;
2733 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2734 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2736 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2738 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2739 = frame_row
->glyphs
[0] + x
;
2740 window_row
->glyphs
[TEXT_AREA
]
2741 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2742 window_row
->glyphs
[LAST_AREA
]
2743 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2744 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2745 = window_row
->glyphs
[LAST_AREA
] - right
;
2750 /* Return the window in the window tree rooted in W containing frame
2751 row ROW. Value is null if none is found. */
2753 static struct window
*
2754 frame_row_to_window (struct window
*w
, int row
)
2756 struct window
*found
= NULL
;
2760 if (WINDOWP (w
->contents
))
2761 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2762 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2763 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2766 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2773 /* Perform a line dance in the window tree rooted at W, after
2774 scrolling a frame matrix in mirrored_line_dance.
2776 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2777 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2778 COPY_FROM is a vector containing, for each row I in the range 0 <=
2779 I < NLINES, the index of the original line to move to I. This
2780 index is relative to the row range, i.e. 0 <= index < NLINES.
2781 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2785 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2789 if (WINDOWP (w
->contents
))
2790 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2791 nlines
, copy_from
, retained_p
);
2794 /* W is a leaf window, and we are working on its current
2796 struct glyph_matrix
*m
= w
->current_matrix
;
2799 struct glyph_row
*old_rows
;
2801 /* Make a copy of the original rows of matrix m. */
2802 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2803 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2805 for (i
= 0; i
< nlines
; ++i
)
2807 /* Frame relative line assigned to. */
2808 int frame_to
= i
+ unchanged_at_top
;
2810 /* Frame relative line assigned. */
2811 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2813 /* Window relative line assigned to. */
2814 int window_to
= frame_to
- m
->matrix_y
;
2816 /* Window relative line assigned. */
2817 int window_from
= frame_from
- m
->matrix_y
;
2819 /* Is assigned line inside window? */
2820 bool from_inside_window_p
2821 = window_from
>= 0 && window_from
< m
->matrix_h
;
2823 /* Is assigned to line inside window? */
2824 bool to_inside_window_p
2825 = window_to
>= 0 && window_to
< m
->matrix_h
;
2827 if (from_inside_window_p
&& to_inside_window_p
)
2829 /* Do the assignment. The enabled_p flag is saved
2830 over the assignment because the old redisplay did
2832 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2833 m
->rows
[window_to
] = old_rows
[window_from
];
2834 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2836 /* If frame line is empty, window line is empty, too. */
2837 if (!retained_p
[copy_from
[i
]])
2838 m
->rows
[window_to
].enabled_p
= false;
2840 else if (to_inside_window_p
)
2842 /* A copy between windows. This is an infrequent
2843 case not worth optimizing. */
2844 struct frame
*f
= XFRAME (w
->frame
);
2845 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2847 struct glyph_matrix
*m2
;
2850 w2
= frame_row_to_window (root
, frame_from
);
2851 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2852 -nw', FROM_FRAME sometimes has no associated window.
2853 This check avoids a segfault if W2 is null. */
2856 m2
= w2
->current_matrix
;
2857 m2_from
= frame_from
- m2
->matrix_y
;
2858 copy_row_except_pointers (m
->rows
+ window_to
,
2859 m2
->rows
+ m2_from
);
2861 /* If frame line is empty, window line is empty, too. */
2862 if (!retained_p
[copy_from
[i
]])
2863 m
->rows
[window_to
].enabled_p
= false;
2867 else if (from_inside_window_p
)
2871 /* If there was a copy between windows, make sure glyph
2872 pointers are in sync with the frame matrix. */
2874 sync_window_with_frame_matrix_rows (w
);
2876 /* Check that no pointers are lost. */
2880 /* Next window on same level. */
2881 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2888 /* Check that window and frame matrices agree about their
2889 understanding where glyphs of the rows are to find. For each
2890 window in the window tree rooted at W, check that rows in the
2891 matrices of leaf window agree with their frame matrices about
2895 check_window_matrix_pointers (struct window
*w
)
2899 if (WINDOWP (w
->contents
))
2900 check_window_matrix_pointers (XWINDOW (w
->contents
));
2903 struct frame
*f
= XFRAME (w
->frame
);
2904 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2905 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2908 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2913 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2914 a window and FRAME_MATRIX is the corresponding frame matrix. For
2915 each row in WINDOW_MATRIX check that it's a slice of the
2916 corresponding frame row. If it isn't, abort. */
2919 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2920 struct glyph_matrix
*frame_matrix
)
2922 /* Row number in WINDOW_MATRIX. */
2925 /* Row number corresponding to I in FRAME_MATRIX. */
2926 int j
= window_matrix
->matrix_y
;
2928 /* For all rows check that the row in the window matrix is a
2929 slice of the row in the frame matrix. If it isn't we didn't
2930 mirror an operation on the frame matrix correctly. */
2931 while (i
< window_matrix
->nrows
)
2933 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2934 frame_matrix
->rows
+ j
))
2940 #endif /* GLYPH_DEBUG */
2944 /**********************************************************************
2945 VPOS and HPOS translations
2946 **********************************************************************/
2950 /* Translate vertical position VPOS which is relative to window W to a
2951 vertical position relative to W's frame. */
2954 window_to_frame_vpos (struct window
*w
, int vpos
)
2956 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2957 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2958 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2959 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
2964 /* Translate horizontal position HPOS which is relative to window W to
2965 a horizontal position relative to W's frame. */
2968 window_to_frame_hpos (struct window
*w
, int hpos
)
2970 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2971 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2975 #endif /* GLYPH_DEBUG */
2979 /**********************************************************************
2981 **********************************************************************/
2983 /* Redraw frame F. */
2986 redraw_frame (struct frame
*f
)
2988 /* Error if F has no glyphs. */
2989 eassert (f
->glyphs_initialized_p
);
2991 if (FRAME_MSDOS_P (f
))
2992 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
2994 clear_current_matrices (f
);
2996 windows_or_buffers_changed
= 13;
2997 /* Mark all windows as inaccurate, so that every window will have
2998 its redisplay done. */
2999 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3000 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), true);
3001 f
->garbaged
= false;
3004 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3005 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3006 If FRAME is omitted or nil, the selected frame is used. */)
3009 redraw_frame (decode_live_frame (frame
));
3013 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3014 doc
: /* Clear and redisplay all visible frames. */)
3017 Lisp_Object tail
, frame
;
3019 FOR_EACH_FRAME (tail
, frame
)
3020 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3021 redraw_frame (XFRAME (frame
));
3028 /***********************************************************************
3030 ***********************************************************************/
3032 /* Update frame F based on the data in desired matrices.
3034 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3035 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3037 Value is true if redisplay was stopped due to pending input. */
3040 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3042 /* True means display has been paused because of pending input. */
3044 struct window
*root_window
= XWINDOW (f
->root_window
);
3046 if (redisplay_dont_pause
)
3048 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3054 if (FRAME_WINDOW_P (f
))
3056 /* We are working on window matrix basis. All windows whose
3057 flag must_be_updated_p is set have to be updated. */
3059 /* Record that we are not working on frame matrices. */
3060 set_frame_matrix_frame (NULL
);
3062 /* Update all windows in the window tree of F, maybe stopping
3063 when pending input is detected. */
3066 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3067 /* Update the menu bar on X frames that don't have toolkit
3069 if (WINDOWP (f
->menu_bar_window
))
3070 update_window (XWINDOW (f
->menu_bar_window
), 1);
3073 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3074 /* Update the tool-bar window, if present. */
3075 if (WINDOWP (f
->tool_bar_window
))
3077 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3079 /* Update tool-bar window. */
3080 if (w
->must_be_updated_p
)
3084 update_window (w
, 1);
3085 w
->must_be_updated_p
= false;
3087 /* Swap tool-bar strings. We swap because we want to
3089 tem
= f
->current_tool_bar_string
;
3090 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3091 fset_desired_tool_bar_string (f
, tem
);
3096 /* Update windows. */
3097 paused_p
= update_window_tree (root_window
, force_p
);
3102 /* We are working on frame matrix basis. Set the frame on whose
3103 frame matrix we operate. */
3104 set_frame_matrix_frame (f
);
3106 /* Build F's desired matrix from window matrices. */
3107 build_frame_matrix (f
);
3109 /* Update the display */
3111 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
, 1);
3114 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3116 if (FRAME_TTY (f
)->termscript
)
3117 fflush (FRAME_TTY (f
)->termscript
);
3118 if (FRAME_TERMCAP_P (f
))
3119 fflush (FRAME_TTY (f
)->output
);
3122 /* Check window matrices for lost pointers. */
3124 check_window_matrix_pointers (root_window
);
3125 add_frame_display_history (f
, paused_p
);
3130 /* Reset flags indicating that a window should be updated. */
3131 set_window_update_flags (root_window
, false);
3133 display_completed
= !paused_p
;
3137 /* Update a TTY frame F that has a menu dropped down over some of its
3138 glyphs. This is like the second part of update_frame, but it
3139 doesn't call build_frame_matrix, because we already have the
3140 desired matrix prepared, and don't want it to be overwritten by the
3141 text of the normal display.
3143 ROW and COL, if non-negative, are the row and column of the TTY
3144 frame where to position the cursor after the frame update is
3145 complete. Negative values mean ask update_frame_1 to position the
3146 cursor "normally", i.e. at point in the selected window. */
3148 update_frame_with_menu (struct frame
*f
, int row
, int col
)
3150 struct window
*root_window
= XWINDOW (f
->root_window
);
3151 bool paused_p
, cursor_at_point_p
;
3153 eassert (FRAME_TERMCAP_P (f
));
3155 /* We are working on frame matrix basis. Set the frame on whose
3156 frame matrix we operate. */
3157 set_frame_matrix_frame (f
);
3159 /* Update the display. */
3161 cursor_at_point_p
= !(row
>= 0 && col
>= 0);
3162 /* Force update_frame_1 not to stop due to pending input, and not
3164 paused_p
= update_frame_1 (f
, 1, 1, cursor_at_point_p
);
3165 /* ROW and COL tell us where in the menu to position the cursor, so
3166 that screen readers know the active region on the screen. */
3167 if (!cursor_at_point_p
)
3168 cursor_to (f
, row
, col
);
3171 if (FRAME_TTY (f
)->termscript
)
3172 fflush (FRAME_TTY (f
)->termscript
);
3173 fflush (FRAME_TTY (f
)->output
);
3174 /* Check window matrices for lost pointers. */
3177 /* We cannot possibly survive the matrix pointers check, since
3178 we have overwritten parts of the frame glyph matrix without
3179 making any updates to the window matrices. */
3180 check_window_matrix_pointers (root_window
);
3182 add_frame_display_history (f
, paused_p
);
3185 /* Reset flags indicating that a window should be updated. */
3186 set_window_update_flags (root_window
, false);
3187 display_completed
= !paused_p
;
3191 /************************************************************************
3192 Window-based updates
3193 ************************************************************************/
3195 /* Perform updates in window tree rooted at W.
3196 If FORCE_P, don't stop updating if input is pending. */
3199 update_window_tree (struct window
*w
, bool force_p
)
3203 while (w
&& !paused_p
)
3205 if (WINDOWP (w
->contents
))
3206 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3207 else if (w
->must_be_updated_p
)
3208 paused_p
|= update_window (w
, force_p
);
3210 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3217 /* Update window W if its flag must_be_updated_p is set.
3218 If FORCE_P, don't stop updating if input is pending. */
3221 update_single_window (struct window
*w
, bool force_p
)
3223 if (w
->must_be_updated_p
)
3225 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3227 /* Record that this is not a frame-based redisplay. */
3228 set_frame_matrix_frame (NULL
);
3230 if (redisplay_dont_pause
)
3235 update_window (w
, force_p
);
3238 /* Reset flag in W. */
3239 w
->must_be_updated_p
= false;
3243 #ifdef HAVE_WINDOW_SYSTEM
3245 /* Redraw lines from the current matrix of window W that are
3246 overlapped by other rows. YB is bottom-most y-position in W. */
3249 redraw_overlapped_rows (struct window
*w
, int yb
)
3252 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3254 /* If rows overlapping others have been changed, the rows being
3255 overlapped have to be redrawn. This won't draw lines that have
3256 already been drawn in update_window_line because overlapped_p in
3257 desired rows is 0, so after row assignment overlapped_p in
3258 current rows is 0. */
3259 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3261 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3263 if (!row
->enabled_p
)
3265 else if (row
->mode_line_p
)
3268 if (row
->overlapped_p
)
3270 enum glyph_row_area area
;
3272 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3274 output_cursor_to (w
, i
, 0, row
->y
,
3275 area
== TEXT_AREA
? row
->x
: 0);
3276 if (row
->used
[area
])
3277 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3278 area
, row
->used
[area
]);
3279 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3282 row
->overlapped_p
= 0;
3285 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3291 /* Redraw lines from the current matrix of window W that overlap
3292 others. YB is bottom-most y-position in W. */
3295 redraw_overlapping_rows (struct window
*w
, int yb
)
3298 struct glyph_row
*row
;
3299 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3301 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3303 row
= w
->current_matrix
->rows
+ i
;
3305 if (!row
->enabled_p
)
3307 else if (row
->mode_line_p
)
3310 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3312 if (row
->overlapping_p
)
3316 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3317 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3318 overlaps
|= OVERLAPS_PRED
;
3319 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3320 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3321 overlaps
|= OVERLAPS_SUCC
;
3325 if (row
->used
[LEFT_MARGIN_AREA
])
3326 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3328 if (row
->used
[TEXT_AREA
])
3329 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3331 if (row
->used
[RIGHT_MARGIN_AREA
])
3332 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3334 /* Record in neighbor rows that ROW overwrites part of
3336 if (overlaps
& OVERLAPS_PRED
)
3337 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3338 if (overlaps
& OVERLAPS_SUCC
)
3339 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3348 #endif /* HAVE_WINDOW_SYSTEM */
3351 #if defined GLYPH_DEBUG && 0
3353 /* Check that no row in the current matrix of window W is enabled
3354 which is below what's displayed in the window. */
3357 check_current_matrix_flags (struct window
*w
)
3359 bool last_seen_p
= 0;
3360 int i
, yb
= window_text_bottom_y (w
);
3362 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3364 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3365 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3367 else if (last_seen_p
&& row
->enabled_p
)
3372 #endif /* GLYPH_DEBUG */
3375 /* Update display of window W.
3376 If FORCE_P, don't stop updating when input is pending. */
3379 update_window (struct window
*w
, bool force_p
)
3381 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3383 int preempt_count
= baud_rate
/ 2400 + 1;
3384 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3386 /* Check that W's frame doesn't have glyph matrices. */
3387 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3390 /* Check pending input the first time so that we can quickly return. */
3392 detect_input_pending_ignore_squeezables ();
3394 /* If forced to complete the update, or if no input is pending, do
3396 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3398 struct glyph_row
*row
, *end
;
3399 struct glyph_row
*mode_line_row
;
3400 struct glyph_row
*header_line_row
;
3402 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3405 rif
->update_window_begin_hook (w
);
3406 yb
= window_text_bottom_y (w
);
3407 row
= MATRIX_ROW (desired_matrix
, 0);
3408 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3410 /* Take note of the header line, if there is one. We will
3411 update it below, after updating all of the window's lines. */
3412 if (row
->mode_line_p
)
3414 header_line_row
= row
;
3418 header_line_row
= NULL
;
3420 /* Update the mode line, if necessary. */
3421 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3422 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3424 mode_line_row
->y
= yb
;
3425 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3427 &mouse_face_overwritten_p
);
3430 /* Find first enabled row. Optimizations in redisplay_internal
3431 may lead to an update with only one row enabled. There may
3432 be also completely empty matrices. */
3433 while (row
< end
&& !row
->enabled_p
)
3436 /* Try reusing part of the display by copying. */
3437 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3439 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3442 /* All rows were found to be equal. */
3448 /* We've scrolled the display. */
3454 /* Update the rest of the lines. */
3455 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3456 /* scrolling_window resets the enabled_p flag of the rows it
3457 reuses from current_matrix. */
3460 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3463 /* We'll have to play a little bit with when to
3464 detect_input_pending. If it's done too often,
3465 scrolling large windows with repeated scroll-up
3466 commands will too quickly pause redisplay. */
3467 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3468 detect_input_pending_ignore_squeezables ();
3469 changed_p
|= update_window_line (w
, vpos
,
3470 &mouse_face_overwritten_p
);
3472 /* Mark all rows below the last visible one in the current
3473 matrix as invalid. This is necessary because of
3474 variable line heights. Consider the case of three
3475 successive redisplays, where the first displays 5
3476 lines, the second 3 lines, and the third 5 lines again.
3477 If the second redisplay wouldn't mark rows in the
3478 current matrix invalid, the third redisplay might be
3479 tempted to optimize redisplay based on lines displayed
3480 in the first redisplay. */
3481 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3482 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3483 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, i
, false);
3486 /* Was display preempted? */
3487 paused_p
= row
< end
;
3491 /* Update the header line after scrolling because a new header
3492 line would otherwise overwrite lines at the top of the window
3493 that can be scrolled. */
3494 if (header_line_row
&& header_line_row
->enabled_p
)
3496 header_line_row
->y
= 0;
3497 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3500 /* Fix the appearance of overlapping/overlapped rows. */
3501 if (!paused_p
&& !w
->pseudo_window_p
)
3503 #ifdef HAVE_WINDOW_SYSTEM
3504 if (changed_p
&& rif
->fix_overlapping_area
)
3506 redraw_overlapped_rows (w
, yb
);
3507 redraw_overlapping_rows (w
, yb
);
3511 /* Make cursor visible at cursor position of W. */
3512 set_window_cursor_after_update (w
);
3514 #if 0 /* Check that current matrix invariants are satisfied. This is
3515 for debugging only. See the comment of check_matrix_invariants. */
3516 IF_DEBUG (check_matrix_invariants (w
));
3521 /* Remember the redisplay method used to display the matrix. */
3522 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3525 #ifdef HAVE_WINDOW_SYSTEM
3526 update_window_fringes (w
, 0);
3529 /* End the update of window W. Don't set the cursor if we
3530 paused updating the display because in this case,
3531 set_window_cursor_after_update hasn't been called, and
3532 W->output_cursor doesn't contain the cursor location. */
3533 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3539 /* check_current_matrix_flags (w); */
3540 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3543 clear_glyph_matrix (desired_matrix
);
3549 /* Update the display of area AREA in window W, row number VPOS.
3550 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3553 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3554 enum glyph_row_area area
, int vpos
)
3556 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3557 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3559 /* Set cursor to start of glyphs, write them, and clear to the end
3560 of the area. I don't think that something more sophisticated is
3561 necessary here, since marginal areas will not be the default. */
3562 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3563 if (desired_row
->used
[area
])
3564 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3565 area
, desired_row
->used
[area
]);
3566 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3570 /* Update the display of the text area of row VPOS in window W.
3571 Value is true if display has changed. */
3574 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3576 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3577 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3578 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3581 /* If rows are at different X or Y, or rows have different height,
3582 or the current row is marked invalid, write the entire line. */
3583 if (!current_row
->enabled_p
3584 || desired_row
->y
!= current_row
->y
3585 || desired_row
->ascent
!= current_row
->ascent
3586 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3587 || desired_row
->phys_height
!= current_row
->phys_height
3588 || desired_row
->visible_height
!= current_row
->visible_height
3589 || current_row
->overlapped_p
3590 /* This next line is necessary for correctly redrawing
3591 mouse-face areas after scrolling and other operations.
3592 However, it causes excessive flickering when mouse is moved
3593 across the mode line. Luckily, turning it off for the mode
3594 line doesn't seem to hurt anything. -- cyd.
3595 But it is still needed for the header line. -- kfs. */
3596 || (current_row
->mouse_face_p
3597 && !(current_row
->mode_line_p
&& vpos
> 0))
3598 || current_row
->x
!= desired_row
->x
)
3600 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3602 if (desired_row
->used
[TEXT_AREA
])
3603 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3604 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3606 /* Clear to end of window. */
3607 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3610 /* This erases the cursor. We do this here because
3611 notice_overwritten_cursor cannot easily check this, which
3612 might indicate that the whole functionality of
3613 notice_overwritten_cursor would better be implemented here.
3614 On the other hand, we need notice_overwritten_cursor as long
3615 as mouse highlighting is done asynchronously outside of
3617 if (vpos
== w
->phys_cursor
.vpos
)
3618 w
->phys_cursor_on_p
= 0;
3623 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3624 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3625 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3626 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3627 bool abort_skipping
= 0;
3629 /* If the desired row extends its face to the text area end, and
3630 unless the current row also does so at the same position,
3631 make sure we write at least one glyph, so that the face
3632 extension actually takes place. */
3633 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3634 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3635 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3636 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3639 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3643 /* Loop over glyphs that current and desired row may have
3647 bool can_skip_p
= !abort_skipping
;
3649 /* Skip over glyphs that both rows have in common. These
3650 don't have to be written. We can't skip if the last
3651 current glyph overlaps the glyph to its right. For
3652 example, consider a current row of `if ' with the `f' in
3653 Courier bold so that it overlaps the ` ' to its right.
3654 If the desired row is ` ', we would skip over the space
3655 after the `if' and there would remain a pixel from the
3656 `f' on the screen. */
3657 if (overlapping_glyphs_p
&& i
> 0)
3659 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3662 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3664 can_skip_p
= (right
== 0 && !abort_skipping
);
3672 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3674 x
+= desired_glyph
->pixel_width
;
3675 ++desired_glyph
, ++current_glyph
, ++i
;
3678 /* Consider the case that the current row contains "xxx
3679 ppp ggg" in italic Courier font, and the desired row
3680 is "xxx ggg". The character `p' has lbearing, `g'
3681 has not. The loop above will stop in front of the
3682 first `p' in the current row. If we would start
3683 writing glyphs there, we wouldn't erase the lbearing
3684 of the `p'. The rest of the lbearing problem is then
3685 taken care of by draw_glyphs. */
3686 if (overlapping_glyphs_p
3688 && i
< current_row
->used
[TEXT_AREA
]
3689 && (current_row
->used
[TEXT_AREA
]
3690 != desired_row
->used
[TEXT_AREA
]))
3694 rif
->get_glyph_overhangs (current_glyph
,
3697 while (left
> 0 && i
> 0)
3699 --i
, --desired_glyph
, --current_glyph
;
3700 x
-= desired_glyph
->pixel_width
;
3701 left
-= desired_glyph
->pixel_width
;
3704 /* Abort the skipping algorithm if we end up before
3705 our starting point, to avoid looping (bug#1070).
3706 This can happen when the lbearing is larger than
3708 abort_skipping
= (i
< start_hpos
);
3712 /* Try to avoid writing the entire rest of the desired row
3713 by looking for a resync point. This mainly prevents
3714 mode line flickering in the case the mode line is in
3715 fixed-pitch font, which it usually will be. */
3716 if (i
< desired_row
->used
[TEXT_AREA
])
3718 int start_x
= x
, start_hpos
= i
;
3719 struct glyph
*start
= desired_glyph
;
3721 bool skip_first_p
= !can_skip_p
;
3723 /* Find the next glyph that's equal again. */
3726 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3729 x
+= desired_glyph
->pixel_width
;
3730 current_x
+= current_glyph
->pixel_width
;
3731 ++desired_glyph
, ++current_glyph
, ++i
;
3735 if (i
== start_hpos
|| x
!= current_x
)
3739 desired_glyph
= start
;
3743 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3744 rif
->write_glyphs (w
, updated_row
, start
,
3745 TEXT_AREA
, i
- start_hpos
);
3750 /* Write the rest. */
3751 if (i
< desired_row
->used
[TEXT_AREA
])
3753 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3754 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3755 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3759 /* Maybe clear to end of line. */
3760 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3762 /* If new row extends to the end of the text area, nothing
3763 has to be cleared, if and only if we did a write_glyphs
3764 above. This is made sure by setting desired_stop_pos
3765 appropriately above. */
3766 eassert (i
< desired_row
->used
[TEXT_AREA
]
3767 || ((desired_row
->used
[TEXT_AREA
]
3768 == current_row
->used
[TEXT_AREA
])
3769 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3771 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3773 /* If old row extends to the end of the text area, clear. */
3774 if (i
>= desired_row
->used
[TEXT_AREA
])
3775 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3776 desired_row
->pixel_width
);
3777 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3780 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3782 /* Otherwise clear to the end of the old row. Everything
3783 after that position should be clear already. */
3786 if (i
>= desired_row
->used
[TEXT_AREA
])
3787 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3788 desired_row
->pixel_width
);
3790 /* If cursor is displayed at the end of the line, make sure
3791 it's cleared. Nowadays we don't have a phys_cursor_glyph
3792 with which to erase the cursor (because this method
3793 doesn't work with lbearing/rbearing), so we must do it
3795 if (vpos
== w
->phys_cursor
.vpos
3796 && (desired_row
->reversed_p
3797 ? (w
->phys_cursor
.hpos
< 0)
3798 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3800 w
->phys_cursor_on_p
= 0;
3804 xlim
= current_row
->pixel_width
;
3805 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3814 /* Update row VPOS in window W. Value is true if display has been changed. */
3817 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3819 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3820 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3821 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3824 /* A row can be completely invisible in case a desired matrix was
3825 built with a vscroll and then make_cursor_line_fully_visible shifts
3826 the matrix. Make sure to make such rows current anyway, since
3827 we need the correct y-position, for example, in the current matrix. */
3828 if (desired_row
->mode_line_p
3829 || desired_row
->visible_height
> 0)
3831 eassert (desired_row
->enabled_p
);
3833 /* Update display of the left margin area, if there is one. */
3834 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3837 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3838 /* Setting this flag will ensure the vertical border, if
3839 any, between this window and the one on its left will be
3840 redrawn. This is necessary because updating the left
3841 margin area can potentially draw over the border. */
3842 current_row
->redraw_fringe_bitmaps_p
= 1;
3845 /* Update the display of the text area. */
3846 if (update_text_area (w
, desired_row
, vpos
))
3849 if (current_row
->mouse_face_p
)
3850 *mouse_face_overwritten_p
= 1;
3853 /* Update display of the right margin area, if there is one. */
3854 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3857 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3860 /* Draw truncation marks etc. */
3861 if (!current_row
->enabled_p
3862 || desired_row
->y
!= current_row
->y
3863 || desired_row
->visible_height
!= current_row
->visible_height
3864 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3865 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3866 || current_row
->redraw_fringe_bitmaps_p
3867 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3868 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3869 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3870 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3871 rif
->after_update_window_line_hook (w
, desired_row
);
3874 /* Update current_row from desired_row. */
3875 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3880 /* Set the cursor after an update of window W. This function may only
3881 be called from update_window. */
3884 set_window_cursor_after_update (struct window
*w
)
3886 struct frame
*f
= XFRAME (w
->frame
);
3887 int cx
, cy
, vpos
, hpos
;
3889 /* Not intended for frame matrix updates. */
3890 eassert (FRAME_WINDOW_P (f
));
3892 if (cursor_in_echo_area
3893 && !NILP (echo_area_buffer
[0])
3894 /* If we are showing a message instead of the mini-buffer,
3895 show the cursor for the message instead. */
3896 && XWINDOW (minibuf_window
) == w
3897 && EQ (minibuf_window
, echo_area_window
)
3898 /* These cases apply only to the frame that contains
3899 the active mini-buffer window. */
3900 && FRAME_HAS_MINIBUF_P (f
)
3901 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3903 cx
= cy
= vpos
= hpos
= 0;
3905 if (cursor_in_echo_area
>= 0)
3907 /* If the mini-buffer is several lines high, find the last
3908 line that has any text on it. Note: either all lines
3909 are enabled or none. Otherwise we wouldn't be able to
3911 struct glyph_row
*row
, *last_row
;
3912 struct glyph
*glyph
;
3913 int yb
= window_text_bottom_y (w
);
3916 row
= w
->current_matrix
->rows
;
3917 while (row
->enabled_p
3918 && (last_row
== NULL
3919 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3921 if (row
->used
[TEXT_AREA
]
3922 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3929 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3930 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3932 while (last
> start
&& last
->charpos
< 0)
3935 for (glyph
= start
; glyph
< last
; ++glyph
)
3937 cx
+= glyph
->pixel_width
;
3942 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3950 hpos
= w
->cursor
.hpos
;
3951 vpos
= w
->cursor
.vpos
;
3954 /* Window cursor can be out of sync for horizontally split windows.
3955 Horizontal position is -1 when cursor is on the left fringe. */
3956 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3957 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3958 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3962 /* Set WINDOW->must_be_updated_p to ON_P for all windows in
3963 the window tree rooted at W. */
3966 set_window_update_flags (struct window
*w
, bool on_p
)
3970 if (WINDOWP (w
->contents
))
3971 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3973 w
->must_be_updated_p
= on_p
;
3975 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3981 /***********************************************************************
3982 Window-Based Scrolling
3983 ***********************************************************************/
3985 /* Structure describing rows in scrolling_window. */
3989 /* Number of occurrences of this row in desired and current matrix. */
3990 int old_uses
, new_uses
;
3992 /* Vpos of row in new matrix. */
3993 int new_line_number
;
3995 /* Bucket index of this row_entry in the hash table row_table. */
3998 /* The row described by this entry. */
3999 struct glyph_row
*row
;
4001 /* Hash collision chain. */
4002 struct row_entry
*next
;
4005 /* A pool to allocate row_entry structures from, and the size of the
4006 pool. The pool is reallocated in scrolling_window when we find
4007 that we need a larger one. */
4009 static struct row_entry
*row_entry_pool
;
4010 static ptrdiff_t row_entry_pool_size
;
4012 /* Index of next free entry in row_entry_pool. */
4014 static ptrdiff_t row_entry_idx
;
4016 /* The hash table used during scrolling, and the table's size. This
4017 table is used to quickly identify equal rows in the desired and
4020 static struct row_entry
**row_table
;
4021 static ptrdiff_t row_table_size
;
4023 /* Vectors of pointers to row_entry structures belonging to the
4024 current and desired matrix, and the size of the vectors. */
4026 static struct row_entry
**old_lines
, **new_lines
;
4027 static ptrdiff_t old_lines_size
, new_lines_size
;
4029 /* A pool to allocate run structures from, and its size. */
4031 static struct run
*run_pool
;
4032 static ptrdiff_t runs_size
;
4034 /* A vector of runs of lines found during scrolling. */
4036 static struct run
**runs
;
4038 /* Add glyph row ROW to the scrolling hash table. */
4040 static struct row_entry
*
4041 add_row_entry (struct glyph_row
*row
)
4043 struct row_entry
*entry
;
4044 ptrdiff_t i
= row
->hash
% row_table_size
;
4046 entry
= row_table
[i
];
4047 eassert (entry
|| verify_row_hash (row
));
4048 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4049 entry
= entry
->next
;
4053 entry
= row_entry_pool
+ row_entry_idx
++;
4055 entry
->old_uses
= entry
->new_uses
= 0;
4056 entry
->new_line_number
= 0;
4058 entry
->next
= row_table
[i
];
4059 row_table
[i
] = entry
;
4066 /* Try to reuse part of the current display of W by scrolling lines.
4067 HEADER_LINE_P means W has a header line.
4069 The algorithm is taken from Communications of the ACM, Apr78 "A
4070 Technique for Isolating Differences Between Files." It should take
4073 A short outline of the steps of the algorithm
4075 1. Skip lines equal at the start and end of both matrices.
4077 2. Enter rows in the current and desired matrix into a symbol
4078 table, counting how often they appear in both matrices.
4080 3. Rows that appear exactly once in both matrices serve as anchors,
4081 i.e. we assume that such lines are likely to have been moved.
4083 4. Starting from anchor lines, extend regions to be scrolled both
4084 forward and backward.
4088 -1 if all rows were found to be equal.
4089 0 to indicate that we did not scroll the display, or
4090 1 if we did scroll. */
4093 scrolling_window (struct window
*w
, bool header_line_p
)
4095 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4096 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4097 int yb
= window_text_bottom_y (w
);
4099 int j
, first_old
, first_new
, last_old
, last_new
;
4102 struct row_entry
*entry
;
4103 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4105 /* Skip over rows equal at the start. */
4106 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4108 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4109 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4113 && !d
->redraw_fringe_bitmaps_p
4115 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4116 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4117 && row_equal_p (c
, d
, 1))
4120 d
->enabled_p
= false;
4126 /* Give up if some rows in the desired matrix are not enabled. */
4127 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4130 first_old
= first_new
= i
;
4132 /* Set last_new to the index + 1 of the row that reaches the
4133 bottom boundary in the desired matrix. Give up if we find a
4134 disabled row before we reach the bottom boundary. */
4136 while (i
< desired_matrix
->nrows
- 1)
4140 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4142 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4151 /* Set last_old to the index + 1 of the row that reaches the bottom
4152 boundary in the current matrix. We don't look at the enabled
4153 flag here because we plan to reuse part of the display even if
4154 other parts are disabled. */
4156 while (i
< current_matrix
->nrows
- 1)
4158 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4167 /* Skip over rows equal at the bottom. */
4170 while (i
- 1 > first_new
4171 && j
- 1 > first_old
4172 && MATRIX_ROW_ENABLED_P (current_matrix
, j
- 1)
4173 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4174 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4175 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4176 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4177 MATRIX_ROW (current_matrix
, j
- 1), 1))
4182 /* Nothing to do if all rows are equal. */
4183 if (last_new
== first_new
)
4186 /* Check for integer overflow in size calculation.
4188 If next_almost_prime checks (N) for divisibility by 2..10, then
4189 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4190 So, set next_almost_prime_increment_max to 10.
4192 It's just a coincidence that next_almost_prime_increment_max ==
4193 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4194 13, then next_almost_prime_increment_max would be 14, e.g.,
4195 because next_almost_prime (113) would be 127. */
4197 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4198 enum { next_almost_prime_increment_max
= 10 };
4199 ptrdiff_t row_table_max
=
4200 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4201 - next_almost_prime_increment_max
);
4202 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4203 if (current_nrows_max
< current_matrix
->nrows
)
4204 memory_full (SIZE_MAX
);
4207 /* Reallocate vectors, tables etc. if necessary. */
4209 if (current_matrix
->nrows
> old_lines_size
)
4210 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4211 current_matrix
->nrows
- old_lines_size
,
4212 INT_MAX
, sizeof *old_lines
);
4214 if (desired_matrix
->nrows
> new_lines_size
)
4215 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4216 desired_matrix
->nrows
- new_lines_size
,
4217 INT_MAX
, sizeof *new_lines
);
4219 n
= desired_matrix
->nrows
;
4220 n
+= current_matrix
->nrows
;
4221 if (row_table_size
< 3 * n
)
4223 ptrdiff_t size
= next_almost_prime (3 * n
);
4224 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4225 row_table_size
= size
;
4226 memset (row_table
, 0, size
* sizeof *row_table
);
4229 if (n
> row_entry_pool_size
)
4230 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4231 n
- row_entry_pool_size
,
4232 -1, sizeof *row_entry_pool
);
4234 if (desired_matrix
->nrows
> runs_size
)
4236 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4237 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4238 runs_size
= desired_matrix
->nrows
;
4241 nruns
= run_idx
= 0;
4244 /* Add rows from the current and desired matrix to the hash table
4245 row_hash_table to be able to find equal ones quickly. */
4247 for (i
= first_old
; i
< last_old
; ++i
)
4249 if (MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4251 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4252 old_lines
[i
] = entry
;
4256 old_lines
[i
] = NULL
;
4259 for (i
= first_new
; i
< last_new
; ++i
)
4261 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4262 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4264 entry
->new_line_number
= i
;
4265 new_lines
[i
] = entry
;
4268 /* Identify moves based on lines that are unique and equal
4269 in both matrices. */
4270 for (i
= first_old
; i
< last_old
;)
4272 && old_lines
[i
]->old_uses
== 1
4273 && old_lines
[i
]->new_uses
== 1)
4276 int new_line
= old_lines
[i
]->new_line_number
;
4277 struct run
*run
= run_pool
+ run_idx
++;
4280 run
->current_vpos
= i
;
4281 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4282 run
->desired_vpos
= new_line
;
4283 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4285 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4287 /* Extend backward. */
4290 while (p
> first_old
4292 && old_lines
[p
] == new_lines
[q
])
4294 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4295 --run
->current_vpos
;
4296 --run
->desired_vpos
;
4299 run
->desired_y
-= h
;
4300 run
->current_y
-= h
;
4304 /* Extend forward. */
4309 && old_lines
[p
] == new_lines
[q
])
4311 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4317 /* Insert run into list of all runs. Order runs by copied
4318 pixel lines. Note that we record runs that don't have to
4319 be copied because they are already in place. This is done
4320 because we can avoid calling update_window_line in this
4322 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4324 for (q
= nruns
; q
> p
; --q
)
4325 runs
[q
] = runs
[q
- 1];
4334 /* Do the moves. Do it in a way that we don't overwrite something
4335 we want to copy later on. This is not solvable in general
4336 because there is only one display and we don't have a way to
4337 exchange areas on this display. Example:
4339 +-----------+ +-----------+
4341 +-----------+ --> +-----------+
4343 +-----------+ +-----------+
4345 Instead, prefer bigger moves, and invalidate moves that would
4346 copy from where we copied to. */
4348 for (i
= 0; i
< nruns
; ++i
)
4349 if (runs
[i
]->nrows
> 0)
4351 struct run
*r
= runs
[i
];
4353 /* Copy on the display. */
4354 if (r
->current_y
!= r
->desired_y
)
4356 rif
->clear_window_mouse_face (w
);
4357 rif
->scroll_run_hook (w
, r
);
4360 /* Truncate runs that copy to where we copied to, and
4361 invalidate runs that copy from where we copied to. */
4362 for (j
= nruns
- 1; j
> i
; --j
)
4364 struct run
*p
= runs
[j
];
4365 bool truncated_p
= 0;
4368 && p
->desired_y
< r
->desired_y
+ r
->height
4369 && p
->desired_y
+ p
->height
> r
->desired_y
)
4371 if (p
->desired_y
< r
->desired_y
)
4373 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4374 p
->height
= r
->desired_y
- p
->desired_y
;
4379 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4382 if (p
->nrows
<= nrows_copied
)
4386 int height_copied
= (r
->desired_y
+ r
->height
4389 p
->current_vpos
+= nrows_copied
;
4390 p
->desired_vpos
+= nrows_copied
;
4391 p
->nrows
-= nrows_copied
;
4392 p
->current_y
+= height_copied
;
4393 p
->desired_y
+= height_copied
;
4394 p
->height
-= height_copied
;
4400 if (r
->current_y
!= r
->desired_y
4401 /* The condition below is equivalent to
4402 ((p->current_y >= r->desired_y
4403 && p->current_y < r->desired_y + r->height)
4404 || (p->current_y + p->height > r->desired_y
4405 && (p->current_y + p->height
4406 <= r->desired_y + r->height)))
4407 because we have 0 < p->height <= r->height. */
4408 && p
->current_y
< r
->desired_y
+ r
->height
4409 && p
->current_y
+ p
->height
> r
->desired_y
)
4412 /* Reorder runs by copied pixel lines if truncated. */
4413 if (truncated_p
&& p
->nrows
> 0)
4417 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4419 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4424 /* Assign matrix rows. */
4425 for (j
= 0; j
< r
->nrows
; ++j
)
4427 struct glyph_row
*from
, *to
;
4428 bool to_overlapped_p
;
4430 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4431 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4432 to_overlapped_p
= to
->overlapped_p
;
4433 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4434 assign_row (to
, from
);
4435 /* The above `assign_row' actually does swap, so if we had
4436 an overlap in the copy destination of two runs, then
4437 the second run would assign a previously disabled bogus
4438 row. But thanks to the truncation code in the
4439 preceding for-loop, we no longer have such an overlap,
4440 and thus the assigned row should always be enabled. */
4441 eassert (to
->enabled_p
);
4442 from
->enabled_p
= false;
4443 to
->overlapped_p
= to_overlapped_p
;
4447 /* Clear the hash table, for the next time. */
4448 for (i
= 0; i
< row_entry_idx
; ++i
)
4449 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4451 /* Value is 1 to indicate that we scrolled the display. */
4457 /************************************************************************
4459 ************************************************************************/
4461 /* Update the desired frame matrix of frame F.
4463 FORCE_P means that the update should not be stopped by pending input.
4464 INHIBIT_ID_P means that scrolling by insert/delete should not be tried.
4465 SET_CURSOR_P false means do not set cursor at point in selected window.
4467 Value is true if update was stopped due to pending input. */
4470 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
,
4473 /* Frame matrices to work on. */
4474 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4475 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4478 int preempt_count
= baud_rate
/ 2400 + 1;
4480 eassert (current_matrix
&& desired_matrix
);
4482 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4483 calculate_costs (f
);
4485 if (preempt_count
<= 0)
4488 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4494 /* If we cannot insert/delete lines, it's no use trying it. */
4495 if (!FRAME_LINE_INS_DEL_OK (f
))
4498 /* See if any of the desired lines are enabled; don't compute for
4499 i/d line if just want cursor motion. */
4500 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4501 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4504 /* Try doing i/d line, if not yet inhibited. */
4505 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4506 force_p
|= scrolling (f
);
4508 /* Update the individual lines as needed. Do bottom line first. */
4509 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4510 update_frame_line (f
, desired_matrix
->nrows
- 1);
4512 /* Now update the rest of the lines. */
4513 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4515 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4517 if (FRAME_TERMCAP_P (f
))
4519 /* Flush out every so many lines.
4520 Also flush out if likely to have more than 1k buffered
4521 otherwise. I'm told that some telnet connections get
4522 really screwed by more than 1k output at once. */
4523 FILE *display_output
= FRAME_TTY (f
)->output
;
4526 ptrdiff_t outq
= __fpending (display_output
);
4528 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4529 fflush (display_output
);
4533 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4534 detect_input_pending_ignore_squeezables ();
4536 update_frame_line (f
, i
);
4540 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4542 /* Now just clean up termcap drivers and set cursor, etc. */
4543 if (!pause_p
&& set_cursor_p
)
4545 if ((cursor_in_echo_area
4546 /* If we are showing a message instead of the mini-buffer,
4547 show the cursor for the message instead of for the
4548 (now hidden) mini-buffer contents. */
4549 || (EQ (minibuf_window
, selected_window
)
4550 && EQ (minibuf_window
, echo_area_window
)
4551 && !NILP (echo_area_buffer
[0])))
4552 /* These cases apply only to the frame that contains
4553 the active mini-buffer window. */
4554 && FRAME_HAS_MINIBUF_P (f
)
4555 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4557 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4560 if (cursor_in_echo_area
< 0)
4562 /* Negative value of cursor_in_echo_area means put
4563 cursor at beginning of line. */
4569 /* Positive value of cursor_in_echo_area means put
4570 cursor at the end of the prompt. If the mini-buffer
4571 is several lines high, find the last line that has
4573 row
= FRAME_LINES (f
);
4579 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4581 /* Frame rows are filled up with spaces that
4582 must be ignored here. */
4583 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4585 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4586 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4589 && (last
- 1)->charpos
< 0)
4595 while (row
> top
&& col
== 0);
4597 /* Make sure COL is not out of range. */
4598 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4600 /* If we have another row, advance cursor into it. */
4601 if (row
< FRAME_LINES (f
) - 1)
4603 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4606 /* Otherwise move it back in range. */
4608 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4612 cursor_to (f
, row
, col
);
4616 /* We have only one cursor on terminal frames. Use it to
4617 display the cursor of the selected window. */
4618 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4619 if (w
->cursor
.vpos
>= 0
4620 /* The cursor vpos may be temporarily out of bounds
4621 in the following situation: There is one window,
4622 with the cursor in the lower half of it. The window
4623 is split, and a message causes a redisplay before
4624 a new cursor position has been computed. */
4625 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4627 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4628 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4630 x
+= max (0, w
->left_margin_cols
);
4631 cursor_to (f
, y
, x
);
4638 clear_desired_matrices (f
);
4643 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4646 scrolling (struct frame
*frame
)
4648 int unchanged_at_top
, unchanged_at_bottom
;
4651 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4652 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4653 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4654 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4656 int free_at_end_vpos
= FRAME_LINES (frame
);
4657 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4658 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4660 eassert (current_matrix
);
4662 /* Compute hash codes of all the lines. Also calculate number of
4663 changed lines, number of unchanged lines at the beginning, and
4664 number of unchanged lines at the end. */
4666 unchanged_at_top
= 0;
4667 unchanged_at_bottom
= FRAME_LINES (frame
);
4668 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4670 /* Give up on this scrolling if some old lines are not enabled. */
4671 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4673 old_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (current_matrix
, i
));
4674 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4676 /* This line cannot be redrawn, so don't let scrolling mess it. */
4677 new_hash
[i
] = old_hash
[i
];
4678 #define INFINITY 1000000 /* Taken from scroll.c */
4679 draw_cost
[i
] = INFINITY
;
4683 new_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (desired_matrix
, i
));
4684 draw_cost
[i
] = line_draw_cost (frame
, desired_matrix
, i
);
4687 if (old_hash
[i
] != new_hash
[i
])
4690 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4692 else if (i
== unchanged_at_top
)
4694 old_draw_cost
[i
] = line_draw_cost (frame
, current_matrix
, i
);
4697 /* If changed lines are few, don't allow preemption, don't scroll. */
4698 if ((!FRAME_SCROLL_REGION_OK (frame
)
4699 && changed_lines
< baud_rate
/ 2400)
4700 || unchanged_at_bottom
== FRAME_LINES (frame
))
4703 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4704 - unchanged_at_bottom
);
4706 if (FRAME_SCROLL_REGION_OK (frame
))
4707 free_at_end_vpos
-= unchanged_at_bottom
;
4708 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4709 free_at_end_vpos
= -1;
4711 /* If large window, fast terminal and few lines in common between
4712 current frame and desired frame, don't bother with i/d calc. */
4713 if (!FRAME_SCROLL_REGION_OK (frame
)
4714 && window_size
>= 18 && baud_rate
> 2400
4716 10 * scrolling_max_lines_saved (unchanged_at_top
,
4717 FRAME_LINES (frame
) - unchanged_at_bottom
,
4718 old_hash
, new_hash
, draw_cost
)))
4721 if (window_size
< 2)
4724 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4725 draw_cost
+ unchanged_at_top
- 1,
4726 old_draw_cost
+ unchanged_at_top
- 1,
4727 old_hash
+ unchanged_at_top
- 1,
4728 new_hash
+ unchanged_at_top
- 1,
4729 free_at_end_vpos
- unchanged_at_top
);
4735 /* Count the number of blanks at the start of the vector of glyphs R
4736 which is LEN glyphs long. */
4739 count_blanks (struct glyph
*r
, int len
)
4743 for (i
= 0; i
< len
; ++i
)
4744 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4751 /* Count the number of glyphs in common at the start of the glyph
4752 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4753 of STR2. Value is the number of equal glyphs equal at the start. */
4756 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4758 struct glyph
*p1
= str1
;
4759 struct glyph
*p2
= str2
;
4763 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4770 /* Char insertion/deletion cost vector, from term.c */
4772 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4775 /* Perform a frame-based update on line VPOS in frame FRAME. */
4778 update_frame_line (struct frame
*f
, int vpos
)
4780 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4782 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4783 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4784 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4785 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4786 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4787 bool must_write_whole_line_p
;
4788 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4789 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4790 != FACE_TTY_DEFAULT_BG_COLOR
);
4792 if (colored_spaces_p
)
4795 /* Current row not enabled means it has unknown contents. We must
4796 write the whole desired line in that case. */
4797 must_write_whole_line_p
= !current_row
->enabled_p
;
4798 if (must_write_whole_line_p
)
4805 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4806 olen
= current_row
->used
[TEXT_AREA
];
4808 /* Ignore trailing spaces, if we can. */
4809 if (!write_spaces_p
)
4810 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4814 current_row
->enabled_p
= true;
4815 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4817 /* If desired line is empty, just clear the line. */
4818 if (!desired_row
->enabled_p
)
4824 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4825 nlen
= desired_row
->used
[TEXT_AREA
];
4826 nend
= nbody
+ nlen
;
4828 /* If display line has unknown contents, write the whole line. */
4829 if (must_write_whole_line_p
)
4831 /* Ignore spaces at the end, if we can. */
4832 if (!write_spaces_p
)
4833 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4836 /* Write the contents of the desired line. */
4839 cursor_to (f
, vpos
, 0);
4840 write_glyphs (f
, nbody
, nlen
);
4843 /* Don't call clear_end_of_line if we already wrote the whole
4844 line. The cursor will not be at the right margin in that
4845 case but in the line below. */
4846 if (nlen
< FRAME_TOTAL_COLS (f
))
4848 cursor_to (f
, vpos
, nlen
);
4849 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4852 /* Make sure we are in the right row, otherwise cursor movement
4853 with cmgoto might use `ch' in the wrong row. */
4854 cursor_to (f
, vpos
, 0);
4856 make_current (desired_matrix
, current_matrix
, vpos
);
4860 /* Pretend trailing spaces are not there at all,
4861 unless for one reason or another we must write all spaces. */
4862 if (!write_spaces_p
)
4863 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4866 /* If there's no i/d char, quickly do the best we can without it. */
4867 if (!FRAME_CHAR_INS_DEL_OK (f
))
4871 /* Find the first glyph in desired row that doesn't agree with
4872 a glyph in the current row, and write the rest from there on. */
4873 for (i
= 0; i
< nlen
; i
++)
4875 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4877 /* Find the end of the run of different glyphs. */
4881 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4882 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4885 /* Output this run of non-matching chars. */
4886 cursor_to (f
, vpos
, i
);
4887 write_glyphs (f
, nbody
+ i
, j
- i
);
4890 /* Now find the next non-match. */
4894 /* Clear the rest of the line, or the non-clear part of it. */
4897 cursor_to (f
, vpos
, nlen
);
4898 clear_end_of_line (f
, olen
);
4901 /* Make current row = desired row. */
4902 make_current (desired_matrix
, current_matrix
, vpos
);
4906 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4907 characters in a row. */
4911 /* If current line is blank, skip over initial spaces, if
4912 possible, and write the rest. */
4916 nsp
= count_blanks (nbody
, nlen
);
4920 cursor_to (f
, vpos
, nsp
);
4921 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4924 /* Exchange contents between current_frame and new_frame. */
4925 make_current (desired_matrix
, current_matrix
, vpos
);
4929 /* Compute number of leading blanks in old and new contents. */
4930 osp
= count_blanks (obody
, olen
);
4931 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4933 /* Compute number of matching chars starting with first non-blank. */
4934 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4935 nbody
+ nsp
, nbody
+ nlen
);
4937 /* Spaces in new match implicit space past the end of old. */
4938 /* A bug causing this to be a no-op was fixed in 18.29. */
4939 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4942 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4946 /* Avoid doing insert/delete char
4947 just cause number of leading spaces differs
4948 when the following text does not match. */
4949 if (begmatch
== 0 && osp
!= nsp
)
4950 osp
= nsp
= min (osp
, nsp
);
4952 /* Find matching characters at end of line */
4955 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4957 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4962 endmatch
= obody
+ olen
- op1
;
4964 /* tem gets the distance to insert or delete.
4965 endmatch is how many characters we save by doing so.
4968 tem
= (nlen
- nsp
) - (olen
- osp
);
4970 && (!FRAME_CHAR_INS_DEL_OK (f
)
4971 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4974 /* nsp - osp is the distance to insert or delete.
4975 If that is nonzero, begmatch is known to be nonzero also.
4976 begmatch + endmatch is how much we save by doing the ins/del.
4980 && (!FRAME_CHAR_INS_DEL_OK (f
)
4981 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
4985 osp
= nsp
= min (osp
, nsp
);
4988 /* Now go through the line, inserting, writing and
4989 deleting as appropriate. */
4993 cursor_to (f
, vpos
, nsp
);
4994 delete_glyphs (f
, osp
- nsp
);
4998 /* If going to delete chars later in line
4999 and insert earlier in the line,
5000 must delete first to avoid losing data in the insert */
5001 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5003 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5004 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5005 olen
= nlen
- (nsp
- osp
);
5007 cursor_to (f
, vpos
, osp
);
5008 insert_glyphs (f
, 0, nsp
- osp
);
5012 tem
= nsp
+ begmatch
+ endmatch
;
5013 if (nlen
!= tem
|| olen
!= tem
)
5015 if (!endmatch
|| nlen
== olen
)
5017 /* If new text being written reaches right margin, there is
5018 no need to do clear-to-eol at the end of this function
5019 (and it would not be safe, since cursor is not going to
5020 be "at the margin" after the text is done). */
5021 if (nlen
== FRAME_TOTAL_COLS (f
))
5024 /* Function write_glyphs is prepared to do nothing
5025 if passed a length <= 0. Check it here to avoid
5026 unnecessary cursor movement. */
5029 cursor_to (f
, vpos
, nsp
+ begmatch
);
5030 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5033 else if (nlen
> olen
)
5035 /* Here, we used to have the following simple code:
5036 ----------------------------------------
5037 write_glyphs (nbody + nsp + begmatch, olen - tem);
5038 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5039 ----------------------------------------
5040 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5041 is a padding glyph. */
5042 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5045 cursor_to (f
, vpos
, nsp
+ begmatch
);
5047 /* Calculate columns we can actually overwrite. */
5048 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5050 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5052 /* If we left columns to be overwritten, we must delete them. */
5053 del
= olen
- tem
- out
;
5055 delete_glyphs (f
, del
);
5057 /* At last, we insert columns not yet written out. */
5058 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5061 else if (olen
> nlen
)
5063 cursor_to (f
, vpos
, nsp
+ begmatch
);
5064 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5065 delete_glyphs (f
, olen
- nlen
);
5071 /* If any unerased characters remain after the new line, erase them. */
5074 cursor_to (f
, vpos
, nlen
);
5075 clear_end_of_line (f
, olen
);
5078 /* Exchange contents between current_frame and new_frame. */
5079 make_current (desired_matrix
, current_matrix
, vpos
);
5084 /***********************************************************************
5085 X/Y Position -> Buffer Position
5086 ***********************************************************************/
5088 /* Determine what's under window-relative pixel position (*X, *Y).
5089 Return the OBJECT (string or buffer) that's there.
5090 Return in *POS the position in that object.
5091 Adjust *X and *Y to character positions.
5092 Return in *DX and *DY the pixel coordinates of the click,
5093 relative to the top left corner of OBJECT, or relative to
5094 the top left corner of the character glyph at (*X, *Y)
5096 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5097 if the coordinates point to an empty area of the display. */
5100 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
)
5103 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5104 struct text_pos startp
;
5106 struct glyph_row
*row
;
5107 #ifdef HAVE_WINDOW_SYSTEM
5108 struct image
*img
= 0;
5111 void *itdata
= NULL
;
5113 /* We used to set current_buffer directly here, but that does the
5114 wrong thing with `face-remapping-alist' (bug#2044). */
5115 Fset_buffer (w
->contents
);
5116 itdata
= bidi_shelve_cache ();
5117 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5118 start_display (&it
, w
, startp
);
5119 /* start_display takes into account the header-line row, but IT's
5120 vpos still counts from the glyph row that includes the window's
5121 start position. Adjust for a possible header-line row. */
5122 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
);
5126 /* First, move to the beginning of the row corresponding to *Y. We
5127 need to be in that row to get the correct value of base paragraph
5128 direction for the text at (*X, *Y). */
5129 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5131 /* TO_X is the pixel position that the iterator will compute for the
5132 glyph at *X. We add it.first_visible_x because iterator
5133 positions include the hscroll. */
5134 to_x
= x0
+ it
.first_visible_x
;
5135 if (it
.bidi_it
.paragraph_dir
== R2L
)
5136 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5137 text area. This is because the iterator, even in R2L
5138 paragraphs, delivers glyphs as if they started at the left
5139 margin of the window. (When we actually produce glyphs for
5140 display, we reverse their order in PRODUCE_GLYPHS, but the
5141 iterator doesn't know about that.) The following line adjusts
5142 the pixel position to the iterator geometry, which is what
5143 move_it_* routines use. (The -1 is because in a window whose
5144 text-area width is W, the rightmost pixel position is W-1, and
5145 it should be mirrored into zero pixel position.) */
5146 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5148 /* Now move horizontally in the row to the glyph under *X. Second
5149 argument is ZV to prevent move_it_in_display_line from matching
5150 based on buffer positions. */
5151 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5152 bidi_unshelve_cache (itdata
, 0);
5154 Fset_buffer (old_current_buffer
);
5156 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5157 *dy
= *y
- it
.current_y
;
5159 string
= w
->contents
;
5160 if (STRINGP (it
.string
))
5163 if (it
.what
== IT_COMPOSITION
5164 && it
.cmp_it
.nchars
> 1
5165 && it
.cmp_it
.reversed_p
)
5167 /* The current display element is a grapheme cluster in a
5168 composition. In that case, we need the position of the first
5169 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5170 it.current points to the last character of the cluster, thus
5171 we must move back to the first character of the same
5173 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5174 if (STRINGP (it
.string
))
5175 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5177 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5178 CHARPOS (pos
->pos
));
5181 #ifdef HAVE_WINDOW_SYSTEM
5182 if (it
.what
== IT_IMAGE
)
5184 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5185 && !NILP (img
->spec
))
5186 *object
= img
->spec
;
5190 if (it
.vpos
< w
->current_matrix
->nrows
5191 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5194 if (it
.hpos
< row
->used
[TEXT_AREA
])
5196 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5197 #ifdef HAVE_WINDOW_SYSTEM
5200 *dy
-= row
->ascent
- glyph
->ascent
;
5201 *dx
+= glyph
->slice
.img
.x
;
5202 *dy
+= glyph
->slice
.img
.y
;
5203 /* Image slices positions are still relative to the entire image */
5204 *width
= img
->width
;
5205 *height
= img
->height
;
5210 *width
= glyph
->pixel_width
;
5211 *height
= glyph
->ascent
+ glyph
->descent
;
5217 *height
= row
->height
;
5222 *width
= *height
= 0;
5225 /* Add extra (default width) columns if clicked after EOL. */
5226 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5228 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5237 /* Value is the string under window-relative coordinates X/Y in the
5238 mode line or header line (PART says which) of window W, or nil if none.
5239 *CHARPOS is set to the position in the string returned. */
5242 mode_line_string (struct window
*w
, enum window_part part
,
5243 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5244 int *dx
, int *dy
, int *width
, int *height
)
5246 struct glyph_row
*row
;
5247 struct glyph
*glyph
, *end
;
5249 Lisp_Object string
= Qnil
;
5251 if (part
== ON_MODE_LINE
)
5252 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5254 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5256 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5258 if (row
->mode_line_p
&& row
->enabled_p
)
5260 /* Find the glyph under X. If we find one with a string object,
5261 it's the one we were looking for. */
5262 glyph
= row
->glyphs
[TEXT_AREA
];
5263 end
= glyph
+ row
->used
[TEXT_AREA
];
5264 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5265 x0
-= glyph
->pixel_width
;
5266 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5269 string
= glyph
->object
;
5270 *charpos
= glyph
->charpos
;
5271 *width
= glyph
->pixel_width
;
5272 *height
= glyph
->ascent
+ glyph
->descent
;
5273 #ifdef HAVE_WINDOW_SYSTEM
5274 if (glyph
->type
== IMAGE_GLYPH
)
5277 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5279 *object
= img
->spec
;
5280 y0
-= row
->ascent
- glyph
->ascent
;
5286 /* Add extra (default width) columns if clicked after EOL. */
5287 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5289 *height
= row
->height
;
5296 *width
= *height
= 0;
5306 /* Value is the string under window-relative coordinates X/Y in either
5307 marginal area, or nil if none. *CHARPOS is set to the position in
5308 the string returned. */
5311 marginal_area_string (struct window
*w
, enum window_part part
,
5312 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5313 int *dx
, int *dy
, int *width
, int *height
)
5315 struct glyph_row
*row
= w
->current_matrix
->rows
;
5316 struct glyph
*glyph
, *end
;
5317 int x0
, y0
, i
, wy
= *y
;
5319 Lisp_Object string
= Qnil
;
5321 if (part
== ON_LEFT_MARGIN
)
5322 area
= LEFT_MARGIN_AREA
;
5323 else if (part
== ON_RIGHT_MARGIN
)
5324 area
= RIGHT_MARGIN_AREA
;
5328 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5329 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5332 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5336 /* Find the glyph under X. If we find one with a string object,
5337 it's the one we were looking for. */
5338 if (area
== RIGHT_MARGIN_AREA
)
5339 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5340 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5341 : WINDOW_FRINGES_WIDTH (w
))
5342 + window_box_width (w
, LEFT_MARGIN_AREA
)
5343 + window_box_width (w
, TEXT_AREA
));
5345 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5346 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5349 glyph
= row
->glyphs
[area
];
5350 end
= glyph
+ row
->used
[area
];
5351 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5352 x0
-= glyph
->pixel_width
;
5353 *x
= glyph
- row
->glyphs
[area
];
5356 string
= glyph
->object
;
5357 *charpos
= glyph
->charpos
;
5358 *width
= glyph
->pixel_width
;
5359 *height
= glyph
->ascent
+ glyph
->descent
;
5360 #ifdef HAVE_WINDOW_SYSTEM
5361 if (glyph
->type
== IMAGE_GLYPH
)
5364 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5366 *object
= img
->spec
;
5367 y0
-= row
->ascent
- glyph
->ascent
;
5368 x0
+= glyph
->slice
.img
.x
;
5369 y0
+= glyph
->slice
.img
.y
;
5375 /* Add extra (default width) columns if clicked after EOL. */
5376 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5378 *height
= row
->height
;
5385 *width
= *height
= 0;
5395 /***********************************************************************
5396 Changing Frame Sizes
5397 ***********************************************************************/
5401 static void deliver_window_change_signal (int);
5404 handle_window_change_signal (int sig
)
5407 struct tty_display_info
*tty
;
5409 /* The frame size change obviously applies to a single
5410 termcap-controlled terminal, but we can't decide which.
5411 Therefore, we resize the frames corresponding to each tty.
5413 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5415 if (! tty
->term_initted
)
5418 /* Suspended tty frames have tty->input == NULL avoid trying to
5423 get_tty_size (fileno (tty
->input
), &width
, &height
);
5425 if (width
> 5 && height
> 2) {
5426 Lisp_Object tail
, frame
;
5428 FOR_EACH_FRAME (tail
, frame
)
5429 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5430 /* Record the new sizes, but don't reallocate the data
5431 structures now. Let that be done later outside of the
5433 change_frame_size (XFRAME (frame
), width
, height
, 0, 1, 0, 0);
5439 deliver_window_change_signal (int sig
)
5441 deliver_process_signal (sig
, handle_window_change_signal
);
5443 #endif /* SIGWINCH */
5446 /* Do any change in frame size that was requested by a signal.
5447 SAFE means this function is called from a place where it is
5448 safe to change frame sizes while a redisplay is in progress. */
5451 do_pending_window_change (bool safe
)
5453 /* If window change signal handler should have run before, run it now. */
5454 if (redisplaying_p
&& !safe
)
5457 while (delayed_size_change
)
5459 Lisp_Object tail
, frame
;
5461 delayed_size_change
= 0;
5463 FOR_EACH_FRAME (tail
, frame
)
5465 struct frame
*f
= XFRAME (frame
);
5467 if (f
->new_height
!= 0 || f
->new_width
!= 0)
5468 change_frame_size (f
, f
->new_width
, f
->new_height
,
5469 0, 0, safe
, f
->new_pixelwise
);
5474 /* Change the frame height and/or width. Values may be given as zero to
5475 indicate no change is to take place.
5477 new_height and new_width refer to the text portion of the frame. It
5478 doesn't matter for new_height, since text and total portion are the
5479 same in that case. But new_width must be enlarged to get the total
5482 If DELAY, assume we're being called from a signal handler, and
5483 queue the change for later - perhaps the next redisplay.
5484 Since this tries to resize windows, we can't call it
5485 from a signal handler.
5487 SAFE means this function is called from a place where it's
5488 safe to change frame sizes while a redisplay is in progress. */
5491 change_frame_size (struct frame
*f
, int new_width
, int new_height
,
5492 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5494 Lisp_Object tail
, frame
;
5496 if (FRAME_MSDOS_P (f
))
5498 /* On MS-DOS, all frames use the same screen, so a change in
5499 size affects all frames. Termcap now supports multiple
5501 FOR_EACH_FRAME (tail
, frame
)
5502 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5503 change_frame_size_1 (XFRAME (frame
), new_width
, new_height
,
5504 pretend
, delay
, safe
, pixelwise
);
5507 change_frame_size_1 (f
, new_width
, new_height
, pretend
, delay
, safe
,
5512 change_frame_size_1 (struct frame
*f
, int new_width
, int new_height
,
5513 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5515 int new_text_width
, new_text_height
, new_root_width
;
5516 int old_root_width
= WINDOW_PIXEL_WIDTH (XWINDOW (FRAME_ROOT_WINDOW (f
)));
5517 int new_cols
, new_lines
;
5518 ptrdiff_t count
= SPECPDL_INDEX ();
5520 /* If we can't deal with the change now, queue it for later. */
5521 if (delay
|| (redisplaying_p
&& !safe
))
5523 f
->new_width
= new_width
;
5524 f
->new_height
= new_height
;
5525 f
->new_pixelwise
= pixelwise
;
5526 delayed_size_change
= 1;
5530 /* This size-change overrides any pending one for this frame. */
5533 f
->new_pixelwise
= 0;
5535 /* If an argument is zero, set it to the current value. */
5538 new_text_width
= (new_width
== 0) ? FRAME_TEXT_WIDTH (f
) : new_width
;
5539 new_text_height
= (new_height
== 0) ? FRAME_TEXT_HEIGHT (f
) : new_height
;
5540 /* Consider rounding here: Currently, the root window can be
5541 larger than the frame in terms of columns/lines. */
5542 new_cols
= new_text_width
/ FRAME_COLUMN_WIDTH (f
);
5543 new_lines
= new_text_height
/ FRAME_LINE_HEIGHT (f
);
5547 new_cols
= (new_width
== 0) ? FRAME_COLS (f
) : new_width
;
5548 new_lines
= (new_height
== 0) ? FRAME_LINES (f
) : new_height
;
5549 new_text_width
= new_cols
* FRAME_COLUMN_WIDTH (f
);
5550 new_text_height
= new_lines
* FRAME_LINE_HEIGHT (f
);
5553 /* Compute width of windows in F. */
5554 /* Round up to the smallest acceptable size. */
5555 check_frame_size (f
, &new_text_width
, &new_text_height
, 1);
5557 /* This is the width of the frame without vertical scroll bars and
5558 fringe columns. Do this after rounding - see discussion of
5560 new_root_width
= (new_text_width
5561 + FRAME_SCROLL_BAR_AREA_WIDTH (f
)
5562 + FRAME_TOTAL_FRINGE_WIDTH (f
));
5563 /* If we're not changing the frame size, quit now. */
5564 /* Frame width may be unchanged but the text portion may change, for
5565 example, fullscreen and remove/add scroll bar. */
5566 if (new_text_height
== FRAME_TEXT_HEIGHT (f
)
5567 && new_text_width
== FRAME_TEXT_WIDTH (f
)
5568 && new_root_width
== old_root_width
5569 && (FRAME_PIXEL_HEIGHT (f
) ==
5570 FRAME_TEXT_TO_PIXEL_HEIGHT (f
, new_text_height
))
5571 && (FRAME_PIXEL_WIDTH (f
) ==
5572 FRAME_TEXT_TO_PIXEL_WIDTH (f
, new_text_width
)))
5578 /* We only can set screen dimensions to certain values supported
5579 by our video hardware. Try to find the smallest size greater
5580 or equal to the requested dimensions. */
5581 dos_set_window_size (&new_lines
, &new_cols
);
5584 if (new_text_height
!= FRAME_TEXT_HEIGHT (f
))
5586 resize_frame_windows (f
, new_text_height
, 0, 1);
5588 /* MSDOS frames cannot PRETEND, as they change frame size by
5589 manipulating video hardware. */
5590 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5591 FrameRows (FRAME_TTY (f
)) = new_lines
;
5594 if (new_text_width
!= FRAME_TEXT_WIDTH (f
)
5595 || new_root_width
!= old_root_width
)
5597 resize_frame_windows (f
, new_root_width
, 1, 1);
5599 /* MSDOS frames cannot PRETEND, as they change frame size by
5600 manipulating video hardware. */
5601 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5602 FrameCols (FRAME_TTY (f
)) = new_cols
;
5604 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5605 if (WINDOWP (f
->tool_bar_window
))
5607 XWINDOW (f
->tool_bar_window
)->total_cols
= new_cols
;
5608 XWINDOW (f
->tool_bar_window
)->pixel_width
= new_root_width
;
5613 SET_FRAME_COLS (f
, new_cols
);
5614 FRAME_LINES (f
) = new_lines
;
5615 FRAME_TEXT_WIDTH (f
) = new_text_width
;
5616 FRAME_TEXT_HEIGHT (f
) = new_text_height
;
5617 FRAME_PIXEL_WIDTH (f
) = FRAME_TEXT_TO_PIXEL_WIDTH (f
, new_text_width
);
5618 FRAME_PIXEL_HEIGHT (f
) = FRAME_TEXT_TO_PIXEL_HEIGHT (f
, new_text_height
);
5621 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5622 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5624 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5626 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5627 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5628 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5629 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5632 adjust_frame_glyphs (f
);
5633 calculate_costs (f
);
5634 SET_FRAME_GARBAGED (f
);
5639 record_unwind_current_buffer ();
5641 run_window_configuration_change_hook (f
);
5643 unbind_to (count
, Qnil
);
5646 /***********************************************************************
5647 Terminal Related Lisp Functions
5648 ***********************************************************************/
5650 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5651 1, 1, "FOpen termscript file: ",
5652 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5653 FILE = nil means just close any termscript file currently open. */)
5656 struct tty_display_info
*tty
;
5658 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5659 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5660 error ("Current frame is not on a tty device");
5664 if (tty
->termscript
!= 0)
5667 fclose (tty
->termscript
);
5668 tty
->termscript
= 0;
5674 file
= Fexpand_file_name (file
, Qnil
);
5675 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5676 if (tty
->termscript
== 0)
5677 report_file_error ("Opening termscript", file
);
5683 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5684 Ssend_string_to_terminal
, 1, 2, 0,
5685 doc
: /* Send STRING to the terminal without alteration.
5686 Control characters in STRING will have terminal-dependent effects.
5688 Optional parameter TERMINAL specifies the tty terminal device to use.
5689 It may be a terminal object, a frame, or nil for the terminal used by
5690 the currently selected frame. In batch mode, STRING is sent to stdout
5691 when TERMINAL is nil. */)
5692 (Lisp_Object string
, Lisp_Object terminal
)
5694 struct terminal
*t
= get_terminal (terminal
, 1);
5697 /* ??? Perhaps we should do something special for multibyte strings here. */
5698 CHECK_STRING (string
);
5702 error ("Unknown terminal device");
5704 if (t
->type
== output_initial
)
5706 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5707 error ("Device %d is not a termcap terminal device", t
->id
);
5710 struct tty_display_info
*tty
= t
->display_info
.tty
;
5713 error ("Terminal is currently suspended");
5715 if (tty
->termscript
)
5717 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5718 fflush (tty
->termscript
);
5722 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5729 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5730 doc
: /* Beep, or flash the screen.
5731 Also, unless an argument is given,
5732 terminate any keyboard macro currently executing. */)
5740 ring_bell (XFRAME (selected_frame
));
5749 bitch_at_user (void)
5753 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5756 = "Keyboard macro terminated by a command ringing the bell";
5757 Fsignal (Quser_error
, list1 (build_string (msg
)));
5760 ring_bell (XFRAME (selected_frame
));
5765 /***********************************************************************
5767 ***********************************************************************/
5769 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5770 doc
: /* Pause, without updating display, for SECONDS seconds.
5771 SECONDS may be a floating-point value, meaning that you can wait for a
5772 fraction of a second. Optional second arg MILLISECONDS specifies an
5773 additional wait period, in milliseconds; this is for backwards compatibility.
5774 \(Not all operating systems support waiting for a fraction of a second.) */)
5775 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5777 double duration
= extract_float (seconds
);
5779 if (!NILP (milliseconds
))
5781 CHECK_NUMBER (milliseconds
);
5782 duration
+= XINT (milliseconds
) / 1000.0;
5787 struct timespec t
= dtotimespec (duration
);
5788 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5789 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5796 /* This is just like wait_reading_process_output, except that
5799 TIMEOUT is number of seconds to wait (float or integer),
5800 or t to wait forever.
5801 READING is true if reading input.
5802 If DISPLAY_OPTION is >0 display process output while waiting.
5803 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5807 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5811 bool do_display
= display_option
> 0;
5813 swallow_events (do_display
);
5815 if ((detect_input_pending_run_timers (do_display
))
5816 || !NILP (Vexecuting_kbd_macro
))
5819 if (display_option
> 1)
5820 redisplay_preserve_echo_area (2);
5822 if (INTEGERP (timeout
))
5824 sec
= XINT (timeout
);
5829 else if (FLOATP (timeout
))
5831 double seconds
= XFLOAT_DATA (timeout
);
5832 if (! (seconds
> 0))
5836 struct timespec t
= dtotimespec (seconds
);
5837 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5841 else if (EQ (timeout
, Qt
))
5847 wrong_type_argument (Qnumberp
, timeout
);
5854 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5857 return detect_input_pending () ? Qnil
: Qt
;
5861 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5862 doc
: /* Perform redisplay.
5863 Optional arg FORCE, if non-nil, prevents redisplay from being
5864 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5865 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5866 preempted by arriving input, so FORCE does nothing.
5868 Return t if redisplay was performed, nil if redisplay was preempted
5869 immediately by pending input. */)
5875 if ((detect_input_pending_run_timers (1)
5876 && NILP (force
) && !redisplay_dont_pause
)
5877 || !NILP (Vexecuting_kbd_macro
))
5880 count
= SPECPDL_INDEX ();
5881 if (!NILP (force
) && !redisplay_dont_pause
)
5882 specbind (Qredisplay_dont_pause
, Qt
);
5883 redisplay_preserve_echo_area (2);
5884 unbind_to (count
, Qnil
);
5890 /***********************************************************************
5891 Other Lisp Functions
5892 ***********************************************************************/
5894 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5895 session's frames, frame names, buffers, buffer-read-only flags, and
5896 buffer-modified-flags. */
5898 static Lisp_Object frame_and_buffer_state
;
5901 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5902 Sframe_or_buffer_changed_p
, 0, 1, 0,
5903 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5904 VARIABLE is a variable name whose value is either nil or a state vector
5905 that will be updated to contain all frames and buffers,
5906 aside from buffers whose names start with space,
5907 along with the buffers' read-only and modified flags. This allows a fast
5908 check to see whether buffer menus might need to be recomputed.
5909 If this function returns non-nil, it updates the internal vector to reflect
5912 If VARIABLE is nil, an internal variable is used. Users should not
5913 pass nil for VARIABLE. */)
5914 (Lisp_Object variable
)
5916 Lisp_Object state
, tail
, frame
, buf
;
5919 if (! NILP (variable
))
5921 CHECK_SYMBOL (variable
);
5922 state
= Fsymbol_value (variable
);
5923 if (! VECTORP (state
))
5927 state
= frame_and_buffer_state
;
5930 FOR_EACH_FRAME (tail
, frame
)
5932 if (idx
== ASIZE (state
))
5934 if (!EQ (AREF (state
, idx
++), frame
))
5936 if (idx
== ASIZE (state
))
5938 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5941 /* Check that the buffer info matches. */
5942 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5944 /* Ignore buffers that aren't included in buffer lists. */
5945 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5947 if (idx
== ASIZE (state
))
5949 if (!EQ (AREF (state
, idx
++), buf
))
5951 if (idx
== ASIZE (state
))
5953 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5955 if (idx
== ASIZE (state
))
5957 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5960 if (idx
== ASIZE (state
))
5962 /* Detect deletion of a buffer at the end of the list. */
5963 if (EQ (AREF (state
, idx
), Qlambda
))
5966 /* Come here if we decide the data has changed. */
5968 /* Count the size we will need.
5969 Start with 1 so there is room for at least one lambda at the end. */
5971 FOR_EACH_FRAME (tail
, frame
)
5973 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5975 /* Reallocate the vector if data has grown to need it,
5976 or if it has shrunk a lot. */
5977 if (! VECTORP (state
)
5978 || n
> ASIZE (state
)
5979 || n
+ 20 < ASIZE (state
) / 2)
5980 /* Add 20 extra so we grow it less often. */
5982 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5983 if (! NILP (variable
))
5984 Fset (variable
, state
);
5986 frame_and_buffer_state
= state
;
5989 /* Record the new data in the (possibly reallocated) vector. */
5991 FOR_EACH_FRAME (tail
, frame
)
5993 ASET (state
, idx
, frame
);
5995 ASET (state
, idx
, XFRAME (frame
)->name
);
5998 FOR_EACH_LIVE_BUFFER (tail
, buf
)
6000 /* Ignore buffers that aren't included in buffer lists. */
6001 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6003 ASET (state
, idx
, buf
);
6005 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
6007 ASET (state
, idx
, Fbuffer_modified_p (buf
));
6010 /* Fill up the vector with lambdas (always at least one). */
6011 ASET (state
, idx
, Qlambda
);
6013 while (idx
< ASIZE (state
))
6015 ASET (state
, idx
, Qlambda
);
6018 /* Make sure we didn't overflow the vector. */
6019 eassert (idx
<= ASIZE (state
));
6025 /***********************************************************************
6027 ***********************************************************************/
6029 /* Initialization done when Emacs fork is started, before doing stty.
6030 Determine terminal type and set terminal_driver. Then invoke its
6031 decoding routine to set up variables in the terminal package. */
6036 char *terminal_type
;
6038 /* Construct the space glyph. */
6039 space_glyph
.type
= CHAR_GLYPH
;
6040 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6041 space_glyph
.charpos
= -1;
6044 cursor_in_echo_area
= 0;
6046 /* Now is the time to initialize this; it's used by init_sys_modes
6048 Vinitial_window_system
= Qnil
;
6050 /* SIGWINCH needs to be handled no matter what display we start
6051 with. Otherwise newly opened tty frames will not resize
6056 #endif /* CANNOT_DUMP */
6058 struct sigaction action
;
6059 emacs_sigaction_init (&action
, deliver_window_change_signal
);
6060 sigaction (SIGWINCH
, &action
, 0);
6062 #endif /* SIGWINCH */
6064 /* If running as a daemon, no need to initialize any frames/terminal. */
6068 /* If the user wants to use a window system, we shouldn't bother
6069 initializing the terminal. This is especially important when the
6070 terminal is so dumb that emacs gives up before and doesn't bother
6071 using the window system.
6073 If the DISPLAY environment variable is set and nonempty,
6074 try to use X, and die with an error message if that doesn't work. */
6076 #ifdef HAVE_X_WINDOWS
6077 if (! inhibit_window_system
&& ! display_arg
)
6080 display
= getenv ("DISPLAY");
6081 display_arg
= (display
!= 0 && *display
!= 0);
6083 if (display_arg
&& !x_display_ok (display
))
6085 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6087 inhibit_window_system
= 1;
6091 if (!inhibit_window_system
&& display_arg
)
6093 Vinitial_window_system
= Qx
;
6095 Vwindow_system_version
= make_number (11);
6098 /* In some versions of ncurses,
6099 tputs crashes if we have not called tgetent.
6101 { char b
[2044]; tgetent (b
, "xterm");}
6105 #endif /* HAVE_X_WINDOWS */
6108 if (!inhibit_window_system
)
6110 Vinitial_window_system
= Qw32
;
6111 Vwindow_system_version
= make_number (1);
6114 #endif /* HAVE_NTGUI */
6117 if (!inhibit_window_system
6123 Vinitial_window_system
= Qns
;
6124 Vwindow_system_version
= make_number (10);
6129 /* If no window system has been specified, try to use the terminal. */
6131 fatal ("standard input is not a tty");
6134 terminal_type
= "w32console";
6136 terminal_type
= getenv ("TERM");
6140 #ifdef HAVE_WINDOW_SYSTEM
6141 if (! inhibit_window_system
)
6142 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6144 #endif /* HAVE_WINDOW_SYSTEM */
6145 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6151 struct frame
*f
= XFRAME (selected_frame
);
6153 init_foreground_group ();
6155 /* Open a display on the controlling tty. */
6156 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6158 /* Convert the initial frame to use the new display. */
6159 if (f
->output_method
!= output_initial
)
6161 f
->output_method
= t
->type
;
6164 t
->reference_count
++;
6166 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6168 if (f
->output_method
== output_termcap
)
6169 create_tty_output (f
);
6171 t
->display_info
.tty
->top_frame
= selected_frame
;
6172 change_frame_size (XFRAME (selected_frame
),
6173 FrameCols (t
->display_info
.tty
),
6174 FrameRows (t
->display_info
.tty
), 0, 0, 1, 0);
6176 /* Delete the initial terminal. */
6177 if (--initial_terminal
->reference_count
== 0
6178 && initial_terminal
->delete_terminal_hook
)
6179 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6181 /* Update frame parameters to reflect the new type. */
6182 Fmodify_frame_parameters
6183 (selected_frame
, list1 (Fcons (Qtty_type
,
6184 Ftty_type (selected_frame
))));
6185 if (t
->display_info
.tty
->name
)
6186 Fmodify_frame_parameters
6188 list1 (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
))));
6190 Fmodify_frame_parameters (selected_frame
, list1 (Fcons (Qtty
, Qnil
)));
6194 struct frame
*sf
= SELECTED_FRAME ();
6195 int width
= FRAME_TOTAL_COLS (sf
);
6196 int height
= FRAME_LINES (sf
);
6198 /* If these sizes are so big they cause overflow, just ignore the
6199 change. It's not clear what better we could do. The rest of
6200 the code assumes that (width + 2) * height * sizeof (struct glyph)
6201 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6202 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6203 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6204 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6205 < (width
+ 2) * height
))
6206 fatal ("screen size %dx%d too big", width
, height
);
6209 calculate_costs (XFRAME (selected_frame
));
6211 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6214 && NILP (Vinitial_window_system
))
6216 /* For the initial frame, we don't have any way of knowing what
6217 are the foreground and background colors of the terminal. */
6218 struct frame
*sf
= SELECTED_FRAME ();
6220 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6221 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6222 call0 (intern ("tty-set-up-initial-frame-faces"));
6228 /***********************************************************************
6230 ***********************************************************************/
6232 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6233 Sinternal_show_cursor
, 2, 2, 0,
6234 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6235 WINDOW nil means use the selected window. SHOW non-nil means
6236 show a cursor in WINDOW in the next redisplay. SHOW nil means
6237 don't show a cursor. */)
6238 (Lisp_Object window
, Lisp_Object show
)
6240 /* Don't change cursor state while redisplaying. This could confuse
6242 if (!redisplaying_p
)
6243 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6248 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6249 Sinternal_show_cursor_p
, 0, 1, 0,
6250 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6251 WINDOW nil or omitted means report on the selected window. */)
6252 (Lisp_Object window
)
6254 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6257 /***********************************************************************
6259 ***********************************************************************/
6262 syms_of_display (void)
6264 defsubr (&Sredraw_frame
);
6265 defsubr (&Sredraw_display
);
6266 defsubr (&Sframe_or_buffer_changed_p
);
6267 defsubr (&Sopen_termscript
);
6269 defsubr (&Sredisplay
);
6270 defsubr (&Ssleep_for
);
6271 defsubr (&Ssend_string_to_terminal
);
6272 defsubr (&Sinternal_show_cursor
);
6273 defsubr (&Sinternal_show_cursor_p
);
6276 defsubr (&Sdump_redisplay_history
);
6279 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6280 staticpro (&frame_and_buffer_state
);
6282 DEFSYM (Qdisplay_table
, "display-table");
6283 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6285 DEFVAR_INT ("baud-rate", baud_rate
,
6286 doc
: /* The output baud rate of the terminal.
6287 On most systems, changing this value will affect the amount of padding
6288 and the other strategic decisions made during redisplay. */);
6290 DEFVAR_BOOL ("inverse-video", inverse_video
,
6291 doc
: /* Non-nil means invert the entire frame display.
6292 This means everything is in inverse video which otherwise would not be. */);
6294 DEFVAR_BOOL ("visible-bell", visible_bell
,
6295 doc
: /* Non-nil means try to flash the frame to represent a bell.
6297 See also `ring-bell-function'. */);
6299 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6300 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6301 A non-nil value is useful if the terminal can automatically preserve
6302 Emacs's frame display when you reenter Emacs.
6303 It is up to you to set this variable if your terminal can do that. */);
6305 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6306 doc
: /* Name of the window system that Emacs uses for the first frame.
6307 The value is a symbol:
6308 nil for a termcap frame (a character-only terminal),
6309 'x' for an Emacs frame that is really an X window,
6310 'w32' for an Emacs frame that is a window on MS-Windows display,
6311 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6312 'pc' for a direct-write MS-DOS frame.
6314 Use of this variable as a boolean is deprecated. Instead,
6315 use `display-graphic-p' or any of the other `display-*-p'
6316 predicates which report frame's specific UI-related capabilities. */);
6318 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6319 doc
: /* Name of window system through which the selected frame is displayed.
6320 The value is a symbol:
6321 nil for a termcap frame (a character-only terminal),
6322 'x' for an Emacs frame that is really an X window,
6323 'w32' for an Emacs frame that is a window on MS-Windows display,
6324 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6325 'pc' for a direct-write MS-DOS frame.
6327 Use of this variable as a boolean is deprecated. Instead,
6328 use `display-graphic-p' or any of the other `display-*-p'
6329 predicates which report frame's specific UI-related capabilities. */);
6331 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6332 doc
: /* The version number of the window system in use.
6333 For X windows, this is 11. */);
6335 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6336 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6338 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6339 doc
: /* Table defining how to output a glyph code to the frame.
6340 If not nil, this is a vector indexed by glyph code to define the glyph.
6341 Each element can be:
6342 integer: a glyph code which this glyph is an alias for.
6343 string: output this glyph using that string (not impl. in X windows).
6344 nil: this glyph mod 524288 is the code of a character to output,
6345 and this glyph / 524288 is the face number (see `face-id') to use
6346 while outputting it. */);
6347 Vglyph_table
= Qnil
;
6349 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6350 doc
: /* Display table to use for buffers that specify none.
6351 See `buffer-display-table' for more information. */);
6352 Vstandard_display_table
= Qnil
;
6354 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6355 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6356 redisplay_dont_pause
= 1;
6362 Vinitial_window_system
= Qnil
;
6363 Vwindow_system_version
= Qnil
;