1 /* Updating of data structures for redisplay.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 #define DISPEXTERN_INLINE EXTERN_INLINE
28 /* cm.h must come after dispextern.h on Windows. */
29 #include "dispextern.h"
31 #include "character.h"
35 #include "termhooks.h"
40 #include "intervals.h"
41 #include "blockinput.h"
44 #include "syssignal.h"
46 #ifdef HAVE_WINDOW_SYSTEM
48 #endif /* HAVE_WINDOW_SYSTEM */
54 /* Include systime.h after xterm.h to avoid double inclusion of time.h. */
61 #if defined (HAVE_TERM_H) && defined (GNU_LINUX)
62 #include <term.h> /* for tgetent */
69 /* Structure to pass dimensions around. Used for character bounding
70 boxes, glyph matrix dimensions and alike. */
79 /* Function prototypes. */
81 static void update_frame_line (struct frame
*, int);
82 static int required_matrix_height (struct window
*);
83 static int required_matrix_width (struct window
*);
84 static void adjust_frame_glyphs (struct frame
*);
85 static void change_frame_size_1 (struct frame
*, int, int, bool, bool, bool);
86 static void increment_row_positions (struct glyph_row
*, ptrdiff_t, ptrdiff_t);
87 static void fill_up_frame_row_with_spaces (struct glyph_row
*, int);
88 static void build_frame_matrix_from_window_tree (struct glyph_matrix
*,
90 static void build_frame_matrix_from_leaf_window (struct glyph_matrix
*,
92 static void adjust_frame_message_buffer (struct frame
*);
93 static void adjust_decode_mode_spec_buffer (struct frame
*);
94 static void fill_up_glyph_row_with_spaces (struct glyph_row
*);
95 static void clear_window_matrices (struct window
*, bool);
96 static void fill_up_glyph_row_area_with_spaces (struct glyph_row
*, int);
97 static int scrolling_window (struct window
*, bool);
98 static bool update_window_line (struct window
*, int, bool *);
99 static void mirror_make_current (struct window
*, int);
101 static void check_matrix_pointers (struct glyph_matrix
*,
102 struct glyph_matrix
*);
104 static void mirror_line_dance (struct window
*, int, int, int *, char *);
105 static bool update_window_tree (struct window
*, bool);
106 static bool update_window (struct window
*, bool);
107 static bool update_frame_1 (struct frame
*, bool, bool);
108 static bool scrolling (struct frame
*);
109 static void set_window_cursor_after_update (struct window
*);
110 static void adjust_frame_glyphs_for_window_redisplay (struct frame
*);
111 static void adjust_frame_glyphs_for_frame_redisplay (struct frame
*);
114 /* Redisplay preemption timers. */
116 static EMACS_TIME preemption_period
;
117 static EMACS_TIME preemption_next_check
;
119 /* True upon entry to redisplay means do not assume anything about
120 current contents of actual terminal frame; clear and redraw it. */
124 /* True means last display completed. False means it was preempted. */
126 bool display_completed
;
128 Lisp_Object Qdisplay_table
, Qredisplay_dont_pause
;
131 /* The currently selected frame. In a single-frame version, this
132 variable always equals the_only_frame. */
134 Lisp_Object selected_frame
;
136 /* A frame which is not just a mini-buffer, or 0 if there are no such
137 frames. This is usually the most recent such frame that was
138 selected. In a single-frame version, this variable always holds
139 the address of the_only_frame. */
141 struct frame
*last_nonminibuf_frame
;
143 /* True means SIGWINCH happened when not safe. */
145 static bool delayed_size_change
;
147 /* Updated window if != 0. Set by update_window. */
149 struct window
*updated_window
;
151 /* Glyph row updated in update_window_line, and area that is updated. */
153 struct glyph_row
*updated_row
;
156 /* A glyph for a space. */
158 struct glyph space_glyph
;
160 /* Counts of allocated structures. These counts serve to diagnose
161 memory leaks and double frees. */
163 static int glyph_matrix_count
;
164 static int glyph_pool_count
;
166 /* If non-null, the frame whose frame matrices are manipulated. If
167 null, window matrices are worked on. */
169 static struct frame
*frame_matrix_frame
;
171 /* True means that fonts have been loaded since the last glyph
172 matrix adjustments. Redisplay must stop, and glyph matrices must
173 be adjusted when this flag becomes true during display. The
174 reason fonts can be loaded so late is that fonts of fontsets are
175 loaded on demand. Another reason is that a line contains many
176 characters displayed by zero width or very narrow glyphs of
177 variable-width fonts. */
179 bool fonts_changed_p
;
181 /* Convert vpos and hpos from frame to window and vice versa.
182 This may only be used for terminal frames. */
186 static int window_to_frame_vpos (struct window
*, int);
187 static int window_to_frame_hpos (struct window
*, int);
188 #define WINDOW_TO_FRAME_VPOS(W, VPOS) window_to_frame_vpos ((W), (VPOS))
189 #define WINDOW_TO_FRAME_HPOS(W, HPOS) window_to_frame_hpos ((W), (HPOS))
191 /* One element of the ring buffer containing redisplay history
194 struct redisplay_history
196 char trace
[512 + 100];
199 /* The size of the history buffer. */
201 #define REDISPLAY_HISTORY_SIZE 30
203 /* The redisplay history buffer. */
205 static struct redisplay_history redisplay_history
[REDISPLAY_HISTORY_SIZE
];
207 /* Next free entry in redisplay_history. */
209 static int history_idx
;
211 /* A tick that's incremented each time something is added to the
214 static uprintmax_t history_tick
;
216 /* Add to the redisplay history how window W has been displayed.
217 MSG is a trace containing the information how W's glyph matrix
218 has been constructed. PAUSED_P means that the update
219 has been interrupted for pending input. */
222 add_window_display_history (struct window
*w
, const char *msg
, bool paused_p
)
226 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
228 buf
= redisplay_history
[history_idx
].trace
;
231 snprintf (buf
, sizeof redisplay_history
[0].trace
,
232 "%"pMu
": window %p (`%s')%s\n%s",
235 ((BUFFERP (w
->buffer
)
236 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
237 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
239 paused_p
? " ***paused***" : "",
244 /* Add to the redisplay history that frame F has been displayed.
245 PAUSED_P means that the update has been interrupted for
248 static void add_frame_display_history (struct frame
*f
, int paused_p
)
252 if (history_idx
>= REDISPLAY_HISTORY_SIZE
)
254 buf
= redisplay_history
[history_idx
].trace
;
257 sprintf (buf
, "%"pMu
": update frame %p%s",
259 f
, paused_p
? " ***paused***" : "");
263 DEFUN ("dump-redisplay-history", Fdump_redisplay_history
,
264 Sdump_redisplay_history
, 0, 0, "",
265 doc
: /* Dump redisplay history to stderr. */)
270 for (i
= history_idx
- 1; i
!= history_idx
; --i
)
273 i
= REDISPLAY_HISTORY_SIZE
- 1;
274 fprintf (stderr
, "%s\n", redisplay_history
[i
].trace
);
281 #else /* not GLYPH_DEBUG */
283 #define WINDOW_TO_FRAME_VPOS(W, VPOS) ((VPOS) + WINDOW_TOP_EDGE_LINE (W))
284 #define WINDOW_TO_FRAME_HPOS(W, HPOS) ((HPOS) + WINDOW_LEFT_EDGE_COL (W))
286 #endif /* GLYPH_DEBUG */
289 #if (defined PROFILING \
290 && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__) \
291 && !HAVE___EXECUTABLE_START)
292 /* This function comes first in the Emacs executable and is used only
293 to estimate the text start for profiling. */
295 __executable_start (void)
301 /***********************************************************************
303 ***********************************************************************/
305 /* Allocate and return a glyph_matrix structure. POOL is the glyph
306 pool from which memory for the matrix should be allocated, or null
307 for window-based redisplay where no glyph pools are used. The
308 member `pool' of the glyph matrix structure returned is set to
309 POOL, the structure is otherwise zeroed. */
311 static struct glyph_matrix
*
312 new_glyph_matrix (struct glyph_pool
*pool
)
314 struct glyph_matrix
*result
= xzalloc (sizeof *result
);
316 /* Increment number of allocated matrices. This count is used
317 to detect memory leaks. */
318 ++glyph_matrix_count
;
320 /* Set pool and return. */
326 /* Free glyph matrix MATRIX. Passing in a null MATRIX is allowed.
328 The global counter glyph_matrix_count is decremented when a matrix
329 is freed. If the count gets negative, more structures were freed
330 than allocated, i.e. one matrix was freed more than once or a bogus
331 pointer was passed to this function.
333 If MATRIX->pool is null, this means that the matrix manages its own
334 glyph memory---this is done for matrices on X frames. Freeing the
335 matrix also frees the glyph memory in this case. */
338 free_glyph_matrix (struct glyph_matrix
*matrix
)
344 /* Detect the case that more matrices are freed than were
346 if (--glyph_matrix_count
< 0)
349 /* Free glyph memory if MATRIX owns it. */
350 if (matrix
->pool
== NULL
)
351 for (i
= 0; i
< matrix
->rows_allocated
; ++i
)
352 xfree (matrix
->rows
[i
].glyphs
[LEFT_MARGIN_AREA
]);
354 /* Free row structures and the matrix itself. */
355 xfree (matrix
->rows
);
361 /* Return the number of glyphs to reserve for a marginal area of
362 window W. TOTAL_GLYPHS is the number of glyphs in a complete
363 display line of window W. MARGIN gives the width of the marginal
364 area in canonical character units. MARGIN should be an integer
368 margin_glyphs_to_reserve (struct window
*w
, int total_glyphs
, Lisp_Object margin
)
372 if (NUMBERP (margin
))
374 int width
= XFASTINT (w
->total_cols
);
375 double d
= max (0, XFLOATINT (margin
));
376 d
= min (width
/ 2 - 1, d
);
377 n
= (int) ((double) total_glyphs
/ width
* d
);
385 /* Return true if ROW's hash value is correct.
386 Optimized away if ENABLE_CHECKING is not defined. */
389 verify_row_hash (struct glyph_row
*row
)
391 return row
->hash
== row_hash (row
);
394 /* Adjust glyph matrix MATRIX on window W or on a frame to changed
397 W is null if the function is called for a frame glyph matrix.
398 Otherwise it is the window MATRIX is a member of. X and Y are the
399 indices of the first column and row of MATRIX within the frame
400 matrix, if such a matrix exists. They are zero for purely
401 window-based redisplay. DIM is the needed size of the matrix.
403 In window-based redisplay, where no frame matrices exist, glyph
404 matrices manage their own glyph storage. Otherwise, they allocate
405 storage from a common frame glyph pool which can be found in
408 The reason for this memory management strategy is to avoid complete
409 frame redraws if possible. When we allocate from a common pool, a
410 change of the location or size of a sub-matrix within the pool
411 requires a complete redisplay of the frame because we cannot easily
412 make sure that the current matrices of all windows still agree with
413 what is displayed on the screen. While this is usually fast, it
414 leads to screen flickering. */
417 adjust_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int x
, int y
, struct dim dim
)
421 bool marginal_areas_changed_p
= 0;
422 bool header_line_changed_p
= 0;
423 bool header_line_p
= 0;
424 int left
= -1, right
= -1;
425 int window_width
= -1, window_height
= -1;
427 /* See if W had a header line that has disappeared now, or vice versa.
431 window_box (w
, -1, 0, 0, &window_width
, &window_height
);
433 header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
434 header_line_changed_p
= header_line_p
!= matrix
->header_line_p
;
436 matrix
->header_line_p
= header_line_p
;
438 /* If POOL is null, MATRIX is a window matrix for window-based redisplay.
439 Do nothing if MATRIX' size, position, vscroll, and marginal areas
440 haven't changed. This optimization is important because preserving
441 the matrix means preventing redisplay. */
442 if (matrix
->pool
== NULL
)
444 left
= margin_glyphs_to_reserve (w
, dim
.width
, w
->left_margin_cols
);
445 right
= margin_glyphs_to_reserve (w
, dim
.width
, w
->right_margin_cols
);
446 eassert (left
>= 0 && right
>= 0);
447 marginal_areas_changed_p
= (left
!= matrix
->left_margin_glyphs
448 || right
!= matrix
->right_margin_glyphs
);
450 if (!marginal_areas_changed_p
452 && !header_line_changed_p
453 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
454 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
455 && matrix
->window_height
== window_height
456 && matrix
->window_vscroll
== w
->vscroll
457 && matrix
->window_width
== window_width
)
461 /* Enlarge MATRIX->rows if necessary. New rows are cleared. */
462 if (matrix
->rows_allocated
< dim
.height
)
464 int old_alloc
= matrix
->rows_allocated
;
465 new_rows
= dim
.height
- matrix
->rows_allocated
;
466 matrix
->rows
= xpalloc (matrix
->rows
, &matrix
->rows_allocated
,
467 new_rows
, INT_MAX
, sizeof *matrix
->rows
);
468 memset (matrix
->rows
+ old_alloc
, 0,
469 (matrix
->rows_allocated
- old_alloc
) * sizeof *matrix
->rows
);
474 /* If POOL is not null, MATRIX is a frame matrix or a window matrix
475 on a frame not using window-based redisplay. Set up pointers for
476 each row into the glyph pool. */
479 eassert (matrix
->pool
->glyphs
);
483 left
= margin_glyphs_to_reserve (w
, dim
.width
,
484 w
->left_margin_cols
);
485 right
= margin_glyphs_to_reserve (w
, dim
.width
,
486 w
->right_margin_cols
);
491 for (i
= 0; i
< dim
.height
; ++i
)
493 struct glyph_row
*row
= &matrix
->rows
[i
];
495 row
->glyphs
[LEFT_MARGIN_AREA
]
496 = (matrix
->pool
->glyphs
497 + (y
+ i
) * matrix
->pool
->ncolumns
501 || row
== matrix
->rows
+ dim
.height
- 1
502 || (row
== matrix
->rows
&& matrix
->header_line_p
))
504 row
->glyphs
[TEXT_AREA
]
505 = row
->glyphs
[LEFT_MARGIN_AREA
];
506 row
->glyphs
[RIGHT_MARGIN_AREA
]
507 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
508 row
->glyphs
[LAST_AREA
]
509 = row
->glyphs
[RIGHT_MARGIN_AREA
];
513 row
->glyphs
[TEXT_AREA
]
514 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
515 row
->glyphs
[RIGHT_MARGIN_AREA
]
516 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
517 row
->glyphs
[LAST_AREA
]
518 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
522 matrix
->left_margin_glyphs
= left
;
523 matrix
->right_margin_glyphs
= right
;
527 /* If MATRIX->pool is null, MATRIX is responsible for managing
528 its own memory. It is a window matrix for window-based redisplay.
529 Allocate glyph memory from the heap. */
530 if (dim
.width
> matrix
->matrix_w
532 || header_line_changed_p
533 || marginal_areas_changed_p
)
535 struct glyph_row
*row
= matrix
->rows
;
536 struct glyph_row
*end
= row
+ matrix
->rows_allocated
;
540 row
->glyphs
[LEFT_MARGIN_AREA
]
541 = xnrealloc (row
->glyphs
[LEFT_MARGIN_AREA
],
542 dim
.width
, sizeof (struct glyph
));
544 /* The mode line never has marginal areas. */
545 if (row
== matrix
->rows
+ dim
.height
- 1
546 || (row
== matrix
->rows
&& matrix
->header_line_p
))
548 row
->glyphs
[TEXT_AREA
]
549 = row
->glyphs
[LEFT_MARGIN_AREA
];
550 row
->glyphs
[RIGHT_MARGIN_AREA
]
551 = row
->glyphs
[TEXT_AREA
] + dim
.width
;
552 row
->glyphs
[LAST_AREA
]
553 = row
->glyphs
[RIGHT_MARGIN_AREA
];
557 row
->glyphs
[TEXT_AREA
]
558 = row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
559 row
->glyphs
[RIGHT_MARGIN_AREA
]
560 = row
->glyphs
[TEXT_AREA
] + dim
.width
- left
- right
;
561 row
->glyphs
[LAST_AREA
]
562 = row
->glyphs
[LEFT_MARGIN_AREA
] + dim
.width
;
568 eassert (left
>= 0 && right
>= 0);
569 matrix
->left_margin_glyphs
= left
;
570 matrix
->right_margin_glyphs
= right
;
573 /* Number of rows to be used by MATRIX. */
574 matrix
->nrows
= dim
.height
;
575 eassert (matrix
->nrows
>= 0);
579 if (matrix
== w
->current_matrix
)
581 /* Mark rows in a current matrix of a window as not having
582 valid contents. It's important to not do this for
583 desired matrices. When Emacs starts, it may already be
584 building desired matrices when this function runs. */
585 if (window_width
< 0)
586 window_width
= window_box_width (w
, -1);
588 /* Optimize the case that only the height has changed (C-x 2,
589 upper window). Invalidate all rows that are no longer part
591 if (!marginal_areas_changed_p
592 && !header_line_changed_p
594 && dim
.width
== matrix
->matrix_w
595 && matrix
->window_left_col
== WINDOW_LEFT_EDGE_COL (w
)
596 && matrix
->window_top_line
== WINDOW_TOP_EDGE_LINE (w
)
597 && matrix
->window_width
== window_width
)
599 /* Find the last row in the window. */
600 for (i
= 0; i
< matrix
->nrows
&& matrix
->rows
[i
].enabled_p
; ++i
)
601 if (MATRIX_ROW_BOTTOM_Y (matrix
->rows
+ i
) >= window_height
)
607 /* Window end is invalid, if inside of the rows that
608 are invalidated below. */
609 if (INTEGERP (w
->window_end_vpos
)
610 && XFASTINT (w
->window_end_vpos
) >= i
)
611 wset_window_end_valid (w
, Qnil
);
613 while (i
< matrix
->nrows
)
614 matrix
->rows
[i
++].enabled_p
= 0;
618 for (i
= 0; i
< matrix
->nrows
; ++i
)
619 matrix
->rows
[i
].enabled_p
= 0;
622 else if (matrix
== w
->desired_matrix
)
624 /* Rows in desired matrices always have to be cleared;
625 redisplay expects this is the case when it runs, so it
626 had better be the case when we adjust matrices between
628 for (i
= 0; i
< matrix
->nrows
; ++i
)
629 matrix
->rows
[i
].enabled_p
= 0;
634 /* Remember last values to be able to optimize frame redraws. */
635 matrix
->matrix_x
= x
;
636 matrix
->matrix_y
= y
;
637 matrix
->matrix_w
= dim
.width
;
638 matrix
->matrix_h
= dim
.height
;
640 /* Record the top y location and height of W at the time the matrix
641 was last adjusted. This is used to optimize redisplay above. */
644 matrix
->window_left_col
= WINDOW_LEFT_EDGE_COL (w
);
645 matrix
->window_top_line
= WINDOW_TOP_EDGE_LINE (w
);
646 matrix
->window_height
= window_height
;
647 matrix
->window_width
= window_width
;
648 matrix
->window_vscroll
= w
->vscroll
;
653 /* Reverse the contents of rows in MATRIX between START and END. The
654 contents of the row at END - 1 end up at START, END - 2 at START +
655 1 etc. This is part of the implementation of rotate_matrix (see
659 reverse_rows (struct glyph_matrix
*matrix
, int start
, int end
)
663 for (i
= start
, j
= end
- 1; i
< j
; ++i
, --j
)
665 /* Non-ISO HP/UX compiler doesn't like auto struct
667 struct glyph_row temp
;
668 temp
= matrix
->rows
[i
];
669 matrix
->rows
[i
] = matrix
->rows
[j
];
670 matrix
->rows
[j
] = temp
;
675 /* Rotate the contents of rows in MATRIX in the range FIRST .. LAST -
676 1 by BY positions. BY < 0 means rotate left, i.e. towards lower
677 indices. (Note: this does not copy glyphs, only glyph pointers in
678 row structures are moved around).
680 The algorithm used for rotating the vector was, I believe, first
681 described by Kernighan. See the vector R as consisting of two
682 sub-vectors AB, where A has length BY for BY >= 0. The result
683 after rotating is then BA. Reverse both sub-vectors to get ArBr
684 and reverse the result to get (ArBr)r which is BA. Similar for
688 rotate_matrix (struct glyph_matrix
*matrix
, int first
, int last
, int by
)
692 /* Up (rotate left, i.e. towards lower indices). */
694 reverse_rows (matrix
, first
, first
+ by
);
695 reverse_rows (matrix
, first
+ by
, last
);
696 reverse_rows (matrix
, first
, last
);
700 /* Down (rotate right, i.e. towards higher indices). */
701 reverse_rows (matrix
, last
- by
, last
);
702 reverse_rows (matrix
, first
, last
- by
);
703 reverse_rows (matrix
, first
, last
);
708 /* Increment buffer positions in glyph rows of MATRIX. Do it for rows
709 with indices START <= index < END. Increment positions by DELTA/
713 increment_matrix_positions (struct glyph_matrix
*matrix
, int start
, int end
,
714 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
716 /* Check that START and END are reasonable values. */
717 eassert (start
>= 0 && start
<= matrix
->nrows
);
718 eassert (end
>= 0 && end
<= matrix
->nrows
);
719 eassert (start
<= end
);
721 for (; start
< end
; ++start
)
722 increment_row_positions (matrix
->rows
+ start
, delta
, delta_bytes
);
726 /* Clear the enable_p flags in a range of rows in glyph matrix MATRIX.
727 START and END are the row indices of the first and last + 1 row to clear. */
730 clear_glyph_matrix_rows (struct glyph_matrix
*matrix
, int start
, int end
)
732 eassert (start
<= end
);
733 eassert (start
>= 0 && start
< matrix
->nrows
);
734 eassert (end
>= 0 && end
<= matrix
->nrows
);
736 for (; start
< end
; ++start
)
737 matrix
->rows
[start
].enabled_p
= 0;
743 Empty all rows in MATRIX by clearing their enabled_p flags.
744 The function prepare_desired_row will eventually really clear a row
745 when it sees one with a false enabled_p flag.
747 Reset update hints to default values. The only update hint
748 currently present is the flag MATRIX->no_scrolling_p. */
751 clear_glyph_matrix (struct glyph_matrix
*matrix
)
755 clear_glyph_matrix_rows (matrix
, 0, matrix
->nrows
);
756 matrix
->no_scrolling_p
= 0;
761 /* Shift part of the glyph matrix MATRIX of window W up or down.
762 Increment y-positions in glyph rows between START and END by DY,
763 and recompute their visible height. */
766 shift_glyph_matrix (struct window
*w
, struct glyph_matrix
*matrix
, int start
, int end
, int dy
)
770 eassert (start
<= end
);
771 eassert (start
>= 0 && start
< matrix
->nrows
);
772 eassert (end
>= 0 && end
<= matrix
->nrows
);
774 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
775 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
777 for (; start
< end
; ++start
)
779 struct glyph_row
*row
= &matrix
->rows
[start
];
782 row
->visible_height
= row
->height
;
785 row
->visible_height
-= min_y
- row
->y
;
786 if (row
->y
+ row
->height
> max_y
)
787 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
788 if (row
->fringe_bitmap_periodic_p
)
789 row
->redraw_fringe_bitmaps_p
= 1;
794 /* Mark all rows in current matrices of frame F as invalid. Marking
795 invalid is done by setting enabled_p to zero for all rows in a
799 clear_current_matrices (register struct frame
*f
)
801 /* Clear frame current matrix, if we have one. */
802 if (f
->current_matrix
)
803 clear_glyph_matrix (f
->current_matrix
);
805 /* Clear the matrix of the menu bar window, if such a window exists.
806 The menu bar window is currently used to display menus on X when
807 no toolkit support is compiled in. */
808 if (WINDOWP (f
->menu_bar_window
))
809 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->current_matrix
);
811 /* Clear the matrix of the tool-bar window, if any. */
812 if (WINDOWP (f
->tool_bar_window
))
813 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
815 /* Clear current window matrices. */
816 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
817 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 0);
821 /* Clear out all display lines of F for a coming redisplay. */
824 clear_desired_matrices (register struct frame
*f
)
826 if (f
->desired_matrix
)
827 clear_glyph_matrix (f
->desired_matrix
);
829 if (WINDOWP (f
->menu_bar_window
))
830 clear_glyph_matrix (XWINDOW (f
->menu_bar_window
)->desired_matrix
);
832 if (WINDOWP (f
->tool_bar_window
))
833 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->desired_matrix
);
835 /* Do it for window matrices. */
836 eassert (WINDOWP (FRAME_ROOT_WINDOW (f
)));
837 clear_window_matrices (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
841 /* Clear matrices in window tree rooted in W. If DESIRED_P,
842 clear desired matrices, otherwise clear current matrices. */
845 clear_window_matrices (struct window
*w
, bool desired_p
)
849 if (!NILP (w
->hchild
))
851 eassert (WINDOWP (w
->hchild
));
852 clear_window_matrices (XWINDOW (w
->hchild
), desired_p
);
854 else if (!NILP (w
->vchild
))
856 eassert (WINDOWP (w
->vchild
));
857 clear_window_matrices (XWINDOW (w
->vchild
), desired_p
);
862 clear_glyph_matrix (w
->desired_matrix
);
865 clear_glyph_matrix (w
->current_matrix
);
866 wset_window_end_valid (w
, Qnil
);
870 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
876 /***********************************************************************
879 See dispextern.h for an overall explanation of glyph rows.
880 ***********************************************************************/
882 /* Clear glyph row ROW. Do it in a way that makes it robust against
883 changes in the glyph_row structure, i.e. addition or removal of
884 structure members. */
886 static struct glyph_row null_row
;
889 clear_glyph_row (struct glyph_row
*row
)
891 struct glyph
*p
[1 + LAST_AREA
];
894 p
[LEFT_MARGIN_AREA
] = row
->glyphs
[LEFT_MARGIN_AREA
];
895 p
[TEXT_AREA
] = row
->glyphs
[TEXT_AREA
];
896 p
[RIGHT_MARGIN_AREA
] = row
->glyphs
[RIGHT_MARGIN_AREA
];
897 p
[LAST_AREA
] = row
->glyphs
[LAST_AREA
];
902 /* Restore pointers. */
903 row
->glyphs
[LEFT_MARGIN_AREA
] = p
[LEFT_MARGIN_AREA
];
904 row
->glyphs
[TEXT_AREA
] = p
[TEXT_AREA
];
905 row
->glyphs
[RIGHT_MARGIN_AREA
] = p
[RIGHT_MARGIN_AREA
];
906 row
->glyphs
[LAST_AREA
] = p
[LAST_AREA
];
908 #if 0 /* At some point, some bit-fields of struct glyph were not set,
909 which made glyphs unequal when compared with GLYPH_EQUAL_P.
910 Redisplay outputs such glyphs, and flickering effects were
911 the result. This also depended on the contents of memory
912 returned by xmalloc. If flickering happens again, activate
913 the code below. If the flickering is gone with that, chances
914 are that the flickering has the same reason as here. */
915 memset (p
[0], 0, (char *) p
[LAST_AREA
] - (char *) p
[0]);
920 /* Make ROW an empty, enabled row of canonical character height,
921 in window W starting at y-position Y. */
924 blank_row (struct window
*w
, struct glyph_row
*row
, int y
)
928 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
929 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
);
931 clear_glyph_row (row
);
933 row
->ascent
= row
->phys_ascent
= 0;
934 row
->height
= row
->phys_height
= FRAME_LINE_HEIGHT (XFRAME (w
->frame
));
935 row
->visible_height
= row
->height
;
938 row
->visible_height
-= min_y
- row
->y
;
939 if (row
->y
+ row
->height
> max_y
)
940 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
946 /* Increment buffer positions in glyph row ROW. DELTA and DELTA_BYTES
947 are the amounts by which to change positions. Note that the first
948 glyph of the text area of a row can have a buffer position even if
949 the used count of the text area is zero. Such rows display line
953 increment_row_positions (struct glyph_row
*row
,
954 ptrdiff_t delta
, ptrdiff_t delta_bytes
)
958 /* Increment start and end positions. */
959 MATRIX_ROW_START_CHARPOS (row
) += delta
;
960 MATRIX_ROW_START_BYTEPOS (row
) += delta_bytes
;
961 MATRIX_ROW_END_CHARPOS (row
) += delta
;
962 MATRIX_ROW_END_BYTEPOS (row
) += delta_bytes
;
963 CHARPOS (row
->start
.pos
) += delta
;
964 BYTEPOS (row
->start
.pos
) += delta_bytes
;
965 CHARPOS (row
->end
.pos
) += delta
;
966 BYTEPOS (row
->end
.pos
) += delta_bytes
;
971 /* Increment positions in glyphs. */
972 for (area
= 0; area
< LAST_AREA
; ++area
)
973 for (i
= 0; i
< row
->used
[area
]; ++i
)
974 if (BUFFERP (row
->glyphs
[area
][i
].object
)
975 && row
->glyphs
[area
][i
].charpos
> 0)
976 row
->glyphs
[area
][i
].charpos
+= delta
;
978 /* Capture the case of rows displaying a line end. */
979 if (row
->used
[TEXT_AREA
] == 0
980 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
981 row
->glyphs
[TEXT_AREA
]->charpos
+= delta
;
986 /* Swap glyphs between two glyph rows A and B. This exchanges glyph
987 contents, i.e. glyph structure contents are exchanged between A and
988 B without changing glyph pointers in A and B. */
991 swap_glyphs_in_rows (struct glyph_row
*a
, struct glyph_row
*b
)
995 for (area
= 0; area
< LAST_AREA
; ++area
)
997 /* Number of glyphs to swap. */
998 int max_used
= max (a
->used
[area
], b
->used
[area
]);
1000 /* Start of glyphs in area of row A. */
1001 struct glyph
*glyph_a
= a
->glyphs
[area
];
1003 /* End + 1 of glyphs in area of row A. */
1004 struct glyph
*glyph_a_end
= a
->glyphs
[max_used
];
1006 /* Start of glyphs in area of row B. */
1007 struct glyph
*glyph_b
= b
->glyphs
[area
];
1009 while (glyph_a
< glyph_a_end
)
1011 /* Non-ISO HP/UX compiler doesn't like auto struct
1015 *glyph_a
= *glyph_b
;
1025 /* Exchange pointers to glyph memory between glyph rows A and B. Also
1026 exchange the used[] array and the hash values of the rows, because
1027 these should all go together for the row's hash value to be
1031 swap_glyph_pointers (struct glyph_row
*a
, struct glyph_row
*b
)
1034 unsigned hash_tem
= a
->hash
;
1036 for (i
= 0; i
< LAST_AREA
+ 1; ++i
)
1038 struct glyph
*temp
= a
->glyphs
[i
];
1040 a
->glyphs
[i
] = b
->glyphs
[i
];
1041 b
->glyphs
[i
] = temp
;
1044 short used_tem
= a
->used
[i
];
1046 a
->used
[i
] = b
->used
[i
];
1047 b
->used
[i
] = used_tem
;
1055 /* Copy glyph row structure FROM to glyph row structure TO, except
1056 that glyph pointers, the `used' counts, and the hash values in the
1057 structures are left unchanged. */
1060 copy_row_except_pointers (struct glyph_row
*to
, struct glyph_row
*from
)
1062 struct glyph
*pointers
[1 + LAST_AREA
];
1063 short used
[LAST_AREA
];
1066 /* Save glyph pointers of TO. */
1067 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
1068 memcpy (used
, to
->used
, sizeof to
->used
);
1071 /* Do a structure assignment. */
1074 /* Restore original pointers of TO. */
1075 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
1076 memcpy (to
->used
, used
, sizeof to
->used
);
1081 /* Assign glyph row FROM to glyph row TO. This works like a structure
1082 assignment TO = FROM, except that glyph pointers are not copied but
1083 exchanged between TO and FROM. Pointers must be exchanged to avoid
1087 assign_row (struct glyph_row
*to
, struct glyph_row
*from
)
1089 swap_glyph_pointers (to
, from
);
1090 copy_row_except_pointers (to
, from
);
1094 /* Test whether the glyph memory of the glyph row WINDOW_ROW, which is
1095 a row in a window matrix, is a slice of the glyph memory of the
1096 glyph row FRAME_ROW which is a row in a frame glyph matrix. Value
1097 is true if the glyph memory of WINDOW_ROW is part of the glyph
1098 memory of FRAME_ROW. */
1103 glyph_row_slice_p (struct glyph_row
*window_row
, struct glyph_row
*frame_row
)
1105 struct glyph
*window_glyph_start
= window_row
->glyphs
[0];
1106 struct glyph
*frame_glyph_start
= frame_row
->glyphs
[0];
1107 struct glyph
*frame_glyph_end
= frame_row
->glyphs
[LAST_AREA
];
1109 return (frame_glyph_start
<= window_glyph_start
1110 && window_glyph_start
< frame_glyph_end
);
1113 #endif /* GLYPH_DEBUG */
1117 /* Find the row in the window glyph matrix WINDOW_MATRIX being a slice
1118 of ROW in the frame matrix FRAME_MATRIX. Value is null if no row
1119 in WINDOW_MATRIX is found satisfying the condition. */
1121 static struct glyph_row
*
1122 find_glyph_row_slice (struct glyph_matrix
*window_matrix
,
1123 struct glyph_matrix
*frame_matrix
, int row
)
1127 eassert (row
>= 0 && row
< frame_matrix
->nrows
);
1129 for (i
= 0; i
< window_matrix
->nrows
; ++i
)
1130 if (glyph_row_slice_p (window_matrix
->rows
+ i
,
1131 frame_matrix
->rows
+ row
))
1134 return i
< window_matrix
->nrows
? window_matrix
->rows
+ i
: 0;
1139 /* Prepare ROW for display. Desired rows are cleared lazily,
1140 i.e. they are only marked as to be cleared by setting their
1141 enabled_p flag to zero. When a row is to be displayed, a prior
1142 call to this function really clears it. */
1145 prepare_desired_row (struct glyph_row
*row
)
1147 if (!row
->enabled_p
)
1149 bool rp
= row
->reversed_p
;
1151 clear_glyph_row (row
);
1153 row
->reversed_p
= rp
;
1158 /* Return a hash code for glyph row ROW. */
1161 line_hash_code (struct glyph_row
*row
)
1167 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
1168 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
1172 int c
= glyph
->u
.ch
;
1173 int face_id
= glyph
->face_id
;
1174 if (FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1176 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + c
;
1177 hash
= (((hash
<< 4) + (hash
>> 24)) & 0x0fffffff) + face_id
;
1189 /* Return the cost of drawing line VPOS in MATRIX. The cost equals
1190 the number of characters in the line. If must_write_spaces is
1191 zero, leading and trailing spaces are ignored. */
1194 line_draw_cost (struct glyph_matrix
*matrix
, int vpos
)
1196 struct glyph_row
*row
= matrix
->rows
+ vpos
;
1197 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
1198 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
];
1200 Lisp_Object
*glyph_table_base
= GLYPH_TABLE_BASE
;
1201 ptrdiff_t glyph_table_len
= GLYPH_TABLE_LENGTH
;
1203 /* Ignore trailing and leading spaces if we can. */
1204 if (!FRAME_MUST_WRITE_SPACES (SELECTED_FRAME ())) /* XXX Is SELECTED_FRAME OK here? */
1206 /* Skip from the end over trailing spaces. */
1207 while (end
> beg
&& CHAR_GLYPH_SPACE_P (*(end
- 1)))
1210 /* All blank line. */
1214 /* Skip over leading spaces. */
1215 while (CHAR_GLYPH_SPACE_P (*beg
))
1219 /* If we don't have a glyph-table, each glyph is one character,
1220 so return the number of glyphs. */
1221 if (glyph_table_base
== 0)
1225 /* Otherwise, scan the glyphs and accumulate their total length
1232 SET_GLYPH_FROM_CHAR_GLYPH (g
, *beg
);
1234 if (GLYPH_INVALID_P (g
)
1235 || GLYPH_SIMPLE_P (glyph_table_base
, glyph_table_len
, g
))
1238 len
+= GLYPH_LENGTH (glyph_table_base
, g
);
1248 /* Return true if the glyph rows A and B have equal contents.
1249 MOUSE_FACE_P means compare the mouse_face_p flags of A and B, too. */
1252 row_equal_p (struct glyph_row
*a
, struct glyph_row
*b
, bool mouse_face_p
)
1254 eassert (verify_row_hash (a
));
1255 eassert (verify_row_hash (b
));
1259 else if (a
->hash
!= b
->hash
)
1263 struct glyph
*a_glyph
, *b_glyph
, *a_end
;
1266 if (mouse_face_p
&& a
->mouse_face_p
!= b
->mouse_face_p
)
1269 /* Compare glyphs. */
1270 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
1272 if (a
->used
[area
] != b
->used
[area
])
1275 a_glyph
= a
->glyphs
[area
];
1276 a_end
= a_glyph
+ a
->used
[area
];
1277 b_glyph
= b
->glyphs
[area
];
1279 while (a_glyph
< a_end
1280 && GLYPH_EQUAL_P (a_glyph
, b_glyph
))
1281 ++a_glyph
, ++b_glyph
;
1283 if (a_glyph
!= a_end
)
1287 if (a
->fill_line_p
!= b
->fill_line_p
1288 || a
->cursor_in_fringe_p
!= b
->cursor_in_fringe_p
1289 || a
->left_fringe_bitmap
!= b
->left_fringe_bitmap
1290 || a
->left_fringe_face_id
!= b
->left_fringe_face_id
1291 || a
->left_fringe_offset
!= b
->left_fringe_offset
1292 || a
->right_fringe_bitmap
!= b
->right_fringe_bitmap
1293 || a
->right_fringe_face_id
!= b
->right_fringe_face_id
1294 || a
->right_fringe_offset
!= b
->right_fringe_offset
1295 || a
->fringe_bitmap_periodic_p
!= b
->fringe_bitmap_periodic_p
1296 || a
->overlay_arrow_bitmap
!= b
->overlay_arrow_bitmap
1297 || a
->exact_window_width_line_p
!= b
->exact_window_width_line_p
1298 || a
->overlapped_p
!= b
->overlapped_p
1299 || (MATRIX_ROW_CONTINUATION_LINE_P (a
)
1300 != MATRIX_ROW_CONTINUATION_LINE_P (b
))
1301 || a
->reversed_p
!= b
->reversed_p
1302 /* Different partially visible characters on left margin. */
1304 /* Different height. */
1305 || a
->ascent
!= b
->ascent
1306 || a
->phys_ascent
!= b
->phys_ascent
1307 || a
->phys_height
!= b
->phys_height
1308 || a
->visible_height
!= b
->visible_height
)
1317 /***********************************************************************
1320 See dispextern.h for an overall explanation of glyph pools.
1321 ***********************************************************************/
1323 /* Allocate a glyph_pool structure. The structure returned is
1324 initialized with zeros. The global variable glyph_pool_count is
1325 incremented for each pool allocated. */
1327 static struct glyph_pool
*
1328 new_glyph_pool (void)
1330 struct glyph_pool
*result
= xzalloc (sizeof *result
);
1332 /* For memory leak and double deletion checking. */
1339 /* Free a glyph_pool structure POOL. The function may be called with
1340 a null POOL pointer. The global variable glyph_pool_count is
1341 decremented with every pool structure freed. If this count gets
1342 negative, more structures were freed than allocated, i.e. one
1343 structure must have been freed more than once or a bogus pointer
1344 was passed to free_glyph_pool. */
1347 free_glyph_pool (struct glyph_pool
*pool
)
1351 /* More freed than allocated? */
1353 eassert (glyph_pool_count
>= 0);
1355 xfree (pool
->glyphs
);
1361 /* Enlarge a glyph pool POOL. MATRIX_DIM gives the number of rows and
1362 columns we need. This function never shrinks a pool. The only
1363 case in which this would make sense, would be when a frame's size
1364 is changed from a large value to a smaller one. But, if someone
1365 does it once, we can expect that he will do it again.
1367 Return true if the pool changed in a way which makes
1368 re-adjusting window glyph matrices necessary. */
1371 realloc_glyph_pool (struct glyph_pool
*pool
, struct dim matrix_dim
)
1376 changed_p
= (pool
->glyphs
== 0
1377 || matrix_dim
.height
!= pool
->nrows
1378 || matrix_dim
.width
!= pool
->ncolumns
);
1380 /* Enlarge the glyph pool. */
1381 needed
= matrix_dim
.width
;
1382 if (INT_MULTIPLY_OVERFLOW (needed
, matrix_dim
.height
))
1383 memory_full (SIZE_MAX
);
1384 needed
*= matrix_dim
.height
;
1385 if (needed
> pool
->nglyphs
)
1387 ptrdiff_t old_nglyphs
= pool
->nglyphs
;
1388 pool
->glyphs
= xpalloc (pool
->glyphs
, &pool
->nglyphs
,
1389 needed
- old_nglyphs
, -1, sizeof *pool
->glyphs
);
1390 memset (pool
->glyphs
+ old_nglyphs
, 0,
1391 (pool
->nglyphs
- old_nglyphs
) * sizeof *pool
->glyphs
);
1394 /* Remember the number of rows and columns because (a) we use them
1395 to do sanity checks, and (b) the number of columns determines
1396 where rows in the frame matrix start---this must be available to
1397 determine pointers to rows of window sub-matrices. */
1398 pool
->nrows
= matrix_dim
.height
;
1399 pool
->ncolumns
= matrix_dim
.width
;
1406 /***********************************************************************
1408 ***********************************************************************/
1413 /* Flush standard output. This is sometimes useful to call from the debugger.
1414 XXX Maybe this should be changed to flush the current terminal instead of
1418 void flush_stdout (void) EXTERNALLY_VISIBLE
;
1427 /* Check that no glyph pointers have been lost in MATRIX. If a
1428 pointer has been lost, e.g. by using a structure assignment between
1429 rows, at least one pointer must occur more than once in the rows of
1433 check_matrix_pointer_lossage (struct glyph_matrix
*matrix
)
1437 for (i
= 0; i
< matrix
->nrows
; ++i
)
1438 for (j
= 0; j
< matrix
->nrows
; ++j
)
1440 || (matrix
->rows
[i
].glyphs
[TEXT_AREA
]
1441 != matrix
->rows
[j
].glyphs
[TEXT_AREA
]));
1445 /* Get a pointer to glyph row ROW in MATRIX, with bounds checks. */
1448 matrix_row (struct glyph_matrix
*matrix
, int row
)
1450 eassert (matrix
&& matrix
->rows
);
1451 eassert (row
>= 0 && row
< matrix
->nrows
);
1453 /* That's really too slow for normal testing because this function
1454 is called almost everywhere. Although---it's still astonishingly
1455 fast, so it is valuable to have for debugging purposes. */
1457 check_matrix_pointer_lossage (matrix
);
1460 return matrix
->rows
+ row
;
1464 #if 0 /* This function makes invalid assumptions when text is
1465 partially invisible. But it might come handy for debugging
1468 /* Check invariants that must hold for an up to date current matrix of
1472 check_matrix_invariants (struct window
*w
)
1474 struct glyph_matrix
*matrix
= w
->current_matrix
;
1475 int yb
= window_text_bottom_y (w
);
1476 struct glyph_row
*row
= matrix
->rows
;
1477 struct glyph_row
*last_text_row
= NULL
;
1478 struct buffer
*saved
= current_buffer
;
1479 struct buffer
*buffer
= XBUFFER (w
->buffer
);
1482 /* This can sometimes happen for a fresh window. */
1483 if (matrix
->nrows
< 2)
1486 set_buffer_temp (buffer
);
1488 /* Note: last row is always reserved for the mode line. */
1489 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
1490 && MATRIX_ROW_BOTTOM_Y (row
) < yb
)
1492 struct glyph_row
*next
= row
+ 1;
1494 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
1495 last_text_row
= row
;
1497 /* Check that character and byte positions are in sync. */
1498 eassert (MATRIX_ROW_START_BYTEPOS (row
)
1499 == CHAR_TO_BYTE (MATRIX_ROW_START_CHARPOS (row
)));
1500 eassert (BYTEPOS (row
->start
.pos
)
1501 == CHAR_TO_BYTE (CHARPOS (row
->start
.pos
)));
1503 /* CHAR_TO_BYTE aborts when invoked for a position > Z. We can
1504 have such a position temporarily in case of a minibuffer
1505 displaying something like `[Sole completion]' at its end. */
1506 if (MATRIX_ROW_END_CHARPOS (row
) < BUF_ZV (current_buffer
))
1508 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1509 == CHAR_TO_BYTE (MATRIX_ROW_END_CHARPOS (row
)));
1510 eassert (BYTEPOS (row
->end
.pos
)
1511 == CHAR_TO_BYTE (CHARPOS (row
->end
.pos
)));
1514 /* Check that end position of `row' is equal to start position
1516 if (next
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (next
))
1518 eassert (MATRIX_ROW_END_CHARPOS (row
)
1519 == MATRIX_ROW_START_CHARPOS (next
));
1520 eassert (MATRIX_ROW_END_BYTEPOS (row
)
1521 == MATRIX_ROW_START_BYTEPOS (next
));
1522 eassert (CHARPOS (row
->end
.pos
) == CHARPOS (next
->start
.pos
));
1523 eassert (BYTEPOS (row
->end
.pos
) == BYTEPOS (next
->start
.pos
));
1528 eassert (w
->current_matrix
->nrows
== w
->desired_matrix
->nrows
);
1529 eassert (w
->desired_matrix
->rows
!= NULL
);
1530 set_buffer_temp (saved
);
1535 #endif /* GLYPH_DEBUG */
1539 /**********************************************************************
1540 Allocating/ Adjusting Glyph Matrices
1541 **********************************************************************/
1543 /* Allocate glyph matrices over a window tree for a frame-based
1546 X and Y are column/row within the frame glyph matrix where
1547 sub-matrices for the window tree rooted at WINDOW must be
1548 allocated. DIM_ONLY_P means that the caller of this
1549 function is only interested in the result matrix dimension, and
1550 matrix adjustments should not be performed.
1552 The function returns the total width/height of the sub-matrices of
1553 the window tree. If called on a frame root window, the computation
1554 will take the mini-buffer window into account.
1556 *WINDOW_CHANGE_FLAGS is set to a bit mask with bits
1558 NEW_LEAF_MATRIX set if any window in the tree did not have a
1559 glyph matrices yet, and
1561 CHANGED_LEAF_MATRIX set if the dimension or location of a matrix of
1562 any window in the tree will be changed or have been changed (see
1565 *WINDOW_CHANGE_FLAGS must be initialized by the caller of this
1568 Windows are arranged into chains of windows on the same level
1569 through the next fields of window structures. Such a level can be
1570 either a sequence of horizontally adjacent windows from left to
1571 right, or a sequence of vertically adjacent windows from top to
1572 bottom. Each window in a horizontal sequence can be either a leaf
1573 window or a vertical sequence; a window in a vertical sequence can
1574 be either a leaf or a horizontal sequence. All windows in a
1575 horizontal sequence have the same height, and all windows in a
1576 vertical sequence have the same width.
1578 This function uses, for historical reasons, a more general
1579 algorithm to determine glyph matrix dimensions that would be
1582 The matrix height of a horizontal sequence is determined by the
1583 maximum height of any matrix in the sequence. The matrix width of
1584 a horizontal sequence is computed by adding up matrix widths of
1585 windows in the sequence.
1587 |<------- result width ------->|
1588 +---------+----------+---------+ ---
1591 +---------+ | | result height
1596 The matrix width of a vertical sequence is the maximum matrix width
1597 of any window in the sequence. Its height is computed by adding up
1598 matrix heights of windows in the sequence.
1600 |<---- result width -->|
1608 +------------+---------+ |
1611 +------------+---------+ --- */
1613 /* Bit indicating that a new matrix will be allocated or has been
1616 #define NEW_LEAF_MATRIX (1 << 0)
1618 /* Bit indicating that a matrix will or has changed its location or
1621 #define CHANGED_LEAF_MATRIX (1 << 1)
1624 allocate_matrices_for_frame_redisplay (Lisp_Object window
, int x
, int y
,
1625 bool dim_only_p
, int *window_change_flags
)
1627 struct frame
*f
= XFRAME (WINDOW_FRAME (XWINDOW (window
)));
1629 int wmax
= 0, hmax
= 0;
1633 bool in_horz_combination_p
;
1635 /* What combination is WINDOW part of? Compute this once since the
1636 result is the same for all windows in the `next' chain. The
1637 special case of a root window (parent equal to nil) is treated
1638 like a vertical combination because a root window's `next'
1639 points to the mini-buffer window, if any, which is arranged
1640 vertically below other windows. */
1641 in_horz_combination_p
1642 = (!NILP (XWINDOW (window
)->parent
)
1643 && !NILP (XWINDOW (XWINDOW (window
)->parent
)->hchild
));
1645 /* For WINDOW and all windows on the same level. */
1648 w
= XWINDOW (window
);
1650 /* Get the dimension of the window sub-matrix for W, depending
1651 on whether this is a combination or a leaf window. */
1652 if (!NILP (w
->hchild
))
1653 dim
= allocate_matrices_for_frame_redisplay (w
->hchild
, x
, y
,
1655 window_change_flags
);
1656 else if (!NILP (w
->vchild
))
1657 dim
= allocate_matrices_for_frame_redisplay (w
->vchild
, x
, y
,
1659 window_change_flags
);
1662 /* If not already done, allocate sub-matrix structures. */
1663 if (w
->desired_matrix
== NULL
)
1665 w
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
1666 w
->current_matrix
= new_glyph_matrix (f
->current_pool
);
1667 *window_change_flags
|= NEW_LEAF_MATRIX
;
1670 /* Width and height MUST be chosen so that there are no
1671 holes in the frame matrix. */
1672 dim
.width
= required_matrix_width (w
);
1673 dim
.height
= required_matrix_height (w
);
1675 /* Will matrix be re-allocated? */
1676 if (x
!= w
->desired_matrix
->matrix_x
1677 || y
!= w
->desired_matrix
->matrix_y
1678 || dim
.width
!= w
->desired_matrix
->matrix_w
1679 || dim
.height
!= w
->desired_matrix
->matrix_h
1680 || (margin_glyphs_to_reserve (w
, dim
.width
,
1681 w
->left_margin_cols
)
1682 != w
->desired_matrix
->left_margin_glyphs
)
1683 || (margin_glyphs_to_reserve (w
, dim
.width
,
1684 w
->right_margin_cols
)
1685 != w
->desired_matrix
->right_margin_glyphs
))
1686 *window_change_flags
|= CHANGED_LEAF_MATRIX
;
1688 /* Actually change matrices, if allowed. Do not consider
1689 CHANGED_LEAF_MATRIX computed above here because the pool
1690 may have been changed which we don't now here. We trust
1691 that we only will be called with DIM_ONLY_P when
1695 adjust_glyph_matrix (w
, w
->desired_matrix
, x
, y
, dim
);
1696 adjust_glyph_matrix (w
, w
->current_matrix
, x
, y
, dim
);
1700 /* If we are part of a horizontal combination, advance x for
1701 windows to the right of W; otherwise advance y for windows
1703 if (in_horz_combination_p
)
1708 /* Remember maximum glyph matrix dimensions. */
1709 wmax
= max (wmax
, dim
.width
);
1710 hmax
= max (hmax
, dim
.height
);
1712 /* Next window on same level. */
1715 while (!NILP (window
));
1717 /* Set `total' to the total glyph matrix dimension of this window
1718 level. In a vertical combination, the width is the width of the
1719 widest window; the height is the y we finally reached, corrected
1720 by the y we started with. In a horizontal combination, the total
1721 height is the height of the tallest window, and the width is the
1722 x we finally reached, corrected by the x we started with. */
1723 if (in_horz_combination_p
)
1725 total
.width
= x
- x0
;
1726 total
.height
= hmax
;
1731 total
.height
= y
- y0
;
1738 /* Return the required height of glyph matrices for window W. */
1741 required_matrix_height (struct window
*w
)
1743 #ifdef HAVE_WINDOW_SYSTEM
1744 struct frame
*f
= XFRAME (w
->frame
);
1746 if (FRAME_WINDOW_P (f
))
1748 int ch_height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1749 int window_pixel_height
= window_box_height (w
) + eabs (w
->vscroll
);
1750 return (((window_pixel_height
+ ch_height
- 1)
1751 / ch_height
) * w
->nrows_scale_factor
1752 /* One partially visible line at the top and
1753 bottom of the window. */
1755 /* 2 for header and mode line. */
1758 #endif /* HAVE_WINDOW_SYSTEM */
1760 return WINDOW_TOTAL_LINES (w
);
1764 /* Return the required width of glyph matrices for window W. */
1767 required_matrix_width (struct window
*w
)
1769 #ifdef HAVE_WINDOW_SYSTEM
1770 struct frame
*f
= XFRAME (w
->frame
);
1771 if (FRAME_WINDOW_P (f
))
1773 int ch_width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1774 int window_pixel_width
= WINDOW_TOTAL_WIDTH (w
);
1776 /* Compute number of glyphs needed in a glyph row. */
1777 return (((window_pixel_width
+ ch_width
- 1)
1778 / ch_width
) * w
->ncols_scale_factor
1779 /* 2 partially visible columns in the text area. */
1781 /* One partially visible column at the right
1782 edge of each marginal area. */
1785 #endif /* HAVE_WINDOW_SYSTEM */
1787 return XINT (w
->total_cols
);
1791 /* Allocate window matrices for window-based redisplay. W is the
1792 window whose matrices must be allocated/reallocated. */
1795 allocate_matrices_for_window_redisplay (struct window
*w
)
1799 if (!NILP (w
->vchild
))
1800 allocate_matrices_for_window_redisplay (XWINDOW (w
->vchild
));
1801 else if (!NILP (w
->hchild
))
1802 allocate_matrices_for_window_redisplay (XWINDOW (w
->hchild
));
1805 /* W is a leaf window. */
1808 /* If matrices are not yet allocated, allocate them now. */
1809 if (w
->desired_matrix
== NULL
)
1811 w
->desired_matrix
= new_glyph_matrix (NULL
);
1812 w
->current_matrix
= new_glyph_matrix (NULL
);
1815 dim
.width
= required_matrix_width (w
);
1816 dim
.height
= required_matrix_height (w
);
1817 adjust_glyph_matrix (w
, w
->desired_matrix
, 0, 0, dim
);
1818 adjust_glyph_matrix (w
, w
->current_matrix
, 0, 0, dim
);
1821 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
1826 /* Re-allocate/ re-compute glyph matrices on frame F. If F is null,
1827 do it for all frames; otherwise do it just for the given frame.
1828 This function must be called when a new frame is created, its size
1829 changes, or its window configuration changes. */
1832 adjust_glyphs (struct frame
*f
)
1834 /* Block input so that expose events and other events that access
1835 glyph matrices are not processed while we are changing them. */
1839 adjust_frame_glyphs (f
);
1842 Lisp_Object tail
, lisp_frame
;
1844 FOR_EACH_FRAME (tail
, lisp_frame
)
1845 adjust_frame_glyphs (XFRAME (lisp_frame
));
1851 /* Allocate/reallocate glyph matrices of a single frame F. */
1854 adjust_frame_glyphs (struct frame
*f
)
1856 if (FRAME_WINDOW_P (f
))
1857 adjust_frame_glyphs_for_window_redisplay (f
);
1859 adjust_frame_glyphs_for_frame_redisplay (f
);
1861 /* Don't forget the message buffer and the buffer for
1862 decode_mode_spec. */
1863 adjust_frame_message_buffer (f
);
1864 adjust_decode_mode_spec_buffer (f
);
1866 f
->glyphs_initialized_p
= 1;
1869 /* Return true if any window in the tree has nonzero window margins. See
1870 the hack at the end of adjust_frame_glyphs_for_frame_redisplay. */
1872 showing_window_margins_p (struct window
*w
)
1876 if (!NILP (w
->hchild
))
1878 if (showing_window_margins_p (XWINDOW (w
->hchild
)))
1881 else if (!NILP (w
->vchild
))
1883 if (showing_window_margins_p (XWINDOW (w
->vchild
)))
1886 else if (!NILP (w
->left_margin_cols
)
1887 || !NILP (w
->right_margin_cols
))
1890 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
1896 /* In the window tree with root W, build current matrices of leaf
1897 windows from the frame's current matrix. */
1900 fake_current_matrices (Lisp_Object window
)
1904 for (; !NILP (window
); window
= w
->next
)
1906 w
= XWINDOW (window
);
1908 if (!NILP (w
->hchild
))
1909 fake_current_matrices (w
->hchild
);
1910 else if (!NILP (w
->vchild
))
1911 fake_current_matrices (w
->vchild
);
1915 struct frame
*f
= XFRAME (w
->frame
);
1916 struct glyph_matrix
*m
= w
->current_matrix
;
1917 struct glyph_matrix
*fm
= f
->current_matrix
;
1919 eassert (m
->matrix_h
== WINDOW_TOTAL_LINES (w
));
1920 eassert (m
->matrix_w
== WINDOW_TOTAL_COLS (w
));
1922 for (i
= 0; i
< m
->matrix_h
; ++i
)
1924 struct glyph_row
*r
= m
->rows
+ i
;
1925 struct glyph_row
*fr
= fm
->rows
+ i
+ WINDOW_TOP_EDGE_LINE (w
);
1927 eassert (r
->glyphs
[TEXT_AREA
] >= fr
->glyphs
[TEXT_AREA
]
1928 && r
->glyphs
[LAST_AREA
] <= fr
->glyphs
[LAST_AREA
]);
1930 r
->enabled_p
= fr
->enabled_p
;
1933 r
->used
[LEFT_MARGIN_AREA
] = m
->left_margin_glyphs
;
1934 r
->used
[RIGHT_MARGIN_AREA
] = m
->right_margin_glyphs
;
1935 r
->used
[TEXT_AREA
] = (m
->matrix_w
1936 - r
->used
[LEFT_MARGIN_AREA
]
1937 - r
->used
[RIGHT_MARGIN_AREA
]);
1946 /* Save away the contents of frame F's current frame matrix. Value is
1947 a glyph matrix holding the contents of F's current frame matrix. */
1949 static struct glyph_matrix
*
1950 save_current_matrix (struct frame
*f
)
1953 struct glyph_matrix
*saved
= xzalloc (sizeof *saved
);
1954 saved
->nrows
= f
->current_matrix
->nrows
;
1955 saved
->rows
= xzalloc (saved
->nrows
* sizeof *saved
->rows
);
1957 for (i
= 0; i
< saved
->nrows
; ++i
)
1959 struct glyph_row
*from
= f
->current_matrix
->rows
+ i
;
1960 struct glyph_row
*to
= saved
->rows
+ i
;
1961 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1962 to
->glyphs
[TEXT_AREA
] = xmalloc (nbytes
);
1963 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1964 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1971 /* Restore the contents of frame F's current frame matrix from SAVED,
1972 and free memory associated with SAVED. */
1975 restore_current_matrix (struct frame
*f
, struct glyph_matrix
*saved
)
1979 for (i
= 0; i
< saved
->nrows
; ++i
)
1981 struct glyph_row
*from
= saved
->rows
+ i
;
1982 struct glyph_row
*to
= f
->current_matrix
->rows
+ i
;
1983 ptrdiff_t nbytes
= from
->used
[TEXT_AREA
] * sizeof (struct glyph
);
1984 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
], nbytes
);
1985 to
->used
[TEXT_AREA
] = from
->used
[TEXT_AREA
];
1986 xfree (from
->glyphs
[TEXT_AREA
]);
1989 xfree (saved
->rows
);
1995 /* Allocate/reallocate glyph matrices of a single frame F for
1996 frame-based redisplay. */
1999 adjust_frame_glyphs_for_frame_redisplay (struct frame
*f
)
2001 struct dim matrix_dim
;
2002 bool pool_changed_p
;
2003 int window_change_flags
;
2006 if (!FRAME_LIVE_P (f
))
2009 top_window_y
= FRAME_TOP_MARGIN (f
);
2011 /* Allocate glyph pool structures if not already done. */
2012 if (f
->desired_pool
== NULL
)
2014 f
->desired_pool
= new_glyph_pool ();
2015 f
->current_pool
= new_glyph_pool ();
2018 /* Allocate frames matrix structures if needed. */
2019 if (f
->desired_matrix
== NULL
)
2021 f
->desired_matrix
= new_glyph_matrix (f
->desired_pool
);
2022 f
->current_matrix
= new_glyph_matrix (f
->current_pool
);
2025 /* Compute window glyph matrices. (This takes the mini-buffer
2026 window into account). The result is the size of the frame glyph
2027 matrix needed. The variable window_change_flags is set to a bit
2028 mask indicating whether new matrices will be allocated or
2029 existing matrices change their size or location within the frame
2031 window_change_flags
= 0;
2033 = allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2036 &window_change_flags
);
2038 /* Add in menu bar lines, if any. */
2039 matrix_dim
.height
+= top_window_y
;
2041 /* Enlarge pools as necessary. */
2042 pool_changed_p
= realloc_glyph_pool (f
->desired_pool
, matrix_dim
);
2043 realloc_glyph_pool (f
->current_pool
, matrix_dim
);
2045 /* Set up glyph pointers within window matrices. Do this only if
2046 absolutely necessary since it requires a frame redraw. */
2047 if (pool_changed_p
|| window_change_flags
)
2049 /* Do it for window matrices. */
2050 allocate_matrices_for_frame_redisplay (FRAME_ROOT_WINDOW (f
),
2052 &window_change_flags
);
2054 /* Size of frame matrices must equal size of frame. Note
2055 that we are called for X frames with window widths NOT equal
2056 to the frame width (from CHANGE_FRAME_SIZE_1). */
2057 eassert (matrix_dim
.width
== FRAME_COLS (f
)
2058 && matrix_dim
.height
== FRAME_LINES (f
));
2060 /* Pointers to glyph memory in glyph rows are exchanged during
2061 the update phase of redisplay, which means in general that a
2062 frame's current matrix consists of pointers into both the
2063 desired and current glyph pool of the frame. Adjusting a
2064 matrix sets the frame matrix up so that pointers are all into
2065 the same pool. If we want to preserve glyph contents of the
2066 current matrix over a call to adjust_glyph_matrix, we must
2067 make a copy of the current glyphs, and restore the current
2068 matrix' contents from that copy. */
2069 if (display_completed
2070 && !FRAME_GARBAGED_P (f
)
2071 && matrix_dim
.width
== f
->current_matrix
->matrix_w
2072 && matrix_dim
.height
== f
->current_matrix
->matrix_h
2073 /* For some reason, the frame glyph matrix gets corrupted if
2074 any of the windows contain margins. I haven't been able
2075 to hunt down the reason, but for the moment this prevents
2076 the problem from manifesting. -- cyd */
2077 && !showing_window_margins_p (XWINDOW (FRAME_ROOT_WINDOW (f
))))
2079 struct glyph_matrix
*copy
= save_current_matrix (f
);
2080 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2081 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2082 restore_current_matrix (f
, copy
);
2083 fake_current_matrices (FRAME_ROOT_WINDOW (f
));
2087 adjust_glyph_matrix (NULL
, f
->desired_matrix
, 0, 0, matrix_dim
);
2088 adjust_glyph_matrix (NULL
, f
->current_matrix
, 0, 0, matrix_dim
);
2089 SET_FRAME_GARBAGED (f
);
2095 /* Allocate/reallocate glyph matrices of a single frame F for
2096 window-based redisplay. */
2099 adjust_frame_glyphs_for_window_redisplay (struct frame
*f
)
2101 eassert (FRAME_WINDOW_P (f
) && FRAME_LIVE_P (f
));
2103 /* Allocate/reallocate window matrices. */
2104 allocate_matrices_for_window_redisplay (XWINDOW (FRAME_ROOT_WINDOW (f
)));
2106 #ifdef HAVE_X_WINDOWS
2107 /* Allocate/ reallocate matrices of the dummy window used to display
2108 the menu bar under X when no X toolkit support is available. */
2109 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
2111 /* Allocate a dummy window if not already done. */
2113 if (NILP (f
->menu_bar_window
))
2116 fset_menu_bar_window (f
, make_window ());
2117 w
= XWINDOW (f
->menu_bar_window
);
2118 XSETFRAME (frame
, f
);
2119 wset_frame (w
, frame
);
2120 w
->pseudo_window_p
= 1;
2123 w
= XWINDOW (f
->menu_bar_window
);
2125 /* Set window dimensions to frame dimensions and allocate or
2126 adjust glyph matrices of W. */
2127 wset_top_line (w
, make_number (0));
2128 wset_left_col (w
, make_number (0));
2129 wset_total_lines (w
, make_number (FRAME_MENU_BAR_LINES (f
)));
2130 wset_total_cols (w
, make_number (FRAME_TOTAL_COLS (f
)));
2131 allocate_matrices_for_window_redisplay (w
);
2133 #endif /* not USE_X_TOOLKIT && not USE_GTK */
2134 #endif /* HAVE_X_WINDOWS */
2138 /* Allocate/ reallocate matrices of the tool bar window. If we
2139 don't have a tool bar window yet, make one. */
2141 if (NILP (f
->tool_bar_window
))
2144 fset_tool_bar_window (f
, make_window ());
2145 w
= XWINDOW (f
->tool_bar_window
);
2146 XSETFRAME (frame
, f
);
2147 wset_frame (w
, frame
);
2148 w
->pseudo_window_p
= 1;
2151 w
= XWINDOW (f
->tool_bar_window
);
2153 wset_top_line (w
, make_number (FRAME_MENU_BAR_LINES (f
)));
2154 wset_left_col (w
, make_number (0));
2155 wset_total_lines (w
, make_number (FRAME_TOOL_BAR_LINES (f
)));
2156 wset_total_cols (w
, make_number (FRAME_TOTAL_COLS (f
)));
2157 allocate_matrices_for_window_redisplay (w
);
2163 /* Adjust/ allocate message buffer of frame F.
2165 Note that the message buffer is never freed. Since I could not
2166 find a free in 19.34, I assume that freeing it would be
2167 problematic in some way and don't do it either.
2169 (Implementation note: It should be checked if we can free it
2170 eventually without causing trouble). */
2173 adjust_frame_message_buffer (struct frame
*f
)
2175 FRAME_MESSAGE_BUF (f
) = xrealloc (FRAME_MESSAGE_BUF (f
),
2176 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2180 /* Re-allocate buffer for decode_mode_spec on frame F. */
2183 adjust_decode_mode_spec_buffer (struct frame
*f
)
2185 f
->decode_mode_spec_buffer
= xrealloc (f
->decode_mode_spec_buffer
,
2186 FRAME_MESSAGE_BUF_SIZE (f
) + 1);
2191 /**********************************************************************
2192 Freeing Glyph Matrices
2193 **********************************************************************/
2195 /* Free glyph memory for a frame F. F may be null. This function can
2196 be called for the same frame more than once. The root window of
2197 F may be nil when this function is called. This is the case when
2198 the function is called when F is destroyed. */
2201 free_glyphs (struct frame
*f
)
2203 if (f
&& f
->glyphs_initialized_p
)
2205 /* Block interrupt input so that we don't get surprised by an X
2206 event while we're in an inconsistent state. */
2208 f
->glyphs_initialized_p
= 0;
2210 /* Release window sub-matrices. */
2211 if (!NILP (f
->root_window
))
2212 free_window_matrices (XWINDOW (f
->root_window
));
2214 /* Free the dummy window for menu bars without X toolkit and its
2216 if (!NILP (f
->menu_bar_window
))
2218 struct window
*w
= XWINDOW (f
->menu_bar_window
);
2219 free_glyph_matrix (w
->desired_matrix
);
2220 free_glyph_matrix (w
->current_matrix
);
2221 w
->desired_matrix
= w
->current_matrix
= NULL
;
2222 fset_menu_bar_window (f
, Qnil
);
2225 /* Free the tool bar window and its glyph matrices. */
2226 if (!NILP (f
->tool_bar_window
))
2228 struct window
*w
= XWINDOW (f
->tool_bar_window
);
2229 free_glyph_matrix (w
->desired_matrix
);
2230 free_glyph_matrix (w
->current_matrix
);
2231 w
->desired_matrix
= w
->current_matrix
= NULL
;
2232 fset_tool_bar_window (f
, Qnil
);
2235 /* Release frame glyph matrices. Reset fields to zero in
2236 case we are called a second time. */
2237 if (f
->desired_matrix
)
2239 free_glyph_matrix (f
->desired_matrix
);
2240 free_glyph_matrix (f
->current_matrix
);
2241 f
->desired_matrix
= f
->current_matrix
= NULL
;
2244 /* Release glyph pools. */
2245 if (f
->desired_pool
)
2247 free_glyph_pool (f
->desired_pool
);
2248 free_glyph_pool (f
->current_pool
);
2249 f
->desired_pool
= f
->current_pool
= NULL
;
2257 /* Free glyph sub-matrices in the window tree rooted at W. This
2258 function may be called with a null pointer, and it may be called on
2259 the same tree more than once. */
2262 free_window_matrices (struct window
*w
)
2266 if (!NILP (w
->hchild
))
2267 free_window_matrices (XWINDOW (w
->hchild
));
2268 else if (!NILP (w
->vchild
))
2269 free_window_matrices (XWINDOW (w
->vchild
));
2272 /* This is a leaf window. Free its memory and reset fields
2273 to zero in case this function is called a second time for
2275 free_glyph_matrix (w
->current_matrix
);
2276 free_glyph_matrix (w
->desired_matrix
);
2277 w
->current_matrix
= w
->desired_matrix
= NULL
;
2280 /* Next window on same level. */
2281 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2286 /* Check glyph memory leaks. This function is called from
2287 shut_down_emacs. Note that frames are not destroyed when Emacs
2288 exits. We therefore free all glyph memory for all active frames
2289 explicitly and check that nothing is left allocated. */
2292 check_glyph_memory (void)
2294 Lisp_Object tail
, frame
;
2296 /* Free glyph memory for all frames. */
2297 FOR_EACH_FRAME (tail
, frame
)
2298 free_glyphs (XFRAME (frame
));
2300 /* Check that nothing is left allocated. */
2301 if (glyph_matrix_count
)
2303 if (glyph_pool_count
)
2309 /**********************************************************************
2310 Building a Frame Matrix
2311 **********************************************************************/
2313 /* Most of the redisplay code works on glyph matrices attached to
2314 windows. This is a good solution most of the time, but it is not
2315 suitable for terminal code. Terminal output functions cannot rely
2316 on being able to set an arbitrary terminal window. Instead they
2317 must be provided with a view of the whole frame, i.e. the whole
2318 screen. We build such a view by constructing a frame matrix from
2319 window matrices in this section.
2321 Windows that must be updated have their must_be_update_p flag set.
2322 For all such windows, their desired matrix is made part of the
2323 desired frame matrix. For other windows, their current matrix is
2324 made part of the desired frame matrix.
2326 +-----------------+----------------+
2327 | desired | desired |
2329 +-----------------+----------------+
2332 +----------------------------------+
2334 Desired window matrices can be made part of the frame matrix in a
2335 cheap way: We exploit the fact that the desired frame matrix and
2336 desired window matrices share their glyph memory. This is not
2337 possible for current window matrices. Their glyphs are copied to
2338 the desired frame matrix. The latter is equivalent to
2339 preserve_other_columns in the old redisplay.
2341 Used glyphs counters for frame matrix rows are the result of adding
2342 up glyph lengths of the window matrices. A line in the frame
2343 matrix is enabled, if a corresponding line in a window matrix is
2346 After building the desired frame matrix, it will be passed to
2347 terminal code, which will manipulate both the desired and current
2348 frame matrix. Changes applied to the frame's current matrix have
2349 to be visible in current window matrices afterwards, of course.
2351 This problem is solved like this:
2353 1. Window and frame matrices share glyphs. Window matrices are
2354 constructed in a way that their glyph contents ARE the glyph
2355 contents needed in a frame matrix. Thus, any modification of
2356 glyphs done in terminal code will be reflected in window matrices
2359 2. Exchanges of rows in a frame matrix done by terminal code are
2360 intercepted by hook functions so that corresponding row operations
2361 on window matrices can be performed. This is necessary because we
2362 use pointers to glyphs in glyph row structures. To satisfy the
2363 assumption of point 1 above that glyphs are updated implicitly in
2364 window matrices when they are manipulated via the frame matrix,
2365 window and frame matrix must of course agree where to find the
2366 glyphs for their rows. Possible manipulations that must be
2367 mirrored are assignments of rows of the desired frame matrix to the
2368 current frame matrix and scrolling the current frame matrix. */
2370 /* Build frame F's desired matrix from window matrices. Only windows
2371 which have the flag must_be_updated_p set have to be updated. Menu
2372 bar lines of a frame are not covered by window matrices, so make
2373 sure not to touch them in this function. */
2376 build_frame_matrix (struct frame
*f
)
2380 /* F must have a frame matrix when this function is called. */
2381 eassert (!FRAME_WINDOW_P (f
));
2383 /* Clear all rows in the frame matrix covered by window matrices.
2384 Menu bar lines are not covered by windows. */
2385 for (i
= FRAME_TOP_MARGIN (f
); i
< f
->desired_matrix
->nrows
; ++i
)
2386 clear_glyph_row (MATRIX_ROW (f
->desired_matrix
, i
));
2388 /* Build the matrix by walking the window tree. */
2389 build_frame_matrix_from_window_tree (f
->desired_matrix
,
2390 XWINDOW (FRAME_ROOT_WINDOW (f
)));
2394 /* Walk a window tree, building a frame matrix MATRIX from window
2395 matrices. W is the root of a window tree. */
2398 build_frame_matrix_from_window_tree (struct glyph_matrix
*matrix
, struct window
*w
)
2402 if (!NILP (w
->hchild
))
2403 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->hchild
));
2404 else if (!NILP (w
->vchild
))
2405 build_frame_matrix_from_window_tree (matrix
, XWINDOW (w
->vchild
));
2407 build_frame_matrix_from_leaf_window (matrix
, w
);
2409 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2414 /* Add a window's matrix to a frame matrix. FRAME_MATRIX is the
2415 desired frame matrix built. W is a leaf window whose desired or
2416 current matrix is to be added to FRAME_MATRIX. W's flag
2417 must_be_updated_p determines which matrix it contributes to
2418 FRAME_MATRIX. If W->must_be_updated_p, W's desired matrix
2419 is added to FRAME_MATRIX, otherwise W's current matrix is added.
2420 Adding a desired matrix means setting up used counters and such in
2421 frame rows, while adding a current window matrix to FRAME_MATRIX
2422 means copying glyphs. The latter case corresponds to
2423 preserve_other_columns in the old redisplay. */
2426 build_frame_matrix_from_leaf_window (struct glyph_matrix
*frame_matrix
, struct window
*w
)
2428 struct glyph_matrix
*window_matrix
;
2429 int window_y
, frame_y
;
2430 /* If non-zero, a glyph to insert at the right border of W. */
2431 GLYPH right_border_glyph
;
2433 SET_GLYPH_FROM_CHAR (right_border_glyph
, 0);
2435 /* Set window_matrix to the matrix we have to add to FRAME_MATRIX. */
2436 if (w
->must_be_updated_p
)
2438 window_matrix
= w
->desired_matrix
;
2440 /* Decide whether we want to add a vertical border glyph. */
2441 if (!WINDOW_RIGHTMOST_P (w
))
2443 struct Lisp_Char_Table
*dp
= window_display_table (w
);
2446 SET_GLYPH_FROM_CHAR (right_border_glyph
, '|');
2448 && (gc
= DISP_BORDER_GLYPH (dp
), GLYPH_CODE_P (gc
)))
2450 SET_GLYPH_FROM_GLYPH_CODE (right_border_glyph
, gc
);
2451 spec_glyph_lookup_face (w
, &right_border_glyph
);
2454 if (GLYPH_FACE (right_border_glyph
) <= 0)
2455 SET_GLYPH_FACE (right_border_glyph
, VERTICAL_BORDER_FACE_ID
);
2459 window_matrix
= w
->current_matrix
;
2461 /* For all rows in the window matrix and corresponding rows in the
2464 frame_y
= window_matrix
->matrix_y
;
2465 while (window_y
< window_matrix
->nrows
)
2467 struct glyph_row
*frame_row
= frame_matrix
->rows
+ frame_y
;
2468 struct glyph_row
*window_row
= window_matrix
->rows
+ window_y
;
2469 bool current_row_p
= window_matrix
== w
->current_matrix
;
2471 /* Fill up the frame row with spaces up to the left margin of the
2473 fill_up_frame_row_with_spaces (frame_row
, window_matrix
->matrix_x
);
2475 /* Fill up areas in the window matrix row with spaces. */
2476 fill_up_glyph_row_with_spaces (window_row
);
2478 /* If only part of W's desired matrix has been built, and
2479 window_row wasn't displayed, use the corresponding current
2481 if (window_matrix
== w
->desired_matrix
2482 && !window_row
->enabled_p
)
2484 window_row
= w
->current_matrix
->rows
+ window_y
;
2490 /* Copy window row to frame row. */
2491 memcpy (frame_row
->glyphs
[TEXT_AREA
] + window_matrix
->matrix_x
,
2492 window_row
->glyphs
[0],
2493 window_matrix
->matrix_w
* sizeof (struct glyph
));
2497 eassert (window_row
->enabled_p
);
2499 /* Only when a desired row has been displayed, we want
2500 the corresponding frame row to be updated. */
2501 frame_row
->enabled_p
= 1;
2503 /* Maybe insert a vertical border between horizontally adjacent
2505 if (GLYPH_CHAR (right_border_glyph
) != 0)
2507 struct glyph
*border
= window_row
->glyphs
[LAST_AREA
] - 1;
2508 SET_CHAR_GLYPH_FROM_GLYPH (*border
, right_border_glyph
);
2512 /* Window row window_y must be a slice of frame row
2514 eassert (glyph_row_slice_p (window_row
, frame_row
));
2516 /* If rows are in sync, we don't have to copy glyphs because
2517 frame and window share glyphs. */
2519 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
2520 add_window_display_history (w
, w
->current_matrix
->method
, 0);
2524 /* Set number of used glyphs in the frame matrix. Since we fill
2525 up with spaces, and visit leaf windows from left to right it
2526 can be done simply. */
2527 frame_row
->used
[TEXT_AREA
]
2528 = window_matrix
->matrix_x
+ window_matrix
->matrix_w
;
2536 /* Given a user-specified glyph, possibly including a Lisp-level face
2537 ID, return a glyph that has a realized face ID.
2538 This is used for glyphs displayed specially and not part of the text;
2539 for instance, vertical separators, truncation markers, etc. */
2542 spec_glyph_lookup_face (struct window
*w
, GLYPH
*glyph
)
2544 int lface_id
= GLYPH_FACE (*glyph
);
2545 /* Convert the glyph's specified face to a realized (cache) face. */
2548 int face_id
= merge_faces (XFRAME (w
->frame
),
2549 Qt
, lface_id
, DEFAULT_FACE_ID
);
2550 SET_GLYPH_FACE (*glyph
, face_id
);
2554 /* Add spaces to a glyph row ROW in a window matrix.
2556 Each row has the form:
2558 +---------+-----------------------------+------------+
2559 | left | text | right |
2560 +---------+-----------------------------+------------+
2562 Left and right marginal areas are optional. This function adds
2563 spaces to areas so that there are no empty holes between areas.
2564 In other words: If the right area is not empty, the text area
2565 is filled up with spaces up to the right area. If the text area
2566 is not empty, the left area is filled up.
2568 To be called for frame-based redisplay, only. */
2571 fill_up_glyph_row_with_spaces (struct glyph_row
*row
)
2573 fill_up_glyph_row_area_with_spaces (row
, LEFT_MARGIN_AREA
);
2574 fill_up_glyph_row_area_with_spaces (row
, TEXT_AREA
);
2575 fill_up_glyph_row_area_with_spaces (row
, RIGHT_MARGIN_AREA
);
2579 /* Fill area AREA of glyph row ROW with spaces. To be called for
2580 frame-based redisplay only. */
2583 fill_up_glyph_row_area_with_spaces (struct glyph_row
*row
, int area
)
2585 if (row
->glyphs
[area
] < row
->glyphs
[area
+ 1])
2587 struct glyph
*end
= row
->glyphs
[area
+ 1];
2588 struct glyph
*text
= row
->glyphs
[area
] + row
->used
[area
];
2591 *text
++ = space_glyph
;
2592 row
->used
[area
] = text
- row
->glyphs
[area
];
2597 /* Add spaces to the end of ROW in a frame matrix until index UPTO is
2598 reached. In frame matrices only one area, TEXT_AREA, is used. */
2601 fill_up_frame_row_with_spaces (struct glyph_row
*row
, int upto
)
2603 int i
= row
->used
[TEXT_AREA
];
2604 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
2607 glyph
[i
++] = space_glyph
;
2609 row
->used
[TEXT_AREA
] = i
;
2614 /**********************************************************************
2615 Mirroring operations on frame matrices in window matrices
2616 **********************************************************************/
2618 /* Set frame being updated via frame-based redisplay to F. This
2619 function must be called before updates to make explicit that we are
2620 working on frame matrices or not. */
2623 set_frame_matrix_frame (struct frame
*f
)
2625 frame_matrix_frame
= f
;
2629 /* Make sure glyph row ROW in CURRENT_MATRIX is up to date.
2630 DESIRED_MATRIX is the desired matrix corresponding to
2631 CURRENT_MATRIX. The update is done by exchanging glyph pointers
2632 between rows in CURRENT_MATRIX and DESIRED_MATRIX. If
2633 frame_matrix_frame is non-null, this indicates that the exchange is
2634 done in frame matrices, and that we have to perform analogous
2635 operations in window matrices of frame_matrix_frame. */
2638 make_current (struct glyph_matrix
*desired_matrix
, struct glyph_matrix
*current_matrix
, int row
)
2640 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, row
);
2641 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, row
);
2642 bool mouse_face_p
= current_row
->mouse_face_p
;
2644 /* Do current_row = desired_row. This exchanges glyph pointers
2645 between both rows, and does a structure assignment otherwise. */
2646 assign_row (current_row
, desired_row
);
2648 /* Enable current_row to mark it as valid. */
2649 current_row
->enabled_p
= 1;
2650 current_row
->mouse_face_p
= mouse_face_p
;
2652 /* If we are called on frame matrices, perform analogous operations
2653 for window matrices. */
2654 if (frame_matrix_frame
)
2655 mirror_make_current (XWINDOW (frame_matrix_frame
->root_window
), row
);
2659 /* W is the root of a window tree. FRAME_ROW is the index of a row in
2660 W's frame which has been made current (by swapping pointers between
2661 current and desired matrix). Perform analogous operations in the
2662 matrices of leaf windows in the window tree rooted at W. */
2665 mirror_make_current (struct window
*w
, int frame_row
)
2669 if (!NILP (w
->hchild
))
2670 mirror_make_current (XWINDOW (w
->hchild
), frame_row
);
2671 else if (!NILP (w
->vchild
))
2672 mirror_make_current (XWINDOW (w
->vchild
), frame_row
);
2675 /* Row relative to window W. Don't use FRAME_TO_WINDOW_VPOS
2676 here because the checks performed in debug mode there
2677 will not allow the conversion. */
2678 int row
= frame_row
- w
->desired_matrix
->matrix_y
;
2680 /* If FRAME_ROW is within W, assign the desired row to the
2681 current row (exchanging glyph pointers). */
2682 if (row
>= 0 && row
< w
->desired_matrix
->matrix_h
)
2684 struct glyph_row
*current_row
2685 = MATRIX_ROW (w
->current_matrix
, row
);
2686 struct glyph_row
*desired_row
2687 = MATRIX_ROW (w
->desired_matrix
, row
);
2689 if (desired_row
->enabled_p
)
2690 assign_row (current_row
, desired_row
);
2692 swap_glyph_pointers (desired_row
, current_row
);
2693 current_row
->enabled_p
= 1;
2695 /* Set the Y coordinate of the mode/header line's row.
2696 It is needed in draw_row_with_mouse_face to find the
2697 screen coordinates. (Window-based redisplay sets
2698 this in update_window, but no one seems to do that
2699 for frame-based redisplay.) */
2700 if (current_row
->mode_line_p
)
2701 current_row
->y
= row
;
2705 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2710 /* Perform row dance after scrolling. We are working on the range of
2711 lines UNCHANGED_AT_TOP + 1 to UNCHANGED_AT_TOP + NLINES (not
2712 including) in MATRIX. COPY_FROM is a vector containing, for each
2713 row I in the range 0 <= I < NLINES, the index of the original line
2714 to move to I. This index is relative to the row range, i.e. 0 <=
2715 index < NLINES. RETAINED_P is a vector containing zero for each
2716 row 0 <= I < NLINES which is empty.
2718 This function is called from do_scrolling and do_direct_scrolling. */
2721 mirrored_line_dance (struct glyph_matrix
*matrix
, int unchanged_at_top
, int nlines
,
2722 int *copy_from
, char *retained_p
)
2724 /* A copy of original rows. */
2725 struct glyph_row
*old_rows
;
2727 /* Rows to assign to. */
2728 struct glyph_row
*new_rows
= MATRIX_ROW (matrix
, unchanged_at_top
);
2732 /* Make a copy of the original rows. */
2733 old_rows
= alloca (nlines
* sizeof *old_rows
);
2734 memcpy (old_rows
, new_rows
, nlines
* sizeof *old_rows
);
2736 /* Assign new rows, maybe clear lines. */
2737 for (i
= 0; i
< nlines
; ++i
)
2739 bool enabled_before_p
= new_rows
[i
].enabled_p
;
2741 eassert (i
+ unchanged_at_top
< matrix
->nrows
);
2742 eassert (unchanged_at_top
+ copy_from
[i
] < matrix
->nrows
);
2743 new_rows
[i
] = old_rows
[copy_from
[i
]];
2744 new_rows
[i
].enabled_p
= enabled_before_p
;
2746 /* RETAINED_P is zero for empty lines. */
2747 if (!retained_p
[copy_from
[i
]])
2748 new_rows
[i
].enabled_p
= 0;
2751 /* Do the same for window matrices, if MATRIX is a frame matrix. */
2752 if (frame_matrix_frame
)
2753 mirror_line_dance (XWINDOW (frame_matrix_frame
->root_window
),
2754 unchanged_at_top
, nlines
, copy_from
, retained_p
);
2758 /* Synchronize glyph pointers in the current matrix of window W with
2759 the current frame matrix. */
2762 sync_window_with_frame_matrix_rows (struct window
*w
)
2764 struct frame
*f
= XFRAME (w
->frame
);
2765 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
2766 int left
, right
, x
, width
;
2768 /* Preconditions: W must be a leaf window on a tty frame. */
2769 eassert (NILP (w
->hchild
) && NILP (w
->vchild
));
2770 eassert (!FRAME_WINDOW_P (f
));
2772 left
= margin_glyphs_to_reserve (w
, 1, w
->left_margin_cols
);
2773 right
= margin_glyphs_to_reserve (w
, 1, w
->right_margin_cols
);
2774 x
= w
->current_matrix
->matrix_x
;
2775 width
= w
->current_matrix
->matrix_w
;
2777 window_row
= w
->current_matrix
->rows
;
2778 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
2779 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
2781 for (; window_row
< window_row_end
; ++window_row
, ++frame_row
)
2783 window_row
->glyphs
[LEFT_MARGIN_AREA
]
2784 = frame_row
->glyphs
[0] + x
;
2785 window_row
->glyphs
[TEXT_AREA
]
2786 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + left
;
2787 window_row
->glyphs
[LAST_AREA
]
2788 = window_row
->glyphs
[LEFT_MARGIN_AREA
] + width
;
2789 window_row
->glyphs
[RIGHT_MARGIN_AREA
]
2790 = window_row
->glyphs
[LAST_AREA
] - right
;
2795 /* Return the window in the window tree rooted in W containing frame
2796 row ROW. Value is null if none is found. */
2798 static struct window
*
2799 frame_row_to_window (struct window
*w
, int row
)
2801 struct window
*found
= NULL
;
2805 if (!NILP (w
->hchild
))
2806 found
= frame_row_to_window (XWINDOW (w
->hchild
), row
);
2807 else if (!NILP (w
->vchild
))
2808 found
= frame_row_to_window (XWINDOW (w
->vchild
), row
);
2809 else if (row
>= WINDOW_TOP_EDGE_LINE (w
)
2810 && row
< WINDOW_BOTTOM_EDGE_LINE (w
))
2813 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2820 /* Perform a line dance in the window tree rooted at W, after
2821 scrolling a frame matrix in mirrored_line_dance.
2823 We are working on the range of lines UNCHANGED_AT_TOP + 1 to
2824 UNCHANGED_AT_TOP + NLINES (not including) in W's frame matrix.
2825 COPY_FROM is a vector containing, for each row I in the range 0 <=
2826 I < NLINES, the index of the original line to move to I. This
2827 index is relative to the row range, i.e. 0 <= index < NLINES.
2828 RETAINED_P is a vector containing zero for each row 0 <= I < NLINES
2832 mirror_line_dance (struct window
*w
, int unchanged_at_top
, int nlines
, int *copy_from
, char *retained_p
)
2836 if (!NILP (w
->hchild
))
2837 mirror_line_dance (XWINDOW (w
->hchild
), unchanged_at_top
,
2838 nlines
, copy_from
, retained_p
);
2839 else if (!NILP (w
->vchild
))
2840 mirror_line_dance (XWINDOW (w
->vchild
), unchanged_at_top
,
2841 nlines
, copy_from
, retained_p
);
2844 /* W is a leaf window, and we are working on its current
2846 struct glyph_matrix
*m
= w
->current_matrix
;
2849 struct glyph_row
*old_rows
;
2851 /* Make a copy of the original rows of matrix m. */
2852 old_rows
= alloca (m
->nrows
* sizeof *old_rows
);
2853 memcpy (old_rows
, m
->rows
, m
->nrows
* sizeof *old_rows
);
2855 for (i
= 0; i
< nlines
; ++i
)
2857 /* Frame relative line assigned to. */
2858 int frame_to
= i
+ unchanged_at_top
;
2860 /* Frame relative line assigned. */
2861 int frame_from
= copy_from
[i
] + unchanged_at_top
;
2863 /* Window relative line assigned to. */
2864 int window_to
= frame_to
- m
->matrix_y
;
2866 /* Window relative line assigned. */
2867 int window_from
= frame_from
- m
->matrix_y
;
2869 /* Is assigned line inside window? */
2870 bool from_inside_window_p
2871 = window_from
>= 0 && window_from
< m
->matrix_h
;
2873 /* Is assigned to line inside window? */
2874 bool to_inside_window_p
2875 = window_to
>= 0 && window_to
< m
->matrix_h
;
2877 if (from_inside_window_p
&& to_inside_window_p
)
2879 /* Do the assignment. The enabled_p flag is saved
2880 over the assignment because the old redisplay did
2882 bool enabled_before_p
= m
->rows
[window_to
].enabled_p
;
2883 m
->rows
[window_to
] = old_rows
[window_from
];
2884 m
->rows
[window_to
].enabled_p
= enabled_before_p
;
2886 /* If frame line is empty, window line is empty, too. */
2887 if (!retained_p
[copy_from
[i
]])
2888 m
->rows
[window_to
].enabled_p
= 0;
2890 else if (to_inside_window_p
)
2892 /* A copy between windows. This is an infrequent
2893 case not worth optimizing. */
2894 struct frame
*f
= XFRAME (w
->frame
);
2895 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
2897 struct glyph_matrix
*m2
;
2900 w2
= frame_row_to_window (root
, frame_from
);
2901 /* ttn@surf.glug.org: when enabling menu bar using `emacs
2902 -nw', FROM_FRAME sometimes has no associated window.
2903 This check avoids a segfault if W2 is null. */
2906 m2
= w2
->current_matrix
;
2907 m2_from
= frame_from
- m2
->matrix_y
;
2908 copy_row_except_pointers (m
->rows
+ window_to
,
2909 m2
->rows
+ m2_from
);
2911 /* If frame line is empty, window line is empty, too. */
2912 if (!retained_p
[copy_from
[i
]])
2913 m
->rows
[window_to
].enabled_p
= 0;
2917 else if (from_inside_window_p
)
2921 /* If there was a copy between windows, make sure glyph
2922 pointers are in sync with the frame matrix. */
2924 sync_window_with_frame_matrix_rows (w
);
2926 /* Check that no pointers are lost. */
2930 /* Next window on same level. */
2931 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2938 /* Check that window and frame matrices agree about their
2939 understanding where glyphs of the rows are to find. For each
2940 window in the window tree rooted at W, check that rows in the
2941 matrices of leaf window agree with their frame matrices about
2945 check_window_matrix_pointers (struct window
*w
)
2949 if (!NILP (w
->hchild
))
2950 check_window_matrix_pointers (XWINDOW (w
->hchild
));
2951 else if (!NILP (w
->vchild
))
2952 check_window_matrix_pointers (XWINDOW (w
->vchild
));
2955 struct frame
*f
= XFRAME (w
->frame
);
2956 check_matrix_pointers (w
->desired_matrix
, f
->desired_matrix
);
2957 check_matrix_pointers (w
->current_matrix
, f
->current_matrix
);
2960 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
2965 /* Check that window rows are slices of frame rows. WINDOW_MATRIX is
2966 a window and FRAME_MATRIX is the corresponding frame matrix. For
2967 each row in WINDOW_MATRIX check that it's a slice of the
2968 corresponding frame row. If it isn't, abort. */
2971 check_matrix_pointers (struct glyph_matrix
*window_matrix
,
2972 struct glyph_matrix
*frame_matrix
)
2974 /* Row number in WINDOW_MATRIX. */
2977 /* Row number corresponding to I in FRAME_MATRIX. */
2978 int j
= window_matrix
->matrix_y
;
2980 /* For all rows check that the row in the window matrix is a
2981 slice of the row in the frame matrix. If it isn't we didn't
2982 mirror an operation on the frame matrix correctly. */
2983 while (i
< window_matrix
->nrows
)
2985 if (!glyph_row_slice_p (window_matrix
->rows
+ i
,
2986 frame_matrix
->rows
+ j
))
2992 #endif /* GLYPH_DEBUG */
2996 /**********************************************************************
2997 VPOS and HPOS translations
2998 **********************************************************************/
3002 /* Translate vertical position VPOS which is relative to window W to a
3003 vertical position relative to W's frame. */
3006 window_to_frame_vpos (struct window
*w
, int vpos
)
3008 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3009 eassert (vpos
>= 0 && vpos
<= w
->desired_matrix
->nrows
);
3010 vpos
+= WINDOW_TOP_EDGE_LINE (w
);
3011 eassert (vpos
>= 0 && vpos
<= FRAME_LINES (XFRAME (w
->frame
)));
3016 /* Translate horizontal position HPOS which is relative to window W to
3017 a horizontal position relative to W's frame. */
3020 window_to_frame_hpos (struct window
*w
, int hpos
)
3022 eassert (!FRAME_WINDOW_P (XFRAME (w
->frame
)));
3023 hpos
+= WINDOW_LEFT_EDGE_COL (w
);
3027 #endif /* GLYPH_DEBUG */
3031 /**********************************************************************
3033 **********************************************************************/
3035 /* Redraw frame F. */
3038 redraw_frame (struct frame
*f
)
3040 /* Error if F has no glyphs. */
3041 eassert (f
->glyphs_initialized_p
);
3044 if (FRAME_MSDOS_P (f
))
3045 FRAME_TERMINAL (f
)->set_terminal_modes_hook (FRAME_TERMINAL (f
));
3048 clear_current_matrices (f
);
3050 if (FRAME_TERMCAP_P (f
))
3051 fflush (FRAME_TTY (f
)->output
);
3052 windows_or_buffers_changed
++;
3053 /* Mark all windows as inaccurate, so that every window will have
3054 its redisplay done. */
3055 mark_window_display_accurate (FRAME_ROOT_WINDOW (f
), 0);
3056 set_window_update_flags (XWINDOW (FRAME_ROOT_WINDOW (f
)), 1);
3060 DEFUN ("redraw-frame", Fredraw_frame
, Sredraw_frame
, 0, 1, 0,
3061 doc
: /* Clear frame FRAME and output again what is supposed to appear on it.
3062 If FRAME is omitted or nil, the selected frame is used. */)
3065 redraw_frame (decode_live_frame (frame
));
3069 DEFUN ("redraw-display", Fredraw_display
, Sredraw_display
, 0, 0, "",
3070 doc
: /* Clear and redisplay all visible frames. */)
3073 Lisp_Object tail
, frame
;
3075 FOR_EACH_FRAME (tail
, frame
)
3076 if (FRAME_VISIBLE_P (XFRAME (frame
)))
3077 redraw_frame (XFRAME (frame
));
3084 /***********************************************************************
3086 ***********************************************************************/
3088 /* Update frame F based on the data in desired matrices.
3090 If FORCE_P, don't let redisplay be stopped by detecting pending input.
3091 If INHIBIT_HAIRY_ID_P, don't try scrolling.
3093 Value is true if redisplay was stopped due to pending input. */
3096 update_frame (struct frame
*f
, bool force_p
, bool inhibit_hairy_id_p
)
3098 /* True means display has been paused because of pending input. */
3100 struct window
*root_window
= XWINDOW (f
->root_window
);
3102 if (redisplay_dont_pause
)
3104 else if (NILP (Vredisplay_preemption_period
))
3106 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3108 double p
= XFLOATINT (Vredisplay_preemption_period
);
3110 if (detect_input_pending_ignore_squeezables ())
3116 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3117 preemption_next_check
= add_emacs_time (current_emacs_time (),
3121 if (FRAME_WINDOW_P (f
))
3123 /* We are working on window matrix basis. All windows whose
3124 flag must_be_updated_p is set have to be updated. */
3126 /* Record that we are not working on frame matrices. */
3127 set_frame_matrix_frame (NULL
);
3129 /* Update all windows in the window tree of F, maybe stopping
3130 when pending input is detected. */
3133 /* Update the menu bar on X frames that don't have toolkit
3135 if (WINDOWP (f
->menu_bar_window
))
3136 update_window (XWINDOW (f
->menu_bar_window
), 1);
3138 /* Update the tool-bar window, if present. */
3139 if (WINDOWP (f
->tool_bar_window
))
3141 struct window
*w
= XWINDOW (f
->tool_bar_window
);
3143 /* Update tool-bar window. */
3144 if (w
->must_be_updated_p
)
3148 update_window (w
, 1);
3149 w
->must_be_updated_p
= 0;
3151 /* Swap tool-bar strings. We swap because we want to
3153 tem
= f
->current_tool_bar_string
;
3154 fset_current_tool_bar_string (f
, f
->desired_tool_bar_string
);
3155 fset_desired_tool_bar_string (f
, tem
);
3160 /* Update windows. */
3161 paused_p
= update_window_tree (root_window
, force_p
);
3164 /* This flush is a performance bottleneck under X,
3165 and it doesn't seem to be necessary anyway (in general).
3166 It is necessary when resizing the window with the mouse, or
3167 at least the fringes are not redrawn in a timely manner. ++kfs */
3168 if (f
->force_flush_display_p
)
3170 FRAME_RIF (f
)->flush_display (f
);
3171 f
->force_flush_display_p
= 0;
3176 /* We are working on frame matrix basis. Set the frame on whose
3177 frame matrix we operate. */
3178 set_frame_matrix_frame (f
);
3180 /* Build F's desired matrix from window matrices. */
3181 build_frame_matrix (f
);
3183 /* Update the display */
3185 paused_p
= update_frame_1 (f
, force_p
, inhibit_hairy_id_p
);
3188 if (FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
3190 if (FRAME_TTY (f
)->termscript
)
3191 fflush (FRAME_TTY (f
)->termscript
);
3192 if (FRAME_TERMCAP_P (f
))
3193 fflush (FRAME_TTY (f
)->output
);
3196 /* Check window matrices for lost pointers. */
3198 check_window_matrix_pointers (root_window
);
3199 add_frame_display_history (f
, paused_p
);
3204 /* Reset flags indicating that a window should be updated. */
3205 set_window_update_flags (root_window
, 0);
3207 display_completed
= !paused_p
;
3213 /************************************************************************
3214 Window-based updates
3215 ************************************************************************/
3217 /* Perform updates in window tree rooted at W.
3218 If FORCE_P, don't stop updating if input is pending. */
3221 update_window_tree (struct window
*w
, bool force_p
)
3225 while (w
&& !paused_p
)
3227 if (!NILP (w
->hchild
))
3228 paused_p
|= update_window_tree (XWINDOW (w
->hchild
), force_p
);
3229 else if (!NILP (w
->vchild
))
3230 paused_p
|= update_window_tree (XWINDOW (w
->vchild
), force_p
);
3231 else if (w
->must_be_updated_p
)
3232 paused_p
|= update_window (w
, force_p
);
3234 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
3241 /* Update window W if its flag must_be_updated_p is set.
3242 If FORCE_P, don't stop updating if input is pending. */
3245 update_single_window (struct window
*w
, bool force_p
)
3247 if (w
->must_be_updated_p
)
3249 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3251 /* Record that this is not a frame-based redisplay. */
3252 set_frame_matrix_frame (NULL
);
3254 if (redisplay_dont_pause
)
3256 else if (NILP (Vredisplay_preemption_period
))
3258 else if (!force_p
&& NUMBERP (Vredisplay_preemption_period
))
3260 double p
= XFLOATINT (Vredisplay_preemption_period
);
3261 preemption_period
= EMACS_TIME_FROM_DOUBLE (p
);
3262 preemption_next_check
= add_emacs_time (current_emacs_time (),
3268 update_window (w
, force_p
);
3271 /* Reset flag in W. */
3272 w
->must_be_updated_p
= 0;
3276 #ifdef HAVE_WINDOW_SYSTEM
3278 /* Redraw lines from the current matrix of window W that are
3279 overlapped by other rows. YB is bottom-most y-position in W. */
3282 redraw_overlapped_rows (struct window
*w
, int yb
)
3285 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
3287 /* If rows overlapping others have been changed, the rows being
3288 overlapped have to be redrawn. This won't draw lines that have
3289 already been drawn in update_window_line because overlapped_p in
3290 desired rows is 0, so after row assignment overlapped_p in
3291 current rows is 0. */
3292 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3294 struct glyph_row
*row
= w
->current_matrix
->rows
+ i
;
3296 if (!row
->enabled_p
)
3298 else if (row
->mode_line_p
)
3301 if (row
->overlapped_p
)
3303 enum glyph_row_area area
;
3305 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
3308 updated_area
= area
;
3309 FRAME_RIF (f
)->cursor_to (i
, 0, row
->y
,
3310 area
== TEXT_AREA
? row
->x
: 0);
3311 if (row
->used
[area
])
3312 FRAME_RIF (f
)->write_glyphs (row
->glyphs
[area
],
3314 FRAME_RIF (f
)->clear_end_of_line (-1);
3317 row
->overlapped_p
= 0;
3320 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3326 /* Redraw lines from the current matrix of window W that overlap
3327 others. YB is bottom-most y-position in W. */
3330 redraw_overlapping_rows (struct window
*w
, int yb
)
3333 struct glyph_row
*row
;
3334 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3336 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
3338 row
= w
->current_matrix
->rows
+ i
;
3340 if (!row
->enabled_p
)
3342 else if (row
->mode_line_p
)
3345 bottom_y
= MATRIX_ROW_BOTTOM_Y (row
);
3347 if (row
->overlapping_p
)
3351 if (MATRIX_ROW_OVERLAPS_PRED_P (row
) && i
> 0
3352 && !MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
)
3353 overlaps
|= OVERLAPS_PRED
;
3354 if (MATRIX_ROW_OVERLAPS_SUCC_P (row
) && bottom_y
< yb
3355 && !MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
)
3356 overlaps
|= OVERLAPS_SUCC
;
3360 if (row
->used
[LEFT_MARGIN_AREA
])
3361 rif
->fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, overlaps
);
3363 if (row
->used
[TEXT_AREA
])
3364 rif
->fix_overlapping_area (w
, row
, TEXT_AREA
, overlaps
);
3366 if (row
->used
[RIGHT_MARGIN_AREA
])
3367 rif
->fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, overlaps
);
3369 /* Record in neighbor rows that ROW overwrites part of
3371 if (overlaps
& OVERLAPS_PRED
)
3372 MATRIX_ROW (w
->current_matrix
, i
- 1)->overlapped_p
= 1;
3373 if (overlaps
& OVERLAPS_SUCC
)
3374 MATRIX_ROW (w
->current_matrix
, i
+ 1)->overlapped_p
= 1;
3383 #endif /* HAVE_WINDOW_SYSTEM */
3386 #if defined GLYPH_DEBUG && 0
3388 /* Check that no row in the current matrix of window W is enabled
3389 which is below what's displayed in the window. */
3392 check_current_matrix_flags (struct window
*w
)
3394 bool last_seen_p
= 0;
3395 int i
, yb
= window_text_bottom_y (w
);
3397 for (i
= 0; i
< w
->current_matrix
->nrows
- 1; ++i
)
3399 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, i
);
3400 if (!last_seen_p
&& MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3402 else if (last_seen_p
&& row
->enabled_p
)
3407 #endif /* GLYPH_DEBUG */
3410 /* Update display of window W.
3411 If FORCE_P, don't stop updating when input is pending. */
3414 update_window (struct window
*w
, bool force_p
)
3416 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
3418 #if !PERIODIC_PREEMPTION_CHECKING
3419 int preempt_count
= baud_rate
/ 2400 + 1;
3421 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3423 /* Check that W's frame doesn't have glyph matrices. */
3424 eassert (FRAME_WINDOW_P (XFRAME (WINDOW_FRAME (w
))));
3427 /* Check pending input the first time so that we can quickly return. */
3428 #if !PERIODIC_PREEMPTION_CHECKING
3430 detect_input_pending_ignore_squeezables ();
3433 /* If forced to complete the update, or if no input is pending, do
3435 if (force_p
|| !input_pending
|| !NILP (do_mouse_tracking
))
3437 struct glyph_row
*row
, *end
;
3438 struct glyph_row
*mode_line_row
;
3439 struct glyph_row
*header_line_row
;
3441 bool changed_p
= 0, mouse_face_overwritten_p
= 0;
3442 #if ! PERIODIC_PREEMPTION_CHECKING
3446 rif
->update_window_begin_hook (w
);
3447 yb
= window_text_bottom_y (w
);
3448 row
= desired_matrix
->rows
;
3449 end
= row
+ desired_matrix
->nrows
- 1;
3451 /* Take note of the header line, if there is one. We will
3452 update it below, after updating all of the window's lines. */
3453 if (row
->mode_line_p
)
3455 header_line_row
= row
;
3459 header_line_row
= NULL
;
3461 /* Update the mode line, if necessary. */
3462 mode_line_row
= MATRIX_MODE_LINE_ROW (desired_matrix
);
3463 if (mode_line_row
->mode_line_p
&& mode_line_row
->enabled_p
)
3465 mode_line_row
->y
= yb
;
3466 update_window_line (w
, MATRIX_ROW_VPOS (mode_line_row
,
3468 &mouse_face_overwritten_p
);
3471 /* Find first enabled row. Optimizations in redisplay_internal
3472 may lead to an update with only one row enabled. There may
3473 be also completely empty matrices. */
3474 while (row
< end
&& !row
->enabled_p
)
3477 /* Try reusing part of the display by copying. */
3478 if (row
< end
&& !desired_matrix
->no_scrolling_p
)
3480 int rc
= scrolling_window (w
, header_line_row
!= NULL
);
3483 /* All rows were found to be equal. */
3489 /* We've scrolled the display. */
3495 /* Update the rest of the lines. */
3496 for (; row
< end
&& (force_p
|| !input_pending
); ++row
)
3497 /* scrolling_window resets the enabled_p flag of the rows it
3498 reuses from current_matrix. */
3501 int vpos
= MATRIX_ROW_VPOS (row
, desired_matrix
);
3504 /* We'll have to play a little bit with when to
3505 detect_input_pending. If it's done too often,
3506 scrolling large windows with repeated scroll-up
3507 commands will too quickly pause redisplay. */
3508 #if PERIODIC_PREEMPTION_CHECKING
3511 EMACS_TIME tm
= current_emacs_time ();
3512 if (EMACS_TIME_LT (preemption_next_check
, tm
))
3514 preemption_next_check
= add_emacs_time (tm
,
3516 if (detect_input_pending_ignore_squeezables ())
3521 if (!force_p
&& ++n_updated
% preempt_count
== 0)
3522 detect_input_pending_ignore_squeezables ();
3524 changed_p
|= update_window_line (w
, vpos
,
3525 &mouse_face_overwritten_p
);
3527 /* Mark all rows below the last visible one in the current
3528 matrix as invalid. This is necessary because of
3529 variable line heights. Consider the case of three
3530 successive redisplays, where the first displays 5
3531 lines, the second 3 lines, and the third 5 lines again.
3532 If the second redisplay wouldn't mark rows in the
3533 current matrix invalid, the third redisplay might be
3534 tempted to optimize redisplay based on lines displayed
3535 in the first redisplay. */
3536 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
3537 for (i
= vpos
+ 1; i
< w
->current_matrix
->nrows
- 1; ++i
)
3538 MATRIX_ROW (w
->current_matrix
, i
)->enabled_p
= 0;
3541 /* Was display preempted? */
3542 paused_p
= row
< end
;
3546 /* Update the header line after scrolling because a new header
3547 line would otherwise overwrite lines at the top of the window
3548 that can be scrolled. */
3549 if (header_line_row
&& header_line_row
->enabled_p
)
3551 header_line_row
->y
= 0;
3552 update_window_line (w
, 0, &mouse_face_overwritten_p
);
3555 /* Fix the appearance of overlapping/overlapped rows. */
3556 if (!paused_p
&& !w
->pseudo_window_p
)
3558 #ifdef HAVE_WINDOW_SYSTEM
3559 if (changed_p
&& rif
->fix_overlapping_area
)
3561 redraw_overlapped_rows (w
, yb
);
3562 redraw_overlapping_rows (w
, yb
);
3566 /* Make cursor visible at cursor position of W. */
3567 set_window_cursor_after_update (w
);
3569 #if 0 /* Check that current matrix invariants are satisfied. This is
3570 for debugging only. See the comment of check_matrix_invariants. */
3571 IF_DEBUG (check_matrix_invariants (w
));
3576 /* Remember the redisplay method used to display the matrix. */
3577 strcpy (w
->current_matrix
->method
, w
->desired_matrix
->method
);
3580 #ifdef HAVE_WINDOW_SYSTEM
3581 update_window_fringes (w
, 0);
3584 /* End the update of window W. Don't set the cursor if we
3585 paused updating the display because in this case,
3586 set_window_cursor_after_update hasn't been called, and
3587 output_cursor doesn't contain the cursor location. */
3588 rif
->update_window_end_hook (w
, !paused_p
, mouse_face_overwritten_p
);
3594 /* check_current_matrix_flags (w); */
3595 add_window_display_history (w
, w
->current_matrix
->method
, paused_p
);
3598 #ifdef HAVE_XWIDGETS
3599 xwidget_end_redisplay(w
, w
->current_matrix
);
3601 clear_glyph_matrix (desired_matrix
);
3607 /* Update the display of area AREA in window W, row number VPOS.
3608 AREA can be either LEFT_MARGIN_AREA or RIGHT_MARGIN_AREA. */
3611 update_marginal_area (struct window
*w
, int area
, int vpos
)
3613 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3614 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3616 /* Let functions in xterm.c know what area subsequent X positions
3617 will be relative to. */
3618 updated_area
= area
;
3620 /* Set cursor to start of glyphs, write them, and clear to the end
3621 of the area. I don't think that something more sophisticated is
3622 necessary here, since marginal areas will not be the default. */
3623 rif
->cursor_to (vpos
, 0, desired_row
->y
, 0);
3624 if (desired_row
->used
[area
])
3625 rif
->write_glyphs (desired_row
->glyphs
[area
], desired_row
->used
[area
]);
3626 rif
->clear_end_of_line (-1);
3630 /* Update the display of the text area of row VPOS in window W.
3631 Value is true if display has changed. */
3634 update_text_area (struct window
*w
, int vpos
)
3636 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3637 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3638 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3641 /* Let functions in xterm.c know what area subsequent X positions
3642 will be relative to. */
3643 updated_area
= TEXT_AREA
;
3645 /* If rows are at different X or Y, or rows have different height,
3646 or the current row is marked invalid, write the entire line. */
3647 if (!current_row
->enabled_p
3648 || desired_row
->y
!= current_row
->y
3649 || desired_row
->ascent
!= current_row
->ascent
3650 || desired_row
->phys_ascent
!= current_row
->phys_ascent
3651 || desired_row
->phys_height
!= current_row
->phys_height
3652 || desired_row
->visible_height
!= current_row
->visible_height
3653 || current_row
->overlapped_p
3654 /* This next line is necessary for correctly redrawing
3655 mouse-face areas after scrolling and other operations.
3656 However, it causes excessive flickering when mouse is moved
3657 across the mode line. Luckily, turning it off for the mode
3658 line doesn't seem to hurt anything. -- cyd.
3659 But it is still needed for the header line. -- kfs. */
3660 || (current_row
->mouse_face_p
3661 && !(current_row
->mode_line_p
&& vpos
> 0))
3662 || current_row
->x
!= desired_row
->x
)
3664 rif
->cursor_to (vpos
, 0, desired_row
->y
, desired_row
->x
);
3666 if (desired_row
->used
[TEXT_AREA
])
3667 rif
->write_glyphs (desired_row
->glyphs
[TEXT_AREA
],
3668 desired_row
->used
[TEXT_AREA
]);
3670 /* Clear to end of window. */
3671 rif
->clear_end_of_line (-1);
3674 /* This erases the cursor. We do this here because
3675 notice_overwritten_cursor cannot easily check this, which
3676 might indicate that the whole functionality of
3677 notice_overwritten_cursor would better be implemented here.
3678 On the other hand, we need notice_overwritten_cursor as long
3679 as mouse highlighting is done asynchronously outside of
3681 if (vpos
== w
->phys_cursor
.vpos
)
3682 w
->phys_cursor_on_p
= 0;
3687 struct glyph
*current_glyph
= current_row
->glyphs
[TEXT_AREA
];
3688 struct glyph
*desired_glyph
= desired_row
->glyphs
[TEXT_AREA
];
3689 bool overlapping_glyphs_p
= current_row
->contains_overlapping_glyphs_p
;
3690 int desired_stop_pos
= desired_row
->used
[TEXT_AREA
];
3691 bool abort_skipping
= 0;
3693 /* If the desired row extends its face to the text area end, and
3694 unless the current row also does so at the same position,
3695 make sure we write at least one glyph, so that the face
3696 extension actually takes place. */
3697 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
)
3698 && (desired_stop_pos
< current_row
->used
[TEXT_AREA
]
3699 || (desired_stop_pos
== current_row
->used
[TEXT_AREA
]
3700 && !MATRIX_ROW_EXTENDS_FACE_P (current_row
))))
3703 stop
= min (current_row
->used
[TEXT_AREA
], desired_stop_pos
);
3707 /* Loop over glyphs that current and desired row may have
3711 bool can_skip_p
= !abort_skipping
;
3713 /* Skip over glyphs that both rows have in common. These
3714 don't have to be written. We can't skip if the last
3715 current glyph overlaps the glyph to its right. For
3716 example, consider a current row of `if ' with the `f' in
3717 Courier bold so that it overlaps the ` ' to its right.
3718 If the desired row is ` ', we would skip over the space
3719 after the `if' and there would remain a pixel from the
3720 `f' on the screen. */
3721 if (overlapping_glyphs_p
&& i
> 0)
3723 struct glyph
*glyph
= ¤t_row
->glyphs
[TEXT_AREA
][i
- 1];
3726 rif
->get_glyph_overhangs (glyph
, XFRAME (w
->frame
),
3728 can_skip_p
= (right
== 0 && !abort_skipping
);
3736 && GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3738 x
+= desired_glyph
->pixel_width
;
3739 ++desired_glyph
, ++current_glyph
, ++i
;
3742 /* Consider the case that the current row contains "xxx
3743 ppp ggg" in italic Courier font, and the desired row
3744 is "xxx ggg". The character `p' has lbearing, `g'
3745 has not. The loop above will stop in front of the
3746 first `p' in the current row. If we would start
3747 writing glyphs there, we wouldn't erase the lbearing
3748 of the `p'. The rest of the lbearing problem is then
3749 taken care of by draw_glyphs. */
3750 if (overlapping_glyphs_p
3752 && i
< current_row
->used
[TEXT_AREA
]
3753 && (current_row
->used
[TEXT_AREA
]
3754 != desired_row
->used
[TEXT_AREA
]))
3758 rif
->get_glyph_overhangs (current_glyph
,
3761 while (left
> 0 && i
> 0)
3763 --i
, --desired_glyph
, --current_glyph
;
3764 x
-= desired_glyph
->pixel_width
;
3765 left
-= desired_glyph
->pixel_width
;
3768 /* Abort the skipping algorithm if we end up before
3769 our starting point, to avoid looping (bug#1070).
3770 This can happen when the lbearing is larger than
3772 abort_skipping
= (i
< start_hpos
);
3776 /* Try to avoid writing the entire rest of the desired row
3777 by looking for a resync point. This mainly prevents
3778 mode line flickering in the case the mode line is in
3779 fixed-pitch font, which it usually will be. */
3780 if (i
< desired_row
->used
[TEXT_AREA
])
3782 int start_x
= x
, start_hpos
= i
;
3783 struct glyph
*start
= desired_glyph
;
3785 bool skip_first_p
= !can_skip_p
;
3787 /* Find the next glyph that's equal again. */
3790 || !GLYPH_EQUAL_P (desired_glyph
, current_glyph
))
3793 x
+= desired_glyph
->pixel_width
;
3794 current_x
+= current_glyph
->pixel_width
;
3795 ++desired_glyph
, ++current_glyph
, ++i
;
3799 if (i
== start_hpos
|| x
!= current_x
)
3803 desired_glyph
= start
;
3807 rif
->cursor_to (vpos
, start_hpos
, desired_row
->y
, start_x
);
3808 rif
->write_glyphs (start
, i
- start_hpos
);
3813 /* Write the rest. */
3814 if (i
< desired_row
->used
[TEXT_AREA
])
3816 rif
->cursor_to (vpos
, i
, desired_row
->y
, x
);
3817 rif
->write_glyphs (desired_glyph
, desired_row
->used
[TEXT_AREA
] - i
);
3821 /* Maybe clear to end of line. */
3822 if (MATRIX_ROW_EXTENDS_FACE_P (desired_row
))
3824 /* If new row extends to the end of the text area, nothing
3825 has to be cleared, if and only if we did a write_glyphs
3826 above. This is made sure by setting desired_stop_pos
3827 appropriately above. */
3828 eassert (i
< desired_row
->used
[TEXT_AREA
]
3829 || ((desired_row
->used
[TEXT_AREA
]
3830 == current_row
->used
[TEXT_AREA
])
3831 && MATRIX_ROW_EXTENDS_FACE_P (current_row
)));
3833 else if (MATRIX_ROW_EXTENDS_FACE_P (current_row
))
3835 /* If old row extends to the end of the text area, clear. */
3836 if (i
>= desired_row
->used
[TEXT_AREA
])
3837 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3838 desired_row
->pixel_width
);
3839 rif
->clear_end_of_line (-1);
3842 else if (desired_row
->pixel_width
< current_row
->pixel_width
)
3844 /* Otherwise clear to the end of the old row. Everything
3845 after that position should be clear already. */
3848 if (i
>= desired_row
->used
[TEXT_AREA
])
3849 rif
->cursor_to (vpos
, i
, desired_row
->y
,
3850 desired_row
->pixel_width
);
3852 /* If cursor is displayed at the end of the line, make sure
3853 it's cleared. Nowadays we don't have a phys_cursor_glyph
3854 with which to erase the cursor (because this method
3855 doesn't work with lbearing/rbearing), so we must do it
3857 if (vpos
== w
->phys_cursor
.vpos
3858 && (desired_row
->reversed_p
3859 ? (w
->phys_cursor
.hpos
< 0)
3860 : (w
->phys_cursor
.hpos
>= desired_row
->used
[TEXT_AREA
])))
3862 w
->phys_cursor_on_p
= 0;
3866 xlim
= current_row
->pixel_width
;
3867 rif
->clear_end_of_line (xlim
);
3876 /* Update row VPOS in window W. Value is true if display has been changed. */
3879 update_window_line (struct window
*w
, int vpos
, bool *mouse_face_overwritten_p
)
3881 struct glyph_row
*current_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
3882 struct glyph_row
*desired_row
= MATRIX_ROW (w
->desired_matrix
, vpos
);
3883 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
3886 /* Set the row being updated. This is important to let xterm.c
3887 know what line height values are in effect. */
3888 updated_row
= desired_row
;
3890 /* A row can be completely invisible in case a desired matrix was
3891 built with a vscroll and then make_cursor_line_fully_visible shifts
3892 the matrix. Make sure to make such rows current anyway, since
3893 we need the correct y-position, for example, in the current matrix. */
3894 if (desired_row
->mode_line_p
3895 || desired_row
->visible_height
> 0)
3897 eassert (desired_row
->enabled_p
);
3899 /* Update display of the left margin area, if there is one. */
3900 if (!desired_row
->full_width_p
3901 && !NILP (w
->left_margin_cols
))
3904 update_marginal_area (w
, LEFT_MARGIN_AREA
, vpos
);
3905 /* Setting this flag will ensure the vertical border, if
3906 any, between this window and the one on its left will be
3907 redrawn. This is necessary because updating the left
3908 margin area can potentially draw over the border. */
3909 current_row
->redraw_fringe_bitmaps_p
= 1;
3912 /* Update the display of the text area. */
3913 if (update_text_area (w
, vpos
))
3916 if (current_row
->mouse_face_p
)
3917 *mouse_face_overwritten_p
= 1;
3920 /* Update display of the right margin area, if there is one. */
3921 if (!desired_row
->full_width_p
3922 && !NILP (w
->right_margin_cols
))
3925 update_marginal_area (w
, RIGHT_MARGIN_AREA
, vpos
);
3928 /* Draw truncation marks etc. */
3929 if (!current_row
->enabled_p
3930 || desired_row
->y
!= current_row
->y
3931 || desired_row
->visible_height
!= current_row
->visible_height
3932 || desired_row
->cursor_in_fringe_p
!= current_row
->cursor_in_fringe_p
3933 || desired_row
->overlay_arrow_bitmap
!= current_row
->overlay_arrow_bitmap
3934 || current_row
->redraw_fringe_bitmaps_p
3935 || desired_row
->mode_line_p
!= current_row
->mode_line_p
3936 || desired_row
->exact_window_width_line_p
!= current_row
->exact_window_width_line_p
3937 || (MATRIX_ROW_CONTINUATION_LINE_P (desired_row
)
3938 != MATRIX_ROW_CONTINUATION_LINE_P (current_row
)))
3939 rif
->after_update_window_line_hook (desired_row
);
3942 /* Update current_row from desired_row. */
3943 make_current (w
->desired_matrix
, w
->current_matrix
, vpos
);
3949 /* Set the cursor after an update of window W. This function may only
3950 be called from update_window. */
3953 set_window_cursor_after_update (struct window
*w
)
3955 struct frame
*f
= XFRAME (w
->frame
);
3956 struct redisplay_interface
*rif
= FRAME_RIF (f
);
3957 int cx
, cy
, vpos
, hpos
;
3959 /* Not intended for frame matrix updates. */
3960 eassert (FRAME_WINDOW_P (f
));
3962 if (cursor_in_echo_area
3963 && !NILP (echo_area_buffer
[0])
3964 /* If we are showing a message instead of the mini-buffer,
3965 show the cursor for the message instead. */
3966 && XWINDOW (minibuf_window
) == w
3967 && EQ (minibuf_window
, echo_area_window
)
3968 /* These cases apply only to the frame that contains
3969 the active mini-buffer window. */
3970 && FRAME_HAS_MINIBUF_P (f
)
3971 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
3973 cx
= cy
= vpos
= hpos
= 0;
3975 if (cursor_in_echo_area
>= 0)
3977 /* If the mini-buffer is several lines high, find the last
3978 line that has any text on it. Note: either all lines
3979 are enabled or none. Otherwise we wouldn't be able to
3981 struct glyph_row
*row
, *last_row
;
3982 struct glyph
*glyph
;
3983 int yb
= window_text_bottom_y (w
);
3986 row
= w
->current_matrix
->rows
;
3987 while (row
->enabled_p
3988 && (last_row
== NULL
3989 || MATRIX_ROW_BOTTOM_Y (row
) <= yb
))
3991 if (row
->used
[TEXT_AREA
]
3992 && row
->glyphs
[TEXT_AREA
][0].charpos
>= 0)
3999 struct glyph
*start
= last_row
->glyphs
[TEXT_AREA
];
4000 struct glyph
*last
= start
+ last_row
->used
[TEXT_AREA
] - 1;
4002 while (last
> start
&& last
->charpos
< 0)
4005 for (glyph
= start
; glyph
< last
; ++glyph
)
4007 cx
+= glyph
->pixel_width
;
4012 vpos
= MATRIX_ROW_VPOS (last_row
, w
->current_matrix
);
4020 hpos
= w
->cursor
.hpos
;
4021 vpos
= w
->cursor
.vpos
;
4024 /* Window cursor can be out of sync for horizontally split windows.
4025 Horisontal position is -1 when cursor is on the left fringe. */
4026 hpos
= clip_to_bounds (-1, hpos
, w
->current_matrix
->matrix_w
- 1);
4027 vpos
= clip_to_bounds (0, vpos
, w
->current_matrix
->nrows
- 1);
4028 rif
->cursor_to (vpos
, hpos
, cy
, cx
);
4032 /* Set WINDOW->must_be_updated_p to ON_P for all windows in the window
4033 tree rooted at W. */
4036 set_window_update_flags (struct window
*w
, bool on_p
)
4040 if (!NILP (w
->hchild
))
4041 set_window_update_flags (XWINDOW (w
->hchild
), on_p
);
4042 else if (!NILP (w
->vchild
))
4043 set_window_update_flags (XWINDOW (w
->vchild
), on_p
);
4045 w
->must_be_updated_p
= on_p
;
4047 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
4053 /***********************************************************************
4054 Window-Based Scrolling
4055 ***********************************************************************/
4057 /* Structure describing rows in scrolling_window. */
4061 /* Number of occurrences of this row in desired and current matrix. */
4062 int old_uses
, new_uses
;
4064 /* Vpos of row in new matrix. */
4065 int new_line_number
;
4067 /* Bucket index of this row_entry in the hash table row_table. */
4070 /* The row described by this entry. */
4071 struct glyph_row
*row
;
4073 /* Hash collision chain. */
4074 struct row_entry
*next
;
4077 /* A pool to allocate row_entry structures from, and the size of the
4078 pool. The pool is reallocated in scrolling_window when we find
4079 that we need a larger one. */
4081 static struct row_entry
*row_entry_pool
;
4082 static ptrdiff_t row_entry_pool_size
;
4084 /* Index of next free entry in row_entry_pool. */
4086 static ptrdiff_t row_entry_idx
;
4088 /* The hash table used during scrolling, and the table's size. This
4089 table is used to quickly identify equal rows in the desired and
4092 static struct row_entry
**row_table
;
4093 static ptrdiff_t row_table_size
;
4095 /* Vectors of pointers to row_entry structures belonging to the
4096 current and desired matrix, and the size of the vectors. */
4098 static struct row_entry
**old_lines
, **new_lines
;
4099 static ptrdiff_t old_lines_size
, new_lines_size
;
4101 /* A pool to allocate run structures from, and its size. */
4103 static struct run
*run_pool
;
4104 static ptrdiff_t runs_size
;
4106 /* A vector of runs of lines found during scrolling. */
4108 static struct run
**runs
;
4110 /* Add glyph row ROW to the scrolling hash table. */
4112 static struct row_entry
*
4113 add_row_entry (struct glyph_row
*row
)
4115 struct row_entry
*entry
;
4116 ptrdiff_t i
= row
->hash
% row_table_size
;
4118 entry
= row_table
[i
];
4119 eassert (entry
|| verify_row_hash (row
));
4120 while (entry
&& !row_equal_p (entry
->row
, row
, 1))
4121 entry
= entry
->next
;
4125 entry
= row_entry_pool
+ row_entry_idx
++;
4127 entry
->old_uses
= entry
->new_uses
= 0;
4128 entry
->new_line_number
= 0;
4130 entry
->next
= row_table
[i
];
4131 row_table
[i
] = entry
;
4138 /* Try to reuse part of the current display of W by scrolling lines.
4139 HEADER_LINE_P means W has a header line.
4141 The algorithm is taken from Communications of the ACM, Apr78 "A
4142 Technique for Isolating Differences Between Files." It should take
4145 A short outline of the steps of the algorithm
4147 1. Skip lines equal at the start and end of both matrices.
4149 2. Enter rows in the current and desired matrix into a symbol
4150 table, counting how often they appear in both matrices.
4152 3. Rows that appear exactly once in both matrices serve as anchors,
4153 i.e. we assume that such lines are likely to have been moved.
4155 4. Starting from anchor lines, extend regions to be scrolled both
4156 forward and backward.
4160 -1 if all rows were found to be equal.
4161 0 to indicate that we did not scroll the display, or
4162 1 if we did scroll. */
4165 scrolling_window (struct window
*w
, bool header_line_p
)
4167 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
4168 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
4169 int yb
= window_text_bottom_y (w
);
4171 int j
, first_old
, first_new
, last_old
, last_new
;
4174 struct row_entry
*entry
;
4175 struct redisplay_interface
*rif
= FRAME_RIF (XFRAME (WINDOW_FRAME (w
)));
4177 /* Skip over rows equal at the start. */
4178 for (i
= header_line_p
; i
< current_matrix
->nrows
- 1; ++i
)
4180 struct glyph_row
*d
= MATRIX_ROW (desired_matrix
, i
);
4181 struct glyph_row
*c
= MATRIX_ROW (current_matrix
, i
);
4185 && !d
->redraw_fringe_bitmaps_p
4187 && MATRIX_ROW_BOTTOM_Y (c
) <= yb
4188 && MATRIX_ROW_BOTTOM_Y (d
) <= yb
4189 && row_equal_p (c
, d
, 1))
4198 #ifdef HAVE_XWIDGETS
4199 //currently this is needed to detect xwidget movement reliably. or probably not.
4200 //printf("scrolling_window\n");
4204 /* Give up if some rows in the desired matrix are not enabled. */
4205 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4208 first_old
= first_new
= i
;
4210 /* Set last_new to the index + 1 of the row that reaches the
4211 bottom boundary in the desired matrix. Give up if we find a
4212 disabled row before we reach the bottom boundary. */
4214 while (i
< desired_matrix
->nrows
- 1)
4218 if (!MATRIX_ROW (desired_matrix
, i
)->enabled_p
)
4220 bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (desired_matrix
, i
));
4229 /* Set last_old to the index + 1 of the row that reaches the bottom
4230 boundary in the current matrix. We don't look at the enabled
4231 flag here because we plan to reuse part of the display even if
4232 other parts are disabled. */
4234 while (i
< current_matrix
->nrows
- 1)
4236 int bottom
= MATRIX_ROW_BOTTOM_Y (MATRIX_ROW (current_matrix
, i
));
4245 /* Skip over rows equal at the bottom. */
4248 while (i
- 1 > first_new
4249 && j
- 1 > first_old
4250 && MATRIX_ROW (current_matrix
, j
- 1)->enabled_p
4251 && (MATRIX_ROW (current_matrix
, j
- 1)->y
4252 == MATRIX_ROW (desired_matrix
, i
- 1)->y
)
4253 && !MATRIX_ROW (desired_matrix
, i
- 1)->redraw_fringe_bitmaps_p
4254 && row_equal_p (MATRIX_ROW (desired_matrix
, i
- 1),
4255 MATRIX_ROW (current_matrix
, j
- 1), 1))
4260 /* Nothing to do if all rows are equal. */
4261 if (last_new
== first_new
)
4264 /* Check for integer overflow in size calculation.
4266 If next_almost_prime checks (N) for divisibility by 2..10, then
4267 it can return at most N + 10, e.g., next_almost_prime (1) == 11.
4268 So, set next_almost_prime_increment_max to 10.
4270 It's just a coincidence that next_almost_prime_increment_max ==
4271 NEXT_ALMOST_PRIME_LIMIT - 1. If NEXT_ALMOST_PRIME_LIMIT were
4272 13, then next_almost_prime_increment_max would be 14, e.g.,
4273 because next_almost_prime (113) would be 127. */
4275 verify (NEXT_ALMOST_PRIME_LIMIT
== 11);
4276 enum { next_almost_prime_increment_max
= 10 };
4277 ptrdiff_t row_table_max
=
4278 (min (PTRDIFF_MAX
, SIZE_MAX
) / (3 * sizeof *row_table
)
4279 - next_almost_prime_increment_max
);
4280 ptrdiff_t current_nrows_max
= row_table_max
- desired_matrix
->nrows
;
4281 if (current_nrows_max
< current_matrix
->nrows
)
4282 memory_full (SIZE_MAX
);
4285 /* Reallocate vectors, tables etc. if necessary. */
4287 if (current_matrix
->nrows
> old_lines_size
)
4288 old_lines
= xpalloc (old_lines
, &old_lines_size
,
4289 current_matrix
->nrows
- old_lines_size
,
4290 INT_MAX
, sizeof *old_lines
);
4292 if (desired_matrix
->nrows
> new_lines_size
)
4293 new_lines
= xpalloc (new_lines
, &new_lines_size
,
4294 desired_matrix
->nrows
- new_lines_size
,
4295 INT_MAX
, sizeof *new_lines
);
4297 n
= desired_matrix
->nrows
;
4298 n
+= current_matrix
->nrows
;
4299 if (row_table_size
< 3 * n
)
4301 ptrdiff_t size
= next_almost_prime (3 * n
);
4302 row_table
= xnrealloc (row_table
, size
, sizeof *row_table
);
4303 row_table_size
= size
;
4304 memset (row_table
, 0, size
* sizeof *row_table
);
4307 if (n
> row_entry_pool_size
)
4308 row_entry_pool
= xpalloc (row_entry_pool
, &row_entry_pool_size
,
4309 n
- row_entry_pool_size
,
4310 -1, sizeof *row_entry_pool
);
4312 if (desired_matrix
->nrows
> runs_size
)
4314 runs
= xnrealloc (runs
, desired_matrix
->nrows
, sizeof *runs
);
4315 run_pool
= xnrealloc (run_pool
, desired_matrix
->nrows
, sizeof *run_pool
);
4316 runs_size
= desired_matrix
->nrows
;
4319 nruns
= run_idx
= 0;
4322 /* Add rows from the current and desired matrix to the hash table
4323 row_hash_table to be able to find equal ones quickly. */
4325 for (i
= first_old
; i
< last_old
; ++i
)
4327 if (MATRIX_ROW (current_matrix
, i
)->enabled_p
)
4329 entry
= add_row_entry (MATRIX_ROW (current_matrix
, i
));
4330 old_lines
[i
] = entry
;
4334 old_lines
[i
] = NULL
;
4337 for (i
= first_new
; i
< last_new
; ++i
)
4339 eassert (MATRIX_ROW_ENABLED_P (desired_matrix
, i
));
4340 entry
= add_row_entry (MATRIX_ROW (desired_matrix
, i
));
4342 entry
->new_line_number
= i
;
4343 new_lines
[i
] = entry
;
4346 /* Identify moves based on lines that are unique and equal
4347 in both matrices. */
4348 for (i
= first_old
; i
< last_old
;)
4350 && old_lines
[i
]->old_uses
== 1
4351 && old_lines
[i
]->new_uses
== 1)
4354 int new_line
= old_lines
[i
]->new_line_number
;
4355 struct run
*run
= run_pool
+ run_idx
++;
4358 run
->current_vpos
= i
;
4359 run
->current_y
= MATRIX_ROW (current_matrix
, i
)->y
;
4360 run
->desired_vpos
= new_line
;
4361 run
->desired_y
= MATRIX_ROW (desired_matrix
, new_line
)->y
;
4363 run
->height
= MATRIX_ROW (current_matrix
, i
)->height
;
4365 /* Extend backward. */
4368 while (p
> first_old
4370 && old_lines
[p
] == new_lines
[q
])
4372 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4373 --run
->current_vpos
;
4374 --run
->desired_vpos
;
4377 run
->desired_y
-= h
;
4378 run
->current_y
-= h
;
4382 /* Extend forward. */
4387 && old_lines
[p
] == new_lines
[q
])
4389 int h
= MATRIX_ROW (current_matrix
, p
)->height
;
4395 /* Insert run into list of all runs. Order runs by copied
4396 pixel lines. Note that we record runs that don't have to
4397 be copied because they are already in place. This is done
4398 because we can avoid calling update_window_line in this
4400 for (p
= 0; p
< nruns
&& runs
[p
]->height
> run
->height
; ++p
)
4402 for (q
= nruns
; q
> p
; --q
)
4403 runs
[q
] = runs
[q
- 1];
4412 /* Do the moves. Do it in a way that we don't overwrite something
4413 we want to copy later on. This is not solvable in general
4414 because there is only one display and we don't have a way to
4415 exchange areas on this display. Example:
4417 +-----------+ +-----------+
4419 +-----------+ --> +-----------+
4421 +-----------+ +-----------+
4423 Instead, prefer bigger moves, and invalidate moves that would
4424 copy from where we copied to. */
4426 for (i
= 0; i
< nruns
; ++i
)
4427 if (runs
[i
]->nrows
> 0)
4429 struct run
*r
= runs
[i
];
4431 /* Copy on the display. */
4432 if (r
->current_y
!= r
->desired_y
)
4434 rif
->clear_window_mouse_face (w
);
4435 rif
->scroll_run_hook (w
, r
);
4438 /* Truncate runs that copy to where we copied to, and
4439 invalidate runs that copy from where we copied to. */
4440 for (j
= nruns
- 1; j
> i
; --j
)
4442 struct run
*p
= runs
[j
];
4443 bool truncated_p
= 0;
4446 && p
->desired_y
< r
->desired_y
+ r
->height
4447 && p
->desired_y
+ p
->height
> r
->desired_y
)
4449 if (p
->desired_y
< r
->desired_y
)
4451 p
->nrows
= r
->desired_vpos
- p
->desired_vpos
;
4452 p
->height
= r
->desired_y
- p
->desired_y
;
4457 int nrows_copied
= (r
->desired_vpos
+ r
->nrows
4460 if (p
->nrows
<= nrows_copied
)
4464 int height_copied
= (r
->desired_y
+ r
->height
4467 p
->current_vpos
+= nrows_copied
;
4468 p
->desired_vpos
+= nrows_copied
;
4469 p
->nrows
-= nrows_copied
;
4470 p
->current_y
+= height_copied
;
4471 p
->desired_y
+= height_copied
;
4472 p
->height
-= height_copied
;
4478 if (r
->current_y
!= r
->desired_y
4479 /* The condition below is equivalent to
4480 ((p->current_y >= r->desired_y
4481 && p->current_y < r->desired_y + r->height)
4482 || (p->current_y + p->height > r->desired_y
4483 && (p->current_y + p->height
4484 <= r->desired_y + r->height)))
4485 because we have 0 < p->height <= r->height. */
4486 && p
->current_y
< r
->desired_y
+ r
->height
4487 && p
->current_y
+ p
->height
> r
->desired_y
)
4490 /* Reorder runs by copied pixel lines if truncated. */
4491 if (truncated_p
&& p
->nrows
> 0)
4495 while (runs
[k
]->nrows
== 0 || runs
[k
]->height
< p
->height
)
4497 memmove (runs
+ j
, runs
+ j
+ 1, (k
- j
) * sizeof (*runs
));
4502 /* Assign matrix rows. */
4503 for (j
= 0; j
< r
->nrows
; ++j
)
4505 struct glyph_row
*from
, *to
;
4506 bool to_overlapped_p
;
4508 to
= MATRIX_ROW (current_matrix
, r
->desired_vpos
+ j
);
4509 from
= MATRIX_ROW (desired_matrix
, r
->desired_vpos
+ j
);
4510 to_overlapped_p
= to
->overlapped_p
;
4511 from
->redraw_fringe_bitmaps_p
= from
->fringe_bitmap_periodic_p
;
4512 assign_row (to
, from
);
4513 /* The above `assign_row' actually does swap, so if we had
4514 an overlap in the copy destination of two runs, then
4515 the second run would assign a previously disabled bogus
4516 row. But thanks to the truncation code in the
4517 preceding for-loop, we no longer have such an overlap,
4518 and thus the assigned row should always be enabled. */
4519 eassert (to
->enabled_p
);
4520 from
->enabled_p
= 0;
4521 to
->overlapped_p
= to_overlapped_p
;
4525 /* Clear the hash table, for the next time. */
4526 for (i
= 0; i
< row_entry_idx
; ++i
)
4527 row_table
[row_entry_pool
[i
].bucket
] = NULL
;
4529 /* Value is 1 to indicate that we scrolled the display. */
4535 /************************************************************************
4537 ************************************************************************/
4539 /* Update the desired frame matrix of frame F.
4541 FORCE_P means that the update should not be stopped by pending input.
4542 INHIBIT_HAIRY_ID_P means that scrolling should not be tried.
4544 Value is true if update was stopped due to pending input. */
4547 update_frame_1 (struct frame
*f
, bool force_p
, bool inhibit_id_p
)
4549 /* Frame matrices to work on. */
4550 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4551 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4554 int preempt_count
= baud_rate
/ 2400 + 1;
4556 eassert (current_matrix
&& desired_matrix
);
4558 if (baud_rate
!= FRAME_COST_BAUD_RATE (f
))
4559 calculate_costs (f
);
4561 if (preempt_count
<= 0)
4564 #if !PERIODIC_PREEMPTION_CHECKING
4565 if (!force_p
&& detect_input_pending_ignore_squeezables ())
4572 /* If we cannot insert/delete lines, it's no use trying it. */
4573 if (!FRAME_LINE_INS_DEL_OK (f
))
4576 /* See if any of the desired lines are enabled; don't compute for
4577 i/d line if just want cursor motion. */
4578 for (i
= 0; i
< desired_matrix
->nrows
; i
++)
4579 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4582 /* Try doing i/d line, if not yet inhibited. */
4583 if (!inhibit_id_p
&& i
< desired_matrix
->nrows
)
4584 force_p
|= scrolling (f
);
4586 /* Update the individual lines as needed. Do bottom line first. */
4587 if (MATRIX_ROW_ENABLED_P (desired_matrix
, desired_matrix
->nrows
- 1))
4588 update_frame_line (f
, desired_matrix
->nrows
- 1);
4590 /* Now update the rest of the lines. */
4591 for (i
= 0; i
< desired_matrix
->nrows
- 1 && (force_p
|| !input_pending
); i
++)
4593 if (MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4595 if (FRAME_TERMCAP_P (f
))
4597 /* Flush out every so many lines.
4598 Also flush out if likely to have more than 1k buffered
4599 otherwise. I'm told that some telnet connections get
4600 really screwed by more than 1k output at once. */
4601 FILE *display_output
= FRAME_TTY (f
)->output
;
4604 ptrdiff_t outq
= __fpending (display_output
);
4606 || (outq
> 20 && ((i
- 1) % preempt_count
== 0)))
4607 fflush (display_output
);
4611 #if PERIODIC_PREEMPTION_CHECKING
4614 EMACS_TIME tm
= current_emacs_time ();
4615 if (EMACS_TIME_LT (preemption_next_check
, tm
))
4617 preemption_next_check
= add_emacs_time (tm
, preemption_period
);
4618 if (detect_input_pending_ignore_squeezables ())
4623 if (!force_p
&& (i
- 1) % preempt_count
== 0)
4624 detect_input_pending_ignore_squeezables ();
4627 update_frame_line (f
, i
);
4631 lint_assume (0 <= FRAME_LINES (f
));
4632 pause_p
= 0 < i
&& i
< FRAME_LINES (f
) - 1;
4634 /* Now just clean up termcap drivers and set cursor, etc. */
4637 if ((cursor_in_echo_area
4638 /* If we are showing a message instead of the mini-buffer,
4639 show the cursor for the message instead of for the
4640 (now hidden) mini-buffer contents. */
4641 || (EQ (minibuf_window
, selected_window
)
4642 && EQ (minibuf_window
, echo_area_window
)
4643 && !NILP (echo_area_buffer
[0])))
4644 /* These cases apply only to the frame that contains
4645 the active mini-buffer window. */
4646 && FRAME_HAS_MINIBUF_P (f
)
4647 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
4649 int top
= WINDOW_TOP_EDGE_LINE (XWINDOW (FRAME_MINIBUF_WINDOW (f
)));
4652 if (cursor_in_echo_area
< 0)
4654 /* Negative value of cursor_in_echo_area means put
4655 cursor at beginning of line. */
4661 /* Positive value of cursor_in_echo_area means put
4662 cursor at the end of the prompt. If the mini-buffer
4663 is several lines high, find the last line that has
4665 row
= FRAME_LINES (f
);
4671 if (MATRIX_ROW_ENABLED_P (current_matrix
, row
))
4673 /* Frame rows are filled up with spaces that
4674 must be ignored here. */
4675 struct glyph_row
*r
= MATRIX_ROW (current_matrix
,
4677 struct glyph
*start
= r
->glyphs
[TEXT_AREA
];
4678 struct glyph
*last
= start
+ r
->used
[TEXT_AREA
];
4681 && (last
- 1)->charpos
< 0)
4687 while (row
> top
&& col
== 0);
4689 /* Make sure COL is not out of range. */
4690 if (col
>= FRAME_CURSOR_X_LIMIT (f
))
4692 /* If we have another row, advance cursor into it. */
4693 if (row
< FRAME_LINES (f
) - 1)
4695 col
= FRAME_LEFT_SCROLL_BAR_COLS (f
);
4698 /* Otherwise move it back in range. */
4700 col
= FRAME_CURSOR_X_LIMIT (f
) - 1;
4704 cursor_to (f
, row
, col
);
4708 /* We have only one cursor on terminal frames. Use it to
4709 display the cursor of the selected window. */
4710 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
4711 if (w
->cursor
.vpos
>= 0
4712 /* The cursor vpos may be temporarily out of bounds
4713 in the following situation: There is one window,
4714 with the cursor in the lower half of it. The window
4715 is split, and a message causes a redisplay before
4716 a new cursor position has been computed. */
4717 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
4719 int x
= WINDOW_TO_FRAME_HPOS (w
, w
->cursor
.hpos
);
4720 int y
= WINDOW_TO_FRAME_VPOS (w
, w
->cursor
.vpos
);
4722 if (INTEGERP (w
->left_margin_cols
))
4723 x
+= XFASTINT (w
->left_margin_cols
);
4725 /* x = max (min (x, FRAME_TOTAL_COLS (f) - 1), 0); */
4726 cursor_to (f
, y
, x
);
4731 #if !PERIODIC_PREEMPTION_CHECKING
4735 clear_desired_matrices (f
);
4740 /* Do line insertions/deletions on frame F for frame-based redisplay. */
4743 scrolling (struct frame
*frame
)
4745 int unchanged_at_top
, unchanged_at_bottom
;
4748 int *old_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4749 int *new_hash
= alloca (FRAME_LINES (frame
) * sizeof (int));
4750 int *draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4751 int *old_draw_cost
= alloca (FRAME_LINES (frame
) * sizeof (int));
4753 int free_at_end_vpos
= FRAME_LINES (frame
);
4754 struct glyph_matrix
*current_matrix
= frame
->current_matrix
;
4755 struct glyph_matrix
*desired_matrix
= frame
->desired_matrix
;
4757 if (!current_matrix
)
4760 /* Compute hash codes of all the lines. Also calculate number of
4761 changed lines, number of unchanged lines at the beginning, and
4762 number of unchanged lines at the end. */
4764 unchanged_at_top
= 0;
4765 unchanged_at_bottom
= FRAME_LINES (frame
);
4766 for (i
= 0; i
< FRAME_LINES (frame
); i
++)
4768 /* Give up on this scrolling if some old lines are not enabled. */
4769 if (!MATRIX_ROW_ENABLED_P (current_matrix
, i
))
4771 old_hash
[i
] = line_hash_code (MATRIX_ROW (current_matrix
, i
));
4772 if (! MATRIX_ROW_ENABLED_P (desired_matrix
, i
))
4774 /* This line cannot be redrawn, so don't let scrolling mess it. */
4775 new_hash
[i
] = old_hash
[i
];
4776 #define INFINITY 1000000 /* Taken from scroll.c */
4777 draw_cost
[i
] = INFINITY
;
4781 new_hash
[i
] = line_hash_code (MATRIX_ROW (desired_matrix
, i
));
4782 draw_cost
[i
] = line_draw_cost (desired_matrix
, i
);
4785 if (old_hash
[i
] != new_hash
[i
])
4788 unchanged_at_bottom
= FRAME_LINES (frame
) - i
- 1;
4790 else if (i
== unchanged_at_top
)
4792 old_draw_cost
[i
] = line_draw_cost (current_matrix
, i
);
4795 /* If changed lines are few, don't allow preemption, don't scroll. */
4796 if ((!FRAME_SCROLL_REGION_OK (frame
)
4797 && changed_lines
< baud_rate
/ 2400)
4798 || unchanged_at_bottom
== FRAME_LINES (frame
))
4801 window_size
= (FRAME_LINES (frame
) - unchanged_at_top
4802 - unchanged_at_bottom
);
4804 if (FRAME_SCROLL_REGION_OK (frame
))
4805 free_at_end_vpos
-= unchanged_at_bottom
;
4806 else if (FRAME_MEMORY_BELOW_FRAME (frame
))
4807 free_at_end_vpos
= -1;
4809 /* If large window, fast terminal and few lines in common between
4810 current frame and desired frame, don't bother with i/d calc. */
4811 if (!FRAME_SCROLL_REGION_OK (frame
)
4812 && window_size
>= 18 && baud_rate
> 2400
4814 10 * scrolling_max_lines_saved (unchanged_at_top
,
4815 FRAME_LINES (frame
) - unchanged_at_bottom
,
4816 old_hash
, new_hash
, draw_cost
)))
4819 if (window_size
< 2)
4822 scrolling_1 (frame
, window_size
, unchanged_at_top
, unchanged_at_bottom
,
4823 draw_cost
+ unchanged_at_top
- 1,
4824 old_draw_cost
+ unchanged_at_top
- 1,
4825 old_hash
+ unchanged_at_top
- 1,
4826 new_hash
+ unchanged_at_top
- 1,
4827 free_at_end_vpos
- unchanged_at_top
);
4833 /* Count the number of blanks at the start of the vector of glyphs R
4834 which is LEN glyphs long. */
4837 count_blanks (struct glyph
*r
, int len
)
4841 for (i
= 0; i
< len
; ++i
)
4842 if (!CHAR_GLYPH_SPACE_P (r
[i
]))
4849 /* Count the number of glyphs in common at the start of the glyph
4850 vectors STR1 and STR2. END1 is the end of STR1 and END2 is the end
4851 of STR2. Value is the number of equal glyphs equal at the start. */
4854 count_match (struct glyph
*str1
, struct glyph
*end1
, struct glyph
*str2
, struct glyph
*end2
)
4856 struct glyph
*p1
= str1
;
4857 struct glyph
*p2
= str2
;
4861 && GLYPH_CHAR_AND_FACE_EQUAL_P (p1
, p2
))
4868 /* Char insertion/deletion cost vector, from term.c */
4870 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_TOTAL_COLS ((f))])
4873 /* Perform a frame-based update on line VPOS in frame FRAME. */
4876 update_frame_line (struct frame
*f
, int vpos
)
4878 struct glyph
*obody
, *nbody
, *op1
, *op2
, *np1
, *nend
;
4880 int osp
, nsp
, begmatch
, endmatch
, olen
, nlen
;
4881 struct glyph_matrix
*current_matrix
= f
->current_matrix
;
4882 struct glyph_matrix
*desired_matrix
= f
->desired_matrix
;
4883 struct glyph_row
*current_row
= MATRIX_ROW (current_matrix
, vpos
);
4884 struct glyph_row
*desired_row
= MATRIX_ROW (desired_matrix
, vpos
);
4885 bool must_write_whole_line_p
;
4886 bool write_spaces_p
= FRAME_MUST_WRITE_SPACES (f
);
4887 bool colored_spaces_p
= (FACE_FROM_ID (f
, DEFAULT_FACE_ID
)->background
4888 != FACE_TTY_DEFAULT_BG_COLOR
);
4890 if (colored_spaces_p
)
4893 /* Current row not enabled means it has unknown contents. We must
4894 write the whole desired line in that case. */
4895 must_write_whole_line_p
= !current_row
->enabled_p
;
4896 if (must_write_whole_line_p
)
4903 obody
= MATRIX_ROW_GLYPH_START (current_matrix
, vpos
);
4904 olen
= current_row
->used
[TEXT_AREA
];
4906 /* Ignore trailing spaces, if we can. */
4907 if (!write_spaces_p
)
4908 while (olen
> 0 && CHAR_GLYPH_SPACE_P (obody
[olen
-1]))
4912 current_row
->enabled_p
= 1;
4913 current_row
->used
[TEXT_AREA
] = desired_row
->used
[TEXT_AREA
];
4915 /* If desired line is empty, just clear the line. */
4916 if (!desired_row
->enabled_p
)
4922 nbody
= desired_row
->glyphs
[TEXT_AREA
];
4923 nlen
= desired_row
->used
[TEXT_AREA
];
4924 nend
= nbody
+ nlen
;
4926 /* If display line has unknown contents, write the whole line. */
4927 if (must_write_whole_line_p
)
4929 /* Ignore spaces at the end, if we can. */
4930 if (!write_spaces_p
)
4931 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4934 /* Write the contents of the desired line. */
4937 cursor_to (f
, vpos
, 0);
4938 write_glyphs (f
, nbody
, nlen
);
4941 /* Don't call clear_end_of_line if we already wrote the whole
4942 line. The cursor will not be at the right margin in that
4943 case but in the line below. */
4944 if (nlen
< FRAME_TOTAL_COLS (f
))
4946 cursor_to (f
, vpos
, nlen
);
4947 clear_end_of_line (f
, FRAME_TOTAL_COLS (f
));
4950 /* Make sure we are in the right row, otherwise cursor movement
4951 with cmgoto might use `ch' in the wrong row. */
4952 cursor_to (f
, vpos
, 0);
4954 make_current (desired_matrix
, current_matrix
, vpos
);
4958 /* Pretend trailing spaces are not there at all,
4959 unless for one reason or another we must write all spaces. */
4960 if (!write_spaces_p
)
4961 while (nlen
> 0 && CHAR_GLYPH_SPACE_P (nbody
[nlen
- 1]))
4964 /* If there's no i/d char, quickly do the best we can without it. */
4965 if (!FRAME_CHAR_INS_DEL_OK (f
))
4969 /* Find the first glyph in desired row that doesn't agree with
4970 a glyph in the current row, and write the rest from there on. */
4971 for (i
= 0; i
< nlen
; i
++)
4973 if (i
>= olen
|| !GLYPH_EQUAL_P (nbody
+ i
, obody
+ i
))
4975 /* Find the end of the run of different glyphs. */
4979 || !GLYPH_EQUAL_P (nbody
+ j
, obody
+ j
)
4980 || CHAR_GLYPH_PADDING_P (nbody
[j
])))
4983 /* Output this run of non-matching chars. */
4984 cursor_to (f
, vpos
, i
);
4985 write_glyphs (f
, nbody
+ i
, j
- i
);
4988 /* Now find the next non-match. */
4992 /* Clear the rest of the line, or the non-clear part of it. */
4995 cursor_to (f
, vpos
, nlen
);
4996 clear_end_of_line (f
, olen
);
4999 /* Make current row = desired row. */
5000 make_current (desired_matrix
, current_matrix
, vpos
);
5004 /* Here when CHAR_INS_DEL_OK != 0, i.e. we can insert or delete
5005 characters in a row. */
5009 /* If current line is blank, skip over initial spaces, if
5010 possible, and write the rest. */
5014 nsp
= count_blanks (nbody
, nlen
);
5018 cursor_to (f
, vpos
, nsp
);
5019 write_glyphs (f
, nbody
+ nsp
, nlen
- nsp
);
5022 /* Exchange contents between current_frame and new_frame. */
5023 make_current (desired_matrix
, current_matrix
, vpos
);
5027 /* Compute number of leading blanks in old and new contents. */
5028 osp
= count_blanks (obody
, olen
);
5029 nsp
= (colored_spaces_p
? 0 : count_blanks (nbody
, nlen
));
5031 /* Compute number of matching chars starting with first non-blank. */
5032 begmatch
= count_match (obody
+ osp
, obody
+ olen
,
5033 nbody
+ nsp
, nbody
+ nlen
);
5035 /* Spaces in new match implicit space past the end of old. */
5036 /* A bug causing this to be a no-op was fixed in 18.29. */
5037 if (!write_spaces_p
&& osp
+ begmatch
== olen
)
5040 while (np1
+ begmatch
< nend
&& CHAR_GLYPH_SPACE_P (np1
[begmatch
]))
5044 /* Avoid doing insert/delete char
5045 just cause number of leading spaces differs
5046 when the following text does not match. */
5047 if (begmatch
== 0 && osp
!= nsp
)
5048 osp
= nsp
= min (osp
, nsp
);
5050 /* Find matching characters at end of line */
5053 op2
= op1
+ begmatch
- min (olen
- osp
, nlen
- nsp
);
5055 && GLYPH_EQUAL_P (op1
- 1, np1
- 1))
5060 endmatch
= obody
+ olen
- op1
;
5062 /* tem gets the distance to insert or delete.
5063 endmatch is how many characters we save by doing so.
5066 tem
= (nlen
- nsp
) - (olen
- osp
);
5068 && (!FRAME_CHAR_INS_DEL_OK (f
)
5069 || endmatch
<= char_ins_del_cost (f
)[tem
]))
5072 /* nsp - osp is the distance to insert or delete.
5073 If that is nonzero, begmatch is known to be nonzero also.
5074 begmatch + endmatch is how much we save by doing the ins/del.
5078 && (!FRAME_CHAR_INS_DEL_OK (f
)
5079 || begmatch
+ endmatch
<= char_ins_del_cost (f
)[nsp
- osp
]))
5083 osp
= nsp
= min (osp
, nsp
);
5086 /* Now go through the line, inserting, writing and
5087 deleting as appropriate. */
5091 cursor_to (f
, vpos
, nsp
);
5092 delete_glyphs (f
, osp
- nsp
);
5096 /* If going to delete chars later in line
5097 and insert earlier in the line,
5098 must delete first to avoid losing data in the insert */
5099 if (endmatch
&& nlen
< olen
+ nsp
- osp
)
5101 cursor_to (f
, vpos
, nlen
- endmatch
+ osp
- nsp
);
5102 delete_glyphs (f
, olen
+ nsp
- osp
- nlen
);
5103 olen
= nlen
- (nsp
- osp
);
5105 cursor_to (f
, vpos
, osp
);
5106 insert_glyphs (f
, 0, nsp
- osp
);
5110 tem
= nsp
+ begmatch
+ endmatch
;
5111 if (nlen
!= tem
|| olen
!= tem
)
5113 if (!endmatch
|| nlen
== olen
)
5115 /* If new text being written reaches right margin, there is
5116 no need to do clear-to-eol at the end of this function
5117 (and it would not be safe, since cursor is not going to
5118 be "at the margin" after the text is done). */
5119 if (nlen
== FRAME_TOTAL_COLS (f
))
5122 /* Function write_glyphs is prepared to do nothing
5123 if passed a length <= 0. Check it here to avoid
5124 unnecessary cursor movement. */
5127 cursor_to (f
, vpos
, nsp
+ begmatch
);
5128 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5131 else if (nlen
> olen
)
5133 /* Here, we used to have the following simple code:
5134 ----------------------------------------
5135 write_glyphs (nbody + nsp + begmatch, olen - tem);
5136 insert_glyphs (nbody + nsp + begmatch + olen - tem, nlen - olen);
5137 ----------------------------------------
5138 but it doesn't work if nbody[nsp + begmatch + olen - tem]
5139 is a padding glyph. */
5140 int out
= olen
- tem
; /* Columns to be overwritten originally. */
5143 cursor_to (f
, vpos
, nsp
+ begmatch
);
5145 /* Calculate columns we can actually overwrite. */
5146 while (CHAR_GLYPH_PADDING_P (nbody
[nsp
+ begmatch
+ out
]))
5148 write_glyphs (f
, nbody
+ nsp
+ begmatch
, out
);
5150 /* If we left columns to be overwritten, we must delete them. */
5151 del
= olen
- tem
- out
;
5153 delete_glyphs (f
, del
);
5155 /* At last, we insert columns not yet written out. */
5156 insert_glyphs (f
, nbody
+ nsp
+ begmatch
+ out
, nlen
- olen
+ del
);
5159 else if (olen
> nlen
)
5161 cursor_to (f
, vpos
, nsp
+ begmatch
);
5162 write_glyphs (f
, nbody
+ nsp
+ begmatch
, nlen
- tem
);
5163 delete_glyphs (f
, olen
- nlen
);
5169 /* If any unerased characters remain after the new line, erase them. */
5172 cursor_to (f
, vpos
, nlen
);
5173 clear_end_of_line (f
, olen
);
5176 /* Exchange contents between current_frame and new_frame. */
5177 make_current (desired_matrix
, current_matrix
, vpos
);
5182 /***********************************************************************
5183 X/Y Position -> Buffer Position
5184 ***********************************************************************/
5186 /* Determine what's under window-relative pixel position (*X, *Y).
5187 Return the OBJECT (string or buffer) that's there.
5188 Return in *POS the position in that object.
5189 Adjust *X and *Y to character positions.
5190 Return in *DX and *DY the pixel coordinates of the click,
5191 relative to the top left corner of OBJECT, or relative to
5192 the top left corner of the character glyph at (*X, *Y)
5194 Return WIDTH and HEIGHT of the object at (*X, *Y), or zero
5195 if the coordinates point to an empty area of the display. */
5198 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
)
5201 Lisp_Object old_current_buffer
= Fcurrent_buffer ();
5202 struct text_pos startp
;
5204 struct glyph_row
*row
;
5205 #ifdef HAVE_WINDOW_SYSTEM
5206 struct image
*img
= 0;
5209 void *itdata
= NULL
;
5211 /* We used to set current_buffer directly here, but that does the
5212 wrong thing with `face-remapping-alist' (bug#2044). */
5213 Fset_buffer (w
->buffer
);
5214 itdata
= bidi_shelve_cache ();
5215 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
5216 CHARPOS (startp
) = min (ZV
, max (BEGV
, CHARPOS (startp
)));
5217 BYTEPOS (startp
) = min (ZV_BYTE
, max (BEGV_BYTE
, BYTEPOS (startp
)));
5218 start_display (&it
, w
, startp
);
5219 /* start_display takes into account the header-line row, but IT's
5220 vpos still counts from the glyph row that includes the window's
5221 start position. Adjust for a possible header-line row. */
5222 it
.vpos
+= WINDOW_WANTS_HEADER_LINE_P (w
);
5226 /* First, move to the beginning of the row corresponding to *Y. We
5227 need to be in that row to get the correct value of base paragraph
5228 direction for the text at (*X, *Y). */
5229 move_it_to (&it
, -1, 0, *y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
5231 /* TO_X is the pixel position that the iterator will compute for the
5232 glyph at *X. We add it.first_visible_x because iterator
5233 positions include the hscroll. */
5234 to_x
= x0
+ it
.first_visible_x
;
5235 if (it
.bidi_it
.paragraph_dir
== R2L
)
5236 /* For lines in an R2L paragraph, we need to mirror TO_X wrt the
5237 text area. This is because the iterator, even in R2L
5238 paragraphs, delivers glyphs as if they started at the left
5239 margin of the window. (When we actually produce glyphs for
5240 display, we reverse their order in PRODUCE_GLYPHS, but the
5241 iterator doesn't know about that.) The following line adjusts
5242 the pixel position to the iterator geometry, which is what
5243 move_it_* routines use. (The -1 is because in a window whose
5244 text-area width is W, the rightmost pixel position is W-1, and
5245 it should be mirrored into zero pixel position.) */
5246 to_x
= window_box_width (w
, TEXT_AREA
) - to_x
- 1;
5248 /* Now move horizontally in the row to the glyph under *X. Second
5249 argument is ZV to prevent move_it_in_display_line from matching
5250 based on buffer positions. */
5251 move_it_in_display_line (&it
, ZV
, to_x
, MOVE_TO_X
);
5252 bidi_unshelve_cache (itdata
, 0);
5254 Fset_buffer (old_current_buffer
);
5256 *dx
= x0
+ it
.first_visible_x
- it
.current_x
;
5257 *dy
= *y
- it
.current_y
;
5260 if (STRINGP (it
.string
))
5263 if (it
.what
== IT_COMPOSITION
5264 && it
.cmp_it
.nchars
> 1
5265 && it
.cmp_it
.reversed_p
)
5267 /* The current display element is a grapheme cluster in a
5268 composition. In that case, we need the position of the first
5269 character of the cluster. But, as it.cmp_it.reversed_p is 1,
5270 it.current points to the last character of the cluster, thus
5271 we must move back to the first character of the same
5273 CHARPOS (pos
->pos
) -= it
.cmp_it
.nchars
- 1;
5274 if (STRINGP (it
.string
))
5275 BYTEPOS (pos
->pos
) = string_char_to_byte (string
, CHARPOS (pos
->pos
));
5277 BYTEPOS (pos
->pos
) = buf_charpos_to_bytepos (XBUFFER (w
->buffer
),
5278 CHARPOS (pos
->pos
));
5281 #ifdef HAVE_WINDOW_SYSTEM
5282 if (it
.what
== IT_IMAGE
)
5284 if ((img
= IMAGE_FROM_ID (it
.f
, it
.image_id
)) != NULL
5285 && !NILP (img
->spec
))
5286 *object
= img
->spec
;
5290 if (it
.vpos
< w
->current_matrix
->nrows
5291 && (row
= MATRIX_ROW (w
->current_matrix
, it
.vpos
),
5294 if (it
.hpos
< row
->used
[TEXT_AREA
])
5296 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + it
.hpos
;
5297 #ifdef HAVE_WINDOW_SYSTEM
5300 *dy
-= row
->ascent
- glyph
->ascent
;
5301 *dx
+= glyph
->slice
.img
.x
;
5302 *dy
+= glyph
->slice
.img
.y
;
5303 /* Image slices positions are still relative to the entire image */
5304 *width
= img
->width
;
5305 *height
= img
->height
;
5310 *width
= glyph
->pixel_width
;
5311 *height
= glyph
->ascent
+ glyph
->descent
;
5317 *height
= row
->height
;
5322 *width
= *height
= 0;
5325 /* Add extra (default width) columns if clicked after EOL. */
5326 x1
= max (0, it
.current_x
+ it
.pixel_width
- it
.first_visible_x
);
5328 it
.hpos
+= (x0
- x1
) / WINDOW_FRAME_COLUMN_WIDTH (w
);
5337 /* Value is the string under window-relative coordinates X/Y in the
5338 mode line or header line (PART says which) of window W, or nil if none.
5339 *CHARPOS is set to the position in the string returned. */
5342 mode_line_string (struct window
*w
, enum window_part part
,
5343 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5344 int *dx
, int *dy
, int *width
, int *height
)
5346 struct glyph_row
*row
;
5347 struct glyph
*glyph
, *end
;
5349 Lisp_Object string
= Qnil
;
5351 if (part
== ON_MODE_LINE
)
5352 row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
);
5354 row
= MATRIX_HEADER_LINE_ROW (w
->current_matrix
);
5356 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5358 if (row
->mode_line_p
&& row
->enabled_p
)
5360 /* Find the glyph under X. If we find one with a string object,
5361 it's the one we were looking for. */
5362 glyph
= row
->glyphs
[TEXT_AREA
];
5363 end
= glyph
+ row
->used
[TEXT_AREA
];
5364 for (x0
= *x
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5365 x0
-= glyph
->pixel_width
;
5366 *x
= glyph
- row
->glyphs
[TEXT_AREA
];
5369 string
= glyph
->object
;
5370 *charpos
= glyph
->charpos
;
5371 *width
= glyph
->pixel_width
;
5372 *height
= glyph
->ascent
+ glyph
->descent
;
5373 #ifdef HAVE_WINDOW_SYSTEM
5374 if (glyph
->type
== IMAGE_GLYPH
)
5377 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5379 *object
= img
->spec
;
5380 y0
-= row
->ascent
- glyph
->ascent
;
5386 /* Add extra (default width) columns if clicked after EOL. */
5387 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5389 *height
= row
->height
;
5396 *width
= *height
= 0;
5406 /* Value is the string under window-relative coordinates X/Y in either
5407 marginal area, or nil if none. *CHARPOS is set to the position in
5408 the string returned. */
5411 marginal_area_string (struct window
*w
, enum window_part part
,
5412 int *x
, int *y
, ptrdiff_t *charpos
, Lisp_Object
*object
,
5413 int *dx
, int *dy
, int *width
, int *height
)
5415 struct glyph_row
*row
= w
->current_matrix
->rows
;
5416 struct glyph
*glyph
, *end
;
5417 int x0
, y0
, i
, wy
= *y
;
5419 Lisp_Object string
= Qnil
;
5421 if (part
== ON_LEFT_MARGIN
)
5422 area
= LEFT_MARGIN_AREA
;
5423 else if (part
== ON_RIGHT_MARGIN
)
5424 area
= RIGHT_MARGIN_AREA
;
5428 for (i
= 0; row
->enabled_p
&& i
< w
->current_matrix
->nrows
; ++i
, ++row
)
5429 if (wy
>= row
->y
&& wy
< MATRIX_ROW_BOTTOM_Y (row
))
5432 *y
= row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
5436 /* Find the glyph under X. If we find one with a string object,
5437 it's the one we were looking for. */
5438 if (area
== RIGHT_MARGIN_AREA
)
5439 x0
= ((WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5440 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5441 : WINDOW_TOTAL_FRINGE_WIDTH (w
))
5442 + window_box_width (w
, LEFT_MARGIN_AREA
)
5443 + window_box_width (w
, TEXT_AREA
));
5445 x0
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5446 ? WINDOW_LEFT_FRINGE_WIDTH (w
)
5449 glyph
= row
->glyphs
[area
];
5450 end
= glyph
+ row
->used
[area
];
5451 for (x0
= *x
- x0
; glyph
< end
&& x0
>= glyph
->pixel_width
; ++glyph
)
5452 x0
-= glyph
->pixel_width
;
5453 *x
= glyph
- row
->glyphs
[area
];
5456 string
= glyph
->object
;
5457 *charpos
= glyph
->charpos
;
5458 *width
= glyph
->pixel_width
;
5459 *height
= glyph
->ascent
+ glyph
->descent
;
5460 #ifdef HAVE_WINDOW_SYSTEM
5461 if (glyph
->type
== IMAGE_GLYPH
)
5464 img
= IMAGE_FROM_ID (WINDOW_XFRAME (w
), glyph
->u
.img_id
);
5466 *object
= img
->spec
;
5467 y0
-= row
->ascent
- glyph
->ascent
;
5468 x0
+= glyph
->slice
.img
.x
;
5469 y0
+= glyph
->slice
.img
.y
;
5475 /* Add extra (default width) columns if clicked after EOL. */
5476 *x
+= x0
/ WINDOW_FRAME_COLUMN_WIDTH (w
);
5478 *height
= row
->height
;
5485 *width
= *height
= 0;
5495 /***********************************************************************
5496 Changing Frame Sizes
5497 ***********************************************************************/
5501 static void deliver_window_change_signal (int);
5504 handle_window_change_signal (int sig
)
5507 struct tty_display_info
*tty
;
5509 /* The frame size change obviously applies to a single
5510 termcap-controlled terminal, but we can't decide which.
5511 Therefore, we resize the frames corresponding to each tty.
5513 for (tty
= tty_list
; tty
; tty
= tty
->next
) {
5515 if (! tty
->term_initted
)
5518 /* Suspended tty frames have tty->input == NULL avoid trying to
5523 get_tty_size (fileno (tty
->input
), &width
, &height
);
5525 if (width
> 5 && height
> 2) {
5526 Lisp_Object tail
, frame
;
5528 FOR_EACH_FRAME (tail
, frame
)
5529 if (FRAME_TERMCAP_P (XFRAME (frame
)) && FRAME_TTY (XFRAME (frame
)) == tty
)
5530 /* Record the new sizes, but don't reallocate the data
5531 structures now. Let that be done later outside of the
5533 change_frame_size (XFRAME (frame
), height
, width
, 0, 1, 0);
5539 deliver_window_change_signal (int sig
)
5541 deliver_process_signal (sig
, handle_window_change_signal
);
5543 #endif /* SIGWINCH */
5546 /* Do any change in frame size that was requested by a signal.
5547 SAFE means this function is called from a place where it is
5548 safe to change frame sizes while a redisplay is in progress. */
5551 do_pending_window_change (bool safe
)
5553 /* If window change signal handler should have run before, run it now. */
5554 if (redisplaying_p
&& !safe
)
5557 while (delayed_size_change
)
5559 Lisp_Object tail
, frame
;
5561 delayed_size_change
= 0;
5563 FOR_EACH_FRAME (tail
, frame
)
5565 struct frame
*f
= XFRAME (frame
);
5567 if (f
->new_text_lines
!= 0 || f
->new_text_cols
!= 0)
5568 change_frame_size (f
, f
->new_text_lines
, f
->new_text_cols
,
5575 /* Change the frame height and/or width. Values may be given as zero to
5576 indicate no change is to take place.
5578 If DELAY, assume we're being called from a signal handler, and
5579 queue the change for later - perhaps the next redisplay.
5580 Since this tries to resize windows, we can't call it
5581 from a signal handler.
5583 SAFE means this function is called from a place where it's
5584 safe to change frame sizes while a redisplay is in progress. */
5587 change_frame_size (struct frame
*f
, int newheight
, int newwidth
,
5588 bool pretend
, bool delay
, bool safe
)
5590 Lisp_Object tail
, frame
;
5592 if (FRAME_MSDOS_P (f
))
5594 /* On MS-DOS, all frames use the same screen, so a change in
5595 size affects all frames. Termcap now supports multiple
5597 FOR_EACH_FRAME (tail
, frame
)
5598 if (! FRAME_WINDOW_P (XFRAME (frame
)))
5599 change_frame_size_1 (XFRAME (frame
), newheight
, newwidth
,
5600 pretend
, delay
, safe
);
5603 change_frame_size_1 (f
, newheight
, newwidth
, pretend
, delay
, safe
);
5607 change_frame_size_1 (struct frame
*f
, int newheight
, int newwidth
,
5608 bool pretend
, bool delay
, bool safe
)
5610 int new_frame_total_cols
;
5611 ptrdiff_t count
= SPECPDL_INDEX ();
5613 /* If we can't deal with the change now, queue it for later. */
5614 if (delay
|| (redisplaying_p
&& !safe
))
5616 f
->new_text_lines
= newheight
;
5617 f
->new_text_cols
= newwidth
;
5618 delayed_size_change
= 1;
5622 /* This size-change overrides any pending one for this frame. */
5623 f
->new_text_lines
= 0;
5624 f
->new_text_cols
= 0;
5626 /* If an argument is zero, set it to the current value. */
5628 newheight
= FRAME_LINES (f
);
5630 newwidth
= FRAME_COLS (f
);
5632 /* Compute width of windows in F. */
5633 /* Round up to the smallest acceptable size. */
5634 check_frame_size (f
, &newheight
, &newwidth
);
5636 /* This is the width of the frame with vertical scroll bars and fringe
5637 columns. Do this after rounding - see discussion of bug#9723. */
5638 new_frame_total_cols
= FRAME_TOTAL_COLS_ARG (f
, newwidth
);
5640 /* If we're not changing the frame size, quit now. */
5641 /* Frame width may be unchanged but the text portion may change, for
5642 example, fullscreen and remove/add scroll bar. */
5643 if (newheight
== FRAME_LINES (f
)
5644 /* Text portion unchanged? */
5645 && newwidth
== FRAME_COLS (f
)
5646 /* Frame width unchanged? */
5647 && new_frame_total_cols
== FRAME_TOTAL_COLS (f
))
5653 /* We only can set screen dimensions to certain values supported
5654 by our video hardware. Try to find the smallest size greater
5655 or equal to the requested dimensions. */
5656 dos_set_window_size (&newheight
, &newwidth
);
5659 if (newheight
!= FRAME_LINES (f
))
5661 resize_frame_windows (f
, newheight
, 0);
5663 /* MSDOS frames cannot PRETEND, as they change frame size by
5664 manipulating video hardware. */
5665 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5666 FrameRows (FRAME_TTY (f
)) = newheight
;
5669 if (new_frame_total_cols
!= FRAME_TOTAL_COLS (f
))
5671 resize_frame_windows (f
, new_frame_total_cols
, 1);
5673 /* MSDOS frames cannot PRETEND, as they change frame size by
5674 manipulating video hardware. */
5675 if ((FRAME_TERMCAP_P (f
) && !pretend
) || FRAME_MSDOS_P (f
))
5676 FrameCols (FRAME_TTY (f
)) = newwidth
;
5678 if (WINDOWP (f
->tool_bar_window
))
5679 wset_total_cols (XWINDOW (f
->tool_bar_window
), make_number (newwidth
));
5682 FRAME_LINES (f
) = newheight
;
5683 SET_FRAME_COLS (f
, newwidth
);
5686 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
5687 int text_area_x
, text_area_y
, text_area_width
, text_area_height
;
5689 window_box (w
, TEXT_AREA
, &text_area_x
, &text_area_y
, &text_area_width
,
5691 if (w
->cursor
.x
>= text_area_x
+ text_area_width
)
5692 w
->cursor
.hpos
= w
->cursor
.x
= 0;
5693 if (w
->cursor
.y
>= text_area_y
+ text_area_height
)
5694 w
->cursor
.vpos
= w
->cursor
.y
= 0;
5698 calculate_costs (f
);
5699 SET_FRAME_GARBAGED (f
);
5704 record_unwind_current_buffer ();
5706 run_window_configuration_change_hook (f
);
5708 unbind_to (count
, Qnil
);
5713 /***********************************************************************
5714 Terminal Related Lisp Functions
5715 ***********************************************************************/
5717 DEFUN ("open-termscript", Fopen_termscript
, Sopen_termscript
,
5718 1, 1, "FOpen termscript file: ",
5719 doc
: /* Start writing all terminal output to FILE as well as the terminal.
5720 FILE = nil means just close any termscript file currently open. */)
5723 struct tty_display_info
*tty
;
5725 if (! FRAME_TERMCAP_P (SELECTED_FRAME ())
5726 && ! FRAME_MSDOS_P (SELECTED_FRAME ()))
5727 error ("Current frame is not on a tty device");
5731 if (tty
->termscript
!= 0)
5734 fclose (tty
->termscript
);
5737 tty
->termscript
= 0;
5741 file
= Fexpand_file_name (file
, Qnil
);
5742 tty
->termscript
= fopen (SSDATA (file
), "w");
5743 if (tty
->termscript
== 0)
5744 report_file_error ("Opening termscript", Fcons (file
, Qnil
));
5750 DEFUN ("send-string-to-terminal", Fsend_string_to_terminal
,
5751 Ssend_string_to_terminal
, 1, 2, 0,
5752 doc
: /* Send STRING to the terminal without alteration.
5753 Control characters in STRING will have terminal-dependent effects.
5755 Optional parameter TERMINAL specifies the tty terminal device to use.
5756 It may be a terminal object, a frame, or nil for the terminal used by
5757 the currently selected frame. In batch mode, STRING is sent to stdout
5758 when TERMINAL is nil. */)
5759 (Lisp_Object string
, Lisp_Object terminal
)
5761 struct terminal
*t
= get_terminal (terminal
, 1);
5764 /* ??? Perhaps we should do something special for multibyte strings here. */
5765 CHECK_STRING (string
);
5769 error ("Unknown terminal device");
5771 if (t
->type
== output_initial
)
5773 else if (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
)
5774 error ("Device %d is not a termcap terminal device", t
->id
);
5777 struct tty_display_info
*tty
= t
->display_info
.tty
;
5780 error ("Terminal is currently suspended");
5782 if (tty
->termscript
)
5784 fwrite (SDATA (string
), 1, SBYTES (string
), tty
->termscript
);
5785 fflush (tty
->termscript
);
5789 fwrite (SDATA (string
), 1, SBYTES (string
), out
);
5796 DEFUN ("ding", Fding
, Sding
, 0, 1, 0,
5797 doc
: /* Beep, or flash the screen.
5798 Also, unless an argument is given,
5799 terminate any keyboard macro currently executing. */)
5807 ring_bell (XFRAME (selected_frame
));
5816 bitch_at_user (void)
5820 else if (!INTERACTIVE
) /* Stop executing a keyboard macro. */
5821 error ("Keyboard macro terminated by a command ringing the bell");
5823 ring_bell (XFRAME (selected_frame
));
5828 /***********************************************************************
5830 ***********************************************************************/
5832 DEFUN ("sleep-for", Fsleep_for
, Ssleep_for
, 1, 2, 0,
5833 doc
: /* Pause, without updating display, for SECONDS seconds.
5834 SECONDS may be a floating-point value, meaning that you can wait for a
5835 fraction of a second. Optional second arg MILLISECONDS specifies an
5836 additional wait period, in milliseconds; this is for backwards compatibility.
5837 \(Not all operating systems support waiting for a fraction of a second.) */)
5838 (Lisp_Object seconds
, Lisp_Object milliseconds
)
5840 double duration
= extract_float (seconds
);
5842 if (!NILP (milliseconds
))
5844 CHECK_NUMBER (milliseconds
);
5845 duration
+= XINT (milliseconds
) / 1000.0;
5850 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (duration
);
5851 wait_reading_process_output (min (EMACS_SECS (t
), WAIT_READING_MAX
),
5852 EMACS_NSECS (t
), 0, 0, Qnil
, NULL
, 0);
5859 /* This is just like wait_reading_process_output, except that
5862 TIMEOUT is number of seconds to wait (float or integer),
5863 or t to wait forever.
5864 READING is true if reading input.
5865 If DISPLAY_OPTION is >0 display process output while waiting.
5866 If DISPLAY_OPTION is >1 perform an initial redisplay before waiting.
5870 sit_for (Lisp_Object timeout
, bool reading
, int display_option
)
5874 bool do_display
= display_option
> 0;
5876 swallow_events (do_display
);
5878 if ((detect_input_pending_run_timers (do_display
))
5879 || !NILP (Vexecuting_kbd_macro
))
5882 if (display_option
> 1)
5883 redisplay_preserve_echo_area (2);
5885 if (INTEGERP (timeout
))
5887 sec
= XINT (timeout
);
5892 else if (FLOATP (timeout
))
5894 double seconds
= XFLOAT_DATA (timeout
);
5895 if (! (0 < seconds
))
5899 EMACS_TIME t
= EMACS_TIME_FROM_DOUBLE (seconds
);
5900 sec
= min (EMACS_SECS (t
), WAIT_READING_MAX
);
5901 nsec
= EMACS_NSECS (t
);
5904 else if (EQ (timeout
, Qt
))
5910 wrong_type_argument (Qnumberp
, timeout
);
5917 wait_reading_process_output (sec
, nsec
, reading
? -1 : 1, do_display
,
5920 return detect_input_pending () ? Qnil
: Qt
;
5924 DEFUN ("redisplay", Fredisplay
, Sredisplay
, 0, 1, 0,
5925 doc
: /* Perform redisplay.
5926 Optional arg FORCE, if non-nil, prevents redisplay from being
5927 preempted by arriving input, even if `redisplay-dont-pause' is nil.
5928 If `redisplay-dont-pause' is non-nil (the default), redisplay is never
5929 preempted by arriving input, so FORCE does nothing.
5931 Return t if redisplay was performed, nil if redisplay was preempted
5932 immediately by pending input. */)
5938 if ((detect_input_pending_run_timers (1)
5939 && NILP (force
) && !redisplay_dont_pause
)
5940 || !NILP (Vexecuting_kbd_macro
))
5943 count
= SPECPDL_INDEX ();
5944 if (!NILP (force
) && !redisplay_dont_pause
)
5945 specbind (Qredisplay_dont_pause
, Qt
);
5946 redisplay_preserve_echo_area (2);
5947 unbind_to (count
, Qnil
);
5953 /***********************************************************************
5954 Other Lisp Functions
5955 ***********************************************************************/
5957 /* A vector of size >= 2 * NFRAMES + 3 * NBUFFERS + 1, containing the
5958 session's frames, frame names, buffers, buffer-read-only flags, and
5959 buffer-modified-flags. */
5961 static Lisp_Object frame_and_buffer_state
;
5964 DEFUN ("frame-or-buffer-changed-p", Fframe_or_buffer_changed_p
,
5965 Sframe_or_buffer_changed_p
, 0, 1, 0,
5966 doc
: /* Return non-nil if the frame and buffer state appears to have changed.
5967 VARIABLE is a variable name whose value is either nil or a state vector
5968 that will be updated to contain all frames and buffers,
5969 aside from buffers whose names start with space,
5970 along with the buffers' read-only and modified flags. This allows a fast
5971 check to see whether buffer menus might need to be recomputed.
5972 If this function returns non-nil, it updates the internal vector to reflect
5975 If VARIABLE is nil, an internal variable is used. Users should not
5976 pass nil for VARIABLE. */)
5977 (Lisp_Object variable
)
5979 Lisp_Object state
, tail
, frame
, buf
;
5982 if (! NILP (variable
))
5984 CHECK_SYMBOL (variable
);
5985 state
= Fsymbol_value (variable
);
5986 if (! VECTORP (state
))
5990 state
= frame_and_buffer_state
;
5993 FOR_EACH_FRAME (tail
, frame
)
5995 if (idx
== ASIZE (state
))
5997 if (!EQ (AREF (state
, idx
++), frame
))
5999 if (idx
== ASIZE (state
))
6001 if (!EQ (AREF (state
, idx
++), XFRAME (frame
)->name
))
6004 /* Check that the buffer info matches. */
6005 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6007 buf
= XCDR (XCAR (tail
));
6008 /* Ignore buffers that aren't included in buffer lists. */
6009 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6011 if (idx
== ASIZE (state
))
6013 if (!EQ (AREF (state
, idx
++), buf
))
6015 if (idx
== ASIZE (state
))
6017 if (!EQ (AREF (state
, idx
++), BVAR (XBUFFER (buf
), read_only
)))
6019 if (idx
== ASIZE (state
))
6021 if (!EQ (AREF (state
, idx
++), Fbuffer_modified_p (buf
)))
6024 if (idx
== ASIZE (state
))
6026 /* Detect deletion of a buffer at the end of the list. */
6027 if (EQ (AREF (state
, idx
), Qlambda
))
6030 /* Come here if we decide the data has changed. */
6032 /* Count the size we will need.
6033 Start with 1 so there is room for at least one lambda at the end. */
6035 FOR_EACH_FRAME (tail
, frame
)
6037 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6039 /* Reallocate the vector if data has grown to need it,
6040 or if it has shrunk a lot. */
6041 if (! VECTORP (state
)
6042 || n
> ASIZE (state
)
6043 || n
+ 20 < ASIZE (state
) / 2)
6044 /* Add 20 extra so we grow it less often. */
6046 state
= Fmake_vector (make_number (n
+ 20), Qlambda
);
6047 if (! NILP (variable
))
6048 Fset (variable
, state
);
6050 frame_and_buffer_state
= state
;
6053 /* Record the new data in the (possibly reallocated) vector. */
6055 FOR_EACH_FRAME (tail
, frame
)
6057 ASET (state
, idx
, frame
);
6059 ASET (state
, idx
, XFRAME (frame
)->name
);
6062 for (tail
= Vbuffer_alist
; CONSP (tail
); tail
= XCDR (tail
))
6064 buf
= XCDR (XCAR (tail
));
6065 /* Ignore buffers that aren't included in buffer lists. */
6066 if (SREF (BVAR (XBUFFER (buf
), name
), 0) == ' ')
6068 ASET (state
, idx
, buf
);
6070 ASET (state
, idx
, BVAR (XBUFFER (buf
), read_only
));
6072 ASET (state
, idx
, Fbuffer_modified_p (buf
));
6075 /* Fill up the vector with lambdas (always at least one). */
6076 ASET (state
, idx
, Qlambda
);
6078 while (idx
< ASIZE (state
))
6080 ASET (state
, idx
, Qlambda
);
6083 /* Make sure we didn't overflow the vector. */
6084 eassert (idx
<= ASIZE (state
));
6090 /***********************************************************************
6092 ***********************************************************************/
6094 /* Initialization done when Emacs fork is started, before doing stty.
6095 Determine terminal type and set terminal_driver. Then invoke its
6096 decoding routine to set up variables in the terminal package. */
6101 char *terminal_type
;
6103 /* Construct the space glyph. */
6104 space_glyph
.type
= CHAR_GLYPH
;
6105 SET_CHAR_GLYPH (space_glyph
, ' ', DEFAULT_FACE_ID
, 0);
6106 space_glyph
.charpos
= -1;
6109 cursor_in_echo_area
= 0;
6110 terminal_type
= (char *) 0;
6112 /* Now is the time to initialize this; it's used by init_sys_modes
6114 Vinitial_window_system
= Qnil
;
6116 /* SIGWINCH needs to be handled no matter what display we start
6117 with. Otherwise newly opened tty frames will not resize
6122 #endif /* CANNOT_DUMP */
6124 struct sigaction action
;
6125 emacs_sigaction_init (&action
, deliver_window_change_signal
);
6126 sigaction (SIGWINCH
, &action
, 0);
6128 #endif /* SIGWINCH */
6130 /* If running as a daemon, no need to initialize any frames/terminal. */
6134 /* If the user wants to use a window system, we shouldn't bother
6135 initializing the terminal. This is especially important when the
6136 terminal is so dumb that emacs gives up before and doesn't bother
6137 using the window system.
6139 If the DISPLAY environment variable is set and nonempty,
6140 try to use X, and die with an error message if that doesn't work. */
6142 #ifdef HAVE_X_WINDOWS
6143 if (! inhibit_window_system
&& ! display_arg
)
6146 display
= getenv ("DISPLAY");
6147 display_arg
= (display
!= 0 && *display
!= 0);
6149 if (display_arg
&& !x_display_ok (display
))
6151 fprintf (stderr
, "Display %s unavailable, simulating -nw\n",
6153 inhibit_window_system
= 1;
6157 if (!inhibit_window_system
&& display_arg
)
6159 Vinitial_window_system
= Qx
;
6161 Vwindow_system_version
= make_number (11);
6164 /* In some versions of ncurses,
6165 tputs crashes if we have not called tgetent.
6167 { char b
[2044]; tgetent (b
, "xterm");}
6171 #endif /* HAVE_X_WINDOWS */
6174 if (!inhibit_window_system
)
6176 Vinitial_window_system
= Qw32
;
6177 Vwindow_system_version
= make_number (1);
6180 #endif /* HAVE_NTGUI */
6183 if (!inhibit_window_system
6189 Vinitial_window_system
= Qns
;
6190 Vwindow_system_version
= make_number (10);
6195 /* If no window system has been specified, try to use the terminal. */
6198 fatal ("standard input is not a tty");
6203 terminal_type
= "w32console";
6205 /* Look at the TERM variable. */
6206 terminal_type
= (char *) getenv ("TERM");
6210 #ifdef HAVE_WINDOW_SYSTEM
6211 if (! inhibit_window_system
)
6212 fprintf (stderr
, "Please set the environment variable DISPLAY or TERM (see `tset').\n");
6214 #endif /* HAVE_WINDOW_SYSTEM */
6215 fprintf (stderr
, "Please set the environment variable TERM; see `tset'.\n");
6221 struct frame
*f
= XFRAME (selected_frame
);
6223 init_foreground_group ();
6225 /* Open a display on the controlling tty. */
6226 t
= init_tty (0, terminal_type
, 1); /* Errors are fatal. */
6228 /* Convert the initial frame to use the new display. */
6229 if (f
->output_method
!= output_initial
)
6231 f
->output_method
= t
->type
;
6234 t
->reference_count
++;
6236 f
->output_data
.tty
->display_info
= &the_only_display_info
;
6238 if (f
->output_method
== output_termcap
)
6239 create_tty_output (f
);
6241 t
->display_info
.tty
->top_frame
= selected_frame
;
6242 change_frame_size (XFRAME (selected_frame
),
6243 FrameRows (t
->display_info
.tty
),
6244 FrameCols (t
->display_info
.tty
), 0, 0, 1);
6246 /* Delete the initial terminal. */
6247 if (--initial_terminal
->reference_count
== 0
6248 && initial_terminal
->delete_terminal_hook
)
6249 (*initial_terminal
->delete_terminal_hook
) (initial_terminal
);
6251 /* Update frame parameters to reflect the new type. */
6252 Fmodify_frame_parameters
6253 (selected_frame
, Fcons (Fcons (Qtty_type
,
6254 Ftty_type (selected_frame
)), Qnil
));
6255 if (t
->display_info
.tty
->name
)
6256 Fmodify_frame_parameters (selected_frame
,
6257 Fcons (Fcons (Qtty
, build_string (t
->display_info
.tty
->name
)),
6260 Fmodify_frame_parameters (selected_frame
, Fcons (Fcons (Qtty
, Qnil
),
6265 struct frame
*sf
= SELECTED_FRAME ();
6266 int width
= FRAME_TOTAL_COLS (sf
);
6267 int height
= FRAME_LINES (sf
);
6269 /* If these sizes are so big they cause overflow, just ignore the
6270 change. It's not clear what better we could do. The rest of
6271 the code assumes that (width + 2) * height * sizeof (struct glyph)
6272 does not overflow and does not exceed PTRDIFF_MAX or SIZE_MAX. */
6273 if (INT_ADD_RANGE_OVERFLOW (width
, 2, INT_MIN
, INT_MAX
)
6274 || INT_MULTIPLY_RANGE_OVERFLOW (width
+ 2, height
, INT_MIN
, INT_MAX
)
6275 || (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (struct glyph
)
6276 < (width
+ 2) * height
))
6277 fatal ("screen size %dx%d too big", width
, height
);
6280 calculate_costs (XFRAME (selected_frame
));
6282 /* Set up faces of the initial terminal frame of a dumped Emacs. */
6285 && NILP (Vinitial_window_system
))
6287 /* For the initial frame, we don't have any way of knowing what
6288 are the foreground and background colors of the terminal. */
6289 struct frame
*sf
= SELECTED_FRAME ();
6291 FRAME_FOREGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_FG_COLOR
;
6292 FRAME_BACKGROUND_PIXEL (sf
) = FACE_TTY_DEFAULT_BG_COLOR
;
6293 call0 (intern ("tty-set-up-initial-frame-faces"));
6299 /***********************************************************************
6301 ***********************************************************************/
6303 DEFUN ("internal-show-cursor", Finternal_show_cursor
,
6304 Sinternal_show_cursor
, 2, 2, 0,
6305 doc
: /* Set the cursor-visibility flag of WINDOW to SHOW.
6306 WINDOW nil means use the selected window. SHOW non-nil means
6307 show a cursor in WINDOW in the next redisplay. SHOW nil means
6308 don't show a cursor. */)
6309 (Lisp_Object window
, Lisp_Object show
)
6311 /* Don't change cursor state while redisplaying. This could confuse
6313 if (!redisplaying_p
)
6314 decode_any_window (window
)->cursor_off_p
= NILP (show
);
6319 DEFUN ("internal-show-cursor-p", Finternal_show_cursor_p
,
6320 Sinternal_show_cursor_p
, 0, 1, 0,
6321 doc
: /* Value is non-nil if next redisplay will display a cursor in WINDOW.
6322 WINDOW nil or omitted means report on the selected window. */)
6323 (Lisp_Object window
)
6325 return decode_any_window (window
)->cursor_off_p
? Qnil
: Qt
;
6328 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame
,
6329 Slast_nonminibuf_frame
, 0, 0, 0,
6330 doc
: /* Value is last nonminibuffer frame. */)
6333 Lisp_Object frame
= Qnil
;
6335 if (last_nonminibuf_frame
)
6336 XSETFRAME (frame
, last_nonminibuf_frame
);
6341 /***********************************************************************
6343 ***********************************************************************/
6346 syms_of_display (void)
6348 defsubr (&Sredraw_frame
);
6349 defsubr (&Sredraw_display
);
6350 defsubr (&Sframe_or_buffer_changed_p
);
6351 defsubr (&Sopen_termscript
);
6353 defsubr (&Sredisplay
);
6354 defsubr (&Ssleep_for
);
6355 defsubr (&Ssend_string_to_terminal
);
6356 defsubr (&Sinternal_show_cursor
);
6357 defsubr (&Sinternal_show_cursor_p
);
6358 defsubr (&Slast_nonminibuf_frame
);
6361 defsubr (&Sdump_redisplay_history
);
6364 frame_and_buffer_state
= Fmake_vector (make_number (20), Qlambda
);
6365 staticpro (&frame_and_buffer_state
);
6367 DEFSYM (Qdisplay_table
, "display-table");
6368 DEFSYM (Qredisplay_dont_pause
, "redisplay-dont-pause");
6370 DEFVAR_INT ("baud-rate", baud_rate
,
6371 doc
: /* The output baud rate of the terminal.
6372 On most systems, changing this value will affect the amount of padding
6373 and the other strategic decisions made during redisplay. */);
6375 DEFVAR_BOOL ("inverse-video", inverse_video
,
6376 doc
: /* Non-nil means invert the entire frame display.
6377 This means everything is in inverse video which otherwise would not be. */);
6379 DEFVAR_BOOL ("visible-bell", visible_bell
,
6380 doc
: /* Non-nil means try to flash the frame to represent a bell.
6382 See also `ring-bell-function'. */);
6384 DEFVAR_BOOL ("no-redraw-on-reenter", no_redraw_on_reenter
,
6385 doc
: /* Non-nil means no need to redraw entire frame after suspending.
6386 A non-nil value is useful if the terminal can automatically preserve
6387 Emacs's frame display when you reenter Emacs.
6388 It is up to you to set this variable if your terminal can do that. */);
6390 DEFVAR_LISP ("initial-window-system", Vinitial_window_system
,
6391 doc
: /* Name of the window system that Emacs uses for the first frame.
6392 The value is a symbol:
6393 nil for a termcap frame (a character-only terminal),
6394 'x' for an Emacs frame that is really an X window,
6395 'w32' for an Emacs frame that is a window on MS-Windows display,
6396 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6397 'pc' for a direct-write MS-DOS frame.
6399 Use of this variable as a boolean is deprecated. Instead,
6400 use `display-graphic-p' or any of the other `display-*-p'
6401 predicates which report frame's specific UI-related capabilities. */);
6403 DEFVAR_KBOARD ("window-system", Vwindow_system
,
6404 doc
: /* Name of window system through which the selected frame is displayed.
6405 The value is a symbol:
6406 nil for a termcap frame (a character-only terminal),
6407 'x' for an Emacs frame that is really an X window,
6408 'w32' for an Emacs frame that is a window on MS-Windows display,
6409 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
6410 'pc' for a direct-write MS-DOS frame.
6412 Use of this variable as a boolean is deprecated. Instead,
6413 use `display-graphic-p' or any of the other `display-*-p'
6414 predicates which report frame's specific UI-related capabilities. */);
6416 DEFVAR_LISP ("window-system-version", Vwindow_system_version
,
6417 doc
: /* The version number of the window system in use.
6418 For X windows, this is 11. */);
6420 DEFVAR_BOOL ("cursor-in-echo-area", cursor_in_echo_area
,
6421 doc
: /* Non-nil means put cursor in minibuffer, at end of any message there. */);
6423 DEFVAR_LISP ("glyph-table", Vglyph_table
,
6424 doc
: /* Table defining how to output a glyph code to the frame.
6425 If not nil, this is a vector indexed by glyph code to define the glyph.
6426 Each element can be:
6427 integer: a glyph code which this glyph is an alias for.
6428 string: output this glyph using that string (not impl. in X windows).
6429 nil: this glyph mod 524288 is the code of a character to output,
6430 and this glyph / 524288 is the face number (see `face-id') to use
6431 while outputting it. */);
6432 Vglyph_table
= Qnil
;
6434 DEFVAR_LISP ("standard-display-table", Vstandard_display_table
,
6435 doc
: /* Display table to use for buffers that specify none.
6436 See `buffer-display-table' for more information. */);
6437 Vstandard_display_table
= Qnil
;
6439 DEFVAR_BOOL ("redisplay-dont-pause", redisplay_dont_pause
,
6440 doc
: /* Non-nil means display update isn't paused when input is detected. */);
6441 redisplay_dont_pause
= 1;
6443 #if PERIODIC_PREEMPTION_CHECKING
6444 DEFVAR_LISP ("redisplay-preemption-period", Vredisplay_preemption_period
,
6445 doc
: /* Period in seconds between checking for input during redisplay.
6446 This has an effect only if `redisplay-dont-pause' is nil; in that
6447 case, arriving input preempts redisplay until the input is processed.
6448 If the value is nil, redisplay is never preempted. */);
6449 Vredisplay_preemption_period
= make_float (0.10);
6456 Vinitial_window_system
= Qnil
;
6457 Vwindow_system_version
= Qnil
;