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
];
1088 /* The real number of glyphs reserved for the margins is
1089 recorded in the glyph matrix, and can be different from
1090 window's left_margin_cols and right_margin_cols; see
1091 margin_glyphs_to_reserve for when that happens. */
1092 int left
= w
->desired_matrix
->left_margin_glyphs
;
1093 int right
= w
->desired_matrix
->right_margin_glyphs
;
1095 /* Make sure the marginal areas of this row are in sync with
1096 what the window wants, when the row actually displays text
1097 and not header/mode line. */
1098 if (w
->left_margin_cols
> 0
1099 && (left
!= row
->glyphs
[TEXT_AREA
] - row
->glyphs
[LEFT_MARGIN_AREA
]))
1100 row
->glyphs
[TEXT_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
1101 if (w
->right_margin_cols
> 0
1102 && (right
!= row
->glyphs
[LAST_AREA
] - row
->glyphs
[RIGHT_MARGIN_AREA
]))
1103 row
->glyphs
[RIGHT_MARGIN_AREA
] = row
->glyphs
[LAST_AREA
] - right
;
1108 /* Return a hash code for glyph row ROW, which may
1109 be from current or desired matrix of frame F. */
1112 line_hash_code (struct frame
*f
, struct glyph_row
*row
)
1118 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1119 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1123 int c
= glyph
->u
.ch
;
1124 int face_id
= glyph
->face_id
;
1125 if (FRAME_MUST_WRITE_SPACES (f
))
1127 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1128 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1140 /* Return the cost of drawing line VPOS in MATRIX, which may
1141 be current or desired matrix of frame F. The cost equals
1142 the number of characters in the line. If must_write_spaces
1143 is zero, leading and trailing spaces are ignored. */
1146 line_draw_cost (struct frame
*f
, struct glyph_matrix
*matrix
, int vpos
)
1148 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1149 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1150 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1152 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1153 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1155 /* Ignore trailing and leading spaces if we can. */
1156 if (!FRAME_MUST_WRITE_SPACES (f
))
1158 /* Skip from the end over trailing spaces. */
1159 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1162 /* All blank line. */
1166 /* Skip over leading spaces. */
1167 while (CHAR_GLYPH_SPACE_P (*beg
))
1171 /* If we don't have a glyph-table, each glyph is one character,
1172 so return the number of glyphs. */
1173 if (glyph_table_base
== 0)
1177 /* Otherwise, scan the glyphs and accumulate their total length
1184 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1186 if (GLYPH_INVALID_P (g
)
1187 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1190 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1200 /* Return true if the glyph rows A and B have equal contents.
1201 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1204 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1206 eassert (verify_row_hash (a
));
1207 eassert (verify_row_hash (b
));
1211 else if (a
->hash
!= b
->hash
)
1215 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1218 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1221 /* Compare glyphs. */
1222 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1224 if (a
->used
[area
] != b
->used
[area
])
1227 a_glyph
= a
->glyphs
[area
];
1228 a_end
= a_glyph
+ a
->used
[area
];
1229 b_glyph
= b
->glyphs
[area
];
1231 while (a_glyph
< a_end
1232 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1233 ++a_glyph
, ++b_glyph
;
1235 if (a_glyph
!= a_end
)
1239 if (a
->fill_line_p
!= b
->fill_line_p
1240 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1241 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1242 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1243 || a
->left_fringe_offset
!= b
->left_fringe_offset
1244 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1245 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1246 || a
->right_fringe_offset
!= b
->right_fringe_offset
1247 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1248 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1249 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1250 || a
->overlapped_p
!= b
->overlapped_p
1251 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1252 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1253 || a
->reversed_p
!= b
->reversed_p
1254 /* Different partially visible characters on left margin. */
1256 /* Different height. */
1257 || a
->ascent
!= b
->ascent
1258 || a
->phys_ascent
!= b
->phys_ascent
1259 || a
->phys_height
!= b
->phys_height
1260 || a
->visible_height
!= b
->visible_height
)
1269 /***********************************************************************
1272 See dispextern.h for an overall explanation of glyph pools.
1273 ***********************************************************************/
1275 /* Allocate a glyph_pool structure. The structure returned is initialized
1276 with zeros. If GLYPH_DEBUG and ENABLE_CHECKING are in effect, the global
1277 variable glyph_pool_count is incremented for each pool allocated. */
1279 static struct glyph_pool
*
1280 new_glyph_pool (void)
1282 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1284 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1285 /* For memory leak and double deletion checking. */
1293 /* Free a glyph_pool structure POOL. The function may be called with
1294 a null POOL pointer. If GLYPH_DEBUG and ENABLE_CHECKING are in effect,
1295 global variable glyph_pool_count is decremented with every pool structure
1296 freed. If this count gets negative, more structures were freed than
1297 allocated, i.e. one structure must have been freed more than once or
1298 a bogus pointer was passed to free_glyph_pool. */
1301 free_glyph_pool (struct glyph_pool
*pool
)
1305 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
1306 /* More freed than allocated? */
1308 eassert (glyph_pool_count
>= 0);
1310 xfree (pool
->glyphs
);
1316 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1317 columns we need. This function never shrinks a pool. The only
1318 case in which this would make sense, would be when a frame's size
1319 is changed from a large value to a smaller one. But, if someone
1320 does it once, we can expect that he will do it again.
1322 Return true if the pool changed in a way which makes
1323 re-adjusting window glyph matrices necessary. */
1326 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1331 changed_p
= (pool
->glyphs
== 0
1332 || matrix_dim
.height
!= pool
->nrows
1333 || matrix_dim
.width
!= pool
->ncolumns
);
1335 /* Enlarge the glyph pool. */
1336 needed
= matrix_dim
.width
;
1337 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1338 memory_full (SIZE_MAX
);
1339 needed
*= matrix_dim
.height
;
1340 if (needed
> pool
->nglyphs
)
1342 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1343 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1344 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1345 memset (pool
->glyphs
+ old_nglyphs
, 0,
1346 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1349 /* Remember the number of rows and columns because (a) we use them
1350 to do sanity checks, and (b) the number of columns determines
1351 where rows in the frame matrix start---this must be available to
1352 determine pointers to rows of window sub-matrices. */
1353 pool
->nrows
= matrix_dim
.height
;
1354 pool
->ncolumns
= matrix_dim
.width
;
1361 /***********************************************************************
1363 ***********************************************************************/
1368 /* Flush standard output. This is sometimes useful to call from the debugger.
1369 XXX Maybe this should be changed to flush the current terminal instead of
1373 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1382 /* Check that no glyph pointers have been lost in MATRIX. If a
1383 pointer has been lost, e.g. by using a structure assignment between
1384 rows, at least one pointer must occur more than once in the rows of
1388 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1392 for (i
= 0; i
< matrix
->nrows
; ++i
)
1393 for (j
= 0; j
< matrix
->nrows
; ++j
)
1395 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1396 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1400 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1403 matrix_row (struct glyph_matrix
*matrix
, int row
)
1405 eassert (matrix
&& matrix
->rows
);
1406 eassert (row
>= 0 && row
< matrix
->nrows
);
1408 /* That's really too slow for normal testing because this function
1409 is called almost everywhere. Although---it's still astonishingly
1410 fast, so it is valuable to have for debugging purposes. */
1412 check_matrix_pointer_lossage (matrix
);
1415 return matrix
->rows
+ row
;
1419 #if 0 /* This function makes invalid assumptions when text is
1420 partially invisible. But it might come handy for debugging
1423 /* Check invariants that must hold for an up to date current matrix of
1427 check_matrix_invariants (struct window
*w
)
1429 struct glyph_matrix
*matrix
= w
->current_matrix
;
1430 int yb
= window_text_bottom_y (w
);
1431 struct glyph_row
*row
= matrix
->rows
;
1432 struct glyph_row
*last_text_row
= NULL
;
1433 struct buffer
*saved
= current_buffer
;
1434 struct buffer
*buffer
= XBUFFER (w
->contents
);
1437 /* This can sometimes happen for a fresh window. */
1438 if (matrix
->nrows
< 2)
1441 set_buffer_temp (buffer
);
1443 /* Note: last row is always reserved for the mode line. */
1444 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1445 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1447 struct glyph_row
*next
= row
+ 1;
1449 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1450 last_text_row
= row
;
1452 /* Check that character and byte positions are in sync. */
1453 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1454 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1455 eassert (BYTEPOS (row
->start
.pos
)
1456 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1458 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1459 have such a position temporarily in case of a minibuffer
1460 displaying something like `[Sole completion]' at its end. */
1461 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1463 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1464 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1465 eassert (BYTEPOS (row
->end
.pos
)
1466 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1469 /* Check that end position of `row' is equal to start position
1471 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1473 eassert (MATRIX_ROW_END_CHARPOS (row
)
1474 == MATRIX_ROW_START_CHARPOS (next
));
1475 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1476 == MATRIX_ROW_START_BYTEPOS (next
));
1477 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1478 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1483 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1484 eassert (w
->desired_matrix
->rows
!= NULL
);
1485 set_buffer_temp (saved
);
1490 #endif /* GLYPH_DEBUG */
1494 /**********************************************************************
1495 Allocating/ Adjusting Glyph Matrices
1496 **********************************************************************/
1498 /* Allocate glyph matrices over a window tree for a frame-based
1501 X and Y are column/row within the frame glyph matrix where
1502 sub-matrices for the window tree rooted at WINDOW must be
1503 allocated. DIM_ONLY_P means that the caller of this
1504 function is only interested in the result matrix dimension, and
1505 matrix adjustments should not be performed.
1507 The function returns the total width/height of the sub-matrices of
1508 the window tree. If called on a frame root window, the computation
1509 will take the mini-buffer window into account.
1511 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1513 NEW_LEAF_MATRIX set if any window in the tree did not have a
1514 glyph matrices yet, and
1516 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1517 any window in the tree will be changed or have been changed (see
1520 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1523 Windows are arranged into chains of windows on the same level
1524 through the next fields of window structures. Such a level can be
1525 either a sequence of horizontally adjacent windows from left to
1526 right, or a sequence of vertically adjacent windows from top to
1527 bottom. Each window in a horizontal sequence can be either a leaf
1528 window or a vertical sequence; a window in a vertical sequence can
1529 be either a leaf or a horizontal sequence. All windows in a
1530 horizontal sequence have the same height, and all windows in a
1531 vertical sequence have the same width.
1533 This function uses, for historical reasons, a more general
1534 algorithm to determine glyph matrix dimensions that would be
1537 The matrix height of a horizontal sequence is determined by the
1538 maximum height of any matrix in the sequence. The matrix width of
1539 a horizontal sequence is computed by adding up matrix widths of
1540 windows in the sequence.
1542 |<------- result width ------->|
1543 +---------+----------+---------+ ---
1546 +---------+ | | result height
1551 The matrix width of a vertical sequence is the maximum matrix width
1552 of any window in the sequence. Its height is computed by adding up
1553 matrix heights of windows in the sequence.
1555 |<---- result width -->|
1563 +------------+---------+ |
1566 +------------+---------+ --- */
1568 /* Bit indicating that a new matrix will be allocated or has been
1571 #define NEW_LEAF_MATRIX (1 << 0)
1573 /* Bit indicating that a matrix will or has changed its location or
1576 #define CHANGED_LEAF_MATRIX (1 << 1)
1579 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1580 bool dim_only_p
, int *window_change_flags
)
1582 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1584 int wmax
= 0, hmax
= 0;
1588 bool in_horz_combination_p
;
1590 /* What combination is WINDOW part of? Compute this once since the
1591 result is the same for all windows in the `next' chain. The
1592 special case of a root window (parent equal to nil) is treated
1593 like a vertical combination because a root window's `next'
1594 points to the mini-buffer window, if any, which is arranged
1595 vertically below other windows. */
1596 in_horz_combination_p
1597 = (!NILP (XWINDOW (window
)->parent
)
1598 && WINDOW_HORIZONTAL_COMBINATION_P (XWINDOW (XWINDOW (window
)->parent
)));
1600 /* For WINDOW and all windows on the same level. */
1603 w
= XWINDOW (window
);
1605 /* Get the dimension of the window sub-matrix for W, depending
1606 on whether this is a combination or a leaf window. */
1607 if (WINDOWP (w
->contents
))
1608 dim
= allocate_matrices_for_frame_redisplay (w
->contents
, x
, y
,
1610 window_change_flags
);
1613 /* If not already done, allocate sub-matrix structures. */
1614 if (w
->desired_matrix
== NULL
)
1616 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1617 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1618 *window_change_flags
|= NEW_LEAF_MATRIX
;
1621 /* Width and height MUST be chosen so that there are no
1622 holes in the frame matrix. */
1623 dim
.width
= required_matrix_width (w
);
1624 dim
.height
= required_matrix_height (w
);
1626 /* Will matrix be re-allocated? */
1627 if (x
!= w
->desired_matrix
->matrix_x
1628 || y
!= w
->desired_matrix
->matrix_y
1629 || dim
.width
!= w
->desired_matrix
->matrix_w
1630 || dim
.height
!= w
->desired_matrix
->matrix_h
1631 || (margin_glyphs_to_reserve (w
, dim
.width
,
1632 w
->left_margin_cols
)
1633 != w
->desired_matrix
->left_margin_glyphs
)
1634 || (margin_glyphs_to_reserve (w
, dim
.width
,
1635 w
->right_margin_cols
)
1636 != w
->desired_matrix
->right_margin_glyphs
))
1637 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1639 /* Actually change matrices, if allowed. Do not consider
1640 CHANGED_LEAF_MATRIX computed above here because the pool
1641 may have been changed which we don't know here. We trust
1642 that we only will be called with DIM_ONLY_P when
1646 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1647 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1651 /* If we are part of a horizontal combination, advance x for
1652 windows to the right of W; otherwise advance y for windows
1654 if (in_horz_combination_p
)
1659 /* Remember maximum glyph matrix dimensions. */
1660 wmax
= max (wmax
, dim
.width
);
1661 hmax
= max (hmax
, dim
.height
);
1663 /* Next window on same level. */
1666 while (!NILP (window
));
1668 /* Set `total' to the total glyph matrix dimension of this window
1669 level. In a vertical combination, the width is the width of the
1670 widest window; the height is the y we finally reached, corrected
1671 by the y we started with. In a horizontal combination, the total
1672 height is the height of the tallest window, and the width is the
1673 x we finally reached, corrected by the x we started with. */
1674 if (in_horz_combination_p
)
1676 total
.width
= x
- x0
;
1677 total
.height
= hmax
;
1682 total
.height
= y
- y0
;
1689 /* Return the required height of glyph matrices for window W. */
1692 required_matrix_height (struct window
*w
)
1694 #ifdef HAVE_WINDOW_SYSTEM
1695 struct frame
*f
= XFRAME (w
->frame
);
1697 if (FRAME_WINDOW_P (f
))
1699 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1700 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1702 return (((window_pixel_height
+ ch_height
- 1)
1703 / ch_height
) * w
->nrows_scale_factor
1704 /* One partially visible line at the top and
1705 bottom of the window. */
1707 /* 2 for header and mode line. */
1710 #endif /* HAVE_WINDOW_SYSTEM */
1712 return WINDOW_TOTAL_LINES (w
);
1716 /* Return the required width of glyph matrices for window W. */
1719 required_matrix_width (struct window
*w
)
1721 #ifdef HAVE_WINDOW_SYSTEM
1722 struct frame
*f
= XFRAME (w
->frame
);
1723 if (FRAME_WINDOW_P (f
))
1725 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1727 /* Compute number of glyphs needed in a glyph row. */
1728 return (((WINDOW_PIXEL_WIDTH (w
) + ch_width
- 1)
1729 / ch_width
) * w
->ncols_scale_factor
1730 /* 2 partially visible columns in the text area. */
1732 /* One partially visible column at the right
1733 edge of each marginal area. */
1736 #endif /* HAVE_WINDOW_SYSTEM */
1738 return w
->total_cols
;
1742 /* Allocate window matrices for window-based redisplay. W is the
1743 window whose matrices must be allocated/reallocated. */
1746 allocate_matrices_for_window_redisplay (struct window
*w
)
1750 if (WINDOWP (w
->contents
))
1751 allocate_matrices_for_window_redisplay (XWINDOW (w
->contents
));
1754 /* W is a leaf window. */
1757 /* If matrices are not yet allocated, allocate them now. */
1758 if (w
->desired_matrix
== NULL
)
1760 w
->desired_matrix
= new_glyph_matrix (NULL
);
1761 w
->current_matrix
= new_glyph_matrix (NULL
);
1764 dim
.width
= required_matrix_width (w
);
1765 dim
.height
= required_matrix_height (w
);
1766 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1767 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1770 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1774 /* Allocate/reallocate glyph matrices of a single frame F.
1775 This function must be called when a new frame is created,
1776 its size changes, or its window configuration changes. */
1779 adjust_frame_glyphs (struct frame
*f
)
1781 /* Block input so that expose events and other events that access
1782 glyph matrices are not processed while we are changing them. */
1785 if (FRAME_WINDOW_P (f
))
1786 adjust_frame_glyphs_for_window_redisplay (f
);
1788 adjust_frame_glyphs_for_frame_redisplay (f
);
1790 /* Don't forget the buffer for decode_mode_spec. */
1791 adjust_decode_mode_spec_buffer (f
);
1793 f
->glyphs_initialized_p
= 1;
1798 /* Return true if any window in the tree has nonzero window margins. See
1799 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1801 showing_window_margins_p (struct window
*w
)
1805 if (WINDOWP (w
->contents
))
1807 if (showing_window_margins_p (XWINDOW (w
->contents
)))
1810 else if (w
->left_margin_cols
> 0 || w
->right_margin_cols
> 0)
1813 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1819 /* In the window tree with root W, build current matrices of leaf
1820 windows from the frame's current matrix. */
1823 fake_current_matrices (Lisp_Object window
)
1827 for (; !NILP (window
); window
= w
->next
)
1829 w
= XWINDOW (window
);
1831 if (WINDOWP (w
->contents
))
1832 fake_current_matrices (w
->contents
);
1836 struct frame
*f
= XFRAME (w
->frame
);
1837 struct glyph_matrix
*m
= w
->current_matrix
;
1838 struct glyph_matrix
*fm
= f
->current_matrix
;
1840 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1841 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1843 for (i
= 0; i
< m
->matrix_h
; ++i
)
1845 struct glyph_row
*r
= m
->rows
+ i
;
1846 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1848 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1849 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1851 r
->enabled_p
= fr
->enabled_p
;
1854 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1855 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1856 r
->used
[TEXT_AREA
] = (m
->matrix_w
1857 - r
->used
[LEFT_MARGIN_AREA
]
1858 - r
->used
[RIGHT_MARGIN_AREA
]);
1867 /* Save away the contents of frame F's current frame matrix. Value is
1868 a glyph matrix holding the contents of F's current frame matrix. */
1870 static struct glyph_matrix
*
1871 save_current_matrix (struct frame
*f
)
1874 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1875 saved
->nrows
= f
->current_matrix
->nrows
;
1876 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1878 for (i
= 0; i
< saved
->nrows
; ++i
)
1880 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1881 struct glyph_row
*to
= saved
->rows
+ i
;
1882 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1884 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1885 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1886 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1887 to
->enabled_p
= from
->enabled_p
;
1888 to
->hash
= from
->hash
;
1889 if (from
->used
[LEFT_MARGIN_AREA
])
1891 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1892 to
->glyphs
[LEFT_MARGIN_AREA
] = xmalloc (nbytes
);
1893 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1894 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1895 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1897 if (from
->used
[RIGHT_MARGIN_AREA
])
1899 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1900 to
->glyphs
[RIGHT_MARGIN_AREA
] = xmalloc (nbytes
);
1901 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1902 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1903 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1911 /* Restore the contents of frame F's current frame matrix from SAVED,
1912 and free memory associated with SAVED. */
1915 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1919 for (i
= 0; i
< saved
->nrows
; ++i
)
1921 struct glyph_row
*from
= saved
->rows
+ i
;
1922 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1923 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1925 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1926 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1927 xfree (from
->glyphs
[TEXT_AREA
]);
1928 nbytes
= from
->used
[LEFT_MARGIN_AREA
] * sizeof (struct glyph
);
1931 memcpy (to
->glyphs
[LEFT_MARGIN_AREA
],
1932 from
->glyphs
[LEFT_MARGIN_AREA
], nbytes
);
1933 to
->used
[LEFT_MARGIN_AREA
] = from
->used
[LEFT_MARGIN_AREA
];
1934 xfree (from
->glyphs
[LEFT_MARGIN_AREA
]);
1937 to
->used
[LEFT_MARGIN_AREA
] = 0;
1938 nbytes
= from
->used
[RIGHT_MARGIN_AREA
] * sizeof (struct glyph
);
1941 memcpy (to
->glyphs
[RIGHT_MARGIN_AREA
],
1942 from
->glyphs
[RIGHT_MARGIN_AREA
], nbytes
);
1943 to
->used
[RIGHT_MARGIN_AREA
] = from
->used
[RIGHT_MARGIN_AREA
];
1944 xfree (from
->glyphs
[RIGHT_MARGIN_AREA
]);
1947 to
->used
[RIGHT_MARGIN_AREA
] = 0;
1950 xfree (saved
->rows
);
1956 /* Allocate/reallocate glyph matrices of a single frame F for
1957 frame-based redisplay. */
1960 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
1962 struct dim matrix_dim
;
1963 bool pool_changed_p
;
1964 int window_change_flags
;
1967 if (!FRAME_LIVE_P (f
))
1970 top_window_y
= FRAME_TOP_MARGIN (f
);
1972 /* Allocate glyph pool structures if not already done. */
1973 if (f
->desired_pool
== NULL
)
1975 f
->desired_pool
= new_glyph_pool ();
1976 f
->current_pool
= new_glyph_pool ();
1979 /* Allocate frames matrix structures if needed. */
1980 if (f
->desired_matrix
== NULL
)
1982 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1983 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1986 /* Compute window glyph matrices. (This takes the mini-buffer
1987 window into account). The result is the size of the frame glyph
1988 matrix needed. The variable window_change_flags is set to a bit
1989 mask indicating whether new matrices will be allocated or
1990 existing matrices change their size or location within the frame
1992 window_change_flags
= 0;
1994 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
1997 &window_change_flags
);
1999 /* Add in menu bar lines, if any. */
2000 matrix_dim
.height
+= top_window_y
;
2002 /* Enlarge pools as necessary. */
2003 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2004 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2006 /* Set up glyph pointers within window matrices. Do this only if
2007 absolutely necessary since it requires a frame redraw. */
2008 if (pool_changed_p
|| window_change_flags
)
2010 /* Do it for window matrices. */
2011 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2013 &window_change_flags
);
2015 /* Size of frame matrices must equal size of frame. Note
2016 that we are called for X frames with window widths NOT equal
2017 to the frame width (from CHANGE_FRAME_SIZE_1). */
2018 if (matrix_dim
.width
!= FRAME_COLS (f
)
2019 || matrix_dim
.height
!= FRAME_LINES (f
))
2022 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2023 && matrix_dim
.height
== FRAME_LINES (f
));
2025 /* Pointers to glyph memory in glyph rows are exchanged during
2026 the update phase of redisplay, which means in general that a
2027 frame's current matrix consists of pointers into both the
2028 desired and current glyph pool of the frame. Adjusting a
2029 matrix sets the frame matrix up so that pointers are all into
2030 the same pool. If we want to preserve glyph contents of the
2031 current matrix over a call to adjust_glyph_matrix, we must
2032 make a copy of the current glyphs, and restore the current
2033 matrix' contents from that copy. */
2034 if (display_completed
2035 && !FRAME_GARBAGED_P (f
)
2036 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2037 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2038 /* For some reason, the frame glyph matrix gets corrupted if
2039 any of the windows contain margins. I haven't been able
2040 to hunt down the reason, but for the moment this prevents
2041 the problem from manifesting. -- cyd */
2042 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2044 struct glyph_matrix
*copy
= save_current_matrix (f
);
2045 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2046 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2047 restore_current_matrix (f
, copy
);
2048 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2052 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2053 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2054 SET_FRAME_GARBAGED (f
);
2060 /* Allocate/reallocate glyph matrices of a single frame F for
2061 window-based redisplay. */
2064 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2066 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2068 /* Allocate/reallocate window matrices. */
2069 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2071 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2072 /* Allocate/ reallocate matrices of the dummy window used to display
2073 the menu bar under X when no X toolkit support is available. */
2075 /* Allocate a dummy window if not already done. */
2077 if (NILP (f
->menu_bar_window
))
2080 fset_menu_bar_window (f
, make_window ());
2081 w
= XWINDOW (f
->menu_bar_window
);
2082 XSETFRAME (frame
, f
);
2083 wset_frame (w
, frame
);
2084 w
->pseudo_window_p
= 1;
2087 w
= XWINDOW (f
->menu_bar_window
);
2089 /* Set window dimensions to frame dimensions and allocate or
2090 adjust glyph matrices of W. */
2095 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2096 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2097 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2098 w
->pixel_height
= FRAME_MENU_BAR_HEIGHT (f
);
2099 w
->total_lines
= FRAME_MENU_BAR_LINES (f
);
2100 allocate_matrices_for_window_redisplay (w
);
2104 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2106 /* Allocate/ reallocate matrices of the tool bar window. If we
2107 don't have a tool bar window yet, make one. */
2109 if (NILP (f
->tool_bar_window
))
2112 fset_tool_bar_window (f
, make_window ());
2113 w
= XWINDOW (f
->tool_bar_window
);
2114 XSETFRAME (frame
, f
);
2115 wset_frame (w
, frame
);
2116 w
->pseudo_window_p
= 1;
2119 w
= XWINDOW (f
->tool_bar_window
);
2123 w
->pixel_top
= FRAME_MENU_BAR_HEIGHT (f
);
2124 w
->top_line
= FRAME_MENU_BAR_LINES (f
);
2125 w
->pixel_width
= (FRAME_PIXEL_WIDTH (f
)
2126 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f
));
2127 w
->total_cols
= FRAME_TOTAL_COLS (f
);
2128 w
->pixel_height
= FRAME_TOOL_BAR_HEIGHT (f
);
2129 w
->total_lines
= FRAME_TOOL_BAR_LINES (f
);
2130 allocate_matrices_for_window_redisplay (w
);
2136 /* Re-allocate buffer for decode_mode_spec on frame F. */
2139 adjust_decode_mode_spec_buffer (struct frame
*f
)
2141 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2142 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2147 /**********************************************************************
2148 Freeing Glyph Matrices
2149 **********************************************************************/
2151 /* Free glyph memory for a frame F. F may be null. This function can
2152 be called for the same frame more than once. The root window of
2153 F may be nil when this function is called. This is the case when
2154 the function is called when F is destroyed. */
2157 free_glyphs (struct frame
*f
)
2159 if (f
&& f
->glyphs_initialized_p
)
2161 /* Block interrupt input so that we don't get surprised by an X
2162 event while we're in an inconsistent state. */
2164 f
->glyphs_initialized_p
= 0;
2166 /* Release window sub-matrices. */
2167 if (!NILP (f
->root_window
))
2168 free_window_matrices (XWINDOW (f
->root_window
));
2170 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2171 /* Free the dummy window for menu bars without X toolkit and its
2173 if (!NILP (f
->menu_bar_window
))
2175 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2176 free_glyph_matrix (w
->desired_matrix
);
2177 free_glyph_matrix (w
->current_matrix
);
2178 w
->desired_matrix
= w
->current_matrix
= NULL
;
2179 fset_menu_bar_window (f
, Qnil
);
2183 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
2184 /* Free the tool bar window and its glyph matrices. */
2185 if (!NILP (f
->tool_bar_window
))
2187 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2188 free_glyph_matrix (w
->desired_matrix
);
2189 free_glyph_matrix (w
->current_matrix
);
2190 w
->desired_matrix
= w
->current_matrix
= NULL
;
2191 fset_tool_bar_window (f
, Qnil
);
2195 /* Release frame glyph matrices. Reset fields to zero in
2196 case we are called a second time. */
2197 if (f
->desired_matrix
)
2199 free_glyph_matrix (f
->desired_matrix
);
2200 free_glyph_matrix (f
->current_matrix
);
2201 f
->desired_matrix
= f
->current_matrix
= NULL
;
2204 /* Release glyph pools. */
2205 if (f
->desired_pool
)
2207 free_glyph_pool (f
->desired_pool
);
2208 free_glyph_pool (f
->current_pool
);
2209 f
->desired_pool
= f
->current_pool
= NULL
;
2217 /* Free glyph sub-matrices in the window tree rooted at W. This
2218 function may be called with a null pointer, and it may be called on
2219 the same tree more than once. */
2222 free_window_matrices (struct window
*w
)
2226 if (WINDOWP (w
->contents
))
2227 free_window_matrices (XWINDOW (w
->contents
));
2230 /* This is a leaf window. Free its memory and reset fields
2231 to zero in case this function is called a second time for
2233 free_glyph_matrix (w
->current_matrix
);
2234 free_glyph_matrix (w
->desired_matrix
);
2235 w
->current_matrix
= w
->desired_matrix
= NULL
;
2238 /* Next window on same level. */
2239 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2244 /* Check glyph memory leaks. This function is called from
2245 shut_down_emacs. Note that frames are not destroyed when Emacs
2246 exits. We therefore free all glyph memory for all active frames
2247 explicitly and check that nothing is left allocated. */
2250 check_glyph_memory (void)
2252 Lisp_Object tail
, frame
;
2254 /* Free glyph memory for all frames. */
2255 FOR_EACH_FRAME (tail
, frame
)
2256 free_glyphs (XFRAME (frame
));
2258 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2259 /* Check that nothing is left allocated. */
2260 eassert (glyph_matrix_count
== 0);
2261 eassert (glyph_pool_count
== 0);
2267 /**********************************************************************
2268 Building a Frame Matrix
2269 **********************************************************************/
2271 /* Most of the redisplay code works on glyph matrices attached to
2272 windows. This is a good solution most of the time, but it is not
2273 suitable for terminal code. Terminal output functions cannot rely
2274 on being able to set an arbitrary terminal window. Instead they
2275 must be provided with a view of the whole frame, i.e. the whole
2276 screen. We build such a view by constructing a frame matrix from
2277 window matrices in this section.
2279 Windows that must be updated have their must_be_updated_p flag set.
2280 For all such windows, their desired matrix is made part of the
2281 desired frame matrix. For other windows, their current matrix is
2282 made part of the desired frame matrix.
2284 +-----------------+----------------+
2285 | desired | desired |
2287 +-----------------+----------------+
2290 +----------------------------------+
2292 Desired window matrices can be made part of the frame matrix in a
2293 cheap way: We exploit the fact that the desired frame matrix and
2294 desired window matrices share their glyph memory. This is not
2295 possible for current window matrices. Their glyphs are copied to
2296 the desired frame matrix. The latter is equivalent to
2297 preserve_other_columns in the old redisplay.
2299 Used glyphs counters for frame matrix rows are the result of adding
2300 up glyph lengths of the window matrices. A line in the frame
2301 matrix is enabled, if a corresponding line in a window matrix is
2304 After building the desired frame matrix, it will be passed to
2305 terminal code, which will manipulate both the desired and current
2306 frame matrix. Changes applied to the frame's current matrix have
2307 to be visible in current window matrices afterwards, of course.
2309 This problem is solved like this:
2311 1. Window and frame matrices share glyphs. Window matrices are
2312 constructed in a way that their glyph contents ARE the glyph
2313 contents needed in a frame matrix. Thus, any modification of
2314 glyphs done in terminal code will be reflected in window matrices
2317 2. Exchanges of rows in a frame matrix done by terminal code are
2318 intercepted by hook functions so that corresponding row operations
2319 on window matrices can be performed. This is necessary because we
2320 use pointers to glyphs in glyph row structures. To satisfy the
2321 assumption of point 1 above that glyphs are updated implicitly in
2322 window matrices when they are manipulated via the frame matrix,
2323 window and frame matrix must of course agree where to find the
2324 glyphs for their rows. Possible manipulations that must be
2325 mirrored are assignments of rows of the desired frame matrix to the
2326 current frame matrix and scrolling the current frame matrix. */
2328 /* Build frame F's desired matrix from window matrices. Only windows
2329 which have the flag must_be_updated_p set have to be updated. Menu
2330 bar lines of a frame are not covered by window matrices, so make
2331 sure not to touch them in this function. */
2334 build_frame_matrix (struct frame
*f
)
2338 /* F must have a frame matrix when this function is called. */
2339 eassert (!FRAME_WINDOW_P (f
));
2341 /* Clear all rows in the frame matrix covered by window matrices.
2342 Menu bar lines are not covered by windows. */
2343 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2344 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2346 /* Build the matrix by walking the window tree. */
2347 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2348 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2352 /* Walk a window tree, building a frame matrix MATRIX from window
2353 matrices. W is the root of a window tree. */
2356 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2360 if (WINDOWP (w
->contents
))
2361 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->contents
));
2363 build_frame_matrix_from_leaf_window (matrix
, w
);
2365 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2370 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2371 desired frame matrix built. W is a leaf window whose desired or
2372 current matrix is to be added to FRAME_MATRIX. W's flag
2373 must_be_updated_p determines which matrix it contributes to
2374 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2375 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2376 Adding a desired matrix means setting up used counters and such in
2377 frame rows, while adding a current window matrix to FRAME_MATRIX
2378 means copying glyphs. The latter case corresponds to
2379 preserve_other_columns in the old redisplay. */
2382 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2384 struct glyph_matrix
*window_matrix
;
2385 int window_y
, frame_y
;
2386 /* If non-zero, a glyph to insert at the right border of W. */
2387 GLYPH right_border_glyph
;
2389 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2391 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2392 if (w
->must_be_updated_p
)
2394 window_matrix
= w
->desired_matrix
;
2396 /* Decide whether we want to add a vertical border glyph. */
2397 if (!WINDOW_RIGHTMOST_P (w
))
2399 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2402 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2404 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2406 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2407 spec_glyph_lookup_face (w
, &right_border_glyph
);
2410 if (GLYPH_FACE (right_border_glyph
) <= 0)
2411 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2415 window_matrix
= w
->current_matrix
;
2417 /* For all rows in the window matrix and corresponding rows in the
2420 frame_y
= window_matrix
->matrix_y
;
2421 while (window_y
< window_matrix
->nrows
)
2423 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2424 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2425 bool current_row_p
= window_matrix
== w
->current_matrix
;
2427 /* Fill up the frame row with spaces up to the left margin of the
2429 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2431 /* Fill up areas in the window matrix row with spaces. */
2432 fill_up_glyph_row_with_spaces (window_row
);
2434 /* If only part of W's desired matrix has been built, and
2435 window_row wasn't displayed, use the corresponding current
2437 if (window_matrix
== w
->desired_matrix
2438 && !window_row
->enabled_p
)
2440 window_row
= w
->current_matrix
->rows
+ window_y
;
2446 /* Copy window row to frame row. */
2447 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2448 window_row
->glyphs
[0],
2449 window_matrix
->matrix_w
* sizeof (struct glyph
));
2453 eassert (window_row
->enabled_p
);
2455 /* Only when a desired row has been displayed, we want
2456 the corresponding frame row to be updated. */
2457 frame_row
->enabled_p
= true;
2459 /* Maybe insert a vertical border between horizontally adjacent
2461 if (GLYPH_CHAR (right_border_glyph
) != 0)
2463 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2464 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2468 /* Window row window_y must be a slice of frame row
2470 eassert (glyph_row_slice_p (window_row
, frame_row
));
2472 /* If rows are in sync, we don't have to copy glyphs because
2473 frame and window share glyphs. */
2475 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2476 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2480 /* Set number of used glyphs in the frame matrix. Since we fill
2481 up with spaces, and visit leaf windows from left to right it
2482 can be done simply. */
2483 frame_row
->used
[TEXT_AREA
]
2484 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2492 /* Given a user-specified glyph, possibly including a Lisp-level face
2493 ID, return a glyph that has a realized face ID.
2494 This is used for glyphs displayed specially and not part of the text;
2495 for instance, vertical separators, truncation markers, etc. */
2498 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2500 int lface_id
= GLYPH_FACE (*glyph
);
2501 /* Convert the glyph's specified face to a realized (cache) face. */
2504 int face_id
= merge_faces (XFRAME (w
->frame
),
2505 Qt
, lface_id
, DEFAULT_FACE_ID
);
2506 SET_GLYPH_FACE (*glyph
, face_id
);
2510 /* Add spaces to a glyph row ROW in a window matrix.
2512 Each row has the form:
2514 +---------+-----------------------------+------------+
2515 | left | text | right |
2516 +---------+-----------------------------+------------+
2518 Left and right marginal areas are optional. This function adds
2519 spaces to areas so that there are no empty holes between areas.
2520 In other words: If the right area is not empty, the text area
2521 is filled up with spaces up to the right area. If the text area
2522 is not empty, the left area is filled up.
2524 To be called for frame-based redisplay, only. */
2527 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2529 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2530 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2531 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2535 /* Fill area AREA of glyph row ROW with spaces. To be called for
2536 frame-based redisplay only. */
2539 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2541 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2543 struct glyph
*end
= row
->glyphs
[area
+ 1];
2544 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2547 *text
++ = space_glyph
;
2548 row
->used
[area
] = text
- row
->glyphs
[area
];
2553 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2554 reached. In frame matrices only one area, TEXT_AREA, is used. */
2557 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2559 int i
= row
->used
[TEXT_AREA
];
2560 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2563 glyph
[i
++] = space_glyph
;
2565 row
->used
[TEXT_AREA
] = i
;
2570 /**********************************************************************
2571 Mirroring operations on frame matrices in window matrices
2572 **********************************************************************/
2574 /* Set frame being updated via frame-based redisplay to F. This
2575 function must be called before updates to make explicit that we are
2576 working on frame matrices or not. */
2579 set_frame_matrix_frame (struct frame
*f
)
2581 frame_matrix_frame
= f
;
2585 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2586 DESIRED_MATRIX is the desired matrix corresponding to
2587 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2588 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2589 frame_matrix_frame is non-null, this indicates that the exchange is
2590 done in frame matrices, and that we have to perform analogous
2591 operations in window matrices of frame_matrix_frame. */
2594 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2596 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2597 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2598 bool mouse_face_p
= current_row
->mouse_face_p
;
2600 /* Do current_row = desired_row. This exchanges glyph pointers
2601 between both rows, and does a structure assignment otherwise. */
2602 assign_row (current_row
, desired_row
);
2604 /* Enable current_row to mark it as valid. */
2605 current_row
->enabled_p
= true;
2606 current_row
->mouse_face_p
= mouse_face_p
;
2608 /* If we are called on frame matrices, perform analogous operations
2609 for window matrices. */
2610 if (frame_matrix_frame
)
2611 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2615 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2616 W's frame which has been made current (by swapping pointers between
2617 current and desired matrix). Perform analogous operations in the
2618 matrices of leaf windows in the window tree rooted at W. */
2621 mirror_make_current (struct window
*w
, int frame_row
)
2625 if (WINDOWP (w
->contents
))
2626 mirror_make_current (XWINDOW (w
->contents
), frame_row
);
2629 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2630 here because the checks performed in debug mode there
2631 will not allow the conversion. */
2632 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2634 /* If FRAME_ROW is within W, assign the desired row to the
2635 current row (exchanging glyph pointers). */
2636 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2638 struct glyph_row
*current_row
2639 = MATRIX_ROW (w
->current_matrix
, row
);
2640 struct glyph_row
*desired_row
2641 = MATRIX_ROW (w
->desired_matrix
, row
);
2643 if (desired_row
->enabled_p
)
2644 assign_row (current_row
, desired_row
);
2646 swap_glyph_pointers (desired_row
, current_row
);
2647 current_row
->enabled_p
= true;
2649 /* Set the Y coordinate of the mode/header line's row.
2650 It is needed in draw_row_with_mouse_face to find the
2651 screen coordinates. (Window-based redisplay sets
2652 this in update_window, but no one seems to do that
2653 for frame-based redisplay.) */
2654 if (current_row
->mode_line_p
)
2655 current_row
->y
= row
;
2659 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2664 /* Perform row dance after scrolling. We are working on the range of
2665 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2666 including) in MATRIX. COPY_FROM is a vector containing, for each
2667 row I in the range 0 <= I < NLINES, the index of the original line
2668 to move to I. This index is relative to the row range, i.e. 0 <=
2669 index < NLINES. RETAINED_P is a vector containing zero for each
2670 row 0 <= I < NLINES which is empty.
2672 This function is called from do_scrolling and do_direct_scrolling. */
2675 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2676 int *copy_from
, char *retained_p
)
2678 /* A copy of original rows. */
2679 struct glyph_row
*old_rows
;
2681 /* Rows to assign to. */
2682 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2686 /* Make a copy of the original rows. */
2687 old_rows
= alloca (nlines
* sizeof *old_rows
);
2688 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2690 /* Assign new rows, maybe clear lines. */
2691 for (i
= 0; i
< nlines
; ++i
)
2693 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2695 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2696 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2697 new_rows
[i
] = old_rows
[copy_from
[i
]];
2698 new_rows
[i
].enabled_p
= enabled_before_p
;
2700 /* RETAINED_P is zero for empty lines. */
2701 if (!retained_p
[copy_from
[i
]])
2702 new_rows
[i
].enabled_p
= false;
2705 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2706 if (frame_matrix_frame
)
2707 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2708 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2712 /* Synchronize glyph pointers in the current matrix of window W with
2713 the current frame matrix. */
2716 sync_window_with_frame_matrix_rows (struct window
*w
)
2718 struct frame
*f
= XFRAME (w
->frame
);
2719 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2720 int left
, right
, x
, width
;
2722 /* Preconditions: W must be a live window on a tty frame. */
2723 eassert (BUFFERP (w
->contents
));
2724 eassert (!FRAME_WINDOW_P (f
));
2726 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2727 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2728 x
= w
->current_matrix
->matrix_x
;
2729 width
= w
->current_matrix
->matrix_w
;
2731 window_row
= w
->current_matrix
->rows
;
2732 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2733 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2735 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2737 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2738 = frame_row
->glyphs
[0] + x
;
2739 window_row
->glyphs
[TEXT_AREA
]
2740 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2741 window_row
->glyphs
[LAST_AREA
]
2742 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2743 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2744 = window_row
->glyphs
[LAST_AREA
] - right
;
2749 /* Return the window in the window tree rooted in W containing frame
2750 row ROW. Value is null if none is found. */
2752 static struct window
*
2753 frame_row_to_window (struct window
*w
, int row
)
2755 struct window
*found
= NULL
;
2759 if (WINDOWP (w
->contents
))
2760 found
= frame_row_to_window (XWINDOW (w
->contents
), row
);
2761 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2762 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2765 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2772 /* Perform a line dance in the window tree rooted at W, after
2773 scrolling a frame matrix in mirrored_line_dance.
2775 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2776 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2777 COPY_FROM is a vector containing, for each row I in the range 0 <=
2778 I < NLINES, the index of the original line to move to I. This
2779 index is relative to the row range, i.e. 0 <= index < NLINES.
2780 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2784 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2788 if (WINDOWP (w
->contents
))
2789 mirror_line_dance (XWINDOW (w
->contents
), unchanged_at_top
,
2790 nlines
, copy_from
, retained_p
);
2793 /* W is a leaf window, and we are working on its current
2795 struct glyph_matrix
*m
= w
->current_matrix
;
2798 struct glyph_row
*old_rows
;
2800 /* Make a copy of the original rows of matrix m. */
2801 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2802 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2804 for (i
= 0; i
< nlines
; ++i
)
2806 /* Frame relative line assigned to. */
2807 int frame_to
= i
+ unchanged_at_top
;
2809 /* Frame relative line assigned. */
2810 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2812 /* Window relative line assigned to. */
2813 int window_to
= frame_to
- m
->matrix_y
;
2815 /* Window relative line assigned. */
2816 int window_from
= frame_from
- m
->matrix_y
;
2818 /* Is assigned line inside window? */
2819 bool from_inside_window_p
2820 = window_from
>= 0 && window_from
< m
->matrix_h
;
2822 /* Is assigned to line inside window? */
2823 bool to_inside_window_p
2824 = window_to
>= 0 && window_to
< m
->matrix_h
;
2826 if (from_inside_window_p
&& to_inside_window_p
)
2828 /* Do the assignment. The enabled_p flag is saved
2829 over the assignment because the old redisplay did
2831 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2832 m
->rows
[window_to
] = old_rows
[window_from
];
2833 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2835 /* If frame line is empty, window line is empty, too. */
2836 if (!retained_p
[copy_from
[i
]])
2837 m
->rows
[window_to
].enabled_p
= false;
2839 else if (to_inside_window_p
)
2841 /* A copy between windows. This is an infrequent
2842 case not worth optimizing. */
2843 struct frame
*f
= XFRAME (w
->frame
);
2844 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2846 struct glyph_matrix
*m2
;
2849 w2
= frame_row_to_window (root
, frame_from
);
2850 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2851 -nw', FROM_FRAME sometimes has no associated window.
2852 This check avoids a segfault if W2 is null. */
2855 m2
= w2
->current_matrix
;
2856 m2_from
= frame_from
- m2
->matrix_y
;
2857 copy_row_except_pointers (m
->rows
+ window_to
,
2858 m2
->rows
+ m2_from
);
2860 /* If frame line is empty, window line is empty, too. */
2861 if (!retained_p
[copy_from
[i
]])
2862 m
->rows
[window_to
].enabled_p
= false;
2866 else if (from_inside_window_p
)
2870 /* If there was a copy between windows, make sure glyph
2871 pointers are in sync with the frame matrix. */
2873 sync_window_with_frame_matrix_rows (w
);
2875 /* Check that no pointers are lost. */
2879 /* Next window on same level. */
2880 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2887 /* Check that window and frame matrices agree about their
2888 understanding where glyphs of the rows are to find. For each
2889 window in the window tree rooted at W, check that rows in the
2890 matrices of leaf window agree with their frame matrices about
2894 check_window_matrix_pointers (struct window
*w
)
2898 if (WINDOWP (w
->contents
))
2899 check_window_matrix_pointers (XWINDOW (w
->contents
));
2902 struct frame
*f
= XFRAME (w
->frame
);
2903 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2904 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2907 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2912 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2913 a window and FRAME_MATRIX is the corresponding frame matrix. For
2914 each row in WINDOW_MATRIX check that it's a slice of the
2915 corresponding frame row. If it isn't, abort. */
2918 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2919 struct glyph_matrix
*frame_matrix
)
2921 /* Row number in WINDOW_MATRIX. */
2924 /* Row number corresponding to I in FRAME_MATRIX. */
2925 int j
= window_matrix
->matrix_y
;
2927 /* For all rows check that the row in the window matrix is a
2928 slice of the row in the frame matrix. If it isn't we didn't
2929 mirror an operation on the frame matrix correctly. */
2930 while (i
< window_matrix
->nrows
)
2932 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2933 frame_matrix
->rows
+ j
))
2939 #endif /* GLYPH_DEBUG */
2943 /**********************************************************************
2944 VPOS and HPOS translations
2945 **********************************************************************/
2949 /* Translate vertical position VPOS which is relative to window W to a
2950 vertical position relative to W's frame. */
2953 window_to_frame_vpos (struct window
*w
, int vpos
)
2955 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2956 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
2957 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
2958 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
2963 /* Translate horizontal position HPOS which is relative to window W to
2964 a horizontal position relative to W's frame. */
2967 window_to_frame_hpos (struct window
*w
, int hpos
)
2969 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
2970 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
2974 #endif /* GLYPH_DEBUG */
2978 /**********************************************************************
2980 **********************************************************************/
2982 /* Redraw frame F. */
2985 redraw_frame (struct frame
*f
)
2987 /* Error if F has no glyphs. */
2988 eassert (f
->glyphs_initialized_p
);
2990 if (FRAME_MSDOS_P (f
))
2991 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
2993 clear_current_matrices (f
);
2995 windows_or_buffers_changed
= 13;
2996 /* Mark all windows as inaccurate, so that every window will have
2997 its redisplay done. */
2998 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
2999 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), true);
3000 f
->garbaged
= false;
3003 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3004 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3005 If FRAME is omitted or nil, the selected frame is used. */)
3008 redraw_frame (decode_live_frame (frame
));
3012 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3013 doc
: /* Clear and redisplay all visible frames. */)
3016 Lisp_Object tail
, frame
;
3018 FOR_EACH_FRAME (tail
, frame
)
3019 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3020 redraw_frame (XFRAME (frame
));
3027 /***********************************************************************
3029 ***********************************************************************/
3031 /* Update frame F based on the data in desired matrices.
3033 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3034 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3036 Value is true if redisplay was stopped due to pending input. */
3039 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3041 /* True means display has been paused because of pending input. */
3043 struct window
*root_window
= XWINDOW (f
->root_window
);
3045 if (redisplay_dont_pause
)
3047 else if (!force_p
&& detect_input_pending_ignore_squeezables ())
3053 if (FRAME_WINDOW_P (f
))
3055 /* We are working on window matrix basis. All windows whose
3056 flag must_be_updated_p is set have to be updated. */
3058 /* Record that we are not working on frame matrices. */
3059 set_frame_matrix_frame (NULL
);
3061 /* Update all windows in the window tree of F, maybe stopping
3062 when pending input is detected. */
3065 #if defined (HAVE_X_WINDOWS) && ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
3066 /* Update the menu bar on X frames that don't have toolkit
3068 if (WINDOWP (f
->menu_bar_window
))
3069 update_window (XWINDOW (f
->menu_bar_window
), 1);
3072 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
3073 /* Update the tool-bar window, if present. */
3074 if (WINDOWP (f
->tool_bar_window
))
3076 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3078 /* Update tool-bar window. */
3079 if (w
->must_be_updated_p
)
3083 update_window (w
, 1);
3084 w
->must_be_updated_p
= false;
3086 /* Swap tool-bar strings. We swap because we want to
3088 tem
= f
->current_tool_bar_string
;
3089 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3090 fset_desired_tool_bar_string (f
, tem
);
3095 /* Update windows. */
3096 paused_p
= update_window_tree (root_window
, force_p
);
3101 /* We are working on frame matrix basis. Set the frame on whose
3102 frame matrix we operate. */
3103 set_frame_matrix_frame (f
);
3105 /* Build F's desired matrix from window matrices. */
3106 build_frame_matrix (f
);
3108 /* Update the display */
3110 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
, 1);
3113 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3115 if (FRAME_TTY (f
)->termscript
)
3116 fflush (FRAME_TTY (f
)->termscript
);
3117 if (FRAME_TERMCAP_P (f
))
3118 fflush (FRAME_TTY (f
)->output
);
3121 /* Check window matrices for lost pointers. */
3123 check_window_matrix_pointers (root_window
);
3124 add_frame_display_history (f
, paused_p
);
3129 /* Reset flags indicating that a window should be updated. */
3130 set_window_update_flags (root_window
, false);
3132 display_completed
= !paused_p
;
3136 /* Update a TTY frame F that has a menu dropped down over some of its
3137 glyphs. This is like the second part of update_frame, but it
3138 doesn't call build_frame_matrix, because we already have the
3139 desired matrix prepared, and don't want it to be overwritten by the
3140 text of the normal display.
3142 ROW and COL, if non-negative, are the row and column of the TTY
3143 frame where to position the cursor after the frame update is
3144 complete. Negative values mean ask update_frame_1 to position the
3145 cursor "normally", i.e. at point in the selected window. */
3147 update_frame_with_menu (struct frame
*f
, int row
, int col
)
3149 struct window
*root_window
= XWINDOW (f
->root_window
);
3150 bool paused_p
, cursor_at_point_p
;
3152 eassert (FRAME_TERMCAP_P (f
));
3154 /* We are working on frame matrix basis. Set the frame on whose
3155 frame matrix we operate. */
3156 set_frame_matrix_frame (f
);
3158 /* Update the display. */
3160 cursor_at_point_p
= !(row
>= 0 && col
>= 0);
3161 /* Force update_frame_1 not to stop due to pending input, and not
3163 paused_p
= update_frame_1 (f
, 1, 1, cursor_at_point_p
);
3164 /* ROW and COL tell us where in the menu to position the cursor, so
3165 that screen readers know the active region on the screen. */
3166 if (!cursor_at_point_p
)
3167 cursor_to (f
, row
, col
);
3170 if (FRAME_TTY (f
)->termscript
)
3171 fflush (FRAME_TTY (f
)->termscript
);
3172 fflush (FRAME_TTY (f
)->output
);
3173 /* Check window matrices for lost pointers. */
3176 /* We cannot possibly survive the matrix pointers check, since
3177 we have overwritten parts of the frame glyph matrix without
3178 making any updates to the window matrices. */
3179 check_window_matrix_pointers (root_window
);
3181 add_frame_display_history (f
, paused_p
);
3184 /* Reset flags indicating that a window should be updated. */
3185 set_window_update_flags (root_window
, false);
3186 display_completed
= !paused_p
;
3190 /************************************************************************
3191 Window-based updates
3192 ************************************************************************/
3194 /* Perform updates in window tree rooted at W.
3195 If FORCE_P, don't stop updating if input is pending. */
3198 update_window_tree (struct window
*w
, bool force_p
)
3202 while (w
&& !paused_p
)
3204 if (WINDOWP (w
->contents
))
3205 paused_p
|= update_window_tree (XWINDOW (w
->contents
), force_p
);
3206 else if (w
->must_be_updated_p
)
3207 paused_p
|= update_window (w
, force_p
);
3209 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3216 /* Update window W if its flag must_be_updated_p is set.
3217 If FORCE_P, don't stop updating if input is pending. */
3220 update_single_window (struct window
*w
, bool force_p
)
3222 if (w
->must_be_updated_p
)
3224 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3226 /* Record that this is not a frame-based redisplay. */
3227 set_frame_matrix_frame (NULL
);
3229 if (redisplay_dont_pause
)
3234 update_window (w
, force_p
);
3237 /* Reset flag in W. */
3238 w
->must_be_updated_p
= false;
3242 #ifdef HAVE_WINDOW_SYSTEM
3244 /* Redraw lines from the current matrix of window W that are
3245 overlapped by other rows. YB is bottom-most y-position in W. */
3248 redraw_overlapped_rows (struct window
*w
, int yb
)
3251 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3253 /* If rows overlapping others have been changed, the rows being
3254 overlapped have to be redrawn. This won't draw lines that have
3255 already been drawn in update_window_line because overlapped_p in
3256 desired rows is 0, so after row assignment overlapped_p in
3257 current rows is 0. */
3258 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3260 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3262 if (!row
->enabled_p
)
3264 else if (row
->mode_line_p
)
3267 if (row
->overlapped_p
)
3269 enum glyph_row_area area
;
3271 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3273 output_cursor_to (w
, i
, 0, row
->y
,
3274 area
== TEXT_AREA
? row
->x
: 0);
3275 if (row
->used
[area
])
3276 FRAME_RIF (f
)->write_glyphs (w
, row
, row
->glyphs
[area
],
3277 area
, row
->used
[area
]);
3278 FRAME_RIF (f
)->clear_end_of_line (w
, row
, area
, -1);
3281 row
->overlapped_p
= 0;
3284 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3290 /* Redraw lines from the current matrix of window W that overlap
3291 others. YB is bottom-most y-position in W. */
3294 redraw_overlapping_rows (struct window
*w
, int yb
)
3297 struct glyph_row
*row
;
3298 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3300 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3302 row
= w
->current_matrix
->rows
+ i
;
3304 if (!row
->enabled_p
)
3306 else if (row
->mode_line_p
)
3309 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3311 if (row
->overlapping_p
)
3315 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3316 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3317 overlaps
|= OVERLAPS_PRED
;
3318 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3319 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3320 overlaps
|= OVERLAPS_SUCC
;
3324 if (row
->used
[LEFT_MARGIN_AREA
])
3325 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3327 if (row
->used
[TEXT_AREA
])
3328 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3330 if (row
->used
[RIGHT_MARGIN_AREA
])
3331 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3333 /* Record in neighbor rows that ROW overwrites part of
3335 if (overlaps
& OVERLAPS_PRED
)
3336 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3337 if (overlaps
& OVERLAPS_SUCC
)
3338 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3347 #endif /* HAVE_WINDOW_SYSTEM */
3350 #if defined GLYPH_DEBUG && 0
3352 /* Check that no row in the current matrix of window W is enabled
3353 which is below what's displayed in the window. */
3356 check_current_matrix_flags (struct window
*w
)
3358 bool last_seen_p
= 0;
3359 int i
, yb
= window_text_bottom_y (w
);
3361 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3363 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3364 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3366 else if (last_seen_p
&& row
->enabled_p
)
3371 #endif /* GLYPH_DEBUG */
3374 /* Update display of window W.
3375 If FORCE_P, don't stop updating when input is pending. */
3378 update_window (struct window
*w
, bool force_p
)
3380 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3382 int preempt_count
= baud_rate
/ 2400 + 1;
3383 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3385 /* Check that W's frame doesn't have glyph matrices. */
3386 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3389 /* Check pending input the first time so that we can quickly return. */
3391 detect_input_pending_ignore_squeezables ();
3393 /* If forced to complete the update, or if no input is pending, do
3395 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3397 struct glyph_row
*row
, *end
;
3398 struct glyph_row
*mode_line_row
;
3399 struct glyph_row
*header_line_row
;
3401 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3404 rif
->update_window_begin_hook (w
);
3405 yb
= window_text_bottom_y (w
);
3406 row
= MATRIX_ROW (desired_matrix
, 0);
3407 end
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3409 /* Take note of the header line, if there is one. We will
3410 update it below, after updating all of the window's lines. */
3411 if (row
->mode_line_p
)
3413 header_line_row
= row
;
3417 header_line_row
= NULL
;
3419 /* Update the mode line, if necessary. */
3420 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3421 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3423 mode_line_row
->y
= yb
;
3424 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3426 &mouse_face_overwritten_p
);
3429 /* Find first enabled row. Optimizations in redisplay_internal
3430 may lead to an update with only one row enabled. There may
3431 be also completely empty matrices. */
3432 while (row
< end
&& !row
->enabled_p
)
3435 /* Try reusing part of the display by copying. */
3436 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3438 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3441 /* All rows were found to be equal. */
3447 /* We've scrolled the display. */
3453 /* Update the rest of the lines. */
3454 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3455 /* scrolling_window resets the enabled_p flag of the rows it
3456 reuses from current_matrix. */
3459 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3462 /* We'll have to play a little bit with when to
3463 detect_input_pending. If it's done too often,
3464 scrolling large windows with repeated scroll-up
3465 commands will too quickly pause redisplay. */
3466 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3467 detect_input_pending_ignore_squeezables ();
3468 changed_p
|= update_window_line (w
, vpos
,
3469 &mouse_face_overwritten_p
);
3471 /* Mark all rows below the last visible one in the current
3472 matrix as invalid. This is necessary because of
3473 variable line heights. Consider the case of three
3474 successive redisplays, where the first displays 5
3475 lines, the second 3 lines, and the third 5 lines again.
3476 If the second redisplay wouldn't mark rows in the
3477 current matrix invalid, the third redisplay might be
3478 tempted to optimize redisplay based on lines displayed
3479 in the first redisplay. */
3480 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3481 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3482 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, i
, false);
3485 /* Was display preempted? */
3486 paused_p
= row
< end
;
3490 /* Update the header line after scrolling because a new header
3491 line would otherwise overwrite lines at the top of the window
3492 that can be scrolled. */
3493 if (header_line_row
&& header_line_row
->enabled_p
)
3495 header_line_row
->y
= 0;
3496 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3499 /* Fix the appearance of overlapping/overlapped rows. */
3500 if (!paused_p
&& !w
->pseudo_window_p
)
3502 #ifdef HAVE_WINDOW_SYSTEM
3503 if (changed_p
&& rif
->fix_overlapping_area
)
3505 redraw_overlapped_rows (w
, yb
);
3506 redraw_overlapping_rows (w
, yb
);
3510 /* Make cursor visible at cursor position of W. */
3511 set_window_cursor_after_update (w
);
3513 #if 0 /* Check that current matrix invariants are satisfied. This is
3514 for debugging only. See the comment of check_matrix_invariants. */
3515 IF_DEBUG (check_matrix_invariants (w
));
3520 /* Remember the redisplay method used to display the matrix. */
3521 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3524 #ifdef HAVE_WINDOW_SYSTEM
3525 update_window_fringes (w
, 0);
3528 /* End the update of window W. Don't set the cursor if we
3529 paused updating the display because in this case,
3530 set_window_cursor_after_update hasn't been called, and
3531 W->output_cursor doesn't contain the cursor location. */
3532 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3538 /* check_current_matrix_flags (w); */
3539 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3542 clear_glyph_matrix (desired_matrix
);
3548 /* Update the display of area AREA in window W, row number VPOS.
3549 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3552 update_marginal_area (struct window
*w
, struct glyph_row
*updated_row
,
3553 enum glyph_row_area area
, int vpos
)
3555 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3556 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3558 /* Set cursor to start of glyphs, write them, and clear to the end
3559 of the area. I don't think that something more sophisticated is
3560 necessary here, since marginal areas will not be the default. */
3561 output_cursor_to (w
, vpos
, 0, desired_row
->y
, 0);
3562 if (desired_row
->used
[area
])
3563 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[area
],
3564 area
, desired_row
->used
[area
]);
3565 rif
->clear_end_of_line (w
, updated_row
, area
, -1);
3569 /* Update the display of the text area of row VPOS in window W.
3570 Value is true if display has changed. */
3573 update_text_area (struct window
*w
, struct glyph_row
*updated_row
, int vpos
)
3575 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3576 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3577 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3580 /* If rows are at different X or Y, or rows have different height,
3581 or the current row is marked invalid, write the entire line. */
3582 if (!current_row
->enabled_p
3583 || desired_row
->y
!= current_row
->y
3584 || desired_row
->ascent
!= current_row
->ascent
3585 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3586 || desired_row
->phys_height
!= current_row
->phys_height
3587 || desired_row
->visible_height
!= current_row
->visible_height
3588 || current_row
->overlapped_p
3589 /* This next line is necessary for correctly redrawing
3590 mouse-face areas after scrolling and other operations.
3591 However, it causes excessive flickering when mouse is moved
3592 across the mode line. Luckily, turning it off for the mode
3593 line doesn't seem to hurt anything. -- cyd.
3594 But it is still needed for the header line. -- kfs. */
3595 || (current_row
->mouse_face_p
3596 && !(current_row
->mode_line_p
&& vpos
> 0))
3597 || current_row
->x
!= desired_row
->x
)
3599 output_cursor_to (w
, vpos
, 0, desired_row
->y
, desired_row
->x
);
3601 if (desired_row
->used
[TEXT_AREA
])
3602 rif
->write_glyphs (w
, updated_row
, desired_row
->glyphs
[TEXT_AREA
],
3603 TEXT_AREA
, desired_row
->used
[TEXT_AREA
]);
3605 /* Clear to end of window. */
3606 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3609 /* This erases the cursor. We do this here because
3610 notice_overwritten_cursor cannot easily check this, which
3611 might indicate that the whole functionality of
3612 notice_overwritten_cursor would better be implemented here.
3613 On the other hand, we need notice_overwritten_cursor as long
3614 as mouse highlighting is done asynchronously outside of
3616 if (vpos
== w
->phys_cursor
.vpos
)
3617 w
->phys_cursor_on_p
= 0;
3622 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3623 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3624 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3625 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3626 bool abort_skipping
= 0;
3628 /* If the desired row extends its face to the text area end, and
3629 unless the current row also does so at the same position,
3630 make sure we write at least one glyph, so that the face
3631 extension actually takes place. */
3632 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3633 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3634 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3635 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3638 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3642 /* Loop over glyphs that current and desired row may have
3646 bool can_skip_p
= !abort_skipping
;
3648 /* Skip over glyphs that both rows have in common. These
3649 don't have to be written. We can't skip if the last
3650 current glyph overlaps the glyph to its right. For
3651 example, consider a current row of `if ' with the `f' in
3652 Courier bold so that it overlaps the ` ' to its right.
3653 If the desired row is ` ', we would skip over the space
3654 after the `if' and there would remain a pixel from the
3655 `f' on the screen. */
3656 if (overlapping_glyphs_p
&& i
> 0)
3658 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3661 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3663 can_skip_p
= (right
== 0 && !abort_skipping
);
3671 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3673 x
+= desired_glyph
->pixel_width
;
3674 ++desired_glyph
, ++current_glyph
, ++i
;
3677 /* Consider the case that the current row contains "xxx
3678 ppp ggg" in italic Courier font, and the desired row
3679 is "xxx ggg". The character `p' has lbearing, `g'
3680 has not. The loop above will stop in front of the
3681 first `p' in the current row. If we would start
3682 writing glyphs there, we wouldn't erase the lbearing
3683 of the `p'. The rest of the lbearing problem is then
3684 taken care of by draw_glyphs. */
3685 if (overlapping_glyphs_p
3687 && i
< current_row
->used
[TEXT_AREA
]
3688 && (current_row
->used
[TEXT_AREA
]
3689 != desired_row
->used
[TEXT_AREA
]))
3693 rif
->get_glyph_overhangs (current_glyph
,
3696 while (left
> 0 && i
> 0)
3698 --i
, --desired_glyph
, --current_glyph
;
3699 x
-= desired_glyph
->pixel_width
;
3700 left
-= desired_glyph
->pixel_width
;
3703 /* Abort the skipping algorithm if we end up before
3704 our starting point, to avoid looping (bug#1070).
3705 This can happen when the lbearing is larger than
3707 abort_skipping
= (i
< start_hpos
);
3711 /* Try to avoid writing the entire rest of the desired row
3712 by looking for a resync point. This mainly prevents
3713 mode line flickering in the case the mode line is in
3714 fixed-pitch font, which it usually will be. */
3715 if (i
< desired_row
->used
[TEXT_AREA
])
3717 int start_x
= x
, start_hpos
= i
;
3718 struct glyph
*start
= desired_glyph
;
3720 bool skip_first_p
= !can_skip_p
;
3722 /* Find the next glyph that's equal again. */
3725 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3728 x
+= desired_glyph
->pixel_width
;
3729 current_x
+= current_glyph
->pixel_width
;
3730 ++desired_glyph
, ++current_glyph
, ++i
;
3734 if (i
== start_hpos
|| x
!= current_x
)
3738 desired_glyph
= start
;
3742 output_cursor_to (w
, vpos
, start_hpos
, desired_row
->y
, start_x
);
3743 rif
->write_glyphs (w
, updated_row
, start
,
3744 TEXT_AREA
, i
- start_hpos
);
3749 /* Write the rest. */
3750 if (i
< desired_row
->used
[TEXT_AREA
])
3752 output_cursor_to (w
, vpos
, i
, desired_row
->y
, x
);
3753 rif
->write_glyphs (w
, updated_row
, desired_glyph
,
3754 TEXT_AREA
, desired_row
->used
[TEXT_AREA
] - i
);
3758 /* Maybe clear to end of line. */
3759 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3761 /* If new row extends to the end of the text area, nothing
3762 has to be cleared, if and only if we did a write_glyphs
3763 above. This is made sure by setting desired_stop_pos
3764 appropriately above. */
3765 eassert (i
< desired_row
->used
[TEXT_AREA
]
3766 || ((desired_row
->used
[TEXT_AREA
]
3767 == current_row
->used
[TEXT_AREA
])
3768 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3770 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3772 /* If old row extends to the end of the text area, clear. */
3773 if (i
>= desired_row
->used
[TEXT_AREA
])
3774 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3775 desired_row
->pixel_width
);
3776 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, -1);
3779 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3781 /* Otherwise clear to the end of the old row. Everything
3782 after that position should be clear already. */
3785 if (i
>= desired_row
->used
[TEXT_AREA
])
3786 output_cursor_to (w
, vpos
, i
, desired_row
->y
,
3787 desired_row
->pixel_width
);
3789 /* If cursor is displayed at the end of the line, make sure
3790 it's cleared. Nowadays we don't have a phys_cursor_glyph
3791 with which to erase the cursor (because this method
3792 doesn't work with lbearing/rbearing), so we must do it
3794 if (vpos
== w
->phys_cursor
.vpos
3795 && (desired_row
->reversed_p
3796 ? (w
->phys_cursor
.hpos
< 0)
3797 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3799 w
->phys_cursor_on_p
= 0;
3803 xlim
= current_row
->pixel_width
;
3804 rif
->clear_end_of_line (w
, updated_row
, TEXT_AREA
, xlim
);
3813 /* Update row VPOS in window W. Value is true if display has been changed. */
3816 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3818 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3819 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3820 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3823 /* A row can be completely invisible in case a desired matrix was
3824 built with a vscroll and then make_cursor_line_fully_visible shifts
3825 the matrix. Make sure to make such rows current anyway, since
3826 we need the correct y-position, for example, in the current matrix. */
3827 if (desired_row
->mode_line_p
3828 || desired_row
->visible_height
> 0)
3830 eassert (desired_row
->enabled_p
);
3832 /* Update display of the left margin area, if there is one. */
3833 if (!desired_row
->full_width_p
&& w
->left_margin_cols
> 0)
3836 update_marginal_area (w
, desired_row
, LEFT_MARGIN_AREA
, vpos
);
3837 /* Setting this flag will ensure the vertical border, if
3838 any, between this window and the one on its left will be
3839 redrawn. This is necessary because updating the left
3840 margin area can potentially draw over the border. */
3841 current_row
->redraw_fringe_bitmaps_p
= 1;
3844 /* Update the display of the text area. */
3845 if (update_text_area (w
, desired_row
, vpos
))
3848 if (current_row
->mouse_face_p
)
3849 *mouse_face_overwritten_p
= 1;
3852 /* Update display of the right margin area, if there is one. */
3853 if (!desired_row
->full_width_p
&& w
->right_margin_cols
> 0)
3856 update_marginal_area (w
, desired_row
, RIGHT_MARGIN_AREA
, vpos
);
3859 /* Draw truncation marks etc. */
3860 if (!current_row
->enabled_p
3861 || desired_row
->y
!= current_row
->y
3862 || desired_row
->visible_height
!= current_row
->visible_height
3863 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3864 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3865 || current_row
->redraw_fringe_bitmaps_p
3866 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3867 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3868 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3869 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3870 rif
->after_update_window_line_hook (w
, desired_row
);
3873 /* Update current_row from desired_row. */
3874 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3879 /* Set the cursor after an update of window W. This function may only
3880 be called from update_window. */
3883 set_window_cursor_after_update (struct window
*w
)
3885 struct frame
*f
= XFRAME (w
->frame
);
3886 int cx
, cy
, vpos
, hpos
;
3888 /* Not intended for frame matrix updates. */
3889 eassert (FRAME_WINDOW_P (f
));
3891 if (cursor_in_echo_area
3892 && !NILP (echo_area_buffer
[0])
3893 /* If we are showing a message instead of the mini-buffer,
3894 show the cursor for the message instead. */
3895 && XWINDOW (minibuf_window
) == w
3896 && EQ (minibuf_window
, echo_area_window
)
3897 /* These cases apply only to the frame that contains
3898 the active mini-buffer window. */
3899 && FRAME_HAS_MINIBUF_P (f
)
3900 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3902 cx
= cy
= vpos
= hpos
= 0;
3904 if (cursor_in_echo_area
>= 0)
3906 /* If the mini-buffer is several lines high, find the last
3907 line that has any text on it. Note: either all lines
3908 are enabled or none. Otherwise we wouldn't be able to
3910 struct glyph_row
*row
, *last_row
;
3911 struct glyph
*glyph
;
3912 int yb
= window_text_bottom_y (w
);
3915 row
= w
->current_matrix
->rows
;
3916 while (row
->enabled_p
3917 && (last_row
== NULL
3918 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3920 if (row
->used
[TEXT_AREA
]
3921 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3928 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
3929 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
3931 while (last
> start
&& last
->charpos
< 0)
3934 for (glyph
= start
; glyph
< last
; ++glyph
)
3936 cx
+= glyph
->pixel_width
;
3941 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
3949 hpos
= w
->cursor
.hpos
;
3950 vpos
= w
->cursor
.vpos
;
3953 /* Window cursor can be out of sync for horizontally split windows.
3954 Horizontal position is -1 when cursor is on the left fringe. */
3955 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
3956 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
3957 output_cursor_to (w
, vpos
, hpos
, cy
, cx
);
3961 /* Set WINDOW->must_be_updated_p to ON_P for all windows in
3962 the window tree rooted at W. */
3965 set_window_update_flags (struct window
*w
, bool on_p
)
3969 if (WINDOWP (w
->contents
))
3970 set_window_update_flags (XWINDOW (w
->contents
), on_p
);
3972 w
->must_be_updated_p
= on_p
;
3974 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3980 /***********************************************************************
3981 Window-Based Scrolling
3982 ***********************************************************************/
3984 /* Structure describing rows in scrolling_window. */
3988 /* Number of occurrences of this row in desired and current matrix. */
3989 int old_uses
, new_uses
;
3991 /* Vpos of row in new matrix. */
3992 int new_line_number
;
3994 /* Bucket index of this row_entry in the hash table row_table. */
3997 /* The row described by this entry. */
3998 struct glyph_row
*row
;
4000 /* Hash collision chain. */
4001 struct row_entry
*next
;
4004 /* A pool to allocate row_entry structures from, and the size of the
4005 pool. The pool is reallocated in scrolling_window when we find
4006 that we need a larger one. */
4008 static struct row_entry
*row_entry_pool
;
4009 static ptrdiff_t row_entry_pool_size
;
4011 /* Index of next free entry in row_entry_pool. */
4013 static ptrdiff_t row_entry_idx
;
4015 /* The hash table used during scrolling, and the table's size. This
4016 table is used to quickly identify equal rows in the desired and
4019 static struct row_entry
**row_table
;
4020 static ptrdiff_t row_table_size
;
4022 /* Vectors of pointers to row_entry structures belonging to the
4023 current and desired matrix, and the size of the vectors. */
4025 static struct row_entry
**old_lines
, **new_lines
;
4026 static ptrdiff_t old_lines_size
, new_lines_size
;
4028 /* A pool to allocate run structures from, and its size. */
4030 static struct run
*run_pool
;
4031 static ptrdiff_t runs_size
;
4033 /* A vector of runs of lines found during scrolling. */
4035 static struct run
**runs
;
4037 /* Add glyph row ROW to the scrolling hash table. */
4039 static struct row_entry
*
4040 add_row_entry (struct glyph_row
*row
)
4042 struct row_entry
*entry
;
4043 ptrdiff_t i
= row
->hash
% row_table_size
;
4045 entry
= row_table
[i
];
4046 eassert (entry
|| verify_row_hash (row
));
4047 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4048 entry
= entry
->next
;
4052 entry
= row_entry_pool
+ row_entry_idx
++;
4054 entry
->old_uses
= entry
->new_uses
= 0;
4055 entry
->new_line_number
= 0;
4057 entry
->next
= row_table
[i
];
4058 row_table
[i
] = entry
;
4065 /* Try to reuse part of the current display of W by scrolling lines.
4066 HEADER_LINE_P means W has a header line.
4068 The algorithm is taken from Communications of the ACM, Apr78 "A
4069 Technique for Isolating Differences Between Files." It should take
4072 A short outline of the steps of the algorithm
4074 1. Skip lines equal at the start and end of both matrices.
4076 2. Enter rows in the current and desired matrix into a symbol
4077 table, counting how often they appear in both matrices.
4079 3. Rows that appear exactly once in both matrices serve as anchors,
4080 i.e. we assume that such lines are likely to have been moved.
4082 4. Starting from anchor lines, extend regions to be scrolled both
4083 forward and backward.
4087 -1 if all rows were found to be equal.
4088 0 to indicate that we did not scroll the display, or
4089 1 if we did scroll. */
4092 scrolling_window (struct window
*w
, bool header_line_p
)
4094 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4095 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4096 int yb
= window_text_bottom_y (w
);
4098 int j
, first_old
, first_new
, last_old
, last_new
;
4101 struct row_entry
*entry
;
4102 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4104 /* Skip over rows equal at the start. */
4105 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4107 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4108 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4112 && !d
->redraw_fringe_bitmaps_p
4114 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4115 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4116 && row_equal_p (c
, d
, 1))
4119 d
->enabled_p
= false;
4125 /* Give up if some rows in the desired matrix are not enabled. */
4126 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4129 first_old
= first_new
= i
;
4131 /* Set last_new to the index + 1 of the row that reaches the
4132 bottom boundary in the desired matrix. Give up if we find a
4133 disabled row before we reach the bottom boundary. */
4135 while (i
< desired_matrix
->nrows
- 1)
4139 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4141 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4150 /* Set last_old to the index + 1 of the row that reaches the bottom
4151 boundary in the current matrix. We don't look at the enabled
4152 flag here because we plan to reuse part of the display even if
4153 other parts are disabled. */
4155 while (i
< current_matrix
->nrows
- 1)
4157 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4166 /* Skip over rows equal at the bottom. */
4169 while (i
- 1 > first_new
4170 && j
- 1 > first_old
4171 && MATRIX_ROW_ENABLED_P (current_matrix
, j
- 1)
4172 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4173 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4174 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4175 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4176 MATRIX_ROW (current_matrix
, j
- 1), 1))
4181 /* Nothing to do if all rows are equal. */
4182 if (last_new
== first_new
)
4185 /* Check for integer overflow in size calculation.
4187 If next_almost_prime checks (N) for divisibility by 2..10, then
4188 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4189 So, set next_almost_prime_increment_max to 10.
4191 It's just a coincidence that next_almost_prime_increment_max ==
4192 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4193 13, then next_almost_prime_increment_max would be 14, e.g.,
4194 because next_almost_prime (113) would be 127. */
4196 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4197 enum { next_almost_prime_increment_max
= 10 };
4198 ptrdiff_t row_table_max
=
4199 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4200 - next_almost_prime_increment_max
);
4201 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4202 if (current_nrows_max
< current_matrix
->nrows
)
4203 memory_full (SIZE_MAX
);
4206 /* Reallocate vectors, tables etc. if necessary. */
4208 if (current_matrix
->nrows
> old_lines_size
)
4209 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4210 current_matrix
->nrows
- old_lines_size
,
4211 INT_MAX
, sizeof *old_lines
);
4213 if (desired_matrix
->nrows
> new_lines_size
)
4214 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4215 desired_matrix
->nrows
- new_lines_size
,
4216 INT_MAX
, sizeof *new_lines
);
4218 n
= desired_matrix
->nrows
;
4219 n
+= current_matrix
->nrows
;
4220 if (row_table_size
< 3 * n
)
4222 ptrdiff_t size
= next_almost_prime (3 * n
);
4223 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4224 row_table_size
= size
;
4225 memset (row_table
, 0, size
* sizeof *row_table
);
4228 if (n
> row_entry_pool_size
)
4229 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4230 n
- row_entry_pool_size
,
4231 -1, sizeof *row_entry_pool
);
4233 if (desired_matrix
->nrows
> runs_size
)
4235 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4236 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4237 runs_size
= desired_matrix
->nrows
;
4240 nruns
= run_idx
= 0;
4243 /* Add rows from the current and desired matrix to the hash table
4244 row_hash_table to be able to find equal ones quickly. */
4246 for (i
= first_old
; i
< last_old
; ++i
)
4248 if (MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4250 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4251 old_lines
[i
] = entry
;
4255 old_lines
[i
] = NULL
;
4258 for (i
= first_new
; i
< last_new
; ++i
)
4260 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4261 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4263 entry
->new_line_number
= i
;
4264 new_lines
[i
] = entry
;
4267 /* Identify moves based on lines that are unique and equal
4268 in both matrices. */
4269 for (i
= first_old
; i
< last_old
;)
4271 && old_lines
[i
]->old_uses
== 1
4272 && old_lines
[i
]->new_uses
== 1)
4275 int new_line
= old_lines
[i
]->new_line_number
;
4276 struct run
*run
= run_pool
+ run_idx
++;
4279 run
->current_vpos
= i
;
4280 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4281 run
->desired_vpos
= new_line
;
4282 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4284 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4286 /* Extend backward. */
4289 while (p
> first_old
4291 && old_lines
[p
] == new_lines
[q
])
4293 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4294 --run
->current_vpos
;
4295 --run
->desired_vpos
;
4298 run
->desired_y
-= h
;
4299 run
->current_y
-= h
;
4303 /* Extend forward. */
4308 && old_lines
[p
] == new_lines
[q
])
4310 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4316 /* Insert run into list of all runs. Order runs by copied
4317 pixel lines. Note that we record runs that don't have to
4318 be copied because they are already in place. This is done
4319 because we can avoid calling update_window_line in this
4321 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4323 for (q
= nruns
; q
> p
; --q
)
4324 runs
[q
] = runs
[q
- 1];
4333 /* Do the moves. Do it in a way that we don't overwrite something
4334 we want to copy later on. This is not solvable in general
4335 because there is only one display and we don't have a way to
4336 exchange areas on this display. Example:
4338 +-----------+ +-----------+
4340 +-----------+ --> +-----------+
4342 +-----------+ +-----------+
4344 Instead, prefer bigger moves, and invalidate moves that would
4345 copy from where we copied to. */
4347 for (i
= 0; i
< nruns
; ++i
)
4348 if (runs
[i
]->nrows
> 0)
4350 struct run
*r
= runs
[i
];
4352 /* Copy on the display. */
4353 if (r
->current_y
!= r
->desired_y
)
4355 rif
->clear_window_mouse_face (w
);
4356 rif
->scroll_run_hook (w
, r
);
4359 /* Truncate runs that copy to where we copied to, and
4360 invalidate runs that copy from where we copied to. */
4361 for (j
= nruns
- 1; j
> i
; --j
)
4363 struct run
*p
= runs
[j
];
4364 bool truncated_p
= 0;
4367 && p
->desired_y
< r
->desired_y
+ r
->height
4368 && p
->desired_y
+ p
->height
> r
->desired_y
)
4370 if (p
->desired_y
< r
->desired_y
)
4372 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4373 p
->height
= r
->desired_y
- p
->desired_y
;
4378 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4381 if (p
->nrows
<= nrows_copied
)
4385 int height_copied
= (r
->desired_y
+ r
->height
4388 p
->current_vpos
+= nrows_copied
;
4389 p
->desired_vpos
+= nrows_copied
;
4390 p
->nrows
-= nrows_copied
;
4391 p
->current_y
+= height_copied
;
4392 p
->desired_y
+= height_copied
;
4393 p
->height
-= height_copied
;
4399 if (r
->current_y
!= r
->desired_y
4400 /* The condition below is equivalent to
4401 ((p->current_y >= r->desired_y
4402 && p->current_y < r->desired_y + r->height)
4403 || (p->current_y + p->height > r->desired_y
4404 && (p->current_y + p->height
4405 <= r->desired_y + r->height)))
4406 because we have 0 < p->height <= r->height. */
4407 && p
->current_y
< r
->desired_y
+ r
->height
4408 && p
->current_y
+ p
->height
> r
->desired_y
)
4411 /* Reorder runs by copied pixel lines if truncated. */
4412 if (truncated_p
&& p
->nrows
> 0)
4416 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4418 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4423 /* Assign matrix rows. */
4424 for (j
= 0; j
< r
->nrows
; ++j
)
4426 struct glyph_row
*from
, *to
;
4427 bool to_overlapped_p
;
4429 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4430 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4431 to_overlapped_p
= to
->overlapped_p
;
4432 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4433 assign_row (to
, from
);
4434 /* The above `assign_row' actually does swap, so if we had
4435 an overlap in the copy destination of two runs, then
4436 the second run would assign a previously disabled bogus
4437 row. But thanks to the truncation code in the
4438 preceding for-loop, we no longer have such an overlap,
4439 and thus the assigned row should always be enabled. */
4440 eassert (to
->enabled_p
);
4441 from
->enabled_p
= false;
4442 to
->overlapped_p
= to_overlapped_p
;
4446 /* Clear the hash table, for the next time. */
4447 for (i
= 0; i
< row_entry_idx
; ++i
)
4448 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4450 /* Value is 1 to indicate that we scrolled the display. */
4456 /************************************************************************
4458 ************************************************************************/
4460 /* Update the desired frame matrix of frame F.
4462 FORCE_P means that the update should not be stopped by pending input.
4463 INHIBIT_ID_P means that scrolling by insert/delete should not be tried.
4464 SET_CURSOR_P false means do not set cursor at point in selected window.
4466 Value is true if update was stopped due to pending input. */
4469 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
,
4472 /* Frame matrices to work on. */
4473 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4474 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4477 int preempt_count
= baud_rate
/ 2400 + 1;
4479 eassert (current_matrix
&& desired_matrix
);
4481 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4482 calculate_costs (f
);
4484 if (preempt_count
<= 0)
4487 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4493 /* If we cannot insert/delete lines, it's no use trying it. */
4494 if (!FRAME_LINE_INS_DEL_OK (f
))
4497 /* See if any of the desired lines are enabled; don't compute for
4498 i/d line if just want cursor motion. */
4499 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4500 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4503 /* Try doing i/d line, if not yet inhibited. */
4504 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4505 force_p
|= scrolling (f
);
4507 /* Update the individual lines as needed. Do bottom line first. */
4508 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4509 update_frame_line (f
, desired_matrix
->nrows
- 1);
4511 /* Now update the rest of the lines. */
4512 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4514 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4516 if (FRAME_TERMCAP_P (f
))
4518 /* Flush out every so many lines.
4519 Also flush out if likely to have more than 1k buffered
4520 otherwise. I'm told that some telnet connections get
4521 really screwed by more than 1k output at once. */
4522 FILE *display_output
= FRAME_TTY (f
)->output
;
4525 ptrdiff_t outq
= __fpending (display_output
);
4527 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4528 fflush (display_output
);
4532 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4533 detect_input_pending_ignore_squeezables ();
4535 update_frame_line (f
, i
);
4539 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4541 /* Now just clean up termcap drivers and set cursor, etc. */
4542 if (!pause_p
&& set_cursor_p
)
4544 if ((cursor_in_echo_area
4545 /* If we are showing a message instead of the mini-buffer,
4546 show the cursor for the message instead of for the
4547 (now hidden) mini-buffer contents. */
4548 || (EQ (minibuf_window
, selected_window
)
4549 && EQ (minibuf_window
, echo_area_window
)
4550 && !NILP (echo_area_buffer
[0])))
4551 /* These cases apply only to the frame that contains
4552 the active mini-buffer window. */
4553 && FRAME_HAS_MINIBUF_P (f
)
4554 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4556 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4559 if (cursor_in_echo_area
< 0)
4561 /* Negative value of cursor_in_echo_area means put
4562 cursor at beginning of line. */
4568 /* Positive value of cursor_in_echo_area means put
4569 cursor at the end of the prompt. If the mini-buffer
4570 is several lines high, find the last line that has
4572 row
= FRAME_LINES (f
);
4578 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4580 /* Frame rows are filled up with spaces that
4581 must be ignored here. */
4582 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4584 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4585 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4588 && (last
- 1)->charpos
< 0)
4594 while (row
> top
&& col
== 0);
4596 /* Make sure COL is not out of range. */
4597 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4599 /* If we have another row, advance cursor into it. */
4600 if (row
< FRAME_LINES (f
) - 1)
4602 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4605 /* Otherwise move it back in range. */
4607 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4611 cursor_to (f
, row
, col
);
4615 /* We have only one cursor on terminal frames. Use it to
4616 display the cursor of the selected window. */
4617 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4618 if (w
->cursor
.vpos
>= 0
4619 /* The cursor vpos may be temporarily out of bounds
4620 in the following situation: There is one window,
4621 with the cursor in the lower half of it. The window
4622 is split, and a message causes a redisplay before
4623 a new cursor position has been computed. */
4624 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4626 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4627 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4629 x
+= max (0, w
->left_margin_cols
);
4630 cursor_to (f
, y
, x
);
4637 clear_desired_matrices (f
);
4642 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4645 scrolling (struct frame
*frame
)
4647 int unchanged_at_top
, unchanged_at_bottom
;
4650 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4651 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4652 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4653 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4655 int free_at_end_vpos
= FRAME_LINES (frame
);
4656 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4657 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4659 eassert (current_matrix
);
4661 /* Compute hash codes of all the lines. Also calculate number of
4662 changed lines, number of unchanged lines at the beginning, and
4663 number of unchanged lines at the end. */
4665 unchanged_at_top
= 0;
4666 unchanged_at_bottom
= FRAME_LINES (frame
);
4667 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4669 /* Give up on this scrolling if some old lines are not enabled. */
4670 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4672 old_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (current_matrix
, i
));
4673 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4675 /* This line cannot be redrawn, so don't let scrolling mess it. */
4676 new_hash
[i
] = old_hash
[i
];
4677 #define INFINITY 1000000 /* Taken from scroll.c */
4678 draw_cost
[i
] = INFINITY
;
4682 new_hash
[i
] = line_hash_code (frame
, MATRIX_ROW (desired_matrix
, i
));
4683 draw_cost
[i
] = line_draw_cost (frame
, desired_matrix
, i
);
4686 if (old_hash
[i
] != new_hash
[i
])
4689 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4691 else if (i
== unchanged_at_top
)
4693 old_draw_cost
[i
] = line_draw_cost (frame
, current_matrix
, i
);
4696 /* If changed lines are few, don't allow preemption, don't scroll. */
4697 if ((!FRAME_SCROLL_REGION_OK (frame
)
4698 && changed_lines
< baud_rate
/ 2400)
4699 || unchanged_at_bottom
== FRAME_LINES (frame
))
4702 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4703 - unchanged_at_bottom
);
4705 if (FRAME_SCROLL_REGION_OK (frame
))
4706 free_at_end_vpos
-= unchanged_at_bottom
;
4707 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4708 free_at_end_vpos
= -1;
4710 /* If large window, fast terminal and few lines in common between
4711 current frame and desired frame, don't bother with i/d calc. */
4712 if (!FRAME_SCROLL_REGION_OK (frame
)
4713 && window_size
>= 18 && baud_rate
> 2400
4715 10 * scrolling_max_lines_saved (unchanged_at_top
,
4716 FRAME_LINES (frame
) - unchanged_at_bottom
,
4717 old_hash
, new_hash
, draw_cost
)))
4720 if (window_size
< 2)
4723 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4724 draw_cost
+ unchanged_at_top
- 1,
4725 old_draw_cost
+ unchanged_at_top
- 1,
4726 old_hash
+ unchanged_at_top
- 1,
4727 new_hash
+ unchanged_at_top
- 1,
4728 free_at_end_vpos
- unchanged_at_top
);
4734 /* Count the number of blanks at the start of the vector of glyphs R
4735 which is LEN glyphs long. */
4738 count_blanks (struct glyph
*r
, int len
)
4742 for (i
= 0; i
< len
; ++i
)
4743 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4750 /* Count the number of glyphs in common at the start of the glyph
4751 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4752 of STR2. Value is the number of equal glyphs equal at the start. */
4755 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4757 struct glyph
*p1
= str1
;
4758 struct glyph
*p2
= str2
;
4762 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4769 /* Char insertion/deletion cost vector, from term.c */
4771 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4774 /* Perform a frame-based update on line VPOS in frame FRAME. */
4777 update_frame_line (struct frame
*f
, int vpos
)
4779 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4781 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4782 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4783 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4784 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4785 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4786 bool must_write_whole_line_p
;
4787 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4788 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4789 != FACE_TTY_DEFAULT_BG_COLOR
);
4791 if (colored_spaces_p
)
4794 /* Current row not enabled means it has unknown contents. We must
4795 write the whole desired line in that case. */
4796 must_write_whole_line_p
= !current_row
->enabled_p
;
4797 if (must_write_whole_line_p
)
4804 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4805 olen
= current_row
->used
[TEXT_AREA
];
4807 /* Ignore trailing spaces, if we can. */
4808 if (!write_spaces_p
)
4809 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4813 current_row
->enabled_p
= true;
4814 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4816 /* If desired line is empty, just clear the line. */
4817 if (!desired_row
->enabled_p
)
4823 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4824 nlen
= desired_row
->used
[TEXT_AREA
];
4825 nend
= nbody
+ nlen
;
4827 /* If display line has unknown contents, write the whole line. */
4828 if (must_write_whole_line_p
)
4830 /* Ignore spaces at the end, if we can. */
4831 if (!write_spaces_p
)
4832 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4835 /* Write the contents of the desired line. */
4838 cursor_to (f
, vpos
, 0);
4839 write_glyphs (f
, nbody
, nlen
);
4842 /* Don't call clear_end_of_line if we already wrote the whole
4843 line. The cursor will not be at the right margin in that
4844 case but in the line below. */
4845 if (nlen
< FRAME_TOTAL_COLS (f
))
4847 cursor_to (f
, vpos
, nlen
);
4848 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4851 /* Make sure we are in the right row, otherwise cursor movement
4852 with cmgoto might use `ch' in the wrong row. */
4853 cursor_to (f
, vpos
, 0);
4855 make_current (desired_matrix
, current_matrix
, vpos
);
4859 /* Pretend trailing spaces are not there at all,
4860 unless for one reason or another we must write all spaces. */
4861 if (!write_spaces_p
)
4862 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4865 /* If there's no i/d char, quickly do the best we can without it. */
4866 if (!FRAME_CHAR_INS_DEL_OK (f
))
4870 /* Find the first glyph in desired row that doesn't agree with
4871 a glyph in the current row, and write the rest from there on. */
4872 for (i
= 0; i
< nlen
; i
++)
4874 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4876 /* Find the end of the run of different glyphs. */
4880 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4881 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4884 /* Output this run of non-matching chars. */
4885 cursor_to (f
, vpos
, i
);
4886 write_glyphs (f
, nbody
+ i
, j
- i
);
4889 /* Now find the next non-match. */
4893 /* Clear the rest of the line, or the non-clear part of it. */
4896 cursor_to (f
, vpos
, nlen
);
4897 clear_end_of_line (f
, olen
);
4900 /* Make current row = desired row. */
4901 make_current (desired_matrix
, current_matrix
, vpos
);
4905 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
4906 characters in a row. */
4910 /* If current line is blank, skip over initial spaces, if
4911 possible, and write the rest. */
4915 nsp
= count_blanks (nbody
, nlen
);
4919 cursor_to (f
, vpos
, nsp
);
4920 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
4923 /* Exchange contents between current_frame and new_frame. */
4924 make_current (desired_matrix
, current_matrix
, vpos
);
4928 /* Compute number of leading blanks in old and new contents. */
4929 osp
= count_blanks (obody
, olen
);
4930 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
4932 /* Compute number of matching chars starting with first non-blank. */
4933 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
4934 nbody
+ nsp
, nbody
+ nlen
);
4936 /* Spaces in new match implicit space past the end of old. */
4937 /* A bug causing this to be a no-op was fixed in 18.29. */
4938 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
4941 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
4945 /* Avoid doing insert/delete char
4946 just cause number of leading spaces differs
4947 when the following text does not match. */
4948 if (begmatch
== 0 && osp
!= nsp
)
4949 osp
= nsp
= min (osp
, nsp
);
4951 /* Find matching characters at end of line */
4954 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
4956 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
4961 endmatch
= obody
+ olen
- op1
;
4963 /* tem gets the distance to insert or delete.
4964 endmatch is how many characters we save by doing so.
4967 tem
= (nlen
- nsp
) - (olen
- osp
);
4969 && (!FRAME_CHAR_INS_DEL_OK (f
)
4970 || endmatch
<= char_ins_del_cost (f
)[tem
]))
4973 /* nsp - osp is the distance to insert or delete.
4974 If that is nonzero, begmatch is known to be nonzero also.
4975 begmatch + endmatch is how much we save by doing the ins/del.
4979 && (!FRAME_CHAR_INS_DEL_OK (f
)
4980 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
4984 osp
= nsp
= min (osp
, nsp
);
4987 /* Now go through the line, inserting, writing and
4988 deleting as appropriate. */
4992 cursor_to (f
, vpos
, nsp
);
4993 delete_glyphs (f
, osp
- nsp
);
4997 /* If going to delete chars later in line
4998 and insert earlier in the line,
4999 must delete first to avoid losing data in the insert */
5000 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5002 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5003 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5004 olen
= nlen
- (nsp
- osp
);
5006 cursor_to (f
, vpos
, osp
);
5007 insert_glyphs (f
, 0, nsp
- osp
);
5011 tem
= nsp
+ begmatch
+ endmatch
;
5012 if (nlen
!= tem
|| olen
!= tem
)
5014 if (!endmatch
|| nlen
== olen
)
5016 /* If new text being written reaches right margin, there is
5017 no need to do clear-to-eol at the end of this function
5018 (and it would not be safe, since cursor is not going to
5019 be "at the margin" after the text is done). */
5020 if (nlen
== FRAME_TOTAL_COLS (f
))
5023 /* Function write_glyphs is prepared to do nothing
5024 if passed a length <= 0. Check it here to avoid
5025 unnecessary cursor movement. */
5028 cursor_to (f
, vpos
, nsp
+ begmatch
);
5029 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5032 else if (nlen
> olen
)
5034 /* Here, we used to have the following simple code:
5035 ----------------------------------------
5036 write_glyphs (nbody + nsp + begmatch, olen - tem);
5037 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5038 ----------------------------------------
5039 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5040 is a padding glyph. */
5041 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5044 cursor_to (f
, vpos
, nsp
+ begmatch
);
5046 /* Calculate columns we can actually overwrite. */
5047 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5049 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5051 /* If we left columns to be overwritten, we must delete them. */
5052 del
= olen
- tem
- out
;
5054 delete_glyphs (f
, del
);
5056 /* At last, we insert columns not yet written out. */
5057 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5060 else if (olen
> nlen
)
5062 cursor_to (f
, vpos
, nsp
+ begmatch
);
5063 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5064 delete_glyphs (f
, olen
- nlen
);
5070 /* If any unerased characters remain after the new line, erase them. */
5073 cursor_to (f
, vpos
, nlen
);
5074 clear_end_of_line (f
, olen
);
5077 /* Exchange contents between current_frame and new_frame. */
5078 make_current (desired_matrix
, current_matrix
, vpos
);
5083 /***********************************************************************
5084 X/Y Position -> Buffer Position
5085 ***********************************************************************/
5087 /* Determine what's under window-relative pixel position (*X, *Y).
5088 Return the OBJECT (string or buffer) that's there.
5089 Return in *POS the position in that object.
5090 Adjust *X and *Y to character positions.
5091 Return in *DX and *DY the pixel coordinates of the click,
5092 relative to the top left corner of OBJECT, or relative to
5093 the top left corner of the character glyph at (*X, *Y)
5095 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5096 if the coordinates point to an empty area of the display. */
5099 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
)
5102 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5103 struct text_pos startp
;
5105 struct glyph_row
*row
;
5106 #ifdef HAVE_WINDOW_SYSTEM
5107 struct image
*img
= 0;
5109 int x0
, x1
, to_x
, it_vpos
;
5110 void *itdata
= NULL
;
5112 /* We used to set current_buffer directly here, but that does the
5113 wrong thing with `face-remapping-alist' (bug#2044). */
5114 Fset_buffer (w
->contents
);
5115 itdata
= bidi_shelve_cache ();
5116 CLIP_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5117 start_display (&it
, w
, startp
);
5120 /* First, move to the beginning of the row corresponding to *Y. We
5121 need to be in that row to get the correct value of base paragraph
5122 direction for the text at (*X, *Y). */
5123 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5125 /* TO_X is the pixel position that the iterator will compute for the
5128 if (it
.bidi_it
.paragraph_dir
== R2L
)
5129 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5130 text area. This is because the iterator, even in R2L
5131 paragraphs, delivers glyphs as if they started at the left
5132 margin of the window. (When we actually produce glyphs for
5133 display, we reverse their order in PRODUCE_GLYPHS, but the
5134 iterator doesn't know about that.) The following line adjusts
5135 the pixel position to the iterator geometry, which is what
5136 move_it_* routines use. (The -1 is because in a window whose
5137 text-area width is W, the rightmost pixel position is W-1, and
5138 it should be mirrored into zero pixel position.) */
5139 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5141 /* We need to add it.first_visible_x because iterator positions
5142 include the hscroll. */
5143 to_x
+= it
.first_visible_x
;
5145 /* Now move horizontally in the row to the glyph under *X. Second
5146 argument is ZV to prevent move_it_in_display_line from matching
5147 based on buffer positions. */
5148 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5149 bidi_unshelve_cache (itdata
, 0);
5151 Fset_buffer (old_current_buffer
);
5153 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5154 *dy
= *y
- it
.current_y
;
5156 string
= w
->contents
;
5157 if (STRINGP (it
.string
))
5160 if (it
.what
== IT_COMPOSITION
5161 && it
.cmp_it
.nchars
> 1
5162 && it
.cmp_it
.reversed_p
)
5164 /* The current display element is a grapheme cluster in a
5165 composition. In that case, we need the position of the first
5166 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5167 it.current points to the last character of the cluster, thus
5168 we must move back to the first character of the same
5170 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5171 if (STRINGP (it
.string
))
5172 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5174 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->contents
),
5175 CHARPOS (pos
->pos
));
5178 #ifdef HAVE_WINDOW_SYSTEM
5179 if (it
.what
== IT_IMAGE
)
5181 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5182 && !NILP (img
->spec
))
5183 *object
= img
->spec
;
5187 /* IT's vpos counts from the glyph row that includes the window's
5188 start position, i.e. it excludes the header-line row, but
5189 MATRIX_ROW includes the header-line row. Adjust for a possible
5191 it_vpos
= it
.vpos
+ WINDOW_WANTS_MODELINE_P (w
);
5192 if (it_vpos
< w
->current_matrix
->nrows
5193 && (row
= MATRIX_ROW (w
->current_matrix
, it_vpos
),
5196 if (it
.hpos
< row
->used
[TEXT_AREA
])
5198 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5199 #ifdef HAVE_WINDOW_SYSTEM
5202 *dy
-= row
->ascent
- glyph
->ascent
;
5203 *dx
+= glyph
->slice
.img
.x
;
5204 *dy
+= glyph
->slice
.img
.y
;
5205 /* Image slices positions are still relative to the entire image */
5206 *width
= img
->width
;
5207 *height
= img
->height
;
5212 *width
= glyph
->pixel_width
;
5213 *height
= glyph
->ascent
+ glyph
->descent
;
5219 *height
= row
->height
;
5224 *width
= *height
= 0;
5227 /* Add extra (default width) columns if clicked after EOL. */
5228 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5230 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5239 /* Value is the string under window-relative coordinates X/Y in the
5240 mode line or header line (PART says which) of window W, or nil if none.
5241 *CHARPOS is set to the position in the string returned. */
5244 mode_line_string (struct window
*w
, enum window_part part
,
5245 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5246 int *dx
, int *dy
, int *width
, int *height
)
5248 struct glyph_row
*row
;
5249 struct glyph
*glyph
, *end
;
5251 Lisp_Object string
= Qnil
;
5253 if (part
== ON_MODE_LINE
)
5254 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5256 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5258 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5260 if (row
->mode_line_p
&& row
->enabled_p
)
5262 /* Find the glyph under X. If we find one with a string object,
5263 it's the one we were looking for. */
5264 glyph
= row
->glyphs
[TEXT_AREA
];
5265 end
= glyph
+ row
->used
[TEXT_AREA
];
5266 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5267 x0
-= glyph
->pixel_width
;
5268 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5271 string
= glyph
->object
;
5272 *charpos
= glyph
->charpos
;
5273 *width
= glyph
->pixel_width
;
5274 *height
= glyph
->ascent
+ glyph
->descent
;
5275 #ifdef HAVE_WINDOW_SYSTEM
5276 if (glyph
->type
== IMAGE_GLYPH
)
5279 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5281 *object
= img
->spec
;
5282 y0
-= row
->ascent
- glyph
->ascent
;
5288 /* Add extra (default width) columns if clicked after EOL. */
5289 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5291 *height
= row
->height
;
5298 *width
= *height
= 0;
5308 /* Value is the string under window-relative coordinates X/Y in either
5309 marginal area, or nil if none. *CHARPOS is set to the position in
5310 the string returned. */
5313 marginal_area_string (struct window
*w
, enum window_part part
,
5314 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5315 int *dx
, int *dy
, int *width
, int *height
)
5317 struct glyph_row
*row
= w
->current_matrix
->rows
;
5318 struct glyph
*glyph
, *end
;
5319 int x0
, y0
, i
, wy
= *y
;
5321 Lisp_Object string
= Qnil
;
5323 if (part
== ON_LEFT_MARGIN
)
5324 area
= LEFT_MARGIN_AREA
;
5325 else if (part
== ON_RIGHT_MARGIN
)
5326 area
= RIGHT_MARGIN_AREA
;
5330 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5331 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5334 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5338 /* Find the glyph under X. If we find one with a string object,
5339 it's the one we were looking for. */
5340 if (area
== RIGHT_MARGIN_AREA
)
5341 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5342 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5343 : WINDOW_FRINGES_WIDTH (w
))
5344 + window_box_width (w
, LEFT_MARGIN_AREA
)
5345 + window_box_width (w
, TEXT_AREA
));
5347 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5348 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5351 glyph
= row
->glyphs
[area
];
5352 end
= glyph
+ row
->used
[area
];
5353 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5354 x0
-= glyph
->pixel_width
;
5355 *x
= glyph
- row
->glyphs
[area
];
5358 string
= glyph
->object
;
5359 *charpos
= glyph
->charpos
;
5360 *width
= glyph
->pixel_width
;
5361 *height
= glyph
->ascent
+ glyph
->descent
;
5362 #ifdef HAVE_WINDOW_SYSTEM
5363 if (glyph
->type
== IMAGE_GLYPH
)
5366 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5368 *object
= img
->spec
;
5369 y0
-= row
->ascent
- glyph
->ascent
;
5370 x0
+= glyph
->slice
.img
.x
;
5371 y0
+= glyph
->slice
.img
.y
;
5377 /* Add extra (default width) columns if clicked after EOL. */
5378 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5380 *height
= row
->height
;
5387 *width
= *height
= 0;
5397 /***********************************************************************
5398 Changing Frame Sizes
5399 ***********************************************************************/
5403 static void deliver_window_change_signal (int);
5406 handle_window_change_signal (int sig
)
5409 struct tty_display_info
*tty
;
5411 /* The frame size change obviously applies to a single
5412 termcap-controlled terminal, but we can't decide which.
5413 Therefore, we resize the frames corresponding to each tty.
5415 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5417 if (! tty
->term_initted
)
5420 /* Suspended tty frames have tty->input == NULL avoid trying to
5425 get_tty_size (fileno (tty
->input
), &width
, &height
);
5427 if (width
> 5 && height
> 2) {
5428 Lisp_Object tail
, frame
;
5430 FOR_EACH_FRAME (tail
, frame
)
5431 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5432 /* Record the new sizes, but don't reallocate the data
5433 structures now. Let that be done later outside of the
5435 change_frame_size (XFRAME (frame
), width
, height
, 0, 1, 0, 0);
5441 deliver_window_change_signal (int sig
)
5443 deliver_process_signal (sig
, handle_window_change_signal
);
5445 #endif /* SIGWINCH */
5448 /* Do any change in frame size that was requested by a signal.
5449 SAFE means this function is called from a place where it is
5450 safe to change frame sizes while a redisplay is in progress. */
5453 do_pending_window_change (bool safe
)
5455 /* If window change signal handler should have run before, run it now. */
5456 if (redisplaying_p
&& !safe
)
5459 while (delayed_size_change
)
5461 Lisp_Object tail
, frame
;
5463 delayed_size_change
= 0;
5465 FOR_EACH_FRAME (tail
, frame
)
5467 struct frame
*f
= XFRAME (frame
);
5469 if (f
->new_height
!= 0 || f
->new_width
!= 0)
5470 change_frame_size (f
, f
->new_width
, f
->new_height
,
5471 0, 0, safe
, f
->new_pixelwise
);
5476 /* Change the frame height and/or width. Values may be given as zero to
5477 indicate no change is to take place.
5479 new_height and new_width refer to the text portion of the frame. It
5480 doesn't matter for new_height, since text and total portion are the
5481 same in that case. But new_width must be enlarged to get the total
5484 If DELAY, assume we're being called from a signal handler, and
5485 queue the change for later - perhaps the next redisplay.
5486 Since this tries to resize windows, we can't call it
5487 from a signal handler.
5489 SAFE means this function is called from a place where it's
5490 safe to change frame sizes while a redisplay is in progress. */
5493 change_frame_size (struct frame
*f
, int new_width
, int new_height
,
5494 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5496 Lisp_Object tail
, frame
;
5498 if (FRAME_MSDOS_P (f
))
5500 /* On MS-DOS, all frames use the same screen, so a change in
5501 size affects all frames. Termcap now supports multiple
5503 FOR_EACH_FRAME (tail
, frame
)
5504 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5505 change_frame_size_1 (XFRAME (frame
), new_width
, new_height
,
5506 pretend
, delay
, safe
, pixelwise
);
5509 change_frame_size_1 (f
, new_width
, new_height
, pretend
, delay
, safe
,
5514 change_frame_size_1 (struct frame
*f
, int new_width
, int new_height
,
5515 bool pretend
, bool delay
, bool safe
, bool pixelwise
)
5517 int new_text_width
, new_text_height
, new_root_width
;
5518 int old_root_width
= WINDOW_PIXEL_WIDTH (XWINDOW (FRAME_ROOT_WINDOW (f
)));
5519 int new_cols
, new_lines
;
5520 ptrdiff_t count
= SPECPDL_INDEX ();
5522 /* If we can't deal with the change now, queue it for later. */
5523 if (delay
|| (redisplaying_p
&& !safe
))
5525 f
->new_width
= new_width
;
5526 f
->new_height
= new_height
;
5527 f
->new_pixelwise
= pixelwise
;
5528 delayed_size_change
= 1;
5532 /* This size-change overrides any pending one for this frame. */
5535 f
->new_pixelwise
= 0;
5537 /* If an argument is zero, set it to the current value. */
5540 new_text_width
= (new_width
== 0) ? FRAME_TEXT_WIDTH (f
) : new_width
;
5541 new_text_height
= (new_height
== 0) ? FRAME_TEXT_HEIGHT (f
) : new_height
;
5542 /* Consider rounding here: Currently, the root window can be
5543 larger than the frame in terms of columns/lines. */
5544 new_cols
= new_text_width
/ FRAME_COLUMN_WIDTH (f
);
5545 new_lines
= new_text_height
/ FRAME_LINE_HEIGHT (f
);
5549 new_cols
= (new_width
== 0) ? FRAME_COLS (f
) : new_width
;
5550 new_lines
= (new_height
== 0) ? FRAME_LINES (f
) : new_height
;
5551 new_text_width
= new_cols
* FRAME_COLUMN_WIDTH (f
);
5552 new_text_height
= new_lines
* FRAME_LINE_HEIGHT (f
);
5555 /* Compute width of windows in F. */
5556 /* Round up to the smallest acceptable size. */
5557 check_frame_size (f
, &new_text_width
, &new_text_height
, 1);
5559 /* This is the width of the frame without vertical scroll bars and
5560 fringe columns. Do this after rounding - see discussion of
5562 new_root_width
= (new_text_width
5563 + FRAME_SCROLL_BAR_AREA_WIDTH (f
)
5564 + FRAME_TOTAL_FRINGE_WIDTH (f
));
5565 /* If we're not changing the frame size, quit now. */
5566 /* Frame width may be unchanged but the text portion may change, for
5567 example, fullscreen and remove/add scroll bar. */
5568 if (new_text_height
== FRAME_TEXT_HEIGHT (f
)
5569 && new_text_width
== FRAME_TEXT_WIDTH (f
)
5570 && new_root_width
== old_root_width
5571 && (FRAME_PIXEL_HEIGHT (f
) ==
5572 FRAME_TEXT_TO_PIXEL_HEIGHT (f
, new_text_height
))
5573 && (FRAME_PIXEL_WIDTH (f
) ==
5574 FRAME_TEXT_TO_PIXEL_WIDTH (f
, new_text_width
)))
5580 /* We only can set screen dimensions to certain values supported
5581 by our video hardware. Try to find the smallest size greater
5582 or equal to the requested dimensions. */
5583 dos_set_window_size (&new_lines
, &new_cols
);
5586 if (new_text_height
!= FRAME_TEXT_HEIGHT (f
))
5588 resize_frame_windows (f
, new_text_height
, 0, 1);
5590 /* MSDOS frames cannot PRETEND, as they change frame size by
5591 manipulating video hardware. */
5592 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5593 FrameRows (FRAME_TTY (f
)) = new_lines
;
5596 if (new_text_width
!= FRAME_TEXT_WIDTH (f
)
5597 || new_root_width
!= old_root_width
)
5599 resize_frame_windows (f
, new_root_width
, 1, 1);
5601 /* MSDOS frames cannot PRETEND, as they change frame size by
5602 manipulating video hardware. */
5603 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5604 FrameCols (FRAME_TTY (f
)) = new_cols
;
5606 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5607 if (WINDOWP (f
->tool_bar_window
))
5609 XWINDOW (f
->tool_bar_window
)->total_cols
= new_cols
;
5610 XWINDOW (f
->tool_bar_window
)->pixel_width
= new_root_width
;
5615 SET_FRAME_COLS (f
, new_cols
);
5616 FRAME_LINES (f
) = new_lines
;
5617 FRAME_TEXT_WIDTH (f
) = new_text_width
;
5618 FRAME_TEXT_HEIGHT (f
) = new_text_height
;
5619 FRAME_PIXEL_WIDTH (f
) = FRAME_TEXT_TO_PIXEL_WIDTH (f
, new_text_width
);
5620 FRAME_PIXEL_HEIGHT (f
) = FRAME_TEXT_TO_PIXEL_HEIGHT (f
, new_text_height
);
5623 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5624 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5626 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5628 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5629 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5630 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5631 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5634 adjust_frame_glyphs (f
);
5635 calculate_costs (f
);
5636 SET_FRAME_GARBAGED (f
);
5641 record_unwind_current_buffer ();
5643 run_window_configuration_change_hook (f
);
5645 unbind_to (count
, Qnil
);
5648 /***********************************************************************
5649 Terminal Related Lisp Functions
5650 ***********************************************************************/
5652 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5653 1, 1, "FOpen termscript file: ",
5654 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5655 FILE = nil means just close any termscript file currently open. */)
5658 struct tty_display_info
*tty
;
5660 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5661 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5662 error ("Current frame is not on a tty device");
5666 if (tty
->termscript
!= 0)
5669 fclose (tty
->termscript
);
5670 tty
->termscript
= 0;
5676 file
= Fexpand_file_name (file
, Qnil
);
5677 tty
->termscript
= emacs_fopen (SSDATA (file
), "w");
5678 if (tty
->termscript
== 0)
5679 report_file_error ("Opening termscript", file
);
5685 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5686 Ssend_string_to_terminal
, 1, 2, 0,
5687 doc
: /* Send STRING to the terminal without alteration.
5688 Control characters in STRING will have terminal-dependent effects.
5690 Optional parameter TERMINAL specifies the tty terminal device to use.
5691 It may be a terminal object, a frame, or nil for the terminal used by
5692 the currently selected frame. In batch mode, STRING is sent to stdout
5693 when TERMINAL is nil. */)
5694 (Lisp_Object string
, Lisp_Object terminal
)
5696 struct terminal
*t
= get_terminal (terminal
, 1);
5699 /* ??? Perhaps we should do something special for multibyte strings here. */
5700 CHECK_STRING (string
);
5704 error ("Unknown terminal device");
5706 if (t
->type
== output_initial
)
5708 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5709 error ("Device %d is not a termcap terminal device", t
->id
);
5712 struct tty_display_info
*tty
= t
->display_info
.tty
;
5715 error ("Terminal is currently suspended");
5717 if (tty
->termscript
)
5719 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5720 fflush (tty
->termscript
);
5724 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5731 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5732 doc
: /* Beep, or flash the screen.
5733 Also, unless an argument is given,
5734 terminate any keyboard macro currently executing. */)
5742 ring_bell (XFRAME (selected_frame
));
5751 bitch_at_user (void)
5755 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5758 = "Keyboard macro terminated by a command ringing the bell";
5759 Fsignal (Quser_error
, list1 (build_string (msg
)));
5762 ring_bell (XFRAME (selected_frame
));
5767 /***********************************************************************
5769 ***********************************************************************/
5771 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5772 doc
: /* Pause, without updating display, for SECONDS seconds.
5773 SECONDS may be a floating-point value, meaning that you can wait for a
5774 fraction of a second. Optional second arg MILLISECONDS specifies an
5775 additional wait period, in milliseconds; this is for backwards compatibility.
5776 \(Not all operating systems support waiting for a fraction of a second.) */)
5777 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5779 double duration
= extract_float (seconds
);
5781 if (!NILP (milliseconds
))
5783 CHECK_NUMBER (milliseconds
);
5784 duration
+= XINT (milliseconds
) / 1000.0;
5789 struct timespec t
= dtotimespec (duration
);
5790 wait_reading_process_output (min (t
.tv_sec
, WAIT_READING_MAX
),
5791 t
.tv_nsec
, 0, 0, Qnil
, NULL
, 0);
5798 /* This is just like wait_reading_process_output, except that
5801 TIMEOUT is number of seconds to wait (float or integer),
5802 or t to wait forever.
5803 READING is true if reading input.
5804 If DISPLAY_OPTION is >0 display process output while waiting.
5805 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5809 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5813 bool do_display
= display_option
> 0;
5815 swallow_events (do_display
);
5817 if ((detect_input_pending_run_timers (do_display
))
5818 || !NILP (Vexecuting_kbd_macro
))
5821 if (display_option
> 1)
5822 redisplay_preserve_echo_area (2);
5824 if (INTEGERP (timeout
))
5826 sec
= XINT (timeout
);
5831 else if (FLOATP (timeout
))
5833 double seconds
= XFLOAT_DATA (timeout
);
5834 if (! (0 < seconds
))
5838 struct timespec t
= dtotimespec (seconds
);
5839 sec
= min (t
.tv_sec
, WAIT_READING_MAX
);
5843 else if (EQ (timeout
, Qt
))
5849 wrong_type_argument (Qnumberp
, timeout
);
5856 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5859 return detect_input_pending () ? Qnil
: Qt
;
5863 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5864 doc
: /* Perform redisplay.
5865 Optional arg FORCE, if non-nil, prevents redisplay from being
5866 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5867 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5868 preempted by arriving input, so FORCE does nothing.
5870 Return t if redisplay was performed, nil if redisplay was preempted
5871 immediately by pending input. */)
5877 if ((detect_input_pending_run_timers (1)
5878 && NILP (force
) && !redisplay_dont_pause
)
5879 || !NILP (Vexecuting_kbd_macro
))
5882 count
= SPECPDL_INDEX ();
5883 if (!NILP (force
) && !redisplay_dont_pause
)
5884 specbind (Qredisplay_dont_pause
, Qt
);
5885 redisplay_preserve_echo_area (2);
5886 unbind_to (count
, Qnil
);
5892 /***********************************************************************
5893 Other Lisp Functions
5894 ***********************************************************************/
5896 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5897 session's frames, frame names, buffers, buffer-read-only flags, and
5898 buffer-modified-flags. */
5900 static Lisp_Object frame_and_buffer_state
;
5903 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5904 Sframe_or_buffer_changed_p
, 0, 1, 0,
5905 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5906 VARIABLE is a variable name whose value is either nil or a state vector
5907 that will be updated to contain all frames and buffers,
5908 aside from buffers whose names start with space,
5909 along with the buffers' read-only and modified flags. This allows a fast
5910 check to see whether buffer menus might need to be recomputed.
5911 If this function returns non-nil, it updates the internal vector to reflect
5914 If VARIABLE is nil, an internal variable is used. Users should not
5915 pass nil for VARIABLE. */)
5916 (Lisp_Object variable
)
5918 Lisp_Object state
, tail
, frame
, buf
;
5921 if (! NILP (variable
))
5923 CHECK_SYMBOL (variable
);
5924 state
= Fsymbol_value (variable
);
5925 if (! VECTORP (state
))
5929 state
= frame_and_buffer_state
;
5932 FOR_EACH_FRAME (tail
, frame
)
5934 if (idx
== ASIZE (state
))
5936 if (!EQ (AREF (state
, idx
++), frame
))
5938 if (idx
== ASIZE (state
))
5940 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
5943 /* Check that the buffer info matches. */
5944 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5946 /* Ignore buffers that aren't included in buffer lists. */
5947 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
5949 if (idx
== ASIZE (state
))
5951 if (!EQ (AREF (state
, idx
++), buf
))
5953 if (idx
== ASIZE (state
))
5955 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
5957 if (idx
== ASIZE (state
))
5959 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
5962 if (idx
== ASIZE (state
))
5964 /* Detect deletion of a buffer at the end of the list. */
5965 if (EQ (AREF (state
, idx
), Qlambda
))
5968 /* Come here if we decide the data has changed. */
5970 /* Count the size we will need.
5971 Start with 1 so there is room for at least one lambda at the end. */
5973 FOR_EACH_FRAME (tail
, frame
)
5975 FOR_EACH_LIVE_BUFFER (tail
, buf
)
5977 /* Reallocate the vector if data has grown to need it,
5978 or if it has shrunk a lot. */
5979 if (! VECTORP (state
)
5980 || n
> ASIZE (state
)
5981 || n
+ 20 < ASIZE (state
) / 2)
5982 /* Add 20 extra so we grow it less often. */
5984 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
5985 if (! NILP (variable
))
5986 Fset (variable
, state
);
5988 frame_and_buffer_state
= state
;
5991 /* Record the new data in the (possibly reallocated) vector. */
5993 FOR_EACH_FRAME (tail
, frame
)
5995 ASET (state
, idx
, frame
);
5997 ASET (state
, idx
, XFRAME (frame
)->name
);
6000 FOR_EACH_LIVE_BUFFER (tail
, buf
)
6002 /* Ignore buffers that aren't included in buffer lists. */
6003 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6005 ASET (state
, idx
, buf
);
6007 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
6009 ASET (state
, idx
, Fbuffer_modified_p (buf
));
6012 /* Fill up the vector with lambdas (always at least one). */
6013 ASET (state
, idx
, Qlambda
);
6015 while (idx
< ASIZE (state
))
6017 ASET (state
, idx
, Qlambda
);
6020 /* Make sure we didn't overflow the vector. */
6021 eassert (idx
<= ASIZE (state
));
6027 /***********************************************************************
6029 ***********************************************************************/
6031 /* Initialization done when Emacs fork is started, before doing stty.
6032 Determine terminal type and set terminal_driver. Then invoke its
6033 decoding routine to set up variables in the terminal package. */
6038 char *terminal_type
;
6040 /* Construct the space glyph. */
6041 space_glyph
.type
= CHAR_GLYPH
;
6042 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6043 space_glyph
.charpos
= -1;
6046 cursor_in_echo_area
= 0;
6048 /* Now is the time to initialize this; it's used by init_sys_modes
6050 Vinitial_window_system
= Qnil
;
6052 /* SIGWINCH needs to be handled no matter what display we start
6053 with. Otherwise newly opened tty frames will not resize
6058 #endif /* CANNOT_DUMP */
6060 struct sigaction action
;
6061 emacs_sigaction_init (&action
, deliver_window_change_signal
);
6062 sigaction (SIGWINCH
, &action
, 0);
6064 #endif /* SIGWINCH */
6066 /* If running as a daemon, no need to initialize any frames/terminal. */
6070 /* If the user wants to use a window system, we shouldn't bother
6071 initializing the terminal. This is especially important when the
6072 terminal is so dumb that emacs gives up before and doesn't bother
6073 using the window system.
6075 If the DISPLAY environment variable is set and nonempty,
6076 try to use X, and die with an error message if that doesn't work. */
6078 #ifdef HAVE_X_WINDOWS
6079 if (! inhibit_window_system
&& ! display_arg
)
6082 display
= getenv ("DISPLAY");
6083 display_arg
= (display
!= 0 && *display
!= 0);
6085 if (display_arg
&& !x_display_ok (display
))
6087 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6089 inhibit_window_system
= 1;
6093 if (!inhibit_window_system
&& display_arg
)
6095 Vinitial_window_system
= Qx
;
6097 Vwindow_system_version
= make_number (11);
6100 /* In some versions of ncurses,
6101 tputs crashes if we have not called tgetent.
6103 { char b
[2044]; tgetent (b
, "xterm");}
6107 #endif /* HAVE_X_WINDOWS */
6110 if (!inhibit_window_system
)
6112 Vinitial_window_system
= Qw32
;
6113 Vwindow_system_version
= make_number (1);
6116 #endif /* HAVE_NTGUI */
6119 if (!inhibit_window_system
6125 Vinitial_window_system
= Qns
;
6126 Vwindow_system_version
= make_number (10);
6131 /* If no window system has been specified, try to use the terminal. */
6133 fatal ("standard input is not a tty");
6136 terminal_type
= "w32console";
6138 terminal_type
= getenv ("TERM");
6142 #ifdef HAVE_WINDOW_SYSTEM
6143 if (! inhibit_window_system
)
6144 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6146 #endif /* HAVE_WINDOW_SYSTEM */
6147 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6153 struct frame
*f
= XFRAME (selected_frame
);
6155 init_foreground_group ();
6157 /* Open a display on the controlling tty. */
6158 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6160 /* Convert the initial frame to use the new display. */
6161 if (f
->output_method
!= output_initial
)
6163 f
->output_method
= t
->type
;
6166 t
->reference_count
++;
6168 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6170 if (f
->output_method
== output_termcap
)
6171 create_tty_output (f
);
6173 t
->display_info
.tty
->top_frame
= selected_frame
;
6174 change_frame_size (XFRAME (selected_frame
),
6175 FrameCols (t
->display_info
.tty
),
6176 FrameRows (t
->display_info
.tty
), 0, 0, 1, 0);
6178 /* Delete the initial terminal. */
6179 if (--initial_terminal
->reference_count
== 0
6180 && initial_terminal
->delete_terminal_hook
)
6181 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6183 /* Update frame parameters to reflect the new type. */
6184 Fmodify_frame_parameters
6185 (selected_frame
, list1 (Fcons (Qtty_type
,
6186 Ftty_type (selected_frame
))));
6187 if (t
->display_info
.tty
->name
)
6188 Fmodify_frame_parameters
6190 list1 (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
))));
6192 Fmodify_frame_parameters (selected_frame
, list1 (Fcons (Qtty
, Qnil
)));
6196 struct frame
*sf
= SELECTED_FRAME ();
6197 int width
= FRAME_TOTAL_COLS (sf
);
6198 int height
= FRAME_LINES (sf
);
6200 /* If these sizes are so big they cause overflow, just ignore the
6201 change. It's not clear what better we could do. The rest of
6202 the code assumes that (width + 2) * height * sizeof (struct glyph)
6203 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6204 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6205 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6206 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6207 < (width
+ 2) * height
))
6208 fatal ("screen size %dx%d too big", width
, height
);
6211 calculate_costs (XFRAME (selected_frame
));
6213 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6216 && NILP (Vinitial_window_system
))
6218 /* For the initial frame, we don't have any way of knowing what
6219 are the foreground and background colors of the terminal. */
6220 struct frame
*sf
= SELECTED_FRAME ();
6222 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6223 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6224 call0 (intern ("tty-set-up-initial-frame-faces"));
6230 /***********************************************************************
6232 ***********************************************************************/
6234 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6235 Sinternal_show_cursor
, 2, 2, 0,
6236 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6237 WINDOW nil means use the selected window. SHOW non-nil means
6238 show a cursor in WINDOW in the next redisplay. SHOW nil means
6239 don't show a cursor. */)
6240 (Lisp_Object window
, Lisp_Object show
)
6242 /* Don't change cursor state while redisplaying. This could confuse
6244 if (!redisplaying_p
)
6245 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6250 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6251 Sinternal_show_cursor_p
, 0, 1, 0,
6252 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6253 WINDOW nil or omitted means report on the selected window. */)
6254 (Lisp_Object window
)
6256 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6259 /***********************************************************************
6261 ***********************************************************************/
6264 syms_of_display (void)
6266 defsubr (&Sredraw_frame
);
6267 defsubr (&Sredraw_display
);
6268 defsubr (&Sframe_or_buffer_changed_p
);
6269 defsubr (&Sopen_termscript
);
6271 defsubr (&Sredisplay
);
6272 defsubr (&Ssleep_for
);
6273 defsubr (&Ssend_string_to_terminal
);
6274 defsubr (&Sinternal_show_cursor
);
6275 defsubr (&Sinternal_show_cursor_p
);
6278 defsubr (&Sdump_redisplay_history
);
6281 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6282 staticpro (&frame_and_buffer_state
);
6284 DEFSYM (Qdisplay_table
, "display-table");
6285 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6287 DEFVAR_INT ("baud-rate", baud_rate
,
6288 doc
: /* The output baud rate of the terminal.
6289 On most systems, changing this value will affect the amount of padding
6290 and the other strategic decisions made during redisplay. */);
6292 DEFVAR_BOOL ("inverse-video", inverse_video
,
6293 doc
: /* Non-nil means invert the entire frame display.
6294 This means everything is in inverse video which otherwise would not be. */);
6296 DEFVAR_BOOL ("visible-bell", visible_bell
,
6297 doc
: /* Non-nil means try to flash the frame to represent a bell.
6299 See also `ring-bell-function'. */);
6301 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6302 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6303 A non-nil value is useful if the terminal can automatically preserve
6304 Emacs's frame display when you reenter Emacs.
6305 It is up to you to set this variable if your terminal can do that. */);
6307 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6308 doc
: /* Name of the window system that Emacs uses for the first frame.
6309 The value is a symbol:
6310 nil for a termcap frame (a character-only terminal),
6311 'x' for an Emacs frame that is really an X window,
6312 'w32' for an Emacs frame that is a window on MS-Windows display,
6313 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6314 'pc' for a direct-write MS-DOS frame.
6316 Use of this variable as a boolean is deprecated. Instead,
6317 use `display-graphic-p' or any of the other `display-*-p'
6318 predicates which report frame's specific UI-related capabilities. */);
6320 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6321 doc
: /* Name of window system through which the selected frame is displayed.
6322 The value is a symbol:
6323 nil for a termcap frame (a character-only terminal),
6324 'x' for an Emacs frame that is really an X window,
6325 'w32' for an Emacs frame that is a window on MS-Windows display,
6326 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6327 'pc' for a direct-write MS-DOS frame.
6329 Use of this variable as a boolean is deprecated. Instead,
6330 use `display-graphic-p' or any of the other `display-*-p'
6331 predicates which report frame's specific UI-related capabilities. */);
6333 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6334 doc
: /* The version number of the window system in use.
6335 For X windows, this is 11. */);
6337 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6338 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6340 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6341 doc
: /* Table defining how to output a glyph code to the frame.
6342 If not nil, this is a vector indexed by glyph code to define the glyph.
6343 Each element can be:
6344 integer: a glyph code which this glyph is an alias for.
6345 string: output this glyph using that string (not impl. in X windows).
6346 nil: this glyph mod 524288 is the code of a character to output,
6347 and this glyph / 524288 is the face number (see `face-id') to use
6348 while outputting it. */);
6349 Vglyph_table
= Qnil
;
6351 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6352 doc
: /* Display table to use for buffers that specify none.
6353 See `buffer-display-table' for more information. */);
6354 Vstandard_display_table
= Qnil
;
6356 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6357 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6358 redisplay_dont_pause
= 1;
6364 Vinitial_window_system
= Qnil
;
6365 Vwindow_system_version
= Qnil
;